adding browser support polyfill #5274

luu-alex · 2022-07-21T20:29:54Z

#5053 #5031 #4659 #4767
Tested using create-react-app and angular 12 worked on my end, id reccommend testing it as well

Description

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

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:

render · 2022-07-21T20:29:59Z

Your Render PR Server URL is https://web3-js-pr-5274.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cbcrehcgqg45pi6tqeg0.

coveralls · 2022-07-21T20:44:41Z

Pull Request Test Coverage Report for Build 2891572287

0 of 0 changed or added relevant lines in 0 files are covered.
436 unchanged lines in 7 files lost coverage.
Overall coverage decreased (-2.3%) to 72.255%

Files with Coverage Reduction	New Missed Lines	%
packages/web3-core-requestmanager/src/jsonrpc.js	1	88.0%
packages/web3-core-helpers/src/formatters.js	25	80.95%
packages/web3-core-helpers/src/errors.js	31	4.41%
packages/web3-utils/src/soliditySha3.js	55	5.13%
packages/web3-utils/src/index.js	62	29.31%
packages/web3-utils/src/utils.js	96	13.31%
packages/web3-eth-accounts/src/index.js	166	23.62%

Totals
Change from base Build 2884572200:	-2.3%
Covered Lines:	3402
Relevant Lines:	4432

💛 - Coveralls

jdevcs

Usually dist contents are added for tagged releases, why we need these builds in this PR?

luu-alex · 2022-07-22T16:19:48Z

@jdevcs the file web3.min.js contains the polyfills needed for bundlers like webpack. webpack was using our main file first, lib/index.js and would get errors during runtime, the dist content fixes this.

jdevcs

@jdevcs the file web3.min.js contains the polyfills needed for bundlers like webpack. webpack was using our main file first, lib/index.js and would get errors during runtime, the dist content fixes this.

These files are generated with release process so in any release these will be over written, if we include in this PR.

And if we dnt include these build files , these will be generated any ways with "browser": "dist/web3.min.js", fix.

luu-alex · 2022-07-22T16:38:43Z

@jdevcs got it, removing dist files from PR

avkos

As I see, you didn't add/delete any package in package.json. Why is it a lot of changes in package-lock.json?

luu-alex · 2022-07-25T15:23:23Z

@avkos I ran npm run build and it updated package.lock. will remove

smejak · 2022-07-29T10:01:24Z

Hello, I am using web3.js in my jupyter lab extension, but am running into issues during installation. I think my error is related to this update, however, when I added the changes proposed here manually, it didn't solve my issue. While building my extension, I am getting this error:

ModuleNotFoundError: Module not found: Error: Can't resolve 'http' in '/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/lib'                                       
                                                                                                                                                                                                                      
BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.                                                                                                                           
This is no longer the case. Verify if you need this module and configure a polyfill for it.                                                                                                                           
                                                                                                                                                                                                                      
If you want to include a polyfill, you need to:                                                                                                                                                                       
        - add a fallback 'resolve.fallback: { "http": require.resolve("stream-http") }'                                                                                                                               
        - install 'stream-http'                                                                                                                                                                                       
