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.

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

feat(tag): visualize history of multiple tags #60

Merged
merged 5 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
136 changes: 115 additions & 21 deletions src/datasources/tag/TagDataSource.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
setupDataSource,
} from 'test/fixtures';
import { TagDataSource } from './TagDataSource';
import { TagQuery, TagQueryType, TagWithValue } from './types';
import { TagQuery, TagQueryType, TagWithValue, TagDataType } from './types';

let ds: TagDataSource, backendSrv: MockProxy<BackendSrv>, templateSrv: MockProxy<TemplateSrv>;

Expand Down Expand Up @@ -124,24 +124,24 @@ describe('queries', () => {
test('current value for all data types', async () => {
backendSrv.fetch
.mockReturnValueOnce(createQueryTagsResponse([{
tag: { type: 'INT', path: 'tag1' },
tag: { type: TagDataType.INT, path: 'tag1' },
current: { value: { value: '3' } }
}]))
.mockReturnValueOnce(createQueryTagsResponse([{
tag: { type: 'DOUBLE', path: 'tag2' },
tag: { type: TagDataType.DOUBLE, path: 'tag2' },
current: { value: { value: '3.3' } }
}]))
.mockReturnValueOnce(createQueryTagsResponse([{
tag: { type: 'STRING', path: 'tag3' },
tag: { type: TagDataType.STRING, path: 'tag3' },
current: { value: { value: 'foo' } }
}]))
.mockReturnValueOnce(createQueryTagsResponse([{
tag: { type: 'BOOLEAN', path: 'tag4' },
tag: { type: TagDataType.BOOLEAN, path: 'tag4' },
current: { value: { value: 'True' } }
}]))
.mockReturnValueOnce(
createQueryTagsResponse([{
tag: { type: 'U_INT64', path: 'tag5' },
tag: { type: TagDataType.U_INT64, path: 'tag5' },
current: { value: { value: '2147483648' } }
}])
);
Expand Down Expand Up @@ -180,9 +180,73 @@ describe('queries', () => {
})
)
.mockReturnValue(
createTagHistoryResponse('my.tag', 'DOUBLE', [
{ timestamp: '2023-01-01T00:00:00Z', value: '1' },
{ timestamp: '2023-01-01T00:01:00Z', value: '2' },
createTagHistoryResponse([
{
path: 'my.tag',
type: TagDataType.DOUBLE,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '1' },
{ timestamp: '2023-01-01T00:01:00Z', value: '2' },
]
}
])
);

const result = await ds.query(queryRequest);

expect(result.data).toMatchSnapshot();
});

test('numeric multiple tags history', async () => {
const queryRequest = buildQuery({ type: TagQueryType.History, path: 'my.tag.*' });

backendSrv.fetch
.calledWith(requestMatching({ url: '/nitag/v2/query-tags-with-values', data: { filter: 'path = "my.tag.*"' } }))
.mockReturnValue(createQueryTagsResponse([
{ tag: { path: 'my.tag.1' } },
{ tag: { path: 'my.tag.2' } },
{ tag: { path: 'my.tag.3' } }
]));

backendSrv.fetch
.calledWith(
requestMatching({
url: '/nitaghistorian/v2/tags/query-decimated-history',
data: {
paths: ['my.tag.1', 'my.tag.2', 'my.tag.3'],
workspace: '1',
startTime: queryRequest.range.from.toISOString(),
endTime: queryRequest.range.to.toISOString(),
decimation: 300,
},
})
)
.mockReturnValue(
createTagHistoryResponse([
{
path: 'my.tag.1',
type: TagDataType.DOUBLE,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '1' },
{ timestamp: '2023-01-01T00:01:00Z', value: '2' },
]
},
{
path: 'my.tag.2',
type: TagDataType.DOUBLE,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '2' },
{ timestamp: '2023-01-01T00:01:00Z', value: '3' },
]
},
{
path: 'my.tag.3',
type: TagDataType.DOUBLE,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '3' },
{ timestamp: '2023-01-01T00:02:00Z', value: '4' },
]
}
])
);

