Additional options to r.http

[marshall007]

See #36. Still not the complete list, but this adds support for:

• resultFormat
• timeout (needs test)
• redirects (needs test)
• header
• params

There are currently three failing test cases. I think this is because Query::evaluate is stripping out all the options passed to r.http. I haven't had time to figure out why that's the case and I'm also not sure whether I should expect options or internalOptions to be populated with the user-supplied options. Let me know and I'll update this PR.

The reason I don't have tests for timeout and redirects is because (AFAIK) there's no way to emulate that with httpbin.

[neumino]

Thanks @marshall007, I've been quite busy these past weeks and didn't have much time to work on reqlite, so I really appreciate your help :)

What you probably want to populate is options. internalOptions is currently only used to track if a query is atomic (for writes).
For example for update, we set deterministic: true.
https://github.com/neumino/reqlite/blob/master/lib/document.js#L36

Let me know if you have more questions.
For timeout/redirects, it's fine if there are no tests. If you can manually check it, it's cool, else we'll just pay attention when merging :)

[marshall007]

No problem! One other thing: when I call r.http(..., { header: [ 'User-Agent: ...' ] }) from the tests, the options passed to me are { header: [ 2, [ 'User-Agent: ...' ] ] }. Is this a bug?

[neumino]

@marshall007 -- arrays are represented with the MAKE_ARRAY from the proto-def.js file:

[2, [x1, x2, ...]]

If you want it as [x1, x2, ...], you can call util.toDatum(<value>)

[marshall007]

@neumino if I call util.toDatum([ 2, [ 'User-Agent: ...' ] ]) I just get back a copy of the array.

Could you explain what Query.prototype.evaluate is doing and why some terms call it with args[0] and others pass their options argument?

[neumino]

Sure, first sorry for the lack of comments/doc. I'll try to improve that.

Then basically Query.prototype.evaluate evaluates a term. Baring primitives, terms are what the JSON object that the drivers build.

For example [2, ["foo", "bar"] is r.expr(["foo", "bar"]) and where 2 is MAKE_ARRAY. We basically carry terms everywhere and evaluates them (to datum) only when we need.

In the case of r.http and its options, we can have:

r.http("www.example.com", { timeout: 200})

In this case it's trivial to evaluate the options, it's {timeout: 200}. The reason why we need to evaluate the options is because this is allowed:

r.http("www.example.com", { timeout: r.random()})
// or
r.http("www.example.com", { timeout: r.table('constant').get('httptimeout')('value')})

[neumino]

Here you want options.header

[neumino]

Added a few comments in your commits, hopefully it make things more clear. Let me know if you have more questions.

[neumino]

Oh also self.evaluate(args[0], internalOptions) means that we are going to evaluate the first argument of a given method.
self.evalute(options, internalOptions) means that we are going to evaluate the options of the given method.

So for example for r.random(3, 4, {float: true}), args is [3, 4] and options is {float: true}