This repository was archived by the owner on Feb 13, 2024. It is now read-only.
Replace crypto-token with uuid. #150
Merged
Conversation
This file contains hidden or 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
stephenmathieson
approved these changes
Jan 16, 2018
vadimdemedes
suggested changes
Jan 17, 2018
|
@vadimdemedes I just copy pasted that from their docs: https://github.com/kelektiv/node-uuid |
|
@f2prateek them writing it that way in the readme doesn't mean it's the best way to do it :) |
|
Will change |
Both use the node crypto package on Node apps so there shouldn't be a meaningful difference here. The differences come in the browser. crypto-token works in the browser by polyfilling the crypto package. node-uuid works by using the browser crypto apis if available, otherwise falling back to Math.random() (https://github.com/kelektiv/node-uuid/blob/master/lib/rng-browser.js). Because of polyfilling on the browser, crypto-token contributes 90kb to our library in the browser which is rougly 80% of the library size on the browser (the rest of the library is only 20kb). node-uuid only adds 1kb (though I believe this comes at the cost of generating slightly less random messageIds on the browser). I don't think the extra weight is worth the cost, especially as we're not using this in a critical security context. One thing we now do to increase randomness in the browser is includes a hash of the contents of the message as well like we do in a.js (https://github.com/segment-integrations/analytics.js-integration-segmentio/blob/master/lib/index.js#L256). On a side note, analytics.js also uses the uuid package. Before: Package size: 107.79 KB Size limit: 150 KB With all dependencies, minified and gzipped After: Package size: 13.79 KB Size limit: 150 KB With all dependencies, minified and gzipped Because of the significant reduction in size, I also updated the size limit to be 25kb instead of 150kb.
|
@vadimdemedes Updated the Side Note: E2E tests are being flaky because of some destinations downtime today, so if Circle fails I'll kick it off again. |
Codecov Report
@@ Coverage Diff @@
## master #150 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 1 1
Lines 96 97 +1
=====================================
+ Hits 96 97 +1
Continue to review full report at Codecov.
|
vadimdemedes
approved these changes
Jan 18, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Both use the node crypto package on Node apps so there shouldn't be a meaningful difference here.
The differences come in the browser. crypto-token works in the browser by polyfilling the crypto package. node-uuid works by using the browser crypto apis if available, otherwise falling back to Math.random() (https://github.com/kelektiv/node-uuid/blob/master/lib/rng-browser.js).
Because of polyfilling on the browser, crypto-token contributes 90kb to our library in the browser which is rougly 80% of the library size on the browser (the rest of the library is only 20kb). node-uuid only adds 1kb (though I believe this comes at the cost of generating slightly less random messageIds on the browser). I don't think the extra weight is worth the cost, especially as we're not using this in a critical security context.
One thing we now do to increase randomness in the browser is includes a hash of the contents of the message as well like we do in a.js (https://github.com/segment-integrations/analytics.js-integration-segmentio/blob/master/lib/index.js#L256). On a side note, analytics.js also uses the uuid package.
Before:
Package size: 107.79 KB
With all dependencies, minified and gzipped
After:
Package size: 13.79 KB
With all dependencies, minified and gzipped
Because of the significant reduction in size, I also updated the size limit to be 25kb instead of 150kb.