@diia-inhouse/features 2.3.1

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./services"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAE5B,6CAA0B"}

package/dist/interfaces/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":""}

package/dist/services/feature.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureService = void 0;
+const semver_1 = __importDefault(require("semver"));
+const unleash_client_1 = require("unleash-client");
+class FeatureService {
+    serviceName;
+    featureConfig;
+    logger;
+    envService;
+    asyncLocalStorage;
+    unleash = null;
+    constructor(serviceName, featureConfig, logger, envService, asyncLocalStorage) {
+        this.serviceName = serviceName;
+        this.featureConfig = featureConfig;
+        this.logger = logger;
+        this.envService = envService;
+        this.asyncLocalStorage = asyncLocalStorage;
+    }
+    async onInit() {
+        const { isEnabled, url, apiToken } = this.featureConfig;
+        if (!isEnabled) {
+            this.logger.info('Unleash is disabled. All feature flags are set to false');
+            return;
+        }
+        this.unleash = await (0, unleash_client_1.startUnleash)({
+            url,
+            appName: this.serviceName,
+            customHeaders: { Authorization: apiToken },
+            environment: this.envService.isProd() ? 'production' : 'development',
+            tags: [{ name: 'microservice', value: this.serviceName }],
+        });
+        this.unleash.on('warn', (err) => {
+            this.logger.warn('Unleash warn event', { err });
+        });
+        this.unleash.on('error', (err) => {
+            this.logger.error('Unleash error event', { err });
+        });
+        this.logger.info('Unleash has started');
+    }
+    isEnabled(name, context = {}) {
+        if (!this.unleash) {
+            this.logger.warn('Unleash is disabled');
+            return false;
+        }
+        const alsStore = this.asyncLocalStorage.getStore() ?? {};
+        context.userId ??= alsStore.logData?.userIdentifier;
+        context.userIdBase64 ??= context.userId && Buffer.from(context.userId, 'hex').toString('base64');
+        context.sessionType ??= alsStore.logData?.sessionType;
+        context.platformType ??= alsStore.headers?.platformType;
+        context.platformVersion ??= alsStore.headers?.platformVersion;
+        context.platformVersion = semver_1.default.coerce(context.platformVersion)?.version;
+        context.appVersion ??= alsStore.headers?.appVersion;
+        context.appVersion = this.parseAppVersion(context.appVersion);
+        context.currentTime ??= new Date();
+        this.logger.debug('Feature flag check', { name, context });
+        const result = this.unleash.isEnabled(name, context);
+        if (result) {
+            alsStore.logData ??= {};
+            alsStore.logData.flags ??= [];
+            alsStore.logData.flags.push(name);
+            this.asyncLocalStorage.enterWith(alsStore);
+        }
+        return result;
+    }
+    isSomeEnabled(name, contexts) {
+        return contexts.some((context) => this.isEnabled(name, context));
+    }
+    getDefinition(name) {
+        return this.unleash?.getFeatureToggleDefinition(name);
+    }
+    parseAppVersion(appVersion) {
+        if (!appVersion) {
+            return;
+        }
+        const parts = appVersion.split('.');
+        if (parts.length === 3) {
+            return appVersion;
+        }
+        if (parts.length === 4) {
+            return parts.slice(0, 3).join('.') + `-${parts[3]}`;
+        }
+        this.logger.warn('Invalid app version format for feature flag', { appVersion });
+        return;
+    }
+}
+exports.FeatureService = FeatureService;
+//# sourceMappingURL=feature.js.map

