zabbix/zabbix-graphql-api
1
0
Fork 0
Code Pull requests Activity

feat(query-optimization): implement GraphQL query optimization and enhance regression suite

Browse source 
- **Optimization**: Implemented automatic Zabbix parameter optimization by analyzing GraphQL selection sets.

- **ZabbixRequest**: Added optimizeZabbixParams with support for skippable parameters and implied field dependencies (e.g., state -> items).

- **Resolvers**: Updated allHosts, allDevices, allHostGroups, and templates to pass requested fields to data sources.

- **Data Sources**: Optimized ZabbixQueryHostsGenericRequest and ZabbixQueryTemplatesRequest to skip unnecessary Zabbix API calls.

- **Regression Tests**: Enhanced RegressionTestExecutor with new tests for optimization (REG-OPT, REG-OPT-NEG), state retrieval (REG-STATE), dependent items (REG-DEP), and empty results (REG-EMPTY).

- **Documentation**: Created query_optimization.md How-To guide and updated roadmap.md, README.md, and tests.md.

- **Bug Fixes**: Fixed deviceType tag assignment during host import and corrected ZabbixCreateHostRequest to support tags.
This commit is contained in:
Andreas Hilbig 2026-02-02 06:23:35 +01:00
parent ad104acde2
commit 97a0f70fd6
16 changed files with 835 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

191
src/test/query_optimization.test.ts Normal file
View file

@ -0,0 +1,191 @@
import {createResolvers} from "../api/resolvers.js";
import {zabbixAPI} from "../datasources/zabbix-api.js";
import {QueryAllHostsArgs, QueryTemplatesArgs} from "../schema/generated/graphql.js";
// Mocking ZabbixAPI
jest.mock("../datasources/zabbix-api.js", () => ({
zabbixAPI: {
executeRequest: jest.fn(),
post: jest.fn(),
baseURL: "http://mock-zabbix",
}
}));
// Mocking Config
jest.mock("../common_utils.js", () => ({
Config: {
HOST_TYPE_FILTER_DEFAULT: null,
HOST_GROUP_FILTER_DEFAULT: null
}
}));
describe("Query Optimization", () => {
let resolvers: any;
beforeEach(() => {
jest.clearAllMocks();
resolvers = createResolvers();
});
test("allHosts optimization - reduce output and skip selectTags/selectItems", async () => {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const args: QueryAllHostsArgs = {};
const context = {
zabbixAuthToken: "test-token",
dataSources: { zabbixAPI: zabbixAPI }
};
const info = {
fieldNodes: [{
selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'hostid' } },
{ kind: 'Field', name: { value: 'name' } }
]
}
}]
};
await resolvers.Query.allHosts(null, args, context, info);
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
body: expect.objectContaining({
params: expect.objectContaining({
output: ["hostid", "name"]
})
})
}));
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
expect(callParams.selectTags).toBeUndefined();
expect(callParams.selectItems).toBeUndefined();
expect(callParams.selectParentTemplates).toBeUndefined();
// Verify no follow-up item.get call
const itemGetCall = (zabbixAPI.post as jest.Mock).mock.calls.find(call => call[1].body.method === "item.get");
expect(itemGetCall).toBeUndefined();
});
test("allHosts optimization - keep selectTags when requested", async () => {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const args: QueryAllHostsArgs = {};
const context = {
zabbixAuthToken: "test-token",
dataSources: { zabbixAPI: zabbixAPI }
};
const info = {
fieldNodes: [{
selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'hostid' } },
{ kind: 'Field', name: { value: 'tags' } }
]
}
}]
};
await resolvers.Query.allHosts(null, args, context, info);
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
body: expect.objectContaining({
params: expect.objectContaining({
output: ["hostid"],
selectTags: expect.any(Array)
})
})
}));
});
test("templates optimization - reduce output and skip selectItems", async () => {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const args: QueryTemplatesArgs = {};
const context = {
zabbixAuthToken: "test-token",
dataSources: { zabbixAPI: zabbixAPI }
};
const info = {
fieldNodes: [{
selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'name' } }
]
}
}]
};
await resolvers.Query.templates(null, args, context, info);
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
body: expect.objectContaining({
params: expect.objectContaining({
output: ["name"]
})
})
}));
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
expect(callParams.selectItems).toBeUndefined();
});
test("allHosts optimization - indirect dependency via nested state field", async () => {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const args: QueryAllHostsArgs = {};
const context = {
zabbixAuthToken: "test-token",
dataSources: { zabbixAPI: zabbixAPI }
};
const info = {
fieldNodes: [{
selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'state' }, selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'operational' }, selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'temperature' } }
]
} }
]
} }
]
}
}]
};
await resolvers.Query.allHosts(null, args, context, info);
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
expect(callParams.selectItems).toBeDefined();
expect(Array.isArray(callParams.output)).toBe(true);
expect(callParams.output).toContain("items");
});
test("allDevices optimization - skip items when not requested", async () => {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const args: any = {};
const context = {
zabbixAuthToken: "test-token",
dataSources: { zabbixAPI: zabbixAPI }
};
const info = {
fieldNodes: [{
selectionSet: {
selections: [
{ kind: 'Field', name: { value: 'hostid' } },
{ kind: 'Field', name: { value: 'name' } }
]
}
}]
};
await resolvers.Query.allDevices(null, args, context, info);
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
expect(callParams.selectItems).toBeUndefined();
expect(callParams.output).not.toContain("items");
});
});