feat(source-maps): Add `debugIds` option by krystofwoldrich · Pull Request #342 · lynx-family/lynx-stack

krystofwoldrich · 2025-03-25T21:29:53Z

Summary

I've noticed that rspeedy is using SourceMapDevToolPlugin to generate source maps, but it doesn't expose the debugIds option. This option is helpful when debugging production errors as it links correct source map to the correct bundle. More at https://github.com/tc39/ecma426/blob/main/proposals/debug-id.md

I've tried the change locally with a new Lynx project and the debugIds comments are generated as expected above existing sourcemappingurl.

I'm curious if you would be open to add this option and what needs to be done to do so.

Checklist

Tests updated (or not required).
Documentation updated (or not required).

changeset-bot · 2025-03-25T21:29:57Z

🦋 Changeset detected

Latest commit: 783a15d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@lynx-js/rspeedy	Patch
create-rspeedy	Patch
upgrade-rspeedy	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

CLAassistant · 2025-03-25T21:29:59Z

All committers have signed the CLA.

colinaaa

This looks GREAT to me! I’ve added a few comments to better align it with Rspack.

packages/rspeedy/core/src/config/output/index.ts

packages/rspeedy/core/src/plugins/sourcemap.plugin.ts

packages/rspeedy/core/src/plugins/index.ts

krystofwoldrich · 2025-03-26T08:32:38Z

Thank you for the feedback. It makes sense to me as well to align with webpack impl.

I'll also add the tests.

packages/rspeedy/core/src/config/rsbuild/index.ts

Signed-off-by: Qingyu Wang <40660121+colinaaa@users.noreply.github.com>

codecov · 2025-03-27T13:15:27Z

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...kages/rspeedy/core/src/plugins/sourcemap.plugin.ts	0.00%	2 Missing ⚠️
packages/rspeedy/core/src/config/rsbuild/index.ts	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

codecov · 2025-03-27T13:15:37Z

Bundle Report

Bundle size has no change ✅

codspeed-hq · 2025-03-27T13:17:41Z

CodSpeed Performance Report

Merging #342 will not alter performance

_{Comparing krystofwoldrich:add-debug-ids (783a15d) with main (510d850)}

Summary

✅ 1 untouched benchmarks

colinaaa

LGTM! Thanks

Looks like the CI is failing. You need to:

Format the code with pnpm dprint fmt
Update API report with pnpm turbo api-extractor -- --local. See: https://github.com/lynx-family/lynx-stack/blob/main/CONTRIBUTING.md#update-api-references

krystofwoldrich · 2025-03-27T13:45:13Z

@colinaaa Thank you for the help.

✅ formatted the code and updated the API.

colinaaa

Thanks!

packages/rspeedy/core/etc/rspeedy.api.md

