Further fix parsing of sampling to match tsp specification

The server was modified to comply to tsp specification for
sampling, update accordingly here. There are now 3 different arrays
for x values: xValues (legacy xy for timestamps), xCategories (array of
string) and xRanges (array of StartEndRanges).

Note that StartEndRange is now an object with start and end attributes.
Before it was an array with 2 values.

Contributes to fix:
eclipse-tracecompass-incubator/org.eclipse.tracecompass.incubator#236

Signed-off-by: Bernd Hufmann <[email protected]>

Author: bhufmann

tsp-typescript-client/fixtures/tsp-client/fetch-generic-xy-0.json

@@ -5,7 +5,7 @@
       {
         "seriesId": 3,
         "seriesName": "15652",
-        "xValues": [
+        "xRanges": [
           {
             "start": 0,
             "end": 604229397
@@ -60,7 +60,7 @@
       {
         "seriesId": 4,
         "seriesName": "15653",
-        "xValues": [
+        "xRanges": [
           {
             "start": 0,
             "end": 604229397
@@ -115,7 +115,7 @@
       {
         "seriesId": 2,
         "seriesName": "15646",
-        "xValues": [
+        "xRanges": [
           {
             "start": 0,
             "end": 604229397
@@ -170,7 +170,7 @@
       {
         "seriesId": 1,
         "seriesName": "15647",
-        "xValues": [
+        "xRanges": [
           {
             "start": 0,
             "end": 604229397

tsp-typescript-client/fixtures/tsp-client/fetch-generic-xy-1.json

@@ -5,7 +5,7 @@
       {
         "seriesId": 3,
         "seriesName": "15652",
-        "xValues": [
+        "xCategories": [
           "red",
           "blue",
           "green",

tsp-typescript-client/src/models/xy.ts

@@ -1,8 +1,8 @@
-import { array, assertNumber, createNormalizer } from '../protocol/serialization';
+import { array, assertNumber, createNormalizer, toBigInt } from '../protocol/serialization';
 import { AxisDomain } from './axis-domain';
 import { DataType } from './data-type';
 import { Entry } from './entry';
-import { Sampling } from './sampling';
+import { StartEndRange } from './sampling';
 import { OutputElementStyle } from "./styles";
 
 export const XYAxisDescription = createNormalizer<XYAxisDescription>({
@@ -11,7 +11,8 @@ export const XYAxisDescription = createNormalizer<XYAxisDescription>({
 
 export const XYSeries = createNormalizer<XYSeries>({
     seriesId: assertNumber,
-    xValues: Sampling,
+    xValues: array(toBigInt),
+    xRanges: array(StartEndRange),
     yValues: array(assertNumber),
     tags: array(assertNumber),
     style: OutputElementStyle,
@@ -53,8 +54,11 @@ export interface XYSeries {
     /**
      * Series' X values
      */
-    xValues: Sampling;
+    xValues?: bigint[];
 
+    xRanges?: StartEndRange[];
+
+    xCategories?: string[];
     /**
      * Series' Y values
      */

tsp-typescript-client/src/protocol/tsp-client.test.ts

@@ -7,7 +7,6 @@ import { DataType } from '../models/data-type';
 import { ConfigurationParameterDescriptor } from '../models/configuration-source';
 import { QueryHelper } from '../models/query/query-helper';
 import { isAxisDomainCategorical, isAxisDomainRange } from '../models/axis-domain';
-import { StartEndRange } from '../models/sampling';
 
 describe('HttpTspClient Deserialization', () => {
 
@@ -349,11 +348,17 @@ describe('HttpTspClient Deserialization', () => {
     expect(xy.series).toHaveLength(1);
     for (const serie of xy.series) {
       expect(typeof serie.seriesId).toEqual('number');
+      expect(serie.xValues).toBeDefined();
+      expect(serie.xRanges).toBeUndefined();
+      expect(serie.xCategories).toBeUndefined();
       expect(serie.xValues).toHaveLength(3);
       expect(serie.yValues).toHaveLength(3);
-      for (const xValue of serie.xValues) {
-        expect(typeof xValue).toEqual('bigint');
-      }
+      if (serie.xValues) {
+        for (const xValue of serie.xValues) {
+          expect(typeof xValue).toEqual('bigint');
+        }
+    }
+      
       for (const yValue of serie.yValues) {
         expect(typeof yValue).toEqual('number');
       }
@@ -370,21 +375,18 @@ describe('HttpTspClient Deserialization', () => {
     expect(xy.series).toHaveLength(4);
     for (const serie of xy.series) {
       expect(typeof serie.seriesId).toEqual('number');
-      expect(serie.xValues).toHaveLength(5);
+      expect(serie.xValues).toBeUndefined();
+      expect(serie.xRanges).toBeDefined();
+      expect(serie.xCategories).toBeUndefined();
+      expect(serie.xRanges).toHaveLength(5);
       expect(serie.yValues).toHaveLength(5);
-      for (const xValue of serie.xValues) {
-        if (
-          typeof xValue === 'object' &&
-          xValue !== null &&
-          !Array.isArray(xValue)
-        ) {
-          const rangeObject = xValue as StartEndRange;
-          expect(typeof rangeObject.start).toBe('bigint');
-          expect(typeof rangeObject.end).toBe('bigint');
-        } else {
-          throw new Error('xValue is not a valid StartEndRange object ({start, end})');
+
+      if (serie.xRanges) {
+        for (const xValue of serie.xRanges) {
+          expect(typeof xValue.start).toBe('bigint');
+          expect(typeof xValue.end).toBe('bigint');
         }
-      }
+    }
 
       for (const yValue of serie.yValues) {
         expect(typeof yValue).toEqual('number');
@@ -419,10 +421,16 @@ describe('HttpTspClient Deserialization', () => {
     expect(xy_categorized.series).toHaveLength(1);
     for (const serie of xy_categorized.series) {
       expect(typeof serie.seriesId).toEqual('number');
-      expect(serie.xValues).toHaveLength(5);
+      expect(serie.xValues).toBeUndefined();
+      expect(serie.xRanges).toBeUndefined();
+      expect(serie.xCategories).toBeDefined();
+
+      expect(serie.xCategories).toHaveLength(5);
       expect(serie.yValues).toHaveLength(5);
-      for (const xValue of serie.xValues) {
-        expect(typeof xValue).toEqual('string');
+      if (serie.xCategories) {
+        for (const xValue of serie.xCategories) {
+          expect(typeof xValue).toEqual('string');
+        }
       }
 
       for (const yValue of serie.yValues) {