refactor: 백엔드 리펙토링 진행 중
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
# Every top-level public type under the platform packages. Growth is a reviewed change.
|
||||
# Update only after review with:
|
||||
# ./gradlew :adapter:outbound:notification:updateNotificationApiSurface -PapproveNotificationApiSurfaceChange
|
||||
# types: 416
|
||||
# types: 379
|
||||
dev.caskeleton.adapter.outbound.notification.NotificationConfig
|
||||
dev.caskeleton.adapter.outbound.notification.NotificationRoutesSettings
|
||||
dev.caskeleton.adapter.outbound.notification.core.FailOpenNotificationProvider
|
||||
@@ -61,20 +61,6 @@ dev.caskeleton.adapter.outbound.notification.platform.observation.NotificationSe
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.EmailAttachments
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ProviderResults
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.UnconfiguredAttachmentResolver
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.apns.ApnsFailureClassifier
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.apns.ApnsNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.apns.ApnsProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.apns.ApnsRequestMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmBatchCoordinator
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmBatchResult
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmContactPointUpdater
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmFailureClassifier
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmGateway
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmMessageMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmTargetMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.fcm.FcmWireTarget
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.http.JdkNotificationHttpGateway
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.http.NotificationEndpoints
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.http.NotificationHttpGateway
|
||||
@@ -89,7 +75,6 @@ dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SesFailureCla
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SesNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SesProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SesRequestMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SesSuppressionUpdater
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SnsCertificateProvider
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.ses.SnsSignatureVerifier
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.smtp.JavaMailSenderSmtpDispatch
|
||||
@@ -99,28 +84,6 @@ dev.caskeleton.adapter.outbound.notification.platform.provider.smtp.SmtpFailureC
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.smtp.SmtpMimeMessageFactory
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.smtp.SmtpNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.smtp.SmtpProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioCallbackAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioDeliveryProjector
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioFailureClassifier
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioReconciliationCapability
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioRequestMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioSignatureValidator
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioSmsProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.twilio.TwilioStatusNormalizer
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webhook.WebhookNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webhook.WebhookSignatureStrategy
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webhook.WebhookSubscription
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.EncryptedWebPushPayload
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.Rfc8291Aes128GcmEncryptor
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.VapidAuthorizationProvider
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.VapidJwtSigner
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.VapidKeyRegistry
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.WebPushFailureClassifier
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.WebPushNotificationProviderAdapter
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.WebPushProviderProperties
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.WebPushReceiptCapability
|
||||
dev.caskeleton.adapter.outbound.notification.platform.provider.webpush.WebPushRequestMapper
|
||||
dev.caskeleton.adapter.outbound.notification.platform.security.AesGcmCallbackPayloadProtection
|
||||
dev.caskeleton.adapter.outbound.notification.platform.security.AesGcmContactPointProtector
|
||||
dev.caskeleton.adapter.outbound.notification.platform.security.AesGcmNotificationPayloadProtection
|
||||
|
||||
@@ -66,14 +66,11 @@ and `APP_NOTIFICATION_PLATFORM_SES_*` aliases so operators do not have to invent
|
||||
|
||||
| Field | Meaning |
|
||||
|---|---|
|
||||
| `type` | `APNS`, `FCM`, `SES`, `SMTP`, `TWILIO`, `WEB_PUSH`, `WEBHOOK` — a closed enum, so an unknown value fails binding rather than assembling into nothing |
|
||||
| `type` | `SES`, `SMTP` — a closed enum, so an unknown value fails binding rather than assembling into nothing |
|
||||
| `enabled` | A disabled profile is bound and validated but contributes no runtime |
|
||||
| `primary-for-channel` | Exactly one primary per channel |
|
||||
| `environment` | Required when enabled |
|
||||
| `credential-profile` | Provider credential key id resolved through `SecretMaterialProvider`; never inline secret material |
|
||||
| `topic` | APNs bundle id |
|
||||
| `vapid-public-key` | Web Push application server key |
|
||||
| `callback-signing-secret-ref` | Reference, not material |
|
||||
| `timeout` | Positive and finite |
|
||||
| `max-concurrency` | Positive |
|
||||
| `rate-per-second` | Positive |
|
||||
@@ -100,22 +97,19 @@ The shipped reference profile is `providers.ses` and is disabled by default. It
|
||||
`APP_NOTIFICATION_PLATFORM_PROVIDER_CREDENTIAL_KEY`, whose active key id must match
|
||||
`APP_NOTIFICATION_PLATFORM_SES_CREDENTIAL_KEY_ID`.
|
||||
|
||||
`type` is the closed **provider model**, not a promise that the shipped composition contains a
|
||||
dispatch assembler for every value. Current shipped reachability is:
|
||||
`type` lists only the families the shipped composition can assemble. Current shipped
|
||||
reachability is:
|
||||
|
||||
| Provider type | Contract/adapter code | Shipped dispatch assembler | Shipped callback assembler | What happens when enabled for dispatch |
|
||||
|---|---|---|---|---|
|
||||
| `SMTP` | yes | **yes** | no | assembles when Spring Mail relay settings are complete |
|
||||
| `SES` | yes | **yes** | **yes** | assembles an EMAIL runtime from the typed `ses` block; SNS callback verification remains available in `INGEST_ONLY` |
|
||||
| `TWILIO` | yes | no | no | dispatch fails startup by profile name |
|
||||
| `FCM` | yes | no | no | dispatch fails startup by profile name |
|
||||
| `APNS` | yes | no | no | dispatch fails startup by profile name |
|
||||
| `WEB_PUSH` | yes | no | no | dispatch fails startup by profile name |
|
||||
| `WEBHOOK` | yes | no | no | dispatch fails startup by profile name |
|
||||
|
||||
This distinction is deliberate: tested provider protocol code is not the same thing as a
|
||||
composition-reachable provider. Adding a family to the shipped runtime requires a
|
||||
`ProviderRuntimeAssembler` plus the settings/secret inputs that adapter actually needs.
|
||||
APNs, FCM, Twilio, Web Push and Webhook adapters used to ship as protocol code with no assembler, so
|
||||
enabling one failed startup. They were removed; the `docs/capability-status.md` "제거된 코드" table
|
||||
names the last commit that had them. Adding a family back means adding its adapter, a
|
||||
`ProviderRuntimeAssembler`, its `ProviderType` constant and the settings/secret inputs it actually
|
||||
needs, together.
|
||||
|
||||
## SMTP relay
|
||||
|
||||
@@ -164,8 +158,7 @@ Startup fails rather than degrading when:
|
||||
- a TTL-required profile has no expiry source
|
||||
- a callback signing secret is missing
|
||||
- a production profile enables trust-all
|
||||
- an APNs profile is missing its environment or topic
|
||||
- a Web Push profile is missing its VAPID key
|
||||
- an SES profile is missing its `ses` block, or callbacks are on and `ses.allowed-topic-arns` is empty
|
||||
- two provider profiles share an id
|
||||
- a route points only at disabled providers
|
||||
- `mode` is `SERVING` and no provider profile is enabled
|
||||
@@ -177,7 +170,7 @@ All key material arrives through `SecretMaterialProvider`. Nothing is read from
|
||||
committed file, or from a plaintext log. Contact point encryption and lookup HMAC keys must be
|
||||
distinct, and the encryption key must be exactly 256 bits.
|
||||
|
||||
Eight purposes, eight keys. Each is base64 of at least 32 bytes and each must differ from every
|
||||
Seven purposes, seven keys. Each is base64 of at least 32 bytes and each must differ from every
|
||||
other; the platform decodes them at startup and refuses to boot if one is blank, short or shared. A
|
||||
blank value used to be skipped, which meant the platform started without the key and found out on
|
||||
the first contact point — in production, on a recipient's notification.
|
||||
@@ -195,7 +188,6 @@ any example: a value that appears in the repository is a value that has been dis
|
||||
| Provider credential encryption | `APP_NOTIFICATION_PLATFORM_PROVIDER_CREDENTIAL_KEY` | `APP_NOTIFICATION_PLATFORM_PROVIDER_CREDENTIAL_KEY_ID` |
|
||||
| Provider request lookup HMAC | `APP_NOTIFICATION_PLATFORM_PROVIDER_REQUEST_LOOKUP_HMAC_KEY` | `APP_NOTIFICATION_PLATFORM_PROVIDER_REQUEST_LOOKUP_HMAC_KEY_ID` |
|
||||
| Payload encryption | `APP_NOTIFICATION_PLATFORM_PAYLOAD_ENCRYPTION_KEY` | `APP_NOTIFICATION_PLATFORM_PAYLOAD_ENCRYPTION_KEY_ID` |
|
||||
| Web Push VAPID signing | `APP_NOTIFICATION_PLATFORM_VAPID_SIGNING_KEY` | `APP_NOTIFICATION_PLATFORM_VAPID_SIGNING_KEY_ID` |
|
||||
|
||||
A key id is not secret — an id identifies key material without revealing it — but it is required,
|
||||
and it has no default on purpose. A constant id makes a rotation indistinguishable from the key it
|
||||
|
||||
@@ -39,11 +39,6 @@ that owns its responsibility. No public contract, evidence rule, or reliability
|
||||
| `notification-template-thymeleaf` (reference renderer) | `adapter:outbound:notification` | `…platform.template` |
|
||||
| `notification-email-smtp` | `adapter:outbound:notification` | `…platform.provider.smtp` |
|
||||
| `notification-email-ses` | `adapter:outbound:notification` | `…platform.provider.ses` |
|
||||
| `notification-sms-twilio` | `adapter:outbound:notification` | `…platform.provider.twilio` |
|
||||
| `notification-push-fcm` | `adapter:outbound:notification` | `…platform.provider.fcm` |
|
||||
| `notification-push-apns` | `adapter:outbound:notification` | `…platform.provider.apns` |
|
||||
| `notification-webpush` (transport + crypto) | `adapter:outbound:notification` | `…platform.provider.webpush` |
|
||||
| `notification-webhook-extension` | `adapter:outbound:notification` | `…platform.provider.webhook` |
|
||||
| `notification-observability` (Micrometer impl) | `adapter:outbound:notification` | `…platform.observation` |
|
||||
| `notification-admin-runtime` | `adapter:outbound:notification` | `…platform.admin` |
|
||||
| `notification-spring-boot-starter` | `adapter:outbound:notification` | `…platform.autoconfigure` |
|
||||
@@ -71,9 +66,8 @@ adapter:outbound:notification adapter:outbound:persistence-jpa adapter:inb
|
||||
|
||||
Two plan edges cannot be expressed as project edges in this repository, and are replaced by ports:
|
||||
|
||||
1. `notification-email-ses`, `notification-sms-twilio`, `notification-push-fcm`,
|
||||
`notification-push-apns`, `notification-webpush`, `notification-webhook-extension`
|
||||
→ `httpclient platform`.
|
||||
1. `notification-email-ses` → `httpclient platform`. (The Twilio, FCM, APNs, Web Push and
|
||||
Webhook adapters that shared this edge were removed: none had an assembler.)
|
||||
`adapter-outbound-notification` is not allowed to depend on `adapter-outbound-httpclient`.
|
||||
The provider adapters therefore call
|
||||
`dev.caskeleton.adapter.outbound.notification.platform.provider.http.NotificationHttpGateway`,
|
||||
|
||||
@@ -27,39 +27,8 @@ send, so `MessageId` is never mapped to `DELIVERED`.
|
||||
| `Reject` | `PROVIDER_REJECTED` |
|
||||
| `RenderingFailure` | `TEMPLATE_FAILURE` |
|
||||
|
||||
## Twilio
|
||||
## Removed provider families
|
||||
|
||||
`accepted`/`queued` is acceptance only. `sent` is carrier acceptance. `delivered` is device delivery.
|
||||
|
||||
Callbacks are not ordered. A `sent` arriving after `delivered` is stored and ignored by the
|
||||
projection. Missing callbacks are corrected by status polling under the provider rate limit.
|
||||
|
||||
Signature verification uses the canonical external URL from the profile, not the URL the servlet
|
||||
container reconstructed behind a proxy.
|
||||
|
||||
## FCM
|
||||
|
||||
| Error | Classification |
|
||||
|---|---|
|
||||
| `UNREGISTERED` | `INVALID_RECIPIENT`; invalidate the contact point, never retry |
|
||||
| `INVALID_ARGUMENT` | `INVALID_PAYLOAD` |
|
||||
| `QUOTA_EXCEEDED` | `THROTTLED`, exponential backoff |
|
||||
| `UNAVAILABLE` | `TRANSIENT_PROVIDER`, honour `Retry-After`, add jitter |
|
||||
| Credential failure | `AUTHENTICATION`; opens the provider route |
|
||||
|
||||
A batch is one transport call and many attempts. Partial results map back by input index; one
|
||||
transport failure does not become one shared outcome unless the adapter can prove it.
|
||||
|
||||
## APNs
|
||||
|
||||
2xx is acceptance. Environment and topic mismatches are configuration failures, not delivery
|
||||
failures. Sandbox and production tokens are separate namespaces.
|
||||
|
||||
## Web Push
|
||||
|
||||
`TTL` is mandatory by protocol. `201` is acceptance. `404` is an expired subscription per RFC 8030;
|
||||
provider-documented `410` maps the same way. Payloads use `aes128gcm` per RFC 8291 and VAPID JWTs are
|
||||
signed per RFC 8292 with the audience taken from the endpoint origin.
|
||||
|
||||
VAPID key rotation is not ordinary credential rotation: a restricted subscription may need to be
|
||||
re-created, so it is a migration operation.
|
||||
Twilio, FCM, APNs, Web Push and Webhook adapters were removed because nothing assembled them; their
|
||||
runbooks went with them. The last commit that had both is named in `docs/capability-status.md`
|
||||
(제거된 코드). A deployment that adds one of these providers back writes its runbook here with it.
|
||||
|
||||
@@ -17,12 +17,11 @@ against real PostgreSQL; the wire and the crash are not. That is what the grade
|
||||
| Channel | Reference implementation | Grade | Strongest evidence the platform records by default |
|
||||
|---|---|---|---|
|
||||
| Email | SMTP, Amazon SES API | Contract implemented / runtime unqualified | Provider acceptance; recipient mail-server delivery, bounce and complaint when the provider publishes events |
|
||||
| SMS | Twilio Programmable Messaging | Contract implemented / runtime unqualified | `accepted`/`queued`, `sent`, and carrier-DLR `delivered`/`undelivered` |
|
||||
| Mobile push (Android and cross-platform) | FCM, FID-first with legacy registration token compatibility | Contract implemented / runtime unqualified | FCM acceptance and explicit failures |
|
||||
| Mobile push (Apple) | APNs HTTP/2 provider API | Contract implemented / runtime unqualified | APNs acceptance |
|
||||
| Web Push | RFC 8030, RFC 8291, RFC 8292 | Contract implemented / runtime unqualified | Push-service acceptance; user-agent acknowledgement only where the service offers receipts |
|
||||
| SMS | none shipped — adapter removed; the channel type stays in the application API (see `docs/capability-status.md` 제거된 코드) | Extension | Whatever the added provider adapter can prove |
|
||||
| Mobile push (FCM, APNs) | none shipped — adapter removed; the channel type stays in the application API (see `docs/capability-status.md` 제거된 코드) | Extension | Whatever the added provider adapter can prove |
|
||||
| Web Push | none shipped — adapter removed; the channel type stays in the application API (see `docs/capability-status.md` 제거된 코드) | Extension | Whatever the added provider adapter can prove |
|
||||
| In-app inbox | Own database | Optional stable | `PERSISTED`, `SEEN`, `READ` |
|
||||
| Webhook | HTTP client platform | Extension | Whatever the receiving HTTP contract states |
|
||||
| Webhook | none shipped — adapter removed; the channel type stays in the application API (see `docs/capability-status.md` 제거된 코드) | Extension | Whatever the receiving HTTP contract states |
|
||||
|
||||
## Shipped provider assembly reachability
|
||||
|
||||
@@ -33,13 +32,10 @@ implementation is selectable in the default composition. Dispatch reachability i
|
||||
|---|---|---|---|
|
||||
| SMTP | **yes** | no | EMAIL dispatch reference family |
|
||||
| SES | **yes** | **yes** | EMAIL dispatch + SNS callback ingestion; disabled reference profile ships in `config/module-defaults/notification.yml` (`composition:notification-platform`) |
|
||||
| Twilio | no | no | contract implementation / extension wiring |
|
||||
| FCM | no | no | contract implementation / extension wiring |
|
||||
| APNs | no | no | contract implementation / extension wiring |
|
||||
| Web Push | no | no | contract implementation / extension wiring |
|
||||
| Webhook | no | no | extension wiring |
|
||||
|
||||
An enabled dispatch profile with no assembler fails startup by profile/family; it never silently
|
||||
APNs, FCM, Twilio, Web Push and Webhook adapters shipped as protocol code with no assembler and
|
||||
were removed; `ProviderType` now lists only SES and SMTP, so such a profile fails binding as an
|
||||
unknown type. An enabled dispatch profile with no assembler fails startup by profile/family; it never silently
|
||||
assembles into an empty runtime. SMTP additionally names `spring.mail.host` when its shipped
|
||||
assembler is absent because the relay was not configured.
|
||||
|
||||
@@ -73,21 +69,14 @@ The remaining unmet claim, and what would meet it:
|
||||
| Internal queue commit | `PLATFORM_QUEUED` |
|
||||
| SES `MessageId` | `PROVIDER_ACCEPTED` |
|
||||
| SES `Delivery` | `NETWORK_OR_CARRIER_ACCEPTED` |
|
||||
| Twilio `accepted` / `queued` | `PROVIDER_ACCEPTED` |
|
||||
| Twilio `sent` | `NETWORK_OR_CARRIER_ACCEPTED` |
|
||||
| Twilio `delivered` | `DEVICE_DELIVERED` |
|
||||
| FCM send success | `PROVIDER_ACCEPTED` |
|
||||
| APNs 2xx | `PROVIDER_ACCEPTED` |
|
||||
| Web Push `201` | `PROVIDER_ACCEPTED` |
|
||||
| Web Push receipt capability | `DEVICE_DELIVERED` |
|
||||
| In-app row commit | `PROVIDER_ACCEPTED` |
|
||||
| In-app `seen` endpoint | `USER_AGENT_DISPLAYED` |
|
||||
| In-app `read` endpoint, authenticated app receipt | `USER_READ` |
|
||||
|
||||
Promotions the platform will not make, in code or in configuration:
|
||||
|
||||
- FCM send success is not `DEVICE_DELIVERED`.
|
||||
- An APNs 2xx is not `DELIVERED`.
|
||||
- A push or SMS acceptance, from any provider adapter a deployment adds, is not `DEVICE_DELIVERED`.
|
||||
- A provider 2xx is not `DELIVERED`.
|
||||
- An SES `MessageId` is not `DELIVERED`.
|
||||
- An SMTP `250` is not inbox delivery.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user