Add snapshots option to cli pull command

.changeset/long-clocks-draw.md

@@ -0,0 +1,6 @@
+---
+'@openfn/cli': minor
+'@openfn/deploy': minor
+---
+
+Add snapshots option to cli pull command

packages/cli/src/options.ts

@@ -46,6 +46,7 @@ export type Opts = {
  repoDir?: string;
  sanitize: 'none' | 'remove' | 'summarize' | 'obfuscate';
  skipAdaptorValidation?: boolean;
+ snapshots?: string[];
  specifier?: string; // docgen
  start?: string; // workflow start step
  statePath?: string;
@@ -402,6 +403,14 @@ export const skipAdaptorValidation: CLIOption = {
  },
 };
 
+export const snapshots: CLIOption = {
+ name: 'snapshots',
+ yargs: {
+ description: 'List of snapshot ids to pull',
+ array: true,
+ },
+};
+
 export const statePath: CLIOption = {
  name: 'state-path',
  yargs: {

packages/cli/src/pull/command.ts

@@ -14,10 +14,18 @@ export type PullOptions = Required<
  | 'configPath'
  | 'projectId'
  | 'confirm'
+ | 'snapshots'
  >
 >;
 
-const options = [o.statePath, o.projectPath, o.configPath, o.log, o.logJson];
+const options = [
+ o.statePath,
+ o.projectPath,
+ o.configPath,
+ o.log,
+ o.logJson,
+ o.snapshots,
+];
 
 const pullCommand: yargs.CommandModule<PullOptions> = {
  command: 'pull [projectId]',

packages/cli/src/pull/handler.ts

@@ -29,7 +29,11 @@ async function pullHandler(options: PullOptions, logger: Logger) {
  );
 
  // Get the project.json from Lightning
- const { data: project } = await getProject(config, options.projectId);
+ const { data: project } = await getProject(
+ config,
+ options.projectId,
+ options.snapshots
+ );
 
  if (!project) {
  logger.error('ERROR: Project not found.');

packages/deploy/src/client.ts

@@ -1,14 +1,25 @@
 import { DeployConfig, ProjectPayload } from './types';
 import { DeployError } from './deployError';
 
-const getLightningUrl = (config: DeployConfig, path: string = '') =>
- new URL(`/api/provision/${path}`, config.endpoint);
+export const getLightningUrl = (
+ config: DeployConfig,
+ path: string = '',
+ snapshots?: string[]
+) => {
+ const params = new URLSearchParams();
+ snapshots?.forEach((snapshot) => params.append('snapshots[]', snapshot));
+ return new URL(
+ `/api/provision/${path}?${params.toString()}`,
+ config.endpoint
+ );
+};
 
 export async function getProject(
  config: DeployConfig,
- projectId: string
+ projectId: string,
+ snapshots?: string[]
 ): Promise<{ data: ProjectPayload | null }> {
- const url = getLightningUrl(config, projectId);
+ const url = getLightningUrl(config, projectId, snapshots);
  console.log(`Checking ${url} for existing project.`);
 
  try {

packages/deploy/test/index.test.ts

@@ -1,6 +1,8 @@
 import { render } from '@inquirer/testing';
 import { input } from '@inquirer/prompts';
 import test from 'ava';
+import { DeployConfig } from '../src/types';
+import { getLightningUrl } from '../src/client';
 
 test('renders a confirmation', async (t) => {
  const { answer, events, getScreen } = await render(input, {
@@ -14,3 +16,37 @@ test('renders a confirmation', async (t) => {
 
  t.is(await answer, 'John');
 });
+
+test('getLightningUrl adds snapshots correctly to the URL', async (t) => {
+ const config: DeployConfig = {
+ endpoint: 'http://localhost',
+ apiKey: 'test-api-key',
+ specPath: './project.yaml',
+ statePath: './state.json',
+ requireConfirmation: false,
+ dryRun: false,
+ };
+
+ const projectId = 'test-project';
+ const snapshots = ['snapshot1', 'snapshot2'];
+
+ const expectedUrl =
+ 'http://localhost/api/provision/test-project?snapshots%5B%5D=snapshot1&snapshots%5B%5D=snapshot2';
+ t.is(getLightningUrl(config, projectId, snapshots).toString(), expectedUrl);
+});
+
+test('getLightningUrl returns the correct URL when no snapshot is provided', async (t) => {
+ const config: DeployConfig = {
+ endpoint: 'http://localhost',
+ apiKey: 'test-api-key',
+ specPath: './project.yaml',
+ statePath: './state.json',
+ requireConfirmation: false,
+ dryRun: false,
+ };
+
+ const projectId = 'test-project';
+
+ const expectedUrl = 'http://localhost/api/provision/test-project?';
+ t.is(getLightningUrl(config, projectId).toString(), expectedUrl);
+});