convex 1.44.0 → 1.45.0

package/src/cli/lib/formatEnvValueForDotfile.test.ts

@@ -1,294 +0,0 @@
-/**
- * NOTE: This test file is intentionally duplicated in dashboard-common.
- * If you change this file, also update:
- * npm-packages/dashboard-common/src/features/settings/components/formatEnvValueForDotfile.test.ts
- */
-import { test, expect, describe } from "vitest";
-import * as dotenv from "dotenv";
-import { formatEnvValueForDotfile } from "./formatEnvValueForDotfile.js";
-
-/**
- * Attempts a round-trip: format the value for dotenv, then parse it back.
- */
-function roundTrip(
-  originalValue: string,
-  name = "TEST_VAR",
-): {
-  success: boolean;
-  parsedValue: string | undefined;
-  formatted: string;
-  warning: string | undefined;
-  envFileContent: string;
-} {
-  const { formatted, warning } = formatEnvValueForDotfile(originalValue);
-  const envFileContent = `${name}=${formatted}`;
-  const parsed = dotenv.parse(envFileContent);
-  const parsedValue = parsed[name];
-  const success = parsedValue === originalValue;
-  return { success, parsedValue, formatted, warning, envFileContent };
-}
-
-/** Values that should round-trip successfully through formatEnvValueForDotfile -> dotenv.parse */
-const ROUND_TRIP_CASES: [string, string][] = [
-  // Basic values
-  ["simple string", "hello"],
-  ["string with spaces", "hello world"],
-  ["empty string", ""],
-  ["numeric string", "12345"],
-
-  // Newlines
-  ["newline", "first\nsecond"],
-  ["newline with trailing", "line1\nline2\n"],
-  ["multiple newlines", "line1\nline2\nline3"],
-  ["only newlines", "\n\n\n"],
-  ["newline + single quotes", "first's\nsecond's"],
-  ["newline + literal \\n", "first\\n\nsec\\nond"],
-
-  // Quotes
-  ["wrapped in single quotes", "'single'"],
-  ["wrapped in double quotes", '"double"'],
-  ["nested quotes: single containing double", "'single \"and\" double'"],
-  ["nested quotes: double containing single", "\"double 'and' single\""],
-  ["single quote in middle", "it's a test"],
-  ["double quote in middle", 'say "hello"'],
-  ["starts with single quote", "'starts"],
-  ["ends with single quote", "ends'"],
-  ["starts with double quote", '"starts'],
-  ["ends with double quote", 'ends"'],
-  ["both quote types", 'it\'s a "test"'],
-  ["both quote types + newline", 'it\'s a "test"\nline2'],
-
-  // Hash/comment character
-  ["hash in middle", "before # after"],
-  ["hash + newlines", "first # after\nsecond # after"],
-  ["hash at start", "#hashtag"],
-  ["hash + single quote", "before#'after'"],
-  ["hash + double quote", 'before#"after"'],
-  ["hash + newline + single quote", "first # 'after'\nsecond # 'after'"],
-
-  // Tabs and whitespace
-  ["tab", "hello\tworld"],
-  ["whitespace padding + newline", "  both  \n  sides  "],
-
-  // Control characters
-  ["formfeed", "\f"],
-  ["vertical tab", "\v"],
-  ["escape char", "\x1b"],
-  ["bell", "\x07"],
-  ["DEL", "\x7f"],
-  ["ANSI color sequence", "\x1b[31mred?\x1b[0m"],
-  ["null byte", "before\x00after"],
-  ["mixed control bytes", "\x01\x02\x03ABC\x7f\x1b"],
-
-  // Backticks
-  ["backticks wrapping", "`command`"],
-  ["backticks in middle", "run `command` here"],
-
-  // Backslashes
-  ["backslash path", "path\\to\\file"],
-  ["literal \\n", "hello\\nworld"],
-  ["literal \\n + single quote", "it's\\nhello"],
-  ["literal escape sequences", "backslash: \\n \\t \\r \\0 \\x41"],
-
-  // Dollar signs
-  ["dollar sign variable", "$HOME/path"],
-  ["dollar sign braces", "${HOME}/path"],
-
-  // Equals sign
-  ["equals in value", "key=value=extra"],
-
-  // Unicode
-  ["unicode", "hello 世界 🌍"],
-  ["emoji", "🎉🎊🎁"],
-
-  // JSON
-  ["JSON object", '{"key": "value", "nested": {"a": 1}}'],
-  ["JSON multiline", '{\n  "pretty": true,\n  "indent": 2\n}\n'],
-  ["JSON with \\n in string", '{"multiline":"line1\\nline2"}'],
-
-  // Config formats
-  ["INI format", "key=value\nother=two\n"],
-  ["YAML", 'a: 1\nb: "two"\nc:\n  - x\n  - y\n'],
-
-  // Real-world
-  [
-    "PEM private key",
-    "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASC\n-----END PRIVATE KEY-----",
-  ],
-  ["URL with hash anchor", "https://example.com/path?key=value&foo=bar#anchor"],
-  ["URL with encoded chars", "redis://:p%40ss@127.0.0.1:6379/0"],
-  ["base64", "SGVsbG8gV29ybGQh"],
-  [
-    "JWT",
-    "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U",
-  ],
-  ["SQL with quotes", "SELECT * FROM users WHERE name = 'John' AND age > 18"],
-  ["regex", "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"],
-];
-
-/**
- * Known limitations - these cannot round-trip due to dotenv parser constraints.
- * Format: [name, value, reason]
- */
-const KNOWN_FAILURES: [string, string, string][] = [
-  // Carriage returns - dotenv strips \r
-  ["CRLF", "line1\r\nline2", "dotenv strips \\r"],
-  ["CR only", "classicmac\rline2\r", "dotenv strips \\r"],
-  ["CRLF multi-line", "windows\r\nline2\r\n", "dotenv strips \\r"],
-  ["mixed \\n\\t\\r", "escapes:\n\t\r", "dotenv strips \\r"],
-
-  // Impossible quoting scenarios
-  [
-    "newline + literal \\n + single quote",
-    "it's\\n\nsec\\nond",
-    "conflicting escape requirements",
-  ],
-  [
-    "hash + newline + both quotes",
-    "first # 'after'\nsecond # \"after\"",
-    "no quoting strategy protects hash with both quote types",
-  ],
-  [
-    "hash + literal \\n + single quote",
-    "value # 'test'\\n",
-    "single quotes needed for \\n but break on inner quotes",
-  ],
-];
-
-describe("formatEnvValueForDotfile", () => {
-  describe("round-trip tests", () => {
-    describe("values that round-trip", () => {
-      test.each(ROUND_TRIP_CASES)("%s", (_, value) => {
-        expect(roundTrip(value).success).toBe(true);
-      });
-    });
-
-    describe("known limitations", () => {
-      test.each(KNOWN_FAILURES)("%s (%s)", (_, value) => {
-        expect(roundTrip(value).success).toBe(false);
-      });
-    });
-  });
-
-  describe("formatted output", () => {
-    test("newline uses single quotes", () => {
-      expect(roundTrip("first\nsecond").formatted).toBe("'first\nsecond'");
-    });
-
-    test("newline + single quotes uses double quotes with escaped newlines", () => {
-      expect(roundTrip("first's\nsecond's").formatted).toBe(
-        "\"first's\\nsecond's\"",
-      );
-    });
-
-    test("wrapped single quotes uses double quote wrapper", () => {
-      expect(roundTrip("'single'").formatted).toBe("\"'single'\"");
-    });
-
-    test("wrapped double quotes uses single quote wrapper", () => {
-      expect(roundTrip('"double"').formatted).toBe("'\"double\"'");
-    });
-
-    test("hash uses single quotes", () => {
-      expect(roundTrip("before # after").formatted).toBe("'before # after'");
-    });
-
-    test("hash + single quote uses double quotes", () => {
-      expect(roundTrip("before#'after'").formatted).toBe("\"before#'after'\"");
-    });
-  });
-
-  describe("warnings", () => {
-    test("no warning for simple hash", () => {
-      expect(roundTrip("api_key # secret").warning).toBeUndefined();
-    });
-
-    test("warns about newline + single quotes + literal \\n", () => {
-      expect(formatEnvValueForDotfile("it's\ncomplex\\n").warning).toContain(
-        "may not round-trip",
-      );
-    });
-
-    test("warns about unprotectable hash", () => {
-      expect(
-        formatEnvValueForDotfile("first # 'a'\nsecond # \"b\"").warning,
-      ).toContain("#");
-    });
-
-    test("warns about carriage return", () => {
-      expect(formatEnvValueForDotfile("line1\r\nline2").warning).toContain(
-        "carriage return",
-      );
-    });
-  });
-
-  describe("permutation matrix", () => {
-    interface Flags {
-      newline: boolean;
-      hash: boolean;
-      slashN: boolean;
-      single: boolean;
-      double: boolean;
-    }
-
-    const build = (f: Flags): string => {
-      let v = "value";
-      if (f.newline) v += "\n";
-      if (f.hash) v += " # comment";
-      if (f.slashN) v += "\\n";
-      if (f.single) v += "'q'";
-      if (f.double) v += '"q"';
-      return v;
-    };
-
-    const describe_ = (f: Flags): string => {
-      const p: string[] = [];
-      if (f.newline) p.push("newline");
-      if (f.hash) p.push("hash");
-      if (f.slashN) p.push("\\n");
-      if (f.single) p.push("'");
-      if (f.double) p.push('"');
-      return p.length ? p.join("+") : "plain";
-    };
-
-    // Patterns that cannot round-trip
-    const badPatterns: Partial<Flags>[] = [
-      { newline: true, slashN: true, single: true },
-      { hash: true, single: true, double: true },
-      { hash: true, slashN: true, single: true },
-    ];
-
-    const matches = (f: Flags, p: Partial<Flags>) =>
-      (!p.newline || f.newline) &&
-      (!p.hash || f.hash) &&
-      (!p.slashN || f.slashN) &&
-      (!p.single || f.single) &&
-      (!p.double || f.double);
-
-    const isBad = (f: Flags) => badPatterns.some((p) => matches(f, p));
-
-    const all: Flags[] = [];
-    for (let i = 0; i < 32; i++) {
-      all.push({
-        newline: !!(i & 1),
-        hash: !!(i & 2),
-        slashN: !!(i & 4),
-        single: !!(i & 8),
-        double: !!(i & 16),
-      });
-    }
-
-    describe("supported", () => {
-      test.each(all.filter((f) => !isBad(f)).map((f) => [describe_(f), f]))(
-        "%s",
-        (_, f) => expect(roundTrip(build(f as Flags)).success).toBe(true),
-      );
-    });
-
-    describe("unsupported", () => {
-      test.each(all.filter(isBad).map((f) => [describe_(f), f]))("%s", (_, f) =>
-        expect(roundTrip(build(f as Flags)).success).toBe(false),
-      );
-    });
-  });
-});

