Merge branch 'main' of github.com:devforth/adminforth

AdminForth/1902/image

AdminForth/1902/image

Author: yaroslav8765

adminforth/commands/createApp/templates/adminuser.ts.hbs

@@ -36,6 +36,7 @@ export default {
       required: true,
       isUnique: true,
       type: AdminForthDataTypes.STRING,
+      normalize: (value: string) => value.trim().toLowerCase(),
       validation: [
         // you can also use AdminForth.Utils.EMAIL_VALIDATOR which is alias to this object
         {
@@ -108,4 +109,4 @@ export default {
       },
     },
   },
-} as AdminForthResourceInput;
+} as AdminForthResourceInput;

adminforth/index.ts

@@ -39,6 +39,7 @@ import AdminForthRestAPI, { interpretResource, rejectApiRawFilters } from './mod
 import OperationalResource from './modules/operationalResource.js';
 import SocketBroker from './modules/socketBroker.js';
 import { afLogger } from './modules/logger.js';
+import { normalizeRecordValues } from './modules/columnValueNormalizer.js';
 export { afLogger } from './modules/logger.js';
 export { dbLogger } from './modules/logger.js';
 export { logger } from './modules/logger.js';
@@ -726,6 +727,8 @@ class AdminForth implements IAdminForth {
   ): Promise<CreateResourceRecordResult> {
     const { resource, record, adminUser, extra, response } = params;
 
+    normalizeRecordValues(resource, record);
+
     const err = this.validateRecordValues(resource, record, 'create');
     if (err) {
       return { error: err };
@@ -816,6 +819,7 @@ class AdminForth implements IAdminForth {
   ): Promise<UpdateResourceRecordResult> {
     const { resource, recordId, record, oldRecord, adminUser, response, extra, updates } = params;
     const dataToUse = updates || record;
+    normalizeRecordValues(resource, dataToUse);
     const err = this.validateRecordValues(resource, dataToUse, 'edit');
     if (err) {
       return { error: err };

adminforth/modules/columnValueNormalizer.ts

@@ -0,0 +1,13 @@
+import type { AdminForthResource, AdminForthResourceColumn } from '../types/Back.js';
+
+export function normalizeColumnValue(column: AdminForthResourceColumn, value: any): any {
+  return column.normalize ? column.normalize(value) : value;
+}
+
+export function normalizeRecordValues(resource: AdminForthResource, record: Record<string, any>): void {
+  for (const column of resource.columns) {
+    if (column.name in record) {
+      record[column.name] = normalizeColumnValue(column, record[column.name]);
+    }
+  }
+}

adminforth/modules/operationalResource.ts

@@ -1,5 +1,6 @@
 import { IAdminForthSingleFilter, IAdminForthAndOrFilter, IAdminForthSort, IOperationalResource, IAdminForthDataSourceConnectorBase, AdminForthResource, IAggregationRule, IGroupByRule } from '../types/Back.js';
 import { AdminForthFilterOperators } from '../types/Common.js';
+import { normalizeRecordValues } from './columnValueNormalizer.js';
 
 function sortsIfSort(sort: IAdminForthSort | IAdminForthSort[]): IAdminForthSort[] {
   return (Array.isArray(sort) ? sort : [sort]) as IAdminForthSort[];
@@ -82,9 +83,11 @@ export default class OperationalResource implements IOperationalResource {
   }
 
   async create(recordValues: any): Promise<{ ok: boolean; createdRecord: any; error?: string; }> {
+    const normalizedRecord = { ...recordValues };
+    normalizeRecordValues(this.resourceConfig, normalizedRecord);
     const { ok, createdRecord, error } = await this.dataConnector.createRecord({ 
       resource: this.resourceConfig, 
-      record: recordValues, 
+      record: normalizedRecord,
       adminUser: null 
     });
     return { ok, createdRecord, error };
@@ -95,15 +98,18 @@ export default class OperationalResource implements IOperationalResource {
       return { ok: true };
     }
 
+    const normalizedRecord = { ...record };
+    normalizeRecordValues(this.resourceConfig, normalizedRecord);
+
     return await this.dataConnector.updateRecord({ 
       resource: this.resourceConfig,
       recordId: primaryKey,
-      newValues: record
+      newValues: normalizedRecord
     });
   }
 
   async delete(primaryKey: any): Promise<boolean> {
     return await this.dataConnector.deleteRecord({ resource: this.resourceConfig, recordId: primaryKey });
   }
 
-}
+}

adminforth/modules/restApi.ts

@@ -31,7 +31,7 @@ import { ActionCheckSource, AdminForthActionFront, AdminForthConfigMenuItem, Adm
    GetConfigResponse,
    ShowInResolved} from "../types/Common.js";
 import { filtersTools } from "../modules/filtersTools.js";
-import is_ip_private from 'private-ip'
+import { normalizeColumnValue } from './columnValueNormalizer.js';
 
 
 async function resolveBoolOrFn(
@@ -760,6 +760,8 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           throw new Error('No config.auth defined we need it to find user, please follow the docs');
         }
         const userResource = this.adminforth.config.resources.find((res) => res.resourceId === this.adminforth.config.auth.usersResourceId);
+        const usernameColumn = userResource.columns.find((col) => col.name === this.adminforth.config.auth.usernameField);
+        const normalizedUsername = normalizeColumnValue(usernameColumn, username);
         // if there is no passwordHashField, in columns, add it, with backendOnly and showIn: []
         if (!userResource.dataSourceColumns.find((col) => col.name === this.adminforth.config.auth.passwordHashField)) {
           userResource.dataSourceColumns.push({
@@ -775,7 +777,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           await this.adminforth.connectors[userResource.dataSource].getData({
             resource: userResource,
             filters: { operator: AdminForthFilterOperators.AND, subFilters: [
-              { field: this.adminforth.config.auth.usernameField, operator: AdminForthFilterOperators.EQ, value: username },
+              { field: this.adminforth.config.auth.usernameField, operator: AdminForthFilterOperators.EQ, value: normalizedUsername },
             ]},
             limit: 1,
             offset: 0,
@@ -795,7 +797,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
           adminUser = { 
             dbUser: userRecord,
             pk: userRecord[userResource.columns.find((col) => col.primaryKey).name], 
-            username,
+            username: normalizedUsername,
           };
 
           const expireInDuration = rememberMe 
@@ -811,7 +813,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
             this.adminforth.auth.setAuthCookie({ 
               expireInDuration,
               response, 
-              username, 
+              username: normalizedUsername,
               pk: userRecord[userResource.columns.find((col) => col.primaryKey).name] 
             });
           } 

adminforth/types/Common.ts

@@ -725,6 +725,16 @@ export interface AdminForthResourceColumnInputCommon {
    */
   name: string,
 
+  /**
+   * Normalizes a column value before it is saved or used as the username during login.
+   *
+   * @example
+   * ```ts
+   * normalize: (value: string) => value.trim().toLowerCase(),
+   * ```
+   */
+  normalize?: (value: any) => any,
+
   /**
    * How column can be labled in the admin panel.
    * Use it for renaming columns. Defaulted to column name with Uppercased first letter.

tests/application/resources/adminuser.ts

@@ -2,11 +2,14 @@ import usersResource from "../../../dev-demo/resources/adminuser.js";
 
 export default {
   ...usersResource,
+  columns: usersResource.columns.map((column) => column.name === 'email'
+    ? { ...column, normalize: (value: string) => value.trim().toLowerCase() }
+    : column),
   plugins: [
     ...usersResource.plugins?.filter((p) => ![
       'AdminForthAgentPlugin',
       'TwoFactorsAuthPlugin',
       'DashboardPlugin',
     ].includes(p.className)) || [],
   ],
-}
+}

tests/jest_tests/CRUD_sqlite.test.ts

@@ -7,6 +7,20 @@ afterAll(async () => {
   await closeApplication();
 });
 
+describe('POST /login', () => {
+  it('normalizes the username using the configured column normalizer', async () => {
+    const res = await agent
+      .post('/adminapi/v1/login')
+      .send({
+        username: '  ADMINFORTH  ',
+        password: 'adminforth',
+      });
+
+    expect(res.status).toEqual(200);
+    expect(res.body.error).toBeUndefined();
+  });
+});
+
 describe('POST /create_record', () => {
   const requestBody: any ={
     "resourceId": "cars_sl",
@@ -378,7 +392,7 @@ describe('POST /update_record', () => {
       body_type: "sedan",
     });
   });
-    
+
   it('should throw error, that resource is not found', async () => {
     const res = await agent
       .set('Cookie', authCookie)