fix: DH-19693: Add null/empty formatting to constituent strings (deephaven#2495)

Cherry-pick deephaven#2464 and deephaven#2480 to `v0.85`

Part of [DH-19693](https://deephaven.atlassian.net/browse/DH-19693).
Anything that renders as "empty" for empty strings, and "null" for null
strings, should still render the same when rolledup. This adds the
missing null and empty string formatting logic for tree table
constituent values.

Changes:
Checks if the result should show "null" or "empty" based on formatter

test: DH-19614: e2e tests for constituent formatting
Follow-up to deephaven#2461. This
PR adds e2e tests for constituent formatting.

[DH-19693]:
https://deephaven.atlassian.net/browse/DH-19693?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: gzh2003

.github/workflows/e2e.yml

@@ -14,7 +14,7 @@ on:
       - 'release/**'
       - 'feature/**'
 env:
-  DHC_VERSION: 0.36.1
+  DHC_VERSION: 0.39.5
 
 jobs:
   build:

packages/iris-grid/src/IrisGridTreeTableModel.test.ts

@@ -1,5 +1,6 @@
 import dh from '@deephaven/jsapi-shim';
 import IrisGridTestUtils from './IrisGridTestUtils';
+import IrisGridTableModelTemplate from './IrisGridTableModelTemplate';
 import IrisGridTreeTableModel, {
   type UITreeRow,
 } from './IrisGridTreeTableModel';
@@ -416,3 +417,143 @@ describe('IrisGridTreeTableModel textAlignForCell', () => {
     expect(result).toBe('left');
   });
 });
+
+describe('IrisGridTreeTableModel textForCell', () => {
+  let model: IrisGridTreeTableModel;
+
+  const columns = {
+    string: irisGridTestUtils.makeColumn('StrCol', 'java.lang.String', 0),
+    stringColWithStringConstituent: {
+      ...irisGridTestUtils.makeColumn('StrCol', 'java.lang.String', 0),
+      constituentType: 'java.lang.String',
+    },
+    stringColWithIntConstituent: {
+      ...irisGridTestUtils.makeColumn('IntCol', 'int', 0),
+      constituentType: 'int',
+    } as DhType.Column,
+  };
+
+  const rows = {
+    leaf: {
+      data: new Map(),
+      hasChildren: false,
+      isExpanded: false,
+      depth: 2,
+    } as UITreeRow,
+    parent: {
+      data: new Map(),
+      hasChildren: true,
+      isExpanded: false,
+      depth: 1,
+    } as UITreeRow,
+  };
+
+  beforeEach(() => {
+    const testColumns = irisGridTestUtils.makeColumns();
+    const table = irisGridTestUtils.makeTreeTable(
+      testColumns,
+      testColumns.slice(0, 1),
+      100,
+      []
+    );
+    model = new IrisGridTreeTableModel(dh, table);
+  });
+
+  const mockTextCell = (
+    value: unknown,
+    column: DhType.Column,
+    row: UITreeRow,
+    displayText?: string
+  ) => {
+    jest.spyOn(model, 'sourceColumn').mockReturnValue(column);
+    jest.spyOn(model, 'row').mockReturnValue(row);
+    jest.spyOn(model, 'valueForCell').mockReturnValue(value);
+    if (displayText !== undefined) {
+      jest.spyOn(model, 'displayString').mockReturnValue(displayText);
+    }
+  };
+
+  describe('leaf nodes with non-string constituent type', () => {
+    it('handles null values', () => {
+      jest
+        .spyOn(model, 'columns', 'get')
+        .mockReturnValue([columns.stringColWithIntConstituent]);
+      mockTextCell(null, columns.stringColWithIntConstituent, rows.leaf, '');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('');
+    });
+
+    it('handles normal values', () => {
+      jest
+        .spyOn(model, 'columns', 'get')
+        .mockReturnValue([columns.stringColWithIntConstituent]);
+      mockTextCell(21, columns.stringColWithIntConstituent, rows.leaf, '21');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('21');
+    });
+  });
+
+  describe('leaf nodes with formatter settings', () => {
+    beforeEach(() => {
+      jest.spyOn(model, 'columns', 'get').mockReturnValue([columns.string]);
+    });
+
+    it('shows "null" when showNullStrings is true', () => {
+      model.formatter.showNullStrings = true;
+      mockTextCell(null, columns.stringColWithIntConstituent, rows.leaf, '');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('null');
+    });
+
+    it('shows empty string when showNullStrings is false', () => {
+      model.formatter.showNullStrings = false;
+      mockTextCell(null, columns.stringColWithIntConstituent, rows.leaf, '');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('');
+    });
+
+    it('shows "empty" when showEmptyStrings is true', () => {
+      model.formatter.showEmptyStrings = true;
+      mockTextCell('', columns.stringColWithIntConstituent, rows.leaf, '');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('empty');
+    });
+
+    it('shows empty string when showEmptyStrings is false', () => {
+      model.formatter.showEmptyStrings = false;
+      mockTextCell('', columns.stringColWithIntConstituent, rows.leaf, '');
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('');
+    });
+  });
+
+  describe('grouping column', () => {
+    it('shows empty string for null values in rollup grouping columns', () => {
+      Object.defineProperty(model.table, 'groupedColumns', {
+        value: [],
+      });
+      jest
+        .spyOn(model, 'getCachedGroupedColumnSet')
+        .mockReturnValue(new Set([0]));
+      mockTextCell(null, columns.string, { ...rows.parent, depth: 1 });
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('');
+    });
+  });
+
+  describe('non-leaf nodes', () => {
+    it('delegates to superClass for parent nodes', () => {
+      jest
+        .spyOn(IrisGridTableModelTemplate.prototype, 'textForCell')
+        .mockReturnValue('parentString');
+      mockTextCell(
+        'parentString',
+        columns.stringColWithIntConstituent,
+        rows.parent,
+        'parentString'
+      );
+      const result = model.textForCell(0, 0);
+      expect(result).toBe('parentString');
+    });
+  });
+});

