feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator #374

jonaslagoni · 2022-10-17T16:23:42Z

Description
This PR adds support for AsyncAPI 2.5, Python and Rust model generation by upgrading the modelina dependency.

derberg

you have some conflicts with package-lock and failing tests

derberg · 2022-10-18T11:18:02Z

package.json

@@ -11,7 +11,7 @@
    "@asyncapi/converter": "^1.1.0",
    "@asyncapi/diff": "^0.4.0",
    "@asyncapi/generator": "^1.9.12",
-    "@asyncapi/modelina": "^0.59.8",
+    "@asyncapi/modelina": "^1.0.0-next.22",


did you adjust modelina release config, so this is not reverted to 0.59.9 with next regular release?

Can I adapt the release workflow when it's managed by .github? 🤔

oh crap, you are right, it is possible with react component with https://github.com/asyncapi/asyncapi-react/blob/master/.github/workflows/bump.yml#L34 hack in global workflow but only because HTML template only depends on react component.

but cli needs bumps from other packages, not only modelina 🤔

we need something smarter 🤔

Opting out modelina from bump.yml updates pushed from .github is the only solution I see I think.
It will require some refactor to https://github.com/asyncapi/.github/blob/master/.github/workflows/global-replicator.yml config.

other than that, I could always add some feature to derberg/npm-dependency-manager-for-your-github-org but not sure what that could be

Would it make sense that derberg/npm-dependency-manager-for-your-github-org was context depending on the version strategy, and "understand" what to update and what not to? 🤔 I.e. in this case "understand" that because we use a next-generation branch, only updates from that can be used going forward instead of those from master? 🧐

in our scenario bump runs in scope of modelina. When it runs in next branch scope, it surely can figure that out, that it runs in next branch, and do something specific. But the problem is when it runs in scope of master, how will it know to not do anything in dependant projects? in cli it works on default master branch 🤷🏼

I don't think there is any other solution than:

have some .bump.config.yml file that you can add to repo, where you can specify what repos should be ignored, and you would store it in master

or

modify settings of workflow that updates all repos, manage bump.yml workflow as separate workflow, independent from nodejs topic. Then we can have autobump topic. Only repos with this topic would get updates, and modelina would be opted out (not only modelina as we have the same case with parser now) from bump workflow updates and could this way have custom settings (like repos to ignore or entire workflow removed from master)

cc @KhudaDad414 @magicmatatjahu @smoya

But the problem is when it runs in scope of master, how will it know to not do anything in dependant projects?

Will it not be able to process the dependent project package.json file to determine the current version and see whether it uses a pre-build id or which major version it uses?

technically possible, but why should it have such functionality?

basing on what condition will it know that RC used in package.json is the last one, and actually main release should be used?

I might be missing some crucial point here, but in the bump workflow, it should be possible to get the new version of the library, and then take the version of the library it tries to bump, and correlate the semver version with each other to know whether to bump it or not.

Of course, this should not automatically update from pre-release to a new major version. Or I guess it can 🤷

# Conflicts: # package-lock.json

# Conflicts: # package-lock.json # package.json

jonaslagoni · 2022-11-16T11:46:49Z

Any reason why the tests are broken? 🧐 I don't see any of the changes I did which affected them, do you?

derberg · 2022-11-16T15:09:16Z

@jonaslagoni hard to say really. First time I see such errors. I see you did not make much changes but you did bump modelina to 1.0 release candidate. I dunno how much changed there, but maybe some basic stuff changed that affects the tests? errory types?

jonaslagoni · 2022-11-16T15:49:39Z

@derberg but the problems with the tests are oclif errors?

derberg · 2022-11-21T18:12:48Z

@jonaslagoni when I checkout your branch and install it, I get the same warning related errors. I think it is like this only because of installation of some crappy patch. You installed dependencies using "lockfileVersion": 1 and version from master is "lockfileVersion": 2. I recommend taking latest package-lock.json from master, and run installation on local again but with npm > 6

# Conflicts: # package-lock.json

derberg · 2022-11-22T09:54:37Z

