@carto/ps-react-ui 4.4.0-chat-ui.6 → 4.4.0-chat-ui.7

package/src/widgets/stores/widget-store.test.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect, beforeEach } from 'vitest'
 import { useWidgetStore } from './widget-store'
+import type { ToolRegistration } from './types'
 
 describe('WidgetStore', () => {
   beforeEach(() => {
@@ -465,6 +466,82 @@ describe('WidgetStore', () => {
     })
   })
 
+  describe('executeToolPipeline sourceData', () => {
+    const widgetId = 'test-widget-source'
+
+    beforeEach(() => {
+      useWidgetStore.getState().clearWidgets()
+    })
+
+    it('stores sourceData alongside data after pipeline execution', async () => {
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'bar',
+        isLoading: false,
+      })
+
+      const source = [{ value: 1 }, { value: 2 }]
+      await useWidgetStore.getState().executeToolPipeline(widgetId, source)
+
+      const widget = useWidgetStore.getState().getWidget(widgetId)
+      expect(widget?.sourceData).toBe(source)
+      expect(widget?.data).toBe(source) // No tools, passthrough
+    })
+
+    it('preserves sourceData when a tool transforms data to empty', async () => {
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'bar',
+        isLoading: false,
+      })
+
+      const emptyFilterTool: ToolRegistration = {
+        id: 'empty-filter',
+        order: 10,
+        enabled: true,
+        fn: () => [], // Transforms any data to empty array
+      }
+
+      useWidgetStore.getState().registerTool(widgetId, emptyFilterTool)
+
+      const source = [{ value: 1 }, { value: 2 }]
+      await useWidgetStore.getState().executeToolPipeline(widgetId, source)
+
+      const widget = useWidgetStore.getState().getWidget(widgetId)
+      expect(widget?.sourceData).toBe(source)
+      expect(widget?.data).toEqual([])
+    })
+
+    it('updates sourceData when input changes but pipeline output stays the same', async () => {
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'bar',
+        isLoading: false,
+      })
+
+      const constantTool: ToolRegistration = {
+        id: 'constant',
+        order: 10,
+        enabled: true,
+        fn: () => 'constant-output',
+      }
+
+      useWidgetStore.getState().registerTool(widgetId, constantTool)
+
+      const source1 = [{ value: 1 }]
+      await useWidgetStore.getState().executeToolPipeline(widgetId, source1)
+
+      expect(useWidgetStore.getState().getWidget(widgetId)?.sourceData).toBe(
+        source1,
+      )
+
+      const source2 = [{ value: 2 }]
+      await useWidgetStore.getState().executeToolPipeline(widgetId, source2)
+
+      // sourceData should reflect the new input
+      expect(useWidgetStore.getState().getWidget(widgetId)?.sourceData).toBe(
+        source2,
+      )
+    })
+  })
+
   describe('Config Tool Pipeline', () => {
     const widgetId = 'test-widget-config'
 
@@ -478,7 +555,7 @@ describe('WidgetStore', () => {
         isLoading: false,
       })
 
-      const configTool: import('./types').ToolRegistration = {
+      const configTool: ToolRegistration = {
         id: 'stack-tool',
         type: 'config',
         order: 10,
@@ -536,7 +613,7 @@ describe('WidgetStore', () => {
         isLoading: false,
       })
 
-      const dataTool: import('./types').ToolRegistration = {
+      const dataTool: ToolRegistration = {
         id: 'data-tool',
         type: 'data',
         order: 10,
@@ -547,7 +624,7 @@ describe('WidgetStore', () => {
         },
       }
 
-      const configTool: import('./types').ToolRegistration = {
+      const configTool: ToolRegistration = {
         id: 'config-tool',
         type: 'config',
         order: 10,
@@ -575,7 +652,7 @@ describe('WidgetStore', () => {
         isLoading: false,
       })
 
-      const configTool: import('./types').ToolRegistration = {
+      const configTool: ToolRegistration = {
         id: 'config-tool',
         type: 'config',
         order: 10,
@@ -586,7 +663,7 @@ describe('WidgetStore', () => {
         },
       }
 
-      const disablerTool: import('./types').ToolRegistration = {
+      const disablerTool: ToolRegistration = {
         id: 'disabler',
         type: 'data',
         order: 10,
@@ -604,6 +681,129 @@ describe('WidgetStore', () => {
 
       expect(executionOrder).not.toContain('config-tool')
     })
+
+    it('should not overwrite user-modified state when config lacks that property', async () => {
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'table',
+        isLoading: false,
+      })
+
+      // Apply initial config (without selected — clean config pattern)
+      await useWidgetStore.getState().executeConfigPipeline(widgetId, {
+        columns: [],
+        selectable: true,
+        mode: 'local',
+      })
+
+      // Simulate user selecting rows via UI action
+      useWidgetStore.getState().setWidget(widgetId, {
+        selected: [1, 2, 3],
+      })
+
+      // Re-run config pipeline (e.g., triggered by tool registration or data change)
+      await useWidgetStore.getState().executeConfigPipeline(widgetId, {
+        columns: [],
+        selectable: true,
+        mode: 'local',
+      })
+
+      // Selection should be preserved — config doesn't include 'selected'
+      const widget = useWidgetStore.getState().getWidget(widgetId)
+      expect((widget as { selected?: (string | number)[] }).selected).toEqual([
+        1, 2, 3,
+      ])
+    })
+
+    it('should not overwrite user-modified state when a tool passes base config through unchanged', async () => {
+      const baseConfig = {
+        option: { series: [{ name: 'A' }] },
+        selected: [] as number[],
+      }
+
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'bar',
+        isLoading: false,
+      })
+
+      // Register a config tool that only changes `option` but spreads
+      // the entire base config (the typical { ...config, option: modified } pattern)
+      useWidgetStore.getState().registerTool(widgetId, {
+        id: 'stack-tool',
+        type: 'config',
+        order: 10,
+        enabled: true,
+        fn: (config: unknown) => {
+          const c = config as typeof baseConfig
+          return { ...c, option: { series: [{ name: 'A', stack: 'group' }] } }
+        },
+      })
+
+      // Initial pipeline sets option and selected
+      await useWidgetStore
+        .getState()
+        .executeConfigPipeline(widgetId, baseConfig)
+
+      // Simulate user modifying selected via UI
+      useWidgetStore.getState().setWidget(widgetId, { selected: [1, 2] })
+
+      // Re-run pipeline — tool still only changes `option`,
+      // but spreads { ...config, option: modified } which includes selected: []
+      await useWidgetStore
+        .getState()
+        .executeConfigPipeline(widgetId, baseConfig)
+
+      const widget = useWidgetStore.getState().getWidget(widgetId) as {
+        selected?: number[]
+        option?: { series?: { stack?: string }[] }
+      }
+
+      // Tool's change should be applied
+      expect(widget.option?.series?.[0]?.stack).toBe('group')
+      // User's selection should be preserved — the tool didn't change `selected`
+      expect(widget.selected).toEqual([1, 2])
+    })
+  })
+
+  describe('triggerToolPipeline', () => {
+    const widgetId = 'test-widget-trigger'
+
+    beforeEach(() => {
+      useWidgetStore.getState().clearWidgets()
+    })
+
+    it('creates new registeredTools reference', () => {
+      useWidgetStore.getState().setWidget(widgetId, {
+        type: 'bar',
+        isLoading: false,
+      })
+
+      useWidgetStore.getState().registerTool(widgetId, {
+        id: 'my-tool',
+        order: 10,
+        enabled: true,
+        fn: (data) => data,
+      })
+
+      const toolsBefore =
+        useWidgetStore.getState().widgets[widgetId]?.registeredTools
+
+      useWidgetStore.getState().triggerToolPipeline(widgetId)
+
+      const toolsAfter =
+        useWidgetStore.getState().widgets[widgetId]?.registeredTools
+
+      // New reference — triggers Effect 4 in WidgetLoader
+      expect(toolsBefore).not.toBe(toolsAfter)
+
+      // But same content
+      expect(toolsAfter?.length).toBe(toolsBefore?.length)
+      expect(toolsAfter?.[0]?.id).toBe(toolsBefore?.[0]?.id)
+    })
+
+    it('does nothing for non-existent widget', () => {
+      useWidgetStore.getState().triggerToolPipeline('non-existent')
+      // No error thrown
+    })
   })
 
   describe('Tool Dependency Management', () => {
@@ -617,7 +817,7 @@ describe('WidgetStore', () => {
       it('skips tools disabled by other enabled tools', async () => {
         const executionOrder: string[] = []
 
-        const toolA: import('./types').ToolRegistration = {
+        const toolA: ToolRegistration = {
           id: 'tool-a',
           order: 10,
           enabled: true,
@@ -627,7 +827,7 @@ describe('WidgetStore', () => {
           },
         }
 
-        const toolB: import('./types').ToolRegistration = {
+        const toolB: ToolRegistration = {
           id: 'tool-b',
           order: 20,
           enabled: true,
@@ -637,7 +837,7 @@ describe('WidgetStore', () => {
           },
         }
 
-        const toolC: import('./types').ToolRegistration = {
+        const toolC: ToolRegistration = {
           id: 'tool-c',
           order: 30,
           enabled: true,
@@ -662,7 +862,7 @@ describe('WidgetStore', () => {
       it('includes tool when disabling tool is not enabled', async () => {
         const executionOrder: string[] = []
 
-        const toolA: import('./types').ToolRegistration = {
+        const toolA: ToolRegistration = {
           id: 'tool-a',
           order: 10,
           enabled: true,
@@ -672,7 +872,7 @@ describe('WidgetStore', () => {
           },
         }
 
-        const toolB: import('./types').ToolRegistration = {
+        const toolB: ToolRegistration = {
           id: 'tool-b',
           order: 20,
           enabled: false, // Disabled
@@ -695,7 +895,7 @@ describe('WidgetStore', () => {
       it('handles multiple tools disabling the same target', async () => {
         const executionOrder: string[] = []
 
-        const toolA: import('./types').ToolRegistration = {
+        const toolA: ToolRegistration = {
           id: 'tool-a',
           order: 10,
           enabled: true,
@@ -705,7 +905,7 @@ describe('WidgetStore', () => {
           },
         }
 
-        const toolB: import('./types').ToolRegistration = {
+        const toolB: ToolRegistration = {
           id: 'tool-b',
           order: 20,
           enabled: true,
@@ -716,7 +916,7 @@ describe('WidgetStore', () => {
           disables: ['tool-a'],
         }
 
-        const toolC: import('./types').ToolRegistration = {
+        const toolC: ToolRegistration = {
           id: 'tool-c',
           order: 30,
           enabled: true,