Merge branch 'next' of https://github.com/devforth/adminforth into fix-mongo-id-filter

Author: NoOne7135

AGENTS.md

@@ -0,0 +1,5 @@
+Follow SOLID principles
+Use DRY and avoid duplication
+Keep the code KISS unless complexity is required
+Avoid unnecessary abstractions.
+Cover edge cases and clear error handling

README.md

@@ -61,44 +61,50 @@ npx adminforth create-app
 
 The most convenient way to add new features or fixes is using `dev-demo`. It imports the source code of the repository and plugins so you can edit them and see changes on the fly.
 
-Fork repo, pull it and do next:
+To run dev demo:
+```sh
+cd dev-demo
 
+npm run setup-dev-demo
+npm run migrate:all
 
-```sh
-cd adminforth
-npm ci
-npm run build
+npm start
 ```
 
-To run dev demo:
-```sh
-cd dev-demo
-cp .env.sample .env
+## Adding columns to a database in dev-demo
 
-# this will install all official plugins and link adminforth package, if plugin installed it will git pull and npm ci
-npm run install-plugins
+Open `./migrations` folder. There is prisma migration folder for the sqlite, postgres and mysql and `clickhouse_migrations` folder for the clickhouse:
 
-# same for official adapters
-npm run install-adapters
+### Migrations for the MySQL, SQLite and Postgres
+To make migration add to the .prisma file in folder with database you need and add new tables or columns. Then run:
 
-npm ci
 
-./run_inventory.sh
+```
+npm run makemigration:sqlite -- --name init
+```
+
+and 
 
-npm run migrate:local
-npm start
+```
+npm run migrate:sqlite
 ```
 
-## Adding columns to a database in dev-demo
+to apply migration
+
+> use :sqlite, :mysql or :postgres for you case
+
+### Migrations for the clickhouse
 
-Open `.prisma` file, modify it, and run:
+In order to make migration for the clickhouse, go to the `./migrations/clickhouse_migrations` folder and add migration file to the folder.
 
+Then run
 ```
-npm run namemigration -- --name desctiption_of_changes
+npm run migrate:clickhouse
 ```
 
+to apply the migration.
 
-### Testing CLI commands during development
+## Testing CLI commands during development
 
 
 Make sure you have not `adminforth` globally installed. If you have it, remove it:

adminforth/auth.ts

@@ -65,9 +65,8 @@ class AdminForthAuth implements IAdminForthAuth {
        headersLower['client-ip'] || 
        headersLower['client-address'] || 
        headersLower['client'] || 
-       headersLower['x-host'] || 
-       headersLower['host'] || 
-       'unknown';
+       headersLower['x-host'] ||
+       null;
     }
   }
 

adminforth/basePlugin.ts

@@ -36,7 +36,7 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
     return 'non-uniquely-identified';
   }
 
-  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource, allPluginInstances?: {pi: AdminForthPlugin, resource: AdminForthResource}[]) {
     this.resourceConfig = resourceConfig;
     const uniqueness = this.instanceUniqueRepresentation(this.pluginOptions);
 

adminforth/dataConnectors/baseConnector.ts

@@ -9,6 +9,7 @@ import {
 import { suggestIfTypo } from "../modules/utils.js";
 import { AdminForthDataTypes, AdminForthFilterOperators, AdminForthSortDirections } from "../types/Common.js";
 import { randomUUID } from "crypto";
+import dayjs from "dayjs";
 
 
 export default class AdminForthBaseConnector implements IAdminForthDataSourceConnectorBase {
@@ -171,9 +172,9 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
             return { ok: false, error: `Value for operator '${filters.operator}' should not be empty array, in filter object: ${JSON.stringify(filters) }` };
           }
         }
-        filters.value = filters.value.map((val: any) => this.setFieldValue(fieldObj, val));
+        filters.value = filters.value.map((val: any) => this.validateAndSetFieldValue(fieldObj, val));
       } else {
-        filtersAsSingle.value = this.setFieldValue(fieldObj, filtersAsSingle.value);
+        filtersAsSingle.value = this.validateAndSetFieldValue(fieldObj, filtersAsSingle.value);
       }
     } else if (filtersAsSingle.insecureRawSQL || filtersAsSingle.insecureRawNoSQL) {
       // if "insecureRawSQL" filter is insecure sql string
@@ -226,6 +227,90 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
     throw new Error('Method not implemented.');
   }
 
