Unique Identifiers for POST Requests #98

03k64 · 2016-12-07T13:37:07Z

Problem

In order to automate soak testing of POST endpoints we need to send some unique identifier as part of the request. For example, when registering a new user for a website, we require the email address used to be unique.

Solution

Alteration of AutoCannon to recognise a specific tag, [<uuid>], within the request body and replace it with a new version 4 UUID. UUID generation is handled by the uuid package. In order to ensure per request rather than per connection unique identifiers, the tag is replaced as part of the Request Iterator rather than Request Builder. The Request Builder is also modified to add 28 bytes per usage of the tag to the Content-Length header to account for the replacement.

…where a unique identifier is required as part of each request such as when creating new users where email must be unique

…st rather than per connection. Added code to correct content length in request builder

…_from function in order to ensure Node <6 compatibility

mcollina · 2016-12-07T13:47:57Z

Thanks for your contribution.
Can you swap uuid with http://npm.im/hyperid? The latter is way faster.

I only have one request, and it is that the id-replicating logic should be configurable, not enabled by default.

03k64 · 2016-12-07T14:15:01Z

No problem, it's been fun to work on.

I have replaced uuid with hyperid and made id-replacement configurable as you asked. I've updated the README to reflect the latter change.

GlenTiki · 2016-12-07T14:36:01Z

lib/httpRequestBuilder.js

