-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
77369b6
commit 7923438
Showing
8 changed files
with
631 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
module.exports = { | ||
root: true, | ||
extends: ['@cloudflare/eslint-config-next-on-pages'], | ||
rules: { | ||
'no-console': 'off', | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Next-on-pages Dev Bindings | ||
|
||
## TODO: populate readme |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"name": "@cloudflare/next-on-pages-dev-bindings", | ||
"version": "0.0.1", | ||
"main": "dist/index.cjs", | ||
"scripts": { | ||
"lint": "eslint src", | ||
"types-check": "tsc --noEmit", | ||
"build:js": "esbuild --bundle --format=cjs ./src/index.ts --external:miniflare --outfile=./dist/index.cjs --platform=node", | ||
"build:types": "tsc --emitDeclarationOnly --declaration --outDir ./dist", | ||
"build:js:watch": "npm run build:js -- --watch=forever", | ||
"build:types:watch": "npm run build:types -- --watch", | ||
"build": "npm run build:js && npm run build:types", | ||
"build:watch": "npm run build:js:watch & npm run build:types:watch", | ||
"test": "npx vitest --config vitest.config.ts" | ||
}, | ||
"files": [ | ||
"dist", | ||
"dev-init.cjs", | ||
"dev-init.d.ts", | ||
"devBindingsOptions.ts" | ||
], | ||
"dependencies": { | ||
"miniflare": "^3.20231002.0" | ||
}, | ||
"devDependencies": { | ||
"@cloudflare/workers-types": "4.20231002.0", | ||
"@tsconfig/strictest": "^2.0.0", | ||
"esbuild": "^0.15.3", | ||
"eslint": "^8.35.0", | ||
"tsconfig": "*", | ||
"typescript": "^5.0.4", | ||
"vitest": "^0.32.2" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
import { Miniflare } from "miniflare"; | ||
|
||
export async function setupDevBindings(options: DevBindingsOptions) { | ||
const mf = new Miniflare({ | ||
modules: true, | ||
script: "", | ||
kvPersist: true, | ||
durableObjectsPersist: true, | ||
r2Persist: true, | ||
d1Persist: true, | ||
...(options ?? {}), | ||
}); | ||
|
||
const bindingsCollections = await Promise.all([ | ||
collectBindings(mf, "KV", options?.kvNamespaces ?? []), | ||
collectBindings(mf, "DO", options?.durableObjects ?? []), | ||
collectBindings(mf, "R2", options?.r2Buckets ?? []), | ||
collectBindings(mf, "D1", options?.d1Databases ?? []), | ||
]); | ||
|
||
const bindings = bindingsCollections.flat(); | ||
|
||
const vmModule = require("vm"); | ||
const originalRunInContext = vmModule.runInContext.bind(vmModule); | ||
|
||
vmModule.runInContext = ( | ||
...args: [ | ||
string, | ||
{ process?: { env?: Record<string, unknown> } }, | ||
...[unknown] | ||
] | ||
) => { | ||
const runtimeContext = args[1]; | ||
if ( | ||
runtimeContext.process?.env && | ||
!runtimeContext.process?.env?.['BINDINGS_PROXY_SET'] | ||
) { | ||
for (const binding of bindings) { | ||
runtimeContext.process.env[binding.name] = binding.binding; | ||
} | ||
|
||
runtimeContext.process.env['BINDINGS_PROXY_SET'] = true; | ||
} | ||
|
||
return originalRunInContext(...args); | ||
}; | ||
} | ||
|
||
async function collectBindings( | ||
mf: Miniflare, | ||
type: "KV" | "DO" | "R2" | "D1", | ||
bindingsOpts: string[] | Record<string, unknown> | ||
) { | ||
const bindingNames = getBindingsNames(bindingsOpts); | ||
const bindingGetterFn = { | ||
KV: mf.getKVNamespace.bind(mf), | ||
DO: mf.getDurableObjectNamespace.bind(mf), | ||
R2: mf.getR2Bucket.bind(mf), | ||
D1: mf.getD1Database.bind(mf), | ||
}[type]; | ||
return await Promise.all( | ||
bindingNames.map(async (bindingName) => { | ||
return { | ||
name: bindingName, | ||
type, | ||
binding: await bindingGetterFn(bindingName), | ||
}; | ||
}) | ||
); | ||
} | ||
|
||
function getBindingsNames( | ||
bindings: string[] | Record<string, unknown> | ||
): string[] { | ||
if (Array.isArray(bindings)) return bindings; | ||
return Object.keys(bindings); | ||
} | ||
|
||
export type DevBindingsOptions = { | ||
kvNamespaces?: string[] | Record<string, string>; | ||
durableObjects?: Record< | ||
string, | ||
| string | ||
| { | ||
scriptName?: string | undefined; | ||
unsafeUniqueKey?: string | undefined; | ||
className: string; | ||
} | ||
>; | ||
r2Buckets?: string[] | Record<string, string>; | ||
d1Databases?: string[] | Record<string, string>; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"extends": "@cloudflare/next-on-pages-tsconfig/tsconfig.json", | ||
"include": [ | ||
".eslintrc.js", | ||
"src", | ||
"dev-init.cjs", | ||
"devBindingsOptions.ts" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.