apostrophe 3.53.0 → 3.55.0

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

@@ -0,0 +1,68 @@
+// Per module log handlers.
+// Usage (same arguments for all log handlers):
+// ```js
+// self.logError('event-type');
+// self.logError('event-type', { key: 'value' });
+// self.logError('event-type', 'some message');
+// self.logError('event-type', 'some message', { key: 'value' });
+// Prepend `req` followed by any of the above argument variations.
+// self.logError(req, ...);
+// ```
+//
+// Event type is required and can be any string.
+// If `req` is provided, the `data` object argument will be enriched with
+// additional information from the request.
+// Example:
+// self.logError('event-type', 'some message', { key: 'value' });
+// will log:
+// 'current-module-name: event-type: some message',
+// {
+//   type: 'event-type',
+//   severity: 'error',
+//   module: 'current-module-name',
+//   key: 'value',
+// }
+// If the option `messageAs` of `@apostrophecms/log` is set to 'msg',
+// the result of the above log entry will be:
+// {
+//   type: 'event-type',
+//   severity: 'error',
+//   module: 'current-module-name',
+//   key: 'value',
+//   msg: 'current-module-name: event-type: some message',
+// }
+//
+// If `filter` option is set, the log entry will be logged only if the
+// `severity` or `eventType` match any filter. For more information about
+// filters see `@apostrophecms/log` module.
+module.exports = function (self) {
+  const exception = new Error(
+    `Structured logging is not available for module "${self.__meta.name}".`
+  );
+  return {
+    logDebug(...args) {
+      if (!self.__structuredLoggingEnabled) {
+        throw exception;
+      }
+      self.apos.structuredLog.logEntry(self, 'debug', ...args);
+    },
+    logInfo(...args) {
+      if (!self.__structuredLoggingEnabled) {
+        throw exception;
+      }
+      self.apos.structuredLog.logEntry(self, 'info', ...args);
+    },
+    logWarn(...args) {
+      if (!self.__structuredLoggingEnabled) {
+        throw exception;
+      }
+      self.apos.structuredLog.logEntry(self, 'warn', ...args);
+    },
+    logError(...args) {
+      if (!self.__structuredLoggingEnabled) {
+        throw exception;
+      }
+      self.apos.structuredLog.logEntry(self, 'error', ...args);
+    }
+  };
+};

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

