windmill-cli 1.641.0 → 1.643.0

package/esm/src/commands/instance/instance.js

@@ -1,586 +0,0 @@
-import * as dntShim from "../../../_dnt.shims.js";
-import { Command, Confirm, path, Select, setClient, Table, yamlParseFile, yamlStringify, } from "../../../deps.js";
-import * as wmill from "../../../gen/services.gen.js";
-import { colors, Input, log } from "../../../deps.js";
-import { loginInteractive } from "../../core/login.js";
-import { getActiveInstanceFilePath, getInstancesConfigFilePath, } from "../../../windmill-utils-internal/src/config/config.js";
-import { pull, push } from "../sync/sync.js";
-import { showDiff } from "../../types.js";
-import { pullInstanceGroups, pullInstanceUsers, pushInstanceGroups, pushInstanceUsers, } from "../user/user.js";
-import { add as workspaceSetup, addWorkspace, removeWorkspace, setActiveWorkspace, } from "../workspace/workspace.js";
-import { pullInstanceConfigs, pullInstanceSettings, pushInstanceConfigs, pushInstanceSettings, } from "../../core/settings.js";
-import { deepEqual } from "../../utils/utils.js";
-import { getActiveWorkspace } from "../workspace/workspace.js";
-export async function allInstances() {
-    try {
-        const file = await getInstancesConfigFilePath();
-        const txt = await dntShim.Deno.readTextFile(file);
-        return txt
-            .split("\n")
-            .map((line) => {
-            if (line.length <= 2) {
-                return;
-            }
-            const instance = JSON.parse(line);
-            return instance;
-        })
-            .filter(Boolean);
-    }
-    catch (_) {
-        return [];
-    }
-}
-export async function addInstance(opts, instanceName, remote, token) {
-    if (!remote) {
-        remote = await Input.prompt({
-            message: "Enter the remote url of this instance",
-            default: "https://my.windmill.dev/",
-        });
-        remote = new URL(remote).toString(); // add trailing slash in all cases!
-    }
-    if (!instanceName) {
-        const defaultName = new URL(remote).hostname.split(".")[0];
-        instanceName = await Input.prompt({
-            message: "Enter a name for this instance",
-            default: defaultName,
-        });
-    }
-    const prefix = instanceName.toLowerCase().replace(/[^a-z0-9]/g, "");
-    while (!token) {
-        token = await loginInteractive(remote);
-    }
-    await appendInstance({
-        name: instanceName,
-        remote,
-        token,
-        prefix,
-    });
-    log.info(colors.green.underline(`Added instance ${instanceName} with remote ${remote}!`));
-    await switchI({}, instanceName);
-    return {
-        name: instanceName,
-        remote,
-        token,
-        prefix,
-    };
-}
-async function appendInstance(instance) {
-    instance.remote = new URL(instance.remote).toString(); // add trailing slash in all cases!
-    await removeInstance(instance.name);
-    const file = await dntShim.Deno.open(await getInstancesConfigFilePath(), {
-        append: true,
-        write: true,
-        read: true,
-        create: true,
-    });
-    await file.write(new TextEncoder().encode(JSON.stringify(instance) + "\n"));
-    file.close();
-}
-async function removeInstance(name) {
-    const orgWorkspaces = await allInstances();
-    await dntShim.Deno.writeTextFile(await getInstancesConfigFilePath(), orgWorkspaces
-        .filter((x) => x.name !== name)
-        .map((x) => JSON.stringify(x))
-        .join("\n") + "\n");
-}
-export function compareInstanceObjects(fromObjects, toObjects, idProp, objectName) {
-    let changes = 0;
-    for (const toObject of toObjects) {
-        const fromMatch = fromObjects.find((u) => u[idProp] === toObject[idProp]);
-        if (!fromMatch) {
-            log.info(colors.red(`- instance ${objectName} ${toObject[idProp]}`));
-            changes += 1;
-        }
-        else if (!deepEqual(toObject, fromMatch)) {
-            log.info(colors.yellow(`~ instance ${objectName} ${toObject[idProp]}`));
-            showDiff(yamlStringify(toObject), yamlStringify(fromMatch));
-            changes += 1;
-        }
-    }
-    for (const fromObject of fromObjects) {
-        const toMatch = toObjects.find((u) => u[idProp] === fromObject[idProp]);
-        if (!toMatch) {
-            log.info(colors.green(`+ instance ${objectName} ${fromObject[idProp]}`));
-            changes += 1;
-        }
-    }
-    return changes;
-}
-export async function pickInstance(opts, allowNew) {
-    const instances = await allInstances();
-    if (opts.baseUrl && opts.token && opts.instance) {
-        log.info("Using instance defined by --instance, --base-url and --token");
-        setClient(opts.token, opts.baseUrl.endsWith("/") ? opts.baseUrl.slice(0, -1) : opts.baseUrl);
-        return {
-            name: opts.instance,
-            remote: opts.baseUrl,
-            token: opts.token,
-            prefix: opts.prefix ?? opts.instance,
-        };
-    }
-    if (opts.baseUrl && opts.token) {
-        log.info("Using instance fully defined by --base-url and --token");
-        setClient(opts.token, opts.baseUrl.endsWith("/") ? opts.baseUrl.slice(0, -1) : opts.baseUrl);
-        return {
-            name: "custom",
-            remote: opts.baseUrl,
-            token: opts.token,
-            prefix: opts.prefix ?? "custom",
-        };
-    }
-    if (!allowNew && instances.length < 1) {
-        throw new Error("No instance found, please add one first");
-    }
-    const instanceName = await getActiveInstance(opts);
-    let instance = instances.find((i) => i.name === instanceName);
-    if (!instance) {
-        if (instances.length < 1) {
-            instance = await addInstance({}, undefined, undefined, undefined);
-        }
-        else {
-            const choice = (await Select.prompt({
-                message: "Select an instance",
-                options: [
-                    ...instances.map((i) => ({
-                        name: `${i.name} (${i.remote})`,
-                        value: i.name,
-                    })),
-                    { name: "Add new instance", value: "new" },
-                ],
-            }));
-            if (choice === "new") {
-                instance = await addInstance({}, undefined, undefined, undefined);
-            }
-            else {
-                instance = instances.find((i) => i.name === choice);
-            }
-        }
-    }
-    else {
-        log.info(`Selected instance: ${instance.name}`);
-    }
-    setClient(instance.token, instance.remote.slice(0, instance.remote.length - 1));
-    return instance;
-}
-async function instancePull(opts) {
-    const instance = await pickInstance(opts, true);
-    log.info("Pulling instance-level changes");
-    log.info(`remote (${instance.name}) -> local`);
-    opts.prefix = opts.prefix ?? instance.prefix;
-    let uChanges = 0;
-    if (!opts.skipUsers) {
-        uChanges = (await pullInstanceUsers(opts, true));
-    }
-    let sChanges = 0;
-    if (!opts.skipSettings) {
-        sChanges = (await pullInstanceSettings(opts, true));
-    }
-    let cChanges = 0;
-    if (!opts.skipConfigs) {
-        cChanges = (await pullInstanceConfigs(opts, true));
-    }
-    let gChanges = 0;
-    if (!opts.skipGroups) {
-        gChanges = (await pullInstanceGroups(opts, true));
-    }
-    const totalChanges = uChanges + sChanges + cChanges + gChanges;
-    const rootDir = dntShim.Deno.cwd();
-    if (totalChanges > 0) {
-        let confirm = true;
-        if (opts.dryRun) {
-            log.info(colors.gray(`Dry run complete.`));
-            return;
-        }
-        if (opts.yes !== true) {
-            confirm = await Confirm.prompt({
-                message: `Do you want to pull these ${totalChanges} instance-level changes?`,
-                default: true,
-            });
-        }
-        if (confirm) {
-            if (uChanges > 0) {
-                if (opts.folderPerInstance && opts.prefixSettings) {
-                    await dntShim.Deno.mkdir(path.join(rootDir, opts.prefix), {
-                        recursive: true,
-                    });
-                }
-            }
-            if (!opts.skipUsers && uChanges > 0) {
-                await pullInstanceUsers(opts);
-            }
-            if (!opts.skipSettings && sChanges > 0) {
-                await pullInstanceSettings(opts);
-            }
-            if (!opts.skipConfigs && cChanges > 0) {
-                await pullInstanceConfigs(opts);
-            }
-            if (!opts.skipGroups && gChanges > 0) {
-                await pullInstanceGroups(opts);
-            }
-        }
-    }
-    else {
-        log.info("No instance-level changes to apply");
-    }
-    if (opts.includeWorkspaces) {
-        log.info("\nPulling all workspaces");
-        const localWorkspaces = await getLocalWorkspaces(rootDir, instance.prefix, opts.folderPerInstance);
-        const previousActiveWorkspace = await getActiveWorkspace(undefined);
-        const remoteWorkspaces = await wmill.listWorkspacesAsSuperAdmin({
-            page: 1,
-            perPage: 1000,
-        });
-        for (const remoteWorkspace of remoteWorkspaces) {
-            log.info("\nPulling workspace " + remoteWorkspace.id);
-            const workspaceName = opts?.folderPerInstance
-                ? instance.prefix + "/" + remoteWorkspace.id
-                : instance.prefix + "_" + remoteWorkspace.id;
-            await dntShim.Deno.mkdir(path.join(rootDir, workspaceName), {
-                recursive: true,
-            });
-            await dntShim.Deno.chdir(path.join(rootDir, workspaceName));
-            await addWorkspace({
-                remote: instance.remote,
-                name: workspaceName,
-                workspaceId: remoteWorkspace.id,
-                token: instance.token,
-            }, {
-                token: undefined,
-                workspace: undefined,
-            });
-            await pull({
-                workspace: workspaceName,
-                token: undefined,
-                baseUrl: undefined,
-                configDir: undefined,
-                includeGroups: true,
-                includeSchedules: true,
-                includeTriggers: true,
-                includeSettings: true,
-                includeUsers: true,
-                includeKey: true,
-                yes: opts.yes,
-                dryRun: opts.dryRun,
-            });
-        }
-        const localWorkspacesToDelete = localWorkspaces.filter((w) => !remoteWorkspaces.find((r) => r.id === w.id));
-        if (localWorkspacesToDelete.length > 0) {
-            const confirmDelete = opts.yes ||
-                (await Confirm.prompt({
-                    message: "Do you want to delete the local copy of workspaces that don't exist anymore on the instance?\n" +
-                        localWorkspacesToDelete.map((w) => w).join(", "),
-                    default: true,
-                }));
-            if (confirmDelete) {
-                for (const workspace of localWorkspacesToDelete) {
-                    await removeWorkspace(workspace.id, false, {});
-                    await dntShim.Deno.remove(path.join(rootDir, workspace.dir), {
-                        recursive: true,
-                    });
-                }
-            }
-        }
-        if (previousActiveWorkspace) {
-            await setActiveWorkspace(previousActiveWorkspace?.name);
-        }
-        log.info(colors.green.underline.bold("All workspaces pulled"));
-    }
-}
-async function instancePush(opts) {
-    let instances = await allInstances();
-    const instance = await pickInstance(opts, true);
-    log.info("Pushing instance-level changes");
-    log.info(`remote (${instance.name}) <- local`);
-    let uChanges = 0;
-    if (!opts.skipUsers) {
-        uChanges = (await pushInstanceUsers(opts, true));
-    }
-    let sChanges = 0;
-    if (!opts.skipSettings) {
-        sChanges = (await pushInstanceSettings(opts, true));
-    }
-    let cChanges = 0;
-    if (!opts.skipConfigs) {
-        cChanges = (await pushInstanceConfigs(opts, true));
-    }
-    let gChanges = 0;
-    if (!opts.skipGroups) {
-        gChanges = (await pushInstanceGroups(opts, true));
-    }
-    const totalChanges = uChanges + sChanges + cChanges + gChanges;
-    if (totalChanges > 0) {
-        let confirm = true;
-        if (opts.yes !== true) {
-            confirm = await Confirm.prompt({
-                message: `Do you want to apply these ${totalChanges} instance-level changes?`,
-                default: true,
-            });
-        }
-        if (confirm) {
-            if (!opts.skipUsers && uChanges > 0) {
-                await pushInstanceUsers(opts);
-            }
-            if (!opts.skipSettings && sChanges > 0) {
-                await pushInstanceSettings(opts);
-            }
-            if (!opts.skipConfigs && cChanges > 0) {
-                await pushInstanceConfigs(opts);
-            }
-            if (!opts.skipGroups && gChanges > 0) {
-                await pushInstanceGroups(opts);
-            }
-        }
-    }
-    else {
-        log.info("No instance-level changes to apply");
-    }
-    if (opts.includeWorkspaces) {
-        instances = await allInstances();
-        const rootDir = dntShim.Deno.cwd();
-        let localPrefix;
-        if (opts.prefix) {
-            localPrefix = opts.prefix;
-        }
-        else {
-            localPrefix = (await Select.prompt({
-                message: "What is the prefix of the local workspaces you want to sync?",
-                options: [
-                    ...instances.map((i) => ({
-                        name: `${i.prefix} (${i.name} - ${i.remote})`,
-                        value: i.prefix,
-                    })),
-                ],
-                default: instance.prefix,
-            }));
-        }
-        const remoteWorkspaces = await wmill.listWorkspacesAsSuperAdmin({
-            page: 1,
-            perPage: 1000,
-        });
-        const previousActiveWorkspace = await getActiveWorkspace(undefined);
-        const localWorkspaces = await getLocalWorkspaces(rootDir, localPrefix, opts.folderPerInstance);
-        log.info(`\nPushing all workspaces: ${localWorkspaces.map((x) => x.id).join(", ")}`);
-        for (const localWorkspace of localWorkspaces) {
-            log.info("\nPushing workspace " + localWorkspace.id);
-            try {
-                await dntShim.Deno.chdir(path.join(rootDir, localWorkspace.dir));
-            }
-            catch (_) {
-                throw new Error("Workspace folder not found, are you in the right directory?");
-            }
-            try {
-                const workspaceSettings = (await yamlParseFile(path.join(dntShim.Deno.cwd(), "settings.yaml")));
-                await workspaceSetup({
-                    token: instance.token,
-                    workspace: undefined,
-                    baseUrl: undefined,
-                    configDir: undefined,
-                    create: true,
-                    createWorkspaceName: workspaceSettings.name,
-                    createUsername: undefined,
-                }, localWorkspace.dir, localWorkspace.id, instance.remote);
-            }
-            catch (e) {
-                log.error(`Settings file not found in workspace ${localWorkspace.id} or error setting up workspace ${e.message}, skipping`);
-                continue;
-            }
-            await push({
-                workspace: localWorkspace.dir,
-                token: undefined,
-                baseUrl: undefined,
-                configDir: undefined,
-                includeGroups: true,
-                includeSchedules: true,
-                includeTriggers: true,
-                includeSettings: true,
-                includeUsers: true,
-                includeKey: true,
-                yes: opts.yes,
-                dryRun: opts.dryRun,
-            });
-        }
-        const workspacesToDelete = remoteWorkspaces.filter((w) => !localWorkspaces.find((l) => l.id === w.id));
-        if (workspacesToDelete.length > 0) {
-            const confirmDelete = opts.yes ||
-                (await Confirm.prompt({
-                    message: "Do you want to delete the following remote workspaces that don't exist locally?\n" +
-                        workspacesToDelete.map((w) => w.id).join(", "),
-                    default: true,
-                }));
-            if (confirmDelete) {
-                for (const workspace of workspacesToDelete) {
-                    await wmill.deleteWorkspace({ workspace: workspace.id });
-                    log.info(colors.green.underline("Deleted workspace " + workspace.id));
-                }
-            }
-        }
-        if (previousActiveWorkspace) {
-            await setActiveWorkspace(previousActiveWorkspace?.name);
-        }
-        log.info(colors.green.underline.bold("All workspaces pushed"));
-    }
-}
-async function getLocalWorkspaces(rootDir, localPrefix, folderPerInstance) {
-    const localWorkspaces = [];
-    if (!(await dntShim.Deno.stat(localPrefix).catch(() => null))) {
-        await dntShim.Deno.mkdir(localPrefix);
-    }
-    if (folderPerInstance) {
-        for await (const dir of dntShim.Deno.readDir(rootDir + "/" + localPrefix)) {
-            if (dir.isDirectory) {
-                const dirName = dir.name;
-                localWorkspaces.push({
-                    dir: localPrefix + "/" + dirName,
-                    id: dirName,
-                });
-            }
-        }
-    }
-    else {
-        for await (const dir of dntShim.Deno.readDir(rootDir)) {
-            const dirName = dir.name;
-            if (dirName.startsWith(localPrefix + "_")) {
-                localWorkspaces.push({
-                    dir: dirName,
-                    id: dirName.substring(localPrefix.length + 1),
-                });
-            }
-        }
-    }
-    log.info("Local workspaces found: " + localWorkspaces.map((x) => x.id).join(", "));
-    return localWorkspaces;
-}
-async function switchI(opts, instanceName) {
-    const all = await allInstances();
-    if (all.findIndex((x) => x.name === instanceName) === -1) {
-        log.info(colors.red.bold(`! This instance ${instanceName} does not exist locally.`));
-        log.info("available instances:");
-        for (const w of all) {
-            log.info("  - " + w.name);
-        }
-        return;
-    }
-    await dntShim.Deno.writeTextFile(await getActiveInstanceFilePath(), instanceName);
-    log.info(colors.green.underline(`Switched to instance ${instanceName}`));
-}
-export async function getActiveInstance(opts) {
-    if (opts.instance) {
-        return opts.instance;
-    }
-    try {
-        return await dntShim.Deno.readTextFile(await getActiveInstanceFilePath());
-    }
-    catch {
-        return undefined;
-    }
-}
-async function getConfig(opts) {
-    await pickInstance(opts, false);
-    const config = await wmill.getInstanceConfig();
-    const yaml = yamlStringify(config);
-    if (opts.outputFile) {
-        await dntShim.Deno.writeTextFile(opts.outputFile, yaml);
-        log.info(colors.green(`Instance config written to ${opts.outputFile}`));
-    }
-    else {
-        console.log(yaml);
-    }
-}
-async function whoami(opts) {
-    await pickInstance({}, false);
-    try {
-        const whoamiInfo = await wmill.globalWhoami();
-        log.info(colors.green.underline(`global whoami infos:`));
-        log.info(JSON.stringify(whoamiInfo, null, 2));
-    }
-    catch (error) {
-        log.error(
-        //@ts-ignore
-        colors.red(`Failed to retrieve whoami information: ${error.message}`));
-    }
-}
-const command = new Command()
-    .description("sync local with a remote instance or the opposite (push or pull)")
-    .action(async () => {
-    log.info("4 actions available, add, remove, switch, pull and push. Use -h to display help.");
-    const activeInstance = await getActiveInstance({});
-    new Table()
-        .header(["name", "remote", "token"])
-        .padding(2)
-        .border(true)
-        .body((await allInstances()).map((x) => [
-        x.name === activeInstance ? colors.underline(x.name) : x.name,
-        x.remote,
-        x.token.substring(0, 7) + "***",
-    ]))
-        .render();
-    if (activeInstance) {
-        log.info(`Selected instance: ${activeInstance}`);
-    }
-    else {
-        log.info("No active instance selected");
-    }
-    log.info("Use 'wmill instance add' to add a new instance");
-})
-    .command("add")
-    .description("Add a new instance")
-    .action(addInstance)
-    .arguments("[instance_name:string] [remote:string] [token:string]")
-    .command("remove")
-    .description("Remove an instance")
-    .complete("instance", async () => (await allInstances()).map((x) => x.name))
-    .arguments("<instance:string:instance>")
-    .action(async (instance) => {
-    const instances = await allInstances();
-    const choice = (await Select.prompt({
-        message: "Select an instance to remove",
-        options: instances.map((i) => ({
-            name: `${i.name} (${i.remote})`,
-            value: i.name,
-        })),
-    }));
-    await removeInstance(choice);
-    log.info(colors.green.underline(`Removed instance ${choice}`));
-})
-    .command("switch")
-    .complete("instance", async () => (await allInstances()).map((x) => x.name))
-    .arguments("<instance:string:instance>")
-    .description("Switch the current instance")
-    .action(switchI)
-    .command("pull")
-    .description("Pull instance settings, users, configs, instance groups and overwrite local")
-    .option("--yes", "Pull without needing confirmation")
-    .option("--dry-run", "Perform a dry run without making changes")
-    .option("--skip-users", "Skip pulling users")
-    .option("--skip-settings", "Skip pulling settings")
-    .option("--skip-configs", "Skip pulling configs (worker groups and SMTP)")
-    .option("--skip-groups", "Skip pulling instance groups")
-    .option("--include-workspaces", "Also pull workspaces")
-    .option("--folder-per-instance", "Create a folder per instance")
-    .option("--instance <instance:string>", "Name of the instance to pull from, override the active instance")
-    .option("--prefix <prefix:string>", "Prefix of the local workspaces to pull, used to create the folders when using --include-workspaces")
-    .option("--prefix-settings", "Store instance yamls inside prefixed folders when using --prefix and --folder-per-instance")
-    .action(instancePull)
-    .command("push")
-    .description("Push instance settings, users, configs, group and overwrite remote")
-    .option("--yes", "Push without needing confirmation")
-    .option("--dry-run", "Perform a dry run without making changes")
-    .option("--skip-users", "Skip pushing users")
-    .option("--skip-settings", "Skip pushing settings")
-    .option("--skip-configs", "Skip pushing configs (worker groups and SMTP)")
-    .option("--skip-groups", "Skip pushing instance groups")
-    .option("--include-workspaces", "Also push workspaces")
-    .option("--folder-per-instance", "Create a folder per instance")
-    .option("--instance <instance:string>", "Name of the instance to push to, override the active instance")
-    .option("--prefix <prefix:string>", "Prefix of the local workspaces folders to push")
-    .option("--prefix-settings", "Store instance yamls inside prefixed folders when using --prefix and --folder-per-instance")
-    .action(instancePush)
-    .command("whoami")
-    .description("Display information about the currently logged-in user")
-    .action(whoami)
-    .command("get-config")
-    .description("Dump the current instance config (global settings + worker configs) as YAML")
-    .option("-o, --output-file <file:string>", "Write YAML to a file instead of stdout")
-    .option("--instance <instance:string>", "Name of the instance, override the active instance")
-    .action(getConfig);
-export default command;