JQ filtering in client #20
Conversation
client/filter.ts
Outdated
| // jq-node doesn't support `import` syntax | ||
| const jq = require("node-jq"); | ||
|
|
||
| export const jpFilter = async ( |
There was a problem hiding this comment.
I assume you meant
| export const jpFilter = async ( | |
| export const jqFilter = async ( |
client/filter.ts
Outdated
|
|
||
| const logger = createLogger({ name: "filter" }); | ||
|
|
||
| // jq-node doesn't support `import` syntax |
There was a problem hiding this comment.
Mmm I think rather our node config doesn't support import of this module. Can you explain the error you get here, and leave a TODO to fix our node config?
There was a problem hiding this comment.
Module '"node-jq"' has no exported member 'jq'.
| data: any, | ||
| jqHeader: string | string[] | undefined | ||
| ): Promise<any> => { | ||
| const query = isArray(jqHeader) ? jqHeader[0] : jqHeader; |
There was a problem hiding this comment.
Wouldn't you want to run this multiple times if there are multiple headers?
| const query = isArray(jqHeader) ? jqHeader[0] : jqHeader; | |
| const query = isArray(jqHeader) ? jqHeader : [jqHeader]; |
There was a problem hiding this comment.
You mean chain the header jq commands? The output of the first is the input of the second?
I don't know if that's helpful, I think chains should be expressible in one query.
client/filter.ts
Outdated
| return data; | ||
| } | ||
| try { | ||
| // jq.run() returns a Promise |
There was a problem hiding this comment.
nit: I think this comment is unnecessary. The fact the line below passes eslint already means the function returns a promise.
| @@ -22,6 +22,7 @@ export const createLogger = <T extends LoggerOptions>( | |||
| // Redact the authorization header that may contain a secret token | |||
| redact: [ | |||
| "response.config.headers.authorization", // Axios intercepted response object | |||
| "response.request.headers.authorization", // Axios intercepted response object contains the request as well | |||
| "request.headers.authorization", // Axios intercepted request object + forwarded request object (JSON RPC request) | |||
There was a problem hiding this comment.
Do you also want just headers? it looks like you manually assign request / response headers to a bare headers field in some logs.
types/index.ts
Outdated
| @@ -2,6 +2,8 @@ import { Request } from "express"; | |||
| import core from "express-serve-static-core"; | |||
| import { IncomingHttpHeaders } from "node:http"; | |||
|
|
|||
| export const JQ_HEADER = "braekhus-jq-response-filter"; | |||
There was a problem hiding this comment.
what motivated you not to add a x- prefix? Any specific reason?
There was a problem hiding this comment.
It's not recommended anymore:
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
types/index.ts
Outdated
| @@ -2,6 +2,8 @@ import { Request } from "express"; | |||
| import core from "express-serve-static-core"; | |||
| import { IncomingHttpHeaders } from "node:http"; | |||
|
|
|||
| export const JQ_HEADER = "braekhus-jq-response-filter"; | |||
There was a problem hiding this comment.
This is a jq program, not a filter, right? Were it a filter I presume your invocation would look more like jq.run(". | " + filter, ...).
Should this be
| export const JQ_HEADER = "braekhus-jq-response-filter"; | |
| export const JQ_HEADER = "x-braekhus-response-jq-program"; |
?
There was a problem hiding this comment.
Called it braekhus-response-jq-transform
Add ability to specify a
jqfilter that is applied to the response body. Allows extracting only parts of the response, which is useful when the response is verbose and the server is only interested in specific part of the response. An example use case is listing Kubernetes resources where the metadata of each item in the response is very verbose. (See test case for a concrete example.) Uses the node-jq library.The jq tranform expression is passed in the
braekhus-jq-response-transformheader - not prefixedx-as recommended by https://specs.openstack.org/openstack/api-wg/guidelines/headers.htmlAlso:
prettier.config.jsto codify import orderyarn preparefailed locally because of cd-ing out of current directory)