Skip to content

Commit ea4d29f

Browse files
niclimniclim
authoredJul 16, 2024··
allow passing in a custom upload function (#2849)
·
v1.0.6v0.55.0
1 parent 07cc93a commit ea4d29f

File tree

13 files changed

+110
-69
lines changed

13 files changed

+110
-69
lines changed
 

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "openapi-workspaces",
33
"license": "MIT",
44
"private": true,
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"workspaces": [
77
"projects/json-pointer-helpers",
88
"projects/openapi-io",

‎projects/fastify-capture/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/fastify-capture",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/json-pointer-helpers/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/json-pointer-helpers",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/openapi-io/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/openapi-io",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/openapi-utilities/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/openapi-utilities",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/optic/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/optic",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/optic/src/commands/diff/diff-all.ts

+34-20
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import { jsonChangelog } from './changelog-renderers/json-changelog';
2525
import * as Types from '../../client/optic-backend-types';
2626
import { openUrl } from '../../utils/open-url';
2727
import { renderCloudSetup } from '../../utils/render-cloud';
28+
import { CustomUploadFn } from '../../types';
2829

2930
const usage = () => `
3031
optic diff-all
@@ -42,7 +43,11 @@ Example usage:
4243
$ optic diff-all --standard @org/example-standard --web --check
4344
`;
4445

45-
export const registerDiffAll = (cli: Command, config: OpticCliConfig) => {
46+
export const registerDiffAll = (
47+
cli: Command,
48+
config: OpticCliConfig,
49+
options: { customUpload?: CustomUploadFn }
50+
) => {
4651
cli
4752
.command('diff-all', { hidden: true })
4853
.configureHelp({
@@ -106,7 +111,9 @@ comma separated values (e.g. "**/*.yml,**/*.json")'
106111
'[deprecated] all matching APIs are now added by default',
107112
false
108113
)
109-
.action(errorHandler(getDiffAllAction(config), { command: 'diff-all' }));
114+
.action(
115+
errorHandler(getDiffAllAction(config, options), { command: 'diff-all' })
116+
);
110117
};
111118

112119
type DiffAllActionOptions = {
@@ -196,7 +203,8 @@ function matchCandidates(
196203
async function computeAll(
197204
candidateMap: CandidateMap,
198205
config: OpticCliConfig,
199-
options: DiffAllActionOptions
206+
options: DiffAllActionOptions,
207+
customOptions: { customUpload?: CustomUploadFn }
200208
): Promise<{
201209
warnings: Warnings;
202210
results: Result[];
@@ -398,21 +406,25 @@ async function computeAll(
398406
let changelogUrl: string | null = null;
399407
let specUrl: string | null = null;
400408
if (options.upload) {
401-
const uploadResults = await uploadDiff(
402-
{
403-
from: fromParseResults,
404-
to: toParseResults,
405-
},
406-
specResults,
407-
config,
408-
specDetails,
409-
{
410-
headTag: options.headTag,
411-
standard,
412-
}
413-
);
414-
specUrl = uploadResults?.headSpecUrl ?? null;
415-
changelogUrl = uploadResults?.changelogUrl ?? null;
409+
if (customOptions.customUpload) {
410+
await customOptions.customUpload(toParseResults);
411+
} else {
412+
const uploadResults = await uploadDiff(
413+
{
414+
from: fromParseResults,
415+
to: toParseResults,
416+
},
417+
specResults,
418+
config,
419+
specDetails,
420+
{
421+
headTag: options.headTag,
422+
standard,
423+
}
424+
);
425+
specUrl = uploadResults?.headSpecUrl ?? null;
426+
changelogUrl = uploadResults?.changelogUrl ?? null;
427+
}
416428
}
417429

418430
let sourcemapOptions: GetSourcemapOptions = {
@@ -619,7 +631,8 @@ function applyGlobFilter(
619631
}
620632

621633
const getDiffAllAction =
622-
(config: OpticCliConfig) => async (options: DiffAllActionOptions) => {
634+
(config: OpticCliConfig, customOptions: { customUpload?: CustomUploadFn }) =>
635+
async (options: DiffAllActionOptions) => {
623636
if (options.generated) {
624637
logger.warn(
625638
chalk.yellow.bold(
@@ -729,7 +742,8 @@ const getDiffAllAction =
729742
const { warnings, results } = await computeAll(
730743
candidateMap,
731744
config,
732-
options
745+
options,
746+
customOptions
733747
);
734748

735749
for (const result of results) {

‎projects/optic/src/commands/diff/diff.ts

+27-18
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { computeChecksumForAws } from '../../utils/checksum';
3232
import { openUrl } from '../../utils/open-url';
3333
import { renderCloudSetup } from '../../utils/render-cloud';
3434
import { getSpinner } from '../../utils/spinner';
35+
import { CustomUploadFn } from '../../types';
3536

3637
type DiffActionOptions = {
3738
base: string;
@@ -70,7 +71,11 @@ Examples:
7071
$ optic diff openapi-spec-v0.yml openapi-spec-v1.yml --check --standard ./other_config.yml
7172
`;
7273

73-
export const registerDiff = (cli: Command, config: OpticCliConfig) => {
74+
export const registerDiff = (
75+
cli: Command,
76+
config: OpticCliConfig,
77+
options: { customUpload?: CustomUploadFn }
78+
) => {
7479
cli
7580
.command('diff')
7681
.configureHelp({
@@ -120,7 +125,7 @@ export const registerDiff = (cli: Command, config: OpticCliConfig) => {
120125
'--generated',
121126
'[deprecated] Optic no longer differentiates generated and non-generated specifications'
122127
)
123-
.action(errorHandler(getDiffAction(config), { command: 'diff' }));
128+
.action(errorHandler(getDiffAction(config, options), { command: 'diff' }));
124129
};
125130

126131
type SpecDetails = { apiId: string; orgId: string } | null;
@@ -287,7 +292,7 @@ const runDiff = async (
287292
};
288293

289294
const getDiffAction =
290-
(config: OpticCliConfig) =>
295+
(config: OpticCliConfig, customOptions: { customUpload?: CustomUploadFn }) =>
291296
async (
292297
file1: string | undefined,
293298
file2: string | undefined,
@@ -389,21 +394,25 @@ const getDiffAction =
389394

390395
let [baseParseResult, headParseResult, specDetails] = parsedFiles;
391396
if (options.upload) {
392-
const uploadResults = await uploadDiff(
393-
{
394-
from: baseParseResult,
395-
to: headParseResult,
396-
},
397-
diffResult.specResults,
398-
config,
399-
specDetails,
400-
{
401-
headTag: options.headTag,
402-
standard: diffResult.standard,
403-
}
404-
);
405-
specUrl = uploadResults?.headSpecUrl ?? null;
406-
maybeChangelogUrl = uploadResults?.changelogUrl ?? null;
397+
if (customOptions.customUpload) {
398+
await customOptions.customUpload(headParseResult);
399+
} else {
400+
const uploadResults = await uploadDiff(
401+
{
402+
from: baseParseResult,
403+
to: headParseResult,
404+
},
405+
diffResult.specResults,
406+
config,
407+
specDetails,
408+
{
409+
headTag: options.headTag,
410+
standard: diffResult.standard,
411+
}
412+
);
413+
specUrl = uploadResults?.headSpecUrl ?? null;
414+
maybeChangelogUrl = uploadResults?.changelogUrl ?? null;
415+
}
407416
}
408417
if (options.json) {
409418
console.log(

‎projects/optic/src/commands/run.ts

+33-20
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ import { getCaptureStorage } from './capture/storage';
5151
import { captureRequestsFromProxy } from './capture/actions/captureRequests';
5252
import { processCaptures } from './capture/capture';
5353
import { uploadCoverage } from './capture/actions/upload-coverage';
54+
import { CustomUploadFn } from '../types';
5455

5556
const usage = () => `
5657
To see how Optic handles changes, run Optic in your repository a first time; then make
@@ -118,7 +119,11 @@ async function comment(data: CiRunDetails, commenter: CommentApi, sha: string) {
118119
}
119120
}
120121

121-
export function registerRunCommand(cli: Command, config: OpticCliConfig) {
122+
export function registerRunCommand(
123+
cli: Command,
124+
config: OpticCliConfig,
125+
options: { customUpload?: CustomUploadFn }
126+
) {
122127
cli
123128
.command('run')
124129
.description(
@@ -146,7 +151,7 @@ export function registerRunCommand(cli: Command, config: OpticCliConfig) {
146151
'[file_paths]',
147152
'Comma-seperated glob patterns matching specifications to process. When omitted, matches all non-ignored specifications.'
148153
)
149-
.action(errorHandler(getRunAction(config), { command: 'run' }));
154+
.action(errorHandler(getRunAction(config, options), { command: 'run' }));
150155
}
151156

152157
type RunActionOptions = {
@@ -375,13 +380,15 @@ const runDiffs = async ({
375380
localSpec,
376381
currentBranch,
377382
specDetails,
383+
customUpload,
378384
}: {
379385
specPath: string;
380386
cloudTag: string;
381387
config: OpticCliConfig;
382388
localSpec: ParseResult;
383389
currentBranch: string;
384390
specDetails: Exclude<ReturnType<typeof getApiFromOpticUrl>, null>;
391+
customUpload?: CustomUploadFn;
385392
}) => {
386393
let specResults: CompareSpecResults,
387394
warnings: string[],
@@ -444,22 +451,27 @@ const runDiffs = async ({
444451

445452
let upload: Awaited<ReturnType<typeof uploadDiff>>;
446453
try {
447-
upload = await uploadDiff(
448-
{
449-
from: cloudSpec,
450-
to: localSpec,
451-
},
452-
specResults,
453-
config,
454-
specDetails,
455-
{
456-
standard,
457-
silent: true,
458-
currentBranch,
459-
}
460-
);
461-
specUrl = upload?.headSpecUrl ?? undefined;
462-
changelogUrl = upload?.changelogUrl ?? undefined;
454+
if (customUpload) {
455+
await customUpload(cloudSpec);
456+
return;
457+
} else {
458+
upload = await uploadDiff(
459+
{
460+
from: cloudSpec,
461+
to: localSpec,
462+
},
463+
specResults,
464+
config,
465+
specDetails,
466+
{
467+
standard,
468+
silent: true,
469+
currentBranch,
470+
}
471+
);
472+
specUrl = upload?.headSpecUrl ?? undefined;
473+
changelogUrl = upload?.changelogUrl ?? undefined;
474+
}
463475
} catch (e) {
464476
return {
465477
success: false,
@@ -604,7 +616,7 @@ const runCapture = async ({
604616
};
605617

606618
export const getRunAction =
607-
(config: OpticCliConfig) =>
619+
(config: OpticCliConfig, customOptions: { customUpload?: CustomUploadFn }) =>
608620
async (matchArg: string | undefined, options: RunActionOptions) => {
609621
const commentToken =
610622
process.env.GITHUB_TOKEN ?? process.env.OPTIC_GITLAB_TOKEN;
@@ -800,14 +812,15 @@ export const getRunAction =
800812
localSpec,
801813
specDetails,
802814
specPath,
815+
customUpload: customOptions.customUpload,
803816
});
804817

805818
const captureReport = await runCapture({
806819
config,
807820
localSpec,
808821
specPath,
809822
specDetails,
810-
runId: diffsReport.success ? diffsReport.runId : undefined,
823+
runId: diffsReport?.success ? diffsReport.runId : undefined,
811824
organizationId: generatedDetails.organization_id,
812825
});
813826

‎projects/optic/src/init.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import { registerApiList } from './commands/api/list';
3232
import { registerHistory } from './commands/history';
3333
import { registerRunCommand } from './commands/run';
3434
import path from 'path';
35+
import { CustomUploadFn } from './types';
3536

3637
const packageJson = require('../package.json');
3738

@@ -65,6 +66,7 @@ export const initCli = async (
6566
cli: Command = cliInstance,
6667
options: {
6768
hideNotifier?: boolean;
69+
customUpload?: CustomUploadFn;
6870
} = {}
6971
): Promise<Command> => {
7072
cli.name('optic');
@@ -136,8 +138,8 @@ export const initCli = async (
136138
cli.version(packageJson.version, '-V, --version', 'Display version');
137139
cli.addHelpCommand(false);
138140

139-
registerRunCommand(cli, cliConfig);
140-
registerDiff(cli, cliConfig);
141+
registerRunCommand(cli, cliConfig, options);
142+
registerDiff(cli, cliConfig, options);
141143

142144
const betaSubcommands = cli.command('beta', { hidden: true });
143145
registerCaptureCommand(cli, cliConfig);
@@ -162,7 +164,7 @@ export const initCli = async (
162164
cli.addCommand(updateCommand(), { hidden: true });
163165

164166
registerLint(cli, cliConfig);
165-
registerDiffAll(cli, cliConfig);
167+
registerDiffAll(cli, cliConfig, options);
166168
registerLogin(cli, cliConfig);
167169
registerDereference(cli, cliConfig);
168170
registerBundle(cli, cliConfig);

‎projects/optic/src/types.ts

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { ParseResult } from './utils/spec-loaders';
2+
3+
export type CustomUploadFn = (spec: ParseResult) => Promise<void>;

‎projects/rulesets-base/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/rulesets-base",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

‎projects/standard-rulesets/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@useoptic/standard-rulesets",
33
"license": "MIT",
44
"packageManager": "yarn@4.1.1",
5-
"version": "0.54.13",
5+
"version": "0.55.0",
66
"main": "build/index.js",
77
"types": "build/index.d.ts",
88
"files": [

0 commit comments

Comments
 (0)
Please sign in to comment.