From 36b2e203b566134d32e80964ece21cfd161b7297 Mon Sep 17 00:00:00 2001
From: Pranav C <pranavxc@gmail.com>
Date: Fri, 17 May 2024 20:40:59 +0000
Subject: [PATCH] refactor: show unsupported formula functions as disabled

---
 .../smartsheet/column/FormulaOptions.vue      | 66 +++++++++++--------
 packages/nc-gui/lang/en.json                  |  1 +
 packages/nocodb-sdk/src/lib/formulaHelpers.ts | 11 ++--
 3 files changed, 48 insertions(+), 30 deletions(-)

diff --git a/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue b/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue
index dd541072a5..5a6e1db3da 100644
--- a/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue
+++ b/packages/nc-gui/components/smartsheet/column/FormulaOptions.vue
@@ -102,36 +102,47 @@ const sortOrder: Record<string, number> = {
 
 const suggestionsList = computed(() => {
   const unsupportedFnList = sqlUi.value.getUnsupportedFnList()
-  return [
-    ...availableFunctions
-      .filter((fn: string) => !unsupportedFnList.includes(fn))
-      .map((fn: string) => ({
+  return (
+    [
+      ...availableFunctions.map((fn: string) => ({
         text: `${fn}()`,
         type: 'function',
         description: formulas[fn].description,
         syntax: formulas[fn].syntax,
         examples: formulas[fn].examples,
         docsUrl: formulas[fn].docsUrl,
+        unsupported: unsupportedFnList.includes(fn),
       })),
-    ...supportedColumns.value
-      .filter((c) => {
-        // skip system LTAR columns
-        if (c.uidt === UITypes.LinkToAnotherRecord && c.system) return false
-        // v1 logic? skip the current column
-        if (!column) return true
-        return column.value?.id !== c.id
-      })
-      .map((c: any) => ({
-        text: c.title,
-        type: 'column',
-        icon: getUIDTIcon(c.uidt),
-        uidt: c.uidt,
+      ...supportedColumns.value
+        .filter((c) => {
+          // skip system LTAR columns
+          if (c.uidt === UITypes.LinkToAnotherRecord && c.system) return false
+          // v1 logic? skip the current column
+          if (!column) return true
+          return column.value?.id !== c.id
+        })
+        .map((c: any) => ({
+          text: c.title,
+          type: 'column',
+          icon: getUIDTIcon(c.uidt),
+          uidt: c.uidt,
+        })),
+      ...availableBinOps.map((op: string) => ({
+        text: op,
+        type: 'op',
       })),
-    ...availableBinOps.map((op: string) => ({
-      text: op,
-      type: 'op',
-    })),
-  ]
+    ]
+      // move unsupported functions to the end
+      .sort((a: Record<string, any>, b: Record<string, any>) => {
+        if (a.unsupported && !b.unsupported) {
+          return 1
+        }
+        if (!a.unsupported && b.unsupported) {
+          return -1
+        }
+        return 0
+      })
+  )
 })
 
 // set default suggestion list
@@ -214,6 +225,7 @@ function handleInput() {
 function selectText() {
   if (suggestion.value && selected.value > -1 && selected.value < suggestionsList.value.length) {
     if (selected.value < suggestedFormulas.value.length) {
+      if (suggestedFormulas.value[selected.value].unsupported) return
       appendText(suggestedFormulas.value[selected.value])
     } else {
       appendText(variableList.value[selected.value + suggestedFormulas.value.length])
@@ -276,7 +288,7 @@ onMounted(() => {
 <template>
   <div class="formula-wrapper relative">
     <div
-      v-if="suggestionPreviewed && suggestionPreviewed.type === 'function'"
+      v-if="suggestionPreviewed && !suggestionPreviewed.unsupported && suggestionPreviewed.type === 'function'"
       class="absolute -left-91 w-84 top-0 bg-white z-10 pl-3 pt-3 border-1 shadow-md rounded-xl"
     >
       <div class="pr-3">
@@ -357,20 +369,22 @@ onMounted(() => {
               class="cursor-pointer !overflow-hidden hover:bg-gray-50"
               :class="{
                 '!bg-gray-100': selected === index,
+                'cursor-not-allowed': item.unsupported,
               }"
-              @click.prevent.stop="appendText(item)"
+              @click.prevent.stop="!item.unsupported && appendText(item)"
               @mouseenter="suggestionPreviewed = item"
             >
               <a-list-item-meta>
                 <template #title>
-                  <div class="flex items-center gap-x-1">
+                  <div class="flex items-center gap-x-1" :class="{ 'text-gray-400': item.unsupported }">
                     <component :is="iconMap.function" v-if="item.type === 'function'" class="text-lg" />
 
                     <component :is="iconMap.calculator" v-if="item.type === 'op'" class="text-lg" />
 
                     <component :is="item.icon" v-if="item.type === 'column'" class="text-lg" />
-                    <span class="prose-sm text-gray-600">{{ item.text }}</span>
+                    <span class="prose-sm" :class="{ 'text-gray-600': !item.unsupported }">{{ item.text }}</span>
                   </div>
+                  <div v-if="item.unsupported" class="ml-5 text-gray-400 text-xs">{{ $t('msg.formulaNotSupported') }}</div>
                 </template>
               </a-list-item-meta>
             </a-list-item>
diff --git a/packages/nc-gui/lang/en.json b/packages/nc-gui/lang/en.json
index 670dc102e9..1efe8c3544 100644
--- a/packages/nc-gui/lang/en.json
+++ b/packages/nc-gui/lang/en.json
@@ -1101,6 +1101,7 @@
     "searchOptions": "Search options"
   },
   "msg": {
+    "formulaNotSupported": "This function is unavailable for your database",
     "controlOrgAppearance": "Control your organisations name and appearance.",
     "addCompanyDomains": "Add company domains to restrict access to unwanted users.",
     "restrictUsersFromSharing": "Restrict users from being able to share bases publicly.",
diff --git a/packages/nocodb-sdk/src/lib/formulaHelpers.ts b/packages/nocodb-sdk/src/lib/formulaHelpers.ts
index b250531a06..d081a90869 100644
--- a/packages/nocodb-sdk/src/lib/formulaHelpers.ts
+++ b/packages/nocodb-sdk/src/lib/formulaHelpers.ts
@@ -1631,15 +1631,18 @@ export async function validateFormulaAndExtractTreeWithType({
     if (parsedTree.type === JSEPNode.CALL_EXP) {
       const calleeName = parsedTree.callee.name.toUpperCase();
       // validate function name
-      if (
-        !formulas[calleeName] ||
-        sqlUI?.getUnsupportedFnList().includes(calleeName)
-      ) {
+      if (!formulas[calleeName]) {
         throw new FormulaError(
           FormulaErrorType.INVALID_FUNCTION_NAME,
           {},
           `Function ${calleeName} is not available`
         );
+      } else if (sqlUI?.getUnsupportedFnList().includes(calleeName)) {
+        throw new FormulaError(
+          FormulaErrorType.INVALID_FUNCTION_NAME,
+          {},
+          `Function ${calleeName} is unavailable for your database`
+        );
       }
 
       // validate arguments