feat: integrate v2 ParserJS in validate command #376

magicmatatjahu · 2022-10-18T10:59:16Z

Integrate new ParserJS (with Spectral) in the validate command
Integrate new way of validation in other commands - user can see validation diagnostics in generate models and diff commands and determine if command should fail or should perform logic if diagnostics severity is allowed.
Write tests

Example input:

asyncapi validate ./test/specification.yaml --diagnostics-format stylish

Example output:

Related issue(s)
Part of asyncapi/parser-js#481

sonarqubecloud · 2022-10-18T13:59:08Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

Souvikns

Looks awesome, one thing to add, when we run the validate command and there is a governance issue it says File ./test/specification.yml and/or referenced documents have governance issues. but the file is valid, shouldn't it say that the file is valid but have governance issue.

magicmatatjahu · 2022-10-19T08:47:19Z

@Souvikns So you wanna see something like:

File ./test/specification.yml is valid but have (and/or referenced documents) governance issues.

?

Souvikns · 2022-10-19T08:48:37Z

I use cli to quickly check if the spec I am writing is valid, and yeah this would help

magicmatatjahu · 2022-10-19T08:50:02Z

@Souvikns Ok, good :) I will change that but before let's see what think about that @derberg

magicmatatjahu · 2022-11-17T09:10:29Z

@derberg ping 😄

derberg

just left 2 comments
other review will do tomorrow

derberg · 2022-11-21T18:37:28Z

src/parser.ts

+import { html, json, junit, stylish, teamcity, text, pretty } from '@stoplight/spectral-cli/dist/formatters';
+import { OutputFormat } from '@stoplight/spectral-cli/dist/services/config';


it is pretty risky to import these helpers from dist of the CLI.....breaking changes may hurt us later

It will give you errors during the CLI build that these exports don't exist in the path. There is no other way, and creating these functions from scratch or copying them to our codebase is pointless. There is no good solution here and this is the least invasive.

then we should at least make sure that in package.json we do not allow ^ for spectral-cli dependency

derberg · 2022-11-21T18:39:20Z

package.json

@@ -12,11 +12,12 @@
    "@asyncapi/diff": "^0.4.0",
    "@asyncapi/generator": "^1.9.12",
    "@asyncapi/modelina": "^0.59.8",
-    "@asyncapi/parser": "^1.17.0",
+    "@asyncapi/parser": "^2.0.0-next-major.6",


and here we have the same problem we have with other PR from Jonas. This will be overwritten with next parser release back to 1.18

derberg

left just few comments

derberg · 2022-11-22T08:39:53Z

scripts/fetch-asyncapi-example.js

