@or-sdk/druid 1.1.0-beta.1311.0

package/src/__tests__/fixtures/scan_lookup_response.json

@@ -0,0 +1,31 @@
+[
+  {
+    "segmentId": "re_Telephony_text_partner_error_short_-146136543-09-08T08:23:32.096Z_146140482-04-24T15:36:27.903Z_dummy_version",
+    "columns": [
+      "k",
+      "v"
+    ],
+    "events": [
+      [
+        "bandwidth::4001",
+        "service-not-allowed"
+      ],
+      [
+        "bandwidth::4301",
+        "malformed-invalid-encoding"
+      ],
+      [
+        "bandwidth::4302",
+        "malformed-invalid-from-number"
+      ],
+      [
+        "bandwidth::4303",
+        "malformed-invalid-to-number"
+      ],
+      [
+        "bandwidth::4350",
+        "malformed-for-destination"
+      ]
+    ]
+  }
+]

package/src/__tests__/fixtures/scan_table_response.json

@@ -0,0 +1,131 @@
+[
+  {
+    "segmentId": "staging_re_rollup_provider_ExecutionTime_2023-05-01T00:00:00.000Z_2023-06-01T00:00:00.000Z_2023-05-01T00:00:24.990Z_343",
+    "columns": [
+      "__time",
+      "AccountId",
+      "BotId",
+      "FlowId",
+      "Type",
+      "count",
+      "sum_AudioDuration15Sec",
+      "sum_AudioDurationMin",
+      "sum_AudioDurationSec",
+      "sum_CharacterCount",
+      "sum_ExecutionDurationMs",
+      "sum_MemoryMb",
+      "sum_Millisecond100Seg",
+      "sum_Millisecond200Seg",
+      "sum_MillisecondTotal"
+    ],
+    "events": [
+      {
+        "__time": 1684144800000,
+        "AccountId": "d40ff964-dd12-4cbd-bb85-6ad35af3f908",
+        "BotId": null,
+        "FlowId": null,
+        "Type": "Read Druid",
+        "count": 20,
+        "sum_AudioDuration15Sec": 0,
+        "sum_AudioDurationMin": 0,
+        "sum_AudioDurationSec": 0,
+        "sum_CharacterCount": 0,
+        "sum_ExecutionDurationMs": 3868,
+        "sum_MemoryMb": 0,
+        "sum_Millisecond100Seg": 48,
+        "sum_Millisecond200Seg": 33,
+        "sum_MillisecondTotal": 3868
+      },
+      {
+        "__time": 1684144800000,
+        "AccountId": "d40ff964-dd12-4cbd-bb85-6ad35af3f908",
+        "BotId": "239df988-3eff-4530-94aa-bda1f6fa4aec",
+        "FlowId": "0e4e7980-fe6f-4326-b037-6faf2aed85e6",
+        "Type": "ProviderLambda",
+        "count": 20,
+        "sum_AudioDuration15Sec": 0,
+        "sum_AudioDurationMin": 0,
+        "sum_AudioDurationSec": 0,
+        "sum_CharacterCount": 0,
+        "sum_ExecutionDurationMs": 10162,
+        "sum_MemoryMb": 20480,
+        "sum_Millisecond100Seg": 112,
+        "sum_Millisecond200Seg": 58,
+        "sum_MillisecondTotal": 10162
+      },
+      {
+        "__time": 1684148400000,
+        "AccountId": "d40ff964-dd12-4cbd-bb85-6ad35af3f908",
+        "BotId": null,
+        "FlowId": null,
+        "Type": "Read Druid",
+        "count": 2,
+        "sum_AudioDuration15Sec": 0,
+        "sum_AudioDurationMin": 0,
+        "sum_AudioDurationSec": 0,
+        "sum_CharacterCount": 0,
+        "sum_ExecutionDurationMs": 2121,
+        "sum_MemoryMb": 0,
+        "sum_Millisecond100Seg": 22,
+        "sum_Millisecond200Seg": 12,
+        "sum_MillisecondTotal": 2121
+      },
+      {
+        "__time": 1684148400000,
+        "AccountId": "d40ff964-dd12-4cbd-bb85-6ad35af3f908",
+        "BotId": "239df988-3eff-4530-94aa-bda1f6fa4aec",
+        "FlowId": "0e4e7980-fe6f-4326-b037-6faf2aed85e6",
+        "Type": "ProviderLambda",
+        "count": 2,
+        "sum_AudioDuration15Sec": 0,
+        "sum_AudioDurationMin": 0,
+        "sum_AudioDurationSec": 0,
+        "sum_CharacterCount": 0,
+        "sum_ExecutionDurationMs": 2626,
+        "sum_MemoryMb": 2048,
+        "sum_Millisecond100Seg": 27,
+        "sum_Millisecond200Seg": 14,
+        "sum_MillisecondTotal": 2626
+      }
+    ]
+  },
+  {
+    "segmentId": "staging_re_rollup_provider_ExecutionTime_2023-05-01T00:00:00.000Z_2023-06-01T00:00:00.000Z_2023-05-01T00:00:24.990Z_344",
+    "columns": [
+      "__time",
+      "AccountId",
+      "BotId",
+      "FlowId",
+      "Type",
+      "count",
+      "sum_AudioDuration15Sec",
+      "sum_AudioDurationMin",
+      "sum_AudioDurationSec",
+      "sum_CharacterCount",
+      "sum_ExecutionDurationMs",
+      "sum_MemoryMb",
+      "sum_Millisecond100Seg",
+      "sum_Millisecond200Seg",
+      "sum_MillisecondTotal"
+    ],
+    "events": [
+      {
+        "__time": 1684148400000,
+        "AccountId": "d40ff964-dd12-4cbd-bb85-6ad35af3f908",
+        "BotId": null,
+        "FlowId": null,
+        "Type": "Read Druid",
+        "count": 23,
+        "sum_AudioDuration15Sec": 0,
+        "sum_AudioDurationMin": 0,
+        "sum_AudioDurationSec": 0,
+        "sum_CharacterCount": 0,
+        "sum_ExecutionDurationMs": 3293,
+        "sum_MemoryMb": 0,
+        "sum_Millisecond100Seg": 44,
+        "sum_Millisecond200Seg": 32,
+        "sum_MillisecondTotal": 3293
+      }
+    ]
+  }
+]

