@atlaspack/feature-flags 2.14.1-dev.118 → 2.14.1-dev.123

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @atlaspack/feature-flags
 
+## 2.16.0
+
+### Minor Changes
+
+- [#582](https://github.com/atlassian-labs/atlaspack/pull/582) [`f4da1e1`](https://github.com/atlassian-labs/atlaspack/commit/f4da1e120e73eeb5e8b8927f05e88f04d6148c7b) Thanks [@matt-koko](https://github.com/matt-koko)! - Export DEFAULT_FEATURE_FLAGS so it will be included in the associate type declaration file and able to be imported elsewhere.
+
+  This will enable patterns like:
+
+  ```
+  import type { FeatureFlags } from '@atlaspack/feature-flags';
+  import { DEFAULT_FEATURE_FLAGS } from '@atlaspack/feature-flags';
+  ```
+
+### Patch Changes
+
+- [#503](https://github.com/atlassian-labs/atlaspack/pull/503) [`209692f`](https://github.com/atlassian-labs/atlaspack/commit/209692ffb11eae103a0d65c5e1118a5aa1625818) Thanks [@JakeLane](https://github.com/JakeLane)! - Fix conditional bundling reporter when condition is reused
+
+## 2.15.1
+
+### Patch Changes
+
+- [#551](https://github.com/atlassian-labs/atlaspack/pull/551) [`30f6017`](https://github.com/atlassian-labs/atlaspack/commit/30f60175ba4d272c5fc193973c63bc298584775b) Thanks [@yamadapc](https://github.com/yamadapc)! - Log request tracker invalidation counts on start-up
+
+## 2.15.0
+
+### Minor Changes
+
+- [#547](https://github.com/atlassian-labs/atlaspack/pull/547) [`a1773d2`](https://github.com/atlassian-labs/atlaspack/commit/a1773d2a62d0ef7805ac7524621dcabcc1afe929) Thanks [@benjervis](https://github.com/benjervis)! - Add a feature flag for resolving the configuration for `@atlaspack/bundler-default` from CWD, rather than exclusively from the project root.
+
+## 2.14.4
+
+### Patch Changes
+
+- [#542](https://github.com/atlassian-labs/atlaspack/pull/542) [`e0f5337`](https://github.com/atlassian-labs/atlaspack/commit/e0f533757bd1019dbd108a04952c87da15286e09) Thanks [@yamadapc](https://github.com/yamadapc)! - Add feature-flagged option to use rayon thread-pool to optimize inline requires
+
+## 2.14.3
+
+### Patch Changes
+
+- [#511](https://github.com/atlassian-labs/atlaspack/pull/511) [`11d6f16`](https://github.com/atlassian-labs/atlaspack/commit/11d6f16b6397dee2f217167e5c98b39edb63f7a7) Thanks [@yamadapc](https://github.com/yamadapc)! - Clean-up dylib worker threads segmentation fault bug fix feature-flag
+
+## 2.14.2
+
+### Patch Changes
+
+- [#494](https://github.com/atlassian-labs/atlaspack/pull/494) [`9b85d3e`](https://github.com/atlassian-labs/atlaspack/commit/9b85d3e645b10bd027eed2304afc970a5ba40062) Thanks [@JakeLane](https://github.com/JakeLane)! - When conditionalBundlingReporterDuplicateFix is enabled, avoid duplicated writes to the descriptor and logging
+
+- [#510](https://github.com/atlassian-labs/atlaspack/pull/510) [`17b9579`](https://github.com/atlassian-labs/atlaspack/commit/17b9579484eced0ed8f23e2aba6d23b3c7238c39) Thanks [@yamadapc](https://github.com/yamadapc)! - Add unused feature-flag for cache rework changes
+
+- [#512](https://github.com/atlassian-labs/atlaspack/pull/512) [`8f4e6c1`](https://github.com/atlassian-labs/atlaspack/commit/8f4e6c1b0e7c1fd48624afda48c1dcc599f1460f) Thanks [@yamadapc](https://github.com/yamadapc)! - Remove LMDB cache back-end
+
 ## 2.14.1
 
 ### Patch Changes

package/index.d.ts

@@ -0,0 +1 @@
+export * from '@atlaspack/unified/feature-flags';

package/index.js

@@ -0,0 +1 @@
+module.exports = require('@atlaspack/unified/feature-flags');

package/index.js.flow

@@ -0,0 +1,3 @@
+// @flow
+
+export * from '@atlaspack/unified/src/feature-flags/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/feature-flags",
-  "version": "2.14.1-dev.118+f615781c0",
+  "version": "2.14.1-dev.123+5a11f33c5",
   "description": "Provides internal feature-flags for the atlaspack codebase.",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
@@ -10,16 +10,11 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/index.js",
-  "source": "src/index.js",
-  "types": "lib/types.d.ts",
-  "scripts": {
-    "build-ts": "mkdir -p lib && flow-to-ts src/types.js > lib/types.d.ts",
-    "check-ts": "tsc --noEmit lib/types.d.ts"
-  },
-  "engines": {
-    "node": ">= 16.0.0"
-  },
+  "main": "index.js",
+  "types": "types.d.ts",
   "type": "commonjs",
-  "gitHead": "f615781c07b16806135476593869793c64e9f4b6"
+  "dependencies": {
+    "@atlaspack/unified": "2.14.2-dev.3834+5a11f33c5"
+  },
+  "gitHead": "5a11f33c51ff74d1cf8d4b72cfa0fda833aa980a"
 }

package/lib/index.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DEFAULT_FEATURE_FLAGS = void 0;
-exports.getFeatureFlag = getFeatureFlag;
-exports.getFeatureFlagValue = getFeatureFlagValue;
-exports.runWithConsistencyCheck = runWithConsistencyCheck;
-exports.setFeatureFlags = setFeatureFlags;
-// We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
-// but we want to export FeatureFlags for Flow
-const DEFAULT_FEATURE_FLAGS = exports.DEFAULT_FEATURE_FLAGS = {
-  exampleConsistencyCheckFeature: 'OLD',
-  exampleFeature: false,
-  atlaspackV3: false,
-  useWatchmanWatcher: false,
-  importRetry: false,
-  fixQuadraticCacheInvalidation: 'OLD',
-  useLmdbJsLite: true,
-  conditionalBundlingApi: false,
-  vcsMode: 'OLD',
-  loadableSideEffects: false,
-  reduceResolverStringCreation: false,
-  inlineBundlesSourceMapFixes: false,
-  conditionalBundlingNestedRuntime: false,
-  patchProjectPaths: false,
-  enableRustWorkerThreadDylibHack: true,
-  inlineStringReplacementPerf: false,
-  conditionalBundlingAsyncRuntime: false
-};
-let featureFlagValues = {
-  ...DEFAULT_FEATURE_FLAGS
-};
-function setFeatureFlags(flags) {
-  featureFlagValues = flags;
-}
-function getFeatureFlag(flagName) {
-  const value = featureFlagValues[flagName];
-  return value === true || value === 'NEW';
-}
-function getFeatureFlagValue(flagName) {
-  return featureFlagValues[flagName];
-}
-/**
- * Run a function with a consistency check.
- */
-function runWithConsistencyCheck(flag, oldFn, newFn, diffFn, report) {
-  const value = featureFlagValues[flag];
-  if (!value || value === false || value === 'OLD') {
-    return oldFn();
-  }
-  if (value === true || value === 'NEW') {
-    return newFn();
-  }
-  const oldStartTime = performance.now();
-  const oldResult = oldFn();
-  const oldExecutionTimeMs = performance.now() - oldStartTime;
-  const newStartTime = performance.now();
-  const newResult = newFn();
-  const newExecutionTimeMs = performance.now() - newStartTime;
-  const diff = diffFn(oldResult, newResult);
-  report({
-    isDifferent: diff.isDifferent,
-    oldExecutionTimeMs,
-    newExecutionTimeMs,
-    custom: diff.custom
-  }, oldResult, newResult);
-  if (value === 'NEW_AND_CHECK') {
-    return newResult;
-  }
-  return oldResult;
-}

package/lib/types.d.ts

@@ -1,88 +0,0 @@
-export type FeatureFlags = {
-  // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
-  readonly exampleFeature: boolean;
-  readonly exampleConsistencyCheckFeature: ConsistencyCheckFeatureFlagValue;
-
-  /**
-   * Rust backed requests
-   */
-  readonly atlaspackV3: boolean;
-
-  /**
-   * Use node.js implementation of @parcel/watcher watchman backend
-   */
-  readonly useWatchmanWatcher: boolean;
-
-  /**
-   * Configure runtime to enable retriable dynamic imports
-   */
-  importRetry: boolean;
-
-  /**
-   * Enable Rust based LMDB wrapper library
-   */
-  useLmdbJsLite: boolean;
-
-  /**
-   * Fixes quadratic cache invalidation issue
-   */
-  fixQuadraticCacheInvalidation: ConsistencyCheckFeatureFlagValue;
-
-  /**
-   * Enables an experimental "conditional bundling" API - this allows the use of `importCond` syntax
-   * in order to have (consumer) feature flag driven bundling. This feature is very experimental,
-   * and requires server-side support.
-   */
-  conditionalBundlingApi: boolean;
-
-  /**
-   * Enable VCS mode. Expected values are:
-   * - OLD - default value, return watchman result
-   * - NEW_AND_CHECK - Return VCS result but still call watchman
-   * - NEW: Return VCS result, but don't call watchman
-   */
-  vcsMode: ConsistencyCheckFeatureFlagValue;
-
-  /**
-   * Enable scanning for the presence of loadable to determine side effects
-   */
-  loadableSideEffects: boolean;
-
-  /**
-   * Enable performance optimization for the resolver specifier to_string
-   * conversions
-   */
-  reduceResolverStringCreation: boolean;
-
-  /**
-   * Fixes source maps for inline bundles
-   */
-  inlineBundlesSourceMapFixes: boolean;
-
-  /**
-   * Enable nested loading of bundles in the runtime with conditional bundling
-   */
-  conditionalBundlingNestedRuntime: boolean;
-
-  /** Enable patch project paths. This will patch the project paths to be relative to the project root.
-   * This feature is experimental and should not be used in production. It will used to test downloadble cache artefacts.
-   */
-  patchProjectPaths: boolean;
-
-  /**
-   * Enable loading of the parcel dylib in the main thread.
-   */
-  enableRustWorkerThreadDylibHack: boolean;
-
-  /**
-   * Enables optimized inline string replacement perf for the packager.
-   * Used heavily for inline bundles.
-   */
-  inlineStringReplacementPerf: boolean;
-
-  /**
-   * Enable support for the async bundle runtime (unstable_asyncBundleRuntime) in conditional bundling
-   */
-  conditionalBundlingAsyncRuntime: boolean;
-};
-export type ConsistencyCheckFeatureFlagValue = "NEW" | "OLD" | "NEW_AND_CHECK" | "OLD_AND_CHECK";

package/lib/types.js

@@ -1 +0,0 @@
-"use strict";

package/src/index.js

@@ -1,108 +0,0 @@
-// @flow strict
-
-import type {FeatureFlags as _FeatureFlags} from './types';
-// We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
-// but we want to export FeatureFlags for Flow
-export type FeatureFlags = _FeatureFlags;
-
-export const DEFAULT_FEATURE_FLAGS: FeatureFlags = {
-  exampleConsistencyCheckFeature: 'OLD',
-  exampleFeature: false,
-  atlaspackV3: false,
-  useWatchmanWatcher: false,
-  importRetry: false,
-  fixQuadraticCacheInvalidation: 'OLD',
-  useLmdbJsLite: true,
-  conditionalBundlingApi: false,
-  vcsMode: 'OLD',
-  loadableSideEffects: false,
-  reduceResolverStringCreation: false,
-  inlineBundlesSourceMapFixes: false,
-  conditionalBundlingNestedRuntime: false,
-  patchProjectPaths: false,
-  enableRustWorkerThreadDylibHack: true,
-  inlineStringReplacementPerf: false,
-  conditionalBundlingAsyncRuntime: false,
-};
-
-let featureFlagValues: FeatureFlags = {...DEFAULT_FEATURE_FLAGS};
-
-export function setFeatureFlags(flags: FeatureFlags) {
-  featureFlagValues = flags;
-}
-
-export function getFeatureFlag(flagName: $Keys<FeatureFlags>): boolean {
-  const value = featureFlagValues[flagName];
-  return value === true || value === 'NEW';
-}
-
-export function getFeatureFlagValue(
-  flagName: $Keys<FeatureFlags>,
-): boolean | string | number {
-  return featureFlagValues[flagName];
-}
-
-export type DiffResult<CustomDiagnostic> = {|
-  isDifferent: boolean,
-  custom: CustomDiagnostic,
-|};
-
-export type Diagnostic<CustomDiagnostic> = {|
-  isDifferent: boolean,
-  oldExecutionTimeMs: number,
-  newExecutionTimeMs: number,
-  custom: CustomDiagnostic,
-|};
-
-/**
- * Run a function with a consistency check.
- */
-export function runWithConsistencyCheck<Result, CustomDiagnostic>(
-  flag: string,
-  oldFn: () => Result,
-  newFn: () => Result,
-  diffFn: (
-    oldResult: Result,
-    newResult: Result,
-  ) => DiffResult<CustomDiagnostic>,
-  report: (
-    diagnostic: Diagnostic<CustomDiagnostic>,
-    oldResult: Result,
-    newResult: Result,
-  ) => void,
-): Result {
-  const value = featureFlagValues[flag];
-  if (!value || value === false || value === 'OLD') {
-    return oldFn();
-  }
-  if (value === true || value === 'NEW') {
-    return newFn();
-  }
-
-  const oldStartTime = performance.now();
-  const oldResult = oldFn();
-  const oldExecutionTimeMs = performance.now() - oldStartTime;
-
-  const newStartTime = performance.now();
-  const newResult = newFn();
-  const newExecutionTimeMs = performance.now() - newStartTime;
-
-  const diff = diffFn(oldResult, newResult);
-
-  report(
-    {
-      isDifferent: diff.isDifferent,
-      oldExecutionTimeMs,
-      newExecutionTimeMs,
-      custom: diff.custom,
-    },
-    oldResult,
-    newResult,
-  );
-
-  if (value === 'NEW_AND_CHECK') {
-    return newResult;
-  }
-
-  return oldResult;
-}

package/src/types.js

@@ -1,80 +0,0 @@
-// @flow strict
-
-export type FeatureFlags = {|
-  // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
-  +exampleFeature: boolean,
-  +exampleConsistencyCheckFeature: ConsistencyCheckFeatureFlagValue,
-  /**
-   * Rust backed requests
-   */
-  +atlaspackV3: boolean,
-  /**
-   * Use node.js implementation of @parcel/watcher watchman backend
-   */
-  +useWatchmanWatcher: boolean,
-  /**
-   * Configure runtime to enable retriable dynamic imports
-   */
-  importRetry: boolean,
-  /**
-   * Enable Rust based LMDB wrapper library
-   */
-  useLmdbJsLite: boolean,
-  /**
-   * Fixes quadratic cache invalidation issue
-   */
-  fixQuadraticCacheInvalidation: ConsistencyCheckFeatureFlagValue,
-  /**
-   * Enables an experimental "conditional bundling" API - this allows the use of `importCond` syntax
-   * in order to have (consumer) feature flag driven bundling. This feature is very experimental,
-   * and requires server-side support.
-   */
-  conditionalBundlingApi: boolean,
-  /**
-   * Enable VCS mode. Expected values are:
-   * - OLD - default value, return watchman result
-   * - NEW_AND_CHECK - Return VCS result but still call watchman
-   * - NEW: Return VCS result, but don't call watchman
-   */
-  vcsMode: ConsistencyCheckFeatureFlagValue,
-  /**
-   * Enable scanning for the presence of loadable to determine side effects
-   */
-  loadableSideEffects: boolean,
-  /**
-   * Enable performance optimization for the resolver specifier to_string
-   * conversions
-   */
-  reduceResolverStringCreation: boolean,
-  /**
-   * Fixes source maps for inline bundles
-   */
-  inlineBundlesSourceMapFixes: boolean,
-  /**
-   * Enable nested loading of bundles in the runtime with conditional bundling
-   */
-  conditionalBundlingNestedRuntime: boolean,
-  /** Enable patch project paths. This will patch the project paths to be relative to the project root.
-   * This feature is experimental and should not be used in production. It will used to test downloadble cache artefacts.
-   */
-  patchProjectPaths: boolean,
-  /**
-   * Enable loading of the parcel dylib in the main thread.
-   */
-  enableRustWorkerThreadDylibHack: boolean,
-  /**
-   * Enables optimized inline string replacement perf for the packager.
-   * Used heavily for inline bundles.
-   */
-  inlineStringReplacementPerf: boolean,
-  /**
-   * Enable support for the async bundle runtime (unstable_asyncBundleRuntime) in conditional bundling
-   */
-  conditionalBundlingAsyncRuntime: boolean,
-|};
-
-export type ConsistencyCheckFeatureFlagValue =
-  | 'NEW'
-  | 'OLD'
-  | 'NEW_AND_CHECK'
-  | 'OLD_AND_CHECK';

package/test/feature-flags.test.js

@@ -1,105 +0,0 @@
-// @flow strict
-import assert from 'assert';
-import {
-  getFeatureFlag,
-  DEFAULT_FEATURE_FLAGS,
-  setFeatureFlags,
-  runWithConsistencyCheck,
-} from '../src';
-import sinon from 'sinon';
-
-describe('feature-flag test', () => {
-  beforeEach(() => {
-    setFeatureFlags(DEFAULT_FEATURE_FLAGS);
-  });
-
-  it('has defaults', () => {
-    assert.equal(
-      getFeatureFlag('exampleFeature'),
-      DEFAULT_FEATURE_FLAGS.exampleFeature,
-    );
-  });
-
-  it('can override', () => {
-    setFeatureFlags({...DEFAULT_FEATURE_FLAGS, exampleFeature: true});
-    assert.equal(getFeatureFlag('exampleFeature'), true);
-  });
-
-  describe('consistency checks', () => {
-    it('runs the old function if the flag is off', () => {
-      setFeatureFlags({
-        ...DEFAULT_FEATURE_FLAGS,
-        exampleConsistencyCheckFeature: 'OLD',
-      });
-      const result = runWithConsistencyCheck(
-        'exampleConsistencyCheckFeature',
-        () => 'old',
-        () => 'new',
-        sinon.spy(),
-        sinon.spy(),
-      );
-      assert.equal(result, 'old');
-    });
-
-    it('runs the new function if the flag is on', () => {
-      setFeatureFlags({
-        ...DEFAULT_FEATURE_FLAGS,
-        exampleConsistencyCheckFeature: 'NEW',
-      });
-      const result = runWithConsistencyCheck(
-        'exampleConsistencyCheckFeature',
-        () => 'old',
-        () => 'new',
-        sinon.spy(),
-        sinon.spy(),
-      );
-      assert.equal(result, 'new');
-    });
-
-    it('diffs old and new values if there is a diff value', () => {
-      setFeatureFlags({
-        ...DEFAULT_FEATURE_FLAGS,
-        exampleConsistencyCheckFeature: 'OLD_AND_CHECK',
-      });
-      const reportSpy = sinon.spy();
-      const result = runWithConsistencyCheck(
-        'exampleConsistencyCheckFeature',
-        () => 'old',
-        () => 'new',
-        () => ({isDifferent: false, custom: 'diff'}),
-        reportSpy,
-      );
-
-      assert.equal(result, 'old');
-      sinon.assert.calledWith(reportSpy, {
-        isDifferent: false,
-        oldExecutionTimeMs: sinon.match.number,
-        newExecutionTimeMs: sinon.match.number,
-        custom: 'diff',
-      });
-    });
-
-    it('diffs old and new values if there is a diff new value', () => {
-      setFeatureFlags({
-        ...DEFAULT_FEATURE_FLAGS,
-        exampleConsistencyCheckFeature: 'NEW_AND_CHECK',
-      });
-      const reportSpy = sinon.spy();
-      const result = runWithConsistencyCheck(
-        'exampleConsistencyCheckFeature',
-        () => 'old',
-        () => 'new',
-        () => ({isDifferent: true, custom: 'diff'}),
-        reportSpy,
-      );
-
-      assert.equal(result, 'new');
-      sinon.assert.calledWith(reportSpy, {
-        isDifferent: true,
-        oldExecutionTimeMs: sinon.match.number,
-        newExecutionTimeMs: sinon.match.number,
-        custom: 'diff',
-      });
-    });
-  });
-});