Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include source in parsed request #67

Merged
merged 1 commit into from
Nov 22, 2024
Merged

include source in parsed request #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/exporters/javascript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export class JavaScriptExporter implements FormatExporter {
Handlebars.registerHelper(
"supportedApi",
function (this: ParsedRequest, options) {
if (!UNSUPPORTED_APIS.test(this.api as string)) {
if (!UNSUPPORTED_APIS.test(this.api as string) && this.request) {
return options.fn(this);
} else {
return options.inverse(this);
Expand Down
2 changes: 1 addition & 1 deletion src/exporters/python.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export class PythonExporter implements FormatExporter {
Handlebars.registerHelper(
"supportedApi",
function (this: ParsedRequest, options) {
if (!UNSUPPORTED_APIS.test(this.api as string)) {
if (!UNSUPPORTED_APIS.test(this.api as string) && this.request) {
return options.fn(this);
} else {
return options.inverse(this);
Expand Down
7 changes: 6 additions & 1 deletion src/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ export type ParseOptions = {
};

export type ParsedRequest = {
/** The source request. */
source: string;
/** The name of the Elasticsearch API this request refers to. */
api?: string;
/** The request definition from the Elasticsearch specification that applies to this request. */
Expand Down Expand Up @@ -110,9 +112,12 @@ function parseCommand(source: string, options: ParseOptions) {
// removes comments tags, such as `<1>`
.replace(/<([\S\s])>/g, "")
// removes comments, such as `// optional`
.replace(/\/\/\s.+/g, "");
.replace(/\s*\/\/\s.+/g, "")
// trimp whitespace
.trim();

const data: ParsedRequest = {
source: source,
params: {},
method: "",
url: "",
Expand Down
4 changes: 0 additions & 4 deletions tests/integration/skip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,10 +375,6 @@ const skip: Record<string, SkippedTest> = {
reason: "test passes boolean field as string",
formats: ["python"],
},
"2577acb462b95bd4394523cf2f8a661f": {
reason: "example uses undefined `tables` attribute",
formats: ["python"],
},
"20e3b181114e00c943a27a9bbcf85f15": {
reason: "test passes date epoch number as string",
formats: ["javascript"],
Expand Down
22 changes: 22 additions & 0 deletions tests/parse.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ describe("parse", () => {
it("parses info GET request", async () => {
const req = await parseRequest("GET /");
expect(req).toMatchObject({
source: "GET /",
api: "info",
params: {},
method: "GET",
Expand All @@ -17,6 +18,7 @@ describe("parse", () => {
"GET /my-index/_search?size=5&expand_wildcards",
);
expect(req).toMatchObject({
source: "GET /my-index/_search?size=5&expand_wildcards",
api: "search",
params: { index: "my-index" },
method: "GET",
Expand All @@ -33,6 +35,7 @@ describe("parse", () => {
}
`);
expect(req).toMatchObject({
source: 'POST /my-index/_search\n{\n "size": 5\n}',
api: "search",
params: { index: "my-index" },
method: "POST",
Expand All @@ -45,6 +48,7 @@ describe("parse", () => {
it("parses search POST request given in a single line", async () => {
const req = await parseRequest(`POST /my-index/_search { "size": 5 }`);
expect(req).toMatchObject({
source: 'POST /my-index/_search { "size": 5 }',
api: "search",
params: { index: "my-index" },
method: "POST",
Expand Down Expand Up @@ -95,6 +99,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
`);
expect(reqs.length).toEqual(11);
expect(reqs[0]).toMatchObject({
source: 'PUT /customer/_doc/1?foo=bar\n{\n "name": "John Doe"\n}',
api: "index",
params: { index: "customer", id: "1" },
method: "PUT",
Expand All @@ -105,6 +110,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
body: { name: "John Doe" },
});
expect(reqs[1]).toMatchObject({
source: "GET /customer/_doc/1",
api: "get",
params: { index: "customer", id: "1" },
method: "GET",
Expand All @@ -113,6 +119,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
rawPath: "/customer/_doc/1",
});
expect(reqs[2]).toMatchObject({
source: "GET/customer/_doc/1?foo=bar&v",
api: "get",
params: { index: "customer", id: "1" },
method: "GET",
Expand All @@ -122,6 +129,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
query: { foo: "bar", v: "true" },
});
expect(reqs[3]).toMatchObject({
source:
'PUT /customer%7B/_doc/1{\n "foo": {\n "bar": "GET{POST}"\n }\n}',
api: "index",
params: { index: "customer{", id: "1" },
method: "PUT",
Expand All @@ -131,6 +140,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
body: { foo: { bar: "GET{POST}" } },
});
expect(reqs[4]).toMatchObject({
source: "GET /customer/_doc/1",
api: "get",
params: { index: "customer", id: "1" },
method: "GET",
Expand All @@ -139,6 +149,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
rawPath: "/customer/_doc/1",
});
expect(reqs[5]).toMatchObject({
source:
'POST /_bulk?foo=bar\n{ "name": "John Doe" }\n{ "name": "John Doe" }\n{ "name": "John Doe" }',
api: "bulk",
params: {},
method: "POST",
Expand All @@ -149,6 +161,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
body: [{ name: "John Doe" }, { name: "John Doe" }, { name: "John Doe" }],
});
expect(reqs[6]).toMatchObject({
source:
'POST /_bulk?foo=bar\n{ "name": "John\\nDoe" }\n{ "name": "John\\nDoe" }\n{ "name": "John\\nDoe" }',
api: "bulk",
params: {},
method: "POST",
Expand All @@ -163,6 +177,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
],
});
expect(reqs[7]).toMatchObject({
source: "GET /{customer}/_doc/1",
api: "get",
params: { index: "{customer}", id: "1" },
method: "GET",
Expand All @@ -171,6 +186,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
rawPath: "/%7Bcustomer%7D/_doc/1",
});
expect(reqs[8]).toMatchObject({
source:
'POST _nodes/reload_secure_settings\n{\n "reload_secure_settings": "s3cr3t" \n}',
api: "nodes.reload_secure_settings",
params: {},
method: "POST",
Expand All @@ -180,6 +197,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
body: { reload_secure_settings: "s3cr3t" },
});
expect(reqs[9]).toMatchObject({
source:
'GET {my_index}/_analyze \n{\n "field": "text",\n "text": "The quick Brown Foxes."\n}',
api: "indices.analyze",
params: { index: "{my_index}" },
method: "GET",
Expand All @@ -189,6 +208,8 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
body: { field: "text", text: "The quick Brown Foxes." },
});
expect(reqs[10]).toMatchObject({
source:
'POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n{\n "description": "Snapshot 1",\n "retain": true\n}',
api: "ml.update_model_snapshot",
params: { job_id: "it_ops_new_logs", snapshot_id: "1491852978" },
method: "POST",
Expand Down Expand Up @@ -224,6 +245,7 @@ POST\n_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update\n
);
const req = await parseRequest(script, { ignoreErrors: true });
expect(req).toMatchObject({
source: 'GET /my-index/_search\n{\n "query": ...\n}',
api: "search",
body: '\n{\n "query": ...\n}',
method: "GET",
Expand Down
Loading