@paralect/hive 0.1.49 → 0.1.50-alpha.2

package/.hive/src/routes/index.js

@@ -0,0 +1,172 @@
+import _ from "lodash";
+import getResources from "helpers/getResources";
+import getMiddlewares from "helpers/getMiddlewares";
+import getResourceEndpoints from "helpers/getResourceEndpoints";
+import mount from "koa-mount";
+import Router from "@koa/router";
+import validate from "middlewares/validate";
+import db from "db";
+import tryToAttachUser from "middlewares/global/tryToAttachUser";
+import attachCustomErrors from "./middlewares/attachCustomErrors";
+import routeErrorHandler from "./middlewares/routeErrorHandler";
+import isAuthorized from "middlewares/isAuthorized";
+import config from 'app-config';
+
+const requestLogService = db.createService("_request_logs");
+
+const logRequestToMongo = async (ctx, next) => {
+  const startedOn = new Date();
+
+  const saveLog = async ({ error = null } = {}) => {
+    if (ctx.state.isSkipLog) {
+      return;
+    }
+
+    if (ctx.state.resourceName && ctx.state.endpoint) {
+      const requestLog = {
+        isSuccess: true,
+        request: {
+          url: ctx.originalUrl,
+          method: ctx.request.method,
+          query: ctx.query,
+          body: ctx.request.body,
+          params: ctx.params,
+          headers: ctx.headers,
+        },
+        response: {
+          status: ctx.status,
+          body: ctx.body,
+        },
+        resourceName: ctx.state.resourceName,
+        endpoint: ctx.state.endpoint,
+        time: new Date() - startedOn,
+      };
+      if (error) {
+        requestLog.isSuccess = false;
+        requestLog.error = {
+          message: error.message,
+          stack: error.stack,
+        };
+      }
+      await requestLogService.create(requestLog);
+    }
+  };
+
+  try {
+    await next();
+
+    await saveLog({ error: ctx.state.error });
+
+  } catch (err) {
+    await saveLog({ error: err });
+    throw err;
+  }
+};
+
+export default async (app) => {
+  app.use(logRequestToMongo);
+  app.use(attachCustomErrors);
+  app.use(routeErrorHandler);
+  app.use(tryToAttachUser);
+
+  const [resources, allMiddlewares] = await Promise.all([getResources(), getMiddlewares()]);
+
+  await Promise.all(_.map(resources, async ({ name: resourceName }) => {
+    const resourceRouter = new Router();
+    const globalRouter = new Router();
+    const endpoints = await Promise.all((await getResourceEndpoints(resourceName))
+      .map(async ({ file: endpointFile, name }) => {
+        let endpointDef = (await import(endpointFile));
+
+        if (!endpointDef.endpoint) {
+          console.log('missing endpoint for', name);
+        }
+        endpointDef.endpoint.name = name;
+
+        return {
+          endpoint: endpointDef.endpoint,
+          requestSchema: endpointDef.requestSchema,
+          middlewares: endpointDef.middlewares,
+          handler: endpointDef.handler,
+        };
+      })
+      .sort((e) => {
+        e.endpoint = e.endpoint || { method: "get", url: "/" };
+        const url = e.endpoint.url || e.endpoint.absoluteUrl;
+        if (url.includes("/:")) {
+          return 1;
+        }
+        return -1;
+      }));
+
+    endpoints.forEach(({ endpoint, requestSchema, middlewares = [], handler }) => {
+      let targetRouter;
+      console.log('[routes] Register endpoint', resourceName, endpoint?.method || 'GET', endpoint?.url);
+
+      let url = endpoint.absoluteUrl || endpoint.url;
+
+      if (url.startsWith("$HOST/")) {
+        url = url.replace("$HOST", "");
+        targetRouter = globalRouter;
+      } else if (endpoint.absoluteUrl) {
+        targetRouter = globalRouter;
+      } else {
+        targetRouter = resourceRouter;
+      }
+
+      const globalMiddleware = allMiddlewares.find(m => m.name === 'global');
+
+      if (globalMiddleware) {
+        globalMiddleware.runOrder = 0;
+        middlewares.unshift(globalMiddleware.fn);
+      }
+
+      middlewares = middlewares.map(middleware => {
+        if (_.isString(middleware)) {
+          if (!allMiddlewares.find(m => m.name === middleware)) {
+            throw new Error(`Middleware ${middleware} not found`);
+          }
+
+          middleware = allMiddlewares.find(m => m.name === middleware).fn;
+        } else if (middleware?.name && middleware?.args) {
+          if (!allMiddlewares.find(m => m.name === middleware.name)) {
+            throw new Error(`Middleware ${middleware.name} not found`);
+          };
+          middleware = allMiddlewares.find(m => m.name === middleware.name).fn(...middleware.args);
+        }
+
+        return middleware;
+      }).map(middleware => {
+        middleware.runOrder = _.isNumber(middleware.runOrder) ? middleware.runOrder : 1;
+        return middleware;
+      });
+
+
+      if (config._hive.isRequireAuthAllEndpoints) {
+        isAuthorized.runOrder = 0;
+        middlewares.unshift(isAuthorized);
+      }
+
+      targetRouter[endpoint.method?.toLowerCase() || "get"](
+        url,
+        async (ctx, next) => {
+          ctx.state.resourceName = resourceName;
+          ctx.state.endpoint = endpoint;
+          await next();
+        },
+        validate(requestSchema),
+        ..._.sortBy(middlewares, m => m.runOrder),
+        async ctx => {
+          const result = await handler(ctx);
+
+          if (!ctx.body) {
+            ctx.body = result || { isOk: true };
+          }
+        }
+      );
+    });
+
+    app.use(globalRouter.routes());
+    app.use(mount(`/${resourceName}`, resourceRouter.routes()));
+  }));
+};

