wrangler 0.0.0-e88a54e → 0.0.0-e8a2a1d9

package/src/__tests__/whoami.test.tsx

@@ -1,100 +0,0 @@
-import { render } from "ink-testing-library";
-import React from "react";
-import { reinitialiseAuthTokens, writeAuthConfigFile } from "../user";
-import { getUserInfo, WhoAmI } from "../whoami";
-import { setMockResponse } from "./helpers/mock-cfetch";
-import { mockConsoleMethods } from "./helpers/mock-console";
-import { runInTempDir } from "./helpers/run-in-tmp";
-import type { UserInfo } from "../whoami";
-
-describe("getUserInfo()", () => {
-  runInTempDir({ homedir: "./home" });
-  const std = mockConsoleMethods();
-
-  it("should return undefined if there is no config file", async () => {
-    const userInfo = await getUserInfo();
-    expect(userInfo).toBeUndefined();
-  });
-
-  it("should return undefined if there is an empty config file", async () => {
-    writeAuthConfigFile({});
-    // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
-    reinitialiseAuthTokens();
-    const userInfo = await getUserInfo();
-    expect(userInfo).toBeUndefined();
-  });
-
-  it("should return the user's email and accounts if authenticated via config token", async () => {
-    writeAuthConfigFile({ oauth_token: "some-oauth-token" });
-    // Now that we have changed the auth tokens in the wrangler.toml we must reinitialize the user auth state.
-    reinitialiseAuthTokens();
-
-    setMockResponse("/user", () => {
-      return { email: "user@example.com" };
-    });
-    setMockResponse("/accounts", () => {
-      return [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ];
-    });
-
-    const userInfo = await getUserInfo();
-
-    expect(userInfo).toEqual({
-      authType: "OAuth",
-      apiToken: "some-oauth-token",
-      email: "user@example.com",
-      accounts: [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ],
-    });
-  });
-
-  it("should display a warning message if the config file contains a legacy api_token field", async () => {
-    writeAuthConfigFile({ api_token: "API_TOKEN" });
-    await reinitialiseAuthTokens();
-    await getUserInfo();
-    expect(std.warn).toMatchInlineSnapshot(`
-      "It looks like you have used Wrangler 1's \`config\` command to login with an API token.
-      This is no longer supported in the current version of Wrangler.
-      If you wish to authenticate via an API token then please set the \`CLOUDFLARE_API_TOKEN\` environment variable."
-    `);
-  });
-});
-
-describe("WhoAmI component", () => {
-  it("should return undefined if there is no user", async () => {
-    const { lastFrame } = render(<WhoAmI user={undefined}></WhoAmI>);
-
-    expect(lastFrame()).toMatchInlineSnapshot(
-      `"You are not authenticated. Please run \`wrangler login\`."`
-    );
-  });
-
-  it("should display the user's email and accounts", async () => {
-    const user: UserInfo = {
-      authType: "OAuth",
-      apiToken: "some-oauth-token",
-      email: "user@example.com",
-      accounts: [
-        { name: "Account One", id: "account-1" },
-        { name: "Account Two", id: "account-2" },
-        { name: "Account Three", id: "account-3" },
-      ],
-    };
-
-    const { lastFrame } = render(<WhoAmI user={user}></WhoAmI>);
-
-    expect(lastFrame()).toContain(
-      "You are logged in with an OAuth Token, associated with the email 'user@example.com'!"
-    );
-    expect(lastFrame()).toMatch(/Account Name .+ Account ID/);
-    expect(lastFrame()).toMatch(/Account One .+ account-1/);
-    expect(lastFrame()).toMatch(/Account Two .+ account-2/);
-    expect(lastFrame()).toMatch(/Account Three .+ account-3/);
-  });
-});

package/src/bundle.ts