package/src/__tests__/fixtures/search_table_response.json

@@ -0,0 +1,12 @@
+[
+  {
+    "timestamp": "2023-05-01T00:00:00.000Z",
+    "result": [
+      {
+        "dimension": "Type",
+        "value": "Read Druid",
+        "count": 11
+      }
+    ]
+  }
+]

package/src/__tests__/fixtures/time_series_table_response.json

@@ -0,0 +1,32 @@
+[
+  {
+    "timestamp": "2023-05-16T11:00:00.000Z",
+    "result": {
+      "count": 1
+    }
+  },
+  {
+    "timestamp": "2023-05-16T08:00:00.000Z",
+    "result": {
+      "count": 33
+    }
+  },
+  {
+    "timestamp": "2023-05-16T07:00:00.000Z",
+    "result": {
+      "count": 42
+    }
+  },
+  {
+    "timestamp": "2023-05-16T05:00:00.000Z",
+    "result": {
+      "count": 10
+    }
+  },
+  {
+    "timestamp": "2023-05-16T04:00:00.000Z",
+    "result": {
+      "count": 20
+    }
+  }
+]

package/src/__tests__/result-converter.spec.ts

@@ -0,0 +1,304 @@
+import { describe, expect, it } from 'vitest';
+
+import { convertQueryResultsToPreview } from '../result-converter';
+
+import lookupScanResponse from './fixtures/scan_lookup_response.json';
+import tableScanResponse from './fixtures/scan_table_response.json';
+import tableSearchResponse from './fixtures/search_table_response.json';
+import tableGroupByResponse from './fixtures/group_by_table_response.json';
+import tableTimeSeriesResponse from './fixtures/time_series_table_response.json';
+
+describe('Druid.ResultConverter', () => {
+  describe('Lookup', () => {
+    it('should convert response of scanning lookup properly', () => {
+      const preview = convertQueryResultsToPreview(lookupScanResponse, false);
+      expect(preview?.columns).toEqual(['k', 'v']);
+      expect(preview?.data).toHaveLength(5);
+      expect(preview?.data).toEqual(
+        [
+          [
+            'bandwidth::4001',
+            'service-not-allowed',
+          ],
+          [
+            'bandwidth::4301',
+            'malformed-invalid-encoding',
+          ],
+          [
+            'bandwidth::4302',
+            'malformed-invalid-from-number',
+          ],
+          [
+            'bandwidth::4303',
+            'malformed-invalid-to-number',
+          ],
+          [
+            'bandwidth::4350',
+            'malformed-for-destination',
+          ],
+        ]
+      );
+    });
+  });
+
+  describe('Table', () => {
+    it('response for scanning request', () => {
+      const preview = convertQueryResultsToPreview(tableScanResponse, false);
+      expect(preview?.columns).toEqual([
+        '__time',
+        'AccountId',
+        'BotId',
+        'FlowId',
+        'Type',
+        'count',
+        'sum_AudioDuration15Sec',
+        'sum_AudioDurationMin',
+        'sum_AudioDurationSec',
+        'sum_CharacterCount',
+        'sum_ExecutionDurationMs',
+        'sum_MemoryMb',
+        'sum_Millisecond100Seg',
+        'sum_Millisecond200Seg',
+        'sum_MillisecondTotal',
+      ]);
+      expect(preview?.data).toHaveLength(5);
+      expect(preview?.data).toEqual(
+        [
+          [
+            1684144800000,
+            'd40ff964-dd12-4cbd-bb85-6ad35af3f908',
+            null,
+            null,
+            'Read Druid',
+            20,
+            0,
+            0,
+            0,
+            0,
+            3868,
+            0,
+            48,
+            33,
+            3868,
+          ],
+          [
+            1684144800000,
+            'd40ff964-dd12-4cbd-bb85-6ad35af3f908',
+            '239df988-3eff-4530-94aa-bda1f6fa4aec',
+            '0e4e7980-fe6f-4326-b037-6faf2aed85e6',
+            'ProviderLambda',
+            20,
+            0,
+            0,
+            0,
+            0,
+            10162,
+            20480,
+            112,
+            58,
+            10162,
+          ],
+          [
+            1684148400000,
+            'd40ff964-dd12-4cbd-bb85-6ad35af3f908',
+            null,
+            null,
+            'Read Druid',
+            2,
+            0,
+            0,
+            0,
+            0,
+            2121,
+            0,
+            22,
+            12,
+            2121,
+          ],
+          [
+            1684148400000,
+            'd40ff964-dd12-4cbd-bb85-6ad35af3f908',
+            '239df988-3eff-4530-94aa-bda1f6fa4aec',
+            '0e4e7980-fe6f-4326-b037-6faf2aed85e6',
+            'ProviderLambda',
+            2,
+            0,
+            0,
+            0,
+            0,
+            2626,
+            2048,
+            27,
+            14,
+            2626,
+          ],
+          [
+            1684148400000,
+            'd40ff964-dd12-4cbd-bb85-6ad35af3f908',
+            null,
+            null,
+            'Read Druid',
+            23,
+            0,
+            0,
+            0,
+            0,
+            3293,
+            0,
+            44,
+            32,
+            3293,
+          ],
+        ]
+      );
+    });
+
+    it('response for search request', () => {
+      const preview = convertQueryResultsToPreview(tableSearchResponse, false);
+      expect(preview?.columns).toEqual(['dimension', 'value', 'count']);
+      expect(preview?.data).toEqual([
+        ['Type', 'Read Druid', 11],
+      ]);
+    });
+
+    it('response for search request with timestamp', () => {
+      const preview = convertQueryResultsToPreview(tableSearchResponse, true);
+      expect(preview?.columns).toEqual(['timestamp', 'dimension', 'value', 'count']);
+      expect(preview?.data).toEqual([
+        ['2023-05-01T00:00:00.000Z', 'Type', 'Read Druid', 11],
+      ]);
+    });
+
+    it('response for grouping with timestamp by request', () => {
+      const preview = convertQueryResultsToPreview(tableGroupByResponse, true);
+      expect(preview?.columns).toEqual(['timestamp', 'Type', 'total_usage']);
+      expect(preview?.data).toEqual([
+        [
+          '2023-05-15T12:00:00.000Z',
+          'ProviderLambda',
+          21,
+        ],
+        [
+          '2023-05-15T12:00:00.000Z',
+          'Read Druid',
+          21,
+        ],
+        [
+          '2023-05-15T13:00:00.000Z',
+          'ProviderLambda',
+          4,
+        ],
+        [
+          '2023-05-15T13:00:00.000Z',
+          'Read Druid',
+          4,
+        ],
+        [
+          '2023-05-15T14:00:00.000Z',
+          'ProviderLambda',
+          7,
+        ],
+        [
+          '2023-05-15T14:00:00.000Z',
+          'Read Druid',
+          7,
+        ],
+        [
+          '2023-05-16T05:00:00.000Z',
+          'ProviderLambda',
+          5,
+        ],
+        [
+          '2023-05-16T05:00:00.000Z',
+          'Read Druid',
+          5,
+        ],
+        [
+          '2023-05-16T07:00:00.000Z',
+          'ProviderLambda',
+          25,
+        ],
+        [
+          '2023-05-16T07:00:00.000Z',
+          'Read Druid',
+          25,
+        ],
+        [
+          '2023-05-16T08:00:00.000Z',
+          'ProviderLambda',
+          52,
+        ],
+        [
+          '2023-05-16T08:00:00.000Z',
+          'Read Druid',
+          52,
+        ],
+        [
+          '2023-05-16T09:00:00.000Z',
+          'ProviderLambda',
+          21,
+        ],
+        [
+          '2023-05-16T09:00:00.000Z',
+          'Read Druid',
+          20,
+        ],
+        [
+          '2023-05-16T10:00:00.000Z',
+          'ProviderLambda',
+          7,
+        ],
+        [
+          '2023-05-16T10:00:00.000Z',
+          'Read Druid',
+          7,
+        ],
+        [
+          '2023-05-16T11:00:00.000Z',
+          'ProviderLambda',
+          29,
+        ],
+        [
+          '2023-05-16T11:00:00.000Z',
+          'Read Druid',
+          29,
+        ],
+      ]);
+    });
+
+    it('response for grouping with timestamp by request', () => {
+      const preview = convertQueryResultsToPreview(tableTimeSeriesResponse, true);
+      expect(preview?.columns).toEqual(['timestamp', 'count']);
+      expect(preview?.data).toEqual([
+        [
+          '2023-05-16T11:00:00.000Z',
+          1,
+        ],
+        [
+          '2023-05-16T08:00:00.000Z',
+          33,
+        ],
+        [
+          '2023-05-16T07:00:00.000Z',
+          42,
+        ],
+        [
+          '2023-05-16T05:00:00.000Z',
+          10,
+        ],
+        [
+          '2023-05-16T04:00:00.000Z',
+          20,
+        ],
+      ]);
+    });
+  });
+
+  it('should return `null` if response is empty', () => {
+    expect(convertQueryResultsToPreview(null, false)).toBe(null);
+  });
+
+  it('should return `null` if response is object', () => {
+    expect(convertQueryResultsToPreview({ a: 1 }, false)).toBe(null);
+  });
+});

