@forge/feature-flags-node 1.1.3 → 2.0.0-next.0-experimental-3cf1031

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @forge/feature-flags-node
 
+## 2.0.0-next.0-experimental-3cf1031
+
+### Major Changes
+
+- 96f7508: Added new identifiers for targeting
+
+### Patch Changes
+
+- @forge/api@6.1.3-next.0-experimental-3cf1031
+
+## 2.0.0-next.0
+
+### Major Changes
+
+- 96f7508: Added new identifiers for targeting
+
+### Patch Changes
+
+- @forge/api@6.1.3-next.0
+
 ## 1.1.3
 
 ### Patch Changes

package/README.md

@@ -22,13 +22,15 @@ export const handler = async (payload, context) => {
   // Initialize the feature flags service
   const featureFlags = new ForgeFeatureFlags();
   await featureFlags.initialize({
-    environment: environmentType?.toLowerCase() || "development" // Optional, defaults to 'development'
+    environment: environmentType?.toLowerCase() || "development" 
   });
 
   // Define a user
   const user = {
-    userID: context?.principal?.accountId,
-    custom: { 
+    identifiers:{
+      accountId: context?.principal?.accountId,
+    },
+    attributes: { 
       license: context?.license?.isActive
     }
   };
@@ -62,6 +64,16 @@ export const handler = async (payload, context) => {
     environment: getAppContext().environmentType?.toLowerCase() || "development"
   });
 
+  // Define a user
+  const user = {
+    identifiers:{
+      installContext: context?.installContext,
+    },
+    custom: { 
+      issues: 4
+    }
+  };
+
   // Use feature flags...
   const isEnabled = featureFlags.checkFlag(user, "new-feature");
 
@@ -132,8 +144,12 @@ Checks if the service is initialized.
 
 ```typescript
 interface ForgeUser {
-  userID: string;
+  identifiers?: {
+    installContext?: string;
+    accountId?: string;
+  };
   custom?: Record<string, string | number | boolean>;
+  attributes?: Record<string, string | number | boolean>;
 }
 ```
 

package/out/data-adapter.d.ts

@@ -3,6 +3,8 @@ export declare class ForgeDataAdapter implements IDataAdapter {
     private readonly pollingIntervalMs;
     private readonly pollingEnabled;
     private readonly cache;
+    private metrics;
+    private tags;
     constructor(pollingIntervalMs?: number, pollingEnabled?: boolean);
     get(key: string): Promise<AdapterResponse>;
     private fetchFromAtlassianServers;

package/out/data-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-adapter.d.ts","sourceRoot":"","sources":["../src/data-adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAK7D,qBAAa,gBAAiB,YAAW,YAAY;IAIjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc;IAJjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkC;gBAGrC,iBAAiB,GAAE,MAAc,EACjC,cAAc,GAAE,OAAc;IAM3C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;YA+ClC,yBAAyB;IAiCjC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ/B,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IA8B/C,oBAAoB,IAAI,MAAM;CAG/B"}
+{"version":3,"file":"data-adapter.d.ts","sourceRoot":"","sources":["../src/data-adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAM7D,qBAAa,gBAAiB,YAAW,YAAY;IASjD,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc;IATjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAkC;IACxD,OAAO,CAAC,OAAO,CAAgE;IAC/E,OAAO,CAAC,IAAI,CAGV;gBAGiB,iBAAiB,GAAE,MAAc,EACjC,cAAc,GAAE,OAAc;IAM3C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;YAoDlC,yBAAyB;IAuCjC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ/B,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IA8B/C,oBAAoB,IAAI,MAAM;CAG/B"}

package/out/data-adapter.js

@@ -6,16 +6,23 @@ class ForgeDataAdapter {
     pollingIntervalMs;
     pollingEnabled;
     cache = new Map();
+    metrics = (0, api_1.__getRuntime)()?.metrics;
+    tags = {
+        environment: (0, api_1.__getRuntime)()?.appContext?.environmentType || 'unknown',
+        appId: (0, api_1.__getRuntime)()?.appContext?.appId || 'unknown'
+    };
     constructor(pollingIntervalMs = 60000, pollingEnabled = true) {
         this.pollingIntervalMs = pollingIntervalMs;
         this.pollingEnabled = pollingEnabled;
     }
     async get(key) {
         try {
+            this.metrics?.counter('forge.feature-flags.data-adapter.get', this.tags).incr();
             const data = await this.fetchFromAtlassianServers();
             if (data) {
                 const serializedData = JSON.stringify(data);
                 this.cache.set(key, serializedData);
+                this.metrics?.counter('forge.feature-flags.data-adapter.get.success', this.tags).incr();
                 return {
                     result: serializedData,
                     time: Date.now()
@@ -23,19 +30,23 @@ class ForgeDataAdapter {
             }
             const cachedValue = this.cache.get(key);
             if (cachedValue) {
+                this.metrics?.counter('forge.feature-flags.data-adapter.get.cached', this.tags).incr();
                 return {
                     result: cachedValue,
                     time: Date.now()
                 };
             }
+            this.metrics?.counter('forge.feature-flags.data-adapter.get.empty', this.tags).incr();
             return {
                 result: undefined,
                 time: Date.now()
             };
         }
         catch {
+            this.metrics?.counter('forge.feature-flags.data-adapter.get.failure', this.tags).incr();
             const cachedValue = this.cache.get(key);
             if (cachedValue) {
+                this.metrics?.counter('forge.feature-flags.data-adapter.get.cached', this.tags).incr();
                 return {
                     result: cachedValue,
                     time: Date.now()
@@ -49,11 +60,17 @@ class ForgeDataAdapter {
     }
     async fetchFromAtlassianServers() {
         const runtime = (0, api_1.__getRuntime)();
-        if (runtime.proxy?.tokenExpiry && runtime.proxy.tokenExpiry * 1000 < Date.now()) {
+        if (runtime?.proxy?.tokenExpiry && runtime?.proxy?.tokenExpiry * 1000 < Date.now()) {
+            this.metrics
+                ?.counter('forge.feature-flags.data-adapter.fetchFromAtlassianServers.tokenExpired', this.tags)
+                .incr();
             return null;
         }
-        const remainingTime = runtime.lambdaContext?.getRemainingTimeInMillis?.();
+        const remainingTime = runtime?.lambdaContext?.getRemainingTimeInMillis?.();
         if (remainingTime !== undefined && remainingTime < 5000) {
+            this.metrics
+                ?.counter('forge.feature-flags.data-adapter.fetchFromAtlassianServers.remainingTimeComplete', this.tags)
+                .incr();
             return null;
         }
         const response = await (0, api_1.__fetchProduct)({ provider: 'app', remote: 'feature-flags', type: 'feature-flags' })('/', {
@@ -84,10 +101,10 @@ class ForgeDataAdapter {
         }
         try {
             const runtime = (0, api_1.__getRuntime)();
-            if (runtime.proxy?.tokenExpiry && runtime.proxy.tokenExpiry * 1000 < Date.now()) {
+            if (runtime?.proxy?.tokenExpiry && runtime?.proxy?.tokenExpiry * 1000 < Date.now()) {
                 return false;
             }
-            const remainingTime = runtime.lambdaContext?.getRemainingTimeInMillis?.();
+            const remainingTime = runtime?.lambdaContext?.getRemainingTimeInMillis?.();
             if (remainingTime !== undefined && remainingTime < 10000) {
                 return false;
             }

package/out/index.d.ts

@@ -2,12 +2,33 @@ export interface ForgeFeatureFlagConfig {
     environment?: 'development' | 'staging' | 'production';
 }
 export interface ForgeUser {
-    userID: string;
+    userID?: string;
     custom?: Record<string, string | number | boolean>;
+    attributes?: Record<string, string | number | boolean>;
+    identifiers?: {
+        installContext?: string;
+        accountId?: string;
+    };
+}
+export interface Counter {
+    incr(): void;
+    decr(): void;
+}
+export interface TimerStop {
+    stop(): void;
+}
+export interface Timer {
+    measure(): TimerStop;
+}
+export interface Metrics {
+    counter(name: string, tags?: Record<string, string>): Counter;
+    timing(name: string, tags?: Record<string, string>): Timer;
 }
 export declare class ForgeFeatureFlags {
     private initialized;
     private dataAdapter;
+    private metrics;
+    private tags;
     initialize(config?: ForgeFeatureFlagConfig): Promise<void>;
     checkFlag(user: ForgeUser, flagName: string): boolean;
     getFeatureFlags(user: ForgeUser, flagNames: string[]): Record<string, boolean>;

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC;CACxD;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CACpD;AAKD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAiC;IAKvC,UAAU,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BpE,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAQrD,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcxE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAe/B,aAAa,IAAI,OAAO;IAI/B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,WAAW;CAMpB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC;CACxD;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACvD,WAAW,CAAC,EAAE;QACZ,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,IAAI,IAAI,CAAC;IACb,IAAI,IAAI,IAAI,CAAC;CACd;AACD,MAAM,WAAW,SAAS;IACxB,IAAI,IAAI,IAAI,CAAC;CACd;AACD,MAAM,WAAW,KAAK;IACpB,OAAO,IAAI,SAAS,CAAC;CACtB;AACD,MAAM,WAAW,OAAO;IACtB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;IAC9D,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC;CAC5D;AAKD,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,OAAO,CAA2C;IAC1D,OAAO,CAAC,IAAI,CAGV;IAIW,UAAU,CAAC,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAsCpE,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IASrD,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAexE,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAe/B,aAAa,IAAI,OAAO;IAI/B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,WAAW;CAOpB"}

package/out/index.js

@@ -4,35 +4,54 @@ exports.ForgeFeatureFlags = void 0;
 const tslib_1 = require("tslib");
 const statsig_node_1 = tslib_1.__importDefault(require("statsig-node"));
 const data_adapter_1 = require("./data-adapter");
+const api_1 = require("@forge/api");
 class ForgeFeatureFlags {
     initialized = false;
     dataAdapter = null;
+    metrics = (0, api_1.__getRuntime)()?.metrics;
+    tags = {
+        environment: (0, api_1.__getRuntime)()?.appContext?.environmentType || 'unknown',
+        appId: (0, api_1.__getRuntime)()?.appContext?.appId || 'unknown'
+    };
     async initialize(config = {}) {
         if (this.initialized) {
             return;
         }
+        this.metrics?.counter('forge.feature-flags.initialize', this.tags).incr();
+        const timer = this.metrics?.timing('forge.feature-flags.initialize', this.tags).measure();
         try {
             statsig_node_1.default.shutdown();
         }
         catch { }
+        const remainingTime = (0, api_1.__getRuntime)()?.lambdaContext?.getRemainingTimeInMillis?.();
+        const disableRulesetsSync = remainingTime && remainingTime < 60000 ? true : false;
+        if (disableRulesetsSync) {
+            this.metrics?.counter('forge.feature-flags.disableRulesetsSync', this.tags).incr();
+        }
         this.dataAdapter = new data_adapter_1.ForgeDataAdapter(60000, true);
         const statsigOptions = {
             environment: { tier: config.environment || 'development' },
-            disableRulesetsSync: false,
+            disableRulesetsSync: disableRulesetsSync,
             disableIdListsSync: true,
             initTimeoutMs: 3000,
             localMode: true,
+            disableAllLogging: true,
+            disableDiagnostics: true,
             dataAdapter: this.dataAdapter
         };
-        await statsig_node_1.default.initialize('forge-internal-key', statsigOptions);
+        await statsig_node_1.default.initialize('secret-forge-internal-key', statsigOptions);
         this.initialized = true;
+        timer?.stop();
+        this.metrics?.counter('forge.feature-flags.initialize.success', this.tags).incr();
     }
     checkFlag(user, flagName) {
         this.ensureInitialized();
+        this.metrics?.counter('forge.feature-flags.checkFlag', this.tags).incr();
         return statsig_node_1.default.checkGate(this.convertUser(user), flagName);
     }
     getFeatureFlags(user, flagNames) {
         this.ensureInitialized();
+        this.metrics?.counter('forge.feature-flags.getFeatureFlags', this.tags).incr();
         const results = {};
         for (const flagName of flagNames) {
             results[flagName] = statsig_node_1.default.checkGate(this.convertUser(user), flagName);
@@ -48,6 +67,7 @@ class ForgeFeatureFlags {
             await this.dataAdapter.shutdown();
         }
         this.initialized = false;
+        this.metrics?.counter('forge.feature-flags.shutdown', this.tags).incr();
     }
     isInitialized() {
         return this.initialized;
@@ -60,7 +80,8 @@ class ForgeFeatureFlags {
     convertUser(user) {
         return {
             userID: user.userID,
-            custom: user.custom
+            custom: { ...(user.custom || {}), ...(user.attributes || {}) },
+            customIDs: user.identifiers || {}
         };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/feature-flags-node",
-  "version": "1.1.3",
+  "version": "2.0.0-next.0-experimental-3cf1031",
   "description": "Feature Flags Node SDK for Atlassian Forge apps running on Node Runtime",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -15,7 +15,7 @@
     "@types/node": "20.19.1"
   },
   "dependencies": {
-    "@forge/api": "^6.1.2",
+    "@forge/api": "^6.1.3-next.0-experimental-3cf1031",
     "statsig-node": "^6.4.3"
   },
   "publishConfig": {