Fix Cesium in Node.js 12+. #8659
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "type": "commonjs" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /*eslint-env node*/ | ||
| 'use strict'; | ||
|
|
||
| var path = require('path'); | ||
|
|
||
| // If in 'production' mode, use the combined/minified/optimized version of Cesium | ||
| if (process.env.NODE_ENV === 'production') { | ||
| module.exports = require(path.join(__dirname, 'Build/Cesium/Cesium')); | ||
| return; | ||
| } | ||
|
|
||
| try { | ||
| module.exports = require('esm')(module)('./Source/Cesium.js'); | ||
| } catch (e) { | ||
| if (e.code !== 'ERR_REQUIRE_ESM') { | ||
| throw e; | ||
| } | ||
|
|
||
| // Node 12+ throws an exception when trying to load an ES module via `esm`, | ||
| // because `esm` loads Cesium ES modules via require instead of import, and | ||
| // that is an illegal thing to do because Cesium's package.json declares | ||
| // `"type": "module"`. Node doesn't know that `esm` is magically | ||
| // transforming the ES modules to CommonJS. | ||
| // | ||
| // So, we override the loader for .js files to skip the exception. | ||
| // Idea from here: | ||
| // https://github.com/standard-things/esm/issues/855#issuecomment-566825957 | ||
| var fs = require('fs'); | ||
|
|
||
| var originalFunc = require.extensions['.js']; | ||
| require.extensions['.js'] = function(module, filename) { | ||
| if (filename.startsWith(__dirname)) { | ||
| var content = fs.readFileSync(filename, 'utf8'); | ||
| module._compile(content, filename); | ||
| return; | ||
| } | ||
| originalFunc(module, filename); | ||
| }; | ||
|
|
||
| module.exports = require('esm')(module)('./Source/Cesium.js'); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,8 +29,12 @@ | |
| "url": "https://github.com/CesiumGS/cesium/issues", | ||
| "email": "cesium-dev@googlegroups.com" | ||
| }, | ||
| "main": "index.cjs", | ||
| "module": "./Source/Cesium.js", | ||
| "exports": { | ||
| "require": "./index.cjs", | ||
| "import": "./Source/Cesium.js" | ||
| }, | ||
| "type": "module", | ||
| "dependencies": { | ||
| "esm": "^3.2.25" | ||
|
|
@@ -81,35 +85,35 @@ | |
| "yargs": "^15.0.1" | ||
| }, | ||
| "scripts": { | ||
| "convertToModules": "gulp -f gulpfile.cjs convertToModules", | ||
| "start": "node server.cjs", | ||
| "startPublic": "node server.cjs --public", | ||
| "build": "gulp -f gulpfile.cjs build", | ||
|
There was a problem hiding this comment. We can revert all of the |
||
| "build-watch": "gulp -f gulpfile.cjs build-watch", | ||
| "buildApps": "gulp -f gulpfile.cjs buildApps", | ||
| "clean": "gulp -f gulpfile.cjs clean", | ||
| "cloc": "gulp -f gulpfile.cjs cloc", | ||
| "combine": "gulp -f gulpfile.cjs combine", | ||
| "combineRelease": "gulp -f gulpfile.cjs combineRelease", | ||
| "coverage": "gulp -f gulpfile.cjs coverage", | ||
| "generateDocumentation": "gulp -f gulpfile.cjs generateDocumentation", | ||
| "generateDocumentation-watch": "gulp -f gulpfile.cjs generateDocumentation-watch", | ||
| "eslint": "eslint \"./**/*.js\" \"./**/*.html\" --cache --quiet", | ||
| "makeZipFile": "gulp -f gulpfile.cjs makeZipFile", | ||
| "minify": "gulp -f gulpfile.cjs minify", | ||
| "minifyRelease": "gulp -f gulpfile.cjs minifyRelease", | ||
| "release": "gulp -f gulpfile.cjs release", | ||
| "build-specs": "gulp -f gulpfile.cjs build-specs", | ||
| "test": "gulp -f gulpfile.cjs test", | ||
| "test-all": "gulp -f gulpfile.cjs test --all", | ||
| "test-webgl": "gulp -f gulpfile.cjs test --include WebGL", | ||
| "test-non-webgl": "gulp -f gulpfile.cjs test --exclude WebGL", | ||
| "test-webgl-validation": "gulp -f gulpfile.cjs test --webglValidation", | ||
| "test-webgl-stub": "gulp -f gulpfile.cjs test --webglStub", | ||
| "test-release": "gulp -f gulpfile.cjs test --release", | ||
| "sortRequires": "gulp -f gulpfile.cjs sortRequires", | ||
| "deploy-s3": "gulp -f gulpfile.cjs deploy-s3", | ||
| "deploy-status": "gulp -f gulpfile.cjs deploy-status", | ||
| "deploy-set-version": "gulp -f gulpfile.cjs deploy-set-version" | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a global change to the node environment, right? Sounds like we don't have a lot of options, just wanted to confirm.
Just to throw out an alternative, we could always use the built version of Cesium in NodeJS and by requiring
CesiumUnminified/Cesium.jswe would still get extra debugging and such.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, if
esmis going the way of the dodo, maybe it's better to just use combined in all cases now and we can revisit going full import later on (Node 14?)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea! I got rid of the hack and made
index.cjsalways load the built version, eitherBuild/Cesium/Cesium.jsorBuild/CesiumUnminified/Cesium.jsdepending on theNODE_ENV.I also hooked up sourcemaps so it still looks like separate source file while debugging. I couldn't get it to work in the minified build for some reason, though. Uglify/Rollup are supposed to be able to do sourcemapping in this scenario, but the generated sourcemaps were rubbish. Step into a Cesium function in a release build and you'd end up somewhere totally random instead of in the function you're actually in.
If you use Node 12 and proper ES module support, you'll use the ES modules directly, with no transpilation by
esmor other shenanigans. However, the debug pragmas won't be removed in this scenario. That's unfortunate, but a problem for another day, I think.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, thanks again for your work on this. We talked offline, but just to summarize for anyone else,
rollup-plugin-strip-pragmacan be used for pragma removal, debug sourcemaps are still enabled, release will have to wait for a different PR to figure out the problem.