Expand All @@ -194,9 +258,15 @@ describe('queries', () => {
test('string tag history', async () => {
backendSrv.fetch.mockReturnValueOnce(createQueryTagsResponse());
backendSrv.fetch.mockReturnValueOnce(
createTagHistoryResponse('my.tag', 'STRING', [
{ timestamp: '2023-01-01T00:00:00Z', value: '3.14' },
{ timestamp: '2023-01-01T00:01:00Z', value: 'foo' },
createTagHistoryResponse([
{
path: 'my.tag',
type: TagDataType.STRING,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '3.14' },
{ timestamp: '2023-01-01T00:01:00Z', value: 'foo' },
]
}
])
);

Expand All @@ -212,9 +282,15 @@ describe('queries', () => {
backendSrv.fetch.mockReturnValueOnce(createQueryTagsResponse());

backendSrv.fetch.mockReturnValueOnce(
createTagHistoryResponse('my.tag', 'INT', [
{ timestamp: '2023-01-01T00:00:00Z', value: '1' },
{ timestamp: '2023-01-01T00:01:00Z', value: '2' },
createTagHistoryResponse([
{
path: 'my.tag',
type: TagDataType.INT,
values: [
{ timestamp: '2023-01-01T00:00:00Z', value: '1' },
{ timestamp: '2023-01-01T00:01:00Z', value: '2' },
]
}
])
);

Expand All @@ -236,7 +312,12 @@ describe('queries', () => {

test('filters by workspace if provided', async () => {
backendSrv.fetch.mockReturnValueOnce(createQueryTagsResponse([{ tag: { workspace: '2' } }]));
backendSrv.fetch.mockReturnValueOnce(createTagHistoryResponse('my.tag', 'DOUBLE', []));
backendSrv.fetch.mockReturnValueOnce(createTagHistoryResponse([{
path: 'my.tag',
type: TagDataType.DOUBLE,
values: []
}
]));

await ds.query(buildQuery({ type: TagQueryType.History, path: 'my.tag', workspace: '2' }));

Expand All @@ -247,7 +328,11 @@ describe('queries', () => {
test('retries failed request with 429 status', async () => {
backendSrv.fetch.mockReturnValueOnce(createQueryTagsResponse());
backendSrv.fetch.mockReturnValueOnce(createFetchError(429));
backendSrv.fetch.mockReturnValueOnce(createTagHistoryResponse('my.tag', 'INT', []));
backendSrv.fetch.mockReturnValueOnce(createTagHistoryResponse([{
path: 'my.tag',
type: TagDataType.INT,
values: []
}]));

await ds.query(buildQuery({ type: TagQueryType.History, path: 'my.tag' }));

Expand Down Expand Up @@ -299,7 +384,7 @@ describe('queries', () => {
tagsWithValues: [{ tag: { datatype: 'DOUBLE', path: 'my.tag', workspace_id: '1' } }],
})
)
.mockReturnValueOnce(createTagHistoryResponse('my.tag', 'DOUBLE', []));
.mockReturnValueOnce(createTagHistoryResponse([{ path: 'my.tag', type: TagDataType.DOUBLE, values: [] }]));

await ds.query(buildQuery({ path: 'my.tag', type: TagQueryType.History }));

Expand Down Expand Up @@ -352,12 +437,21 @@ function createQueryTagsResponse(
return createFetchResponse({
tagsWithValues: [{
current: { value: { value: '3.14' }, timestamp: '2023-10-04T00:00:00.000000Z' },
tag: { type: 'DOUBLE', path: 'my.tag', properties: {}, workspace: '1' },
tag: { type: TagDataType.DOUBLE, path: 'my.tag', properties: {}, workspace: '1' },
}],
});
}
}

function createTagHistoryResponse(path: string, type: string, values: Array<{ timestamp: string; value: string }>) {
return createFetchResponse({ results: { [path]: { type, values } } });

function createTagHistoryResponse(tagsHistory: Array<{
path: string,
type: TagDataType,
values: Array<{ timestamp: string; value: string }>
}>) {
const results: { [key: string]: { type: string, values: any[] } } = {};
tagsHistory.forEach(({ path, type, values }) => {
results[path] = { type, values };
});
return createFetchResponse({ results });
}
Loading
Loading