Integrate interactions with @bedrock/notify.

Author: dlongley

lib/config.js

@@ -50,17 +50,8 @@ config.ensureConfigOverride.fields.push(meterServiceName);
 
 // optional interaction config
 cfg.interactions = {
+  // FIXME: add qr-code route fallback for non-accept-json "protocols" requests
   enabled: false,
-  caches: {
-    // FIXME: remove; replace with bedrock-notify
-    exchangePolling: {
-      // each cache value is only a boolean (the key is ~64 bytes); one entry
-      // per exchange being actively polled, 1M = ~60 MiB
-      max: 1000000,
-      // polling allowed no more than once per second by default
-      ttl: 1000
-    }
-  },
   // named workflows for interactions
   /* Spec:
   {

lib/interactions.js

@@ -1,19 +1,20 @@
 /*!
- * Copyright (c) 2020-2024 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2025 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
 import * as schemas from '../schemas/bedrock-profile-http.js';
+import {poll, pollers} from '@bedrock/notify';
+import {agent} from '@bedrock/https-agent';
 import {asyncHandler} from '@bedrock/express';
 import {ensureAuthenticated} from '@bedrock/passport';
-import {LRUCache} from 'lru-cache';
+import {httpClient} from '@digitalbazaar/http-client';
 import {createValidateMiddleware as validate} from '@bedrock/validation';
-import {ZCAP_CLIENT} from './zcapClient.js';
+import {ZCAP_CLIENT as zcapClient} from './zcapClient.js';
 
 const {config, util: {BedrockError}} = bedrock;
 
 let WORKFLOWS_BY_NAME_MAP;
 let WORKFLOWS_BY_ID_MAP;
-let EXCHANGE_POLLING_CACHE;
 
 bedrock.events.on('bedrock.init', () => {
   const cfg = config['profile-http'];
@@ -52,10 +53,6 @@ bedrock.events.on('bedrock.init', () => {
     WORKFLOWS_BY_NAME_MAP.set(workflowName, workflow);
     WORKFLOWS_BY_ID_MAP.set(localInteractionId, workflow);
   }
-
-  // setup caches
-  const {caches} = interactions;
-  EXCHANGE_POLLING_CACHE = new LRUCache(caches.exchangePolling);
 });
 
 bedrock.events.on('bedrock-express.configure.routes', app => {
@@ -73,8 +70,6 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
     interaction: `${interactionsPath}/:localInteractionId/:localExchangeId`
   };
 
-  const retryAfter = Math.ceil(EXCHANGE_POLLING_CACHE.ttl / 1000);
-
   // create an interaction to exchange VCs
   app.post(
     routes.interactions,
@@ -97,6 +92,7 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
 
       // create exchange with given variables
       const exchange = {
+        // FIXME: use `expires` instead of now-deprecated `ttl`
         // 15 minute expiry in seconds
         ttl: 60 * 15,
         // template variables
@@ -106,7 +102,7 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
         }
       };
       const capability = workflow.zcaps.get('readWriteExchanges');
-      const response = await ZCAP_CLIENT.write({json: exchange, capability});
+      const response = await zcapClient.write({json: exchange, capability});
       const exchangeId = response.headers.get('location');
       const {localInteractionId} = workflow;
       // reuse `localExchangeId` in path
@@ -120,9 +116,13 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
   app.get(
     routes.interaction,
     ensureAuthenticated,
+    // FIXME: add URL query validator that requires no query or `iuv=1` only
     asyncHandler(async (req, res) => {
       const {id: accountId} = req.user.account || {};
-      const {localInteractionId, localExchangeId} = req.params;
+      const {
+        params: {localInteractionId, localExchangeId},
+        query: {iuv}
+      } = req;
 
       const workflow = WORKFLOWS_BY_ID_MAP.get(localInteractionId);
       if(!workflow) {
@@ -136,34 +136,66 @@ bedrock.events.on('bedrock-express.configure.routes', app => {
           });
       }
 
-      // check if entry is in exchange polling cache, if so, return
-      // "too many requests" error response
-      const key = `${localExchangeId}/${localExchangeId}`;
-      if(EXCHANGE_POLLING_CACHE.get(key)) {
-        res.set('retry-after', retryAfter);
-        res.status(429).json({retryAfter});
-        return;
+      // determine full exchange ID based on related capability
+      const capability = workflow.zcaps.get('readWriteExchanges');
+      const exchangeId = `${capability.invocationTarget}/${localExchangeId}`;
+
+      // if an "Interaction URL Version" is present send "protocols"
+      // (note: validation requires it to be `1`, so no need to check its value)
+      if(iuv) {
+        // FIXME: send to a QR-code page if supported
+        // FIXME: check config for supported QR code route and use it
+        // instead of hard-coded value
+        if(req.accepts('html') || !req.accepts('json')) {
+          return res.redirect(`${req.originalUrl}/qr-code`);
+        }
+        try {
+          const url = `${exchangeId}/protocols`;
+          const {data: protocols} = await httpClient.get(url, {agent});
+          res.json(protocols);
+        } catch(cause) {
+          throw new BedrockError(
+            'Unable to serve protocols object: ' + cause.message, {
+              name: 'OperationError',
+              details: {httpStatusCode: 500, public: true},
+              cause
+            });
+        }
       }
 
-      // fetch exchange
-      const capability = workflow.zcaps.get('readWriteExchanges');
-      const response = await ZCAP_CLIENT.read({
-        url: `${capability.invocationTarget}/${localExchangeId}`,
-        capability
+      // poll the exchange...
+      const result = await poll({
+        id: exchangeId,
+        poller: pollers.createExchangePoller({
+          zcapClient,
+          capability,
+          filterExchange({exchange/*, previousPollResult*/}) {
+            // ensure `accountId` matches exchange variables
+            if(exchange?.variables.accountId !== accountId) {
+              throw new BedrockError(
+                'Not authorized.',
+                'NotAllowedError',
+                {httpStatusCode: 403, public: true});
+            }
+            // return only information that should be accessible to client
+            return {
+              exchange
+              // FIXME: filter info once final step name and info is determined
+              /*
+              exchange: {
+                state: exchange.state,
+                result: exchange.variables.results?.finish
+              }*/
+            };
+          }
+        }),
+        // set a TTL of 1 seconds to account for the case where a push
+        // notification isn't received by the same instance that the client
+        // hits, but prevent requests from triggering a hit to the backend more
+        // frequently than 1 second
+        ttl: 1000
       });
 
