ESM CJS builds #5904

jdevcs · 2023-03-08T11:43:25Z

Description

#5241

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist for 1.x:

Checklist for 4.x:

codecov · 2023-03-08T12:05:33Z

Codecov Report

Merging #5904 (3573c8a) into 4.x (dd33e17) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##              4.x    #5904      +/-   ##
==========================================
+ Coverage   82.14%   82.15%   +0.01%     
==========================================
  Files         137      137              
  Lines        5981     5985       +4     
  Branches     1572     1576       +4     
==========================================
+ Hits         4913     4917       +4     
  Misses       1068     1068

Flag	Coverage Δ
UnitTests	`82.15% <100.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
web3	`∅ <ø> (∅)`
web3-core	`∅ <ø> (∅)`
web3-errors	`∅ <ø> (∅)`
web3-eth	`∅ <ø> (∅)`
web3-eth-abi	`∅ <ø> (∅)`
web3-eth-accounts	`∅ <ø> (∅)`
web3-eth-contract	`∅ <ø> (∅)`
web3-eth-ens	`∅ <ø> (∅)`
web3-eth-iban	`∅ <ø> (∅)`
web3-eth-personal	`∅ <ø> (∅)`
web3-net	`∅ <ø> (∅)`
web3-providers-http	`∅ <ø> (∅)`
web3-providers-ipc	`∅ <ø> (∅)`
web3-providers-ws	`∅ <ø> (∅)`
web3-rpc-methods	`∅ <ø> (∅)`
web3-utils	`∅ <ø> (∅)`
web3-validator	`∅ <ø> (∅)`

github-actions · 2023-03-09T15:49:32Z

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset	Old size	New size	Diff	Diff %
Total	1.06 MB	1.06 MB	-1.34 KB	-0.12%

View detailed bundle breakdown

Added

Asset	New size	Diff	Diff %
../lib/commonjs/accounts.d.ts	3.39 KB	3.39 KB	-
../lib/commonjs/types.d.ts	1.64 KB	1.64 KB	-
../lib/commonjs/abi.d.ts	966 bytes	966 bytes	-
../lib/commonjs/index.d.ts	864 bytes	864 bytes	-
../lib/commonjs/web3.d.ts	808 bytes	808 bytes	-
../lib/commonjs/eth.exports.d.ts	280 bytes	280 bytes	-
../lib/commonjs/providers.exports.d.ts	191 bytes	191 bytes	-
../lib/commonjs/version.d.ts	60 bytes	60 bytes	-

Removed

Asset	Old size	Diff	Diff %
../lib/accounts.d.ts	3.42 KB	-3.42 KB	-100.00%
../lib/types.d.ts	1.68 KB	-1.68 KB	-100.00%
../lib/types.d.ts.map	1.51 KB	-1.51 KB	-100.00%
../lib/abi.d.ts	999 bytes	-999 bytes	-100.00%
../lib/index.d.ts.map	919 bytes	-919 bytes	-100.00%
../lib/index.d.ts	899 bytes	-899 bytes	-100.00%
../lib/web3.d.ts	842 bytes	-842 bytes	-100.00%
../lib/web3.d.ts.map	694 bytes	-694 bytes	-100.00%
../lib/accounts.d.ts.map	528 bytes	-528 bytes	-100.00%
../lib/eth.exports.d.ts.map	358 bytes	-358 bytes	-100.00%
../lib/eth.exports.d.ts	321 bytes	-321 bytes	-100.00%
../lib/providers.exports.d.ts.map	292 bytes	-292 bytes	-100.00%
../lib/providers.exports.d.ts	238 bytes	-238 bytes	-100.00%
../lib/version.d.ts.map	140 bytes	-140 bytes	-100.00%
../lib/abi.d.ts.map	124 bytes	-124 bytes	-100.00%
../lib/version.d.ts	97 bytes	-97 bytes	-100.00%

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	Old size	New size	Diff	Diff %
web3.min.js	1.05 MB	1.05 MB	3.45 KB	0.32%

cloudflare-workers-and-pages · 2023-03-13T14:06:34Z

Deploying with Cloudflare Pages

Latest commit:	`3573c8a`
Status:	✅ Deploy successful!
Preview URL:	https://fb4a71c4.web3-js-docs.pages.dev
Branch Preview URL:	https://junaid-5241esmcjsbuilds.web3-js-docs.pages.dev

View logs

jdevcs · 2023-03-15T15:18:55Z

node users will need to use --experimental-specifier-resolution=node if they want to use our ESM builds, as we are not importing files in our packages with file extension. (This is for ESM node apps, using our ESM build )

jdevcs · 2023-03-21T21:08:48Z

packages/web3-eth-accounts/src/account.ts

@@ -15,7 +15,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */

-import { TransactionFactory, TypedTransaction } from '@ethereumjs/tx';
+import { TypedTransaction } from '@ethereumjs/tx';
+import defaultImport, * as fullImport from '@ethereumjs/tx';


While local testing in ESM app and importing web3 ESM build there was problem in importing TransactionFactory from @ethereumjs/tx, reason with ESM @ethereumjs/tx is not exposing named export but exporting under default but with CJS @ethereumjs/tx is exporting it with named export. Following fix is applied in eth and accounts package and it imports both default and all ( named + default ) making sure that we will not miss TransactionFactory in either esm or cjs.

This export problem is fixed in @ethereumjs/tx in 4.x and we can upgrade to that in our 4.x after reviewing breaking changes in another PR.

Hmm maybe you should try again, now that types are first in export. Maybe also publish repro repo^^

It isnt issue in web3 exporting, but in ethereumjs/tx lib. I tested in another proj as well.

jdevcs · 2023-03-22T11:52:55Z

tsconfig.base.json

@@ -3,8 +3,6 @@
 		"resolveJsonModule": true,
 		"forceConsistentCasingInFileNames": true,
 		"target": "es2016",
-		"module": "commonjs",


Now we have base config for building in root with common configuration items.

jdevcs · 2023-03-22T11:54:01Z

packages/web3-core/tsconfig.cjs.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../tsconfig.base.json",


each package has three configs for building CommonJS, ESM and type defs, these are extending from base config in root

jdevcs · 2023-03-22T11:55:26Z

packages/web3-core/package.json

-		"build": "tsc --build",
+		"build": "yarn build:cjs && yarn build:esm && yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",


It was explicitly required to have package json in build dir ( lib ) to explicitly override module type for correctly loading ESM when required so I am generating here a package json in lib

I don't think you need that for cjs dir

By default its not required, but I kept it to always override any higher level package config ( in client app) for surely giving error in case if any module type is loaded / referred by mistake.
Do you think it will cause any issue in client side if we keep this explicit overriding file?

No idea tbh

@jdevcs Maybe it would be better to use nodejs script for this. Afaik this excludes developers on windows to build library^^

for creating package.json? I think echo is also avalible in win

jdevcs · 2023-03-22T11:55:46Z

packages/web3-core/package.json

-		"build": "tsc --build",
+		"build": "yarn build:cjs && yarn build:esm && yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",


It was explicitly required to have package json in build dir ( lib ) to explicitly override module type for correctly loading ESM when required so I am generating here a package json in lib

packages/web3-core/tsconfig.esm.json

packages/web3-core/package.json

mpetrunic · 2023-03-22T13:29:57Z

packages/web3-core/package.json

-		"build": "tsc --build",
+		"build": "yarn build:cjs && yarn build:esm && yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",


I don't think you need that for cjs dir

packages/web3-eth-accounts/package.json

spacesailor24 · 2023-03-23T07:57:54Z

packages/web3-eth/src/utils/decode_signed_transaction.ts

@@ -14,12 +14,14 @@ GNU Lesser General Public License for more details.
 You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
-import { TransactionFactory } from '@ethereumjs/tx';
+import defaultImport, * as fullImport from '@ethereumjs/tx';


Doing this doesn't increase the build size?

No, it shouldn't, because there is one copy of this dependency in node_modules.

@jdevcs But would this affect tree shaking since we're now importing everything and setting it to a const instead of just importing and using the TransactionFactory export?

I think this may not affect treeshaking as in case of ESM usage of our lib , dependency usage tree is still construable for module being used.

import defaultImport, * as fullImport from '@ethereumjs/tx'; const { TransactionFactory } = defaultImport || fullImport;

Even if any issue arise , the lib under discussion is decided to be removed, or we can upgrade this to latest @ethereumjs/tx where these exports are fixed as mentioned earlier:

This export problem is fixed in @ethereumjs/tx in 4.x and we can upgrade to that in our 4.x after reviewing breaking changes in another PR.

jdevcs added 4 commits March 8, 2023 11:19

base tsconfig

0935531

build specific tsconfig

064d48b

build scripts for esm and cjs

a56bc6b

tsconfig fix for tests

4b092e0

jdevcs added the 4.x 4.0 related label Mar 8, 2023

jdevcs changed the title ~~Junaid/5241 esm cjs builds~~ [Draft] ESM CJS builds Mar 8, 2023

jdevcs added 3 commits March 9, 2023 15:12

Merge branch '4.x' into junaid/5241EsmCjsBuilds

50726e1

integration test fix

4b8557c

webpack custom tsconf to ts-loader

49bfccb

jdevcs added 4 commits March 9, 2023 16:54

doc pointing to conf

e68cc66

Merge branch '4.x' into junaid/5241EsmCjsBuilds

a0c7d04

linter ts config

f5da76b

docs config

a508be6

github-actions bot deployed to web3-js-docs (Preview) March 13, 2023 14:06 View deployment

jdevcs added 2 commits March 15, 2023 16:15

explicitly override module type in build outputs

50cc1de

Merge branch '4.x' into junaid/5241EsmCjsBuilds

f4d404c

github-actions bot deployed to web3-js-docs (Preview) March 15, 2023 15:36 View deployment

github-actions bot deployed to web3-js-docs (Preview) March 15, 2023 15:43 View deployment

Merge branch '4.x' into junaid/5241EsmCjsBuilds

3f6b964

github-actions bot deployed to web3-js-docs (Preview) March 21, 2023 11:39 View deployment

jdevcs added 2 commits March 21, 2023 21:56

tsconf update

93f94c7

fix ethereumjs/tx import issue for pure ESM

bad48a7

jdevcs commented Mar 21, 2023

View reviewed changes

jdevcs marked this pull request as ready for review March 21, 2023 21:10

jdevcs requested a review from a team as a code owner March 21, 2023 21:10

jdevcs changed the title ~~[Draft] ESM CJS builds~~ ESM CJS builds Mar 21, 2023

jdevcs commented Mar 22, 2023

View reviewed changes

github-actions bot deployed to web3-js-docs (Preview) March 22, 2023 12:04 View deployment

mpetrunic reviewed Mar 22, 2023

View reviewed changes

types at first

4adb051

github-actions bot deployed to web3-js-docs (Preview) March 22, 2023 16:01 View deployment

avkos requested changes Mar 22, 2023

View reviewed changes

packages/web3-eth-accounts/package.json Outdated Show resolved Hide resolved

spacesailor24 reviewed Mar 23, 2023

View reviewed changes

updated build script

1625c39

jdevcs requested review from luu-alex, Muhammad-Altabba and nikoulai as code owners March 27, 2023 11:01

jdevcs added 2 commits March 27, 2023 13:12

Merge branch '4.x' into junaid/5241EsmCjsBuilds

4164851

change log sync

dcc4dba

github-actions bot deployed to web3-js-docs (Preview) March 27, 2023 11:17 View deployment

github-actions bot deployed to web3-js-docs (Preview) March 27, 2023 11:37 View deployment

jdevcs requested review from avkos, spacesailor24 and mpetrunic March 27, 2023 11:47

nikoulai approved these changes Mar 27, 2023

View reviewed changes

avkos approved these changes Mar 28, 2023

View reviewed changes

Merge branch '4.x' into junaid/5241EsmCjsBuilds

3573c8a

github-actions bot deployed to web3-js-docs (Preview) March 28, 2023 05:18 View deployment

jdevcs merged commit 0781d8a into 4.x Mar 28, 2023

jdevcs deleted the junaid/5241EsmCjsBuilds branch March 28, 2023 08:54

jdevcs mentioned this pull request Mar 29, 2023

ESM CJS native builds documentation #5969

Open

4 tasks

jdevcs mentioned this pull request Apr 6, 2023

4.x - min.js build error #5994

Closed

1 task

jdevcs mentioned this pull request Apr 14, 2023

Release/4.0.1 rc.1 #6016

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ESM CJS builds #5904

ESM CJS builds #5904

jdevcs commented Mar 8, 2023

codecov bot commented Mar 8, 2023 •

edited

Loading

github-actions bot commented Mar 9, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Mar 13, 2023 •

edited

Loading

jdevcs commented Mar 15, 2023 •

edited

Loading

jdevcs Mar 21, 2023

jdevcs Mar 21, 2023

mpetrunic Mar 23, 2023

jdevcs Mar 27, 2023

jdevcs Mar 22, 2023

jdevcs Mar 22, 2023

jdevcs Mar 22, 2023

mpetrunic Mar 22, 2023

jdevcs Mar 22, 2023

mpetrunic Mar 22, 2023

mpetrunic Mar 23, 2023

jdevcs Mar 27, 2023

jdevcs Mar 22, 2023

mpetrunic Mar 22, 2023

spacesailor24 Mar 23, 2023

jdevcs Mar 24, 2023

spacesailor24 Mar 28, 2023

jdevcs Mar 28, 2023

ESM CJS builds #5904

ESM CJS builds #5904

Conversation

jdevcs commented Mar 8, 2023

Description

Type of change

Checklist for 1.x:

Checklist for 4.x:

codecov bot commented Mar 8, 2023 • edited Loading

Codecov Report

github-actions bot commented Mar 9, 2023 • edited Loading

Bundle Stats

cloudflare-workers-and-pages bot commented Mar 13, 2023 • edited Loading

Deploying with Cloudflare Pages

jdevcs commented Mar 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Mar 8, 2023 •

edited

Loading

github-actions bot commented Mar 9, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Mar 13, 2023 •

edited

Loading

jdevcs commented Mar 15, 2023 •

edited

Loading