feat: add a traverse schema function

[jonaslagoni]

Description

The PR contains the following updates

• Exposed a traverseSchema function
• Split out the mark recursive functionality
• Added test to the traverseSchema function
• Added special iterator type to include certain schemas
• Revisited all the code which recursively tries to access schemas

Related issue(s)
Fixes #166

[derberg]

@jonaslagoni awesome you picked it up. Let me know once you are ready for some hands on, I'd like to test it on the template for templates, and basically remove https://github.com/asyncapi/template-for-generator-templates/blob/main/filters/mermaidDiagram.js#L75-L177

[jonaslagoni]

Hmm, this is not as straight forward as I first assumed since it is implemented with markcircular on the previous schema not the currently crawled schema. And its not possible to directly overwrite the schema because of the nature of JavaScript passes objects as copy of a reference, have to do some sort of recursive overwrite in that case 🤔

[derberg]

@jonaslagoni oh yes, I think some refactor might be needed, not trivial one, this is why I've put it here and didn't work on it immediately

[magicmatatjahu]

Awesome! I only have a suggestion to change cb name to more verbose callback :)

[derberg]

@jonaslagoni I'll give it a try in template for templates. I'll keep ya posted

[derberg]

so far I'm running it locally without introduction any changes to template, like this:

../generator/cli.js https://raw.githubusercontent.com/asyncapi/generator/v1.0.1/test/docs/dummy.yml ./ -o output

• where ../generator/cli.js points to my local generator with parser pointing to your fork
• where ./ indicates I use local template which is template for templates

I get this error:

tl;dr property of type string, inside object, doesn't get anonymousId assigned

Something went wrong:
Template render error: (/Users/wookiee/sources/generator/node_modules/template-for-generator-templates/template/index.html)
  Template render error: (/Users/wookiee/sources/generator/node_modules/template-for-generator-templates/partials/diagramContent.html) [Line 13, Column 48]
  TypeError: Cannot read property 'startsWith' of undefined
    at Object._prettifyError (/Users/wookiee/sources/generator/node_modules/nunjucks/src/lib.js:36:11)
    at /Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:561:19
    at eval (eval at _compile (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:631:18), <anonymous>:49:11)
    at /Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:569:11
    at Template.root [as rootRenderFunc] (eval at _compile (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:631:18), <anonymous>:63:3)
    at Template.render (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:550:10)
    at eval (eval at _compile (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:631:18), <anonymous>:48:10)
    at fn (/Users/wookiee/sources/generator/node_modules/a-sync-waterfall/index.js:26:24)
    at /Users/wookiee/sources/generator/node_modules/a-sync-waterfall/index.js:66:22
    at executeSync (/Users/wookiee/sources/generator/node_modules/a-sync-waterfall/index.js:8:15)
    at /Users/wookiee/sources/generator/node_modules/a-sync-waterfall/index.js:65:11
    at eval (eval at _compile (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:631:18), <anonymous>:44:1)
    at createTemplate (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:313:9)
    at handle (/Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:325:11)
    at /Users/wookiee/sources/generator/node_modules/nunjucks/src/environment.js:337:9
    at next (/Users/wookiee/sources/generator/node_modules/nunjucks/src/lib.js:280:7)

Of cource when I try the same with latest generator, all is good. Something is wrong here https://github.com/asyncapi/template-for-generator-templates/blob/main/filters/mermaidDiagram.js#L13. There is a moment when https://github.com/asyncapi/template-for-generator-templates/blob/main/filters/mermaidDiagram.js#L35 gets undefined in propSchemaId. I narrowed it down that problem is with this prop dummyRecursiveProp2 from dummyRecursiveObject schema, it doesn't get anonymousId assigned at all.

I hope this helps. I did not check where exactly is the problem on your side but this investigation should make it easier to find

[jonaslagoni]

There is a moment when https://github.com/asyncapi/template-for-generator-templates/blob/main/filters/mermaidDiagram.js#L35 gets undefined in propSchemaId. I narrowed it down that problem is with this prop dummyRecursiveProp2 from dummyRecursiveObject schema, it doesn't get anonymousId assigned at all.

Found the issue, creating some tests and then pushing the change.

[jonaslagoni]

@derberg done. Tried testing it with your document and it seems to work. return is a dangerous thing inside a loop that should continue 🙄

[derberg]

• I wonder if we could get schemaTypesToIterate also into API docs, like have a list of supported types?
• I get strange results after your changes, results in diagram. Below you can find diagram before and after your change. Look at dummyObject.
  After:

Before:

dummyObject.dummyObjectProp2 is a reference to dummyRecursiveObject, and we know dummyRecursiveObject has recursive property so dummyObject should also list dummyObjectProp2 as circular prop, right? or my thinking is stupid as then it would mean dummyCreated also should list dummyObject as circular prop . Ok, I think you mixed bug with this PR 😄

ok, after checking with html template, I'm now actually sure you fixed a bug 👏
Before:

After:

---

Now I will focus on checking if I can actually use this new function to refactor my filter

[derberg]

now this is what I call a good feature - when by using it I add just one line and remove 108 -> https://github.com/asyncapi/template-for-generator-templates/pull/5/files 👏

I only shared my concerns about jsdocs, that there is one small error I think, and that those special types you added are not represented in jsdoc

[jonaslagoni]

@derberg sorry for requesting review before fixing the lint errors. It is ready now 😄

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[derberg]

Awesome work man!
Let us not merge yet, I want to first fix the issue with twitter action to not tweet again that it this feature was done by the bot 😄
I'll work on it today

[derberg]

@jonaslagoni I'm almost done with #208, one repo left to get pr testing there with mandatory option. I want to merge it first too because we will be able to test with your feature how the automated bump works 😄

[jonaslagoni]

@jonaslagoni I'm almost done with #208, one repo left to get pr testing there with mandatory option. I want to merge it first too because we will be able to test with your feature how the automated bump works 😄

Sounds good 👍

[asyncapi-bot]

🎉 This PR is included in version 1.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