@adaptivestone/framework 5.0.0-alpha.9 → 5.0.0-beta.10

package/services/http/middleware/RateLimiter.test.js

@@ -1,233 +0,0 @@
-import { setTimeout } from 'node:timers/promises';
-import crypto from 'node:crypto';
-import { beforeAll, afterAll, describe, it, expect } from 'vitest';
-
-import RateLimiter from './RateLimiter.js';
-
-let mongoRateLimiter;
-
-describe('rate limiter methods', () => {
-  beforeAll(async () => {
-    await setTimeout(20);
-
-    mongoRateLimiter = new RateLimiter(global.server.app, {
-      driver: 'mongo',
-      limiterOptions: {
-        keyPrefix: `mongo_${Date.now()}_${crypto.randomUUID()}}`,
-      },
-    });
-  });
-
-  afterAll(async () => {
-    // we need to wait because redis mongo ask mongo to create indexes
-    await setTimeout(200);
-  });
-  it('have description fields', async () => {
-    expect.assertions(1);
-    const middleware = new RateLimiter(global.server.app, {
-      driver: 'redis',
-    });
-    expect(middleware.constructor.description).toBeDefined();
-  });
-
-  it('can create redis rateLimiter', async () => {
-    expect.assertions(1);
-
-    const redisRateLimiter = new RateLimiter(global.server.app, {
-      driver: 'redis',
-    });
-
-    expect(redisRateLimiter.limiter).toBeDefined();
-  });
-
-  it('can not create rateLimiter with unknown driver', async () => {
-    expect.assertions(1);
-
-    const rateLimiter = new RateLimiter(global.server.app, {
-      driver: 'unknown',
-    });
-
-    expect(rateLimiter.limiter).toBeNull();
-  });
-
-  it('generateConsumeKey works correctly', async () => {
-    expect.assertions(1);
-
-    const redisRateLimiter = new RateLimiter(global.server.app, {
-      driver: 'redis',
-    });
-
-    const res = await redisRateLimiter.gerenateConsumeKey({
-      ip: '192.168.0.0',
-      appInfo: {
-        user: {
-          id: 'someId',
-        },
-      },
-    });
-
-    expect(res).toBe('192.168.0.0__someId');
-  });
-
-  it('generateConsumeKey with request works correctly', async () => {
-    expect.assertions(1);
-
-    const redisRateLimiter = new RateLimiter(global.server.app, {
-      driver: 'redis',
-      consumeKeyComponents: {
-        request: ['email'],
-      },
-    });
-
-    const res = await redisRateLimiter.gerenateConsumeKey({
-      ip: '192.168.0.0',
-      body: {
-        email: 'foo@example.com',
-      },
-    });
-
-    expect(res).toBe('192.168.0.0__foo@example.com');
-  });
-
-  it('middleware without driver should fail', async () => {
-    expect.assertions(2);
-    const rateLimiter = new RateLimiter(global.server.app, {
-      driver: 'unknown',
-    });
-    const req = {
-      appInfo: {},
-    };
-    let status;
-    let isSend;
-    await rateLimiter.middleware(
-      req,
-      {
-        status(statusCode) {
-          status = statusCode;
-          return this;
-        },
-        json() {
-          isSend = true;
-        },
-      },
-      () => {},
-    );
-    expect(status).toBe(500);
-    expect(isSend).toBeTruthy();
-  });
-
-  const makeOneRequest = async ({ rateLimiter, driver, request }) => {
-    let realRateLimiter = rateLimiter;
-    if (!realRateLimiter) {
-      realRateLimiter = new RateLimiter(global.server.app, {
-        driver,
-      });
-    }
-    const req = {
-      appInfo: {},
-      ...request,
-    };
-    let status;
-    let isSend = false;
-    let isNextCalled = false;
-    await realRateLimiter.middleware(
-      req,
-      {
-        status(statusCode) {
-          status = statusCode;
-          return this;
-        },
-        json() {
-          isSend = true;
-        },
-      },
-      () => {
-        isNextCalled = true;
-      },
-    );
-    return { status, isSend, isNextCalled };
-  };
-
-  it('middleware should works with a mongo drivers', async () => {
-    expect.assertions(1);
-    const { isNextCalled } = await makeOneRequest({
-      rateLimiter: mongoRateLimiter,
-      request: { ip: '10.10.0.1' },
-    });
-    expect(isNextCalled).toBeTruthy();
-  });
-
-  it('middleware should works with a memory drivers', async () => {
-    expect.assertions(1);
-    const { isNextCalled } = await makeOneRequest({
-      driver: 'memory',
-      request: { ip: '10.10.0.1' },
-    });
-    expect(isNextCalled).toBeTruthy();
-  });
-
-  it('middleware should works with a redis drivers', async () => {
-    expect.assertions(1);
-    const { isNextCalled } = await makeOneRequest({
-      driver: 'redis',
-      request: { ip: '10.10.0.1' },
-    });
-    expect(isNextCalled).toBeTruthy();
-  });
-
-  it('middleware should rate limits for us. mongo driver', async () => {
-    expect.assertions(2);
-
-    const middlewares = Array.from({ length: 20 }, () =>
-      makeOneRequest({ rateLimiter: mongoRateLimiter }),
-    );
-
-    const data = await Promise.all(middlewares);
-
-    const status = data.find((obj) => obj.status === 429);
-    const isSend = data.find((obj) => obj.isSend);
-
-    expect(status.status).toBe(429);
-    expect(isSend.isSend).toBeTruthy();
-  });
-
-  it('middleware should rate limits for us. memory driver', async () => {
-    expect.assertions(2);
-
-    const rateLimiter = new RateLimiter(global.server.app, {
-      driver: 'memory',
-    });
-
-    const middlewares = Array.from({ length: 20 }, () =>
-      makeOneRequest({ rateLimiter }),
-    );
-
-    const data = await Promise.all(middlewares);
-
-    const status = data.find((obj) => obj.status === 429);
-    const isSend = data.find((obj) => obj.isSend);
-
-    expect(status.status).toBe(429);
-    expect(isSend.isSend).toBeTruthy();
-  });
-
-  it('middleware should rate limits for us. redis driver', async () => {
-    expect.assertions(2);
-
-    const rateLimiter = new RateLimiter(global.server.app, {
-      driver: 'redis',
-    });
-
-    const middlewares = Array.from({ length: 20 }, () =>
-      makeOneRequest({ rateLimiter }),
-    );
-
-    const data = await Promise.all(middlewares);
-
-    const status = data.find((obj) => obj.status === 429);
-    const isSend = data.find((obj) => obj.isSend);
-
-    expect(status.status).toBe(429);
-    expect(isSend.isSend).toBeTruthy();
-  });
-});