package/src/cli/lib/formatTargetedDeployment.test.ts

@@ -1,281 +0,0 @@
-import { afterAll, beforeAll, describe, expect, test } from "vitest";
-import { Chalk } from "chalk";
-import { formatTargetedDeployment } from "./announceDeploymentTarget.js";
-import type { DetailedDeploymentCredentials } from "./api.js";
-
-const chalk = new Chalk({ level: 3 });
-
-function creds(
-  overrides: Partial<DetailedDeploymentCredentials> & {
-    fields?: Partial<
-      NonNullable<DetailedDeploymentCredentials["deploymentFields"]>
-    > | null;
-  } = {},
-): DetailedDeploymentCredentials {
-  const { fields, ...rest } = overrides;
-  // Explicit `fields: null` clears the deployment fields entirely (the
-  // self-hosted / `--url+--admin-key` case). Otherwise merge with defaults.
-  const deploymentFields =
-    fields === null
-      ? null
-      : {
-          deploymentName: "happy-animal-123",
-          deploymentType: "dev" as const,
-          teamSlug: "my-team",
-          projectSlug: "my-project",
-          reference: null,
-          isDefault: false,
-          ...fields,
-        };
-  return {
-    adminKey: "test-admin-key",
-    url: "https://happy-animal-123.convex.cloud",
-    deploymentFields,
-    ...rest,
-  };
-}
-
-describe("formatTargetedDeployment", () => {
-  let originalIsTTY = process.stderr.isTTY;
-  beforeAll(() => {
-    process.stderr.isTTY = true;
-  });
-  afterAll(() => {
-    process.stderr.isTTY = originalIsTTY;
-  });
-
-  describe("standard terminal", () => {
-    test("default dev deployment shows reference and (dev) alias", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "dev",
-              reference: "dev/nicolas",
-              isDefault: true,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("non-default dev deployment shows reference without alias", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "dev",
-              reference: "dev/staging-test",
-              isDefault: false,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("default prod deployment shows reference and (prod) alias", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "prod",
-              reference: "production",
-              isDefault: true,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("non-default prod deployment shows reference without alias", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "prod",
-              reference: "prod-shadow",
-              isDefault: false,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("preview deployment with team and project", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "preview",
-              deploymentName: "happy-otter-123",
-              reference: "preview/pr-42",
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("preview deployment without a reference falls back to deploymentName", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "preview",
-              deploymentName: "happy-otter-123",
-              reference: null,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("custom deployment with team and project", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            fields: {
-              deploymentType: "custom",
-              deploymentName: "playful-otter-999",
-              reference: "my-staging-shadow",
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("dev deployment without team/project slugs", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({ fields: { teamSlug: null, projectSlug: null } }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("local deployment with team and project", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            url: "http://127.0.0.1:3210",
-            fields: {
-              deploymentType: "local",
-              deploymentName: "local",
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("local deployment without team/project slugs", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            url: "http://127.0.0.1:3210",
-            fields: {
-              deploymentType: "local",
-              deploymentName: "local",
-              teamSlug: null,
-              projectSlug: null,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("anonymous deployment", () => {
-      expect(
-        formatTargetedDeployment(
-          null,
-          creds({
-            url: "http://127.0.0.1:3210",
-            fields: {
-              deploymentType: "anonymous",
-              deploymentName: "anonymous",
-              teamSlug: null,
-              projectSlug: null,
-            },
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("self-hosted deployment", () => {
-      expect(
-        formatTargetedDeployment(
-          "Deploying code to deployment:",
-          creds({
-            url: "https://convex.my-company.com",
-            fields: null,
-          }),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-  });
-
-  describe("every header value", () => {
-    test("no header (used after logFinishedStep)", () => {
-      expect(formatTargetedDeployment(null, creds(), chalk)).toMatchSnapshot();
-    });
-
-    test("dev", () => {
-      expect(
-        formatTargetedDeployment(
-          "Developing against deployment:",
-          creds(),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-
-    test("logs", () => {
-      expect(
-        formatTargetedDeployment("Showing logs of deployment:", creds(), chalk),
-      ).toMatchSnapshot();
-    });
-
-    test("deploy", () => {
-      expect(
-        formatTargetedDeployment(
-          "Deploying code to deployment:",
-          creds(),
-          chalk,
-        ),
-      ).toMatchSnapshot();
-    });
-  });
-
-  describe("terminals with partial feature support", () => {
-    test("without colors", () => {
-      expect(
-        formatTargetedDeployment(null, creds(), new Chalk({ level: 0 })),
-      ).toMatchSnapshot();
-    });
-
-    test("without link support", () => {
-      process.stderr.isTTY = false;
-
-      expect(formatTargetedDeployment(null, creds(), chalk)).toMatchSnapshot();
-    });
-  });
-});

package/src/cli/lib/fsUtils.test.ts

@@ -1,67 +0,0 @@
-import { test, expect, describe, beforeEach, afterEach } from "vitest";
-import { oneoffContext, Context } from "../../bundler/context.js";
-import fs from "fs";
-import os from "os";
-import path from "path";
-import { recursivelyDelete } from "./fsUtils.js";
-
-describe("fsUtils", async () => {
-  let tmpDir: string;
-  let ctx: Context;
-
-  beforeEach(async () => {
-    ctx = await oneoffContext({
-      url: undefined,
-      adminKey: undefined,
-      envFile: undefined,
-    });
-    tmpDir = fs.mkdtempSync(`${os.tmpdir()}${path.sep}`);
-  });
-
-  describe("recursivelyDelete", () => {
-    test("deletes file", () => {
-      const file = path.join(tmpDir, "file");
-      ctx.fs.writeUtf8File(file, "contents");
-      expect(ctx.fs.exists(file)).toBe(true);
-
-      recursivelyDelete(ctx, file);
-      expect(ctx.fs.exists(file)).toBe(false);
-    });
-
-    test("throws an error on non-existent file", () => {
-      const nonexistentFile = path.join(tmpDir, "nonexistent_file");
-      expect(() => {
-        recursivelyDelete(ctx, nonexistentFile);
-      }).toThrow("ENOENT: no such file or directory");
-    });
-
-    test("does not throw error if `force` is used", () => {
-      const nonexistentFile = path.join(tmpDir, "nonexistent_file");
-      recursivelyDelete(ctx, nonexistentFile, { force: true });
-    });
-
-    test("recursively deletes a directory", () => {
-      const dir = path.join(tmpDir, "dir");
-      ctx.fs.mkdir(dir);
-      const nestedFile = path.join(dir, "nested_file");
-      ctx.fs.writeUtf8File(nestedFile, "content");
-      const nestedDir = path.join(dir, "nested_dir");
-      ctx.fs.mkdir(nestedDir);
-
-      expect(ctx.fs.exists(dir)).toBe(true);
-
-      recursivelyDelete(ctx, dir);
-      expect(ctx.fs.exists(dir)).toBe(false);
-    });
-
-    test("`recursive` and `force` work together", () => {
-      const nonexistentDir = path.join(tmpDir, "nonexistent_dir");
-      // Shouldn't throw an exception.
-      recursivelyDelete(ctx, nonexistentDir, { force: true });
-    });
-  });
-
-  afterEach(() => {
-    fs.rmSync(tmpDir, { recursive: true });
-  });
-});