Merge pull request #67599 from code-dot-org/stephen/home-redirect

feat(marketing): only redirect home page if code.org

Author: stephenliang

frontend/apps/marketing/src/middleware/__tests__/withLocale.test.ts

@@ -1,7 +1,11 @@
 import {NextRequest, NextFetchEvent, NextResponse} from 'next/server';
 
 import {STALE_WHILE_REVALIDATE_ONE_HOUR} from '@/cache/constants';
-import {SUPPORTED_LOCALE_CODES, SUPPORTED_LOCALES_SET} from '@/config/locale';
+import {
+  SUPPORTED_LOCALE_CODES,
+  SUPPORTED_LOCALES_SET,
+  SupportedLocale,
+} from '@/config/locale';
 import {getStage} from '@/config/stage';
 import {getContentfulSlug} from '@/contentful/slug/getContentfulSlug';
 
@@ -40,15 +44,19 @@ describe('withLocale middleware', () => {
       response: {cookies: {set: jest.fn()}},
     } as unknown as NextRequest;
 
-    SUPPORTED_LOCALES_SET.add('zh-TW');
+    SUPPORTED_LOCALES_SET.add('zh-TW' as SupportedLocale);
     await withLocale(next)(request, mockEvent);
 
     expect(next).toHaveBeenCalledWith(request, mockEvent);
     expect(getContentfulSlug).not.toHaveBeenCalled();
-    expect(cookieMock.set).toHaveBeenCalledWith('language_', 'zh-TW', {
-      domain: undefined,
-      path: '/',
-    });
+    expect(cookieMock.set).toHaveBeenCalledWith(
+      'language_',
+      'zh-TW' as SupportedLocale,
+      {
+        domain: undefined,
+        path: '/',
+      },
+    );
   });
 
   it('should not redirect if the path contains a supported locale - development', async () => {
@@ -60,26 +68,30 @@ describe('withLocale middleware', () => {
     } as unknown as NextRequest;
     (getStage as jest.Mock).mockReturnValue('production');
 
-    SUPPORTED_LOCALES_SET.add('zh-TW');
+    SUPPORTED_LOCALES_SET.add('zh-TW' as SupportedLocale);
     await withLocale(next)(request, mockEvent);
 
     expect(next).toHaveBeenCalledWith(request, mockEvent);
     expect(getContentfulSlug).not.toHaveBeenCalled();
-    expect(cookieMock.set).toHaveBeenCalledWith('language_', 'zh-TW', {
-      domain: '.code.org',
-      path: '/',
-    });
+    expect(cookieMock.set).toHaveBeenCalledWith(
+      'language_',
+      'zh-TW' as SupportedLocale,
+      {
+        domain: '.code.org',
+        path: '/',
+      },
+    );
   });
 
   it('should redirect to the locale path if no locale is present in the path for cookies', async () => {
     const request = {
       url: 'https://test.code.org',
       nextUrl: {pathname: '/home', url: 'https://test.code.org/home'},
-      cookies: {get: jest.fn(() => ({value: 'zh-TW'}))},
+      cookies: {get: jest.fn(() => ({value: 'zh-TW' as SupportedLocale}))},
       headers: {get: jest.fn()},
     } as unknown as NextRequest;
 
-    SUPPORTED_LOCALES_SET.add('zh-TW');
+    SUPPORTED_LOCALES_SET.add('zh-TW' as SupportedLocale);
     (getContentfulSlug as jest.Mock).mockReturnValue('home');
 
     const response = await withLocale(next)(request, mockEvent);
@@ -103,7 +115,7 @@ describe('withLocale middleware', () => {
       },
     } as unknown as NextRequest;
 
-    SUPPORTED_LOCALE_CODES.push('zh-TW');
+    SUPPORTED_LOCALE_CODES.push('zh-TW' as SupportedLocale);
     (getContentfulSlug as jest.Mock).mockReturnValue('home');
 
     const response = await withLocale(next)(request, mockEvent);
@@ -127,7 +139,7 @@ describe('withLocale middleware', () => {
       },
     } as unknown as NextRequest;
 
-    SUPPORTED_LOCALE_CODES.push('en-US');
+    SUPPORTED_LOCALE_CODES.push('en-US' as SupportedLocale);
     (getContentfulSlug as jest.Mock).mockReturnValue('home');
 
     const response = await withLocale(next)(request, mockEvent);
@@ -182,11 +194,11 @@ describe('withLocale middleware', () => {
         pathname: '/engineering/all-the-things',
         url: 'https://test.code.org/engineering/all-the-things',
       },
-      cookies: {get: jest.fn(() => ({value: 'zh-TW'}))},
+      cookies: {get: jest.fn(() => ({value: 'zh-TW' as SupportedLocale}))},
       headers: {get: jest.fn()},
     } as unknown as NextRequest;
 
-    SUPPORTED_LOCALES_SET.add('zh-TW');
+    SUPPORTED_LOCALES_SET.add('zh-TW' as SupportedLocale);
     (getContentfulSlug as jest.Mock).mockReturnValue(
       'engineering/all-the-things',
     );
@@ -198,4 +210,23 @@ describe('withLocale middleware', () => {
       'https://test.code.org/zh-TW/engineering/all-the-things',
     );
   });
+
+  it('should not set language_ cookie or redirect to studio base url when brand is not CODE_DOT_ORG', async () => {
+    const request = {
+      nextUrl: {pathname: '/zh-TW/home'},
+      cookies: {get: jest.fn()},
+      headers: {get: jest.fn().mockReturnValue('csforall.org')},
+      response: {cookies: {set: jest.fn()}},
+      url: 'https://not-code.org/zh-TW/home',
+    } as unknown as NextRequest;
+
+    SUPPORTED_LOCALES_SET.add('zh-TW' as SupportedLocale);
+    await withLocale(next)(request, mockEvent);
+
+    expect(cookieMock.set).not.toHaveBeenCalledWith(
+      'language_',
+      expect.anything(),
+      expect.anything(),
+    );
+  });
 });

