@aglyn/plugins-workflows 1.0.0-beta.218 → 1.0.0-beta.220

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, 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 { ACTION_MAX_STEPS, checkEntitlement, consentGroupForHost, planLabelGrantingFeature, checkQuota, evaluateExpression, evaluateStepGuard, evaluateTriggerConditions, FLOW_TIMED_OUT_FIELD, flowSubscriptionTopicId, hostPublicOrigin, isClientActionStep, isFlowSuspendingStep, datasetDisplayName, describeDatasetRecordErrors, contactContainerFieldPath, datasetIntegrityFields, datasetIntegrityUpdate, effectiveDatasetModel, ensureDeclaredCustomFieldTypes, normalizeTriggerConditions, prepareDatasetRecordWrite, resolveOrgEntitlements } 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";
@@ -23,6 +23,7 @@ import { visibleToHost } from "@aglyn/aglyn/app-utils/scope-tokens";
 // The leaf, not the barrel: this library's specs substitute the barrel
 // wholesale, and the lookup must reach the real index logic under them.
 import { findContactByEmail } from "@aglyn/tenant-data-admin/server/contact-email-index";
+import { findOrgContainersByName, readOrgContainers } from "@aglyn/tenant-data-admin/server/org-containers";
 // The leaf again, for the phishing screen's hold (AGL-3356): the control
 // that stops a send must be the real one under a spec that mocks the barrel.
 import { screenOutboundSend } from "@aglyn/tenant-data-admin/server/outbound-send-review";
@@ -30,9 +31,12 @@ import { renderSiteTextEmail } from "@aglyn/tenant-data-admin/server/host-email-
 import { createHmac } from "crypto";
 import { FieldValue } from "firebase-admin/firestore";
 import { runSummaryFields } from "../model/run-history.js";
+import { ACTION_MAX_EVENT_DEPTH, runWorkflow, WORKFLOW_MAX_STEPS } from "../model/workflows.js";
+import { describeStepOutcome } from "../model/step-outcomes.js";
+import { WEBHOOK_URL_PATTERN } from "../model/webhooks.js";
 import { eventRunSuspension } from "./site-suspension.js";
 import { advanceFlowEnrollment, claimFlowEnrollment, deferFlowEnrollment, endFlowEnrollment, enrollInFlow, findFlowEnrollmentsAwaiting, sweepDueFlowEnrollments } from "./flow-enrollments.js";
-import { logCrmEmailActivity, prepareCrmEmailActivity, runCrmActionStep } from "./crm-action-steps.js";
+import { isCrmActionStep, logCrmEmailActivity, prepareCrmEmailActivity, runCrmActionStep } from "./crm-action-steps.js";
 import { resolveDatasetDoc } from "@aglyn/tenant-runtime/resolve-dataset";
 import { resumeWorkflowEnrollment, runEventWorkflows } from "./run-event-workflows.js";
 import { ORG_AUTOMATION_RUN_TARGET, orgAutomationStepRefusal } from "../model/org-automations.js";
@@ -384,7 +388,11 @@ async function datasetAppendRefusal(env, datasetRef) {
                 model: datasetDoc.get('model'),
                 fields: Array.isArray(datasetDoc.get('fields')) ? datasetDoc.get('fields') : []
             };
