@atlaskit/react-compiler-gating 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/react-compiler-gating
 
+## 0.2.5
+
+### Patch Changes
+
+- [`18a1c474f8fd9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/18a1c474f8fd9) -
+  Behind the `confluence_cache_react_compiler_fg` experiment, `isReactCompilerActivePlatform` caches
+  its result for the page load once Statsig has initialised. It never caches before initialisation,
+  when the experiment returns its default. The React Compiler calls this function once per compiled
+  function when its module first runs, often during hydration.
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/cjs/isReactCompilerActivePlatform.js

@@ -6,14 +6,35 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.isReactCompilerActivePlatform = isReactCompilerActivePlatform;
 var _featureGates = _interopRequireDefault(require("@atlaskit/feature-gate-js-client/feature-gates"));
+// The React Compiler calls this once per compiled function, when its module first runs.
+var cachedIsActive;
+var shouldCacheIsActive;
+
+// expVal from @atlaskit/platform-feature-experiments would import @atlaskit/react-ufo, which is
+// itself compiled with this gating function.
+function isExperimentEnabled(experimentName) {
+  return Boolean(_featureGates.default.getExperimentValue(experimentName, 'isEnabled', false));
+}
+
 /**
  * Returns true if the React Compiler runtime is active for platform packages.
  *
  * Controlled by the 'confluence_enable_react-compiler-runtime-platform' experiment in Switcheroo.
+ * Behind the 'confluence_cache_react_compiler_fg' experiment, the result is cached for the page
+ * load once Statsig has initialised.
  */
 function isReactCompilerActivePlatform() {
-  if (_featureGates.default.getExperimentValue('confluence_enable_react-compiler-runtime-platform', 'isEnabled', false)) {
-    return true;
+  if (cachedIsActive !== undefined) {
+    return cachedIsActive;
+  }
+  var isActive = isExperimentEnabled('confluence_enable_react-compiler-runtime-platform');
+
+  // Before Statsig initialises, getExperimentValue returns the default, which must not be cached.
+  if (shouldCacheIsActive === undefined && _featureGates.default.initializeCompleted()) {
+    shouldCacheIsActive = isExperimentEnabled('confluence_cache_react_compiler_fg');
+  }
+  if (shouldCacheIsActive) {
+    cachedIsActive = isActive;
   }
-  return false;
+  return isActive;
 }

package/dist/es2019/isReactCompilerActivePlatform.js

@@ -1,13 +1,34 @@
 import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
 
+// The React Compiler calls this once per compiled function, when its module first runs.
+let cachedIsActive;
+let shouldCacheIsActive;
+
+// expVal from @atlaskit/platform-feature-experiments would import @atlaskit/react-ufo, which is
+// itself compiled with this gating function.
+function isExperimentEnabled(experimentName) {
+  return Boolean(FeatureGates.getExperimentValue(experimentName, 'isEnabled', false));
+}
+
 /**
  * Returns true if the React Compiler runtime is active for platform packages.
  *
  * Controlled by the 'confluence_enable_react-compiler-runtime-platform' experiment in Switcheroo.
+ * Behind the 'confluence_cache_react_compiler_fg' experiment, the result is cached for the page
+ * load once Statsig has initialised.
  */
 export function isReactCompilerActivePlatform() {
-  if (FeatureGates.getExperimentValue('confluence_enable_react-compiler-runtime-platform', 'isEnabled', false)) {
-    return true;
+  if (cachedIsActive !== undefined) {
+    return cachedIsActive;
+  }
+  const isActive = isExperimentEnabled('confluence_enable_react-compiler-runtime-platform');
+
+  // Before Statsig initialises, getExperimentValue returns the default, which must not be cached.
+  if (shouldCacheIsActive === undefined && FeatureGates.initializeCompleted()) {
+    shouldCacheIsActive = isExperimentEnabled('confluence_cache_react_compiler_fg');
+  }
+  if (shouldCacheIsActive) {
+    cachedIsActive = isActive;
   }
-  return false;
+  return isActive;
 }

package/dist/esm/isReactCompilerActivePlatform.js

@@ -1,13 +1,34 @@
 import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
 
+// The React Compiler calls this once per compiled function, when its module first runs.
+var cachedIsActive;
+var shouldCacheIsActive;
+
+// expVal from @atlaskit/platform-feature-experiments would import @atlaskit/react-ufo, which is
+// itself compiled with this gating function.
+function isExperimentEnabled(experimentName) {
+  return Boolean(FeatureGates.getExperimentValue(experimentName, 'isEnabled', false));
+}
+
 /**
  * Returns true if the React Compiler runtime is active for platform packages.
  *
  * Controlled by the 'confluence_enable_react-compiler-runtime-platform' experiment in Switcheroo.
+ * Behind the 'confluence_cache_react_compiler_fg' experiment, the result is cached for the page
+ * load once Statsig has initialised.
  */
 export function isReactCompilerActivePlatform() {
-  if (FeatureGates.getExperimentValue('confluence_enable_react-compiler-runtime-platform', 'isEnabled', false)) {
-    return true;
+  if (cachedIsActive !== undefined) {
+    return cachedIsActive;
+  }
+  var isActive = isExperimentEnabled('confluence_enable_react-compiler-runtime-platform');
+
+  // Before Statsig initialises, getExperimentValue returns the default, which must not be cached.
+  if (shouldCacheIsActive === undefined && FeatureGates.initializeCompleted()) {
+    shouldCacheIsActive = isExperimentEnabled('confluence_cache_react_compiler_fg');
+  }
+  if (shouldCacheIsActive) {
+    cachedIsActive = isActive;
   }
-  return false;
+  return isActive;
 }

package/dist/types/isReactCompilerActivePlatform.d.ts

@@ -2,5 +2,7 @@
  * Returns true if the React Compiler runtime is active for platform packages.
  *
  * Controlled by the 'confluence_enable_react-compiler-runtime-platform' experiment in Switcheroo.
+ * Behind the 'confluence_cache_react_compiler_fg' experiment, the result is cached for the page
+ * load once Statsig has initialised.
  */
 export declare function isReactCompilerActivePlatform(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-compiler-gating",
-	"version": "0.2.4",
+	"version": "0.2.5",
 	"description": "Runtime gating for enabling the React Compiler in Atlassian platform packages.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/src/__tests__/isReactCompilerActivePlatform.test.ts

@@ -0,0 +1,129 @@
+import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
+
+const COMPILER_EXPERIMENT = 'confluence_enable_react-compiler-runtime-platform';
+const CACHE_EXPERIMENT = 'confluence_cache_react_compiler_fg';
+
+// The gating module keeps its cache at module scope, so every test loads a fresh copy.
+const loadIsReactCompilerActivePlatform = (): (() => boolean) => {
+	let isReactCompilerActivePlatform: (() => boolean) | undefined;
+	jest.isolateModules(() => {
+		isReactCompilerActivePlatform =
+			require('../isReactCompilerActivePlatform').isReactCompilerActivePlatform;
+	});
+	return isReactCompilerActivePlatform!;
+};
+
+describe('isReactCompilerActivePlatform', () => {
+	let experimentValues: Record<string, unknown>;
+	let getExperimentValueSpy: jest.SpyInstance;
+	let initializeCompletedSpy: jest.SpyInstance;
+
+	const setExperimentValue = (experimentName: string, value: unknown) => {
+		experimentValues[experimentName] = value;
+	};
+	const setInitializeCompleted = (value: boolean) => initializeCompletedSpy.mockReturnValue(value);
+	const experimentReads = (experimentName: string) =>
+		getExperimentValueSpy.mock.calls.filter(([name]) => name === experimentName).length;
+
+	beforeEach(() => {
+		experimentValues = {};
+		getExperimentValueSpy = jest
+			.spyOn(FeatureGates, 'getExperimentValue')
+			.mockImplementation(
+				(experimentName, _param, defaultValue) =>
+					(experimentValues[experimentName] ?? defaultValue) as never,
+			);
+		initializeCompletedSpy = jest.spyOn(FeatureGates, 'initializeCompleted').mockReturnValue(false);
+	});
+
+	afterEach(() => {
+		getExperimentValueSpy.mockRestore();
+		initializeCompletedSpy.mockRestore();
+	});
+
+	it('reads the experiment on every call before Statsig initialises', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, true);
+		setExperimentValue(COMPILER_EXPERIMENT, true);
+
+		expect(isReactCompilerActivePlatform()).toBe(true);
+		expect(isReactCompilerActivePlatform()).toBe(true);
+
+		expect(experimentReads(COMPILER_EXPERIMENT)).toBe(2);
+		expect(experimentReads(CACHE_EXPERIMENT)).toBe(0);
+	});
+
+	it('does not cache the default returned before Statsig initialises', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, true);
+
+		expect(isReactCompilerActivePlatform()).toBe(false);
+
+		setInitializeCompleted(true);
+		setExperimentValue(COMPILER_EXPERIMENT, true);
+
+		expect(isReactCompilerActivePlatform()).toBe(true);
+	});
+
+	it('caches the result after Statsig initialises when the cache experiment is on', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, true);
+		setInitializeCompleted(true);
+		setExperimentValue(COMPILER_EXPERIMENT, true);
+
+		expect(isReactCompilerActivePlatform()).toBe(true);
+		setExperimentValue(COMPILER_EXPERIMENT, false);
+		expect(isReactCompilerActivePlatform()).toBe(true);
+		expect(isReactCompilerActivePlatform()).toBe(true);
+
+		expect(experimentReads(COMPILER_EXPERIMENT)).toBe(1);
+	});
+
+	it('caches a false result', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, true);
+		setInitializeCompleted(true);
+
+		expect(isReactCompilerActivePlatform()).toBe(false);
+		setExperimentValue(COMPILER_EXPERIMENT, true);
+		expect(isReactCompilerActivePlatform()).toBe(false);
+
+		expect(experimentReads(COMPILER_EXPERIMENT)).toBe(1);
+	});
+
+	it('reads the experiment on every call when the cache experiment is off', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, false);
+		setInitializeCompleted(true);
+		setExperimentValue(COMPILER_EXPERIMENT, true);
+
+		expect(isReactCompilerActivePlatform()).toBe(true);
+		expect(isReactCompilerActivePlatform()).toBe(true);
+		setExperimentValue(COMPILER_EXPERIMENT, false);
+		expect(isReactCompilerActivePlatform()).toBe(false);
+
+		expect(experimentReads(COMPILER_EXPERIMENT)).toBe(3);
+	});
+
+	it('reads the cache experiment once, after Statsig initialises', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(CACHE_EXPERIMENT, false);
+
+		isReactCompilerActivePlatform();
+		expect(experimentReads(CACHE_EXPERIMENT)).toBe(0);
+
+		setInitializeCompleted(true);
+		isReactCompilerActivePlatform();
+		isReactCompilerActivePlatform();
+		isReactCompilerActivePlatform();
+
+		expect(experimentReads(CACHE_EXPERIMENT)).toBe(1);
+	});
+
+	it('returns false for a value that is not truthy', () => {
+		const isReactCompilerActivePlatform = loadIsReactCompilerActivePlatform();
+		setExperimentValue(COMPILER_EXPERIMENT, 0);
+
+		expect(isReactCompilerActivePlatform()).toBe(false);
+	});
+});

package/src/isReactCompilerActivePlatform.ts

@@ -1,19 +1,37 @@
 import FeatureGates from '@atlaskit/feature-gate-js-client/feature-gates';
 
+// The React Compiler calls this once per compiled function, when its module first runs.
+let cachedIsActive: boolean | undefined;
+let shouldCacheIsActive: boolean | undefined;
+
+// expVal from @atlaskit/platform-feature-experiments would import @atlaskit/react-ufo, which is
+// itself compiled with this gating function.
+function isExperimentEnabled(experimentName: string): boolean {
+	return Boolean(FeatureGates.getExperimentValue(experimentName, 'isEnabled', false));
+}
+
 /**
  * Returns true if the React Compiler runtime is active for platform packages.
  *
  * Controlled by the 'confluence_enable_react-compiler-runtime-platform' experiment in Switcheroo.
+ * Behind the 'confluence_cache_react_compiler_fg' experiment, the result is cached for the page
+ * load once Statsig has initialised.
  */
 export function isReactCompilerActivePlatform(): boolean {
-	if (
-		FeatureGates.getExperimentValue(
-			'confluence_enable_react-compiler-runtime-platform',
-			'isEnabled',
-			false,
-		)
-	) {
-		return true;
+	if (cachedIsActive !== undefined) {
+		return cachedIsActive;
 	}
-	return false;
+
+	const isActive = isExperimentEnabled('confluence_enable_react-compiler-runtime-platform');
+
+	// Before Statsig initialises, getExperimentValue returns the default, which must not be cached.
+	if (shouldCacheIsActive === undefined && FeatureGates.initializeCompleted()) {
+		shouldCacheIsActive = isExperimentEnabled('confluence_cache_react_compiler_fg');
+	}
+
+	if (shouldCacheIsActive) {
+		cachedIsActive = isActive;
+	}
+
+	return isActive;
 }

package/tsconfig.app.json

@@ -1,7 +1,8 @@
 {
 	"extends": "../../../tsconfig.base.json",
-	"include": ["./src/**/*.ts", "./src/**/*.tsx"],
-	"exclude": [
+	"include": [
+		"./src/**/*.ts",
+		"./src/**/*.tsx",
 		"**/docs/**/*",
 		"**/__tests__/**/*",
 		"**/vr-tests/**/*",
@@ -29,6 +30,7 @@
 		"**/codemods/**/*.ts",
 		"**/codemods/**/*.tsx"
 	],
+	"exclude": [],
 	"compilerOptions": {
 		"composite": true,
 		"outDir": "../../../tsDist/@atlaskit__react-compiler-gating/app",

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "./tsconfig.dev.json",
+	"extends": "./tsconfig.app.json",
 	"compilerOptions": {
 		"disableReferencedProjectLoad": true,
 		"disableSolutionSearching": true

package/tsconfig.dev.json

@@ -1,42 +0,0 @@
-{
-	"extends": "../../../tsconfig.base.json",
-	"include": [
-		"**/docs/**/*",
-		"**/__tests__/**/*",
-		"**/vr-tests/**/*",
-		"**/__perf__/**/*",
-		"**/*.test.*",
-		"**/test.*",
-		"**/test-*",
-		"**/examples.ts",
-		"**/examples.tsx",
-		"**/examples/*.ts",
-		"**/examples/*.tsx",
-		"**/examples/**/*.ts",
-		"**/examples/**/*.tsx",
-		"**/storybook/**/*",
-		"**/constellation/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*",
-		".storybook/*",
-		"./__fixtures__/**/*",
-		"./__generated__/**/*",
-		"./mocks/**/*",
-		"./__mocks__/**/*",
-		"**/mock.*",
-		"**/codemods/**/*.ts",
-		"**/codemods/**/*.tsx"
-	],
-	"exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
-	"compilerOptions": {
-		"composite": true,
-		"outDir": "../../../tsDist/@atlaskit__react-compiler-gating/dev",
-		"isolatedDeclarations": true
-	},
-	"references": [
-		{
-			"path": "./tsconfig.app.json"
-		}
-	]
-}