fix: circular reference issue resolved #2538
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -104,6 +104,19 @@ describe('mocker', () => { | |
| }, | ||
| ], | ||
| }, | ||
| { | ||
| id: '500', | ||
| code: '500', | ||
| headers: [], | ||
| contents: [ | ||
| { | ||
| id: 'contents', | ||
| mediaType: 'application/json', | ||
| examples: [{ id: 'example-1', key: 'internalServerError', value: { message: 'Internal Server Error' } }], | ||
| encodings: [], | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
|
|
@@ -676,5 +689,142 @@ describe('mocker', () => { | |
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('should return 500 error', () => { | ||
| it('returns a 500 error response', () => { | ||
| jest.spyOn(helpers, 'negotiateOptionsForInvalidRequest').mockReturnValue( | ||
| right({ | ||
| code: '500', | ||
| mediaType: 'application/json', | ||
| bodyExample: mockResource.responses[3].contents![0].examples![0], | ||
| headers: [], | ||
| }) | ||
| ); | ||
| const mockResult = mock({ | ||
| config: { dynamic: false }, | ||
| resource: mockResource, | ||
| input: Object.assign({}, mockInput, { | ||
| validations: [{ severity: DiagnosticSeverity.Error }], | ||
| }), | ||
| })(logger); | ||
| assertRight(mockResult, result => { | ||
| expect(result).toMatchObject({ | ||
| statusCode: 500, | ||
| body: { message: 'Internal Server Error' }, | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('With __bundled__ should get response', () => { | ||
|
There was a problem hiding this comment. This test is passing with and without your changes so it still doesn't seem to be testing the initial bug you were seeing / the fix hasn't changed anything. It should be removed or changed to properly capture the issue you are seeing and fixing. We have test harness tests for circular references and those have been passing in the pipeline so it seems like circular references are getting resolved in most cases. Maybe a test harness test for the specific scenario that is causing you not to see circular references get resolved would help demonstrate the issue a bit better. |
||
| it('With __bundled__ should get response', () => { | ||
| const BundledResource: IHttpOperation = { | ||
| ...mockResource, | ||
| // @ts-ignore - Requires update in @stoplight/types to allow for '__bundled__' | ||
| __bundled__: { | ||
| properties: { | ||
| id: { | ||
| type: 'integer', | ||
| description: 'Unique identifier for the given user.', | ||
| }, | ||
| name: { | ||
| type: 'string', | ||
| }, | ||
| surname: { | ||
| type: 'string', | ||
| }, | ||
| user: { | ||
| title: 'User', | ||
| type: 'object', | ||
| examples: [ | ||
| { | ||
| id: 142, | ||
| name: 'Alice', | ||
| surname: 'Smith', | ||
| }, | ||
| ], | ||
| required: ['id', 'name', 'surname'], | ||
| properties: { | ||
| $ref: '#/__bundled__/properties', | ||
| }, | ||
| }, | ||
| test: { | ||
| title: 'Test', | ||
| type: 'object', | ||
| properties: { | ||
| id: { | ||
| type: 'string', | ||
| }, | ||
| user: { | ||
| title: 'User', | ||
| type: 'object', | ||
| examples: [ | ||
| { | ||
| id: 142, | ||
| name: 'Alice', | ||
| surname: 'Smith', | ||
| }, | ||
| ], | ||
| required: ['id', 'name', 'surname'], | ||
| properties: { | ||
| $ref: '#/__bundled__/properties', | ||
| }, | ||
| }, | ||
| test: { | ||
| title: 'Test', | ||
| type: 'object', | ||
| properties: { | ||
| $ref: '#/__bundled__/properties_2', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| properties_2: { | ||
| id: { | ||
| type: 'string', | ||
| }, | ||
| user: { | ||
| title: 'User', | ||
| type: 'object', | ||
| examples: [ | ||
| { | ||
| id: 142, | ||
| name: 'Alice', | ||
| surname: 'Smith', | ||
| }, | ||
| ], | ||
| required: ['id', 'name', 'surname'], | ||
| properties: { | ||
| $ref: '#/__bundled__/properties', | ||
| }, | ||
| }, | ||
| test: { | ||
| title: 'Test', | ||
| type: 'object', | ||
| properties: { | ||
| $ref: '#/__bundled__/properties_2', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const mockResult = mock({ | ||
| config: { dynamic: true }, | ||
| resource: BundledResource, | ||
| input: mockInput, | ||
| })(logger); | ||
| assertRight(mockResult, result => { | ||
| expect(result).toMatchObject({ | ||
| statusCode: 200, | ||
| }); | ||
| expect(result).toHaveProperty('body', { | ||
| name: expect.any(String), | ||
| surname: expect.any(String), | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
| }); | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test does not seem relevant to this PR. Could you please add a test that covers the original circular reference problem and show that it is no longer throwing a 500?