Redocly / Redocly/redoc

preview-docs with Stripe's OpenAPI will hang Firefox

Open
#2,399 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug

Running redocly preview-docs openapi.yaml with the Stripe OpenAPI causes firefox to freeze when I load up the URL in the browser.

To Reproduce
Steps to reproduce the behavior:

  1. Given no config
  2. And this OpenAPI file(s): https://api.apis.guru/v2/specs/stripe.com/2022-11-15/openapi.yaml
  3. Run this command with these arguments: redocly preview-docs openapi.yaml
  4. Open http://127.0.0.1:8080
  5. After a long wait Firefox will ask if you'd like to give up.
Screenshot 2023-08-18 at 5 39 19 PM

Expected behavior

Should load up.

Logs

Redocly Version(s)

1.0.2

Node.js Version(s)

18.15.0

Additional context

Firefox version 116.0.2.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running redocly preview-docs openapi.yaml with the linked Stripe OpenAPI file, then open the local URL in Firefox 116.0.2 to reproduce the hang. Compare the behavior with the reported Redocly and Node.js versions; done means the generated documentation loads without freezing Firefox.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, openapi, typescript
Domain
cli, documentation, frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.