Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

22.9 KB
Raw Blame
/* Copyright 2026 Marimo. All rights reserved. */

import { describe, expect, it } from "vitest";
import type { FieldTypes } from "@/components/data-table/types";
import type { DataType } from "@/core/kernel/messages";
import {
  insertColumn,
  modifyColumnFields,
  orderColumnFields,
  removeColumn,
  renameColumn,
} from "../data-utils";

// Fixtures are written as object literals for readability; `FieldTypes`
// is a `Map` (#9269).
const asFieldTypes = (obj: Record<string, DataType>): FieldTypes =>
  new Map(Object.entries(obj));

const testData = [
  { int: 1, string: "a", bool: "True", datetime: "2025-07-12 00:07:13" },
  { int: 2, string: "b", bool: "False", datetime: null },
  { int: 3, string: "c", bool: null, datetime: "2025-07-12 00:07:13" },
  { int: 0, string: "", bool: "", datetime: "" },
];

const mixedData = [{ a: 1, b: 2 }, { a: 3, b: 4, c: 5 }, { a: 6 }];

const dataWithNulls = [
  { a: 1, b: null, c: undefined },
  { a: null, b: 2, c: 3 },
];

describe("orderColumnFields", () => {
  it("uses explicit order for numeric-looking column names", () => {
    const inferred = new Map([
      ["2", "string"],
      ["10", "string"],
    ]) as FieldTypes;

    expect([...orderColumnFields(inferred, ["10", "2"])]).toEqual([
      ["10", "string"],
      ["2", "string"],
    ]);
  });

  it("creates unknown fields for an empty table", () => {
    expect([...orderColumnFields(new Map(), ["value"])]).toEqual([
      ["value", "unknown"],
    ]);
  });
});

describe("removeColumn", () => {
  it("should remove the first column", () => {
    const result = removeColumn(testData, "int");

    expect(result).toEqual([
      { string: "a", bool: "True", datetime: "2025-07-12 00:07:13" },
      { string: "b", bool: "False", datetime: null },
      { string: "c", bool: null, datetime: "2025-07-12 00:07:13" },
      { string: "", bool: "", datetime: "" },
    ]);
  });

  it("should remove the second column", () => {
    const result = removeColumn(testData, "string");

    expect(result).toEqual([
      { int: 1, bool: "True", datetime: "2025-07-12 00:07:13" },
      { int: 2, bool: "False", datetime: null },
      { int: 3, bool: null, datetime: "2025-07-12 00:07:13" },
      { int: 0, bool: "", datetime: "" },
    ]);
  });

  it("should remove the third column", () => {
    const result = removeColumn(testData, "bool");

    expect(result).toEqual([
      { int: 1, string: "a", datetime: "2025-07-12 00:07:13" },
      { int: 2, string: "b", datetime: null },
      { int: 3, string: "c", datetime: "2025-07-12 00:07:13" },
      { int: 0, string: "", datetime: "" },
    ]);
  });

  it("should remove the last column", () => {
    const result = removeColumn(testData, "datetime");

    expect(result).toEqual([
      { int: 1, string: "a", bool: "True" },
      { int: 2, string: "b", bool: "False" },
      { int: 3, string: "c", bool: null },
      { int: 0, string: "", bool: "" },
    ]);
  });

  it("should handle removing a non-existent column", () => {
    const result = removeColumn(testData, "missing");
    expect(result).toEqual(testData);
  });

  it("should preserve original data structure", () => {
    const originalData = [...testData];
    removeColumn(testData, "string");
    // Original data should remain unchanged
    expect(testData).toEqual(originalData);
  });

  it("should handle objects with different property counts", () => {
    const result = removeColumn(mixedData, "b");

    expect(result).toEqual([{ a: 1 }, { a: 3, c: 5 }, { a: 6 }]);
  });

  it("should handle null and undefined values in data", () => {
    const result = removeColumn(dataWithNulls, "b");

    expect(result).toEqual([
      { a: 1, c: undefined },
      { a: null, c: 3 },
    ]);
  });
});

