build(client-utils): use export map instead of 'browser' field #20665
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tylerbutler
reviewed
Apr 15, 2024
tylerbutler
reviewed
Apr 15, 2024
| "require": { | ||
| "types": "./dist/bufferBrowser.d.ts", | ||
| "default": "./dist/bufferBrowser.js" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "main": "lib/indexNode.js", | ||
| "browser": { |
There was a problem hiding this comment.
Can we delete this altogether?
There was a problem hiding this comment.
CloudPack doesn't use it. If it passes our Jest tests, I think we're good to go.
DLehenbauer
changed the title
github-actions
bot
added
the
area: framework
DLehenbauer
commented
Apr 15, 2024
| @@ -3,7 +3,8 @@ | |||
| * Licensed under the MIT License. | |||
| */ | |||
|
|
|||
| import { IsoBuffer } from "./indexNode.js"; | |||
| // Note: The exports map in package.json will correct this import to "./bufferNode.js" in node environments | |||
| import { IsoBuffer } from "./bufferBrowser.js"; | |||
There was a problem hiding this comment.
Note: changed to 'bufferBrowser.js' instead of 'indexBrowser.js' to avoid import cycle.
tylerbutler
approved these changes
Apr 15, 2024
jason-ha
reviewed
May 4, 2024
Comment on lines
-28
to
-33
| "browser": { | ||
| "./dist/indexNode.js": "./dist/indexBrowser.js", | ||
| "./dist/indexNode.d.ts": "./dist/indexBrowser.d.ts", | ||
| "./lib/indexNode.js": "./lib/indexBrowser.js", | ||
| "./lib/indexNode.d.ts": "./lib/indexBrowser.d.ts" | ||
| }, |
There was a problem hiding this comment.
Removing these means any uses of indexNode.js will not be redirected to indexBrowser.js. trace.ts uses indexNode.js; so, that needs corrected.
Comment on lines
-28
to
-33
| "browser": { | ||
| "./dist/indexNode.js": "./dist/indexBrowser.js", | ||
| "./dist/indexNode.d.ts": "./dist/indexBrowser.d.ts", | ||
| "./lib/indexNode.js": "./lib/indexBrowser.js", | ||
| "./lib/indexNode.d.ts": "./lib/indexBrowser.d.ts" | ||
| }, |
There was a problem hiding this comment.
This is also replicated in src/cjs/package.json that is needed for webpack (with CJS). AB#7374 would help avoid getting out of sync.
scottn12
pushed a commit
to scottn12/FluidFramework
that referenced
this pull request
Jun 5, 2024
…soft#20665) Previously, we used [the 'browser' field](https://github.com/defunctzombie/package-browser-field-spec) to implement different entry points for browser vs. node. This field does not appear to be supported by CloudPack. Instead, we now use [conditional exports](https://nodejs.org/docs/latest-v18.x/api/packages.html#conditional-exports) in the export map.
scottn12
pushed a commit
to scottn12/FluidFramework
that referenced
this pull request
Jun 5, 2024
…soft#20665) Previously, we used [the 'browser' field](https://github.com/defunctzombie/package-browser-field-spec) to implement different entry points for browser vs. node. This field does not appear to be supported by CloudPack. Instead, we now use [conditional exports](https://nodejs.org/docs/latest-v18.x/api/packages.html#conditional-exports) in the export map.
scottn12
pushed a commit
to scottn12/FluidFramework
that referenced
this pull request
Jun 5, 2024
…soft#20665) Previously, we used [the 'browser' field](https://github.com/defunctzombie/package-browser-field-spec) to implement different entry points for browser vs. node. This field does not appear to be supported by CloudPack. Instead, we now use [conditional exports](https://nodejs.org/docs/latest-v18.x/api/packages.html#conditional-exports) in the export map.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we used the 'browser' field to implement different entry points for browser vs. node.
This field does not appear to be supported by CloudPack. Instead, we now use conditional exports in the export map.