Default preferred locale (#422)

src/container.ts

@@ -51,6 +51,7 @@ export type Configuration = {
     eventMetadata?: {[key: string]: string},
     eventProcessor?: DependencyResolver<TrackingEventProcessor>,
     defaultFetchTimeout?: number,
+    defaultPreferredLocale?: string,
 };
 
 export class Container {
@@ -119,6 +120,7 @@ export class Container {
             baseEndpointUrl: this.configuration.contentBaseEndpointUrl,
             logger: this.getLogger('ContentFetcher'),
             defaultTimeout: this.configuration.defaultFetchTimeout ?? Container.DEFAULT_FETCH_TIMEOUT,
+            defaultPreferredLocale: this.configuration.defaultPreferredLocale,
         });
     }
 

src/contentFetcher.ts

@@ -78,12 +78,14 @@ export type Configuration = {
     baseEndpointUrl?: string,
     logger?: Logger,
     defaultTimeout?: number,
+    defaultPreferredLocale?: string,
 };
 
 type InternalConfiguration = {
     appId?: string,
     apiKey?: string,
     defaultTimeout?: number,
+    defaultPreferredLocale?: string,
 };
 
 export class ContentFetcher {
@@ -117,6 +119,7 @@ export class ContentFetcher {
             appId: configuration.appId,
             apiKey: apiKey,
             defaultTimeout: configuration.defaultTimeout,
+            defaultPreferredLocale: configuration.defaultPreferredLocale,
         };
     }
 
@@ -214,8 +217,10 @@ export class ContentFetcher {
             payload.version = `${options.version}`;
         }
 
-        if (options.preferredLocale !== undefined) {
-            payload.preferredLocale = options.preferredLocale;
+        const preferredLocale = options.preferredLocale ?? this.configuration.defaultPreferredLocale;
+
+        if (preferredLocale !== undefined) {
+            payload.preferredLocale = preferredLocale;
         }
 
         const dynamic = ContentFetcher.isDynamicContent(options);

src/facade/contentFetcherFacade.ts

@@ -21,11 +21,7 @@ function validate(options: unknown): asserts options is FetchOptions {
     }
 }
 
