@adaptivestone/framework 5.0.0-beta.7 → 5.0.0-beta.9

package/CHANGELOG.md

@@ -1,9 +1,21 @@
-### 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.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
 

package/controllers/Auth.js

@@ -107,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();
   }

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/jsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "NodeNext",
-    "target": "ES2022",
+    "target": "ES2024",
     "moduleResolution": "nodenext",
     "checkJs": true
   },

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

@@ -14,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);
       }
     });
@@ -172,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,
@@ -243,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',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-beta.7",
+  "version": "5.0.0-beta.9",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
@@ -30,20 +30,14 @@
   "author": "Andrey Logunov",
   "license": "MIT",
   "dependencies": {
+    "@redis/client": "^1.6.0",
     "deepmerge": "^4.2.2",
     "express": "^5.0.1",
     "formidable": "^3.5.1",
-    "html-to-text": "^9.0.3",
     "i18next": "^24.0.0",
     "i18next-fs-backend": "^2.0.0",
-    "juice": "^11.0.0",
     "mongoose": "^8.0.0",
-    "nodemailer": "^6.6.3",
-    "nodemailer-sendmail-transport": "^1.0.2",
-    "nodemailer-stub-transport": "^1.1.0",
-    "pug": "^3.0.2",
     "rate-limiter-flexible": "^5.0.0",
-    "redis": "^4.3.1",
     "winston": "^3.3.3",
     "winston-transport-sentry-node": "^3.0.0",
     "yup": "^1.0.0"
@@ -64,6 +58,14 @@
     "prettier": "^3.0.0",
     "vitest": "^3.0.0"
   },
