@opengis/fastify-table 1.1.17 → 1.1.18

package/Changelog.md

@@ -1,5 +1,9 @@
 # fastify-table
 
+## 1.1.18 - 01.10.2024
+
+- custom hook support - addHook, applyHook
+
 ## 1.1.17 - 30.09.2024
 
 - add relkinds to pg

package/hook/funcs/addHook.js

@@ -0,0 +1,8 @@
+import hookList from './hookList.js';
+
+export default function addHook(name, fn) {
+  if (!hookList[name]) {
+    hookList[name] = [];
+  }
+  hookList[name].push(fn);
+}

package/hook/funcs/applyHook.js

@@ -0,0 +1,24 @@
+import config from '../../config.js';
+import hookList from './hookList.js';
+
+export default async function applyHook(name, data) {
+  const debug = config.local || config.debug;
+  if (debug) console.log('applyHook', name);
+  if (!hookList[name]?.length) return null;
+  const result = {};
+  await Promise.all(hookList[name].map(async (hook) => {
+    const hookData = await hook({ ...data, config });
+    if (hookData) {
+      if (debug) console.log('applyHook', name, hookData);
+      Object.assign(result, hookData);
+    }
+  })).catch((err) => {
+    console.error('applyHook', name, err.toString());
+  });
+
+  if (Object.keys(result).length) {
+    return result;
+  }
+
+  return null;
+}

package/hook/funcs/hookList.js

@@ -0,0 +1 @@
+export default {};

package/hook/index.js

@@ -0,0 +1,6 @@
+import addHook from './funcs/addHook.js';
+import applyHook from './funcs/applyHook.js';
+
+export default async function plugin(fastify, opts) {
+  fastify.decorate('hook', { add: addHook, apply: applyHook });
+}

package/index.js

@@ -14,6 +14,7 @@ import crudPlugin from './crud/index.js';
 import policyPlugin from './policy/index.js';
 import utilPlugin from './util/index.js';
 import cronPlugin from './cron/index.js';
+import hookPlugin from './hook/index.js';
 
 import pgClients from './pg/pgClients.js';
 
@@ -92,6 +93,7 @@ async function plugin(fastify, opt) {
   widgetPlugin(fastify, opt);
   utilPlugin(fastify, opt);
   cronPlugin(fastify, opt);
+  hookPlugin(fastify, opt);
 }
 export default fp(plugin);
 // export { rclient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengis/fastify-table",
-  "version": "1.1.17",
+  "version": "1.1.18",
   "type": "module",
   "description": "core-plugins",
   "main": "index.js",

package/table/controllers/data.js

@@ -6,16 +6,24 @@ import getAccess from '../../crud/funcs/getAccess.js';
 import setToken from '../../crud/funcs/setToken.js';
 import gisIRColumn from './utils/gisIRColumn.js';
 
+import { applyHook } from '../../utils.js';
+
 const maxLimit = 100;
-export default async function dataAPI({
-  pg, params, funcs = {}, query = {}, opt = {}, uid: uid1, req, session,
-}) {
+export default async function dataAPI(req) {
+  const {
+    pg, params, funcs = {}, query = {}, opt = {}, uid: uid1, session,
+  } = req;
   const time = Date.now();
 
   const uid = session?.passport?.user?.uid || uid1 || query.uid || 0;
 
   const loadTable = await getTemplate('table', params.table);
 
+  const check = await applyHook('preData', { req });
+  if (check?.message && check?.status) {
+    return { message: check?.message, status: check?.status };
+  }
+
   if (!loadTable) { return { message: 'template not found', status: 404 }; }
 
   const {
@@ -104,5 +112,7 @@ export default async function dataAPI({
     });
   }
 
-  return res;
+  const result = await applyHook('afterData', { req, table: loadTable.table, res });
+
+  return result || res;
 }

package/table/controllers/table.js

@@ -1,9 +1,11 @@
 import getTemplate from './utils/getTemplate.js';
 import getMeta from '../../pg/funcs/getMeta.js';
 
+import { applyHook } from '../../utils.js';
+
 export default async function tableAPI(req) {
   const {
-    pg, params = {}, query = {}, opt = {},
+    pg, params = {}, query = {}, opt = {}, funcs,
   } = req;
   if (!params.id) return { message: 'not enough params', status: 400 };
 
@@ -12,6 +14,11 @@ export default async function tableAPI(req) {
     if (!pg.pk?.[opt?.table || params.table]) { return { message: 'not found', status: 404 }; }
   }
 
+  const check = await applyHook('preTable', { req });
+  if (check?.message && check?.status) {
+    return { message: check?.message, status: check?.status };
+  }
+
   const {
     table, /* columns, */ form,
   } = loadTable;
@@ -48,5 +55,6 @@ export default async function tableAPI(req) {
     }));
   }
 
