Build fails with "Cannot read property 'opId' of undefined"

[wickedest]

Q&A (please complete the following information)

• OS: ubuntu
• Browser: chrome
• Version: 83.0.4103.97
• Method of installation: npm
• Swagger-UI version: 3.26.2
• Swagger/OpenAPI version: Swagger 2.0, OpenAPI 3.0

Content & configuration

Describe the bug you're encountering

Our UI builds suddenly stopped working today, failing at the start of karma tests with the error:

HeadlessChrome 83.0.4103 (Linux 0.0.0) ERROR
  Uncaught TypeError: Cannot read property 'opId' of undefined
  at webpack:///home/jamie/piper/api-builder/node_modules/swagger-ui/dist/swagger-ui.js:8:0 <- test/loadtests.js:269997

I noticed that swagger-ui hadn't changed in a few days, however, swagger-client changed only 7 hours ago. I also noticed this change: e3b3bf0#diff-c85b6c9e099af384a182e638a811c734R4 from July 6th.

Maybe it is possible that the opId change to swagger-client was a breaking change?

To reproduce...

Expected behavior

Screenshots

Additional context or thoughts

[AustinMutschler]

This has also happened to me today. I am on v3.25.0 and this started happening out of no where.

[prashantsingh143]

Our build is also failing:-
Uncaught TypeError: Cannot read property 'opId' of undefined
at Module.eval (swagger-ui.js?9474:8)
at n (swagger-ui.js?9474:1)
at Object.eval (swagger-ui.js?9474:1)
at n (swagger-ui.js?9474:1)
at eval (swagger-ui.js?9474:1)
at eval (swagger-ui.js?9474:1)
at eval (swagger-ui.js?9474:1)
at eval (swagger-ui.js?9474:1)

[bahull]

Same error encountered today when installing codebase on new system

• OS: MacOS Catalina 10.15.2
• Browser: Chrome
  • Version: 83.0.4103.97
• Browser: Safari
  • Version: 13.0.4 (15608.4.9.1.3)
• Method of installation: npm
• Swagger-UI version: 3.22.2

Error:

Uncaught TypeError: Cannot read property 'opId' of undefined
    at Object.<anonymous> (swagger-ui.js:8)
    at __webpack_require__ (swagger-ui.js:1)
    at Object.<anonymous> (swagger-ui.js:8)
    at __webpack_require__ (swagger-ui.js:1)
    at Object.<anonymous> (swagger-ui.js:8)
    at __webpack_require__ (swagger-ui.js:1)
    at Object.<anonymous> (swagger-ui.js:1)
    at __webpack_require__ (swagger-ui.js:1)
    at Object.<anonymous> (swagger-ui.js:1)
    at __webpack_require__ (swagger-ui.js:1)

It appears that when swagger-ui tries to set

var opId = _swaggerClient.helpers.opId;

_swaggerClient.helpers is undefined.

[char0n]

Hello everybody, thanks for letting us know.

Along with already mentioned change in swagger-ui e3b3bf0#diff-c85b6c9e099af384a182e638a811c734R4 we released swagger-client with changes to our build artifacts. We're trying to figure out what is wrong at this point as we made sure new build artifacts are compatible with the old ones.

[char0n]

I could reproduce on simple Create React App setup. The problem is in this line in older version of swagger-ui:

swagger-ui/src/core/containers/OperationContainer.jsx

Line 4 in 3f06bb5

import { helpers } from "swagger-client"

swagger-client never had such an export and this only worked because of the fact that previous build artifact was exported as commonJS which has object-like semantics and support destructuring the same way as basic pojo.

Working on the fix.

[char0n]

swagger-client fixing PR addressing this issue provided here: swagger-api/swagger-js#1631

[char0n]

We've just released swagger-client@3.10.11 that rectifies the issue. Please rerun your build and the problem should autoresolve. If you already have swagger-client@3.10.10 embeded in your package-lock.json or yarn.lock files please uninstall swagger-ui and then install it again.

Again, thanks for reporting this guys!