wrangler 0.0.0-e2a26a0 → 0.0.0-e3cab74

package/src/__tests__/kv.test.ts

@@ -10,7 +10,7 @@ import { mockConsoleMethods } from "./helpers/mock-console";
 import { mockKeyListRequest } from "./helpers/mock-kv";
 import { runInTempDir } from "./helpers/run-in-tmp";
 import { runWrangler } from "./helpers/run-wrangler";
-import type { KVNamespaceInfo } from "../kv";
+import type { KVNamespaceInfo, NamespaceKeyInfo } from "../kv";
 
 describe("wrangler", () => {
   mockAccountId();
@@ -53,12 +53,12 @@ describe("wrangler", () => {
             namespace  The name of the new namespace  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local    Run on my machine  [boolean] [default: false]
                 --env      Perform on a specific environment  [string]
                 --preview  Interact with a preview namespace  [boolean]
 
@@ -82,12 +82,12 @@ describe("wrangler", () => {
             namespace  The name of the new namespace  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local    Run on my machine  [boolean] [default: false]
                 --env      Perform on a specific environment  [string]
                 --preview  Interact with a preview namespace  [boolean]
 
@@ -112,12 +112,12 @@ describe("wrangler", () => {
             namespace  The name of the new namespace  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local    Run on my machine  [boolean] [default: false]
                 --env      Perform on a specific environment  [string]
                 --preview  Interact with a preview namespace  [boolean]
 
@@ -276,12 +276,12 @@ describe("wrangler", () => {
           Deletes a given namespace.
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
                 --binding       The name of the namespace to delete  [string]
                 --namespace-id  The id of the namespace to delete  [string]
                 --env           Perform on a specific environment  [string]
@@ -467,23 +467,23 @@ describe("wrangler", () => {
           Writes a single key/value pair to the given namespace.
 
           Positionals:
-            key    The key to write to.  [string] [required]
-            value  The value to write.  [string]
+            key    The key to write to  [string] [required]
+            value  The value to write  [string]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
-                --binding       The binding of the namespace to write to.  [string]
-                --namespace-id  The id of the namespace to write to.  [string]
+                --binding       The binding of the namespace to write to  [string]
+                --namespace-id  The id of the namespace to write to  [string]
                 --env           Perform on a specific environment  [string]
                 --preview       Interact with a preview namespace  [boolean]
-                --ttl           Time for which the entries should be visible.  [number]
+                --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
-                --path          Read value from the file at a given path.  [string]
+                --path          Read value from the file at a given path  [string]
 
           Not enough non-option arguments: got 0, need at least 1"
         `);
@@ -503,23 +503,23 @@ describe("wrangler", () => {
           Writes a single key/value pair to the given namespace.
 
           Positionals:
-            key    The key to write to.  [string] [required]
-            value  The value to write.  [string]
+            key    The key to write to  [string] [required]
+            value  The value to write  [string]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
-                --binding       The binding of the namespace to write to.  [string]
-                --namespace-id  The id of the namespace to write to.  [string]
+                --binding       The binding of the namespace to write to  [string]
+                --namespace-id  The id of the namespace to write to  [string]
                 --env           Perform on a specific environment  [string]
                 --preview       Interact with a preview namespace  [boolean]
-                --ttl           Time for which the entries should be visible.  [number]
+                --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
-                --path          Read value from the file at a given path.  [string]
+                --path          Read value from the file at a given path  [string]
 
           Exactly one of the arguments binding and namespace-id is required"
         `);
@@ -539,23 +539,23 @@ describe("wrangler", () => {
           Writes a single key/value pair to the given namespace.
 
           Positionals:
-            key    The key to write to.  [string] [required]
-            value  The value to write.  [string]
+            key    The key to write to  [string] [required]
+            value  The value to write  [string]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
-                --binding       The binding of the namespace to write to.  [string]
-                --namespace-id  The id of the namespace to write to.  [string]
+                --binding       The binding of the namespace to write to  [string]
+                --namespace-id  The id of the namespace to write to  [string]
                 --env           Perform on a specific environment  [string]
                 --preview       Interact with a preview namespace  [boolean]
-                --ttl           Time for which the entries should be visible.  [number]
+                --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
-                --path          Read value from the file at a given path.  [string]
+                --path          Read value from the file at a given path  [string]
 
           Arguments binding and namespace-id are mutually exclusive"
         `);
@@ -575,23 +575,23 @@ describe("wrangler", () => {
           Writes a single key/value pair to the given namespace.
 
           Positionals:
-            key    The key to write to.  [string] [required]
-            value  The value to write.  [string]
+            key    The key to write to  [string] [required]
+            value  The value to write  [string]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
-                --binding       The binding of the namespace to write to.  [string]
-                --namespace-id  The id of the namespace to write to.  [string]
+                --binding       The binding of the namespace to write to  [string]
+                --namespace-id  The id of the namespace to write to  [string]
                 --env           Perform on a specific environment  [string]
                 --preview       Interact with a preview namespace  [boolean]
-                --ttl           Time for which the entries should be visible.  [number]
+                --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
-                --path          Read value from the file at a given path.  [string]
+                --path          Read value from the file at a given path  [string]
 
           Exactly one of the arguments value and path is required"
         `);
@@ -611,23 +611,23 @@ describe("wrangler", () => {
           Writes a single key/value pair to the given namespace.
 
           Positionals:
-            key    The key to write to.  [string] [required]
-            value  The value to write.  [string]
+            key    The key to write to  [string] [required]
+            value  The value to write  [string]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
-                --binding       The binding of the namespace to write to.  [string]
-                --namespace-id  The id of the namespace to write to.  [string]
+                --binding       The binding of the namespace to write to  [string]
+                --namespace-id  The id of the namespace to write to  [string]
                 --env           Perform on a specific environment  [string]
                 --preview       Interact with a preview namespace  [boolean]
-                --ttl           Time for which the entries should be visible.  [number]
+                --ttl           Time for which the entries should be visible  [number]
                 --expiration    Time since the UNIX epoch after which the entry expires  [number]
-                --path          Read value from the file at a given path.  [string]
+                --path          Read value from the file at a given path  [string]
 
           Arguments value and path are mutually exclusive"
         `);
@@ -839,7 +839,9 @@ describe("wrangler", () => {
               "kv:key list --namespace-id some-namespace-id --limit 100"
             );
             expect(std.err).toMatchInlineSnapshot(`""`);
-            expect(JSON.parse(std.out).map((k) => k.name)).toEqual(keys);
+            expect(
+              JSON.parse(std.out).map((k: NamespaceKeyInfo) => k.name)
+            ).toEqual(keys);
             expect(requests.count).toEqual(6);
           });
         });
@@ -938,12 +940,12 @@ describe("wrangler", () => {
             key  The key value to get.  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
                 --binding       The name of the namespace to get from  [string]
                 --namespace-id  The id of the namespace to get from  [string]
                 --env           Perform on a specific environment  [string]
@@ -969,12 +971,12 @@ describe("wrangler", () => {
             key  The key value to get.  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
                 --binding       The name of the namespace to get from  [string]
                 --namespace-id  The id of the namespace to get from  [string]
                 --env           Perform on a specific environment  [string]
@@ -1001,12 +1003,12 @@ describe("wrangler", () => {
             key  The key value to get.  [string] [required]
 
           Flags:
-            -c, --config   Path to .toml configuration file  [string]
-            -h, --help     Show help  [boolean]
-            -v, --version  Show version number  [boolean]
+            -c, --config      Path to .toml configuration file  [string]
+            -h, --help        Show help  [boolean]
+            -v, --version     Show version number  [boolean]
+                --legacy-env  Use legacy environments  [boolean]
 
           Options:
-            -l, --local         Run on my machine  [boolean] [default: false]
                 --binding       The name of the namespace to get from  [string]
                 --namespace-id  The id of the namespace to get from  [string]
                 --env           Perform on a specific environment  [string]

package/src/__tests__/package-manager.test.ts

@@ -151,7 +151,7 @@ describe("getPackageManager()", () => {
  * Create a fake yarn binary
  */
 function mockYarn(succeed: boolean): void {
-  let unMock;
+  let unMock: () => void;
   beforeEach(async () => {
     unMock = await mockBinary("yarn", `process.exit(${succeed ? 0 : 1})`);
   });
@@ -162,7 +162,7 @@ function mockYarn(succeed: boolean): void {
  * Create a fake npm binary
  */
 function mockNpm(succeed: boolean): void {
-  let unMock;
+  let unMock: () => void;
   beforeEach(async () => {
     unMock = await mockBinary("npm", `process.exit(${succeed ? 0 : 1})`);
   });

package/src/__tests__/parse.test.ts

@@ -0,0 +1,322 @@
+import {
+  formatMessage,
+  searchLocation,
+  indexLocation,
+  parseJSON,
+  parseTOML,
+} from "../parse";
+import type { Message } from "../parse";
+
+describe("formatMessage", () => {
+  const format = (input: Message) => {
+    // No color and skip emojis at the start.
+    return formatMessage(input, false).substring(2);
+  };
+
+  it("should format message without location", () => {
+    expect(
+      format({
+        text: "Invalid argument",
+        kind: "warning",
+      })
+    ).toMatchInlineSnapshot(`
+      "[WARNING] Invalid argument
+
+      "
+    `);
+  });
+
+  it("should format message with location", () => {
+    expect(
+      format({
+        text: "Missing property: main",
+        location: {
+          line: 1,
+          column: 0,
+          lineText: "{}",
+          file: "package.json",
+          fileText: "{}",
+        },
+      })
+    ).toMatchInlineSnapshot(`
+      "[ERROR] Missing property: main
+
+          package.json:1:0:
+            1 │ {}
+              ╵ ^
+
+      "
+    `);
+  });
+
+  it("should format message with location and notes", () => {
+    expect(
+      format({
+        text: "Invalid property: type",
+        location: {
+          line: 3,
+          column: 8,
+          length: 7,
+          lineText: "type = 'modular'",
+          suggestion: "Did you mean 'module'?",
+          file: "package.toml",
+          fileText: "[package]\ntype = 'modular'\n",
+        },
+        notes: [
+          {
+            text: "There are two acceptable types: 'module' and 'commonjs'",
+          },
+        ],
+      })
+    ).toMatchInlineSnapshot(`
+      "[ERROR] Invalid property: type
+
+          package.toml:3:8:
+            3 │ type = 'modular'
+              │         ~~~~~~~
+              ╵         Did you mean 'module'?
+
+        There are two acceptable types: 'module' and 'commonjs'
+
+      "
+    `);
+  });
+});
+
+describe("parseTOML", () => {
+  it("should parse toml that is empty", () => {
+    expect(parseTOML("")).toStrictEqual({});
+  });
+
+  it("should parse toml with basic values", () => {
+    expect(
+      parseTOML(`
+        name = "basic"
+        version = 1
+    `)
+    ).toStrictEqual({
+      name: "basic",
+      version: 1,
+    });
+  });
+
+  it("should parse toml with complex values", () => {
+    expect(
+      parseTOML(`
+        name = 'complex'
+        version = 1
+        [owner]
+        name = ["tim"]
+        alive = true
+        [owner.dog]
+        exists = true
+      `)
+    ).toStrictEqual({
+      name: "complex",
+      owner: {
+        alive: true,
+        dog: {
+          exists: true,
+        },
+        name: ["tim"],
+      },
+      version: 1,
+    });
+  });
+
+  it("should fail to parse toml with invalid string", () => {
+    try {
+      parseTOML(`name = 'fail"`);
+      fail("parseTOML did not throw");
+    } catch (err) {
+      expect({ ...(err as Error) }).toStrictEqual({
+        name: "ParseError",
+        text: "Unterminated string",
+        kind: "error",
+        location: {
+          line: 1,
+          column: 14,
+          fileText: "name = 'fail\"",
+          file: undefined,
+          lineText: "name = 'fail\"",
+        },
+        notes: [],
+      });
+    }
+  });
+
+  it("should fail to parse toml with invalid header", () => {
+    try {
+      parseTOML(`\n[name`, "config.toml");
+      fail("parseTOML did not throw");
+    } catch (err) {
+      expect({ ...(err as Error) }).toStrictEqual({
+        name: "ParseError",
+        text: "Key ended without value",
+        kind: "error",
+        location: {
+          line: 2,
+          column: 5,
+          lineText: "[name",
+          file: "config.toml",
+          fileText: "\n[name",
+        },
+        notes: [],
+      });
+    }
+  });
+});
+
+describe("parseJSON", () => {
+  it("should parse json that is empty", () => {
+    expect(parseJSON("{}")).toStrictEqual({});
+  });
+
+  it("should parse json with basic values", () => {
+    expect(
+      parseJSON(`
+      {
+        "name" : "basic",
+        "version": 1
+      }`)
+    ).toStrictEqual({
+      name: "basic",
+      version: 1,
+    });
+  });
+
+  it("should parse json with complex values", () => {
+    expect(
+      parseJSON(
+        `{
+          "name":"complex",
+          "spec":{
+            "uptime":[1,2.5,3],
+            "ok":true
+          }
+        }`
+      )
+    ).toStrictEqual({
+      name: "complex",
+      spec: {
+        uptime: [1, 2.5, 3],
+        ok: true,
+      },
+    });
+  });
+
+  it("should fail to parse json with invalid string", () => {
+    try {
+      parseJSON(`\n{\n"version" "1\n}\n`);
+      fail("parseJSON did not throw");
+    } catch (err) {
+      expect({ ...(err as Error) }).toStrictEqual({
+        name: "ParseError",
+        text: "Unexpected string",
+        kind: "error",
+        location: {
+          line: 3,
+          column: 9,
+          lineText: '"version" "1',
+          file: undefined,
+          fileText: `\n{\n"version" "1\n}\n`,
+        },
+        notes: [],
+      });
+    }
+  });
+
+  it("should fail to parse json with invalid number", () => {
+    const file = "config.json",
+      fileText = `{\n\t"a":{\n\t\t"b":{\n\t\t\t"c":[012345]\n}\n}\n}`;
+    try {
+      parseJSON(fileText, file);
+      fail("parseJSON did not throw");
+    } catch (err) {
+      expect({ ...(err as Error) }).toStrictEqual({
+        name: "ParseError",
+        text: "Unexpected number",
+        kind: "error",
+        location: {
+          file,
+          fileText,
+          line: 4,
+          column: 8,
+          lineText: `\t\t\t"c":[012345]`,
+        },
+        notes: [],
+      });
+    }
+  });
+});
+
+describe("indexLocation", () => {
+  it("should calculate location from one-line input", () => {
+    const fileText = "";
+    expect(indexLocation({ fileText }, 1)).toStrictEqual({
+      fileText,
+      line: 1,
+      column: 0,
+      lineText: "",
+    });
+  });
+
+  it("should calculate location from multi-line input", () => {
+    const file = "package.json",
+      fileText = `\n{\n\t"hello":"world"\n}\n`;
+    expect(indexLocation({ file, fileText }, 11)).toStrictEqual({
+      file,
+      fileText,
+      line: 3,
+      column: 7,
+      lineText: `\t"hello":"world"`,
+    });
+  });
+
+  it("should calculate location when index is out of bounds", () => {
+    const fileText = `\n\n\n\n`;
+    expect(indexLocation({ fileText }, 10)).toStrictEqual({
+      fileText,
+      line: 5,
+      column: 0,
+      lineText: undefined,
+    });
+  });
+});
+
+describe("searchLocation", () => {
+  it("should calculate location from one-line match", () => {
+    const file = "config.toml",
+      fileText = `name = 'coolthing'`;
+    expect(searchLocation({ file, fileText }, "coolthing")).toStrictEqual({
+      file,
+      fileText,
+      line: 1,
+      column: 8,
+      length: 9,
+      lineText: `name = 'coolthing'`,
+    });
+  });
+
+  it("should calculate location from multi-line match", () => {
+    const fileText = `\n{"versions":[\n\t"1.2.3",\n\t"1.2.4",\n\t"1.2.5"\n]}\n`;
+    expect(searchLocation({ fileText }, "1.2.4")).toStrictEqual({
+      fileText,
+      line: 4,
+      column: 2,
+      length: 5,
+      lineText: `\t"1.2.4",`,
+    });
+  });
+
+  it("should calculate location from no match", () => {
+    const fileText = `\n{}\n`;
+    expect(searchLocation({ fileText }, "apple")).toStrictEqual({
+      fileText,
+      line: 3,
+      column: 0,
+      length: undefined,
+      lineText: undefined,
+    });
+  });
+});