-    if (!parsedAsyncAPI.hasServers()) {return '';}
-    const servers = parsedAsyncAPI.servers();
-    return Object.keys(servers).map(server => servers[String(server)].protocol()).join(',');
+  const listAllProtocolsForFile = (document) => {


good candidate for Parser API 😉

derberg · 2022-11-22T08:53:30Z

src/models/SpecificationFile.ts

+    return this.getFilePath() || this.getFileURL();
+  }
+
+  toDetails() {


this one sounds weird, do not play well with what it returns

derberg · 2022-11-22T09:06:27Z

test/commands/diff.test.ts

@@ -6,7 +6,7 @@ describe('diff', () => {
    test
      .stderr()
      .stdout()
-      .command(['diff', './test/specification.yml', './test/specification.yml', '--format=json'])
+      .command(['diff', './test/specification.yml', './test/specification.yml', '--format=json', '--no-log-diagnostics'])


when I run diff successfully I do not want to see diagnostics by default. When I run diff I'm interested with diff, unless files that I run through diff have errors and diff cannot run because of it

derberg

since asyncapi/.github#204 the bump.yml workflow is not going to be replicated in repositories that do not have get-global-node-release-workflows. This means that you can now easily update it in parser repository, in the master branch to make sure regular releases will not revert the version update that you did here. So in parser bump workflow you need to add cli to list of ignored repos

sonarqubecloud · 2023-01-26T14:35:37Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
4 Code Smells

No Coverage information
0.0% Duplication

magicmatatjahu · 2023-01-26T14:39:18Z

@derberg Ok, suggestions applied! Could you check again?

derberg · 2023-01-30T14:30:25Z

@magicmatatjahu can you address code smells?

magicmatatjahu · 2023-01-30T14:33:09Z

@derberg You can check that we cannot address such an issues, because Modelina doesn't support in input parsed AsyncAPI document (but only in types) - in the logic we check that. However, that code is in HEAD on master https://github.com/asyncapi/cli/blob/master/src/commands/generate/models.ts#L164 so that code isn't added by my PR.

derberg

@magicmatatjahu right, thanks for point that out

magicmatatjahu · 2023-01-30T14:36:04Z

@jonaslagoni Do you wanna check. I changed some code in models generation?

derberg · 2023-01-30T14:36:34Z

@magicmatatjahu when do you plan to update https://github.com/asyncapi/parser-js/blob/master/.github/workflows/bump.yml and https://github.com/asyncapi/parser-js/blob/next-major/.github/workflows/bump.yml ?

jonaslagoni

@magicmatatjahu not necessary, but now that I am here LGTM 👍

magicmatatjahu · 2023-01-30T15:44:50Z

@derberg asyncapi/parser-js#701 and asyncapi/parser-js#702 Could you check? Thanks!

derberg · 2023-01-31T15:30:27Z

/rtm

asyncapi-bot · 2023-01-31T16:05:45Z

🎉 This PR is included in version 0.30.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

magicmatatjahu added the enhancement New feature or request label Oct 18, 2022

magicmatatjahu mentioned this pull request Oct 18, 2022

feat: integrate new parser-js #347

Closed

magicmatatjahu marked this pull request as ready for review October 18, 2022 11:06

magicmatatjahu requested review from Souvikns, derberg, boyney123 and asyncapi-bot-eve as code owners October 18, 2022 11:06

Souvikns previously approved these changes Oct 19, 2022

View reviewed changes

derberg reviewed Nov 21, 2022

View reviewed changes

derberg requested changes Nov 22, 2022

View reviewed changes

derberg reviewed Jan 17, 2023

View reviewed changes

magicmatatjahu added 3 commits January 26, 2023 13:22

feat: integrate new parserJS

00ef7d8

update commands

fd6fb20

fix windows tests

bb64439

magicmatatjahu dismissed Souvikns’s stale review via bb64439 January 26, 2023 12:23

magicmatatjahu force-pushed the integrate-spectral branch from 52fd3ee to bb64439 Compare January 26, 2023 12:23

magicmatatjahu added 2 commits January 26, 2023 15:18

fix tests and apply review suggestions

72b616d

fix problems with event listeners

5185496

derberg approved these changes Jan 30, 2023

View reviewed changes

jonaslagoni approved these changes Jan 30, 2023

View reviewed changes

Souvikns approved these changes Jan 30, 2023

View reviewed changes

This was referenced Jan 30, 2023

ci: add cli to ignore repos in bump workflow asyncapi/parser-js#701

Merged

ci: add cli to ignore repos in bump workflow asyncapi/parser-js#702

Merged

derberg changed the title ~~feat: integrate v2 ParserJS~~ feat: integrate v2 ParserJS in validate command Jan 31, 2023

asyncapi-bot added the ready-to-merge label Jan 31, 2023

asyncapi-bot merged commit fe5bf85 into asyncapi:master Jan 31, 2023

asyncapi-bot added the released label Jan 31, 2023

magicmatatjahu deleted the integrate-spectral branch January 31, 2023 16:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: integrate v2 ParserJS in validate command #376

feat: integrate v2 ParserJS in validate command #376

magicmatatjahu commented Oct 18, 2022 •

edited

Loading

sonarqubecloud bot commented Oct 18, 2022

Souvikns left a comment

magicmatatjahu commented Oct 19, 2022 •

edited

Loading

Souvikns commented Oct 19, 2022

magicmatatjahu commented Oct 19, 2022

magicmatatjahu commented Nov 17, 2022

derberg left a comment

derberg Nov 21, 2022

magicmatatjahu Nov 22, 2022

derberg Jan 17, 2023

derberg Nov 21, 2022

derberg left a comment

derberg Nov 22, 2022

derberg Nov 22, 2022

derberg Nov 22, 2022

derberg left a comment

sonarqubecloud bot commented Jan 26, 2023

magicmatatjahu commented Jan 26, 2023

derberg commented Jan 30, 2023

magicmatatjahu commented Jan 30, 2023 •

edited

Loading

derberg left a comment

magicmatatjahu commented Jan 30, 2023 •

edited

Loading

derberg commented Jan 30, 2023

jonaslagoni left a comment

magicmatatjahu commented Jan 30, 2023

derberg commented Jan 31, 2023

asyncapi-bot commented Jan 31, 2023

		import { html, json, junit, stylish, teamcity, text, pretty } from '@stoplight/spectral-cli/dist/formatters';
		import { OutputFormat } from '@stoplight/spectral-cli/dist/services/config';

feat: integrate v2 ParserJS in validate command #376

feat: integrate v2 ParserJS in validate command #376

Conversation

magicmatatjahu commented Oct 18, 2022 • edited Loading

sonarqubecloud bot commented Oct 18, 2022

Souvikns left a comment

Choose a reason for hiding this comment

magicmatatjahu commented Oct 19, 2022 • edited Loading

Souvikns commented Oct 19, 2022

magicmatatjahu commented Oct 19, 2022

magicmatatjahu commented Nov 17, 2022

derberg left a comment

Choose a reason for hiding this comment

derberg Nov 21, 2022

Choose a reason for hiding this comment

magicmatatjahu Nov 22, 2022

Choose a reason for hiding this comment

derberg Jan 17, 2023

Choose a reason for hiding this comment

derberg Nov 21, 2022

Choose a reason for hiding this comment

derberg left a comment

Choose a reason for hiding this comment

derberg Nov 22, 2022

Choose a reason for hiding this comment

derberg Nov 22, 2022

Choose a reason for hiding this comment

derberg Nov 22, 2022

Choose a reason for hiding this comment

derberg left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 26, 2023

magicmatatjahu commented Jan 26, 2023

derberg commented Jan 30, 2023

magicmatatjahu commented Jan 30, 2023 • edited Loading

derberg left a comment

Choose a reason for hiding this comment

magicmatatjahu commented Jan 30, 2023 • edited Loading

derberg commented Jan 30, 2023

jonaslagoni left a comment

Choose a reason for hiding this comment

magicmatatjahu commented Jan 30, 2023

derberg commented Jan 31, 2023

asyncapi-bot commented Jan 31, 2023

magicmatatjahu commented Oct 18, 2022 •

edited

Loading

magicmatatjahu commented Oct 19, 2022 •

edited

Loading

magicmatatjahu commented Jan 30, 2023 •

edited

Loading

magicmatatjahu commented Jan 30, 2023 •

edited

Loading