Release - 1.2.7 #3470

ryanio · 2020-04-15T01:50:05Z

Description

This PR introduces web3.js version 1.2.7 beginning with 1.2.7-rc.0.

Please see the release notes for more.

Changelog

Added

Add revert reason support to sendSignedTransaction (Extend transaction revert handling for eth.sendSignedTransaction #3345)
ENS module extended with the possibility to add a custom registry (Adds the possibility to define a custom registry for the ENS module #3301)
Missing ENS Registry methods and Resolver.supportsInterface method added (Implements all methods of the ENS registry #3325)
Add optional gas type to AbiItem typescript definitions (for ABIs generated by Vyper) (Gas Type Added in AbiItem #3437)
Add auto-reconnect option for Websockets ([v1.2.1] Connection not Open. #3092, Provider does not reconnect after failure #1085, Question: Keepalive for ws subscriptions? #1391, Reconnect on Websocket Drop #1558, Reconnect feature is missing when websocket connection is closed. #1852, issue with websocket connection to infura #1646)

Changed

Ensure '0x' prefix is existing for Accounts.sign and Accounts.privateKeyToAccount (web3.eth.accounts.privateKeyToAccount accepts private key without "0x" prefix but returns incorrect result #3041)
Repository cleanup (Routine cleanup #3443)
- Removed old docs/_build folder
- Removed old bower and meteor artifacts
- Moved logo assets to own folder
- Moved github assets to own folder
Remove @types/node from (non-dev) dependency tree (Feature/web3 eth iban es6 (#3964) #3965, Formatter has a large number of overflow bugs #3227)

Fixed

Add missing subscription.on('connected') TS type definition (missing types for Subscription.on('connected') #3319)
Add missing bignumber.js dependency for TS types (Typescript compilation error regarding a bignumber.js import #3386)
Upgrade swarm-js to 0.1.40 to remove npm vulnerability warning (Swarm.js - Arbitrary File Write vulnerability #3399)
Upgrade devDeps to resolve security warnings (Upgrade devDeps to resolve security warnings #3464)
- dtslint 0.4.2 => 3.4.1
- definitelytyped-header-parser 1.0.1 => 3.9.0
Race-condition when subscribing to historical logs as first client request (WebsocketProvider with fromBlock doesnt return events from the past #3389)
Fix crash when using Web-Workers by removing any-promise dependency (web3 -- Web Worker environment still is not supported in 1.2.4 #3377 web3 -- web worker environment isn't supported #2211 Using web3 inside a web worker #1774)
MaxListenersExceededWarning event emitter warning mitigated (MaxListenersExceededWarning when sending contract (v1.0.0-beta.33) #1648)

Compare View

v1.2.6 -> v1.2.7

Type of change

Release

Checklist:

ryanio · 2020-04-15T02:15:15Z

Hey everyone, @cgewecke and I are happy to announce release version 1.2.7.

We plan to leave this PR open for one week (until next Tuesday, April 21) for community feedback and reviewer approvals. If there are any large changes requested, they will be published and released as incremented rc releases.

@michaelsbradleyjr @alcuadrado @gnidan hey 👋 please let us know if you could take a 👀 and give us your 👍 for this release. Thank you!

cgewecke · 2020-04-15T02:18:55Z

As part of the RC process, am doing some test installations in other projects and running their tests to see if everything.

installs properly
builds
tests pass

This list will be actively edited:

Project	Desc	Status
oz-test-helpers	Test utils. Subset of their suite is web3 contracts	✅
oceanprotocol/squid-js	TS API ~95 tests + tsc + webpack build	Only used by sub-deps
gnosis/dex-react	TS React app ~200 tests + webpack build + jest	✅ (Test/Build)

nivida · 2020-04-15T02:30:08Z

Is there a compare view existing to see the diff of 1.2.6 and 1.2.7 as in all other releases? also, the changelog we always had and which notified the issue/PR creators is missing in the description? can you reference the release guidelines as well? and is the RC version already released because I can't see the in-progress label? (I know some annoying questions) :-)

nivida · 2020-04-15T02:38:24Z

gulpfile.js

@@ -119,6 +119,7 @@ var ugliyOptions = {
    }
 };

+// Apply lerna.json version to root package.json


I think these comments are non-related to this PR.. see point 4.1 of the contribution guidelines.

ryanio · 2020-04-15T02:38:33Z

Is there a compare view existing to see the diff of 1.2.6 and 1.2.7 as in all other releases?

Yes thanks, just added!

also, the changelog we always had and which notified the issue/PR creators is missing in the description? can you reference the release guidelines as well?

Will add now.

and is the RC version already released because I can't see the in-progress label? (I know some annoying questions) :-)

Just added, thanks ;)

package.json

nivida · 2020-04-15T02:40:27Z

package.json

@@ -20,10 +20,11 @@
        }
    ],
    "scripts": {
+        "version": "npm run build-all",


Shouldn't those modified or additional commands not be a separate PR to be aligned with the contribution guidelines from @cgewecke?

NOT a good idea to have a script named the same as a discrete step in the NPM release-lifecycle unless you fully intend to follow the documented behavior (not sure lerna can/will/do/acknowledge that re: the root package.json in a lerna publish scenario)...

Run AFTER bumping the package version, but BEFORE commit.

See: https://docs.npmjs.com/misc/scripts

Maybe that's the case, but NOTE-ing out of caution.

Yes thanks that was exactly our intention, it is to build the minified file after bumping package versions but before committing the working state.

Hmmm... not entirely sure, but sounds like maybe "files" in package.json (in child packages) could be added / edited; and that .gitignore (root or children) could be adjusted to ignore *.min.js. Main point: if you're specifying a "version" script, something's probably not right.

It's been awhile since I looked closely at this monorepo, but if you have .npmignore in root or child packages, nuke with prejudice and prefer "files" in all child packages' package.json — it will save you a world of trouble.

Also, consider "prepublishOnly'" in package.json scripts.

Hmmm... not entirely sure, but sounds like maybe "files" in package.json (in child packages) could be added / edited; and that .gitignore (root or children) could be adjusted to ignore *.min.js. Main point: if you're specifying a "version" script, something's probably not right.

I agree.. I've added the filesproperty to the package.json files in 2.x...

and that .gitignore (root or children) could be adjusted to ignore *.min.js.

Sadly no.. I've noticed the min file has to be on GitHub because many do use it for their tutorials and courses or of whatever reason :-)

@ryanio

NOT a good idea to have a script named the same as a discrete step

I would add this command/alias to the required places without defining a version command because this is for some/many devs a "hidden logic" :D

There's more about this in the lerna documentation for version command lifecycle scripts.

nivida · 2020-04-15T02:40:58Z

package.json

@@ -132,7 +133,7 @@
        "karma-firefox-launcher": "^1.2.0",
        "karma-mocha": "^1.3.0",
        "karma-spec-reporter": "0.0.32",
-        "lerna": "^3.18.3",
+        "lerna": "^3.20.2",


What exactly was the reason to bump two minor versions of lerna? 🤔

The lerna project is quite good about adhering to semver, so this should only pick-up bug fixes and new featuresl

Yep, I agree and know.. just thought it is out of the scope of this PR idk (4.1 contribution rules) :-)

For additional background: the existence of several moderate/high vulnerability audit warnings originating in Lerna was flagged by a longtime contributor in this 2744 comment, yesterday.

nivida · 2020-04-15T03:31:28Z

v1.2.6...v1.2.7-rc.0#diff-40a5d984375cfacc5cc552a01648ee51R20

Could we not add this disclaimer to the README.md and documentation and remove the in-line comment? This information is probably important for some old projects which are integrating web3.js idk.. (only the duplicated comments everywhere should have brought that up) :-)

I mean this says 3.7.. do we now have 3.0 or 3.7 as min. version? :P

v1.2.6...v1.2.7-rc.0#diff-8c363e4016c0523ddfd8355b2b3dcf48L26

Did this probably also improve the Promise chaining functionality? We do have 1-2 issues about it here on GitHub.

v1.2.6...v1.2.7-rc.0#diff-b9a9f37d5a3a90f3953a269ddca60a65R62

Typo it should be: // Subscription might not exist

v1.2.6...v1.2.7-rc.0#diff-a383cea7a2a9d92a58631e2d44a94ffeR201

@cgewecke is there a way to document the timing issue we noticed? 🤔

v1.2.6...v1.2.7-rc.0#diff-5ca1164e985980d3e045ad9298bbec26R9

Is this required or do I/We have a badly defined type? idk..

v1.2.6...v1.2.7-rc.0#diff-bd11c69500f2885e9e6ebfaf8fd2da13R26

I think this comment is I think from my side.. 😅 but we should probably create an issue out of it to track it idk... and this is a lie the generic Contract was/is always implemented.

class MyContract extends eth.Contract {}

v1.2.6...v1.2.7-rc.0#diff-7fb0ce5099d9515831133d423fef6c75R30

Can we add the explanation of it to the changelog or so? otherwise, those addresses do look like cheeked in...

revert msg sendSignedTransaction

As I informed Chris already is the additional network request not required.. should we inform the user about it? or do you think as I'm doing that this isn't required for the time being?

Thanks for all of your great work on this release! I'm really happy to see my started improvements are getting done and improved! ❤️

cgewecke · 2020-04-15T15:58:47Z

@nivida In your comment with detailed review suggestions, the links aren't resolving correctly. When I click on the diff hashes it shows "nothing to compare" page. Are you also seeing this on your side?

The suggested change to sendSignedTransaction is being tracked in #3457. It's an efficiency improvement that won't change correctness. Unsure what we should "inform the user about" here - could you clarify?

Unfortunately your suggestion about that came right as we agreed to freeze public-facing changes to prepare for a release so it will need to go in 1.2.8.

ryanio · 2020-04-17T01:17:01Z

I mean this says 3.7.. do we now have 3.0 or 3.7 as min. version? :P

dtslint was only checking TypeScript 3.9 prior to #3464. There were some type errors on earlier versions, which is why you see those minimum comments, it's actually to programmatically let dtslint know. I've been meaning to go back and see if I can resolve them since it's just a few of them out of all the packages, but haven't gotten a chance yet.

edit: resolved in #3479

ryanio · 2020-04-22T04:31:04Z

Just an update since today was our planned day for release.

@cgewecke and I still have a few review comments we are addressing from @nivida before considering ready so please give us some additional time to finish the aforementioned threads.

cgewecke · 2020-04-24T16:53:06Z

Release notes: remove comments about MaxListenersExceededWarning
Release notes: describe and link to auto-reconnect configuration in docs
- https://web3js.readthedocs.io/en/v1.2.7-rc.0/web3-eth.html#configuration

cgewecke

Yes, great work @ryanio! 🎉

holgerd77 · 2020-04-24T20:47:45Z

Congrats! 🐡🐠🐟

paub444 · 2021-07-25T13:25:13Z

I'm facing an issue when I do require('web3') inside a worker. It works for the first call, but nodejs crashes on the second call to the program.
Strangely, this issue happens when I use require('web3') in the main thread. I cannot avoid this because I need web3 in the main thread as well.

Is there an issue with updation of require cache by any chance?

ryanio requested review from cgewecke, alcuadrado, gnidan and holgerd77 April 15, 2020 02:15

ryanio added 1.x 1.0 related issues Release labels Apr 15, 2020

ryanio added the In Progress Currently being worked on label Apr 15, 2020

nivida reviewed Apr 15, 2020

View reviewed changes

package.json Show resolved Hide resolved

nivida reviewed Apr 15, 2020

View reviewed changes

This was referenced Apr 15, 2020

Inject commit hash into scripts/html/index.html for Surge E2E test #3471

Closed

Add --ignore-scripts to lerna publish command for E2E publishing tests #3472

Closed

ryanio force-pushed the release/1.2.7 branch from a35e93c to 65237be Compare April 24, 2020 19:21

ryanio added 7 commits April 24, 2020 12:41

Update changelog

1d04bee

Update lerna dep and release scripts

b0fc357

Document gulpfile

4185ffa

Run build on different lerna version lifecycle segment

68fa5e1

Use web3.js for root package name

7cdcca9

v1.2.7-rc.0

a66e541

v1.2.7

a5bfd01

ryanio force-pushed the release/1.2.7 branch from 65237be to a5bfd01 Compare April 24, 2020 19:41

ryanio removed the In Progress Currently being worked on label Apr 24, 2020

Update package-locks

c42d3e8

cgewecke approved these changes Apr 24, 2020

View reviewed changes

ryanio merged commit 2e4bbf4 into 1.x Apr 24, 2020

holgerd77 deleted the release/1.2.7 branch April 24, 2020 20:42

cgewecke mentioned this pull request Apr 27, 2020

Add --ignore-scripts to lerna publish command for E2E publishing tests #3487

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release - 1.2.7 #3470

Release - 1.2.7 #3470

ryanio commented Apr 15, 2020 •

edited by cgewecke

ryanio commented Apr 15, 2020

cgewecke commented Apr 15, 2020 •

edited

nivida commented Apr 15, 2020

nivida Apr 15, 2020

ryanio commented Apr 15, 2020

nivida Apr 15, 2020

michaelsbradleyjr Apr 15, 2020 •

edited

ryanio Apr 15, 2020

michaelsbradleyjr Apr 15, 2020 •

edited

michaelsbradleyjr Apr 15, 2020 •

edited

nivida Apr 15, 2020

nivida Apr 15, 2020

cgewecke Apr 15, 2020 •

edited

nivida Apr 15, 2020

michaelsbradleyjr Apr 15, 2020

nivida Apr 15, 2020

cgewecke Apr 15, 2020

nivida commented Apr 15, 2020 •

edited

cgewecke commented Apr 15, 2020

ryanio commented Apr 17, 2020 •

edited

ryanio commented Apr 22, 2020

cgewecke commented Apr 24, 2020 •

edited

cgewecke left a comment

holgerd77 commented Apr 24, 2020

paub444 commented Jul 25, 2021

Release - 1.2.7 #3470

Release - 1.2.7 #3470

Conversation

ryanio commented Apr 15, 2020 • edited by cgewecke

Description

Changelog

Added

Changed

Fixed

Compare View

Type of change

Checklist:

ryanio commented Apr 15, 2020

cgewecke commented Apr 15, 2020 • edited

nivida commented Apr 15, 2020

Choose a reason for hiding this comment

ryanio commented Apr 15, 2020

Choose a reason for hiding this comment

michaelsbradleyjr Apr 15, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaelsbradleyjr Apr 15, 2020 • edited

Choose a reason for hiding this comment

michaelsbradleyjr Apr 15, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cgewecke Apr 15, 2020 • edited

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

nivida commented Apr 15, 2020 • edited

cgewecke commented Apr 15, 2020

ryanio commented Apr 17, 2020 • edited

ryanio commented Apr 22, 2020

cgewecke commented Apr 24, 2020 • edited

cgewecke left a comment

Choose a reason for hiding this comment

holgerd77 commented Apr 24, 2020

paub444 commented Jul 25, 2021

ryanio commented Apr 15, 2020 •

edited by cgewecke

cgewecke commented Apr 15, 2020 •

edited

michaelsbradleyjr Apr 15, 2020 •

edited

michaelsbradleyjr Apr 15, 2020 •

edited

michaelsbradleyjr Apr 15, 2020 •

edited

cgewecke Apr 15, 2020 •

edited

nivida commented Apr 15, 2020 •

edited

ryanio commented Apr 17, 2020 •

edited

cgewecke commented Apr 24, 2020 •

edited