@@ -1,142 +0,0 @@
-import assert from "node:assert";
-import * as fs from "node:fs";
-import * as path from "node:path";
-import * as esbuild from "esbuild";
-import createModuleCollector from "./module-collection";
-import type { Config } from "./config";
-import type { Entry } from "./entry";
-import type { CfModule } from "./worker";
-
-type BundleResult = {
-  modules: CfModule[];
-  resolvedEntryPointPath: string;
-  bundleType: "esm" | "commonjs";
-  stop: (() => void) | undefined;
-};
-
-/**
- * Generate a bundle for the worker identified by the arguments passed in.
- */
-export async function bundleWorker(
-  entry: Entry,
-  destination: string,
-  options: {
-    serveAssetsFromWorker: boolean;
-    jsxFactory: string | undefined;
-    jsxFragment: string | undefined;
-    rules: Config["rules"];
-    watch?: esbuild.WatchMode;
-  }
-): Promise<BundleResult> {
-  const { serveAssetsFromWorker, jsxFactory, jsxFragment, rules, watch } =
-    options;
-  const entryDirectory = path.dirname(entry.file);
-  const moduleCollector = createModuleCollector({
-    wrangler1xlegacyModuleReferences: {
-      rootDirectory: entryDirectory,
-      fileNames: new Set(
-        fs
-          .readdirSync(entryDirectory, { withFileTypes: true })
-          .filter(
-            (dirEntry) =>
-              dirEntry.isFile() && dirEntry.name !== path.basename(entry.file)
-          )
-          .map((dirEnt) => dirEnt.name)
-      ),
-    },
-    format: entry.format,
-    rules,
-  });
-  const result = await esbuild.build({
-    ...getEntryPoint(entry.file, serveAssetsFromWorker),
-    bundle: true,
-    absWorkingDir: entry.directory,
-    outdir: destination,
-    external: ["__STATIC_CONTENT_MANIFEST"],
-    format: "esm",
-    sourcemap: true,
-    metafile: true,
-    conditions: ["worker", "browser"],
-    loader: {
-      ".js": "jsx",
-      ".mjs": "jsx",
-      ".cjs": "jsx",
-    },
-    plugins: [moduleCollector.plugin],
-    ...(jsxFactory && { jsxFactory }),
-    ...(jsxFragment && { jsxFragment }),
-    watch,
-  });
-
-  const entryPointOutputs = Object.entries(result.metafile.outputs).filter(
-    ([_path, output]) => output.entryPoint !== undefined
-  );
-  assert(
-    entryPointOutputs.length > 0,
-    `Cannot find entry-point "${entry.file}" in generated bundle.` +
-      listEntryPoints(entryPointOutputs)
-  );
-  assert(
-    entryPointOutputs.length < 2,
-    "More than one entry-point found for generated bundle." +
-      listEntryPoints(entryPointOutputs)
-  );
-
-  const entryPointExports = entryPointOutputs[0][1].exports;
-  const bundleType = entryPointExports.length > 0 ? "esm" : "commonjs";
-
-  return {
-    modules: moduleCollector.modules,
-    resolvedEntryPointPath: path.resolve(
-      entry.directory,
-      entryPointOutputs[0][0]
-    ),
-    bundleType,
-    stop: result.stop,
-  };
-}
-
-type EntryPoint =
-  | { stdin: esbuild.StdinOptions; nodePaths: string[] }
-  | { entryPoints: string[] };
-
-/**
- * Create an object that describes the entry point for esbuild.
- *
- * If we are using the experimental asset handling, then the entry point is
- * actually a shim worker that will either return an asset from a KV store,
- * or delegate to the actual worker.
- */
-function getEntryPoint(
-  entryFile: string,
-  serveAssetsFromWorker: boolean
-): EntryPoint {
-  if (serveAssetsFromWorker) {
-    return {
-      stdin: {
-        contents: fs
-          .readFileSync(
-            path.join(__dirname, "../templates/static-asset-facade.js"),
-            "utf8"
-          )
-          .replace("__ENTRY_POINT__", entryFile),
-        sourcefile: "static-asset-facade.js",
-        resolveDir: path.dirname(entryFile),
-      },
-      nodePaths: [path.join(__dirname, "../vendor")],
-    };
-  } else {
-    return { entryPoints: [entryFile] };
-  }
-}
-
-/**
- * Generate a string that describes the entry-points that were identified by esbuild.
- */
-function listEntryPoints(
-  outputs: [string, ValueOf<esbuild.Metafile["outputs"]>][]
-): string {
-  return outputs.map(([_input, output]) => output.entryPoint).join("\n");
-}
-
-type ValueOf<T> = T[keyof T];

package/src/cfetch/index.ts

