SvelteKit SDK: Cannot find package '$env' imported from @arcjet/sveltekit/index.js

[davidmytton]

Reported in #886 (comment), the Sveltekit adapter is not working with both Node and Bun (which is the runtime of the original report).

"@arcjet/sveltekit": "^1.0.0-alpha.16"

Reproduce - Node

node --version
v20.14.0

Follow the SvelteKit setup guide:

npm create svelte@latest my-app
cd my-app
npm install
npm run dev

Then follow our SvelteKit getting started guide to install npm i @arcjet/sveltekit and create an API route at src/routes/arcjet/+server.ts

import { env } from "$env/dynamic/private";
import arcjet, { tokenBucket } from "@arcjet/sveltekit";
import { error, json, type RequestEvent } from "@sveltejs/kit";

const aj = arcjet({
  // Get your site key from https://app.arcjet.com
  // and set it as an environment variable rather than hard coding.
  // See: https://kit.svelte.dev/docs/modules#$env-dynamic-private
  key: env.ARCJET_KEY!,
  rules: [
    // Create a token bucket rate limit. Other algorithms are supported.
    tokenBucket({
      mode: "LIVE", // will block requests. Use "DRY_RUN" to log only
      characteristics: ["userId"], // track requests by a custom user ID
      refillRate: 5, // refill 5 tokens per interval
      interval: 10, // refill every 10 seconds
      capacity: 10, // bucket maximum capacity of 10 tokens
    }),
  ],
});

export async function GET(event: RequestEvent) {
  const userId = "user123"; // Replace with your authenticated user ID
  const decision = await aj.protect(event, { userId, requested: 5 }); // Deduct 5 tokens from the bucket
  console.log("Arcjet decision", decision);

  if (decision.isDenied()) {
    return error(429, { message: "Too many requests" });
  }

  return json({ message: "Hello world" });
}

Then npm run dev and loading the route errors:

npm run dev

> sk@0.0.1 dev
> vite dev

Re-optimizing dependencies because lockfile has changed

  VITE v5.3.1  ready in 418 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h + enter to show help
9:39:51 AM [vite] Error when evaluating SSR module /Users/david/Code/sk/src/routes/arcjet/+server.ts: failed to import "@arcjet/sveltekit"
|- Error [ERR_MODULE_NOT_FOUND]: Cannot find package '$env' imported from /Users/david/Code/sk/node_modules/@arcjet/sveltekit/index.js
    at packageResolve (node:internal/modules/esm/resolve:854:9)
    at moduleResolve (node:internal/modules/esm/resolve:927:18)
    at defaultResolve (node:internal/modules/esm/resolve:1157:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:227:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:87:39)
    at link (node:internal/modules/esm/module_job:86:36)

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '$env' imported from /Users/david/Code/sk/node_modules/@arcjet/sveltekit/index.js
    at packageResolve (node:internal/modules/esm/resolve:854:9)
    at moduleResolve (node:internal/modules/esm/resolve:927:18)
    at defaultResolve (node:internal/modules/esm/resolve:1157:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:227:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:87:39)
    at link (node:internal/modules/esm/module_job:86:36) {
  code: 'ERR_MODULE_NOT_FOUND'
}
Error [ERR_MODULE_NOT_FOUND]: Cannot find package '$env' imported from /Users/david/Code/sk/node_modules/@arcjet/sveltekit/index.js
    at packageResolve (node:internal/modules/esm/resolve:854:9)
    at moduleResolve (node:internal/modules/esm/resolve:927:18)
    at defaultResolve (node:internal/modules/esm/resolve:1157:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:227:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:87:39)
    at link (node:internal/modules/esm/module_job:86:36) {
  code: 'ERR_MODULE_NOT_FOUND'

Reproduce - Bun

bun --version
1.1.8

Follow the Bun Sveltekit guide:

bun create svelte@latest my-app
# Choose SvelteKit demo app and Add type checking with TypeScript? with no additional options
cd my-app
bun install

Then follow our SvelteKit getting started guide to install bun install @arcjet/sveltekit and you get a similar error:

bun run dev
$ vite dev

  VITE v5.3.1  ready in 340 ms

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h + enter to show help
9:54:46 AM [vite] Error when evaluating SSR module /Users/david/Code/my-app/src/routes/arcjet/+server.ts: failed to import "@arcjet/sveltekit"
|- Error [ERR_MODULE_NOT_FOUND]: Cannot find package '$env' imported from /Users/david/Code/my-app/node_modules/@arcjet/sveltekit/index.js
    at packageResolve (node:internal/modules/esm/resolve:854:9)
    at moduleResolve (node:internal/modules/esm/resolve:927:18)
    at defaultResolve (node:internal/modules/esm/resolve:1157:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:227:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:87:39)
    at link (node:internal/modules/esm/module_job:86:36)

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '$env' imported from /Users/david/Code/my-app/node_modules/@arcjet/sveltekit/index.js
    at packageResolve (node:internal/modules/esm/resolve:854:9)
    at moduleResolve (node:internal/modules/esm/resolve:927:18)
    at defaultResolve (node:internal/modules/esm/resolve:1157:11)
    at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:383:12)
    at ModuleLoader.resolve (node:internal/modules/esm/loader:352:25)
    at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:227:38)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:87:39)
    at link (node:internal/modules/esm/module_job:86:36) {
  code: 'ERR_MODULE_NOT_FOUND'

[blaine-arcjet]

I'm wondering how SvelteKit creates/replaces the $env/dynamic/private module. If it creates a virtual module, we should be able to access that, but it seems like it might not.

[blaine-arcjet]

This issue doesn't surface in our example so it might be related to node_modules

[blaine-arcjet]

I was finally able to get this to trigger in our sveltekit example too.