Compare commits
91 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4774a8025c | |||
| 689dc1fd6b | |||
| 90677348ff | |||
| 06786e86ef | |||
| 6fda123fc3 | |||
| 2fa91bb943 | |||
| e3cc476508 | |||
| 01ef541917 | |||
| d567257311 | |||
| 3075ef7f5b | |||
| 1ab4e91ffd | |||
| 735e874bd0 | |||
| 99d44eeb8d | |||
| f095a3e2c7 | |||
| 1225802c5d | |||
| ac3329cafe | |||
| 4eb651c6ac | |||
| 0b4017c240 | |||
| 79b576b4bc | |||
| b0282ebff2 | |||
| aae4ef5952 | |||
| 8ee87b7558 | |||
| 7229fb8e3d | |||
| 3487ec7048 | |||
| 22d72f82f5 | |||
| fc36aee6c0 | |||
| 06125cc0e8 | |||
| 21f3014ac5 | |||
| 62a68792a4 | |||
| aa4ec66b7b | |||
| 60efd1cb5d | |||
| 7e1660344d | |||
| a8c0750dd7 | |||
| bfbb86564c | |||
| c05bb8e474 | |||
| 99ef25b08f | |||
| 03100b77db | |||
| 0ac903c82d | |||
| 60776803c5 | |||
| 9a709b1264 | |||
| af833ca38c | |||
| 50c509d161 | |||
| 9f4eab07f6 | |||
| 25a69b3fa9 | |||
| 24538c2a99 | |||
| 7d8579194d | |||
| 09c63de813 | |||
| 057e660b17 | |||
| 701c0fe184 | |||
| 2c5519908a | |||
| dc56687af6 | |||
| 2c70c553ac | |||
| 8627d0e135 | |||
| d2adcca7ae | |||
| 002ca4b371 | |||
| 641bead0d8 | |||
| 3c305753d6 | |||
| ef513816f8 | |||
| b7653b58f4 | |||
| ce92499333 | |||
| 04bc6c430e | |||
| 04c214b149 | |||
| 35b3cc151d | |||
| c54fec4cc3 | |||
| 1d291377c0 | |||
| 78f52a36d4 | |||
| 0c4f198802 | |||
| c71fa3dc64 | |||
| 0a6064ec62 | |||
| fce6dd1138 | |||
| 4b9eb79065 | |||
| 7ea5bdb217 | |||
| f755cdf48d | |||
| 8965b27517 | |||
| 12036b1f36 | |||
| ad34365f6c | |||
| 724ca779d6 | |||
| 2e593b7fa4 | |||
| 3f0b14a726 | |||
| 30b43913e8 | |||
| 83b2082c74 | |||
| 5775347746 | |||
| 083c089003 | |||
| 54c9881a25 | |||
| da4c8731fc | |||
| 9a6b6c7e8e | |||
| 52e6ed49c5 | |||
| 57f6066bf7 | |||
| 533c4c8fe3 | |||
| fb6fb67d45 | |||
| ab2343aa88 |
35
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
35
.gitea/ISSUE_TEMPLATE/bug_report.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
---
|
||||||
|
name: "Bug"
|
||||||
|
about: "Report a reproducible defect, regression, or incorrect behavior"
|
||||||
|
title: "[Bug] "
|
||||||
|
labels:
|
||||||
|
- type/bug
|
||||||
|
- status/triage
|
||||||
|
- module/campaign
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Repository:
|
||||||
|
- Area/module:
|
||||||
|
- Affected version or commit:
|
||||||
|
|
||||||
|
## Behavior
|
||||||
|
|
||||||
|
Expected:
|
||||||
|
|
||||||
|
Actual:
|
||||||
|
|
||||||
|
## Reproduction
|
||||||
|
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
|
||||||
|
## Evidence
|
||||||
|
|
||||||
|
Logs, screenshots, traces, or failing test output:
|
||||||
|
|
||||||
|
## Verification Target
|
||||||
|
|
||||||
|
Command or workflow that should pass when fixed:
|
||||||
1
.gitea/ISSUE_TEMPLATE/config.yaml
Normal file
1
.gitea/ISSUE_TEMPLATE/config.yaml
Normal file
@@ -0,0 +1 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
27
.gitea/ISSUE_TEMPLATE/docs_workflow.md
Normal file
27
.gitea/ISSUE_TEMPLATE/docs_workflow.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
name: "Docs / workflow"
|
||||||
|
about: "Request documentation, process, or developer workflow changes"
|
||||||
|
title: "[Docs] "
|
||||||
|
labels:
|
||||||
|
- type/docs
|
||||||
|
- status/triage
|
||||||
|
- module/campaign
|
||||||
|
- area/docs
|
||||||
|
---
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Repository:
|
||||||
|
- Document or workflow:
|
||||||
|
|
||||||
|
## Current State
|
||||||
|
|
||||||
|
What is missing, unclear, duplicated, or stale?
|
||||||
|
|
||||||
|
## Desired State
|
||||||
|
|
||||||
|
What should the docs or workflow make clear?
|
||||||
|
|
||||||
|
## Verification Target
|
||||||
|
|
||||||
|
How should this be checked?
|
||||||
32
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
32
.gitea/ISSUE_TEMPLATE/feature_request.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
name: "Feature"
|
||||||
|
about: "Propose new user-visible behavior or platform capability"
|
||||||
|
title: "[Feature] "
|
||||||
|
labels:
|
||||||
|
- type/feature
|
||||||
|
- status/triage
|
||||||
|
- module/campaign
|
||||||
|
---
|
||||||
|
|
||||||
|
## Problem
|
||||||
|
|
||||||
|
What user, operator, or developer problem should this solve?
|
||||||
|
|
||||||
|
## Proposed Capability
|
||||||
|
|
||||||
|
What should exist when this is done?
|
||||||
|
|
||||||
|
## Ownership
|
||||||
|
|
||||||
|
- Owning repository:
|
||||||
|
- Related module repositories:
|
||||||
|
- Extension point or integration boundary:
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- [ ]
|
||||||
|
- [ ]
|
||||||
|
|
||||||
|
## Verification Target
|
||||||
|
|
||||||
|
Command, scenario, or UI flow that should prove completion:
|
||||||
28
.gitea/ISSUE_TEMPLATE/task.md
Normal file
28
.gitea/ISSUE_TEMPLATE/task.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
name: "Task"
|
||||||
|
about: "Track implementation, maintenance, or migration work"
|
||||||
|
title: "[Task] "
|
||||||
|
labels:
|
||||||
|
- type/task
|
||||||
|
- status/triage
|
||||||
|
- module/campaign
|
||||||
|
---
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
What needs to be completed?
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
- Owning repository:
|
||||||
|
- In-scope:
|
||||||
|
- Out-of-scope:
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ]
|
||||||
|
- [ ]
|
||||||
|
|
||||||
|
## Verification Target
|
||||||
|
|
||||||
|
Command or manual check:
|
||||||
25
.gitea/ISSUE_TEMPLATE/tech_debt.md
Normal file
25
.gitea/ISSUE_TEMPLATE/tech_debt.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
---
|
||||||
|
name: "Tech debt"
|
||||||
|
about: "Track cleanup, refactoring, risk reduction, or deferred engineering work"
|
||||||
|
title: "[Debt] "
|
||||||
|
labels:
|
||||||
|
- type/debt
|
||||||
|
- status/triage
|
||||||
|
- module/campaign
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current Cost
|
||||||
|
|
||||||
|
What does this make harder, riskier, slower, or more fragile?
|
||||||
|
|
||||||
|
## Desired Shape
|
||||||
|
|
||||||
|
What should the code, tests, or architecture look like afterwards?
|
||||||
|
|
||||||
|
## Constraints
|
||||||
|
|
||||||
|
What behavior, compatibility, or module boundary must be preserved?
|
||||||
|
|
||||||
|
## Verification Target
|
||||||
|
|
||||||
|
Focused checks that should pass:
|
||||||
15
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
15
.gitea/PULL_REQUEST_TEMPLATE.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
## Issue
|
||||||
|
|
||||||
|
Closes #
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
-
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
-
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
Follow-up issues:
|
||||||
19
.gitignore
vendored
19
.gitignore
vendored
@@ -331,3 +331,22 @@ cython_debug/
|
|||||||
# GovOPlaN WebUI test output
|
# GovOPlaN WebUI test output
|
||||||
webui/.policy-test-build/
|
webui/.policy-test-build/
|
||||||
webui/.template-preview-test-build/
|
webui/.template-preview-test-build/
|
||||||
|
webui/.import-test-build/
|
||||||
|
webui/.review-preview-test-build/
|
||||||
|
webui/.report-grid-test-build/
|
||||||
|
|
||||||
|
# GovOPlaN shared ignore rules from govoplan-core
|
||||||
|
# Local WebUI test/build scratch directories
|
||||||
|
.component-test-build/
|
||||||
|
.module-test-build/
|
||||||
|
.policy-test-build/
|
||||||
|
.template-preview-test-build/
|
||||||
|
.import-test-build/
|
||||||
|
.review-preview-test-build/
|
||||||
|
webui/.component-test-build/
|
||||||
|
webui/.module-test-build/
|
||||||
|
*.db
|
||||||
|
# GovOPlaN local runtime state
|
||||||
|
runtime/
|
||||||
|
webui/.module-test-build/
|
||||||
|
webui/.component-test-build/
|
||||||
|
|||||||
@@ -26,8 +26,8 @@ PATH=/mnt/DATA/git/govoplan-core/webui/node_modules/.bin:/home/zemion/.nvm/versi
|
|||||||
For combined checks, run:
|
For combined checks, run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd /mnt/DATA/git/govoplan-core
|
cd /mnt/DATA/git/govoplan
|
||||||
./scripts/check-focused.sh
|
tools/checks/check-focused.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
## Working Rules
|
## Working Rules
|
||||||
|
|||||||
49
README.md
49
README.md
@@ -1,5 +1,9 @@
|
|||||||
# govoplan-campaign
|
# govoplan-campaign
|
||||||
|
|
||||||
|
<!-- govoplan-repository-type:start -->
|
||||||
|
**Repository type:** module (domain).
|
||||||
|
<!-- govoplan-repository-type:end -->
|
||||||
|
|
||||||
GovOPlaN Campaign is the campaign authoring, validation, review, sending-control, and reporting module. It bundles backend campaign APIs with the campaign WebUI package.
|
GovOPlaN Campaign is the campaign authoring, validation, review, sending-control, and reporting module. It bundles backend campaign APIs with the campaign WebUI package.
|
||||||
|
|
||||||
## Ownership
|
## Ownership
|
||||||
@@ -11,9 +15,12 @@ This repository owns:
|
|||||||
- campaign/version/job/issue/send-attempt/append-attempt models and migrations
|
- campaign/version/job/issue/send-attempt/append-attempt models and migrations
|
||||||
- campaign JSON schema, validation, message building, attachment resolution, ZIP handling, reports, queue/control services, and mock-send paths
|
- campaign JSON schema, validation, message building, attachment resolution, ZIP handling, reports, queue/control services, and mock-send paths
|
||||||
- WebUI package `@govoplan/campaign-webui`
|
- WebUI package `@govoplan/campaign-webui`
|
||||||
- route contributions for `/campaigns`, `/campaigns/:campaignId/*`, `/operator`, `/reports`, `/address-book`, and `/templates`
|
- route contributions for `/campaigns`, `/campaigns/:campaignId/*`, `/operator`, `/reports`, and `/templates`
|
||||||
|
|
||||||
Core owns auth, tenants, RBAC evaluation, database/session primitives, CSRF/API helpers, shell layout, and route rendering. Files and mail own their respective storage and transport capabilities.
|
Core owns the auth facade, RBAC/capability contracts, database/session
|
||||||
|
primitives, CSRF/API helpers, shell layout, and route rendering. Tenancy is an
|
||||||
|
optional platform module for tenant administration and tenant resolver behavior.
|
||||||
|
Files and mail own their respective storage and transport capabilities.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
@@ -23,11 +30,32 @@ The module has one required runtime dependency:
|
|||||||
|
|
||||||
Files and mail are optional module integrations declared in the campaign manifest:
|
Files and mail are optional module integrations declared in the campaign manifest:
|
||||||
|
|
||||||
- `govoplan-files` enables managed attachment selection, frozen file-version evidence, and managed-file usage tracking. Without it, campaigns can still use legacy/local attachment paths where configured.
|
- `govoplan-files` enables managed attachment selection, frozen file-version evidence, and managed-file usage tracking. Server/API campaigns require this integration for attachments and never resolve caller-supplied local filesystem paths. Legacy file-oriented loading remains available only to explicitly trusted operator/library workflows.
|
||||||
- `govoplan-mail` enables reusable mail profiles, delivery policy checks, SMTP sending, and IMAP append behavior. Without it, campaigns can still be authored, validated, built, and reported, but real delivery/profile features are unavailable.
|
- `govoplan-mail` owns reusable profiles, encrypted SMTP/IMAP credentials, delivery policy checks, connection tests, and transport execution. Campaign JSON stores only `server.mail_profile_id`; inline transport settings and credentials are rejected. Without Mail, campaigns can still be authored, but profile validation and real delivery are unavailable.
|
||||||
|
|
||||||
|
Public campaign, version, job, and report responses expose business data and
|
||||||
|
delivery evidence, but never process-local paths, storage-backend keys, or
|
||||||
|
worker claim tokens. Operational troubleshooting uses the dedicated job
|
||||||
|
diagnostics endpoint and requires the tenant-level
|
||||||
|
`campaigns:diagnostic:read` permission. The campaign sender role receives this
|
||||||
|
permission; tenant-wide administrator scopes continue to grant it through the
|
||||||
|
standard policy evaluator.
|
||||||
|
|
||||||
Backend optional behavior is accessed through core-provided capabilities, not direct required imports. WebUI optional behavior uses core module metadata/capabilities so campaign pages can build and run without files or mail WebUI packages installed.
|
Backend optional behavior is accessed through core-provided capabilities, not direct required imports. WebUI optional behavior uses core module metadata/capabilities so campaign pages can build and run without files or mail WebUI packages installed.
|
||||||
|
|
||||||
|
Campaign also provides narrow kernel capabilities so other modules and core
|
||||||
|
services can cooperate without importing campaign internals:
|
||||||
|
|
||||||
|
- `campaigns.access` for campaign share/existence checks
|
||||||
|
- `campaigns.mailPolicyContext` for campaign-scoped mail policy and owner
|
||||||
|
context
|
||||||
|
- `campaigns.policyContext` for retention/policy provenance
|
||||||
|
- `campaigns.deliveryTasks` for queued send and append-to-Sent workers
|
||||||
|
- `campaigns.retention` for campaign-owned retention cleanup
|
||||||
|
|
||||||
|
Keep these capability payloads narrow: stable ids, policy payloads, and task
|
||||||
|
results only.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Install through the core environment:
|
Install through the core environment:
|
||||||
@@ -61,6 +89,19 @@ Frontend package:
|
|||||||
|
|
||||||
Platform RBAC and governance rules are documented in `govoplan-core/docs/`.
|
Platform RBAC and governance rules are documented in `govoplan-core/docs/`.
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
- [Campaign handbook](docs/CAMPAIGN_HANDBOOK.md) provides the adaptive user, process, governance, technical, and operations perspectives.
|
||||||
|
- [Campaign delivery runbook](docs/CAMPAIGN_DELIVERY_RUNBOOK.md) covers queueing, local vs Celery operation, retries, reconciliation, reports, and the live SMTP/IMAP test checklist.
|
||||||
|
- Immediate delivery is bounded to 25 exact eligible recipient jobs by default. Deployments may set `GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS` (0–500), and tenants may narrow that ceiling through `campaign_delivery_policy.synchronous_send_max_recipients` in tenant settings.
|
||||||
|
- Report-email preview uses the selected version's stored v5 Mail-profile evidence. Live report email fails closed until [govoplan-mail#17](https://git.add-ideas.de/add-ideas/govoplan-mail/issues/17) provides a durable, idempotent Mail-owned outbox and transport-attempt ledger; per-job CSV is off by default and requires `campaigns:recipient:export` when requested.
|
||||||
|
- [Campaign/Mail profile boundary](docs/MAIL_PROFILE_BOUNDARY.md) defines profile-only delivery, runtime resolution, execution evidence, and the fail-closed legacy migration path.
|
||||||
|
- [Recipient import guide](docs/RECIPIENT_IMPORT_GUIDE.md) covers user/admin workflows, mapping profiles, validation, and import evidence.
|
||||||
|
- [Recipient and address boundary](docs/RECIPIENT_ADDRESS_BOUNDARY.md) defines the split between campaign-local recipients and future reusable address management.
|
||||||
|
- [Example campaigns and release checklist](docs/EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md) defines the maintained example scenarios and release gates.
|
||||||
|
- [Campaign examples](examples/README.md) is the credential-free scenario catalogue that release fixtures must follow.
|
||||||
|
- [SMTP/IMAP test bed](dev/mail-testbed/README.md) provides the GreenMail Docker Compose setup and transport smoke for dedicated non-production delivery tests.
|
||||||
|
|
||||||
## Release packaging
|
## Release packaging
|
||||||
|
|
||||||
The repository root includes a `package.json` for git-based WebUI installs. It exports the package `@govoplan/campaign-webui` from `webui/src` so release builds can depend on tagged git refs instead of local `file:` paths. Files and mail WebUI packages remain optional product-composition dependencies supplied by the core host build, not required campaign package dependencies.
|
The repository root includes a `package.json` for git-based WebUI installs. It exports the package `@govoplan/campaign-webui` from `webui/src` so release builds can depend on tagged git refs instead of local `file:` paths. Files and mail WebUI packages remain optional product-composition dependencies supplied by the core host build, not required campaign package dependencies.
|
||||||
|
|||||||
13
dev/mail-testbed/.env.example
Normal file
13
dev/mail-testbed/.env.example
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
GOVOPLAN_MAIL_TEST_LOCAL_PART=campaign-test
|
||||||
|
GOVOPLAN_MAIL_TEST_DOMAIN=govoplan.test
|
||||||
|
GOVOPLAN_MAIL_TEST_USER=campaign-test@govoplan.test
|
||||||
|
GOVOPLAN_MAIL_TEST_PASSWORD=campaign-test-password
|
||||||
|
GOVOPLAN_MAIL_TEST_RECIPIENT=campaign-test@govoplan.test
|
||||||
|
GOVOPLAN_MAIL_TEST_FROM=campaign-test@govoplan.test
|
||||||
|
GOVOPLAN_MAIL_TEST_SMTP_PORT=3025
|
||||||
|
GOVOPLAN_MAIL_TEST_IMAP_PORT=3143
|
||||||
|
GOVOPLAN_MAIL_TEST_SENT_FOLDER=Sent
|
||||||
|
GOVOPLAN_MAIL_TEST_ZIP_PASSWORD=zip-test-password
|
||||||
|
GOVOPLAN_MAIL_TEST_READY_TIMEOUT_SECONDS=45
|
||||||
|
GOVOPLAN_CAMPAIGN_TEST_REDIS_PORT=36379
|
||||||
|
GOVOPLAN_CAMPAIGN_TEST_REDIS_VISIBILITY_TIMEOUT_SECONDS=3
|
||||||
174
dev/mail-testbed/README.md
Normal file
174
dev/mail-testbed/README.md
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
# Campaign SMTP/IMAP Test Bed
|
||||||
|
|
||||||
|
This test bed provides dedicated non-production SMTP/IMAP infrastructure for
|
||||||
|
campaign delivery checks. It uses GreenMail and must never be configured with
|
||||||
|
production recipients or credentials.
|
||||||
|
|
||||||
|
## Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /mnt/DATA/git/govoplan-campaign/dev/mail-testbed
|
||||||
|
cp .env.example .env
|
||||||
|
docker compose --env-file .env up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Default endpoints:
|
||||||
|
|
||||||
|
- SMTP: `127.0.0.1:3025`, plain transport
|
||||||
|
- IMAP: `127.0.0.1:3143`, plain transport
|
||||||
|
- GreenMail API/UI endpoint: `127.0.0.1:38080`
|
||||||
|
|
||||||
|
## Smoke Test
|
||||||
|
|
||||||
|
Run the transport smoke from the core virtual environment after installing the
|
||||||
|
campaign and mail modules:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /mnt/DATA/git/govoplan-campaign/dev/mail-testbed
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
/mnt/DATA/git/govoplan-core/.venv/bin/python run_transport_smoke.py
|
||||||
|
```
|
||||||
|
|
||||||
|
The smoke sends and appends three messages:
|
||||||
|
|
||||||
|
- no attachment
|
||||||
|
- one normal attachment
|
||||||
|
- one password-protected AES ZIP attachment
|
||||||
|
|
||||||
|
It verifies SMTP authentication, IMAP authentication, folder listing, delivery
|
||||||
|
to `INBOX`, and append-to-Sent behavior.
|
||||||
|
|
||||||
|
If the smoke is started immediately after `docker compose up -d`, GreenMail may
|
||||||
|
bind the SMTP/IMAP ports before the services are fully ready. The smoke retries
|
||||||
|
login and folder setup for `GOVOPLAN_MAIL_TEST_READY_TIMEOUT_SECONDS`.
|
||||||
|
|
||||||
|
## Campaign Acceptance
|
||||||
|
|
||||||
|
The transport smoke proves the Mail adapters. The Campaign acceptance runner
|
||||||
|
proves the public composition: it creates an isolated temporary Core database,
|
||||||
|
creates a Mail-owned encrypted profile through the API, materializes the
|
||||||
|
credential-free [`greenmail-delivery`](../../examples/greenmail-delivery/campaign.json)
|
||||||
|
fixture with only that profile reference, validates/builds it, sends the exact
|
||||||
|
generated EML through Campaign once, appends it once, and cross-checks Campaign
|
||||||
|
report/audit state with one unique-subject message in the GreenMail INBOX and
|
||||||
|
Sent folders. Provider mailbox verification is not a byte-for-byte comparison
|
||||||
|
after provider-side header or storage transformations.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /mnt/DATA/git/govoplan-campaign/dev/mail-testbed
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
/mnt/DATA/git/govoplan/.venv/bin/python run_campaign_acceptance.py \
|
||||||
|
--evidence /tmp/govoplan-campaign-greenmail-evidence.json
|
||||||
|
```
|
||||||
|
|
||||||
|
The default run also uses controlled loopback protocol endpoints to prove that
|
||||||
|
an SMTP connection loss before transmission is temporary, an explicit SMTP
|
||||||
|
authentication rejection is permanent, a final `451` response after DATA is
|
||||||
|
temporary, one accepted and one refused RCPT command is retained as partial
|
||||||
|
envelope acceptance, a connection loss after complete DATA is frozen as
|
||||||
|
`outcome_unknown`, and an IMAP authentication rejection after SMTP acceptance
|
||||||
|
leaves the send accepted while the append fails. A
|
||||||
|
second ordinary send must be rejected before another provider effect.
|
||||||
|
|
||||||
|
The worker drill queues one job, starts the registered
|
||||||
|
`govoplan.campaigns.send_email` task body in a dedicated OS process, waits until
|
||||||
|
the controlled endpoint has received complete DATA, terminates that process,
|
||||||
|
and starts the same task body in a fresh process. It proves the durable
|
||||||
|
`sending`/unfinished-attempt boundary is recovered as `outcome_unknown`
|
||||||
|
without a second SMTP connection or DATA transaction. This is a real process
|
||||||
|
and task-boundary interruption, but it does not start a Celery daemon, Redis
|
||||||
|
broker, or broker redelivery; `celery_broker_redelivery` therefore remains
|
||||||
|
`false` in the evidence.
|
||||||
|
|
||||||
|
The bounded JSON contains no endpoint, account, address, credential, profile,
|
||||||
|
campaign, version, or job identifiers. It records module versions, the fixture
|
||||||
|
hash, normalized classifications/counts, the Mail-profile boundary, required
|
||||||
|
audit actions, provider mailbox increments, and coverage flags. Runtime version
|
||||||
|
declarations identify the exercised composition; they do not claim that the
|
||||||
|
sources are clean, tagged, signed, or release-provenanced. The evidence names
|
||||||
|
them `declared_module_versions` and keeps `source_artifact_provenance` false;
|
||||||
|
exact commit/artifact provenance belongs to the package and release gate.
|
||||||
|
|
||||||
|
This runner is restricted to literal loopback IP addresses and the synchronous
|
||||||
|
Campaign delivery mode. Hostnames such as `localhost` and every non-loopback
|
||||||
|
address fail before profile creation, avoiding a DNS change between validation
|
||||||
|
and connection. It is local target-like evidence, not approval of an
|
||||||
|
institution's SMTP/IMAP service. The controlled post-DATA, temporary-response,
|
||||||
|
partial-refusal, and task-process interruption drills are local effect-level
|
||||||
|
proof, not proof of a target provider's behavior or Redis/Celery broker
|
||||||
|
redelivery. Use `--success-only` only when testing the success journey without
|
||||||
|
the local failure endpoints.
|
||||||
|
|
||||||
|
## Redis/Celery Redelivery Acceptance
|
||||||
|
|
||||||
|
Run the maintained broker/worker-loss acceptance separately from the GreenMail
|
||||||
|
journey:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /mnt/DATA/git/govoplan-campaign/dev/mail-testbed
|
||||||
|
set -a
|
||||||
|
. ./.env
|
||||||
|
set +a
|
||||||
|
/mnt/DATA/git/govoplan/.venv/bin/python run_celery_redelivery_acceptance.py \
|
||||||
|
--evidence /tmp/govoplan-campaign-celery-redelivery-evidence.json
|
||||||
|
```
|
||||||
|
|
||||||
|
The runner creates a unique Compose project, starts only its loopback-bound,
|
||||||
|
AOF-enabled Redis service, creates an isolated temporary GovOPlaN database,
|
||||||
|
and starts a real Celery worker subscribed to `send_email`. A controlled SMTP
|
||||||
|
server holds the transaction after complete DATA and before the final response.
|
||||||
|
The runner kills that solo worker with the task still unacknowledged and starts
|
||||||
|
a replacement worker. After the configured Redis visibility timeout, the same Celery task identity must be redelivered.
|
||||||
|
The replacement must turn the durable
|
||||||
|
unfinished attempt into `outcome_unknown`, acknowledge the task, drain the
|
||||||
|
broker queue/unacked records, and leave the SMTP endpoint at exactly one
|
||||||
|
connection and one DATA transaction.
|
||||||
|
|
||||||
|
Only bounded counts, classifications, and booleans are retained. Worker logs,
|
||||||
|
task IDs, database identifiers, endpoints, credentials, and raw diagnostics are
|
||||||
|
kept in the temporary runtime and deleted. The evidence proves the local Redis
|
||||||
|
transport, real Celery process boundary, runner-supervised replacement, and
|
||||||
|
Campaign's duplicate-effect guard. It deliberately keeps production daemon supervision,
|
||||||
|
target-provider behavior, and source-artifact provenance false.
|
||||||
|
It does not claim that systemd, Kubernetes, another container orchestrator, or
|
||||||
|
an institution's Redis/SMTP deployment behaves identically.
|
||||||
|
|
||||||
|
The default run requires Docker CLI/Compose/daemon access and permission to
|
||||||
|
pull `redis:7-alpine`; the Celery workers execute from the current Python
|
||||||
|
environment. The isolated Compose project and volume are removed on exit.
|
||||||
|
`GOVOPLAN_CAMPAIGN_TEST_REDIS_VISIBILITY_TIMEOUT_SECONDS` defaults to three
|
||||||
|
seconds only to make this destructive local drill finish promptly; it is not a
|
||||||
|
production recommendation.
|
||||||
|
|
||||||
|
Starting the maintained test bed requires a working Docker CLI, Compose plugin,
|
||||||
|
daemon/socket access, and permission to pull `greenmail/standalone:2.1.9`. The
|
||||||
|
Campaign runner needs only the already-running loopback endpoints; it neither
|
||||||
|
starts Docker nor claims that it did.
|
||||||
|
|
||||||
|
## Use With A Campaign
|
||||||
|
|
||||||
|
Use the same settings in a campaign mail profile:
|
||||||
|
|
||||||
|
- SMTP host `127.0.0.1`, port `3025`, security `plain`
|
||||||
|
- IMAP host `127.0.0.1`, port `3143`, security `plain`
|
||||||
|
- username and password from `.env`
|
||||||
|
- append folder from `GOVOPLAN_MAIL_TEST_SENT_FOLDER`
|
||||||
|
|
||||||
|
When changing the mailbox, keep `GOVOPLAN_MAIL_TEST_USER` equal to
|
||||||
|
`${GOVOPLAN_MAIL_TEST_LOCAL_PART}@${GOVOPLAN_MAIL_TEST_DOMAIN}` because the
|
||||||
|
compose file creates the GreenMail account from local part, password, and
|
||||||
|
domain while login uses the full email address.
|
||||||
|
|
||||||
|
Then run the controlled sending checklist from
|
||||||
|
`docs/CAMPAIGN_DELIVERY_RUNBOOK.md` for no attachment, one attachment, and
|
||||||
|
password-protected ZIP campaign variants.
|
||||||
|
|
||||||
|
## Stop
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose --env-file .env down -v
|
||||||
|
```
|
||||||
33
dev/mail-testbed/docker-compose.yml
Normal file
33
dev/mail-testbed/docker-compose.yml
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
services:
|
||||||
|
greenmail:
|
||||||
|
image: greenmail/standalone:2.1.9
|
||||||
|
container_name: govoplan-campaign-mail-testbed
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
GREENMAIL_OPTS: >-
|
||||||
|
-Dgreenmail.setup.test.all
|
||||||
|
-Dgreenmail.hostname=0.0.0.0
|
||||||
|
-Dgreenmail.auth.disabled=false
|
||||||
|
-Dgreenmail.users=${GOVOPLAN_MAIL_TEST_LOCAL_PART:-campaign-test}:${GOVOPLAN_MAIL_TEST_PASSWORD:-campaign-test-password}@${GOVOPLAN_MAIL_TEST_DOMAIN:-govoplan.test}
|
||||||
|
-Dgreenmail.users.login=email
|
||||||
|
-Dgreenmail.verbose
|
||||||
|
ports:
|
||||||
|
- "${GOVOPLAN_MAIL_TEST_SMTP_PORT:-3025}:3025"
|
||||||
|
- "${GOVOPLAN_MAIL_TEST_IMAP_PORT:-3143}:3143"
|
||||||
|
- "127.0.0.1:38080:8080"
|
||||||
|
|
||||||
|
redis:
|
||||||
|
image: redis:7-alpine
|
||||||
|
command: ["redis-server", "--appendonly", "yes"]
|
||||||
|
ports:
|
||||||
|
- "127.0.0.1:${GOVOPLAN_CAMPAIGN_TEST_REDIS_PORT:-36379}:6379"
|
||||||
|
healthcheck:
|
||||||
|
test: ["CMD", "redis-cli", "ping"]
|
||||||
|
interval: 1s
|
||||||
|
timeout: 1s
|
||||||
|
retries: 30
|
||||||
|
volumes:
|
||||||
|
- campaign-redis-data:/data
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
campaign-redis-data:
|
||||||
1935
dev/mail-testbed/run_campaign_acceptance.py
Normal file
1935
dev/mail-testbed/run_campaign_acceptance.py
Normal file
File diff suppressed because it is too large
Load Diff
856
dev/mail-testbed/run_celery_redelivery_acceptance.py
Normal file
856
dev/mail-testbed/run_celery_redelivery_acceptance.py
Normal file
@@ -0,0 +1,856 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Prove Redis/Celery redelivery does not repeat an ambiguous SMTP effect.
|
||||||
|
|
||||||
|
The default run starts an isolated Redis Compose service, two successive real
|
||||||
|
Celery worker processes, and a controlled loopback SMTP endpoint. It kills the
|
||||||
|
first worker after complete DATA but before a final SMTP response. The same
|
||||||
|
unacknowledged broker task must be delivered to the replacement worker, which
|
||||||
|
must freeze the unfinished durable attempt as ``outcome_unknown`` without a
|
||||||
|
second SMTP connection or DATA transaction.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
from collections import Counter
|
||||||
|
from contextlib import contextmanager
|
||||||
|
from dataclasses import dataclass, replace
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
import hashlib
|
||||||
|
import json
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
import socket
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import time
|
||||||
|
from typing import Any, Callable, Iterator, Mapping
|
||||||
|
from uuid import uuid4
|
||||||
|
|
||||||
|
from redis import Redis
|
||||||
|
from redis.exceptions import RedisError
|
||||||
|
|
||||||
|
|
||||||
|
SCRIPT_ROOT = Path(__file__).resolve().parent
|
||||||
|
REPOSITORY_ROOT = SCRIPT_ROOT.parents[1]
|
||||||
|
if str(SCRIPT_ROOT) not in sys.path:
|
||||||
|
sys.path.insert(0, str(SCRIPT_ROOT))
|
||||||
|
|
||||||
|
from run_campaign_acceptance import ( # noqa: E402
|
||||||
|
AcceptanceError,
|
||||||
|
DEFAULT_FIXTURE,
|
||||||
|
EXPECTED_AUDIT_ACTIONS,
|
||||||
|
TestbedSettings,
|
||||||
|
_assert_evidence_safe,
|
||||||
|
_core_package_version,
|
||||||
|
_durable_state_evidence,
|
||||||
|
_expect,
|
||||||
|
_report_evidence,
|
||||||
|
create_mail_profile,
|
||||||
|
prepare_campaign_scenario,
|
||||||
|
required_composition_versions,
|
||||||
|
smtp_fault_endpoint,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
EVIDENCE_SCHEMA = "govoplan.campaign.celery-redelivery-acceptance.v1"
|
||||||
|
MAX_EVIDENCE_BYTES = 128 * 1024
|
||||||
|
DEFAULT_COMPOSE_FILE = SCRIPT_ROOT / "docker-compose.yml"
|
||||||
|
TASK_RECEIVED_PATTERN = re.compile(
|
||||||
|
r"Task govoplan[.]campaigns[.]send_email\[([0-9a-f-]{36})\] received",
|
||||||
|
re.IGNORECASE,
|
||||||
|
)
|
||||||
|
TASK_SUCCEEDED_PATTERN = re.compile(
|
||||||
|
r"Task govoplan[.]campaigns[.]send_email\[([0-9a-f-]{36})\] succeeded",
|
||||||
|
re.IGNORECASE,
|
||||||
|
)
|
||||||
|
WORKER_BOOTSTRAP = r"""
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from govoplan_core.celery_app import celery
|
||||||
|
|
||||||
|
visibility_timeout = int(os.environ["GOVOPLAN_CAMPAIGN_TEST_REDIS_VISIBILITY_TIMEOUT_SECONDS"])
|
||||||
|
celery.conf.broker_transport_options = {
|
||||||
|
**dict(celery.conf.broker_transport_options or {}),
|
||||||
|
"polling_interval": 0.25,
|
||||||
|
"visibility_timeout": visibility_timeout,
|
||||||
|
}
|
||||||
|
celery.worker_main(
|
||||||
|
[
|
||||||
|
"worker",
|
||||||
|
"--loglevel=INFO",
|
||||||
|
"--pool=solo",
|
||||||
|
"--concurrency=1",
|
||||||
|
"--queues=send_email",
|
||||||
|
f"--hostname={sys.argv[1]}@%h",
|
||||||
|
"--without-gossip",
|
||||||
|
"--without-mingle",
|
||||||
|
"--without-heartbeat",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class WorkerProcess:
|
||||||
|
process: subprocess.Popen[bytes]
|
||||||
|
log_path: Path
|
||||||
|
log_handle: Any
|
||||||
|
|
||||||
|
def text(self) -> str:
|
||||||
|
self.log_handle.flush()
|
||||||
|
try:
|
||||||
|
return self.log_path.read_text(encoding="utf-8", errors="replace")
|
||||||
|
except OSError as exc:
|
||||||
|
raise AcceptanceError("Celery worker evidence log could not be read") from exc
|
||||||
|
|
||||||
|
def received_task_ids(self) -> tuple[str, ...]:
|
||||||
|
return tuple(TASK_RECEIVED_PATTERN.findall(self.text()))
|
||||||
|
|
||||||
|
def succeeded_task_ids(self) -> tuple[str, ...]:
|
||||||
|
return tuple(TASK_SUCCEEDED_PATTERN.findall(self.text()))
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True, slots=True)
|
||||||
|
class RedisBrokerState:
|
||||||
|
queue_depth: int
|
||||||
|
unacked_hash_count: int
|
||||||
|
unacked_index_count: int
|
||||||
|
|
||||||
|
def as_dict(self) -> dict[str, int]:
|
||||||
|
return {
|
||||||
|
"queue_depth": self.queue_depth,
|
||||||
|
"unacked_hash_count": self.unacked_hash_count,
|
||||||
|
"unacked_index_count": self.unacked_index_count,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _positive_int(value: str, *, label: str) -> int:
|
||||||
|
try:
|
||||||
|
parsed = int(value)
|
||||||
|
except ValueError as exc:
|
||||||
|
raise argparse.ArgumentTypeError(f"{label} must be a positive integer") from exc
|
||||||
|
if parsed <= 0:
|
||||||
|
raise argparse.ArgumentTypeError(f"{label} must be a positive integer")
|
||||||
|
return parsed
|
||||||
|
|
||||||
|
|
||||||
|
def _unused_loopback_port() -> int:
|
||||||
|
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as probe:
|
||||||
|
probe.bind(("127.0.0.1", 0))
|
||||||
|
return int(probe.getsockname()[1])
|
||||||
|
|
||||||
|
|
||||||
|
def _compose_command(
|
||||||
|
*, compose_file: Path, project_name: str, operation: str
|
||||||
|
) -> list[str]:
|
||||||
|
prefix = [
|
||||||
|
"docker",
|
||||||
|
"compose",
|
||||||
|
"--file",
|
||||||
|
str(compose_file),
|
||||||
|
"--project-name",
|
||||||
|
project_name,
|
||||||
|
]
|
||||||
|
if operation == "up":
|
||||||
|
return [*prefix, "up", "--detach", "redis"]
|
||||||
|
if operation == "down":
|
||||||
|
return [*prefix, "down", "--volumes", "--remove-orphans"]
|
||||||
|
raise AcceptanceError("Unsupported Redis Compose operation")
|
||||||
|
|
||||||
|
|
||||||
|
def _run_compose(
|
||||||
|
command: list[str],
|
||||||
|
*,
|
||||||
|
environment: Mapping[str, str],
|
||||||
|
timeout_seconds: int,
|
||||||
|
) -> None:
|
||||||
|
try:
|
||||||
|
completed = subprocess.run(
|
||||||
|
command,
|
||||||
|
env=dict(environment),
|
||||||
|
stdin=subprocess.DEVNULL,
|
||||||
|
stdout=subprocess.PIPE,
|
||||||
|
stderr=subprocess.PIPE,
|
||||||
|
timeout=timeout_seconds,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
except (OSError, subprocess.TimeoutExpired) as exc:
|
||||||
|
raise AcceptanceError("Redis Compose lifecycle command failed") from exc
|
||||||
|
if completed.returncode != 0:
|
||||||
|
raise AcceptanceError("Redis Compose lifecycle command failed")
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_redis(redis_url: str, *, timeout_seconds: int) -> None:
|
||||||
|
deadline = time.monotonic() + timeout_seconds
|
||||||
|
client = Redis.from_url(
|
||||||
|
redis_url,
|
||||||
|
socket_connect_timeout=1,
|
||||||
|
socket_timeout=1,
|
||||||
|
decode_responses=False,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
try:
|
||||||
|
if client.ping() is True:
|
||||||
|
return
|
||||||
|
except RedisError:
|
||||||
|
pass
|
||||||
|
time.sleep(0.25)
|
||||||
|
finally:
|
||||||
|
client.close()
|
||||||
|
raise AcceptanceError("Isolated Redis broker did not become ready")
|
||||||
|
|
||||||
|
|
||||||
|
@contextmanager
|
||||||
|
def isolated_redis_broker(
|
||||||
|
*,
|
||||||
|
compose_file: Path,
|
||||||
|
timeout_seconds: int,
|
||||||
|
requested_port: int | None = None,
|
||||||
|
) -> Iterator[str]:
|
||||||
|
if shutil.which("docker") is None:
|
||||||
|
raise AcceptanceError("Docker CLI is required to start the isolated Redis broker")
|
||||||
|
if not compose_file.is_file():
|
||||||
|
raise AcceptanceError("Redis Compose definition is unavailable")
|
||||||
|
port = requested_port or _unused_loopback_port()
|
||||||
|
if port <= 0 or port > 65_535:
|
||||||
|
raise AcceptanceError("Redis test port is invalid")
|
||||||
|
project_name = f"govoplan-campaign-redelivery-{uuid4().hex[:12]}"
|
||||||
|
environment = {
|
||||||
|
**os.environ,
|
||||||
|
"GOVOPLAN_CAMPAIGN_TEST_REDIS_PORT": str(port),
|
||||||
|
}
|
||||||
|
lifecycle_attempted = False
|
||||||
|
try:
|
||||||
|
lifecycle_attempted = True
|
||||||
|
_run_compose(
|
||||||
|
_compose_command(
|
||||||
|
compose_file=compose_file,
|
||||||
|
project_name=project_name,
|
||||||
|
operation="up",
|
||||||
|
),
|
||||||
|
environment=environment,
|
||||||
|
timeout_seconds=timeout_seconds,
|
||||||
|
)
|
||||||
|
redis_url = f"redis://127.0.0.1:{port}/0"
|
||||||
|
_wait_for_redis(redis_url, timeout_seconds=timeout_seconds)
|
||||||
|
yield redis_url
|
||||||
|
finally:
|
||||||
|
if lifecycle_attempted:
|
||||||
|
_run_compose(
|
||||||
|
_compose_command(
|
||||||
|
compose_file=compose_file,
|
||||||
|
project_name=project_name,
|
||||||
|
operation="down",
|
||||||
|
),
|
||||||
|
environment=environment,
|
||||||
|
timeout_seconds=timeout_seconds,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _start_worker(runtime_root: Path, *, label: str) -> WorkerProcess:
|
||||||
|
log_path = runtime_root / f"{label}.log"
|
||||||
|
log_handle = log_path.open("wb")
|
||||||
|
environment = {**os.environ, "PYTHONUNBUFFERED": "1"}
|
||||||
|
try:
|
||||||
|
process = subprocess.Popen(
|
||||||
|
[sys.executable, "-c", WORKER_BOOTSTRAP, label],
|
||||||
|
env=environment,
|
||||||
|
stdin=subprocess.DEVNULL,
|
||||||
|
stdout=log_handle,
|
||||||
|
stderr=subprocess.STDOUT,
|
||||||
|
close_fds=True,
|
||||||
|
)
|
||||||
|
except Exception:
|
||||||
|
log_handle.close()
|
||||||
|
raise
|
||||||
|
return WorkerProcess(process=process, log_path=log_path, log_handle=log_handle)
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_worker_ready(worker: WorkerProcess, *, timeout_seconds: int) -> None:
|
||||||
|
deadline = time.monotonic() + timeout_seconds
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
if worker.process.poll() is not None:
|
||||||
|
raise AcceptanceError("Celery worker exited before becoming ready")
|
||||||
|
if " ready." in worker.text():
|
||||||
|
return
|
||||||
|
time.sleep(0.2)
|
||||||
|
raise AcceptanceError("Celery worker did not become ready")
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_received_task(
|
||||||
|
worker: WorkerProcess,
|
||||||
|
*,
|
||||||
|
timeout_seconds: int,
|
||||||
|
expected_task_id: str | None = None,
|
||||||
|
) -> str:
|
||||||
|
deadline = time.monotonic() + timeout_seconds
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
received = worker.received_task_ids()
|
||||||
|
if received:
|
||||||
|
if len(set(received)) != 1:
|
||||||
|
raise AcceptanceError("Celery worker received more than one task identity")
|
||||||
|
task_id = received[0]
|
||||||
|
if expected_task_id is not None and task_id != expected_task_id:
|
||||||
|
raise AcceptanceError("Replacement worker received a different broker task")
|
||||||
|
return task_id
|
||||||
|
if worker.process.poll() is not None:
|
||||||
|
raise AcceptanceError("Celery worker exited before receiving the task")
|
||||||
|
time.sleep(0.2)
|
||||||
|
raise AcceptanceError("Celery worker did not receive the broker task")
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_task_success(
|
||||||
|
worker: WorkerProcess,
|
||||||
|
*,
|
||||||
|
task_id: str,
|
||||||
|
timeout_seconds: int,
|
||||||
|
) -> None:
|
||||||
|
deadline = time.monotonic() + timeout_seconds
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
succeeded = worker.succeeded_task_ids()
|
||||||
|
if task_id in succeeded:
|
||||||
|
return
|
||||||
|
if worker.process.poll() is not None:
|
||||||
|
raise AcceptanceError("Replacement Celery worker exited before task success")
|
||||||
|
time.sleep(0.2)
|
||||||
|
raise AcceptanceError("Redelivered Celery task did not complete")
|
||||||
|
|
||||||
|
|
||||||
|
def _kill_worker(worker: WorkerProcess, *, timeout_seconds: int) -> int:
|
||||||
|
if worker.process.poll() is not None:
|
||||||
|
raise AcceptanceError("Celery worker exited before controlled termination")
|
||||||
|
worker.process.kill()
|
||||||
|
try:
|
||||||
|
return_code = worker.process.wait(timeout=timeout_seconds)
|
||||||
|
except subprocess.TimeoutExpired as exc:
|
||||||
|
raise AcceptanceError("Celery worker could not be killed") from exc
|
||||||
|
if return_code == 0:
|
||||||
|
raise AcceptanceError("Celery worker termination was not forced")
|
||||||
|
return return_code
|
||||||
|
|
||||||
|
|
||||||
|
def _stop_worker(worker: WorkerProcess, *, timeout_seconds: int) -> None:
|
||||||
|
if worker.process.poll() is None:
|
||||||
|
worker.process.terminate()
|
||||||
|
try:
|
||||||
|
worker.process.wait(timeout=timeout_seconds)
|
||||||
|
except subprocess.TimeoutExpired:
|
||||||
|
worker.process.kill()
|
||||||
|
worker.process.wait(timeout=timeout_seconds)
|
||||||
|
worker.log_handle.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _broker_state(redis_url: str) -> RedisBrokerState:
|
||||||
|
client = Redis.from_url(
|
||||||
|
redis_url,
|
||||||
|
socket_connect_timeout=2,
|
||||||
|
socket_timeout=2,
|
||||||
|
decode_responses=False,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
return RedisBrokerState(
|
||||||
|
queue_depth=int(client.llen("send_email")),
|
||||||
|
unacked_hash_count=int(client.hlen("unacked")),
|
||||||
|
unacked_index_count=int(client.zcard("unacked_index")),
|
||||||
|
)
|
||||||
|
except RedisError as exc:
|
||||||
|
raise AcceptanceError("Redis broker state could not be inspected") from exc
|
||||||
|
finally:
|
||||||
|
client.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_broker_drained(
|
||||||
|
redis_url: str,
|
||||||
|
*,
|
||||||
|
timeout_seconds: int,
|
||||||
|
) -> RedisBrokerState:
|
||||||
|
deadline = time.monotonic() + timeout_seconds
|
||||||
|
last = RedisBrokerState(0, 0, 0)
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
last = _broker_state(redis_url)
|
||||||
|
if last == RedisBrokerState(0, 0, 0):
|
||||||
|
return last
|
||||||
|
time.sleep(0.2)
|
||||||
|
raise AcceptanceError("Redis broker retained delivery state after recovery")
|
||||||
|
|
||||||
|
|
||||||
|
def _queue_evidence(payload: Mapping[str, Any]) -> dict[str, Any]:
|
||||||
|
expected = {
|
||||||
|
"queued_count": 1,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"blocked_count": 0,
|
||||||
|
"enqueued_count": 1,
|
||||||
|
"delivery_mode": "worker_queue",
|
||||||
|
"worker_queue_available": True,
|
||||||
|
"dry_run": False,
|
||||||
|
}
|
||||||
|
evidence = {key: payload.get(key) for key in expected}
|
||||||
|
if evidence != expected:
|
||||||
|
raise AcceptanceError("Campaign was not durably queued to one Celery task")
|
||||||
|
return evidence
|
||||||
|
|
||||||
|
|
||||||
|
def execute_redelivery_scenario(
|
||||||
|
client: Any,
|
||||||
|
headers: Mapping[str, str],
|
||||||
|
*,
|
||||||
|
fixture_path: Path,
|
||||||
|
settings: TestbedSettings,
|
||||||
|
endpoint: Any,
|
||||||
|
redis_url: str,
|
||||||
|
runtime_root: Path,
|
||||||
|
snapshot_probe: Callable[[str], tuple[Mapping[str, Any], Mapping[str, Any]]],
|
||||||
|
audit_probe: Callable[[str, str], Mapping[str, int]],
|
||||||
|
delivery_probe: Callable[[str, str], Mapping[str, Any]],
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
profile_id = create_mail_profile(
|
||||||
|
client,
|
||||||
|
headers,
|
||||||
|
settings,
|
||||||
|
name="Campaign Redis Celery redelivery drill",
|
||||||
|
smtp_host=endpoint.host,
|
||||||
|
smtp_port=endpoint.port,
|
||||||
|
)
|
||||||
|
prepared = prepare_campaign_scenario(
|
||||||
|
client,
|
||||||
|
headers,
|
||||||
|
fixture_path=fixture_path,
|
||||||
|
profile_id=profile_id,
|
||||||
|
settings=settings,
|
||||||
|
scenario="celery_broker_redelivery",
|
||||||
|
snapshot_probe=snapshot_probe,
|
||||||
|
)
|
||||||
|
|
||||||
|
first_worker = _start_worker(runtime_root, label="first-worker")
|
||||||
|
replacement_worker: WorkerProcess | None = None
|
||||||
|
try:
|
||||||
|
_wait_for_worker_ready(
|
||||||
|
first_worker,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
queued = _expect(
|
||||||
|
client.post(
|
||||||
|
f"/api/v1/campaigns/{prepared.campaign_id}/queue",
|
||||||
|
headers=dict(headers),
|
||||||
|
json={
|
||||||
|
"version_id": prepared.version_id,
|
||||||
|
"include_warnings": True,
|
||||||
|
"enqueue_celery": True,
|
||||||
|
"dry_run": False,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
200,
|
||||||
|
"Celery-redelivery Campaign queue",
|
||||||
|
)
|
||||||
|
queue_evidence = _queue_evidence(queued)
|
||||||
|
first_task_id = _wait_for_received_task(
|
||||||
|
first_worker,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
if not endpoint.wait_for_data(settings.provider_timeout_seconds):
|
||||||
|
raise AcceptanceError("Celery worker did not reach complete SMTP DATA")
|
||||||
|
first_exit_code = _kill_worker(
|
||||||
|
first_worker,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
endpoint.release_held_connection()
|
||||||
|
|
||||||
|
interrupted_state = _durable_state_evidence(
|
||||||
|
delivery_probe(prepared.campaign_id, prepared.version_id)
|
||||||
|
)
|
||||||
|
expected_interrupted = {
|
||||||
|
"job_count": 1,
|
||||||
|
"send_status_counts": {"sending": 1},
|
||||||
|
"attempt_status_counts": {"smtp_in_progress": 1},
|
||||||
|
"unfinished_attempt_count": 1,
|
||||||
|
}
|
||||||
|
if interrupted_state != expected_interrupted:
|
||||||
|
raise AcceptanceError("Killed worker state was not durably SMTP-in-progress")
|
||||||
|
|
||||||
|
replacement_worker = _start_worker(runtime_root, label="replacement-worker")
|
||||||
|
_wait_for_worker_ready(
|
||||||
|
replacement_worker,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
redelivered_task_id = _wait_for_received_task(
|
||||||
|
replacement_worker,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
expected_task_id=first_task_id,
|
||||||
|
)
|
||||||
|
_wait_for_task_success(
|
||||||
|
replacement_worker,
|
||||||
|
task_id=redelivered_task_id,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
recovered_state = _durable_state_evidence(
|
||||||
|
delivery_probe(prepared.campaign_id, prepared.version_id)
|
||||||
|
)
|
||||||
|
expected_recovered = {
|
||||||
|
"job_count": 1,
|
||||||
|
"send_status_counts": {"outcome_unknown": 1},
|
||||||
|
"attempt_status_counts": {"outcome_unknown": 1},
|
||||||
|
"unfinished_attempt_count": 0,
|
||||||
|
}
|
||||||
|
if recovered_state != expected_recovered:
|
||||||
|
raise AcceptanceError("Redelivered task did not freeze the unfinished attempt")
|
||||||
|
|
||||||
|
protocol = endpoint.evidence()
|
||||||
|
expected_protocol = {
|
||||||
|
"connection_count": 1,
|
||||||
|
"accepted_rcpt_commands": 1,
|
||||||
|
"refused_rcpt_commands": 0,
|
||||||
|
"data_transactions": 1,
|
||||||
|
}
|
||||||
|
if protocol != expected_protocol:
|
||||||
|
raise AcceptanceError("Broker redelivery caused an unexpected SMTP transaction")
|
||||||
|
broker_after = _wait_for_broker_drained(
|
||||||
|
redis_url,
|
||||||
|
timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
first_received = first_worker.received_task_ids()
|
||||||
|
replacement_received = replacement_worker.received_task_ids()
|
||||||
|
if first_received != (first_task_id,) or replacement_received != (
|
||||||
|
redelivered_task_id,
|
||||||
|
):
|
||||||
|
raise AcceptanceError(
|
||||||
|
"Celery workers did not each receive the broker task exactly once"
|
||||||
|
)
|
||||||
|
report = _report_evidence(
|
||||||
|
_expect(
|
||||||
|
client.get(
|
||||||
|
f"/api/v1/campaigns/{prepared.campaign_id}/report",
|
||||||
|
headers=dict(headers),
|
||||||
|
params={"version_id": prepared.version_id},
|
||||||
|
),
|
||||||
|
200,
|
||||||
|
"Celery-redelivery Campaign report",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if report["send_status_counts"] != {"outcome_unknown": 1}:
|
||||||
|
raise AcceptanceError("Campaign report did not retain outcome_unknown")
|
||||||
|
audit_actions = dict(
|
||||||
|
sorted(audit_probe(prepared.campaign_id, prepared.version_id).items())
|
||||||
|
)
|
||||||
|
if not {
|
||||||
|
"campaign.created",
|
||||||
|
"campaign.validated",
|
||||||
|
"campaign.messages_built",
|
||||||
|
"campaign.queued",
|
||||||
|
}.issubset(audit_actions):
|
||||||
|
raise AcceptanceError("Celery-redelivery Campaign audit evidence is incomplete")
|
||||||
|
|
||||||
|
return {
|
||||||
|
**prepared.public_evidence(),
|
||||||
|
"queue": queue_evidence,
|
||||||
|
"interrupted_durable_state": interrupted_state,
|
||||||
|
"recovered_durable_state": recovered_state,
|
||||||
|
"protocol": protocol,
|
||||||
|
"report": report,
|
||||||
|
"audit_actions": audit_actions,
|
||||||
|
"broker": {
|
||||||
|
"transport": "redis",
|
||||||
|
"same_task_identity_redelivered": first_task_id
|
||||||
|
== redelivered_task_id,
|
||||||
|
"first_worker_received_count": len(first_received),
|
||||||
|
"replacement_worker_received_count": len(replacement_received),
|
||||||
|
**broker_after.as_dict(),
|
||||||
|
},
|
||||||
|
"supervision": {
|
||||||
|
"first_worker_killed_after_complete_data": True,
|
||||||
|
"first_worker_forced_exit": first_exit_code != 0,
|
||||||
|
"replacement_worker_started": True,
|
||||||
|
"replacement_worker_completed_redelivery": True,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
finally:
|
||||||
|
endpoint.release_held_connection()
|
||||||
|
_stop_worker(first_worker, timeout_seconds=5)
|
||||||
|
if replacement_worker is not None:
|
||||||
|
_stop_worker(replacement_worker, timeout_seconds=5)
|
||||||
|
|
||||||
|
|
||||||
|
def _runtime_module_versions(registry: Any) -> dict[str, str]:
|
||||||
|
versions = {"core": _core_package_version()}
|
||||||
|
versions.update(
|
||||||
|
{
|
||||||
|
manifest.id: manifest.version
|
||||||
|
for manifest in registry.manifests()
|
||||||
|
if manifest.id in {"access", "audit", "campaigns", "mail"}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return versions
|
||||||
|
|
||||||
|
|
||||||
|
def _create_runtime_root() -> Path:
|
||||||
|
"""Create the isolated runtime under the platform-selected temp root."""
|
||||||
|
|
||||||
|
return Path(tempfile.mkdtemp(prefix="govoplan-campaign-celery-redelivery-"))
|
||||||
|
|
||||||
|
|
||||||
|
def _bootstrap_and_run(
|
||||||
|
*,
|
||||||
|
settings: TestbedSettings,
|
||||||
|
fixture_path: Path,
|
||||||
|
redis_url: str,
|
||||||
|
visibility_timeout_seconds: int,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
runtime_root = _create_runtime_root()
|
||||||
|
database = None
|
||||||
|
try:
|
||||||
|
os.environ.update(
|
||||||
|
{
|
||||||
|
"APP_ENV": "test",
|
||||||
|
"DATABASE_URL": f"sqlite:///{runtime_root / 'acceptance.db'}",
|
||||||
|
"FILE_STORAGE_BACKEND": "local",
|
||||||
|
"FILE_STORAGE_LOCAL_ROOT": str(runtime_root / "files"),
|
||||||
|
"MOCK_MAILBOX_DIR": str(runtime_root / "mock-mailbox"),
|
||||||
|
"DEV_BOOTSTRAP_ENABLED": "false",
|
||||||
|
"CELERY_ENABLED": "true",
|
||||||
|
"REDIS_URL": redis_url,
|
||||||
|
"GOVOPLAN_CAMPAIGN_TEST_REDIS_VISIBILITY_TIMEOUT_SECONDS": str(
|
||||||
|
visibility_timeout_seconds
|
||||||
|
),
|
||||||
|
"GOVOPLAN_CONNECTOR_ALLOW_PRIVATE_NETWORKS": "true",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
from fastapi.testclient import TestClient
|
||||||
|
|
||||||
|
from govoplan_core.db.base import Base
|
||||||
|
from govoplan_core.db.bootstrap import bootstrap_dev_data
|
||||||
|
from govoplan_core.db.session import configure_database, set_database
|
||||||
|
from govoplan_core.settings import Settings, settings as core_settings
|
||||||
|
from govoplan_core.tenancy.scope import create_scope_tables
|
||||||
|
|
||||||
|
isolated_settings = Settings()
|
||||||
|
for field_name in Settings.model_fields:
|
||||||
|
setattr(core_settings, field_name, getattr(isolated_settings, field_name))
|
||||||
|
database = configure_database(os.environ["DATABASE_URL"])
|
||||||
|
set_database(database)
|
||||||
|
|
||||||
|
from govoplan_core.server.app import app
|
||||||
|
|
||||||
|
create_scope_tables(database.engine)
|
||||||
|
Base.metadata.create_all(bind=database.engine)
|
||||||
|
with database.SessionLocal() as session:
|
||||||
|
bootstrap_dev_data(
|
||||||
|
session,
|
||||||
|
api_key_secret="celery-redelivery-unused-api-key",
|
||||||
|
user_password="celery-redelivery-admin",
|
||||||
|
)
|
||||||
|
|
||||||
|
def snapshot_probe(
|
||||||
|
version_id: str,
|
||||||
|
) -> tuple[Mapping[str, Any], Mapping[str, Any]]:
|
||||||
|
from govoplan_campaign.backend.db.models import CampaignVersion
|
||||||
|
|
||||||
|
with database.SessionLocal() as session:
|
||||||
|
version = session.get(CampaignVersion, version_id)
|
||||||
|
if version is None:
|
||||||
|
raise AcceptanceError("Campaign execution snapshot is unavailable")
|
||||||
|
raw = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
snapshot = (
|
||||||
|
version.execution_snapshot
|
||||||
|
if isinstance(version.execution_snapshot, dict)
|
||||||
|
else {}
|
||||||
|
)
|
||||||
|
return raw, snapshot
|
||||||
|
|
||||||
|
def audit_probe(campaign_id: str, version_id: str) -> Mapping[str, int]:
|
||||||
|
from govoplan_audit.backend.db.models import AuditLog
|
||||||
|
|
||||||
|
with database.SessionLocal() as session:
|
||||||
|
actions = [
|
||||||
|
row[0]
|
||||||
|
for row in session.query(AuditLog.action)
|
||||||
|
.filter(AuditLog.object_id.in_([campaign_id, version_id]))
|
||||||
|
.all()
|
||||||
|
if row[0] in EXPECTED_AUDIT_ACTIONS
|
||||||
|
]
|
||||||
|
return dict(Counter(actions))
|
||||||
|
|
||||||
|
def delivery_probe(campaign_id: str, version_id: str) -> Mapping[str, Any]:
|
||||||
|
from govoplan_campaign.backend.db.models import CampaignJob, SendAttempt
|
||||||
|
|
||||||
|
with database.SessionLocal() as session:
|
||||||
|
jobs = (
|
||||||
|
session.query(CampaignJob)
|
||||||
|
.filter(
|
||||||
|
CampaignJob.campaign_id == campaign_id,
|
||||||
|
CampaignJob.campaign_version_id == version_id,
|
||||||
|
)
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
job_ids = [job.id for job in jobs]
|
||||||
|
attempts = (
|
||||||
|
session.query(SendAttempt)
|
||||||
|
.filter(SendAttempt.job_id.in_(job_ids))
|
||||||
|
.all()
|
||||||
|
if job_ids
|
||||||
|
else []
|
||||||
|
)
|
||||||
|
return {
|
||||||
|
"job_count": len(jobs),
|
||||||
|
"send_status_counts": dict(
|
||||||
|
Counter(job.send_status for job in jobs)
|
||||||
|
),
|
||||||
|
"attempt_status_counts": dict(
|
||||||
|
Counter(attempt.status for attempt in attempts)
|
||||||
|
),
|
||||||
|
"unfinished_attempt_count": sum(
|
||||||
|
1 for attempt in attempts if attempt.finished_at is None
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
with TestClient(app) as client:
|
||||||
|
login = _expect(
|
||||||
|
client.post(
|
||||||
|
"/api/v1/auth/login",
|
||||||
|
json={
|
||||||
|
"email": "admin@example.local",
|
||||||
|
"password": "celery-redelivery-admin",
|
||||||
|
},
|
||||||
|
),
|
||||||
|
200,
|
||||||
|
"Acceptance login",
|
||||||
|
)
|
||||||
|
access_token = str(login.get("access_token") or "")
|
||||||
|
if not access_token:
|
||||||
|
raise AcceptanceError("Acceptance login returned no access token")
|
||||||
|
from govoplan_core.core.runtime import get_registry
|
||||||
|
|
||||||
|
registry = get_registry()
|
||||||
|
if registry is None:
|
||||||
|
raise AcceptanceError("The GovOPlaN module registry is unavailable")
|
||||||
|
composition_versions = required_composition_versions(
|
||||||
|
fixture_path,
|
||||||
|
_runtime_module_versions(registry),
|
||||||
|
)
|
||||||
|
with smtp_fault_endpoint("post_data_hold") as endpoint:
|
||||||
|
scenario = execute_redelivery_scenario(
|
||||||
|
client,
|
||||||
|
{"Authorization": f"Bearer {access_token}"},
|
||||||
|
fixture_path=fixture_path,
|
||||||
|
settings=settings,
|
||||||
|
endpoint=endpoint,
|
||||||
|
redis_url=redis_url,
|
||||||
|
runtime_root=runtime_root,
|
||||||
|
snapshot_probe=snapshot_probe,
|
||||||
|
audit_probe=audit_probe,
|
||||||
|
delivery_probe=delivery_probe,
|
||||||
|
)
|
||||||
|
|
||||||
|
evidence = {
|
||||||
|
"schema_version": EVIDENCE_SCHEMA,
|
||||||
|
"generated_at": datetime.now(timezone.utc).isoformat(),
|
||||||
|
"fixture_sha256": hashlib.sha256(fixture_path.read_bytes()).hexdigest(),
|
||||||
|
"declared_module_versions": composition_versions,
|
||||||
|
"target": {
|
||||||
|
"kind": "local_redis_celery_controlled_smtp",
|
||||||
|
"isolated_temporary_database": True,
|
||||||
|
"redis_started_by_runner": True,
|
||||||
|
"worker_pool": "solo",
|
||||||
|
"worker_prefetch_multiplier": 1,
|
||||||
|
"task_acks_late": True,
|
||||||
|
"task_reject_on_worker_lost": True,
|
||||||
|
"visibility_timeout_seconds": visibility_timeout_seconds,
|
||||||
|
},
|
||||||
|
"scenario": scenario,
|
||||||
|
"coverage": {
|
||||||
|
"redis_broker_delivery": True,
|
||||||
|
"celery_worker_processes": True,
|
||||||
|
"forced_worker_loss_after_complete_data": True,
|
||||||
|
"same_task_broker_redelivery": True,
|
||||||
|
"durable_outcome_unknown_recovery": True,
|
||||||
|
"duplicate_smtp_transaction_prevented": True,
|
||||||
|
"production_daemon_supervisor": False,
|
||||||
|
"target_provider": False,
|
||||||
|
"source_artifact_provenance": False,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
_assert_evidence_safe(evidence, settings=settings)
|
||||||
|
rendered = json.dumps(
|
||||||
|
evidence,
|
||||||
|
ensure_ascii=False,
|
||||||
|
indent=2,
|
||||||
|
sort_keys=True,
|
||||||
|
).encode("utf-8") + b"\n"
|
||||||
|
if len(rendered) > MAX_EVIDENCE_BYTES:
|
||||||
|
raise AcceptanceError("Celery-redelivery evidence exceeds its size limit")
|
||||||
|
return evidence
|
||||||
|
finally:
|
||||||
|
if database is not None:
|
||||||
|
database.engine.dispose()
|
||||||
|
shutil.rmtree(runtime_root, ignore_errors=True)
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str] | None = None) -> int:
|
||||||
|
parser = argparse.ArgumentParser(description=__doc__)
|
||||||
|
parser.add_argument("--fixture", type=Path, default=DEFAULT_FIXTURE)
|
||||||
|
parser.add_argument("--compose-file", type=Path, default=DEFAULT_COMPOSE_FILE)
|
||||||
|
parser.add_argument("--redis-port", type=int)
|
||||||
|
parser.add_argument(
|
||||||
|
"--visibility-timeout-seconds",
|
||||||
|
type=lambda value: _positive_int(value, label="visibility timeout"),
|
||||||
|
default=os.environ.get(
|
||||||
|
"GOVOPLAN_CAMPAIGN_TEST_REDIS_VISIBILITY_TIMEOUT_SECONDS",
|
||||||
|
"3",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--timeout-seconds",
|
||||||
|
type=lambda value: _positive_int(value, label="timeout"),
|
||||||
|
default=60,
|
||||||
|
)
|
||||||
|
parser.add_argument("--evidence", type=Path)
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
try:
|
||||||
|
settings = TestbedSettings.from_environment()
|
||||||
|
settings.assert_local_testbed()
|
||||||
|
settings = replace(
|
||||||
|
settings,
|
||||||
|
provider_timeout_seconds=args.timeout_seconds,
|
||||||
|
)
|
||||||
|
with isolated_redis_broker(
|
||||||
|
compose_file=args.compose_file.resolve(),
|
||||||
|
timeout_seconds=args.timeout_seconds,
|
||||||
|
requested_port=args.redis_port,
|
||||||
|
) as redis_url:
|
||||||
|
evidence = _bootstrap_and_run(
|
||||||
|
settings=settings,
|
||||||
|
fixture_path=args.fixture.resolve(),
|
||||||
|
redis_url=redis_url,
|
||||||
|
visibility_timeout_seconds=args.visibility_timeout_seconds,
|
||||||
|
)
|
||||||
|
rendered = json.dumps(
|
||||||
|
evidence,
|
||||||
|
ensure_ascii=False,
|
||||||
|
indent=2,
|
||||||
|
sort_keys=True,
|
||||||
|
) + "\n"
|
||||||
|
if args.evidence:
|
||||||
|
args.evidence.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
args.evidence.write_text(rendered, encoding="utf-8")
|
||||||
|
else:
|
||||||
|
sys.stdout.write(rendered)
|
||||||
|
return 0
|
||||||
|
except AcceptanceError as exc:
|
||||||
|
print(f"Campaign Celery-redelivery acceptance failed: {exc}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
except Exception as exc:
|
||||||
|
print(
|
||||||
|
"Campaign Celery-redelivery acceptance failed unexpectedly "
|
||||||
|
f"({type(exc).__name__}); inspect local service logs.",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
167
dev/mail-testbed/run_transport_smoke.py
Normal file
167
dev/mail-testbed/run_transport_smoke.py
Normal file
@@ -0,0 +1,167 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import imaplib
|
||||||
|
import mimetypes
|
||||||
|
import os
|
||||||
|
import tempfile
|
||||||
|
import time
|
||||||
|
from email.message import EmailMessage
|
||||||
|
from email.utils import formatdate, make_msgid
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from govoplan_mail.backend.config import ImapConfig, SmtpConfig, TransportSecurity
|
||||||
|
from govoplan_mail.backend.sending.imap import append_message_to_sent, list_imap_folders, list_imap_messages, test_imap_login
|
||||||
|
from govoplan_mail.backend.sending.smtp import send_email_message, test_smtp_login
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.services.zip_service import create_zip_archive
|
||||||
|
|
||||||
|
|
||||||
|
def _env(name: str, default: str) -> str:
|
||||||
|
return os.environ.get(name, default).strip() or default
|
||||||
|
|
||||||
|
|
||||||
|
SMTP_HOST = _env("GOVOPLAN_MAIL_TEST_SMTP_HOST", "127.0.0.1")
|
||||||
|
IMAP_HOST = _env("GOVOPLAN_MAIL_TEST_IMAP_HOST", "127.0.0.1")
|
||||||
|
SMTP_PORT = int(_env("GOVOPLAN_MAIL_TEST_SMTP_PORT", "3025"))
|
||||||
|
IMAP_PORT = int(_env("GOVOPLAN_MAIL_TEST_IMAP_PORT", "3143"))
|
||||||
|
USERNAME = _env("GOVOPLAN_MAIL_TEST_USER", "campaign-test@govoplan.test")
|
||||||
|
PASSWORD = _env("GOVOPLAN_MAIL_TEST_PASSWORD", "campaign-test-password")
|
||||||
|
SENDER = _env("GOVOPLAN_MAIL_TEST_FROM", USERNAME)
|
||||||
|
RECIPIENT = _env("GOVOPLAN_MAIL_TEST_RECIPIENT", USERNAME)
|
||||||
|
SENT_FOLDER = _env("GOVOPLAN_MAIL_TEST_SENT_FOLDER", "Sent")
|
||||||
|
ZIP_PASSWORD = _env("GOVOPLAN_MAIL_TEST_ZIP_PASSWORD", "zip-test-password")
|
||||||
|
SERVICE_READY_TIMEOUT_SECONDS = int(_env("GOVOPLAN_MAIL_TEST_READY_TIMEOUT_SECONDS", "45"))
|
||||||
|
|
||||||
|
|
||||||
|
def _smtp_config() -> SmtpConfig:
|
||||||
|
return SmtpConfig(
|
||||||
|
host=SMTP_HOST,
|
||||||
|
port=SMTP_PORT,
|
||||||
|
security=TransportSecurity.PLAIN,
|
||||||
|
username=USERNAME,
|
||||||
|
password=PASSWORD,
|
||||||
|
timeout_seconds=10,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _imap_config() -> ImapConfig:
|
||||||
|
return ImapConfig(
|
||||||
|
host=IMAP_HOST,
|
||||||
|
port=IMAP_PORT,
|
||||||
|
security=TransportSecurity.PLAIN,
|
||||||
|
username=USERNAME,
|
||||||
|
password=PASSWORD,
|
||||||
|
sent_folder=SENT_FOLDER,
|
||||||
|
timeout_seconds=10,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _message(subject: str, body: str, attachments: list[Path] | None = None) -> EmailMessage:
|
||||||
|
msg = EmailMessage()
|
||||||
|
msg["From"] = SENDER
|
||||||
|
msg["To"] = RECIPIENT
|
||||||
|
msg["Subject"] = subject
|
||||||
|
msg["Date"] = formatdate(localtime=False)
|
||||||
|
msg["Message-ID"] = make_msgid(domain="govoplan.test")
|
||||||
|
msg.set_content(body)
|
||||||
|
|
||||||
|
for attachment in attachments or []:
|
||||||
|
content_type = mimetypes.guess_type(attachment.name)[0] or "application/octet-stream"
|
||||||
|
maintype, subtype = content_type.split("/", 1)
|
||||||
|
msg.add_attachment(attachment.read_bytes(), maintype=maintype, subtype=subtype, filename=attachment.name)
|
||||||
|
return msg
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_folder(config: ImapConfig, folder: str) -> None:
|
||||||
|
client = imaplib.IMAP4(host=config.host or "", port=config.port or 143, timeout=config.timeout_seconds)
|
||||||
|
try:
|
||||||
|
if config.username and config.password:
|
||||||
|
client.login(config.username, config.password)
|
||||||
|
typ, data = client.create(folder)
|
||||||
|
if typ not in {"OK", "NO"}:
|
||||||
|
raise RuntimeError(f"Could not create IMAP folder {folder!r}: {data!r}")
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
client.logout()
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_delivery(config: ImapConfig, *, before_count: int, expected_increment: int) -> None:
|
||||||
|
deadline = time.monotonic() + 15
|
||||||
|
last_count = before_count
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
result = list_imap_messages(imap_config=config, folder="INBOX", limit=10)
|
||||||
|
last_count = result.total_count
|
||||||
|
if last_count >= before_count + expected_increment:
|
||||||
|
return
|
||||||
|
time.sleep(0.5)
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Expected at least {expected_increment} new INBOX message(s), "
|
||||||
|
f"but count moved from {before_count} to {last_count}."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for_service(label: str, check):
|
||||||
|
deadline = time.monotonic() + SERVICE_READY_TIMEOUT_SECONDS
|
||||||
|
last_error: Exception | None = None
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
try:
|
||||||
|
return check()
|
||||||
|
except Exception as exc: # GreenMail can bind before SMTP/IMAP is ready.
|
||||||
|
last_error = exc
|
||||||
|
time.sleep(1)
|
||||||
|
raise RuntimeError(f"{label} did not become ready within {SERVICE_READY_TIMEOUT_SECONDS}s: {last_error}") from last_error
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
smtp = _smtp_config()
|
||||||
|
imap = _imap_config()
|
||||||
|
|
||||||
|
smtp_login = _wait_for_service("SMTP", lambda: test_smtp_login(smtp_config=smtp))
|
||||||
|
imap_login = _wait_for_service("IMAP", lambda: test_imap_login(imap_config=imap))
|
||||||
|
print(f"SMTP login OK: {smtp_login.host}:{smtp_login.port} authenticated={smtp_login.authenticated}")
|
||||||
|
print(f"IMAP login OK: {imap_login.host}:{imap_login.port} authenticated={imap_login.authenticated}")
|
||||||
|
|
||||||
|
_wait_for_service("IMAP folder creation", lambda: _ensure_folder(imap, SENT_FOLDER))
|
||||||
|
folders = _wait_for_service("IMAP folder listing", lambda: list_imap_folders(imap_config=imap))
|
||||||
|
print("IMAP folders: " + ", ".join(folder.name for folder in folders.folders))
|
||||||
|
|
||||||
|
before_inbox = list_imap_messages(imap_config=imap, folder="INBOX", limit=10).total_count
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory(prefix="govoplan-campaign-mail-test-") as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
attachment = root / "single-attachment.txt"
|
||||||
|
attachment.write_text("GovOPlaN single attachment smoke test\n", encoding="utf-8")
|
||||||
|
zip_source = root / "zip-source.txt"
|
||||||
|
zip_source.write_text("GovOPlaN password-protected ZIP smoke test\n", encoding="utf-8")
|
||||||
|
zip_path = create_zip_archive(root / "password-protected.zip", [zip_source], ZIP_PASSWORD)
|
||||||
|
|
||||||
|
messages = [
|
||||||
|
_message("[GovOPlaN test] no attachment", "No attachment SMTP/IMAP smoke."),
|
||||||
|
_message("[GovOPlaN test] one attachment", "One attachment SMTP/IMAP smoke.", [attachment]),
|
||||||
|
_message("[GovOPlaN test] password ZIP", "Password-protected ZIP SMTP/IMAP smoke.", [zip_path]),
|
||||||
|
]
|
||||||
|
|
||||||
|
for message in messages:
|
||||||
|
result = send_email_message(
|
||||||
|
message,
|
||||||
|
smtp_config=smtp,
|
||||||
|
envelope_from=SENDER,
|
||||||
|
envelope_recipients=[RECIPIENT],
|
||||||
|
)
|
||||||
|
print(f"SMTP accepted {result.accepted_count} recipient(s): {message['Subject']}")
|
||||||
|
append = append_message_to_sent(bytes(message), imap_config=imap, folder=SENT_FOLDER)
|
||||||
|
print(f"IMAP appended {append.bytes_appended} byte(s) to {append.folder}: {message['Subject']}")
|
||||||
|
|
||||||
|
_wait_for_delivery(imap, before_count=before_inbox, expected_increment=3)
|
||||||
|
sent_count = list_imap_messages(imap_config=imap, folder=SENT_FOLDER, limit=10).total_count
|
||||||
|
if sent_count < 3:
|
||||||
|
raise RuntimeError(f"Expected at least 3 messages in {SENT_FOLDER!r}, found {sent_count}.")
|
||||||
|
print("Transport smoke OK: no attachment, one attachment, and password-protected ZIP messages verified.")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
148
docs/CAMPAIGN_DELIVERY_RUNBOOK.md
Normal file
148
docs/CAMPAIGN_DELIVERY_RUNBOOK.md
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
# Campaign Delivery Runbook
|
||||||
|
|
||||||
|
This runbook covers controlled campaign delivery after a campaign version has
|
||||||
|
been validated, built, reviewed, and locked.
|
||||||
|
|
||||||
|
## Operating Modes
|
||||||
|
|
||||||
|
- Local direct send: `CELERY_ENABLED=false`. **Send now** is available only for
|
||||||
|
exact built runs within the effective synchronous limit. It preflights the
|
||||||
|
complete batch before the first SMTP effect.
|
||||||
|
- Worker send: `CELERY_ENABLED=true` with Redis/Celery workers running. Queueing
|
||||||
|
publishes durable delivery tasks, and Review and send polls their persisted
|
||||||
|
summary counters even after the initiating request has returned.
|
||||||
|
- Mock send: use only for development review. It does not prove real SMTP/IMAP
|
||||||
|
credentials or server policy.
|
||||||
|
|
||||||
|
## Before First Live Use
|
||||||
|
|
||||||
|
- Use dedicated non-production SMTP/IMAP credentials.
|
||||||
|
- Store and test those credentials in a Mail-module profile. Campaign must
|
||||||
|
contain only the selected `server.mail_profile_id` reference.
|
||||||
|
- Start the repository test bed in `dev/mail-testbed/` when a local
|
||||||
|
production-like SMTP/IMAP server is sufficient.
|
||||||
|
- Use a dedicated mailbox/folder for append-to-Sent tests.
|
||||||
|
- Confirm policy allows the SMTP host, envelope sender, recipients, and optional
|
||||||
|
IMAP append target.
|
||||||
|
- Run one campaign each for no attachment, one attachment, and password-protected
|
||||||
|
ZIP before using production recipients.
|
||||||
|
- Keep the report page open during tests; it is the operational source of truth
|
||||||
|
for attempts, outcomes, and reconciliation.
|
||||||
|
- Confirm the effective Send now recipient-job limit. The safe default is 25;
|
||||||
|
use Queue for workers for ordinary batches or any run above that limit.
|
||||||
|
|
||||||
|
## Deliverability Preflight
|
||||||
|
|
||||||
|
Before the first live send for a sender domain or mail-server profile:
|
||||||
|
|
||||||
|
- Confirm the selected SMTP identity matches the visible From/envelope sender
|
||||||
|
policy.
|
||||||
|
- Confirm SPF, DKIM, and DMARC are handled by the sending infrastructure or
|
||||||
|
documented as out of scope for the selected test environment.
|
||||||
|
- Confirm rate limits are explicitly set for the expected provider and recipient
|
||||||
|
volume.
|
||||||
|
- Confirm bounce/reply/notification addresses are monitored by an operational
|
||||||
|
mailbox or intentionally disabled.
|
||||||
|
- Confirm large attachments and password-protected ZIPs are acceptable for the
|
||||||
|
recipient systems.
|
||||||
|
- Confirm owner transfer or policy changes force profile reselection and
|
||||||
|
revalidation before live delivery.
|
||||||
|
|
||||||
|
## Queue And Send
|
||||||
|
|
||||||
|
1. Validate the version with file checks enabled.
|
||||||
|
2. Build the version and inspect all blocking review items.
|
||||||
|
3. Queue only after the selected version is the intended immutable execution
|
||||||
|
version. Select **Queue for workers**, then verify the committed and
|
||||||
|
published counts.
|
||||||
|
4. Use **Send now** only if the exact eligible count is non-zero and at or below
|
||||||
|
the effective deployment/tenant limit shown on the page.
|
||||||
|
5. In worker mode, verify queue counters move from queued/claimed/sending to a
|
||||||
|
terminal SMTP state.
|
||||||
|
6. If a synchronous request is used, keep Review and send open: it polls the
|
||||||
|
durable counters while the request runs. A rejection occurs before SMTP and
|
||||||
|
directs oversized runs to workers.
|
||||||
|
|
||||||
|
## Outcome Handling
|
||||||
|
|
||||||
|
- `smtp_accepted`: Do not retry. If IMAP append is enabled and pending, run or
|
||||||
|
enqueue the append action.
|
||||||
|
- `failed_temporary`: Retry explicitly after checking the error and retry count.
|
||||||
|
- `failed_permanent`: Retry only if the operator has corrected the root cause and
|
||||||
|
intentionally includes permanent failures.
|
||||||
|
- `outcome_unknown`: Do not retry directly. Check SMTP logs, mailbox evidence, or
|
||||||
|
provider control panels, then reconcile as accepted or not sent.
|
||||||
|
- `claimed` or `sending` that does not progress: treat as a worker interruption.
|
||||||
|
Re-run worker handling or reconcile if SMTP may already have accepted the
|
||||||
|
message.
|
||||||
|
- IMAP `appending`: A worker owns the durable append claim. Do not start a
|
||||||
|
second append; if the worker cannot finish, reconcile only after checking the
|
||||||
|
mailbox.
|
||||||
|
- IMAP `outcome_unknown`: Never append automatically. An operator with
|
||||||
|
`campaigns:campaign:reconcile` must record an evidence note and resolve it as
|
||||||
|
`imap_appended` or `imap_not_appended`. Only the latter becomes explicitly
|
||||||
|
retryable.
|
||||||
|
|
||||||
|
## Reconciliation
|
||||||
|
|
||||||
|
- Choose "Accepted" only with external evidence that SMTP accepted the message.
|
||||||
|
The job becomes protected from retry and may proceed to IMAP append.
|
||||||
|
- Choose "Not sent" only when SMTP did not accept the message. The job becomes a
|
||||||
|
temporary failure and can be selected by explicit retry.
|
||||||
|
- Add a note that identifies the evidence used, for example SMTP log line,
|
||||||
|
provider message ID, or operator ticket.
|
||||||
|
|
||||||
|
## Fault Injection Checklist
|
||||||
|
|
||||||
|
Use mock infrastructure first, then repeat against the non-production real test
|
||||||
|
bed where possible:
|
||||||
|
|
||||||
|
- SMTP temporary failure.
|
||||||
|
- SMTP permanent failure.
|
||||||
|
- Recipient refusal after partial SMTP acceptance.
|
||||||
|
- Connection drop or worker interruption during SMTP.
|
||||||
|
- IMAP append failure after SMTP acceptance.
|
||||||
|
- Worker restart with queued, claimed, and sending jobs.
|
||||||
|
|
||||||
|
For the maintained loopback baseline, run
|
||||||
|
`dev/mail-testbed/run_campaign_acceptance.py`. It proves the public Campaign
|
||||||
|
path for SMTP acceptance, IMAP append, repeat-send blocking, an SMTP connection
|
||||||
|
failure before transmission, an explicit SMTP authentication rejection, an
|
||||||
|
explicit temporary `451` response after DATA, partial RCPT refusal, a
|
||||||
|
connection loss after complete DATA, and an IMAP authentication rejection
|
||||||
|
after SMTP acceptance. Its evidence is an allowlisted classification/count
|
||||||
|
projection; raw provider diagnostics and transport/account identifiers are
|
||||||
|
deliberately excluded.
|
||||||
|
|
||||||
|
The runner also terminates a dedicated OS process executing the registered
|
||||||
|
Campaign send task after complete DATA, then invokes the task in a fresh
|
||||||
|
process. The unfinished durable attempt must become `outcome_unknown` and the
|
||||||
|
endpoint must observe no second connection or DATA transaction. This covers
|
||||||
|
the worker task/process boundary but not a broker or daemon.
|
||||||
|
|
||||||
|
Run `dev/mail-testbed/run_celery_redelivery_acceptance.py` for the maintained
|
||||||
|
Redis/Celery delivery and broker redelivery boundary. It starts an isolated
|
||||||
|
Redis Compose service and real Celery workers, kills the first solo worker after complete DATA while the
|
||||||
|
late-ack task is unacknowledged, and requires the same task identity to reach a
|
||||||
|
replacement worker after Redis visibility recovery. Passing evidence also
|
||||||
|
requires durable `outcome_unknown`, an empty broker queue/unacked set, and
|
||||||
|
exactly one SMTP connection and DATA transaction. Raw worker logs and task,
|
||||||
|
database, endpoint, and credential identifiers are never retained.
|
||||||
|
|
||||||
|
That second runner proves local runner-supervised process replacement, not the
|
||||||
|
production process manager. Repeat the worker-loss drill under the selected
|
||||||
|
systemd, container, Kubernetes, or other production supervisor and the target
|
||||||
|
Redis/SMTP infrastructure before deployment approval.
|
||||||
|
|
||||||
|
## Reporting Checks
|
||||||
|
|
||||||
|
- Partial delivery must show accepted, failed, and unknown counts separately.
|
||||||
|
- Excluded messages must show SMTP and IMAP as `skipped`, with skipped counts
|
||||||
|
and filters separate from unattempted or failed delivery.
|
||||||
|
- Accepted and unknown jobs must not appear in retry selections.
|
||||||
|
- Reconciled accepted jobs must remain protected from resend.
|
||||||
|
- Reconciled not-sent jobs must appear only as explicit retry candidates.
|
||||||
|
- The final CSV export should include message id, resolved envelope headers,
|
||||||
|
attachment evidence, EML reference/checksum, latest SMTP response/error, and
|
||||||
|
latest IMAP folder/error before the campaign is considered operationally
|
||||||
|
closed.
|
||||||
479
docs/CAMPAIGN_HANDBOOK.md
Normal file
479
docs/CAMPAIGN_HANDBOOK.md
Normal file
@@ -0,0 +1,479 @@
|
|||||||
|
# Campaign Handbook
|
||||||
|
|
||||||
|
## Purpose and status
|
||||||
|
|
||||||
|
This is the canonical, multi-perspective handbook for the Campaign module. It
|
||||||
|
describes the current implementation, the operational contract it relies on,
|
||||||
|
and the remaining work required before Campaign can be presented as GovOPlaN's
|
||||||
|
maintained reference composition.
|
||||||
|
|
||||||
|
Use the section that matches the task at hand:
|
||||||
|
|
||||||
|
| Perspective | Start here |
|
||||||
|
| --- | --- |
|
||||||
|
| Campaign author | [Prepare a campaign](#prepare-a-campaign) |
|
||||||
|
| Reviewer | [Review and complete review](#review-and-complete-review) |
|
||||||
|
| Sender or delivery operator | [Deliver and resolve outcomes](#deliver-and-resolve-outcomes) |
|
||||||
|
| Campaign or tenant administrator | [Administration and policy](#administration-and-policy) |
|
||||||
|
| Platform operator | [Operations and recovery](#operations-and-recovery) |
|
||||||
|
| Integrator or developer | [Composition and integration contracts](#composition-and-integration-contracts) |
|
||||||
|
| Security, privacy, or audit reviewer | [Assurance model](#assurance-model) |
|
||||||
|
| Release reviewer | [Reference-composition acceptance](#reference-composition-acceptance) |
|
||||||
|
|
||||||
|
The shorter task documents remain useful companions:
|
||||||
|
|
||||||
|
- [Campaign delivery runbook](CAMPAIGN_DELIVERY_RUNBOOK.md)
|
||||||
|
- [Mail profile boundary](MAIL_PROFILE_BOUNDARY.md)
|
||||||
|
- [Recipient import guide](RECIPIENT_IMPORT_GUIDE.md)
|
||||||
|
- [Recipient and Addresses boundary](RECIPIENT_ADDRESS_BOUNDARY.md)
|
||||||
|
- [Examples and release checklist](EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md)
|
||||||
|
|
||||||
|
## What Campaign is for
|
||||||
|
|
||||||
|
Campaign turns governed source data into individually built messages and then
|
||||||
|
controls their review, delivery, and evidence. It is intentionally a
|
||||||
|
composition module: it demonstrates how one user journey can use optional Mail,
|
||||||
|
Files, Addresses, and Notifications capabilities alongside Core access/audit
|
||||||
|
infrastructure without copying ownership from those modules. Policy may consume
|
||||||
|
Campaign context through a narrow capability; Campaign does not import Policy.
|
||||||
|
|
||||||
|
Campaign owns:
|
||||||
|
|
||||||
|
- the communication purpose, content, campaign-local fields, and templates;
|
||||||
|
- campaign-local recipient snapshots, exclusions, and personalization;
|
||||||
|
- message and attachment rules for a version;
|
||||||
|
- validation, review, build, queue, and delivery-control state;
|
||||||
|
- the durable jobs and attempts needed to explain delivery outcomes; and
|
||||||
|
- campaign-specific reports, shares, and frozen execution evidence.
|
||||||
|
|
||||||
|
Campaign does not own:
|
||||||
|
|
||||||
|
- SMTP/IMAP profiles, credentials, protocol adapters, or mailbox policy;
|
||||||
|
- long-lived address-book master data, consent lifecycle, or deduplication;
|
||||||
|
- managed file bytes, connector credentials, or external-file provenance;
|
||||||
|
- general-purpose workflow definitions; or
|
||||||
|
- global identity, organization, permission, or retention policy.
|
||||||
|
|
||||||
|
Those boundaries matter in both persistence and UI. A campaign references an
|
||||||
|
authorized Mail profile and managed file versions; it must never become a
|
||||||
|
second secret store, file store, or address directory.
|
||||||
|
|
||||||
|
## Process view
|
||||||
|
|
||||||
|
The supported process is a controlled progression, not a single "send" call:
|
||||||
|
|
||||||
|
```text
|
||||||
|
create/edit
|
||||||
|
-> validate and resolve policy/integrations
|
||||||
|
-> review warnings and blockers
|
||||||
|
-> build exact recipient messages
|
||||||
|
-> complete review and queue
|
||||||
|
-> SMTP attempt per job
|
||||||
|
-> optional IMAP append per accepted job
|
||||||
|
-> report, retry, reconcile, or correct
|
||||||
|
-> archive when no active/uncertain delivery remains
|
||||||
|
```
|
||||||
|
|
||||||
|
Campaign status summarizes the whole campaign. Version workflow state describes
|
||||||
|
the selected immutable/editable version. Each recipient job separately records
|
||||||
|
build, validation, queue, SMTP, and IMAP state. Operators must use the job-level
|
||||||
|
states when deciding whether another external effect is safe.
|
||||||
|
|
||||||
|
Important distinctions:
|
||||||
|
|
||||||
|
- **Validation lock** is the reversible lock created by a successful
|
||||||
|
validation/build path. Editing requires unlocking and invalidates derived
|
||||||
|
evidence as appropriate.
|
||||||
|
- **User lock** is an explicit audit-safe lock. A permanently locked or
|
||||||
|
delivery-final version is not edited in place; create an editable successor.
|
||||||
|
- **SMTP accepted** means the provider accepted the message. It does not prove
|
||||||
|
inbox delivery, reading, or business acknowledgement.
|
||||||
|
- **Outcome unknown** means an attempt may have had an external effect. It must
|
||||||
|
be investigated and reconciled before retry.
|
||||||
|
- **IMAP append** is a separate effect after SMTP acceptance. An append failure
|
||||||
|
is not evidence that sending failed.
|
||||||
|
- **Archive** preserves evidence. Draft-only campaigns without built, locked,
|
||||||
|
or delivery evidence may be deleted where policy allows; evidence-bearing
|
||||||
|
campaigns are archived instead.
|
||||||
|
|
||||||
|
## User tasks
|
||||||
|
|
||||||
|
### Prepare a campaign
|
||||||
|
|
||||||
|
1. Create a campaign and confirm its owner or owning group.
|
||||||
|
2. Define global settings, fields, templates, and recipient data.
|
||||||
|
3. Import one-off recipient data or select a reusable Addresses source when the
|
||||||
|
optional capability is installed. Review source provenance and stale-source
|
||||||
|
warnings; Campaign freezes the selected rows rather than following later
|
||||||
|
directory changes silently.
|
||||||
|
4. Select managed attachments through Files. Server/API campaigns do not accept
|
||||||
|
arbitrary local paths. Preview rules and unmatched files before building.
|
||||||
|
5. Open **Mail settings** and select an available Mail profile. The campaign
|
||||||
|
stores only `server.mail_profile_id`; it never accepts SMTP/IMAP settings,
|
||||||
|
usernames, passwords, or credential references.
|
||||||
|
6. Save the editable version, validate the relevant sections, and resolve every
|
||||||
|
blocking issue. Warnings remain explicit review decisions.
|
||||||
|
7. Build the exact messages and inspect recipient, addressing, template,
|
||||||
|
attachment, and generated-message evidence.
|
||||||
|
|
||||||
|
If a selected optional module is absent, Campaign remains loadable and explains
|
||||||
|
which function is unavailable. It must not fail startup because Mail, Files, or
|
||||||
|
Addresses is not installed.
|
||||||
|
|
||||||
|
### Review and complete review
|
||||||
|
|
||||||
|
The reviewer should verify the immutable candidate that will be delivered, not
|
||||||
|
just the authoring form:
|
||||||
|
|
||||||
|
1. Confirm purpose, owner, selected version, and recipient count.
|
||||||
|
2. Inspect blocking errors, warnings, exclusions, and recipients requiring
|
||||||
|
review.
|
||||||
|
3. Inspect representative and exceptional rendered messages, including From,
|
||||||
|
To/CC/BCC, Reply-To, subject, body, and attachment evidence.
|
||||||
|
4. Confirm the selected Mail profile is authorized for the campaign's current
|
||||||
|
tenant and owner context.
|
||||||
|
5. Confirm attachment behavior when a rule matches no files, ZIP/password
|
||||||
|
behavior, and any recipient-specific files.
|
||||||
|
6. Record review completion and the inspected message keys through the review
|
||||||
|
surface. The current baseline does not persist a distinct approve/reject
|
||||||
|
decision or review reason. If content, recipients, attachment inputs, owner
|
||||||
|
context, or non-secret transport identity changes, revalidate and rebuild.
|
||||||
|
|
||||||
|
Normal readers and reviewers see business state and safe evidence. Process-local
|
||||||
|
paths, storage keys, worker claim tokens, and raw provider diagnostics require
|
||||||
|
the dedicated diagnostic permission and must not leak through ordinary campaign,
|
||||||
|
version, job, or report responses.
|
||||||
|
|
||||||
|
Campaign now provides a separate aggregate **Reports** surface for readers with
|
||||||
|
`campaigns:report:read` and access to the campaign. It loads only the safe
|
||||||
|
aggregate projections, applies small-cell suppression, and offers no recipient
|
||||||
|
rows, drill-down, filtering, export, or delivery actions. The recipient-aware
|
||||||
|
**Campaign Report** still requires recipient-read access and does not yet hide
|
||||||
|
every action control that the actor lacks. The server authorizes each action,
|
||||||
|
but permission-aware action visibility on that detailed surface remains open
|
||||||
|
work; do not confuse it with the aggregate reader experience.
|
||||||
|
|
||||||
|
### Deliver and resolve outcomes
|
||||||
|
|
||||||
|
Use the [delivery runbook](CAMPAIGN_DELIVERY_RUNBOOK.md) for the detailed
|
||||||
|
operator sequence.
|
||||||
|
|
||||||
|
At a minimum:
|
||||||
|
|
||||||
|
1. Queue only a validated, locked, built version. Use **Queue for workers** for
|
||||||
|
ordinary batches; the durable progress remains visible after leaving and
|
||||||
|
returning to Review and send.
|
||||||
|
2. Use **Send now** only when the exact persisted eligible build is within the
|
||||||
|
effective synchronous limit shown by the UI. The default deployment limit
|
||||||
|
is 25 recipient jobs. The backend repeats the count and preflights every
|
||||||
|
message and the Mail profile revision before contacting SMTP.
|
||||||
|
3. Treat `smtp_accepted` as protected from ordinary retry.
|
||||||
|
4. Retry `failed_temporary` explicitly after inspecting the cause.
|
||||||
|
5. Include `failed_permanent` only after correcting the cause and making a
|
||||||
|
conscious override.
|
||||||
|
6. Never retry `outcome_unknown` blindly. Inspect SMTP/provider evidence and
|
||||||
|
reconcile it as **accepted** or **not sent**, with a note identifying the
|
||||||
|
evidence.
|
||||||
|
7. Process append-to-Sent only for SMTP-accepted jobs and investigate append
|
||||||
|
failure independently. Never retry an `outcome_unknown` IMAP append blindly:
|
||||||
|
reconcile mailbox evidence as **appended** or **not appended** with a note.
|
||||||
|
Only the latter becomes explicitly retryable, and neither decision resends
|
||||||
|
the already SMTP-accepted message.
|
||||||
|
8. Archive only after active and uncertain effects are resolved.
|
||||||
|
|
||||||
|
Pause stops new eligible work but cannot undo a provider effect already in
|
||||||
|
progress. Cancel marks work that has not yet produced a protected SMTP outcome;
|
||||||
|
it cannot recall accepted mail.
|
||||||
|
|
||||||
|
The deployment ceiling is configured with
|
||||||
|
`GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS` (0 disables Send now; the
|
||||||
|
accepted range is 0–500). A tenant may only narrow that ceiling with
|
||||||
|
`tenant.settings.campaign_delivery_policy.synchronous_send_max_recipients`.
|
||||||
|
The effective value and source are returned by the protected delivery-options
|
||||||
|
API, recorded for successful/rejected synchronous commands, and stated in the
|
||||||
|
configured handbook topic.
|
||||||
|
|
||||||
|
### Test and one-message actions
|
||||||
|
|
||||||
|
The current baseline includes mock send, queue dry-run, synchronous immediate
|
||||||
|
delivery, sending one selected job, retry selection, and unattempted-job
|
||||||
|
selection. Their audit and state behavior is not yet the final vocabulary
|
||||||
|
accepted for issue `govoplan-campaign#69`.
|
||||||
|
|
||||||
|
The intended distinction is:
|
||||||
|
|
||||||
|
- **Test:** deliver once to the configured test path, audit it, and leave the
|
||||||
|
production job unsent.
|
||||||
|
- **Single send:** send one unsent job, audit it, and mark its production effect
|
||||||
|
complete.
|
||||||
|
- **Single resend:** intentionally send one job again regardless of an earlier
|
||||||
|
failure or acceptance, with distinct authority, warning, reason, and audit.
|
||||||
|
|
||||||
|
Until that slice is implemented and target-tested, do not present the existing
|
||||||
|
buttons as a complete resend policy. Ordinary retry protection remains the safe
|
||||||
|
default.
|
||||||
|
|
||||||
|
## Data and evidence model
|
||||||
|
|
||||||
|
### Versions and snapshots
|
||||||
|
|
||||||
|
Editable campaign JSON is versioned. Build creates recipient jobs and an
|
||||||
|
execution snapshot. A new profile-only snapshot contains the stable Mail
|
||||||
|
profile id, delivery policy/evidence, and opaque Mail-issued transport
|
||||||
|
revisions. It contains no resolved SMTP/IMAP configuration or credentials.
|
||||||
|
|
||||||
|
At delivery time Mail re-authorizes the profile, compares the expected opaque
|
||||||
|
revisions, resolves credentials inside the same Mail-owned operation, and
|
||||||
|
performs the transport effect. Campaign receives only the sanitized result it
|
||||||
|
needs for job state and evidence. This same-call check prevents a
|
||||||
|
validate-then-use race across the module boundary.
|
||||||
|
|
||||||
|
Credential rotation that does not change the non-secret transport identity may
|
||||||
|
continue to satisfy the snapshot. A host, account identity, protocol, sender,
|
||||||
|
or other revisioned transport change stops delivery until the campaign is
|
||||||
|
revalidated and rebuilt.
|
||||||
|
|
||||||
|
### Existing legacy database records
|
||||||
|
|
||||||
|
The current Campaign database may contain versions with inline SMTP/IMAP
|
||||||
|
material. No separate historical Campaign JSON corpus exists. Inline transport
|
||||||
|
material in those rows is treated as inert legacy data and is never interpreted
|
||||||
|
as an executable Mail configuration:
|
||||||
|
|
||||||
|
- public responses remove legacy transport fields and secrets;
|
||||||
|
- validation, build, queue, retry, and delivery fail closed;
|
||||||
|
- an editable version changes to profile-only form only through an explicit
|
||||||
|
Mail-settings save; and
|
||||||
|
- a locked version is preserved and must be forked to an editable successor.
|
||||||
|
|
||||||
|
Normal database backup/restore and access controls cover those rows together
|
||||||
|
with the rest of the current database. There is no separate historical-JSON,
|
||||||
|
backup-scanning, or inline-secret migration program. Restoring an existing
|
||||||
|
legacy row preserves it as inert evidence and does not make it deliverable.
|
||||||
|
|
||||||
|
### Recipient and attachment evidence
|
||||||
|
|
||||||
|
The delivery record should be able to identify:
|
||||||
|
|
||||||
|
- source/import context and the frozen recipient row;
|
||||||
|
- effective addressing and message id;
|
||||||
|
- template inputs and unresolved-placeholder decisions;
|
||||||
|
- managed file/version ids, source provenance, checksums, and ZIP evidence;
|
||||||
|
- generated EML checksum and size;
|
||||||
|
- Mail profile reference and opaque transport revisions;
|
||||||
|
- each SMTP and IMAP attempt, its classification, safe provider response, and
|
||||||
|
reconciliation note; and
|
||||||
|
- actor/system trigger, timestamps, policy context, and corrections.
|
||||||
|
|
||||||
|
An excluded recipient/message is a completed validation decision, not a
|
||||||
|
pending delivery. Its SMTP and IMAP states are both `skipped`; it is counted and
|
||||||
|
filterable separately from unattempted, failed, accepted, and append outcomes.
|
||||||
|
No SMTP or IMAP attempt exists for such a row. If historical data contains
|
||||||
|
actual transport evidence despite an exclusion marker, that evidence is
|
||||||
|
preserved for audit and reconciliation rather than relabelled.
|
||||||
|
|
||||||
|
## Administration and policy
|
||||||
|
|
||||||
|
### Roles and permissions
|
||||||
|
|
||||||
|
The supplied role templates deliberately separate preparation, review, and
|
||||||
|
delivery:
|
||||||
|
|
||||||
|
- **Campaign manager** prepares, validates, and builds campaigns and recipients.
|
||||||
|
- **Campaign reviewer** inspects prepared material and records review
|
||||||
|
completion for the exact messages checked.
|
||||||
|
- **Campaign sender** queues, sends, pauses/resumes/cancels, retries, reconciles,
|
||||||
|
reads reports, and has diagnostic access.
|
||||||
|
|
||||||
|
Administrators may compose narrower roles from the declared permissions. Keep
|
||||||
|
these separations where institutional policy requires four-eyes approval. Mail
|
||||||
|
profile use additionally requires `mail:profile:use`; profile and credential
|
||||||
|
administration remains a Mail permission.
|
||||||
|
|
||||||
|
Campaign access is also constrained by tenant, owner/group context, and explicit
|
||||||
|
shares. A share grants only its declared campaign permission; it does not grant
|
||||||
|
Mail credentials, Files administration, or tenant-wide recipient access.
|
||||||
|
|
||||||
|
### Configuration checklist
|
||||||
|
|
||||||
|
- Install compatible Core and Campaign versions. Access and base audit are Core
|
||||||
|
infrastructure; install optional Mail, Files, Addresses, Notifications, and
|
||||||
|
Policy modules only where the configured journey requires them.
|
||||||
|
- Configure Mail profiles and policy in Mail, not in campaign fixtures or JSON.
|
||||||
|
- Configure Files storage/connectors and attachment permissions in Files.
|
||||||
|
- Define role assignments and separation-of-duty policy.
|
||||||
|
- Configure Redis/Celery for durable batch workers where production volume
|
||||||
|
requires it. Local execution is a development/small-run mode, not horizontal
|
||||||
|
worker coordination.
|
||||||
|
- Set rate limits for the target provider. Mail may use Redis for shared
|
||||||
|
throttling when present and a process-local fallback in development.
|
||||||
|
- Establish retention, deletion, archive, report-export, and diagnostic-access
|
||||||
|
policy before production recipient data is loaded.
|
||||||
|
- Use non-production SMTP/IMAP identities and the maintained examples before
|
||||||
|
allowing a production profile.
|
||||||
|
|
||||||
|
### Owner transfer
|
||||||
|
|
||||||
|
Mail profile visibility can depend on campaign owner or group. Transferring an
|
||||||
|
editable campaign with a selected profile clears/requires reselection and
|
||||||
|
revalidation. A locked or delivery-final version is never silently rewritten;
|
||||||
|
create an editable successor.
|
||||||
|
|
||||||
|
## Operations and recovery
|
||||||
|
|
||||||
|
### Health to observe
|
||||||
|
|
||||||
|
- database and migration health;
|
||||||
|
- compatible module interface versions;
|
||||||
|
- queue publication, worker heartbeat, claim age, and backlog;
|
||||||
|
- SMTP/IMAP profile test result and deployment egress policy;
|
||||||
|
- Mail profile authorization/transport-revision mismatch;
|
||||||
|
- Files resolution and frozen attachment availability;
|
||||||
|
- counts by queue, SMTP, IMAP, and reconciliation state; and
|
||||||
|
- audit and report generation failures.
|
||||||
|
|
||||||
|
### Worker interruption
|
||||||
|
|
||||||
|
A crashed worker can leave a job claimed or sending. Do not infer non-delivery
|
||||||
|
from worker loss. If the SMTP boundary may have been crossed, classify the
|
||||||
|
outcome as unknown and reconcile from external evidence. Only work that is
|
||||||
|
provably unattempted may be returned to an ordinary queue.
|
||||||
|
|
||||||
|
### Retry and reconciliation
|
||||||
|
|
||||||
|
Retries create new attempt evidence; they do not overwrite the previous
|
||||||
|
attempt. Reconciliation is a privileged factual correction supported by an
|
||||||
|
operator note. Repeated automated requests should be idempotent for the same
|
||||||
|
eligible job state; a deliberate resend is a different, not-yet-finalized
|
||||||
|
business action and must never be disguised as a retry.
|
||||||
|
|
||||||
|
### Backups and restoration
|
||||||
|
|
||||||
|
Back up Campaign, Mail, Files, Core/Audit, and shared storage consistently for
|
||||||
|
the composition. A database restore without generated EML/file storage, or file
|
||||||
|
storage without matching metadata, does not reconstruct the evidence chain.
|
||||||
|
After restore, keep outbound delivery paused until queue/attempt state and
|
||||||
|
provider evidence have been reconciled; never let restored accepted jobs send
|
||||||
|
again merely because a queue message was lost.
|
||||||
|
|
||||||
|
### Incident handling
|
||||||
|
|
||||||
|
1. Pause new delivery when duplicate or unknown effects are possible.
|
||||||
|
2. Preserve database, queue, provider, worker, and audit evidence.
|
||||||
|
3. Scope affected campaigns/jobs without exposing recipient content broadly.
|
||||||
|
4. Reconcile uncertain jobs individually or through an approved bounded tool.
|
||||||
|
5. Correct configuration in its owning module, then revalidate/rebuild where
|
||||||
|
revisioned transport inputs changed.
|
||||||
|
6. Record the incident reference and recovery rationale in audit evidence.
|
||||||
|
|
||||||
|
## Composition and integration contracts
|
||||||
|
|
||||||
|
Campaign has one required platform dependency: Core. Optional module behavior
|
||||||
|
is discovered through versioned, Core-mediated capabilities; Campaign must not
|
||||||
|
import optional sibling ORM, services, or WebUI implementation.
|
||||||
|
|
||||||
|
Current principal contracts include:
|
||||||
|
|
||||||
|
| Contract | Direction | Purpose |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `mail.campaign_delivery` 0.2.x | Mail -> Campaign | Summarize a known reference; authorize and revision-gate it; send/append using Mail-owned configuration and credentials; return sanitized results |
|
||||||
|
| `files.campaign_attachments` 0.1.x | Files -> Campaign | Select/materialize governed file versions and preserve campaign usage/evidence |
|
||||||
|
| `addresses.lookup` 0.1.x | Addresses -> Campaign | Optional address suggestions |
|
||||||
|
| `addresses.recipient_source` 0.1.x | Addresses -> Campaign | Optional versioned recipient-source snapshots |
|
||||||
|
| `campaigns.access` 0.1.x | Campaign -> platform | Explain campaign access/existence without exporting ORM objects |
|
||||||
|
| `campaigns.mail_policy_context` 0.1.x | Campaign -> Mail | Resolve campaign tenant/owner context for Mail policy |
|
||||||
|
| `campaigns.delivery_tasks` 0.1.x | Campaign -> workers | Execute narrow queued send/append tasks |
|
||||||
|
| `campaigns.retention` 0.1.x | Campaign -> retention | Apply Campaign-owned retention behavior |
|
||||||
|
|
||||||
|
Breaking payload or ownership changes require an interface-version bump and a
|
||||||
|
release-composition alignment gate. Optional absence must be tested physically,
|
||||||
|
not only hidden in navigation.
|
||||||
|
|
||||||
|
### External API expectations
|
||||||
|
|
||||||
|
- Tenant and campaign access are evaluated for every operation.
|
||||||
|
- Writes require CSRF/auth behavior supplied by Core and the specific declared
|
||||||
|
scope.
|
||||||
|
- Queue/retry/reconcile endpoints operate on persisted state and return safe
|
||||||
|
summaries; initiating HTTP success is not proof of external delivery.
|
||||||
|
- Delta endpoints are optimization surfaces, not a separate source of truth.
|
||||||
|
- Report exports contain permitted business/evidence fields but no credentials,
|
||||||
|
local paths, storage keys, or worker claims.
|
||||||
|
|
||||||
|
## Assurance model
|
||||||
|
|
||||||
|
### Security invariants
|
||||||
|
|
||||||
|
- No new campaign payload, fixture, response, or execution snapshot contains
|
||||||
|
SMTP/IMAP settings or credentials.
|
||||||
|
- Mail resolves credentials and performs transports inside Mail-owned calls.
|
||||||
|
- Every real connector peer is validated and pinned at connection time under
|
||||||
|
deployment-wide private-network policy.
|
||||||
|
- API/server attachment paths use managed Files references; arbitrary and
|
||||||
|
traversal-capable local paths are rejected.
|
||||||
|
- Public responses recursively remove infrastructure locators and secret-like
|
||||||
|
legacy fields.
|
||||||
|
- Accepted and outcome-unknown jobs are protected from ordinary retry.
|
||||||
|
- Diagnostic permission is separate from campaign read/report access.
|
||||||
|
|
||||||
|
### Privacy
|
||||||
|
|
||||||
|
Recipient fields and rendered messages may contain personal or sensitive data.
|
||||||
|
Grant recipient read/export, report export, and diagnostic access separately.
|
||||||
|
Prefer aggregate status for readers who do not need recipient detail. Define
|
||||||
|
purpose, lawful basis, minimization, export control, and retention before the
|
||||||
|
campaign starts; do not use Campaign as a substitute consent or address-master
|
||||||
|
system.
|
||||||
|
|
||||||
|
### Audit and destructive actions
|
||||||
|
|
||||||
|
Material authoring, validation, locking, review, queueing, send, retry,
|
||||||
|
reconciliation, sharing, owner transfer, archive, and permitted deletion actions
|
||||||
|
emit attributable evidence. Audit details must be non-secret and should refer to
|
||||||
|
stable ids rather than repeat message bodies or credentials.
|
||||||
|
|
||||||
|
Draft deletion is allowed only while no audit-relevant build, delivery job, or
|
||||||
|
lock exists. Evidence-bearing campaigns are archived. Destructive module
|
||||||
|
retirement remains a separately confirmed installer operation with backup and
|
||||||
|
retirement evidence.
|
||||||
|
|
||||||
|
## Reference-composition acceptance
|
||||||
|
|
||||||
|
Campaign is ready to serve as the demonstration module only when all of the
|
||||||
|
following are repeatable in a pinned clean installation:
|
||||||
|
|
||||||
|
1. The maintained examples validate and build with Mail/Files present, and
|
||||||
|
Campaign still starts with each optional module absent.
|
||||||
|
2. A user can import recipients, select managed files, choose an authorized Mail
|
||||||
|
profile, validate, review, build, and queue without entering transport ids or
|
||||||
|
secrets manually.
|
||||||
|
3. Campaign JSON and all ordinary APIs reject/omit inline transport material;
|
||||||
|
legacy records are visible as migration-required and cannot execute.
|
||||||
|
4. SMTP success, temporary/permanent failure, connection loss, worker loss,
|
||||||
|
outcome unknown, retry, reconciliation, IMAP success, and IMAP failure have
|
||||||
|
tested, non-duplicating outcomes against the target environment.
|
||||||
|
5. Author, reviewer, sender/operator, reader, and administrator views use the
|
||||||
|
central component system and expose only task-relevant actions.
|
||||||
|
6. Reports and audit can reconstruct recipient/message/file/profile/attempt
|
||||||
|
evidence without exposing secrets or ordinary-reader infrastructure details.
|
||||||
|
7. Clean install, upgrade, backup/restore, module permutations, version
|
||||||
|
alignment, security audit, and target SMTP/IMAP tests pass.
|
||||||
|
8. This handbook and its adaptive Docs topics match the shipped UI wording and
|
||||||
|
distinguish implemented behavior from planned work.
|
||||||
|
|
||||||
|
## Explicitly planned, not yet claimed
|
||||||
|
|
||||||
|
The following are part of the selected reference journey but are not implied by
|
||||||
|
the current baseline:
|
||||||
|
|
||||||
|
- the final audited **test / single send / single resend** semantics;
|
||||||
|
- reusable SMTP batch sessions and their measured throughput benefit;
|
||||||
|
- durable, idempotent Campaign report delivery through a Mail-owned outbox
|
||||||
|
([`govoplan-mail#17`](https://git.add-ideas.de/add-ideas/govoplan-mail/issues/17));
|
||||||
|
- a fully packaged one-command Campaign reference composition with production
|
||||||
|
policy presets and target-provider certification;
|
||||||
|
- function-bound Postbox delivery (stage 2 of the reference program);
|
||||||
|
- generic workflow-driven campaign transitions.
|
||||||
|
|
||||||
|
Each item needs an owning issue, implementation, failure tests, documentation,
|
||||||
|
and release evidence before the wording above can move from planned to current.
|
||||||
103
docs/EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md
Normal file
103
docs/EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
# Example Campaigns And Release Checklist
|
||||||
|
|
||||||
|
This document defines the campaign examples and release gates that should be
|
||||||
|
kept working before a GovOPlaN Campaign release is tagged.
|
||||||
|
|
||||||
|
## Example Campaign Set
|
||||||
|
|
||||||
|
Maintain fixtures or guided examples for these scenarios. The canonical
|
||||||
|
scenario catalogue lives in `examples/README.md`; committed fixture files should
|
||||||
|
be added under `examples/` only when they validate against the current campaign
|
||||||
|
schema and are safe to run in non-production environments.
|
||||||
|
|
||||||
|
- [`simple-announcement`](../examples/simple-announcement/campaign.json), a
|
||||||
|
credential-free campaign with one active recipient and no attachments; its
|
||||||
|
automated acceptance check physically blocks Mail and Files imports, denies
|
||||||
|
network connections, and validates/builds from an unrelated temporary
|
||||||
|
workspace
|
||||||
|
- multi-recipient message with To, CC, BCC, Reply-To, bounce, and disposition
|
||||||
|
notification fields
|
||||||
|
- campaign with global attachments and recipient-specific attachment rules
|
||||||
|
- campaign with password-protected ZIP attachments
|
||||||
|
- campaign using a reusable mail profile from the mail module
|
||||||
|
- legacy inline SMTP/IMAP campaign rejected with an actionable profile-migration
|
||||||
|
error and no returned transport data
|
||||||
|
- campaign with validation warnings that may be sent only after explicit review
|
||||||
|
- campaign with blocked recipients or attachment errors that must not be sent
|
||||||
|
- mock delivery campaign that captures SMTP and IMAP append messages in the mail
|
||||||
|
development mailbox
|
||||||
|
- [`greenmail-delivery`](../examples/greenmail-delivery/campaign.json), a
|
||||||
|
credential-free real-delivery Campaign materialized with a temporary
|
||||||
|
Mail-owned profile by the loopback acceptance runner
|
||||||
|
|
||||||
|
## Fixture Rules
|
||||||
|
|
||||||
|
- Examples must not contain production recipient data or production credentials.
|
||||||
|
- Attachment examples should use deterministic small files and checksums.
|
||||||
|
- Mail secrets belong only to encrypted Mail profiles and must never appear in
|
||||||
|
a campaign fixture, placeholder, or campaign-local secret reference.
|
||||||
|
- Examples that require optional modules must declare the required modules and
|
||||||
|
capabilities in their README or fixture metadata.
|
||||||
|
- Examples must stay valid when files or mail modules are physically absent,
|
||||||
|
with optional behavior disabled instead of import failures.
|
||||||
|
|
||||||
|
## Release Gates
|
||||||
|
|
||||||
|
Before tagging a campaign release:
|
||||||
|
|
||||||
|
- Review `examples/README.md` and update the scenario catalogue when a release
|
||||||
|
adds or removes delivery behavior.
|
||||||
|
- Run `python -m unittest discover -s tests -p 'test_example_campaigns.py'` and
|
||||||
|
retain its isolated validate/build result as release evidence.
|
||||||
|
- Run core module permutation tests with campaign installed both with and
|
||||||
|
without files/mail.
|
||||||
|
- Validate and build each maintained example campaign.
|
||||||
|
- Run the mock delivery example when the mail development mailbox capability is
|
||||||
|
enabled.
|
||||||
|
- Run the GreenMail SMTP/IMAP smoke for a non-production real delivery path.
|
||||||
|
- Run `dev/mail-testbed/run_campaign_acceptance.py` and retain its bounded JSON
|
||||||
|
projection. It must show one SMTP acceptance, one IMAP append, no duplicate
|
||||||
|
effect from a repeated ordinary send, matching Campaign report/audit state,
|
||||||
|
and no resolved transport material in Campaign JSON or its execution
|
||||||
|
snapshot. Its controlled endpoint evidence must also show explicit SMTP 451,
|
||||||
|
partial RCPT refusal, post-DATA ambiguity, and task-process interruption
|
||||||
|
classifications without retaining addresses or provider diagnostics.
|
||||||
|
- Treat the task-process restart proof separately from the still-open
|
||||||
|
Redis/Celery broker redelivery and daemon-supervision check; the coverage
|
||||||
|
projection must keep `celery_broker_redelivery` false.
|
||||||
|
- Run `dev/mail-testbed/run_celery_redelivery_acceptance.py` as a separate
|
||||||
|
destructive worker-loss check. Retain its bounded evidence only when the same
|
||||||
|
broker task is observed at both workers, the durable state is
|
||||||
|
`outcome_unknown`, broker queue/unacked counts are zero, and the controlled
|
||||||
|
SMTP endpoint observed one connection and one DATA transaction. This closes
|
||||||
|
local Redis/Celery redelivery coverage, while production supervisor and
|
||||||
|
target-provider coverage remain false until separately tested.
|
||||||
|
- Confirm reusable mail profile selection is revalidated after campaign owner
|
||||||
|
transfer.
|
||||||
|
- Confirm every inline SMTP/IMAP field is rejected on import/write, omitted
|
||||||
|
from responses, and blocked from legacy execution until explicitly migrated.
|
||||||
|
- Confirm execution snapshots store only the Mail profile reference and
|
||||||
|
opaque Mail-owned transport revisions, not resolved transport material.
|
||||||
|
- Confirm delivery reports include SMTP outcome, IMAP append outcome, latest
|
||||||
|
error, generated EML reference, and attachment evidence.
|
||||||
|
- Confirm retries cannot resend messages already accepted by SMTP unless an
|
||||||
|
explicit reconciliation path allows it.
|
||||||
|
|
||||||
|
## Ownership Transfer Check
|
||||||
|
|
||||||
|
Reusable user/group mail profiles are owner-context-sensitive. When campaign
|
||||||
|
ownership changes, the editable current version must require profile reselection
|
||||||
|
and validation before live delivery. A locked delivery-final version should not
|
||||||
|
be silently rewritten.
|
||||||
|
|
||||||
|
## Delivery Checklist
|
||||||
|
|
||||||
|
Use the Review & Send preflight panel and the delivery runbook together:
|
||||||
|
|
||||||
|
1. Validate and resolve all blocking policy/data issues.
|
||||||
|
2. Build exact messages.
|
||||||
|
3. Review warnings, generated recipients, body content, and attachment evidence.
|
||||||
|
4. Run mock delivery if available for the release channel.
|
||||||
|
5. Test the selected Mail profile against non-production infrastructure.
|
||||||
|
6. Send only after queue, rate limit, and append-to-Sent behavior are understood.
|
||||||
|
7. Reconcile failed, unknown, or pending jobs from the report/audit surfaces.
|
||||||
93
docs/MAIL_PROFILE_BOUNDARY.md
Normal file
93
docs/MAIL_PROFILE_BOUNDARY.md
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
# Campaign and Mail Profile Boundary
|
||||||
|
|
||||||
|
## Product view
|
||||||
|
|
||||||
|
A campaign chooses an authorized Mail profile. It does not define a mail
|
||||||
|
server. The Campaign module owns recipients, content, attachment rules,
|
||||||
|
delivery intent, review state, and delivery evidence. The Mail module owns the
|
||||||
|
SMTP/IMAP endpoints, encrypted credentials, connection tests, profile policy,
|
||||||
|
and runtime transport adapters.
|
||||||
|
|
||||||
|
The persisted campaign contract is therefore deliberately narrow:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "stable-mail-profile-id"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
No `server.smtp`, `server.imap`, `server.credentials`, credential-inheritance
|
||||||
|
override, or password is valid campaign JSON.
|
||||||
|
|
||||||
|
## User journey
|
||||||
|
|
||||||
|
1. A Mail administrator creates and tests a reusable profile in Mail.
|
||||||
|
2. A campaign author opens **Mail settings** and selects one profile available
|
||||||
|
for the campaign's tenant, owner, and policy context.
|
||||||
|
3. Campaign stores only the stable profile identifier.
|
||||||
|
4. Validation asks Mail to authorize the active profile and returns only
|
||||||
|
availability flags plus opaque Mail-owned transport revisions. Reading that
|
||||||
|
summary does not decrypt credentials.
|
||||||
|
5. Build stores the profile identifier, delivery policy, job manifest, and
|
||||||
|
non-secret transport revisions as execution evidence. It stores no
|
||||||
|
resolved host, username, password, or other transport material.
|
||||||
|
6. A delivery worker invokes one Mail-owned effect operation. Mail re-authorizes
|
||||||
|
the profile, resolves credentials, compares the expected transport
|
||||||
|
revision, checks policy, and sends or appends without returning transport
|
||||||
|
material to Campaign. If the selected profile or its non-secret transport settings
|
||||||
|
changed after build, delivery stops until the campaign is revalidated and
|
||||||
|
rebuilt. A password rotation that leaves the transport identity unchanged
|
||||||
|
does not invalidate the build.
|
||||||
|
7. Mail returns only Campaign-owned envelope addresses, counts, sanitized
|
||||||
|
refusal classifications/status codes, or the selected Sent folder. Raw
|
||||||
|
server banners, provider bytes, host details, and credentials never enter
|
||||||
|
Campaign attempts or public evidence.
|
||||||
|
|
||||||
|
Non-dry Campaign report email currently fails closed. It must not bypass the
|
||||||
|
durable job/effect model through a direct SMTP call. Re-enabling it requires the
|
||||||
|
Mail-owned idempotent outbox, attempt, unknown-outcome, and reconciliation path
|
||||||
|
tracked in
|
||||||
|
[`govoplan-mail#17`](https://git.add-ideas.de/add-ideas/govoplan-mail/issues/17).
|
||||||
|
Report generation and dry-run validation remain separate from an external
|
||||||
|
effect; recipient-level exports require recipient-export authorization.
|
||||||
|
|
||||||
|
Campaign authors need `mail:profile:use` in addition to the relevant Campaign
|
||||||
|
permission. Profile visibility remains governed by Mail policy and campaign
|
||||||
|
owner context.
|
||||||
|
|
||||||
|
## Existing database rows and migration
|
||||||
|
|
||||||
|
The current database can contain campaign versions with inline SMTP/IMAP
|
||||||
|
settings or credentials. There is no separate historical Campaign JSON corpus
|
||||||
|
to import or remediate. GovOPlaN treats those inline fields as inert legacy
|
||||||
|
material and does not delete or rewrite the stored audit rows automatically:
|
||||||
|
|
||||||
|
- API responses omit all legacy transport fields and secrets and expose a
|
||||||
|
`mail_profile_migration_required` marker.
|
||||||
|
- validation, build, queue, retry, and delivery fail closed with an actionable
|
||||||
|
profile-migration error;
|
||||||
|
- unrelated edits cannot silently scrub the legacy fields;
|
||||||
|
- an editable version is migrated only through an explicit Mail-settings save
|
||||||
|
with an authorized profile; and
|
||||||
|
- a locked version remains unchanged. Creating its editable successor records
|
||||||
|
the migration while retaining the locked source as audit evidence.
|
||||||
|
|
||||||
|
Legacy execution snapshots are likewise retained but cannot be used for
|
||||||
|
delivery. Revalidate and rebuild an editable profile-only version. Normal
|
||||||
|
database backup, restore, encryption, and access controls apply to the current
|
||||||
|
database as a whole; the product does not define a separate historical-JSON or
|
||||||
|
inline-secret recovery workflow. A restored legacy row remains inert and
|
||||||
|
fail-closed under the same rules.
|
||||||
|
|
||||||
|
## Operator checks
|
||||||
|
|
||||||
|
Before live delivery, confirm that:
|
||||||
|
|
||||||
|
- the profile is active and still authorized for the campaign owner;
|
||||||
|
- SMTP and optional IMAP profile tests pass;
|
||||||
|
- validation and build occurred after the latest transport-identity change;
|
||||||
|
- append-to-Sent is enabled only when the selected profile has IMAP; and
|
||||||
|
- reports show the profile-bound snapshot revisions and delivery outcomes,
|
||||||
|
never credentials or resolved transport configuration.
|
||||||
79
docs/RECIPIENT_ADDRESS_BOUNDARY.md
Normal file
79
docs/RECIPIENT_ADDRESS_BOUNDARY.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
# Recipient And Address Management Boundary
|
||||||
|
|
||||||
|
Campaigns own campaign-local recipient entries because sending and reporting
|
||||||
|
need a frozen recipient snapshot. Long-lived address management is a separate
|
||||||
|
domain owned by `govoplan-addresses`.
|
||||||
|
|
||||||
|
## `govoplan-campaign` Owns
|
||||||
|
|
||||||
|
- campaign-local recipient entries
|
||||||
|
- campaign-local recipient import mapping and validation
|
||||||
|
- message addressing for a concrete campaign version
|
||||||
|
- send/build/report evidence for the exact recipients used
|
||||||
|
- campaign-local exclusions, warnings, and review status
|
||||||
|
- recipient-specific attachment and template evidence
|
||||||
|
|
||||||
|
Campaign data is immutable once a version is built for sending. Later address
|
||||||
|
book changes must not rewrite historical campaign evidence.
|
||||||
|
|
||||||
|
## `govoplan-addresses` Owns
|
||||||
|
|
||||||
|
- Adrema-style address management
|
||||||
|
- reusable person, organization, household, and postal-address records
|
||||||
|
- reusable email address lists and segments
|
||||||
|
- postal-letter recipient views
|
||||||
|
- consent, legal-basis, and communication-preference metadata
|
||||||
|
- deduplication and merge workflows
|
||||||
|
- import/export of reusable address directories
|
||||||
|
- address quality checks and change history
|
||||||
|
|
||||||
|
The addresses module provides the UI/module boundary for this domain and should
|
||||||
|
grow stable DTOs and capabilities that campaigns, mail, forms, reporting,
|
||||||
|
portal, and postbox modules can consume without direct imports.
|
||||||
|
|
||||||
|
## Current Integration Contract
|
||||||
|
|
||||||
|
The campaign module asks the platform registry for address capabilities and
|
||||||
|
keeps working when they are absent. It must not import `govoplan-addresses`
|
||||||
|
ORM models, services, or WebUI components.
|
||||||
|
|
||||||
|
When `addresses.lookup` is available, campaign recipient address fields use it
|
||||||
|
for autocomplete. The campaign page may warm a small suggestion cache with an
|
||||||
|
empty query and then query by typed text as the user edits sender, reply-to,
|
||||||
|
global recipient, or per-recipient address fields.
|
||||||
|
|
||||||
|
When `addresses.recipient_source` is available, campaign offers a separate
|
||||||
|
address-book/list import flow. This is for importing reusable recipient sources
|
||||||
|
into the campaign recipient table; normal one-off address entry still happens
|
||||||
|
inside the address fields while typing.
|
||||||
|
|
||||||
|
The capability should return snapshots, not live ORM objects:
|
||||||
|
|
||||||
|
- selected source id and display label
|
||||||
|
- normalized recipient rows
|
||||||
|
- provenance fields for source, segment, legal basis, and import time
|
||||||
|
- update markers so campaigns can show whether a draft is based on stale source
|
||||||
|
data
|
||||||
|
|
||||||
|
Campaign stores the resolved snapshot in the campaign version. It may keep a
|
||||||
|
reference to the address source for traceability, but the built campaign remains
|
||||||
|
auditable even if the address source changes later.
|
||||||
|
|
||||||
|
If the source revision changes after import, campaign shows a stale-source
|
||||||
|
warning and lets the user reopen the import dialog with that source preselected.
|
||||||
|
The user still chooses append or replace; campaign should not silently rewrite
|
||||||
|
recipient rows.
|
||||||
|
|
||||||
|
## Non-Goals For Campaign
|
||||||
|
|
||||||
|
Campaign should not become the global address book. It should not own:
|
||||||
|
|
||||||
|
- deduplication across campaigns
|
||||||
|
- consent lifecycle
|
||||||
|
- master-data merge policy
|
||||||
|
- address-directory permissions beyond campaign use
|
||||||
|
- postal address normalization
|
||||||
|
- reusable segmentation rules
|
||||||
|
|
||||||
|
Those belong in `govoplan-addresses` or a dedicated records/identity module when
|
||||||
|
the domain needs stronger governance.
|
||||||
87
docs/RECIPIENT_IMPORT_GUIDE.md
Normal file
87
docs/RECIPIENT_IMPORT_GUIDE.md
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
# Recipient Import Guide
|
||||||
|
|
||||||
|
Recipient import lets campaign authors turn spreadsheet-like source data into
|
||||||
|
campaign-local recipient entries. It is intentionally campaign-local:
|
||||||
|
reusable address books and Adrema-style address management belong in the
|
||||||
|
`govoplan-addresses` module.
|
||||||
|
|
||||||
|
## Supported Inputs
|
||||||
|
|
||||||
|
The current importer is designed for tabular data with a header row. CSV and
|
||||||
|
spreadsheet-derived tables should be normalized before import so the campaign UI
|
||||||
|
sees:
|
||||||
|
|
||||||
|
- column headers
|
||||||
|
- row values
|
||||||
|
- source filename and sheet name when available
|
||||||
|
- a stable ordered and unordered header fingerprint
|
||||||
|
|
||||||
|
Avoid importing production secrets or credentials as recipient fields. Recipient
|
||||||
|
custom fields may be used in templates and reports, so they should be treated as
|
||||||
|
campaign data.
|
||||||
|
|
||||||
|
## Mapping Fields
|
||||||
|
|
||||||
|
Common headers are detected automatically:
|
||||||
|
|
||||||
|
- `email`, `e_mail`, `mail`, `to`, `to_email`, `recipient`,
|
||||||
|
`recipient_email`
|
||||||
|
- `name`, `full_name`, `recipient_name`, `to_name`
|
||||||
|
- `id`, `entry_id`, `recipient_id`
|
||||||
|
|
||||||
|
Authors can map columns to address fields:
|
||||||
|
|
||||||
|
- `from`
|
||||||
|
- `to`
|
||||||
|
- `cc`
|
||||||
|
- `bcc`
|
||||||
|
- `reply_to`
|
||||||
|
|
||||||
|
Rows without a valid `to` address should remain visible with validation issues
|
||||||
|
instead of disappearing silently. Authors should be able to fix the source file,
|
||||||
|
adjust the mapping, or exclude the row before building the campaign.
|
||||||
|
|
||||||
|
## Mapping Profiles
|
||||||
|
|
||||||
|
Mapping profiles save a known column layout so repeated imports can reuse the
|
||||||
|
same mapping. The importer stores ordered and unordered header fingerprints so a
|
||||||
|
profile can distinguish exact column order from equivalent column sets.
|
||||||
|
|
||||||
|
Administrators should curate shared profiles only for stable recurring sources.
|
||||||
|
Campaign-local profiles are acceptable for one-off work and experiments.
|
||||||
|
|
||||||
|
## User Workflow
|
||||||
|
|
||||||
|
1. Open the campaign recipient/data import screen.
|
||||||
|
2. Upload or paste a tabular source.
|
||||||
|
3. Review detected headers and preview rows.
|
||||||
|
4. Pick or adjust a mapping profile.
|
||||||
|
5. Confirm validation issues, exclusions, and generated recipient ids.
|
||||||
|
6. Import into the campaign draft.
|
||||||
|
7. Build messages and review recipient-specific evidence before sending.
|
||||||
|
|
||||||
|
## Admin Workflow
|
||||||
|
|
||||||
|
Administrators should:
|
||||||
|
|
||||||
|
- define naming conventions for recurring mapping profiles
|
||||||
|
- verify that imported fields have a lawful processing basis for the campaign
|
||||||
|
- keep reusable address-directory ownership out of campaigns because
|
||||||
|
`govoplan-addresses` owns that domain
|
||||||
|
- use campaign reports and audit evidence to trace which source produced which
|
||||||
|
recipient entries
|
||||||
|
- remove obsolete shared profiles when an upstream source layout changes
|
||||||
|
|
||||||
|
## Evidence Expectations
|
||||||
|
|
||||||
|
The campaign should preserve enough evidence to explain a send:
|
||||||
|
|
||||||
|
- source filename and sheet name where available
|
||||||
|
- header fingerprints
|
||||||
|
- mapping profile id/name when used
|
||||||
|
- row number or source id
|
||||||
|
- validation status and exclusion reason
|
||||||
|
- final recipient addresses used for the built message
|
||||||
|
|
||||||
|
The evidence should be available in reports without requiring the original
|
||||||
|
source file to be reprocessed.
|
||||||
50
examples/README.md
Normal file
50
examples/README.md
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# GovOPlaN Campaign Examples
|
||||||
|
|
||||||
|
These examples are the maintained scenario catalogue for campaign release
|
||||||
|
checks. They are intentionally small and credential-free. Add concrete fixture
|
||||||
|
files next to this README only when they can be validated by the current
|
||||||
|
campaign schema and do not require production data.
|
||||||
|
|
||||||
|
## Scenarios
|
||||||
|
|
||||||
|
| Scenario | Required Modules | Release Check |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| [`simple-announcement`](simple-announcement/campaign.json) | core, access, campaigns | Validate and build one active recipient without attachments while Mail and Files are absent. |
|
||||||
|
| `addressing-matrix` | core, access, campaigns | Exercise To, CC, BCC, Reply-To, bounce, and disposition-notification fields. |
|
||||||
|
| `global-attachment` | core, access, campaigns; optional files | Build one deterministic attachment and verify evidence. |
|
||||||
|
| `recipient-attachment-rules` | core, access, campaigns; optional files | Match recipient-specific attachment rules and verify per-recipient evidence. |
|
||||||
|
| `zip-protected` | core, access, campaigns | Build password-protected AES ZIP output and verify password-source metadata. |
|
||||||
|
| `mail-profile-send` | core, access, campaigns, mail | Select a reusable mail profile and send through the GreenMail test bed. |
|
||||||
|
| `legacy-inline-mail-rejected` | core, access, campaigns, mail | Confirm legacy campaign-local SMTP/IMAP data fails closed and requires explicit profile migration. |
|
||||||
|
| `warnings-review` | core, access, campaigns | Require explicit review before queueing jobs with warnings. |
|
||||||
|
| `blocked-send` | core, access, campaigns | Confirm blocked recipients or missing attachments cannot be queued. |
|
||||||
|
| `mock-delivery` | core, access, campaigns, mail with dev capability | Capture messages in the development mailbox. |
|
||||||
|
| [`greenmail-delivery`](greenmail-delivery/campaign.json) | core, access, audit, campaigns, mail | Run a credential-free Campaign through a Mail-owned profile, GreenMail SMTP/IMAP, report/audit checks, repeat-send protection, and bounded failure drills. |
|
||||||
|
|
||||||
|
## Fixture Rules
|
||||||
|
|
||||||
|
- Do not commit real recipients, mail credentials, or production attachment
|
||||||
|
names.
|
||||||
|
- Keep attachments deterministic and small.
|
||||||
|
- Store transport secrets only in encrypted Mail profiles or local `.env`
|
||||||
|
values consumed directly by the test bed, never in campaign JSON.
|
||||||
|
- Declare optional module requirements in fixture metadata.
|
||||||
|
- Fixtures must not import files or mail modules directly; optional behavior is
|
||||||
|
discovered through core module metadata and capabilities.
|
||||||
|
|
||||||
|
## Validation Flow
|
||||||
|
|
||||||
|
Before a release tag:
|
||||||
|
|
||||||
|
1. Run module permutation startup checks from core.
|
||||||
|
2. Run `python -m unittest discover -s tests -p 'test_example_campaigns.py'`
|
||||||
|
from this repository. The acceptance test copies each maintained fixture to
|
||||||
|
an unrelated temporary workspace before using Campaign's public loader,
|
||||||
|
validator, and message builder.
|
||||||
|
3. Validate every committed example fixture against the current campaign schema.
|
||||||
|
4. Build exact messages for each fixture.
|
||||||
|
5. Run the mock-delivery example when the dev mailbox capability is enabled.
|
||||||
|
6. Run `dev/mail-testbed/run_transport_smoke.py` for low-level transport and attachment variants.
|
||||||
|
7. Run `dev/mail-testbed/run_campaign_acceptance.py` for the Campaign journey and bounded evidence.
|
||||||
|
8. Execute the delivery checklist in
|
||||||
|
`docs/EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md`.
|
||||||
88
examples/greenmail-delivery/campaign.json
Normal file
88
examples/greenmail-delivery/campaign.json
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
{
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {
|
||||||
|
"id": "greenmail-delivery",
|
||||||
|
"name": "GreenMail delivery acceptance",
|
||||||
|
"description": "Credential-free Campaign fixture for the local SMTP/IMAP acceptance test bed.",
|
||||||
|
"mode": "test"
|
||||||
|
},
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"name": "display_name",
|
||||||
|
"type": "string",
|
||||||
|
"label": "Display name",
|
||||||
|
"required": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "acceptance_run",
|
||||||
|
"type": "string",
|
||||||
|
"label": "Acceptance run",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "00000000-0000-4000-8000-000000000001"
|
||||||
|
},
|
||||||
|
"recipients": {
|
||||||
|
"from": [
|
||||||
|
{
|
||||||
|
"email": "campaign-test@govoplan.test",
|
||||||
|
"name": "GovOPlaN acceptance",
|
||||||
|
"type": "to"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"allow_individual_to": true
|
||||||
|
},
|
||||||
|
"template": {
|
||||||
|
"subject": "[GovOPlaN acceptance ${acceptance_run}] Campaign delivery",
|
||||||
|
"text": "Hello ${display_name},\n\nThis is an isolated GovOPlaN Campaign SMTP/IMAP acceptance message.\n",
|
||||||
|
"body_mode": "text"
|
||||||
|
},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": ".",
|
||||||
|
"send_without_attachments_behavior": "continue",
|
||||||
|
"global": []
|
||||||
|
},
|
||||||
|
"entries": {
|
||||||
|
"inline": [
|
||||||
|
{
|
||||||
|
"id": "greenmail-recipient",
|
||||||
|
"to": [
|
||||||
|
{
|
||||||
|
"email": "campaign-test@govoplan.test",
|
||||||
|
"name": "GreenMail recipient",
|
||||||
|
"type": "to"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"fields": {
|
||||||
|
"display_name": "GreenMail recipient",
|
||||||
|
"acceptance_run": "fixture"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"validation_policy": {
|
||||||
|
"missing_email": "block",
|
||||||
|
"template_error": "block"
|
||||||
|
},
|
||||||
|
"delivery": {
|
||||||
|
"rate_limit": {
|
||||||
|
"messages_per_minute": 60
|
||||||
|
},
|
||||||
|
"retry": {
|
||||||
|
"max_attempts": 3,
|
||||||
|
"backoff_seconds": [
|
||||||
|
1,
|
||||||
|
5,
|
||||||
|
30
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"imap_append_sent": {
|
||||||
|
"enabled": true,
|
||||||
|
"folder": "Sent"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"status_tracking": {
|
||||||
|
"enabled": true
|
||||||
|
}
|
||||||
|
}
|
||||||
22
examples/greenmail-delivery/fixture.json
Normal file
22
examples/greenmail-delivery/fixture.json
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
{
|
||||||
|
"scenario": "greenmail-delivery",
|
||||||
|
"campaign_file": "campaign.json",
|
||||||
|
"required_modules": [
|
||||||
|
"core",
|
||||||
|
"access",
|
||||||
|
"audit",
|
||||||
|
"campaigns",
|
||||||
|
"mail"
|
||||||
|
],
|
||||||
|
"required_capabilities": [
|
||||||
|
"mail.campaign_delivery"
|
||||||
|
],
|
||||||
|
"transport": "local GreenMail SMTP/IMAP test bed",
|
||||||
|
"credentials": "local environment only; never copied into Campaign JSON or evidence",
|
||||||
|
"expected": {
|
||||||
|
"entries_count": 1,
|
||||||
|
"built_count": 1,
|
||||||
|
"smtp_accepted_count": 1,
|
||||||
|
"imap_appended_count": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
54
examples/simple-announcement/campaign.json
Normal file
54
examples/simple-announcement/campaign.json
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
{
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {
|
||||||
|
"id": "simple-announcement",
|
||||||
|
"name": "Simple announcement",
|
||||||
|
"description": "Credential-free release fixture for Campaign validation and message building.",
|
||||||
|
"mode": "test"
|
||||||
|
},
|
||||||
|
"fields": [
|
||||||
|
{
|
||||||
|
"name": "display_name",
|
||||||
|
"type": "string",
|
||||||
|
"label": "Display name",
|
||||||
|
"required": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"recipients": {
|
||||||
|
"from": [
|
||||||
|
{
|
||||||
|
"email": "announcements@example.test",
|
||||||
|
"name": "GovOPlaN Example",
|
||||||
|
"type": "to"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"allow_individual_to": true
|
||||||
|
},
|
||||||
|
"template": {
|
||||||
|
"subject": "Planned service maintenance for ${display_name}",
|
||||||
|
"text": "Hello ${display_name},\n\nThe example service will be unavailable during the announced maintenance window.\n\nThis message was built locally and was not sent.\n",
|
||||||
|
"body_mode": "text"
|
||||||
|
},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": ".",
|
||||||
|
"send_without_attachments_behavior": "continue",
|
||||||
|
"global": []
|
||||||
|
},
|
||||||
|
"entries": {
|
||||||
|
"inline": [
|
||||||
|
{
|
||||||
|
"id": "example-recipient",
|
||||||
|
"to": [
|
||||||
|
{
|
||||||
|
"email": "recipient@example.test",
|
||||||
|
"name": "Example Recipient",
|
||||||
|
"type": "to"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"fields": {
|
||||||
|
"display_name": "Example Recipient"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
23
examples/simple-announcement/fixture.json
Normal file
23
examples/simple-announcement/fixture.json
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
{
|
||||||
|
"schema_version": 1,
|
||||||
|
"id": "simple-announcement",
|
||||||
|
"campaign_file": "campaign.json",
|
||||||
|
"required_modules": [
|
||||||
|
"core",
|
||||||
|
"access",
|
||||||
|
"campaigns"
|
||||||
|
],
|
||||||
|
"absent_optional_modules": [
|
||||||
|
"files",
|
||||||
|
"mail"
|
||||||
|
],
|
||||||
|
"external_effects": "forbidden",
|
||||||
|
"expected": {
|
||||||
|
"campaign_id": "simple-announcement",
|
||||||
|
"entries_count": 1,
|
||||||
|
"built_count": 1,
|
||||||
|
"queueable_count": 1,
|
||||||
|
"attachment_count": 0,
|
||||||
|
"subject": "Planned service maintenance for Example Recipient"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@govoplan/campaign-webui",
|
"name": "@govoplan/campaign-webui",
|
||||||
"version": "0.1.1",
|
"version": "0.1.11",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "webui/src/index.ts",
|
"main": "webui/src/index.ts",
|
||||||
@@ -18,9 +18,12 @@
|
|||||||
"README.md",
|
"README.md",
|
||||||
"LICENSE"
|
"LICENSE"
|
||||||
],
|
],
|
||||||
|
"dependencies": {
|
||||||
|
"read-excel-file": "9.2.0"
|
||||||
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@govoplan/core-webui": "^0.1.1",
|
"@govoplan/core-webui": "^0.1.12",
|
||||||
"lucide-react": "^0.555.0",
|
"lucide-react": "^1.23.0",
|
||||||
"react": "^19.0.0",
|
"react": "^19.0.0",
|
||||||
"react-dom": "^19.0.0",
|
"react-dom": "^19.0.0",
|
||||||
"react-router-dom": "^7.1.1"
|
"react-router-dom": "^7.1.1"
|
||||||
|
|||||||
@@ -4,18 +4,18 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "govoplan-campaign"
|
name = "govoplan-campaign"
|
||||||
version = "0.1.2"
|
version = "0.1.11"
|
||||||
description = "GovOPlaN campaigns module with backend and WebUI integration."
|
description = "GovOPlaN campaigns module with backend and WebUI integration."
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.12"
|
requires-python = ">=3.12"
|
||||||
license = { file = "LICENSE" }
|
license = { file = "LICENSE" }
|
||||||
authors = [{ name = "GovOPlaN" }]
|
authors = [{ name = "GovOPlaN" }]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"govoplan-core>=0.1.2",
|
"govoplan-core>=0.1.8",
|
||||||
"jsonschema>=4,<5",
|
"jsonschema>=4,<5",
|
||||||
"pydantic>=2,<3",
|
"pydantic>=2,<3",
|
||||||
"SQLAlchemy>=2,<3",
|
"SQLAlchemy>=2,<3",
|
||||||
"pyzipper>=0.3,<1",
|
"pyzipper>=0.4,<1",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
[tool.setuptools.packages.find]
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import fnmatch
|
import fnmatch
|
||||||
import re
|
|
||||||
import time
|
import time
|
||||||
from dataclasses import dataclass, field
|
from dataclasses import dataclass, field
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
@@ -13,6 +12,12 @@ from pydantic import BaseModel, ConfigDict, Field
|
|||||||
from govoplan_campaign.backend.campaign.entries import load_campaign_entries
|
from govoplan_campaign.backend.campaign.entries import load_campaign_entries
|
||||||
from govoplan_campaign.backend.campaign.template_values import build_template_values
|
from govoplan_campaign.backend.campaign.template_values import build_template_values
|
||||||
from govoplan_campaign.backend.campaign.models import AttachmentBasePathConfig, AttachmentConfig, Behavior, CampaignConfig, EntryConfig, ZipArchiveConfig, ZipRuleMode
|
from govoplan_campaign.backend.campaign.models import AttachmentBasePathConfig, AttachmentConfig, Behavior, CampaignConfig, EntryConfig, ZipArchiveConfig, ZipRuleMode
|
||||||
|
from govoplan_campaign.backend.path_security import (
|
||||||
|
CampaignPathSecurityError,
|
||||||
|
assert_logical_relative_path,
|
||||||
|
is_managed_source,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.template_rendering import render_template
|
||||||
|
|
||||||
|
|
||||||
class AttachmentScope(StrEnum):
|
class AttachmentScope(StrEnum):
|
||||||
@@ -140,43 +145,8 @@ def _resolve_path(campaign_file: str | Path, raw_path: str) -> Path:
|
|||||||
return (campaign_path.parent / path).resolve()
|
return (campaign_path.parent / path).resolve()
|
||||||
|
|
||||||
|
|
||||||
_DOLLAR_FIELD_PATTERN = re.compile(r"(?<!\\)\$\{(.*?)(?<!\\)\}")
|
|
||||||
_BRACE_FIELD_PATTERN = re.compile(r"(?<!\\)\{\{\s*(.*?)\s*\}\}")
|
|
||||||
|
|
||||||
|
|
||||||
def _normalize_template_key(raw: str) -> str:
|
|
||||||
key = raw.strip()
|
|
||||||
if key.startswith("fields."):
|
|
||||||
key = key.removeprefix("fields.")
|
|
||||||
elif key.startswith("local."):
|
|
||||||
key = "local::" + key.removeprefix("local.")
|
|
||||||
elif key.startswith("global."):
|
|
||||||
key = "global::" + key.removeprefix("global.")
|
|
||||||
|
|
||||||
if key.startswith("local::") or key.startswith("global::"):
|
|
||||||
return key
|
|
||||||
if key.startswith("local:"):
|
|
||||||
return "local::" + key.removeprefix("local:")
|
|
||||||
if key.startswith("global:"):
|
|
||||||
return "global::" + key.removeprefix("global:")
|
|
||||||
return key
|
|
||||||
|
|
||||||
|
|
||||||
def _render_template(template: str, values: dict[str, Any]) -> str:
|
|
||||||
def replace(match: re.Match[str]) -> str:
|
|
||||||
key = _normalize_template_key(match.group(1))
|
|
||||||
if key in values:
|
|
||||||
value = values[key]
|
|
||||||
return "" if value is None else str(value)
|
|
||||||
return match.group(0)
|
|
||||||
|
|
||||||
rendered = _DOLLAR_FIELD_PATTERN.sub(replace, template)
|
|
||||||
rendered = _BRACE_FIELD_PATTERN.sub(replace, rendered)
|
|
||||||
return rendered.replace(r"\${", "${").replace(r"\}", "}")
|
|
||||||
|
|
||||||
|
|
||||||
def _rendered_base_dir(config: AttachmentConfig, values: dict[str, Any]) -> str:
|
def _rendered_base_dir(config: AttachmentConfig, values: dict[str, Any]) -> str:
|
||||||
rendered = _render_template(config.base_dir, values).strip()
|
rendered = render_template(config.base_dir, values, keep_missing=True).strip()
|
||||||
return rendered or "."
|
return rendered or "."
|
||||||
|
|
||||||
|
|
||||||
@@ -260,7 +230,7 @@ def _attachment_zip_archive(
|
|||||||
def _render_zip_filename(archive: ZipArchiveConfig | None, values: dict[str, Any]) -> str | None:
|
def _render_zip_filename(archive: ZipArchiveConfig | None, values: dict[str, Any]) -> str | None:
|
||||||
if archive is None:
|
if archive is None:
|
||||||
return None
|
return None
|
||||||
rendered = _render_template(archive.name or "attachments.zip", values).strip() or "attachments.zip"
|
rendered = render_template(archive.name or "attachments.zip", values, keep_missing=True).strip() or "attachments.zip"
|
||||||
return rendered if rendered.lower().endswith(".zip") else f"{rendered}.zip"
|
return rendered if rendered.lower().endswith(".zip") else f"{rendered}.zip"
|
||||||
|
|
||||||
|
|
||||||
@@ -369,6 +339,23 @@ def _match_files(directory: Path, file_filter: str, include_subdirs: bool, match
|
|||||||
return sorted(path for path in directory.glob(file_filter) if path.is_file())
|
return sorted(path for path in directory.glob(file_filter) if path.is_file())
|
||||||
|
|
||||||
|
|
||||||
|
def _confine_managed_matches(directory: Path, matches: list[Path]) -> tuple[list[Path], bool]:
|
||||||
|
root = directory.resolve()
|
||||||
|
confined: list[Path] = []
|
||||||
|
rejected = False
|
||||||
|
for match in matches:
|
||||||
|
try:
|
||||||
|
resolved = match.resolve()
|
||||||
|
except (OSError, RuntimeError):
|
||||||
|
rejected = True
|
||||||
|
continue
|
||||||
|
if not resolved.is_relative_to(root):
|
||||||
|
rejected = True
|
||||||
|
continue
|
||||||
|
confined.append(match)
|
||||||
|
return confined, rejected
|
||||||
|
|
||||||
|
|
||||||
def _issue_for_missing(config: AttachmentConfig, behavior: Behavior) -> AttachmentIssue:
|
def _issue_for_missing(config: AttachmentConfig, behavior: Behavior) -> AttachmentIssue:
|
||||||
code = "missing_required_attachment" if config.required else "missing_optional_attachment"
|
code = "missing_required_attachment" if config.required else "missing_optional_attachment"
|
||||||
severity = ResolutionSeverity.ERROR if config.required and behavior == Behavior.BLOCK else ResolutionSeverity.WARNING
|
severity = ResolutionSeverity.ERROR if config.required and behavior == Behavior.BLOCK else ResolutionSeverity.WARNING
|
||||||
@@ -390,6 +377,27 @@ def _issue_for_ambiguous(config: AttachmentConfig, behavior: Behavior, match_cou
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _send_without_attachments_behavior(config: CampaignConfig) -> Behavior:
|
||||||
|
return config.attachments.send_without_attachments_behavior or (
|
||||||
|
Behavior.CONTINUE if config.attachments.send_without_attachments else Behavior.BLOCK
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _issue_for_missing_attachment_coverage(behavior: Behavior) -> AttachmentIssue:
|
||||||
|
messages = {
|
||||||
|
Behavior.BLOCK: "No attachment file was resolved for this message, and campaign policy blocks sending without attachments.",
|
||||||
|
Behavior.ASK: "No attachment file was resolved for this message. Confirm the message should still be sent.",
|
||||||
|
Behavior.DROP: "No attachment file was resolved for this message. Campaign policy excludes messages without attachments.",
|
||||||
|
Behavior.WARN: "No attachment file was resolved for this message. Campaign policy allows sending with a warning.",
|
||||||
|
}
|
||||||
|
return AttachmentIssue(
|
||||||
|
severity=ResolutionSeverity.ERROR if behavior == Behavior.BLOCK else ResolutionSeverity.WARNING,
|
||||||
|
code="missing_attachment_coverage",
|
||||||
|
message=messages.get(behavior, "No attachment file was resolved for this message."),
|
||||||
|
behavior=behavior,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _resolve_one_config(
|
def _resolve_one_config(
|
||||||
*,
|
*,
|
||||||
campaign_file: str | Path,
|
campaign_file: str | Path,
|
||||||
@@ -401,20 +409,57 @@ def _resolve_one_config(
|
|||||||
match_index: AttachmentMatchIndex | None = None,
|
match_index: AttachmentMatchIndex | None = None,
|
||||||
) -> ResolvedAttachment:
|
) -> ResolvedAttachment:
|
||||||
rendered_base_dir = _rendered_base_dir(config, values)
|
rendered_base_dir = _rendered_base_dir(config, values)
|
||||||
rendered_file_filter = _render_template(config.file_filter, values)
|
rendered_file_filter = render_template(config.file_filter, values, keep_missing=True)
|
||||||
directory, selected_base_path = _resolve_attachment_directory(
|
directory, selected_base_path = _resolve_attachment_directory(
|
||||||
campaign_file=campaign_file,
|
campaign_file=campaign_file,
|
||||||
campaign_config=campaign_config,
|
campaign_config=campaign_config,
|
||||||
attachment_config=config,
|
attachment_config=config,
|
||||||
rendered_base_dir=rendered_base_dir,
|
rendered_base_dir=rendered_base_dir,
|
||||||
)
|
)
|
||||||
matches = _match_files(directory, rendered_file_filter, config.include_subdirs, match_index)
|
|
||||||
allow_multiple = _rule_allows_multiple(config, rendered_file_filter)
|
allow_multiple = _rule_allows_multiple(config, rendered_file_filter)
|
||||||
|
|
||||||
issues: list[AttachmentIssue] = []
|
issues: list[AttachmentIssue] = []
|
||||||
behavior: Behavior | None = None
|
behavior: Behavior | None = None
|
||||||
|
managed_source = selected_base_path is not None and is_managed_source(selected_base_path.source)
|
||||||
|
unsafe_managed_path = False
|
||||||
|
if managed_source:
|
||||||
|
try:
|
||||||
|
assert_logical_relative_path(
|
||||||
|
rendered_file_filter,
|
||||||
|
field="rendered managed attachment file_filter",
|
||||||
|
)
|
||||||
|
except CampaignPathSecurityError as exc:
|
||||||
|
matches = []
|
||||||
|
unsafe_managed_path = True
|
||||||
|
issues.append(
|
||||||
|
AttachmentIssue(
|
||||||
|
severity=ResolutionSeverity.ERROR,
|
||||||
|
code="unsafe_managed_attachment_path",
|
||||||
|
message=str(exc),
|
||||||
|
behavior=Behavior.BLOCK,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
matches = _match_files(directory, rendered_file_filter, config.include_subdirs, match_index)
|
||||||
|
matches, rejected = _confine_managed_matches(directory, matches)
|
||||||
|
if rejected:
|
||||||
|
matches = []
|
||||||
|
unsafe_managed_path = True
|
||||||
|
issues.append(
|
||||||
|
AttachmentIssue(
|
||||||
|
severity=ResolutionSeverity.ERROR,
|
||||||
|
code="managed_attachment_path_escape",
|
||||||
|
message="A managed attachment match resolved outside its materialized source directory.",
|
||||||
|
behavior=Behavior.BLOCK,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
matches = _match_files(directory, rendered_file_filter, config.include_subdirs, match_index)
|
||||||
|
|
||||||
if not matches:
|
if unsafe_managed_path:
|
||||||
|
status = AttachmentMatchStatus.MISSING
|
||||||
|
behavior = Behavior.BLOCK
|
||||||
|
elif not matches:
|
||||||
status = AttachmentMatchStatus.MISSING
|
status = AttachmentMatchStatus.MISSING
|
||||||
behavior = _missing_behavior(campaign_config, config)
|
behavior = _missing_behavior(campaign_config, config)
|
||||||
issues.append(_issue_for_missing(config, behavior))
|
issues.append(_issue_for_missing(config, behavior))
|
||||||
@@ -495,6 +540,15 @@ def resolve_entry_attachments(
|
|||||||
)
|
)
|
||||||
|
|
||||||
issues = [issue for item in resolved for issue in item.issues]
|
issues = [issue for item in resolved for issue in item.issues]
|
||||||
|
missing_coverage_behavior = _send_without_attachments_behavior(config)
|
||||||
|
if (
|
||||||
|
entry.active
|
||||||
|
and resolved
|
||||||
|
and missing_coverage_behavior != Behavior.CONTINUE
|
||||||
|
and sum(len(item.matches) for item in resolved) == 0
|
||||||
|
and not any(issue.behavior == Behavior.BLOCK for issue in issues)
|
||||||
|
):
|
||||||
|
issues.append(_issue_for_missing_attachment_coverage(missing_coverage_behavior))
|
||||||
return EntryAttachmentResolution(
|
return EntryAttachmentResolution(
|
||||||
entry_index=entry_index,
|
entry_index=entry_index,
|
||||||
entry_id=entry.id,
|
entry_id=entry.id,
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from typing import Any
|
|||||||
|
|
||||||
from jsonschema import Draft202012Validator, FormatChecker
|
from jsonschema import Draft202012Validator, FormatChecker
|
||||||
|
|
||||||
|
from .mail_profile_boundary import assert_campaign_uses_mail_profile_reference
|
||||||
from .models import CampaignConfig
|
from .models import CampaignConfig
|
||||||
|
|
||||||
|
|
||||||
@@ -83,6 +84,7 @@ def load_campaign_config(
|
|||||||
schema_path: str | Path | None = None,
|
schema_path: str | Path | None = None,
|
||||||
) -> CampaignConfig:
|
) -> CampaignConfig:
|
||||||
data = load_campaign_json(path)
|
data = load_campaign_json(path)
|
||||||
|
assert_campaign_uses_mail_profile_reference(data)
|
||||||
if validate_schema:
|
if validate_schema:
|
||||||
validate_against_schema(data, schema_path=schema_path)
|
validate_against_schema(data, schema_path=schema_path)
|
||||||
return CampaignConfig.model_validate(data)
|
return CampaignConfig.model_validate(data)
|
||||||
|
|||||||
258
src/govoplan_campaign/backend/campaign/mail_profile_boundary.py
Normal file
258
src/govoplan_campaign/backend/campaign/mail_profile_boundary.py
Normal file
@@ -0,0 +1,258 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import copy
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
|
||||||
|
CAMPAIGN_MAIL_SERVER_KEYS = frozenset({"mail_profile_id"})
|
||||||
|
CAMPAIGN_CLIENT_EDITOR_STATE_KEYS = frozenset({"created_from", "field_overrides", "opt_ins"})
|
||||||
|
CAMPAIGN_OPT_IN_KEYS = frozenset(
|
||||||
|
{"campaign_address_suggestions", "remember_used_addresses", "inline_guidance"}
|
||||||
|
)
|
||||||
|
CAMPAIGN_REVIEW_STATE_KEYS = frozenset(
|
||||||
|
{
|
||||||
|
"build_token",
|
||||||
|
"inspection_complete",
|
||||||
|
"reviewed_message_keys",
|
||||||
|
"updated_at",
|
||||||
|
"updated_by_user_id",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignMailProfileBoundaryError(ValueError):
|
||||||
|
"""Raised when campaign JSON owns mail transport configuration.
|
||||||
|
|
||||||
|
SMTP/IMAP endpoints and credentials are Mail-module data. Campaign JSON
|
||||||
|
may select one Mail-owned profile, but it must never copy or override that
|
||||||
|
profile's transport configuration.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_opt_ins(value: Any) -> dict[str, bool]:
|
||||||
|
if not isinstance(value, dict) or any(
|
||||||
|
key not in CAMPAIGN_OPT_IN_KEYS for key in value
|
||||||
|
):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign editor opt_ins contains unsupported fields"
|
||||||
|
)
|
||||||
|
if any(not isinstance(item, bool) for item in value.values()):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign editor opt_ins values must be booleans"
|
||||||
|
)
|
||||||
|
return copy.deepcopy(value)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_field_override(key: Any, value: Any) -> bool:
|
||||||
|
return (
|
||||||
|
isinstance(key, str)
|
||||||
|
and bool(key.strip())
|
||||||
|
and len(key) <= 256
|
||||||
|
and isinstance(value, bool)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_field_overrides(value: Any) -> dict[str, bool]:
|
||||||
|
if not isinstance(value, dict) or len(value) > 10_000:
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign editor field_overrides must be a bounded object"
|
||||||
|
)
|
||||||
|
if any(not _is_valid_field_override(key, item) for key, item in value.items()):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign editor field_overrides must map short field names to booleans"
|
||||||
|
)
|
||||||
|
return copy.deepcopy(value)
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_required_string(value: Any, *, max_length: int, error: str) -> str:
|
||||||
|
if not isinstance(value, str) or not value.strip() or len(value) > max_length:
|
||||||
|
raise CampaignMailProfileBoundaryError(error)
|
||||||
|
return value.strip()
|
||||||
|
|
||||||
|
|
||||||
|
def validate_campaign_editor_state(
|
||||||
|
value: dict[str, Any] | None,
|
||||||
|
*,
|
||||||
|
allow_server_review_state: bool = False,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Validate the bounded Campaign-owned UI metadata contract.
|
||||||
|
|
||||||
|
Arbitrary editor metadata would be a second, weakly typed persistence and
|
||||||
|
response channel for Mail credentials. Review evidence is server-owned and
|
||||||
|
cannot be supplied through ordinary version create/update requests.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if value is None:
|
||||||
|
return {}
|
||||||
|
if not isinstance(value, dict):
|
||||||
|
raise CampaignMailProfileBoundaryError("Campaign editor state must be an object")
|
||||||
|
allowed = set(CAMPAIGN_CLIENT_EDITOR_STATE_KEYS)
|
||||||
|
if allow_server_review_state:
|
||||||
|
allowed.add("review_send")
|
||||||
|
if any(key not in allowed for key in value):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign editor state contains unsupported or transport-owned fields"
|
||||||
|
)
|
||||||
|
|
||||||
|
result: dict[str, Any] = {}
|
||||||
|
if "created_from" in value:
|
||||||
|
result["created_from"] = _validated_required_string(
|
||||||
|
value["created_from"],
|
||||||
|
max_length=128,
|
||||||
|
error="Campaign editor created_from must be a short string",
|
||||||
|
)
|
||||||
|
if "opt_ins" in value:
|
||||||
|
result["opt_ins"] = _validated_opt_ins(value["opt_ins"])
|
||||||
|
if "field_overrides" in value:
|
||||||
|
result["field_overrides"] = _validated_field_overrides(
|
||||||
|
value["field_overrides"]
|
||||||
|
)
|
||||||
|
if "review_send" in value:
|
||||||
|
result["review_send"] = _validated_server_review_state(value["review_send"])
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def public_campaign_editor_state(
|
||||||
|
value: Any,
|
||||||
|
*,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return only known non-secret UI metadata from current or legacy rows."""
|
||||||
|
|
||||||
|
if not isinstance(value, dict):
|
||||||
|
return {}
|
||||||
|
result: dict[str, Any] = {}
|
||||||
|
for key in CAMPAIGN_CLIENT_EDITOR_STATE_KEYS:
|
||||||
|
if key not in value:
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
result.update(validate_campaign_editor_state({key: value[key]}))
|
||||||
|
except CampaignMailProfileBoundaryError:
|
||||||
|
continue
|
||||||
|
if "review_send" in value:
|
||||||
|
try:
|
||||||
|
review_state = _validated_server_review_state(value["review_send"])
|
||||||
|
if not include_diagnostics:
|
||||||
|
review_state.pop("build_token", None)
|
||||||
|
result["review_send"] = review_state
|
||||||
|
except CampaignMailProfileBoundaryError:
|
||||||
|
pass
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def campaign_editor_state_for_edit(value: Any) -> dict[str, Any]:
|
||||||
|
"""Copy only client-owned safe metadata into a new editable version."""
|
||||||
|
|
||||||
|
state = public_campaign_editor_state(value)
|
||||||
|
state.pop("review_send", None)
|
||||||
|
return state
|
||||||
|
|
||||||
|
|
||||||
|
def _is_valid_reviewed_message_key(value: Any) -> bool:
|
||||||
|
return isinstance(value, str) and bool(value.strip()) and len(value) <= 512
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_reviewed_message_keys(value: Any) -> list[str]:
|
||||||
|
if not isinstance(value, list) or len(value) > 100_000:
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign reviewed message keys are invalid"
|
||||||
|
)
|
||||||
|
if any(not _is_valid_reviewed_message_key(key) for key in value):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign reviewed message keys are invalid"
|
||||||
|
)
|
||||||
|
return list(dict.fromkeys(key.strip() for key in value))
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_review_actor(value: Any) -> str | None:
|
||||||
|
if value is not None and (not isinstance(value, str) or len(value) > 256):
|
||||||
|
raise CampaignMailProfileBoundaryError("Campaign review actor is invalid")
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
def _validated_server_review_state(value: Any) -> dict[str, Any]:
|
||||||
|
if not isinstance(value, dict) or any(
|
||||||
|
key not in CAMPAIGN_REVIEW_STATE_KEYS for key in value
|
||||||
|
):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign review editor state is invalid"
|
||||||
|
)
|
||||||
|
build_token = value.get("build_token")
|
||||||
|
inspected = value.get("inspection_complete")
|
||||||
|
keys = value.get("reviewed_message_keys", [])
|
||||||
|
updated_at = value.get("updated_at")
|
||||||
|
updated_by = value.get("updated_by_user_id")
|
||||||
|
validated_build_token = _validated_required_string(
|
||||||
|
build_token,
|
||||||
|
max_length=256,
|
||||||
|
error="Campaign review build token is invalid",
|
||||||
|
)
|
||||||
|
if not isinstance(inspected, bool):
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign review completion state is invalid"
|
||||||
|
)
|
||||||
|
validated_keys = _validated_reviewed_message_keys(keys)
|
||||||
|
validated_updated_at = _validated_required_string(
|
||||||
|
updated_at,
|
||||||
|
max_length=128,
|
||||||
|
error="Campaign review timestamp is invalid",
|
||||||
|
)
|
||||||
|
validated_updated_by = _validated_review_actor(updated_by)
|
||||||
|
return {
|
||||||
|
"build_token": validated_build_token,
|
||||||
|
"inspection_complete": inspected,
|
||||||
|
"reviewed_message_keys": validated_keys,
|
||||||
|
"updated_at": validated_updated_at,
|
||||||
|
"updated_by_user_id": validated_updated_by,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def campaign_mail_profile_id(raw_json: dict[str, Any] | None) -> str | None:
|
||||||
|
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
||||||
|
if not isinstance(server, dict):
|
||||||
|
return None
|
||||||
|
value = server.get("mail_profile_id")
|
||||||
|
if not isinstance(value, str):
|
||||||
|
return None
|
||||||
|
normalized = value.strip()
|
||||||
|
return normalized or None
|
||||||
|
|
||||||
|
|
||||||
|
def campaign_mail_profile_boundary_violations(raw_json: dict[str, Any] | None) -> tuple[str, ...]:
|
||||||
|
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
||||||
|
if not isinstance(server, dict):
|
||||||
|
return ()
|
||||||
|
|
||||||
|
violations = [f"/server/{key}" for key in sorted(server) if key not in CAMPAIGN_MAIL_SERVER_KEYS]
|
||||||
|
if "mail_profile_id" in server:
|
||||||
|
profile_id = server["mail_profile_id"]
|
||||||
|
if not isinstance(profile_id, str) or not profile_id.strip():
|
||||||
|
violations.append("/server/mail_profile_id")
|
||||||
|
return tuple(violations)
|
||||||
|
|
||||||
|
|
||||||
|
def assert_campaign_uses_mail_profile_reference(
|
||||||
|
raw_json: dict[str, Any] | None,
|
||||||
|
*,
|
||||||
|
require_profile: bool = False,
|
||||||
|
) -> None:
|
||||||
|
violations = campaign_mail_profile_boundary_violations(raw_json)
|
||||||
|
if violations:
|
||||||
|
fields = ", ".join(violations)
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign JSON may only reference a Mail-module profile through "
|
||||||
|
f"server.mail_profile_id; remove campaign-local SMTP/IMAP settings ({fields}), "
|
||||||
|
"select an authorized Mail profile, and save a new campaign version."
|
||||||
|
)
|
||||||
|
if require_profile and campaign_mail_profile_id(raw_json) is None:
|
||||||
|
raise CampaignMailProfileBoundaryError(
|
||||||
|
"Campaign delivery requires server.mail_profile_id. Select an authorized, active "
|
||||||
|
"profile from the Mail module and validate the campaign again."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def public_campaign_mail_server(raw_json: dict[str, Any] | None) -> dict[str, str]:
|
||||||
|
"""Return the complete public/persisted Campaign-to-Mail contract."""
|
||||||
|
|
||||||
|
profile_id = campaign_mail_profile_id(raw_json)
|
||||||
|
return {"mail_profile_id": profile_id} if profile_id else {}
|
||||||
@@ -6,8 +6,6 @@ from typing import Any, Literal
|
|||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
|
from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
|
||||||
|
|
||||||
from govoplan_core.mail.config import ImapConfig, ImapServerConfig, SmtpConfig, SmtpServerConfig, TransportCredentials, TransportSecurity
|
|
||||||
|
|
||||||
|
|
||||||
class StrictModel(BaseModel):
|
class StrictModel(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid", populate_by_name=True)
|
model_config = ConfigDict(extra="forbid", populate_by_name=True)
|
||||||
@@ -24,7 +22,7 @@ class FieldType(StrEnum):
|
|||||||
INTEGER = "integer"
|
INTEGER = "integer"
|
||||||
DOUBLE = "double"
|
DOUBLE = "double"
|
||||||
DATE = "date"
|
DATE = "date"
|
||||||
PASSWORD = "password"
|
PASSWORD = "password" # noqa: S105 # nosec B105 - field type vocabulary.
|
||||||
|
|
||||||
|
|
||||||
class RecipientType(StrEnum):
|
class RecipientType(StrEnum):
|
||||||
@@ -91,6 +89,7 @@ class BuildStatus(StrEnum):
|
|||||||
class SendStatus(StrEnum):
|
class SendStatus(StrEnum):
|
||||||
DRAFT = "draft"
|
DRAFT = "draft"
|
||||||
QUEUED = "queued"
|
QUEUED = "queued"
|
||||||
|
SKIPPED = "skipped"
|
||||||
|
|
||||||
|
|
||||||
class CampaignMeta(StrictModel):
|
class CampaignMeta(StrictModel):
|
||||||
@@ -108,58 +107,14 @@ class FieldDefinition(StrictModel):
|
|||||||
can_override: bool = True
|
can_override: bool = True
|
||||||
|
|
||||||
|
|
||||||
class MailServerCredentials(StrictModel):
|
class MailProfileCapabilities(StrictModel):
|
||||||
smtp: TransportCredentials = Field(default_factory=TransportCredentials)
|
smtp_available: bool = False
|
||||||
imap: TransportCredentials = Field(default_factory=TransportCredentials)
|
imap_available: bool = False
|
||||||
|
|
||||||
|
|
||||||
class ServerConfig(StrictModel):
|
class ServerConfig(StrictModel):
|
||||||
mail_profile_id: str | None = None
|
mail_profile_id: str | None = None
|
||||||
inherit_smtp_credentials: bool = True
|
profile_capabilities: MailProfileCapabilities = Field(default_factory=MailProfileCapabilities)
|
||||||
inherit_imap_credentials: bool = True
|
|
||||||
smtp: SmtpServerConfig | None = None
|
|
||||||
imap: ImapServerConfig | None = None
|
|
||||||
credentials: MailServerCredentials = Field(default_factory=MailServerCredentials)
|
|
||||||
|
|
||||||
@model_validator(mode="before")
|
|
||||||
@classmethod
|
|
||||||
def normalize_legacy_credentials(cls, value: Any) -> Any:
|
|
||||||
if not isinstance(value, dict):
|
|
||||||
return value
|
|
||||||
data = dict(value)
|
|
||||||
credentials = data.get("credentials") if isinstance(data.get("credentials"), dict) else {}
|
|
||||||
credentials = {key: dict(item) for key, item in credentials.items() if isinstance(item, dict)}
|
|
||||||
for protocol in ("smtp", "imap"):
|
|
||||||
transport = data.get(protocol)
|
|
||||||
if not isinstance(transport, dict):
|
|
||||||
continue
|
|
||||||
next_transport = dict(transport)
|
|
||||||
next_credentials = dict(credentials.get(protocol) or {})
|
|
||||||
for field in ("username", "password"):
|
|
||||||
if field in next_transport and field not in next_credentials:
|
|
||||||
next_credentials[field] = next_transport[field]
|
|
||||||
next_transport.pop(field, None)
|
|
||||||
next_transport.pop("enabled", None)
|
|
||||||
data[protocol] = next_transport
|
|
||||||
if next_credentials:
|
|
||||||
credentials[protocol] = next_credentials
|
|
||||||
if credentials:
|
|
||||||
data["credentials"] = credentials
|
|
||||||
return data
|
|
||||||
|
|
||||||
def runtime_smtp_config(self) -> SmtpConfig | None:
|
|
||||||
if self.smtp is None:
|
|
||||||
return None
|
|
||||||
payload = self.smtp.model_dump(mode="json")
|
|
||||||
payload.update(self.credentials.smtp.model_dump(mode="json", exclude_none=True))
|
|
||||||
return SmtpConfig.model_validate(payload)
|
|
||||||
|
|
||||||
def runtime_imap_config(self) -> ImapConfig | None:
|
|
||||||
if self.imap is None:
|
|
||||||
return None
|
|
||||||
payload = self.imap.model_dump(mode="json")
|
|
||||||
payload.update(self.credentials.imap.model_dump(mode="json", exclude_none=True))
|
|
||||||
return ImapConfig.model_validate(payload)
|
|
||||||
|
|
||||||
|
|
||||||
class RecipientConfig(StrictModel):
|
class RecipientConfig(StrictModel):
|
||||||
@@ -418,11 +373,20 @@ class AttachmentsConfig(StrictModel):
|
|||||||
base_paths: list[AttachmentBasePathConfig] = Field(default_factory=list)
|
base_paths: list[AttachmentBasePathConfig] = Field(default_factory=list)
|
||||||
allow_individual: bool = False
|
allow_individual: bool = False
|
||||||
send_without_attachments: bool = True
|
send_without_attachments: bool = True
|
||||||
|
send_without_attachments_behavior: Behavior | None = None
|
||||||
zip: ZipCollectionConfig = Field(default_factory=ZipCollectionConfig)
|
zip: ZipCollectionConfig = Field(default_factory=ZipCollectionConfig)
|
||||||
global_: list[AttachmentConfig] = Field(default_factory=list, alias="global")
|
global_: list[AttachmentConfig] = Field(default_factory=list, alias="global")
|
||||||
missing_behavior: Behavior = Behavior.ASK
|
missing_behavior: Behavior = Behavior.ASK
|
||||||
ambiguous_behavior: Behavior = Behavior.ASK
|
ambiguous_behavior: Behavior = Behavior.ASK
|
||||||
|
|
||||||
|
@model_validator(mode="after")
|
||||||
|
def normalize_send_without_attachments_behavior(self) -> "AttachmentsConfig":
|
||||||
|
if self.send_without_attachments_behavior is None:
|
||||||
|
self.send_without_attachments_behavior = Behavior.CONTINUE if self.send_without_attachments else Behavior.BLOCK
|
||||||
|
else:
|
||||||
|
self.send_without_attachments = self.send_without_attachments_behavior != Behavior.BLOCK
|
||||||
|
return self
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def individual_base_path_values(self) -> set[str]:
|
def individual_base_path_values(self) -> set[str]:
|
||||||
return {base_path.path for base_path in self.base_paths if base_path.allow_individual}
|
return {base_path.path for base_path in self.base_paths if base_path.allow_individual}
|
||||||
@@ -489,6 +453,39 @@ class EntryConfig(StrictModel):
|
|||||||
last_sent: str | None = None
|
last_sent: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ImportColumnProvenance(StrictModel):
|
||||||
|
column_index: int = Field(ge=0)
|
||||||
|
header: str
|
||||||
|
kind: str
|
||||||
|
field_name: str | None = None
|
||||||
|
new_field_name: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ImportProvenance(StrictModel):
|
||||||
|
id: str
|
||||||
|
imported_at: str
|
||||||
|
mode: Literal["append", "replace"]
|
||||||
|
source_type: Literal["csv", "xlsx", "text", "addresses"]
|
||||||
|
source_id: str | None = None
|
||||||
|
source_label: str | None = None
|
||||||
|
source_revision: str | None = None
|
||||||
|
source_provenance: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
filename: str | None = None
|
||||||
|
sheet_name: str | None = None
|
||||||
|
encoding: str | None = None
|
||||||
|
delimiter: str | None = None
|
||||||
|
header_rows: int = Field(default=0, ge=0)
|
||||||
|
quoted: bool | None = None
|
||||||
|
value_separators: str | None = None
|
||||||
|
rows_total: int = Field(default=0, ge=0)
|
||||||
|
valid_rows: int = Field(default=0, ge=0)
|
||||||
|
invalid_rows: int = Field(default=0, ge=0)
|
||||||
|
imported_rows: int = Field(default=0, ge=0)
|
||||||
|
field_names_created: list[str] = Field(default_factory=list)
|
||||||
|
attachment_patterns: int = Field(default=0, ge=0)
|
||||||
|
mapping: list[ImportColumnProvenance] = Field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
class SourceConfig(StrictModel):
|
class SourceConfig(StrictModel):
|
||||||
type: SourceType
|
type: SourceType
|
||||||
path: str
|
path: str
|
||||||
@@ -502,6 +499,7 @@ class EntriesConfig(StrictModel):
|
|||||||
source: SourceConfig | None = None
|
source: SourceConfig | None = None
|
||||||
mapping: dict[str, str] | None = None
|
mapping: dict[str, str] | None = None
|
||||||
defaults: EntryConfig | None = None
|
defaults: EntryConfig | None = None
|
||||||
|
imports: list[ImportProvenance] = Field(default_factory=list)
|
||||||
|
|
||||||
@model_validator(mode="after")
|
@model_validator(mode="after")
|
||||||
def inline_or_external(self) -> "EntriesConfig":
|
def inline_or_external(self) -> "EntriesConfig":
|
||||||
|
|||||||
@@ -1,14 +1,17 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import csv
|
import csv
|
||||||
|
from dataclasses import dataclass
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Iterable
|
from typing import Iterable
|
||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict, Field
|
from pydantic import BaseModel, ConfigDict, Field
|
||||||
|
|
||||||
|
from .addressing import effective_address_lists
|
||||||
from .field_values import ignored_entry_field_overrides
|
from .field_values import ignored_entry_field_overrides
|
||||||
from .models import AttachmentConfig, CampaignConfig, EntryConfig, FieldType, SourceType, ZipPasswordMode, ZipPasswordScope, ZipRuleMode
|
from .models import AttachmentConfig, CampaignConfig, EntryConfig, FieldType, SourceType, ZipArchiveConfig, ZipPasswordMode, ZipPasswordScope, ZipRuleMode
|
||||||
|
from ..attachments.resolver import resolve_campaign_attachments
|
||||||
|
|
||||||
|
|
||||||
class Severity(StrEnum):
|
class Severity(StrEnum):
|
||||||
@@ -51,6 +54,13 @@ class SemanticReport(BaseModel):
|
|||||||
return self.error_count == 0
|
return self.error_count == 0
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True, slots=True)
|
||||||
|
class _EntriesValidation:
|
||||||
|
mode: str
|
||||||
|
count: int | None
|
||||||
|
issues: list[SemanticIssue]
|
||||||
|
|
||||||
|
|
||||||
def _issue(severity: Severity, code: str, message: str, path: str | None = None) -> SemanticIssue:
|
def _issue(severity: Severity, code: str, message: str, path: str | None = None) -> SemanticIssue:
|
||||||
return SemanticIssue(severity=severity, code=code, message=message, path=path)
|
return SemanticIssue(severity=severity, code=code, message=message, path=path)
|
||||||
|
|
||||||
@@ -200,57 +210,95 @@ def _attachment_path_issues(config: CampaignConfig) -> list[SemanticIssue]:
|
|||||||
|
|
||||||
def _zip_configuration_issues(config: CampaignConfig) -> list[SemanticIssue]:
|
def _zip_configuration_issues(config: CampaignConfig) -> list[SemanticIssue]:
|
||||||
collection = config.attachments.zip
|
collection = config.attachments.zip
|
||||||
issues: list[SemanticIssue] = []
|
|
||||||
if not collection.enabled:
|
if not collection.enabled:
|
||||||
return issues
|
return []
|
||||||
if not collection.archives:
|
if not collection.archives:
|
||||||
return [_issue(Severity.ERROR, "zip_archive_missing", "Attachment zipping is enabled, but no ZIP archive is configured", "/attachments/zip/archives")]
|
return [_issue(Severity.ERROR, "zip_archive_missing", "Attachment zipping is enabled, but no ZIP archive is configured", "/attachments/zip/archives")]
|
||||||
|
|
||||||
|
issues, archive_ids, standard_count = _zip_archive_catalog_issues(config)
|
||||||
|
if standard_count != 1:
|
||||||
|
issues.append(_issue(Severity.ERROR, "zip_standard_archive_invalid", "Exactly one ZIP archive must be selected as the campaign standard", "/attachments/zip/archives"))
|
||||||
|
issues.extend(_zip_rule_selection_issues(config, archive_ids))
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _zip_archive_catalog_issues(config: CampaignConfig) -> tuple[list[SemanticIssue], set[str], int]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
archive_ids: set[str] = set()
|
archive_ids: set[str] = set()
|
||||||
archive_names: set[str] = set()
|
archive_names: set[str] = set()
|
||||||
standard_count = 0
|
standard_count = 0
|
||||||
field_definitions = {field.name: field for field in config.fields}
|
field_definitions = {field.name: field for field in config.fields}
|
||||||
for index, archive in enumerate(collection.archives):
|
for index, archive in enumerate(config.attachments.zip.archives):
|
||||||
path = f"/attachments/zip/archives/{index}"
|
path = f"/attachments/zip/archives/{index}"
|
||||||
if not archive.id.strip():
|
issues.extend(_zip_archive_identity_issues(archive, path, archive_ids, archive_names))
|
||||||
issues.append(_issue(Severity.ERROR, "zip_archive_id_missing", "ZIP archive has no identifier", f"{path}/id"))
|
|
||||||
elif archive.id in archive_ids:
|
|
||||||
issues.append(_issue(Severity.ERROR, "zip_archive_id_duplicate", f"ZIP archive id {archive.id!r} is used more than once", f"{path}/id"))
|
|
||||||
archive_ids.add(archive.id)
|
|
||||||
normalized_archive_name = _normalized_zip_archive_name(archive.name)
|
|
||||||
if not normalized_archive_name:
|
|
||||||
issues.append(_issue(Severity.ERROR, "zip_archive_name_missing", "ZIP archive has no filename", f"{path}/name"))
|
|
||||||
elif normalized_archive_name in archive_names:
|
|
||||||
issues.append(_issue(Severity.ERROR, "zip_archive_name_duplicate", f"ZIP archive filename {archive.name!r} is used more than once; archive filenames must be unique", f"{path}/name"))
|
|
||||||
archive_names.add(normalized_archive_name)
|
|
||||||
if archive.standard:
|
if archive.standard:
|
||||||
standard_count += 1
|
standard_count += 1
|
||||||
|
issues.extend(_zip_password_issues(config, archive, path, field_definitions))
|
||||||
|
return issues, archive_ids, standard_count
|
||||||
|
|
||||||
if not archive.password_enabled:
|
|
||||||
continue
|
|
||||||
if archive.password_mode == ZipPasswordMode.DIRECT:
|
|
||||||
if not (archive.password or ""):
|
|
||||||
issues.append(_issue(Severity.ERROR, "zip_password_missing", "A legacy fixed ZIP password is enabled, but no password is configured", f"{path}/password"))
|
|
||||||
continue
|
|
||||||
if archive.password_mode == ZipPasswordMode.TEMPLATE:
|
|
||||||
if not (archive.password_template or ""):
|
|
||||||
issues.append(_issue(Severity.ERROR, "zip_password_template_missing", "A legacy ZIP password template is enabled, but no template is configured", f"{path}/password_template"))
|
|
||||||
continue
|
|
||||||
|
|
||||||
field_name = (archive.password_field or "").strip()
|
def _zip_archive_identity_issues(
|
||||||
field = field_definitions.get(field_name)
|
archive: ZipArchiveConfig,
|
||||||
if not field_name:
|
path: str,
|
||||||
issues.append(_issue(Severity.ERROR, "zip_password_field_missing", f"ZIP archive {archive.name!r} has password protection enabled, but no field is selected", f"{path}/password_field"))
|
archive_ids: set[str],
|
||||||
elif field is None:
|
archive_names: set[str],
|
||||||
issues.append(_issue(Severity.ERROR, "zip_password_field_unknown", f"ZIP password field {field_name!r} is not declared in campaign fields", f"{path}/password_field"))
|
) -> list[SemanticIssue]:
|
||||||
elif field.type != FieldType.PASSWORD:
|
issues: list[SemanticIssue] = []
|
||||||
issues.append(_issue(Severity.WARNING, "zip_password_field_not_password_type", f"ZIP password field {field_name!r} is not configured with field type 'password'", f"{path}/password_field"))
|
if not archive.id.strip():
|
||||||
elif archive.password_scope == ZipPasswordScope.GLOBAL and config.global_values.get(field_name) in (None, ""):
|
issues.append(_issue(Severity.ERROR, "zip_archive_id_missing", "ZIP archive has no identifier", f"{path}/id"))
|
||||||
issues.append(_issue(Severity.ERROR, "zip_global_password_value_missing", f"Global ZIP password field {field_name!r} has no campaign-wide value", f"/global_values/{field_name}"))
|
elif archive.id in archive_ids:
|
||||||
|
issues.append(_issue(Severity.ERROR, "zip_archive_id_duplicate", f"ZIP archive id {archive.id!r} is used more than once", f"{path}/id"))
|
||||||
|
archive_ids.add(archive.id)
|
||||||
|
|
||||||
if standard_count != 1:
|
normalized_archive_name = _normalized_zip_archive_name(archive.name)
|
||||||
issues.append(_issue(Severity.ERROR, "zip_standard_archive_invalid", "Exactly one ZIP archive must be selected as the campaign standard", "/attachments/zip/archives"))
|
if not normalized_archive_name:
|
||||||
|
issues.append(_issue(Severity.ERROR, "zip_archive_name_missing", "ZIP archive has no filename", f"{path}/name"))
|
||||||
|
elif normalized_archive_name in archive_names:
|
||||||
|
issues.append(_issue(Severity.ERROR, "zip_archive_name_duplicate", f"ZIP archive filename {archive.name!r} is used more than once; archive filenames must be unique", f"{path}/name"))
|
||||||
|
archive_names.add(normalized_archive_name)
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _zip_password_issues(
|
||||||
|
config: CampaignConfig,
|
||||||
|
archive: ZipArchiveConfig,
|
||||||
|
path: str,
|
||||||
|
field_definitions: dict[str, object],
|
||||||
|
) -> list[SemanticIssue]:
|
||||||
|
if not archive.password_enabled:
|
||||||
|
return []
|
||||||
|
if archive.password_mode == ZipPasswordMode.DIRECT:
|
||||||
|
if not (archive.password or ""):
|
||||||
|
return [_issue(Severity.ERROR, "zip_password_missing", "A legacy fixed ZIP password is enabled, but no password is configured", f"{path}/password")]
|
||||||
|
return []
|
||||||
|
if archive.password_mode == ZipPasswordMode.TEMPLATE:
|
||||||
|
if not (archive.password_template or ""):
|
||||||
|
return [_issue(Severity.ERROR, "zip_password_template_missing", "A legacy ZIP password template is enabled, but no template is configured", f"{path}/password_template")]
|
||||||
|
return []
|
||||||
|
return _zip_password_field_issues(config, archive, path, field_definitions)
|
||||||
|
|
||||||
|
|
||||||
|
def _zip_password_field_issues(
|
||||||
|
config: CampaignConfig,
|
||||||
|
archive: ZipArchiveConfig,
|
||||||
|
path: str,
|
||||||
|
field_definitions: dict[str, object],
|
||||||
|
) -> list[SemanticIssue]:
|
||||||
|
field_name = (archive.password_field or "").strip()
|
||||||
|
field = field_definitions.get(field_name)
|
||||||
|
if not field_name:
|
||||||
|
return [_issue(Severity.ERROR, "zip_password_field_missing", f"ZIP archive {archive.name!r} has password protection enabled, but no field is selected", f"{path}/password_field")]
|
||||||
|
if field is None:
|
||||||
|
return [_issue(Severity.ERROR, "zip_password_field_unknown", f"ZIP password field {field_name!r} is not declared in campaign fields", f"{path}/password_field")]
|
||||||
|
if getattr(field, "type", None) != FieldType.PASSWORD:
|
||||||
|
return [_issue(Severity.WARNING, "zip_password_field_not_password_type", f"ZIP password field {field_name!r} is not configured with field type 'password'", f"{path}/password_field")]
|
||||||
|
if archive.password_scope == ZipPasswordScope.GLOBAL and config.global_values.get(field_name) in (None, ""):
|
||||||
|
return [_issue(Severity.ERROR, "zip_global_password_value_missing", f"Global ZIP password field {field_name!r} has no campaign-wide value", f"/global_values/{field_name}")]
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def _zip_rule_selection_issues(config: CampaignConfig, archive_ids: set[str]) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
for path, rule, _is_individual in _iter_attachment_rules(config):
|
for path, rule, _is_individual in _iter_attachment_rules(config):
|
||||||
selection = (rule.zip.archive_id or ZipRuleMode.INHERIT.value).strip()
|
selection = (rule.zip.archive_id or ZipRuleMode.INHERIT.value).strip()
|
||||||
if selection not in {"", ZipRuleMode.INHERIT.value, ZipRuleMode.INCLUDE.value, ZipRuleMode.EXCLUDE.value} and selection not in archive_ids:
|
if selection not in {"", ZipRuleMode.INHERIT.value, ZipRuleMode.INCLUDE.value, ZipRuleMode.EXCLUDE.value} and selection not in archive_ids:
|
||||||
@@ -276,6 +324,288 @@ def _ignored_override_issues(config: CampaignConfig, entry: EntryConfig, path_pr
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _global_value_issues(config: CampaignConfig, declared_names: set[str]) -> list[SemanticIssue]:
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.WARNING,
|
||||||
|
"unknown_global_value",
|
||||||
|
f"global_values contains {key!r}, but it is not declared in fields",
|
||||||
|
f"/global_values/{key}",
|
||||||
|
)
|
||||||
|
for key in config.global_values
|
||||||
|
if declared_names and key not in declared_names
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _delivery_issues(config: CampaignConfig) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
profile_id = (config.server.mail_profile_id or "").strip()
|
||||||
|
if (config.campaign.mode == "send" or config.delivery.imap_append_sent.enabled) and not profile_id:
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"missing_mail_profile",
|
||||||
|
"Select an authorized Mail-module profile; campaigns cannot store SMTP/IMAP settings or credentials.",
|
||||||
|
"/server/mail_profile_id",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
capabilities = config.server.profile_capabilities
|
||||||
|
if config.campaign.mode == "send" and profile_id and not capabilities.smtp_available:
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"mail_profile_without_smtp",
|
||||||
|
"campaign mode is 'send', but the selected Mail profile has no SMTP configuration",
|
||||||
|
"/server/mail_profile_id",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if config.delivery.imap_append_sent.enabled and profile_id and not capabilities.imap_available:
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"mail_profile_without_imap",
|
||||||
|
"IMAP append is enabled, but the selected Mail profile has no IMAP configuration",
|
||||||
|
"/server/mail_profile_id",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _sender_issues(config: CampaignConfig) -> list[SemanticIssue]:
|
||||||
|
"""Require Campaign-owned sender data before a send-mode build."""
|
||||||
|
|
||||||
|
if config.campaign.mode != "send":
|
||||||
|
return []
|
||||||
|
if config.entries.is_inline:
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"missing_sender",
|
||||||
|
"No effective From address is configured; Campaign must resolve the sender before building.",
|
||||||
|
f"/entries/inline/{index}/from",
|
||||||
|
)
|
||||||
|
for index, entry in enumerate(config.entries.inline or [])
|
||||||
|
if entry.active and not effective_address_lists(config, entry)["from"]
|
||||||
|
]
|
||||||
|
if config.recipients.from_:
|
||||||
|
return []
|
||||||
|
defaults = config.entries.defaults
|
||||||
|
mapping_can_supply_sender = bool(
|
||||||
|
config.recipients.allow_individual_from
|
||||||
|
and (
|
||||||
|
(defaults is not None and defaults.from_)
|
||||||
|
or "from.email" in (config.entries.mapping or {})
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if mapping_can_supply_sender:
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"missing_sender",
|
||||||
|
"Configure recipients.from, or allow and map an individual From address, before building a send-mode campaign.",
|
||||||
|
"/recipients/from",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _entries_validation(
|
||||||
|
config: CampaignConfig,
|
||||||
|
*,
|
||||||
|
campaign_path: Path,
|
||||||
|
check_files: bool,
|
||||||
|
field_names: set[str],
|
||||||
|
field_definitions: dict[str, object],
|
||||||
|
) -> _EntriesValidation:
|
||||||
|
if config.entries.is_inline:
|
||||||
|
inline_entries = config.entries.inline or []
|
||||||
|
issues = _inline_entries_issues(config, inline_entries)
|
||||||
|
return _EntriesValidation(mode="inline", count=len(inline_entries), issues=issues)
|
||||||
|
issues = _external_entries_issues(
|
||||||
|
config,
|
||||||
|
campaign_path=campaign_path,
|
||||||
|
check_files=check_files,
|
||||||
|
field_names=field_names,
|
||||||
|
field_definitions=field_definitions,
|
||||||
|
)
|
||||||
|
source_type = config.entries.source.type.value if config.entries.source else "unknown"
|
||||||
|
return _EntriesValidation(mode=f"external:{source_type}", count=None, issues=issues)
|
||||||
|
|
||||||
|
|
||||||
|
def _inline_entries_issues(config: CampaignConfig, inline_entries: list[EntryConfig]) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
if not inline_entries:
|
||||||
|
issues.append(_issue(Severity.WARNING, "no_inline_entries", "entries.inline is empty", "/entries/inline"))
|
||||||
|
for index, entry in enumerate(inline_entries):
|
||||||
|
if entry.active:
|
||||||
|
issues.extend(_ignored_override_issues(config, entry, f"/entries/inline/{index}"))
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _external_entries_issues(
|
||||||
|
config: CampaignConfig,
|
||||||
|
*,
|
||||||
|
campaign_path: Path,
|
||||||
|
check_files: bool,
|
||||||
|
field_names: set[str],
|
||||||
|
field_definitions: dict[str, object],
|
||||||
|
) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
mapping = config.entries.mapping or {}
|
||||||
|
if not mapping:
|
||||||
|
issues.append(_issue(Severity.ERROR, "empty_mapping", "external entries require a non-empty mapping", "/entries/mapping"))
|
||||||
|
issues.extend(_mapping_issues(mapping, field_names, field_definitions))
|
||||||
|
if config.entries.defaults:
|
||||||
|
issues.extend(_ignored_override_issues(config, config.entries.defaults, "/entries/defaults"))
|
||||||
|
if check_files and config.entries.source:
|
||||||
|
issues.extend(_entries_source_file_issues(config, campaign_path, mapping))
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _mapping_issues(
|
||||||
|
mapping: dict[str, str],
|
||||||
|
field_names: set[str],
|
||||||
|
field_definitions: dict[str, object],
|
||||||
|
) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
for target in mapping:
|
||||||
|
if not _mapping_target_known(target, field_names):
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.WARNING,
|
||||||
|
"unknown_mapping_target",
|
||||||
|
f"mapping target {target!r} is not recognized by the current campaign model",
|
||||||
|
f"/entries/mapping/{target}",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
field_name = _mapping_target_field_name(target)
|
||||||
|
field = field_definitions.get(field_name or "")
|
||||||
|
if field_name and field is not None and not getattr(field, "can_override", True):
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.WARNING,
|
||||||
|
"mapping_target_not_overridable",
|
||||||
|
f"mapping target {target!r} points to a field that does not allow recipient overrides; mapped values will be ignored",
|
||||||
|
f"/entries/mapping/{target}",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _entries_source_file_issues(config: CampaignConfig, campaign_path: Path, mapping: dict[str, str]) -> list[SemanticIssue]:
|
||||||
|
source = config.entries.source
|
||||||
|
if source is None:
|
||||||
|
return []
|
||||||
|
source_path = _resolve(campaign_path, source.path)
|
||||||
|
if not source_path.exists():
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"entries_source_not_found",
|
||||||
|
f"entries source file does not exist: {source_path}",
|
||||||
|
"/entries/source/path",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
if source.type != SourceType.CSV or not source.has_header:
|
||||||
|
return []
|
||||||
|
try:
|
||||||
|
header = _csv_header(source_path, source.delimiter, source.encoding)
|
||||||
|
except OSError as exc:
|
||||||
|
return [_issue(Severity.ERROR, "entries_source_read_error", str(exc), "/entries/source/path")]
|
||||||
|
header_set = set(header or [])
|
||||||
|
missing_columns = sorted({source_name for source_name in mapping.values() if source_name not in header_set})
|
||||||
|
if not missing_columns:
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"mapping_columns_missing",
|
||||||
|
"CSV mapping refers to missing columns: " + ", ".join(missing_columns),
|
||||||
|
"/entries/mapping",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _file_check_issues(config: CampaignConfig, campaign_path: Path) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
issues.extend(_attachment_file_check_issues(config, campaign_path))
|
||||||
|
issues.extend(_attachment_resolution_check_issues(config, campaign_path))
|
||||||
|
issues.extend(_template_source_file_issues(config, campaign_path))
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _attachment_file_check_issues(config: CampaignConfig, campaign_path: Path) -> list[SemanticIssue]:
|
||||||
|
if config.attachments.base_paths:
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.WARNING,
|
||||||
|
"attachments_base_path_not_found",
|
||||||
|
f"attachment base path {base_path_config.name!r} does not exist: {_resolve(campaign_path, base_path_config.path)}",
|
||||||
|
f"/attachments/base_paths/{index}/path",
|
||||||
|
)
|
||||||
|
for index, base_path_config in enumerate(config.attachments.base_paths)
|
||||||
|
if not _resolve(campaign_path, base_path_config.path).exists()
|
||||||
|
]
|
||||||
|
attachments_base_path = _resolve(campaign_path, config.attachments.base_path)
|
||||||
|
if attachments_base_path.exists():
|
||||||
|
return []
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.WARNING,
|
||||||
|
"attachments_base_path_not_found",
|
||||||
|
f"attachments.base_path does not exist: {attachments_base_path}",
|
||||||
|
"/attachments/base_path",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _attachment_resolution_check_issues(config: CampaignConfig, campaign_path: Path) -> list[SemanticIssue]:
|
||||||
|
try:
|
||||||
|
report = resolve_campaign_attachments(config, campaign_file=campaign_path)
|
||||||
|
except Exception as exc:
|
||||||
|
return [
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"attachment_resolution_failed",
|
||||||
|
f"attachment rules could not be resolved: {exc}",
|
||||||
|
"/attachments",
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
for entry in report.entries:
|
||||||
|
entry_path = f"/entries/{entry.entry_id or entry.entry_index}"
|
||||||
|
for issue in entry.issues:
|
||||||
|
if any(issue is attachment_issue for attachment in entry.attachments for attachment_issue in attachment.issues):
|
||||||
|
continue
|
||||||
|
issues.append(_issue(Severity(issue.severity.value), issue.code, issue.message, entry_path))
|
||||||
|
for attachment in entry.attachments:
|
||||||
|
attachment_path = (
|
||||||
|
f"/attachments/global/{attachment.index}"
|
||||||
|
if attachment.scope.value == "global"
|
||||||
|
else f"{entry_path}/attachments/{attachment.index}"
|
||||||
|
)
|
||||||
|
for issue in attachment.issues:
|
||||||
|
issues.append(_issue(Severity(issue.severity.value), issue.code, issue.message, attachment_path))
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def _template_source_file_issues(config: CampaignConfig, campaign_path: Path) -> list[SemanticIssue]:
|
||||||
|
issues: list[SemanticIssue] = []
|
||||||
|
for schema_path, raw_path in _iter_template_source_paths(config):
|
||||||
|
path = _resolve(campaign_path, raw_path)
|
||||||
|
if not path.exists():
|
||||||
|
issues.append(
|
||||||
|
_issue(
|
||||||
|
Severity.ERROR,
|
||||||
|
"template_source_not_found",
|
||||||
|
f"template source file does not exist: {path}",
|
||||||
|
schema_path,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
def validate_campaign_config(
|
def validate_campaign_config(
|
||||||
config: CampaignConfig,
|
config: CampaignConfig,
|
||||||
*,
|
*,
|
||||||
@@ -289,149 +619,30 @@ def validate_campaign_config(
|
|||||||
field_definitions = {field.name: field for field in config.fields}
|
field_definitions = {field.name: field for field in config.fields}
|
||||||
declared_names = set(field_definitions)
|
declared_names = set(field_definitions)
|
||||||
|
|
||||||
for key in config.global_values:
|
issues.extend(_global_value_issues(config, declared_names))
|
||||||
if declared_names and key not in declared_names:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"unknown_global_value",
|
|
||||||
f"global_values contains {key!r}, but it is not declared in fields",
|
|
||||||
f"/global_values/{key}",
|
|
||||||
))
|
|
||||||
|
|
||||||
issues.extend(_attachment_path_issues(config))
|
issues.extend(_attachment_path_issues(config))
|
||||||
issues.extend(_zip_configuration_issues(config))
|
issues.extend(_zip_configuration_issues(config))
|
||||||
|
issues.extend(_delivery_issues(config))
|
||||||
|
issues.extend(_sender_issues(config))
|
||||||
|
|
||||||
runtime_imap = config.server.runtime_imap_config()
|
entries = _entries_validation(
|
||||||
if config.delivery.imap_append_sent.enabled:
|
config,
|
||||||
if runtime_imap is None:
|
campaign_path=campaign_path,
|
||||||
issues.append(_issue(
|
check_files=check_files,
|
||||||
Severity.WARNING,
|
field_names=field_names,
|
||||||
"delivery_imap_enabled_without_server_imap",
|
field_definitions=field_definitions,
|
||||||
"delivery.imap_append_sent is enabled, but no server.imap configuration is present",
|
)
|
||||||
"/delivery/imap_append_sent/enabled",
|
issues.extend(entries.issues)
|
||||||
))
|
|
||||||
else:
|
|
||||||
missing = [name for name in ["host", "port", "username", "password"] if getattr(runtime_imap, name) in (None, "")]
|
|
||||||
if missing:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.ERROR,
|
|
||||||
"incomplete_imap_config",
|
|
||||||
"IMAP append is enabled, but these IMAP settings are missing: " + ", ".join(missing),
|
|
||||||
"/server/imap",
|
|
||||||
))
|
|
||||||
|
|
||||||
runtime_smtp = config.server.runtime_smtp_config()
|
|
||||||
if config.campaign.mode == "send" and not runtime_smtp:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.ERROR,
|
|
||||||
"missing_smtp_config",
|
|
||||||
"campaign mode is 'send', but no server.smtp configuration is present",
|
|
||||||
"/server/smtp",
|
|
||||||
))
|
|
||||||
|
|
||||||
if runtime_smtp:
|
|
||||||
missing = [name for name in ["host", "port"] if getattr(runtime_smtp, name) in (None, "")]
|
|
||||||
if missing:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"incomplete_smtp_config",
|
|
||||||
"SMTP settings are present, but these settings are missing: " + ", ".join(missing),
|
|
||||||
"/server/smtp",
|
|
||||||
))
|
|
||||||
|
|
||||||
if config.entries.is_inline:
|
|
||||||
inline_entries = config.entries.inline or []
|
|
||||||
entries_count = len(inline_entries)
|
|
||||||
entries_mode = "inline"
|
|
||||||
if entries_count == 0:
|
|
||||||
issues.append(_issue(Severity.WARNING, "no_inline_entries", "entries.inline is empty", "/entries/inline"))
|
|
||||||
for index, entry in enumerate(inline_entries):
|
|
||||||
if entry.active:
|
|
||||||
issues.extend(_ignored_override_issues(config, entry, f"/entries/inline/{index}"))
|
|
||||||
else:
|
|
||||||
entries_count = None
|
|
||||||
entries_mode = f"external:{config.entries.source.type.value if config.entries.source else 'unknown'}"
|
|
||||||
mapping = config.entries.mapping or {}
|
|
||||||
if not mapping:
|
|
||||||
issues.append(_issue(Severity.ERROR, "empty_mapping", "external entries require a non-empty mapping", "/entries/mapping"))
|
|
||||||
for target in mapping:
|
|
||||||
if not _mapping_target_known(target, field_names):
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"unknown_mapping_target",
|
|
||||||
f"mapping target {target!r} is not recognized by the current campaign model",
|
|
||||||
f"/entries/mapping/{target}",
|
|
||||||
))
|
|
||||||
field_name = _mapping_target_field_name(target)
|
|
||||||
if field_name and field_name in field_definitions and not field_definitions[field_name].can_override:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"mapping_target_not_overridable",
|
|
||||||
f"mapping target {target!r} points to a field that does not allow recipient overrides; mapped values will be ignored",
|
|
||||||
f"/entries/mapping/{target}",
|
|
||||||
))
|
|
||||||
if config.entries.defaults:
|
|
||||||
issues.extend(_ignored_override_issues(config, config.entries.defaults, "/entries/defaults"))
|
|
||||||
if check_files and config.entries.source:
|
|
||||||
source_path = _resolve(campaign_path, config.entries.source.path)
|
|
||||||
if not source_path.exists():
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.ERROR,
|
|
||||||
"entries_source_not_found",
|
|
||||||
f"entries source file does not exist: {source_path}",
|
|
||||||
"/entries/source/path",
|
|
||||||
))
|
|
||||||
elif config.entries.source.type == SourceType.CSV and config.entries.source.has_header:
|
|
||||||
try:
|
|
||||||
header = _csv_header(source_path, config.entries.source.delimiter, config.entries.source.encoding)
|
|
||||||
header_set = set(header or [])
|
|
||||||
missing_columns = sorted({source_name for source_name in mapping.values() if source_name not in header_set})
|
|
||||||
if missing_columns:
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.ERROR,
|
|
||||||
"mapping_columns_missing",
|
|
||||||
"CSV mapping refers to missing columns: " + ", ".join(missing_columns),
|
|
||||||
"/entries/mapping",
|
|
||||||
))
|
|
||||||
except OSError as exc:
|
|
||||||
issues.append(_issue(Severity.ERROR, "entries_source_read_error", str(exc), "/entries/source/path"))
|
|
||||||
|
|
||||||
if check_files:
|
if check_files:
|
||||||
if config.attachments.base_paths:
|
issues.extend(_file_check_issues(config, campaign_path))
|
||||||
for index, base_path_config in enumerate(config.attachments.base_paths):
|
|
||||||
attachments_base_path = _resolve(campaign_path, base_path_config.path)
|
|
||||||
if not attachments_base_path.exists():
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"attachments_base_path_not_found",
|
|
||||||
f"attachment base path {base_path_config.name!r} does not exist: {attachments_base_path}",
|
|
||||||
f"/attachments/base_paths/{index}/path",
|
|
||||||
))
|
|
||||||
else:
|
|
||||||
attachments_base_path = _resolve(campaign_path, config.attachments.base_path)
|
|
||||||
if not attachments_base_path.exists():
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.WARNING,
|
|
||||||
"attachments_base_path_not_found",
|
|
||||||
f"attachments.base_path does not exist: {attachments_base_path}",
|
|
||||||
"/attachments/base_path",
|
|
||||||
))
|
|
||||||
for schema_path, raw_path in _iter_template_source_paths(config):
|
|
||||||
path = _resolve(campaign_path, raw_path)
|
|
||||||
if not path.exists():
|
|
||||||
issues.append(_issue(
|
|
||||||
Severity.ERROR,
|
|
||||||
"template_source_not_found",
|
|
||||||
f"template source file does not exist: {path}",
|
|
||||||
schema_path,
|
|
||||||
))
|
|
||||||
|
|
||||||
report = SemanticReport(
|
report = SemanticReport(
|
||||||
campaign_id=config.campaign.id,
|
campaign_id=config.campaign.id,
|
||||||
campaign_name=config.campaign.name,
|
campaign_name=config.campaign.name,
|
||||||
issues=issues,
|
issues=issues,
|
||||||
entries_mode=entries_mode,
|
entries_mode=entries.mode,
|
||||||
entries_count=entries_count,
|
entries_count=entries.count,
|
||||||
attachments_base_path=_attachment_base_path_report_value(config),
|
attachments_base_path=_attachment_base_path_report_value(config),
|
||||||
rate_limit=f"{config.delivery.rate_limit.messages_per_minute}/min, concurrency {config.delivery.rate_limit.concurrency}",
|
rate_limit=f"{config.delivery.rate_limit.messages_per_minute}/min, concurrency {config.delivery.rate_limit.concurrency}",
|
||||||
imap_append_enabled=config.delivery.imap_append_sent.enabled,
|
imap_append_enabled=config.delivery.imap_append_sent.enabled,
|
||||||
|
|||||||
299
src/govoplan_campaign/backend/capabilities.py
Normal file
299
src/govoplan_campaign/backend/capabilities.py
Normal file
@@ -0,0 +1,299 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Iterable, Mapping
|
||||||
|
|
||||||
|
from sqlalchemy import and_, or_
|
||||||
|
|
||||||
|
from govoplan_core.core.access import AccessDecisionProvenance, PrincipalRef
|
||||||
|
from govoplan_core.core.campaigns import (
|
||||||
|
CampaignAccessProvider,
|
||||||
|
CampaignDeliveryTaskProvider,
|
||||||
|
CampaignMailPolicyContext,
|
||||||
|
CampaignMailPolicyContextProvider,
|
||||||
|
CampaignPolicyContext,
|
||||||
|
CampaignPolicyContextProvider,
|
||||||
|
CampaignRetentionProvider,
|
||||||
|
)
|
||||||
|
from govoplan_core.security.module_permissions import scopes_grant_compatible
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign, CampaignShare
|
||||||
|
|
||||||
|
|
||||||
|
READ_ACTIONS = {"campaigns:campaign:read", "campaign:read"}
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignMailPolicyContextService(CampaignMailPolicyContextProvider):
|
||||||
|
def get_campaign_mail_policy_context(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
) -> CampaignMailPolicyContext | None:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or campaign.tenant_id != tenant_id:
|
||||||
|
return None
|
||||||
|
return CampaignMailPolicyContext(
|
||||||
|
id=campaign.id,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
owner_user_id=campaign.owner_user_id,
|
||||||
|
owner_group_id=campaign.owner_group_id,
|
||||||
|
mail_profile_policy=dict(campaign.mail_profile_policy or {}),
|
||||||
|
)
|
||||||
|
|
||||||
|
def set_campaign_mail_profile_policy(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
policy: Mapping[str, object],
|
||||||
|
) -> Mapping[str, object]:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or campaign.tenant_id != tenant_id:
|
||||||
|
raise ValueError("Campaign policy not found")
|
||||||
|
payload = dict(policy)
|
||||||
|
campaign.mail_profile_policy = payload
|
||||||
|
session.add(campaign) # type: ignore[attr-defined]
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def mail_policy_context_capability(context: object) -> CampaignMailPolicyContextService:
|
||||||
|
return CampaignMailPolicyContextService()
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignAccessService(CampaignAccessProvider):
|
||||||
|
def campaign_exists(self, session: object, *, tenant_id: str, campaign_id: str) -> bool:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
return bool(campaign and campaign.tenant_id == tenant_id)
|
||||||
|
|
||||||
|
def can_read_campaign(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
user_id: str,
|
||||||
|
group_ids: Iterable[str] = (),
|
||||||
|
tenant_admin: bool = False,
|
||||||
|
) -> bool:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or campaign.tenant_id != tenant_id:
|
||||||
|
return False
|
||||||
|
if tenant_admin or campaign.owner_user_id == user_id:
|
||||||
|
return True
|
||||||
|
group_id_set = {str(group_id) for group_id in group_ids}
|
||||||
|
if campaign.owner_group_id and campaign.owner_group_id in group_id_set:
|
||||||
|
return True
|
||||||
|
share_clauses = [
|
||||||
|
and_(
|
||||||
|
CampaignShare.target_type == "user",
|
||||||
|
CampaignShare.target_id == user_id,
|
||||||
|
)
|
||||||
|
]
|
||||||
|
if group_id_set:
|
||||||
|
share_clauses.append(
|
||||||
|
and_(
|
||||||
|
CampaignShare.target_type == "group",
|
||||||
|
CampaignShare.target_id.in_(group_id_set),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
share = (
|
||||||
|
session.query(CampaignShare) # type: ignore[attr-defined]
|
||||||
|
.filter(
|
||||||
|
CampaignShare.tenant_id == tenant_id,
|
||||||
|
CampaignShare.campaign_id == campaign.id,
|
||||||
|
CampaignShare.revoked_at.is_(None),
|
||||||
|
or_(*share_clauses),
|
||||||
|
)
|
||||||
|
.first()
|
||||||
|
)
|
||||||
|
return share is not None
|
||||||
|
|
||||||
|
def explain_resource_provenance(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
principal: PrincipalRef,
|
||||||
|
*,
|
||||||
|
resource_type: str,
|
||||||
|
resource_id: str,
|
||||||
|
action: str,
|
||||||
|
) -> tuple[AccessDecisionProvenance, ...]:
|
||||||
|
normalized_type = resource_type.lower().strip()
|
||||||
|
if normalized_type not in {"campaign", "campaign_object", "campaigns:campaign"}:
|
||||||
|
return ()
|
||||||
|
campaign = session.get(Campaign, resource_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or (principal.tenant_id and campaign.tenant_id != principal.tenant_id):
|
||||||
|
return (
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="resource",
|
||||||
|
id=resource_id,
|
||||||
|
tenant_id=principal.tenant_id,
|
||||||
|
source="campaigns.not_found",
|
||||||
|
details={"resource_type": "campaign", "found": False},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
items = [
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="resource",
|
||||||
|
id=campaign.id,
|
||||||
|
label=campaign.name,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
source="campaigns.campaign",
|
||||||
|
details={
|
||||||
|
"resource_type": "campaign",
|
||||||
|
"external_id": campaign.external_id,
|
||||||
|
"status": campaign.status,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
]
|
||||||
|
items.extend(_owner_provenance(campaign, principal))
|
||||||
|
items.extend(_tenant_admin_provenance(principal))
|
||||||
|
permission_values = {"read", "write"} if action in READ_ACTIONS else {"write"}
|
||||||
|
shares = (
|
||||||
|
session.query(CampaignShare) # type: ignore[attr-defined]
|
||||||
|
.filter(
|
||||||
|
CampaignShare.tenant_id == campaign.tenant_id,
|
||||||
|
CampaignShare.campaign_id == campaign.id,
|
||||||
|
CampaignShare.revoked_at.is_(None),
|
||||||
|
CampaignShare.permission.in_(sorted(permission_values)),
|
||||||
|
or_(
|
||||||
|
(CampaignShare.target_type == "user") & (CampaignShare.target_id == principal.membership_id),
|
||||||
|
(CampaignShare.target_type == "group") & (CampaignShare.target_id.in_(sorted(principal.group_ids))),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.order_by(CampaignShare.target_type.asc(), CampaignShare.target_id.asc())
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
for share in shares:
|
||||||
|
items.append(
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="share",
|
||||||
|
id=share.id,
|
||||||
|
label=share.permission,
|
||||||
|
tenant_id=share.tenant_id,
|
||||||
|
source="campaigns.share",
|
||||||
|
details={
|
||||||
|
"target_type": share.target_type,
|
||||||
|
"target_id": share.target_id,
|
||||||
|
"permission": share.permission,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return tuple(items)
|
||||||
|
|
||||||
|
|
||||||
|
def access_capability(context: object) -> CampaignAccessService:
|
||||||
|
return CampaignAccessService()
|
||||||
|
|
||||||
|
|
||||||
|
def _owner_provenance(campaign: Campaign, principal: PrincipalRef) -> tuple[AccessDecisionProvenance, ...]:
|
||||||
|
if campaign.owner_user_id and campaign.owner_user_id == principal.membership_id:
|
||||||
|
return (
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="owner",
|
||||||
|
id=campaign.owner_user_id,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
source="campaigns.owner",
|
||||||
|
details={"owner_type": "user"},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if campaign.owner_group_id and campaign.owner_group_id in principal.group_ids:
|
||||||
|
return (
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="owner",
|
||||||
|
id=campaign.owner_group_id,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
source="campaigns.owner",
|
||||||
|
details={"owner_type": "group"},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
return ()
|
||||||
|
|
||||||
|
|
||||||
|
def _tenant_admin_provenance(principal: PrincipalRef) -> tuple[AccessDecisionProvenance, ...]:
|
||||||
|
if not scopes_grant_compatible(principal.scopes, "tenant:*"):
|
||||||
|
return ()
|
||||||
|
return (
|
||||||
|
AccessDecisionProvenance(
|
||||||
|
kind="policy",
|
||||||
|
id="tenant:*",
|
||||||
|
label="tenant:*",
|
||||||
|
tenant_id=principal.tenant_id,
|
||||||
|
source="campaigns.tenant_admin",
|
||||||
|
details={"grant": "tenant_admin"},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignPolicyContextService(CampaignPolicyContextProvider):
|
||||||
|
def get_campaign_policy_context(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
*,
|
||||||
|
tenant_id: str | None = None,
|
||||||
|
campaign_id: str,
|
||||||
|
) -> CampaignPolicyContext | None:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or (tenant_id is not None and campaign.tenant_id != tenant_id):
|
||||||
|
return None
|
||||||
|
return CampaignPolicyContext(
|
||||||
|
id=campaign.id,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
owner_user_id=campaign.owner_user_id,
|
||||||
|
owner_group_id=campaign.owner_group_id,
|
||||||
|
settings=dict(campaign.settings or {}),
|
||||||
|
)
|
||||||
|
|
||||||
|
def set_campaign_settings(
|
||||||
|
self,
|
||||||
|
session: object,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
settings: Mapping[str, object],
|
||||||
|
) -> Mapping[str, object]:
|
||||||
|
campaign = session.get(Campaign, campaign_id) # type: ignore[attr-defined]
|
||||||
|
if campaign is None or campaign.tenant_id != tenant_id:
|
||||||
|
raise ValueError("Campaign privacy policy not found")
|
||||||
|
payload = dict(settings)
|
||||||
|
campaign.settings = payload
|
||||||
|
session.add(campaign) # type: ignore[attr-defined]
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def policy_context_capability(context: object) -> CampaignPolicyContextService:
|
||||||
|
return CampaignPolicyContextService()
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignDeliveryTaskService(CampaignDeliveryTaskProvider):
|
||||||
|
def send_campaign_job(self, session: object, *, job_id: str, enqueue_imap_task: bool = True) -> Mapping[str, object]:
|
||||||
|
from govoplan_campaign.backend.sending.jobs import send_campaign_job
|
||||||
|
|
||||||
|
return send_campaign_job(session, job_id=job_id, enqueue_imap_task=enqueue_imap_task).as_dict() # type: ignore[arg-type]
|
||||||
|
|
||||||
|
def append_sent_for_job(self, session: object, *, job_id: str) -> Mapping[str, object]:
|
||||||
|
from govoplan_campaign.backend.sending.jobs import append_sent_for_job
|
||||||
|
|
||||||
|
return append_sent_for_job(session, job_id=job_id).as_dict() # type: ignore[arg-type]
|
||||||
|
|
||||||
|
|
||||||
|
def delivery_tasks_capability(context: object) -> CampaignDeliveryTaskService:
|
||||||
|
from govoplan_campaign.backend.runtime import configure_runtime
|
||||||
|
|
||||||
|
configure_runtime(
|
||||||
|
registry=getattr(context, "registry", None),
|
||||||
|
settings=getattr(context, "settings", None),
|
||||||
|
)
|
||||||
|
return CampaignDeliveryTaskService()
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRetentionService(CampaignRetentionProvider):
|
||||||
|
def apply_retention(self, session: object, *, dry_run, now, policy_for_campaign_id):
|
||||||
|
from govoplan_campaign.backend.retention import apply_campaign_retention
|
||||||
|
|
||||||
|
return apply_campaign_retention(session, dry_run=dry_run, now=now, policy_for_campaign_id=policy_for_campaign_id) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
|
||||||
|
def retention_capability(context: object) -> CampaignRetentionService:
|
||||||
|
return CampaignRetentionService()
|
||||||
330
src/govoplan_campaign/backend/change_tracking.py
Normal file
330
src/govoplan_campaign/backend/change_tracking.py
Normal file
@@ -0,0 +1,330 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from sqlalchemy import event
|
||||||
|
from sqlalchemy.orm import Session as OrmSession
|
||||||
|
|
||||||
|
from govoplan_core.core.change_sequence import record_change
|
||||||
|
from govoplan_core.core.sqlalchemy_change_tracking import (
|
||||||
|
ensure_object_id,
|
||||||
|
has_attr_changes,
|
||||||
|
object_state,
|
||||||
|
operation_for_object,
|
||||||
|
previous_value,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.db.models import (
|
||||||
|
Campaign,
|
||||||
|
CampaignIssue,
|
||||||
|
CampaignJob,
|
||||||
|
CampaignShare,
|
||||||
|
CampaignVersion,
|
||||||
|
ImapAppendAttempt,
|
||||||
|
SendAttempt,
|
||||||
|
new_uuid,
|
||||||
|
)
|
||||||
|
|
||||||
|
CAMPAIGNS_MODULE_ID = "campaigns"
|
||||||
|
CAMPAIGNS_COLLECTION = "campaigns.campaigns"
|
||||||
|
CAMPAIGN_VERSIONS_COLLECTION = "campaigns.versions"
|
||||||
|
CAMPAIGN_JOBS_COLLECTION = "campaigns.jobs"
|
||||||
|
CAMPAIGN_ISSUES_COLLECTION = "campaigns.issues"
|
||||||
|
CAMPAIGN_ATTEMPTS_COLLECTION = "campaigns.attempts"
|
||||||
|
|
||||||
|
_REGISTERED = False
|
||||||
|
|
||||||
|
|
||||||
|
def register_campaign_change_tracking() -> None:
|
||||||
|
global _REGISTERED
|
||||||
|
if _REGISTERED:
|
||||||
|
return
|
||||||
|
event.listen(OrmSession, "before_flush", _record_campaign_changes)
|
||||||
|
_REGISTERED = True
|
||||||
|
|
||||||
|
|
||||||
|
def _record_campaign_changes(session: OrmSession, _flush_context: object, _instances: object) -> None:
|
||||||
|
for obj in tuple(session.new) + tuple(session.dirty) + tuple(session.deleted):
|
||||||
|
if isinstance(obj, Campaign):
|
||||||
|
_record_campaign_change(session, obj)
|
||||||
|
elif isinstance(obj, CampaignShare):
|
||||||
|
_record_share_visibility_change(session, obj)
|
||||||
|
elif isinstance(obj, CampaignVersion):
|
||||||
|
_record_version_change(session, obj)
|
||||||
|
elif isinstance(obj, CampaignJob):
|
||||||
|
_record_job_change(session, obj)
|
||||||
|
elif isinstance(obj, CampaignIssue):
|
||||||
|
_record_issue_change(session, obj)
|
||||||
|
elif isinstance(obj, (SendAttempt, ImapAppendAttempt)):
|
||||||
|
_record_attempt_change(session, obj)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_campaign_change(session: OrmSession, campaign: Campaign) -> None:
|
||||||
|
operation = _operation_for_campaign(
|
||||||
|
campaign,
|
||||||
|
changed_attrs=(
|
||||||
|
"external_id",
|
||||||
|
"name",
|
||||||
|
"description",
|
||||||
|
"status",
|
||||||
|
"current_version_id",
|
||||||
|
"owner_user_id",
|
||||||
|
"owner_group_id",
|
||||||
|
"settings",
|
||||||
|
"mail_profile_policy",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if operation is None:
|
||||||
|
return
|
||||||
|
campaign_id = _ensure_id(campaign)
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGNS_COLLECTION,
|
||||||
|
resource_type="campaign",
|
||||||
|
resource_id=campaign_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
actor_type="user" if campaign.created_by_user_id else None,
|
||||||
|
actor_id=campaign.created_by_user_id,
|
||||||
|
payload=_campaign_payload(campaign),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_share_visibility_change(session: OrmSession, share: CampaignShare) -> None:
|
||||||
|
state = object_state(share)
|
||||||
|
if not share.campaign_id:
|
||||||
|
return
|
||||||
|
if not state.deleted and not state.pending and not has_attr_changes(
|
||||||
|
state,
|
||||||
|
("campaign_id", "target_type", "target_id", "permission", "revoked_at"),
|
||||||
|
):
|
||||||
|
return
|
||||||
|
_ensure_id(share)
|
||||||
|
operation = "deleted" if state.deleted or share.revoked_at is not None else "updated"
|
||||||
|
campaign = session.get(Campaign, share.campaign_id)
|
||||||
|
payload = _campaign_payload(campaign) if campaign is not None else {"campaign_id": share.campaign_id}
|
||||||
|
payload.update({
|
||||||
|
"share_id": share.id,
|
||||||
|
"share_target_type": share.target_type,
|
||||||
|
"share_target_id": share.target_id,
|
||||||
|
"share_permission": share.permission,
|
||||||
|
"share_revoked_at": _isoformat(share.revoked_at),
|
||||||
|
})
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGNS_COLLECTION,
|
||||||
|
resource_type="campaign",
|
||||||
|
resource_id=share.campaign_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=share.tenant_id,
|
||||||
|
actor_type="user" if share.created_by_user_id else None,
|
||||||
|
actor_id=share.created_by_user_id,
|
||||||
|
payload=payload,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_version_change(session: OrmSession, version: CampaignVersion) -> None:
|
||||||
|
operation = _operation_for_object(
|
||||||
|
version,
|
||||||
|
changed_attrs=(
|
||||||
|
"raw_json",
|
||||||
|
"schema_version",
|
||||||
|
"source_filename",
|
||||||
|
"source_base_path",
|
||||||
|
"workflow_state",
|
||||||
|
"current_flow",
|
||||||
|
"current_step",
|
||||||
|
"is_complete",
|
||||||
|
"editor_state",
|
||||||
|
"autosaved_at",
|
||||||
|
"published_at",
|
||||||
|
"locked_at",
|
||||||
|
"locked_by_user_id",
|
||||||
|
"user_lock_state",
|
||||||
|
"user_locked_at",
|
||||||
|
"user_locked_by_user_id",
|
||||||
|
"validation_summary",
|
||||||
|
"build_summary",
|
||||||
|
"execution_snapshot_hash",
|
||||||
|
"execution_snapshot_at",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if operation is None:
|
||||||
|
return
|
||||||
|
version_id = _ensure_id(version)
|
||||||
|
campaign = session.get(Campaign, version.campaign_id) if version.campaign_id else None
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGN_VERSIONS_COLLECTION,
|
||||||
|
resource_type="campaign_version",
|
||||||
|
resource_id=version_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=campaign.tenant_id if campaign is not None else None,
|
||||||
|
payload={
|
||||||
|
**(_campaign_payload(campaign) if campaign is not None else {"campaign_id": version.campaign_id}),
|
||||||
|
"version_id": version_id,
|
||||||
|
"version_number": version.version_number,
|
||||||
|
"workflow_state": version.workflow_state,
|
||||||
|
"current_flow": version.current_flow,
|
||||||
|
"current_step": version.current_step,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_job_change(session: OrmSession, job: CampaignJob) -> None:
|
||||||
|
operation = _operation_for_object(
|
||||||
|
job,
|
||||||
|
changed_attrs=(
|
||||||
|
"build_status",
|
||||||
|
"validation_status",
|
||||||
|
"queue_status",
|
||||||
|
"send_status",
|
||||||
|
"imap_status",
|
||||||
|
"attempt_count",
|
||||||
|
"last_error",
|
||||||
|
"queued_at",
|
||||||
|
"claimed_at",
|
||||||
|
"smtp_started_at",
|
||||||
|
"outcome_unknown_at",
|
||||||
|
"sent_at",
|
||||||
|
"resolved_recipients",
|
||||||
|
"resolved_attachments",
|
||||||
|
"issues_snapshot",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if operation is None:
|
||||||
|
return
|
||||||
|
job_id = _ensure_id(job)
|
||||||
|
campaign = session.get(Campaign, job.campaign_id) if job.campaign_id else None
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGN_JOBS_COLLECTION,
|
||||||
|
resource_type="campaign_job",
|
||||||
|
resource_id=job_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=job.tenant_id,
|
||||||
|
payload={
|
||||||
|
**(_campaign_payload(campaign) if campaign is not None else {"campaign_id": job.campaign_id}),
|
||||||
|
"job_id": job_id,
|
||||||
|
"version_id": job.campaign_version_id,
|
||||||
|
"entry_index": job.entry_index,
|
||||||
|
"entry_id": job.entry_id,
|
||||||
|
"build_status": job.build_status,
|
||||||
|
"validation_status": job.validation_status,
|
||||||
|
"queue_status": job.queue_status,
|
||||||
|
"send_status": job.send_status,
|
||||||
|
"imap_status": job.imap_status,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_issue_change(session: OrmSession, issue: CampaignIssue) -> None:
|
||||||
|
operation = _operation_for_object(issue, changed_attrs=("severity", "code", "message", "source", "behavior"))
|
||||||
|
if operation is None:
|
||||||
|
return
|
||||||
|
issue_id = _ensure_id(issue)
|
||||||
|
campaign = session.get(Campaign, issue.campaign_id) if issue.campaign_id else None
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGN_ISSUES_COLLECTION,
|
||||||
|
resource_type="campaign_issue",
|
||||||
|
resource_id=issue_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=issue.tenant_id,
|
||||||
|
payload={
|
||||||
|
**(_campaign_payload(campaign) if campaign is not None else {"campaign_id": issue.campaign_id}),
|
||||||
|
"issue_id": issue_id,
|
||||||
|
"version_id": issue.campaign_version_id,
|
||||||
|
"job_id": issue.job_id,
|
||||||
|
"severity": issue.severity,
|
||||||
|
"code": issue.code,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _record_attempt_change(session: OrmSession, attempt: SendAttempt | ImapAppendAttempt) -> None:
|
||||||
|
operation = _operation_for_object(
|
||||||
|
attempt,
|
||||||
|
changed_attrs=("status", "claim_token", "smtp_status_code", "smtp_response", "error_type", "error_message", "folder"),
|
||||||
|
)
|
||||||
|
if operation is None:
|
||||||
|
return
|
||||||
|
attempt_id = _ensure_id(attempt)
|
||||||
|
job = session.get(CampaignJob, attempt.job_id) if attempt.job_id else None
|
||||||
|
if job is None:
|
||||||
|
return
|
||||||
|
campaign = session.get(Campaign, job.campaign_id) if job.campaign_id else None
|
||||||
|
record_change(
|
||||||
|
session,
|
||||||
|
module_id=CAMPAIGNS_MODULE_ID,
|
||||||
|
collection=CAMPAIGN_ATTEMPTS_COLLECTION,
|
||||||
|
resource_type="campaign_attempt",
|
||||||
|
resource_id=attempt_id,
|
||||||
|
operation=operation,
|
||||||
|
tenant_id=job.tenant_id,
|
||||||
|
payload={
|
||||||
|
**(_campaign_payload(campaign) if campaign is not None else {"campaign_id": job.campaign_id}),
|
||||||
|
"attempt_id": attempt_id,
|
||||||
|
"attempt_kind": "imap" if isinstance(attempt, ImapAppendAttempt) else "smtp",
|
||||||
|
"job_id": job.id,
|
||||||
|
"version_id": job.campaign_version_id,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _operation_for_campaign(obj: Campaign, *, changed_attrs: tuple[str, ...]) -> str | None:
|
||||||
|
state = object_state(obj)
|
||||||
|
if state.pending:
|
||||||
|
return "created"
|
||||||
|
if state.deleted:
|
||||||
|
return "deleted"
|
||||||
|
if not has_attr_changes(state, changed_attrs):
|
||||||
|
return None
|
||||||
|
status_history = state.attrs.status.history
|
||||||
|
if status_history.has_changes() and any(value == "deleted" for value in status_history.added):
|
||||||
|
return "deleted"
|
||||||
|
return "updated"
|
||||||
|
|
||||||
|
|
||||||
|
def _operation_for_object(obj: object, *, changed_attrs: tuple[str, ...]) -> str | None:
|
||||||
|
return operation_for_object(obj, changed_attrs=changed_attrs)
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure_id(obj: object) -> str:
|
||||||
|
return ensure_object_id(obj, new_uuid)
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_payload(campaign: Campaign | None) -> dict[str, Any]:
|
||||||
|
if campaign is None:
|
||||||
|
return {}
|
||||||
|
return {
|
||||||
|
"campaign_id": campaign.id,
|
||||||
|
"owner_user_id": campaign.owner_user_id,
|
||||||
|
"owner_group_id": campaign.owner_group_id,
|
||||||
|
"previous_owner_user_id": previous_value(campaign, "owner_user_id"),
|
||||||
|
"previous_owner_group_id": previous_value(campaign, "owner_group_id"),
|
||||||
|
"status": campaign.status,
|
||||||
|
"previous_status": previous_value(campaign, "status"),
|
||||||
|
"current_version_id": campaign.current_version_id,
|
||||||
|
"previous_current_version_id": previous_value(campaign, "current_version_id"),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _isoformat(value: datetime | None) -> str | None:
|
||||||
|
return value.isoformat() if value else None
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"CAMPAIGNS_COLLECTION",
|
||||||
|
"CAMPAIGNS_MODULE_ID",
|
||||||
|
"CAMPAIGN_ATTEMPTS_COLLECTION",
|
||||||
|
"CAMPAIGN_ISSUES_COLLECTION",
|
||||||
|
"CAMPAIGN_JOBS_COLLECTION",
|
||||||
|
"CAMPAIGN_VERSIONS_COLLECTION",
|
||||||
|
"register_campaign_change_tracking",
|
||||||
|
]
|
||||||
@@ -10,11 +10,6 @@ from sqlalchemy.orm import Mapped, mapped_column, relationship
|
|||||||
|
|
||||||
from govoplan_core.db.base import Base, TimestampMixin
|
from govoplan_core.db.base import Base, TimestampMixin
|
||||||
|
|
||||||
try:
|
|
||||||
from govoplan_core.db.models import Group, Tenant, User, UserGroupMembership
|
|
||||||
except (ImportError, ModuleNotFoundError):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def new_uuid() -> str:
|
def new_uuid() -> str:
|
||||||
return str(uuid.uuid4())
|
return str(uuid.uuid4())
|
||||||
@@ -83,6 +78,7 @@ class JobQueueStatus(StrEnum):
|
|||||||
|
|
||||||
class JobSendStatus(StrEnum):
|
class JobSendStatus(StrEnum):
|
||||||
NOT_QUEUED = "not_queued"
|
NOT_QUEUED = "not_queued"
|
||||||
|
SKIPPED = "skipped"
|
||||||
QUEUED = "queued"
|
QUEUED = "queued"
|
||||||
CLAIMED = "claimed"
|
CLAIMED = "claimed"
|
||||||
SENDING = "sending"
|
SENDING = "sending"
|
||||||
@@ -97,7 +93,9 @@ class JobSendStatus(StrEnum):
|
|||||||
class JobImapStatus(StrEnum):
|
class JobImapStatus(StrEnum):
|
||||||
NOT_REQUESTED = "not_requested"
|
NOT_REQUESTED = "not_requested"
|
||||||
PENDING = "pending"
|
PENDING = "pending"
|
||||||
|
APPENDING = "appending"
|
||||||
APPENDED = "appended"
|
APPENDED = "appended"
|
||||||
|
OUTCOME_UNKNOWN = "outcome_unknown"
|
||||||
FAILED = "failed"
|
FAILED = "failed"
|
||||||
SKIPPED = "skipped"
|
SKIPPED = "skipped"
|
||||||
|
|
||||||
@@ -113,10 +111,10 @@ class Campaign(Base, TimestampMixin):
|
|||||||
__table_args__ = (UniqueConstraint("tenant_id", "external_id", name="uq_campaigns_tenant_external_id"),)
|
__table_args__ = (UniqueConstraint("tenant_id", "external_id", name="uq_campaigns_tenant_external_id"),)
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
created_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
created_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
owner_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
owner_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
owner_group_id: Mapped[str | None] = mapped_column(ForeignKey("groups.id", ondelete="SET NULL"), nullable=True, index=True)
|
owner_group_id: Mapped[str | None] = mapped_column(ForeignKey("access_groups.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
external_id: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
|
external_id: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
|
||||||
name: Mapped[str] = mapped_column(String(255), nullable=False)
|
name: Mapped[str] = mapped_column(String(255), nullable=False)
|
||||||
description: Mapped[str | None] = mapped_column(Text)
|
description: Mapped[str | None] = mapped_column(Text)
|
||||||
@@ -125,7 +123,6 @@ class Campaign(Base, TimestampMixin):
|
|||||||
settings: Mapped[dict[str, Any]] = mapped_column(JSON, default=dict, nullable=False)
|
settings: Mapped[dict[str, Any]] = mapped_column(JSON, default=dict, nullable=False)
|
||||||
mail_profile_policy: Mapped[dict[str, Any]] = mapped_column(JSON, default=dict, nullable=False)
|
mail_profile_policy: Mapped[dict[str, Any]] = mapped_column(JSON, default=dict, nullable=False)
|
||||||
|
|
||||||
tenant: Mapped[Tenant] = relationship()
|
|
||||||
versions: Mapped[list[CampaignVersion]] = relationship(back_populates="campaign", cascade="all, delete-orphan")
|
versions: Mapped[list[CampaignVersion]] = relationship(back_populates="campaign", cascade="all, delete-orphan")
|
||||||
jobs: Mapped[list[CampaignJob]] = relationship(back_populates="campaign", cascade="all, delete-orphan")
|
jobs: Mapped[list[CampaignJob]] = relationship(back_populates="campaign", cascade="all, delete-orphan")
|
||||||
|
|
||||||
@@ -135,15 +132,39 @@ class CampaignShare(Base, TimestampMixin):
|
|||||||
__table_args__ = (UniqueConstraint("campaign_id", "target_type", "target_id", name="uq_campaign_share_target"),)
|
__table_args__ = (UniqueConstraint("campaign_id", "target_type", "target_id", name="uq_campaign_share_target"),)
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
target_type: Mapped[str] = mapped_column(String(20), nullable=False, index=True)
|
target_type: Mapped[str] = mapped_column(String(20), nullable=False, index=True)
|
||||||
target_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
target_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
permission: Mapped[str] = mapped_column(String(20), default="read", nullable=False)
|
permission: Mapped[str] = mapped_column(String(20), default="read", nullable=False)
|
||||||
created_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
created_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
revoked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True, index=True)
|
revoked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True), nullable=True, index=True)
|
||||||
|
|
||||||
|
|
||||||
|
class RecipientImportMappingProfile(Base, TimestampMixin):
|
||||||
|
__tablename__ = "campaign_recipient_import_mapping_profiles"
|
||||||
|
__table_args__ = (
|
||||||
|
Index("ix_recipient_import_profiles_owner", "tenant_id", "owner_user_id"),
|
||||||
|
Index("ix_recipient_import_profiles_ordered_fp", "tenant_id", "owner_user_id", "ordered_header_fingerprint"),
|
||||||
|
Index("ix_recipient_import_profiles_unordered_fp", "tenant_id", "owner_user_id", "unordered_header_fingerprint"),
|
||||||
|
)
|
||||||
|
|
||||||
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
|
owner_user_id: Mapped[str] = mapped_column(ForeignKey("access_users.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
|
name: Mapped[str] = mapped_column(String(255), nullable=False)
|
||||||
|
column_count: Mapped[int] = mapped_column(Integer, nullable=False)
|
||||||
|
headers: Mapped[list[str]] = mapped_column(JSON, default=list, nullable=False)
|
||||||
|
normalized_headers: Mapped[list[str]] = mapped_column(JSON, default=list, nullable=False)
|
||||||
|
ordered_header_fingerprint: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
|
||||||
|
unordered_header_fingerprint: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
|
||||||
|
delimiter: Mapped[str] = mapped_column(String(8), nullable=False)
|
||||||
|
header_rows: Mapped[int] = mapped_column(Integer, default=1, nullable=False)
|
||||||
|
quoted: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False)
|
||||||
|
value_separators: Mapped[str] = mapped_column(String(50), default=",;|", nullable=False)
|
||||||
|
mappings: Mapped[list[dict[str, Any]]] = mapped_column(JSON, default=list, nullable=False)
|
||||||
|
|
||||||
|
|
||||||
class CampaignVersion(Base, TimestampMixin):
|
class CampaignVersion(Base, TimestampMixin):
|
||||||
__tablename__ = "campaign_versions"
|
__tablename__ = "campaign_versions"
|
||||||
__table_args__ = (UniqueConstraint("campaign_id", "version_number", name="uq_campaign_versions_campaign_number"),)
|
__table_args__ = (UniqueConstraint("campaign_id", "version_number", name="uq_campaign_versions_campaign_number"),)
|
||||||
@@ -177,7 +198,7 @@ class CampaignVersion(Base, TimestampMixin):
|
|||||||
autosaved_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
autosaved_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
published_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
published_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
locked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
locked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
locked_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
locked_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
|
|
||||||
# Explicit user-requested lock. This is deliberately separate from
|
# Explicit user-requested lock. This is deliberately separate from
|
||||||
# locked_at, which represents the reversible validation lock used by the
|
# locked_at, which represents the reversible validation lock used by the
|
||||||
@@ -185,23 +206,31 @@ class CampaignVersion(Base, TimestampMixin):
|
|||||||
# RBAC permission for unlocking; permanent locks never unlock in place.
|
# RBAC permission for unlocking; permanent locks never unlock in place.
|
||||||
user_lock_state: Mapped[str | None] = mapped_column(String(20), nullable=True, index=True)
|
user_lock_state: Mapped[str | None] = mapped_column(String(20), nullable=True, index=True)
|
||||||
user_locked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
user_locked_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
user_locked_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
user_locked_by_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
|
|
||||||
validation_summary: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
validation_summary: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
||||||
build_summary: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
build_summary: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
||||||
execution_snapshot: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
execution_snapshot: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
||||||
execution_snapshot_hash: Mapped[str | None] = mapped_column(String(64), nullable=True, index=True)
|
execution_snapshot_hash: Mapped[str | None] = mapped_column(String(64), nullable=True, index=True)
|
||||||
execution_snapshot_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
execution_snapshot_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
|
delivery_mode: Mapped[str | None] = mapped_column(String(30), nullable=True, index=True)
|
||||||
|
delivery_mode_selected_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
|
|
||||||
campaign: Mapped[Campaign] = relationship(back_populates="versions")
|
campaign: Mapped[Campaign] = relationship(back_populates="versions")
|
||||||
|
|
||||||
|
@property
|
||||||
|
def mail_profile_migration_required(self) -> bool:
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import campaign_mail_profile_boundary_violations
|
||||||
|
|
||||||
|
return bool(campaign_mail_profile_boundary_violations(self.raw_json))
|
||||||
|
|
||||||
|
|
||||||
class CampaignJob(Base, TimestampMixin):
|
class CampaignJob(Base, TimestampMixin):
|
||||||
__tablename__ = "campaign_jobs"
|
__tablename__ = "campaign_jobs"
|
||||||
__table_args__ = (UniqueConstraint("campaign_version_id", "entry_index", name="uq_campaign_jobs_version_entry"),)
|
__table_args__ = (UniqueConstraint("campaign_version_id", "entry_index", name="uq_campaign_jobs_version_entry"),)
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
campaign_version_id: Mapped[str] = mapped_column(ForeignKey("campaign_versions.id", ondelete="CASCADE"), nullable=False, index=True)
|
campaign_version_id: Mapped[str] = mapped_column(ForeignKey("campaign_versions.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
entry_index: Mapped[int] = mapped_column(Integer, nullable=False)
|
entry_index: Mapped[int] = mapped_column(Integer, nullable=False)
|
||||||
@@ -214,6 +243,7 @@ class CampaignJob(Base, TimestampMixin):
|
|||||||
eml_local_path: Mapped[str | None] = mapped_column(String(1000))
|
eml_local_path: Mapped[str | None] = mapped_column(String(1000))
|
||||||
eml_size_bytes: Mapped[int | None] = mapped_column(Integer)
|
eml_size_bytes: Mapped[int | None] = mapped_column(Integer)
|
||||||
eml_sha256: Mapped[str | None] = mapped_column(String(64), nullable=True, index=True)
|
eml_sha256: Mapped[str | None] = mapped_column(String(64), nullable=True, index=True)
|
||||||
|
execution_input_sha256: Mapped[str | None] = mapped_column(String(64), nullable=True)
|
||||||
|
|
||||||
build_status: Mapped[str] = mapped_column(String(50), default=JobBuildStatus.PENDING.value, nullable=False, index=True)
|
build_status: Mapped[str] = mapped_column(String(50), default=JobBuildStatus.PENDING.value, nullable=False, index=True)
|
||||||
validation_status: Mapped[str] = mapped_column(String(50), default=JobValidationStatus.NEEDS_REVIEW.value, nullable=False, index=True)
|
validation_status: Mapped[str] = mapped_column(String(50), default=JobValidationStatus.NEEDS_REVIEW.value, nullable=False, index=True)
|
||||||
@@ -228,6 +258,8 @@ class CampaignJob(Base, TimestampMixin):
|
|||||||
claim_token: Mapped[str | None] = mapped_column(String(36), nullable=True, index=True)
|
claim_token: Mapped[str | None] = mapped_column(String(36), nullable=True, index=True)
|
||||||
smtp_started_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
smtp_started_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
outcome_unknown_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
outcome_unknown_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
|
imap_claimed_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
|
imap_claim_token: Mapped[str | None] = mapped_column(String(36), nullable=True, index=True)
|
||||||
sent_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
sent_at: Mapped[datetime | None] = mapped_column(DateTime(timezone=True))
|
||||||
|
|
||||||
resolved_recipients: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
resolved_recipients: Mapped[dict[str, Any] | None] = mapped_column(JSON, nullable=True)
|
||||||
@@ -241,7 +273,7 @@ class CampaignIssue(Base, TimestampMixin):
|
|||||||
__tablename__ = "campaign_issues"
|
__tablename__ = "campaign_issues"
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
campaign_id: Mapped[str] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
campaign_version_id: Mapped[str | None] = mapped_column(ForeignKey("campaign_versions.id", ondelete="CASCADE"), nullable=True, index=True)
|
campaign_version_id: Mapped[str | None] = mapped_column(ForeignKey("campaign_versions.id", ondelete="CASCADE"), nullable=True, index=True)
|
||||||
job_id: Mapped[str | None] = mapped_column(ForeignKey("campaign_jobs.id", ondelete="CASCADE"), nullable=True, index=True)
|
job_id: Mapped[str | None] = mapped_column(ForeignKey("campaign_jobs.id", ondelete="CASCADE"), nullable=True, index=True)
|
||||||
@@ -257,7 +289,7 @@ class AttachmentBlob(Base, TimestampMixin):
|
|||||||
__table_args__ = (UniqueConstraint("tenant_id", "sha256", name="uq_attachment_blobs_tenant_sha256"),)
|
__table_args__ = (UniqueConstraint("tenant_id", "sha256", name="uq_attachment_blobs_tenant_sha256"),)
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
sha256: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
|
sha256: Mapped[str] = mapped_column(String(64), nullable=False, index=True)
|
||||||
size_bytes: Mapped[int] = mapped_column(Integer, nullable=False)
|
size_bytes: Mapped[int] = mapped_column(Integer, nullable=False)
|
||||||
mime_type: Mapped[str | None] = mapped_column(String(255))
|
mime_type: Mapped[str | None] = mapped_column(String(255))
|
||||||
@@ -269,8 +301,8 @@ class AttachmentInstance(Base, TimestampMixin):
|
|||||||
__tablename__ = "attachment_instances"
|
__tablename__ = "attachment_instances"
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
tenant_id: Mapped[str] = mapped_column(ForeignKey("tenants.id", ondelete="CASCADE"), nullable=False, index=True)
|
tenant_id: Mapped[str] = mapped_column(String(36), nullable=False, index=True)
|
||||||
owner_user_id: Mapped[str | None] = mapped_column(ForeignKey("users.id", ondelete="SET NULL"), nullable=True, index=True)
|
owner_user_id: Mapped[str | None] = mapped_column(ForeignKey("access_users.id", ondelete="SET NULL"), nullable=True, index=True)
|
||||||
campaign_id: Mapped[str | None] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=True, index=True)
|
campaign_id: Mapped[str | None] = mapped_column(ForeignKey("campaigns.id", ondelete="CASCADE"), nullable=True, index=True)
|
||||||
blob_id: Mapped[str] = mapped_column(ForeignKey("attachment_blobs.id", ondelete="CASCADE"), nullable=False, index=True)
|
blob_id: Mapped[str] = mapped_column(ForeignKey("attachment_blobs.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
logical_name: Mapped[str | None] = mapped_column(String(500))
|
logical_name: Mapped[str | None] = mapped_column(String(500))
|
||||||
@@ -297,10 +329,14 @@ class SendAttempt(Base, TimestampMixin):
|
|||||||
|
|
||||||
class ImapAppendAttempt(Base, TimestampMixin):
|
class ImapAppendAttempt(Base, TimestampMixin):
|
||||||
__tablename__ = "imap_append_attempts"
|
__tablename__ = "imap_append_attempts"
|
||||||
|
__table_args__ = (
|
||||||
|
UniqueConstraint("job_id", "attempt_number", name="uq_imap_append_attempts_job_attempt"),
|
||||||
|
)
|
||||||
|
|
||||||
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
id: Mapped[str] = mapped_column(String(36), primary_key=True, default=new_uuid)
|
||||||
job_id: Mapped[str] = mapped_column(ForeignKey("campaign_jobs.id", ondelete="CASCADE"), nullable=False, index=True)
|
job_id: Mapped[str] = mapped_column(ForeignKey("campaign_jobs.id", ondelete="CASCADE"), nullable=False, index=True)
|
||||||
attempt_number: Mapped[int] = mapped_column(Integer, nullable=False)
|
attempt_number: Mapped[int] = mapped_column(Integer, nullable=False)
|
||||||
|
claim_token: Mapped[str | None] = mapped_column(String(36), nullable=True)
|
||||||
folder: Mapped[str | None] = mapped_column(String(500))
|
folder: Mapped[str | None] = mapped_column(String(500))
|
||||||
status: Mapped[str] = mapped_column(String(50), nullable=False)
|
status: Mapped[str] = mapped_column(String(50), nullable=False)
|
||||||
error_message: Mapped[str | None] = mapped_column(Text)
|
error_message: Mapped[str | None] = mapped_column(Text)
|
||||||
@@ -319,7 +355,6 @@ __all__ = [
|
|||||||
"CampaignVersion",
|
"CampaignVersion",
|
||||||
"CampaignVersionFlow",
|
"CampaignVersionFlow",
|
||||||
"CampaignVersionWorkflowState",
|
"CampaignVersionWorkflowState",
|
||||||
"Group",
|
|
||||||
"ImapAppendAttempt",
|
"ImapAppendAttempt",
|
||||||
"IssueSeverity",
|
"IssueSeverity",
|
||||||
"JobBuildStatus",
|
"JobBuildStatus",
|
||||||
@@ -328,7 +363,4 @@ __all__ = [
|
|||||||
"JobSendStatus",
|
"JobSendStatus",
|
||||||
"JobValidationStatus",
|
"JobValidationStatus",
|
||||||
"SendAttempt",
|
"SendAttempt",
|
||||||
"Tenant",
|
|
||||||
"User",
|
|
||||||
"UserGroupMembership",
|
|
||||||
]
|
]
|
||||||
|
|||||||
107
src/govoplan_campaign/backend/delivery_policy.py
Normal file
107
src/govoplan_campaign/backend/delivery_policy.py
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Any, Mapping
|
||||||
|
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_core.tenancy.scope import Tenant
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS = 25
|
||||||
|
ABSOLUTE_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS = 500
|
||||||
|
SYNCHRONOUS_SEND_MAX_ENV = "GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS"
|
||||||
|
CAMPAIGN_DELIVERY_POLICY_SETTINGS_KEY = "campaign_delivery_policy"
|
||||||
|
SYNCHRONOUS_SEND_MAX_SETTINGS_KEY = "synchronous_send_max_recipients"
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignDeliveryPolicyError(RuntimeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True, slots=True)
|
||||||
|
class SynchronousSendPolicy:
|
||||||
|
max_recipient_jobs: int
|
||||||
|
source: str
|
||||||
|
deployment_max_recipient_jobs: int
|
||||||
|
tenant_max_recipient_jobs: int | None = None
|
||||||
|
|
||||||
|
def as_dict(self) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"max_recipient_jobs": self.max_recipient_jobs,
|
||||||
|
"source": self.source,
|
||||||
|
"deployment_max_recipient_jobs": self.deployment_max_recipient_jobs,
|
||||||
|
"tenant_max_recipient_jobs": self.tenant_max_recipient_jobs,
|
||||||
|
"deployment_setting": SYNCHRONOUS_SEND_MAX_ENV,
|
||||||
|
"tenant_setting": (
|
||||||
|
f"tenant.settings.{CAMPAIGN_DELIVERY_POLICY_SETTINGS_KEY}."
|
||||||
|
f"{SYNCHRONOUS_SEND_MAX_SETTINGS_KEY}"
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def effective_synchronous_send_policy(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
environ: Mapping[str, str] | None = None,
|
||||||
|
) -> SynchronousSendPolicy:
|
||||||
|
env = os.environ if environ is None else environ
|
||||||
|
deployment_value = _configured_limit(
|
||||||
|
env.get(SYNCHRONOUS_SEND_MAX_ENV),
|
||||||
|
source=SYNCHRONOUS_SEND_MAX_ENV,
|
||||||
|
default=DEFAULT_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS,
|
||||||
|
)
|
||||||
|
tenant = session.get(Tenant, tenant_id)
|
||||||
|
tenant_raw = _tenant_limit_value(tenant.settings if tenant is not None else None)
|
||||||
|
if tenant_raw is None:
|
||||||
|
return SynchronousSendPolicy(
|
||||||
|
max_recipient_jobs=deployment_value,
|
||||||
|
source=("deployment" if env.get(SYNCHRONOUS_SEND_MAX_ENV) not in (None, "") else "deployment_default"),
|
||||||
|
deployment_max_recipient_jobs=deployment_value,
|
||||||
|
)
|
||||||
|
|
||||||
|
tenant_value = _configured_limit(
|
||||||
|
tenant_raw,
|
||||||
|
source=(
|
||||||
|
f"tenant.settings.{CAMPAIGN_DELIVERY_POLICY_SETTINGS_KEY}."
|
||||||
|
f"{SYNCHRONOUS_SEND_MAX_SETTINGS_KEY}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
effective_value = min(deployment_value, tenant_value)
|
||||||
|
return SynchronousSendPolicy(
|
||||||
|
max_recipient_jobs=effective_value,
|
||||||
|
source="tenant" if tenant_value <= deployment_value else "deployment_ceiling",
|
||||||
|
deployment_max_recipient_jobs=deployment_value,
|
||||||
|
tenant_max_recipient_jobs=tenant_value,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _tenant_limit_value(settings: Mapping[str, Any] | None) -> object | None:
|
||||||
|
if not isinstance(settings, Mapping):
|
||||||
|
return None
|
||||||
|
policy = settings.get(CAMPAIGN_DELIVERY_POLICY_SETTINGS_KEY)
|
||||||
|
if not isinstance(policy, Mapping):
|
||||||
|
return None
|
||||||
|
return policy.get(SYNCHRONOUS_SEND_MAX_SETTINGS_KEY)
|
||||||
|
|
||||||
|
|
||||||
|
def _configured_limit(value: object, *, source: str, default: int | None = None) -> int:
|
||||||
|
if value is None or (isinstance(value, str) and not value.strip()):
|
||||||
|
if default is not None:
|
||||||
|
return default
|
||||||
|
raise CampaignDeliveryPolicyError(f"{source} must be configured as an integer")
|
||||||
|
if isinstance(value, bool):
|
||||||
|
raise CampaignDeliveryPolicyError(f"{source} must be an integer, not a boolean")
|
||||||
|
try:
|
||||||
|
parsed = int(value)
|
||||||
|
except (TypeError, ValueError) as exc:
|
||||||
|
raise CampaignDeliveryPolicyError(f"{source} must be an integer") from exc
|
||||||
|
if str(parsed) != str(value).strip() and not isinstance(value, int):
|
||||||
|
raise CampaignDeliveryPolicyError(f"{source} must be an integer")
|
||||||
|
if parsed < 0 or parsed > ABSOLUTE_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS:
|
||||||
|
raise CampaignDeliveryPolicyError(
|
||||||
|
f"{source} must be between 0 and {ABSOLUTE_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS}"
|
||||||
|
)
|
||||||
|
return parsed
|
||||||
@@ -1,36 +1,55 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
from email import policy
|
from email import policy
|
||||||
from email.message import EmailMessage
|
from email.message import EmailMessage
|
||||||
from importlib import import_module
|
|
||||||
from types import ModuleType
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from sqlalchemy.orm import Session
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
from govoplan_campaign.backend.db.models import Campaign, CampaignVersion
|
from govoplan_campaign.backend.db.models import Campaign, CampaignVersion
|
||||||
from govoplan_core.core.optional import reraise_unless_missing_package
|
|
||||||
from govoplan_campaign.backend.campaign.loader import load_campaign_json
|
from govoplan_campaign.backend.campaign.loader import load_campaign_json
|
||||||
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
||||||
from govoplan_campaign.backend.persistence.campaigns import load_campaign_config_from_json
|
from govoplan_campaign.backend.persistence.campaigns import load_campaign_config_from_json
|
||||||
from govoplan_campaign.backend.messages.builder import build_campaign_messages
|
from govoplan_campaign.backend.messages.builder import build_campaign_messages
|
||||||
from govoplan_campaign.backend.messages.models import MessageAddress, MessageDraft, MessageValidationStatus
|
from govoplan_campaign.backend.messages.models import MessageAddress, MessageDraft, MessageValidationStatus
|
||||||
from govoplan_campaign.backend.integrations import files_integration
|
from govoplan_campaign.backend.integrations import files_integration, mail_integration
|
||||||
|
from govoplan_campaign.backend.path_security import assert_server_safe_campaign_paths
|
||||||
|
|
||||||
|
|
||||||
class MockCampaignSendError(RuntimeError):
|
class MockCampaignSendError(RuntimeError):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def _mock_mailbox() -> ModuleType | None:
|
@dataclass(slots=True)
|
||||||
try:
|
class _MockSendOutcome:
|
||||||
return import_module("govoplan_mail.backend.dev.mock_mailbox")
|
row: dict[str, Any]
|
||||||
except ModuleNotFoundError as exc:
|
sent_count: int = 0
|
||||||
reraise_unless_missing_package(exc, "govoplan_mail")
|
failed_count: int = 0
|
||||||
return None
|
skipped_count: int = 0
|
||||||
|
imap_appended_count: int = 0
|
||||||
|
imap_failed_count: int = 0
|
||||||
|
|
||||||
|
|
||||||
def _require_mock_mailbox() -> ModuleType:
|
@dataclass(slots=True)
|
||||||
|
class _MockSendBatch:
|
||||||
|
results: list[dict[str, Any]]
|
||||||
|
sent_count: int = 0
|
||||||
|
failed_count: int = 0
|
||||||
|
skipped_count: int = 0
|
||||||
|
imap_appended_count: int = 0
|
||||||
|
imap_failed_count: int = 0
|
||||||
|
|
||||||
|
@property
|
||||||
|
def attempted_count(self) -> int:
|
||||||
|
return self.sent_count + self.failed_count
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_mailbox() -> Any | None:
|
||||||
|
return mail_integration().mock_mailbox()
|
||||||
|
|
||||||
|
|
||||||
|
def _require_mock_mailbox() -> Any:
|
||||||
mailbox = _mock_mailbox()
|
mailbox = _mock_mailbox()
|
||||||
if mailbox is None:
|
if mailbox is None:
|
||||||
raise MockCampaignSendError("Mail module is not available")
|
raise MockCampaignSendError("Mail module is not available")
|
||||||
@@ -123,6 +142,394 @@ def _can_mock_send(
|
|||||||
return False, f"Validation status is {message.validation_status.value}"
|
return False, f"Validation status is {message.validation_status.value}"
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_send_batch(
|
||||||
|
*,
|
||||||
|
config: Any,
|
||||||
|
built_messages: list[Any],
|
||||||
|
mailbox: Any | None,
|
||||||
|
send: bool,
|
||||||
|
include_warnings: bool,
|
||||||
|
include_needs_review: bool,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> _MockSendBatch:
|
||||||
|
batch = _MockSendBatch(results=[])
|
||||||
|
for built in built_messages:
|
||||||
|
outcome = _mock_send_message(
|
||||||
|
config=config,
|
||||||
|
built=built,
|
||||||
|
mailbox=mailbox,
|
||||||
|
send=send,
|
||||||
|
include_warnings=include_warnings,
|
||||||
|
include_needs_review=include_needs_review,
|
||||||
|
append_sent=append_sent,
|
||||||
|
)
|
||||||
|
batch.results.append(outcome.row)
|
||||||
|
batch.sent_count += outcome.sent_count
|
||||||
|
batch.failed_count += outcome.failed_count
|
||||||
|
batch.skipped_count += outcome.skipped_count
|
||||||
|
batch.imap_appended_count += outcome.imap_appended_count
|
||||||
|
batch.imap_failed_count += outcome.imap_failed_count
|
||||||
|
return batch
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_send_message(
|
||||||
|
*,
|
||||||
|
config: Any,
|
||||||
|
built: Any,
|
||||||
|
mailbox: Any | None,
|
||||||
|
send: bool,
|
||||||
|
include_warnings: bool,
|
||||||
|
include_needs_review: bool,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> _MockSendOutcome:
|
||||||
|
draft = built.draft
|
||||||
|
row = _mock_send_row(draft)
|
||||||
|
can_send, skip_reason = _can_mock_send(
|
||||||
|
draft,
|
||||||
|
include_warnings=include_warnings,
|
||||||
|
include_needs_review=include_needs_review,
|
||||||
|
)
|
||||||
|
if not can_send or built.mime is None:
|
||||||
|
row.update({"status": "skipped", "message": skip_reason or "Message has no MIME output"})
|
||||||
|
return _MockSendOutcome(row=row, skipped_count=1)
|
||||||
|
|
||||||
|
recipients = _recipient_emails(draft)
|
||||||
|
envelope_from = _envelope_from(draft)
|
||||||
|
if not recipients:
|
||||||
|
row.update({"status": "skipped", "message": "No envelope recipients"})
|
||||||
|
return _MockSendOutcome(row=row, skipped_count=1)
|
||||||
|
if not send:
|
||||||
|
row.update({
|
||||||
|
"status": "ready",
|
||||||
|
"message": f"Would send to {len(recipients)} recipient(s)",
|
||||||
|
"envelope_from": envelope_from,
|
||||||
|
"envelope_recipients": recipients,
|
||||||
|
})
|
||||||
|
return _MockSendOutcome(row=row)
|
||||||
|
return _send_mock_smtp_message(
|
||||||
|
config=config,
|
||||||
|
built=built,
|
||||||
|
mailbox=mailbox,
|
||||||
|
row=row,
|
||||||
|
recipients=recipients,
|
||||||
|
envelope_from=envelope_from,
|
||||||
|
append_sent=append_sent,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_send_row(draft: MessageDraft) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"entry_index": draft.entry_index,
|
||||||
|
"entry_id": draft.entry_id,
|
||||||
|
"subject": draft.subject,
|
||||||
|
"validation_status": draft.validation_status.value,
|
||||||
|
"build_status": str(draft.build_status.value if hasattr(draft.build_status, "value") else draft.build_status),
|
||||||
|
"to": _message_addresses_payload(draft.to),
|
||||||
|
"attachments": _attachment_payloads(draft),
|
||||||
|
"issues": _issue_payloads(draft),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _send_mock_smtp_message(
|
||||||
|
*,
|
||||||
|
config: Any,
|
||||||
|
built: Any,
|
||||||
|
mailbox: Any | None,
|
||||||
|
row: dict[str, Any],
|
||||||
|
recipients: list[str],
|
||||||
|
envelope_from: str,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> _MockSendOutcome:
|
||||||
|
try:
|
||||||
|
if mailbox is not None and mailbox.consume_fail_next_smtp():
|
||||||
|
raise MockCampaignSendError("Configured mock failure: next SMTP delivery fails")
|
||||||
|
rejected = _smtp_rejection_matches(recipients)
|
||||||
|
if rejected and len(rejected) == len(recipients):
|
||||||
|
raise MockCampaignSendError(f"Configured mock failure: all recipients rejected ({', '.join(rejected)})")
|
||||||
|
|
||||||
|
accepted = [recipient for recipient in recipients if recipient not in rejected]
|
||||||
|
smtp_record = mailbox.record_smtp_delivery(
|
||||||
|
built.mime,
|
||||||
|
envelope_from=envelope_from,
|
||||||
|
envelope_recipients=accepted,
|
||||||
|
smtp_host="mock.smtp.local",
|
||||||
|
)
|
||||||
|
row.update({
|
||||||
|
"status": "sent",
|
||||||
|
"message": f"Mock SMTP captured as {smtp_record.id}",
|
||||||
|
"smtp_message_id": smtp_record.id,
|
||||||
|
"envelope_from": envelope_from,
|
||||||
|
"envelope_recipients": accepted,
|
||||||
|
"refused_recipients": rejected,
|
||||||
|
})
|
||||||
|
imap_appended, imap_failed = _append_mock_sent_message(config, built, mailbox, row, append_sent=append_sent)
|
||||||
|
return _MockSendOutcome(row=row, sent_count=1, imap_appended_count=imap_appended, imap_failed_count=imap_failed)
|
||||||
|
except Exception as exc:
|
||||||
|
row.update({"status": "failed", "message": str(exc), "envelope_from": envelope_from, "envelope_recipients": recipients})
|
||||||
|
return _MockSendOutcome(row=row, failed_count=1)
|
||||||
|
|
||||||
|
|
||||||
|
def _append_mock_sent_message(
|
||||||
|
config: Any,
|
||||||
|
built: Any,
|
||||||
|
mailbox: Any | None,
|
||||||
|
row: dict[str, Any],
|
||||||
|
*,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> tuple[int, int]:
|
||||||
|
if not append_sent:
|
||||||
|
return 0, 0
|
||||||
|
try:
|
||||||
|
if mailbox is not None and mailbox.consume_fail_next_imap():
|
||||||
|
raise MockCampaignSendError("Configured mock failure: next IMAP append fails")
|
||||||
|
folder = _mock_sent_folder(config)
|
||||||
|
imap_record = mailbox.record_imap_append(_raw_message_bytes(built.mime), folder=folder, imap_host="mock.imap.local")
|
||||||
|
row.update({"imap_status": "appended", "imap_message_id": imap_record.id, "imap_folder": folder})
|
||||||
|
return 1, 0
|
||||||
|
except Exception as exc:
|
||||||
|
row.update({"imap_status": "failed", "imap_error": str(exc)})
|
||||||
|
return 0, 1
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_sent_folder(config: Any) -> str:
|
||||||
|
if config.delivery.imap_append_sent.folder and config.delivery.imap_append_sent.folder != "auto":
|
||||||
|
return config.delivery.imap_append_sent.folder
|
||||||
|
if config.server.imap and config.server.imap.sent_folder and config.server.imap.sent_folder != "auto":
|
||||||
|
return config.server.imap.sent_folder
|
||||||
|
return "Sent"
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_campaign_version(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
version_id: str | None,
|
||||||
|
) -> tuple[Campaign, CampaignVersion]:
|
||||||
|
campaign = (
|
||||||
|
session.query(Campaign)
|
||||||
|
.filter(Campaign.id == campaign_id, Campaign.tenant_id == tenant_id)
|
||||||
|
.one_or_none()
|
||||||
|
)
|
||||||
|
if not campaign:
|
||||||
|
raise MockCampaignSendError("Campaign not found or not accessible")
|
||||||
|
wanted_version_id = version_id or campaign.current_version_id
|
||||||
|
if not wanted_version_id:
|
||||||
|
raise MockCampaignSendError("Campaign has no current version")
|
||||||
|
version = session.get(CampaignVersion, wanted_version_id)
|
||||||
|
if not version or version.campaign_id != campaign.id:
|
||||||
|
raise MockCampaignSendError(
|
||||||
|
"Campaign version not found or not part of campaign"
|
||||||
|
)
|
||||||
|
return campaign, version
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_mailbox_for_run(*, send: bool, clear_mailbox: bool) -> Any | None:
|
||||||
|
mailbox = _require_mock_mailbox() if send or clear_mailbox else _mock_mailbox()
|
||||||
|
if clear_mailbox and mailbox is not None:
|
||||||
|
mailbox.clear_records()
|
||||||
|
return mailbox
|
||||||
|
|
||||||
|
|
||||||
|
def _build_mock_campaign_run(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign: Campaign,
|
||||||
|
version: CampaignVersion,
|
||||||
|
mailbox: Any | None,
|
||||||
|
send: bool,
|
||||||
|
include_warnings: bool,
|
||||||
|
include_needs_review: bool,
|
||||||
|
append_sent: bool,
|
||||||
|
check_files: bool,
|
||||||
|
) -> tuple[Any, Any, _MockSendBatch]:
|
||||||
|
files = files_integration()
|
||||||
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw_json,
|
||||||
|
managed_files_available=files.available,
|
||||||
|
)
|
||||||
|
with files.prepared_campaign_snapshot(
|
||||||
|
session,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
raw_json=raw_json,
|
||||||
|
include_bytes=True,
|
||||||
|
prefix="govoplan-mock-send-",
|
||||||
|
) as prepared:
|
||||||
|
prepared_raw = load_campaign_json(prepared.path)
|
||||||
|
config = load_campaign_config_from_json(
|
||||||
|
session,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
raw_json=prepared_raw,
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
)
|
||||||
|
validation_report = validate_campaign_config(
|
||||||
|
config,
|
||||||
|
campaign_file=prepared.path,
|
||||||
|
check_files=check_files,
|
||||||
|
)
|
||||||
|
build_result = build_campaign_messages(
|
||||||
|
config,
|
||||||
|
campaign_file=prepared.path,
|
||||||
|
write_eml=False,
|
||||||
|
)
|
||||||
|
files.annotate_built_messages_with_managed_files(
|
||||||
|
build_result.built_messages,
|
||||||
|
prepared.managed_files_by_local_path,
|
||||||
|
)
|
||||||
|
send_batch = _mock_send_batch(
|
||||||
|
config=config,
|
||||||
|
built_messages=build_result.built_messages,
|
||||||
|
mailbox=mailbox,
|
||||||
|
send=send,
|
||||||
|
include_warnings=include_warnings,
|
||||||
|
include_needs_review=include_needs_review,
|
||||||
|
append_sent=append_sent,
|
||||||
|
)
|
||||||
|
return validation_report, build_result, send_batch
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_validation_payload(validation_report: Any) -> dict[str, Any]:
|
||||||
|
payload = validation_report.model_dump(mode="json")
|
||||||
|
payload.update(
|
||||||
|
{
|
||||||
|
"ok": validation_report.ok,
|
||||||
|
"error_count": validation_report.error_count,
|
||||||
|
"warning_count": validation_report.warning_count,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_build_payload(build_result: Any) -> dict[str, Any]:
|
||||||
|
report = build_result.report
|
||||||
|
payload = report.model_dump(mode="json")
|
||||||
|
payload.update(
|
||||||
|
{
|
||||||
|
"built_count": report.built_count,
|
||||||
|
"queueable_count": report.queueable_count,
|
||||||
|
"needs_review_count": report.needs_review_count,
|
||||||
|
"blocked_count": report.blocked_count,
|
||||||
|
"warning_count": report.warning_count,
|
||||||
|
"ready_count": report.ready_count,
|
||||||
|
"messages": [_message_payload(message) for message in report.messages],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_send_steps(
|
||||||
|
*,
|
||||||
|
validation_report: Any,
|
||||||
|
validation_payload: dict[str, Any],
|
||||||
|
build_report: Any,
|
||||||
|
send_batch: _MockSendBatch,
|
||||||
|
send: bool,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> list[dict[str, Any]]:
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"key": "validate",
|
||||||
|
"label": "Validate campaign JSON",
|
||||||
|
"status": "ok" if validation_report.ok else "needs_review",
|
||||||
|
"summary": validation_payload,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "build",
|
||||||
|
"label": "Build messages",
|
||||||
|
"status": "ok" if build_report.queueable_count else "needs_review",
|
||||||
|
"summary": {
|
||||||
|
"built": build_report.built_count,
|
||||||
|
"queueable": build_report.queueable_count,
|
||||||
|
"needs_review": build_report.needs_review_count,
|
||||||
|
"blocked": build_report.blocked_count,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "send",
|
||||||
|
"label": "Mock SMTP delivery",
|
||||||
|
"status": (
|
||||||
|
"skipped"
|
||||||
|
if not send
|
||||||
|
else "ok"
|
||||||
|
if send_batch.failed_count == 0
|
||||||
|
else "needs_review"
|
||||||
|
),
|
||||||
|
"summary": {
|
||||||
|
"attempted": send_batch.attempted_count,
|
||||||
|
"sent": send_batch.sent_count,
|
||||||
|
"failed": send_batch.failed_count,
|
||||||
|
"skipped": send_batch.skipped_count,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"key": "imap",
|
||||||
|
"label": "Mock IMAP Sent append",
|
||||||
|
"status": (
|
||||||
|
"skipped"
|
||||||
|
if not send or not append_sent
|
||||||
|
else "ok"
|
||||||
|
if send_batch.imap_failed_count == 0
|
||||||
|
else "needs_review"
|
||||||
|
),
|
||||||
|
"summary": {
|
||||||
|
"appended": send_batch.imap_appended_count,
|
||||||
|
"failed": send_batch.imap_failed_count,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _mock_campaign_send_response(
|
||||||
|
*,
|
||||||
|
campaign: Campaign,
|
||||||
|
version: CampaignVersion,
|
||||||
|
mailbox: Any | None,
|
||||||
|
validation_report: Any,
|
||||||
|
validation_payload: dict[str, Any],
|
||||||
|
build_result: Any,
|
||||||
|
build_payload: dict[str, Any],
|
||||||
|
send_batch: _MockSendBatch,
|
||||||
|
send: bool,
|
||||||
|
include_warnings: bool,
|
||||||
|
include_needs_review: bool,
|
||||||
|
append_sent: bool,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"campaign_id": campaign.id,
|
||||||
|
"version_id": version.id,
|
||||||
|
"version_number": version.version_number,
|
||||||
|
"send_requested": send,
|
||||||
|
"include_warnings": include_warnings,
|
||||||
|
"include_needs_review": include_needs_review,
|
||||||
|
"append_sent": append_sent,
|
||||||
|
"steps": _mock_send_steps(
|
||||||
|
validation_report=validation_report,
|
||||||
|
validation_payload=validation_payload,
|
||||||
|
build_report=build_result.report,
|
||||||
|
send_batch=send_batch,
|
||||||
|
send=send,
|
||||||
|
append_sent=append_sent,
|
||||||
|
),
|
||||||
|
"validation": validation_payload,
|
||||||
|
"build": build_payload,
|
||||||
|
"send": {
|
||||||
|
"attempted_count": send_batch.attempted_count,
|
||||||
|
"sent_count": send_batch.sent_count,
|
||||||
|
"failed_count": send_batch.failed_count,
|
||||||
|
"skipped_count": send_batch.skipped_count,
|
||||||
|
"imap_appended_count": send_batch.imap_appended_count,
|
||||||
|
"imap_failed_count": send_batch.imap_failed_count,
|
||||||
|
"results": send_batch.results,
|
||||||
|
},
|
||||||
|
"mailbox": {
|
||||||
|
"messages": mailbox.list_records(limit=200) if mailbox is not None else []
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
def run_mock_campaign_send(
|
def run_mock_campaign_send(
|
||||||
session: Session,
|
session: Session,
|
||||||
*,
|
*,
|
||||||
@@ -144,155 +551,38 @@ def run_mock_campaign_send(
|
|||||||
mailbox only when send=True.
|
mailbox only when send=True.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
campaign = session.query(Campaign).filter(Campaign.id == campaign_id, Campaign.tenant_id == tenant_id).one_or_none()
|
campaign, version = _mock_campaign_version(
|
||||||
if not campaign:
|
|
||||||
raise MockCampaignSendError("Campaign not found or not accessible")
|
|
||||||
wanted_version_id = version_id or campaign.current_version_id
|
|
||||||
if not wanted_version_id:
|
|
||||||
raise MockCampaignSendError("Campaign has no current version")
|
|
||||||
version = session.get(CampaignVersion, wanted_version_id)
|
|
||||||
if not version or version.campaign_id != campaign.id:
|
|
||||||
raise MockCampaignSendError("Campaign version not found or not part of campaign")
|
|
||||||
|
|
||||||
mailbox = _require_mock_mailbox() if send or clear_mailbox else _mock_mailbox()
|
|
||||||
if clear_mailbox and mailbox is not None:
|
|
||||||
mailbox.clear_records()
|
|
||||||
|
|
||||||
files = files_integration()
|
|
||||||
with files.prepared_campaign_snapshot(
|
|
||||||
session,
|
session,
|
||||||
tenant_id=tenant_id,
|
tenant_id=tenant_id,
|
||||||
campaign_id=campaign.id,
|
campaign_id=campaign_id,
|
||||||
raw_json=version.raw_json if isinstance(version.raw_json, dict) else {},
|
version_id=version_id,
|
||||||
include_bytes=True,
|
)
|
||||||
prefix="multimailer-mock-send-",
|
mailbox = _mock_mailbox_for_run(send=send, clear_mailbox=clear_mailbox)
|
||||||
) as prepared:
|
validation_report, build_result, send_batch = _build_mock_campaign_run(
|
||||||
prepared_raw = load_campaign_json(prepared.path)
|
session,
|
||||||
config = load_campaign_config_from_json(session, tenant_id=tenant_id, raw_json=prepared_raw, campaign_id=campaign.id)
|
tenant_id=tenant_id,
|
||||||
validation_report = validate_campaign_config(config, campaign_file=prepared.path, check_files=check_files)
|
campaign=campaign,
|
||||||
build_result = build_campaign_messages(config, campaign_file=prepared.path, write_eml=False)
|
version=version,
|
||||||
files.annotate_built_messages_with_managed_files(build_result.built_messages, prepared.managed_files_by_local_path)
|
mailbox=mailbox,
|
||||||
|
send=send,
|
||||||
send_results: list[dict[str, Any]] = []
|
include_warnings=include_warnings,
|
||||||
sent_count = 0
|
include_needs_review=include_needs_review,
|
||||||
failed_count = 0
|
append_sent=append_sent,
|
||||||
skipped_count = 0
|
check_files=check_files,
|
||||||
imap_appended_count = 0
|
)
|
||||||
imap_failed_count = 0
|
validation_payload = _mock_validation_payload(validation_report)
|
||||||
|
build_payload = _mock_build_payload(build_result)
|
||||||
for built in build_result.built_messages:
|
return _mock_campaign_send_response(
|
||||||
draft = built.draft
|
campaign=campaign,
|
||||||
can_send, skip_reason = _can_mock_send(draft, include_warnings=include_warnings, include_needs_review=include_needs_review)
|
version=version,
|
||||||
row: dict[str, Any] = {
|
mailbox=mailbox,
|
||||||
"entry_index": draft.entry_index,
|
validation_report=validation_report,
|
||||||
"entry_id": draft.entry_id,
|
validation_payload=validation_payload,
|
||||||
"subject": draft.subject,
|
build_result=build_result,
|
||||||
"validation_status": draft.validation_status.value,
|
build_payload=build_payload,
|
||||||
"build_status": str(draft.build_status.value if hasattr(draft.build_status, "value") else draft.build_status),
|
send_batch=send_batch,
|
||||||
"to": _message_addresses_payload(draft.to),
|
send=send,
|
||||||
"attachments": _attachment_payloads(draft),
|
include_warnings=include_warnings,
|
||||||
"issues": _issue_payloads(draft),
|
include_needs_review=include_needs_review,
|
||||||
}
|
append_sent=append_sent,
|
||||||
|
)
|
||||||
if not can_send or built.mime is None:
|
|
||||||
skipped_count += 1
|
|
||||||
row.update({"status": "skipped", "message": skip_reason or "Message has no MIME output"})
|
|
||||||
send_results.append(row)
|
|
||||||
continue
|
|
||||||
|
|
||||||
recipients = _recipient_emails(draft)
|
|
||||||
envelope_from = _envelope_from(draft)
|
|
||||||
if not recipients:
|
|
||||||
skipped_count += 1
|
|
||||||
row.update({"status": "skipped", "message": "No envelope recipients"})
|
|
||||||
send_results.append(row)
|
|
||||||
continue
|
|
||||||
|
|
||||||
if not send:
|
|
||||||
row.update({"status": "ready", "message": f"Would send to {len(recipients)} recipient(s)", "envelope_from": envelope_from, "envelope_recipients": recipients})
|
|
||||||
send_results.append(row)
|
|
||||||
continue
|
|
||||||
|
|
||||||
try:
|
|
||||||
if mailbox is not None and mailbox.consume_fail_next_smtp():
|
|
||||||
raise MockCampaignSendError("Configured mock failure: next SMTP delivery fails")
|
|
||||||
rejected = _smtp_rejection_matches(recipients)
|
|
||||||
if rejected and len(rejected) == len(recipients):
|
|
||||||
raise MockCampaignSendError(f"Configured mock failure: all recipients rejected ({', '.join(rejected)})")
|
|
||||||
|
|
||||||
accepted = [recipient for recipient in recipients if recipient not in rejected]
|
|
||||||
smtp_record = mailbox.record_smtp_delivery(built.mime, envelope_from=envelope_from, envelope_recipients=accepted, smtp_host="mock.smtp.local")
|
|
||||||
sent_count += 1
|
|
||||||
row.update({
|
|
||||||
"status": "sent",
|
|
||||||
"message": f"Mock SMTP captured as {smtp_record.id}",
|
|
||||||
"smtp_message_id": smtp_record.id,
|
|
||||||
"envelope_from": envelope_from,
|
|
||||||
"envelope_recipients": accepted,
|
|
||||||
"refused_recipients": rejected,
|
|
||||||
})
|
|
||||||
|
|
||||||
if append_sent:
|
|
||||||
try:
|
|
||||||
if mailbox is not None and mailbox.consume_fail_next_imap():
|
|
||||||
raise MockCampaignSendError("Configured mock failure: next IMAP append fails")
|
|
||||||
folder = "Sent"
|
|
||||||
if config.delivery.imap_append_sent.folder and config.delivery.imap_append_sent.folder != "auto":
|
|
||||||
folder = config.delivery.imap_append_sent.folder
|
|
||||||
elif config.server.imap and config.server.imap.sent_folder and config.server.imap.sent_folder != "auto":
|
|
||||||
folder = config.server.imap.sent_folder
|
|
||||||
imap_record = mailbox.record_imap_append(_raw_message_bytes(built.mime), folder=folder, imap_host="mock.imap.local")
|
|
||||||
imap_appended_count += 1
|
|
||||||
row.update({"imap_status": "appended", "imap_message_id": imap_record.id, "imap_folder": folder})
|
|
||||||
except Exception as exc:
|
|
||||||
imap_failed_count += 1
|
|
||||||
row.update({"imap_status": "failed", "imap_error": str(exc)})
|
|
||||||
|
|
||||||
except Exception as exc:
|
|
||||||
failed_count += 1
|
|
||||||
row.update({"status": "failed", "message": str(exc), "envelope_from": envelope_from, "envelope_recipients": recipients})
|
|
||||||
|
|
||||||
send_results.append(row)
|
|
||||||
|
|
||||||
validation_json = validation_report.model_dump(mode="json")
|
|
||||||
validation_json.update({"ok": validation_report.ok, "error_count": validation_report.error_count, "warning_count": validation_report.warning_count})
|
|
||||||
build_report = build_result.report
|
|
||||||
build_json = build_report.model_dump(mode="json")
|
|
||||||
build_json.update({
|
|
||||||
"built_count": build_report.built_count,
|
|
||||||
"queueable_count": build_report.queueable_count,
|
|
||||||
"needs_review_count": build_report.needs_review_count,
|
|
||||||
"blocked_count": build_report.blocked_count,
|
|
||||||
"warning_count": build_report.warning_count,
|
|
||||||
"ready_count": build_report.ready_count,
|
|
||||||
"messages": [_message_payload(message) for message in build_report.messages],
|
|
||||||
})
|
|
||||||
|
|
||||||
attempted_count = sum(1 for row in send_results if row.get("status") in {"sent", "failed"})
|
|
||||||
return {
|
|
||||||
"campaign_id": campaign.id,
|
|
||||||
"version_id": version.id,
|
|
||||||
"version_number": version.version_number,
|
|
||||||
"send_requested": send,
|
|
||||||
"include_warnings": include_warnings,
|
|
||||||
"include_needs_review": include_needs_review,
|
|
||||||
"append_sent": append_sent,
|
|
||||||
"steps": [
|
|
||||||
{"key": "validate", "label": "Validate campaign JSON", "status": "ok" if validation_report.ok else "needs_review", "summary": validation_json},
|
|
||||||
{"key": "build", "label": "Build messages", "status": "ok" if build_report.queueable_count else "needs_review", "summary": {"built": build_report.built_count, "queueable": build_report.queueable_count, "needs_review": build_report.needs_review_count, "blocked": build_report.blocked_count}},
|
|
||||||
{"key": "send", "label": "Mock SMTP delivery", "status": "skipped" if not send else ("ok" if failed_count == 0 else "needs_review"), "summary": {"attempted": attempted_count, "sent": sent_count, "failed": failed_count, "skipped": skipped_count}},
|
|
||||||
{"key": "imap", "label": "Mock IMAP Sent append", "status": "skipped" if not send or not append_sent else ("ok" if imap_failed_count == 0 else "needs_review"), "summary": {"appended": imap_appended_count, "failed": imap_failed_count}},
|
|
||||||
],
|
|
||||||
"validation": validation_json,
|
|
||||||
"build": build_json,
|
|
||||||
"send": {
|
|
||||||
"attempted_count": attempted_count,
|
|
||||||
"sent_count": sent_count,
|
|
||||||
"failed_count": failed_count,
|
|
||||||
"skipped_count": skipped_count,
|
|
||||||
"imap_appended_count": imap_appended_count,
|
|
||||||
"imap_failed_count": imap_failed_count,
|
|
||||||
"results": send_results,
|
|
||||||
},
|
|
||||||
"mailbox": {"messages": mailbox.list_records(limit=200) if mailbox is not None else []},
|
|
||||||
}
|
|
||||||
|
|||||||
755
src/govoplan_campaign/backend/documentation.py
Normal file
755
src/govoplan_campaign/backend/documentation.py
Normal file
@@ -0,0 +1,755 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from govoplan_core.core.modules import DocumentationCondition, DocumentationContext, DocumentationLink, DocumentationTopic
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.delivery_policy import (
|
||||||
|
CampaignDeliveryPolicyError,
|
||||||
|
effective_synchronous_send_policy,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_CAMPAIGN_USER_SCOPES = (
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:create",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:copy",
|
||||||
|
"campaigns:campaign:archive",
|
||||||
|
"campaigns:campaign:delete",
|
||||||
|
"campaigns:campaign:share",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:campaign:build",
|
||||||
|
"campaigns:campaign:review",
|
||||||
|
"campaigns:campaign:send_test",
|
||||||
|
"campaigns:campaign:queue",
|
||||||
|
"campaigns:campaign:control",
|
||||||
|
"campaigns:campaign:send",
|
||||||
|
"campaigns:campaign:retry",
|
||||||
|
"campaigns:campaign:reconcile",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
"campaigns:recipient:export",
|
||||||
|
"campaigns:report:read",
|
||||||
|
"campaigns:report:export",
|
||||||
|
"campaigns:report:send",
|
||||||
|
)
|
||||||
|
|
||||||
|
_CAMPAIGN_HELP_CONTEXTS = (
|
||||||
|
"campaigns.list",
|
||||||
|
"campaign.overview",
|
||||||
|
)
|
||||||
|
|
||||||
|
_FILES_INTEGRATION = "files.campaign_attachments"
|
||||||
|
_MAIL_INTEGRATION = "mail.campaign_delivery"
|
||||||
|
_ADDRESSES_LOOKUP_INTEGRATION = "addresses.lookup"
|
||||||
|
_ADDRESSES_SOURCE_INTEGRATION = "addresses.recipient_source"
|
||||||
|
_NOTIFICATIONS_INTEGRATION = "notifications.dispatch"
|
||||||
|
|
||||||
|
|
||||||
|
def _workflow_topic(
|
||||||
|
*,
|
||||||
|
topic_id: str,
|
||||||
|
title: str,
|
||||||
|
summary: str,
|
||||||
|
body: str,
|
||||||
|
order: int,
|
||||||
|
audience: tuple[str, ...],
|
||||||
|
required_scopes: tuple[str, ...],
|
||||||
|
route: str,
|
||||||
|
screen: str,
|
||||||
|
help_contexts: tuple[str, ...],
|
||||||
|
prerequisites: tuple[str, ...],
|
||||||
|
steps: tuple[str, ...],
|
||||||
|
outcome: str,
|
||||||
|
verification: str,
|
||||||
|
related_topic_ids: tuple[str, ...] = (),
|
||||||
|
required_modules: tuple[str, ...] = ("campaigns",),
|
||||||
|
required_capabilities: tuple[str, ...] = (),
|
||||||
|
links: tuple[DocumentationLink, ...] = (DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),),
|
||||||
|
related_modules: tuple[str, ...] = (),
|
||||||
|
limitations: tuple[str, ...] = (),
|
||||||
|
) -> DocumentationTopic:
|
||||||
|
metadata: dict[str, object] = {
|
||||||
|
"kind": "workflow",
|
||||||
|
"route": route,
|
||||||
|
"screen": screen,
|
||||||
|
"help_contexts": list(help_contexts),
|
||||||
|
"prerequisites": list(prerequisites),
|
||||||
|
"steps": list(steps),
|
||||||
|
"outcome": outcome,
|
||||||
|
"verification": verification,
|
||||||
|
"related_topic_ids": list(related_topic_ids),
|
||||||
|
}
|
||||||
|
if limitations:
|
||||||
|
metadata["limitations"] = list(limitations)
|
||||||
|
return DocumentationTopic(
|
||||||
|
id=topic_id,
|
||||||
|
title=title,
|
||||||
|
summary=summary,
|
||||||
|
body=body,
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("user",),
|
||||||
|
audience=audience,
|
||||||
|
order=order,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=required_modules,
|
||||||
|
required_capabilities=required_capabilities,
|
||||||
|
required_scopes=required_scopes,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=links,
|
||||||
|
related_modules=related_modules,
|
||||||
|
unlocks=(outcome,),
|
||||||
|
source_module_id="campaigns",
|
||||||
|
metadata=metadata,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
CAMPAIGN_USER_DOCUMENTATION = (
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.create-campaign",
|
||||||
|
title="Create a campaign",
|
||||||
|
summary="Start a governed campaign as an editable draft and complete its purpose and ownership before adding delivery data.",
|
||||||
|
body="A new campaign starts with one editable working version. Creating it does not grant access to Mail profiles, managed files, address sources, or delivery actions; those remain separately authorized.",
|
||||||
|
order=30,
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:create"),
|
||||||
|
route="/campaigns",
|
||||||
|
screen="Campaigns",
|
||||||
|
help_contexts=("campaigns.list",),
|
||||||
|
prerequisites=("You may create campaigns in the active tenant.",),
|
||||||
|
steps=(
|
||||||
|
"Open Campaigns and select New campaign.",
|
||||||
|
"Use the creation wizard to enter a clear name, identifier, and purpose.",
|
||||||
|
"Open the new campaign and confirm its owner before adding recipient or delivery data.",
|
||||||
|
"Continue through the preparation sections and save the editable working version.",
|
||||||
|
),
|
||||||
|
outcome="An owned campaign draft with an editable working version.",
|
||||||
|
verification="The Campaign overview shows the new campaign as a draft and identifies its current working version.",
|
||||||
|
related_topic_ids=("campaigns.workflow.prepare-validate-and-build", "campaigns.workflow.import-recipients"),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.create-editable-successor",
|
||||||
|
title="Create an editable successor",
|
||||||
|
summary="Continue work after a permanent or delivery-final lock without rewriting the preserved version.",
|
||||||
|
body="Create editable copy means creating the campaign's next working version. Validation locks and temporary user locks are removed in place instead; they must not create parallel drafts.",
|
||||||
|
order=31,
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:copy", "campaigns:recipient:read"),
|
||||||
|
route="/campaigns/{campaign_id}",
|
||||||
|
screen="Campaign workspace",
|
||||||
|
help_contexts=("campaign.overview", "campaign.audit"),
|
||||||
|
prerequisites=(
|
||||||
|
"You have write access to the selected campaign.",
|
||||||
|
"Its current version is permanently user-locked or delivery-final.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open the locked current version and review the reason it is read-only.",
|
||||||
|
"Select Create editable copy in the locked-version notice.",
|
||||||
|
"If the notice instead offers an unlock action, unlock that validation or temporary user lock rather than creating a successor.",
|
||||||
|
"Review the new working version, reselect any Mail profile when requested, and validate and build again before delivery.",
|
||||||
|
),
|
||||||
|
outcome="A new editable working version while the source version and its evidence remain unchanged.",
|
||||||
|
verification="The Campaign overview identifies a new current version number and the earlier version remains in history.",
|
||||||
|
related_topic_ids=("campaigns.workflow.prepare-validate-and-build", "campaigns.mail-profile-user-journey"),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.import-recipients",
|
||||||
|
title="Import recipients into a campaign",
|
||||||
|
summary="Turn a text, CSV, or spreadsheet table into reviewed campaign-local recipient rows with source provenance.",
|
||||||
|
body="Import copies valid rows into the editable campaign version. Invalid rows stay visible during preview instead of disappearing, and later changes to the source file do not silently change the saved campaign.",
|
||||||
|
order=33,
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/recipients",
|
||||||
|
screen="Recipient data",
|
||||||
|
help_contexts=("campaign.recipients", "campaign.recipient-data"),
|
||||||
|
prerequisites=(
|
||||||
|
"The current campaign version is editable and you have write access to it.",
|
||||||
|
"The source is tabular and contains only data needed for this campaign.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Recipient data and select Import.",
|
||||||
|
"Upload or paste the table, then confirm its encoding, sheet, header rows, and separator where applicable.",
|
||||||
|
"Map address and campaign fields, choose append or replace, and review every invalid or excluded row.",
|
||||||
|
"Select Import valid rows, inspect the resulting recipient table, and save the campaign page.",
|
||||||
|
),
|
||||||
|
outcome="A campaign-local recipient snapshot with mapping and source evidence.",
|
||||||
|
verification="Reopen Recipient data, confirm the expected row count and addressing, then validate before building messages.",
|
||||||
|
related_topic_ids=("campaigns.workflow.import-address-source", "campaigns.workflow.prepare-validate-and-build"),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.import-address-source",
|
||||||
|
title="Import a recipient source from Addresses",
|
||||||
|
summary="Copy a permitted reusable address book or list into the campaign as a traceable versioned snapshot.",
|
||||||
|
body="Campaign does not follow the address source live. It records the selected source revision and warns when a newer source revision is available, so re-import is always an explicit author action.",
|
||||||
|
order=32,
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
required_modules=("campaigns", "addresses"),
|
||||||
|
required_capabilities=(_ADDRESSES_SOURCE_INTEGRATION,),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/recipients",
|
||||||
|
screen="Recipient data",
|
||||||
|
help_contexts=("campaign.recipients", "campaign.recipient-data"),
|
||||||
|
prerequisites=(
|
||||||
|
"Addresses offers at least one source visible to you.",
|
||||||
|
"The current campaign version is editable and you have write access to it.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Recipient data and select Import address book/list.",
|
||||||
|
"Choose the permitted source and review the returned snapshot and its revision.",
|
||||||
|
"Choose append or replace, import the snapshot, inspect the recipient rows, and save.",
|
||||||
|
"When a stale-source warning appears later, compare the source and re-import deliberately if the campaign should use the new revision.",
|
||||||
|
),
|
||||||
|
outcome="A campaign-local recipient snapshot whose Addresses source and revision can be traced.",
|
||||||
|
verification="Recipient data records the source provenance, and a later source revision does not alter the saved rows until you re-import it.",
|
||||||
|
related_topic_ids=("campaigns.workflow.import-recipients", "campaigns.workflow.prepare-validate-and-build"),
|
||||||
|
related_modules=("addresses",),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.use-managed-attachments",
|
||||||
|
title="Use managed files as campaign attachments",
|
||||||
|
summary="Select governed file versions, preview rule matches, and preserve exactly which files were used for the campaign build.",
|
||||||
|
body="Managed attachments remain owned by Files. Campaign stores governed references and frozen build evidence; it does not copy Files administration authority or accept arbitrary server paths.",
|
||||||
|
order=34,
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
required_modules=("campaigns", "files"),
|
||||||
|
required_capabilities=(_FILES_INTEGRATION,),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"files:file:read",
|
||||||
|
"files:file:share",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/files",
|
||||||
|
screen="Attachments",
|
||||||
|
help_contexts=("campaign.attachments",),
|
||||||
|
prerequisites=(
|
||||||
|
"The current campaign version is editable and you have write access to it.",
|
||||||
|
"The required file versions exist in Files and may be shared with this campaign.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Attachments and choose managed files or patterns from Files.",
|
||||||
|
"Define campaign-wide and recipient-specific rules, including unmatched-file and archive behavior.",
|
||||||
|
"Preview the matches and link the exact managed versions to the campaign.",
|
||||||
|
"Save, validate, and build, then inspect the resolved attachment evidence in Review and send.",
|
||||||
|
),
|
||||||
|
outcome="Governed file versions linked to the campaign and frozen into the exact build evidence.",
|
||||||
|
verification="Confirm the expected filenames, paths, matches, and link state in the Campaign UI. Exact managed versions and checksums remain retained in build evidence for authorized supporting tools.",
|
||||||
|
related_topic_ids=("campaigns.workflow.prepare-validate-and-build",),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),
|
||||||
|
DocumentationLink(label="Files", href="/files", kind="runtime"),
|
||||||
|
),
|
||||||
|
related_modules=("files",),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.queue-delivery",
|
||||||
|
title="Queue a campaign for controlled delivery",
|
||||||
|
summary="Place an exact reviewed build into the worker queue while preserving recipient-level state and retry protection.",
|
||||||
|
body="Queueing is a controlled state change, not proof of delivery. Ordinary batches should use background workers, and accepted or outcome-unknown effects remain protected from blind retry.",
|
||||||
|
order=35,
|
||||||
|
audience=("campaign_sender", "campaign_operator"),
|
||||||
|
required_modules=("campaigns", "mail"),
|
||||||
|
required_capabilities=(_MAIL_INTEGRATION,),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:queue",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"mail:profile:use",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/review",
|
||||||
|
screen="Review and send",
|
||||||
|
help_contexts=(),
|
||||||
|
prerequisites=(
|
||||||
|
"The selected version is validated, locked, built, and reviewed.",
|
||||||
|
"Its Mail profile remains available and authorized for the current campaign context.",
|
||||||
|
"You have write access to the selected campaign.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Review and send and confirm the selected version, build, recipients, warnings, and review completion.",
|
||||||
|
"Select Queue for workers and confirm the exact durable execution that will be committed.",
|
||||||
|
"Remain on Review and send or leave and return later; both views read the same durable job states.",
|
||||||
|
"Use the delivery controls to pause, resume, cancel unsent work, or retry eligible failures without requeueing accepted or uncertain outcomes.",
|
||||||
|
),
|
||||||
|
outcome="Eligible jobs queued with an auditable execution snapshot and protected delivery state.",
|
||||||
|
verification="The Report shows the selected version's jobs as queued or progressing, without changing any accepted job back to retryable.",
|
||||||
|
related_topic_ids=("campaigns.workflow.complete-review", "campaigns.workflow.retry-and-reconcile"),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign operator queue", href="/operator", kind="runtime"),
|
||||||
|
),
|
||||||
|
related_modules=("mail", "notifications"),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.send-small-controlled-run",
|
||||||
|
title="Send a campaign immediately",
|
||||||
|
summary="Run the eligible jobs synchronously only after deliberately confirming that the reviewed campaign is small enough for an interactive request.",
|
||||||
|
body="Send now is protected by an effective deployment/tenant recipient-job maximum. The server counts the exact persisted eligible build, rejects an oversized or empty run before SMTP, and preflights every message and the Mail profile revision before the first provider effect.",
|
||||||
|
order=36,
|
||||||
|
audience=("campaign_sender", "campaign_operator"),
|
||||||
|
required_modules=("campaigns", "mail"),
|
||||||
|
required_capabilities=(_MAIL_INTEGRATION,),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:send",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"mail:profile:use",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/review",
|
||||||
|
screen="Review and send",
|
||||||
|
help_contexts=("campaign.review-send",),
|
||||||
|
prerequisites=(
|
||||||
|
"The selected version is validated, locked, built, and reviewed.",
|
||||||
|
"The exact eligible recipient-job count is within the effective limit shown on Review and send.",
|
||||||
|
"Its Mail profile remains available and authorized for the current campaign context.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Review and send and inspect the exact build and delivery readiness checks.",
|
||||||
|
"Review the effective synchronous limit and exact eligible count; use Queue for workers when Send now is unavailable or for an ordinary batch.",
|
||||||
|
"Select Send now and confirm the protected delivery action.",
|
||||||
|
"Open Report and inspect each resulting delivery state before attempting any recovery action.",
|
||||||
|
),
|
||||||
|
outcome="A synchronous real delivery run with recipient-level attempt and outcome evidence.",
|
||||||
|
verification="The Report distinguishes accepted, failed, unattempted, cancelled, and outcome-unknown jobs and retains their attempt history.",
|
||||||
|
related_topic_ids=("campaigns.workflow.queue-delivery", "campaigns.workflow.retry-and-reconcile"),
|
||||||
|
related_modules=("mail",),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.view-aggregate-delivery-report",
|
||||||
|
title="Review aggregate campaign outcomes",
|
||||||
|
summary="Inspect privacy-protected Campaign totals without receiving recipient rows, message content, delivery diagnostics, or export authority.",
|
||||||
|
body="The aggregate Reports view exposes only approved campaign-level business outcomes. Positive cells below the configured threshold are suppressed together with a complementary value or the denominator when needed, so totals cannot be subtracted to recover a small group.",
|
||||||
|
order=37,
|
||||||
|
audience=("campaign_aggregate_reader", "campaign_reader", "campaign_manager"),
|
||||||
|
required_scopes=("campaigns:report:read",),
|
||||||
|
route="/reports",
|
||||||
|
screen="Reports",
|
||||||
|
help_contexts=("campaign.report",),
|
||||||
|
prerequisites=("The campaign is owned by or explicitly shared with you, or you hold tenant-wide authority.",),
|
||||||
|
steps=(
|
||||||
|
"Open Reports and select a campaign available to you.",
|
||||||
|
"Read the stated denominator before comparing accepted, failed, unknown, active, excluded, cancelled, and unattempted outcomes.",
|
||||||
|
"Treat Suppressed as an intentional privacy boundary rather than zero or missing data.",
|
||||||
|
"Request separately authorized recipient-level access only when the task genuinely requires individual evidence.",
|
||||||
|
),
|
||||||
|
outcome="A business-level Campaign outcome view with small-group and recipient privacy preserved.",
|
||||||
|
verification="No row, address, message, attachment, diagnostic, filter, drill-down, or export action is available from the aggregate view.",
|
||||||
|
related_topic_ids=("campaigns.workflow.view-delivery-report",),
|
||||||
|
links=(DocumentationLink(label="Aggregate Campaign reports", href="/reports", kind="runtime"),),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.view-delivery-report",
|
||||||
|
title="Review campaign delivery details",
|
||||||
|
summary="Inspect delivery totals and recipient-level job evidence in the current Campaign Report UI.",
|
||||||
|
body="The recipient-aware Campaign Report requires campaign-read, report-read, and recipient-read authority. Infrastructure diagnostics remain separately authorized, and the server checks every direct detail route independently of the interface.",
|
||||||
|
order=38,
|
||||||
|
audience=("campaign_reader", "campaign_manager", "campaign_reviewer", "campaign_sender"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:report:read", "campaigns:recipient:read"),
|
||||||
|
route="/campaigns/{campaign_id}/report",
|
||||||
|
screen="Campaign Report",
|
||||||
|
help_contexts=("campaign.report",),
|
||||||
|
prerequisites=("You may read the selected campaign and its report.",),
|
||||||
|
steps=(
|
||||||
|
"Open the campaign and select Report.",
|
||||||
|
"Review totals for queued, accepted, failed, cancelled, excluded/skipped, unattempted, and outcome-unknown jobs.",
|
||||||
|
"Inspect the authorized recipient-level rows and attempt history.",
|
||||||
|
"Treat outcome-unknown jobs as unresolved and hand them to an authorized operator for evidence-backed reconciliation.",
|
||||||
|
),
|
||||||
|
outcome="A recipient-aware view of delivery progress and outcomes with diagnostics still separately protected.",
|
||||||
|
verification="The report totals and job rows match the selected campaign version, and infrastructure diagnostics are absent unless separately authorized.",
|
||||||
|
related_topic_ids=("campaigns.workflow.view-aggregate-delivery-report", "campaigns.workflow.retry-and-reconcile", "campaigns.workflow.export-delivery-report"),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.export-delivery-report",
|
||||||
|
title="Export recipient delivery results",
|
||||||
|
summary="Download an authorized CSV snapshot of recipient-level campaign delivery results for controlled downstream use.",
|
||||||
|
body="A report export contains personal and delivery evidence. Store, transmit, retain, and delete it according to the campaign's purpose and the applicable export and retention policy.",
|
||||||
|
order=39,
|
||||||
|
audience=("campaign_report_exporter", "campaign_auditor"),
|
||||||
|
required_scopes=(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:report:read",
|
||||||
|
"campaigns:report:export",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:export",
|
||||||
|
),
|
||||||
|
route="/campaigns/{campaign_id}/report",
|
||||||
|
screen="Campaign Report",
|
||||||
|
help_contexts=("campaign.report", "campaign.audit"),
|
||||||
|
prerequisites=(
|
||||||
|
"You may export both campaign reports and recipient data.",
|
||||||
|
"The export has an approved purpose and destination.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open the campaign Report and select the intended version.",
|
||||||
|
"Confirm that recipient-level export is necessary for the task.",
|
||||||
|
"Select Download CSV and store the result only in the approved location.",
|
||||||
|
"Verify the selected version and row counts, then apply the required retention or deletion rule to the downloaded copy.",
|
||||||
|
),
|
||||||
|
outcome="A point-in-time CSV export of authorized campaign job results.",
|
||||||
|
verification="The downloaded file identifies the intended campaign/version and contains business evidence without credentials or ordinary-reader infrastructure details.",
|
||||||
|
related_topic_ids=("campaigns.workflow.view-delivery-report",),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.share-campaign",
|
||||||
|
title="Share a campaign",
|
||||||
|
summary="Grant a user or group explicit view or write access to one campaign without widening their platform permissions.",
|
||||||
|
body="A share can only narrow access to the selected campaign within the recipient's existing role. It never grants Mail profile use, Files authority, tenant-wide recipient access, or a missing Campaign action.",
|
||||||
|
order=39,
|
||||||
|
audience=("campaign_owner", "campaign_access_manager"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:share"),
|
||||||
|
route="/campaigns/{campaign_id}/global-settings",
|
||||||
|
screen="Ownership and sharing",
|
||||||
|
help_contexts=("campaign.overview", "campaign.global-settings"),
|
||||||
|
prerequisites=(
|
||||||
|
"You have write access to the selected campaign.",
|
||||||
|
"The target user or group already has an appropriate Campaign role for the intended actions.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Global settings and find Ownership and sharing.",
|
||||||
|
"Select Share, choose a user or group, and choose Can view or Can edit and operate.",
|
||||||
|
"Save the share and verify the target appears in the sharing table with the intended level.",
|
||||||
|
"Use the row action to revoke the explicit share when it is no longer needed.",
|
||||||
|
),
|
||||||
|
outcome="Explicit campaign access for the selected subject, bounded by that subject's existing permissions.",
|
||||||
|
verification="The sharing table shows the active target and level; revocation removes its explicit access while preserving the audit record.",
|
||||||
|
related_topic_ids=("campaigns.reference.composition-assurance",),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.archive-campaign",
|
||||||
|
title="Archive a campaign",
|
||||||
|
summary="Remove a completed campaign from active work while preserving its versions, outcomes, and audit evidence.",
|
||||||
|
body="Archive only after queued, sending, and outcome-unknown work has been resolved. Archiving preserves evidence and is the correct lifecycle action for any campaign with build, lock, or delivery history.",
|
||||||
|
order=40,
|
||||||
|
audience=("campaign_owner", "campaign_records_manager"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:archive"),
|
||||||
|
route="/campaigns/{campaign_id}",
|
||||||
|
screen="Campaign lifecycle",
|
||||||
|
help_contexts=("campaign.overview", "campaign.report", "campaign.audit"),
|
||||||
|
prerequisites=(
|
||||||
|
"You have write access to the selected campaign.",
|
||||||
|
"No delivery job is queued, sending, or awaiting uncertain-outcome reconciliation.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Open Report and resolve every active or outcome-unknown delivery state.",
|
||||||
|
"Confirm that the campaign should leave active work while its evidence remains retained.",
|
||||||
|
"Invoke the authorized Archive action from a supporting client.",
|
||||||
|
"Reopen or query the campaign and confirm its state is Archived.",
|
||||||
|
),
|
||||||
|
outcome="An archived campaign whose versions, reports, and audit evidence remain preserved.",
|
||||||
|
verification="The campaign state is Archived and its report remains available. Ask an authorized audit reader to verify the platform audit event.",
|
||||||
|
related_topic_ids=("campaigns.workflow.view-delivery-report", "campaigns.workflow.delete-untouched-draft"),
|
||||||
|
limitations=(
|
||||||
|
"The current Campaign Web UI does not yet expose the archive action; use an authorized supporting client or API.",
|
||||||
|
"The Campaign-local Audit page is not integrated yet; audit verification uses the platform audit surface or API.",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
_workflow_topic(
|
||||||
|
topic_id="campaigns.workflow.delete-untouched-draft",
|
||||||
|
title="Delete an untouched campaign draft",
|
||||||
|
summary="Immediately remove a draft that has no protected build, lock, publication, snapshot, or delivery evidence.",
|
||||||
|
body="Deletion is deliberately narrower than archive. It marks an eligible draft deleted and emits an audit record; it cannot erase a campaign that already carries evidence that must be retained.",
|
||||||
|
order=41,
|
||||||
|
audience=("campaign_owner", "campaign_records_manager"),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:delete"),
|
||||||
|
route="/campaigns/{campaign_id}",
|
||||||
|
screen="Campaign lifecycle",
|
||||||
|
help_contexts=("campaign.overview", "campaign.audit"),
|
||||||
|
prerequisites=(
|
||||||
|
"You have write access to the selected campaign.",
|
||||||
|
"The campaign is still a draft and has no jobs, locks, published version, or execution snapshot.",
|
||||||
|
),
|
||||||
|
steps=(
|
||||||
|
"Confirm that the draft is not needed and contains no evidence that should be retained.",
|
||||||
|
"Invoke the authorized Delete action from a supporting client and confirm the destructive action.",
|
||||||
|
"If deletion is refused because protected evidence exists, archive the campaign after resolving any active delivery state.",
|
||||||
|
"Verify that the deleted draft no longer appears in active Campaigns and that the audit event exists.",
|
||||||
|
),
|
||||||
|
outcome="An eligible untouched draft removed from active Campaigns with attributable deletion evidence.",
|
||||||
|
verification="The draft is no longer returned as an active campaign. Ask an authorized audit reader to verify who deleted it and when through the platform audit surface.",
|
||||||
|
related_topic_ids=("campaigns.workflow.archive-campaign",),
|
||||||
|
limitations=(
|
||||||
|
"The current Campaign Web UI does not yet expose the delete action; use an authorized supporting client or API.",
|
||||||
|
"The Campaign-local Audit page is not integrated yet; audit verification uses the platform audit surface or API.",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def documentation_topics(context: DocumentationContext) -> tuple[DocumentationTopic, ...]:
|
||||||
|
"""Describe the current Campaign composition without resolving module data.
|
||||||
|
|
||||||
|
The provider deliberately uses only the actor's permission evaluator and the
|
||||||
|
registry's declared contracts. Resource access, policy decisions, and
|
||||||
|
campaign state remain authoritative at the point where an action is used.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if context.documentation_type != "user":
|
||||||
|
return ()
|
||||||
|
principal = context.principal
|
||||||
|
if principal is None or not _has_any_scope(principal, _CAMPAIGN_USER_SCOPES):
|
||||||
|
return ()
|
||||||
|
|
||||||
|
mail_available = _integration_available(context.registry, _MAIL_INTEGRATION)
|
||||||
|
current_configuration = list(_actor_capabilities(principal, mail_available=mail_available))
|
||||||
|
integration_configuration, integration_limitations = _integration_summary(context.registry, principal)
|
||||||
|
current_configuration.extend(integration_configuration)
|
||||||
|
delivery_configuration, delivery_limitations = _delivery_policy_summary(context)
|
||||||
|
current_configuration.extend(delivery_configuration)
|
||||||
|
limitations = [
|
||||||
|
"Access to a particular campaign still depends on its owner or sharing rules and on the campaign's current state.",
|
||||||
|
"Profile, file, and address pickers re-evaluate the actual resources visible in the selected campaign; this overview does not claim that an eligible item currently exists.",
|
||||||
|
*integration_limitations,
|
||||||
|
*delivery_limitations,
|
||||||
|
]
|
||||||
|
|
||||||
|
return (
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.current-composition",
|
||||||
|
title="Your Campaign role and installed composition",
|
||||||
|
summary="This guide separates actions authorized by your role from optional services connected to Campaign in this installation.",
|
||||||
|
body=_composition_body(current_configuration, limitations),
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("user",),
|
||||||
|
audience=("campaign_user",),
|
||||||
|
order=29,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns",),
|
||||||
|
any_scopes=_CAMPAIGN_USER_SCOPES,
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),),
|
||||||
|
related_modules=("mail", "files", "addresses", "notifications"),
|
||||||
|
source_module_id="campaigns",
|
||||||
|
metadata={
|
||||||
|
"kind": "reference",
|
||||||
|
"route": "/campaigns",
|
||||||
|
"screen": "Campaigns",
|
||||||
|
"help_contexts": list(_CAMPAIGN_HELP_CONTEXTS),
|
||||||
|
"current_configuration": current_configuration,
|
||||||
|
"limitations": limitations,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _actor_capabilities(principal: object, *, mail_available: bool) -> tuple[str, ...]:
|
||||||
|
capabilities: list[str] = []
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:read",), "Open campaigns shared with you and inspect their business state.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:create",), "Create new campaigns.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:update",), "Edit eligible working campaign versions.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:copy",), "Create an editable successor from an eligible existing version.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:recipient:read",), "Inspect recipients and recipient-specific campaign data.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:recipient:write",), "Add and edit recipient rows.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:recipient:import",), "Import recipient snapshots.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:validate",), "Validate campaign inputs and resolve blocking issues.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:build",), "Build exact recipient messages for review.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:review",), "Record review completion for an exact build.")
|
||||||
|
if mail_available:
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:send_test",), "Run authorized delivery verification tools.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:queue",), "Queue an eligible reviewed campaign for controlled delivery.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:control",), "Pause, resume, or cancel eligible delivery jobs.")
|
||||||
|
if mail_available:
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:send",), "Start an eligible real delivery run.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:retry",), "Retry delivery jobs whose recorded state permits a retry.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:reconcile",), "Reconcile delivery effects whose outcome is uncertain.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:report:read",), "View authorized campaign delivery reports.")
|
||||||
|
_append_if(
|
||||||
|
capabilities,
|
||||||
|
principal,
|
||||||
|
("campaigns:report:export", "campaigns:recipient:export"),
|
||||||
|
"Export authorized delivery and recipient report data.",
|
||||||
|
require_all=True,
|
||||||
|
)
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:share",), "Manage explicit access to eligible campaigns.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:archive",), "Archive eligible campaigns while retaining their evidence.")
|
||||||
|
_append_if(capabilities, principal, ("campaigns:campaign:delete",), "Delete eligible untouched drafts.")
|
||||||
|
if mail_available:
|
||||||
|
_append_if(
|
||||||
|
capabilities,
|
||||||
|
principal,
|
||||||
|
("campaigns:report:send", "campaigns:report:read", "mail:profile:use"),
|
||||||
|
"Send an authorized campaign report through a Mail profile.",
|
||||||
|
require_all=True,
|
||||||
|
)
|
||||||
|
return tuple(capabilities)
|
||||||
|
|
||||||
|
|
||||||
|
def _integration_summary(registry: object, principal: object) -> tuple[tuple[str, ...], tuple[str, ...]]:
|
||||||
|
configured: list[str] = []
|
||||||
|
limitations: list[str] = []
|
||||||
|
|
||||||
|
mail_available = _integration_available(registry, _MAIL_INTEGRATION)
|
||||||
|
can_select_mail_profile = _has_all_scopes(
|
||||||
|
principal,
|
||||||
|
("campaigns:campaign:read", "campaigns:campaign:update", "mail:profile:use"),
|
||||||
|
)
|
||||||
|
can_deliver_with_mail = _has_scope(principal, "mail:profile:use") and _has_any_scope(
|
||||||
|
principal,
|
||||||
|
("campaigns:campaign:queue", "campaigns:campaign:send", "campaigns:campaign:retry"),
|
||||||
|
)
|
||||||
|
if mail_available and can_select_mail_profile:
|
||||||
|
configured.append("Installed composition: Campaign can open Mail's actor-filtered profile picker while you edit; eligible profiles are resolved in the selected campaign context.")
|
||||||
|
elif mail_available and can_deliver_with_mail:
|
||||||
|
configured.append("Installed composition: Mail-backed Campaign delivery is connected, and the selected profile is re-authorized for each delivery action.")
|
||||||
|
elif mail_available:
|
||||||
|
limitations.append("Mail delivery is configured, but selecting a Mail profile is not included in your current tasks.")
|
||||||
|
else:
|
||||||
|
limitations.append("Mail-backed Campaign delivery is not available in the current composition.")
|
||||||
|
|
||||||
|
files_available = _integration_available(registry, _FILES_INTEGRATION)
|
||||||
|
can_preview_files = _has_all_scopes(
|
||||||
|
principal,
|
||||||
|
("campaigns:campaign:read", "campaigns:recipient:read", "files:file:read"),
|
||||||
|
)
|
||||||
|
can_link_files = _has_all_scopes(
|
||||||
|
principal,
|
||||||
|
(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"files:file:read",
|
||||||
|
"files:file:share",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if files_available and can_link_files:
|
||||||
|
configured.append("Installed composition: Managed file versions can be selected, previewed, and linked as governed campaign attachments when the selected campaign and files pass their resource checks.")
|
||||||
|
elif files_available and can_preview_files:
|
||||||
|
configured.append("Installed composition: Managed campaign attachments can be previewed; linking a version requires campaign-update, validation, and attachment-sharing authority.")
|
||||||
|
elif files_available:
|
||||||
|
limitations.append("Managed attachments are configured, but they are not included in your current Campaign tasks.")
|
||||||
|
else:
|
||||||
|
limitations.append("Managed file attachments are not available in the current composition; campaign-owned uploads remain separate.")
|
||||||
|
|
||||||
|
lookup_available = _integration_available(registry, _ADDRESSES_LOOKUP_INTEGRATION)
|
||||||
|
source_available = _integration_available(registry, _ADDRESSES_SOURCE_INTEGRATION)
|
||||||
|
if lookup_available and _has_scope(principal, "campaigns:recipient:read"):
|
||||||
|
configured.append("Installed composition: Address records can be looked up while preparing recipients.")
|
||||||
|
elif lookup_available:
|
||||||
|
limitations.append("Address lookup is configured, but recipient inspection is not included in your current Campaign tasks.")
|
||||||
|
else:
|
||||||
|
limitations.append("Connected address lookup is not available in the current composition.")
|
||||||
|
can_import_source = _has_all_scopes(
|
||||||
|
principal,
|
||||||
|
(
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
if source_available and can_import_source:
|
||||||
|
configured.append("Installed composition: The actor-filtered Addresses source picker can copy a selected source into a campaign as a traceable recipient snapshot.")
|
||||||
|
elif source_available:
|
||||||
|
limitations.append("Connected recipient sources are configured, but source import is not included in your current Campaign tasks.")
|
||||||
|
else:
|
||||||
|
limitations.append("Connected recipient-source snapshots are not available; direct campaign imports remain available when authorized.")
|
||||||
|
|
||||||
|
if _integration_available(registry, _NOTIFICATIONS_INTEGRATION):
|
||||||
|
configured.append("Installed composition: In-app notifications can report important Campaign delivery status changes.")
|
||||||
|
else:
|
||||||
|
limitations.append("Automatic in-app Campaign status notifications are not configured.")
|
||||||
|
|
||||||
|
return tuple(configured), tuple(limitations)
|
||||||
|
|
||||||
|
|
||||||
|
def _delivery_policy_summary(context: DocumentationContext) -> tuple[tuple[str, ...], tuple[str, ...]]:
|
||||||
|
session = context.session
|
||||||
|
tenant_id = str(getattr(context.principal, "tenant_id", "") or "").strip()
|
||||||
|
if session is None or not tenant_id:
|
||||||
|
return (), ("The effective synchronous Campaign limit could not be resolved for this documentation request.",)
|
||||||
|
try:
|
||||||
|
policy = effective_synchronous_send_policy(session, tenant_id=tenant_id) # type: ignore[arg-type]
|
||||||
|
except CampaignDeliveryPolicyError as exc:
|
||||||
|
return (), (f"Synchronous Campaign delivery is disabled until its policy configuration is corrected: {exc}",)
|
||||||
|
return (
|
||||||
|
(
|
||||||
|
"Delivery policy: Send now is limited to "
|
||||||
|
f"{policy.max_recipient_jobs} eligible recipient job(s) for this tenant. "
|
||||||
|
"The exact built count and Queue for workers alternative are shown before confirmation."
|
||||||
|
),
|
||||||
|
), ()
|
||||||
|
|
||||||
|
|
||||||
|
def _append_if(
|
||||||
|
target: list[str],
|
||||||
|
principal: object,
|
||||||
|
scopes: tuple[str, ...],
|
||||||
|
text: str,
|
||||||
|
*,
|
||||||
|
require_all: bool = False,
|
||||||
|
) -> None:
|
||||||
|
allowed = _has_all_scopes(principal, scopes) if require_all else _has_any_scope(principal, scopes)
|
||||||
|
if allowed:
|
||||||
|
target.append(f"Role authorization: {text}")
|
||||||
|
|
||||||
|
|
||||||
|
def _has_scope(principal: object, scope: str) -> bool:
|
||||||
|
checker = getattr(principal, "has", None)
|
||||||
|
if not callable(checker):
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
return bool(checker(scope))
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _has_any_scope(principal: object, scopes: tuple[str, ...]) -> bool:
|
||||||
|
return any(_has_scope(principal, scope) for scope in scopes)
|
||||||
|
|
||||||
|
|
||||||
|
def _has_all_scopes(principal: object, scopes: tuple[str, ...]) -> bool:
|
||||||
|
return all(_has_scope(principal, scope) for scope in scopes)
|
||||||
|
|
||||||
|
|
||||||
|
def _integration_available(registry: object, interface_name: str) -> bool:
|
||||||
|
return _registry_has_interface(registry, interface_name) and _registry_has_capability(registry, interface_name)
|
||||||
|
|
||||||
|
|
||||||
|
def _registry_has_interface(registry: object, interface_name: str) -> bool:
|
||||||
|
manifests_provider = getattr(registry, "manifests", None)
|
||||||
|
if not callable(manifests_provider):
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
manifests = tuple(manifests_provider())
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
return any(
|
||||||
|
getattr(provider, "name", None) == interface_name
|
||||||
|
for manifest in manifests
|
||||||
|
for provider in (getattr(manifest, "provides_interfaces", ()) or ())
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _registry_has_capability(registry: object, capability_name: str) -> bool:
|
||||||
|
capability_checker = getattr(registry, "has_capability", None)
|
||||||
|
if not callable(capability_checker):
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
return bool(capability_checker(capability_name))
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def _composition_body(current_configuration: list[str], limitations: list[str]) -> str:
|
||||||
|
del current_configuration, limitations
|
||||||
|
return "The facts below are calculated for the current actor and installed module contracts. They do not bypass campaign ownership, sharing, state, or operation-time resource and policy checks."
|
||||||
@@ -34,7 +34,16 @@ class ImapConfigurationError(RuntimeError):
|
|||||||
|
|
||||||
|
|
||||||
class ImapAppendError(RuntimeError):
|
class ImapAppendError(RuntimeError):
|
||||||
pass
|
def __init__(
|
||||||
|
self,
|
||||||
|
message: str,
|
||||||
|
*,
|
||||||
|
temporary: bool | None = None,
|
||||||
|
outcome_unknown: bool = False,
|
||||||
|
) -> None:
|
||||||
|
super().__init__(message)
|
||||||
|
self.temporary = temporary
|
||||||
|
self.outcome_unknown = outcome_unknown
|
||||||
|
|
||||||
|
|
||||||
class MailProfileError(OptionalModuleUnavailable):
|
class MailProfileError(OptionalModuleUnavailable):
|
||||||
@@ -48,6 +57,7 @@ class _PreparedCampaignSnapshot:
|
|||||||
self.raw_json = raw_json
|
self.raw_json = raw_json
|
||||||
self.managed_files_by_local_path: dict[str, Any] = {}
|
self.managed_files_by_local_path: dict[str, Any] = {}
|
||||||
self.shared_assets: list[Any] = []
|
self.shared_assets: list[Any] = []
|
||||||
|
self.candidate_assets: list[Any] = []
|
||||||
|
|
||||||
def cleanup(self) -> None:
|
def cleanup(self) -> None:
|
||||||
shutil.rmtree(self._directory, ignore_errors=True)
|
shutil.rmtree(self._directory, ignore_errors=True)
|
||||||
@@ -105,6 +115,11 @@ class FilesCampaignIntegration:
|
|||||||
raise OptionalModuleUnavailable("Files module is not available")
|
raise OptionalModuleUnavailable("Files module is not available")
|
||||||
return self._delegate.current_version_and_blob(session, asset)
|
return self._delegate.current_version_and_blob(session, asset)
|
||||||
|
|
||||||
|
def share_assets_with_campaign(self, session: Any, **kwargs: Any) -> list[dict[str, Any]]:
|
||||||
|
if self._delegate is None:
|
||||||
|
raise OptionalModuleUnavailable("Files module is not available")
|
||||||
|
return self._delegate.share_assets_with_campaign(session, **kwargs)
|
||||||
|
|
||||||
def mark_job_attachment_uses_sent(self, session: Any, job: Any) -> None:
|
def mark_job_attachment_uses_sent(self, session: Any, job: Any) -> None:
|
||||||
if self._delegate is not None:
|
if self._delegate is not None:
|
||||||
self._delegate.mark_job_attachment_uses_sent(session, job)
|
self._delegate.mark_job_attachment_uses_sent(session, job)
|
||||||
@@ -131,17 +146,6 @@ class MailCampaignIntegration:
|
|||||||
raise MailProfileError("Mail module is not available")
|
raise MailProfileError("Mail module is not available")
|
||||||
return self._delegate
|
return self._delegate
|
||||||
|
|
||||||
def materialize_campaign_mail_profile_config(self, session: Any, **kwargs: Any) -> dict[str, Any]:
|
|
||||||
if self._delegate is None:
|
|
||||||
raw_json = kwargs.get("raw_json")
|
|
||||||
if self.mail_profile_id_from_campaign_json(raw_json if isinstance(raw_json, dict) else {}):
|
|
||||||
raise MailProfileError("Campaign mail-server profiles require the mail module")
|
|
||||||
return dict(raw_json) if isinstance(raw_json, dict) else {}
|
|
||||||
try:
|
|
||||||
return self._delegate.materialize_campaign_mail_profile_config(session, **kwargs)
|
|
||||||
except getattr(self._delegate, "MailProfileError", MailProfileError) as exc:
|
|
||||||
raise MailProfileError(str(exc)) from exc
|
|
||||||
|
|
||||||
def assert_campaign_mail_policy_allows_json(self, session: Any, **kwargs: Any) -> None:
|
def assert_campaign_mail_policy_allows_json(self, session: Any, **kwargs: Any) -> None:
|
||||||
if self._delegate is None:
|
if self._delegate is None:
|
||||||
raw_json = kwargs.get("raw_json")
|
raw_json = kwargs.get("raw_json")
|
||||||
@@ -154,72 +158,55 @@ class MailCampaignIntegration:
|
|||||||
except getattr(self._delegate, "MailProfileError", MailProfileError) as exc:
|
except getattr(self._delegate, "MailProfileError", MailProfileError) as exc:
|
||||||
raise MailProfileError(str(exc)) from exc
|
raise MailProfileError(str(exc)) from exc
|
||||||
|
|
||||||
def assert_mail_policy_allows_send(self, session: Any, **kwargs: Any) -> None:
|
|
||||||
delegate = self._require()
|
|
||||||
try:
|
|
||||||
return delegate.assert_mail_policy_allows_send(session, **kwargs)
|
|
||||||
except getattr(delegate, "MailProfileError", MailProfileError) as exc:
|
|
||||||
raise MailProfileError(str(exc)) from exc
|
|
||||||
|
|
||||||
def mail_profile_id_from_campaign_json(self, raw_json: dict[str, Any]) -> str | None:
|
def mail_profile_id_from_campaign_json(self, raw_json: dict[str, Any]) -> str | None:
|
||||||
if self._delegate is not None:
|
if self._delegate is not None:
|
||||||
return self._delegate.mail_profile_id_from_campaign_json(raw_json)
|
return self._delegate.mail_profile_id_from_campaign_json(raw_json)
|
||||||
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
||||||
profile_id = server.get("mail_profile_id") if isinstance(server, dict) else None
|
profile_id = server.get("mail_profile_id") if isinstance(server, dict) else None
|
||||||
if profile_id is None and isinstance(server, dict):
|
|
||||||
profile_id = server.get("profile_id")
|
|
||||||
return str(profile_id).strip() if profile_id else None
|
return str(profile_id).strip() if profile_id else None
|
||||||
|
|
||||||
def ensure_mail_profile_allowed_for_campaign(self, session: Any, **kwargs: Any) -> Any:
|
def campaign_profile_delivery_summary(self, session: Any, **kwargs: Any) -> dict[str, Any]:
|
||||||
delegate = self._require()
|
delegate = self._require()
|
||||||
try:
|
try:
|
||||||
return delegate.ensure_mail_profile_allowed_for_campaign(session, **kwargs)
|
return delegate.campaign_profile_delivery_summary(session, **kwargs)
|
||||||
except getattr(delegate, "MailProfileError", MailProfileError) as exc:
|
except getattr(delegate, "MailProfileError", MailProfileError) as exc:
|
||||||
raise MailProfileError(str(exc)) from exc
|
raise MailProfileError(str(exc)) from exc
|
||||||
|
|
||||||
def smtp_config_from_profile(self, profile: Any) -> Any:
|
|
||||||
return self._require().smtp_config_from_profile(profile)
|
|
||||||
|
|
||||||
def imap_config_from_profile(self, profile: Any) -> Any:
|
|
||||||
return self._require().imap_config_from_profile(profile)
|
|
||||||
|
|
||||||
def effective_profile_credentials_inherited(self, session: Any, **kwargs: Any) -> bool:
|
|
||||||
return self._require().effective_profile_credentials_inherited(session, **kwargs)
|
|
||||||
|
|
||||||
def apply_campaign_credentials(self, profile_payload: dict[str, Any], server: dict[str, Any], protocol: str) -> dict[str, Any]:
|
|
||||||
return self._require().apply_campaign_credentials(profile_payload, server, protocol)
|
|
||||||
|
|
||||||
def wait_for_rate_limit(self, **kwargs: Any) -> None:
|
def wait_for_rate_limit(self, **kwargs: Any) -> None:
|
||||||
if self._delegate is None:
|
if self._delegate is None:
|
||||||
return None
|
return None
|
||||||
return self._delegate.wait_for_rate_limit(**kwargs)
|
return self._delegate.wait_for_rate_limit(**kwargs)
|
||||||
|
|
||||||
def send_email_bytes(self, *args: Any, **kwargs: Any) -> Any:
|
def send_campaign_email_bytes(self, *args: Any, **kwargs: Any) -> Any:
|
||||||
delegate = self._require()
|
delegate = self._require()
|
||||||
try:
|
try:
|
||||||
return delegate.send_email_bytes(*args, **kwargs)
|
return delegate.send_campaign_email_bytes(*args, **kwargs)
|
||||||
except getattr(delegate, "SmtpSendError", SmtpSendError) as exc:
|
except getattr(delegate, "SmtpSendError", SmtpSendError) as exc:
|
||||||
raise SmtpSendError(str(exc), temporary=bool(getattr(exc, "temporary", False)), outcome_unknown=bool(getattr(exc, "outcome_unknown", False))) from exc
|
raise SmtpSendError(str(exc), temporary=bool(getattr(exc, "temporary", False)), outcome_unknown=bool(getattr(exc, "outcome_unknown", False))) from exc
|
||||||
except getattr(delegate, "SmtpConfigurationError", SmtpConfigurationError) as exc:
|
except getattr(delegate, "SmtpConfigurationError", SmtpConfigurationError) as exc:
|
||||||
raise SmtpConfigurationError(str(exc)) from exc
|
raise SmtpConfigurationError(str(exc)) from exc
|
||||||
|
except getattr(delegate, "MailProfileError", MailProfileError) as exc:
|
||||||
|
raise MailProfileError(str(exc)) from exc
|
||||||
|
|
||||||
def append_message_to_sent(self, *args: Any, **kwargs: Any) -> Any:
|
def append_campaign_message_to_sent(self, *args: Any, **kwargs: Any) -> Any:
|
||||||
delegate = self._require()
|
delegate = self._require()
|
||||||
try:
|
try:
|
||||||
return delegate.append_message_to_sent(*args, **kwargs)
|
return delegate.append_campaign_message_to_sent(*args, **kwargs)
|
||||||
except getattr(delegate, "ImapAppendError", ImapAppendError) as exc:
|
except getattr(delegate, "ImapAppendError", ImapAppendError) as exc:
|
||||||
raise ImapAppendError(str(exc)) from exc
|
raise ImapAppendError(
|
||||||
|
str(exc),
|
||||||
|
temporary=getattr(exc, "temporary", None),
|
||||||
|
outcome_unknown=bool(getattr(exc, "outcome_unknown", False)),
|
||||||
|
) from exc
|
||||||
except getattr(delegate, "ImapConfigurationError", ImapConfigurationError) as exc:
|
except getattr(delegate, "ImapConfigurationError", ImapConfigurationError) as exc:
|
||||||
raise ImapConfigurationError(str(exc)) from exc
|
raise ImapConfigurationError(str(exc)) from exc
|
||||||
|
except getattr(delegate, "MailProfileError", MailProfileError) as exc:
|
||||||
|
raise MailProfileError(str(exc)) from exc
|
||||||
|
|
||||||
def send_email_message(self, *args: Any, **kwargs: Any) -> Any:
|
def mock_mailbox(self) -> Any | None:
|
||||||
delegate = self._require()
|
if self._delegate is None or not hasattr(self._delegate, "mock_mailbox"):
|
||||||
try:
|
return None
|
||||||
return delegate.send_email_message(*args, **kwargs)
|
return self._delegate.mock_mailbox()
|
||||||
except getattr(delegate, "SmtpSendError", SmtpSendError) as exc:
|
|
||||||
raise SmtpSendError(str(exc), temporary=bool(getattr(exc, "temporary", False)), outcome_unknown=bool(getattr(exc, "outcome_unknown", False))) from exc
|
|
||||||
except getattr(delegate, "SmtpConfigurationError", SmtpConfigurationError) as exc:
|
|
||||||
raise SmtpConfigurationError(str(exc)) from exc
|
|
||||||
|
|
||||||
|
|
||||||
def files_integration() -> FilesCampaignIntegration:
|
def files_integration() -> FilesCampaignIntegration:
|
||||||
|
|||||||
@@ -2,9 +2,35 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from govoplan_core.core.modules import FrontendModule, MigrationSpec, ModuleContext, ModuleManifest, NavItem, PermissionDefinition, RoleTemplate
|
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER
|
||||||
|
from govoplan_core.core.campaigns import (
|
||||||
|
CAPABILITY_CAMPAIGNS_ACCESS,
|
||||||
|
CAPABILITY_CAMPAIGNS_DELIVERY_TASKS,
|
||||||
|
CAPABILITY_CAMPAIGNS_MAIL_POLICY_CONTEXT,
|
||||||
|
CAPABILITY_CAMPAIGNS_POLICY_CONTEXT,
|
||||||
|
CAPABILITY_CAMPAIGNS_RETENTION,
|
||||||
|
)
|
||||||
|
from govoplan_core.core.module_guards import drop_table_retirement_provider, persistent_table_uninstall_guard
|
||||||
|
from govoplan_core.core.modules import (
|
||||||
|
DocumentationCondition,
|
||||||
|
DocumentationLink,
|
||||||
|
DocumentationTopic,
|
||||||
|
FrontendModule,
|
||||||
|
MigrationSpec,
|
||||||
|
ModuleContext,
|
||||||
|
ModuleInterfaceProvider,
|
||||||
|
ModuleInterfaceRequirement,
|
||||||
|
ModuleManifest,
|
||||||
|
NavItem,
|
||||||
|
PermissionDefinition,
|
||||||
|
RoleTemplate,
|
||||||
|
)
|
||||||
from govoplan_core.db.base import Base
|
from govoplan_core.db.base import Base
|
||||||
|
from govoplan_campaign.backend.change_tracking import register_campaign_change_tracking
|
||||||
from govoplan_campaign.backend.db import models as campaign_models # noqa: F401 - populate Campaign ORM metadata
|
from govoplan_campaign.backend.db import models as campaign_models # noqa: F401 - populate Campaign ORM metadata
|
||||||
|
from govoplan_campaign.backend.documentation import CAMPAIGN_USER_DOCUMENTATION, documentation_topics
|
||||||
|
|
||||||
|
register_campaign_change_tracking()
|
||||||
|
|
||||||
|
|
||||||
def _permission(scope: str, label: str, description: str, category: str) -> PermissionDefinition:
|
def _permission(scope: str, label: str, description: str, category: str) -> PermissionDefinition:
|
||||||
@@ -31,13 +57,14 @@ PERMISSIONS = (
|
|||||||
_permission("campaigns:campaign:share", "Share campaigns", "Grant or revoke explicit campaign access.", "Campaigns"),
|
_permission("campaigns:campaign:share", "Share campaigns", "Grant or revoke explicit campaign access.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:validate", "Validate campaigns", "Run technical validation and manage validation locks.", "Campaigns"),
|
_permission("campaigns:campaign:validate", "Validate campaigns", "Run technical validation and manage validation locks.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:build", "Build campaigns", "Build exact messages and attachment evidence.", "Campaigns"),
|
_permission("campaigns:campaign:build", "Build campaigns", "Build exact messages and attachment evidence.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:review", "Approve campaign review", "Approve or reject built messages and review conditions.", "Campaigns"),
|
_permission("campaigns:campaign:review", "Complete campaign review", "Record review completion and the exact built messages inspected.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:send_test", "Mock-send campaigns", "Use mock delivery and verification tools.", "Campaigns"),
|
_permission("campaigns:campaign:send_test", "Mock-send campaigns", "Use mock delivery and verification tools.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:queue", "Queue campaigns", "Place approved executions into the delivery queue.", "Campaigns"),
|
_permission("campaigns:campaign:queue", "Queue campaigns", "Place approved executions into the delivery queue.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:control", "Control delivery", "Pause, resume or cancel queued and sending jobs.", "Campaigns"),
|
_permission("campaigns:campaign:control", "Control delivery", "Pause, resume or cancel queued and sending jobs.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:send", "Send campaigns", "Start real SMTP delivery.", "Campaigns"),
|
_permission("campaigns:campaign:send", "Send campaigns", "Start real SMTP delivery.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:retry", "Retry delivery", "Retry failed or unattempted delivery jobs.", "Campaigns"),
|
_permission("campaigns:campaign:retry", "Retry delivery", "Retry failed or unattempted delivery jobs.", "Campaigns"),
|
||||||
_permission("campaigns:campaign:reconcile", "Reconcile delivery", "Resolve outcome-unknown SMTP attempts after inspection.", "Campaigns"),
|
_permission("campaigns:campaign:reconcile", "Reconcile delivery", "Resolve outcome-unknown SMTP or IMAP attempts after inspection.", "Campaigns"),
|
||||||
|
_permission("campaigns:diagnostic:read", "View campaign diagnostics", "Inspect worker claims and internal storage locators for campaign delivery troubleshooting.", "Campaign operations"),
|
||||||
_permission("campaigns:recipient:read", "View recipients", "Read recipient lists and recipient-specific campaign data.", "Recipients"),
|
_permission("campaigns:recipient:read", "View recipients", "Read recipient lists and recipient-specific campaign data.", "Recipients"),
|
||||||
_permission("campaigns:recipient:write", "Edit recipients", "Create and edit recipient rows and field values.", "Recipients"),
|
_permission("campaigns:recipient:write", "Edit recipients", "Create and edit recipient rows and field values.", "Recipients"),
|
||||||
_permission("campaigns:recipient:import", "Import recipients", "Bulk-import recipient lists.", "Recipients"),
|
_permission("campaigns:recipient:import", "Import recipients", "Bulk-import recipient lists.", "Recipients"),
|
||||||
@@ -48,6 +75,14 @@ PERMISSIONS = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
ROLE_TEMPLATES = (
|
ROLE_TEMPLATES = (
|
||||||
|
RoleTemplate(
|
||||||
|
slug="campaign_aggregate_reader",
|
||||||
|
name="Campaign aggregate reader",
|
||||||
|
description="View privacy-protected outcome totals without recipient or delivery diagnostics.",
|
||||||
|
permissions=(
|
||||||
|
"campaigns:report:read",
|
||||||
|
),
|
||||||
|
),
|
||||||
RoleTemplate(
|
RoleTemplate(
|
||||||
slug="campaign_manager",
|
slug="campaign_manager",
|
||||||
name="Campaign manager",
|
name="Campaign manager",
|
||||||
@@ -68,7 +103,7 @@ ROLE_TEMPLATES = (
|
|||||||
RoleTemplate(
|
RoleTemplate(
|
||||||
slug="campaign_reviewer",
|
slug="campaign_reviewer",
|
||||||
name="Campaign reviewer",
|
name="Campaign reviewer",
|
||||||
description="Inspect and approve prepared campaign messages.",
|
description="Inspect prepared campaign messages and record review completion.",
|
||||||
permissions=(
|
permissions=(
|
||||||
"campaigns:campaign:read",
|
"campaigns:campaign:read",
|
||||||
"campaigns:campaign:validate",
|
"campaigns:campaign:validate",
|
||||||
@@ -89,6 +124,7 @@ ROLE_TEMPLATES = (
|
|||||||
"campaigns:campaign:send",
|
"campaigns:campaign:send",
|
||||||
"campaigns:campaign:retry",
|
"campaigns:campaign:retry",
|
||||||
"campaigns:campaign:reconcile",
|
"campaigns:campaign:reconcile",
|
||||||
|
"campaigns:diagnostic:read",
|
||||||
"campaigns:recipient:read",
|
"campaigns:recipient:read",
|
||||||
"campaigns:report:read",
|
"campaigns:report:read",
|
||||||
"campaigns:report:send",
|
"campaigns:report:send",
|
||||||
@@ -97,40 +133,85 @@ ROLE_TEMPLATES = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _tenant_summary(session, tenant_id: str) -> dict[str, int]:
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign
|
||||||
|
|
||||||
|
return {"campaigns": session.query(Campaign).filter(Campaign.tenant_id == tenant_id).count()}
|
||||||
|
|
||||||
|
|
||||||
def _campaigns_router(context: ModuleContext):
|
def _campaigns_router(context: ModuleContext):
|
||||||
from govoplan_campaign.backend.runtime import configure_runtime
|
from govoplan_campaign.backend.runtime import configure_runtime
|
||||||
|
|
||||||
configure_runtime(registry=context.registry, settings=context.settings)
|
configure_runtime(registry=context.registry, settings=context.settings)
|
||||||
|
from fastapi import APIRouter
|
||||||
from govoplan_campaign.backend.router import router
|
from govoplan_campaign.backend.router import router
|
||||||
|
from govoplan_campaign.backend.schema_router import router as schema_router
|
||||||
|
|
||||||
return router
|
aggregate = APIRouter()
|
||||||
|
aggregate.include_router(router)
|
||||||
|
aggregate.include_router(schema_router)
|
||||||
|
return aggregate
|
||||||
|
|
||||||
|
|
||||||
manifest = ModuleManifest(
|
manifest = ModuleManifest(
|
||||||
id="campaigns",
|
id="campaigns",
|
||||||
name="Campaigns",
|
name="Campaigns",
|
||||||
version="1.0.0",
|
version="0.1.11",
|
||||||
dependencies=("access",),
|
required_capabilities=(CAPABILITY_AUTH_PRINCIPAL_RESOLVER, CAPABILITY_AUTH_PERMISSION_EVALUATOR),
|
||||||
optional_dependencies=("files", "mail"),
|
optional_dependencies=("files", "mail", "notifications", "addresses"),
|
||||||
|
provides_interfaces=(
|
||||||
|
ModuleInterfaceProvider(name="campaigns.access", version="0.1.6"),
|
||||||
|
ModuleInterfaceProvider(name="campaigns.delivery_tasks", version="0.1.6"),
|
||||||
|
ModuleInterfaceProvider(name="campaigns.mail_policy_context", version="0.1.6"),
|
||||||
|
ModuleInterfaceProvider(name="campaigns.policy_context", version="0.1.6"),
|
||||||
|
ModuleInterfaceProvider(name="campaigns.retention", version="0.1.6"),
|
||||||
|
),
|
||||||
|
requires_interfaces=(
|
||||||
|
ModuleInterfaceRequirement(
|
||||||
|
name="files.campaign_attachments",
|
||||||
|
version_min="0.1.0",
|
||||||
|
version_max_exclusive="0.2.0",
|
||||||
|
optional=True,
|
||||||
|
),
|
||||||
|
ModuleInterfaceRequirement(
|
||||||
|
name="mail.campaign_delivery",
|
||||||
|
version_min="0.2.0",
|
||||||
|
version_max_exclusive="0.3.0",
|
||||||
|
optional=True,
|
||||||
|
),
|
||||||
|
ModuleInterfaceRequirement(
|
||||||
|
name="addresses.lookup",
|
||||||
|
version_min="0.1.0",
|
||||||
|
version_max_exclusive="0.2.0",
|
||||||
|
optional=True,
|
||||||
|
),
|
||||||
|
ModuleInterfaceRequirement(
|
||||||
|
name="addresses.recipient_source",
|
||||||
|
version_min="0.1.0",
|
||||||
|
version_max_exclusive="0.2.0",
|
||||||
|
optional=True,
|
||||||
|
),
|
||||||
|
),
|
||||||
permissions=PERMISSIONS,
|
permissions=PERMISSIONS,
|
||||||
route_factory=_campaigns_router,
|
route_factory=_campaigns_router,
|
||||||
role_templates=ROLE_TEMPLATES,
|
role_templates=ROLE_TEMPLATES,
|
||||||
|
tenant_summary_providers=(_tenant_summary,),
|
||||||
nav_items=(
|
nav_items=(
|
||||||
NavItem(path="/campaigns", label="Campaigns", icon="campaign", required_any=("campaigns:campaign:read",), order=20),
|
NavItem(path="/campaigns", label="Campaigns", icon="campaign", required_any=("campaigns:campaign:read",), order=20),
|
||||||
NavItem(
|
NavItem(
|
||||||
path="/operator",
|
path="/operator",
|
||||||
label="Operator Queue",
|
label="Operator Queue",
|
||||||
icon="activity",
|
icon="radio-tower",
|
||||||
|
required_all=("campaigns:campaign:read",),
|
||||||
required_any=(
|
required_any=(
|
||||||
"campaigns:campaign:queue",
|
"campaigns:campaign:queue",
|
||||||
"campaigns:campaign:retry",
|
"campaigns:campaign:retry",
|
||||||
"campaigns:campaign:reconcile",
|
"campaigns:campaign:reconcile",
|
||||||
"campaigns:campaign:control",
|
"campaigns:campaign:control",
|
||||||
"campaigns:campaign:send",
|
|
||||||
),
|
),
|
||||||
order=30,
|
order=30,
|
||||||
),
|
),
|
||||||
NavItem(path="/reports", label="Reports", icon="reports", required_any=("campaigns:report:read",), order=70),
|
NavItem(path="/reports", label="Reports", icon="clipboard-pen-line", required_any=("campaigns:report:read",), order=70),
|
||||||
),
|
),
|
||||||
frontend=FrontendModule(
|
frontend=FrontendModule(
|
||||||
module_id="campaigns",
|
module_id="campaigns",
|
||||||
@@ -140,29 +221,380 @@ manifest = ModuleManifest(
|
|||||||
NavItem(
|
NavItem(
|
||||||
path="/operator",
|
path="/operator",
|
||||||
label="Operator Queue",
|
label="Operator Queue",
|
||||||
icon="activity",
|
icon="radio-tower",
|
||||||
|
required_all=("campaigns:campaign:read",),
|
||||||
required_any=(
|
required_any=(
|
||||||
"campaigns:campaign:queue",
|
"campaigns:campaign:queue",
|
||||||
"campaigns:campaign:retry",
|
"campaigns:campaign:retry",
|
||||||
"campaigns:campaign:reconcile",
|
"campaigns:campaign:reconcile",
|
||||||
"campaigns:campaign:control",
|
"campaigns:campaign:control",
|
||||||
"campaigns:campaign:send",
|
|
||||||
),
|
),
|
||||||
order=30,
|
order=30,
|
||||||
),
|
),
|
||||||
NavItem(path="/reports", label="Reports", icon="reports", required_any=("campaigns:report:read",), order=70),
|
NavItem(path="/reports", label="Reports", icon="clipboard-pen-line", required_any=("campaigns:report:read",), order=70),
|
||||||
NavItem(path="/address-book", label="Address Book", icon="users", order=80),
|
NavItem(path="/templates", label="Templates", icon="layout-template", order=90),
|
||||||
NavItem(path="/templates", label="Templates", icon="form", order=90),
|
|
||||||
),
|
),
|
||||||
),
|
),
|
||||||
migration_spec=MigrationSpec(
|
migration_spec=MigrationSpec(
|
||||||
module_id="campaigns",
|
module_id="campaigns",
|
||||||
metadata=Base.metadata,
|
metadata=Base.metadata,
|
||||||
script_location=str(Path(__file__).with_name("migrations") / "versions"),
|
script_location=str(Path(__file__).with_name("migrations") / "versions"),
|
||||||
|
retirement_supported=True,
|
||||||
|
retirement_provider=drop_table_retirement_provider(
|
||||||
|
campaign_models.Campaign,
|
||||||
|
campaign_models.CampaignShare,
|
||||||
|
campaign_models.RecipientImportMappingProfile,
|
||||||
|
campaign_models.CampaignVersion,
|
||||||
|
campaign_models.CampaignJob,
|
||||||
|
campaign_models.CampaignIssue,
|
||||||
|
campaign_models.AttachmentBlob,
|
||||||
|
campaign_models.AttachmentInstance,
|
||||||
|
campaign_models.SendAttempt,
|
||||||
|
campaign_models.ImapAppendAttempt,
|
||||||
|
label="Campaigns",
|
||||||
|
),
|
||||||
|
retirement_notes="Destructive retirement drops campaign-owned database tables after the installer captures a database snapshot.",
|
||||||
),
|
),
|
||||||
|
uninstall_guard_providers=(
|
||||||
|
persistent_table_uninstall_guard(
|
||||||
|
campaign_models.Campaign,
|
||||||
|
campaign_models.CampaignShare,
|
||||||
|
campaign_models.RecipientImportMappingProfile,
|
||||||
|
campaign_models.CampaignVersion,
|
||||||
|
campaign_models.CampaignJob,
|
||||||
|
campaign_models.CampaignIssue,
|
||||||
|
campaign_models.AttachmentBlob,
|
||||||
|
campaign_models.AttachmentInstance,
|
||||||
|
campaign_models.SendAttempt,
|
||||||
|
campaign_models.ImapAppendAttempt,
|
||||||
|
label="Campaigns",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
documentation=(
|
||||||
|
*CAMPAIGN_USER_DOCUMENTATION,
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.mail-profile-user-journey",
|
||||||
|
title="Choose a Mail profile for campaign delivery",
|
||||||
|
summary="Campaigns reference an authorized Mail profile and never store SMTP/IMAP settings or credentials.",
|
||||||
|
body="Open the campaign Mail settings, select an available profile, test it through Mail, and save. Validation and delivery recheck profile authorization. A changed transport identity requires a new validation and build.",
|
||||||
|
layer="available",
|
||||||
|
documentation_types=("user",),
|
||||||
|
audience=("campaign_manager", "campaign_reviewer", "campaign_sender"),
|
||||||
|
order=46,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns", "mail"),
|
||||||
|
required_scopes=("campaigns:campaign:update", "mail:profile:use"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),
|
||||||
|
DocumentationLink(label="Mail profiles", href="/settings?section=mail-profiles", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign handbook", href="govoplan-campaign/docs/CAMPAIGN_HANDBOOK.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("mail",),
|
||||||
|
unlocks=("Profile-backed SMTP delivery and optional IMAP append-to-Sent.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "workflow",
|
||||||
|
"route": "/campaigns/{campaign_id}/mail-settings",
|
||||||
|
"screen": "Campaign Mail settings",
|
||||||
|
"help_contexts": ["campaign.server-settings"],
|
||||||
|
"prerequisites": [
|
||||||
|
"Campaign and Mail are installed.",
|
||||||
|
"You may edit the current campaign version and use at least one authorized Mail profile.",
|
||||||
|
],
|
||||||
|
"steps": [
|
||||||
|
"Open the campaign and go to Mail settings.",
|
||||||
|
"Select an available Mail profile; Campaign stores only its stable identifier.",
|
||||||
|
"Test SMTP and, when configured, IMAP through the Mail module.",
|
||||||
|
"Save, validate, and build the campaign before queueing delivery.",
|
||||||
|
],
|
||||||
|
"outcome": "The editable campaign version references an authorized Mail-owned delivery profile without copying transport settings or credentials.",
|
||||||
|
"verification": "Reopen Mail settings, confirm the selected profile, then run validation and verify that the build completes without profile-drift errors.",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.mail-profile-governance",
|
||||||
|
"campaigns.mail-profile-operations",
|
||||||
|
"mail.profile-ownership-and-consumers",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.mail-profile-governance",
|
||||||
|
title="Govern Campaign-to-Mail profile references",
|
||||||
|
summary="Mail owns transport definitions and encrypted credentials; Campaign owns only the selected profile reference and delivery evidence.",
|
||||||
|
body="Grant mail:profile:use to campaign authors, constrain profile availability through Mail policy, and keep effective credential inheritance enabled. Inline transport fields are rejected. Legacy records remain unchanged until an explicit, audited profile migration creates or updates an editable version.",
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("admin",),
|
||||||
|
audience=("tenant_admin", "mail_admin", "campaign_admin"),
|
||||||
|
order=47,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns", "mail"),
|
||||||
|
any_scopes=("mail:profile:write", "admin:policies:read", "system:settings:read"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Mail profiles", href="/settings?section=mail-profiles", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign schema", href="/api/v1/campaigns/schema", kind="api"),
|
||||||
|
DocumentationLink(label="Mail profile boundary", href="govoplan-campaign/docs/MAIL_PROFILE_BOUNDARY.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("mail", "access"),
|
||||||
|
unlocks=("Auditable, reusable transport configuration across campaigns.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "reference",
|
||||||
|
"route": "/campaigns/{campaign_id}/mail-policy",
|
||||||
|
"screen": "Campaign Mail policy",
|
||||||
|
"section": "Profile authorization and credential inheritance",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.mail-profile-user-journey",
|
||||||
|
"campaigns.mail-profile-operations",
|
||||||
|
"mail.profile-ownership-and-consumers",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.mail-profile-operations",
|
||||||
|
title="Operate profile-backed campaign delivery",
|
||||||
|
summary="Workers re-authorize and resolve Mail profiles at execution time while Campaign retains only opaque Mail-owned revisions and outcomes.",
|
||||||
|
body="A legacy snapshot, unauthorized or inactive profile, profile-reference mismatch, or changed SMTP/IMAP transport revision stops delivery. Preserve the record, migrate or correct the profile selection, revalidate, rebuild, and only then queue again. Password-only rotation remains possible without copying secrets into Campaign. Uncertain SMTP and IMAP effects remain blocked until an evidence-backed operator reconciliation.",
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("admin",),
|
||||||
|
audience=("campaign_sender", "campaign_operator", "mail_admin"),
|
||||||
|
order=48,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns", "mail"),
|
||||||
|
any_scopes=("campaigns:diagnostic:read", "campaigns:campaign:reconcile", "mail:profile:test"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaign operator queue", href="/operator", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign reports", href="/reports", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign delivery runbook", href="govoplan-campaign/docs/CAMPAIGN_DELIVERY_RUNBOOK.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("mail", "audit"),
|
||||||
|
unlocks=("Fail-closed recovery without exposing Mail credentials.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "reference",
|
||||||
|
"route": "/operator",
|
||||||
|
"screen": "Campaign operator queue",
|
||||||
|
"section": "Profile-backed delivery recovery",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.mail-profile-user-journey",
|
||||||
|
"campaigns.mail-profile-governance",
|
||||||
|
"mail.profile-ownership-and-consumers",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.workflow.prepare-validate-and-build",
|
||||||
|
title="Prepare, validate, and build a campaign",
|
||||||
|
summary="Turn governed recipient, template, attachment, and Mail-profile inputs into exact built messages for review.",
|
||||||
|
body="Prepare each input in its owning surface, resolve every blocking validation issue, and build exact recipient messages before review. Campaign freezes recipient and attachment evidence for the selected version; later source changes do not silently alter that build.",
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("user",),
|
||||||
|
audience=("campaign_manager", "campaign_author"),
|
||||||
|
order=49,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns",),
|
||||||
|
required_scopes=("campaigns:campaign:update", "campaigns:campaign:validate", "campaigns:campaign:build"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign handbook", href="govoplan-campaign/docs/CAMPAIGN_HANDBOOK.md", kind="repository"),
|
||||||
|
DocumentationLink(label="Recipient import guide", href="govoplan-campaign/docs/RECIPIENT_IMPORT_GUIDE.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("addresses", "files", "mail"),
|
||||||
|
unlocks=("A reviewable build whose exact recipient-specific effects can be inspected before delivery.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "workflow",
|
||||||
|
"route": "/campaigns/{campaign_id}/global-settings",
|
||||||
|
"screen": "Campaign workspace",
|
||||||
|
"help_contexts": [
|
||||||
|
"campaign.overview",
|
||||||
|
"campaign.settings",
|
||||||
|
"campaign.fields",
|
||||||
|
"campaign.template",
|
||||||
|
"campaign.attachments",
|
||||||
|
"campaign.recipients",
|
||||||
|
"campaign.recipient-data",
|
||||||
|
"campaign.server-settings",
|
||||||
|
"campaign.global-settings",
|
||||||
|
"campaign.review-send",
|
||||||
|
"campaign.json",
|
||||||
|
],
|
||||||
|
"prerequisites": [
|
||||||
|
"The campaign has an owner and a clear communication purpose.",
|
||||||
|
"You may edit, validate, and build the selected campaign version.",
|
||||||
|
"Optional source modules needed by this campaign are installed and authorized.",
|
||||||
|
],
|
||||||
|
"steps": [
|
||||||
|
"Set campaign-wide fields and purpose, then define the recipient fields and templates.",
|
||||||
|
"Import or select recipients and inspect provenance, exclusions, and review-required rows.",
|
||||||
|
"Select managed attachment versions and an authorized Mail profile when those capabilities are used.",
|
||||||
|
"Validate the relevant sections and resolve every blocker without hiding warnings.",
|
||||||
|
"Build the selected version and inspect representative and exceptional rendered messages.",
|
||||||
|
],
|
||||||
|
"outcome": "The selected version has exact built messages and frozen source evidence ready for an independent review.",
|
||||||
|
"verification": "Open Review, confirm the build belongs to the intended version, and inspect counts, warnings, recipients, addressing, rendered content, and attachment evidence.",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.workflow.complete-review",
|
||||||
|
"campaigns.mail-profile-user-journey",
|
||||||
|
"files.workflow.import-managed-snapshot",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.workflow.complete-review",
|
||||||
|
title="Inspect built messages and complete review",
|
||||||
|
summary="Review the exact immutable candidate and record which built messages were inspected before delivery is enabled.",
|
||||||
|
body="Review completion records the inspected message keys for the selected build. The current baseline does not persist a separate approve/reject decision or review reason, so do not present completion as a richer decision record. Any material input or non-secret transport-identity change requires validation and a new build.",
|
||||||
|
layer="configured",
|
||||||
|
documentation_types=("user",),
|
||||||
|
audience=("campaign_reviewer",),
|
||||||
|
order=50,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns",),
|
||||||
|
required_scopes=("campaigns:campaign:read", "campaigns:campaign:review"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaigns", href="/campaigns", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign handbook", href="govoplan-campaign/docs/CAMPAIGN_HANDBOOK.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("files", "mail"),
|
||||||
|
unlocks=("An attributable review-completion record for the exact built messages inspected.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "workflow",
|
||||||
|
"route": "/campaigns/{campaign_id}/review",
|
||||||
|
"screen": "Review and send",
|
||||||
|
"help_contexts": ["campaign.review-send"],
|
||||||
|
"prerequisites": [
|
||||||
|
"The selected campaign version is validated and built.",
|
||||||
|
"You may read the campaign and complete its review.",
|
||||||
|
],
|
||||||
|
"steps": [
|
||||||
|
"Confirm the campaign, owner, selected version, recipient count, warnings, and exclusions.",
|
||||||
|
"Inspect representative and exceptional messages, addressing, templates, and attachment evidence.",
|
||||||
|
"Confirm that the selected Mail profile is suitable and authorized for the current context.",
|
||||||
|
"Record review completion for the exact message keys inspected.",
|
||||||
|
],
|
||||||
|
"outcome": "The reviewed build is eligible for a separately authorized queue or send action.",
|
||||||
|
"verification": "Reload Review and confirm completion is tied to the same version and message build; changed inputs must invalidate or supersede it.",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.workflow.prepare-validate-and-build",
|
||||||
|
"campaigns.workflow.retry-and-reconcile",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.workflow.retry-and-reconcile",
|
||||||
|
title="Retry only known failures and reconcile uncertain effects",
|
||||||
|
summary="Keep safe-to-retry failures separate from SMTP or IMAP effects whose outcome is unknown.",
|
||||||
|
body="A retry creates new attempt evidence and is valid only for an explicitly eligible state. Never blindly retry an unknown SMTP or IMAP effect. Inspect external evidence, reconcile SMTP as accepted or not sent, and reconcile IMAP as appended or not appended; repairing Sent never resends accepted SMTP mail.",
|
||||||
|
layer="evidence",
|
||||||
|
documentation_types=("admin", "user"),
|
||||||
|
audience=("campaign_sender", "campaign_operator"),
|
||||||
|
order=51,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns",),
|
||||||
|
any_scopes=("campaigns:campaign:retry", "campaigns:campaign:reconcile", "campaigns:diagnostic:read"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaign operator queue", href="/operator", kind="runtime"),
|
||||||
|
DocumentationLink(label="Campaign delivery runbook", href="govoplan-campaign/docs/CAMPAIGN_DELIVERY_RUNBOOK.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("mail", "audit"),
|
||||||
|
unlocks=("Evidence-backed recovery without accidental duplicate external effects.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "workflow",
|
||||||
|
"route": "/operator",
|
||||||
|
"screen": "Campaign operator queue",
|
||||||
|
"help_contexts": ["campaign.review-send", "campaign.report", "campaign.audit"],
|
||||||
|
"prerequisites": [
|
||||||
|
"You may perform the selected retry or reconciliation action.",
|
||||||
|
"Provider, mailbox, worker, and campaign evidence has been preserved.",
|
||||||
|
],
|
||||||
|
"steps": [
|
||||||
|
"Classify the job and latest SMTP and IMAP attempts independently.",
|
||||||
|
"Retry only an explicitly temporary, permanent-with-override, or unattempted eligible state.",
|
||||||
|
"For an unknown effect, inspect provider or mailbox evidence and record the factual reconciliation with a note.",
|
||||||
|
"Verify the resulting protected state before allowing more work for that job.",
|
||||||
|
],
|
||||||
|
"outcome": "Every investigated job is either protected as effected, explicitly retryable, or still visibly unresolved.",
|
||||||
|
"verification": "Confirm the previous attempt remains in history, a retry has a new attempt number, and no accepted SMTP effect was repeated to repair IMAP state.",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.mail-profile-operations",
|
||||||
|
"campaigns.reference.composition-assurance",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
DocumentationTopic(
|
||||||
|
id="campaigns.reference.composition-assurance",
|
||||||
|
title="Assure the Campaign reference composition",
|
||||||
|
summary="Release Campaign only with aligned contracts, role-safe surfaces, durable effect evidence, optional-module isolation, and recoverable data.",
|
||||||
|
body="Campaign is a reference composition only when Core, Mail, Files, Addresses, workers, storage, policies, and documentation are tested in the exact installed combination. Normal readers see business state rather than paths, storage keys, worker claims, or raw provider diagnostics; diagnostic and export authority remain separate.",
|
||||||
|
layer="evidence",
|
||||||
|
documentation_types=("admin",),
|
||||||
|
audience=("platform_operator", "security_reviewer", "release_reviewer", "integrator"),
|
||||||
|
order=52,
|
||||||
|
conditions=(
|
||||||
|
DocumentationCondition(
|
||||||
|
required_modules=("campaigns",),
|
||||||
|
any_scopes=("campaigns:diagnostic:read", "campaigns:report:read", "system:settings:read", "admin:modules:read"),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
links=(
|
||||||
|
DocumentationLink(label="Campaign handbook", href="govoplan-campaign/docs/CAMPAIGN_HANDBOOK.md", kind="repository"),
|
||||||
|
DocumentationLink(label="Reference examples and release checklist", href="govoplan-campaign/docs/EXAMPLE_CAMPAIGNS_AND_RELEASE_CHECKLIST.md", kind="repository"),
|
||||||
|
),
|
||||||
|
related_modules=("mail", "files", "addresses", "audit"),
|
||||||
|
unlocks=("A repeatable, supportable Campaign demonstration rather than an unverified module assembly.",),
|
||||||
|
metadata={
|
||||||
|
"kind": "reference",
|
||||||
|
"route": "/campaigns",
|
||||||
|
"screen": "Campaign reference composition",
|
||||||
|
"section": "Release, security, integration, and recovery assurance",
|
||||||
|
"verification": "Run the maintained examples, module-permutation tests, migration and restore drills, target SMTP/IMAP checks, version-alignment gate, WebUI/i18n checks, and full security audit for the pinned composition.",
|
||||||
|
"related_topic_ids": [
|
||||||
|
"campaigns.workflow.prepare-validate-and-build",
|
||||||
|
"campaigns.workflow.complete-review",
|
||||||
|
"campaigns.workflow.retry-and-reconcile",
|
||||||
|
"mail.reference.credentials-egress-retirement",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
),
|
||||||
|
),
|
||||||
|
documentation_providers=(documentation_topics,),
|
||||||
|
capability_factories={
|
||||||
|
CAPABILITY_CAMPAIGNS_ACCESS: lambda context: __import__(
|
||||||
|
"govoplan_campaign.backend.capabilities",
|
||||||
|
fromlist=["access_capability"],
|
||||||
|
).access_capability(context),
|
||||||
|
CAPABILITY_CAMPAIGNS_DELIVERY_TASKS: lambda context: __import__(
|
||||||
|
"govoplan_campaign.backend.capabilities",
|
||||||
|
fromlist=["delivery_tasks_capability"],
|
||||||
|
).delivery_tasks_capability(context),
|
||||||
|
CAPABILITY_CAMPAIGNS_MAIL_POLICY_CONTEXT: lambda context: __import__(
|
||||||
|
"govoplan_campaign.backend.capabilities",
|
||||||
|
fromlist=["mail_policy_context_capability"],
|
||||||
|
).mail_policy_context_capability(context),
|
||||||
|
CAPABILITY_CAMPAIGNS_POLICY_CONTEXT: lambda context: __import__(
|
||||||
|
"govoplan_campaign.backend.capabilities",
|
||||||
|
fromlist=["policy_context_capability"],
|
||||||
|
).policy_context_capability(context),
|
||||||
|
CAPABILITY_CAMPAIGNS_RETENTION: lambda context: __import__(
|
||||||
|
"govoplan_campaign.backend.capabilities",
|
||||||
|
fromlist=["retention_capability"],
|
||||||
|
).retention_capability(context),
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def get_manifest() -> ModuleManifest:
|
def get_manifest() -> ModuleManifest:
|
||||||
return manifest
|
return manifest
|
||||||
|
|
||||||
|
|||||||
@@ -36,6 +36,10 @@ from govoplan_campaign.backend.campaign.models import (
|
|||||||
)
|
)
|
||||||
from govoplan_campaign.backend.campaign.template_values import build_template_values
|
from govoplan_campaign.backend.campaign.template_values import build_template_values
|
||||||
from govoplan_campaign.backend.services.zip_service import create_zip_archive
|
from govoplan_campaign.backend.services.zip_service import create_zip_archive
|
||||||
|
from govoplan_campaign.backend.template_rendering import (
|
||||||
|
find_unresolved_placeholders as _find_unresolved_placeholders,
|
||||||
|
render_template as _render_template,
|
||||||
|
)
|
||||||
|
|
||||||
from .models import (
|
from .models import (
|
||||||
CampaignBuildReport,
|
CampaignBuildReport,
|
||||||
@@ -47,28 +51,6 @@ from .models import (
|
|||||||
MessageValidationStatus,
|
MessageValidationStatus,
|
||||||
)
|
)
|
||||||
|
|
||||||
_DOLLAR_FIELD_PATTERN = re.compile(r"(?<!\\)\$\{(.*?)(?<!\\)\}")
|
|
||||||
_BRACE_FIELD_PATTERN = re.compile(r"(?<!\\)\{\{\s*(.*?)\s*\}\}")
|
|
||||||
|
|
||||||
|
|
||||||
def _normalize_template_key(raw: str) -> str:
|
|
||||||
key = raw.strip()
|
|
||||||
if key.startswith("fields."):
|
|
||||||
key = key.removeprefix("fields.")
|
|
||||||
elif key.startswith("local."):
|
|
||||||
key = "local::" + key.removeprefix("local.")
|
|
||||||
elif key.startswith("global."):
|
|
||||||
key = "global::" + key.removeprefix("global.")
|
|
||||||
|
|
||||||
if key.startswith("local::") or key.startswith("global::"):
|
|
||||||
return key
|
|
||||||
if key.startswith("local:"):
|
|
||||||
return "local::" + key.removeprefix("local:")
|
|
||||||
if key.startswith("global:"):
|
|
||||||
return "global::" + key.removeprefix("global:")
|
|
||||||
return key
|
|
||||||
|
|
||||||
|
|
||||||
@dataclass(slots=True)
|
@dataclass(slots=True)
|
||||||
class BuiltMessage:
|
class BuiltMessage:
|
||||||
draft: MessageDraft
|
draft: MessageDraft
|
||||||
@@ -81,6 +63,33 @@ class CampaignBuildResult:
|
|||||||
built_messages: list[BuiltMessage]
|
built_messages: list[BuiltMessage]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class _EntryMessageContext:
|
||||||
|
resolution: EntryAttachmentResolution
|
||||||
|
senders: list[RecipientConfig]
|
||||||
|
sender: RecipientConfig | None
|
||||||
|
recipients: dict[str, list[RecipientConfig]]
|
||||||
|
issues: list[MessageIssue]
|
||||||
|
validation_status: MessageValidationStatus
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class _RenderedMessageTemplate:
|
||||||
|
subject: str
|
||||||
|
text_body: str | None
|
||||||
|
html_body: str | None
|
||||||
|
body_mode: str
|
||||||
|
values: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class _MimeBuildResult:
|
||||||
|
message: EmailMessage | None
|
||||||
|
build_status: BuildStatus
|
||||||
|
validation_status: MessageValidationStatus
|
||||||
|
attachment_count: int
|
||||||
|
|
||||||
|
|
||||||
def _resolve(campaign_file: str | Path, raw_path: str) -> Path:
|
def _resolve(campaign_file: str | Path, raw_path: str) -> Path:
|
||||||
campaign_path = Path(campaign_file).resolve()
|
campaign_path = Path(campaign_file).resolve()
|
||||||
path = Path(raw_path).expanduser()
|
path = Path(raw_path).expanduser()
|
||||||
@@ -96,29 +105,6 @@ def _read_text(campaign_file: str | Path, raw_path: str | None, encoding: str =
|
|||||||
return path.read_text(encoding=encoding)
|
return path.read_text(encoding=encoding)
|
||||||
|
|
||||||
|
|
||||||
def _render_template(template: str, values: dict[str, Any], *, keep_missing: bool = True) -> str:
|
|
||||||
def replace(match: re.Match[str]) -> str:
|
|
||||||
key = _normalize_template_key(match.group(1))
|
|
||||||
if key in values:
|
|
||||||
value = values[key]
|
|
||||||
return "" if value is None else str(value)
|
|
||||||
return match.group(0) if keep_missing else ""
|
|
||||||
|
|
||||||
rendered = _DOLLAR_FIELD_PATTERN.sub(replace, template)
|
|
||||||
rendered = _BRACE_FIELD_PATTERN.sub(replace, rendered)
|
|
||||||
return rendered.replace(r"\${", "${").replace(r"\}", "}")
|
|
||||||
|
|
||||||
|
|
||||||
def _find_unresolved_placeholders(text: str | None) -> set[str]:
|
|
||||||
if not text:
|
|
||||||
return set()
|
|
||||||
return {
|
|
||||||
_normalize_template_key(match.group(1))
|
|
||||||
for pattern in (_DOLLAR_FIELD_PATTERN, _BRACE_FIELD_PATTERN)
|
|
||||||
for match in pattern.finditer(text)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def _message_address(recipient: RecipientConfig | None) -> MessageAddress | None:
|
def _message_address(recipient: RecipientConfig | None) -> MessageAddress | None:
|
||||||
if recipient is None:
|
if recipient is None:
|
||||||
return None
|
return None
|
||||||
@@ -218,6 +204,26 @@ def _message_issues_from_attachment_resolution(resolution: EntryAttachmentResolu
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _append_no_attachment_coverage_issue(issues: list[MessageIssue]) -> None:
|
||||||
|
if any(issue.code == "missing_attachment_coverage" for issue in issues):
|
||||||
|
return
|
||||||
|
issues.append(
|
||||||
|
MessageIssue(
|
||||||
|
severity="error",
|
||||||
|
code="missing_attachment_coverage",
|
||||||
|
message="No attachment file was resolved for this message, and sending without attachments is not allowed.",
|
||||||
|
behavior=Behavior.BLOCK.value,
|
||||||
|
source="attachments",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _send_without_attachments_behavior(config: CampaignConfig) -> Behavior:
|
||||||
|
return config.attachments.send_without_attachments_behavior or (
|
||||||
|
Behavior.CONTINUE if config.attachments.send_without_attachments else Behavior.BLOCK
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _safe_filename(value: str | None, fallback: str) -> str:
|
def _safe_filename(value: str | None, fallback: str) -> str:
|
||||||
raw = value or fallback
|
raw = value or fallback
|
||||||
safe = re.sub(r"[^A-Za-z0-9_.-]+", "_", raw).strip("._")
|
safe = re.sub(r"[^A-Za-z0-9_.-]+", "_", raw).strip("._")
|
||||||
@@ -364,6 +370,7 @@ def _attach_files(
|
|||||||
for attachment in resolution.attachments:
|
for attachment in resolution.attachments:
|
||||||
attachment.message_filenames = []
|
attachment.message_filenames = []
|
||||||
attachment.zip_entry_names = []
|
attachment.zip_entry_names = []
|
||||||
|
attachment.zip_filename = None
|
||||||
|
|
||||||
for attachment in resolution.attachments:
|
for attachment in resolution.attachments:
|
||||||
if attachment.status != AttachmentMatchStatus.OK or not attachment.matches:
|
if attachment.status != AttachmentMatchStatus.OK or not attachment.matches:
|
||||||
@@ -408,6 +415,7 @@ def _attach_files(
|
|||||||
work_dir / "_zip" / f"entry-{entry_index:04d}" / _safe_filename(archive.id, "archive") / filename,
|
work_dir / "_zip" / f"entry-{entry_index:04d}" / _safe_filename(archive.id, "archive") / filename,
|
||||||
members,
|
members,
|
||||||
password,
|
password,
|
||||||
|
archive.method.value,
|
||||||
)
|
)
|
||||||
data, maintype, subtype = _attachment_bytes(archive_path)
|
data, maintype, subtype = _attachment_bytes(archive_path)
|
||||||
message.add_attachment(data, maintype=maintype, subtype=subtype, filename=filename)
|
message.add_attachment(data, maintype=maintype, subtype=subtype, filename=filename)
|
||||||
@@ -431,6 +439,355 @@ def _write_eml(message: EmailMessage, output_dir: Path, entry: EntryConfig, entr
|
|||||||
return str(path), path.stat().st_size
|
return str(path), path.stat().st_size
|
||||||
|
|
||||||
|
|
||||||
|
def _entry_message_context(
|
||||||
|
*,
|
||||||
|
config: CampaignConfig,
|
||||||
|
campaign_file: str | Path,
|
||||||
|
entry: EntryConfig,
|
||||||
|
entry_index: int,
|
||||||
|
attachment_match_index: AttachmentMatchIndex | None,
|
||||||
|
) -> _EntryMessageContext:
|
||||||
|
resolution = resolve_entry_attachments(
|
||||||
|
config=config,
|
||||||
|
campaign_file=campaign_file,
|
||||||
|
entry=entry,
|
||||||
|
entry_index=entry_index,
|
||||||
|
match_index=attachment_match_index,
|
||||||
|
)
|
||||||
|
effective_addresses = effective_address_lists(config, entry)
|
||||||
|
senders = effective_addresses["from"]
|
||||||
|
sender = senders[0] if senders else None
|
||||||
|
recipients = {key: value for key, value in effective_addresses.items() if key != "from"}
|
||||||
|
issues = _message_issues_from_attachment_resolution(resolution)
|
||||||
|
validation_status = _validation_status_from_attachment_status(resolution.status)
|
||||||
|
validation_status = _apply_ignored_field_override_issues(config, entry, issues, validation_status)
|
||||||
|
return _EntryMessageContext(
|
||||||
|
resolution=resolution,
|
||||||
|
senders=senders,
|
||||||
|
sender=sender,
|
||||||
|
recipients=recipients,
|
||||||
|
issues=issues,
|
||||||
|
validation_status=validation_status,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_ignored_field_override_issues(
|
||||||
|
config: CampaignConfig,
|
||||||
|
entry: EntryConfig,
|
||||||
|
issues: list[MessageIssue],
|
||||||
|
validation_status: MessageValidationStatus,
|
||||||
|
) -> MessageValidationStatus:
|
||||||
|
ignored_field_overrides = ignored_entry_field_overrides(config, entry)
|
||||||
|
if not ignored_field_overrides:
|
||||||
|
return validation_status
|
||||||
|
issues.append(
|
||||||
|
MessageIssue(
|
||||||
|
severity="warning",
|
||||||
|
code="field_override_not_allowed",
|
||||||
|
message=(
|
||||||
|
"Recipient field value(s) ignored because the campaign field does not allow overrides: "
|
||||||
|
+ ", ".join(ignored_field_overrides)
|
||||||
|
),
|
||||||
|
behavior="warn",
|
||||||
|
source="fields",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if validation_status == MessageValidationStatus.READY:
|
||||||
|
return MessageValidationStatus.WARNING
|
||||||
|
return validation_status
|
||||||
|
|
||||||
|
|
||||||
|
def _message_draft(
|
||||||
|
*,
|
||||||
|
config: CampaignConfig,
|
||||||
|
entry: EntryConfig,
|
||||||
|
entry_index: int,
|
||||||
|
context: _EntryMessageContext,
|
||||||
|
build_status: BuildStatus,
|
||||||
|
validation_status: MessageValidationStatus,
|
||||||
|
send_status: SendStatus = SendStatus.DRAFT,
|
||||||
|
imap_status: ImapStatus | None = None,
|
||||||
|
subject: str | None = None,
|
||||||
|
attachment_count: int = 0,
|
||||||
|
issues: list[MessageIssue] | None = None,
|
||||||
|
eml_path: str | None = None,
|
||||||
|
eml_size: int | None = None,
|
||||||
|
) -> MessageDraft:
|
||||||
|
if validation_status == MessageValidationStatus.EXCLUDED:
|
||||||
|
# Exclusion is a completed validation decision, not a pending delivery.
|
||||||
|
# Keep both transport projections explicit so reports never imply that
|
||||||
|
# SMTP or IMAP work is still expected for this row.
|
||||||
|
send_status = SendStatus.SKIPPED
|
||||||
|
imap_status = ImapStatus.SKIPPED
|
||||||
|
if imap_status is None:
|
||||||
|
imap_status = _imap_initial_status(config) if build_status == BuildStatus.BUILT else ImapStatus.SKIPPED
|
||||||
|
return MessageDraft(
|
||||||
|
entry_index=entry_index,
|
||||||
|
entry_id=entry.id,
|
||||||
|
active=entry.active,
|
||||||
|
build_status=build_status,
|
||||||
|
validation_status=validation_status,
|
||||||
|
send_status=send_status,
|
||||||
|
imap_status=imap_status,
|
||||||
|
subject=subject,
|
||||||
|
from_=_message_address(context.sender),
|
||||||
|
from_all=_message_addresses(context.senders),
|
||||||
|
to=_message_addresses(context.recipients["to"]),
|
||||||
|
cc=_message_addresses(context.recipients["cc"]),
|
||||||
|
bcc=_message_addresses(context.recipients["bcc"]),
|
||||||
|
reply_to=_message_addresses(context.recipients["reply_to"]),
|
||||||
|
bounce_to=_message_addresses(context.recipients["bounce_to"]),
|
||||||
|
disposition_notification_to=_message_addresses(context.recipients["disposition_notification_to"]),
|
||||||
|
attachment_count=attachment_count,
|
||||||
|
attachments=_attachment_summaries(context.resolution),
|
||||||
|
issues=issues if issues is not None else context.issues,
|
||||||
|
eml_path=eml_path,
|
||||||
|
eml_size_bytes=eml_size,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _inactive_entry_message(
|
||||||
|
*,
|
||||||
|
config: CampaignConfig,
|
||||||
|
entry: EntryConfig,
|
||||||
|
entry_index: int,
|
||||||
|
context: _EntryMessageContext,
|
||||||
|
) -> BuiltMessage:
|
||||||
|
draft = _message_draft(
|
||||||
|
config=config,
|
||||||
|
entry=entry,
|
||||||
|
entry_index=entry_index,
|
||||||
|
context=context,
|
||||||
|
build_status=BuildStatus.BUILD_FAILED,
|
||||||
|
validation_status=MessageValidationStatus.INACTIVE,
|
||||||
|
imap_status=ImapStatus.SKIPPED,
|
||||||
|
issues=[
|
||||||
|
MessageIssue(
|
||||||
|
severity="info",
|
||||||
|
code="inactive_entry",
|
||||||
|
message="Entry is inactive",
|
||||||
|
behavior=config.validation_policy.inactive_entry.value,
|
||||||
|
source="entry",
|
||||||
|
)
|
||||||
|
],
|
||||||
|
)
|
||||||
|
return BuiltMessage(draft=draft, mime=None)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_required_recipients(
|
||||||
|
config: CampaignConfig,
|
||||||
|
recipients: dict[str, list[RecipientConfig]],
|
||||||
|
issues: list[MessageIssue],
|
||||||
|
validation_status: MessageValidationStatus,
|
||||||
|
) -> MessageValidationStatus:
|
||||||
|
if recipients["to"]:
|
||||||
|
return validation_status
|
||||||
|
behavior = config.validation_policy.missing_email.value
|
||||||
|
issues.append(
|
||||||
|
_issue_from_behavior(
|
||||||
|
code="missing_email",
|
||||||
|
message="No effective To recipient is configured",
|
||||||
|
behavior=behavior,
|
||||||
|
source="recipients",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if behavior == MissingAddressBehavior.BLOCK.value:
|
||||||
|
return MessageValidationStatus.BLOCKED
|
||||||
|
return MessageValidationStatus.EXCLUDED
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_required_sender(
|
||||||
|
senders: list[RecipientConfig],
|
||||||
|
issues: list[MessageIssue],
|
||||||
|
validation_status: MessageValidationStatus,
|
||||||
|
) -> MessageValidationStatus:
|
||||||
|
if senders:
|
||||||
|
return validation_status
|
||||||
|
issues.append(
|
||||||
|
MessageIssue(
|
||||||
|
severity="error",
|
||||||
|
code="missing_sender",
|
||||||
|
message="No effective From address is configured; Campaign must resolve the sender before building.",
|
||||||
|
behavior="block",
|
||||||
|
source="recipients",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return MessageValidationStatus.BLOCKED
|
||||||
|
|
||||||
|
|
||||||
|
def _render_message_template(
|
||||||
|
config: CampaignConfig,
|
||||||
|
campaign_file: str | Path,
|
||||||
|
entry: EntryConfig,
|
||||||
|
) -> _RenderedMessageTemplate:
|
||||||
|
subject_template, text_template, html_template = _load_template_parts(config, campaign_file)
|
||||||
|
body_mode = _template_body_mode(config)
|
||||||
|
values = build_template_values(config, entry)
|
||||||
|
keep_missing_placeholders = not config.validation_policy.ignore_empty_fields
|
||||||
|
subject = _render_template(subject_template, values, keep_missing=keep_missing_placeholders)
|
||||||
|
text_body = None
|
||||||
|
html_body = None
|
||||||
|
if text_template is not None:
|
||||||
|
text_body = _render_template(text_template or "", values, keep_missing=keep_missing_placeholders)
|
||||||
|
if html_template is not None:
|
||||||
|
html_body = _render_template(html_template or "", values, keep_missing=keep_missing_placeholders)
|
||||||
|
return _RenderedMessageTemplate(
|
||||||
|
subject=subject,
|
||||||
|
text_body=text_body,
|
||||||
|
html_body=html_body,
|
||||||
|
body_mode=body_mode,
|
||||||
|
values=values,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _unresolved_template_fields(rendered: _RenderedMessageTemplate) -> list[str]:
|
||||||
|
unresolved_fields = _find_unresolved_placeholders(rendered.subject)
|
||||||
|
if rendered.body_mode in {TemplateBodyMode.TEXT.value, TemplateBodyMode.BOTH.value}:
|
||||||
|
unresolved_fields |= _find_unresolved_placeholders(rendered.text_body)
|
||||||
|
if rendered.body_mode in {TemplateBodyMode.HTML.value, TemplateBodyMode.BOTH.value}:
|
||||||
|
unresolved_fields |= _find_unresolved_placeholders(rendered.html_body)
|
||||||
|
return sorted(unresolved_fields)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_rendered_template(
|
||||||
|
config: CampaignConfig,
|
||||||
|
rendered: _RenderedMessageTemplate,
|
||||||
|
issues: list[MessageIssue],
|
||||||
|
validation_status: MessageValidationStatus,
|
||||||
|
) -> MessageValidationStatus:
|
||||||
|
unresolved = _unresolved_template_fields(rendered)
|
||||||
|
if not unresolved:
|
||||||
|
return validation_status
|
||||||
|
behavior = config.validation_policy.template_error.value
|
||||||
|
issues.append(
|
||||||
|
_issue_from_behavior(
|
||||||
|
code="template_error",
|
||||||
|
message="Unresolved template placeholder(s): " + ", ".join(unresolved),
|
||||||
|
behavior=behavior,
|
||||||
|
source="template",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if behavior == MissingAddressBehavior.BLOCK.value:
|
||||||
|
return MessageValidationStatus.BLOCKED
|
||||||
|
return MessageValidationStatus.EXCLUDED
|
||||||
|
|
||||||
|
|
||||||
|
def _populate_message_headers(
|
||||||
|
message: EmailMessage,
|
||||||
|
*,
|
||||||
|
senders: list[RecipientConfig],
|
||||||
|
recipients: dict[str, list[RecipientConfig]],
|
||||||
|
subject: str,
|
||||||
|
) -> None:
|
||||||
|
message["Date"] = formatdate(localtime=True)
|
||||||
|
message["Message-ID"] = make_msgid()
|
||||||
|
if senders:
|
||||||
|
message["From"] = _format_recipient_header(senders)
|
||||||
|
if len(senders) > 1:
|
||||||
|
# RFC 5322 requires a singular Sender when From contains more
|
||||||
|
# than one mailbox. The first effective From address remains
|
||||||
|
# the SMTP envelope sender and compatibility primary value.
|
||||||
|
message["Sender"] = _format_recipient(senders[0])
|
||||||
|
if recipients["to"]:
|
||||||
|
message["To"] = _format_recipient_header(recipients["to"])
|
||||||
|
if recipients["cc"]:
|
||||||
|
message["Cc"] = _format_recipient_header(recipients["cc"])
|
||||||
|
# Bcc deliberately remains envelope-only and is tracked in MessageDraft.
|
||||||
|
if recipients["reply_to"]:
|
||||||
|
message["Reply-To"] = _format_recipient_header(recipients["reply_to"])
|
||||||
|
if recipients["disposition_notification_to"]:
|
||||||
|
message["Disposition-Notification-To"] = _format_recipient_header(
|
||||||
|
recipients["disposition_notification_to"]
|
||||||
|
)
|
||||||
|
# bounce_to is tracked but not emitted as Return-Path. That should be the SMTP envelope sender.
|
||||||
|
message["Subject"] = subject
|
||||||
|
|
||||||
|
|
||||||
|
def _populate_message_body(message: EmailMessage, rendered: _RenderedMessageTemplate) -> None:
|
||||||
|
effective_html_body = rendered.html_body if rendered.html_body and rendered.html_body.strip() else None
|
||||||
|
if rendered.body_mode == TemplateBodyMode.HTML.value:
|
||||||
|
message.set_content(effective_html_body or "", subtype="html")
|
||||||
|
elif rendered.body_mode == TemplateBodyMode.TEXT.value:
|
||||||
|
message.set_content(rendered.text_body or "")
|
||||||
|
elif effective_html_body is not None:
|
||||||
|
message.set_content(rendered.text_body or "")
|
||||||
|
message.add_alternative(effective_html_body, subtype="html")
|
||||||
|
else:
|
||||||
|
message.set_content(rendered.text_body or "")
|
||||||
|
|
||||||
|
|
||||||
|
def _build_mime_message(
|
||||||
|
*,
|
||||||
|
config: CampaignConfig,
|
||||||
|
entry: EntryConfig,
|
||||||
|
entry_index: int,
|
||||||
|
output_dir: Path | None,
|
||||||
|
work_dir: Path | None,
|
||||||
|
context: _EntryMessageContext,
|
||||||
|
rendered: _RenderedMessageTemplate,
|
||||||
|
) -> _MimeBuildResult:
|
||||||
|
message = EmailMessage()
|
||||||
|
try:
|
||||||
|
_populate_message_headers(
|
||||||
|
message,
|
||||||
|
senders=context.senders,
|
||||||
|
recipients=context.recipients,
|
||||||
|
subject=rendered.subject,
|
||||||
|
)
|
||||||
|
_populate_message_body(message, rendered)
|
||||||
|
if work_dir is None:
|
||||||
|
work_dir = output_dir or Path(tempfile.mkdtemp(prefix="govoplan-build-"))
|
||||||
|
attachment_count = _attach_files(
|
||||||
|
message=message,
|
||||||
|
config=config,
|
||||||
|
entry=entry,
|
||||||
|
entry_index=entry_index,
|
||||||
|
resolution=context.resolution,
|
||||||
|
values=rendered.values,
|
||||||
|
work_dir=work_dir,
|
||||||
|
)
|
||||||
|
if attachment_count == 0 and context.resolution.attachments and _send_without_attachments_behavior(config) == Behavior.BLOCK:
|
||||||
|
_append_no_attachment_coverage_issue(context.issues)
|
||||||
|
return _MimeBuildResult(
|
||||||
|
message=None,
|
||||||
|
build_status=BuildStatus.BUILD_FAILED,
|
||||||
|
validation_status=MessageValidationStatus.BLOCKED,
|
||||||
|
attachment_count=0,
|
||||||
|
)
|
||||||
|
return _MimeBuildResult(
|
||||||
|
message=message,
|
||||||
|
build_status=BuildStatus.BUILT,
|
||||||
|
validation_status=context.validation_status,
|
||||||
|
attachment_count=attachment_count,
|
||||||
|
)
|
||||||
|
except ZipBuildError as exc:
|
||||||
|
context.issues.append(
|
||||||
|
MessageIssue(
|
||||||
|
severity="error",
|
||||||
|
code=exc.code,
|
||||||
|
message=str(exc),
|
||||||
|
behavior="block",
|
||||||
|
source="attachments",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
except Exception as exc:
|
||||||
|
context.issues.append(
|
||||||
|
MessageIssue(
|
||||||
|
severity="error",
|
||||||
|
code="build_failed",
|
||||||
|
message=str(exc),
|
||||||
|
behavior="block",
|
||||||
|
source="builder",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return _MimeBuildResult(
|
||||||
|
message=None,
|
||||||
|
build_status=BuildStatus.BUILD_FAILED,
|
||||||
|
validation_status=MessageValidationStatus.BLOCKED,
|
||||||
|
attachment_count=0,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def build_entry_message(
|
def build_entry_message(
|
||||||
*,
|
*,
|
||||||
config: CampaignConfig,
|
config: CampaignConfig,
|
||||||
@@ -442,169 +799,62 @@ def build_entry_message(
|
|||||||
work_dir: Path | None = None,
|
work_dir: Path | None = None,
|
||||||
attachment_match_index: AttachmentMatchIndex | None = None,
|
attachment_match_index: AttachmentMatchIndex | None = None,
|
||||||
) -> BuiltMessage:
|
) -> BuiltMessage:
|
||||||
resolution = resolve_entry_attachments(config=config, campaign_file=campaign_file, entry=entry, entry_index=entry_index, match_index=attachment_match_index)
|
context = _entry_message_context(
|
||||||
effective_addresses = effective_address_lists(config, entry)
|
config=config,
|
||||||
senders = effective_addresses["from"]
|
campaign_file=campaign_file,
|
||||||
sender = senders[0] if senders else None
|
entry=entry,
|
||||||
recipients = {key: value for key, value in effective_addresses.items() if key != "from"}
|
entry_index=entry_index,
|
||||||
issues = _message_issues_from_attachment_resolution(resolution)
|
attachment_match_index=attachment_match_index,
|
||||||
validation_status = _validation_status_from_attachment_status(resolution.status)
|
)
|
||||||
|
|
||||||
ignored_field_overrides = ignored_entry_field_overrides(config, entry)
|
|
||||||
if ignored_field_overrides:
|
|
||||||
issues.append(
|
|
||||||
MessageIssue(
|
|
||||||
severity="warning",
|
|
||||||
code="field_override_not_allowed",
|
|
||||||
message="Recipient field value(s) ignored because the campaign field does not allow overrides: " + ", ".join(ignored_field_overrides),
|
|
||||||
behavior="warn",
|
|
||||||
source="fields",
|
|
||||||
)
|
|
||||||
)
|
|
||||||
if validation_status == MessageValidationStatus.READY:
|
|
||||||
validation_status = MessageValidationStatus.WARNING
|
|
||||||
|
|
||||||
if not entry.active:
|
if not entry.active:
|
||||||
draft = MessageDraft(
|
return _inactive_entry_message(config=config, entry=entry, entry_index=entry_index, context=context)
|
||||||
entry_index=entry_index,
|
|
||||||
entry_id=entry.id,
|
|
||||||
active=False,
|
|
||||||
build_status=BuildStatus.BUILD_FAILED,
|
|
||||||
validation_status=MessageValidationStatus.INACTIVE,
|
|
||||||
send_status=SendStatus.DRAFT,
|
|
||||||
imap_status=ImapStatus.SKIPPED,
|
|
||||||
from_=_message_address(sender),
|
|
||||||
from_all=_message_addresses(senders),
|
|
||||||
to=_message_addresses(recipients["to"]),
|
|
||||||
cc=_message_addresses(recipients["cc"]),
|
|
||||||
bcc=_message_addresses(recipients["bcc"]),
|
|
||||||
reply_to=_message_addresses(recipients["reply_to"]),
|
|
||||||
bounce_to=_message_addresses(recipients["bounce_to"]),
|
|
||||||
disposition_notification_to=_message_addresses(recipients["disposition_notification_to"]),
|
|
||||||
attachments=_attachment_summaries(resolution),
|
|
||||||
issues=[MessageIssue(severity="info", code="inactive_entry", message="Entry is inactive", behavior=config.validation_policy.inactive_entry.value, source="entry")],
|
|
||||||
)
|
|
||||||
return BuiltMessage(draft=draft, mime=None)
|
|
||||||
|
|
||||||
if not recipients["to"]:
|
context.validation_status = _validate_required_sender(
|
||||||
behavior = config.validation_policy.missing_email.value
|
context.senders,
|
||||||
issues.append(_issue_from_behavior(code="missing_email", message="No effective To recipient is configured", behavior=behavior, source="recipients"))
|
context.issues,
|
||||||
validation_status = MessageValidationStatus.BLOCKED if behavior == MissingAddressBehavior.BLOCK.value else MessageValidationStatus.EXCLUDED
|
context.validation_status,
|
||||||
|
)
|
||||||
subject_template, text_template, html_template = _load_template_parts(config, campaign_file)
|
context.validation_status = _validate_required_recipients(
|
||||||
body_mode = _template_body_mode(config)
|
config,
|
||||||
values = build_template_values(config, entry)
|
context.recipients,
|
||||||
keep_missing_placeholders = not config.validation_policy.ignore_empty_fields
|
context.issues,
|
||||||
subject = _render_template(subject_template, values, keep_missing=keep_missing_placeholders)
|
context.validation_status,
|
||||||
text_body = _render_template(text_template or "", values, keep_missing=keep_missing_placeholders) if text_template is not None else None
|
)
|
||||||
html_body = _render_template(html_template or "", values, keep_missing=keep_missing_placeholders) if html_template is not None else None
|
rendered = _render_message_template(config, campaign_file, entry)
|
||||||
|
context.validation_status = _validate_rendered_template(
|
||||||
unresolved_fields = _find_unresolved_placeholders(subject)
|
config,
|
||||||
if body_mode in {TemplateBodyMode.TEXT.value, TemplateBodyMode.BOTH.value}:
|
rendered,
|
||||||
unresolved_fields |= _find_unresolved_placeholders(text_body)
|
context.issues,
|
||||||
if body_mode in {TemplateBodyMode.HTML.value, TemplateBodyMode.BOTH.value}:
|
context.validation_status,
|
||||||
unresolved_fields |= _find_unresolved_placeholders(html_body)
|
)
|
||||||
unresolved = sorted(unresolved_fields)
|
mime_result = _build_mime_message(
|
||||||
if unresolved:
|
config=config,
|
||||||
behavior = config.validation_policy.template_error.value
|
entry=entry,
|
||||||
issues.append(
|
entry_index=entry_index,
|
||||||
_issue_from_behavior(
|
output_dir=output_dir,
|
||||||
code="template_error",
|
work_dir=work_dir,
|
||||||
message="Unresolved template placeholder(s): " + ", ".join(unresolved),
|
context=context,
|
||||||
behavior=behavior,
|
rendered=rendered,
|
||||||
source="template",
|
)
|
||||||
)
|
|
||||||
)
|
|
||||||
validation_status = MessageValidationStatus.BLOCKED if behavior == MissingAddressBehavior.BLOCK.value else MessageValidationStatus.EXCLUDED
|
|
||||||
|
|
||||||
message = EmailMessage()
|
|
||||||
try:
|
|
||||||
message["Date"] = formatdate(localtime=True)
|
|
||||||
message["Message-ID"] = make_msgid()
|
|
||||||
if senders:
|
|
||||||
message["From"] = _format_recipient_header(senders)
|
|
||||||
if len(senders) > 1:
|
|
||||||
# RFC 5322 requires a singular Sender when From contains more
|
|
||||||
# than one mailbox. The first effective From address remains
|
|
||||||
# the SMTP envelope sender and compatibility primary value.
|
|
||||||
message["Sender"] = _format_recipient(senders[0])
|
|
||||||
if recipients["to"]:
|
|
||||||
message["To"] = _format_recipient_header(recipients["to"])
|
|
||||||
if recipients["cc"]:
|
|
||||||
message["Cc"] = _format_recipient_header(recipients["cc"])
|
|
||||||
# Bcc deliberately remains envelope-only and is tracked in MessageDraft.
|
|
||||||
if recipients["reply_to"]:
|
|
||||||
message["Reply-To"] = _format_recipient_header(recipients["reply_to"])
|
|
||||||
if recipients["disposition_notification_to"]:
|
|
||||||
message["Disposition-Notification-To"] = _format_recipient_header(recipients["disposition_notification_to"])
|
|
||||||
# bounce_to is tracked but not emitted as Return-Path. That should be the SMTP envelope sender.
|
|
||||||
message["Subject"] = subject
|
|
||||||
|
|
||||||
effective_html_body = html_body if html_body and html_body.strip() else None
|
|
||||||
if body_mode == TemplateBodyMode.HTML.value:
|
|
||||||
message.set_content(effective_html_body or "", subtype="html")
|
|
||||||
elif body_mode == TemplateBodyMode.TEXT.value:
|
|
||||||
message.set_content(text_body or "")
|
|
||||||
elif effective_html_body is not None:
|
|
||||||
message.set_content(text_body or "")
|
|
||||||
message.add_alternative(effective_html_body, subtype="html")
|
|
||||||
else:
|
|
||||||
message.set_content(text_body or "")
|
|
||||||
|
|
||||||
if work_dir is None:
|
|
||||||
work_dir = output_dir or Path(tempfile.mkdtemp(prefix="multimailer-build-"))
|
|
||||||
attachment_count = _attach_files(
|
|
||||||
message=message,
|
|
||||||
config=config,
|
|
||||||
entry=entry,
|
|
||||||
entry_index=entry_index,
|
|
||||||
resolution=resolution,
|
|
||||||
values=values,
|
|
||||||
work_dir=work_dir,
|
|
||||||
)
|
|
||||||
build_status = BuildStatus.BUILT
|
|
||||||
except ZipBuildError as exc:
|
|
||||||
issues.append(MessageIssue(severity="error", code=exc.code, message=str(exc), behavior="block", source="attachments"))
|
|
||||||
validation_status = MessageValidationStatus.BLOCKED
|
|
||||||
build_status = BuildStatus.BUILD_FAILED
|
|
||||||
attachment_count = 0
|
|
||||||
message = None # type: ignore[assignment]
|
|
||||||
except Exception as exc:
|
|
||||||
issues.append(MessageIssue(severity="error", code="build_failed", message=str(exc), behavior="block", source="builder"))
|
|
||||||
validation_status = MessageValidationStatus.BLOCKED
|
|
||||||
build_status = BuildStatus.BUILD_FAILED
|
|
||||||
attachment_count = 0
|
|
||||||
message = None # type: ignore[assignment]
|
|
||||||
|
|
||||||
eml_path: str | None = None
|
eml_path: str | None = None
|
||||||
eml_size: int | None = None
|
eml_size: int | None = None
|
||||||
if write_eml and output_dir is not None and message is not None:
|
if write_eml and output_dir is not None and mime_result.message is not None:
|
||||||
eml_path, eml_size = _write_eml(message, output_dir, entry, entry_index)
|
eml_path, eml_size = _write_eml(mime_result.message, output_dir, entry, entry_index)
|
||||||
|
|
||||||
draft = MessageDraft(
|
draft = _message_draft(
|
||||||
|
config=config,
|
||||||
|
entry=entry,
|
||||||
entry_index=entry_index,
|
entry_index=entry_index,
|
||||||
entry_id=entry.id,
|
context=context,
|
||||||
active=entry.active,
|
build_status=mime_result.build_status,
|
||||||
build_status=build_status,
|
validation_status=mime_result.validation_status,
|
||||||
validation_status=validation_status,
|
subject=rendered.subject,
|
||||||
send_status=SendStatus.DRAFT,
|
attachment_count=mime_result.attachment_count,
|
||||||
imap_status=_imap_initial_status(config) if build_status == BuildStatus.BUILT else ImapStatus.SKIPPED,
|
|
||||||
subject=subject,
|
|
||||||
from_=_message_address(sender),
|
|
||||||
from_all=_message_addresses(senders),
|
|
||||||
to=_message_addresses(recipients["to"]),
|
|
||||||
cc=_message_addresses(recipients["cc"]),
|
|
||||||
bcc=_message_addresses(recipients["bcc"]),
|
|
||||||
reply_to=_message_addresses(recipients["reply_to"]),
|
|
||||||
bounce_to=_message_addresses(recipients["bounce_to"]),
|
|
||||||
disposition_notification_to=_message_addresses(recipients["disposition_notification_to"]),
|
|
||||||
attachment_count=attachment_count,
|
|
||||||
attachments=_attachment_summaries(resolution),
|
|
||||||
issues=issues,
|
|
||||||
eml_path=eml_path,
|
eml_path=eml_path,
|
||||||
eml_size_bytes=eml_size,
|
eml_size=eml_size,
|
||||||
)
|
)
|
||||||
return BuiltMessage(draft=draft, mime=message)
|
return BuiltMessage(draft=draft, mime=mime_result.message)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -680,7 +930,7 @@ def build_campaign_messages(
|
|||||||
|
|
||||||
started = time.perf_counter()
|
started = time.perf_counter()
|
||||||
attachment_match_index = AttachmentMatchIndex()
|
attachment_match_index = AttachmentMatchIndex()
|
||||||
with tempfile.TemporaryDirectory(prefix="multimailer-build-") as tmp:
|
with tempfile.TemporaryDirectory(prefix="govoplan-build-") as tmp:
|
||||||
work_dir = output_path or Path(tmp)
|
work_dir = output_path or Path(tmp)
|
||||||
built_messages = [
|
built_messages = [
|
||||||
build_entry_message(
|
build_entry_message(
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
"""recipient import mapping profiles
|
||||||
|
|
||||||
|
Revision ID: 2c3d4e5f7081
|
||||||
|
Revises: 2e3f4a5b6c7d
|
||||||
|
Create Date: 2026-06-26 00:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "2c3d4e5f7081"
|
||||||
|
down_revision = "2e3f4a5b6c7d"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def _scope_fk_target(inspector) -> str:
|
||||||
|
tables = set(inspector.get_table_names())
|
||||||
|
return "core_scopes.id" if "core_scopes" in tables else "tenancy_tenants.id"
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
inspector = sa.inspect(op.get_bind())
|
||||||
|
if "campaign_recipient_import_mapping_profiles" in inspector.get_table_names():
|
||||||
|
return
|
||||||
|
scope_fk_target = _scope_fk_target(inspector)
|
||||||
|
op.create_table(
|
||||||
|
"campaign_recipient_import_mapping_profiles",
|
||||||
|
sa.Column("id", sa.String(length=36), nullable=False),
|
||||||
|
sa.Column("tenant_id", sa.String(length=36), nullable=False),
|
||||||
|
sa.Column("owner_user_id", sa.String(length=36), nullable=False),
|
||||||
|
sa.Column("name", sa.String(length=255), nullable=False),
|
||||||
|
sa.Column("column_count", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("headers", sa.JSON(), nullable=False),
|
||||||
|
sa.Column("normalized_headers", sa.JSON(), nullable=False),
|
||||||
|
sa.Column("ordered_header_fingerprint", sa.String(length=64), nullable=False),
|
||||||
|
sa.Column("unordered_header_fingerprint", sa.String(length=64), nullable=False),
|
||||||
|
sa.Column("delimiter", sa.String(length=8), nullable=False),
|
||||||
|
sa.Column("header_rows", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("quoted", sa.Boolean(), nullable=False),
|
||||||
|
sa.Column("value_separators", sa.String(length=50), nullable=False),
|
||||||
|
sa.Column("mappings", sa.JSON(), nullable=False),
|
||||||
|
sa.Column("created_at", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column("updated_at", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(["owner_user_id"], ["access_users.id"], name=op.f("fk_campaign_recipient_import_mapping_profiles_owner_user_id_users"), ondelete="CASCADE"),
|
||||||
|
sa.ForeignKeyConstraint(["tenant_id"], [scope_fk_target], name=op.f("fk_campaign_recipient_import_mapping_profiles_tenant_id_scopes"), ondelete="CASCADE"),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_campaign_recipient_import_mapping_profiles")),
|
||||||
|
)
|
||||||
|
op.create_index(op.f("ix_campaign_recipient_import_mapping_profiles_tenant_id"), "campaign_recipient_import_mapping_profiles", ["tenant_id"], unique=False)
|
||||||
|
op.create_index(op.f("ix_campaign_recipient_import_mapping_profiles_owner_user_id"), "campaign_recipient_import_mapping_profiles", ["owner_user_id"], unique=False)
|
||||||
|
op.create_index(op.f("ix_campaign_recipient_import_mapping_profiles_ordered_header_fingerprint"), "campaign_recipient_import_mapping_profiles", ["ordered_header_fingerprint"], unique=False)
|
||||||
|
op.create_index(op.f("ix_campaign_recipient_import_mapping_profiles_unordered_header_fingerprint"), "campaign_recipient_import_mapping_profiles", ["unordered_header_fingerprint"], unique=False)
|
||||||
|
op.create_index("ix_recipient_import_profiles_owner", "campaign_recipient_import_mapping_profiles", ["tenant_id", "owner_user_id"], unique=False)
|
||||||
|
op.create_index("ix_recipient_import_profiles_ordered_fp", "campaign_recipient_import_mapping_profiles", ["tenant_id", "owner_user_id", "ordered_header_fingerprint"], unique=False)
|
||||||
|
op.create_index("ix_recipient_import_profiles_unordered_fp", "campaign_recipient_import_mapping_profiles", ["tenant_id", "owner_user_id", "unordered_header_fingerprint"], unique=False)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
inspector = sa.inspect(op.get_bind())
|
||||||
|
if "campaign_recipient_import_mapping_profiles" not in inspector.get_table_names():
|
||||||
|
return
|
||||||
|
op.drop_index("ix_recipient_import_profiles_unordered_fp", table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index("ix_recipient_import_profiles_ordered_fp", table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index("ix_recipient_import_profiles_owner", table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index(op.f("ix_campaign_recipient_import_mapping_profiles_unordered_header_fingerprint"), table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index(op.f("ix_campaign_recipient_import_mapping_profiles_ordered_header_fingerprint"), table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index(op.f("ix_campaign_recipient_import_mapping_profiles_owner_user_id"), table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_index(op.f("ix_campaign_recipient_import_mapping_profiles_tenant_id"), table_name="campaign_recipient_import_mapping_profiles")
|
||||||
|
op.drop_table("campaign_recipient_import_mapping_profiles")
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"""add durable IMAP append claim and attempt idempotency
|
||||||
|
|
||||||
|
Revision ID: 3c4d5e6f8192
|
||||||
|
Revises: 2c3d4e5f7081
|
||||||
|
Create Date: 2026-07-21 00:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "3c4d5e6f8192"
|
||||||
|
down_revision = "2c3d4e5f7081"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.add_column(sa.Column("imap_claimed_at", sa.DateTime(timezone=True), nullable=True))
|
||||||
|
batch.add_column(sa.Column("imap_claim_token", sa.String(length=36), nullable=True))
|
||||||
|
batch.create_index("ix_campaign_jobs_imap_claim_token", ["imap_claim_token"], unique=False)
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.add_column(sa.Column("claim_token", sa.String(length=36), nullable=True))
|
||||||
|
_renumber_attempts()
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.create_unique_constraint(
|
||||||
|
"uq_imap_append_attempts_job_attempt",
|
||||||
|
["job_id", "attempt_number"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.drop_constraint("uq_imap_append_attempts_job_attempt", type_="unique")
|
||||||
|
batch.drop_column("claim_token")
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.drop_index("ix_campaign_jobs_imap_claim_token")
|
||||||
|
batch.drop_column("imap_claim_token")
|
||||||
|
batch.drop_column("imap_claimed_at")
|
||||||
|
|
||||||
|
|
||||||
|
def _renumber_attempts() -> None:
|
||||||
|
"""Make historical attempt numbers unique per job before constraining them."""
|
||||||
|
|
||||||
|
bind = op.get_bind()
|
||||||
|
rows = list(
|
||||||
|
bind.execute(
|
||||||
|
sa.text(
|
||||||
|
"SELECT id, job_id FROM imap_append_attempts "
|
||||||
|
"ORDER BY job_id, created_at, id"
|
||||||
|
)
|
||||||
|
).mappings()
|
||||||
|
)
|
||||||
|
per_job: dict[str, int] = {}
|
||||||
|
for row in rows:
|
||||||
|
job_id = str(row["job_id"])
|
||||||
|
attempt_number = per_job.get(job_id, 0) + 1
|
||||||
|
per_job[job_id] = attempt_number
|
||||||
|
bind.execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE imap_append_attempts SET attempt_number = :attempt_number "
|
||||||
|
"WHERE id = :attempt_id"
|
||||||
|
),
|
||||||
|
{"attempt_number": attempt_number, "attempt_id": row["id"]},
|
||||||
|
)
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
"""seal each campaign delivery job's immutable execution input
|
||||||
|
|
||||||
|
Revision ID: 4d5e6f7a9203
|
||||||
|
Revises: 3c4d5e6f8192
|
||||||
|
Create Date: 2026-07-21 00:00:01.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "4d5e6f7a9203"
|
||||||
|
down_revision = "3c4d5e6f8192"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.add_column(sa.Column("execution_input_sha256", sa.String(length=64), nullable=True))
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.drop_column("execution_input_sha256")
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
"""persist the selected Campaign delivery mode
|
||||||
|
|
||||||
|
Revision ID: c7a2f91e4b60
|
||||||
|
Revises: 4d5e6f7a9203
|
||||||
|
Create Date: 2026-07-22 09:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "c7a2f91e4b60"
|
||||||
|
down_revision = "4d5e6f7a9203"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_versions") as batch:
|
||||||
|
batch.add_column(sa.Column("delivery_mode", sa.String(length=30), nullable=True))
|
||||||
|
batch.add_column(sa.Column("delivery_mode_selected_at", sa.DateTime(timezone=True), nullable=True))
|
||||||
|
batch.create_index("ix_campaign_versions_delivery_mode", ["delivery_mode"], unique=False)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_versions") as batch:
|
||||||
|
batch.drop_index("ix_campaign_versions_delivery_mode")
|
||||||
|
batch.drop_column("delivery_mode_selected_at")
|
||||||
|
batch.drop_column("delivery_mode")
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
"""mark untouched excluded jobs as skipped delivery
|
||||||
|
|
||||||
|
Revision ID: d8b3e2c1f4a5
|
||||||
|
Revises: c7a2f91e4b60
|
||||||
|
Create Date: 2026-07-22 11:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "d8b3e2c1f4a5"
|
||||||
|
down_revision = "c7a2f91e4b60"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
# Only normalize rows with no recorded transport effect. Unexpected
|
||||||
|
# historical delivery evidence must remain intact for audit/reconciliation.
|
||||||
|
op.get_bind().execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE campaign_jobs "
|
||||||
|
"SET send_status = 'skipped', imap_status = 'skipped' "
|
||||||
|
"WHERE validation_status = 'excluded' "
|
||||||
|
"AND send_status = 'not_queued' "
|
||||||
|
"AND imap_status IN ('not_requested', 'pending', 'skipped')"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
op.get_bind().execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE campaign_jobs "
|
||||||
|
"SET send_status = 'not_queued', imap_status = 'not_requested' "
|
||||||
|
"WHERE validation_status = 'excluded' "
|
||||||
|
"AND send_status = 'skipped' "
|
||||||
|
"AND imap_status = 'skipped'"
|
||||||
|
)
|
||||||
|
)
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
"""v0.1.7 campaign baseline
|
||||||
|
|
||||||
|
Revision ID: 2c3d4e5f7081
|
||||||
|
Revises: None
|
||||||
|
Create Date: 2026-07-11 00:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = '2c3d4e5f7081'
|
||||||
|
down_revision = None
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = '4f2a9c8e7b6d'
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
op.create_table('campaign_recipient_import_mapping_profiles',
|
||||||
|
sa.Column('id', sa.String(length=36), nullable=False),
|
||||||
|
sa.Column('tenant_id', sa.String(length=36), nullable=False),
|
||||||
|
sa.Column('owner_user_id', sa.String(length=36), nullable=False),
|
||||||
|
sa.Column('name', sa.String(length=255), nullable=False),
|
||||||
|
sa.Column('column_count', sa.Integer(), nullable=False),
|
||||||
|
sa.Column('headers', sa.JSON(), nullable=False),
|
||||||
|
sa.Column('normalized_headers', sa.JSON(), nullable=False),
|
||||||
|
sa.Column('ordered_header_fingerprint', sa.String(length=64), nullable=False),
|
||||||
|
sa.Column('unordered_header_fingerprint', sa.String(length=64), nullable=False),
|
||||||
|
sa.Column('delimiter', sa.String(length=8), nullable=False),
|
||||||
|
sa.Column('header_rows', sa.Integer(), nullable=False),
|
||||||
|
sa.Column('quoted', sa.Boolean(), nullable=False),
|
||||||
|
sa.Column('value_separators', sa.String(length=50), nullable=False),
|
||||||
|
sa.Column('mappings', sa.JSON(), nullable=False),
|
||||||
|
sa.Column('created_at', sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column('updated_at', sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(['owner_user_id'], ['access_users.id'], name=op.f('fk_campaign_recipient_import_mapping_profiles_owner_user_id_access_users'), ondelete='CASCADE'),
|
||||||
|
sa.ForeignKeyConstraint(['tenant_id'], ['core_scopes.id'], name=op.f('fk_campaign_recipient_import_mapping_profiles_tenant_id_scopes'), ondelete='CASCADE'),
|
||||||
|
sa.PrimaryKeyConstraint('id', name=op.f('pk_campaign_recipient_import_mapping_profiles'))
|
||||||
|
)
|
||||||
|
op.create_index(op.f('ix_campaign_recipient_import_mapping_profiles_ordered_header_fingerprint'), 'campaign_recipient_import_mapping_profiles', ['ordered_header_fingerprint'], unique=False)
|
||||||
|
op.create_index(op.f('ix_campaign_recipient_import_mapping_profiles_owner_user_id'), 'campaign_recipient_import_mapping_profiles', ['owner_user_id'], unique=False)
|
||||||
|
op.create_index(op.f('ix_campaign_recipient_import_mapping_profiles_tenant_id'), 'campaign_recipient_import_mapping_profiles', ['tenant_id'], unique=False)
|
||||||
|
op.create_index(op.f('ix_campaign_recipient_import_mapping_profiles_unordered_header_fingerprint'), 'campaign_recipient_import_mapping_profiles', ['unordered_header_fingerprint'], unique=False)
|
||||||
|
op.create_index('ix_recipient_import_profiles_ordered_fp', 'campaign_recipient_import_mapping_profiles', ['tenant_id', 'owner_user_id', 'ordered_header_fingerprint'], unique=False)
|
||||||
|
op.create_index('ix_recipient_import_profiles_owner', 'campaign_recipient_import_mapping_profiles', ['tenant_id', 'owner_user_id'], unique=False)
|
||||||
|
op.create_index('ix_recipient_import_profiles_unordered_fp', 'campaign_recipient_import_mapping_profiles', ['tenant_id', 'owner_user_id', 'unordered_header_fingerprint'], unique=False)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
op.drop_table('campaign_recipient_import_mapping_profiles')
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"""add durable IMAP append claim and attempt idempotency
|
||||||
|
|
||||||
|
Revision ID: 3c4d5e6f8192
|
||||||
|
Revises: 2c3d4e5f7081
|
||||||
|
Create Date: 2026-07-21 00:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "3c4d5e6f8192"
|
||||||
|
down_revision = "2c3d4e5f7081"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.add_column(sa.Column("imap_claimed_at", sa.DateTime(timezone=True), nullable=True))
|
||||||
|
batch.add_column(sa.Column("imap_claim_token", sa.String(length=36), nullable=True))
|
||||||
|
batch.create_index("ix_campaign_jobs_imap_claim_token", ["imap_claim_token"], unique=False)
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.add_column(sa.Column("claim_token", sa.String(length=36), nullable=True))
|
||||||
|
_renumber_attempts()
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.create_unique_constraint(
|
||||||
|
"uq_imap_append_attempts_job_attempt",
|
||||||
|
["job_id", "attempt_number"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("imap_append_attempts") as batch:
|
||||||
|
batch.drop_constraint("uq_imap_append_attempts_job_attempt", type_="unique")
|
||||||
|
batch.drop_column("claim_token")
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.drop_index("ix_campaign_jobs_imap_claim_token")
|
||||||
|
batch.drop_column("imap_claim_token")
|
||||||
|
batch.drop_column("imap_claimed_at")
|
||||||
|
|
||||||
|
|
||||||
|
def _renumber_attempts() -> None:
|
||||||
|
"""Make historical attempt numbers unique per job before constraining them."""
|
||||||
|
|
||||||
|
bind = op.get_bind()
|
||||||
|
rows = list(
|
||||||
|
bind.execute(
|
||||||
|
sa.text(
|
||||||
|
"SELECT id, job_id FROM imap_append_attempts "
|
||||||
|
"ORDER BY job_id, created_at, id"
|
||||||
|
)
|
||||||
|
).mappings()
|
||||||
|
)
|
||||||
|
per_job: dict[str, int] = {}
|
||||||
|
for row in rows:
|
||||||
|
job_id = str(row["job_id"])
|
||||||
|
attempt_number = per_job.get(job_id, 0) + 1
|
||||||
|
per_job[job_id] = attempt_number
|
||||||
|
bind.execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE imap_append_attempts SET attempt_number = :attempt_number "
|
||||||
|
"WHERE id = :attempt_id"
|
||||||
|
),
|
||||||
|
{"attempt_number": attempt_number, "attempt_id": row["id"]},
|
||||||
|
)
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
"""seal each campaign delivery job's immutable execution input
|
||||||
|
|
||||||
|
Revision ID: 4d5e6f7a9203
|
||||||
|
Revises: 3c4d5e6f8192
|
||||||
|
Create Date: 2026-07-21 00:00:01.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "4d5e6f7a9203"
|
||||||
|
down_revision = "3c4d5e6f8192"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.add_column(sa.Column("execution_input_sha256", sa.String(length=64), nullable=True))
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_jobs") as batch:
|
||||||
|
batch.drop_column("execution_input_sha256")
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
"""persist the selected Campaign delivery mode
|
||||||
|
|
||||||
|
Revision ID: c7a2f91e4b60
|
||||||
|
Revises: 4d5e6f7a9203
|
||||||
|
Create Date: 2026-07-22 09:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "c7a2f91e4b60"
|
||||||
|
down_revision = "4d5e6f7a9203"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_versions") as batch:
|
||||||
|
batch.add_column(sa.Column("delivery_mode", sa.String(length=30), nullable=True))
|
||||||
|
batch.add_column(sa.Column("delivery_mode_selected_at", sa.DateTime(timezone=True), nullable=True))
|
||||||
|
batch.create_index("ix_campaign_versions_delivery_mode", ["delivery_mode"], unique=False)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
with op.batch_alter_table("campaign_versions") as batch:
|
||||||
|
batch.drop_index("ix_campaign_versions_delivery_mode")
|
||||||
|
batch.drop_column("delivery_mode_selected_at")
|
||||||
|
batch.drop_column("delivery_mode")
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
"""mark untouched excluded jobs as skipped delivery
|
||||||
|
|
||||||
|
Revision ID: d8b3e2c1f4a5
|
||||||
|
Revises: c7a2f91e4b60
|
||||||
|
Create Date: 2026-07-22 11:00:00.000000
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
|
||||||
|
revision = "d8b3e2c1f4a5"
|
||||||
|
down_revision = "c7a2f91e4b60"
|
||||||
|
branch_labels = None
|
||||||
|
depends_on = None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
# Only normalize rows with no recorded transport effect. Unexpected
|
||||||
|
# historical delivery evidence must remain intact for audit/reconciliation.
|
||||||
|
op.get_bind().execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE campaign_jobs "
|
||||||
|
"SET send_status = 'skipped', imap_status = 'skipped' "
|
||||||
|
"WHERE validation_status = 'excluded' "
|
||||||
|
"AND send_status = 'not_queued' "
|
||||||
|
"AND imap_status IN ('not_requested', 'pending', 'skipped')"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
op.get_bind().execute(
|
||||||
|
sa.text(
|
||||||
|
"UPDATE campaign_jobs "
|
||||||
|
"SET send_status = 'not_queued', imap_status = 'not_requested' "
|
||||||
|
"WHERE validation_status = 'excluded' "
|
||||||
|
"AND send_status = 'skipped' "
|
||||||
|
"AND imap_status = 'skipped'"
|
||||||
|
)
|
||||||
|
)
|
||||||
170
src/govoplan_campaign/backend/path_security.py
Normal file
170
src/govoplan_campaign/backend/path_security.py
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import PureWindowsPath
|
||||||
|
from typing import Any, Iterable
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignPathSecurityError(ValueError):
|
||||||
|
"""Raised when server-provided campaign JSON could read local files."""
|
||||||
|
|
||||||
|
|
||||||
|
def _text(value: object) -> str:
|
||||||
|
return value.strip() if isinstance(value, str) else ""
|
||||||
|
|
||||||
|
|
||||||
|
def assert_logical_relative_path(value: object, *, field: str) -> None:
|
||||||
|
raw = _text(value)
|
||||||
|
if not raw:
|
||||||
|
return
|
||||||
|
if "\x00" in raw:
|
||||||
|
raise CampaignPathSecurityError(f"{field} contains a NUL byte")
|
||||||
|
|
||||||
|
normalized = raw.replace("\\", "/")
|
||||||
|
windows_path = PureWindowsPath(raw)
|
||||||
|
if (
|
||||||
|
normalized.startswith("/")
|
||||||
|
or normalized.startswith("~")
|
||||||
|
or windows_path.is_absolute()
|
||||||
|
or bool(windows_path.drive)
|
||||||
|
):
|
||||||
|
raise CampaignPathSecurityError(f"{field} must be a relative managed-file path")
|
||||||
|
if any(part == ".." for part in normalized.split("/")):
|
||||||
|
raise CampaignPathSecurityError(f"{field} must not contain parent-directory traversal")
|
||||||
|
|
||||||
|
|
||||||
|
def is_managed_source(value: object) -> bool:
|
||||||
|
raw = _text(value)
|
||||||
|
if not raw.startswith("managed:"):
|
||||||
|
return False
|
||||||
|
parts = raw.split(":", 2)
|
||||||
|
return len(parts) == 3 and parts[1] in {"user", "group"} and bool(parts[2].strip())
|
||||||
|
|
||||||
|
|
||||||
|
def _attachment_rules(raw_json: dict[str, Any]) -> Iterable[tuple[str, dict[str, Any]]]:
|
||||||
|
attachments = raw_json.get("attachments")
|
||||||
|
if isinstance(attachments, dict):
|
||||||
|
global_rules = attachments.get("global")
|
||||||
|
if isinstance(global_rules, list):
|
||||||
|
for index, rule in enumerate(global_rules):
|
||||||
|
if isinstance(rule, dict):
|
||||||
|
yield f"attachments.global[{index}]", rule
|
||||||
|
|
||||||
|
entries = raw_json.get("entries")
|
||||||
|
inline = entries.get("inline") if isinstance(entries, dict) else None
|
||||||
|
if isinstance(inline, list):
|
||||||
|
for entry_index, entry in enumerate(inline):
|
||||||
|
rules = entry.get("attachments") if isinstance(entry, dict) else None
|
||||||
|
if not isinstance(rules, list):
|
||||||
|
continue
|
||||||
|
for rule_index, rule in enumerate(rules):
|
||||||
|
if isinstance(rule, dict):
|
||||||
|
yield f"entries.inline[{entry_index}].attachments[{rule_index}]", rule
|
||||||
|
defaults = entries.get("defaults") if isinstance(entries, dict) else None
|
||||||
|
default_rules = defaults.get("attachments") if isinstance(defaults, dict) else None
|
||||||
|
if isinstance(default_rules, list):
|
||||||
|
for rule_index, rule in enumerate(default_rules):
|
||||||
|
if isinstance(rule, dict):
|
||||||
|
yield f"entries.defaults.attachments[{rule_index}]", rule
|
||||||
|
|
||||||
|
|
||||||
|
def _assert_inline_server_sources(
|
||||||
|
raw_json: dict[str, Any],
|
||||||
|
*,
|
||||||
|
source_filename: str | None,
|
||||||
|
source_base_path: str | None,
|
||||||
|
) -> None:
|
||||||
|
if _text(source_filename):
|
||||||
|
raise CampaignPathSecurityError("source_filename is not accepted for server-managed campaigns")
|
||||||
|
if _text(source_base_path):
|
||||||
|
raise CampaignPathSecurityError("source_base_path is not accepted for server-managed campaigns")
|
||||||
|
|
||||||
|
template = raw_json.get("template")
|
||||||
|
template_source = template.get("source") if isinstance(template, dict) else None
|
||||||
|
path_fields = ("subject_path", "text_path", "html_path")
|
||||||
|
if isinstance(template_source, dict) and any(_text(template_source.get(key)) for key in path_fields):
|
||||||
|
raise CampaignPathSecurityError(
|
||||||
|
"template source paths are not accepted for server-managed campaigns; store template content inline"
|
||||||
|
)
|
||||||
|
|
||||||
|
entries = raw_json.get("entries")
|
||||||
|
entries_source = entries.get("source") if isinstance(entries, dict) else None
|
||||||
|
if isinstance(entries_source, dict) and _text(entries_source.get("path")):
|
||||||
|
raise CampaignPathSecurityError(
|
||||||
|
"entries.source.path is not accepted for server-managed campaigns; import recipients into the campaign snapshot"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _managed_attachment_base_paths(attachments: dict[str, Any]) -> dict[str, dict[str, Any]]:
|
||||||
|
assert_logical_relative_path(attachments.get("base_path"), field="attachments.base_path")
|
||||||
|
raw_base_paths = attachments.get("base_paths")
|
||||||
|
base_paths = raw_base_paths if isinstance(raw_base_paths, list) else []
|
||||||
|
managed: dict[str, dict[str, Any]] = {}
|
||||||
|
for index, item in enumerate(base_paths):
|
||||||
|
if not isinstance(item, dict):
|
||||||
|
continue
|
||||||
|
assert_logical_relative_path(
|
||||||
|
item.get("path"),
|
||||||
|
field=f"attachments.base_paths[{index}].path",
|
||||||
|
)
|
||||||
|
source_is_managed = is_managed_source(item.get("source"))
|
||||||
|
base_path_id = _text(item.get("id"))
|
||||||
|
if base_path_id and source_is_managed:
|
||||||
|
managed[base_path_id] = item
|
||||||
|
if item.get("unsent_warning") is True and not source_is_managed:
|
||||||
|
raise CampaignPathSecurityError(
|
||||||
|
f"attachments.base_paths[{index}] must use a managed Files source before unsent-file scanning is enabled"
|
||||||
|
)
|
||||||
|
return managed
|
||||||
|
|
||||||
|
|
||||||
|
def _assert_managed_attachment_rules(
|
||||||
|
raw_json: dict[str, Any],
|
||||||
|
*,
|
||||||
|
managed_base_paths: dict[str, dict[str, Any]],
|
||||||
|
managed_files_available: bool,
|
||||||
|
) -> None:
|
||||||
|
rules = list(_attachment_rules(raw_json))
|
||||||
|
if not rules:
|
||||||
|
return
|
||||||
|
if not managed_files_available:
|
||||||
|
raise CampaignPathSecurityError("campaign attachments require the Files module in server mode")
|
||||||
|
|
||||||
|
for field, rule in rules:
|
||||||
|
base_path_id = _text(rule.get("base_path_id"))
|
||||||
|
if not base_path_id or base_path_id not in managed_base_paths:
|
||||||
|
raise CampaignPathSecurityError(
|
||||||
|
f"{field}.base_path_id must select an attachments.base_paths entry backed by managed Files"
|
||||||
|
)
|
||||||
|
assert_logical_relative_path(rule.get("base_dir"), field=f"{field}.base_dir")
|
||||||
|
assert_logical_relative_path(rule.get("file_filter"), field=f"{field}.file_filter")
|
||||||
|
|
||||||
|
|
||||||
|
def assert_server_safe_campaign_paths(
|
||||||
|
raw_json: dict[str, Any],
|
||||||
|
*,
|
||||||
|
source_filename: str | None = None,
|
||||||
|
source_base_path: str | None = None,
|
||||||
|
managed_files_available: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Reject local-file references at the HTTP/server trust boundary.
|
||||||
|
|
||||||
|
File-oriented campaign loading remains available to trusted operator code
|
||||||
|
through the campaign loader and message builder. Persisted/API campaigns
|
||||||
|
must use inline templates and recipients plus managed Files attachment
|
||||||
|
sources, which are materialized into an isolated snapshot before use.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_assert_inline_server_sources(
|
||||||
|
raw_json,
|
||||||
|
source_filename=source_filename,
|
||||||
|
source_base_path=source_base_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
attachments = raw_json.get("attachments")
|
||||||
|
if not isinstance(attachments, dict):
|
||||||
|
return
|
||||||
|
_assert_managed_attachment_rules(
|
||||||
|
raw_json,
|
||||||
|
managed_base_paths=_managed_attachment_base_paths(attachments),
|
||||||
|
managed_files_available=managed_files_available,
|
||||||
|
)
|
||||||
@@ -1,13 +1,14 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import copy
|
||||||
import hashlib
|
import hashlib
|
||||||
import json
|
import json
|
||||||
|
import os
|
||||||
|
from datetime import UTC, datetime
|
||||||
from email import policy
|
from email import policy
|
||||||
from email.parser import BytesParser
|
from email.parser import BytesParser
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
import copy
|
|
||||||
from datetime import UTC, datetime
|
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
|
|
||||||
from sqlalchemy import func
|
from sqlalchemy import func
|
||||||
@@ -25,13 +26,18 @@ from govoplan_campaign.backend.db.models import (
|
|||||||
JobSendStatus,
|
JobSendStatus,
|
||||||
JobValidationStatus,
|
JobValidationStatus,
|
||||||
)
|
)
|
||||||
from govoplan_campaign.backend.campaign.loader import load_campaign_config, load_campaign_json, validate_against_schema
|
from govoplan_campaign.backend.campaign.loader import load_campaign_json, validate_against_schema
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
assert_campaign_uses_mail_profile_reference,
|
||||||
|
campaign_mail_profile_id,
|
||||||
|
)
|
||||||
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
||||||
from govoplan_campaign.backend.messages.builder import build_campaign_messages
|
from govoplan_campaign.backend.messages.builder import build_campaign_messages
|
||||||
from govoplan_campaign.backend.messages.models import MessageDraft
|
from govoplan_campaign.backend.messages.models import MessageDraft
|
||||||
from govoplan_campaign.backend.sending.execution import create_execution_snapshot
|
from govoplan_campaign.backend.sending.execution import create_execution_snapshot, profile_transport_revisions
|
||||||
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
from govoplan_campaign.backend.campaign.models import CampaignConfig, SendStatus
|
||||||
from govoplan_campaign.backend.integrations import files_integration, mail_integration
|
from govoplan_campaign.backend.integrations import files_integration, mail_integration
|
||||||
|
from govoplan_campaign.backend.path_security import assert_server_safe_campaign_paths
|
||||||
|
|
||||||
RUNTIME_DIR = Path(__file__).resolve().parents[3] / "runtime"
|
RUNTIME_DIR = Path(__file__).resolve().parents[3] / "runtime"
|
||||||
CAMPAIGN_SNAPSHOT_DIR = RUNTIME_DIR / "campaign_snapshots"
|
CAMPAIGN_SNAPSHOT_DIR = RUNTIME_DIR / "campaign_snapshots"
|
||||||
@@ -43,8 +49,9 @@ class CampaignPersistenceError(RuntimeError):
|
|||||||
|
|
||||||
|
|
||||||
def _ensure_dirs() -> None:
|
def _ensure_dirs() -> None:
|
||||||
CAMPAIGN_SNAPSHOT_DIR.mkdir(parents=True, exist_ok=True)
|
for directory in (CAMPAIGN_SNAPSHOT_DIR, BUILD_OUTPUT_DIR):
|
||||||
BUILD_OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
|
directory.mkdir(parents=True, mode=0o700, exist_ok=True)
|
||||||
|
directory.chmod(0o700)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -58,22 +65,44 @@ def load_campaign_config_from_json(
|
|||||||
owner_user_id: str | None = None,
|
owner_user_id: str | None = None,
|
||||||
owner_group_id: str | None = None,
|
owner_group_id: str | None = None,
|
||||||
) -> CampaignConfig:
|
) -> CampaignConfig:
|
||||||
materialized = mail_integration().materialize_campaign_mail_profile_config(
|
# Validate the persisted Campaign-to-Mail contract before asking Mail for a
|
||||||
session,
|
# non-secret capability summary. Campaign never receives resolved transport
|
||||||
tenant_id=tenant_id,
|
# settings, account identities, or credentials.
|
||||||
raw_json=raw_json,
|
assert_campaign_uses_mail_profile_reference(raw_json)
|
||||||
campaign_id=campaign_id,
|
validate_against_schema(raw_json)
|
||||||
owner_user_id=owner_user_id,
|
materialized = copy.deepcopy(raw_json)
|
||||||
owner_group_id=owner_group_id,
|
profile_id = campaign_mail_profile_id(raw_json)
|
||||||
)
|
if profile_id:
|
||||||
validate_against_schema(materialized)
|
summary = mail_integration().campaign_profile_delivery_summary(
|
||||||
|
session,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
campaign_id=campaign_id,
|
||||||
|
profile_id=profile_id,
|
||||||
|
owner_user_id=owner_user_id,
|
||||||
|
owner_group_id=owner_group_id,
|
||||||
|
)
|
||||||
|
materialized.setdefault("server", {})["profile_capabilities"] = {
|
||||||
|
"smtp_available": bool(summary.get("smtp_available")),
|
||||||
|
"imap_available": bool(summary.get("imap_available")),
|
||||||
|
}
|
||||||
return CampaignConfig.model_validate(materialized)
|
return CampaignConfig.model_validate(materialized)
|
||||||
|
|
||||||
|
|
||||||
def _write_campaign_snapshot(version: CampaignVersion) -> Path:
|
def _write_campaign_snapshot(version: CampaignVersion) -> Path:
|
||||||
_ensure_dirs()
|
_ensure_dirs()
|
||||||
path = CAMPAIGN_SNAPSHOT_DIR / f"{version.id}.json"
|
path = CAMPAIGN_SNAPSHOT_DIR / f"{version.id}.json"
|
||||||
path.write_text(json.dumps(version.raw_json, ensure_ascii=False, indent=2), encoding="utf-8")
|
flags = os.O_WRONLY | os.O_CREAT | os.O_TRUNC
|
||||||
|
if hasattr(os, "O_NOFOLLOW"):
|
||||||
|
flags |= os.O_NOFOLLOW
|
||||||
|
descriptor = os.open(path, flags, 0o600)
|
||||||
|
try:
|
||||||
|
os.fchmod(descriptor, 0o600)
|
||||||
|
with os.fdopen(descriptor, "w", encoding="utf-8") as stream:
|
||||||
|
descriptor = -1
|
||||||
|
json.dump(version.raw_json, stream, ensure_ascii=False, indent=2)
|
||||||
|
finally:
|
||||||
|
if descriptor >= 0:
|
||||||
|
os.close(descriptor)
|
||||||
return path
|
return path
|
||||||
|
|
||||||
|
|
||||||
@@ -92,13 +121,14 @@ def _resolve_runtime_path(base_path: Path | None, value: str | None) -> str | No
|
|||||||
|
|
||||||
|
|
||||||
def normalize_campaign_paths(raw_json: dict[str, Any], source_base_path: str | Path | None) -> dict[str, Any]:
|
def normalize_campaign_paths(raw_json: dict[str, Any], source_base_path: str | Path | None) -> dict[str, Any]:
|
||||||
"""Return a DB/runtime-safe campaign JSON snapshot.
|
"""Resolve paths for an explicitly trusted, file-oriented import.
|
||||||
|
|
||||||
The CLI naturally resolves relative paths against the campaign.json file.
|
The CLI naturally resolves relative paths against the campaign.json file.
|
||||||
Once the campaign is stored in the database, the JSON snapshot lives in
|
Once the campaign is stored in the database, the JSON snapshot lives in
|
||||||
app/mailer/runtime/campaign_snapshots. To keep existing file-based
|
app/mailer/runtime/campaign_snapshots. To keep existing file-based
|
||||||
campaigns working, relative file paths are normalized to absolute paths at
|
campaigns working, relative file paths are normalized to absolute paths at
|
||||||
import time when a source_base_path is known.
|
import time when a source_base_path is known. HTTP/API callers are rejected
|
||||||
|
by ``assert_server_safe_campaign_paths`` before they can reach this helper.
|
||||||
"""
|
"""
|
||||||
base = Path(source_base_path).expanduser().resolve() if source_base_path else None
|
base = Path(source_base_path).expanduser().resolve() if source_base_path else None
|
||||||
data = copy.deepcopy(raw_json)
|
data = copy.deepcopy(raw_json)
|
||||||
@@ -127,7 +157,14 @@ def create_campaign_version_from_json(
|
|||||||
raw_json: dict[str, Any],
|
raw_json: dict[str, Any],
|
||||||
source_filename: str | None = None,
|
source_filename: str | None = None,
|
||||||
source_base_path: str | None = None,
|
source_base_path: str | None = None,
|
||||||
|
commit: bool = True,
|
||||||
) -> tuple[Campaign, CampaignVersion]:
|
) -> tuple[Campaign, CampaignVersion]:
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw_json,
|
||||||
|
source_filename=source_filename,
|
||||||
|
source_base_path=source_base_path,
|
||||||
|
managed_files_available=files_integration().available,
|
||||||
|
)
|
||||||
if source_base_path is None and source_filename:
|
if source_base_path is None and source_filename:
|
||||||
source_path = Path(source_filename).expanduser()
|
source_path = Path(source_filename).expanduser()
|
||||||
source_base_path = str(source_path.parent if source_path.suffix else source_path)
|
source_base_path = str(source_path.parent if source_path.suffix else source_path)
|
||||||
@@ -175,8 +212,11 @@ def create_campaign_version_from_json(
|
|||||||
session.flush()
|
session.flush()
|
||||||
campaign.current_version_id = version.id
|
campaign.current_version_id = version.id
|
||||||
session.add(campaign)
|
session.add(campaign)
|
||||||
_write_campaign_snapshot(version)
|
if commit:
|
||||||
session.commit()
|
_write_campaign_snapshot(version)
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return campaign, version
|
return campaign, version
|
||||||
|
|
||||||
|
|
||||||
@@ -235,8 +275,12 @@ def load_version_config(session: Session, version_id: str):
|
|||||||
campaign = session.get(Campaign, version.campaign_id)
|
campaign = session.get(Campaign, version.campaign_id)
|
||||||
if not campaign:
|
if not campaign:
|
||||||
raise CampaignPersistenceError(f"Campaign not found for version: {version_id}")
|
raise CampaignPersistenceError(f"Campaign not found for version: {version_id}")
|
||||||
path = _write_campaign_snapshot(version)
|
|
||||||
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw_json,
|
||||||
|
managed_files_available=files_integration().available,
|
||||||
|
)
|
||||||
|
path = _write_campaign_snapshot(version)
|
||||||
return version, path, load_campaign_config_from_json(session, tenant_id=campaign.tenant_id, raw_json=raw_json, campaign_id=campaign.id)
|
return version, path, load_campaign_config_from_json(session, tenant_id=campaign.tenant_id, raw_json=raw_json, campaign_id=campaign.id)
|
||||||
|
|
||||||
|
|
||||||
@@ -275,7 +319,7 @@ def validate_campaign_version(
|
|||||||
campaign_id=campaign.id,
|
campaign_id=campaign.id,
|
||||||
raw_json=version.raw_json if isinstance(version.raw_json, dict) else {},
|
raw_json=version.raw_json if isinstance(version.raw_json, dict) else {},
|
||||||
include_bytes=False,
|
include_bytes=False,
|
||||||
prefix="multimailer-managed-validate-",
|
prefix="govoplan-managed-validate-",
|
||||||
) as prepared:
|
) as prepared:
|
||||||
managed_raw = load_campaign_json(prepared.path)
|
managed_raw = load_campaign_json(prepared.path)
|
||||||
managed_config = load_campaign_config_from_json(session, tenant_id=tenant_id, raw_json=managed_raw, campaign_id=campaign.id)
|
managed_config = load_campaign_config_from_json(session, tenant_id=tenant_id, raw_json=managed_raw, campaign_id=campaign.id)
|
||||||
@@ -362,7 +406,11 @@ def _job_from_message(
|
|||||||
build_status=message.build_status.value if hasattr(message.build_status, "value") else str(message.build_status),
|
build_status=message.build_status.value if hasattr(message.build_status, "value") else str(message.build_status),
|
||||||
validation_status=_job_validation_status(message.validation_status.value),
|
validation_status=_job_validation_status(message.validation_status.value),
|
||||||
queue_status=JobQueueStatus.DRAFT.value,
|
queue_status=JobQueueStatus.DRAFT.value,
|
||||||
send_status=JobSendStatus.NOT_QUEUED.value,
|
send_status=(
|
||||||
|
JobSendStatus.SKIPPED.value
|
||||||
|
if message.send_status == SendStatus.SKIPPED
|
||||||
|
else JobSendStatus.NOT_QUEUED.value
|
||||||
|
),
|
||||||
imap_status=message.imap_status.value if hasattr(message.imap_status, "value") else JobImapStatus.NOT_REQUESTED.value,
|
imap_status=message.imap_status.value if hasattr(message.imap_status, "value") else JobImapStatus.NOT_REQUESTED.value,
|
||||||
resolved_recipients={
|
resolved_recipients={
|
||||||
"from": message.from_.model_dump(mode="json") if message.from_ else None,
|
"from": message.from_.model_dump(mode="json") if message.from_ else None,
|
||||||
@@ -407,7 +455,7 @@ def build_campaign_version(
|
|||||||
campaign_id=campaign.id,
|
campaign_id=campaign.id,
|
||||||
raw_json=version.raw_json if isinstance(version.raw_json, dict) else {},
|
raw_json=version.raw_json if isinstance(version.raw_json, dict) else {},
|
||||||
include_bytes=True,
|
include_bytes=True,
|
||||||
prefix="multimailer-managed-build-",
|
prefix="govoplan-managed-build-",
|
||||||
) as prepared:
|
) as prepared:
|
||||||
managed_raw = load_campaign_json(prepared.path)
|
managed_raw = load_campaign_json(prepared.path)
|
||||||
managed_config = load_campaign_config_from_json(session, tenant_id=tenant_id, raw_json=managed_raw, campaign_id=campaign.id)
|
managed_config = load_campaign_config_from_json(session, tenant_id=tenant_id, raw_json=managed_raw, campaign_id=campaign.id)
|
||||||
@@ -460,13 +508,19 @@ def build_campaign_version(
|
|||||||
[job for job, _message in job_build_pairs],
|
[job for job, _message in job_build_pairs],
|
||||||
stage="built",
|
stage="built",
|
||||||
)
|
)
|
||||||
runtime_smtp = managed_config.server.runtime_smtp_config()
|
if not managed_config.server.profile_capabilities.smtp_available:
|
||||||
if not runtime_smtp:
|
raise CampaignPersistenceError("The selected Mail profile has no SMTP configuration; an execution snapshot cannot be created")
|
||||||
raise CampaignPersistenceError("Campaign has no SMTP configuration; an execution snapshot cannot be created")
|
profile_id = campaign_mail_profile_id(version.raw_json if isinstance(version.raw_json, dict) else {})
|
||||||
|
if profile_id is None:
|
||||||
|
raise CampaignPersistenceError("Select an authorized Mail profile before building campaign messages")
|
||||||
|
revisions = profile_transport_revisions(session, version)
|
||||||
|
if not revisions["smtp"]:
|
||||||
|
raise CampaignPersistenceError("The selected Mail profile has no SMTP transport revision")
|
||||||
execution_snapshot, execution_snapshot_hash = create_execution_snapshot(
|
execution_snapshot, execution_snapshot_hash = create_execution_snapshot(
|
||||||
version,
|
version,
|
||||||
smtp=runtime_smtp,
|
mail_profile_id=profile_id,
|
||||||
imap=managed_config.server.runtime_imap_config(),
|
smtp_transport_revision=revisions["smtp"],
|
||||||
|
imap_transport_revision=revisions["imap"],
|
||||||
delivery=managed_config.delivery,
|
delivery=managed_config.delivery,
|
||||||
jobs=[job for job, _message in job_build_pairs],
|
jobs=[job for job, _message in job_build_pairs],
|
||||||
build_summary=report_json,
|
build_summary=report_json,
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
from dataclasses import dataclass, field
|
||||||
from datetime import UTC, datetime
|
from datetime import UTC, datetime
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from uuid import uuid4
|
from uuid import uuid4
|
||||||
@@ -18,19 +19,61 @@ from govoplan_campaign.backend.db.models import (
|
|||||||
JobSendStatus,
|
JobSendStatus,
|
||||||
)
|
)
|
||||||
from govoplan_campaign.backend.sending.execution import clear_execution_snapshot
|
from govoplan_campaign.backend.sending.execution import clear_execution_snapshot
|
||||||
from govoplan_campaign.backend.integrations import mail_integration
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
campaign_editor_state_for_edit,
|
||||||
|
campaign_mail_profile_boundary_violations,
|
||||||
|
campaign_mail_profile_id,
|
||||||
|
assert_campaign_uses_mail_profile_reference,
|
||||||
|
public_campaign_mail_server,
|
||||||
|
validate_campaign_editor_state,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.integrations import files_integration, mail_integration
|
||||||
from govoplan_campaign.backend.persistence.campaigns import (
|
from govoplan_campaign.backend.persistence.campaigns import (
|
||||||
CampaignPersistenceError,
|
CampaignPersistenceError,
|
||||||
_next_version_number,
|
_next_version_number,
|
||||||
_write_campaign_snapshot,
|
_write_campaign_snapshot,
|
||||||
normalize_campaign_paths,
|
normalize_campaign_paths,
|
||||||
)
|
)
|
||||||
|
from govoplan_campaign.backend.path_security import assert_server_safe_campaign_paths
|
||||||
|
|
||||||
|
|
||||||
class LockedCampaignVersionError(CampaignPersistenceError):
|
class LockedCampaignVersionError(CampaignPersistenceError):
|
||||||
"""Raised when a caller tries to edit an immutable campaign version."""
|
"""Raised when a caller tries to edit an immutable campaign version."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(slots=True)
|
||||||
|
class _PartialValidationCollector:
|
||||||
|
section: str | None
|
||||||
|
issues: list[dict[str, Any]] = field(default_factory=list)
|
||||||
|
|
||||||
|
def issue(self, severity: str, section: str, field: str, code: str, message: str) -> None:
|
||||||
|
if self.section is None or self.section == section:
|
||||||
|
self.issues.append({
|
||||||
|
"severity": severity,
|
||||||
|
"section": section,
|
||||||
|
"field": field,
|
||||||
|
"code": code,
|
||||||
|
"message": message,
|
||||||
|
})
|
||||||
|
|
||||||
|
def result(self) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"ok": not any(item["severity"] == "error" for item in self.issues),
|
||||||
|
"section": self.section,
|
||||||
|
"error_count": sum(1 for item in self.issues if item["severity"] == "error"),
|
||||||
|
"warning_count": sum(1 for item in self.issues if item["severity"] == "warning"),
|
||||||
|
"info_count": sum(1 for item in self.issues if item["severity"] == "info"),
|
||||||
|
"issues": self.issues,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _require_campaign(session: Session, campaign_id: str) -> Campaign:
|
||||||
|
campaign = session.get(Campaign, campaign_id)
|
||||||
|
if campaign is None:
|
||||||
|
raise CampaignPersistenceError(f"Campaign not found: {campaign_id}")
|
||||||
|
return campaign
|
||||||
|
|
||||||
|
|
||||||
USER_LOCK_TEMPORARY = "temporary"
|
USER_LOCK_TEMPORARY = "temporary"
|
||||||
USER_LOCK_PERMANENT = "permanent"
|
USER_LOCK_PERMANENT = "permanent"
|
||||||
USER_LOCK_STATES = {USER_LOCK_TEMPORARY, USER_LOCK_PERMANENT}
|
USER_LOCK_STATES = {USER_LOCK_TEMPORARY, USER_LOCK_PERMANENT}
|
||||||
@@ -71,25 +114,7 @@ def minimal_campaign_json(*, external_id: str, name: str, description: str | Non
|
|||||||
},
|
},
|
||||||
"fields": [],
|
"fields": [],
|
||||||
"global_values": {},
|
"global_values": {},
|
||||||
"server": {
|
"server": {},
|
||||||
"inherit_smtp_credentials": True,
|
|
||||||
"inherit_imap_credentials": True,
|
|
||||||
"smtp": {
|
|
||||||
"host": "",
|
|
||||||
"port": 587,
|
|
||||||
"security": "starttls",
|
|
||||||
},
|
|
||||||
"imap": {
|
|
||||||
"host": "",
|
|
||||||
"port": 993,
|
|
||||||
"security": "tls",
|
|
||||||
"sent_folder": "auto",
|
|
||||||
},
|
|
||||||
"credentials": {
|
|
||||||
"smtp": {"username": "", "password": ""},
|
|
||||||
"imap": {"username": "", "password": ""},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"recipients": {
|
"recipients": {
|
||||||
"from": [],
|
"from": [],
|
||||||
"allow_individual_from": False,
|
"allow_individual_from": False,
|
||||||
@@ -124,6 +149,7 @@ def minimal_campaign_json(*, external_id: str, name: str, description: str | Non
|
|||||||
],
|
],
|
||||||
"allow_individual": True,
|
"allow_individual": True,
|
||||||
"send_without_attachments": False,
|
"send_without_attachments": False,
|
||||||
|
"send_without_attachments_behavior": "block",
|
||||||
"global": [],
|
"global": [],
|
||||||
"zip": {"enabled": False, "archives": []},
|
"zip": {"enabled": False, "archives": []},
|
||||||
"missing_behavior": "ask",
|
"missing_behavior": "ask",
|
||||||
@@ -182,6 +208,7 @@ def create_minimal_campaign(
|
|||||||
description: str | None = None,
|
description: str | None = None,
|
||||||
current_flow: str = CampaignVersionFlow.CREATE.value,
|
current_flow: str = CampaignVersionFlow.CREATE.value,
|
||||||
current_step: str = "basics",
|
current_step: str = "basics",
|
||||||
|
commit: bool = True,
|
||||||
) -> tuple[Campaign, CampaignVersion]:
|
) -> tuple[Campaign, CampaignVersion]:
|
||||||
existing = session.query(Campaign).filter(Campaign.tenant_id == tenant_id, Campaign.external_id == external_id).one_or_none()
|
existing = session.query(Campaign).filter(Campaign.tenant_id == tenant_id, Campaign.external_id == external_id).one_or_none()
|
||||||
if existing:
|
if existing:
|
||||||
@@ -215,8 +242,11 @@ def create_minimal_campaign(
|
|||||||
session.flush()
|
session.flush()
|
||||||
campaign.current_version_id = version.id
|
campaign.current_version_id = version.id
|
||||||
session.add(campaign)
|
session.add(campaign)
|
||||||
_write_campaign_snapshot(version)
|
if commit:
|
||||||
session.commit()
|
_write_campaign_snapshot(version)
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return campaign, version
|
return campaign, version
|
||||||
|
|
||||||
|
|
||||||
@@ -311,6 +341,8 @@ def fork_campaign_version_for_edit(
|
|||||||
source_filename: str | None = None,
|
source_filename: str | None = None,
|
||||||
source_base_path: str | None = None,
|
source_base_path: str | None = None,
|
||||||
autosave: bool = True,
|
autosave: bool = True,
|
||||||
|
migrate_legacy_mail_settings: bool = False,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Create the next sole working version from immutable campaign history.
|
"""Create the next sole working version from immutable campaign history.
|
||||||
|
|
||||||
@@ -320,8 +352,7 @@ def fork_campaign_version_for_edit(
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
source = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
source = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
|
|
||||||
if campaign_has_active_working_version(session, campaign):
|
if campaign_has_active_working_version(session, campaign):
|
||||||
current = session.get(CampaignVersion, campaign.current_version_id)
|
current = session.get(CampaignVersion, campaign.current_version_id)
|
||||||
@@ -336,8 +367,24 @@ def fork_campaign_version_for_edit(
|
|||||||
"Create the next working copy from the campaign's current immutable version."
|
"Create the next working copy from the campaign's current immutable version."
|
||||||
)
|
)
|
||||||
|
|
||||||
base_json = raw_json if raw_json is not None else copy.deepcopy(source.raw_json)
|
source_json = source.raw_json if isinstance(source.raw_json, dict) else {}
|
||||||
|
source_requires_mail_migration = bool(campaign_mail_profile_boundary_violations(source_json))
|
||||||
|
if source_requires_mail_migration and not migrate_legacy_mail_settings:
|
||||||
|
raise CampaignPersistenceError(
|
||||||
|
"This version contains legacy campaign-local SMTP/IMAP settings. Create the editable copy from "
|
||||||
|
"the Mail settings migration action so the audit record is preserved and the copy uses a Mail profile."
|
||||||
|
)
|
||||||
|
base_json = raw_json if raw_json is not None else copy.deepcopy(source_json)
|
||||||
|
if source_requires_mail_migration and raw_json is None:
|
||||||
|
base_json["server"] = public_campaign_mail_server(source_json)
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
base_json,
|
||||||
|
source_filename=source_filename,
|
||||||
|
source_base_path=source_base_path,
|
||||||
|
managed_files_available=files_integration().available,
|
||||||
|
)
|
||||||
runtime_json = normalize_campaign_paths(base_json, source_base_path) if source_base_path else copy.deepcopy(base_json)
|
runtime_json = normalize_campaign_paths(base_json, source_base_path) if source_base_path else copy.deepcopy(base_json)
|
||||||
|
assert_campaign_uses_mail_profile_reference(runtime_json)
|
||||||
mail_integration().assert_campaign_mail_policy_allows_json(session, tenant_id=tenant_id, raw_json=runtime_json, campaign_id=campaign.id)
|
mail_integration().assert_campaign_mail_policy_allows_json(session, tenant_id=tenant_id, raw_json=runtime_json, campaign_id=campaign.id)
|
||||||
|
|
||||||
new_version = CampaignVersion(
|
new_version = CampaignVersion(
|
||||||
@@ -351,7 +398,11 @@ def fork_campaign_version_for_edit(
|
|||||||
current_flow=current_flow if current_flow is not None else (source.current_flow or CampaignVersionFlow.MANUAL.value),
|
current_flow=current_flow if current_flow is not None else (source.current_flow or CampaignVersionFlow.MANUAL.value),
|
||||||
current_step=current_step if current_step is not None else source.current_step,
|
current_step=current_step if current_step is not None else source.current_step,
|
||||||
is_complete=False,
|
is_complete=False,
|
||||||
editor_state=editor_state if editor_state is not None else copy.deepcopy(source.editor_state or {}),
|
editor_state=(
|
||||||
|
validate_campaign_editor_state(editor_state)
|
||||||
|
if editor_state is not None
|
||||||
|
else campaign_editor_state_for_edit(source.editor_state)
|
||||||
|
),
|
||||||
autosaved_at=datetime.now(UTC) if autosave else None,
|
autosaved_at=datetime.now(UTC) if autosave else None,
|
||||||
)
|
)
|
||||||
session.add(new_version)
|
session.add(new_version)
|
||||||
@@ -361,8 +412,11 @@ def fork_campaign_version_for_edit(
|
|||||||
campaign.current_version_id = new_version.id
|
campaign.current_version_id = new_version.id
|
||||||
campaign.status = CampaignStatus.DRAFT.value
|
campaign.status = CampaignStatus.DRAFT.value
|
||||||
session.add(campaign)
|
session.add(campaign)
|
||||||
_write_campaign_snapshot(new_version)
|
if commit:
|
||||||
session.commit()
|
_write_campaign_snapshot(new_version)
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return new_version
|
return new_version
|
||||||
|
|
||||||
|
|
||||||
@@ -420,6 +474,7 @@ def unlock_validated_campaign_version(
|
|||||||
tenant_id: str,
|
tenant_id: str,
|
||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str,
|
version_id: str,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Unlock a validation snapshot so it can be edited again.
|
"""Unlock a validation snapshot so it can be edited again.
|
||||||
|
|
||||||
@@ -429,8 +484,7 @@ def unlock_validated_campaign_version(
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
version = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
version = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="unlock")
|
ensure_current_working_version(campaign, version, action="unlock")
|
||||||
|
|
||||||
if is_temporary_user_locked_version(version):
|
if is_temporary_user_locked_version(version):
|
||||||
@@ -470,7 +524,10 @@ def unlock_validated_campaign_version(
|
|||||||
campaign.status = CampaignStatus.DRAFT.value
|
campaign.status = CampaignStatus.DRAFT.value
|
||||||
session.add(version)
|
session.add(version)
|
||||||
session.add(campaign)
|
session.add(campaign)
|
||||||
session.commit()
|
if commit:
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return version
|
return version
|
||||||
|
|
||||||
def update_campaign_version(
|
def update_campaign_version(
|
||||||
@@ -488,10 +545,18 @@ def update_campaign_version(
|
|||||||
source_filename: str | None = None,
|
source_filename: str | None = None,
|
||||||
source_base_path: str | None = None,
|
source_base_path: str | None = None,
|
||||||
autosave: bool = False,
|
autosave: bool = False,
|
||||||
|
migrate_legacy_mail_settings: bool = False,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
|
if raw_json is not None or source_filename is not None or source_base_path is not None:
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw_json if raw_json is not None else {},
|
||||||
|
source_filename=source_filename,
|
||||||
|
source_base_path=source_base_path,
|
||||||
|
managed_files_available=files_integration().available,
|
||||||
|
)
|
||||||
version = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
version = get_campaign_version_for_tenant(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version_id)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="edit")
|
ensure_current_working_version(campaign, version, action="edit")
|
||||||
|
|
||||||
if is_version_locked(version):
|
if is_version_locked(version):
|
||||||
@@ -501,6 +566,18 @@ def update_campaign_version(
|
|||||||
|
|
||||||
if raw_json is not None:
|
if raw_json is not None:
|
||||||
runtime_json = normalize_campaign_paths(raw_json, source_base_path) if source_base_path else copy.deepcopy(raw_json)
|
runtime_json = normalize_campaign_paths(raw_json, source_base_path) if source_base_path else copy.deepcopy(raw_json)
|
||||||
|
if campaign_mail_profile_boundary_violations(version.raw_json) and not migrate_legacy_mail_settings:
|
||||||
|
raise CampaignPersistenceError(
|
||||||
|
"This version contains legacy campaign-local SMTP/IMAP settings. Select an authorized Mail "
|
||||||
|
"profile on the Mail settings page and explicitly save the migration; the stored legacy version "
|
||||||
|
"will not be changed automatically."
|
||||||
|
)
|
||||||
|
assert_campaign_uses_mail_profile_reference(runtime_json)
|
||||||
|
if campaign_mail_profile_boundary_violations(version.raw_json) and campaign_mail_profile_id(runtime_json) is None:
|
||||||
|
raise CampaignPersistenceError(
|
||||||
|
"Migrating legacy campaign mail settings requires an authorized server.mail_profile_id. "
|
||||||
|
"Select a Mail profile before saving."
|
||||||
|
)
|
||||||
mail_integration().assert_campaign_mail_policy_allows_json(session, tenant_id=tenant_id, raw_json=runtime_json, campaign_id=campaign.id)
|
mail_integration().assert_campaign_mail_policy_allows_json(session, tenant_id=tenant_id, raw_json=runtime_json, campaign_id=campaign.id)
|
||||||
version.raw_json = runtime_json
|
version.raw_json = runtime_json
|
||||||
version.schema_version = str(runtime_json.get("version", version.schema_version or "1.0"))
|
version.schema_version = str(runtime_json.get("version", version.schema_version or "1.0"))
|
||||||
@@ -515,7 +592,7 @@ def update_campaign_version(
|
|||||||
if is_complete is not None:
|
if is_complete is not None:
|
||||||
version.is_complete = is_complete
|
version.is_complete = is_complete
|
||||||
if editor_state is not None:
|
if editor_state is not None:
|
||||||
version.editor_state = editor_state
|
version.editor_state = validate_campaign_editor_state(editor_state)
|
||||||
if source_filename is not None:
|
if source_filename is not None:
|
||||||
version.source_filename = source_filename
|
version.source_filename = source_filename
|
||||||
if source_base_path is not None:
|
if source_base_path is not None:
|
||||||
@@ -538,8 +615,11 @@ def update_campaign_version(
|
|||||||
session.add(version)
|
session.add(version)
|
||||||
session.add(campaign)
|
session.add(campaign)
|
||||||
session.flush()
|
session.flush()
|
||||||
_write_campaign_snapshot(version)
|
if commit:
|
||||||
session.commit()
|
_write_campaign_snapshot(version)
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
@@ -552,6 +632,7 @@ def update_campaign_review_state(
|
|||||||
inspection_complete: bool,
|
inspection_complete: bool,
|
||||||
reviewed_message_keys: list[str],
|
reviewed_message_keys: list[str],
|
||||||
user_id: str | None,
|
user_id: str | None,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Persist review acknowledgement without mutating the locked campaign data.
|
"""Persist review acknowledgement without mutating the locked campaign data.
|
||||||
|
|
||||||
@@ -566,64 +647,98 @@ def update_campaign_review_state(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version_id,
|
version_id=version_id,
|
||||||
)
|
)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="record review state for")
|
ensure_current_working_version(campaign, version, action="record review state for")
|
||||||
if is_version_final_locked(version):
|
if is_version_final_locked(version):
|
||||||
raise LockedCampaignVersionError("Delivery has started; message review state can no longer be changed.")
|
raise LockedCampaignVersionError("Delivery has started; message review state can no longer be changed.")
|
||||||
|
build_token = _campaign_review_build_token(version)
|
||||||
|
normalized_reviewed = list(dict.fromkeys(str(value) for value in reviewed_message_keys if str(value).strip()))
|
||||||
|
if inspection_complete:
|
||||||
|
normalized_reviewed = _complete_campaign_review_keys(session, version, normalized_reviewed)
|
||||||
|
_write_campaign_review_state(
|
||||||
|
version,
|
||||||
|
build_token=build_token,
|
||||||
|
inspection_complete=inspection_complete,
|
||||||
|
reviewed_message_keys=normalized_reviewed,
|
||||||
|
user_id=user_id,
|
||||||
|
)
|
||||||
|
session.add(version)
|
||||||
|
if commit:
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_review_build_token(version: CampaignVersion) -> str:
|
||||||
build_summary = version.build_summary if isinstance(version.build_summary, dict) else {}
|
build_summary = version.build_summary if isinstance(version.build_summary, dict) else {}
|
||||||
if not build_summary:
|
if not build_summary:
|
||||||
raise CampaignPersistenceError("Build messages before recording review state.")
|
raise CampaignPersistenceError("Build messages before recording review state.")
|
||||||
build_token = str(build_summary.get("build_token") or build_summary.get("built_at") or "").strip()
|
build_token = str(build_summary.get("build_token") or build_summary.get("built_at") or "").strip()
|
||||||
if not build_token:
|
if build_token:
|
||||||
# Backwards-compatible upgrade for build summaries created before
|
return build_token
|
||||||
# review-state tokens were introduced.
|
build_token = uuid4().hex
|
||||||
build_token = uuid4().hex
|
updated_summary = copy.deepcopy(build_summary)
|
||||||
build_summary = copy.deepcopy(build_summary)
|
updated_summary["build_token"] = build_token
|
||||||
build_summary["build_token"] = build_token
|
version.build_summary = updated_summary
|
||||||
version.build_summary = build_summary
|
return build_token
|
||||||
|
|
||||||
normalized_reviewed = list(dict.fromkeys(str(value) for value in reviewed_message_keys if str(value).strip()))
|
|
||||||
if inspection_complete:
|
def _complete_campaign_review_keys(
|
||||||
jobs = (
|
session: Session,
|
||||||
session.query(CampaignJob)
|
version: CampaignVersion,
|
||||||
.filter(CampaignJob.campaign_version_id == version.id)
|
reviewed_message_keys: list[str],
|
||||||
.order_by(CampaignJob.entry_index.asc())
|
) -> list[str]:
|
||||||
.all()
|
jobs = (
|
||||||
|
session.query(CampaignJob)
|
||||||
|
.filter(CampaignJob.campaign_version_id == version.id)
|
||||||
|
.order_by(CampaignJob.entry_index.asc())
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
blocking = [job for job in jobs if job.build_status != "built" or job.validation_status == "blocked"]
|
||||||
|
if blocking:
|
||||||
|
raise CampaignPersistenceError("Blocked or failed messages must be resolved before review can be completed.")
|
||||||
|
missing = sorted(_required_review_keys(jobs) - set(reviewed_message_keys))
|
||||||
|
if missing:
|
||||||
|
raise CampaignPersistenceError(
|
||||||
|
"Messages requiring an explicit decision must be opened before review can be completed: " + ", ".join(missing)
|
||||||
)
|
)
|
||||||
blocking = [job for job in jobs if job.build_status != "built" or job.validation_status == "blocked"]
|
return list(dict.fromkeys([*reviewed_message_keys, *_bulk_acceptable_review_keys(jobs)]))
|
||||||
if blocking:
|
|
||||||
raise CampaignPersistenceError("Blocked or failed messages must be resolved before review can be completed.")
|
|
||||||
reviewed = set(normalized_reviewed)
|
|
||||||
explicit = {
|
|
||||||
str(job.entry_id or job.entry_index)
|
|
||||||
for job in jobs
|
|
||||||
if job.validation_status == "needs_review"
|
|
||||||
}
|
|
||||||
missing = sorted(explicit - reviewed)
|
|
||||||
if missing:
|
|
||||||
raise CampaignPersistenceError(
|
|
||||||
"Messages requiring an explicit decision must be opened before review can be completed: " + ", ".join(missing)
|
|
||||||
)
|
|
||||||
bulk_acceptable = [
|
|
||||||
str(job.entry_id or job.entry_index)
|
|
||||||
for job in jobs
|
|
||||||
if job.validation_status in {"warning", "excluded"}
|
|
||||||
]
|
|
||||||
normalized_reviewed = list(dict.fromkeys([*normalized_reviewed, *bulk_acceptable]))
|
|
||||||
|
|
||||||
|
|
||||||
|
def _required_review_keys(jobs: list[CampaignJob]) -> set[str]:
|
||||||
|
return {
|
||||||
|
str(job.entry_id or job.entry_index)
|
||||||
|
for job in jobs
|
||||||
|
if job.validation_status == "needs_review"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _bulk_acceptable_review_keys(jobs: list[CampaignJob]) -> list[str]:
|
||||||
|
return [
|
||||||
|
str(job.entry_id or job.entry_index)
|
||||||
|
for job in jobs
|
||||||
|
if job.validation_status in {"warning", "excluded"}
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def _write_campaign_review_state(
|
||||||
|
version: CampaignVersion,
|
||||||
|
*,
|
||||||
|
build_token: str,
|
||||||
|
inspection_complete: bool,
|
||||||
|
reviewed_message_keys: list[str],
|
||||||
|
user_id: str | None,
|
||||||
|
) -> None:
|
||||||
editor_state = copy.deepcopy(version.editor_state or {})
|
editor_state = copy.deepcopy(version.editor_state or {})
|
||||||
editor_state["review_send"] = {
|
editor_state["review_send"] = {
|
||||||
"build_token": build_token,
|
"build_token": build_token,
|
||||||
"inspection_complete": bool(inspection_complete),
|
"inspection_complete": bool(inspection_complete),
|
||||||
"reviewed_message_keys": normalized_reviewed,
|
"reviewed_message_keys": reviewed_message_keys,
|
||||||
"updated_at": datetime.now(UTC).isoformat(),
|
"updated_at": datetime.now(UTC).isoformat(),
|
||||||
"updated_by_user_id": user_id,
|
"updated_by_user_id": user_id,
|
||||||
}
|
}
|
||||||
version.editor_state = editor_state
|
version.editor_state = editor_state
|
||||||
session.add(version)
|
|
||||||
session.commit()
|
|
||||||
return version
|
|
||||||
|
|
||||||
|
|
||||||
def lock_campaign_version_temporarily(
|
def lock_campaign_version_temporarily(
|
||||||
@@ -633,6 +748,7 @@ def lock_campaign_version_temporarily(
|
|||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str,
|
version_id: str,
|
||||||
user_id: str | None,
|
user_id: str | None,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Apply a reversible user-requested lock without changing workflow state."""
|
"""Apply a reversible user-requested lock without changing workflow state."""
|
||||||
|
|
||||||
@@ -642,8 +758,7 @@ def lock_campaign_version_temporarily(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version_id,
|
version_id=version_id,
|
||||||
)
|
)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="lock")
|
ensure_current_working_version(campaign, version, action="lock")
|
||||||
if is_version_final_locked(version):
|
if is_version_final_locked(version):
|
||||||
raise LockedCampaignVersionError("Delivery/final versions are permanently locked and cannot receive a temporary user lock.")
|
raise LockedCampaignVersionError("Delivery/final versions are permanently locked and cannot receive a temporary user lock.")
|
||||||
@@ -658,7 +773,10 @@ def lock_campaign_version_temporarily(
|
|||||||
version.user_locked_at = datetime.now(UTC)
|
version.user_locked_at = datetime.now(UTC)
|
||||||
version.user_locked_by_user_id = user_id
|
version.user_locked_by_user_id = user_id
|
||||||
session.add(version)
|
session.add(version)
|
||||||
session.commit()
|
if commit:
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
@@ -668,6 +786,7 @@ def unlock_user_locked_campaign_version(
|
|||||||
tenant_id: str,
|
tenant_id: str,
|
||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str,
|
version_id: str,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Remove a reversible user lock without invalidating campaign data."""
|
"""Remove a reversible user lock without invalidating campaign data."""
|
||||||
|
|
||||||
@@ -677,8 +796,7 @@ def unlock_user_locked_campaign_version(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version_id,
|
version_id=version_id,
|
||||||
)
|
)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="unlock")
|
ensure_current_working_version(campaign, version, action="unlock")
|
||||||
state = campaign_version_user_lock_state(version)
|
state = campaign_version_user_lock_state(version)
|
||||||
if state == USER_LOCK_PERMANENT:
|
if state == USER_LOCK_PERMANENT:
|
||||||
@@ -692,7 +810,10 @@ def unlock_user_locked_campaign_version(
|
|||||||
version.user_locked_at = None
|
version.user_locked_at = None
|
||||||
version.user_locked_by_user_id = None
|
version.user_locked_by_user_id = None
|
||||||
session.add(version)
|
session.add(version)
|
||||||
session.commit()
|
if commit:
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
@@ -703,6 +824,7 @@ def permanently_lock_campaign_version(
|
|||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str,
|
version_id: str,
|
||||||
user_id: str | None,
|
user_id: str | None,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Apply an irreversible user lock.
|
"""Apply an irreversible user lock.
|
||||||
|
|
||||||
@@ -716,8 +838,7 @@ def permanently_lock_campaign_version(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version_id,
|
version_id=version_id,
|
||||||
)
|
)
|
||||||
campaign = session.get(Campaign, campaign_id)
|
campaign = _require_campaign(session, campaign_id)
|
||||||
assert campaign is not None
|
|
||||||
ensure_current_working_version(campaign, version, action="lock permanently")
|
ensure_current_working_version(campaign, version, action="lock permanently")
|
||||||
if is_version_final_locked(version):
|
if is_version_final_locked(version):
|
||||||
raise LockedCampaignVersionError("This version is already permanently locked by its delivery/final state.")
|
raise LockedCampaignVersionError("This version is already permanently locked by its delivery/final state.")
|
||||||
@@ -731,7 +852,10 @@ def permanently_lock_campaign_version(
|
|||||||
# Retain published_at as a compatibility marker for existing integrations.
|
# Retain published_at as a compatibility marker for existing integrations.
|
||||||
version.published_at = version.published_at or now
|
version.published_at = version.published_at or now
|
||||||
session.add(version)
|
session.add(version)
|
||||||
session.commit()
|
if commit:
|
||||||
|
session.commit()
|
||||||
|
else:
|
||||||
|
session.flush()
|
||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
@@ -742,6 +866,7 @@ def publish_campaign_version(
|
|||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str,
|
version_id: str,
|
||||||
user_id: str | None = None,
|
user_id: str | None = None,
|
||||||
|
commit: bool = True,
|
||||||
) -> CampaignVersion:
|
) -> CampaignVersion:
|
||||||
"""Backwards-compatible alias for the permanent user lock."""
|
"""Backwards-compatible alias for the permanent user lock."""
|
||||||
|
|
||||||
@@ -751,6 +876,7 @@ def publish_campaign_version(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version_id,
|
version_id=version_id,
|
||||||
user_id=user_id,
|
user_id=user_id,
|
||||||
|
commit=commit,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -761,79 +887,122 @@ def validate_campaign_partial(raw_json: dict[str, Any], *, section: str | None =
|
|||||||
lets the WebUI autosave and validate one wizard step at a time.
|
lets the WebUI autosave and validate one wizard step at a time.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
issues: list[dict[str, Any]] = []
|
collector = _PartialValidationCollector(section=section)
|
||||||
|
_validate_partial_basics(collector, _dict_value(raw_json, "campaign"))
|
||||||
|
recipients = _dict_value(raw_json, "recipients")
|
||||||
|
_validate_partial_sender(collector, recipients)
|
||||||
|
_validate_partial_mail_profile(collector, raw_json)
|
||||||
|
_validate_partial_recipients(collector, _dict_value(raw_json, "entries"))
|
||||||
|
_validate_partial_template(collector, _dict_value(raw_json, "template"))
|
||||||
|
_validate_partial_attachments(collector, _dict_value(raw_json, "attachments"))
|
||||||
|
_validate_partial_delivery(collector, _dict_value(raw_json, "delivery"))
|
||||||
|
return collector.result()
|
||||||
|
|
||||||
def issue(severity: str, sec: str, field: str, code: str, message: str) -> None:
|
|
||||||
if section is None or section == sec:
|
|
||||||
issues.append({
|
|
||||||
"severity": severity,
|
|
||||||
"section": sec,
|
|
||||||
"field": field,
|
|
||||||
"code": code,
|
|
||||||
"message": message,
|
|
||||||
})
|
|
||||||
|
|
||||||
campaign = raw_json.get("campaign") if isinstance(raw_json.get("campaign"), dict) else {}
|
def _dict_value(value: dict[str, Any], key: str) -> dict[str, Any]:
|
||||||
|
candidate = value.get(key)
|
||||||
|
return candidate if isinstance(candidate, dict) else {}
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_basics(collector: _PartialValidationCollector, campaign: dict[str, Any]) -> None:
|
||||||
if not campaign.get("id"):
|
if not campaign.get("id"):
|
||||||
issue("error", "basics", "campaign.id", "missing_campaign_id", "Campaign id is required.")
|
collector.issue("error", "basics", "campaign.id", "missing_campaign_id", "Campaign id is required.")
|
||||||
if not campaign.get("name"):
|
if not campaign.get("name"):
|
||||||
issue("error", "basics", "campaign.name", "missing_campaign_name", "Campaign name is required.")
|
collector.issue("error", "basics", "campaign.name", "missing_campaign_name", "Campaign name is required.")
|
||||||
|
|
||||||
recipients = raw_json.get("recipients") if isinstance(raw_json.get("recipients"), dict) else {}
|
|
||||||
|
def _validate_partial_sender(collector: _PartialValidationCollector, recipients: dict[str, Any]) -> None:
|
||||||
sender = recipients.get("from") if isinstance(recipients.get("from"), dict) else {}
|
sender = recipients.get("from") if isinstance(recipients.get("from"), dict) else {}
|
||||||
if not sender.get("email"):
|
if not sender.get("email"):
|
||||||
issue("warning", "sender", "recipients.from.email", "missing_sender_email", "Sender email is not configured yet.")
|
collector.issue("warning", "sender", "recipients.from.email", "missing_sender_email", "Sender email is not configured yet.")
|
||||||
|
|
||||||
entries = raw_json.get("entries") if isinstance(raw_json.get("entries"), dict) else {}
|
|
||||||
|
def _validate_partial_mail_profile(collector: _PartialValidationCollector, raw_json: dict[str, Any]) -> None:
|
||||||
|
violations = campaign_mail_profile_boundary_violations(raw_json)
|
||||||
|
if violations:
|
||||||
|
collector.issue(
|
||||||
|
"error",
|
||||||
|
"sender",
|
||||||
|
"server",
|
||||||
|
"campaign_local_mail_transport_forbidden",
|
||||||
|
"Campaign-local SMTP/IMAP settings are not supported. Select or migrate to an authorized Mail-module profile.",
|
||||||
|
)
|
||||||
|
elif campaign_mail_profile_id(raw_json) is None:
|
||||||
|
collector.issue(
|
||||||
|
"warning",
|
||||||
|
"sender",
|
||||||
|
"server.mail_profile_id",
|
||||||
|
"missing_mail_profile",
|
||||||
|
"Select an authorized Mail-module profile before validating or delivering this campaign.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_recipients(collector: _PartialValidationCollector, entries: dict[str, Any]) -> None:
|
||||||
has_inline = bool(entries.get("inline"))
|
has_inline = bool(entries.get("inline"))
|
||||||
has_source = isinstance(entries.get("source"), dict)
|
has_source = isinstance(entries.get("source"), dict)
|
||||||
if not has_inline and not has_source:
|
if not has_inline and not has_source:
|
||||||
issue("warning", "recipients", "entries", "missing_recipients", "No inline recipients or external recipient source configured yet.")
|
collector.issue("warning", "recipients", "entries", "missing_recipients", "No inline recipients or external recipient source configured yet.")
|
||||||
if has_source:
|
if has_source and not _entries_source_has_email_mapping(entries):
|
||||||
mapping = entries.get("mapping") if isinstance(entries.get("mapping"), dict) else {}
|
collector.issue("warning", "recipients", "entries.mapping", "missing_email_mapping", "No email field mapping is configured.")
|
||||||
if not any(key in mapping for key in ("to.0.email", "to.email", "email")):
|
|
||||||
issue("warning", "recipients", "entries.mapping", "missing_email_mapping", "No email field mapping is configured.")
|
|
||||||
|
|
||||||
template = raw_json.get("template") if isinstance(raw_json.get("template"), dict) else {}
|
|
||||||
|
def _entries_source_has_email_mapping(entries: dict[str, Any]) -> bool:
|
||||||
|
mapping = entries.get("mapping") if isinstance(entries.get("mapping"), dict) else {}
|
||||||
|
return any(key in mapping for key in ("to.0.email", "to.email", "email"))
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_template(collector: _PartialValidationCollector, template: dict[str, Any]) -> None:
|
||||||
source_template = template.get("source") if isinstance(template.get("source"), dict) else {}
|
source_template = template.get("source") if isinstance(template.get("source"), dict) else {}
|
||||||
if not template.get("subject") and not source_template.get("subject_path"):
|
if not template.get("subject") and not source_template.get("subject_path"):
|
||||||
issue("warning", "template", "template.subject", "missing_subject", "Template subject is empty.")
|
collector.issue("warning", "template", "template.subject", "missing_subject", "Template subject is empty.")
|
||||||
explicit_body_mode = template.get("body_mode") if template.get("body_mode") in {"text", "html", "both"} else None
|
body_state = _partial_template_body_state(template, source_template)
|
||||||
has_text_body = bool(template.get("text")) or bool(source_template.get("text_path"))
|
_validate_partial_template_body(collector, body_state)
|
||||||
has_html_body = bool(template.get("html")) or bool(source_template.get("html_path"))
|
|
||||||
if explicit_body_mode == "text" and not has_text_body:
|
|
||||||
issue("warning", "template", "template.text", "missing_template_text_body", "Template body mode is text only, but no text body is configured.")
|
|
||||||
elif explicit_body_mode == "html" and not has_html_body:
|
|
||||||
issue("warning", "template", "template.html", "missing_template_html_body", "Template body mode is HTML only, but no HTML body is configured.")
|
|
||||||
elif explicit_body_mode == "both":
|
|
||||||
if not has_text_body:
|
|
||||||
issue("warning", "template", "template.text", "missing_template_text_body", "Template body mode is both, but no text body is configured.")
|
|
||||||
if not has_html_body:
|
|
||||||
issue("warning", "template", "template.html", "missing_template_html_body", "Template body mode is both, but no HTML body is configured.")
|
|
||||||
elif not has_text_body and not has_html_body and not source_template:
|
|
||||||
issue("warning", "template", "template", "missing_template_body", "No text, HTML or file-based template body configured yet.")
|
|
||||||
|
|
||||||
attachments = raw_json.get("attachments") if isinstance(raw_json.get("attachments"), dict) else {}
|
|
||||||
|
def _partial_template_body_state(template: dict[str, Any], source_template: dict[str, Any]) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"mode": template.get("body_mode") if template.get("body_mode") in {"text", "html", "both"} else None,
|
||||||
|
"has_text": bool(template.get("text")) or bool(source_template.get("text_path")),
|
||||||
|
"has_html": bool(template.get("html")) or bool(source_template.get("html_path")),
|
||||||
|
"has_source": bool(source_template),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_template_body(collector: _PartialValidationCollector, state: dict[str, Any]) -> None:
|
||||||
|
mode = state["mode"]
|
||||||
|
has_text = bool(state["has_text"])
|
||||||
|
has_html = bool(state["has_html"])
|
||||||
|
if mode == "text" and not has_text:
|
||||||
|
collector.issue("warning", "template", "template.text", "missing_template_text_body", "Template body mode is text only, but no text body is configured.")
|
||||||
|
elif mode == "html" and not has_html:
|
||||||
|
collector.issue("warning", "template", "template.html", "missing_template_html_body", "Template body mode is HTML only, but no HTML body is configured.")
|
||||||
|
elif mode == "both":
|
||||||
|
_validate_partial_dual_body_template(collector, has_text=has_text, has_html=has_html)
|
||||||
|
elif not has_text and not has_html and not state["has_source"]:
|
||||||
|
collector.issue("warning", "template", "template", "missing_template_body", "No text, HTML or file-based template body configured yet.")
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_dual_body_template(collector: _PartialValidationCollector, *, has_text: bool, has_html: bool) -> None:
|
||||||
|
if not has_text:
|
||||||
|
collector.issue("warning", "template", "template.text", "missing_template_text_body", "Template body mode is both, but no text body is configured.")
|
||||||
|
if not has_html:
|
||||||
|
collector.issue("warning", "template", "template.html", "missing_template_html_body", "Template body mode is both, but no HTML body is configured.")
|
||||||
|
|
||||||
|
|
||||||
|
def _validate_partial_attachments(collector: _PartialValidationCollector, attachments: dict[str, Any]) -> None:
|
||||||
base_paths = attachments.get("base_paths") if isinstance(attachments.get("base_paths"), list) else []
|
base_paths = attachments.get("base_paths") if isinstance(attachments.get("base_paths"), list) else []
|
||||||
has_named_base_path = any(isinstance(item, dict) and item.get("path") for item in base_paths)
|
has_named_base_path = any(isinstance(item, dict) and item.get("path") for item in base_paths)
|
||||||
if not has_named_base_path and not attachments.get("base_path"):
|
if not has_named_base_path and not attachments.get("base_path"):
|
||||||
issue("info", "attachments", "attachments.base_path", "missing_attachment_base_path", "Attachment base path is not configured yet.")
|
collector.issue("info", "attachments", "attachments.base_path", "missing_attachment_base_path", "Attachment base path is not configured yet.")
|
||||||
|
|
||||||
delivery = raw_json.get("delivery") if isinstance(raw_json.get("delivery"), dict) else {}
|
|
||||||
|
def _validate_partial_delivery(collector: _PartialValidationCollector, delivery: dict[str, Any]) -> None:
|
||||||
rate_limit = delivery.get("rate_limit") if isinstance(delivery.get("rate_limit"), dict) else {}
|
rate_limit = delivery.get("rate_limit") if isinstance(delivery.get("rate_limit"), dict) else {}
|
||||||
messages_per_minute = rate_limit.get("messages_per_minute")
|
messages_per_minute = rate_limit.get("messages_per_minute")
|
||||||
if messages_per_minute is not None:
|
if messages_per_minute is None:
|
||||||
try:
|
return
|
||||||
if int(messages_per_minute) < 1:
|
try:
|
||||||
issue("error", "send", "delivery.rate_limit.messages_per_minute", "invalid_rate_limit", "Messages per minute must be at least 1.")
|
if int(messages_per_minute) < 1:
|
||||||
except (TypeError, ValueError):
|
collector.issue("error", "send", "delivery.rate_limit.messages_per_minute", "invalid_rate_limit", "Messages per minute must be at least 1.")
|
||||||
issue("error", "send", "delivery.rate_limit.messages_per_minute", "invalid_rate_limit", "Messages per minute must be a number.")
|
except (TypeError, ValueError):
|
||||||
|
collector.issue("error", "send", "delivery.rate_limit.messages_per_minute", "invalid_rate_limit", "Messages per minute must be a number.")
|
||||||
return {
|
|
||||||
"ok": not any(item["severity"] == "error" for item in issues),
|
|
||||||
"section": section,
|
|
||||||
"error_count": sum(1 for item in issues if item["severity"] == "error"),
|
|
||||||
"warning_count": sum(1 for item in issues if item["severity"] == "warning"),
|
|
||||||
"info_count": sum(1 for item in issues if item["severity"] == "info"),
|
|
||||||
"issues": issues,
|
|
||||||
}
|
|
||||||
|
|||||||
109
src/govoplan_campaign/backend/report_privacy_policy.py
Normal file
109
src/govoplan_campaign/backend/report_privacy_policy.py
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Any, Mapping
|
||||||
|
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_core.tenancy.scope import Tenant
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_SMALL_CELL_THRESHOLD = 5
|
||||||
|
MIN_SMALL_CELL_THRESHOLD = 2
|
||||||
|
MAX_SMALL_CELL_THRESHOLD = 100
|
||||||
|
SMALL_CELL_THRESHOLD_ENV = "GOVOPLAN_CAMPAIGN_REPORT_SMALL_CELL_THRESHOLD"
|
||||||
|
CAMPAIGN_REPORT_POLICY_SETTINGS_KEY = "campaign_report_privacy_policy"
|
||||||
|
SMALL_CELL_THRESHOLD_SETTINGS_KEY = "small_cell_threshold"
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignReportPrivacyPolicyError(RuntimeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True, slots=True)
|
||||||
|
class CampaignReportPrivacyPolicy:
|
||||||
|
small_cell_threshold: int
|
||||||
|
source: str
|
||||||
|
deployment_small_cell_threshold: int
|
||||||
|
tenant_small_cell_threshold: int | None = None
|
||||||
|
|
||||||
|
def as_dict(self) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"small_cell_threshold": self.small_cell_threshold,
|
||||||
|
"source": self.source,
|
||||||
|
"deployment_small_cell_threshold": self.deployment_small_cell_threshold,
|
||||||
|
"tenant_small_cell_threshold": self.tenant_small_cell_threshold,
|
||||||
|
"deployment_setting": SMALL_CELL_THRESHOLD_ENV,
|
||||||
|
"tenant_setting": (
|
||||||
|
f"tenant.settings.{CAMPAIGN_REPORT_POLICY_SETTINGS_KEY}."
|
||||||
|
f"{SMALL_CELL_THRESHOLD_SETTINGS_KEY}"
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def effective_campaign_report_privacy_policy(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
environ: Mapping[str, str] | None = None,
|
||||||
|
) -> CampaignReportPrivacyPolicy:
|
||||||
|
env = os.environ if environ is None else environ
|
||||||
|
deployment_raw = env.get(SMALL_CELL_THRESHOLD_ENV)
|
||||||
|
deployment_value = _configured_threshold(
|
||||||
|
deployment_raw,
|
||||||
|
source=SMALL_CELL_THRESHOLD_ENV,
|
||||||
|
default=DEFAULT_SMALL_CELL_THRESHOLD,
|
||||||
|
)
|
||||||
|
tenant = session.get(Tenant, tenant_id)
|
||||||
|
tenant_raw = _tenant_threshold_value(tenant.settings if tenant is not None else None)
|
||||||
|
if tenant_raw is None:
|
||||||
|
return CampaignReportPrivacyPolicy(
|
||||||
|
small_cell_threshold=deployment_value,
|
||||||
|
source="deployment" if deployment_raw not in (None, "") else "deployment_default",
|
||||||
|
deployment_small_cell_threshold=deployment_value,
|
||||||
|
)
|
||||||
|
|
||||||
|
tenant_value = _configured_threshold(
|
||||||
|
tenant_raw,
|
||||||
|
source=(
|
||||||
|
f"tenant.settings.{CAMPAIGN_REPORT_POLICY_SETTINGS_KEY}."
|
||||||
|
f"{SMALL_CELL_THRESHOLD_SETTINGS_KEY}"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
effective_value = max(deployment_value, tenant_value)
|
||||||
|
return CampaignReportPrivacyPolicy(
|
||||||
|
small_cell_threshold=effective_value,
|
||||||
|
source="tenant" if tenant_value >= deployment_value else "deployment_floor",
|
||||||
|
deployment_small_cell_threshold=deployment_value,
|
||||||
|
tenant_small_cell_threshold=tenant_value,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _tenant_threshold_value(settings: Mapping[str, Any] | None) -> object | None:
|
||||||
|
if not isinstance(settings, Mapping):
|
||||||
|
return None
|
||||||
|
policy = settings.get(CAMPAIGN_REPORT_POLICY_SETTINGS_KEY)
|
||||||
|
if not isinstance(policy, Mapping):
|
||||||
|
return None
|
||||||
|
return policy.get(SMALL_CELL_THRESHOLD_SETTINGS_KEY)
|
||||||
|
|
||||||
|
|
||||||
|
def _configured_threshold(value: object, *, source: str, default: int | None = None) -> int:
|
||||||
|
if value is None or (isinstance(value, str) and not value.strip()):
|
||||||
|
if default is not None:
|
||||||
|
return default
|
||||||
|
raise CampaignReportPrivacyPolicyError(f"{source} must be configured as an integer")
|
||||||
|
if isinstance(value, bool):
|
||||||
|
raise CampaignReportPrivacyPolicyError(f"{source} must be an integer, not a boolean")
|
||||||
|
try:
|
||||||
|
parsed = int(value)
|
||||||
|
except (TypeError, ValueError) as exc:
|
||||||
|
raise CampaignReportPrivacyPolicyError(f"{source} must be an integer") from exc
|
||||||
|
if str(parsed) != str(value).strip() and not isinstance(value, int):
|
||||||
|
raise CampaignReportPrivacyPolicyError(f"{source} must be an integer")
|
||||||
|
if parsed < MIN_SMALL_CELL_THRESHOLD or parsed > MAX_SMALL_CELL_THRESHOLD:
|
||||||
|
raise CampaignReportPrivacyPolicyError(
|
||||||
|
f"{source} must be between {MIN_SMALL_CELL_THRESHOLD} and {MAX_SMALL_CELL_THRESHOLD}"
|
||||||
|
)
|
||||||
|
return parsed
|
||||||
490
src/govoplan_campaign/backend/reports/aggregate.py
Normal file
490
src/govoplan_campaign/backend/reports/aggregate.py
Normal file
@@ -0,0 +1,490 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections import Counter
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from typing import Literal
|
||||||
|
|
||||||
|
from pydantic import BaseModel, ConfigDict
|
||||||
|
from sqlalchemy import case, func, or_
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign, CampaignJob, CampaignVersion
|
||||||
|
from govoplan_campaign.backend.report_privacy_policy import (
|
||||||
|
CampaignReportPrivacyPolicy,
|
||||||
|
effective_campaign_report_privacy_policy,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateCampaignReportError(RuntimeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateReportCampaign(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
id: str
|
||||||
|
name: str
|
||||||
|
status: str
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateReportCampaignListItem(AggregateReportCampaign):
|
||||||
|
updated_at: datetime
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateReportCampaignList(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
campaigns: list[AggregateReportCampaignListItem]
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateCount(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
value: int | None
|
||||||
|
suppressed: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
class AggregatePopulation(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
denominator: AggregateCount
|
||||||
|
denominator_definition: str
|
||||||
|
inactive_source_entries: AggregateCount
|
||||||
|
excluded_or_blocked_jobs: AggregateCount
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateOutcomeCounts(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
smtp_accepted: AggregateCount
|
||||||
|
failed: AggregateCount
|
||||||
|
outcome_unknown: AggregateCount
|
||||||
|
queued_or_active: AggregateCount
|
||||||
|
cancelled: AggregateCount
|
||||||
|
excluded: AggregateCount
|
||||||
|
not_attempted: AggregateCount
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateTimeRange(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
first_activity_at: datetime | None
|
||||||
|
last_activity_at: datetime | None
|
||||||
|
suppressed: bool
|
||||||
|
|
||||||
|
|
||||||
|
class AggregatePrivacy(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
small_cell_threshold: int
|
||||||
|
suppression_applied: bool
|
||||||
|
rule: str
|
||||||
|
|
||||||
|
|
||||||
|
class AggregateCampaignReport(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
generated_at: datetime
|
||||||
|
campaign: AggregateReportCampaign
|
||||||
|
version_number: int | None
|
||||||
|
completion_state: Literal[
|
||||||
|
"not_started",
|
||||||
|
"in_progress",
|
||||||
|
"completed",
|
||||||
|
"partially_completed",
|
||||||
|
"incomplete",
|
||||||
|
"outcome_unknown",
|
||||||
|
"suppressed",
|
||||||
|
]
|
||||||
|
population: AggregatePopulation
|
||||||
|
outcomes: AggregateOutcomeCounts
|
||||||
|
time_range: AggregateTimeRange
|
||||||
|
privacy: AggregatePrivacy
|
||||||
|
|
||||||
|
|
||||||
|
_OUTCOME_KEYS = (
|
||||||
|
"smtp_accepted",
|
||||||
|
"failed",
|
||||||
|
"outcome_unknown",
|
||||||
|
"queued_or_active",
|
||||||
|
"cancelled",
|
||||||
|
"excluded",
|
||||||
|
"not_attempted",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def generate_aggregate_campaign_report(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
version_id: str | None = None,
|
||||||
|
) -> AggregateCampaignReport:
|
||||||
|
"""Build the deliberately small, recipient-free Campaign report projection."""
|
||||||
|
|
||||||
|
campaign = _get_campaign(session, tenant_id=tenant_id, campaign_id=campaign_id)
|
||||||
|
version = _selected_version(session, campaign, version_id)
|
||||||
|
facts = _query_aggregate_facts(
|
||||||
|
session,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
version=version,
|
||||||
|
)
|
||||||
|
policy = effective_campaign_report_privacy_policy(session, tenant_id=tenant_id)
|
||||||
|
return _build_aggregate_campaign_report(
|
||||||
|
campaign=campaign,
|
||||||
|
version=version,
|
||||||
|
facts=facts,
|
||||||
|
policy=policy,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_campaign(session: Session, *, tenant_id: str, campaign_id: str) -> Campaign:
|
||||||
|
campaign = (
|
||||||
|
session.query(Campaign)
|
||||||
|
.filter(Campaign.tenant_id == tenant_id, Campaign.id == campaign_id)
|
||||||
|
.one_or_none()
|
||||||
|
)
|
||||||
|
if campaign is None:
|
||||||
|
raise AggregateCampaignReportError("Campaign not found")
|
||||||
|
return campaign
|
||||||
|
|
||||||
|
|
||||||
|
def _selected_version(
|
||||||
|
session: Session,
|
||||||
|
campaign: Campaign,
|
||||||
|
version_id: str | None,
|
||||||
|
) -> CampaignVersion | None:
|
||||||
|
selected_id = version_id or campaign.current_version_id
|
||||||
|
if not selected_id:
|
||||||
|
return None
|
||||||
|
version = session.get(CampaignVersion, selected_id)
|
||||||
|
if version is None or version.campaign_id != campaign.id:
|
||||||
|
raise AggregateCampaignReportError("Campaign version not found")
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
def _query_aggregate_facts(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
) -> _AggregateFacts:
|
||||||
|
if version is None:
|
||||||
|
return _AggregateFacts.empty()
|
||||||
|
|
||||||
|
accepted = CampaignJob.send_status.in_({"smtp_accepted", "sent"})
|
||||||
|
failed = CampaignJob.send_status.in_({"failed_temporary", "failed_permanent"})
|
||||||
|
unknown = CampaignJob.send_status == "outcome_unknown"
|
||||||
|
active = CampaignJob.send_status.in_({"queued", "claimed", "sending"})
|
||||||
|
cancelled = CampaignJob.send_status == "cancelled"
|
||||||
|
excluded = CampaignJob.send_status == "skipped"
|
||||||
|
excluded_or_blocked = or_(
|
||||||
|
CampaignJob.validation_status.in_({"blocked", "excluded", "inactive"}),
|
||||||
|
CampaignJob.build_status != "built",
|
||||||
|
)
|
||||||
|
row = (
|
||||||
|
session.query(
|
||||||
|
func.count(CampaignJob.id).label("denominator"),
|
||||||
|
func.sum(case((accepted, 1), else_=0)).label("smtp_accepted"),
|
||||||
|
func.sum(case((failed, 1), else_=0)).label("failed"),
|
||||||
|
func.sum(case((unknown, 1), else_=0)).label("outcome_unknown"),
|
||||||
|
func.sum(case((active, 1), else_=0)).label("queued_or_active"),
|
||||||
|
func.sum(case((cancelled, 1), else_=0)).label("cancelled"),
|
||||||
|
func.sum(case((excluded, 1), else_=0)).label("excluded"),
|
||||||
|
func.sum(
|
||||||
|
case((or_(accepted, failed, unknown, active, cancelled, excluded), 0), else_=1)
|
||||||
|
).label("not_attempted"),
|
||||||
|
func.sum(case((excluded_or_blocked, 1), else_=0)).label("excluded_or_blocked"),
|
||||||
|
func.min(CampaignJob.queued_at).label("queued_min"),
|
||||||
|
func.max(CampaignJob.queued_at).label("queued_max"),
|
||||||
|
func.min(CampaignJob.smtp_started_at).label("smtp_min"),
|
||||||
|
func.max(CampaignJob.smtp_started_at).label("smtp_max"),
|
||||||
|
func.min(CampaignJob.sent_at).label("sent_min"),
|
||||||
|
func.max(CampaignJob.sent_at).label("sent_max"),
|
||||||
|
func.min(CampaignJob.outcome_unknown_at).label("unknown_min"),
|
||||||
|
func.max(CampaignJob.outcome_unknown_at).label("unknown_max"),
|
||||||
|
)
|
||||||
|
.filter(
|
||||||
|
CampaignJob.tenant_id == tenant_id,
|
||||||
|
CampaignJob.campaign_id == campaign_id,
|
||||||
|
CampaignJob.campaign_version_id == version.id,
|
||||||
|
)
|
||||||
|
.one()
|
||||||
|
)
|
||||||
|
values = row._mapping
|
||||||
|
activity = [
|
||||||
|
values[key]
|
||||||
|
for key in (
|
||||||
|
"queued_min",
|
||||||
|
"queued_max",
|
||||||
|
"smtp_min",
|
||||||
|
"smtp_max",
|
||||||
|
"sent_min",
|
||||||
|
"sent_max",
|
||||||
|
"unknown_min",
|
||||||
|
"unknown_max",
|
||||||
|
)
|
||||||
|
if values[key] is not None
|
||||||
|
]
|
||||||
|
return _AggregateFacts(
|
||||||
|
outcomes={key: int(values[key] or 0) for key in _OUTCOME_KEYS},
|
||||||
|
denominator=int(values["denominator"] or 0),
|
||||||
|
excluded_or_blocked=int(values["excluded_or_blocked"] or 0),
|
||||||
|
first_activity_at=min(activity) if activity else None,
|
||||||
|
last_activity_at=max(activity) if activity else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def build_aggregate_campaign_report(
|
||||||
|
*,
|
||||||
|
campaign: Campaign,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
jobs: list[CampaignJob],
|
||||||
|
policy: CampaignReportPrivacyPolicy,
|
||||||
|
generated_at: datetime | None = None,
|
||||||
|
) -> AggregateCampaignReport:
|
||||||
|
return _build_aggregate_campaign_report(
|
||||||
|
campaign=campaign,
|
||||||
|
version=version,
|
||||||
|
facts=_facts_from_jobs(jobs),
|
||||||
|
policy=policy,
|
||||||
|
generated_at=generated_at,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _build_aggregate_campaign_report(
|
||||||
|
*,
|
||||||
|
campaign: Campaign,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
facts: _AggregateFacts,
|
||||||
|
policy: CampaignReportPrivacyPolicy,
|
||||||
|
generated_at: datetime | None = None,
|
||||||
|
) -> AggregateCampaignReport:
|
||||||
|
outcome_values = facts.outcomes
|
||||||
|
outcomes, denominator = _suppress_partition(
|
||||||
|
outcome_values,
|
||||||
|
threshold=policy.small_cell_threshold,
|
||||||
|
)
|
||||||
|
outcome_suppression_applied = denominator.suppressed or any(
|
||||||
|
item.suppressed for item in outcomes.values()
|
||||||
|
)
|
||||||
|
inactive_entries = _inactive_entry_count(version)
|
||||||
|
standalone_counts = {
|
||||||
|
"inactive_source_entries": _suppress_standalone_count(
|
||||||
|
inactive_entries,
|
||||||
|
threshold=policy.small_cell_threshold,
|
||||||
|
),
|
||||||
|
# This population count overlaps the outcome partition, so exposing it
|
||||||
|
# can make a suppressed outcome recoverable through subtraction.
|
||||||
|
"excluded_or_blocked_jobs": (
|
||||||
|
AggregateCount(value=None, suppressed=True)
|
||||||
|
if outcome_suppression_applied
|
||||||
|
else _suppress_standalone_count(
|
||||||
|
facts.excluded_or_blocked,
|
||||||
|
threshold=policy.small_cell_threshold,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
}
|
||||||
|
suppression_applied = denominator.suppressed or any(
|
||||||
|
item.suppressed for item in (*outcomes.values(), *standalone_counts.values())
|
||||||
|
)
|
||||||
|
first_activity = facts.first_activity_at
|
||||||
|
last_activity = facts.last_activity_at
|
||||||
|
suppress_time_range = suppression_applied or (
|
||||||
|
0 < facts.denominator < policy.small_cell_threshold
|
||||||
|
)
|
||||||
|
|
||||||
|
return AggregateCampaignReport(
|
||||||
|
generated_at=generated_at or datetime.now(timezone.utc),
|
||||||
|
campaign=AggregateReportCampaign(
|
||||||
|
id=campaign.id,
|
||||||
|
name=campaign.name,
|
||||||
|
status=campaign.status,
|
||||||
|
),
|
||||||
|
version_number=version.version_number if version else None,
|
||||||
|
completion_state=(
|
||||||
|
"suppressed"
|
||||||
|
if denominator.suppressed
|
||||||
|
else _completion_state(outcome_values, facts.denominator)
|
||||||
|
),
|
||||||
|
population=AggregatePopulation(
|
||||||
|
denominator=denominator,
|
||||||
|
denominator_definition=(
|
||||||
|
"All persisted recipient delivery jobs for the selected campaign version, "
|
||||||
|
"including excluded or blocked jobs. Inactive source entries without a job "
|
||||||
|
"record are excluded and reported separately."
|
||||||
|
),
|
||||||
|
inactive_source_entries=standalone_counts["inactive_source_entries"],
|
||||||
|
excluded_or_blocked_jobs=standalone_counts["excluded_or_blocked_jobs"],
|
||||||
|
),
|
||||||
|
outcomes=AggregateOutcomeCounts(**outcomes),
|
||||||
|
time_range=AggregateTimeRange(
|
||||||
|
first_activity_at=None if suppress_time_range else first_activity,
|
||||||
|
last_activity_at=None if suppress_time_range else last_activity,
|
||||||
|
suppressed=suppress_time_range and first_activity is not None,
|
||||||
|
),
|
||||||
|
privacy=AggregatePrivacy(
|
||||||
|
small_cell_threshold=policy.small_cell_threshold,
|
||||||
|
suppression_applied=suppression_applied,
|
||||||
|
rule=(
|
||||||
|
"Positive counts below the threshold are hidden. At least one additional "
|
||||||
|
"count or the denominator is hidden when needed to prevent subtraction. "
|
||||||
|
"Overlapping population counts are hidden whenever outcome suppression applies."
|
||||||
|
),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def aggregate_report_campaign_item(campaign: Campaign) -> AggregateReportCampaignListItem:
|
||||||
|
return AggregateReportCampaignListItem(
|
||||||
|
id=campaign.id,
|
||||||
|
name=campaign.name,
|
||||||
|
status=campaign.status,
|
||||||
|
updated_at=campaign.updated_at,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _outcome_counts(jobs: list[CampaignJob]) -> dict[str, int]:
|
||||||
|
counts: Counter[str] = Counter()
|
||||||
|
for job in jobs:
|
||||||
|
status = job.send_status
|
||||||
|
if status in {"smtp_accepted", "sent"}:
|
||||||
|
counts["smtp_accepted"] += 1
|
||||||
|
elif status in {"failed_temporary", "failed_permanent"}:
|
||||||
|
counts["failed"] += 1
|
||||||
|
elif status == "outcome_unknown":
|
||||||
|
counts["outcome_unknown"] += 1
|
||||||
|
elif status in {"queued", "claimed", "sending"}:
|
||||||
|
counts["queued_or_active"] += 1
|
||||||
|
elif status == "cancelled":
|
||||||
|
counts["cancelled"] += 1
|
||||||
|
elif status == "skipped":
|
||||||
|
counts["excluded"] += 1
|
||||||
|
else:
|
||||||
|
counts["not_attempted"] += 1
|
||||||
|
return {key: counts[key] for key in _OUTCOME_KEYS}
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True, slots=True)
|
||||||
|
class _AggregateFacts:
|
||||||
|
outcomes: dict[str, int]
|
||||||
|
denominator: int
|
||||||
|
excluded_or_blocked: int
|
||||||
|
first_activity_at: datetime | None
|
||||||
|
last_activity_at: datetime | None
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def empty(cls) -> _AggregateFacts:
|
||||||
|
return cls(
|
||||||
|
outcomes={key: 0 for key in _OUTCOME_KEYS},
|
||||||
|
denominator=0,
|
||||||
|
excluded_or_blocked=0,
|
||||||
|
first_activity_at=None,
|
||||||
|
last_activity_at=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _facts_from_jobs(jobs: list[CampaignJob]) -> _AggregateFacts:
|
||||||
|
first_activity, last_activity = _activity_range(jobs)
|
||||||
|
return _AggregateFacts(
|
||||||
|
outcomes=_outcome_counts(jobs),
|
||||||
|
denominator=len(jobs),
|
||||||
|
excluded_or_blocked=sum(
|
||||||
|
1
|
||||||
|
for job in jobs
|
||||||
|
if job.validation_status in {"blocked", "excluded", "inactive"}
|
||||||
|
or job.build_status != "built"
|
||||||
|
),
|
||||||
|
first_activity_at=first_activity,
|
||||||
|
last_activity_at=last_activity,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _suppress_partition(
|
||||||
|
counts: dict[str, int],
|
||||||
|
*,
|
||||||
|
threshold: int,
|
||||||
|
) -> tuple[dict[str, AggregateCount], AggregateCount]:
|
||||||
|
total = sum(counts.values())
|
||||||
|
suppressed = {key for key, value in counts.items() if 0 < value < threshold}
|
||||||
|
suppress_denominator = False
|
||||||
|
if suppressed:
|
||||||
|
companions = [
|
||||||
|
(value, key)
|
||||||
|
for key, value in counts.items()
|
||||||
|
if key not in suppressed and value > 0
|
||||||
|
]
|
||||||
|
if companions:
|
||||||
|
suppressed.add(max(companions)[1])
|
||||||
|
else:
|
||||||
|
suppress_denominator = True
|
||||||
|
denominator = AggregateCount(
|
||||||
|
value=None if suppress_denominator else total,
|
||||||
|
suppressed=suppress_denominator,
|
||||||
|
)
|
||||||
|
return (
|
||||||
|
{
|
||||||
|
key: AggregateCount(
|
||||||
|
value=None if key in suppressed else value,
|
||||||
|
suppressed=key in suppressed,
|
||||||
|
)
|
||||||
|
for key, value in counts.items()
|
||||||
|
},
|
||||||
|
denominator,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _suppress_standalone_count(value: int, *, threshold: int) -> AggregateCount:
|
||||||
|
if 0 < value < threshold:
|
||||||
|
return AggregateCount(value=None, suppressed=True)
|
||||||
|
return AggregateCount(value=value, suppressed=False)
|
||||||
|
|
||||||
|
|
||||||
|
def _completion_state(
|
||||||
|
counts: dict[str, int],
|
||||||
|
total: int,
|
||||||
|
) -> Literal[
|
||||||
|
"not_started",
|
||||||
|
"in_progress",
|
||||||
|
"completed",
|
||||||
|
"partially_completed",
|
||||||
|
"incomplete",
|
||||||
|
"outcome_unknown",
|
||||||
|
]:
|
||||||
|
if total == 0 or counts["not_attempted"] + counts["excluded"] == total:
|
||||||
|
return "not_started"
|
||||||
|
if counts["outcome_unknown"]:
|
||||||
|
return "outcome_unknown"
|
||||||
|
if counts["queued_or_active"]:
|
||||||
|
return "in_progress"
|
||||||
|
accepted = counts["smtp_accepted"]
|
||||||
|
if accepted == total:
|
||||||
|
return "completed"
|
||||||
|
if accepted:
|
||||||
|
return "partially_completed"
|
||||||
|
return "incomplete"
|
||||||
|
|
||||||
|
|
||||||
|
def _activity_range(jobs: list[CampaignJob]) -> tuple[datetime | None, datetime | None]:
|
||||||
|
activity = [
|
||||||
|
value
|
||||||
|
for job in jobs
|
||||||
|
for value in (
|
||||||
|
job.queued_at,
|
||||||
|
job.smtp_started_at,
|
||||||
|
job.sent_at,
|
||||||
|
job.outcome_unknown_at,
|
||||||
|
)
|
||||||
|
if value is not None
|
||||||
|
]
|
||||||
|
if not activity:
|
||||||
|
return None, None
|
||||||
|
return min(activity), max(activity)
|
||||||
|
|
||||||
|
|
||||||
|
def _inactive_entry_count(version: CampaignVersion | None) -> int:
|
||||||
|
build_summary = version.build_summary if version and isinstance(version.build_summary, dict) else {}
|
||||||
|
return int(build_summary.get("inactive_count") or build_summary.get("inactive_entries_count") or 0)
|
||||||
@@ -2,6 +2,7 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import csv
|
import csv
|
||||||
import io
|
import io
|
||||||
|
import logging
|
||||||
import math
|
import math
|
||||||
from collections import Counter
|
from collections import Counter
|
||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
@@ -20,12 +21,20 @@ from govoplan_campaign.backend.db.models import (
|
|||||||
SendAttempt,
|
SendAttempt,
|
||||||
)
|
)
|
||||||
from govoplan_campaign.backend.sending.execution import ExecutionSnapshot
|
from govoplan_campaign.backend.sending.execution import ExecutionSnapshot
|
||||||
|
from govoplan_campaign.backend.response_security import (
|
||||||
|
public_campaign_payload,
|
||||||
|
public_delivery_result_message,
|
||||||
|
public_source_filename,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class CampaignReportError(RuntimeError):
|
class CampaignReportError(RuntimeError):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _utcnow_iso() -> str:
|
def _utcnow_iso() -> str:
|
||||||
return datetime.now(timezone.utc).isoformat()
|
return datetime.now(timezone.utc).isoformat()
|
||||||
|
|
||||||
@@ -55,23 +64,42 @@ def _selected_version(
|
|||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
def _version_info(version: CampaignVersion | None) -> dict[str, Any] | None:
|
def _version_info(
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
*,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
|
) -> dict[str, Any] | None:
|
||||||
if not version:
|
if not version:
|
||||||
return None
|
return None
|
||||||
return {
|
return {
|
||||||
"id": version.id,
|
"id": version.id,
|
||||||
"version_number": version.version_number,
|
"version_number": version.version_number,
|
||||||
"schema_version": version.schema_version,
|
"schema_version": version.schema_version,
|
||||||
"source_filename": version.source_filename,
|
"source_filename": public_source_filename(version.source_filename),
|
||||||
"created_at": version.created_at.isoformat() if version.created_at else None,
|
"created_at": version.created_at.isoformat() if version.created_at else None,
|
||||||
"validation_summary": version.validation_summary,
|
"validation_summary": public_campaign_payload(
|
||||||
"build_summary": version.build_summary,
|
version.validation_summary,
|
||||||
|
include_diagnostics=include_diagnostics,
|
||||||
|
),
|
||||||
|
"build_summary": public_campaign_payload(
|
||||||
|
version.build_summary,
|
||||||
|
include_diagnostics=include_diagnostics,
|
||||||
|
),
|
||||||
"execution_snapshot_hash": version.execution_snapshot_hash,
|
"execution_snapshot_hash": version.execution_snapshot_hash,
|
||||||
"execution_snapshot_at": version.execution_snapshot_at.isoformat() if version.execution_snapshot_at else None,
|
"execution_snapshot_at": version.execution_snapshot_at.isoformat() if version.execution_snapshot_at else None,
|
||||||
|
"delivery_mode": version.delivery_mode,
|
||||||
|
"delivery_mode_selected_at": (
|
||||||
|
version.delivery_mode_selected_at.isoformat() if version.delivery_mode_selected_at else None
|
||||||
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def _load_delivery_info(version: CampaignVersion | None, jobs: list[CampaignJob]) -> dict[str, Any]:
|
def _load_delivery_info(
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
jobs: list[CampaignJob],
|
||||||
|
*,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
|
) -> dict[str, Any]:
|
||||||
"""Read deterministic delivery settings from the immutable execution snapshot."""
|
"""Read deterministic delivery settings from the immutable execution snapshot."""
|
||||||
|
|
||||||
default = {
|
default = {
|
||||||
@@ -81,25 +109,37 @@ def _load_delivery_info(version: CampaignVersion | None, jobs: list[CampaignJob]
|
|||||||
"execution_snapshot_hash": None,
|
"execution_snapshot_hash": None,
|
||||||
"execution_snapshot_at": None,
|
"execution_snapshot_at": None,
|
||||||
"snapshot_version": None,
|
"snapshot_version": None,
|
||||||
"build_token": None,
|
|
||||||
"built_at": None,
|
"built_at": None,
|
||||||
"job_manifest_sha256": None,
|
|
||||||
"job_count": 0,
|
"job_count": 0,
|
||||||
"queueable_job_count": 0,
|
"queueable_job_count": 0,
|
||||||
"effective_policy_sha256": None,
|
|
||||||
"smtp_config_fingerprint": None,
|
|
||||||
"imap_config_fingerprint": None,
|
|
||||||
"estimated_remaining_send_seconds": None,
|
"estimated_remaining_send_seconds": None,
|
||||||
"estimated_remaining_send_human": None,
|
"estimated_remaining_send_human": None,
|
||||||
"background_workers_enabled": bool(core_settings.celery_enabled),
|
"delivery_mode": getattr(version, "delivery_mode", None) if version else None,
|
||||||
|
"delivery_mode_selected_at": (
|
||||||
|
getattr(version, "delivery_mode_selected_at", None).isoformat()
|
||||||
|
if version and getattr(version, "delivery_mode_selected_at", None)
|
||||||
|
else None
|
||||||
|
),
|
||||||
}
|
}
|
||||||
|
if include_diagnostics:
|
||||||
|
default.update(
|
||||||
|
{
|
||||||
|
"build_token": None, # nosec B105 - absent report value, not a credential.
|
||||||
|
"job_manifest_sha256": None,
|
||||||
|
"effective_policy_sha256": None,
|
||||||
|
"smtp_transport_revision": None,
|
||||||
|
"imap_transport_revision": None,
|
||||||
|
"background_workers_enabled": bool(core_settings.celery_enabled),
|
||||||
|
}
|
||||||
|
)
|
||||||
if not version or not isinstance(version.execution_snapshot, dict):
|
if not version or not isinstance(version.execution_snapshot, dict):
|
||||||
default["load_error"] = "No execution snapshot exists; rebuild the current locked version before delivery."
|
default["load_error"] = "No execution snapshot exists; rebuild the current locked version before delivery."
|
||||||
return default
|
return default
|
||||||
try:
|
try:
|
||||||
snapshot = ExecutionSnapshot.model_validate(version.execution_snapshot)
|
snapshot = ExecutionSnapshot.model_validate(version.execution_snapshot)
|
||||||
except Exception as exc: # pragma: no cover - reporting should remain available
|
except Exception: # pragma: no cover - reporting should remain available
|
||||||
default["load_error"] = str(exc)
|
logger.warning("Campaign execution snapshot could not be loaded for a report")
|
||||||
|
default["load_error"] = "Execution snapshot is invalid; rebuild the selected version before delivery."
|
||||||
return default
|
return default
|
||||||
|
|
||||||
messages_per_minute = snapshot.delivery.rate_limit.messages_per_minute
|
messages_per_minute = snapshot.delivery.rate_limit.messages_per_minute
|
||||||
@@ -108,7 +148,7 @@ def _load_delivery_info(version: CampaignVersion | None, jobs: list[CampaignJob]
|
|||||||
if messages_per_minute and pending:
|
if messages_per_minute and pending:
|
||||||
estimated_seconds = int(math.ceil((len(pending) / messages_per_minute) * 60))
|
estimated_seconds = int(math.ceil((len(pending) / messages_per_minute) * 60))
|
||||||
|
|
||||||
return {
|
result = {
|
||||||
"rate_limit": {
|
"rate_limit": {
|
||||||
"messages_per_minute": messages_per_minute,
|
"messages_per_minute": messages_per_minute,
|
||||||
"concurrency": snapshot.delivery.rate_limit.concurrency,
|
"concurrency": snapshot.delivery.rate_limit.concurrency,
|
||||||
@@ -124,18 +164,28 @@ def _load_delivery_info(version: CampaignVersion | None, jobs: list[CampaignJob]
|
|||||||
"execution_snapshot_hash": version.execution_snapshot_hash,
|
"execution_snapshot_hash": version.execution_snapshot_hash,
|
||||||
"execution_snapshot_at": version.execution_snapshot_at.isoformat() if version.execution_snapshot_at else None,
|
"execution_snapshot_at": version.execution_snapshot_at.isoformat() if version.execution_snapshot_at else None,
|
||||||
"snapshot_version": snapshot.snapshot_version,
|
"snapshot_version": snapshot.snapshot_version,
|
||||||
"build_token": snapshot.build_token,
|
|
||||||
"built_at": snapshot.built_at,
|
"built_at": snapshot.built_at,
|
||||||
"job_manifest_sha256": snapshot.job_manifest_sha256,
|
|
||||||
"job_count": snapshot.job_count,
|
"job_count": snapshot.job_count,
|
||||||
"queueable_job_count": snapshot.queueable_job_count,
|
"queueable_job_count": snapshot.queueable_job_count,
|
||||||
"effective_policy_sha256": snapshot.effective_policy_sha256,
|
|
||||||
"smtp_config_fingerprint": snapshot.smtp_config_fingerprint,
|
|
||||||
"imap_config_fingerprint": snapshot.imap_config_fingerprint,
|
|
||||||
"estimated_remaining_send_seconds": estimated_seconds,
|
"estimated_remaining_send_seconds": estimated_seconds,
|
||||||
"estimated_remaining_send_human": _human_duration(estimated_seconds),
|
"estimated_remaining_send_human": _human_duration(estimated_seconds),
|
||||||
"background_workers_enabled": bool(core_settings.celery_enabled),
|
"delivery_mode": version.delivery_mode,
|
||||||
|
"delivery_mode_selected_at": (
|
||||||
|
version.delivery_mode_selected_at.isoformat() if version.delivery_mode_selected_at else None
|
||||||
|
),
|
||||||
}
|
}
|
||||||
|
if include_diagnostics:
|
||||||
|
result.update(
|
||||||
|
{
|
||||||
|
"build_token": snapshot.build_token,
|
||||||
|
"job_manifest_sha256": snapshot.job_manifest_sha256,
|
||||||
|
"effective_policy_sha256": snapshot.effective_policy_sha256,
|
||||||
|
"smtp_transport_revision": snapshot.smtp_transport_revision,
|
||||||
|
"imap_transport_revision": snapshot.imap_transport_revision,
|
||||||
|
"background_workers_enabled": bool(core_settings.celery_enabled),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
def _human_duration(seconds: int | None) -> str | None:
|
def _human_duration(seconds: int | None) -> str | None:
|
||||||
@@ -222,15 +272,19 @@ def _recent_failures(jobs: list[CampaignJob], *, limit: int = 20) -> list[dict[s
|
|||||||
"send_status": job.send_status,
|
"send_status": job.send_status,
|
||||||
"imap_status": job.imap_status,
|
"imap_status": job.imap_status,
|
||||||
"attempt_count": job.attempt_count,
|
"attempt_count": job.attempt_count,
|
||||||
"last_error": job.last_error,
|
"last_error": public_delivery_result_message(
|
||||||
|
last_error=job.last_error,
|
||||||
|
send_status=job.send_status,
|
||||||
|
imap_status=job.imap_status,
|
||||||
|
),
|
||||||
"updated_at": job.updated_at.isoformat() if job.updated_at else None,
|
"updated_at": job.updated_at.isoformat() if job.updated_at else None,
|
||||||
}
|
}
|
||||||
for job in failed[:limit]
|
for job in failed[:limit]
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def _job_row(job: CampaignJob) -> dict[str, Any]:
|
def _job_row(job: CampaignJob, *, include_diagnostics: bool = False) -> dict[str, Any]:
|
||||||
return {
|
row = {
|
||||||
"job_id": job.id,
|
"job_id": job.id,
|
||||||
"entry_index": job.entry_index,
|
"entry_index": job.entry_index,
|
||||||
"entry_id": job.entry_id,
|
"entry_id": job.entry_id,
|
||||||
@@ -243,17 +297,115 @@ def _job_row(job: CampaignJob) -> dict[str, Any]:
|
|||||||
"imap_status": job.imap_status,
|
"imap_status": job.imap_status,
|
||||||
"attempt_count": job.attempt_count,
|
"attempt_count": job.attempt_count,
|
||||||
"queued_at": job.queued_at.isoformat() if job.queued_at else None,
|
"queued_at": job.queued_at.isoformat() if job.queued_at else None,
|
||||||
"claimed_at": job.claimed_at.isoformat() if job.claimed_at else None,
|
|
||||||
"smtp_started_at": job.smtp_started_at.isoformat() if job.smtp_started_at else None,
|
|
||||||
"outcome_unknown_at": job.outcome_unknown_at.isoformat() if job.outcome_unknown_at else None,
|
"outcome_unknown_at": job.outcome_unknown_at.isoformat() if job.outcome_unknown_at else None,
|
||||||
"sent_at": job.sent_at.isoformat() if job.sent_at else None,
|
"sent_at": job.sent_at.isoformat() if job.sent_at else None,
|
||||||
"last_error": job.last_error,
|
"last_error": public_delivery_result_message(
|
||||||
|
last_error=job.last_error,
|
||||||
|
send_status=job.send_status,
|
||||||
|
imap_status=job.imap_status,
|
||||||
|
),
|
||||||
"eml_size_bytes": job.eml_size_bytes,
|
"eml_size_bytes": job.eml_size_bytes,
|
||||||
"eml_sha256": job.eml_sha256,
|
"eml_sha256": job.eml_sha256,
|
||||||
"issues_count": len(job.issues_snapshot or []),
|
"issues_count": len(job.issues_snapshot or []),
|
||||||
"attachment_config_count": len(job.resolved_attachments or []),
|
"attachment_config_count": len(job.resolved_attachments or []),
|
||||||
"matched_file_count": sum(len(item.get("matches") or []) for item in (job.resolved_attachments or []) if isinstance(item, dict)),
|
"matched_file_count": sum(len(item.get("matches") or []) for item in (job.resolved_attachments or []) if isinstance(item, dict)),
|
||||||
}
|
}
|
||||||
|
if include_diagnostics:
|
||||||
|
row.update(
|
||||||
|
{
|
||||||
|
"claimed_at": job.claimed_at.isoformat() if job.claimed_at else None,
|
||||||
|
"smtp_started_at": job.smtp_started_at.isoformat() if job.smtp_started_at else None,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
return row
|
||||||
|
|
||||||
|
|
||||||
|
def _address_summary(value: Any) -> str:
|
||||||
|
if value is None:
|
||||||
|
return ""
|
||||||
|
if isinstance(value, str):
|
||||||
|
return value
|
||||||
|
if isinstance(value, dict):
|
||||||
|
email = str(value.get("email") or "").strip()
|
||||||
|
name = str(value.get("name") or "").strip()
|
||||||
|
if name and email:
|
||||||
|
return f"{name} <{email}>"
|
||||||
|
return email or name
|
||||||
|
if isinstance(value, list):
|
||||||
|
return "; ".join(item for item in (_address_summary(item) for item in value) if item)
|
||||||
|
return str(value)
|
||||||
|
|
||||||
|
|
||||||
|
def _latest_by_job_id(attempts: list[Any]) -> dict[str, Any]:
|
||||||
|
latest: dict[str, Any] = {}
|
||||||
|
for attempt in attempts:
|
||||||
|
current = latest.get(attempt.job_id)
|
||||||
|
if current is None or (attempt.attempt_number or 0) >= (current.attempt_number or 0):
|
||||||
|
latest[attempt.job_id] = attempt
|
||||||
|
return latest
|
||||||
|
|
||||||
|
|
||||||
|
def _attachment_names(attachments: list[dict[str, Any]] | None) -> str:
|
||||||
|
names: list[str] = []
|
||||||
|
for attachment in attachments or []:
|
||||||
|
if not isinstance(attachment, dict):
|
||||||
|
continue
|
||||||
|
for key in ("message_filenames", "zip_entry_names"):
|
||||||
|
values = attachment.get(key)
|
||||||
|
if isinstance(values, list):
|
||||||
|
names.extend(str(value) for value in values if value)
|
||||||
|
zip_filename = attachment.get("zip_filename")
|
||||||
|
if zip_filename:
|
||||||
|
names.append(str(zip_filename))
|
||||||
|
matches = attachment.get("matches")
|
||||||
|
if isinstance(matches, list):
|
||||||
|
for match in matches:
|
||||||
|
if isinstance(match, dict):
|
||||||
|
filename = match.get("filename") or match.get("name") or match.get("display_name")
|
||||||
|
if filename:
|
||||||
|
names.append(str(filename))
|
||||||
|
elif match:
|
||||||
|
names.append(str(match).rsplit("/", 1)[-1])
|
||||||
|
seen: set[str] = set()
|
||||||
|
deduplicated = []
|
||||||
|
for name in names:
|
||||||
|
if name and name not in seen:
|
||||||
|
seen.add(name)
|
||||||
|
deduplicated.append(name)
|
||||||
|
return "; ".join(deduplicated)
|
||||||
|
|
||||||
|
|
||||||
|
def _job_evidence_row(
|
||||||
|
job: CampaignJob,
|
||||||
|
*,
|
||||||
|
latest_smtp: SendAttempt | None = None,
|
||||||
|
latest_imap: ImapAppendAttempt | None = None,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
row = _job_row(job, include_diagnostics=include_diagnostics)
|
||||||
|
recipients = job.resolved_recipients or {}
|
||||||
|
row.update({
|
||||||
|
"campaign_id": job.campaign_id,
|
||||||
|
"campaign_version_id": job.campaign_version_id,
|
||||||
|
"message_id_header": job.message_id_header,
|
||||||
|
"from": _address_summary(recipients.get("from")),
|
||||||
|
"to": _address_summary(recipients.get("to")),
|
||||||
|
"cc": _address_summary(recipients.get("cc")),
|
||||||
|
"bcc": _address_summary(recipients.get("bcc")),
|
||||||
|
"reply_to": _address_summary(recipients.get("reply_to")),
|
||||||
|
"attachment_names": _attachment_names(job.resolved_attachments),
|
||||||
|
"latest_smtp_attempt_number": latest_smtp.attempt_number if latest_smtp else None,
|
||||||
|
"latest_smtp_status": latest_smtp.status if latest_smtp else None,
|
||||||
|
"latest_smtp_status_code": latest_smtp.smtp_status_code if latest_smtp else None,
|
||||||
|
"latest_smtp_started_at": latest_smtp.started_at.isoformat() if latest_smtp and latest_smtp.started_at else None,
|
||||||
|
"latest_smtp_finished_at": latest_smtp.finished_at.isoformat() if latest_smtp and latest_smtp.finished_at else None,
|
||||||
|
"latest_imap_attempt_number": latest_imap.attempt_number if latest_imap else None,
|
||||||
|
"latest_imap_status": latest_imap.status if latest_imap else None,
|
||||||
|
"latest_imap_folder": latest_imap.folder if latest_imap else None,
|
||||||
|
"latest_imap_created_at": latest_imap.created_at.isoformat() if latest_imap and latest_imap.created_at else None,
|
||||||
|
"latest_imap_updated_at": latest_imap.updated_at.isoformat() if latest_imap and latest_imap.updated_at else None,
|
||||||
|
})
|
||||||
|
return row
|
||||||
|
|
||||||
|
|
||||||
def generate_campaign_report(
|
def generate_campaign_report(
|
||||||
@@ -263,7 +415,8 @@ def generate_campaign_report(
|
|||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str | None = None,
|
version_id: str | None = None,
|
||||||
include_jobs: bool = False,
|
include_jobs: bool = False,
|
||||||
include_recent_failures: bool = True,
|
include_recent_failures: bool = False,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
) -> dict[str, Any]:
|
) -> dict[str, Any]:
|
||||||
"""Generate a dashboard/report payload for one campaign.
|
"""Generate a dashboard/report payload for one campaign.
|
||||||
|
|
||||||
@@ -274,39 +427,158 @@ def generate_campaign_report(
|
|||||||
|
|
||||||
campaign = _get_campaign(session, tenant_id=tenant_id, campaign_id=campaign_id)
|
campaign = _get_campaign(session, tenant_id=tenant_id, campaign_id=campaign_id)
|
||||||
version = _selected_version(session, campaign, version_id)
|
version = _selected_version(session, campaign, version_id)
|
||||||
|
jobs = _report_jobs(session, tenant_id=tenant_id, campaign_id=campaign.id, version=version)
|
||||||
|
report = _campaign_report_payload(
|
||||||
|
session,
|
||||||
|
campaign=campaign,
|
||||||
|
version=version,
|
||||||
|
jobs=jobs,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
include_recent_failures=include_recent_failures,
|
||||||
|
include_diagnostics=include_diagnostics,
|
||||||
|
)
|
||||||
|
if include_jobs:
|
||||||
|
report["jobs"] = [
|
||||||
|
_job_row(job, include_diagnostics=include_diagnostics)
|
||||||
|
for job in jobs
|
||||||
|
]
|
||||||
|
return report
|
||||||
|
|
||||||
|
|
||||||
|
def _report_jobs(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
) -> list[CampaignJob]:
|
||||||
jobs_query = session.query(CampaignJob).filter(
|
jobs_query = session.query(CampaignJob).filter(
|
||||||
CampaignJob.tenant_id == tenant_id,
|
CampaignJob.tenant_id == tenant_id,
|
||||||
CampaignJob.campaign_id == campaign.id,
|
CampaignJob.campaign_id == campaign_id,
|
||||||
)
|
)
|
||||||
if version:
|
if version:
|
||||||
jobs_query = jobs_query.filter(CampaignJob.campaign_version_id == version.id)
|
jobs_query = jobs_query.filter(CampaignJob.campaign_version_id == version.id)
|
||||||
else:
|
else:
|
||||||
jobs_query = jobs_query.filter(False)
|
jobs_query = jobs_query.filter(False)
|
||||||
jobs = (
|
return jobs_query.order_by(CampaignJob.entry_index.asc()).all()
|
||||||
jobs_query
|
|
||||||
.order_by(CampaignJob.entry_index.asc())
|
|
||||||
.all()
|
def _campaign_report_payload(
|
||||||
)
|
session: Session,
|
||||||
|
*,
|
||||||
|
campaign: Campaign,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
jobs: list[CampaignJob],
|
||||||
|
tenant_id: str,
|
||||||
|
include_recent_failures: bool,
|
||||||
|
include_diagnostics: bool,
|
||||||
|
) -> dict[str, Any]:
|
||||||
job_ids = [job.id for job in jobs]
|
job_ids = [job.id for job in jobs]
|
||||||
send_attempts = session.query(SendAttempt).filter(SendAttempt.job_id.in_(job_ids)).count() if job_ids else 0
|
report = {
|
||||||
imap_attempts = session.query(ImapAppendAttempt).filter(ImapAppendAttempt.job_id.in_(job_ids)).count() if job_ids else 0
|
"generated_at": _utcnow_iso(),
|
||||||
|
"campaign": _campaign_report_campaign_payload(campaign),
|
||||||
|
"current_version": _version_info(version, include_diagnostics=include_diagnostics),
|
||||||
|
"selected_version_id": version.id if version else None,
|
||||||
|
"cards": _campaign_report_cards(version, jobs),
|
||||||
|
"status_counts": _campaign_report_status_counts(version, jobs),
|
||||||
|
"issues": {
|
||||||
|
**_issue_summary_from_jobs(jobs),
|
||||||
|
"persisted_campaign_issue_count": _persisted_campaign_issue_count(
|
||||||
|
session,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
version=version,
|
||||||
|
),
|
||||||
|
},
|
||||||
|
"attachments": _attachment_summary(jobs),
|
||||||
|
"attempts": _campaign_report_attempt_counts(session, job_ids),
|
||||||
|
"delivery": _load_delivery_info(
|
||||||
|
version,
|
||||||
|
jobs,
|
||||||
|
include_diagnostics=include_diagnostics,
|
||||||
|
),
|
||||||
|
}
|
||||||
|
if include_recent_failures:
|
||||||
|
report["recent_failures"] = _recent_failures(jobs)
|
||||||
|
return report
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_report_campaign_payload(campaign: Campaign) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"id": campaign.id,
|
||||||
|
"external_id": campaign.external_id,
|
||||||
|
"name": campaign.name,
|
||||||
|
"description": campaign.description,
|
||||||
|
"status": campaign.status,
|
||||||
|
"created_at": campaign.created_at.isoformat() if campaign.created_at else None,
|
||||||
|
"updated_at": campaign.updated_at.isoformat() if campaign.updated_at else None,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_report_attempt_counts(session: Session, job_ids: list[str]) -> dict[str, int]:
|
||||||
|
return {
|
||||||
|
"send_attempts": int(session.query(SendAttempt).filter(SendAttempt.job_id.in_(job_ids)).count()) if job_ids else 0,
|
||||||
|
"imap_append_attempts": int(session.query(ImapAppendAttempt).filter(ImapAppendAttempt.job_id.in_(job_ids)).count()) if job_ids else 0,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _persisted_campaign_issue_count(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
tenant_id: str,
|
||||||
|
campaign_id: str,
|
||||||
|
version: CampaignVersion | None,
|
||||||
|
) -> int:
|
||||||
issue_query = session.query(CampaignIssue).filter(
|
issue_query = session.query(CampaignIssue).filter(
|
||||||
CampaignIssue.tenant_id == tenant_id,
|
CampaignIssue.tenant_id == tenant_id,
|
||||||
CampaignIssue.campaign_id == campaign.id,
|
CampaignIssue.campaign_id == campaign_id,
|
||||||
)
|
)
|
||||||
if version:
|
if version:
|
||||||
issue_query = issue_query.filter(CampaignIssue.campaign_version_id == version.id)
|
issue_query = issue_query.filter(CampaignIssue.campaign_version_id == version.id)
|
||||||
else:
|
else:
|
||||||
issue_query = issue_query.filter(False)
|
issue_query = issue_query.filter(False)
|
||||||
persisted_issues = issue_query.count()
|
return int(issue_query.count())
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_report_status_counts(version: CampaignVersion | None, jobs: list[CampaignJob]) -> dict[str, dict[str, int]]:
|
||||||
validation_counts = _counter([job.validation_status for job in jobs])
|
validation_counts = _counter([job.validation_status for job in jobs])
|
||||||
queue_counts = _counter([job.queue_status for job in jobs])
|
inactive_entries = _inactive_entry_count(version)
|
||||||
|
if inactive_entries:
|
||||||
|
validation_counts["inactive"] = inactive_entries
|
||||||
|
return {
|
||||||
|
"build": _counter([job.build_status for job in jobs]),
|
||||||
|
"validation": validation_counts,
|
||||||
|
"queue": _counter([job.queue_status for job in jobs]),
|
||||||
|
"send": _counter([job.send_status for job in jobs]),
|
||||||
|
"imap": _counter([job.imap_status for job in jobs]),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_report_cards(version: CampaignVersion | None, jobs: list[CampaignJob]) -> dict[str, object]:
|
||||||
send_counts = _counter([job.send_status for job in jobs])
|
send_counts = _counter([job.send_status for job in jobs])
|
||||||
imap_counts = _counter([job.imap_status for job in jobs])
|
imap_counts = _counter([job.imap_status for job in jobs])
|
||||||
build_counts = _counter([job.build_status for job in jobs])
|
|
||||||
|
|
||||||
queueable = sum(1 for job in jobs if job.validation_status in {"ready", "warning"} and job.build_status == "built")
|
queueable = sum(1 for job in jobs if job.validation_status in {"ready", "warning"} and job.build_status == "built")
|
||||||
|
queueable_unattempted = sum(
|
||||||
|
1
|
||||||
|
for job in jobs
|
||||||
|
if job.attempt_count == 0
|
||||||
|
and job.send_status in {"not_queued", "cancelled"}
|
||||||
|
and job.validation_status in {"ready", "warning"}
|
||||||
|
and job.build_status == "built"
|
||||||
|
)
|
||||||
|
retry_max_attempts = _retry_max_attempts(version)
|
||||||
|
retryable = sum(
|
||||||
|
1
|
||||||
|
for job in jobs
|
||||||
|
if job.send_status == "failed_temporary"
|
||||||
|
and (retry_max_attempts is None or job.attempt_count < retry_max_attempts)
|
||||||
|
)
|
||||||
|
cancellable = sum(
|
||||||
|
1
|
||||||
|
for job in jobs
|
||||||
|
if job.send_status
|
||||||
|
not in {"skipped", "smtp_accepted", "sent", "outcome_unknown", "claimed", "sending", "cancelled"}
|
||||||
|
)
|
||||||
needs_attention = sum(
|
needs_attention = sum(
|
||||||
1
|
1
|
||||||
for job in jobs
|
for job in jobs
|
||||||
@@ -318,65 +590,45 @@ def generate_campaign_report(
|
|||||||
failed = send_counts.get("failed_temporary", 0) + send_counts.get("failed_permanent", 0)
|
failed = send_counts.get("failed_temporary", 0) + send_counts.get("failed_permanent", 0)
|
||||||
outcome_unknown = send_counts.get("outcome_unknown", 0)
|
outcome_unknown = send_counts.get("outcome_unknown", 0)
|
||||||
not_attempted = send_counts.get("not_queued", 0)
|
not_attempted = send_counts.get("not_queued", 0)
|
||||||
|
skipped = send_counts.get("skipped", 0)
|
||||||
queued = send_counts.get("queued", 0) + send_counts.get("claimed", 0) + send_counts.get("sending", 0)
|
queued = send_counts.get("queued", 0) + send_counts.get("claimed", 0) + send_counts.get("sending", 0)
|
||||||
cancelled = send_counts.get("cancelled", 0)
|
cancelled = send_counts.get("cancelled", 0)
|
||||||
build_summary = version.build_summary if version and isinstance(version.build_summary, dict) else {}
|
inactive_entries = _inactive_entry_count(version)
|
||||||
inactive_entries = int(build_summary.get("inactive_count") or build_summary.get("inactive_entries_count") or 0)
|
return {
|
||||||
if inactive_entries:
|
"jobs_total": len(jobs),
|
||||||
validation_counts["inactive"] = inactive_entries
|
"inactive": inactive_entries,
|
||||||
|
"queueable": queueable,
|
||||||
report: dict[str, Any] = {
|
"queueable_unattempted": queueable_unattempted,
|
||||||
"generated_at": _utcnow_iso(),
|
"retryable": retryable,
|
||||||
"campaign": {
|
"cancellable": cancellable,
|
||||||
"id": campaign.id,
|
"needs_attention": needs_attention,
|
||||||
"external_id": campaign.external_id,
|
"sent": sent,
|
||||||
"name": campaign.name,
|
"smtp_accepted": sent,
|
||||||
"description": campaign.description,
|
"failed": failed,
|
||||||
"status": campaign.status,
|
"outcome_unknown": outcome_unknown,
|
||||||
"created_at": campaign.created_at.isoformat() if campaign.created_at else None,
|
"not_attempted": not_attempted,
|
||||||
"updated_at": campaign.updated_at.isoformat() if campaign.updated_at else None,
|
"skipped": skipped,
|
||||||
},
|
"queued_or_active": queued,
|
||||||
"current_version": _version_info(version),
|
"cancelled": cancelled,
|
||||||
"selected_version_id": version.id if version else None,
|
"partially_completed": bool(sent and (failed or outcome_unknown or not_attempted or cancelled)),
|
||||||
"cards": {
|
"imap_appended": imap_counts.get("appended", 0),
|
||||||
"jobs_total": len(jobs),
|
"imap_failed": imap_counts.get("failed", 0),
|
||||||
"inactive": inactive_entries,
|
"imap_skipped": imap_counts.get("skipped", 0),
|
||||||
"queueable": queueable,
|
|
||||||
"needs_attention": needs_attention,
|
|
||||||
"sent": sent,
|
|
||||||
"smtp_accepted": sent,
|
|
||||||
"failed": failed,
|
|
||||||
"outcome_unknown": outcome_unknown,
|
|
||||||
"not_attempted": not_attempted,
|
|
||||||
"queued_or_active": queued,
|
|
||||||
"cancelled": cancelled,
|
|
||||||
"partially_completed": bool(sent and (failed or outcome_unknown or not_attempted or cancelled)),
|
|
||||||
"imap_appended": imap_counts.get("appended", 0),
|
|
||||||
"imap_failed": imap_counts.get("failed", 0),
|
|
||||||
},
|
|
||||||
"status_counts": {
|
|
||||||
"build": build_counts,
|
|
||||||
"validation": validation_counts,
|
|
||||||
"queue": queue_counts,
|
|
||||||
"send": send_counts,
|
|
||||||
"imap": imap_counts,
|
|
||||||
},
|
|
||||||
"issues": {
|
|
||||||
**_issue_summary_from_jobs(jobs),
|
|
||||||
"persisted_campaign_issue_count": persisted_issues,
|
|
||||||
},
|
|
||||||
"attachments": _attachment_summary(jobs),
|
|
||||||
"attempts": {
|
|
||||||
"send_attempts": int(send_attempts),
|
|
||||||
"imap_append_attempts": int(imap_attempts),
|
|
||||||
},
|
|
||||||
"delivery": _load_delivery_info(version, jobs),
|
|
||||||
}
|
}
|
||||||
if include_recent_failures:
|
|
||||||
report["recent_failures"] = _recent_failures(jobs)
|
|
||||||
if include_jobs:
|
def _retry_max_attempts(version: CampaignVersion | None) -> int | None:
|
||||||
report["jobs"] = [_job_row(job) for job in jobs]
|
if version is None or not isinstance(version.execution_snapshot, dict):
|
||||||
return report
|
return None
|
||||||
|
try:
|
||||||
|
return ExecutionSnapshot.model_validate(version.execution_snapshot).delivery.retry.max_attempts
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _inactive_entry_count(version: CampaignVersion | None) -> int:
|
||||||
|
build_summary = version.build_summary if version and isinstance(version.build_summary, dict) else {}
|
||||||
|
return int(build_summary.get("inactive_count") or build_summary.get("inactive_entries_count") or 0)
|
||||||
|
|
||||||
|
|
||||||
def generate_jobs_csv(
|
def generate_jobs_csv(
|
||||||
@@ -385,6 +637,7 @@ def generate_jobs_csv(
|
|||||||
tenant_id: str,
|
tenant_id: str,
|
||||||
campaign_id: str,
|
campaign_id: str,
|
||||||
version_id: str | None = None,
|
version_id: str | None = None,
|
||||||
|
include_diagnostics: bool = False,
|
||||||
) -> str:
|
) -> str:
|
||||||
campaign = _get_campaign(session, tenant_id=tenant_id, campaign_id=campaign_id)
|
campaign = _get_campaign(session, tenant_id=tenant_id, campaign_id=campaign_id)
|
||||||
version = _selected_version(session, campaign, version_id)
|
version = _selected_version(session, campaign, version_id)
|
||||||
@@ -401,13 +654,48 @@ def generate_jobs_csv(
|
|||||||
.order_by(CampaignJob.entry_index.asc())
|
.order_by(CampaignJob.entry_index.asc())
|
||||||
.all()
|
.all()
|
||||||
)
|
)
|
||||||
rows = [_job_row(job) for job in jobs]
|
job_ids = [job.id for job in jobs]
|
||||||
|
smtp_attempts = (
|
||||||
|
session.query(SendAttempt)
|
||||||
|
.filter(SendAttempt.job_id.in_(job_ids))
|
||||||
|
.order_by(SendAttempt.job_id.asc(), SendAttempt.attempt_number.asc())
|
||||||
|
.all()
|
||||||
|
if job_ids
|
||||||
|
else []
|
||||||
|
)
|
||||||
|
imap_attempts = (
|
||||||
|
session.query(ImapAppendAttempt)
|
||||||
|
.filter(ImapAppendAttempt.job_id.in_(job_ids))
|
||||||
|
.order_by(ImapAppendAttempt.job_id.asc(), ImapAppendAttempt.attempt_number.asc())
|
||||||
|
.all()
|
||||||
|
if job_ids
|
||||||
|
else []
|
||||||
|
)
|
||||||
|
latest_smtp = _latest_by_job_id(smtp_attempts)
|
||||||
|
latest_imap = _latest_by_job_id(imap_attempts)
|
||||||
|
rows = [
|
||||||
|
_job_evidence_row(
|
||||||
|
job,
|
||||||
|
latest_smtp=latest_smtp.get(job.id),
|
||||||
|
latest_imap=latest_imap.get(job.id),
|
||||||
|
include_diagnostics=include_diagnostics,
|
||||||
|
)
|
||||||
|
for job in jobs
|
||||||
|
]
|
||||||
fieldnames = [
|
fieldnames = [
|
||||||
"job_id",
|
"job_id",
|
||||||
|
"campaign_id",
|
||||||
|
"campaign_version_id",
|
||||||
"entry_index",
|
"entry_index",
|
||||||
"entry_id",
|
"entry_id",
|
||||||
"recipient_email",
|
"recipient_email",
|
||||||
|
"from",
|
||||||
|
"to",
|
||||||
|
"cc",
|
||||||
|
"bcc",
|
||||||
|
"reply_to",
|
||||||
"subject",
|
"subject",
|
||||||
|
"message_id_header",
|
||||||
"build_status",
|
"build_status",
|
||||||
"validation_status",
|
"validation_status",
|
||||||
"queue_status",
|
"queue_status",
|
||||||
@@ -415,8 +703,6 @@ def generate_jobs_csv(
|
|||||||
"imap_status",
|
"imap_status",
|
||||||
"attempt_count",
|
"attempt_count",
|
||||||
"queued_at",
|
"queued_at",
|
||||||
"claimed_at",
|
|
||||||
"smtp_started_at",
|
|
||||||
"outcome_unknown_at",
|
"outcome_unknown_at",
|
||||||
"sent_at",
|
"sent_at",
|
||||||
"last_error",
|
"last_error",
|
||||||
@@ -425,7 +711,21 @@ def generate_jobs_csv(
|
|||||||
"issues_count",
|
"issues_count",
|
||||||
"attachment_config_count",
|
"attachment_config_count",
|
||||||
"matched_file_count",
|
"matched_file_count",
|
||||||
|
"attachment_names",
|
||||||
|
"latest_smtp_attempt_number",
|
||||||
|
"latest_smtp_status",
|
||||||
|
"latest_smtp_status_code",
|
||||||
|
"latest_smtp_started_at",
|
||||||
|
"latest_smtp_finished_at",
|
||||||
|
"latest_imap_attempt_number",
|
||||||
|
"latest_imap_status",
|
||||||
|
"latest_imap_folder",
|
||||||
|
"latest_imap_created_at",
|
||||||
|
"latest_imap_updated_at",
|
||||||
]
|
]
|
||||||
|
if include_diagnostics:
|
||||||
|
sent_at_index = fieldnames.index("outcome_unknown_at")
|
||||||
|
fieldnames[sent_at_index:sent_at_index] = ["claimed_at", "smtp_started_at"]
|
||||||
buffer = io.StringIO()
|
buffer = io.StringIO()
|
||||||
writer = csv.DictWriter(buffer, fieldnames=fieldnames)
|
writer = csv.DictWriter(buffer, fieldnames=fieldnames)
|
||||||
writer.writeheader()
|
writer.writeheader()
|
||||||
|
|||||||
@@ -9,11 +9,12 @@ from typing import Any
|
|||||||
from sqlalchemy.orm import Session
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
from govoplan_campaign.backend.db.models import Campaign, CampaignVersion
|
from govoplan_campaign.backend.db.models import Campaign, CampaignVersion
|
||||||
from govoplan_campaign.backend.campaign.loader import load_campaign_config
|
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
||||||
from govoplan_campaign.backend.campaign.models import CampaignConfig, SmtpConfig
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import campaign_mail_profile_id
|
||||||
from govoplan_campaign.backend.persistence.campaigns import _write_campaign_snapshot
|
from govoplan_campaign.backend.persistence.campaigns import load_version_config
|
||||||
from govoplan_campaign.backend.reports.campaigns import CampaignReportError, generate_campaign_report, generate_jobs_csv
|
from govoplan_campaign.backend.reports.campaigns import CampaignReportError, generate_campaign_report, generate_jobs_csv
|
||||||
from govoplan_campaign.backend.integrations import SmtpConfigurationError, mail_integration
|
from govoplan_campaign.backend.integrations import SmtpConfigurationError
|
||||||
|
from govoplan_campaign.backend.sending.execution import ExecutionSnapshotError, ensure_execution_snapshot
|
||||||
|
|
||||||
|
|
||||||
class CampaignReportEmailError(RuntimeError):
|
class CampaignReportEmailError(RuntimeError):
|
||||||
@@ -30,8 +31,6 @@ class CampaignReportEmailResult:
|
|||||||
sent: bool
|
sent: bool
|
||||||
attached_jobs_csv: bool
|
attached_jobs_csv: bool
|
||||||
attached_report_json: bool
|
attached_report_json: bool
|
||||||
smtp_host: str | None = None
|
|
||||||
smtp_port: int | None = None
|
|
||||||
accepted_count: int | None = None
|
accepted_count: int | None = None
|
||||||
|
|
||||||
def as_dict(self) -> dict[str, Any]:
|
def as_dict(self) -> dict[str, Any]:
|
||||||
@@ -44,8 +43,6 @@ class CampaignReportEmailResult:
|
|||||||
"sent": self.sent,
|
"sent": self.sent,
|
||||||
"attached_jobs_csv": self.attached_jobs_csv,
|
"attached_jobs_csv": self.attached_jobs_csv,
|
||||||
"attached_report_json": self.attached_report_json,
|
"attached_report_json": self.attached_report_json,
|
||||||
"smtp_host": self.smtp_host,
|
|
||||||
"smtp_port": self.smtp_port,
|
|
||||||
"accepted_count": self.accepted_count,
|
"accepted_count": self.accepted_count,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -62,18 +59,15 @@ def _selected_version(
|
|||||||
return version
|
return version
|
||||||
|
|
||||||
|
|
||||||
def _load_config(version: CampaignVersion) -> CampaignConfig:
|
def _load_config(session: Session, version: CampaignVersion) -> CampaignConfig:
|
||||||
snapshot_path = _write_campaign_snapshot(version)
|
_campaign, _version, config = load_version_config(session, version.id)
|
||||||
return load_campaign_config(snapshot_path)
|
return config
|
||||||
|
|
||||||
|
|
||||||
def _effective_from(config: CampaignConfig) -> tuple[str, str | None]:
|
def _effective_from(config: CampaignConfig) -> tuple[str, str | None]:
|
||||||
if config.recipients.from_:
|
if config.recipients.from_:
|
||||||
return config.recipients.from_[0].email, config.recipients.from_[0].name
|
return config.recipients.from_[0].email, config.recipients.from_[0].name
|
||||||
smtp_config = config.server.runtime_smtp_config()
|
raise SmtpConfigurationError("Report email requires a Campaign-owned recipients.from address")
|
||||||
if smtp_config and smtp_config.username and "@" in smtp_config.username:
|
|
||||||
return smtp_config.username, None
|
|
||||||
raise SmtpConfigurationError("Report email requires a recipients.from address or an SMTP username that is an email address")
|
|
||||||
|
|
||||||
|
|
||||||
def _text_summary(report: dict[str, Any]) -> str:
|
def _text_summary(report: dict[str, Any]) -> str:
|
||||||
@@ -94,8 +88,10 @@ def _text_summary(report: dict[str, Any]) -> str:
|
|||||||
f"- Needs attention: {cards['needs_attention']}",
|
f"- Needs attention: {cards['needs_attention']}",
|
||||||
f"- Sent: {cards['sent']}",
|
f"- Sent: {cards['sent']}",
|
||||||
f"- Failed: {cards['failed']}",
|
f"- Failed: {cards['failed']}",
|
||||||
|
f"- SMTP skipped (excluded): {cards.get('skipped', status.get('send', {}).get('skipped', 0))}",
|
||||||
f"- IMAP appended: {cards['imap_appended']}",
|
f"- IMAP appended: {cards['imap_appended']}",
|
||||||
f"- IMAP failed: {cards['imap_failed']}",
|
f"- IMAP failed: {cards['imap_failed']}",
|
||||||
|
f"- IMAP skipped: {cards.get('imap_skipped', status.get('imap', {}).get('skipped', 0))}",
|
||||||
"",
|
"",
|
||||||
f"Build status: {status.get('build', {})}",
|
f"Build status: {status.get('build', {})}",
|
||||||
f"Validation status: {status.get('validation', {})}",
|
f"Validation status: {status.get('validation', {})}",
|
||||||
@@ -105,7 +101,7 @@ def _text_summary(report: dict[str, Any]) -> str:
|
|||||||
]
|
]
|
||||||
if delivery.get("estimated_remaining_send_human"):
|
if delivery.get("estimated_remaining_send_human"):
|
||||||
lines.extend(["", f"Estimated remaining send time: {delivery['estimated_remaining_send_human']}"])
|
lines.extend(["", f"Estimated remaining send time: {delivery['estimated_remaining_send_human']}"])
|
||||||
lines.extend(["", "This report was generated by MultiMailer."])
|
lines.extend(["", "This report was generated by GovOPlaN."])
|
||||||
return "\n".join(lines)
|
return "\n".join(lines)
|
||||||
|
|
||||||
|
|
||||||
@@ -119,20 +115,20 @@ def build_report_message(
|
|||||||
report_json: dict[str, Any] | None = None,
|
report_json: dict[str, Any] | None = None,
|
||||||
) -> EmailMessage:
|
) -> EmailMessage:
|
||||||
from_email, from_name = _effective_from(config)
|
from_email, from_name = _effective_from(config)
|
||||||
subject = f"MultiMailer report: {campaign.name}"
|
subject = f"GovOPlaN report: {campaign.name}"
|
||||||
|
|
||||||
msg = EmailMessage()
|
msg = EmailMessage()
|
||||||
msg["Subject"] = subject
|
msg["Subject"] = subject
|
||||||
msg["From"] = formataddr((from_name or from_email, from_email))
|
msg["From"] = formataddr((from_name or from_email, from_email))
|
||||||
msg["To"] = ", ".join(to)
|
msg["To"] = ", ".join(to)
|
||||||
msg["X-MultiMailer-Report"] = "campaign"
|
msg["X-GovOPlaN-Report"] = "campaign"
|
||||||
msg.set_content(_text_summary(report))
|
msg.set_content(_text_summary(report))
|
||||||
|
|
||||||
if jobs_csv is not None:
|
if jobs_csv is not None:
|
||||||
filename = f"multimailer-{campaign.external_id}-jobs.csv"
|
filename = f"govoplan-{campaign.external_id}-jobs.csv"
|
||||||
msg.add_attachment(jobs_csv.encode("utf-8"), maintype="text", subtype="csv", filename=filename)
|
msg.add_attachment(jobs_csv.encode("utf-8"), maintype="text", subtype="csv", filename=filename)
|
||||||
if report_json is not None:
|
if report_json is not None:
|
||||||
filename = f"multimailer-{campaign.external_id}-report.json"
|
filename = f"govoplan-{campaign.external_id}-report.json"
|
||||||
msg.add_attachment(
|
msg.add_attachment(
|
||||||
json.dumps(report_json, indent=2, ensure_ascii=False, default=str).encode("utf-8"),
|
json.dumps(report_json, indent=2, ensure_ascii=False, default=str).encode("utf-8"),
|
||||||
maintype="application",
|
maintype="application",
|
||||||
@@ -150,7 +146,7 @@ def send_campaign_report_email(
|
|||||||
version_id: str | None = None,
|
version_id: str | None = None,
|
||||||
to: list[str],
|
to: list[str],
|
||||||
include_jobs: bool = False,
|
include_jobs: bool = False,
|
||||||
attach_jobs_csv: bool = True,
|
attach_jobs_csv: bool = False,
|
||||||
attach_report_json: bool = False,
|
attach_report_json: bool = False,
|
||||||
dry_run: bool = False,
|
dry_run: bool = False,
|
||||||
) -> CampaignReportEmailResult:
|
) -> CampaignReportEmailResult:
|
||||||
@@ -161,10 +157,28 @@ def send_campaign_report_email(
|
|||||||
raise CampaignReportEmailError("At least one report recipient is required")
|
raise CampaignReportEmailError("At least one report recipient is required")
|
||||||
|
|
||||||
version = _selected_version(session, campaign, version_id)
|
version = _selected_version(session, campaign, version_id)
|
||||||
config = _load_config(version)
|
config = _load_config(session, version)
|
||||||
smtp_config: SmtpConfig | None = config.server.runtime_smtp_config()
|
if not config.server.profile_capabilities.smtp_available:
|
||||||
if smtp_config is None:
|
|
||||||
raise SmtpConfigurationError("Campaign has no SMTP configuration")
|
raise SmtpConfigurationError("Campaign has no SMTP configuration")
|
||||||
|
profile_id = campaign_mail_profile_id(version.raw_json if isinstance(version.raw_json, dict) else {})
|
||||||
|
if not profile_id:
|
||||||
|
raise SmtpConfigurationError("Campaign has no Mail profile reference")
|
||||||
|
if not isinstance(version.execution_snapshot, dict):
|
||||||
|
raise CampaignReportEmailError(
|
||||||
|
"Report email requires a validated and built campaign version with stored Mail-profile evidence."
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
snapshot = ensure_execution_snapshot(session, version)
|
||||||
|
except ExecutionSnapshotError as exc:
|
||||||
|
raise CampaignReportEmailError(
|
||||||
|
"Report email requires a validated and built campaign version with current Mail-profile evidence."
|
||||||
|
) from exc
|
||||||
|
if not snapshot.smtp_transport_revision:
|
||||||
|
raise CampaignReportEmailError("Campaign build evidence has no SMTP transport revision")
|
||||||
|
if not dry_run:
|
||||||
|
raise CampaignReportEmailError(
|
||||||
|
"Report email delivery is disabled until it uses a durable, idempotent Mail-owned outbox with unknown-outcome reconciliation."
|
||||||
|
)
|
||||||
|
|
||||||
report = generate_campaign_report(
|
report = generate_campaign_report(
|
||||||
session,
|
session,
|
||||||
@@ -172,6 +186,7 @@ def send_campaign_report_email(
|
|||||||
campaign_id=campaign_id,
|
campaign_id=campaign_id,
|
||||||
version_id=version.id,
|
version_id=version.id,
|
||||||
include_jobs=include_jobs,
|
include_jobs=include_jobs,
|
||||||
|
include_recent_failures=include_jobs,
|
||||||
)
|
)
|
||||||
jobs_csv = (
|
jobs_csv = (
|
||||||
generate_jobs_csv(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version.id)
|
generate_jobs_csv(session, tenant_id=tenant_id, campaign_id=campaign_id, version_id=version.id)
|
||||||
@@ -187,38 +202,13 @@ def send_campaign_report_email(
|
|||||||
jobs_csv=jobs_csv,
|
jobs_csv=jobs_csv,
|
||||||
report_json=report_json,
|
report_json=report_json,
|
||||||
)
|
)
|
||||||
envelope_from, _ = _effective_from(config)
|
|
||||||
|
|
||||||
if dry_run:
|
|
||||||
return CampaignReportEmailResult(
|
|
||||||
campaign_id=campaign.id,
|
|
||||||
version_id=version.id,
|
|
||||||
to=to,
|
|
||||||
subject=str(message["Subject"]),
|
|
||||||
dry_run=True,
|
|
||||||
sent=False,
|
|
||||||
attached_jobs_csv=jobs_csv is not None,
|
|
||||||
attached_report_json=report_json is not None,
|
|
||||||
smtp_host=smtp_config.host,
|
|
||||||
smtp_port=smtp_config.port,
|
|
||||||
)
|
|
||||||
|
|
||||||
result = mail_integration().send_email_message(
|
|
||||||
message,
|
|
||||||
smtp_config=smtp_config,
|
|
||||||
envelope_from=envelope_from,
|
|
||||||
envelope_recipients=to,
|
|
||||||
)
|
|
||||||
return CampaignReportEmailResult(
|
return CampaignReportEmailResult(
|
||||||
campaign_id=campaign.id,
|
campaign_id=campaign.id,
|
||||||
version_id=version.id,
|
version_id=version.id,
|
||||||
to=to,
|
to=to,
|
||||||
subject=str(message["Subject"]),
|
subject=str(message["Subject"]),
|
||||||
dry_run=False,
|
dry_run=True,
|
||||||
sent=True,
|
sent=False,
|
||||||
attached_jobs_csv=jobs_csv is not None,
|
attached_jobs_csv=jobs_csv is not None,
|
||||||
attached_report_json=report_json is not None,
|
attached_report_json=report_json is not None,
|
||||||
smtp_host=result.host,
|
|
||||||
smtp_port=result.port,
|
|
||||||
accepted_count=result.accepted_count,
|
|
||||||
)
|
)
|
||||||
|
|||||||
266
src/govoplan_campaign/backend/response_security.py
Normal file
266
src/govoplan_campaign/backend/response_security.py
Normal file
@@ -0,0 +1,266 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import copy
|
||||||
|
from pathlib import Path, PureWindowsPath
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import public_campaign_mail_server
|
||||||
|
|
||||||
|
|
||||||
|
# These fields locate process-local or storage-backend resources, or authorize
|
||||||
|
# a worker claim. They are useful for tightly controlled diagnostics but are
|
||||||
|
# not part of the campaign business-data contract.
|
||||||
|
CAMPAIGN_INTERNAL_RESPONSE_KEYS = frozenset(
|
||||||
|
{
|
||||||
|
"campaign_file",
|
||||||
|
"claim_token",
|
||||||
|
"eml_local_path",
|
||||||
|
"eml_path",
|
||||||
|
"eml_storage_key",
|
||||||
|
"local_path",
|
||||||
|
"source_base_path",
|
||||||
|
"storage_bucket",
|
||||||
|
"storage_key",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
CAMPAIGN_DIAGNOSTIC_RESPONSE_KEYS = frozenset(
|
||||||
|
{
|
||||||
|
"background_workers_enabled",
|
||||||
|
"build_token",
|
||||||
|
"celery_enabled",
|
||||||
|
"claimed_at",
|
||||||
|
"effective_policy_sha256",
|
||||||
|
"execution_input_sha256",
|
||||||
|
"imap_claimed_at",
|
||||||
|
"imap_transport_revision",
|
||||||
|
"job_manifest_sha256",
|
||||||
|
"smtp_started_at",
|
||||||
|
"smtp_transport_revision",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
_SEND_NOW_RESULT_KEYS = (
|
||||||
|
"campaign_id",
|
||||||
|
"version_id",
|
||||||
|
"attempted_count",
|
||||||
|
"sent_count",
|
||||||
|
"failed_count",
|
||||||
|
"outcome_unknown_count",
|
||||||
|
"skipped_count",
|
||||||
|
"preflight_count",
|
||||||
|
"delivery_mode",
|
||||||
|
"dry_run",
|
||||||
|
)
|
||||||
|
_SEND_NOW_JOB_RESULT_KEYS = (
|
||||||
|
"campaign_id",
|
||||||
|
"version_id",
|
||||||
|
"job_id",
|
||||||
|
"status",
|
||||||
|
"attempt_number",
|
||||||
|
"dry_run",
|
||||||
|
"queued_count",
|
||||||
|
"skipped_count",
|
||||||
|
"blocked_count",
|
||||||
|
"enqueued_count",
|
||||||
|
"delivery_mode",
|
||||||
|
"worker_queue_available",
|
||||||
|
)
|
||||||
|
_SYNCHRONOUS_POLICY_KEYS = (
|
||||||
|
"max_recipient_jobs",
|
||||||
|
"source",
|
||||||
|
"deployment_max_recipient_jobs",
|
||||||
|
"tenant_max_recipient_jobs",
|
||||||
|
)
|
||||||
|
_VALIDATION_SUMMARY_KEYS = ("ok", "error_count", "warning_count")
|
||||||
|
_BUILD_SUMMARY_KEYS = (
|
||||||
|
"built_count",
|
||||||
|
"build_failed_count",
|
||||||
|
"ready_count",
|
||||||
|
"warning_count",
|
||||||
|
"needs_review_count",
|
||||||
|
"blocked_count",
|
||||||
|
"excluded_count",
|
||||||
|
"inactive_count",
|
||||||
|
"queueable_count",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def public_campaign_payload(value: Any, *, include_diagnostics: bool = False) -> Any:
|
||||||
|
"""Return a detached payload without infrastructure-only locators."""
|
||||||
|
|
||||||
|
if isinstance(value, dict):
|
||||||
|
blocked_keys = CAMPAIGN_INTERNAL_RESPONSE_KEYS
|
||||||
|
if not include_diagnostics:
|
||||||
|
blocked_keys = blocked_keys | CAMPAIGN_DIAGNOSTIC_RESPONSE_KEYS
|
||||||
|
return {
|
||||||
|
key: public_campaign_payload(item, include_diagnostics=include_diagnostics)
|
||||||
|
for key, item in value.items()
|
||||||
|
if key not in blocked_keys
|
||||||
|
}
|
||||||
|
if isinstance(value, list):
|
||||||
|
return [public_campaign_payload(item, include_diagnostics=include_diagnostics) for item in value]
|
||||||
|
if isinstance(value, tuple):
|
||||||
|
return tuple(public_campaign_payload(item, include_diagnostics=include_diagnostics) for item in value)
|
||||||
|
return copy.deepcopy(value)
|
||||||
|
|
||||||
|
|
||||||
|
def public_delivery_result_message(
|
||||||
|
*,
|
||||||
|
last_error: Any,
|
||||||
|
send_status: Any,
|
||||||
|
imap_status: Any,
|
||||||
|
) -> str | None:
|
||||||
|
"""Map persisted provider text to a stable business-safe explanation."""
|
||||||
|
|
||||||
|
if not last_error:
|
||||||
|
return None
|
||||||
|
clean_send_status = str(send_status or "")
|
||||||
|
clean_imap_status = str(imap_status or "")
|
||||||
|
if clean_send_status == "outcome_unknown":
|
||||||
|
return "SMTP delivery outcome requires operator reconciliation."
|
||||||
|
if clean_send_status in {"failed_temporary", "failed_permanent"}:
|
||||||
|
return "SMTP delivery failed; an operator can inspect restricted diagnostics."
|
||||||
|
if clean_imap_status in {"outcome_unknown", "appending"}:
|
||||||
|
return "Sent-folder append outcome requires operator reconciliation."
|
||||||
|
if clean_imap_status in {"failed", "skipped"}:
|
||||||
|
return "Sent-folder append did not complete; an operator can inspect restricted diagnostics."
|
||||||
|
return "Delivery recorded a warning; an operator can inspect restricted diagnostics."
|
||||||
|
|
||||||
|
|
||||||
|
def public_send_campaign_now_result(
|
||||||
|
value: dict[str, Any],
|
||||||
|
*,
|
||||||
|
validation_summary: dict[str, Any],
|
||||||
|
build_summary: dict[str, Any],
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Project synchronous delivery into its recipient-authorized public contract.
|
||||||
|
|
||||||
|
Per-job provider messages are deliberately omitted. They can contain SMTP
|
||||||
|
diagnostics or refused envelope addresses and belong only in restricted
|
||||||
|
diagnostics backed by persisted job state.
|
||||||
|
"""
|
||||||
|
|
||||||
|
result = _selected_payload(value, _SEND_NOW_RESULT_KEYS)
|
||||||
|
policy = value.get("synchronous_send_policy")
|
||||||
|
result["synchronous_send_policy"] = _selected_payload(
|
||||||
|
policy if isinstance(policy, dict) else {},
|
||||||
|
_SYNCHRONOUS_POLICY_KEYS,
|
||||||
|
)
|
||||||
|
rows = value.get("results")
|
||||||
|
if isinstance(rows, list):
|
||||||
|
result["results"] = [
|
||||||
|
_selected_payload(row, _SEND_NOW_JOB_RESULT_KEYS)
|
||||||
|
for row in rows
|
||||||
|
if isinstance(row, dict)
|
||||||
|
]
|
||||||
|
else:
|
||||||
|
result["results"] = []
|
||||||
|
result["validation"] = _selected_payload(validation_summary, _VALIDATION_SUMMARY_KEYS)
|
||||||
|
result["build"] = _selected_payload(build_summary, _BUILD_SUMMARY_KEYS)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def send_campaign_now_audit_details(value: dict[str, Any]) -> dict[str, Any]:
|
||||||
|
"""Return aggregate-only evidence for a synchronous Campaign send audit."""
|
||||||
|
|
||||||
|
details = _selected_payload(value, _SEND_NOW_RESULT_KEYS)
|
||||||
|
policy = value.get("synchronous_send_policy")
|
||||||
|
details["synchronous_send_policy"] = _selected_payload(
|
||||||
|
policy if isinstance(policy, dict) else {},
|
||||||
|
_SYNCHRONOUS_POLICY_KEYS,
|
||||||
|
)
|
||||||
|
return details
|
||||||
|
|
||||||
|
|
||||||
|
def _selected_payload(value: dict[str, Any], keys: tuple[str, ...]) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
key: copy.deepcopy(value[key])
|
||||||
|
for key in keys
|
||||||
|
if key in value
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def public_campaign_configuration(value: Any) -> Any:
|
||||||
|
"""Return campaign JSON without infrastructure locators or mail secrets.
|
||||||
|
|
||||||
|
Password-named business fields are intentionally retained. Only the
|
||||||
|
schema-defined SMTP/IMAP credential paths under ``server`` are secrets.
|
||||||
|
"""
|
||||||
|
|
||||||
|
payload = public_campaign_payload(value)
|
||||||
|
if not isinstance(payload, dict):
|
||||||
|
return payload
|
||||||
|
if "server" in payload:
|
||||||
|
payload["server"] = public_campaign_mail_server(payload)
|
||||||
|
_sanitize_configuration_paths(payload)
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def public_source_filename(value: Any) -> str | None:
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
text = str(value).strip()
|
||||||
|
if not text:
|
||||||
|
return text
|
||||||
|
windows_path = PureWindowsPath(text)
|
||||||
|
return windows_path.name if windows_path.is_absolute() or "\\" in text else Path(text).name
|
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_configuration_paths(payload: dict[str, Any]) -> None:
|
||||||
|
template = payload.get("template")
|
||||||
|
source = template.get("source") if isinstance(template, dict) else None
|
||||||
|
if isinstance(source, dict):
|
||||||
|
for key in ("subject_path", "text_path", "html_path"):
|
||||||
|
if key in source:
|
||||||
|
source[key] = _public_configuration_path(source[key])
|
||||||
|
|
||||||
|
entries = payload.get("entries")
|
||||||
|
entry_source = entries.get("source") if isinstance(entries, dict) else None
|
||||||
|
if isinstance(entry_source, dict) and "path" in entry_source:
|
||||||
|
entry_source["path"] = _public_configuration_path(entry_source["path"])
|
||||||
|
|
||||||
|
attachments = payload.get("attachments")
|
||||||
|
if isinstance(attachments, dict):
|
||||||
|
if "base_path" in attachments:
|
||||||
|
attachments["base_path"] = _public_configuration_path(attachments["base_path"])
|
||||||
|
base_paths = attachments.get("base_paths")
|
||||||
|
if isinstance(base_paths, list):
|
||||||
|
for item in base_paths:
|
||||||
|
if not isinstance(item, dict):
|
||||||
|
continue
|
||||||
|
for key in ("path", "source"):
|
||||||
|
if key in item:
|
||||||
|
item[key] = _public_configuration_path(item[key])
|
||||||
|
_sanitize_attachment_rules(attachments.get("global"))
|
||||||
|
|
||||||
|
if isinstance(entries, dict):
|
||||||
|
inline_entries = entries.get("inline")
|
||||||
|
if isinstance(inline_entries, list):
|
||||||
|
for entry in inline_entries:
|
||||||
|
if isinstance(entry, dict):
|
||||||
|
_sanitize_attachment_rules(entry.get("attachments"))
|
||||||
|
defaults = entries.get("defaults")
|
||||||
|
if isinstance(defaults, dict):
|
||||||
|
_sanitize_attachment_rules(defaults.get("attachments"))
|
||||||
|
|
||||||
|
|
||||||
|
def _sanitize_attachment_rules(value: Any) -> None:
|
||||||
|
if not isinstance(value, list):
|
||||||
|
return
|
||||||
|
for rule in value:
|
||||||
|
if isinstance(rule, dict) and "base_dir" in rule:
|
||||||
|
rule["base_dir"] = _public_configuration_path(rule["base_dir"])
|
||||||
|
|
||||||
|
|
||||||
|
def _public_configuration_path(value: Any) -> Any:
|
||||||
|
if not isinstance(value, str) or not value.strip():
|
||||||
|
return value
|
||||||
|
text = value.strip()
|
||||||
|
windows_path = PureWindowsPath(text)
|
||||||
|
path = Path(text)
|
||||||
|
if windows_path.is_absolute():
|
||||||
|
return windows_path.name
|
||||||
|
if path.is_absolute() or text.startswith("~"):
|
||||||
|
return path.name
|
||||||
|
return value
|
||||||
195
src/govoplan_campaign/backend/retention.py
Normal file
195
src/govoplan_campaign/backend/retention.py
Normal file
@@ -0,0 +1,195 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import copy
|
||||||
|
import hashlib
|
||||||
|
import json
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Callable
|
||||||
|
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.db.models import CampaignJob, CampaignVersion, JobImapStatus, JobQueueStatus
|
||||||
|
|
||||||
|
FINAL_VERSION_STATES = {
|
||||||
|
"completed",
|
||||||
|
"partially_completed",
|
||||||
|
"outcome_unknown",
|
||||||
|
"failed",
|
||||||
|
"cancelled",
|
||||||
|
"archived",
|
||||||
|
}
|
||||||
|
FINAL_EML_SEND_STATUSES = {
|
||||||
|
"smtp_accepted",
|
||||||
|
"sent",
|
||||||
|
"failed_permanent",
|
||||||
|
"cancelled",
|
||||||
|
"outcome_unknown",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _cutoff(days: int | None, *, now: datetime) -> datetime | None:
|
||||||
|
if days is None:
|
||||||
|
return None
|
||||||
|
return now - timedelta(days=days)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_before_cutoff(value: datetime | None, cutoff: datetime | None) -> bool:
|
||||||
|
if value is None or cutoff is None:
|
||||||
|
return False
|
||||||
|
candidate = value.replace(tzinfo=timezone.utc) if value.tzinfo is None else value
|
||||||
|
return candidate < cutoff
|
||||||
|
|
||||||
|
|
||||||
|
def _json_sha256(value: Any) -> str:
|
||||||
|
payload = json.dumps(value, sort_keys=True, ensure_ascii=False, default=str).encode("utf-8")
|
||||||
|
return hashlib.sha256(payload).hexdigest()
|
||||||
|
|
||||||
|
|
||||||
|
def _summary_was_redacted(summary: Any) -> bool:
|
||||||
|
return isinstance(summary, dict) and bool(summary.get("_retention", {}).get("report_detail_redacted"))
|
||||||
|
|
||||||
|
|
||||||
|
def _redacted_report_summary(summary: Any, *, now: datetime) -> tuple[dict[str, Any] | None, bool]:
|
||||||
|
if not isinstance(summary, dict):
|
||||||
|
return summary, False
|
||||||
|
if _summary_was_redacted(summary):
|
||||||
|
return summary, False
|
||||||
|
detail_keys = {"messages", "issues", "recent_failures", "jobs"}
|
||||||
|
if not any(key in summary for key in detail_keys):
|
||||||
|
return summary, False
|
||||||
|
next_summary = copy.deepcopy(summary)
|
||||||
|
for key in detail_keys:
|
||||||
|
next_summary.pop(key, None)
|
||||||
|
retention = dict(next_summary.get("_retention") or {})
|
||||||
|
retention.update({"report_detail_redacted": True, "redacted_at": now.isoformat()})
|
||||||
|
next_summary["_retention"] = retention
|
||||||
|
return next_summary, True
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_raw_json_retention(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
dry_run: bool,
|
||||||
|
now: datetime,
|
||||||
|
policy_for_campaign_id: Callable[[str | None], object],
|
||||||
|
) -> dict[str, int]:
|
||||||
|
result = {"eligible": 0, "redacted": 0, "skipped_not_final": 0, "already_redacted": 0}
|
||||||
|
versions = session.query(CampaignVersion).order_by(CampaignVersion.updated_at.asc()).all()
|
||||||
|
for version in versions:
|
||||||
|
policy = policy_for_campaign_id(version.campaign_id)
|
||||||
|
cutoff = _cutoff(0 if not policy.store_raw_campaign_json else policy.raw_campaign_json_retention_days, now=now)
|
||||||
|
if not _is_before_cutoff(version.updated_at, cutoff):
|
||||||
|
continue
|
||||||
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
if raw_json.get("_retention", {}).get("raw_json_redacted"):
|
||||||
|
result["already_redacted"] += 1
|
||||||
|
continue
|
||||||
|
if version.workflow_state not in FINAL_VERSION_STATES:
|
||||||
|
result["skipped_not_final"] += 1
|
||||||
|
continue
|
||||||
|
result["eligible"] += 1
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
snapshot = version.execution_snapshot if isinstance(version.execution_snapshot, dict) else {}
|
||||||
|
version.raw_json = {
|
||||||
|
"version": version.schema_version or "1.0",
|
||||||
|
"_retention": {
|
||||||
|
"raw_json_redacted": True,
|
||||||
|
"redacted_at": now.isoformat(),
|
||||||
|
"original_sha256": snapshot.get("campaign_json_sha256") or _json_sha256(raw_json),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
session.add(version)
|
||||||
|
result["redacted"] += 1
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_eml_retention(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
dry_run: bool,
|
||||||
|
now: datetime,
|
||||||
|
policy_for_campaign_id: Callable[[str | None], object],
|
||||||
|
) -> dict[str, int]:
|
||||||
|
result = {"eligible": 0, "metadata_cleared": 0, "files_deleted": 0, "files_missing": 0, "skipped_not_final": 0}
|
||||||
|
jobs = (
|
||||||
|
session.query(CampaignJob)
|
||||||
|
.filter((CampaignJob.eml_local_path.is_not(None)) | (CampaignJob.eml_storage_key.is_not(None)))
|
||||||
|
.order_by(CampaignJob.updated_at.asc())
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
for job in jobs:
|
||||||
|
policy = policy_for_campaign_id(job.campaign_id)
|
||||||
|
cutoff = _cutoff(policy.generated_eml_retention_days, now=now)
|
||||||
|
if not _is_before_cutoff(job.updated_at, cutoff):
|
||||||
|
continue
|
||||||
|
if job.queue_status in {JobQueueStatus.QUEUED.value, JobQueueStatus.SENDING.value} or job.send_status not in FINAL_EML_SEND_STATUSES:
|
||||||
|
result["skipped_not_final"] += 1
|
||||||
|
continue
|
||||||
|
if job.imap_status in {
|
||||||
|
JobImapStatus.PENDING.value,
|
||||||
|
JobImapStatus.APPENDING.value,
|
||||||
|
JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
}:
|
||||||
|
result["skipped_not_final"] += 1
|
||||||
|
continue
|
||||||
|
result["eligible"] += 1
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
if job.eml_local_path:
|
||||||
|
path = Path(job.eml_local_path)
|
||||||
|
if path.exists():
|
||||||
|
path.unlink()
|
||||||
|
result["files_deleted"] += 1
|
||||||
|
else:
|
||||||
|
result["files_missing"] += 1
|
||||||
|
job.eml_local_path = None
|
||||||
|
job.eml_storage_key = None
|
||||||
|
session.add(job)
|
||||||
|
result["metadata_cleared"] += 1
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _apply_report_detail_retention(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
dry_run: bool,
|
||||||
|
now: datetime,
|
||||||
|
policy_for_campaign_id: Callable[[str | None], object],
|
||||||
|
) -> dict[str, int]:
|
||||||
|
result = {"eligible_versions": 0, "summaries_redacted": 0, "already_redacted": 0}
|
||||||
|
versions = session.query(CampaignVersion).order_by(CampaignVersion.updated_at.asc()).all()
|
||||||
|
for version in versions:
|
||||||
|
policy = policy_for_campaign_id(version.campaign_id)
|
||||||
|
cutoff = _cutoff(policy.stored_report_detail_retention_days, now=now)
|
||||||
|
if not _is_before_cutoff(version.updated_at, cutoff):
|
||||||
|
continue
|
||||||
|
next_validation, validation_changed = _redacted_report_summary(version.validation_summary, now=now)
|
||||||
|
next_build, build_changed = _redacted_report_summary(version.build_summary, now=now)
|
||||||
|
if not validation_changed and not build_changed:
|
||||||
|
if _summary_was_redacted(version.validation_summary) or _summary_was_redacted(version.build_summary):
|
||||||
|
result["already_redacted"] += 1
|
||||||
|
continue
|
||||||
|
result["eligible_versions"] += 1
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
version.validation_summary = next_validation
|
||||||
|
version.build_summary = next_build
|
||||||
|
session.add(version)
|
||||||
|
result["summaries_redacted"] += int(validation_changed) + int(build_changed)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def apply_campaign_retention(
|
||||||
|
session: Session,
|
||||||
|
*,
|
||||||
|
dry_run: bool,
|
||||||
|
now: datetime,
|
||||||
|
policy_for_campaign_id: Callable[[str | None], object],
|
||||||
|
) -> dict[str, dict[str, int]]:
|
||||||
|
return {
|
||||||
|
"raw_campaign_json": _apply_raw_json_retention(session, dry_run=dry_run, now=now, policy_for_campaign_id=policy_for_campaign_id),
|
||||||
|
"generated_eml": _apply_eml_retention(session, dry_run=dry_run, now=now, policy_for_campaign_id=policy_for_campaign_id),
|
||||||
|
"stored_report_detail": _apply_report_detail_retention(session, dry_run=dry_run, now=now, policy_for_campaign_id=policy_for_campaign_id),
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||||
"$id": "https://multimailer.local/schema/campaign.schema.json",
|
"$id": "https://govoplan.local/schema/campaign.schema.json",
|
||||||
"title": "MultiMailer Campaign",
|
"title": "GovOPlaN Campaign",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": [
|
||||||
"version",
|
"version",
|
||||||
@@ -90,125 +90,9 @@
|
|||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
"mail_profile_id": {
|
"mail_profile_id": {
|
||||||
"type": "string"
|
"type": "string",
|
||||||
},
|
"minLength": 1,
|
||||||
"inherit_smtp_credentials": {
|
"description": "Stable reference to an authorized profile owned by the Mail module. Campaign JSON never stores SMTP/IMAP settings or credentials."
|
||||||
"type": "boolean",
|
|
||||||
"default": true
|
|
||||||
},
|
|
||||||
"inherit_imap_credentials": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": true
|
|
||||||
},
|
|
||||||
"smtp": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"host": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"port": {
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1,
|
|
||||||
"maximum": 65535
|
|
||||||
},
|
|
||||||
"username": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"security": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"plain",
|
|
||||||
"tls",
|
|
||||||
"starttls"
|
|
||||||
],
|
|
||||||
"default": "starttls"
|
|
||||||
},
|
|
||||||
"timeout_seconds": {
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1,
|
|
||||||
"default": 30
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
},
|
|
||||||
"imap": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"enabled": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"port": {
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1,
|
|
||||||
"maximum": 65535
|
|
||||||
},
|
|
||||||
"username": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"security": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"plain",
|
|
||||||
"tls",
|
|
||||||
"starttls"
|
|
||||||
],
|
|
||||||
"default": "tls"
|
|
||||||
},
|
|
||||||
"sent_folder": {
|
|
||||||
"type": "string",
|
|
||||||
"default": "auto"
|
|
||||||
},
|
|
||||||
"timeout_seconds": {
|
|
||||||
"type": "integer",
|
|
||||||
"minimum": 1,
|
|
||||||
"default": 30
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
},
|
|
||||||
"credentials": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"smtp": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"username": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
},
|
|
||||||
"imap": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"username": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"password": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false,
|
|
||||||
"default": {
|
|
||||||
"smtp": {},
|
|
||||||
"imap": {}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@@ -419,7 +303,19 @@
|
|||||||
"send_without_attachments": {
|
"send_without_attachments": {
|
||||||
"type": "boolean",
|
"type": "boolean",
|
||||||
"default": true,
|
"default": true,
|
||||||
"description": "Legacy compatibility flag. Prefer validation_policy and per-config missing_behavior for new campaigns."
|
"description": "Legacy compatibility flag. Use send_without_attachments_behavior for new campaigns."
|
||||||
|
},
|
||||||
|
"send_without_attachments_behavior": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"block",
|
||||||
|
"ask",
|
||||||
|
"drop",
|
||||||
|
"continue",
|
||||||
|
"warn"
|
||||||
|
],
|
||||||
|
"default": "continue",
|
||||||
|
"description": "Campaign-wide behavior when no attachment file is resolved for an active message."
|
||||||
},
|
},
|
||||||
"zip": {
|
"zip": {
|
||||||
"$ref": "#/$defs/zip_collection_config",
|
"$ref": "#/$defs/zip_collection_config",
|
||||||
@@ -482,6 +378,13 @@
|
|||||||
},
|
},
|
||||||
"defaults": {
|
"defaults": {
|
||||||
"$ref": "#/$defs/entry"
|
"$ref": "#/$defs/entry"
|
||||||
|
},
|
||||||
|
"imports": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/$defs/import_provenance"
|
||||||
|
},
|
||||||
|
"default": []
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@@ -505,6 +408,13 @@
|
|||||||
},
|
},
|
||||||
"defaults": {
|
"defaults": {
|
||||||
"$ref": "#/$defs/entry"
|
"$ref": "#/$defs/entry"
|
||||||
|
},
|
||||||
|
"imports": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/$defs/import_provenance"
|
||||||
|
},
|
||||||
|
"default": []
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
@@ -1027,6 +937,174 @@
|
|||||||
},
|
},
|
||||||
"additionalProperties": false
|
"additionalProperties": false
|
||||||
},
|
},
|
||||||
|
"import_provenance": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"id",
|
||||||
|
"imported_at",
|
||||||
|
"mode",
|
||||||
|
"source_type",
|
||||||
|
"header_rows",
|
||||||
|
"rows_total",
|
||||||
|
"valid_rows",
|
||||||
|
"invalid_rows",
|
||||||
|
"imported_rows"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"imported_at": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"mode": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"append",
|
||||||
|
"replace"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"source_type": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"csv",
|
||||||
|
"xlsx",
|
||||||
|
"text",
|
||||||
|
"addresses"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"source_id": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"source_label": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"source_revision": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"source_provenance": {
|
||||||
|
"type": "object",
|
||||||
|
"default": {}
|
||||||
|
},
|
||||||
|
"filename": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"sheet_name": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"encoding": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"delimiter": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"header_rows": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0,
|
||||||
|
"default": 0
|
||||||
|
},
|
||||||
|
"quoted": {
|
||||||
|
"type": [
|
||||||
|
"boolean",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"value_separators": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"rows_total": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
},
|
||||||
|
"valid_rows": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
},
|
||||||
|
"invalid_rows": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
},
|
||||||
|
"imported_rows": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
},
|
||||||
|
"field_names_created": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"default": []
|
||||||
|
},
|
||||||
|
"attachment_patterns": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0,
|
||||||
|
"default": 0
|
||||||
|
},
|
||||||
|
"mapping": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"column_index",
|
||||||
|
"header",
|
||||||
|
"kind"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"column_index": {
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 0
|
||||||
|
},
|
||||||
|
"header": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"kind": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"field_name": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"new_field_name": {
|
||||||
|
"type": [
|
||||||
|
"string",
|
||||||
|
"null"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
|
"default": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false
|
||||||
|
},
|
||||||
"attachment_base_path": {
|
"attachment_base_path": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": [
|
"required": [
|
||||||
|
|||||||
31
src/govoplan_campaign/backend/schema_router.py
Normal file
31
src/govoplan_campaign/backend/schema_router.py
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Depends
|
||||||
|
|
||||||
|
from govoplan_core.auth import ApiPrincipal, require_any_scope
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.loader import load_campaign_schema, load_campaign_schema_ui
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/schemas", tags=["schemas"])
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/campaign")
|
||||||
|
def get_campaign_schema(
|
||||||
|
principal: ApiPrincipal = Depends(require_any_scope("campaigns:campaign:read", "campaigns:campaign:create", "admin:roles:read")),
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return the authoritative campaign JSON Schema used by the backend."""
|
||||||
|
|
||||||
|
del principal
|
||||||
|
return load_campaign_schema()
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/campaign/ui")
|
||||||
|
def get_campaign_schema_ui(
|
||||||
|
principal: ApiPrincipal = Depends(require_any_scope("campaigns:campaign:read", "campaigns:campaign:create", "admin:roles:read")),
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Return UI metadata paired with the campaign JSON Schema."""
|
||||||
|
|
||||||
|
del principal
|
||||||
|
return load_campaign_schema_ui()
|
||||||
@@ -3,9 +3,18 @@ from __future__ import annotations
|
|||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
from typing import Any, Literal
|
from typing import Any, Literal
|
||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict, Field
|
from pydantic import BaseModel, ConfigDict, Field, ValidationInfo, field_validator, model_validator
|
||||||
|
|
||||||
from govoplan_core.mail.config import ImapConfig, SmtpConfig
|
from govoplan_core.api.v1.schemas import DeltaDeletedItem
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
public_campaign_editor_state,
|
||||||
|
validate_campaign_editor_state,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.response_security import (
|
||||||
|
public_campaign_configuration,
|
||||||
|
public_campaign_payload,
|
||||||
|
public_source_filename,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class CampaignCreateRequest(BaseModel):
|
class CampaignCreateRequest(BaseModel):
|
||||||
@@ -48,6 +57,12 @@ class CampaignVersionUpdateRequest(BaseModel):
|
|||||||
editor_state: dict[str, Any] | None = None
|
editor_state: dict[str, Any] | None = None
|
||||||
source_filename: str | None = None
|
source_filename: str | None = None
|
||||||
source_base_path: str | None = None
|
source_base_path: str | None = None
|
||||||
|
migrate_legacy_mail_settings: bool = False
|
||||||
|
|
||||||
|
@field_validator("editor_state")
|
||||||
|
@classmethod
|
||||||
|
def validate_editor_state(cls, value: dict[str, Any] | None) -> dict[str, Any] | None:
|
||||||
|
return validate_campaign_editor_state(value) if value is not None else None
|
||||||
|
|
||||||
|
|
||||||
class CampaignVersionSetStepRequest(BaseModel):
|
class CampaignVersionSetStepRequest(BaseModel):
|
||||||
@@ -79,7 +94,6 @@ class CampaignVersionResponse(BaseModel):
|
|||||||
version_number: int
|
version_number: int
|
||||||
schema_version: str
|
schema_version: str
|
||||||
source_filename: str | None = None
|
source_filename: str | None = None
|
||||||
source_base_path: str | None = None
|
|
||||||
workflow_state: str = "editing"
|
workflow_state: str = "editing"
|
||||||
current_flow: str = "manual"
|
current_flow: str = "manual"
|
||||||
current_step: str | None = None
|
current_step: str | None = None
|
||||||
@@ -98,10 +112,39 @@ class CampaignVersionResponse(BaseModel):
|
|||||||
build_summary: dict[str, Any] | None = None
|
build_summary: dict[str, Any] | None = None
|
||||||
execution_snapshot_hash: str | None = None
|
execution_snapshot_hash: str | None = None
|
||||||
execution_snapshot_at: datetime | None = None
|
execution_snapshot_at: datetime | None = None
|
||||||
|
delivery_mode: Literal["synchronous", "worker_queue", "database_queue"] | None = None
|
||||||
|
delivery_mode_selected_at: datetime | None = None
|
||||||
|
|
||||||
|
@field_validator("editor_state", mode="before")
|
||||||
|
@classmethod
|
||||||
|
def remove_unsupported_editor_state(cls, value: Any, info: ValidationInfo) -> dict[str, Any]:
|
||||||
|
return public_campaign_editor_state(
|
||||||
|
value,
|
||||||
|
include_diagnostics=bool((info.context or {}).get("include_diagnostics")),
|
||||||
|
)
|
||||||
|
|
||||||
|
@field_validator("source_filename", mode="before")
|
||||||
|
@classmethod
|
||||||
|
def remove_source_directory(cls, value: Any) -> str | None:
|
||||||
|
return public_source_filename(value)
|
||||||
|
|
||||||
|
@field_validator("validation_summary", "build_summary", mode="before")
|
||||||
|
@classmethod
|
||||||
|
def remove_internal_summary_fields(cls, value: Any, info: ValidationInfo) -> Any:
|
||||||
|
return public_campaign_payload(
|
||||||
|
value,
|
||||||
|
include_diagnostics=bool((info.context or {}).get("include_diagnostics")),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class CampaignVersionDetailResponse(CampaignVersionResponse):
|
class CampaignVersionDetailResponse(CampaignVersionResponse):
|
||||||
raw_json: dict[str, Any]
|
raw_json: dict[str, Any]
|
||||||
|
mail_profile_migration_required: bool = False
|
||||||
|
|
||||||
|
@field_validator("raw_json", mode="before")
|
||||||
|
@classmethod
|
||||||
|
def remove_internal_configuration_fields(cls, value: Any) -> Any:
|
||||||
|
return public_campaign_configuration(value)
|
||||||
|
|
||||||
|
|
||||||
class CampaignPartialValidationResponse(BaseModel):
|
class CampaignPartialValidationResponse(BaseModel):
|
||||||
@@ -145,6 +188,21 @@ class CampaignWorkspaceResponse(BaseModel):
|
|||||||
selected_version_id: str | None = None
|
selected_version_id: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignDeltaResponse(BaseModel):
|
||||||
|
campaigns: list[CampaignResponse] = Field(default_factory=list)
|
||||||
|
deleted: list[DeltaDeletedItem] = Field(default_factory=list)
|
||||||
|
watermark: str | None = None
|
||||||
|
has_more: bool = False
|
||||||
|
full: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignWorkspaceDeltaResponse(CampaignWorkspaceResponse):
|
||||||
|
deleted: list[DeltaDeletedItem] = Field(default_factory=list)
|
||||||
|
watermark: str | None = None
|
||||||
|
has_more: bool = False
|
||||||
|
full: bool = False
|
||||||
|
|
||||||
|
|
||||||
class CampaignShareItem(BaseModel):
|
class CampaignShareItem(BaseModel):
|
||||||
model_config = ConfigDict(from_attributes=True)
|
model_config = ConfigDict(from_attributes=True)
|
||||||
|
|
||||||
@@ -186,6 +244,129 @@ class CampaignOwnerUpdateRequest(BaseModel):
|
|||||||
owner_group_id: str | None = None
|
owner_group_id: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
RecipientImportColumnKind = Literal[
|
||||||
|
"ignore",
|
||||||
|
"id",
|
||||||
|
"active",
|
||||||
|
"name",
|
||||||
|
"from",
|
||||||
|
"to",
|
||||||
|
"cc",
|
||||||
|
"bcc",
|
||||||
|
"reply_to",
|
||||||
|
"field",
|
||||||
|
"new_field",
|
||||||
|
"attachment_pattern",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class RecipientImportColumnMappingPayload(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid", populate_by_name=True)
|
||||||
|
|
||||||
|
column_index: int = Field(ge=0, alias="columnIndex")
|
||||||
|
kind: RecipientImportColumnKind
|
||||||
|
field_name: str | None = Field(default=None, max_length=255, alias="fieldName")
|
||||||
|
new_field_name: str | None = Field(default=None, max_length=255, alias="newFieldName")
|
||||||
|
|
||||||
|
|
||||||
|
class RecipientImportMappingProfilePayload(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid", populate_by_name=True)
|
||||||
|
|
||||||
|
name: str = Field(min_length=1, max_length=255)
|
||||||
|
column_count: int = Field(ge=0, le=500, alias="columnCount")
|
||||||
|
headers: list[str] = Field(default_factory=list, max_length=500)
|
||||||
|
normalized_headers: list[str] = Field(default_factory=list, max_length=500, alias="normalizedHeaders")
|
||||||
|
ordered_header_fingerprint: str = Field(min_length=1, max_length=64, alias="orderedHeaderFingerprint")
|
||||||
|
unordered_header_fingerprint: str = Field(min_length=1, max_length=64, alias="unorderedHeaderFingerprint")
|
||||||
|
delimiter: Literal[",", ";", "\t"]
|
||||||
|
header_rows: int = Field(ge=0, le=10, alias="headerRows")
|
||||||
|
quoted: bool = True
|
||||||
|
value_separators: str = Field(default=",;|", max_length=50, alias="valueSeparators")
|
||||||
|
mappings: list[RecipientImportColumnMappingPayload] = Field(default_factory=list, max_length=500)
|
||||||
|
|
||||||
|
@model_validator(mode="after")
|
||||||
|
def validate_column_shape(self) -> "RecipientImportMappingProfilePayload":
|
||||||
|
if len(self.headers) != self.column_count:
|
||||||
|
raise ValueError("headers length must match columnCount")
|
||||||
|
if len(self.normalized_headers) != self.column_count:
|
||||||
|
raise ValueError("normalizedHeaders length must match columnCount")
|
||||||
|
for mapping in self.mappings:
|
||||||
|
if mapping.column_index >= self.column_count:
|
||||||
|
raise ValueError("mapping columnIndex exceeds columnCount")
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
|
class RecipientImportMappingProfileResponse(RecipientImportMappingProfilePayload):
|
||||||
|
model_config = ConfigDict(from_attributes=True, populate_by_name=True)
|
||||||
|
|
||||||
|
id: str
|
||||||
|
created_at: datetime = Field(alias="createdAt")
|
||||||
|
updated_at: datetime = Field(alias="updatedAt")
|
||||||
|
|
||||||
|
|
||||||
|
class RecipientImportMappingProfileListResponse(BaseModel):
|
||||||
|
profiles: list[RecipientImportMappingProfileResponse] = Field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignAddressLookupCandidate(BaseModel):
|
||||||
|
contact_id: str
|
||||||
|
address_book_id: str
|
||||||
|
display_name: str
|
||||||
|
email: str | None = None
|
||||||
|
email_label: str | None = None
|
||||||
|
organization: str | None = None
|
||||||
|
role_title: str | None = None
|
||||||
|
tags: list[str] = Field(default_factory=list)
|
||||||
|
source_kind: str = "local"
|
||||||
|
source_ref: str | None = None
|
||||||
|
source_revision: str | None = None
|
||||||
|
provenance: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignAddressLookupResponse(BaseModel):
|
||||||
|
available: bool = False
|
||||||
|
candidates: list[CampaignAddressLookupCandidate] = Field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRecipientAddressSource(BaseModel):
|
||||||
|
source_id: str
|
||||||
|
source_label: str
|
||||||
|
source_kind: str
|
||||||
|
source_revision: str
|
||||||
|
recipient_count: int = 0
|
||||||
|
provenance: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRecipientAddressSourcesResponse(BaseModel):
|
||||||
|
available: bool = False
|
||||||
|
sources: list[CampaignRecipientAddressSource] = Field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRecipientAddressSourceSnapshotRequest(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
source_id: str = Field(min_length=1)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRecipientSnapshotItem(BaseModel):
|
||||||
|
contact_id: str
|
||||||
|
display_name: str
|
||||||
|
email: str
|
||||||
|
email_label: str | None = None
|
||||||
|
fields: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
provenance: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignRecipientAddressSourceSnapshotResponse(BaseModel):
|
||||||
|
source_id: str
|
||||||
|
source_label: str
|
||||||
|
source_kind: str
|
||||||
|
source_revision: str
|
||||||
|
generated_at: str
|
||||||
|
recipients: list[CampaignRecipientSnapshotItem] = Field(default_factory=list)
|
||||||
|
provenance: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
class CampaignJobsResponse(BaseModel):
|
class CampaignJobsResponse(BaseModel):
|
||||||
jobs: list[dict[str, Any]]
|
jobs: list[dict[str, Any]]
|
||||||
page: int = 1
|
page: int = 1
|
||||||
@@ -193,16 +374,34 @@ class CampaignJobsResponse(BaseModel):
|
|||||||
total: int = 0
|
total: int = 0
|
||||||
total_unfiltered: int = 0
|
total_unfiltered: int = 0
|
||||||
pages: int = 0
|
pages: int = 0
|
||||||
|
cursor: str | None = None
|
||||||
|
next_cursor: str | None = None
|
||||||
counts: dict[str, dict[str, int]] = Field(default_factory=dict)
|
counts: dict[str, dict[str, int]] = Field(default_factory=dict)
|
||||||
filtered_counts: dict[str, dict[str, int]] = Field(default_factory=dict)
|
filtered_counts: dict[str, dict[str, int]] = Field(default_factory=dict)
|
||||||
review: dict[str, Any] = Field(default_factory=dict)
|
review: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignJobsDeltaResponse(CampaignJobsResponse):
|
||||||
|
deleted: list[DeltaDeletedItem] = Field(default_factory=list)
|
||||||
|
watermark: str | None = None
|
||||||
|
has_more: bool = False
|
||||||
|
full: bool = False
|
||||||
|
|
||||||
|
|
||||||
class CampaignJobDetailResponse(BaseModel):
|
class CampaignJobDetailResponse(BaseModel):
|
||||||
job: dict[str, Any]
|
job: dict[str, Any]
|
||||||
attempts: dict[str, list[dict[str, Any]]] = Field(default_factory=dict)
|
attempts: dict[str, list[dict[str, Any]]] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignJobDiagnosticsResponse(BaseModel):
|
||||||
|
job_id: str
|
||||||
|
campaign_id: str
|
||||||
|
campaign_version_id: str
|
||||||
|
storage: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
worker_claim: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
attempts: dict[str, list[dict[str, Any]]] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
class CampaignRetryJobsRequest(BaseModel):
|
class CampaignRetryJobsRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
@@ -223,17 +422,39 @@ class CampaignSendUnattemptedRequest(BaseModel):
|
|||||||
dry_run: bool = False
|
dry_run: bool = False
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignSendJobRequest(BaseModel):
|
||||||
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
include_warnings: bool = True
|
||||||
|
dry_run: bool = False
|
||||||
|
use_rate_limit: bool = True
|
||||||
|
enqueue_imap_task: bool = False
|
||||||
|
|
||||||
|
|
||||||
class CampaignResolveOutcomeRequest(BaseModel):
|
class CampaignResolveOutcomeRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
decision: Literal["smtp_accepted", "not_sent"]
|
decision: Literal[
|
||||||
note: str | None = None
|
"smtp_accepted",
|
||||||
|
"not_sent",
|
||||||
|
"imap_appended",
|
||||||
|
"imap_not_appended",
|
||||||
|
]
|
||||||
|
note: str | None = Field(default=None, max_length=2000)
|
||||||
|
|
||||||
|
@model_validator(mode="after")
|
||||||
|
def require_reconciliation_evidence(self) -> "CampaignResolveOutcomeRequest":
|
||||||
|
self.note = (self.note or "").strip()
|
||||||
|
if not self.note:
|
||||||
|
raise ValueError("Reconciliation requires an evidence note")
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
class ValidateCampaignRequest(BaseModel):
|
class ValidateCampaignRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
check_files: bool = False
|
check_files: bool = False
|
||||||
|
link_unshared_matches: bool = False
|
||||||
|
|
||||||
|
|
||||||
class BuildCampaignRequest(BaseModel):
|
class BuildCampaignRequest(BaseModel):
|
||||||
@@ -242,125 +463,6 @@ class BuildCampaignRequest(BaseModel):
|
|||||||
write_eml: bool = True
|
write_eml: bool = True
|
||||||
|
|
||||||
|
|
||||||
class MailSmtpTestRequest(SmtpConfig):
|
|
||||||
"""SMTP settings supplied directly from the WebUI mail settings form."""
|
|
||||||
|
|
||||||
|
|
||||||
class MailImapTestRequest(ImapConfig):
|
|
||||||
"""IMAP settings supplied directly from the WebUI mail settings form."""
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
MailProfileScope = Literal["system", "tenant", "user", "group", "campaign"]
|
|
||||||
|
|
||||||
|
|
||||||
class MailCredentialPolicyPayload(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
inherit: bool | None = None
|
|
||||||
allow_override: bool | None = None
|
|
||||||
|
|
||||||
|
|
||||||
class MailProfilePolicyPayload(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
allowed_profile_ids: list[str] = Field(default_factory=list)
|
|
||||||
allow_user_profiles: bool | None = None
|
|
||||||
allow_group_profiles: bool | None = None
|
|
||||||
allow_campaign_profiles: bool | None = None
|
|
||||||
smtp_credentials: MailCredentialPolicyPayload = Field(default_factory=MailCredentialPolicyPayload)
|
|
||||||
imap_credentials: MailCredentialPolicyPayload = Field(default_factory=MailCredentialPolicyPayload)
|
|
||||||
whitelist: dict[str, list[str]] = Field(default_factory=dict)
|
|
||||||
blacklist: dict[str, list[str]] = Field(default_factory=dict)
|
|
||||||
|
|
||||||
|
|
||||||
class MailProfilePolicyUpdateRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
policy: MailProfilePolicyPayload = Field(default_factory=MailProfilePolicyPayload)
|
|
||||||
|
|
||||||
|
|
||||||
class MailProfilePolicyResponse(BaseModel):
|
|
||||||
scope_type: MailProfileScope
|
|
||||||
scope_id: str | None = None
|
|
||||||
policy: dict[str, Any]
|
|
||||||
effective_policy: dict[str, Any] | None = None
|
|
||||||
|
|
||||||
|
|
||||||
class MailServerProfileCreateRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
name: str = Field(min_length=1, max_length=255)
|
|
||||||
slug: str | None = Field(default=None, max_length=100)
|
|
||||||
description: str | None = None
|
|
||||||
is_active: bool = True
|
|
||||||
scope_type: MailProfileScope = "tenant"
|
|
||||||
scope_id: str | None = None
|
|
||||||
smtp: SmtpConfig
|
|
||||||
imap: ImapConfig | None = None
|
|
||||||
|
|
||||||
|
|
||||||
class MailServerProfileUpdateRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
name: str | None = Field(default=None, max_length=255)
|
|
||||||
slug: str | None = Field(default=None, max_length=100)
|
|
||||||
description: str | None = None
|
|
||||||
is_active: bool | None = None
|
|
||||||
smtp: SmtpConfig | None = None
|
|
||||||
imap: ImapConfig | None = None
|
|
||||||
clear_imap: bool = False
|
|
||||||
|
|
||||||
|
|
||||||
class MailServerProfileResponse(BaseModel):
|
|
||||||
id: str
|
|
||||||
tenant_id: str | None = None
|
|
||||||
scope_type: MailProfileScope = "tenant"
|
|
||||||
scope_id: str | None = None
|
|
||||||
name: str
|
|
||||||
slug: str
|
|
||||||
description: str | None = None
|
|
||||||
is_active: bool
|
|
||||||
smtp: dict[str, Any]
|
|
||||||
imap: dict[str, Any] | None = None
|
|
||||||
smtp_password_configured: bool = False
|
|
||||||
imap_password_configured: bool = False
|
|
||||||
created_at: datetime
|
|
||||||
updated_at: datetime
|
|
||||||
|
|
||||||
|
|
||||||
class MailServerProfileListResponse(BaseModel):
|
|
||||||
profiles: list[MailServerProfileResponse] = Field(default_factory=list)
|
|
||||||
|
|
||||||
|
|
||||||
class MailConnectionTestResponse(BaseModel):
|
|
||||||
ok: bool
|
|
||||||
protocol: Literal["smtp", "imap"]
|
|
||||||
host: str | None = None
|
|
||||||
port: int | None = None
|
|
||||||
security: str | None = None
|
|
||||||
message: str
|
|
||||||
details: dict[str, Any] = Field(default_factory=dict)
|
|
||||||
|
|
||||||
|
|
||||||
class MailImapFolderResponse(BaseModel):
|
|
||||||
name: str
|
|
||||||
flags: list[str] = Field(default_factory=list)
|
|
||||||
|
|
||||||
|
|
||||||
class MailImapFolderListResponse(BaseModel):
|
|
||||||
ok: bool
|
|
||||||
protocol: Literal["imap"] = "imap"
|
|
||||||
host: str | None = None
|
|
||||||
port: int | None = None
|
|
||||||
security: str | None = None
|
|
||||||
message: str
|
|
||||||
folders: list[MailImapFolderResponse] = Field(default_factory=list)
|
|
||||||
detected_sent_folder: str | None = None
|
|
||||||
details: dict[str, Any] = Field(default_factory=dict)
|
|
||||||
|
|
||||||
|
|
||||||
class ApiKeyCreateRequest(BaseModel):
|
class ApiKeyCreateRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
@@ -392,6 +494,8 @@ class QueueCampaignResponse(BaseModel):
|
|||||||
skipped_count: int
|
skipped_count: int
|
||||||
blocked_count: int
|
blocked_count: int
|
||||||
enqueued_count: int
|
enqueued_count: int
|
||||||
|
delivery_mode: str = "worker_queue"
|
||||||
|
worker_queue_available: bool = False
|
||||||
dry_run: bool = False
|
dry_run: bool = False
|
||||||
|
|
||||||
|
|
||||||
@@ -412,6 +516,13 @@ class SendCampaignNowResponse(BaseModel):
|
|||||||
result: dict[str, Any]
|
result: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignDeliveryOptionsResponse(BaseModel):
|
||||||
|
campaign_id: str
|
||||||
|
version_id: str
|
||||||
|
worker_queue_available: bool
|
||||||
|
synchronous_send: dict[str, Any] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
class MockCampaignSendRequest(BaseModel):
|
class MockCampaignSendRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
@@ -439,124 +550,64 @@ class AppendSentRequest(BaseModel):
|
|||||||
class CampaignActionResponse(BaseModel):
|
class CampaignActionResponse(BaseModel):
|
||||||
result: dict[str, Any]
|
result: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
class ReportEmailRequest(BaseModel):
|
class ReportEmailRequest(BaseModel):
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
|
|
||||||
to: list[str]
|
to: list[str] = Field(min_length=1, max_length=50)
|
||||||
version_id: str | None = None
|
version_id: str | None = None
|
||||||
include_jobs: bool = False
|
include_jobs: bool = False
|
||||||
attach_jobs_csv: bool = True
|
attach_jobs_csv: bool = False
|
||||||
attach_report_json: bool = False
|
attach_report_json: bool = False
|
||||||
dry_run: bool = False
|
dry_run: bool = False
|
||||||
|
|
||||||
|
@field_validator("to", mode="before")
|
||||||
|
@classmethod
|
||||||
|
def normalize_and_validate_recipients(cls, value: Any) -> Any:
|
||||||
|
if not isinstance(value, list):
|
||||||
|
return value
|
||||||
|
if not 1 <= len(value) <= 50:
|
||||||
|
raise ValueError("report email requires between 1 and 50 recipients")
|
||||||
|
recipients: list[str] = []
|
||||||
|
seen: set[str] = set()
|
||||||
|
for item in value:
|
||||||
|
if not isinstance(item, str):
|
||||||
|
raise ValueError("report recipients must be email-address strings")
|
||||||
|
recipient = item.strip()
|
||||||
|
if len(recipient) > 320:
|
||||||
|
raise ValueError("report recipient addresses must be at most 320 characters")
|
||||||
|
if any(ord(character) < 32 or ord(character) == 127 for character in recipient):
|
||||||
|
raise ValueError("report recipient addresses must not contain control characters")
|
||||||
|
if recipient.count("@") != 1:
|
||||||
|
raise ValueError("report recipients must be email addresses")
|
||||||
|
local, domain = recipient.split("@", 1)
|
||||||
|
if (
|
||||||
|
not local
|
||||||
|
or not domain
|
||||||
|
or any(character.isspace() for character in recipient)
|
||||||
|
or any(character in ',;:<>[]()\\"' for character in recipient)
|
||||||
|
or local.startswith(".")
|
||||||
|
or local.endswith(".")
|
||||||
|
or ".." in local
|
||||||
|
or domain.startswith(".")
|
||||||
|
or domain.endswith(".")
|
||||||
|
or ".." in domain
|
||||||
|
or any(
|
||||||
|
not label
|
||||||
|
or label.startswith("-")
|
||||||
|
or label.endswith("-")
|
||||||
|
or not all(character.isalnum() or character == "-" for character in label)
|
||||||
|
for label in domain.split(".")
|
||||||
|
)
|
||||||
|
):
|
||||||
|
raise ValueError("report recipients must be email addresses")
|
||||||
|
key = recipient.casefold()
|
||||||
|
if key in seen:
|
||||||
|
continue
|
||||||
|
seen.add(key)
|
||||||
|
recipients.append(recipient)
|
||||||
|
return recipients
|
||||||
|
|
||||||
|
|
||||||
class ReportEmailResponse(BaseModel):
|
class ReportEmailResponse(BaseModel):
|
||||||
result: dict[str, Any]
|
result: dict[str, Any]
|
||||||
|
|
||||||
|
|
||||||
class AuditLogItemResponse(BaseModel):
|
|
||||||
model_config = ConfigDict(from_attributes=True)
|
|
||||||
|
|
||||||
id: str
|
|
||||||
tenant_id: str | None = None
|
|
||||||
user_id: str | None = None
|
|
||||||
api_key_id: str | None = None
|
|
||||||
action: str
|
|
||||||
object_type: str | None = None
|
|
||||||
object_id: str | None = None
|
|
||||||
details: dict[str, Any] | None = None
|
|
||||||
created_at: datetime
|
|
||||||
|
|
||||||
|
|
||||||
class AuditLogListResponse(BaseModel):
|
|
||||||
items: list[AuditLogItemResponse]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
class LoginRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
email: str
|
|
||||||
password: str
|
|
||||||
# Kept optional for backwards compatibility and future tenant-switch login flows.
|
|
||||||
# The WebUI no longer sends it. If omitted, the backend resolves the user by email.
|
|
||||||
tenant_slug: str | None = None
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
class SwitchTenantRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
tenant_id: str
|
|
||||||
|
|
||||||
|
|
||||||
class TenantInfo(BaseModel):
|
|
||||||
id: str
|
|
||||||
slug: str
|
|
||||||
name: str
|
|
||||||
is_active: bool = True
|
|
||||||
default_locale: str = "en"
|
|
||||||
|
|
||||||
|
|
||||||
class TenantMembershipInfo(TenantInfo):
|
|
||||||
roles: list[str] = Field(default_factory=list)
|
|
||||||
is_active: bool = True
|
|
||||||
|
|
||||||
|
|
||||||
class UserInfo(BaseModel):
|
|
||||||
id: str
|
|
||||||
account_id: str
|
|
||||||
email: str
|
|
||||||
# Global account identity used by the title bar and account settings.
|
|
||||||
display_name: str | None = None
|
|
||||||
# Optional tenant-local alias used in tenant administration and ownership.
|
|
||||||
tenant_display_name: str | None = None
|
|
||||||
is_tenant_admin: bool = False
|
|
||||||
password_reset_required: bool = False
|
|
||||||
|
|
||||||
|
|
||||||
class ProfileUpdateRequest(BaseModel):
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
display_name: str | None = Field(default=None, max_length=255)
|
|
||||||
tenant_display_name: str | None = Field(default=None, max_length=255)
|
|
||||||
|
|
||||||
|
|
||||||
class RoleInfo(BaseModel):
|
|
||||||
id: str
|
|
||||||
slug: str
|
|
||||||
name: str
|
|
||||||
permissions: list[str] = Field(default_factory=list)
|
|
||||||
level: Literal["tenant", "system"] = "tenant"
|
|
||||||
|
|
||||||
|
|
||||||
class GroupInfo(BaseModel):
|
|
||||||
id: str
|
|
||||||
slug: str
|
|
||||||
name: str
|
|
||||||
|
|
||||||
|
|
||||||
class LoginResponse(BaseModel):
|
|
||||||
access_token: str
|
|
||||||
token_type: str = "bearer"
|
|
||||||
expires_at: datetime
|
|
||||||
user: UserInfo
|
|
||||||
# Backwards-compatible alias for the active tenant.
|
|
||||||
tenant: TenantInfo
|
|
||||||
active_tenant: TenantInfo
|
|
||||||
tenants: list[TenantMembershipInfo] = Field(default_factory=list)
|
|
||||||
scopes: list[str]
|
|
||||||
roles: list[RoleInfo] = Field(default_factory=list)
|
|
||||||
groups: list[GroupInfo] = Field(default_factory=list)
|
|
||||||
|
|
||||||
|
|
||||||
class MeResponse(BaseModel):
|
|
||||||
user: UserInfo
|
|
||||||
# Backwards-compatible alias for the active tenant.
|
|
||||||
tenant: TenantInfo
|
|
||||||
active_tenant: TenantInfo
|
|
||||||
tenants: list[TenantMembershipInfo] = Field(default_factory=list)
|
|
||||||
scopes: list[str]
|
|
||||||
roles: list[RoleInfo] = Field(default_factory=list)
|
|
||||||
groups: list[GroupInfo] = Field(default_factory=list)
|
|
||||||
|
|||||||
@@ -9,10 +9,16 @@ from pydantic import BaseModel, ConfigDict
|
|||||||
from sqlalchemy.orm import Session
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
from govoplan_campaign.backend.db.models import Campaign, CampaignJob, CampaignVersion, JobValidationStatus
|
from govoplan_campaign.backend.db.models import Campaign, CampaignJob, CampaignVersion, JobValidationStatus
|
||||||
from govoplan_campaign.backend.campaign.models import DeliveryConfig, ImapConfig, SmtpConfig
|
from govoplan_campaign.backend.campaign.models import DeliveryConfig
|
||||||
from govoplan_campaign.backend.integrations import MailProfileError, mail_integration
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
CampaignMailProfileBoundaryError,
|
||||||
|
assert_campaign_uses_mail_profile_reference,
|
||||||
|
campaign_mail_profile_id,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.integrations import MailProfileError, files_integration, mail_integration
|
||||||
|
from govoplan_campaign.backend.path_security import CampaignPathSecurityError, assert_server_safe_campaign_paths
|
||||||
|
|
||||||
SNAPSHOT_VERSION = "3"
|
SNAPSHOT_VERSION = "5"
|
||||||
|
|
||||||
|
|
||||||
class ExecutionSnapshotError(RuntimeError):
|
class ExecutionSnapshotError(RuntimeError):
|
||||||
@@ -24,9 +30,9 @@ class ExecutionSnapshot(BaseModel):
|
|||||||
|
|
||||||
Rendered messages and attachment evidence remain normalized in
|
Rendered messages and attachment evidence remain normalized in
|
||||||
``CampaignJob`` and ``CampaignAttachmentUse``. This record freezes the
|
``CampaignJob`` and ``CampaignAttachmentUse``. This record freezes the
|
||||||
mutable transport/runtime configuration and cryptographically binds it to
|
Mail-profile reference, delivery policy, and opaque transport revisions and
|
||||||
the build and the exact set of persisted jobs without duplicating all
|
cryptographically binds them to the build and exact persisted jobs. Mail
|
||||||
recipient data into one large JSON value.
|
owns the resolved transport configuration and credentials.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
model_config = ConfigDict(extra="forbid")
|
model_config = ConfigDict(extra="forbid")
|
||||||
@@ -34,6 +40,7 @@ class ExecutionSnapshot(BaseModel):
|
|||||||
snapshot_version: str = SNAPSHOT_VERSION
|
snapshot_version: str = SNAPSHOT_VERSION
|
||||||
campaign_version_id: str
|
campaign_version_id: str
|
||||||
campaign_json_sha256: str
|
campaign_json_sha256: str
|
||||||
|
mail_profile_id: str
|
||||||
created_at: str
|
created_at: str
|
||||||
build_token: str | None = None
|
build_token: str | None = None
|
||||||
built_at: str | None = None
|
built_at: str | None = None
|
||||||
@@ -41,10 +48,8 @@ class ExecutionSnapshot(BaseModel):
|
|||||||
queueable_job_count: int = 0
|
queueable_job_count: int = 0
|
||||||
job_manifest_sha256: str | None = None
|
job_manifest_sha256: str | None = None
|
||||||
effective_policy_sha256: str | None = None
|
effective_policy_sha256: str | None = None
|
||||||
smtp_config_fingerprint: str | None = None
|
smtp_transport_revision: str | None = None
|
||||||
imap_config_fingerprint: str | None = None
|
imap_transport_revision: str | None = None
|
||||||
smtp: SmtpConfig
|
|
||||||
imap: ImapConfig | None = None
|
|
||||||
delivery: DeliveryConfig
|
delivery: DeliveryConfig
|
||||||
|
|
||||||
|
|
||||||
@@ -60,110 +65,50 @@ def snapshot_hash(payload: dict[str, Any]) -> str:
|
|||||||
return _sha256(payload)
|
return _sha256(payload)
|
||||||
|
|
||||||
|
|
||||||
def _transport_fingerprint(config: SmtpConfig | ImapConfig | None) -> str | None:
|
def profile_delivery_summary(session: Session, version: CampaignVersion) -> dict[str, Any]:
|
||||||
if config is None:
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
return None
|
_assert_version_mail_profile_boundary(raw_json)
|
||||||
payload = config.model_dump(mode="json")
|
|
||||||
# The fingerprint is safe to expose in reports. It identifies the effective
|
|
||||||
# account/transport settings without incorporating or revealing the secret.
|
|
||||||
if "password" in payload:
|
|
||||||
payload["password"] = "<configured>" if payload.get("password") else None
|
|
||||||
return _sha256(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def _redacted_transport_config(config: SmtpConfig | ImapConfig | None) -> SmtpConfig | ImapConfig | None:
|
|
||||||
if config is None:
|
|
||||||
return None
|
|
||||||
payload = config.model_dump(mode="json")
|
|
||||||
payload["password"] = None
|
|
||||||
if isinstance(config, SmtpConfig):
|
|
||||||
return SmtpConfig.model_validate(payload)
|
|
||||||
return ImapConfig.model_validate(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def _transport_password_from_campaign_json(raw_json: dict[str, Any] | None, name: str) -> str | None:
|
|
||||||
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
|
||||||
credentials = server.get("credentials") if isinstance(server, dict) and isinstance(server.get("credentials"), dict) else None
|
|
||||||
config = credentials.get(name) if isinstance(credentials, dict) and isinstance(credentials.get(name), dict) else None
|
|
||||||
password = config.get("password") if isinstance(config, dict) else None
|
|
||||||
if password is None:
|
|
||||||
legacy_config = server.get(name) if isinstance(server, dict) else None
|
|
||||||
password = legacy_config.get("password") if isinstance(legacy_config, dict) else None
|
|
||||||
if password is None:
|
|
||||||
return None
|
|
||||||
return str(password)
|
|
||||||
|
|
||||||
|
|
||||||
def _server_from_campaign_json(raw_json: dict[str, Any] | None) -> dict[str, Any]:
|
|
||||||
server = raw_json.get("server") if isinstance(raw_json, dict) else None
|
|
||||||
return server if isinstance(server, dict) else {}
|
|
||||||
|
|
||||||
|
|
||||||
def _profile_for_version(session: Session, version: CampaignVersion):
|
|
||||||
mail = mail_integration()
|
mail = mail_integration()
|
||||||
profile_id = mail.mail_profile_id_from_campaign_json(version.raw_json if isinstance(version.raw_json, dict) else {})
|
profile_id = campaign_mail_profile_id(raw_json)
|
||||||
if not profile_id:
|
if profile_id is None: # Kept explicit for static typing; the assertion above requires it.
|
||||||
return None
|
raise ExecutionSnapshotError("Campaign has no Mail profile reference")
|
||||||
campaign = session.get(Campaign, version.campaign_id)
|
campaign = session.get(Campaign, version.campaign_id)
|
||||||
if campaign is None:
|
if campaign is None:
|
||||||
raise ExecutionSnapshotError("Campaign not found for mail-server profile resolution")
|
raise ExecutionSnapshotError("Campaign not found for mail-server profile resolution")
|
||||||
try:
|
try:
|
||||||
return mail.ensure_mail_profile_allowed_for_campaign(session, tenant_id=campaign.tenant_id, campaign_id=campaign.id, profile_id=profile_id, require_active=True)
|
return mail.campaign_profile_delivery_summary(
|
||||||
|
session,
|
||||||
|
tenant_id=campaign.tenant_id,
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
profile_id=profile_id,
|
||||||
|
)
|
||||||
except MailProfileError as exc:
|
except MailProfileError as exc:
|
||||||
raise ExecutionSnapshotError(str(exc)) from exc
|
raise ExecutionSnapshotError(str(exc)) from exc
|
||||||
|
|
||||||
|
|
||||||
def runtime_smtp_config(session: Session, version: CampaignVersion, snapshot: ExecutionSnapshot) -> SmtpConfig:
|
def profile_transport_revisions(session: Session, version: CampaignVersion) -> dict[str, str | None]:
|
||||||
payload = snapshot.smtp.model_dump(mode="json")
|
summary = profile_delivery_summary(session, version)
|
||||||
if not payload.get("password"):
|
return {
|
||||||
server = _server_from_campaign_json(version.raw_json)
|
"smtp": summary.get("smtp_transport_revision"),
|
||||||
profile = _profile_for_version(session, version)
|
"imap": summary.get("imap_transport_revision"),
|
||||||
if profile is not None:
|
}
|
||||||
campaign = session.get(Campaign, version.campaign_id)
|
|
||||||
if campaign is None:
|
|
||||||
raise ExecutionSnapshotError("Campaign not found for mail-server profile resolution")
|
|
||||||
mail = mail_integration()
|
|
||||||
profile_payload = mail.smtp_config_from_profile(profile).model_dump(mode="json")
|
|
||||||
if mail.effective_profile_credentials_inherited(session, tenant_id=campaign.tenant_id, campaign_id=campaign.id, server=server, protocol="smtp"):
|
|
||||||
return SmtpConfig.model_validate(profile_payload)
|
|
||||||
return SmtpConfig.model_validate(mail.apply_campaign_credentials(profile_payload, server, "smtp"))
|
|
||||||
payload["password"] = _transport_password_from_campaign_json(version.raw_json, "smtp")
|
|
||||||
return SmtpConfig.model_validate(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def runtime_imap_config(session: Session, version: CampaignVersion, snapshot: ExecutionSnapshot) -> ImapConfig | None:
|
def _assert_snapshot_profile_matches_version(version: CampaignVersion, snapshot: ExecutionSnapshot) -> None:
|
||||||
server = _server_from_campaign_json(version.raw_json)
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
if snapshot.imap is None:
|
_assert_version_mail_profile_boundary(raw_json)
|
||||||
profile = _profile_for_version(session, version)
|
if campaign_mail_profile_id(raw_json) != snapshot.mail_profile_id:
|
||||||
if profile is None:
|
raise ExecutionSnapshotError(
|
||||||
return None
|
"The campaign's Mail profile reference differs from the built execution snapshot. "
|
||||||
mail = mail_integration()
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
imap = mail.imap_config_from_profile(profile)
|
)
|
||||||
if imap is None:
|
|
||||||
return None
|
|
||||||
campaign = session.get(Campaign, version.campaign_id)
|
def _assert_version_mail_profile_boundary(raw_json: dict[str, Any]) -> None:
|
||||||
if campaign is None:
|
try:
|
||||||
raise ExecutionSnapshotError("Campaign not found for mail-server profile resolution")
|
assert_campaign_uses_mail_profile_reference(raw_json, require_profile=True)
|
||||||
imap_payload = imap.model_dump(mode="json")
|
except CampaignMailProfileBoundaryError as exc:
|
||||||
if mail.effective_profile_credentials_inherited(session, tenant_id=campaign.tenant_id, campaign_id=campaign.id, server=server, protocol="imap"):
|
raise ExecutionSnapshotError(str(exc)) from exc
|
||||||
return ImapConfig.model_validate(imap_payload)
|
|
||||||
return ImapConfig.model_validate(mail.apply_campaign_credentials(imap_payload, server, "imap"))
|
|
||||||
payload = snapshot.imap.model_dump(mode="json")
|
|
||||||
if not payload.get("password"):
|
|
||||||
profile = _profile_for_version(session, version)
|
|
||||||
if profile is not None:
|
|
||||||
mail = mail_integration()
|
|
||||||
imap = mail.imap_config_from_profile(profile)
|
|
||||||
if imap is not None:
|
|
||||||
campaign = session.get(Campaign, version.campaign_id)
|
|
||||||
if campaign is None:
|
|
||||||
raise ExecutionSnapshotError("Campaign not found for mail-server profile resolution")
|
|
||||||
imap_payload = imap.model_dump(mode="json")
|
|
||||||
if mail.effective_profile_credentials_inherited(session, tenant_id=campaign.tenant_id, campaign_id=campaign.id, server=server, protocol="imap"):
|
|
||||||
return ImapConfig.model_validate(imap_payload)
|
|
||||||
return ImapConfig.model_validate(mail.apply_campaign_credentials(imap_payload, server, "imap"))
|
|
||||||
payload["password"] = _transport_password_from_campaign_json(version.raw_json, "imap")
|
|
||||||
return ImapConfig.model_validate(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def _policy_fingerprint(raw_json: dict[str, Any], delivery: DeliveryConfig) -> str:
|
def _policy_fingerprint(raw_json: dict[str, Any], delivery: DeliveryConfig) -> str:
|
||||||
@@ -179,68 +124,143 @@ def _policy_fingerprint(raw_json: dict[str, Any], delivery: DeliveryConfig) -> s
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _job_execution_input_payload(job: CampaignJob) -> dict[str, Any]:
|
||||||
|
return {
|
||||||
|
"job_id": job.id,
|
||||||
|
"entry_index": job.entry_index,
|
||||||
|
"entry_id": job.entry_id,
|
||||||
|
"recipient_email": job.recipient_email,
|
||||||
|
"subject": job.subject,
|
||||||
|
"message_id_header": job.message_id_header,
|
||||||
|
"eml_size_bytes": job.eml_size_bytes,
|
||||||
|
"eml_sha256": job.eml_sha256,
|
||||||
|
"build_status": job.build_status,
|
||||||
|
"validation_status": job.validation_status,
|
||||||
|
"resolved_recipients_sha256": _sha256(job.resolved_recipients or {}),
|
||||||
|
"resolved_attachments_sha256": _sha256(job.resolved_attachments or []),
|
||||||
|
"issues_sha256": _sha256(job.issues_snapshot or []),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def job_execution_input_hash(job: CampaignJob) -> str:
|
||||||
|
return _sha256(_job_execution_input_payload(job))
|
||||||
|
|
||||||
|
|
||||||
def job_manifest_hash(jobs: Iterable[CampaignJob]) -> str:
|
def job_manifest_hash(jobs: Iterable[CampaignJob]) -> str:
|
||||||
"""Hash the immutable per-message execution records in stable order."""
|
"""Hash the immutable per-message execution records in stable order."""
|
||||||
|
|
||||||
payload: list[dict[str, Any]] = []
|
payload = [
|
||||||
for job in sorted(jobs, key=lambda item: (item.entry_index, item.id)):
|
_job_execution_input_payload(job)
|
||||||
payload.append(
|
for job in sorted(jobs, key=lambda item: (item.entry_index, item.id))
|
||||||
{
|
]
|
||||||
"job_id": job.id,
|
|
||||||
"entry_index": job.entry_index,
|
|
||||||
"entry_id": job.entry_id,
|
|
||||||
"recipient_email": job.recipient_email,
|
|
||||||
"subject": job.subject,
|
|
||||||
"message_id_header": job.message_id_header,
|
|
||||||
"eml_size_bytes": job.eml_size_bytes,
|
|
||||||
"eml_sha256": job.eml_sha256,
|
|
||||||
"build_status": job.build_status,
|
|
||||||
"validation_status": job.validation_status,
|
|
||||||
"resolved_recipients_sha256": _sha256(job.resolved_recipients or {}),
|
|
||||||
"resolved_attachments_sha256": _sha256(job.resolved_attachments or []),
|
|
||||||
"issues_sha256": _sha256(job.issues_snapshot or []),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
return _sha256(payload)
|
return _sha256(payload)
|
||||||
|
|
||||||
|
|
||||||
def create_execution_snapshot(
|
def create_execution_snapshot(
|
||||||
version: CampaignVersion,
|
version: CampaignVersion,
|
||||||
*,
|
*,
|
||||||
smtp: SmtpConfig,
|
mail_profile_id: str,
|
||||||
imap: ImapConfig | None,
|
smtp_transport_revision: str,
|
||||||
|
imap_transport_revision: str | None,
|
||||||
delivery: DeliveryConfig,
|
delivery: DeliveryConfig,
|
||||||
jobs: Iterable[CampaignJob] = (),
|
jobs: Iterable[CampaignJob] = (),
|
||||||
build_summary: dict[str, Any] | None = None,
|
build_summary: dict[str, Any] | None = None,
|
||||||
) -> tuple[dict[str, Any], str]:
|
) -> tuple[dict[str, Any], str]:
|
||||||
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
job_list = list(jobs)
|
job_list = list(jobs)
|
||||||
|
for job in job_list:
|
||||||
|
job.execution_input_sha256 = job_execution_input_hash(job)
|
||||||
summary = build_summary if isinstance(build_summary, dict) else {}
|
summary = build_summary if isinstance(build_summary, dict) else {}
|
||||||
queueable_statuses = {JobValidationStatus.READY.value, JobValidationStatus.WARNING.value}
|
queueable_statuses = {JobValidationStatus.READY.value, JobValidationStatus.WARNING.value}
|
||||||
redacted_smtp = _redacted_transport_config(smtp)
|
|
||||||
redacted_imap = _redacted_transport_config(imap)
|
|
||||||
assert isinstance(redacted_smtp, SmtpConfig)
|
|
||||||
assert redacted_imap is None or isinstance(redacted_imap, ImapConfig)
|
|
||||||
payload = ExecutionSnapshot(
|
payload = ExecutionSnapshot(
|
||||||
campaign_version_id=version.id,
|
campaign_version_id=version.id,
|
||||||
campaign_json_sha256=_sha256(raw_json),
|
campaign_json_sha256=_sha256(raw_json),
|
||||||
|
mail_profile_id=mail_profile_id,
|
||||||
build_token=str(summary.get("build_token") or "") or None,
|
build_token=str(summary.get("build_token") or "") or None,
|
||||||
built_at=str(summary.get("built_at") or "") or None,
|
built_at=str(summary.get("built_at") or "") or None,
|
||||||
job_count=len(job_list),
|
job_count=len(job_list),
|
||||||
queueable_job_count=sum(1 for job in job_list if job.validation_status in queueable_statuses),
|
queueable_job_count=sum(1 for job in job_list if job.validation_status in queueable_statuses),
|
||||||
job_manifest_sha256=job_manifest_hash(job_list) if job_list else None,
|
job_manifest_sha256=job_manifest_hash(job_list) if job_list else None,
|
||||||
effective_policy_sha256=_policy_fingerprint(raw_json, delivery),
|
effective_policy_sha256=_policy_fingerprint(raw_json, delivery),
|
||||||
smtp_config_fingerprint=_transport_fingerprint(smtp),
|
smtp_transport_revision=smtp_transport_revision,
|
||||||
imap_config_fingerprint=_transport_fingerprint(imap),
|
imap_transport_revision=imap_transport_revision,
|
||||||
created_at=datetime.now(timezone.utc).isoformat(),
|
created_at=datetime.now(timezone.utc).isoformat(),
|
||||||
smtp=redacted_smtp,
|
|
||||||
imap=redacted_imap,
|
|
||||||
delivery=delivery,
|
delivery=delivery,
|
||||||
).model_dump(mode="json")
|
).model_dump(mode="json")
|
||||||
return payload, snapshot_hash(payload)
|
return payload, snapshot_hash(payload)
|
||||||
|
|
||||||
|
|
||||||
def ensure_execution_snapshot(session: Session, version: CampaignVersion) -> ExecutionSnapshot:
|
def _assert_snapshot_matches_persisted_inputs(
|
||||||
|
session: Session,
|
||||||
|
version: CampaignVersion,
|
||||||
|
snapshot: ExecutionSnapshot,
|
||||||
|
*,
|
||||||
|
effect_job: CampaignJob | None = None,
|
||||||
|
) -> None:
|
||||||
|
"""Fail closed when any build-bound input drifted after snapshot creation."""
|
||||||
|
|
||||||
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
if snapshot.campaign_version_id != version.id:
|
||||||
|
raise ExecutionSnapshotError("Execution snapshot campaign version mismatch")
|
||||||
|
if snapshot.campaign_json_sha256 != _sha256(raw_json):
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"Campaign inputs changed after this execution snapshot was built. "
|
||||||
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
|
)
|
||||||
|
if not snapshot.smtp_transport_revision:
|
||||||
|
raise ExecutionSnapshotError("Execution snapshot has no SMTP transport revision")
|
||||||
|
if not snapshot.job_manifest_sha256:
|
||||||
|
raise ExecutionSnapshotError("Execution snapshot has no built-job manifest checksum")
|
||||||
|
if not snapshot.effective_policy_sha256:
|
||||||
|
raise ExecutionSnapshotError("Execution snapshot has no effective-policy checksum")
|
||||||
|
if snapshot.effective_policy_sha256 != _policy_fingerprint(raw_json, snapshot.delivery):
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"Campaign delivery policy changed after the execution snapshot was created. "
|
||||||
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
|
)
|
||||||
|
|
||||||
|
if effect_job is not None:
|
||||||
|
if effect_job.campaign_version_id != version.id:
|
||||||
|
raise ExecutionSnapshotError("Campaign job does not belong to the snapshotted version")
|
||||||
|
if not getattr(effect_job, "execution_input_sha256", None):
|
||||||
|
raise ExecutionSnapshotError("Campaign job has no execution-input checksum; rebuild before delivery")
|
||||||
|
if effect_job.execution_input_sha256 != job_execution_input_hash(effect_job):
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"Built campaign job inputs changed after the execution snapshot was created. "
|
||||||
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
jobs = (
|
||||||
|
session.query(CampaignJob)
|
||||||
|
.filter(CampaignJob.campaign_version_id == version.id)
|
||||||
|
.order_by(CampaignJob.entry_index.asc(), CampaignJob.id.asc())
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
queueable_statuses = {JobValidationStatus.READY.value, JobValidationStatus.WARNING.value}
|
||||||
|
if snapshot.job_count != len(jobs):
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"Built campaign jobs changed after the execution snapshot was created. "
|
||||||
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
|
)
|
||||||
|
queueable_count = sum(1 for job in jobs if job.validation_status in queueable_statuses)
|
||||||
|
if (
|
||||||
|
snapshot.queueable_job_count != queueable_count
|
||||||
|
or snapshot.job_manifest_sha256 != job_manifest_hash(jobs)
|
||||||
|
or any(getattr(job, "execution_input_sha256", None) != job_execution_input_hash(job) for job in jobs)
|
||||||
|
):
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"Built campaign job inputs changed after the execution snapshot was created. "
|
||||||
|
"Revalidate and rebuild the campaign before delivery."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_execution_snapshot(
|
||||||
|
session: Session,
|
||||||
|
version: CampaignVersion,
|
||||||
|
*,
|
||||||
|
effect_job: CampaignJob | None = None,
|
||||||
|
) -> ExecutionSnapshot:
|
||||||
"""Return a validated snapshot, creating one for pre-migration builds.
|
"""Return a validated snapshot, creating one for pre-migration builds.
|
||||||
|
|
||||||
New builds create the snapshot after persisting their jobs. The fallback is
|
New builds create the snapshot after persisting their jobs. The fallback is
|
||||||
@@ -248,19 +268,46 @@ def ensure_execution_snapshot(session: Session, version: CampaignVersion) -> Exe
|
|||||||
without a manual data migration.
|
without a manual data migration.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
raw_json = version.raw_json if isinstance(version.raw_json, dict) else {}
|
||||||
|
try:
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw_json,
|
||||||
|
managed_files_available=files_integration().available,
|
||||||
|
)
|
||||||
|
except CampaignPathSecurityError as exc:
|
||||||
|
raise ExecutionSnapshotError(str(exc)) from exc
|
||||||
|
_assert_version_mail_profile_boundary(raw_json)
|
||||||
|
|
||||||
if isinstance(version.execution_snapshot, dict):
|
if isinstance(version.execution_snapshot, dict):
|
||||||
|
if str(version.execution_snapshot.get("snapshot_version") or "") != SNAPSHOT_VERSION:
|
||||||
|
raise ExecutionSnapshotError(
|
||||||
|
"This campaign has a legacy execution snapshot that may contain campaign-owned transport data. "
|
||||||
|
"It is preserved for audit only and cannot be delivered; select a Mail profile, then revalidate "
|
||||||
|
"and rebuild a new campaign version."
|
||||||
|
)
|
||||||
snapshot = ExecutionSnapshot.model_validate(version.execution_snapshot)
|
snapshot = ExecutionSnapshot.model_validate(version.execution_snapshot)
|
||||||
expected = snapshot_hash(snapshot.model_dump(mode="json"))
|
expected = snapshot_hash(snapshot.model_dump(mode="json"))
|
||||||
if version.execution_snapshot_hash and version.execution_snapshot_hash != expected:
|
if not version.execution_snapshot_hash:
|
||||||
|
raise ExecutionSnapshotError("Execution snapshot checksum is missing")
|
||||||
|
if version.execution_snapshot_hash != expected:
|
||||||
raise ExecutionSnapshotError("Execution snapshot checksum mismatch")
|
raise ExecutionSnapshotError("Execution snapshot checksum mismatch")
|
||||||
|
_assert_snapshot_profile_matches_version(version, snapshot)
|
||||||
|
_assert_snapshot_matches_persisted_inputs(
|
||||||
|
session,
|
||||||
|
version,
|
||||||
|
snapshot,
|
||||||
|
effect_job=effect_job,
|
||||||
|
)
|
||||||
return snapshot
|
return snapshot
|
||||||
|
|
||||||
from govoplan_campaign.backend.persistence.campaigns import load_version_config
|
from govoplan_campaign.backend.persistence.campaigns import load_version_config
|
||||||
|
|
||||||
_, _, config = load_version_config(session, version.id)
|
_, _, config = load_version_config(session, version.id)
|
||||||
runtime_smtp = config.server.runtime_smtp_config()
|
profile_id = campaign_mail_profile_id(raw_json)
|
||||||
if not runtime_smtp:
|
if not config.server.profile_capabilities.smtp_available:
|
||||||
raise ExecutionSnapshotError("Campaign has no SMTP configuration")
|
raise ExecutionSnapshotError("The selected Mail profile has no SMTP configuration")
|
||||||
|
if profile_id is None:
|
||||||
|
raise ExecutionSnapshotError("Campaign has no Mail profile reference")
|
||||||
jobs = (
|
jobs = (
|
||||||
session.query(CampaignJob)
|
session.query(CampaignJob)
|
||||||
.filter(CampaignJob.campaign_version_id == version.id)
|
.filter(CampaignJob.campaign_version_id == version.id)
|
||||||
@@ -269,10 +316,14 @@ def ensure_execution_snapshot(session: Session, version: CampaignVersion) -> Exe
|
|||||||
)
|
)
|
||||||
if not jobs:
|
if not jobs:
|
||||||
raise ExecutionSnapshotError("Campaign version has no built jobs; rebuild it before delivery")
|
raise ExecutionSnapshotError("Campaign version has no built jobs; rebuild it before delivery")
|
||||||
|
revisions = profile_transport_revisions(session, version)
|
||||||
|
if not revisions["smtp"]:
|
||||||
|
raise ExecutionSnapshotError("The selected Mail profile has no SMTP transport revision")
|
||||||
payload, digest = create_execution_snapshot(
|
payload, digest = create_execution_snapshot(
|
||||||
version,
|
version,
|
||||||
smtp=runtime_smtp,
|
mail_profile_id=profile_id,
|
||||||
imap=config.server.runtime_imap_config(),
|
smtp_transport_revision=revisions["smtp"],
|
||||||
|
imap_transport_revision=revisions["imap"],
|
||||||
delivery=config.delivery,
|
delivery=config.delivery,
|
||||||
jobs=jobs,
|
jobs=jobs,
|
||||||
build_summary=version.build_summary if isinstance(version.build_summary, dict) else {},
|
build_summary=version.build_summary if isinstance(version.build_summary, dict) else {},
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,8 +1,14 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import binascii
|
||||||
|
from datetime import datetime
|
||||||
|
import secrets
|
||||||
|
import stat
|
||||||
|
import struct
|
||||||
import zipfile
|
import zipfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Iterable
|
from typing import Iterable
|
||||||
|
import zlib
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import pyzipper
|
import pyzipper
|
||||||
@@ -10,6 +16,8 @@ except ImportError: # pragma: no cover
|
|||||||
pyzipper = None
|
pyzipper = None
|
||||||
|
|
||||||
ArchiveMember = tuple[Path, str]
|
ArchiveMember = tuple[Path, str]
|
||||||
|
ZIP_METHOD_AES = "aes"
|
||||||
|
ZIP_METHOD_STANDARD = "zip_standard"
|
||||||
|
|
||||||
|
|
||||||
def _normalized_members(files: Iterable[Path | ArchiveMember]) -> list[ArchiveMember]:
|
def _normalized_members(files: Iterable[Path | ArchiveMember]) -> list[ArchiveMember]:
|
||||||
@@ -33,24 +41,18 @@ def _normalized_members(files: Iterable[Path | ArchiveMember]) -> list[ArchiveMe
|
|||||||
def create_zip_archive(
|
def create_zip_archive(
|
||||||
output_path: Path,
|
output_path: Path,
|
||||||
files: Iterable[Path | ArchiveMember],
|
files: Iterable[Path | ArchiveMember],
|
||||||
password: str = "",
|
password: str = "", # nosec B107 - empty means an unencrypted archive.
|
||||||
|
method: str = ZIP_METHOD_AES,
|
||||||
) -> Path:
|
) -> Path:
|
||||||
"""Create a ZIP archive, using AES encryption when a password is supplied."""
|
"""Create a ZIP archive, optionally using AES or legacy ZipCrypto encryption."""
|
||||||
|
|
||||||
output_path.parent.mkdir(parents=True, exist_ok=True)
|
output_path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
members = _normalized_members(files)
|
members = _normalized_members(files)
|
||||||
if password:
|
if password:
|
||||||
if pyzipper is None:
|
if method == ZIP_METHOD_STANDARD:
|
||||||
raise RuntimeError("pyzipper is required for writing password-protected ZIP files")
|
_create_zipcrypto_archive(output_path, members, password)
|
||||||
with pyzipper.AESZipFile(
|
return output_path
|
||||||
output_path,
|
_create_aes_archive(output_path, members, password)
|
||||||
"w",
|
|
||||||
compression=pyzipper.ZIP_DEFLATED,
|
|
||||||
encryption=pyzipper.WZ_AES,
|
|
||||||
) as zip_file:
|
|
||||||
zip_file.setpassword(password.encode("utf-8"))
|
|
||||||
for file_path, archive_name in members:
|
|
||||||
zip_file.write(file_path, arcname=archive_name)
|
|
||||||
return output_path
|
return output_path
|
||||||
|
|
||||||
with zipfile.ZipFile(output_path, "w", compression=zipfile.ZIP_DEFLATED) as zip_file:
|
with zipfile.ZipFile(output_path, "w", compression=zipfile.ZIP_DEFLATED) as zip_file:
|
||||||
@@ -59,7 +61,214 @@ def create_zip_archive(
|
|||||||
return output_path
|
return output_path
|
||||||
|
|
||||||
|
|
||||||
def create_encrypted_zip(output_path: Path, files: list[Path], password: str) -> Path:
|
def create_encrypted_zip(output_path: Path, files: list[Path], password: str, method: str = ZIP_METHOD_AES) -> Path:
|
||||||
"""Backward-compatible wrapper for the original per-rule ZIP helper."""
|
"""Backward-compatible wrapper for the original per-rule ZIP helper."""
|
||||||
|
|
||||||
return create_zip_archive(output_path, files, password)
|
return create_zip_archive(output_path, files, password, method)
|
||||||
|
|
||||||
|
|
||||||
|
def _create_aes_archive(output_path: Path, members: list[ArchiveMember], password: str) -> None:
|
||||||
|
if pyzipper is None:
|
||||||
|
raise RuntimeError("pyzipper is required for writing AES password-protected ZIP files")
|
||||||
|
with pyzipper.AESZipFile(
|
||||||
|
output_path,
|
||||||
|
"w",
|
||||||
|
compression=pyzipper.ZIP_DEFLATED,
|
||||||
|
encryption=pyzipper.WZ_AES,
|
||||||
|
) as zip_file:
|
||||||
|
zip_file.setpassword(password.encode("utf-8"))
|
||||||
|
for file_path, archive_name in members:
|
||||||
|
zip_file.write(file_path, arcname=archive_name)
|
||||||
|
|
||||||
|
|
||||||
|
def _create_zipcrypto_archive(output_path: Path, members: list[ArchiveMember], password: str) -> None:
|
||||||
|
entries: list[_CentralDirectoryEntry] = []
|
||||||
|
password_bytes = password.encode("utf-8")
|
||||||
|
with output_path.open("wb") as zip_file:
|
||||||
|
for file_path, archive_name in members:
|
||||||
|
local_header_offset = zip_file.tell()
|
||||||
|
file_data = file_path.read_bytes()
|
||||||
|
crc = binascii.crc32(file_data) & 0xFFFFFFFF
|
||||||
|
compressed_data = _deflate(file_data)
|
||||||
|
encrypted_data = _zipcrypto_encrypt(compressed_data, password_bytes, crc)
|
||||||
|
compressed_size = len(encrypted_data)
|
||||||
|
uncompressed_size = len(file_data)
|
||||||
|
modified_at = datetime.fromtimestamp(file_path.stat().st_mtime)
|
||||||
|
dos_time, dos_date = _dos_timestamp(modified_at)
|
||||||
|
filename_bytes, flags = _filename_bytes(archive_name, encrypted=True)
|
||||||
|
|
||||||
|
zip_file.write(
|
||||||
|
struct.pack(
|
||||||
|
"<IHHHHHIIIHH",
|
||||||
|
0x04034B50,
|
||||||
|
20,
|
||||||
|
flags,
|
||||||
|
zipfile.ZIP_DEFLATED,
|
||||||
|
dos_time,
|
||||||
|
dos_date,
|
||||||
|
crc,
|
||||||
|
compressed_size,
|
||||||
|
uncompressed_size,
|
||||||
|
len(filename_bytes),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
zip_file.write(filename_bytes)
|
||||||
|
zip_file.write(encrypted_data)
|
||||||
|
entries.append(
|
||||||
|
_CentralDirectoryEntry(
|
||||||
|
filename_bytes=filename_bytes,
|
||||||
|
flags=flags,
|
||||||
|
dos_time=dos_time,
|
||||||
|
dos_date=dos_date,
|
||||||
|
crc=crc,
|
||||||
|
compressed_size=compressed_size,
|
||||||
|
uncompressed_size=uncompressed_size,
|
||||||
|
external_attributes=_external_attributes(file_path),
|
||||||
|
local_header_offset=local_header_offset,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
central_directory_offset = zip_file.tell()
|
||||||
|
for entry in entries:
|
||||||
|
zip_file.write(
|
||||||
|
struct.pack(
|
||||||
|
"<IHHHHHHIIIHHHHHII",
|
||||||
|
0x02014B50,
|
||||||
|
20,
|
||||||
|
20,
|
||||||
|
entry.flags,
|
||||||
|
zipfile.ZIP_DEFLATED,
|
||||||
|
entry.dos_time,
|
||||||
|
entry.dos_date,
|
||||||
|
entry.crc,
|
||||||
|
entry.compressed_size,
|
||||||
|
entry.uncompressed_size,
|
||||||
|
len(entry.filename_bytes),
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
entry.external_attributes,
|
||||||
|
entry.local_header_offset,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
zip_file.write(entry.filename_bytes)
|
||||||
|
|
||||||
|
central_directory_size = zip_file.tell() - central_directory_offset
|
||||||
|
zip_file.write(
|
||||||
|
struct.pack(
|
||||||
|
"<IHHHHIIH",
|
||||||
|
0x06054B50,
|
||||||
|
0,
|
||||||
|
0,
|
||||||
|
len(entries),
|
||||||
|
len(entries),
|
||||||
|
central_directory_size,
|
||||||
|
central_directory_offset,
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _CentralDirectoryEntry:
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
filename_bytes: bytes,
|
||||||
|
flags: int,
|
||||||
|
dos_time: int,
|
||||||
|
dos_date: int,
|
||||||
|
crc: int,
|
||||||
|
compressed_size: int,
|
||||||
|
uncompressed_size: int,
|
||||||
|
external_attributes: int,
|
||||||
|
local_header_offset: int,
|
||||||
|
) -> None:
|
||||||
|
self.filename_bytes = filename_bytes
|
||||||
|
self.flags = flags
|
||||||
|
self.dos_time = dos_time
|
||||||
|
self.dos_date = dos_date
|
||||||
|
self.crc = crc
|
||||||
|
self.compressed_size = compressed_size
|
||||||
|
self.uncompressed_size = uncompressed_size
|
||||||
|
self.external_attributes = external_attributes
|
||||||
|
self.local_header_offset = local_header_offset
|
||||||
|
|
||||||
|
|
||||||
|
def _deflate(data: bytes) -> bytes:
|
||||||
|
compressor = zlib.compressobj(zlib.Z_DEFAULT_COMPRESSION, zlib.DEFLATED, -zlib.MAX_WBITS)
|
||||||
|
return compressor.compress(data) + compressor.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def _zipcrypto_encrypt(data: bytes, password: bytes, crc: int) -> bytes:
|
||||||
|
cipher = _ZipCrypto(password)
|
||||||
|
header = secrets.token_bytes(11) + bytes([(crc >> 24) & 0xFF])
|
||||||
|
return cipher.encrypt(header + data)
|
||||||
|
|
||||||
|
|
||||||
|
class _ZipCrypto:
|
||||||
|
def __init__(self, password: bytes) -> None:
|
||||||
|
self.key0 = 0x12345678
|
||||||
|
self.key1 = 0x23456789
|
||||||
|
self.key2 = 0x34567890
|
||||||
|
for value in password:
|
||||||
|
self._update_keys(value)
|
||||||
|
|
||||||
|
def encrypt(self, data: bytes) -> bytes:
|
||||||
|
encrypted = bytearray()
|
||||||
|
for value in data:
|
||||||
|
encrypted.append(value ^ self._decrypt_byte())
|
||||||
|
self._update_keys(value)
|
||||||
|
return bytes(encrypted)
|
||||||
|
|
||||||
|
def _decrypt_byte(self) -> int:
|
||||||
|
temp = self.key2 | 2
|
||||||
|
return ((temp * (temp ^ 1)) >> 8) & 0xFF
|
||||||
|
|
||||||
|
def _update_keys(self, value: int) -> None:
|
||||||
|
self.key0 = _zipcrypto_crc32_byte(value, self.key0)
|
||||||
|
self.key1 = (self.key1 + (self.key0 & 0xFF)) & 0xFFFFFFFF
|
||||||
|
self.key1 = (self.key1 * 134775813 + 1) & 0xFFFFFFFF
|
||||||
|
self.key2 = _zipcrypto_crc32_byte((self.key1 >> 24) & 0xFF, self.key2)
|
||||||
|
|
||||||
|
|
||||||
|
def _build_zipcrypto_crc(value: int) -> int:
|
||||||
|
for _ in range(8):
|
||||||
|
if value & 1:
|
||||||
|
value = 0xEDB88320 ^ (value >> 1)
|
||||||
|
else:
|
||||||
|
value >>= 1
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
_ZIPCRYPTO_CRC_TABLE = [_build_zipcrypto_crc(value) for value in range(256)]
|
||||||
|
|
||||||
|
|
||||||
|
def _zipcrypto_crc32_byte(value: int, crc: int) -> int:
|
||||||
|
return ((crc >> 8) ^ _ZIPCRYPTO_CRC_TABLE[(crc ^ value) & 0xFF]) & 0xFFFFFFFF
|
||||||
|
|
||||||
|
|
||||||
|
def _filename_bytes(filename: str, *, encrypted: bool) -> tuple[bytes, int]:
|
||||||
|
flags = 0x1 if encrypted else 0
|
||||||
|
try:
|
||||||
|
return filename.encode("ascii"), flags
|
||||||
|
except UnicodeEncodeError:
|
||||||
|
return filename.encode("utf-8"), flags | 0x800
|
||||||
|
|
||||||
|
|
||||||
|
def _dos_timestamp(value: datetime) -> tuple[int, int]:
|
||||||
|
year = min(max(value.year, 1980), 2107)
|
||||||
|
month = value.month if value.year == year else 1
|
||||||
|
day = value.day if value.year == year else 1
|
||||||
|
dos_time = value.hour << 11 | value.minute << 5 | value.second // 2
|
||||||
|
dos_date = (year - 1980) << 9 | month << 5 | day
|
||||||
|
return dos_time, dos_date
|
||||||
|
|
||||||
|
|
||||||
|
def _external_attributes(path: Path) -> int:
|
||||||
|
try:
|
||||||
|
permissions = stat.S_IMODE(path.stat().st_mode)
|
||||||
|
except OSError:
|
||||||
|
return 0
|
||||||
|
return permissions << 16
|
||||||
|
|||||||
55
src/govoplan_campaign/backend/template_rendering.py
Normal file
55
src/govoplan_campaign/backend/template_rendering.py
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import re
|
||||||
|
from collections.abc import Mapping
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
|
||||||
|
_DOLLAR_FIELD_PATTERN = re.compile(r"(?<!\\)\$\{(.*?)(?<!\\)\}")
|
||||||
|
_BRACE_FIELD_PATTERN = re.compile(r"(?<!\\)\{\{\s*(.*?)\s*\}\}")
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_template_key(raw: str) -> str:
|
||||||
|
key = raw.strip()
|
||||||
|
if key.startswith("fields."):
|
||||||
|
key = key.removeprefix("fields.")
|
||||||
|
elif key.startswith("local."):
|
||||||
|
key = "local::" + key.removeprefix("local.")
|
||||||
|
elif key.startswith("global."):
|
||||||
|
key = "global::" + key.removeprefix("global.")
|
||||||
|
|
||||||
|
if key.startswith("local::") or key.startswith("global::"):
|
||||||
|
return key
|
||||||
|
if key.startswith("local:"):
|
||||||
|
return "local::" + key.removeprefix("local:")
|
||||||
|
if key.startswith("global:"):
|
||||||
|
return "global::" + key.removeprefix("global:")
|
||||||
|
return key
|
||||||
|
|
||||||
|
|
||||||
|
def render_template(
|
||||||
|
template: str,
|
||||||
|
values: Mapping[str, Any],
|
||||||
|
*,
|
||||||
|
keep_missing: bool = True,
|
||||||
|
) -> str:
|
||||||
|
def replace(match: re.Match[str]) -> str:
|
||||||
|
key = normalize_template_key(match.group(1))
|
||||||
|
if key in values:
|
||||||
|
value = values[key]
|
||||||
|
return "" if value is None else str(value)
|
||||||
|
return match.group(0) if keep_missing else ""
|
||||||
|
|
||||||
|
rendered = _DOLLAR_FIELD_PATTERN.sub(replace, template)
|
||||||
|
rendered = _BRACE_FIELD_PATTERN.sub(replace, rendered)
|
||||||
|
return rendered.replace(r"\${", "${").replace(r"\}", "}")
|
||||||
|
|
||||||
|
|
||||||
|
def find_unresolved_placeholders(text: str | None) -> set[str]:
|
||||||
|
if not text:
|
||||||
|
return set()
|
||||||
|
return {
|
||||||
|
normalize_template_key(match.group(1))
|
||||||
|
for pattern in (_DOLLAR_FIELD_PATTERN, _BRACE_FIELD_PATTERN)
|
||||||
|
for match in pattern.finditer(text)
|
||||||
|
}
|
||||||
103
tests/test_access_provider.py
Normal file
103
tests/test_access_provider.py
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from sqlalchemy import create_engine
|
||||||
|
from sqlalchemy.orm import sessionmaker
|
||||||
|
|
||||||
|
from govoplan_access.backend.db.models import Account, Group, User
|
||||||
|
from govoplan_campaign.backend.capabilities import CampaignAccessService
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign, CampaignShare
|
||||||
|
from govoplan_core.core.access import PrincipalRef
|
||||||
|
from govoplan_core.db.base import Base
|
||||||
|
|
||||||
|
|
||||||
|
TENANT_ID = "tenant-1"
|
||||||
|
USER_ID = "user-1"
|
||||||
|
OTHER_USER_ID = "user-2"
|
||||||
|
GROUP_ID = "group-1"
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignAccessProviderTests(unittest.TestCase):
|
||||||
|
def test_campaign_access_provider_explains_owner_share_admin_and_missing_resources(self) -> None:
|
||||||
|
session = _session()
|
||||||
|
self.addCleanup(_close_session, session)
|
||||||
|
_seed_access_subjects(session)
|
||||||
|
owned = Campaign(id="campaign-owned", tenant_id=TENANT_ID, owner_user_id=USER_ID, external_id="owned", name="Owned campaign")
|
||||||
|
shared = Campaign(id="campaign-shared", tenant_id=TENANT_ID, owner_user_id=OTHER_USER_ID, external_id="shared", name="Shared campaign")
|
||||||
|
session.add_all([
|
||||||
|
owned,
|
||||||
|
shared,
|
||||||
|
CampaignShare(id="share-group", tenant_id=TENANT_ID, campaign_id=shared.id, target_type="group", target_id=GROUP_ID, permission="read"),
|
||||||
|
])
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
service = CampaignAccessService()
|
||||||
|
owned_items = service.explain_resource_provenance(session, _principal(), resource_type="campaign", resource_id=owned.id, action="campaigns:campaign:read")
|
||||||
|
shared_items = service.explain_resource_provenance(session, _principal(group_ids={GROUP_ID}), resource_type="campaign", resource_id=shared.id, action="campaigns:campaign:read")
|
||||||
|
admin_items = service.explain_resource_provenance(session, _principal(scopes={"tenant:*"}), resource_type="campaign", resource_id=shared.id, action="campaigns:campaign:read")
|
||||||
|
missing_items = service.explain_resource_provenance(session, _principal(), resource_type="campaign", resource_id="missing-campaign", action="campaigns:campaign:read")
|
||||||
|
|
||||||
|
self.assertTrue(any(item.kind == "resource" and item.source == "campaigns.campaign" and item.id == owned.id for item in owned_items))
|
||||||
|
self.assertTrue(any(item.kind == "owner" and item.id == USER_ID for item in owned_items))
|
||||||
|
self.assertTrue(any(item.kind == "share" and item.id == "share-group" for item in shared_items))
|
||||||
|
self.assertTrue(any(item.kind == "policy" and item.id == "tenant:*" for item in admin_items))
|
||||||
|
self.assertEqual("campaigns.not_found", missing_items[0].source)
|
||||||
|
self.assertIs(missing_items[0].details["found"], False)
|
||||||
|
|
||||||
|
def test_campaign_access_provider_requires_write_share_for_write_actions(self) -> None:
|
||||||
|
session = _session()
|
||||||
|
self.addCleanup(_close_session, session)
|
||||||
|
_seed_access_subjects(session)
|
||||||
|
campaign = Campaign(id="campaign-write", tenant_id=TENANT_ID, owner_user_id=OTHER_USER_ID, external_id="write", name="Write campaign")
|
||||||
|
session.add_all([
|
||||||
|
campaign,
|
||||||
|
CampaignShare(id="share-read", tenant_id=TENANT_ID, campaign_id=campaign.id, target_type="group", target_id=GROUP_ID, permission="read"),
|
||||||
|
CampaignShare(id="share-write", tenant_id=TENANT_ID, campaign_id=campaign.id, target_type="user", target_id=USER_ID, permission="write"),
|
||||||
|
])
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
service = CampaignAccessService()
|
||||||
|
items = service.explain_resource_provenance(
|
||||||
|
session,
|
||||||
|
_principal(group_ids={GROUP_ID}),
|
||||||
|
resource_type="campaign",
|
||||||
|
resource_id=campaign.id,
|
||||||
|
action="campaigns:campaign:update",
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertTrue(any(item.kind == "share" and item.id == "share-write" for item in items))
|
||||||
|
self.assertFalse(any(item.kind == "share" and item.id == "share-read" for item in items))
|
||||||
|
|
||||||
|
|
||||||
|
def _session():
|
||||||
|
engine = create_engine("sqlite:///:memory:", future=True)
|
||||||
|
Base.metadata.create_all(bind=engine, tables=[Account.__table__, User.__table__, Group.__table__, Campaign.__table__, CampaignShare.__table__])
|
||||||
|
return sessionmaker(bind=engine, future=True)()
|
||||||
|
|
||||||
|
|
||||||
|
def _close_session(session) -> None:
|
||||||
|
engine = session.get_bind()
|
||||||
|
session.close()
|
||||||
|
engine.dispose()
|
||||||
|
|
||||||
|
|
||||||
|
def _seed_access_subjects(session) -> None:
|
||||||
|
session.add_all([
|
||||||
|
Account(id="account-1", email="one@example.test", normalized_email="one@example.test"),
|
||||||
|
Account(id="account-2", email="two@example.test", normalized_email="two@example.test"),
|
||||||
|
User(id=USER_ID, tenant_id=TENANT_ID, account_id="account-1", email="one@example.test"),
|
||||||
|
User(id=OTHER_USER_ID, tenant_id=TENANT_ID, account_id="account-2", email="two@example.test"),
|
||||||
|
Group(id=GROUP_ID, tenant_id=TENANT_ID, slug="group", name="Group"),
|
||||||
|
])
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
|
||||||
|
def _principal(*, scopes: set[str] | None = None, group_ids: set[str] | None = None) -> PrincipalRef:
|
||||||
|
return PrincipalRef(
|
||||||
|
account_id="account-1",
|
||||||
|
membership_id=USER_ID,
|
||||||
|
tenant_id=TENANT_ID,
|
||||||
|
scopes=frozenset(scopes or {"campaigns:campaign:read"}),
|
||||||
|
group_ids=frozenset(group_ids or set()),
|
||||||
|
)
|
||||||
245
tests/test_aggregate_report.py
Normal file
245
tests/test_aggregate_report.py
Normal file
@@ -0,0 +1,245 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import UTC, datetime, timedelta
|
||||||
|
from types import SimpleNamespace
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.report_privacy_policy import (
|
||||||
|
CampaignReportPrivacyPolicy,
|
||||||
|
CampaignReportPrivacyPolicyError,
|
||||||
|
DEFAULT_SMALL_CELL_THRESHOLD,
|
||||||
|
effective_campaign_report_privacy_policy,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.reports.aggregate import build_aggregate_campaign_report
|
||||||
|
|
||||||
|
|
||||||
|
class _PolicySession:
|
||||||
|
def __init__(self, settings: dict[str, object] | None = None) -> None:
|
||||||
|
self.tenant = SimpleNamespace(settings=settings or {})
|
||||||
|
|
||||||
|
def get(self, _model, _id):
|
||||||
|
return self.tenant
|
||||||
|
|
||||||
|
|
||||||
|
def _policy(threshold: int = 5) -> CampaignReportPrivacyPolicy:
|
||||||
|
return CampaignReportPrivacyPolicy(
|
||||||
|
small_cell_threshold=threshold,
|
||||||
|
source="test",
|
||||||
|
deployment_small_cell_threshold=threshold,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign() -> SimpleNamespace:
|
||||||
|
now = datetime(2026, 7, 22, 8, 0, tzinfo=UTC)
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="campaign-safe",
|
||||||
|
tenant_id="tenant-safe",
|
||||||
|
external_id="must-not-leak-external-id",
|
||||||
|
name="Semester notification",
|
||||||
|
description="Business-safe description",
|
||||||
|
status="partially_completed",
|
||||||
|
owner_user_id="must-not-leak-owner",
|
||||||
|
current_version_id="must-not-leak-version-id",
|
||||||
|
updated_at=now,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _version(*, inactive_count: int = 0) -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="must-not-leak-version-id",
|
||||||
|
version_number=7,
|
||||||
|
build_summary={"inactive_count": inactive_count, "build_token": "must-not-leak-token"},
|
||||||
|
execution_snapshot={"smtp": {"password": "must-not-leak-secret"}},
|
||||||
|
raw_json={"entries": [{"email": "must-not-leak@example.test"}]},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _job(index: int, send_status: str, **overrides: object) -> SimpleNamespace:
|
||||||
|
started = datetime(2026, 7, 22, 8, 0, tzinfo=UTC) + timedelta(minutes=index)
|
||||||
|
values: dict[str, object] = {
|
||||||
|
"id": f"job-{index}",
|
||||||
|
"recipient_email": f"private-{index}@example.test",
|
||||||
|
"subject": f"Personal subject {index}",
|
||||||
|
"last_error": "smtp.internal.example provider-secret",
|
||||||
|
"resolved_attachments": [{"storage_key": f"private/{index}"}],
|
||||||
|
"send_status": send_status,
|
||||||
|
"validation_status": "ready",
|
||||||
|
"build_status": "built",
|
||||||
|
"queued_at": started,
|
||||||
|
"smtp_started_at": started,
|
||||||
|
"sent_at": started if send_status in {"smtp_accepted", "sent"} else None,
|
||||||
|
"outcome_unknown_at": started if send_status == "outcome_unknown" else None,
|
||||||
|
}
|
||||||
|
values.update(overrides)
|
||||||
|
return SimpleNamespace(**values)
|
||||||
|
|
||||||
|
|
||||||
|
def test_aggregate_projection_has_a_strict_recipient_free_shape() -> None:
|
||||||
|
jobs = [
|
||||||
|
*[_job(index, "smtp_accepted") for index in range(10)],
|
||||||
|
*[_job(index + 10, "failed_permanent") for index in range(5)],
|
||||||
|
]
|
||||||
|
|
||||||
|
payload = build_aggregate_campaign_report(
|
||||||
|
campaign=_campaign(), # type: ignore[arg-type]
|
||||||
|
version=_version(inactive_count=5), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=_policy(),
|
||||||
|
generated_at=datetime(2026, 7, 22, 12, 0, tzinfo=UTC),
|
||||||
|
).model_dump(mode="json")
|
||||||
|
|
||||||
|
assert set(payload) == {
|
||||||
|
"generated_at",
|
||||||
|
"campaign",
|
||||||
|
"version_number",
|
||||||
|
"completion_state",
|
||||||
|
"population",
|
||||||
|
"outcomes",
|
||||||
|
"time_range",
|
||||||
|
"privacy",
|
||||||
|
}
|
||||||
|
assert set(payload["campaign"]) == {"id", "name", "status"}
|
||||||
|
assert payload["population"]["denominator"] == {"value": 15, "suppressed": False}
|
||||||
|
assert payload["outcomes"]["smtp_accepted"] == {"value": 10, "suppressed": False}
|
||||||
|
assert payload["outcomes"]["failed"] == {"value": 5, "suppressed": False}
|
||||||
|
assert payload["completion_state"] == "partially_completed"
|
||||||
|
serialized = repr(payload)
|
||||||
|
for forbidden in (
|
||||||
|
"private-0@example.test",
|
||||||
|
"Personal subject",
|
||||||
|
"smtp.internal.example",
|
||||||
|
"provider-secret",
|
||||||
|
"storage_key",
|
||||||
|
"must-not-leak",
|
||||||
|
"Business-safe description",
|
||||||
|
"job-0",
|
||||||
|
):
|
||||||
|
assert forbidden not in serialized
|
||||||
|
|
||||||
|
|
||||||
|
def test_small_cells_use_primary_and_complementary_suppression() -> None:
|
||||||
|
jobs = [
|
||||||
|
*[_job(index, "smtp_accepted") for index in range(8)],
|
||||||
|
_job(8, "failed_permanent"),
|
||||||
|
]
|
||||||
|
|
||||||
|
report = build_aggregate_campaign_report(
|
||||||
|
campaign=_campaign(), # type: ignore[arg-type]
|
||||||
|
version=_version(inactive_count=1), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=_policy(5),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert report.population.denominator.value == 9
|
||||||
|
assert report.outcomes.failed.suppressed is True
|
||||||
|
assert report.outcomes.failed.value is None
|
||||||
|
assert report.outcomes.smtp_accepted.suppressed is True
|
||||||
|
assert report.outcomes.smtp_accepted.value is None
|
||||||
|
assert report.population.inactive_source_entries.suppressed is True
|
||||||
|
assert report.time_range.suppressed is True
|
||||||
|
assert report.privacy.suppression_applied is True
|
||||||
|
|
||||||
|
|
||||||
|
def test_outcome_suppression_also_hides_overlapping_population_count() -> None:
|
||||||
|
jobs = [
|
||||||
|
*[
|
||||||
|
_job(
|
||||||
|
index,
|
||||||
|
"smtp_accepted",
|
||||||
|
validation_status="blocked" if index < 4 else "ready",
|
||||||
|
)
|
||||||
|
for index in range(8)
|
||||||
|
],
|
||||||
|
_job(8, "skipped", validation_status="excluded"),
|
||||||
|
]
|
||||||
|
|
||||||
|
report = build_aggregate_campaign_report(
|
||||||
|
campaign=_campaign(), # type: ignore[arg-type]
|
||||||
|
version=_version(inactive_count=5), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=_policy(5),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert report.outcomes.excluded.suppressed is True
|
||||||
|
assert report.population.excluded_or_blocked_jobs.model_dump() == {
|
||||||
|
"value": None,
|
||||||
|
"suppressed": True,
|
||||||
|
}
|
||||||
|
# Source entries without jobs are outside the outcome denominator and do
|
||||||
|
# not overlap the suppressed partition, so their threshold-safe count stays visible.
|
||||||
|
assert report.population.inactive_source_entries.model_dump() == {
|
||||||
|
"value": 5,
|
||||||
|
"suppressed": False,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_all_small_cells_also_suppress_the_denominator_and_state() -> None:
|
||||||
|
jobs = [_job(0, "smtp_accepted"), _job(1, "failed_permanent")]
|
||||||
|
|
||||||
|
report = build_aggregate_campaign_report(
|
||||||
|
campaign=_campaign(), # type: ignore[arg-type]
|
||||||
|
version=_version(), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=_policy(5),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert report.population.denominator.model_dump() == {"value": None, "suppressed": True}
|
||||||
|
assert report.completion_state == "suppressed"
|
||||||
|
assert report.outcomes.smtp_accepted.value is None
|
||||||
|
assert report.outcomes.failed.value is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_explicitly_skipped_jobs_are_exclusions_not_unattempted_outcomes() -> None:
|
||||||
|
jobs = [_job(index, "skipped") for index in range(5)]
|
||||||
|
|
||||||
|
report = build_aggregate_campaign_report(
|
||||||
|
campaign=_campaign(), # type: ignore[arg-type]
|
||||||
|
version=_version(), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=_policy(5),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert report.outcomes.excluded.value == 5
|
||||||
|
assert report.outcomes.not_attempted.value == 0
|
||||||
|
assert report.completion_state == "not_started"
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_privacy_policy_defaults_to_five_and_tenant_can_only_strengthen() -> None:
|
||||||
|
default = effective_campaign_report_privacy_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={},
|
||||||
|
)
|
||||||
|
assert default.small_cell_threshold == DEFAULT_SMALL_CELL_THRESHOLD == 5
|
||||||
|
assert default.source == "deployment_default"
|
||||||
|
|
||||||
|
strengthened = effective_campaign_report_privacy_policy(
|
||||||
|
_PolicySession(
|
||||||
|
{"campaign_report_privacy_policy": {"small_cell_threshold": 10}}
|
||||||
|
), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_REPORT_SMALL_CELL_THRESHOLD": "5"},
|
||||||
|
)
|
||||||
|
assert strengthened.small_cell_threshold == 10
|
||||||
|
assert strengthened.source == "tenant"
|
||||||
|
|
||||||
|
floor = effective_campaign_report_privacy_policy(
|
||||||
|
_PolicySession(
|
||||||
|
{"campaign_report_privacy_policy": {"small_cell_threshold": 3}}
|
||||||
|
), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_REPORT_SMALL_CELL_THRESHOLD": "7"},
|
||||||
|
)
|
||||||
|
assert floor.small_cell_threshold == 7
|
||||||
|
assert floor.source == "deployment_floor"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("value", [True, 0, 1, 101, "2.5", "disabled"])
|
||||||
|
def test_invalid_report_privacy_policy_fails_closed(value: object) -> None:
|
||||||
|
with pytest.raises(CampaignReportPrivacyPolicyError):
|
||||||
|
effective_campaign_report_privacy_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_REPORT_SMALL_CELL_THRESHOLD": value}, # type: ignore[dict-item]
|
||||||
|
)
|
||||||
199
tests/test_aggregate_report_routes.py
Normal file
199
tests/test_aggregate_report_routes.py
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi import HTTPException
|
||||||
|
from sqlalchemy import create_engine
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_access.backend.db.models import Account, Group, User
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign, CampaignJob, CampaignVersion
|
||||||
|
from govoplan_campaign.backend.reports.aggregate import (
|
||||||
|
AggregateCampaignReportError,
|
||||||
|
generate_aggregate_campaign_report,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.schemas import ReportEmailRequest
|
||||||
|
from govoplan_core.core.change_sequence import ChangeSequenceEntry
|
||||||
|
from govoplan_core.db.base import Base
|
||||||
|
from govoplan_core.tenancy.scope import Tenant, create_scope_tables
|
||||||
|
|
||||||
|
|
||||||
|
class _Principal:
|
||||||
|
def __init__(self, *scopes: str, tenant_id: str = "tenant-1") -> None:
|
||||||
|
self.scopes = set(scopes)
|
||||||
|
self.tenant_id = tenant_id
|
||||||
|
self.user = SimpleNamespace(id="reader-1")
|
||||||
|
|
||||||
|
def has(self, scope: str) -> bool:
|
||||||
|
return scope in self.scopes
|
||||||
|
|
||||||
|
|
||||||
|
def test_full_report_and_job_detail_reject_aggregate_only_principal() -> None:
|
||||||
|
principal = _Principal("campaigns:report:read")
|
||||||
|
session = Mock()
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", tenant_id="tenant-1")
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
pytest.raises(HTTPException) as full_report_denied,
|
||||||
|
):
|
||||||
|
router.campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
assert full_report_denied.value.status_code == 403
|
||||||
|
assert "campaigns:recipient:read" in full_report_denied.value.detail
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
pytest.raises(HTTPException) as job_detail_denied,
|
||||||
|
):
|
||||||
|
router.get_job_detail(
|
||||||
|
"campaign-1",
|
||||||
|
"job-1",
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
assert job_detail_denied.value.status_code == 403
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
pytest.raises(HTTPException) as report_email_denied,
|
||||||
|
):
|
||||||
|
router.email_campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
ReportEmailRequest(to=["auditor@example.test"]),
|
||||||
|
session=session,
|
||||||
|
principal=_Principal("campaigns:report:send"), # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
assert report_email_denied.value.status_code == 403
|
||||||
|
assert "campaigns:recipient:export" in report_email_denied.value.detail
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
pytest.raises(HTTPException) as diagnostics_denied,
|
||||||
|
):
|
||||||
|
router.get_job_diagnostics(
|
||||||
|
"campaign-1",
|
||||||
|
"job-1",
|
||||||
|
session=session,
|
||||||
|
principal=_Principal("campaigns:diagnostic:read"), # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
assert diagnostics_denied.value.status_code == 403
|
||||||
|
assert "campaigns:recipient:read" in diagnostics_denied.value.detail
|
||||||
|
|
||||||
|
|
||||||
|
def test_aggregate_route_uses_only_the_safe_projection() -> None:
|
||||||
|
principal = _Principal("campaigns:report:read")
|
||||||
|
session = Mock()
|
||||||
|
safe_projection = Mock()
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal") as acl,
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"generate_aggregate_campaign_report",
|
||||||
|
return_value=safe_projection,
|
||||||
|
) as generate,
|
||||||
|
):
|
||||||
|
result = router.aggregate_campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result is safe_projection
|
||||||
|
acl.assert_called_once_with(session, "campaign-1", principal)
|
||||||
|
generate.assert_called_once_with(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("path", ["/campaigns/aggregate-reports", "/campaigns/aggregate-reports/{campaign_id}"])
|
||||||
|
def test_aggregate_routes_require_report_read_permission(path: str) -> None:
|
||||||
|
route = next(item for item in router.router.routes if item.path == path)
|
||||||
|
dependency = next(item for item in route.dependant.dependencies if item.name == "principal")
|
||||||
|
|
||||||
|
with pytest.raises(HTTPException) as denied:
|
||||||
|
dependency.call(_Principal())
|
||||||
|
assert denied.value.status_code == 403
|
||||||
|
|
||||||
|
principal = _Principal("campaigns:report:read")
|
||||||
|
assert dependency.call(principal) is principal
|
||||||
|
|
||||||
|
|
||||||
|
def test_aggregate_projection_is_tenant_isolated_and_needs_no_optional_module() -> None:
|
||||||
|
engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||||
|
create_scope_tables(engine)
|
||||||
|
Base.metadata.create_all(
|
||||||
|
engine,
|
||||||
|
tables=[
|
||||||
|
Account.__table__,
|
||||||
|
User.__table__,
|
||||||
|
Group.__table__,
|
||||||
|
Campaign.__table__,
|
||||||
|
CampaignVersion.__table__,
|
||||||
|
CampaignJob.__table__,
|
||||||
|
ChangeSequenceEntry.__table__,
|
||||||
|
],
|
||||||
|
)
|
||||||
|
with Session(engine) as session:
|
||||||
|
session.add(Tenant(id="tenant-1", slug="tenant-1", name="Tenant 1", settings={}))
|
||||||
|
campaign = Campaign(
|
||||||
|
id="campaign-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
external_id="external-1",
|
||||||
|
name="Safe aggregate",
|
||||||
|
description=None,
|
||||||
|
status="sent",
|
||||||
|
)
|
||||||
|
version = CampaignVersion(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
version_number=1,
|
||||||
|
raw_json={"mail": {"profile_id": "optional-module-not-loaded"}},
|
||||||
|
schema_version="5",
|
||||||
|
build_summary={},
|
||||||
|
)
|
||||||
|
campaign.current_version_id = version.id
|
||||||
|
session.add_all([campaign, version])
|
||||||
|
for index in range(5):
|
||||||
|
session.add(CampaignJob(
|
||||||
|
id=f"job-{index}",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id=campaign.id,
|
||||||
|
campaign_version_id=version.id,
|
||||||
|
entry_index=index,
|
||||||
|
recipient_email=f"private-{index}@example.test",
|
||||||
|
subject="Private",
|
||||||
|
build_status="built",
|
||||||
|
validation_status="ready",
|
||||||
|
queue_status="queued",
|
||||||
|
send_status="smtp_accepted",
|
||||||
|
imap_status="not_requested",
|
||||||
|
))
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
report = generate_aggregate_campaign_report(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
assert report.population.denominator.value == 5
|
||||||
|
assert report.outcomes.smtp_accepted.value == 5
|
||||||
|
|
||||||
|
with pytest.raises(AggregateCampaignReportError):
|
||||||
|
generate_aggregate_campaign_report(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-2",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
engine.dispose()
|
||||||
215
tests/test_attachment_building.py
Normal file
215
tests/test_attachment_building.py
Normal file
@@ -0,0 +1,215 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import io
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
import zipfile
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
||||||
|
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
||||||
|
from govoplan_campaign.backend.messages.builder import build_campaign_messages
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignAttachmentBuildTests(unittest.TestCase):
|
||||||
|
def _no_attachment_config(
|
||||||
|
self,
|
||||||
|
behavior: str | None = None,
|
||||||
|
legacy_allow: bool | None = None,
|
||||||
|
*,
|
||||||
|
configure_missing_rule: bool = False,
|
||||||
|
) -> CampaignConfig:
|
||||||
|
attachments: dict[str, object] = {
|
||||||
|
"base_path": ".",
|
||||||
|
"global": [],
|
||||||
|
"zip": {"enabled": False, "archives": []},
|
||||||
|
}
|
||||||
|
if configure_missing_rule:
|
||||||
|
attachments["global"] = [
|
||||||
|
{
|
||||||
|
"id": "missing",
|
||||||
|
"label": "Missing attachment",
|
||||||
|
"base_dir": ".",
|
||||||
|
"file_filter": "missing.pdf",
|
||||||
|
"required": False,
|
||||||
|
"missing_behavior": "continue",
|
||||||
|
}
|
||||||
|
]
|
||||||
|
if behavior is not None:
|
||||||
|
attachments["send_without_attachments_behavior"] = behavior
|
||||||
|
if legacy_allow is not None:
|
||||||
|
attachments["send_without_attachments"] = legacy_allow
|
||||||
|
return CampaignConfig.model_validate({
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": f"no-attachment-{behavior or legacy_allow}", "name": "No attachment policy", "mode": "test"},
|
||||||
|
"fields": [],
|
||||||
|
"global_values": {},
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"profile_capabilities": {"smtp_available": True},
|
||||||
|
},
|
||||||
|
"recipients": {"from": {"email": "sender@example.org", "type": "to"}, "allow_individual_to": True},
|
||||||
|
"template": {"subject": "Subject", "text": "Body"},
|
||||||
|
"attachments": attachments,
|
||||||
|
"entries": {"inline": [{"id": "recipient-1", "to": [{"email": "recipient@example.org", "type": "to"}]}]},
|
||||||
|
"validation_policy": {"missing_email": "block", "template_error": "block"},
|
||||||
|
"delivery": {"imap_append_sent": {"enabled": False}},
|
||||||
|
})
|
||||||
|
|
||||||
|
def test_send_without_attachments_policy_does_not_block_when_no_rules_are_configured(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
campaign_file = root / "campaign.json"
|
||||||
|
campaign_file.write_text("{}", encoding="utf-8")
|
||||||
|
config = self._no_attachment_config(legacy_allow=False)
|
||||||
|
|
||||||
|
validation = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
self.assertTrue(validation.ok)
|
||||||
|
self.assertNotIn("missing_attachment_coverage", {issue.code for issue in validation.issues})
|
||||||
|
|
||||||
|
result = build_campaign_messages(config, campaign_file=campaign_file, output_dir=root / "out", write_eml=True)
|
||||||
|
self.assertEqual(result.report.build_failed_count, 0)
|
||||||
|
self.assertEqual(result.report.queueable_count, 1)
|
||||||
|
message = result.report.messages[0]
|
||||||
|
self.assertEqual(message.attachment_count, 0)
|
||||||
|
self.assertIsNotNone(message.eml_path)
|
||||||
|
self.assertNotIn("missing_attachment_coverage", {issue.code for issue in message.issues})
|
||||||
|
self.assertIsNotNone(result.built_messages[0].mime)
|
||||||
|
|
||||||
|
def test_configured_attachment_rule_blocks_generation_when_no_files_resolve(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
campaign_file = root / "campaign.json"
|
||||||
|
campaign_file.write_text("{}", encoding="utf-8")
|
||||||
|
config = self._no_attachment_config(behavior="block", configure_missing_rule=True)
|
||||||
|
|
||||||
|
validation = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
self.assertFalse(validation.ok)
|
||||||
|
self.assertIn("missing_attachment_coverage", {issue.code for issue in validation.issues})
|
||||||
|
|
||||||
|
result = build_campaign_messages(config, campaign_file=campaign_file, output_dir=root / "out", write_eml=True)
|
||||||
|
self.assertEqual(result.report.build_failed_count, 1)
|
||||||
|
self.assertEqual(result.report.queueable_count, 0)
|
||||||
|
message = result.report.messages[0]
|
||||||
|
self.assertEqual(message.attachment_count, 0)
|
||||||
|
self.assertIsNone(message.eml_path)
|
||||||
|
self.assertIn("missing_attachment_coverage", {issue.code for issue in message.issues})
|
||||||
|
self.assertIsNone(result.built_messages[0].mime)
|
||||||
|
|
||||||
|
def test_send_without_attachments_behavior_modes(self) -> None:
|
||||||
|
cases = {
|
||||||
|
"block": ("build_failed", "blocked", 0, "block", False),
|
||||||
|
"ask": ("built", "needs_review", 0, "ask", True),
|
||||||
|
"drop": ("built", "excluded", 0, "drop", True),
|
||||||
|
"warn": ("built", "warning", 1, "warn", True),
|
||||||
|
"continue": ("built", "ready", 1, None, True),
|
||||||
|
}
|
||||||
|
for behavior, (build_status, validation_status, queueable_count, issue_behavior, has_mime) in cases.items():
|
||||||
|
with self.subTest(behavior=behavior):
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
campaign_file = root / "campaign.json"
|
||||||
|
campaign_file.write_text("{}", encoding="utf-8")
|
||||||
|
config = self._no_attachment_config(behavior=behavior, configure_missing_rule=True)
|
||||||
|
|
||||||
|
validation = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
if behavior == "block":
|
||||||
|
self.assertFalse(validation.ok)
|
||||||
|
else:
|
||||||
|
self.assertTrue(validation.ok)
|
||||||
|
|
||||||
|
result = build_campaign_messages(config, campaign_file=campaign_file, output_dir=root / "out", write_eml=True)
|
||||||
|
self.assertEqual(result.report.queueable_count, queueable_count)
|
||||||
|
message = result.report.messages[0]
|
||||||
|
self.assertEqual(message.build_status.value, build_status)
|
||||||
|
self.assertEqual(message.validation_status.value, validation_status)
|
||||||
|
if validation_status == "excluded":
|
||||||
|
self.assertEqual(message.send_status.value, "skipped")
|
||||||
|
self.assertEqual(message.imap_status.value, "skipped")
|
||||||
|
coverage_issues = [issue for issue in message.issues if issue.code == "missing_attachment_coverage"]
|
||||||
|
if issue_behavior is None:
|
||||||
|
self.assertEqual(coverage_issues, [])
|
||||||
|
else:
|
||||||
|
self.assertEqual(coverage_issues[0].behavior, issue_behavior)
|
||||||
|
self.assertEqual(result.built_messages[0].mime is not None, has_mime)
|
||||||
|
|
||||||
|
def test_missing_pattern_does_not_create_zip_member_or_count_as_attachment(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
documents = root / "documents"
|
||||||
|
documents.mkdir()
|
||||||
|
(documents / "matched.xlsx").write_bytes(b"matched workbook")
|
||||||
|
campaign_file = root / "campaign.json"
|
||||||
|
campaign_file.write_text("{}", encoding="utf-8")
|
||||||
|
config = CampaignConfig.model_validate({
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "zip-missing-pattern", "name": "ZIP missing pattern", "mode": "test"},
|
||||||
|
"fields": [],
|
||||||
|
"global_values": {},
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"profile_capabilities": {"smtp_available": True},
|
||||||
|
},
|
||||||
|
"recipients": {"from": {"email": "sender@example.org", "type": "to"}, "allow_individual_to": True},
|
||||||
|
"template": {"subject": "Subject", "text": "Body"},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": ".",
|
||||||
|
"allow_individual": True,
|
||||||
|
"send_without_attachments": False,
|
||||||
|
"zip": {
|
||||||
|
"enabled": True,
|
||||||
|
"archives": [{"id": "bundle", "name": "recipient-bundle.zip", "standard": True}],
|
||||||
|
},
|
||||||
|
"global": [],
|
||||||
|
},
|
||||||
|
"entries": {
|
||||||
|
"inline": [{
|
||||||
|
"id": "recipient-1",
|
||||||
|
"to": [{"email": "recipient@example.org", "type": "to"}],
|
||||||
|
"attachments": [
|
||||||
|
{"id": "matched", "base_dir": "documents", "file_filter": "matched.xlsx", "required": True},
|
||||||
|
{
|
||||||
|
"id": "missing",
|
||||||
|
"base_dir": "documents",
|
||||||
|
"file_filter": "missing.xlsx",
|
||||||
|
"required": False,
|
||||||
|
"missing_behavior": "warn",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}]
|
||||||
|
},
|
||||||
|
"validation_policy": {
|
||||||
|
"missing_email": "block",
|
||||||
|
"template_error": "block",
|
||||||
|
"missing_optional_attachment": "warn",
|
||||||
|
},
|
||||||
|
"delivery": {"imap_append_sent": {"enabled": False}},
|
||||||
|
})
|
||||||
|
|
||||||
|
validation = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
self.assertTrue(validation.ok)
|
||||||
|
self.assertIn("missing_optional_attachment", {issue.code for issue in validation.issues})
|
||||||
|
|
||||||
|
result = build_campaign_messages(config, campaign_file=campaign_file, output_dir=root / "out", write_eml=False)
|
||||||
|
self.assertEqual(result.report.built_count, 1)
|
||||||
|
self.assertEqual(result.report.queueable_count, 1)
|
||||||
|
message = result.report.messages[0]
|
||||||
|
self.assertEqual(message.attachment_count, 1)
|
||||||
|
summaries = {attachment.attachment_id: attachment for attachment in message.attachments}
|
||||||
|
self.assertEqual(summaries["matched"].zip_filename, "recipient-bundle.zip")
|
||||||
|
self.assertEqual(summaries["matched"].zip_entry_names, ["matched.xlsx"])
|
||||||
|
self.assertIsNone(summaries["missing"].zip_filename)
|
||||||
|
self.assertEqual(summaries["missing"].zip_entry_names, [])
|
||||||
|
self.assertEqual(summaries["missing"].matches, [])
|
||||||
|
|
||||||
|
mime = result.built_messages[0].mime
|
||||||
|
self.assertIsNotNone(mime)
|
||||||
|
attachments = {part.get_filename(): part.get_payload(decode=True) for part in mime.iter_attachments()}
|
||||||
|
self.assertEqual(set(attachments), {"recipient-bundle.zip"})
|
||||||
|
with zipfile.ZipFile(io.BytesIO(attachments["recipient-bundle.zip"])) as archive:
|
||||||
|
self.assertEqual(archive.namelist(), ["matched.xlsx"])
|
||||||
|
self.assertEqual(archive.read("matched.xlsx"), b"matched workbook")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
119
tests/test_campaign_audit_atomicity.py
Normal file
119
tests/test_campaign_audit_atomicity.py
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi import HTTPException
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.schemas import CampaignUpdateRequest, CampaignVersionUpdateRequest
|
||||||
|
|
||||||
|
|
||||||
|
def _principal() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
user=SimpleNamespace(id="user-1"),
|
||||||
|
api_key=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_update_rolls_back_when_its_audit_record_cannot_be_written() -> None:
|
||||||
|
session = MagicMock()
|
||||||
|
principal = _principal()
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
raw_json={},
|
||||||
|
current_flow="manual",
|
||||||
|
current_step="recipients",
|
||||||
|
)
|
||||||
|
|
||||||
|
def mutate(*_args, **kwargs):
|
||||||
|
assert kwargs["commit"] is False
|
||||||
|
session.flush()
|
||||||
|
return version
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal"),
|
||||||
|
patch.object(router, "_get_version_for_tenant", return_value=version),
|
||||||
|
patch.object(router, "update_campaign_version", side_effect=mutate),
|
||||||
|
patch.object(router, "audit_from_principal", side_effect=RuntimeError("audit unavailable")),
|
||||||
|
):
|
||||||
|
with pytest.raises(HTTPException, match="audit unavailable") as captured:
|
||||||
|
router._update_campaign_version_detail_response( # noqa: SLF001 - transaction regression test
|
||||||
|
session,
|
||||||
|
principal, # type: ignore[arg-type]
|
||||||
|
"campaign-1",
|
||||||
|
"version-1",
|
||||||
|
CampaignVersionUpdateRequest(current_step="recipients"),
|
||||||
|
autosave=True,
|
||||||
|
audit_action="campaign.version_autosaved",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert captured.value.status_code == 422
|
||||||
|
session.commit.assert_not_called()
|
||||||
|
session.rollback.assert_called_once_with()
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_fork_rolls_back_when_its_audit_record_cannot_be_written() -> None:
|
||||||
|
session = MagicMock()
|
||||||
|
principal = _principal()
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
source = SimpleNamespace(id="version-1", campaign_id="campaign-1", raw_json={})
|
||||||
|
forked = SimpleNamespace(id="version-2", campaign_id="campaign-1", version_number=2)
|
||||||
|
|
||||||
|
def mutate(*_args, **kwargs):
|
||||||
|
assert kwargs["commit"] is False
|
||||||
|
session.flush()
|
||||||
|
return forked
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
patch.object(router, "_require_permission"),
|
||||||
|
patch.object(router, "_get_version_for_tenant", return_value=source),
|
||||||
|
patch.object(router, "_get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch.object(router, "fork_campaign_version_for_edit", side_effect=mutate),
|
||||||
|
patch.object(router, "audit_from_principal", side_effect=RuntimeError("audit unavailable")),
|
||||||
|
):
|
||||||
|
with pytest.raises(RuntimeError, match="audit unavailable"):
|
||||||
|
router.fork_version_for_edit(
|
||||||
|
"campaign-1",
|
||||||
|
"version-1",
|
||||||
|
CampaignVersionUpdateRequest(),
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
session.commit.assert_not_called()
|
||||||
|
session.rollback.assert_called_once_with()
|
||||||
|
|
||||||
|
|
||||||
|
def test_metadata_update_rolls_back_when_its_audit_record_cannot_be_written() -> None:
|
||||||
|
session = MagicMock()
|
||||||
|
principal = _principal()
|
||||||
|
campaign = SimpleNamespace(
|
||||||
|
id="campaign-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
external_id="C-1",
|
||||||
|
name="Old name",
|
||||||
|
description=None,
|
||||||
|
status="draft",
|
||||||
|
current_version_id=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
patch.object(router, "_sync_campaign_metadata_to_current_version"),
|
||||||
|
patch.object(router, "audit_from_principal", side_effect=RuntimeError("audit unavailable")),
|
||||||
|
):
|
||||||
|
with pytest.raises(RuntimeError, match="audit unavailable"):
|
||||||
|
router.update_campaign_metadata_endpoint(
|
||||||
|
"campaign-1",
|
||||||
|
CampaignUpdateRequest(name="New name"),
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
session.flush.assert_called_once_with()
|
||||||
|
session.commit.assert_not_called()
|
||||||
|
session.rollback.assert_called_once_with()
|
||||||
173
tests/test_campaign_reports.py
Normal file
173
tests/test_campaign_reports.py
Normal file
@@ -0,0 +1,173 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from types import SimpleNamespace
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.reports.campaigns import (
|
||||||
|
_job_evidence_row,
|
||||||
|
_latest_by_job_id,
|
||||||
|
_load_delivery_info,
|
||||||
|
generate_campaign_report,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _dt() -> datetime:
|
||||||
|
return datetime(2026, 7, 8, 12, 30, tzinfo=UTC)
|
||||||
|
|
||||||
|
|
||||||
|
def test_job_evidence_row_contains_transport_and_message_evidence() -> None:
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
entry_index=0,
|
||||||
|
entry_id="recipient-1",
|
||||||
|
recipient_email="recipient@govoplan.test",
|
||||||
|
subject="Evidence test",
|
||||||
|
message_id_header="<message-1@govoplan.test>",
|
||||||
|
eml_storage_key="eml/job-1.eml",
|
||||||
|
eml_local_path="/tmp/job-1.eml",
|
||||||
|
eml_size_bytes=1234,
|
||||||
|
eml_sha256="abc123",
|
||||||
|
build_status="built",
|
||||||
|
validation_status="ready",
|
||||||
|
queue_status="queued",
|
||||||
|
send_status="smtp_accepted",
|
||||||
|
imap_status="appended",
|
||||||
|
attempt_count=2,
|
||||||
|
queued_at=_dt(),
|
||||||
|
claimed_at=None,
|
||||||
|
smtp_started_at=_dt(),
|
||||||
|
outcome_unknown_at=None,
|
||||||
|
sent_at=_dt(),
|
||||||
|
last_error=None,
|
||||||
|
resolved_recipients={
|
||||||
|
"from": [{"name": "Sender", "email": "sender@govoplan.test"}],
|
||||||
|
"to": [{"name": "Recipient", "email": "recipient@govoplan.test"}],
|
||||||
|
"cc": [],
|
||||||
|
"bcc": [],
|
||||||
|
"reply_to": [{"email": "reply@govoplan.test"}],
|
||||||
|
},
|
||||||
|
resolved_attachments=[
|
||||||
|
{
|
||||||
|
"matches": [{"filename": "notice.pdf"}, "/tmp/evidence.xlsx"],
|
||||||
|
"zip_filename": "bundle.zip",
|
||||||
|
"message_filenames": ["notice.pdf"],
|
||||||
|
}
|
||||||
|
],
|
||||||
|
issues_snapshot=[],
|
||||||
|
created_at=_dt(),
|
||||||
|
updated_at=_dt(),
|
||||||
|
)
|
||||||
|
smtp = SimpleNamespace(
|
||||||
|
job_id="job-1",
|
||||||
|
attempt_number=2,
|
||||||
|
status="success",
|
||||||
|
smtp_status_code=250,
|
||||||
|
smtp_response="2.0.0 queued",
|
||||||
|
error_type=None,
|
||||||
|
error_message=None,
|
||||||
|
started_at=_dt(),
|
||||||
|
finished_at=_dt(),
|
||||||
|
)
|
||||||
|
imap = SimpleNamespace(
|
||||||
|
job_id="job-1",
|
||||||
|
attempt_number=1,
|
||||||
|
status="appended",
|
||||||
|
folder="Sent",
|
||||||
|
error_message=None,
|
||||||
|
created_at=_dt(),
|
||||||
|
updated_at=_dt(),
|
||||||
|
)
|
||||||
|
|
||||||
|
row = _job_evidence_row(job, latest_smtp=smtp, latest_imap=imap)
|
||||||
|
|
||||||
|
assert row["campaign_id"] == "campaign-1"
|
||||||
|
assert row["campaign_version_id"] == "version-1"
|
||||||
|
assert row["message_id_header"] == "<message-1@govoplan.test>"
|
||||||
|
assert row["from"] == "Sender <sender@govoplan.test>"
|
||||||
|
assert row["to"] == "Recipient <recipient@govoplan.test>"
|
||||||
|
assert row["reply_to"] == "reply@govoplan.test"
|
||||||
|
assert "bundle.zip" in row["attachment_names"]
|
||||||
|
assert "notice.pdf" in row["attachment_names"]
|
||||||
|
assert row["latest_smtp_status_code"] == 250
|
||||||
|
assert "latest_smtp_response" not in row
|
||||||
|
assert "latest_smtp_error_type" not in row
|
||||||
|
assert "latest_smtp_error_message" not in row
|
||||||
|
assert row["latest_imap_status"] == "appended"
|
||||||
|
assert row["latest_imap_folder"] == "Sent"
|
||||||
|
assert "latest_imap_error_message" not in row
|
||||||
|
assert "eml_storage_key" not in row
|
||||||
|
assert "eml_local_path" not in row
|
||||||
|
|
||||||
|
|
||||||
|
def test_latest_by_job_id_keeps_highest_attempt_number() -> None:
|
||||||
|
attempts = [
|
||||||
|
SimpleNamespace(job_id="job-1", attempt_number=1),
|
||||||
|
SimpleNamespace(job_id="job-1", attempt_number=3),
|
||||||
|
SimpleNamespace(job_id="job-2", attempt_number=2),
|
||||||
|
]
|
||||||
|
|
||||||
|
latest = _latest_by_job_id(attempts)
|
||||||
|
|
||||||
|
assert latest["job-1"].attempt_number == 3
|
||||||
|
assert latest["job-2"].attempt_number == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_invalid_legacy_snapshot_never_echoes_validation_details() -> None:
|
||||||
|
version = SimpleNamespace(
|
||||||
|
execution_snapshot={
|
||||||
|
"snapshot_version": "legacy",
|
||||||
|
"smtp": {"host": "smtp.internal.example", "password": "provider-secret"},
|
||||||
|
},
|
||||||
|
execution_snapshot_hash=None,
|
||||||
|
execution_snapshot_at=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
delivery = _load_delivery_info(version, [])
|
||||||
|
|
||||||
|
assert delivery["load_error"] == "Execution snapshot is invalid; rebuild the selected version before delivery."
|
||||||
|
assert "provider-secret" not in repr(delivery)
|
||||||
|
assert "smtp.internal.example" not in repr(delivery)
|
||||||
|
assert "background_workers_enabled" not in delivery
|
||||||
|
assert "smtp_transport_revision" not in delivery
|
||||||
|
|
||||||
|
operator_delivery = _load_delivery_info(version, [], include_diagnostics=True)
|
||||||
|
assert "background_workers_enabled" in operator_delivery
|
||||||
|
assert "smtp_transport_revision" in operator_delivery
|
||||||
|
|
||||||
|
|
||||||
|
def test_aggregate_report_omits_recipient_level_failures_by_default() -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
version = SimpleNamespace(id="version-1")
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.reports.campaigns._get_campaign", return_value=campaign),
|
||||||
|
patch("govoplan_campaign.backend.reports.campaigns._selected_version", return_value=version),
|
||||||
|
patch("govoplan_campaign.backend.reports.campaigns._report_jobs", return_value=[]),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.reports.campaigns._campaign_report_payload",
|
||||||
|
return_value={"cards": {}},
|
||||||
|
) as payload,
|
||||||
|
):
|
||||||
|
report = generate_campaign_report(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert report == {"cards": {}}
|
||||||
|
assert payload.call_args.kwargs["include_recent_failures"] is False
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignReportProjectionTests(unittest.TestCase):
|
||||||
|
def test_evidence_projection(self) -> None:
|
||||||
|
test_job_evidence_row_contains_transport_and_message_evidence()
|
||||||
|
|
||||||
|
def test_latest_attempt_projection(self) -> None:
|
||||||
|
test_latest_by_job_id_keeps_highest_attempt_number()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
314
tests/test_celery_redelivery_acceptance.py
Normal file
314
tests/test_celery_redelivery_acceptance.py
Normal file
@@ -0,0 +1,314 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import json
|
||||||
|
from pathlib import Path
|
||||||
|
from types import SimpleNamespace
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
from unittest import mock
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
|
||||||
|
REPOSITORY_ROOT = Path(__file__).resolve().parents[1]
|
||||||
|
RUNNER_PATH = (
|
||||||
|
REPOSITORY_ROOT
|
||||||
|
/ "dev"
|
||||||
|
/ "mail-testbed"
|
||||||
|
/ "run_celery_redelivery_acceptance.py"
|
||||||
|
)
|
||||||
|
COMPOSE_PATH = REPOSITORY_ROOT / "dev" / "mail-testbed" / "docker-compose.yml"
|
||||||
|
FIXTURE_PATH = REPOSITORY_ROOT / "examples" / "greenmail-delivery" / "campaign.json"
|
||||||
|
TASK_ID = "12345678-1234-4234-8234-123456789abc"
|
||||||
|
|
||||||
|
|
||||||
|
def _load_runner():
|
||||||
|
spec = importlib.util.spec_from_file_location(
|
||||||
|
"govoplan_campaign_celery_redelivery_acceptance",
|
||||||
|
RUNNER_PATH,
|
||||||
|
)
|
||||||
|
assert spec is not None and spec.loader is not None
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
sys.modules[spec.name] = module
|
||||||
|
spec.loader.exec_module(module)
|
||||||
|
return module
|
||||||
|
|
||||||
|
|
||||||
|
runner = _load_runner()
|
||||||
|
|
||||||
|
|
||||||
|
class _Response:
|
||||||
|
def __init__(self, status_code: int, payload: dict) -> None:
|
||||||
|
self.status_code = status_code
|
||||||
|
self._payload = payload
|
||||||
|
|
||||||
|
def json(self) -> dict:
|
||||||
|
return self._payload
|
||||||
|
|
||||||
|
|
||||||
|
class _Client:
|
||||||
|
def post(self, path: str, **_kwargs) -> _Response:
|
||||||
|
assert path.endswith("/queue")
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"queued_count": 1,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"blocked_count": 0,
|
||||||
|
"enqueued_count": 1,
|
||||||
|
"delivery_mode": "worker_queue",
|
||||||
|
"worker_queue_available": True,
|
||||||
|
"dry_run": False,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
def get(self, path: str, **_kwargs) -> _Response:
|
||||||
|
assert path.endswith("/report")
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"cards": {
|
||||||
|
"jobs_total": 1,
|
||||||
|
"outcome_unknown": 1,
|
||||||
|
"needs_attention": 1,
|
||||||
|
},
|
||||||
|
"status_counts": {
|
||||||
|
"send": {"outcome_unknown": 1},
|
||||||
|
"imap": {"pending": 1},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _Endpoint:
|
||||||
|
host = "127.0.0.1"
|
||||||
|
port = 4025
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.release_count = 0
|
||||||
|
|
||||||
|
def wait_for_data(self, _timeout_seconds: int) -> bool:
|
||||||
|
return True
|
||||||
|
|
||||||
|
def release_held_connection(self) -> None:
|
||||||
|
self.release_count += 1
|
||||||
|
|
||||||
|
def evidence(self) -> dict[str, int]:
|
||||||
|
return {
|
||||||
|
"connection_count": 1,
|
||||||
|
"accepted_rcpt_commands": 1,
|
||||||
|
"refused_rcpt_commands": 0,
|
||||||
|
"data_transactions": 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _settings():
|
||||||
|
return runner.TestbedSettings(
|
||||||
|
smtp_host="127.0.0.1",
|
||||||
|
smtp_port=3025,
|
||||||
|
imap_host="127.0.0.1",
|
||||||
|
imap_port=3143,
|
||||||
|
username="campaign-test@govoplan.test",
|
||||||
|
password="local-test-password",
|
||||||
|
sender="campaign-test@govoplan.test",
|
||||||
|
recipient="campaign-test@govoplan.test",
|
||||||
|
sent_folder="Sent",
|
||||||
|
provider_timeout_seconds=5,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_compose_redis_is_isolated_durable_and_health_checked() -> None:
|
||||||
|
compose = COMPOSE_PATH.read_text(encoding="utf-8")
|
||||||
|
|
||||||
|
assert "redis:7-alpine" in compose
|
||||||
|
assert '"--appendonly", "yes"' in compose
|
||||||
|
assert "127.0.0.1:${GOVOPLAN_CAMPAIGN_TEST_REDIS_PORT:-36379}:6379" in compose
|
||||||
|
assert 'test: ["CMD", "redis-cli", "ping"]' in compose
|
||||||
|
assert "campaign-redis-data:/data" in compose
|
||||||
|
|
||||||
|
|
||||||
|
def test_runbook_keeps_local_redelivery_distinct_from_production_supervision() -> None:
|
||||||
|
testbed = (REPOSITORY_ROOT / "dev" / "mail-testbed" / "README.md").read_text(
|
||||||
|
encoding="utf-8"
|
||||||
|
)
|
||||||
|
runbook = (REPOSITORY_ROOT / "docs" / "CAMPAIGN_DELIVERY_RUNBOOK.md").read_text(
|
||||||
|
encoding="utf-8"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "run_celery_redelivery_acceptance.py" in testbed
|
||||||
|
assert "same Celery task identity must be redelivered" in testbed
|
||||||
|
assert "production daemon supervision" in testbed
|
||||||
|
assert "empty broker queue/unacked set" in runbook
|
||||||
|
assert "production process manager" in runbook
|
||||||
|
|
||||||
|
|
||||||
|
def test_compose_lifecycle_targets_only_isolated_redis_service() -> None:
|
||||||
|
up = runner._compose_command(
|
||||||
|
compose_file=COMPOSE_PATH,
|
||||||
|
project_name="govoplan-campaign-redelivery-test",
|
||||||
|
operation="up",
|
||||||
|
)
|
||||||
|
down = runner._compose_command(
|
||||||
|
compose_file=COMPOSE_PATH,
|
||||||
|
project_name="govoplan-campaign-redelivery-test",
|
||||||
|
operation="down",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert up[-3:] == ["up", "--detach", "redis"]
|
||||||
|
assert down[-3:] == ["down", "--volumes", "--remove-orphans"]
|
||||||
|
assert "greenmail" not in up
|
||||||
|
assert "--project-name" in up
|
||||||
|
|
||||||
|
|
||||||
|
def test_worker_bootstrap_uses_real_late_ack_solo_celery_worker() -> None:
|
||||||
|
source = runner.WORKER_BOOTSTRAP
|
||||||
|
|
||||||
|
assert "celery.worker_main" in source
|
||||||
|
assert '"--pool=solo"' in source
|
||||||
|
assert '"--queues=send_email"' in source
|
||||||
|
assert '"visibility_timeout"' in source
|
||||||
|
assert '"polling_interval"' in source
|
||||||
|
assert "send_email.run" not in source
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_root_uses_platform_temp_selection() -> None:
|
||||||
|
with mock.patch(
|
||||||
|
"govoplan_campaign_celery_redelivery_acceptance.tempfile.mkdtemp",
|
||||||
|
return_value="/selected-temp/govoplan-campaign-celery-redelivery-test",
|
||||||
|
) as mkdtemp:
|
||||||
|
runtime_root = runner._create_runtime_root()
|
||||||
|
|
||||||
|
assert runtime_root == Path(
|
||||||
|
"/selected-temp/govoplan-campaign-celery-redelivery-test"
|
||||||
|
)
|
||||||
|
mkdtemp.assert_called_once_with(prefix="govoplan-campaign-celery-redelivery-")
|
||||||
|
|
||||||
|
|
||||||
|
def test_worker_log_projection_matches_redelivered_task_without_retaining_id() -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temporary_directory:
|
||||||
|
log_path = Path(temporary_directory) / "worker.log"
|
||||||
|
log_path.write_text(
|
||||||
|
"\n".join(
|
||||||
|
[
|
||||||
|
f"Task govoplan.campaigns.send_email[{TASK_ID}] received",
|
||||||
|
f"Task govoplan.campaigns.send_email[{TASK_ID}] succeeded in 0.1s",
|
||||||
|
]
|
||||||
|
),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
with log_path.open("ab") as handle:
|
||||||
|
worker = runner.WorkerProcess(
|
||||||
|
process=SimpleNamespace(),
|
||||||
|
log_path=log_path,
|
||||||
|
log_handle=handle,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert worker.received_task_ids() == (TASK_ID,)
|
||||||
|
assert worker.succeeded_task_ids() == (TASK_ID,)
|
||||||
|
|
||||||
|
|
||||||
|
def test_queue_projection_fails_closed_if_no_task_was_published() -> None:
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="one Celery task"):
|
||||||
|
runner._queue_evidence(
|
||||||
|
{
|
||||||
|
"queued_count": 1,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"blocked_count": 0,
|
||||||
|
"enqueued_count": 0,
|
||||||
|
"delivery_mode": "database_queue",
|
||||||
|
"worker_queue_available": False,
|
||||||
|
"dry_run": False,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_redelivery_orchestration_requires_same_task_and_no_second_smtp_effect(
|
||||||
|
monkeypatch,
|
||||||
|
) -> None:
|
||||||
|
first_worker = mock.Mock()
|
||||||
|
first_worker.received_task_ids.return_value = (TASK_ID,)
|
||||||
|
replacement_worker = mock.Mock()
|
||||||
|
replacement_worker.received_task_ids.return_value = (TASK_ID,)
|
||||||
|
workers = iter([first_worker, replacement_worker])
|
||||||
|
endpoint = _Endpoint()
|
||||||
|
durable_states = iter(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"job_count": 1,
|
||||||
|
"send_status_counts": {"sending": 1},
|
||||||
|
"attempt_status_counts": {"smtp_in_progress": 1},
|
||||||
|
"unfinished_attempt_count": 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"job_count": 1,
|
||||||
|
"send_status_counts": {"outcome_unknown": 1},
|
||||||
|
"attempt_status_counts": {"outcome_unknown": 1},
|
||||||
|
"unfinished_attempt_count": 0,
|
||||||
|
},
|
||||||
|
]
|
||||||
|
)
|
||||||
|
prepared = SimpleNamespace(
|
||||||
|
campaign_id="campaign-internal",
|
||||||
|
version_id="version-internal",
|
||||||
|
public_evidence=lambda: {
|
||||||
|
"validation": {"ok": True},
|
||||||
|
"build": {"built_count": 1},
|
||||||
|
"campaign_mail_boundary": {
|
||||||
|
"profile_reference_only": True,
|
||||||
|
"smtp_revision_frozen": True,
|
||||||
|
"imap_revision_frozen": True,
|
||||||
|
"resolved_transport_material_present": False,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
monkeypatch.setattr(runner, "create_mail_profile", lambda *args, **kwargs: "profile-internal")
|
||||||
|
monkeypatch.setattr(runner, "prepare_campaign_scenario", lambda *args, **kwargs: prepared)
|
||||||
|
monkeypatch.setattr(runner, "_start_worker", lambda *args, **kwargs: next(workers))
|
||||||
|
monkeypatch.setattr(runner, "_wait_for_worker_ready", lambda *args, **kwargs: None)
|
||||||
|
received = iter([TASK_ID, TASK_ID])
|
||||||
|
monkeypatch.setattr(runner, "_wait_for_received_task", lambda *args, **kwargs: next(received))
|
||||||
|
monkeypatch.setattr(runner, "_wait_for_task_success", lambda *args, **kwargs: None)
|
||||||
|
monkeypatch.setattr(runner, "_kill_worker", lambda *args, **kwargs: -9)
|
||||||
|
monkeypatch.setattr(runner, "_stop_worker", lambda *args, **kwargs: None)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
runner,
|
||||||
|
"_wait_for_broker_drained",
|
||||||
|
lambda *args, **kwargs: runner.RedisBrokerState(0, 0, 0),
|
||||||
|
)
|
||||||
|
|
||||||
|
evidence = runner.execute_redelivery_scenario(
|
||||||
|
_Client(),
|
||||||
|
{"Authorization": "not-retained"},
|
||||||
|
fixture_path=FIXTURE_PATH,
|
||||||
|
settings=_settings(),
|
||||||
|
endpoint=endpoint,
|
||||||
|
redis_url="redis://127.0.0.1:36379/0",
|
||||||
|
runtime_root=Path("/not-used"),
|
||||||
|
snapshot_probe=lambda _version_id: ({}, {}),
|
||||||
|
audit_probe=lambda _campaign_id, _version_id: {
|
||||||
|
"campaign.created": 1,
|
||||||
|
"campaign.validated": 1,
|
||||||
|
"campaign.messages_built": 1,
|
||||||
|
"campaign.queued": 1,
|
||||||
|
},
|
||||||
|
delivery_probe=lambda _campaign_id, _version_id: next(durable_states),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert evidence["broker"] == {
|
||||||
|
"transport": "redis",
|
||||||
|
"same_task_identity_redelivered": True,
|
||||||
|
"first_worker_received_count": 1,
|
||||||
|
"replacement_worker_received_count": 1,
|
||||||
|
"queue_depth": 0,
|
||||||
|
"unacked_hash_count": 0,
|
||||||
|
"unacked_index_count": 0,
|
||||||
|
}
|
||||||
|
assert evidence["protocol"]["connection_count"] == 1
|
||||||
|
assert evidence["protocol"]["data_transactions"] == 1
|
||||||
|
assert evidence["recovered_durable_state"]["send_status_counts"] == {
|
||||||
|
"outcome_unknown": 1
|
||||||
|
}
|
||||||
|
assert TASK_ID not in json.dumps(evidence, sort_keys=True)
|
||||||
|
assert endpoint.release_count >= 1
|
||||||
434
tests/test_documentation.py
Normal file
434
tests/test_documentation.py
Normal file
@@ -0,0 +1,434 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.documentation import CAMPAIGN_USER_DOCUMENTATION, documentation_topics
|
||||||
|
from govoplan_core.core.modules import DocumentationContext
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class _Principal:
|
||||||
|
scopes: frozenset[str]
|
||||||
|
tenant_id: str = "tenant-1"
|
||||||
|
|
||||||
|
def has(self, scope: str) -> bool:
|
||||||
|
namespace, resource, _action = scope.split(":", 2)
|
||||||
|
return scope in self.scopes or f"{namespace}:{resource}:*" in self.scopes or f"{namespace}:*" in self.scopes or "*:*" in self.scopes
|
||||||
|
|
||||||
|
|
||||||
|
class _Registry:
|
||||||
|
def __init__(self, integrations: set[str], *, interface_only: set[str] | None = None, capability_only: set[str] | None = None) -> None:
|
||||||
|
interfaces = integrations | (interface_only or set())
|
||||||
|
self._capabilities = integrations | (capability_only or set())
|
||||||
|
self._manifests = (
|
||||||
|
SimpleNamespace(
|
||||||
|
provides_interfaces=tuple(SimpleNamespace(name=name) for name in sorted(interfaces)),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
def manifests(self):
|
||||||
|
return self._manifests
|
||||||
|
|
||||||
|
def has_capability(self, name: str) -> bool:
|
||||||
|
return name in self._capabilities
|
||||||
|
|
||||||
|
|
||||||
|
def _topics(scopes: set[str], integrations: set[str] | None = None, *, documentation_type: str = "user"):
|
||||||
|
return documentation_topics(
|
||||||
|
DocumentationContext(
|
||||||
|
registry=_Registry(integrations or set()),
|
||||||
|
principal=_Principal(frozenset(scopes)),
|
||||||
|
documentation_type=documentation_type, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_runtime_documentation_provider_is_registered() -> None:
|
||||||
|
from govoplan_campaign.backend.manifest import get_manifest
|
||||||
|
|
||||||
|
assert documentation_topics in get_manifest().documentation_providers
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_documentation_is_user_only_and_requires_a_campaign_task() -> None:
|
||||||
|
assert _topics({"docs:documentation:read"}) == ()
|
||||||
|
assert _topics({"campaigns:campaign:read"}, documentation_type="admin") == ()
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_documentation_reflects_actor_authority_without_exposing_scopes() -> None:
|
||||||
|
topic = _topics(
|
||||||
|
{
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:create",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:campaign:build",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
}
|
||||||
|
)[0]
|
||||||
|
|
||||||
|
configuration = topic.metadata["current_configuration"]
|
||||||
|
assert "Role authorization: Create new campaigns." in configuration
|
||||||
|
assert "Role authorization: Build exact recipient messages for review." in configuration
|
||||||
|
assert not any("queue" in item.lower() for item in configuration)
|
||||||
|
assert not any("campaigns:" in item or "files:" in item or "mail:" in item for item in configuration)
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_documentation_requires_both_interface_and_capability() -> None:
|
||||||
|
integration = "mail.campaign_delivery"
|
||||||
|
scopes = {"campaigns:campaign:read", "campaigns:campaign:update", "mail:profile:use"}
|
||||||
|
|
||||||
|
for registry in (
|
||||||
|
_Registry(set(), interface_only={integration}),
|
||||||
|
_Registry(set(), capability_only={integration}),
|
||||||
|
):
|
||||||
|
topic = documentation_topics(
|
||||||
|
DocumentationContext(registry=registry, principal=_Principal(frozenset(scopes)), documentation_type="user")
|
||||||
|
)[0]
|
||||||
|
assert not any("profile picker" in item for item in topic.metadata["current_configuration"])
|
||||||
|
|
||||||
|
topic = _topics(scopes, {integration})[0]
|
||||||
|
assert any("Mail's actor-filtered profile picker" in item for item in topic.metadata["current_configuration"])
|
||||||
|
|
||||||
|
|
||||||
|
def test_mail_delivery_actions_are_not_presented_without_the_mail_contract() -> None:
|
||||||
|
scopes = {
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:queue",
|
||||||
|
"campaigns:campaign:send",
|
||||||
|
"campaigns:campaign:retry",
|
||||||
|
}
|
||||||
|
|
||||||
|
without_mail = _topics(scopes)[0]
|
||||||
|
with_mail = _topics(scopes, {"mail.campaign_delivery"})[0]
|
||||||
|
|
||||||
|
assert not any("Queue an eligible" in item for item in without_mail.metadata["current_configuration"])
|
||||||
|
assert any("Queue an eligible" in item for item in with_mail.metadata["current_configuration"])
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("integrations", "scopes", "expected"),
|
||||||
|
[
|
||||||
|
(
|
||||||
|
{"files.campaign_attachments"},
|
||||||
|
{"campaigns:campaign:read", "campaigns:recipient:read", "files:file:read"},
|
||||||
|
"Managed campaign attachments can be previewed",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{"addresses.lookup"},
|
||||||
|
{"campaigns:campaign:read", "campaigns:recipient:read"},
|
||||||
|
"Address records can be looked up",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{"addresses.recipient_source"},
|
||||||
|
{
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
},
|
||||||
|
"traceable recipient snapshot",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{"notifications.dispatch"},
|
||||||
|
{"campaigns:campaign:read"},
|
||||||
|
"status changes",
|
||||||
|
),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_runtime_documentation_reflects_optional_composition_permutations(
|
||||||
|
integrations: set[str],
|
||||||
|
scopes: set[str],
|
||||||
|
expected: str,
|
||||||
|
) -> None:
|
||||||
|
topic = _topics(scopes, integrations)[0]
|
||||||
|
assert any(expected in item for item in topic.metadata["current_configuration"])
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_documentation_full_composition_uses_only_user_facing_names() -> None:
|
||||||
|
integrations = {
|
||||||
|
"mail.campaign_delivery",
|
||||||
|
"files.campaign_attachments",
|
||||||
|
"addresses.lookup",
|
||||||
|
"addresses.recipient_source",
|
||||||
|
"notifications.dispatch",
|
||||||
|
}
|
||||||
|
topic = _topics({"*:*"}, integrations)[0]
|
||||||
|
rendered = "\n".join(
|
||||||
|
(
|
||||||
|
topic.title,
|
||||||
|
topic.summary,
|
||||||
|
topic.body,
|
||||||
|
*topic.metadata["current_configuration"],
|
||||||
|
*topic.metadata["limitations"],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "Mail's actor-filtered profile picker" in rendered
|
||||||
|
assert "Managed file versions" in rendered
|
||||||
|
assert "Address records" in rendered
|
||||||
|
assert "In-app notifications" in rendered
|
||||||
|
assert topic.metadata["help_contexts"] == ["campaigns.list", "campaign.overview"]
|
||||||
|
for technical_name in integrations:
|
||||||
|
assert technical_name not in rendered
|
||||||
|
assert "0.1." not in rendered
|
||||||
|
assert "0.2." not in rendered
|
||||||
|
assert "hostname" not in rendered.lower()
|
||||||
|
assert "secret" not in rendered.lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_documentation_states_the_effective_synchronous_limit() -> None:
|
||||||
|
session = SimpleNamespace(
|
||||||
|
get=lambda _model, _id: SimpleNamespace(
|
||||||
|
settings={
|
||||||
|
"campaign_delivery_policy": {
|
||||||
|
"synchronous_send_max_recipients": 12,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with patch.dict("os.environ", {"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "25"}):
|
||||||
|
topic = documentation_topics(
|
||||||
|
DocumentationContext(
|
||||||
|
registry=_Registry({"mail.campaign_delivery"}),
|
||||||
|
principal=_Principal(frozenset({"campaigns:campaign:read", "campaigns:campaign:send"})),
|
||||||
|
session=session,
|
||||||
|
documentation_type="user",
|
||||||
|
)
|
||||||
|
)[0]
|
||||||
|
|
||||||
|
assert any(
|
||||||
|
"Send now is limited to 12 eligible recipient job(s)" in item
|
||||||
|
for item in topic.metadata["current_configuration"]
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _visible_static_topics(
|
||||||
|
scopes: set[str],
|
||||||
|
*,
|
||||||
|
modules: set[str] | None = None,
|
||||||
|
capabilities: set[str] | None = None,
|
||||||
|
) -> set[str]:
|
||||||
|
installed = modules or {"campaigns"}
|
||||||
|
available_capabilities = capabilities or set()
|
||||||
|
principal = _Principal(frozenset(scopes))
|
||||||
|
visible: set[str] = set()
|
||||||
|
for topic in CAMPAIGN_USER_DOCUMENTATION:
|
||||||
|
condition = topic.conditions[0]
|
||||||
|
if not set(condition.required_modules).issubset(installed):
|
||||||
|
continue
|
||||||
|
if not set(condition.required_capabilities).issubset(available_capabilities):
|
||||||
|
continue
|
||||||
|
if not all(principal.has(scope) for scope in condition.required_scopes):
|
||||||
|
continue
|
||||||
|
visible.add(topic.id)
|
||||||
|
return visible
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_manager_sees_only_authoring_tasks_from_the_static_handbook() -> None:
|
||||||
|
visible = _visible_static_topics(
|
||||||
|
{
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:create",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:copy",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:campaign:build",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
"campaigns:report:read",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert {
|
||||||
|
"campaigns.workflow.create-campaign",
|
||||||
|
"campaigns.workflow.create-editable-successor",
|
||||||
|
"campaigns.workflow.import-recipients",
|
||||||
|
"campaigns.workflow.view-delivery-report",
|
||||||
|
}.issubset(visible)
|
||||||
|
assert "campaigns.workflow.queue-delivery" not in visible
|
||||||
|
assert "campaigns.workflow.send-small-controlled-run" not in visible
|
||||||
|
assert "campaigns.workflow.export-delivery-report" not in visible
|
||||||
|
assert "campaigns.workflow.share-campaign" not in visible
|
||||||
|
assert "campaigns.workflow.archive-campaign" not in visible
|
||||||
|
assert "campaigns.workflow.delete-untouched-draft" not in visible
|
||||||
|
assert "campaigns.workflow.create-campaign" not in _visible_static_topics({"campaigns:campaign:create"})
|
||||||
|
|
||||||
|
|
||||||
|
def test_sender_sees_queue_and_send_only_with_the_mail_contract_and_profile_authority() -> None:
|
||||||
|
scopes = {
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:queue",
|
||||||
|
"campaigns:campaign:send",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:report:read",
|
||||||
|
"mail:profile:use",
|
||||||
|
}
|
||||||
|
|
||||||
|
without_mail = _visible_static_topics(scopes)
|
||||||
|
with_mail = _visible_static_topics(
|
||||||
|
scopes,
|
||||||
|
modules={"campaigns", "mail"},
|
||||||
|
capabilities={"mail.campaign_delivery"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "campaigns.workflow.queue-delivery" not in without_mail
|
||||||
|
assert "campaigns.workflow.send-small-controlled-run" not in without_mail
|
||||||
|
assert "campaigns.workflow.queue-delivery" in with_mail
|
||||||
|
assert "campaigns.workflow.send-small-controlled-run" in with_mail
|
||||||
|
|
||||||
|
queue_topic = next(
|
||||||
|
topic for topic in CAMPAIGN_USER_DOCUMENTATION
|
||||||
|
if topic.id == "campaigns.workflow.queue-delivery"
|
||||||
|
)
|
||||||
|
assert any(link.href == "/operator" for link in queue_topic.links)
|
||||||
|
|
||||||
|
|
||||||
|
def test_connected_authoring_tasks_require_their_declared_contracts_and_permissions() -> None:
|
||||||
|
attachment_scopes = {
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:campaign:validate",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"files:file:read",
|
||||||
|
"files:file:share",
|
||||||
|
}
|
||||||
|
source_scopes = {
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:write",
|
||||||
|
"campaigns:recipient:import",
|
||||||
|
}
|
||||||
|
|
||||||
|
files_visible = _visible_static_topics(
|
||||||
|
attachment_scopes,
|
||||||
|
modules={"campaigns", "files"},
|
||||||
|
capabilities={"files.campaign_attachments"},
|
||||||
|
)
|
||||||
|
addresses_visible = _visible_static_topics(
|
||||||
|
source_scopes,
|
||||||
|
modules={"campaigns", "addresses"},
|
||||||
|
capabilities={"addresses.recipient_source"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "campaigns.workflow.use-managed-attachments" in files_visible
|
||||||
|
assert "campaigns.workflow.import-address-source" in addresses_visible
|
||||||
|
assert "campaigns.workflow.use-managed-attachments" not in _visible_static_topics(attachment_scopes)
|
||||||
|
assert "campaigns.workflow.import-address-source" not in _visible_static_topics(source_scopes)
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_export_and_lifecycle_tasks_are_independently_permission_gated() -> None:
|
||||||
|
exporter = _visible_static_topics(
|
||||||
|
{
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:report:read",
|
||||||
|
"campaigns:report:export",
|
||||||
|
"campaigns:recipient:read",
|
||||||
|
"campaigns:recipient:export",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
custodian = _visible_static_topics(
|
||||||
|
{
|
||||||
|
"campaigns:campaign:read",
|
||||||
|
"campaigns:campaign:share",
|
||||||
|
"campaigns:campaign:archive",
|
||||||
|
"campaigns:campaign:delete",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "campaigns.workflow.export-delivery-report" in exporter
|
||||||
|
assert "campaigns.workflow.view-delivery-report" in exporter
|
||||||
|
assert "campaigns.workflow.share-campaign" in custodian
|
||||||
|
assert "campaigns.workflow.archive-campaign" in custodian
|
||||||
|
assert "campaigns.workflow.delete-untouched-draft" in custodian
|
||||||
|
assert "campaigns.workflow.export-delivery-report" not in custodian
|
||||||
|
|
||||||
|
|
||||||
|
def test_aggregate_report_task_never_implies_recipient_detail_or_export_authority() -> None:
|
||||||
|
visible = _visible_static_topics({"campaigns:report:read"})
|
||||||
|
|
||||||
|
assert visible == {"campaigns.workflow.view-aggregate-delivery-report"}
|
||||||
|
topic = next(
|
||||||
|
item for item in CAMPAIGN_USER_DOCUMENTATION
|
||||||
|
if item.id == "campaigns.workflow.view-aggregate-delivery-report"
|
||||||
|
)
|
||||||
|
assert topic.metadata["route"] == "/reports"
|
||||||
|
assert "export" in topic.metadata["verification"].lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_handbook_distinguishes_shipped_aggregate_reports_from_detailed_report_gaps() -> None:
|
||||||
|
handbook = " ".join(
|
||||||
|
(
|
||||||
|
Path(__file__).resolve().parents[1] / "docs" / "CAMPAIGN_HANDBOOK.md"
|
||||||
|
).read_text(encoding="utf-8").lower().split()
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "aggregate-only reader ui remains open" not in handbook
|
||||||
|
assert "separate aggregate **reports** surface" in handbook
|
||||||
|
assert "permission-aware action visibility on that detailed surface remains open work" in handbook
|
||||||
|
|
||||||
|
|
||||||
|
def test_static_campaign_handbook_has_unique_ids_help_contexts_and_no_planned_resend_claim() -> None:
|
||||||
|
from govoplan_campaign.backend.manifest import get_manifest
|
||||||
|
|
||||||
|
topics = get_manifest().documentation
|
||||||
|
ids = [topic.id for topic in topics]
|
||||||
|
rendered_static = "\n".join(
|
||||||
|
(topic.title + "\n" + topic.summary + "\n" + topic.body).lower()
|
||||||
|
for topic in CAMPAIGN_USER_DOCUMENTATION
|
||||||
|
)
|
||||||
|
known_help_contexts = {
|
||||||
|
"campaigns.list",
|
||||||
|
"campaign.overview",
|
||||||
|
"campaign.settings",
|
||||||
|
"campaign.fields",
|
||||||
|
"campaign.template",
|
||||||
|
"campaign.attachments",
|
||||||
|
"campaign.recipients",
|
||||||
|
"campaign.recipient-data",
|
||||||
|
"campaign.server-settings",
|
||||||
|
"campaign.global-settings",
|
||||||
|
"campaign.review-send",
|
||||||
|
"campaign.report",
|
||||||
|
"campaign.audit",
|
||||||
|
"campaign.json",
|
||||||
|
}
|
||||||
|
|
||||||
|
assert len(ids) == len(set(ids))
|
||||||
|
assert "single resend" not in rendered_static
|
||||||
|
for topic in CAMPAIGN_USER_DOCUMENTATION:
|
||||||
|
assert topic.metadata["kind"] == "workflow"
|
||||||
|
assert topic.metadata["prerequisites"]
|
||||||
|
assert topic.metadata["steps"]
|
||||||
|
assert topic.metadata["outcome"]
|
||||||
|
assert topic.metadata["verification"]
|
||||||
|
assert set(topic.metadata["help_contexts"]).issubset(known_help_contexts)
|
||||||
|
|
||||||
|
existing_user_workflows = {
|
||||||
|
topic.id: topic
|
||||||
|
for topic in topics
|
||||||
|
if topic.id
|
||||||
|
in {
|
||||||
|
"campaigns.mail-profile-user-journey",
|
||||||
|
"campaigns.workflow.prepare-validate-and-build",
|
||||||
|
"campaigns.workflow.complete-review",
|
||||||
|
"campaigns.workflow.retry-and-reconcile",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert set(existing_user_workflows) == {
|
||||||
|
"campaigns.mail-profile-user-journey",
|
||||||
|
"campaigns.workflow.prepare-validate-and-build",
|
||||||
|
"campaigns.workflow.complete-review",
|
||||||
|
"campaigns.workflow.retry-and-reconcile",
|
||||||
|
}
|
||||||
|
for topic in existing_user_workflows.values():
|
||||||
|
assert topic.metadata["help_contexts"]
|
||||||
110
tests/test_editor_state_security.py
Normal file
110
tests/test_editor_state_security.py
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from pydantic import ValidationError
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
campaign_editor_state_for_edit,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.schemas import (
|
||||||
|
CampaignVersionResponse,
|
||||||
|
CampaignVersionUpdateRequest,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"editor_state",
|
||||||
|
[
|
||||||
|
{"smtp": {"host": "smtp.example.test", "password": "secret"}},
|
||||||
|
{"transport": {"imap_password": "secret"}},
|
||||||
|
{
|
||||||
|
"review_send": {
|
||||||
|
"build_token": "forged",
|
||||||
|
"inspection_complete": True,
|
||||||
|
"reviewed_message_keys": [],
|
||||||
|
"updated_at": "2026-07-21T00:00:00+00:00",
|
||||||
|
"updated_by_user_id": "user-1",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_version_updates_reject_arbitrary_or_server_owned_editor_state(
|
||||||
|
editor_state: dict[str, object],
|
||||||
|
) -> None:
|
||||||
|
with pytest.raises(ValidationError, match="unsupported or transport-owned"):
|
||||||
|
CampaignVersionUpdateRequest(editor_state=editor_state)
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_response_omits_legacy_secret_bearing_editor_state() -> None:
|
||||||
|
response = CampaignVersionResponse.model_validate(
|
||||||
|
{
|
||||||
|
"id": "version-1",
|
||||||
|
"campaign_id": "campaign-1",
|
||||||
|
"version_number": 1,
|
||||||
|
"schema_version": "1.0",
|
||||||
|
"editor_state": {
|
||||||
|
"opt_ins": {"inline_guidance": True},
|
||||||
|
"smtp": {"host": "smtp.internal.example", "password": "provider-secret"},
|
||||||
|
},
|
||||||
|
"created_at": datetime.now(UTC),
|
||||||
|
"updated_at": datetime.now(UTC),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert response.editor_state == {"opt_ins": {"inline_guidance": True}}
|
||||||
|
assert "provider-secret" not in repr(response)
|
||||||
|
assert "internal.example" not in repr(response)
|
||||||
|
|
||||||
|
|
||||||
|
def test_review_build_token_is_visible_only_in_operator_diagnostics() -> None:
|
||||||
|
value = {
|
||||||
|
"id": "version-1",
|
||||||
|
"campaign_id": "campaign-1",
|
||||||
|
"version_number": 1,
|
||||||
|
"schema_version": "1.0",
|
||||||
|
"editor_state": {
|
||||||
|
"review_send": {
|
||||||
|
"build_token": "internal-build-token",
|
||||||
|
"inspection_complete": True,
|
||||||
|
"reviewed_message_keys": ["entry-1"],
|
||||||
|
"updated_at": "2026-07-21T00:00:00+00:00",
|
||||||
|
"updated_by_user_id": "reviewer-1",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"created_at": datetime.now(UTC),
|
||||||
|
"updated_at": datetime.now(UTC),
|
||||||
|
}
|
||||||
|
|
||||||
|
public = CampaignVersionResponse.model_validate(value)
|
||||||
|
operator = CampaignVersionResponse.model_validate(
|
||||||
|
value,
|
||||||
|
context={"include_diagnostics": True},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "build_token" not in public.editor_state["review_send"]
|
||||||
|
assert operator.editor_state["review_send"]["build_token"] == "internal-build-token"
|
||||||
|
|
||||||
|
|
||||||
|
def test_fork_copy_keeps_only_client_owned_bounded_metadata() -> None:
|
||||||
|
copied = campaign_editor_state_for_edit(
|
||||||
|
{
|
||||||
|
"created_from": "minimal_campaign",
|
||||||
|
"field_overrides": {"department": False},
|
||||||
|
"review_send": {
|
||||||
|
"build_token": "build-1",
|
||||||
|
"inspection_complete": True,
|
||||||
|
"reviewed_message_keys": ["entry-1"],
|
||||||
|
"updated_at": "2026-07-21T00:00:00+00:00",
|
||||||
|
"updated_by_user_id": "reviewer-1",
|
||||||
|
},
|
||||||
|
"credentials": {"password": "legacy-secret"},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
assert copied == {
|
||||||
|
"created_from": "minimal_campaign",
|
||||||
|
"field_overrides": {"department": False},
|
||||||
|
}
|
||||||
|
assert "legacy-secret" not in repr(copied)
|
||||||
207
tests/test_example_campaigns.py
Normal file
207
tests/test_example_campaigns.py
Normal file
@@ -0,0 +1,207 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
REPOSITORY_ROOT = Path(__file__).resolve().parents[1]
|
||||||
|
FIXTURE_ROOT = REPOSITORY_ROOT / "examples" / "simple-announcement"
|
||||||
|
|
||||||
|
|
||||||
|
_ISOLATED_ACCEPTANCE_PROGRAM = r"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import hashlib
|
||||||
|
import importlib.abc
|
||||||
|
import json
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
from email import policy
|
||||||
|
from email.parser import BytesParser
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
source_root = Path(sys.argv[1]).resolve()
|
||||||
|
fixture_root = Path(sys.argv[2]).resolve()
|
||||||
|
sys.path.insert(0, str(source_root))
|
||||||
|
|
||||||
|
|
||||||
|
class AbsentOptionalModuleFinder(importlib.abc.MetaPathFinder):
|
||||||
|
absent_roots = {"govoplan_files", "govoplan_mail"}
|
||||||
|
|
||||||
|
def find_spec(self, fullname, path=None, target=None):
|
||||||
|
if fullname.partition(".")[0] in self.absent_roots:
|
||||||
|
raise ModuleNotFoundError(
|
||||||
|
f"{fullname} is intentionally absent in the Campaign fixture check",
|
||||||
|
name=fullname,
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
sys.meta_path.insert(0, AbsentOptionalModuleFinder())
|
||||||
|
|
||||||
|
|
||||||
|
def deny_network(*args, **kwargs):
|
||||||
|
raise AssertionError("the Campaign validate/build fixture must not open a network connection")
|
||||||
|
|
||||||
|
|
||||||
|
class NoNetworkSocket(socket.socket):
|
||||||
|
def connect(self, address):
|
||||||
|
deny_network(address)
|
||||||
|
|
||||||
|
def connect_ex(self, address):
|
||||||
|
deny_network(address)
|
||||||
|
|
||||||
|
|
||||||
|
socket.create_connection = deny_network
|
||||||
|
socket.socket = NoNetworkSocket
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign import ( # noqa: E402
|
||||||
|
load_campaign_config,
|
||||||
|
load_campaign_json,
|
||||||
|
validate_campaign_config,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.messages import build_campaign_messages # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
metadata = json.loads((fixture_root / "fixture.json").read_text(encoding="utf-8"))
|
||||||
|
assert metadata["required_modules"] == ["core", "access", "campaigns"]
|
||||||
|
assert metadata["absent_optional_modules"] == ["files", "mail"]
|
||||||
|
assert metadata["external_effects"] == "forbidden"
|
||||||
|
|
||||||
|
campaign_file = fixture_root / metadata["campaign_file"]
|
||||||
|
raw_campaign = load_campaign_json(campaign_file)
|
||||||
|
|
||||||
|
|
||||||
|
def iter_keys(value):
|
||||||
|
if isinstance(value, dict):
|
||||||
|
for key, nested in value.items():
|
||||||
|
yield key.casefold()
|
||||||
|
yield from iter_keys(nested)
|
||||||
|
elif isinstance(value, list):
|
||||||
|
for nested in value:
|
||||||
|
yield from iter_keys(nested)
|
||||||
|
|
||||||
|
|
||||||
|
forbidden_key_fragments = ("credential", "imap", "mail_profile", "password", "secret", "smtp")
|
||||||
|
assert not [
|
||||||
|
key
|
||||||
|
for key in iter_keys(raw_campaign)
|
||||||
|
if any(fragment in key for fragment in forbidden_key_fragments)
|
||||||
|
]
|
||||||
|
|
||||||
|
config = load_campaign_config(campaign_file)
|
||||||
|
assert config.server.mail_profile_id is None
|
||||||
|
assert not config.attachments.global_
|
||||||
|
|
||||||
|
validation = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
assert validation.ok
|
||||||
|
assert validation.error_count == 0
|
||||||
|
assert validation.warning_count == 0
|
||||||
|
assert validation.entries_count == metadata["expected"]["entries_count"]
|
||||||
|
|
||||||
|
|
||||||
|
def build(output_name):
|
||||||
|
return build_campaign_messages(
|
||||||
|
config,
|
||||||
|
campaign_file=campaign_file,
|
||||||
|
output_dir=fixture_root.parent / output_name,
|
||||||
|
write_eml=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
first = build("build-first")
|
||||||
|
second = build("build-second")
|
||||||
|
expected = metadata["expected"]
|
||||||
|
for result in (first, second):
|
||||||
|
assert result.report.campaign_id == expected["campaign_id"]
|
||||||
|
assert result.report.entries_count == expected["entries_count"]
|
||||||
|
assert result.report.built_count == expected["built_count"]
|
||||||
|
assert result.report.build_failed_count == 0
|
||||||
|
assert result.report.queueable_count == expected["queueable_count"]
|
||||||
|
assert len(result.built_messages) == 1
|
||||||
|
|
||||||
|
built = result.built_messages[0]
|
||||||
|
assert built.mime is not None
|
||||||
|
assert built.draft.subject == expected["subject"]
|
||||||
|
assert built.draft.validation_status.value == "ready"
|
||||||
|
assert built.draft.send_status.value == "draft"
|
||||||
|
assert built.draft.imap_status.value == "not_requested"
|
||||||
|
assert built.draft.attachment_count == expected["attachment_count"]
|
||||||
|
assert not built.draft.attachments
|
||||||
|
assert not built.draft.issues
|
||||||
|
assert built.draft.from_ is not None
|
||||||
|
assert built.draft.from_.email == "announcements@example.test"
|
||||||
|
assert [address.email for address in built.draft.to] == ["recipient@example.test"]
|
||||||
|
assert built.mime["Subject"] == expected["subject"]
|
||||||
|
assert "Hello Example Recipient" in built.mime.get_content()
|
||||||
|
assert list(built.mime.iter_attachments()) == []
|
||||||
|
|
||||||
|
|
||||||
|
def normalized_eml(path_value):
|
||||||
|
message = BytesParser(policy=policy.default).parsebytes(Path(path_value).read_bytes())
|
||||||
|
del message["Date"]
|
||||||
|
del message["Message-ID"]
|
||||||
|
return message.as_bytes(policy=policy.default)
|
||||||
|
|
||||||
|
|
||||||
|
first_eml = normalized_eml(first.report.messages[0].eml_path)
|
||||||
|
second_eml = normalized_eml(second.report.messages[0].eml_path)
|
||||||
|
assert first_eml == second_eml
|
||||||
|
assert not any(
|
||||||
|
name == root or name.startswith(root + ".")
|
||||||
|
for name in sys.modules
|
||||||
|
for root in ("govoplan_files", "govoplan_mail")
|
||||||
|
)
|
||||||
|
|
||||||
|
print(json.dumps({
|
||||||
|
"campaign_id": first.report.campaign_id,
|
||||||
|
"built_count": first.report.built_count,
|
||||||
|
"queueable_count": first.report.queueable_count,
|
||||||
|
"normalized_eml_sha256": hashlib.sha256(first_eml).hexdigest(),
|
||||||
|
}, sort_keys=True))
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignExampleAcceptanceTests(unittest.TestCase):
|
||||||
|
def test_simple_announcement_validates_and_builds_without_mail_or_files(self) -> None:
|
||||||
|
self.assertTrue((FIXTURE_ROOT / "campaign.json").is_file())
|
||||||
|
self.assertTrue((FIXTURE_ROOT / "fixture.json").is_file())
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory(prefix="govoplan-campaign-acceptance-", dir="/tmp") as temp_dir:
|
||||||
|
workspace = Path(temp_dir).resolve()
|
||||||
|
self.assertNotIn(REPOSITORY_ROOT, workspace.parents)
|
||||||
|
isolated_fixture = workspace / "simple-announcement"
|
||||||
|
shutil.copytree(FIXTURE_ROOT, isolated_fixture)
|
||||||
|
|
||||||
|
completed = subprocess.run(
|
||||||
|
[
|
||||||
|
sys.executable,
|
||||||
|
"-I",
|
||||||
|
"-c",
|
||||||
|
_ISOLATED_ACCEPTANCE_PROGRAM,
|
||||||
|
str(REPOSITORY_ROOT / "src"),
|
||||||
|
str(isolated_fixture),
|
||||||
|
],
|
||||||
|
cwd=workspace,
|
||||||
|
check=False,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=30,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(completed.returncode, 0, completed.stderr or completed.stdout)
|
||||||
|
evidence = json.loads(completed.stdout)
|
||||||
|
self.assertEqual(evidence["campaign_id"], "simple-announcement")
|
||||||
|
self.assertEqual(evidence["built_count"], 1)
|
||||||
|
self.assertEqual(evidence["queueable_count"], 1)
|
||||||
|
self.assertRegex(evidence["normalized_eml_sha256"], r"^[0-9a-f]{64}$")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
67
tests/test_excluded_delivery_status.py
Normal file
67
tests/test_excluded_delivery_status.py
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from importlib import import_module
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from sqlalchemy import create_engine, text
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.models import BuildStatus, SendStatus
|
||||||
|
from govoplan_campaign.backend.messages.models import ImapStatus, MessageDraft, MessageValidationStatus
|
||||||
|
from govoplan_campaign.backend.persistence.campaigns import _job_from_message
|
||||||
|
|
||||||
|
|
||||||
|
def test_excluded_message_persists_explicit_skipped_transport_states() -> None:
|
||||||
|
message = MessageDraft(
|
||||||
|
entry_index=0,
|
||||||
|
entry_id="excluded-entry",
|
||||||
|
active=True,
|
||||||
|
build_status=BuildStatus.BUILT,
|
||||||
|
validation_status=MessageValidationStatus.EXCLUDED,
|
||||||
|
send_status=SendStatus.SKIPPED,
|
||||||
|
imap_status=ImapStatus.SKIPPED,
|
||||||
|
)
|
||||||
|
|
||||||
|
job = _job_from_message(
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
message=message,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert job.send_status == "skipped"
|
||||||
|
assert job.imap_status == "skipped"
|
||||||
|
|
||||||
|
|
||||||
|
def test_status_migration_only_normalizes_excluded_rows_without_transport_evidence() -> None:
|
||||||
|
migration = import_module(
|
||||||
|
"govoplan_campaign.backend.migrations.versions."
|
||||||
|
"d8b3e2c1f4a5_v0110_excluded_delivery_skipped"
|
||||||
|
)
|
||||||
|
engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||||
|
with engine.begin() as connection:
|
||||||
|
connection.execute(text(
|
||||||
|
"CREATE TABLE campaign_jobs ("
|
||||||
|
"id TEXT PRIMARY KEY, validation_status TEXT NOT NULL, "
|
||||||
|
"send_status TEXT NOT NULL, imap_status TEXT NOT NULL)"
|
||||||
|
))
|
||||||
|
connection.execute(
|
||||||
|
text(
|
||||||
|
"INSERT INTO campaign_jobs (id, validation_status, send_status, imap_status) VALUES "
|
||||||
|
"('untouched', 'excluded', 'not_queued', 'pending'), "
|
||||||
|
"('evidence', 'excluded', 'smtp_accepted', 'appended'), "
|
||||||
|
"('queueable', 'ready', 'not_queued', 'pending')"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with patch.object(migration.op, "get_bind", return_value=connection):
|
||||||
|
migration.upgrade()
|
||||||
|
|
||||||
|
rows = {
|
||||||
|
row.id: (row.send_status, row.imap_status)
|
||||||
|
for row in connection.execute(
|
||||||
|
text("SELECT id, send_status, imap_status FROM campaign_jobs ORDER BY id")
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
assert rows["untouched"] == ("skipped", "skipped")
|
||||||
|
assert rows["evidence"] == ("smtp_accepted", "appended")
|
||||||
|
assert rows["queueable"] == ("not_queued", "pending")
|
||||||
139
tests/test_execution_snapshot_integrity.py
Normal file
139
tests/test_execution_snapshot_integrity.py
Normal file
@@ -0,0 +1,139 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.models import DeliveryConfig
|
||||||
|
from govoplan_campaign.backend.sending.execution import (
|
||||||
|
ExecutionSnapshotError,
|
||||||
|
create_execution_snapshot,
|
||||||
|
ensure_execution_snapshot,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _raw_campaign() -> dict[str, object]:
|
||||||
|
return {
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "campaign-1", "name": "Campaign", "mode": "send"},
|
||||||
|
"server": {"mail_profile_id": "profile-1"},
|
||||||
|
"recipients": {"from": [{"email": "sender@example.test"}]},
|
||||||
|
"template": {"subject": "Subject", "text": "Body", "body_mode": "text"},
|
||||||
|
"entries": {"inline": []},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _job() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
entry_index=0,
|
||||||
|
entry_id="entry-1",
|
||||||
|
recipient_email="recipient@example.test",
|
||||||
|
subject="Subject",
|
||||||
|
message_id_header="<message@example.test>",
|
||||||
|
eml_size_bytes=123,
|
||||||
|
eml_sha256="eml-digest",
|
||||||
|
build_status="built",
|
||||||
|
validation_status="ready",
|
||||||
|
resolved_recipients={"to": ["recipient@example.test"]},
|
||||||
|
resolved_attachments=[],
|
||||||
|
issues_snapshot=[],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _Query:
|
||||||
|
def __init__(self, jobs: list[SimpleNamespace]):
|
||||||
|
self.jobs = jobs
|
||||||
|
|
||||||
|
def filter(self, *_args):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def order_by(self, *_args):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def all(self):
|
||||||
|
return list(self.jobs)
|
||||||
|
|
||||||
|
|
||||||
|
class _Session:
|
||||||
|
def __init__(self, jobs: list[SimpleNamespace]):
|
||||||
|
self.jobs = jobs
|
||||||
|
|
||||||
|
def query(self, _model):
|
||||||
|
return _Query(self.jobs)
|
||||||
|
|
||||||
|
|
||||||
|
def _snapshotted_version(job: SimpleNamespace):
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
raw_json=_raw_campaign(),
|
||||||
|
build_summary={"build_token": "build-1", "built_at": "2026-07-21T00:00:00+00:00"},
|
||||||
|
)
|
||||||
|
payload, digest = create_execution_snapshot(
|
||||||
|
version, # type: ignore[arg-type]
|
||||||
|
mail_profile_id="profile-1",
|
||||||
|
smtp_transport_revision="smtp-revision",
|
||||||
|
imap_transport_revision="imap-revision",
|
||||||
|
delivery=DeliveryConfig(),
|
||||||
|
jobs=[job], # type: ignore[list-item]
|
||||||
|
build_summary=version.build_summary,
|
||||||
|
)
|
||||||
|
version.execution_snapshot = payload
|
||||||
|
version.execution_snapshot_hash = digest
|
||||||
|
return version
|
||||||
|
|
||||||
|
|
||||||
|
def _ensure(session: _Session, version) -> None:
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.execution.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=False),
|
||||||
|
):
|
||||||
|
ensure_execution_snapshot(session, version) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
|
||||||
|
def test_v5_snapshot_requires_its_persisted_checksum() -> None:
|
||||||
|
job = _job()
|
||||||
|
version = _snapshotted_version(job)
|
||||||
|
version.execution_snapshot_hash = None
|
||||||
|
|
||||||
|
with pytest.raises(ExecutionSnapshotError, match="checksum is missing"):
|
||||||
|
_ensure(_Session([job]), version)
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_json_drift_is_rejected_before_delivery() -> None:
|
||||||
|
job = _job()
|
||||||
|
version = _snapshotted_version(job)
|
||||||
|
version.raw_json["template"] = {"subject": "Changed", "text": "Body"}
|
||||||
|
|
||||||
|
with pytest.raises(ExecutionSnapshotError, match="Campaign inputs changed"):
|
||||||
|
_ensure(_Session([job]), version)
|
||||||
|
|
||||||
|
|
||||||
|
def test_post_build_recipient_drift_cannot_redirect_delivery() -> None:
|
||||||
|
job = _job()
|
||||||
|
version = _snapshotted_version(job)
|
||||||
|
job.resolved_recipients = {"to": ["attacker@example.test"]}
|
||||||
|
|
||||||
|
with pytest.raises(ExecutionSnapshotError, match="job inputs changed"):
|
||||||
|
_ensure(_Session([job]), version)
|
||||||
|
|
||||||
|
|
||||||
|
def test_effect_check_verifies_only_the_claimed_job_in_constant_time() -> None:
|
||||||
|
job = _job()
|
||||||
|
version = _snapshotted_version(job)
|
||||||
|
session = SimpleNamespace(
|
||||||
|
query=lambda *_args: pytest.fail("per-effect validation must not rescan every campaign job")
|
||||||
|
)
|
||||||
|
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.execution.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=False),
|
||||||
|
):
|
||||||
|
ensure_execution_snapshot(
|
||||||
|
session, # type: ignore[arg-type]
|
||||||
|
version,
|
||||||
|
effect_job=job, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
433
tests/test_imap_append_idempotency.py
Normal file
433
tests/test_imap_append_idempotency.py
Normal file
@@ -0,0 +1,433 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime, timedelta, timezone
|
||||||
|
import importlib
|
||||||
|
from pathlib import Path
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from sqlalchemy import create_engine, text
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.db.models import (
|
||||||
|
CampaignJob,
|
||||||
|
ImapAppendAttempt,
|
||||||
|
JobImapStatus,
|
||||||
|
JobSendStatus,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.retention import _apply_eml_retention
|
||||||
|
from govoplan_campaign.backend.schemas import CampaignResolveOutcomeRequest
|
||||||
|
from govoplan_campaign.backend.sending.jobs import (
|
||||||
|
AppendSentResult,
|
||||||
|
QueueingError,
|
||||||
|
_claim_job_for_imap_append,
|
||||||
|
_record_imap_append_success,
|
||||||
|
append_sent_for_job,
|
||||||
|
reconcile_job_outcome,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("imap_status", "expected_status"),
|
||||||
|
[
|
||||||
|
(JobImapStatus.APPENDING.value, "append_in_progress"),
|
||||||
|
(JobImapStatus.OUTCOME_UNKNOWN.value, JobImapStatus.OUTCOME_UNKNOWN.value),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_in_progress_and_unknown_jobs_never_reinvoke_mail_provider(
|
||||||
|
imap_status: str,
|
||||||
|
expected_status: str,
|
||||||
|
) -> None:
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
send_status=JobSendStatus.SMTP_ACCEPTED.value,
|
||||||
|
imap_status=imap_status,
|
||||||
|
)
|
||||||
|
session = SimpleNamespace(get=lambda _model, _id: job)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._imap_attempt_count", return_value=1),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.mail_integration") as mail,
|
||||||
|
):
|
||||||
|
result = append_sent_for_job(
|
||||||
|
session, # type: ignore[arg-type]
|
||||||
|
job_id="job-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.status == expected_status
|
||||||
|
mail.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_imap_claim_is_a_single_atomic_state_transition() -> None:
|
||||||
|
session = MagicMock()
|
||||||
|
query = session.query.return_value
|
||||||
|
query.filter.return_value.update.return_value = 1
|
||||||
|
job = SimpleNamespace(id="job-1")
|
||||||
|
|
||||||
|
claim_token = _claim_job_for_imap_append(
|
||||||
|
session,
|
||||||
|
job, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert claim_token
|
||||||
|
changes = query.filter.return_value.update.call_args.args[0]
|
||||||
|
assert changes[CampaignJob.imap_status] == JobImapStatus.APPENDING.value
|
||||||
|
assert changes[CampaignJob.imap_claim_token] == claim_token
|
||||||
|
session.commit.assert_called_once_with()
|
||||||
|
session.expire_all.assert_called_once_with()
|
||||||
|
|
||||||
|
|
||||||
|
def test_late_provider_acknowledgement_cannot_overwrite_a_changed_claim() -> None:
|
||||||
|
session = MagicMock()
|
||||||
|
session.query.return_value.filter.return_value.update.return_value = 0
|
||||||
|
job = SimpleNamespace(id="job-1")
|
||||||
|
attempt = SimpleNamespace(id="attempt-1", attempt_number=1)
|
||||||
|
expected = AppendSentResult(
|
||||||
|
job_id="job-1",
|
||||||
|
status=JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
attempt_number=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._imap_result_after_lost_claim",
|
||||||
|
return_value=expected,
|
||||||
|
) as lost_claim,
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.files_integration") as files,
|
||||||
|
):
|
||||||
|
result = _record_imap_append_success(
|
||||||
|
session,
|
||||||
|
job=job, # type: ignore[arg-type]
|
||||||
|
attempt=attempt, # type: ignore[arg-type]
|
||||||
|
claim_token="claim-1",
|
||||||
|
folder="Sent",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result is expected
|
||||||
|
lost_claim.assert_called_once_with(
|
||||||
|
session,
|
||||||
|
job_id="job-1",
|
||||||
|
attempt=attempt,
|
||||||
|
provider_succeeded=True,
|
||||||
|
)
|
||||||
|
files.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_post_provider_persistence_failure_freezes_imap_retry() -> None:
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
send_status=JobSendStatus.SMTP_ACCEPTED.value,
|
||||||
|
imap_status=JobImapStatus.PENDING.value,
|
||||||
|
)
|
||||||
|
version = SimpleNamespace(id="version-1")
|
||||||
|
snapshot = SimpleNamespace(
|
||||||
|
mail_profile_id="profile-1",
|
||||||
|
smtp_transport_revision="smtp-revision",
|
||||||
|
imap_transport_revision="imap-revision",
|
||||||
|
delivery=SimpleNamespace(
|
||||||
|
imap_append_sent=SimpleNamespace(enabled=True, folder="Sent"),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
attempt = SimpleNamespace(id="attempt-1", attempt_number=1)
|
||||||
|
|
||||||
|
class Session:
|
||||||
|
def get(self, model, _object_id):
|
||||||
|
return version if model.__name__ == "CampaignVersion" else job
|
||||||
|
|
||||||
|
class Mail:
|
||||||
|
def append_campaign_message_to_sent(self, *_args, **_kwargs):
|
||||||
|
return SimpleNamespace(folder="Sent")
|
||||||
|
|
||||||
|
expected = AppendSentResult(
|
||||||
|
job_id="job-1",
|
||||||
|
status=JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
attempt_number=1,
|
||||||
|
)
|
||||||
|
session = Session()
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.ensure_execution_snapshot", return_value=snapshot),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._load_eml_bytes_for_job", return_value=b"message"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._claim_job_for_imap_append", return_value="claim-1"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._record_imap_attempt_start", return_value=attempt),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.mail_integration", return_value=Mail()),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._record_imap_append_success",
|
||||||
|
side_effect=OSError("database unavailable"),
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._mark_imap_append_outcome_unknown_after_effect",
|
||||||
|
return_value=expected,
|
||||||
|
) as mark_unknown,
|
||||||
|
):
|
||||||
|
result = append_sent_for_job(
|
||||||
|
session, # type: ignore[arg-type]
|
||||||
|
job_id="job-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result is expected
|
||||||
|
assert "Automatic retry is stopped" in mark_unknown.call_args.kwargs["reason"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_attempt_numbers_are_unique_per_job_in_the_model_contract() -> None:
|
||||||
|
constraints = {
|
||||||
|
constraint.name
|
||||||
|
for constraint in ImapAppendAttempt.__table__.constraints
|
||||||
|
}
|
||||||
|
assert "uq_imap_append_attempts_job_attempt" in constraints
|
||||||
|
|
||||||
|
|
||||||
|
def test_imap_claim_migration_preserves_and_renumbers_duplicate_attempts() -> None:
|
||||||
|
migration = importlib.import_module(
|
||||||
|
"govoplan_campaign.backend.migrations.versions.3c4d5e6f8192_v019_imap_append_claim"
|
||||||
|
)
|
||||||
|
engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||||
|
with engine.begin() as connection:
|
||||||
|
connection.execute(
|
||||||
|
text(
|
||||||
|
"CREATE TABLE imap_append_attempts ("
|
||||||
|
"id VARCHAR(36) PRIMARY KEY, job_id VARCHAR(36) NOT NULL, "
|
||||||
|
"attempt_number INTEGER NOT NULL, created_at DATETIME NOT NULL)"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
connection.execute(
|
||||||
|
text(
|
||||||
|
"INSERT INTO imap_append_attempts "
|
||||||
|
"(id, job_id, attempt_number, created_at) VALUES "
|
||||||
|
"('a2', 'job-1', 1, '2026-01-02'), "
|
||||||
|
"('a1', 'job-1', 1, '2026-01-01'), "
|
||||||
|
"('b1', 'job-2', 7, '2026-01-01')"
|
||||||
|
)
|
||||||
|
)
|
||||||
|
with patch.object(migration.op, "get_bind", return_value=connection):
|
||||||
|
migration._renumber_attempts()
|
||||||
|
rows = connection.execute(
|
||||||
|
text(
|
||||||
|
"SELECT id, job_id, attempt_number FROM imap_append_attempts "
|
||||||
|
"ORDER BY job_id, attempt_number"
|
||||||
|
)
|
||||||
|
).all()
|
||||||
|
|
||||||
|
assert rows == [
|
||||||
|
("a1", "job-1", 1),
|
||||||
|
("a2", "job-1", 2),
|
||||||
|
("b1", "job-2", 1),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("decision", ["smtp_accepted", "not_sent", "imap_appended", "imap_not_appended"])
|
||||||
|
def test_reconciliation_requires_an_evidence_note(decision: str) -> None:
|
||||||
|
with pytest.raises(ValueError, match="evidence note"):
|
||||||
|
CampaignResolveOutcomeRequest(
|
||||||
|
decision=decision, # type: ignore[arg-type]
|
||||||
|
note=" ",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("decision", "expected_status", "attempt_status"),
|
||||||
|
[
|
||||||
|
(
|
||||||
|
"imap_appended",
|
||||||
|
JobImapStatus.APPENDED.value,
|
||||||
|
"reconciled_imap_appended",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
"imap_not_appended",
|
||||||
|
JobImapStatus.FAILED.value,
|
||||||
|
"reconciled_imap_not_appended",
|
||||||
|
),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_imap_reconciliation_preserves_attempt_and_only_not_appended_is_retryable(
|
||||||
|
decision: str,
|
||||||
|
expected_status: str,
|
||||||
|
attempt_status: str,
|
||||||
|
) -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
send_status=JobSendStatus.SMTP_ACCEPTED.value,
|
||||||
|
imap_status=JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
imap_claimed_at=datetime.now(timezone.utc),
|
||||||
|
imap_claim_token="claim-1",
|
||||||
|
last_error="unknown",
|
||||||
|
)
|
||||||
|
attempt = SimpleNamespace(
|
||||||
|
id="attempt-1",
|
||||||
|
status=JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
error_message="unknown",
|
||||||
|
)
|
||||||
|
session = MagicMock()
|
||||||
|
session.get.return_value = job
|
||||||
|
session.query.return_value.filter.return_value.order_by.return_value.first.return_value = attempt
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant",
|
||||||
|
return_value=campaign,
|
||||||
|
),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.files_integration") as files,
|
||||||
|
):
|
||||||
|
result = reconcile_job_outcome(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
job_id="job-1",
|
||||||
|
decision=decision,
|
||||||
|
note="Mailbox UID evidence checked by operator 42.",
|
||||||
|
commit=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result["channel"] == "imap"
|
||||||
|
assert job.imap_status == expected_status
|
||||||
|
assert job.imap_claimed_at is None
|
||||||
|
assert job.imap_claim_token is None
|
||||||
|
assert attempt.status == attempt_status
|
||||||
|
assert attempt.error_message == "Mailbox UID evidence checked by operator 42."
|
||||||
|
assert attempt in session.add.call_args_list[0].args
|
||||||
|
session.flush.assert_called_once_with()
|
||||||
|
session.commit.assert_not_called()
|
||||||
|
if decision == "imap_appended":
|
||||||
|
files().mark_job_attachment_uses_sent.assert_called_once_with(session, job)
|
||||||
|
else:
|
||||||
|
files().mark_job_attachment_uses_sent.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"imap_status",
|
||||||
|
[JobImapStatus.APPENDING.value, JobImapStatus.FAILED.value, JobImapStatus.APPENDED.value],
|
||||||
|
)
|
||||||
|
def test_imap_reconciliation_rejects_live_retryable_or_completed_state(imap_status: str) -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
send_status=JobSendStatus.SMTP_ACCEPTED.value,
|
||||||
|
imap_status=imap_status,
|
||||||
|
)
|
||||||
|
session = MagicMock()
|
||||||
|
session.get.return_value = job
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant",
|
||||||
|
return_value=campaign,
|
||||||
|
):
|
||||||
|
with pytest.raises(QueueingError, match="does not require reconciliation"):
|
||||||
|
reconcile_job_outcome(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
job_id="job-1",
|
||||||
|
decision="imap_not_appended",
|
||||||
|
note="Checked mailbox.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("send_status", [JobSendStatus.CLAIMED.value, JobSendStatus.SENDING.value])
|
||||||
|
def test_smtp_reconciliation_rejects_a_live_worker_state(send_status: str) -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
send_status=send_status,
|
||||||
|
)
|
||||||
|
session = MagicMock()
|
||||||
|
session.get.return_value = job
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant",
|
||||||
|
return_value=campaign,
|
||||||
|
):
|
||||||
|
with pytest.raises(QueueingError, match="does not require reconciliation"):
|
||||||
|
reconcile_job_outcome(
|
||||||
|
session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
job_id="job-1",
|
||||||
|
decision="not_sent",
|
||||||
|
note="Checked provider logs.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("decision", "note"),
|
||||||
|
[
|
||||||
|
("smtp_accepted", "SMTP provider evidence checked."),
|
||||||
|
("imap_appended", "Mailbox evidence checked."),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_reconciliation_rolls_back_state_when_audit_fails(
|
||||||
|
decision: str,
|
||||||
|
note: str | None,
|
||||||
|
) -> None:
|
||||||
|
payload = CampaignResolveOutcomeRequest(decision=decision, note=note) # type: ignore[arg-type]
|
||||||
|
principal = SimpleNamespace(tenant_id="tenant-1")
|
||||||
|
session = MagicMock()
|
||||||
|
|
||||||
|
def mutate_without_commit(*_args, **kwargs):
|
||||||
|
assert kwargs["commit"] is False
|
||||||
|
session.flush()
|
||||||
|
return {"decision": decision, "job_id": "job-1"}
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.router._get_campaign_for_principal"),
|
||||||
|
patch("govoplan_campaign.backend.router._require_permission"),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.router.reconcile_job_outcome",
|
||||||
|
side_effect=mutate_without_commit,
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.router.audit_from_principal",
|
||||||
|
side_effect=RuntimeError("audit unavailable"),
|
||||||
|
),
|
||||||
|
):
|
||||||
|
with pytest.raises(RuntimeError, match="audit unavailable"):
|
||||||
|
router.resolve_campaign_job_outcome(
|
||||||
|
"campaign-1",
|
||||||
|
"job-1",
|
||||||
|
payload,
|
||||||
|
session=session,
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
session.commit.assert_not_called()
|
||||||
|
session.rollback.assert_called_once_with()
|
||||||
|
|
||||||
|
|
||||||
|
def test_retention_preserves_eml_for_unknown_imap_outcome(tmp_path: Path) -> None:
|
||||||
|
eml_path = tmp_path / "message.eml"
|
||||||
|
eml_path.write_bytes(b"message")
|
||||||
|
job = SimpleNamespace(
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
updated_at=datetime.now(timezone.utc) - timedelta(days=10),
|
||||||
|
queue_status="draft",
|
||||||
|
send_status=JobSendStatus.SMTP_ACCEPTED.value,
|
||||||
|
imap_status=JobImapStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
eml_local_path=str(eml_path),
|
||||||
|
eml_storage_key=None,
|
||||||
|
)
|
||||||
|
query = MagicMock()
|
||||||
|
query.filter.return_value.order_by.return_value.all.return_value = [job]
|
||||||
|
session = MagicMock()
|
||||||
|
session.query.return_value = query
|
||||||
|
policy = SimpleNamespace(generated_eml_retention_days=1)
|
||||||
|
|
||||||
|
result = _apply_eml_retention(
|
||||||
|
session,
|
||||||
|
dry_run=False,
|
||||||
|
now=datetime.now(timezone.utc),
|
||||||
|
policy_for_campaign_id=lambda _campaign_id: policy,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result["skipped_not_final"] == 1
|
||||||
|
assert eml_path.exists()
|
||||||
|
session.add.assert_not_called()
|
||||||
149
tests/test_job_list_query.py
Normal file
149
tests/test_job_list_query.py
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from fastapi import HTTPException
|
||||||
|
from sqlalchemy import create_engine
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_access.backend.db.models import Account, Group, User
|
||||||
|
from govoplan_campaign.backend.db.models import Campaign, CampaignJob, CampaignVersion
|
||||||
|
from govoplan_campaign.backend.router import (
|
||||||
|
_campaign_jobs_grid_filter_expressions,
|
||||||
|
_campaign_jobs_ordering,
|
||||||
|
_campaign_jobs_page_response,
|
||||||
|
)
|
||||||
|
from govoplan_core.core.change_sequence import ChangeSequenceEntry
|
||||||
|
from govoplan_core.db.base import Base
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignJobListQueryTests(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self.engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||||
|
Base.metadata.create_all(
|
||||||
|
self.engine,
|
||||||
|
tables=[
|
||||||
|
Account.__table__,
|
||||||
|
User.__table__,
|
||||||
|
Group.__table__,
|
||||||
|
Campaign.__table__,
|
||||||
|
CampaignVersion.__table__,
|
||||||
|
CampaignJob.__table__,
|
||||||
|
ChangeSequenceEntry.__table__,
|
||||||
|
],
|
||||||
|
)
|
||||||
|
self.session = Session(self.engine)
|
||||||
|
rows = [
|
||||||
|
(0, "ordinary-0@example.test", "General notice", "ready", "draft", "not_queued", "not_requested", 0),
|
||||||
|
(1, "ordinary-1@example.test", "General notice", "ready", "draft", "not_queued", "not_requested", 1),
|
||||||
|
(2, "target-c@example.test", "Target notice C", "warning", "queued", "queued", "pending", 2),
|
||||||
|
(3, "ordinary-3@example.test", "General notice", "blocked", "draft", "failed_permanent", "failed", 3),
|
||||||
|
(4, "target-b@example.test", "Target notice B", "ready", "draft", "failed_temporary", "not_requested", 4),
|
||||||
|
(5, "target-a@example.test", "Target notice A", "ready", "draft", "outcome_unknown", "outcome_unknown", 5),
|
||||||
|
(6, "excluded@example.test", "Excluded notice", "excluded", "draft", "skipped", "skipped", 0),
|
||||||
|
]
|
||||||
|
for entry_index, recipient, subject, validation, queue, send, imap, attempts in rows:
|
||||||
|
self.session.add(CampaignJob(
|
||||||
|
id=f"job-{entry_index}",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
entry_index=entry_index,
|
||||||
|
entry_id=f"entry-{entry_index}",
|
||||||
|
recipient_email=recipient,
|
||||||
|
subject=subject,
|
||||||
|
message_id_header=f"<message-{entry_index}@example.test>",
|
||||||
|
eml_sha256=f"sha-{entry_index}",
|
||||||
|
build_status="built",
|
||||||
|
validation_status=validation,
|
||||||
|
queue_status=queue,
|
||||||
|
send_status=send,
|
||||||
|
imap_status=imap,
|
||||||
|
attempt_count=attempts,
|
||||||
|
resolved_attachments=[],
|
||||||
|
issues_snapshot=[],
|
||||||
|
))
|
||||||
|
self.session.commit()
|
||||||
|
|
||||||
|
def tearDown(self) -> None:
|
||||||
|
self.session.close()
|
||||||
|
self.engine.dispose()
|
||||||
|
|
||||||
|
def test_grid_filters_apply_before_pagination_and_report_filtered_totals(self) -> None:
|
||||||
|
base_filters = [CampaignJob.tenant_id == "tenant-1", CampaignJob.campaign_id == "campaign-1"]
|
||||||
|
grid_filters = {"recipient": "target"}
|
||||||
|
filtered = [*base_filters, *_campaign_jobs_grid_filter_expressions(grid_filters)]
|
||||||
|
|
||||||
|
page = _campaign_jobs_page_response(
|
||||||
|
self.session,
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
base_filters=base_filters,
|
||||||
|
filtered=filtered,
|
||||||
|
reviewed_keys=set(),
|
||||||
|
review_metadata={},
|
||||||
|
page=1,
|
||||||
|
page_size=2,
|
||||||
|
grid_filters=grid_filters,
|
||||||
|
sort_by="recipient",
|
||||||
|
sort_direction="asc",
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(page.total, 3)
|
||||||
|
self.assertEqual(page.total_unfiltered, 7)
|
||||||
|
self.assertEqual(page.pages, 2)
|
||||||
|
self.assertEqual(
|
||||||
|
[row["recipient_email"] for row in page.jobs],
|
||||||
|
["target-a@example.test", "target-b@example.test"],
|
||||||
|
)
|
||||||
|
self.assertIsNone(page.next_cursor)
|
||||||
|
|
||||||
|
def test_list_and_integer_filters_share_the_full_backend_query(self) -> None:
|
||||||
|
expressions = _campaign_jobs_grid_filter_expressions({
|
||||||
|
"send": 'list:["failed_temporary","outcome_unknown"]',
|
||||||
|
"attempts": "gte:4",
|
||||||
|
})
|
||||||
|
|
||||||
|
rows = (
|
||||||
|
self.session.query(CampaignJob)
|
||||||
|
.filter(*expressions)
|
||||||
|
.order_by(*_campaign_jobs_ordering("attempts", "desc"))
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual([row.id for row in rows], ["job-5", "job-4"])
|
||||||
|
|
||||||
|
def test_invalid_list_filters_fail_closed(self) -> None:
|
||||||
|
with self.assertRaises(HTTPException) as raised:
|
||||||
|
_campaign_jobs_grid_filter_expressions({"send": 'list:["not-a-status"]'})
|
||||||
|
|
||||||
|
self.assertEqual(raised.exception.status_code, 422)
|
||||||
|
|
||||||
|
def test_skipped_transport_filters_and_counts_remain_separate(self) -> None:
|
||||||
|
base_filters = [CampaignJob.tenant_id == "tenant-1", CampaignJob.campaign_id == "campaign-1"]
|
||||||
|
grid_filters = {"send": 'list:["skipped"]', "imap": 'list:["skipped"]'}
|
||||||
|
filtered = [*base_filters, *_campaign_jobs_grid_filter_expressions(grid_filters)]
|
||||||
|
|
||||||
|
page = _campaign_jobs_page_response(
|
||||||
|
self.session,
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
base_filters=base_filters,
|
||||||
|
filtered=filtered,
|
||||||
|
reviewed_keys=set(),
|
||||||
|
review_metadata={},
|
||||||
|
page=1,
|
||||||
|
page_size=20,
|
||||||
|
grid_filters=grid_filters,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual([row["id"] for row in page.jobs], ["job-6"])
|
||||||
|
self.assertEqual(page.counts["send"]["skipped"], 1)
|
||||||
|
self.assertEqual(page.counts["send"]["not_queued"], 2)
|
||||||
|
self.assertEqual(page.counts["imap"]["skipped"], 1)
|
||||||
|
self.assertEqual(page.filtered_counts["send"], {"skipped": 1})
|
||||||
|
self.assertEqual(page.filtered_counts["imap"], {"skipped": 1})
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
248
tests/test_mail_profile_boundary.py
Normal file
248
tests/test_mail_profile_boundary.py
Normal file
@@ -0,0 +1,248 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import call, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi import HTTPException
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.campaign.loader import CampaignSchemaError, validate_against_schema
|
||||||
|
from govoplan_campaign.backend.campaign.mail_profile_boundary import (
|
||||||
|
CampaignMailProfileBoundaryError,
|
||||||
|
assert_campaign_uses_mail_profile_reference,
|
||||||
|
campaign_mail_profile_boundary_violations,
|
||||||
|
campaign_mail_profile_id,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.campaign.models import DeliveryConfig
|
||||||
|
from govoplan_campaign.backend.persistence.campaigns import CampaignPersistenceError, load_campaign_config_from_json
|
||||||
|
from govoplan_campaign.backend.persistence.versions import update_campaign_version
|
||||||
|
from govoplan_campaign.backend.integrations import MailCampaignIntegration
|
||||||
|
from govoplan_campaign.backend.sending.execution import ExecutionSnapshotError, create_execution_snapshot, ensure_execution_snapshot
|
||||||
|
from govoplan_campaign.backend.schemas import CampaignVersionUpdateRequest
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_json(server: dict[str, object] | None = None) -> dict[str, object]:
|
||||||
|
return {
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "campaign-1", "name": "Campaign", "mode": "send"},
|
||||||
|
"server": server or {},
|
||||||
|
"recipients": {"from": [{"email": "sender@example.test"}]},
|
||||||
|
"template": {"subject": "Subject", "text": "Body", "body_mode": "text"},
|
||||||
|
"entries": {"inline": []},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_mail_contract_accepts_only_a_stable_profile_reference() -> None:
|
||||||
|
raw = _campaign_json({"mail_profile_id": " profile-1 "})
|
||||||
|
|
||||||
|
assert_campaign_uses_mail_profile_reference(raw)
|
||||||
|
|
||||||
|
assert campaign_mail_profile_id(raw) == "profile-1"
|
||||||
|
assert campaign_mail_profile_boundary_violations(raw) == ()
|
||||||
|
|
||||||
|
|
||||||
|
def test_mail_profile_documentation_is_classified_for_adaptive_views() -> None:
|
||||||
|
from govoplan_campaign.backend.manifest import get_manifest
|
||||||
|
|
||||||
|
manifest = get_manifest()
|
||||||
|
topics = {topic.id: topic for topic in manifest.documentation}
|
||||||
|
|
||||||
|
workflow = topics["campaigns.mail-profile-user-journey"]
|
||||||
|
assert workflow.metadata["kind"] == "workflow"
|
||||||
|
assert workflow.metadata["route"] == "/campaigns/{campaign_id}/mail-settings"
|
||||||
|
assert workflow.conditions[0].required_scopes == (
|
||||||
|
"campaigns:campaign:update",
|
||||||
|
"mail:profile:use",
|
||||||
|
)
|
||||||
|
assert workflow.metadata["prerequisites"]
|
||||||
|
assert workflow.metadata["steps"]
|
||||||
|
assert workflow.metadata["outcome"]
|
||||||
|
assert workflow.metadata["verification"]
|
||||||
|
assert "campaigns.mail-profile-governance" in workflow.metadata["related_topic_ids"]
|
||||||
|
|
||||||
|
assert topics["campaigns.mail-profile-governance"].metadata["kind"] == "reference"
|
||||||
|
assert topics["campaigns.mail-profile-operations"].metadata["kind"] == "reference"
|
||||||
|
assert topics["campaigns.workflow.prepare-validate-and-build"].metadata["kind"] == "workflow"
|
||||||
|
assert topics["campaigns.workflow.complete-review"].metadata["kind"] == "workflow"
|
||||||
|
assert topics["campaigns.workflow.retry-and-reconcile"].metadata["kind"] == "workflow"
|
||||||
|
assert topics["campaigns.reference.composition-assurance"].metadata["kind"] == "reference"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("legacy_key", ["smtp", "imap", "credentials", "inherit_smtp_credentials", "profile_id"])
|
||||||
|
def test_campaign_mail_contract_rejects_every_legacy_server_field(legacy_key: str) -> None:
|
||||||
|
raw = _campaign_json({"mail_profile_id": "profile-1", legacy_key: {}})
|
||||||
|
|
||||||
|
with pytest.raises(CampaignMailProfileBoundaryError, match="select an authorized Mail profile"):
|
||||||
|
assert_campaign_uses_mail_profile_reference(raw)
|
||||||
|
|
||||||
|
|
||||||
|
def test_persisted_schema_rejects_inline_transport_even_without_a_secret() -> None:
|
||||||
|
with pytest.raises(CampaignSchemaError, match="Additional properties are not allowed"):
|
||||||
|
validate_against_schema(_campaign_json({"smtp": {"host": "smtp.example.test"}}))
|
||||||
|
|
||||||
|
|
||||||
|
def test_loader_rejects_inline_transport_before_optional_mail_summary() -> None:
|
||||||
|
integration = SimpleNamespace(campaign_profile_delivery_summary=lambda *_args, **_kwargs: pytest.fail("must not resolve"))
|
||||||
|
with patch("govoplan_campaign.backend.persistence.campaigns.mail_integration", return_value=integration):
|
||||||
|
with pytest.raises(CampaignMailProfileBoundaryError, match="remove campaign-local SMTP/IMAP settings"):
|
||||||
|
load_campaign_config_from_json(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
raw_json=_campaign_json({"smtp": {"password": "secret"}}),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_loader_uses_only_non_secret_mail_profile_capabilities() -> None:
|
||||||
|
raw = _campaign_json({"mail_profile_id": "profile-1"})
|
||||||
|
|
||||||
|
def summary(_session, **kwargs):
|
||||||
|
assert kwargs["profile_id"] == "profile-1"
|
||||||
|
return {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"smtp_available": True,
|
||||||
|
"imap_available": False,
|
||||||
|
"smtp_transport_revision": "opaque-smtp",
|
||||||
|
"imap_transport_revision": None,
|
||||||
|
# Even a broken/malicious provider cannot inject extra material into
|
||||||
|
# Campaign's strict in-memory ServerConfig.
|
||||||
|
"host": "smtp.example.test",
|
||||||
|
"password": "secret",
|
||||||
|
}
|
||||||
|
|
||||||
|
integration = SimpleNamespace(campaign_profile_delivery_summary=summary)
|
||||||
|
with patch("govoplan_campaign.backend.persistence.campaigns.mail_integration", return_value=integration):
|
||||||
|
config = load_campaign_config_from_json(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
raw_json=raw,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert raw["server"] == {"mail_profile_id": "profile-1"}
|
||||||
|
assert config.server.mail_profile_id == "profile-1"
|
||||||
|
assert config.server.profile_capabilities.smtp_available is True
|
||||||
|
assert config.server.profile_capabilities.imap_available is False
|
||||||
|
assert "smtp.example.test" not in repr(config.server)
|
||||||
|
assert "secret" not in repr(config.server)
|
||||||
|
|
||||||
|
|
||||||
|
def test_new_execution_snapshot_stores_reference_and_evidence_not_transport_material() -> None:
|
||||||
|
raw = _campaign_json({"mail_profile_id": "profile-1"})
|
||||||
|
version = SimpleNamespace(id="version-1", raw_json=raw)
|
||||||
|
|
||||||
|
payload, _digest = create_execution_snapshot(
|
||||||
|
version, # type: ignore[arg-type]
|
||||||
|
mail_profile_id="profile-1",
|
||||||
|
smtp_transport_revision="opaque-smtp-evidence",
|
||||||
|
imap_transport_revision="opaque-imap-evidence",
|
||||||
|
delivery=DeliveryConfig(),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert payload["snapshot_version"] == "5"
|
||||||
|
assert payload["mail_profile_id"] == "profile-1"
|
||||||
|
assert "smtp" not in payload
|
||||||
|
assert "imap" not in payload
|
||||||
|
assert payload["smtp_transport_revision"] == "opaque-smtp-evidence"
|
||||||
|
assert payload["imap_transport_revision"] == "opaque-imap-evidence"
|
||||||
|
|
||||||
|
|
||||||
|
def test_legacy_execution_snapshot_is_preserved_but_fails_closed() -> None:
|
||||||
|
version = SimpleNamespace(
|
||||||
|
raw_json=_campaign_json({"mail_profile_id": "profile-1"}),
|
||||||
|
execution_snapshot={"snapshot_version": "3", "smtp": {"host": "legacy.example.test"}},
|
||||||
|
execution_snapshot_hash=None,
|
||||||
|
)
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.execution.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=False),
|
||||||
|
):
|
||||||
|
with pytest.raises(ExecutionSnapshotError, match="preserved for audit only"):
|
||||||
|
ensure_execution_snapshot(object(), version) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
assert version.execution_snapshot["smtp"]["host"] == "legacy.example.test"
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_mail_adapter_does_not_expose_raw_transport_helpers() -> None:
|
||||||
|
integration = MailCampaignIntegration(SimpleNamespace())
|
||||||
|
|
||||||
|
for name in (
|
||||||
|
"smtp_config_from_profile",
|
||||||
|
"imap_config_from_profile",
|
||||||
|
"send_email_bytes",
|
||||||
|
"send_email_message",
|
||||||
|
"materialize_campaign_mail_profile_config",
|
||||||
|
):
|
||||||
|
assert not hasattr(integration, name)
|
||||||
|
|
||||||
|
|
||||||
|
def test_editing_a_legacy_record_requires_an_explicit_profile_migration() -> None:
|
||||||
|
legacy_raw = _campaign_json({"smtp": {"host": "smtp.example.test", "password": "secret"}})
|
||||||
|
version = SimpleNamespace(id="version-1", campaign_id="campaign-1", raw_json=legacy_raw)
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", current_version_id="version-1")
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.persistence.versions.get_campaign_version_for_tenant", return_value=version),
|
||||||
|
patch("govoplan_campaign.backend.persistence.versions._require_campaign", return_value=campaign),
|
||||||
|
patch("govoplan_campaign.backend.persistence.versions.ensure_current_working_version"),
|
||||||
|
patch("govoplan_campaign.backend.persistence.versions.is_version_locked", return_value=False),
|
||||||
|
):
|
||||||
|
with pytest.raises(CampaignPersistenceError, match="explicitly save the migration"):
|
||||||
|
update_campaign_version(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
raw_json=_campaign_json({"mail_profile_id": "profile-1"}),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert version.raw_json is legacy_raw
|
||||||
|
assert legacy_raw["server"]["smtp"]["password"] == "secret" # type: ignore[index]
|
||||||
|
|
||||||
|
|
||||||
|
def test_fork_inherited_profile_requires_mail_profile_use_scope() -> None:
|
||||||
|
principal = SimpleNamespace(
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
user=SimpleNamespace(id="user-1"),
|
||||||
|
)
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
source = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
raw_json={"server": {"mail_profile_id": "profile-1"}},
|
||||||
|
)
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
patch.object(router, "_require_permission"),
|
||||||
|
patch.object(router, "_get_version_for_tenant", return_value=source),
|
||||||
|
patch.object(router, "has_scope", return_value=False),
|
||||||
|
patch.object(router, "fork_campaign_version_for_edit") as fork,
|
||||||
|
):
|
||||||
|
with pytest.raises(HTTPException) as captured:
|
||||||
|
router.fork_version_for_edit(
|
||||||
|
"campaign-1",
|
||||||
|
"version-1",
|
||||||
|
CampaignVersionUpdateRequest(),
|
||||||
|
session=object(), # type: ignore[arg-type]
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert captured.value.status_code == 403
|
||||||
|
fork.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_wide_effect_authorizes_every_affected_version() -> None:
|
||||||
|
session = object()
|
||||||
|
principal = SimpleNamespace(tenant_id="tenant-1")
|
||||||
|
|
||||||
|
with patch.object(router, "_require_campaign_profile_use_if_needed") as require_profile:
|
||||||
|
router._require_campaign_versions_profile_use( # noqa: SLF001 - security boundary regression test
|
||||||
|
session, # type: ignore[arg-type]
|
||||||
|
principal, # type: ignore[arg-type]
|
||||||
|
"campaign-1",
|
||||||
|
{"version-2", "version-1"},
|
||||||
|
)
|
||||||
|
|
||||||
|
assert require_profile.call_args_list == [
|
||||||
|
call(session, principal, "campaign-1", "version-1"),
|
||||||
|
call(session, principal, "campaign-1", "version-2"),
|
||||||
|
]
|
||||||
480
tests/test_mail_testbed_acceptance.py
Normal file
480
tests/test_mail_testbed_acceptance.py
Normal file
@@ -0,0 +1,480 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import json
|
||||||
|
import smtplib
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign import load_campaign_config
|
||||||
|
|
||||||
|
|
||||||
|
REPOSITORY_ROOT = Path(__file__).resolve().parents[1]
|
||||||
|
RUNNER_PATH = REPOSITORY_ROOT / "dev" / "mail-testbed" / "run_campaign_acceptance.py"
|
||||||
|
FIXTURE_PATH = REPOSITORY_ROOT / "examples" / "greenmail-delivery" / "campaign.json"
|
||||||
|
|
||||||
|
|
||||||
|
def _load_runner():
|
||||||
|
spec = importlib.util.spec_from_file_location("govoplan_campaign_greenmail_acceptance", RUNNER_PATH)
|
||||||
|
assert spec is not None and spec.loader is not None
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
sys.modules[spec.name] = module
|
||||||
|
spec.loader.exec_module(module)
|
||||||
|
return module
|
||||||
|
|
||||||
|
|
||||||
|
runner = _load_runner()
|
||||||
|
|
||||||
|
|
||||||
|
class _Response:
|
||||||
|
def __init__(self, status_code: int, payload: dict[str, Any]) -> None:
|
||||||
|
self.status_code = status_code
|
||||||
|
self._payload = payload
|
||||||
|
|
||||||
|
def json(self) -> dict[str, Any]:
|
||||||
|
return self._payload
|
||||||
|
|
||||||
|
|
||||||
|
class _AcceptanceClient:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.campaign_json: dict[str, Any] | None = None
|
||||||
|
self.send_calls = 0
|
||||||
|
|
||||||
|
def post(self, path: str, **kwargs: Any) -> _Response:
|
||||||
|
if path == "/api/v1/campaigns":
|
||||||
|
self.campaign_json = kwargs["json"]["config"]
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"campaign": {"id": "campaign-internal"},
|
||||||
|
"version": {"id": "version-internal"},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if path.endswith("/validate"):
|
||||||
|
return _Response(200, {"ok": True, "error_count": 0, "warning_count": 0})
|
||||||
|
if path.endswith("/build"):
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"built_count": 1,
|
||||||
|
"build_failed_count": 0,
|
||||||
|
"queueable_count": 1,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if path.endswith("/send-now"):
|
||||||
|
self.send_calls += 1
|
||||||
|
if self.send_calls == 2:
|
||||||
|
return _Response(422, {"detail": "Already accepted"})
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"result": {
|
||||||
|
"attempted_count": 1,
|
||||||
|
"sent_count": 1,
|
||||||
|
"failed_count": 0,
|
||||||
|
"outcome_unknown_count": 0,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"delivery_mode": "synchronous",
|
||||||
|
"results": [{"job_id": "not-retained", "status": "smtp_accepted"}],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if path.endswith("/append-sent"):
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"result": {
|
||||||
|
"pending_count": 1,
|
||||||
|
"processed_count": 1,
|
||||||
|
"appended_count": 1,
|
||||||
|
"failed_count": 0,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"results": [{"job_id": "not-retained", "status": "appended"}],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)
|
||||||
|
raise AssertionError(f"unexpected POST {path}")
|
||||||
|
|
||||||
|
def get(self, path: str, **kwargs: Any) -> _Response:
|
||||||
|
if path.endswith("/report"):
|
||||||
|
return _Response(
|
||||||
|
200,
|
||||||
|
{
|
||||||
|
"cards": {
|
||||||
|
"jobs_total": 1,
|
||||||
|
"sent": 1,
|
||||||
|
"smtp_accepted": 1,
|
||||||
|
"failed": 0,
|
||||||
|
"outcome_unknown": 0,
|
||||||
|
"retryable": 0,
|
||||||
|
"needs_attention": 0,
|
||||||
|
"imap_appended": 1,
|
||||||
|
"imap_failed": 0,
|
||||||
|
},
|
||||||
|
"status_counts": {
|
||||||
|
"send": {"smtp_accepted": 1},
|
||||||
|
"imap": {"appended": 1},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
raise AssertionError(f"unexpected GET {path}")
|
||||||
|
|
||||||
|
|
||||||
|
def _settings():
|
||||||
|
return runner.TestbedSettings(
|
||||||
|
smtp_host="127.0.0.1",
|
||||||
|
smtp_port=3025,
|
||||||
|
imap_host="127.0.0.1",
|
||||||
|
imap_port=3143,
|
||||||
|
username="campaign-test@govoplan.test",
|
||||||
|
password="local-test-password",
|
||||||
|
sender="campaign-test@govoplan.test",
|
||||||
|
recipient="campaign-test@govoplan.test",
|
||||||
|
sent_folder="Sent",
|
||||||
|
provider_timeout_seconds=5,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("host", ["localhost", "mail.test", "192.168.1.20", "8.8.8.8"])
|
||||||
|
def test_testbed_rejects_hostnames_and_non_loopback_addresses(host: str) -> None:
|
||||||
|
settings = _settings()
|
||||||
|
rejected = runner.TestbedSettings(
|
||||||
|
smtp_host=host,
|
||||||
|
smtp_port=settings.smtp_port,
|
||||||
|
imap_host=settings.imap_host,
|
||||||
|
imap_port=settings.imap_port,
|
||||||
|
username=settings.username,
|
||||||
|
password=settings.password,
|
||||||
|
sender=settings.sender,
|
||||||
|
recipient=settings.recipient,
|
||||||
|
sent_folder=settings.sent_folder,
|
||||||
|
provider_timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="literal loopback|restricted to the loopback"):
|
||||||
|
rejected.assert_local_testbed()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("host", ["127.0.0.1", "127.8.9.10", "::1"])
|
||||||
|
def test_testbed_accepts_literal_loopback_and_preserves_it_in_profile(host: str) -> None:
|
||||||
|
settings = _settings()
|
||||||
|
accepted = runner.TestbedSettings(
|
||||||
|
smtp_host=host,
|
||||||
|
smtp_port=settings.smtp_port,
|
||||||
|
imap_host=host,
|
||||||
|
imap_port=settings.imap_port,
|
||||||
|
username=settings.username,
|
||||||
|
password=settings.password,
|
||||||
|
sender=settings.sender,
|
||||||
|
recipient=settings.recipient,
|
||||||
|
sent_folder=settings.sent_folder,
|
||||||
|
provider_timeout_seconds=settings.provider_timeout_seconds,
|
||||||
|
)
|
||||||
|
|
||||||
|
accepted.assert_local_testbed()
|
||||||
|
profile = runner._profile_payload(accepted, name="Literal loopback")
|
||||||
|
assert profile["smtp"]["host"] == host
|
||||||
|
assert profile["imap"]["host"] == host
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_acceptance_orchestration_retains_only_profile_reference_and_safe_evidence() -> None:
|
||||||
|
client = _AcceptanceClient()
|
||||||
|
|
||||||
|
def snapshot_probe(_version_id: str):
|
||||||
|
assert client.campaign_json is not None
|
||||||
|
return client.campaign_json, {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"smtp_transport_revision": "opaque-smtp-revision",
|
||||||
|
"imap_transport_revision": "opaque-imap-revision",
|
||||||
|
"delivery": {"imap_append_sent": {"enabled": True, "folder": "Sent"}},
|
||||||
|
}
|
||||||
|
|
||||||
|
audit = {
|
||||||
|
"campaign.created": 1,
|
||||||
|
"campaign.validated": 1,
|
||||||
|
"campaign.messages_built": 1,
|
||||||
|
"campaign.sent_now": 1,
|
||||||
|
"campaign.send_now_rejected": 1,
|
||||||
|
"campaign.append_sent_enqueued": 1,
|
||||||
|
}
|
||||||
|
evidence, subject = runner.execute_campaign_scenario(
|
||||||
|
client,
|
||||||
|
{"Authorization": "not-retained"},
|
||||||
|
fixture_path=FIXTURE_PATH,
|
||||||
|
profile_id="profile-1",
|
||||||
|
settings=_settings(),
|
||||||
|
scenario="success",
|
||||||
|
snapshot_probe=snapshot_probe,
|
||||||
|
audit_probe=lambda _campaign_id, _version_id: audit,
|
||||||
|
append_sent=True,
|
||||||
|
repeat_send=True,
|
||||||
|
)
|
||||||
|
evidence["provider_verification"] = {
|
||||||
|
"inbox_increment": 1,
|
||||||
|
"sent_increment": 1,
|
||||||
|
"unique_subject_matches_in_inbox": 1,
|
||||||
|
"unique_subject_matches_in_sent": 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
runner._assert_success_evidence(evidence)
|
||||||
|
runner._assert_evidence_safe(
|
||||||
|
{
|
||||||
|
"schema_version": runner.EVIDENCE_SCHEMA,
|
||||||
|
"coverage": {
|
||||||
|
"smtp_acceptance": True,
|
||||||
|
"partial_envelope_refusal": False,
|
||||||
|
"post_data_connection_loss_outcome_unknown": False,
|
||||||
|
"source_artifact_provenance": False,
|
||||||
|
"worker_restart_interruption": False,
|
||||||
|
},
|
||||||
|
"success": evidence,
|
||||||
|
},
|
||||||
|
settings=_settings(),
|
||||||
|
)
|
||||||
|
assert subject.startswith("[GovOPlaN acceptance ")
|
||||||
|
assert client.send_calls == 2
|
||||||
|
assert client.campaign_json is not None
|
||||||
|
assert client.campaign_json["server"] == {"mail_profile_id": "profile-1"}
|
||||||
|
assert "credentials" not in json.dumps(client.campaign_json).casefold()
|
||||||
|
serialized = json.dumps(evidence, sort_keys=True)
|
||||||
|
assert "not-retained" not in serialized
|
||||||
|
assert "local-test-password" not in serialized
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_boundary_rejects_resolved_transport_material() -> None:
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="forbidden transport material"):
|
||||||
|
runner.assert_campaign_boundary(
|
||||||
|
{"server": {"mail_profile_id": "profile-1"}},
|
||||||
|
{
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"smtp_transport_revision": "smtp-revision",
|
||||||
|
"imap_transport_revision": "imap-revision",
|
||||||
|
"smtp": {"host": "should-not-be-here"},
|
||||||
|
},
|
||||||
|
profile_id="profile-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_success_projection_fails_closed_on_inconsistent_campaign_report() -> None:
|
||||||
|
evidence = {
|
||||||
|
"send": {
|
||||||
|
"attempted_count": 1,
|
||||||
|
"sent_count": 1,
|
||||||
|
"failed_count": 0,
|
||||||
|
"outcome_unknown_count": 0,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"delivery_mode": "synchronous",
|
||||||
|
"statuses": {"smtp_accepted": 1},
|
||||||
|
},
|
||||||
|
"append_sent": {
|
||||||
|
"pending_count": 1,
|
||||||
|
"processed_count": 1,
|
||||||
|
"appended_count": 1,
|
||||||
|
"failed_count": 0,
|
||||||
|
"skipped_count": 0,
|
||||||
|
"statuses": {"appended": 1},
|
||||||
|
},
|
||||||
|
"report": {
|
||||||
|
"cards": {
|
||||||
|
"jobs_total": 1,
|
||||||
|
"sent": 0,
|
||||||
|
"smtp_accepted": 0,
|
||||||
|
"failed": 0,
|
||||||
|
"outcome_unknown": 0,
|
||||||
|
"needs_attention": 0,
|
||||||
|
"imap_appended": 0,
|
||||||
|
"imap_failed": 0,
|
||||||
|
},
|
||||||
|
"send_status_counts": {},
|
||||||
|
"imap_status_counts": {},
|
||||||
|
},
|
||||||
|
"provider_verification": {
|
||||||
|
"inbox_increment": 1,
|
||||||
|
"sent_increment": 1,
|
||||||
|
"unique_subject_matches_in_inbox": 1,
|
||||||
|
"unique_subject_matches_in_sent": 1,
|
||||||
|
},
|
||||||
|
"campaign_mail_boundary": {
|
||||||
|
"profile_reference_only": True,
|
||||||
|
"smtp_revision_frozen": True,
|
||||||
|
"imap_revision_frozen": True,
|
||||||
|
"resolved_transport_material_present": False,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="report does not agree"):
|
||||||
|
runner._assert_success_evidence(evidence)
|
||||||
|
|
||||||
|
|
||||||
|
def test_evidence_projection_rejects_unknown_status_keys() -> None:
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="unsupported status"):
|
||||||
|
runner._send_evidence(
|
||||||
|
{
|
||||||
|
"delivery_mode": "synchronous",
|
||||||
|
"results": [{"status": "provider diagnostic: recipient@example.test"}],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="durable attempt status"):
|
||||||
|
runner._durable_state_evidence(
|
||||||
|
{
|
||||||
|
"job_count": 1,
|
||||||
|
"send_status_counts": {"sending": 1},
|
||||||
|
"attempt_status_counts": {"provider-secret": 1},
|
||||||
|
"unfinished_attempt_count": 1,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="synchronous delivery mode"):
|
||||||
|
runner._send_evidence(
|
||||||
|
{
|
||||||
|
"delivery_mode": "provider diagnostic: recipient@example.test",
|
||||||
|
"results": [],
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="unsupported"):
|
||||||
|
runner._report_evidence(
|
||||||
|
{
|
||||||
|
"cards": {},
|
||||||
|
"status_counts": {
|
||||||
|
"send": {"smtp_accepted": 1, "provider-secret": 1},
|
||||||
|
"imap": {},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _open_fault_smtp(endpoint):
|
||||||
|
client = smtplib.SMTP(endpoint.host, endpoint.port, timeout=5)
|
||||||
|
client.ehlo()
|
||||||
|
client.login("acceptance-user", "acceptance-password")
|
||||||
|
return client
|
||||||
|
|
||||||
|
|
||||||
|
def test_explicit_temporary_smtp_response_occurs_after_complete_data() -> None:
|
||||||
|
with runner.smtp_fault_endpoint("temporary_data_response") as endpoint:
|
||||||
|
client = _open_fault_smtp(endpoint)
|
||||||
|
try:
|
||||||
|
with pytest.raises(smtplib.SMTPDataError) as captured:
|
||||||
|
client.sendmail(
|
||||||
|
"sender@example.test",
|
||||||
|
["recipient@example.test"],
|
||||||
|
b"Subject: temporary\r\n\r\nmessage",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
client.close()
|
||||||
|
assert captured.value.smtp_code == 451
|
||||||
|
assert endpoint.evidence() == {
|
||||||
|
"connection_count": 1,
|
||||||
|
"accepted_rcpt_commands": 1,
|
||||||
|
"refused_rcpt_commands": 0,
|
||||||
|
"data_transactions": 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_partial_recipient_refusal_retains_one_accepted_envelope() -> None:
|
||||||
|
with runner.smtp_fault_endpoint("partial_recipient_refusal") as endpoint:
|
||||||
|
client = _open_fault_smtp(endpoint)
|
||||||
|
try:
|
||||||
|
refused = client.sendmail(
|
||||||
|
"sender@example.test",
|
||||||
|
["accepted@example.test", "refused@example.test"],
|
||||||
|
b"Subject: partial\r\n\r\nmessage",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
client.quit()
|
||||||
|
assert set(refused) == {"refused@example.test"}
|
||||||
|
assert endpoint.evidence() == {
|
||||||
|
"connection_count": 1,
|
||||||
|
"accepted_rcpt_commands": 1,
|
||||||
|
"refused_rcpt_commands": 1,
|
||||||
|
"data_transactions": 1,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_post_data_disconnect_is_a_real_ambiguous_protocol_boundary() -> None:
|
||||||
|
with runner.smtp_fault_endpoint("post_data_disconnect") as endpoint:
|
||||||
|
client = _open_fault_smtp(endpoint)
|
||||||
|
try:
|
||||||
|
with pytest.raises(smtplib.SMTPServerDisconnected):
|
||||||
|
client.sendmail(
|
||||||
|
"sender@example.test",
|
||||||
|
["recipient@example.test"],
|
||||||
|
b"Subject: ambiguous\r\n\r\nmessage",
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
client.close()
|
||||||
|
assert endpoint.wait_for_data(1)
|
||||||
|
assert endpoint.evidence()["data_transactions"] == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_partial_refusal_fixture_adds_a_second_distinct_recipient() -> None:
|
||||||
|
raw, _subject = runner.materialize_campaign_fixture(
|
||||||
|
FIXTURE_PATH,
|
||||||
|
profile_id="profile-1",
|
||||||
|
settings=_settings(),
|
||||||
|
scenario="partial_envelope_refusal",
|
||||||
|
run_token="0123456789ab",
|
||||||
|
additional_envelope_recipient=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
recipients = raw["entries"]["inline"][0]["to"]
|
||||||
|
assert len(recipients) == 2
|
||||||
|
assert recipients[0]["email"] != recipients[1]["email"]
|
||||||
|
assert recipients[1]["email"].endswith("@govoplan.test")
|
||||||
|
|
||||||
|
def test_fixture_contains_no_transport_credentials() -> None:
|
||||||
|
raw = json.loads(FIXTURE_PATH.read_text(encoding="utf-8"))
|
||||||
|
runner._assert_no_forbidden_campaign_keys(raw)
|
||||||
|
assert raw["server"] == {"mail_profile_id": "00000000-0000-4000-8000-000000000001"}
|
||||||
|
config = load_campaign_config(FIXTURE_PATH)
|
||||||
|
assert config.server.mail_profile_id == "00000000-0000-4000-8000-000000000001"
|
||||||
|
|
||||||
|
|
||||||
|
def test_fixture_composition_versions_are_complete_and_exact() -> None:
|
||||||
|
versions = {
|
||||||
|
"core": "0.1.13",
|
||||||
|
"access": "0.1.11",
|
||||||
|
"audit": "0.1.8",
|
||||||
|
"campaigns": "0.1.11",
|
||||||
|
"mail": "0.1.10",
|
||||||
|
"files": "0.1.9",
|
||||||
|
}
|
||||||
|
|
||||||
|
assert runner.required_composition_versions(FIXTURE_PATH, versions) == {
|
||||||
|
"core": "0.1.13",
|
||||||
|
"access": "0.1.11",
|
||||||
|
"audit": "0.1.8",
|
||||||
|
"campaigns": "0.1.11",
|
||||||
|
"mail": "0.1.10",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_fixture_composition_fails_closed_when_a_required_version_is_missing() -> None:
|
||||||
|
with pytest.raises(runner.AcceptanceError, match="versions are unavailable"):
|
||||||
|
runner.required_composition_versions(
|
||||||
|
FIXTURE_PATH,
|
||||||
|
{
|
||||||
|
"core": "0.1.13",
|
||||||
|
"access": "0.1.11",
|
||||||
|
"campaigns": "0.1.11",
|
||||||
|
"mail": "0.1.10",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_testbed_documentation_distinguishes_proven_and_open_failure_drills() -> None:
|
||||||
|
testbed = (REPOSITORY_ROOT / "dev" / "mail-testbed" / "README.md").read_text(encoding="utf-8")
|
||||||
|
runbook = (REPOSITORY_ROOT / "docs" / "CAMPAIGN_DELIVERY_RUNBOOK.md").read_text(encoding="utf-8")
|
||||||
|
|
||||||
|
assert "second ordinary send must be rejected before another provider effect" in testbed
|
||||||
|
assert "connection loss after complete DATA is frozen" in testbed
|
||||||
|
assert "dedicated OS process" in testbed
|
||||||
|
assert "Redis/Celery delivery" in runbook
|
||||||
|
assert "broker redelivery" in runbook
|
||||||
|
assert "celery_broker_redelivery" in testbed
|
||||||
|
assert "raw provider diagnostics" in runbook
|
||||||
66
tests/test_mock_campaign_helpers.py
Normal file
66
tests/test_mock_campaign_helpers.py
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from types import SimpleNamespace
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.dev.mock_campaign import (
|
||||||
|
_MockSendBatch,
|
||||||
|
_mock_send_steps,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class MockCampaignStepTests(unittest.TestCase):
|
||||||
|
def test_preview_marks_delivery_steps_as_skipped(self):
|
||||||
|
validation = SimpleNamespace(ok=True)
|
||||||
|
build = SimpleNamespace(
|
||||||
|
built_count=2,
|
||||||
|
queueable_count=2,
|
||||||
|
needs_review_count=0,
|
||||||
|
blocked_count=0,
|
||||||
|
)
|
||||||
|
|
||||||
|
steps = _mock_send_steps(
|
||||||
|
validation_report=validation,
|
||||||
|
validation_payload={"ok": True},
|
||||||
|
build_report=build,
|
||||||
|
send_batch=_MockSendBatch(results=[]),
|
||||||
|
send=False,
|
||||||
|
append_sent=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
[step["status"] for step in steps],
|
||||||
|
["ok", "ok", "skipped", "skipped"],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_delivery_failures_require_review(self):
|
||||||
|
validation = SimpleNamespace(ok=False)
|
||||||
|
build = SimpleNamespace(
|
||||||
|
built_count=1,
|
||||||
|
queueable_count=0,
|
||||||
|
needs_review_count=1,
|
||||||
|
blocked_count=0,
|
||||||
|
)
|
||||||
|
batch = _MockSendBatch(
|
||||||
|
results=[],
|
||||||
|
failed_count=1,
|
||||||
|
imap_failed_count=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
steps = _mock_send_steps(
|
||||||
|
validation_report=validation,
|
||||||
|
validation_payload={"ok": False},
|
||||||
|
build_report=build,
|
||||||
|
send_batch=batch,
|
||||||
|
send=True,
|
||||||
|
append_sent=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
[step["status"] for step in steps],
|
||||||
|
["needs_review", "needs_review", "needs_review", "needs_review"],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
174
tests/test_partial_validation.py
Normal file
174
tests/test_partial_validation.py
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
||||||
|
from govoplan_campaign.backend.campaign.validation import validate_campaign_config
|
||||||
|
from govoplan_campaign.backend.persistence.versions import validate_campaign_partial
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignPartialValidationTests(unittest.TestCase):
|
||||||
|
def test_partial_validation_reports_counts_across_sections(self) -> None:
|
||||||
|
result = validate_campaign_partial({
|
||||||
|
"campaign": {},
|
||||||
|
"recipients": {"from": {}},
|
||||||
|
"entries": {"source": {}, "mapping": {}},
|
||||||
|
"template": {"body_mode": "both"},
|
||||||
|
"attachments": {},
|
||||||
|
"delivery": {"rate_limit": {"messages_per_minute": 0}},
|
||||||
|
})
|
||||||
|
|
||||||
|
codes = {item["code"] for item in result["issues"]}
|
||||||
|
self.assertFalse(result["ok"])
|
||||||
|
self.assertEqual(3, result["error_count"])
|
||||||
|
self.assertIn("missing_campaign_id", codes)
|
||||||
|
self.assertIn("missing_email_mapping", codes)
|
||||||
|
self.assertIn("missing_template_text_body", codes)
|
||||||
|
self.assertIn("missing_attachment_base_path", codes)
|
||||||
|
self.assertIn("invalid_rate_limit", codes)
|
||||||
|
|
||||||
|
def test_partial_validation_filters_to_requested_section(self) -> None:
|
||||||
|
result = validate_campaign_partial(
|
||||||
|
{
|
||||||
|
"campaign": {},
|
||||||
|
"template": {"body_mode": "text"},
|
||||||
|
"delivery": {"rate_limit": {"messages_per_minute": "fast"}},
|
||||||
|
},
|
||||||
|
section="template",
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertTrue(result["ok"])
|
||||||
|
self.assertEqual("template", result["section"])
|
||||||
|
self.assertEqual(0, result["error_count"])
|
||||||
|
self.assertEqual({"missing_subject", "missing_template_text_body"}, {item["code"] for item in result["issues"]})
|
||||||
|
|
||||||
|
def test_address_lookup_returns_unavailable_when_addresses_capability_absent(self) -> None:
|
||||||
|
with patch.object(router, "_get_campaign_for_principal", return_value=None), patch.object(router, "_registry_capability", return_value=None):
|
||||||
|
response = router.lookup_campaign_addresses("campaign-1", query="", session=object(), principal=object())
|
||||||
|
|
||||||
|
self.assertFalse(response.available)
|
||||||
|
self.assertEqual(response.candidates, [])
|
||||||
|
|
||||||
|
def test_address_lookup_accepts_empty_query_for_suggestion_preload(self) -> None:
|
||||||
|
class LookupCapability:
|
||||||
|
def lookup(self, _session, _principal, *, query: str, limit: int):
|
||||||
|
self.query = query
|
||||||
|
self.limit = limit
|
||||||
|
return [{
|
||||||
|
"contact_id": "contact-1",
|
||||||
|
"address_book_id": "book-1",
|
||||||
|
"display_name": "Ada Lovelace",
|
||||||
|
"email": "ada@example.local",
|
||||||
|
"email_label": "work",
|
||||||
|
"tags": [],
|
||||||
|
"source_kind": "local",
|
||||||
|
"provenance": {"module": "addresses"},
|
||||||
|
}]
|
||||||
|
|
||||||
|
capability = LookupCapability()
|
||||||
|
with patch.object(router, "_get_campaign_for_principal", return_value=None), patch.object(router, "_registry_capability", return_value=capability):
|
||||||
|
response = router.lookup_campaign_addresses("campaign-1", query="", limit=100, session=object(), principal=object())
|
||||||
|
|
||||||
|
self.assertEqual(capability.query, "")
|
||||||
|
self.assertEqual(capability.limit, 100)
|
||||||
|
self.assertTrue(response.available)
|
||||||
|
self.assertEqual(response.candidates[0].email, "ada@example.local")
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignSemanticValidationTests(unittest.TestCase):
|
||||||
|
def test_send_mode_requires_campaign_owned_sender_for_each_inline_entry(self) -> None:
|
||||||
|
config = CampaignConfig.model_validate({
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "campaign-1", "name": "Campaign", "mode": "send"},
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"profile_capabilities": {"smtp_available": True},
|
||||||
|
},
|
||||||
|
"recipients": {"allow_individual_from": True},
|
||||||
|
"template": {"subject": "Subject", "text": "Body", "body_mode": "text"},
|
||||||
|
"entries": {
|
||||||
|
"inline": [
|
||||||
|
{"id": "ready", "from": [{"email": "sender@example.local"}]},
|
||||||
|
{"id": "missing"},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
report = validate_campaign_config(config)
|
||||||
|
|
||||||
|
missing_sender = [issue for issue in report.issues if issue.code == "missing_sender"]
|
||||||
|
self.assertEqual(1, len(missing_sender))
|
||||||
|
self.assertEqual("/entries/inline/1/from", missing_sender[0].path)
|
||||||
|
|
||||||
|
def test_semantic_validation_reports_zip_delivery_and_external_mapping_issues(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as tmp:
|
||||||
|
root = Path(tmp)
|
||||||
|
(root / "recipients.csv").write_text("email\nada@example.local\n", encoding="utf-8")
|
||||||
|
campaign_file = root / "campaign.json"
|
||||||
|
config = CampaignConfig.model_validate({
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "campaign-1", "name": "Campaign", "mode": "send"},
|
||||||
|
"fields": [
|
||||||
|
{"name": "pin", "type": "string", "can_override": False},
|
||||||
|
{"name": "secret", "type": "password"},
|
||||||
|
],
|
||||||
|
"global_values": {"unknown": "value"},
|
||||||
|
"recipients": {
|
||||||
|
"from": [{"email": "sender@example.local"}],
|
||||||
|
"to": [{"email": "recipient@example.local"}],
|
||||||
|
},
|
||||||
|
"template": {"subject": "Subject", "text": "Body", "body_mode": "text"},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": "attachments",
|
||||||
|
"zip": {
|
||||||
|
"enabled": True,
|
||||||
|
"archives": [
|
||||||
|
{
|
||||||
|
"id": "main",
|
||||||
|
"name": "bundle.zip",
|
||||||
|
"standard": True,
|
||||||
|
"password_enabled": True,
|
||||||
|
"password_field": "secret",
|
||||||
|
"password_scope": "global",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"entries": {
|
||||||
|
"source": {"type": "csv", "path": "recipients.csv", "has_header": True},
|
||||||
|
"mapping": {"fields.pin": "missing_pin", "fields.unknown": "missing_unknown"},
|
||||||
|
"defaults": {
|
||||||
|
"attachments": [
|
||||||
|
{
|
||||||
|
"base_dir": "",
|
||||||
|
"file_filter": "*.pdf",
|
||||||
|
"zip": {"archive_id": "missing-archive"},
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"delivery": {"imap_append_sent": {"enabled": True}},
|
||||||
|
})
|
||||||
|
|
||||||
|
report = validate_campaign_config(config, campaign_file=campaign_file, check_files=True)
|
||||||
|
|
||||||
|
codes = {issue.code for issue in report.issues}
|
||||||
|
self.assertFalse(report.ok)
|
||||||
|
self.assertEqual("external:csv", report.entries_mode)
|
||||||
|
self.assertIsNone(report.entries_count)
|
||||||
|
self.assertIn("unknown_global_value", codes)
|
||||||
|
self.assertIn("zip_global_password_value_missing", codes)
|
||||||
|
self.assertIn("zip_archive_unknown", codes)
|
||||||
|
self.assertIn("missing_mail_profile", codes)
|
||||||
|
self.assertIn("unknown_mapping_target", codes)
|
||||||
|
self.assertIn("mapping_target_not_overridable", codes)
|
||||||
|
self.assertIn("mapping_columns_missing", codes)
|
||||||
|
self.assertIn("attachments_base_path_not_found", codes)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
216
tests/test_queue_controls.py
Normal file
216
tests/test_queue_controls.py
Normal file
@@ -0,0 +1,216 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from sqlalchemy import create_engine
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from govoplan_access.backend.db.models import Account, Group, User
|
||||||
|
from govoplan_campaign.backend.db.models import (
|
||||||
|
Campaign,
|
||||||
|
CampaignJob,
|
||||||
|
CampaignStatus,
|
||||||
|
CampaignVersion,
|
||||||
|
JobBuildStatus,
|
||||||
|
JobQueueStatus,
|
||||||
|
JobSendStatus,
|
||||||
|
JobValidationStatus,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.sending.jobs import (
|
||||||
|
QueueingError,
|
||||||
|
cancel_campaign_jobs,
|
||||||
|
pause_campaign_jobs,
|
||||||
|
resume_campaign_jobs,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.reports.campaigns import _campaign_report_cards, _version_info
|
||||||
|
from govoplan_core.core.change_sequence import ChangeSequenceEntry, ChangeSequenceRetentionFloor
|
||||||
|
from govoplan_core.db.base import Base
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignQueueControlTests(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self.engine = create_engine("sqlite+pysqlite:///:memory:")
|
||||||
|
Base.metadata.create_all(
|
||||||
|
self.engine,
|
||||||
|
tables=[
|
||||||
|
Account.__table__,
|
||||||
|
User.__table__,
|
||||||
|
Group.__table__,
|
||||||
|
ChangeSequenceEntry.__table__,
|
||||||
|
ChangeSequenceRetentionFloor.__table__,
|
||||||
|
Campaign.__table__,
|
||||||
|
CampaignVersion.__table__,
|
||||||
|
CampaignJob.__table__,
|
||||||
|
],
|
||||||
|
)
|
||||||
|
self.session = Session(self.engine)
|
||||||
|
self._add_campaign("campaign-1", "tenant-1", "version-1")
|
||||||
|
self._add_campaign("campaign-2", "tenant-2", "version-2")
|
||||||
|
self._add_job("queued", queue="queued", send="queued")
|
||||||
|
self._add_job("paused", queue="paused", send="queued")
|
||||||
|
self._add_job("failed", queue="draft", send="failed_temporary")
|
||||||
|
self._add_job("unknown", queue="draft", send="outcome_unknown")
|
||||||
|
self._add_job("accepted", queue="draft", send="smtp_accepted")
|
||||||
|
self._add_job("claimed", queue="sending", send="claimed")
|
||||||
|
self._add_job(
|
||||||
|
"excluded",
|
||||||
|
queue="draft",
|
||||||
|
send="skipped",
|
||||||
|
validation="excluded",
|
||||||
|
imap="skipped",
|
||||||
|
)
|
||||||
|
self._add_job(
|
||||||
|
"other-tenant",
|
||||||
|
tenant_id="tenant-2",
|
||||||
|
campaign_id="campaign-2",
|
||||||
|
version_id="version-2",
|
||||||
|
queue="queued",
|
||||||
|
send="queued",
|
||||||
|
)
|
||||||
|
self.session.commit()
|
||||||
|
|
||||||
|
def tearDown(self) -> None:
|
||||||
|
self.session.close()
|
||||||
|
self.engine.dispose()
|
||||||
|
|
||||||
|
def test_pause_and_resume_change_only_valid_jobs_in_the_selected_tenant(self) -> None:
|
||||||
|
with patch("govoplan_campaign.backend.sending.jobs._emit_campaign_status_notification"):
|
||||||
|
paused = pause_campaign_jobs(
|
||||||
|
self.session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
resumed = resume_campaign_jobs(
|
||||||
|
self.session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
enqueue_celery=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(paused["paused_count"], 1)
|
||||||
|
self.assertEqual(resumed, {
|
||||||
|
"campaign_id": "campaign-1",
|
||||||
|
"resumed_count": 2,
|
||||||
|
"enqueued_count": 0,
|
||||||
|
})
|
||||||
|
self.session.expire_all()
|
||||||
|
self.assertEqual(self.session.get(Campaign, "campaign-1").status, CampaignStatus.QUEUED.value)
|
||||||
|
version = self.session.get(CampaignVersion, "version-1")
|
||||||
|
self.assertEqual(version.delivery_mode, "database_queue")
|
||||||
|
self.assertIsNotNone(version.delivery_mode_selected_at)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "queued").queue_status, JobQueueStatus.QUEUED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "paused").queue_status, JobQueueStatus.QUEUED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "other-tenant").queue_status, JobQueueStatus.QUEUED.value)
|
||||||
|
|
||||||
|
def test_cancel_is_auditable_idempotent_state_change_and_protects_started_effects(self) -> None:
|
||||||
|
with patch("govoplan_campaign.backend.sending.jobs._emit_campaign_status_notification"):
|
||||||
|
first = cancel_campaign_jobs(
|
||||||
|
self.session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
second = cancel_campaign_jobs(
|
||||||
|
self.session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(first["cancelled_count"], 3)
|
||||||
|
self.assertEqual(first["protected_count"], 3)
|
||||||
|
self.assertEqual(first["skipped_count"], 1)
|
||||||
|
self.assertEqual(second["cancelled_count"], 0)
|
||||||
|
self.assertEqual(second["protected_count"], 3)
|
||||||
|
self.assertEqual(second["skipped_count"], 1)
|
||||||
|
self.session.expire_all()
|
||||||
|
for job_id in ("queued", "paused", "failed"):
|
||||||
|
job = self.session.get(CampaignJob, job_id)
|
||||||
|
self.assertEqual(job.queue_status, JobQueueStatus.CANCELLED.value)
|
||||||
|
self.assertEqual(job.send_status, JobSendStatus.CANCELLED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "unknown").send_status, JobSendStatus.OUTCOME_UNKNOWN.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "accepted").send_status, JobSendStatus.SMTP_ACCEPTED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "claimed").send_status, JobSendStatus.CLAIMED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "excluded").send_status, JobSendStatus.SKIPPED.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "excluded").queue_status, JobQueueStatus.DRAFT.value)
|
||||||
|
self.assertEqual(self.session.get(CampaignJob, "other-tenant").send_status, JobSendStatus.QUEUED.value)
|
||||||
|
|
||||||
|
def test_controls_fail_closed_for_a_campaign_owned_by_another_tenant(self) -> None:
|
||||||
|
for control in (pause_campaign_jobs, resume_campaign_jobs, cancel_campaign_jobs):
|
||||||
|
with self.subTest(control=control.__name__), self.assertRaises(QueueingError):
|
||||||
|
control(
|
||||||
|
self.session,
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-2",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_queue_projection_exposes_exact_action_counts_and_persisted_mode_only(self) -> None:
|
||||||
|
version = self.session.get(CampaignVersion, "version-1")
|
||||||
|
version.delivery_mode = "worker_queue"
|
||||||
|
version.delivery_mode_selected_at = version.updated_at
|
||||||
|
jobs = (
|
||||||
|
self.session.query(CampaignJob)
|
||||||
|
.filter(CampaignJob.tenant_id == "tenant-1")
|
||||||
|
.all()
|
||||||
|
)
|
||||||
|
|
||||||
|
cards = _campaign_report_cards(version, jobs)
|
||||||
|
projected_version = _version_info(version)
|
||||||
|
|
||||||
|
self.assertEqual(cards["retryable"], 1)
|
||||||
|
self.assertEqual(cards["queueable_unattempted"], 0)
|
||||||
|
self.assertEqual(cards["cancellable"], 3)
|
||||||
|
self.assertEqual(cards["skipped"], 1)
|
||||||
|
self.assertEqual(cards["imap_skipped"], 1)
|
||||||
|
self.assertEqual(projected_version["delivery_mode"], "worker_queue")
|
||||||
|
self.assertIn("delivery_mode_selected_at", projected_version)
|
||||||
|
self.assertNotIn("execution_snapshot", projected_version)
|
||||||
|
|
||||||
|
def _add_campaign(self, campaign_id: str, tenant_id: str, version_id: str) -> None:
|
||||||
|
self.session.add(Campaign(
|
||||||
|
id=campaign_id,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
external_id=f"external-{campaign_id}",
|
||||||
|
name=campaign_id,
|
||||||
|
status=CampaignStatus.QUEUED.value,
|
||||||
|
current_version_id=version_id,
|
||||||
|
settings={},
|
||||||
|
mail_profile_policy={},
|
||||||
|
))
|
||||||
|
self.session.add(CampaignVersion(
|
||||||
|
id=version_id,
|
||||||
|
campaign_id=campaign_id,
|
||||||
|
version_number=1,
|
||||||
|
raw_json={},
|
||||||
|
))
|
||||||
|
|
||||||
|
def _add_job(
|
||||||
|
self,
|
||||||
|
job_id: str,
|
||||||
|
*,
|
||||||
|
queue: str,
|
||||||
|
send: str,
|
||||||
|
tenant_id: str = "tenant-1",
|
||||||
|
campaign_id: str = "campaign-1",
|
||||||
|
version_id: str = "version-1",
|
||||||
|
validation: str = JobValidationStatus.READY.value,
|
||||||
|
imap: str = "not_requested",
|
||||||
|
) -> None:
|
||||||
|
self.session.add(CampaignJob(
|
||||||
|
id=job_id,
|
||||||
|
tenant_id=tenant_id,
|
||||||
|
campaign_id=campaign_id,
|
||||||
|
campaign_version_id=version_id,
|
||||||
|
entry_index=len(self.session.new),
|
||||||
|
entry_id=f"entry-{job_id}",
|
||||||
|
build_status=JobBuildStatus.BUILT.value,
|
||||||
|
validation_status=validation,
|
||||||
|
queue_status=queue,
|
||||||
|
send_status=send,
|
||||||
|
imap_status=imap,
|
||||||
|
resolved_attachments=[],
|
||||||
|
issues_snapshot=[],
|
||||||
|
))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
175
tests/test_report_email_security.py
Normal file
175
tests/test_report_email_security.py
Normal file
@@ -0,0 +1,175 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi import HTTPException
|
||||||
|
from pydantic import ValidationError
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.reports.emailing import CampaignReportEmailError, send_campaign_report_email
|
||||||
|
from govoplan_campaign.backend.schemas import ReportEmailRequest
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_email_recipient_schema_normalizes_and_has_safe_attachment_default() -> None:
|
||||||
|
request = ReportEmailRequest.model_validate({
|
||||||
|
"to": [" First@Example.test ", "first@example.test", "second@example.test"],
|
||||||
|
})
|
||||||
|
|
||||||
|
assert request.to == ["First@Example.test", "second@example.test"]
|
||||||
|
assert request.attach_jobs_csv is False
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"recipients",
|
||||||
|
[
|
||||||
|
[],
|
||||||
|
[f"recipient-{index}@example.test" for index in range(51)],
|
||||||
|
["a" * 310 + "@example.test"],
|
||||||
|
["victim@example.test\r\nBcc: attacker@example.test"],
|
||||||
|
["missing-at.example.test"],
|
||||||
|
["@example.test"],
|
||||||
|
["local@"],
|
||||||
|
["local @example.test"],
|
||||||
|
["one@two@example.test"],
|
||||||
|
["victim@example.test,Bcc:attacker"],
|
||||||
|
["Display<a@example.test>"],
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_report_email_recipient_schema_rejects_unsafe_addresses(recipients: list[str]) -> None:
|
||||||
|
with pytest.raises(ValidationError):
|
||||||
|
ReportEmailRequest.model_validate({"to": recipients})
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_jobs_csv_attachment_requires_recipient_export_permission() -> None:
|
||||||
|
payload = ReportEmailRequest(to=["recipient@example.test"], attach_jobs_csv=True)
|
||||||
|
principal = SimpleNamespace(tenant_id="tenant-1")
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"_get_campaign_for_principal",
|
||||||
|
return_value=SimpleNamespace(id="campaign-1", current_version_id=None),
|
||||||
|
),
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"_require_permission",
|
||||||
|
side_effect=HTTPException(status_code=403, detail="missing export"),
|
||||||
|
) as require_permission,
|
||||||
|
patch.object(router, "send_campaign_report_email") as send_report,
|
||||||
|
):
|
||||||
|
with pytest.raises(HTTPException) as captured:
|
||||||
|
router.email_campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
payload,
|
||||||
|
session=object(), # type: ignore[arg-type]
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert captured.value.status_code == 403
|
||||||
|
require_permission.assert_called_once_with(principal, "campaigns:recipient:export")
|
||||||
|
send_report.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_email_requires_permission_to_use_selected_mail_profile() -> None:
|
||||||
|
payload = ReportEmailRequest(to=["recipient@example.test"])
|
||||||
|
principal = SimpleNamespace(
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
has=lambda scope: scope == "campaigns:recipient:export",
|
||||||
|
)
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", current_version_id="version-1")
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
raw_json={"server": {"mail_profile_id": "profile-1"}},
|
||||||
|
)
|
||||||
|
session = SimpleNamespace(get=lambda _model, _id: version)
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"_require_mail_profile_use_if_needed",
|
||||||
|
side_effect=HTTPException(status_code=403, detail="missing profile use"),
|
||||||
|
) as require_profile_use,
|
||||||
|
patch.object(router, "send_campaign_report_email") as send_report,
|
||||||
|
):
|
||||||
|
with pytest.raises(HTTPException) as captured:
|
||||||
|
router.email_campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
payload,
|
||||||
|
session=session, # type: ignore[arg-type]
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert captured.value.status_code == 403
|
||||||
|
require_profile_use.assert_called_once_with(principal, version.raw_json)
|
||||||
|
send_report.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_unexpected_report_failure_does_not_leak_internal_details() -> None:
|
||||||
|
payload = ReportEmailRequest(to=["recipient@example.test"])
|
||||||
|
principal = SimpleNamespace(
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
has=lambda scope: scope == "campaigns:recipient:export",
|
||||||
|
)
|
||||||
|
with (
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"_get_campaign_for_principal",
|
||||||
|
return_value=SimpleNamespace(id="campaign-1", current_version_id=None),
|
||||||
|
),
|
||||||
|
patch.object(
|
||||||
|
router,
|
||||||
|
"send_campaign_report_email",
|
||||||
|
side_effect=RuntimeError("smtp.internal.example provider-secret"),
|
||||||
|
),
|
||||||
|
):
|
||||||
|
with pytest.raises(HTTPException) as captured:
|
||||||
|
router.email_campaign_report(
|
||||||
|
"campaign-1",
|
||||||
|
payload,
|
||||||
|
session=object(), # type: ignore[arg-type]
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert captured.value.status_code == 500
|
||||||
|
assert captured.value.detail == "Campaign report email could not be completed."
|
||||||
|
|
||||||
|
|
||||||
|
def test_report_send_fails_closed_until_durable_mail_outbox_exists() -> None:
|
||||||
|
campaign = SimpleNamespace(
|
||||||
|
id="campaign-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
name="Campaign",
|
||||||
|
external_id="campaign-1",
|
||||||
|
)
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
raw_json={"server": {"mail_profile_id": "profile-1"}},
|
||||||
|
execution_snapshot={"snapshot_version": "5"},
|
||||||
|
)
|
||||||
|
config = SimpleNamespace(
|
||||||
|
server=SimpleNamespace(profile_capabilities=SimpleNamespace(smtp_available=True)),
|
||||||
|
)
|
||||||
|
snapshot = SimpleNamespace(smtp_transport_revision="frozen-build-revision")
|
||||||
|
class Session:
|
||||||
|
def get(self, _model, _id):
|
||||||
|
return campaign
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.reports.emailing._selected_version", return_value=version),
|
||||||
|
patch("govoplan_campaign.backend.reports.emailing._load_config", return_value=config),
|
||||||
|
patch("govoplan_campaign.backend.reports.emailing.ensure_execution_snapshot", return_value=snapshot),
|
||||||
|
patch("govoplan_campaign.backend.reports.emailing.generate_campaign_report") as generate_report,
|
||||||
|
):
|
||||||
|
with pytest.raises(CampaignReportEmailError, match="durable, idempotent Mail-owned outbox"):
|
||||||
|
send_campaign_report_email(
|
||||||
|
Session(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
to=["recipient@example.test"],
|
||||||
|
)
|
||||||
|
|
||||||
|
generate_report.assert_not_called()
|
||||||
292
tests/test_response_security.py
Normal file
292
tests/test_response_security.py
Normal file
@@ -0,0 +1,292 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import stat
|
||||||
|
import unittest
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from types import SimpleNamespace
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.response_security import public_campaign_payload
|
||||||
|
from govoplan_campaign.backend.router import (
|
||||||
|
_job_attempts_payload,
|
||||||
|
_job_detail_payload,
|
||||||
|
_job_diagnostics_payload,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.schemas import CampaignVersionDetailResponse, CampaignVersionResponse
|
||||||
|
|
||||||
|
|
||||||
|
def _now() -> datetime:
|
||||||
|
return datetime(2026, 7, 21, 12, 0, tzinfo=UTC)
|
||||||
|
|
||||||
|
|
||||||
|
def _job() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
entry_index=1,
|
||||||
|
entry_id="recipient-1",
|
||||||
|
recipient_email="person@example.test",
|
||||||
|
subject="Subject",
|
||||||
|
message_id_header="<message@example.test>",
|
||||||
|
build_status="built",
|
||||||
|
validation_status="ready",
|
||||||
|
queue_status="claimed",
|
||||||
|
send_status="sending",
|
||||||
|
imap_status="pending",
|
||||||
|
eml_size_bytes=123,
|
||||||
|
eml_sha256="sha256",
|
||||||
|
eml_local_path="/runtime/campaign/job-1.eml",
|
||||||
|
eml_storage_key="campaign/job-1.eml",
|
||||||
|
claim_token="job-claim-secret",
|
||||||
|
attempt_count=1,
|
||||||
|
last_error="smtp.internal.example /srv/private provider-secret",
|
||||||
|
queued_at=_now(),
|
||||||
|
claimed_at=_now(),
|
||||||
|
smtp_started_at=_now(),
|
||||||
|
outcome_unknown_at=None,
|
||||||
|
sent_at=None,
|
||||||
|
created_at=_now(),
|
||||||
|
updated_at=_now(),
|
||||||
|
issues_snapshot=[],
|
||||||
|
resolved_attachments=[
|
||||||
|
{
|
||||||
|
"filename": "public.pdf",
|
||||||
|
"local_path": "/tmp/materialized/public.pdf",
|
||||||
|
"storage_key": "private/blob-key",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
resolved_recipients={"to": [{"email": "person@example.test"}]},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _smtp_attempt() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="smtp-attempt-1",
|
||||||
|
attempt_number=1,
|
||||||
|
status="started",
|
||||||
|
claim_token="attempt-claim-secret",
|
||||||
|
smtp_status_code=None,
|
||||||
|
smtp_response="smtp.internal.example provider-secret",
|
||||||
|
error_type="/srv/private/ProviderError",
|
||||||
|
error_message="credential=provider-secret",
|
||||||
|
started_at=_now(),
|
||||||
|
finished_at=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _imap_attempt() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="imap-attempt-1",
|
||||||
|
attempt_number=1,
|
||||||
|
status="claimed",
|
||||||
|
claim_token="imap-claim-secret",
|
||||||
|
folder="Sent",
|
||||||
|
error_message="imap.internal.example /srv/private provider-secret",
|
||||||
|
created_at=_now(),
|
||||||
|
updated_at=_now(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_public_payload_recursively_removes_infrastructure_locators() -> None:
|
||||||
|
source = {
|
||||||
|
"campaign_file": "/tmp/campaign.json",
|
||||||
|
"messages": [
|
||||||
|
{
|
||||||
|
"subject": "Public",
|
||||||
|
"eml_path": "/tmp/message.eml",
|
||||||
|
"managed": {"storage_bucket": "private", "storage_key": "object"},
|
||||||
|
}
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
result = public_campaign_payload(source)
|
||||||
|
|
||||||
|
assert result == {"messages": [{"subject": "Public", "managed": {}}]}
|
||||||
|
assert source["messages"][0]["eml_path"] == "/tmp/message.eml"
|
||||||
|
|
||||||
|
|
||||||
|
def test_version_response_omits_source_base_path_and_sanitizes_summaries() -> None:
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_number=1,
|
||||||
|
schema_version="1",
|
||||||
|
source_filename="/srv/govoplan/imports/campaign.json",
|
||||||
|
source_base_path="/private/import/path",
|
||||||
|
workflow_state="editing",
|
||||||
|
current_flow="manual",
|
||||||
|
current_step=None,
|
||||||
|
is_complete=False,
|
||||||
|
editor_state={},
|
||||||
|
autosaved_at=None,
|
||||||
|
published_at=None,
|
||||||
|
locked_at=None,
|
||||||
|
locked_by_user_id=None,
|
||||||
|
user_lock_state=None,
|
||||||
|
user_locked_at=None,
|
||||||
|
user_locked_by_user_id=None,
|
||||||
|
created_at=_now(),
|
||||||
|
updated_at=_now(),
|
||||||
|
validation_summary={"campaign_file": "/tmp/campaign.json", "ok": True},
|
||||||
|
build_summary={
|
||||||
|
"build_token": "internal-build-token",
|
||||||
|
"smtp_transport_revision": "internal-smtp-revision",
|
||||||
|
"messages": [{"eml_path": "/tmp/message.eml", "subject": "Public"}],
|
||||||
|
},
|
||||||
|
execution_snapshot_hash=None,
|
||||||
|
execution_snapshot_at=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
payload = CampaignVersionResponse.model_validate(version).model_dump()
|
||||||
|
|
||||||
|
assert "source_base_path" not in payload
|
||||||
|
assert payload["source_filename"] == "campaign.json"
|
||||||
|
assert payload["validation_summary"] == {"ok": True}
|
||||||
|
assert payload["build_summary"] == {"messages": [{"subject": "Public"}]}
|
||||||
|
|
||||||
|
operator_payload = CampaignVersionResponse.model_validate(
|
||||||
|
version,
|
||||||
|
context={"include_diagnostics": True},
|
||||||
|
).model_dump()
|
||||||
|
assert operator_payload["build_summary"]["build_token"] == "internal-build-token"
|
||||||
|
assert operator_payload["build_summary"]["smtp_transport_revision"] == "internal-smtp-revision"
|
||||||
|
|
||||||
|
detail = CampaignVersionDetailResponse.model_validate(
|
||||||
|
SimpleNamespace(
|
||||||
|
**version.__dict__,
|
||||||
|
raw_json={
|
||||||
|
"campaign": {"title": "Public"},
|
||||||
|
"files": [{"storage_key": "private/object", "filename": "public.pdf"}],
|
||||||
|
"server": {
|
||||||
|
"mail_profile_id": "profile-1",
|
||||||
|
"smtp": {"host": "smtp.example.invalid", "password": "smtp-secret"},
|
||||||
|
"imap": {"host": "imap.example.invalid", "password": "imap-secret"},
|
||||||
|
"credentials": {
|
||||||
|
"smtp": {"username": "sender", "password": "legacy-smtp-secret"},
|
||||||
|
"imap": {"username": "archive", "password": "legacy-imap-secret"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"archives": [{"password": "business-zip-password"}],
|
||||||
|
"template": {
|
||||||
|
"source": {
|
||||||
|
"subject_path": "/srv/govoplan/templates/subject.txt",
|
||||||
|
"html_path": "templates/body.html",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"entries": {"source": {"type": "csv", "path": "C:\\imports\\recipients.csv"}},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": "/srv/govoplan/attachments",
|
||||||
|
"base_paths": [
|
||||||
|
{"name": "Shared", "path": "/mnt/shared/campaign", "source": "/mnt/shared"}
|
||||||
|
],
|
||||||
|
"global": [{"base_dir": "/srv/govoplan/attachments/global", "file_filter": "*.pdf"}],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
)
|
||||||
|
).model_dump()
|
||||||
|
assert detail["raw_json"] == {
|
||||||
|
"campaign": {"title": "Public"},
|
||||||
|
"files": [{"filename": "public.pdf"}],
|
||||||
|
"server": {"mail_profile_id": "profile-1"},
|
||||||
|
"archives": [{"password": "business-zip-password"}],
|
||||||
|
"template": {
|
||||||
|
"source": {
|
||||||
|
"subject_path": "subject.txt",
|
||||||
|
"html_path": "templates/body.html",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"entries": {"source": {"type": "csv", "path": "recipients.csv"}},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": "attachments",
|
||||||
|
"base_paths": [{"name": "Shared", "path": "campaign", "source": "shared"}],
|
||||||
|
"global": [{"base_dir": "global", "file_filter": "*.pdf"}],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def test_ordinary_job_detail_and_attempts_do_not_expose_diagnostics() -> None:
|
||||||
|
job_payload = _job_detail_payload(_job()) # type: ignore[arg-type]
|
||||||
|
attempts = _job_attempts_payload([_smtp_attempt()], [_imap_attempt()]) # type: ignore[list-item]
|
||||||
|
|
||||||
|
assert "eml_local_path" not in job_payload
|
||||||
|
assert "eml_storage_key" not in job_payload
|
||||||
|
assert "claimed_at" not in job_payload
|
||||||
|
assert "smtp_started_at" not in job_payload
|
||||||
|
assert job_payload["attachments"] == [{"filename": "public.pdf"}]
|
||||||
|
assert "claim_token" not in attempts["smtp"][0]
|
||||||
|
assert "claim_token" not in attempts["imap"][0]
|
||||||
|
assert "smtp_response" not in attempts["smtp"][0]
|
||||||
|
assert "error_type" not in attempts["smtp"][0]
|
||||||
|
assert "error_message" not in attempts["smtp"][0]
|
||||||
|
assert "error_message" not in attempts["imap"][0]
|
||||||
|
ordinary = repr({"job": job_payload, "attempts": attempts})
|
||||||
|
assert "internal.example" not in ordinary
|
||||||
|
assert "/srv/private" not in ordinary
|
||||||
|
assert "provider-secret" not in ordinary
|
||||||
|
|
||||||
|
|
||||||
|
def test_operator_diagnostics_include_claim_and_storage_details() -> None:
|
||||||
|
diagnostics = _job_diagnostics_payload( # type: ignore[arg-type, list-item]
|
||||||
|
_job(),
|
||||||
|
[_smtp_attempt()],
|
||||||
|
[_imap_attempt()],
|
||||||
|
).model_dump()
|
||||||
|
|
||||||
|
assert diagnostics["storage"]["eml_local_path"] == "/runtime/campaign/job-1.eml"
|
||||||
|
assert diagnostics["storage"]["eml_storage_key"] == "campaign/job-1.eml"
|
||||||
|
assert diagnostics["worker_claim"]["claim_token"] == "job-claim-secret"
|
||||||
|
assert diagnostics["attempts"]["smtp"][0]["claim_token"] == "attempt-claim-secret"
|
||||||
|
assert diagnostics["attempts"]["imap"][0]["claim_token"] == "imap-claim-secret"
|
||||||
|
assert "smtp.internal.example" in diagnostics["attempts"]["smtp"][0]["smtp_response"]
|
||||||
|
assert "imap.internal.example" in diagnostics["attempts"]["imap"][0]["error_message"]
|
||||||
|
assert "provider-secret" in diagnostics["worker_claim"]["last_error"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_diagnostics_permission_is_operator_only_by_default() -> None:
|
||||||
|
from govoplan_campaign.backend.manifest import PERMISSIONS, ROLE_TEMPLATES
|
||||||
|
|
||||||
|
permission_scopes = {permission.scope for permission in PERMISSIONS}
|
||||||
|
role_permissions = {role.slug: set(role.permissions) for role in ROLE_TEMPLATES}
|
||||||
|
|
||||||
|
assert "campaigns:diagnostic:read" in permission_scopes
|
||||||
|
assert "campaigns:diagnostic:read" in role_permissions["campaign_sender"]
|
||||||
|
assert "campaigns:diagnostic:read" not in role_permissions["campaign_manager"]
|
||||||
|
assert "campaigns:diagnostic:read" not in role_permissions["campaign_reviewer"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_campaign_snapshot_with_inline_credentials_is_owner_only(tmp_path, monkeypatch) -> None:
|
||||||
|
from govoplan_campaign.backend.persistence import campaigns as persistence
|
||||||
|
|
||||||
|
snapshots = tmp_path / "snapshots"
|
||||||
|
output = tmp_path / "generated"
|
||||||
|
monkeypatch.setattr(persistence, "CAMPAIGN_SNAPSHOT_DIR", snapshots)
|
||||||
|
monkeypatch.setattr(persistence, "BUILD_OUTPUT_DIR", output)
|
||||||
|
path = persistence._write_campaign_snapshot( # type: ignore[arg-type]
|
||||||
|
SimpleNamespace(id="version-secret", raw_json={"server": {"smtp": {"password": "secret"}}})
|
||||||
|
)
|
||||||
|
|
||||||
|
assert stat.S_IMODE(path.stat().st_mode) == 0o600
|
||||||
|
assert stat.S_IMODE(snapshots.stat().st_mode) == 0o700
|
||||||
|
assert stat.S_IMODE(output.stat().st_mode) == 0o700
|
||||||
|
|
||||||
|
|
||||||
|
class ResponseSecurityTests(unittest.TestCase):
|
||||||
|
def test_public_payload(self) -> None:
|
||||||
|
test_public_payload_recursively_removes_infrastructure_locators()
|
||||||
|
|
||||||
|
def test_version_response(self) -> None:
|
||||||
|
test_version_response_omits_source_base_path_and_sanitizes_summaries()
|
||||||
|
|
||||||
|
def test_ordinary_job_response(self) -> None:
|
||||||
|
test_ordinary_job_detail_and_attempts_do_not_expose_diagnostics()
|
||||||
|
|
||||||
|
def test_operator_diagnostics(self) -> None:
|
||||||
|
test_operator_diagnostics_include_claim_and_storage_details()
|
||||||
|
|
||||||
|
def test_operator_permission(self) -> None:
|
||||||
|
test_diagnostics_permission_is_operator_only_by_default()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
133
tests/test_send_now_response_security.py
Normal file
133
tests/test_send_now_response_security.py
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.schemas import SendCampaignNowRequest
|
||||||
|
from govoplan_campaign.backend.sending.jobs import SendCampaignNowResult
|
||||||
|
|
||||||
|
|
||||||
|
def test_send_now_omits_provider_and_recipient_text_from_response_and_audit() -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", current_version_id="version-1")
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
raw_json={},
|
||||||
|
locked_at=datetime(2026, 7, 22, tzinfo=UTC),
|
||||||
|
validation_summary={
|
||||||
|
"ok": True,
|
||||||
|
"error_count": 0,
|
||||||
|
"warning_count": 1,
|
||||||
|
"issues": [{"message": "provider-secret validation detail"}],
|
||||||
|
},
|
||||||
|
build_summary={
|
||||||
|
"built_count": 2,
|
||||||
|
"build_failed_count": 0,
|
||||||
|
"ready_count": 2,
|
||||||
|
"warning_count": 1,
|
||||||
|
"messages": [{"recipient": "refused-recipient@example.test"}],
|
||||||
|
"build_token": "provider-secret-build-token",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
delivery = SendCampaignNowResult(
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
attempted_count=2,
|
||||||
|
sent_count=1,
|
||||||
|
failed_count=1,
|
||||||
|
outcome_unknown_count=0,
|
||||||
|
skipped_count=0,
|
||||||
|
preflight_count=2,
|
||||||
|
synchronous_send_policy={
|
||||||
|
"max_recipient_jobs": 25,
|
||||||
|
"source": "deployment_default",
|
||||||
|
"deployment_max_recipient_jobs": 25,
|
||||||
|
"tenant_max_recipient_jobs": None,
|
||||||
|
"provider_diagnostic": "provider-secret-policy",
|
||||||
|
},
|
||||||
|
results=[
|
||||||
|
{
|
||||||
|
"job_id": "job-failed",
|
||||||
|
"status": "failed",
|
||||||
|
"attempt_number": 1,
|
||||||
|
"message": "provider-secret smtp.internal.example",
|
||||||
|
"recipient_email": "private@example.test",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"job_id": "job-refused",
|
||||||
|
"status": "smtp_accepted",
|
||||||
|
"attempt_number": 1,
|
||||||
|
"message": (
|
||||||
|
"SMTP accepted 1/2 envelope recipient(s); refused recipients: "
|
||||||
|
'{"refused-recipient@example.test": [550, "not allowed"]}'
|
||||||
|
),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
principal = SimpleNamespace(tenant_id="tenant-1", user=SimpleNamespace(id="user-1"), api_key=None)
|
||||||
|
audit = Mock()
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal", return_value=campaign),
|
||||||
|
patch.object(router, "_require_permission"),
|
||||||
|
patch.object(router, "_get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch.object(router, "_get_version_for_tenant", return_value=version),
|
||||||
|
patch.object(router, "_require_mail_profile_use_if_needed"),
|
||||||
|
patch.object(router, "is_user_locked_version", return_value=False),
|
||||||
|
patch.object(router, "send_campaign_now", return_value=delivery),
|
||||||
|
patch.object(router, "audit_from_principal", audit),
|
||||||
|
):
|
||||||
|
response = router.send_campaign_now_endpoint(
|
||||||
|
"campaign-1",
|
||||||
|
SendCampaignNowRequest(),
|
||||||
|
session=Mock(),
|
||||||
|
principal=principal, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
payload = response.model_dump(mode="json")["result"]
|
||||||
|
assert payload["results"] == [
|
||||||
|
{"job_id": "job-failed", "status": "failed", "attempt_number": 1},
|
||||||
|
{"job_id": "job-refused", "status": "smtp_accepted", "attempt_number": 1},
|
||||||
|
]
|
||||||
|
assert payload["validation"] == {"ok": True, "error_count": 0, "warning_count": 1}
|
||||||
|
assert payload["build"] == {
|
||||||
|
"built_count": 2,
|
||||||
|
"build_failed_count": 0,
|
||||||
|
"ready_count": 2,
|
||||||
|
"warning_count": 1,
|
||||||
|
}
|
||||||
|
assert payload["synchronous_send_policy"] == {
|
||||||
|
"max_recipient_jobs": 25,
|
||||||
|
"source": "deployment_default",
|
||||||
|
"deployment_max_recipient_jobs": 25,
|
||||||
|
"tenant_max_recipient_jobs": None,
|
||||||
|
}
|
||||||
|
|
||||||
|
audit_details = audit.call_args.kwargs["details"]
|
||||||
|
assert set(audit_details) == {
|
||||||
|
"campaign_id",
|
||||||
|
"version_id",
|
||||||
|
"attempted_count",
|
||||||
|
"sent_count",
|
||||||
|
"failed_count",
|
||||||
|
"outcome_unknown_count",
|
||||||
|
"skipped_count",
|
||||||
|
"preflight_count",
|
||||||
|
"delivery_mode",
|
||||||
|
"dry_run",
|
||||||
|
"synchronous_send_policy",
|
||||||
|
}
|
||||||
|
assert "results" not in audit_details
|
||||||
|
assert "validation" not in audit_details
|
||||||
|
assert "build" not in audit_details
|
||||||
|
|
||||||
|
serialized = repr({"response": payload, "audit": audit_details})
|
||||||
|
for forbidden in (
|
||||||
|
"provider-secret",
|
||||||
|
"smtp.internal.example",
|
||||||
|
"private@example.test",
|
||||||
|
"refused-recipient@example.test",
|
||||||
|
"not allowed",
|
||||||
|
):
|
||||||
|
assert forbidden not in serialized
|
||||||
207
tests/test_sending_jobs.py
Normal file
207
tests/test_sending_jobs.py
Normal file
@@ -0,0 +1,207 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.db.models import (
|
||||||
|
JobBuildStatus,
|
||||||
|
JobQueueStatus,
|
||||||
|
JobSendStatus,
|
||||||
|
JobValidationStatus,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.capabilities import delivery_tasks_capability
|
||||||
|
from govoplan_campaign.backend.sending.jobs import (
|
||||||
|
SendJobResult,
|
||||||
|
_queue_validation_statuses,
|
||||||
|
_select_campaign_jobs_for_queue,
|
||||||
|
_send_claimed_campaign_job,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class FakeSession:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.added: list[object] = []
|
||||||
|
|
||||||
|
def add(self, value: object) -> None:
|
||||||
|
self.added.append(value)
|
||||||
|
|
||||||
|
|
||||||
|
def _job(entry_id: str, **overrides):
|
||||||
|
values = {
|
||||||
|
"entry_id": entry_id,
|
||||||
|
"entry_index": int(entry_id),
|
||||||
|
"send_status": JobSendStatus.NOT_QUEUED.value,
|
||||||
|
"queue_status": JobQueueStatus.DRAFT.value,
|
||||||
|
"validation_status": JobValidationStatus.READY.value,
|
||||||
|
"build_status": JobBuildStatus.BUILT.value,
|
||||||
|
"eml_local_path": f"{entry_id}.eml",
|
||||||
|
"eml_storage_key": None,
|
||||||
|
"last_error": "old error",
|
||||||
|
"queued_at": None,
|
||||||
|
"claimed_at": "claimed",
|
||||||
|
"claim_token": "token",
|
||||||
|
"smtp_started_at": "started",
|
||||||
|
"outcome_unknown_at": "unknown",
|
||||||
|
}
|
||||||
|
values.update(overrides)
|
||||||
|
return SimpleNamespace(**values)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignQueueSelectionTests(unittest.TestCase):
|
||||||
|
def test_delivery_task_capability_configures_module_runtime_for_worker_processes(self):
|
||||||
|
registry = object()
|
||||||
|
settings = object()
|
||||||
|
context = SimpleNamespace(registry=registry, settings=settings)
|
||||||
|
|
||||||
|
with patch("govoplan_campaign.backend.runtime.configure_runtime") as configure:
|
||||||
|
capability = delivery_tasks_capability(context)
|
||||||
|
|
||||||
|
self.assertIsNotNone(capability)
|
||||||
|
configure.assert_called_once_with(registry=registry, settings=settings)
|
||||||
|
|
||||||
|
def test_selects_queueable_jobs_without_reclassifying_retry_states(self):
|
||||||
|
skipped_send = _job("1", send_status=JobSendStatus.FAILED_TEMPORARY.value)
|
||||||
|
skipped_queue = _job("2", queue_status=JobQueueStatus.PAUSED.value)
|
||||||
|
blocked_validation = _job(
|
||||||
|
"3",
|
||||||
|
validation_status=JobValidationStatus.WARNING.value,
|
||||||
|
)
|
||||||
|
blocked_missing_eml = _job(
|
||||||
|
"4",
|
||||||
|
eml_local_path=None,
|
||||||
|
eml_storage_key=None,
|
||||||
|
)
|
||||||
|
ready = _job("5")
|
||||||
|
reviewed = _job(
|
||||||
|
"6",
|
||||||
|
validation_status=JobValidationStatus.NEEDS_REVIEW.value,
|
||||||
|
)
|
||||||
|
session = FakeSession()
|
||||||
|
|
||||||
|
queued, skipped_count, blocked_count = _select_campaign_jobs_for_queue(
|
||||||
|
session,
|
||||||
|
jobs=[
|
||||||
|
skipped_send,
|
||||||
|
skipped_queue,
|
||||||
|
blocked_validation,
|
||||||
|
blocked_missing_eml,
|
||||||
|
ready,
|
||||||
|
reviewed,
|
||||||
|
],
|
||||||
|
allowed_validation=_queue_validation_statuses(include_warnings=False),
|
||||||
|
reviewed_needs_review_keys={"6"},
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(queued, [ready, reviewed])
|
||||||
|
self.assertEqual(skipped_count, 2)
|
||||||
|
self.assertEqual(blocked_count, 2)
|
||||||
|
self.assertIn("generated EML", blocked_missing_eml.last_error)
|
||||||
|
self.assertEqual(session.added, [ready, reviewed])
|
||||||
|
for job in queued:
|
||||||
|
self.assertEqual(job.queue_status, JobQueueStatus.QUEUED.value)
|
||||||
|
self.assertEqual(job.send_status, JobSendStatus.QUEUED.value)
|
||||||
|
self.assertIsNotNone(job.queued_at)
|
||||||
|
self.assertIsNone(job.claimed_at)
|
||||||
|
self.assertIsNone(job.claim_token)
|
||||||
|
self.assertIsNone(job.smtp_started_at)
|
||||||
|
self.assertIsNone(job.outcome_unknown_at)
|
||||||
|
self.assertIsNone(job.last_error)
|
||||||
|
|
||||||
|
def test_dry_run_does_not_mutate_queueable_job(self):
|
||||||
|
warning = _job(
|
||||||
|
"1",
|
||||||
|
validation_status=JobValidationStatus.WARNING.value,
|
||||||
|
)
|
||||||
|
session = FakeSession()
|
||||||
|
|
||||||
|
queued, skipped_count, blocked_count = _select_campaign_jobs_for_queue(
|
||||||
|
session,
|
||||||
|
jobs=[warning],
|
||||||
|
allowed_validation=_queue_validation_statuses(include_warnings=True),
|
||||||
|
reviewed_needs_review_keys=set(),
|
||||||
|
dry_run=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(queued, [warning])
|
||||||
|
self.assertEqual((skipped_count, blocked_count), (0, 0))
|
||||||
|
self.assertEqual(warning.queue_status, JobQueueStatus.DRAFT.value)
|
||||||
|
self.assertEqual(warning.send_status, JobSendStatus.NOT_QUEUED.value)
|
||||||
|
self.assertEqual(session.added, [])
|
||||||
|
|
||||||
|
def test_post_smtp_persistence_failure_is_outcome_unknown_not_retryable_failure(self):
|
||||||
|
job = SimpleNamespace(
|
||||||
|
id="job-1",
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
campaign_version_id="version-1",
|
||||||
|
imap_status="not_requested",
|
||||||
|
resolved_recipients={"from": {"email": "sender@example.test"}},
|
||||||
|
)
|
||||||
|
snapshot = SimpleNamespace(
|
||||||
|
mail_profile_id="profile-1",
|
||||||
|
smtp_transport_revision="frozen",
|
||||||
|
delivery=SimpleNamespace(
|
||||||
|
rate_limit=SimpleNamespace(messages_per_minute=60),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
context = SimpleNamespace(
|
||||||
|
snapshot=snapshot,
|
||||||
|
message_bytes=b"message",
|
||||||
|
envelope_from="sender@example.test",
|
||||||
|
envelope_recipients=["recipient@example.test"],
|
||||||
|
)
|
||||||
|
current = SimpleNamespace(id="job-1")
|
||||||
|
|
||||||
|
class Session:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.rolled_back = False
|
||||||
|
|
||||||
|
def rollback(self) -> None:
|
||||||
|
self.rolled_back = True
|
||||||
|
|
||||||
|
def get(self, _model, _id):
|
||||||
|
return current
|
||||||
|
|
||||||
|
class Mail:
|
||||||
|
def wait_for_rate_limit(self, **_kwargs):
|
||||||
|
return None
|
||||||
|
|
||||||
|
def send_campaign_email_bytes(self, *_args, **_kwargs):
|
||||||
|
return SimpleNamespace(accepted_count=1)
|
||||||
|
|
||||||
|
session = Session()
|
||||||
|
expected = SendJobResult(
|
||||||
|
job_id="job-1",
|
||||||
|
status=JobSendStatus.OUTCOME_UNKNOWN.value,
|
||||||
|
attempt_number=1,
|
||||||
|
)
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.mail_integration", return_value=Mail()),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._record_attempt_start", return_value=object()),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._record_smtp_send_success",
|
||||||
|
side_effect=OSError("storage unavailable"),
|
||||||
|
),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs.mark_job_outcome_unknown",
|
||||||
|
return_value=expected,
|
||||||
|
) as mark_unknown,
|
||||||
|
):
|
||||||
|
result = _send_claimed_campaign_job(
|
||||||
|
session, # type: ignore[arg-type]
|
||||||
|
job=job, # type: ignore[arg-type]
|
||||||
|
claim_token="claim-1",
|
||||||
|
context=context, # type: ignore[arg-type]
|
||||||
|
use_rate_limit=False,
|
||||||
|
enqueue_imap_task=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertIs(result, expected)
|
||||||
|
self.assertTrue(session.rolled_back)
|
||||||
|
self.assertIn("Automatic retry is stopped", mark_unknown.call_args.kwargs["reason"])
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
279
tests/test_server_path_security.py
Normal file
279
tests/test_server_path_security.py
Normal file
@@ -0,0 +1,279 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import copy
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.attachments.resolver import (
|
||||||
|
MessageAttachmentStatus,
|
||||||
|
resolve_entry_attachments,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
||||||
|
from govoplan_campaign.backend.path_security import (
|
||||||
|
CampaignPathSecurityError,
|
||||||
|
assert_server_safe_campaign_paths,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.persistence.campaigns import (
|
||||||
|
create_campaign_version_from_json,
|
||||||
|
load_version_config,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.sending.execution import ExecutionSnapshotError, ensure_execution_snapshot
|
||||||
|
|
||||||
|
|
||||||
|
def _campaign_json() -> dict[str, object]:
|
||||||
|
return {
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "path-security", "name": "Path security", "mode": "test"},
|
||||||
|
"template": {"subject": "Subject", "text": "Body"},
|
||||||
|
"attachments": {"base_path": ".", "base_paths": [], "global": []},
|
||||||
|
"entries": {"inline": []},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class ServerCampaignPathSecurityTests(unittest.TestCase):
|
||||||
|
def test_api_import_rejects_absolute_source_filename_before_persistence(self) -> None:
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.persistence.campaigns.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=False),
|
||||||
|
):
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "source_filename"):
|
||||||
|
create_campaign_version_from_json(
|
||||||
|
None, # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
user_id="user-1",
|
||||||
|
raw_json=_campaign_json(),
|
||||||
|
source_filename="/etc/passwd",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_template_parent_traversal_is_rejected(self) -> None:
|
||||||
|
raw = _campaign_json()
|
||||||
|
raw["template"] = {"source": {"text_path": "../../etc/passwd"}}
|
||||||
|
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "template source paths"):
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
def test_existing_unsafe_version_cannot_reuse_a_delivery_snapshot(self) -> None:
|
||||||
|
raw = _campaign_json()
|
||||||
|
raw["template"] = {"source": {"text_path": "/etc/passwd"}}
|
||||||
|
version = SimpleNamespace(raw_json=raw, execution_snapshot={})
|
||||||
|
|
||||||
|
with patch(
|
||||||
|
"govoplan_campaign.backend.sending.execution.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=True),
|
||||||
|
):
|
||||||
|
with self.assertRaisesRegex(ExecutionSnapshotError, "template source paths"):
|
||||||
|
ensure_execution_snapshot(None, version) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
def test_existing_unsafe_version_is_rejected_before_config_loading(self) -> None:
|
||||||
|
raw = _campaign_json()
|
||||||
|
raw["template"] = {"source": {"text_path": "/etc/passwd"}}
|
||||||
|
version = SimpleNamespace(campaign_id="campaign-1", raw_json=raw)
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", tenant_id="tenant-1")
|
||||||
|
session = SimpleNamespace(get=lambda _model, key: version if key == "version-1" else campaign)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.persistence.campaigns.files_integration",
|
||||||
|
return_value=SimpleNamespace(available=True),
|
||||||
|
),
|
||||||
|
patch("govoplan_campaign.backend.persistence.campaigns._write_campaign_snapshot") as write_snapshot,
|
||||||
|
patch("govoplan_campaign.backend.persistence.campaigns.load_campaign_config_from_json") as load_config,
|
||||||
|
):
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "template source paths"):
|
||||||
|
load_version_config(session, "version-1") # type: ignore[arg-type]
|
||||||
|
|
||||||
|
write_snapshot.assert_not_called()
|
||||||
|
load_config.assert_not_called()
|
||||||
|
|
||||||
|
def test_source_base_symlink_escape_is_rejected(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
outside = root / "outside"
|
||||||
|
outside.mkdir()
|
||||||
|
(outside / "secret.txt").write_text("secret", encoding="utf-8")
|
||||||
|
trusted = root / "trusted"
|
||||||
|
trusted.mkdir()
|
||||||
|
(trusted / "escape").symlink_to(outside, target_is_directory=True)
|
||||||
|
|
||||||
|
raw = _campaign_json()
|
||||||
|
raw["template"] = {"source": {"text_path": "escape/secret.txt"}}
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "source_base_path"):
|
||||||
|
assert_server_safe_campaign_paths(
|
||||||
|
raw,
|
||||||
|
source_base_path=str(trusted),
|
||||||
|
managed_files_available=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_attachment_absolute_path_and_parent_filter_are_rejected(self) -> None:
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
attachments = raw["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
base_paths = attachments["base_paths"]
|
||||||
|
assert isinstance(base_paths, list)
|
||||||
|
assert isinstance(base_paths[0], dict)
|
||||||
|
base_paths[0]["path"] = "/etc"
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "relative managed-file path"):
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
attachments = raw["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
rules = attachments["global"]
|
||||||
|
assert isinstance(rules, list)
|
||||||
|
assert isinstance(rules[0], dict)
|
||||||
|
rules[0]["file_filter"] = "../../etc/passwd"
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "parent-directory traversal"):
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
def test_local_attachment_rule_is_rejected_in_server_mode(self) -> None:
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
attachments = raw["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
base_paths = attachments["base_paths"]
|
||||||
|
assert isinstance(base_paths, list)
|
||||||
|
assert isinstance(base_paths[0], dict)
|
||||||
|
base_paths[0].pop("source")
|
||||||
|
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "backed by managed Files"):
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
def test_default_attachment_rule_must_use_managed_files(self) -> None:
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
attachments = raw["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
attachments["global"] = []
|
||||||
|
entries = raw["entries"]
|
||||||
|
assert isinstance(entries, dict)
|
||||||
|
entries["defaults"] = {
|
||||||
|
"attachments": [{"base_dir": "invoices", "file_filter": "invoice.pdf"}]
|
||||||
|
}
|
||||||
|
|
||||||
|
with self.assertRaisesRegex(CampaignPathSecurityError, "entries.defaults.attachments"):
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
def test_normal_managed_file_campaign_is_allowed(self) -> None:
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
assert_server_safe_campaign_paths(raw, managed_files_available=True)
|
||||||
|
|
||||||
|
copied = copy.deepcopy(raw)
|
||||||
|
attachments = copied["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
rules = attachments["global"]
|
||||||
|
assert isinstance(rules, list)
|
||||||
|
assert isinstance(rules[0], dict)
|
||||||
|
rules[0]["file_filter"] = "**/{{local:invoice_number}}-report.XLSX"
|
||||||
|
assert_server_safe_campaign_paths(copied, managed_files_available=True)
|
||||||
|
|
||||||
|
def test_rendered_managed_filter_cannot_traverse_materialized_source(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
managed_root = root / "managed"
|
||||||
|
managed_root.mkdir()
|
||||||
|
(root / "secret.pdf").write_bytes(b"server secret")
|
||||||
|
|
||||||
|
config = _runtime_managed_attachment_config(
|
||||||
|
managed_root,
|
||||||
|
file_filter="{{local:file_name}}",
|
||||||
|
file_name="../secret.pdf",
|
||||||
|
)
|
||||||
|
resolution = resolve_entry_attachments(
|
||||||
|
config=config,
|
||||||
|
campaign_file=root / "campaign.json",
|
||||||
|
entry=config.entries.inline[0], # type: ignore[index]
|
||||||
|
entry_index=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(resolution.status, MessageAttachmentStatus.BLOCKED)
|
||||||
|
self.assertEqual(resolution.attachments[0].matches, [])
|
||||||
|
self.assertIn(
|
||||||
|
"unsafe_managed_attachment_path",
|
||||||
|
{issue.code for issue in resolution.issues},
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_managed_match_symlink_cannot_escape_materialized_source(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
managed_root = root / "managed"
|
||||||
|
managed_root.mkdir()
|
||||||
|
outside = root / "secret.pdf"
|
||||||
|
outside.write_bytes(b"server secret")
|
||||||
|
(managed_root / "escape.pdf").symlink_to(outside)
|
||||||
|
|
||||||
|
config = _runtime_managed_attachment_config(
|
||||||
|
managed_root,
|
||||||
|
file_filter="escape.pdf",
|
||||||
|
file_name="unused.pdf",
|
||||||
|
)
|
||||||
|
resolution = resolve_entry_attachments(
|
||||||
|
config=config,
|
||||||
|
campaign_file=root / "campaign.json",
|
||||||
|
entry=config.entries.inline[0], # type: ignore[index]
|
||||||
|
entry_index=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(resolution.status, MessageAttachmentStatus.BLOCKED)
|
||||||
|
self.assertEqual(resolution.attachments[0].matches, [])
|
||||||
|
self.assertIn(
|
||||||
|
"managed_attachment_path_escape",
|
||||||
|
{issue.code for issue in resolution.issues},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _managed_attachment_campaign() -> dict[str, object]:
|
||||||
|
raw = _campaign_json()
|
||||||
|
raw["attachments"] = {
|
||||||
|
"base_path": "invoices",
|
||||||
|
"base_paths": [
|
||||||
|
{
|
||||||
|
"id": "personal-invoices",
|
||||||
|
"name": "My invoices",
|
||||||
|
"source": "managed:user:user-1",
|
||||||
|
"path": "invoices",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"global": [
|
||||||
|
{
|
||||||
|
"base_path_id": "personal-invoices",
|
||||||
|
"base_dir": "invoices",
|
||||||
|
"file_filter": "invoice.pdf",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
}
|
||||||
|
return raw
|
||||||
|
|
||||||
|
|
||||||
|
def _runtime_managed_attachment_config(
|
||||||
|
managed_root: Path,
|
||||||
|
*,
|
||||||
|
file_filter: str,
|
||||||
|
file_name: str,
|
||||||
|
) -> CampaignConfig:
|
||||||
|
raw = _managed_attachment_campaign()
|
||||||
|
raw["fields"] = [{"name": "file_name", "type": "string", "required": True}]
|
||||||
|
attachments = raw["attachments"]
|
||||||
|
assert isinstance(attachments, dict)
|
||||||
|
base_paths = attachments["base_paths"]
|
||||||
|
assert isinstance(base_paths, list)
|
||||||
|
assert isinstance(base_paths[0], dict)
|
||||||
|
base_paths[0]["path"] = str(managed_root)
|
||||||
|
rules = attachments["global"]
|
||||||
|
assert isinstance(rules, list)
|
||||||
|
assert isinstance(rules[0], dict)
|
||||||
|
rules[0]["file_filter"] = file_filter
|
||||||
|
entries = raw["entries"]
|
||||||
|
assert isinstance(entries, dict)
|
||||||
|
entries["inline"] = [
|
||||||
|
{
|
||||||
|
"id": "recipient-1",
|
||||||
|
"to": [{"email": "recipient@example.test", "type": "to"}],
|
||||||
|
"fields": {"file_name": file_name},
|
||||||
|
}
|
||||||
|
]
|
||||||
|
return CampaignConfig.model_validate(raw)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
405
tests/test_synchronous_delivery_policy.py
Normal file
405
tests/test_synchronous_delivery_policy.py
Normal file
@@ -0,0 +1,405 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from unittest.mock import Mock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from fastapi import HTTPException
|
||||||
|
|
||||||
|
from govoplan_campaign.backend import router
|
||||||
|
from govoplan_campaign.backend.delivery_policy import (
|
||||||
|
CampaignDeliveryPolicyError,
|
||||||
|
DEFAULT_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS,
|
||||||
|
effective_synchronous_send_policy,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.db.models import (
|
||||||
|
JobBuildStatus,
|
||||||
|
JobQueueStatus,
|
||||||
|
JobSendStatus,
|
||||||
|
JobValidationStatus,
|
||||||
|
)
|
||||||
|
from govoplan_campaign.backend.sending.jobs import (
|
||||||
|
QueueCampaignResult,
|
||||||
|
SynchronousSendRejected,
|
||||||
|
_ensure_synchronous_send_count_allowed,
|
||||||
|
_preflight_synchronous_send_batch,
|
||||||
|
queue_campaign_jobs,
|
||||||
|
send_campaign_now,
|
||||||
|
synchronous_send_candidate_jobs,
|
||||||
|
synchronous_send_options,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _PolicySession:
|
||||||
|
def __init__(self, settings: dict[str, object] | None = None) -> None:
|
||||||
|
self.tenant = SimpleNamespace(settings=settings or {})
|
||||||
|
|
||||||
|
def get(self, _model, _id):
|
||||||
|
return self.tenant
|
||||||
|
|
||||||
|
|
||||||
|
def _version() -> SimpleNamespace:
|
||||||
|
return SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
locked_at=object(),
|
||||||
|
published_at=None,
|
||||||
|
validation_summary={"ok": True},
|
||||||
|
build_summary={"build_token": "build-1"},
|
||||||
|
editor_state={
|
||||||
|
"review_send": {
|
||||||
|
"build_token": "build-1",
|
||||||
|
"inspection_complete": True,
|
||||||
|
"reviewed_message_keys": ["reviewed"],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _Principal:
|
||||||
|
def __init__(self, *scopes: str) -> None:
|
||||||
|
self.scopes = set(scopes)
|
||||||
|
self.tenant_id = "tenant-1"
|
||||||
|
self.user = SimpleNamespace(id="user-1")
|
||||||
|
|
||||||
|
def has(self, scope: str) -> bool:
|
||||||
|
return scope in self.scopes
|
||||||
|
|
||||||
|
|
||||||
|
def _job(job_id: str, **overrides: object) -> SimpleNamespace:
|
||||||
|
values: dict[str, object] = {
|
||||||
|
"id": job_id,
|
||||||
|
"entry_id": job_id,
|
||||||
|
"entry_index": 1,
|
||||||
|
"build_status": JobBuildStatus.BUILT.value,
|
||||||
|
"validation_status": JobValidationStatus.READY.value,
|
||||||
|
"queue_status": JobQueueStatus.DRAFT.value,
|
||||||
|
"send_status": JobSendStatus.NOT_QUEUED.value,
|
||||||
|
"eml_local_path": f"{job_id}.eml",
|
||||||
|
"eml_storage_key": None,
|
||||||
|
}
|
||||||
|
values.update(overrides)
|
||||||
|
return SimpleNamespace(**values)
|
||||||
|
|
||||||
|
|
||||||
|
def test_synchronous_policy_defaults_to_25_and_tenant_can_only_narrow() -> None:
|
||||||
|
default = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={},
|
||||||
|
)
|
||||||
|
assert default.max_recipient_jobs == DEFAULT_SYNCHRONOUS_SEND_MAX_RECIPIENT_JOBS == 25
|
||||||
|
assert default.source == "deployment_default"
|
||||||
|
|
||||||
|
narrowed = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(
|
||||||
|
{"campaign_delivery_policy": {"synchronous_send_max_recipients": 10}}
|
||||||
|
), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "40"},
|
||||||
|
)
|
||||||
|
assert narrowed.max_recipient_jobs == 10
|
||||||
|
assert narrowed.source == "tenant"
|
||||||
|
|
||||||
|
ceiling = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(
|
||||||
|
{"campaign_delivery_policy": {"synchronous_send_max_recipients": 100}}
|
||||||
|
), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "40"},
|
||||||
|
)
|
||||||
|
assert ceiling.max_recipient_jobs == 40
|
||||||
|
assert ceiling.source == "deployment_ceiling"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("value", [True, -1, 501, "2.5", "unbounded"])
|
||||||
|
def test_invalid_synchronous_policy_fails_closed(value: object) -> None:
|
||||||
|
with pytest.raises(CampaignDeliveryPolicyError):
|
||||||
|
effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": value}, # type: ignore[dict-item]
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_candidate_count_uses_exact_built_and_reviewed_job_states() -> None:
|
||||||
|
jobs = [
|
||||||
|
_job("ready"),
|
||||||
|
_job("queued", queue_status=JobQueueStatus.QUEUED.value, send_status=JobSendStatus.QUEUED.value),
|
||||||
|
_job("reviewed", validation_status=JobValidationStatus.NEEDS_REVIEW.value),
|
||||||
|
_job("blocked", validation_status=JobValidationStatus.BLOCKED.value),
|
||||||
|
_job("failed", send_status=JobSendStatus.FAILED_TEMPORARY.value),
|
||||||
|
_job("missing-eml", eml_local_path=None),
|
||||||
|
]
|
||||||
|
|
||||||
|
candidates = synchronous_send_candidate_jobs(_version(), jobs) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
assert [job.id for job in candidates] == ["ready", "queued", "reviewed"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_limit_and_zero_count_reject_before_delivery() -> None:
|
||||||
|
policy = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "2"},
|
||||||
|
)
|
||||||
|
with pytest.raises(SynchronousSendRejected, match="No eligible") as empty:
|
||||||
|
_ensure_synchronous_send_count_allowed(0, policy=policy)
|
||||||
|
assert empty.value.reason == "no_eligible_recipient_jobs"
|
||||||
|
|
||||||
|
with pytest.raises(SynchronousSendRejected, match="Queue it") as oversized:
|
||||||
|
_ensure_synchronous_send_count_allowed(3, policy=policy)
|
||||||
|
assert oversized.value.audit_details()["eligible_recipient_job_count"] == 3
|
||||||
|
assert oversized.value.audit_details()["synchronous_send_policy"]["max_recipient_jobs"] == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_exact_synchronous_policy_boundary_is_allowed() -> None:
|
||||||
|
policy = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "2"},
|
||||||
|
)
|
||||||
|
|
||||||
|
_ensure_synchronous_send_count_allowed(2, policy=policy)
|
||||||
|
|
||||||
|
|
||||||
|
def test_post_queue_growth_is_rejected_before_batch_or_provider_preflight() -> None:
|
||||||
|
policy = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={"GOVOPLAN_CAMPAIGN_SYNCHRONOUS_SEND_MAX_RECIPIENTS": "2"},
|
||||||
|
)
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", current_version_id="version-1")
|
||||||
|
initial_jobs = [_job("one"), _job("two")]
|
||||||
|
post_queue_jobs = [
|
||||||
|
_job(
|
||||||
|
job_id,
|
||||||
|
queue_status=JobQueueStatus.QUEUED.value,
|
||||||
|
send_status=JobSendStatus.QUEUED.value,
|
||||||
|
)
|
||||||
|
for job_id in ("one", "two", "concurrent")
|
||||||
|
]
|
||||||
|
queued = QueueCampaignResult(
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
version_id="version-1",
|
||||||
|
queued_count=2,
|
||||||
|
skipped_count=0,
|
||||||
|
blocked_count=0,
|
||||||
|
enqueued_count=0,
|
||||||
|
delivery_mode="synchronous",
|
||||||
|
)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_current_version", return_value=_version()),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._ensure_version_validated_and_locked"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._ensure_campaign_execution_snapshot"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.effective_synchronous_send_policy", return_value=policy),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._campaign_jobs_for_queue", return_value=initial_jobs),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs.queue_campaign_jobs",
|
||||||
|
return_value=queued,
|
||||||
|
) as queue,
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._campaign_jobs_for_version", return_value=post_queue_jobs),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._preflight_synchronous_send_batch") as batch_preflight,
|
||||||
|
):
|
||||||
|
with pytest.raises(SynchronousSendRejected, match="above the effective") as rejected:
|
||||||
|
send_campaign_now(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert rejected.value.eligible_count == 3
|
||||||
|
assert queue.call_args.kwargs["commit_queue"] is False
|
||||||
|
batch_preflight.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("workers_available", "expected_mode", "expected_enqueued"),
|
||||||
|
((False, "database_queue", 0), (True, "worker_queue", 1)),
|
||||||
|
)
|
||||||
|
def test_asynchronous_mode_matches_actual_worker_availability(
|
||||||
|
workers_available: bool,
|
||||||
|
expected_mode: str,
|
||||||
|
expected_enqueued: int,
|
||||||
|
) -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
version = _version()
|
||||||
|
job = _job("one")
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._celery_enabled", return_value=workers_available),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_current_version", return_value=version),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._ensure_version_validated_and_locked"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._ensure_campaign_execution_snapshot"),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._campaign_jobs_for_queue", return_value=[job]),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._select_campaign_jobs_for_queue",
|
||||||
|
return_value=([job], 0, 0),
|
||||||
|
),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._persist_campaign_queue") as persist,
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._enqueue_campaign_jobs",
|
||||||
|
return_value=expected_enqueued,
|
||||||
|
) as enqueue,
|
||||||
|
):
|
||||||
|
result = queue_campaign_jobs(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
enqueue_celery=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.delivery_mode == expected_mode
|
||||||
|
assert result.worker_queue_available is workers_available
|
||||||
|
assert result.enqueued_count == expected_enqueued
|
||||||
|
assert persist.call_args.kwargs["delivery_mode"] == expected_mode
|
||||||
|
assert persist.call_args.kwargs["commit"] is True
|
||||||
|
assert enqueue.call_args.kwargs["enabled"] is workers_available
|
||||||
|
|
||||||
|
|
||||||
|
def test_invalid_policy_disables_synchronous_mode_without_hiding_queue_availability() -> None:
|
||||||
|
campaign = SimpleNamespace(id="campaign-1")
|
||||||
|
version = _version()
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._get_version_for_campaign", return_value=version),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._campaign_jobs_for_version", return_value=[_job("one")]),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._celery_enabled", return_value=True),
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs.effective_synchronous_send_policy",
|
||||||
|
side_effect=CampaignDeliveryPolicyError("invalid deployment value"),
|
||||||
|
),
|
||||||
|
):
|
||||||
|
options = synchronous_send_options(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
campaign_id="campaign-1",
|
||||||
|
)
|
||||||
|
|
||||||
|
assert options["worker_queue_available"] is True
|
||||||
|
assert options["synchronous_send"]["allowed"] is False
|
||||||
|
assert options["synchronous_send"]["reason"] == "policy_configuration_invalid"
|
||||||
|
assert options["synchronous_send"]["policy"] == {}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("path", "required_scope"),
|
||||||
|
(
|
||||||
|
("/campaigns/{campaign_id}/send-now", "campaigns:campaign:send"),
|
||||||
|
("/campaigns/{campaign_id}/queue", "campaigns:campaign:queue"),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
def test_delivery_endpoints_require_their_mode_permission_and_recipient_authority(
|
||||||
|
path: str,
|
||||||
|
required_scope: str,
|
||||||
|
) -> None:
|
||||||
|
route = next(item for item in router.router.routes if item.path == path)
|
||||||
|
dependency = next(item for item in route.dependant.dependencies if item.name == "principal")
|
||||||
|
|
||||||
|
with pytest.raises(HTTPException) as missing_mode_permission:
|
||||||
|
dependency.call(_Principal("campaigns:recipient:read"))
|
||||||
|
assert missing_mode_permission.value.status_code == 403
|
||||||
|
allowed = _Principal(required_scope, "campaigns:recipient:read")
|
||||||
|
assert dependency.call(allowed) is allowed
|
||||||
|
|
||||||
|
mode_only = _Principal(required_scope)
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal"),
|
||||||
|
pytest.raises(HTTPException) as missing_recipient_authority,
|
||||||
|
):
|
||||||
|
if required_scope == "campaigns:campaign:send":
|
||||||
|
router.send_campaign_now_endpoint(
|
||||||
|
"campaign-1",
|
||||||
|
session=Mock(),
|
||||||
|
principal=mode_only, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
router.queue_campaign(
|
||||||
|
"campaign-1",
|
||||||
|
session=Mock(),
|
||||||
|
principal=mode_only, # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
assert missing_recipient_authority.value.status_code == 403
|
||||||
|
assert "campaigns:recipient:read" in missing_recipient_authority.value.detail
|
||||||
|
|
||||||
|
|
||||||
|
def test_batch_preflight_checks_every_message_before_provider_effects() -> None:
|
||||||
|
jobs = [_job("one"), _job("two")]
|
||||||
|
contexts = {
|
||||||
|
"one": SimpleNamespace(snapshot=SimpleNamespace(smtp_transport_revision="revision-1")),
|
||||||
|
"two": SimpleNamespace(snapshot=SimpleNamespace(smtp_transport_revision="revision-1")),
|
||||||
|
}
|
||||||
|
policy = effective_synchronous_send_policy(
|
||||||
|
_PolicySession(), # type: ignore[arg-type]
|
||||||
|
tenant_id="tenant-1",
|
||||||
|
environ={},
|
||||||
|
)
|
||||||
|
provider = Mock()
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs._preflight_send_campaign_job", return_value=None) as state_preflight,
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs._send_job_delivery_context",
|
||||||
|
side_effect=lambda _session, job: contexts[job.id],
|
||||||
|
) as input_preflight,
|
||||||
|
patch(
|
||||||
|
"govoplan_campaign.backend.sending.jobs.profile_delivery_summary",
|
||||||
|
return_value={"smtp_transport_revision": "revision-1"},
|
||||||
|
),
|
||||||
|
patch("govoplan_campaign.backend.sending.jobs.mail_integration", return_value=provider),
|
||||||
|
):
|
||||||
|
result = _preflight_synchronous_send_batch(
|
||||||
|
object(), # type: ignore[arg-type]
|
||||||
|
version=_version(), # type: ignore[arg-type]
|
||||||
|
jobs=jobs, # type: ignore[arg-type]
|
||||||
|
policy=policy,
|
||||||
|
)
|
||||||
|
|
||||||
|
assert list(result) == ["one", "two"]
|
||||||
|
assert state_preflight.call_count == 2
|
||||||
|
assert input_preflight.call_count == 2
|
||||||
|
provider.send_campaign_email_bytes.assert_not_called()
|
||||||
|
|
||||||
|
|
||||||
|
def test_rejected_synchronous_preflight_rolls_back_staged_queue_before_audit() -> None:
|
||||||
|
session = Mock()
|
||||||
|
campaign = SimpleNamespace(id="campaign-1", current_version_id="version-1")
|
||||||
|
version = SimpleNamespace(
|
||||||
|
id="version-1",
|
||||||
|
raw_json={},
|
||||||
|
locked_at=object(),
|
||||||
|
validation_summary={"ok": True},
|
||||||
|
build_summary={"built_count": 1},
|
||||||
|
)
|
||||||
|
rejection = SynchronousSendRejected(
|
||||||
|
"Preflight rejected the staged send.",
|
||||||
|
reason="batch_preflight_failed",
|
||||||
|
eligible_count=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
with (
|
||||||
|
patch.object(router, "_get_campaign_for_principal"),
|
||||||
|
patch.object(router, "_require_permission"),
|
||||||
|
patch.object(router, "_get_campaign_for_tenant", return_value=campaign),
|
||||||
|
patch.object(router, "_get_version_for_tenant", return_value=version),
|
||||||
|
patch.object(router, "_require_mail_profile_use_if_needed"),
|
||||||
|
patch.object(router, "is_user_locked_version", return_value=False),
|
||||||
|
patch.object(router, "send_campaign_now", side_effect=rejection),
|
||||||
|
patch.object(router, "audit_from_principal") as audit,
|
||||||
|
pytest.raises(HTTPException) as rejected,
|
||||||
|
):
|
||||||
|
router.send_campaign_now_endpoint(
|
||||||
|
"campaign-1",
|
||||||
|
session=session,
|
||||||
|
principal=_Principal(
|
||||||
|
"campaigns:campaign:send", "campaigns:recipient:read"
|
||||||
|
), # type: ignore[arg-type]
|
||||||
|
)
|
||||||
|
|
||||||
|
assert rejected.value.status_code == 422
|
||||||
|
session.rollback.assert_called_once_with()
|
||||||
|
audit.assert_called_once()
|
||||||
|
assert audit.call_args.kwargs["action"] == "campaign.send_now_rejected"
|
||||||
|
assert audit.call_args.kwargs["commit"] is True
|
||||||
101
tests/test_template_rendering.py
Normal file
101
tests/test_template_rendering.py
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.campaign.models import CampaignConfig
|
||||||
|
from govoplan_campaign.backend.attachments.resolver import resolve_entry_attachments
|
||||||
|
from govoplan_campaign.backend.template_rendering import (
|
||||||
|
find_unresolved_placeholders,
|
||||||
|
normalize_template_key,
|
||||||
|
render_template,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class CampaignTemplateRenderingTests(unittest.TestCase):
|
||||||
|
def test_template_key_aliases_have_shared_normalization(self) -> None:
|
||||||
|
cases = {
|
||||||
|
" name ": "name",
|
||||||
|
"fields.name": "name",
|
||||||
|
"local.name": "local::name",
|
||||||
|
"local:name": "local::name",
|
||||||
|
"local::name": "local::name",
|
||||||
|
"global.name": "global::name",
|
||||||
|
"global:name": "global::name",
|
||||||
|
"global::name": "global::name",
|
||||||
|
}
|
||||||
|
|
||||||
|
for raw, expected in cases.items():
|
||||||
|
with self.subTest(raw=raw):
|
||||||
|
self.assertEqual(normalize_template_key(raw), expected)
|
||||||
|
|
||||||
|
def test_rendering_preserves_both_syntaxes_none_and_missing_values(self) -> None:
|
||||||
|
values = {
|
||||||
|
"name": "Ada",
|
||||||
|
"local::reference": 42,
|
||||||
|
"global::empty": None,
|
||||||
|
}
|
||||||
|
template = "${fields.name}|{{ local.reference }}|${global:empty}|${missing}|{{ global.absent }}"
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
render_template(template, values),
|
||||||
|
"Ada|42||${missing}|{{ global.absent }}",
|
||||||
|
)
|
||||||
|
self.assertEqual(render_template(template, values, keep_missing=False), "Ada|42|||")
|
||||||
|
|
||||||
|
def test_rendering_unescapes_literal_dollar_placeholders(self) -> None:
|
||||||
|
self.assertEqual(
|
||||||
|
render_template(r"\${literal\}|${known}", {"known": "resolved"}, keep_missing=False),
|
||||||
|
"${literal}|resolved",
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_unresolved_placeholders_are_normalized_and_deduplicated(self) -> None:
|
||||||
|
unresolved = find_unresolved_placeholders(
|
||||||
|
r"${fields.missing} {{ local:name }} ${global.other} {{local::name}} \${escaped\}"
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(unresolved, {"missing", "local::name", "global::other"})
|
||||||
|
self.assertEqual(find_unresolved_placeholders(None), set())
|
||||||
|
|
||||||
|
def test_attachment_resolution_keeps_missing_placeholders(self) -> None:
|
||||||
|
config = CampaignConfig.model_validate(
|
||||||
|
{
|
||||||
|
"version": "1.0",
|
||||||
|
"campaign": {"id": "template-parity", "name": "Template parity", "mode": "test"},
|
||||||
|
"template": {"subject": "Subject", "text": "Body"},
|
||||||
|
"attachments": {
|
||||||
|
"base_path": ".",
|
||||||
|
"global": [
|
||||||
|
{
|
||||||
|
"base_dir": ".",
|
||||||
|
"file_filter": "${missing}.pdf",
|
||||||
|
"required": False,
|
||||||
|
"missing_behavior": "continue",
|
||||||
|
}
|
||||||
|
],
|
||||||
|
},
|
||||||
|
"entries": {
|
||||||
|
"inline": [
|
||||||
|
{
|
||||||
|
"id": "recipient-1",
|
||||||
|
"to": [{"email": "recipient@example.test", "type": "to"}],
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
resolution = resolve_entry_attachments(
|
||||||
|
config=config,
|
||||||
|
campaign_file=Path(temp_dir) / "campaign.json",
|
||||||
|
entry=config.entries.inline[0], # type: ignore[index]
|
||||||
|
entry_index=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.assertEqual(resolution.attachments[0].file_filter, "${missing}.pdf")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
68
tests/test_zip_service.py
Normal file
68
tests/test_zip_service.py
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
import zipfile
|
||||||
|
|
||||||
|
try:
|
||||||
|
import pyzipper
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
pyzipper = None
|
||||||
|
|
||||||
|
from govoplan_campaign.backend.services.zip_service import create_zip_archive
|
||||||
|
|
||||||
|
|
||||||
|
class ZipServiceTests(unittest.TestCase):
|
||||||
|
def test_standard_password_zip_uses_zipcrypto_readable_by_stdlib(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
source = root / "source.txt"
|
||||||
|
source.write_text("Hello Windows ZIP", encoding="utf-8")
|
||||||
|
output = root / "standard.zip"
|
||||||
|
|
||||||
|
create_zip_archive(output, [(source, "message.txt")], "secret", "zip_standard")
|
||||||
|
|
||||||
|
with zipfile.ZipFile(output) as archive:
|
||||||
|
info = archive.getinfo("message.txt")
|
||||||
|
self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
|
||||||
|
self.assertTrue(info.flag_bits & 0x1)
|
||||||
|
self.assertEqual(archive.read("message.txt", pwd=b"secret"), b"Hello Windows ZIP")
|
||||||
|
|
||||||
|
@unittest.skipIf(pyzipper is None, "pyzipper is not installed")
|
||||||
|
def test_aes_password_zip_keeps_aes_encryption(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
source = root / "source.txt"
|
||||||
|
source.write_text("Hello AES ZIP", encoding="utf-8")
|
||||||
|
output = root / "aes.zip"
|
||||||
|
|
||||||
|
create_zip_archive(output, [(source, "message.txt")], "secret", "aes")
|
||||||
|
|
||||||
|
with zipfile.ZipFile(output) as archive:
|
||||||
|
info = archive.getinfo("message.txt")
|
||||||
|
self.assertEqual(info.compress_type, 99)
|
||||||
|
self.assertTrue(info.flag_bits & 0x1)
|
||||||
|
|
||||||
|
with pyzipper.AESZipFile(output) as archive:
|
||||||
|
archive.setpassword(b"secret")
|
||||||
|
self.assertEqual(archive.read("message.txt"), b"Hello AES ZIP")
|
||||||
|
|
||||||
|
def test_unprotected_zip_ignores_encryption_mode(self) -> None:
|
||||||
|
with tempfile.TemporaryDirectory() as temp_dir:
|
||||||
|
root = Path(temp_dir)
|
||||||
|
source = root / "source.txt"
|
||||||
|
source.write_text("Plain ZIP", encoding="utf-8")
|
||||||
|
output = root / "plain.zip"
|
||||||
|
|
||||||
|
create_zip_archive(output, [(source, "message.txt")], "", "zip_standard")
|
||||||
|
|
||||||
|
with zipfile.ZipFile(output) as archive:
|
||||||
|
info = archive.getinfo("message.txt")
|
||||||
|
self.assertEqual(info.compress_type, zipfile.ZIP_DEFLATED)
|
||||||
|
self.assertFalse(info.flag_bits & 0x1)
|
||||||
|
self.assertEqual(archive.read("message.txt"), b"Plain ZIP")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@govoplan/campaign-webui",
|
"name": "@govoplan/campaign-webui",
|
||||||
"version": "0.1.1",
|
"version": "0.1.11",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"main": "src/index.ts",
|
"main": "src/index.ts",
|
||||||
@@ -13,16 +13,24 @@
|
|||||||
},
|
},
|
||||||
"./styles/campaign-workspace.css": "./src/styles/campaign-workspace.css"
|
"./styles/campaign-workspace.css": "./src/styles/campaign-workspace.css"
|
||||||
},
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"read-excel-file": "9.2.0"
|
||||||
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@govoplan/core-webui": "^0.1.1",
|
"@govoplan/core-webui": "^0.1.12",
|
||||||
"lucide-react": "^0.555.0",
|
"lucide-react": "^1.23.0",
|
||||||
"react": "^19.0.0",
|
"react": "^19.0.0",
|
||||||
"react-dom": "^19.0.0",
|
"react-dom": "^19.0.0",
|
||||||
"react-router-dom": "^7.1.1"
|
"react-router-dom": "^7.1.1"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test:policy-ui": "rm -rf .policy-test-build && mkdir -p .policy-test-build && printf '{\"type\":\"commonjs\"}\\n' > .policy-test-build/package.json && tsc -p tsconfig.policy-tests.json && node .policy-test-build/tests/policy-ui.test.js",
|
"test:policy-ui": "rm -rf .policy-test-build && mkdir -p .policy-test-build && printf '{\"type\":\"commonjs\"}\\n' > .policy-test-build/package.json && tsc -p tsconfig.policy-tests.json && node .policy-test-build/tests/policy-ui.test.js",
|
||||||
"test:template-preview": "rm -rf .template-preview-test-build && mkdir -p .template-preview-test-build && printf '{\"type\":\"commonjs\"}\\n' > .template-preview-test-build/package.json && tsc -p tsconfig.template-preview-tests.json && node .template-preview-test-build/tests/template-preview-draft.test.js"
|
"test:template-preview": "rm -rf .template-preview-test-build && mkdir -p .template-preview-test-build && printf '{\"type\":\"commonjs\"}\\n' > .template-preview-test-build/package.json && tsc -p tsconfig.template-preview-tests.json && node .template-preview-test-build/tests/template-preview-draft.test.js",
|
||||||
|
"test:import-utils": "rm -rf .import-test-build && mkdir -p .import-test-build && printf '{\"type\":\"commonjs\"}\\n' > .import-test-build/package.json && tsc -p tsconfig.import-tests.json && node .import-test-build/tests/import-utils.test.js",
|
||||||
|
"test:report-grid": "rm -rf .report-grid-test-build && mkdir -p .report-grid-test-build && printf '{\"type\":\"commonjs\"}\\n' > .report-grid-test-build/package.json && tsc -p tsconfig.report-grid-tests.json && node .report-grid-test-build/tests/report-grid-query.test.js",
|
||||||
|
"test:review-preview-ui": "rm -rf .review-preview-test-build && mkdir -p .review-preview-test-build && printf '{\"type\":\"commonjs\"}\\n' > .review-preview-test-build/package.json && tsc -p tsconfig.review-preview-tests.json && node .review-preview-test-build/tests/review-preview-ui.test.js && node tests/delivery-mode-ui-structure.test.mjs",
|
||||||
|
"test:operator-queue": "node --experimental-strip-types --test tests/operator-queue-model.test.ts && node tests/operator-queue-ui-structure.test.mjs",
|
||||||
|
"test:aggregate-report": "tsc -p tsconfig.aggregate-report-tests.json && node tests/aggregate-report-ui-structure.test.mjs"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.7.2"
|
"typescript": "^5.7.2"
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user