-      // prevent more polling on the same exchange for another second
-      EXCHANGE_POLLING_CACHE.set(key, true);
-
-      // ensure `accountId` matches exchange variables
-      const {exchange: {state, variables}} = response;
-      if(variables.accountId !== accountId) {
-        throw new BedrockError(
-          'The "account" is not authorized.',
-          'NotAllowedError',
-          {httpStatusCode: 403, public: true});
-      }
-
-      res.json({exchange: {state, variables}});
+      res.json(result);
     }));
 });

package.json

@@ -31,13 +31,14 @@
   "dependencies": {
     "@digitalbazaar/ed25519-signature-2020": "^5.4.0",
     "@digitalbazaar/ezcap": "^4.1.0",
-    "lru-cache": "^10.2.2"
+    "@digitalbazaar/http-client": "^4.2.0"
   },
   "peerDependencies": {
     "@bedrock/app-identity": "^4.0.0",
     "@bedrock/core": "^6.3.0",
     "@bedrock/express": "^8.3.1",
     "@bedrock/https-agent": "^4.1.0",
+    "@bedrock/notify": "^1.1.0",
     "@bedrock/passport": "^12.0.0",
     "@bedrock/profile": "^26.0.0",
     "@bedrock/validation": "^7.1.1"

test/package.json

@@ -27,6 +27,7 @@
     "@bedrock/meter-http": "^14.0.0",
     "@bedrock/meter-usage-reporter": "^10.0.0",
     "@bedrock/mongodb": "^11.0.0",
+    "@bedrock/notify": "^1.1.0",
     "@bedrock/package-manager": "^3.0.0",
     "@bedrock/passport": "^12.0.0",
     "@bedrock/profile": "^26.0.0",

test/test.js

@@ -1,5 +1,5 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2025 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
 import {handlers} from '@bedrock/meter-http';
@@ -13,6 +13,7 @@ import '@bedrock/https-agent';
 import '@bedrock/jsonld-document-loader';
 import '@bedrock/meter';
 import '@bedrock/meter-usage-reporter';
+import '@bedrock/notify';
 import '@bedrock/passport';
 import '@bedrock/server';
 import '@bedrock/kms-http';