@atlaspack/core 2.18.6 → 2.18.7-dev-eae8c193d.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2024 Atlassian US., Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/lib/Atlaspack.js

@@ -226,6 +226,11 @@ class Atlaspack {
       });
     }
     this.rustAtlaspack = rustAtlaspack;
+    if (featureFlags.atlaspackV3CleanShutdown) {
+      this.#disposable.add(() => {
+        rustAtlaspack.end();
+      });
+    }
     let {
       config
     } = await (0, _AtlaspackConfigRequest.loadAtlaspackConfig)(resolvedOptions);
@@ -395,6 +400,11 @@ class Atlaspack {
       }
       if (options.shouldTrace) {
         _profiler().tracer.enable();
+        // We need to ensure the tracer is disabled when Atlaspack is disposed as it is a module level object.
+        // While rare (except for tests), if another instance is created later it should not have tracing enabled.
+        this.#disposable.add(() => {
+          _profiler().tracer.disable();
+        });
       }
       await this.#reporterRunner.report({
         type: 'buildStart'

package/lib/atlaspack-v3/AtlaspackV3.js

@@ -21,21 +21,28 @@ function _diagnostic() {
 }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 class AtlaspackV3 {
-  constructor(atlaspack_napi) {
+  constructor(atlaspack_napi, napiWorkerPool, isDefaultNapiWorkerPool) {
     this._atlaspack_napi = atlaspack_napi;
+    this._napiWorkerPool = napiWorkerPool;
+    this._isDefaultNapiWorkerPool = isDefaultNapiWorkerPool;
   }
   static async create({
     fs,
     packageManager,
     threads,
     lmdb,
-    napiWorkerPool = new _NapiWorkerPool.NapiWorkerPool(),
+    napiWorkerPool,
     ...options
   }) {
     options.logLevel = options.logLevel || 'error';
     options.defaultTargetOptions = options.defaultTargetOptions || {};
     // $FlowFixMe "engines" are readonly
     options.defaultTargetOptions.engines = options.defaultTargetOptions.engines || {};
+    let isDefaultNapiWorkerPool = false;
+    if (!napiWorkerPool) {
+      napiWorkerPool = new _NapiWorkerPool.NapiWorkerPool();
+      isDefaultNapiWorkerPool = true;
+    }
     const [internal, error] = await (0, _rust().atlaspackNapiCreate)({
       fs,
       packageManager,
@@ -48,7 +55,13 @@ class AtlaspackV3 {
         diagnostic: error
       });
     }
-    return new AtlaspackV3(internal);
+    return new AtlaspackV3(internal, napiWorkerPool, isDefaultNapiWorkerPool);
+  }
+  end() {
+    // If the worker pool was provided to us, don't shut it down, it's up to the provider.
+    if (this._isDefaultNapiWorkerPool) {
+      this._napiWorkerPool.shutdown();
+    }
   }
   async buildAssetGraph() {
     let [graph, error] = await (0, _rust().atlaspackNapiBuildAssetGraph)(this._atlaspack_napi);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/core",
-  "version": "2.18.6",
+  "version": "2.18.7-dev-eae8c193d.0",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -21,22 +21,22 @@
     "check-ts": "tsc --noEmit index.d.ts"
   },
   "dependencies": {
+    "@atlaspack/build-cache": "2.13.4-dev-eae8c193d.0",
+    "@atlaspack/cache": "3.2.11-dev-eae8c193d.0",
+    "@atlaspack/diagnostic": "2.14.2-dev-eae8c193d.0",
+    "@atlaspack/events": "2.14.2-dev-eae8c193d.0",
+    "@atlaspack/feature-flags": "2.18.4-dev-eae8c193d.0",
+    "@atlaspack/fs": "2.15.11-dev-eae8c193d.0",
+    "@atlaspack/graph": "3.5.6-dev-eae8c193d.0",
+    "@atlaspack/logger": "2.14.12-dev-eae8c193d.0",
+    "@atlaspack/package-manager": "2.14.16-dev-eae8c193d.0",
+    "@atlaspack/plugin": "2.14.16-dev-eae8c193d.0",
+    "@atlaspack/profiler": "2.14.14-dev-eae8c193d.0",
+    "@atlaspack/rust": "3.3.6-dev-eae8c193d.0",
+    "@atlaspack/types": "2.15.6-dev-eae8c193d.0",
+    "@atlaspack/utils": "2.15.4-dev-eae8c193d.0",
+    "@atlaspack/workers": "2.14.16-dev-eae8c193d.0",
     "@mischnic/json-sourcemap": "^0.1.0",
-    "@atlaspack/build-cache": "2.13.3",
-    "@atlaspack/cache": "3.2.10",
-    "@atlaspack/diagnostic": "2.14.1",
-    "@atlaspack/events": "2.14.1",
-    "@atlaspack/feature-flags": "2.18.3",
-    "@atlaspack/fs": "2.15.10",
-    "@atlaspack/graph": "3.5.5",
-    "@atlaspack/logger": "2.14.11",
-    "@atlaspack/package-manager": "2.14.15",
-    "@atlaspack/plugin": "2.14.15",
-    "@atlaspack/profiler": "2.14.13",
-    "@atlaspack/rust": "3.3.5",
-    "@atlaspack/types": "2.15.5",
-    "@atlaspack/utils": "2.15.3",
-    "@atlaspack/workers": "2.14.15",
     "@parcel/source-map": "^2.1.1",
     "base-x": "^3.0.8",
     "browserslist": "^4.6.6",
@@ -49,15 +49,16 @@
     "semver": "^7.5.2"
   },
   "devDependencies": {
-    "@atlaspack/babel-register": "2.14.1",
+    "@atlaspack/babel-register": "2.14.2-dev-eae8c193d.0",
     "@types/node": ">= 18",
-    "rfdc": "1",
-    "jest-diff": "*",
     "graphviz": "^0.0.9",
+    "jest-diff": "*",
+    "rfdc": "1",
     "tempy": "^0.2.1"
   },
   "browser": {
     "./src/serializerCore.js": "./src/serializerCore.browser.js"
   },
-  "type": "commonjs"
+  "type": "commonjs",
+  "gitHead": "eae8c193d1b12309f6377859a2da6a352b329f3d"
 }

package/src/Atlaspack.js

@@ -190,6 +190,12 @@ export default class Atlaspack {
     }
     this.rustAtlaspack = rustAtlaspack;
 
+    if (featureFlags.atlaspackV3CleanShutdown) {
+      this.#disposable.add(() => {
+        rustAtlaspack.end();
+      });
+    }
+
     let {config} = await loadAtlaspackConfig(resolvedOptions);
     this.#config = new AtlaspackConfig(config, resolvedOptions);
 
