📝(contributing) add signed commits paragraph

Add a paragraph to inform that only signed commits are accepted now.
🚚(frontend) Display homepage on /home url
2025-04-14 18:14:41 +02:00 · 2025-04-13 13:25:40 +02:00 · 2025-04-13 13:25:40 +02:00 · 2025-04-13 13:25:40 +02:00
14 changed files with 100 additions and 35 deletions
@@ -8,6 +8,11 @@ and this project adheres to

 ## [Unreleased]

+## Added
+
+- 🚩 add homepage feature flag #861
+
+
 ## [3.1.0] - 2025-04-07

 ## Added
@@ -48,6 +48,10 @@ All commit messages must adhere to the following format:
 Implemented login and signup features, and integrated OAuth2 for social login.
 ```

+## Signing commits
+
+Only signed commits are accepted. They can be signed using a SSH or GPG key. Github documentation about signing commits contains all the information you need : https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#about-commit-signature-verification
+
 ## Changelog Update

 Please add a line to the changelog describing your development. The changelog entry should include a brief summary of the changes, this helps in tracking changes effectively and keeping everyone informed. We usually include the title of the pull request, followed by the pull request ID to finish the log entry. The changelog line should be less than 80 characters in total.
@@ -47,6 +47,11 @@ These are the environmental variables you can set for the impress-backend contai
 | COLLABORATION_API_URL                           | collaboration api host                                                                        |                                                         |
 | COLLABORATION_SERVER_SECRET                     | collaboration api secret                                                                      |                                                         |
 | COLLABORATION_WS_URL                            | collaboration websocket url                                                                   |                                                         |
+| FRONTEND_CSS_URL                                | To add a external css file to the app                                                         |                                                         |
+| FRONTEND_HOMEPAGE_FEATURE_ENABLED               | frontend feature flag to display the homepage                                                 | false                                                   |
+| FRONTEND_FOOTER_FEATURE_ENABLED                 | frontend feature flag to display the footer                                                   | false                                                   |
+| FRONTEND_FOOTER_VIEW_CACHE_TIMEOUT              | Cache duration of the json footer                                                             | 86400                                                   |
+| FRONTEND_URL_JSON_FOOTER                        | Url with a json to configure the footer                                                       |                                                         |
 | FRONTEND_THEME                                  | frontend theme to use                                                                         |                                                         |
 | POSTHOG_KEY                                     | posthog key for analytics                                                                     |                                                         |
 | CRISP_WEBSITE_ID                                | crisp website id for support                                                                  |                                                         |
@@ -64,5 +64,6 @@ COLLABORATION_WS_URL=ws://localhost:4444/collaboration/ws/

 # Frontend
 FRONTEND_THEME=default
+FRONTEND_HOMEPAGE_FEATURE_ENABLED=True
 FRONTEND_FOOTER_FEATURE_ENABLED=True
 FRONTEND_URL_JSON_FOOTER=http://frontend:3000/contents/footer-demo.json
@@ -1692,6 +1692,7 @@ class ConfigView(drf.views.APIView):
            "CRISP_WEBSITE_ID",
            "ENVIRONMENT",
            "FRONTEND_CSS_URL",
+            "FRONTEND_HOMEPAGE_FEATURE_ENABLED",
            "FRONTEND_FOOTER_FEATURE_ENABLED",
            "FRONTEND_THEME",
            "MEDIA_BASE_URL",
@@ -19,6 +19,7 @@ pytestmark = pytest.mark.django_db
    COLLABORATION_WS_URL="http://testcollab/",
    CRISP_WEBSITE_ID="123",
    FRONTEND_CSS_URL="http://testcss/",
+    FRONTEND_HOMEPAGE_FEATURE_ENABLED=True,
    FRONTEND_FOOTER_FEATURE_ENABLED=True,
    FRONTEND_THEME="test-theme",
    MEDIA_BASE_URL="http://testserver/",
@@ -41,6 +42,7 @@ def test_api_config(is_authenticated):
        "CRISP_WEBSITE_ID": "123",
        "ENVIRONMENT": "test",
        "FRONTEND_CSS_URL": "http://testcss/",
+        "FRONTEND_HOMEPAGE_FEATURE_ENABLED": True,
        "FRONTEND_FOOTER_FEATURE_ENABLED": True,
        "FRONTEND_THEME": "test-theme",
        "LANGUAGES": [
@@ -410,6 +410,11 @@ class Base(Configuration):
    FRONTEND_THEME = values.Value(
        None, environ_name="FRONTEND_THEME", environ_prefix=None
    )
+    FRONTEND_HOMEPAGE_FEATURE_ENABLED = values.BooleanValue(
+        default=False,
+        environ_name="FRONTEND_HOMEPAGE_FEATURE_ENABLED",
+        environ_prefix=None,
+    )
    FRONTEND_URL_JSON_FOOTER = values.Value(
        None, environ_name="FRONTEND_URL_JSON_FOOTER", environ_prefix=None
    )
@@ -1,5 +1,26 @@
 import { Page, expect } from '@playwright/test';

+export const CONFIG = {
+  AI_FEATURE_ENABLED: true,
+  CRISP_WEBSITE_ID: null,
+  COLLABORATION_WS_URL: 'ws://localhost:4444/collaboration/ws/',
+  ENVIRONMENT: 'development',
+  FRONTEND_CSS_URL: null,
+  FRONTEND_HOMEPAGE_FEATURE_ENABLED: true,
+  FRONTEND_FOOTER_FEATURE_ENABLED: true,
+  FRONTEND_THEME: 'default',
+  MEDIA_BASE_URL: 'http://localhost:8083',
+  LANGUAGES: [
+    ['en-us', 'English'],
+    ['fr-fr', 'Français'],
+    ['de-de', 'Deutsch'],
+    ['nl-nl', 'Nederlands'],
+  ],
+  LANGUAGE_CODE: 'en-us',
+  POSTHOG_KEY: {},
+  SENTRY_DSN: null,
+};
+
 export const keyCloakSignIn = async (
  page: Page,
  browserName: string,
@@ -2,27 +2,7 @@ import path from 'path';

 import { expect, test } from '@playwright/test';

-import { createDoc } from './common';
-
-const config = {
-  AI_FEATURE_ENABLED: true,
-  CRISP_WEBSITE_ID: null,
-  COLLABORATION_WS_URL: 'ws://localhost:4444/collaboration/ws/',
-  ENVIRONMENT: 'development',
-  FRONTEND_CSS_URL: null,
-  FRONTEND_FOOTER_FEATURE_ENABLED: true,
-  FRONTEND_THEME: 'default',
-  MEDIA_BASE_URL: 'http://localhost:8083',
-  LANGUAGES: [
-    ['en-us', 'English'],
-    ['fr-fr', 'Français'],
-    ['de-de', 'Deutsch'],
-    ['nl-nl', 'Nederlands'],
-  ],
-  LANGUAGE_CODE: 'en-us',
-  POSTHOG_KEY: {},
-  SENTRY_DSN: null,
-};
+import { CONFIG, createDoc } from './common';

 test.describe('Config', () => {
  test('it checks the config api is called', async ({ page }) => {
@@ -36,7 +16,7 @@ test.describe('Config', () => {
    const response = await responsePromise;
    expect(response.ok()).toBeTruthy();

-    expect(await response.json()).toStrictEqual(config);
+    expect(await response.json()).toStrictEqual(CONFIG);
  });

  test('it checks that sentry is trying to init from config endpoint', async ({
@@ -47,7 +27,7 @@ test.describe('Config', () => {
      if (request.method().includes('GET')) {
        await route.fulfill({
          json: {
-            ...config,
+            ...CONFIG,
            SENTRY_DSN: 'https://sentry.io/123',
          },
        });
@@ -120,7 +100,7 @@ test.describe('Config', () => {
      if (request.method().includes('GET')) {
        await route.fulfill({
          json: {
-            ...config,
+            ...CONFIG,
            AI_FEATURE_ENABLED: false,
          },
        });
@@ -151,7 +131,7 @@ test.describe('Config', () => {
      if (request.method().includes('GET')) {
        await route.fulfill({
          json: {
-            ...config,
+            ...CONFIG,
            CRISP_WEBSITE_ID: '1234',
          },
        });
@@ -173,7 +153,7 @@ test.describe('Config', () => {
      if (request.method().includes('GET')) {
        await route.fulfill({
          json: {
-            ...config,
+            ...CONFIG,
            FRONTEND_CSS_URL: 'http://localhost:123465/css/style.css',
          },
        });
@@ -1,5 +1,7 @@
 import { expect, test } from '@playwright/test';

+import { CONFIG } from './common';
+
 test.beforeEach(async ({ page }) => {
  await page.goto('/docs/');
 });
@@ -50,4 +52,27 @@ test.describe('Home page', () => {

    await expect(footer).toBeVisible();
  });
+
+  test('it checks the homepage feature flag', async ({ page }) => {
+    await page.route('**/api/v1.0/config/', async (route) => {
+      const request = route.request();
+      if (request.method().includes('GET')) {
+        await route.fulfill({
+          json: {
+            ...CONFIG,
+            FRONTEND_HOMEPAGE_FEATURE_ENABLED: false,
+          },
+        });
+      } else {
+        await route.continue();
+      }
+    });
+
+    await page.goto('/');
+
+    // Keyclock login page
+    await expect(
+      page.locator('.login-pf-page-header').getByText('impress'),
+    ).toBeVisible();
+  });
 });
@@ -5,17 +5,18 @@ import { Theme } from '@/cunningham/';
 import { PostHogConf } from '@/services';

 interface ConfigResponse {
-  LANGUAGES: [string, string][];
-  LANGUAGE_CODE: string;
-  ENVIRONMENT: string;
+  AI_FEATURE_ENABLED?: boolean;
  COLLABORATION_WS_URL?: string;
  CRISP_WEBSITE_ID?: string;
-  FRONTEND_THEME?: Theme;
+  ENVIRONMENT: string;
  FRONTEND_CSS_URL?: string;
+  FRONTEND_HOMEPAGE_FEATURE_ENABLED?: boolean;
+  FRONTEND_THEME?: Theme;
+  LANGUAGES: [string, string][];
+  LANGUAGE_CODE: string;
  MEDIA_BASE_URL?: string;
  POSTHOG_KEY?: PostHogConf;
  SENTRY_DSN?: string;
-  AI_FEATURE_ENABLED?: boolean;
 }

 export const getConfig = async (): Promise<ConfigResponse> => {
@@ -3,14 +3,16 @@ import { useRouter } from 'next/router';
 import { PropsWithChildren } from 'react';

 import { Box } from '@/components';
+import { useConfig } from '@/core';

 import { useAuth } from '../hooks';
-import { getAuthUrl } from '../utils';
+import { getAuthUrl, gotoLogin } from '../utils';

 export const Auth = ({ children }: PropsWithChildren) => {
  const { isLoading, pathAllowed, isFetchedAfterMount, authenticated } =
    useAuth();
  const { replace, pathname } = useRouter();
+  const { data: config } = useConfig();

  if (isLoading && !isFetchedAfterMount) {
    return (
@@ -40,7 +42,11 @@ export const Auth = ({ children }: PropsWithChildren) => {
   * If the user is not authenticated and the path is not allowed, we redirect to the login page.
   */
  if (!authenticated && !pathAllowed) {
-    void replace('/login');
+    if (config?.FRONTEND_HOMEPAGE_FEATURE_ENABLED) {
+      void replace('/home');
+    } else {
+      gotoLogin();
+    }
    return (
      <Box $height="100vh" $width="100vw" $align="center" $justify="center">
        <Loader />
@@ -49,9 +55,9 @@ export const Auth = ({ children }: PropsWithChildren) => {
  }

  /**
-   * If the user is authenticated and the path is the login page, we redirect to the home page.
+   * If the user is authenticated and the path is the home page, we redirect to the index.
   */
-  if (pathname === '/login' && authenticated) {
+  if (pathname === '/home' && authenticated) {
    void replace('/');
    return (
      <Box $height="100vh" $width="100vw" $align="center" $justify="center">
@@ -0,0 +1,8 @@
+import { HomeContent } from '@/features/home';
+import { NextPageWithLayout } from '@/types/next';
+
+const Page: NextPageWithLayout = () => {
+  return <HomeContent />;
+};
+
+export default Page;
@@ -50,6 +50,7 @@ backend:
    DB_USER: dinum
    DB_PASSWORD: pass
    DB_PORT: 5432
+    FRONTEND_HOMEPAGE_FEATURE_ENABLED: true
    FRONTEND_FOOTER_FEATURE_ENABLED: true
    FRONTEND_URL_JSON_FOOTER: https://impress.127.0.0.1.nip.io/contents/footer-demo.json
    POSTGRES_DB: impress
Author	SHA1	Message	Date
Manuel Raynaud	4e1a9b6a27	📝(contributing) add signed commits paragraph Add a paragraph to inform that only signed commits are accepted now.	2025-04-14 18:14:41 +02:00
Anthony LC	ecd06560c6	🚚(frontend) Display homepage on /home url The homepage is now accessible at the /home URL. Before the homepage was accessible on the /login URL. We still keep the /login URL for backward compatibility.	2025-04-13 13:25:40 +02:00
Anthony LC	e9ab099ce0	🚩(frontend) integrate homepage feature flag If the homepage feature flag is enabled, the homepage will be displayed.	2025-04-13 13:25:40 +02:00
Anthony LC	67b69d05f7	🚩(backend) add homepage feature flag Add a homepage feature flag that we will propagate to the frontend. It will be used to enable or disable the homepage at runtime.	2025-04-13 13:25:40 +02:00