[TT-12195] : Public playground still shows schema when introspection is turned off

jay-deshmukh commented 1 month ago

User description

Description

Schema handling for public playground : Do not show schema by default for public playground

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

[ ] I ensured that the documentation is up to date
[ ] I explained why this PR updates go.mod in detail with reasoning why it's required
[ ] I would like a code coverage CI quality gate exception and have explained why

PR Type

Bug fix

Description

Removed the Schema field from the struct passed to the GraphQL playground template in gateway/api_loader.go.
Updated the GraphiQlInitInstance initialization in templates/playground/index.html to exclude the schema field.
Ensured that the public playground does not show the schema when introspection is turned off.

Changes walkthrough 📝

Relevant files

Bug fix

api_loader.go `Remove schema from GraphQL playground template data` gateway/api_loader.go Removed the `Schema` field from the struct passed to the playground template. Updated the struct to only include `Url` and `PathPrefix`.	+2/-2
index.html `Exclude schema from GraphiQL initialization in playground` templates/playground/index.html Removed the `schema` variable initialization. Updated `GraphiQlInitInstance` initialization to exclude the `schema` field.	+0/-2

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 1 month ago

API Changes

no api changes detected

github-actions[bot] commented 1 month ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

**Possible Bug:** Ensure that removing the schema from the playground does not affect other functionalities that might rely on the schema being present.

github-actions[bot] commented 1 month ago

PR Code Suggestions ✨

Category	Suggestion	Score
Maintainability	Improve struct initialization by explicitly naming the fields ___ The struct initialization in `playgroundTemplate.ExecuteTemplate` should explicitly name the fields to avoid future errors if the struct definition changes. [gateway/api_loader.go [907]](https://github.com/TykTechnologies/tyk/pull/6397/files#diff-cdf0b7f176c9d18e1a314b78ddefc2cb3a94b3de66f1f360174692c915734c68R907-R907) ```diff -{endpoint, path.Join(endpoint, playgroundPath)} +{Url: endpoint, PathPrefix: path.Join(endpoint, playgroundPath)} ``` Suggestion importance[1-10]: 9 Why: Explicitly naming the fields in the struct initialization improves code readability and maintainability, and helps prevent future errors if the struct definition changes.	9
Enhancement	Enhance error handling by logging and providing detailed client responses ___ Consider handling the error from `playgroundTemplate.ExecuteTemplate` more comprehensively by logging the error or providing a more informative response to the client. [gateway/api_loader.go [910]](https://github.com/TykTechnologies/tyk/pull/6397/files#diff-cdf0b7f176c9d18e1a314b78ddefc2cb3a94b3de66f1f360174692c915734c68R910-R910) ```diff if err != nil { - rw.WriteHeader(http.StatusInternalServerError) + log.Printf("Error executing template: %v", err) + http.Error(rw, "Internal Server Error", http.StatusInternalServerError) ``` Suggestion importance[1-10]: 8 Why: Logging the error and providing a detailed response to the client improves debugging and user experience, making the system more robust.	8
Best practice	Add error handling for the JavaScript instance creation to improve robustness ___ Add error handling for the `GraphiqlInit` instance creation to catch and display errors related to initialization or configuration issues. [templates/playground/index.html [78-81]](https://github.com/TykTechnologies/tyk/pull/6397/files#diff-98c2e4a69b270a6e10203409fff11a7ec1253faeaa0c1dd1b5cec5e137dcbf6fR78-R81) ```diff -const GraphiQlInitInstance = new window.GraphiqlInit({ - containerId: 'root', - schemaUrls: [{url}], - onSubscriptionError: window.showError +try { + const GraphiQlInitInstance = new window.GraphiqlInit({ + containerId: 'root', + schemaUrls: [{url}], + onSubscriptionError: window.showError + }); +} catch (error) { + window.showError(error.message); +} ``` Suggestion importance[1-10]: 7 Why: Adding error handling for the `GraphiqlInit` instance creation is a good practice that can help catch and display errors related to initialization or configuration issues, improving the robustness of the code.	7