@aglyn/plugins-workflows 1.0.0-beta.182 → 1.0.0-beta.184

package/src/lib/engine/run-event-actions.js

@@ -14,7 +14,7 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ import { ACTION_MAX_EVENT_DEPTH, ACTION_MAX_STEPS, checkEntitlement, planLabelGrantingFeature, checkQuota, WEBHOOK_URL_PATTERN, evaluateExpression, evaluateStepGuard, evaluateTriggerConditions, FLOW_TIMED_OUT_FIELD, flowEmailTopicId, hostPublicOrigin, isClientActionStep, isCrmActionStep, isFlowSuspendingStep, buildDatasetRecordValues, datasetDisplayName, contactCampaignFieldPath, datasetIntegrityFields, datasetIntegrityUpdate, describeStepOutcome, effectiveDatasetModel, normalizeTriggerConditions, resolveOrgEntitlements, runWorkflow, WORKFLOW_MAX_STEPS } from "@aglyn/aglyn/server";
+ */ import { ACTION_MAX_EVENT_DEPTH, ACTION_MAX_STEPS, checkEntitlement, consentGroupForHost, planLabelGrantingFeature, checkQuota, WEBHOOK_URL_PATTERN, evaluateExpression, evaluateStepGuard, evaluateTriggerConditions, FLOW_TIMED_OUT_FIELD, flowEmailTopicId, hostPublicOrigin, isClientActionStep, isCrmActionStep, isFlowSuspendingStep, buildDatasetRecordValues, datasetDisplayName, contactCampaignFieldPath, datasetIntegrityFields, datasetIntegrityUpdate, describeStepOutcome, effectiveDatasetModel, normalizeTriggerConditions, resolveOrgEntitlements, runWorkflow, WORKFLOW_MAX_STEPS } from "@aglyn/aglyn/server";
 import { isDeferrableSendResult, isEmailConfigured, sendEmail, sendFailureReason } from "@aglyn/shared-util-email";
 import { dataStorageRefusal, enrollListMember, firebaseAdmin, flowEmailRefusal, getOrgForHost, hostSendingIdentity, meterHostEmail, notifyHostManagers, consentGroupForSite, orgDataCollectionForHost, orgDataQueryForHost, resolveOrgIdForHost } from "@aglyn/tenant-data-admin";
 import { announceDatasetRecordChange } from "@aglyn/tenant-data-admin/server/dataset-live-pages";
@@ -465,7 +465,7 @@ async function datasetAppendRefusal(env, datasetRef) {
                 link: `/${hostId}`
             }));
         } else if (step.type === 'sendEmail') {
-            var _payload_, _hostPublicOrigin, _step_topicId, _step_subject, _step_body;
+            var _payload_, _hostPublicOrigin, _step_topicId, _step_subject, _step_body, _env_org;
             var _step_toField, _this;
             const to = String((_payload_ = payload[((_step_toField = step.toField) == null ? void 0 : _step_toField.trim()) || 'email']) != null ? _payload_ : '').trim();
             if (!isEmailConfigured()) return failed('email is not configured');
@@ -572,10 +572,14 @@ async function datasetAppendRefusal(env, datasetRef) {
             } : {}, {
                 // `topicId` is `''` for a step that belongs to no stream, which
                 // every reader of it treats as absent — see `flowEmailTopicId`.
+                // The consent group comes off the org the run already holds, so the
+                // gate honors an unsubscribe from any site of a declared group —
+                // the sender this site mails as — at no extra read.
                 marketing: {
                     hostId,
                     siteBase,
-                    topicId
+                    topicId,
+                    consentHostIds: consentGroupForHost((_env_org = env.org) != null ? _env_org : null, hostId).hostIds
                 }
             }));
             /*
@@ -1249,27 +1253,45 @@ async function datasetAppendRefusal(env, datasetRef) {
  * event name would wrongly fire sibling actions with different
  * thresholds. Same gates and metering as the event runner.
  */ export async function runSingleAction(hostId, actionId, event, payload = {}) {
+    return (await runSingleActionOutcome(hostId, actionId, event, payload)).alerts;
+}
+/**
+ * {@link runSingleAction}, answering what it did as well as the alerts: whether
+ * the steps ran and, when they did not, which gate stopped them.
+ *
+ * One body for both, so the console's test run meets exactly the gates a
+ * page's dispatch meets — the switch, the event, the conditions, the plan and
+ * the month's allowance — and is metered and recorded the same way.
+ */ export async function runSingleActionOutcome(hostId, actionId, event, payload = {}) {
     const alerts = [];
+    const skipped = (reason, limit)=>_extends({
+            ran: false,
+            skipped: reason,
+            alerts
+        }, limit === undefined ? {} : {
+            limit
+        });
     try {
         var _ref, _ref1, _ref2;
         var _action_trigger;
         const firestore = firebaseAdmin.app().firestore();
         const hostRef = firestore.collection('hosts').doc(hostId);
         const doc = await hostRef.collection('actions').doc(actionId).get();
-        if (!doc.exists || doc.get('deletedAt') || doc.get('enabled') === false) {
-            return alerts;
-        }
+        if (!doc.exists || doc.get('deletedAt')) return skipped('missing');
+        if (doc.get('enabled') === false) return skipped('disabled');
         const action = doc.data();
         // Only site-event actions may be dispatched externally — server
         // events flow through their own emitters.
-        if (String((_ref = (_action_trigger = action.trigger) == null ? void 0 : _action_trigger.event) != null ? _ref : '') !== String(event)) return alerts;
+        if (String((_ref = (_action_trigger = action.trigger) == null ? void 0 : _action_trigger.event) != null ? _ref : '') !== String(event)) {
+            return skipped('event');
+        }
         // Structured payload conditions (AGL-557; AND/OR chaining AGL-565):
         // the single-action dispatch path honors them too, so
         // client-evaluated triggers can't bypass them.
         if (!evaluateTriggerConditions(action.trigger, _extends({
             event
         }, payload))) {
-            return alerts;
+            return skipped('conditions');
         }
         const monthKey = new Date().toISOString().slice(0, 7);
         const runCounterRef = hostRef.collection('counters').doc('actionRuns');
@@ -1280,13 +1302,13 @@ async function datasetAppendRefusal(env, datasetRef) {
         {
             var _counterSnapshot_get;
             const org = owner == null ? void 0 : owner.org;
-            if (!checkEntitlement(org, 'actions')) return alerts;
+            if (!checkEntitlement(org, 'actions')) return skipped('plan');
             webhooksAllowed = checkEntitlement(org, 'webhooks');
             crmAllowed = checkEntitlement(org, 'crm');
             const limit = resolveOrgEntitlements(org).actionRunsPerMonth;
             const counterSnapshot = await runCounterRef.get();
             const used = Number((_counterSnapshot_get = counterSnapshot.get(monthKey)) != null ? _counterSnapshot_get : 0);
-            if (used + 1 > limit) return alerts;
+            if (used + 1 > limit) return skipped('allowance', limit);
         }
         const env = {
             hostId,
@@ -1307,10 +1329,15 @@ async function datasetAppendRefusal(env, datasetRef) {
         }, {
             merge: true
         }).catch(()=>undefined);
+        return {
+            ran: true,
+            skipped: null,
+            alerts
+        };
     } catch (error) {
         console.error('runSingleAction failed', hostId, actionId, error);
+        return skipped('failed');
     }
-    return alerts;
 }
 /**
  * Ends an enrollment its automation may no longer run, and says why in the