site-dependencies.js foundation for partial build work

By exposing a map of component-version to origins, with latest SHA,
and dependencies (e.g. origins referenced via include:: or image::)
we lay foundations for partial build work.

Output will look like

   "server@8.1": {
     "origins": {
       "https://github.com/couchbase/docs-server.git@release/8.1": "123456789",
       "https://github.com/couchbaselabs/docs-devex.git@release/8.1": "abcdefg",
       "https://github.com/couchbaselabs/cb-swagger.git@release/8.1:docs": "5e4776963c"
     },
     "dependencies": [
       "https://github.com/couchbase/docs-server.git@release/8.1",
       "https://github.com/couchbaselabs/docs-devex.git@release/8.1",
       "https://github.com/couchbaselabs/cb-swagger.git@release/8.1:docs"
     ]
   },

The SHA will note be present for local worktrees (e.g. if run locally, or for docs-site).

Author: osfameron

antora-playbook-staging.diff.yml

@@ -3,6 +3,7 @@ antora:
   - ./lib/report-tree.js
   - ./lib/site-stats-extension.js
   - ./lib/component-stats.js
+  - ./lib/site-dependencies.js
 
 site:
   title: Couchbase Docs Staging

antora-playbook-staging.yml

@@ -15,7 +15,7 @@ urls:
   latest_version_segment: current
 ui:
   bundle:
-    url: https://github.com/couchbase/docs-ui/releases/download/prod-230/ui-bundle.zip
+    url: https://github.com/couchbase/docs-ui/releases/download/prod-229/ui-bundle.zip
 output:
   dir: ./public
 runtime:
@@ -29,6 +29,7 @@ antora:
     - ./lib/report-tree.js
     - ./lib/site-stats-extension.js
     - ./lib/component-stats.js
+    - ./lib/site-dependencies.js
 site:
   title: Couchbase Docs Staging
   url: https://docs-staging.couchbase.com
@@ -201,7 +202,6 @@ content:
         - release/2.0
         - release/1.2
         - release/1.1
-        - release/1.0
     - url: https://github.com/couchbase/docs-connectors-power-bi
       branches:
         - release/1.3
@@ -363,23 +363,25 @@ content:
         - release/2.8
     - url: https://github.com/couchbase/docs-couchbase-lite
       branches:
+        - release/4.1
         - release/4.0
-        - release/3.3
-        - release/3.2
+        - release/3.4
     - url: https://github.com/couchbaselabs/docs-couchbase-lite-js
       branches:
         - release/1.0
     - url: https://github.com/couchbase/docs-sync-gateway
       branches:
+        - release/4.1
         - release/4.0
         - release/3.3
-        - release/3.2
     - url: https://github.com/couchbaselabs/docs-couchbase-lite-edge-server
       branches:
+        - release/1.1
         - release/1.0
     - url: https://github.com/couchbase/edge-server
       branches:
-        - main
+        - release/1.1
+        - release/1.0
       start_path: docs
     - url: https://github.com/couchbaselabs/mobile-travel-sample
       branches:

lib/site-dependencies.js

@@ -0,0 +1,81 @@
+'use strict'
+
+const cvs = {}
+
+module.exports.register = function () {
+  // '8.0@docs-server' -> Set of '8.0@docs-devex'
+  this.once('contentClassified', ({ contentCatalog }) => {
+    this.updateVariables({ contentCatalog: trackingContentCatalog(contentCatalog, record) })
+  })
+
+  this.once('beforePublish', ({ siteCatalog }) => {
+    const depsFile = createDependenciesFile(cvs)
+    siteCatalog.addFile(depsFile)
+  })
+
+  this.once('contentAggregated', ({ contentAggregate }) => {
+
+    for (const cv of contentAggregate) {
+      const cvKey = `${cv.name}@${cv.version}`
+      const origins = Object.fromEntries(
+        cv.origins.map(o => [repoKey(o), o.refhash || null]))
+
+      cvs[cvKey] = { origins, dependencies: new Set() }
+    }
+
+    // compare repos[].sha against your persisted previous-build record
+  })
+
+}
+
+function repoKey ({ url, refname, startPath }) {
+  return `${url}@${refname}${startPath ? ':' + startPath : ''}`
+}
+
+function record (from, to) {
+  if (!to.origin) return // stub/synthetic files (e.g. Atlas-imported pages) carry no origin
+
+  const fromKey = `${from.component}@${from.version}`
+  const toKey = repoKey(to.origin)
+
+  cvs[fromKey].dependencies.add(toKey)
+}
+
+function trackingContentCatalog (contentCatalog, record) {
+  return new Proxy(contentCatalog, {
+    get (target, property) {
+      if (property !== 'resolveResource') return target[property]
+      return (spec, context, defaultFamily, permittedFamilies) => {
+        const resolved = target.resolveResource(spec, context, defaultFamily, permittedFamilies)
+
+        // we explicitly don't want to handle 'page', as those are already
+        // dealt with by Atlas
+        if (resolved && resolved.src && resolved.src.family !== 'page') {
+          record(context, resolved.src)
+        }
+        return resolved
+      }
+    },
+  })
+}
+
+const replacer = function (k, v) {
+  if (v instanceof Set) {
+    return Array.from(v)
+  }
+  else {
+    return v
+  }
+}
+
+function createDependenciesFile (data) {
+  const contents = JSON.stringify(data, replacer, 2) + '\n'
+  return {
+    contents: Buffer.from(contents),
+    mediaType: 'application/json',
+    out: { path: 'site-dependencies.json' },
+    path: 'site-dependencies.json',
+    pub: { url: '/site-dependencies.json', rootPath: '' },
+    src: { stem: 'site-dependencies' },
+  }
+}