Merge pull request #27 from fingerprintjs/rc

Release v0.3.0-rc.1

Author: necipallef

.releaserc.json

@@ -30,7 +30,7 @@
     [
       "@semantic-release/exec",
       {
-        "prepareCmd":"pnpm build"
+        "prepareCmd":"pnpm artifact:create"
       }
     ],
     [

CHANGELOG.md

@@ -1,3 +1,74 @@
+## [0.3.0-rc.7](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.6...v0.3.0-rc.7) (2024-12-03)
+
+
+### Features
+
+* add links to the status page ([bed4323](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/bed4323b666ff30cc2451eda6dfb27d139fa1421))
+* restructure status page ([b8ead8f](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/b8ead8f28f10384ff9bff0484bae0cd6cdfe2563))
+* status page shows save_to_kvstore_plugin value ([4eb3aaa](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/4eb3aaae7fd0fb39119456830f06219f4a585c98))
+
+
+### Bug Fixes
+
+* status page wording ([468fd54](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/468fd54f1e786c1d2177e827e526059eda9b9b37))
+* undefined message for status page ([ef643f4](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/ef643f429427f452424a427a53a849e227dcc12e))
+
+## [0.3.0-rc.6](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.5...v0.3.0-rc.6) (2024-11-29)
+
+
+### Bug Fixes
+
+* more clear error message ([74a1a34](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/74a1a347f8d3ae423b74eed9007d54150a927635))
+
+## [0.3.0-rc.5](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.4...v0.3.0-rc.5) (2024-11-28)
+
+
+### Features
+
+* add backend checks to status page ([62260ae](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/62260aeb5f5fa7c10aabb7729cf4d09f5c55f087))
+* improve status page ([d1733b5](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/d1733b5768f8c1eaf95f041c2c92ff24b019c36b))
+
+
+### Bug Fixes
+
+* build command missing metadata ([3d77697](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/3d776976c72b3490b90aff4729f56170fbe2f9a7))
+* github ci not running prebuild ([9957582](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/9957582dc9ec64781ea718b3946fa9c7e34ccb9b))
+* show status page correct store name for kv storage ([5df22d3](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/5df22d368c5a7f38b46ffbc7e71a65d8d0d6cb08))
+
+## [0.3.0-rc.4](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.3...v0.3.0-rc.4) (2024-11-26)
+
+
+### Bug Fixes
+
+* when open client response is enabled, non utf body throws an error ([d88dc2b](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/d88dc2bb6ee36df4a3098ef390c3afd1ed151c2b))
+
+## [0.3.0-rc.3](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.2...v0.3.0-rc.3) (2024-11-25)
+
+
+### Bug Fixes
+
+* create artifact via metadata ([ba22a53](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/ba22a538130c75d22aa119aeb403390ca35f9426))
+
+## [0.3.0-rc.2](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.3.0-rc.1...v0.3.0-rc.2) (2024-11-22)
+
+
+### Bug Fixes
+
+* update fastly cli version to fix metadata bug ([95b2d60](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/95b2d60ad5bbe5c85a4c7075827cc69ad775122e))
+
+## [0.3.0-rc.1](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.2.1...v0.3.0-rc.1) (2024-11-21)
+
+
+### Features
+
+* add fastly compute service version to status page ([b7cd7b1](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/b7cd7b15dfd60708452f0ccef8d138387655ddbb))
+
+
+### Bug Fixes
+
+* add cors headers for error response ([0c9a721](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/0c9a721e4be67676505b09f14e36fb482d6f91d5))
+* enable metadata on pack step ([565affd](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/commit/565affd396c42b5ee7bb2a332a33b5a2dd0331c5))
+
 ## [0.2.1](https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration/compare/v0.2.0...v0.2.1) (2024-11-14)
 
 

README.md

@@ -42,7 +42,7 @@ This is a quick overview of the installation setup. For detailed step-by-step in
    | ---------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
    | AGENT_SCRIPT_DOWNLOAD_PATH   | z5kms2        | Random path segment for downloading the JavaScript agent.                                                                                                              |
    | GET_RESULT_PATH              | nocmjw        | Random path segment for Fingerprint identification requests.                                                                                                           |
-   | OPEN_CLIENT_RESPONSE_PLUGINS_ENABLED | false         | Set to `true` if you have [Open client response](https://dev.fingerprint.com/docs/open-client-response) enabled for your Fingerprint application. Defaults to `false`. |
+   | OPEN_CLIENT_RESPONSE_PLUGINS_ENABLED | false         | Set to `true` if you have [Open client response](https://dev.fingerprint.com/docs/open-client-response) enabled for your Fingerprint workspace. Defaults to `false`. |
 
 4. [Create a Secret store](https://docs.fastly.com/en/guides/working-with-secret-stores#creating-a-secret-store) named `Fingerprint_Compute_Secret_Store_<SERVICE_ID>`, where the suffix is your proxy integration's [Compute Service ID](https://docs.fastly.com/en/guides/about-services). Add your proxy secret:
 
@@ -71,25 +71,6 @@ This is a quick overview of the installation setup. For detailed step-by-step in
 
 See the [Fastly Compute proxy integration guide](https://dev.fingerprint.com/docs/fastly-compute-proxy-integration#step-4-configure-the-fingerprint-client-agent-to-use-your-service) in our documentation for more details.
 
-### Using custom store names
-
-By default, the service package provided in releases assumes the following names for the Config store and Secret Store:
-
-* `Fingerprint_Compute_Config_Store_<SERVICE_ID>`
-* `Fingerprint_Compute_Secret_Store_<SERVICE_ID>`
-
-To use a custom name prefix for both stores, use the `STORE_NAME_PREFIX` environment variable to build a custom service package:
-
-```shell=
-STORE_NAME_PREFIX=CustomName pnpm run build
-```
-
-Your custom built package in `pkg/fingerprint-fastly-compute-proxy-integration.tar.gz` will use your custom prefix in store names like:
-
-* `CustomName_Config_Store_<SERVICE_ID>`
-* `CustomName_Secret_Store_<SERVICE_ID>`
-
-
 ## Feedback and support
 
 Please reach out to our [Customer Success team](https://fingerprint.com/support/) if run into any issues with the integration.

contributing.md

@@ -22,6 +22,25 @@ For proposing changes, use the standard [pull request approach](https://docs.git
 2. Run `pnpm build` to compile the project and assemble the WebAssembly output.
 3. The build artifact is located in the `bin/main.wasm` file, which will be deployed to Fastly.
 
+### Using custom store names
+
+By default, the service package provided in releases assumes the following names for the Config store and Secret Store:
+
+* `Fingerprint_Compute_Config_Store_<SERVICE_ID>`
+* `Fingerprint_Compute_Secret_Store_<SERVICE_ID>`
+
+To use a custom name prefix for both(Secret and Config) stores, use the `STORE_NAME_PREFIX` environment variable to build a custom service package:
+
+```shell=
+STORE_NAME_PREFIX=CustomName fastly compute build
+```
+
+Your custom built package in `pkg/fingerprint-fastly-compute-proxy-integration.tar.gz` will use your custom prefix in store names like:
+
+* `CustomName_Config_Store_<SERVICE_ID>`
+* `CustomName_Secret_Store_<SERVICE_ID>`
+
+
 ### Code Style
 
 We enforce code quality using [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/). To check code style:

fastly.toml

@@ -1,5 +1,5 @@
 # This file describes a Fastly Compute package. To learn more visit:
-# https://developer.fastly.com/reference/fastly-toml/
+# https://www.fastly.com/documentation/reference/compute/fastly-toml/
 
 authors = ["support@fingerprint.com"]
 cloned_from = "https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration"

package.json

@@ -1,14 +1,14 @@
 {
   "name": "fingerprint-pro-fastly-compute-proxy-integration",
-  "version": "0.2.1",
+  "version": "0.3.0-rc.7",
   "engines": {
     "node": ">=20"
   },
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
-    "@fastly/cli": "^10.15.0",
+    "@fastly/cli": "^10.17.0",
     "@fingerprintjs/commit-lint-dx-team": "^0.1.0",
     "@fingerprintjs/conventional-changelog-dx-team": "^0.1.0",
     "@fingerprintjs/eslint-config-dx-team": "^0.1.0",
@@ -39,10 +39,10 @@
     "cookie": "0.7.0"
   },
   "scripts": {
-    "prebuild": "ts-node build.ts",
     "assemble": "js-compute-runtime build/index.js bin/main.wasm",
     "pack": "fastly compute pack --wasm-binary=./bin/main.wasm && mv pkg/package.tar.gz pkg/fingerprint-fastly-compute-proxy-integration.tar.gz",
-    "build": "pnpm run prebuild && pnpm run assemble && pnpm run pack",
+    "build": "ts-node build.ts && fastly compute metadata --enable && pnpm run assemble && pnpm run pack",
+    "artifact:create": "fastly compute build",
     "deploy": "fastly compute publish",
     "dev": "fastly compute serve",
     "prepare": "husky",

plugins/saveToKVStore.ts

@@ -4,18 +4,20 @@ import { KVStore } from 'fastly:kv-store'
 import { ProcessOpenClientResponseContext } from '../src/utils/registerPlugin'
 import { getConfigStore } from '../src/utils/getStore'
 import { env } from 'fastly:env'
+import { saveToKvStorePluginEnabledVarName } from '../src/env'
+
 export async function saveFingerprintResultToKVStore(context: ProcessOpenClientResponseContext) {
   const configStore = getConfigStore()
-  const isPluginEnabled = configStore?.get('SAVE_TO_KV_STORE_PLUGIN_ENABLED') === 'true'
+  const isPluginEnabled = configStore?.get(saveToKvStorePluginEnabledVarName) === 'true'
 
   if (!isPluginEnabled) {
-    console.log("Plugin 'saveFingerprintResultToKVStore' is not enabled")
+    console.log(`Plugin '${saveToKvStorePluginEnabledVarName}' is not enabled`)
     return
   }
 
   const requestId = context.event?.products.identification?.data?.requestId
   if (!requestId) {
-    console.log('[saveFingerprintResultToKVStore] Plugin Error: request ID is undefined in the event response.')
+    console.log(`[${saveToKvStorePluginEnabledVarName}] Plugin Error: request ID is undefined in the event response.`)
     return
   }
   const serviceId = env('FASTLY_SERVICE_ID')