feat: creation of new `openapi:reduce` command to reduce large OpenAPI definitions #572

erunion · 2022-08-19T06:13:29Z

🚥 Fix RM-5114

🧰 Changes

Earlier this week I ported the reduction functionality in oas-reducer, a rad library I built last year to reduce an OpenAPI definition, over into oas with the intention of porting the CLI side of it in here as a new command. This is that! Why? oas-reducer is cool as hell and deserves a larger audience¹.

Thanks to the refactoring going on in #570 developing and testing this was a goddamned dream.

ℹ️ After we eventually publish a new major release of rdme for all the work we've been doing I'll formally deprecate oas-reducer in NPM and archive the repo.

🧬 QA & Testing

Here's what it looks like when you supply it a spec²:

Screen.Recording.2022-08-18.at.11.03.07.PM.mov

And with the work that's been happening with the promptOas library, and its file selection work, it looks great when you don't give it a spec:

Screen.Recording.2022-08-18.at.11.08.56.PM.mov

It especially deserves to be core to rdme and the whole rdme openapi flow if CX or Sales occasionally recommend it to customers to chunk up huge OAS files into smaller ones so they can be uploaded within our smol Heroku timeouts. ↩
The error at the end of this video is because I didn't select a method to filter down that path by. I've since fixed this by adding a min: 1 to the methods question. ↩

__tests__/cmds/openapi/reduce.test.ts

__tests__/__fixtures__/relative-ref-oas/petstore.json

erunion · 2022-08-19T06:31:43Z

