Include original .ts files in the NPM packages to allow proper debugging

[gabmontes]

The published package in NPM only contains the /dist/* files but when debugging with i.e. the Chrome DevTools and stepping into the library, an error is thrown because the original /src/*.ts files cannot be found and therefore the sourcemaps can't be used to display the proper source lines being executed.

Please update the NPM package to also include the /src directory.

Other packages distributing transpiled TypeScript files have the same issue. See MetaMask/eth-sig-util#142.

[ryanio]

hey, thanks, yes we've had this discussion before in ethereumjs/rlp#97

i'd be in favor of adding the source files since it can be useful in certain situations.

[holgerd77]

Yes, I guess I would be in favor too, so maybe let's just right out do this. Would be nice to hear the opinions from @acolytec3 and @jochem-brouwer too and see if there are major reservations for whatever reasons.

@gabmontes I can't promise you to directly do version bumps (time constraints) on all the libraries with this (if we agree to do), are there any libraries which are most pressing to you and you would very much want to see released?

[gabmontes]

@ryanio @holgerd77 thanks for your quick response!

Not in a hurry right now but it would help others that may need debugging in the future.

Thanks again!!!

[acolytec3]

I don't have any concerns with it (though then again I've not encountered this specific sort of issue previously so have no past experience. Seems like it would make sense to do. If people start complaining about package sizes, we could always do some sort of minified version of each that strips the sources back out.

…

On Tue, Jun 8, 2021 at 8:18 PM Gabriel Montes ***@***.***> wrote: @ryanio <https://github.com/ryanio> @holgerd77 <https://github.com/holgerd77> thanks for your quick response! Not in a hurry right now but it would help others that may need debugging in the future. Thanks again!!! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1287 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEENFXEDVP3QKQZDTKOOI3TTR2XOFANCNFSM46IPDEUA> .

[holgerd77]

@gabmontes I would like to give this a try but not really sure how to approach. Is there a simple way to get into this setup context with having one of the libraries available in the browser and using Chrome for debugging? This would generally be pretty helpful for us to have a quick way to do some occasional (manual) test runs apart from the Karma runs in the browser, I guess all of us have little experience with this and it would be nice to get some better feeling for that (I personally have used ChromeDevTools on other occasions though). (Once we've got that it would be good to document).

I actually tried to use our run-code-browser example from the VM, but interestingly enough the vm object is not exposed any more in the debug console when going to the local 127.0.0.1:8080 server in the browser. Another thing is is that the code is routed through browserify there, not sure if this invalidates the whole thing.

[gabmontes]

@holgerd77 this is no related to running the code in the browser. In fact I saw the issue while debugging code running in Node.js, using the Chrome DevTools.

[holgerd77]

Ok, I was finally able to recreate this respectively do a relevant setup by using this tutorial to set up (or just: using) Chrome for doing Node.js debugging, here is some screenshot for illustration:

Some note on this: For this to use one has to first add the folder one is working with to the workspace ("Filesystem" tab in the dev tools) and then one can set a breakpoint in the code. Otherwise code runs triggered from the console will just terminate and files won't be available for inspection.

Then you can run node --inspect create-al-tx.js (or whatever short script you have) and code run is halted at the respective break point (actually really excited about this experiment in general since I never had a proper way of debugging Node scripts in a practical manner 😄 ).

I then tested on our root problem here (the missing source files) by mouse-hovering on e.g. FeeMarketEIP1559Transaction, the link provided there went into some "could not load content" reporting. Then I adjusted a monorepo tx package.json file and added the "src" folder to the files directive (and also needed to revert on all the bnToUnpaddedBuffer -> bnToRlp occurrences since I had no working release state), then did a local package with npm run pack and installed from this local file.

Same debug test in the Chrome DevTools now lead to going to the FeeMarketEIP1559Transaction original source reference when clicked on the source link.

Yeah, I would say proven to be both useful and working, so I would say we can add. 🤩

Will directly open a PR.