…onfigurations and use cspell.jsonc

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @lynx-js/web-constants@0.10.0 ### Minor Changes - feat: rewrite the main thread Element PAPIs ([#343](#343)) In this commit we've rewritten the main thread apis. The most highlighted change is that - Before this commit we send events directly to bts - After this change, we send events to mts then send them to bts with some data combined. ### Patch Changes - feat: The onNapiModulesCall function of lynx-view provides the fourth parameter: `lynxView`, which is the actual lynx-view DOM. ([#350](#350)) - fix: publicComponentEvent args order ([#401](#401)) - Updated dependencies \[[`a521759`](a521759)]: - @lynx-js/web-worker-rpc@0.10.0 ## @lynx-js/web-core@0.10.0 ### Minor Changes - feat: rewrite the main thread Element PAPIs ([#343](#343)) In this commit we've rewritten the main thread apis. The most highlighted change is that - Before this commit we send events directly to bts - After this change, we send events to mts then send them to bts with some data combined. ### Patch Changes - refactor: timing system ([#378](#378)) Now we moved the timing system to the background thread. - feat: support `defaultOverflowVisible` config ([#406](#406)) - fix(web): rsbuild will bundle 2 exactly same chunk for two same `new Worker` stmt ([#372](#372)) the bundle size will be optimized about 28.2KB - fix: inline style will be removed for value number `0` ([#368](#368)) the inline style value could be incorrectly removed for number value `0`; For example, `flex-shrink:0` may be ignored. - feat: The onNapiModulesCall function of lynx-view provides the fourth parameter: `lynxView`, which is the actual lynx-view DOM. ([#350](#350)) - fix: publicComponentEvent args order ([#401](#401)) - Updated dependencies \[[`3a8dabd`](3a8dabd), [`a521759`](a521759), [`890c6c5`](890c6c5)]: - @lynx-js/web-worker-runtime@0.10.0 - @lynx-js/web-constants@0.10.0 - @lynx-js/web-worker-rpc@0.10.0 ## @lynx-js/web-mainthread-apis@0.10.0 ### Minor Changes - feat: rewrite the main thread Element PAPIs ([#343](#343)) In this commit we've rewritten the main thread apis. The most highlighted change is that - Before this commit we send events directly to bts - After this change, we send events to mts then send them to bts with some data combined. ### Patch Changes - feat(web): use pure DOM API to implement Element PAPIs ([#334](#334)) 1. rewrite all element PAPIs impl. Now we use DOM. 2. use our new package `@lynx-js/offscreen-document` to support the new Element PAPI implementation in a worker - fix: inline style will be removed for value number `0` ([#368](#368)) the inline style value could be incorrectly removed for number value `0`; For example, `flex-shrink:0` may be ignored. - fix: publicComponentEvent args order ([#401](#401)) - Updated dependencies \[[`3a8dabd`](3a8dabd), [`a521759`](a521759), [`890c6c5`](890c6c5)]: - @lynx-js/web-constants@0.10.0 ## @lynx-js/web-worker-runtime@0.10.0 ### Minor Changes - feat: rewrite the main thread Element PAPIs ([#343](#343)) In this commit we've rewritten the main thread apis. The most highlighted change is that - Before this commit we send events directly to bts - After this change, we send events to mts then send them to bts with some data combined. ### Patch Changes - Updated dependencies \[[`2a8ddf3`](2a8ddf3), [`3a8dabd`](3a8dabd), [`878050a`](878050a), [`a521759`](a521759), [`890c6c5`](890c6c5)]: - @lynx-js/web-mainthread-apis@0.10.0 - @lynx-js/web-constants@0.10.0 - @lynx-js/web-worker-rpc@0.10.0 ## @lynx-js/react@0.106.2 ### Patch Changes - fix: prevent multiple firstScreen events when reloading before `jsReady` ([#377](#377)) - Optimize the bundle size by eliminating unnecessary code when the lazy bundle is not utilized. ([#284](#284)) ## @lynx-js/rspeedy@0.8.7 ### Patch Changes - Support using `-debugids` in `output.sourceMap.js`. ([#342](#342)) See [Source Map Debug ID Proposal](https://github.com/tc39/ecma426/blob/main/proposals/debug-id.md) for more details. - Use `chunkLoading: 'import-scripts'` for Web platform ([#352](#352)) - Support `output.distPath.*`. ([#366](#366)) See [Rsbuild - distPath](https://rsbuild.dev/config/output/dist-path) for all available options. - Support `performance.printFileSize` ([#336](#336)) Whether to print the file sizes after production build. ## @lynx-js/react-rsbuild-plugin@0.9.4 ### Patch Changes - feat: add extractStr option to pluginReactLynx ([#391](#391)) - Convert background-only files from js to ts ([#346](#346)) - Updated dependencies \[[`f849117`](f849117), [`d730101`](d730101), [`42217c2`](42217c2), [`f03bd4a`](f03bd4a)]: - @lynx-js/react-webpack-plugin@0.6.10 - @lynx-js/template-webpack-plugin@0.6.7 - @lynx-js/react-alias-rsbuild-plugin@0.9.4 - @lynx-js/react-refresh-webpack-plugin@0.3.2 - @lynx-js/css-extract-webpack-plugin@0.5.2 - @lynx-js/web-webpack-plugin@0.6.3 ## @lynx-js/web-elements@0.5.2 ### Patch Changes - fix: When list with list-type: flow, scrolltoupper, scrolltolower were specified, there was a blank block. ([#379](#379)) - fix: do not show scroll bar ([#406](#406)) ## @lynx-js/web-worker-rpc@0.10.0 ### Patch Changes - feat: The onNapiModulesCall function of lynx-view provides the fourth parameter: `lynxView`, which is the actual lynx-view DOM. ([#350](#350)) ## @lynx-js/react-webpack-plugin@0.6.10 ### Patch Changes - feat: add extractStr option to pluginReactLynx ([#391](#391)) - Fix issue with lazy loading of bundles when source maps are enabled. ([#380](#380)) - Fix issue where loading a lazy bundle fails if it does not return a webpack chunk. ([#365](#365)) ## @lynx-js/template-webpack-plugin@0.6.7 ### Patch Changes - fix: merge different chunk groups for same output filename ([#371](#371)) ## create-rspeedy@0.8.7 ## @lynx-js/react-alias-rsbuild-plugin@0.9.4 ## upgrade-rspeedy@0.8.7 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