@@ -60,7 +60,8 @@ function requestBuilder (defaults) {
 }

 if (bodyBuf && bodyBuf.length > 0) {
- headers['Content-Length'] = '' + bodyBuf.length
+ const uuidCount = (bodyBuf.toString().match(/\[<uuid>\]/g) || []).length
+ headers['Content-Length'] = `${bodyBuf.length + (uuidCount * 28)}`


The maths relating to this content-length is wrong, I think.

content-length = bodyBuf.length - ('<uuid>'.length * uuidCount) + (uuidCount * 28)

Because the bodyBuf string will remove the '' tokens to replace them with the uuid's

Also is an uuid not 16 bytes in length?

Thanks!

Sure, I will absolutely do that, I think in my haste to respond to the earlier comment I forgot to go back over the maths. I'd gotten the earlier figure by comparing the content length with the tag and with the UUID, but I will look into this and add a test as you suggested below. Should have time to work on this tonight or tomorrow.

GlenTiki · 2016-12-07T14:37:24Z

If you wouldn't mind, could you add a basic test to validate this works as expected? Thank you for this PR, it looks awesome 👍

mcollina · 2016-12-07T16:02:41Z

README.md

@@ -90,6 +90,8 @@ Available options:
 Don't render the progress bar. default: false.
 -l/--latency
 Print all the latency data. default: false.
+ -I/--idReplacement
+ Enable replacement of [<uuid>] with a randomly generated unique identifier within the request body. default: false.


call it <id>, or :id:.

Changed to [<id>]

mcollina · 2016-12-07T16:03:35Z

lib/requestIterator.js

@@ -1,3 +1,4 @@
+const uuid = require('hyperid')()


this is not a uuid.

Changed to hyperid

mcollina · 2016-12-07T16:06:04Z

lib/requestIterator.js

@@ -28,7 +29,7 @@ RequestIterator.prototype.nextRequestBuffer = function () {

 RequestIterator.prototype.move = function () {
 // get the current buffer and proceed to next request
- const ret = this.currentRequest.requestBuffer
+ const ret = new Buffer(this.currentRequest.requestBuffer.toString().replace(/\[<uuid>\]/g, uuid()))


this is where we lose speed. Can we do this change using a function passed in as an option? In this way we could support more scenarios that just :id:.

mcollina · 2016-12-07T16:12:41Z

lib/requestIterator.js

- const ret = this.currentRequest.requestBuffer
+ const ret = this.reqDefaults.idReplacement
+ ? new Buffer(this.currentRequest.requestBuffer.toString().replace(/\[<uuid>\]/g, uuid()))
+ : this.currentRequest.requestBuffer


can we change this logic so that this mangling logic is an opt-in function?

…ement is enabled

…anged instance name of hyperid to hyperid to reflect that it is not a uuid

…arlier versions of node

mcollina · 2016-12-07T23:21:31Z

lib/requestIterator.js

+ const contentLengthRegex = /\[<contentLength>\]/
+ const reqStr = ret.toString().replace(/\[<id>\]/g, hyperid())
+ const bodyLength = reqStr.split(contentLengthRegex)[1].trim().length
+ ret = new Buffer(reqStr.replace(contentLengthRegex, `${bodyLength}`))


All those steps are going to be really slow, and we are running it twice.
Isn't there a chance to have this logic into the requestBuilder?

The only problem with moving it into requestBuilder is that the length of the replacement value on line 37 will vary. As you will know, hyperid generates IDs made up of a base64 string plus an integer, the integer will grow in length as it gets larger, which prevents setting content length until all replacements have been carried out.

This would not be a problem if we used UUIDs as they would be a fixed size, of course then there is a penalty for constantly regenerating UUIDs. I could fork and submit a change to the implementation of hyperid to pad the iteration section out to a fixed width but I don't know how expensive that would be in terms of the performance of hyperid. What do you think?

let's try adding a pad to hyperid. It does not grow indefinitely, but up to https://github.com/mcollina/hyperid/blob/master/hyperid.js#L4. Maybe as an option when we create the hyperid instance.

mcollina · 2016-12-07T23:22:10Z

Good progress! I think we are nearly there!

@thekemkid what do you think?

GlenTiki · 2016-12-08T09:53:30Z

I'm loving this work 👍This feature will be fairly complex to understand purely based on the docs, would an example be appropriate?

Other than that, I don't have much to add, and I don't want to step on your toes @darArch 😄 So for now I'm just keeping an eye on how this pr is progressing, but if you need any help, I'm happy to jump in and give you the support you need where I can! :)

GlenTiki · 2016-12-08T09:55:36Z

Also, make sure you add your name to the contributors section in the package.json if that's your thing :)

… back to request builder and simplified request iterator. Updated tests as appropriate and tested manually with personal site. Added name to contributors section :)

mcollina

Amazing. LGTM

mcollina · 2016-12-09T14:46:07Z

@darArch would you like to help maintaining/developing autocannon?

03k64 · 2016-12-09T14:50:37Z

@mcollina I would definitely be interested. It's been great fun to use and work with/on.

03k64 · 2016-12-09T15:01:25Z

@mcollina @thekemkid The Travis CI build failed when Node v6 failed to install with NVM, would you be able to retrigger the build?

03k64 · 2016-12-09T15:06:02Z

@thekemkid Should I add an example body before and after tag replacement to the README?

mcollina · 2016-12-09T15:11:12Z

@darArch an example will be better, I would like to keep the README thin.

GlenTiki · 2016-12-09T15:11:43Z

🎉Great to hear you're happy to join 🎉

I'm rebuilding now, and defer to @mcollina on the example 👍

mcollina · 2016-12-09T15:11:54Z

@darArch just invited you to the repo!

…dReplacement to default options in run.js, updated README

03k64 · 2016-12-09T15:55:03Z

Not sure what's going on with the Travis CI builds, but I just added an example in samples/using-id-replacement and linked to it in the README.

GlenTiki · 2016-12-09T17:15:24Z

NVM on travis seems to be having some trouble right now, lets leave it be for the evening, and retrigger the build in the morning. If its something deeper, I'll investigate further over the weekend.

03k64 · 2016-12-12T09:32:05Z

I retriggered the Travis build which has now passed. I don't see any option to retrigger the Appveyor build though, @mcollina would you be able to?

mcollina · 2016-12-12T12:57:22Z

All is good now. @thekemkid would you mind doing a release? (Also check if native-hdr-histogram is all good).

Donald Robertson added 4 commits December 6, 2016 19:13

Added ability to include uuid as part of body. Body can then be used …

2c700d7

…where a unique identifier is required as part of each request such as when creating new users where email must be unique

Added missing require

c4218c3

Refactored how uuids are inserted in order to ensure unique per reque…

0105862

…st rather than per connection. Added code to correct content length in request builder

Amended Request Iterator to use Buffer constructor rather than Buffer…

bebd868

…_from function in order to ensure Node <6 compatibility

Donald Robertson added 4 commits December 7, 2016 13:55

Replaced uuid with hyperid per PR comments, removed errant console.log

7e3e583

Made ID Replacement configurable per PR comments

097eaca

Updated README

f8ad97b

Updated README

ae66d3c

GlenTiki reviewed Dec 7, 2016

View reviewed changes

mcollina requested changes Dec 7, 2016

View reviewed changes

Donald Robertson added 4 commits December 7, 2016 17:43

Refactored to set content length dynamically per request if ID replac…

9c56ec0

…ement is enabled

Refactored httpRequestBuilder and added tests

870cef2

Made changes based on PR comments: changed [<uuid>] tag to [<id>], ch…

6547e61

…anged instance name of hyperid to hyperid to reflect that it is not a uuid

Added missing use strict label to allow usage of let and const with e…

6f19647

…arlier versions of node

mcollina reviewed Dec 7, 2016

View reviewed changes

Updated to use new version of HyperID, moved logic for content length…

bab9588

… back to request builder and simplified request iterator. Updated tests as appropriate and tested manually with personal site. Added name to contributors section :)

