feat: map schema references from baseUrl to folder

[muenchhausen]

Description

introduce a new cli parameter

--map-base-url <url>:<baseFolder>: maps all schema references with this base url to folder

This can be tested by running

./cli.js test/docs/apiwithref.json @asyncapi/html-template -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/

Related issue(s)
Resolves #512

Open

1. Run the test from above as unit or integration test. How do you want me to implement that? Should I test against cli.js or generator.js?
2. There is a lint Warning in generator.js 92:3: How do you want me to refactor this?

[fmvilas]

I love it! I'd only suggest removing all these console.log before it's merged :)

[magicmatatjahu]

Very good! Please refer to my comments and also, please write some integration tests using examples from your PR in test/docs :)

[magicmatatjahu]

@muenchhausen Answering to your questions:

Run the test from above as unit or integration test. How do you want me to implement that? Should I test against cli.js or generator.js?

You can write test only for Generator class. Please pass mapBaseUrlToFolder property to Generator's constructor, parse given schema with refs and check by some asserts that references are properly parsed :)

There is a lint Warning in generator.js 92:3: How do you want me to refactor this?

If you move new logic from constructor to separate function, it should be fixed.

[derberg]

Please add information about new CLI param to the readme

[derberg]

@muenchhausen please have a look at the failing tests

[muenchhausen]

I did not manage to create an integration test that checks the renedered result for test/docs/apiwithref.json. I got some problems with some mocked libraries - even if I remove some jest.mock. I have the feeling, that integration testing is a sepearate issue.

Here is the test I tried:

const path = require('path');
const Generator = require('../lib/generator');

//jest.mock('../lib/filtersRegistry');
//jest.mock('../lib/hooksRegistry');

describe('Generator', () => {
  describe('#generateFromFile', () => {

    it('test', async () => {
      const gen = new Generator('@asyncapi/html-template', '/Users/z0024p1y/prototypes/generator/build', {
        mapBaseUrlToFolder: 'https://schema.example.com/crm/:./test/docs/',
        forceWrite: true
      });
      await gen.generateFromFile(path.resolve('./test/docs/apiwithref.json'));
    });
  });
});

[magicmatatjahu]

@muenchhausen Hi! Thanks for your work! I see that you have very old revision in tests in your branch:

• master: https://github.com/asyncapi/generator/tree/master/test
• your branch: https://github.com/muenchhausen/generator/tree/map-schema/test

Please update branch and write tests like here https://github.com/asyncapi/generator/blob/master/test/integration.test.js :)

[muenchhausen]

I implemented all suggestions and tested this branch successfully in a company CI. I think I am done again :)

[derberg]

just a comment that this statement will not work with such situation:

ag test/docs/apiwithref.json @asyncapi/html-template -o ./build/ --force-write --map-base-url https://schema.example.com/crm/

because https://schema.example.com/crm/ has : so const re = /(.*):(.*)/g; returns 3 elements and therefor it contunes to work and fails when trying to resolve refs

Something went wrong:
Error: Error downloading https://schema.example.com/crm/shared.json 
getaddrinfo ENOTFOUND schema.example.com
    at dereference (/Users/wookiee/sources/generator/node_modules/@asyncapi/parser/lib/parser.js:155:11)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)

[muenchhausen]

Thanks - good point! I fixed it. Of course it would be better to put cli.js under test.

[derberg]

yeah, we will have all that is needed in the new CLI that will be not only for the generator but also other tools -> https://github.com/asyncapi/cli

this is why we do not invest much in CLI tests here

[derberg]

@muenchhausen I played with this on local and just found this https://github.com/asyncapi/generator/pull/529/files#r629460080. Other than that - great stuff 🎉

@fmvilas @magicmatatjahu have a final look folks

[derberg]

lgtm 🚀

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[fmvilas]

🚀

[asyncapi-bot]

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[derberg]

@all-contributors please add @muenchhausen for code

[allcontributors]

@derberg

I've put up a pull request to add @muenchhausen! 🎉