@@ -1,104 +0,0 @@
-import { URLSearchParams } from "node:url";
-import { ParseError } from "../parse";
-import { fetchInternal } from "./internal";
-import type { RequestInit } from "undici";
-
-// Check out https://api.cloudflare.com/ for API docs.
-
-export { getCloudflareAPIBaseURL as getCloudflareApiBaseUrl } from "./internal";
-
-export interface FetchError {
-  code: number;
-  message: string;
-}
-export interface FetchResult<ResponseType = unknown> {
-  success: boolean;
-  result: ResponseType;
-  errors: FetchError[];
-  messages: string[];
-  result_info?: unknown;
-}
-
-export { fetchKVGetValue } from "./internal";
-
-/**
- * Make a fetch request, and extract the `result` from the JSON response.
- */
-export async function fetchResult<ResponseType>(
-  resource: string,
-  init: RequestInit = {},
-  queryParams?: URLSearchParams
-): Promise<ResponseType> {
-  const json = await fetchInternal<FetchResult<ResponseType>>(
-    resource,
-    init,
-    queryParams
-  );
-  if (json.success) {
-    return json.result;
-  } else {
-    throwFetchError(resource, json);
-  }
-}
-
-/**
- * Make a fetch request for a list of values,
- * extracting the `result` from the JSON response,
- * and repeating the request if the results are paginated.
- */
-export async function fetchListResult<ResponseType>(
-  resource: string,
-  init: RequestInit = {},
-  queryParams?: URLSearchParams
-): Promise<ResponseType[]> {
-  const results: ResponseType[] = [];
-  let getMoreResults = true;
-  let cursor: string | undefined;
-  while (getMoreResults) {
-    if (cursor) {
-      queryParams = new URLSearchParams(queryParams);
-      queryParams.set("cursor", cursor);
-    }
-    const json = await fetchInternal<FetchResult<ResponseType[]>>(
-      resource,
-      init,
-      queryParams
-    );
-    if (json.success) {
-      results.push(...json.result);
-      if (hasCursor(json.result_info)) {
-        cursor = json.result_info?.cursor;
-      } else {
-        getMoreResults = false;
-      }
-    } else {
-      throwFetchError(resource, json);
-    }
-  }
-  return results;
-}
-
-function throwFetchError(
-  resource: string,
-  response: FetchResult<unknown>
-): never {
-  const error = new ParseError({
-    text: "Received a bad response from the API",
-    notes: response.errors.map((err) => ({
-      text: err.code ? `${err.message} [code: ${err.code}]` : err.message,
-    })),
-  });
-  // add the first error code directly to this error
-  // so consumers can use it for specific behaviour
-  const code = response.errors[0]?.code;
-  if (code) {
-    //@ts-expect-error non-standard property on Error
-    error.code = code;
-  }
-  throw error;
-}
-
-function hasCursor(result_info: unknown): result_info is { cursor: string } {
-  const cursor = (result_info as { cursor: string } | undefined)?.cursor;
-  return cursor !== undefined && cursor !== null && cursor !== "";
-}

package/src/cfetch/internal.ts

@@ -1,139 +0,0 @@
-import { fetch, Headers } from "undici";
-import { getEnvironmentVariableFactory } from "../environment-variables";
-import { ParseError, parseJSON } from "../parse";
-import { reportError } from "../reporting";
-import { getAPIToken, loginOrRefreshIfRequired } from "../user";
-import type { URLSearchParams } from "node:url";
-import type { RequestInit, HeadersInit } from "undici";
-
-/**
- * Get the URL to use to access the Cloudflare API.
- */
-export const getCloudflareAPIBaseURL = getEnvironmentVariableFactory({
-  variableName: "CLOUDFLARE_API_BASE_URL",
-  deprecatedName: "CF_API_BASE_URL",
-  defaultValue: "https://api.cloudflare.com/client/v4",
-});
-
-/**
- * Make a fetch request to the Cloudflare API.
- *
- * This function handles acquiring the API token and logging the caller in, as necessary.
- *
- * Check out https://api.cloudflare.com/ for API docs.
- *
- * This function should not be used directly, instead use the functions in `cfetch/index.ts`.
- */
-export async function fetchInternal<ResponseType>(
-  resource: string,
-  init: RequestInit = {},
-  queryParams?: URLSearchParams
-): Promise<ResponseType> {
-  await requireLoggedIn();
-  const apiToken = requireApiToken();
-  const headers = cloneHeaders(init.headers);
-  addAuthorizationHeader(headers, apiToken);
-
-  const queryString = queryParams ? `?${queryParams.toString()}` : "";
-  const method = init.method ?? "GET";
-  const response = await fetch(
-    `${getCloudflareAPIBaseURL()}${resource}${queryString}`,
-    {
-      method,
-      ...init,
-      headers,
-    }
-  );
-  const jsonText = await response.text();
-  try {
-    return parseJSON(jsonText) as ResponseType;
-  } catch (err) {
-    await reportError(err as Error);
-    throw new ParseError({
-      text: "Received a malformed response from the API",
-      notes: [
-        {
-          text: truncate(jsonText, 100),
-        },
-        {
-          text: `${method} ${resource} -> ${response.status} ${response.statusText}`,
-        },
-      ],
-    });
-  }
-}
-
-function truncate(text: string, maxLength: number): string {
-  const { length } = text;
-  if (length <= maxLength) {
-    return text;
-  }
-  return `${text.substring(0, maxLength)}... (length = ${length})`;
-}
-
-function cloneHeaders(
-  headers: HeadersInit | undefined
-): Record<string, string> {
-  return headers instanceof Headers
-    ? Object.fromEntries(headers.entries())
-    : Array.isArray(headers)
-    ? Object.fromEntries(headers)
-    : { ...headers };
-}
-
-async function requireLoggedIn(): Promise<void> {
-  const loggedIn = await loginOrRefreshIfRequired();
-  if (!loggedIn) {
-    throw new Error("Not logged in.");
-  }
-}
-
-function requireApiToken(): string {
-  const authToken = getAPIToken();
-  if (!authToken) {
-    throw new Error("No API token found.");
-  }
-  return authToken;
-}
-
-function addAuthorizationHeader(
-  headers: Record<string, string>,
-  apiToken: string
-): void {
-  if ("Authorization" in headers) {
-    throw new Error(
-      "The request already specifies an authorisation header - cannot add a new one."
-    );
-  }
-  headers["Authorization"] = `Bearer ${apiToken}`;
-}
-
-/**
- * The implementation for fetching a kv value from the cloudflare API.
- * We special-case this one call, because it's the only API call that
- * doesn't return json. We inline the implementation and try not to share
- * any code with the other calls. We should push back on any new APIs that
- * try to introduce non-"standard" response structures.
- */
-
-export async function fetchKVGetValue(
-  accountId: string,
-  namespaceId: string,
-  key: string
-): Promise<string> {
-  await requireLoggedIn();
-  const apiToken = requireApiToken();
-  const headers = { Authorization: `Bearer ${apiToken}` };
-  const resource = `${getCloudflareAPIBaseURL()}/accounts/${accountId}/storage/kv/namespaces/${namespaceId}/values/${key}`;
-  const response = await fetch(resource, {
-    method: "GET",
-    headers,
-  });
-  if (response.ok) {
-    return await response.text();
-  } else {
-    throw new Error(
-      `Failed to fetch ${resource} - ${response.status}: ${response.statusText});`
-    );
-  }
-}

