swallowkit 1.0.0-beta.3 → 1.0.0-beta.31

package/src/__tests__/dev-seeds.test.ts

@@ -0,0 +1,173 @@
+import * as fs from "fs";
+import * as os from "os";
+import * as path from "path";
+import { createBasicModelInfo } from "./fixtures";
+import {
+  buildDefaultCosmosDatabaseName,
+  buildSeedTemplateDocument,
+  getContainerNameForModel,
+  loadDevSeedFiles,
+  normalizeSeedIdentifier,
+  parseCosmosConnectionString,
+  parseSeedDocuments,
+  prepareSeedDocumentsForExport,
+  resolveLocalCosmosConnectionInfo,
+} from "../cli/commands/dev-seeds";
+
+describe("dev seed helpers", () => {
+  const originalCwd = process.cwd();
+  let tempDir: string;
+
+  beforeEach(() => {
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "swallowkit-dev-seeds-"));
+    process.chdir(tempDir);
+  });
+
+  afterEach(() => {
+    process.chdir(originalCwd);
+    fs.rmSync(tempDir, { recursive: true, force: true });
+  });
+
+  it("builds Cosmos container names from model names", () => {
+    expect(getContainerNameForModel(createBasicModelInfo())).toBe("Todos");
+  });
+
+  it("normalizes seed identifiers across common naming styles", () => {
+    expect(normalizeSeedIdentifier("todo-items")).toBe("todoitems");
+    expect(normalizeSeedIdentifier("Todo_Items")).toBe("todoitems");
+    expect(normalizeSeedIdentifier("todoSchema")).toBe("todoschema");
+  });
+
+  it("wraps a single JSON object into a document array", () => {
+    expect(parseSeedDocuments('{"id":"todo-001","title":"Hello"}', "todo.json")).toEqual([
+      { id: "todo-001", title: "Hello" },
+    ]);
+  });
+
+  it("builds default Cosmos database names from package names", () => {
+    expect(buildDefaultCosmosDatabaseName("swallowkit")).toBe("SwallowkitDatabase");
+  });
+
+  it("parses Cosmos DB connection strings", () => {
+    expect(parseCosmosConnectionString("AccountEndpoint=https://localhost:8081/;AccountKey=test-key==;")).toEqual({
+      endpoint: "https://localhost:8081/",
+      key: "test-key==",
+    });
+  });
+
+  it("loads matching seed files for an environment", async () => {
+    const seedsDir = path.join(tempDir, "dev-seeds", "local");
+    fs.mkdirSync(seedsDir, { recursive: true });
+    fs.writeFileSync(
+      path.join(seedsDir, "todo.json"),
+      JSON.stringify([{ id: "todo-001", title: "First task" }], null, 2),
+      "utf-8"
+    );
+    fs.writeFileSync(
+      path.join(seedsDir, "ignored.json"),
+      JSON.stringify([{ id: "ignored-001" }], null, 2),
+      "utf-8"
+    );
+
+    const loaded = await loadDevSeedFiles("local", [createBasicModelInfo()]);
+
+    expect(loaded).toHaveLength(1);
+    expect(loaded[0]).toMatchObject({
+      containerName: "Todos",
+      documents: [{ id: "todo-001", title: "First task" }],
+    });
+  });
+
+  it("rejects seed documents without ids", async () => {
+    const seedsDir = path.join(tempDir, "dev-seeds", "local");
+    fs.mkdirSync(seedsDir, { recursive: true });
+    fs.writeFileSync(path.join(seedsDir, "todo.json"), JSON.stringify([{ title: "Missing id" }], null, 2), "utf-8");
+
+    await expect(loadDevSeedFiles("local", [createBasicModelInfo()])).rejects.toThrow(/non-empty string id/);
+  });
+
+  it("reads local Cosmos DB settings from local.settings.json", () => {
+    const functionsDir = path.join(tempDir, "functions");
+    fs.mkdirSync(functionsDir, { recursive: true });
+    fs.writeFileSync(
+      path.join(functionsDir, "local.settings.json"),
+      JSON.stringify(
+        {
+          Values: {
+            CosmosDBConnection: "AccountEndpoint=https://localhost:8081/;AccountKey=test-key==;",
+            COSMOS_DB_DATABASE_NAME: "CustomDatabase",
+          },
+        },
+        null,
+        2
+      ),
+      "utf-8"
+    );
+
+    const result = resolveLocalCosmosConnectionInfo("FallbackDatabase", functionsDir);
+
+    expect(result).toEqual({
+      ok: true,
+      value: {
+        endpoint: "https://localhost:8081/",
+        key: "test-key==",
+        databaseName: "CustomDatabase",
+        localSettingsPath: path.join(functionsDir, "local.settings.json"),
+      },
+    });
+  });
+
+  it("prepares exported seed documents by removing Cosmos metadata and sorting ids", () => {
+    expect(
+      prepareSeedDocumentsForExport(
+        [
+          { id: "todo-002", title: "Second", _etag: "etag-2", _ts: 2 },
+          { id: "todo-001", title: "First", _rid: "rid-1", _self: "self-1" },
+        ],
+        "todo.json"
+      )
+    ).toEqual([
+      { id: "todo-001", title: "First" },
+      { id: "todo-002", title: "Second" },
+    ]);
+  });
+
+  it("builds nested template documents from related schemas", () => {
+    const category = createBasicModelInfo({
+      name: "Category",
+      displayName: "Category",
+      schemaName: "categorySchema",
+      filePath: "/models/category.ts",
+      fields: [
+        { name: "id", type: "string", isOptional: false, isArray: false },
+        { name: "name", type: "string", isOptional: false, isArray: false },
+      ],
+      hasCreatedAt: false,
+      hasUpdatedAt: false,
+    });
+    const todo = createBasicModelInfo({
+      fields: [
+        { name: "id", type: "string", isOptional: false, isArray: false },
+        { name: "title", type: "string", isOptional: false, isArray: false },
+        {
+          name: "category",
+          type: "object",
+          isOptional: true,
+          isArray: false,
+          isNestedSchema: true,
+          nestedModelName: "Category",
+          nestedSchemaName: "categorySchema",
+        },
+      ],
+    });
+
+    expect(buildSeedTemplateDocument(todo, [todo, category])).toEqual({
+      id: "todo-001",
+      title: "todo-title-sample",
+      category: {
+        id: "category-001",
+        name: "category-name-sample",
+      },
+    });
+  });
+});

