Notifikasjonsplattformen består av flere applikasjoner bygget rundt en Event Sourcing arkitektur. Hendelser publiseres til kafka topicen fager.notifikasjon. Hver applikasjon konsumerer hendelser fra denne topicen og bruker hendelsene som kilde til å bygge opp sine modeller.
Følgende diagram viser en oversikt over de forskjellige applikasjonene og hvordan de er koblet sammen.
C4Dynamic
title Notifikasjonsplattform Oversikt
SystemQueue(notifikasjonerTopic, "notifikasjoner kafka topic")
Container_Boundary(produsentApiBnd, "notifikasjon-produsent-api") {
Container(produsentApi, "notifikasjon-produsent-api", "ktor app", "produserer notifikasjoner")
ContainerDb(produsentApiDb, "database", "gcp sql postgres")
}
BiRel(notifikasjonerTopic, produsentApi, "read/write")
BiRel(produsentApi, produsentApiDb, "read/write")
Container_Boundary(brukerApiBnd, "notifikasjon-bruker-api") {
Container(brukerApi, "notifikasjon-bruker-api", "ktor app", "viser notifikasjoner for bruker")
ContainerDb(brukerApiDb, "database", "gcp sql postgres")
Container(brukerApiWriter, "notifikasjon-bruker-api-writer", "ktor app", "skriver notifikasjoner til brukerApi databasen")
}
Rel(notifikasjonerTopic, brukerApi, "read")
Rel(brukerApiWriter, notifikasjonerTopic, "write")
Rel(brukerApiWriter, brukerApiDb, "write")
Rel(brukerApi, brukerApiDb, "read")
Container_Boundary(eksternVarslingBnd, "notifikasjon-ekstern-varsling") {
System_Ext(altinnWs, "Altinn SOAP WS", "Tjenesteeier SOAP API i Altinn for sending av sms/epost")
Container_Ext(altinnVarselFirewall, "altinn-varsel-firewall", "ktor app", "Proxy tjeneste eid av team FAGER")
Container(eksternVarsling, "notifikasjon-ekstern-varsling", "ktor app", "varsler bruker eksternt via sms/epost")
ContainerDb(eksternVarslingDb, "database", "gcp sql postgres")
}
Rel(eksternVarsling, altinnVarselFirewall, "sendStandaloneNotification (sms/epost/serviceCode)")
Rel(altinnVarselFirewall, altinnWs, "sendStandaloneNotification (sms/epost/serviceCode)")
BiRel(notifikasjonerTopic, eksternVarsling, "read/write")
BiRel(eksternVarsling, eksternVarslingDb, "read/write")
Container_Boundary(skedulertHardDeleteBnd, "notifikasjon-skedulert-harddelete") {
Container(skedulertHardDelete, "notifikasjon-skedulert-harddelete", "ktor app", "oppretter harddeletes som har blitt bestilt ved opprettelse")
ContainerDb(skedulertHardDeleteDb, "database", "gcp sql postgres")
}
BiRel(notifikasjonerTopic, skedulertHardDelete, "read/write")
BiRel(skedulertHardDelete, skedulertHardDeleteDb, "read/write")
Container_Boundary(skedulertPaaminnelse, "notifikasjon-skedulert-paaminnelse") {
Container(skedulertPaaminnelse, "notifikasjon-skedulert-paaminnelse", "ktor app", "oppretter påminnelser som har blitt bestilt ved opprettelse")
}
BiRel(notifikasjonerTopic, skedulertPaaminnelse, "read/write")
Container_Boundary(skedulertUtgaatt, "notifikasjon-skedulert-utgaatt") {
Container(skedulertUtgaatt, "notifikasjon-skedulert-utgaatt", "ktor app", "oppretter utgått hendelse for oppgaver som er utgått")
}
BiRel(notifikasjonerTopic, skedulertUtgaatt, "read/write")
Container_Boundary(kafkaReaperBnd, "notifikasjon-kafka-reaper") {
Container(kafkaReaper, "notifikasjon-kafka-reaper", "ktor app", "gjør hard deletes om til tombstones i kafka")
ContainerDb(kafkaReaperDb, "database", "gcp sql postgres")
}
BiRel(notifikasjonerTopic, kafkaReaper, "read/write")
BiRel(kafkaReaper, kafkaReaperDb, "read/write")
Container_Boundary(replayValidatorBnd, "notifikasjon-replay-validator") {
Container(replayValidator, "notifikasjon-replay-validator", "ktor app", "validerer replay av event source")
}
Rel(notifikasjonerTopic, replayValidator, "event source read", "sjekker alle hendelser er kompatible med hendelsemodellen i kode")
Container_Boundary(kafkaBackupBnd, "notifikasjon-kafka-backup") {
Container(kafkaBackup, "notifikasjon-kafka-backup", "ktor app", "raw backup av event source i tilfelle katastrofe")
ContainerDb(kafkaBackupDb, "database", "gcp sql postgres")
}
Rel(notifikasjonerTopic, kafkaBackup, "event source read")
Rel(kafkaBackup, kafkaBackupDb, "read/write")
Container_Boundary(manueltVedlikeholdBnd, "notifikasjon-manuelt-vedlikehold") {
Container(manueltVedlikehold, "notifikasjon-manuelt-vedlikehold", "ktor app", "muliggjør manuell vedlikehold av event source")
}
BiRel(notifikasjonerTopic, manueltVedlikehold, "read/write")
Container_Boundary(statistikk, "notifikasjon-statistikk") {
Container(statistikk, "notifikasjon-statistikk", "ktor app", "real time statistikk over notifikasjoner")
ContainerDb(statistikkDb, "database", "gcp sql postgres")
}
Rel(notifikasjonerTopic, statistikk, "event source read")
Rel(statistikk, statistikkDb, "read/write")
Container_Boundary(dataproduktBnd, "notifikasjon-dataprodukt") {
ContainerDb_Ext(dataproduktDatastore, "metabase", "Dataprodukt database")
ContainerDb(dataproduktDb, "database", "gcp sql postgres")
Container(dataprodukt, "notifikasjon-dataprodukt", "ktor app", "eksporterer statistikk til dataprodukt")
}
Rel(notifikasjonerTopic, dataprodukt, "event source read")
Rel(dataprodukt, dataproduktDb, "lagre pseudonymert data")
Rel(dataproduktDb, dataproduktDatastore, "publiser dataprodukt")
UpdateLayoutConfig($c4ShapeInRow="1", $c4BoundaryInRow="4")
notifikasjon-produsent-api brukes av produsenter for å opprette saker, beskjeder, oppgaver og kalenderavtaler. Produsenter kaller applikasjonen gjennom et GraphQL API. Applikasjonen oppretter hendelser på kafka topicen fager.notifikasjon basert på de mutations som produsenter gjør via APIet. Applikasjonen har et register for hvilke produsenter som har tilgang til hvilke merkelapper som definert i arbeidsgiver-notifikasjon-produsenter. Den har en egen database som brukes for bl.a. idempotens sjekk og validering. Applikasjonen er deployet til nais med følgende definisjon: prod-gcp-produsent-api.yaml
notifikasjon-bruker-api brukes av min side arbeidsgiver og notifikasjon-widget for å vise innloggede arbeidsgivere sine notifikasjoner og saker. appen er delt i to (writer/reader) for økt robusthet. De deler samme database på gcp. applikasjon eksponerer et GraphQL API som klientene bruker for å hente data til visning. Det blir også produsert noen hendelser baser på brukerinteraksjon, f.eks bruker klikket på en notifikasjon.
notifikasjon-ekstern-varsling sender eksterne varsler
til arbeidsgivere via Altinn sitt SOAP API (https://altinn.github.io/docs/api/tjenesteeiere/soap/endepunkt-liste/#notificationagencyexternal).
Som et risikominimerende tiltak gjøres dette via en dedikert proxy-tjeneste altinn-varsel-firewall som er eid av team FAGER.
notifikasjon-ekstern-varsling konsumerer hendelser fra kafka topicen og registrerer/skedulerer varsler for notifikasjoner som skal ha det.
Ekstern varsling har en egen database som brukes for å lagre skedulerte varsler og status på varsler. Når varsler er sendt blir det lagret en hendelse på kafka topicen med status på varslingen iht. svar fra Altinn sitt API.
Applikasjonen har retry mekanismer som håndterer ustabilitet i Altinn sitt API.
notifikasjon-skedulert-harddelete konsumerer hendelser fra kafka topicen og oppretter harddeletes som har blitt bestilt ved opprettelse. Applikasjonen har en egen database som brukes for å lagre skedulerte harddeletes og sender disse på kafka topic når tidspunktet tilsier det skal gjøres.
notifikasjon-skedulert-paaminnelse konsumerer hendelser fra kafka topicen og oppretter påminnelser som har blitt bestilt ved opprettelse. Dette er funksjonalitet tilknyttet oppgave. Når en oppgave ikke er løst og påminnelsestidspunkt har passert så vil det bli laget en påminnelse med eller uten ekstern varsling avhengig av hva produsenten har bestilt.
notifikasjon-skedulert-utgaatt konsumerer hendelser fra kafka topicen og oppretter utgått hendelse for oppgaver som er utgått. Dette er funksjonalitet tilknyttet oppgave. Når en oppgave ikke er løst og den har en frist som er passert vil det bli laget en utgått hendelse. Utgått hendelsen sendes på kafka topic og vil endre tilstand på oppgaven og vil bli vist til arbeidsgiver via bruker-api.
notifikasjon-kafka-reaper konsumerer hendelser fra kafka topicen og gjør hard deletes om til tombstones i kafka. Applikasjonen holder styr på alle hendelser tilknyttet et aggregat og tombstoner alle relaterte hendelser når et aggregat blir slettet. Dette gjøres for å ivareta juridiske krav om sletting og for å støtte varierende hjemmel for datalagring hos forskjellige produsenter. En produsent kan når som helst slette sin data fra plattformen vha hard delete endepunktet. Produsenter kan også ved opprettelse av aggregater bestille hard deletes som skal skje på et senere tidspunkt (se notifikasjon-skedulert-harddelete i eget avsnitt).
notifikasjon-replay-validator konsumerer hendelser fra kafka topicen og validerer replay av event source.
Som et tiltak for å sikre at event source er robust og kan håndtere replay av hendelser så validerer denne applikasjonen at alle hendelser er kompatible med hendelsemodellen i kode.
Replay gjøres kontinuerlig i de fleste applikasjonene via delt replayPeriodically funksjonalitet. I tillegg til periodevis replay gjør replay-validatoren en full replay av event source ved oppstart.
notifikasjon-kafka-backup konsumerer hendelser fra kafka topicen og tar en raw backup av event source i tilfelle katastrofe.
notifikasjon-manuelt-vedlikehold brukes til ad hoc administrasjon av hendelsene. Som følge av uventede feil har det oppstått behov for å rydde i hendelser som er blitt publisert.
notifikasjon-statistikk konsumerer hendelser fra kafka topicen og produserer near realtime statistikk over bruk av plattformen. Denne statistikken lagres i en database og eksponeres til prometheus for overvåkning. Se for eksempel bruk av notifikasjoner, bruk av saker og bruk av ekstern varsling.
notifikasjon-dataprodukt eksporterer pseudonymisert statistikk til dataprodukt i metabase. Denne statistikken brukes til å lage dashboards og rapporter som produsenter selv kan bruke for innsikt i bruk av plattformen.