package/src/constants.ts

@@ -0,0 +1,2 @@
+export const SERVICE_KEY = 'druid';
+export const V3_ROUTE_PATH = 'druid/query/v3';

package/src/index.ts

@@ -0,0 +1,2 @@
+export { Druid } from './Druid';
+export * from './types';

package/src/result-converter.ts

@@ -0,0 +1,113 @@
+import isEmpty from 'lodash/isEmpty.js';
+import isArray from 'lodash/isArray.js';
+import isObject from 'lodash/isObject.js';
+import keys from 'lodash/keys.js';
+import values from 'lodash/values.js';
+import map from 'lodash/map.js';
+import flatten from 'lodash/flatten.js';
+
+import type { Druid$NormalizedResponse as RS } from './types';
+
+export function convertQueryResultsToPreview(data: unknown, includeTimestamp: boolean): RS | null {
+  if (isEmpty(data) || !isArray(data)) {
+    return null;
+  }
+  if (data[0].result) {
+    if (isArray(data[0].result)) {
+      return formatQueryResult1(data, includeTimestamp);
+    }
+    return formatQueryResult2(data, includeTimestamp);
+  }
+  if (data[0].event) {
+    return formatQueryResult3(data, includeTimestamp);
+  }
+  return formatQueryResult4(data);
+}
+
+function formatQueryResult1(data: Array<{ result: unknown[]; }>, includeTimestamp: boolean): RS {
+  let columns: string[] = [];
+  for (const chunk of data) {
+    for (const row of chunk.result) {
+      columns = keys(row);
+      if (!isEmpty(columns)) {
+        break;
+      }
+    }
+    if (!isEmpty(columns)) {
+      break;
+    }
+  }
+
+  const rawData = map(data, (row) => {
+    return map(row.result, obj => dataWithTSIfNeeded(values(obj), row, includeTimestamp));
+  });
+
+  return {
+    columns: columnsWithTSIfNeeded(columns, includeTimestamp),
+    data: flatten(rawData),
+  };
+}
+
+function formatQueryResult2(data: Array<{ result: Record<string, unknown>; }>, includeTimestamp: boolean): RS {
+  let columns: string[] = [];
+  for (const row of data) {
+    columns = keys(row.result);
+    if (!isEmpty(columns)) {
+      break;
+    }
+  }
+  return {
+    columns: columnsWithTSIfNeeded(columns, includeTimestamp),
+    data: data.map(row => dataWithTSIfNeeded(values(row.result), row, includeTimestamp)),
+  };
+}
+
+function formatQueryResult3(data: Array<{ event: unknown[]; }>, includeTimestamp: boolean): RS {
+  let columns: string[] = [];
+  for (const row of data) {
+    columns = keys(row.event);
+    if (!isEmpty(columns)) {
+      break;
+    }
+  }
+  // console.warn('FormatQuery3', columns, rows);
+  return {
+    columns: columnsWithTSIfNeeded(columns, includeTimestamp),
+    data: data.map(row => dataWithTSIfNeeded(values(row.event), row, includeTimestamp)),
+  };
+}
+
+type Format4 = Array<{
+  columns: string[];
+  events: Array<Record<string, unknown>> | unknown[][];
+}>;
+function formatQueryResult4(resp: Format4): RS {
+  const columns = resp[0].columns;
+  const data = resp.map(row => row.events).flat().map((o) => {
+    return isArray(o) ? o : columns.map((c) => o[c]);
+  });
+  return {
+    columns,
+    data,
+  };
+}
+
+type TimeStampRow = { timestamp: number; };
+function dataWithTSIfNeeded(data: unknown[], row: unknown, includeTimestamp: boolean): unknown[] {
+  if (includeTimestamp && isObject(row)) {
+    if (isObject(row)) {
+      const tsr = row as TimeStampRow;
+      if (typeof tsr.timestamp === 'number' || typeof tsr.timestamp === 'string') {
+        const ts: unknown[] = [tsr.timestamp];
+        return ts.concat(data);
+      }
+    }
+    const ts: unknown[] = [null];
+    return ts.concat(data);
+  }
+  return data;
+}
+
+function columnsWithTSIfNeeded(columns: string[], includeTimestamp: boolean): string[] {
+  return includeTimestamp ? ['timestamp'].concat(columns) : columns;
+}

