@adaptivestone/framework 5.0.0-beta.1 → 5.0.0-beta.10

package/CHANGELOG.md

@@ -1,3 +1,41 @@
+### 5.0.0-beta.9
+
+[BREAKING] move email module to separate package @adaptivestone/framework-module-email. Please use it if you want to send emails
+[NEW] app now contains 'frameworkFolder' folder the framework located. Mostly for modules usage
+[BREAKING] remove VIEWS folders at all. Should not afffect any user as this was not used internally
+[UPDATE] update typing
+[UPDATE] change redis -> @redis/client as we are using only client from pakage
+[BREAKING] removed noidemailer-sendmail-transport. Not needed anymore and not recommended to use as well
+
+### 5.0.0-beta.8
+
+[UPDATE] update deps
+[NEW] Lock model for working locks via mongoDB
+
+### 5.0.0-beta.7
+
+[UPDATE] update deps
+[UPDATE] change vitest shutdown behavior as mongo driver v6.13 change befaviur that affect us (MongoClient.close now closes any outstanding cursors)
+
+### 5.0.0-beta.5
+
+[BREAKING] remove minimist CLI parsing and replace it by commandArguments parser
+[UPDATE] migrated from eslint-plugin-import to eslint-plugin-import-x
+
+### 5.0.0-beta.5
+
+[UPDATE] migrate to eslint 9 and away from aibnb styles (they are abonded)
+
+### 5.0.0-beta.4
+
+[NEW] on shutdown event now after timeout we are forcing to shutdown
+
+### 5.0.0-beta.2
+
+[UPDATE] update deps
+[NEW] add ability to skip mongo model init in CLI env
+[NEW] now each mongo connection on CLI have own name and inslude command name there too (getMongoConnectionName in command)
+
 ### 5.0.0-beta.1
 
 [UPDATE] update deps
