@lokalise/fastify-extras 5.1.0 → 5.3.0

package/README.md

@@ -8,3 +8,12 @@ The following needs to be taken into consideration when adding new runtime depen
 
 * If dependency is an implementation detail, and end consumer is not expected to import and use the dependency directly, it should be a `dependency`;
 * If dependency needs to be imported and used by consumer directly for it to function properly, it should be a `peerDependency`.
+
+### Split IO plugin
+
+Plugin has 3 modes:
+- `enabled`  - will connect to [](https://split.io) using provided `apiKey` and store data in memory with background sync
+- `localhost` - will use `localhost` mode with features provided in a file via param `localhostFilePath`
+- `disabled` - on any request to `SplitIOFeatureManager` it will return `control` treatment
+
+More info about Split IO can be checked [here](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)

package/dist/index.d.ts

@@ -4,6 +4,8 @@ export { requestContextProviderPlugin, getRequestIdFastifyAppConfig, REQUEST_ID_
 export type { BaseRequestContext as RequestContext } from './plugins/requestContextProviderPlugin';
 export { newrelicTransactionManagerPlugin, NewRelicTransactionManager, } from './plugins/newrelicTransactionManagerPlugin';
 export type { NewRelicTransactionManagerOptions } from './plugins/newrelicTransactionManagerPlugin';
+export { splitIOFeatureManagerPlugin, SplitIOFeatureManager, } from './plugins/splitIOFeatureManagerPlugin';
+export type { SplitIOOptions } from './plugins/splitIOFeatureManagerPlugin';
 export { metricsPlugin } from './plugins/metricsPlugin';
 export type { ErrorObjectResolver, MetricsPluginOptions } from './plugins/metricsPlugin';
 export { prismaOtelTracingPlugin } from './plugins/opentelemetry/prismaOtelTracingPlugin';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.publicHealthcheckPlugin = exports.prismaOtelTracingPlugin = exports.metricsPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
+exports.publicHealthcheckPlugin = exports.prismaOtelTracingPlugin = exports.metricsPlugin = exports.SplitIOFeatureManager = exports.splitIOFeatureManagerPlugin = exports.NewRelicTransactionManager = exports.newrelicTransactionManagerPlugin = exports.REQUEST_ID_STORE_KEY = exports.getRequestIdFastifyAppConfig = exports.requestContextProviderPlugin = exports.reportErrorToBugsnag = exports.bugsnagPlugin = void 0;
 var bugsnagPlugin_1 = require("./plugins/bugsnagPlugin");
 Object.defineProperty(exports, "bugsnagPlugin", { enumerable: true, get: function () { return bugsnagPlugin_1.bugsnagPlugin; } });
 Object.defineProperty(exports, "reportErrorToBugsnag", { enumerable: true, get: function () { return bugsnagPlugin_1.reportErrorToBugsnag; } });
@@ -11,6 +11,9 @@ Object.defineProperty(exports, "REQUEST_ID_STORE_KEY", { enumerable: true, get:
 var newrelicTransactionManagerPlugin_1 = require("./plugins/newrelicTransactionManagerPlugin");
 Object.defineProperty(exports, "newrelicTransactionManagerPlugin", { enumerable: true, get: function () { return newrelicTransactionManagerPlugin_1.newrelicTransactionManagerPlugin; } });
 Object.defineProperty(exports, "NewRelicTransactionManager", { enumerable: true, get: function () { return newrelicTransactionManagerPlugin_1.NewRelicTransactionManager; } });
+var splitIOFeatureManagerPlugin_1 = require("./plugins/splitIOFeatureManagerPlugin");
+Object.defineProperty(exports, "splitIOFeatureManagerPlugin", { enumerable: true, get: function () { return splitIOFeatureManagerPlugin_1.splitIOFeatureManagerPlugin; } });
+Object.defineProperty(exports, "SplitIOFeatureManager", { enumerable: true, get: function () { return splitIOFeatureManagerPlugin_1.SplitIOFeatureManager; } });
 var metricsPlugin_1 = require("./plugins/metricsPlugin");
 Object.defineProperty(exports, "metricsPlugin", { enumerable: true, get: function () { return metricsPlugin_1.metricsPlugin; } });
 var prismaOtelTracingPlugin_1 = require("./plugins/opentelemetry/prismaOtelTracingPlugin");

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,yDAAuD;AAA9C,8GAAA,aAAa,OAAA;AAGtB,2FAAyF;AAAhF,kIAAA,uBAAuB,OAAA;AAGhC,6EAA2E;AAAlE,kIAAA,uBAAuB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA6E;AAApE,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAG5C,uFAI+C;AAH7C,4IAAA,4BAA4B,OAAA;AAC5B,4IAAA,4BAA4B,OAAA;AAC5B,oIAAA,oBAAoB,OAAA;AAItB,+FAGmD;AAFjD,oJAAA,gCAAgC,OAAA;AAChC,8IAAA,0BAA0B,OAAA;AAI5B,qFAG8C;AAF5C,0IAAA,2BAA2B,OAAA;AAC3B,oIAAA,qBAAqB,OAAA;AAIvB,yDAAuD;AAA9C,8GAAA,aAAa,OAAA;AAGtB,2FAAyF;AAAhF,kIAAA,uBAAuB,OAAA;AAGhC,6EAA2E;AAAlE,kIAAA,uBAAuB,OAAA"}

package/dist/plugins/newrelicTransactionManagerPlugin.d.ts

@@ -10,6 +10,7 @@ export declare class NewRelicTransactionManager {
     private readonly isEnabled;
     private readonly transactionMap;
     constructor(isNewRelicEnabled: boolean);
+    addCustomAttribte(attrName: string, attrValue: string | number | boolean): void;
     start(jobName: string): void;
     stop(jobId: string): void;
 }

package/dist/plugins/newrelicTransactionManagerPlugin.js

@@ -15,6 +15,12 @@ class NewRelicTransactionManager {
         this.isEnabled = isNewRelicEnabled;
         this.transactionMap = new Map();
     }
+    addCustomAttribte(attrName, attrValue) {
+        if (!this.isEnabled) {
+            return;
+        }
+        newrelic.addCustomAttribute(attrName, attrValue);
+    }
     start(jobName) {
         if (!this.isEnabled) {
             return;

package/dist/plugins/newrelicTransactionManagerPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"newrelicTransactionManagerPlugin.js","sourceRoot":"","sources":["../../lib/plugins/newrelicTransactionManagerPlugin.ts"],"names":[],"mappings":";;;;AACA,4EAA+B;AAc/B,IAAI,QAAkB,CAAA;AAYtB,MAAa,0BAA0B;IACpB,SAAS,CAAS;IAClB,cAAc,CAAgC;IAE/D,YAAY,iBAA0B;QACpC,IAAI,iBAAiB,EAAE;YACrB,mEAAmE;YACnE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;SAC/B;QAED,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAA;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,CAAC;IAEM,KAAK,CAAC,OAAe;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,QAAQ,CAAC,0BAA0B,CAAC,OAAO,EAAE,GAAG,EAAE;YAChD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAA;QAC7D,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,IAAI,CAAC,KAAa;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAA;QAC1D,IAAI,IAAI,KAAK,WAAW,EAAE;YACxB,OAAM;SACP;QACD,WAAW,CAAC,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;CACF;AApCD,gEAoCC;AAED,SAAS,MAAM,CACb,OAAwB,EACxB,IAAuC,EACvC,IAAgB;IAEhB,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAE9D,OAAO,CAAC,QAAQ,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAA;IAEvD,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC1B,IAAI,KAAK,EAAE;wBACT,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;qBACrB;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,gCAAgC,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACzD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,qCAAqC;CAC5C,CAAC,CAAA"}
+{"version":3,"file":"newrelicTransactionManagerPlugin.js","sourceRoot":"","sources":["../../lib/plugins/newrelicTransactionManagerPlugin.ts"],"names":[],"mappings":";;;;AACA,4EAA+B;AAe/B,IAAI,QAAkB,CAAA;AAYtB,MAAa,0BAA0B;IACpB,SAAS,CAAS;IAClB,cAAc,CAAgC;IAE/D,YAAY,iBAA0B;QACpC,IAAI,iBAAiB,EAAE;YACrB,mEAAmE;YACnE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;SAC/B;QAED,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAA;QAClC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,CAAC;IAEM,iBAAiB,CAAC,QAAgB,EAAE,SAAoC;QAC7E,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,QAAQ,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IAClD,CAAC;IAEM,KAAK,CAAC,OAAe;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,QAAQ,CAAC,0BAA0B,CAAC,OAAO,EAAE,GAAG,EAAE;YAChD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAA;QAC7D,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,IAAI,CAAC,KAAa;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAA;QAC1D,IAAI,IAAI,KAAK,WAAW,EAAE;YACxB,OAAM;SACP;QACD,WAAW,CAAC,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;CACF;AA5CD,gEA4CC;AAED,SAAS,MAAM,CACb,OAAwB,EACxB,IAAuC,EACvC,IAAgB;IAEhB,MAAM,OAAO,GAAG,IAAI,0BAA0B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAE9D,OAAO,CAAC,QAAQ,CAAC,4BAA4B,EAAE,OAAO,CAAC,CAAA;IAEvD,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,QAAQ,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC1B,IAAI,KAAK,EAAE;wBACT,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;qBACrB;oBACD,OAAO,EAAE,CAAA;gBACX,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IAED,IAAI,EAAE,CAAA;AACR,CAAC;AAEY,QAAA,gCAAgC,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACzD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,qCAAqC;CAC5C,CAAC,CAAA"}

package/dist/plugins/splitIOFeatureManagerPlugin.d.ts

@@ -0,0 +1,24 @@
+import type SplitIO from '@splitsoftware/splitio/types/splitio';
+import type { Attributes, Properties, SplitKey, Treatment, TreatmentWithConfig } from '@splitsoftware/splitio/types/splitio';
+declare module 'fastify' {
+    interface FastifyInstance {
+        splitIOFeatureManager: SplitIOFeatureManager;
+    }
+}
+export interface SplitIOOptions {
+    isEnabled: boolean;
+    apiKey: string;
+    debugMode: boolean;
+    localhostFilePath?: string;
+}
+export declare class SplitIOFeatureManager {
+    private readonly isEnabled;
+    private readonly splitIOClient?;
+    constructor(isSplitIOEnabled: boolean, apiKey: string, debugMode: boolean, localhostFilePath?: string);
+    init(): Promise<void>;
+    getTreatment(key: SplitKey, splitName: string, attributes?: Attributes): Treatment;
+    getTreatmentWithConfig(key: SplitKey, splitName: string, attributes?: Attributes): TreatmentWithConfig;
+    track(key: SplitIO.SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): boolean;
+    shutdown(): Promise<void>;
+}
+export declare const splitIOFeatureManagerPlugin: import("fastify").FastifyPluginCallback<SplitIOOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;

package/dist/plugins/splitIOFeatureManagerPlugin.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitIOFeatureManagerPlugin = exports.SplitIOFeatureManager = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const process = tslib_1.__importStar(require("process"));
+const splitio_1 = require("@splitsoftware/splitio");
+const fastify_plugin_1 = tslib_1.__importDefault(require("fastify-plugin"));
+const DISABLED_TREATMENT = 'control';
+class SplitIOFeatureManager {
+    isEnabled;
+    splitIOClient;
+    constructor(isSplitIOEnabled, apiKey, debugMode, localhostFilePath) {
+        if (isSplitIOEnabled) {
+            const factory = (0, splitio_1.SplitFactory)({
+                core: {
+                    authorizationKey: localhostFilePath ? 'localhost' : apiKey,
+                },
+                features: localhostFilePath ? path.join(process.cwd(), localhostFilePath) : undefined,
+                debug: debugMode,
+            });
+            this.splitIOClient = factory.client();
+        }
+        this.isEnabled = isSplitIOEnabled;
+    }
+    async init() {
+        await this.splitIOClient?.ready();
+    }
+    getTreatment(key, splitName, attributes) {
+        return this.splitIOClient?.getTreatment(key, splitName, attributes) ?? DISABLED_TREATMENT;
+    }
+    getTreatmentWithConfig(key, splitName, attributes) {
+        return (this.splitIOClient?.getTreatmentWithConfig(key, splitName, attributes) ?? {
+            treatment: DISABLED_TREATMENT,
+            config: null,
+        });
+    }
+    track(key, trafficType, eventType, value, properties) {
+        return this.splitIOClient?.track(key, trafficType, eventType, value, properties) ?? false;
+    }
+    async shutdown() {
+        if (!this.isEnabled) {
+            return;
+        }
+        await this.splitIOClient?.destroy();
+    }
+}
+exports.SplitIOFeatureManager = SplitIOFeatureManager;
+function plugin(fastify, opts, done) {
+    const manager = new SplitIOFeatureManager(opts.isEnabled, opts.apiKey, opts.debugMode, opts.localhostFilePath);
+    fastify.decorate('splitIOFeatureManager', manager);
+    if (opts.isEnabled) {
+        fastify.addHook('onClose', async () => {
+            await manager.shutdown();
+        });
+    }
+    void manager
+        .init()
+        .then(() => done())
+        .catch(() => {
+        throw new Error('Split IO client is not ready');
+    });
+}
+exports.splitIOFeatureManagerPlugin = (0, fastify_plugin_1.default)(plugin, {
+    fastify: '4.x',
+    name: 'split-io-feature-manager-plugin',
+});
+//# sourceMappingURL=splitIOFeatureManagerPlugin.js.map

package/dist/plugins/splitIOFeatureManagerPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitIOFeatureManagerPlugin.js","sourceRoot":"","sources":["../../lib/plugins/splitIOFeatureManagerPlugin.ts"],"names":[],"mappings":";;;;AAAA,mDAA4B;AAC5B,yDAAkC;AAElC,oDAAqD;AAUrD,4EAA+B;AAE/B,MAAM,kBAAkB,GAAc,SAAS,CAAA;AAe/C,MAAa,qBAAqB;IACf,SAAS,CAAS;IAElB,aAAa,CAAkB;IAEhD,YACE,gBAAyB,EACzB,MAAc,EACd,SAAkB,EAClB,iBAA0B;QAE1B,IAAI,gBAAgB,EAAE;YACpB,MAAM,OAAO,GAAiB,IAAA,sBAAY,EAAC;gBACzC,IAAI,EAAE;oBACJ,gBAAgB,EAAE,iBAAiB,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM;iBAC3D;gBACD,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS;gBACrF,KAAK,EAAE,SAAS;aACjB,CAAC,CAAA;YACF,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,CAAA;SACtC;QAED,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAA;IACnC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,CAAA;IACnC,CAAC;IAEM,YAAY,CAAC,GAAa,EAAE,SAAiB,EAAE,UAAuB;QAC3E,OAAO,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,IAAI,kBAAkB,CAAA;IAC3F,CAAC;IAEM,sBAAsB,CAC3B,GAAa,EACb,SAAiB,EACjB,UAAuB;QAEvB,OAAO,CACL,IAAI,CAAC,aAAa,EAAE,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,CAAC,IAAI;YACxE,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE,IAAI;SACb,CACF,CAAA;IACH,CAAC;IAEM,KAAK,CACV,GAAqB,EACrB,WAAmB,EACnB,SAAiB,EACjB,KAAc,EACd,UAAuB;QAEvB,OAAO,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,KAAK,CAAA;IAC3F,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,OAAM;SACP;QAED,MAAM,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,CAAA;IACrC,CAAC;CACF;AA/DD,sDA+DC;AAED,SAAS,MAAM,CAAC,OAAwB,EAAE,IAAoB,EAAE,IAAgB;IAC9E,MAAM,OAAO,GAAG,IAAI,qBAAqB,CACvC,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,iBAAiB,CACvB,CAAA;IAED,OAAO,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAA;IAElD,IAAI,IAAI,CAAC,SAAS,EAAE;QAClB,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAA;QAC1B,CAAC,CAAC,CAAA;KACH;IAED,KAAK,OAAO;SACT,IAAI,EAAE;SACN,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC;SAClB,KAAK,CAAC,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;AACN,CAAC;AAEY,QAAA,2BAA2B,GAAG,IAAA,wBAAE,EAAC,MAAM,EAAE;IACpD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,iCAAiC;CACxC,CAAC,CAAA"}

package/dist/plugins/splitIOFeatureManagerPlugin.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/splitIOFeatureManagerPlugin.spec.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fastify_1 = tslib_1.__importDefault(require("fastify"));
+const splitIOFeatureManagerPlugin_1 = require("./splitIOFeatureManagerPlugin");
+async function initApp(opts) {
+    const app = (0, fastify_1.default)();
+    await app.register(splitIOFeatureManagerPlugin_1.splitIOFeatureManagerPlugin, opts);
+    await app.ready();
+    return app;
+}
+describe('splitIOFeatureManagerPlugin', () => {
+    let app;
+    afterEach(async () => {
+        await app.close();
+    });
+    it('returns control treatment on disabled client', async () => {
+        expect.assertions(1);
+        const opts = {
+            isEnabled: false,
+            apiKey: '',
+            debugMode: false,
+        };
+        app = await initApp(opts);
+        const treatment = app.splitIOFeatureManager.getTreatment('', '');
+        expect(treatment).toBe('control');
+    });
+    it('returns treatments from local file', async () => {
+        expect.assertions(2);
+        const opts = {
+            isEnabled: true,
+            apiKey: 'localhost',
+            debugMode: false,
+            localhostFilePath: '/lib/plugins/tests/.split.yaml',
+        };
+        app = await initApp(opts);
+        const onTreatment = app.splitIOFeatureManager.getTreatment('mock_user_id', 'my_feature');
+        const offTreatment = app.splitIOFeatureManager.getTreatment('unknown_id', 'my_feature');
+        expect(onTreatment).toBe('on');
+        expect(offTreatment).toBe('off');
+    });
+    it('returns control treatment with config on disabled client', async () => {
+        expect.assertions(1);
+        const opts = {
+            isEnabled: false,
+            apiKey: '',
+            debugMode: false,
+        };
+        app = await initApp(opts);
+        const treatment = app.splitIOFeatureManager.getTreatmentWithConfig('', '');
+        expect(treatment).toStrictEqual({ config: null, treatment: 'control' });
+    });
+    it('returns false track on disabled client', async () => {
+        expect.assertions(1);
+        const opts = {
+            isEnabled: false,
+            apiKey: '',
+            debugMode: false,
+        };
+        app = await initApp(opts);
+        const trackResult = app.splitIOFeatureManager.track('', '', '');
+        expect(trackResult).toBe(false);
+    });
+    it('shutdown running client', async () => {
+        expect.assertions(1);
+        const opts = {
+            isEnabled: true,
+            apiKey: 'localhost',
+            debugMode: false,
+            localhostFilePath: '/lib/plugins/tests/.split.yaml',
+        };
+        app = await initApp(opts);
+        await app.close();
+        const onTreatment = app.splitIOFeatureManager.getTreatment('mock_user_id', 'my_feature');
+        expect(onTreatment).toBe('control');
+    });
+    it('shutdown not active client', async () => {
+        expect.assertions(1);
+        const opts = {
+            isEnabled: false,
+            apiKey: '',
+            debugMode: false,
+        };
+        app = await initApp(opts);
+        await app.splitIOFeatureManager.shutdown();
+        const treatment = app.splitIOFeatureManager.getTreatment('', '');
+        expect(treatment).toBe('control');
+    });
+});
+//# sourceMappingURL=splitIOFeatureManagerPlugin.spec.js.map

package/dist/plugins/splitIOFeatureManagerPlugin.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitIOFeatureManagerPlugin.spec.js","sourceRoot":"","sources":["../../lib/plugins/splitIOFeatureManagerPlugin.spec.ts"],"names":[],"mappings":";;;AACA,8DAA6B;AAG7B,+EAA2E;AAE3E,KAAK,UAAU,OAAO,CAAC,IAAqB;IAC1C,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAA;IACrB,MAAM,GAAG,CAAC,QAAQ,CAAC,yDAA2B,EAAE,IAAI,CAAC,CAAA;IACrD,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;IACjB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,IAAI,GAAoB,CAAA;IACxB,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;YACV,SAAS,EAAE,KAAK;SACjB,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,SAAS,GAAG,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QAEhE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,WAAW;YACnB,SAAS,EAAE,KAAK;YAChB,iBAAiB,EAAE,gCAAgC;SACpD,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,WAAW,GAAG,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;QACxF,MAAM,YAAY,GAAG,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QACvF,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9B,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;YACV,SAAS,EAAE,KAAK;SACjB,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,SAAS,GAAG,GAAG,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QAE1E,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAA;IACzE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;YACV,SAAS,EAAE,KAAK;SACjB,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,WAAW,GAAG,GAAG,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;QAE/D,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,WAAW;YACnB,SAAS,EAAE,KAAK;YAChB,iBAAiB,EAAE,gCAAgC;SACpD,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAA;QACjB,MAAM,WAAW,GAAG,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,cAAc,EAAE,YAAY,CAAC,CAAA;QAExF,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACpB,MAAM,IAAI,GAAG;YACX,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;YACV,SAAS,EAAE,KAAK;SACjB,CAAA;QAED,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;QACzB,MAAM,GAAG,CAAC,qBAAqB,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,SAAS,GAAG,GAAG,CAAC,qBAAqB,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QAEhE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lokalise/fastify-extras",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "Opinionated set of fastify plugins, commonly used in Lokalise",
   "author": {
     "name": "Lokalise",
@@ -17,7 +17,8 @@
     "bugsnag",
     "request-context",
     "als",
-    "request-id"
+    "request-id",
+    "split-io"
   ],
   "homepage": "https://github.com/lokalise/fastify-extras",
   "files": [
@@ -58,6 +59,7 @@
     "@fastify/request-context": "^4.2.0",
     "fastify": "^4.10.2",
     "newrelic": "^9.7.4",
+    "@splitsoftware/splitio": "^10.22.3",
     "pino": "^8.8.0"
   },
   "devDependencies": {
@@ -74,6 +76,7 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-prettier": "^4.2.1",
+    "esquery": "1.4.0",
     "fastify": "^4.12.0",
     "jest": "^29.4.1",
     "newrelic": "^9.7.4",