add get-apos-doc-id and set-apos-doc-id tasks (#5136)

* add get-apos-doc-id and set-apos-doc-id tasks

* require at the top

* add tests for changing apos doc ID

* test apos-doc-id get and set tasks

* update changelog

* remove only

* filter non existing _id values + remove req usage

* add missing usage

* remove locale when using _id

* test get-apos-doc-id without locale when using _id

---------

Co-authored-by: Harouna Traoré <haroun@users.noreply.github.com>

Author: haroun

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Adds `stripUrlAccents` option in `@apostrophecms/i18n` module to globally control whether accents are stripped from URLs. When set to `true`, all URLs (slugs) will have accents from Latin characters removed on document creation and updates. No existing documents are modified automatically; this only affects new or updated documents. A new task `node app @apostrophecms/i18n:strip-slug-accents` is provided to update existing document slugs in the database when needed.
 * Add `@apostrophecms/migration:add-missing-schema-fields` task. This task does not run database migrations.
 * Translation strings added for the layout- and layout-column-widgets.
+* Adds `@apostrophecms/doc:get-apos-doc-id` and `@apostrophecms/doc:set-apos-doc-id` tasks.
 * New `box` schema field type
 * When switching locale from the doc editor, ask if the user wants to localize the current document in the target locale or want to start a blank document.
 * Introduced a new `longPolling: false` option for the `@apostrophecms/notification` module. This eliminates long-pending requests when logged in, but also slows down the delivery of notifications. The behavior can be tuned further via the `pollingInterval` option, which defaults to `5000` milliseconds.

modules/@apostrophecms/doc/index.js

@@ -2,6 +2,8 @@ const _ = require('lodash');
 const { createId } = require('@paralleldrive/cuid2');
 const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const { klona } = require('klona');
+const legacyMigrations = require('./lib/legacy-migrations.js');
+const migrations = require('./lib/migrations.js');
 
 // This module is responsible for managing all of the documents (apostrophe
 // "docs") in the `aposDocs` mongodb collection.
@@ -1851,8 +1853,125 @@ module.exports = {
         return existing?.aposDocId || self.apos.util.generateId();
       },
 
-      ...require('./lib/legacy-migrations')(self),
-      ...require('./lib/migrations')(self)
+      async getAposDocId({
+        _id, slug, locale
+      }) {
+        if (!_id && !slug) {
+          throw self.apos.error('invalid', 'Either _id or slug must be provided');
+        }
+        if (!_id && !locale) {
+          throw self.apos.error('invalid', 'Missing locale');
+        }
+
+        const criteria = _id
+          ? { _id }
+          : {
+            slug,
+            aposLocale: new RegExp(`^${self.apos.util.regExpQuote(locale)}:`)
+          };
+
+        const doc = await self.apos.doc.db
+          .findOne(criteria, { projection: { aposDocId: 1 } });
+        if (!doc || !doc.aposDocId) {
+          throw self.apos.error('notfound');
+        }
+
+        return doc.aposDocId;
+      },
+      async setAposDocId({
+        newId, oldId, slug, locale
+      }) {
+        if (!newId) {
+          throw self.apos.error('invalid', 'Missing newId');
+        }
+        if (!oldId && !slug) {
+          throw self.apos.error('invalid', 'Either oldId or slug must be provided');
+        }
+        if (!locale) {
+          throw self.apos.error('invalid', 'Missing locale');
+        }
+
+        const originalId = (slug && !oldId)
+          ? await self.getAposDocId({
+            slug,
+            locale
+          })
+          : oldId;
+
+        const modes = [ 'previous', 'draft', 'published' ];
+        const pairs = modes.map(mode =>
+          [
+            `${originalId}:${locale}:${mode}`,
+            `${newId}:${locale}:${mode}`
+          ]
+        );
+
+        // Filter non existing from _id from the list
+        const existing = (
+          await self.apos.doc.db
+            .find(
+              { _id: { $in: pairs.map(([ from ]) => from) } },
+              { projection: { _id: 1 } }
+            )
+            .toArray()
+        )
+          .map(({ _id }) => _id);
+        const { renamed } = await self.changeDocIds(
+          pairs.filter(([ from ]) => existing.includes(from)),
+          { keep: false }
+        );
+
+        return {
+          oldId: originalId,
+          newId,
+          locale,
+          renamed
+        };
+      },
+
+      ...legacyMigrations(self),
+      ...migrations(self)
+    };
+  },
+  tasks(self) {
+    return {
+      'get-apos-doc-id': {
+        usage: 'Retrieve the aposDocId from the _id or slug, and the locale. Usage: "node app.js @apostrophecms/doc:get-apos-doc-id --_id=pfh0haxfpzowht3oi213cqos:fr:draft" or "node app.js @apostrophecms/doc:get-apos-doc-id --slug=test --locale=fr"',
+        task: async (argv) => {
+          const {
+            _id, slug, locale
+          } = argv;
+
+          const aposDocId = await self.getAposDocId({
+            _id,
+            slug,
+            locale
+          });
+
+          self.apos.util.info(aposDocId);
+
+          return aposDocId;
+        }
+      },
+      'set-apos-doc-id': {
+        usage: 'Change the aposDocId of an existing document. You need the new aposDocId (new-id), the old aposDocId (old-id) or the slug, and the locale. Usage: "node app.js @apostrophecms/doc:set-apos-doc-id --new-id=tz4a98xxat96iws9zmbrgj3a --old-id=pfh0haxfpzowht3oi213cqos --locale=fr" or "node app.js @apostrophecms/doc:set-apos-doc-id --new-id=tz4a98xxat96iws9zmbrgj3a --slug=test --locale=fr"',
+        task: async (argv) => {
+          const {
+            'new-id': newId, 'old-id': oldId, slug, locale
+          } = argv;
+
+          const result = await self.setAposDocId({
+            newId,
+            oldId,
+            slug,
+            locale
+          });
+
+          self.apos.util.info(`"${result.oldId}" has been changed to "${result.newId}" for locale "${result.locale}", ${result.renamed} documents changed.`);
+
+          return result;
+        }
+      }
     };
   }
 };