frontend/apps/marketing/src/middleware/withLocale.ts

@@ -1,6 +1,7 @@
 import Negotiator from 'negotiator';
 import {NextFetchEvent, NextRequest} from 'next/server';
 
+import {Brand, getBrandFromHostname} from '@/config/brand';
 import {
   getLocalizeJsLocaleFromDashboardLocale,
   getDashboardLocale,
@@ -52,33 +53,37 @@ export const withLocale: MiddlewareFactory = next => {
 
     const maybeLocale = pathParts[0] as SupportedLocale;
     const stage = getStage();
-
-    if (SUPPORTED_LOCALES_SET.has(maybeLocale)) {
-      // If the first part of the path is a supported locale or there are no subpaths, we don't need to redirect
-      const response = await next(request, event);
-
-      response.cookies.set('language_', getDashboardLocale(maybeLocale), {
-        path: '/',
-        domain: stage === 'production' ? '.code.org' : undefined,
-      });
-
-      return response;
-    }
+    const hostname = request.headers.get('host');
+    const brand = getBrandFromHostname(hostname);
 
     // If pathParts is empty, then it is a request to / which should resolve to the / slug
     // It is an empty string here because when a call is made to Contentful, `/` is automatically prepended
     const isRootRoute = pathParts.length === 0;
 
-    if (isRootRoute) {
-      // If the _user_type cookie is set, then Dashboard successfully logged in the user which is an early indicator
-      // that the user is logged in right now. Therefore, send the user to Code Studio
-      // See: https://github.com/code-dot-org/code-dot-org/blob/3fad8bce055846378ae3da343da93a32acd4df8c/dashboard/config/initializers/devise.rb#L331
-      const userTypeCookie = request.cookies.get(
-        getCookieNameByStage('_user_type', stage),
-      );
+    if (brand === Brand.CODE_DOT_ORG) {
+      if (SUPPORTED_LOCALES_SET.has(maybeLocale)) {
+        // If the first part of the path is a supported locale or there are no subpaths, we don't need to redirect
+        const response = await next(request, event);
 
-      if (userTypeCookie?.value) {
-        return getCachedRedirectResponse(getStudioBaseUrl());
+        response.cookies.set('language_', getDashboardLocale(maybeLocale), {
+          path: '/',
+          domain: stage === 'production' ? '.code.org' : undefined,
+        });
+
+        return response;
+      }
+
+      if (isRootRoute) {
+        // If the _user_type cookie is set, then Dashboard successfully logged in the user which is an early indicator
+        // that the user is logged in right now. Therefore, send the user to Code Studio
+        // See: https://github.com/code-dot-org/code-dot-org/blob/3fad8bce055846378ae3da343da93a32acd4df8c/dashboard/config/initializers/devise.rb#L331
+        const userTypeCookie = request.cookies.get(
+          getCookieNameByStage('_user_type', stage),
+        );
+
+        if (userTypeCookie?.value) {
+          return getCachedRedirectResponse(getStudioBaseUrl());
+        }
       }
     }
 
@@ -99,11 +104,13 @@ export const withLocale: MiddlewareFactory = next => {
     const redirectUrl = new URL(localizedPath, request.url);
     const response = getCachedRedirectResponse(redirectUrl);
 
-    // Set the language cookie if discovered via Accept-Language header
-    response.cookies.set('language_', getDashboardLocale(locale), {
-      path: '/',
-      domain: getStage() === 'production' ? '.code.org' : undefined,
-    });
+    if (brand === Brand.CODE_DOT_ORG) {
+      // Set the language cookie if discovered via Accept-Language header
+      response.cookies.set('language_', getDashboardLocale(locale), {
+        path: '/',
+        domain: getStage() === 'production' ? '.code.org' : undefined,
+      });
+    }
 
     return response;
   };