windmill/cli/flow.ts

// deno-lint-ignore-file no-explicit-any
import {
  Difference,
  GlobalOptions,
  PushDiffs,
  Resource,
  setValueByPath,
} from "./types.ts";
import {
  colors,
  Command,
  Flow,
  FlowService,
  JobService,
  microdiff,
  OpenFlowWPath,
  Table,
} from "./deps.ts";
import { requireLogin, resolveWorkspace, validatePath } from "./context.ts";
import { resolve, track_job } from "./script.ts";
import { Any, decoverto, model, property } from "./decoverto.ts";

// this is effectively "OpenFlow" but a copy as it is accepted by the CLI
@model()
export class FlowFile implements Resource, PushDiffs {
  @property(() => String)
  summary: string;
  @property(() => String)
  description?: string;
  @property(Any)
  value: any;
  @property(Any)
  schema?: any;

  constructor(value: any, summary?: string) {
    this.summary = summary ?? "";
    this.value = value;
  }
  async pushDiffs(
    workspace: string,
    remotePath: string,
    diffs: Difference[]
  ): Promise<void> {
    if (
      await FlowService.existsFlowByPath({
        workspace: workspace,
        path: remotePath,
      })
    ) {
      console.log(
        colors.bold.yellow(
          `Applying ${diffs.length} diffs to existing flow... ${remotePath}`
        )
      );

      // TODO: Make these optional in backend (not path ofc)
      const changeset: OpenFlowWPath = {
        path: remotePath,
        summary: this.summary,
        value: this.value,
        description: this.description, // This is OpenAPIed as optional, but isn't
        schema: this.schema, // Same
      };
      const base_changeset = { ...changeset };
      for (const diff of diffs) {
        if (
          diff.type !== "REMOVE" &&
          diff.path[0] !== "value" &&
          (diff.path.length !== 1 ||
            !["summary", "description", "schema"].includes(
              diff.path[0] as string
            ))
        ) {
          throw new Error("Invalid flow diff with path " + diff.path);
        }
        if (diff.type === "CREATE" || diff.type === "CHANGE") {
          setValueByPath(changeset, diff.path, diff.value);
        } else if (diff.type === "REMOVE") {
          setValueByPath(changeset, diff.path, null);
        }
      }
      const hasChanges = Object.values(changeset).some(
        (v) => v !== null && typeof v !== "undefined"
      );
      if (!hasChanges) {
        return;
      }

      const update = {
        ...changeset,
        ...base_changeset,
      };

      await FlowService.updateFlow({
        workspace: workspace,
        path: remotePath,
        requestBody: update,
      });
    } else {
      console.log(colors.bold.yellow("Creating new flow..."));
      await FlowService.createFlow({
        workspace: workspace,
        requestBody: {
          path: remotePath,
          summary: this.summary,
          value: this.value,
          schema: this.schema,
          description: this.description,
        },
      });
    }
  }
  async push(workspace: string, remotePath: string): Promise<void> {
    await this.pushDiffs(
      workspace,
      remotePath,
      microdiff({}, this, { cyclesFix: false })
    );
  }
}

type Options = GlobalOptions;

async function push(opts: Options, filePath: string, remotePath: string) {
  if (!validatePath(remotePath)) {
    return;
  }
  const workspace = await resolveWorkspace(opts);
  await requireLogin(opts);

  await pushFlow(filePath, workspace.workspaceId, remotePath);
  console.log(colors.bold.underline.green("Flow pushed"));
}

export async function pushFlow(
  filePath: string,
  workspace: string,
  remotePath: string
) {
  const data = decoverto
    .type(FlowFile)
    .rawToInstance(await Deno.readTextFile(filePath));
  await data.push(workspace, remotePath);
}

async function list(opts: GlobalOptions & { showArchived?: boolean }) {
  const workspace = await resolveWorkspace(opts);
  await requireLogin(opts);

  let page = 0;
  const perPage = 10;
  const total: Flow[] = [];
  while (true) {
    const res = await FlowService.listFlows({
      workspace: workspace.workspaceId,
      page,
      perPage,
      showArchived: opts.showArchived ?? false,
    });
    page += 1;
    total.push(...res);
    if (res.length < perPage) {
      break;
    }
  }

  new Table()
    .header(["path", "summary", "edited by"])
    .padding(2)
    .border(true)
    .body(total.map((x) => [x.path, x.summary, x.edited_by]))
    .render();
}
async function run(
  opts: GlobalOptions & {
    data?: string;
    silent: boolean;
  },
  path: string
) {
  const workspace = await resolveWorkspace(opts);
  await requireLogin(opts);

  const input = opts.data ? await resolve(opts.data) : {};

  const id = await JobService.runFlowByPath({
    workspace: workspace.workspaceId,
    path,
    requestBody: input,
  });

  let i = 0;
  while (true) {
    const jobInfo = await JobService.getJob({
      workspace: workspace.workspaceId,
      id,
    });
    if (jobInfo.flow_status!.modules.length <= i) {
      break;
    }
    const module = jobInfo.flow_status!.modules[i];

    if (module.job) {
      if (!opts.silent) {
        console.log("====== Job " + (i + 1) + " ======");
        await track_job(workspace.workspaceId, module.job);
      }
    } else {
      console.log(module.type);
      await new Promise((resolve, _) =>
        setTimeout(() => resolve(undefined), 100)
      );
      continue;
    }
    i++;
  }

  if (!opts.silent) {
    console.log(colors.green.underline.bold("Flow ran to completion"));
    console.log();
  }
  const jobInfo = await JobService.getCompletedJob({
    workspace: workspace.workspaceId,
    id,
  });
  console.log(jobInfo.result ?? {});
}

const command = new Command()
  .description("flow related commands")
  .option("--show-archived", "Enable archived scripts in output")
  .action(list as any)
  .command(
    "push",
    "push a local flow spec. This overrides any remote versions."
  )
  .arguments("<file_path:string> <remote_path:string>")
  .action(push as any)
  .command("run", "run a flow by path.")
  .arguments("<path:string>")
  .option(
    "-d --data <data:string>",
    "Inputs specified as a JSON string or a file using @<filename> or stdin using @-."
  )
  .option(
    "-s --silent",
    "Do not ouput anything other then the final output. Useful for scripting."
  )
  .action(run as any);

export default command;