package/src/cli.ts

@@ -1,19 +0,0 @@
-import process from "process";
-import { hideBin } from "yargs/helpers";
-import { reportError, initReporting } from "./reporting";
-import { main } from ".";
-
-try {
-  initReporting();
-} catch (error) {}
-
-process.on("uncaughtExceptionMonitor", async (err, origin) => {
-  await reportError(err, origin);
-});
-
-main(hideBin(process.argv)).catch(() => {
-  // The logging of any error that was thrown from `main()` is handled in the `yargs.fail()` handler.
-  // Here we just want to ensure that the process exits with a non-zero code.
-  // We don't want to do this inside the `main()` function, since that would kill the process when running our tests.
-  process.exit(1);
-});

package/src/config/README.md

@@ -1,107 +0,0 @@
-# Configuration validation
-
-The files in this directory define and validate the configuration that is read from a `wrangler.toml` file.
-
-The configuration for a Worker is complicated since we can define different "environments", and each environment can have its own configuration.
-There is a default ("top-level") environment and then named environments that provide environment specific configuration.
-
-This is further complicated by the fact that there are three kinds of environment configuration:
-
-- **non-overridable**: these values are defined once in the top-level configuration, apply to all environments and cannot be overridden by an environment.
-- **inheritable**: these values can be defined at the top-level but can also be overridden by environment specific values.
-  Named environments do not need to provide their own values, in which case they inherit the value from the top-level.
-- **non-inheritable**: these values must be explicitly defined in each environment if they are defined at the top-level.
-  Named environments do not inherit such configuration and must provide their own values.
-
-All configuration values in `wrangler.toml` are optional and will receive a default value if not defined.
-
-## Types
-
-### Environment
-
-The fields that can be defined within the `env` containers are defined in the [`Environment`](./environment.ts) type.
-This includes the `EnvironmentInheritable` and `EnvironmentNonInheritable` fields.
-
-### Config
-
-The "non-overridable" types are defined in the [`ConfigFields`](./config.ts) type.
-The `Config` type is the overall configuration, which consists of the `ConfigFields` and also an `Environment`.
-In this case the `Environment`, here, corresponds to the "currently active" environment. This is specified by the `--env` command line argument.
-If there is no argument passed then the currently active environment is the "top-level" environment.
-The fields in `Config` and `Environment` are not generally optional and so you can expect they have been filled with suitable inherited or default values.
-These types should be used when you are working with fields that should be passed to commands.
-
-### RawConfig
-
-The `RawConfig` type is a version of `Config`, where all the fields are optional.
-The `RawConfig` type includes `DeprecatedConfigFields` and `EnvironmentMap`.
-It also extends the `RawEnvironment` type, which is a version of `Environment` where all the fields are optional.
-These optional fields map to the actual fields found in the `wrangler.toml`.
-These types should be used when you are working with raw configuration that is read or will be written to a `wrangler.toml`.
-
-## Validation
-
-Validation is triggered by passing a `RawConfig` object, and the active environment name, to the `normalizeAndValidateConfig()` function.
-This function will return:
-
-- a `Config` object, where all the fields have suitable valid values
-- a `Diagnostics` object, which contains any errors or warnings from the validation process
-
-The field values may have been parsed directly from the `RawConfig`, inherited into a named environment from the top-level environment, or given a default value.
-Generally, if there are any warnings they should be presented to the user via `console.warn()` messages,
-and if there are any errors then an `Error` should be thrown describing these errors.
-
-The `Diagnostics` object is hierarchical: each `Diagnostics` instance can contain a collection of child `Diagnostics` instance.
-When checking for or rendering warnings and errors, the `Diagnostics` class will automatically traverse down to all its children.
-
-## Usage
-
-The [high level API](./index.ts) for configuration processing consists of the `findWranglerToml()` and `readConfig()` functions.
-
-### readConfig()
-
-The `readConfig()` function will find the nearest `wrangler.toml` file, load and parse it, then validate and normalize the values into a `Config` object.
-Note that you should pass the current active environment name in as a parameter. The resulting `Config` object will contain only the fields appropriate to that environment.
-If there are validation errors then it will throw a suitable error.
-
-## Changing configuration
-
-### Add a new configuration field
-
-When a new field needs to be added to the `wrangler.toml` configuration you will need to add to the types and validation code in this directory.
-
-Here are some steps that you should consider when doing this:
-
-- add the new field to one of the interface:
-  - if the field is not overridable in an environment then add it to the `ConfigFields` interface.
-  - if the field can be inherited and overridden in a named environment then add it to the `EnvironmentInheritable` interface.
-  - if the field cannot be inherited and must be specified in each named environment then add it to the `EnvironmentNonInheritable` interface.
-- if the field is experimental then add a call to the `experimental()` function:
-  - if the field is now in the `ConfigDeprecated` interface then add the call to the `normalizeAndValidateConfig()` function.
-  - if the field is now in the `EnvironmentDeprecated` interface then add the call to the `normalizeAndValidateEnvironment()` function.
-- add validation and normalization to the interface
-  - if the field is in `ConfigFields` then add validation calls to `normalizeAndValidateConfig()` and assign the normalized value to the appropriate property in the `config` object.
-  - if the field is in `EnvironmentInheritable` then call `inheritable()` in `normalizeAndValidateEnvironment()` and assign the normalized value to the appropriate property in the `environment` object.
-  - if the field is in `EnvironmentNonInheritable` then call `notInheritable()` in `normalizeAndValidateEnvironment()` and assign the normalized value to the appropriate property in the `environment` object.
-- update the tests in `configuration.test.ts`
-  - add to the `"should use defaults for empty configuration"` test to prove the correct default value is assigned
-  - if the field is in `ConfigFields` add tests to the `"top-level non-environment configuration"` block to check the validation and normalization of values
-  - if the field is in `EnvironmentInheritable` or `EnvironmentNonInheritable`
-    - add tests to the `"top-level environment configuration"` block to check the validation and normalization of values
-    - add tests to the `"named environment configuration"` block to check the inheritance of values
-
-### Remove a configuration field
-
-We should not just remove a field from use, since users would not know that this field is no longer needed, nor how to migrate to any new usage.
-Instead we should first deprecate it, and then then remove it in a future major release.
-
-- move the field to a deprecation interface:
-  - if the field was originally in `ConfigFields` then move it to the `ConfigDeprecated` interface.
-  - if the field was originally in either `EnvironmentInheritable` or `EnvironmentNonInheritable` then move it to the `EnvironmentDeprecatedInterface`.
-- remove the validation for the field
-  - the TypeScript compiler should indicate where there is now an unknown field, so that you can remove its validation and normalization from the code base.
-- add a deprecation warning by calling `deprecated()`
-  - if the field is now in the `ConfigDeprecated` interface then add the call to the `normalizeAndValidateConfig()` function.
-  - if the field is now in the `EnvironmentDeprecated` interface then add the call to the `normalizeAndValidateEnvironment()` function.
-- update the tests in `configuration.test.ts`
-  - Find tests where the field is mentioned and either remove them (e.g. validation) or update to show the deprecation message.