+  validateAndSetFieldValue(field: AdminForthResourceColumn, value: any): any {
+    // Int
+    if (field.type === AdminForthDataTypes.INTEGER) {
+      if (value === "" || value === null) {
+        return this.setFieldValue(field, null);
+      }
+      if (!Number.isFinite(value)) {
+        throw new Error(`Value is not an integer. Field ${field.name} with type is ${field.type}, but got value: ${value} with type ${typeof value}`);
+      }
+      return this.setFieldValue(field, value);
+    }
+
+    // Float
+    if (field.type === AdminForthDataTypes.FLOAT) {
+      if (value === "" || value === null) {
+        return this.setFieldValue(field, null);
+      }
+
+      if (typeof value !== "number" || !Number.isFinite(value)) {
+        throw new Error(
+          `Value is not a float. Field ${field.name} with type is ${field.type}, but got value: ${String(value)} with type ${typeof value}`
+        );
+      }
+
+      return this.setFieldValue(field, value);
+    }
+
+    // Decimal
+    if (field.type === AdminForthDataTypes.DECIMAL) {
+      if (value === "" || value === null) {
+        return this.setFieldValue(field, null);
+      }
+      if (typeof value === "string") {
+        const string = value.trim();
+        if (!string) {
+          return this.setFieldValue(field, null);
+        }
+        if (Number.isFinite(Number(string))) {
+          return this.setFieldValue(field, string);
+        }
+        throw new Error(`Value is not a decimal. Field ${field.name} with type is ${field.type}, but got value: ${value} with type ${typeof value}`);
+      }
+
+      throw new Error(`Value is not a decimal. Field ${field.name} with type is ${field.type}, but got value: ${String(value)} with type ${typeof value}`);
+    }
+
+    // Date
+
+
+    // DateTime
+    if (field.type === AdminForthDataTypes.DATETIME) {
+      if (value === "" || value === null) {
+        return this.setFieldValue(field, null);
+      }
+      if (!dayjs(value).isValid()) {
+        throw new Error(`Value is not a valid datetime. Field ${field.name} with type is ${field.type}, but got value: ${value} with type ${typeof value}`);
+      }
+      return this.setFieldValue(field, value);
+    }
+
+    // Time
+
+    // Boolean
+    if (field.type === AdminForthDataTypes.BOOLEAN) {
+      if (value === "" || value === null) {
+        return this.setFieldValue(field, null);
+      }
+      if (typeof value !== 'boolean') {
+        throw new Error(`Value is not a boolean. Field ${field.name} with type is ${field.type}, but got value: ${value} with type ${typeof value}`);
+      }
+      return this.setFieldValue(field, value);
+    }
+    
+    // JSON
+
+    // String
+    if (field.type === AdminForthDataTypes.STRING) {
+      if (value === "" || value === null){
+        return this.setFieldValue(field, null);
+      }
+    }
+    return this.setFieldValue(field, value);
+  }
+
   getMinMaxForColumnsWithOriginalTypes({ resource, columns }: { resource: AdminForthResource; columns: AdminForthResourceColumn[]; }): Promise<{ [key: string]: { min: any; max: any; }; }> {
     throw new Error('Method not implemented.');
   }
@@ -275,7 +360,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
       }
       if (filledRecord[col.name] !== undefined) {
         // no sense to set value if it is not defined
-        recordWithOriginalValues[col.name] = this.setFieldValue(col, filledRecord[col.name]);
+        recordWithOriginalValues[col.name] = this.validateAndSetFieldValue(col, filledRecord[col.name]);
       }
     }
 
@@ -332,7 +417,7 @@ export default class AdminForthBaseConnector implements IAdminForthDataSourceCon
           Update record received field '${field}' (with value ${newValues[field]}), but such column not found in resource '${resource.resourceId}'. ${similar ? `Did you mean '${similar}'?` : ''}
         `);
       }
-      recordWithOriginalValues[col.name] = this.setFieldValue(col, newValues[col.name]);
+      recordWithOriginalValues[col.name] = this.validateAndSetFieldValue(col, newValues[col.name]);
     }
     const record = await this.getRecordByPrimaryKey(resource, recordId);
     let error: string | null = null;