Skip to content

Commit 49c6b8a

Browse files
raju-optiraju-opti
authored
[FSSDK-11114] add type test for entrypoints (#1004)
1 parent 1f82bdb commit 49c6b8a

File tree

7 files changed

+201
-123
lines changed

7 files changed

+201
-123
lines changed

‎lib/common_exports.ts‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2023-2024 Optimizely
2+
* Copyright 2023-2025 Optimizely
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -15,4 +15,23 @@
1515
*/
1616

1717
export { createStaticProjectConfigManager } from './project_config/config_manager_factory';
18-
export { PollingConfigManagerConfig } from './project_config/config_manager_factory';
18+
19+
export { LogLevel } from './logging/logger';
20+
21+
export {
22+
DebugLog,
23+
InfoLog,
24+
WarnLog,
25+
ErrorLog,
26+
} from './logging/logger_factory';
27+
28+
export { createLogger } from './logging/logger_factory';
29+
export { createErrorNotifier } from './error/error_notifier_factory';
30+
31+
export {
32+
DECISION_SOURCES,
33+
DECISION_NOTIFICATION_TYPES,
34+
NOTIFICATION_TYPES,
35+
} from './utils/enums';
36+
37+
export { OptimizelyDecideOption } from './shared_types';

‎lib/entrypoint.test-d.ts‎

Lines changed: 80 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,91 @@
1616

1717
import { expectTypeOf } from 'vitest';
1818

19-
import * as browserEntrypoint from './index.browser';
20-
import * as nodeEntrypoint from './index.node';
21-
import * as reactNativeEntrypoint from './index.react_native';
19+
import * as browser from './index.browser';
20+
import * as node from './index.node';
21+
import * as reactNative from './index.react_native';
2222

23-
import { Config, Client } from './shared_types';
23+
type WithoutReadonly<T> = { -readonly [P in keyof T]: T[P] };
24+
25+
const nodeEntrypoint: WithoutReadonly<typeof node> = node;
26+
const browserEntrypoint: WithoutReadonly<typeof browser> = browser;
27+
const reactNativeEntrypoint: WithoutReadonly<typeof reactNative> = reactNative;
28+
29+
import {
30+
Config,
31+
Client,
32+
StaticConfigManagerConfig,
33+
OpaqueConfigManager,
34+
PollingConfigManagerConfig,
35+
EventDispatcher,
36+
OpaqueEventProcessor,
37+
BatchEventProcessorOptions,
38+
OdpManagerOptions,
39+
OpaqueOdpManager,
40+
VuidManagerOptions,
41+
OpaqueVuidManager,
42+
OpaqueLevelPreset,
43+
LoggerConfig,
44+
OpaqueLogger,
45+
ErrorHandler,
46+
OpaqueErrorNotifier,
47+
} from './export_types';
48+
49+
import {
50+
DECISION_SOURCES,
51+
DECISION_NOTIFICATION_TYPES,
52+
NOTIFICATION_TYPES,
53+
} from './utils/enums';
54+
55+
import { LogLevel } from './logging/logger';
56+
57+
import { OptimizelyDecideOption } from './shared_types';
2458

2559
export type Entrypoint = {
60+
// client factory
2661
createInstance: (config: Config) => Client | null;
27-
}
2862

63+
// config manager related exports
64+
createStaticProjectConfigManager: (config: StaticConfigManagerConfig) => OpaqueConfigManager;
65+
createPollingProjectConfigManager: (config: PollingConfigManagerConfig) => OpaqueConfigManager;
66+
67+
// event processor related exports
68+
eventDispatcher: EventDispatcher;
69+
getSendBeaconEventDispatcher: () => EventDispatcher;
70+
createForwardingEventProcessor: (eventDispatcher?: EventDispatcher) => OpaqueEventProcessor;
71+
createBatchEventProcessor: (options: BatchEventProcessorOptions) => OpaqueEventProcessor;
72+
73+
// odp manager related exports
74+
createOdpManager: (options: OdpManagerOptions) => OpaqueOdpManager;
75+
76+
// vuid manager related exports
77+
createVuidManager: (options: VuidManagerOptions) => OpaqueVuidManager;
78+
79+
// logger related exports
80+
LogLevel: typeof LogLevel;
81+
DebugLog: OpaqueLevelPreset,
82+
InfoLog: OpaqueLevelPreset,
83+
WarnLog: OpaqueLevelPreset,
84+
ErrorLog: OpaqueLevelPreset,
85+
createLogger: (config: LoggerConfig) => OpaqueLogger;
86+
87+
// error related exports
88+
createErrorNotifier: (errorHandler: ErrorHandler) => OpaqueErrorNotifier;
89+
90+
// enums
91+
DECISION_SOURCES: typeof DECISION_SOURCES;
92+
DECISION_NOTIFICATION_TYPES: typeof DECISION_NOTIFICATION_TYPES;
93+
NOTIFICATION_TYPES: typeof NOTIFICATION_TYPES;
94+
95+
// decide options
96+
OptimizelyDecideOption: typeof OptimizelyDecideOption;
97+
}
2998

