@forge/cli-shared 2.4.2-next.0 → 2.5.0-next.0

package/out/graphql/graphql-types.js

@@ -549,6 +549,7 @@ var ForgeMetricsGroupByDimensions;
     ForgeMetricsGroupByDimensions["UserTier"] = "USER_TIER";
     ForgeMetricsGroupByDimensions["EnvironmentId"] = "ENVIRONMENT_ID";
     ForgeMetricsGroupByDimensions["ErrorType"] = "ERROR_TYPE";
+    ForgeMetricsGroupByDimensions["Version"] = "VERSION";
 })(ForgeMetricsGroupByDimensions = exports.ForgeMetricsGroupByDimensions || (exports.ForgeMetricsGroupByDimensions = {}));
 var ForgeMetricsResolutionUnit;
 (function (ForgeMetricsResolutionUnit) {

package/out/service/feature-flag-service.d.ts

@@ -0,0 +1,35 @@
+import { LDClient, LDOptions, LDUser } from 'launchdarkly-node-client-sdk';
+import { PersonalApiCredentialsGetter } from '../auth';
+import { ConfigSectionReader } from '../config';
+import { getEnvironment } from '../graphql';
+import { CLIDetails } from '../shared';
+import { Logger } from '../ui';
+declare type FeatureFlagType = {
+    'forge-cli-test-flag': 'apple' | 'banana' | 'orange' | 'watermelon';
+    'forge-cli-startup-warning': string;
+    'xls-lambda-runtime': string;
+};
+export declare type FeatureFlag = keyof FeatureFlagType;
+export interface FeatureFlagReader {
+    readFlag<F extends FeatureFlag>(flag: F): Promise<FeatureFlagType[F] | null>;
+}
+declare type ILaunchDarkly = Pick<LDClient, 'variation' | 'waitUntilReady'>;
+declare type LaunchDarklyInitialize = (envKey: string, user: LDUser, options?: LDOptions) => ILaunchDarkly;
+export declare function cachedMethod<C, T>(getter: (this: C) => Promise<T>): (this: C) => Promise<T>;
+export declare class FeatureFlagService implements FeatureFlagReader {
+    private readonly logger;
+    private readonly cliDetails;
+    private readonly userCredentials;
+    private readonly appConfigReader;
+    private readonly getEnvironmentFn;
+    private readonly initializeLD;
+    constructor(logger: Logger, cliDetails: Pick<CLIDetails, 'version'> | undefined, userCredentials: PersonalApiCredentialsGetter, appConfigReader: ConfigSectionReader<{
+        id: string;
+    }>, getEnvironmentFn?: typeof getEnvironment, initializeLD?: LaunchDarklyInitialize);
+    private appID;
+    private user;
+    private client;
+    readFlag<F extends FeatureFlag>(flag: F): Promise<FeatureFlagType[F] | null>;
+}
+export {};
+//# sourceMappingURL=feature-flag-service.d.ts.map

package/out/service/feature-flag-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-flag-service.d.ts","sourceRoot":"","sources":["../../src/service/feature-flag-service.ts"],"names":[],"mappings":"AAAA,OAAqB,EAAe,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAKtG,OAAO,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAyB/B,aAAK,eAAe,GAAG;IACrB,qBAAqB,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAC;IACpE,2BAA2B,EAAE,MAAM,CAAC;IACpC,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,oBAAY,WAAW,GAAG,MAAM,eAAe,CAAC;AAKhD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;CAC9E;AAmBD,aAAK,aAAa,GAAG,IAAI,CAAC,QAAQ,EAAE,WAAW,GAAG,gBAAgB,CAAC,CAAC;AAMpE,aAAK,sBAAsB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,KAAK,aAAa,CAAC;AAEnG,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAa3F;AAKD,qBAAa,kBAAmB,YAAW,iBAAiB;IAExD,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY;gBALZ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,GAAG,SAAS,EACnD,eAAe,EAAE,4BAA4B,EAC7C,eAAe,EAAE,mBAAmB,CAAC;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,EACpD,gBAAgB,GAAE,OAAO,cAA+B,EACxD,YAAY,GAAE,sBAAgD;IAOjF,OAAO,CAAC,KAAK,CAOV;IAMH,OAAO,CAAC,IAAI,CAkBT;IAEH,OAAO,CAAC,MAAM,CAYX;IAEG,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAUnF"}

package/out/service/feature-flag-service.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureFlagService = exports.cachedMethod = void 0;
+const tslib_1 = require("tslib");
+const launchdarkly_node_client_sdk_1 = tslib_1.__importStar(require("launchdarkly-node-client-sdk"));
+const env_paths_1 = tslib_1.__importDefault(require("env-paths"));
+const fs_1 = require("fs");
+const util_1 = require("util");
+const graphql_1 = require("../graphql");
+var CLIENT_SIDE_ID;
+(function (CLIENT_SIDE_ID) {
+    CLIENT_SIDE_ID["DEV"] = "5d22bfb52c6a0707aac5be90";
+    CLIENT_SIDE_ID["STG"] = "5d1eed1f47274b07674b9395";
+    CLIENT_SIDE_ID["PROD"] = "5d1eecfe47274b07674b938f";
+})(CLIENT_SIDE_ID || (CLIENT_SIDE_ID = {}));
+function cachedMethod(getter) {
+    const cacheDict = new Map();
+    return async function () {
+        const cached = cacheDict.get(this);
+        if (cached !== undefined) {
+            return cached;
+        }
+        const value = await getter.call(this);
+        cacheDict.set(this, value);
+        return value;
+    };
+}
+exports.cachedMethod = cachedMethod;
+class FeatureFlagService {
+    constructor(logger, cliDetails, userCredentials, appConfigReader, getEnvironmentFn = graphql_1.getEnvironment, initializeLD = launchdarkly_node_client_sdk_1.default.initialize) {
+        this.logger = logger;
+        this.cliDetails = cliDetails;
+        this.userCredentials = userCredentials;
+        this.appConfigReader = appConfigReader;
+        this.getEnvironmentFn = getEnvironmentFn;
+        this.initializeLD = initializeLD;
+        this.appID = cachedMethod(async () => {
+            try {
+                const config = await this.appConfigReader.readConfigSection();
+                return config == 'missing' || config == 'invalid' ? null : config.id;
+            }
+            catch (e) {
+                return null;
+            }
+        });
+        this.user = cachedMethod(async () => {
+            const custom = {};
+            const appID = await this.appID();
+            if (appID) {
+                custom.appID = appID;
+            }
+            if (this.cliDetails) {
+                custom.version = this.cliDetails.version;
+            }
+            let key;
+            try {
+                key = (await this.userCredentials.getCredentials()).accountId;
+            }
+            catch (e) {
+                key = 'anonymous';
+            }
+            return { key, anonymous: true, custom };
+        });
+        this.client = cachedMethod(async () => {
+            const clientSideID = this.getEnvironmentFn(CLIENT_SIDE_ID);
+            const user = await this.user();
+            const cachePath = env_paths_1.default('@forge/cli').cache;
+            await util_1.promisify(fs_1.mkdir)(cachePath, { recursive: true });
+            const options = {
+                bootstrap: 'localStorage',
+                localStoragePath: cachePath,
+                logger: launchdarkly_node_client_sdk_1.basicLogger({ level: 'error' }),
+                sendEvents: false
+            };
+            return this.initializeLD(clientSideID, user, options);
+        });
+    }
+    async readFlag(flag) {
+        try {
+            const client = await this.client();
+            await client.waitUntilReady();
+            return client.variation(flag, null);
+        }
+        catch (e) {
+            this.logger.error(new Error('Failed to read feature flags. Proceeding with defaults.'));
+            return null;
+        }
+    }
+}
+exports.FeatureFlagService = FeatureFlagService;

package/out/service/index.d.ts

@@ -1,3 +1,4 @@
 export * from './bridge-script-service';
 export * from './iframe-resizer-script-service';
+export * from './feature-flag-service';
 //# sourceMappingURL=index.d.ts.map

package/out/service/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":"AAEA,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/service/index.ts"],"names":[],"mappings":"AAEA,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC;AAChD,cAAc,wBAAwB,CAAC"}

package/out/service/index.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./bridge-script-service"), exports);
 tslib_1.__exportStar(require("./iframe-resizer-script-service"), exports);
+tslib_1.__exportStar(require("./feature-flag-service"), exports);

package/out/shared/error-handling.d.ts

@@ -1,5 +1,5 @@
 import { Logger } from '../ui';
 export declare class HiddenError extends Error {
 }
-export declare const exitOnError: (logger: Logger) => (error?: HiddenError | undefined) => never;
+export declare const exitOnError: (logger: Logger) => (error?: Error | undefined) => never;
 //# sourceMappingURL=error-handling.d.ts.map

package/out/shared/error-handling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/shared/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,qBAAa,WAAY,SAAQ,KAAK;CAAG;AAUzC,eAAO,MAAM,WAAW,WAAY,MAAM,0CAA4B,KAarE,CAAC"}
+{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/shared/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,qBAAa,WAAY,SAAQ,KAAK;CAAG;AAUzC,eAAO,MAAM,WAAW,WAAY,MAAM,oCAAsB,KAa/D,CAAC"}

package/out/ui/logger.d.ts

@@ -10,5 +10,6 @@ export interface Logger {
     }): void;
     snapshotLog(message: string, level: 'INFO' | 'WARNING' | 'ERROR'): void;
 }
+export declare const NullLogger: Logger;
 export declare function errorMessage(error: Error): string;
 //# sourceMappingURL=logger.d.ts.map

package/out/ui/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/ui/logger.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACvD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;CACzE;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEjD"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/ui/logger.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,OAAO,CAAC;IAEtB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACvD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;CACzE;AAED,eAAO,MAAM,UAAU,EAAE,MAsBxB,CAAC;AAEF,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEjD"}

package/out/ui/logger.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMessage = void 0;
+exports.errorMessage = exports.NullLogger = void 0;
+exports.NullLogger = {
+    traceEnabled: false,
+    debugEnabled: false,
+    trace() {
+    },
+    debug() {
+    },
+    info() {
+    },
+    warn() {
+    },
+    error() {
+    },
+    snapshotLog() {
+    }
+};
 function errorMessage(error) {
     return error.message ? error.message : error.constructor.name;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "2.4.2-next.0",
+  "version": "2.5.0-next.0",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,7 +12,7 @@
     "generate-graphql-types": "graphql-codegen --config src/graphql/codegen.yml"
   },
   "dependencies": {
-    "@forge/manifest": "3.6.1-next.0",
+    "@forge/manifest": "3.7.0",
     "@forge/util": "1.2.0",
     "array.prototype.flatmap": "^1.2.3",
     "case": "^1.6.2",
@@ -21,6 +21,7 @@
     "cli-table3": "^0.6.1",
     "conf": "^6.2.0",
     "cross-spawn": "^7.0.1",
+    "env-paths": "^2.2.0",
     "figures": "^3.2.0",
     "fp-ts": "^2.0.1",
     "fs-extra": "^8.1.0",