package/src/__tests__/dev.test.ts

@@ -0,0 +1,252 @@
+import * as http from "http";
+import { readFileSync } from "fs";
+import * as path from "path";
+import {
+  buildFunctionsBaseUrl,
+  buildFunctionsStartArgs,
+  buildFunctionsCoreToolsCommand,
+  buildNextDevArgs,
+  buildDevCommand,
+  buildPythonFunctionsEnv,
+  compareVersionNumbers,
+  DevOptions,
+  getFunctionsReadinessTimeoutMs,
+  getCSharpFunctionsBuildArtifactPaths,
+  getPythonVirtualEnvPaths,
+  parseCoreToolsVersion,
+  waitForHttpServerReady,
+} from "../cli/commands/dev";
+import { CLI_VERSION, createProgram, normalizeDevCommandArgv } from "../cli/index";
+
+const packageVersion = JSON.parse(
+  readFileSync(path.resolve(__dirname, "../../package.json"), "utf8")
+).version as string;
+
+describe("dev command helpers", () => {
+  it("keeps the CLI version in sync with package.json", () => {
+    expect(CLI_VERSION).toBe(packageVersion);
+  });
+
+  it("passes the requested port to Azure Functions Core Tools", () => {
+    expect(buildFunctionsStartArgs("7076")).toEqual(["start", "--port", "7076"]);
+  });
+
+  it("parses the Core Tools version from CLI output", () => {
+    expect(parseCoreToolsVersion("4.6.0+ab90faafcab539d63cd3d0ce5faf1bca4395fccc")).toBe("4.6.0");
+  });
+
+  it("compares Core Tools versions numerically", () => {
+    expect(compareVersionNumbers("4.0.5198", "4.6.0")).toBeLessThan(0);
+    expect(compareVersionNumbers("4.6.0", "4.6.0")).toBe(0);
+    expect(compareVersionNumbers("4.10.0", "4.6.0")).toBeGreaterThan(0);
+  });
+
+  it("falls back to npm Core Tools for older C# isolated hosts", () => {
+    expect(buildFunctionsCoreToolsCommand("csharp", "4.0.5198")).toEqual({
+      command: "npm",
+      argsPrefix: ["exec", "--yes", "azure-functions-core-tools@4", "--"],
+      label: "npm exec azure-functions-core-tools@4 (installed func 4.0.5198 is too old for C# isolated)",
+    });
+  });
+
+  it("keeps the installed func command for supported Core Tools versions", () => {
+    expect(buildFunctionsCoreToolsCommand("csharp", "4.6.0")).toEqual({
+      command: "func",
+      argsPrefix: [],
+      label: "func 4.6.0",
+    });
+  });
+
+  it("uses webpack mode for npm-based Next.js dev", () => {
+    expect(buildNextDevArgs("npm", "3012")).toEqual(["next", "dev", "--port", "3012", "--webpack"]);
+  });
+
+  it("uses pnpm exec for pnpm-based Next.js dev", () => {
+    expect(buildNextDevArgs("pnpm", "3012")).toEqual(["exec", "next", "dev", "--port", "3012", "--webpack"]);
+  });
+
+  it("builds the Azure Functions base URL from host and port", () => {
+    expect(buildFunctionsBaseUrl(undefined, "7071")).toBe("http://localhost:7071");
+    expect(buildFunctionsBaseUrl("127.0.0.1", "7072")).toBe("http://127.0.0.1:7072");
+  });
+
+  it("gives C# more startup time before reporting readiness timeout", () => {
+    expect(getFunctionsReadinessTimeoutMs("csharp")).toBeGreaterThan(getFunctionsReadinessTimeoutMs("typescript"));
+    expect(getFunctionsReadinessTimeoutMs("csharp")).toBeGreaterThan(getFunctionsReadinessTimeoutMs("python"));
+  });
+
+  it("waits until an HTTP server responds before reporting ready", async () => {
+    const server = http.createServer((_request, response) => {
+      response.writeHead(404);
+      response.end("not found");
+    });
+
+    await new Promise<void>((resolve) => {
+      server.listen(0, "127.0.0.1", () => resolve());
+    });
+
+    const address = server.address();
+    if (!address || typeof address === "string") {
+      throw new Error("Failed to determine ephemeral port.");
+    }
+
+    try {
+      await expect(
+        waitForHttpServerReady(`http://127.0.0.1:${address.port}`, 2_000, 50)
+      ).resolves.toBe(true);
+    } finally {
+      await new Promise<void>((resolve, reject) => {
+        server.close((error) => {
+          if (error) {
+            reject(error);
+            return;
+          }
+          resolve();
+        });
+      });
+    }
+  });
+
+  it("builds Python virtual environment paths under functions/.venv", () => {
+    const functionsDir = path.join("C:\\repo", "functions");
+    const paths = getPythonVirtualEnvPaths(functionsDir);
+
+    expect(paths.venvDir).toBe(path.join(functionsDir, ".venv"));
+    expect(paths.binDir.endsWith(process.platform === "win32" ? path.join(".venv", "Scripts") : path.join(".venv", "bin"))).toBe(true);
+    expect(paths.pythonExecutable.endsWith(process.platform === "win32" ? path.join("Scripts", "python.exe") : path.join("bin", "python"))).toBe(true);
+  });
+
+  it("targets C# bin and obj directories for build cleanup", () => {
+    const functionsDir = path.join("C:\\repo", "functions");
+
+    expect(getCSharpFunctionsBuildArtifactPaths(functionsDir)).toEqual([
+      path.join(functionsDir, "bin"),
+      path.join(functionsDir, "obj"),
+    ]);
+  });
+
+  it("injects Python virtual environment settings for Functions", () => {
+    const functionsDir = path.join("C:\\repo", "functions");
+    const env = buildPythonFunctionsEnv({ PATH: "C:\\Windows\\System32" }, functionsDir);
+    const expectedBinDir = getPythonVirtualEnvPaths(functionsDir).binDir;
+
+    expect(env.VIRTUAL_ENV).toBe(path.join(functionsDir, ".venv"));
+    expect(env.languageWorkers__python__defaultExecutablePath).toBe(
+      getPythonVirtualEnvPaths(functionsDir).pythonExecutable
+    );
+    expect(env.PATH?.startsWith(`${expectedBinDir}${path.delimiter}`)).toBe(true);
+  });
+});
+
+describe("dev CLI parser", () => {
+  async function parseDevOptions(argv: string[]): Promise<DevOptions> {
+    let capturedOptions: DevOptions | undefined;
+    const logSpy = jest.spyOn(console, "log").mockImplementation(() => undefined);
+    const program = createProgram(buildDevCommand(async (options) => {
+      capturedOptions = options;
+    }, () => undefined));
+
+    program.exitOverride();
+
+    try {
+      await program.parseAsync(normalizeDevCommandArgv(argv));
+    } finally {
+      logSpy.mockRestore();
+    }
+
+    expect(capturedOptions).toBeDefined();
+    return capturedOptions!;
+  }
+
+  it("normalizes dev options placed before the subcommand", () => {
+    expect(
+      normalizeDevCommandArgv([
+        "node",
+        "swallowkit",
+        "--seed-env",
+        "local",
+        "--mock-connectors",
+        "dev",
+        "--port",
+        "3001",
+      ])
+    ).toEqual([
+      "node",
+      "swallowkit",
+      "dev",
+      "--seed-env",
+      "local",
+      "--mock-connectors",
+      "--port",
+      "3001",
+    ]);
+  });
+
+  it("keeps non-dev commands unchanged", () => {
+    const argv = ["node", "swallowkit", "create-model", "dev", "--connector", "external"];
+    expect(normalizeDevCommandArgv(argv)).toEqual(argv);
+  });
+
+  it("parses the same dev options regardless of whether they appear before or after the subcommand", async () => {
+    const expected = {
+      port: "3001",
+      functionsPort: "7072",
+      host: "127.0.0.1",
+      open: true,
+      verbose: true,
+      noFunctions: true,
+      seedEnv: "local",
+      mockConnectors: true,
+    };
+
+    const optionsAfterCommand = await parseDevOptions([
+      "node",
+      "swallowkit",
+      "dev",
+      "--port",
+      "3001",
+      "--functions-port",
+      "7072",
+      "--host",
+      "127.0.0.1",
+      "--open",
+      "--verbose",
+      "--no-functions",
+      "--seed-env",
+      "local",
+      "--mock-connectors",
+    ]);
+
+    const optionsBeforeCommand = await parseDevOptions([
+      "node",
+      "swallowkit",
+      "--verbose",
+      "--host",
+      "127.0.0.1",
+      "--seed-env",
+      "local",
+      "--mock-connectors",
+      "--no-functions",
+      "--port",
+      "3001",
+      "--functions-port",
+      "7072",
+      "--open",
+      "dev",
+    ]);
+
+    expect(optionsAfterCommand).toMatchObject(expected);
+    expect(optionsBeforeCommand).toMatchObject(expected);
+    expect(optionsBeforeCommand).toMatchObject(optionsAfterCommand);
+  });
+
+  it("keeps Azure Functions enabled by default", async () => {
+    const options = await parseDevOptions([
+      "node",
+      "swallowkit",
+      "dev",
+    ]);
+
+    expect(options.noFunctions).toBe(false);
+  });
+});