package/.hive/src/routes/middlewares/attachCustomErrors.js

@@ -0,0 +1,28 @@
+import _ from 'lodash';
+
+const formatError = (customError) => {
+  const errors = {};
+
+  Object.keys(customError).forEach((key) => {
+    errors[key] = _.isArray(customError[key])
+      ? customError[key]
+      : [customError[key]];
+  });
+
+  return errors;
+};
+
+const attachCustomErrors = async (ctx, next) => {
+  ctx.throwError = (message) => ctx.throw(500, { message });
+  ctx.assertError = (condition, message) =>
+    ctx.assert(condition, 500, { message });
+
+  ctx.throwClientError = (errors) =>
+    ctx.throw(400, { errors: formatError(errors) });
+  ctx.assertClientError = (condition, errors) =>
+    ctx.assert(condition, 400, { errors: formatError(errors) });
+
+  await next();
+};
+
+export default attachCustomErrors;

package/.hive/src/routes/middlewares/routeErrorHandler.js

@@ -0,0 +1,27 @@
+import logger from 'logger';
+
+const routeErrorHandler = async (ctx, next) => {
+  try {
+    await next();
+  } catch (error) {
+    console.log("Route Error", error, error.stack);
+
+    const clientError = error.errors;
+    const serverError = { global: error.message };
+
+    const errors = clientError || serverError;
+
+    logger.error(errors);
+
+    if (serverError && (error.status === 500 || !error.status) && process.env.APP_ENV === "production") {
+      serverError.global = "Something went wrong";
+    }
+
+    ctx.state.error = error;
+
+    ctx.status = error.status || 500;
+    ctx.body = { errors };
+  }
+};
+
+export default routeErrorHandler;

package/.hive/src/scheduler/handlers/sendDailyReport.example.js

@@ -0,0 +1,7 @@
+import moment from 'moment';
+
+export const cron = "* * * * *";
+
+export const handler = () => {
+  const yesterday = moment().add(-1, "day").toDate();
+};

package/.hive/src/scheduler.js

@@ -0,0 +1,32 @@
+import path from 'path';
+import fs from 'fs';
+import moment from 'moment';
+import schedule from 'node-schedule';
+import requireDir from 'require-dir';
+
+export default () => {
+  const paths = [path.resolve(__dirname, './scheduler/handlers')];
+  if (process.env.HIVE_SRC) {
+    paths.push(path.resolve(process.env.HIVE_SRC, './scheduler/handlers'))
+  }
+
+  paths.forEach((pathName) => {
+    if (fs.existsSync(pathName)) {
+      requireDir(pathName, {
+        mapValue: (handler, handlerName) => {
+          console.log(
+            `[scheduler] Registering handler ${handlerName} with cron ${handler.cron}`
+          );
+
+          schedule.scheduleJob(handler.cron, () => {
+            console.log(
+              `[scheduler] ${moment().format()} executing ${handlerName} with cron ${handler.cron
+              }`
+            );
+            handler.handler();
+          });
+        },
+      });
+    }
+  });
+}

