@servicetitan/launchdarkly-service 28.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/dist/get-ld-client.d.ts +4 -0
  2. package/dist/get-ld-client.d.ts.map +1 -0
  3. package/dist/get-ld-client.js +11 -0
  4. package/dist/get-ld-client.js.map +1 -0
  5. package/dist/index.d.ts +5 -0
  6. package/dist/index.d.ts.map +1 -0
  7. package/dist/index.js +5 -0
  8. package/dist/index.js.map +1 -0
  9. package/dist/ld-provider.d.ts +8 -0
  10. package/dist/ld-provider.d.ts.map +1 -0
  11. package/dist/ld-provider.js +39 -0
  12. package/dist/ld-provider.js.map +1 -0
  13. package/dist/ld-service-provider.d.ts +3 -0
  14. package/dist/ld-service-provider.d.ts.map +1 -0
  15. package/dist/ld-service-provider.js +14 -0
  16. package/dist/ld-service-provider.js.map +1 -0
  17. package/dist/tests/get-ld-client.test.d.ts +2 -0
  18. package/dist/tests/get-ld-client.test.d.ts.map +1 -0
  19. package/dist/tests/get-ld-client.test.js +51 -0
  20. package/dist/tests/get-ld-client.test.js.map +1 -0
  21. package/dist/tests/ld-provider.test.d.ts +2 -0
  22. package/dist/tests/ld-provider.test.d.ts.map +1 -0
  23. package/dist/tests/ld-provider.test.js +113 -0
  24. package/dist/tests/ld-provider.test.js.map +1 -0
  25. package/dist/tests/ld-service-provider.test.d.ts +2 -0
  26. package/dist/tests/ld-service-provider.test.d.ts.map +1 -0
  27. package/dist/tests/ld-service-provider.test.js +33 -0
  28. package/dist/tests/ld-service-provider.test.js.map +1 -0
  29. package/dist/types.d.ts +11 -0
  30. package/dist/types.d.ts.map +1 -0
  31. package/dist/types.js +3 -0
  32. package/dist/types.js.map +1 -0
  33. package/package.json +41 -0
  34. package/src/get-ld-client.ts +13 -0
  35. package/src/index.ts +4 -0
  36. package/src/ld-provider.tsx +53 -0
  37. package/src/ld-service-provider.tsx +21 -0
  38. package/src/tests/get-ld-client.test.ts +75 -0
  39. package/src/tests/ld-provider.test.tsx +150 -0
  40. package/src/tests/ld-service-provider.test.tsx +49 -0
  41. package/src/types.ts +14 -0
