apostrophe 3.53.0 → 3.55.0

package/modules/@apostrophecms/util/index.js

@@ -5,7 +5,7 @@
 
 // ## Options
 //
-// ### `logger`
+// ### `logger` (LEGACY)
 //
 // A function which accepts `apos` and returns an object with
 // at least `info`, `debug`, `warn` and `error` methods. These methods should
@@ -16,6 +16,11 @@
 // `apos.util.error`, etc. are routed through this object
 // by Apostrophe. This provides compatibility out of
 // the box with many popular logging modules, including `winston`.
+// NOTE: this option is deprecated, you should configure `@apostrophecms/log`
+// module instead. This option will still work for BC reasons, but switching
+// to structured logging and module `self.logInfo()`, `self.logError()`, etc
+// is highly recommended.
+// Read more in the`@apostrophecms/log` module documentation.
 
 const _ = require('lodash');
 const he = require('he');
@@ -46,6 +51,17 @@ module.exports = {
     self.warnedDev = {};
     return self.enableLogger();
   },
+  handlers(self) {
+    return {
+      'apostrophe:destroy': {
+        async destroyLogger() {
+          if (self.logger.destroy) {
+            await self.logger.destroy();
+          }
+        }
+      }
+    };
+  },
   methods(self) {
     return {
       // generate a unique identifier for a new page or other object.
@@ -504,7 +520,20 @@ module.exports = {
         }
       },
       enableLogger() {
-        self.logger = self.options.logger ? self.options.logger(self.apos) : require('./lib/logger.js')(self.apos);
+        // Legacy, configured via this module.
+        if (self.options.logger) {
+          self.logger = self.options.logger(self.apos);
+          return;
+        }
+        // New, configured via the `log` module.
+        const logOpts = self.apos.structuredLog.options;
+        if (logOpts.logger) {
+          self.logger = typeof logOpts.logger === 'function'
+            ? logOpts.logger(self.apos)
+            : logOpts.logger;
+          return;
+        }
+        self.logger = require('./lib/logger.js')(self.apos);
       },
       // Log a message. The default
       // implementation wraps `console.log` and passes on
@@ -517,11 +546,12 @@ module.exports = {
       // If the logger has no `log` method, the `info` method
       // is used. This allows an instance of `bole` or similar
       // to be used directly.
-      log(msg) {
+      log(...args) {
+        // kept for bc
         if (!self.logger.log) {
-          return self.logger.info.apply(self.logger.info, arguments);
+          return self.logger.info(...self.convertLegacyLogPayload(args));
         }
-        self.logger.log.apply(self.logger, arguments);
+        self.logger.log(...self.convertLegacyLogPayload(args));
       },
       // Log an informational message. The default
       // implementation wraps `console.info` and passes on
@@ -530,8 +560,8 @@ module.exports = {
       // Overrides should be written with support for
       // substitution strings in mind. See the
       // `console.log` documentation.
-      info(msg) {
-        self.logger.info.apply(self.logger, arguments);
+      info(...args) {
+        self.logger.info(...self.convertLegacyLogPayload(args));
       },
       // Log a debug message. The default implementation wraps
       // `console.debug` if available, otherwise `console.log`,
@@ -540,8 +570,8 @@ module.exports = {
       // Overrides should be written with support for
       // substitution strings in mind. See the
       // `console.warn` documentation.
-      debug(msg) {
-        self.logger.debug.apply(self.logger, arguments);
+      debug(...args) {
+        self.logger.debug(...self.convertLegacyLogPayload(args));
       },
       // Log a warning. The default implementation wraps
       // `console.warn` and passes on all arguments,
@@ -554,8 +584,8 @@ module.exports = {
       // The intention is that `apos.util.warn` should be
       // called for situations less dire than
       // `apos.util.error`.
-      warn(msg) {
-        self.logger.warn.apply(self.logger, arguments);
+      warn(...args) {
+        self.logger.warn(...self.convertLegacyLogPayload(args));
       },
 
       // Identical to `apos.util.warn`, except that the warning is
@@ -605,8 +635,8 @@ module.exports = {
       // Overrides should be written with support for
       // substitution strings in mind. See the
       // `console.error` documentation.
-      error(msg) {
-        self.logger.error.apply(self.logger, arguments);
+      error(...args) {
+        self.logger.error(...self.convertLegacyLogPayload(args));
       },
       // Performance profiling method. At the start of the operation you want
       // to profile, call with req (may be null or omitted entirely) and a
@@ -811,6 +841,46 @@ module.exports = {
       },
       omit(source, keys) {
         return _.omit(source, keys);
+      },
+
+      // Internal method. Attempt to convert the log payload to an object
+      // for legacy calls and when `@apostrophecms/log` has been configured
+      // with `messageAs: 'someKey'`.
+      // This change is backwards compatible with the previous behavior because
+      // `messageAs` is a newly introduced option. Custom loggers should adapt
+      // to this change when using `messageAs`.
+      // `args` is the argument array passed to the any log method.
+      // The result (when required) is an array with a single object.
+      // First string argument (if available) is used as `message`.
+      // First object argument is used as result object.
+      // All other arguments are passed as `args` property of the result object.
+      convertLegacyLogPayload(args) {
+        const messageAs = self.apos.structuredLog.options.messageAs;
+        if (!messageAs || args.length === 0) {
+          return args;
+        }
+        // Already formatted by the structured log module. Nothing we can do if not.
+        if (args.length === 1 && _.isPlainObject(args[0])) {
+          return args;
+        }
+
+        // Should also handle apos.util.warnDev() calls.
+        const messageIndex = args
+          .findIndex(arg => typeof arg === 'string' && arg.trim() && arg !== '\n⚠️ ');
+        const firstObjectIndex = args.findIndex(arg => _.isPlainObject(arg));
+        const message = messageIndex !== -1 ? args[messageIndex] : null;
+        const firstObject = firstObjectIndex !== -1 ? { ...args[firstObjectIndex] } : {};
+
+        if (message) {
+          firstObject[messageAs] = message;
+        }
+        const rest = args
+          .filter((arg, index) => ![ messageIndex, firstObjectIndex ].includes(index));
+        if (rest.length) {
+          firstObject.args = rest;
+        }
+
+        return [ firstObject ];
       }
     };
   },

package/modules/@apostrophecms/util/lib/logger.js

@@ -1,7 +1,9 @@
 // Default logger. You may pass an alternate implementation
 // as the `logger` top-level option when configuring Apostrophe.
 
-module.exports = function(apos) {
+module.exports = function (apos) {
+  const logModule = apos.structuredLog;
+
   return {
     // Log a message. The default
     // implementation wraps `console.log` and passes on
@@ -11,9 +13,9 @@ module.exports = function(apos) {
     // substitution strings in mind. See the
     // `console.log` documentation.
 
-    log: function(msg) {
+    log: function(...args) {
       // eslint-disable-next-line no-console
-      console.log.apply(console, arguments);
+      console.log(...logModule.formatLogByEnv(args));
     },
 
     // Log an informational message.
@@ -22,9 +24,9 @@ module.exports = function(apos) {
     // substitution strings in mind. See the
     // `console.log` documentation.
 
-    info: function(msg) {
+    info: function(...args) {
       // eslint-disable-next-line no-console
-      console.info.apply(console, arguments);
+      console.info(...logModule.formatLogByEnv(args));
     },
 
     // Log a debug message. Invokes
@@ -35,15 +37,9 @@ module.exports = function(apos) {
     // substitution strings in mind. See the
     // `console.log` documentation.
 
-    debug: function(msg) {
+    debug: function(...args) {
       // eslint-disable-next-line no-console
-      if (console.debug) {
-        // eslint-disable-next-line no-console
-        console.debug.apply(console, arguments);
-      } else {
-        // eslint-disable-next-line no-console
-        console.log.apply(console, arguments);
-      }
+      console.debug(...logModule.formatLogByEnv(args));
     },
 
     // Log an error message. The default implementation
@@ -54,9 +50,9 @@ module.exports = function(apos) {
     // substitution strings in mind. See the
     // `console.error` documentation.
 
-    error: function(msg) {
+    error: function(...args) {
       // eslint-disable-next-line no-console
-      console.error.apply(console, arguments);
+      console.error(...logModule.formatLogByEnv(args));
     },
     // Log a warning. The default implementation wraps
     // `console.warn` and passes on all arguments,
@@ -70,9 +66,15 @@ module.exports = function(apos) {
     // called for situations less dire than
     // `apos.util.error`.
 
-    warn: function(msg) {
+    warn: function(...args) {
       // eslint-disable-next-line no-console
-      console.warn.apply(console, arguments);
+      console.warn(...logModule.formatLogByEnv(args));
+    },
+
+    // Automatically tear down the logger if available.
+
+    async destroy() {
+      // Nothing to do
     }
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.53.0",
+  "version": "3.55.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {

package/test/docs.js

@@ -159,7 +159,7 @@ describe('Docs', function() {
     assert(person._friends[0].slug === 'larry');
   });
 
-  it('should support custom context menu (required only)', async function() {
+  it('should support custom context menu (legacy, required only)', async function() {
     const operation = {
       context: 'update',
       action: 'test',
@@ -176,7 +176,7 @@ describe('Docs', function() {
       moduleName: 'test-people'
     });
   });
-  it('should support custom context menu (with optional)', async function() {
+  it('should support custom context menu (legacy, with optional)', async function() {
     apos.doc.contextOperations = [];
     const operation = {
       context: 'update',
@@ -196,6 +196,39 @@ describe('Docs', function() {
     });
   });
 
+  it('should support custom context menu (modern, required only)', async function() {
+    const operation = {
+      context: 'update',
+      action: 'test2',
+      label: 'Menu Label',
+      modal: 'SomeModalComponent'
+    };
+    const initialLength = apos.doc.contextOperations.length;
+
+    apos.doc.addContextOperation(operation);
+
+    assert.strictEqual(apos.doc.contextOperations.length, initialLength + 1);
+    // Front end is responsible for inferring moduleName here
+    assert.deepStrictEqual(apos.doc.contextOperations.find(op => op.action === 'test2'), operation);
+  });
+  it('should support custom context menu (modern, with optional)', async function() {
+    apos.doc.contextOperations = [];
+    const operation = {
+      context: 'update',
+      action: 'test',
+      label: 'Menu Label',
+      modal: 'SomeModalComponent',
+      manuallyPublished: true,
+      modifiers: [ 'danger' ]
+    };
+    assert.strictEqual(apos.doc.contextOperations.length, 0);
+
+    apos.doc.addContextOperation(operation);
+    assert.strictEqual(apos.doc.contextOperations.length, 1);
+    // Front end is responsible for inferring moduleName here
+    assert.deepStrictEqual(apos.doc.contextOperations[0], operation);
+  });
+
   it('should override custom context menu', async function() {
     apos.doc.contextOperations = [];
     const operation1 = {