package/.hive/src/security.util.js

@@ -0,0 +1,38 @@
+import crypto from 'crypto';
+import bcrypt from 'bcryptjs';
+import util from 'util';
+
+const randomBytes = util.promisify(crypto.randomBytes, crypto);
+const bcryptHash = util.promisify(bcrypt.hash, bcrypt);
+const compare = util.promisify(bcrypt.compare, bcrypt);
+
+/**
+ * @desc Generates random string, useful for creating secure tokens
+ *
+ * @return {string} - random string
+ */
+export const generateSecureToken = async (tokenLength = 48) => {
+  const buf = await randomBytes(tokenLength);
+  return buf.toString("hex");
+};
+
+/**
+ * @desc Generate hash from any string. Could be used to generate a hash from password
+ *
+ * @param text {string} - a text to produce hash from
+ * @return {Promise} - a hash from input text
+ */
+export const getHash = (text) => {
+  return bcryptHash(text, 10);
+};
+
+/**
+ * @desc Compares if text and hash are equal
+ *
+ * @param text {string} - a text to compare with hash
+ * @param hash {string} - a hash to compare with text
+ * @return {Promise} - are hash and text equal
+ */
+export const compareTextWithHash = (text, hash) => {
+  return compare(text, hash);
+};

package/.hive/src/services/emailService.js

@@ -0,0 +1,15 @@
+import config from 'app-config';
+import nodemailer from 'nodemailer';
+
+config.assert('smtp');
+
+export default {
+  sendEmail: async ({ to, subject, html }) => {
+    const transporter = nodemailer.createTransport(config.smtp)
+
+    return await transporter.sendMail({
+      from: config.smtp.fromEmail,
+      to, subject, html
+    })
+  }
+};

package/.hive/src/services/setCookie.js

@@ -0,0 +1,21 @@
+import psl from 'psl';
+import url from 'url';
+import { env } from 'app-config';
+import { webUri } from 'app-config';
+
+let cookiesDomain;
+
+if (webUri) {
+  const parsedUrl = url.parse(webUri);
+  const parsed = psl.parse(parsedUrl.hostname);
+  cookiesDomain = parsed.domain;
+}
+
+export default (ctx, { name, value }, options = {}) => {
+  ctx.cookies.set(name, value, {
+    domain: '',
+    expires: new Date(Date.now() + 10 * 365 * 24 * 60 * 60 * 1000),
+    httpOnly: false,
+    ...options,
+  });
+};

package/.hive/src/socketIo.js

@@ -0,0 +1,99 @@
+import db from 'db';
+import { Server } from 'socket.io';
+import { createClient } from 'redis';
+import { createAdapter } from '@socket.io/redis-adapter';
+import config from 'app-config';
+import logger from 'logger';
+
+export default (server) => {
+  const io = new Server(server);
+
+  const pubClient = createClient({ url: config.redis.url });
+  const subClient = pubClient.duplicate();
+
+  io.adapter(createAdapter(pubClient, subClient));
+
+  const getCookie = (cookieString, name) => {
+    const value = `; ${cookieString}`;
+    const parts = value.split(`; ${name}=`);
+
+    if (parts.length === 2) {
+      return parts.pop().split(";").shift();
+    }
+
+    return null;
+  };
+
+  // #TODO get user using accessToken
+  const getUserData = async (socket) => {
+    const accessToken = getCookie(
+      socket.handshake.headers.cookie,
+      "access_token"
+    ) || '';
+
+    console.log('socket: cookie access token', accessToken[0], accessToken[1], accessToken[2]);
+
+    let tokenDoc = null;
+
+    if (!accessToken) {
+      logger.info(
+        "Note: socket io anonymous auth. Add user authentication in socketIoService"
+      );
+    } else {
+      tokenDoc = await db.services.tokens.findOne({ token: accessToken });
+    }
+
+    return {
+      _id: tokenDoc?.user?._id || "anonymous",
+    };
+  };
+
+  io.use(async (socket, next) => {
+    const userData = await getUserData(socket);
+
+    if (userData) {
+      // eslint-disable-next-line no-param-reassign
+      socket.handshake.data = {
+        userId: userData.userId,
+      };
+
+      return next();
+    }
+
+    return next(new Error("token is invalid"));
+  });
+
+  function checkAccessToRoom(roomId, data) {
+    let result = false;
+    const [roomType, id] = roomId.split("-");
+
+    switch (roomType) {
+      case "user":
+        result = id === data.userId;
+        break;
+      default:
+        result = true;
+    }
+
+    return result;
+  }
+
+  io.on("connection", (client) => {
+    client.on("subscribe", (roomId) => {
+      const { userId } = client.handshake.data;
+      // const hasAccessToRoom = checkAccessToRoom(roomId, { userId });
+      
+      const hasAccessToRoom = true;
+
+      if (hasAccessToRoom) {
+        client.join(roomId);
+      }
+    });
+
+    client.on("unsubscribe", (roomId) => {
+      client.leave(roomId);
+    });
+  });
+
+  console.log(`Socket.io server is started on app instance`);
+};

