@finos/legend-cube-builder 0.0.4 → 0.0.6

package/src/__test-utils__/CubeTestApplication.ts

@@ -22,6 +22,11 @@ import {
   LegendApplicationPluginManager,
 } from '@finos/legend-application';
 import { TEST__getApplicationVersionData } from '@finos/legend-application/test';
+import { jest } from '@jest/globals';
+import {
+  type CubeEngineClientControls,
+  CubeEngineClientSettings,
+} from '../graph-manager/CubeEngineClientSettings.js';
 import type { CubeHost } from '../stores/CubeHost.js';
 import { LocalModelCatalog } from '../stores/LocalModelCatalog.js';
 import {
@@ -73,6 +78,9 @@ export const TEST__createCubeApplicationStore = (
   );
 };
 
+/** The engine URL a test host is configured with */
+export const TEST__CUBE_ENGINE_URL = 'http://localhost:6300/api';
+
 /** A host over fakes of the engine, the connection explorer and the data product catalog, with the bundled models */
 export const TEST__createCubeHost = (
   answers?: FakeCubeEngineAnswers,
@@ -82,8 +90,23 @@ export const TEST__createCubeHost = (
   fake: FakeCubeEngine;
   connections: FakeCubeConnectionExplorer;
   dataProducts: FakeCubeDataProductCatalog;
+  /** An engine client registered with the host's engine client settings */
+  engineClient: {
+    setBaseUrl: jest.Mock<CubeEngineClientControls['setBaseUrl']>;
+    setCompression: jest.Mock<CubeEngineClientControls['setCompression']>;
+  };
 } => {
   const fake = createFakeCubeEngine(answers);
+  const engineClientSettings = new CubeEngineClientSettings({
+    baseUrl: TEST__CUBE_ENGINE_URL,
+    enableCompression: true,
+  });
+  const engineClient = {
+    setBaseUrl: jest.fn<CubeEngineClientControls['setBaseUrl']>(),
+    setCompression: jest.fn<CubeEngineClientControls['setCompression']>(),
+  };
+  engineClientSettings.register(engineClient);
+  engineClient.setCompression.mockClear();
   const connections = createFakeCubeConnectionExplorer();
   const dataProducts = createFakeCubeDataProductCatalog();
   return {
@@ -93,9 +116,11 @@ export const TEST__createCubeHost = (
       modelCatalog: new LocalModelCatalog(fake.engine),
       connectionExplorer: connections.explorer,
       dataProductCatalog: dataProducts.catalog,
+      engineClientSettings,
     },
     fake,
     connections,
     dataProducts,
+    engineClient,
   };
 };

package/src/__test-utils__/CubeVariantTestUtils.ts

@@ -0,0 +1,103 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { expect } from '@jest/globals';
+import {
+  CubeDocument,
+  PrimitiveType,
+  Query,
+  SchemaColumn,
+} from '@finos/legend-cube';
+import { flowResult } from 'mobx';
+import type { CubeResult } from '../graph-manager/CubeEngine.js';
+import { CubeEditorState } from '../stores/CubeEditorState.js';
+import { CUBE_NORTHWIND_MODEL } from '../stores/fixtures/CubeNorthwindModel.js';
+import { TEST__createCubeHost } from './CubeTestApplication.js';
+import {
+  NORTHWIND_RUNTIME,
+  northwindTable,
+} from './CubeNorthwindTestQueries.js';
+import {
+  createFakeNorthwindOutline,
+  type FakeCubeEngine,
+} from './FakeCubeEngine.js';
+
+// A cube whose rows hold a Variant column, PAYLOAD, for Explore JSON's tests
+// (PLAN §11.20): Northwind's ORDERS as a table of a model whose runtime runs on
+// the database type given
+
+export const TEST__PAYLOAD = new SchemaColumn(
+  'PAYLOAD',
+  PrimitiveType.get('Variant'),
+  true,
+);
+
+/** ORDERS' columns in these tests: an id, PAYLOAD, and a number */
+export const TEST__PAYLOAD_COLUMNS = [
+  new SchemaColumn(
+    'ORDER_ID',
+    PrimitiveType.get('meta::pure::precisePrimitives::Int'),
+    false,
+  ),
+  TEST__PAYLOAD,
+  // a name an offer would take, in another case
+  new SchemaColumn('PAYLOAD_TAGS_COUNT', PrimitiveType.get('Integer'), true),
+];
+
+export const TEST__PAYLOAD_DOCUMENTS = [
+  '{"user":{"name":"ann","tier":"gold"},"tags":["a","b"]}',
+  '{"user":{"name":"bob"},"tags":[]}',
+];
+
+/** The engine's answer to a read of PAYLOAD: these documents, one per row */
+export const TEST__payloadSample = (
+  documents: readonly string[] = TEST__PAYLOAD_DOCUMENTS,
+): CubeResult => ({
+  columns: ['PAYLOAD'],
+  rows: documents.map((document) => [document]),
+  sql: [],
+  durationMs: 1,
+});
+
+/** The table alone, run once on a database of this type; later runs read the sample */
+export const TEST__setUpPayloadRun = async (
+  databaseType = 'DuckDB',
+  sample: CubeResult = TEST__payloadSample(),
+): Promise<{ state: CubeEditorState; fake: FakeCubeEngine }> => {
+  const { host, fake } = TEST__createCubeHost({
+    result: {
+      columns: TEST__PAYLOAD_COLUMNS.map((column) => column.name),
+      rows: [['1', TEST__PAYLOAD_DOCUMENTS[0] ?? null, '2']],
+      sql: [],
+      durationMs: 1,
+    },
+    outline: createFakeNorthwindOutline(databaseType),
+  });
+  const state = new CubeEditorState(
+    host,
+    new CubeDocument({
+      context: { model: CUBE_NORTHWIND_MODEL, runtime: NORTHWIND_RUNTIME },
+      query: new Query(
+        [northwindTable('relational101', 'ORDERS', TEST__PAYLOAD_COLUMNS)],
+        [],
+        'relational101',
+      ),
+    }),
+  );
+  await flowResult(state.execution.execute());
+  expect(state.execution.result).toBeDefined();
+  fake.execute.mockResolvedValue(sample);
+  return { state, fake };
+};

package/src/__test-utils__/FakeCubeEngine.ts

@@ -71,6 +71,20 @@ export const FAKE_NORTHWIND_OUTLINE: CubeModelOutline = {
   ],
 };
 
