Merge pull request #7268 from nocodb/nc-feat/formula-type

Formula type extraction and improvements
nocodb · Dec 21, 2023 · beabf15 · beabf15
2 parents b691549 + 46075eb
commit beabf15
Show file tree

Hide file tree

Showing 27 changed files with 2,527 additions and 1,473 deletions.
diff --git a/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue b/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue
diff --git a/packages/nc-gui/utils/formulaUtils.ts b/packages/nc-gui/utils/formulaUtils.ts
diff --git a/packages/nocodb-sdk/jest.config.js b/packages/nocodb-sdk/jest.config.js
@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};
diff --git a/packages/nocodb-sdk/package.json b/packages/nocodb-sdk/package.json
@@ -30,6 +30,7 @@
     "fix:prettier": "prettier \"src/**/*.ts\" --write",
     "fix:lint": "eslint src --ext .ts --fix",
     "test": "run-s build test:*",
+    "test:unit": "ENV_FILE=./config/.env.test jest",
     "test:lint": "eslint src --ext .ts",
     "test:prettier": "prettier \"src/**/*.ts\" --list-different",
     "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
@@ -45,6 +46,7 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^6.14.0",
     "@typescript-eslint/parser": "^6.14.0",
+    "@types/jest": "^29.5.2",
     "cspell": "^4.2.8",
     "eslint": "^8.54.0",
     "eslint-config-prettier": "^8.10.0",
@@ -56,7 +58,8 @@
     "prettier": "^2.8.8",
     "rimraf": "^5.0.5",
     "tsc-alias": "^1.8.8",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "ts-jest": "^29.1.1"
   },
   "files": [
     "build/main",
@@ -70,4 +73,4 @@
   "prettier": {
     "singleQuote": true
   }
-}
+}
diff --git a/packages/nocodb-sdk/src/lib/Api.ts b/packages/nocodb-sdk/src/lib/Api.ts
@@ -3341,15 +3341,15 @@ export class Api<
       }),
 
     /**
- * @description Regenerate user refresh token
+ * @description Creates a new refresh token and JWT auth token for the user. The refresh token is sent as a cookie, while the JWT auth token is included in the response body.
  * 
  * @tags Auth
  * @name TokenRefresh
  * @summary Refresh Token
  * @request POST:/api/v1/auth/token/refresh
  * @response `200` `{
   \**
-   * New access token for user
+   * New JWT auth token for user
    * @example 96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63
    *\
   token?: string,
@@ -3365,7 +3365,7 @@ export class Api<
       this.request<
         {
           /**
-           * New access token for user
+           * New JWT auth token for user
            * @example 96751db2d53fb834382b682268874a2ea9ee610e4d904e688d1513f11d3c30d62d36d9e05dec0d63
            */
           token?: string;

diff --git a/packages/nocodb-sdk/src/lib/formulaHelpers.spec.ts b/packages/nocodb-sdk/src/lib/formulaHelpers.spec.ts
@@ -0,0 +1,77 @@
+import {
+  FormulaDataTypes,
+  validateFormulaAndExtractTreeWithType,
+} from './formulaHelpers';
+import UITypes from './UITypes';
+
+describe('Formula parsing and type validation', () => {
+  it('Simple formula', async () => {
+    const result = await validateFormulaAndExtractTreeWithType({
+      formula: '1 + 2',
+      columns: [],
+      clientOrSqlUi: 'mysql2',
+      getMeta: async () => ({}),
+    });
+
+    expect(result.dataType).toEqual(FormulaDataTypes.NUMERIC);
+  });
+
+  it('Formula with IF condition', async () => {
+    const result = await validateFormulaAndExtractTreeWithType({
+      formula: 'IF({column}, "Found", BLANK())',
+      columns: [
+        {
+          id: 'cid',
+          title: 'column',
+          uidt: UITypes.Number,
+        },
+      ],
+      clientOrSqlUi: 'mysql2',
+      getMeta: async () => ({}),
+    });
+
+    expect(result.dataType).toEqual(FormulaDataTypes.STRING);
+  });
+  it('Complex formula', async () => {
+    const result = await validateFormulaAndExtractTreeWithType({
+      formula:
+        'SWITCH({column2},"value1",IF({column1}, "Found", BLANK()),"value2", 2)',
+      columns: [
+        {
+          id: 'id1',
+          title: 'column1',
+          uidt: UITypes.Number,
+        },
+        {
+          id: 'id2',
+          title: 'column2',
+          uidt: UITypes.SingleLineText,
+        },
+      ],
+      clientOrSqlUi: 'mysql2',
+      getMeta: async () => ({}),
+    });
+
+    expect(result.dataType).toEqual(FormulaDataTypes.STRING);
+
+    const result1 = await validateFormulaAndExtractTreeWithType({
+      formula: 'SWITCH({column2},"value1",IF({column1}, 1, 2),"value2", 2)',
+      columns: [
+        {
+          id: 'id1',
+          title: 'column1',
+          uidt: UITypes.Number,
+        },
+        {
+          id: 'id2',
+          title: 'column2',
+          uidt: UITypes.SingleLineText,
+        },
+      ],
+      clientOrSqlUi: 'mysql2',
+      getMeta: async () => ({}),
+    });
+
+    expect(result1.dataType).toEqual(FormulaDataTypes.NUMERIC);
+  });
+});