@atlaspack/feature-flags 2.19.2 → 2.19.3-typescript-80839fbd5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -68,7 +68,6 @@
68
68
  ### Patch Changes
69
69
 
70
70
  - [#632](https://github.com/atlassian-labs/atlaspack/pull/632) [`10fbcfb`](https://github.com/atlassian-labs/atlaspack/commit/10fbcfbfa49c7a83da5d7c40983e36e87f524a75) Thanks [@marcins](https://github.com/marcins)! - Added a new feature flag `inlineConstOptimisationFix` which when enabled changes the behaviour for output of constant modules. This fixes two issues with constant modules:
71
-
72
71
  - Previously constant modules, if they needed a namespace anywhere, would have a namespace everywhere, with this change they only have a namespace in the bundles where needed.
73
72
  - Previously in the case of wrapped assets, a constant module dependnecy of that wrapped asset would be rendered after the module - which meant the minifier would not be able to inline the constants safely. With this flag all constant modules are rendered at the top of the bundle.
74
73
 
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright (c) 2024 Atlassian US., Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/lib/index.js CHANGED
@@ -8,8 +8,8 @@ exports.getFeatureFlag = getFeatureFlag;
8
8
  exports.getFeatureFlagValue = getFeatureFlagValue;
9
9
  exports.runWithConsistencyCheck = runWithConsistencyCheck;
10
10
  exports.setFeatureFlags = setFeatureFlags;
11
- // We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
12
- // but we want to export FeatureFlags for Flow
11
+ // Converted from Flow to TypeScript
12
+
13
13
  const CONSISTENCY_CHECK_VALUES = exports.CONSISTENCY_CHECK_VALUES = Object.freeze(['NEW', 'OLD', 'NEW_AND_CHECK', 'OLD_AND_CHECK']);
14
14
  const DEFAULT_FEATURE_FLAGS = exports.DEFAULT_FEATURE_FLAGS = {
15
15
  exampleConsistencyCheckFeature: 'OLD',
@@ -59,6 +59,7 @@ function getFeatureFlagValue(flagName) {
59
59
  */
60
60
  function runWithConsistencyCheck(flag, oldFn, newFn, diffFn, report) {
61
61
  const value = featureFlagValues[flag];
62
+ // @ts-expect-error - TypeScript doesn't understand the union type comparison
62
63
  if (!value || value === false || value === 'OLD') {
63
64
  return oldFn();
64
65
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaspack/feature-flags",
3
- "version": "2.19.2",
3
+ "version": "2.19.3-typescript-80839fbd5.0",
4
4
  "description": "Provides internal feature-flags for the atlaspack codebase.",
5
5
  "license": "(MIT OR Apache-2.0)",
6
6
  "publishConfig": {
@@ -11,14 +11,14 @@
11
11
  "url": "https://github.com/atlassian-labs/atlaspack.git"
12
12
  },
13
13
  "main": "lib/index.js",
14
- "source": "src/index.js",
15
- "types": "lib/types.d.ts",
14
+ "source": "src/index.ts",
15
+ "types": "src/index.ts",
16
16
  "scripts": {
17
- "build-ts": "mkdir -p lib && flow-to-ts src/types.js > lib/types.d.ts",
18
- "check-ts": "tsc --noEmit lib/types.d.ts"
17
+ "check-ts": "tsc --noEmit"
19
18
  },
20
19
  "engines": {
21
20
  "node": ">= 16.0.0"
22
21
  },
23
- "type": "commonjs"
22
+ "type": "commonjs",
23
+ "gitHead": "80839fbd5c6d6668c2622849856a4b25601354a8"
24
24
  }
@@ -1,36 +1,33 @@
1
- import { $ElementType } from "utility-types";
1
+ // Converted from Flow to TypeScript
2
+
2
3
  export type FeatureFlags = {
3
- // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
4
+ /**
5
+ * This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
6
+ */
4
7
  readonly exampleFeature: boolean;
5
8
  readonly exampleConsistencyCheckFeature: ConsistencyCheckFeatureFlagValue;
6
-
7
9
  /**
8
10
  * Rust backed requests
9
11
  */
10
12
  readonly atlaspackV3: boolean;
11
-
12
13
  /**
13
14
  * Use node.js implementation of @parcel/watcher watchman backend
14
15
  */
15
16
  readonly useWatchmanWatcher: boolean;
16
-
17
17
  /**
18
18
  * Configure runtime to enable retriable dynamic imports
19
19
  */
20
20
  importRetry: boolean;
21
-
22
21
  /**
23
22
  * Fixes quadratic cache invalidation issue
24
23
  */
25
24
  fixQuadraticCacheInvalidation: ConsistencyCheckFeatureFlagValue;
26
-
27
25
  /**
28
26
  * Enables an experimental "conditional bundling" API - this allows the use of `importCond` syntax
29
27
  * in order to have (consumer) feature flag driven bundling. This feature is very experimental,
30
28
  * and requires server-side support.
31
29
  */
32
30
  conditionalBundlingApi: boolean;
33
-
34
31
  /**
35
32
  * Enable VCS mode. Expected values are:
36
33
  * - OLD - default value, return watchman result
@@ -38,7 +35,6 @@ export type FeatureFlags = {
38
35
  * - NEW: Return VCS result, but don't call watchman
39
36
  */
40
37
  vcsMode: ConsistencyCheckFeatureFlagValue;
41
-
42
38
  /**
43
39
  * Refactor cache to:
44
40
  * - Split writes into multiple entries
@@ -46,90 +42,74 @@ export type FeatureFlags = {
46
42
  * - Reduce size of the caches by deduplicating data
47
43
  */
48
44
  cachePerformanceImprovements: boolean;
49
-
50
45
  /**
51
46
  * Deduplicates environments across cache / memory entities
52
47
  */
53
48
  environmentDeduplication: boolean;
54
-
55
49
  /**
56
50
  * Enable scanning for the presence of loadable to determine side effects
57
51
  */
58
52
  loadableSideEffects: boolean;
59
-
60
53
  /**
61
54
  * Enable performance optimization for the resolver specifier to_string
62
55
  * conversions
63
56
  */
64
57
  reduceResolverStringCreation: boolean;
65
-
66
58
  /**
67
59
  * Add verbose metrics for request tracker invalidation
68
60
  */
69
61
  verboseRequestInvalidationStats: boolean;
70
-
71
62
  /**
72
63
  * Fixes source maps for inline bundles
73
64
  */
74
65
  inlineBundlesSourceMapFixes: boolean;
75
-
76
66
  /** Enable patch project paths. This will patch the project paths to be relative to the project root.
77
67
  * This feature is experimental and should not be used in production. It will used to test downloadble cache artefacts.
78
68
  */
79
69
  patchProjectPaths: boolean;
80
-
81
70
  /**
82
71
  * Enables optimized inline string replacement perf for the packager.
83
72
  * Used heavily for inline bundles.
84
73
  */
85
74
  inlineStringReplacementPerf: boolean;
86
-
87
75
  /**
88
76
  * Enable resolution of bundler config starting from the CWD
89
77
  */
90
78
  resolveBundlerConfigFromCwd: boolean;
91
-
92
79
  /**
93
80
  * Enable a setting that allows for more assets to be scope hoisted, if
94
81
  * they're safe to do so.
95
82
  */
96
83
  applyScopeHoistingImprovement: boolean;
97
-
98
84
  /**
99
85
  * Enable a change where a constant module only have the namespacing object added in bundles where it is required
100
86
  */
101
87
  inlineConstOptimisationFix: boolean;
102
-
103
88
  /**
104
89
  * Improves/fixes HMR behaviour by:
105
90
  * - Fixing HMR behaviour with lazy bundle edges
106
91
  * - Moving the functionality of the react-refresh runtime into the react-refresh-wrap transformer
107
92
  */
108
93
  hmrImprovements: boolean;
109
-
110
94
  /**
111
95
  * Adds an end() method to AtlaspckV3 to cleanly shutdown the NAPI worker pool
112
96
  */
113
97
  atlaspackV3CleanShutdown: boolean;
114
-
115
98
  /**
116
99
  * Fixes a bug where imported objects that are accessed with non-static
117
100
  * properties (e.g. `CONSTANTS['api_' + endpoint`]) would not be recognised as
118
101
  * being used, and thus not included in the bundle.
119
102
  */
120
103
  unusedComputedPropertyFix: boolean;
121
-
122
104
  /**
123
105
  * Fixes an issue where star re-exports of empty files (usually occurring in compiled typescript libraries)
124
106
  * could cause exports to undefined at runtime.
125
107
  */
126
108
  emptyFileStarRexportFix: boolean;
127
-
128
109
  /**
129
110
  * Enables the new packaging progress CLI experience
130
111
  */
131
112
  cliProgressReportingImprovements: boolean;
132
-
133
113
  /**
134
114
  * Enable a change to the conditional bundling loader to use a fallback bundle loading if the expected scripts aren't found
135
115
  *
@@ -137,13 +117,133 @@ export type FeatureFlags = {
137
117
  */
138
118
  condbDevFallbackDev: boolean;
139
119
  condbDevFallbackProd: boolean;
140
-
141
120
  /**
142
121
  * Enable the new incremental bundling versioning logic which determines whether
143
122
  * a full bundling pass is required based on the AssetGraph's bundlingVersion.
144
123
  */
145
124
  incrementalBundlingVersioning: boolean;
146
125
  };
147
- export declare var CONSISTENCY_CHECK_VALUES: ReadonlyArray<string>;
148
- export type ConsistencyCheckFeatureFlagValue = $ElementType<typeof CONSISTENCY_CHECK_VALUES, number>;
149
- export declare var DEFAULT_FEATURE_FLAGS: FeatureFlags;
126
+
127
+ export type ConsistencyCheckFeatureFlagValue =
128
+ (typeof CONSISTENCY_CHECK_VALUES)[number];
129
+
130
+ export const CONSISTENCY_CHECK_VALUES: ReadonlyArray<string> = Object.freeze([
131
+ 'NEW',
132
+ 'OLD',
133
+ 'NEW_AND_CHECK',
134
+ 'OLD_AND_CHECK',
135
+ ]);
136
+
137
+ export const DEFAULT_FEATURE_FLAGS: FeatureFlags = {
138
+ exampleConsistencyCheckFeature: 'OLD',
139
+ exampleFeature: false,
140
+ atlaspackV3: false,
141
+ useWatchmanWatcher: false,
142
+ importRetry: false,
143
+ fixQuadraticCacheInvalidation: 'OLD',
144
+ conditionalBundlingApi: false,
145
+ vcsMode: 'OLD',
146
+ loadableSideEffects: false,
147
+ reduceResolverStringCreation: false,
148
+ inlineBundlesSourceMapFixes: false,
149
+ patchProjectPaths: false,
150
+ cachePerformanceImprovements: process.env.NODE_ENV === 'test',
151
+ environmentDeduplication: false,
152
+ inlineStringReplacementPerf: false,
153
+ // Default to true as it's a monitoring change. Can be turned off if necessary.
154
+ verboseRequestInvalidationStats: true,
155
+ resolveBundlerConfigFromCwd: false,
156
+ applyScopeHoistingImprovement: false,
157
+ inlineConstOptimisationFix: false,
158
+ hmrImprovements: false,
159
+ atlaspackV3CleanShutdown: false,
160
+ unusedComputedPropertyFix: process.env.NODE_ENV === 'test',
161
+ emptyFileStarRexportFix: process.env.NODE_ENV === 'test',
162
+ cliProgressReportingImprovements: false,
163
+ condbDevFallbackDev: false,
164
+ condbDevFallbackProd: false,
165
+ incrementalBundlingVersioning: process.env.NODE_ENV === 'test',
166
+ };
167
+
168
+ let featureFlagValues: FeatureFlags = {...DEFAULT_FEATURE_FLAGS};
169
+
170
+ export function setFeatureFlags(flags: FeatureFlags) {
171
+ featureFlagValues = flags;
172
+ }
173
+
174
+ export function getFeatureFlag(flagName: keyof FeatureFlags): boolean {
175
+ const value = featureFlagValues[flagName];
176
+ return value === true || value === 'NEW';
177
+ }
178
+
179
+ export function getFeatureFlagValue(
180
+ flagName: keyof FeatureFlags,
181
+ ): boolean | string | number {
182
+ return featureFlagValues[flagName];
183
+ }
184
+
185
+ export type DiffResult<CustomDiagnostic> = {
186
+ isDifferent: boolean;
187
+ custom: CustomDiagnostic;
188
+ };
189
+
190
+ export type Diagnostic<CustomDiagnostic> = {
191
+ isDifferent: boolean;
192
+ oldExecutionTimeMs: number;
193
+ newExecutionTimeMs: number;
194
+ custom: CustomDiagnostic;
195
+ };
196
+
197
+ /**
198
+ * Run a function with a consistency check.
199
+ */
200
+ export function runWithConsistencyCheck<Result, CustomDiagnostic>(
201
+ flag: keyof FeatureFlags,
202
+ oldFn: () => Result,
203
+ newFn: () => Result,
204
+ diffFn: (
205
+ oldResult: Result,
206
+ newResult: Result,
207
+ ) => DiffResult<CustomDiagnostic>,
208
+ report: (
209
+ diagnostic: Diagnostic<CustomDiagnostic>,
210
+ oldResult: Result,
211
+ newResult: Result,
212
+ ) => void,
213
+ ): Result {
214
+ const value = featureFlagValues[flag];
215
+ // @ts-expect-error - TypeScript doesn't understand the union type comparison
216
+ if (!value || value === false || value === 'OLD') {
217
+ return oldFn();
218
+ }
219
+ if (value === true || value === 'NEW') {
220
+ return newFn();
221
+ }
222
+
223
+ const oldStartTime = performance.now();
224
+ const oldResult = oldFn();
225
+ const oldExecutionTimeMs = performance.now() - oldStartTime;
226
+
227
+ const newStartTime = performance.now();
228
+ const newResult = newFn();
229
+ const newExecutionTimeMs = performance.now() - newStartTime;
230
+
231
+ const diff = diffFn(oldResult, newResult);
232
+
233
+ report(
234
+ {
235
+ isDifferent: diff.isDifferent,
236
+ oldExecutionTimeMs,
237
+ newExecutionTimeMs,
238
+ custom: diff.custom,
239
+ },
240
+ oldResult,
241
+ newResult,
242
+ );
243
+
244
+ if (value === 'NEW_AND_CHECK') {
245
+ return newResult;
246
+ }
247
+
248
+ return oldResult;
249
+ }
@@ -1,4 +1,3 @@
1
- // @flow strict
2
1
  import assert from 'assert';
3
2
  import {
4
3
  getFeatureFlag,
package/tsconfig.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "extends": "../../../tsconfig.json",
3
+ "include": ["src"]
4
+ }
package/lib/types.js DELETED
@@ -1 +0,0 @@
1
- "use strict";
package/src/index.js DELETED
@@ -1,126 +0,0 @@
1
- // @flow strict
2
-
3
- import type {FeatureFlags as _FeatureFlags} from './types';
4
- // We need to do these gymnastics as we don't want flow-to-ts to touch DEFAULT_FEATURE_FLAGS,
5
- // but we want to export FeatureFlags for Flow
6
- export type FeatureFlags = _FeatureFlags;
7
-
8
- export const CONSISTENCY_CHECK_VALUES: $ReadOnlyArray<string> = Object.freeze([
9
- 'NEW',
10
- 'OLD',
11
- 'NEW_AND_CHECK',
12
- 'OLD_AND_CHECK',
13
- ]);
14
-
15
- export const DEFAULT_FEATURE_FLAGS: FeatureFlags = {
16
- exampleConsistencyCheckFeature: 'OLD',
17
- exampleFeature: false,
18
- atlaspackV3: false,
19
- useWatchmanWatcher: false,
20
- importRetry: false,
21
- fixQuadraticCacheInvalidation: 'OLD',
22
- conditionalBundlingApi: false,
23
- vcsMode: 'OLD',
24
- loadableSideEffects: false,
25
- reduceResolverStringCreation: false,
26
- inlineBundlesSourceMapFixes: false,
27
- patchProjectPaths: false,
28
- cachePerformanceImprovements: process.env.NODE_ENV === 'test',
29
- environmentDeduplication: false,
30
- inlineStringReplacementPerf: false,
31
- // Default to true as it's a monitoring change. Can be turned off if necessary.
32
- verboseRequestInvalidationStats: true,
33
- resolveBundlerConfigFromCwd: false,
34
- applyScopeHoistingImprovement: false,
35
- inlineConstOptimisationFix: false,
36
- hmrImprovements: false,
37
- atlaspackV3CleanShutdown: false,
38
- unusedComputedPropertyFix: process.env.NODE_ENV === 'test',
39
- emptyFileStarRexportFix: process.env.NODE_ENV === 'test',
40
- cliProgressReportingImprovements: false,
41
- condbDevFallbackDev: false,
42
- condbDevFallbackProd: false,
43
- incrementalBundlingVersioning: process.env.NODE_ENV === 'test',
44
- };
45
-
46
- let featureFlagValues: FeatureFlags = {...DEFAULT_FEATURE_FLAGS};
47
-
48
- export function setFeatureFlags(flags: FeatureFlags) {
49
- featureFlagValues = flags;
50
- }
51
-
52
- export function getFeatureFlag(flagName: $Keys<FeatureFlags>): boolean {
53
- const value = featureFlagValues[flagName];
54
- return value === true || value === 'NEW';
55
- }
56
-
57
- export function getFeatureFlagValue(
58
- flagName: $Keys<FeatureFlags>,
59
- ): boolean | string | number {
60
- return featureFlagValues[flagName];
61
- }
62
-
63
- export type DiffResult<CustomDiagnostic> = {|
64
- isDifferent: boolean,
65
- custom: CustomDiagnostic,
66
- |};
67
-
68
- export type Diagnostic<CustomDiagnostic> = {|
69
- isDifferent: boolean,
70
- oldExecutionTimeMs: number,
71
- newExecutionTimeMs: number,
72
- custom: CustomDiagnostic,
73
- |};
74
-
75
- /**
76
- * Run a function with a consistency check.
77
- */
78
- export function runWithConsistencyCheck<Result, CustomDiagnostic>(
79
- flag: string,
80
- oldFn: () => Result,
81
- newFn: () => Result,
82
- diffFn: (
83
- oldResult: Result,
84
- newResult: Result,
85
- ) => DiffResult<CustomDiagnostic>,
86
- report: (
87
- diagnostic: Diagnostic<CustomDiagnostic>,
88
- oldResult: Result,
89
- newResult: Result,
90
- ) => void,
91
- ): Result {
92
- const value = featureFlagValues[flag];
93
- if (!value || value === false || value === 'OLD') {
94
- return oldFn();
95
- }
96
- if (value === true || value === 'NEW') {
97
- return newFn();
98
- }
99
-
100
- const oldStartTime = performance.now();
101
- const oldResult = oldFn();
102
- const oldExecutionTimeMs = performance.now() - oldStartTime;
103
-
104
- const newStartTime = performance.now();
105
- const newResult = newFn();
106
- const newExecutionTimeMs = performance.now() - newStartTime;
107
-
108
- const diff = diffFn(oldResult, newResult);
109
-
110
- report(
111
- {
112
- isDifferent: diff.isDifferent,
113
- oldExecutionTimeMs,
114
- newExecutionTimeMs,
115
- custom: diff.custom,
116
- },
117
- oldResult,
118
- newResult,
119
- );
120
-
121
- if (value === 'NEW_AND_CHECK') {
122
- return newResult;
123
- }
124
-
125
- return oldResult;
126
- }
package/src/types.js DELETED
@@ -1,133 +0,0 @@
1
- // @flow strict
2
-
3
- export type FeatureFlags = {|
4
- // This feature flag mostly exists to test the feature flag system, and doesn't have any build/runtime effect
5
- +exampleFeature: boolean,
6
- +exampleConsistencyCheckFeature: ConsistencyCheckFeatureFlagValue,
7
- /**
8
- * Rust backed requests
9
- */
10
- +atlaspackV3: boolean,
11
- /**
12
- * Use node.js implementation of @parcel/watcher watchman backend
13
- */
14
- +useWatchmanWatcher: boolean,
15
- /**
16
- * Configure runtime to enable retriable dynamic imports
17
- */
18
- importRetry: boolean,
19
- /**
20
- * Fixes quadratic cache invalidation issue
21
- */
22
- fixQuadraticCacheInvalidation: ConsistencyCheckFeatureFlagValue,
23
- /**
24
- * Enables an experimental "conditional bundling" API - this allows the use of `importCond` syntax
25
- * in order to have (consumer) feature flag driven bundling. This feature is very experimental,
26
- * and requires server-side support.
27
- */
28
- conditionalBundlingApi: boolean,
29
- /**
30
- * Enable VCS mode. Expected values are:
31
- * - OLD - default value, return watchman result
32
- * - NEW_AND_CHECK - Return VCS result but still call watchman
33
- * - NEW: Return VCS result, but don't call watchman
34
- */
35
- vcsMode: ConsistencyCheckFeatureFlagValue,
36
- /**
37
- * Refactor cache to:
38
- * - Split writes into multiple entries
39
- * - Remove "large file blob" writes
40
- * - Reduce size of the caches by deduplicating data
41
- */
42
- cachePerformanceImprovements: boolean,
43
- /**
44
- * Deduplicates environments across cache / memory entities
45
- */
46
- environmentDeduplication: boolean,
47
- /**
48
- * Enable scanning for the presence of loadable to determine side effects
49
- */
50
- loadableSideEffects: boolean,
51
- /**
52
- * Enable performance optimization for the resolver specifier to_string
53
- * conversions
54
- */
55
- reduceResolverStringCreation: boolean,
56
- /**
57
- * Add verbose metrics for request tracker invalidation
58
- */
59
- verboseRequestInvalidationStats: boolean,
60
- /**
61
- * Fixes source maps for inline bundles
62
- */
63
- inlineBundlesSourceMapFixes: boolean,
64
- /** Enable patch project paths. This will patch the project paths to be relative to the project root.
65
- * This feature is experimental and should not be used in production. It will used to test downloadble cache artefacts.
66
- */
67
- patchProjectPaths: boolean,
68
- /**
69
- * Enables optimized inline string replacement perf for the packager.
70
- * Used heavily for inline bundles.
71
- */
72
- inlineStringReplacementPerf: boolean,
73
- /**
74
- * Enable resolution of bundler config starting from the CWD
75
- */
76
- resolveBundlerConfigFromCwd: boolean,
77
- /**
78
- * Enable a setting that allows for more assets to be scope hoisted, if
79
- * they're safe to do so.
80
- */
81
- applyScopeHoistingImprovement: boolean,
82
- /**
83
- * Enable a change where a constant module only have the namespacing object added in bundles where it is required
84
- */
85
- inlineConstOptimisationFix: boolean,
86
- /**
87
- * Improves/fixes HMR behaviour by:
88
- * - Fixing HMR behaviour with lazy bundle edges
89
- * - Moving the functionality of the react-refresh runtime into the react-refresh-wrap transformer
90
- */
91
- hmrImprovements: boolean,
92
- /**
93
- * Adds an end() method to AtlaspckV3 to cleanly shutdown the NAPI worker pool
94
- */
95
- atlaspackV3CleanShutdown: boolean,
96
- /**
97
- * Fixes a bug where imported objects that are accessed with non-static
98
- * properties (e.g. `CONSTANTS['api_' + endpoint`]) would not be recognised as
99
- * being used, and thus not included in the bundle.
100
- */
101
- unusedComputedPropertyFix: boolean,
102
-
103
- /**
104
- * Fixes an issue where star re-exports of empty files (usually occurring in compiled typescript libraries)
105
- * could cause exports to undefined at runtime.
106
- */
107
- emptyFileStarRexportFix: boolean,
108
-
109
- /**
110
- * Enables the new packaging progress CLI experience
111
- */
112
- cliProgressReportingImprovements: boolean,
113
- /**
114
- * Enable a change to the conditional bundling loader to use a fallback bundle loading if the expected scripts aren't found
115
- *
116
- * Split into two flags, to allow usage in the dev or prod packagers separately
117
- */
118
- condbDevFallbackDev: boolean,
119
- condbDevFallbackProd: boolean,
120
- /**
121
- * Enable the new incremental bundling versioning logic which determines whether
122
- * a full bundling pass is required based on the AssetGraph's bundlingVersion.
123
- */
124
- incrementalBundlingVersioning: boolean,
125
- |};
126
-
127
- declare export var CONSISTENCY_CHECK_VALUES: $ReadOnlyArray<string>;
128
- export type ConsistencyCheckFeatureFlagValue = $ElementType<
129
- typeof CONSISTENCY_CHECK_VALUES,
130
- number,
131
- >;
132
-
133
- declare export var DEFAULT_FEATURE_FLAGS: FeatureFlags;