Merge pull request #966 from OpenFn/project-versions

Projects: versions

Author: josephjclark

packages/cli/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @openfn/cli
 
+## 1.17.0
+
+### Minor Changes
+
+- New command: openfn project version
+
+### Patch Changes
+
+- Updated dependencies
+  - @openfn/project@0.6.0
+
 ## 1.16.2
 
 ### Patch Changes

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/cli",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "description": "CLI devtools for the OpenFn toolchain",
   "engines": {
     "node": ">=18",

packages/cli/src/cli.ts

@@ -16,6 +16,7 @@ import testCommand from './test/command';
 import projectsCommand from './projects/command';
 import checkoutCommand from './checkout/command';
 import mergeCommand from './merge/command';
+import workflowVersionCommand from './version/command';
 
 const y = yargs(hideBin(process.argv));
 
@@ -36,6 +37,7 @@ export const cmd = y
   .command(projectsCommand)
   .command(checkoutCommand)
   .command(mergeCommand)
+  .command(workflowVersionCommand)
   .command({
     command: 'version',
     describe:

packages/cli/src/commands.ts

@@ -10,6 +10,7 @@ import docs from './docs/handler';
 import metadata from './metadata/handler';
 import pull from './pull/handler';
 import projects from './projects/handler';
+import workflowVersion from './version/handler';
 import checkout from './checkout/handler';
 import merge from './merge/handler';
 import { clean, install, pwd, list } from './repo/handler';
@@ -36,6 +37,7 @@ export type CommandList =
   | 'projects'
   | 'checkout'
   | 'merge'
+  | 'project'
   | 'repo-clean'
   | 'repo-install'
   | 'repo-list'
@@ -56,6 +58,7 @@ const handlers = {
   projects,
   checkout,
   merge,
+  project: workflowVersion,
   ['collections-get']: collections.get,
   ['collections-set']: collections.set,
   ['collections-remove']: collections.remove,

packages/cli/src/options.ts

@@ -25,6 +25,7 @@ export type Opts = {
   apolloUrl?: string;
   apiKey?: string;
   autoinstall?: boolean;
+  json?: boolean;
   beta?: boolean;
   cacheSteps?: boolean;
   compile?: boolean;
@@ -176,6 +177,15 @@ export const apolloUrl: CLIOption = {
   },
 };
 
+export const json: CLIOption = {
+  name: 'json',
+  yargs: {
+    boolean: true,
+    description: 'Output the result as a json object',
+    default: false,
+  },
+};
+
 export const beta: CLIOption = {
   name: 'beta',
   yargs: {

packages/cli/src/version/command.ts

@@ -0,0 +1,33 @@
+import yargs from 'yargs';
+import { Opts } from '../options';
+import { ensure, build } from '../util/command-builders';
+import * as o from '../options';
+
+export type VersionOptions = Required<
+  Pick<
+    Opts,
+    | 'command'
+    | 'workflow'
+    | 'projectName'
+    | 'projectPath'
+    | 'workflowMappings'
+    | 'json'
+  >
+>;
+
+const options = [
+  o.workflow,
+  o.projectName,
+  o.projectPath,
+  o.workflowMappings,
+  o.json,
+];
+
+const workflowVersionCommand: yargs.CommandModule = {
+  command: 'project version [workflow]',
+  describe: 'Returns the version has of a workflow',
+  handler: ensure('project', options),
+  builder: (yargs) => build(options, yargs),
+};
+
+export default workflowVersionCommand;

packages/cli/src/version/handler.ts

@@ -0,0 +1,48 @@
+import { Workspace } from '@openfn/project';
+import path from 'path';
+import type { Logger } from '../util/logger';
+import type { VersionOptions } from './command';
+
+const workflowVersionHandler = async (
+  options: VersionOptions,
+  logger: Logger
+) => {
+  const commandPath = path.resolve(options.projectPath ?? '.');
+  const workspace = new Workspace(commandPath);
+  if (!workspace.valid) {
+    logger.error('Command was run in an invalid openfn workspace');
+    return;
+  }
+
+  const output = new Map<string, string>();
+
+  const activeProject = workspace.getActiveProject();
+  if (options.workflow) {
+    const workflow = activeProject?.getWorkflow(options.workflow);
+    if (!workflow) {
+      logger.error(`No workflow found with id/name ${options.workflow}`);
+      return;
+    }
+    output.set(workflow.name || workflow.id, workflow.getVersionHash());
+  } else {
+    for (const wf of activeProject?.workflows || []) {
+      output.set(wf.name || wf.id, wf.getVersionHash());
+    }
+  }
+  if (!output.size) {
+    logger.error('No workflow available');
+    return;
+  }
+
+  let final: string;
+  if (options.json) {
+    final = JSON.stringify(Object.fromEntries(output), undefined, 2);
+  } else {
+    final = Array.from(output.entries())
+      .map(([key, value]) => key + '\n' + value)
+      .join('\n\n');
+  }
+  logger.success(`Workflow(s) and their hashes\n\n${final}`);
+};
+
+export default workflowVersionHandler;

packages/project/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @openfn/project
 
+## 0.6.0
+
+### Minor Changes
+
+- Add version hashes for workflows
+
 ## 0.5.1
 
 ### Patch Changes

packages/project/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/project",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Read, serialize, replicate and sync OpenFn projects",
   "scripts": {
     "test": "pnpm ava",

packages/project/src/Project.ts

@@ -133,7 +133,7 @@ export class Project {
   static from(
     type: 'state' | 'path' | 'fs',
     data: any,
-    options?: Partial<l.ProjectConfig>
+    options: Partial<l.ProjectConfig> = {}
   ): Project {
     if (type === 'state') {
       return fromAppState(data, options);
@@ -188,8 +188,11 @@ export class Project {
 
   // get workflow by name or id
   // this is fuzzy, but is that wrong?
-  getWorkflow(id: string) {
-    return this.workflows.find((wf) => wf.id == id);
+  getWorkflow(idOrName: string) {
+    return (
+      this.workflows.find((wf) => wf.id == idOrName) ||
+      this.workflows.find((wf) => wf.name === idOrName)
+    );
   }
 
   // it's the name of the project.yaml file