IVA Notifications (GSI-741)

.devcontainer/.dev_config.yaml

@@ -11,3 +11,5 @@ notification_event_type: notification
 notification_event_topic: notification_events
 file_registered_event_topic: internal_file_registry
 file_registered_event_type: file_registered
+iva_events_topic: ivas
+iva_state_changed_event_type: iva_state_changed

.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
       - id: no-commit-to-branch
         args: [--branch, dev, --branch, int, --branch, main]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.2
+    rev: v0.4.3
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

README.md

@@ -151,6 +151,26 @@ The service requires the following configuration parameters:
   ```
 
 
+- **`iva_events_topic`** *(string)*: The name of the topic containing IVA events.
+
+
+  Examples:
+
+  ```json
+  "ivas"
+  ```
+
+
+- **`iva_state_changed_event_type`** *(string)*: The type to use for iva state changed events.
+
+
+  Examples:
+
+  ```json
+  "iva_state_changed"
+  ```
+
+
 - **`service_name`** *(string)*: The Notification Orchestration Service controls the creation of notification events. Default: `"nos"`.
 
 - **`service_instance_id`** *(string)*: A string that uniquely identifies this instance across all instances of this service. This is included in log messages.

config_schema.json

@@ -84,6 +84,22 @@
       "title": "File Registered Event Type",
       "type": "string"
     },
+    "iva_events_topic": {
+      "description": "The name of the topic containing IVA events.",
+      "examples": [
+        "ivas"
+      ],
+      "title": "Iva Events Topic",
+      "type": "string"
+    },
+    "iva_state_changed_event_type": {
+      "description": "The type to use for iva state changed events.",
+      "examples": [
+        "iva_state_changed"
+      ],
+      "title": "Iva State Changed Event Type",
+      "type": "string"
+    },
     "service_name": {
       "default": "nos",
       "description": "The Notification Orchestration Service controls the creation of notification events.",
@@ -205,6 +221,8 @@
     "access_request_denied_event_type",
     "file_registered_event_topic",
     "file_registered_event_type",
+    "iva_events_topic",
+    "iva_state_changed_event_type",
     "service_instance_id",
     "kafka_servers",
     "central_data_stewardship_email"

example_config.yaml

@@ -8,6 +8,8 @@ db_name: users
 file_registered_event_topic: internal_file_registry
 file_registered_event_type: file_registered
 generate_correlation_id: true
+iva_events_topic: ivas
+iva_state_changed_event_type: iva_state_changed
 kafka_security_protocol: PLAINTEXT
 kafka_servers:
 - kafka:9092

lock/requirements.txt

@@ -51,13 +51,13 @@ attrs==23.2.0 \
     # via
     #   jsonschema
     #   referencing
-boto3==1.34.94 \
-    --hash=sha256:22f65b3c9b7a419f8f39c2dddc421e14fab8cbb3bd8a9d467e874237d39f59b1 \
-    --hash=sha256:bbb87d641c73462e53b1777083b55c8f13921618ad08757478a8122985c56c13
+boto3==1.34.98 \
+    --hash=sha256:030e43b8efe22b4cf10b9f3ef9e30cd4cf9ef9784b26efe9a4583339f2b2bcec \
+    --hash=sha256:28c10956033fa79e64529f48c3b62db86d5e4b77024a7343764b6bde6b553543
     # via hexkit
-botocore==1.34.94 \
-    --hash=sha256:99b11be9a28f9051af4c96fa121e9c3f22a86d499abd773c9e868b2a38961bae \
-    --hash=sha256:f00a79002e0cb9d6895ecd0919c506402850177d7b6c4d2634fa2da362d95bcb
+botocore==1.34.98 \
+    --hash=sha256:4cee65df02f4b0be08ad1401965cc89efafebc50ef0727d2d17083c7f1ed2831 \
+    --hash=sha256:631c0031d8ce922b5752ab395ead896a0281b0dc74745a754d0351a27c5d83de
     # via
     #   boto3
     #   hexkit
@@ -82,9 +82,9 @@ fastapi==0.110.3 \
     --hash=sha256:555700b0159379e94fdbfc6bb66a0f1c43f4cf7060f25239af3d84b63a656626 \
     --hash=sha256:fd7600612f755e4050beb74001310b5a7e1796d149c2ee363124abdfa0289d32
     # via ghga-service-commons
-ghga-event-schemas==3.1.0 \
-    --hash=sha256:87706784895376314124d30a0ba77dd7cfebdbfbcbb98e88d2a836486f11c385 \
-    --hash=sha256:fa0048eda36002e7a79bc9084d2acdcc9eb9d38bcf263d6f68ad6fc453cae130
+ghga-event-schemas==3.2.0 \
+    --hash=sha256:66ccf599967722163b06a98a665a9393de012e4db92059e8fd5a312785f21071 \
+    --hash=sha256:d6f9ad7a9132f5aaff2003e3db07d2a9a223b27270d0afb256d698a639fd6f2c
 ghga-service-commons==3.1.3 \
     --hash=sha256:4f7c2b56ae24594dd60cb28719f040351056c06d59b2d8f74f46eb9005b770f2 \
     --hash=sha256:8b2e255506ac11cfafba3a18f58c0471a0b1b0c89893f6489a8a2f9af4dd6c0b
@@ -146,9 +146,9 @@ jmespath==1.0.1 \
     # via
     #   boto3
     #   botocore
-jsonschema==4.21.1 \
-    --hash=sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f \
-    --hash=sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5
+jsonschema==4.22.0 \
+    --hash=sha256:5b22d434a45935119af990552c862e5d6d564e8f6601206b305a61fdf661a2b7 \
+    --hash=sha256:ff4cfd6b1367a40e7bc6411caec72effadd3db0bbe5017de188f2d6108335802
     # via
     #   ghga-event-schemas
     #   hexkit
@@ -266,71 +266,71 @@ pydantic-settings==2.2.1 \
     --hash=sha256:00b9f6a5e95553590434c0fa01ead0b216c3e10bc54ae02e37f359948643c5ed \
     --hash=sha256:0235391d26db4d2190cb9b31051c4b46882d28a51533f97440867f012d4da091
     # via hexkit
-pygments==2.17.2 \
-    --hash=sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c \
-    --hash=sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367
+pygments==2.18.0 \
+    --hash=sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199 \
+    --hash=sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a
     # via rich
-pymongo==4.7.0 \
-    --hash=sha256:030dba8b3e1cb29f874739247e1eba1d01118a11583c62145c707a6e725d416a \
-    --hash=sha256:07265c14aa40259771255dbf59f9160a3690e82522ed02ab07e0e5c3045bad5b \
-    --hash=sha256:0ad32bb7e5f889fc5994001f7bb8bf945b52e10e428a563dfce0661961eae224 \
-    --hash=sha256:0dc2e365b14cb768898429e4331c58587be7143ad230858d19e8dd032f0adadc \
-    --hash=sha256:12db8e8768bd0d4a433eea3463f05648c3f65f262776c777a0e19e7c55f27a73 \
-    --hash=sha256:16d7fc4891f5482e42c35be6931e9cf6b635d7d95056ff45b56bae5f0384830f \
-    --hash=sha256:1864f224b1793ef8698f779a7808e2b8c4a8f26bd0612c578412f62d6e99be46 \
-    --hash=sha256:2161278182f3163d15afc3c578097ec20c844ac7180e41134a2a2b5c9ae77b9d \
-    --hash=sha256:2545c2be5ed25b1e9419cde4269d6a744076f80eaf86695d2dd888bddac29dd7 \
-    --hash=sha256:2bfaf7a7eb6a91dfe58f384be16fd895e040d17236ee82217d1be9fc56869dc8 \
-    --hash=sha256:2f1a2ee91a97904cd21bddfce58d1868b6ea67b99bdd81dfe9cebfe35d0d751b \
-    --hash=sha256:31ed6426fc68d500e2f27346e4ce3cc4fd3438adc99a3aaae41578c8a3b1f467 \
-    --hash=sha256:36536a41f08180adc647a21ca12dba859a23d841d28ca8fd3976c8781ed8290b \
-    --hash=sha256:36d05d1ff861dda7c9e84d9848ea6f2b5d2245ae1093865d14597de29ba95b37 \
-    --hash=sha256:3f1d57edc2a4bd96ae5741e4d83d3d54695174fd9068c88c89e12f7262be4de4 \
-    --hash=sha256:41d647fdaedba2f5b5c92299575814c164af44696fed3a4fc0d0df4f29eabcb2 \
-    --hash=sha256:431093ef808944a14698b2a719b739fa7721778769e80c08423568991aa29c42 \
-    --hash=sha256:44eb2a3adaa0916f2fb6812d4d805956fd376b7fceae3b62f5dfae5e29330786 \
-    --hash=sha256:4b2b49670b32df8cf6650133cf439593f0291228ce971094c62c3a478024c7d1 \
-    --hash=sha256:4c82105c91cf95821039aca48350630435e7be18989496b6292aaa8779fa5fb6 \
-    --hash=sha256:50865177882df0badc879c5b20f20cdc9c73494f0e2b19a40534af9c90018b4e \
-    --hash=sha256:52facf98dcba501b2ae337d21f065cc30ceb25b97ce8f17878c1ae9d781f7f26 \
-    --hash=sha256:5307bfda4f39d9f1b3df9ab96b22d44bca458e44286ce806d716a2ffed2c46da \
-    --hash=sha256:5366f28b2115120611536914540b0d247a89b09bb80bbc78893f246a584165b9 \
-    --hash=sha256:5c4b0d8393fb991b3dd934e891e064ae804e9267fce9d01d2f16b25e20564e3d \
-    --hash=sha256:6673daf8fc23a96934cbb7a3626dcfa3ae21510492047e6003dfe3f26e62886b \
-    --hash=sha256:66b490775aa4542e0585ffdff1d0c6c4279536c852334f34a6a9a5c882beafd4 \
-    --hash=sha256:69865d5739822c277d075a50601077767706e9f0862562e116ef13969d09fc9e \
-    --hash=sha256:6c993fff4c110f6de4d76b76af97733efecae83b688cb27d1a3c5431415e3803 \
-    --hash=sha256:7214b7599a9f2e4ed01ecdc034cbe8f2926954bfdad9277390dd1bccf9fd6553 \
-    --hash=sha256:7530ea1da6fe0bb1960390ba6523483dfdb2a6239d0e8058b1505cc2a79c75f8 \
-    --hash=sha256:78b0ba6d60c7f2ac779909ac53383c83584826a304206559599c46a33366622a \
-    --hash=sha256:7a3c9218c5bc4384fa079f41b744473ada6a5f549fc11a4ae0fe7287746acc04 \
-    --hash=sha256:7be2e57df38fa9b1b6f9ebe5bedd38118b511d3bdf0d9e77158c476542c9153d \
-    --hash=sha256:8449b6af19cac09cce9d0834c196b29b72b29e05724f4ea208b3f602fdd47086 \
-    --hash=sha256:8885f825203fa14ce863b462effcd93e07bfc6e582b3b93cfcde5ae42ccc9923 \
-    --hash=sha256:8af3de7fea21b1ced0770766ec37a5900a62b45fe4b8f1dfa521226d591dbf66 \
-    --hash=sha256:8fc34b4d92d5d8671be6b728076f275ccfe8495c7e6b74750b634190e17ede68 \
-    --hash=sha256:9584be3d20ee26b53c0b1e25ba38196b7f65f594f48211b5ab3fa12b428ec6a9 \
-    --hash=sha256:97ccb53d9310d5963df1a4543f1cfabdfd914638a5c8438234f6ed70d9303222 \
-    --hash=sha256:98cb932ab936d702e28cf8da1982dcf5e7cfc35736b7516c0df7aaa46c63e0e2 \
-    --hash=sha256:9f53cf5bf65dda3fc1b5ec5f760233a41b282db3157d135e9272101f0492825f \
-    --hash=sha256:a292ee4babdd632531effaac95da5f211caafa6a039c097a1b18a4dc0d52488b \
-    --hash=sha256:aebd99aaea95c48fba24bc3d7b72e7bf70e06df4c647de938c4d3dce2fd25a1c \
-    --hash=sha256:b3784063fa43a0019b6a73e1e63b7fcbff4ded4d0ec5442202aa3caa12be9ef8 \
-    --hash=sha256:b3a49be20a403d86eb1c559350fb56f28a859041756159eeb00e89f59b6e1288 \
-    --hash=sha256:b7b8bd94c63cef8f5bfbb29568934213d9730381db94f467f979c9e5aaa27130 \
-    --hash=sha256:bd514420eb09bba897016b7f1a2c17f9f3f1a7bc320c0505c59c3225e024b51c \
-    --hash=sha256:c85f9824a7e90bf49aeed953e63942bff499116312e555ccb51bd3bf7ebe9342 \
-    --hash=sha256:c8ff95728965e633591862bfc197018d25bc349b5cd8da080acb52a2d17a6e95 \
-    --hash=sha256:cb809ff53ab3110ebc43a5e47aa945bb97e4ed9bc9beb07f935f5c83d9077e67 \
-    --hash=sha256:cefa4e9be8bffa80de1bd70ae5ee79973e5db10befabcb25289fb52231a0dcff \
-    --hash=sha256:cf4187bc91bd10e29857775651101d0ec26e580d6b46a8c5cbf93928358ac3c3 \
-    --hash=sha256:d4d584b249c79acae86729d216a5185d833a90477d566f094b47d39620493870 \
-    --hash=sha256:db2885773af0c10420e6bb86e84ee780bc3817d45a29ef24d8f6376ae2351eec \
-    --hash=sha256:e7a00cee5b7a4160eed9cb43a2539037f572f01ed7261c2d1b4f7217060dba61 \
-    --hash=sha256:eb00787bed1939ef21ffcb09b3034b193c3c6e9838724e2c05ef881cb2b03a33 \
-    --hash=sha256:f807dadc8030a5b55915f78fac25393af47bee8ccb62b5a6c5c622274ff4adf1 \
-    --hash=sha256:f8c4cbe5a1258b9f3a49f83781c8b2fb58f39a682779a3c81dc444a609cb15ba \
-    --hash=sha256:fbad9290b32ff1fc38bcac42699b8ea6a7c49cab081ba54761f3109bc5703248
+pymongo==4.7.1 \
+    --hash=sha256:11f74dafde63ad2dc30c01f40b4c69d9af157f8ba5224b0c9d4de7158537266f \
+    --hash=sha256:13fc201e073644acd77860d9e91ccfc27addf510563e07381cadc9a55ac3a894 \
+    --hash=sha256:1bd1eef70c1eda838b26397ef75c9580d7a97fd94b6324971d7f3d2ad3552e9a \
+    --hash=sha256:24c8f1dd545360ec1b79007a3ba6573af565df6fde49f6dfc53813f3f475a751 \
+    --hash=sha256:253ed8fd6e7f4b2a1caa89e6b287b9e04f42613319ee1e1240c2db2afe1637e7 \
+    --hash=sha256:263c169302df636f9086b584994a51d0adfc8738fe27d7b8e2aacf46fd68b6cb \
+    --hash=sha256:297cdc87c4b4168782b571c8643540e9b0ad1d09266b43d2f5954f8632280835 \
+    --hash=sha256:2ccc8dd4fe9aac18dde27c33a53271c6c90159b74c43fbdab1d33d5efc36c2f5 \
+    --hash=sha256:30a9d891631d7e847b24f551b1d89ff2033539e7cd8e9af29714b4d0db7abb06 \
+    --hash=sha256:31ed8ba3da0366346264604b3a443f5a4232cab5ed45f520bead6184cf0851a1 \
+    --hash=sha256:337d99f88d32a5f8056d6d2bc365ccf09d09583f3942882c50cf11b459e8fbc0 \
+    --hash=sha256:3ef32a7cfe748c0c72fdad9e51459de5e0c6b16c5288b39f863abfff23503847 \
+    --hash=sha256:455f9d603ed0990a787773d5718e871300bddf585ce543baf129c9f5ca3adb02 \
+    --hash=sha256:45ac46f0d6bdc2baac34ced60aae27b2083170d77397330eff0ac5689ea29d38 \
+    --hash=sha256:4c7e05454cdc5aa4702e03cad0df4205daccd6fd631bbbf0a85bbe598129a6cc \
+    --hash=sha256:4d227555be35078b53f506f6b58bd0b0e8fd4513e89e6f29e83a97efab439250 \
+    --hash=sha256:4dd998e9f0f7694032c1648c7f57fccaa78903df6329b8f8ae20cfa7c4ceca34 \
+    --hash=sha256:5119c66af8c4197c8757b4b7d98c443e5b127c224ac92fb657dbe2b512ae2713 \
+    --hash=sha256:57b5b485ef89270ed2e603814f43f0fdd9b8ba5d4039124d90878cdc2327000c \
+    --hash=sha256:58989bcb94233233a71645236b972835d4f87a6bb1b7e818d38a7e6e6d4630de \
+    --hash=sha256:5a58b6cd7c423ba49db10d8445756062c931ad2246ba0da1e705bf22962fd9e9 \
+    --hash=sha256:5ae1aeeb405c29885266666dc7115792d647ed68cfdb6ed02e2e211d12f2e1c8 \
+    --hash=sha256:5bc87db2e9563295c4e45602ab978a2fcbaba3ab89e745503b24f895cddeb755 \
+    --hash=sha256:5ff6d56ca1f0cd3687a13ce90a32a8efb3cc3a53728e5ac160c4c30d10385a72 \
+    --hash=sha256:615c7573d7a9c4837332a673fdc5a5f214b474dd52d846bcf4cc3d011550bee1 \
+    --hash=sha256:64b69b9cd8a6d23881a80490d575e92918f9afca43096a7d6c1013d6b3e5c75c \
+    --hash=sha256:65c45682d5ed8c6618bde22cd6716b47a197f4ef800a025213b28d13a59e5fca \
+    --hash=sha256:67cbee427c263a4483e3249fef480788ccc16edb1a4fc330c4c6cb0cb9db94a8 \
+    --hash=sha256:7247c1dc7d8eed4e24eb1dd92c4c58ebf1e5159500015652552acfdebdeed256 \
+    --hash=sha256:73bf96ece4999b0bbab7169cb2b9c60918b434487009e48be4bd47eeb2aa7b14 \
+    --hash=sha256:7b10603ba64af08f5af7eb9a69d6b24e3c69d91fdd48c54b95e284686c1c582d \
+    --hash=sha256:811a07bba9d35f1e34159ede632ac71dbc429b372a20004e32d6578af872db1a \
+    --hash=sha256:811c41c6227b7548afcb53e1b996c25262d837b5e5f519e2ddc2c7e59d8728a5 \
+    --hash=sha256:85b8dd3756b73993b1e3ab6b1cba826b9e4987a094a5d5b6d37313776458cd94 \
+    --hash=sha256:887d043ecc0c7d5591925bbc7abb67caf21c94d6e6e5d442cb49eb5d9d8ee76b \
+    --hash=sha256:8cee62188127a126f59ea45d3981868a5e35343be4ef4ad8712eaf42be37a00b \
+    --hash=sha256:9e0a30a022ac8a9164ee5a4b761e13dbb3d10a21845f7258011e3415151fb645 \
+    --hash=sha256:9e99dac3c7c2cb498937cc1767361851099da38861e921113318c87d71e3d127 \
+    --hash=sha256:a46c08ef0b273c415b1e8933f6739596be264ae700a4927f84e0b84e70fdf0eb \
+    --hash=sha256:a848249d5b4763497add62f7dd7bd0ce1538129bf42f4cb132a76d24c61bf98d \
+    --hash=sha256:aa354933a158e57494c98b592f46d5d24d1b109e6ba05a05179cde719d9f7fd3 \
+    --hash=sha256:ad360630c221aee7c0841a51851496a3ca6fdea87007098a982c1aa26e34083a \
+    --hash=sha256:b897b60b2d55c26f3efea0effc11b655db68125c3731274bc3953375e9ccab73 \
+    --hash=sha256:b8b95e2163b73d03a913efa89b0f7c5012be82efd4e9dbce8aa62010a75a277c \
+    --hash=sha256:bfd5c7e5bb87171a5296fa32205adb50b27704a612036ec4395c3cd316fc0e91 \
+    --hash=sha256:c808098f2cdb87d4035144e536ba5fa7709d0420c17b68e6ace5da18c38ded5f \
+    --hash=sha256:d1829a7db720ff586aaf59c806e89e0a388548063aa844d21a570a231ad8ca87 \
+    --hash=sha256:d50969de00d3522b2c394f7e59b843871e2be4b525af92066da7f3bd02799fdc \
+    --hash=sha256:d63f38454a2e23c117d3ceab3b661568f2418536825787256ad24e5baaedfd27 \
+    --hash=sha256:d804eaf19a65211cc2c8c5db75be685c3f31c64cdab639794f66f13f8e258ba6 \
+    --hash=sha256:daf35ab13b86aba7cc8c4b019882f1fa8d287a26f586ef5eaf60a5233d3eaa52 \
+    --hash=sha256:dbc32217c81d87750401fa1c2bc9450e854b23e6e30243c82d3514b8e58f39e3 \
+    --hash=sha256:e175d74c52b6c8414a4b4504a2dd42b0202d101b2eb9508a34c137357683864e \
+    --hash=sha256:e4a63ba6813a2168ebd35ea5369f6c33f7787525986cd77668b7956acc3d2a38 \
+    --hash=sha256:e935712b17e7a42831022353bac91a346a792658a54e12bec907ec11695cc899 \
+    --hash=sha256:ec94d29103317aa920dae59ed385de9604cb0ef840b5b7137b5eaa7a2042580a \
+    --hash=sha256:ed6b3a0740efe98bb03ccf054578e9788ebcd06d021d548b8217ab2c82e45975 \
+    --hash=sha256:f2a720e787c9b9b912db5bb4c3e7123ccff1352d6c3ac0cb2c7ee392cdc95c00 \
+    --hash=sha256:f8822614975038e0cece47d12e7634a79c2ee590a0ae78ae64c37b9c6610a14c \
+    --hash=sha256:fb1a884b1c6aeac5ffeb8ccb696fbc242a7ae1bba36f2328c01f76fab7221b94
     # via motor
 python-dateutil==2.9.0.post0 \
     --hash=sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3 \
@@ -397,9 +397,9 @@ pyyaml==6.0.1 \
     # via
     #   hexkit
     #   uvicorn
-referencing==0.35.0 \
-    --hash=sha256:191e936b0c696d0af17ad7430a3dc68e88bc11be6514f4757dc890f04ab05889 \
-    --hash=sha256:8080727b30e364e5783152903672df9b6b091c926a146a759080b62ca3126cd6
+referencing==0.35.1 \
+    --hash=sha256:25b42124a6c8b632a425174f24087783efb348a6f1e0008e63cd4466fedf703c \
+    --hash=sha256:eda6d3234d62814d1c64e305c1331c9a3a6132da475ab6382eaa997b21ee75de
     # via
     #   jsonschema
     #   jsonschema-specifications