packages/iris-grid/src/IrisGridTreeTableModel.ts

@@ -130,8 +130,25 @@ class IrisGridTreeTableModel extends IrisGridTableModelTemplate<
     if (row != null && column != null) {
       if (!row.hasChildren && column.constituentType != null) {
         const value = this.valueForCell(x, y);
-        return this.displayString(value, column.constituentType, column.name);
+        const text = this.displayString(
+          value,
+          column.constituentType,
+          column.name
+        );
+
+        if (TableUtils.isTextType(this.columns[x]?.type)) {
+          if (value === null) {
+            return this.formatter.showNullStrings ? 'null' : '';
+          }
+
+          if (text === '') {
+            return this.formatter.showEmptyStrings ? 'empty' : '';
+          }
+        }
+
+        return text;
       }
+
       // Show empty string instead of null in rollup grouping columns (issue #1483)
       if (
         row.hasChildren &&

tests/docker-scripts/docker-compose.yml

@@ -1,7 +1,7 @@
 services:
   dhc-server:
     container_name: dhc-server
-    image: ghcr.io/deephaven/server:${DHC_VERSION:-0.36.1}
+    image: ghcr.io/deephaven/server:${DHC_VERSION:-0.39.5}
     pull_policy: always
     volumes:
       - ./data:/data

tests/table-operations.spec.ts

@@ -439,8 +439,9 @@ test('rollup rows and aggregrate columns', async ({ page }) => {
     await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
   });
 
-  await test.step('Toggle constituents', async () => {
-    await page.getByText('Constituents').click();
+  await test.step('Expand constituent with non-aggregated columns visible', async () => {
+    const gridCanvas = page.locator('.iris-grid .grid-wrapper');
+    await gridCanvas.click({ position: { x: 10, y: 80 } });
 
     await waitForLoadingDone(page);
     await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
@@ -453,6 +454,21 @@ test('rollup rows and aggregrate columns', async ({ page }) => {
     await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
   });
 
+  await test.step('Expand constituent with non-aggregated columns hidden', async () => {
+    const gridCanvas = page.locator('.iris-grid .grid-wrapper');
+    await gridCanvas.click({ position: { x: 10, y: 80 } });
+
+    await waitForLoadingDone(page);
+    await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
+  });
+
+  await test.step('Toggle constituents', async () => {
+    await page.getByText('Constituents').click();
+
+    await waitForLoadingDone(page);
+    await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
+  });
+
   await test.step('Rollup another column', async () => {
     const intColumn = page.getByRole('button', { name: 'Int', exact: true });
     expect(intColumn).toBeTruthy();
@@ -486,6 +502,14 @@ test('rollup rows and aggregrate columns', async ({ page }) => {
     await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
   });
 
+  await test.step('Expand constituent with aggregations applied', async () => {
+    const gridCanvas = page.locator('.iris-grid .grid-wrapper');
+    await gridCanvas.click({ position: { x: 10, y: 80 } });
+
+    await waitForLoadingDone(page);
+    await expect(page.locator('.iris-grid-column')).toHaveScreenshot();
+  });
+
   await test.step('Edit aggregated columns', async () => {
     await page
       .getByRole('button', { name: 'Edit Columns', exact: true })