@oneuptime/common 14.0.7 → 14.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Models/DatabaseModels/Incident.ts +267 -1
- package/Models/DatabaseModels/IncidentCustomField.ts +202 -0
- package/Models/DatabaseModels/IncidentEpisode.ts +30 -0
- package/Models/DatabaseModels/IncidentTemplate.ts +126 -1
- package/Models/DatabaseModels/StatusPage.ts +55 -0
- package/Models/DatabaseModels/StatusPageSubscriber.ts +128 -0
- package/Server/API/IncidentAPI.ts +162 -0
- package/Server/API/StatusPageAPI.ts +487 -171
- package/Server/API/StatusPageSubscriberAPI.ts +63 -15
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795300000000-SkipHiddenIncidentCreatedNotifications.ts +49 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795400000000-AddIncidentStatusPageScope.ts +108 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795500000000-AddIncidentTemplateStatusPageScopeFlag.ts +33 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795600000000-AddStatusPageSubscriberUnsubscribeToken.ts +51 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795700000000-AddStatusPageSubscriberIsAddedByTeam.ts +33 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795800000000-AddIncidentCustomFieldCreateAndNotificationSettings.ts +168 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/1795900000000-AddSubscriberNotificationClaimedAt.ts +44 -0
- package/Server/Infrastructure/Postgres/SchemaMigrations/Index.ts +14 -0
- package/Server/Infrastructure/Semaphore.ts +10 -0
- package/Server/Middleware/IdentityRateLimit.ts +108 -3
- package/Server/Middleware/SubscriberNotificationPreviewRateLimit.ts +237 -0
- package/Server/Middleware/SubscriberNotificationTestSendRateLimit.ts +304 -0
- package/Server/Services/DatabaseService.ts +93 -10
- package/Server/Services/IncidentCustomFieldService.ts +276 -1
- package/Server/Services/IncidentEpisodePublicNoteService.ts +28 -0
- package/Server/Services/IncidentEpisodeService.ts +15 -0
- package/Server/Services/IncidentEpisodeStateTimelineService.ts +27 -1
- package/Server/Services/IncidentPublicNoteService.ts +30 -1
- package/Server/Services/IncidentService.ts +1535 -65
- package/Server/Services/IncidentStateTimelineService.ts +13 -0
- package/Server/Services/IncidentTemplateService.ts +109 -0
- package/Server/Services/ScheduledMaintenancePublicNoteService.ts +30 -1
- package/Server/Services/ScheduledMaintenanceService.ts +68 -18
- package/Server/Services/SmsService.ts +10 -0
- package/Server/Services/StatusPageService.ts +65 -8
- package/Server/Services/StatusPageSubscriberNotificationTemplateService.ts +299 -37
- package/Server/Services/StatusPageSubscriberNotificationTemplateStatusPageService.ts +129 -0
- package/Server/Services/StatusPageSubscriberService.ts +1161 -64
- package/Server/Types/Markdown.ts +153 -6
- package/Server/Types/Workflow/Components/Email.ts +61 -2
- package/Server/Utils/CustomField/CustomFieldRename.ts +378 -0
- package/Server/Utils/DataSource/EgressGuard.ts +66 -21
- package/Server/Utils/Mail/PinnedSmtpSocket.ts +130 -0
- package/Server/Utils/Monitor/MonitorCriteriaObservationBuilder.ts +10 -0
- package/Server/Utils/SSRFProtection.ts +76 -16
- package/Server/Utils/StatusPage/IncidentStatusPageScope.ts +948 -0
- package/Server/Utils/StatusPage/IncidentSubscriberAudienceBuilder.ts +656 -0
- package/Server/Utils/StatusPage/IncidentTemplateVariableBuilder.ts +805 -0
- package/Server/Utils/StatusPage/StatusPageExclusion.ts +18 -0
- package/Server/Utils/StatusPage/StatusPageReadAccess.ts +125 -0
- package/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeNotice.ts +151 -0
- package/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeToken.ts +70 -0
- package/Server/Utils/StatusPage/SubscriberIncidentEmailBuilder.ts +421 -0
- package/Server/Utils/StatusPage/SubscriberNotificationClaim.ts +107 -0
- package/Server/Utils/StatusPage/SubscriberNotificationDeliveryRecord.ts +1049 -0
- package/Server/Utils/StatusPage/SubscriberNotificationFanOut.ts +180 -0
- package/Server/Utils/StatusPage/SubscriberNotificationPreviewBuilder.ts +839 -0
- package/Server/Utils/StatusPage/SubscriberNotificationResendAccess.ts +393 -0
- package/Server/Utils/StatusPage/SubscriberNotificationRunLimit.ts +246 -0
- package/Server/Utils/StatusPage/SubscriberNotificationTiming.ts +133 -0
- package/Server/Utils/StatusPage/SubscriberTemplateIncidentRecordAccess.ts +215 -0
- package/Server/Utils/StatusPageResource.ts +51 -20
- package/Server/Utils/VM/VMAPI.ts +1 -0
- package/Server/Utils/VM/VMRunner.ts +10 -0
- package/Server/Utils/Workflow/OAuth2TokenClient.ts +10 -0
- package/Server/Views/Partials/SensitiveUrlToken.ejs +8 -5
- package/Tests/App/Accounts/RegisterVerifyEmail.test.tsx +748 -0
- package/Tests/App/Accounts/ResendVerificationEmail.test.tsx +1222 -0
- package/Tests/App/Accounts/VerificationEmailResendUtils.test.ts +797 -0
- package/Tests/App/Accounts/VerifyEmailPending.test.tsx +538 -0
- package/Tests/App/Accounts/VerifyEmailResend.test.tsx +779 -0
- package/Tests/App/Dashboard/CustomFieldsSettingsIncidentOptions.test.tsx +357 -0
- package/Tests/App/Dashboard/EventNotes.test.tsx +776 -0
- package/Tests/App/Dashboard/EventNotesPages.test.tsx +119 -0
- package/Tests/App/Dashboard/EventNotesUtil.test.ts +116 -17
- package/Tests/App/Dashboard/EventOverviewPages.test.tsx +242 -5
- package/Tests/App/Dashboard/IncidentChangeStateNotifyDefault.test.tsx +91 -1
- package/Tests/App/Dashboard/IncidentCreateDetailsStep.test.tsx +643 -0
- package/Tests/App/Dashboard/IncidentCreateFromAlerts.test.tsx +8 -1
- package/Tests/App/Dashboard/IncidentCreateStatusPageScope.test.tsx +601 -0
- package/Tests/App/Dashboard/IncidentCustomFieldTemplateVariables.test.tsx +386 -0
- package/Tests/App/Dashboard/IncidentNoteTemplatePlaceholders.test.tsx +124 -0
- package/Tests/App/Dashboard/IncidentNoteTemplateVariablesLoader.test.ts +305 -0
- package/Tests/App/Dashboard/IncidentOverviewNotifyDefault.test.tsx +112 -0
- package/Tests/App/Dashboard/IncidentSettingsRenotifyOnPublish.test.tsx +674 -0
- package/Tests/App/Dashboard/IncidentSettingsStatusPageScope.test.tsx +1051 -0
- package/Tests/App/Dashboard/IncidentTemplateCustomFields.test.tsx +384 -0
- package/Tests/App/Dashboard/IncidentTemplateStatusPageScopeCard.test.tsx +215 -0
- package/Tests/App/Dashboard/PublicNotePagesNotifyDefault.test.tsx +113 -1
- package/Tests/App/Dashboard/SubscriberAudienceSummary.test.tsx +512 -0
- package/Tests/App/Dashboard/SubscriberNotificationPreviewModal.test.tsx +837 -0
- package/Tests/App/Dashboard/SubscriberNotificationStatusLabel.test.tsx +88 -0
- package/Tests/App/Dashboard/SubscriberNotificationStatusResend.test.tsx +473 -0
- package/Tests/App/Dashboard/SubscriberTemplateLivePreview.test.tsx +196 -0
- package/Tests/App/Dashboard/TeamAddedSubscribersUnsubscribedNotice.test.tsx +248 -0
- package/Tests/App/SensitiveUrlTokenBootstrap.test.ts +64 -3
- package/Tests/App/StatusPage/StatusPageUnsubscribePage.test.tsx +412 -0
- package/Tests/Models/IncidentCustomFieldApiSchemaContract.test.ts +217 -0
- package/Tests/Models/IncidentCustomFieldCreateSettingsColumns.test.ts +252 -0
- package/Tests/Models/StatusPageSubscriberUnsubscribeColumns.test.ts +218 -0
- package/Tests/Server/API/ExpiredSessionRouteGuards.test.ts +7 -0
- package/Tests/Server/API/IncidentSubscriberAudienceAPI.test.ts +1408 -0
- package/Tests/Server/API/StatusPageIncidentScope.test.ts +1868 -0
- package/Tests/Server/API/StatusPageIncidentScopePostgres.test.ts +790 -0
- package/Tests/Server/API/StatusPageManageSubscriptionRecipient.test.ts +10 -1
- package/Tests/Server/API/StatusPageManageSubscriptionTemplateVariables.test.ts +206 -18
- package/Tests/Server/API/StatusPagePostmortemVisibility.test.ts +14 -2
- package/Tests/Server/API/StatusPageSubscriberCreateResponse.test.ts +217 -0
- package/Tests/Server/API/StatusPageSubscriberOwnership.test.ts +103 -2
- package/Tests/Server/API/StatusPageUnsubscribeAPI.test.ts +396 -0
- package/Tests/Server/Infrastructure/Postgres/AddIncidentStatusPageScopeMigration.test.ts +395 -0
- package/Tests/Server/Infrastructure/Postgres/AddIncidentTemplateStatusPageScopeFlagMigration.test.ts +150 -0
- package/Tests/Server/Infrastructure/Postgres/AddSubscriberNotificationClaimedAtMigration.test.ts +156 -0
- package/Tests/Server/Infrastructure/Postgres/SkipHiddenIncidentCreatedNotificationsMigration.test.ts +410 -0
- package/Tests/Server/Middleware/IdentityRateLimit.test.ts +551 -1
- package/Tests/Server/Middleware/SubscriberNotificationPreviewRateLimit.test.ts +238 -0
- package/Tests/Server/Middleware/SubscriberNotificationTestSendRateLimit.test.ts +245 -0
- package/Tests/Server/Services/AddStatusPageSubscriberUnsubscribeTokenMigration.test.ts +152 -0
- package/Tests/Server/Services/CrossProjectRelationWriteGuard.test.ts +221 -36
- package/Tests/Server/Services/DatabaseServiceCompareAndSetColumns.test.ts +191 -0
- package/Tests/Server/Services/IncidentCreatedRenotifyOnPublish.test.ts +681 -0
- package/Tests/Server/Services/IncidentCreatedResend.test.ts +775 -0
- package/Tests/Server/Services/IncidentCustomFieldRenamePostgres.test.ts +713 -0
- package/Tests/Server/Services/IncidentCustomFieldService.test.ts +751 -0
- package/Tests/Server/Services/IncidentCustomFieldValueValidation.test.ts +556 -0
- package/Tests/Server/Services/IncidentStatusPageScope.test.ts +2971 -0
- package/Tests/Server/Services/IncidentStatusPageScopeFeed.test.ts +131 -0
- package/Tests/Server/Services/IncidentStatusPageScopePostgres.test.ts +625 -0
- package/Tests/Server/Services/IncidentTemplateCustomFieldsCopy.test.ts +311 -0
- package/Tests/Server/Services/IncidentTemplateStatusPageScope.test.ts +363 -0
- package/Tests/Server/Services/PublicNoteEditFeedEventType.test.ts +213 -0
- package/Tests/Server/Services/PublicNoteResendAccess.test.ts +994 -0
- package/Tests/Server/Services/ScheduledMaintenanceSubscriberTemplateFormats.test.ts +289 -9
- package/Tests/Server/Services/SmsServiceFailIfNotSent.test.ts +67 -0
- package/Tests/Server/Services/StatusPageReportIncidentCounts.test.ts +610 -0
- package/Tests/Server/Services/StatusPageSubscriberAudienceCounts.test.ts +201 -0
- package/Tests/Server/Services/StatusPageSubscriberAudienceCountsPostgres.test.ts +271 -0
- package/Tests/Server/Services/StatusPageSubscriberConfirmationTemplateEscaping.test.ts +200 -0
- package/Tests/Server/Services/StatusPageSubscriberNotificationLogRedaction.test.ts +54 -0
- package/Tests/Server/Services/StatusPageSubscriberNotificationTemplateCompile.test.ts +37 -0
- package/Tests/Server/Services/StatusPageSubscriberNotificationTemplateIncidentRecordAccess.test.ts +772 -0
- package/Tests/Server/Services/StatusPageSubscriberNotificationTemplateLookup.test.ts +506 -0
- package/Tests/Server/Services/StatusPageSubscriberNotificationTemplateLookupPostgres.test.ts +261 -0
- package/Tests/Server/Services/StatusPageSubscriberReport.test.ts +21 -5
- package/Tests/Server/Services/StatusPageSubscriberUnsubscribe.test.ts +1618 -0
- package/Tests/Server/Services/StatusPageSubscriberUnsubscribeLinkSenders.test.ts +373 -0
- package/Tests/Server/Services/StatusPageSubscriberUnsubscribePostgres.test.ts +388 -0
- package/Tests/Server/Services/SubscriberNotificationInFlightRequeue.test.ts +500 -0
- package/Tests/Server/Types/MarkdownEmailLinks.test.ts +320 -0
- package/Tests/Server/Types/Workflow/Components/Email.test.ts +491 -1
- package/Tests/Server/Types/Workflow/Components/EmailSmtpPinning.test.ts +398 -0
- package/Tests/Server/Utils/CustomField/CustomFieldRename.test.ts +586 -0
- package/Tests/Server/Utils/DataSource/EgressGuard.test.ts +246 -10
- package/Tests/Server/Utils/DataSource/EgressGuardDeploymentConfig.test.ts +226 -0
- package/Tests/Server/Utils/DataSource/EgressGuardPinning.test.ts +131 -0
- package/Tests/Server/Utils/DataSource/HttpFetch.test.ts +4 -0
- package/Tests/Server/Utils/EgressPolicyEnvironment.ts +45 -0
- package/Tests/Server/Utils/Mail/PinnedSmtpSocket.test.ts +409 -0
- package/Tests/Server/Utils/Monitor/MonitorCriteriaObservationBuilderUnits.test.ts +23 -0
- package/Tests/Server/Utils/SSRFProtection.test.ts +4 -0
- package/Tests/Server/Utils/SSRFProtectionCloudServiceAddresses.test.ts +4 -0
- package/Tests/Server/Utils/SSRFProtectionPrivateNetwork.test.ts +4 -0
- package/Tests/Server/Utils/SSRFProtectionResolutionDetail.test.ts +314 -0
- package/Tests/Server/Utils/StatusPage/IncidentStatusPageScope.test.ts +1699 -0
- package/Tests/Server/Utils/StatusPage/IncidentStatusPageScopeQueriesPostgres.test.ts +508 -0
- package/Tests/Server/Utils/StatusPage/IncidentSubscriberAudienceCallerPermission.test.ts +246 -0
- package/Tests/Server/Utils/StatusPage/IncidentTemplateVariableBuilder.test.ts +1348 -0
- package/Tests/Server/Utils/StatusPage/StatusPageReadAccess.test.ts +221 -0
- package/Tests/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeNotice.test.ts +132 -0
- package/Tests/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeToken.test.ts +155 -0
- package/Tests/Server/Utils/StatusPage/SubscriberIncidentEmailBuilder.test.ts +708 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationClaim.test.ts +255 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationClaimPostgres.test.ts +528 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationDeliveryRecord.test.ts +1238 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationFanOut.test.ts +472 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationPreviewBuilder.test.ts +1168 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationRunLimit.test.ts +275 -0
- package/Tests/Server/Utils/StatusPage/SubscriberNotificationTiming.test.ts +131 -0
- package/Tests/Server/Utils/StatusPageResource.test.ts +98 -0
- package/Tests/Server/Utils/VM/VMRunnerPrivateNetworkWiring.test.ts +17 -0
- package/Tests/Server/Utils/VM/VMRunnerSsrf.test.ts +75 -0
- package/Tests/Types/CustomField/CustomFieldSavedViews.test.ts +247 -0
- package/Tests/Types/CustomField/CustomFieldTemplateValues.test.ts +186 -0
- package/Tests/Types/CustomField/CustomFieldTypeCorrespondence.test.ts +48 -0
- package/Tests/Types/CustomField/CustomFieldValueFormat.test.ts +215 -0
- package/Tests/Types/CustomField/CustomFieldValueValidator.test.ts +343 -0
- package/Tests/Types/CustomField/CustomFieldVariableKey.test.ts +364 -0
- package/Tests/Types/SafeHtml.test.ts +102 -0
- package/Tests/Types/StatusPage/IncidentCreatedRenotify.test.ts +419 -0
- package/Tests/Types/StatusPage/IncidentCreatedResend.test.ts +118 -0
- package/Tests/Types/StatusPage/IncidentScopeAddedPagesNotification.test.ts +558 -0
- package/Tests/Types/StatusPage/IncidentSubscriberAudience.test.ts +284 -0
- package/Tests/Types/StatusPage/StatusPageSubscriberUnsubscribe.test.ts +341 -0
- package/Tests/Types/StatusPage/SubscriberNotificationPreview.test.ts +196 -0
- package/Tests/Types/StatusPage/SubscriberNotificationResend.test.ts +201 -0
- package/Tests/Types/StatusPage/SubscriberNotificationTemplateCompiler.test.ts +277 -0
- package/Tests/Types/StatusPage/SubscriberNotificationTemplatePreview.test.ts +179 -0
- package/Tests/Types/StatusPage/SubscriberNotificationTemplateVariables.test.ts +324 -0
- package/Tests/Types/StatusPage/SubscriberUpdateNotification.test.ts +60 -13
- package/Tests/UI/Components/CustomFields/CustomFieldFormFields.test.ts +432 -0
- package/Tests/UI/Components/CustomFields/CustomFieldModelFormFields.test.tsx +685 -0
- package/Tests/UI/Components/CustomFields/CustomFieldsDetailOrder.test.tsx +469 -0
- package/Tests/UI/Components/Forms/ModelFormCustomFieldInputs.test.tsx +325 -0
- package/Tests/UI/Components/Forms/ModelFormDropdownOptionsRefused.test.tsx +358 -0
- package/Tests/UI/Components/ModelTable/CustomFieldColumns.test.tsx +22 -0
- package/Tests/UI/Monitor/NetworkPathView.test.tsx +289 -0
- package/Tests/Utils/Incident/IncidentNoteTemplateVariables.test.ts +623 -0
- package/Tests/Utils/Markdown/MarkdownEscape.test.ts +89 -0
- package/Tests/Utils/ProbeNetworkFailureUtil.test.ts +992 -0
- package/Tests/Utils/RequestFailedDetails.test.ts +575 -0
- package/Types/CustomField/CustomFieldOrder.ts +55 -0
- package/Types/CustomField/CustomFieldSavedViews.ts +225 -0
- package/Types/CustomField/CustomFieldTemplateMerge.ts +71 -0
- package/Types/CustomField/CustomFieldType.ts +14 -0
- package/Types/CustomField/CustomFieldValueFormat.ts +161 -0
- package/Types/CustomField/CustomFieldValueValidator.ts +488 -0
- package/Types/CustomField/CustomFieldVariableKey.ts +211 -0
- package/Types/SafeHtml.ts +93 -0
- package/Types/StatusPage/IncidentCreatedRenotify.ts +224 -0
- package/Types/StatusPage/IncidentCreatedResend.ts +108 -0
- package/Types/StatusPage/IncidentScopeAddedPagesNotification.ts +343 -0
- package/Types/StatusPage/IncidentSubscriberAudience.ts +332 -0
- package/Types/StatusPage/StatusPageSubscriberUnsubscribe.ts +405 -0
- package/Types/StatusPage/SubscriberNotificationInterruption.ts +32 -0
- package/Types/StatusPage/SubscriberNotificationPreview.ts +322 -0
- package/Types/StatusPage/SubscriberNotificationResend.ts +132 -0
- package/Types/StatusPage/SubscriberNotificationTemplateCompiler.ts +180 -0
- package/Types/StatusPage/SubscriberNotificationTemplatePreview.ts +301 -0
- package/Types/StatusPage/SubscriberNotificationTemplateVariables.ts +217 -4
- package/Types/StatusPage/SubscriberUpdateNotification.ts +32 -11
- package/UI/Components/CustomFields/CustomFieldFormFields.ts +317 -0
- package/UI/Components/CustomFields/CustomFieldModelFormFields.tsx +395 -0
- package/UI/Components/CustomFields/CustomFieldsDetail.tsx +95 -55
- package/UI/Components/Forms/ModelForm.tsx +70 -8
- package/UI/Components/Forms/Validation.ts +1 -1
- package/UI/Components/ModelFormModal/ModelFormModal.tsx +2 -4
- package/UI/Components/ModelTable/AnalyticsModelTable.tsx +2 -6
- package/UI/Components/ModelTable/BaseModelTable.tsx +9 -8
- package/UI/Components/ModelTable/CustomFieldColumns.tsx +14 -1
- package/UI/Components/ModelTable/ModelTable.tsx +6 -7
- package/UI/Utils/SensitiveUrlToken.ts +10 -5
- package/Utils/API.ts +247 -2
- package/Utils/Incident/IncidentNoteTemplateVariables.ts +304 -0
- package/Utils/Markdown/MarkdownEscape.ts +65 -0
- package/Utils/ProbeNetworkFailureUtil.ts +673 -0
- package/build/dist/Models/DatabaseModels/Incident.js +267 -1
- package/build/dist/Models/DatabaseModels/Incident.js.map +1 -1
- package/build/dist/Models/DatabaseModels/IncidentCustomField.js +207 -1
- package/build/dist/Models/DatabaseModels/IncidentCustomField.js.map +1 -1
- package/build/dist/Models/DatabaseModels/IncidentEpisode.js +31 -0
- package/build/dist/Models/DatabaseModels/IncidentEpisode.js.map +1 -1
- package/build/dist/Models/DatabaseModels/IncidentTemplate.js +124 -1
- package/build/dist/Models/DatabaseModels/IncidentTemplate.js.map +1 -1
- package/build/dist/Models/DatabaseModels/StatusPage.js +56 -0
- package/build/dist/Models/DatabaseModels/StatusPage.js.map +1 -1
- package/build/dist/Models/DatabaseModels/StatusPageSubscriber.js +131 -0
- package/build/dist/Models/DatabaseModels/StatusPageSubscriber.js.map +1 -1
- package/build/dist/Server/API/IncidentAPI.js +100 -1
- package/build/dist/Server/API/IncidentAPI.js.map +1 -1
- package/build/dist/Server/API/StatusPageAPI.js +417 -176
- package/build/dist/Server/API/StatusPageAPI.js.map +1 -1
- package/build/dist/Server/API/StatusPageSubscriberAPI.js +52 -13
- package/build/dist/Server/API/StatusPageSubscriberAPI.js.map +1 -1
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795300000000-SkipHiddenIncidentCreatedNotifications.js +41 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795300000000-SkipHiddenIncidentCreatedNotifications.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795400000000-AddIncidentStatusPageScope.js +57 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795400000000-AddIncidentStatusPageScope.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795500000000-AddIncidentTemplateStatusPageScopeFlag.js +23 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795500000000-AddIncidentTemplateStatusPageScopeFlag.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795600000000-AddStatusPageSubscriberUnsubscribeToken.js +40 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795600000000-AddStatusPageSubscriberUnsubscribeToken.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795700000000-AddStatusPageSubscriberIsAddedByTeam.js +26 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795700000000-AddStatusPageSubscriberIsAddedByTeam.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795800000000-AddIncidentCustomFieldCreateAndNotificationSettings.js +89 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795800000000-AddIncidentCustomFieldCreateAndNotificationSettings.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795900000000-AddSubscriberNotificationClaimedAt.js +29 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/1795900000000-AddSubscriberNotificationClaimedAt.js.map +1 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/Index.js +14 -0
- package/build/dist/Server/Infrastructure/Postgres/SchemaMigrations/Index.js.map +1 -1
- package/build/dist/Server/Infrastructure/Semaphore.js +3 -0
- package/build/dist/Server/Infrastructure/Semaphore.js.map +1 -1
- package/build/dist/Server/Middleware/IdentityRateLimit.js +89 -3
- package/build/dist/Server/Middleware/IdentityRateLimit.js.map +1 -1
- package/build/dist/Server/Middleware/SubscriberNotificationPreviewRateLimit.js +149 -0
- package/build/dist/Server/Middleware/SubscriberNotificationPreviewRateLimit.js.map +1 -0
- package/build/dist/Server/Middleware/SubscriberNotificationTestSendRateLimit.js +190 -0
- package/build/dist/Server/Middleware/SubscriberNotificationTestSendRateLimit.js.map +1 -0
- package/build/dist/Server/Services/DatabaseService.js +56 -7
- package/build/dist/Server/Services/DatabaseService.js.map +1 -1
- package/build/dist/Server/Services/IncidentCustomFieldService.js +204 -8
- package/build/dist/Server/Services/IncidentCustomFieldService.js.map +1 -1
- package/build/dist/Server/Services/IncidentEpisodePublicNoteService.js +24 -0
- package/build/dist/Server/Services/IncidentEpisodePublicNoteService.js.map +1 -1
- package/build/dist/Server/Services/IncidentEpisodeService.js +14 -0
- package/build/dist/Server/Services/IncidentEpisodeService.js.map +1 -1
- package/build/dist/Server/Services/IncidentEpisodeStateTimelineService.js +26 -0
- package/build/dist/Server/Services/IncidentEpisodeStateTimelineService.js.map +1 -1
- package/build/dist/Server/Services/IncidentPublicNoteService.js +26 -1
- package/build/dist/Server/Services/IncidentPublicNoteService.js.map +1 -1
- package/build/dist/Server/Services/IncidentService.js +1052 -0
- package/build/dist/Server/Services/IncidentService.js.map +1 -1
- package/build/dist/Server/Services/IncidentStateTimelineService.js +12 -0
- package/build/dist/Server/Services/IncidentStateTimelineService.js.map +1 -1
- package/build/dist/Server/Services/IncidentTemplateService.js +83 -0
- package/build/dist/Server/Services/IncidentTemplateService.js.map +1 -1
- package/build/dist/Server/Services/ScheduledMaintenancePublicNoteService.js +26 -1
- package/build/dist/Server/Services/ScheduledMaintenancePublicNoteService.js.map +1 -1
- package/build/dist/Server/Services/ScheduledMaintenanceService.js +47 -17
- package/build/dist/Server/Services/ScheduledMaintenanceService.js.map +1 -1
- package/build/dist/Server/Services/SmsService.js +2 -22
- package/build/dist/Server/Services/SmsService.js.map +1 -1
- package/build/dist/Server/Services/StatusPageService.js +47 -9
- package/build/dist/Server/Services/StatusPageService.js.map +1 -1
- package/build/dist/Server/Services/StatusPageSubscriberNotificationTemplateService.js +237 -32
- package/build/dist/Server/Services/StatusPageSubscriberNotificationTemplateService.js.map +1 -1
- package/build/dist/Server/Services/StatusPageSubscriberNotificationTemplateStatusPageService.js +109 -0
- package/build/dist/Server/Services/StatusPageSubscriberNotificationTemplateStatusPageService.js.map +1 -1
- package/build/dist/Server/Services/StatusPageSubscriberService.js +925 -99
- package/build/dist/Server/Services/StatusPageSubscriberService.js.map +1 -1
- package/build/dist/Server/Types/Markdown.js +110 -6
- package/build/dist/Server/Types/Markdown.js.map +1 -1
- package/build/dist/Server/Types/Workflow/Components/Email.js +55 -6
- package/build/dist/Server/Types/Workflow/Components/Email.js.map +1 -1
- package/build/dist/Server/Utils/CustomField/CustomFieldRename.js +211 -0
- package/build/dist/Server/Utils/CustomField/CustomFieldRename.js.map +1 -0
- package/build/dist/Server/Utils/DataSource/EgressGuard.js +41 -12
- package/build/dist/Server/Utils/DataSource/EgressGuard.js.map +1 -1
- package/build/dist/Server/Utils/Mail/PinnedSmtpSocket.js +101 -0
- package/build/dist/Server/Utils/Mail/PinnedSmtpSocket.js.map +1 -0
- package/build/dist/Server/Utils/Monitor/MonitorCriteriaObservationBuilder.js +9 -0
- package/build/dist/Server/Utils/Monitor/MonitorCriteriaObservationBuilder.js.map +1 -1
- package/build/dist/Server/Utils/SSRFProtection.js +48 -6
- package/build/dist/Server/Utils/SSRFProtection.js.map +1 -1
- package/build/dist/Server/Utils/StatusPage/IncidentStatusPageScope.js +631 -0
- package/build/dist/Server/Utils/StatusPage/IncidentStatusPageScope.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/IncidentSubscriberAudienceBuilder.js +403 -0
- package/build/dist/Server/Utils/StatusPage/IncidentSubscriberAudienceBuilder.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/IncidentTemplateVariableBuilder.js +451 -0
- package/build/dist/Server/Utils/StatusPage/IncidentTemplateVariableBuilder.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageExclusion.js +13 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageExclusion.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageReadAccess.js +91 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageReadAccess.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeNotice.js +101 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeNotice.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeToken.js +47 -0
- package/build/dist/Server/Utils/StatusPage/StatusPageSubscriberUnsubscribeToken.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberIncidentEmailBuilder.js +273 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberIncidentEmailBuilder.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationClaim.js +73 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationClaim.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationDeliveryRecord.js +722 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationDeliveryRecord.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationFanOut.js +102 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationFanOut.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationPreviewBuilder.js +527 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationPreviewBuilder.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationResendAccess.js +278 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationResendAccess.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationRunLimit.js +137 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationRunLimit.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationTiming.js +103 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberNotificationTiming.js.map +1 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberTemplateIncidentRecordAccess.js +114 -0
- package/build/dist/Server/Utils/StatusPage/SubscriberTemplateIncidentRecordAccess.js.map +1 -0
- package/build/dist/Server/Utils/StatusPageResource.js +39 -7
- package/build/dist/Server/Utils/StatusPageResource.js.map +1 -1
- package/build/dist/Server/Utils/VM/VMAPI.js.map +1 -1
- package/build/dist/Server/Utils/VM/VMRunner.js +1 -0
- package/build/dist/Server/Utils/VM/VMRunner.js.map +1 -1
- package/build/dist/Server/Utils/Workflow/OAuth2TokenClient.js +3 -0
- package/build/dist/Server/Utils/Workflow/OAuth2TokenClient.js.map +1 -1
- package/build/dist/Types/CustomField/CustomFieldOrder.js +36 -0
- package/build/dist/Types/CustomField/CustomFieldOrder.js.map +1 -0
- package/build/dist/Types/CustomField/CustomFieldSavedViews.js +135 -0
- package/build/dist/Types/CustomField/CustomFieldSavedViews.js.map +1 -0
- package/build/dist/Types/CustomField/CustomFieldTemplateMerge.js +27 -0
- package/build/dist/Types/CustomField/CustomFieldTemplateMerge.js.map +1 -0
- package/build/dist/Types/CustomField/CustomFieldType.js +12 -0
- package/build/dist/Types/CustomField/CustomFieldType.js.map +1 -1
- package/build/dist/Types/CustomField/CustomFieldValueFormat.js +126 -0
- package/build/dist/Types/CustomField/CustomFieldValueFormat.js.map +1 -0
- package/build/dist/Types/CustomField/CustomFieldValueValidator.js +280 -0
- package/build/dist/Types/CustomField/CustomFieldValueValidator.js.map +1 -0
- package/build/dist/Types/CustomField/CustomFieldVariableKey.js +150 -0
- package/build/dist/Types/CustomField/CustomFieldVariableKey.js.map +1 -0
- package/build/dist/Types/SafeHtml.js +84 -0
- package/build/dist/Types/SafeHtml.js.map +1 -0
- package/build/dist/Types/StatusPage/IncidentCreatedRenotify.js +117 -0
- package/build/dist/Types/StatusPage/IncidentCreatedRenotify.js.map +1 -0
- package/build/dist/Types/StatusPage/IncidentCreatedResend.js +86 -0
- package/build/dist/Types/StatusPage/IncidentCreatedResend.js.map +1 -0
- package/build/dist/Types/StatusPage/IncidentScopeAddedPagesNotification.js +246 -0
- package/build/dist/Types/StatusPage/IncidentScopeAddedPagesNotification.js.map +1 -0
- package/build/dist/Types/StatusPage/IncidentSubscriberAudience.js +183 -0
- package/build/dist/Types/StatusPage/IncidentSubscriberAudience.js.map +1 -0
- package/build/dist/Types/StatusPage/StatusPageSubscriberUnsubscribe.js +277 -0
- package/build/dist/Types/StatusPage/StatusPageSubscriberUnsubscribe.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationInterruption.js +27 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationInterruption.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationPreview.js +190 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationPreview.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationResend.js +102 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationResend.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplateCompiler.js +97 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplateCompiler.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplatePreview.js +175 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplatePreview.js.map +1 -0
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplateVariables.js +144 -4
- package/build/dist/Types/StatusPage/SubscriberNotificationTemplateVariables.js.map +1 -1
- package/build/dist/Types/StatusPage/SubscriberUpdateNotification.js +29 -9
- package/build/dist/Types/StatusPage/SubscriberUpdateNotification.js.map +1 -1
- package/build/dist/UI/Components/CustomFields/CustomFieldFormFields.js +169 -0
- package/build/dist/UI/Components/CustomFields/CustomFieldFormFields.js.map +1 -0
- package/build/dist/UI/Components/CustomFields/CustomFieldModelFormFields.js +212 -0
- package/build/dist/UI/Components/CustomFields/CustomFieldModelFormFields.js.map +1 -0
- package/build/dist/UI/Components/CustomFields/CustomFieldsDetail.js +64 -49
- package/build/dist/UI/Components/CustomFields/CustomFieldsDetail.js.map +1 -1
- package/build/dist/UI/Components/Forms/ModelForm.js +39 -5
- package/build/dist/UI/Components/Forms/ModelForm.js.map +1 -1
- package/build/dist/UI/Components/Forms/Validation.js +1 -1
- package/build/dist/UI/Components/Forms/Validation.js.map +1 -1
- package/build/dist/UI/Components/ModelFormModal/ModelFormModal.js.map +1 -1
- package/build/dist/UI/Components/ModelTable/AnalyticsModelTable.js.map +1 -1
- package/build/dist/UI/Components/ModelTable/BaseModelTable.js +2 -2
- package/build/dist/UI/Components/ModelTable/BaseModelTable.js.map +1 -1
- package/build/dist/UI/Components/ModelTable/CustomFieldColumns.js +13 -1
- package/build/dist/UI/Components/ModelTable/CustomFieldColumns.js.map +1 -1
- package/build/dist/UI/Components/ModelTable/ModelTable.js +1 -1
- package/build/dist/UI/Components/ModelTable/ModelTable.js.map +1 -1
- package/build/dist/UI/Utils/SensitiveUrlToken.js +10 -5
- package/build/dist/UI/Utils/SensitiveUrlToken.js.map +1 -1
- package/build/dist/Utils/API.js +177 -1
- package/build/dist/Utils/API.js.map +1 -1
- package/build/dist/Utils/Incident/IncidentNoteTemplateVariables.js +155 -0
- package/build/dist/Utils/Incident/IncidentNoteTemplateVariables.js.map +1 -0
- package/build/dist/Utils/Markdown/MarkdownEscape.js +48 -0
- package/build/dist/Utils/Markdown/MarkdownEscape.js.map +1 -1
- package/build/dist/Utils/ProbeNetworkFailureUtil.js +460 -0
- package/build/dist/Utils/ProbeNetworkFailureUtil.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import StatusPageSubscriberService from "../../../Server/Services/StatusPageSubscriberService";
|
|
2
|
+
import Dictionary from "../../../Types/Dictionary";
|
|
3
|
+
import ObjectID from "../../../Types/ObjectID";
|
|
4
|
+
import { IncidentSubscriberAudienceCounts } from "../../../Types/StatusPage/IncidentSubscriberAudience";
|
|
5
|
+
import getJestMockFunction, { MockFunction } from "../../MockType";
|
|
6
|
+
import {
|
|
7
|
+
afterEach,
|
|
8
|
+
beforeEach,
|
|
9
|
+
describe,
|
|
10
|
+
expect,
|
|
11
|
+
jest,
|
|
12
|
+
test,
|
|
13
|
+
} from "@jest/globals";
|
|
14
|
+
|
|
15
|
+
/*
|
|
16
|
+
* StatusPageSubscriberService.countActiveSubscribersByChannel: the counts the
|
|
17
|
+
* audience summary shows before an incident or a public note is sent.
|
|
18
|
+
*
|
|
19
|
+
* These tests stub the database driver and pin down the query's contract:
|
|
20
|
+
* it counts (never reads an address), it is pinned to the project, it counts
|
|
21
|
+
* only the subscribers the jobs send to, and it reads the rows back into
|
|
22
|
+
* per-page, per-channel numbers. StatusPageSubscriberAudienceCountsPostgres
|
|
23
|
+
* runs the same query against a real Postgres.
|
|
24
|
+
*/
|
|
25
|
+
|
|
26
|
+
const PROJECT_ID: ObjectID = new ObjectID(
|
|
27
|
+
"10000000-0000-4000-8000-000000000001",
|
|
28
|
+
);
|
|
29
|
+
const PAGE_A: string = "b0000000-0000-4000-8000-00000000000a";
|
|
30
|
+
const PAGE_B: string = "b0000000-0000-4000-8000-00000000000b";
|
|
31
|
+
|
|
32
|
+
let query: MockFunction;
|
|
33
|
+
|
|
34
|
+
beforeEach(() => {
|
|
35
|
+
query = getJestMockFunction();
|
|
36
|
+
query.mockResolvedValue([] as never);
|
|
37
|
+
|
|
38
|
+
jest.spyOn(StatusPageSubscriberService, "getRepository").mockReturnValue({
|
|
39
|
+
manager: {
|
|
40
|
+
query: query,
|
|
41
|
+
},
|
|
42
|
+
} as never);
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
afterEach(() => {
|
|
46
|
+
jest.restoreAllMocks();
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
function sql(): string {
|
|
50
|
+
return (query.mock.calls[0]![0] as string).replace(/\s+/g, " ");
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
function params(): Array<unknown> {
|
|
54
|
+
return query.mock.calls[0]![1] as Array<unknown>;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
describe("StatusPageSubscriberService.countActiveSubscribersByChannel", () => {
|
|
58
|
+
test("no status pages: no query at all", async () => {
|
|
59
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> =
|
|
60
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
61
|
+
projectId: PROJECT_ID,
|
|
62
|
+
statusPageIds: [],
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
expect(counts).toEqual({});
|
|
66
|
+
expect(query).not.toHaveBeenCalled();
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
test("one aggregate query, grouped by status page", async () => {
|
|
70
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
71
|
+
projectId: PROJECT_ID,
|
|
72
|
+
statusPageIds: [new ObjectID(PAGE_A), new ObjectID(PAGE_B)],
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
expect(query).toHaveBeenCalledTimes(1);
|
|
76
|
+
expect(sql()).toContain('FROM "StatusPageSubscriber"');
|
|
77
|
+
expect(sql()).toContain('GROUP BY "statusPageId"');
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
test("it counts and never selects an address", async () => {
|
|
81
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
82
|
+
projectId: PROJECT_ID,
|
|
83
|
+
statusPageIds: [new ObjectID(PAGE_A)],
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
// Everything between SELECT and FROM is the statusPageId and counts.
|
|
87
|
+
const selected: string = sql().split(" FROM ")[0]!;
|
|
88
|
+
const columns: Array<string> = selected
|
|
89
|
+
.replace(/^ ?SELECT /, "")
|
|
90
|
+
.split(/,(?![^(]*\))/)
|
|
91
|
+
.map((column: string): string => {
|
|
92
|
+
return column.trim();
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
expect(columns).toHaveLength(6);
|
|
96
|
+
expect(columns[0]).toBe('"statusPageId"::text AS "statusPageId"');
|
|
97
|
+
|
|
98
|
+
for (const column of columns.slice(1)) {
|
|
99
|
+
expect(column).toMatch(
|
|
100
|
+
/^COUNT\(\*\) FILTER \(WHERE .+\)::text AS "\w+"$/,
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
test("only the subscribers the jobs send to: confirmed, subscribed, not deleted", async () => {
|
|
106
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
107
|
+
projectId: PROJECT_ID,
|
|
108
|
+
statusPageIds: [new ObjectID(PAGE_A)],
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
expect(sql()).toContain('"isUnsubscribed" = false');
|
|
112
|
+
expect(sql()).toContain('"isSubscriptionConfirmed" = true');
|
|
113
|
+
expect(sql()).toContain('"deletedAt" IS NULL');
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
test("pinned to the project, with the page ids as a bound parameter", async () => {
|
|
117
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
118
|
+
projectId: PROJECT_ID,
|
|
119
|
+
statusPageIds: [
|
|
120
|
+
new ObjectID(PAGE_A.toUpperCase()),
|
|
121
|
+
new ObjectID(PAGE_A),
|
|
122
|
+
new ObjectID(PAGE_B),
|
|
123
|
+
],
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
expect(sql()).toContain('"projectId" = $1');
|
|
127
|
+
expect(sql()).toContain('"statusPageId" = ANY($2::uuid[])');
|
|
128
|
+
expect(params()).toEqual([PROJECT_ID.toString(), [PAGE_A, PAGE_B]]);
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
test("reads the rows back as numbers, keyed by the lower-cased page id", async () => {
|
|
132
|
+
query.mockResolvedValue([
|
|
133
|
+
{
|
|
134
|
+
statusPageId: PAGE_A.toUpperCase(),
|
|
135
|
+
email: "41",
|
|
136
|
+
sms: "3",
|
|
137
|
+
slack: "0",
|
|
138
|
+
microsoftTeams: "1",
|
|
139
|
+
webhook: "2",
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
statusPageId: PAGE_B,
|
|
143
|
+
email: "18",
|
|
144
|
+
sms: "0",
|
|
145
|
+
slack: "0",
|
|
146
|
+
microsoftTeams: "0",
|
|
147
|
+
webhook: "0",
|
|
148
|
+
},
|
|
149
|
+
] as never);
|
|
150
|
+
|
|
151
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> =
|
|
152
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
153
|
+
projectId: PROJECT_ID,
|
|
154
|
+
statusPageIds: [new ObjectID(PAGE_A), new ObjectID(PAGE_B)],
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
expect(counts).toEqual({
|
|
158
|
+
[PAGE_A]: {
|
|
159
|
+
email: 41,
|
|
160
|
+
sms: 3,
|
|
161
|
+
slack: 0,
|
|
162
|
+
microsoftTeams: 1,
|
|
163
|
+
webhook: 2,
|
|
164
|
+
},
|
|
165
|
+
[PAGE_B]: {
|
|
166
|
+
email: 18,
|
|
167
|
+
sms: 0,
|
|
168
|
+
slack: 0,
|
|
169
|
+
microsoftTeams: 0,
|
|
170
|
+
webhook: 0,
|
|
171
|
+
},
|
|
172
|
+
});
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
test("a garbled count reads as zero", async () => {
|
|
176
|
+
query.mockResolvedValue([
|
|
177
|
+
{
|
|
178
|
+
statusPageId: PAGE_A,
|
|
179
|
+
email: "abc",
|
|
180
|
+
sms: null,
|
|
181
|
+
slack: "-2",
|
|
182
|
+
microsoftTeams: undefined,
|
|
183
|
+
webhook: "7",
|
|
184
|
+
},
|
|
185
|
+
] as never);
|
|
186
|
+
|
|
187
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> =
|
|
188
|
+
await StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
189
|
+
projectId: PROJECT_ID,
|
|
190
|
+
statusPageIds: [new ObjectID(PAGE_A)],
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
expect(counts[PAGE_A]).toEqual({
|
|
194
|
+
email: 0,
|
|
195
|
+
sms: 0,
|
|
196
|
+
slack: 0,
|
|
197
|
+
microsoftTeams: 0,
|
|
198
|
+
webhook: 7,
|
|
199
|
+
});
|
|
200
|
+
});
|
|
201
|
+
});
|
|
@@ -0,0 +1,271 @@
|
|
|
1
|
+
import Entities from "../../../Models/DatabaseModels/Index";
|
|
2
|
+
import PostgresAppInstance from "../../../Server/Infrastructure/PostgresDatabase";
|
|
3
|
+
import StatusPageSubscriberService from "../../../Server/Services/StatusPageSubscriberService";
|
|
4
|
+
import Dictionary from "../../../Types/Dictionary";
|
|
5
|
+
import ObjectID from "../../../Types/ObjectID";
|
|
6
|
+
import { IncidentSubscriberAudienceCounts } from "../../../Types/StatusPage/IncidentSubscriberAudience";
|
|
7
|
+
import { DataSource } from "typeorm";
|
|
8
|
+
|
|
9
|
+
/*
|
|
10
|
+
* StatusPageSubscriberService.countActiveSubscribersByChannel against a
|
|
11
|
+
* migrated Postgres: the per-page, per-channel counts the audience summary
|
|
12
|
+
* shows before an incident or a public note is sent.
|
|
13
|
+
*
|
|
14
|
+
* Opt in with RUN_POSTGRES_SUBSCRIBER_AUDIENCE_COUNT_TESTS=true against a
|
|
15
|
+
* database the registered migrations have been applied to, e.g.
|
|
16
|
+
*
|
|
17
|
+
* RUN_POSTGRES_SUBSCRIBER_AUDIENCE_COUNT_TESTS=true \
|
|
18
|
+
* SUBSCRIBER_AUDIENCE_COUNT_TEST_DATABASE_HOST=127.0.0.1 \
|
|
19
|
+
* SUBSCRIBER_AUDIENCE_COUNT_TEST_DATABASE_PORT=5400 \
|
|
20
|
+
* DATABASE_PASSWORD=... npx jest Tests/Server/Services/StatusPageSubscriberAudienceCountsPostgres.test.ts
|
|
21
|
+
*
|
|
22
|
+
* CI runs it in .github/workflows/postgres-schema-drift.yaml, right after that
|
|
23
|
+
* job has applied every registered migration to an empty database.
|
|
24
|
+
*
|
|
25
|
+
* The query is hand-written SQL (COUNT(*) FILTER ..., = ANY($2::uuid[])), so
|
|
26
|
+
* only a real driver can judge it. It runs against a structure-only clone of
|
|
27
|
+
* the migrated StatusPageSubscriber table (LIKE ... INCLUDING ALL) in a
|
|
28
|
+
* uniquely named schema that is dropped afterwards; every row is synthetic.
|
|
29
|
+
*/
|
|
30
|
+
const describePostgres: typeof describe =
|
|
31
|
+
process.env["RUN_POSTGRES_SUBSCRIBER_AUDIENCE_COUNT_TESTS"] === "true"
|
|
32
|
+
? describe
|
|
33
|
+
: describe.skip;
|
|
34
|
+
|
|
35
|
+
describePostgres("subscriber audience counts against Postgres", () => {
|
|
36
|
+
const schema: string = `subscriber_audience_${ObjectID.generate()
|
|
37
|
+
.toString()
|
|
38
|
+
.replace(/-/g, "")}`;
|
|
39
|
+
|
|
40
|
+
const projectId: ObjectID = ObjectID.generate();
|
|
41
|
+
const otherProjectId: ObjectID = ObjectID.generate();
|
|
42
|
+
const pageA: ObjectID = ObjectID.generate();
|
|
43
|
+
const pageB: ObjectID = ObjectID.generate();
|
|
44
|
+
const pageC: ObjectID = ObjectID.generate();
|
|
45
|
+
|
|
46
|
+
let database: DataSource;
|
|
47
|
+
|
|
48
|
+
interface SubscriberRow {
|
|
49
|
+
projectId?: ObjectID;
|
|
50
|
+
statusPageId: ObjectID;
|
|
51
|
+
email?: string | null;
|
|
52
|
+
phone?: string | null;
|
|
53
|
+
webhook?: string | null;
|
|
54
|
+
slack?: string | null;
|
|
55
|
+
teams?: string | null;
|
|
56
|
+
isUnsubscribed?: boolean;
|
|
57
|
+
isSubscriptionConfirmed?: boolean;
|
|
58
|
+
isDeleted?: boolean;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
async function seed(row: SubscriberRow): Promise<void> {
|
|
62
|
+
await database.query(
|
|
63
|
+
`INSERT INTO "${schema}"."StatusPageSubscriber"
|
|
64
|
+
("_id", "projectId", "statusPageId", "subscriberEmail", "subscriberPhone",
|
|
65
|
+
"subscriberWebhook", "slackIncomingWebhookUrl", "microsoftTeamsIncomingWebhookUrl",
|
|
66
|
+
"isUnsubscribed", "isSubscriptionConfirmed", "deletedAt", "version")
|
|
67
|
+
VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, 1)`,
|
|
68
|
+
[
|
|
69
|
+
ObjectID.generate().toString(),
|
|
70
|
+
(row.projectId || projectId).toString(),
|
|
71
|
+
row.statusPageId.toString(),
|
|
72
|
+
row.email ?? null,
|
|
73
|
+
row.phone ?? null,
|
|
74
|
+
row.webhook ?? null,
|
|
75
|
+
row.slack ?? null,
|
|
76
|
+
row.teams ?? null,
|
|
77
|
+
row.isUnsubscribed ?? false,
|
|
78
|
+
row.isSubscriptionConfirmed ?? true,
|
|
79
|
+
row.isDeleted ? new Date() : null,
|
|
80
|
+
],
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function countFor(
|
|
85
|
+
statusPageIds: Array<ObjectID>,
|
|
86
|
+
forProjectId: ObjectID = projectId,
|
|
87
|
+
): Promise<Dictionary<IncidentSubscriberAudienceCounts>> {
|
|
88
|
+
return StatusPageSubscriberService.countActiveSubscribersByChannel({
|
|
89
|
+
projectId: forProjectId,
|
|
90
|
+
statusPageIds: statusPageIds,
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
beforeAll(async () => {
|
|
95
|
+
database = new DataSource({
|
|
96
|
+
type: "postgres",
|
|
97
|
+
host:
|
|
98
|
+
process.env["SUBSCRIBER_AUDIENCE_COUNT_TEST_DATABASE_HOST"] ||
|
|
99
|
+
"localhost",
|
|
100
|
+
port: Number(
|
|
101
|
+
process.env["SUBSCRIBER_AUDIENCE_COUNT_TEST_DATABASE_PORT"] || "5400",
|
|
102
|
+
),
|
|
103
|
+
username: process.env["DATABASE_USERNAME"] || "postgres",
|
|
104
|
+
password: process.env["DATABASE_PASSWORD"] || "password",
|
|
105
|
+
database:
|
|
106
|
+
process.env["SUBSCRIBER_AUDIENCE_COUNT_TEST_DATABASE_NAME"] ||
|
|
107
|
+
process.env["DATABASE_NAME"] ||
|
|
108
|
+
"oneuptimedb",
|
|
109
|
+
entities: Entities,
|
|
110
|
+
schema,
|
|
111
|
+
synchronize: false,
|
|
112
|
+
extra: { options: `-c search_path=${schema},public` },
|
|
113
|
+
});
|
|
114
|
+
await database.initialize();
|
|
115
|
+
await database.query(`CREATE SCHEMA "${schema}"`);
|
|
116
|
+
await database.query(
|
|
117
|
+
`CREATE TABLE "${schema}"."StatusPageSubscriber" (LIKE public."StatusPageSubscriber" INCLUDING ALL)`,
|
|
118
|
+
);
|
|
119
|
+
|
|
120
|
+
jest.spyOn(PostgresAppInstance, "isConnected").mockReturnValue(true);
|
|
121
|
+
jest.spyOn(PostgresAppInstance, "getDataSource").mockReturnValue(database);
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
beforeEach(async () => {
|
|
125
|
+
await database.query(`DELETE FROM "${schema}"."StatusPageSubscriber"`);
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
afterAll(async () => {
|
|
129
|
+
jest.restoreAllMocks();
|
|
130
|
+
if (database?.isInitialized) {
|
|
131
|
+
await database.query(`DROP SCHEMA IF EXISTS "${schema}" CASCADE`);
|
|
132
|
+
await database.destroy();
|
|
133
|
+
}
|
|
134
|
+
});
|
|
135
|
+
|
|
136
|
+
test("the harness reads the clone, not public", async () => {
|
|
137
|
+
await seed({ statusPageId: pageA, email: "a@example.com" });
|
|
138
|
+
|
|
139
|
+
const rows: Array<{ count: string }> = await database.query(
|
|
140
|
+
`SELECT COUNT(*)::text AS "count" FROM "StatusPageSubscriber" WHERE "statusPageId" = $1`,
|
|
141
|
+
[pageA.toString()],
|
|
142
|
+
);
|
|
143
|
+
|
|
144
|
+
expect(rows[0]!.count).toBe("1");
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
test("counts each channel of each page", async () => {
|
|
148
|
+
await seed({ statusPageId: pageA, email: "one@example.com" });
|
|
149
|
+
await seed({ statusPageId: pageA, email: "two@example.com" });
|
|
150
|
+
await seed({
|
|
151
|
+
statusPageId: pageA,
|
|
152
|
+
email: "three@example.com",
|
|
153
|
+
phone: "+15550100",
|
|
154
|
+
});
|
|
155
|
+
await seed({ statusPageId: pageA, phone: "+15550101" });
|
|
156
|
+
await seed({ statusPageId: pageA, webhook: "https://hooks.example.com/1" });
|
|
157
|
+
await seed({
|
|
158
|
+
statusPageId: pageA,
|
|
159
|
+
slack: "https://hooks.slack.com/services/T/B/x",
|
|
160
|
+
});
|
|
161
|
+
await seed({
|
|
162
|
+
statusPageId: pageB,
|
|
163
|
+
teams: "https://example.webhook.office.com/x",
|
|
164
|
+
});
|
|
165
|
+
await seed({ statusPageId: pageB, email: "four@example.com" });
|
|
166
|
+
|
|
167
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> = await countFor(
|
|
168
|
+
[pageA, pageB],
|
|
169
|
+
);
|
|
170
|
+
|
|
171
|
+
expect(counts).toEqual({
|
|
172
|
+
[pageA.toString().toLowerCase()]: {
|
|
173
|
+
email: 3,
|
|
174
|
+
sms: 2,
|
|
175
|
+
slack: 1,
|
|
176
|
+
microsoftTeams: 0,
|
|
177
|
+
webhook: 1,
|
|
178
|
+
},
|
|
179
|
+
[pageB.toString().toLowerCase()]: {
|
|
180
|
+
email: 1,
|
|
181
|
+
sms: 0,
|
|
182
|
+
slack: 0,
|
|
183
|
+
microsoftTeams: 1,
|
|
184
|
+
webhook: 0,
|
|
185
|
+
},
|
|
186
|
+
});
|
|
187
|
+
});
|
|
188
|
+
|
|
189
|
+
test("only confirmed, still-subscribed, not deleted subscribers count", async () => {
|
|
190
|
+
await seed({ statusPageId: pageA, email: "counted@example.com" });
|
|
191
|
+
await seed({
|
|
192
|
+
statusPageId: pageA,
|
|
193
|
+
email: "unsubscribed@example.com",
|
|
194
|
+
isUnsubscribed: true,
|
|
195
|
+
});
|
|
196
|
+
await seed({
|
|
197
|
+
statusPageId: pageA,
|
|
198
|
+
email: "unconfirmed@example.com",
|
|
199
|
+
isSubscriptionConfirmed: false,
|
|
200
|
+
});
|
|
201
|
+
await seed({
|
|
202
|
+
statusPageId: pageA,
|
|
203
|
+
email: "deleted@example.com",
|
|
204
|
+
isDeleted: true,
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> = await countFor(
|
|
208
|
+
[pageA],
|
|
209
|
+
);
|
|
210
|
+
|
|
211
|
+
expect(counts[pageA.toString().toLowerCase()]!.email).toBe(1);
|
|
212
|
+
});
|
|
213
|
+
|
|
214
|
+
test("an empty or blank value is no channel", async () => {
|
|
215
|
+
await seed({ statusPageId: pageA, email: "", phone: " " });
|
|
216
|
+
await seed({ statusPageId: pageA, webhook: "https://hooks.example.com/1" });
|
|
217
|
+
|
|
218
|
+
const counts: Dictionary<IncidentSubscriberAudienceCounts> = await countFor(
|
|
219
|
+
[pageA],
|
|
220
|
+
);
|
|
221
|
+
|
|
222
|
+
expect(counts[pageA.toString().toLowerCase()]).toEqual({
|
|
223
|
+
email: 0,
|
|
224
|
+
sms: 0,
|
|
225
|
+
slack: 0,
|
|
226
|
+
microsoftTeams: 0,
|
|
227
|
+
webhook: 1,
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
test("only the pages asked about, and only in the project asked about", async () => {
|
|
232
|
+
await seed({ statusPageId: pageA, email: "a@example.com" });
|
|
233
|
+
await seed({ statusPageId: pageC, email: "c@example.com" });
|
|
234
|
+
// Another project's subscriber on the same page id is never counted.
|
|
235
|
+
await seed({
|
|
236
|
+
projectId: otherProjectId,
|
|
237
|
+
statusPageId: pageA,
|
|
238
|
+
email: "theirs@example.com",
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
expect(await countFor([pageA])).toEqual({
|
|
242
|
+
[pageA.toString().toLowerCase()]: {
|
|
243
|
+
email: 1,
|
|
244
|
+
sms: 0,
|
|
245
|
+
slack: 0,
|
|
246
|
+
microsoftTeams: 0,
|
|
247
|
+
webhook: 0,
|
|
248
|
+
},
|
|
249
|
+
});
|
|
250
|
+
|
|
251
|
+
expect(await countFor([pageA], otherProjectId)).toEqual({
|
|
252
|
+
[pageA.toString().toLowerCase()]: {
|
|
253
|
+
email: 1,
|
|
254
|
+
sms: 0,
|
|
255
|
+
slack: 0,
|
|
256
|
+
microsoftTeams: 0,
|
|
257
|
+
webhook: 0,
|
|
258
|
+
},
|
|
259
|
+
});
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
test("a page with no active subscriber has no entry", async () => {
|
|
263
|
+
await seed({
|
|
264
|
+
statusPageId: pageB,
|
|
265
|
+
email: "gone@example.com",
|
|
266
|
+
isUnsubscribed: true,
|
|
267
|
+
});
|
|
268
|
+
|
|
269
|
+
expect(await countFor([pageA, pageB])).toEqual({});
|
|
270
|
+
});
|
|
271
|
+
});
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
import ProjectSmtpConfig from "../../../Models/DatabaseModels/ProjectSmtpConfig";
|
|
2
|
+
import StatusPage from "../../../Models/DatabaseModels/StatusPage";
|
|
3
|
+
import StatusPageSubscriber from "../../../Models/DatabaseModels/StatusPageSubscriber";
|
|
4
|
+
import StatusPageSubscriberNotificationTemplate from "../../../Models/DatabaseModels/StatusPageSubscriberNotificationTemplate";
|
|
5
|
+
import DatabaseConfig from "../../../Server/DatabaseConfig";
|
|
6
|
+
import MailService from "../../../Server/Services/MailService";
|
|
7
|
+
import ProjectSmtpConfigService from "../../../Server/Services/ProjectSmtpConfigService";
|
|
8
|
+
import StatusPageService from "../../../Server/Services/StatusPageService";
|
|
9
|
+
import StatusPageSubscriberNotificationTemplateService, {
|
|
10
|
+
Service as StatusPageSubscriberNotificationTemplateServiceClass,
|
|
11
|
+
} from "../../../Server/Services/StatusPageSubscriberNotificationTemplateService";
|
|
12
|
+
import StatusPageSubscriberService from "../../../Server/Services/StatusPageSubscriberService";
|
|
13
|
+
import Hostname from "../../../Types/API/Hostname";
|
|
14
|
+
import HTTPResponse from "../../../Types/API/HTTPResponse";
|
|
15
|
+
import Protocol from "../../../Types/API/Protocol";
|
|
16
|
+
import Email from "../../../Types/Email";
|
|
17
|
+
import EmailTemplateType from "../../../Types/Email/EmailTemplateType";
|
|
18
|
+
import { JSONObject } from "../../../Types/JSON";
|
|
19
|
+
import ObjectID from "../../../Types/ObjectID";
|
|
20
|
+
import StatusPageSubscriberNotificationEventType from "../../../Types/StatusPage/StatusPageSubscriberNotificationEventType";
|
|
21
|
+
import StatusPageSubscriberNotificationMethod from "../../../Types/StatusPage/StatusPageSubscriberNotificationMethod";
|
|
22
|
+
import {
|
|
23
|
+
afterEach,
|
|
24
|
+
beforeEach,
|
|
25
|
+
describe,
|
|
26
|
+
expect,
|
|
27
|
+
jest,
|
|
28
|
+
test,
|
|
29
|
+
} from "@jest/globals";
|
|
30
|
+
|
|
31
|
+
/*
|
|
32
|
+
* The subscription confirmation and "you have subscribed" emails can use a
|
|
33
|
+
* status page's custom email template. Its body is HTML, so the status
|
|
34
|
+
* page's name - which a project member typed - and the links are escaped
|
|
35
|
+
* into it; the subject is plain text and keeps them as written.
|
|
36
|
+
*/
|
|
37
|
+
|
|
38
|
+
const PROJECT_ID: ObjectID = new ObjectID(
|
|
39
|
+
"10000000-0000-4000-8000-000000000001",
|
|
40
|
+
);
|
|
41
|
+
const STATUS_PAGE_ID: ObjectID = new ObjectID(
|
|
42
|
+
"20000000-0000-4000-8000-000000000002",
|
|
43
|
+
);
|
|
44
|
+
const SUBSCRIBER_ID: ObjectID = new ObjectID(
|
|
45
|
+
"30000000-0000-4000-8000-000000000003",
|
|
46
|
+
);
|
|
47
|
+
|
|
48
|
+
const STATUS_PAGE_URL: string = "https://status.acme.com";
|
|
49
|
+
const HOSTILE_PAGE_NAME: string =
|
|
50
|
+
'<a href="https://evil.example/login">Acme</a> & "Status"';
|
|
51
|
+
const HOSTILE_PAGE_NAME_HTML: string =
|
|
52
|
+
"<a href="https://evil.example/login">Acme</a> & "Status"";
|
|
53
|
+
|
|
54
|
+
const BODY: string =
|
|
55
|
+
'<h1>{{statusPageName}}</h1><a href="{{statusPageUrl}}">Open</a>';
|
|
56
|
+
const SUBJECT: string = "Welcome to {{statusPageName}}";
|
|
57
|
+
|
|
58
|
+
function mock(fn: unknown): jest.Mock {
|
|
59
|
+
return fn as unknown as jest.Mock;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
function subscriber(): StatusPageSubscriber {
|
|
63
|
+
const row: StatusPageSubscriber = new StatusPageSubscriber();
|
|
64
|
+
row._id = SUBSCRIBER_ID.toString();
|
|
65
|
+
row.statusPageId = STATUS_PAGE_ID;
|
|
66
|
+
row.projectId = PROJECT_ID;
|
|
67
|
+
row.subscriberEmail = new Email("subscriber@example.com");
|
|
68
|
+
row.subscriptionConfirmationToken = "123456";
|
|
69
|
+
row.unsubscribeToken = "a".repeat(64);
|
|
70
|
+
return row;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function statusPage(): StatusPage {
|
|
74
|
+
const page: StatusPage = new StatusPage();
|
|
75
|
+
page._id = STATUS_PAGE_ID.toString();
|
|
76
|
+
page.projectId = PROJECT_ID;
|
|
77
|
+
page.name = "acme-internal";
|
|
78
|
+
page.pageTitle = HOSTILE_PAGE_NAME;
|
|
79
|
+
page.isPublicStatusPage = true;
|
|
80
|
+
const smtpConfig: ProjectSmtpConfig = new ProjectSmtpConfig();
|
|
81
|
+
smtpConfig._id = "50000000-0000-4000-8000-000000000005";
|
|
82
|
+
page.smtpConfig = smtpConfig;
|
|
83
|
+
return page;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
function sentMail(): Array<{
|
|
87
|
+
templateType: EmailTemplateType;
|
|
88
|
+
subject: string;
|
|
89
|
+
vars: JSONObject;
|
|
90
|
+
}> {
|
|
91
|
+
return mock(MailService.sendMail).mock.calls.map((call: Array<unknown>) => {
|
|
92
|
+
return call[0] as {
|
|
93
|
+
templateType: EmailTemplateType;
|
|
94
|
+
subject: string;
|
|
95
|
+
vars: JSONObject;
|
|
96
|
+
};
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
describe("status page subscription emails with a custom email template", () => {
|
|
101
|
+
beforeEach(() => {
|
|
102
|
+
jest
|
|
103
|
+
.spyOn(StatusPageSubscriberService, "findOneBy")
|
|
104
|
+
.mockResolvedValue(subscriber());
|
|
105
|
+
jest.spyOn(StatusPageService, "findOneBy").mockResolvedValue(statusPage());
|
|
106
|
+
jest
|
|
107
|
+
.spyOn(StatusPageService, "getStatusPageURL")
|
|
108
|
+
.mockResolvedValue(STATUS_PAGE_URL);
|
|
109
|
+
jest
|
|
110
|
+
.spyOn(DatabaseConfig, "getHost")
|
|
111
|
+
.mockResolvedValue(new Hostname("oneuptime.com"));
|
|
112
|
+
jest
|
|
113
|
+
.spyOn(DatabaseConfig, "getHttpProtocol")
|
|
114
|
+
.mockResolvedValue(Protocol.HTTPS);
|
|
115
|
+
jest
|
|
116
|
+
.spyOn(ProjectSmtpConfigService, "toEmailServer")
|
|
117
|
+
.mockReturnValue(undefined);
|
|
118
|
+
jest
|
|
119
|
+
.spyOn(MailService, "sendMail")
|
|
120
|
+
.mockResolvedValue(new HTTPResponse<JSONObject>(200, {}, {}));
|
|
121
|
+
jest
|
|
122
|
+
.spyOn(
|
|
123
|
+
StatusPageSubscriberNotificationTemplateService,
|
|
124
|
+
"getTemplateForStatusPage",
|
|
125
|
+
)
|
|
126
|
+
.mockImplementation(
|
|
127
|
+
async (data: {
|
|
128
|
+
eventType: StatusPageSubscriberNotificationEventType;
|
|
129
|
+
notificationMethod: StatusPageSubscriberNotificationMethod;
|
|
130
|
+
}): Promise<StatusPageSubscriberNotificationTemplate | null> => {
|
|
131
|
+
const template: StatusPageSubscriberNotificationTemplate =
|
|
132
|
+
new StatusPageSubscriberNotificationTemplate();
|
|
133
|
+
template.eventType = data.eventType;
|
|
134
|
+
template.notificationMethod = data.notificationMethod;
|
|
135
|
+
template.templateBody = BODY;
|
|
136
|
+
template.emailSubject = SUBJECT;
|
|
137
|
+
return template;
|
|
138
|
+
},
|
|
139
|
+
);
|
|
140
|
+
jest.spyOn(
|
|
141
|
+
StatusPageSubscriberNotificationTemplateServiceClass,
|
|
142
|
+
"compileEmailBodyTemplate",
|
|
143
|
+
);
|
|
144
|
+
jest.spyOn(
|
|
145
|
+
StatusPageSubscriberNotificationTemplateServiceClass,
|
|
146
|
+
"compileTemplate",
|
|
147
|
+
);
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
afterEach(() => {
|
|
151
|
+
jest.restoreAllMocks();
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
test.each([
|
|
155
|
+
{
|
|
156
|
+
name: "the confirmation email",
|
|
157
|
+
send: (): Promise<void> => {
|
|
158
|
+
return StatusPageSubscriberService.sendConfirmSubscriptionEmail({
|
|
159
|
+
subscriberId: SUBSCRIBER_ID,
|
|
160
|
+
});
|
|
161
|
+
},
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
name: "the you-have-subscribed email",
|
|
165
|
+
send: (): Promise<void> => {
|
|
166
|
+
return StatusPageSubscriberService.sendYouHaveSubscribedEmail({
|
|
167
|
+
subscriberId: SUBSCRIBER_ID,
|
|
168
|
+
});
|
|
169
|
+
},
|
|
170
|
+
},
|
|
171
|
+
])(
|
|
172
|
+
"$name escapes the page name in the body and keeps it as written in the subject",
|
|
173
|
+
async ({ send }: { send: () => Promise<void> }) => {
|
|
174
|
+
await send();
|
|
175
|
+
|
|
176
|
+
expect(sentMail()).toHaveLength(1);
|
|
177
|
+
expect(sentMail()[0]!.templateType).toBe(EmailTemplateType.BlankTemplate);
|
|
178
|
+
expect(sentMail()[0]!.vars["body"]).toBe(
|
|
179
|
+
`<h1>${HOSTILE_PAGE_NAME_HTML}</h1><a href="${STATUS_PAGE_URL}">Open</a>`,
|
|
180
|
+
);
|
|
181
|
+
expect(sentMail()[0]!.subject).toBe(`Welcome to ${HOSTILE_PAGE_NAME}`);
|
|
182
|
+
|
|
183
|
+
// The body went through the HTML compile, the subject through the text one.
|
|
184
|
+
expect(
|
|
185
|
+
mock(
|
|
186
|
+
StatusPageSubscriberNotificationTemplateServiceClass.compileEmailBodyTemplate,
|
|
187
|
+
).mock.calls.map((call: Array<unknown>): unknown => {
|
|
188
|
+
return call[0];
|
|
189
|
+
}),
|
|
190
|
+
).toEqual([BODY]);
|
|
191
|
+
expect(
|
|
192
|
+
mock(
|
|
193
|
+
StatusPageSubscriberNotificationTemplateServiceClass.compileTemplate,
|
|
194
|
+
).mock.calls.map((call: Array<unknown>): unknown => {
|
|
195
|
+
return call[0];
|
|
196
|
+
}),
|
|
197
|
+
).toEqual([SUBJECT]);
|
|
198
|
+
},
|
|
199
|
+
);
|
|
200
|
+
});
|