package/src/__tests__/fixtures.ts

@@ -0,0 +1,144 @@
+import { ModelInfo } from "../core/scaffold/model-parser";
+
+/**
+ * テスト用の基本的な ModelInfo フィクスチャ
+ */
+export function createBasicModelInfo(overrides?: Partial<ModelInfo>): ModelInfo {
+  return {
+    name: "Todo",
+    displayName: "Todo",
+    schemaName: "todoSchema",
+    filePath: "/models/todo.ts",
+    fields: [
+      { name: "id", type: "string", isOptional: false, isArray: false },
+      { name: "title", type: "string", isOptional: false, isArray: false },
+      { name: "description", type: "string", isOptional: true, isArray: false },
+      { name: "completed", type: "boolean", isOptional: false, isArray: false },
+      { name: "createdAt", type: "string", isOptional: false, isArray: false },
+      { name: "updatedAt", type: "string", isOptional: false, isArray: false },
+    ],
+    hasId: true,
+    hasCreatedAt: true,
+    hasUpdatedAt: true,
+    nestedSchemaRefs: [],
+    partitionKey: '/id',
+    ...overrides,
+  };
+}
+
+/**
+ * RDB コネクタ (read-only) 付きの ModelInfo フィクスチャ
+ */
+export function createRdbConnectorModelInfo(overrides?: Partial<ModelInfo>): ModelInfo {
+  return createBasicModelInfo({
+    name: "User",
+    displayName: "User",
+    schemaName: "userSchema",
+    filePath: "/models/user.ts",
+    fields: [
+      { name: "id", type: "string", isOptional: false, isArray: false },
+      { name: "employeeCode", type: "string", isOptional: false, isArray: false },
+      { name: "name", type: "string", isOptional: false, isArray: false },
+      { name: "email", type: "string", isOptional: false, isArray: false },
+      { name: "department", type: "string", isOptional: true, isArray: false },
+      { name: "createdAt", type: "string", isOptional: true, isArray: false },
+      { name: "updatedAt", type: "string", isOptional: true, isArray: false },
+    ],
+    connectorConfig: {
+      connector: "mysql",
+      operations: ["getAll", "getById"],
+      table: "users",
+      idColumn: "id",
+    },
+    ...overrides,
+  });
+}
+
+/**
+ * API コネクタ (read-write) 付きの ModelInfo フィクスチャ
+ */
+export function createApiConnectorModelInfo(overrides?: Partial<ModelInfo>): ModelInfo {
+  return createBasicModelInfo({
+    name: "BacklogIssue",
+    displayName: "BacklogIssue",
+    schemaName: "backlogIssueSchema",
+    filePath: "/models/backlog-issue.ts",
+    fields: [
+      { name: "id", type: "string", isOptional: false, isArray: false },
+      { name: "projectId", type: "string", isOptional: false, isArray: false },
+      { name: "issueKey", type: "string", isOptional: false, isArray: false },
+      { name: "summary", type: "string", isOptional: false, isArray: false },
+      { name: "description", type: "string", isOptional: true, isArray: false },
+      { name: "createdAt", type: "string", isOptional: true, isArray: false },
+      { name: "updatedAt", type: "string", isOptional: true, isArray: false },
+    ],
+    connectorConfig: {
+      connector: "backlog",
+      operations: ["getAll", "getById", "create", "update"],
+      endpoints: {
+        getAll: "GET /issues",
+        getById: "GET /issues/{id}",
+        create: "POST /issues",
+        update: "PATCH /issues/{id}",
+      },
+    },
+    ...overrides,
+  });
+}
+
+/**
+ * 外部キーを含む ModelInfo フィクスチャ
+ */
+export function createModelInfoWithForeignKey(): ModelInfo {
+  return createBasicModelInfo({
+    name: "Task",
+    displayName: "Task",
+    schemaName: "taskSchema",
+    filePath: "/models/task.ts",
+    fields: [
+      { name: "id", type: "string", isOptional: false, isArray: false },
+      { name: "title", type: "string", isOptional: false, isArray: false },
+      {
+        name: "categoryId",
+        type: "string",
+        isOptional: false,
+        isArray: false,
+        isForeignKey: true,
+        referencedModel: "Category",
+      },
+      { name: "createdAt", type: "string", isOptional: false, isArray: false },
+      { name: "updatedAt", type: "string", isOptional: false, isArray: false },
+    ],
+  });
+}
+
+/**
+ * enum フィールドを含む ModelInfo フィクスチャ
+ */
+export function createModelInfoWithEnum(): ModelInfo {
+  return createBasicModelInfo({
+    name: "Issue",
+    displayName: "Issue",
+    schemaName: "issueSchema",
+    filePath: "/models/issue.ts",
+    fields: [
+      { name: "id", type: "string", isOptional: false, isArray: false },
+      { name: "title", type: "string", isOptional: false, isArray: false },
+      {
+        name: "status",
+        type: "string",
+        isOptional: false,
+        isArray: false,
+        enumValues: ["open", "in_progress", "closed"],
+      },
+      {
+        name: "priority",
+        type: "number",
+        isOptional: true,
+        isArray: false,
+      },
+      { name: "createdAt", type: "string", isOptional: false, isArray: false },
+      { name: "updatedAt", type: "string", isOptional: false, isArray: false },
+    ],
+  });
+}