add support for proper error messages (#129)

* add support for proper error messages

* exported ErrorMessageHandlerReturnType

Author: Joshua-onwuzu

index.ts

@@ -2,3 +2,4 @@ export { default as DsheetEditor } from './package/dsheet-editor';
 export { formulaResponseUiSync } from './package/utils/formula-ui-sync';
 export { executeStringFunction } from './package/utils/executeStringFunction';
 export { FLVURL } from '@fileverse-dev/formulajs';
+export type { ErrorMessageHandlerReturnType } from './package/types';

package-lock.json

@@ -2,7 +2,7 @@
   "name": "@fileverse-dev/dsheet",
   "private": false,
   "description": "DSheet",
-  "version": "1.0.42",
+  "version": "1.0.43",
   "main": "dist/index.es.js",
   "module": "dist/index.es.js",
   "exports": {
@@ -34,10 +34,10 @@
   },
   "dependencies": {
     "@fileverse-dev/dsheets-templates": "^0.0.17",
-    "@fileverse-dev/formula-parser": "^0.2.19",
-    "@fileverse-dev/formulajs": "^4.4.11-mod-64",
-    "@fileverse-dev/fortune-core": "^1.0.23",
-    "@fileverse-dev/fortune-react": "^1.0.23",
+    "@fileverse-dev/formula-parser": "^0.2.21",
+    "@fileverse-dev/formulajs": "^4.4.11-mod-67",
+    "@fileverse-dev/fortune-core": "^1.0.25",
+    "@fileverse-dev/fortune-react": "^1.0.25",
     "@fileverse/ui": "^4.1.7-patch-18",
     "classnames": "^2.5.1",
     "exceljs": "^4.4.0",

package.json

@@ -61,7 +61,7 @@ export const EditorWorkbook: React.FC<EditorWorkbookProps> = ({
   exportDropdownOpen = false,
   commentData,
   getCommentCellUI,
-  setExportDropdownOpen = () => { },
+  setExportDropdownOpen = () => {},
   dsheetId,
   storeApiKey,
   onDataBlockApiResponse,
@@ -146,30 +146,29 @@ export const EditorWorkbook: React.FC<EditorWorkbookProps> = ({
         customToolbarItems={
           !isReadOnly
             ? getCustomToolbarItems({
-              setExportDropdownOpen,
-              handleCSVUpload,
-              handleXLSXUpload,
-              handleExportToXLSX,
-              handleExportToCSV,
-              handleExportToJSON,
-              sheetEditorRef,
-              ydocRef,
-              dsheetId,
-              currentDataRef,
-              setForceSheetRender,
-              toggleTemplateSidebar,
-              setShowFetchURLModal,
-            })
+                setExportDropdownOpen,
+                handleCSVUpload,
+                handleXLSXUpload,
+                handleExportToXLSX,
+                handleExportToCSV,
+                handleExportToJSON,
+                sheetEditorRef,
+                ydocRef,
+                dsheetId,
+                currentDataRef,
+                setForceSheetRender,
+                toggleTemplateSidebar,
+                setShowFetchURLModal,
+              })
             : []
         }
         hooks={{
           afterUpdateCell: (
             row: number,
             column: number,
-            oldValue: Cell,
+            _oldValue: Cell,
             newValue: Cell,
           ): void => {
-            console.log('afterUpdateCell Old value', oldValue);
             const refObj = { current: sheetEditorRef.current };
             afterUpdateCell({
               row,

package/components/editor-workbook.tsx

@@ -3,6 +3,8 @@ import { RefObject } from 'react';
 import { WorkbookInstance } from '@fileverse-dev/fortune-react';
 import * as Y from 'yjs';
 import { Cell } from '@fileverse-dev/fortune-core';
+// @ts-ignore
+import { ERROR_MESSAGES_FLAG } from '@fileverse-dev/formulajs/crypto-constants';
 
 export interface SheetUpdateData {
   data: Sheet[];
@@ -23,7 +25,7 @@ export type OnboardingHandlerType = (params: {
 
 // Define the data block API key handler type
 export type DataBlockApiKeyHandlerType = (params: {
-  data: string;
+  data: ErrorMessageHandlerReturnType;
   sheetEditorRef: React.RefObject<WorkbookInstance | null>;
   executeStringFunction: (functionCallString: string) => Promise<unknown>;
   row: number;
@@ -69,3 +71,29 @@ export interface DsheetProps {
   onDuneChartEmbed?: () => void;
   onSheetCountChange?: (sheetCount: number) => void;
 }
+type BaseError = {
+  message: string;
+  functionName?: string;
+  type: string;
+};
+
+type CustomError = BaseError & {
+  type: typeof ERROR_MESSAGES_FLAG.CUSTOM;
+  reason: string;
+};
+
+export type NetworkError = BaseError & {
+  type:
+    | typeof ERROR_MESSAGES_FLAG.NETWORK_ERROR
+    | typeof ERROR_MESSAGES_FLAG.RATE_LIMIT;
+};
+
+export type DefaultError = BaseError & {
+  reason: string;
+};
+
+export type ErrorMessageHandlerReturnType =
+  | BaseError
+  | CustomError
+  | NetworkError
+  | DefaultError;

package/types.ts

@@ -1,7 +1,11 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 import { Cell } from '@fileverse-dev/fortune-core';
 import { WorkbookInstance } from '@fileverse-dev/fortune-react';
-import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
+import {
+  OnboardingHandlerType,
+  DataBlockApiKeyHandlerType,
+  ErrorMessageHandlerReturnType,
+} from '../types';
 import { formulaResponseUiSync } from './formula-ui-sync';
 import {
   executeStringFunction,
@@ -236,7 +240,7 @@ const processFlvurlPromise = async (
 };
 
 const handleDatablockErroMessage = (
-  data: string,
+  data: ErrorMessageHandlerReturnType,
   dataBlockApiKeyHandler: DataBlockApiKeyHandlerType,
   params: Pick<
     AfterUpdateCellParams,
@@ -254,11 +258,18 @@ const handleDatablockErroMessage = (
   });
 };
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isDatablockError = (value: any) => {
+  const isObject =
+    value !== null && typeof value === 'object' && !Array.isArray(value);
+  return isObject && containsErrorFlag(value.type);
+};
+
 /**
  * Processes promise resolution for regular formulas
  */
 const processRegularPromise = async (
-  promise: Promise<Record<string, string>[] | string>,
+  promise: Promise<unknown[] | ErrorMessageHandlerReturnType | string>,
   params: Pick<
     AfterUpdateCellParams,
     | 'row'
@@ -272,18 +283,21 @@ const processRegularPromise = async (
 ): Promise<void> => {
   try {
     const data = await promise;
-    if (
-      typeof data === 'string' &&
-      containsErrorFlag(data) &&
-      params.dataBlockApiKeyHandler
-    ) {
-      handleStringResponse(data as string, params);
-      handleDatablockErroMessage(data, params.dataBlockApiKeyHandler, params);
+    const formulaName = params.newValue?.f
+      ?.match(/^=([A-Za-z0-9_]+)\s*\(/)?.[1]
+      ?.toUpperCase();
+    if (isDatablockError(data)) {
+      if (!params.dataBlockApiKeyHandler) {
+        throw new Error('dataBlockApiKeyHandler missing');
+      }
+      const _data = data as ErrorMessageHandlerReturnType;
+      handleDatablockErroMessage(_data, params.dataBlockApiKeyHandler, params);
       return;
     }
 
     if (Array.isArray(data)) {
-      if (!data.length) {
+      const firstItem = (data as any[])?.[0];
+      if (!data.length || Object.keys(firstItem).length === 0) {
         params.sheetEditorRef.current?.setCellValue(params.row, params.column, {
           ...params.newValue,
           m: 'No Data',
@@ -295,16 +309,33 @@ const processRegularPromise = async (
     } else {
       handleStringResponse(data as string, params);
     }
+    params.onDataBlockApiResponse?.(formulaName as string);
     const workbookContext = params.sheetEditorRef.current?.getWorkbookContext();
-    const formulaName = params.newValue?.f
-      ?.match(/^=([A-Za-z0-9_]+)\s*\(/)?.[1]
-      ?.toUpperCase();
     const apiKeyName =
       workbookContext?.formulaCache.functionlistMap[formulaName || '']?.API_KEY;
     params.storeApiKey?.(apiKeyName);
-  } catch (error) {
-    console.error('Error processing regular promise:', error);
-    handleStringResponse('Error processing data', params);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  } catch (error: any) {
+    if (
+      error === 'dataBlockApiKeyHandler missing' ||
+      error?.message === 'dataBlockApiKeyHandler missing'
+    ) {
+      throw new Error('dataBlockApiKeyHandler missing');
+    } else {
+      const formulaName = params.newValue?.f
+        ?.match(/^=([A-Za-z0-9_]+)\s*\(/)?.[1]
+        ?.toUpperCase();
+      handleDatablockErroMessage(
+        {
+          type: 'DSHEET_ERROR',
+          message: 'Unexpected Error',
+          functionName: formulaName,
+          reason: error?.message,
+        },
+        params.dataBlockApiKeyHandler!,
+        params,
+      );
+    }
   }
 };
 
@@ -433,8 +464,6 @@ export const afterUpdateCell = async (
 
     // register dataBlockCalcFunction cell
     updateDataCalcFunc({ params: updatedParams, currentSheetId });
-
-    params.onDataBlockApiResponse?.(formulaName as string);
   }
 
   const dataBlockCalcFunction = params?.dataBlockCalcFunction;
@@ -521,10 +550,16 @@ const updateDataCalcFunc = ({
       };
     });
   } catch (error: any) {
-    console.log({ error });
+    const formulaName = params.newValue.f
+      ?.match(/^=([A-Za-z0-9_]+)\s*\(/)?.[1]
+      ?.toUpperCase();
     // send error message to dsheet.new to commit to sentry
     params?.dataBlockApiKeyHandler?.({
-      data: `ERROR from updateDataCalcFunc ${error?.message}`,
+      data: {
+        message: `ERROR from updateDataCalcFunc ${error?.message}`,
+        type: 'Unexpected error',
+        functionName: formulaName,
+      },
       sheetEditorRef: params.sheetEditorRef,
       executeStringFunction,
       row: params.row,