Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix(import): resolve renamed workflow column names

Tine890b474c29a
diff --git a/apps/api/src/column/controllers/create-column.ts b/apps/api/src/column/controllers/create-column.ts
index 35be40e35..1e620d0ce 100644
--- a/apps/api/src/column/controllers/create-column.ts
+++ b/apps/api/src/column/controllers/create-column.ts
@@ -1,3 +1,4 @@
+import { toSlug } from "../to-slug";
import { publishEvent } from "../../events";
import { eq, sql } from "drizzle-orm";
import { HTTPException } from "hono/http-exception";
@@ -5,17 +6,6 @@ import db from "../../database";
import { columnTable } from "../../database/schema";
import { VIRTUAL_STATUSES } from "../../task/validate-task-fields";
-export function toSlug(name: string): string {
- const slug = name
- .normalize("NFKC")
- .toLowerCase()
- .trim()
- .replace(/[^\p{L}\p{M}\p{N}]+/gu, "-")
- .replace(/^-+|-+$/g, "");
-
- return /[\p{L}\p{N}]/u.test(slug) ? slug : "";
-}
-
async function createColumn({
projectId,
name,
diff --git a/apps/api/src/column/to-slug.ts b/apps/api/src/column/to-slug.ts
new file mode 100644
index 000000000..966b980ef
--- /dev/null
+++ b/apps/api/src/column/to-slug.ts
@@ -0,0 +1,10 @@
+export function toSlug(name: string): string {
+ const slug = name
+ .normalize("NFKC")
+ .toLowerCase()
+ .trim()
+ .replace(/[^\p{L}\p{M}\p{N}]+/gu, "-")
+ .replace(/^-+|-+$/g, "");
+
+ return /[\p{L}\p{N}]/u.test(slug) ? slug : "";
+}
diff --git a/apps/api/src/import/writer/plan-import-columns.ts b/apps/api/src/import/writer/plan-import-columns.ts
index c515ae0bf..74535af95 100644
--- a/apps/api/src/import/writer/plan-import-columns.ts
+++ b/apps/api/src/import/writer/plan-import-columns.ts
@@ -1,5 +1,5 @@
import type { ImportedColumn } from "@kaneo/importers";
-import { toSlug } from "../../column/controllers/create-column";
+import { toSlug } from "../../column/to-slug";
import { VIRTUAL_STATUSES } from "../../task/validate-task-fields";
export type PlannedImportColumn = {
diff --git a/apps/api/src/task/controllers/import-tasks.ts b/apps/api/src/task/controllers/import-tasks.ts
index 507b1a795..5e381d392 100644
--- a/apps/api/src/task/controllers/import-tasks.ts
+++ b/apps/api/src/task/controllers/import-tasks.ts
@@ -1,4 +1,4 @@
-import { and, eq } from "drizzle-orm";
+import { asc, eq } from "drizzle-orm";
import { HTTPException } from "hono/http-exception";
import db from "../../database";
import { columnTable, projectTable, taskTable } from "../../database/schema";
@@ -9,11 +9,8 @@ import {
NO_PROJECT_ACCESS,
NOT_ASSIGNABLE,
} from "../../utils/assert-assignable-user";
-import {
- coercePriority,
- coerceStatus,
- getValidTaskStatuses,
-} from "../validate-task-fields";
+import { coercePriority } from "../validate-task-fields";
+import { resolveImportTaskStatus } from "../resolve-import-task-status";
import { claimTaskNumber } from "./claim-task-numbers";
import { nextTaskPosition } from "./next-task-position";
@@ -59,7 +56,10 @@ async function importTasks(
projectId,
);
- const validStatuses = await getValidTaskStatuses(projectId);
+ const columns = await db.query.columnTable.findMany({
+ where: eq(columnTable.projectId, projectId),
+ orderBy: asc(columnTable.position),
+ });
const results = [];
@@ -76,21 +76,18 @@ async function importTasks(
}
try {
- const { status, warning: statusWarning } = coerceStatus(
- taskData.status,
- validStatuses,
- );
+ const resolved = resolveImportTaskStatus(taskData.status, columns);
+ if ("error" in resolved) {
+ results.push({ success: false, error: resolved.error, task: taskData });
+ continue;
+ }
+ const { status, warning: statusWarning } = resolved;
const { priority, warning: priorityWarning } = coercePriority(
taskData.priority || "low",
);
const warnings = [statusWarning, priorityWarning].filter(Boolean);
- const column = await db.query.columnTable.findFirst({
- where: and(
- eq(columnTable.projectId, projectId),
- eq(columnTable.slug, status),
- ),
- });
+ const column = columns.find((candidate) => candidate.slug === status);
const createdTask = await db.transaction(async (tx) => {
const taskNumber = await claimTaskNumber(projectId, tx);
diff --git a/apps/api/src/task/resolve-import-task-status.test.ts b/apps/api/src/task/resolve-import-task-status.test.ts
new file mode 100644
index 000000000..3fb693361
--- /dev/null
+++ b/apps/api/src/task/resolve-import-task-status.test.ts
@@ -0,0 +1,49 @@
+import { describe, expect, it } from "vite-plus/test";
+import { resolveImportTaskStatus } from "./resolve-import-task-status";
+
+const columns = [
+ { slug: "to-do", name: "Ready to Start" },
+ { slug: "done", name: "Fertig ✨" },
+];
+
+describe("resolveImportTaskStatus", () => {
+ it.each(["Ready to Start", "ready-to-start", " READY TO START "])(
+ "resolves the renamed column %s to its stored slug",
+ (status) =>
+ expect(resolveImportTaskStatus(status, columns)).toEqual({
+ status: "to-do",
+ }),
+ );
+ it("preserves stored slugs and virtual statuses", () => {
+ for (const status of ["to-do", "done", "planned", "archived"]) {
+ expect(resolveImportTaskStatus(status, columns)).toEqual({ status });
+ }
+ });
+ it("supports non-English column names", () => {
+ expect(resolveImportTaskStatus("FERTIG", columns)).toEqual({
+ status: "done",
+ });
+ });
+ it("prefers an exact slug over another column's display name", () => {
+ expect(
+ resolveImportTaskStatus("to-do", [
+ ...columns,
+ { slug: "other", name: "To Do" },
+ ]),
+ ).toEqual({ status: "to-do" });
+ });
+ it("rejects ambiguous display names", () => {
+ expect(
+ resolveImportTaskStatus("ready-to-start", [
+ ...columns,
+ { slug: "other", name: "Ready to start" },
+ ]),
+ ).toHaveProperty("error");
+ });
+ it("retains the warning and backlog fallback for unknown statuses", () => {
+ expect(resolveImportTaskStatus("missing", columns)).toEqual({
+ status: "planned",
+ warning: 'Unknown status "missing" mapped to "planned"',
+ });
+ });
+});
diff --git a/apps/api/src/task/resolve-import-task-status.ts b/apps/api/src/task/resolve-import-task-status.ts
new file mode 100644
index 000000000..b8581620d
--- /dev/null
+++ b/apps/api/src/task/resolve-import-task-status.ts
@@ -0,0 +1,27 @@
+import { toSlug } from "../column/to-slug";
+import { coerceStatus, VIRTUAL_STATUSES } from "./validate-task-fields";
+
+export function resolveImportTaskStatus(
+ status: string,
+ columns: { slug: string; name: string }[],
+): { status: string; warning?: string } | { error: string } {
+ const validStatuses = [
+ ...columns.map((column) => column.slug),
+ ...VIRTUAL_STATUSES,
+ ];
+ // Persisted slugs and virtual statuses take precedence over display names.
+ if (validStatuses.includes(status)) return { status };
+
+ const alias = toSlug(status);
+ const matches = alias
+ ? columns.filter((column) => toSlug(column.name) === alias)
+ : [];
+ const [match] = matches;
+ if (matches.length === 1 && match) return { status: match.slug };
+ if (matches.length > 1) {
+ return {
+ error: `Ambiguous status "${status}". Use the column's stored slug.`,
+ };
+ }
+ return coerceStatus(status, validStatuses);
+}
diff --git a/apps/api/src/task/schema.ts b/apps/api/src/task/schema.ts
index 7bea11e0e..dfeda0626 100644
--- a/apps/api/src/task/schema.ts
+++ b/apps/api/src/task/schema.ts
@@ -114,7 +114,10 @@ export const importTasksBody = z.object({
z.object({
title: z.string(),
description: z.string().optional(),
- status: z.string(),
+ status: z.string().openapi({
+ description:
+ "Column slug, current column name, or slugified current name. Unknown values map to planned with a warning; ambiguous names fail the task import.",
+ }),
priority: z.string().optional(),
startDate: z.string().nullable().optional(),
dueDate: z.string().nullable().optional(),
diff --git a/apps/docs/openapi.json b/apps/docs/openapi.json
index 8907e27be..7f2b0270e 100644
--- a/apps/docs/openapi.json
+++ b/apps/docs/openapi.json
@@ -12085,7 +12085,8 @@
"type": "string"
},
"status": {
- "type": "string"
+ "type": "string",
+ "description": "Column slug, current column name, or slugified current name. Unknown values map to planned with a warning; ambiguous names fail the task import."
},
"priority": {
"type": "string"
diff --git a/tests/api-integration/task-import-status.test.ts b/tests/api-integration/task-import-status.test.ts
new file mode 100644
index 000000000..8d2537163
--- /dev/null
+++ b/tests/api-integration/task-import-status.test.ts
@@ -0,0 +1,62 @@
+import { eq } from "drizzle-orm";
+import { beforeEach, describe, expect, it } from "vite-plus/test";
+import db, { schema } from "../../apps/api/src/database";
+import { createApp } from "../../apps/api/src/index";
+import updateColumn from "../../apps/api/src/column/controllers/update-column";
+import { mockAuthenticatedSession } from "./helpers/auth";
+import { resetTestDatabase } from "./helpers/database";
+import {
+ createProjectFixture,
+ createWorkspaceMember,
+} from "./helpers/fixtures";
+
+beforeEach(resetTestDatabase);
+
+describe("JSON imports after column renames", () => {
+ it("accepts the renamed name and its slug while retaining stored status identities", async () => {
+ const { user, workspace } = await createWorkspaceMember({ role: "owner" });
+ const { project, columns } = await createProjectFixture({
+ workspaceId: workspace.id,
+ });
+ await updateColumn(columns.todo.id, { name: "Ready to Start" });
+ mockAuthenticatedSession(user);
+ const { app } = createApp();
+ const response = await app.request(`/api/task/import/${project.id}`, {
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({
+ tasks: [
+ "Ready to Start",
+ "ready-to-start",
+ "to-do",
+ "planned",
+ "unknown",
+ ].map((status) => ({ title: status, status })),
+ }),
+ });
+ expect(response.status).toBe(200);
+ const body = await response.json();
+ expect(body.results.successful).toBe(5);
+ const imported = await db
+ .select()
+ .from(schema.taskTable)
+ .where(eq(schema.taskTable.projectId, project.id));
+ for (const title of ["Ready to Start", "ready-to-start", "to-do"]) {
+ expect(imported.find((task) => task.title === title)).toMatchObject({
+ status: "to-do",
+ columnId: columns.todo.id,
+ });
+ }
+ for (const title of ["planned", "unknown"]) {
+ expect(imported.find((task) => task.title === title)).toMatchObject({
+ status: "planned",
+ columnId: null,
+ });
+ }
+ expect(
+ body.results.tasks.find(
+ (entry: { task: { title: string } }) => entry.task.title === "unknown",
+ ).warnings,
+ ).toEqual(['Unknown status "unknown" mapped to "planned"']);
+ });
+});
diff --git a/tests/api/column/to-slug.test.ts b/tests/api/column/to-slug.test.ts
index 89d46d916..e26fba2cf 100644
--- a/tests/api/column/to-slug.test.ts
+++ b/tests/api/column/to-slug.test.ts
@@ -1,5 +1,5 @@
import { describe, expect, it } from "vite-plus/test";
-import { toSlug } from "../../../apps/api/src/column/controllers/create-column";
+import { toSlug } from "../../../apps/api/src/column/to-slug";
describe("toSlug", () => {
it("slugifies Latin names", () => {