+/** The Northwind outline, its runtime's connection of this database type */
+export const createFakeNorthwindOutline = (
+  databaseType: string,
+): CubeModelOutline => ({
+  ...FAKE_NORTHWIND_OUTLINE,
+  runtimes: [
+    {
+      path: NORTHWIND_RUNTIME,
+      storePaths: [NORTHWIND_DATABASE],
+      connections: [{ storePath: NORTHWIND_DATABASE, databaseType }],
+    },
+  ],
+});
+
 /** The schemas the fake gives, keyed by `<schema>.<table>` as the outline names them */
 export const FAKE_NORTHWIND_SCHEMAS: ReadonlyMap<string, Schema> = new Map([
   ['NORTHWIND.ORDERS', new Schema(ORDERS_COLUMNS)],
@@ -89,6 +103,7 @@ export interface FakeCubeEngineAnswers {
   /** keyed by `<schema>.<table>`; a table not in it gets a compile error */
   readonly schemas?: ReadonlyMap<string, Schema>;
   readonly result?: CubeResult;
+  readonly csv?: string;
   readonly pure?: string;
 }
 
@@ -98,7 +113,9 @@ export interface FakeCubeEngine {
   readonly resolveSchemas: jest.Mock<CubeEngine['resolveSchemas']>;
   readonly typeLambdas: jest.Mock<CubeEngine['typeLambdas']>;
   readonly execute: jest.Mock<CubeEngine['execute']>;
+  readonly exportCsv: jest.Mock<CubeEngine['exportCsv']>;
   readonly renderPure: jest.Mock<CubeEngine['renderPure']>;
+  readonly serializeLambda: jest.Mock<CubeEngine['serializeLambda']>;
   readonly parseExpression: jest.Mock<CubeEngine['parseExpression']>;
   readonly planLambda: jest.Mock<CubeEngine['planLambda']>;
 }
@@ -133,9 +150,15 @@ export const createFakeCubeEngine = (
   const execute = jest.fn<CubeEngine['execute']>(async () =>
     Promise.resolve(answers.result ?? EMPTY_CUBE_RESULT),
   );
+  const exportCsv = jest.fn<CubeEngine['exportCsv']>(async () =>
+    Promise.resolve(answers.csv ?? ''),
+  );
   const renderPure = jest.fn<CubeEngine['renderPure']>(async () =>
     Promise.resolve(answers.pure ?? ''),
   );
+  const serializeLambda = jest.fn<CubeEngine['serializeLambda']>((lambda) =>
+    JSON.stringify(lambda, undefined, 2),
+  );
   // a test that types expressions says how; by default, each parses to nothing
   const parseExpression = jest.fn<CubeEngine['parseExpression']>(async () =>
     Promise.reject(
@@ -154,7 +177,9 @@ export const createFakeCubeEngine = (
       resolveSchemas,
       typeLambdas,
       execute,
+      exportCsv,
       renderPure,
+      serializeLambda,
       parseExpression,
       planLambda,
     },
@@ -162,7 +187,9 @@ export const createFakeCubeEngine = (
     resolveSchemas,
     typeLambdas,
     execute,
+    exportCsv,
     renderPure,
+    serializeLambda,
     parseExpression,
     planLambda,
   };

package/src/__test-utils__/FakeCubeIngestCatalog.ts

@@ -84,6 +84,24 @@ const DATA_SETS: ReadonlyMap<string, readonly CubeIngestDataSet[]> = new Map([
   ],
 ]);
 
+export const FAKE_INGEST_FILLS_SCHEMA = new Schema([
+  new SchemaColumn('FILL_ID', PrimitiveType.get('Integer'), false),
+  new SchemaColumn('QUANTITY', PrimitiveType.get('Integer'), false),
+]);
+
+/**
+ * The orders definition's data sets with a second one that can be added,
+ * FILLS, for picking several at once: what `describe` gives when mocked so
+ */
+export const FAKE_INGEST_ORDERS_WITH_FILLS: readonly CubeIngestDataSet[] = [
+  ...(DATA_SETS.get(FAKE_INGEST_ORDERS) ?? []),
+  new CubeIngestDataSet({
+    name: 'FILLS',
+    schema: FAKE_INGEST_FILLS_SCHEMA,
+    primaryKey: ['FILL_ID'],
+  }),
+];
+
 const definitionOf = (urn: string): string =>
   urn.slice(urn.lastIndexOf('~') + 1);
 

package/src/__test-utils__/FakeCubeServiceCatalog.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { jest } from '@jest/globals';
+import type {
+  CubeServiceCatalog,
+  CubeServiceSummary,
+} from '../graph-manager/CubeServiceCatalog.js';
+
+// A fake of the engine's service registry, for the Service tab's and the
+// editor's tests: two trading services, one without a title
+
+export const FAKE_TRADES_SERVICE: CubeServiceSummary = {
+  name: 'trading::services::TradesByDesk',
+  title: 'Trades by desk',
+  pattern: '/trades/byDesk',
+  documentation: 'Every trade, by desk',
+  owners: ['alice', 'bob'],
+};
+
+export const FAKE_DESKS_SERVICE: CubeServiceSummary = {
+  name: 'trading::services::Desks',
+  pattern: '/desks',
+  documentation: '',
+  owners: ['Deployment 1234'],
+};
+
+export interface FakeCubeServiceCatalog {
+  readonly catalog: CubeServiceCatalog;
+  readonly listServices: jest.Mock<CubeServiceCatalog['listServices']>;
+}
+
+/** A fresh fake: build one per test, since jest.fn keeps its calls across tests */
+export const createFakeCubeServiceCatalog = (
+  services: readonly CubeServiceSummary[] = [
+    FAKE_DESKS_SERVICE,
+    FAKE_TRADES_SERVICE,
+  ],
+): FakeCubeServiceCatalog => {
+  const listServices = jest.fn<CubeServiceCatalog['listServices']>(async () =>
+    Promise.resolve(services),
+  );
+  return { catalog: { listServices }, listServices };
+};

package/src/components/CubeAddItems.tsx

@@ -28,10 +28,16 @@ import {
 import type { AnyNodeDefinition } from '@finos/legend-cube';
 import { observer } from 'mobx-react-lite';
 import {
+  getCubeNodeBadge,
   OTHER_SOURCE_KIND_TITLE,
   READ_ONLY_CUBE_TITLE,
 } from '../__lib__/LegendCubeLabels.js';
-import { addCubeNode, canAddCubeNode } from '../stores/CubeAddPlacement.js';
+import { CUBE_TOUR_ANCHOR, cubeTourAnchor } from '../__lib__/LegendCubeTour.js';
+import {
+  addCubeNode,
+  canAddCubeNode,
+  getCubeAddDatabaseProblem,
+} from '../stores/CubeAddPlacement.js';
 import type { CubeEditorState } from '../stores/CubeEditorState.js';
 import { CubeNodeIcon } from './CubeNodeIcon.js';
 
@@ -40,7 +46,7 @@ interface CubeAddItem {
   readonly definition: AnyNodeDefinition;
   readonly label: string;
   readonly disabled: boolean;
-  /** Why a source can't be added */
+  /** Why a source, or a transform its database can't run, can't be added */
   readonly title: string | undefined;
   readonly add: () => void;
 }
@@ -59,14 +65,16 @@ const getCubeAddItems = (
 ): { sources: CubeAddItem[]; transforms: CubeAddItem[] } => {
   const item = (definition: AnyNodeDefinition): CubeAddItem => {
     const disabled = !canAddCubeNode(editorState, definition.type, nodeId);
+    const badge = getCubeNodeBadge(definition);
     return {
       definition,
-      label: `${definition.label}${definition.beta ? ' (BETA)' : ''}`,
+      label: `${definition.label}${badge ? ` (${badge})` : ''}`,
       disabled,
-      title:
-        disabled && definition.kind === 'source'
+      title: !disabled
+        ? undefined
+        : definition.kind === 'source'
           ? (editorState.sourcePicker.disabledReason ?? OTHER_SOURCE_KIND_TITLE)
-          : undefined,
+          : getCubeAddDatabaseProblem(editorState, definition.type, nodeId),
       add: () => addCubeNode(editorState, definition.type, nodeId),
     };
   };
@@ -151,6 +159,7 @@ export const CubeAddItemsMenu = observer(
               ? READ_ONLY_CUBE_TITLE
               : 'Add a source, or a step after the selected node'
           }
+          {...cubeTourAnchor(CUBE_TOUR_ANCHOR.ADD_ITEMS)}
           aria-haspopup="menu"
           aria-expanded={isOpen}
           onClick={openMenu}

package/src/components/CubeDialogTheme.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2026-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * The `darkMode` Cube's dialogs give their primary footer button (Add,
+ * Apply, Close): always legend-art's "dark" variant, which its styles now
+ * draw from the theme's tokens in every theme, an accent button. In a light
+ * theme, its "light" variant, a legacy alias, draws it grey, so an enabled
+ * Add looked disabled. The dialog and its secondary buttons keep following
+ * the theme: the "dark" variant would draw the title dark on the blue header
+ */
+export const CUBE_PRIMARY_BUTTON_DARK_MODE = true;