-  return rows?.[0] || {};
+  const res = await applyHook('afterTable', { req, table: loadTable?.table, rows });
+  return res || rows?.[0] || {};
 }

package/test/api/applyHook.test.js

@@ -0,0 +1,96 @@
+import { test } from 'node:test';
+import assert from 'node:assert';
+import path from 'node:path';
+import pgClients from '../../pg/pgClients.js';
+import init from '../../pg/funcs/init.js';
+
+import build from '../../helper.js';
+import config from '../config.js';
+
+import { addTemplateDir, addHook } from '../../utils.js';
+
+const prefix = config.prefix || '/api';
+const table = 'gis.dataset.table';
+
+test('applyHook to API data/table', async (t) => {
+  const app = await build(t);
+  const cwd = process.cwd();
+  await init(pgClients.client);
+  addTemplateDir(path.join(cwd, 'test/templates'));
+
+  addHook('preData', async ({ req }) => {
+    if (req.params?.table === `${table}1`) {
+      return { message: 'access restricted by hook', status: 403 };
+    }
+    return null;
+  });
+  addHook('preTable', async ({ req }) => {
+    const { params = {} } = req;
+    if (params?.table === `${table}1`) {
+      return { message: 'access restricted by hook', status: 403 };
+    }
+    return null;
+  });
+
+  addHook('afterData', async ({ res }) => {
+    Object.assign(res, { test: '1' });
+  });
+  addHook('afterTable', async ({ rows = [] }) => {
+    Object.assign(rows[0], { count: 1 });
+  });
+
+  await t.test('GET /data (preData ok)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/data/${table}`,
+    });
+    const json = res.json();
+    assert.ok(json?.time, 'api error');
+  });
+  await t.test('GET /data (preData message)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/data/${table}1`,
+    });
+    const json = res.json();
+    assert.ok(json.message === 'access restricted by hook', 'preData hook error');
+  });
+
+  await t.test('GET /data (afterData)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/data/${table}`,
+    });
+    const json = res.json();
+    assert.ok(json?.test === '1', 'afterData hook error');
+  });
+
+  const { id = '1' } = pgClients.client?.pk['gis.dataset']
+    ? await pgClients.client.query('select dataset_id as id from gis.dataset limit 1')
+      .then((res) => res.rows?.[0] || {}) : {};
+  await t.test('GET /table/:id (preTable ok)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/table/${table}1/${id}`,
+    });
+    const json = res.json();
+    assert.ok(json.message === 'access restricted by hook', 'preTable hook error');
+  });
+  await t.test('GET /table/:id (preTable message)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/table/${table}1/${id}`,
+    });
+    const json = res.json();
+    assert.ok(json.message === 'access restricted by hook', 'preTable hook error');
+  });
+
+  await t.test('GET /table/:id (afterTable)', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/table/${table}/${id}`,
+    });
+    const json = res.json();
+    assert.equal(json?.count, 1);
+  });
+});

package/utils.js

@@ -24,6 +24,8 @@ import gisIRColumn from './table/controllers/utils/gisIRColumn.js';
 import getMeta from './pg/funcs/getMeta.js';
 import getAccess from './crud/funcs/getAccess.js';
 import getSelectVal from './table/funcs/metaFormat/getSelectVal.js';
+import applyHook from './hook/funcs/applyHook.js';
+import addHook from './hook/funcs/addHook.js';
 
 export default null;
 export {
@@ -47,4 +49,6 @@ export {
   getMeta,
   getAccess,
   getSelectVal,
+  applyHook,
+  addHook,
 };