finally different errors 🚀 😄
have a look, sometimes message do not match reality. Also try fixing by switching from toMatch instead of toEqual. I saw @magicmatatjahu did it in one of his PRs. Probably because of switch to jest

derberg · 2022-12-01T11:38:10Z

@jonaslagoni you need help?

jonaslagoni · 2022-12-08T22:00:26Z

@derberg I need a better way to integrate with the old parser 😅 See asyncapi/modelina#1050 and asyncapi/parser-js#687

jonaslagoni · 2023-01-11T09:34:05Z

I am gonna need some help with the test CI, cause I have no idea why it's failing and I cannot reproduce it locally, any ideas? @derberg

Maybe it's related to #374 (comment) 🤔

jonaslagoni · 2023-01-12T06:43:14Z

.gitignore

@@ -17,7 +17,6 @@ node_modules
 asyncapi.json
 asyncapi.yaml
 asyncapi.yml
-/test/docs


Because each file is cleaned up in the fromTemplate test, there is no reason to ignore it, and because one of the tests require that it's not ignored.

jonaslagoni · 2023-01-12T06:55:33Z

test/commands/generate/fromTemplate.test.ts

+  describe('git clash', () => {
+    const pathToOutput = './test/docs/2';
+    beforeAll(() => {
+      fs.mkdirSync(pathToOutput, { recursive: true });
+      // Write a random file to trigger that dir has unstaged changes.
+      fs.writeFileSync(path.join(pathToOutput, 'random.md'), '');
+    });
+    test
+      .stderr()
+      .command([...generalOptions, '--output=./test/docs/2'])
+      .it(
+        'should throw error if output folder is in a git repository',
+        (ctx, done) => {
+          expect(ctx.stderr).toContain(
+            'Error: "./test/docs/2" is in a git repository with unstaged changes.'
+          );
+          cleanup('./test/docs/2');
+          done();
+        }
+      );
+  });


I dont quite understand why this worked before, but I guess that's just race conditions in a nutshell 🤷

I refactored the tests so each tests are completely siloed from the other. Furthermore, this test is specifically set up to trigger the error by using an empty unstaged file.

jonaslagoni · 2023-01-12T06:58:18Z

PR is ready for final review 🙂

# Conflicts: # package-lock.json

jonaslagoni · 2023-01-13T09:03:16Z

Fixed the conflict from master, feel free to merge whenever you have the reviews you think is needed 🙂

sonarqubecloud · 2023-01-13T09:04:06Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

derberg · 2023-01-16T08:29:12Z

/rtm

asyncapi-bot · 2023-01-16T08:52:02Z

🎉 This PR is included in version 0.28.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

add impl and test

8cee7d1

jonaslagoni requested review from Souvikns, magicmatatjahu, derberg, boyney123 and asyncapi-bot-eve as code owners October 17, 2022 16:23

jonaslagoni marked this pull request as draft October 17, 2022 16:36

jonaslagoni changed the title ~~feat: add support for AsyncAPI 2.5 and Python generator~~ feat: add support for AsyncAPI 2.5, Python and Rust generator Oct 17, 2022

add rust support

8bfeca4

jonaslagoni marked this pull request as ready for review October 17, 2022 16:48

derberg requested changes Oct 18, 2022

View reviewed changes

jonaslagoni added 3 commits October 18, 2022 16:34

Merge branch 'master-master-upstream' into feature/upgrade_modelina

d71ef84

# Conflicts: # package-lock.json

update packagelock

e199f5c

Merge branch 'master-master-upstream' into feature/upgrade_modelina

cebc2de

# Conflicts: # package-lock.json # package.json

jonaslagoni requested a review from derberg November 16, 2022 11:38

jonaslagoni added 2 commits November 16, 2022 12:41

update package

86bf031

update readme

1ade2cb

jonaslagoni added 3 commits November 21, 2022 19:36

update packagelock

f7b8d1c

Merge branch 'master-master-upstream' into feature/upgrade_modelina

166ee4a

# Conflicts: # package-lock.json

update packagelock

5e44cb4

