Skip to content

vzip-patch requires queue but it may not be available #23

@wilkinsona

Description

@wilkinsona

Upgrading Spring Boot's dependency on @antora/site-generator from 3.2.0-alpha.4 to 3.2.0-alpha.9 results in a failure:

> Task :documentation:spring-boot-docs:antora FAILED
[11:09:50.871] FATAL (antora): Cannot find module 'queue'
Require stack:
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@springio/antora-zip-contents-collector-extension/lib/util/vzip-patch.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@springio/antora-zip-contents-collector-extension/lib/index.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/site-generator/node_modules/@antora/user-require-helper/lib/index.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/site-generator/lib/generator-context.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/site-generator/lib/generate-site.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/site-generator/lib/index.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/cli/lib/cli.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/cli/lib/index.js
- /Users/aw036093/dev/spring-projects/spring-boot/main/documentation/spring-boot-docs/build/.gradle/nodeproject/node_modules/@antora/cli/bin/antora
Add the --stacktrace option to see the cause of the error.

vzip-patch.js requires queue:

My guess is that it used to be available transitively through an Antora-related dependency and that the transitive dependency is no longer there following the upgrade. As a result, the module's now missing and Antora fails.

The path to queue appears to be @antora/ui-loader (3.1.4) -> gulp-vinyl-zip (2.5.0) -> queue. ui-loader swapped out its dependency on gulp-vinyl-zip in this commit that landed in 3.2.0-alpha.5. I think this explains why it works with 3.2.0-alpha.4.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions