change default of serverSetCookie to "always"

i18nexus · Feb 8, 2024 · b11b9c2 · b11b9c2
1 parent b3e839c
commit b11b9c2
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 5.3.0
+
+- Change default of `serverSetCookie` to `"always"`.
+- Add `"never"` option to `serverSetCookie`. This is the same as `undefined` in previous versions.
+
 ## 5.2.1
 
 - Update dependencies

diff --git a/README.md b/README.md
@@ -58,15 +58,15 @@ You now have internationalized routing!
 
 ## Config Options
 
-| Option            | Default value   | Type                   | Required? |
-| ----------------- | --------------- | ---------------------- | --------- |
-| `locales`         |                 | string[]               | &#10004;  |
-| `defaultLocale`   |                 | string                 | &#10004;  |
-| `prefixDefault`   | `false`         | boolean                |           |
-| `localeDetector`  | (See below)     | function \| false      |           |
-| `localeCookie`    | `'NEXT_LOCALE'` | string                 |           |
-| `serverSetCookie` |                 | "always" \| "if-empty" |           |
-| `basePath`        | `''`            | string                 |           |
+| Option            | Default value   | Type                              | Required? |
+| ----------------- | --------------- | --------------------------------- | --------- |
+| `locales`         |                 | string[]                          | &#10004;  |
+| `defaultLocale`   |                 | string                            | &#10004;  |
+| `prefixDefault`   | `false`         | boolean                           |           |
+| `localeDetector`  | (See below)     | function \| false                 |           |
+| `localeCookie`    | `'NEXT_LOCALE'` | string                            |           |
+| `serverSetCookie` | `'always'`      | "always" \| "if-empty" \| "never" |           |
+| `basePath`        | `''`            | string                            |           |
 
 ## Locale Path Prefixing
 
@@ -113,11 +113,11 @@ If you would prefer to use a different cookie key other than `NEXT_LOCALE`, you
 
 The `serverSetCookie` option automatically changes a visitor's preferred locale cookie by simply visiting a pathname that contains a locale.
 
-`'always'`: When the pathname of a request includes a locale, that locale will be set as the cookie by the middleware. This means that locale detection and any existing locale cookie will be ignored if a locale exists in the request's pathname. Locale detection and the reading of any existing cookie will still be run on pathnames that do not include a locale.
+`'always'`(default): When the pathname of a request includes a locale, that locale will be set as the cookie by the middleware. This means that locale detection and any existing locale cookie will be ignored if a locale exists in the request's pathname. Locale detection and the reading of any existing cookie will still be run on pathnames that do not include a locale.
 
 `'if-empty'`: Same as `'always'`, except the middleware will not overwrite the cookie if one already exists.
 
-`undefined` (default): When `serverSetCookie` is not set, the middleware will not automatically set the cookie.
+`'never'`: The middleware will not automatically set the cookie.
 
 ## Using `basePath` (optional)
 

diff --git a/__tests__/i18nRouter.test.ts b/__tests__/i18nRouter.test.ts
@@ -10,7 +10,8 @@ basePaths.forEach(basePath => {
       const config = {
         locales: 'invalid',
         defaultLocale: 'en-US',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       };
 
       // @ts-ignore
@@ -20,7 +21,7 @@ basePaths.forEach(basePath => {
     });
 
     it('should throw an error if defaultLocale is not defined', () => {
-      const config = { locales: ['en-US'], basePath };
+      const config = { locales: ['en-US'], basePath, serverSetCookie: 'never' };
 
       // @ts-ignore
       expect(() => i18nRouter(mockRequest('/', ['en']), config)).toThrow(
@@ -29,28 +30,35 @@ basePaths.forEach(basePath => {
     });
 
     it('should throw an error if defaultLocale is not in locales array', () => {
-      const config = {
-        locales: ['en-US'],
-        defaultLocale: 'invalid',
-        basePath
-      };
-      expect(() => i18nRouter(mockRequest('/', ['en']), config)).toThrow(
-        /defaultLocale/
-      );
+      expect(() =>
+        i18nRouter(mockRequest('/', ['en']), {
+          locales: ['en-US'],
+          defaultLocale: 'invalid',
+          basePath,
+          serverSetCookie: 'never'
+        })
+      ).toThrow(/defaultLocale/);
     });
 
     it('should throw an error if localeDetector is not a function', () => {
       const config = {
         locales: ['en-US'],
         defaultLocale: 'en-US',
         localeDetector: 'invalid',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       };
 
-      // @ts-ignore
-      expect(() => i18nRouter(mockRequest('/', ['en']), config)).toThrow(
-        /localeDetector/
-      );
+      expect(() =>
+        i18nRouter(mockRequest('/', ['en']), {
+          locales: ['en-US'],
+          defaultLocale: 'en-US',
+          // @ts-ignore
+          localeDetector: 'invalid',
+          basePath,
+          serverSetCookie: 'never'
+        })
+      ).toThrow(/localeDetector/);
     });
 
     it('should throw an error if request argument is missing', () => {
@@ -67,7 +75,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledTimes(0);
@@ -83,7 +92,8 @@ basePaths.forEach(basePath => {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
         prefixDefault: true,
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -100,7 +110,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -118,7 +129,8 @@ basePaths.forEach(basePath => {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
         prefixDefault: true,
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -135,7 +147,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -152,7 +165,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledTimes(0);
@@ -167,7 +181,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledTimes(0);
@@ -182,7 +197,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -199,7 +215,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledTimes(0);
@@ -214,7 +231,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledTimes(0);
@@ -229,7 +247,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(
@@ -246,7 +265,8 @@ basePaths.forEach(basePath => {
       i18nRouter(request, {
         locales: ['en', 'de', 'jp'],
         defaultLocale: 'en',
-        basePath
+        basePath,
+        serverSetCookie: 'never'
       });
 
       expect(mockRedirect).toHaveBeenCalledWith(

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "next-i18n-router",
-  "version": "5.2.1",
+  "version": "5.3.0",
   "description": "Next.js App Router internationalized routing and locale detection.",
   "repository": "https://github.com/i18nexus/next-i18n-router",
   "keywords": [

diff --git a/src/i18nRouter.ts b/src/i18nRouter.ts
@@ -19,7 +19,7 @@ function i18nRouter(request: NextRequest, config: Config): NextResponse {
     localeDetector = defaultLocaleDetector,
     prefixDefault = false,
     basePath = '',
-    serverSetCookie
+    serverSetCookie = 'always'
   } = config;
 
   validateConfig(config);
@@ -134,7 +134,7 @@ function i18nRouter(request: NextRequest, config: Config): NextResponse {
       });
     };
 
-    if (serverSetCookie) {
+    if (serverSetCookie !== 'never') {
       if (
         cookieLocale &&
         cookieLocale !== pathLocale &&

diff --git a/src/types.ts b/src/types.ts
@@ -7,5 +7,5 @@ export interface Config {
   localeDetector?: ((request: NextRequest, config: Config) => string) | false;
   prefixDefault?: boolean;
   basePath?: string;
-  serverSetCookie?: 'if-empty' | 'always';
+  serverSetCookie?: 'if-empty' | 'always' | 'never';
 }