Merge branch 'master' into feature/upgrade_modelina

10a878d

This was referenced Dec 8, 2022

fix: improve integration with old AsyncAPI parser asyncapi/modelina#1050

Merged

Update Modelina dependency to use next asyncapi/website#949

Closed

jonaslagoni changed the title ~~feat: add support for AsyncAPI 2.5, Python and Rust generator~~ feat: update Modleina to support AsyncAPI 2.5, Python and Rust generator Jan 12, 2023

test

505e945

jonaslagoni changed the title ~~feat: update Modleina to support AsyncAPI 2.5, Python and Rust generator~~ feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator Jan 12, 2023

jonaslagoni added 5 commits January 12, 2023 06:22

fix tests

8f9b179

fix tests

76523c9

add cleanup

8930c73

fix tests

4071039

fixed lint

e97faac

jonaslagoni commented Jan 12, 2023

View reviewed changes

updated tests

3c1cf98

jonaslagoni commented Jan 12, 2023

View reviewed changes

jonaslagoni mentioned this pull request Jan 12, 2023

tests fail in Windows environment #416

Closed

Souvikns previously approved these changes Jan 12, 2023

View reviewed changes

derberg previously approved these changes Jan 12, 2023

View reviewed changes

Merge branch 'master-master-upstream' into feature/upgrade_modelina

6456797

# Conflicts: # package-lock.json

jonaslagoni dismissed stale reviews from derberg and Souvikns via 6456797 January 13, 2023 09:02

jonaslagoni requested review from derberg and Souvikns January 13, 2023 09:20

derberg approved these changes Jan 16, 2023

View reviewed changes

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

asyncapi-bot merged commit e4a5a1d into asyncapi:master Jan 16, 2023

jonaslagoni deleted the feature/upgrade_modelina branch January 16, 2023 08:35

asyncapi-bot added the released label Jan 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator #374

feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator #374

jonaslagoni commented Oct 17, 2022 •

edited

Loading

derberg left a comment

derberg Oct 18, 2022

jonaslagoni Oct 18, 2022

derberg Nov 21, 2022

derberg Nov 21, 2022

jonaslagoni Nov 21, 2022

derberg Nov 26, 2022

jonaslagoni Nov 28, 2022

derberg Dec 12, 2022

jonaslagoni Dec 12, 2022

jonaslagoni commented Nov 16, 2022

derberg commented Nov 16, 2022

jonaslagoni commented Nov 16, 2022

derberg commented Nov 21, 2022

derberg commented Nov 22, 2022

derberg commented Dec 1, 2022

jonaslagoni commented Dec 8, 2022

jonaslagoni commented Jan 11, 2023 •

edited

Loading

jonaslagoni Jan 12, 2023

jonaslagoni Jan 12, 2023 •

edited

Loading

jonaslagoni commented Jan 12, 2023

jonaslagoni commented Jan 13, 2023

sonarqubecloud bot commented Jan 13, 2023

derberg commented Jan 16, 2023

asyncapi-bot commented Jan 16, 2023

feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator #374

feat: update Modelina to support AsyncAPI 2.5, Python and Rust generator #374

Conversation

jonaslagoni commented Oct 17, 2022 • edited Loading

derberg 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonaslagoni commented Nov 16, 2022

derberg commented Nov 16, 2022

jonaslagoni commented Nov 16, 2022

derberg commented Nov 21, 2022

derberg commented Nov 22, 2022

derberg commented Dec 1, 2022

jonaslagoni commented Dec 8, 2022

jonaslagoni commented Jan 11, 2023 • edited Loading

Choose a reason for hiding this comment

jonaslagoni Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

jonaslagoni commented Jan 12, 2023

jonaslagoni commented Jan 13, 2023

sonarqubecloud bot commented Jan 13, 2023

derberg commented Jan 16, 2023

asyncapi-bot commented Jan 16, 2023

jonaslagoni commented Oct 17, 2022 •

edited

Loading

jonaslagoni commented Jan 11, 2023 •

edited

Loading

jonaslagoni Jan 12, 2023 •

edited

Loading