Document versions (#5610)

Author: myovchev

.changeset/db-connect-cursor-release.md

@@ -0,0 +1,5 @@
+---
+"@apostrophecms/db-connect": patch
+---
+
+The postgres cursor returns its pooled connection when iteration stops early: on a query error inside `next()`, and when a `for await` loop exits through `break`, `return` or a throwing body. Previously each abandoned cursor kept a connection checked out for the life of the process  (PRO-10051).

.changeset/db-connect-ejson.md

@@ -0,0 +1,5 @@
+---
+"@apostrophecms/db-connect": patch
+---
+
+Export the driver's `EJSON` (Extended JSON) so apostrophe modules can serialize documents without a direct driver dependency.

.changeset/db-connect-numeric-sort.md

@@ -0,0 +1,5 @@
+---
+"@apostrophecms/db-connect": patch
+---
+
+The postgres adapter's `sort()` orders numbers numerically instead of as text, so `10` no longer sorts before `2` and the children of a page with ten or more of them stay in rank order (PRO-10055).

.changeset/document-versions.md

@@ -0,0 +1,5 @@
+---
+"apostrophe": minor
+---
+
+Document Versions ships in core as `@apostrophecms/document-versions`, on for pages and pieces by default and set per type with the `versions` option: a history of drafts and publications with the editor who saved each one and whether AI was involved, a list of what every version changed field by field, those changes marked on the document where they render, restore from a version's own entry, and Undo Publish through the history. Existing version records are converted on upgrade.

.changeset/import-export-ai-versions.md

@@ -0,0 +1,5 @@
+---
+"@apostrophecms/import-export": patch
+---
+
+Documents translated during an import are recorded as AI-assisted versions in Document Versions.

.changeset/migration-each-close.md

@@ -0,0 +1,5 @@
+---
+"apostrophe": patch
+---
+
+`apos.migration.each` now closes its cursor when the iterator throws, instead of leaving it open (PRO-10051).

.github/workflows/monorepo.yml

@@ -34,6 +34,10 @@ on:
         required: false
         type: boolean
         default: false
+      automatic-translation-ref:
+        description: automatic-translation branch, tag or commit for the import-export tests with Pro modules
+        required: false
+        type: string
 
 jobs:
   setup:
@@ -335,6 +339,7 @@ jobs:
           # Yes we want import-export to test with automatic-translation,
           # but only when the deploy key is available (not on fork PRs).
           TEST_WITH_PRO: ${{ env.HAS_PRO_KEY == 'true' && '1' || '' }}
+          APOS_AUTOMATIC_TRANSLATION_REF: ${{ inputs.automatic-translation-ref || env.APOS_AUTOMATIC_TRANSLATION_REF }}
           # Adapter selection: mongodb (default), postgres, or sqlite.
           # ADAPTER is used by db-connect tests, APOS_TEST_DB_PROTOCOL by apostrophe tests.
           ADAPTER: ${{ matrix.adapter }}

packages/apostrophe/defaults.js

@@ -68,6 +68,7 @@ module.exports = {
     '@apostrophecms/submitted-draft': {},
     '@apostrophecms/recently-edited': {},
     '@apostrophecms/command-menu': {},
-    '@apostrophecms/translation': {}
+    '@apostrophecms/translation': {},
+    '@apostrophecms/document-versions': {}
   }
 };

packages/apostrophe/modules/@apostrophecms/area/index.js

@@ -121,17 +121,43 @@ module.exports = {
             return 'aposLivePreviewSchemaNotYetValid';
           }
 
+          // A widget of a document version, posted with the widget it was
+          // in the version before, hands it to its template when its type
+          // sets `versionsRender`
+          const older = await getOlderVersion();
+
           widget._edit = true;
           widget._docId = _docId;
           // So that carrying out relationship loading again can yield results
           // (the idsStorage must be populated as if we were saving)
           self.apos.schema.prepareForStorage(req, widget);
+          if (older) {
+            self.apos.schema.prepareForStorage(req, older);
+          }
           await load();
+          if (older) {
+            widget._olderVersion = older;
+          }
           return render();
+          async function getOlderVersion() {
+            const data = req.body.widget?._olderVersion;
+            if (!data || (typeof data !== 'object') || !manager.options.versionsRender) {
+              return null;
+            }
+            try {
+              return await manager.sanitize(req, data, options);
+            } catch (e) {
+              // It renders as it would without its older version
+              return null;
+            }
+          }
           async function load() {
             // Hint to call nested widget loaders as if it were a doc
             widget._virtual = true;
-            return manager.loadIfSuitable(req, [ widget ]);
+            if (older) {
+              older._virtual = true;
+            }
+            return manager.loadIfSuitable(req, older ? [ widget, older ] : [ widget ]);
           }
           async function render() {
             if (req.aposExternalFront) {

packages/apostrophe/modules/@apostrophecms/area/ui/apos/apps/AposAreas.js

@@ -172,8 +172,10 @@ export default function() {
       event.claim();
     }
 
+    // The newest entry: a scroll right after `observe` arrives in the same
+    // callback as the first report, which still says the area is out of view
     function observed(entries) {
-      const intersects = entries[0].isIntersecting;
+      const intersects = entries.at(-1).isIntersecting;
       if (!intersects) {
         return;
       }