30-
// these type tests will be fixed in a future PR
3199

32-
// expectTypeOf(browserEntrypoint).toEqualTypeOf<Entrypoint>();
33-
// expectTypeOf(nodeEntrypoint).toEqualTypeOf<Entrypoint>();
34-
// expectTypeOf(reactNativeEntrypoint).toEqualTypeOf<Entrypoint>();
100+
expectTypeOf(browserEntrypoint).toEqualTypeOf<Entrypoint>();
101+
expectTypeOf(nodeEntrypoint).toEqualTypeOf<Entrypoint>();
102+
expectTypeOf(reactNativeEntrypoint).toEqualTypeOf<Entrypoint>();
35103

36-
// expectTypeOf(browserEntrypoint).toEqualTypeOf(nodeEntrypoint);
37-
// expectTypeOf(browserEntrypoint).toEqualTypeOf(reactNativeEntrypoint);
38-
// expectTypeOf(nodeEntrypoint).toEqualTypeOf(reactNativeEntrypoint);
104+
expectTypeOf(browserEntrypoint).toEqualTypeOf(nodeEntrypoint);
105+
expectTypeOf(browserEntrypoint).toEqualTypeOf(reactNativeEntrypoint);
106+
expectTypeOf(nodeEntrypoint).toEqualTypeOf(reactNativeEntrypoint);

‎lib/export_types.ts‎

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,62 @@
1414
* limitations under the License.
1515
*/
1616

17-
/**
18-
* This file contains a collection of all types to be externally exported.
19-
*/
17+
// config manager related types
18+
export type {
19+
StaticConfigManagerConfig,
20+
PollingConfigManagerConfig,
21+
OpaqueConfigManager,
22+
} from './project_config/config_manager_factory';
23+
24+
// event processor related types
25+
export type {
26+
LogEvent,
27+
EventDispatcherResponse,
28+
EventDispatcher,
29+
} from './event_processor/event_dispatcher/event_dispatcher';
30+
31+
export type {
32+
BatchEventProcessorOptions,
33+
OpaqueEventProcessor,
34+
} from './event_processor/event_processor_factory';
35+
36+
// Odp manager related types
37+
export type {
38+
OdpManagerOptions,
39+
OpaqueOdpManager,
40+
} from './odp/odp_manager_factory';
41+
42+
// Vuid manager related types
43+
export type {
44+
VuidManagerOptions,
45+
OpaqueVuidManager,
46+
} from './vuid/vuid_manager_factory';
2047