@@ -0,0 +1,4 @@
1
+ import { LDClient } from 'launchdarkly-js-client-sdk';
2
+ import { ProviderConfig } from 'launchdarkly-react-client-sdk';
3
+ export declare function getLDClient({ clientSideID, context, options }: ProviderConfig): LDClient;
4
+ //# sourceMappingURL=get-ld-client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-ld-client.d.ts","sourceRoot":"","sources":["../src/get-ld-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAc,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAI/D,wBAAgB,WAAW,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,cAAc,YAO7E"}
@@ -0,0 +1,11 @@
1
+ import { initialize } from 'launchdarkly-js-client-sdk';
2
+ const ldClients = new Map();
3
+ export function getLDClient({ clientSideID, context, options }) {
4
+ let client = ldClients.get(clientSideID);
5
+ if (!client) {
6
+ client = initialize(clientSideID, context !== null && context !== void 0 ? context : { kind: 'user', anonymous: true }, options);
7
+ ldClients.set(clientSideID, client);
8
+ }
9
+ return client;
10
+ }
11
+ //# sourceMappingURL=get-ld-client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-ld-client.js","sourceRoot":"","sources":["../src/get-ld-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAGlE,MAAM,SAAS,GAA0B,IAAI,GAAG,EAAE,CAAC;AAEnD,MAAM,UAAU,WAAW,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAkB;IAC1E,IAAI,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,GAAG,UAAU,CAAC,YAAY,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QACzF,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC"}
@@ -0,0 +1,5 @@
1
+ export * from './get-ld-client';
2
+ export * from './ld-provider';
3
+ export * from './ld-service-provider';
4
+ export * from './types';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export * from './get-ld-client';
2
+ export * from './ld-provider';
3
+ export * from './ld-service-provider';
4
+ export * from './types';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC"}
@@ -0,0 +1,8 @@
1
+ import { ProviderConfig as BaseProviderConfig } from 'launchdarkly-react-client-sdk';
2
+ import { FC, PropsWithChildren } from 'react';
3
+ export type ProviderConfig = Pick<BaseProviderConfig, 'clientSideID' | 'context'> & {
4
+ projectName: string;
5
+ waitForInitialization?: boolean;
6
+ };
7
+ export declare const LDProvider: FC<PropsWithChildren<ProviderConfig>>;
8
+ //# sourceMappingURL=ld-provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-provider.d.ts","sourceRoot":"","sources":["../src/ld-provider.tsx"],"names":[],"mappings":"AAGA,OAAO,EAEH,cAAc,IAAI,kBAAkB,EACvC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAuB,MAAM,OAAO,CAAC;AAKnE,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,cAAc,GAAG,SAAS,CAAC,GAAG;IAChF,WAAW,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,EAAE,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAmC5D,CAAC"}
@@ -0,0 +1,39 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { Log } from '@servicetitan/log-service';
3
+ import { useOptionalDependencies } from '@servicetitan/react-ioc';
4
+ import { LDProvider as BaseLDProvider, } from 'launchdarkly-react-client-sdk';
5
+ import { useEffect, useState } from 'react';
6
+ import { getLDClient } from './get-ld-client';
7
+ import { LD_SERVICE_TOKEN } from './types';
8
+ export const LDProvider = props => {
9
+ const { children, clientSideID, context, projectName, waitForInitialization = true } = props;
10
+ const [ldClient, setLDClient] = useState();
11
+ const [ldService, log] = useOptionalDependencies(LD_SERVICE_TOKEN, Log);
12
+ useEffect(() => {
13
+ (async function initializeClient() {
14
+ var _a;
15
+ const config = { clientSideID, context };
16
+ const client = (_a = ldService === null || ldService === void 0 ? void 0 : ldService.getClient(config)) !== null && _a !== void 0 ? _a : getLDClient(config);
17
+ if (waitForInitialization) {
18
+ try {
19
+ await client.waitForInitialization(5);
20
+ }
21
+ catch (error) {
22
+ log === null || log === void 0 ? void 0 : log.error({
23
+ category: 'LaunchDarkly',
24
+ code: 'InitializationFailed',
25
+ error,
26
+ message: `"${projectName}" client failed to initialize`,
27
+ });
28
+ }
29
+ }
30
+ setLDClient(client);
31
+ })();
32
+ // eslint-disable-next-line react-hooks/exhaustive-deps
33
+ }, [clientSideID]); // only reload if clientSideID changes
34
+ if (!ldClient) {
35
+ return null;
36
+ }
37
+ return (_jsx(BaseLDProvider, { clientSideID: clientSideID, ldClient: ldClient, children: children }));
38
+ };
39
+ //# sourceMappingURL=ld-provider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-provider.js","sourceRoot":"","sources":["../src/ld-provider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAElE,OAAO,EACH,UAAU,IAAI,cAAc,GAE/B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAyB,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAO3C,MAAM,CAAC,MAAM,UAAU,GAA0C,KAAK,CAAC,EAAE;IACrE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,qBAAqB,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IAC7F,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,EAAY,CAAC;IACrD,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;IAExE,SAAS,CAAC,GAAG,EAAE;QACX,CAAC,KAAK,UAAU,gBAAgB;;YAC5B,MAAM,MAAM,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;YACzC,MAAM,MAAM,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,CAAC,MAAM,CAAC,mCAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YACnE,IAAI,qBAAqB,EAAE,CAAC;gBACxB,IAAI,CAAC;oBACD,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;gBAC1C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACb,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAC;wBACP,QAAQ,EAAE,cAAc;wBACxB,IAAI,EAAE,sBAAsB;wBAC5B,KAAK;wBACL,OAAO,EAAE,IAAI,WAAW,+BAA+B;qBAC1D,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YACD,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC,CAAC,EAAE,CAAC;QACL,uDAAuD;IAC3D,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,sCAAsC;IAE1D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CACH,KAAC,cAAc,IAAC,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,YACzD,QAAQ,GACI,CACpB,CAAC;AACN,CAAC,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { FC, PropsWithChildren } from 'react';
2
+ export declare const LDServiceProvider: FC<PropsWithChildren>;
3
+ //# sourceMappingURL=ld-service-provider.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-service-provider.d.ts","sourceRoot":"","sources":["../src/ld-service-provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAS9C,eAAO,MAAM,iBAAiB,EAAE,EAAE,CAAC,iBAAiB,CAUnD,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { Provider, useOptionalDependencies } from '@servicetitan/react-ioc';
3
+ import { getLDClient } from './get-ld-client';
4
+ import { LD_SERVICE_TOKEN } from './types';
5
+ const ldService = {
6
+ getClient: getLDClient,
7
+ };
8
+ export const LDServiceProvider = ({ children }) => {
9
+ if (useOptionalDependencies(LD_SERVICE_TOKEN)[0]) {
10
+ return children;
11
+ }
12
+ return (_jsx(Provider, { singletons: [{ provide: LD_SERVICE_TOKEN, useValue: ldService }], children: children }));
13
+ };
14
+ //# sourceMappingURL=ld-service-provider.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-service-provider.js","sourceRoot":"","sources":["../src/ld-service-provider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAG5E,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAa,MAAM,SAAS,CAAC;AAEtD,MAAM,SAAS,GAAc;IACzB,SAAS,EAAE,WAAW;CACzB,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAA0B,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IACrE,IAAI,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,OAAO,CACH,KAAC,QAAQ,IAAC,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,YACrE,QAAQ,GACF,CACd,CAAC;AACN,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=get-ld-client.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-ld-client.test.d.ts","sourceRoot":"","sources":["../../src/tests/get-ld-client.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,51 @@
1
+ import { initialize } from 'launchdarkly-js-client-sdk';
2
+ import { getLDClient } from '../get-ld-client';
3
+ jest.mock('launchdarkly-js-client-sdk', () => ({
4
+ initialize: jest.fn(),
5
+ }));
6
+ describe(`[launchdarkly-service] ${getLDClient.name}`, () => {
7
+ const mockClient = Symbol('mockClient');
8
+ let config;
9
+ const subject = () => getLDClient(config);
10
+ beforeEach(() => {
11
+ jest.clearAllMocks();
12
+ jest.mocked(initialize).mockImplementation(() => mockClient);
13
+ config = { clientSideID: makeId() };
14
+ });
15
+ function anonymousUserContext() {
16
+ return { kind: 'user', anonymous: true };
17
+ }
18
+ test('returns new LaunchDarkly client with anonymous user context', () => {
19
+ expect(subject()).toBe(mockClient);
20
+ expect(initialize).toHaveBeenCalledWith(config.clientSideID, anonymousUserContext(), undefined);
21
+ });
22
+ describe('when given a context', () => {
23
+ beforeEach(() => (config.context = { kind: 'multi' }));
24
+ test('initializes client with context', () => {
25
+ subject();
26
+ expect(initialize).toHaveBeenCalledWith(config.clientSideID, config.context, undefined);
27
+ });
28
+ });
29
+ describe('when given options', () => {
30
+ beforeEach(() => (config.options = { hash: 'foo' }));
31
+ test('initializes client with options', () => {
32
+ subject();
33
+ expect(initialize).toHaveBeenCalledWith(config.clientSideID, anonymousUserContext(), config.options);
34
+ });
35
+ });
36
+ describe('when client already exists', () => {
37
+ const existingClient = Symbol('existingClient');
38
+ beforeEach(() => {
39
+ jest.mocked(initialize).mockImplementationOnce(() => existingClient);
40
+ subject();
41
+ });
42
+ test('returns existing client', () => {
43
+ expect(subject()).toBe(existingClient);
44
+ expect(initialize).toHaveBeenCalledTimes(1);
45
+ });
46
+ });
47
+ });
48
+ function makeId() {
49
+ return Math.round(1e6 * Math.random()).toString(36);
50
+ }
51
+ //# sourceMappingURL=get-ld-client.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-ld-client.test.js","sourceRoot":"","sources":["../../src/tests/get-ld-client.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,IAAI,CAAC,IAAI,CAAC,4BAA4B,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3C,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;CACxB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,0BAA0B,WAAW,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IACxD,MAAM,UAAU,GAAQ,MAAM,CAAC,YAAY,CAAC,CAAC;IAC7C,IAAI,MAAyC,CAAC;IAE9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAE1C,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QAC7D,MAAM,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,SAAS,oBAAoB;QACzB,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnC,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,YAAY,EACnB,oBAAoB,EAAE,EACtB,SAAS,CACZ,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAClC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAEvD,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAChC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAErD,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CACnC,MAAM,CAAC,YAAY,EACnB,oBAAoB,EAAE,EACtB,MAAM,CAAC,OAAO,CACjB,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACxC,MAAM,cAAc,GAAQ,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAErD,UAAU,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,CAAC;YACrE,OAAO,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACvC,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,SAAS,MAAM;IACX,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACxD,CAAC"}
@@ -0,0 +1,2 @@
1
+ import '@testing-library/jest-dom';
2
+ //# sourceMappingURL=ld-provider.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-provider.test.d.ts","sourceRoot":"","sources":["../../src/tests/ld-provider.test.tsx"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}
@@ -0,0 +1,113 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import '@testing-library/jest-dom';
3
+ import { Log } from '@servicetitan/log-service';
4
+ import { Provider } from '@servicetitan/react-ioc';
5
+ import { render, screen, waitFor } from '@testing-library/react';
6
+ import { Fragment } from 'react';
7
+ import { getLDClient } from '../get-ld-client';
8
+ import { LDProvider } from '../ld-provider';
9
+ import { LD_SERVICE_TOKEN } from '../types';
10
+ function formatProps(props) {
11
+ return Object.entries(props).map(([key, value]) => {
12
+ return `${key}=${value.toString()}`;
13
+ });
14
+ }
15
+ function mockComponent(name) {
16
+ return {
17
+ [name]: ({ children, ...props }) => (_jsxs(Fragment, { children: [_jsx("div", { children: `<${name} ${formatProps(props)}>` }), children] })),
18
+ };
19
+ }
20
+ jest.mock('launchdarkly-react-client-sdk', () => ({
21
+ ...mockComponent('LDProvider'),
22
+ }));
23
+ jest.mock('../get-ld-client', () => ({
24
+ getLDClient: jest.fn(),
25
+ }));
26
+ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
27
+ const log = {
28
+ error: jest.fn(),
29
+ };
30
+ const ldClient = {
31
+ waitUntilReady: jest.fn().mockResolvedValue(undefined),
32
+ waitForInitialization: jest.fn().mockResolvedValue(undefined),
33
+ toString: () => 'ldClient',
34
+ };
35
+ let singletons;
36
+ let props;
37
+ const Component = () => {
38
+ return _jsx("div", { children: '<Component />' });
39
+ };
40
+ beforeEach(() => {
41
+ jest.clearAllMocks();
42
+ jest.mocked(getLDClient).mockReturnValue(ldClient);
43
+ singletons = [];
44
+ props = { clientSideID: 'foo', projectName: 'bar' };
45
+ });
46
+ const subject = () => {
47
+ return render(_jsx(Provider, { singletons: singletons, children: _jsx(LDProvider, { ...props, children: _jsx(Component, {}) }) }));
48
+ };
49
+ function expectLDProvider(props) {
50
+ if (props) {
51
+ expect(screen.getByText(`<LDProvider ${formatProps(props)}>`)).toBeInTheDocument();
52
+ }
53
+ else {
54
+ expect(screen.getByText(/<LDProvider .*>/)).toBeInTheDocument();
55
+ }
56
+ }
57
+ test('renders base LDProvider after client is ready and initialized', async () => {
58
+ subject();
59
+ await waitFor(() => expectLDProvider({ clientSideID: props.clientSideID, ldClient }));
60
+ expect(screen.getByText('<Component />')).toBeInTheDocument();
61
+ expect(ldClient.waitForInitialization).toHaveBeenCalled();
62
+ });
63
+ describe('when waitForInitialization is false', () => {
64
+ beforeEach(() => (props.waitForInitialization = false));
65
+ test('does not wait for client to initialize', async () => {
66
+ subject();
67
+ await waitFor(() => expectLDProvider());
68
+ expect(ldClient.waitForInitialization).not.toHaveBeenCalled();
69
+ });
70
+ });
71
+ describe('when initialization fails', () => {
72
+ beforeEach(() => {
73
+ var _a;
74
+ (_a = jest.mocked(ldClient.waitForInitialization)) === null || _a === void 0 ? void 0 : _a.mockRejectedValue('Oops!');
75
+ });
76
+ test('renders base LDProvider', async () => {
77
+ subject();
78
+ await waitFor(() => expectLDProvider());
79
+ });
80
+ describe('when log service is provided', () => {
81
+ beforeEach(() => singletons.push({ provide: Log, useValue: log }));
82
+ test('logs error', async () => {
83
+ subject();
84
+ await waitFor(() => expectLDProvider());
85
+ expect(log.error).toHaveBeenCalledWith({
86
+ category: 'LaunchDarkly',
87
+ code: 'InitializationFailed',
88
+ error: 'Oops!',
89
+ message: `"${props.projectName}" client failed to initialize`,
90
+ });
91
+ });
92
+ });
93
+ });
94
+ describe('when LDService is provided', () => {
95
+ const ldServiceClient = {
96
+ waitUntilReady: jest.fn().mockResolvedValue(undefined),
97
+ waitForInitialization: jest.fn().mockResolvedValue(undefined),
98
+ toString: () => 'ldServiceClient',
99
+ };
100
+ const ldService = {
101
+ getClient: jest.fn().mockReturnValue(ldServiceClient),
102
+ };
103
+ beforeEach(() => {
104
+ singletons === null || singletons === void 0 ? void 0 : singletons.push({ provide: LD_SERVICE_TOKEN, useValue: ldService });
105
+ });
106
+ test('uses LDService client', async () => {
107
+ subject();
108
+ await waitFor(() => expectLDProvider({ clientSideID: props.clientSideID, ldClient: ldServiceClient }));
109
+ expect(ldServiceClient.waitForInitialization).toHaveBeenCalled();
110
+ });
111
+ });
112
+ });
113
+ //# sourceMappingURL=ld-provider.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-provider.test.js","sourceRoot":"","sources":["../../src/tests/ld-provider.test.tsx"],"names":[],"mappings":";AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,2BAA2B,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjE,OAAO,EAAM,QAAQ,EAAE,MAAM,OAAO,CAAC;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAa,MAAM,UAAU,CAAC;AAEvD,SAAS,WAAW,CAAC,KAA0B;IAC3C,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,OAAO,GAAG,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IAC/B,OAAO;QACH,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAO,EAAE,EAAE,CAAC,CACrC,MAAC,QAAQ,eACL,wBAAM,IAAI,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,GAAO,EAC7C,QAAQ,IACF,CACd;KACJ,CAAC;AACN,CAAC;AACD,IAAI,CAAC,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9C,GAAG,aAAa,CAAC,YAAY,CAAC;CACjC,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC;IACjC,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE;CACzB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,0BAA0B,UAAU,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IACvD,MAAM,GAAG,GAAiB;QACtB,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;KACnB,CAAC;IACF,MAAM,QAAQ,GAAmD;QAC7D,cAAc,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;QACtD,qBAAqB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAC7D,QAAQ,EAAE,GAAG,EAAE,CAAC,UAAU;KAC7B,CAAC;IACF,IAAI,UAAkE,CAAC;IACvE,IAAI,KAAuC,CAAC;IAE5C,MAAM,SAAS,GAAO,GAAG,EAAE;QACvB,OAAO,wBAAM,eAAe,GAAO,CAAC;IACxC,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,QAAoB,CAAC,CAAC;QAC/D,UAAU,GAAG,EAAE,CAAC;QAChB,KAAK,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAG,EAAE;QACjB,OAAO,MAAM,CACT,KAAC,QAAQ,IAAC,UAAU,EAAE,UAAU,YAC5B,KAAC,UAAU,OAAK,KAAK,YACjB,KAAC,SAAS,KAAG,GACJ,GACN,CACd,CAAC;IACN,CAAC,CAAC;IAEF,SAAS,gBAAgB,CAAC,KAA2B;QACjD,IAAI,KAAK,EAAE,CAAC;YACR,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACvF,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACpE,CAAC;IACL,CAAC;IAED,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,OAAO,EAAE,CAAC;QAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAEtF,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAC9D,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;QACjD,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,OAAO,EAAE,CAAC;YAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAExC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QAClE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACvC,UAAU,CAAC,GAAG,EAAE;;YACZ,MAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;YACvC,OAAO,EAAE,CAAC;YAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;YAC1C,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;YAEnE,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;gBAC1B,OAAO,EAAE,CAAC;gBAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;gBAExC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC;oBACnC,QAAQ,EAAE,cAAc;oBACxB,IAAI,EAAE,sBAAsB;oBAC5B,KAAK,EAAE,OAAO;oBACd,OAAO,EAAE,IAAI,KAAK,CAAC,WAAW,+BAA+B;iBAChE,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACxC,MAAM,eAAe,GAAmD;YACpE,cAAc,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;YACtD,qBAAqB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;YAC7D,QAAQ,EAAE,GAAG,EAAE,CAAC,iBAAiB;SACpC,CAAC;QACF,MAAM,SAAS,GAAc;YACzB,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,eAAe,CAAC;SACxD,CAAC;QAEF,UAAU,CAAC,GAAG,EAAE;YACZ,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,OAAO,EAAE,CAAC;YAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CACf,gBAAgB,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CACpF,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=ld-service-provider.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-service-provider.test.d.ts","sourceRoot":"","sources":["../../src/tests/ld-service-provider.test.tsx"],"names":[],"mappings":""}
@@ -0,0 +1,33 @@
1
+ import { jsx as _jsx } from "react/jsx-runtime";
2
+ import { Provider, useDependencies } from '@servicetitan/react-ioc';
3
+ import { render } from '@testing-library/react';
4
+ import { getLDClient } from '../get-ld-client';
5
+ import { LDServiceProvider } from '../ld-service-provider';
6
+ import { LD_SERVICE_TOKEN } from '../types';
7
+ describe(`[launchdarkly-service] ${LDServiceProvider.name}`, () => {
8
+ let providedLDService;
9
+ let singletons;
10
+ const Component = () => {
11
+ [providedLDService] = useDependencies(LD_SERVICE_TOKEN);
12
+ return null;
13
+ };
14
+ beforeEach(() => (singletons = []));
15
+ const subject = () => {
16
+ return render(_jsx(Provider, { singletons: singletons, children: _jsx(LDServiceProvider, { children: _jsx(Component, {}) }) }));
17
+ };
18
+ test('provides LDService instance', () => {
19
+ subject();
20
+ expect(providedLDService).toEqual({
21
+ getClient: getLDClient,
22
+ });
23
+ });
24
+ describe('when LDService is already provided', () => {
25
+ const ldService = Symbol('ldService');
26
+ beforeEach(() => singletons === null || singletons === void 0 ? void 0 : singletons.push({ provide: LD_SERVICE_TOKEN, useValue: ldService }));
27
+ test('provides existing LDService', () => {
28
+ subject();
29
+ expect(providedLDService).toBe(ldService);
30
+ });
31
+ });
32
+ });
33
+ //# sourceMappingURL=ld-service-provider.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ld-service-provider.test.js","sourceRoot":"","sources":["../../src/tests/ld-service-provider.test.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAa,MAAM,UAAU,CAAC;AAEvD,QAAQ,CAAC,0BAA0B,iBAAiB,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IAC9D,IAAI,iBAA4B,CAAC;IACjC,IAAI,UAAwD,CAAC;IAE7D,MAAM,SAAS,GAAO,GAAG,EAAE;QACvB,CAAC,iBAAiB,CAAC,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC,CAAC;IAEpC,MAAM,OAAO,GAAG,GAAG,EAAE;QACjB,OAAO,MAAM,CACT,KAAC,QAAQ,IAAC,UAAU,EAAE,UAAU,YAC5B,KAAC,iBAAiB,cACd,KAAC,SAAS,KAAG,GACG,GACb,CACd,CAAC;IACN,CAAC,CAAC;IAEF,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,OAAO,EAAE,CAAC;QAEV,MAAM,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;YAC9B,SAAS,EAAE,WAAW;SACzB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAChD,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAEtC,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;QAEvF,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { type LDContext, type LDClient, type LDOptions } from 'launchdarkly-js-client-sdk';
2
+ export declare const LD_SERVICE_TOKEN: import("@servicetitan/react-ioc").SymbolToken<LDService>;
3
+ export interface ClientConfig {
4
+ clientSideID: string;
5
+ context?: LDContext;
6
+ options?: LDOptions;
7
+ }
8
+ export interface LDService {
9
+ getClient: (config: ClientConfig) => LDClient;
10
+ }
11
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE3F,eAAO,MAAM,gBAAgB,0DAA6C,CAAC;AAE3E,MAAM,WAAW,YAAY;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACtB,SAAS,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,QAAQ,CAAC;CACjD"}
package/dist/types.js ADDED
@@ -0,0 +1,3 @@
1
+ import { symbolToken } from '@servicetitan/react-ioc';
2
+ export const LD_SERVICE_TOKEN = symbolToken('LD_SERVICE_TOKEN');
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAGtD,MAAM,CAAC,MAAM,gBAAgB,GAAG,WAAW,CAAY,kBAAkB,CAAC,CAAC"}
package/package.json ADDED
@@ -0,0 +1,41 @@
1
+ {
2
+ "name": "@servicetitan/launchdarkly-service",
3
+ "version": "28.2.0",
4
+ "description": "",
5
+ "homepage": "https://docs.st.dev/docs/frontend/launchdarkly-service",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/servicetitan/uikit.git",
9
+ "directory": "packages/launchdarkly-service"
10
+ },
11
+ "main": "./dist/index.js",
12
+ "typings": "./dist/index.d.ts",
13
+ "sideEffects": false,
14
+ "files": [
15
+ "dist",
16
+ "src"
17
+ ],
18
+ "devDependencies": {
19
+ "@servicetitan/log-service": "28.2.0",
20
+ "@servicetitan/react-ioc": "28.2.0",
21
+ "@testing-library/dom": "^10.4.0",
22
+ "@testing-library/react": "^16.0.1",
23
+ "launchdarkly-js-client-sdk": "3.5.0",
24
+ "launchdarkly-react-client-sdk": "^3.6.0",
25
+ "react": "~18.3.1"
26
+ },
27
+ "peerDependencies": {
28
+ "@servicetitan/log-service": "28.2.0",
29
+ "@servicetitan/react-ioc": "28.2.0",
30
+ "launchdarkly-js-client-sdk": "3.5.0",
31
+ "launchdarkly-react-client-sdk": "^3.6.0",
32
+ "react": ">=17.0.2"
33
+ },
34
+ "publishConfig": {
35
+ "access": "public"
36
+ },
37
+ "cli": {
38
+ "webpack": false
39
+ },
40
+ "gitHead": "df48bdf4994bce3971c7e4f099eeb11ebb4945e6"
41
+ }
@@ -0,0 +1,13 @@
1
+ import { LDClient, initialize } from 'launchdarkly-js-client-sdk';
2
+ import { ProviderConfig } from 'launchdarkly-react-client-sdk';
3
+
4
+ const ldClients: Map<string, LDClient> = new Map();
5
+
6
+ export function getLDClient({ clientSideID, context, options }: ProviderConfig) {
7
+ let client = ldClients.get(clientSideID);
8
+ if (!client) {
9
+ client = initialize(clientSideID, context ?? { kind: 'user', anonymous: true }, options);
10
+ ldClients.set(clientSideID, client);
11
+ }
12
+ return client;
13
+ }
package/src/index.ts ADDED
@@ -0,0 +1,4 @@
1
+ export * from './get-ld-client';
2
+ export * from './ld-provider';
3
+ export * from './ld-service-provider';
4
+ export * from './types';
@@ -0,0 +1,53 @@
1
+ import { Log } from '@servicetitan/log-service';
2
+ import { useOptionalDependencies } from '@servicetitan/react-ioc';
3
+ import { LDClient } from 'launchdarkly-js-client-sdk';
4
+ import {
5
+ LDProvider as BaseLDProvider,
6
+ ProviderConfig as BaseProviderConfig,
7
+ } from 'launchdarkly-react-client-sdk';
8
+ import { FC, PropsWithChildren, useEffect, useState } from 'react';
9
+
10
+ import { getLDClient } from './get-ld-client';
11
+ import { LD_SERVICE_TOKEN } from './types';
12
+
13
+ export type ProviderConfig = Pick<BaseProviderConfig, 'clientSideID' | 'context'> & {
14
+ projectName: string;
15
+ waitForInitialization?: boolean;
16
+ };
17
+
18
+ export const LDProvider: FC<PropsWithChildren<ProviderConfig>> = props => {
19
+ const { children, clientSideID, context, projectName, waitForInitialization = true } = props;
20
+ const [ldClient, setLDClient] = useState<LDClient>();
21
+ const [ldService, log] = useOptionalDependencies(LD_SERVICE_TOKEN, Log);
22
+
23
+ useEffect(() => {
24
+ (async function initializeClient() {
25
+ const config = { clientSideID, context };
26
+ const client = ldService?.getClient(config) ?? getLDClient(config);
27
+ if (waitForInitialization) {
28
+ try {
29
+ await client.waitForInitialization(5);
30
+ } catch (error) {
31
+ log?.error({
32
+ category: 'LaunchDarkly',
33
+ code: 'InitializationFailed',
34
+ error,
35
+ message: `"${projectName}" client failed to initialize`,
36
+ });
37
+ }
38
+ }
39
+ setLDClient(client);
40
+ })();
41
+ // eslint-disable-next-line react-hooks/exhaustive-deps
42
+ }, [clientSideID]); // only reload if clientSideID changes
43
+
44
+ if (!ldClient) {
45
+ return null;
46
+ }
47
+
48
+ return (
49
+ <BaseLDProvider clientSideID={clientSideID} ldClient={ldClient}>
50
+ {children}
51
+ </BaseLDProvider>
52
+ );
53
+ };
@@ -0,0 +1,21 @@
1
+ import { Provider, useOptionalDependencies } from '@servicetitan/react-ioc';
2
+ import { FC, PropsWithChildren } from 'react';
3
+
4
+ import { getLDClient } from './get-ld-client';
5
+ import { LD_SERVICE_TOKEN, LDService } from './types';
6
+
7
+ const ldService: LDService = {
8
+ getClient: getLDClient,
9
+ };
10
+
11
+ export const LDServiceProvider: FC<PropsWithChildren> = ({ children }) => {
12
+ if (useOptionalDependencies(LD_SERVICE_TOKEN)[0]) {
13
+ return children;
14
+ }
15
+
16
+ return (
17
+ <Provider singletons={[{ provide: LD_SERVICE_TOKEN, useValue: ldService }]}>
18
+ {children}
19
+ </Provider>
20
+ );
21
+ };
@@ -0,0 +1,75 @@
1
+ import { initialize } from 'launchdarkly-js-client-sdk';
2
+
3
+ import { getLDClient } from '../get-ld-client';
4
+
5
+ jest.mock('launchdarkly-js-client-sdk', () => ({
6
+ initialize: jest.fn(),
7
+ }));
8
+
9
+ describe(`[launchdarkly-service] ${getLDClient.name}`, () => {
10
+ const mockClient: any = Symbol('mockClient');
11
+ let config: Parameters<typeof getLDClient>[0];
12
+
13
+ const subject = () => getLDClient(config);
14
+
15
+ beforeEach(() => {
16
+ jest.clearAllMocks();
17
+ jest.mocked(initialize).mockImplementation(() => mockClient);
18
+ config = { clientSideID: makeId() };
19
+ });
20
+
21
+ function anonymousUserContext() {
22
+ return { kind: 'user', anonymous: true };
23
+ }
24
+
25
+ test('returns new LaunchDarkly client with anonymous user context', () => {
26
+ expect(subject()).toBe(mockClient);
27
+ expect(initialize).toHaveBeenCalledWith(
28
+ config.clientSideID,
29
+ anonymousUserContext(),
30
+ undefined
31
+ );
32
+ });
33
+
34
+ describe('when given a context', () => {
35
+ beforeEach(() => (config.context = { kind: 'multi' }));
36
+
37
+ test('initializes client with context', () => {
38
+ subject();
39
+
40
+ expect(initialize).toHaveBeenCalledWith(config.clientSideID, config.context, undefined);
41
+ });
42
+ });
43
+
44
+ describe('when given options', () => {
45
+ beforeEach(() => (config.options = { hash: 'foo' }));
46
+
47
+ test('initializes client with options', () => {
48
+ subject();
49
+
50
+ expect(initialize).toHaveBeenCalledWith(
51
+ config.clientSideID,
52
+ anonymousUserContext(),
53
+ config.options
54
+ );
55
+ });
56
+ });
57
+
58
+ describe('when client already exists', () => {
59
+ const existingClient: any = Symbol('existingClient');
60
+
61
+ beforeEach(() => {
62
+ jest.mocked(initialize).mockImplementationOnce(() => existingClient);
63
+ subject();
64
+ });
65
+
66
+ test('returns existing client', () => {
67
+ expect(subject()).toBe(existingClient);
68
+ expect(initialize).toHaveBeenCalledTimes(1);
69
+ });
70
+ });
71
+ });
72
+
73
+ function makeId() {
74
+ return Math.round(1e6 * Math.random()).toString(36);
75
+ }
@@ -0,0 +1,150 @@
1
+ import '@testing-library/jest-dom';
2
+ import { Log } from '@servicetitan/log-service';
3
+ import { Provider } from '@servicetitan/react-ioc';
4
+ import { render, screen, waitFor } from '@testing-library/react';
5
+ import { LDClient } from 'launchdarkly-js-client-sdk';
6
+ import { FC, Fragment } from 'react';
7
+
8
+ import { getLDClient } from '../get-ld-client';
9
+ import { LDProvider } from '../ld-provider';
10
+ import { LD_SERVICE_TOKEN, LDService } from '../types';
11
+
12
+ function formatProps(props: Record<string, any>) {
13
+ return Object.entries(props).map(([key, value]) => {
14
+ return `${key}=${value.toString()}`;
15
+ });
16
+ }
17
+
18
+ function mockComponent(name: string) {
19
+ return {
20
+ [name]: ({ children, ...props }: any) => (
21
+ <Fragment>
22
+ <div>{`<${name} ${formatProps(props)}>`}</div>
23
+ {children}
24
+ </Fragment>
25
+ ),
26
+ };
27
+ }
28
+ jest.mock('launchdarkly-react-client-sdk', () => ({
29
+ ...mockComponent('LDProvider'),
30
+ }));
31
+ jest.mock('../get-ld-client', () => ({
32
+ getLDClient: jest.fn(),
33
+ }));
34
+
35
+ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
36
+ const log: Partial<Log> = {
37
+ error: jest.fn(),
38
+ };
39
+ const ldClient: Partial<LDClient> & { toString: () => string } = {
40
+ waitUntilReady: jest.fn().mockResolvedValue(undefined),
41
+ waitForInitialization: jest.fn().mockResolvedValue(undefined),
42
+ toString: () => 'ldClient',
43
+ };
44
+ let singletons: Required<Parameters<typeof Provider>[0]>['singletons'];
45
+ let props: Parameters<typeof LDProvider>[0];
46
+
47
+ const Component: FC = () => {
48
+ return <div>{'<Component />'}</div>;
49
+ };
50
+
51
+ beforeEach(() => {
52
+ jest.clearAllMocks();
53
+ jest.mocked(getLDClient).mockReturnValue(ldClient as LDClient);
54
+ singletons = [];
55
+ props = { clientSideID: 'foo', projectName: 'bar' };
56
+ });
57
+
58
+ const subject = () => {
59
+ return render(
60
+ <Provider singletons={singletons}>
61
+ <LDProvider {...props}>
62
+ <Component />
63
+ </LDProvider>
64
+ </Provider>
65
+ );
66
+ };
67
+
68
+ function expectLDProvider(props?: Record<string, any>) {
69
+ if (props) {
70
+ expect(screen.getByText(`<LDProvider ${formatProps(props)}>`)).toBeInTheDocument();
71
+ } else {
72
+ expect(screen.getByText(/<LDProvider .*>/)).toBeInTheDocument();
73
+ }
74
+ }
75
+
76
+ test('renders base LDProvider after client is ready and initialized', async () => {
77
+ subject();
78
+
79
+ await waitFor(() => expectLDProvider({ clientSideID: props.clientSideID, ldClient }));
80
+
81
+ expect(screen.getByText('<Component />')).toBeInTheDocument();
82
+ expect(ldClient.waitForInitialization).toHaveBeenCalled();
83
+ });
84
+
85
+ describe('when waitForInitialization is false', () => {
86
+ beforeEach(() => (props.waitForInitialization = false));
87
+
88
+ test('does not wait for client to initialize', async () => {
89
+ subject();
90
+
91
+ await waitFor(() => expectLDProvider());
92
+
93
+ expect(ldClient.waitForInitialization).not.toHaveBeenCalled();
94
+ });
95
+ });
96
+
97
+ describe('when initialization fails', () => {
98
+ beforeEach(() => {
99
+ jest.mocked(ldClient.waitForInitialization)?.mockRejectedValue('Oops!');
100
+ });
101
+
102
+ test('renders base LDProvider', async () => {
103
+ subject();
104
+
105
+ await waitFor(() => expectLDProvider());
106
+ });
107
+
108
+ describe('when log service is provided', () => {
109
+ beforeEach(() => singletons.push({ provide: Log, useValue: log }));
110
+
111
+ test('logs error', async () => {
112
+ subject();
113
+
114
+ await waitFor(() => expectLDProvider());
115
+
116
+ expect(log.error).toHaveBeenCalledWith({
117
+ category: 'LaunchDarkly',
118
+ code: 'InitializationFailed',
119
+ error: 'Oops!',
120
+ message: `"${props.projectName}" client failed to initialize`,
121
+ });
122
+ });
123
+ });
124
+ });
125
+
126
+ describe('when LDService is provided', () => {
127
+ const ldServiceClient: Partial<LDClient> & { toString: () => string } = {
128
+ waitUntilReady: jest.fn().mockResolvedValue(undefined),
129
+ waitForInitialization: jest.fn().mockResolvedValue(undefined),
130
+ toString: () => 'ldServiceClient',
131
+ };
132
+ const ldService: LDService = {
133
+ getClient: jest.fn().mockReturnValue(ldServiceClient),
134
+ };
135
+
136
+ beforeEach(() => {
137
+ singletons?.push({ provide: LD_SERVICE_TOKEN, useValue: ldService });
138
+ });
139
+
140
+ test('uses LDService client', async () => {
141
+ subject();
142
+
143
+ await waitFor(() =>
144
+ expectLDProvider({ clientSideID: props.clientSideID, ldClient: ldServiceClient })
145
+ );
146
+
147
+ expect(ldServiceClient.waitForInitialization).toHaveBeenCalled();
148
+ });
149
+ });
150
+ });
@@ -0,0 +1,49 @@
1
+ import { Provider, useDependencies } from '@servicetitan/react-ioc';
2
+ import { render } from '@testing-library/react';
3
+ import { FC } from 'react';
4
+
5
+ import { getLDClient } from '../get-ld-client';
6
+ import { LDServiceProvider } from '../ld-service-provider';
7
+ import { LD_SERVICE_TOKEN, LDService } from '../types';
8
+
9
+ describe(`[launchdarkly-service] ${LDServiceProvider.name}`, () => {
10
+ let providedLDService: LDService;
11
+ let singletons: Parameters<typeof Provider>[0]['singletons'];
12
+
13
+ const Component: FC = () => {
14
+ [providedLDService] = useDependencies(LD_SERVICE_TOKEN);
15
+ return null;
16
+ };
17
+
18
+ beforeEach(() => (singletons = []));
19
+
20
+ const subject = () => {
21
+ return render(
22
+ <Provider singletons={singletons}>
23
+ <LDServiceProvider>
24
+ <Component />
25
+ </LDServiceProvider>
26
+ </Provider>
27
+ );
28
+ };
29
+
30
+ test('provides LDService instance', () => {
31
+ subject();
32
+
33
+ expect(providedLDService).toEqual({
34
+ getClient: getLDClient,
35
+ });
36
+ });
37
+
38
+ describe('when LDService is already provided', () => {
39
+ const ldService = Symbol('ldService');
40
+
41
+ beforeEach(() => singletons?.push({ provide: LD_SERVICE_TOKEN, useValue: ldService }));
42
+
43
+ test('provides existing LDService', () => {
44
+ subject();
45
+
46
+ expect(providedLDService).toBe(ldService);
47
+ });
48
+ });
49
+ });
package/src/types.ts ADDED
@@ -0,0 +1,14 @@
1
+ import { symbolToken } from '@servicetitan/react-ioc';
2
+ import { type LDContext, type LDClient, type LDOptions } from 'launchdarkly-js-client-sdk';
3
+
4
+ export const LD_SERVICE_TOKEN = symbolToken<LDService>('LD_SERVICE_TOKEN');
5
+
6
+ export interface ClientConfig {
7
+ clientSideID: string;
8
+ context?: LDContext;
9
+ options?: LDOptions;
10
+ }
11
+
12
+ export interface LDService {
13
+ getClient: (config: ClientConfig) => LDClient;
14
+ }