review

raju-opti · raju-opti · commit 9bb07f7b9266 · 2024-12-13T01:25:49.000+06:00
diff --git a/lib/odp/constant.ts b/lib/odp/constant.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export enum ODP_USER_KEY {
   VUID = 'vuid',
   FS_USER_ID = 'fs_user_id',
diff --git a/lib/odp/event_manager/odp_event.ts b/lib/odp/event_manager/odp_event.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022-2023, Optimizely
+ * Copyright 2022-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/lib/odp/event_manager/odp_event_api_manager.spec.ts b/lib/odp/event_manager/odp_event_api_manager.spec.ts
@@ -14,14 +14,11 @@
  * limitations under the License.
  */
 
-import { describe, beforeEach, beforeAll, it, expect, vi } from 'vitest';
+import { describe, it, expect, vi } from 'vitest';
 
-import { LogHandler, LogLevel } from '../../modules/logging';
 import { DefaultOdpEventApiManager, eventApiRequestGenerator, pixelApiRequestGenerator } from './odp_event_api_manager';
-import { OdpEvent } from './odp_event';
-import { RequestHandler } from '../../utils/http_request_handler/http';
+import { OdpEvent } from './odp_event';;
 import { OdpConfig } from '../odp_config';
-import { get } from 'http';
 
 const data1 = new Map<string, unknown>();
 data1.set('key11', 'value-1');
diff --git a/lib/odp/event_manager/odp_event_api_manager.ts b/lib/odp/event_manager/odp_event_api_manager.ts
@@ -51,7 +51,7 @@ export class DefaultOdpEventApiManager implements OdpEventApiManager {
 
   async sendEvents(odpConfig: OdpConfig, events: OdpEvent[]): Promise<EventDispatchResponse> {
     if (events.length === 0) {
-      return Promise.resolve({});
+      return {};
     }
 
     const { method, endpoint, headers, data } = this.requestGenerator(odpConfig, events);
diff --git a/lib/odp/event_manager/odp_event_manager.spec.ts b/lib/odp/event_manager/odp_event_manager.spec.ts
@@ -175,7 +175,7 @@ describe('DefaultOdpEventManager', () => {
     expect(apiManager.sendEvents).toHaveBeenNthCalledWith(1, config, events);
   });
 
-  it('should should send events immediately asynchronously if batchSize is 1', async () => {
+  it('should send events immediately asynchronously if batchSize is 1', async () => {
     const apiManager = getMockApiManager();
     apiManager.sendEvents.mockResolvedValue({ statusCode: 200 });
 
diff --git a/lib/odp/odp_manager_factory.browser.spec.ts b/lib/odp/odp_manager_factory.browser.spec.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 vi.mock('../utils/http_request_handler/browser_request_handler', () => {
   return { BrowserRequestHandler: vi.fn() };
 });
diff --git a/lib/odp/odp_manager_factory.browser.ts b/lib/odp/odp_manager_factory.browser.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { BrowserRequestHandler } from '../utils/http_request_handler/browser_request_handler';
 import { pixelApiRequestGenerator } from './event_manager/odp_event_api_manager';
 import { OdpManager } from './odp_manager';
diff --git a/lib/odp/odp_manager_factory.node.spec.ts b/lib/odp/odp_manager_factory.node.spec.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 vi.mock('../utils/http_request_handler/node_request_handler', () => {
   return { NodeRequestHandler: vi.fn() };
 });
diff --git a/lib/odp/odp_manager_factory.node.ts b/lib/odp/odp_manager_factory.node.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { NodeRequestHandler } from '../utils/http_request_handler/node_request_handler';
 import { eventApiRequestGenerator } from './event_manager/odp_event_api_manager';
 import { OdpManager } from './odp_manager';
diff --git a/lib/odp/odp_manager_factory.react_native.spec.ts b/lib/odp/odp_manager_factory.react_native.spec.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 vi.mock('../utils/http_request_handler/browser_request_handler', () => {
   return { BrowserRequestHandler: vi.fn() };
 });
diff --git a/lib/odp/odp_manager_factory.react_native.ts b/lib/odp/odp_manager_factory.react_native.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { BrowserRequestHandler } from '../utils/http_request_handler/browser_request_handler';
 import { eventApiRequestGenerator } from './event_manager/odp_event_api_manager';
 import { OdpManager } from './odp_manager';
diff --git a/lib/odp/odp_manager_factory.spec.ts b/lib/odp/odp_manager_factory.spec.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 vi.mock('./odp_manager', () => {
   return {
     DefaultOdpManager: vi.fn(),
diff --git a/lib/odp/odp_manager_factory.ts b/lib/odp/odp_manager_factory.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { RequestHandler } from "../shared_types";
 import { Cache } from "../utils/cache/cache";
 import { InMemoryLruCache } from "../utils/cache/in_memory_lru_cache";
diff --git a/lib/odp/odp_types.ts b/lib/odp/odp_types.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022-2023, Optimizely
+ * Copyright 2022-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/lib/odp/segment_manager/odp_response_schema.ts b/lib/odp/segment_manager/odp_response_schema.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022, Optimizely
+ * Copyright 2022, 2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the 'License');
  * you may not use this file except in compliance with the License.
diff --git a/lib/odp/segment_manager/odp_segment_api_manager.ts b/lib/odp/segment_manager/odp_segment_api_manager.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022-2023, Optimizely
+ * Copyright 2022-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/lib/odp/segment_manager/odp_segment_manager.spec.ts b/lib/odp/segment_manager/odp_segment_manager.spec.ts
@@ -71,7 +71,7 @@ describe('DefaultOdpSegmentManager', () => {
     expect(cache.get(manager.makeCacheKey(userKey, userValue))).toEqual(['k', 'l']);
   });
 
-  it('should return sement from cache and not call apiManager on cache hit.', async () => {
+  it('should return segment from cache and not call apiManager on cache hit.', async () => {
     const cache = getMockSyncCache<string[]>();
     const apiManager = getMockApiManager();
 
diff --git a/lib/odp/segment_manager/optimizely_segment_option.ts b/lib/odp/segment_manager/optimizely_segment_option.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022, Optimizely
+ * Copyright 2022, 2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/lib/optimizely/index.ts b/lib/optimizely/index.ts
@@ -91,12 +91,12 @@ export default class Optimizely implements Client {
   private clientEngine: string;
   private clientVersion: string;
   private errorHandler: ErrorHandler;
-  protected logger: LoggerFacade;
+  private logger: LoggerFacade;
   private projectConfigManager: ProjectConfigManager;
   private decisionService: DecisionService;
   private eventProcessor?: EventProcessor;
   private defaultDecideOptions: { [key: string]: boolean };
-  protected odpManager?: OdpManager;
+  private odpManager?: OdpManager;
   public notificationCenter: DefaultNotificationCenter;
   private vuidManager?: VuidManager;
 
diff --git a/lib/tests/testUtils.ts b/lib/tests/testUtils.ts
@@ -1,7 +1,23 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export const exhaustMicrotasks = async (loop = 100): Promise<void> => {
   for(let i = 0; i < loop; i++) {
     await Promise.resolve();
   }
 };
 
-export const wait = (ms: number): Promise<void> => new Promise(resolve => setTimeout(resolve, ms));
+export const wait = (ms: number): Promise<void> => new Promise(resolve => setTimeout(resolve, ms));
diff --git a/lib/utils/cache/in_memory_lru_cache.spec.ts b/lib/utils/cache/in_memory_lru_cache.spec.ts
@@ -112,13 +112,6 @@ describe('InMemoryLruCache', () => {
     expect(cache.getBatched(['a', 'b', 'c'])).toEqual([1, 2, undefined]);
   });
 
-  it('should return correct values when getBatched is called', () => {
-    const cache = new InMemoryLruCache<number>(2);
-    cache.set('a', 1);
-    cache.set('b', 2);
-    expect(cache.getBatched(['a', 'b', 'c'])).toEqual([1, 2, undefined]);
-  });
-
   it('should not return expired values  when getBatched is called', async () => {
     const cache = new InMemoryLruCache<number>(2, 100);
     cache.set('a', 1);
diff --git a/lib/utils/cache/in_memory_lru_cache.ts b/lib/utils/cache/in_memory_lru_cache.ts
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022-2023, Optimizely
+ * Copyright 2022-2024, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/lib/vuid/vuid.spec.ts b/lib/vuid/vuid.spec.ts
@@ -1,6 +1,22 @@
-import { vi, describe, expect, it } from 'vitest';
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
-import { VUID_PREFIX, VUID_MAX_LENGTH, isVuid, makeVuid } from './vuid';
+import { describe, expect, it } from 'vitest';
+
+import { isVuid, makeVuid, VUID_MAX_LENGTH } from './vuid';
 
 describe('isVuid', () => {
   it('should return true if and only if the value strats with the VUID_PREFIX and is longer than vuid_prefix', () => {
@@ -13,3 +29,11 @@ describe('isVuid', () => {
     expect(isVuid('123')).toBe(false);
   })
 });
+
+describe('makeVuid', () => {
+  it('should return a string that is a valid vuid and whose length is within VUID_MAX_LENGTH', () => {
+    const vuid = makeVuid();
+    expect(isVuid(vuid)).toBe(true);
+    expect(vuid.length).toBeLessThanOrEqual(VUID_MAX_LENGTH);
+  });
+});
diff --git a/lib/vuid/vuid.ts b/lib/vuid/vuid.ts
@@ -1,3 +1,19 @@
+/**
+ * Copyright 2024, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import { v4 as uuidV4 } from 'uuid';
 
 export const VUID_PREFIX = `vuid_`;
diff --git a/lib/vuid/vuid_manager.spec.ts b/lib/vuid/vuid_manager.spec.ts
diff --git a/lib/vuid/vuid_manager_factory.browser.spec.ts b/lib/vuid/vuid_manager_factory.browser.spec.ts
diff --git a/lib/vuid/vuid_manager_factory.node.spec.ts b/lib/vuid/vuid_manager_factory.node.spec.ts
diff --git a/lib/vuid/vuid_manager_factory.react_native.spec.ts b/lib/vuid/vuid_manager_factory.react_native.spec.ts
diff --git a/lib/vuid/vuid_manager_factory.ts b/lib/vuid/vuid_manager_factory.ts

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		`- * Copyright 2022-2023, Optimizely`
	`2`	`+ * Copyright 2022-2024, Optimizely`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ export class DefaultOdpEventApiManager implements OdpEventApiManager {`
`51`	`51`
`52`	`52`	`async sendEvents(odpConfig: OdpConfig, events: OdpEvent[]): Promise<EventDispatchResponse> {`
`53`	`53`	`if (events.length === 0) {`
`54`		`- return Promise.resolve({});`
	`54`	`+ return {};`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`const { method, endpoint, headers, data } = this.requestGenerator(odpConfig, events);`