Modification to be use audit component in open-pryv.io

Perki · Perki · commit eefceddec421 · 2025-05-19T16:01:45.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 
 ## 1.9
 
+### 1.9.3
+- Modifications to allow usage of Audit in Open-Pryv.io
+
 ### 1.9.2
 - Refactored Attachments (Event Files) Logic to b modular
 
diff --git a/components/api-server/src/API.js b/components/api-server/src/API.js
@@ -12,7 +12,7 @@ const Result = require('./Result');
 const _ = require('lodash');
 const { getConfigUnsafe } = require('@pryv/boiler');
 
-let audit, throwIfMethodIsNotDeclared, isOpenSource, isAuditActive;
+let audit, throwIfMethodIsNotDeclared, isAuditActive;
 
 // When storing full events.get request instead of streaming it, the maximum
 // array size before returning an error.
@@ -65,8 +65,7 @@ class API {
     this.map = new Map();
     this.filters = [];
     const config = getConfigUnsafe();
-    isOpenSource = config.get('openSource:isActive');
-    isAuditActive = !isOpenSource && config.get('audit:active');
+    isAuditActive = config.get('audit:active');
     if (isAuditActive) {
       audit = require('audit');
       throwIfMethodIsNotDeclared =
diff --git a/components/api-server/src/application.js b/components/api-server/src/application.js
@@ -132,7 +132,7 @@ class Application {
     logger.debug('Init started');
     this.config = await getConfig();
     this.isOpenSource = this.config.get('openSource:isActive');
-    this.isAuditActive = !this.isOpenSource && this.config.get('audit:active');
+    this.isAuditActive = this.config.get('audit:active');
     await userLocalDirectory.init();
     if (this.isAuditActive) {
       const audit = require('audit');
diff --git a/components/api-server/src/methods/accesses.js b/components/api-server/src/methods/accesses.js
@@ -56,7 +56,6 @@ const { integrity } = require('business');
 
 module.exports = async function produceAccessesApiMethods (api) {
   const config = await getConfig();
-  const isOpenSource = config.get('openSource:isActive');
   const dbFindOptions = { projection: { calls: 0, deleted: 0 } };
   const mall = await getMall();
   const storageLayer = await getStorageLayer();
@@ -589,7 +588,6 @@ module.exports = async function produceAccessesApiMethods (api) {
         integrity: result.access.integrity
       };
       if (process.env.NODE_ENV === 'test' &&
-                !isOpenSource &&
                 integrity.accesses.isActive) {
         // double check integrity when running tests only
         if (result.access.integrity !== integrity.accesses.hash(result.access)) {
diff --git a/components/api-server/src/methods/utility.js b/components/api-server/src/methods/utility.js
@@ -20,8 +20,7 @@ const updateAccessUsageStats = require('./helpers/updateAccessUsageStats');
 module.exports = async function (api) {
   const logger = getLogger('methods:batch');
   const config = await getConfig();
-  const isOpenSource = config.get('openSource:isActive');
-  const isAuditActive = !isOpenSource && config.get('audit:active');
+  const isAuditActive = config.get('audit:active');
   const updateAccessUsage = await updateAccessUsageStats();
   const passwordRules = await getPasswordRules();
   let audit;
diff --git a/components/api-server/src/middleware/attachment-access.js b/components/api-server/src/middleware/attachment-access.js
@@ -22,8 +22,7 @@ async function middlewareFactory () {
   config = await getConfig();
   mall = await getMall();
   // -- Audit
-  isAuditActive =
-        !config.get('openSource:isActive') && config.get('audit:active');
+  isAuditActive = config.get('audit:active');
   if (isAuditActive) {
     const throwIfMethodIsNotDeclared = require('audit/src/ApiMethods').throwIfMethodIsNotDeclared;
     throwIfMethodIsNotDeclared('events.getAttachment');
diff --git a/components/api-server/src/middleware/errors.js b/components/api-server/src/middleware/errors.js
@@ -26,7 +26,7 @@ module.exports = produceHandleErrorMiddleware;
 function produceHandleErrorMiddleware (logging) {
   const logger = logging.getLogger('error-middleware');
   const config = getConfigUnsafe();
-  const isAuditActive = !config.get('openSource:isActive') && config.get('audit:active');
+  const isAuditActive = config.get('audit:active');
   let audit;
   if (isAuditActive) {
     audit = require('audit');
diff --git a/components/api-server/src/server.js b/components/api-server/src/server.js
@@ -41,6 +41,7 @@ class Server {
     const config = await getConfig();
     this.config = config;
     this.isOpenSource = config.get('openSource:isActive');
+    this.isAuditActive = config.get('audit:active');
     const defaultParam = this.findDefaultParam();
     if (defaultParam != null) {
       this.logger.error(`Config parameter "${defaultParam}" has a default value, please change it`);
@@ -116,7 +117,7 @@ class Server {
     await require('./methods/profile')(app.api);
     await require('./methods/streams')(app.api);
     await require('./methods/events')(app.api);
-    if (!this.isOpenSource) {
+    if (this.isAuditActive) {
       require('audit/src/methods/audit-logs')(app.api);
     }
     this.logger.debug('api methods registered');
diff --git a/components/api-server/test/acceptance/events-audit.test.js b/components/api-server/test/acceptance/events-audit.test.js
@@ -13,7 +13,7 @@ const cuid = require('cuid');
 const { assert } = require('chai');
 const SystemStreamsSerializer = require('business/src/system-streams/serializer');
 
-describe('Audit logs events', () => {
+describe('[AUDI] Audit logs events', () => {
   let config;
   let mongoFixtures;
   let server;
@@ -23,7 +23,7 @@ describe('Audit logs events', () => {
   before(async function () {
     config = await getConfig();
     await SystemStreamsSerializer.init();
-    if (config.get('openSource:isActive')) this.skip();
+    if (!config.get('audit:active')) this.skip();
 
     mongoFixtures = databaseFixture(await produceMongoConnection());
 
diff --git a/components/api-server/test/deletion.test.js b/components/api-server/test/deletion.test.js
@@ -38,13 +38,15 @@ let influx;
 let influxRepository;
 let config;
 let isOpenSource = false;
+let isAuditActive = false;
 let regUrl;
 let mall;
 describe('[PGTD] DELETE /users/:username', () => {
   before(async function () {
     config = await getConfig();
     regUrl = config.get('services:register:url');
     isOpenSource = config.get('openSource:isActive');
+    isAuditActive = config.get('audit:active');
     app = getApplication();
     await app.initiate();
     await require('api-server/src/methods/auth/delete')(app.api);
@@ -258,7 +260,7 @@ describe('[PGTD] DELETE /users/:username', () => {
           assert.isFalse(isFound);
         });
         it(`[${testIDs[i][9]}] should delete user audit events`, async function () {
-          if (isOpenSource) this.skip();
+          if (!isAuditActive) this.skip();
           const pathToUserAuditData = require('storage').userLocalDirectory.getPathForUser(userToDelete.attrs.id);
           const userFileExists = fs.existsSync(pathToUserAuditData);
           assert.isFalse(userFileExists);
diff --git a/components/api-server/test/helpers/validation.js b/components/api-server/test/helpers/validation.js
@@ -18,7 +18,6 @@ const util = require('util');
 const _ = require('lodash');
 const SystemStreamsSerializer = require('business/src/system-streams/serializer');
 const { integrity } = require('business');
-const isOpenSource = require('@pryv/boiler').getConfigUnsafe('true').get('openSource:isActive');
 
 /**
  * Expose common JSON schemas.
@@ -104,7 +103,6 @@ function checkEventDeletionIntegrity (e) {
 
 function checkEventIntegrity (e) {
   if (!integrity.events.isActive) return;
-  if (isOpenSource) return;
   const int = integrity.events.hash(e);
   if (e.integrity !== int) {
     throw (new Error('Received item with bad integrity checkum. \nexpected [' + int + '] \ngot: \n' + JSON.stringify(e, null, 2)));
@@ -113,7 +111,6 @@ function checkEventIntegrity (e) {
 
 function checkAccessIntegrity (access) {
   if (!integrity.accesses.isActive) return;
-  if (isOpenSource) return;
   const int = integrity.accesses.hash(access);
   if (access.integrity !== int) {
     throw (new Error('Received item with bad integrity checkum. \nexpected [' + int + '] \ngot: \n' + JSON.stringify(access, null, 2)));
diff --git a/components/api-server/test/permissions-create-only.test.js b/components/api-server/test/permissions-create-only.test.js
@@ -24,7 +24,7 @@ describe('permissions create-only level', () => {
   before(async function () {
     mongoFixtures = databaseFixture(await produceMongoConnection());
     const config = await getConfig();
-    isAuditActive = (!config.get('openSource:isActive')) && config.get('audit:active');
+    isAuditActive = config.get('audit:active');
   });
   after(async () => {
     await mongoFixtures.clean();
diff --git a/components/api-server/test/permissions.test.js b/components/api-server/test/permissions.test.js
@@ -25,7 +25,7 @@ let isAuditActive = false;
 describe('[ACCP] Access permissions', function () {
   before(async () => {
     const config = await getConfig();
-    isAuditActive = (!config.get('openSource:isActive')) && config.get('audit:active');
+    isAuditActive = config.get('audit:active');
   });
 
   const user = structuredClone(testData.users[0]);
diff --git a/components/api-server/test/root.test.js b/components/api-server/test/root.test.js
@@ -32,7 +32,7 @@ describe('[ROOT] root', function () {
 
   before(async () => {
     const config = await getConfig();
-    isAuditActive = (!config.get('openSource:isActive')) && config.get('audit:active');
+    isAuditActive = config.get('audit:active');
   });
 
   let mongoFixtures;
diff --git a/components/audit/test/unit/syslog.test.js b/components/audit/test/unit/syslog.test.js
@@ -5,14 +5,20 @@
  * Refer to LICENSE file
  */
 /* global assert, cuid, config, initTests, audit, _ */
+const os = require('os');
 
 const SyslogWatch = require('storage/test/userSQLite/support/SyslogWatch');
 
-describe('Syslog', () => {
+describe('Syslog', function () {
   const userId = cuid();
   const createdBy = cuid();
   let syslogWatch;
 
+  if (os.type() === 'Darwin') {
+    console.log('** to fix - sylog monitoring not working anymore on OSX **');
+    return;
+  }
+
   before(async () => {
     await initTests();
     syslogWatch = new SyslogWatch(config.get('audit:syslog:options:app_name'));
diff --git a/components/mall/src/index.js b/components/mall/src/index.js
@@ -68,7 +68,7 @@ async function getMall () {
     mall.addStore(mongo, { id: 'local', name: 'Local', settings: localSettings });
   }
   // audit
-  if (!config.get('openSource:isActive') && config.get('audit:active')) {
+  if (config.get('audit:active')) {
     const auditDataStore = require('audit/src/datastore/auditDataStore');
     mall.addStore(auditDataStore, { id: '_audit', name: 'Audit', settings: {} });
   }
diff --git a/components/mall/test/acceptance/streams-events.test.js b/components/mall/test/acceptance/streams-events.test.js
@@ -14,11 +14,11 @@ describe('[MSTE] Stores Streams & Events', function () {
   let user, username, password, access, appAccessDummy, appAccessMaster;
   let personalToken;
   let mongoFixtures;
-  let isOpenSource;
+  let isAuditActive;
   let accessesPath, streamsPath, eventsPath;
 
   before(async () => {
-    isOpenSource = (await getConfig()).get('openSource:isActive');
+    isAuditActive = (await getConfig()).get('audit:active');
   });
 
   const streamId = 'yo';
@@ -83,11 +83,11 @@ describe('[MSTE] Stores Streams & Events', function () {
           .query({});
         const streams = res.body.streams;
         assert.exists(streams);
-        assert.equal(streams.length, isOpenSource ? 2 : 3);
+        assert.equal(streams.length, !isAuditActive ? 2 : 3);
         assert.equal(streams[0].id, streamId);
         assert.equal(streams[0].children.length, 1);
         assert.equal(streams[1].id, ':dummy:');
-        if (!isOpenSource) { assert.equal(streams[2].id, ':_audit:access-' + appAccessDummy.id); }
+        if (isAuditActive) { assert.equal(streams[2].id, ':_audit:access-' + appAccessDummy.id); }
       });
 
       it('[XC20] master token must retrieve "yo" streams and all stores when requesting "*"', async () => {
@@ -98,10 +98,10 @@ describe('[MSTE] Stores Streams & Events', function () {
         const streams = res.body.streams;
         assert.exists(streams);
         // we also get helpers here, because with the current implementation, it is returned.
-        assert.equal(streams.length, isOpenSource ? 4 : 5);
+        assert.equal(streams.length, !isAuditActive ? 4 : 5);
         assert.equal(streams[0].id, ':dummy:');
         assert.equal(streams[1].id, ':faulty:');
-        if (!isOpenSource) {
+        if (isAuditActive) {
           assert.equal(streams[2].id, ':_audit:');
           assert.equal(streams[3].id, streamId);
           assert.equal(streams[3].children.length, 1);
diff --git a/components/storage/package.json b/components/storage/package.json
@@ -1,6 +1,6 @@
 {
   "name": "storage",
-  "version": "1.9.2",
+  "version": "1.9.3",
   "private": true,
   "description": "Handles storage of user data on MongoDB",
   "homepage": "https://pryv.com",
diff --git a/components/storage/src/migrations/1.9.2.js b/components/storage/src/migrations/1.9.2.js
@@ -4,7 +4,7 @@
  * This file is part of Pryv.io and released under BSD-Clause-3 License
  * Refer to LICENSE file
  */
-const { getLogger, getConfig } = require('@pryv/boiler');
+const { getLogger } = require('@pryv/boiler');
 
 /**
  * v1.9.2:
@@ -13,6 +13,6 @@ const { getLogger, getConfig } = require('@pryv/boiler');
 module.exports = async function (context, callback) {
   const logger = getLogger('migration-1.9.2');
   logger.info('V1.9.0 => v1.9.2 Migration started');
-  logger.info('V1.8.0 => v1.9.2 Migration finished');
+  logger.info('V1.9.0 => v1.9.2 Migration finished');
   callback();
 };
diff --git a/components/storage/src/migrations/1.9.3.js b/components/storage/src/migrations/1.9.3.js
@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright (C) Pryv https://pryv.com
+ * This file is part of Pryv.io and released under BSD-Clause-3 License
+ * Refer to LICENSE file
+ */
+const { getLogger } = require('@pryv/boiler');
+
+/**
+ * v1.9.3:
+ * - nothing to do
+ */
+module.exports = async function (context, callback) {
+  const logger = getLogger('migration-1.9.3');
+  logger.info('V1.9.2 => v1.9.3 Migration started');
+  logger.info('V1.9.2 => v1.9.3 Migration finished');
+  callback();
+};
diff --git a/components/storage/src/migrations/index.js b/components/storage/src/migrations/index.js
@@ -16,5 +16,6 @@ module.exports = {
   '1.7.5': require('./1.7.5'),
   '1.8.0': require('./1.8.0'),
   '1.9.0': require('./1.9.0'),
-  '1.9.2': require('./1.9.2')
+  '1.9.2': require('./1.9.2'),
+  '1.9.3': require('./1.9.3')
 };
diff --git a/components/test-helpers/src/integrity-final-check.js b/components/test-helpers/src/integrity-final-check.js
@@ -111,7 +111,7 @@ async function all () {
     const config = await getConfig();
     isOpenSource = config.get('openSource:isActive');
   }
-  if (isOpenSource) return;
+  // if (isOpenSource) return;
   await events();
   await accesses();
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pryv-service-core",
-  "version": "1.9.2",
+  "version": "1.9.3",
   "private": true,
   "description": "Pryv core server app components",
   "homepage": "https://pryv.com",
diff --git a/scripts/migrations/audit1.6-1.7/src/index.js b/scripts/migrations/audit1.6-1.7/src/index.js
@@ -307,7 +307,7 @@ async function getAuditLogDir () {
 let db; let config; let audiLogsDirs; const userIdMap = {}; const userStorageByUsername = {}; const userAnchor = {};
 async function start () {
   config = await getConfig();
-  if (config.get('openSource:isActive') || (!config.get('audit:active'))) {
+  if (!config.get('audit:active')) {
     logger.info('Skipping Migration Audit is not active');
   }
   await audit.init();
