feat(pos-integration): DOMA-13041 add webhook notifications for integration status changes (#7356)

* feat(webhooks): DOMA-13041 make WebhookSubscription model field degradable when no models registered

* refactor(webhooks): DOMA-13041 move modeled plugin inline to WebhookSubscription schema

Moved modeled plugin implementation from separate file into WebhookSubscription.js to consolidate webhook-related code.

* feat(webhooks): DOMA-13041 update yarn.lock

Set all submodules on main and run "yarn"

* feat(condo): DOMA-13041 add webhook env vars to CI workflow and update pos-integration submodule with fixed tests

* feat(condo): DOMA-13041 remove webhook env vars from CI workflow

* refactor(webhooks): DOMA-13041 rename modeled plugin to configureModelField for clarity

* feat(webhooks): DOMA-13041 add documentation for getWebhookModels() initialization order

* feat(condo): DOMA-13041 updte to rebased submodule branch

* feat(webhooks): DOMA-13041 disable WebhookSubscription creation when no models available

Replace dynamic hasAvailableModels function with static boolean set during schema initialization to properly disable create access when no webhooked models are registered.

* refactor(webhooks): DOMA-13041 pass attrs parameter to canManageWebhookSubscriptions in create access check

Author: AleX83Xpert

apps/pos-integration

@@ -4,6 +4,13 @@ const { getWebhookSubscriptionModel } = require('@open-condo/webhooks/schema/mod
 
 /**
  * Returns all webhook models (Webhook, WebhookSubscription, WebhookPayload)
+ *
+ * IMPORTANT: This function must be called AFTER all domain schemas that use
+ * webHooked() plugin have been registered. The WebhookSubscription.model field
+ * will be a Select containing ONLY models registered via webHooked() plugin.
+ * If no webHooked() models are registered, the field degrades to Text.
+ * In the schemas() array, always place getWebhookModels() after domain schemas.
+ *
  * @param {string} schemaPath - Path to GraphQL schema file
  * @param {Array<string>} [appWebhooksEventsTypes] - Array of event types supported by the application
  * @returns {Object} Object with Webhook, WebhookSubscription, and WebhookPayload models

packages/webhooks/schema/index.js

@@ -1,10 +1,56 @@
 const conf = require('@open-condo/config')
 const { uuided, versioned, tracked, softDeleted, dvAndSender, historical } = require('@open-condo/keystone/plugins')
+const { plugin } = require('@open-condo/keystone/plugins/utils/typing')
 const { GQLListSchema } = require('@open-condo/keystone/schema')
 const { DEFAULT_MAX_PACK_SIZE, DEFAULT_UNAVAILABILITY_THRESHOLD } = require('@open-condo/webhooks/constants')
 const { WebHookModelValidator, getModelValidator, setModelValidator } = require('@open-condo/webhooks/model-validator')
 const access = require('@open-condo/webhooks/schema/access/WebhookSubscription')
 
+
+const configureModelField = ({ validator, validateFields, validateFilters, setHasAvailableModels }) => plugin(({ fields = {}, ...rest }) => {
+    const hasAvailableModels = Boolean(validator && validator.models.length > 0)
+    setHasAvailableModels(hasAvailableModels)
+
+    // WebhookSubscription is intended for model-based webhooks only, so in the normal case
+    // `model` must be a required Select backed by models registered through `webHooked()`.
+    // Some applications import webhook schemas only to use custom `WebhookPayload` events and
+    // therefore never register any `webHooked()` models. In that case `validator.models` stays
+    // empty, and a required Select with no options makes the schema impossible to use and can
+    // break app startup. To keep such apps bootable while still requiring callers to provide a
+    // `model` value, we degrade the field to required Text and disable creation access when
+    // no models are available.
+    //
+    // If `validator.models` later becomes non-empty for the same app, the field automatically
+    // switches back to the strict Select variant on the next startup because this plugin runs
+    // during schema registration, after `webHooked()` had a chance to register models. No special
+    // runtime toggle is needed, but existing WebhookSubscription records should be checked before
+    // that rollout: rows with arbitrary `model` values are acceptable in the "no models available"
+    // mode, while the Select mode expects values from the registered model list. If the storage
+    // representation or generated schema changes are important for deployment, run the usual
+    // `makemigrations` / schema generation checks as part of that transition.
+    fields.model = hasAvailableModels
+        ? {
+            schemaDoc: 'The data model (schema) that the webhook is subscribed to',
+            type: 'Select',
+            dataType: 'string',
+            isRequired: true,
+            options: validator.models,
+            hooks: {
+                validateInput: (args) => {
+                    validateFields(args)
+                    validateFilters(args)
+                },
+            },
+        }
+        : {
+            schemaDoc: 'The data model (schema) that the webhook is subscribed to',
+            type: 'Text',
+            isRequired: true,
+        }
+
+    return { fields, ...rest }
+})
+
 const UNAVAILABILITY_THRESHOLD = (typeof conf['WEBHOOK_BLOCK_THRESHOLD'] === 'number' && conf['WEBHOOK_BLOCK_THRESHOLD'] > 0)
     ? conf['WEBHOOK_BLOCK_THRESHOLD']
     : DEFAULT_UNAVAILABILITY_THRESHOLD
@@ -15,10 +61,17 @@ function getWebhookSubscriptionModel (schemaPath) {
     }
 
     const validator = getModelValidator()
+    let hasAvailableModels = false
+    const setHasAvailableModels = (value) => { hasAvailableModels = value }
+    const checkHasAvailableModels = () => hasAvailableModels
 
     const validateFields = ({ resolvedData, existingItem, addFieldValidationError }) => {
         const newItem = { ...existingItem, ...resolvedData }
 
+        if (!checkHasAvailableModels()) {
+            return
+        }
+
         if (!validator) {
             return addFieldValidationError(`Invalid fields for model "${newItem.model}" was provided. Details: ["Validator for this model is not specified!"]`)
         }
@@ -39,6 +92,10 @@ function getWebhookSubscriptionModel (schemaPath) {
     const validateFilters = ({ resolvedData, existingItem, addFieldValidationError }) => {
         const newItem = { ...existingItem, ...resolvedData }
 
+        if (!checkHasAvailableModels()) {
+            return
+        }
+
         if (!validator) {
             return addFieldValidationError(`Invalid filters for model "${newItem.model}" was provided. Details: ["Validator for this model is not specified!"]`)
         }
@@ -49,7 +106,6 @@ function getWebhookSubscriptionModel (schemaPath) {
         }
     }
 
-
     return new GQLListSchema('WebhookSubscription', {
         schemaDoc: 'Determines which models the WebHook will be subscribed to. When model changes subscription task will be triggered to resolve changed data and send a webhook',
         fields: {
@@ -112,19 +168,6 @@ function getWebhookSubscriptionModel (schemaPath) {
                     },
                 },
             },
-            model: {
-                schemaDoc: 'The data model (schema) that the webhook is subscribed to',
-                type: 'Select',
-                dataType: 'string',
-                isRequired: true,
-                options: validator.models,
-                hooks: {
-                    validateInput: (args) => {
-                        validateFields(args)
-                        validateFilters(args)
-                    },
-                },
-            },
             fields: {
                 schemaDoc: 'String representing list of model fields in graphql-query format. ' +
                     'Exactly the fields specified here will be sent by the webhook. ' +
@@ -170,10 +213,10 @@ function getWebhookSubscriptionModel (schemaPath) {
                 },
             },
         },
-        plugins: [uuided(), versioned(), tracked(), softDeleted(), dvAndSender(), historical()],
+        plugins: [configureModelField({ validator, validateFields, validateFilters, setHasAvailableModels }), uuided(), versioned(), tracked(), softDeleted(), dvAndSender(), historical()],
         access: {
             read: access.canReadWebhookSubscriptions,
-            create: access.canManageWebhookSubscriptions,
+            create: (attrs) => checkHasAvailableModels() ? access.canManageWebhookSubscriptions(attrs) : false,
             update: access.canManageWebhookSubscriptions,
             delete: false,
             auth: true,

packages/webhooks/schema/models/WebhookSubscription.js

@@ -1376,6 +1376,7 @@ __metadata:
     "@open-condo/miniapp-utils": "workspace:^"
     "@open-condo/next": "workspace:^"
     "@open-condo/ui": "workspace:^"
+    "@open-condo/webhooks": "workspace:^"
     "@open-keystone/app-next": ^9.0.1
     "@open-keystone/server-side-graphql-client": ^2.1.3
     "@pos-integration/domains": "link:./domains"
@@ -8356,17 +8357,17 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@graphql-tools/batch-execute@npm:^10.0.5":
-  version: 10.0.5
-  resolution: "@graphql-tools/batch-execute@npm:10.0.5"
+"@graphql-tools/batch-execute@npm:^10.0.7":
+  version: 10.0.7
+  resolution: "@graphql-tools/batch-execute@npm:10.0.7"
   dependencies:
     "@graphql-tools/utils": ^11.0.0
     "@whatwg-node/promise-helpers": ^1.3.2
     dataloader: ^2.2.3
     tslib: ^2.8.1
   peerDependencies:
     graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0
-  checksum: fc577bdb7c8de8ee4915caed5c22dda2aeedc8fd33e35f1604d681e613e844985b141a34f9e9fe107bf76d26e81d3772ae28bc6de78a6fffd1f7aa1376e94ee5
+  checksum: 535a2c2c4257bf8fb6f361f59a4a11a208ab04b44039063f9fb857d6579bd74d785df2029d0ab19fc4d876536f39ec776cf76787d8058a34c8fd2bc5e7141cfc
   languageName: node
   linkType: hard
 
@@ -8431,11 +8432,11 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@graphql-tools/delegate@npm:^12.0.9":
-  version: 12.0.9
-  resolution: "@graphql-tools/delegate@npm:12.0.9"
+"@graphql-tools/delegate@npm:^12.0.11":
+  version: 12.0.11
+  resolution: "@graphql-tools/delegate@npm:12.0.11"
   dependencies:
-    "@graphql-tools/batch-execute": ^10.0.5
+    "@graphql-tools/batch-execute": ^10.0.7
     "@graphql-tools/executor": ^1.4.13
     "@graphql-tools/schema": ^10.0.29
     "@graphql-tools/utils": ^11.0.0
@@ -8445,7 +8446,7 @@ __metadata:
     tslib: ^2.8.1
   peerDependencies:
     graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0
-  checksum: aa1ff2c8aff21f2be4ef10d4455d0dfb9841d8019a9f49e0ec7d98a5f284fdb9ccbeeb6fa12d9889f904d222ae7caedba466de70adc8c05ee3cf2bc53e1b5969
+  checksum: a390158c31bdadbbf69cbed3117cc990738243facd6779fc75f83042be4ec49e2e579d3f5ada33e38b4c1594234776a2cf50a57eb739d3cab24d6513babf3a3c
   languageName: node
   linkType: hard
 
@@ -9188,17 +9189,17 @@ __metadata:
   linkType: hard
 
 "@graphql-tools/wrap@npm:^11.1.1":
-  version: 11.1.9
-  resolution: "@graphql-tools/wrap@npm:11.1.9"
+  version: 11.1.11
+  resolution: "@graphql-tools/wrap@npm:11.1.11"
   dependencies:
-    "@graphql-tools/delegate": ^12.0.9
+    "@graphql-tools/delegate": ^12.0.11
     "@graphql-tools/schema": ^10.0.29
     "@graphql-tools/utils": ^11.0.0
     "@whatwg-node/promise-helpers": ^1.3.2
     tslib: ^2.8.1
   peerDependencies:
     graphql: ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0
-  checksum: 22088b23b049210b8edbe80e21c6d212b2546b2d1c4fe87bc749cccb196945df78d64f15b347529172891588b6c9119806c0cc1fa2ecece9972e70542a267761
+  checksum: c036b459f2f59d8a3f4b935fcba61ac2197113521ee3fcf56e94d41a740ef60e907d90fb3ad142dd3c7c46522a8c728b73455936c6d3fb19b180aee35fc3534a
   languageName: node
   linkType: hard