@@ -452,7 +490,7 @@ await doc.populate([
 [UPDATE] update deps
 [UPDATE] winston console transport now using timestapms
 [UPDATE] PrepareAppInfo middleware now a global one. Do not need to include it on every controller
-[NEW] Request anso works with req.query, but req.body have bigger priority
+[NEW] Request also works with req.query, but req.body have bigger priority
 
 ### 2.18.0
 

package/Cli.js

@@ -1,4 +1,3 @@
-import parseArgs from 'minimist';
 import mongoose from 'mongoose';
 import BaseCli from './modules/BaseCli.js';
 import Server from './server.js';
@@ -8,14 +7,14 @@ class Cli extends BaseCli {
     mongoose.set('autoIndex', false); // we do not need create indexes on CLI.
     const server = new Server(serverConfig);
     super(server);
-    this.args = parseArgs(process.argv.slice(3));
   }
 
   async run() {
-    await this.server.init();
+    await this.server.init({ isSkipModelInit: true, isSkipModelLoading: true });
     const command = process.argv[2]?.toLowerCase();
-    await super.run(command, this.args);
+    await super.run(command);
     this.app.events.emit('shutdown');
+    return true;
   }
 }
 

package/cluster.js

@@ -4,7 +4,6 @@ import { cpus } from 'node:os';
 const numCPUs = cpus().length;
 
 if (cluster.isPrimary) {
-  // eslint-disable-next-line no-console
   console.log(`Master ${process.pid} is running`);
   // Fork workers.
   for (let i = 0; i < numCPUs; i += 1) {
@@ -12,7 +11,6 @@ if (cluster.isPrimary) {
   }
 
   cluster.on('exit', (worker, code, signal) => {
-    // eslint-disable-next-line no-console
     console.log(
       `Worker \x1B[45m ${
         worker.process.pid

package/commands/CreateUser.js

@@ -6,6 +6,37 @@ class CreateUser extends AbstractCommand {
     return 'Create user in a database';
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      id: {
+        type: 'string',
+        description: 'User id to find user',
+      },
+      email: {
+        type: 'string',
+        description: 'User id to find/create user',
+      },
+      password: {
+        type: 'string',
+        description: 'New password for user',
+      },
+      roles: {
+        type: 'string',
+        description:
+          'User roles comma separated string (--roles=user,admin,someOtherRoles)',
+      },
+      update: {
+        type: 'boolean',
+        default: false,
+        description: 'Update user if it exists',
+      },
+    };
+  }
+
   async run() {
     const User = this.app.getModel('User');
     const { id, email, password, roles, update } = this.args;

package/commands/DropIndex.js

@@ -5,12 +5,21 @@ class DropIndex extends AbstractCommand {
     return 'Drop indexes of model';
   }
 
-  async run() {
-    if (!this.args.model) {
-      this.logger.error('Please provide model name as "--model=BestUserModel"');
-      return false;
-    }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      model: {
+        type: 'string',
+        description: 'Model name',
+        required: true,
+      },
+    };
+  }
 
+  async run() {
     const Model = this.app.getModel(this.args.model);
 
     if (!Model) {

package/commands/GenerateRandomBytes.js

@@ -6,6 +6,8 @@ class GenerateRandomBytes extends AbstractCommand {
     return 'Generate random bytes ising randomBytes from  node:crypto';
   }
 
+  static isShouldInitModels = false;
+
   async run() {
     const sizes = [16, 32, 64, 128, 256];
     for (const size of sizes) {

package/commands/GetOpenApiJson.js

@@ -8,6 +8,18 @@ class GetOpenApiJson extends AbstractCommand {
   static get description() {
     return 'Generate documentation (openApi) ';
   }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      output: {
+        type: 'string',
+        description: 'Output file path',
+      },
+    };
+  }
 
   async run() {
     const { myDomain } = this.app.getConfig('http');
@@ -18,7 +30,7 @@ class GetOpenApiJson extends AbstractCommand {
 
     try {
       jsonFile = JSON.parse(await fs.readFile(jsonFile, 'utf8'));
-    } catch (e) {
+    } catch {
       this.logger.error(
         'No npm package detected. Please start this command via NPM as it depends on package.json',
       );
@@ -123,7 +135,6 @@ class GetOpenApiJson extends AbstractCommand {
 
         let routeName = Object.keys(route)[0];
         if (routeName === '/') {
-          // eslint-disable-next-line no-continue
           continue;
         }
 

package/commands/SyncIndexes.js

@@ -29,6 +29,7 @@ class SyncIndexes extends AbstractCommand {
         this.logger.info(`Model - ${modelName} NO removed indexes`);
       }
     }
+    return true;
   }
 
   static get description() {

package/commands/migration/Create.js

@@ -7,28 +7,39 @@ class CreateMigration extends AbstractCommand {
     return 'Create new migration';
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      name: {
+        type: 'string',
+        description: 'Migration name',
+        required: true,
+      },
+    };
+  }
+
   async run() {
-    if (!this.args.name) {
-      return this.logger.error(
-        'Please provide migration name with key "--name={someName}"',
-      );
-    }
     if (this.args.name.match(/^\d/)) {
-      return this.logger.error('Command cant start from nubmer');
+      this.logger.error('Command cant start from nubmer');
+      return false;
     }
-    const fileName = `${Date.now()}_${this.constructor.camelSentence(
+    const fileName = `${Date.now()}_${CreateMigration.camelSentence(
       this.args.name,
     )}.js`;
 
-    const fileContent = this.constructor.getTemplate(
-      this.constructor.camelSentence(this.args.name),
+    const fileContent = CreateMigration.getTemplate(
+      CreateMigration.camelSentence(this.args.name),
     );
 
     await fs.writeFile(
       path.join(this.app.foldersConfig.migrations, fileName),
       fileContent,
     );
-    return this.logger.info(`Migration created ${fileName}`);
+    this.logger.info(`Migration created ${fileName}`);
+    return true;
   }
 
   static camelSentence(str) {

package/commands/migration/Migrate.js

@@ -49,6 +49,7 @@ class Migrate extends AbstractCommand {
     this.logger.info(
       `=== Migration Finished. Migrated ${migrations.length} files ===`,
     );
+    return true;
   }
 }
 

package/controllers/Auth.js

@@ -1,4 +1,4 @@
-import yup from 'yup';
+import { object, string } from 'yup';
 import AbstractController from '../modules/AbstractController.js';
 import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
 import RateLimiter from '../services/http/middleware/RateLimiter.js';
@@ -9,58 +9,52 @@ class Auth extends AbstractController {
       post: {
         '/login': {
           handler: this.postLogin,
-          request: yup.object().shape({
-            email: yup.string().email().required('auth.emailProvided'), // if not provided then error will be generated
-            password: yup.string().required('auth.passwordProvided'), // possible to provide values from translation
+          request: object().shape({
+            email: string().email().required('auth.emailProvided'), // if not provided then error will be generated
+            password: string().required('auth.passwordProvided'), // possible to provide values from translation
           }),
         },
         '/register': {
           handler: this.postRegister,
-          request: yup.object().shape({
-            email: yup
-              .string()
+          request: object().shape({
+            email: string()
               .email('auth.emailValid')
               .required('auth.emailProvided'),
-            password: yup
-              .string()
+            password: string()
               .matches(
                 /^[a-zA-Z0-9!@#$%ˆ^&*()_+\-{}[\]<>]+$/,
                 'auth.passwordValid',
               )
               .required('auth.passwordProvided'),
-            nickName: yup
-              .string()
-              .matches(/^[a-zA-Z0-9_\-.]+$/, 'auth.nickNameValid'),
-            firstName: yup.string(),
-            lastName: yup.string(),
+            nickName: string().matches(
+              /^[a-zA-Z0-9_\-.]+$/,
+              'auth.nickNameValid',
+            ),
+            firstName: string(),
+            lastName: string(),
           }),
         },
         '/logout': this.postLogout,
         '/verify': this.verifyUser,
         '/send-recovery-email': {
           handler: this.sendPasswordRecoveryEmail,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
+          request: object().shape({ email: string().email().required() }),
         },
         '/recover-password': {
           handler: this.recoverPassword,
-          request: yup.object().shape({
-            password: yup
-              .string()
+          request: object().shape({
+            password: string()
               .matches(
                 /^[a-zA-Z0-9!@#$%ˆ^&*()_+\-{}[\]<>]+$/,
                 'auth.passwordValid',
               )
               .required(),
-            passwordRecoveryToken: yup.string().required(),
+            passwordRecoveryToken: string().required(),
           }),
         },
         '/send-verification': {
           handler: this.sendVerification,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
+          request: object().shape({ email: string().email().required() }),
         },
       },
     };
@@ -113,12 +107,9 @@ class Auth extends AbstractController {
 
     const { isAuthWithVefificationFlow } = this.app.getConfig('auth');
     if (isAuthWithVefificationFlow) {
-      const answer = await user.sendVerificationEmail(req.i18n).catch((e) => {
+      await user.sendVerificationEmail(req.i18n).catch((e) => {
         this.logger.error(e);
       });
-      if (!answer) {
-        return res.status(500).json();
-      }
     }
     return res.status(201).json();
   }
@@ -136,7 +127,7 @@ class Auth extends AbstractController {
       user = await User.getUserByVerificationToken(
         req.query.verification_token,
       );
-    } catch (e) {
+    } catch {
       return res.status(400).json({
         message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
       });

package/eslint.config.js

@@ -0,0 +1,68 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import importPlugin from 'eslint-plugin-import-x';
+import vitest from '@vitest/eslint-plugin';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier/recommended';
+
+/** @type {import('eslint').Linter.Config[]} */
+// @ts-ignore
+export default [
+  pluginJs.configs.recommended,
+  importPlugin.flatConfigs.recommended,
+  eslintConfigPrettier,
+  prettierPlugin,
+  {
+    languageOptions: {
+      sourceType: 'module',
+      ecmaVersion: 'latest',
+      globals: {
+        ...globals.es2023,
+        ...globals.node,
+      },
+    },
+  },
+  {
+    rules: {
+      'no-await-in-loop': 'error',
+      'no-param-reassign': 'error',
+      'class-methods-use-this': 'error',
+      'no-shadow': 'error',
+      'prefer-const': 'error',
+      'import-x/no-extraneous-dependencies': ['error'],
+      'import-x/first': ['error'],
+      camelcase: ['error', { properties: 'never', ignoreDestructuring: false }],
+      'prefer-destructuring': [
+        'error',
+        {
+          VariableDeclarator: {
+            array: false,
+            object: true,
+          },
+          AssignmentExpression: {
+            array: true,
+            object: false,
+          },
+        },
+        {
+          enforceForRenamedProperties: false,
+        },
+      ],
+      'no-plusplus': 'error',
+      'consistent-return': 'error',
+      'no-return-await': 'error',
+      'arrow-body-style': 'error',
+      'dot-notation': 'error',
+      curly: 'error',
+    },
+  },
+  {
+    files: ['**/*.test.js'],
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+  },
+];

package/folderConfig.js

@@ -5,7 +5,6 @@ export default {
     config: path.resolve('./config'),
     models: path.resolve('./models'),
     controllers: path.resolve('./controllers'),
-    views: path.resolve('./views'),
     locales: path.resolve('./locales'),
     emails: path.resolve('./services/messaging/email/templates'),
     commands: path.resolve('./commands'),

package/helpers/files.js

@@ -73,7 +73,4 @@ const getFilesPathWithInheritance = async ({
   return filesToLoad;
 };
 
-export {
-  // eslint-disable-next-line import/prefer-default-export
-  getFilesPathWithInheritance,
-};
+export { getFilesPathWithInheritance };

package/helpers/logger.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 const levels = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
 
 const consoleLogger = (level, message) => {

package/helpers/yup.js

@@ -13,12 +13,10 @@ class YupFile extends Schema {
   constructor() {
     super({
       type: 'file',
+      // @ts-ignore
       check: (value) => value.every((item) => item instanceof PersistentFile),
     });
   }
 }
 
-export {
-  // eslint-disable-next-line import/prefer-default-export
-  YupFile,
-};
+export { YupFile };

package/jsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
-    "module": "node16",
-    "target": "ES2022",
-    "moduleResolution": "node16",
+    "module": "NodeNext",
+    "target": "ES2024",
+    "moduleResolution": "nodenext",
     "checkJs": true
   },
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "coverage"]
 }

package/models/Lock.js

@@ -0,0 +1,107 @@
+import AbstractModel from '../modules/AbstractModel.js';
+
+class Lock extends AbstractModel {
+  initHooks() {
+    this.mongooseSchema.index({ expiredAt: 1 }, { expireAfterSeconds: 0 });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  get modelSchema() {
+    return {
+      _id: { type: String, required: true },
+      expiredAt: {
+        type: Date,
+      },
+    };
+  }
+
+  /**
+   * acquire lock based on lock name
+   * @param {string} name
+   * @param {number} [ttlSeconds=30]
+   * @returns {Promise<boolean>}
+   */
+  static async acquireLock(name, ttlSeconds = 30) {
+    try {
+      await this.create({
+        _id: name,
+        expiredAt: new Date(Date.now() + ttlSeconds * 1000),
+      });
+    } catch (error) {
+      if (error.code !== 11000) {
+        // not a duplicate leys
+        throw error;
+      }
+      return false;
+    }
+    return true;
+  }
+
+  /**
+   * release lock based on lock name
+   * @param {string} name
+   * @returns {Promise<boolean>}
+   */
+  static async releaseLock(name) {
+    const res = await this.deleteOne({ _id: name });
+    if (res.acknowledged && res.deletedCount) {
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * wait lock based on lock name
+   * @param {string} name
+   * @returns {Promise}
+   */
+  static async waitForUnlock(name) {
+    const res = await this.findOne({ _id: name });
+    if (!res) {
+      return Promise.resolve();
+    }
+
+    return new Promise((resolve) => {
+      const stream = this.watch([
+        { $match: { operationType: 'delete', 'documentKey._id': name } },
+      ]);
+      stream.on('change', () => {
+        stream.close();
+        resolve();
+      });
+    });
+  }
+
+  /**
+   * get lock remaining time based on lock name
+   * @param {string} name
+   * @returns {Promise<{ttl: number}>}
+   */
+  static async getLockData(name) {
+    const res = await this.findOne({ _id: name });
+    if (!res) {
+      return { ttl: 0 };
+    }
+    return { ttl: res.expiredAt.getTime() - Date.now() };
+  }
+
+  /**
+   * get lock remaining time based on lock name
+   * @param {string[]} names
+   * @returns {Promise<{name: string, ttl: number}[]>}
+   */
+  static async getLocksData(names) {
+    const res = await this.find({ _id: { $in: names } });
+    const lockMap = new Map(res.map((lock) => [lock._id, lock]));
+
+    return names.map((name) => {
+      const lock = lockMap.get(name);
+      return {
+        name,
+        ttl: lock ? lock.expiredAt.getTime() - Date.now() : 0,
+      };
+    });
+  }
+}
+
+export default Lock;

package/models/User.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-param-reassign */
-
 import { scrypt } from 'node:crypto';
 
 import { promisify } from 'node:util';
@@ -16,6 +14,7 @@ class User extends AbstractModel {
   initHooks() {
     this.mongooseSchema.pre('save', async function userPreSaveHook() {
       if (this.isModified('password')) {
+        // @ts-ignore
         this.password = await this.constructor.hashPassword(this.password);
       }
     });
@@ -174,9 +173,18 @@ class User extends AbstractModel {
   async sendPasswordRecoveryEmail(i18n) {
     const passwordRecoveryToken =
       await User.generateUserPasswordRecoveryToken(this);
+    let Mailer;
     // speed optimisation
-    const Mailer = (await import('../services/messaging/email/index.js'))
-      .default;
+    try {
+      // @ts-ignore
+      // eslint-disable-next-line import-x/no-unresolved
+      Mailer = (await import('@adaptivestone/framework-module-email')).default;
+    } catch {
+      const error =
+        'Mailer not found. Please install @adaptivestone/framework-module-email in order to use it';
+      this.getSuper().logger.error(error);
+      return false;
+    }
 
     const mail = new Mailer(
       this.getSuper().app,
@@ -245,8 +253,17 @@ class User extends AbstractModel {
   async sendVerificationEmail(i18n) {
     const verificationToken = await User.generateUserVerificationToken(this);
     // speed optimisation
-    const Mailer = (await import('../services/messaging/email/index.js'))
-      .default;
+    let Mailer;
+    try {
+      // @ts-ignore
+      // eslint-disable-next-line import-x/no-unresolved
+      Mailer = (await import('@adaptivestone/framework-module-email')).default;
+    } catch {
+      const error =
+        'Mailer not found. Please install @adaptivestone/framework-module-email in order to use it';
+      this.getSuper().logger.error(error);
+      return false;
+    }
     const mail = new Mailer(
       this.getSuper().app,
       'verification',