Fastly Compute Proxy Integration Open Response Plugins

• Enable plugins in your proxy integration
• Use the example KV Store plugin
• Make your own plugin

​

Enable plugins in your proxy integration

​

Step 1: Enable plugins in your Fingerprint Config store

1. Inside your Fastly dashboard, navigate to Resources > Config stores > Fingerprint_Compute_Config_Store_<SERVICE_ID>.
2. Create an item OPEN_CLIENT_RESPONSE_PLUGINS_ENABLED and set it to true. The integration will process the open client response and run all registered plugins. You can set this flag to false to disable all plugins at once.

​

Step 2: Add a decryption key to your Secret store

1. Inside your Fastly dashboard, navigate to Resources > Secret stores > Fingerprint_Compute_Secret_Store_<SERVICE_ID>.
2. Create an item DECRYPTION_KEY and set it to the value of your decryption key.

​

Use the example KV Store plugin

​

Step 1: Create a KV Store

1. Inside the Fastly dashboard, navigate to Resources > KV Stores.
2. Click Create a KV Store.
3. Name it Fingerprint_Results_<SERVICE_ID> where the suffix is your proxy integration’s Compute Service ID. Make sure you have no spaces in the KV store name after copy-pasting your service ID.
4. Click Add.
5. In your KV store, click Link to services.
6. Select your proxy integration service, click Next, Link and activate, and Confirm and activate.
7. Click Finish.

​

Step 2: Enable the KV Store plugin

1. Inside your Fastly dashboard, navigate to Resources > Config stores > Fingerprint_Compute_Config_Store_<SERVICE_ID>.
2. Create an item SAVE_TO_KV_STORE_PLUGIN_ENABLED and set it to true. This specifically enables only the example KV Store plugin. You can set this flag to false to disable only this plugin.

​

Step 3: Test the KV Store plugin

1. Use the Fingerprint client agent to make identification requests through your Fastly Compute proxy integration.
2. After a few moments, you should see the results of these identification events inside your KV Store.

• Go to your integration’s status page at metric.yourwebsite.com/status to see that your integration is working and all required variables are set.
• Double-check the names of your Config store, Secret store, and KV Store. Check the names and values of all the configuration variables.
• Examine the logs of your proxy integration for errors.
• Contact our support team.

​

Make your own plugin

​

Step 1: Fork the integration repository

1. Fork the Fastly Compute proxy integration repository to your own GitHub account. This allows you to manage and deploy your custom plugins while staying in sync with the base repository.
2. Clone the forked repository to your local machine:
   Copy

   Ask AI

   git clone https://github.com/YOUR_GITHUB_USERNAME/fingerprint-pro-fastly-compute-proxy-integration.git
   cd fingerprint-pro-fastly-compute-proxy-integration
   
3. Install dependencies using PNPM:
   Copy

   Ask AI

   pnpm install
   

​

Step 2: Implement your custom plugin

// plugins/yourPlugin.ts
import { getConfigStore } from '../src/utils/getStore' 
import { ProcessOpenClientResponseContext } from '../src/utils/registerPlugin'

export async function yourPlugin(context: ProcessOpenClientResponseContext) {
  // Optional 'enabled' check
  const configStore = getConfigStore()
  const isPluginEnabled = configStore?.get('YOUR_PLUGIN_ENABLED') === 'true'
  if (!isPluginEnabled) {
    return
  }
  // Process the result as you need
  console.log(context.event, context.httpResponse);
}

• A plugin is a callback function that receives ProcessOpenClientResponseContext as its argument. The response context includes the Fingerprint identification event with the complete device intelligence result.
• You can use a custom item in your integration’s Config store to enable or disable the plugin. If you implement this check, do not forget to add the item to your Config store. This operation may take some time to take effect due to Fastly Compute’s caching policy.
• See the example saveToKVStore.ts plugin for reference.
• See processOpenClientResponse.ts to see how the callback is called.

​

Step 3: Register the plugin

import { saveFingerprintResultToKVStore } from './saveToKVStore'
import { yourPlugin } from './yourPlugin'
import { Plugin } from '../src/utils/registerPlugin'

export default [
  {
    name: 'Save Fingerprint Result to KV Store',  
    callback: saveFingerprintResultToKVStore,
    type: 'processOpenClientResponse',
  },
  { 
    name: 'Your plugin',
    callback: yourPlugin,
    type: 'processOpenClientResponse',
  },
] satisfies Plugin[]

​

Step 4: Compile your custom package

fastly compute build

Note: You can confirm this by searching for your package name in build/index.js.

​

Step 5: Deploy your custom package

​

Using Fastly UI

1. Go to Fastly Dashboard.
2. Open your proxy integration Compute Service and click Edit configuration > Clone version (active) to edit.
3. Click Package in the left-hand menu.
4. Click Upload new package and upload the fingerprint-fastly-compute-proxy-integration.tar.gz file.
5. Click Activate in the top right to deploy a new version of your service.

​

Using Fastly CLI

1. Install the Fastly CLI on your local machine for managing deployments.
   Copy

   Ask AI

   fastly profile create
   
2. Inside your fork of the proxy integration Git repository, update the fastly.toml file to include your details:
   • Update service_id to the service ID of your proxy integration’s Compute service.
   • Update authors to add your name and email address.
   • Update description to provide a custom description for your service.
   Copy

   Ask AI

   # This file describes a Fastly Compute package. To learn more visit:
   # https://developer.fastly.com/reference/fastly-toml/
   
   authors = ["YOUR_EMAIL"]
   cloned_from = "https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration"
   description = "Fingerprint Proxy Fastly Compute Package"
   language = "javascript"
   manifest_version = 3
   name = "fingerprint-fastly-compute-proxy-integration"
   service_id = "YOUR_SERVICE_ID"
   
   [scripts]
     build = "pnpm build"
     post_init = "pnpm install"
   
3. Deploy your custom proxy service package to your proxy integration’s Fastly Compute service:
   Copy

   Ask AI

   fastly compute publish
   

​

Step 6: Test your plugin

1. Verify the deployment status of your service in the Fastly dashboard.
2. Check that the plugin behaves as you expect.
3. If necessary, examine your integration’s service logs.

Note: The proxy integration runs the plugins after it sends the identification response to the client. Plugins cannot interfere with or delay proxying requests, even if they fail. The integration logs and ignores any errors thrown by the plugin.

​

Step 7: Keep your forked repository up to date

git remote add upstream https://github.com/fingerprintjs/fingerprint-pro-fastly-compute-proxy-integration
git fetch upstream
git merge upstream/main