@oanda/labs-crowd-view-widget 1.0.51 → 1.0.53

package/test/components/Chart/utils/processSentiments.test.ts

@@ -0,0 +1,238 @@
+import { processSentiments } from '../../../../src/CrowdViewWidget/components/Chart/utils/processSentiments';
+import type { GetSentimentsQuery } from '../../../../src/gql/types/graphql';
+
+describe('processSentiments', () => {
+  it('returns empty arrays when sentimentsData is undefined', () => {
+    const result = processSentiments(undefined, ['2025-03-15T10:30:00Z']);
+    expect(result).toEqual({
+      sentimentLongs: [],
+      sentimentShorts: [],
+      hasValidSentiments: false,
+    });
+  });
+
+  it('returns empty arrays when sentiments array is empty', () => {
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [],
+      },
+    };
+    const result = processSentiments(sentimentsData, ['2025-03-15T10:30:00Z']);
+    expect(result).toEqual({
+      sentimentLongs: [],
+      sentimentShorts: [],
+      hasValidSentiments: false,
+    });
+  });
+
+  it('returns empty arrays when sentiments is null', () => {
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: null as never,
+      },
+    };
+    const result = processSentiments(sentimentsData, ['2025-03-15T10:30:00Z']);
+    expect(result).toEqual({
+      sentimentLongs: [],
+      sentimentShorts: [],
+      hasValidSentiments: false,
+    });
+  });
+
+  it('processes sentiments and matches with dates', () => {
+    const dates = [
+      '2025-03-15T10:30:00Z',
+      '2025-03-15T11:30:00Z',
+      '2025-03-15T12:30:00Z',
+    ];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+          {
+            time: '2025-03-15T11:30:00Z',
+            sentiment: {
+              shortPercent: 40.2,
+              longPercent: 59.8,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.hasValidSentiments).toBe(true);
+    expect(result.sentimentShorts).toEqual([30.5, 40.2, null]);
+    expect(result.sentimentLongs).toEqual([69.5, 59.8, null]);
+  });
+
+  it('returns null for dates that do not match any sentiment', () => {
+    const dates = ['2025-03-15T10:30:00Z', '2025-03-15T11:30:00Z'];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+          {
+            time: '2025-03-15T12:30:00Z', // Not in dates
+            sentiment: {
+              shortPercent: 50.0,
+              longPercent: 50.0,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.sentimentShorts).toEqual([30.5, null]);
+    expect(result.sentimentLongs).toEqual([69.5, null]);
+  });
+
+  it('returns null arrays when no sentiments match dates', () => {
+    const dates = ['2025-03-15T10:30:00Z'];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T11:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.sentimentShorts).toEqual([null]);
+    expect(result.sentimentLongs).toEqual([null]);
+  });
+
+  it('handles multiple dates with mixed matching sentiments', () => {
+    const dates = [
+      '2025-03-15T10:30:00Z',
+      '2025-03-15T11:30:00Z',
+      '2025-03-15T12:30:00Z',
+      '2025-03-15T13:30:00Z',
+    ];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+          {
+            time: '2025-03-15T12:30:00Z',
+            sentiment: {
+              shortPercent: 25.0,
+              longPercent: 75.0,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.sentimentShorts).toEqual([30.5, null, 25.0, null]);
+    expect(result.sentimentLongs).toEqual([69.5, null, 75.0, null]);
+  });
+
+  it('should handle null sentiment objects gracefully', () => {
+    const dates = ['2025-03-15T10:30:00Z'];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: null as never,
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.sentimentShorts).toEqual([null]);
+    expect(result.sentimentLongs).toEqual([null]);
+  });
+
+  it('should handle undefined sentiment properties', () => {
+    const dates = ['2025-03-15T10:30:00Z'];
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: undefined as never,
+              longPercent: undefined as never,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, dates);
+    expect(result.sentimentShorts).toEqual([null]);
+    expect(result.sentimentLongs).toEqual([null]);
+  });
+
+  it('should return empty arrays when dates array is empty', () => {
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+        ],
+      },
+    };
+
+    const result = processSentiments(sentimentsData, []);
+    expect(result).toEqual({
+      sentimentLongs: [],
+      sentimentShorts: [],
+      hasValidSentiments: false,
+    });
+  });
+
+  it('should return empty arrays when dates is not an array', () => {
+    const sentimentsData: GetSentimentsQuery = {
+      sentiments: {
+        sentiments: [
+          {
+            time: '2025-03-15T10:30:00Z',
+            sentiment: {
+              shortPercent: 30.5,
+              longPercent: 69.5,
+            },
+          },
+        ],
+      },
+    };
+
+    // @ts-expect-error - Testing invalid input
+    const result = processSentiments(sentimentsData, null);
+    expect(result.hasValidSentiments).toBe(false);
+  });
+});

