Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove hapi-swagger, use static json #396

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Remove hapi-swagger, use static json #396

merged 2 commits into from
Nov 27, 2024

Conversation

sauntimo
Copy link
Contributor

@sauntimo sauntimo commented Nov 22, 2024

✏️ Changes

  • hapi-swagger was causing an issue with conflicting versions of joi, which it requires as a subdependency vs the version of joi used by the main project.
  • this PR removes hapi-swagger as a dependency, instead storing it's output as a static json file in the repo. This is deemed to be suitable as there is no intention to modify the API of the extension in future, but it should be noted that if we ever did, we'd need to manually update that JSON file in order to update the API explorer.

📷 Screenshots

  • Tested in prod-us-4 using joi@17.12.2
    image

  • Test in prod-jp-1 using joi@17.12.2
    image

🔗 References

🎯 Testing

  • Follow the instructions documented elsewhere to build the extensions locally with the dev branch of auth0-exentsions-cli
  • upload to /extensions/deploy using the extensions-deployment tool
  • install the authz-extension in a prod tenant using the chrome overrides hack for extensions.json and extensions-gallery
  • open the extension and use chrome overrides to override the html page to replace the path of the assets with /extensions/develop
  • navigate to the API explorer and check if it works or errors

✅ This change has been tested in a Webtask

🚫 This change has unit test coverage

🚫 This change has integration test coverage

🚫 This change has been tested for performance

🚀 Deployment

✅ This can be deployed any time

🎡 Rollout

In order to verify that the deployment was successful we will deploy the extensions in /extensions/develop and test in a prod tenant

🔥 Rollback

We will rollback if we encounter any issues

📄 Procedure

  • if the extension update is released, we'll follow the recovery plan

@sauntimo sauntimo marked this pull request as ready for review November 22, 2024 15:06
@sauntimo sauntimo self-assigned this Nov 22, 2024
fbgoode
fbgoode previously approved these changes Nov 25, 2024
@sauntimo sauntimo merged commit 2183fcc into master Nov 27, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants