Feature/playwright #72
Merged
Conversation
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
added 9 commits
March 3, 2025 19:51
nimarb
reviewed
Mar 4, 2025
nimarb
reviewed
Mar 4, 2025
Comment on lines
53
to
109
| it('should fetch GraphQL schema for GraphQL endpoints', async () => { | ||
| const mockSchema = { | ||
| __schema: { | ||
| types: [ | ||
| { name: 'Query', fields: [] } | ||
| ] | ||
| } | ||
| }; | ||
|
|
||
| mockedAxios.get.mockResolvedValueOnce({ data: 'GraphQL API Documentation' }); | ||
| mockedAxios.post.mockResolvedValueOnce({ | ||
| data: { data: mockSchema } | ||
| }); | ||
|
|
||
| const result = await getDocumentation( | ||
| 'https://api.example.com/graphql', | ||
| { 'Authorization': 'Bearer token' }, | ||
| { 'version': '1' } | ||
| ); | ||
|
|
||
| // Verify both documentation and schema were fetched | ||
| expect(mockedAxios.get).toHaveBeenCalledWith('https://api.example.com/graphql'); | ||
| expect(mockedAxios.post).toHaveBeenCalledWith( | ||
| 'https://api.example.com/graphql', | ||
| expect.objectContaining({ | ||
| query: expect.any(String), | ||
| operationName: 'IntrospectionQuery' | ||
| }), | ||
| expect.objectContaining({ | ||
| headers: { 'Authorization': 'Bearer token' }, | ||
| params: { 'version': '1' } | ||
| }) | ||
| ); | ||
| expect(result).toContain(JSON.stringify(mockSchema.__schema)); | ||
| }); | ||
|
|
||
| it('should handle GraphQL schema fetch errors gracefully', async () => { | ||
| const plainDoc = 'GraphQL API Documentation'; | ||
| mockedAxios.get.mockResolvedValueOnce({ data: plainDoc }); | ||
| mockedAxios.post.mockRejectedValueOnce(new Error('GraphQL Error')); | ||
|
|
||
| const result = await getDocumentation('https://api.example.com/graphql', {}, {}); | ||
|
|
||
| expect(result).toBe(plainDoc); | ||
| }); | ||
|
|
||
| it('should handle GraphQL schema errors in response', async () => { | ||
| const plainDoc = 'GraphQL API Documentation'; | ||
| mockedAxios.get.mockResolvedValueOnce({ data: plainDoc }); | ||
| mockedAxios.post.mockResolvedValueOnce({ | ||
| data: { | ||
| errors: [{ message: 'Invalid introspection query' }] | ||
| } | ||
| }); | ||
|
|
||
| const result = await getDocumentation('https://api.example.com/graphql', {}, {}); | ||
|
|
There was a problem hiding this comment.
don't delete gql schema tests
nimarb
reviewed
Mar 4, 2025
Comment on lines
121
to
144
| it('should detect GraphQL endpoints from documentation content', async () => { | ||
| const docWithGraphQL = 'This is a GraphQL API endpoint'; | ||
| const mockSchema = { | ||
| __schema: { | ||
| types: [ | ||
| { name: 'Query', fields: [] } | ||
| ] | ||
| } | ||
| }; | ||
| it('should set custom headers when provided', async () => { | ||
| const headers = { 'Authorization': 'Bearer token' }; | ||
| await getDocumentation('https://api.example.com/docs', headers, {}); | ||
|
|
||
| expect(mockContext.setExtraHTTPHeaders).toHaveBeenCalledWith(headers); | ||
| }); | ||
|
|
||
| mockedAxios.get.mockResolvedValueOnce({ data: docWithGraphQL }); | ||
| mockedAxios.post.mockResolvedValueOnce({ | ||
| data: { data: mockSchema } | ||
| }); | ||
| it('should handle query parameters correctly', async () => { | ||
| const queryParams = { 'version': '1' }; | ||
| await getDocumentation('https://api.example.com/docs', {}, queryParams); | ||
|
|
||
| expect(mockPage.goto).toHaveBeenCalledWith('https://api.example.com/docs?version=1'); | ||
| }); | ||
|
|
||
| const result = await getDocumentation( | ||
| 'https://api.example.com/docs', | ||
| {}, | ||
| {} | ||
| ); | ||
| it('should clean up resources after fetching', async () => { | ||
| await getDocumentation('https://api.example.com/docs', {}, {}); | ||
|
|
||
| expect(mockPage.close).toHaveBeenCalled(); | ||
| expect(mockContext.close).toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| expect(mockedAxios.post).toHaveBeenCalled(); | ||
| expect(result).toContain(docWithGraphQL); | ||
| expect(result).toContain(JSON.stringify(mockSchema.__schema)); |
nimarb
reviewed
Mar 4, 2025
|
|
||
| <script src="/static/ninja/swagger-ui-bundle.ca90216c3f6d.js"></script> | ||
| <script src="/static/ninja/swagger-ui-init.ec666b6c27d3.js"></script> | ||
|
|
||
| </body> |
There was a problem hiding this comment.
i would leave the more complex html here, because it represents reality
nimarb
reviewed
Mar 4, 2025
| <script type="application/json" id="swagger-settings"> | ||
| { | ||
| "url": "https://external-api.com/openapi.json" | ||
| } | ||
| </script> | ||
| <div id="swagger-ui"></div> | ||
| </body> |
nimarb
reviewed
Mar 4, 2025
| <script type="application/json" id="swagger-settings"> | ||
| { | ||
| "url": "/api/v1/openapi.json" | ||
| } | ||
| </script> | ||
| <div id="swagger-ui"></div> | ||
| </body> |
nimarb
approved these changes
Mar 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.