package/test/utils/processOrderPositionBooks.test.ts

@@ -3,125 +3,242 @@ import type { GetOrderPositionBooksQuery } from '../../src/gql/types/graphql';
 
 describe('processOrderPositionBooks', () => {
   const createMockOrderPositionBook = (time: string) => ({
-    bucketWidth: 0.0005,
-    price: 1.0,
     time,
-    buckets: [{ price: 1.0, sentiment: 0.2 }],
+    price: 1.0,
+    buckets: [
+      { price: 1.0, sentiment: 0.2 },
+      { price: 1.0005, sentiment: -0.3 },
+    ],
   });
 
-  it('should return empty array when orderPositionData is undefined', () => {
-    const candleMap = new Map();
-    expect(processOrderPositionBooks(undefined, candleMap)).toEqual([]);
+  it('should return empty arrays when orderPositionData is undefined', () => {
+    const result = processOrderPositionBooks(undefined, []);
+    expect(result).toEqual({
+      bookPrices: [],
+      bookIndexes: [],
+      buckets: [],
+      bucketWidth: 0,
+      sentimentThresholdMin: 0,
+      sentimentThresholdMax: 0,
+      hasValidBooks: false,
+    });
   });
 
-  it('should return empty array when orderPositionBooks is empty', () => {
+  it('should return empty arrays when orderPositionBooks is undefined', () => {
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [],
+      orderPositionBooks: {} as any,
     };
-    const candleMap = new Map();
-    expect(processOrderPositionBooks(mockData, candleMap)).toEqual([]);
+    const result = processOrderPositionBooks(mockData, []);
+    expect(result).toEqual({
+      bookPrices: [],
+      bookIndexes: [],
+      buckets: [],
+      bucketWidth: 0,
+      sentimentThresholdMin: 0,
+      sentimentThresholdMax: 0,
+      hasValidBooks: false,
+    });
   });
 
-  it('should filter out null books', () => {
+  it('should return empty arrays when books array is empty', () => {
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [null, createMockOrderPositionBook('2025-01-01')],
+      orderPositionBooks: {
+        books: [],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map();
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(1);
-    expect(result[0]).toEqual(['2025-01-01', null, 0]);
+    const result = processOrderPositionBooks(mockData, []);
+    expect(result).toEqual({
+      bookPrices: [],
+      bookIndexes: [],
+      buckets: [],
+      bucketWidth: 0,
+      sentimentThresholdMin: 0,
+      sentimentThresholdMax: 0,
+      hasValidBooks: false,
+    });
   });
 
-  it('should filter out books with no buckets', () => {
+  it('should return empty arrays when sentimentThresholdMin is missing', () => {
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [
-        {
-          bucketWidth: 0.0005,
-          price: 1.0,
-          time: '2025-01-01',
-          buckets: [],
-        },
-        createMockOrderPositionBook('2025-01-02'),
-      ],
+      orderPositionBooks: {
+        books: [createMockOrderPositionBook('2025-01-01T00:00:00Z')],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: null as any,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map();
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(1);
-    expect(result[0]).toEqual(['2025-01-02', null, 0]);
+    const result = processOrderPositionBooks(mockData, [
+      '2025-01-01T00:00:00Z',
+    ]);
+    expect(result.hasValidBooks).toBe(false);
   });
 
-  it('should use candle high price when available in map', () => {
+  it('should process valid order position books and match with dates', () => {
+    const dates = [
+      '2025-01-01T00:00:00Z',
+      '2025-01-01T01:00:00Z',
+      '2025-01-01T02:00:00Z',
+    ];
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [
-        createMockOrderPositionBook('2025-01-01'),
-        createMockOrderPositionBook('2025-01-02'),
-      ],
+      orderPositionBooks: {
+        books: [
+          createMockOrderPositionBook('2025-01-01T00:00:00Z'),
+          createMockOrderPositionBook('2025-01-01T01:00:00Z'),
+        ],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map([
-      ['2025-01-01', { high: 1.1234 }],
-      ['2025-01-02', { high: 1.5678 }],
-    ]);
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(2);
-    expect(result[0]).toEqual(['2025-01-01', 1.1234, 0]);
-    expect(result[1]).toEqual(['2025-01-02', 1.5678, 1]);
+    const result = processOrderPositionBooks(mockData, dates);
+    expect(result.hasValidBooks).toBe(true);
+    expect(result.bucketWidth).toBe(0.0005);
+    expect(result.sentimentThresholdMin).toBe(0.15);
+    expect(result.sentimentThresholdMax).toBe(0.55);
+    expect(result.bookPrices).toHaveLength(3);
+    expect(result.bookIndexes).toHaveLength(3);
+    expect(result.buckets).toHaveLength(3);
+    expect(result.bookPrices[0]).toBe(1.0);
+    expect(result.bookPrices[1]).toBe(1.0);
+    expect(result.bookPrices[2]).toBeNull();
+    expect(result.bookIndexes).toEqual([0, 1, 2]);
+    expect(result.buckets[0]).toHaveLength(2);
+    expect(result.buckets[1]).toHaveLength(2);
+    expect(result.buckets[2]).toEqual([]);
   });
 
-  it('should use null when candle is not in map', () => {
+  it('should handle dates that do not match any book', () => {
+    const dates = [
+      '2025-01-01T00:00:00Z',
+      '2025-01-01T01:00:00Z',
+      '2025-01-01T02:00:00Z',
+    ];
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [createMockOrderPositionBook('2025-01-01')],
+      orderPositionBooks: {
+        books: [createMockOrderPositionBook('2025-01-01T00:00:00Z')],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map();
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(1);
-    expect(result[0]).toEqual(['2025-01-01', null, 0]);
+    const result = processOrderPositionBooks(mockData, dates);
+    expect(result.bookPrices).toEqual([1.0, null, null]);
+    expect(result.buckets[0]).toHaveLength(2);
+    expect(result.buckets[1]).toEqual([]);
+    expect(result.buckets[2]).toEqual([]);
   });
 
-  it('should use null when candle high is undefined', () => {
+  it('should handle books with null price', () => {
+    const dates = ['2025-01-01T00:00:00Z'];
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [createMockOrderPositionBook('2025-01-01')],
+      orderPositionBooks: {
+        books: [
+          {
+            time: '2025-01-01T00:00:00Z',
+            price: null,
+            buckets: [{ price: 1.0, sentiment: 0.2 }],
+          },
+        ],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map([
-      ['2025-01-01', { low: 1.0 }], // no high property
+    const result = processOrderPositionBooks(mockData, dates);
+    expect(result.bookPrices[0]).toBeNull();
+    expect(result.buckets[0]).toHaveLength(1);
+  });
+
+  it('should correctly map buckets structure', () => {
+    const dates = ['2025-01-01T00:00:00Z'];
+    const mockData: GetOrderPositionBooksQuery = {
+      orderPositionBooks: {
+        books: [
+          {
+            time: '2025-01-01T00:00:00Z',
+            price: 1.0,
+            buckets: [
+              { price: 1.0, sentiment: 0.2 },
+              { price: 1.0005, sentiment: -0.3 },
+              { price: 1.001, sentiment: 0.5 },
+            ],
+          },
+        ],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
+    };
+    const result = processOrderPositionBooks(mockData, dates);
+    expect(result.buckets[0]).toEqual([
+      { price: 1.0, sentiment: 0.2 },
+      { price: 1.0005, sentiment: -0.3 },
+      { price: 1.001, sentiment: 0.5 },
     ]);
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(1);
-    expect(result[0]).toEqual(['2025-01-01', null, 0]);
   });
 
-  it('should correctly assign index to each book', () => {
+  it('should handle duplicate time values in books array (last one wins)', () => {
+    const dates = ['2025-01-01T00:00:00Z'];
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [
-        createMockOrderPositionBook('2025-01-01'),
-        createMockOrderPositionBook('2025-01-02'),
-        createMockOrderPositionBook('2025-01-03'),
-      ],
+      orderPositionBooks: {
+        books: [
+          {
+            time: '2025-01-01T00:00:00Z',
+            price: 1.0,
+            buckets: [{ price: 1.0, sentiment: 0.2 }],
+          },
+          {
+            time: '2025-01-01T00:00:00Z',
+            price: 1.5,
+            buckets: [{ price: 1.5, sentiment: 0.8 }],
+          },
+        ],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map();
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(3);
-    expect(result[0][2]).toBe(0);
-    expect(result[1][2]).toBe(1);
-    expect(result[2][2]).toBe(2);
+    const result = processOrderPositionBooks(mockData, dates);
+    // Last entry should win
+    expect(result.bookPrices[0]).toBe(1.5);
+    expect(result.buckets[0]).toEqual([{ price: 1.5, sentiment: 0.8 }]);
   });
 
-  it('should handle mixed cases with and without candles', () => {
+  it('should return empty arrays when dates array is empty', () => {
     const mockData: GetOrderPositionBooksQuery = {
-      orderPositionBooks: [
-        createMockOrderPositionBook('2025-01-01'),
-        createMockOrderPositionBook('2025-01-02'),
-        createMockOrderPositionBook('2025-01-03'),
-      ],
+      orderPositionBooks: {
+        books: [createMockOrderPositionBook('2025-01-01T00:00:00Z')],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
     };
-    const candleMap = new Map([
-      ['2025-01-01', { high: 1.1111 }],
-      // 2025-01-02 missing from map
-      ['2025-01-03', { high: 1.3333 }],
-    ]);
-    const result = processOrderPositionBooks(mockData, candleMap);
-    expect(result).toHaveLength(3);
-    expect(result[0]).toEqual(['2025-01-01', 1.1111, 0]);
-    expect(result[1]).toEqual(['2025-01-02', null, 1]);
-    expect(result[2]).toEqual(['2025-01-03', 1.3333, 2]);
+    const result = processOrderPositionBooks(mockData, []);
+    expect(result).toEqual({
+      bookPrices: [],
+      bookIndexes: [],
+      buckets: [],
+      bucketWidth: 0,
+      sentimentThresholdMin: 0,
+      sentimentThresholdMax: 0,
+      hasValidBooks: false,
+    });
+  });
+
+  it('should return empty arrays when dates is not an array', () => {
+    const mockData: GetOrderPositionBooksQuery = {
+      orderPositionBooks: {
+        books: [createMockOrderPositionBook('2025-01-01T00:00:00Z')],
+        bucketWidth: 0.0005,
+        sentimentThresholdMin: 0.15,
+        sentimentThresholdMax: 0.55,
+      },
+    };
+    // @ts-expect-error - Testing invalid input
+    const result = processOrderPositionBooks(mockData, null);
+    expect(result.hasValidBooks).toBe(false);
   });
 });