-type Options = {
-    preferredLocale?: string,
-};
-
-export type Configuration = Options & {
+export type Configuration = {
     contentFetcher: ContentFetcher,
     contextFactory: ContextFactory,
     previewTokenProvider: TokenProvider,
@@ -44,17 +40,12 @@ export class ContentFetcherFacade {
 
     private readonly cidAssigner: CidAssigner;
 
-    private readonly options: Options;
-
     public constructor(configuration: Configuration) {
         this.fetcher = configuration.contentFetcher;
         this.previewTokenProvider = configuration.previewTokenProvider;
         this.userTokenProvider = configuration.userTokenProvider;
         this.cidAssigner = configuration.cidAssigner;
         this.contextFactory = configuration.contextFactory;
-        this.options = {
-            preferredLocale: configuration.preferredLocale,
-        };
     }
 
     public async fetch<P extends JsonObject>(slotId: string, options: FetchOptions = {}): Promise<FetchResponse<P>> {
@@ -72,7 +63,7 @@ export class ContentFetcherFacade {
             version: options.version,
             context: this.contextFactory.createContext(options.attributes),
             timeout: options.timeout,
-            preferredLocale: options.preferredLocale ?? this.options.preferredLocale,
+            preferredLocale: options.preferredLocale,
         });
     }
 }

src/facade/sdkFacade.ts

@@ -17,11 +17,7 @@ import {ContentFetcherFacade} from './contentFetcherFacade';
 import {CookieCacheConfiguration} from '../cache/cookieCache';
 import {EventSubjectProcessor} from '../eventSubjectProcessor';
 
-type Options = {
-    preferredLocale?: string,
-};
-
-export type Configuration = Options & {
+export type Configuration = {
     appId: string,
     tokenScope?: TokenScope,
     debug?: boolean,
@@ -42,6 +38,7 @@ export type Configuration = Options & {
         previewToken?: CookieCacheConfiguration,
     },
     defaultFetchTimeout?: number,
+    defaultPreferredLocale?: string,
 };
 
 function validateConfiguration(configuration: unknown): asserts configuration is Configuration {
@@ -65,17 +62,14 @@ export class SdkFacade {
 
     private contentFetcherFacade?: ContentFetcherFacade;
 
-    private readonly options: Options;
-
-    private constructor(sdk: Sdk, options: Options = {}) {
+    private constructor(sdk: Sdk) {
         this.sdk = sdk;
-        this.options = options;
     }
 
     public static init(configuration: Configuration): SdkFacade {
         validateConfiguration(configuration);
 
-        const {track = true, userId, token, preferredLocale, ...containerConfiguration} = configuration;
+        const {track = true, userId, token, ...containerConfiguration} = configuration;
 
         if (userId !== undefined && token !== undefined) {
             throw new Error('Either the user ID or token can be specified, but not both.');
@@ -90,9 +84,6 @@ export class SdkFacade {
                 disableCidMirroring: containerConfiguration.disableCidMirroring ?? false,
                 eventProcessor: container => new EventSubjectProcessor(container.getLogger('EventSubjectProcessor')),
             }),
-            {
-                preferredLocale: preferredLocale,
-            },
         );
 
         if (userId !== undefined) {
@@ -185,7 +176,6 @@ export class SdkFacade {
                 cidAssigner: this.sdk.cidAssigner,
                 previewTokenProvider: this.sdk.previewTokenStore,
                 userTokenProvider: this.sdk.userTokenStore,
-                preferredLocale: this.options.preferredLocale,
             });
         }
 

src/schema/sdkFacadeSchemas.ts

@@ -57,7 +57,7 @@ export const sdkFacadeConfigurationSchema = new ObjectType({
             integer: true,
             minimum: 1,
         }),
-        preferredLocale: new StringType({
+        defaultPreferredLocale: new StringType({
             pattern: /^[a-z]{2,3}([-_][a-z]{2,3})?$/i,
         }),
     },

src/schema/sdkSchemas.ts

@@ -75,5 +75,8 @@ export const sdkConfigurationSchema = new ObjectType({
             integer: true,
             minimum: 1,
         }),
+        defaultPreferredLocale: new StringType({
+            pattern: /^[a-z]{2,3}([-_][a-z]{2,3})?$/i,
+        }),
     },
 });

src/sdk.ts

@@ -34,6 +34,7 @@ export type Configuration = {
     },
     eventProcessor?: DependencyResolver<TrackingEventProcessor>,
     defaultFetchTimeout?: number,
+    defaultPreferredLocale?: string,
 };
 
 function validateConfiguration(configuration: unknown): asserts configuration is Configuration {

test/container.test.ts

@@ -32,6 +32,8 @@ describe('A container', () => {
         contentBaseEndpointUrl: 'https://localtest/content',
         evaluationBaseEndpointUrl: 'https://localtest/evaluate',
         trackerEndpointUrl: 'https://localtest/track',
+        defaultFetchTimeout: 5000,
+        defaultPreferredLocale: 'en-us',
     };
 
     it('should provide its configuration', () => {

test/contentFetcher.test.ts

@@ -473,12 +473,32 @@ describe('A content fetcher', () => {
         await expect(promise).resolves.toEqual(content);
     });
 
+    it('should fetch dynamic content for the default preferred locale', async () => {
+        const fetcher = new ContentFetcher({
+            appId: appId,
+            defaultPreferredLocale: 'en-us',
+        });
+
+        fetchMock.mock({
+            ...requestMatcher,
+            body: {
+                ...requestMatcher.body,
+                preferredLocale: 'en-us',
+            },
+            response: content,
+        });
+
+        const promise = fetcher.fetch(contentId);
+
+        await expect(promise).resolves.toEqual(content);
+    });
+
     it('should fetch dynamic content for the specified preferred locale', async () => {
         const fetcher = new ContentFetcher({
             appId: appId,
         });
 
-        const preferredLocale = 'pt_BR';
+        const preferredLocale = 'pt-br';
 
         fetchMock.mock({
             ...requestMatcher,

test/facade/contentFecherFacade.test.ts

@@ -100,7 +100,6 @@ describe('A content fetcher facade', () => {
             userTokenProvider: new FixedTokenProvider(userToken),
             previewTokenProvider: new FixedTokenProvider(previewToken),
             contextFactory: new TabContextFactory(tab),
-            preferredLocale: 'pt-br',
         });
 
         const options: FetchOptions = {
@@ -131,10 +130,7 @@ describe('A content fetcher facade', () => {
             attributes: options?.context?.attributes,
         });
 
-        expect(fetcher.fetch).toHaveBeenNthCalledWith(1, slotId, {
-            ...options,
-            preferredLocale: 'pt-br',
-        });
+        expect(fetcher.fetch).toHaveBeenNthCalledWith(1, slotId, options);
 
         await fetcherFacade.fetch(slotId, {
             timeout: options.timeout,

test/facade/sdkFacade.test.ts

@@ -119,6 +119,7 @@ describe('A SDK facade', () => {
             logger: logger,
             urlSanitizer: urlSanitizer,
             defaultFetchTimeout: 5,
+            defaultPreferredLocale: 'en-us',
         });
 
         expect(initialize).toHaveBeenCalledWith(
@@ -134,6 +135,7 @@ describe('A SDK facade', () => {
                 urlSanitizer: urlSanitizer,
                 eventProcessor: expect.any(Function),
                 defaultFetchTimeout: 5,
+                defaultPreferredLocale: 'en-us',
             } satisfies ResolvedConfiguration,
         );
     });
@@ -392,21 +394,28 @@ describe('A SDK facade', () => {
         const sdkFacade = SdkFacade.init({
             appId: appId,
             track: false,
-            preferredLocale: preferredLocale,
         });
 
         const options: FetchOptions = {
             timeout: 5,
-        };
-
-        const expectedOptions: FetchOptions = {
-            ...options,
+            version: '1',
             preferredLocale: preferredLocale,
+            attributes: {
+                foo: 'bar',
+            },
         };
 
         await expect(sdkFacade.contentFetcher.fetch(slotId, options)).resolves.toBe(result);
 
-        expect(fetcher.fetch).toHaveBeenCalledWith(slotId, expect.objectContaining(expectedOptions));
+        expect(fetcher.fetch).toHaveBeenCalledWith(slotId, expect.objectContaining({
+            timeout: options.timeout,
+            version: options.version,
+            preferredLocale: preferredLocale,
+            context: expect.objectContaining({
+                attributes: options.attributes,
+            }),
+        }));
+
         expect(fetcher.fetch).toHaveBeenCalledTimes(1);
     });
 

test/schemas/sdkFacadeSchemas.test.ts

@@ -24,27 +24,27 @@ describe('The SDK facade configuration schema', () => {
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'pt',
+            defaultPreferredLocale: 'pt',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'pt_br',
+            defaultPreferredLocale: 'pt_br',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'pt_BR',
+            defaultPreferredLocale: 'pt_BR',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'pt-br',
+            defaultPreferredLocale: 'pt-br',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'pt-BR',
+            defaultPreferredLocale: 'pt-BR',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-            preferredLocale: 'abc_cde',
+            defaultPreferredLocale: 'abc_cde',
         }],
         [{
             appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
@@ -195,30 +195,30 @@ describe('The SDK facade configuration schema', () => {
         [
             {
                 appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-                preferredLocale: '',
+                defaultPreferredLocale: '',
             },
-            "Invalid format at path '/preferredLocale'.",
+            "Invalid format at path '/defaultPreferredLocale'.",
         ],
         [
             {
                 appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-                preferredLocale: 'fooo',
+                defaultPreferredLocale: 'fooo',
             },
-            'Invalid format at path \'/preferredLocale\'.',
+            'Invalid format at path \'/defaultPreferredLocale\'.',
         ],
         [
             {
                 appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-                preferredLocale: 'foo-baar',
+                defaultPreferredLocale: 'foo-baar',
             },
-            'Invalid format at path \'/preferredLocale\'.',
+            'Invalid format at path \'/defaultPreferredLocale\'.',
         ],
         [
             {
                 appId: '7e9d59a9-e4b3-45d4-b1c7-48287f1e5e8a',
-                preferredLocale: 'foo_baar',
+                defaultPreferredLocale: 'foo_baar',
             },
-            'Invalid format at path \'/preferredLocale\'.',
+            'Invalid format at path \'/defaultPreferredLocale\'.',
         ],
         [
             {