feat(source-maps): Add debugIds option

2074412

krystofwoldrich requested a review from colinaaa as a code owner March 25, 2025 21:29

colinaaa reviewed Mar 26, 2025

View reviewed changes

packages/rspeedy/core/src/config/output/index.ts Outdated Show resolved Hide resolved

packages/rspeedy/core/src/plugins/sourcemap.plugin.ts Show resolved Hide resolved

packages/rspeedy/core/src/plugins/index.ts Outdated Show resolved Hide resolved

align debugids option with webpack and rsbuild

98c4081

add types and tests

ff2e281

krystofwoldrich commented Mar 27, 2025

View reviewed changes

packages/rspeedy/core/src/config/rsbuild/index.ts Outdated Show resolved Hide resolved

krystofwoldrich requested a review from colinaaa March 27, 2025 12:51

Create cyan-ravens-lie.md

335094f

Signed-off-by: Qingyu Wang <40660121+colinaaa@users.noreply.github.com>

colinaaa previously approved these changes Mar 27, 2025

View reviewed changes

krystofwoldrich added 2 commits March 27, 2025 14:43

fix format and api report

6d97cf4

Merge remote-tracking branch 'origin/add-debug-ids' into add-debug-ids

3187a95

krystofwoldrich dismissed colinaaa’s stale review via 3187a95 March 27, 2025 13:43

colinaaa previously approved these changes Mar 27, 2025

View reviewed changes

colinaaa enabled auto-merge March 27, 2025 13:48

fix: disable cSpell for debugIds option in SourceMap interface

c7724e3

auto-merge was automatically disabled March 27, 2025 14:03
Head branch was pushed to by a user without write access

krystofwoldrich dismissed colinaaa’s stale review via c7724e3 March 27, 2025 14:03

colinaaa reviewed Mar 27, 2025

View reviewed changes

packages/rspeedy/core/etc/rspeedy.api.md Outdated Show resolved Hide resolved

krystofwoldrich added 2 commits March 27, 2025 15:44

refactor: remove cSpell disable comments for debugIds in source map c…

bb9664c

…onfigurations and use cspell.jsonc

Merge remote-tracking branch 'upstream/main' into add-debug-ids

783a15d

colinaaa approved these changes Mar 27, 2025

View reviewed changes

colinaaa enabled auto-merge March 27, 2025 14:53

colinaaa added this pull request to the merge queue Mar 27, 2025

Merged via the queue into lynx-family:main with commit d002876 Mar 27, 2025
21 checks passed

github-actions bot mentioned this pull request Mar 27, 2025

chore: Release 2025-03-31 09:13:17 #357

Merged

Conversation

krystofwoldrich commented Mar 25, 2025 • edited by colinaaa Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

changeset-bot bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

CLAassistant commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

colinaaa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

krystofwoldrich commented Mar 26, 2025

Uh oh!

Uh oh!

codecov bot commented Mar 27, 2025

Codecov Report

Uh oh!

codecov bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Uh oh!

codspeed-hq bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #342 will not alter performance

Summary

Uh oh!

colinaaa left a comment

Choose a reason for hiding this comment

Uh oh!

krystofwoldrich commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

colinaaa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

krystofwoldrich commented Mar 25, 2025 •

edited by colinaaa

Loading

changeset-bot bot commented Mar 25, 2025 •

edited

Loading

CLAassistant commented Mar 25, 2025 •

edited

Loading

codecov bot commented Mar 27, 2025 •

edited

Loading

codspeed-hq bot commented Mar 27, 2025 •

edited

Loading

krystofwoldrich commented Mar 27, 2025 •

edited

Loading