@servicetitan/launchdarkly-service 28.2.0 → 28.3.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.
- package/dist/create-flag-keys.d.ts +7 -0
- package/dist/create-flag-keys.d.ts.map +1 -0
- package/dist/create-flag-keys.js +4 -0
- package/dist/create-flag-keys.js.map +1 -0
- package/dist/feature-flag-provider.d.ts +3 -0
- package/dist/feature-flag-provider.d.ts.map +1 -0
- package/dist/feature-flag-provider.js +13 -0
- package/dist/feature-flag-provider.js.map +1 -0
- package/dist/feature-flag-store.d.ts +7 -0
- package/dist/feature-flag-store.d.ts.map +1 -0
- package/dist/feature-flag-store.js +42 -0
- package/dist/feature-flag-store.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/ld-provider.d.ts.map +1 -1
- package/dist/ld-provider.js +18 -5
- package/dist/ld-provider.js.map +1 -1
- package/dist/tests/feature-flag-provider.test.d.ts +2 -0
- package/dist/tests/feature-flag-provider.test.d.ts.map +1 -0
- package/dist/tests/feature-flag-provider.test.js +32 -0
- package/dist/tests/feature-flag-provider.test.js.map +1 -0
- package/dist/tests/feature-flag-store.test.d.ts +2 -0
- package/dist/tests/feature-flag-store.test.d.ts.map +1 -0
- package/dist/tests/feature-flag-store.test.js +27 -0
- package/dist/tests/feature-flag-store.test.js.map +1 -0
- package/dist/tests/ld-provider.test.js +45 -7
- package/dist/tests/ld-provider.test.js.map +1 -1
- package/dist/tests/with-feature-flag.test.d.ts +2 -0
- package/dist/tests/with-feature-flag.test.d.ts.map +1 -0
- package/dist/tests/with-feature-flag.test.js +65 -0
- package/dist/tests/with-feature-flag.test.js.map +1 -0
- package/dist/types.d.ts +3 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/with-feature-flag.d.ts +18 -0
- package/dist/with-feature-flag.d.ts.map +1 -0
- package/dist/with-feature-flag.js +12 -0
- package/dist/with-feature-flag.js.map +1 -0
- package/package.json +10 -7
- package/src/create-flag-keys.ts +9 -0
- package/src/feature-flag-provider.tsx +16 -0
- package/src/feature-flag-store.ts +18 -0
- package/src/index.ts +3 -0
- package/src/ld-provider.tsx +20 -6
- package/src/tests/feature-flag-provider.test.tsx +48 -0
- package/src/tests/feature-flag-store.test.ts +38 -0
- package/src/tests/ld-provider.test.tsx +58 -7
- package/src/tests/with-feature-flag.test.tsx +89 -0
- package/src/types.ts +4 -0
- package/src/with-feature-flag.tsx +28 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-flag-keys.d.ts","sourceRoot":"","sources":["../src/create-flag-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,KAAK,QAAQ,CAAC,CAAC,IAAI;KACd,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;CAChC,CAAC;AAEF,wBAAgB,cAAc,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAEnE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-flag-keys.js","sourceRoot":"","sources":["../src/create-flag-keys.ts"],"names":[],"mappings":"AAMA,MAAM,UAAU,cAAc,CAAI,GAAG,IAAiB;IAClD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAiB,CAAC,CAAC;AACxF,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-provider.d.ts","sourceRoot":"","sources":["../src/feature-flag-provider.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAa,MAAM,OAAO,CAAC;AAIrD,wBAAgB,mBAAmB,CAAC,EAAE,QAAQ,EAAE,EAAE,iBAAiB,6BASlE"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { useDependencies } from '@servicetitan/react-ioc';
|
|
2
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
3
|
+
import { useEffect } from 'react';
|
|
4
|
+
import { FeatureFlagStore } from './feature-flag-store';
|
|
5
|
+
export function FeatureFlagProvider({ children }) {
|
|
6
|
+
const [{ setFlags }] = useDependencies(FeatureFlagStore);
|
|
7
|
+
const flags = useFlags();
|
|
8
|
+
useEffect(() => {
|
|
9
|
+
setFlags(flags);
|
|
10
|
+
}, [flags, setFlags]);
|
|
11
|
+
return children;
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=feature-flag-provider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-provider.js","sourceRoot":"","sources":["../src/feature-flag-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAqB,SAAS,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,MAAM,UAAU,mBAAmB,CAAC,EAAE,QAAQ,EAAqB;IAC/D,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;IAEzB,SAAS,CAAC,GAAG,EAAE;QACX,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEtB,OAAO,QAAQ,CAAC;AACpB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-store.d.ts","sourceRoot":"","sources":["../src/feature-flag-store.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAG1D,qBACa,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAE7C,KAAK,EAAE,CAAC,CAAmB;;IAOvC,QAAQ,CAAC,KAAK,EAAE,CAAC;CAGpB"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import { injectable } from '@servicetitan/react-ioc';
|
|
11
|
+
import { action, makeObservable, observable } from 'mobx';
|
|
12
|
+
let FeatureFlagStore = class FeatureFlagStore {
|
|
13
|
+
constructor() {
|
|
14
|
+
// @ts-expect-error because 'LDFlagSet' is assignable to the constraint of type 'T', but 'T' could be instantiated with a different subtype of constraint
|
|
15
|
+
Object.defineProperty(this, "flags", {
|
|
16
|
+
enumerable: true,
|
|
17
|
+
configurable: true,
|
|
18
|
+
writable: true,
|
|
19
|
+
value: {}
|
|
20
|
+
});
|
|
21
|
+
makeObservable(this);
|
|
22
|
+
}
|
|
23
|
+
setFlags(flags) {
|
|
24
|
+
this.flags = flags;
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
__decorate([
|
|
28
|
+
observable,
|
|
29
|
+
__metadata("design:type", Object)
|
|
30
|
+
], FeatureFlagStore.prototype, "flags", void 0);
|
|
31
|
+
__decorate([
|
|
32
|
+
action,
|
|
33
|
+
__metadata("design:type", Function),
|
|
34
|
+
__metadata("design:paramtypes", [Object]),
|
|
35
|
+
__metadata("design:returntype", void 0)
|
|
36
|
+
], FeatureFlagStore.prototype, "setFlags", null);
|
|
37
|
+
FeatureFlagStore = __decorate([
|
|
38
|
+
injectable(),
|
|
39
|
+
__metadata("design:paramtypes", [])
|
|
40
|
+
], FeatureFlagStore);
|
|
41
|
+
export { FeatureFlagStore };
|
|
42
|
+
//# sourceMappingURL=feature-flag-store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-store.js","sourceRoot":"","sources":["../src/feature-flag-store.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAGnD,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAIzB;QAHA,yJAAyJ;QAC7I;;;;mBAAW,EAAe;WAAC;QAGnC,cAAc,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAGD,QAAQ,CAAC,KAAQ;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;CACJ,CAAA;AAVe;IAAX,UAAU;;+CAA4B;AAOvC;IADC,MAAM;;;;gDAGN;AAXQ,gBAAgB;IAD5B,UAAU,EAAE;;GACA,gBAAgB,CAY5B"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
+
export * from './create-flag-keys';
|
|
2
|
+
export * from './feature-flag-store';
|
|
1
3
|
export * from './get-ld-client';
|
|
2
4
|
export * from './ld-provider';
|
|
3
5
|
export * from './ld-service-provider';
|
|
4
6
|
export * from './types';
|
|
7
|
+
export * from './with-feature-flag';
|
|
5
8
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +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"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
+
export * from './create-flag-keys';
|
|
2
|
+
export * from './feature-flag-store';
|
|
1
3
|
export * from './get-ld-client';
|
|
2
4
|
export * from './ld-provider';
|
|
3
5
|
export * from './ld-service-provider';
|
|
4
6
|
export * from './types';
|
|
7
|
+
export * from './with-feature-flag';
|
|
5
8
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +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"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}
|
|
@@ -1 +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,
|
|
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,EAAmC,MAAM,OAAO,CAAC;AAO/E,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,CA+C3D,CAAC"}
|
package/dist/ld-provider.js
CHANGED
|
@@ -1,14 +1,19 @@
|
|
|
1
1
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
2
|
import { Log } from '@servicetitan/log-service';
|
|
3
|
-
import { useOptionalDependencies } from '@servicetitan/react-ioc';
|
|
3
|
+
import { provide, useOptionalDependencies } from '@servicetitan/react-ioc';
|
|
4
4
|
import { LDProvider as BaseLDProvider, } from 'launchdarkly-react-client-sdk';
|
|
5
|
-
import { useEffect, useState } from 'react';
|
|
5
|
+
import { useEffect, useReducer, useState } from 'react';
|
|
6
|
+
import { FeatureFlagProvider } from './feature-flag-provider';
|
|
7
|
+
import { FeatureFlagStore } from './feature-flag-store';
|
|
6
8
|
import { getLDClient } from './get-ld-client';
|
|
7
9
|
import { LD_SERVICE_TOKEN } from './types';
|
|
8
|
-
export const LDProvider =
|
|
10
|
+
export const LDProvider = provide({
|
|
11
|
+
singletons: [FeatureFlagStore],
|
|
12
|
+
})(props => {
|
|
9
13
|
const { children, clientSideID, context, projectName, waitForInitialization = true } = props;
|
|
10
14
|
const [ldClient, setLDClient] = useState();
|
|
11
15
|
const [ldService, log] = useOptionalDependencies(LD_SERVICE_TOKEN, Log);
|
|
16
|
+
const [counter, forceUpdate] = useReducer((x) => x + 1, 0);
|
|
12
17
|
useEffect(() => {
|
|
13
18
|
(async function initializeClient() {
|
|
14
19
|
var _a;
|
|
@@ -31,9 +36,17 @@ export const LDProvider = props => {
|
|
|
31
36
|
})();
|
|
32
37
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
33
38
|
}, [clientSideID]); // only reload if clientSideID changes
|
|
39
|
+
useEffect(() => {
|
|
40
|
+
if (!waitForInitialization && ldClient) {
|
|
41
|
+
ldClient.on('initialized', forceUpdate);
|
|
42
|
+
return () => {
|
|
43
|
+
ldClient.off('initialized', forceUpdate);
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
}, [ldClient, waitForInitialization]);
|
|
34
47
|
if (!ldClient) {
|
|
35
48
|
return null;
|
|
36
49
|
}
|
|
37
|
-
return (_jsx(BaseLDProvider, { clientSideID: clientSideID, ldClient: ldClient, children: children }));
|
|
38
|
-
};
|
|
50
|
+
return (_jsx(BaseLDProvider, { clientSideID: clientSideID, ldClient: ldClient, children: _jsx(FeatureFlagProvider, { children: children }) }, counter.toString()));
|
|
51
|
+
});
|
|
39
52
|
//# sourceMappingURL=ld-provider.js.map
|
package/dist/ld-provider.js.map
CHANGED
|
@@ -1 +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;
|
|
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,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAE3E,OAAO,EACH,UAAU,IAAI,cAAc,GAE/B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAyB,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAO3C,MAAM,CAAC,MAAM,UAAU,GAA0C,OAAO,CAAC;IACrE,UAAU,EAAE,CAAC,gBAAgB,CAAC;CACjC,CAAC,CAAC,KAAK,CAAC,EAAE;IACP,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;IACxE,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,UAAU,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAEnE,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,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,CAAC,qBAAqB,IAAI,QAAQ,EAAE,CAAC;YACrC,QAAQ,CAAC,EAAE,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;YACxC,OAAO,GAAG,EAAE;gBACR,QAAQ,CAAC,GAAG,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;YAC7C,CAAC,CAAC;QACN,CAAC;IACL,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAEtC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,CACH,KAAC,cAAc,IAA0B,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,YACnF,KAAC,mBAAmB,cAAE,QAAQ,GAAuB,IADpC,OAAO,CAAC,QAAQ,EAAE,CAEtB,CACpB,CAAC;AACN,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-provider.test.d.ts","sourceRoot":"","sources":["../../src/tests/feature-flag-provider.test.tsx"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import '@testing-library/jest-dom';
|
|
3
|
+
import { Provider } from '@servicetitan/react-ioc';
|
|
4
|
+
import { render, screen } from '@testing-library/react';
|
|
5
|
+
import { FeatureFlagProvider } from '../feature-flag-provider';
|
|
6
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
7
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
8
|
+
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
9
|
+
useFlags: jest.fn(),
|
|
10
|
+
}));
|
|
11
|
+
describe(`[launchdarkly-service] ${FeatureFlagProvider.name}`, () => {
|
|
12
|
+
const flags = { foo: 'bar', baz: 'qux' };
|
|
13
|
+
const mockFeatureFlagStore = {
|
|
14
|
+
setFlags: jest.fn(),
|
|
15
|
+
};
|
|
16
|
+
const Component = () => {
|
|
17
|
+
return `<Component />`;
|
|
18
|
+
};
|
|
19
|
+
beforeEach(() => {
|
|
20
|
+
jest.mocked(useFlags).mockImplementation(() => flags);
|
|
21
|
+
});
|
|
22
|
+
const subject = () => render(_jsx(Provider, { singletons: [{ provide: FeatureFlagStore, useValue: mockFeatureFlagStore }], children: _jsx(FeatureFlagProvider, { children: _jsx(Component, {}) }) }));
|
|
23
|
+
test('renders children', () => {
|
|
24
|
+
subject();
|
|
25
|
+
expect(screen.getByText(`<Component />`)).toBeInTheDocument();
|
|
26
|
+
});
|
|
27
|
+
test('sets feature flags in store', () => {
|
|
28
|
+
subject();
|
|
29
|
+
expect(mockFeatureFlagStore.setFlags).toHaveBeenCalledWith(flags);
|
|
30
|
+
});
|
|
31
|
+
});
|
|
32
|
+
//# sourceMappingURL=feature-flag-provider.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-provider.test.js","sourceRoot":"","sources":["../../src/tests/feature-flag-provider.test.tsx"],"names":[],"mappings":";AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAEnD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEzD,IAAI,CAAC,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9C,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;CACtB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,0BAA0B,mBAAmB,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IAChE,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IACzC,MAAM,oBAAoB,GAAG;QACzB,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;KACtB,CAAC;IAEF,MAAM,SAAS,GAAO,GAAG,EAAE;QACvB,OAAO,eAAe,CAAC;IAC3B,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACZ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAG,EAAE,CACjB,MAAM,CACF,KAAC,QAAQ,IAAC,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC,YACjF,KAAC,mBAAmB,cAChB,KAAC,SAAS,KAAG,GACK,GACf,CACd,CAAC;IAEN,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAC1B,OAAO,EAAE,CAAC;QAEV,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,OAAO,EAAE,CAAC;QAEV,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-store.test.d.ts","sourceRoot":"","sources":["../../src/tests/feature-flag-store.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
2
|
+
describe(`[launchdarkly-service] ${FeatureFlagStore.name}`, () => {
|
|
3
|
+
const subject = () => new FeatureFlagStore();
|
|
4
|
+
test('has no flags initially', () => {
|
|
5
|
+
expect(subject().flags).toEqual({});
|
|
6
|
+
});
|
|
7
|
+
describe('setFlags', () => {
|
|
8
|
+
let store;
|
|
9
|
+
let flags;
|
|
10
|
+
beforeEach(() => {
|
|
11
|
+
store = new FeatureFlagStore();
|
|
12
|
+
flags = { foo: 'bar' };
|
|
13
|
+
});
|
|
14
|
+
const subject = (...args) => store.setFlags(...args);
|
|
15
|
+
test('sets flags', () => {
|
|
16
|
+
subject(flags);
|
|
17
|
+
expect(store.flags).toEqual(flags);
|
|
18
|
+
});
|
|
19
|
+
test('stores copy of flags', () => {
|
|
20
|
+
subject(flags);
|
|
21
|
+
const originalFlags = { ...flags };
|
|
22
|
+
flags.baz = 'qux';
|
|
23
|
+
expect(store.flags).toEqual(originalFlags);
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
//# sourceMappingURL=feature-flag-store.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature-flag-store.test.js","sourceRoot":"","sources":["../../src/tests/feature-flag-store.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,QAAQ,CAAC,0BAA0B,gBAAgB,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IAC7D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,gBAAgB,EAAE,CAAC;IAE7C,IAAI,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACtB,IAAI,KAAuB,CAAC;QAC5B,IAAI,KAAgB,CAAC;QAErB,UAAU,CAAC,GAAG,EAAE;YACZ,KAAK,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAC/B,KAAK,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,CAAC,GAAG,IAA8C,EAAE,EAAE,CAClE,KAAK,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAE5B,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;YAEf,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC9B,OAAO,CAAC,KAAK,CAAC,CAAC;YAEf,MAAM,aAAa,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;YACnC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC;YAElB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
2
|
import '@testing-library/jest-dom';
|
|
3
3
|
import { Log } from '@servicetitan/log-service';
|
|
4
|
-
import { Provider } from '@servicetitan/react-ioc';
|
|
4
|
+
import { Provider, useDependencies } from '@servicetitan/react-ioc';
|
|
5
5
|
import { render, screen, waitFor } from '@testing-library/react';
|
|
6
|
-
import { Fragment } from 'react';
|
|
6
|
+
import { act, Fragment } from 'react';
|
|
7
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
7
8
|
import { getLDClient } from '../get-ld-client';
|
|
8
9
|
import { LDProvider } from '../ld-provider';
|
|
9
10
|
import { LD_SERVICE_TOKEN } from '../types';
|
|
@@ -14,12 +15,15 @@ function formatProps(props) {
|
|
|
14
15
|
}
|
|
15
16
|
function mockComponent(name) {
|
|
16
17
|
return {
|
|
17
|
-
[name]: ({ children, ...props }) => (_jsxs(Fragment, { children: [_jsx("div", { children: `<${name} ${formatProps(props)}
|
|
18
|
+
[name]: ({ children, ...props }) => (_jsxs(Fragment, { children: [_jsx("div", { children: `<${name} ${formatProps(props)} />` }), children] })),
|
|
18
19
|
};
|
|
19
20
|
}
|
|
20
21
|
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
21
22
|
...mockComponent('LDProvider'),
|
|
22
23
|
}));
|
|
24
|
+
jest.mock('../feature-flag-provider', () => ({
|
|
25
|
+
...mockComponent('FeatureFlagProvider'),
|
|
26
|
+
}));
|
|
23
27
|
jest.mock('../get-ld-client', () => ({
|
|
24
28
|
getLDClient: jest.fn(),
|
|
25
29
|
}));
|
|
@@ -28,18 +32,25 @@ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
|
|
|
28
32
|
error: jest.fn(),
|
|
29
33
|
};
|
|
30
34
|
const ldClient = {
|
|
35
|
+
on: jest.fn(),
|
|
36
|
+
off: jest.fn(),
|
|
31
37
|
waitUntilReady: jest.fn().mockResolvedValue(undefined),
|
|
32
38
|
waitForInitialization: jest.fn().mockResolvedValue(undefined),
|
|
33
39
|
toString: () => 'ldClient',
|
|
34
40
|
};
|
|
35
41
|
let singletons;
|
|
36
42
|
let props;
|
|
43
|
+
let providedFeatureFlagStore;
|
|
44
|
+
let renderCount;
|
|
37
45
|
const Component = () => {
|
|
46
|
+
[providedFeatureFlagStore] = useDependencies(FeatureFlagStore);
|
|
47
|
+
renderCount += 1;
|
|
38
48
|
return _jsx("div", { children: '<Component />' });
|
|
39
49
|
};
|
|
40
50
|
beforeEach(() => {
|
|
41
51
|
jest.clearAllMocks();
|
|
42
52
|
jest.mocked(getLDClient).mockReturnValue(ldClient);
|
|
53
|
+
renderCount = 0;
|
|
43
54
|
singletons = [];
|
|
44
55
|
props = { clientSideID: 'foo', projectName: 'bar' };
|
|
45
56
|
});
|
|
@@ -48,25 +59,52 @@ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
|
|
|
48
59
|
};
|
|
49
60
|
function expectLDProvider(props) {
|
|
50
61
|
if (props) {
|
|
51
|
-
expect(screen.getByText(`<LDProvider ${formatProps(props)}
|
|
62
|
+
expect(screen.getByText(`<LDProvider ${formatProps(props)} />`)).toBeInTheDocument();
|
|
52
63
|
}
|
|
53
64
|
else {
|
|
54
|
-
expect(screen.getByText(/<LDProvider
|
|
65
|
+
expect(screen.getByText(/<LDProvider .* \/>/)).toBeInTheDocument();
|
|
55
66
|
}
|
|
56
67
|
}
|
|
57
|
-
test('renders base LDProvider after client is ready and initialized', async () => {
|
|
68
|
+
test('renders base LDProvider and FeatureFlagProvider after client is ready and initialized', async () => {
|
|
58
69
|
subject();
|
|
59
70
|
await waitFor(() => expectLDProvider({ clientSideID: props.clientSideID, ldClient }));
|
|
71
|
+
expect(screen.getByText('<FeatureFlagProvider />')).toBeInTheDocument();
|
|
60
72
|
expect(screen.getByText('<Component />')).toBeInTheDocument();
|
|
61
73
|
expect(ldClient.waitForInitialization).toHaveBeenCalled();
|
|
62
74
|
});
|
|
75
|
+
test('provides FeatureFlagStore', () => {
|
|
76
|
+
subject();
|
|
77
|
+
expect(providedFeatureFlagStore).toBeDefined();
|
|
78
|
+
});
|
|
63
79
|
describe('when waitForInitialization is false', () => {
|
|
64
|
-
|
|
80
|
+
let initializedCallback;
|
|
81
|
+
beforeEach(() => {
|
|
82
|
+
var _a;
|
|
83
|
+
props.waitForInitialization = false;
|
|
84
|
+
(_a = jest.mocked(ldClient.on)) === null || _a === void 0 ? void 0 : _a.mockImplementation((event, callback) => {
|
|
85
|
+
if (event === 'initialized') {
|
|
86
|
+
initializedCallback = callback;
|
|
87
|
+
}
|
|
88
|
+
});
|
|
89
|
+
});
|
|
65
90
|
test('does not wait for client to initialize', async () => {
|
|
66
91
|
subject();
|
|
67
92
|
await waitFor(() => expectLDProvider());
|
|
68
93
|
expect(ldClient.waitForInitialization).not.toHaveBeenCalled();
|
|
69
94
|
});
|
|
95
|
+
test('re-renders when client is initialized', async () => {
|
|
96
|
+
subject();
|
|
97
|
+
await waitFor(() => expectLDProvider());
|
|
98
|
+
expect(renderCount).toBe(1);
|
|
99
|
+
act(() => initializedCallback === null || initializedCallback === void 0 ? void 0 : initializedCallback());
|
|
100
|
+
expect(renderCount).toBe(2);
|
|
101
|
+
});
|
|
102
|
+
test('deregisters listener when component is unmounted', async () => {
|
|
103
|
+
const { unmount } = subject();
|
|
104
|
+
await waitFor(() => expectLDProvider());
|
|
105
|
+
unmount();
|
|
106
|
+
expect(jest.mocked(ldClient.off)).toHaveBeenCalledWith('initialized', initializedCallback);
|
|
107
|
+
});
|
|
70
108
|
});
|
|
71
109
|
describe('when initialization fails', () => {
|
|
72
110
|
beforeEach(() => {
|
|
@@ -1 +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;
|
|
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,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjE,OAAO,EAAE,GAAG,EAAM,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,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,KAAK,GAAO,EAC/C,QAAQ,IACF,CACd;KACJ,CAAC;AACN,CAAC;AAED,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,0BAA0B,EAAE,GAAG,EAAE,CAAC,CAAC;IACzC,GAAG,aAAa,CAAC,qBAAqB,CAAC;CAC1C,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,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;QACb,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;QACd,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;IAC5C,IAAI,wBAA0C,CAAC;IAC/C,IAAI,WAAmB,CAAC;IAExB,MAAM,SAAS,GAAO,GAAG,EAAE;QACvB,CAAC,wBAAwB,CAAC,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAC/D,WAAW,IAAI,CAAC,CAAC;QACjB,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,WAAW,GAAG,CAAC,CAAC;QAChB,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,KAAK,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACzF,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACvE,CAAC;IACL,CAAC;IAED,IAAI,CAAC,uFAAuF,EAAE,KAAK,IAAI,EAAE;QACrG,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,yBAAyB,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACxE,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,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,OAAO,EAAE,CAAC;QAEV,MAAM,CAAC,wBAAwB,CAAC,CAAC,WAAW,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;QACjD,IAAI,mBAA6B,CAAC;QAElC,UAAU,CAAC,GAAG,EAAE;;YACZ,KAAK,CAAC,qBAAqB,GAAG,KAAK,CAAC;YACpC,MAAA,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,0CAAE,kBAAkB,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;gBAC7D,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;oBAC1B,mBAAmB,GAAG,QAAQ,CAAC;gBACnC,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,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;QAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,OAAO,EAAE,CAAC;YAEV,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;YACxC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAE5B,GAAG,CAAC,GAAG,EAAE,CAAC,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,EAAI,CAAC,CAAC;YACnC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;YAE9B,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAExC,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB,CAClD,aAAa,EACb,mBAAmB,CACtB,CAAC;QACN,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 @@
|
|
|
1
|
+
{"version":3,"file":"with-feature-flag.test.d.ts","sourceRoot":"","sources":["../../src/tests/with-feature-flag.test.tsx"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import '@testing-library/jest-dom';
|
|
3
|
+
import { render, screen } from '@testing-library/react';
|
|
4
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
5
|
+
import { WithFeatureFlag } from '../with-feature-flag';
|
|
6
|
+
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
7
|
+
useFlags: jest.fn(),
|
|
8
|
+
}));
|
|
9
|
+
describe(`[launchdarkly-service] ${WithFeatureFlag.name}`, () => {
|
|
10
|
+
const flagKey = 'foo';
|
|
11
|
+
const childContent = 'Flag is ON';
|
|
12
|
+
let props;
|
|
13
|
+
let flagValue;
|
|
14
|
+
beforeEach(() => {
|
|
15
|
+
props = { flagKey, children: childContent };
|
|
16
|
+
jest.mocked(useFlags).mockImplementation(() => ({ [flagKey]: flagValue }));
|
|
17
|
+
});
|
|
18
|
+
const subject = () => render(_jsx(WithFeatureFlag, { ...props }));
|
|
19
|
+
function itRendersNothing() {
|
|
20
|
+
test('renders nothing', () => {
|
|
21
|
+
subject();
|
|
22
|
+
expect(screen.queryByText(childContent)).not.toBeInTheDocument();
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
function itRendersChildren() {
|
|
26
|
+
test('renders children', () => {
|
|
27
|
+
subject();
|
|
28
|
+
expect(screen.getByText(childContent)).toBeInTheDocument();
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
itRendersNothing();
|
|
32
|
+
describe('when flag is turned on', () => {
|
|
33
|
+
beforeEach(() => (flagValue = true));
|
|
34
|
+
itRendersChildren();
|
|
35
|
+
describe('with on prop', () => {
|
|
36
|
+
const onContent = 'Flag is ENABLED';
|
|
37
|
+
beforeEach(() => (props.on = () => onContent));
|
|
38
|
+
test('renders on content', () => {
|
|
39
|
+
subject();
|
|
40
|
+
expect(screen.getByText(onContent)).toBeInTheDocument();
|
|
41
|
+
});
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
describe('when flag is turned off', () => {
|
|
45
|
+
beforeEach(() => (flagValue = false));
|
|
46
|
+
itRendersNothing();
|
|
47
|
+
describe('with off prop', () => {
|
|
48
|
+
const offContent = 'flag is OFF';
|
|
49
|
+
beforeEach(() => (props.off = () => offContent));
|
|
50
|
+
test('renders off content', () => {
|
|
51
|
+
subject();
|
|
52
|
+
expect(screen.getByText(offContent)).toBeInTheDocument();
|
|
53
|
+
});
|
|
54
|
+
});
|
|
55
|
+
});
|
|
56
|
+
describe('with flag value', () => {
|
|
57
|
+
beforeEach(() => (props.value = 'bar'));
|
|
58
|
+
itRendersNothing();
|
|
59
|
+
describe('when flag matches value', () => {
|
|
60
|
+
beforeEach(() => (flagValue = props.value));
|
|
61
|
+
itRendersChildren();
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
//# sourceMappingURL=with-feature-flag.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"with-feature-flag.test.js","sourceRoot":"","sources":["../../src/tests/with-feature-flag.test.tsx"],"names":[],"mappings":";AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAe,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEtE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,IAAI,CAAC,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9C,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;CACtB,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,0BAA0B,eAAe,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IAC5D,MAAM,OAAO,GAAG,KAAK,CAAC;IACtB,MAAM,YAAY,GAAG,YAAY,CAAC;IAClC,IAAI,KAA4C,CAAC;IACjD,IAAI,SAAsB,CAAC;IAE3B,UAAU,CAAC,GAAG,EAAE;QACZ,KAAK,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,KAAC,eAAe,OAAK,KAAK,GAAI,CAAC,CAAC;IAE7D,SAAS,gBAAgB;QACrB,IAAI,CAAC,iBAAiB,EAAE,GAAG,EAAE;YACzB,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACrE,CAAC,CAAC,CAAC;IACP,CAAC;IAED,SAAS,iBAAiB;QACtB,IAAI,CAAC,kBAAkB,EAAE,GAAG,EAAE;YAC1B,OAAO,EAAE,CAAC;YAEV,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAC/D,CAAC,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,EAAE,CAAC;IAEnB,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACpC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC;QAErC,iBAAiB,EAAE,CAAC;QAEpB,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;YAC1B,MAAM,SAAS,GAAG,iBAAiB,CAAC;YAEpC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;YAE/C,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;gBAC5B,OAAO,EAAE,CAAC;gBAEV,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;YAC5D,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACrC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC;QAEtC,gBAAgB,EAAE,CAAC;QAEnB,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;YAC3B,MAAM,UAAU,GAAG,aAAa,CAAC;YAEjC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;YAEjD,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE;gBAC7B,OAAO,EAAE,CAAC;gBAEV,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;YAC7D,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC7B,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;QAExC,gBAAgB,EAAE,CAAC;QAEnB,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACrC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YAE5C,iBAAiB,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
package/dist/types.d.ts
CHANGED
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +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"}
|
|
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;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CAClB,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { LDFlagSet } from 'launchdarkly-js-client-sdk';
|
|
2
|
+
import { ComponentType, ReactNode } from 'react';
|
|
3
|
+
import { FlagKey } from './types';
|
|
4
|
+
interface BaseProps<S extends LDFlagSet, T extends keyof S> {
|
|
5
|
+
flagKey: FlagKey<S, T>;
|
|
6
|
+
off?: ComponentType;
|
|
7
|
+
value?: S[T];
|
|
8
|
+
}
|
|
9
|
+
export type WithFeatureFlagProps<S extends LDFlagSet, T extends keyof S = keyof S> = (BaseProps<S, T> & {
|
|
10
|
+
children?: ReactNode;
|
|
11
|
+
on?: never;
|
|
12
|
+
}) | (BaseProps<S, T> & {
|
|
13
|
+
on?: ComponentType;
|
|
14
|
+
children?: never;
|
|
15
|
+
});
|
|
16
|
+
export declare function WithFeatureFlag<S extends LDFlagSet, T extends keyof S = keyof S>(props: WithFeatureFlagProps<S, T>): ReactNode;
|
|
17
|
+
export {};
|
|
18
|
+
//# sourceMappingURL=with-feature-flag.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"with-feature-flag.d.ts","sourceRoot":"","sources":["../src/with-feature-flag.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,UAAU,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC;IACtD,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvB,GAAG,CAAC,EAAE,aAAa,CAAC;IACpB,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CAChB;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAC3E,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAC;IAAC,EAAE,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,GACxD,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IAAE,EAAE,CAAC,EAAE,aAAa,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAEnE,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,EAC5E,KAAK,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAClC,SAAS,CAUX"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
3
|
+
export function WithFeatureFlag(props) {
|
|
4
|
+
const { flagKey, value } = props;
|
|
5
|
+
const flagValue = useFlags()[flagKey];
|
|
6
|
+
const isEnabled = value !== undefined ? flagValue === value : !!flagValue;
|
|
7
|
+
if (isEnabled) {
|
|
8
|
+
return props.on ? _jsx(props.on, {}) : props.children;
|
|
9
|
+
}
|
|
10
|
+
return props.off ? _jsx(props.off, {}) : null;
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=with-feature-flag.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"with-feature-flag.js","sourceRoot":"","sources":["../src/with-feature-flag.tsx"],"names":[],"mappings":";AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAczD,MAAM,UAAU,eAAe,CAC3B,KAAiC;IAEjC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACjC,MAAM,SAAS,GAAG,QAAQ,EAAK,CAAC,OAAO,CAAC,CAAC;IAEzC,MAAM,SAAS,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,IAAI,SAAS,EAAE,CAAC;QACZ,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAC,KAAK,CAAC,EAAE,KAAG,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;IACpD,CAAC;IAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAC,KAAK,CAAC,GAAG,KAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5C,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@servicetitan/launchdarkly-service",
|
|
3
|
-
"version": "28.
|
|
3
|
+
"version": "28.3.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"homepage": "https://docs.st.dev/docs/frontend/launchdarkly-service",
|
|
6
6
|
"repository": {
|
|
@@ -16,19 +16,22 @@
|
|
|
16
16
|
"src"
|
|
17
17
|
],
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@servicetitan/log-service": "28.
|
|
20
|
-
"@servicetitan/react-ioc": "28.
|
|
19
|
+
"@servicetitan/log-service": "28.3.0",
|
|
20
|
+
"@servicetitan/react-ioc": "28.3.0",
|
|
21
21
|
"@testing-library/dom": "^10.4.0",
|
|
22
|
-
"@testing-library/
|
|
22
|
+
"@testing-library/jest-dom": "^6.6.3",
|
|
23
|
+
"@testing-library/react": "^16.1.0",
|
|
23
24
|
"launchdarkly-js-client-sdk": "3.5.0",
|
|
24
25
|
"launchdarkly-react-client-sdk": "^3.6.0",
|
|
26
|
+
"mobx": "~6.13.5",
|
|
25
27
|
"react": "~18.3.1"
|
|
26
28
|
},
|
|
27
29
|
"peerDependencies": {
|
|
28
|
-
"@servicetitan/log-service": "28.
|
|
29
|
-
"@servicetitan/react-ioc": "28.
|
|
30
|
+
"@servicetitan/log-service": "28.3.0",
|
|
31
|
+
"@servicetitan/react-ioc": "28.3.0",
|
|
30
32
|
"launchdarkly-js-client-sdk": "3.5.0",
|
|
31
33
|
"launchdarkly-react-client-sdk": "^3.6.0",
|
|
34
|
+
"mobx": ">= 6.13.5",
|
|
32
35
|
"react": ">=17.0.2"
|
|
33
36
|
},
|
|
34
37
|
"publishConfig": {
|
|
@@ -37,5 +40,5 @@
|
|
|
37
40
|
"cli": {
|
|
38
41
|
"webpack": false
|
|
39
42
|
},
|
|
40
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "63ce3ca18966fc5522a3b61df5e4c55f82b4272e"
|
|
41
44
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { useDependencies } from '@servicetitan/react-ioc';
|
|
2
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
3
|
+
import { PropsWithChildren, useEffect } from 'react';
|
|
4
|
+
|
|
5
|
+
import { FeatureFlagStore } from './feature-flag-store';
|
|
6
|
+
|
|
7
|
+
export function FeatureFlagProvider({ children }: PropsWithChildren) {
|
|
8
|
+
const [{ setFlags }] = useDependencies(FeatureFlagStore);
|
|
9
|
+
const flags = useFlags();
|
|
10
|
+
|
|
11
|
+
useEffect(() => {
|
|
12
|
+
setFlags(flags);
|
|
13
|
+
}, [flags, setFlags]);
|
|
14
|
+
|
|
15
|
+
return children;
|
|
16
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { injectable } from '@servicetitan/react-ioc';
|
|
2
|
+
import { LDFlagSet } from 'launchdarkly-react-client-sdk';
|
|
3
|
+
import { action, makeObservable, observable } from 'mobx';
|
|
4
|
+
|
|
5
|
+
@injectable()
|
|
6
|
+
export class FeatureFlagStore<T extends LDFlagSet = LDFlagSet> {
|
|
7
|
+
// @ts-expect-error because 'LDFlagSet' is assignable to the constraint of type 'T', but 'T' could be instantiated with a different subtype of constraint
|
|
8
|
+
@observable flags: T = {} as LDFlagSet;
|
|
9
|
+
|
|
10
|
+
constructor() {
|
|
11
|
+
makeObservable(this);
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
@action
|
|
15
|
+
setFlags(flags: T) {
|
|
16
|
+
this.flags = flags;
|
|
17
|
+
}
|
|
18
|
+
}
|
package/src/index.ts
CHANGED
package/src/ld-provider.tsx
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
import { Log } from '@servicetitan/log-service';
|
|
2
|
-
import { useOptionalDependencies } from '@servicetitan/react-ioc';
|
|
2
|
+
import { provide, useOptionalDependencies } from '@servicetitan/react-ioc';
|
|
3
3
|
import { LDClient } from 'launchdarkly-js-client-sdk';
|
|
4
4
|
import {
|
|
5
5
|
LDProvider as BaseLDProvider,
|
|
6
6
|
ProviderConfig as BaseProviderConfig,
|
|
7
7
|
} from 'launchdarkly-react-client-sdk';
|
|
8
|
-
import { FC, PropsWithChildren, useEffect, useState } from 'react';
|
|
8
|
+
import { FC, PropsWithChildren, useEffect, useReducer, useState } from 'react';
|
|
9
9
|
|
|
10
|
+
import { FeatureFlagProvider } from './feature-flag-provider';
|
|
11
|
+
import { FeatureFlagStore } from './feature-flag-store';
|
|
10
12
|
import { getLDClient } from './get-ld-client';
|
|
11
13
|
import { LD_SERVICE_TOKEN } from './types';
|
|
12
14
|
|
|
@@ -15,10 +17,13 @@ export type ProviderConfig = Pick<BaseProviderConfig, 'clientSideID' | 'context'
|
|
|
15
17
|
waitForInitialization?: boolean;
|
|
16
18
|
};
|
|
17
19
|
|
|
18
|
-
export const LDProvider: FC<PropsWithChildren<ProviderConfig>> =
|
|
20
|
+
export const LDProvider: FC<PropsWithChildren<ProviderConfig>> = provide({
|
|
21
|
+
singletons: [FeatureFlagStore],
|
|
22
|
+
})(props => {
|
|
19
23
|
const { children, clientSideID, context, projectName, waitForInitialization = true } = props;
|
|
20
24
|
const [ldClient, setLDClient] = useState<LDClient>();
|
|
21
25
|
const [ldService, log] = useOptionalDependencies(LD_SERVICE_TOKEN, Log);
|
|
26
|
+
const [counter, forceUpdate] = useReducer((x: number) => x + 1, 0);
|
|
22
27
|
|
|
23
28
|
useEffect(() => {
|
|
24
29
|
(async function initializeClient() {
|
|
@@ -41,13 +46,22 @@ export const LDProvider: FC<PropsWithChildren<ProviderConfig>> = props => {
|
|
|
41
46
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
42
47
|
}, [clientSideID]); // only reload if clientSideID changes
|
|
43
48
|
|
|
49
|
+
useEffect(() => {
|
|
50
|
+
if (!waitForInitialization && ldClient) {
|
|
51
|
+
ldClient.on('initialized', forceUpdate);
|
|
52
|
+
return () => {
|
|
53
|
+
ldClient.off('initialized', forceUpdate);
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
}, [ldClient, waitForInitialization]);
|
|
57
|
+
|
|
44
58
|
if (!ldClient) {
|
|
45
59
|
return null;
|
|
46
60
|
}
|
|
47
61
|
|
|
48
62
|
return (
|
|
49
|
-
<BaseLDProvider clientSideID={clientSideID} ldClient={ldClient}>
|
|
50
|
-
{children}
|
|
63
|
+
<BaseLDProvider key={counter.toString()} clientSideID={clientSideID} ldClient={ldClient}>
|
|
64
|
+
<FeatureFlagProvider>{children}</FeatureFlagProvider>
|
|
51
65
|
</BaseLDProvider>
|
|
52
66
|
);
|
|
53
|
-
};
|
|
67
|
+
});
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
2
|
+
import { Provider } from '@servicetitan/react-ioc';
|
|
3
|
+
import { FC } from 'react';
|
|
4
|
+
import { render, screen } from '@testing-library/react';
|
|
5
|
+
|
|
6
|
+
import { FeatureFlagProvider } from '../feature-flag-provider';
|
|
7
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
8
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
9
|
+
|
|
10
|
+
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
11
|
+
useFlags: jest.fn(),
|
|
12
|
+
}));
|
|
13
|
+
|
|
14
|
+
describe(`[launchdarkly-service] ${FeatureFlagProvider.name}`, () => {
|
|
15
|
+
const flags = { foo: 'bar', baz: 'qux' };
|
|
16
|
+
const mockFeatureFlagStore = {
|
|
17
|
+
setFlags: jest.fn(),
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
const Component: FC = () => {
|
|
21
|
+
return `<Component />`;
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
beforeEach(() => {
|
|
25
|
+
jest.mocked(useFlags).mockImplementation(() => flags);
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
const subject = () =>
|
|
29
|
+
render(
|
|
30
|
+
<Provider singletons={[{ provide: FeatureFlagStore, useValue: mockFeatureFlagStore }]}>
|
|
31
|
+
<FeatureFlagProvider>
|
|
32
|
+
<Component />
|
|
33
|
+
</FeatureFlagProvider>
|
|
34
|
+
</Provider>
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
test('renders children', () => {
|
|
38
|
+
subject();
|
|
39
|
+
|
|
40
|
+
expect(screen.getByText(`<Component />`)).toBeInTheDocument();
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
test('sets feature flags in store', () => {
|
|
44
|
+
subject();
|
|
45
|
+
|
|
46
|
+
expect(mockFeatureFlagStore.setFlags).toHaveBeenCalledWith(flags);
|
|
47
|
+
});
|
|
48
|
+
});
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { LDFlagSet } from 'launchdarkly-js-client-sdk';
|
|
2
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
3
|
+
|
|
4
|
+
describe(`[launchdarkly-service] ${FeatureFlagStore.name}`, () => {
|
|
5
|
+
const subject = () => new FeatureFlagStore();
|
|
6
|
+
|
|
7
|
+
test('has no flags initially', () => {
|
|
8
|
+
expect(subject().flags).toEqual({});
|
|
9
|
+
});
|
|
10
|
+
|
|
11
|
+
describe('setFlags', () => {
|
|
12
|
+
let store: FeatureFlagStore;
|
|
13
|
+
let flags: LDFlagSet;
|
|
14
|
+
|
|
15
|
+
beforeEach(() => {
|
|
16
|
+
store = new FeatureFlagStore();
|
|
17
|
+
flags = { foo: 'bar' };
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
const subject = (...args: Parameters<FeatureFlagStore['setFlags']>) =>
|
|
21
|
+
store.setFlags(...args);
|
|
22
|
+
|
|
23
|
+
test('sets flags', () => {
|
|
24
|
+
subject(flags);
|
|
25
|
+
|
|
26
|
+
expect(store.flags).toEqual(flags);
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
test('stores copy of flags', () => {
|
|
30
|
+
subject(flags);
|
|
31
|
+
|
|
32
|
+
const originalFlags = { ...flags };
|
|
33
|
+
flags.baz = 'qux';
|
|
34
|
+
|
|
35
|
+
expect(store.flags).toEqual(originalFlags);
|
|
36
|
+
});
|
|
37
|
+
});
|
|
38
|
+
});
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import '@testing-library/jest-dom';
|
|
2
2
|
import { Log } from '@servicetitan/log-service';
|
|
3
|
-
import { Provider } from '@servicetitan/react-ioc';
|
|
3
|
+
import { Provider, useDependencies } from '@servicetitan/react-ioc';
|
|
4
4
|
import { render, screen, waitFor } from '@testing-library/react';
|
|
5
5
|
import { LDClient } from 'launchdarkly-js-client-sdk';
|
|
6
|
-
import { FC, Fragment } from 'react';
|
|
6
|
+
import { act, FC, Fragment } from 'react';
|
|
7
7
|
|
|
8
|
+
import { FeatureFlagStore } from '../feature-flag-store';
|
|
8
9
|
import { getLDClient } from '../get-ld-client';
|
|
9
10
|
import { LDProvider } from '../ld-provider';
|
|
10
11
|
import { LD_SERVICE_TOKEN, LDService } from '../types';
|
|
@@ -19,15 +20,19 @@ function mockComponent(name: string) {
|
|
|
19
20
|
return {
|
|
20
21
|
[name]: ({ children, ...props }: any) => (
|
|
21
22
|
<Fragment>
|
|
22
|
-
<div>{`<${name} ${formatProps(props)}
|
|
23
|
+
<div>{`<${name} ${formatProps(props)} />`}</div>
|
|
23
24
|
{children}
|
|
24
25
|
</Fragment>
|
|
25
26
|
),
|
|
26
27
|
};
|
|
27
28
|
}
|
|
29
|
+
|
|
28
30
|
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
29
31
|
...mockComponent('LDProvider'),
|
|
30
32
|
}));
|
|
33
|
+
jest.mock('../feature-flag-provider', () => ({
|
|
34
|
+
...mockComponent('FeatureFlagProvider'),
|
|
35
|
+
}));
|
|
31
36
|
jest.mock('../get-ld-client', () => ({
|
|
32
37
|
getLDClient: jest.fn(),
|
|
33
38
|
}));
|
|
@@ -37,20 +42,27 @@ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
|
|
|
37
42
|
error: jest.fn(),
|
|
38
43
|
};
|
|
39
44
|
const ldClient: Partial<LDClient> & { toString: () => string } = {
|
|
45
|
+
on: jest.fn(),
|
|
46
|
+
off: jest.fn(),
|
|
40
47
|
waitUntilReady: jest.fn().mockResolvedValue(undefined),
|
|
41
48
|
waitForInitialization: jest.fn().mockResolvedValue(undefined),
|
|
42
49
|
toString: () => 'ldClient',
|
|
43
50
|
};
|
|
44
51
|
let singletons: Required<Parameters<typeof Provider>[0]>['singletons'];
|
|
45
52
|
let props: Parameters<typeof LDProvider>[0];
|
|
53
|
+
let providedFeatureFlagStore: FeatureFlagStore;
|
|
54
|
+
let renderCount: number;
|
|
46
55
|
|
|
47
56
|
const Component: FC = () => {
|
|
57
|
+
[providedFeatureFlagStore] = useDependencies(FeatureFlagStore);
|
|
58
|
+
renderCount += 1;
|
|
48
59
|
return <div>{'<Component />'}</div>;
|
|
49
60
|
};
|
|
50
61
|
|
|
51
62
|
beforeEach(() => {
|
|
52
63
|
jest.clearAllMocks();
|
|
53
64
|
jest.mocked(getLDClient).mockReturnValue(ldClient as LDClient);
|
|
65
|
+
renderCount = 0;
|
|
54
66
|
singletons = [];
|
|
55
67
|
props = { clientSideID: 'foo', projectName: 'bar' };
|
|
56
68
|
});
|
|
@@ -67,23 +79,39 @@ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
|
|
|
67
79
|
|
|
68
80
|
function expectLDProvider(props?: Record<string, any>) {
|
|
69
81
|
if (props) {
|
|
70
|
-
expect(screen.getByText(`<LDProvider ${formatProps(props)}
|
|
82
|
+
expect(screen.getByText(`<LDProvider ${formatProps(props)} />`)).toBeInTheDocument();
|
|
71
83
|
} else {
|
|
72
|
-
expect(screen.getByText(/<LDProvider
|
|
84
|
+
expect(screen.getByText(/<LDProvider .* \/>/)).toBeInTheDocument();
|
|
73
85
|
}
|
|
74
86
|
}
|
|
75
87
|
|
|
76
|
-
test('renders base LDProvider after client is ready and initialized', async () => {
|
|
88
|
+
test('renders base LDProvider and FeatureFlagProvider after client is ready and initialized', async () => {
|
|
77
89
|
subject();
|
|
78
90
|
|
|
79
91
|
await waitFor(() => expectLDProvider({ clientSideID: props.clientSideID, ldClient }));
|
|
80
92
|
|
|
93
|
+
expect(screen.getByText('<FeatureFlagProvider />')).toBeInTheDocument();
|
|
81
94
|
expect(screen.getByText('<Component />')).toBeInTheDocument();
|
|
82
95
|
expect(ldClient.waitForInitialization).toHaveBeenCalled();
|
|
83
96
|
});
|
|
84
97
|
|
|
98
|
+
test('provides FeatureFlagStore', () => {
|
|
99
|
+
subject();
|
|
100
|
+
|
|
101
|
+
expect(providedFeatureFlagStore).toBeDefined();
|
|
102
|
+
});
|
|
103
|
+
|
|
85
104
|
describe('when waitForInitialization is false', () => {
|
|
86
|
-
|
|
105
|
+
let initializedCallback: Function;
|
|
106
|
+
|
|
107
|
+
beforeEach(() => {
|
|
108
|
+
props.waitForInitialization = false;
|
|
109
|
+
jest.mocked(ldClient.on)?.mockImplementation((event, callback) => {
|
|
110
|
+
if (event === 'initialized') {
|
|
111
|
+
initializedCallback = callback;
|
|
112
|
+
}
|
|
113
|
+
});
|
|
114
|
+
});
|
|
87
115
|
|
|
88
116
|
test('does not wait for client to initialize', async () => {
|
|
89
117
|
subject();
|
|
@@ -92,6 +120,29 @@ describe(`[launchdarkly-service] ${LDProvider.name}`, () => {
|
|
|
92
120
|
|
|
93
121
|
expect(ldClient.waitForInitialization).not.toHaveBeenCalled();
|
|
94
122
|
});
|
|
123
|
+
|
|
124
|
+
test('re-renders when client is initialized', async () => {
|
|
125
|
+
subject();
|
|
126
|
+
|
|
127
|
+
await waitFor(() => expectLDProvider());
|
|
128
|
+
expect(renderCount).toBe(1);
|
|
129
|
+
|
|
130
|
+
act(() => initializedCallback?.());
|
|
131
|
+
expect(renderCount).toBe(2);
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
test('deregisters listener when component is unmounted', async () => {
|
|
135
|
+
const { unmount } = subject();
|
|
136
|
+
|
|
137
|
+
await waitFor(() => expectLDProvider());
|
|
138
|
+
|
|
139
|
+
unmount();
|
|
140
|
+
|
|
141
|
+
expect(jest.mocked(ldClient.off)).toHaveBeenCalledWith(
|
|
142
|
+
'initialized',
|
|
143
|
+
initializedCallback
|
|
144
|
+
);
|
|
145
|
+
});
|
|
95
146
|
});
|
|
96
147
|
|
|
97
148
|
describe('when initialization fails', () => {
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import '@testing-library/jest-dom';
|
|
2
|
+
import { render, screen } from '@testing-library/react';
|
|
3
|
+
import { LDFlagValue, useFlags } from 'launchdarkly-react-client-sdk';
|
|
4
|
+
|
|
5
|
+
import { WithFeatureFlag } from '../with-feature-flag';
|
|
6
|
+
|
|
7
|
+
jest.mock('launchdarkly-react-client-sdk', () => ({
|
|
8
|
+
useFlags: jest.fn(),
|
|
9
|
+
}));
|
|
10
|
+
|
|
11
|
+
describe(`[launchdarkly-service] ${WithFeatureFlag.name}`, () => {
|
|
12
|
+
const flagKey = 'foo';
|
|
13
|
+
const childContent = 'Flag is ON';
|
|
14
|
+
let props: Parameters<typeof WithFeatureFlag>[0];
|
|
15
|
+
let flagValue: LDFlagValue;
|
|
16
|
+
|
|
17
|
+
beforeEach(() => {
|
|
18
|
+
props = { flagKey, children: childContent };
|
|
19
|
+
jest.mocked(useFlags).mockImplementation(() => ({ [flagKey]: flagValue }));
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
const subject = () => render(<WithFeatureFlag {...props} />);
|
|
23
|
+
|
|
24
|
+
function itRendersNothing() {
|
|
25
|
+
test('renders nothing', () => {
|
|
26
|
+
subject();
|
|
27
|
+
|
|
28
|
+
expect(screen.queryByText(childContent)).not.toBeInTheDocument();
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function itRendersChildren() {
|
|
33
|
+
test('renders children', () => {
|
|
34
|
+
subject();
|
|
35
|
+
|
|
36
|
+
expect(screen.getByText(childContent)).toBeInTheDocument();
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
itRendersNothing();
|
|
41
|
+
|
|
42
|
+
describe('when flag is turned on', () => {
|
|
43
|
+
beforeEach(() => (flagValue = true));
|
|
44
|
+
|
|
45
|
+
itRendersChildren();
|
|
46
|
+
|
|
47
|
+
describe('with on prop', () => {
|
|
48
|
+
const onContent = 'Flag is ENABLED';
|
|
49
|
+
|
|
50
|
+
beforeEach(() => (props.on = () => onContent));
|
|
51
|
+
|
|
52
|
+
test('renders on content', () => {
|
|
53
|
+
subject();
|
|
54
|
+
|
|
55
|
+
expect(screen.getByText(onContent)).toBeInTheDocument();
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
describe('when flag is turned off', () => {
|
|
61
|
+
beforeEach(() => (flagValue = false));
|
|
62
|
+
|
|
63
|
+
itRendersNothing();
|
|
64
|
+
|
|
65
|
+
describe('with off prop', () => {
|
|
66
|
+
const offContent = 'flag is OFF';
|
|
67
|
+
|
|
68
|
+
beforeEach(() => (props.off = () => offContent));
|
|
69
|
+
|
|
70
|
+
test('renders off content', () => {
|
|
71
|
+
subject();
|
|
72
|
+
|
|
73
|
+
expect(screen.getByText(offContent)).toBeInTheDocument();
|
|
74
|
+
});
|
|
75
|
+
});
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
describe('with flag value', () => {
|
|
79
|
+
beforeEach(() => (props.value = 'bar'));
|
|
80
|
+
|
|
81
|
+
itRendersNothing();
|
|
82
|
+
|
|
83
|
+
describe('when flag matches value', () => {
|
|
84
|
+
beforeEach(() => (flagValue = props.value));
|
|
85
|
+
|
|
86
|
+
itRendersChildren();
|
|
87
|
+
});
|
|
88
|
+
});
|
|
89
|
+
});
|
package/src/types.ts
CHANGED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { LDFlagSet } from 'launchdarkly-js-client-sdk';
|
|
2
|
+
import { useFlags } from 'launchdarkly-react-client-sdk';
|
|
3
|
+
import { ComponentType, ReactNode } from 'react';
|
|
4
|
+
import { FlagKey } from './types';
|
|
5
|
+
|
|
6
|
+
interface BaseProps<S extends LDFlagSet, T extends keyof S> {
|
|
7
|
+
flagKey: FlagKey<S, T>;
|
|
8
|
+
off?: ComponentType;
|
|
9
|
+
value?: S[T];
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export type WithFeatureFlagProps<S extends LDFlagSet, T extends keyof S = keyof S> =
|
|
13
|
+
| (BaseProps<S, T> & { children?: ReactNode; on?: never })
|
|
14
|
+
| (BaseProps<S, T> & { on?: ComponentType; children?: never });
|
|
15
|
+
|
|
16
|
+
export function WithFeatureFlag<S extends LDFlagSet, T extends keyof S = keyof S>(
|
|
17
|
+
props: WithFeatureFlagProps<S, T>
|
|
18
|
+
): ReactNode {
|
|
19
|
+
const { flagKey, value } = props;
|
|
20
|
+
const flagValue = useFlags<S>()[flagKey];
|
|
21
|
+
|
|
22
|
+
const isEnabled = value !== undefined ? flagValue === value : !!flagValue;
|
|
23
|
+
if (isEnabled) {
|
|
24
|
+
return props.on ? <props.on /> : props.children;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
return props.off ? <props.off /> : null;
|
|
28
|
+
}
|