Enable running Loam from a CDN like unpkg #76
Conversation
Loam.initialize() now accepts an absolute path as a prefix, and accepts an optional, second prefix for GDAL assets, instead of using the same prefix for both Loam and GDAL assets.
| @@ -14,7 +14,7 @@ jobs: | |||
|
|
|||
| strategy: | |||
| matrix: | |||
| node-version: [10.x, 12.x] | |||
| node-version: [12.x, 14.x] | |||
There was a problem hiding this comment.
This is fallout from upgrading webpack, which was required to resolve a bug and add the demo page.
| @@ -50,136 +50,124 @@ self.Module = { | |||
| // Optimized builds contain a .js.mem file which is loaded asynchronously; | |||
| // this waits until that has finished before performing further setup. | |||
| onRuntimeInitialized: function () { | |||
| try { | |||
There was a problem hiding this comment.
The change here is removing this try block and delegating error handling to the native onerror handler.
| }, | ||
| }; | ||
|
|
||
| // Load gdal.js. This will populate the Module object, and then call | ||
| // Module.onRuntimeInitialized() when it is ready for user code to interact with it. | ||
| importScripts('gdal.js'); |
There was a problem hiding this comment.
This now happens within the blobified webworker initialization code.
| @@ -14,33 +59,75 @@ function getPathPrefix() { | |||
| return THIS_SCRIPT.src.substring(0, THIS_SCRIPT.src.lastIndexOf('/')) + '/'; | |||
| } | |||
|
|
|||
| // Destroy the worker and clear the promise so that calling initWorker will make a new one. | |||
| function clearWorker() { | |||
There was a problem hiding this comment.
This was necessary because the statefulness of the worker made testing initialization processes impossible without a way to reset the worker state.
| throw new Error('render() promise should have been rejected but got ' + | ||
| result + ' instead.' | ||
| throw new Error( | ||
| 'render() promise should have been rejected but got ' + |
There was a problem hiding this comment.
I added format-on-save to my editor since the last time touching this file and there was some minor fallout.
|
This is ready for review (and was yesterday, but I was rushing to get it done before I had to sign off and forgot to specify)! |
| ### `loam.reset()` | ||
| Tear down Loam's internal Web Worker. This will cause initialize() to create a new Web Worker the next time it is called. | ||
|
|
||
| **Note**: This exists primarily to enable certain types of unit testing. It should not be necessary to call this function during normal usage of Loam. If you find that you are encountering a problem that loam.reset() solves, please [open an issue](https://github.com/azavea/loam/issues) |
This was much trickier than anticipated due to webpack/webpack-dev-server#2484 which necessitated upgrading to webpack-dev-server 4.0.0-rc.0
ddohler
force-pushed
the
feature/dpd/run-from-cdn
branch
from
1e564fd to
60c5a29
Compare
Overview
This turned into a bit of a grab-bag, but it does two key things to improve developer experience:
yarn demo. This provides a complete example of how to utilize loam in a simple webapp, and can be used as a test bed for features (in fact, it usesunpkgto load GDAL) or as a playground.Notes
Testing Instructions
yarn installto pick up dependency upgrades.yarn demoshould result in a demo page being available on localhost:8080 -- you should be able to edit Loam source or the page source and change the behavior of the page.Checklist
Resolves #58