|
| 1 | +import { createClient } from '@clickhouse/client'; |
| 2 | +import { ClickHouseClient } from '@clickhouse/client-common'; |
| 3 | + |
| 4 | +import { ClickhouseClient as HdxClickhouseClient } from '@/clickhouse/node'; |
| 5 | +import { Metadata, MetadataCache } from '@/metadata'; |
| 6 | +import { ChartConfigWithDateRange } from '@/types'; |
| 7 | + |
| 8 | +describe('Metadata Integration Tests', () => { |
| 9 | + let client: ClickHouseClient; |
| 10 | + let hdxClient: HdxClickhouseClient; |
| 11 | + |
| 12 | + beforeAll(() => { |
| 13 | + const host = process.env.CLICKHOUSE_HOST || 'http://localhost:8123'; |
| 14 | + const username = process.env.CLICKHOUSE_USER || 'default'; |
| 15 | + const password = process.env.CLICKHOUSE_PASSWORD || ''; |
| 16 | + |
| 17 | + client = createClient({ |
| 18 | + url: host, |
| 19 | + username, |
| 20 | + password, |
| 21 | + }); |
| 22 | + |
| 23 | + hdxClient = new HdxClickhouseClient({ |
| 24 | + host, |
| 25 | + username, |
| 26 | + password, |
| 27 | + }); |
| 28 | + }); |
| 29 | + |
| 30 | + describe('getKeyValues', () => { |
| 31 | + let metadata: Metadata; |
| 32 | + const chartConfig: ChartConfigWithDateRange = { |
| 33 | + connection: 'test_connection', |
| 34 | + from: { |
| 35 | + databaseName: 'default', |
| 36 | + tableName: 'test_table', |
| 37 | + }, |
| 38 | + dateRange: [new Date('2023-01-01'), new Date('2025-01-01')], |
| 39 | + select: 'col1, col2', |
| 40 | + timestampValueExpression: 'Timestamp', |
| 41 | + where: '', |
| 42 | + }; |
| 43 | + |
| 44 | + beforeAll(async () => { |
| 45 | + await client.command({ |
| 46 | + query: `CREATE OR REPLACE TABLE default.test_table ( |
| 47 | + Timestamp DateTime64(9) CODEC(Delta(8), ZSTD(1)), |
| 48 | + SeverityText LowCardinality(String) CODEC(ZSTD(1)), |
| 49 | + TraceId String, |
| 50 | + LogAttributes JSON CODEC(ZSTD(1)), |
| 51 | + ResourceAttributes Map(LowCardinality(String), String) CODEC(ZSTD(1)), |
| 52 | + \`__hdx_materialized_k8s.pod.name\` String MATERIALIZED ResourceAttributes['k8s.pod.name'] CODEC(ZSTD(1)), |
| 53 | + ) |
| 54 | + ENGINE = MergeTree() |
| 55 | + ORDER BY (Timestamp) |
| 56 | + `, |
| 57 | + }); |
| 58 | + |
| 59 | + await client.command({ |
| 60 | + query: `INSERT INTO default.test_table (Timestamp, SeverityText, TraceId, ResourceAttributes, LogAttributes) VALUES |
| 61 | + ('2023-06-01 12:00:00', 'info', '1o2udn120d8n', { 'k8s.pod.name': 'pod1', 'env': 'prod' },'{"action":"ping"}'), |
| 62 | + ('2024-06-01 12:00:00', 'error', '67890-09098', { 'k8s.pod.name': 'pod2', 'env': 'prod' },'{}'), |
| 63 | + ('2024-06-01 12:00:00', 'info', '11h9238re1h92', { 'env': 'staging' },'{"user":"john"}'), |
| 64 | + ('2024-06-01 12:00:00', 'warning', '1o2udn120d8n', { 'k8s.pod.name': 'pod1', 'env': 'prod' }, '{"user":"jack","action":"login"}'), |
| 65 | + ('2024-06-01 12:00:00', '', '1o2udn120d8n', { 'env': 'prod' }, '{"user":"jane","action":"login"}') |
| 66 | + `, |
| 67 | + }); |
| 68 | + }); |
| 69 | + |
| 70 | + beforeEach(async () => { |
| 71 | + metadata = new Metadata(hdxClient, new MetadataCache()); |
| 72 | + }); |
| 73 | + |
| 74 | + afterAll(async () => { |
| 75 | + await client.command({ |
| 76 | + query: 'DROP TABLE IF EXISTS default.test_table', |
| 77 | + }); |
| 78 | + }); |
| 79 | + |
| 80 | + describe.each([true, false])('with disableRowLimit=%s', disableRowLimit => { |
| 81 | + it('should return key-value pairs for a given metadata key', async () => { |
| 82 | + const resultSeverityText = await metadata.getKeyValues({ |
| 83 | + chartConfig, |
| 84 | + keys: ['SeverityText'], |
| 85 | + disableRowLimit, |
| 86 | + }); |
| 87 | + |
| 88 | + expect(resultSeverityText).toHaveLength(1); |
| 89 | + expect(resultSeverityText[0].key).toBe('SeverityText'); |
| 90 | + expect(resultSeverityText[0].value).toHaveLength(3); |
| 91 | + expect(resultSeverityText[0].value).toEqual( |
| 92 | + expect.arrayContaining(['info', 'error', 'warning']), |
| 93 | + ); |
| 94 | + |
| 95 | + const resultTraceId = await metadata.getKeyValues({ |
| 96 | + chartConfig, |
| 97 | + keys: ['TraceId'], |
| 98 | + disableRowLimit, |
| 99 | + }); |
| 100 | + |
| 101 | + expect(resultTraceId).toHaveLength(1); |
| 102 | + expect(resultTraceId[0].key).toBe('TraceId'); |
| 103 | + expect(resultTraceId[0].value).toHaveLength(3); |
| 104 | + expect(resultTraceId[0].value).toEqual( |
| 105 | + expect.arrayContaining([ |
| 106 | + '1o2udn120d8n', |
| 107 | + '67890-09098', |
| 108 | + '11h9238re1h92', |
| 109 | + ]), |
| 110 | + ); |
| 111 | + |
| 112 | + const resultBoth = await metadata.getKeyValues({ |
| 113 | + chartConfig, |
| 114 | + keys: ['TraceId', 'SeverityText'], |
| 115 | + disableRowLimit, |
| 116 | + }); |
| 117 | + |
| 118 | + expect(resultBoth).toEqual([ |
| 119 | + { |
| 120 | + key: 'TraceId', |
| 121 | + value: expect.arrayContaining([ |
| 122 | + '1o2udn120d8n', |
| 123 | + '67890-09098', |
| 124 | + '11h9238re1h92', |
| 125 | + ]), |
| 126 | + }, |
| 127 | + { |
| 128 | + key: 'SeverityText', |
| 129 | + value: expect.arrayContaining(['info', 'error', 'warning']), |
| 130 | + }, |
| 131 | + ]); |
| 132 | + }); |
| 133 | + |
| 134 | + it('should handle materialized columns correctly', async () => { |
| 135 | + const resultPodName = await metadata.getKeyValues({ |
| 136 | + chartConfig, |
| 137 | + keys: ['__hdx_materialized_k8s.pod.name'], |
| 138 | + disableRowLimit, |
| 139 | + }); |
| 140 | + |
| 141 | + expect(resultPodName).toHaveLength(1); |
| 142 | + expect(resultPodName[0].key).toBe('__hdx_materialized_k8s.pod.name'); |
| 143 | + expect(resultPodName[0].value).toHaveLength(2); |
| 144 | + expect(resultPodName[0].value).toEqual( |
| 145 | + expect.arrayContaining(['pod1', 'pod2']), |
| 146 | + ); |
| 147 | + }); |
| 148 | + |
| 149 | + it('should handle JSON columns correctly', async () => { |
| 150 | + const resultLogAttributes = await metadata.getKeyValues({ |
| 151 | + chartConfig, |
| 152 | + keys: ['LogAttributes.user'], |
| 153 | + disableRowLimit, |
| 154 | + }); |
| 155 | + |
| 156 | + expect(resultLogAttributes).toHaveLength(1); |
| 157 | + expect(resultLogAttributes[0].key).toBe('LogAttributes.user'); |
| 158 | + expect(resultLogAttributes[0].value).toHaveLength(3); |
| 159 | + expect(resultLogAttributes[0].value).toEqual( |
| 160 | + expect.arrayContaining(['john', 'jack', 'jane']), |
| 161 | + ); |
| 162 | + }); |
| 163 | + |
| 164 | + it('should return an empty list when no keys are provided', async () => { |
| 165 | + const resultEmpty = await metadata.getKeyValues({ |
| 166 | + chartConfig, |
| 167 | + keys: [], |
| 168 | + }); |
| 169 | + |
| 170 | + expect(resultEmpty).toEqual([]); |
| 171 | + }); |
| 172 | + |
| 173 | + it('should correctly limit the number of returned values', async () => { |
| 174 | + const resultLimited = await metadata.getKeyValues({ |
| 175 | + chartConfig, |
| 176 | + keys: ['SeverityText'], |
| 177 | + limit: 2, |
| 178 | + }); |
| 179 | + |
| 180 | + expect(resultLimited).toHaveLength(1); |
| 181 | + expect(resultLimited[0].key).toBe('SeverityText'); |
| 182 | + expect(resultLimited[0].value).toHaveLength(2); |
| 183 | + expect( |
| 184 | + resultLimited[0].value.every(v => |
| 185 | + ['info', 'error', 'warning'].includes(v), |
| 186 | + ), |
| 187 | + ).toBeTruthy(); |
| 188 | + }); |
| 189 | + }); |
| 190 | + }); |
| 191 | +}); |
0 commit comments