Skip to content

[ES|QL] SET header instruction parsing #236460

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

Merged
merged 12 commits into from
Oct 6, 2025
Merged

[ES|QL] SET header instruction parsing #236460

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
21002d4
set instruction parsing
vadimkibana Oct 1, 2025
d180d2d
Merge branch 'main' into esql-set-instruction-2
vadimkibana Oct 1, 2025
7a24ce6
Merge branch 'main' into esql-set-instruction-2
vadimkibana Oct 2, 2025
c446803
update type
vadimkibana Oct 2, 2025
bdd700c
fixup types in traversal
vadimkibana Oct 2, 2025
6ed9f1f
better handling for missing query
vadimkibana Oct 2, 2025
018bcf8
Merge branch 'main' into esql-set-instruction-2
vadimkibana Oct 2, 2025
e3f0c9d
Merge branch 'main' into esql-set-instruction-2
vadimkibana Oct 5, 2025
dc92710
Merge branch 'main' into esql-set-instruction-2
vadimkibana Oct 6, 2025
0130bf1
fixup tests
vadimkibana Oct 6, 2025
09fbc6d
fixup more tests
vadimkibana Oct 6, 2025
37d53a8
one error
vadimkibana Oct 6, 2025
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
150 changes: 150 additions & 0 deletions src/platform/packages/shared/kbn-esql-ast/src/builder/builder.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,3 +525,153 @@ describe('map', () => {
});
});
});

describe('header', () => {
describe('.command()', () => {
test('can create a generic header command', () => {
const node = Builder.header.command({
name: 'custom_header',
args: [Builder.expression.literal.integer(42)],
});

expect(node).toMatchObject({
type: 'header-command',
name: 'custom_header',
args: [
{
type: 'literal',
literalType: 'integer',
value: 42,
},
],
});
});

test('can create a header command with no args', () => {
const node = Builder.header.command({
name: 'some_command',
});

expect(node).toMatchObject({
type: 'header-command',
name: 'some_command',
args: [],
});
});
});

describe('.command.set()', () => {
test('can create a SET command with single assignment', () => {
const node = Builder.header.command.set([
Builder.expression.func.binary('=', [
Builder.identifier('setting1'),
Builder.expression.literal.string('value1'),
]),
]);

expect(node).toMatchObject({
type: 'header-command',
name: 'set',
args: [
{
type: 'function',
name: '=',
subtype: 'binary-expression',
args: [
{
type: 'identifier',
name: 'setting1',
},
{
type: 'literal',
literalType: 'keyword',
valueUnquoted: 'value1',
},
],
},
],
});
});

test('can create a SET command with multiple assignments', () => {
const node = Builder.header.command.set([
Builder.expression.func.binary('=', [
Builder.identifier('setting1'),
Builder.expression.literal.string('value1'),
]),
Builder.expression.func.binary('=', [
Builder.identifier('setting2'),
Builder.expression.literal.integer(42),
]),
]);

expect(node).toMatchObject({
type: 'header-command',
name: 'set',
args: [
{
type: 'function',
name: '=',
args: [
{
type: 'identifier',
name: 'setting1',
},
{
type: 'literal',
literalType: 'keyword',
valueUnquoted: 'value1',
},
],
},
{
type: 'function',
name: '=',
args: [
{
type: 'identifier',
name: 'setting2',
},
{
type: 'literal',
literalType: 'integer',
value: 42,
},
],
},
],
});
});

test('can create a SET command with integer value', () => {
const node = Builder.header.command.set([
Builder.expression.func.binary('=', [
Builder.identifier('timeout'),
Builder.expression.literal.integer(30),
]),
]);

expect(node).toMatchObject({
type: 'header-command',
name: 'set',
args: [
{
type: 'function',
name: '=',
args: [
{
type: 'identifier',
name: 'timeout',
},
{
type: 'literal',
literalType: 'integer',
value: 30,
},
],
},
],
});
});
});
});
44 changes: 44 additions & 0 deletions src/platform/packages/shared/kbn-esql-ast/src/builder/builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ import type {
ESQLMapEntry,
ESQLTimeDurationLiteral,
ESQLDatePeriodLiteral,
ESQLAstHeaderCommand,
ESQLAstSetHeaderCommand,
} from '../types';
import type { AstNodeParserFields, AstNodeTemplate, PartialFields } from './types';

Expand Down Expand Up @@ -641,4 +643,46 @@ export namespace Builder {
}
};
}

export namespace header {
export interface HeaderCommandBuilder {
<Name extends string>(
template: PartialFields<AstNodeTemplate<ESQLAstHeaderCommand<Name>>, 'args'>,
fromParser?: Partial<AstNodeParserFields>
): ESQLAstHeaderCommand<Name>;

set: (
args: ESQLAstSetHeaderCommand['args'],
template?: Omit<PartialFields<AstNodeTemplate<ESQLAstSetHeaderCommand>, 'args'>, 'name'>,
fromParser?: Partial<AstNodeParserFields>
) => ESQLAstSetHeaderCommand;
}

// eslint-disable-next-line @typescript-eslint/no-shadow
export const command: HeaderCommandBuilder = Object.assign(
<Name extends string>(
template: PartialFields<AstNodeTemplate<ESQLAstHeaderCommand<Name>>, 'args'>,
fromParser?: Partial<AstNodeParserFields>
): ESQLAstHeaderCommand<Name> => {
return {
...template,
...Builder.parserFields(fromParser),
args: template.args ?? [],
type: 'header-command',
};
},
{
set: (
args: ESQLAstSetHeaderCommand['args'],
template?: Omit<PartialFields<AstNodeTemplate<ESQLAstSetHeaderCommand>, 'args'>, 'name'>,
fromParser?: Partial<AstNodeParserFields>
): ESQLAstSetHeaderCommand => {
return Builder.header.command(
{ args, ...template, name: 'set' },
fromParser
) as ESQLAstSetHeaderCommand;
},
}
);
}
}
Loading