Wrong type leading to a tricky ECONNRESET bug

[nem035]

Bugs

1. TypeScript Bug: The type of limit is invalid for the IRequestRunQuery.
2. API Bug: Looker API returns ECONNRESET for invalid value for limit

Explanation

The limit property is defined as a string for the WriteQuery type (used for creating a query or running it inline) but defined as a number for the IRequestRunQuery type (used for running a previously created query).

Not only is this confusing...but it's also wrong.

Passing a number for the run query API calls errors with ECONNRESET every time.

const params: Partial<IWriteQuery> = {
  model: ...,
  view: ...,
  fields: [...],
};
const query = await sdk.ok(sdk.create_query(params));
const runParams: IRequestRunQuery = {
  query_id: 1,
  limit: 1 // <--- this can't be a number but types say it should be!
}
const result = await sdk.ok(sdk.run_query(runParams)) // <-- ECONNRESET every time.

Changing the 1 to a "1" does not lead to an ECONNRESET anymore but does conflict with the existing types and thus must be @ts-ignore-ed.

const params: Partial<IWriteQuery> = {
  model: ...,
  view: ...,
  fields: [...],
};
const query = await sdk.ok(sdk.create_query(params));
const runParams: IRequestRunQuery = {
  query_id: 1,
  // @ts-ignore
  limit: "1" // <--- this can't be a number but types say it should be!
}
const result = await sdk.ok(sdk.run_query(runParams)) // <-- ECONNRESET every time.

Note: the run query call also errors with ECONNRESET for any invalid value for limit, such as an empty string "":

const params: Partial<IWriteQuery> = {
  model: ...,
  view: ...,
  fields: [...],
};
const query = await sdk.ok(sdk.create_query(params));
const runParams: IRequestRunQuery = {
  query_id: 1,
  limit: "" // <--- this is invalid
}
const result = await sdk.ok(sdk.run_query(runParams)) // <-- ECONNRESET every time.

[nem035]

Ok it seems the ECONRESET error isn't that simple. I'm able to reproduce it on simple queries by adding filters or sorts as well...

It's difficult to pinpoint why exactly it happens but it does seem to be affected by mishandling of bad requests (should throw 4XX error instead)

[nem035]

I managed to isolate the issue to a single endpoint and am able to consistently reproduce it.

The erroring URL is a GET request to /queries/:query_id/run/json_bi?limit=1, like this:

GET https://$OBFUSCATED.looker.com:19999/api/4.0/queries/751560/run/json_bi?limit=1

After digging into the Looker SDK code base, the error returned is:

{
  "name": "RequestError",
  "message": "Error: socket hang up",
  "cause": {
    "code": "ECONNRESET"
  },
  "error": {
    "code": "ECONNRESET"
  },
  "options": {
    "encoding": null,
    "headers": {
      "x-looker-appid": "...",
      "Authorization": "Bearer $OBFUSCATED$"
    },
    "json": null,
    "method": "GET",
    "rejectUnauthorized": true,
    "resolveWithFullResponse": true,
    "timeout": 120000,
    "url": "https://$OBFUSCATED.looker.com:19999/api/4.0/queries/751560/run/json_bi?limit=1"
    "simple": true,
    "transform2xxOnly": false
  }
}

And the erroring is caught here: 

sdk-codegen/packages/sdk-node/src/nodeTransport.ts

Line 131 in 13f209c

let statusMessage = `${method} ${path}`;

[nem035]

On further inspection, it seems that the json_bi format is the issue.

Using the json format doesn't lead to ECONNRESET while using json_bi does.

This is quite strange but I am able to reproduce the results (tried 5 times).

Confusingly, json_bi is the recommended format even though it leads to an obfuscated issue like this.

This works:

GET /api/4.0/queries/:query_id/run/json

This throws ECONNRESET each time (for some queries):

GET /api/4.0/queries/:query_id/run/json_bi