__tests__/lib/__snapshots__/commands.test.ts.snap

      Object {
        "description": "Alias for \`rdme openapi\`. [deprecated]",
        "name": "swagger",
-        "position": 2,


I'm surprised that this has always been showing up after validate in --help with them having the same position.

:lots-of-yikes:

erunion · 2022-08-19T06:33:32Z

src/cmds/openapi/index.ts

@@ -1,4 +1,4 @@
-import type { CommandOptions } from '../lib/baseCommand';
+import type { CommandOptions } from '../../lib/baseCommand';


Moved this into src/cmds/openapi/index.ts because the openapi command group is a family now. :corona: :vindiesel:

oh the v8¹ release notes are definitely going to be F&F-themed now

Footnotes

also v8... multitudes!!!! ↩

…command

kanadgupta

overall looking good, most of my comments are minor! chatted briefly about this offline but I saw this in the tag selection (note the [object Object]):

__tests__/cmds/openapi/reduce.test.ts

kanadgupta · 2022-08-19T16:09:24Z

__tests__/lib/__snapshots__/commands.test.ts.snap

      Object {
        "description": "Alias for \`rdme openapi\`. [deprecated]",
        "name": "swagger",
-        "position": 2,


:lots-of-yikes:

kanadgupta · 2022-08-19T16:10:33Z

src/cmds/openapi/index.ts

@@ -1,4 +1,4 @@
-import type { CommandOptions } from '../lib/baseCommand';
+import type { CommandOptions } from '../../lib/baseCommand';


oh the v8¹ release notes are definitely going to be F&F-themed now

Footnotes

also v8... multitudes!!!! ↩

src/cmds/openapi/reduce.ts

src/lib/prepareOas.ts

src/cmds/openapi/reduce.ts

Co-authored-by: Kanad Gupta <[email protected]>

erunion · 2022-08-19T17:42:16Z

chatted briefly about this offline but I saw this in the tag selection (note the [object Object]):

Turns out this was because that spec has a {name: 'tag'} XML property in it and that was being picked up by the loose JSONPath query. I've added some filtering to filter these out:

erunion · 2022-08-19T17:46:11Z

src/cmds/openapi/reduce.ts

+        message: 'Enter the path to save your reduced API definition to:',
+        initial: () => {
+          const extension = path.extname(specPath);
+          return `${path.basename(specPath).split(extension)[0]}-reduced${extension}`;


This'll dynamically turn petstore.json or petstore.yaml into petstore-reduced.{ext}

erunion · 2022-08-19T17:47:21Z

src/cmds/openapi/reduce.ts

+      spinner.succeed(`${spinner.text} done! ✅`);
+    } catch (err) {
+      Command.debug(`err=${err.message}`);
+      throw err;


The reducer throws exceptions for errors (eg. if you try to filter out too much) right now so instead of trying to capture and put those in some sort of "Yikes! We couldn't reduce this because...` error I'm just letting it do its thing.

kanadgupta

tiny nit but otherwise LGTM!

kanadgupta · 2022-08-19T17:46:46Z

src/cmds/openapi/reduce.ts

+            .filter(tag => {
+              // A spec may have a `name: tag` which this JSONPath query will pick up. Since that
+              // definitely isn't a tag we want here we need to filter them out.
+              return typeof tag === 'string';


damn nice find... I wish there was an easy way to test this but can't really think of one 🤔

Yeah I'm not sure how to test what a prompt in prompts is rendering without factoring this work out into a separate small utility.

src/cmds/openapi/reduce.ts

kanadgupta · 2022-08-19T17:47:37Z

src/cmds/openapi/reduce.ts

+        message: 'Enter the path to save your reduced API definition to:',
+        initial: () => {
+          const extension = path.extname(specPath);
+          return `${path.basename(specPath).split(extension)[0]}-reduced${extension}`;


Co-authored-by: Kanad Gupta <[email protected]>

erunion added command:openapi Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands enhancement New feature or request labels Aug 19, 2022

erunion changed the title ~~feat: porting over the oas-reducer CLI into a new openapi:reduce command~~ feat: creation of new openapi:reduce command to reduce large OpenAPI definitions Aug 19, 2022

erunion requested a review from kanadgupta August 19, 2022 06:21

erunion commented Aug 19, 2022

View reviewed changes

__tests__/cmds/openapi/reduce.test.ts Show resolved Hide resolved

erunion commented Aug 19, 2022

View reviewed changes

__tests__/cmds/openapi/reduce.test.ts Show resolved Hide resolved

erunion commented Aug 19, 2022

View reviewed changes

__tests__/__fixtures__/relative-ref-oas/petstore.json Show resolved Hide resolved

erunion commented Aug 19, 2022

View reviewed changes

Base automatically changed from kanad/rm-5116-migrate-from-enquirer-to-prompts to main August 19, 2022 15:34

erunion added 3 commits August 19, 2022 08:38

feat: porting over the oas-reducer CLI into a new openapi:reduce …

d6a6ba1

…command

fix: requiring at least one method + adding docs

3a5225a

fix: alex

94e982c

erunion force-pushed the feat/oas-reducer branch from ad0e962 to 94e982c Compare August 19, 2022 15:39

kanadgupta requested changes Aug 19, 2022

View reviewed changes

erunion and others added 11 commits August 19, 2022 09:29

Update src/lib/prepareOas.ts

4699144

Co-authored-by: Kanad Gupta <[email protected]>

Update src/cmds/openapi/reduce.ts

92fe6d0

Co-authored-by: Kanad Gupta <[email protected]>

Update src/cmds/openapi/reduce.ts

0e0f26d

Co-authored-by: Kanad Gupta <[email protected]>

Update src/cmds/openapi/reduce.ts

866951f

Co-authored-by: Kanad Gupta <[email protected]>

Update src/cmds/openapi/reduce.ts

76f89b3

Co-authored-by: Kanad Gupta <[email protected]>

Update src/cmds/openapi/reduce.ts

8d5a804

Co-authored-by: Kanad Gupta <[email protected]>

Update src/lib/prepareOas.ts

17e3fb7

Co-authored-by: Kanad Gupta <[email protected]>

Update src/lib/prepareOas.ts

fe43aa8

Co-authored-by: Kanad Gupta <[email protected]>

feat: adding a dynamic initial outputPath

8d34b03

feat: wrapping the reducer process in a spinner

67c267d

fix: filter out non-tags from being handled as tags in the multiselect

a61409e

Merge branch 'main' into feat/oas-reducer

0cd3e92

erunion requested a review from kanadgupta August 19, 2022 17:45

erunion commented Aug 19, 2022

View reviewed changes

kanadgupta approved these changes Aug 19, 2022

View reviewed changes

Update src/cmds/openapi/reduce.ts

1db1617

Co-authored-by: Kanad Gupta <[email protected]>

erunion merged commit 074c13e into main Aug 19, 2022

erunion deleted the feat/oas-reducer branch August 19, 2022 17:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: creation of new `openapi:reduce` command to reduce large OpenAPI definitions #572

feat: creation of new `openapi:reduce` command to reduce large OpenAPI definitions #572

erunion commented Aug 19, 2022 •

edited

Loading

erunion Aug 19, 2022

kanadgupta Aug 19, 2022

erunion Aug 19, 2022

kanadgupta Aug 19, 2022

kanadgupta left a comment

kanadgupta Aug 19, 2022

kanadgupta Aug 19, 2022

erunion commented Aug 19, 2022

erunion Aug 19, 2022

kanadgupta Aug 19, 2022

erunion Aug 19, 2022

kanadgupta left a comment

kanadgupta Aug 19, 2022

erunion Aug 19, 2022

kanadgupta Aug 19, 2022

		@@ -1,4 +1,4 @@
		import type { CommandOptions } from '../lib/baseCommand';
		import type { CommandOptions } from '../../lib/baseCommand';

feat: creation of new openapi:reduce command to reduce large OpenAPI definitions #572

feat: creation of new openapi:reduce command to reduce large OpenAPI definitions #572

Conversation

erunion commented Aug 19, 2022 • edited Loading

🧰 Changes

🧬 QA & Testing

Footnotes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

kanadgupta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Footnotes

erunion commented Aug 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kanadgupta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

feat: creation of new `openapi:reduce` command to reduce large OpenAPI definitions #572

feat: creation of new `openapi:reduce` command to reduce large OpenAPI definitions #572

erunion commented Aug 19, 2022 •

edited

Loading