package/services/http/middleware/RequestParser.test.js

@@ -1,121 +0,0 @@
-import { createServer } from 'node:http';
-import { describe, it, expect } from 'vitest';
-import { PersistentFile } from 'formidable';
-
-import RequestParser from './RequestParser.js';
-
-describe('reqest parser limiter methods', () => {
-  it('have description fields', async () => {
-    expect.assertions(1);
-    const middleware = new RequestParser(global.server.app);
-    expect(middleware.constructor.description).toBeDefined();
-  });
-  it('middleware that works', async () => {
-    expect.assertions(4);
-
-    await new Promise((done) => {
-      // from https://github.com/node-formidable/formidable/blob/master/test-node/standalone/promise.test.js
-
-      const server = createServer(async (req, res) => {
-        req.appInfo = {};
-        const middleware = new RequestParser(global.server.app);
-        middleware.middleware(req, {}, (err) => {
-          expect(err).toBeUndefined();
-          expect(req.body.title).toBeDefined();
-          expect(req.body.multipleFiles).toBeDefined();
-          expect(
-            req.body.multipleFiles[0] instanceof PersistentFile,
-          ).toBeTruthy();
-
-          res.writeHead(200);
-          res.end('ok');
-        });
-      });
-      server.listen(null, async () => {
-        const chosenPort = server.address().port;
-        const body = `----13068458571765726332503797717\r
-Content-Disposition: form-data; name="title"\r
-\r
-a\r
-----13068458571765726332503797717\r
-Content-Disposition: form-data; name="multipleFiles"; filename="x.txt"\r
-Content-Type: application/x-javascript\r
-\r
-\r
-\r
-a\r
-b\r
-c\r
-d\r
-\r
-----13068458571765726332503797717--\r
-`;
-        await fetch(String(new URL(`http:localhost:${chosenPort}/`)), {
-          method: 'POST',
-
-          headers: {
-            'Content-Length': body.length,
-            Host: `localhost:${chosenPort}`,
-            'Content-Type':
-              'multipart/form-data; boundary=--13068458571765726332503797717',
-          },
-          body,
-        }).catch((err) => {
-          console.error(err);
-          done(err);
-        });
-        server.close(() => {
-          done();
-        });
-      });
-    });
-  });
-  it('middleware with a problem', async () => {
-    expect.assertions(1);
-
-    await new Promise((done) => {
-      // from https://github.com/node-formidable/formidable/blob/master/test-node/standalone/promise.test.js
-
-      const server = createServer(async (req, res) => {
-        req.appInfo = {};
-        const middleware = new RequestParser(global.server.app);
-        let status;
-
-        const resp = {
-          status: (code) => {
-            status = code;
-            return resp;
-          },
-          json: () => resp,
-        };
-        await middleware.middleware(req, resp, () => {});
-        expect(status).toBe(400);
-        // expect(err).toBeDefined();
-
-        res.writeHead(200);
-        res.end('ok');
-      });
-      server.listen(null, async () => {
-        const chosenPort = server.address().port;
-        const body = 'someBadBody';
-
-        await fetch(String(new URL(`http:localhost:${chosenPort}/`)), {
-          method: 'POST',
-
-          headers: {
-            'Content-Length': body.length,
-            Host: `localhost:${chosenPort}`,
-            'Content-Type': 'badContentType',
-          },
-          body,
-        }).catch((err) => {
-          console.error(err);
-          done(err);
-        });
-        server.close(() => {
-          done();
-        });
-      });
-    });
-  });
-});

