apostrophe 3.17.0 → 3.18.0

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

@@ -25,6 +25,7 @@
 // available in the browser for use in the Vue-based admin UI when a user is
 // logged in.
 
+const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const _ = require('lodash');
 
 module.exports = {
@@ -444,10 +445,42 @@ module.exports = {
       // that point.
 
       async sendPage(req, template, data) {
-        await self.apos.page.emit('beforeSend', req);
-        await self.apos.area.loadDeferredWidgets(req);
-        req.res.send(
-          await self.apos.template.renderPageForModule(req, template, data, self)
+        const telemetry = self.apos.telemetry;
+        const spanName = `${self.__meta.name}:sendPage`;
+        await telemetry.startActiveSpan(spanName, async (span) => {
+          span.setAttribute(SemanticAttributes.CODE_FUNCTION, 'sendPage');
+          span.setAttribute(SemanticAttributes.CODE_NAMESPACE, self.__meta.name);
+          span.setAttribute(telemetry.Attributes.TEMPLATE, template);
+
+          try {
+            await self.apos.page.emit('beforeSend', req);
+            await self.apos.area.loadDeferredWidgets(req);
+            req.res.send(
+              await self.apos.template.renderPageForModule(req, template, data, self)
+            );
+            span.setStatus({ code: telemetry.api.SpanStatusCode.OK });
+          } catch (err) {
+            telemetry.handleError(span, err);
+            throw err;
+          } finally {
+            span.end();
+          }
+        });
+      },
+
+      // A cookie in session doesn't mean we can't cache, nor an empty flash or passport object.
+      // Other session properties must be assumed to be specific to the user, with a possible
+      // impact on the response, and thus mean this request must not be cached.
+      // Same rule as in [express-cache-on-demand](https://github.com/apostrophecms/express-cache-on-demand/blob/master/index.js#L102)
+      isSafeToCache(req) {
+        if (req.user) {
+          return false;
+        }
+
+        return Object.entries(req.session).every(([ key, val ]) =>
+          key === 'cookie' || (
+            (key === 'flash' || key === 'passport') && _.isEmpty(val)
+          )
         );
       },
 
@@ -457,21 +490,50 @@ module.exports = {
           return;
         }
 
-        // A cookie in session doesn't mean we can't cache, nor an empty flash or passport object.
-        // Other session properties must be assumed to be specific to the user, with a possible
-        // impact on the response, and thus mean this request must not be cached.
-        // Same rule as in [express-cache-on-demand](https://github.com/apostrophecms/express-cache-on-demand/blob/master/index.js#L102)
-        const isSessionClearForCaching = Object.entries(req.session).every(([ key, val ]) =>
-          key === 'cookie' || (
-            (key === 'flash' || key === 'passport') && _.isEmpty(val)
-          )
-        );
-        const isSafeToCache = !req.user && isSessionClearForCaching;
-        const cacheControlValue = isSafeToCache ? `max-age=${maxAge}` : 'no-store';
+        const cacheControlValue = self.isSafeToCache(req) ? `max-age=${maxAge}` : 'no-store';
 
         req.res.header('Cache-Control', cacheControlValue);
       },
 
+      generateETagParts(req, doc) {
+        const context = doc || req.data.piece || req.data.page;
+
+        if (!context || !context.cacheInvalidatedAt) {
+          return null;
+        }
+
+        const releaseId = self.apos.asset.getReleaseId();
+        const cacheInvalidatedAtTimestamp = (new Date(context.cacheInvalidatedAt)).getTime().toString();
+
+        return [ releaseId, cacheInvalidatedAtTimestamp ];
+      },
+
+      setETag(req, eTagParts) {
+        req.res.header('ETag', eTagParts.join(':'));
+      },
+
+      checkETag(req, doc, maxAge) {
+        const eTagParts = self.generateETagParts(req, doc);
+
+        if (!eTagParts || !self.isSafeToCache(req)) {
+          return false;
+        }
+
+        const clientETagParts = req.headers['if-none-match'] ? req.headers['if-none-match'].split(':') : [];
+        const doesETagMatch = clientETagParts[0] === eTagParts[0] && clientETagParts[1] === eTagParts[1];
+
+        const now = Date.now();
+        const clientETagAge = (now - clientETagParts[2]) / 1000;
+
+        if (!doesETagMatch || clientETagAge > maxAge) {
+          self.setETag(req, [ ...eTagParts, now ]);
+          return false;
+        }
+
+        self.setETag(req, clientETagParts);
+        return true;
+      },
+
       // Call from init once if this module implements the `getBrowserData` method.
       // The data returned by `getBrowserData(req)` will then be available on
       // `apos.modules['your-module-name']` in the browser.
@@ -649,10 +711,29 @@ module.exports = {
             // @apostrophecms/db:reset which
             // must run before most modules are awake
             if (self.apos.argv._[0] === `${self.__meta.name}:${name}`) {
-              await info.task(self.apos.argv);
+              const telemetry = self.apos.telemetry;
+              const spanName = `task:${self.__meta.name}:${name}`;
+              // only this span can be sent to the backend, attach to the ROOT
+              await telemetry.startActiveSpan(
+                spanName,
+                async (span) => {
+                  span.setAttribute(SemanticAttributes.CODE_FUNCTION, 'executeAfterModuleInitTask');
+                  span.setAttribute(SemanticAttributes.CODE_NAMESPACE, '@apostrophecms/module');
+                  span.setAttribute(telemetry.Attributes.TARGET_NAMESPACE, self.__meta.name);
+                  span.setAttribute(telemetry.Attributes.TARGET_FUNCTION, name);
+                  try {
+                    await info.task(self.apos.argv);
+                    span.setStatus({ code: telemetry.api.SpanStatusCode.OK });
+                  } catch (err) {
+                    telemetry.handleError(span, err);
+                    throw err;
+                  } finally {
+                    span.end();
+                  }
+                });
               // In most cases we exit after running a task
               if (info.exitAfter !== false) {
-                process.exit(0);
+                await self.apos._exit();
               } else {
                 // Provision for @apostrophecms/db:reset which should be
                 // followed by normal initialization so all the collections

package/modules/@apostrophecms/module/lib/events.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 
 module.exports = function(self) {
 
@@ -38,18 +39,52 @@ module.exports = function(self) {
         }
       ];
 
-      for (const entry of chain) {
-        const handlers = self.apos.eventHandlers[entry.name] && self.apos.eventHandlers[entry.name][name];
-        if (handlers) {
-          for (const handler of handlers) {
-            const module = self.apos.modules[handler.moduleName];
-            const fn = module.compiledHandlers[entry.name][name][handler.handlerName];
-            // Although we have `self` it can't hurt to
-            // supply the correct `this`
-            await fn.apply(module, args);
+      const telemetry = self.apos.telemetry;
+
+      // Create the "outer" span
+      const moduleName = (self.__meta && self.__meta.name) || 'apostrophe';
+      const spanEmitName = `event:${moduleName}:${name}`;
+      await telemetry.startActiveSpan(spanEmitName, async (spanEmit) => {
+        spanEmit.setAttribute(SemanticAttributes.CODE_FUNCTION, 'emit');
+        spanEmit.setAttribute(SemanticAttributes.CODE_NAMESPACE, moduleName);
+        spanEmit.setAttribute(telemetry.Attributes.EVENT_MODULE, moduleName);
+        spanEmit.setAttribute(telemetry.Attributes.EVENT_NAME, name);
+
+        for (const entry of chain) {
+          const handlers = self.apos.eventHandlers[entry.name] && self.apos.eventHandlers[entry.name][name];
+          if (handlers) {
+            for (const handler of handlers) {
+
+              // Create an active "inner" span for each handler using the parent as a context
+              const spanHandlerName = spanEmitName + `:handler:${handler.moduleName}:${handler.handlerName}`;
+              await telemetry.startActiveSpan(spanHandlerName, async (spanHandler) => {
+                spanHandler.setAttribute(SemanticAttributes.CODE_FUNCTION, handler.handlerName);
+                spanHandler.setAttribute(SemanticAttributes.CODE_NAMESPACE, handler.moduleName);
+                spanHandler.setAttribute(telemetry.Attributes.EVENT_MODULE, moduleName);
+                spanHandler.setAttribute(telemetry.Attributes.EVENT_NAME, name);
+
+                try {
+                  const module = self.apos.modules[handler.moduleName];
+                  const fn = module.compiledHandlers[entry.name][name][handler.handlerName];
+                  // Although we have `self` it can't hurt to
+                  // supply the correct `this`
+                  await fn.apply(module, args);
+                  spanHandler.setStatus({ code: telemetry.api.SpanStatusCode.OK });
+                  spanHandler.end();
+                } catch (err) {
+                  telemetry.handleError(spanHandler, err);
+                  // Be sure to close the parent span as well
+                  spanHandler.end();
+                  spanEmit.end();
+                  throw err;
+                }
+              }, spanEmit);
+            }
           }
         }
-      }
+
+        spanEmit.end();
+      });
     },
 
     // You don't need to call this. It is called for you
@@ -95,7 +130,7 @@ module.exports = function(self) {
       self.apos.eventHandlers[moduleName] = self.apos.eventHandlers[moduleName] || {};
       const eh = self.apos.eventHandlers[moduleName];
       eh[eventName] = eh[eventName] || [];
-      if (_.find(eh[eventName], function(item) {
+      if (_.find(eh[eventName], function (item) {
         return (item.moduleName === self.__meta.name) && (item.handlerName === handlerName);
       })) {
         // The "event name and method name must differ" rule helps

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

@@ -1,6 +1,7 @@
 const _ = require('lodash');
 const path = require('path');
 const { klona } = require('klona');
+const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const expressCacheOnDemand = require('express-cache-on-demand')();
 
 module.exports = {
@@ -119,7 +120,7 @@ module.exports = {
               project: self.getAllProjection()
             }).toObject();
 
-            if (self.options.cache && self.options.cache.api) {
+            if (self.options.cache && self.options.cache.api && self.options.cache.api.maxAge) {
               self.setMaxAge(req, self.options.cache.api.maxAge);
             }
 
@@ -142,7 +143,7 @@ module.exports = {
           } else {
             const result = await self.getRestQuery(req).and({ level: 0 }).toObject();
 
-            if (self.options.cache && self.options.cache.api) {
+            if (self.options.cache && self.options.cache.api && self.options.cache.api.maxAge) {
               self.setMaxAge(req, self.options.cache.api.maxAge);
             }
 
@@ -178,8 +179,14 @@ module.exports = {
           const criteria = self.getIdCriteria(_id);
           const result = await self.getRestQuery(req).and(criteria).toObject();
 
-          if (self.options.cache && self.options.cache.api) {
-            self.setMaxAge(req, self.options.cache.api.maxAge);
+          if (self.options.cache && self.options.cache.api && self.options.cache.api.maxAge) {
+            const { maxAge } = self.options.cache.api;
+
+            if (!self.options.cache.api.etags) {
+              self.setMaxAge(req, maxAge);
+            } else if (self.checkETag(req, result, maxAge)) {
+              return {};
+            }
           }
 
           if (!result) {
@@ -1404,6 +1411,18 @@ database.`);
         } catch (err) {
           return await self.serve500Error(req, err);
         }
+
+        if (self.options.cache && self.options.cache.page && self.options.cache.page.maxAge) {
+          const { maxAge } = self.options.cache.page;
+
+          if (!self.options.cache.page.etags) {
+            self.setMaxAge(req, maxAge);
+          } else if (self.checkETag(req, undefined, maxAge)) {
+            // Stop there and send a 304 status code; the cached response will be used
+            return res.sendStatus(304);
+          }
+        }
+
         try {
           await self.serveDeliver(req, null);
         } catch (err) {
@@ -1415,24 +1434,35 @@ database.`);
       // of course wins, followed by the parent "folder," and so on up to the
       // home page.
       async serveGetPage(req) {
-        req.slug = req.params[0];
-        self.normalizeSlug(req);
-        // Had to change the URL, so redirect to it. TODO: this
-        // contains an assumption that we are mounted at /
-        if (req.slug !== req.params[0]) {
-          req.redirect = req.slug;
-        }
-        const builders = self.getServePageBuilders();
-        const query = self.find(req);
-        query.applyBuilders(builders);
-        self.matchPageAndPrefixes(query, req.slug);
-        await self.emit('serveQuery', query);
-        req.data.bestPage = await query.toObject();
-        self.evaluatePageMatch(req);
+        const spanName = `${self.__meta.name}:serveGetPage`;
+        await self.apos.telemetry.startActiveSpan(spanName, async (span) => {
+          span.setAttribute(SemanticAttributes.CODE_FUNCTION, 'serveGetPage');
+          span.setAttribute(SemanticAttributes.CODE_NAMESPACE, self.__meta.name);
 
-        if (self.options.cache && self.options.cache.page) {
-          self.setMaxAge(req, self.options.cache.page.maxAge);
-        }
+          try {
+            req.slug = req.params[0];
+            self.normalizeSlug(req);
+            // Had to change the URL, so redirect to it. TODO: this
+            // contains an assumption that we are mounted at /
+            if (req.slug !== req.params[0]) {
+              req.redirect = req.slug;
+            }
+            const builders = self.getServePageBuilders();
+            const query = self.find(req);
+            query.applyBuilders(builders);
+            self.matchPageAndPrefixes(query, req.slug);
+            await self.emit('serveQuery', query);
+            req.data.bestPage = await query.toObject();
+            self.evaluatePageMatch(req);
+
+            span.setStatus({ code: self.apos.telemetry.api.SpanStatusCode.OK });
+          } catch (err) {
+            self.apos.telemetry.handleError(span, err);
+            throw err;
+          } finally {
+            span.end();
+          }
+        });
       },
       // Normalize req.slug to account for unneeded trailing whitespace,
       // trailing slashes other than the root, and double slash based open
@@ -2108,7 +2138,10 @@ database.`);
               _id: null
             });
           } else {
-            query.project(self.options.publicApiProjection);
+            query.project({
+              ...self.options.publicApiProjection,
+              cacheInvalidatedAt: 1
+            });
           }
         }
         return query;

package/modules/@apostrophecms/piece-page-type/index.js

@@ -241,6 +241,7 @@ module.exports = {
           if (parentPage) {
             piece._url = self.buildUrl(req, parentPage, piece);
             piece._parentUrl = parentPage._url;
+            piece._parentSlug = parentPage.slug;
           }
         });
       },

package/modules/@apostrophecms/piece-type/index.js

@@ -201,7 +201,7 @@ module.exports = {
             result.counts = query.get('countsResults');
           }
 
-          if (self.options.cache && self.options.cache.api) {
+          if (self.options.cache && self.options.cache.api && self.options.cache.api.maxAge) {
             self.setMaxAge(req, self.options.cache.api.maxAge);
           }
 
@@ -215,8 +215,14 @@ module.exports = {
           self.publicApiCheck(req);
           const doc = await self.getRestQuery(req).and({ _id }).toObject();
 
-          if (self.options.cache && self.options.cache.api) {
-            self.setMaxAge(req, self.options.cache.api.maxAge);
+          if (self.options.cache && self.options.cache.api && self.options.cache.api.maxAge) {
+            const { maxAge } = self.options.cache.api;
+
+            if (!self.options.cache.api.etags) {
+              self.setMaxAge(req, maxAge);
+            } else if (self.checkETag(req, doc, maxAge)) {
+              return {};
+            }
           }
 
           if (!doc) {
@@ -917,7 +923,10 @@ module.exports = {
               _id: null
             });
           } else if (!query.state.project) {
-            query.project(self.options.publicApiProjection);
+            query.project({
+              ...self.options.publicApiProjection,
+              cacheInvalidatedAt: 1
+            });
           }
         }
         return query;

package/modules/@apostrophecms/piece-type/ui/apos/components/AposRelationshipEditor.vue

@@ -72,8 +72,8 @@ export default {
       original: this.value,
       docFields: {
         data: {
-          ...((this.value != null) ? this.value :
-            Object.fromEntries(
+          ...((this.value != null) ? this.value
+            : Object.fromEntries(
               this.schema.map(field =>
                 [ field.name, (field.def !== undefined) ? klona(field.def) : null ]
               )

package/modules/@apostrophecms/rich-text-widget/index.js

@@ -44,8 +44,7 @@ module.exports = {
     },
     defaultOptions: {},
     components: {
-      widgetEditor: 'AposRichTextWidgetEditor',
-      widget: 'AposRichTextWidget'
+      widgetEditor: 'AposRichTextWidgetEditor'
     },
     editorTools: {
       styles: {
@@ -415,7 +414,6 @@ module.exports = {
 
         const finalData = {
           ...initialData,
-          components: self.options.components,
           tools: self.options.editorTools,
           defaultOptions: self.options.defaultOptions,
           tiptapTextCommands: self.options.tiptapTextCommands,

package/modules/@apostrophecms/rich-text-widget/ui/apos/components/AposRichTextWidgetEditor.vue

@@ -72,6 +72,10 @@ export default {
       default() {
         return null;
       }
+    },
+    focused: {
+      type: Boolean,
+      default: false
     }
   },
   emits: [ 'update' ],