windmill-cli 1.401.0 → 1.402.0

package/esm/gen/core/OpenAPI.js

@@ -32,7 +32,7 @@ export const OpenAPI = {
     PASSWORD: undefined,
     TOKEN: getEnv("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: '1.401.0',
+    VERSION: '1.402.0',
     WITH_CREDENTIALS: true,
     interceptors: {
         request: new Interceptors(),

package/esm/gen/services.gen.js

@@ -4510,6 +4510,24 @@ export const getDbClock = () => {
         url: '/jobs/db_clock'
     });
 };
+/**
+ * Count jobs by tag
+ * @param data The data for the request.
+ * @param data.horizonSecs Past Time horizon in seconds (when to start the count = now - horizon) (default is 3600)
+ * @param data.workspaceId Specific workspace ID to filter results (optional)
+ * @returns unknown Job counts by tag
+ * @throws ApiError
+ */
+export const countJobsByTag = (data = {}) => {
+    return __request(OpenAPI, {
+        method: 'GET',
+        url: '/jobs/completed/count_by_tag',
+        query: {
+            horizon_secs: data.horizonSecs,
+            workspace_id: data.workspaceId
+        }
+    });
+};
 /**
  * get job
  * @param data The data for the request.

package/esm/instance.js

@@ -1,5 +1,5 @@
 import * as dntShim from "./_dnt.shims.js";
-import { Select, path, Confirm, yamlStringify, yamlParse, Command, setClient, } from "./deps.js";
+import { Select, path, Confirm, yamlStringify, yamlParse, Command, setClient, Table, } from "./deps.js";
 import * as wmill from "./gen/services.gen.js";
 import { Input, colors, log } from "./deps.js";
 import { loginInteractive } from "./login.js";
@@ -29,31 +29,35 @@ export async function allInstances() {
         return [];
     }
 }
-export async function addInstance() {
-    let remote = await Input.prompt({
-        message: "Enter the remote url of this instance",
-        default: "https://app.windmill.dev/",
-    });
-    remote = new URL(remote).toString(); // add trailing slash in all cases!
-    const defaultName = new URL(remote).hostname;
-    const name = await Input.prompt({
-        message: "Enter a name for this instance",
-        default: defaultName,
-    });
-    const prefix = name.toLowerCase().replace(/[^a-z0-9]/g, "");
-    let token = undefined;
+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,
+        name: instanceName,
         remote,
         token,
         prefix,
     });
-    log.info(colors.green.underline(`Added instance ${name} with remote ${remote}!`));
+    log.info(colors.green.underline(`Added instance ${instanceName} with remote ${remote}!`));
+    await switchI({}, instanceName);
     return {
-        name,
+        name: instanceName,
         remote,
         token,
         prefix,
@@ -101,31 +105,53 @@ export function compareInstanceObjects(fromObjects, toObjects, idProp, objectNam
     }
     return changes;
 }
-async function instancePull(opts) {
+export async function pickInstance(opts, allowNew) {
     const instances = await allInstances();
-    let instance;
-    if (instances.length < 1) {
-        instance = await addInstance();
+    if (opts.baseUrl && opts.token) {
+        log.info("Using instance fully defined by --base-url and --token");
+        return {
+            name: "custom",
+            remote: opts.baseUrl,
+            token: opts.token,
+            prefix: "custom",
+        };
     }
-    else {
-        const choice = (await Select.prompt({
-            message: "Select an instance to pull from",
-            options: [
-                ...instances.map((i) => ({
-                    name: `${i.name} (${i.remote})`,
-                    value: i.name,
-                })),
-                { name: "Add new instance", value: "new" },
-            ],
-        }));
-        if (choice === "new") {
-            instance = await addInstance();
+    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 {
-            instance = instances.find((i) => i.name === choice);
+            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`);
     let uChanges = 0;
@@ -146,10 +172,13 @@ async function instancePull(opts) {
     }
     const totalChanges = uChanges + sChanges + cChanges + gChanges;
     if (totalChanges > 0) {
-        const confirm = await Confirm.prompt({
-            message: `Do you want to apply these ${totalChanges} instance-level changes?`,
-            default: true,
-        });
+        let confirm = true;
+        if (opts.yes !== true) {
+            confirm = await Confirm.prompt({
+                message: `Do you want to pull these ${totalChanges} instance-level changes?`,
+                default: true,
+            });
+        }
         if (confirm) {
             if (!opts.skipUsers && uChanges > 0) {
                 await pullInstanceUsers();
@@ -227,29 +256,7 @@ async function instancePull(opts) {
 }
 async function instancePush(opts) {
     let instances = await allInstances();
-    let instance;
-    if (instances.length < 1) {
-        instance = await addInstance();
-    }
-    else {
-        const choice = (await Select.prompt({
-            message: "Select an instance to push to",
-            options: [
-                ...instances.map((i) => ({
-                    name: `${i.name} (${i.remote})`,
-                    value: i.name,
-                })),
-                { name: "Add new instance", value: "new" },
-            ],
-        }));
-        if (choice === "new") {
-            instance = await addInstance();
-        }
-        else {
-            instance = instances.find((i) => i.name === choice);
-        }
-    }
-    setClient(instance.token, instance.remote.slice(0, instance.remote.length - 1));
+    const instance = await pickInstance(opts, true);
     log.info("Pushing instance-level changes");
     log.info(`remote (${instance.name}) <- local`);
     let uChanges = 0;
@@ -270,10 +277,13 @@ async function instancePush(opts) {
     }
     const totalChanges = uChanges + sChanges + cChanges + gChanges;
     if (totalChanges > 0) {
-        const confirm = await Confirm.prompt({
-            message: `Do you want to apply these ${totalChanges} instance-level changes?`,
-            default: true,
-        });
+        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();
@@ -365,11 +375,92 @@ async function instancePush(opts) {
         log.info(colors.green.underline.bold("All workspaces pushed"));
     }
 }
+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 getRootStore()) + "/activeInstance", 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 getRootStore()) + "/activeInstance");
+    }
+    catch {
+        return undefined;
+    }
+}
+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(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(() => log.info("2 actions available, pull and push. Use -h to display help."))
+    .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("--skip-users", "Skip pulling users")
     .option("--skip-settings", "Skip pulling settings")
     .option("--skip-configs", "Skip pulling configs (worker groups and SMTP)")
@@ -378,11 +469,16 @@ const command = new Command()
     .action(instancePull)
     .command("push")
     .description("Push instance settings, users, configs, group and overwrite remote")
+    .option("--yes", "Push without needing confirmation")
     .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("--base-url", "Base url to be passed to the instance settings instead of the local one")
-    .action(instancePush);
+    .option("--instance", "Name of the instance to push to, override the active instance")
+    .option("--base-url", "If used with --token, will be used as the base url for the instance")
+    .action(instancePush)
+    .command("whoami")
+    .description("Display information about the currently logged-in user")
+    .action(whoami);
 export default command;

package/esm/main.js

@@ -15,6 +15,7 @@ import folder from "./folder.js";
 import schedule from "./schedule.js";
 import sync from "./sync.js";
 import instance from "./instance.js";
+import workerGroups from "./worker_groups.js";
 import dev from "./dev.js";
 import { fetchVersion } from "./context.js";
 import { OpenAPI } from "./gen/index.js";
@@ -23,6 +24,8 @@ import { NpmProvider } from "./upgrade.js";
 import { pull as hubPull } from "./hub.js";
 import { pull, push } from "./sync.js";
 import { add as workspaceAdd } from "./workspace.js";
+import workers from "./workers.js";
+import queues from "./queues.js";
 export { flow, app, script, workspace, resource, user, variable, hub, folder, schedule, sync, instance, dev, hubPull, pull, push, workspaceAdd, };
 // addEventListener("error", (event) => {
 //   if (event.error) {
@@ -30,11 +33,11 @@ export { flow, app, script, workspace, resource, user, variable, hub, folder, sc
 //     console.error(JSON.stringify(event.error, null, 4));
 //   }
 // });
-export const VERSION = "1.401.0";
+export const VERSION = "1.402.0";
 const command = new Command()
     .name("wmill")
     .action(() => log.info(`Welcome to Windmill CLI ${VERSION}. Use -h for help.`))
-    .description("A simple CLI tool for windmill.")
+    .description("Windmill CLI")
     .globalOption("--workspace <workspace:string>", "Specify the target workspace. This overrides the default workspace.")
     .globalOption("--debug --verbose", "Show debug/verbose logs")
     .globalOption("--show-diffs", "Show diff informations when syncing (may show sensitive informations)")
@@ -69,6 +72,9 @@ const command = new Command()
     .command("dev", dev)
     .command("sync", sync)
     .command("instance", instance)
+    .command("worker-groups", workerGroups)
+    .command("workers", workers)
+    .command("queues", queues)
     .command("version", "Show version information")
     .action(async (opts) => {
     console.log("CLI build against " + VERSION);

package/esm/queues.js

@@ -0,0 +1,117 @@
+import { Command, Table } from "./deps.js";
+import { log } from "./deps.js";
+import * as wmill from "./gen/services.gen.js";
+import { pickInstance } from "./instance.js";
+function createRow(tag, data) {
+    if (data[tag]) {
+        return;
+    }
+    else {
+        data[tag] = {
+            count: 0,
+            waiting: 0,
+            later: 0,
+            running: 0,
+            suspended: 0,
+            rps30s: "",
+            rps5min: "",
+            rps30min: "",
+            rps24h: "",
+        };
+    }
+}
+async function displayQueues(opts, workspace) {
+    const activeInstance = await pickInstance(opts, true);
+    if (activeInstance) {
+        try {
+            const queuedJobs = await wmill.listQueue({ workspace: workspace ?? 'admins', allWorkspaces: workspace === undefined, perPage: 100000 });
+            const jobCounts30s = await wmill.countJobsByTag({
+                horizonSecs: 30,
+                workspaceId: workspace,
+            });
+            const nowFromDb = new Date(await wmill.getDbClock());
+            const jobCounts5min = await wmill.countJobsByTag({
+                horizonSecs: 300,
+                workspaceId: workspace,
+            });
+            const jobCounts30min = await wmill.countJobsByTag({
+                horizonSecs: 1800,
+                workspaceId: workspace,
+            });
+            const jobCounts24h = await wmill.countJobsByTag({
+                horizonSecs: 86400,
+                workspaceId: workspace,
+            });
+            const data = {};
+            for (const job of queuedJobs) {
+                createRow(job.tag, data);
+                const scheduledFor = new Date(job.scheduled_for ?? "");
+                if (job.running) {
+                    if (job.suspend) {
+                        data[job.tag].suspended += 1;
+                    }
+                    else {
+                        data[job.tag].running += 1;
+                    }
+                }
+                else if (scheduledFor <= nowFromDb) {
+                    data[job.tag].waiting += 1;
+                }
+                else {
+                    data[job.tag].later += 1;
+                }
+            }
+            for (const count of jobCounts30s) {
+                const tag = count.tag;
+                createRow(tag, data);
+                data[tag].rps30s = (count.count / 30).toFixed(3);
+            }
+            for (const count of jobCounts5min) {
+                const tag = count.tag;
+                createRow(tag, data);
+                data[tag].rps5min = (count.count / 300).toFixed(3);
+            }
+            for (const count of jobCounts30min) {
+                const tag = count.tag;
+                createRow(tag, data);
+                data[tag].rps30min = (count.count / 1800).toFixed(3);
+            }
+            for (const count of jobCounts24h) {
+                const tag = count.tag;
+                createRow(tag, data);
+                data[tag].rps24h = (count.count / 86400).toFixed(3);
+            }
+            const table = new Table();
+            table.header([
+                "",
+                "Running",
+                "Waiting",
+                "Later",
+                "Suspended",
+                "RPS (30s)",
+                "RPS (5min)",
+                "RPS (30min)",
+                "RPS (24h)",
+            ]);
+            let body = [];
+            for (const tag in data) {
+                body.push([tag, data[tag].running, data[tag].waiting, data[tag].later, data[tag].suspended, data[tag].rps30s, data[tag].rps5min, data[tag].rps30min, data[tag].rps24h]);
+            }
+            table.body(body).render();
+        }
+        catch (error) {
+            log.error("Failed to fetch queue metrics:", error);
+        }
+    }
+    else {
+        log.info("No active instance found");
+        log.info("Use 'wmill instance add' to add a new instance");
+    }
+}
+const command = new Command()
+    .description("List all queues with their metrics")
+    .arguments("[workspace:string] the optional workspace to filter by (default to all workspaces)")
+    .option("--instance [instance]", "Name of the instance to push to, override the active instance")
+    .option("--base-url [baseUrl]", "If used with --token, will be used as the base url for the instance")
+    .action(displayQueues);
+export default command;

package/esm/settings.js

@@ -8,6 +8,7 @@ import { compareInstanceObjects } from "./instance.js";
 import { isSuperset } from "./types.js";
 import { deepEqual } from "./utils.js";
 import * as wmill from "./gen/services.gen.js";
+import { removeWorkerPrefix } from "./worker_groups.js";
 export async function pushWorkspaceSettings(workspace, _path, settings, localSettings) {
     try {
         const remoteSettings = await wmill.getSettings({
@@ -271,7 +272,12 @@ export async function pushInstanceSettings(preview = false, baseUrl) {
     }
 }
 export async function pullInstanceConfigs(preview = false) {
-    const remoteConfigs = await wmill.listConfigs();
+    const remoteConfigs = (await wmill.listConfigs()).map((x) => {
+        return {
+            ...x,
+            name: removeWorkerPrefix(x.name),
+        };
+    });
     if (preview) {
         let localConfigs = [];
         try {
@@ -287,7 +293,12 @@ export async function pullInstanceConfigs(preview = false) {
     }
 }
 export async function pushInstanceConfigs(preview = false) {
-    const remoteConfigs = await wmill.listConfigs();
+    const remoteConfigs = (await wmill.listConfigs()).map((x) => {
+        return {
+            ...x,
+            name: removeWorkerPrefix(x.name),
+        };
+    });
     const localConfigs = (await dntShim.Deno.readTextFile("instance_configs.yaml")
         .then((raw) => yamlParse(raw))
         .catch(() => []));
@@ -303,7 +314,7 @@ export async function pushInstanceConfigs(preview = false) {
             }
             try {
                 await wmill.updateConfig({
-                    name: config.name,
+                    name: config.name.startsWith('worker__') ? config.name : `worker__${config.name}`,
                     requestBody: config.config,
                 });
             }

package/esm/worker_groups.js

@@ -0,0 +1,96 @@
+import { Command, Confirm, setClient, Table } from "./deps.js";
+import { log } from "./deps.js";
+import { allInstances, getActiveInstance, pickInstance } from "./instance.js";
+import * as wmill from "./gen/services.gen.js";
+import { pullInstanceConfigs, pushInstanceConfigs } from "./settings.js";
+export async function getInstance(opts) {
+    const instances = await allInstances();
+    const instanceName = await getActiveInstance(opts);
+    const instance = instances.find((i) => i.name === instanceName);
+    if (instance) {
+        setClient(instance.token, instance.remote.slice(0, instance.remote.length - 1));
+    }
+    return instance;
+}
+export function removeWorkerPrefix(name) {
+    if (name.startsWith("worker__")) {
+        return name.substring(8);
+    }
+    return name;
+}
+export async function displayWorkerGroups(opts) {
+    log.info("2 actions available, pull and push.");
+    const activeInstance = await getActiveInstance({});
+    if (activeInstance) {
+        log.info("Active instance: " + activeInstance);
+        const instance = await getInstance({});
+        if (instance) {
+            const wGroups = await wmill.listWorkerGroups();
+            new Table()
+                .header(["name", "config"])
+                .padding(2)
+                .border(true)
+                .body(wGroups.map((x) => [removeWorkerPrefix(x.name), JSON.stringify(x.config, null, 2)]))
+                .render();
+        }
+        else {
+            log.error(`Instance ${activeInstance} not found`);
+        }
+    }
+    else {
+        log.info("No active instance found");
+        log.info("Use 'wmill instance add' to add a new instance");
+    }
+}
+async function pullWorkerGroups(opts) {
+    await pickInstance(opts, true);
+    const totalChanges = await pullInstanceConfigs(true) ?? 0;
+    if (totalChanges === 0) {
+        log.info("No changes to apply");
+        return;
+    }
+    let confirm = true;
+    if (opts.yes !== true) {
+        confirm = await Confirm.prompt({
+            message: `Do you want to pul these ${totalChanges} instance-level changes?`,
+            default: true,
+        });
+    }
+    if (confirm) {
+        await pullInstanceConfigs(false);
+    }
+}
+async function pushWorkerGroups(opts) {
+    await pickInstance(opts, true);
+    const totalChanges = await pushInstanceConfigs(true) ?? 0;
+    if (totalChanges === 0) {
+        log.info("No changes to apply");
+        return;
+    }
+    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) {
+        await pushInstanceConfigs(false);
+    }
+}
+const command = new Command()
+    .description("display worker groups, pull and push worker groups configs")
+    .action(displayWorkerGroups)
+    .command("pull")
+    .description("Pull worker groups (similar to `wmill instance pull --skip-users --skip-settings --skip-groups`)")
+    .option("--instance", "Name of the instance to push to, override the active instance")
+    .option("--base-url", "Base url to be passed to the instance settings instead of the local one")
+    .option("--yes", "Pull without needing confirmation")
+    .action(pullWorkerGroups)
+    .command("push")
+    .description("Push instance settings, users, configs, group and overwrite remote")
+    .option("--instance [instance]", "Name of the instance to push to, override the active instance")
+    .option("--base-url [baseUrl]", "If used with --token, will be used as the base url for the instance")
+    .option("--yes", "Push without needing confirmation")
+    .action(pushWorkerGroups);
+export default command;