Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/cli/src/deploy/command.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import yargs from 'yargs';
import { build, ensure, override } from '../util/command-builders';
import { Opts } from '../options';
import { Opts as POpts } from '../projects/options';
import * as o from '../options';
import * as o2 from '../projects/options';

export type DeployOptions = Required<
Pick<
Opts,
Opts & POpts,
| 'beta'
| 'command'
| 'configPath'
Expand All @@ -15,6 +16,7 @@ export type DeployOptions = Required<
| 'logJson'
| 'projectPath'
| 'statePath'
| 'workspace'
>
>;

Expand Down
24 changes: 21 additions & 3 deletions packages/cli/src/deploy/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import {
import type { Logger } from '../util/logger';
import { DeployOptions } from './command';
import * as beta from '../projects/deploy';
import path from 'node:path';
import { fileExists } from '../util/file-exists';

export type DeployFn = typeof deploy;

Expand All @@ -32,6 +34,17 @@ async function deployHandler(
try {
const config = mergeOverrides(await getConfig(options.configPath), options);

const v2ConfigPath = path.join(
options.workspace || process.cwd(),
'openfn.yaml'
);
if (await fileExists(v2ConfigPath)) {
logger.always(
'Detected openfn.yaml file - switching to v2 deploy (openfn project deploy)'
);
return beta.handler({ ...options, force: true }, logger);
}

logger.debug('Deploying with config', JSON.stringify(config, null, 2));

if (options.confirm === false) {
Expand Down Expand Up @@ -76,13 +89,18 @@ function mergeOverrides(
config: DeployConfig,
options: DeployOptions
): DeployConfig {
const workspace = options.workspace || process.cwd();
const resolveRelative = (p: string) =>
path.isAbsolute(p) ? p : path.join(workspace, p);
const specPath = pickFirst(options.projectPath, config.specPath);
const statePath = pickFirst(options.statePath, config.statePath);
return {
...config,
apiKey: pickFirst(process.env['OPENFN_API_KEY'], config.apiKey),
endpoint: pickFirst(process.env['OPENFN_ENDPOINT'], config.endpoint),
statePath: pickFirst(options.statePath, config.statePath),
specPath: pickFirst(options.projectPath, config.specPath),
configPath: options.configPath,
statePath: resolveRelative(statePath),
specPath: resolveRelative(specPath),
configPath: resolveRelative(options.configPath),
requireConfirmation: pickFirst(options.confirm, config.requireConfirmation),
};
}
Expand Down
1 change: 1 addition & 0 deletions packages/cli/src/projects/pull.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ export const command: yargs.CommandModule<PullOptions> = {
};

export async function handler(options: PullOptions, logger: Logger) {
options.workspace ??= process.cwd();
ensureProjectId(options, logger);

await fetch(options, logger);
Expand Down
4 changes: 3 additions & 1 deletion packages/cli/src/pull/command.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import yargs from 'yargs';
import { build, ensure, override } from '../util/command-builders';
import { Opts } from '../options';
import { Opts as POpts } from '../projects/options';
import * as o from '../options';
import * as po from '../projects/options';

export type PullOptions = Required<
Pick<
Opts,
Opts & POpts,
| 'beta'
| 'command'
| 'log'
Expand All @@ -17,6 +18,7 @@ export type PullOptions = Required<
| 'projectId'
| 'confirm'
| 'snapshots'
| 'workspace'
>
>;

Expand Down
23 changes: 22 additions & 1 deletion packages/cli/src/pull/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
import type { Logger } from '../util/logger';
import { PullOptions } from '../pull/command';
import beta from '../projects/pull';
import { fileExists } from '../util/file-exists';

async function pullHandler(options: PullOptions, logger: Logger) {
if (options.beta) {
Expand All @@ -21,6 +22,17 @@ async function pullHandler(options: PullOptions, logger: Logger) {
try {
const config = mergeOverrides(await getConfig(options.configPath), options);

const v2ConfigPath = path.join(
options.workspace || process.cwd(),
'openfn.yaml'
);
if (await fileExists(v2ConfigPath)) {
logger.info(
'Detected openfn.yaml file - switching to v2 pull (openfn project pull)'
);
return beta({ ...options, project: options.projectId }, logger);
}

if (process.env['OPENFN_API_KEY']) {
logger.info('Using OPENFN_API_KEY environment variable');
config.apiKey = process.env['OPENFN_API_KEY'];
Expand Down Expand Up @@ -127,11 +139,20 @@ function mergeOverrides(
config: DeployConfig,
options: PullOptions
): DeployConfig {
const workspace = options.workspace || process.cwd();
return {
...config,
apiKey: pickFirst(process.env['OPENFN_API_KEY'], config.apiKey),
endpoint: pickFirst(process.env['OPENFN_ENDPOINT'], config.endpoint),
configPath: options.configPath,
configPath: path.isAbsolute(options.configPath)
? options.configPath
: path.join(workspace, options.configPath),
specPath: path.isAbsolute(config.specPath)
? config.specPath
: path.join(workspace, config.specPath),
statePath: path.isAbsolute(config.statePath)
? config.statePath
: path.join(workspace, config.statePath),
requireConfirmation: pickFirst(options.confirm, config.requireConfirmation),
};
}
Expand Down
10 changes: 10 additions & 0 deletions packages/cli/src/util/file-exists.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import fs from 'fs/promises';

export async function fileExists(filePath: string) {
try {
const stats = await fs.stat(filePath);
return stats.isFile();
} catch (error) {
return false;
}
}
43 changes: 43 additions & 0 deletions packages/cli/test/pull/handler.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import test from 'ava';
import mockfs from 'mock-fs';
import { createMockLogger } from '@openfn/logger';
import pullHandler from '../../src/pull/handler';
import { PullOptions } from '../../src/pull/command';

test.beforeEach(() => {
mockfs.restore();
});

test.afterEach(() => {
mockfs.restore();
});

const options: PullOptions = {
beta: false,
command: 'pull',
projectPath: './project.yaml',
configPath: './config.json',
projectId: 'abc-123',
confirm: false,
snapshots: [],
};

test.serial(
'redirects to beta handler when openfn.yaml exists in cwd',
async (t) => {
const logger = createMockLogger('', { level: 'debug' });
mockfs({
['./config.json']: `{"apiKey": "123"}`,
['./openfn.yaml']: '',
});

await t.throwsAsync(() => pullHandler(options, logger));

t.truthy(
logger._find(
'info',
/Detected openfn.yaml file - switching to v2 pull (openfn project pull)/
)
);
}
);
22 changes: 22 additions & 0 deletions packages/cli/test/util/file-exists.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import test from 'ava';
import mockfs from 'mock-fs';
import { fileExists } from '../../src/util/file-exists';

test.afterEach(() => {
mockfs.restore();
});

test('returns true for an existing file', async (t) => {
mockfs({ './test.txt': 'content' });
t.true(await fileExists('./test.txt'));
});

test('returns false for a non-existent path', async (t) => {
mockfs({});
t.false(await fileExists('./nonexistent.txt'));
});

test('returns false for a directory', async (t) => {
mockfs({ './mydir': {} });
t.false(await fileExists('./mydir'));
});