package/.hive/tsconfig.json

@@ -0,0 +1,31 @@
+{
+	"compilerOptions": {
+
+		// Treat files as modules even if it doesn't use import/export
+		"moduleDetection": "force",
+
+		// Ignore module structure
+		"module": "Preserve",
+
+		// Allow JSON modules to be imported
+		"resolveJsonModule": true,
+
+		// Allow JS files to be imported from TS and vice versa
+		"allowJs": true,
+
+		// Use correct ESM import behavior
+		"esModuleInterop": true,
+
+		// Disallow features that require cross-file awareness
+		"isolatedModules": true,
+
+    "baseUrl": "src",
+    "paths": {
+      "*": ["*"]
+    },
+	},
+ "include": [
+		"src/**/*",
+		".hive/**/*"
+	]
+}

package/cli/helpers/docker.js

@@ -0,0 +1,59 @@
+const { execSync } = require('child_process');
+
+const isDockerInstalled = () => {
+  try {
+    execSync('docker --version', { stdio: 'ignore' });
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const getContainerStatus = (name) => {
+  try {
+    const result = execSync(`docker inspect --format='{{.State.Status}}' ${name}`, { 
+      encoding: 'utf8',
+      stdio: ['pipe', 'pipe', 'ignore']
+    });
+    return result.trim();
+  } catch {
+    return null; // Container doesn't exist
+  }
+};
+
+const startContainer = async (name, image, hostPort, containerPort, extraArgs = '') => {
+  const status = getContainerStatus(name);
+
+  if (status === 'running') {
+    console.log(`  ${name} already running`);
+    return true;
+  }
+
+  if (status === 'exited' || status === 'created') {
+    console.log(`  Starting ${name}...`);
+    execSync(`docker start ${name}`, { stdio: 'inherit' });
+    return true;
+  }
+
+  // Container doesn't exist, create it
+  console.log(`  Creating ${name}...`);
+  const cmd = `docker run -d --name ${name} -p ${hostPort}:${containerPort} ${extraArgs} ${image}`;
+  execSync(cmd, { stdio: 'inherit' });
+  return true;
+};
+
+const startMongo = async () => {
+  return startContainer('hive-mongo', 'mongo:7', 27027, 27017, '-e MONGO_INITDB_DATABASE=hive');
+};
+
+const startRedis = async () => {
+  return startContainer('hive-redis', 'redis:7-alpine', 6389, 6379);
+};
+
+module.exports = {
+  isDockerInstalled,
+  getContainerStatus,
+  startContainer,
+  startMongo,
+  startRedis,
+};

package/cli/helpers/envCheck.js

@@ -0,0 +1,127 @@
+const fs = require('fs');
+const path = require('path');
+const inquirer = require('inquirer');
+
+const hashCode = (str) => {
+  let hash = 0;
+  for (let i = 0; i < str.length; i++) {
+    const char = str.charCodeAt(i);
+    hash = ((hash << 5) - hash) + char;
+    hash = hash & hash;
+  }
+  return Math.abs(hash);
+};
+
+const readEnvFile = (envPath) => {
+  if (!fs.existsSync(envPath)) {
+    return {};
+  }
+  
+  const content = fs.readFileSync(envPath, 'utf8');
+  const env = {};
+  
+  content.split('\n').forEach(line => {
+    const trimmed = line.trim();
+    if (trimmed && !trimmed.startsWith('#')) {
+      const [key, ...valueParts] = trimmed.split('=');
+      if (key) {
+        env[key.trim()] = valueParts.join('=').trim();
+      }
+    }
+  });
+  
+  return env;
+};
+
+const writeEnvFile = (envPath, env) => {
+  const content = Object.entries(env)
+    .map(([key, value]) => `${key}=${value}`)
+    .join('\n') + '\n';
+  
+  fs.writeFileSync(envPath, content);
+};
+
+const updateEnvFile = (envPath, updates) => {
+  const env = readEnvFile(envPath);
+  Object.assign(env, updates);
+  writeEnvFile(envPath, env);
+};
+
+const ensureEnvConfig = async (hiveSrc) => {
+  const appConfigDir = path.join(hiveSrc, 'app-config');
+  if (!fs.existsSync(appConfigDir)) {
+    fs.mkdirSync(appConfigDir, { recursive: true });
+  }
+  const envPath = path.join(appConfigDir, '.env');
+  const env = readEnvFile(envPath);
+  const projectName = path.basename(path.dirname(hiveSrc));
+  const updates = {};
+  
+  // Check MONGODB_URI
+  if (!env.MONGODB_URI) {
+    const { mongoChoice } = await inquirer.prompt([{
+      type: 'list',
+      name: 'mongoChoice',
+      message: 'MONGODB_URI not set. How would you like to configure MongoDB?',
+      choices: [
+        { name: 'Use local Docker (localhost:27027)', value: 'local' },
+        { name: 'Enter custom URI', value: 'custom' },
+      ]
+    }]);
+    
+    if (mongoChoice === 'local') {
+      updates.MONGODB_URI = `mongodb://localhost:27027/${projectName}`;
+    } else {
+      const { mongoUri } = await inquirer.prompt([{
+        type: 'input',
+        name: 'mongoUri',
+        message: 'Enter MongoDB URI:',
+        default: `mongodb://localhost:27027/${projectName}`
+      }]);
+      updates.MONGODB_URI = mongoUri;
+    }
+  }
+  
+  // Check REDIS_URI
+  if (!env.REDIS_URI) {
+    const { redisChoice } = await inquirer.prompt([{
+      type: 'list',
+      name: 'redisChoice',
+      message: 'REDIS_URI not set. How would you like to configure Redis?',
+      choices: [
+        { name: 'Use local Docker (localhost:6389)', value: 'local' },
+        { name: 'Enter custom URI', value: 'custom' },
+        { name: 'Skip (Redis optional)', value: 'skip' },
+      ]
+    }]);
+    
+    if (redisChoice === 'local') {
+      const redisDb = hashCode(projectName) % 16;
+      updates.REDIS_URI = `redis://localhost:6389/${redisDb}`;
+    } else if (redisChoice === 'custom') {
+      const { redisUri } = await inquirer.prompt([{
+        type: 'input',
+        name: 'redisUri',
+        message: 'Enter Redis URI:',
+        default: `redis://localhost:6389/0`
+      }]);
+      updates.REDIS_URI = redisUri;
+    }
+  }
+  
+  // Write updates if any
+  if (Object.keys(updates).length > 0) {
+    updateEnvFile(envPath, updates);
+    console.log(`\n  Updated app-config/.env with: ${Object.keys(updates).join(', ')}\n`);
+  }
+  
+  return { ...env, ...updates };
+};
+
+module.exports = {
+  readEnvFile,
+  writeEnvFile,
+  updateEnvFile,
+  ensureEnvConfig,
+  hashCode,
+};

package/cli/helpers/findPort.js

@@ -0,0 +1,32 @@
+const net = require('net');
+
+const isPortAvailable = (port) => {
+  return new Promise((resolve) => {
+    const server = net.createServer();
+
+    server.once('error', () => {
+      resolve(false);
+    });
+
+    server.once('listening', () => {
+      server.close();
+      resolve(true);
+    });
+
+    server.listen(port, '127.0.0.1');
+  });
+};
+
+const findAvailablePort = async (startPort = 3001, maxAttempts = 100) => {
+  for (let port = startPort; port < startPort + maxAttempts; port++) {
+    if (await isPortAvailable(port)) {
+      return port;
+    }
+  }
+  throw new Error(`No available port found between ${startPort} and ${startPort + maxAttempts - 1}`);
+};
+
+module.exports = {
+  isPortAvailable,
+  findAvailablePort,
+};