redoc-cli: ReferenceError: URL is not defined

Created on 13 May 2019 · 30Comments · Source: Redocly/redoc

Hi there!

There seems to be an issue with redoc-cli ATM.

Noticed it with one of our docs, but can be reproduced using the demo/swagger.yaml file from this repository:

$> yarn add redoc-cli
$> ./node_modules/.bin/redoc-cli bundle -o './redoc-test' demo/swagger.yaml
[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0
Prerendering docs
ReferenceError: URL is not defined
    at removeQueryString (/tmp/node_modules/redoc/bundles/redoc.lib.js:6940:15)
    at /tmp/node_modules/redoc/bundles/redoc.lib.js:11055:137
    at Array.map (<anonymous>)
    at Object.children (/tmp/node_modules/redoc/bundles/redoc.lib.js:11051:104)
    at ReactDOMServerRenderer.render (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3412:55)
    at ReactDOMServerRenderer.read (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29)
    at Object.renderToString (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3646:27)
    at /tmp/node_modules/redoc-cli/index.js:189:29
    at Generator.next (<anonymous>)
    at fulfilled (/tmp/node_modules/redoc-cli/index.js:5:58)

$> nodejs --version
v8.10.0
$> yarn --version
1.13.0

Source

srats

👍1

Most helpful comment

Does it work now?

xuleijian on 13 May 2019

👀1 🚀1 ❤1 😕1 🎉1 😄1 👎1 👍1

All 30 comments

it was working 2 days ago... now i got the same error...
I was using npx like:

npx redoc-cli bundle --output deploy/api/index.html deploy/swagger.yaml

[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0 Prerendering docs ReferenceError: URL is not defined at removeQueryString (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:6940:19) at /usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11055:137 at Array.map (native) at Object.children (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11051:104) at ReactDOMServerRenderer.render (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3412:55) at ReactDOMServerRenderer.read (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29) at Object.renderToString (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3646:27) at /usr/local/lib/node_modules/redoc-cli/index.js:189:29 at Generator.next (<anonymous>) at fulfilled (/usr/local/lib/node_modules/redoc-cli/index.js:5:58)

[email protected]
node version 8.x

gabrielm0 on 13 May 2019

Could you try the same with node 10.x?

RomanHotsiy on 13 May 2019

i got a different error using node 10:

npx -p node@10 redoc-cli bundle --output deploy/api/index.html deploy/swagger.yaml

[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0 Prerendering docs TypeError [ERR_INVALID_URL]: Invalid URL: at onParseError (internal/url.js:241:17) at new URL (internal/url.js:319:5) at removeQueryString (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:6940:15) at /usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11055:137 at Array.map (<anonymous>) at Object.children (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11051:104) at ReactDOMServerRenderer.render (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3412:55) at ReactDOMServerRenderer.read (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29) at Object.renderToString (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3646:27) at /usr/local/lib/node_modules/redoc-cli/index.js:189:29

gabrielm0 on 13 May 2019

Thanks. Working on a fix!

RomanHotsiy on 13 May 2019

👍4

Downgrading to v2.0.0-rc.4 fixes the issue.

qzb on 13 May 2019

rc.7 is coming with the fix

RomanHotsiy on 13 May 2019

Should be fixed now. @srats could you please confirm.
Thanks in advance!

RomanHotsiy on 13 May 2019

Still having the same issue.

From yarn.lock file:

redoc@^2.0.0-rc.4:
  version "2.0.0-rc.7"
  resolved "https://registry.yarnpkg.com/redoc/-/redoc-2.0.0-rc.7.tgz#ef27c64ea9fbc0aa5b1135dc85d59b64eef87396"
  integrity sha512-+2OPuEuUDzwt/R6ZXpBuCMy7aCo0k2pQKfOHq6eG+84QO9+y0ASr91WGmaHUtsvDaItsyrfmhW35NjXIbps2ug==

$> ./node_modules/.bin/redoc-cli bundle -o './redoc-test' demo/swagger.yaml
[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0
Prerendering docs
ReferenceError: URL is not defined
    at parseURL (/tmp/node_modules/redoc/bundles/redoc.lib.js:6950:9)
    at removeQueryString (/tmp/node_modules/redoc/bundles/redoc.lib.js:6940:15)
    at /tmp/node_modules/redoc/bundles/redoc.lib.js:11064:137
    at Array.map (<anonymous>)
    at Object.children (/tmp/node_modules/redoc/bundles/redoc.lib.js:11060:104)
    at ReactDOMServerRenderer.render (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3412:55)
    at ReactDOMServerRenderer.read (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29)
    at Object.renderToString (/tmp/node_modules/react-dom/cjs/react-dom-server.node.development.js:3646:27)
    at /tmp/node_modules/redoc-cli/index.js:189:29
    at Generator.next (<anonymous>)

srats on 13 May 2019

🤦‍♂ my mistake...

rc.8 is coming

RomanHotsiy on 13 May 2019

It works with nodejs 10 now, BTW.

srats on 13 May 2019

🎉1

@srats could you try it now with rc.8?

RomanHotsiy on 13 May 2019

  version "2.0.0-rc.8"
  resolved "https://registry.yarnpkg.com/redoc/-/redoc-2.0.0-rc.8.tgz#46fb40900a04f2438cabd973181860323e1ee7de"
  integrity sha512-DpPa/rAUoSDYWGk5k/i0KUoRPrj62WKmbffHmS+c7zZGmFjtzVMpUzwrxrs3Dmf+u1t4YGw5wuhyq2p7qSlhsQ==

Works fine with nodejs 8, thanks :)

srats on 13 May 2019

🎉1

Why package number on npmjs is still rc7? https://www.npmjs.com/package/redoc
rc8 marked as «next» :thinking:

pohmelie on 13 May 2019

node version 10.8.0
redoc version 2.0.0-rc.8
redoc-cli version 0.8.3

TypeError [ERR_INVALID_URL]: Invalid URL:
at onParseError (internal/url.js:237:17)
at parse (internal/url.js:246:3)
at new URL (internal/url.js:321:5)
at parseURL (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:6950:16)
at removeQueryString (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:6940:15)
at /usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11064:137
at Array.map ()
at Object.children (/usr/local/lib/node_modules/redoc-cli/node_modules/redoc/bundles/redoc.lib.js:11060:104)
at ReactDOMServerRenderer.render (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3412:55)
at ReactDOMServerRenderer.read (/usr/local/lib/node_modules/redoc-cli/node_modules/react-dom/cjs/react-dom-server.node.development.js:3161:29)

kevintsengtw on 13 May 2019

👍2

Why package number on npmjs is still rc7

Fixed to rc.8

RomanHotsiy on 13 May 2019

got the same error...
node version v10.15.3
redoc-cli version 0.8.3

Prerendering docs
TypeError [ERR_INVALID_URL]: Invalid URL: /v1
at onParseError (internal/url.js:241:17)
at new URL (internal/url.js:319:5)
at parseURL (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\redoc\bundles\redoc.lib.js:6950:16)
at removeQueryString (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\redoc\bundles\redoc.lib.js:6940:15)
at C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\redoc\bundles\redoc.lib.js:11064:137
at Array.map ()
at Object.children (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\redoc\bundles\redoc.lib.js:11060:104)
at ReactDOMServerRenderer.render (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\react-dom\cjs\react-dom-server.node.development.js:3412:55)
at ReactDOMServerRenderer.read (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\react-dom\cjs\react-dom-server.node.development.js:3161:29)
at Object.renderToString (C:\Users\A11180221040052\AppData\Roaming\npm\node_modules\redoc-cli\node_modules\react-dom\cjs\react-dom-server.node.development.js:3646:27)

zhangwbgogogo on 13 May 2019

👍5

Does it work now?

xuleijian on 13 May 2019

👀1 🚀1 ❤1 😕1 🎉1 😄1 👎1 👍1

@kevintsengtw, @zhangwbgogogo could you share your spec servers if you use OpenAPI v3 or host, basePath and schemes if using OpenAPI 2

RomanHotsiy on 13 May 2019

@RomanGotsiy
I have same issue and have no servers field in spec (openapi v3)

pohmelie on 13 May 2019

👍3

@RomanGotsiy Just ran

redoc-cli bundle swagger.yaml

zhangwbgogogo on 13 May 2019

🚀1 🎉1

Should be fixed now with rc.8-1

RomanHotsiy on 13 May 2019

I also bumped redoc-cli version to 0.8.4

Could you guys verify it is working now? Thanks

RomanHotsiy on 13 May 2019

This seems to be working correctly for me now. Thanks @RomanGotsiy!

AnthonyPorthouse on 13 May 2019

@pohmelie @zhangwbgogogo @kevintsengtw ?

RomanHotsiy on 13 May 2019

it's working now! thank you @RomanGotsiy!

gabrielm0 on 13 May 2019

🎉

RomanHotsiy on 13 May 2019

🎉3

@RomanGotsiy
Works fine now, thank you!

pohmelie on 13 May 2019

🎉1

@RomanGotsiy
Works fine, thank you!

xuleijian on 14 May 2019

it's working now! thanks

zhangwbgogogo on 14 May 2019

@RomanGotsiy
[email protected]
[email protected]
Works fine now, thanks

kevintsengtw on 14 May 2019

Was this page helpful?

0 / 5 - 0 ratings

Related issues

Description of array items is not appeared on response.

zmes50416 · 3Comments

Provide versioning support for APIs?

gauravmokhasi · 4Comments

Feature request: Ability to hide internal paths, operations, parameters etc.

shreyas-agnihotri · 3Comments

Redoc UI/UX

skllcrn · 3Comments

Support for vue.js

bmarwell · 3Comments