package/dist/services/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../src/services/feature.ts"],"names":[],"mappings":";;;;;;AAEA,oDAA2B;AAC3B,mDAAsD;AAQtD,MAAa,cAAc;IAIF;IACA;IACA;IACA;IACA;IAPb,OAAO,GAAmB,IAAI,CAAA;IAEtC,YACqB,WAAmB,EACnB,aAA4B,EAC5B,MAAc,EACd,UAAsB,EACtB,iBAA6C;QAJ7C,gBAAW,GAAX,WAAW,CAAQ;QACnB,kBAAa,GAAb,aAAa,CAAe;QAC5B,WAAM,GAAN,MAAM,CAAQ;QACd,eAAU,GAAV,UAAU,CAAY;QACtB,sBAAiB,GAAjB,iBAAiB,CAA4B;IAC/D,CAAC;IAEJ,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,aAAa,CAAA;QACvD,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAA;YAE3E,OAAM;QACV,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,MAAM,IAAA,6BAAY,EAAC;YAC9B,GAAG;YACH,OAAO,EAAE,IAAI,CAAC,WAAW;YACzB,aAAa,EAAE,EAAE,aAAa,EAAE,QAAQ,EAAE;YAC1C,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa;YACpE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;SAC5D,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA;QACnD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;IAC3C,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,UAA0B,EAAE;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;YAEvC,OAAO,KAAK,CAAA;QAChB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAA;QAExD,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAA;QACnD,OAAO,CAAC,YAAY,KAAK,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAEhG,OAAO,CAAC,WAAW,KAAK,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;QAErD,OAAO,CAAC,YAAY,KAAK,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;QAEvD,OAAO,CAAC,eAAe,KAAK,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;QAC7D,OAAO,CAAC,eAAe,GAAG,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,OAAO,CAAA;QAEzE,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAA;QACnD,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QAE7D,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,EAAE,CAAA;QAElC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;QAE1D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpD,IAAI,MAAM,EAAE,CAAC;YACT,QAAQ,CAAC,OAAO,KAAK,EAAE,CAAA;YACvB,QAAQ,CAAC,OAAO,CAAC,KAAK,KAAK,EAAE,CAAA;YAC7B,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC9C,CAAC;QAED,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,aAAa,CAAC,IAAY,EAAE,QAA0B;QAClD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IACpE,CAAC;IAED,aAAa,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,IAAI,CAAC,CAAA;IACzD,CAAC;IAEO,eAAe,CAAC,UAAmB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAM;QACV,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,UAAU,CAAA;QACrB,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;QACvD,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6CAA6C,EAAE,EAAE,UAAU,EAAE,CAAC,CAAA;QAE/E,OAAM;IACV,CAAC;CACJ;AArGD,wCAqGC"}

package/dist/services/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./feature"), exports);
+//# sourceMappingURL=index.js.map

package/dist/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interfaces';
+export * from './services';

package/dist/types/interfaces/index.d.ts

@@ -0,0 +1,22 @@
+import { Context } from 'unleash-client';
+import { PlatformType, ProfileFeature, SessionType } from '@diia-inhouse/types';
+export { FeatureInterface } from 'unleash-client/lib/feature';
+export interface FeatureConfig {
+    isEnabled: boolean;
+    url: string;
+    apiToken: string;
+}
+export interface FeatureContext extends Context {
+    /**
+     * Base64 encoded userIdentifier. Due to Unleash limitation max 100 chars per value we can't use userIdentifier (sha512 hex representation) for unleash values as his length is 128.
+     * But at the same time base64 representation of it is 88 chars long which is fine.
+     */
+    userIdBase64?: string;
+    platformType?: PlatformType;
+    /** semver major(.minor)(.patch) */
+    platformVersion?: string;
+    /** semver major.minor.patch(.build) */
+    appVersion?: string;
+    sessionType?: SessionType;
+    profileFeature?: ProfileFeature;
+}