describe("insertColumn", () => {
  it("should insert column at index 0", () => {
    const result = insertColumn(testData, "newColumn", 0);

    const expected = [
      {
        newColumn: "",
        int: 1,
        string: "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
      },
      { newColumn: "", int: 2, string: "b", bool: "False", datetime: null },
      {
        newColumn: "",
        int: 3,
        string: "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
      },
      { newColumn: "", int: 0, string: "", bool: "", datetime: "" },
    ];
    expect(result).toEqual(expected);
    expect(Object.keys(result[0])).toEqual([
      "newColumn",
      "int",
      "string",
      "bool",
      "datetime",
    ]);
  });

  it("should insert column at index 1", () => {
    const result = insertColumn(testData, "newColumn", 1);

    expect(result).toEqual([
      {
        int: 1,
        newColumn: "",
        string: "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
      },
      { int: 2, newColumn: "", string: "b", bool: "False", datetime: null },
      {
        int: 3,
        newColumn: "",
        string: "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
      },
      { int: 0, newColumn: "", string: "", bool: "", datetime: "" },
    ]);
    expect(Object.keys(result[0])).toEqual([
      "int",
      "newColumn",
      "string",
      "bool",
      "datetime",
    ]);
  });

  it("should insert column at index 2", () => {
    const result = insertColumn(testData, "newColumn", 2);

    expect(result).toEqual([
      {
        int: 1,
        string: "a",
        newColumn: "",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
      },
      { int: 2, string: "b", newColumn: "", bool: "False", datetime: null },
      {
        int: 3,
        string: "c",
        newColumn: "",
        bool: null,
        datetime: "2025-07-12 00:07:13",
      },
      { int: 0, string: "", newColumn: "", bool: "", datetime: "" },
    ]);
  });

  it("should insert column at index 3", () => {
    const result = insertColumn(testData, "newColumn", 3);

    expect(result).toEqual([
      {
        int: 1,
        string: "a",
        bool: "True",
        newColumn: "",
        datetime: "2025-07-12 00:07:13",
      },
      { int: 2, string: "b", bool: "False", newColumn: "", datetime: null },
      {
        int: 3,
        string: "c",
        bool: null,
        newColumn: "",
        datetime: "2025-07-12 00:07:13",
      },
      { int: 0, string: "", bool: "", newColumn: "", datetime: "" },
    ]);
  });

  it("should insert column at the end when index equals length", () => {
    const result = insertColumn(testData, "newColumn", 4);

    expect(result).toEqual([
      {
        int: 1,
        string: "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
        newColumn: "",
      },
      { int: 2, string: "b", bool: "False", datetime: null, newColumn: "" },
      {
        int: 3,
        string: "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
        newColumn: "",
      },
      { int: 0, string: "", bool: "", datetime: "", newColumn: "" },
    ]);
  });

  it("should handle inserting at index beyond array length", () => {
    const result = insertColumn(testData, "newColumn", 999);
    // Should add the column at the end
    expect(result).toEqual([
      {
        int: 1,
        string: "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
        newColumn: "",
      },
      { int: 2, string: "b", bool: "False", datetime: null, newColumn: "" },
      {
        int: 3,
        string: "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
        newColumn: "",
      },
      { int: 0, string: "", bool: "", datetime: "", newColumn: "" },
    ]);
  });

  it("should preserve original data structure", () => {
    const originalData = [...testData];
    insertColumn(testData, "newColumn");
    // Original data should remain unchanged
    expect(testData).toEqual(originalData);
  });

  it("should handle empty array", () => {
    const result = insertColumn([], "newColumn");
    expect(result).toEqual([]);
  });

  it("should handle array with single object", () => {
    const singleRowData = [{ a: 1, b: 2, c: 3 }];
    const result = insertColumn(singleRowData, "newColumn", 1);
    expect(result).toEqual([{ a: 1, newColumn: "", b: 2, c: 3 }]);
  });

  it("should handle objects with different property counts", () => {
    const result = insertColumn(mixedData, "newColumn", 1);

    expect(result).toEqual([
      { a: 1, newColumn: "", b: 2 },
      { a: 3, newColumn: "", b: 4, c: 5 },
      { a: 6, newColumn: "" },
    ]);
  });

  it("should handle null and undefined values in data", () => {
    const result = insertColumn(dataWithNulls, "newColumn", 1);

    expect(result).toEqual([
      { a: 1, newColumn: "", b: null, c: undefined },
      { a: null, newColumn: "", b: 2, c: 3 },
    ]);
  });

  it("should handle special characters in column name", () => {
    const result = insertColumn(testData, "new-column_with_123", 1);

    expect(result).toEqual([
      {
        int: 1,
        "new-column_with_123": "",
        string: "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
      },
      {
        int: 2,
        "new-column_with_123": "",
        string: "b",
        bool: "False",
        datetime: null,
      },
      {
        int: 3,
        "new-column_with_123": "",
        string: "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
      },
      { int: 0, "new-column_with_123": "", string: "", bool: "", datetime: "" },
    ]);
  });
});