If you don't want to include a polyfill, you can use an empty module like this:                                                                                                                                       
        resolve.fallback: { "http": false }                                                                                                                                                                           
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/Compilation.js:2016:28                                                                                             
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:798:13                                                                                      
    at eval (eval at create (/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:10:1)                                                 
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:270:22                                                                                      
    at eval (eval at create (/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:9:1)                                                  
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:434:22                                                                                      
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:116:11                                                                                      
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:670:25  
at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:855:8
    at /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/webpack/lib/NormalModuleFactory.js:975:5
resolve 'http' in '/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/lib'
  Parsed request is a module
  using description file: /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/package.json (relative path: ./lib)
    Field 'browser' doesn't contain a valid alias configuration
    resolve as module
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/lib/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/node_modules doesn't exist or is not a directory
      looking for modules in /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules
        single file module
          using description file: /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/package.json (relative path: ./node_modules/http)
            no extension
              /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/http doesn't exist
            .js
              /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/http.js doesn't exist.json
              /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/http.json doesn't exist
            .wasm
              /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/http.wasm doesn't exist
        /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/http doesn't exist
      /Users/jakub/Development/Algovera/Core/tests/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/Core/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/node_modules doesn't exist or is not a directory
      /Users/jakub/node_modules doesn't exist or is not a directory
      /Users/node_modules doesn't exist or is not a directory
      /node_modules doesn't exist or is not a directory
/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/@jupyterlab/builder/lib/build-labextension.js:100
            throw new Error(err.details);
            ^

Error: resolve 'http' in '/Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/lib'
  Parsed request is a module
  using description file: /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/package.json (relative path: ./lib)
    Field 'browser' doesn't contain a valid alias configuration
    resolve as module
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/lib/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/web3-providers-http/node_modules doesn't exist or is not a directory
      /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules/node_modules doesn't exist or is not a directory
      looking for modules in /Users/jakub/Development/Algovera/Core/tests/jupyterlab_extensions/node_modules
...

Web3js is actually used here in another node package (ocean-lib) and I have tried adding that update to this library as well. Also, I have tried using web3.js previously to just send transactions and that also resulted in the same error, but for instance ethers.js did not (but now I cannot refactor my code to ethers.js since it is nested in another package).

I appreciate any suggestions.

luu-alex · 2022-07-29T14:03:10Z

@smejak You added changes to your package/web3/package.json? This looks a bit weird Field 'browser' doesn't contain a valid alias configuration can you join the discord and post in the web3js-general channel? https://discord.com/invite/pb3U4zE8ca ill help debug with you from there

smejak · 2022-07-29T14:39:09Z

Hi @luu-alex . Thanks, I just sent a message there.

Jack-Works · 2022-11-05T11:43:38Z

this PR break throws a runtime error: removing the browser field added by this PR solves the problem.

TypeError: Cannot set property Request of # which has only a getter

jdevcs · 2022-11-07T07:05:13Z

this PR break throws a runtime error: removing the browser field added by this PR solves the problem.

TypeError: Cannot set property Request of # which has only a getter

@luu-alex

adding browser support polyfill

c5f5ca4

update package-lock

59957af

jdevcs reviewed Jul 22, 2022

View reviewed changes

jdevcs added the 1.x 1.0 related issues label Jul 22, 2022

jdevcs reviewed Jul 22, 2022

View reviewed changes

adding dist back

0813205

luu-alex requested review from jdevcs, nazarhussain, avkos, Muhammad-Altabba, spacesailor24 and nikoulai July 22, 2022 17:13

luu-alex added the Future Release For future release. label Jul 22, 2022

adding changelog

f62e836

nazarhussain approved these changes Jul 25, 2022

View reviewed changes

jdevcs approved these changes Jul 25, 2022

View reviewed changes

nikoulai approved these changes Jul 25, 2022

View reviewed changes

avkos requested changes Jul 25, 2022

View reviewed changes

revert package.lock

9b9dc10

jasongrout mentioned this pull request Jul 26, 2022

Jupyterlab extension not reading webpack config jupyterlab/jupyterlab#12851

Closed

avkos approved these changes Jul 26, 2022

View reviewed changes

luu-alex linked an issue Jul 26, 2022 that may be closed by this pull request

Webpack5 support for create-react-app #5031

Closed

This was referenced Feb 15, 2023

[Snyk] Upgrade web3-utils from 1.6.0 to 1.8.1 Mhmonicox/web3.js#9

Open

[Snyk] Upgrade web3-eth-iban from 1.6.0 to 1.8.1 Mhmonicox/web3.js#10

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding browser support polyfill #5274

adding browser support polyfill #5274

luu-alex commented Jul 21, 2022 •

edited

Loading

render bot commented Jul 21, 2022

coveralls commented Jul 21, 2022 •

edited

Loading

jdevcs left a comment

luu-alex commented Jul 22, 2022

jdevcs left a comment

luu-alex commented Jul 22, 2022

avkos left a comment •

edited

Loading

luu-alex commented Jul 25, 2022

smejak commented Jul 29, 2022

luu-alex commented Jul 29, 2022 •

edited

Loading

smejak commented Jul 29, 2022

Jack-Works commented Nov 5, 2022

jdevcs commented Nov 7, 2022

adding browser support polyfill #5274

adding browser support polyfill #5274

Conversation

luu-alex commented Jul 21, 2022 • edited Loading

Description

Type of change

Checklist:

render bot commented Jul 21, 2022

coveralls commented Jul 21, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2891572287

💛 - Coveralls

jdevcs left a comment

Choose a reason for hiding this comment

luu-alex commented Jul 22, 2022

jdevcs left a comment

Choose a reason for hiding this comment

luu-alex commented Jul 22, 2022

avkos left a comment • edited Loading

Choose a reason for hiding this comment

luu-alex commented Jul 25, 2022

smejak commented Jul 29, 2022

luu-alex commented Jul 29, 2022 • edited Loading

smejak commented Jul 29, 2022

Jack-Works commented Nov 5, 2022

jdevcs commented Nov 7, 2022

luu-alex commented Jul 21, 2022 •

edited

Loading

coveralls commented Jul 21, 2022 •

edited

Loading

avkos left a comment •

edited

Loading

luu-alex commented Jul 29, 2022 •

edited

Loading