diff --git a/.github/workflows/pullrequests.yml b/.github/workflows/pullrequests.yml index d7e2682e3b31..0de8097c5ef1 100644 --- a/.github/workflows/pullrequests.yml +++ b/.github/workflows/pullrequests.yml @@ -44,6 +44,50 @@ jobs: env: NODE_OPTIONS: "--max_old_space_size=8192" + schema: + if: ${{ github.repository_owner == 'cloudflare' }} + name: "Publish JSON schema" + runs-on: ubuntu-latest + steps: + - name: Checkout Repo + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Use Node.js 18 + uses: actions/setup-node@v3 + with: + node-version: 18 + cache: "npm" # cache ~/.npm in case 'npm ci' needs to run + + - name: Install workerd Dependencies + if: ${{ runner.os == 'Linux' }} + run: | + export DEBIAN_FRONTEND=noninteractive + sudo apt-get update + sudo apt-get install -y libc++1 + + - name: Install NPM Dependencies + run: npm ci + + - name: Build Wrangler + run: npm run build + + - name: Generate JSON schema + run: npx typescript-json-schema packages/wrangler/tsconfig.json RawConfig > packages/json-schema-worker/wrangler-schema.json + + - name: Upload JSON schema + run: npx wrangler kv:key put ${{ github.head_ref }} --path wrangler-schema.json --binding Schema --preview false + env: + CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} + working-directory: packages/json-schema-worker + + - name: Build & Publish JSON Schema worker + run: npm run deploy + env: + CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }} + working-directory: packages/json-schema-worker + test: name: "Tests" strategy: diff --git a/package-lock.json b/package-lock.json index 8fbdfbab2ec8..9bd1dfcd0f0c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2511,6 +2511,10 @@ "react": "^15.0.0-0 || ^16.0.0-0 || ^17.0.0-0" } }, + "node_modules/@cloudflare/json-schema-worker": { + "resolved": "packages/json-schema-worker", + "link": true + }, "node_modules/@cloudflare/kv-asset-handler": { "version": "0.2.0", "license": "MIT OR Apache-2.0", @@ -28266,6 +28270,13 @@ "url": "https://github.com/sponsors/wooorm" } }, + "packages/json-schema-worker": { + "name": "@cloudflare/json-schema-worker", + "version": "0.0.0", + "devDependencies": { + "wrangler": "2.8.1" + } + }, "packages/pages-shared": { "name": "@cloudflare/pages-shared", "version": "0.0.13", @@ -31259,6 +31270,12 @@ "dev": true, "requires": {} }, + "@cloudflare/json-schema-worker": { + "version": "file:packages/json-schema-worker", + "requires": { + "wrangler": "2.8.1" + } + }, "@cloudflare/kv-asset-handler": { "version": "0.2.0", "requires": { diff --git a/packages/json-schema-worker/package.json b/packages/json-schema-worker/package.json new file mode 100644 index 000000000000..117570c59fdf --- /dev/null +++ b/packages/json-schema-worker/package.json @@ -0,0 +1,12 @@ +{ + "name": "@cloudflare/json-schema-worker", + "version": "0.0.0", + "private": true, + "scripts": { + "deploy": "wrangler publish", + "start": "wrangler dev" + }, + "devDependencies": { + "wrangler": "2.8.1" + } +} diff --git a/packages/json-schema-worker/src/index.ts b/packages/json-schema-worker/src/index.ts new file mode 100644 index 000000000000..4fb4a9e9acf3 --- /dev/null +++ b/packages/json-schema-worker/src/index.ts @@ -0,0 +1,12 @@ +export default { + async fetch(request: Request, env: Env): Promise { + const url = new URL(request.url); + const matches = url.pathname.match(/\/(.*?)\.json/); + if (matches) { + const branch = matches[1]; + return Response.json(await env.Schema.get(branch, "json")); + } else { + return new Response(null, { status: 404 }); + } + }, +}; diff --git a/packages/json-schema-worker/tsconfig.json b/packages/json-schema-worker/tsconfig.json new file mode 100644 index 000000000000..d8a199cc714d --- /dev/null +++ b/packages/json-schema-worker/tsconfig.json @@ -0,0 +1,106 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Projects */ + // "incremental": true, /* Enable incremental compilation */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + "lib": [ + "es2021" + ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */, + "jsx": "react" /* Specify what JSX code is generated. */, + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */ + // "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + + /* Modules */ + "module": "es2022" /* Specify what module code is generated. */, + // "rootDir": "./", /* Specify the root folder within your source files. */ + "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */, + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */ + "types": [ + "@cloudflare/workers-types", + "jest" + ] /* Specify type package names to be included without being referenced in a source file. */, + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + "resolveJsonModule": true /* Enable importing .json files */, + // "noResolve": true, /* Disallow `import`s, `require`s or ``s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */, + "checkJs": false /* Enable error reporting in type-checked JavaScript files. */, + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + "noEmit": true /* Disable emitting files from a compilation. */, + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */, + "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */, + // "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */ + // "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */ + // "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} diff --git a/packages/json-schema-worker/worker-configuration.d.ts b/packages/json-schema-worker/worker-configuration.d.ts new file mode 100644 index 000000000000..40a3022ed78c --- /dev/null +++ b/packages/json-schema-worker/worker-configuration.d.ts @@ -0,0 +1,4 @@ +// Generated by Wrangler on Mon Jan 23 2023 21:41:02 GMT+0000 (Greenwich Mean Time) +interface Env { + Schema: KVNamespace; +} diff --git a/packages/json-schema-worker/wrangler.toml b/packages/json-schema-worker/wrangler.toml new file mode 100644 index 000000000000..9dd369217944 --- /dev/null +++ b/packages/json-schema-worker/wrangler.toml @@ -0,0 +1,7 @@ +name = "json-schema-worker" +main = "src/index.ts" +compatibility_date = "2023-01-23" +account_id = "e35fd947284363a46fd7061634477114" +route = { pattern = "json-schema.devprod.cloudflare.dev", custom_domain = true } + +kv_namespaces = [{ binding = "Schema", id = "4c8cacd39db14eec98cec812f2401300", preview_id = "4c8cacd39db14eec98cec812f2401300"}] \ No newline at end of file