Merge pull request #11773 from CesiumGS/resource-fetch

Swap node internal packages out for `fetch` in `Resource`
CesiumGS · Jan 22, 2024 · 3ca3506 · 3ca3506
2 parents 5046889 + 7410218
commit 3ca3506
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 80 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -9,6 +9,8 @@
 - By default, the screen space camera controller will no longer go inside or under instances of `Cesium3DTileset`. [#11581](https://github.com/CesiumGS/cesium/pull/11581)
   - This behavior can be disabled by setting `Cesium3DTileset.disableCollision` to true.
   - This feature is enabled by default only for WebGL 2 and above, but can be enabled for WebGL 1 by setting the `enablePick` option to true when creating the `Cesium3DTileset`.
+- Remove the need for node internal packages `http`, `https`, `url` and `zlib` in the `Resource` class. This means they do not need to be marked external by build tools anymore. [#11773](https://github.com/CesiumGS/cesium/pull/11773)
+  - This slightly changed the contents of the `RequestErrorEvent` error that is thrown in node environments when a request fails. The `response` property is now a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) object instead of an [`http.IncomingMessage`](https://nodejs.org/docs/latest-v20.x/api/http.html#class-httpincomingmessage)
 
 ##### Additions :tada:
 

diff --git a/Specs/test.cjs b/Specs/test.cjs
@@ -1,15 +1,15 @@
 /*eslint-env node*/
 "use strict";
 
-// NodeJS smoke screen test
-
 const assert = require("node:assert");
 const {
   Cartographic,
   createWorldTerrainAsync,
   sampleTerrain,
 } = require("cesium");
 
+// NodeJS smoke screen test
+
 async function test() {
   const provider = await createWorldTerrainAsync();
   const results = await sampleTerrain(provider, 11, [

diff --git a/Specs/test.mjs b/Specs/test.mjs
@@ -15,4 +15,5 @@ async function test() {
   assert(results[1].height < 10000);
 }
 
-test();
+test()
+
diff --git a/gulpfile.js b/gulpfile.js
@@ -798,7 +798,6 @@ export async function runCoverage(options) {
     sourcemap: true,
     format: "esm",
     target: "es2020",
-    external: ["https", "http", "url", "zlib"],
     outfile: karmaBundle,
     logLevel: "error", // print errors immediately, and collect warnings so we can filter out known ones
   });
@@ -812,7 +811,6 @@ export async function runCoverage(options) {
     sourcemap: true,
     format: "esm",
     target: "es2020",
-    external: ["https", "http", "url", "zlib"],
     outfile: specListBundle,
     plugins: [instrumentPlugin],
     logLevel: "error", // print errors immediately, and collect warnings so we can filter out known ones
@@ -1697,7 +1695,6 @@ async function buildCesiumViewer() {
   config.format = "iife";
   // Configure Cesium base path to use built
   config.define = { CESIUM_BASE_URL: `"."` };
-  config.external = ["https", "http", "url", "zlib"];
   config.outdir = cesiumViewerOutputDirectory;
   config.outbase = "Apps/CesiumViewer";
   config.logLevel = "error"; // print errors immediately, and collect warnings so we can filter out known ones

diff --git a/packages/engine/Source/Core/Resource.js b/packages/engine/Source/Core/Resource.js
@@ -2045,17 +2045,6 @@ Resource.createImageBitmapFromBlob = function (blob, options) {
   });
 };
 
-function decodeResponse(loadWithHttpResponse, responseType) {
-  switch (responseType) {
-    case "text":
-      return loadWithHttpResponse.toString("utf8");
-    case "json":
-      return JSON.parse(loadWithHttpResponse.toString("utf8"));
-    default:
-      return new Uint8Array(loadWithHttpResponse).buffer;
-  }
-}
-
 function loadWithHttpRequest(
   url,
   responseType,
@@ -2066,64 +2055,36 @@ function loadWithHttpRequest(
   overrideMimeType
 ) {
   // Note: only the 'json' and 'text' responseTypes transforms the loaded buffer
-  let URL;
-  let zlib;
-  Promise.all([import("url"), import("zlib")])
-    .then(([urlImport, zlibImport]) => {
-      URL = urlImport.parse(url);
-      zlib = zlibImport;
-
-      return URL.protocol === "https:" ? import("https") : import("http");
-    })
-    .then((http) => {
-      const options = {
-        protocol: URL.protocol,
-        hostname: URL.hostname,
-        port: URL.port,
-        path: URL.path,
-        query: URL.query,
-        method: method,
-        headers: headers,
-      };
-      http
-        .request(options)
-        .on("response", function (res) {
-          if (res.statusCode < 200 || res.statusCode >= 300) {
-            deferred.reject(
-              new RequestErrorEvent(res.statusCode, res, res.headers)
-            );
-            return;
-          }
-
-          const chunkArray = [];
-          res.on("data", function (chunk) {
-            chunkArray.push(chunk);
-          });
+  fetch(url, {
+    method,
+    headers,
+  })
+    .then(async (response) => {
+      if (!response.ok) {
+        const responseHeaders = {};
+        response.headers.forEach((value, key) => {
+          responseHeaders[key] = value;
+        });
+        deferred.reject(
+          new RequestErrorEvent(response.status, response, responseHeaders)
+        );
+        return;
+      }
 
-          res.on("end", function () {
-            // eslint-disable-next-line no-undef
-            const result = Buffer.concat(chunkArray);
-            if (res.headers["content-encoding"] === "gzip") {
-              zlib.gunzip(result, function (error, resultUnzipped) {
-                if (error) {
-                  deferred.reject(
-                    new RuntimeError("Error decompressing response.")
-                  );
-                } else {
-                  deferred.resolve(
-                    decodeResponse(resultUnzipped, responseType)
-                  );
-                }
-              });
-            } else {
-              deferred.resolve(decodeResponse(result, responseType));
-            }
-          });
-        })
-        .on("error", function (e) {
-          deferred.reject(new RequestErrorEvent());
-        })
-        .end();
+      switch (responseType) {
+        case "text":
+          deferred.resolve(response.text());
+          break;
+        case "json":
+          deferred.resolve(response.json());
+          break;
+        default:
+          deferred.resolve(new Uint8Array(await response.arrayBuffer()).buffer);
+          break;
+      }
+    })
+    .catch(() => {
+      deferred.reject(new RequestErrorEvent());
     });
 }
 
@@ -2226,7 +2187,7 @@ Resource._Implementations.loadWithXhr = function (
     //or do not support the xhr.response property.
     if (xhr.status === 204) {
       // accept no content
-      deferred.resolve();
+      deferred.resolve(undefined);
     } else if (
       defined(response) &&
       (!defined(responseType) || browserResponseType === responseType)

diff --git a/scripts/build.js b/scripts/build.js
@@ -162,7 +162,6 @@ export async function bundleCesiumJs(options) {
   buildConfig.entryPoints = ["Source/Cesium.js"];
   buildConfig.minify = options.minify;
   buildConfig.sourcemap = options.sourcemap;
-  buildConfig.external = ["https", "http", "url", "zlib"];
   buildConfig.plugins = options.removePragmas ? [stripPragmaPlugin] : undefined;
   buildConfig.write = options.write;
   buildConfig.banner = {
@@ -361,7 +360,7 @@ export async function bundleWorkers(options) {
   const workers = await globby(["packages/engine/Source/Workers/**"]);
   const workerConfig = defaultESBuildOptions();
   workerConfig.bundle = true;
-  workerConfig.external = ["http", "https", "url", "zlib", "fs", "path"];
+  workerConfig.external = ["fs", "path"];
 
   if (options.iife) {
     let contents = ``;
@@ -816,7 +815,6 @@ export async function bundleCombinedSpecs(options) {
     sourcemap: true,
     outdir: path.join("Build", "Specs"),
     plugins: [externalResolvePlugin],
-    external: [`http`, `https`, `url`, `zlib`],
     write: options.write,
   });
 }
@@ -843,7 +841,7 @@ export async function bundleTestWorkers(options) {
     format: "esm",
     sourcemap: true,
     outdir: path.join("Build", "Specs", "TestWorkers"),
-    external: ["http", "https", "url", "zlib", "fs", "path"],
+    external: ["fs", "path"],
     write: options.write,
   });
 }
@@ -960,7 +958,6 @@ async function bundleSpecs(options) {
     format: "esm",
     outdir: options.outdir,
     sourcemap: true,
-    external: ["https", "http", "zlib", "url"],
     target: "es2020",
     write: write,
   };