package/dist/types/services/feature.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="node" />
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { FeatureInterface } from 'unleash-client/lib/feature';
+import type { EnvService } from '@diia-inhouse/env';
+import { AlsData, Logger, OnInit } from '@diia-inhouse/types';
+import { FeatureConfig, FeatureContext } from '../interfaces';
+export declare class FeatureService implements OnInit {
+    private readonly serviceName;
+    private readonly featureConfig;
+    private readonly logger;
+    private readonly envService;
+    private readonly asyncLocalStorage;
+    private unleash;
+    constructor(serviceName: string, featureConfig: FeatureConfig, logger: Logger, envService: EnvService, asyncLocalStorage: AsyncLocalStorage<AlsData>);
+    onInit(): Promise<void>;
+    isEnabled(name: string, context?: FeatureContext): boolean;
+    isSomeEnabled(name: string, contexts: FeatureContext[]): boolean;
+    getDefinition(name: string): FeatureInterface | undefined;
+    private parseAppVersion;
+}

package/dist/types/services/index.d.ts

@@ -0,0 +1 @@
+export * from './feature';

package/package.json

@@ -0,0 +1,86 @@
+{
+    "name": "@diia-inhouse/features",
+    "version": "2.3.1",
+    "description": "Features toggles",
+    "main": "dist/index.js",
+    "types": "dist/types/index.d.ts",
+    "repository": "https://gitlab.diia.org.ua/diia-inhouse/pkg-features.git",
+    "author": "Diia",
+    "license": "MIT",
+    "files": [
+        "dist"
+    ],
+    "engines": {
+        "node": ">=18"
+    },
+    "scripts": {
+        "prebuild": "rimraf dist",
+        "build": "tsc",
+        "semantic-release": "semantic-release",
+        "start": "npm run build && node dist/index.js",
+        "lint": "eslint --ext .ts . && prettier --check .",
+        "lint-fix": "eslint '*/**/*.{js,ts}' --fix && prettier --write .",
+        "lint:lockfile": "lockfile-lint --path package-lock.json --allowed-hosts registry.npmjs.org gitlab.diia.org.ua --validate-https",
+        "prepare": "npm run build",
+        "test": "jest",
+        "test:unit": "npm run test --selectProjects unit",
+        "test:integration": "npm run test --selectProjects integration --",
+        "test:coverage": "npm run test --selectProjects unit --coverage",
+        "find-circulars": "madge --circular --extensions ts ./"
+    },
+    "dependencies": {
+        "semver": "7.6.2",
+        "unleash-client": "5.5.5"
+    },
+    "peerDependencies": {
+        "@diia-inhouse/env": ">=1.14.0",
+        "@diia-inhouse/types": ">=6.34.1"
+    },
+    "devDependencies": {
+        "@commitlint/cli": "19.3.0",
+        "@diia-inhouse/configs": "1.32.0",
+        "@diia-inhouse/diia-logger": "3.3.0",
+        "@diia-inhouse/env": "1.16.0",
+        "@diia-inhouse/errors": "1.10.0",
+        "@diia-inhouse/eslint-config": "5.1.0",
+        "@diia-inhouse/test": "6.4.0",
+        "@diia-inhouse/types": "6.34.1",
+        "@types/node": "20.14.9",
+        "lockfile-lint": "4.14.0",
+        "madge": "7.0.0",
+        "rimraf": "5.0.7",
+        "semantic-release": "21.1.2"
+    },
+    "release": {
+        "extends": "@diia-inhouse/configs/dist/semantic-release/package",
+        "branches": [
+            "main"
+        ]
+    },
+    "commitlint": {
+        "extends": "@diia-inhouse/configs/dist/commitlint"
+    },
+    "eslintConfig": {
+        "extends": "@diia-inhouse/eslint-config",
+        "overrides": [
+            {
+                "files": [
+                    "*.ts"
+                ],
+                "parserOptions": {
+                    "project": [
+                        "./tsconfig.json",
+                        "./tests/tsconfig.json"
+                    ]
+                }
+            }
+        ]
+    },
+    "prettier": "@diia-inhouse/eslint-config/prettier",
+    "madge": {
+        "tsConfig": "./tsconfig.json"
+    },
+    "jest": {
+        "preset": "@diia-inhouse/configs/dist/jest"
+    }
+}