21-
export {
48+
// Logger related types
49+
export type {
50+
LogHandler,
51+
} from './logging/logger';
52+
53+
export type {
54+
OpaqueLevelPreset,
55+
LoggerConfig,
56+
OpaqueLogger,
57+
} from './logging/logger_factory';
58+
59+
// Error related types
60+
export type { ErrorHandler } from './error/error_handler';
61+
export type { OpaqueErrorNotifier } from './error/error_notifier_factory';
62+
63+
export type { Cache } from './utils/cache/cache';
64+
65+
export type {
66+
NotificationType,
67+
NotificationPayload,
68+
} from './notification_center/type';
69+
70+
export type { OptimizelyDecideOption } from './shared_types';
71+
72+
export type {
2273
UserAttributeValue,
2374
UserAttributes,
2475
OptimizelyConfig,
@@ -31,7 +82,6 @@ export {
3182
OptimizelyForcedDecision,
3283
EventTags,
3384
Event,
34-
EventDispatcher,
3585
DatafileOptions,
3686
UserProfileService,
3787
UserProfile,

‎lib/index.browser.ts‎

Lines changed: 14 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2016-2017, 2019-2024 Optimizely
2+
* Copyright 2016-2017, 2019-2025 Optimizely
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -13,36 +13,18 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
17-
import configValidator from './utils/config_validator';
18-
import defaultEventDispatcher from './event_processor/event_dispatcher/default_dispatcher.browser';
16+
import { Config, Client } from './shared_types';
1917
import sendBeaconEventDispatcher from './event_processor/event_dispatcher/send_beacon_dispatcher.browser';
20-
import * as enums from './utils/enums';
21-
import { OptimizelyDecideOption, Client, Config } from './shared_types';
22-
import Optimizely from './optimizely';
23-
import { UserAgentParser } from './odp/ua_parser/user_agent_parser';
24-
import { getUserAgentParser } from './odp/ua_parser/ua_parser.browser';
25-
import * as commonExports from './common_exports';
26-
import { PollingConfigManagerConfig } from './project_config/config_manager_factory';
27-
import { createPollingProjectConfigManager } from './project_config/config_manager_factory.browser';
28-
import { createBatchEventProcessor, createForwardingEventProcessor } from './event_processor/event_processor_factory.browser';
29-
import { createVuidManager } from './vuid/vuid_manager_factory.browser';
30-
import { createOdpManager } from './odp/odp_manager_factory.browser';
31-
import { UNABLE_TO_ATTACH_UNLOAD } from 'error_message';
32-
import { extractLogger, createLogger } from './logging/logger_factory';
33-
import { extractErrorNotifier, createErrorNotifier } from './error/error_notifier_factory';
34-
import { LoggerFacade } from './logging/logger';
35-
import { Maybe } from './utils/type';
3618
import { getOptimizelyInstance } from './client_factory';
37-
19+
import { EventDispatcher } from './event_processor/event_dispatcher/event_dispatcher';
3820

3921
/**
4022
* Creates an instance of the Optimizely class
4123
* @param {Config} config
4224
* @return {Client|null} the Optimizely client object
4325
* null on error
4426
*/
45-
const createInstance = function(config: Config): Client | null {
27+
export const createInstance = function(config: Config): Client | null {
4628
const client = getOptimizelyInstance(config);
4729

4830
if (client) {
@@ -58,24 +40,18 @@ const createInstance = function(config: Config): Client | null {
5840
return client;
5941
};
6042

61-
62-
export {
63-
defaultEventDispatcher as eventDispatcher,
64-
// sendBeaconEventDispatcher,
65-
enums,
66-
createInstance,
67-
OptimizelyDecideOption,
68-
UserAgentParser as IUserAgentParser,
69-
getUserAgentParser,
70-
createPollingProjectConfigManager,
71-
createForwardingEventProcessor,
72-
createBatchEventProcessor,
73-
createOdpManager,
74-
createVuidManager,
75-
createLogger,
76-
createErrorNotifier,
43+
export const getSendBeaconEventDispatcher = (): EventDispatcher => {
44+
return sendBeaconEventDispatcher;
7745
};
7846

47+
export { default as eventDispatcher } from './event_processor/event_dispatcher/default_dispatcher.browser';
48+
49+
export { createPollingProjectConfigManager } from './project_config/config_manager_factory.browser';
50+
export { createForwardingEventProcessor, createBatchEventProcessor } from './event_processor/event_processor_factory.browser';
51+
52+
export { createOdpManager } from './odp/odp_manager_factory.browser';
53+
export { createVuidManager } from './vuid/vuid_manager_factory.browser';
54+
7955
export * from './common_exports';
8056

8157
export * from './export_types';

‎lib/index.node.ts‎

Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2016-2017, 2019-2024 Optimizely
2+
* Copyright 2016-2017, 2019-2025 Optimizely
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -13,56 +13,38 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
17-
import * as enums from './utils/enums';
18-
import defaultEventDispatcher from './event_processor/event_dispatcher/default_dispatcher.node';
19-
import { createNotificationCenter } from './notification_center';
20-
import { OptimizelyDecideOption, Client, Config } from './shared_types';
21-
import * as commonExports from './common_exports';
22-
import { createPollingProjectConfigManager } from './project_config/config_manager_factory.node';
23-
import { createForwardingEventProcessor, createBatchEventProcessor } from './event_processor/event_processor_factory.node';
24-
import { createVuidManager } from './vuid/vuid_manager_factory.node';
25-
import { createOdpManager } from './odp/odp_manager_factory.node';
26-
import { extractLogger, createLogger } from './logging/logger_factory';
27-
import { extractErrorNotifier, createErrorNotifier } from './error/error_notifier_factory';
28-
import { Maybe } from './utils/type';
29-
import { LoggerFacade } from './logging/logger';
30-
import { ErrorNotifier } from './error/error_notifier';
16+
import { NODE_CLIENT_ENGINE } from './utils/enums';
17+
import { Client, Config } from './shared_types';
3118
import { getOptimizelyInstance } from './client_factory';
19+
import { EventDispatcher } from './event_processor/event_dispatcher/event_dispatcher';
3220

3321
/**
3422
* Creates an instance of the Optimizely class
3523
* @param {Config} config
3624
* @return {Client|null} the Optimizely client object
3725
* null on error
3826
*/
39-
const createInstance = function(config: Config): Client | null {
27+
export const createInstance = function(config: Config): Client | null {
4028
const nodeConfig = {
4129
...config,
42-
clientEnging: config.clientEngine || enums.NODE_CLIENT_ENGINE,
30+
clientEnging: config.clientEngine || NODE_CLIENT_ENGINE,
4331
}
4432

4533
return getOptimizelyInstance(nodeConfig);
4634
};
4735

48-
/**
49-
* Entry point into the Optimizely Node testing SDK
50-
*/
51-
export {
52-
defaultEventDispatcher as eventDispatcher,
53-
enums,
54-
createInstance,
55-
OptimizelyDecideOption,
56-
createPollingProjectConfigManager,
57-
createForwardingEventProcessor,
58-
createBatchEventProcessor,
59-
createOdpManager,
60-
createVuidManager,
61-
createLogger,
62-
createErrorNotifier,
36+
export const getSendBeaconEventDispatcher = function(): EventDispatcher {
37+
throw new Error('Send beacon event dispatcher is not supported in NodeJS');
6338
};
6439

65-
export * from './common_exports';
40+
export { default as eventDispatcher } from './event_processor/event_dispatcher/default_dispatcher.node';
6641

42+
export { createPollingProjectConfigManager } from './project_config/config_manager_factory.node';
43+
export { createForwardingEventProcessor, createBatchEventProcessor } from './event_processor/event_processor_factory.node';
44+
45+
export { createOdpManager } from './odp/odp_manager_factory.node';
46+
export { createVuidManager } from './vuid/vuid_manager_factory.node';
47+
48+
export * from './common_exports';
6749

6850
export * from './export_types';

0 commit comments

Comments
 (0)