@odoo/o-spreadsheet 14.0.1 → 15.0.0

package/tests/formulas/__snapshots__/compiler_test.ts.snap

@@ -1,302 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`compile functions with lazy arguments functions call requesting lazy parameters 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =USELAZYARG(|N0|)
-let _2 = ()=> deps[0]
-ctx.__lastFnCalled = 'USELAZYARG'
-let _1 = ctx['USELAZYARG'](_2)
-return _1;
-}"
-`;
-
-exports[`compile functions with lazy arguments functions call requesting lazy parameters 2`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =USELAZYARG(|N0|/|N1|)
-let _3 = deps[0]
-let _4 = deps[1]
-ctx.__lastFnCalled = 'DIVIDE'
-let _2 = ()=> ctx['DIVIDE'](_3, _4)
-ctx.__lastFnCalled = 'USELAZYARG'
-let _1 = ctx['USELAZYARG'](_2)
-return _1;
-}"
-`;
-
-exports[`expression compiler async functions 1`] = `
-"async function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =WAIT(|N0|)
-let _2 = deps[0]
-ctx.__lastFnCalled = 'WAIT'
-let _1 = await ctx['WAIT'](_2)
-return _1;
-}"
-`;
-
-exports[`expression compiler cells are converted to ranges if function require a range 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =sum(|0|)
-let _2 = range(0, deps, sheetId)
-ctx.__lastFnCalled = 'SUM'
-let _1 = ctx['SUM'](_2)
-return _1;
-}"
-`;
-
-exports[`expression compiler expression with $ref 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|0|+|1|+|2|
-let _3 = ref(0, deps, sheetId,
-              \\"undefined\\", undefined)
-let _4 = ref(1, deps, sheetId,
-              \\"undefined\\", undefined)
-ctx.__lastFnCalled = 'ADD'
-let _2 = ctx['ADD'](_3, _4)
-let _5 = ref(2, deps, sheetId,
-              \\"undefined\\", undefined)
-ctx.__lastFnCalled = 'ADD'
-let _1 = ctx['ADD'](_2, _5)
-return _1;
-}"
-`;
-
-exports[`expression compiler expression with references with a sheet 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|0|
-let _1 = ref(0, deps, sheetId,
-              \\"undefined\\", undefined)
-return _1;
-}"
-`;
-
-exports[`expression compiler expressions with a debugger 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =? |0| / |N1|
-debugger;
-let _2 = ref(0, deps, sheetId,
-              \\"undefined\\", undefined)
-let _3 = deps[1]
-ctx.__lastFnCalled = 'DIVIDE'
-let _1 = ctx['DIVIDE'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call (with lazy parameters) 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =IF(TRUE, |N0|, |N1|)
-let _2 = true
-let _3 = ()=> deps[0]
-let _4 = ()=> deps[1]
-ctx.__lastFnCalled = 'IF'
-let _1 = ctx['IF'](_2,_3,_4)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call (with lazy parameters) 2`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =IF(TRUE, |0|, |N1|/|N2|)
-let _2 = true
-let _3 = ()=> ref(0, deps, sheetId,
-              \\"IF\\", 2)
-let _5 = deps[1]
-let _6 = deps[2]
-ctx.__lastFnCalled = 'DIVIDE'
-let _4 = ()=> ctx['DIVIDE'](_5, _6)
-ctx.__lastFnCalled = 'IF'
-let _1 = ctx['IF'](_2,_3,_4)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call (with lazy parameters) 3`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =IF(TRUE, IF(TRUE, |0|, SQRT(-|N1|)), |N1|/|N2|)
-let _2 = true
-let _4 = true
-let _5 = ()=> ref(0, deps, sheetId,
-              \\"IF\\", 2)
-let _8 = deps[1]
-ctx.__lastFnCalled = 'UMINUS'
-let _7 = ctx['UMINUS']( _8)
-ctx.__lastFnCalled = 'SQRT'
-let _6 = ()=> ctx['SQRT'](_7)
-ctx.__lastFnCalled = 'IF'
-let _3 = ()=> ctx['IF'](_4,_5,_6)
-let _10 = deps[1]
-let _11 = deps[2]
-ctx.__lastFnCalled = 'DIVIDE'
-let _9 = ()=> ctx['DIVIDE'](_10, _11)
-ctx.__lastFnCalled = 'IF'
-let _1 = ctx['IF'](_2,_3,_9)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =sum(|N0|,|N1|)
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'SUM'
-let _1 = ctx['SUM'](_2,_3)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call 2`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =sum(true, |S0|)
-let _2 = true
-let _3 = deps[0]
-ctx.__lastFnCalled = 'SUM'
-let _1 = ctx['SUM'](_2,_3)
-return _1;
-}"
-`;
-
-exports[`expression compiler function call 3`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =sum(|N0|,,|N1|)
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'SUM'
-let _1 = ctx['SUM'](_2,null,_3)
-return _1;
-}"
-`;
-
-exports[`expression compiler read some values and functions 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|0| + sum(|1|)
-let _2 = ref(0, deps, sheetId,
-              \\"undefined\\", undefined)
-let _4 = range(1, deps, sheetId)
-ctx.__lastFnCalled = 'SUM'
-let _3 = ctx['SUM'](_4)
-ctx.__lastFnCalled = 'ADD'
-let _1 = ctx['ADD'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler simple values 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|N0|
-let _1 = deps[0]
-return _1;
-}"
-`;
-
-exports[`expression compiler simple values 2`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =true
-let _1 = true
-return _1;
-}"
-`;
-
-exports[`expression compiler simple values 3`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|S0|
-let _1 = deps[0]
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 1`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|N0| + |N1|
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'ADD'
-let _1 = ctx['ADD'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 2`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|N0| * |N1|
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'MULTIPLY'
-let _1 = ctx['MULTIPLY'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 3`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|N0| - |N1|
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'MINUS'
-let _1 = ctx['MINUS'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 4`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =|N0| / |N1|
-let _2 = deps[0]
-let _3 = deps[1]
-ctx.__lastFnCalled = 'DIVIDE'
-let _1 = ctx['DIVIDE'](_2, _3)
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 5`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =-|N0|
-let _2 = deps[0]
-ctx.__lastFnCalled = 'UMINUS'
-let _1 = ctx['UMINUS']( _2)
-return _1;
-}"
-`;
-
-exports[`expression compiler some arithmetic expressions 6`] = `
-"function anonymous(deps,sheetId,ref,range,ctx
-) {
-// =(|N0| + |N1|) * (-|N1| + |N2|)
-let _3 = deps[0]
-let _4 = deps[1]
-ctx.__lastFnCalled = 'ADD'
-let _2 = ctx['ADD'](_3, _4)
-let _7 = deps[1]
-ctx.__lastFnCalled = 'UMINUS'
-let _6 = ctx['UMINUS']( _7)
-let _8 = deps[2]
-ctx.__lastFnCalled = 'ADD'
-let _5 = ctx['ADD'](_6, _8)
-ctx.__lastFnCalled = 'MULTIPLY'
-let _1 = ctx['MULTIPLY'](_2, _5)
-return _1;
-}"
-`;

package/tests/formulas/compiler_test.ts

@@ -1,266 +0,0 @@
-import { Model } from "../../src";
-import { functionCache } from "../../src/formulas/compiler";
-import { compile, normalize } from "../../src/formulas/index";
-import { functionRegistry } from "../../src/functions/index";
-import { ArgType, NormalizedFormula } from "../../src/types";
-import { evaluateCell } from "../helpers";
-
-function compiledBaseFunction(formula: string): string {
-  for (let f in functionCache) {
-    delete functionCache[f];
-  }
-  compileFromCompleteFormula(formula);
-  return Object.values(functionCache)[0].toString();
-}
-
-function compileFromCompleteFormula(formula: string) {
-  let formulaString: NormalizedFormula = normalize(formula);
-  return compile(formulaString);
-}
-
-describe("expression compiler", () => {
-  test("simple values", () => {
-    expect(compiledBaseFunction("=1")).toMatchSnapshot();
-    expect(compiledBaseFunction("=true")).toMatchSnapshot();
-    expect(compiledBaseFunction(`="abc"`)).toMatchSnapshot();
-
-    expect(() => compiledBaseFunction(`='abc'`)).toThrowError();
-  });
-
-  test("some arithmetic expressions", () => {
-    expect(compiledBaseFunction("=1 + 3")).toMatchSnapshot();
-    expect(compiledBaseFunction("=2 * 3")).toMatchSnapshot();
-    expect(compiledBaseFunction("=2 - 3")).toMatchSnapshot();
-    expect(compiledBaseFunction("=2 / 3")).toMatchSnapshot();
-    expect(compiledBaseFunction("=-3")).toMatchSnapshot();
-    expect(compiledBaseFunction("=(3 + 1) * (-1 + 4)")).toMatchSnapshot();
-  });
-
-  test("function call", () => {
-    expect(compiledBaseFunction("=sum(1,2)")).toMatchSnapshot();
-    expect(compiledBaseFunction('=sum(true, "")')).toMatchSnapshot();
-    expect(compiledBaseFunction("=sum(1,,2)")).toMatchSnapshot();
-  });
-
-  test("function call (with lazy parameters)", () => {
-    expect(compiledBaseFunction("=IF(TRUE, 42, 24)")).toMatchSnapshot();
-    expect(compiledBaseFunction("=IF(TRUE, A2, 1/0)")).toMatchSnapshot();
-    expect(compiledBaseFunction("=IF(TRUE, IF(TRUE, A2, SQRT(-1)), 1/0)")).toMatchSnapshot();
-  });
-
-  test("read some values and functions", () => {
-    expect(compiledBaseFunction("=A1 + sum(A2:C3)")).toMatchSnapshot();
-  });
-
-  test("expression with $ref", () => {
-    expect(compiledBaseFunction("=$A1+$A$2+A$3")).toMatchSnapshot();
-  });
-
-  test("expression with references with a sheet", () => {
-    expect(compiledBaseFunction("=Sheet34!B3")).toMatchSnapshot();
-  });
-
-  test("expressions with a debugger", () => {
-    expect(compiledBaseFunction("=? A1 / 2")).toMatchSnapshot();
-  });
-
-  test("async functions", () => {
-    expect(compiledBaseFunction("=WAIT(5)")).toMatchSnapshot();
-  });
-
-  test("cells are converted to ranges if function require a range", () => {
-    expect(compiledBaseFunction("=sum(A1)")).toMatchSnapshot();
-  });
-
-  test("cannot compile some invalid formulas", () => {
-    expect(() => compiledBaseFunction("=qsdf")).toThrow();
-  });
-
-  test("check at compile time for number of arguments", () => {
-    expect(() => compiledBaseFunction("=pi()")).not.toThrow();
-    expect(() => compiledBaseFunction("=pi(3)")).toThrowError("Invalid number of arguments");
-    expect(() => compiledBaseFunction("=sum()")).toThrowError("Invalid number of arguments");
-    expect(() => compiledBaseFunction("=sum(1)")).not.toThrowError();
-    expect(() => compiledBaseFunction("=sum(1,2)")).not.toThrowError();
-    expect(() => compiledBaseFunction("=sum(1,2,3)")).not.toThrowError();
-  });
-});
-
-describe("compile functions", () => {
-  describe("check number of arguments", () => {
-    test("with basic arguments", () => {
-      functionRegistry.add("ANYFUNCTION", {
-        description: "any function",
-        compute: () => {
-          return true;
-        },
-        args: [
-          { name: "arg1", description: "", type: ["ANY"] },
-          { name: "arg2", description: "", type: ["ANY"] },
-        ],
-        returns: ["ANY"],
-      });
-      expect(() => compiledBaseFunction("=ANYFUNCTION()")).toThrow();
-      expect(() => compiledBaseFunction("=ANYFUNCTION(1)")).toThrow();
-      expect(() => compiledBaseFunction("=ANYFUNCTION(1,2)")).not.toThrow();
-      expect(() => compiledBaseFunction("=ANYFUNCTION(1,2,3)")).toThrow();
-    });
-
-    test("with optional argument", () => {
-      functionRegistry.add("OPTIONAL", {
-        description: "function with optional argument",
-        compute: (arg) => {
-          return true;
-        },
-        args: [
-          { name: "arg1", description: "", type: ["ANY"] },
-          { name: "arg2", description: "", type: ["ANY"], optional: true },
-        ],
-        returns: ["ANY"],
-      });
-      expect(() => compiledBaseFunction("=OPTIONAL(1)")).not.toThrow();
-      expect(() => compiledBaseFunction("=OPTIONAL(1,2)")).not.toThrow();
-      expect(() => compiledBaseFunction("=OPTIONAL(1,2,3)")).toThrow();
-    });
-
-    test("with repeatable argument", () => {
-      functionRegistry.add("REPEATABLE", {
-        description: "function with repeatable argument",
-        compute: (arg) => {
-          return true;
-        },
-        args: [
-          { name: "arg1", description: "", type: ["ANY"] },
-          { name: "arg2", description: "", type: ["ANY"], optional: true, repeating: true },
-        ],
-        returns: ["ANY"],
-      });
-      expect(() => compiledBaseFunction("=REPEATABLE(1)")).not.toThrow();
-      expect(() => compiledBaseFunction("=REPEATABLE(1,2)")).not.toThrow();
-      expect(() => compiledBaseFunction("=REPEATABLE(1,2,3,4,5,6)")).not.toThrow();
-    });
-  });
-
-  describe("check type of arguments", () => {
-    test("reject non-range argument when expecting only range argument", () => {
-      functionRegistry.add("RANGEEXPECTED", {
-        description: "function expect number in 1st arg",
-        compute: (arg) => {
-          return true;
-        },
-        args: [{ name: "arg1", description: "", type: ["RANGE"] }],
-        returns: ["ANY"],
-      });
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(42)")).toThrowError(
-        "Function RANGEEXPECTED expects the parameter 1 to be reference to a cell or range, not a number."
-      );
-      expect(() => compiledBaseFunction('=RANGEEXPECTED("test")')).toThrowError(
-        "Function RANGEEXPECTED expects the parameter 1 to be reference to a cell or range, not a string."
-      );
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(TRUE)")).toThrowError(
-        "Function RANGEEXPECTED expects the parameter 1 to be reference to a cell or range, not a boolean."
-      );
-
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(A1)")).not.toThrow();
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(A1:A1)")).not.toThrow();
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(A1:A2)")).not.toThrow();
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(A1:A$2)")).not.toThrow();
-      expect(() => compiledBaseFunction("=RANGEEXPECTED(sheet2!A1:A$2)")).not.toThrow();
-    });
-
-    test("reject range when expecting only non-range argument", () => {
-      for (let typeExpected of ["ANY", "BOOLEAN", "DATE", "NUMBER", "STRING"] as ArgType[]) {
-        functionRegistry.add(typeExpected + "EXPECTED", {
-          description: "function expect number in 1st arg",
-          compute: (arg) => {
-            return true;
-          },
-          args: [{ name: "arg1", description: "", type: [typeExpected] }],
-          returns: ["ANY"],
-        });
-      }
-
-      const m = new Model();
-      expect(() => m.getters.evaluateFormula("=ANYEXPECTED(A1:A2)")).toThrowError(
-        "Function ANYEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=BOOLEANEXPECTED(A1:A2)")).toThrowError(
-        "Function BOOLEANEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=DATEEXPECTED(A1:A2)")).toThrowError(
-        "Function DATEEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=NUMBEREXPECTED(A1:A2)")).toThrowError(
-        "Function NUMBEREXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=STRINGEXPECTED(A1:A2)")).toThrowError(
-        "Function STRINGEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-
-      expect(() => m.getters.evaluateFormula("=ANYEXPECTED(A1:A$2)")).toThrowError(
-        "Function ANYEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=ANYEXPECTED(sheet2!A1:A$2)")).toThrowError(
-        "Function ANYEXPECTED expects the parameter 1 to be a single value or a single cell reference, not a range."
-      );
-      expect(() => m.getters.evaluateFormula("=ANYEXPECTED(A1:A1)")).not.toThrow();
-    });
-  });
-
-  describe("with lazy arguments", () => {
-    // this tests performs controls inside formula functions. For this reason, we
-    // don't use mocked functions. Errors would be caught during evaluation of
-    // formulas and not during the tests. So here we use a simple counter
-
-    let count = 0;
-
-    beforeAll(() => {
-      functionRegistry.add("ANYFUNCTION", {
-        description: "any function",
-        compute: () => {
-          count += 1;
-          return true;
-        },
-        args: [],
-        returns: ["ANY"],
-      });
-
-      functionRegistry.add("USELAZYARG", {
-        description: "function with a lazy argument",
-        compute: (arg) => {
-          count *= 42;
-          return arg();
-        },
-        args: [{ name: "lazyArg", description: "", type: ["ANY"], lazy: true }],
-        returns: ["ANY"],
-      });
-
-      functionRegistry.add("NOTUSELAZYARG", {
-        description: "any function",
-        compute: (arg) => {
-          count *= 42;
-          return arg;
-        },
-        args: [{ name: "any", description: "", type: ["ANY"] }],
-        returns: ["ANY"],
-      });
-    });
-
-    test("with function as argument --> change the order in which functions are evaluated ", () => {
-      count = 0;
-      evaluateCell("A1", { A1: "=USELAZYARG(ANYFUNCTION())" });
-      expect(count).toBe(1);
-      count = 0;
-      evaluateCell("A2", { A2: "=NOTUSELAZYARG(ANYFUNCTION())" });
-      expect(count).toBe(42);
-    });
-
-    test.each(["=USELAZYARG(24)", "=USELAZYARG(1/0)"])(
-      "functions call requesting lazy parameters",
-      (formula) => {
-        const compiledFormula = compiledBaseFunction(formula);
-        expect(compiledFormula.toString()).toMatchSnapshot();
-      }
-    );
-  });
-});