fix: pass file source path to generator for proper $ref resolution#2046
Open
shengxinzhe wants to merge 1 commit intoasyncapi:masterfrom
Open
fix: pass file source path to generator for proper $ref resolution#2046shengxinzhe wants to merge 1 commit intoasyncapi:masterfrom
shengxinzhe wants to merge 1 commit intoasyncapi:masterfrom
Conversation
…syncapi#1839) Since v3.3.0, the generator.service.ts was passing the entire Specification object as the `path` option to generateFromString() instead of the file path string. This caused the @asyncapi/generator to fail when resolving relative $ref references to external files in the same directory. Fix by using asyncapi.getSource() which returns the file path or URL string, consistent with how validation.service.ts already handles this.
shengxinzhe
requested review from
AayushSaini101,
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
🦋 Changeset detectedLatest commit: 271f7e2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1839
Since v3.3.0 (commit c944268), the
GeneratorService.generate()method passes the entireSpecificationobject as thepathoption togenerateFromString(), instead of the file path string. This causes the@asyncapi/generatorto fail when resolving relative$refreferences to external files in the same directory.Before (broken):
After (fixed):
This is consistent with how
ValidationServicealready handles the same scenario (commit 0a8406d fixed it there but the generator was missed).How to test
src/contract/asyncapi.yaml) that references external files in the same directory via$ref:asyncapi generate fromTemplate src/contract/asyncapi.yaml @asyncapi/html-template$refreferences are resolved correctly