@opengis/fastify-table 1.3.18 → 1.3.20

package/README.md

@@ -1,87 +1,87 @@
-# fastify-table
-
-<!-- ![alt text](https://cdn.softpro.ua/data/npm/admin/opengis-admin.png) -->
-
-[![NPM version](https://img.shields.io/npm/v/@opengis/fastify-table?style=plain)](https://www.npmjs.com/package/@opengis/fastify-table)
-[![NPM last update](https://img.shields.io/npm/last-update/@opengis/fastify-table?style=plain)]()
-[![NPM downloads](https://img.shields.io/npm/dw/@opengis/fastify-table?style=plain)]()
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=plain)](http://standardjs.com/)
-
-This is a backend toolkit for database management and more.
-
-### Why fastify-table?
-
-- **Logger** - Monitoring user activity and system status.
-- **Redis cache** - Optimizes web page rendering for lightning-fast performance.
-- **Secure** - Ensures protection against XSS attacks in queries.
-- **SQL Migration** - Automatically adds all necessary tables to your project's database.
-
-
-### Features 
-
-- CRUD
-- cron
-- Logger
-- Redis
-- pg
-
----
-
-### Install
-
-```bash
-npm i @opengis/fastify-table
-```
-
-### Usage
-
-```js
-fastify.register(import('@opengis/fastify-table'), config);
-```
-
----
-
-### Documenation
-
-For a detailed understanding `fastify-table`, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/fastify-table/).
-
----
-
-### Technology stack
-
-<a href="https://fastify.dev/" target="_blank">
-<img src="https://img.shields.io/badge/Fastify-323330?style=for-the-badge&logo=fastify" /></a>
-
-<a href="https://www.postgresql.org/" target="_blank">
-<img src="https://img.shields.io/badge/PostgreSQL-323330?style=for-the-badge&logo=postgresql&logoColor=white" /></a>
-
-<a href="https://redis.io/" target="_blank">
-<img src="https://img.shields.io/badge/redis-323330.svg?&style=for-the-badge&logo=redis&logoColor=" /></a>
-
-<a href="https://www.npmjs.com/package/pino" target="_blank">
-<img src="https://img.shields.io/badge/pino-323330.svg?&style=for-the-badge&logo=pino&logoColor=" /></a>
-
----
-
-### Contribute
-
-Feel free to contact us through our website [SOFTPRO.UA](https://softpro.ua) or email <info@softpro.ua>
-
-- Report bugs
-- Share your ideas
-- Ask questions
-
-### Follow Us
-
-[Official site](https://softpro.ua)
-
-<p>
-  <a href="https://www.instagram.com/gissoftpro/" target="_blank"><img src="https://cdn.softpro.ua/data/npm/instagram.png" alt="Softpro Instagram" title="oftpro Instagram"></a>&nbsp;&nbsp;
-  <a href="https://www.facebook.com/gissoftpro" target="_blank"><img src="https://cdn.softpro.ua/data/npm/facebook.png" alt="Softpro Facebook" title="Softpro Facebook"></a>&nbsp;&nbsp;
-  <a href="https://t.me/softprogis" target="_blank"><img src="https://cdn.softpro.ua/data/npm/telegram.png" alt="Softpro Telegram" title="Softpro Telegram"></a>&nbsp;&nbsp;
-  <a href="https://www.linkedin.com/in/softpro-ukraine-a8876b282/recent-activity/all/" target="_blank"><img src="https://cdn.softpro.ua/data/npm/social/linkedin.png" alt="Softpro Linkedin" title="Softpro LinkedIn"></a>&nbsp;&nbsp;
-</p>
-
-### License
-
+# fastify-table
+
+<!-- ![alt text](https://cdn.softpro.ua/data/npm/admin/opengis-admin.png) -->
+
+[![NPM version](https://img.shields.io/npm/v/@opengis/fastify-table?style=plain)](https://www.npmjs.com/package/@opengis/fastify-table)
+[![NPM last update](https://img.shields.io/npm/last-update/@opengis/fastify-table?style=plain)]()
+[![NPM downloads](https://img.shields.io/npm/dw/@opengis/fastify-table?style=plain)]()
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=plain)](http://standardjs.com/)
+
+This is a backend toolkit for database management and more.
+
+### Why fastify-table?
+
+- **Logger** - Monitoring user activity and system status.
+- **Redis cache** - Optimizes web page rendering for lightning-fast performance.
+- **Secure** - Ensures protection against XSS attacks in queries.
+- **SQL Migration** - Automatically adds all necessary tables to your project's database.
+
+
+### Features 
+
+- CRUD
+- cron
+- Logger
+- Redis
+- pg
+
+---
+
+### Install
+
+```bash
+npm i @opengis/fastify-table
+```
+
+### Usage
+
+```js
+fastify.register(import('@opengis/fastify-table'), config);
+```
+
+---
+
+### Documenation
+
+For a detailed understanding `fastify-table`, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/fastify-table/).
+
+---
+
+### Technology stack
+
+<a href="https://fastify.dev/" target="_blank">
+<img src="https://img.shields.io/badge/Fastify-323330?style=for-the-badge&logo=fastify" /></a>
+
+<a href="https://www.postgresql.org/" target="_blank">
+<img src="https://img.shields.io/badge/PostgreSQL-323330?style=for-the-badge&logo=postgresql&logoColor=white" /></a>
+
+<a href="https://redis.io/" target="_blank">
+<img src="https://img.shields.io/badge/redis-323330.svg?&style=for-the-badge&logo=redis&logoColor=" /></a>
+
+<a href="https://www.npmjs.com/package/pino" target="_blank">
+<img src="https://img.shields.io/badge/pino-323330.svg?&style=for-the-badge&logo=pino&logoColor=" /></a>
+
+---
+
+### Contribute
+
+Feel free to contact us through our website [SOFTPRO.UA](https://softpro.ua) or email <info@softpro.ua>
+
+- Report bugs
+- Share your ideas
+- Ask questions
+
+### Follow Us
+
+[Official site](https://softpro.ua)
+
+<p>
+  <a href="https://www.instagram.com/gissoftpro/" target="_blank"><img src="https://cdn.softpro.ua/data/npm/instagram.png" alt="Softpro Instagram" title="oftpro Instagram"></a>&nbsp;&nbsp;
+  <a href="https://www.facebook.com/gissoftpro" target="_blank"><img src="https://cdn.softpro.ua/data/npm/facebook.png" alt="Softpro Facebook" title="Softpro Facebook"></a>&nbsp;&nbsp;
+  <a href="https://t.me/softprogis" target="_blank"><img src="https://cdn.softpro.ua/data/npm/telegram.png" alt="Softpro Telegram" title="Softpro Telegram"></a>&nbsp;&nbsp;
+  <a href="https://www.linkedin.com/in/softpro-ukraine-a8876b282/recent-activity/all/" target="_blank"><img src="https://cdn.softpro.ua/data/npm/social/linkedin.png" alt="Softpro Linkedin" title="Softpro LinkedIn"></a>&nbsp;&nbsp;
+</p>
+
+### License
+
 Copyright © SOFTPRO. All rights reserved.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengis/fastify-table",
-  "version": "1.3.18",
+  "version": "1.3.20",
   "type": "module",
   "description": "core-plugins",
   "keywords": [

package/server/plugins/cron/funcs/addCron.js

@@ -1,130 +1,52 @@
-import { createHash } from 'crypto';
-
-import config from '../../../../config.js';
-import getRedis from '../../redis/funcs/getRedis.js';
-import getPG from '../../pg/funcs/getPG.js';
-import logger from '../../logger/getLogger.js';
-import cronList from '../cronList.js';
-
-const md5 = (string) => createHash('md5').update(string).digest('hex');
-
-const rclient = getRedis();
-async function verifyUnique(name) {
-  const cronId = config.port || 3000 + md5(name);
-  // one per node check
-  const key = `cron:unique:${cronId}`;
-  const unique = await rclient.setnx(key, 1);
-  const ttl = await rclient.ttl(key);
-  if (!unique && ttl !== -1) {
-    return false;
-  }
-  await rclient.expire(key, 20);
-  return true;
-}
-
-const intervalStringMs = {
-  everyMin: 1000 * 60,
-  tenMin: 1000 * 60 * 10,
-  everyHour: 1000 * 60 * 60,
-  isHalfday: 1000 * 60 * 60 * 12,
-  dailyHour: 1000 * 60 * 60 * 24,
-};
-
-const interval2ms = {
-  string: (interval) => {
-    const date = new Date();
-    const intervarSplit = interval.match(/^(\*{2}|(\*)?(\d{1,2})):(\*(\d)|(\d{2}))/);
-    if (!intervarSplit) {
-      throw new Error(`interval ${interval} not suported`);
-    }
-    const [, , isHalfday, dailyHour, , tenMin, HourlyMin] = intervarSplit;
-    const intervalMs = (isHalfday && intervalStringMs.isHalfday)
-      || (dailyHour && intervalStringMs.dailyHour)
-      || (tenMin && intervalStringMs.tenMin)
-      || intervalStringMs.everyHour;
-    const offsetDay = ((+dailyHour || 0) * 60 + (+tenMin || +HourlyMin)) * 60 * 1000;
-    const offsetCur = (date - date.getTimezoneOffset() * 1000 * 60) % intervalMs;
-    const waitMs = (offsetDay - offsetCur + intervalMs) % intervalMs;
-    return [waitMs, intervalMs];
-  },
-  number: (interval) => {
-    const date = new Date();
-    const intervalMs = interval * 1000;
-    const dateWithTZ = date - date.getTimezoneOffset() * 1000 * 60;
-    const offsetCur = dateWithTZ % intervalMs;
-    // start every cron within 1 hour
-    const sixtyMinutesStartMs = 3600000;
-    const waitMs = (intervalMs - offsetCur) % sixtyMinutesStartMs;
-    return [waitMs, intervalMs];
-  },
-};
-
-async function runCron({
-  func, name,
-}) {
-  const pg = getPG();
-
-  const unique = await verifyUnique(name);
-
-  if (!unique) return;
-  const db = pg.options.database;
-
-  try {
-    // console.log(`cron:${name}`);
-    const data = await func({ pg });
-    const subdir = !!data ? 'cron' : 'cron/null';
-    logger.file(subdir, {
-      db, name, result: data,
-    });
-  }
-  catch (err) {
-    logger.file('cron', {
-      db, name, error: err.toString(),
-    });
-    logger.error(err);
-  }
-}
-
-/**
- * interval:
- * -   02:54 - every day
- * -    2:03 - every day
- * -   *1:43 - 2 times a day
- * -  *12:03 - 2 times a day
- * -   **:54 - every hour
- * -   **:*3 - every 10 minutes
- * -      60 - every minute
- * - 10 * 60 - every 10 minutes
- */
-
-export default async function addCron(func, interval) {
-  const { time = {}, disabled = [] } = config.cron || {};
-
-  const name = func.name || func.toString().split('/').at(-1).split('\'')[0];
-
-  // if (!config.isServer) return;
-
-  if (disabled.includes(name)) {
-    logger.file('cron', { name, message: 'cron disabled' });
-    return;
-  }
-
-  cronList[name] = func;
-
-  const userInterval = time[name] || interval;
-  const [waitMs, intervalMs] = interval2ms[typeof interval](userInterval);
-
-  if (intervalMs < 1000) {
-    logger.file('cron', { name, error: `interval ${interval} to small` });
-    return;
-  }
-
-  // setTimeout to w8 for the time to start
-  setTimeout(() => {
-    runCron({ func, name });
-    // interval
-    setInterval(() => {
-      runCron({ func, name });
-    }, intervalMs);
-  }, waitMs);
-}
+import config from '../../../../config.js';
+
+import logger from '../../logger/getLogger.js';
+import pgClients from '../../pg/pgClients.js';
+
+import cronList from '../cronList.js';
+import runCron from './runCron.js';
+import interval2ms from './interval2ms.js';
+
+/**
+ * interval:
+ * -   02:54 - every day
+ * -    2:03 - every day
+ * -   *1:43 - 2 times a day
+ * -  *12:03 - 2 times a day
+ * -   **:54 - every hour
+ * -   **:*3 - every 10 minutes
+ * -      60 - every minute
+ * - 10 * 60 - every 10 minutes
+ */
+
+export default async function addCron(func, interval, pg = pgClients.client) {
+  const { time = {}, disabled = [] } = config.cron || {};
+
+  const name = func.name || func.toString().split('/').at(-1).split('\'')[0];
+
+  // if (!config.isServer) return;
+
+  if (disabled.includes(name)) {
+    logger.file('cron', { name, message: 'cron disabled' });
+    return;
+  }
+
+  cronList[name] = func;
+
+  const userInterval = time[name] || interval;
+  const [waitMs, intervalMs] = interval2ms[typeof interval](userInterval);
+
+  if (intervalMs < 1000) {
+    logger.file('cron', { name, error: `interval ${interval} too small` });
+    return;
+  }
+
+  // setTimeout to w8 for the time to start
+  setTimeout(() => {
+    runCron({ pg, func, name });
+    // interval
+    setInterval(() => {
+      runCron({ pg, func, name });
+    }, intervalMs);
+  }, waitMs);
+}

package/server/plugins/cron/funcs/interval2ms.js

@@ -0,0 +1,40 @@
+const intervalStringMs = {
+    everyMin: 1000 * 60,
+    tenMin: 1000 * 60 * 10,
+    everyHour: 1000 * 60 * 60,
+    isHalfday: 1000 * 60 * 60 * 12,
+    dailyHour: 1000 * 60 * 60 * 24,
+};
+
+const interval2ms = {
+    string: (interval) => {
+        const date = new Date();
+        const intervarSplit = interval.match(/^(\*{2}|(\*)?(\d{1,2})):(\*(\d)|(\d{2}))/);
+
+        if (!intervarSplit) {
+            throw new Error(`interval ${interval} not suported`);
+        }
+
+        const [, , isHalfday, dailyHour, , tenMin, HourlyMin] = intervarSplit;
+        const intervalMs = (isHalfday && intervalStringMs.isHalfday)
+            || (dailyHour && intervalStringMs.dailyHour)
+            || (tenMin && intervalStringMs.tenMin)
+            || intervalStringMs.everyHour;
+        const offsetDay = ((+dailyHour || 0) * 60 + (+tenMin || +HourlyMin)) * 60 * 1000;
+        const offsetCur = (date - date.getTimezoneOffset() * 1000 * 60) % intervalMs;
+        const waitMs = (offsetDay - offsetCur + intervalMs) % intervalMs;
+        return [waitMs, intervalMs];
+    },
+    number: (interval) => {
+        const date = new Date();
+        const intervalMs = interval * 1000;
+        const dateWithTZ = date - date.getTimezoneOffset() * 1000 * 60;
+        const offsetCur = dateWithTZ % intervalMs;
+        // start every cron within 1 hour
+        const sixtyMinutesStartMs = 3600000;
+        const waitMs = (intervalMs - offsetCur) % sixtyMinutesStartMs;
+        return [waitMs, intervalMs];
+    },
+};
+
+export default interval2ms;

package/server/plugins/cron/funcs/runCron.js

@@ -0,0 +1,23 @@
+import logger from '../../logger/getLogger.js';
+import pgClients from '../../pg/pgClients.js';
+
+import verifyUnique from './verifyUnique.js';
+
+export default async function runCron({
+    pg = pgClients.client, func, name,
+}) {
+    const unique = await verifyUnique(name);
+    if (!unique) return;
+
+    const db = pg.options.database;
+
+    try {
+        const data = await func({ pg });
+        const subdir = !!data ? 'cron' : 'cron/null';
+        logger.file(subdir, { db, name, result: data });
+    }
+    catch (err) {
+        logger.file('cron', { db, name, error: err.toString() });
+        logger.error(err);
+    }
+}

package/server/plugins/cron/funcs/verifyUnique.js

@@ -0,0 +1,22 @@
+import { createHash } from 'node:crypto';
+
+import config from '../../../../config.js';
+
+import getRedis from '../../redis/funcs/getRedis.js';
+
+const md5 = (string) => createHash('md5').update(string).digest('hex');
+
+const rclient = getRedis();
+
+export default async function verifyUnique(name) {
+    const cronId = config.port || 3000 + md5(name);
+    // one per node check
+    const key = `cron:unique:${cronId}`;
+    const unique = await rclient.setnx(key, 1);
+    const ttl = await rclient.ttl(key);
+    if (!unique && ttl !== -1) {
+        return false;
+    }
+    await rclient.expire(key, 20);
+    return true;
+}

package/server/plugins/cron/index.js

@@ -1,6 +1,74 @@
-import addCron from './funcs/addCron.js';
-
-async function plugin(fastify) {
-//   fastify.decorate('addCron', addCron);
-}
-export default plugin;
+import { createHash } from 'node:crypto';
+
+import config from "../../../config.js";
+
+import getPG from "../pg/funcs/getPG.js";
+import pgClients from "../pg/pgClients.js";
+import getRedis from '../redis/funcs/getRedis.js';
+import logger from "../logger/getLogger.js";
+import interval2ms from "./funcs/interval2ms.js";
+
+const rclient = getRedis();
+
+async function runCron({
+    pg = pgClients.client, query, name,
+}) {
+    const db = pg.options.database;
+
+    // verifyUnique
+    const key = `cron:unique:${name}`;
+    const unique = await rclient.setnx(key, 1);
+    const ttl = await rclient.ttl(key);
+
+    if (!unique && ttl !== -1) {
+        // if (config.trace) console.log(name, db, query, 'skip unique');
+        return;
+    }
+
+    await rclient.expire(key, 20);
+
+    try {
+        if (!pg.pk) await pg.init();
+
+        if (config.trace) console.time(`${db}:${query}`);
+        const { command, rows = [], rowCount } = await pg.query(query);
+        if (config.trace) console.timeEnd(`${db}:${query}`);
+
+        logger.file('cron', { db, name, result: { command, rows, rowCount } });
+    }
+    catch (err) {
+        if (config.trace) console.error(name, err.toString());
+        logger.file('cron/error', { db, name, error: err.toString() });
+        logger.error(err);
+    }
+}
+
+async function plugin(fastify) {
+    if (config.cronList?.length) {
+        config.cronList?.filter(el => el.query && !el.disabled)?.forEach?.((el, idx) => {
+            const { interval, db, query } = el;
+            const name = createHash('md5').update(`${config.port || 3000}:${db}:${query}`).digest('hex');
+            const pg = getPG(db);
+
+            if (config.trace) console.log('cron-list: init', db, idx);
+
+            const [waitMs, intervalMs] = interval2ms[typeof interval](interval);
+
+            if (intervalMs < 1000) {
+                if (config.trace) console.error('cron-list: skip too small interval', db, idx);
+                logger.file('cron', { name, error: `interval ${interval} too small` });
+                return;
+            }
+
+            // setTimeout to w8 for the time to start
+            setTimeout(() => {
+                runCron({ pg, query, name });
+                // interval
+                setInterval(() => {
+                    runCron({ pg, query, name });
+                }, intervalMs);
+            }, waitMs);
+        });
+    }
+}
+export default plugin;

package/server/plugins/crud/funcs/getOpt.js

@@ -1,13 +1,13 @@
-import getRedis from '../../redis/funcs/getRedis.js';
-
-// import { getRedis } from '../../../../utils.js';
-
-export default async function getOpt(token, uid = 0) {
-  const rclient = getRedis({ db: 0 });
-
-  const key = `opt:${uid}:${token}`;
-  // console.log(key);
-  const data = await rclient.get(key);
-  if (!data) return null;
-  return JSON.parse(data);
-}
+import getRedis from '../../redis/funcs/getRedis.js';
+
+// import { getRedis } from '../../../../utils.js';
+
+export default async function getOpt(token, uid = 0) {
+  const rclient = getRedis({ db: 0 });
+
+  const key = `opt:${uid}:${token}`;
+  // console.log(key);
+  const data = await rclient.get(key);
+  if (!data) return null;
+  return JSON.parse(data);
+}

package/server/plugins/crud/funcs/setOpt.js

@@ -1,21 +1,21 @@
-import { createHash, randomUUID } from 'crypto';
-
-const random = randomUUID();
-
-import getRedis from '../../redis/funcs/getRedis.js';
-
-// import { getRedis } from '../../../../utils.js';
-
-function md5(string) {
-  return createHash('md5').update(string).digest('hex');
-}
-
-export default function setOpt(params, uid = 0) {
-  const token = Buffer.from(md5(typeof params === 'object' ? JSON.stringify(params) : params) + random, 'hex').toString('base64').replace(/[+-=]+/g, '');
-  // const token = md5(params);
-  const key = `opt:${uid}:${token}`;
-
-  const rclient = getRedis({ db: 0 });
-  rclient.set(key, JSON.stringify(params), 'EX', 60 * 60);
-  return token;
-}
+import { createHash, randomUUID } from 'crypto';
+
+const random = randomUUID();
+
+import getRedis from '../../redis/funcs/getRedis.js';
+
+// import { getRedis } from '../../../../utils.js';
+
+function md5(string) {
+  return createHash('md5').update(string).digest('hex');
+}
+
+export default function setOpt(params, uid = 0) {
+  const token = Buffer.from(md5(typeof params === 'object' ? JSON.stringify(params) : params) + random, 'hex').toString('base64').replace(/[+-=]+/g, '');
+  // const token = md5(params);
+  const key = `opt:${uid}:${token}`;
+
+  const rclient = getRedis({ db: 0 });
+  rclient.set(key, JSON.stringify(params), 'EX', 60 * 60);
+  return token;
+}