@@ -5,7 +5,7 @@ const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const expressCacheOnDemand = require('express-cache-on-demand')();
 
 module.exports = {
-  cascades: [ 'batchOperations' ],
+  cascades: [ 'batchOperations', 'utilityOperations' ],
   options: {
     alias: 'page',
     types: [
@@ -127,7 +127,7 @@ module.exports = {
       getAll: [
         ...self.enableCacheOnDemand ? [ expressCacheOnDemand ] : [],
         async (req) => {
-          self.publicApiCheck(req);
+          await self.publicApiCheckAsync(req);
           const all = self.apos.launder.boolean(req.query.all);
           const archived = self.apos.launder.booleanOrNull(req.query.archived);
           const flat = self.apos.launder.boolean(req.query.flat);
@@ -215,7 +215,7 @@ module.exports = {
         async (req, _id) => {
           _id = self.inferIdLocaleAndMode(req, _id);
           // Edit access to draft is sufficient to fetch either
-          self.publicApiCheck(req);
+          await self.publicApiCheckAsync(req);
           const criteria = self.getIdCriteria(_id);
           const result = await self.getRestQuery(req).permission(false).and(criteria).toObject();
 
@@ -253,7 +253,7 @@ module.exports = {
       //
       // This call is atomic with respect to other REST write operations on pages.
       async post(req) {
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         let targetId = self.apos.launder.string(req.body._targetId);
         let position = self.apos.launder.string(req.body._position || 'lastChild');
         // Here we have to normalize before calling insert because we
@@ -338,7 +338,7 @@ module.exports = {
 
       async put(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
 
         return self.withLock(req, async () => {
           const page = await self.findForEditing(req, { _id }).toObject();
@@ -385,7 +385,7 @@ module.exports = {
       },
       async delete(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         const page = await self.findOneForEditing(req, {
           _id
         });
@@ -396,9 +396,9 @@ module.exports = {
       // You may pass `_targetId` and `_position` to move the page within the tree. `_position`
       // may be `before`, `after` or `inside`. To move a page into or out of the archive, set
       // `archived` to `true` or `false`.
-      patch(req, _id) {
+      async patch(req, _id) {
         _id = self.inferIdLocaleAndMode(req, _id);
-        self.publicApiCheck(req);
+        await self.publicApiCheckAsync(req);
         return self.patch(req, _id);
       }
     };
@@ -659,6 +659,13 @@ database.`);
               };
             }
           }
+        },
+        composeUtilityOperations() {
+          self.utilityOperations = Object.entries(self.utilityOperations || {})
+            .map(([ action, properties ]) => ({
+              action,
+              ...properties
+            }));
         }
       },
       'apostrophe:ready': {
@@ -830,6 +837,7 @@ database.`);
           browserOptions.localized &&
           Object.keys(self.apos.i18n.locales).length > 1 &&
           Object.values(self.apos.i18n.locales).some(locale => locale._edit);
+        browserOptions.utilityOperations = self.utilityOperations;
         return browserOptions;
       },
       // Returns a query that finds pages the current user can edit
@@ -864,8 +872,6 @@ database.`);
         position = normalized.position;
         return self.withLock(req, async () => {
           let peers;
-          page.aposLastTargetId = targetId;
-          page.aposLastPosition = position;
           const target = await self.getTarget(req, targetId, position);
           if (!target) {
             throw self.apos.error('notfound');
@@ -1203,8 +1209,6 @@ database.`);
             }
             moved.level = level;
             moved.rank = rank;
-            moved.aposLastTargetId = targetId;
-            moved.aposLastPosition = position;
             // Are we in the archive? Our new parent reveals that
             if (parent.archived) {
               moved.archived = true;
@@ -1222,8 +1226,11 @@ database.`);
       // value. `position` is used to prevent attempts to move after the archive
       // "page."
       async getTarget(req, targetId, position) {
-        const criteria = self.getIdCriteria(targetId);
-        const target = await self.find(req, criteria).permission(false).archived(null).areas(false).ancestors({
+        const criteria = self.getIdCriteria(self.inferIdLocaleAndMode(req, targetId));
+        // Use findForEditing to ensure we get improvements to that method from
+        // npm modules that make the query more inclusive. Then explicitly shut off
+        // things we know we don't want to be blocked by
+        const target = await self.findForEditing(req, criteria).permission(false).archived(null).areas(false).ancestors({
           depth: 1,
           archived: null,
           orphan: null,
@@ -2053,9 +2060,7 @@ database.`);
             page.rank = rank;
             const $set = {
               path: page.path,
-              rank: page.rank,
-              aposLastTargetId: home.aposDocId,
-              aposLastPosition: 'lastChild'
+              rank: page.rank
             };
             if (argv['new-slug']) {
               $set.slug = argv['new-slug'];
@@ -2275,7 +2280,10 @@ database.`);
         return self.apos.doc.getManager(page.type)
           .allowedSchema(req, page, parentPage);
       },
-      getRestQuery(req) {
+      // Can be extended on a project level with `_super(req, true)` to disable
+      // permission check and public API projection. You shouldn't do this
+      // if you're not sure what you're doing.
+      getRestQuery(req, omitPermissionCheck = false) {
         const query = self.find(req)
           .ancestors(true)
           .children(true)
@@ -2283,7 +2291,7 @@ database.`);
           .applyBuildersSafely(req.query);
         // Minimum standard for a REST query without a public projection
         // is being allowed to view drafts on the site
-        if (!self.canAccessApi(req)) {
+        if (!omitPermissionCheck && !self.canAccessApi(req)) {
           if (!self.options.publicApiProjection) {
             // Shouldn't be needed thanks to publicApiCheck, but be sure
             query.and({
@@ -2329,6 +2337,11 @@ database.`);
           }
         }
       },
+      // An async version of the above. It can be overridden to implement
+      // an asynchronous check of the public API permissions.
+      async publicApiCheckAsync(req) {
+        return self.publicApiCheck(req);
+      },
       getAllProjection() {
         return {
           _url: 1,
@@ -2489,6 +2502,45 @@ database.`);
             await self.apos.attachment.recomputeAllDocReferences();
           }
         });
+      },
+      async inferLastTargetIdAndPosition(doc) {
+        const parentPath = self.getParentPath(doc);
+        const parentAposDocId = parentPath.split('/').pop();
+        const parentId = doc.aposLocale
+          ? `${parentAposDocId}:${doc.aposLocale}`
+          : parentAposDocId;
+        const peerCriteria = {
+          path: self.matchDescendants(parentPath),
+          level: doc.level
+        };
+        if (doc.aposLocale) {
+          peerCriteria.aposLocale = doc.aposLocale;
+        }
+        const peers = await self.apos.doc.db.find(peerCriteria).sort({
+          rank: 1
+        }).project({
+          _id: 1
+        }).toArray();
+        let targetId;
+        let position;
+        const index = peers.findIndex(peer => peer._id === doc._id);
+        if (index === -1) {
+          throw new Error('Cannot find page among its peers');
+        }
+        if (index === 0) {
+          targetId = parentId;
+          position = 'firstChild';
+        } else if (index === (peers.length - 1)) {
+          targetId = parentId;
+          position = 'lastChild';
+        } else {
+          targetId = peers[index - 1]._id;
+          position = 'after';
+        }
+        return {
+          lastTargetId: targetId,
+          lastPosition: position
+        };
       }
     };
   },

package/modules/@apostrophecms/page/lib/legacy-migrations.js

@@ -6,7 +6,6 @@ module.exports = (self) => {
     addLegacyMigrations() {
       self.addDeduplicateRanksMigration();
       self.addFixHomePagePathMigration();
-      self.addMissingLastTargetIdAndPositionMigration();
       self.addArchivedMigration();
     },
     addArchivedMigration() {
@@ -100,62 +99,6 @@ module.exports = (self) => {
           }
         });
       });
-    },
-    addMissingLastTargetIdAndPositionMigration() {
-      self.apos.migration.add('missing-last-target-id-and-position', async () => {
-        await self.apos.migration.eachDoc({
-          slug: /^\//,
-          // Home page should not have them, that's OK
-          level: {
-            $gte: 0
-          },
-          aposLastTargetId: {
-            $exists: 0
-          }
-        }, 5, async (doc) => {
-          const parentPath = self.getParentPath(doc);
-          const parentAposDocId = parentPath.split('/').pop();
-          let parentId;
-          if (doc.aposLocale) {
-            parentId = `${parentAposDocId}:${doc.aposLocale}`;
-          } else {
-            parentId = parentAposDocId;
-          }
-          const peerCriteria = {
-            path: self.matchDescendants(parentPath),
-            level: doc.level
-          };
-          if (doc.aposLocale) {
-            peerCriteria.aposLocale = doc.aposLocale;
-          }
-          const peers = await self.apos.doc.db.find(peerCriteria).sort({
-            rank: 1
-          }).project({
-            _id: 1
-          }).toArray();
-          let targetId;
-          let position;
-          const index = peers.findIndex(peer => peer._id === doc._id);
-          if (index === -1) {
-            return;
-          }
-          if (index === 0) {
-            targetId = parentId;
-            position = 'firstChild';
-          } else {
-            targetId = peers[index - 1]._id;
-            position = 'after';
-          }
-          return self.apos.doc.db.updateOne({
-            _id: doc._id
-          }, {
-            $set: {
-              aposLastTargetId: targetId,
-              aposLastPosition: position
-            }
-          });
-        });
-      });
     }
   };
 };

package/modules/@apostrophecms/page/ui/apos/components/AposPagesManager.vue

@@ -20,6 +20,10 @@
       />
     </template>
     <template #primaryControls>
+      <AposUtilityOperations
+        :module-options="moduleOptions"
+        :has-relationship-field="!!relationshipField"
+      />
       <AposContextMenu
         v-if="relationshipField"
         :menu="moreMenu"
@@ -86,294 +90,13 @@
 </template>
 
 <script>
-import AposModifiedMixin from 'Modules/@apostrophecms/ui/mixins/AposModifiedMixin';
-import AposArchiveMixin from 'Modules/@apostrophecms/ui/mixins/AposArchiveMixin';
-import AposPublishMixin from 'Modules/@apostrophecms/ui/mixins/AposPublishMixin';
-import AposDocsManagerMixin from 'Modules/@apostrophecms/modal/mixins/AposDocsManagerMixin';
-import { klona } from 'klona';
+import AposPagesManagerLogic from 'Modules/@apostrophecms/page/logic/AposPagesManager';
 
 export default {
   name: 'AposPagesManager',
-  mixins: [ AposModifiedMixin, AposDocsManagerMixin, AposArchiveMixin, AposPublishMixin ],
-  emits: [ 'archive', 'search', 'safe-close', 'modal-result' ],
-  data() {
-
-    return {
-      moduleName: '@apostrophecms/page',
-      modal: {
-        active: false,
-        triggerFocusRefresh: 0,
-        type: 'slide',
-        showModal: false,
-        width: 'two-thirds'
-      },
-      pages: [],
-      pagesFlat: [],
-      options: {
-        columns: [
-          {
-            columnHeader: 'apostrophe:pageTitle',
-            property: 'title',
-            cellValue: 'title'
-          },
-          {
-            name: 'labels',
-            component: 'AposCellLabels'
-          },
-          {
-            columnHeader: 'apostrophe:lastEdited',
-            property: 'updatedAt',
-            component: 'AposCellLastEdited',
-            cellValue: 'updatedAt'
-          },
-          {
-            property: 'contextMenu',
-            component: 'AposCellContextMenu'
-          }
-        ]
-      },
-      treeOptions: {
-        bulkSelect: !!this.relationshipField,
-        draggable: true,
-        ghostUnpublished: true
-      },
-      moreMenu: [
-        {
-          label: 'New Page',
-          action: 'new'
-        }
-      ],
-      moreMenuButton: {
-        tooltip: {
-          content: 'More Options',
-          placement: 'bottom'
-        },
-        label: 'More Options',
-        icon: 'dots-vertical-icon',
-        iconOnly: true,
-        type: 'subtle',
-        modifiers: [ 'small', 'no-motion' ]
-      },
-      pageSetMenuSelection: 'live'
-    };
-  },
-  computed: {
-    moduleOptions() {
-      return apos.page;
-    },
-    items() {
-      if (!this.pages || !this.headers.length) {
-        return [];
-      }
-      return klona(this.pages);
-    },
-    selectAllChoice() {
-      const checkLen = this.checked.length;
-      const rowLen = this.pagesFlat.length;
-
-      return checkLen > 0 && checkLen !== rowLen ? {
-        value: 'checked',
-        indeterminate: true
-      } : {
-        value: 'checked'
-      };
-    },
-    saveRelationshipLabel() {
-      if (this.relationshipField && (this.relationshipField.max === 1)) {
-        return 'Select Page';
-      } else {
-        return 'Select Pages';
-      }
-    },
-    headers() {
-      let headers = this.options.columns || [];
-      if (!this.pageSetMenuSelectionIsLive) {
-        headers = headers.filter(h => h.component !== 'AposCellLabels');
-      }
-      return headers;
-    },
-    pageSetMenu() {
-      return [ {
-        label: 'apostrophe:live',
-        action: 'live',
-        modifiers: this.pageSetMenuSelectionIsLive ? [ 'selected', 'disabled' ] : []
-      }, {
-        label: 'apostrophe:archived',
-        action: 'archive',
-        modifiers: !this.pageSetMenuSelectionIsLive ? [ 'selected', 'disabled' ] : []
-      } ];
-    },
-    pageSetMenuButton() {
-      const button = {
-        label: this.pageSetMenuSelectionIsLive ? 'apostrophe:live' : 'apostrophe:archived',
-        icon: 'chevron-down-icon',
-        modifiers: [ 'no-motion', 'outline', 'icon-right' ],
-        class: 'apos-pages-manager__page-set-menu-button'
-      };
-      return button;
-    },
-    pageSetMenuSelectionIsLive() {
-      return this.pageSetMenuSelection === 'live';
-    }
-  },
-  watch: {
-    async pageSetMenuSelection() {
-      await this.getPages();
-    }
-  },
-  async mounted() {
-    // Get the data. This will be more complex in actuality.
-    this.modal.active = true;
-    await this.getPages();
-    this.modal.triggerFocusRefresh++;
-
-    apos.bus.$on('content-changed', this.getPages);
-    apos.bus.$on('command-menu-manager-create-new', this.create);
-    apos.bus.$on('command-menu-manager-close', this.confirmAndCancel);
-  },
-  destroyed() {
-    apos.bus.$off('content-changed', this.getPages);
-    apos.bus.$off('command-menu-manager-create-new', this.create);
-    apos.bus.$off('command-menu-manager-close', this.confirmAndCancel);
-  },
-  methods: {
-    moreMenuHandler(action) {
-      if (action === 'new') {
-        this.create();
-      }
-    },
-    async getPages () {
-      const self = this;
-      if (this.gettingPages) {
-        // Avoid race conditions by trying again later if already in progress
-        setTimeout(this.getPages, 100);
-        return;
-      }
-      // Not reactive, so not in data()
-      this.gettingPages = true;
-      try {
-        this.pages = [];
-        this.pagesFlat = [];
-
-        let pageTree = (await apos.http.get(
-          '/api/v1/@apostrophecms/page', {
-            busy: true,
-            qs: {
-              all: '1',
-              archived: this.relationshipField || this.pageSetMenuSelectionIsLive ? '0' : 'any',
-              // Also fetch published docs as _publishedDoc subproperties
-              withPublished: 1
-            },
-            draft: true
-          }
-        ));
-
-        // If editor is looking at the archive tree, trim the normal page tree response
-        if (this.pageSetMenuSelection === 'archive') {
-          pageTree = pageTree._children.find(page => page.slug === '/archive');
-          pageTree = pageTree._children;
-        }
-
-        formatPage(pageTree);
-
-        if (!pageTree.length && pageTree.length !== 0) {
-          pageTree = [ pageTree ];
-        }
-
-        this.pages = [ ...pageTree ];
-
-      } finally {
-        this.gettingPages = false;
-      }
-
-      function formatPage(page) {
-        if (page.length) {
-          page.forEach(formatPage);
-          return;
-        }
-
-        self.pagesFlat.push(klona(page));
-
-        if (Array.isArray(page._children)) {
-          page._children.forEach(formatPage);
-        }
-      }
-    },
-    async update(page) {
-      const body = {
-        _targetId: page.endContext,
-        _position: page.endIndex
-      };
-
-      const route = `${this.moduleOptions.action}/${page.changedId}`;
-      try {
-        await apos.http.patch(route, {
-          busy: true,
-          body,
-          draft: true
-        });
-      } catch (error) {
-        await apos.notify(error.body.message || this.$t('apostrophe:treeError'), {
-          type: 'danger',
-          icon: 'alert-circle-icon',
-          dismiss: true,
-          localize: false
-        });
-      }
-
-      await this.getPages();
-      if (this.pagesFlat.find(page => {
-        return (page.aposDocId === (window.apos.page.page && window.apos.page.page.aposDocId)) && page.archived;
-      })) {
-        // With the current page gone, we need to move to safe ground
-        location.assign(`${window.apos.prefix}/`);
-      }
-    },
-    toggleRowCheck(id) {
-      if (this.checked.includes(id)) {
-        this.checked = this.checked.filter(item => item !== id);
-      } else {
-        this.checked.push(id);
-      }
-    },
-    selectAll(event) {
-      if (!this.checked.length) {
-        this.pagesFlat.forEach((row) => {
-          this.toggleRowCheck(row._id);
-        });
-        return;
-      }
-
-      if (this.checked.length <= this.pagesFlat.length) {
-        this.checked.forEach((id) => {
-          this.toggleRowCheck(id);
-        });
-      }
-    },
-    async create() {
-      const doc = await apos.modal.execute(this.moduleOptions.components.editorModal, {
-        moduleName: this.moduleName
-      });
-      if (!doc) {
-        // Cancel clicked
-        return;
-      }
-      await this.getPages();
-      if (this.relationshipField) {
-        doc._fields = doc._fields || {};
-        // Must push to checked docs or it will try to do it for us
-        // and not include _fields
-        this.checkedDocs.push(doc);
-        this.checked.push(doc._id);
-      }
-    },
-    setCheckedDocs(checkedDocs) {
-      this.checked = checkedDocs.map(doc => doc._id);
-    },
-    updateCheckedDocs() {
-      this.checkedDocs = this.checked.map(_id => this.pagesFlat.find(page => page._id === _id));
-    }
-  }
+  mixins: [ AposPagesManagerLogic ],
+  // Keep it for linting
+  emits: [ 'archive', 'search', 'safe-close', 'modal-result' ]
 };
 </script>