mcollina approved these changes Dec 9, 2016

View reviewed changes

Added example of programatic use of idReplacement to samples, added i…

1260a80

…dReplacement to default options in run.js, updated README

GlenTiki merged commit 34e23d6 into mcollina:master Dec 12, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unique Identifiers for POST Requests #98

Unique Identifiers for POST Requests #98

03k64 commented Dec 7, 2016

mcollina commented Dec 7, 2016

03k64 commented Dec 7, 2016

GlenTiki Dec 7, 2016 •

edited

Loading

03k64 Dec 7, 2016

GlenTiki commented Dec 7, 2016

mcollina Dec 7, 2016

03k64 Dec 7, 2016

mcollina Dec 7, 2016

03k64 Dec 7, 2016

mcollina Dec 7, 2016

mcollina Dec 7, 2016

mcollina Dec 7, 2016

03k64 Dec 8, 2016

mcollina Dec 8, 2016

mcollina commented Dec 7, 2016

GlenTiki commented Dec 8, 2016

GlenTiki commented Dec 8, 2016

mcollina left a comment

mcollina commented Dec 9, 2016

03k64 commented Dec 9, 2016

03k64 commented Dec 9, 2016

03k64 commented Dec 9, 2016

mcollina commented Dec 9, 2016

GlenTiki commented Dec 9, 2016

mcollina commented Dec 9, 2016

03k64 commented Dec 9, 2016

GlenTiki commented Dec 9, 2016

03k64 commented Dec 12, 2016

mcollina commented Dec 12, 2016

Unique Identifiers for POST Requests #98

Unique Identifiers for POST Requests #98

Conversation

03k64 commented Dec 7, 2016

Problem

Solution

mcollina commented Dec 7, 2016

03k64 commented Dec 7, 2016

GlenTiki Dec 7, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GlenTiki commented Dec 7, 2016

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

mcollina commented Dec 7, 2016

GlenTiki commented Dec 8, 2016

GlenTiki commented Dec 8, 2016

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented Dec 9, 2016

03k64 commented Dec 9, 2016

03k64 commented Dec 9, 2016

03k64 commented Dec 9, 2016

mcollina commented Dec 9, 2016

GlenTiki commented Dec 9, 2016

mcollina commented Dec 9, 2016

03k64 commented Dec 9, 2016

GlenTiki commented Dec 9, 2016

03k64 commented Dec 12, 2016

mcollina commented Dec 12, 2016

GlenTiki Dec 7, 2016 •

edited

Loading