package/src/types.ts

@@ -0,0 +1,37 @@
+import type { Token } from '@or-sdk/base';
+
+export type DruidConfig = {
+  /**
+   * token
+   */
+  token: Token;
+  /**
+   * Gateway url
+   */
+  gatewayUrl: string;
+
+  providersAccountId: string;
+};
+
+type Druid$DataType = 'BIGINT' | 'VARCHAR' | 'TIMESTAMP' | 'DOUBLE' | `COMPLEX<${string}>`;
+
+export type Druid$Schema = 'lookup' | 'druid';
+
+export type Druid$RawMetaDescription = {
+  TABLE_SCHEMA: Druid$Schema;
+  TABLE_NAME: string;
+  COLUMN_NAME: string;
+  DATA_TYPE: Druid$DataType;
+  IS_NULLABLE: 'YES' | 'NO';
+};
+
+export type Druid$NormalizedResponse = {
+  columns: string[];
+  data: unknown[][];
+};
+
+export type RunNativeQueryWithTransformation = {
+  includeTimestamp?: boolean;
+};
+
+export type RunNativeQueryOptions = true | RunNativeQueryWithTransformation;

package/tsconfig.dev.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.esm.json",
+  "compilerOptions": {
+    "declarationDir": "./dist/types",
+    "rootDir": "./src",
+    "declaration": true
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/esm",
+    "declarationDir": "./dist/types",
+    "module": "ES6",
+    "target": "es6",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs/",
+    "rootDir": "./src"
+  }
+}