describe("renameColumn", () => {
  it("should rename a column successfully", () => {
    const result = renameColumn(testData, "int", "number");

    expect(result).toEqual([
      { number: 1, string: "a", bool: "True", datetime: "2025-07-12 00:07:13" },
      { number: 2, string: "b", bool: "False", datetime: null },
      { number: 3, string: "c", bool: null, datetime: "2025-07-12 00:07:13" },
      { number: 0, string: "", bool: "", datetime: "" },
    ]);
  });

  it("should rename a column with special characters", () => {
    const result = renameColumn(testData, "string", "text-field");

    expect(result).toEqual([
      {
        int: 1,
        "text-field": "a",
        bool: "True",
        datetime: "2025-07-12 00:07:13",
      },
      { int: 2, "text-field": "b", bool: "False", datetime: null },
      {
        int: 3,
        "text-field": "c",
        bool: null,
        datetime: "2025-07-12 00:07:13",
      },
      { int: 0, "text-field": "", bool: "", datetime: "" },
    ]);
  });

  it("should handle renaming to an existing column name", () => {
    const result = renameColumn(testData, "int", "string");

    expect(result).toEqual(testData);
  });

  it("should handle non-existent column name gracefully", () => {
    const result = renameColumn(testData, "nonexistent", "newName");

    // Should return the original data unchanged since the column doesn't exist
    expect(result).toEqual(testData);
  });

  it("should handle empty string column names", () => {
    const result = renameColumn(testData, "", "emptyColumn");

    // Should return the original data unchanged since empty string is not a valid column name
    expect(result).toEqual(testData);
  });

  it("should handle renaming to empty string", () => {
    const result = renameColumn(testData, "int", "");

    // Should return the original data unchanged since empty string is not a valid column name
    expect(result).toEqual(testData);
  });

  it("should preserve original data structure", () => {
    const originalData = [...testData];
    renameColumn(testData, "int", "number");
    // Original data should remain unchanged
    expect(testData).toEqual(originalData);
  });

  it("should handle empty array", () => {
    const result = renameColumn([], "oldName", "newName");
    expect(result).toEqual([]);
  });

  it("should handle array with single object", () => {
    const singleRowData = [{ a: 1, b: 2, c: 3 }];
    const result = renameColumn(singleRowData, "a", "x");
    expect(result).toEqual([{ x: 1, b: 2, c: 3 }]);
  });

  it("should handle objects with different property counts", () => {
    const result = renameColumn(mixedData, "a", "alpha");

    expect(result).toEqual([
      { alpha: 1, b: 2 },
      { alpha: 3, b: 4, c: 5 },
      { alpha: 6 },
    ]);
  });

  it("should handle null and undefined values in data", () => {
    const result = renameColumn(dataWithNulls, "b", "beta");

    expect(result).toEqual([
      { a: 1, beta: null, c: undefined },
      { a: null, beta: 2, c: 3 },
    ]);
  });

  it("should handle case-sensitive column names", () => {
    const caseSensitiveData = [{ Name: "John", name: "Jane" }];
    const result = renameColumn(caseSensitiveData, "Name", "FullName");

    expect(result).toEqual([{ FullName: "John", name: "Jane" }]);
  });

  it("should handle renaming multiple columns in sequence", () => {
    let result = renameColumn(testData, "int", "number");
    result = renameColumn(result, "string", "text");
    result = renameColumn(result, "bool", "boolean");

    expect(result).toEqual([
      {
        number: 1,
        text: "a",
        boolean: "True",
        datetime: "2025-07-12 00:07:13",
      },
      { number: 2, text: "b", boolean: "False", datetime: null },
      { number: 3, text: "c", boolean: null, datetime: "2025-07-12 00:07:13" },
      { number: 0, text: "", boolean: "", datetime: "" },
    ]);
  });

  it("should handle renaming to the same name", () => {
    const result = renameColumn(testData, "int", "int");

    // Should return the original data unchanged
    expect(result).toEqual(testData);
  });

  it("should handle numeric column names", () => {
    const numericData = [{ "1": "value1", "2": "value2" }];
    const result = renameColumn(numericData, "1", "one");

    expect(result).toEqual([{ one: "value1", "2": "value2" }]);
  });
});

