feat: Subscribe to new parcel notifications in PoWeb via Redis PubSub

chart/dev-backing-services/Chart.yaml

@@ -21,12 +21,12 @@ dependencies:
   - name: stan
     version: 0.7.2
     repository: https://nats-io.github.io/k8s/helm/charts
+  - name: redis
+    version: 16.12.2
+    repository: https://charts.bitnami.com/bitnami
 
   # Pong app
   - name: relaynet-pong
     version: 3.0.37
     repository: https://h.cfcr.io/relaycorp/public
     alias: pong
-  - name: redis
-    version: 16.12.2
-    repository: https://charts.bitnami.com/bitnami

chart/dev-backing-services/values.yml

@@ -43,7 +43,16 @@ stan:
   store:
     type: memory
 
-# Relaynet Pong dependencies
+redis:
+  fullnameOverride: redis
+  auth:
+    enabled: false
+  architecture: standalone
+  master:
+    persistence:
+      enabled: false
+
+# Awala Pong dependencies
 pong:
   fullnameOverride: pong
   pohttp_tls_required: false
@@ -54,11 +63,3 @@ pong:
     session_keys_mount_path: pong-keys
   redis:
     host: redis-headless
-redis:
-  fullnameOverride: redis
-  auth:
-    enabled: false
-  architecture: standalone
-  master:
-    persistence:
-      enabled: false

chart/templates/global-cm.yml

@@ -20,6 +20,8 @@ data:
   NATS_SERVER_URL: {{ .Values.nats.serverUrl }}
   NATS_CLUSTER_ID: {{ .Values.nats.clusterId }}
 
+  REDIS_URL: {{ .Values.redis.url }}
+
   OBJECT_STORE_BACKEND: {{ .Values.objectStore.backend }}
   OBJECT_STORE_BUCKET: {{ .Values.objectStore.bucket }}
   {{- if .Values.objectStore.endpoint }}

chart/values.dev.yml

@@ -29,6 +29,9 @@ nats:
   serverUrl: nats://nats:4222
   clusterId: stan
 
+redis:
+  url: redis://dev-backing-services-redis-headless:6379
+
 objectStore:
   backend: minio
   endpoint: minio:9000

chart/values.schema.json

@@ -7,6 +7,7 @@
     "pdcQueue",
     "mongo",
     "nats",
+    "redis",
     "keystore"
   ],
   "properties": {
@@ -132,6 +133,16 @@
         }
       }
     },
+    "redis": {
+      "type": "object",
+      "required": ["url"],
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri"
+        }
+      }
+    },
     "objectStore": {
       "type": "object",
       "required": ["backend", "bucket"],

chart/values.yaml

@@ -84,6 +84,7 @@ crcQueue:
 mongo: {}
 
 nats: {}
+redis: {}
 
 objectStore:
   tlsEnabled: true

docs/architecture.md

@@ -62,12 +62,17 @@ This server is used to store parcels and cargoes under the following object key
 
 ### NATS Streaming
 
-[NAT Streaming](https://docs.nats.io/nats-streaming-concepts/intro) is used for inter-component communication using asynchronous messaging. The following channels are used:
+[NAT Streaming](https://docs.nats.io/nats-streaming-concepts/intro) is used for inter-component communication using asynchronous messaging, when we need messages to be persisted until a subscriber processes them. The following channels are used:
 
-- `pdc-parcel.${privateGatewayId}` where `${privateGatewayId}` is the id of the private gateway. Parcels received via Internet-based PDCs (e.g., PoHTTP) are published on these channels.
 - `internet-parcels`. Parcels bound for an internet.
 - `crc-cargo`. Cargo received via CRC (e.g., CogRPC) are published here.
 
+### Redis
+
+[Redis PubSub](https://redis.io/docs/interact/pubsub/) is used for inter-component communication using asynchronous messaging, when we don't need messages to be persisted. The following channels are used:
+
+- `pdc-parcel.${privateGatewayId}` where `${privateGatewayId}` is the id of the private gateway. Parcels received via Internet-based PDCs (e.g., PoHTTP) are published on these channels.
+
 ### HashiCorp Vault
 
 [HashiCorp Vault](https://www.vaultproject.io/) is used to store the key pairs for identity and session keys.

docs/install.md

@@ -21,6 +21,8 @@ mongo:
 nats:
   serverUrl: nats://nats.example.com:4222
   clusterId: example-stan
+redis:
+  url: redis://redis.example.com:6379
 objectStore:
   endpoint: minio.example.com:9000
   bucket: public-gateway
@@ -101,6 +103,7 @@ Each gateway component has the following options:
 | `mongo.password` | string | | MongoDB user password |
 | `nats.serverUrl` | string | | Connection URI for NATS Streaming |
 | `nats.clusterId` | string | | NATS Streaming cluster id |
+| `redis.url` | string | | Connection URI for Redis |
 | `objectStore.endpoint` | string | | Host name and port number for the object store server |
 | `objectStore.bucket` | string | | Bucket name |
 | `objectStore.accessKeyId` | string | | Access key id to the object store |

package.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.8.21",
+    "@redis/client": "^1.5.11",
     "@relaycorp/awala-keystore-cloud": "^2.1.17",
     "@relaycorp/awala-keystore-mongodb": "^1.1.19",
     "@relaycorp/cogrpc": "^1.3.75",