package/services/http/middleware/Role.test.js

@@ -1,93 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import Role from './Role.js';
-
-describe('role middleware methods', () => {
-  it('have description fields', async () => {
-    expect.assertions(1);
-    const middleware = new Role(global.server.app);
-    expect(middleware.constructor.description).toBeDefined();
-  });
-
-  it('middleware pass when user presented with a right role', async () => {
-    expect.assertions(1);
-    let isCalled = false;
-    const nextFunction = () => {
-      isCalled = true;
-    };
-    const req = {
-      appInfo: {
-        user: {
-          roles: ['role1', 'role2'],
-        },
-      },
-    };
-    const middleware = new Role(global.server.app, {
-      roles: ['admin', 'role1'],
-    });
-
-    await middleware.middleware(req, {}, nextFunction);
-    expect(isCalled).toBeTruthy();
-  });
-
-  it('middleware NOT pass when user NOT presented', async () => {
-    expect.assertions(3);
-    let isCalled = false;
-    let status;
-    let isSend;
-    const nextFunction = () => {
-      isCalled = true;
-    };
-    const req = {
-      appInfo: {}, // no user
-    };
-    const middleware = new Role(global.server.app);
-    await middleware.middleware(
-      req,
-      {
-        status(statusCode) {
-          status = statusCode;
-          return this;
-        },
-        json() {
-          isSend = true;
-        },
-      },
-      nextFunction,
-    );
-    expect(isCalled).toBeFalsy();
-    expect(status).toBe(401);
-    expect(isSend).toBeTruthy();
-  });
-
-  it('middleware NOT pass when user  have a wrong role', async () => {
-    expect.assertions(3);
-    let isCalled = false;
-    let status;
-    let isSend;
-    const nextFunction = () => {
-      isCalled = true;
-    };
-    const req = {
-      appInfo: {
-        user: { roles: ['role1', 'role2'] },
-      },
-    };
-    const middleware = new Role(global.server.app, { roles: ['admin'] });
-    await middleware.middleware(
-      req,
-      {
-        status(statusCode) {
-          status = statusCode;
-          return this;
-        },
-        json() {
-          isSend = true;
-        },
-      },
-      nextFunction,
-    );
-    expect(isCalled).toBeFalsy();
-    expect(status).toBe(403);
-    expect(isSend).toBeTruthy();
-  });
-});

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),
-      ]);
-
-    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 this.constructor.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 };