describe("modifyColumnFields", () => {
  const testFieldTypes: FieldTypes = asFieldTypes({
    int: "integer",
    string: "string",
    bool: "boolean",
    datetime: "datetime",
  });

  it("should insert a new column at index 0", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 0,
      type: "insert",
      newColumnName: "newColumn",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "newColumn" => "string",
        "int" => "integer",
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should insert a new column at index 1", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 1,
      type: "insert",
      newColumnName: "newColumn",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "newColumn" => "string",
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should insert a new column at index 2", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 2,
      type: "insert",
      newColumnName: "newColumn",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "newColumn" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should insert a new column at the end", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 4,
      type: "insert",
      newColumnName: "newColumn",
      dataType: "datetime",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
        "newColumn" => "datetime",
      }
    `);
  });

  it("should insert a new column beyond the array length", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 10,
      type: "insert",
      newColumnName: "newColumn",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
        "newColumn" => "string",
      }
    `);
  });

  it("should remove column at index 0", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 0,
      type: "remove",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should remove column at index 1", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 1,
      type: "remove",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should remove column at index 2", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 2,
      type: "remove",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "datetime" => "datetime",
      }
    `);
  });

  it("should remove column at index 3", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 3,
      type: "remove",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "bool" => "boolean",
      }
    `);
  });

  it("should handle removing non-existent column index", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 999,
      type: "remove",
    });
    // Should return the original field types since the index doesn't exist
    expect(result).toEqual(testFieldTypes);
  });

  it("should handle negative index for remove", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: -1,
      type: "remove",
    });
    // Should return the original field types since negative index is invalid
    expect(result).toEqual(testFieldTypes);
  });

  it("should rename column at index 0", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 0,
      type: "rename",
      newColumnName: "number",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "number" => "string",
        "string" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should rename column at index 1", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 1,
      type: "rename",
      newColumnName: "text",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "text" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });

  it("should rename column at index 3", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 3,
      type: "rename",
      dataType: "datetime",
      newColumnName: "timestamp",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "int" => "integer",
        "string" => "string",
        "bool" => "boolean",
        "timestamp" => "datetime",
      }
    `);
  });

  it("should handle renaming non-existent column index", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 999,
      type: "rename",
      newColumnName: "newName",
    });
    // Should return the original field types since the index doesn't exist
    expect(result).toEqual(testFieldTypes);
  });

  it("should handle negative index for rename", () => {
    const result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: -1,
      type: "rename",
      newColumnName: "newName",
    });
    // Should return the original field types since negative index is invalid
    expect(result).toEqual(testFieldTypes);
  });

  it("should preserve original field types structure", () => {
    const originalFieldTypes = new Map(testFieldTypes);
    modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 1,
      type: "remove",
    });
    // Original field types should remain unchanged
    expect(testFieldTypes).toEqual(originalFieldTypes);
  });

  it("should handle empty field types object", () => {
    const emptyFieldTypes: FieldTypes = new Map();

    // Insert
    const insertResult = modifyColumnFields({
      columnFields: emptyFieldTypes,
      columnIdx: 0,
      type: "insert",
      newColumnName: "newColumn",
    });
    expect(insertResult).toMatchInlineSnapshot(`
      Map {
        "newColumn" => "string",
      }
    `);

    // Remove
    const removeResult = modifyColumnFields({
      columnFields: emptyFieldTypes,
      columnIdx: 0,
      type: "remove",
    });
    expect(removeResult).toMatchInlineSnapshot(`Map {}`);
  });

  it("should handle field types with special characters in column names", () => {
    const specialFieldTypes: FieldTypes = asFieldTypes({
      "column-with-dash": "integer",
      column_with_underscore: "string",
      "column.with.dot": "boolean",
      "column with space": "datetime",
    });

    // Insert
    const insertResult = modifyColumnFields({
      columnFields: specialFieldTypes,
      columnIdx: 1,
      type: "insert",
      newColumnName: "new-column",
    });
    expect(insertResult).toMatchInlineSnapshot(`
      Map {
        "column-with-dash" => "integer",
        "new-column" => "string",
        "column_with_underscore" => "string",
        "column.with.dot" => "boolean",
        "column with space" => "datetime",
      }
    `);

    // Remove
    const removeResult = modifyColumnFields({
      columnFields: specialFieldTypes,
      columnIdx: 1,
      type: "remove",
    });
    expect(removeResult).toMatchInlineSnapshot(`
      Map {
        "column-with-dash" => "integer",
        "column.with.dot" => "boolean",
        "column with space" => "datetime",
      }
    `);

    // Rename
    const renameResult = modifyColumnFields({
      columnFields: specialFieldTypes,
      columnIdx: 1,
      type: "rename",
      newColumnName: "renamed-column",
    });
    expect(renameResult).toMatchInlineSnapshot(`
      Map {
        "column-with-dash" => "integer",
        "renamed-column" => "string",
        "column.with.dot" => "boolean",
        "column with space" => "datetime",
      }
    `);
  });

  it("should handle multiple operations in sequence", () => {
    let result = modifyColumnFields({
      columnFields: testFieldTypes,
      columnIdx: 1,
      type: "insert",
      newColumnName: "newColumn",
    });
    result = modifyColumnFields({
      columnFields: result,
      columnIdx: 2,
      type: "remove",
    });
    result = modifyColumnFields({
      columnFields: result,
      columnIdx: 0,
      type: "rename",
      newColumnName: "renamed",
    });

    expect(result).toMatchInlineSnapshot(`
      Map {
        "renamed" => "string",
        "newColumn" => "string",
        "bool" => "boolean",
        "datetime" => "datetime",
      }
    `);
  });
});