Merge pull request #456 from devforth/next

Next

Author: yaroslav8765

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

@@ -58,44 +58,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:

adapters/install-adapters.sh

@@ -4,7 +4,7 @@ adminforth-email-adapter-mailgun adminforth-google-oauth-adapter adminforth-gith
 adminforth-facebook-oauth-adapter adminforth-keycloak-oauth-adapter adminforth-microsoft-oauth-adapter \
 adminforth-twitch-oauth-adapter adminforth-image-generation-adapter-openai adminforth-storage-adapter-amazon-s3 \
 adminforth-storage-adapter-local adminforth-image-vision-adapter-openai adminforth-key-value-adapter-ram \
-adminforth-login-captcha-adapter-cloudflare adminforth-login-captcha-adapter-recaptcha"
+adminforth-login-captcha-adapter-cloudflare adminforth-login-captcha-adapter-recaptcha adminforth-completion-adapter-google-gemini"
 
 # for each
 install_adapter() {

adminforth/auth.ts

@@ -3,6 +3,8 @@ import jwt from 'jsonwebtoken';
 import crypto from 'crypto';
 import AdminForth from './index.js';
 import { IAdminForthAuth } from './types/Back.js';
+import { afLogger } from './modules/logger.js';
+import is_ip_private from 'private-ip'
 
 // Function to generate a password hash using PBKDF2
 function calcPasswordHash(password, salt, iterations = 100000, keyLength = 64, digest = 'sha512') {
@@ -43,20 +45,22 @@ class AdminForthAuth implements IAdminForthAuth {
     this.adminforth = adminforth;
   }
 
-  getClientIp(headers: object) {
+getClientIp(headers: object) {
     const clientIpHeader = this.adminforth.config.auth.clientIpHeader;
 
     const headersLower = Object.keys(headers).reduce((acc, key) => {
       acc[key.toLowerCase()] = headers[key];
       return acc;
     }, {});
+
+    let ip: string | null = null;
     if (clientIpHeader) {
-      return headersLower[clientIpHeader.toLowerCase()] || 'unknown';
+      ip = headersLower[clientIpHeader.toLowerCase()];
     } else {
       // first try common headers which can't bee spoofed, in other words
       // most common to nginx/traefik/apache
       // then fallback to less secure headers
-      return headersLower['x-forwarded-for']?.split(',').shift().trim() ||
+      ip = headersLower['x-forwarded-for']?.split(',').shift().trim() ||
        headersLower['x-real-ip'] || 
        headersLower['x-client-ip'] || 
        headersLower['x-cluster-client-ip'] || 
@@ -65,10 +69,14 @@ class AdminForthAuth implements IAdminForthAuth {
        headersLower['client-ip'] || 
        headersLower['client-address'] || 
        headersLower['client'] || 
-       headersLower['x-host'] || 
-       headersLower['host'] || 
-       'unknown';
+       headersLower['x-host'] ||
+       null;
+    }
+    const isIpPrivate = is_ip_private(ip)
+    if (isIpPrivate) {
+      return null;
     }
+    return ip;
   }
 
   removeAuthCookie(response) {
@@ -98,15 +106,15 @@ class AdminForthAuth implements IAdminForthAuth {
   }
 
   setCustomCookie({ response, payload }: {
-    response: any, payload: { name: string, value: string, expiry: number | undefined, expirySeconds: number | undefined, httpOnly: boolean }
+    response: any, payload: { name: string, value: string, expiry?: number | undefined, expirySeconds: number | undefined, httpOnly: boolean }
   }) {
     const {name, value, expiry, httpOnly, expirySeconds } = payload;
 
     let expiryMs = 24 * 60 * 60 * 1000; // default 1 day
     if (expirySeconds !== undefined) {
       expiryMs = expirySeconds * 1000;
     } else if (expiry !== undefined) {
-      console.warn('setCustomCookie: expiry(in ms) is deprecated, use expirySeconds instead (seconds), traceback:', new Error().stack);
+      afLogger.warn(`setCustomCookie: expiry(in ms) is deprecated, use expirySeconds instead (seconds), traceback: ${new Error().stack}`);
       expiryMs = expiry;
     }
 
@@ -146,23 +154,23 @@ class AdminForthAuth implements IAdminForthAuth {
       decoded = jwt.verify(jwtToken, secret);
     } catch (err) {
       if (err.name === 'TokenExpiredError') {
-        console.error('Token expired:', err.message);
+        afLogger.error(`Token expired: ${err.message}`);
       } else  if (err.name === 'JsonWebTokenError') {
-        console.error('Token error:', err.message);
+        afLogger.error(`Token error: ${err.message}`);
       } else {
-        console.error('Failed to verify JWT token', err);
+        afLogger.error(`Failed to verify JWT token: ${err}`);
       }
       return null;
     }
     const { pk, t } = decoded;
     if (t !== mustHaveType) {
-      console.error(`Invalid token type during verification: ${t}, must be ${mustHaveType}`);
+      afLogger.error(`Invalid token type during verification: ${t}, must be ${mustHaveType}`);
       return null;
     }
     if (decodeUser !== false) {
       const dbUser = await this.adminforth.getUserByPk(pk);
       if (!dbUser) {
-        console.error(`User with pk ${pk} not found in database`);
+        afLogger.error(`User with pk ${pk} not found in database`);
         // will logout user which was deleted
         return null;
       }

adminforth/basePlugin.ts

@@ -6,6 +6,8 @@ import fs from 'fs';
 
 import crypto from 'crypto';
 
+import { afLogger } from './modules/logger.js';
+
 
 export default class AdminForthPlugin implements IAdminForthPlugin {
 
@@ -24,7 +26,7 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
     this.pluginDir = currentFileDir(metaUrl);
     this.customFolderPath = path.join(this.pluginDir, this.customFolderName);
     this.pluginOptions = pluginOptions;
-    process.env.HEAVY_DEBUG && console.log(`🪲 🪲  AdminForthPlugin.constructor`, this.constructor.name);
+    afLogger.trace(`🪲 🪲  AdminForthPlugin.constructor ${this.constructor.name}`);
     this.className = this.constructor.name;
   }
 
@@ -36,13 +38,17 @@ export default class AdminForthPlugin implements IAdminForthPlugin {
     return 'non-uniquely-identified';
   }
 
-  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
+  shouldHaveSingleInstancePerWholeApp(): boolean {
+    return false;
+  }
+
+  modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource, allPluginInstances?: {pi: AdminForthPlugin, resource: AdminForthResource}[]) {
     this.resourceConfig = resourceConfig;
     const uniqueness = this.instanceUniqueRepresentation(this.pluginOptions);
 
     const seed = `af_pl_${this.constructor.name}_${resourceConfig.resourceId}_${uniqueness}`;
     this.pluginInstanceId = md5hash(seed);
-    process.env.HEAVY_DEBUG && console.log(`🪲 AdminForthPlugin.modifyResourceConfig`, seed, 'id', this.pluginInstanceId);
+    afLogger.trace(`🪲 AdminForthPlugin.modifyResourceConfig, ${seed}, 'id', ${this.pluginInstanceId}`);
     this.adminforth = adminforth;
   }
 

adminforth/commands/callTsProxy.js

@@ -39,7 +39,8 @@ export function callTsProxy(tsCode, silent=false) {
     child.on("close", (code) => {
       if (code === 0) {
         try {
-          const parsed = JSON.parse(stdout);
+          const preparedStdout = stdout.slice(stdout.indexOf("{"), stdout.lastIndexOf("}") + 1);
+          const parsed = JSON.parse(preparedStdout);
           if (!silent) {
             parsed.capturedLogs.forEach((log) => {
               console.log(...log);

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

@@ -1,6 +1,7 @@
 import AdminForth, { AdminForthDataTypes } from 'adminforth';
 import type { AdminForthResourceInput, AdminForthResource, AdminUser } from 'adminforth';
 import { randomUUID } from 'crypto';
+import { logger } from 'adminforth';
 
 async function allowedForSuperAdmin({ adminUser }: { adminUser: AdminUser }): Promise<boolean> {
   return adminUser.dbUser.role === 'superadmin';
@@ -94,7 +95,7 @@ export default {
     },
     edit: {
       beforeSave: async ({ oldRecord, updates, adminUser, resource }: { oldRecord: any, updates: any, adminUser: AdminUser, resource: AdminForthResource }) => {
-        console.log('Updating user', updates);
+        logger.info(`Updating user, ${updates}`);
         if (oldRecord.id === adminUser.dbUser.id && updates.role) {
           return { ok: false, error: 'You cannot change your own role' };
         }

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

@@ -5,6 +5,7 @@ import { fileURLToPath } from 'url';
 import path from 'path';
 import { Filters } from 'adminforth';
 import { initApi } from './api.js';
+import { logger } from 'adminforth';
 
 const ADMIN_BASE_URL = '';
 
@@ -75,7 +76,7 @@ if (fileURLToPath(import.meta.url) === path.resolve(process.argv[1])) {
   const port = 3500;
 
   admin.bundleNow({ hotReload: process.env.NODE_ENV === 'development' }).then(() => {
-    console.log('Bundling AdminForth SPA done.');
+    logger.info('Bundling AdminForth SPA done.');
   });
 
   admin.express.serve(app);
@@ -91,6 +92,6 @@ if (fileURLToPath(import.meta.url) === path.resolve(process.argv[1])) {
   });
 
   admin.express.listen(port, () => {
-    console.log(`\n⚡ AdminForth is available at http://localhost:${port}${ADMIN_BASE_URL}\n`);
+    logger.info(`\x1b[38;5;249m ⚡ AdminForth is available at\x1b[1m\x1b[38;5;46m http://localhost:${port}${ADMIN_BASE_URL}\x1b[0m\n`);
   });
 }

adminforth/commands/createCustomComponent/main.js

@@ -188,9 +188,6 @@ async function handleCrudPageInjectionCreation(config, resources) {
   const injectionPosition = await select({
     message: 'Where exactly do you want to inject the component?',
     choices: [
-      ...(crudType === 'create' || crudType === 'edit'
-        ? [{ name: '💾 Save button on create/edit page', value: 'saveButton' }, new Separator()]
-        : []),
       { name: '⬆️ Before Breadcrumbs', value: 'beforeBreadcrumbs' },
       { name: '➡️ Before Action Buttons', value: 'beforeActionButtons' },
       { name: '⬇️ After Breadcrumbs', value: 'afterBreadcrumbs' },

adminforth/commands/createCustomComponent/templates/customCrud/afterBreadcrumbs.vue.hbs

@@ -13,11 +13,13 @@
 <script setup lang="ts">
 import { onMounted } from 'vue';
 import { useI18n } from 'vue-i18n';
-import adminforth from '@/adminforth';
+import { useAdminforth } from '@/adminforth';
 import { AdminForthResourceCommon, AdminUser } from "@/types/Common";
 
 const { t } = useI18n();
 
+const { alert } = useAdminforth();
+
 const props = defineProps<{
   record: any
   resource: AdminForthResourceCommon
@@ -30,7 +32,7 @@ onMounted(() => {
 });
 
 function handleClick() {
-  adminforth.alert({
+  alert({
     message: t('Confirmed'),
     variant: 'success',
   });