-            const values = buildDatasetRecordValues(appendDataset, payload);
+            const appendModel = effectiveDatasetModel(appendDataset);
+            // A plugin's field validator runs only once its plugin registered it.
+            await ensureDeclaredCustomFieldTypes(appendModel);
+            const write = prepareDatasetRecordWrite(appendDataset, payload);
+            const values = write.values;
             // Same name precedence `findDatasetByName` resolves in.
             const appendLabel = (datasetDisplayName({
                 displayName: datasetDoc.get('displayName'),
@@ -394,14 +402,23 @@ async function datasetAppendRefusal(env, datasetRef) {
             // to write. An error rather than a quiet success: a run history that
             // says `saved to Leads` while nothing saves is how a mismatched field
             // name goes unnoticed.
-            if (!Object.keys(values).length) {
+            if (!write.matched.length) {
                 return failed(`no event field matches a field in dataset "${appendLabel || step.datasetId}"`);
             }
+            // Held to the model like every other record write (AGL-2773): a value
+            // its field cannot hold refuses the whole record, and the run says
+            // which field and why instead of `saved to Leads`.
+            if (Object.keys(write.errors).length) {
+                return failed(`record failed validation for dataset "${appendLabel || step.datasetId}": ${describeDatasetRecordErrors(write.errors)}`);
+            }
+            if (!Object.keys(values).length) {
+                return failed(`every event field matching dataset "${appendLabel || step.datasetId}" is empty`);
+            }
             const refusal = await datasetAppendRefusal(env, datasetDoc.ref);
             if (refusal) return failed(refusal);
             await datasetDoc.ref.collection('records').add(_extends({
                 values
-            }, datasetIntegrityFields(effectiveDatasetModel(appendDataset), values), {
+            }, datasetIntegrityFields(appendModel, values), {
                 createdAt: FieldValue.serverTimestamp()
             }));
             await announceDatasetStepWrite(env, datasetDoc.id);
@@ -421,15 +438,22 @@ async function datasetAppendRefusal(env, datasetRef) {
                 fields: Array.isArray(datasetDoc.get('fields')) ? datasetDoc.get('fields') : []
             };
             const updateModel = effectiveDatasetModel(updateDataset);
-            const values = buildDatasetRecordValues(updateDataset, payload);
+            await ensureDeclaredCustomFieldTypes(updateModel);
+            const updateLabel = String(datasetDisplayName({
+                displayName: datasetDoc.get('displayName'),
+                name: datasetDoc.get('name')
+            }) || step.datasetName || step.datasetId || '').slice(0, 60);
+            // Checked before the lookup, as an append: the fields this write
+            // supplies are held to the model whichever leg runs below, and a
+            // refusal costs no read.
+            const incoming = prepareDatasetRecordWrite(updateDataset, payload);
             // Nothing to merge or append — an error, for the reason the append
             // branch above gives.
-            if (!Object.keys(values).length) {
-                const updateLabel = datasetDisplayName({
-                    displayName: datasetDoc.get('displayName'),
-                    name: datasetDoc.get('name')
-                }) || step.datasetName || step.datasetId;
-                return failed(`no event field matches a field in dataset "${String(updateLabel != null ? updateLabel : '').slice(0, 60)}"`);
+            if (!incoming.matched.length) {
+                return failed(`no event field matches a field in dataset "${updateLabel}"`);
+            }
+            if (!Object.keys(incoming.values).length) {
+                return failed(`every event field matching dataset "${updateLabel}" is empty`);
             }
             const email = String((_payload_email = payload.email) != null ? _payload_email : '').trim();
             // `records.values` is exempt from indexing, so this lookup is served
@@ -439,7 +463,16 @@ async function datasetAppendRefusal(env, datasetRef) {
             const existing = email ? await datasetDoc.ref.collection('records').where('values.email', '==', email).limit(1).get() : null;
             if (existing && !existing.empty) {
                 var _existing_docs__get;
-                const merged = _extends({}, (_existing_docs__get = existing.docs[0].get('values')) != null ? _existing_docs__get : {}, values);
+                // A merge holds only the fields this write sent to the model: a row
+                // stored as text before AGL-2773 is not refused for a legacy value
+                // this run never touched.
+                const write = prepareDatasetRecordWrite(updateDataset, payload, {
+                    existing: (_existing_docs__get = existing.docs[0].get('values')) != null ? _existing_docs__get : {}
+                });
+                if (Object.keys(write.errors).length) {
+                    return failed(`record failed validation for dataset "${updateLabel}": ${describeDatasetRecordErrors(write.errors)}`);
+                }
+                const merged = write.values;
                 await existing.docs[0].ref.set(_extends({
                     values: merged
                 }, datasetIntegrityUpdate(updateModel, merged, FieldValue.delete()), {
@@ -460,12 +493,16 @@ async function datasetAppendRefusal(env, datasetRef) {
             } else {
                 // The APPEND leg of update-or-append, and the only one of the two
                 // that adds a row — the merge above rewrites a record that already
-                // counts against the band.
+                // counts against the band. A new row is held to the whole model,
+                // required fields included, like any other append.
+                if (Object.keys(incoming.errors).length) {
+                    return failed(`record failed validation for dataset "${updateLabel}": ${describeDatasetRecordErrors(incoming.errors)}`);
+                }
                 const refusal = await datasetAppendRefusal(env, datasetDoc.ref);
                 if (refusal) return failed(refusal);
                 await datasetDoc.ref.collection('records').add(_extends({
-                    values
-                }, datasetIntegrityFields(updateModel, values), {
+                    values: incoming.values
+                }, datasetIntegrityFields(updateModel, incoming.values), {
                     createdAt: FieldValue.serverTimestamp()
                 }));
             }
@@ -546,7 +583,7 @@ async function datasetAppendRefusal(env, datasetRef) {
        * so the opt-out link the seam mints names it. Without that the
        * preference page opens on a list of every stream the site has, and
        * the recipient has to find the one they were trying to leave.
-       */ const topicId = flowEmailTopicId(step.topicId, scope);
+       */ const topicId = flowSubscriptionTopicId(step.topicId, scope);
             const gate = await flowEmailRefusal({
                 hostId,
                 email: to,
@@ -636,7 +673,7 @@ async function datasetAppendRefusal(env, datasetRef) {
                 priority: 'bulk'
             } : {}, {
                 // `topicId` is `''` for a step that belongs to no stream, which
-                // every reader of it treats as absent — see `flowEmailTopicId`.
+                // every reader of it treats as absent — see `flowSubscriptionTopicId`.
                 // 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 — and the org's confirmation switch,
@@ -753,17 +790,21 @@ async function datasetAppendRefusal(env, datasetRef) {
        */ const campaignLabel = step.campaignName || step.campaignId;
             const campaignOrgId = (_env_orgId = env.orgId) != null ? _env_orgId : await resolveOrgIdForHost(hostId);
             if (!campaignOrgId) return failed(`unknown campaign "${campaignLabel}"`);
-            const campaignsRef = firebaseAdmin.app().firestore().collection('orgs').doc(campaignOrgId).collection('emailCampaigns');
-            const usable = (doc)=>Boolean((doc == null ? void 0 : doc.exists) && !doc.get('deletedAt') && visibleToHost(doc.get('visibleTo'), hostId));
+            // The org's containers of the `campaign` kind, read where the kind's
+            // declaration says they are stored.
+            const containerStore = firebaseAdmin.app().firestore();
+            const usable = (container)=>Boolean((container == null ? void 0 : container.live) && visibleToHost(container.visibleTo, hostId));
             const namedId = (_ref7 = (_step_campaignId = step.campaignId) == null ? void 0 : _step_campaignId.trim()) != null ? _ref7 : '';
-            const campaignDoc = namedId ? await campaignsRef.doc(namedId).get() : (await campaignsRef.where('name', '==', (_ref8 = (_step_campaignName = step.campaignName) == null ? void 0 : _step_campaignName.trim()) != null ? _ref8 : '').limit(10).get()).docs.find(usable);
-            if (!(campaignDoc == null ? void 0 : campaignDoc.exists)) {
+            const campaign = namedId ? (await readOrgContainers(containerStore, 'campaign', campaignOrgId, [
+                namedId
+            ]))[0] : (await findOrgContainersByName(containerStore, 'campaign', campaignOrgId, (_ref8 = (_step_campaignName = step.campaignName) == null ? void 0 : _step_campaignName.trim()) != null ? _ref8 : '', 10)).find(usable);
+            if (!(campaign == null ? void 0 : campaign.exists)) {
                 return failed(`unknown campaign "${campaignLabel}"`);
             }
-            if (campaignDoc.get('deletedAt')) {
+            if (!campaign.live) {
                 return failed(`campaign "${campaignLabel}" was deleted`);
             }
-            if (!usable(campaignDoc)) {
+            if (!usable(campaign)) {
                 return failed(`campaign "${campaignLabel}" is not placed on this site`);
             }
             /*
@@ -781,7 +822,7 @@ async function datasetAppendRefusal(env, datasetRef) {
        * update cannot fail for absence.
        */ const group = await consentGroupForSite(hostId);
             await contact.ref.update({
-                [contactCampaignFieldPath(group.groupId)]: FieldValue.arrayUnion(campaignDoc.id),
+                [contactContainerFieldPath(group.groupId, 'campaign')]: FieldValue.arrayUnion(campaign.id),
                 updatedAt: FieldValue.serverTimestamp()
             });
         } else if (isCrmActionStep(step)) {