sb-mig 6.0.0-beta.3 → 6.0.0-beta.4

package/dist/api/data-migration/component-data-migration.js

@@ -9,6 +9,7 @@ import { isObjectEmpty } from "../../utils/object-utils.js";
 import { managementApi } from "../managementApi.js";
 import { buildPreMigrationBackupBaseName, resolveOutputFileBaseName, shouldUseDatestampForArtifacts, } from "./file-naming.js";
 import { extendMigrationMapperWithAliases, resolveMigrationComponentsToMigrate, } from "./migration-component-scope.js";
+import { saveMigrationRunLog } from "./migration-run-log.js";
 import { discoverMigrationValidatorForMigrationFile, MigrationValidationFailedError, runPreparedMigrationValidator, } from "./migration-validation.js";
 import { summarizeMutationWriteResults } from "./write-summary.js";
 export const normalizeMigrationConfigNames = (migrationConfig) => {
@@ -507,6 +508,25 @@ export const doTheMigration = async ({ itemType = "story", from, itemsToMigrate,
         }, config);
     }
     const writeSummary = summarizeMutationWriteResults(writeResults);
+    try {
+        await saveMigrationRunLog({
+            artifactBaseName,
+            useDatestamp,
+            from,
+            to,
+            itemType,
+            dryRun,
+            publish,
+            migrateFrom,
+            fromFilePath,
+            pipelineResult,
+            writeResults,
+            writeSummary,
+        }, config);
+    }
+    catch (error) {
+        Logger.warning(`[MIGRATION] Could not write migration run log: ${error instanceof Error ? error.message : String(error)}`);
+    }
     if (writeSummary.failed === 0) {
         Logger.success(`[MIGRATION] Update complete. ${writeSummary.successful}/${writeSummary.total} ${itemType}(s) updated successfully.`);
         return;

package/dist/api/data-migration/migration-run-log.d.ts

@@ -0,0 +1,64 @@
+import type { MigrateFrom, MigrationPipelineResult } from "./component-data-migration.js";
+import type { MutationWriteResult, MutationWriteSummary } from "./write-summary.js";
+import type { RequestBaseConfig } from "../utils/request.js";
+type MigrationRunLogEvent = "update_success" | "update_failed" | "migration_write_summary";
+export interface MigrationRunLogRecord {
+    timestamp: string;
+    event: MigrationRunLogEvent;
+    runId: string;
+    itemType: "story" | "preset";
+    source: {
+        migrateFrom: MigrateFrom;
+        from: string;
+        fromFilePath: string | null;
+    };
+    target: {
+        to: string;
+    };
+    writeMode: "publish" | "save";
+    dryRun: boolean;
+    migrationConfigs: string[];
+    totalItems: number;
+    totalChangedItems: number;
+    writeSummary?: {
+        total: number;
+        successful: number;
+        failed: number;
+        failedItems: Array<{
+            id?: number | string;
+            name?: string;
+            slug?: string;
+            spaceId?: string;
+            status?: number | string;
+            response?: string | null;
+        }>;
+    };
+    item?: {
+        index: number;
+        id?: number | string;
+        name?: string;
+        slug?: string;
+        spaceId?: string;
+    };
+    status?: number | string | null;
+    response?: string | null;
+    error?: unknown;
+}
+interface SaveMigrationRunLogArgs {
+    artifactBaseName: string;
+    useDatestamp: boolean;
+    from: string;
+    to: string;
+    itemType: "story" | "preset";
+    dryRun?: boolean;
+    publish?: boolean;
+    migrateFrom: MigrateFrom;
+    fromFilePath?: string;
+    pipelineResult: MigrationPipelineResult;
+    writeResults: PromiseSettledResult<MutationWriteResult>[];
+    writeSummary: MutationWriteSummary;
+}
+export declare const buildMigrationRunLogRecords: ({ from, to, itemType, dryRun, publish, migrateFrom, fromFilePath, pipelineResult, writeResults, writeSummary, }: Omit<SaveMigrationRunLogArgs, "artifactBaseName" | "useDatestamp">) => MigrationRunLogRecord[];
+export declare const recordsToJsonl: (records: MigrationRunLogRecord[]) => string;
+export declare const saveMigrationRunLog: (args: SaveMigrationRunLogArgs, config: RequestBaseConfig) => Promise<void>;
+export {};

package/dist/api/data-migration/migration-run-log.js

@@ -0,0 +1,109 @@
+import { generateDatestamp } from "../../utils/date-utils.js";
+import { createDir, createJsonFile } from "../../utils/files.js";
+import Logger from "../../utils/logger.js";
+const serializeError = (error) => {
+    if (!error) {
+        return null;
+    }
+    if (error instanceof Error) {
+        return {
+            name: error.name,
+            message: error.message,
+            stack: error.stack,
+        };
+    }
+    try {
+        return JSON.parse(JSON.stringify(error));
+    }
+    catch {
+        return String(error);
+    }
+};
+const resolveChangedItemPayload = (item) => item?.story || item;
+const resolveWriteResultValue = (result) => {
+    if (result.status === "fulfilled") {
+        return (result.value || {
+            ok: false,
+        });
+    }
+    return {
+        ok: false,
+        error: result.reason,
+    };
+};
+export const buildMigrationRunLogRecords = ({ from, to, itemType, dryRun, publish, migrateFrom, fromFilePath, pipelineResult, writeResults, writeSummary, }) => {
+    const timestamp = new Date().toISOString();
+    const runId = `${itemType}-${timestamp}`;
+    const baseRecord = {
+        timestamp,
+        runId,
+        itemType,
+        source: {
+            migrateFrom,
+            from,
+            fromFilePath: fromFilePath || null,
+        },
+        target: {
+            to,
+        },
+        writeMode: itemType === "story" && publish ? "publish" : "save",
+        dryRun: Boolean(dryRun),
+        migrationConfigs: pipelineResult.stepReports.map((step) => step.migrationConfig),
+        totalItems: pipelineResult.totalItems,
+        totalChangedItems: pipelineResult.changedItems.length,
+    };
+    const updateRecords = writeResults.map((result, index) => {
+        const value = resolveWriteResultValue(result);
+        const changedItem = resolveChangedItemPayload(pipelineResult.changedItems[index]);
+        const event = value.ok
+            ? "update_success"
+            : "update_failed";
+        return {
+            ...baseRecord,
+            event,
+            item: {
+                index,
+                id: value.id || changedItem?.id,
+                name: value.name || changedItem?.name,
+                slug: value.slug ||
+                    changedItem?.full_slug ||
+                    changedItem?.slug,
+                spaceId: value.spaceId || to,
+            },
+            status: value.status || null,
+            response: value.response || null,
+            ...(value.ok ? {} : { error: serializeError(value.error) }),
+        };
+    });
+    const summaryRecord = {
+        ...baseRecord,
+        event: "migration_write_summary",
+        writeSummary: {
+            total: writeSummary.total,
+            successful: writeSummary.successful,
+            failed: writeSummary.failed,
+            failedItems: writeSummary.failedItems.map((item) => ({
+                id: item.id,
+                name: item.name,
+                slug: item.slug,
+                spaceId: item.spaceId,
+                status: item.status,
+                response: item.response || null,
+            })),
+        },
+    };
+    return [...updateRecords, summaryRecord];
+};
+export const recordsToJsonl = (records) => `${records.map((record) => JSON.stringify(record)).join("\n")}\n`;
+export const saveMigrationRunLog = async (args, config) => {
+    const { sbmigWorkingDirectory } = config;
+    const { artifactBaseName, useDatestamp, itemType, dryRun } = args;
+    const timestamp = generateDatestamp(new Date());
+    const finalFilename = `${dryRun ? "dry-run--" : ""}${artifactBaseName}---${itemType}-migration-run-log${useDatestamp ? `__${timestamp}` : ""}.jsonl`;
+    const folderPath = `${sbmigWorkingDirectory}/migrations/`;
+    const fullPath = `${folderPath}${finalFilename}`;
+    const records = buildMigrationRunLogRecords(args);
+    await createDir(folderPath);
+    await createJsonFile(recordsToJsonl(records), fullPath);
+    Logger.success(`Migration run log written to a file:  ${fullPath}`);
+};

package/dist/api/data-migration/write-summary.d.ts

@@ -3,6 +3,9 @@ export interface MutationWriteResult {
     id?: number | string;
     name?: string;
     slug?: string;
+    spaceId?: string;
+    status?: number | string;
+    response?: string | null;
     error?: unknown;
 }
 export interface MutationWriteSummary {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sb-mig",
-  "version": "6.0.0-beta.3",
+  "version": "6.0.0-beta.4",
   "description": "CLI to rule the world. (and handle stuff related to Storyblok CMS)",
   "author": "Marcin Krawczyk <marckraw@icloud.com>",
   "license": "MIT",