Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/migrate-v1-to-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The minimum supported Node.js version is now `^20.19.0 || >=22.12.0`.

### Upgraded Express to v5

`express`` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details.
`express` has been updated to v5, see [Introducing Express v5: A New Era for the Node.js Framework](https://expressjs.com/2024/10/15/v5-release.html) for details.

### Removed `spdy` support

Expand Down Expand Up @@ -88,6 +88,23 @@ export default {
};
```

### Optional `selfsigned` peer dependency

`selfsigned` is no longer bundled as a direct dependency of `@rspack/dev-server`.

If you use `server.type: "https"` or `"http2"` without providing your own
`server.options.key` and `server.options.cert`, the dev server needs
`selfsigned` to generate a local certificate.

Install it in your project when needed:

```bash
npm i -D selfsigned@^5.0.0
# or pnpm add -D selfsigned@^5.0.0
# or yarn add -D selfsigned@^5.0.0
# or bun add -D selfsigned@^5.0.0
```

### Removed SockJS support (`ws` only)

In v2, the following SockJS options are no longer available:
Expand Down
10 changes: 8 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
"puppeteer": "^24.37.5",
"react-refresh": "0.18.0",
"require-from-string": "^2.0.2",
"selfsigned": "^5.5.0",
"simple-git-hooks": "^2.13.1",
"style-loader": "^4.0.0",
"typescript": "^5.9.3",
Expand All @@ -104,12 +105,17 @@
"launch-editor": "^2.13.1",
"open": "^11.0.0",
"p-retry": "^7.1.1",
"selfsigned": "^5.5.0",
"serve-index": "^1.9.2",
"webpack-dev-middleware": "^7.4.5",
"ws": "^8.19.0"
},
"peerDependencies": {
"@rspack/core": "^2.0.0-0"
"@rspack/core": "^2.0.0-0",
"selfsigned": "^5.0.0"
},
"peerDependenciesMeta": {
"selfsigned": {
"optional": true
}
}
}
6 changes: 3 additions & 3 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 17 additions & 1 deletion src/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -926,7 +926,23 @@ class Server<
if (!certificateExists) {
this.logger.info('Generating SSL certificate...');

const selfsigned = require('selfsigned');
let selfsigned: typeof import('selfsigned');

try {
selfsigned = require('selfsigned');
} catch (error) {
if (
error instanceof Error &&
(error as NodeJS.ErrnoException).code === 'MODULE_NOT_FOUND'
) {
throw new Error(
'Cannot generate a self-signed certificate because optional peer dependency `selfsigned@^5.0.0` is not installed. Please install it and try again.',
);
}

throw error;
}

const attributes = [{ name: 'commonName', value: 'localhost' }];
const notBeforeDate = new Date();
const notAfterDate = new Date(notBeforeDate);
Expand Down