@atlaspack/core 2.15.1 → 2.16.1-canary.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaspack/core
 
+## 2.16.0
+
+### Minor Changes
+
+- [#520](https://github.com/atlassian-labs/atlaspack/pull/520) [`90150df`](https://github.com/atlassian-labs/atlaspack/commit/90150dfb68236e1d1c11813108ecabd92cff9366) Thanks [@pancaspe87](https://github.com/pancaspe87)! - Modify "large blobs" to be written to the LMDB cache
+
+### Patch Changes
+
+- Updated dependencies [[`f27d39e`](https://github.com/atlassian-labs/atlaspack/commit/f27d39e767b06def059944b3bc5fd50797eaea96)]:
+  - @atlaspack/rust@3.1.1
+  - @atlaspack/cache@3.0.1
+  - @atlaspack/fs@2.14.3
+  - @atlaspack/logger@2.14.3
+  - @atlaspack/utils@2.14.3
+  - @atlaspack/package-manager@2.14.3
+  - @atlaspack/workers@2.14.3
+  - @atlaspack/types@2.14.3
+  - @atlaspack/plugin@2.14.3
+
 ## 2.15.1
 
 ### Patch Changes

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/RequestTracker.js

@@ -759,8 +759,10 @@ class RequestTracker {
       return result;
     } else if (node.resultCacheKey != null && ifMatch == null) {
       let key = node.resultCacheKey;
-      (0, _assert().default)(this.options.cache.hasLargeBlob(key));
-      let cachedResult = (0, _buildCache().deserialize)(await this.options.cache.getLargeBlob(key));
+      if (!(0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements')) {
+        (0, _assert().default)(this.options.cache.hasLargeBlob(key));
+      }
+      let cachedResult = (0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements') ? (0, _nullthrows().default)(await this.options.cache.get(key)) : (0, _buildCache().deserialize)(await this.options.cache.getLargeBlob(key));
       node.result = cachedResult;
       return cachedResult;
     }
@@ -937,16 +939,21 @@ class RequestTracker {
       size: this.graph.nodes.length
     });
     let serialisedGraph = this.graph.serialize();
-
-    // Delete an existing request graph cache, to prevent invalid states
-    await this.options.cache.deleteLargeBlob(requestGraphKey);
+    if (!(0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements')) {
+      // Delete an existing request graph cache, to prevent invalid states
+      await this.options.cache.deleteLargeBlob(requestGraphKey);
+    }
     const serialiseAndSet = async (key, contents) => {
       if (signal !== null && signal !== void 0 && signal.aborted) {
         throw new Error('Serialization was aborted');
       }
-      await this.options.cache.setLargeBlob(key, (0, _buildCache().serialize)(contents), signal ? {
-        signal: signal
-      } : undefined);
+      if ((0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements')) {
+        await this.options.cache.set(key, (0, _buildCache().serialize)(contents));
+      } else {
+        await this.options.cache.setLargeBlob(key, (0, _buildCache().serialize)(contents), signal ? {
+          signal: signal
+        } : undefined);
+      }
       total += 1;
       (0, _ReporterRunner.report)({
         type: 'cache',
@@ -1050,6 +1057,13 @@ function getRequestGraphNodeKey(index, cacheKey) {
 }
 async function readAndDeserializeRequestGraph(cache, requestGraphKey, cacheKey) {
   let bufferLength = 0;
+  if ((0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements')) {
+    let data = (0, _nullthrows().default)(await cache.get(requestGraphKey));
+    return {
+      requestGraph: RequestGraph.deserialize(data),
+      bufferLength
+    };
+  }
   const getAndDeserialize = async key => {
     let buffer = await cache.getLargeBlob(key);
     bufferLength += Buffer.byteLength(buffer);
@@ -1087,7 +1101,7 @@ async function loadRequestGraph(options) {
       snapshotKey
     }
   });
-  if (await options.cache.hasLargeBlob(requestGraphKey)) {
+  if (!(0, _featureFlags().getFeatureFlag)('cachePerformanceImprovements') && (await options.cache.hasLargeBlob(requestGraphKey))) {
     try {
       let {
         requestGraph

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/core",
-  "version": "2.15.1",
+  "version": "2.16.1-canary.0+41f62c447",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -20,22 +20,22 @@
     "check-ts": "tsc --noEmit index.d.ts"
   },
   "dependencies": {
+    "@atlaspack/build-cache": "2.13.3-canary.63+41f62c447",
+    "@atlaspack/cache": "3.0.2-canary.0+41f62c447",
+    "@atlaspack/diagnostic": "2.14.1-canary.63+41f62c447",
+    "@atlaspack/events": "2.14.1-canary.63+41f62c447",
+    "@atlaspack/feature-flags": "2.14.1-canary.63+41f62c447",
+    "@atlaspack/fs": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/graph": "3.4.1-canary.63+41f62c447",
+    "@atlaspack/logger": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/package-manager": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/plugin": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/profiler": "2.14.1-canary.63+41f62c447",
+    "@atlaspack/rust": "3.1.2-canary.0+41f62c447",
+    "@atlaspack/types": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/utils": "2.14.4-canary.0+41f62c447",
+    "@atlaspack/workers": "2.14.4-canary.0+41f62c447",
     "@mischnic/json-sourcemap": "^0.1.0",
-    "@atlaspack/build-cache": "2.13.3",
-    "@atlaspack/cache": "3.0.0",
-    "@atlaspack/diagnostic": "2.14.1",
-    "@atlaspack/events": "2.14.1",
-    "@atlaspack/feature-flags": "2.14.2",
-    "@atlaspack/fs": "2.14.2",
-    "@atlaspack/graph": "3.4.2",
-    "@atlaspack/logger": "2.14.2",
-    "@atlaspack/package-manager": "2.14.2",
-    "@atlaspack/plugin": "2.14.2",
-    "@atlaspack/profiler": "2.14.2",
-    "@atlaspack/rust": "3.1.0",
-    "@atlaspack/types": "2.14.2",
-    "@atlaspack/utils": "2.14.2",
-    "@atlaspack/workers": "2.14.2",
     "@parcel/source-map": "^2.1.1",
     "base-x": "^3.0.8",
     "browserslist": "^4.6.6",
@@ -50,9 +50,9 @@
   "devDependencies": {
     "@atlaspack/babel-register": "2.14.1",
     "@types/node": ">= 18",
-    "rfdc": "1",
-    "jest-diff": "*",
     "graphviz": "^0.0.9",
+    "jest-diff": "*",
+    "rfdc": "1",
     "tempy": "^0.2.1"
   },
   "exports": {
@@ -66,5 +66,6 @@
   "browser": {
     "./src/serializerCore.js": "./src/serializerCore.browser.js"
   },
-  "type": "commonjs"
+  "type": "commonjs",
+  "gitHead": "41f62c4479595808d8426c1e674d69fbe1bf0d5e"
 }

package/src/RequestTracker.js

@@ -1228,10 +1228,13 @@ export default class RequestTracker {
       return result;
     } else if (node.resultCacheKey != null && ifMatch == null) {
       let key = node.resultCacheKey;
-      invariant(this.options.cache.hasLargeBlob(key));
-      let cachedResult: T = deserialize(
-        await this.options.cache.getLargeBlob(key),
-      );
+      if (!getFeatureFlag('cachePerformanceImprovements')) {
+        invariant(this.options.cache.hasLargeBlob(key));
+      }
+
+      let cachedResult: T = getFeatureFlag('cachePerformanceImprovements')
+        ? nullthrows(await this.options.cache.get<T>(key))
+        : deserialize(await this.options.cache.getLargeBlob(key));
       node.result = cachedResult;
       return cachedResult;
     }
@@ -1472,8 +1475,10 @@ export default class RequestTracker {
 
     let serialisedGraph = this.graph.serialize();
 
-    // Delete an existing request graph cache, to prevent invalid states
-    await this.options.cache.deleteLargeBlob(requestGraphKey);
+    if (!getFeatureFlag('cachePerformanceImprovements')) {
+      // Delete an existing request graph cache, to prevent invalid states
+      await this.options.cache.deleteLargeBlob(requestGraphKey);
+    }
 
     const serialiseAndSet = async (
       key: string,
@@ -1484,15 +1489,19 @@ export default class RequestTracker {
         throw new Error('Serialization was aborted');
       }
 
-      await this.options.cache.setLargeBlob(
-        key,
-        serialize(contents),
-        signal
-          ? {
-              signal: signal,
-            }
-          : undefined,
-      );
+      if (getFeatureFlag('cachePerformanceImprovements')) {
+        await this.options.cache.set(key, serialize(contents));
+      } else {
+        await this.options.cache.setLargeBlob(
+          key,
+          serialize(contents),
+          signal
+            ? {
+                signal: signal,
+              }
+            : undefined,
+        );
+      }
 
       total += 1;
 
@@ -1631,6 +1640,15 @@ export async function readAndDeserializeRequestGraph(
   cacheKey: string,
 ): Async<{|requestGraph: RequestGraph, bufferLength: number|}> {
   let bufferLength = 0;
+
+  if (getFeatureFlag('cachePerformanceImprovements')) {
+    let data = nullthrows(await cache.get(requestGraphKey));
+    return {
+      requestGraph: RequestGraph.deserialize(data),
+      bufferLength,
+    };
+  }
+
   const getAndDeserialize = async (key: string) => {
     let buffer = await cache.getLargeBlob(key);
     bufferLength += Buffer.byteLength(buffer);
@@ -1680,7 +1698,11 @@ async function loadRequestGraph(options): Async<RequestGraph> {
       snapshotKey,
     },
   });
-  if (await options.cache.hasLargeBlob(requestGraphKey)) {
+
+  if (
+    !getFeatureFlag('cachePerformanceImprovements') &&
+    (await options.cache.hasLargeBlob(requestGraphKey))
+  ) {
     try {
       let {requestGraph} = await readAndDeserializeRequestGraph(
         options.cache,