Merge branch 'main' into send_final_state

Author: josephjclark

packages/cli/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @openfn/cli
 
+## 1.17.1
+
+### Patch Changes
+
+- a0a1cb7: Add log option for checkout and merge
+
+## 1.17.0
+
+### Minor Changes
+
+- New command: openfn project version
+
+### Patch Changes
+
+- Updated dependencies
+  - @openfn/project@0.6.0
+
+## 1.16.2
+
+### Patch Changes
+
+- 8a50703: Allow a project to be checked out from a direct path to a project file
+- 7d16875: When merging, allow the source project to specified as a path to a project file
+- Updated dependencies [81b97c3]
+- Updated dependencies [43be979]
+- Updated dependencies [1f8d65e]
+- Updated dependencies [25c7a2b]
+- Updated dependencies [04a89e2]
+- Updated dependencies [7d16875]
+  - @openfn/project@0.5.1
+  - @openfn/lexicon@1.2.4
+
 ## 1.16.1
 
 ### Patch Changes

packages/cli/package.json

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

packages/cli/src/checkout/command.ts

@@ -4,10 +4,10 @@ import { ensure, build } from '../util/command-builders';
 import * as o from '../options';
 
 export type CheckoutOptions = Required<
-  Pick<Opts, 'command' | 'projectName' | 'projectPath'>
+  Pick<Opts, 'command' | 'projectName' | 'projectPath' | 'log'>
 >;
 
-const options = [o.projectName, o.projectPath];
+const options = [o.projectName, o.projectPath, o.log];
 
 const checkoutCommand: yargs.CommandModule = {
   command: 'checkout <project-name>',

packages/cli/src/checkout/handler.ts

@@ -1,4 +1,4 @@
-import { Workspace } from '@openfn/project';
+import Project, { Workspace } from '@openfn/project';
 import path from 'path';
 import type { Logger } from '../util/logger';
 import type { CheckoutOptions } from './command';
@@ -13,20 +13,32 @@ const checkoutHandler = async (options: CheckoutOptions, logger: Logger) => {
     return;
   }
 
+  // get the config
+  // TODO: try to retain the endpoint for the projects
+  const { project: _, ...config } = workspace.getConfig() ?? {};
+
   // get the project
-  const switchProject = workspace.get(options.projectName);
+  let switchProject;
+  if (/\.(yaml|json)$/.test(options.projectName)) {
+    // TODO: should we allow checkout into an arbitrary folder?
+    const filePath = path.join(commandPath, options.projectName);
+    logger.debug('Loading project from path ', filePath);
+    switchProject = await Project.from('path', filePath, {
+      config,
+    });
+  } else {
+    switchProject = workspace.get(options.projectName);
+  }
+
   if (!switchProject) {
     logger.error(
       `Project with id/name ${options.projectName} not found in the workspace`
     );
     return;
   }
-  // get the config
-  // TODO: try to retain the endpoint for the projects
-  const config = workspace.getConfig();
 
   // delete workflow dir before expanding project
-  await rimraf(path.join(commandPath, config?.workflowRoot || 'workflows'));
+  await rimraf(path.join(commandPath, config.workflowRoot ?? 'workflows'));
 
   // expand project into directory
   const files = switchProject.serialize('fs');

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/merge/command.ts

@@ -11,6 +11,7 @@ export type MergeOptions = Required<
     | 'projectPath'
     | 'removeUnmapped'
     | 'workflowMappings'
+    | 'log'
   >
 >;
 
@@ -19,6 +20,7 @@ const options = [
   o.projectPath,
   o.removeUnmapped,
   o.workflowMappings,
+  o.log,
 ];
 
 const mergeCommand: yargs.CommandModule = {

packages/cli/src/merge/handler.ts

@@ -13,38 +13,46 @@ const mergeHandler = async (options: MergeOptions, logger: Logger) => {
     return;
   }
 
-  const checkedProject = workspace.getActiveProject();
-  if (!checkedProject) {
+  // The target project - the think we apply changes to - is
+  // whatever is checked out
+  const targetProject = workspace.getActiveProject();
+  if (!targetProject) {
     logger.error(`No project currently checked out`);
     return;
   }
 
-  const mProject = workspace.get(options.projectName);
-  if (!mProject) {
-    logger.error(
-      `Project with id/name ${options.projectName} not found in the workspace`
-    );
+  // Lookup the source project - the thing we are getting changes from
+  let sourceProject;
+  if (/\.(yaml|json)$/.test(options.projectName)) {
+    const filePath = path.join(commandPath, options.projectName);
+    logger.debug('Loading source project from path ', filePath);
+    sourceProject = await Project.from('path', filePath);
+  } else {
+    sourceProject = workspace.get(options.projectName);
+  }
+  if (!sourceProject) {
+    logger.error(`Project "${options.projectName}" not found in the workspace`);
     return;
   }
 
-  if (checkedProject.name === mProject.name) {
+  if (targetProject.name === sourceProject.name) {
     logger.error('Merging into the same project not allowed');
     return;
   }
 
-  if (!checkedProject.name) {
+  if (!targetProject.name) {
     logger.error('The checked out project has no name/id');
     return;
   }
 
-  const finalPath = workspace.getProjectPath(checkedProject.name);
+  const finalPath = workspace.getProjectPath(targetProject.name);
   if (!finalPath) {
     logger.error('Path to checked out project not found.');
     return;
   }
 
   // TODO pick options from the terminal
-  const final = Project.merge(mProject, checkedProject, {
+  const final = Project.merge(sourceProject, targetProject, {
     removeUnmapped: options.removeUnmapped,
     workflowMappings: options.workflowMappings,
   });
@@ -61,7 +69,7 @@ const mergeHandler = async (options: MergeOptions, logger: Logger) => {
     logger
   );
   logger.success(
-    `Project ${mProject.name} has been merged into Project ${checkedProject.name} successfully`
+    `Project ${sourceProject.name} has been merged into Project ${targetProject.name} successfully`
   );
 };
 

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;