feat: add attr check for datagrid columns

Author: iobuhov

packages/pluggableWidgets/datagrid-web/src/helpers/state/column/ColumnFilterStore.tsx

@@ -1,7 +1,8 @@
 import { FilterData } from "@mendix/filter-commons/typings/settings";
 import { EnumFilterStore } from "@mendix/widget-plugin-dropdown-filter/stores/EnumFilterStore";
 import { FilterAPI, getGlobalFilterContextObject } from "@mendix/widget-plugin-filtering/context";
-import { value } from "@mendix/widget-plugin-filtering/result-meta";
+import { APIError } from "@mendix/widget-plugin-filtering/errors";
+import { error, value } from "@mendix/widget-plugin-filtering/result-meta";
 import { InputFilterStore, attrgroupFilterStore } from "@mendix/widget-plugin-filtering/stores/input/store-utils";
 import { ObservableFilterHost } from "@mendix/widget-plugin-filtering/typings/ObservableFilterHost";
 import { disposeBatch } from "@mendix/widget-plugin-mobx-kit/disposeBatch";
@@ -22,14 +23,24 @@ const { Provider } = getGlobalFilterContextObject();
 
 export class ColumnFilterStore implements IColumnFilterStore {
     private _widget: ReactNode;
+    private _error: APIError | null;
     private _filterStore: FilterStore | null = null;
     private _context: FilterAPI;
     private _observerBag: ObserverBag;
 
     constructor(props: ColumnsType, info: StaticInfo, dsViewState: FilterCondition | null, observerBag: ObserverBag) {
         this._observerBag = observerBag;
         this._widget = props.filter;
-        this._filterStore = this.createFilterStore(props, dsViewState);
+        const storeResult = this.createFilterStore(props, dsViewState);
+        if (storeResult === null) {
+            this._error = this._filterStore = null;
+        } else if (storeResult.hasError) {
+            this._error = storeResult.error;
+            this._filterStore = null;
+        } else {
+            this._error = null;
+            this._filterStore = storeResult.value;
+        }
         this._context = this.createContext(this._filterStore, info);
 
         makeObservable<this>(this, {
@@ -45,9 +56,12 @@ export class ColumnFilterStore implements IColumnFilterStore {
         return disposeAll;
     }
 
-    private createFilterStore(props: ColumnsType, dsViewState: FilterCondition | null): FilterStore | null {
+    private createFilterStore(
+        props: ColumnsType,
+        dsViewState: FilterCondition | null
+    ): ReturnType<typeof attrgroupFilterStore> | null {
         if (isListAttributeValue(props.attribute)) {
-            return attrgroupFilterStore(props.attribute.type, [props.attribute], dsViewState);
+            return attrgroupFilterStore(props.attribute.type, props.attribute, dsViewState);
         }
 
         return null;
@@ -57,10 +71,12 @@ export class ColumnFilterStore implements IColumnFilterStore {
         return {
             version: 3,
             parentChannelName: info.filtersChannelName,
-            provider: value({
-                type: "direct",
-                store
-            }),
+            provider: this._error
+                ? error(this._error)
+                : value({
+                      type: "direct",
+                      store
+                  }),
             filterObserver: this._observerBag.customFilterHost,
             sharedInitFilter: this._observerBag.sharedInitFilter
         };

packages/shared/widget-plugin-filtering/src/errors.ts

@@ -3,7 +3,9 @@ enum Code {
     ENOCONTEXT = 1,
     ESTORETYPE = 3,
     EKEYMISSING = 7,
-    OPTIONS_NOT_FILTERABLE = 8
+    OPTIONS_NOT_FILTERABLE = 8,
+    NOT_FILTERABLE = 9,
+    UNSUPPORTED_ATTRIBUTE_TYPE = 10
 }
 
 export { Code as APIErrorCode };
@@ -41,3 +43,13 @@ export const OPTIONS_NOT_FILTERABLE: APIError = Object.freeze({
     message:
         "Drop-down options can't be filtered with current column configuration. To enable filtering, change 'Option caption type'  to 'Attribute' in column settings."
 });
+
+export const NOT_FILTERABLE: APIError = Object.freeze({
+    code: Code.NOT_FILTERABLE,
+    message: "The attribute is not filterable. Please choose a different attribute."
+});
+
+export const UNSUPPORTED_ATTRIBUTE_TYPE: APIError = Object.freeze({
+    code: Code.UNSUPPORTED_ATTRIBUTE_TYPE,
+    message: "Unsupported attribute type for filtering. Please choose a different attribute."
+});

packages/shared/widget-plugin-filtering/src/stores/input/store-utils.ts

@@ -1,6 +1,8 @@
 import { EnumFilterStore } from "@mendix/widget-plugin-dropdown-filter/stores/EnumFilterStore";
 import { ListAttributeValue } from "mendix";
 import { FilterCondition } from "mendix/filters";
+import { APIError, NOT_FILTERABLE, UNSUPPORTED_ATTRIBUTE_TYPE } from "../../errors";
+import { error, Result, value } from "../../result-meta";
 import {
     Date_InputFilterInterface,
     InputFilterInterface,
@@ -15,29 +17,31 @@ export type InputFilterStore = StringInputFilterStore | NumberInputFilterStore |
 
 export function attrgroupFilterStore(
     type: ListAttributeValue["type"],
-    attributes: ListAttributeValue[],
+    attribute: ListAttributeValue,
     initCond: FilterCondition | null
-): InputFilterStore | EnumFilterStore | null {
+): Result<InputFilterStore | EnumFilterStore, APIError> {
+    if (!attribute.filterable) {
+        return error(NOT_FILTERABLE);
+    }
     switch (type) {
         case "DateTime":
-            return new DateInputFilterStore(attributes as Array<ListAttributeValue<Date>>, initCond);
+            return value(new DateInputFilterStore([attribute] as Array<ListAttributeValue<Date>>, initCond));
 
         case "AutoNumber":
         case "Decimal":
         case "Integer":
         case "Long":
-            return new NumberInputFilterStore(attributes as Array<ListAttributeValue<Big>>, initCond);
+            return value(new NumberInputFilterStore([attribute] as Array<ListAttributeValue<Big>>, initCond));
 
         case "String":
         case "HashString":
-            return new StringInputFilterStore(attributes as Array<ListAttributeValue<string>>, initCond);
+            return value(new StringInputFilterStore([attribute] as Array<ListAttributeValue<string>>, initCond));
 
         case "Boolean":
         case "Enum":
-            return new EnumFilterStore(attributes, initCond);
+            return value(new EnumFilterStore([attribute], initCond));
         default:
-            console.error("attrgroupFilterStore: not supported type " + type, attributes);
-            return null;
+            return error(UNSUPPORTED_ATTRIBUTE_TYPE);
     }
 }