+  "peerDependencies": {
+    "@adaptivestone/framework-module-email": "^1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@adaptivestone/framework-module-email": {
+      "optional": true
+    }
+  },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [
       "prettier --write"

package/server.d.ts

@@ -1,12 +1,12 @@
-import TFolderConfig from './types/TFoldersConfig';
-import { ExpandDeep } from './types/Expand';
+import TFolderConfig from './types/TFoldersConfig.d.ts';
+import { ExpandDeep } from './types/Expand.d.ts';
 
 import EventEmitter from 'events';
 
 import { Model as MongooseModel, Schema } from 'mongoose';
 
-import BaseCli from './modules/BaseCli';
-import Cache from './services/cache/Cache';
+import BaseCli from './modules/BaseCli.js';
+import Cache from './services/cache/Cache.d.ts';
 import winston from 'winston';
 
 import HttpServer from './services/http/HttpServer.js';
@@ -29,6 +29,7 @@ declare class Server {
     get logger(): winston.Logger;
     httpServer: HttpServer | null;
     controllerManager: ControllerManager | null;
+    frameworkFolder: string;
   };
   cacheService: Cache;
 

package/server.js

@@ -36,9 +36,10 @@ class Server {
    * @param {String} config.folders.config path to folder with config files
    * @param {String} config.folders.models path to folder with moidels files
    * @param {String} config.folders.controllers path to folder with controllers files
-   * @param {String} config.folders.views path to folder with view files
    * @param {String} config.folders.locales path to folder with locales files
-   * @param {String} config.folders.emails path to folder with emails files
+   * @param {String} [config.folders.emails] path to folder with emails files
+   * @param {String} config.folders.commands path to folder with commands files
+   * @param {String} config.folders.migrations path to folder with migrations files
    */
   constructor(config) {
     this.config = config;
@@ -58,6 +59,7 @@ class Server {
       },
       httpServer: null,
       controllerManager: null,
+      frameworkFolder: new URL('.', import.meta.url).pathname,
     };
 
     this.cache = {

package/services/cache/Cache.d.ts

@@ -1,4 +1,4 @@
-import Base from '../../modules/Base';
+import Base from '../../modules/Base.d.ts';
 import Server from '../../server.js';
 
 declare class Cache extends Base {

package/services/cache/Cache.js

@@ -11,9 +11,9 @@ class Cache extends Base {
     // at least memory and redis drivers should be presented
     // memory drives should works on master process level
     // we should support multiple cashe same time
-    const redis = await import('redis');
+    const { createClient } = await import('@redis/client');
     const conf = this.app.getConfig('redis');
-    this.redisClient = redis.createClient({
+    this.redisClient = createClient({
       url: conf.url,
     });
 

package/services/http/HttpServer.js

@@ -18,12 +18,6 @@ class HttpServer extends Base {
     super(app);
     this.express = express();
     this.express.disable('x-powered-by');
-    // const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-    // this.express.set('views', [
-    //   this.app.foldersConfig.views,
-    //   path.join(dirname, '../../views'),
-    // ]);
-    // this.express.set('view engine', 'pug');
 
     this.express.use(new RequestLoggerMiddleware(this.app).getMiddleware());
     this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());

package/services/http/middleware/RateLimiter.js

@@ -4,7 +4,7 @@ import {
   RateLimiterMongo,
 } from 'rate-limiter-flexible';
 import merge from 'deepmerge';
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import mongoose from 'mongoose';
 import AbstractMiddleware from './AbstractMiddleware.js';
 
@@ -46,7 +46,7 @@ class RateLimiter extends AbstractMiddleware {
 
   initRedisLimiter() {
     const redisConfig = this.app.getConfig('redis');
-    const redisClient = redis.createClient({
+    const redisClient = createClient({
       url: redisConfig.url,
     });
 

package/tests/setup.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { randomBytes } from 'node:crypto';
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 import mongoose from 'mongoose';
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import Server from '../server.js';
 
 import clearRedisNamespace from '../helpers/redis/clearNamespace.js';
@@ -31,7 +31,6 @@ beforeAll(async () => {
       config: process.env.TEST_FOLDER_CONFIG || path.resolve('./config'),
       controllers:
         process.env.TEST_FOLDER_CONTROLLERS || path.resolve('./controllers'),
-      views: process.env.TEST_FOLDER_VIEWS || path.resolve('./views'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||
@@ -93,7 +92,7 @@ beforeEach(() => {
 afterEach(async () => {
   if (global.server) {
     const { url, namespace } = global.server.getConfig('redis');
-    const redisClient = redis.createClient({ url });
+    const redisClient = createClient({ url });
 
     try {
       await redisClient.connect();

package/tests/setupVitest.js

@@ -4,7 +4,7 @@ import { beforeAll, beforeEach, afterEach, afterAll } from 'vitest';
 
 import mongoose from 'mongoose'; // we do not need create indexes on tests
 
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import clearRedisNamespace from '../helpers/redis/clearNamespace.js';
 import Server from '../server.js';
 
@@ -18,7 +18,6 @@ beforeAll(async () => {
       config: process.env.TEST_FOLDER_CONFIG || path.resolve('./config'),
       controllers:
         process.env.TEST_FOLDER_CONTROLLERS || path.resolve('./controllers'),
-      views: process.env.TEST_FOLDER_VIEWS || path.resolve('./views'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||
@@ -82,7 +81,7 @@ beforeEach(() => {
 afterEach(async () => {
   if (global.server) {
     const { url, namespace } = global.server.getConfig('redis');
-    const redisClient = redis.createClient({ url });
+    const redisClient = createClient({ url });
 
     try {
       await redisClient.connect();

package/types/TFoldersConfig.d.ts

@@ -2,16 +2,19 @@
  * @param config path to folder with config files
  * @param models path to folder with moidels files
  * @param controllers path to folder with controllers files
- * @param views path to folder with view files
+ * @param migrations path to folder with migrations files
  * @param locales path to folder with locales files
- * @param emails path to folder with emails files
+ * @param migrations path to folder with migrations files
+ * @param [emails] path to folder with emails files. Optional
  */
 type FolderConfig = {
   config: string;
   models: string;
   controllers: string;
-  views: string;
-  emails: string;
+  commands: string;
+  locales: string;
+  migrations: string;
+  emails?: string;
 };
 
 export default FolderConfig;

package/config/mail.js

@@ -1,29 +0,0 @@
-import path from 'node:path';
-
-export default {
-  from: 'Localhost <info@localhost>',
-  transports: {
-    sendMail: {
-      // path:  "path to the sendmail command (defaults to 'sendmail')"
-      // args: 'an array of extra command line options to pass to the sendmail command (ie. ["-f", "foo@blurdybloop.com"]).'
-    },
-    stub: {},
-    smtp: {
-      // https://github.com/nodemailer/nodemailer#set-up-smtp
-      host: process.env.EMAIL_HOST || 'smtp.mailtrap.io',
-      port: process.env.EMAIL_PORT || 2525,
-      auth: {
-        user: process.env.EMAIL_USER,
-        pass: process.env.EMAIL_PASSWORD,
-      },
-      connectionTimeout: 10000, // timeout to 10 seconds
-    },
-  },
-  transport: process.env.EMAIL_TRANSPORT || 'smtp',
-  webResources: {
-    // https://github.com/jrit/web-resource-inliner path to find resources
-    relativeTo: path.resolve('src/services/messaging/email/resources'),
-    images: false,
-  },
-  globalVariablesToTemplates: {},
-};

package/services/messaging/email/index.js

@@ -1,217 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import * as url from 'node:url';
-import { promisify } from 'node:util';
-import nodemailer from 'nodemailer';
-import sendMail from 'nodemailer-sendmail-transport';
-import stub from 'nodemailer-stub-transport';
-import pug from 'pug';
-import juice from 'juice';
-import { convert } from 'html-to-text';
-import Base from '../../../modules/Base.js';
-
-const mailTransports = {
-  sendMail,
-  stub,
-  smtp: (data) => data,
-};
-
-class Mail extends Base {
-  /**
-   * Construct mail class
-   * @param {object} app
-   * @param {string} template template name
-   * @param {object} [templateData={}] data to render in template. Object with value that available inside template
-   * @param {object} [i18n] data to render in template
-   */
-  constructor(app, template, templateData = {}, i18n = null) {
-    super(app);
-    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-    if (!path.isAbsolute(template)) {
-      if (
-        fs.existsSync(
-          `${this.app.foldersConfig.emails}/${path.basename(template)}`,
-        )
-      ) {
-        this.template = `${this.app.foldersConfig.emails}/${path.basename(
-          template,
-        )}`;
-      } else if (
-        fs.existsSync(
-          path.join(dirname, `/templates/${path.basename(template)}`),
-        )
-      ) {
-        this.template = path.join(
-          dirname,
-          `/templates/${path.basename(template)}`,
-        );
-      } else {
-        this.template = path.join(dirname, `/templates/emptyTemplate`);
-        this.logger.error(
-          `Template '${template}' not found. Using 'emptyTemplate' as a fallback`,
-        );
-      }
-    }
-    this.templateData = templateData;
-    this.i18n = i18n ?? {
-      t: (str) => str,
-      locale: 'en', // todo change it to config
-    };
-    this.locale = this.i18n?.language;
-  }
-
-  /**
-   * Render template
-   * @param {object} type and fullpath
-   * @param {object} templateData
-   * @returns string
-   */
-  // eslint-disable-next-line class-methods-use-this
-  async #renderTemplateFile({ type, fullPath } = {}, templateData = {}) {
-    if (!type) {
-      return null;
-    }
-
-    switch (type) {
-      case 'html':
-      case 'text':
-      case 'css':
-        return fs.promises.readFile(fullPath, { encoding: 'utf8' });
-      case 'pug': {
-        const compiledFunction = pug.compileFile(fullPath);
-        return compiledFunction(templateData);
-      }
-      default:
-        throw new Error(`Template type ${type} is not supported`);
-    }
-  }
-
-  /**
-   * Render template
-   * @return {Promise}
-   */
-  async renderTemplate() {
-    const files = await fs.promises.readdir(this.template);
-    const templates = {};
-    for (const file of files) {
-      const [name, extension] = file.split('.');
-      templates[name] = {
-        type: extension,
-        fullPath: path.join(this.template, file),
-      };
-    }
-
-    if (!templates.html || !templates.subject) {
-      throw new Error(
-        'Template HTML and Subject must be provided. Please follow documentation for details https://framework.adaptivestone.com/docs/email',
-      );
-    }
-    const mailConfig = this.app.getConfig('mail');
-
-    const templateDataToRender = {
-      locale: this.locale,
-      t: this.i18n.t.bind(this.i18n),
-      ...mailConfig.globalVariablesToTemplates,
-      ...this.templateData,
-    };
-
-    const [htmlRendered, subjectRendered, textRendered, extraCss] =
-      await Promise.all([
-        this.#renderTemplateFile(templates.html, templateDataToRender),
-        this.#renderTemplateFile(templates.subject, templateDataToRender),
-        this.#renderTemplateFile(templates.text, templateDataToRender),
-        this.#renderTemplateFile(templates.style),
-      ]);
-
-    // @ts-ignore
-    juice.tableElements = ['TABLE'];
-
-    const juiceResourcesAsync = promisify(juice.juiceResources);
-
-    const inlinedHTML = await juiceResourcesAsync(htmlRendered, {
-      preserveImportant: true,
-      webResources: mailConfig.webResources,
-      extraCss,
-    });
-    return {
-      htmlRaw: htmlRendered,
-      subject: subjectRendered,
-      text: textRendered,
-      inlinedHTML,
-    };
-  }
-  /**
-   * Send email
-   * @param {string} to email send to
-   * @param {string} [from = mailConfig.from]
-   * @param {object} [aditionalNodemailerOptions = {}] additional option to nodemailer
-   * @return {Promise}
-   */
-  async send(to, from = null, aditionalNodemailerOptions = {}) {
-    const { subject, text, inlinedHTML } = await this.renderTemplate();
-
-    return Mail.sendRaw(
-      this.app,
-      to,
-      subject,
-      inlinedHTML,
-      text,
-      from,
-      aditionalNodemailerOptions,
-    );
-  }
-
-  /**
-   * Send provided text (html) to email. Low level function. All data should be prepared before sending (like inline styles)
-   * @param {import('../../../server.js').default['app']} app application
-   * @param {string} to send to
-   * @param {string} subject email topic
-   * @param {string} html hmlt body of emain
-   * @param {string} [text] if not provided will be generated from html string
-   * @param {string} [from = mailConfig.from] from. If not provided will be grabbed from config
-   * @param {object} [additionalNodeMailerOption = {}] any otipns to pass to nodemailer  https://nodemailer.com/message/
-   */
-  static async sendRaw(
-    app,
-    to,
-    subject,
-    html,
-    text = null,
-    from = null,
-    additionalNodeMailerOption = {},
-  ) {
-    if (!app || !to || !subject || !html) {
-      throw new Error('App, to, subject and html is required fields.');
-    }
-    const mailConfig = app.getConfig('mail');
-    if (!from) {
-      // eslint-disable-next-line no-param-reassign
-      from = mailConfig.from;
-    }
-
-    if (!text) {
-      // eslint-disable-next-line no-param-reassign
-      text = convert(html, {
-        selectors: [{ selector: 'img', format: 'skip' }],
-      });
-    }
-    const transportConfig = mailConfig.transports[mailConfig.transport];
-    const transport = mailTransports[mailConfig.transport];
-    const transporter = nodemailer.createTransport(transport(transportConfig));
-
-    return transporter.sendMail({
-      from,
-      to,
-      subject,
-      text,
-      html,
-      ...additionalNodeMailerOption,
-    });
-  }
-
-  static get loggerGroup() {
-    return 'email_';
-  }
-}
-
-export default Mail;

package/services/messaging/email/templates/emptyTemplate/html.pug

@@ -1,9 +0,0 @@
-doctype html
-html(lang='en')
-   head
-     meta(charset='UTF-8')
-     title New message
-   body
-     h1 Good day
-     p
-       | Sorry, message template not found

package/services/messaging/email/templates/emptyTemplate/subject.pug

@@ -1 +0,0 @@
-= `New message`

package/services/messaging/email/templates/emptyTemplate/text.pug

@@ -1 +0,0 @@
-= `Good day`

package/services/messaging/index.js

@@ -1,3 +0,0 @@
-import email from './email/index.js';
-
-export { email };