fix(gzip): Use Compression Streams API in place of pako (#674)

This is expected to be faster and also reduces the bundle size.
google · Dec 2, 2024 · c581f20 · c581f20 · shangmu · Dec 6, 2024
1 parent 98595ee
commit c581f20
Show file tree

Hide file tree

Showing 25 changed files with 40 additions and 191 deletions.
diff --git a/build_tools/update-conditions.ts b/build_tools/update-conditions.ts
@@ -124,8 +124,8 @@ packageJson.imports = imports;
 
 packageJson.exports = {
   ".": "./src/main_module.ts",
-  "./*.js": "./src/*.ts",
-  "./*": "./src/*",
+  "./unstable/*.js": "./src/*.ts",
+  "./unstable/*": "./src/*",
 };
 
 const tempPackageJsonPath = packageJsonPath + ".tmp";

diff --git a/examples/parcel/parcel-project-built/package-lock.json b/examples/parcel/parcel-project-built/package-lock.json
diff --git a/examples/parcel/parcel-project-source/package-lock.json b/examples/parcel/parcel-project-source/package-lock.json
diff --git a/examples/vite/vite-project-built/package-lock.json b/examples/vite/vite-project-built/package-lock.json
diff --git a/examples/vite/vite-project-source/package-lock.json b/examples/vite/vite-project-source/package-lock.json
diff --git a/examples/webpack/webpack-project-built/package-lock.json b/examples/webpack/webpack-project-built/package-lock.json
diff --git a/examples/webpack/webpack-project-source/package-lock.json b/examples/webpack/webpack-project-source/package-lock.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -44,7 +44,6 @@
     "@types/gl-matrix": "^2.4.5",
     "@types/lodash-es": "^4.17.12",
     "@types/node": "^20.14.12",
-    "@types/pako": "^2.0.3",
     "@types/yargs": "^17.0.32",
     "@typescript-eslint/eslint-plugin": "^7.17.0",
     "@typescript-eslint/parser": "^7.17.0",
@@ -83,8 +82,7 @@
     "ikonate": "github:mikolajdobrucki/ikonate#a86b4107c6ec717e7877f880a930d1ccf0b59d89",
     "lodash-es": "^4.17.21",
     "nifti-reader-js": "^0.6.8",
-    "numcodecs": "^0.3.2",
-    "pako": "^2.1.0"
+    "numcodecs": "^0.3.2"
   },
   "overrides": {
     "@puppeteer/browsers": ">=2"
@@ -265,12 +263,6 @@
       "neuroglancer/datasource/nifti:disabled": "./src/datasource/nifti/backend.ts",
       "default": "./src/datasource/nifti/backend.ts"
     },
-    "#datasource/nifti/async_computation": {
-      "neuroglancer/datasource/nifti:enabled": "./src/datasource/nifti/async_computation.ts",
-      "neuroglancer/datasource:none_by_default": "./src/util/false.ts",
-      "neuroglancer/datasource/nifti:disabled": "./src/datasource/nifti/async_computation.ts",
-      "default": "./src/datasource/nifti/async_computation.ts"
-    },
     "#datasource/nifti/register_default": {
       "neuroglancer/datasource/nifti:enabled": "./src/datasource/nifti/register_default.ts",
       "neuroglancer/datasource:none_by_default": "./src/util/false.ts",

diff --git a/src/async_computation/decode_gzip.ts b/src/async_computation/decode_gzip.ts
diff --git a/src/async_computation/decode_gzip_request.ts b/src/async_computation/decode_gzip_request.ts
diff --git a/src/datasource/boss/async_computation.ts b/src/datasource/boss/async_computation.ts
@@ -1,2 +1 @@
 import "#src/async_computation/decode_jpeg.js";
-import "#src/async_computation/decode_gzip.js";
diff --git a/src/datasource/enabled_async_computation_modules.ts b/src/datasource/enabled_async_computation_modules.ts
@@ -5,7 +5,6 @@ import "#datasource/deepzoom/async_computation";
 import "#datasource/dvid/async_computation";
 import "#datasource/graphene/async_computation";
 import "#datasource/n5/async_computation";
-import "#datasource/nifti/async_computation";
 import "#datasource/obj/async_computation";
 import "#datasource/precomputed/async_computation";
 import "#datasource/render/async_computation";

diff --git a/src/datasource/graphene/async_computation.ts b/src/datasource/graphene/async_computation.ts
@@ -1,2 +1 @@
 import "#src/async_computation/decode_jpeg.js";
-import "#src/async_computation/decode_gzip.js";
diff --git a/src/datasource/n5/async_computation.ts b/src/datasource/n5/async_computation.ts
@@ -1,3 +1,2 @@
-import "#src/async_computation/decode_gzip.js";
 import "#src/async_computation/decode_blosc.js";
 import "#src/async_computation/decode_zstd.js";
diff --git a/src/datasource/n5/backend.ts b/src/datasource/n5/backend.ts
@@ -15,7 +15,6 @@
  */
 
 import { decodeBlosc } from "#src/async_computation/decode_blosc_request.js";
-import { decodeGzip } from "#src/async_computation/decode_gzip_request.js";
 import { decodeZstd } from "#src/async_computation/decode_zstd_request.js";
 import { requestAsyncComputation } from "#src/async_computation/request.js";
 import { WithParameters } from "#src/chunk_manager/backend.js";
@@ -29,6 +28,7 @@ import type { VolumeChunk } from "#src/sliceview/volume/backend.js";
 import { VolumeChunkSource } from "#src/sliceview/volume/backend.js";
 import type { CancellationToken } from "#src/util/cancellation.js";
 import { Endianness } from "#src/util/endian.js";
+import { decodeGzip } from "#src/util/gzip.js";
 import {
   isNotFoundError,
   responseArrayBuffer,
@@ -62,12 +62,7 @@ async function decodeChunk(
   let buffer = new Uint8Array(response, offset);
   switch (encoding) {
     case VolumeChunkEncoding.GZIP:
-      buffer = await requestAsyncComputation(
-        decodeGzip,
-        cancellationToken,
-        [buffer.buffer],
-        buffer,
-      );
+      buffer = new Uint8Array(await decodeGzip(buffer));
       break;
     case VolumeChunkEncoding.BLOSC:
       buffer = await requestAsyncComputation(

diff --git a/src/datasource/nifti/async_computation.ts b/src/datasource/nifti/async_computation.ts
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@
		import "#src/async_computation/decode_jpeg.js";
		import "#src/async_computation/decode_gzip.js";