@@ -386,6 +392,11 @@ export default class Atlaspack {
       }
       if (options.shouldTrace) {
         tracer.enable();
+        // We need to ensure the tracer is disabled when Atlaspack is disposed as it is a module level object.
+        // While rare (except for tests), if another instance is created later it should not have tracing enabled.
+        this.#disposable.add(() => {
+          tracer.disable();
+        });
       }
       await this.#reporterRunner.report({
         type: 'buildStart',

package/src/atlaspack-v3/AtlaspackV3.js

@@ -28,9 +28,17 @@ export type AtlaspackV3Options = {|
 
 export class AtlaspackV3 {
   _atlaspack_napi: AtlaspackNapi;
+  _napiWorkerPool: INapiWorkerPool;
+  _isDefaultNapiWorkerPool: boolean;
 
-  constructor(atlaspack_napi: AtlaspackNapi) {
+  constructor(
+    atlaspack_napi: AtlaspackNapi,
+    napiWorkerPool: INapiWorkerPool,
+    isDefaultNapiWorkerPool: boolean,
+  ) {
     this._atlaspack_napi = atlaspack_napi;
+    this._napiWorkerPool = napiWorkerPool;
+    this._isDefaultNapiWorkerPool = isDefaultNapiWorkerPool;
   }
 
   static async create({
@@ -38,7 +46,7 @@ export class AtlaspackV3 {
     packageManager,
     threads,
     lmdb,
-    napiWorkerPool = new NapiWorkerPool(),
+    napiWorkerPool,
     ...options
   }: AtlaspackV3Options): Promise<AtlaspackV3> {
     options.logLevel = options.logLevel || 'error';
@@ -47,6 +55,12 @@ export class AtlaspackV3 {
     options.defaultTargetOptions.engines =
       options.defaultTargetOptions.engines || {};
 
+    let isDefaultNapiWorkerPool = false;
+    if (!napiWorkerPool) {
+      napiWorkerPool = new NapiWorkerPool();
+      isDefaultNapiWorkerPool = true;
+    }
+
     const [internal, error] = await atlaspackNapiCreate(
       {
         fs,
@@ -64,7 +78,14 @@ export class AtlaspackV3 {
       });
     }
 
-    return new AtlaspackV3(internal);
+    return new AtlaspackV3(internal, napiWorkerPool, isDefaultNapiWorkerPool);
+  }
+
+  end(): void {
+    // If the worker pool was provided to us, don't shut it down, it's up to the provider.
+    if (this._isDefaultNapiWorkerPool) {
+      this._napiWorkerPool.shutdown();
+    }
   }
 
   async buildAssetGraph(): Promise<any> {

package/test/RequestTracker.test.js

@@ -24,9 +24,13 @@ const options = {
   ...DEFAULT_OPTIONS,
   cache: new LMDBLiteCache(DEFAULT_OPTIONS.cacheDir),
 };
-const farm = new WorkerFarm({workerPath: require.resolve('../src/worker')});
 
 describe('RequestTracker', () => {
+  let farm;
+  before(() => {
+    farm = new WorkerFarm({workerPath: require.resolve('../src/worker')});
+  });
+
   beforeEach(async () => {
     await options.cache.ensure();
 
@@ -35,6 +39,10 @@ describe('RequestTracker', () => {
     }
   });
 
+  after(() => {
+    farm.end();
+  });
+
   it('should not run requests that have not been invalidated', async () => {
     let tracker = new RequestTracker({farm, options});
     await tracker.runRequest({

package/test/requests/ConfigRequest.test.js

@@ -23,15 +23,23 @@ const mockCast = (f: any): any => f;
 
 describe('ConfigRequest tests', () => {
   const projectRoot = 'project_root';
-  const farm = new WorkerFarm({
-    workerPath: require.resolve('../../src/worker'),
-    maxConcurrentWorkers: 1,
+  let farm;
+  let fs;
+  before(() => {
+    farm = new WorkerFarm({
+      workerPath: require.resolve('../../src/worker'),
+      maxConcurrentWorkers: 1,
+    });
   });
-  let fs = new MemoryFS(farm);
+
   beforeEach(() => {
     fs = new MemoryFS(farm);
   });
 
+  after(() => {
+    farm.end();
+  });
+
   const getMockRunApi = (
     options: mixed = {projectRoot, inputFS: fs},
   ): RunAPI<ConfigRequestResult> => {