@fastly/js-compute - npm Package Compare versions

Comparing version 0.2.5 to 0.3.0

bin/linux-x86_64/README.md

@@ -11,3 +11,3 @@ # Fastly Compute@Edge JS Runtime
 
-```
+```sh
 git submodule update --recursive --init
@@ -25,4 +25,45 @@ ```
 
+
 Alternatively, the engine can also be built from source using `c-dependencies/spidermonkey/build-engine.sh`. That should only be required if you want to modify the engine itself, however.
 
+In addition you need to have the following tools installed to successfully build, and build from a linux based system.
+
+- Rust 
+  ```
+  curl -so rust.sh https://sh.rustup.rs && sh rust.sh -y
+  restart shell or run source $HOME/.cargo/env
+  ```
+- Build tools
+  ```sh
+  sudo apt install build-essential
+  ```
+- binaryen
+  ```sh
+  sudo apt install binaryen
+  ```
+- rust target wasm32-wasi
+  ```sh
+  rustup target add wasm32-wasi
+  ```
+- [cbindgen](https://github.com/eqrion/cbindgen#quick-start)
+  ```sh
+  cargo install cbindgen
+  ```
+- [wasi-sdk, version 12](https://github.com/WebAssembly/wasi-sdk/releases/tag/wasi-sdk-12),
+  with alternate [install instructions](https://github.com/WebAssembly/wasi-sdk#install)
+  ```sh
+  curl -sS -L -O https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-12/wasi-sdk-12.0-linux.tar.gz
+  tar xf wasi-sdk-12.0-linux.tar.gz
+  sudo mkdir -p /opt/wasi-sdk
+  sudo mv wasi-sdk-12.0/* /opt/wasi-sdk/
+  ```
+
+- rust version - the rust version may need to be pinned due to the WASI spidermonkey version, the current version can be found at [main.yml](.github/workflows/main.yml) under "Install pinned Rust version and wasm32-wasi target"
+  ```
+   rustup update 1.57.0 --no-self-update
+
+   cd /location/of/js-compute-runtime
+   rustup override set 1.57.0
+  ```
+
 Once that is done, the runtime and the CLI tool for applying it to JS source code can be built using cargo:
@@ -33,2 +74,15 @@ ```sh
 
+#### Build a windows executable
+To build for windows on a linux system you need to install the following modules:
+
+```
+sudo apt-get install gcc-mingw-w64
+rustup target add x86_64-pc-windows-gnu
+```
+
+then you can run the following
+```sh
+cargo build --target x86_64-pc-windows-gnu --release
+```
+
 ## Testing
@@ -49,2 +103,3 @@
 ```
+
 into a C@E service with your build of the CLI tool, run the following command:
@@ -59,1 +114,8 @@ ```sh
 ```
+
+## Testing a Dev Release
+:warning:	**You should not use this for production workloads!!!!!!!!**
+
+Dev builds are released before production releases to allow for further testing. These are not released upstream to NPM, however you can acquire them from the [Releases](https://github.com/fastly/js-compute-runtime/releases/) section. Download the runtime for your platform, extract the executable and place it in the /node_modules/@fastly/js-compute/bin/PLATFORM folder of your Compute@Edge project. Then you can use the normal [Fastly CLI](https://github.com/fastly/cli) to build your service. 
+
+Please submit an [issue](https://github.com/fastly/js-compute-runtime/issues) if you find any problems during testing.

bin/macos-x86_64/README.md

@@ -11,3 +11,3 @@ # Fastly Compute@Edge JS Runtime
 
-```
+```sh
 git submodule update --recursive --init
@@ -25,4 +25,45 @@ ```
 
+
 Alternatively, the engine can also be built from source using `c-dependencies/spidermonkey/build-engine.sh`. That should only be required if you want to modify the engine itself, however.
 
+In addition you need to have the following tools installed to successfully build, and build from a linux based system.
+
+- Rust 
+  ```
+  curl -so rust.sh https://sh.rustup.rs && sh rust.sh -y
+  restart shell or run source $HOME/.cargo/env
+  ```
+- Build tools
+  ```sh
+  sudo apt install build-essential
+  ```
+- binaryen
+  ```sh
+  sudo apt install binaryen
+  ```
+- rust target wasm32-wasi
+  ```sh
+  rustup target add wasm32-wasi
+  ```
+- [cbindgen](https://github.com/eqrion/cbindgen#quick-start)
+  ```sh
+  cargo install cbindgen
+  ```
+- [wasi-sdk, version 12](https://github.com/WebAssembly/wasi-sdk/releases/tag/wasi-sdk-12),
+  with alternate [install instructions](https://github.com/WebAssembly/wasi-sdk#install)
+  ```sh
+  curl -sS -L -O https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-12/wasi-sdk-12.0-linux.tar.gz
+  tar xf wasi-sdk-12.0-linux.tar.gz
+  sudo mkdir -p /opt/wasi-sdk
+  sudo mv wasi-sdk-12.0/* /opt/wasi-sdk/
+  ```
+
+- rust version - the rust version may need to be pinned due to the WASI spidermonkey version, the current version can be found at [main.yml](.github/workflows/main.yml) under "Install pinned Rust version and wasm32-wasi target"
+  ```
+   rustup update 1.57.0 --no-self-update
+
+   cd /location/of/js-compute-runtime
+   rustup override set 1.57.0
+  ```
+
 Once that is done, the runtime and the CLI tool for applying it to JS source code can be built using cargo:
@@ -33,2 +74,15 @@ ```sh
 
+#### Build a windows executable
+To build for windows on a linux system you need to install the following modules:
+
+```
+sudo apt-get install gcc-mingw-w64
+rustup target add x86_64-pc-windows-gnu
+```
+
+then you can run the following
+```sh
+cargo build --target x86_64-pc-windows-gnu --release
+```
+
 ## Testing
@@ -49,2 +103,3 @@
 ```
+
 into a C@E service with your build of the CLI tool, run the following command:
@@ -59,1 +114,8 @@ ```sh
 ```
+
+## Testing a Dev Release
+:warning:	**You should not use this for production workloads!!!!!!!!**
+
+Dev builds are released before production releases to allow for further testing. These are not released upstream to NPM, however you can acquire them from the [Releases](https://github.com/fastly/js-compute-runtime/releases/) section. Download the runtime for your platform, extract the executable and place it in the /node_modules/@fastly/js-compute/bin/PLATFORM folder of your Compute@Edge project. Then you can use the normal [Fastly CLI](https://github.com/fastly/cli) to build your service. 
+
+Please submit an [issue](https://github.com/fastly/js-compute-runtime/issues) if you find any problems during testing.

bin/windows-x86_64/README.md

@@ -11,3 +11,3 @@ # Fastly Compute@Edge JS Runtime
 
-```
+```sh
 git submodule update --recursive --init
@@ -25,4 +25,45 @@ ```
 
+
 Alternatively, the engine can also be built from source using `c-dependencies/spidermonkey/build-engine.sh`. That should only be required if you want to modify the engine itself, however.
 
+In addition you need to have the following tools installed to successfully build, and build from a linux based system.
+
+- Rust 
+  ```
+  curl -so rust.sh https://sh.rustup.rs && sh rust.sh -y
+  restart shell or run source $HOME/.cargo/env
+  ```
+- Build tools
+  ```sh
+  sudo apt install build-essential
+  ```
+- binaryen
+  ```sh
+  sudo apt install binaryen
+  ```
+- rust target wasm32-wasi
+  ```sh
+  rustup target add wasm32-wasi
+  ```
+- [cbindgen](https://github.com/eqrion/cbindgen#quick-start)
+  ```sh
+  cargo install cbindgen
+  ```
+- [wasi-sdk, version 12](https://github.com/WebAssembly/wasi-sdk/releases/tag/wasi-sdk-12),
+  with alternate [install instructions](https://github.com/WebAssembly/wasi-sdk#install)
+  ```sh
+  curl -sS -L -O https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-12/wasi-sdk-12.0-linux.tar.gz
+  tar xf wasi-sdk-12.0-linux.tar.gz
+  sudo mkdir -p /opt/wasi-sdk
+  sudo mv wasi-sdk-12.0/* /opt/wasi-sdk/
+  ```
+
+- rust version - the rust version may need to be pinned due to the WASI spidermonkey version, the current version can be found at [main.yml](.github/workflows/main.yml) under "Install pinned Rust version and wasm32-wasi target"
+  ```
+   rustup update 1.57.0 --no-self-update
+
+   cd /location/of/js-compute-runtime
+   rustup override set 1.57.0
+  ```
+
 Once that is done, the runtime and the CLI tool for applying it to JS source code can be built using cargo:
@@ -33,2 +74,15 @@ ```sh
 
+#### Build a windows executable
+To build for windows on a linux system you need to install the following modules:
+
+```
+sudo apt-get install gcc-mingw-w64
+rustup target add x86_64-pc-windows-gnu
+```
+
+then you can run the following
+```sh
+cargo build --target x86_64-pc-windows-gnu --release
+```
+
 ## Testing
@@ -49,2 +103,3 @@
 ```
+
 into a C@E service with your build of the CLI tool, run the following command:
@@ -59,1 +114,8 @@ ```sh
 ```
+
+## Testing a Dev Release
+:warning:	**You should not use this for production workloads!!!!!!!!**
+
+Dev builds are released before production releases to allow for further testing. These are not released upstream to NPM, however you can acquire them from the [Releases](https://github.com/fastly/js-compute-runtime/releases/) section. Download the runtime for your platform, extract the executable and place it in the /node_modules/@fastly/js-compute/bin/PLATFORM folder of your Compute@Edge project. Then you can use the normal [Fastly CLI](https://github.com/fastly/cli) to build your service. 
+
+Please submit an [issue](https://github.com/fastly/js-compute-runtime/issues) if you find any problems during testing.

CHANGELOG.md

@@ -0,1 +1,19 @@
+## 0.3.0 (2022-06-29)
+
+### Enhancements
+
+- Implement the CompressionStream builtin
+  [#84](https://github.com/fastly/js-compute-runtime/pull/84)
+- Removed the requirement for a fastly.toml file to be present when using js-compute-runtimes CLI to compile a WASM file
+- **Breaking change:** Removed --skip-pkg argument from js-compute-runtime's CLI
+  [#108](https://github.com/fastly/js-compute-runtime/pull/108)
+- **Breaking change:** Removed `console.trace` method
+
+### Fixes
+
+- Fix the response error message text
+- Throw an error if constructors are called as plain functions
+- Fix the behavior of `console.debug`
+- Allow builtin classes to be extended
+
 ## 0.2.5  (2022-04-20)
@@ -2,0 +20,0 @@

package.json

 {
   "name": "@fastly/js-compute",
-  "version": "0.2.5",
-  "js-compute-runtime-version": "0.2.5",
+  "version": "0.3.0",
+  "js-compute-runtime-version": "0.3.0",
   "license": "SEE LICENSE IN LICENSE",
@@ -6,0 +6,0 @@ "main": "js-compute-runtime-cli.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

71712614

increased by1.03%

No dependency changes