From c171008229f9ebb20d6ad10505c83228c24389e5 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Fri, 25 Sep 2026 09:59:13 +0000 Subject: [PATCH 01/26] docs: wireframes and plan for buying a badge in the app; ios, android: align the badge screens (#7572) --- ...View.swift => BadgesChooseBadgeView.swift} | 24 +- ...sPayView.swift => BadgesHowLongView.swift} | 21 +- .../Badges/BadgesSupportSimplexView.swift | 2 +- apps/ios/SimpleX.xcodeproj/project.pbxproj | 16 +- ...rLevelView.kt => BadgesChooseBadgeView.kt} | 20 +- ...{BadgesPayView.kt => BadgesHowLongView.kt} | 16 +- .../views/badges/BadgesSupportSimplexView.kt | 2 +- .../commonMain/resources/MR/base/strings.xml | 8 +- plans/2026-09-24-badge-buy-in-browser.md | 114 + ...026-09-23-badge-in-app-checkout.excalidraw | 9352 +++++++++++++++++ 10 files changed, 9528 insertions(+), 47 deletions(-) rename apps/ios/Shared/Views/Badges/{BadgesYourLevelView.swift => BadgesChooseBadgeView.swift} (88%) rename apps/ios/Shared/Views/Badges/{BadgesPayView.swift => BadgesHowLongView.swift} (95%) rename apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/{BadgesYourLevelView.kt => BadgesChooseBadgeView.kt} (90%) rename apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/{BadgesPayView.kt => BadgesHowLongView.kt} (97%) create mode 100644 plans/2026-09-24-badge-buy-in-browser.md create mode 100644 plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw diff --git a/apps/ios/Shared/Views/Badges/BadgesYourLevelView.swift b/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift similarity index 88% rename from apps/ios/Shared/Views/Badges/BadgesYourLevelView.swift rename to apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift index d47bcaa0a7..077c9e5810 100644 --- a/apps/ios/Shared/Views/Badges/BadgesYourLevelView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift @@ -1,5 +1,5 @@ // -// BadgesYourLevelView.swift +// BadgesChooseBadgeView.swift // SimpleX (iOS) // // Created by spaced4ndy on 28.07.2026. @@ -30,10 +30,10 @@ enum BadgeLevel: String, CaseIterable, Identifiable { } } - var tagline: LocalizedStringKey { + var summary: LocalizedStringKey { switch self { - case .supporter: "Optional profile badge\nand 2GB files" - case .legend: "Optional profile badge\nand 5GB files" + case .supporter: "Supporter: 2 GB files available for 7 days." + case .legend: "Legend: 5 GB files available for 21 days." } } @@ -45,7 +45,7 @@ enum BadgeLevel: String, CaseIterable, Identifiable { } } -struct BadgesYourLevelView: View { +struct BadgesChooseBadgeView: View { @EnvironmentObject var theme: AppTheme @ObservedObject private var store = BadgeStore.shared @State private var selectedLevel: BadgeLevel = .supporter @@ -56,13 +56,19 @@ struct BadgesYourLevelView: View { GeometryReader { g in ScrollView { VStack(alignment: .center, spacing: 16) { - Text("Your level") + Text("Choose your badge") .font(.largeTitle) .bold() .foregroundColor(theme.colors.primary) .multilineTextAlignment(.center) .fixedSize(horizontal: false, vertical: true) + Text("Larger files that stay available longer.") + .font(.body) + .foregroundColor(theme.colors.secondary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + BadgeUserPreview(level: selectedLevel) { Image(systemName: "chevron.down") .font(.body) @@ -145,7 +151,7 @@ struct BadgesYourLevelView: View { .buttonStyle(OnboardingButtonStyle(isDisabled: false)) NavigationLink(isActive: $continueActive) { - BadgesPayView(level: selectedLevel) + BadgesHowLongView(level: selectedLevel) .modifier(ThemedBackground()) } label: { EmptyView() @@ -179,10 +185,10 @@ struct BadgesYourLevelView: View { } } -struct BadgesYourLevelView_Previews: PreviewProvider { +struct BadgesChooseBadgeView_Previews: PreviewProvider { static var previews: some View { NavigationView { - BadgesYourLevelView() + BadgesChooseBadgeView() } } } diff --git a/apps/ios/Shared/Views/Badges/BadgesPayView.swift b/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift similarity index 95% rename from apps/ios/Shared/Views/Badges/BadgesPayView.swift rename to apps/ios/Shared/Views/Badges/BadgesHowLongView.swift index 707bdb3059..d2783383de 100644 --- a/apps/ios/Shared/Views/Badges/BadgesPayView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift @@ -1,5 +1,5 @@ // -// BadgesPayView.swift +// BadgesHowLongView.swift // SimpleX (iOS) // // Created by spaced4ndy on 28.07.2026. @@ -60,7 +60,7 @@ enum BadgePeriod: String, CaseIterable, Identifiable { } } -struct BadgesPayView: View { +struct BadgesHowLongView: View { @EnvironmentObject var theme: AppTheme @ObservedObject private var store = BadgeStore.shared let level: BadgeLevel @@ -73,21 +73,20 @@ struct BadgesPayView: View { GeometryReader { g in ScrollView { VStack(alignment: .center, spacing: 16) { - Text(level.title) + Text("How long?") .font(.largeTitle) .bold() .foregroundColor(theme.colors.primary) .multilineTextAlignment(.center) .fixedSize(horizontal: false, vertical: true) - BadgeUserPreview(level: level) - .padding(.top, 4) - - Text(level.tagline) + Text(level.summary) .font(.body) - .foregroundColor(theme.colors.onBackground) + .foregroundColor(theme.colors.secondary) .multilineTextAlignment(.center) .fixedSize(horizontal: false, vertical: true) + + BadgeUserPreview(level: level) .padding(.top, 4) Spacer(minLength: 20) @@ -202,7 +201,7 @@ struct BadgesPayView: View { } } } catch let error { - logger.error("BadgesPayView.purchase: \(String(describing: error))") + logger.error("BadgesHowLongView.purchase: \(String(describing: error))") await MainActor.run { purchasing = false alert = SomeAlert( @@ -260,10 +259,10 @@ struct BadgesPayView: View { } } -struct BadgesPayView_Previews: PreviewProvider { +struct BadgesHowLongView_Previews: PreviewProvider { static var previews: some View { NavigationView { - BadgesPayView(level: .supporter) + BadgesHowLongView(level: .supporter) } } } diff --git a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift index 55d05f2615..44b1e48be1 100644 --- a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift @@ -76,7 +76,7 @@ struct BadgesSupportSimplexView: View { .buttonStyle(OnboardingButtonStyle(isDisabled: false)) NavigationLink(isActive: $chooseLevelActive) { - BadgesYourLevelView() + BadgesChooseBadgeView() .modifier(ThemedBackground()) } label: { EmptyView() diff --git a/apps/ios/SimpleX.xcodeproj/project.pbxproj b/apps/ios/SimpleX.xcodeproj/project.pbxproj index e0a634a713..d4171b89ae 100644 --- a/apps/ios/SimpleX.xcodeproj/project.pbxproj +++ b/apps/ios/SimpleX.xcodeproj/project.pbxproj @@ -166,6 +166,8 @@ 647B15E82F4C8D2500EB431E /* AddChannelView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647B15E72F4C8D2500EB431E /* AddChannelView.swift */; }; 647B15EA2F4C8D5100EB431E /* ChatRelayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647B15E92F4C8D5100EB431E /* ChatRelayView.swift */; }; 647C9E293061362A0032110E /* GetStakeBanner.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E283061362A0032110E /* GetStakeBanner.swift */; }; + 647C9E2C30666C640032110E /* BadgesChooseBadgeView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */; }; + 647C9E2D30666C640032110E /* BadgesHowLongView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E2B30666C640032110E /* BadgesHowLongView.swift */; }; 647F090E288EA27B00644C40 /* GroupMemberInfoView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647F090D288EA27B00644C40 /* GroupMemberInfoView.swift */; }; 648010AB281ADD15009009B9 /* CIFileView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 648010AA281ADD15009009B9 /* CIFileView.swift */; }; 648679AB2BC96A74006456E7 /* ChatItemForwardingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 648679AA2BC96A74006456E7 /* ChatItemForwardingView.swift */; }; @@ -181,13 +183,11 @@ 64A77A022DC4AD6100FDEF2F /* ContextPendingMemberActionsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64A77A012DC4AD6100FDEF2F /* ContextPendingMemberActionsView.swift */; }; 64AA1C6927EE10C800AC7277 /* ContextItemView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64AA1C6827EE10C800AC7277 /* ContextItemView.swift */; }; 64AA1C6C27F3537400AC7277 /* DeletedItemView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64AA1C6B27F3537400AC7277 /* DeletedItemView.swift */; }; - 64C03BF9302F423300072BDE /* BadgesPayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF1302F423300072BDE /* BadgesPayView.swift */; }; 64C03BFA302F423300072BDE /* BadgesRedeemCodeView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF2302F423300072BDE /* BadgesRedeemCodeView.swift */; }; 64C03BFB302F423300072BDE /* BadgesHowItWorksView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF0302F423300072BDE /* BadgesHowItWorksView.swift */; }; 64C03BFC302F423300072BDE /* BadgeUserPreview.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF6302F423300072BDE /* BadgeUserPreview.swift */; }; 64C03BFD302F423300072BDE /* BadgeStore.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF4302F423300072BDE /* BadgeStore.swift */; }; 64C03BFE302F423300072BDE /* SupportSimpleXBanner.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF7302F423300072BDE /* SupportSimpleXBanner.swift */; }; - 64C03BFF302F423300072BDE /* BadgesYourLevelView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF5302F423300072BDE /* BadgesYourLevelView.swift */; }; 64C03C00302F423300072BDE /* BadgesSupportSimplexView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C03BF3302F423300072BDE /* BadgesSupportSimplexView.swift */; }; 64C06EB52A0A4A7C00792D4D /* ChatItemInfoView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C06EB42A0A4A7C00792D4D /* ChatItemInfoView.swift */; }; 64C3B0212A0D359700E19930 /* CustomTimePicker.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64C3B0202A0D359700E19930 /* CustomTimePicker.swift */; }; @@ -558,6 +558,8 @@ 647B15E72F4C8D2500EB431E /* AddChannelView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AddChannelView.swift; sourceTree = ""; }; 647B15E92F4C8D5100EB431E /* ChatRelayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatRelayView.swift; sourceTree = ""; }; 647C9E283061362A0032110E /* GetStakeBanner.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetStakeBanner.swift; sourceTree = ""; }; + 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesChooseBadgeView.swift; sourceTree = ""; }; + 647C9E2B30666C640032110E /* BadgesHowLongView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesHowLongView.swift; sourceTree = ""; }; 647F090D288EA27B00644C40 /* GroupMemberInfoView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GroupMemberInfoView.swift; sourceTree = ""; }; 648010AA281ADD15009009B9 /* CIFileView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CIFileView.swift; sourceTree = ""; }; 648679AA2BC96A74006456E7 /* ChatItemForwardingView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatItemForwardingView.swift; sourceTree = ""; }; @@ -575,11 +577,9 @@ 64AA1C6827EE10C800AC7277 /* ContextItemView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContextItemView.swift; sourceTree = ""; }; 64AA1C6B27F3537400AC7277 /* DeletedItemView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DeletedItemView.swift; sourceTree = ""; }; 64C03BF0302F423300072BDE /* BadgesHowItWorksView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesHowItWorksView.swift; sourceTree = ""; }; - 64C03BF1302F423300072BDE /* BadgesPayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesPayView.swift; sourceTree = ""; }; 64C03BF2302F423300072BDE /* BadgesRedeemCodeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesRedeemCodeView.swift; sourceTree = ""; }; 64C03BF3302F423300072BDE /* BadgesSupportSimplexView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesSupportSimplexView.swift; sourceTree = ""; }; 64C03BF4302F423300072BDE /* BadgeStore.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgeStore.swift; sourceTree = ""; }; - 64C03BF5302F423300072BDE /* BadgesYourLevelView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesYourLevelView.swift; sourceTree = ""; }; 64C03BF6302F423300072BDE /* BadgeUserPreview.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgeUserPreview.swift; sourceTree = ""; }; 64C03BF7302F423300072BDE /* SupportSimpleXBanner.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SupportSimpleXBanner.swift; sourceTree = ""; }; 64C06EB42A0A4A7C00792D4D /* ChatItemInfoView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatItemInfoView.swift; sourceTree = ""; }; @@ -1217,14 +1217,14 @@ 64C03BF8302F423300072BDE /* Badges */ = { isa = PBXGroup; children = ( + 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */, + 647C9E2B30666C640032110E /* BadgesHowLongView.swift */, 644CC228305BFAE400D2A571 /* BadgesLedgerView.swift */, 64EB8A9A3054347A0089FFDF /* BadgesView.swift */, 64C03BF0302F423300072BDE /* BadgesHowItWorksView.swift */, - 64C03BF1302F423300072BDE /* BadgesPayView.swift */, 64C03BF2302F423300072BDE /* BadgesRedeemCodeView.swift */, 64C03BF3302F423300072BDE /* BadgesSupportSimplexView.swift */, 64C03BF4302F423300072BDE /* BadgeStore.swift */, - 64C03BF5302F423300072BDE /* BadgesYourLevelView.swift */, 64C03BF6302F423300072BDE /* BadgeUserPreview.swift */, 64C03BF7302F423300072BDE /* SupportSimpleXBanner.swift */, 64EB8A98305405C60089FFDF /* BadgesYourBadgeView.swift */, @@ -1649,13 +1649,11 @@ 640417CD2B29B8C200CCB412 /* NewChatMenuButton.swift in Sources */, 5CFE0921282EEAF60002594B /* ZoomableScrollView.swift in Sources */, 5C3A88CE27DF50170060F1C2 /* DetermineWidth.swift in Sources */, - 64C03BF9302F423300072BDE /* BadgesPayView.swift in Sources */, 64C03BFA302F423300072BDE /* BadgesRedeemCodeView.swift in Sources */, 64C03BFB302F423300072BDE /* BadgesHowItWorksView.swift in Sources */, 64C03BFC302F423300072BDE /* BadgeUserPreview.swift in Sources */, 64C03BFD302F423300072BDE /* BadgeStore.swift in Sources */, 64C03BFE302F423300072BDE /* SupportSimpleXBanner.swift in Sources */, - 64C03BFF302F423300072BDE /* BadgesYourLevelView.swift in Sources */, 64C03C00302F423300072BDE /* BadgesSupportSimplexView.swift in Sources */, 5C7505A527B679EE00BE3227 /* NavLinkPlain.swift in Sources */, 5C58BCD6292BEBE600AF9E4F /* CIChatFeatureView.swift in Sources */, @@ -1672,6 +1670,8 @@ CEFB2EDF2CA1BCC7004B1ECE /* SheetRepresentable.swift in Sources */, 5C2E260B27A30CFA00F70299 /* ChatListView.swift in Sources */, 6442E0BA287F169300CEC0F9 /* AddGroupView.swift in Sources */, + 647C9E2C30666C640032110E /* BadgesChooseBadgeView.swift in Sources */, + 647C9E2D30666C640032110E /* BadgesHowLongView.swift in Sources */, 5CF937232B2503D000E1D781 /* NSESubscriber.swift in Sources */, 6419EC582AB97507004A607A /* CIMemberCreatedContactView.swift in Sources */, 64D0C2C229FA57AB00B38D5F /* UserAddressLearnMore.swift in Sources */, diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourLevelView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt similarity index 90% rename from apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourLevelView.kt rename to apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt index 161702704b..b8324cc9c9 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourLevelView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt @@ -40,10 +40,10 @@ enum class BadgeLevel { Legend -> MR.strings.badges_level_legend_files } - val tagline: StringResource + val summary: StringResource get() = when (this) { - Supporter -> MR.strings.badges_level_supporter_tagline - Legend -> MR.strings.badges_level_legend_tagline + Supporter -> MR.strings.badges_level_supporter_summary + Legend -> MR.strings.badges_level_legend_summary } val badgeType: BadgeType @@ -54,7 +54,7 @@ enum class BadgeLevel { } @Composable -fun BadgesYourLevelView(modalManager: ModalManager) { +fun BadgesChooseBadgeView(modalManager: ModalManager) { var selectedLevel by remember { mutableStateOf(BadgeLevel.Supporter) } LaunchedEffect(Unit) { BadgeStore.load() } @@ -66,7 +66,7 @@ fun BadgesYourLevelView(modalManager: ModalManager) { maxIntrinsicSize = true, ) { Text( - stringResource(MR.strings.badges_your_level_title), + stringResource(MR.strings.badges_choose_your_badge_title), style = MaterialTheme.typography.h1, fontWeight = FontWeight.Bold, color = MaterialTheme.colors.primary, @@ -74,6 +74,14 @@ fun BadgesYourLevelView(modalManager: ModalManager) { modifier = Modifier.fillMaxWidth() ) + Text( + stringResource(MR.strings.badges_choose_your_badge_lede), + style = MaterialTheme.typography.body1, + color = MaterialTheme.colors.secondary, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + BadgeUserPreview(level = selectedLevel, modifier = Modifier.padding(top = 4.dp)) { Icon( painterResource(MR.images.ic_keyboard_arrow_down), @@ -146,7 +154,7 @@ private fun ContinueButton(selectedLevel: BadgeLevel, modalManager: ModalManager labelId = MR.strings.badges_continue, onboarding = null, onclick = { - modalManager.showModal { BadgesPayView(selectedLevel) } + modalManager.showModal { BadgesHowLongView(selectedLevel) } } ) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPayView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt similarity index 97% rename from apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPayView.kt rename to apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt index d7a10f38f7..2845e3986a 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPayView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt @@ -68,7 +68,7 @@ enum class BadgePeriod { } @Composable -fun BadgesPayView(level: BadgeLevel) { +fun BadgesHowLongView(level: BadgeLevel) { var selectedPeriod by remember { mutableStateOf(BadgePeriod.Monthly) } val purchasing = remember { mutableStateOf(false) } val clipboard = LocalClipboardManager.current @@ -82,7 +82,7 @@ fun BadgesPayView(level: BadgeLevel) { maxIntrinsicSize = true, ) { Text( - stringResource(level.title), + stringResource(MR.strings.badges_how_long_title), style = MaterialTheme.typography.h1, fontWeight = FontWeight.Bold, color = MaterialTheme.colors.primary, @@ -90,16 +90,16 @@ fun BadgesPayView(level: BadgeLevel) { modifier = Modifier.fillMaxWidth() ) - BadgeUserPreview(level = level, modifier = Modifier.padding(top = 4.dp)) - Text( - stringResource(level.tagline), + stringResource(level.summary), style = MaterialTheme.typography.body1, - color = MaterialTheme.colors.onBackground, + color = MaterialTheme.colors.secondary, textAlign = TextAlign.Center, - modifier = Modifier.fillMaxWidth().padding(top = 4.dp) + modifier = Modifier.fillMaxWidth() ) + BadgeUserPreview(level = level, modifier = Modifier.padding(top = 4.dp)) + Spacer(Modifier.weight(1f).heightIn(min = 8.dp)) // IntrinsicSize.Max + fillMaxHeight on children so all three cards match the tallest one - @@ -206,7 +206,7 @@ private fun purchase(level: BadgeLevel, period: BadgePeriod, purchasing: Mutable is BadgePurchaseOutcome.Cancelled -> {} } } catch (e: Exception) { - Log.e(TAG, "BadgesPayView.purchase: ${e.stackTraceToString()}") + Log.e(TAG, "BadgesHowLongView.purchase: ${e.stackTraceToString()}") purchasing.value = false AlertManager.shared.showAlertMsg( title = generalGetString(MR.strings.badges_purchase_error), diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt index 4f1cc2ed66..7fa32edaf3 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt @@ -80,7 +80,7 @@ private fun ChooseLevelButton(modalManager: ModalManager) { labelId = MR.strings.badges_choose_your_level, onboarding = null, onclick = { - modalManager.showModal { BadgesYourLevelView(modalManager) } + modalManager.showModal { BadgesChooseBadgeView(modalManager) } } ) } diff --git a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml index 42aecc9cfe..82dfe5152e 100644 --- a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml +++ b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml @@ -3151,14 +3151,16 @@ Loading… Not available Save %1$s - Optional profile badge\nand 2GB files - Optional profile badge\nand 5GB files + Supporter: 2 GB files available for 7 days. + Legend: 5 GB files available for 21 days. 1 month Monthly Annual Renews on %1$s. Cancel anytime. Ends on %1$s. - Your level + Choose your badge + Larger files that stay available longer. + How long? Support SimpleX Get a badge to send larger files (2-5GB) that stay available longer (7-21 days), and to show it on your profile. Why SimpleX is built. diff --git a/plans/2026-09-24-badge-buy-in-browser.md b/plans/2026-09-24-badge-buy-in-browser.md new file mode 100644 index 0000000000..4dea4782f4 --- /dev/null +++ b/plans/2026-09-24-badge-buy-in-browser.md @@ -0,0 +1,114 @@ +# Buying a badge in the browser + +The web page already sells badge codes. This makes the app the way in without making the app a shop: the app opens the page, the page runs the checkout it already has, and at the end hands the code back through a deep link instead of putting it on screen. The buyer never sees a code, and the code purchase itself is untouched. + +Wireframes: `plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw`. Panel ids below (A1, B3, D2…) refer to it, and the screens are drawn there rather than described again here. + +## Scope + +**Part 1** is everything in the wireframes except recurring payments: the browser lane on both builds, and the store lane's one-time product. Monthly and Annual stay on B3 and keep exactly the behaviour they have now — a real store transaction followed by a diagnostic alert, nothing sent anywhere. They must not reach the service, which cannot yet add months to a badge that already exists. + +The two lanes of part 1 are independent and unequal: the browser lane needs nothing from the service and can ship on its own, while the store lane cannot start until `purchaseBadge` accepts store receipts. + +**Part 2** is subscriptions, outlined at the end. + +Everything in the app sections below is both platforms unless it says otherwise. + +## Order of work + +1. **The renames**, on their own. Both screens are unreachable today, so nothing visible changes and the diff is strings and two titles. +2. **The page** — the `app` parameter, the second-screen start, both endings. Nothing sends the flag yet, so this is inert whenever it lands. It sits on the unmerged badge-service branch, which decides where it gets committed. +3. **The app's browser lane** — Buy in browser, the link handler, A6, and the desktop pair. End to end once 2 is deployed; before that it degrades to today's flow, where the buyer carries the code by hand. +4. **`purchaseBadge` with store receipts**, which depends on none of the above and can run alongside it. +5. **The app's store lane**, last, because nothing in it completes without 4. + +(*) **Desktop deep links** sit outside this order entirely — any time or never, blocking nothing. Own section below. + +## The page + +Three changes, all in `apps/simplex-badge-service/web`. + +**Start at the second screen.** The page already routes on the fragment, and `#/tier` is one of its own step hashes, landing on Choose your badge — the screen after its own Support SimpleX, which the app has just shown. But `landingIndex()` compares the whole hash, so `#/tier?app=true` matches no step and falls to the welcome panel. Parsing the flag's tail is what makes this work; it is not free. + +The app opens the page at its own host, `https://badges.simplex.chat/#/tier?app=true`. Not `simplex.chat/badges/`, which the app links to today: that is an Eleventy page whose layout is a bare `` to a fixed URL, so the fragment does not survive it. The redirect stays as it is for people who type it. Both platforms should hold the page URL as one constant, since a dev deployment of the service has its own page and the app has to be able to point at it. + +**Carry an `app` flag through the flow.** It rides in the fragment beside the step — `#/tier?app=true`, or `?app=desktop` — rather than in the query, because a fragment is never sent: the service learns nothing about which visitors came from the app, and it is stripped from the `Referer` when the page hands off to a payment provider. Nothing server-side needs it, and both things it decides are rendering. + +Only the ending needs it, and getting it there takes two carriers, because nothing single-handedly spans the flow. The session record holds it from the first load to checkout. At `created` the session is cleared and the URL is rewritten to a relative `?order=`, which drops the fragment, and a card payment returns to `origin + pathname` with neither — so the flag is then stamped onto the order record, beside the browser-only fields it already keeps, and the ending reads the order alone. An order resumed in another browser has no record, falls back to the plain page, and shows the code; that is correct. Keeping the flag in the session past checkout instead would be smaller and wrong: it would outlive the purchase, and it could not be cleared on a flagless load, because a reload and the card return are both flagless. + +**Replace the final screen for `app=true` (A5).** Try the deep link on load, then offer *Return to SimpleX* with *Show code* under it. `Show code` reveals the existing `codeIssued` content, unchanged — which means the code must still be minted and saved in the browser exactly as now. For `app=desktop` (D2), keep `codeIssued` as it is and change only the "Redeem it in the app" line to say the screen is already open. With no flag, nothing changes. + +## The link + +`simplexchat:/badge/code/` — a scheme of its own, not a path added to `simplex:`. That costs a registration on every platform, including the two where `simplex:` was already free, and buys a badge link that cannot be mistaken for a connection link and an existing dispatch left alone: the URL arrives at the same entry point the app already has, branches on scheme before the path switch that feeds `planAndConnect`, and never reaches it. + +Two things the code must get right: + +The link is a bearer token. Anything that can read it can redeem the badge — no worse than a code on screen, but it must not be logged. iOS logs every incoming URL in `SimpleXApp.onOpenURL` today and Kotlin should be checked for the same; those lines have to stop short of the code. Any web page can send one, so the screen it opens should do nothing but redeem. + +A link may arrive when no profile is active, or for a different profile than the one that bought it. Redeem into the active profile, as the redeem screen does, and let the existing errors speak if the code is spent. + +## The app: non-store (A1, A6) + +On Support SimpleX, *Get your code* becomes the primary button *Buy in browser* and *Redeem badge code* drops to the text button. The tap must open the browser directly, not through `openExternalLink`, which alerts for anything that is not a SimpleX connection link. The info button stays as it is: the TODO in that file proposing to swap it for *Why SimpleX is built* should not be followed. `chooseLevelButton()` is never called in these builds — there is no in-app purchase here at all. + +A6 is the one new screen: a title, a spinner, and a call to the existing redeem API with the code from the link. It is reachable only from the link, never from navigation, and a link can arrive from anywhere in the app — present it the way the badge sheet is already presented from an alert. Its failures are the redeem screen's failures and should use the same alerts. On success the app lands on Your badge by the path it already takes. + +## The app: store builds (B1–B5) + +B1's primary becomes *Choose your badge* — `chooseLevelButton()`, which already exists and is called by nothing. Its text button is *Buy in browser* where the store rules allow it and *Redeem code* where they do not, so the slot is never empty and codes are always reachable. Define that predicate once and use it for both the button and B2's — the rule is expected to be wider than the crowdfunding banner's and is not settled, so it should be one thing to change later. + +B2 (`BadgesChooseBadgeView`) gains *Redeem code* only when B1's slot is taken by *Buy in browser*. The privacy link stays on B1 in both builds and does not move here. + +B3 (`BadgesHowLongView`) loses its Pay button to *Continue*; `purchase()` moves to B4, which is new. Three of B5's outcomes need building: a verified transaction becomes a funded-not-issued state, `.pending` becomes an awaiting-the-store state, and an unverified one is refused with an alert and never sent. Both of those states belong on `BadgeState` and both must hold the Support SimpleX slot, because a consumable can otherwise be bought twice. Cancelled does nothing, and other billing errors keep today's alert. + +Two invariants that are easy to miss. A store transaction must not be finished until the credential is stored — `BadgeStore` says so in a comment already and does the opposite because nothing is delivered yet. And both platforms need reconciliation at launch (`Transaction.updates`, `queryPurchasesAsync`), because an outcome can arrive while the app is closed. + +## Desktop (D1, D2) + +No deep link. *Buy in browser* opens the page with `app=desktop` and the Redeem code screen at the same time, so the code has somewhere to go the moment it appears. This is also the fallback for any platform where the scheme turns out not to work: nothing else in the app depends on the link existing. + +## Desktop deep links (*) + +Optional, off the critical path, and blocking nothing — D1 works without it. Worth investigating on its own; if it lands, desktop joins lane A and D1 becomes the fallback rather than the design. + +Nothing registers a scheme on desktop today. `appOpenUrl` is wired in commonMain with no desktop implementation behind it, and `desktop/build.gradle.kts` declares Deb, Dmg, Msi and Exe with no protocol entry. Registration is per-OS, three separate small jobs: `CFBundleURLTypes` in the bundle plist plus `Desktop.setOpenURIHandler` on macOS, registry keys under `HKCU\Software\Classes` that the installer would have to write on Windows, and a `.desktop` entry with `MimeType=x-scheme-handler/simplexchat` on Linux. None of them covers an unpackaged run, so the fallback stays either way. + +Getting the URL to an app that is already running is the part that half exists. `SingleInstance.kt` takes a file lock and uses a watched file to bring the running instance forward on a second launch; carrying a URL means giving that channel a payload rather than inventing IPC for it. + +## The service + +The browser lane needs nothing. The store lane needs `purchaseBadge` to accept a store receipt and verify it — Apple's JWS offline, Google's token through the Publisher API, per `docs/protocol/badges-rpc.md`. No provider adapter for either exists today. + +Two properties matter more than the plumbing. It must be idempotent per signing key, since the app will retry. And an unknown or invalid token must be a plain refusal, not a retryable error — Android has no local verification, so tampered clients will send junk tokens as a matter of course, and a retryable answer would leave the worker grinding on one that can never become valid. + +`badges-rpc.md` also specifies `getBadgeCatalog` and `getBadgeInvoice`. Neither is needed by anything here and neither should be built: the page owns the catalog and the invoice. + +## Naming + +Two renames: *Your level* becomes *Choose your badge* with the page's lede, and the duration screen's title stops being the level name and becomes *How long?* with the chosen badge on the line below. This is the page's vocabulary; the app adopts it so the two halves of one purchase read the same. + +The views take their screens' names too, in a commit of their own: `BadgesYourLevelView` becomes `BadgesChooseBadgeView` and `BadgesPayView` becomes `BadgesHowLongView`, matching the directory's habit of naming a view after its title. `BadgeLevel` and `BadgePeriod` are domain types rather than views and keep their names — and `BadgeLevel` is marked for replacement by the purchase API's own types, so renaming it would be churn. Kotlin resource ids change along with their values — `badges_your_level_title` becomes `badges_choose_your_badge_title` and so on. Keeping an id while changing its English would leave every translation of it saying the old thing and still being shown, since a changed base value does not invalidate a translation; renaming retires them and gets the string translated afresh, which is what iOS does for free, its literals being their own keys. An id removed from base has to be removed from each translation file too, or the build fails formatting them. None of this costs anything today: no `badges_*` string has been through a translation round, so `base/strings.xml` is the only file that holds any. It stops being free the moment they are translated. + +## Tests + +The page has screen and routing tests; extend those rather than starting a parallel suite, and cover all three cases, including no flag at all. No UI tests on the app side — verify those by review. + +The store purchase needs end-to-end coverage and `BadgeServiceTests` is already the place: it runs a real client against a real service over SMP and covers redeeming, issuing, renewal and the worker. Everything from `APIPurchaseBadge` rightwards belongs there, with the receipt an opaque blob and verification behind a test provider that accepts one known token — the same seam the crypto and card providers already sit behind. Worth covering: a valid receipt issues a credential; the same receipt twice returns that same credential; an unknown token is refused and the refusal is not retryable; a receipt whose purchase key is not the signer is refused, as the code path is already tested for. + +The store SDK call itself cannot be automated. StoreKit needs a configuration file on a device, Play needs a real billing connection, and `.pending` needs a sandbox family account with Ask to Buy. That part is QA, and `useBadgeTestProducts` already exists for walking the Kotlin flow without Play Console products. + +## Comments + +Default to none. Add one only where behaviour or a consequence cannot be carried by names and structure — the transaction-finish ordering, the unlogged code, the retryability rule above are the kind of thing that earns one. Do not comment each function, do not restate the code, and do not reference this plan, a panel id or a ticket in the source. + +## Open questions + +- **Will a browser follow the scheme without a gesture?** Safari and Chrome both block some automatic scheme navigations, and a blocked one can show an error page rather than nothing. *Return to SimpleX* exists for this; the question is only whether the automatic attempt is worth making. +- **Where the browser button is allowed.** Which markets, and whether the same answer governs both builds. + +## Part 2: subscriptions + +Monthly and Annual become real purchases. The service side is the work: a subscription renews without the app present, so the badge has to gain months from a provider notification rather than from a `purchaseBadge` call, which means Apple's server notifications and Google's Pub/Sub, and a way to add months to a badge that already exists. The app side is smaller but not only copy: `BadgeState.renewsAt` and `willRenew` are hardcoded to nothing today and have to become real, and `BadgesYourBadgeView`'s Ends section says prepaid months have no billing date, which stops being true and needs a second wording. + +The browser lane never gains subscriptions: the page sells prepaid months and says so. diff --git a/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw b/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw new file mode 100644 index 0000000000..78f7d9987a --- /dev/null +++ b/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw @@ -0,0 +1,9352 @@ +{ + "type": "excalidraw", + "version": 2, + "source": "https://excalidraw-jetbrains-plugin", + "elements": [ + { + "id": "hdr-bg", + "type": "rectangle", + "x": 0, + "y": 0, + "width": 2500, + "height": 96, + "strokeColor": "transparent", + "backgroundColor": "#1c1e26", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": null, + "groupIds": [ + "header" + ], + "seed": 1001, + "index": "a000", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "hdr-title", + "type": "text", + "x": 40, + "y": 24, + "width": 620, + "height": 28, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "header" + ], + "seed": 1002, + "text": "Buying a badge - hidden codes", + "fontSize": 22, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a001", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Buying a badge - hidden codes", + "lineHeight": 1.2727272727272727 + }, + { + "id": "hdr-sub", + "type": "text", + "x": 40, + "y": 58, + "width": 1500, + "height": 15, + "strokeColor": "#a0a6b0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "header" + ], + "seed": 1003, + "text": "the shipped code purchase, reused whole: the page still mints a code, the deep link carries it, and the buyer never sees it. solid = exists, dashed = does not", + "fontSize": 12, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a002", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "the shipped code purchase, reused whole: the page still mints a code, the deep link carries it, and the buyer never sees it. solid = exists, dashed = does not", + "lineHeight": 1.25 + }, + { + "id": "hdr-r1", + "type": "text", + "x": 2260, + "y": 26, + "width": 200, + "height": 15, + "strokeColor": "#a0a6b0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "header" + ], + "seed": 1004, + "text": "in-app checkout", + "fontSize": 12, + "fontFamily": 2, + "textAlign": "right", + "verticalAlign": "top", + "autoResize": false, + "index": "a003", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "in-app checkout", + "lineHeight": 1.25 + }, + { + "id": "hdr-r2", + "type": "text", + "x": 2260, + "y": 48, + "width": 200, + "height": 14, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "header" + ], + "seed": 1005, + "text": "wireframes", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "right", + "verticalAlign": "top", + "autoResize": false, + "index": "a004", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "wireframes", + "lineHeight": 1.2727272727272727 + }, + { + "id": "l1-band", + "type": "rectangle", + "x": 20, + "y": 150, + "width": 2460, + "height": 850, + "strokeColor": "transparent", + "backgroundColor": "#eef5ff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "lane1" + ], + "seed": 1010, + "index": "a010", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "l1-head", + "type": "text", + "x": 60, + "y": 178, + "width": 900, + "height": 22, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane1" + ], + "seed": 1011, + "text": "Non-store builds - the browser does all of it", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a011", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Non-store builds - the browser does all of it", + "lineHeight": 1.2941176470588236 + }, + { + "id": "l1-sub", + "type": "text", + "x": 60, + "y": 206, + "width": 1300, + "height": 14, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane1" + ], + "seed": 1012, + "text": "no catalog API, no invoice API, no in-app checkout: the app opens the page, the page sells a code, the deep link brings it home", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a012", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "no catalog API, no invoice API, no in-app checkout: the app opens the page, the page sells a code, the deep link brings it home", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a1-panel", + "type": "rectangle", + "x": 60, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1101, + "boundElements": [ + { + "id": "ar-a1a2", + "type": "arrow" + } + ], + "index": "a020", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a1-title", + "type": "text", + "x": 80, + "y": 306, + "width": 260, + "height": 24, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1102, + "text": "Support SimpleX", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a021", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Support SimpleX", + "lineHeight": 1.263157894736842 + }, + { + "id": "a1-body", + "type": "text", + "x": 76, + "y": 348, + "width": 268, + "height": 39, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1103, + "text": "Get a badge to send larger files (2-5GB)\nthat stay available longer (7-21 days),\nand to show it on your profile.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a022", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Get a badge to send larger files (2-5GB)\nthat stay available longer (7-21 days),\nand to show it on your profile.", + "lineHeight": 1.3 + }, + { + "id": "a1-info", + "type": "text", + "x": 80, + "y": 404, + "width": 260, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1104, + "text": "(i) How badges protect your privacy", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a023", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "(i) How badges protect your privacy", + "lineHeight": 1.3 + }, + { + "id": "a1-hero", + "type": "rectangle", + "x": 132, + "y": 448, + "width": 156, + "height": 156, + "strokeColor": "transparent", + "backgroundColor": "#e8eef7", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1105, + "index": "a024", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a1-herot", + "type": "text", + "x": 132, + "y": 519, + "width": 156, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1106, + "text": "phone-supporter", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a025", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "phone-supporter", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a1-btn", + "type": "rectangle", + "x": 90, + "y": 730, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#0053d0", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1107, + "boundElements": [ + { + "id": "a1-btnt", + "type": "text" + } + ], + "index": "a026", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a1-btnt", + "type": "text", + "x": 100, + "y": 742, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1108, + "text": "Buy in browser", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "a1-btn", + "index": "a027", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Buy in browser", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "a1-sec", + "type": "text", + "x": 80, + "y": 786, + "width": 260, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1109, + "text": "Redeem code", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a028", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Redeem code", + "lineHeight": 1.3 + }, + { + "id": "a1-secn", + "type": "text", + "x": 80, + "y": 806, + "width": 260, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1112, + "text": "the manual path, for a code from elsewhere", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a029", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "the manual path, for a code from elsewhere", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a1-capt", + "type": "text", + "x": 60, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1110, + "text": "A1. BadgesSupportSimplexView", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a02a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A1. BadgesSupportSimplexView", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a1-capb", + "type": "text", + "x": 60, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A1", + "lane1" + ], + "seed": 1111, + "text": "Get your code becomes the primary button and loses the\nconfirm-in-browser alert - the tap opens the browser. Redeem\nbadge code drops to the text button. The info button stays as\nit is - the file's TODO would swap it for Why SimpleX is built\nonce purchase lands, and it should not.\nchooseLevelButton() is never called in this build.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a02b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Get your code becomes the primary button and loses the\nconfirm-in-browser alert - the tap opens the browser. Redeem\nbadge code drops to the text button. The info button stays as\nit is - the file's TODO would swap it for Why SimpleX is built\nonce purchase lands, and it should not.\nchooseLevelButton() is never called in this build.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "a2-panel", + "type": "rectangle", + "x": 480, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1201, + "boundElements": [ + { + "id": "ar-a1a2", + "type": "arrow" + }, + { + "id": "ar-a2a3", + "type": "arrow" + } + ], + "index": "a030", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-url", + "type": "rectangle", + "x": 480, + "y": 260, + "width": 300, + "height": 26, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1202, + "index": "a031", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-urlt", + "type": "text", + "x": 496, + "y": 268, + "width": 268, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1203, + "text": "simplex.chat/badges/#app=true", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a032", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplex.chat/badges/#app=true", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a2-title", + "type": "text", + "x": 496, + "y": 312, + "width": 268, + "height": 22, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1204, + "text": "Choose your badge", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a033", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Choose your badge", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a2-lede", + "type": "text", + "x": 496, + "y": 342, + "width": 268, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1205, + "text": "Larger files that stay available longer.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a034", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Larger files that stay available longer.", + "lineHeight": 1.368421052631579 + }, + { + "id": "a2-c1", + "type": "rectangle", + "x": 496, + "y": 378, + "width": 130, + "height": 150, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1206, + "index": "a035", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-c1i", + "type": "rectangle", + "x": 545, + "y": 398, + "width": 32, + "height": 32, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1207, + "index": "a036", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-c1t", + "type": "text", + "x": 504, + "y": 442, + "width": 114, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1208, + "text": "Supporter\n2GB files\n\n$7/month", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a037", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Supporter\n2GB files\n\n$7/month", + "lineHeight": 1.3 + }, + { + "id": "a2-c2", + "type": "rectangle", + "x": 634, + "y": 378, + "width": 130, + "height": 150, + "strokeColor": "#0053d0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1209, + "index": "a038", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-c2i", + "type": "rectangle", + "x": 683, + "y": 398, + "width": 32, + "height": 32, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1210, + "index": "a039", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-c2t", + "type": "text", + "x": 642, + "y": 442, + "width": 114, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1211, + "text": "Legend\n5GB files\n\n$70/month", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a03a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend\n5GB files\n\n$70/month", + "lineHeight": 1.3 + }, + { + "id": "a2-btn", + "type": "rectangle", + "x": 496, + "y": 560, + "width": 268, + "height": 36, + "strokeColor": "transparent", + "backgroundColor": "#0053d0", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1212, + "boundElements": [ + { + "id": "a2-btnt", + "type": "text" + } + ], + "index": "a03b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a2-btnt", + "type": "text", + "x": 506, + "y": 571, + "width": 248, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1213, + "text": "Continue", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "a2-btn", + "index": "a03c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "a2-capt", + "type": "text", + "x": 480, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1215, + "text": "A2. Where the link lands", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a03d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A2. Where the link lands", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a2-capb", + "type": "text", + "x": 480, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A2", + "lane1" + ], + "seed": 1216, + "text": "The page's own second screen, quoted as it is. #app=true\nskips its Support SimpleX, which the app has just shown.\nNEW on the page: read that flag, start here, and remember it\nthrough the flow. The app builds the URL, so it can also say\nwhich kind of app it is - better than the page guessing from\nthe user agent (see lane C).", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a03e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The page's own second screen, quoted as it is. #app=true\nskips its Support SimpleX, which the app has just shown.\nNEW on the page: read that flag, start here, and remember it\nthrough the flow. The app builds the URL, so it can also say\nwhich kind of app it is - better than the page guessing from\nthe user agent (see lane C).", + "lineHeight": 1.2222222222222223 + }, + { + "id": "a3-panel", + "type": "rectangle", + "x": 900, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1301, + "boundElements": [ + { + "id": "ar-a2a3", + "type": "arrow" + }, + { + "id": "ar-a3a4", + "type": "arrow" + } + ], + "index": "a040", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-url", + "type": "rectangle", + "x": 900, + "y": 260, + "width": 300, + "height": 26, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1302, + "index": "a041", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-urlt", + "type": "text", + "x": 916, + "y": 268, + "width": 268, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1303, + "text": "simplex.chat/badges/#app=true", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a042", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplex.chat/badges/#app=true", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a3-title", + "type": "text", + "x": 916, + "y": 312, + "width": 268, + "height": 22, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1304, + "text": "How long?", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a043", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "How long?", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a3-lede", + "type": "text", + "x": 916, + "y": 342, + "width": 268, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1305, + "text": "Legend - 5GB files, 21 days", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a044", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend - 5GB files, 21 days", + "lineHeight": 1.368421052631579 + }, + { + "id": "a3-c1", + "type": "rectangle", + "x": 916, + "y": 378, + "width": 84, + "height": 124, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1306, + "index": "a045", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-c1t", + "type": "text", + "x": 920, + "y": 418, + "width": 76, + "height": 39, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1307, + "text": "1 month\n\n$70", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a046", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "1 month\n\n$70", + "lineHeight": 1.3 + }, + { + "id": "a3-c2", + "type": "rectangle", + "x": 1008, + "y": 378, + "width": 84, + "height": 124, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1308, + "index": "a047", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-c2t", + "type": "text", + "x": 1012, + "y": 412, + "width": 76, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1309, + "text": "3 months\n\n$140\none month free", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a048", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "3 months\n\n$140\none month free", + "lineHeight": 1.3 + }, + { + "id": "a3-c3", + "type": "rectangle", + "x": 1100, + "y": 378, + "width": 84, + "height": 124, + "strokeColor": "#0053d0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1310, + "index": "a049", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-c3t", + "type": "text", + "x": 1104, + "y": 412, + "width": 76, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1311, + "text": "12 months\n\n$420\nsave 50%", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a04a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "12 months\n\n$420\nsave 50%", + "lineHeight": 1.3 + }, + { + "id": "a3-note", + "type": "text", + "x": 916, + "y": 520, + "width": 268, + "height": 24, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1312, + "text": "Paid once, for the months you choose.\nNo subscription.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a04b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paid once, for the months you choose.\nNo subscription.", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a3-btn", + "type": "rectangle", + "x": 916, + "y": 560, + "width": 268, + "height": 36, + "strokeColor": "transparent", + "backgroundColor": "#0053d0", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1313, + "boundElements": [ + { + "id": "a3-btnt", + "type": "text" + } + ], + "index": "a04c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a3-btnt", + "type": "text", + "x": 926, + "y": 571, + "width": 248, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1314, + "text": "Continue", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "a3-btn", + "index": "a04d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "a3-capt", + "type": "text", + "x": 900, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1315, + "text": "A3. Unchanged", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a04e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A3. Unchanged", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a3-capb", + "type": "text", + "x": 900, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A3", + "lane1" + ], + "seed": 1316, + "text": "The page's own screen, and the source of the names this\nplan adopts in the app: Choose your badge, How long?,\nCheck your order. Prices and offers are the compiled catalog\nthe page already has, so getBadgeCatalog is not needed by\nanyone in this lane.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a04f", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The page's own screen, and the source of the names this\nplan adopts in the app: Choose your badge, How long?,\nCheck your order. Prices and offers are the compiled catalog\nthe page already has, so getBadgeCatalog is not needed by\nanyone in this lane.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "a4-panel", + "type": "rectangle", + "x": 1320, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1401, + "boundElements": [ + { + "id": "ar-a3a4", + "type": "arrow" + }, + { + "id": "ar-a4a5", + "type": "arrow" + } + ], + "index": "a050", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-url", + "type": "rectangle", + "x": 1320, + "y": 260, + "width": 300, + "height": 26, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1402, + "index": "a051", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-urlt", + "type": "text", + "x": 1336, + "y": 268, + "width": 268, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1403, + "text": "simplex.chat/badges/?order=8f3a...#app=true", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a052", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplex.chat/badges/?order=8f3a...#app=true", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a4-title", + "type": "text", + "x": 1336, + "y": 312, + "width": 268, + "height": 22, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1404, + "text": "Check your order", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a053", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Check your order", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a4-rowsL", + "type": "text", + "x": 1336, + "y": 352, + "width": 160, + "height": 48, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1405, + "text": "Your badge\nDuration\nLaunch discount: 50% off\nTotal", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a054", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Your badge\nDuration\nLaunch discount: 50% off\nTotal", + "lineHeight": 1.263157894736842 + }, + { + "id": "a4-rowsR", + "type": "text", + "x": 1508, + "y": 352, + "width": 96, + "height": 48, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1406, + "text": "Legend\n12 months\n-$420.00\n$420.00", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "right", + "verticalAlign": "top", + "autoResize": false, + "index": "a055", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend\n12 months\n-$420.00\n$420.00", + "lineHeight": 1.263157894736842 + }, + { + "id": "a4-label", + "type": "text", + "x": 1336, + "y": 420, + "width": 100, + "height": 12, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1407, + "text": "PAY WITH", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a056", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "PAY WITH", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a4-m1", + "type": "rectangle", + "x": 1336, + "y": 438, + "width": 84, + "height": 60, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1408, + "index": "a057", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-m1t", + "type": "text", + "x": 1340, + "y": 460, + "width": 76, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1409, + "text": "Bitcoin", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a058", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Bitcoin", + "lineHeight": 1.3 + }, + { + "id": "a4-m2", + "type": "rectangle", + "x": 1428, + "y": 438, + "width": 84, + "height": 60, + "strokeColor": "#0053d0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1410, + "index": "a059", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-m2t", + "type": "text", + "x": 1432, + "y": 460, + "width": 76, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1411, + "text": "Monero", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a05a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Monero", + "lineHeight": 1.3 + }, + { + "id": "a4-m3", + "type": "rectangle", + "x": 1520, + "y": 438, + "width": 84, + "height": 60, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1412, + "index": "a05b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-m3t", + "type": "text", + "x": 1524, + "y": 460, + "width": 76, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1413, + "text": "Card", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a05c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Card", + "lineHeight": 1.3 + }, + { + "id": "a4-btn", + "type": "rectangle", + "x": 1336, + "y": 560, + "width": 268, + "height": 36, + "strokeColor": "transparent", + "backgroundColor": "#0053d0", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1414, + "boundElements": [ + { + "id": "a4-btnt", + "type": "text" + } + ], + "index": "a05d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a4-btnt", + "type": "text", + "x": 1346, + "y": 571, + "width": 248, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1415, + "text": "Pay $420.00 with Monero", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "a4-btn", + "index": "a05e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Pay $420.00 with Monero", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "a4-capt", + "type": "text", + "x": 1320, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1416, + "text": "A4. Unchanged, and the pay screens after it", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a05f", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A4. Unchanged, and the pay screens after it", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a4-capb", + "type": "text", + "x": 1320, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A4", + "lane1" + ], + "seed": 1417, + "text": "The method is picked here and the code is minted here, as\ntoday: the browser generates it and sends only its SHA-256.\nSend 1.482 XMR, the countdown and Payment received follow\nand are unchanged, so they are not drawn. The service needs\nno new API for this lane at all.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a05g", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The method is picked here and the code is minted here, as\ntoday: the browser generates it and sends only its SHA-256.\nSend 1.482 XMR, the countdown and Payment received follow\nand are unchanged, so they are not drawn. The service needs\nno new API for this lane at all.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "a5-panel", + "type": "rectangle", + "x": 1740, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#0053d0", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1501, + "boundElements": [ + { + "id": "ar-a4a5", + "type": "arrow" + }, + { + "id": "ar-a5a6", + "type": "arrow" + } + ], + "index": "a060", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a5-url", + "type": "rectangle", + "x": 1740, + "y": 260, + "width": 300, + "height": 26, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1502, + "index": "a061", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a5-urlt", + "type": "text", + "x": 1756, + "y": 268, + "width": 268, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1503, + "text": "simplex.chat/badges/?order=8f3a...#app=true", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a062", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplex.chat/badges/?order=8f3a...#app=true", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a5-title", + "type": "text", + "x": 1756, + "y": 312, + "width": 268, + "height": 22, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1504, + "text": "Paid", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a063", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paid", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a5-lede", + "type": "text", + "x": 1756, + "y": 344, + "width": 268, + "height": 26, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1505, + "text": "Opening SimpleX to add your badge.\nIf nothing happens, use the button.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a064", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Opening SimpleX to add your badge.\nIf nothing happens, use the button.", + "lineHeight": 1.368421052631579 + }, + { + "id": "a5-btn", + "type": "rectangle", + "x": 1756, + "y": 396, + "width": 268, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#0053d0", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1506, + "boundElements": [ + { + "id": "a5-btnt", + "type": "text" + } + ], + "index": "a065", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a5-btnt", + "type": "text", + "x": 1766, + "y": 408, + "width": 248, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1507, + "text": "Return to SimpleX", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "a5-btn", + "index": "a066", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Return to SimpleX", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "a5-sec", + "type": "text", + "x": 1756, + "y": 452, + "width": 268, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1508, + "text": "Show code", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a067", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Show code", + "lineHeight": 1.3 + }, + { + "id": "a5-link", + "type": "rectangle", + "x": 1756, + "y": 496, + "width": 268, + "height": 34, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1509, + "index": "a068", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a5-linkt", + "type": "text", + "x": 1762, + "y": 507, + "width": 256, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1510, + "text": "simplexchat:/badge/code/SB-4K2M9-...", + "fontSize": 9, + "fontFamily": 3, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a069", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplexchat:/badge/code/SB-4K2M9-...", + "lineHeight": 1.4444444444444444 + }, + { + "id": "a5-note", + "type": "text", + "x": 1756, + "y": 544, + "width": 268, + "height": 33, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1511, + "text": "the page tries this on load; the button is\nthe backup, and Show code is the\nbackup to the backup", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a06a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "the page tries this on load; the button is\nthe backup, and Show code is the\nbackup to the backup", + "lineHeight": 1.2222222222222223 + }, + { + "id": "a5-capt", + "type": "text", + "x": 1740, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1512, + "text": "A5. New: the code leaves by link, not by eye", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a06b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A5. New: the code leaves by link, not by eye", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a5-capb", + "type": "text", + "x": 1740, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A5", + "lane1" + ], + "seed": 1513, + "text": "Replaces codeIssued when #app=true. The code is still\nminted and still saved in the browser, so Show code\nrecovers it if the link fails. simplexchat: is a scheme of its\nown, registered everywhere including mobile, so a badge link\ncan never be read as a connection link. Whether a browser\nwill follow it with no tap is the open question.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a06c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Replaces codeIssued when #app=true. The code is still\nminted and still saved in the browser, so Show code\nrecovers it if the link fails. simplexchat: is a scheme of its\nown, registered everywhere including mobile, so a badge link\ncan never be read as a connection link. Whether a browser\nwill follow it with no tap is the open question.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "a6-panel", + "type": "rectangle", + "x": 2160, + "y": 260, + "width": 300, + "height": 620, + "strokeColor": "#0053d0", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1601, + "boundElements": [ + { + "id": "ar-a5a6", + "type": "arrow" + } + ], + "index": "a070", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a6-title", + "type": "text", + "x": 2180, + "y": 306, + "width": 260, + "height": 24, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1602, + "text": "Badge is being issued", + "fontSize": 18, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a071", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Badge is being issued", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a6-spin", + "type": "ellipse", + "x": 2288, + "y": 380, + "width": 44, + "height": 44, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1603, + "index": "a072", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a6-spint", + "type": "text", + "x": 2180, + "y": 440, + "width": 260, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1604, + "text": "progress", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a073", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "progress", + "lineHeight": 1.3333333333333333 + }, + { + "id": "a6-body", + "type": "text", + "x": 2186, + "y": 478, + "width": 248, + "height": 39, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1605, + "text": "This takes a moment. You do not\nneed to do anything, and you can\nclose the app.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a074", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "This takes a moment. You do not\nneed to do anything, and you can\nclose the app.", + "lineHeight": 1.368421052631579 + }, + { + "id": "a6-then", + "type": "rectangle", + "x": 2176, + "y": 600, + "width": 268, + "height": 96, + "strokeColor": "#8f97a3", + "backgroundColor": "#f2f3f5", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1606, + "index": "a075", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a6-theni", + "type": "rectangle", + "x": 2190, + "y": 612, + "width": 240, + "height": 72, + "strokeColor": "transparent", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1607, + "index": "a076", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a6-theng", + "type": "rectangle", + "x": 2298, + "y": 620, + "width": 24, + "height": 24, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1608, + "index": "a077", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "a6-thent", + "type": "text", + "x": 2180, + "y": 650, + "width": 260, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1609, + "text": "Legend", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a078", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend", + "lineHeight": 1.3 + }, + { + "id": "a6-thens", + "type": "text", + "x": 2180, + "y": 666, + "width": 260, + "height": 11, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1610, + "text": "shown on your profile", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a079", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "shown on your profile", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a6-thenn", + "type": "text", + "x": 2160, + "y": 708, + "width": 300, + "height": 11, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1611, + "text": "then BadgesYourBadgeView, unchanged", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a07a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "then BadgesYourBadgeView, unchanged", + "lineHeight": 1.2941176470588236 + }, + { + "id": "a6-capt", + "type": "text", + "x": 2160, + "y": 900, + "width": 300, + "height": 14, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1612, + "text": "A6. New screen, and the only new app state", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a07b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "A6. New screen, and the only new app state", + "lineHeight": 1.2727272727272727 + }, + { + "id": "a6-capb", + "type": "text", + "x": 2160, + "y": 920, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "A6", + "lane1" + ], + "seed": 1613, + "text": "The deep link lands here, not on Redeem code: a pasted code\nand a QR scanner make no sense when the code arrived by\nlink. It calls the existing apiRedeemBadgeCode and shows its\nfailures as that screen does. Naming: Redeeming code names\nthe mechanism, Badge is being issued names the outcome -\nand the outcome is what the buyer cares about.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a07c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The deep link lands here, not on Redeem code: a pasted code\nand a QR scanner make no sense when the code arrived by\nlink. It calls the existing apiRedeemBadgeCode and shows its\nfailures as that screen does. Naming: Redeeming code names\nthe mechanism, Badge is being issued names the outcome -\nand the outcome is what the buyer cares about.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "ar-a1a2", + "type": "arrow", + "x": 368, + "y": 570, + "width": 104, + "height": 0, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 1701, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-a1a2-t", + "type": "text" + } + ], + "index": "a080", + "version": 2, + "versionNonce": 1538965901, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251194517, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-a1a2-t", + "type": "text", + "x": 365.810546875, + "y": 563.5, + "width": 108.37890625, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 1702, + "text": "Buy in browser - no alert", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-a1a2", + "index": "a081", + "version": 3, + "versionNonce": 709045891, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251191288, + "link": null, + "locked": false, + "originalText": "Buy in browser - no alert", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-a2a3", + "type": "arrow", + "x": 788, + "y": 570, + "width": 104, + "height": 0, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 1703, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-a2a3-t", + "type": "text" + } + ], + "index": "a082", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-a2a3-t", + "type": "text", + "x": 800, + "y": 556, + "width": 80, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 1704, + "text": "Continue", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-a2a3", + "index": "a083", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-a3a4", + "type": "arrow", + "x": 1208, + "y": 570, + "width": 104, + "height": 0, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 1705, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-a3a4-t", + "type": "text" + } + ], + "index": "a084", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-a3a4-t", + "type": "text", + "x": 1220, + "y": 556, + "width": 80, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 1706, + "text": "Continue", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-a3a4", + "index": "a085", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-a4a5", + "type": "arrow", + "x": 1628, + "y": 570, + "width": 104, + "height": 0, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 1707, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-a4a5-t", + "type": "text" + } + ], + "index": "a086", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-a4a5-t", + "type": "text", + "x": 1640, + "y": 556, + "width": 80, + "height": 13, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 1708, + "text": "it settles", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-a4a5", + "index": "a087", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "it settles", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-a5a6", + "type": "arrow", + "x": 2048, + "y": 570, + "width": 104, + "height": 0, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 1709, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-a5a6-t", + "type": "text" + } + ], + "index": "a088", + "version": 2, + "versionNonce": 737650275, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251382068, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-a5a6-t", + "type": "text", + "x": 2056.93115234375, + "y": 557, + "width": 86.1376953125, + "height": 26, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 1710, + "text": "simplexchat: carries\nthe code", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-a5a6", + "index": "a089", + "version": 4, + "versionNonce": 1743168653, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251380246, + "link": null, + "locked": false, + "originalText": "simplexchat: carries the code", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "l2-band", + "type": "rectangle", + "x": 20, + "y": 1040, + "width": 2460, + "height": 850, + "strokeColor": "transparent", + "backgroundColor": "#f5f1ff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "lane2" + ], + "seed": 2010, + "index": "a100", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "l2-head", + "type": "text", + "x": 60, + "y": 1068, + "width": 900, + "height": 22, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane2" + ], + "seed": 2011, + "text": "Store builds - the store path in the app, the browser alongside it", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a101", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Store builds - the store path in the app, the browser alongside it", + "lineHeight": 1.2941176470588236 + }, + { + "id": "l2-sub", + "type": "text", + "x": 60, + "y": 1096, + "width": 1300, + "height": 14, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane2" + ], + "seed": 2012, + "text": "Buy in browser runs lane A unchanged; only these four screens and the outcomes after them are in-app, and only here", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a102", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Buy in browser runs lane A unchanged; only these four screens and the outcomes after them are in-app, and only here", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b1-panel", + "type": "rectangle", + "x": 60, + "y": 1150, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2101, + "boundElements": [ + { + "id": "ar-b1b2", + "type": "arrow" + } + ], + "index": "a110", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b1-title", + "type": "text", + "x": 80, + "y": 1196, + "width": 260, + "height": 24, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2102, + "text": "Support SimpleX", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a111", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Support SimpleX", + "lineHeight": 1.263157894736842 + }, + { + "id": "b1-body", + "type": "text", + "x": 76, + "y": 1238, + "width": 268, + "height": 39, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2103, + "text": "Get a badge to send larger files (2-5GB)\nthat stay available longer (7-21 days),\nand to show it on your profile.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a112", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Get a badge to send larger files (2-5GB)\nthat stay available longer (7-21 days),\nand to show it on your profile.", + "lineHeight": 1.3 + }, + { + "id": "b1-info", + "type": "text", + "x": 80, + "y": 1294, + "width": 260, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2104, + "text": "(i) How badges protect your privacy", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a113", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "(i) How badges protect your privacy", + "lineHeight": 1.3 + }, + { + "id": "b1-hero", + "type": "rectangle", + "x": 132, + "y": 1338, + "width": 156, + "height": 156, + "strokeColor": "transparent", + "backgroundColor": "#efeaf9", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2105, + "index": "a114", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b1-herot", + "type": "text", + "x": 132, + "y": 1409, + "width": 156, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2106, + "text": "phone-supporter", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a115", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "phone-supporter", + "lineHeight": 1.3333333333333333 + }, + { + "id": "b1-btn", + "type": "rectangle", + "x": 90, + "y": 1620, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#5b21b6", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2107, + "boundElements": [ + { + "id": "b1-btnt", + "type": "text" + } + ], + "index": "a116", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b1-btnt", + "type": "text", + "x": 100, + "y": 1632, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2108, + "text": "Choose your badge", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "b1-btn", + "index": "a117", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Choose your badge", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "b1-sec", + "type": "text", + "x": 80, + "y": 1676, + "width": 260, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2109, + "text": "Buy in browser", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a118", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Buy in browser", + "lineHeight": 1.3 + }, + { + "id": "b1-secn", + "type": "text", + "x": 80, + "y": 1696, + "width": 260, + "height": 24, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2110, + "text": "where the browser is not allowed,\nthis slot reads Redeem code instead", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a119", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "where the browser is not allowed,\nthis slot reads Redeem code instead", + "lineHeight": 1.3333333333333333 + }, + { + "id": "b1-capt", + "type": "text", + "x": 60, + "y": 1790, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2111, + "text": "B1. Two buttons, one of them gated", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a11a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "B1. Two buttons, one of them gated", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b1-capb", + "type": "text", + "x": 60, + "y": 1810, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B1", + "lane2" + ], + "seed": 2112, + "text": "Buy in browser is the same tap as A1's and runs the same\nlane, but only where the store rules allow it - a wider set of\nmarkets than the crowdfunding banner covers, and not pinned\ndown yet. Where it is not allowed the slot reads Redeem code\ninstead, so this screen always offers one of the two and codes\nare never out of reach.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a11b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Buy in browser is the same tap as A1's and runs the same\nlane, but only where the store rules allow it - a wider set of\nmarkets than the crowdfunding banner covers, and not pinned\ndown yet. Where it is not allowed the slot reads Redeem code\ninstead, so this screen always offers one of the two and codes\nare never out of reach.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "b2-panel", + "type": "rectangle", + "x": 480, + "y": 1150, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2201, + "boundElements": [ + { + "id": "ar-b1b2", + "type": "arrow" + }, + { + "id": "ar-b2b3", + "type": "arrow" + } + ], + "index": "a120", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-back", + "type": "text", + "x": 496, + "y": 1168, + "width": 20, + "height": 14, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2202, + "text": "<", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a121", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "<", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b2-title", + "type": "text", + "x": 500, + "y": 1196, + "width": 260, + "height": 24, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2203, + "text": "Choose your badge", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a122", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Choose your badge", + "lineHeight": 1.263157894736842 + }, + { + "id": "b2-lede", + "type": "text", + "x": 500, + "y": 1236, + "width": 260, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2204, + "text": "Larger files that stay available longer.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a123", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Larger files that stay available longer.", + "lineHeight": 1.368421052631579 + }, + { + "id": "b2-avatar", + "type": "ellipse", + "x": 598, + "y": 1268, + "width": 56, + "height": 56, + "strokeColor": "transparent", + "backgroundColor": "#e3e6ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2205, + "index": "a124", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-name", + "type": "text", + "x": 500, + "y": 1334, + "width": 260, + "height": 15, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2206, + "text": "My nickname [badge] v", + "fontSize": 12, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a125", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "My nickname [badge] v", + "lineHeight": 1.25 + }, + { + "id": "b2-c1", + "type": "rectangle", + "x": 492, + "y": 1378, + "width": 132, + "height": 150, + "strokeColor": "#5b21b6", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2207, + "index": "a126", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-c1i", + "type": "rectangle", + "x": 542, + "y": 1398, + "width": 32, + "height": 32, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2208, + "index": "a127", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-c1t", + "type": "text", + "x": 500, + "y": 1442, + "width": 116, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2209, + "text": "Supporter\nSend 2GB files\n\n$6.99/month", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a128", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Supporter\nSend 2GB files\n\n$6.99/month", + "lineHeight": 1.3 + }, + { + "id": "b2-c2", + "type": "rectangle", + "x": 636, + "y": 1378, + "width": 132, + "height": 150, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2210, + "index": "a129", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-c2i", + "type": "rectangle", + "x": 686, + "y": 1398, + "width": 32, + "height": 32, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2211, + "index": "a12a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-c2t", + "type": "text", + "x": 644, + "y": 1442, + "width": 116, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2212, + "text": "Legend\nSend 5GB files\n\n$69.99/month", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a12b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend\nSend 5GB files\n\n$69.99/month", + "lineHeight": 1.3 + }, + { + "id": "b2-btn", + "type": "rectangle", + "x": 510, + "y": 1596, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#5b21b6", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2213, + "boundElements": [ + { + "id": "b2-btnt", + "type": "text" + } + ], + "index": "a12c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001521, + "link": null, + "locked": false + }, + { + "id": "b2-btnt", + "type": "text", + "x": 520, + "y": 1608, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2214, + "text": "Continue", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "b2-btn", + "index": "a12d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "b2-sec", + "type": "text", + "x": 500, + "y": 1652, + "width": 260, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2215, + "text": "Redeem code", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a12e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Redeem code", + "lineHeight": 1.3 + }, + { + "id": "b2-infon", + "type": "text", + "x": 500, + "y": 1676, + "width": 260, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2216, + "text": "here only when B1 offers the browser;\nthe privacy link always stays on B1", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a12f", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "here only when B1 offers the browser;\nthe privacy link always stays on B1", + "lineHeight": 1.3333333333333333 + }, + { + "id": "b2-capt", + "type": "text", + "x": 480, + "y": 1790, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2217, + "text": "B2. BadgesChooseBadgeView", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a130", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "B2. BadgesChooseBadgeView", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b2-capb", + "type": "text", + "x": 480, + "y": 1810, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B2", + "lane2" + ], + "seed": 2218, + "text": "Your level becomes Choose your badge, with the page's lede.\nRedeem code sits here only when B1's slot is taken by Buy in\nbrowser; where the browser is not allowed it stays on B1 and\nthis screen has Continue alone. The privacy link never moves -\nit stays on Support SimpleX in both builds.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a131", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001521, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Your level becomes Choose your badge, with the page's lede.\nRedeem code sits here only when B1's slot is taken by Buy in\nbrowser; where the browser is not allowed it stays on B1 and\nthis screen has Continue alone. The privacy link never moves -\nit stays on Support SimpleX in both builds.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "b3-panel", + "type": "rectangle", + "x": 900, + "y": 1150, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2301, + "boundElements": [ + { + "id": "ar-b2b3", + "type": "arrow" + }, + { + "id": "ar-b3b4", + "type": "arrow" + } + ], + "index": "a132", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-back", + "type": "text", + "x": 916, + "y": 1168, + "width": 20, + "height": 14, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2302, + "text": "<", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a133", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "<", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b3-title", + "type": "text", + "x": 920, + "y": 1196, + "width": 260, + "height": 24, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2303, + "text": "How long?", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a134", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "How long?", + "lineHeight": 1.263157894736842 + }, + { + "id": "b3-lede", + "type": "text", + "x": 920, + "y": 1236, + "width": 260, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2304, + "text": "Legend - 5GB files, 21 days", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a135", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend - 5GB files, 21 days", + "lineHeight": 1.368421052631579 + }, + { + "id": "b3-avatar", + "type": "ellipse", + "x": 1022, + "y": 1268, + "width": 56, + "height": 56, + "strokeColor": "transparent", + "backgroundColor": "#e3e6ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2305, + "index": "a136", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-name", + "type": "text", + "x": 920, + "y": 1334, + "width": 260, + "height": 15, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2306, + "text": "My nickname [badge]", + "fontSize": 12, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a137", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "My nickname [badge]", + "lineHeight": 1.25 + }, + { + "id": "b3-c1", + "type": "rectangle", + "x": 912, + "y": 1386, + "width": 85, + "height": 124, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2307, + "index": "a138", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-c1t", + "type": "text", + "x": 917, + "y": 1426, + "width": 75, + "height": 39, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2308, + "text": "1 month\n\n$69.99", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a139", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "1 month\n\n$69.99", + "lineHeight": 1.3 + }, + { + "id": "b3-c2", + "type": "rectangle", + "x": 1007, + "y": 1386, + "width": 85, + "height": 124, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2309, + "index": "a13a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-c2t", + "type": "text", + "x": 1010, + "y": 1426, + "width": 79, + "height": 39, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2310, + "text": "Monthly\n\n$69.99/month", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a13b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Monthly\n\n$69.99/month", + "lineHeight": 1.3 + }, + { + "id": "b3-c3", + "type": "rectangle", + "x": 1102, + "y": 1386, + "width": 85, + "height": 124, + "strokeColor": "#5b21b6", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 2, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2311, + "index": "a13c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-c3t", + "type": "text", + "x": 1105, + "y": 1420, + "width": 79, + "height": 52, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2312, + "text": "Annual\n\n$699.99/year\nSave 17%", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a13d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Annual\n\n$699.99/year\nSave 17%", + "lineHeight": 1.3 + }, + { + "id": "b3-btn", + "type": "rectangle", + "x": 930, + "y": 1620, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#5b21b6", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2313, + "boundElements": [ + { + "id": "b3-btnt", + "type": "text" + } + ], + "index": "a13e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b3-btnt", + "type": "text", + "x": 940, + "y": 1632, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2314, + "text": "Continue", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "b3-btn", + "index": "a13f", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "b3-foot", + "type": "text", + "x": 920, + "y": 1676, + "width": 260, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2315, + "text": "Renews on 24 August 2027. Cancel anytime.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a140", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Renews on 24 August 2027. Cancel anytime.", + "lineHeight": 1.368421052631579 + }, + { + "id": "b3-capt", + "type": "text", + "x": 900, + "y": 1790, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2316, + "text": "B3. BadgesHowLongView, disarmed", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a141", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "B3. BadgesHowLongView, disarmed", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b3-capb", + "type": "text", + "x": 900, + "y": 1810, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B3", + "lane2" + ], + "seed": 2317, + "text": "The level name was the title; now How long? is, with the\nchosen badge on the line under it, as the page does it.\nPay $69.99 becomes Continue and purchase() moves to B4.\nBadgePeriod as written today: one-time, monthly, annual,\nprices from StoreKit and Play, which need not match the web\npage's and generally will not.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a142", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The level name was the title; now How long? is, with the\nchosen badge on the line under it, as the page does it.\nPay $69.99 becomes Continue and purchase() moves to B4.\nBadgePeriod as written today: one-time, monthly, annual,\nprices from StoreKit and Play, which need not match the web\npage's and generally will not.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "b4-panel", + "type": "rectangle", + "x": 1320, + "y": 1150, + "width": 300, + "height": 620, + "strokeColor": "#5b21b6", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2401, + "boundElements": [ + { + "id": "ar-b3b4", + "type": "arrow" + }, + { + "id": "ar-b4o1", + "type": "arrow" + }, + { + "id": "ar-b4o2", + "type": "arrow" + }, + { + "id": "ar-b4o3", + "type": "arrow" + } + ], + "index": "a143", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b4-back", + "type": "text", + "x": 1336, + "y": 1168, + "width": 20, + "height": 14, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2402, + "text": "<", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a144", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "<", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b4-title", + "type": "text", + "x": 1340, + "y": 1196, + "width": 260, + "height": 24, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2403, + "text": "Check your order", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a145", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Check your order", + "lineHeight": 1.263157894736842 + }, + { + "id": "b4-rowsL", + "type": "text", + "x": 1344, + "y": 1270, + "width": 160, + "height": 36, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2404, + "text": "Your badge\nDuration\nTotal", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a146", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Your badge\nDuration\nTotal", + "lineHeight": 1.263157894736842 + }, + { + "id": "b4-rowsR", + "type": "text", + "x": 1500, + "y": 1270, + "width": 96, + "height": 36, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2405, + "text": "Legend\nAnnual\n$699.99/year", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "right", + "verticalAlign": "top", + "autoResize": false, + "index": "a147", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend\nAnnual\n$699.99/year", + "lineHeight": 1.263157894736842 + }, + { + "id": "b4-div", + "type": "rectangle", + "x": 1344, + "y": 1292, + "width": 252, + "height": 1, + "strokeColor": "#dfe4ea", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": null, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2406, + "index": "a148", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b4-note", + "type": "text", + "x": 1344, + "y": 1336, + "width": 252, + "height": 26, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2407, + "text": "Charged by the App Store to the\naccount on this device.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a149", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Charged by the App Store to the\naccount on this device.", + "lineHeight": 1.368421052631579 + }, + { + "id": "b4-btn", + "type": "rectangle", + "x": 1350, + "y": 1620, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#5b21b6", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2408, + "boundElements": [ + { + "id": "b4-btnt", + "type": "text" + } + ], + "index": "a14a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "b4-btnt", + "type": "text", + "x": 1360, + "y": 1632, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2409, + "text": "Pay $699.99/year", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "b4-btn", + "index": "a14b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Pay $699.99/year", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "b4-foot", + "type": "text", + "x": 1340, + "y": 1676, + "width": 260, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2410, + "text": "Renews on 24 August 2027. Cancel anytime.", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a14c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Renews on 24 August 2027. Cancel anytime.", + "lineHeight": 1.368421052631579 + }, + { + "id": "b4-capt", + "type": "text", + "x": 1320, + "y": 1790, + "width": 300, + "height": 14, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2411, + "text": "B4. New screen, one for every market", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a14d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "B4. New screen, one for every market", + "lineHeight": 1.2727272727272727 + }, + { + "id": "b4-capb", + "type": "text", + "x": 1320, + "y": 1810, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "B4", + "lane2" + ], + "seed": 2412, + "text": "No second button and nothing about paying elsewhere - that\nchoice was made back on B1. So this screen is identical in\nevery storefront and nothing on it is gated, which also means\nthe subscription never has to be reconciled against a web\nprice.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a14e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "No second button and nothing about paying elsewhere - that\nchoice was made back on B1. So this screen is identical in\nevery storefront and nothing on it is gated, which also means\nthe subscription never has to be reconciled against a web\nprice.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "o1-card", + "type": "rectangle", + "x": 1740, + "y": 1160, + "width": 300, + "height": 120, + "strokeColor": "#5b21b6", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O1", + "lane2" + ], + "seed": 2601, + "boundElements": [ + { + "id": "ar-b4o1", + "type": "arrow" + } + ], + "index": "a150", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o1-t", + "type": "text", + "x": 1760, + "y": 1174, + "width": 260, + "height": 17, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O1", + "lane2" + ], + "seed": 2602, + "text": "Paid", + "fontSize": 13, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a151", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paid", + "lineHeight": 1.3076923076923077 + }, + { + "id": "o1-s", + "type": "text", + "x": 1760, + "y": 1198, + "width": 260, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O1", + "lane2" + ], + "seed": 2603, + "text": "o Issuing your badge", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a152", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "o Issuing your badge", + "lineHeight": 1.3 + }, + { + "id": "o1-b", + "type": "text", + "x": 1766, + "y": 1222, + "width": 248, + "height": 26, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O1", + "lane2" + ], + "seed": 2604, + "text": "The store has taken the payment.\nKeeps trying if you close the app.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a153", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The store has taken the payment.\nKeeps trying if you close the app.", + "lineHeight": 1.4444444444444444 + }, + { + "id": "o2-card", + "type": "rectangle", + "x": 1740, + "y": 1300, + "width": 300, + "height": 96, + "strokeColor": "#8f97a3", + "backgroundColor": "#f2f3f5", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2605, + "index": "a154", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o2-i", + "type": "rectangle", + "x": 1756, + "y": 1312, + "width": 268, + "height": 72, + "strokeColor": "transparent", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2606, + "index": "a155", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o2-g", + "type": "rectangle", + "x": 1878, + "y": 1320, + "width": 24, + "height": 24, + "strokeColor": "transparent", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2607, + "index": "a156", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o2-t", + "type": "text", + "x": 1760, + "y": 1350, + "width": 260, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2608, + "text": "Legend", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a157", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Legend", + "lineHeight": 1.3 + }, + { + "id": "o2-s", + "type": "text", + "x": 1760, + "y": 1366, + "width": 260, + "height": 11, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2609, + "text": "shown on your profile", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a158", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "shown on your profile", + "lineHeight": 1.2941176470588236 + }, + { + "id": "o2-n", + "type": "text", + "x": 1740, + "y": 1402, + "width": 300, + "height": 11, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O2", + "lane2" + ], + "seed": 2610, + "text": "BadgesYourBadgeView, unchanged", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a159", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "BadgesYourBadgeView, unchanged", + "lineHeight": 1.2941176470588236 + }, + { + "id": "o3-card", + "type": "rectangle", + "x": 1740, + "y": 1424, + "width": 300, + "height": 130, + "strokeColor": "#5b21b6", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O3", + "lane2" + ], + "seed": 2611, + "boundElements": [ + { + "id": "ar-b4o2", + "type": "arrow" + } + ], + "index": "a15a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o3-t", + "type": "text", + "x": 1760, + "y": 1438, + "width": 260, + "height": 15, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O3", + "lane2" + ], + "seed": 2612, + "text": "Waiting for approval", + "fontSize": 12, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Waiting for approval", + "lineHeight": 1.25 + }, + { + "id": "o3-s", + "type": "text", + "x": 1760, + "y": 1460, + "width": 260, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O3", + "lane2" + ], + "seed": 2613, + "text": "o Nothing has been charged", + "fontSize": 9.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "o Nothing has been charged", + "lineHeight": 1.368421052631579 + }, + { + "id": "o3-b", + "type": "text", + "x": 1746, + "y": 1484, + "width": 288, + "height": 39, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O3", + "lane2" + ], + "seed": 2614, + "text": "Ask to Buy on iOS, a slow payment on\nPlay. Holds the slot so nothing can be\nbought twice, and becomes Paid above.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Ask to Buy on iOS, a slow payment on\nPlay. Holds the slot so nothing can be\nbought twice, and becomes Paid above.", + "lineHeight": 1.4444444444444444 + }, + { + "id": "o4-card", + "type": "rectangle", + "x": 1760, + "y": 1584, + "width": 260, + "height": 120, + "strokeColor": "#d6dae0", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "O4", + "lane2" + ], + "seed": 2615, + "boundElements": [ + { + "id": "ar-b4o3", + "type": "arrow" + } + ], + "index": "a15e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o4-t", + "type": "text", + "x": 1776, + "y": 1598, + "width": 228, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O4", + "lane2" + ], + "seed": 2616, + "text": "Cannot verify this purchase", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15f", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Cannot verify this purchase", + "lineHeight": 1.2727272727272727 + }, + { + "id": "o4-b", + "type": "text", + "x": 1776, + "y": 1620, + "width": 228, + "height": 39, + "strokeColor": "#4b5563", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O4", + "lane2" + ], + "seed": 2617, + "text": "The store returned a transaction\nthat Apple has not signed. Nothing\nhas been bought.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15g", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The store returned a transaction\nthat Apple has not signed. Nothing\nhas been bought.", + "lineHeight": 1.4444444444444444 + }, + { + "id": "o4-d", + "type": "rectangle", + "x": 1760, + "y": 1668, + "width": 260, + "height": 1, + "strokeColor": "#dfe4ea", + "backgroundColor": "#dfe4ea", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": null, + "groupIds": [ + "O4", + "lane2" + ], + "seed": 2618, + "index": "a15h", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "o4-o", + "type": "text", + "x": 1760, + "y": 1678, + "width": 260, + "height": 14, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O4", + "lane2" + ], + "seed": 2619, + "text": "Ok", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15i", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Ok", + "lineHeight": 1.2727272727272727 + }, + { + "id": "o-note", + "type": "text", + "x": 1740, + "y": 1712, + "width": 300, + "height": 44, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O", + "lane2" + ], + "seed": 2620, + "text": "iOS only - Play does no local verification, so a bad\ntoken is refused by the service instead. cancelled:\nnothing. other errors: today's Purchase error alert.", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a15j", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "iOS only - Play does no local verification, so a bad\ntoken is refused by the service instead. cancelled:\nnothing. other errors: today's Purchase error alert.", + "lineHeight": 1.7254901960784312 + }, + { + "id": "o-capt", + "type": "text", + "x": 1740, + "y": 1790, + "width": 300, + "height": 14, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O", + "lane2" + ], + "seed": 2621, + "text": "B5. What the sheet returns", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a15k", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "B5. What the sheet returns", + "lineHeight": 1.2727272727272727 + }, + { + "id": "o-capb", + "type": "text", + "x": 1740, + "y": 1810, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "O", + "lane2" + ], + "seed": 2622, + "text": "Two of these are states on BadgeState, not alerts: Paid, which\nthe worker retries, and Waiting, which holds nothing but the\nslot - Support SimpleX must not offer a second purchase of a\nconsumable. Both resolve through the store, not the service:\nTransaction.updates on iOS, queryPurchasesAsync on Play,\nwhich is also how each is re-found after a restart.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a15l", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Two of these are states on BadgeState, not alerts: Paid, which\nthe worker retries, and Waiting, which holds nothing but the\nslot - Support SimpleX must not offer a second purchase of a\nconsumable. Both resolve through the store, not the service:\nTransaction.updates on iOS, queryPurchasesAsync on Play,\nwhich is also how each is re-found after a restart.", + "lineHeight": 1.2222222222222223 + }, + { + "id": "ar-b1b2", + "type": "arrow", + "x": 368, + "y": 1460, + "width": 104, + "height": 0, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2701, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b1b2-t", + "type": "text" + } + ], + "index": "a180", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b1b2-t", + "type": "text", + "x": 380, + "y": 1446, + "width": 80, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2702, + "text": "Choose your badge", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b1b2", + "index": "a181", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Choose your badge", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-b2b3", + "type": "arrow", + "x": 788, + "y": 1460, + "width": 104, + "height": 0, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2703, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b2b3-t", + "type": "text" + } + ], + "index": "a182", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b2b3-t", + "type": "text", + "x": 800, + "y": 1446, + "width": 80, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2704, + "text": "Continue", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b2b3", + "index": "a183", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-b3b4", + "type": "arrow", + "x": 1208, + "y": 1460, + "width": 104, + "height": 0, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2705, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b3b4-t", + "type": "text" + } + ], + "index": "a184", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b3b4-t", + "type": "text", + "x": 1220, + "y": 1446, + "width": 80, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2706, + "text": "Continue", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b3b4", + "index": "a185", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Continue", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-b4o1", + "type": "arrow", + "x": 1628, + "y": 1220, + "width": 104, + "height": 0, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2709, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b4o1-t", + "type": "text" + } + ], + "index": "a186", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b4o1-t", + "type": "text", + "x": 1640, + "y": 1206, + "width": 80, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2710, + "text": "verified", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b4o1", + "index": "a187", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "verified", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-b4o2", + "type": "arrow", + "x": 1628, + "y": 1489, + "width": 104, + "height": 0, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "strokeWidth": 2, + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2711, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b4o2-t", + "type": "text" + } + ], + "index": "a188", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b4o2-t", + "type": "text", + "x": 1640, + "y": 1475, + "width": 80, + "height": 13, + "strokeColor": "#5b21b6", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2712, + "text": "pending", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b4o2", + "index": "a189", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "pending", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ar-b4o3", + "type": "arrow", + "x": 1628, + "y": 1644, + "width": 124, + "height": 0, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "strokeWidth": 2, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 2713, + "points": [ + [ + 0, + 0 + ], + [ + 124, + 0 + ] + ], + "startArrowhead": null, + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-b4o3-t", + "type": "text" + } + ], + "index": "a18a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-b4o3-t", + "type": "text", + "x": 1640, + "y": 1630, + "width": 100, + "height": 13, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 2714, + "text": "unverified", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-b4o3", + "index": "a18b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "unverified", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "l3-band", + "type": "rectangle", + "x": 20, + "y": 1930, + "width": 2460, + "height": 850, + "strokeColor": "transparent", + "backgroundColor": "#fff6ef", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "lane3" + ], + "seed": 3010, + "index": "a200", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "l3-head", + "type": "text", + "x": 60, + "y": 1958, + "width": 900, + "height": 22, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane3" + ], + "seed": 3011, + "text": "Desktop - where the deep link may not exist", + "fontSize": 17, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a201", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Desktop - where the deep link may not exist", + "lineHeight": 1.2941176470588236 + }, + { + "id": "l3-sub", + "type": "text", + "x": 60, + "y": 1986, + "width": 1300, + "height": 14, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "lane3" + ], + "seed": 3012, + "text": "the fallback is the shipped code flow with both halves opened at once, so nothing depends on a scheme handler that may not be there", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a202", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "the fallback is the shipped code flow with both halves opened at once, so nothing depends on a scheme handler that may not be there", + "lineHeight": 1.2727272727272727 + }, + { + "id": "d1-panel", + "type": "rectangle", + "x": 60, + "y": 2040, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3101, + "boundElements": [ + { + "id": "ar-d1d2", + "type": "arrow" + } + ], + "index": "a210", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d1-back", + "type": "text", + "x": 76, + "y": 2058, + "width": 20, + "height": 14, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3102, + "text": "<", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a211", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "<", + "lineHeight": 1.2727272727272727 + }, + { + "id": "d1-title", + "type": "text", + "x": 80, + "y": 2086, + "width": 260, + "height": 24, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3103, + "text": "Redeem code", + "fontSize": 19, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a212", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Redeem code", + "lineHeight": 1.263157894736842 + }, + { + "id": "d1-body", + "type": "text", + "x": 80, + "y": 2128, + "width": 260, + "height": 13, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3104, + "text": "Paste the code you received.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a213", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paste the code you received.", + "lineHeight": 1.3 + }, + { + "id": "d1-field", + "type": "rectangle", + "x": 76, + "y": 2160, + "width": 268, + "height": 40, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3105, + "index": "a214", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d1-fieldt", + "type": "text", + "x": 80, + "y": 2174, + "width": 260, + "height": 13, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3106, + "text": "SB-XXXXX-XXXXX-XXXXX-XXXXX", + "fontSize": 10, + "fontFamily": 3, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a215", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "SB-XXXXX-XXXXX-XXXXX-XXXXX", + "lineHeight": 1.3 + }, + { + "id": "d1-paste", + "type": "text", + "x": 80, + "y": 2216, + "width": 260, + "height": 13, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3107, + "text": "Paste", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a216", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paste", + "lineHeight": 1.3 + }, + { + "id": "d1-scan", + "type": "rectangle", + "x": 126, + "y": 2254, + "width": 168, + "height": 168, + "strokeColor": "#d6dae0", + "backgroundColor": "#f2f3f5", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3108, + "index": "a217", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d1-scant", + "type": "text", + "x": 126, + "y": 2332, + "width": 168, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3109, + "text": "QR scanner", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a218", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "QR scanner", + "lineHeight": 1.3333333333333333 + }, + { + "id": "d1-btn", + "type": "rectangle", + "x": 90, + "y": 2510, + "width": 240, + "height": 38, + "strokeColor": "transparent", + "backgroundColor": "#dcc9b4", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3110, + "boundElements": [ + { + "id": "d1-btnt", + "type": "text" + } + ], + "index": "a219", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d1-btnt", + "type": "text", + "x": 100, + "y": 2522, + "width": 220, + "height": 14, + "strokeColor": "#ffffff", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3111, + "text": "Redeem", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "d1-btn", + "index": "a21a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Redeem", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "d1-note", + "type": "text", + "x": 80, + "y": 2566, + "width": 260, + "height": 24, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3112, + "text": "opened by Buy in browser at the same\nmoment as the browser, and waiting", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a21b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "opened by Buy in browser at the same\nmoment as the browser, and waiting", + "lineHeight": 1.3333333333333333 + }, + { + "id": "d1-capt", + "type": "text", + "x": 60, + "y": 2680, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3113, + "text": "D1. Both halves at once", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a21c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "D1. Both halves at once", + "lineHeight": 1.2727272727272727 + }, + { + "id": "d1-capb", + "type": "text", + "x": 60, + "y": 2700, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D1", + "lane3" + ], + "seed": 3114, + "text": "On desktop, Buy in browser opens the page and this screen\ntogether, so the code has somewhere to go the moment it\nappears. No new screen, no deep link, no A6 - the shipped\nflow, with one extra window. It is also the honest fallback for\nany platform where the scheme turns out not to work.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a21d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "On desktop, Buy in browser opens the page and this screen\ntogether, so the code has somewhere to go the moment it\nappears. No new screen, no deep link, no A6 - the shipped\nflow, with one extra window. It is also the honest fallback for\nany platform where the scheme turns out not to work.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "d2-panel", + "type": "rectangle", + "x": 480, + "y": 2040, + "width": 300, + "height": 620, + "strokeColor": "#8f97a3", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3201, + "boundElements": [ + { + "id": "ar-d1d2", + "type": "arrow" + } + ], + "index": "a220", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-url", + "type": "rectangle", + "x": 480, + "y": 2040, + "width": 300, + "height": 26, + "strokeColor": "transparent", + "backgroundColor": "#eceef1", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3202, + "index": "a221", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-urlt", + "type": "text", + "x": 496, + "y": 2048, + "width": 268, + "height": 12, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3203, + "text": "simplex.chat/badges/#app=desktop", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a222", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "simplex.chat/badges/#app=desktop", + "lineHeight": 1.3333333333333333 + }, + { + "id": "d2-title", + "type": "text", + "x": 496, + "y": 2090, + "width": 268, + "height": 22, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3204, + "text": "Paid. Here is your code.", + "fontSize": 16, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a223", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Paid. Here is your code.", + "lineHeight": 1.375 + }, + { + "id": "d2-code", + "type": "rectangle", + "x": 496, + "y": 2128, + "width": 268, + "height": 36, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3205, + "index": "a224", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-codet", + "type": "text", + "x": 500, + "y": 2140, + "width": 260, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3206, + "text": "SB-4K2M9-XQ7VT-H3BNP-R8WLC", + "fontSize": 10, + "fontFamily": 3, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a225", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "SB-4K2M9-XQ7VT-H3BNP-R8WLC", + "lineHeight": 1.4 + }, + { + "id": "d2-btn", + "type": "rectangle", + "x": 496, + "y": 2180, + "width": 268, + "height": 34, + "strokeColor": "#0053d0", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3207, + "boundElements": [ + { + "id": "d2-btnt", + "type": "text" + } + ], + "index": "a226", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-btnt", + "type": "text", + "x": 506, + "y": 2190, + "width": 248, + "height": 14, + "strokeColor": "#0053d0", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3208, + "text": "Copy code", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "d2-btn", + "index": "a227", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "originalText": "Copy code", + "autoResize": true, + "lineHeight": 1.2727272727272727 + }, + { + "id": "d2-qr", + "type": "rectangle", + "x": 496, + "y": 2236, + "width": 110, + "height": 110, + "strokeColor": "#d6dae0", + "backgroundColor": "#f7f8fa", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": null, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3209, + "index": "a228", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-qrt", + "type": "text", + "x": 496, + "y": 2352, + "width": 110, + "height": 24, + "strokeColor": "#9aa1ab", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3210, + "text": "scan to carry it\nto your phone", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "top", + "autoResize": false, + "index": "a229", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "scan to carry it\nto your phone", + "lineHeight": 1.3333333333333333 + }, + { + "id": "d2-redeem", + "type": "text", + "x": 622, + "y": 2236, + "width": 142, + "height": 36, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3211, + "text": "REDEEM IT IN THE APP\nThe Redeem code screen\nis already open.", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a22a", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "REDEEM IT IN THE APP\nThe Redeem code screen\nis already open.", + "lineHeight": 1.411764705882353 + }, + { + "id": "d2-warn", + "type": "rectangle", + "x": 622, + "y": 2288, + "width": 142, + "height": 58, + "strokeColor": "transparent", + "backgroundColor": "#fdf3e7", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3212, + "index": "a22b", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "d2-warnt", + "type": "text", + "x": 632, + "y": 2298, + "width": 122, + "height": 38, + "strokeColor": "#8a5a1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3213, + "text": "This is the only copy.\nSaved in this browser\nand nowhere else.", + "fontSize": 8.5, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a22c", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "This is the only copy.\nSaved in this browser\nand nowhere else.", + "lineHeight": 1.4901960784313726 + }, + { + "id": "d2-capt", + "type": "text", + "x": 480, + "y": 2680, + "width": 300, + "height": 14, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3214, + "text": "D2. The page, told which app it is", + "fontSize": 11, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a22d", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "D2. The page, told which app it is", + "lineHeight": 1.2727272727272727 + }, + { + "id": "d2-capb", + "type": "text", + "x": 480, + "y": 2700, + "width": 340, + "height": 66, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "D2", + "lane3" + ], + "seed": 3215, + "text": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so #app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets #app=true and the A5 screen instead.", + "fontSize": 9, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a22e", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so #app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets #app=true and the A5 screen instead.", + "lineHeight": 1.4666666666666666 + }, + { + "id": "q-box", + "type": "rectangle", + "x": 900, + "y": 2040, + "width": 1540, + "height": 260, + "strokeColor": "#e0a672", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "Q", + "lane3" + ], + "seed": 3301, + "index": "a230", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "q-head", + "type": "text", + "x": 924, + "y": 2064, + "width": 900, + "height": 20, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "Q", + "lane3" + ], + "seed": 3302, + "text": "QUESTIONS - deep links, and whether the desktop can have them at all", + "fontSize": 15, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a231", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "QUESTIONS - deep links, and whether the desktop can have them at all", + "lineHeight": 1.3333333333333333 + }, + { + "id": "q-body", + "type": "text", + "x": 924, + "y": 2098, + "width": 1490, + "height": 130, + "strokeColor": "#4b5563", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "Q", + "lane3" + ], + "seed": 3303, + "text": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? Safari and Chrome both refuse some scheme navigations that no user gesture asked for, and a refused one can show an error page rather\n than nothing. That is what Return to SimpleX is for, and why Show code sits under it - but it decides whether the automatic attempt is worth making at all.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a232", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? Safari and Chrome both refuse some scheme navigations that no user gesture asked for, and a refused one can show an error page rather\n than nothing. That is what Return to SimpleX is for, and why Show code sits under it - but it decides whether the automatic attempt is worth making at all.", + "lineHeight": 1.4444444444444444 + }, + { + "id": "n-box", + "type": "rectangle", + "x": 900, + "y": 2340, + "width": 1540, + "height": 300, + "strokeColor": "#c9ced6", + "backgroundColor": "#ffffff", + "fillStyle": "solid", + "strokeWidth": 1, + "roughness": 0, + "roundness": { + "type": 3 + }, + "groupIds": [ + "N", + "lane3" + ], + "seed": 3401, + "index": "a233", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false + }, + { + "id": "n-head", + "type": "text", + "x": 924, + "y": 2364, + "width": 900, + "height": 20, + "strokeColor": "#1c1e26", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "N", + "lane3" + ], + "seed": 3402, + "text": "What has to be built, and what it costs", + "fontSize": 15, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a234", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "What has to be built, and what it costs", + "lineHeight": 1.3333333333333333 + }, + { + "id": "n-body", + "type": "text", + "x": 924, + "y": 2398, + "width": 1490, + "height": 220, + "strokeColor": "#4b5563", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "N", + "lane3" + ], + "seed": 3403, + "text": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read ?app and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it; and for #app=desktop,\nkeep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": false, + "index": "a235", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read ?app and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it; and for #app=desktop,\nkeep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", + "lineHeight": 2 + }, + { + "id": "ar-d1d2", + "type": "arrow", + "x": 368, + "y": 2350, + "width": 104, + "height": 0, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "strokeWidth": 2, + "strokeStyle": "dashed", + "roughness": 0, + "roundness": null, + "elbowed": true, + "groupIds": [], + "seed": 3501, + "points": [ + [ + 0, + 0 + ], + [ + 104, + 0 + ] + ], + "startArrowhead": "arrow", + "endArrowhead": "arrow", + "startBinding": null, + "endBinding": null, + "boundElements": [ + { + "id": "ar-d1d2-t", + "type": "text" + } + ], + "index": "a250", + "version": 2, + "versionNonce": 1589412771, + "isDeleted": false, + "fillStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "updated": 1790251896821, + "link": null, + "locked": false, + "lastCommittedPoint": null + }, + { + "id": "ar-d1d2-t", + "type": "text", + "x": 370.23193359375, + "y": 2337, + "width": 99.5361328125, + "height": 26, + "strokeColor": "#a15c1e", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [], + "seed": 3502, + "text": "opened together, code\ncarried by hand", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "center", + "verticalAlign": "middle", + "containerId": "ar-d1d2", + "index": "a251", + "version": 4, + "versionNonce": 1533799245, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251895408, + "link": null, + "locked": false, + "originalText": "opened together, code carried by hand", + "autoResize": true, + "lineHeight": 1.3 + }, + { + "id": "ft-note", + "type": "text", + "x": 60, + "y": 2830, + "width": 2400, + "height": 26, + "strokeColor": "#6b7280", + "backgroundColor": "transparent", + "roughness": 0, + "groupIds": [ + "footer" + ], + "seed": 4005, + "text": "Copy is quoted from the app and the page. The app's screens take the page's names: Your level becomes Choose your badge, the level name becomes How long?, and Check your order is shared already.\nStore prices are illustrative and come from the storefront; the page's prices are the shipped catalog. Not drawn: the page's refusals - no active price, a provider unavailable, too many attempts - which are unchanged and already built.", + "fontSize": 10, + "fontFamily": 2, + "textAlign": "left", + "verticalAlign": "top", + "autoResize": true, + "index": "a300", + "version": 1, + "versionNonce": 0, + "isDeleted": false, + "fillStyle": "solid", + "strokeWidth": 2, + "strokeStyle": "solid", + "opacity": 100, + "angle": 0, + "frameId": null, + "roundness": null, + "boundElements": [], + "updated": 1790251001522, + "link": null, + "locked": false, + "containerId": null, + "originalText": "Copy is quoted from the app and the page. The app's screens take the page's names: Your level becomes Choose your badge, the level name becomes How long?, and Check your order is shared already.\nStore prices are illustrative and come from the storefront; the page's prices are the shipped catalog. Not drawn: the page's refusals - no active price, a provider unavailable, too many attempts - which are unchanged and already built.", + "lineHeight": 1.3 + } + ], + "appState": { + "gridSize": 20, + "gridStep": 5, + "gridModeEnabled": false, + "viewBackgroundColor": "#ffffff" + }, + "files": {} +} \ No newline at end of file From 0dc85d3311346d758170d7249fd36ead2f611154 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Fri, 25 Sep 2026 13:23:28 +0000 Subject: [PATCH 02/26] badges: page ends an app purchase with a link instead of the code (#7589) --- apps/simplex-badge-service/web/README.md | 37 ++++-- apps/simplex-badge-service/web/mock/server.py | 12 +- .../web/public/index.html | 10 +- apps/simplex-badge-service/web/public/sw.js | 2 +- apps/simplex-badge-service/web/src/domain.ts | 6 + apps/simplex-badge-service/web/src/flow.ts | 6 +- apps/simplex-badge-service/web/src/main.ts | 57 +++++++-- apps/simplex-badge-service/web/src/order.ts | 1 + apps/simplex-badge-service/web/src/routing.ts | 20 ++- apps/simplex-badge-service/web/src/screens.ts | 76 ++++++++--- apps/simplex-badge-service/web/src/store.ts | 9 +- .../web/test/main-app-desktop.test.ts | 50 ++++++++ .../web/test/main-app-mobile.test.ts | 119 ++++++++++++++++++ .../web/test/main-app-reload.test.ts | 31 +++++ .../web/test/main-app-return.test.ts | 38 ++++++ .../web/test/main-app-unsaved.test.ts | 49 ++++++++ .../web/test/main-card-full-store.test.ts | 2 +- .../web/test/main-card-return.test.ts | 3 + .../web/test/routing.test.ts | 19 ++- .../web/test/screens.test.ts | 60 +++++++++ .../web/test/store.test.ts | 21 ++++ plans/2026-09-24-badge-buy-in-browser.md | 2 +- ...026-09-23-badge-in-app-checkout.excalidraw | 40 +++--- 23 files changed, 594 insertions(+), 76 deletions(-) create mode 100644 apps/simplex-badge-service/web/test/main-app-desktop.test.ts create mode 100644 apps/simplex-badge-service/web/test/main-app-mobile.test.ts create mode 100644 apps/simplex-badge-service/web/test/main-app-reload.test.ts create mode 100644 apps/simplex-badge-service/web/test/main-app-return.test.ts create mode 100644 apps/simplex-badge-service/web/test/main-app-unsaved.test.ts diff --git a/apps/simplex-badge-service/web/README.md b/apps/simplex-badge-service/web/README.md index 0004b44944..ae2f5b37e5 100644 --- a/apps/simplex-badge-service/web/README.md +++ b/apps/simplex-badge-service/web/README.md @@ -56,10 +56,10 @@ is plain TypeScript, tested directly in Node. | `format.ts` | Money, countdowns and elapsed time as the words a screen prints | | `store.ts` | The three `localStorage` keys — session, orders and the chosen theme | | `order.ts` | What an order's state means: what to keep from a response, which screen it selects, and its history row | -| `routing.ts` | Reading `?order=` and the store into what to render | +| `routing.ts` | Reading `?order=`, the step hash with its `?app=` flag, and the store into what to render; the `simplexchat:` link that hands a code to the app | | `api.ts` | The three routes — create, cancel and read — and the long-poll wait loop, with `fetch`, sleep and the clock injected | | `flow.ts` | Payment flow control logic — pure, no DOM, no globals | -| `stripe.ts` | Loading Stripe.js, mounting the Payment Element, confirming, and the no-key stand-in | +| `stripe.ts` | Loading Stripe.js, mounting the Payment Element, confirming, and refusing the card path with no key | | `icons.ts` | The badge art, the payment marks and the hamburger, built with `createElementNS`. The brand mark is NOT here: it is a served file | | `qr.ts` | A QR encoder written for this page, with no dependency, no network and no raster | | `screens.ts` | Every screen of the spec, and the header and its menu, built node by node — markup is never assigned from a string | @@ -183,6 +183,29 @@ which is what the page's own wait loop relies on — no polling on a timer. Card invoices (`"method":"card"`) get a `clientSecret` in the response instead of an address; BTC and XMR get `address` and `cryptoAmount`. +### Opening the page as the app does + +The SimpleX app opens the page at a step hash carrying a flag, which decides +only how the code is handed over at the end. Both endings can be driven here: + +``` +http://localhost:8099/#/tier?app=true # Return to SimpleX, with Show code under it +http://localhost:8099/#/tier?app=desktop # the code screen, saying the Redeem code screen is already open +``` + +With no flag the page ends as it always has. + +**Open each in a fresh private window.** The flag is read once, at load, and +kept in the session; nothing re-reads it when the hash changes, so editing the +address bar of a page that is already open does nothing. A session left over +from an earlier purchase in the same browser has already spent its flag at +checkout, and the ending falls back to the plain code screen. + +Pay with Monero or Bitcoin and settle it with `/control/settle` above — the +card path needs a Stripe key. A code the browser could not store also falls +back to the plain screen, so a browser that blocks `localStorage` never shows +the `app=true` ending at all. + ### The Stripe key The publishable key lives in a `` element @@ -191,12 +214,10 @@ in `public/index.html`, committed empty. `mock/server.py` substitutes set to anything but a `pk_`-prefixed key (a secret or restricted key would otherwise be baked into a page anyone can read). -With no key set, the card path renders a labelled development stand-in -instead of a Stripe Payment Element: its button does what a successful -confirm does, and settling it calls the mock's `/control/settle` directly. -**This stand-in cannot appear when a key is set** — the code path that -builds it is unreachable once Stripe.js has actually loaded. To see the real -Payment Element, set a test key: +With no key set there is no card path at all: `cardPlan` answers +`unconfigured`, `renderCardForm` returns before it builds anything, and +choosing Card reaches "The card form did not load". Drive a purchase with +Monero or Bitcoin instead, or set a test key: ``` STRIPE_PUBLISHABLE_KEY=pk_test_... python3 mock/server.py --port 8099 diff --git a/apps/simplex-badge-service/web/mock/server.py b/apps/simplex-badge-service/web/mock/server.py index af7612a084..009aea31d4 100644 --- a/apps/simplex-badge-service/web/mock/server.py +++ b/apps/simplex-badge-service/web/mock/server.py @@ -9,9 +9,9 @@ Environment: STRIPE_PUBLISHABLE_KEY substituted into the served index.html. Public by design, but still not committed: unset, the page has NO card form and - renders the development stand-in instead, whose - button does what a successful confirm does and whose - settling is POST /control/settle/ below. + choosing Card reaches "The card form did not load", + so drive a purchase with btc or xmr and settle it + with POST /control/settle/ below. Set it to a `pk_test_...` key to drive the real Stripe path; a secret key here is refused at start. """ @@ -111,8 +111,8 @@ def public_view(inv): def with_publishable_key(html): """The publishable key is compiled into the page. Here it comes from the environment, so nothing that could be a real key is ever written - back into public/index.html. Unset leaves the committed empty value, which - is what selects the development stand-in.""" + back into public/index.html. Unset leaves the committed empty value, with + which the page offers no card form at all.""" if not STRIPE_PUBLISHABLE_KEY: return html text, found = KEY_META.subn(lambda m: m.group(1) + STRIPE_PUBLISHABLE_KEY + m.group(2), html.decode()) @@ -314,7 +314,7 @@ def main(): print(f"mock badge service on http://localhost:{port}", flush=True) print("stripe: " + (f"publishable key {STRIPE_PUBLISHABLE_KEY[:11]}… — the real card form" if STRIPE_PUBLISHABLE_KEY - else "no STRIPE_PUBLISHABLE_KEY — the card path renders the development stand-in"), + else "no STRIPE_PUBLISHABLE_KEY — no card form; pay with btc or xmr"), flush=True) server.serve_forever() diff --git a/apps/simplex-badge-service/web/public/index.html b/apps/simplex-badge-service/web/public/index.html index dcf5e7d4b2..6caac72b84 100644 --- a/apps/simplex-badge-service/web/public/index.html +++ b/apps/simplex-badge-service/web/public/index.html @@ -20,17 +20,17 @@ Support SimpleX - - + + - + - + - + diff --git a/apps/simplex-badge-service/web/public/sw.js b/apps/simplex-badge-service/web/public/sw.js index 8faa9d0c1f..c0c46f2942 100644 --- a/apps/simplex-badge-service/web/public/sw.js +++ b/apps/simplex-badge-service/web/public/sw.js @@ -2,7 +2,7 @@ // runs this exact file in a Node `vm` with a fake Cache API and reads `self.sw`. /** Rewritten by `build.js` from the bytes of the compiled modules, the stylesheet and the images. */ -const BUILD = "9539a668abb6a8c8"; +const BUILD = "55cd5080cd9b28a4"; const ASSETS = `/assets/${BUILD}/`; /** One cache per build, so eviction is "everything that is not this one". */ const CACHE = `sb-${BUILD}`; diff --git a/apps/simplex-badge-service/web/src/domain.ts b/apps/simplex-badge-service/web/src/domain.ts index 4bae3d13b9..3baba3656f 100644 --- a/apps/simplex-badge-service/web/src/domain.ts +++ b/apps/simplex-badge-service/web/src/domain.ts @@ -5,18 +5,22 @@ export const THEMES = ["light", "dark", "system"] as const; const ORDER_STATUSES = ["open", "paid", "expired"] as const; const METHODS = ["card", "btc", "xmr"] as const; const CHAINS = ["btc", "xmr"] as const; +const APPS = ["mobile", "desktop"] as const; export type Step = (typeof STEPS)[number]; export type Theme = (typeof THEMES)[number]; export type OrderStatus = (typeof ORDER_STATUSES)[number]; export type Method = (typeof METHODS)[number]; export type Chain = (typeof CHAINS)[number]; +/** The SimpleX app that opened the page, which decides how the code is handed over at the end. */ +export type App = (typeof APPS)[number]; export const readStep = oneOf(STEPS); export const readTheme = oneOf(THEMES); export const readStatus = oneOf(ORDER_STATUSES); export const readMethod = oneOf(METHODS); export const readChain = oneOf(CHAINS); +export const readApp = oneOf(APPS); /** The optional fields are written `| undefined` so a patch can set one back to undefined to clear it. */ export interface SessionRecord { @@ -24,6 +28,7 @@ export interface SessionRecord { priceId?: string | undefined; offerId?: string | undefined; method?: Method | undefined; + app?: App | undefined; } export interface OrderIdentity { @@ -39,6 +44,7 @@ export interface OrderLocalState { submitted: boolean | undefined; canceled: boolean | undefined; method: Method | undefined; + app: App | undefined; } /** Every field is a required key even when undefined, so a withdrawn field cannot survive in the stored record. */ diff --git a/apps/simplex-badge-service/web/src/flow.ts b/apps/simplex-badge-service/web/src/flow.ts index 13da0949d0..af675eac04 100644 --- a/apps/simplex-badge-service/web/src/flow.ts +++ b/apps/simplex-badge-service/web/src/flow.ts @@ -9,7 +9,7 @@ import { applyView, closedInvoice, offlineInvoice, recordFromView, serverState, viewFor, withoutCode, type PaymentView, } from "./order.js"; -import type { Method, OrderRecord, OrderStatus } from "./domain.js"; +import type { App, Method, OrderRecord, OrderStatus } from "./domain.js"; import type { Store } from "./store.js"; export const GIVE_UP_MS = 15 * 60 * 1000; @@ -285,7 +285,7 @@ export class Flow { constructor(private readonly d: FlowDeps) {} - async checkout(sel: Selection): Promise { + async checkout(sel: Selection, app?: App): Promise { for (let attempt = 0; attempt < CODE_ATTEMPTS; attempt++) { const wipes = this.d.store.wipeCount; const code = this.d.newCode(); @@ -316,7 +316,7 @@ export class Flow { months: created.months, createdAt: new Date(this.d.now()).toISOString(), }, - { code: display(code), submitted: undefined, canceled: undefined, method: sel.method }, + { code: display(code), submitted: undefined, canceled: undefined, method: sel.method, app }, serverState({ ...created, status: "open" }, undefined), ); // The buyer can empty this browser while the invoice is bought, so the order is saved only diff --git a/apps/simplex-badge-service/web/src/main.ts b/apps/simplex-badge-service/web/src/main.ts index 310fa93220..3bb4917ddc 100644 --- a/apps/simplex-badge-service/web/src/main.ts +++ b/apps/simplex-badge-service/web/src/main.ts @@ -5,12 +5,12 @@ import { Flow, type CheckoutOutcome, type Selection } from "./flow.js"; import { applyView, historyRows, selectionFromOrder, type PaymentView, withoutDestination } from "./order.js"; import { money, moneyCompact } from "./format.js"; import * as api from "./api.js"; -import { resolveLoad } from "./routing.js"; +import { appCodeLink, readHash, resolveLoad } from "./routing.js"; import * as screens from "./screens.js"; import { appearanceFor, cardPlan, loadStripeJs, mountCard, publishableKey, type CardFailure, type ConfirmOutcome } from "./stripe.js"; import { Store, type StorageLike } from "./store.js"; import { STEPS } from "./domain.js"; -import type { Method, OrderRecord, SessionRecord, Step, Theme } from "./domain.js"; +import type { App, Method, OrderRecord, SessionRecord, Step, Theme } from "./domain.js"; import { EMBED_READY, HEIGHT_MESSAGE, NAV_MESSAGE, THEME_MESSAGE, bgFromMessage, isNewPurchaseMessage, returnUrlFromMessage, routeFromMessage, themeFromMessage, trustedHost } from "./embed.js"; const app = document.getElementById("app"); @@ -268,7 +268,8 @@ const panels: HTMLElement[] = []; let index = 0; function landingIndex(): number { - const fromHash = STEPS.findIndex((s) => HASHES[s] === location.hash); + const { route } = readHash(location.hash); + const fromHash = STEPS.findIndex((s) => HASHES[s] === route); return fromHash >= 0 ? fromHash + 1 : 0; } @@ -486,7 +487,7 @@ async function pay(): Promise { const since = flow.epoch; let outcome: CheckoutOutcome; try { - outcome = await flow.checkout(sel); + outcome = await flow.checkout(sel, session.app); } finally { checkoutInFlight = false; } @@ -507,7 +508,7 @@ async function pay(): Promise { } case "catalogChanged": root.replaceChildren(screens.catalogChanged(() => { - newInvoice(); + newInvoice(session.app); })); return; case "rateLimited": { @@ -606,7 +607,7 @@ async function cancelInvoice(orderId: string): Promise { return; } store.markCanceled(orderId); - newInvoice(); + newInvoice(store.order(orderId)?.app); } // The Cancel button's disabled attribute does not survive a repaint, so this flag allows one cancel at a time. @@ -631,8 +632,10 @@ function resetToLanding(nav: "push" | "replace"): void { announceLocation(); } -function newInvoice(): void { +// A purchase started over keeps the app that opened the page, or its order would end by showing the code. +function newInvoice(openedBy: App | undefined): void { store.clearSession(); + if (openedBy !== undefined) store.saveSession({ app: openedBy }); resetToLanding("replace"); } @@ -664,10 +667,10 @@ function paint(view: PaymentView): void { syncChrome(); switch (view.screen) { case "unknownOrder": - root.replaceChildren(screens.unknownOrder(newInvoice)); + root.replaceChildren(screens.unknownOrder(() => { newInvoice(store.session().app); })); return; case "codeIssued": - root.replaceChildren(screens.codeIssued({ code: view.code, savedLocally: view.savedLocally })); + root.replaceChildren(codeScreen(view)); return; case "paidNoCode": root.replaceChildren(screens.paidNoCode({ order: view.order, settledAt: view.invoice?.settledAt })); @@ -695,7 +698,7 @@ function paint(view: PaymentView): void { root.replaceChildren(screens.windowClosed({ order: view.order, invoice: view.invoice, offline: isOffline(), canceled: store.order(view.order.orderId)?.canceled === true, - onNewInvoice: newInvoice, + onNewInvoice: () => { newInvoice(view.order.app); }, })); return; case "cardForm": @@ -704,12 +707,38 @@ function paint(view: PaymentView): void { case "detailsUnavailable": root.replaceChildren(screens.detailsUnavailable({ order: view.order, - onCheckAgain: () => checkAgain(view.order.orderId), onNewInvoice: newInvoice, + onCheckAgain: () => checkAgain(view.order.orderId), onNewInvoice: () => { newInvoice(view.order.app); }, })); return; } } +type CodeView = Extract; + +const codeRevealed = new Set(); +const appLaunched = new Set(); + +function codeScreen(view: CodeView): HTMLElement { + const { orderId } = view.order; + // An unsaved code exists only on this screen, so it is never held back behind a link that may fail. + if (view.order.app !== "mobile" || !view.savedLocally) { + return screens.codeIssued({ code: view.code, savedLocally: view.savedLocally, app: view.order.app }); + } + const link = appCodeLink(view.code); + const ending = screens.returnToApp({ + onReturn: () => { location.href = link; }, + code: codeRevealed.has(orderId) + ? { kind: "shown", code: view.code, savedLocally: view.savedLocally } + : { kind: "hidden", onShow: () => { codeRevealed.add(orderId); paint(view); } }, + }); + // A connectivity event repaints this screen, and each repaint must not fire the scheme again. + if (!appLaunched.has(orderId)) { + appLaunched.add(orderId); + ending.append(screens.appLauncher(link)); + } + return ending; +} + let cardElementDestroy: (() => void) | null = null; let cardConfirmPending = false; @@ -783,7 +812,7 @@ function cardFailureScreen(view: CardView, reason: CardFailure): HTMLElement { return screens.cardUnavailable({ order: view.order, reason, onRetry: () => { renderCardForm(view); }, - onNewInvoice: newInvoice, + onNewInvoice: () => { newInvoice(view.order.app); }, }); } @@ -925,6 +954,10 @@ function registerServiceWorker(): void { // The shell prerenders the welcome page, so the document is that page until the first render, and a load resolving to a codes or order screen never mounts the wizard for measureWelcome to read. if (embedded && welcomeHeight <= 0) welcomeHeight = Math.ceil(document.documentElement.getBoundingClientRect().height); +// Read before the first sync rewrites the hash, which drops the flag from the URL. +const entryApp = readHash(location.hash).app; +if (entryApp !== undefined) store.saveSession({ app: entryApp }); + syncFromLocation(true); document.documentElement.classList.remove("sb-booting"); registerServiceWorker(); diff --git a/apps/simplex-badge-service/web/src/order.ts b/apps/simplex-badge-service/web/src/order.ts index 0370c55135..6bb40aa1ba 100644 --- a/apps/simplex-badge-service/web/src/order.ts +++ b/apps/simplex-badge-service/web/src/order.ts @@ -138,6 +138,7 @@ function localState(base: OrderRecord, memory: OrderRecord | undefined, method: submitted: memory?.submitted === true || base.submitted === true ? true : undefined, canceled: memory?.canceled === true || base.canceled === true ? true : undefined, method: method ?? base.method, + app: memory?.app ?? base.app, }; } diff --git a/apps/simplex-badge-service/web/src/routing.ts b/apps/simplex-badge-service/web/src/routing.ts index f5b50cbcb2..8557e3e9c6 100644 --- a/apps/simplex-badge-service/web/src/routing.ts +++ b/apps/simplex-badge-service/web/src/routing.ts @@ -1,4 +1,4 @@ -import type { Method, OrderRecord } from "./domain.js"; +import type { App, Method, OrderRecord } from "./domain.js"; export type Screen = "awaitingPayment" | "awaitingConfirmation" | "cardForm"; @@ -6,6 +6,24 @@ export type Load = { kind: "order"; orderId: string } | { kind: "step" }; export interface UrlParts { search: string } +export interface HashParts { route: string; app: App | undefined } + +// The flag rides in the fragment, which is never sent to the service nor carried in a Referer. +export function readHash(hash: string): HashParts { + const at = hash.indexOf("?"); + if (at < 0) return { route: hash, app: undefined }; + const flag = new URLSearchParams(hash.slice(at + 1)).get("app"); + return { + route: hash.slice(0, at), + app: flag === "true" ? "mobile" : flag === "desktop" ? "desktop" : undefined, + }; +} + +// A bearer token: whoever reads this URL can redeem the badge. +export function appCodeLink(code: string): string { + return `simplexchat:/badge/code/${encodeURIComponent(code)}`; +} + export function resolveLoad(url: UrlParts, newestOpen: OrderRecord | undefined): Load { const orderId = new URLSearchParams(url.search).get("order"); if (orderId) return { kind: "order", orderId }; diff --git a/apps/simplex-badge-service/web/src/screens.ts b/apps/simplex-badge-service/web/src/screens.ts index 04cb54f756..84e2135a00 100644 --- a/apps/simplex-badge-service/web/src/screens.ts +++ b/apps/simplex-badge-service/web/src/screens.ts @@ -3,7 +3,7 @@ import { badgeIcon, chevronLeft, hamburger, hasBadgeArt, methodMark, wefunderMar import { paymentUri, qrSvg } from "./qr.js"; import type { HistoryRow, UnpaidOrder } from "./order.js"; import type { InvoiceView } from "./api.js"; -import { THEMES, type Method, type Theme } from "./domain.js"; +import { THEMES, type App, type Method, type Theme } from "./domain.js"; import type { CardFailure } from "./stripe.js"; import { CROWDFUNDING_ACTIVE, WEFUNDER_URL, dollars } from "./crowdfunding.js"; @@ -785,9 +785,18 @@ export function windowClosed(o: WindowClosedOptions): HTMLElement { export interface CodeIssuedOptions { code: string; savedLocally: boolean; + app?: App | undefined; } -export function codeIssued(o: CodeIssuedOptions): HTMLElement { +export const REDEEM_IN_SETTINGS = "Settings → Supporter perks → Redeem code"; +export const REDEEM_SCREEN_OPEN = "The Redeem code screen is already open."; + +function codeWithCopy(code: string): HTMLElement[] { + const copy = copyControl("Copy code", code, "primary outline"); + return [el("div", { class: "code" }, code), copy.control, copy.status]; +} + +function codeDetails(o: CodeIssuedOptions): HTMLElement { const onlyCopy = o.savedLocally ? el("div", { class: "warn" }, el("span", { class: "title" }, "This is the only copy."), @@ -796,29 +805,68 @@ export function codeIssued(o: CodeIssuedOptions): HTMLElement { : el("div", { class: "warn" }, el("span", { class: "title" }, "This code could not be saved in this browser."), el("p", {}, "Copy it now. It is shown here and nowhere else.")); - const copy = copyControl("Copy code", o.code, "primary outline"); - const p = panel( - el("div", { class: "tick" }, "✓"), - el("h1", { class: "tight center" }, "Paid. Here is your code."), - el("div", { class: "code" }, o.code), - copy.control, - copy.status, - ); - const qr = qrFigure(o.code, "Badge code as a scannable code", "scan to carry it to your phone"); - const details = el("div", { class: "details" }, + return el("div", { class: "details" }, el("div", { class: "rows plain" }, el("span", { class: "label" }, "Redeem it in the app"), - el("div", {}, "Settings → Supporter perks → Redeem code"), + el("div", {}, o.app === "desktop" ? REDEEM_SCREEN_OPEN : REDEEM_IN_SETTINGS), ), onlyCopy, ); +} + +export function codeIssued(o: CodeIssuedOptions): HTMLElement { + const p = panel( + el("div", { class: "tick" }, "✓"), + el("h1", { class: "tight center" }, "Paid. Here is your code."), + ...codeWithCopy(o.code), + ); + const qr = qrFigure(o.code, "Badge code as a scannable code", "scan to carry it to your phone"); const split = el("div", { class: "split" }); if (qr !== null) split.append(qr); - split.append(details); + split.append(codeDetails(o)); p.append(split); return p; } +export const RETURN_TO_APP = "Return to SimpleX"; +export const SHOW_CODE = "Show code"; + +export type AppCode = + | { kind: "hidden"; onShow: () => void } + | { kind: "shown"; code: string; savedLocally: boolean }; + +export interface ReturnToAppOptions { + onReturn: () => void; + code: AppCode; +} + +// The buyer is on the phone the code is for, so the revealed code comes without the QR that would carry it there. +export function returnToApp(o: ReturnToAppOptions): HTMLElement { + const p = panel( + el("div", { class: "tick" }, "✓"), + el("h1", { class: "tight" }, "Paid"), + el("p", { class: "lede" }, + el("span", { class: "line" }, "Opening SimpleX to add your badge."), " ", + el("span", { class: "line" }, "If nothing happens, use the button."), + ), + button(RETURN_TO_APP, o.onReturn), + ); + switch (o.code.kind) { + case "hidden": + p.append(el("p", { class: "row-line center" }, button(SHOW_CODE, o.code.onShow, "link"))); + return p; + case "shown": + p.append(...codeWithCopy(o.code.code), el("div", { class: "split" }, codeDetails(o.code))); + return p; + } +} + +// A refused or unhandled scheme fails inside this frame, so no error page replaces the screen and no entry +// joins the history; the frame's first navigation replaces its about:blank. +export function appLauncher(link: string): HTMLIFrameElement { + return el("iframe", { src: link, hidden: "", "aria-hidden": "true", tabindex: "-1" }); +} + const MONTHS: readonly string[] = [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December", diff --git a/apps/simplex-badge-service/web/src/store.ts b/apps/simplex-badge-service/web/src/store.ts index 767b63e780..339334c77a 100644 --- a/apps/simplex-badge-service/web/src/store.ts +++ b/apps/simplex-badge-service/web/src/store.ts @@ -1,5 +1,5 @@ import { - composeOrder, readChain, readMethod, readStatus, readStep, readTheme, + composeOrder, readApp, readChain, readMethod, readStatus, readStep, readTheme, type OrderRecord, type SessionRecord, type Theme, } from "./domain.js"; import { asObject, filledText, flag, positiveInteger, text, nonNegativeInteger } from "./parse.js"; @@ -36,7 +36,7 @@ function readOrder(value: unknown): OrderRecord | undefined { badgeType: text(o.badgeType) ?? "", months: positiveInteger(o.months) ?? 0, }, - { code: text(o.code), submitted: flag(o.submitted), canceled: flag(o.canceled), method: readMethod(o.method) }, + { code: text(o.code), submitted: flag(o.submitted), canceled: flag(o.canceled), method: readMethod(o.method), app: readApp(o.app) }, { status, amount: positiveInteger(o.amount), @@ -61,9 +61,11 @@ function readSession(value: unknown): SessionRecord | undefined { const priceId = text(s.priceId); const offerId = text(s.offerId); const method = readMethod(s.method); + const app = readApp(s.app); if (priceId !== undefined) session.priceId = priceId; if (offerId !== undefined) session.offerId = offerId; if (method !== undefined) session.method = method; + if (app !== undefined) session.app = app; return session; } @@ -119,7 +121,7 @@ export class Store { return list.flatMap((o) => readOrder(o) ?? []); } - // The record replaces the stored entry, but the browser-only fields (code, submitted, canceled) are preserved because the service never sends them back. + // The record replaces the stored entry, but the browser-only fields (code, submitted, canceled, app) are preserved because the service never sends them back. saveOrder(record: OrderRecord): boolean { const list = this.orders(); const at = list.findIndex((o) => o.orderId === record.orderId); @@ -130,6 +132,7 @@ export class Store { ...(record.code === undefined && kept.code !== undefined ? { code: kept.code } : {}), ...(kept.submitted === true ? { submitted: true } : {}), ...(kept.canceled === true ? { canceled: true } : {}), + ...(record.app === undefined && kept.app !== undefined ? { app: kept.app } : {}), }; } else { if (list.length >= CAP) { diff --git a/apps/simplex-badge-service/web/test/main-app-desktop.test.ts b/apps/simplex-badge-service/web/test/main-app-desktop.test.ts new file mode 100644 index 0000000000..4c6d956cb0 --- /dev/null +++ b/apps/simplex-badge-service/web/test/main-app-desktop.test.ts @@ -0,0 +1,50 @@ +// Opened by the desktop app, which has no scheme handler: the code is shown as ever, and the app has Redeem code open beside it. +import { mock } from "node:test"; +import assert from "node:assert/strict"; +import { headingOf, inViewOf, installPage, primaryOf, screenOf, timedTest, until } from "./boot.js"; +import type { StubElement } from "./stub-dom.js"; + +const appTest = timedTest(5000); +const NOW = Date.parse("2026-08-28T12:00:00Z"); + +mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); +const page = installPage({ url: "/#/tier?app=desktop" }); +const { app, history, storage, fetches } = page; +await import("../src/main.js"); + +const heading = (): string => headingOf(screenOf(app)); +const inView = (): StubElement => inViewOf(app); + +appTest("main: #/tier?app=desktop lands on Choose your badge", () => { + assert.equal(headingOf(inView()), "Choose your badge"); + assert.equal(history.url, "/#/tier"); +}); + +appTest("main: paid from the desktop app, the code screen says Redeem code is already open", async () => { + inView().all("button.choice").find((c) => c.textContent.startsWith("Supporter"))!.click(); + primaryOf(inView())!.click(); + inView().all("button.choice").find((c) => c.textContent.startsWith("1 month"))!.click(); + primaryOf(inView())!.click(); + page.respondWith({ status: 200, body: { + invoiceId: "inv_desk", badgeType: "supporter", months: 1, amount: 700, currency: "usd", + expiresAt: "2026-08-28T12:58:12Z", address: "48HqK2Xm", cryptoAmount: "0.02", cryptoCurrency: "xmr", + } }); + inView().all("button.primary").find((b) => b.textContent.startsWith("Pay"))!.click(); + await until(() => heading() === "Send 0.02 XMR", `the payment screen, not ${heading()}`); + for (const f of fetches) { + const sent = `${f.url} ${String(f.init?.body ?? "")}`; + assert.ok(!/app=|"app"|desktop/.test(sent), `no request names the app: ${sent}`); + } + + page.answerHeld({ status: 200, body: { + status: "paid", badgeType: "supporter", months: 1, amount: 700, currency: "usd", + paidInFull: true, settledAt: "2026-08-28T12:05:00Z", + } }, "/api/invoice/inv_desk"); + await until(() => heading() === "Paid. Here is your code.", `the code screen, not ${heading()}`); + + const code = (JSON.parse(storage.getItem("sb.orders.v1")!) as Array<{ code: string }>)[0]!.code; + assert.equal(screenOf(app).all("div.code")[0]!.textContent, code, "the code, shown as it always was"); + assert.ok(screenOf(app).textContent.includes("The Redeem code screen is already open.")); + assert.ok(!screenOf(app).textContent.includes("Settings → Supporter perks"), "the one changed line"); + assert.equal(screenOf(app).all("iframe").length, 0, "desktop has no scheme to try"); +}); diff --git a/apps/simplex-badge-service/web/test/main-app-mobile.test.ts b/apps/simplex-badge-service/web/test/main-app-mobile.test.ts new file mode 100644 index 0000000000..40c5682a48 --- /dev/null +++ b/apps/simplex-badge-service/web/test/main-app-mobile.test.ts @@ -0,0 +1,119 @@ +// Opened by the mobile app: the code leaves by the simplexchat: link, and the page shows it only when asked. +import { mock } from "node:test"; +import assert from "node:assert/strict"; +import { headingOf, inViewOf, installPage, primaryOf, screenOf, settle, timedTest, until } from "./boot.js"; +import type { StubElement } from "./stub-dom.js"; + +const appTest = timedTest(5000); +const NOW = Date.parse("2026-08-28T12:00:00Z"); + +mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); +const page = installPage({ url: "/#/tier?app=true" }); +const { app, history, location, storage, fetches } = page; +await import("../src/main.js"); + +const heading = (): string => headingOf(screenOf(app)); +const inView = (): StubElement => inViewOf(app); +const stored = (): Record => + (JSON.parse(storage.getItem("sb.orders.v1") ?? "[]") as Array>)[0] ?? {}; + +appTest("main: #/tier?app=true lands on Choose your badge, with the flag in the session and off the URL", () => { + assert.equal(headingOf(inView()), "Choose your badge"); + assert.equal(history.url, "/#/tier", "the tail is dropped once read"); + assert.deepEqual(history.stack, ["/", "/#/tier"], "and Back still reaches the landing"); + assert.equal((JSON.parse(storage.getItem("sb.session.v1")!) as { app?: unknown }).app, "mobile"); +}); + +appTest("main: the flag survives the steps and is stamped on the order, and no request carries it", async () => { + inView().all("button.choice").find((c) => c.textContent.startsWith("Legend"))!.click(); + primaryOf(inView())!.click(); + inView().all("button.choice").find((c) => c.textContent.startsWith("12 months"))!.click(); + primaryOf(inView())!.click(); + assert.equal(headingOf(inView()), "Check your order"); + + page.respondWith({ status: 200, body: { + invoiceId: "inv_mob", badgeType: "legend", months: 12, amount: 42000, currency: "usd", + expiresAt: "2026-08-28T12:58:12Z", address: "48HqK2Xm", cryptoAmount: "1.482", cryptoCurrency: "xmr", + } }); + inView().all("button.primary").find((b) => b.textContent.startsWith("Pay"))!.click(); + await until(() => heading() === "Send 1.482 XMR", `the payment screen, not ${heading()}`); + + assert.equal(location.search, "?order=inv_mob"); + assert.equal(stored().app, "mobile", "the order carries the flag across the ?order= round trip"); + assert.equal(storage.getItem("sb.session.v1"), null, "the session that carried it here is done"); + const created = fetches.find((f) => f.url === "/api/invoice")!; + assert.deepEqual(Object.keys(JSON.parse(String(created.init!.body)) as object).sort(), + ["codeHash", "method", "offerId", "priceId"], "the service is told nothing about the app"); + for (const f of fetches) { + const sent = `${f.url} ${String(f.init?.body ?? "")}`; + assert.ok(!/app=|"app"|mobile/.test(sent), `no request names the app: ${sent}`); + } +}); + +appTest("main: once paid, the ending tries the link once and holds the code back", async () => { + page.answerHeld({ status: 200, body: { + status: "paid", badgeType: "legend", months: 12, amount: 42000, currency: "usd", + paidInFull: true, settledAt: "2026-08-28T12:05:00Z", + } }, "/api/invoice/inv_mob"); + await until(() => heading() === "Paid", `the return-to-app ending, not ${heading()}`); + + const code = stored().code as string; + const link = `simplexchat:/badge/code/${code}`; + const frames = screenOf(app).all("iframe"); + assert.equal(frames.length, 1, "one automatic attempt"); + assert.equal(frames[0]!.getAttribute("src"), link); + assert.ok(frames[0]!.hasAttribute("hidden"), "a refusal stays inside a frame nobody sees"); + assert.equal(screenOf(app).serialize().split(code).length - 1, 1, "the frame's src is the only place the code appears"); + assert.ok(!screenOf(app).textContent.includes(code), "and none of it is text on the screen"); +}); + +appTest("main: a repaint keeps the ending but does not fire the link again", async () => { + page.setOffline(true); + await settle(); + page.setOffline(false); + await settle(); + assert.equal(heading(), "Paid"); + assert.equal(screenOf(app).all("iframe").length, 0); +}); + +appTest("main: with the automatic attempt refused, Return to SimpleX still navigates, off the page's history", () => { + const before = [...history.stack]; + screenOf(app).all("button.primary").find((b) => b.textContent === "Return to SimpleX")!.click(); + assert.equal((location as { href?: string }).href, `simplexchat:/badge/code/${stored().code as string}`); + assert.deepEqual(history.stack, before, "the page adds no history entry of its own"); + assert.equal(heading(), "Paid", "and the screen is still there to fall back on"); +}); + +appTest("main: Show code reveals the stored code in place, keeps Return to SimpleX, and it stays revealed", async () => { + screenOf(app).all("button.link").find((b) => b.textContent === "Show code")!.click(); + const code = stored().code as string; + const revealed = (): void => { + assert.equal(heading(), "Paid", "still the ending, not the plain code screen"); + assert.equal(screenOf(app).all("div.code")[0]!.textContent, code); + assert.equal(screenOf(app).all("svg").filter((s) => s.getAttribute("class") === "qr").length, 0, "no QR"); + assert.ok(screenOf(app).all("button.primary").some((b) => b.textContent === "Return to SimpleX")); + }; + revealed(); + assert.equal(screenOf(app).all("iframe").length, 0, "revealing does not fire the link again"); + + page.clipboard.writes.length = 0; + screenOf(app).all("button.primary").find((b) => b.textContent === "Copy code")!.click(); + await settle(); + assert.deepEqual(page.clipboard.writes, [code]); + + page.setOffline(true); + await settle(); + page.setOffline(false); + await settle(); + revealed(); + + screenOf(app).all("button.primary").find((b) => b.textContent === "Return to SimpleX")!.click(); + assert.equal((location as { href?: string }).href, `simplexchat:/badge/code/${code}`, "the button still works once the code is out"); +}); + +appTest("main: nothing the page wrote to history or storage outside the order holds the link", () => { + for (const url of history.stack) assert.ok(!url.includes("simplexchat") && !url.includes("SB-"), url); + for (const [key, value] of storage.m) { + if (key !== "sb.orders.v1") assert.ok(!value.includes("SB-") && !value.includes("simplexchat"), key); + } +}); diff --git a/apps/simplex-badge-service/web/test/main-app-reload.test.ts b/apps/simplex-badge-service/web/test/main-app-reload.test.ts new file mode 100644 index 0000000000..f372dd7ec8 --- /dev/null +++ b/apps/simplex-badge-service/web/test/main-app-reload.test.ts @@ -0,0 +1,31 @@ +// A reload mid-purchase: the flag is off the URL by now, so only the session can still carry it to the order. +import { mock } from "node:test"; +import assert from "node:assert/strict"; +import { headingOf, inViewOf, installPage, primaryOf, screenOf, timedTest, until } from "./boot.js"; +import { MemStorage } from "./stub-dom.js"; + +const reloadTest = timedTest(5000); +const NOW = Date.parse("2026-08-28T12:00:00Z"); + +const storage = new MemStorage(); +storage.setItem("sb.session.v1", JSON.stringify({ step: "months", priceId: "price_legend", offerId: "offer_12m", app: "mobile" })); + +mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); +const page = installPage({ storage, url: "/#/months" }); +const { app } = page; +await import("../src/main.js"); + +reloadTest("main: after a reload the session still carries the flag, and the order it makes is stamped", async () => { + assert.equal(headingOf(inViewOf(app)), "How long?"); + assert.equal((JSON.parse(storage.getItem("sb.session.v1")!) as { app?: unknown }).app, "mobile"); + + primaryOf(inViewOf(app))!.click(); + page.respondWith({ status: 200, body: { + invoiceId: "inv_reload", badgeType: "legend", months: 12, amount: 42000, currency: "usd", + expiresAt: "2026-08-28T12:58:12Z", address: "48HqK2Xm", cryptoAmount: "1.482", cryptoCurrency: "xmr", + } }); + inViewOf(app).all("button.primary").find((b) => b.textContent.startsWith("Pay"))!.click(); + await until(() => headingOf(screenOf(app)) === "Send 1.482 XMR", "the payment screen"); + const order = (JSON.parse(storage.getItem("sb.orders.v1")!) as Array<{ app?: string }>)[0]!; + assert.equal(order.app, "mobile"); +}); diff --git a/apps/simplex-badge-service/web/test/main-app-return.test.ts b/apps/simplex-badge-service/web/test/main-app-return.test.ts new file mode 100644 index 0000000000..cfb53206b4 --- /dev/null +++ b/apps/simplex-badge-service/web/test/main-app-return.test.ts @@ -0,0 +1,38 @@ +// A mobile-app order comes back from Stripe with neither the query nor the fragment, so the ending is read off the order alone. +// This is also the reload after Show code: a fresh load puts the ending back, with the code one tap away. +import { mock } from "node:test"; +import assert from "node:assert/strict"; +import { headingOf, installPage, screenOf, timedTest, until } from "./boot.js"; +import { MemStorage } from "./stub-dom.js"; + +const returnTest = timedTest(3000); +const NOW = Date.parse("2026-08-28T12:00:00Z"); +const CODE = "SB-YDC8A-YGQTM-PUYZ9-2TUXP"; + +const storage = new MemStorage(); +storage.setItem("sb.orders.v1", JSON.stringify([{ + orderId: "inv_card", badgeType: "supporter", months: 1, + createdAt: new Date(NOW - 60_000).toISOString(), status: "paid", paidInFull: true, + submitted: true, code: CODE, amount: 700, currency: "usd", method: "card", app: "mobile", +}])); +storage.setItem("sb.cardReturn.v1", JSON.stringify({ orderId: "inv_card", at: NOW - 5_000 })); + +mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); +const page = installPage({ storage, url: "/?payment_intent=pi_1&redirect_status=succeeded" }); +const { app } = page; +await import("../src/main.js"); + +const heading = (): string => headingOf(screenOf(app)); + +returnTest("main: back from Stripe, the order's own flag picks the return-to-app ending", async () => { + await until(() => heading() === "Paid", `the return-to-app ending, not ${heading()}`); + assert.equal(page.location.search, "?order=inv_card"); + assert.equal(screenOf(app).all("iframe")[0]!.getAttribute("src"), `simplexchat:/badge/code/${CODE}`); + assert.ok(!screenOf(app).textContent.includes(CODE)); +}); + +returnTest("main: Show code reveals the stored code", () => { + screenOf(app).all("button.link").find((b) => b.textContent === "Show code")!.click(); + assert.equal(heading(), "Paid"); + assert.equal(screenOf(app).all("div.code")[0]!.textContent, CODE); +}); diff --git a/apps/simplex-badge-service/web/test/main-app-unsaved.test.ts b/apps/simplex-badge-service/web/test/main-app-unsaved.test.ts new file mode 100644 index 0000000000..ddead5d2ef --- /dev/null +++ b/apps/simplex-badge-service/web/test/main-app-unsaved.test.ts @@ -0,0 +1,49 @@ +// Opened by the mobile app, but every stored row already holds a code, so the new order's code cannot be saved. +import { mock } from "node:test"; +import assert from "node:assert/strict"; +import { headingOf, inViewOf, installPage, primaryOf, screenOf, timedTest, until } from "./boot.js"; +import { MemStorage, type StubElement } from "./stub-dom.js"; + +const unsavedTest = timedTest(5000); +const NOW = Date.parse("2026-08-28T12:00:00Z"); + +const full = new MemStorage(); +full.m.set("sb.orders.v1", JSON.stringify( + Array.from({ length: 50 }, (_, i) => ({ + orderId: `inv_old_${i}`, badgeType: "supporter", months: 1, + createdAt: new Date(NOW - (i + 2) * 86_400_000).toISOString(), status: "paid", paidInFull: true, + code: `SB-OLD${String(i).padStart(2, "0")}-YGQTM-PUYZ9-2TUXP`, amount: 700, currency: "usd", + })), +)); + +mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); +const page = installPage({ storage: full, url: "/#/tier?app=true" }); +const { app } = page; +await import("../src/main.js"); + +const heading = (): string => headingOf(screenOf(app)); +const inView = (): StubElement => inViewOf(app); + +unsavedTest("main: a code this browser could not save is shown at once, not held back behind the link", async () => { + inView().all("button.choice").find((c) => c.textContent.startsWith("Supporter"))!.click(); + primaryOf(inView())!.click(); + inView().all("button.choice").find((c) => c.textContent.startsWith("1 month"))!.click(); + primaryOf(inView())!.click(); + page.respondWith({ status: 200, body: { + invoiceId: "inv_unsaved", badgeType: "supporter", months: 1, amount: 700, currency: "usd", + expiresAt: "2026-08-28T12:58:12Z", address: "48HqK2Xm", cryptoAmount: "0.02", cryptoCurrency: "xmr", + } }); + inView().all("button.primary").find((b) => b.textContent.startsWith("Pay"))!.click(); + await until(() => heading() === "Send 0.02 XMR", `the payment screen, not ${heading()}`); + + page.answerHeld({ status: 200, body: { + status: "paid", badgeType: "supporter", months: 1, amount: 700, currency: "usd", + paidInFull: true, settledAt: "2026-08-28T12:05:00Z", + } }, "/api/invoice/inv_unsaved"); + await until(() => heading() === "Paid. Here is your code.", `the plain code screen, not ${heading()}`); + + assert.match(screenOf(app).all("div.code")[0]!.textContent, /^SB-[0-9A-Z]{5}-[0-9A-Z]{5}-[0-9A-Z]{5}-[0-9A-Z]{5}$/); + assert.ok(screenOf(app).textContent.includes("This code could not be saved in this browser.")); + assert.equal(screenOf(app).all("iframe").length, 0, "no link is tried"); + assert.equal(screenOf(app).all("button").filter((b) => b.textContent === "Show code").length, 0); +}); diff --git a/apps/simplex-badge-service/web/test/main-card-full-store.test.ts b/apps/simplex-badge-service/web/test/main-card-full-store.test.ts index bad13b57ef..57cc836222 100644 --- a/apps/simplex-badge-service/web/test/main-card-full-store.test.ts +++ b/apps/simplex-badge-service/web/test/main-card-full-store.test.ts @@ -22,7 +22,7 @@ mock.timers.enable({ apis: ["setTimeout", "Date"], now: NOW }); const page = installPage({ storage: full }); const { app } = page; -// The publishable key makes the card path use the real Payment Element, not a stand-in. +// The publishable key is what makes the card path exist at all; with none, it refuses. const keyMeta = new StubElement("meta"); keyMeta.setAttribute("id", "stripe-publishable-key"); keyMeta.setAttribute("name", "stripe-publishable-key"); diff --git a/apps/simplex-badge-service/web/test/main-card-return.test.ts b/apps/simplex-badge-service/web/test/main-card-return.test.ts index 53752dff42..b4277a9b59 100644 --- a/apps/simplex-badge-service/web/test/main-card-return.test.ts +++ b/apps/simplex-badge-service/web/test/main-card-return.test.ts @@ -37,6 +37,9 @@ returnTest("main: a card return resumes the exact order it was for, not the newe assert.ok(codeShape.test(screenOf(app).serialize()), "the code the buyer paid for is on it"); assert.ok(screenOf(app).serialize().includes(CODE), "and it is the code of inv_card, the order that was paid"); assert.ok(!screenOf(app).serialize().includes("48HqK2Xmv"), "not the newer open order's address"); + assert.ok(screenOf(app).textContent.includes("Settings → Supporter perks → Redeem code"), + "an order bought with no app flag ends as the page always has"); + assert.equal(screenOf(app).all("iframe").length, 0, "with no link to try"); }); returnTest("main: the return is spent — the URL is the order and the remembered id is cleared", () => { diff --git a/apps/simplex-badge-service/web/test/routing.test.ts b/apps/simplex-badge-service/web/test/routing.test.ts index 67ff1c2151..f4f704505a 100644 --- a/apps/simplex-badge-service/web/test/routing.test.ts +++ b/apps/simplex-badge-service/web/test/routing.test.ts @@ -1,6 +1,6 @@ import { timedTest } from "./boot.js"; import assert from "node:assert/strict"; -import { resolveLoad, screenForOpenOrder } from "../src/routing.js"; +import { appCodeLink, readHash, resolveLoad, screenForOpenOrder } from "../src/routing.js"; import { type OrderRecord } from "../src/domain.js"; import { Store } from "../src/store.js"; @@ -68,3 +68,20 @@ routingTest("routing: the flag survives clearSession, a second order and a reloa assert.equal(reloaded.order("inv_second")!.submitted, undefined, "and it did not spread to the order that followed it"); }); + +routingTest("routing: the app flag is read off the hash's tail, and the route is the hash without it", () => { + assert.deepEqual(readHash("#/tier?app=true"), { route: "#/tier", app: "mobile" }); + assert.deepEqual(readHash("#/tier?app=desktop"), { route: "#/tier", app: "desktop" }); + assert.deepEqual(readHash("#/tier"), { route: "#/tier", app: undefined }, "no tail, no flag"); + assert.deepEqual(readHash(""), { route: "", app: undefined }); +}); + +routingTest("routing: an app value outside the contract is no flag at all", () => { + for (const tail of ["app=", "app=false", "app=TRUE", "app=ios", "other=true"]) { + assert.deepEqual(readHash(`#/tier?${tail}`), { route: "#/tier", app: undefined }, tail); + } +}); + +routingTest("routing: the link back to the app is the simplexchat: scheme with the code as its last segment", () => { + assert.equal(appCodeLink("SB-YDC8A-YGQTM-PUYZ9-2TUXP"), "simplexchat:/badge/code/SB-YDC8A-YGQTM-PUYZ9-2TUXP"); +}); diff --git a/apps/simplex-badge-service/web/test/screens.test.ts b/apps/simplex-badge-service/web/test/screens.test.ts index efe74e6535..00bac7561c 100644 --- a/apps/simplex-badge-service/web/test/screens.test.ts +++ b/apps/simplex-badge-service/web/test/screens.test.ts @@ -688,6 +688,66 @@ domTest("screens: the code screen is the one screen that prints a code, with the assert.deepEqual(copied, [HELD_CODE]); }); +domTest("screens: opened from the desktop app, the code screen says the Redeem code screen is already open", () => { + const p = render(screens.codeIssued({ code: HELD_CODE, savedLocally: true, app: "desktop" })); + assert.ok(p.textContent.includes("Redeem it in the app")); + assert.ok(p.textContent.includes(screens.REDEEM_SCREEN_OPEN)); + assert.ok(!p.textContent.includes(screens.REDEEM_IN_SETTINGS), "one way to redeem, the one already on screen"); + assert.ok(p.textContent.includes(HELD_CODE), "and the code itself is unchanged"); +}); + +domTest("screens: the return-to-app ending opens on the tick, offers the link and Show code, and prints no code", () => { + let returned = 0; + let shown = 0; + const p = render(screens.returnToApp({ + onReturn: () => { returned += 1; }, + code: { kind: "hidden", onShow: () => { shown += 1; } }, + })); + assert.equal(p.children[0], p.all("div.tick")[0], "the payment went through, and this is the first thing that says so"); + assert.equal(p.all("div.tick")[0]!.textContent, "✓"); + assert.equal(p.all("h1")[0]!.textContent, "Paid"); + assert.ok(p.textContent.includes("Opening SimpleX to add your badge.")); + assert.ok(p.textContent.includes("If nothing happens, use the button.")); + assertNoCode(p, "the return-to-app ending"); + p.all("button.primary").find((b) => b.textContent === screens.RETURN_TO_APP)!.click(); + p.all("button.link").find((b) => b.textContent === screens.SHOW_CODE)!.click(); + assert.deepEqual([returned, shown], [1, 1]); +}); + +domTest("screens: Show code reveals the code in place, under a Return to SimpleX that stays, and with no QR", () => { + copied.length = 0; + let returned = 0; + const p = render(screens.returnToApp({ + onReturn: () => { returned += 1; }, + code: { kind: "shown", code: HELD_CODE, savedLocally: true }, + })); + assert.equal(p.all("h1")[0]!.textContent, "Paid", "the ending stays the ending"); + assert.equal(p.all("div.tick").length, 1); + assert.equal(p.all("div.code")[0]!.textContent, HELD_CODE); + assert.equal(p.all("button").filter((b) => b.textContent === screens.SHOW_CODE).length, 0, "Show code has given way"); + assert.equal(p.all("svg").filter((s) => s.getAttribute("class") === "qr").length, 0, + "the buyer is already on the phone, so there is nothing to scan it to"); + assert.ok(!p.textContent.includes("scan to carry it to your phone")); + for (const line of ["Redeem it in the app", screens.REDEEM_IN_SETTINGS, "This is the only copy.", + "Saved in this browser and nowhere else."]) { + assert.ok(p.textContent.includes(line), `the revealed code is missing: ${line}`); + } + + p.all("button.primary").find((b) => b.textContent === "Copy code")!.click(); + assert.deepEqual(copied, [HELD_CODE], "the copy control copies the code"); + p.all("button.primary").find((b) => b.textContent === screens.RETURN_TO_APP)!.click(); + assert.equal(returned, 1, "and the link is still one tap away"); +}); + +domTest("screens: the launcher is a hidden frame out of the tab order, pointed at the link", () => { + const f = render(screens.appLauncher("simplexchat:/badge/code/X")); + assert.equal(f.tagName, "iframe"); + assert.equal(f.getAttribute("src"), "simplexchat:/badge/code/X"); + assert.ok(f.hasAttribute("hidden")); + assert.equal(f.getAttribute("aria-hidden"), "true"); + assert.equal(f.getAttribute("tabindex"), "-1"); +}); + domTest("screens: the code screen drops its saved-copy clause where the local write failed", () => { const p = render(screens.codeIssued({ code: HELD_CODE, savedLocally: false })); assert.ok(p.textContent.includes("This code could not be saved in this browser.")); diff --git a/apps/simplex-badge-service/web/test/store.test.ts b/apps/simplex-badge-service/web/test/store.test.ts index d4e8c5a8c4..08ce22b8f5 100644 --- a/apps/simplex-badge-service/web/test/store.test.ts +++ b/apps/simplex-badge-service/web/test/store.test.ts @@ -190,6 +190,27 @@ storeTest("store: the two facts only this browser holds survive a write that omi assert.equal(s.order("1")!.submitted, true); }); +storeTest("store: the app that opened the page round-trips the session, and a value outside the contract reads as none", () => { + const mem = new MemoryStorage(); + const s = new Store(mem); + s.saveSession({ app: "mobile" }); + s.saveSession({ step: "months", priceId: "price_legend" }); + assert.equal(new Store(mem).session().app, "mobile", "a later step and a reload keep it"); + mem.setItem("sb.session.v1", JSON.stringify({ step: "tier", app: "true" })); + assert.equal(s.session().app, undefined, "the stored value is the page's own word, never the URL's"); +}); + +storeTest("store: an order keeps the app it was bought from through a write that omits it and a reload", () => { + const mem = new MemoryStorage(); + const s = new Store(mem); + s.saveOrder(order("1", { app: "desktop" })); + s.saveOrder(order("1", { status: "paid" })); + assert.equal(s.order("1")!.app, "desktop", "the service never sends it, so its answer cannot clear it"); + assert.equal(new Store(mem).order("1")!.app, "desktop"); + s.saveOrder(order("2")); + assert.equal(s.order("2")!.app, undefined, "and it is not a page-wide flag"); +}); + storeTest("store: markSubmitted is per order, sticky, and survives everything but Forget", () => { const mem = new MemoryStorage(); const s = new Store(mem); diff --git a/plans/2026-09-24-badge-buy-in-browser.md b/plans/2026-09-24-badge-buy-in-browser.md index 4dea4782f4..d0a4b9c18f 100644 --- a/plans/2026-09-24-badge-buy-in-browser.md +++ b/plans/2026-09-24-badge-buy-in-browser.md @@ -104,7 +104,7 @@ Default to none. Add one only where behaviour or a consequence cannot be carried ## Open questions -- **Will a browser follow the scheme without a gesture?** Safari and Chrome both block some automatic scheme navigations, and a blocked one can show an error page rather than nothing. *Return to SimpleX* exists for this; the question is only whether the automatic attempt is worth making. +- **Will a browser follow the scheme without a gesture?** The attempt is made from a hidden frame, so a refusal stays inside the frame instead of replacing the screen with an error page and putting the code into history. Expect it to do nothing on iOS Safari, which has ignored custom schemes in frames for years, and on Chrome, which blocks an external-protocol launch with no user gesture — and a payment settling minutes after the last tap has none. So *Return to SimpleX* is the real path and the automatic attempt is a bonus where it happens to work. What remains is to try it on real devices once the app registers the scheme. - **Where the browser button is allowed.** Which markets, and whether the same answer governs both builds. ## Part 2: subscriptions diff --git a/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw b/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw index 78f7d9987a..25caf53711 100644 --- a/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw +++ b/plans/sketches/2026-09-23-badge-in-app-checkout.excalidraw @@ -858,7 +858,7 @@ "lane1" ], "seed": 1203, - "text": "simplex.chat/badges/#app=true", + "text": "badges.simplex.chat/#/tier?app=true", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -880,7 +880,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "simplex.chat/badges/#app=true", + "originalText": "badges.simplex.chat/#/tier?app=true", "lineHeight": 1.3333333333333333 }, { @@ -1308,7 +1308,7 @@ "lane1" ], "seed": 1216, - "text": "The page's own second screen, quoted as it is. #app=true\nskips its Support SimpleX, which the app has just shown.\nNEW on the page: read that flag, start here, and remember it\nthrough the flow. The app builds the URL, so it can also say\nwhich kind of app it is - better than the page guessing from\nthe user agent (see lane C).", + "text": "The page's own second screen, quoted as it is. The flag\nin #/tier?app=true skips its Support SimpleX, which the\napp has just shown. NEW on the page: read that flag, start\nhere, and carry it: the session to checkout, then the order.\nThe app builds the URL, so it can also say which kind of\napp it is - better than guessing from the user agent.", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -1330,7 +1330,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "The page's own second screen, quoted as it is. #app=true\nskips its Support SimpleX, which the app has just shown.\nNEW on the page: read that flag, start here, and remember it\nthrough the flow. The app builds the URL, so it can also say\nwhich kind of app it is - better than the page guessing from\nthe user agent (see lane C).", + "originalText": "The page's own second screen, quoted as it is. The flag\nin #/tier?app=true skips its Support SimpleX, which the\napp has just shown. NEW on the page: read that flag, start\nhere, and carry it: the session to checkout, then the order.\nThe app builds the URL, so it can also say which kind of\napp it is - better than guessing from the user agent.", "lineHeight": 1.2222222222222223 }, { @@ -1423,7 +1423,7 @@ "lane1" ], "seed": 1303, - "text": "simplex.chat/badges/#app=true", + "text": "badges.simplex.chat/#/tier?app=true", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -1445,7 +1445,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "simplex.chat/badges/#app=true", + "originalText": "badges.simplex.chat/#/tier?app=true", "lineHeight": 1.3333333333333333 }, { @@ -2035,7 +2035,7 @@ "lane1" ], "seed": 1403, - "text": "simplex.chat/badges/?order=8f3a...#app=true", + "text": "badges.simplex.chat/?order=8f3a...", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -2057,7 +2057,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "simplex.chat/badges/?order=8f3a...#app=true", + "originalText": "badges.simplex.chat/?order=8f3a...", "lineHeight": 1.3333333333333333 }, { @@ -2687,7 +2687,7 @@ "lane1" ], "seed": 1503, - "text": "simplex.chat/badges/?order=8f3a...#app=true", + "text": "badges.simplex.chat/?order=8f3a...", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -2709,7 +2709,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "simplex.chat/badges/?order=8f3a...#app=true", + "originalText": "badges.simplex.chat/?order=8f3a...", "lineHeight": 1.3333333333333333 }, { @@ -3078,7 +3078,7 @@ "lane1" ], "seed": 1513, - "text": "Replaces codeIssued when #app=true. The code is still\nminted and still saved in the browser, so Show code\nrecovers it if the link fails. simplexchat: is a scheme of its\nown, registered everywhere including mobile, so a badge link\ncan never be read as a connection link. Whether a browser\nwill follow it with no tap is the open question.", + "text": "Replaces codeIssued for a mobile app purchase. The flag is\nnot in the URL here - it rode the session to checkout and is\nstamped on the order. The code is still minted and saved, so\nShow code recovers it if the link fails; a code that could\nnot be saved gets the plain screen instead. simplexchat: is a\nscheme of its own, so a badge link can never be read as a\nconnection link. The attempt is silent where it is blocked.", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -3100,7 +3100,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "Replaces codeIssued when #app=true. The code is still\nminted and still saved in the browser, so Show code\nrecovers it if the link fails. simplexchat: is a scheme of its\nown, registered everywhere including mobile, so a badge link\ncan never be read as a connection link. Whether a browser\nwill follow it with no tap is the open question.", + "originalText": "Replaces codeIssued for a mobile app purchase. The flag is\nnot in the URL here - it rode the session to checkout and is\nstamped on the order. The code is still minted and saved, so\nShow code recovers it if the link fails; a code that could\nnot be saved gets the plain screen instead. simplexchat: is a\nscheme of its own, so a badge link can never be read as a\nconnection link. The attempt is silent where it is blocked.", "lineHeight": 1.2222222222222223 }, { @@ -8510,7 +8510,7 @@ "lane3" ], "seed": 3203, - "text": "simplex.chat/badges/#app=desktop", + "text": "badges.simplex.chat/#/tier?app=desktop", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -8532,7 +8532,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "simplex.chat/badges/#app=desktop", + "originalText": "badges.simplex.chat/#/tier?app=desktop", "lineHeight": 1.3333333333333333 }, { @@ -8965,7 +8965,7 @@ "lane3" ], "seed": 3215, - "text": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so #app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets #app=true and the A5 screen instead.", + "text": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so ?app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets ?app=true and the A5 screen instead.", "fontSize": 9, "fontFamily": 2, "textAlign": "left", @@ -8987,7 +8987,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so #app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets #app=true and the A5 screen instead.", + "originalText": "codeIssued as it ships, with one line changed. The app builds\nthe URL, so ?app=desktop is a fact rather than a guess -\nbetter than sniffing the user agent, which cannot tell a\ndesktop browser opened by SimpleX from any other. Mobile\ngets ?app=true and the A5 screen instead.", "lineHeight": 1.4666666666666666 }, { @@ -9078,7 +9078,7 @@ "lane3" ], "seed": 3303, - "text": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? Safari and Chrome both refuse some scheme navigations that no user gesture asked for, and a refused one can show an error page rather\n than nothing. That is what Return to SimpleX is for, and why Show code sits under it - but it decides whether the automatic attempt is worth making at all.", + "text": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? The attempt is made from a hidden frame, so a refusal stays inside the frame rather than replacing the screen with an error page that would\n put the code into history. Expect nothing to happen on iOS Safari, which has ignored custom schemes in frames for years, nor on Chrome, which blocks a gestureless external-protocol\n launch - and a payment settling minutes after the last tap has no gesture. So Return to SimpleX is the real path. What is left is to try it on devices once the app registers the scheme.", "fontSize": 10, "fontFamily": 2, "textAlign": "left", @@ -9100,7 +9100,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? Safari and Chrome both refuse some scheme navigations that no user gesture asked for, and a refused one can show an error page rather\n than nothing. That is what Return to SimpleX is for, and why Show code sits under it - but it decides whether the automatic attempt is worth making at all.", + "originalText": "1. Desktop has no scheme handler today. Nothing in the desktop module registers one and nothing handles it: appOpenUrl is wired in commonMain but has no desktop plumbing, and\n desktop/build.gradle.kts declares only Deb, Dmg, Msi and Exe with no protocol entry. Adding one is per-OS work - CFBundleURLTypes plus setOpenURIHandler on macOS, registry keys\n the MSI would have to write on Windows, a .desktop file with x-scheme-handler/simplexchat on Linux - and it would still not cover an unpackaged run. Hence D1: desktop does not wait for it.\n\n2. Will a browser follow it without a tap? The attempt is made from a hidden frame, so a refusal stays inside the frame rather than replacing the screen with an error page that would\n put the code into history. Expect nothing to happen on iOS Safari, which has ignored custom schemes in frames for years, nor on Chrome, which blocks a gestureless external-protocol\n launch - and a payment settling minutes after the last tap has no gesture. So Return to SimpleX is the real path. What is left is to try it on devices once the app registers the scheme.", "lineHeight": 1.4444444444444444 }, { @@ -9191,7 +9191,7 @@ "lane3" ], "seed": 3403, - "text": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read ?app and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it; and for #app=desktop,\nkeep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", + "text": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read the app flag from the fragment and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it;\nand for ?app=desktop, keep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", "fontSize": 10, "fontFamily": 2, "textAlign": "left", @@ -9213,7 +9213,7 @@ "link": null, "locked": false, "containerId": null, - "originalText": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read ?app and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it; and for #app=desktop,\nkeep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", + "originalText": "The browser lane needs nothing from the service: the code purchase runs exactly as it ships, the browser mints the code and sends only its SHA-256, and the only reason the buyer\nnever sees one is that the link carries it instead of the screen. The store lane is the part that does need service work - purchaseBadge has to accept a store receipt and verify it,\nand no provider adapter for that exists today.\n\nThe page needs three things: read the app flag from the fragment and start at Choose your badge; at the end, try the deep link and offer Return to SimpleX with Show code under it;\nand for ?app=desktop, keep showing codeIssued as it does now.\n\nThe app needs: Buy in browser without its confirm alert; a handler for the new link; A6, a spinner around the existing apiRedeemBadgeCode; on desktop, opening Redeem code alongside\nthe browser; and for the store lane, B4's checkout and the two BadgeState outcomes behind B5.\n\nWhat it costs: the app cannot show a price before sending the buyer out, because it has no catalog - Buy in browser is a leap into a page. And the code still exists, so it can be\nintercepted, screenshotted from the backup button, or pasted somewhere else. Hidden is not the same as absent.", "lineHeight": 2 }, { From 36da024394cc9c1a643e1995018c300a19c4d889 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Tue, 29 Sep 2026 10:30:57 +0000 Subject: [PATCH 03/26] ui: buy a badge in the browser, with a deep link back on mobile (#7592) --- apps/ios/Shared/ContentView.swift | 25 +- apps/ios/Shared/SimpleXApp.swift | 3 +- apps/ios/Shared/Views/Badges/BadgeStore.swift | 3 + .../Views/Badges/BadgesRedeemCodeView.swift | 271 ++++++++++++++++-- .../Badges/BadgesSupportSimplexView.swift | 18 +- apps/ios/Shared/Views/Helpers/AppSheet.swift | 8 +- apps/ios/SimpleX--iOS--Info.plist | 10 + apps/ios/spec/client/navigation.md | 2 + .../android/src/main/AndroidManifest.xml | 9 + .../simplex/common/views/badges/BadgeStore.kt | 5 + .../views/badges/BadgesRedeemCodeView.kt | 265 ++++++++++++++--- .../views/badges/BadgesSupportSimplexView.kt | 28 +- .../common/views/chatlist/ChatListView.kt | 25 ++ .../simplex/common/views/helpers/ModalView.kt | 4 +- .../commonMain/resources/MR/base/strings.xml | 13 +- apps/multiplatform/spec/client/navigation.md | 6 + .../web/public/index.html | 10 +- .../web/public/styles.css | 4 + apps/simplex-badge-service/web/public/sw.js | 2 +- apps/simplex-badge-service/web/src/screens.ts | 5 +- .../web/test/screens.test.ts | 4 +- 21 files changed, 623 insertions(+), 97 deletions(-) diff --git a/apps/ios/Shared/ContentView.swift b/apps/ios/Shared/ContentView.swift index 22d0da3829..32dffbf2e2 100644 --- a/apps/ios/Shared/ContentView.swift +++ b/apps/ios/Shared/ContentView.swift @@ -461,9 +461,14 @@ struct ContentView: View { } func connectViaUrl_(_ url: URL) { + // an app link must not tear down a redemption in flight + if isAppLink(url) && isBadgeLinkIssuing() { return } dismissAllSheets() { var path = url.path - if path == "/r" { + if isAppLink(url) { + // branched on the scheme before the connection dispatch, which an app link must never reach + openAppLink(url) + } else if path == "/r" { showAlert( NSLocalizedString("Relay address", comment: "alert title"), message: NSLocalizedString("This is a chat relay address, it cannot be used to connect.", comment: "alert message") @@ -498,6 +503,24 @@ struct ContentView: View { } } +// the app's own scheme, for every link that is not a connection link, which stays on simplex: +private let appLinkScheme = "simplexchat" +private let badgeLinkPath = "/badge/code/" + +func isAppLink(_ url: URL) -> Bool { + url.scheme?.lowercased() == appLinkScheme +} + +// a link type added in a later version reaches this build too, so an unknown path asks for an update +private func openAppLink(_ url: URL) { + let path = url.path + if path.hasPrefix(badgeLinkPath) { + openBadgeLink(String(path.dropFirst(badgeLinkPath.count))) + } else { + AlertManager.shared.showAlert(Alert(title: Text("This link is not supported by this app version. Please check for app updates."))) + } +} + final class AlertManager: ObservableObject { static let shared = AlertManager() @Published var presentAlert = false diff --git a/apps/ios/Shared/SimpleXApp.swift b/apps/ios/Shared/SimpleXApp.swift index 1e9a97c31b..28aa7e4002 100644 --- a/apps/ios/Shared/SimpleXApp.swift +++ b/apps/ios/Shared/SimpleXApp.swift @@ -43,7 +43,8 @@ struct SimpleXApp: App { .environmentObject(chatModel) .environmentObject(AppTheme.shared) .onOpenURL { url in - logger.debug("ContentView.onOpenURL: \(url)") + // an app link can carry a secret, such as a badge code that anyone who reads it can redeem + logger.debug("ContentView.onOpenURL: \(isAppLink(url) ? "app link" : url.absoluteString)") if AppChatState.shared.value == .active { chatModel.appOpenUrl = url } else { diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index 8d092bbc19..c31e45439a 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -32,6 +32,9 @@ let badgeProductIds: [String] = BadgeLevel.allCases.flatMap { level in // which is how the service learns which invoice a store transaction settles. func newBadgeInvoiceId() -> UUID { UUID() } +// the page's app flag rides in the fragment, which never reaches the service +let badgePageUrl = "https://badges.simplex.chat/#/tier?app=true" + enum BadgePrice { case loading case price(String) diff --git a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift index 6ea0c58edb..ed53b21173 100644 --- a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift @@ -33,10 +33,43 @@ private func formatBadgeCodeInput(_ s: String) -> String { return groups.joined(separator: "-") } +enum BadgeRedeemOutcome { + case redeemed + case refused(message: String) + case cancelled +} + +// sets the badge before returning, so a caller that dismisses on .redeemed lands on Your Badge +// instead of showing the switch from Support. .cancelled when the user cancels the retry alert. +func redeemBadgeCode(_ user: User, _ code: String) async -> BadgeRedeemOutcome { + do { + guard let redeemed = try await apiRedeemBadgeCode(user.userId, code) else { return .cancelled } + return await MainActor.run { () -> BadgeRedeemOutcome in + BadgeModel.shared.set(userId: user.userId, badgeState: redeemed.badgeState) + ChatModel.shared.updateUser(redeemed.user) + if let badgeState = redeemed.badgeState, !badgeState.shown { + // a replay adds no purchase; a fresh code's badge can be retired on arrival + return .refused(message: redeemed.newBadge + ? NSLocalizedString("The code was accepted, but the badge it grants has already ended.", comment: "alert message") + : NSLocalizedString("This code has already been used.", comment: "alert message") + ) + } + UserDefaults.standard.set(true, forKey: DEFAULT_SUPPORTER_BANNER_SHOWN) + return .redeemed + } + } catch let error { + logger.error("apiRedeemBadgeCode: \(responseError(error))") + return .refused(message: redeemErrorText(error)) + } +} + +func showCannotRedeemAlert(_ message: String) { + showAlert(NSLocalizedString("Cannot redeem code", comment: "alert title"), message: message) +} + struct BadgesRedeemCodeView: View { @EnvironmentObject var theme: AppTheme @EnvironmentObject var chatModel: ChatModel - @AppStorage(DEFAULT_SUPPORTER_BANNER_SHOWN) private var supporterBannerShown = false @Environment(\.dismiss) var dismiss: DismissAction @State private var code = "" @State private var canonicalCode: String? = nil @@ -184,39 +217,221 @@ struct BadgesRedeemCodeView: View { guard let sending = canonicalCode, let user = chatModel.currentUser else { return } submitting = true Task { - do { - guard let redeemed = try await apiRedeemBadgeCode(user.userId, sending) else { - await MainActor.run { submitting = false } - return - } - await MainActor.run { - submitting = false - // set before dismissing: BadgesView then switches Support to Your Badge while this screen - // still covers it, so the pop lands on Your Badge instead of showing the switch - BadgeModel.shared.set(userId: user.userId, badgeState: redeemed.badgeState) - chatModel.updateUser(redeemed.user) - if let badgeState = redeemed.badgeState, !badgeState.shown { - // a replay adds no purchase; a fresh code's badge can be retired on arrival - let message = redeemed.newBadge - ? NSLocalizedString("The code was accepted, but the badge it grants has already ended.", comment: "alert message") - : NSLocalizedString("This code has already been used.", comment: "alert message") - showAlert(NSLocalizedString("Cannot redeem code", comment: "alert title"), message: message) - } else { - supporterBannerShown = true - dismiss() - } - } - } catch let error { - logger.error("apiRedeemBadgeCode: \(responseError(error))") - await MainActor.run { - submitting = false - showAlert(NSLocalizedString("Cannot redeem code", comment: "alert title"), message: redeemErrorText(error)) + let outcome = await redeemBadgeCode(user, sending) + await MainActor.run { + submitting = false + switch outcome { + case .redeemed: dismiss() + case let .refused(message): showCannotRedeemAlert(message) + case .cancelled: break } } } } } +private weak var badgeLinkSheet: UIViewController? +// the open screen's own state, not a copy of its step, so the two cannot disagree +private weak var badgeLinkState: BadgeLinkState? + +func isBadgeLinkIssuing() -> Bool { + badgeLinkSheet?.presentingViewController != nil && badgeLinkState?.step == .issuing +} + +func openBadgeLink(_ codeText: String) { + guard let code = parseBadgeCode(codeText) else { + return showCannotRedeemAlert(NSLocalizedString("This code is not valid.", comment: "alert message")) + } + let state = BadgeLinkState() + badgeLinkSheet = showAppSheet { + NavigationView { + BadgesRedeemLinkView(code: code, state: state) + .modifier(ThemedBackground()) + } + } + badgeLinkState = state +} + +enum BadgeLinkStep { + case confirming + case issuing + case redeemed + case viewingBadge +} + +final class BadgeLinkState: ObservableObject { + @Published var step = BadgeLinkStep.confirming +} + +// Any web page can send a badge link, and a profile holds one badge at a time, +// so this screen asks before redeeming, names the profile, and offers nothing but the redemption. +// It is a code redemption with the code hidden, so it inherits the redeem screen's behaviour: an +// interrupted request is not resumed, and the code stays on the page that issued the link. +struct BadgesRedeemLinkView: View { + @EnvironmentObject var theme: AppTheme + @EnvironmentObject var chatModel: ChatModel + @ObservedObject private var badgeModel = BadgeModel.shared + let code: String + @ObservedObject var state: BadgeLinkState + + var body: some View { + switch state.step { + case .confirming: if profileHasBadge { badgeHeld() } else { confirming() } + case .issuing: beingIssued() + case .redeemed, .viewingBadge: BadgesView(showsAsSheet: true) + } + } + + // read for the profile the screen names, when it renders, so the two cannot disagree; + // core refuses a code while the profile shows a badge + private var profileHasBadge: Bool { + badgeModel.userId == chatModel.currentUser?.userId && badgeModel.badgeState?.shown == true + } + + // the screen cannot tell a repeated link for the badge it shows from a code for another badge, + // so it asserts neither + private func badgeHeld() -> some View { + linkStep( + "Profile already has a badge", + primary: ("View your badge", { state.step = .viewingBadge }), + textButton: ("Cancel", { closeIfShowing() }) + ) { + linkText(NSLocalizedString("A badge can be added to another profile, or here once this badge ends.", comment: "badge link, profile has a badge")) + linkText(NSLocalizedString("Its code is on the page you bought it on, under Show code.", comment: "badge link, profile has a badge")) + } + } + + private func confirming() -> some View { + linkStep( + "Add badge to your profile?", + primary: ("Add badge", { redeemFromLink() }), + textButton: ("Cancel", { closeIfShowing() }) + ) { + linkText(String.localizedStringWithFormat(NSLocalizedString("The badge will be added to the profile %@.", comment: "badge link confirmation"), chatModel.currentUser?.displayName ?? "")) + } + } + + // leaving does not cancel: the badge is still added after the screen closes + private func beingIssued() -> some View { + linkStep("Badge is being issued", textButton: ("Dismiss", { closeIfShowing() })) { + Spacer() + ProgressView().scaleEffect(2) + } + } + + // with no primary, the text button takes its place, so a button does not move between steps + private func linkStep( + _ title: LocalizedStringKey, + primary: (label: LocalizedStringKey, action: () -> Void)? = nil, + textButton: (label: LocalizedStringKey, action: () -> Void), + @ViewBuilder content: () -> Content + ) -> some View { + let textButtonLabel = Text(textButton.label) + .font(.body) + .fontWeight(.medium) + .foregroundColor(theme.colors.primary) + return VStack(alignment: .center, spacing: 16) { + Text(title) + .font(.largeTitle) + .bold() + .foregroundColor(theme.colors.primary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + + content() + + Spacer() + + VStack(spacing: 10) { + if let primary { + Button { + primary.action() + } label: { + Text(primary.label) + } + .buttonStyle(OnboardingButtonStyle(isDisabled: false)) + .padding(.vertical, 10) + + Button { + textButton.action() + } label: { + textButtonLabel + } + .frame(height: 22) + } else { + Button { + textButton.action() + } label: { + // the inset OnboardingButtonStyle gives a primary + textButtonLabel.padding() + } + .padding(.vertical, 10) + Color.clear + .frame(height: 22) + } + } + } + .padding(.horizontal, 25) + .padding(.top, 48) + .padding(.bottom, 20) + .frame(maxHeight: .infinity) + .navigationBarTitleDisplayMode(.inline) + } + + private func linkText(_ text: String) -> some View { + Text(text) + .font(.body) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + } + + private func redeemFromLink() { + // a second tap before the screen changes must not send the code again + guard state.step == .confirming else { return } + guard let user = chatModel.currentUser else { return closeIfShowing() } + state.step = .issuing + Task { + let outcome = await redeemBadgeCode(user, code) + await MainActor.run { + switch outcome { + case .redeemed: + if !isShowing { + showAlert( + NSLocalizedString("Badge added", comment: "alert title"), + message: String.localizedStringWithFormat(NSLocalizedString("The badge was added to the profile %@.", comment: "alert message"), user.displayName) + ) + } + // a covered screen is not left on the spinner; a closed one is not written to + if isOpen { state.step = .redeemed } + case let .refused(message): closeIfShowing { showCannotRedeemAlert(message) } + case .cancelled: closeIfShowing() + } + } + } + } + + private var isOpen: Bool { + badgeLinkState === state && badgeLinkSheet?.presentingViewController != nil + } + + // an alert over this screen still counts: dismissing from the presenter dismisses it too + private var isShowing: Bool { + guard isOpen, let sheet = badgeLinkSheet else { return false } + return sheet.presentedViewController == nil || sheet.presentedViewController is UIAlertController + } + + // An outcome can arrive after this screen was closed or covered: it must not close another screen, + // and a covered one goes back to asking, so it is never left locked on the spinner. + private func closeIfShowing(then: @escaping () -> Void = {}) { + if isShowing, let presenter = badgeLinkSheet?.presentingViewController { + presenter.dismiss(animated: true, completion: then) + } else { + if isOpen { state.step = .confirming } + then() + } + } +} + struct BadgesRedeemCodeView_Previews: PreviewProvider { static var previews: some View { NavigationView { diff --git a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift index 44b1e48be1..22cec4a4f4 100644 --- a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift @@ -47,9 +47,9 @@ struct BadgesSupportSimplexView: View { Spacer(minLength: 0) VStack(spacing: 10) { - redeemCodeButton() + buyInBrowserButton() .padding(.vertical, 10) - getCodeButton() + redeemCodeButton() .frame(height: 22) } .padding(.bottom, g.safeAreaInsets.bottom == 0 ? 20 : 0) @@ -131,8 +131,10 @@ struct BadgesSupportSimplexView: View { redeemCodeActive = true } label: { Text("Redeem badge code") + .font(.body) + .fontWeight(.medium) + .foregroundColor(theme.colors.primary) } - .buttonStyle(OnboardingButtonStyle(isDisabled: false)) NavigationLink(isActive: $redeemCodeActive) { BadgesRedeemCodeView() @@ -145,15 +147,13 @@ struct BadgesSupportSimplexView: View { } } - private func getCodeButton() -> some View { + private func buyInBrowserButton() -> some View { Button { - openExternalLink(URL(string: "https://simplex.chat/badges/")!) + UIApplication.shared.open(URL(string: badgePageUrl)!) } label: { - Text("Get your code") - .font(.body) - .fontWeight(.medium) - .foregroundColor(theme.colors.primary) + Text("Buy in browser") } + .buttonStyle(OnboardingButtonStyle(isDisabled: false)) } } diff --git a/apps/ios/Shared/Views/Helpers/AppSheet.swift b/apps/ios/Shared/Views/Helpers/AppSheet.swift index 51ae63f07e..d505cdead7 100644 --- a/apps/ios/Shared/Views/Helpers/AppSheet.swift +++ b/apps/ios/Shared/Views/Helpers/AppSheet.swift @@ -31,14 +31,18 @@ private struct PrivacySensitive: ViewModifier { // Presented from the top view controller instead of a .sheet on a parent view, so an alert button or // a view that is itself in a sheet can open it. -func showAppSheet(@ViewBuilder content: () -> Content) { +@discardableResult +func showAppSheet(@ViewBuilder content: () -> Content) -> UIViewController? { if let topController = getTopViewController() { let v = content() .modifier(PrivacySensitive()) .environmentObject(ChatModel.shared) .environmentObject(AppTheme.shared) - topController.present(UIHostingController(rootView: v), animated: true) + let sheet = UIHostingController(rootView: v) + topController.present(sheet, animated: true) + return sheet } + return nil } extension View { diff --git a/apps/ios/SimpleX--iOS--Info.plist b/apps/ios/SimpleX--iOS--Info.plist index 72bd9b0dc3..06edbf9ce9 100644 --- a/apps/ios/SimpleX--iOS--Info.plist +++ b/apps/ios/SimpleX--iOS--Info.plist @@ -42,6 +42,16 @@ simplex + + CFBundleTypeRole + Editor + CFBundleURLName + chat.simplex.app.deeplink + CFBundleURLSchemes + + simplexchat + + ITSAppUsesNonExemptEncryption diff --git a/apps/ios/spec/client/navigation.md b/apps/ios/spec/client/navigation.md index 64d0940e39..329f764efa 100644 --- a/apps/ios/spec/client/navigation.md +++ b/apps/ios/spec/client/navigation.md @@ -200,6 +200,8 @@ SimpleX links (`simplex:/chat#...`) are handled via [`connectViaUrl()`](../../Sh URL processing routes to the appropriate connection flow (join group, add contact, etc.) via [`planAndConnect()`](../../Shared/Views/NewChat/NewChatView.swift#L1181). +App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectViaUrl_()` branches on that scheme before the path switch, so an app link never reaches `planAndConnect()`, and `openAppLink()` dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to `openBadgeLink()` in [`BadgesRedeemCodeView.swift`](../../Shared/Views/Badges/BadgesRedeemCodeView.swift), which presents `BadgesRedeemLinkView` as an app sheet. The sheet names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the sheet renders), which core would refuse, the sheet does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or a swipe closes the sheet without cancelling anything; if the redemption then succeeds with the sheet closed or covered, an alert says the badge was added. While the sheet shows a redemption in flight (`isBadgeLinkIssuing()`), `connectViaUrl_()` ignores a further app link; otherwise it dismisses the sheets as for any link, which replaces an earlier badge link sheet. Any other path is a link type from a later version, and gets an alert asking to check for app updates. An app link can carry a secret, so `onOpenURL` logs it as "app link" rather than the URL. + ### Call Deep Link Call invitations from notifications: diff --git a/apps/multiplatform/android/src/main/AndroidManifest.xml b/apps/multiplatform/android/src/main/AndroidManifest.xml index 9e059afa14..c2c789f998 100644 --- a/apps/multiplatform/android/src/main/AndroidManifest.xml +++ b/apps/multiplatform/android/src/main/AndroidManifest.xml @@ -70,6 +70,15 @@ + + + + + + + + + diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index f8a37c39a7..2c7dfd05f6 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -34,6 +34,11 @@ val badgeStoreProductIds: List = BadgeLevel.entries.flatMap // learns which invoice a store transaction settles. fun newBadgeInvoiceId(): String = UUID.randomUUID().toString() +// the page's app flag rides in the fragment, which never reaches the service +val badgePageUrl: String = + if (appPlatform.isAndroid) "https://badges.simplex.chat/#/tier?app=true" + else "https://badges.simplex.chat/#/tier?app=desktop" + // what the platform store knows about one product; ProductDetails cannot cross into commonMain data class BadgeProduct( val id: BadgeStoreProductId, diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt index 9ebaf9bcdc..7494229aaa 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt @@ -21,6 +21,7 @@ import androidx.compose.ui.text.input.KeyboardCapitalization import androidx.compose.ui.text.input.TextFieldValue import androidx.compose.ui.text.style.TextAlign import androidx.compose.ui.unit.dp +import dev.icerock.moko.resources.StringResource import dev.icerock.moko.resources.compose.stringResource import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.withContext @@ -57,10 +58,44 @@ private fun formatBadgeCodeInput(s: String): String { return groups.joinToString("-") } +sealed class BadgeRedeemOutcome { + object Redeemed: BadgeRedeemOutcome() + class Refused(val message: String): BadgeRedeemOutcome() + object Cancelled: BadgeRedeemOutcome() +} + +// sets the badge before returning, so a caller that dismisses on Redeemed lands on Your Badge +// instead of showing the switch from Support. Cancelled when the user cancels the retry alert. +suspend fun redeemBadgeCode(rhId: Long?, user: User, code: String): BadgeRedeemOutcome = + when (val result = chatModel.controller.apiRedeemBadgeCode(rhId, user.userId, code)) { + null -> BadgeRedeemOutcome.Cancelled + is BadgeRedeemResult.Redeemed -> withContext(Dispatchers.Main) { + val badgeState = result.badgeState + BadgeModel.set(rhId, user.userId, badgeState) + chatModel.updateUser(result.user) + if (badgeState != null && !badgeState.shown) { + // a replay adds no purchase; a fresh code's badge can be retired on arrival + BadgeRedeemOutcome.Refused( + generalGetString(if (result.newBadge) MR.strings.badges_error_badge_ended else MR.strings.badges_error_code_used) + ) + } else { + appPrefs.supporterBannerShown.set(true) + BadgeRedeemOutcome.Redeemed + } + } + is BadgeRedeemResult.Failed -> { + Log.e(TAG, "apiRedeemBadgeCode: ${result.err?.string}") + BadgeRedeemOutcome.Refused(chatModel.controller.redeemErrorText(result.err)) + } + } + +fun showCannotRedeemAlert(message: String) { + AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.badges_error_title), text = message) +} + @Composable fun BadgesRedeemCodeView(modalManager: ModalManager) { val rhId = remember { chatModel.remoteHostId() } - val supporterBannerShown = remember { appPrefs.supporterBannerShown } val code = remember { mutableStateOf(TextFieldValue("")) } val canonicalCode = remember { mutableStateOf(null) } val submitting = remember { mutableStateOf(false) } @@ -78,37 +113,13 @@ fun BadgesRedeemCodeView(modalManager: ModalManager) { val user = chatModel.currentUser.value ?: return submitting.value = true withBGApi { - when (val result = chatModel.controller.apiRedeemBadgeCode(rhId, user.userId, sending)) { - null -> withContext(Dispatchers.Main) { submitting.value = false } - is BadgeRedeemResult.Redeemed -> { - val badgeState = result.badgeState - withContext(Dispatchers.Main) { - submitting.value = false - // set before dismissing: BadgesView then switches Support to Your Badge while this screen - // still covers it, so the pop lands on Your Badge instead of showing the switch - BadgeModel.set(rhId, user.userId, badgeState) - chatModel.updateUser(result.user) - if (badgeState != null && !badgeState.shown) { - // a replay adds no purchase; a fresh code's badge can be retired on arrival - AlertManager.shared.showAlertMsg( - title = generalGetString(MR.strings.badges_error_title), - text = generalGetString(if (result.newBadge) MR.strings.badges_error_badge_ended else MR.strings.badges_error_code_used) - ) - } else { - supporterBannerShown.set(true) - modalManager.closeModal() - } - } - } - is BadgeRedeemResult.Failed -> { - Log.e(TAG, "apiRedeemBadgeCode: ${result.err?.string}") - withContext(Dispatchers.Main) { - submitting.value = false - AlertManager.shared.showAlertMsg( - title = generalGetString(MR.strings.badges_error_title), - text = chatModel.controller.redeemErrorText(result.err) - ) - } + val outcome = redeemBadgeCode(rhId, user, sending) + withContext(Dispatchers.Main) { + submitting.value = false + when (outcome) { + is BadgeRedeemOutcome.Redeemed -> modalManager.closeModal() + is BadgeRedeemOutcome.Refused -> showCannotRedeemAlert(outcome.message) + is BadgeRedeemOutcome.Cancelled -> {} } } } @@ -244,3 +255,193 @@ private fun SubmitButton(enabled: Boolean, onClick: () -> Unit) { onclick = onClick ) } + +// the open screen's own state, not a copy of its step, so the two cannot disagree +private var badgeLinkStep: MutableState? = null + +private fun isBadgeLinkOpen(): Boolean = + ModalManager.end.hasModalOpen(ModalViewId.BADGE_LINK) + +fun isBadgeLinkIssuing(): Boolean = + isBadgeLinkOpen() && badgeLinkStep?.value == BadgeLinkStep.Issuing + +fun openBadgeLink(rhId: Long?, codeText: String) { + val code = parseBadgeCode(codeText) + ?: return showCannotRedeemAlert(generalGetString(MR.strings.badges_error_invalid_code)) + // opens over the chat list, as iOS dismisses every sheet before a link + ModalManager.closeAllModalsEverywhere() + // held by the modal, not remembered: a modal is composed only while on top, and rotation recreates the activity, + // either of which would reset remembered state to Confirming with a request in flight + val step = mutableStateOf(BadgeLinkStep.Confirming) + ModalManager.end.showCustomModal(id = ModalViewId.BADGE_LINK) { close -> + BadgesRedeemLinkView(rhId, code, step, close) + } + badgeLinkStep = step +} + +enum class BadgeLinkStep { + Confirming, + Issuing, + Redeemed, + ViewingBadge +} + +// Any web page can send a badge link, and a profile holds one badge at a time, +// so this screen asks before redeeming, names the profile, and offers nothing but the redemption. +// It is a code redemption with the code hidden, so it inherits the redeem screen's behaviour: an +// interrupted request is not resumed, and the code stays on the page that issued the link. +@Composable +fun BadgesRedeemLinkView(rhId: Long?, code: String, step: MutableState, close: () -> Unit) { + fun isOpen(): Boolean = + badgeLinkStep === step && isBadgeLinkOpen() + + fun isShowing(): Boolean = + isOpen() && ModalManager.end.isLastModalOpen(ModalViewId.BADGE_LINK) + + // An outcome can arrive after this screen was closed or covered: it must not close another screen, + // and a covered one goes back to asking, so it is never left locked on the spinner. + fun closeIfShowing() { + if (isShowing()) { + close() + } else if (isOpen()) { + step.value = BadgeLinkStep.Confirming + } + } + + fun redeemFromLink() { + // a second tap before the screen changes must not send the code again + if (step.value != BadgeLinkStep.Confirming) return + val user = chatModel.currentUser.value ?: return closeIfShowing() + step.value = BadgeLinkStep.Issuing + withBGApi { + val outcome = redeemBadgeCode(rhId, user, code) + withContext(Dispatchers.Main) { + when (outcome) { + is BadgeRedeemOutcome.Redeemed -> { + if (!isShowing()) { + AlertManager.shared.showAlertMsg( + title = generalGetString(MR.strings.badges_link_added_title), + text = String.format(generalGetString(MR.strings.badges_link_added_profile), user.displayName) + ) + } + // a covered screen is not left on the spinner; a closed one is not written to + if (isOpen()) step.value = BadgeLinkStep.Redeemed + } + is BadgeRedeemOutcome.Refused -> { + closeIfShowing() + showCannotRedeemAlert(outcome.message) + } + is BadgeRedeemOutcome.Cancelled -> closeIfShowing() + } + } + } + } + + // read for the profile the screen names, when it renders, so the two cannot disagree; + // core refuses a code while the profile shows a badge + val profileHasBadge = BadgeModel.isCurrent(rhId, chatModel.currentUser.value?.userId) && BadgeModel.badgeState.value?.shown == true + + when (step.value) { + BadgeLinkStep.Confirming -> ModalView(::closeIfShowing) { + if (profileHasBadge) { + BadgeHeld(onViewBadge = { step.value = BadgeLinkStep.ViewingBadge }, onCancel = ::closeIfShowing) + } else { + Confirming(onConfirm = ::redeemFromLink, onCancel = ::closeIfShowing) + } + } + BadgeLinkStep.Issuing -> ModalView(::closeIfShowing) { BeingIssued(onDismiss = ::closeIfShowing) } + BadgeLinkStep.Redeemed, BadgeLinkStep.ViewingBadge -> BadgesView(ModalManager.end, close) + } +} + +// the screen cannot tell a repeated link for the badge it shows from a code for another badge, +// so it asserts neither +@Composable +private fun BadgeHeld(onViewBadge: () -> Unit, onCancel: () -> Unit) { + LinkStep( + MR.strings.badges_link_held_title, + primary = MR.strings.badges_link_view_badge to onViewBadge, + textButton = MR.strings.cancel_verb to onCancel + ) { + LinkText(stringResource(MR.strings.badges_link_held_other_profile)) + LinkText(stringResource(MR.strings.badges_link_held_page)) + } +} + +@Composable +private fun Confirming(onConfirm: () -> Unit, onCancel: () -> Unit) { + LinkStep( + MR.strings.badges_link_confirm_title, + primary = MR.strings.badges_link_add_badge to onConfirm, + textButton = MR.strings.cancel_verb to onCancel + ) { + LinkText(String.format(stringResource(MR.strings.badges_link_confirm_profile), chatModel.currentUser.value?.displayName ?: "")) + } +} + +// leaving does not cancel: the badge is still added after the screen closes +@Composable +private fun BeingIssued(onDismiss: () -> Unit) { + LinkStep(MR.strings.badges_being_issued, textButton = MR.strings.badges_dismiss to onDismiss) { + Spacer(Modifier.weight(1f)) + CircularProgressIndicator( + Modifier.size(30.dp), + color = MaterialTheme.colors.secondary, + strokeWidth = 3.dp + ) + } +} + +// with no primary, the text button takes its place, so a button does not move between steps +@Composable +private fun LinkStep( + title: StringResource, + primary: Pair Unit>? = null, + textButton: Pair Unit>, + content: @Composable ColumnScope.() -> Unit +) { + ColumnWithScrollBar( + Modifier.padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), + verticalArrangement = Arrangement.spacedBy(16.dp), + horizontalAlignment = Alignment.CenterHorizontally, + maxIntrinsicSize = true, + ) { + Text( + stringResource(title), + style = MaterialTheme.typography.h1, + fontWeight = FontWeight.Bold, + color = MaterialTheme.colors.primary, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + + content() + + Spacer(Modifier.weight(1f)) + + Column(horizontalAlignment = Alignment.CenterHorizontally) { + if (primary != null) { + OnboardingActionButton( + modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), + labelId = primary.first, + onboarding = null, + onclick = primary.second + ) + TextButtonBelowOnboardingButton(stringResource(textButton.first), textButton.second) + } else { + TextButtonBelowOnboardingButton(stringResource(textButton.first), textButton.second) + TextButtonBelowOnboardingButton("", null) + } + } + } +} + +@Composable +private fun LinkText(text: String) { + Text( + text, + style = MaterialTheme.typography.body1, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) +} diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt index 7fa32edaf3..dc65897547 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt @@ -66,8 +66,8 @@ fun BadgesSupportSimplexView(modalManager: ModalManager) { Spacer(Modifier.weight(1f)) Column(horizontalAlignment = Alignment.CenterHorizontally) { + BuyInBrowserButton(modalManager) RedeemCodeButton(modalManager) - GetCodeButton() } } } @@ -112,22 +112,26 @@ private fun HowItWorksButton(modalManager: ModalManager) { @Composable private fun RedeemCodeButton(modalManager: ModalManager) { - OnboardingActionButton( - modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), - labelId = MR.strings.badges_redeem_code_button, - onboarding = null, - onclick = { - modalManager.showModal { BadgesRedeemCodeView(modalManager) } - } + TextButtonBelowOnboardingButton( + text = stringResource(MR.strings.badges_redeem_code_button), + onClick = { modalManager.showModal { BadgesRedeemCodeView(modalManager) } } ) } @Composable -private fun GetCodeButton() { +private fun BuyInBrowserButton(modalManager: ModalManager) { val uriHandler = LocalUriHandler.current - TextButtonBelowOnboardingButton( - text = stringResource(MR.strings.badges_get_your_code), - onClick = { uriHandler.openExternalLink("https://simplex.chat/badges/") } + OnboardingActionButton( + modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), + labelId = MR.strings.badges_buy_in_browser, + onboarding = null, + onclick = { + uriHandler.openUriCatching(badgePageUrl) + // desktop has no scheme to bring the code back, so the code is pasted into this screen, opened beside the browser + if (appPlatform.isDesktop && !modalManager.hasModalOpen(ModalViewId.BADGE_REDEEM_CODE)) { + modalManager.showModal(id = ModalViewId.BADGE_REDEEM_CODE) { BadgesRedeemCodeView(modalManager) } + } + } ) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt index fae1b7c155..5fe3b7d5f6 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt @@ -776,6 +776,10 @@ fun connectIfOpenedViaUri(rhId: Long?, uri: String, chatModel: ChatModel) { Log.d(TAG, "connectIfOpenedViaUri: opened via link") if (chatModel.currentUser.value == null) { chatModel.appOpenUrl.value = rhId to uri + } else if (isAppLink(uri)) { + // branched on the scheme before the connection dispatch, which an app link must never reach + // an app link must not tear down a redemption in flight + if (!isBadgeLinkIssuing()) openAppLink(rhId, uri) } else { withBGApi { chatModel.appOpenUrlConnecting.value = true @@ -784,6 +788,27 @@ fun connectIfOpenedViaUri(rhId: Long?, uri: String, chatModel: ChatModel) { } } +// the app's own scheme, for every link that is not a connection link, which stays on simplex: +private const val appLinkScheme = "simplexchat" +private const val badgeLinkPath = "/badge/code/" + +// the prefix of the raw text, not a parsed URI: a link that does not parse is still an app link +fun isAppLink(uri: String): Boolean = + uri.startsWith("$appLinkScheme:", ignoreCase = true) + +// a link type added in a later version reaches this build too, so an unknown path asks for an update +private fun openAppLink(rhId: Long?, uri: String) { + // a link that does not parse is dropped, as iOS never receives one; one that parses without + // a path, such as simplexchat:badge/code/X, is an unknown link on both platforms + val parsed = uriCreateOrNull(uri) ?: return + val path = parsed.path ?: "" + if (path.startsWith(badgeLinkPath)) { + openBadgeLink(rhId, path.removePrefix(badgeLinkPath)) + } else { + AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.app_link_not_supported)) + } +} + @Composable private fun ChatListSearchBar(listState: LazyListState, searchText: MutableState, searchShowingSimplexLink: MutableState, searchChatFilteredBySimplexLink: MutableState>, connectNameCandidate: MutableState) { Box { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt index 02c0b45de4..0511bb1cba 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt @@ -91,7 +91,9 @@ class ModalData(val keyboardCoversBar: Boolean = true) { enum class ModalViewId { SECONDARY_CHAT, - CONTEXT_USER_PICKER_INCOGNITO + CONTEXT_USER_PICKER_INCOGNITO, + BADGE_LINK, + BADGE_REDEEM_CODE } class ModalManager(private val placement: ModalPlacement? = null) { diff --git a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml index 82dfe5152e..957160041b 100644 --- a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml +++ b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml @@ -25,6 +25,7 @@ You are an owner Invalid link Please check that SimpleX link is correct. + This link is not supported by this app version. Please check for app updates. Opening database… @@ -3182,8 +3183,18 @@ Purchase pending The purchase is awaiting approval. This build does not deliver purchases approved later. Purchase error - Get your code + Buy in browser Redeem code + Add badge to your profile? + The badge will be added to the profile %1$s. + Add badge + Profile already has a badge + A badge can be added to another profile, or here once this badge ends. + Its code is on the page you bought it on, under Show code. + View your badge + Badge is being issued + Badge added + The badge was added to the profile %1$s. Paste the code you received. SB-XXXXX-XXXXX-XXXXX-XXXXX Redeem diff --git a/apps/multiplatform/spec/client/navigation.md b/apps/multiplatform/spec/client/navigation.md index 34a3b502ee..427e31d9d8 100644 --- a/apps/multiplatform/spec/client/navigation.md +++ b/apps/multiplatform/spec/client/navigation.md @@ -107,6 +107,12 @@ When onboarding is complete: 1. Shows "advertise lock" alert if conditions met (not shown before, LA not enabled, >3 chats, no active call). 2. Routes to `AndroidScreen` or `DesktopScreen` based on platform. +### URL Deep Link + +On Android, [`processIntent()`](../../android/src/main/java/chat/simplex/app/MainActivity.kt#L144) puts the URI of a VIEW intent into `chatModel.appOpenUrl`. Once onboarding is complete, a `LaunchedEffect` in `MainScreen` ([`App.kt`](../../common/src/commonMain/kotlin/chat/simplex/common/App.kt#L241)) hands it to [`connectIfOpenedViaUri()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L775), which re-queues it while no profile is active. Desktop registers no URL scheme. + +App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectIfOpenedViaUri()` branches on that scheme before the connection dispatch, so an app link never reaches `planAndConnect()`. [`isAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L796) tests the raw prefix, since text that does not parse as a URI is still an app link, and [`openAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L800) dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to [`openBadgeLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L268), which shows `BadgesRedeemLinkView` as a `ModalManager.end` modal with `ModalViewId.BADGE_LINK`. Once the code parses, every modal is closed first, so the screen opens over the chat list, as iOS dismisses every sheet before a link; a code that does not parse gets an alert and closes nothing. The screen names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the screen composes), which core would refuse, the screen does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or back closes the screen without cancelling anything; if the redemption then succeeds with the screen closed or covered, an alert says the badge was added. Its step is held by the modal rather than remembered by the composition, so rotation and being covered do not reset it. While the screen shows a redemption in flight ([`isBadgeLinkIssuing()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L265)), a further app link is ignored. Any other path is a link type from a later version, and gets an alert asking to check for app updates; text that does not parse is dropped. An app link can carry a secret, and nothing on this path logs the URI: `processIntent()` logs nothing, and `connectIfOpenedViaUri()` logs a fixed string. + ### Overlay Layers (bottom of MainScreen) | Layer | Condition | Content | diff --git a/apps/simplex-badge-service/web/public/index.html b/apps/simplex-badge-service/web/public/index.html index 6caac72b84..9885481483 100644 --- a/apps/simplex-badge-service/web/public/index.html +++ b/apps/simplex-badge-service/web/public/index.html @@ -20,17 +20,17 @@ Support SimpleX - - + + - + - + - + diff --git a/apps/simplex-badge-service/web/public/styles.css b/apps/simplex-badge-service/web/public/styles.css index 2fee434fcd..760cc259e7 100644 --- a/apps/simplex-badge-service/web/public/styles.css +++ b/apps/simplex-badge-service/web/public/styles.css @@ -477,6 +477,10 @@ footer a:hover { text-decoration: underline; } .panel > .primary { margin-top: auto; } .panel > .notes { margin-top: auto; } .notes + .primary { margin-top: 20px; } +/* The ending's button keeps the foot position every screen gives it, but the text above it + keeps a floor: once Show code fills the screen there is no free space for the auto margin, + and the button would otherwise land against the line it follows. */ +.panel.ending > .lede { margin-bottom: 24px; } .notes .muted { margin: 4px auto 0; max-width: 480px; } /* The checkout's note slot holds one line's height whether or not the line is shown, so choosing a method moves nothing above or below it. */ diff --git a/apps/simplex-badge-service/web/public/sw.js b/apps/simplex-badge-service/web/public/sw.js index c0c46f2942..447530421a 100644 --- a/apps/simplex-badge-service/web/public/sw.js +++ b/apps/simplex-badge-service/web/public/sw.js @@ -2,7 +2,7 @@ // runs this exact file in a Node `vm` with a fake Cache API and reads `self.sw`. /** Rewritten by `build.js` from the bytes of the compiled modules, the stylesheet and the images. */ -const BUILD = "55cd5080cd9b28a4"; +const BUILD = "c1e049e40dfe7be6"; const ASSETS = `/assets/${BUILD}/`; /** One cache per build, so eviction is "everything that is not this one". */ const CACHE = `sb-${BUILD}`; diff --git a/apps/simplex-badge-service/web/src/screens.ts b/apps/simplex-badge-service/web/src/screens.ts index 84e2135a00..8ebda80496 100644 --- a/apps/simplex-badge-service/web/src/screens.ts +++ b/apps/simplex-badge-service/web/src/screens.ts @@ -846,11 +846,12 @@ export function returnToApp(o: ReturnToAppOptions): HTMLElement { el("div", { class: "tick" }, "✓"), el("h1", { class: "tight" }, "Paid"), el("p", { class: "lede" }, - el("span", { class: "line" }, "Opening SimpleX to add your badge."), " ", - el("span", { class: "line" }, "If nothing happens, use the button."), + el("span", { class: "line" }, "Your badge is ready."), " ", + el("span", { class: "line" }, "Return to SimpleX to add it."), ), button(RETURN_TO_APP, o.onReturn), ); + p.classList.add("ending"); switch (o.code.kind) { case "hidden": p.append(el("p", { class: "row-line center" }, button(SHOW_CODE, o.code.onShow, "link"))); diff --git a/apps/simplex-badge-service/web/test/screens.test.ts b/apps/simplex-badge-service/web/test/screens.test.ts index 00bac7561c..50370be92b 100644 --- a/apps/simplex-badge-service/web/test/screens.test.ts +++ b/apps/simplex-badge-service/web/test/screens.test.ts @@ -706,8 +706,8 @@ domTest("screens: the return-to-app ending opens on the tick, offers the link an assert.equal(p.children[0], p.all("div.tick")[0], "the payment went through, and this is the first thing that says so"); assert.equal(p.all("div.tick")[0]!.textContent, "✓"); assert.equal(p.all("h1")[0]!.textContent, "Paid"); - assert.ok(p.textContent.includes("Opening SimpleX to add your badge.")); - assert.ok(p.textContent.includes("If nothing happens, use the button.")); + assert.ok(p.textContent.includes("Your badge is ready.")); + assert.ok(p.textContent.includes("Return to SimpleX to add it.")); assertNoCode(p, "the return-to-app ending"); p.all("button.primary").find((b) => b.textContent === screens.RETURN_TO_APP)!.click(); p.all("button.link").find((b) => b.textContent === screens.SHOW_CODE)!.click(); From 27d12f230d81296b83962bbe83d09a16b3e0c1ce Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Wed, 7 Oct 2026 14:32:48 +0000 Subject: [PATCH 04/26] core, ui: buy a badge with an App Store or Google Play purchase (#7590) --- apps/ios/Shared/Model/AppAPITypes.swift | 44 +- apps/ios/Shared/Model/SimpleXAPI.swift | 69 +- apps/ios/Shared/SimpleXApp.swift | 1 + apps/ios/Shared/Views/Badges/BadgeStore.swift | 228 ++++- .../Views/Badges/BadgeUserPreview.swift | 17 +- .../Views/Badges/BadgesCheckOrderView.swift | 131 +++ .../Views/Badges/BadgesChooseBadgeView.swift | 75 +- .../Views/Badges/BadgesHowLongView.swift | 154 ++- .../Badges/BadgesPurchaseStateView.swift | 100 ++ .../Views/Badges/BadgesRedeemCodeView.swift | 5 +- .../Badges/BadgesSupportSimplexView.swift | 53 +- apps/ios/Shared/Views/Badges/BadgesView.swift | 16 + .../Views/Badges/BadgesYourBadgeView.swift | 10 + apps/ios/SimpleX.xcodeproj/project.pbxproj | 8 + apps/ios/SimpleXChat/APITypes.swift | 13 +- apps/ios/SimpleXChat/ChatTypes.swift | 10 + .../foss/java/chat/simplex/app/PlayStore.kt | 9 + .../google/java/chat/simplex/app/PlayStore.kt | 94 +- .../main/java/chat/simplex/app/SimplexApp.kt | 9 + .../chat/simplex/common/model/ChatModel.kt | 6 + .../chat/simplex/common/model/SimpleXAPI.kt | 102 +- .../chat/simplex/common/platform/Platform.kt | 4 + .../simplex/common/views/badges/BadgeStore.kt | 242 ++++- .../common/views/badges/BadgeUserPreview.kt | 19 +- .../views/badges/BadgesCheckOrderView.kt | 107 +++ .../views/badges/BadgesChooseBadgeView.kt | 53 +- .../common/views/badges/BadgesHowLongView.kt | 142 +-- .../views/badges/BadgesPurchaseStateView.kt | 87 ++ .../views/badges/BadgesRedeemCodeView.kt | 11 +- .../views/badges/BadgesSupportSimplexView.kt | 42 +- .../simplex/common/views/badges/BadgesView.kt | 51 +- .../views/badges/BadgesYourBadgeView.kt | 8 + .../commonMain/resources/MR/base/strings.xml | 33 +- apps/simplex-badge-service/README.md | 23 +- .../badge_service.ini.example | 3 + .../src/BadgeService/Catalog.hs | 21 +- .../src/BadgeService/Config.hs | 10 +- .../src/BadgeService/Poller.hs | 5 +- .../src/BadgeService/Service.hs | 216 +++-- .../src/BadgeService/Store.hs | 137 ++- .../src/BadgeService/Store/Invoices.hs | 30 +- .../BadgeService/Store/Postgres/Migrations.hs | 41 +- .../BadgeService/Store/SQLite/Migrations.hs | 41 +- .../src/BadgeService/StoreReceipts.hs | 101 ++ .../src/BadgeService/StoreReceipts/Mock.hs | 41 + .../apple/transaction-legend.json | 19 + .../apple/transaction-sandbox.json | 19 + .../apple/transaction-supporter.json | 19 + bots/api/TYPES.md | 4 + bots/src/API/Docs/Commands.hs | 2 + bots/src/API/Docs/Events.hs | 1 + bots/src/API/Docs/Responses.hs | 1 + docs/protocol/badges-rpc.md | 19 +- docs/protocol/badges-rpc.schema.json | 9 +- .../types/typescript/src/types.ts | 7 + .../src/simplex_chat/types/_types.py | 8 +- plans/2026-09-24-badge-buy-in-browser.md | 2 +- .../badge-service/badge_service.ini.example | 7 +- simplex-chat.cabal | 7 + src/Simplex/Chat.hs | 3 + src/Simplex/Chat/Badges/Ledger.hs | 17 +- src/Simplex/Chat/Badges/Service.hs | 4 +- src/Simplex/Chat/Badges/Types.hs | 19 +- src/Simplex/Chat/Controller.hs | 14 +- src/Simplex/Chat/Library/Commands.hs | 233 ++++- src/Simplex/Chat/PaymentService.hs | 26 +- src/Simplex/Chat/PaymentService/Types.hs | 38 + src/Simplex/Chat/Store/Badges.hs | 252 ++++- src/Simplex/Chat/Store/Postgres/Migrations.hs | 4 +- .../Migrations/M20260915_user_badges.hs | 13 +- .../M20260925_badge_store_receipts.hs | 51 + .../Store/Postgres/Migrations/chat_schema.sql | 66 +- src/Simplex/Chat/Store/SQLite/Migrations.hs | 4 +- .../Migrations/M20260915_user_badges.hs | 13 +- .../M20260925_badge_store_receipts.hs | 50 + .../SQLite/Migrations/chat_query_plans.txt | 124 ++- .../Store/SQLite/Migrations/chat_schema.sql | 22 + src/Simplex/Chat/View.hs | 17 +- tests/BadgeTests.hs | 144 ++- tests/Bots/BadgeService/BotTests.hs | 883 +++++++++++++++++- tests/Bots/BadgeService/ConfigTests.hs | 24 + tests/Bots/BadgeService/FakeStore.hs | 141 +++ tests/Bots/BadgeService/WebTests.hs | 7 +- 83 files changed, 4183 insertions(+), 732 deletions(-) create mode 100644 apps/ios/Shared/Views/Badges/BadgesCheckOrderView.swift create mode 100644 apps/ios/Shared/Views/Badges/BadgesPurchaseStateView.swift create mode 100644 apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt create mode 100644 apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt create mode 100644 apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs create mode 100644 apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs create mode 100644 apps/simplex-badge-service/test-fixtures/apple/transaction-legend.json create mode 100644 apps/simplex-badge-service/test-fixtures/apple/transaction-sandbox.json create mode 100644 apps/simplex-badge-service/test-fixtures/apple/transaction-supporter.json create mode 100644 src/Simplex/Chat/Store/Postgres/Migrations/M20260925_badge_store_receipts.hs create mode 100644 src/Simplex/Chat/Store/SQLite/Migrations/M20260925_badge_store_receipts.hs create mode 100644 tests/Bots/BadgeService/FakeStore.hs diff --git a/apps/ios/Shared/Model/AppAPITypes.swift b/apps/ios/Shared/Model/AppAPITypes.swift index eadca9f71e..bf7ee67a7e 100644 --- a/apps/ios/Shared/Model/AppAPITypes.swift +++ b/apps/ios/Shared/Model/AppAPITypes.swift @@ -193,6 +193,8 @@ enum ChatCommand: ChatCmdProtocol { case apiStandaloneFileInfo(url: String) // badges case apiRedeemBadgeCode(userId: Int64, code: String) + case apiPurchaseBadge(userId: Int64, echoedInvoiceId: String?, payment: ServicePayment) + case apiCreateBadgeInvoice(userId: Int64) case apiGetBadgeState(userId: Int64) case apiGetBadgeLedger(userId: Int64, badgePurchaseId: Int64) case apiAckBadgeAlert(userId: Int64, badgePurchaseId: Int64, alertKind: BadgeAlertKind, snooze: Bool, episode: String) @@ -419,6 +421,9 @@ enum ChatCommand: ChatCmdProtocol { case let .apiDownloadStandaloneFile(userId, link, file): return "/_download \(userId) \(link) \(file.filePath)" case let .apiStandaloneFileInfo(link): return "/_download info \(link)" case let .apiRedeemBadgeCode(userId, code): return "/_redeem_badge_code \(userId) \(code)" + case let .apiPurchaseBadge(userId, echoedInvoiceId, payment): + return "/_badge purchase \(userId)\(echoedInvoiceId.map { " invoice=\($0)" } ?? "") \(encodeJSON(payment))" + case let .apiCreateBadgeInvoice(userId): return "/_badge invoice \(userId)" case let .apiGetBadgeState(userId): return "/_badge state \(userId)" case let .apiGetBadgeLedger(userId, badgePurchaseId): return "/_badge ledger \(userId) \(badgePurchaseId)" case let .apiAckBadgeAlert(userId, badgePurchaseId, alertKind, snooze, episode): @@ -611,6 +616,8 @@ enum ChatCommand: ChatCmdProtocol { case .apiDownloadStandaloneFile: return "apiDownloadStandaloneFile" case .apiStandaloneFileInfo: return "apiStandaloneFileInfo" case .apiRedeemBadgeCode: return "apiRedeemBadgeCode" + case .apiPurchaseBadge: return "apiPurchaseBadge" + case .apiCreateBadgeInvoice: return "apiCreateBadgeInvoice" case .apiGetBadgeState: return "apiGetBadgeState" case .apiGetBadgeLedger: return "apiGetBadgeLedger" case .apiAckBadgeAlert: return "apiAckBadgeAlert" @@ -667,9 +674,11 @@ enum ChatCommand: ChatCmdProtocol { return .apiDeleteUser(userId: userId, delSMPQueues: delSMPQueues, viewPwd: obfuscate(viewPwd)) case let .testStorageEncryption(key): return .testStorageEncryption(key: obfuscate(key)) - // a code is a bearer secret until it is redeemed, and the terminal shows and copies cmdString + // a code or a store receipt is a bearer secret until it is redeemed, and the terminal shows and copies cmdString case let .apiRedeemBadgeCode(userId, code): return .apiRedeemBadgeCode(userId: userId, code: obfuscate(code)) + case let .apiPurchaseBadge(userId, echoedInvoiceId, .apple(jws)): + return .apiPurchaseBadge(userId: userId, echoedInvoiceId: echoedInvoiceId, payment: .apple(jws: obfuscate(jws))) default: return self } } @@ -719,6 +728,29 @@ enum ChatCommand: ChatCmdProtocol { } } +enum ServicePayment: Encodable { + case apple(jws: String) + + func encode(to encoder: Encoder) throws { + var container = encoder.container(keyedBy: CodingKeys.self) + switch self { + case let .apple(jws): + try container.encode("apple", forKey: .type) + try container.encode(jws, forKey: .jws) + } + } + + private enum CodingKeys: String, CodingKey { + case type, jws + } +} + +struct OpenStorePurchase: Decodable { + var invoiceId: String? + var transactionRef: String? + var creditError: BadgeIssueFailure? +} + // ChatResponse is split to three enums to reduce stack size used when parsing it, parsing large enums is very inefficient. // Spec: spec/api.md#ChatResponse0 enum ChatResponse0: Decodable, ChatAPIResult { @@ -1051,7 +1083,8 @@ enum ChatResponse2: Decodable, ChatAPIResult { // badges // the full user, not UserRef: its profile carries the badge that setUserBadge just stored case badgeRedeemed(user: User, redeemedBadge: LocalBadge, newBadge: Bool, badgeState: BadgeState?) - case badgeState(user: UserRef, badgeState: BadgeState?) + case badgeInvoice(user: UserRef, invoiceId: String) + case badgeState(user: UserRef, badgeState: BadgeState?, storePurchases: [OpenStorePurchase]?) case badgeLedger(user: UserRef, badgeLedger: [StatementEntry]) var responseType: String { @@ -1105,6 +1138,7 @@ enum ChatResponse2: Decodable, ChatAPIResult { case .archiveImported: "archiveImported" case .appSettings: "appSettings" case .badgeRedeemed: "badgeRedeemed" + case .badgeInvoice: "badgeInvoice" case .badgeState: "badgeState" case .badgeLedger: "badgeLedger" } @@ -1161,7 +1195,8 @@ enum ChatResponse2: Decodable, ChatAPIResult { case let .archiveImported(archiveErrors): return String(describing: archiveErrors) case let .appSettings(appSettings): return String(describing: appSettings) case let .badgeRedeemed(u, redeemedBadge, newBadge, badgeState): return withUser(u, "redeemedBadge: \(String(describing: redeemedBadge))\nnewBadge: \(newBadge)\nbadgeState: \(String(describing: badgeState))") - case let .badgeState(u, badgeState): return withUser(u, String(describing: badgeState)) + case let .badgeInvoice(u, invoiceId): return withUser(u, invoiceId) + case let .badgeState(u, badgeState, storePurchases): return withUser(u, "\(String(describing: badgeState))\nstorePurchases: \(String(describing: storePurchases ?? []))") case let .badgeLedger(u, badgeLedger): return withUser(u, String(describing: badgeLedger)) } } @@ -1248,6 +1283,7 @@ enum ChatEvent: Decodable, ChatAPIResult { // badges case badgeChanged(user: User, badgeState: BadgeState?) case badgeAlert(user: UserRef, badgeAlert: BadgeAlert) + case storePurchaseResolved(user: UserRef) var responseType: String { switch self { @@ -1322,6 +1358,7 @@ enum ChatEvent: Decodable, ChatAPIResult { case .contactPQEnabled: "contactPQEnabled" case .badgeChanged: "badgeChanged" case .badgeAlert: "badgeAlert" + case .storePurchaseResolved: "storePurchaseResolved" } } @@ -1406,6 +1443,7 @@ enum ChatEvent: Decodable, ChatAPIResult { case let .contactPQEnabled(u, contact, pqEnabled): return withUser(u, "contact: \(String(describing: contact))\npqEnabled: \(pqEnabled)") case let .badgeChanged(u, badgeState): return withUser(u, String(describing: badgeState)) case let .badgeAlert(u, badgeAlert): return withUser(u, String(describing: badgeAlert)) + case .storePurchaseResolved: return noDetails } } } diff --git a/apps/ios/Shared/Model/SimpleXAPI.swift b/apps/ios/Shared/Model/SimpleXAPI.swift index 742ef20688..dc7cfb059e 100644 --- a/apps/ios/Shared/Model/SimpleXAPI.swift +++ b/apps/ios/Shared/Model/SimpleXAPI.swift @@ -2196,13 +2196,42 @@ func apiRedeemBadgeCode(_ userId: Int64, _ code: String) async throws -> (user: throw r.unexpected } +// a refusal is thrown, as BREServiceError with the code +enum BadgePurchaseResult { + case held(user: UserRef, badgeState: BadgeState?, storePurchases: [OpenStorePurchase]) + case credited(user: User, badgeState: BadgeState?) +} + +// log: false because a store receipt is a bearer secret, like a badge code - it is in the command. +func apiPurchaseBadge(_ userId: Int64, _ echoedInvoiceId: String?, _ payment: ServicePayment) async throws -> BadgePurchaseResult { + let r: ChatResponse2 = try await chatSendCmd(.apiPurchaseBadge(userId: userId, echoedInvoiceId: echoedInvoiceId, payment: payment), log: false) + switch r { + case let .badgeState(user, badgeState, storePurchases): return .held(user: user, badgeState: badgeState, storePurchases: storePurchases ?? []) + case let .badgeRedeemed(user, _, _, badgeState): return .credited(user: user, badgeState: badgeState) + default: throw r.unexpected + } +} + +func apiCreateBadgeInvoice(_ userId: Int64) async throws -> String { + let r: ChatResponse2 = try await chatSendCmd(.apiCreateBadgeInvoice(userId: userId)) + if case let .badgeInvoice(_, invoiceId) = r { return invoiceId } + throw r.unexpected +} + // localized where the user can act on it; otherwise the error itself, so a screenshot says what happened -func redeemErrorText(_ error: Error) -> String { +func redeemErrorText(_ error: Error, purchase: Bool) -> String { if case let .error(.badgeRedeemError(e)) = error as? ChatError { switch e { case .invalidCode: return NSLocalizedString("This code is not valid.", comment: "alert message") - case .serviceNotConfigured: return NSLocalizedString("This app version cannot redeem badge codes.", comment: "alert message") - case .badgeActive: return NSLocalizedString("This profile already has a badge. Redeem the code on another profile, or once this badge ends.", comment: "alert message") + case .invalidReceipt: break + case .serviceNotConfigured: + return purchase + ? NSLocalizedString("This app version cannot buy badges.", comment: "alert message") + : NSLocalizedString("This app version cannot redeem badge codes.", comment: "alert message") + case .badgeActive: + return purchase + ? NSLocalizedString("This profile already has a badge.", comment: "alert message") + : NSLocalizedString("This profile already has a badge. Redeem the code on another profile, or once this badge ends.", comment: "alert message") case let .serviceError(code): if let text = badgeServiceErrorText(code) { return text } case let .invalidResponse(message): return String.localizedStringWithFormat(NSLocalizedString("The badge service sent an unexpected response: %@", comment: "alert message"), message) @@ -2212,15 +2241,15 @@ func redeemErrorText(_ error: Error) -> String { return String.localizedStringWithFormat(NSLocalizedString("Error: %@", comment: "alert message"), responseError(error)) } -func apiGetBadgeState(_ userId: Int64) async throws -> BadgeState? { +func apiGetBadgeState(_ userId: Int64) async throws -> (badgeState: BadgeState?, storePurchases: [OpenStorePurchase]) { let r: ChatResponse2 = try await chatSendCmd(.apiGetBadgeState(userId: userId)) - if case let .badgeState(_, badgeState) = r { return badgeState } + if case let .badgeState(_, badgeState, storePurchases) = r { return (badgeState, storePurchases ?? []) } throw r.unexpected } -func apiGetBadgeStateSync(_ userId: Int64) throws -> BadgeState? { +func apiGetBadgeStateSync(_ userId: Int64) throws -> (badgeState: BadgeState?, storePurchases: [OpenStorePurchase]) { let r: ChatResponse2 = try chatSendCmdSync(.apiGetBadgeState(userId: userId)) - if case let .badgeState(_, badgeState) = r { return badgeState } + if case let .badgeState(_, badgeState, storePurchases) = r { return (badgeState, storePurchases ?? []) } throw r.unexpected } @@ -2232,7 +2261,7 @@ func apiGetBadgeLedger(_ userId: Int64, _ badgePurchaseId: Int64) async throws - func apiAckBadgeAlert(_ userId: Int64, _ badgePurchaseId: Int64, _ alertKind: BadgeAlertKind, snooze: Bool, episode: String) async throws -> BadgeState? { let r: ChatResponse2 = try await chatSendCmd(.apiAckBadgeAlert(userId: userId, badgePurchaseId: badgePurchaseId, alertKind: alertKind, snooze: snooze, episode: episode)) - if case let .badgeState(_, badgeState) = r { return badgeState } + if case let .badgeState(_, badgeState, _) = r { return badgeState } throw r.unexpected } @@ -2361,6 +2390,7 @@ func startChat(refreshInvitations: Bool = true, onboarding: Bool = false) throws ChatReceiver.shared.start() m.chatRunning = true chatLastStartGroupDefault.set(Date.now) + Task { await BadgeStore.shared.presentUnfinished() } } func startChatWithTemporaryDatabase(ctrl: chat_ctrl) throws -> User? { @@ -2385,6 +2415,7 @@ private func changeActiveUser_(_ userId: Int64, viewPwd: String?) throws { m.currentUser = try apiSetActiveUser(userId, viewPwd: viewPwd) m.users = try listUsers() try getUserChatData() + Task { await BadgeStore.shared.presentUnfinished() } } func changeActiveUserAsync_(_ userId: Int64?, viewPwd: String?, keepingChatId: String? = nil) async throws { @@ -2400,6 +2431,7 @@ func changeActiveUserAsync_(_ userId: Int64?, viewPwd: String?, keepingChatId: S m.users = users } try await getUserChatDataAsync(keepingChatId: keepingChatId) + Task { await BadgeStore.shared.presentUnfinished() } await MainActor.run { if let currentUser = currentUser, var (_, invitation) = ChatModel.shared.callInvitations.first(where: { _, inv in inv.user.userId == userId }) { invitation.user = currentUser @@ -2427,22 +2459,32 @@ func getUserChatData() throws { private func loadBadgeState() { do { let userId = try currentUserId("loadBadgeState") - let badgeState = try apiGetBadgeStateSync(userId) + let (badgeState, storePurchases) = try apiGetBadgeStateSync(userId) BadgeModel.shared.set(userId: userId, badgeState: badgeState) + BadgeStore.shared.setStorePurchases(userId, storePurchases) } catch let error { logger.error("loadBadgeState: \(responseError(error))") } } -private func loadBadgeStateAsync(_ userId: Int64) async { +func loadBadgeStateAsync(_ userId: Int64) async { do { - let badgeState = try await apiGetBadgeState(userId) - await MainActor.run { BadgeModel.shared.set(userId: userId, badgeState: badgeState) } + let (badgeState, storePurchases) = try await apiGetBadgeState(userId) + await MainActor.run { + BadgeModel.shared.set(userId: userId, badgeState: badgeState) + BadgeStore.shared.setStorePurchases(userId, storePurchases) + } } catch let error { logger.error("loadBadgeState: \(responseError(error))") } } +func loadCurrentBadgeState() async { + if let userId = await MainActor.run(body: { ChatModel.shared.currentUser?.userId }) { + await loadBadgeStateAsync(userId) + } +} + private func getUserChatDataAsync(keepingChatId: String?) async throws { let m = ChatModel.shared let tm = ChatTagsModel.shared @@ -3052,6 +3094,9 @@ func processReceivedMsg(_ res: ChatEvent) async { BadgeModel.shared.setAlert(userId: user.userId, alert: badgeAlert) } } + case .storePurchaseResolved: + // whichever profile owns it: only the app can finish the store transaction + Task { await BadgeStore.shared.presentUnfinished() } default: logger.debug("unsupported event: \(res.responseType)") } diff --git a/apps/ios/Shared/SimpleXApp.swift b/apps/ios/Shared/SimpleXApp.swift index 28aa7e4002..654a31c001 100644 --- a/apps/ios/Shared/SimpleXApp.swift +++ b/apps/ios/Shared/SimpleXApp.swift @@ -101,6 +101,7 @@ struct SimpleXApp: App { if !chatModel.showCallView && !CallController.shared.hasActiveCalls() { await updateCallInvitations() } + Task { await BadgeStore.shared.presentUnfinished() } if let url = chatModel.appOpenUrlLater { await MainActor.run { chatModel.appOpenUrlLater = nil diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index c31e45439a..0c338655cd 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -9,6 +9,7 @@ import Foundation import Combine import StoreKit +import SimpleXChat // TODO [badges] product ids will come from app config and prices from the badge service catalog; // hardcoded here so the App Store integration can be tested before the purchase API lands. @@ -27,13 +28,26 @@ let badgeProductIds: [String] = BadgeLevel.allCases.flatMap { level in BadgePeriod.allCases.map { badgeProductId(level, $0) } } -// TODO [badges] replaced by APIGetBadgeInvoice, which creates the invoice row and returns its id. -// Apple requires a UUID - it is sent as appAccountToken and echoed back in the signed transaction, -// which is how the service learns which invoice a store transaction settles. +// the only products sent to the badge service: nothing delivers a subscription yet +let badgeOneTimeProductIds: Set = Set(BadgeLevel.allCases.map { badgeProductId($0, .oneMonth) }) + +// subscriptions are for sale once renewals are delivered +let badgePeriodsForSale: [BadgePeriod] = [.oneMonth] + +// A subscription's id only: core mints a one-time purchase's, and a subscription is never sent to core. +// Apple requires a UUID - it is sent as appAccountToken and echoed back in the signed transaction. func newBadgeInvoiceId() -> UUID { UUID() } // the page's app flag rides in the fragment, which never reaches the service -let badgePageUrl = "https://badges.simplex.chat/#/tier?app=true" +// TEST ONLY: pointed at the dev deployment; restore the line below before merging +let badgePageUrl = "https://smp7.simplex.im/#/tier?app=true" +// let badgePageUrl = "https://badges.simplex.chat/#/tier?app=true" + +// where the store allows a link out to the badge page: the US for now, a set expected to widen. +// An unknown storefront does not count, as this decides whether the store sees a link out of the app. +var badgeBrowserAllowed: Bool { + SKPaymentQueue.default().storefront?.countryCode == "USA" +} enum BadgePrice { case loading @@ -52,21 +66,32 @@ struct BadgeStoreReceipt { // the signed token the badge service verifies - never transaction.jsonRepresentation let jws: String let productId: String - let transactionId: UInt64 let invoiceId: UUID? - let environment: String? let signatureVerified: Bool + let transaction: Transaction + + var echoedInvoiceId: String? { invoiceId.map(coreInvoiceId) } } +// core mints the id in lower case, and UUID formats it in upper case +func coreInvoiceId(_ invoiceId: UUID) -> String { invoiceId.uuidString.lowercased() } + enum BadgePurchaseOutcome { case purchased(BadgeStoreReceipt) - case pending + case pending(invoiceId: String?) case cancelled } +enum BadgePurchaseState { + case issuing + case waitingForApproval +} + enum BadgeStoreError: Error { case productUnavailable(productId: String) case unknownPurchaseResult + case noActiveProfile + case invalidInvoiceId(String) } final class BadgeStore: ObservableObject { @@ -76,14 +101,52 @@ final class BadgeStore: ObservableObject { @Published private var state: LoadState = .notLoaded private var products: [String: Product] = [:] + // core's open store purchases for the profile they were read for: core knows whose a purchase is + @Published private var storePurchases: (userId: Int64, purchases: [OpenStorePurchase])? = nil + // whether a store sheet this run opened has not returned + @Published private var buying = false + // kept for this run only: StoreKit lists no deferred purchase, and a declined one delivers nothing + // by invoice id, so a pending purchase shows only under the profile whose record it names + @Published private var waitingForApproval: Set = [] + // set once presentUnfinished has read the store: until then, an Ask to Buy approved while the app was + // closed, or a purchase it died before handing over, are both unknown, so canBuy refuses to buy again + @Published private var reconciledOnce = false + let refusals = PassthroughSubject() + private var transactionUpdates: Task? = nil private init() {} - func price(_ level: BadgeLevel, _ period: BadgePeriod) -> BadgePrice { + func purchaseState(_ userId: Int64?) -> BadgePurchaseState? { + let purchases = openStorePurchases(userId) + if purchases.contains(where: { $0.transactionRef != nil }) { return .issuing } + if purchases.contains(where: { $0.invoiceId.map(waitingForApproval.contains) == true }) { return .waitingForApproval } + return nil + } + + func creditError(_ userId: Int64?) -> BadgeIssueFailure? { + openStorePurchases(userId).compactMap(\.creditError).first + } + + var checkingPurchases: Bool { !reconciledOnce } + + func canBuy(_ userId: Int64?) -> Bool { + reconciledOnce && !buying && purchaseState(userId) == nil + } + + func setStorePurchases(_ userId: Int64, _ purchases: [OpenStorePurchase]) { + storePurchases = (userId, purchases) + } + + private func openStorePurchases(_ userId: Int64?) -> [OpenStorePurchase] { + guard let storePurchases, storePurchases.userId == userId else { return [] } + return storePurchases.purchases + } + + func price(_ level: BadgeLevel, _ period: BadgePeriod, compact: Bool = true) -> BadgePrice { switch state { case .notLoaded, .loading: return .loading case .loaded, .failed: - if let p = products[badgeProductId(level, period)] { return .price(compactPrice(p)) } + if let p = products[badgeProductId(level, period)] { return .price(compact ? compactPrice(p) : p.displayPrice) } return .unavailable } } @@ -122,33 +185,123 @@ final class BadgeStore: ObservableObject { } } - func purchase(_ level: BadgeLevel, _ period: BadgePeriod, invoiceId: UUID) async throws -> BadgePurchaseOutcome { + // A one-time purchase has its core record before the store charges, and every store outcome reaches it. + func purchase(_ level: BadgeLevel, _ period: BadgePeriod) async throws -> BadgePurchaseOutcome { let productId = badgeProductId(level, period) guard let product = await MainActor.run(body: { products[productId] }) else { throw BadgeStoreError.productUnavailable(productId: productId) } - switch try await product.purchase(options: [.appAccountToken(invoiceId)]) { - case let .success(verification): - let transaction: Transaction - let signatureVerified: Bool - switch verification { - case let .verified(t): - transaction = t - signatureVerified = true - case let .unverified(t, _): - transaction = t - signatureVerified = false + // a subscription is never sent to core, so nothing would ever finish it later + guard badgeOneTimeProductIds.contains(productId) else { + let outcome = try await storePurchase(product, newBadgeInvoiceId()) + if case let .purchased(receipt) = outcome { await receipt.transaction.finish() } + return outcome + } + guard let userId = await MainActor.run(body: { ChatModel.shared.currentUser?.userId }) else { + throw BadgeStoreError.noActiveProfile + } + let invoice = try await apiCreateBadgeInvoice(userId) + guard let invoiceId = UUID(uuidString: invoice) else { throw BadgeStoreError.invalidInvoiceId(invoice) } + await MainActor.run { buying = true } + await loadBadgeStateAsync(userId) + do { + let outcome = try await storePurchase(product, invoiceId) + if case let .purchased(receipt) = outcome, receipt.signatureVerified { + try await handOver(receipt) } - // nothing is delivered in this build, so the transaction is finished right away; once the - // service issues credentials it must only be finished after the credential is stored - await transaction.finish() - return .purchased(storeReceipt(verification.jwsRepresentation, transaction, signatureVerified)) - case .pending: return .pending + await MainActor.run { buying = false } + return outcome + } catch let error { + await MainActor.run { buying = false } + throw error + } + } + + private func storePurchase(_ product: Product, _ invoiceId: UUID) async throws -> BadgePurchaseOutcome { + switch try await product.purchase(options: [.appAccountToken(invoiceId)]) { + case let .success(verification): return .purchased(storeReceipt(verification)) + case .pending: + let pending = coreInvoiceId(invoiceId) + await MainActor.run { _ = waitingForApproval.insert(pending) } + return .pending(invoiceId: pending) case .userCancelled: return .cancelled @unknown default: throw BadgeStoreError.unknownPurchaseResult } } + // Core holds the receipt and credits it; the transaction stays unfinished until core answers it credited + // or refused, as an unfinished transaction is what the store re-delivers if anything is lost on the way. + private func handOver(_ receipt: BadgeStoreReceipt) async throws { + guard let userId = await MainActor.run(body: { ChatModel.shared.currentUser?.userId }) else { return } + // a refusal is announced where it reads as its own, so only an unexpected answer reaches the buyer + do { + switch try await apiPurchaseBadge(userId, receipt.echoedInvoiceId, .apple(jws: receipt.jws)) { + case let .held(user, badgeState, storePurchases): + await MainActor.run { + // the answer is the owner's, which may be another profile and a hidden one + if active(user) { + BadgeModel.shared.set(userId: user.userId, badgeState: badgeState) + setStorePurchases(user.userId, storePurchases) + } + } + case let .credited(user, badgeState): + await MainActor.run { + if active(user) { + BadgeModel.shared.set(userId: user.userId, badgeState: badgeState) + ChatModel.shared.updateUser(user) + if badgeState?.shown == true { UserDefaults.standard.set(true, forKey: DEFAULT_SUPPORTER_BANNER_SHOWN) } + } + } + await resolve(receipt, refusal: nil) + } + } catch let error where badgeReceiptRefused(error) { + logger.error("BadgeStore.handOver: \(responseError(error))") + await resolve(receipt, refusal: error) + } + } + + private func resolve(_ receipt: BadgeStoreReceipt, refusal: Error?) async { + await receipt.transaction.finish() + if let refusal { + await MainActor.run { refusals.send(refusal) } + } + } + + // at launch, on return to the foreground, on a profile switch and when core resolves a purchase, never on a timer + func presentUnfinished() async { + await listenForTransactions() + for await verification in Transaction.unfinished { + await reconcile(verification) + } + await loadCurrentBadgeState() + await MainActor.run { reconciledOnce = true } + } + + // transactions the store settles outside a purchase call, such as an approved Ask to Buy + @MainActor + private func listenForTransactions() { + if transactionUpdates == nil { + transactionUpdates = Task.detached { + for await verification in Transaction.updates { + await BadgeStore.shared.reconcile(verification) + } + } + } + } + + // an unverified one-time transaction is never sent, and left unfinished rather than lost + private func reconcile(_ verification: VerificationResult) async { + let receipt = storeReceipt(verification) + if !badgeOneTimeProductIds.contains(receipt.productId) { + await receipt.transaction.finish() + } else if receipt.signatureVerified { + // no buyer to tell: the receipt stays unfinished and the next sweep hands it over again + do { try await handOver(receipt) } catch let error { + logger.error("BadgeStore.reconcile: \(responseError(error))") + } + } + } + @MainActor private func startLoading() -> Bool { switch state { @@ -172,15 +325,24 @@ private func compactPrice(_ product: Product) -> String { : product.displayPrice } -private func storeReceipt(_ jws: String, _ t: Transaction, _ signatureVerified: Bool) -> BadgeStoreReceipt { - var environment: String? = nil - if #available(iOS 16.0, *) { environment = t.environment.rawValue } +private func storeReceipt(_ verification: VerificationResult) -> BadgeStoreReceipt { + let (t, signatureVerified) = switch verification { + case let .verified(t): (t, true) + case let .unverified(t, _): (t, false) + } return BadgeStoreReceipt( - jws: jws, + jws: verification.jwsRepresentation, productId: t.productID, - transactionId: t.id, invoiceId: t.appAccountToken, - environment: environment, - signatureVerified: signatureVerified + signatureVerified: signatureVerified, + transaction: t ) } + +// the codes core refuses a receipt with for good, after which the store may stop re-delivering it +private func badgeReceiptRefused(_ error: Error) -> Bool { + if case let .error(.badgeRedeemError(.serviceError(code))) = error as? ChatError { + return code == .receiptInvalid || code == .receiptUsed + } + return false +} diff --git a/apps/ios/Shared/Views/Badges/BadgeUserPreview.swift b/apps/ios/Shared/Views/Badges/BadgeUserPreview.swift index 45d94c3ed6..10b68be473 100644 --- a/apps/ios/Shared/Views/Badges/BadgeUserPreview.swift +++ b/apps/ios/Shared/Views/Badges/BadgeUserPreview.swift @@ -9,15 +9,9 @@ import SwiftUI import SimpleXChat -struct BadgeUserPreview: View { +struct BadgeUserPreview: View { @EnvironmentObject var chatModel: ChatModel let level: BadgeLevel - let trailing: () -> Trailing - - init(level: BadgeLevel, @ViewBuilder trailing: @escaping () -> Trailing = { EmptyView() }) { - self.level = level - self.trailing = trailing - } var body: some View { let user = chatModel.currentUser @@ -29,12 +23,9 @@ struct BadgeUserPreview: View { ) return VStack(spacing: 12) { ProfileImage(imageStr: user?.image, size: 128) - HStack(alignment: .center, spacing: 6) { - NameWithBadge(Text(displayName).font(.largeTitle), previewBadge, .largeTitle) - .lineLimit(1) - .minimumScaleFactor(0.75) - trailing() - } + NameWithBadge(Text(displayName).font(.largeTitle), previewBadge, .largeTitle) + .lineLimit(1) + .minimumScaleFactor(0.75) } } } diff --git a/apps/ios/Shared/Views/Badges/BadgesCheckOrderView.swift b/apps/ios/Shared/Views/Badges/BadgesCheckOrderView.swift new file mode 100644 index 0000000000..2c0dd851ed --- /dev/null +++ b/apps/ios/Shared/Views/Badges/BadgesCheckOrderView.swift @@ -0,0 +1,131 @@ +// +// BadgesCheckOrderView.swift +// SimpleX (iOS) +// +// Created by spaced4ndy on 29.09.2026. +// Copyright © 2026 SimpleX Chat. All rights reserved. +// + +import SwiftUI +import SimpleXChat + +struct BadgesCheckOrderView: View { + @EnvironmentObject var theme: AppTheme + @EnvironmentObject var chatModel: ChatModel + @ObservedObject private var store = BadgeStore.shared + let level: BadgeLevel + let period: BadgePeriod + @State private var purchasing = false + // presented from this view, not AlertManager: its host is behind the sheet these views open in + @State private var alert: SomeAlert? + + var body: some View { + GeometryReader { g in + ScrollView { + VStack(alignment: .center, spacing: 16) { + Text("Check your order") + .font(.largeTitle) + .bold() + .foregroundColor(theme.colors.primary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + + VStack(spacing: 0) { + orderRow("Your badge", Text(level.title)) + orderRow("Duration", Text(period.label)) + Divider() + .padding(.top, 8) + .padding(.bottom, 6) + orderRow("Total", period.priceText(store.price(level, period, compact: false))) + } + .padding(.horizontal, 24) + .padding(.vertical, 12) + .background(Color(uiColor: .secondarySystemGroupedBackground)) + .clipShape(RoundedRectangle(cornerRadius: 16)) + .padding(.top, 20) + + Spacer(minLength: 20) + + VStack(spacing: 10) { + payButton() + .padding(.vertical, 10) + BadgeBillingFooter(period: period) + } + .padding(.bottom, g.safeAreaInsets.bottom == 0 ? 20 : 0) + } + .padding(.horizontal, 25) + .padding(.top, 0) + .padding(.bottom, 20) + .frame(minHeight: g.size.height) + } + } + .frame(maxHeight: .infinity) + .navigationBarTitleDisplayMode(.inline) + .task { await store.load() } + .alert(item: $alert) { $0.alert } + } + + private func orderRow(_ title: LocalizedStringKey, _ value: Text) -> some View { + HStack { + Text(title) + .foregroundColor(theme.colors.secondary) + Spacer() + value + .fontWeight(.medium) + } + .font(.body) + .padding(.vertical, 8) + } + + private func payButton() -> some View { + let price = store.price(level, period, compact: false) + let disabled = !price.canPurchase || purchasing || !store.canBuy(chatModel.currentUser?.userId) + return Button { + purchase() + } label: { + period.payText(price) + } + .buttonStyle(OnboardingButtonStyle(isDisabled: disabled)) + .disabled(disabled) + } + + private func purchase() { + purchasing = true + Task { + do { + if case let .purchased(receipt) = try await store.purchase(level, period), !receipt.signatureVerified { + await MainActor.run { + alert = SomeAlert( + alert: mkAlert( + title: "Cannot verify this purchase", + message: "The store returned a transaction that Apple has not signed. SimpleX cannot verify this purchase with the App Store." + ), + id: "badgePurchaseUnverified" + ) + } + } + await MainActor.run { purchasing = false } + } catch let error { + logger.error("BadgesCheckOrderView.purchase: \(String(describing: error))") + await MainActor.run { + purchasing = false + alert = SomeAlert( + alert: Alert( + title: Text("Purchase error"), + message: Text(verbatim: redeemErrorText(error, purchase: true)) + ), + id: "badgePurchaseError" + ) + } + } + } + } +} + +struct BadgesCheckOrderView_Previews: PreviewProvider { + static var previews: some View { + NavigationView { + BadgesCheckOrderView(level: .supporter, period: .oneMonth) + } + } +} diff --git a/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift b/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift index 077c9e5810..ba7b5b8613 100644 --- a/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesChooseBadgeView.swift @@ -23,10 +23,17 @@ enum BadgeLevel: String, CaseIterable, Identifiable { } } - var filesDescription: LocalizedStringKey { + var fileSize: LocalizedStringKey { switch self { - case .supporter: "Send 2GB files" - case .legend: "Send 5GB files" + case .supporter: "Files up to 2 GB" + case .legend: "Files up to 5 GB" + } + } + + var fileStorage: LocalizedStringKey { + switch self { + case .supporter: "Stored for 7 days" + case .legend: "Stored for 21 days" } } @@ -50,7 +57,6 @@ struct BadgesChooseBadgeView: View { @ObservedObject private var store = BadgeStore.shared @State private var selectedLevel: BadgeLevel = .supporter @State private var continueActive = false - @State private var howItWorksActive = false var body: some View { GeometryReader { g in @@ -69,14 +75,10 @@ struct BadgesChooseBadgeView: View { .multilineTextAlignment(.center) .fixedSize(horizontal: false, vertical: true) - BadgeUserPreview(level: selectedLevel) { - Image(systemName: "chevron.down") - .font(.body) - .foregroundColor(theme.colors.primary) - } - .padding(.top, 4) + BadgeUserPreview(level: selectedLevel) + .padding(.top, 4) - Spacer(minLength: 20) + Spacer(minLength: 12) // fixedSize + maxHeight on the cards so both match the taller one when a // store price wraps in one of them @@ -86,13 +88,20 @@ struct BadgesChooseBadgeView: View { } .fixedSize(horizontal: false, vertical: true) - Spacer(minLength: 20) + Spacer(minLength: 12) VStack(spacing: 10) { continueButton() .padding(.vertical, 10) - howItWorksButton() - .frame(height: 22) + // redeeming a code is here only when Support SimpleX offers the browser instead + Group { + if badgeBrowserAllowed { + RedeemCodeButton() + } else { + Color.clear + } + } + .frame(height: 22) } .padding(.bottom, g.safeAreaInsets.bottom == 0 ? 20 : 0) } @@ -116,17 +125,20 @@ struct BadgesChooseBadgeView: View { Image(badgeImageName(level.badgeType)) .resizable() .scaledToFit() - .frame(width: 60, height: 60) - .padding(.top, 20) + .frame(width: 44, height: 44) + .padding(.top, 16) Text(level.title) .font(.title3) .fontWeight(.bold) - Text(level.filesDescription) - .font(.subheadline) - .foregroundColor(theme.colors.secondary) BadgePeriod.monthly.priceText(store.price(level, .monthly)) .font(.body) - .padding(.bottom, 20) + VStack(spacing: 2) { + Text(level.fileSize) + Text(level.fileStorage) + } + .font(.subheadline) + .foregroundColor(theme.colors.secondary) + .padding(.bottom, 16) } .multilineTextAlignment(.center) .padding(.horizontal, 12) @@ -160,29 +172,6 @@ struct BadgesChooseBadgeView: View { .hidden() } } - - private func howItWorksButton() -> some View { - ZStack { - Button { - howItWorksActive = true - } label: { - HStack(spacing: 4) { - Image(systemName: "info.circle") - Text("How badges protect your privacy").fontWeight(.medium) - } - .font(.body) - } - - NavigationLink(isActive: $howItWorksActive) { - BadgesHowItWorksView() - .modifier(ThemedBackground()) - } label: { - EmptyView() - } - .frame(width: 1, height: 1) - .hidden() - } - } } struct BadgesChooseBadgeView_Previews: PreviewProvider { diff --git a/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift b/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift index d2783383de..2377a79a3b 100644 --- a/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesHowLongView.swift @@ -33,6 +33,14 @@ enum BadgePeriod: String, CaseIterable, Identifiable { } } + var months: Int { + switch self { + case .oneMonth: 1 + case .monthly: 1 + case .annual: 12 + } + } + func priceText(_ price: BadgePrice) -> Text { switch price { case .loading: return Text(verbatim: "…") @@ -64,10 +72,8 @@ struct BadgesHowLongView: View { @EnvironmentObject var theme: AppTheme @ObservedObject private var store = BadgeStore.shared let level: BadgeLevel - @State private var selectedPeriod: BadgePeriod = .monthly - @State private var purchasing = false - // presented from this view, not AlertManager: its host is behind the sheet these views open in - @State private var alert: SomeAlert? + @State private var selectedPeriod: BadgePeriod = badgePeriodsForSale.contains(.monthly) ? .monthly : .oneMonth + @State private var continueActive = false var body: some View { GeometryReader { g in @@ -91,26 +97,19 @@ struct BadgesHowLongView: View { Spacer(minLength: 20) - // fixedSize + maxHeight on the cards so all three match the tallest one - + // fixedSize + maxHeight on the cards so they all match the tallest one - // only Annual carries a savings line, and prices wrap at large fonts HStack(alignment: .top, spacing: 12) { - periodCard(.oneMonth) - periodCard(.monthly) - periodCard(.annual) + ForEach(BadgePeriod.allCases) { periodCard($0) } } .fixedSize(horizontal: false, vertical: true) Spacer(minLength: 20) VStack(spacing: 10) { - payButton() + continueButton() .padding(.vertical, 10) - Text(billingFooter) - .font(.footnote) - .foregroundColor(theme.colors.secondary) - .multilineTextAlignment(.center) - .fixedSize(horizontal: false, vertical: true) - .frame(height: 22) + BadgeBillingFooter(period: selectedPeriod) } .padding(.bottom, g.safeAreaInsets.bottom == 0 ? 20 : 0) } @@ -123,11 +122,11 @@ struct BadgesHowLongView: View { .frame(maxHeight: .infinity) .navigationBarTitleDisplayMode(.inline) .task { await store.load() } - .alert(item: $alert) { $0.alert } } private func periodCard(_ period: BadgePeriod) -> some View { let isSelected = period == selectedPeriod + let forSale = badgePeriodsForSale.contains(period) return Button { selectedPeriod = period } label: { @@ -137,17 +136,18 @@ struct BadgesHowLongView: View { .scaledToFit() .frame(width: 32, height: 32) .foregroundColor(isSelected ? theme.colors.primary : theme.colors.secondary) + .opacity(forSale ? 1 : 0.4) Text(period.label) - .font(.title3) - .fontWeight(.bold) + .font(.subheadline) period.priceText(store.price(level, period)) - .font(.body) + .font(.headline) if let percent = savingsPercent(period) { - Text("Save \(percent)%") + Text("\(percent)% off") .font(.footnote) .foregroundColor(isSelected ? theme.colors.primary : theme.colors.secondary) } } + .foregroundColor(forSale ? nil : theme.colors.secondary) .multilineTextAlignment(.center) .padding(.vertical, 25) .padding(.horizontal, 12) @@ -160,99 +160,53 @@ struct BadgesHowLongView: View { ) } .buttonStyle(.plain) + .disabled(!forSale) } private func savingsPercent(_ period: BadgePeriod) -> Int? { period == .annual ? store.annualSavings(level) : nil } - private func payButton() -> some View { - let price = store.price(level, selectedPeriod) - let disabled = !price.canPurchase || purchasing - return Button { - purchase() - } label: { - selectedPeriod.payText(price) - } - .buttonStyle(OnboardingButtonStyle(isDisabled: disabled)) - .disabled(disabled) - } - - private func purchase() { - let period = selectedPeriod - let invoiceId = newBadgeInvoiceId() - purchasing = true - Task { - do { - let outcome = try await store.purchase(level, period, invoiceId: invoiceId) - await MainActor.run { - purchasing = false - switch outcome { - case let .purchased(receipt): showPurchasedAlert(receipt, invoiceId) - case .pending: - alert = SomeAlert( - alert: mkAlert( - title: "Purchase pending", - message: "The purchase is awaiting approval. This build does not deliver purchases approved later." - ), - id: "badgePurchasePending" - ) - case .cancelled: break - } - } - } catch let error { - logger.error("BadgesHowLongView.purchase: \(String(describing: error))") - await MainActor.run { - purchasing = false - alert = SomeAlert( - alert: Alert( - title: Text("Purchase error"), - message: Text(verbatim: String(describing: error)) - ), - id: "badgePurchaseError" - ) - } + private func continueButton() -> some View { + ZStack { + Button { + continueActive = true + } label: { + Text("Continue") } + .buttonStyle(OnboardingButtonStyle(isDisabled: false)) + + NavigationLink(isActive: $continueActive) { + BadgesCheckOrderView(level: level, period: selectedPeriod) + .modifier(ThemedBackground(grouped: true)) + } label: { + EmptyView() + } + .frame(width: 1, height: 1) + .hidden() } } +} - // TODO [badges] store integration diagnostics - replaced by the issued badge once the service lands. - private func showPurchasedAlert(_ receipt: BadgeStoreReceipt, _ invoiceId: UUID) { - let returnedInvoice: String - if let returned = receipt.invoiceId { - returnedInvoice = returned == invoiceId ? "yes" : "mismatch: \(returned.uuidString)" - } else { - returnedInvoice = "none" - } - var lines = [ - "Product: \(receipt.productId)", - "Invoice: \(invoiceId.uuidString)", - "Invoice returned by Apple: \(returnedInvoice)", - "Transaction: \(receipt.transactionId)" - ] - if let environment = receipt.environment { lines.append("Environment: \(environment)") } - lines.append("Signature: \(receipt.signatureVerified ? "verified" : "unverified")") - lines.append("Token: \(receipt.jws.count) bytes") - let summary = lines.joined(separator: "\n") - // logged as well as shown: the alert races StoreKit's own sheets, the log always lands - logger.debug("badge purchase succeeded\n\(summary)") - alert = SomeAlert( - alert: Alert( - title: Text("Purchase successful"), - message: Text(verbatim: summary), - primaryButton: .default(Text(verbatim: "Copy token")) { UIPasteboard.general.string = receipt.jws }, - secondaryButton: .cancel(Text("Ok")) - ), - id: "badgePurchased" - ) +struct BadgeBillingFooter: View { + @EnvironmentObject var theme: AppTheme + let period: BadgePeriod + + var body: some View { + Text(billingFooter) + .font(.footnote) + .foregroundColor(theme.colors.secondary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + .frame(height: 22) } private var billingFooter: LocalizedStringKey { - // TODO [badges] source the actual date from the purchase state machine when wired. - var comps = DateComponents(); comps.year = 2026; comps.month = 7; comps.day = 22 - let stubDate = Calendar.current.date(from: comps) ?? Date() - let date = DateFormatter.localizedString(from: stubDate, dateStyle: .long, timeStyle: .none) - switch selectedPeriod { + // TODO [badges] from now only because a purchase is refused while a badge is held (refuseWhileBadgeHeld); + // a top-up must count from the end of the existing balance + let endDate = Calendar.current.date(byAdding: .month, value: period.months, to: Date()) ?? Date() + let date = DateFormatter.localizedString(from: endDate, dateStyle: .long, timeStyle: .none) + switch period { case .monthly, .annual: return "Renews on \(date). Cancel anytime." case .oneMonth: return "Ends on \(date)." } diff --git a/apps/ios/Shared/Views/Badges/BadgesPurchaseStateView.swift b/apps/ios/Shared/Views/Badges/BadgesPurchaseStateView.swift new file mode 100644 index 0000000000..702304acd4 --- /dev/null +++ b/apps/ios/Shared/Views/Badges/BadgesPurchaseStateView.swift @@ -0,0 +1,100 @@ +// +// BadgesPurchaseStateView.swift +// SimpleX (iOS) +// +// Created by spaced4ndy on 29.09.2026. +// Copyright © 2026 SimpleX Chat. All rights reserved. +// + +import SwiftUI +import SimpleXChat + +struct BadgesPurchaseStateView: View { + @EnvironmentObject var theme: AppTheme + @Environment(\.dismiss) private var dismiss + let title: LocalizedStringKey + var message: LocalizedStringKey? = nil + var failure: BadgeIssueFailure? = nil + var showsAsSheet: Bool = false + + var body: some View { + GeometryReader { g in + ScrollView { + content + .padding(.horizontal, 25) + .padding(.top, showsAsSheet ? 48 : 0) + .padding(.bottom, 20) + .frame(minHeight: g.size.height) + } + } + .frame(maxHeight: .infinity) + .navigationBarTitleDisplayMode(.inline) + } + + private var content: some View { + VStack(alignment: .center, spacing: 16) { + Text(title) + .font(.largeTitle) + .bold() + .foregroundColor(theme.colors.primary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + + if let message { + Text(message) + .font(.body) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + } + + if let failure { + VStack(spacing: 6) { + Image(systemName: "exclamationmark.triangle") + .foregroundColor(.red) + Text(failure.purchaseText) + .font(.body) + .foregroundColor(theme.colors.secondary) + .multilineTextAlignment(.center) + .fixedSize(horizontal: false, vertical: true) + } + } + + Spacer() + + ProgressView().scaleEffect(2) + + Spacer() + + VStack(spacing: 10) { + Button { + dismiss() + } label: { + Text("Dismiss") + .font(.body) + .fontWeight(.medium) + .foregroundColor(theme.colors.primary) + .padding() + } + .padding(.vertical, 10) + Color.clear + .frame(height: 22) + } + } + } +} + +extension BadgePurchaseState { + var title: LocalizedStringKey { + switch self { + case .issuing: "Issuing your badge" + case .waitingForApproval: "Waiting for approval" + } + } + + var message: LocalizedStringKey { + switch self { + case .issuing: "Your payment is complete. The badge will be added to this profile." + case .waitingForApproval: "Nothing has been charged." + } + } +} diff --git a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift index ed53b21173..322dbf1864 100644 --- a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift @@ -59,7 +59,7 @@ func redeemBadgeCode(_ user: User, _ code: String) async -> BadgeRedeemOutcome { } } catch let error { logger.error("apiRedeemBadgeCode: \(responseError(error))") - return .refused(message: redeemErrorText(error)) + return .refused(message: redeemErrorText(error, purchase: false)) } } @@ -313,7 +313,8 @@ struct BadgesRedeemLinkView: View { // leaving does not cancel: the badge is still added after the screen closes private func beingIssued() -> some View { - linkStep("Badge is being issued", textButton: ("Dismiss", { closeIfShowing() })) { + linkStep("Issuing your badge", textButton: ("Dismiss", { closeIfShowing() })) { + linkText(NSLocalizedString("The badge will be added to this profile.", comment: "badge link, being issued")) Spacer() ProgressView().scaleEffect(2) } diff --git a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift index 22cec4a4f4..df13abdc97 100644 --- a/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesSupportSimplexView.swift @@ -11,13 +11,14 @@ import SimpleXChat struct BadgesSupportSimplexView: View { @EnvironmentObject var theme: AppTheme + @EnvironmentObject var chatModel: ChatModel + @ObservedObject private var store = BadgeStore.shared // set true when presented as a sheet root (from the chat-list banner) — that path doesn't // reserve nav-bar space like a NavigationLink push does, so the title lands too close to the top var showsAsSheet: Bool = false @State private var whyBuiltActive = false @State private var howItWorksActive = false @State private var chooseLevelActive = false - @State private var redeemCodeActive = false var body: some View { GeometryReader { g in @@ -34,8 +35,6 @@ struct BadgesSupportSimplexView: View { .multilineTextAlignment(.center) .fixedSize(horizontal: false, vertical: true) - // TODO [badges] restore whyBuiltButton() when in-app purchase lands: the level screen - // returns to the flow and howItWorksButton() moves there, leaving this one alone here. howItWorksButton() Spacer(minLength: 0) @@ -47,10 +46,16 @@ struct BadgesSupportSimplexView: View { Spacer(minLength: 0) VStack(spacing: 10) { - buyInBrowserButton() + chooseLevelButton() .padding(.vertical, 10) - redeemCodeButton() - .frame(height: 22) + Group { + if badgeBrowserAllowed { + buyInBrowserButton() + } else { + RedeemCodeButton() + } + } + .frame(height: 22) } .padding(.bottom, g.safeAreaInsets.bottom == 0 ? 20 : 0) } @@ -65,15 +70,16 @@ struct BadgesSupportSimplexView: View { .navigationBarTitleDisplayMode(.inline) } - // the in-app purchase path, kept compiling and uncalled until payments return after the MVP private func chooseLevelButton() -> some View { - ZStack { + let disabled = !store.canBuy(chatModel.currentUser?.userId) + return ZStack { Button { chooseLevelActive = true } label: { - Text("Choose your level") + Text("Choose your badge") } - .buttonStyle(OnboardingButtonStyle(isDisabled: false)) + .buttonStyle(OnboardingButtonStyle(isDisabled: disabled)) + .disabled(disabled) NavigationLink(isActive: $chooseLevelActive) { BadgesChooseBadgeView() @@ -125,7 +131,23 @@ struct BadgesSupportSimplexView: View { } } - private func redeemCodeButton() -> some View { + private func buyInBrowserButton() -> some View { + Button { + UIApplication.shared.open(URL(string: badgePageUrl)!) + } label: { + Text("Buy in browser") + .font(.body) + .fontWeight(.medium) + .foregroundColor(theme.colors.primary) + } + } +} + +struct RedeemCodeButton: View { + @EnvironmentObject var theme: AppTheme + @State private var redeemCodeActive = false + + var body: some View { ZStack { Button { redeemCodeActive = true @@ -146,15 +168,6 @@ struct BadgesSupportSimplexView: View { .hidden() } } - - private func buyInBrowserButton() -> some View { - Button { - UIApplication.shared.open(URL(string: badgePageUrl)!) - } label: { - Text("Buy in browser") - } - .buttonStyle(OnboardingButtonStyle(isDisabled: false)) - } } struct PhoneSupporterHero: View { diff --git a/apps/ios/Shared/Views/Badges/BadgesView.swift b/apps/ios/Shared/Views/Badges/BadgesView.swift index df12094a6b..28fa1a02e8 100644 --- a/apps/ios/Shared/Views/Badges/BadgesView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesView.swift @@ -12,6 +12,7 @@ import SimpleXChat struct BadgesView: View { @EnvironmentObject var chatModel: ChatModel @ObservedObject private var badgeModel = BadgeModel.shared + @ObservedObject private var store = BadgeStore.shared var showsAsSheet: Bool = false private var shownBadge: BadgeState? { @@ -25,12 +26,27 @@ struct BadgesView: View { if let badgeState = shownBadge { BadgesYourBadgeView(badgeState: badgeState, showsAsSheet: showsAsSheet) .transition(.opacity) + } else if let purchaseState = store.purchaseState(chatModel.currentUser?.userId) { + // holds the purchase screens' slot, so a consumable cannot be bought twice + BadgesPurchaseStateView(title: purchaseState.title, message: purchaseState.message, failure: store.creditError(chatModel.currentUser?.userId), showsAsSheet: showsAsSheet) + .transition(.opacity) + .onReceive(store.refusals) { refusal in + // only the issuing screen belongs to the active profile's held purchase, so a refusal shown there reads as its own + if purchaseState == .issuing { + showAlert(NSLocalizedString("Purchase error", comment: "alert title"), message: redeemErrorText(refusal, purchase: true)) + } + } + } else if store.checkingPurchases { + BadgesPurchaseStateView(title: "Checking your purchases", showsAsSheet: showsAsSheet) + .transition(.opacity) } else { BadgesSupportSimplexView(showsAsSheet: showsAsSheet) .transition(.opacity) } } .animation(.default, value: shownBadge != nil) + .animation(.default, value: store.purchaseState(chatModel.currentUser?.userId)) + .animation(.default, value: store.checkingPurchases) } } diff --git a/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift b/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift index 60c6a0ab77..6a67dad8c2 100644 --- a/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift @@ -14,6 +14,7 @@ struct BadgesYourBadgeView: View { @EnvironmentObject var chatModel: ChatModel @Environment(\.dismiss) private var dismiss @AppStorage(DEFAULT_DEVELOPER_TOOLS) private var developerTools = false + @ObservedObject private var store = BadgeStore.shared let badgeState: BadgeState var showsAsSheet: Bool = false @@ -78,6 +79,15 @@ struct BadgesYourBadgeView: View { } } } + if store.purchaseState(chatModel.currentUser?.userId) != nil { + Section { + Text("A store purchase is being processed.") + .foregroundColor(theme.colors.secondary) + } header: { + Text("Store purchase") + .foregroundColor(theme.colors.secondary) + } + } if developerTools { Section(header: Text("Credential").foregroundColor(theme.colors.secondary)) { if let badge = chatModel.currentUser?.profile.localBadge { diff --git a/apps/ios/SimpleX.xcodeproj/project.pbxproj b/apps/ios/SimpleX.xcodeproj/project.pbxproj index d4171b89ae..05a28d21ce 100644 --- a/apps/ios/SimpleX.xcodeproj/project.pbxproj +++ b/apps/ios/SimpleX.xcodeproj/project.pbxproj @@ -168,6 +168,8 @@ 647C9E293061362A0032110E /* GetStakeBanner.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E283061362A0032110E /* GetStakeBanner.swift */; }; 647C9E2C30666C640032110E /* BadgesChooseBadgeView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */; }; 647C9E2D30666C640032110E /* BadgesHowLongView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647C9E2B30666C640032110E /* BadgesHowLongView.swift */; }; + 64D1B0A23070AA0000C0DE01 /* BadgesCheckOrderView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64D1B0A13070AA0000C0DE01 /* BadgesCheckOrderView.swift */; }; + 64D1B0A43070AA0000C0DE01 /* BadgesPurchaseStateView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64D1B0A33070AA0000C0DE01 /* BadgesPurchaseStateView.swift */; }; 647F090E288EA27B00644C40 /* GroupMemberInfoView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 647F090D288EA27B00644C40 /* GroupMemberInfoView.swift */; }; 648010AB281ADD15009009B9 /* CIFileView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 648010AA281ADD15009009B9 /* CIFileView.swift */; }; 648679AB2BC96A74006456E7 /* ChatItemForwardingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 648679AA2BC96A74006456E7 /* ChatItemForwardingView.swift */; }; @@ -560,6 +562,8 @@ 647C9E283061362A0032110E /* GetStakeBanner.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetStakeBanner.swift; sourceTree = ""; }; 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesChooseBadgeView.swift; sourceTree = ""; }; 647C9E2B30666C640032110E /* BadgesHowLongView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesHowLongView.swift; sourceTree = ""; }; + 64D1B0A13070AA0000C0DE01 /* BadgesCheckOrderView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesCheckOrderView.swift; sourceTree = ""; }; + 64D1B0A33070AA0000C0DE01 /* BadgesPurchaseStateView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BadgesPurchaseStateView.swift; sourceTree = ""; }; 647F090D288EA27B00644C40 /* GroupMemberInfoView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GroupMemberInfoView.swift; sourceTree = ""; }; 648010AA281ADD15009009B9 /* CIFileView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CIFileView.swift; sourceTree = ""; }; 648679AA2BC96A74006456E7 /* ChatItemForwardingView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatItemForwardingView.swift; sourceTree = ""; }; @@ -1219,6 +1223,8 @@ children = ( 647C9E2A30666C640032110E /* BadgesChooseBadgeView.swift */, 647C9E2B30666C640032110E /* BadgesHowLongView.swift */, + 64D1B0A13070AA0000C0DE01 /* BadgesCheckOrderView.swift */, + 64D1B0A33070AA0000C0DE01 /* BadgesPurchaseStateView.swift */, 644CC228305BFAE400D2A571 /* BadgesLedgerView.swift */, 64EB8A9A3054347A0089FFDF /* BadgesView.swift */, 64C03BF0302F423300072BDE /* BadgesHowItWorksView.swift */, @@ -1672,6 +1678,8 @@ 6442E0BA287F169300CEC0F9 /* AddGroupView.swift in Sources */, 647C9E2C30666C640032110E /* BadgesChooseBadgeView.swift in Sources */, 647C9E2D30666C640032110E /* BadgesHowLongView.swift in Sources */, + 64D1B0A23070AA0000C0DE01 /* BadgesCheckOrderView.swift in Sources */, + 64D1B0A43070AA0000C0DE01 /* BadgesPurchaseStateView.swift in Sources */, 5CF937232B2503D000E1D781 /* NSESubscriber.swift in Sources */, 6419EC582AB97507004A607A /* CIMemberCreatedContactView.swift in Sources */, 64D0C2C229FA57AB00B38D5F /* UserAddressLearnMore.swift in Sources */, diff --git a/apps/ios/SimpleXChat/APITypes.swift b/apps/ios/SimpleXChat/APITypes.swift index 75d66ebb6f..1815a53f4f 100644 --- a/apps/ios/SimpleXChat/APITypes.swift +++ b/apps/ios/SimpleXChat/APITypes.swift @@ -826,6 +826,7 @@ public enum ChatErrorType: Decodable, Hashable { public enum BadgeRedeemError: Decodable, Hashable { case invalidCode + case invalidReceipt case serviceNotConfigured case badgeActive case serviceError(serviceError: BadgeServiceErrorCode) @@ -846,6 +847,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case paymentNotEntitled case paymentPending case providerUnavailable + case providerNotConfigured case rateLimited case codeInvalid case codeUsed @@ -867,6 +869,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case .paymentNotEntitled: "payment_not_entitled" case .paymentPending: "payment_pending" case .providerUnavailable: "provider_unavailable" + case .providerNotConfigured: "provider_not_configured" case .rateLimited: "rate_limited" case .codeInvalid: "code_invalid" case .codeUsed: "code_used" @@ -890,6 +893,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case "payment_not_entitled": self = .paymentNotEntitled case "payment_pending": self = .paymentPending case "provider_unavailable": self = .providerUnavailable + case "provider_not_configured": self = .providerNotConfigured case "rate_limited": self = .rateLimited case "code_invalid": self = .codeInvalid case "code_used": self = .codeUsed @@ -911,8 +915,13 @@ public func badgeServiceErrorText(_ code: BadgeServiceErrorCode) -> String? { case .unsupportedVersion: NSLocalizedString("This app version is too old for the badge service. Please update the app.", comment: "alert message") case .unknownPurchaseKey: NSLocalizedString("The badge service does not recognize this badge.", comment: "alert message") case .internalError: NSLocalizedString("The badge service reported an internal error.", comment: "alert message") - case .badRequest, .unknownOfferId, .offerDisabled, .offerMismatch, .productUnavailable, - .paymentNotEntitled, .paymentPending, .providerUnavailable, .receiptInvalid, .receiptUsed, .unknown: nil + case .receiptInvalid: NSLocalizedString("The store did not confirm this purchase.", comment: "alert message") + case .receiptUsed: NSLocalizedString("This purchase was already credited to a badge on another device or profile.", comment: "alert message") + case .paymentPending: NSLocalizedString("The payment has not been confirmed yet.", comment: "alert message") + case .providerUnavailable: NSLocalizedString("The store could not be reached.", comment: "alert message") + case .providerNotConfigured: NSLocalizedString("Badges cannot be bought in the app yet.", comment: "alert message") + case .productUnavailable: NSLocalizedString("This badge is not on sale.", comment: "alert message") + case .badRequest, .unknownOfferId, .offerDisabled, .offerMismatch, .paymentNotEntitled, .unknown: nil } } diff --git a/apps/ios/SimpleXChat/ChatTypes.swift b/apps/ios/SimpleXChat/ChatTypes.swift index cf520a65c7..9e6ff84b96 100644 --- a/apps/ios/SimpleXChat/ChatTypes.swift +++ b/apps/ios/SimpleXChat/ChatTypes.swift @@ -368,6 +368,16 @@ public enum BadgeIssueFailure: Decodable, Hashable { } } + public var purchaseText: String { + switch self { + case let .serviceError(code, _): + badgeServiceErrorText(code) + ?? String.localizedStringWithFormat(NSLocalizedString("The badge service refused the purchase: %@", comment: "badge purchase error"), code.text) + case .invalidCredential: NSLocalizedString("This app version cannot verify this badge. Please update the app.", comment: "alert message") + case .serviceTimeout, .network, .unexpected: text + } + } + // the stored form, for support public var tag: String { switch self { diff --git a/apps/multiplatform/android/src/foss/java/chat/simplex/app/PlayStore.kt b/apps/multiplatform/android/src/foss/java/chat/simplex/app/PlayStore.kt index 1d8fc5e151..0cad378da6 100644 --- a/apps/multiplatform/android/src/foss/java/chat/simplex/app/PlayStore.kt +++ b/apps/multiplatform/android/src/foss/java/chat/simplex/app/PlayStore.kt @@ -5,6 +5,7 @@ import chat.simplex.common.views.badges.BadgeProduct import chat.simplex.common.views.badges.BadgePurchaseOutcome import chat.simplex.common.views.badges.BadgeStoreError import chat.simplex.common.views.badges.BadgeStoreProductId +import chat.simplex.common.views.badges.BadgeStoreReceipt // Play Billing is only in the google flavor, so the Play country stays unknown here fun loadPlayStoreCountry() {} @@ -22,3 +23,11 @@ suspend fun loadBadgeProducts(oneTimeIds: List, subscriptio @Suppress("UNUSED_PARAMETER") suspend fun purchaseBadge(id: BadgeStoreProductId, invoiceId: String): BadgePurchaseOutcome = throw BadgeStoreError.StoreUnavailable + +@Suppress("UNUSED_PARAMETER") +suspend fun acknowledgeBadgePurchase(receipt: BadgeStoreReceipt) {} + +@Suppress("UNUSED_PARAMETER") +suspend fun finishBadgePurchase(receipt: BadgeStoreReceipt) {} + +suspend fun unfinishedBadgePurchases(): List = emptyList() diff --git a/apps/multiplatform/android/src/google/java/chat/simplex/app/PlayStore.kt b/apps/multiplatform/android/src/google/java/chat/simplex/app/PlayStore.kt index 4075421e52..85b9da1316 100644 --- a/apps/multiplatform/android/src/google/java/chat/simplex/app/PlayStore.kt +++ b/apps/multiplatform/android/src/google/java/chat/simplex/app/PlayStore.kt @@ -5,6 +5,7 @@ import chat.simplex.common.platform.androidAppContext import chat.simplex.common.platform.androidPlayStoreCountry import chat.simplex.common.platform.mainActivity import chat.simplex.common.views.badges.* +import chat.simplex.common.views.helpers.withLongRunningApi import com.android.billingclient.api.* import kotlinx.coroutines.CompletableDeferred import kotlinx.coroutines.Dispatchers @@ -40,7 +41,7 @@ fun loadPlayStoreCountry() { // One long-lived client for badges: ProductDetails obtained from it are passed back to it when the // purchase is launched, and the purchase result arrives on its listener rather than as a return value. -// volatile: the listener is called on the main thread, the purchase runs on a background dispatcher +// volatile: written by the purchase on a background dispatcher, read by the listener on another thread @Volatile private var badgeBillingClient: BillingClient? = null @Volatile private var badgeOffers: Map = emptyMap() @Volatile private var badgePurchase: CompletableDeferred? = null @@ -80,8 +81,7 @@ suspend fun purchaseBadge(id: BadgeStoreProductId, invoiceId: String): BadgePurc val activity = mainActivity.get() ?: throw BadgeStoreError.StoreUnavailable val client = connectedBadgeBillingClient() val offer = badgeOffers[id] ?: throw BadgeStoreError.ProductUnavailable(id.productId) - val details = offer.details - val productParams = BillingFlowParams.ProductDetailsParams.newBuilder().setProductDetails(details) + val productParams = BillingFlowParams.ProductDetailsParams.newBuilder().setProductDetails(offer.details) offer.offerToken?.let { productParams.setOfferToken(it) } val params = BillingFlowParams.newBuilder() .setProductDetailsParamsList(listOf(productParams.build())) @@ -94,19 +94,42 @@ suspend fun purchaseBadge(id: BadgeStoreProductId, invoiceId: String): BadgePurc if (launched.responseCode != BillingClient.BillingResponseCode.OK) { throw BadgeStoreError.BillingError(launched.responseCode, launched.debugMessage) } - val outcome = purchase.await() - if (outcome is BadgePurchaseOutcome.Purchased) finishBadgePurchase(client, details, outcome.receipt) - return outcome + return purchase.await() } finally { badgePurchase = null } } +// one-time purchases Play still holds: bought and not consumed, or awaiting a slow payment +suspend fun unfinishedBadgePurchases(): List { + val client = connectedBadgeBillingClient() + val params = QueryPurchasesParams.newBuilder().setProductType(BillingClient.ProductType.INAPP).build() + val queried = CompletableDeferred>() + client.queryPurchasesAsync(params) { result, purchases -> + if (result.responseCode == BillingClient.BillingResponseCode.OK) { + queried.complete(purchases) + } else { + queried.completeExceptionally(BadgeStoreError.BillingError(result.responseCode, result.debugMessage)) + } + } + return queried.await().mapNotNull(::badgePurchaseOutcome) +} + private val badgePurchasesUpdatedListener = PurchasesUpdatedListener { result, purchases -> - val pending = badgePurchase ?: return@PurchasesUpdatedListener + val pending = badgePurchase + if (pending == null) { + // settled outside a purchase call, such as a slow payment completing + if (result.responseCode == BillingClient.BillingResponseCode.OK && purchases != null) { + withLongRunningApi { purchases.mapNotNull(::badgePurchaseOutcome).forEach { BadgeStore.reconcile(it) } } + } + return@PurchasesUpdatedListener + } when { - result.responseCode == BillingClient.BillingResponseCode.OK && purchases != null -> - pending.complete(badgePurchaseOutcome(purchases)) + result.responseCode == BillingClient.BillingResponseCode.OK && purchases != null -> { + val outcomes = purchases.mapNotNull(::badgePurchaseOutcome) + pending.complete(outcomes.firstOrNull() ?: BadgePurchaseOutcome.Cancelled) + withLongRunningApi { outcomes.drop(1).forEach { BadgeStore.reconcile(it) } } + } result.responseCode == BillingClient.BillingResponseCode.USER_CANCELED -> pending.complete(BadgePurchaseOutcome.Cancelled) else -> @@ -114,17 +137,17 @@ private val badgePurchasesUpdatedListener = PurchasesUpdatedListener { result, p } } -private fun badgePurchaseOutcome(purchases: List): BadgePurchaseOutcome { - val purchase = purchases.firstOrNull() ?: return BadgePurchaseOutcome.Cancelled - if (purchase.purchaseState == Purchase.PurchaseState.PENDING) return BadgePurchaseOutcome.Pending - return BadgePurchaseOutcome.Purchased( +private fun badgePurchaseOutcome(purchase: Purchase): BadgePurchaseOutcome? = when (purchase.purchaseState) { + Purchase.PurchaseState.PENDING -> BadgePurchaseOutcome.Pending(purchase.accountIdentifiers?.obfuscatedAccountId) + Purchase.PurchaseState.PURCHASED -> BadgePurchaseOutcome.Purchased( BadgeStoreReceipt( token = purchase.purchaseToken, productId = purchase.products.firstOrNull() ?: "", - orderId = purchase.orderId, - invoiceId = purchase.accountIdentifiers?.obfuscatedAccountId + invoiceId = purchase.accountIdentifiers?.obfuscatedAccountId, + acknowledged = purchase.isAcknowledged ) ) + else -> null } private suspend fun connectedBadgeBillingClient(): BillingClient { @@ -203,21 +226,34 @@ private fun ProductDetails.badgeOffer(id: BadgeStoreProductId): BadgeOffer? { return BadgeOffer(id, product, this, offer.offerToken) } -// nothing is delivered in this build, so the purchase is finished right away; once the service issues -// credentials it must only be finished after the credential is stored. One-time products are consumed -// so they can be bought again, subscriptions are acknowledged - Play refunds an unacknowledged -// purchase after 3 days. -private suspend fun finishBadgePurchase(client: BillingClient, details: ProductDetails, receipt: BadgeStoreReceipt) { - val done = CompletableDeferred() - if (details.productType == BillingClient.ProductType.SUBS) { - val params = AcknowledgePurchaseParams.newBuilder().setPurchaseToken(receipt.token).build() - client.acknowledgePurchase(params) { done.complete(it) } - } else { +// acknowledged without consuming, so Play stops its 3-day refund clock and still lists the purchase until it is finished +suspend fun acknowledgeBadgePurchase(receipt: BadgeStoreReceipt) { + if (!receipt.acknowledged) acknowledge(connectedBadgeBillingClient(), receipt.token) +} + +// consumed if one-time so it can be bought again, else acknowledged, as Play refunds an unacknowledged purchase +// after 3 days; decided by product id, as after a restart there is no ProductDetails for the purchase +suspend fun finishBadgePurchase(receipt: BadgeStoreReceipt) { + val client = connectedBadgeBillingClient() + if (receipt.productId in badgeOneTimeProductIds) { + val done = CompletableDeferred() val params = ConsumeParams.newBuilder().setPurchaseToken(receipt.token).build() client.consumeAsync(params) { result, _ -> done.complete(result) } - } - val result = done.await() - if (result.responseCode != BillingClient.BillingResponseCode.OK) { - Log.e(TAG, "finishBadgePurchase: ${result.responseCode} ${result.debugMessage}") + checkBillingResult(done.await()) + } else { + acknowledge(client, receipt.token) + } +} + +private suspend fun acknowledge(client: BillingClient, token: String) { + val done = CompletableDeferred() + val params = AcknowledgePurchaseParams.newBuilder().setPurchaseToken(token).build() + client.acknowledgePurchase(params) { done.complete(it) } + checkBillingResult(done.await()) +} + +private fun checkBillingResult(result: BillingResult) { + if (result.responseCode != BillingClient.BillingResponseCode.OK) { + throw BadgeStoreError.BillingError(result.responseCode, result.debugMessage) } } diff --git a/apps/multiplatform/android/src/main/java/chat/simplex/app/SimplexApp.kt b/apps/multiplatform/android/src/main/java/chat/simplex/app/SimplexApp.kt index 1a4c836b2e..9093b1427b 100644 --- a/apps/multiplatform/android/src/main/java/chat/simplex/app/SimplexApp.kt +++ b/apps/multiplatform/android/src/main/java/chat/simplex/app/SimplexApp.kt @@ -28,7 +28,9 @@ import chat.simplex.common.platform.* import chat.simplex.common.ui.theme.* import chat.simplex.common.views.badges.BadgeProduct import chat.simplex.common.views.badges.BadgePurchaseOutcome +import chat.simplex.common.views.badges.BadgeStore import chat.simplex.common.views.badges.BadgeStoreProductId +import chat.simplex.common.views.badges.BadgeStoreReceipt import chat.simplex.common.views.call.* import chat.simplex.common.views.database.deleteOldChatArchive import chat.simplex.common.views.helpers.* @@ -113,6 +115,7 @@ class SimplexApp: Application(), LifecycleEventObserver { } }.onFailure { Log.e(TAG, it.stackTraceToString()) } } + BadgeStore.presentUnfinished() } } Lifecycle.Event.ON_RESUME -> { @@ -352,6 +355,12 @@ class SimplexApp: Application(), LifecycleEventObserver { override suspend fun androidPurchaseBadge(id: BadgeStoreProductId, invoiceId: String): BadgePurchaseOutcome = purchaseBadge(id, invoiceId) + override suspend fun androidAcknowledgeBadgePurchase(receipt: BadgeStoreReceipt) = acknowledgeBadgePurchase(receipt) + + override suspend fun androidFinishBadgePurchase(receipt: BadgeStoreReceipt) = finishBadgePurchase(receipt) + + override suspend fun androidUnfinishedBadgePurchases(): List = unfinishedBadgePurchases() + @SuppressLint("SourceLockedOrientationActivity") @Composable override fun androidLockPortraitOrientation() { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/ChatModel.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/ChatModel.kt index 9d65606a9c..6a345bb612 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/ChatModel.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/ChatModel.kt @@ -2271,6 +2271,12 @@ sealed class BadgeIssueFailure { is Unexpected -> String.format(generalGetString(MR.strings.badges_error_unexpected), message) } + val purchaseText: String get() = when (this) { + is ServiceError -> badgeServiceErrorText(code) ?: String.format(generalGetString(MR.strings.badges_error_purchase_refused), code.text) + is InvalidCredential -> generalGetString(MR.strings.badges_error_credential_not_verified) + is ServiceTimeout, is Network, is Unexpected -> text + } + // the stored form, for support val tag: String get() = when (this) { is ServiceError -> "serviceError ${if (retryable) "retry" else "final"} ${code.text}" diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt index 9100b5ecea..cf453d7f88 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt @@ -27,6 +27,8 @@ import chat.simplex.common.model.SMPProxyMode.Always import dev.icerock.moko.resources.compose.painterResource import chat.simplex.common.platform.* import chat.simplex.common.ui.theme.* +import chat.simplex.common.views.badges.BadgeStore +import chat.simplex.common.views.badges.BadgeStoreError import chat.simplex.common.views.call.* import chat.simplex.common.views.chat.item.contentModerationPostLink import chat.simplex.common.views.chat.item.showContentBlockedAlert @@ -587,13 +589,38 @@ object ChatController { } } + // log = false because a store receipt is a bearer secret, like a badge code - it is in the command. + suspend fun apiPurchaseBadge(rh: Long?, userId: Long, echoedInvoiceId: String?, payment: ServicePayment): BadgePurchaseResult { + val r = sendCmd(rh, CC.ApiPurchaseBadge(userId, echoedInvoiceId, payment), log = false) + return when { + r is API.Result && r.res is CR.BadgeStateR -> BadgePurchaseResult.Held(r.res.user, r.res.badgeState, r.res.storePurchases) + r is API.Result && r.res is CR.BadgeRedeemed -> BadgePurchaseResult.Credited(r.res.user.updateRemoteHostId(rh), r.res.badgeState) + r is API.Error -> BadgePurchaseResult.Failed(r.err) + else -> { + // the response type alone - it names a case or a JSON key, never the service's message + Log.e(TAG, "apiPurchaseBadge: unexpected ${r.responseType}") + BadgePurchaseResult.Failed(null) + } + } + } + + suspend fun apiCreateBadgeInvoice(rh: Long?, userId: Long): String { + val r = sendCmd(rh, CC.ApiCreateBadgeInvoice(userId)) + if (r is API.Result && r.res is CR.BadgeInvoice) return r.res.invoiceId + if (r is API.Error) throw BadgeStoreError.ApiError(r.err) + throw Exception("apiCreateBadgeInvoice: unexpected ${r.responseType}") + } + // localized where the user can act on it; otherwise the error itself, so a screenshot says what happened - fun redeemErrorText(err: ChatError?): String { + fun redeemErrorText(err: ChatError?, purchase: Boolean): String { if (err is ChatError.ChatErrorChat && err.errorType is ChatErrorType.CEBadgeRedeemError) { when (val e = err.errorType.badgeRedeemError) { is BadgeRedeemError.InvalidCode -> return generalGetString(MR.strings.badges_error_invalid_code) - is BadgeRedeemError.ServiceNotConfigured -> return generalGetString(MR.strings.badges_error_service_not_configured) - is BadgeRedeemError.BadgeActive -> return generalGetString(MR.strings.badges_error_already_active) + is BadgeRedeemError.InvalidReceipt -> {} + is BadgeRedeemError.ServiceNotConfigured -> + return generalGetString(if (purchase) MR.strings.badges_error_service_not_configured_purchase else MR.strings.badges_error_service_not_configured) + is BadgeRedeemError.BadgeActive -> + return generalGetString(if (purchase) MR.strings.badges_error_already_active_purchase else MR.strings.badges_error_already_active) is BadgeRedeemError.ServiceError -> badgeServiceErrorText(e.serviceError)?.let { return it } is BadgeRedeemError.InvalidResponse -> return String.format(generalGetString(MR.strings.badges_error_bad_service_response), e.message) is BadgeRedeemError.UnknownKeyIndex, is BadgeRedeemError.CredentialNotVerified -> return generalGetString(MR.strings.badges_error_credential_not_verified) @@ -602,9 +629,9 @@ object ChatController { return "${generalGetString(MR.strings.error_prefix)}: ${err?.string ?: generalGetString(MR.strings.badges_error_unknown)}" } - suspend fun apiGetBadgeState(rh: Long?, userId: Long): BadgeState? { + suspend fun apiGetBadgeState(rh: Long?, userId: Long): Pair> { val r = sendCmd(rh, CC.ApiGetBadgeState(userId)) - if (r is API.Result && r.res is CR.BadgeStateR) return r.res.badgeState + if (r is API.Result && r.res is CR.BadgeStateR) return r.res.badgeState to r.res.storePurchases throw Exception("apiGetBadgeState: unexpected ${r.responseType}") } @@ -637,11 +664,14 @@ object ChatController { // Not thrown: a failed badge read must not stop the app starting, and the model is left alone // rather than set to nil, which would read as "no badge". - private suspend fun loadBadgeState(rhId: Long?) { + suspend fun loadBadgeState(rhId: Long?) { try { val userId = currentUserId("loadBadgeState") - val badgeState = apiGetBadgeState(rhId, userId) - withContext(Dispatchers.Main) { BadgeModel.set(rhId, userId, badgeState) } + val (badgeState, storePurchases) = apiGetBadgeState(rhId, userId) + withContext(Dispatchers.Main) { + BadgeModel.set(rhId, userId, badgeState) + BadgeStore.setStorePurchases(rhId, userId, storePurchases) + } } catch (e: Exception) { Log.e(TAG, "loadBadgeState: ${e.message}") } @@ -686,6 +716,7 @@ object ChatController { } apiStartChat() appPrefs.chatStopped.set(false) + withLongRunningApi { BadgeStore.presentUnfinished() } } catch (e: Throwable) { Log.e(TAG, "failed starting chat $e") throw e @@ -751,6 +782,7 @@ object ChatController { chatModel.users.clear() chatModel.users.addAll(users) getUserChatData(rhId, keepingChatId = keepingChatId) + withLongRunningApi { BadgeStore.presentUnfinished() } val invitation = chatModel.callInvitations.values.firstOrNull { inv -> inv.user.userId == toUserId } if (invitation != null && currentUser != null) { chatModel.callManager.reportNewIncomingCall(invitation.copy(user = currentUser)) @@ -3581,6 +3613,9 @@ object ChatController { BadgeModel.setAlert(rhId, r.user.userId, r.badgeAlert) } } + is CR.StorePurchaseResolved -> + // whichever profile owns it: only the app can finish the store purchase + withLongRunningApi { BadgeStore.presentUnfinished() } else -> Log.d(TAG , "unsupported event: ${msg.responseType}") } @@ -3622,7 +3657,7 @@ object ChatController { getUserChatData(null) } - private fun activeUser(rhId: Long?, user: UserLike): Boolean = + fun activeUser(rhId: Long?, user: UserLike): Boolean = rhId == chatModel.remoteHostId() && user.userId == chatModel.currentUser.value?.userId private fun withCall(r: CR, contact: Contact, perform: (Call) -> Unit) { @@ -3884,6 +3919,17 @@ sealed class BadgeRedeemResult { class Failed(val err: ChatError?): BadgeRedeemResult() } +@Serializable +data class OpenStorePurchase(val invoiceId: String? = null, val transactionRef: String? = null, val creditError: BadgeIssueFailure? = null) + +// a refusal is Failed, with the code in BREServiceError +sealed class BadgePurchaseResult { + class Held(val user: UserRef, val badgeState: BadgeState?, val storePurchases: List): BadgePurchaseResult() + class Credited(val user: User, val badgeState: BadgeState?): BadgePurchaseResult() + // err is null for a response of an unexpected type, which is logged where it is received + class Failed(val err: ChatError?): BadgePurchaseResult() +} + // ChatCommand // Spec: spec/api.md#CC sealed class CC { @@ -4064,6 +4110,8 @@ sealed class CC { class ApiStandaloneFileInfo(val url: String): CC() // badges class ApiRedeemBadgeCode(val userId: Long, val code: String): CC() + class ApiPurchaseBadge(val userId: Long, val echoedInvoiceId: String?, val payment: ServicePayment): CC() + class ApiCreateBadgeInvoice(val userId: Long): CC() class ApiGetBadgeState(val userId: Long): CC() class ApiGetBadgeLedger(val userId: Long, val badgePurchaseId: Long): CC() class ApiAckBadgeAlert(val userId: Long, val badgePurchaseId: Long, val alertKind: BadgeAlertKind, val snooze: Boolean, val episode: String): CC() @@ -4289,6 +4337,8 @@ sealed class CC { is ApiDownloadStandaloneFile -> "/_download $userId $url ${file.filePath}" is ApiStandaloneFileInfo -> "/_download info $url" is ApiRedeemBadgeCode -> "/_redeem_badge_code $userId $code" + is ApiPurchaseBadge -> "/_badge purchase $userId${echoedInvoiceId?.let { " invoice=$it" } ?: ""} ${json.encodeToString(payment)}" + is ApiCreateBadgeInvoice -> "/_badge invoice $userId" is ApiGetBadgeState -> "/_badge state $userId" is ApiGetBadgeLedger -> "/_badge ledger $userId $badgePurchaseId" is ApiAckBadgeAlert -> "/_badge ack $userId $badgePurchaseId ${badgeAlertKindParam(alertKind)} ${onOff(snooze)} $episode" @@ -4473,6 +4523,8 @@ sealed class CC { is ApiDownloadStandaloneFile -> "apiDownloadStandaloneFile" is ApiStandaloneFileInfo -> "apiStandaloneFileInfo" is ApiRedeemBadgeCode -> "apiRedeemBadgeCode" + is ApiPurchaseBadge -> "apiPurchaseBadge" + is ApiCreateBadgeInvoice -> "apiCreateBadgeInvoice" is ApiGetBadgeState -> "apiGetBadgeState" is ApiGetBadgeLedger -> "apiGetBadgeLedger" is ApiAckBadgeAlert -> "apiAckBadgeAlert" @@ -4497,8 +4549,11 @@ sealed class CC { is ApiUnhideUser -> ApiUnhideUser(userId, obfuscate(viewPwd)) is ApiDeleteUser -> ApiDeleteUser(userId, delSMPQueues, obfuscateOrNull(viewPwd)) is TestStorageEncryption -> TestStorageEncryption(obfuscate(key)) - // a code is a bearer secret until it is redeemed, and the terminal shows and copies cmdString + // a code or a store receipt is a bearer secret until it is redeemed, and the terminal shows and copies cmdString is ApiRedeemBadgeCode -> ApiRedeemBadgeCode(userId, obfuscate(code)) + is ApiPurchaseBadge -> ApiPurchaseBadge(userId, echoedInvoiceId, when (payment) { + is ServicePayment.Google -> ServicePayment.Google(payment.productId, obfuscate(payment.token)) + }) else -> this } @@ -4532,6 +4587,12 @@ sealed class CC { } } +// the field must stay typed as the sealed base, or kotlinx omits the "type" tag core parses by +@Serializable +sealed class ServicePayment { + @Serializable @SerialName("google") class Google(val productId: String, val token: String): ServicePayment() +} + fun onOff(b: Boolean): String = if (b) "on" else "off" // /_badge ack takes the kind in core's text encoding, not the JSON tag @@ -6865,10 +6926,12 @@ sealed class CR { // badges // the full user, not UserRef: its profile carries the badge that setUserBadge just stored @Serializable @SerialName("badgeRedeemed") class BadgeRedeemed(val user: User, val redeemedBadge: LocalBadge, val newBadge: Boolean, val badgeState: BadgeState?): CR() - @Serializable @SerialName("badgeState") class BadgeStateR(val user: UserRef, val badgeState: BadgeState?): CR() + @Serializable @SerialName("badgeInvoice") class BadgeInvoice(val user: UserRef, val invoiceId: String): CR() + @Serializable @SerialName("badgeState") class BadgeStateR(val user: UserRef, val badgeState: BadgeState?, val storePurchases: List = emptyList()): CR() @Serializable @SerialName("badgeLedger") class BadgeLedger(val user: UserRef, val badgeLedger: List): CR() @Serializable @SerialName("badgeChanged") class BadgeChanged(val user: User, val badgeState: BadgeState?): CR() @Serializable @SerialName("badgeAlert") class BadgeAlertR(val user: UserRef, val badgeAlert: BadgeAlert): CR() + @Serializable @SerialName("storePurchaseResolved") class StorePurchaseResolved(val user: UserRef): CR() // general @Serializable class Response(val type: String, val json: String): CR() @Serializable class Invalid(val str: String): CR() @@ -7056,10 +7119,12 @@ sealed class CR { is ArchiveImported -> "archiveImported" is AppSettingsR -> "appSettings" is BadgeRedeemed -> "badgeRedeemed" + is BadgeInvoice -> "badgeInvoice" is BadgeStateR -> "badgeState" is BadgeLedger -> "badgeLedger" is BadgeChanged -> "badgeChanged" is BadgeAlertR -> "badgeAlert" + is StorePurchaseResolved -> "storePurchaseResolved" is Response -> "* $type" is Invalid -> "* invalid json" } @@ -7264,10 +7329,12 @@ sealed class CR { is ArchiveImported -> "${archiveErrors.map { it.string } }" is AppSettingsR -> json.encodeToString(appSettings) is BadgeRedeemed -> withUser(user, "redeemedBadge: ${json.encodeToString(redeemedBadge)}\nnewBadge: $newBadge\nbadgeState: ${json.encodeToString(badgeState)}") - is BadgeStateR -> withUser(user, json.encodeToString(badgeState)) + is BadgeInvoice -> withUser(user, invoiceId) + is BadgeStateR -> withUser(user, "${json.encodeToString(badgeState)}\nstorePurchases: ${json.encodeToString(storePurchases)}") is BadgeLedger -> withUser(user, json.encodeToString(badgeLedger)) is BadgeChanged -> withUser(user, json.encodeToString(badgeState)) is BadgeAlertR -> withUser(user, json.encodeToString(badgeAlert)) + is StorePurchaseResolved -> withUser(user, noDetails()) is Response -> json is Invalid -> str } @@ -7323,6 +7390,7 @@ sealed class SimplexDomainError { sealed class BadgeRedeemError { val string: String get() = when (this) { is InvalidCode -> "invalidCode" + is InvalidReceipt -> "invalidReceipt" is ServiceNotConfigured -> "serviceNotConfigured" is BadgeActive -> "badgeActive" is ServiceError -> "serviceError ${serviceError.text}" @@ -7331,6 +7399,7 @@ sealed class BadgeRedeemError { is CredentialNotVerified -> "credentialNotVerified" } @Serializable @SerialName("invalidCode") object InvalidCode : BadgeRedeemError() + @Serializable @SerialName("invalidReceipt") object InvalidReceipt : BadgeRedeemError() @Serializable @SerialName("serviceNotConfigured") object ServiceNotConfigured : BadgeRedeemError() @Serializable @SerialName("badgeActive") object BadgeActive : BadgeRedeemError() @Serializable @SerialName("serviceError") class ServiceError(val serviceError: BadgeServiceErrorCode) : BadgeRedeemError() @@ -7352,6 +7421,7 @@ sealed class BadgeServiceErrorCode { object PaymentNotEntitled: BadgeServiceErrorCode() object PaymentPending: BadgeServiceErrorCode() object ProviderUnavailable: BadgeServiceErrorCode() + object ProviderNotConfigured: BadgeServiceErrorCode() object RateLimited: BadgeServiceErrorCode() object CodeInvalid: BadgeServiceErrorCode() object CodeUsed: BadgeServiceErrorCode() @@ -7373,6 +7443,7 @@ sealed class BadgeServiceErrorCode { is PaymentNotEntitled -> "payment_not_entitled" is PaymentPending -> "payment_pending" is ProviderUnavailable -> "provider_unavailable" + is ProviderNotConfigured -> "provider_not_configured" is RateLimited -> "rate_limited" is CodeInvalid -> "code_invalid" is CodeUsed -> "code_used" @@ -7392,6 +7463,12 @@ fun badgeServiceErrorText(code: BadgeServiceErrorCode): String? = when (code) { is BadgeServiceErrorCode.UnsupportedVersion -> generalGetString(MR.strings.badges_error_unsupported_version) is BadgeServiceErrorCode.UnknownPurchaseKey -> generalGetString(MR.strings.badges_error_unknown_purchase) is BadgeServiceErrorCode.Internal -> generalGetString(MR.strings.badges_error_service_internal) + is BadgeServiceErrorCode.ReceiptInvalid -> generalGetString(MR.strings.badges_error_receipt_invalid) + is BadgeServiceErrorCode.ReceiptUsed -> generalGetString(MR.strings.badges_error_receipt_used) + is BadgeServiceErrorCode.PaymentPending -> generalGetString(MR.strings.badges_error_payment_pending) + is BadgeServiceErrorCode.ProviderUnavailable -> generalGetString(MR.strings.badges_error_provider_unavailable) + is BadgeServiceErrorCode.ProviderNotConfigured -> generalGetString(MR.strings.badges_error_provider_not_configured) + is BadgeServiceErrorCode.ProductUnavailable -> generalGetString(MR.strings.badges_error_product_unavailable) else -> null } @@ -7409,6 +7486,7 @@ object BadgeServiceErrorCodeSerializer : KSerializer { "payment_not_entitled" -> BadgeServiceErrorCode.PaymentNotEntitled "payment_pending" -> BadgeServiceErrorCode.PaymentPending "provider_unavailable" -> BadgeServiceErrorCode.ProviderUnavailable + "provider_not_configured" -> BadgeServiceErrorCode.ProviderNotConfigured "rate_limited" -> BadgeServiceErrorCode.RateLimited "code_invalid" -> BadgeServiceErrorCode.CodeInvalid "code_used" -> BadgeServiceErrorCode.CodeUsed diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt index 7d126096e8..f4e902b967 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt @@ -13,6 +13,7 @@ import chat.simplex.common.views.badges.BadgeProduct import chat.simplex.common.views.badges.BadgePurchaseOutcome import chat.simplex.common.views.badges.BadgeStoreError import chat.simplex.common.views.badges.BadgeStoreProductId +import chat.simplex.common.views.badges.BadgeStoreReceipt import kotlinx.coroutines.Job import java.io.Closeable @@ -44,6 +45,9 @@ interface PlatformInterface { return emptyList() } suspend fun androidPurchaseBadge(id: BadgeStoreProductId, invoiceId: String): BadgePurchaseOutcome = throw BadgeStoreError.StoreUnavailable + suspend fun androidAcknowledgeBadgePurchase(receipt: BadgeStoreReceipt) {} + suspend fun androidFinishBadgePurchase(receipt: BadgeStoreReceipt) {} + suspend fun androidUnfinishedBadgePurchases(): List = emptyList() val androidApiLevel: Int? get() = null // The build distributed via Google Play, which has to follow its policies val androidIsPlayStoreBuild: Boolean get() = false diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index 2c7dfd05f6..ae6ecd3876 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -1,7 +1,16 @@ package chat.simplex.common.views.badges +import androidx.compose.runtime.Composable +import androidx.compose.runtime.LaunchedEffect import androidx.compose.runtime.mutableStateOf +import chat.simplex.common.model.* +import chat.simplex.common.model.ChatController.appPrefs import chat.simplex.common.platform.* +import kotlinx.coroutines.CancellationException +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.NonCancellable +import kotlinx.coroutines.flow.MutableSharedFlow +import kotlinx.coroutines.withContext import java.text.NumberFormat import java.util.Currency import java.util.UUID @@ -29,15 +38,33 @@ val badgeStoreProductIds: List = BadgeLevel.entries.flatMap BadgePeriod.entries.map { badgeStoreProductId(level, it) } } -// TODO [badges] replaced by APIGetBadgeInvoice, which creates the invoice row and returns its id. -// Sent to Play as obfuscatedAccountId and echoed back on the purchase, which is how the service -// learns which invoice a store transaction settles. +// the only products sent to the badge service: nothing delivers a subscription yet +val badgeOneTimeProductIds: Set = badgeStoreProductIds.filter { it.basePlanId == null }.map { it.productId }.toSet() + +// subscriptions are for sale once renewals are delivered +val badgePeriodsForSale: List = listOf(BadgePeriod.OneMonth) + +// A subscription's id only: core mints a one-time purchase's, and a subscription is never sent to core. +// Sent to Play as obfuscatedAccountId and echoed back on the purchase. fun newBadgeInvoiceId(): String = UUID.randomUUID().toString() // the page's app flag rides in the fragment, which never reaches the service +// TEST ONLY: pointed at the dev deployment; restore the two lines below before merging val badgePageUrl: String = - if (appPlatform.isAndroid) "https://badges.simplex.chat/#/tier?app=true" - else "https://badges.simplex.chat/#/tier?app=desktop" + if (appPlatform.isAndroid) "https://smp7.simplex.im/#/tier?app=true" + else "https://smp7.simplex.im/#/tier?app=desktop" +// if (appPlatform.isAndroid) "https://badges.simplex.chat/#/tier?app=true" +// else "https://badges.simplex.chat/#/tier?app=desktop" + +// where the store allows a link out to the badge page: the US for now, a set expected to widen. +// An unknown country does not count, as this decides whether the store sees a link out of the app. +@Composable +fun badgeBrowserAllowed(): Boolean { + if (androidPlayStoreCountry.value == null) { + LaunchedEffect(Unit) { platform.androidLoadPlayStoreCountry() } + } + return androidPlayStoreCountry.value == "US" +} // what the platform store knows about one product; ProductDetails cannot cross into commonMain data class BadgeProduct( @@ -63,10 +90,8 @@ data class BadgeStoreReceipt( // the token the badge service verifies with the Publisher API val token: String, val productId: String, - val orderId: String?, val invoiceId: String?, - // only set for test products - a real Play purchase has no environment to report - val environment: String? = null + val acknowledged: Boolean = false ) // TODO [badges] Play Billing has no offline product configuration. Set to true to price the screens @@ -74,6 +99,9 @@ data class BadgeStoreReceipt( // receipt says so. const val useBadgeTestProducts = false +// test products stand in for a store, so the lane is offered without one +val badgeStoreAvailable: Boolean get() = useBadgeTestProducts || platform.androidHasPlatformStore + private fun testProduct(level: BadgeLevel, period: BadgePeriod, priceMicros: Long) = BadgeProduct(badgeStoreProductId(level, period), "\$${priceMicros / 1_000_000}.00", priceMicros, "USD") @@ -88,20 +116,29 @@ private val testBadgeProducts: List = listOf( sealed class BadgePurchaseOutcome { class Purchased(val receipt: BadgeStoreReceipt): BadgePurchaseOutcome() - object Pending: BadgePurchaseOutcome() + class Pending(val invoiceId: String?): BadgePurchaseOutcome() object Cancelled: BadgePurchaseOutcome() } +enum class BadgePurchaseState { + Issuing, + WaitingForApproval +} + sealed class BadgeStoreError: Exception() { class ProductUnavailable(val productId: String): BadgeStoreError() class BillingError(val responseCode: Int, val debugMessage: String): BadgeStoreError() object StoreUnavailable: BadgeStoreError() + object NoActiveProfile: BadgeStoreError() + class ApiError(val err: ChatError): BadgeStoreError() override val message: String get() = when (this) { is ProductUnavailable -> "productUnavailable(productId: $productId)" is BillingError -> "billingError(responseCode: $responseCode, $debugMessage)" is StoreUnavailable -> "storeUnavailable" + is NoActiveProfile -> "noActiveProfile" + is ApiError -> "apiError(${err.string})" } } @@ -111,12 +148,49 @@ object BadgeStore { private val state = mutableStateOf(LoadState.NotLoaded) // snapshot state so a composable reading only the products still recomposes when they arrive private val products = mutableStateOf>(emptyMap()) + // core's open store purchases for the profile they were read for: core knows whose a purchase is + private val storePurchases = mutableStateOf>?>(null) + // whether a store sheet this run opened has not returned + private val buying = mutableStateOf(false) + // by invoice id, so a pending purchase shows only under the profile whose record it names + private val waitingForApproval = mutableStateOf>(emptySet()) + // set once presentUnfinished has read the store, or failed to: until then, a slow payment completed while + // the app was closed, or a purchase it died before handing over, are both unknown, so canBuy refuses + private val reconciledOnce = mutableStateOf(false) + val refusals = MutableSharedFlow() - fun price(level: BadgeLevel, period: BadgePeriod): BadgePrice = when (state.value) { + fun purchaseState(userId: Long?): BadgePurchaseState? { + if (!badgeStoreAvailable) return null + val purchases = openStorePurchases(userId) + return when { + purchases.any { it.transactionRef != null } -> BadgePurchaseState.Issuing + purchases.any { it.invoiceId?.let(waitingForApproval.value::contains) == true } -> BadgePurchaseState.WaitingForApproval + else -> null + } + } + + fun creditError(userId: Long?): BadgeIssueFailure? = + openStorePurchases(userId).firstNotNullOfOrNull { it.creditError } + + val checkingPurchases: Boolean get() = badgeStoreAvailable && !reconciledOnce.value + + fun canBuy(userId: Long?): Boolean = + badgeStoreAvailable && reconciledOnce.value && !buying.value && purchaseState(userId) == null + + fun setStorePurchases(rhId: Long?, userId: Long, purchases: List) { + storePurchases.value = Triple(rhId, userId, purchases) + } + + private fun openStorePurchases(userId: Long?): List { + val (rhId, readFor, purchases) = storePurchases.value ?: return emptyList() + return if (rhId == chatModel.remoteHostId() && readFor == userId) purchases else emptyList() + } + + fun price(level: BadgeLevel, period: BadgePeriod, compact: Boolean = true): BadgePrice = when (state.value) { LoadState.NotLoaded, LoadState.Loading -> BadgePrice.Loading LoadState.Loaded, LoadState.Failed -> { val p = products.value[badgeStoreProductId(level, period)] - if (p != null) BadgePrice.Price(compactPrice(p)) else BadgePrice.Unavailable + if (p != null) BadgePrice.Price(if (compact) compactPrice(p) else p.displayPrice) else BadgePrice.Unavailable } } @@ -151,21 +225,146 @@ object BadgeStore { } } - suspend fun purchase(level: BadgeLevel, period: BadgePeriod, invoiceId: String): BadgePurchaseOutcome { + // A one-time purchase has its core record before the store charges, and every store outcome reaches it. + suspend fun purchase(level: BadgeLevel, period: BadgePeriod): BadgePurchaseOutcome { val id = badgeStoreProductId(level, period) if (!products.value.containsKey(id)) throw BadgeStoreError.ProductUnavailable(id.productId) - if (useBadgeTestProducts) { - return BadgePurchaseOutcome.Purchased( + // a subscription is never sent to core, so nothing would ever finish it later + if (id.productId !in badgeOneTimeProductIds) { + val outcome = storePurchase(id, newBadgeInvoiceId()) + if (outcome is BadgePurchaseOutcome.Purchased) finish(outcome.receipt) + return outcome + } + val rhId = chatModel.remoteHostId() + val userId = chatModel.currentUser.value?.userId ?: throw BadgeStoreError.NoActiveProfile + val invoiceId = chatModel.controller.apiCreateBadgeInvoice(rhId, userId) + withContext(Dispatchers.Main) { buying.value = true } + chatModel.controller.loadBadgeState(rhId) + try { + val outcome = storePurchase(id, invoiceId) + if (outcome is BadgePurchaseOutcome.Purchased) { + handOver(outcome.receipt) + } + return outcome + } finally { + withContext(Dispatchers.Main + NonCancellable) { buying.value = false } + } + } + + private suspend fun storePurchase(id: BadgeStoreProductId, invoiceId: String): BadgePurchaseOutcome { + val outcome = if (useBadgeTestProducts) { + BadgePurchaseOutcome.Purchased( BadgeStoreReceipt( token = "test-${UUID.randomUUID()}", productId = id.productId, - orderId = null, - invoiceId = invoiceId, - environment = "test products" + invoiceId = invoiceId ) ) + } else { + platform.androidPurchaseBadge(id, invoiceId) + } + if (outcome is BadgePurchaseOutcome.Pending && outcome.invoiceId != null) withContext(Dispatchers.Main) { waitingForApproval.value += outcome.invoiceId } + return outcome + } + + // Core holds the receipt and credits it; the purchase stays unfinished until core answers it credited + // or refused, as an unfinished purchase is what the store re-delivers if anything is lost on the way. + private suspend fun handOver(receipt: BadgeStoreReceipt) { + val rhId = chatModel.remoteHostId() + val userId = chatModel.currentUser.value?.userId ?: return + when (val r = chatModel.controller.apiPurchaseBadge(rhId, userId, receipt.invoiceId, ServicePayment.Google(receipt.productId, receipt.token))) { + is BadgePurchaseResult.Held -> { + // core holds it durably now, so Play must not refund it after three days unacknowledged + acknowledge(receipt) + withContext(Dispatchers.Main) { + // the answer is the owner's, which may be another profile and a hidden one + if (chatModel.controller.activeUser(rhId, r.user)) { + BadgeModel.set(rhId, r.user.userId, r.badgeState) + setStorePurchases(rhId, r.user.userId, r.storePurchases) + } + } + } + is BadgePurchaseResult.Credited -> { + withContext(Dispatchers.Main) { + if (chatModel.controller.activeUser(rhId, r.user)) { + BadgeModel.set(rhId, r.user.userId, r.badgeState) + chatModel.updateUser(r.user) + if (r.badgeState?.shown == true) appPrefs.supporterBannerShown.set(true) + } + } + resolve(receipt, refusal = null) + } + // a refusal is announced where it reads as its own, so only an unexpected answer reaches the buyer + is BadgePurchaseResult.Failed -> + if (badgeReceiptRefused(r.err)) { + Log.e(TAG, "BadgeStore.handOver: ${r.err?.string}") + resolve(receipt, refusal = r.err) + } else { + throw r.err?.let(BadgeStoreError::ApiError) ?: Exception("apiPurchaseBadge: unexpected response") + } + } + } + + private suspend fun resolve(receipt: BadgeStoreReceipt, refusal: ChatError?) { + finish(receipt) + if (refusal != null) { + withContext(Dispatchers.Main) { refusals.emit(refusal) } + } + } + + // at launch, on return to the foreground, on a profile switch and when core resolves a purchase, never on a timer + suspend fun presentUnfinished() { + try { + if (!useBadgeTestProducts && platform.androidHasPlatformStore) { + try { + val purchases = platform.androidUnfinishedBadgePurchases() + // Play lists a purchase awaiting payment, so unlike on iOS the waiting state is re-found here + withContext(Dispatchers.Main) { waitingForApproval.value = purchases.mapNotNull { (it as? BadgePurchaseOutcome.Pending)?.invoiceId }.toSet() } + purchases.forEach { reconcile(it) } + } catch (e: Exception) { + if (e is CancellationException) throw e + Log.e(TAG, "BadgeStore.presentUnfinished: ${e.message}") + } + } + chatModel.controller.loadBadgeState(chatModel.remoteHostId()) + } finally { + withContext(Dispatchers.Main + NonCancellable) { reconciledOnce.value = true } + } + } + + suspend fun reconcile(outcome: BadgePurchaseOutcome) { + when (outcome) { + is BadgePurchaseOutcome.Purchased -> + if (outcome.receipt.productId !in badgeOneTimeProductIds) finish(outcome.receipt) + // no buyer to tell: the purchase stays unfinished and the next sweep hands it over again + else try { + handOver(outcome.receipt) + } catch (e: Exception) { + if (e is CancellationException) throw e + Log.e(TAG, "BadgeStore.reconcile: ${e.stackTraceToString()}") + } + is BadgePurchaseOutcome.Pending -> + if (outcome.invoiceId != null) withContext(Dispatchers.Main) { waitingForApproval.value += outcome.invoiceId } + is BadgePurchaseOutcome.Cancelled -> {} + } + } + + private suspend fun acknowledge(receipt: BadgeStoreReceipt) { + try { + if (!useBadgeTestProducts) platform.androidAcknowledgeBadgePurchase(receipt) + } catch (e: Exception) { + // the next sweep hands the purchase over again, and acknowledges it then + Log.e(TAG, "BadgeStore.acknowledge: ${e.message}") + } + } + + private suspend fun finish(receipt: BadgeStoreReceipt) { + try { + if (!useBadgeTestProducts) platform.androidFinishBadgePurchase(receipt) + } catch (e: Exception) { + // still unfinished: the store re-delivers it, and the next answer for it finishes it + Log.e(TAG, "BadgeStore.finish: ${e.message}") } - return platform.androidPurchaseBadge(id, invoiceId) } private fun startLoading(): Boolean = when (state.value) { @@ -190,3 +389,10 @@ private fun compactPrice(product: BadgeProduct): String { product.displayPrice } } + +// the codes core refuses a receipt with for good, after which the store may stop re-delivering it +private fun badgeReceiptRefused(err: ChatError?): Boolean { + val redeemError = ((err as? ChatError.ChatErrorChat)?.errorType as? ChatErrorType.CEBadgeRedeemError)?.badgeRedeemError + val code = (redeemError as? BadgeRedeemError.ServiceError)?.serviceError + return code is BadgeServiceErrorCode.ReceiptInvalid || code is BadgeServiceErrorCode.ReceiptUsed +} diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeUserPreview.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeUserPreview.kt index 03fabf817e..53c9f98f60 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeUserPreview.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeUserPreview.kt @@ -19,7 +19,7 @@ import chat.simplex.res.MR import kotlinx.datetime.Instant @Composable -fun BadgeUserPreview(level: BadgeLevel, modifier: Modifier = Modifier, trailing: @Composable () -> Unit = {}) { +fun BadgeUserPreview(level: BadgeLevel, modifier: Modifier = Modifier) { val user = chatModel.currentUser.value val displayName = user?.displayName ?: stringResource(MR.strings.badges_preview_my_nickname) val previewBadge = LocalBadge( @@ -29,15 +29,12 @@ fun BadgeUserPreview(level: BadgeLevel, modifier: Modifier = Modifier, trailing: ) Column(modifier, horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.spacedBy(12.dp)) { ProfileImage(size = 128.dp, image = user?.image) - Row(verticalAlignment = Alignment.CenterVertically, horizontalArrangement = Arrangement.spacedBy(6.dp)) { - NameWithBadge( - name = displayName, - badge = previewBadge, - style = MaterialTheme.typography.h1.copy(fontWeight = FontWeight.Normal), - maxLines = 1, - overflow = TextOverflow.Ellipsis - ) - trailing() - } + NameWithBadge( + name = displayName, + badge = previewBadge, + style = MaterialTheme.typography.h1.copy(fontWeight = FontWeight.Normal), + maxLines = 1, + overflow = TextOverflow.Ellipsis + ) } } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt new file mode 100644 index 0000000000..90f459a520 --- /dev/null +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt @@ -0,0 +1,107 @@ +package chat.simplex.common.views.badges + +import androidx.compose.foundation.background +import androidx.compose.foundation.layout.* +import androidx.compose.foundation.shape.RoundedCornerShape +import androidx.compose.material.* +import androidx.compose.runtime.* +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import dev.icerock.moko.resources.StringResource +import dev.icerock.moko.resources.compose.stringResource +import chat.simplex.common.platform.* +import chat.simplex.common.ui.theme.* +import chat.simplex.common.views.helpers.* +import chat.simplex.common.views.onboarding.OnboardingActionButton +import chat.simplex.res.MR + +@Composable +fun BadgesCheckOrderView(level: BadgeLevel, period: BadgePeriod, modalManager: ModalManager, unwindToDepth: Int) { + val purchasing = remember { mutableStateOf(false) } + + LaunchedEffect(Unit) { BadgeStore.load() } + CloseWhenSupportGivesWay(modalManager, unwindToDepth) + + ColumnWithScrollBar( + Modifier.padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), + verticalArrangement = Arrangement.spacedBy(16.dp), + horizontalAlignment = Alignment.CenterHorizontally, + maxIntrinsicSize = true, + ) { + Text( + stringResource(MR.strings.badges_check_your_order_title), + style = MaterialTheme.typography.h1, + fontWeight = FontWeight.Bold, + color = MaterialTheme.colors.primary, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + + Column( + Modifier + .fillMaxWidth() + .padding(top = 20.dp) + .clip(RoundedCornerShape(16.dp)) + .background(sectionCardColor()) + .padding(horizontal = 24.dp, vertical = 12.dp) + ) { + OrderRow(MR.strings.badges_your_badge, stringResource(level.title)) + OrderRow(MR.strings.badges_order_duration, stringResource(period.label)) + Divider(Modifier.padding(top = 8.dp, bottom = 6.dp)) + OrderRow(MR.strings.badges_order_total, period.priceText(BadgeStore.price(level, period, compact = false))) + } + + Spacer(Modifier.weight(1f).heightIn(min = 20.dp)) + + Column(horizontalAlignment = Alignment.CenterHorizontally) { + PayButton(level, period, purchasing) + BadgeBillingFooter(period) + } + } +} + +@Composable +private fun OrderRow(title: StringResource, value: String) { + Row(Modifier.fillMaxWidth().padding(vertical = 8.dp)) { + Text(stringResource(title), style = MaterialTheme.typography.body1, color = MaterialTheme.colors.secondary) + Spacer(Modifier.weight(1f)) + Text(value, style = MaterialTheme.typography.body1, fontWeight = FontWeight.Medium) + } +} + +@Composable +private fun PayButton(level: BadgeLevel, period: BadgePeriod, purchasing: MutableState) { + val price = BadgeStore.price(level, period, compact = false) + val (labelId, labelArg) = period.payLabel(price) + OnboardingActionButton( + modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), + labelId = labelId, + labelArg = labelArg, + onboarding = null, + enabled = price.canPurchase && !purchasing.value && BadgeStore.canBuy(chatModel.currentUser.value?.userId), + onclick = { purchase(level, period, purchasing) } + ) +} + +private fun purchase(level: BadgeLevel, period: BadgePeriod, purchasing: MutableState) { + purchasing.value = true + // not withBGApi: the purchase waits for the user in the Play sheet and would block chat API calls + withLongRunningApi { + try { + BadgeStore.purchase(level, period) + purchasing.value = false + } catch (e: Exception) { + Log.e(TAG, "BadgesCheckOrderView.purchase: ${e.stackTraceToString()}") + purchasing.value = false + AlertManager.shared.showAlertMsg( + title = generalGetString(MR.strings.badges_purchase_error), + text = if (e is BadgeStoreError.ApiError) chatModel.controller.redeemErrorText(e.err, purchase = true) + else "${generalGetString(MR.strings.error_prefix)}: ${e.message ?: e}" + ) + } + } +} diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt index b8324cc9c9..0fac45ac81 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesChooseBadgeView.kt @@ -34,10 +34,16 @@ enum class BadgeLevel { Legend -> MR.strings.badges_level_legend } - val filesDescription: StringResource + val fileSize: StringResource get() = when (this) { - Supporter -> MR.strings.badges_level_supporter_files - Legend -> MR.strings.badges_level_legend_files + Supporter -> MR.strings.badges_level_supporter_file_size + Legend -> MR.strings.badges_level_legend_file_size + } + + val fileStorage: StringResource + get() = when (this) { + Supporter -> MR.strings.badges_level_supporter_file_storage + Legend -> MR.strings.badges_level_legend_file_storage } val summary: StringResource @@ -54,10 +60,11 @@ enum class BadgeLevel { } @Composable -fun BadgesChooseBadgeView(modalManager: ModalManager) { +fun BadgesChooseBadgeView(modalManager: ModalManager, unwindToDepth: Int) { var selectedLevel by remember { mutableStateOf(BadgeLevel.Supporter) } LaunchedEffect(Unit) { BadgeStore.load() } + CloseWhenSupportGivesWay(modalManager, unwindToDepth) ColumnWithScrollBar( Modifier.background(MaterialTheme.colors.background).padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), @@ -82,15 +89,9 @@ fun BadgesChooseBadgeView(modalManager: ModalManager) { modifier = Modifier.fillMaxWidth() ) - BadgeUserPreview(level = selectedLevel, modifier = Modifier.padding(top = 4.dp)) { - Icon( - painterResource(MR.images.ic_keyboard_arrow_down), - contentDescription = null, - tint = MaterialTheme.colors.primary - ) - } + BadgeUserPreview(level = selectedLevel, modifier = Modifier.padding(top = 4.dp)) - Spacer(Modifier.weight(1f).heightIn(min = 20.dp)) + Spacer(Modifier.weight(1f).heightIn(min = 12.dp)) // IntrinsicSize.Max + fillMaxHeight on children so both cards match the taller card's height // when 2-line labels at large fonts would otherwise size them differently. @@ -102,17 +103,18 @@ fun BadgesChooseBadgeView(modalManager: ModalManager) { LevelCard(BadgeLevel.Legend, selectedLevel, Modifier.weight(1f).fillMaxHeight()) { selectedLevel = it } } - Spacer(Modifier.weight(1f).heightIn(min = 20.dp)) + Spacer(Modifier.weight(1f).heightIn(min = 12.dp)) // Nested Column with no spacing so the TextButtonBelowOnboardingButton sits directly under // the action button (matches onboarding pattern where its own 7.5dp top padding is the gap). Column(horizontalAlignment = Alignment.CenterHorizontally) { - ContinueButton(selectedLevel, modalManager) - TextButtonBelowOnboardingButton( - text = stringResource(MR.strings.badges_how_it_works_button), - icon = painterResource(MR.images.ic_info), - onClick = { modalManager.showModal { BadgesHowItWorksView() } } - ) + ContinueButton(selectedLevel, modalManager, unwindToDepth) + // redeeming a code is here only when Support SimpleX offers the browser instead + if (badgeBrowserAllowed()) { + RedeemCodeButton(modalManager, unwindToDepth) + } else { + TextButtonBelowOnboardingButton("", null) + } } } } @@ -131,7 +133,7 @@ private fun LevelCard(level: BadgeLevel, selectedLevel: BadgeLevel, modifier: Mo .background(cardBackground, shape) .border(2.dp, borderColor, shape) .clickable { onSelect(level) } - .padding(vertical = 20.dp, horizontal = 12.dp), + .padding(vertical = 16.dp, horizontal = 12.dp), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.spacedBy(10.dp) ) { @@ -139,22 +141,25 @@ private fun LevelCard(level: BadgeLevel, selectedLevel: BadgeLevel, modifier: Mo painterResource(badgeImage(level.badgeType)), contentDescription = null, contentScale = ContentScale.Fit, - modifier = Modifier.size(60.dp) + modifier = Modifier.size(44.dp) ) Text(stringResource(level.title), style = MaterialTheme.typography.h3, fontWeight = FontWeight.Bold, textAlign = TextAlign.Center) - Text(stringResource(level.filesDescription), style = MaterialTheme.typography.body2, color = MaterialTheme.colors.secondary, textAlign = TextAlign.Center) Text(BadgePeriod.Monthly.priceText(BadgeStore.price(level, BadgePeriod.Monthly)), style = MaterialTheme.typography.body1, textAlign = TextAlign.Center) + Column(horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.spacedBy(2.dp)) { + Text(stringResource(level.fileSize), style = MaterialTheme.typography.body2, color = MaterialTheme.colors.secondary, textAlign = TextAlign.Center) + Text(stringResource(level.fileStorage), style = MaterialTheme.typography.body2, color = MaterialTheme.colors.secondary, textAlign = TextAlign.Center) + } } } @Composable -private fun ContinueButton(selectedLevel: BadgeLevel, modalManager: ModalManager) { +private fun ContinueButton(selectedLevel: BadgeLevel, modalManager: ModalManager, unwindToDepth: Int) { OnboardingActionButton( modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), labelId = MR.strings.badges_continue, onboarding = null, onclick = { - modalManager.showModal { BadgesHowLongView(selectedLevel) } + modalManager.showModal { BadgesHowLongView(selectedLevel, modalManager, unwindToDepth) } } ) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt index 2845e3986a..0dfc3ac742 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesHowLongView.kt @@ -9,10 +9,9 @@ import androidx.compose.material.* import androidx.compose.runtime.* import androidx.compose.ui.Alignment import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.alpha import androidx.compose.ui.draw.clip -import androidx.compose.ui.platform.ClipboardManager -import androidx.compose.ui.platform.LocalClipboardManager -import androidx.compose.ui.text.AnnotatedString +import androidx.compose.ui.graphics.Color import androidx.compose.ui.text.font.FontWeight import androidx.compose.ui.text.style.TextAlign import androidx.compose.ui.unit.dp @@ -45,6 +44,13 @@ enum class BadgePeriod { Annual -> MR.strings.badges_period_annual } + val months: Int + get() = when (this) { + OneMonth -> 1 + Monthly -> 1 + Annual -> 12 + } + @Composable fun priceText(price: BadgePrice): String = when (price) { is BadgePrice.Loading -> "…" @@ -68,12 +74,11 @@ enum class BadgePeriod { } @Composable -fun BadgesHowLongView(level: BadgeLevel) { - var selectedPeriod by remember { mutableStateOf(BadgePeriod.Monthly) } - val purchasing = remember { mutableStateOf(false) } - val clipboard = LocalClipboardManager.current +fun BadgesHowLongView(level: BadgeLevel, modalManager: ModalManager, unwindToDepth: Int) { + var selectedPeriod by remember { mutableStateOf(if (BadgePeriod.Monthly in badgePeriodsForSale) BadgePeriod.Monthly else BadgePeriod.OneMonth) } LaunchedEffect(Unit) { BadgeStore.load() } + CloseWhenSupportGivesWay(modalManager, unwindToDepth) ColumnWithScrollBar( Modifier.background(MaterialTheme.colors.background).padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), @@ -102,39 +107,46 @@ fun BadgesHowLongView(level: BadgeLevel) { Spacer(Modifier.weight(1f).heightIn(min = 8.dp)) - // IntrinsicSize.Max + fillMaxHeight on children so all three cards match the tallest one - + // IntrinsicSize.Max + fillMaxHeight on children so the cards all match the tallest one - // only Annual carries a savings line, and prices wrap at large fonts. Row( Modifier.fillMaxWidth().height(IntrinsicSize.Max), horizontalArrangement = Arrangement.spacedBy(12.dp) ) { - PeriodCard(level, BadgePeriod.OneMonth, selectedPeriod, Modifier.weight(1f).fillMaxHeight()) { selectedPeriod = it } - PeriodCard(level, BadgePeriod.Monthly, selectedPeriod, Modifier.weight(1f).fillMaxHeight()) { selectedPeriod = it } - PeriodCard(level, BadgePeriod.Annual, selectedPeriod, Modifier.weight(1f).fillMaxHeight()) { selectedPeriod = it } + BadgePeriod.entries.forEach { period -> + PeriodCard(level, period, selectedPeriod, Modifier.weight(1f).fillMaxHeight()) { selectedPeriod = it } + } } Spacer(Modifier.weight(1f).heightIn(min = 8.dp)) - // Replicates TextButtonBelowOnboardingButton spacing (7.5dp outer + 5dp inner) without a - // TextButton so the footer has no hover/click affordance. Column(horizontalAlignment = Alignment.CenterHorizontally) { - PayButton(level, selectedPeriod, purchasing, clipboard) - Box(Modifier.padding(top = 7.5.dp, bottom = 7.5.dp).padding(horizontal = 16.dp, vertical = 8.dp)) { - Text( - stringResource(billingFooter(selectedPeriod)).format(stubBillingDate()), - Modifier.padding(vertical = 5.dp), - style = MaterialTheme.typography.body2, - color = MaterialTheme.colors.secondary, - textAlign = TextAlign.Center - ) - } + ContinueButton(level, selectedPeriod, modalManager, unwindToDepth) + BadgeBillingFooter(selectedPeriod) } } } +// Replicates TextButtonBelowOnboardingButton spacing (7.5dp outer + 5dp inner) without a +// TextButton so the footer has no hover/click affordance. +@Composable +fun BadgeBillingFooter(period: BadgePeriod) { + Box(Modifier.padding(top = 7.5.dp, bottom = 7.5.dp).padding(horizontal = 16.dp, vertical = 8.dp)) { + Text( + stringResource(billingFooter(period)).format(billingDate(period)), + Modifier.padding(vertical = 5.dp), + style = MaterialTheme.typography.body2, + color = MaterialTheme.colors.secondary, + textAlign = TextAlign.Center + ) + } +} + @Composable private fun PeriodCard(level: BadgeLevel, period: BadgePeriod, selectedPeriod: BadgePeriod, modifier: Modifier, onSelect: (BadgePeriod) -> Unit) { val isSelected = period == selectedPeriod + val forSale = period in badgePeriodsForSale + val textColor = if (forSale) Color.Unspecified else MaterialTheme.colors.secondary val borderColor = if (isSelected) MaterialTheme.colors.primary else MaterialTheme.colors.background.mixWith(MaterialTheme.colors.onBackground, 0.92f) // Light: transparent so card matches page background. Dark: subtle gray tint for visible contrast. val cardBackground = if (isInDarkTheme()) MaterialTheme.colors.background.mixWith(MaterialTheme.colors.onBackground, 0.97f) @@ -145,7 +157,7 @@ private fun PeriodCard(level: BadgeLevel, period: BadgePeriod, selectedPeriod: B .clip(shape) .background(cardBackground, shape) .border(2.dp, borderColor, shape) - .clickable { onSelect(period) } + .clickable(enabled = forSale) { onSelect(period) } .padding(vertical = 20.dp, horizontal = 12.dp), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.spacedBy(12.dp) @@ -154,10 +166,10 @@ private fun PeriodCard(level: BadgeLevel, period: BadgePeriod, selectedPeriod: B painterResource(period.icon), contentDescription = null, tint = if (isSelected) MaterialTheme.colors.primary else MaterialTheme.colors.secondary, - modifier = Modifier.size(32.dp) + modifier = Modifier.size(32.dp).alpha(if (forSale) 1f else 0.4f) ) - Text(stringResource(period.label), style = MaterialTheme.typography.h3, fontWeight = FontWeight.Bold, textAlign = TextAlign.Center) - Text(period.priceText(BadgeStore.price(level, period)), style = MaterialTheme.typography.body1, textAlign = TextAlign.Center) + Text(stringResource(period.label), style = MaterialTheme.typography.body2, color = textColor, textAlign = TextAlign.Center) + Text(period.priceText(BadgeStore.price(level, period)), style = MaterialTheme.typography.body1, fontWeight = FontWeight.SemiBold, color = textColor, textAlign = TextAlign.Center) val percent = savingsPercent(level, period) if (percent != null) { Text( @@ -173,76 +185,15 @@ private fun PeriodCard(level: BadgeLevel, period: BadgePeriod, selectedPeriod: B private fun savingsPercent(level: BadgeLevel, period: BadgePeriod): Int? = if (period == BadgePeriod.Annual) BadgeStore.annualSavings(level) else null -// TODO [badges] on desktop and the foss build there is no store, so every price is Unavailable and -// this button stays disabled - it will offer Stripe/crypto payment instead @Composable -private fun PayButton(level: BadgeLevel, selectedPeriod: BadgePeriod, purchasing: MutableState, clipboard: ClipboardManager) { - val price = BadgeStore.price(level, selectedPeriod) - val (labelId, labelArg) = selectedPeriod.payLabel(price) +private fun ContinueButton(level: BadgeLevel, selectedPeriod: BadgePeriod, modalManager: ModalManager, unwindToDepth: Int) { OnboardingActionButton( modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), - labelId = labelId, - labelArg = labelArg, + labelId = MR.strings.badges_continue, onboarding = null, - enabled = price.canPurchase && !purchasing.value, - onclick = { purchase(level, selectedPeriod, purchasing, clipboard) } - ) -} - -private fun purchase(level: BadgeLevel, period: BadgePeriod, purchasing: MutableState, clipboard: ClipboardManager) { - val invoiceId = newBadgeInvoiceId() - purchasing.value = true - // not withBGApi: the purchase waits for the user in the Play sheet and would block chat API calls - withLongRunningApi { - try { - val outcome = BadgeStore.purchase(level, period, invoiceId) - purchasing.value = false - when (outcome) { - is BadgePurchaseOutcome.Purchased -> showPurchasedAlert(outcome.receipt, invoiceId, clipboard) - is BadgePurchaseOutcome.Pending -> AlertManager.shared.showAlertMsg( - title = generalGetString(MR.strings.badges_purchase_pending), - text = generalGetString(MR.strings.badges_purchase_pending_desc) - ) - is BadgePurchaseOutcome.Cancelled -> {} - } - } catch (e: Exception) { - Log.e(TAG, "BadgesHowLongView.purchase: ${e.stackTraceToString()}") - purchasing.value = false - AlertManager.shared.showAlertMsg( - title = generalGetString(MR.strings.badges_purchase_error), - text = e.toString() - ) + onclick = { + modalManager.showModal(cardScreen = true) { BadgesCheckOrderView(level, selectedPeriod, modalManager, unwindToDepth) } } - } -} - -// TODO [badges] store integration diagnostics - replaced by the issued badge once the service lands. -private fun showPurchasedAlert(receipt: BadgeStoreReceipt, invoiceId: String, clipboard: ClipboardManager) { - val returnedInvoice = when (receipt.invoiceId) { - null -> "none" - invoiceId -> "yes" - else -> "mismatch: ${receipt.invoiceId}" - } - val lines = mutableListOf( - "Product: ${receipt.productId}", - "Invoice: $invoiceId", - "Invoice returned by Google: $returnedInvoice", - "Order: ${receipt.orderId ?: "none"}" - ) - if (receipt.environment != null) lines.add("Environment: ${receipt.environment}") - lines.add("Token: ${receipt.token.length} bytes") - val summary = lines.joinToString("\n") - Log.d(TAG, "badge purchase succeeded\n$summary") - AlertManager.shared.showAlertDialog( - title = generalGetString(MR.strings.badges_purchase_successful), - text = summary, - confirmText = "Copy token", - onConfirm = { - clipboard.setText(AnnotatedString(receipt.token)) - showToast(generalGetString(MR.strings.copied)) - }, - dismissText = generalGetString(MR.strings.ok), - parseHtml = false ) } @@ -251,9 +202,10 @@ private fun billingFooter(period: BadgePeriod): StringResource = when (period) { BadgePeriod.OneMonth -> MR.strings.badges_billing_footer_one_month } -// TODO [badges] source the actual date from the purchase state machine when wired. -private fun stubBillingDate(): String { - val date = java.time.LocalDate.of(2026, 7, 22) +// TODO [badges] from now only because a purchase is refused while a badge is held (refuseWhileBadgeHeld); +// a top-up must count from the end of the existing balance +private fun billingDate(period: BadgePeriod): String { + val date = java.time.LocalDate.now().plusMonths(period.months.toLong()) val formatter = java.time.format.DateTimeFormatter.ofLocalizedDate(java.time.format.FormatStyle.LONG) return date.format(formatter) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt new file mode 100644 index 0000000000..4c808d60a6 --- /dev/null +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt @@ -0,0 +1,87 @@ +package chat.simplex.common.views.badges + +import androidx.compose.foundation.background +import androidx.compose.foundation.layout.* +import androidx.compose.material.* +import androidx.compose.runtime.Composable +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.graphics.Color +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.text.style.TextAlign +import androidx.compose.ui.unit.dp +import dev.icerock.moko.resources.StringResource +import dev.icerock.moko.resources.compose.painterResource +import dev.icerock.moko.resources.compose.stringResource +import chat.simplex.common.model.BadgeIssueFailure +import chat.simplex.common.platform.ColumnWithScrollBar +import chat.simplex.common.views.onboarding.TextButtonBelowOnboardingButton +import chat.simplex.res.MR + +@Composable +fun BadgesPurchaseStateView(title: StringResource, message: StringResource?, failure: BadgeIssueFailure? = null, onDismiss: () -> Unit) { + ColumnWithScrollBar( + Modifier.background(MaterialTheme.colors.background).padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), + verticalArrangement = Arrangement.spacedBy(16.dp), + horizontalAlignment = Alignment.CenterHorizontally, + maxIntrinsicSize = true, + ) { + Text( + stringResource(title), + style = MaterialTheme.typography.h1, + fontWeight = FontWeight.Bold, + color = MaterialTheme.colors.primary, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + + if (message != null) { + Text( + stringResource(message), + style = MaterialTheme.typography.body1, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + } + + if (failure != null) { + Column(horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.spacedBy(6.dp)) { + Icon(painterResource(MR.images.ic_warning), contentDescription = null, tint = Color.Red) + Text( + failure.purchaseText, + style = MaterialTheme.typography.body1, + color = MaterialTheme.colors.secondary, + textAlign = TextAlign.Center, + modifier = Modifier.fillMaxWidth() + ) + } + } + + Spacer(Modifier.weight(1f)) + + CircularProgressIndicator( + Modifier.size(30.dp), + color = MaterialTheme.colors.secondary, + strokeWidth = 3.dp + ) + + Spacer(Modifier.weight(1f)) + + Column(horizontalAlignment = Alignment.CenterHorizontally) { + TextButtonBelowOnboardingButton(stringResource(MR.strings.badges_dismiss), onDismiss) + TextButtonBelowOnboardingButton("", null) + } + } +} + +val BadgePurchaseState.title: StringResource + get() = when (this) { + BadgePurchaseState.Issuing -> MR.strings.badges_issuing_title + BadgePurchaseState.WaitingForApproval -> MR.strings.badges_waiting_for_approval_title + } + +val BadgePurchaseState.message: StringResource + get() = when (this) { + BadgePurchaseState.Issuing -> MR.strings.badges_issuing_body + BadgePurchaseState.WaitingForApproval -> MR.strings.badges_waiting_for_approval_body + } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt index 7494229aaa..11367134f7 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt @@ -85,7 +85,7 @@ suspend fun redeemBadgeCode(rhId: Long?, user: User, code: String): BadgeRedeemO } is BadgeRedeemResult.Failed -> { Log.e(TAG, "apiRedeemBadgeCode: ${result.err?.string}") - BadgeRedeemOutcome.Refused(chatModel.controller.redeemErrorText(result.err)) + BadgeRedeemOutcome.Refused(chatModel.controller.redeemErrorText(result.err, purchase = false)) } } @@ -94,11 +94,12 @@ fun showCannotRedeemAlert(message: String) { } @Composable -fun BadgesRedeemCodeView(modalManager: ModalManager) { +fun BadgesRedeemCodeView(modalManager: ModalManager, unwindToDepth: Int) { val rhId = remember { chatModel.remoteHostId() } val code = remember { mutableStateOf(TextFieldValue("")) } val canonicalCode = remember { mutableStateOf(null) } val submitting = remember { mutableStateOf(false) } + CloseWhenSupportGivesWay(modalManager, unwindToDepth) // when the text is unchanged, the field's own value is kept: it carries the cursor position and the // keyboard's composition state, which BasicTextField loses unless they are passed back to it @@ -117,7 +118,8 @@ fun BadgesRedeemCodeView(modalManager: ModalManager) { withContext(Dispatchers.Main) { submitting.value = false when (outcome) { - is BadgeRedeemOutcome.Redeemed -> modalManager.closeModal() + // a shown badge closes this screen itself, and a second close would take the screen beneath + is BadgeRedeemOutcome.Redeemed -> if (currentShownBadge() == null) modalManager.closeModal() is BadgeRedeemOutcome.Refused -> showCannotRedeemAlert(outcome.message) is BadgeRedeemOutcome.Cancelled -> {} } @@ -382,7 +384,8 @@ private fun Confirming(onConfirm: () -> Unit, onCancel: () -> Unit) { // leaving does not cancel: the badge is still added after the screen closes @Composable private fun BeingIssued(onDismiss: () -> Unit) { - LinkStep(MR.strings.badges_being_issued, textButton = MR.strings.badges_dismiss to onDismiss) { + LinkStep(MR.strings.badges_issuing_title, textButton = MR.strings.badges_dismiss to onDismiss) { + LinkText(stringResource(MR.strings.badges_link_issuing_profile)) Spacer(Modifier.weight(1f)) CircularProgressIndicator( Modifier.size(30.dp), diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt index dc65897547..aa2144ff59 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt @@ -32,7 +32,7 @@ import chat.simplex.common.views.onboarding.TextButtonBelowOnboardingButton import chat.simplex.res.MR @Composable -fun BadgesSupportSimplexView(modalManager: ModalManager) { +fun BadgesSupportSimplexView(modalManager: ModalManager, unwindToDepth: Int) { ColumnWithScrollBar( Modifier.background(MaterialTheme.colors.background).padding(horizontal = 25.dp).padding(top = 8.dp, bottom = 20.dp), verticalArrangement = Arrangement.spacedBy(16.dp), @@ -55,8 +55,6 @@ fun BadgesSupportSimplexView(modalManager: ModalManager) { modifier = Modifier.fillMaxWidth() ) - // TODO [badges] restore WhyBuiltButton() when in-app purchase lands: the level screen - // returns to the flow and HowItWorksButton() moves there, leaving this one alone here. HowItWorksButton(modalManager) Spacer(Modifier.weight(1f)) @@ -66,21 +64,30 @@ fun BadgesSupportSimplexView(modalManager: ModalManager) { Spacer(Modifier.weight(1f)) Column(horizontalAlignment = Alignment.CenterHorizontally) { - BuyInBrowserButton(modalManager) - RedeemCodeButton(modalManager) + if (badgeStoreAvailable) { + ChooseLevelButton(modalManager, unwindToDepth) + if (badgeBrowserAllowed()) { + BuyInBrowserTextButton() + } else { + RedeemCodeButton(modalManager, unwindToDepth) + } + } else { + BuyInBrowserButton(modalManager, unwindToDepth) + RedeemCodeButton(modalManager, unwindToDepth) + } } } } -// the in-app purchase path, kept compiling and uncalled until payments return after the MVP @Composable -private fun ChooseLevelButton(modalManager: ModalManager) { +private fun ChooseLevelButton(modalManager: ModalManager, unwindToDepth: Int) { OnboardingActionButton( modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), - labelId = MR.strings.badges_choose_your_level, + labelId = MR.strings.badges_choose_your_badge_title, onboarding = null, + enabled = BadgeStore.canBuy(chatModel.currentUser.value?.userId), onclick = { - modalManager.showModal { BadgesChooseBadgeView(modalManager) } + modalManager.showModal { BadgesChooseBadgeView(modalManager, unwindToDepth) } } ) } @@ -111,15 +118,24 @@ private fun HowItWorksButton(modalManager: ModalManager) { } @Composable -private fun RedeemCodeButton(modalManager: ModalManager) { +fun RedeemCodeButton(modalManager: ModalManager, unwindToDepth: Int) { TextButtonBelowOnboardingButton( text = stringResource(MR.strings.badges_redeem_code_button), - onClick = { modalManager.showModal { BadgesRedeemCodeView(modalManager) } } + onClick = { modalManager.showModal { BadgesRedeemCodeView(modalManager, unwindToDepth) } } ) } @Composable -private fun BuyInBrowserButton(modalManager: ModalManager) { +private fun BuyInBrowserTextButton() { + val uriHandler = LocalUriHandler.current + TextButtonBelowOnboardingButton( + text = stringResource(MR.strings.badges_buy_in_browser), + onClick = { uriHandler.openUriCatching(badgePageUrl) } + ) +} + +@Composable +private fun BuyInBrowserButton(modalManager: ModalManager, unwindToDepth: Int) { val uriHandler = LocalUriHandler.current OnboardingActionButton( modifier = if (appPlatform.isAndroid) Modifier.padding(horizontal = DEFAULT_ONBOARDING_HORIZONTAL_PADDING).fillMaxWidth() else Modifier.widthIn(min = 300.dp), @@ -129,7 +145,7 @@ private fun BuyInBrowserButton(modalManager: ModalManager) { uriHandler.openUriCatching(badgePageUrl) // desktop has no scheme to bring the code back, so the code is pasted into this screen, opened beside the browser if (appPlatform.isDesktop && !modalManager.hasModalOpen(ModalViewId.BADGE_REDEEM_CODE)) { - modalManager.showModal(id = ModalViewId.BADGE_REDEEM_CODE) { BadgesRedeemCodeView(modalManager) } + modalManager.showModal(id = ModalViewId.BADGE_REDEEM_CODE) { BadgesRedeemCodeView(modalManager, unwindToDepth) } } } ) diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt index ff2660497e..d631735e3e 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt @@ -2,33 +2,70 @@ package chat.simplex.common.views.badges import androidx.compose.animation.* import androidx.compose.runtime.Composable +import androidx.compose.runtime.LaunchedEffect +import androidx.compose.runtime.remember import chat.simplex.common.model.BadgeModel import chat.simplex.common.model.BadgeState import chat.simplex.common.platform.chatModel +import chat.simplex.common.views.helpers.AlertManager import chat.simplex.common.views.helpers.ModalManager import chat.simplex.common.views.helpers.ModalView +import chat.simplex.common.views.helpers.generalGetString +import chat.simplex.res.MR @OptIn(ExperimentalAnimationApi::class) @Composable fun BadgesView(modalManager: ModalManager, close: () -> Unit) { - val shownBadge: BadgeState? = run { - if (!BadgeModel.isCurrent(chatModel.remoteHostId(), chatModel.currentUser.value?.userId)) return@run null - val badgeState = BadgeModel.badgeState.value - if (badgeState != null && badgeState.shown) badgeState else null - } + val shownBadge = currentShownBadge() + val unwindToDepth = remember { modalManager.openModalCount() } // the card look is a modal setting, so the modal is composed here to follow the screen shown ModalView(close, cardScreen = shownBadge != null) { - AnimatedContent(targetState = shownBadge, transitionSpec = { fadeIn() with fadeOut() }, contentKey = { it != null }) { badgeState -> + AnimatedContent( + targetState = Triple(shownBadge, BadgeStore.purchaseState(chatModel.currentUser.value?.userId), BadgeStore.checkingPurchases), + transitionSpec = { fadeIn() with fadeOut() }, + contentKey = { (badgeState, purchaseState, checkingPurchases) -> Triple(badgeState != null, purchaseState, checkingPurchases) } + ) { (badgeState, purchaseState, checkingPurchases) -> if (badgeState != null) { BadgesYourBadgeView(badgeState, modalManager) + } else if (purchaseState != null) { + // holds the purchase screens' slot, so a consumable cannot be bought twice + BadgesPurchaseStateView(purchaseState.title, purchaseState.message, BadgeStore.creditError(chatModel.currentUser.value?.userId), onDismiss = close) + LaunchedEffect(purchaseState) { + BadgeStore.refusals.collect { refusal -> + // only the issuing screen belongs to the active profile's held purchase, so a refusal shown there reads as its own + if (purchaseState == BadgePurchaseState.Issuing) { + AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.badges_purchase_error), text = chatModel.controller.redeemErrorText(refusal, purchase = true)) + } + } + } + } else if (checkingPurchases) { + BadgesPurchaseStateView(MR.strings.badges_checking_purchases_title, null, onDismiss = close) } else { - BadgesSupportSimplexView(modalManager) + BadgesSupportSimplexView(modalManager, unwindToDepth) } } } } +fun currentShownBadge(): BadgeState? { + if (!BadgeModel.isCurrent(chatModel.remoteHostId(), chatModel.currentUser.value?.userId)) return null + val badgeState = BadgeModel.badgeState.value + return if (badgeState != null && badgeState.shown) badgeState else null +} + +// The badges modal shows the purchase state itself, so screens pushed over it have to go once a purchase +// appears. Only the top one is composed, so this runs there, closing them in one effect because a close per +// recomposition restarts showInView's transition, and stopping on a depth because closeModal defers removal. +// TODO [badges] ModalManager has no close-above and records no parentage; with either, the depth goes away. +@Composable +fun CloseWhenSupportGivesWay(modalManager: ModalManager, unwindToDepth: Int) { + val gaveWay = BadgeStore.purchaseState(chatModel.currentUser.value?.userId) != null || currentShownBadge() != null + LaunchedEffect(gaveWay) { + if (gaveWay) while (modalManager.openModalCount() > unwindToDepth) modalManager.closeModal() + } +} + // ModalManager.end, not start: every caller is in the chat, which on desktop is the right pane fun openBadgesView() { ModalManager.end.showCustomModal { close -> BadgesView(ModalManager.end, close) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt index c2ca7d7f10..6be88831a4 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt @@ -78,6 +78,14 @@ fun BadgesYourBadgeView(badgeState: BadgeState, modalManager: ModalManager) { } SectionSpacer() } + if (BadgeStore.purchaseState(chatModel.currentUser.value?.userId) != null) { + SectionView(stringResource(MR.strings.badges_store_purchase_title)) { + SectionItemView { + Text(stringResource(MR.strings.badges_store_purchase_processing), color = MaterialTheme.colors.secondary) + } + } + SectionSpacer() + } if (appPrefs.developerTools.get()) { val clipboard = LocalClipboardManager.current SectionView(stringResource(MR.strings.badges_credential)) { diff --git a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml index 957160041b..deaf291138 100644 --- a/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml +++ b/apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml @@ -3142,8 +3142,10 @@ The badge is signed with a key that this version of the app does not recognize. Update the app to verify this badge. Supporter Legend - Send 2GB files - Send 5GB files + Files up to 2 GB + Stored for 7 days + Files up to 5 GB + Stored for 21 days %1$s/month %1$s/year Pay %1$s/month @@ -3151,7 +3153,7 @@ Pay %1$s Loading… Not available - Save %1$s + %1$s off Supporter: 2 GB files available for 7 days. Legend: 5 GB files available for 21 days. 1 month @@ -3165,7 +3167,6 @@ Support SimpleX Get a badge to send larger files (2-5GB) that stay available longer (7-21 days), and to show it on your profile. Why SimpleX is built. - Choose your level Redeem badge code Continue How badges protect your privacy @@ -3179,10 +3180,17 @@ Get badge + better files You can support SimpleX later in Settings. Support SimpleX to send larger files that stay available longer - Purchase successful - Purchase pending - The purchase is awaiting approval. This build does not deliver purchases approved later. Purchase error + Check your order + Duration + Total + Issuing your badge + Your payment is complete. The badge will be added to this profile. + Waiting for approval + Nothing has been charged. + Checking your purchases + Store purchase + A store purchase is being processed. Buy in browser Redeem code Add badge to your profile? @@ -3192,7 +3200,7 @@ A badge can be added to another profile, or here once this badge ends. Its code is on the page you bought it on, under Show code. View your badge - Badge is being issued + The badge will be added to this profile. Badge added The badge was added to the profile %1$s. Paste the code you received. @@ -3201,7 +3209,9 @@ Cannot redeem code This code is not valid. This app version cannot redeem badge codes. + This app version cannot buy badges. This profile already has a badge. Redeem the code on another profile, or once this badge ends. + This profile already has a badge. This code was not recognized. This code has already been used. This code has expired. @@ -3211,6 +3221,12 @@ This app version is too old for the badge service. Please update the app. The badge service does not recognize this badge. The badge service reported an internal error. + The store did not confirm this purchase. + This purchase was already credited to a badge on another device or profile. + The payment has not been confirmed yet. + The store could not be reached. + Badges cannot be bought in the app yet. + This badge is not on sale. The code was accepted, but the badge it grants has already ended. The code could not be redeemed. The code you scanned is not a badge code. @@ -3245,6 +3261,7 @@ Badge renewal failed Tap for details The badge service refused the renewal: %1$s + The badge service refused the purchase: %1$s The badge service did not respond. The badge service could not be reached. The badge issued by the service cannot be verified. diff --git a/apps/simplex-badge-service/README.md b/apps/simplex-badge-service/README.md index 945256f814..538d75c7a0 100644 --- a/apps/simplex-badge-service/README.md +++ b/apps/simplex-badge-service/README.md @@ -48,7 +48,7 @@ simplex-badge-service --help - `--run-cli`: interactive CLI that also processes service requests (mirrors `simplex-directory-service --run-cli`). This mode is the chat/RPC side and the `//` commands below: it starts no web listener and no poller, and `[dev] chat_redeem` does not apply to it, - whatever `--service-config` says. + whatever `--service-config` says. `[dev] accept_unverified_store_receipts` does. - `--no-address`: skip address creation on start-up (for operators who provision the address themselves). The service cannot sign credentials without an issuer key and refuses to start without one: @@ -81,7 +81,8 @@ Other options: - `--service-config INI_FILE`: path to `badge_service.ini`. Omit it to run the chat/RPC side only; the process never starts a web listener without it, and never starts one under `--run-cli`, which parses and validates the whole file (`[listener] static_dir` included) but - uses only its `[issuer]` section. An issuer key is still required either way. + uses only its `[issuer]` section and `[dev] accept_unverified_store_receipts`. An issuer key is + still required either way. - `--service-name NAME`: the bot's display name, without `*`s or spaces (default `SimpleX Badges`). - `--client-service`: use the client service certificate. - also accepts the standard SimpleX Chat core options — database path, SMP/XFTP servers, @@ -216,6 +217,24 @@ there is no client key, so the service generates one and hands it over with the means it can link every badge it issues this way. `simplex-chat badge sign` has the same property and is the offline equivalent. +### Accepting store receipts unverified, for local testing + +```ini +[dev] +accept_unverified_store_receipts = on +``` + +Without a store verifier every store purchase is answered `provider_not_configured`. With this on, +the service accepts any well-formed receipt without asking or verifying anything: an Apple JWS for +the `transactionId` and `productId` its payload names, unsigned or not, and a Play product id and +token as given. It applies to both run modes, since `--run-cli` answers service requests too, and +the service logs a warning at every start while it is on. Off by default, and only `on`/`off` +parse. + +With it on, anyone who can reach the service address can mint badges by sending a made-up receipt. +That is harmless only while this deployment signs with an issuer key released apps do not carry, so +they refuse what it signs — never turn it on where the key is one those apps trust. + ## Issuing codes Issuing a code is an operator command sent to the running service in `--run-cli` mode, not a way diff --git a/apps/simplex-badge-service/badge_service.ini.example b/apps/simplex-badge-service/badge_service.ini.example index b1f5f4b1c1..3d02951fdc 100644 --- a/apps/simplex-badge-service/badge_service.ini.example +++ b/apps/simplex-badge-service/badge_service.ini.example @@ -54,3 +54,6 @@ idle_seconds = 60 ; with a master key this service generates and can therefore link [dev] chat_redeem = off +; local testing only, in both run modes: accepts any well-formed App Store or Play receipt without +; verifying it, so anyone who can reach this service can mint badges +accept_unverified_store_receipts = off diff --git a/apps/simplex-badge-service/src/BadgeService/Catalog.hs b/apps/simplex-badge-service/src/BadgeService/Catalog.hs index b15185da68..85b678d8d5 100644 --- a/apps/simplex-badge-service/src/BadgeService/Catalog.hs +++ b/apps/simplex-badge-service/src/BadgeService/Catalog.hs @@ -11,6 +11,8 @@ module BadgeService.Catalog priceOffer, catalogCurrency, defaultCatalog, + StoreProduct (..), + storeProduct, ) where @@ -21,7 +23,7 @@ import Data.Word (Word32, Word64, Word8) import Simplex.Chat.Badges (BadgeType (..)) import Simplex.Chat.Badges.Service (BadgeOffer (..), BadgePrice (..)) import Simplex.Chat.Badges.Types (BadgeItemStatus (..), BadgeOfferId (..), BadgePriceId (..), OfferDiscount (..)) -import Simplex.Chat.PaymentService.Types (CurrencyAmount (..)) +import Simplex.Chat.PaymentService.Types (CurrencyAmount (..), PaymentProvider (..)) data OfferInvalid = OIZeroMonths | OIFreeMonthsExceedTerm | OIDiscountTooLarge | OIAmountUnsellable deriving (Eq, Show) @@ -133,3 +135,20 @@ defaultCatalog seededAt = (prices, offers) status = BISActive, createdAt = seededAt } + +data StoreProduct = StoreProduct + { badgeType :: BadgeType, + months :: Int + } + deriving (Eq, Show) + +-- | A receipt proves only the product paid for, so the badge comes from here, never from the client. +-- Mirrors the one-time SKUs of BadgeStore.swift and .kt; subscriptions wait until renewals add months. +-- Not part of the seeded catalog above, which exists to pin prices this service sets: a store sets its own. +storeProduct :: PaymentProvider -> Text -> Maybe StoreProduct +storeProduct provider productId = case (provider, productId) of + (PPApple, "BADGE_SUPPORTER_01") -> Just $ StoreProduct BTSupporter 1 + (PPApple, "BADGE_LEGEND_01") -> Just $ StoreProduct BTLegend 1 + (PPGoogle, "badge_supporter_01") -> Just $ StoreProduct BTSupporter 1 + (PPGoogle, "badge_legend_01") -> Just $ StoreProduct BTLegend 1 + _ -> Nothing diff --git a/apps/simplex-badge-service/src/BadgeService/Config.hs b/apps/simplex-badge-service/src/BadgeService/Config.hs index 10d55d7da7..fd11647a36 100644 --- a/apps/simplex-badge-service/src/BadgeService/Config.hs +++ b/apps/simplex-badge-service/src/BadgeService/Config.hs @@ -104,7 +104,9 @@ data ServiceConfig = ServiceConfig poll :: PollConfig, issuer :: Maybe BadgeIssuerKey, -- Local testing only; signs credentials with a master key this service can link. - devChatRedeem :: Bool + devChatRedeem :: Bool, + -- Local testing only; anyone who can reach the service can mint badges with any well-formed receipt. + devAcceptUnverifiedStoreReceipts :: Bool } deriving (Eq, Show) @@ -155,7 +157,7 @@ knownSettings = ("btcpay", ["host", "api_key", "store_id", "webhook_secret", "expiry_minutes", "speed_policy", "payment_tolerance"]), ("stripe", ["secret_key", "publishable_key", "webhook_secret", "session_minutes"]), ("poll", ["waiting_seconds", "idle_seconds"]), - ("dev", ["chat_redeem"]), + ("dev", ["chat_redeem", "accept_unverified_store_receipts"]), ("issuer", ["index", "private_key"]) ] @@ -189,6 +191,7 @@ parseConfig ini = do pWaitingSeconds <- cadence "waiting_seconds" 3 pIdleSeconds <- cadence "idle_seconds" 60 devRedeem <- bool "dev" "chat_redeem" False + devUnverifiedReceipts <- bool "dev" "accept_unverified_store_receipts" False pure ServiceConfig { listener = ListenerConfig {lHost, lPort, lStaticDir, lServeWebapp, lWebappExportDir, lTrustForwardedFor}, @@ -196,7 +199,8 @@ parseConfig ini = do stripe = str, poll = PollConfig {pWaitingSeconds, pIdleSeconds}, issuer = iss, - devChatRedeem = devRedeem + devChatRedeem = devRedeem, + devAcceptUnverifiedStoreReceipts = devUnverifiedReceipts } where hasSection s = s `elem` sections ini diff --git a/apps/simplex-badge-service/src/BadgeService/Poller.hs b/apps/simplex-badge-service/src/BadgeService/Poller.hs index c91ffcd22f..f066ed5d0c 100644 --- a/apps/simplex-badge-service/src/BadgeService/Poller.hs +++ b/apps/simplex-badge-service/src/BadgeService/Poller.hs @@ -30,7 +30,7 @@ where import BadgeService.Config (PollConfig (..)) import BadgeService.Orders (decide, settleOrder) import BadgeService.Providers (ListPass (..), PaymentSignal (..), Provider (..), ProviderError (..), Received (..), expiresItself, settleWindow) -import BadgeService.Store.Invoices (InvoiceRow (..), OverdueInvoice (..), expireOverdue, getInvoiceByProviderRef, overdueInvoices, providerText, unpaidRefs) +import BadgeService.Store.Invoices (InvoiceRow (..), OverdueInvoice (..), expireOverdue, getInvoiceByProviderRef, overdueInvoices, unpaidRefs) import BadgeService.Waiters (Waiters, publish, waitingCount, waitingCountSTM) import Control.Concurrent.STM import Control.Exception (SomeAsyncException, SomeException, fromException, throwIO, try) @@ -47,6 +47,7 @@ import Data.Time.Clock (NominalDiffTime, UTCTime, addUTCTime, diffUTCTime, getCu import Numeric.Natural (Natural) import Simplex.Chat.PaymentService.Types (InvoiceStatus (..), PaymentProvider) import Simplex.Messaging.Agent.Store.Common (DBStore) +import Simplex.Messaging.Encoding.String (textEncode) import Simplex.Messaging.Util (tshow) -- | Allows for our clock running ahead of the provider's; an expired invoice can still be marked paid. @@ -145,7 +146,7 @@ readsPerPass = 25 coveringProvider :: PollerEnv -> UTCTime -> (Text, Text) -> IO (Maybe Provider) coveringProvider env@PollerEnv {peProviders} now (provider, ref) = - case find ((== provider) . providerText . pProvider) peProviders of + case find ((== provider) . textEncode . pProvider) peProviders of Just p -> pure (Just p) Nothing -> do due <- dueToWarn env now ("no provider for " <> provider) diff --git a/apps/simplex-badge-service/src/BadgeService/Service.hs b/apps/simplex-badge-service/src/BadgeService/Service.hs index 9a3a3f4236..02519095de 100644 --- a/apps/simplex-badge-service/src/BadgeService/Service.hs +++ b/apps/simplex-badge-service/src/BadgeService/Service.hs @@ -15,13 +15,16 @@ module BadgeService.Service badgeServiceCLI, badgeServiceResponse, badgeErrorRetryAfter, + shownServiceRequest, + survive, IssueCodeOpts (..), issueBadgeCode, ) where -import BadgeService.Catalog (defaultCatalog) +import BadgeService.Catalog (StoreProduct (..), defaultCatalog, storeProduct) import BadgeService.Config (BadgeIssuerKey (..), ServiceConfig (..), readServiceConfig) +import BadgeService.Log (logError, logInfo, logWarn) import BadgeService.Options import BadgeService.Poller (newPollerEnv, newReadHints, runPoller) import BadgeService.Providers.BTCPay (btcpayProvider) @@ -29,11 +32,12 @@ import BadgeService.Providers.Stripe (stripeProvider) import BadgeService.Store import BadgeService.Store.Invoices (seedCatalog, truncateToSecond) import BadgeService.Store.Migrate (runBadgeServiceMigrations) +import BadgeService.StoreReceipts +import BadgeService.StoreReceipts.Mock (mockStoreVerifier) import BadgeService.Waiters (Waiters, newWaiters) import BadgeService.Web.Server (exportWebapp, newWebEnv, runWebListener) import Control.Applicative (optional) import Control.Concurrent.STM -import BadgeService.Log (logError, logInfo, logWarn) import Control.Monad import Control.Monad.IO.Class (liftIO) import qualified Data.Aeson as J @@ -43,7 +47,8 @@ import Data.ByteString.Char8 (ByteString) import qualified Data.ByteString.Lazy.Char8 as LB import Data.Char (isSpace) import Data.Either (fromRight) -import Data.Functor (($>)) +import Data.Functor (($>), (<&>)) +import Data.Int (Int64) import qualified Data.Map.Strict as M import Data.Maybe (fromMaybe, maybeToList) import qualified Data.Text as T @@ -61,14 +66,16 @@ import Simplex.Chat.Core (sendChatCmd, simplexChatCore) import Simplex.Chat.Messages import Simplex.Chat.Messages.CIContent (CIContent (..), SMsgDirection (..), ciContentToText) import Simplex.Chat.Options (printDbOpts) +import Simplex.Chat.PaymentService.Types (StoreTransactionRef (..)) import Simplex.Chat.Terminal (terminalChatConfig) import Simplex.Chat.Terminal.Main (simplexChatCLI') import Simplex.Chat.Types (AgentInvId (..), Contact, User (..)) import Simplex.Messaging.Agent.Store.Common (DBStore) +import qualified Simplex.Messaging.Agent.Store.DB as DB import qualified Simplex.Messaging.Crypto as C import Simplex.Messaging.Crypto.BBS (bbsPublicKey) import Simplex.Messaging.Encoding.String (TextEncoding, strEncode, textDecode, textEncode) -import Simplex.Messaging.Util (raceAny_, safeDecodeUtf8, tshow) +import Simplex.Messaging.Util (catchOwn', raceAny_, safeDecodeUtf8, tshow) import Simplex.Messaging.Version (isCompatible) import System.Directory (getAppUserDataDirectory) import System.Exit (exitFailure) @@ -76,15 +83,18 @@ import System.Exit (exitFailure) data ServiceState = ServiceState { serviceCC :: TMVar ChatController, serviceRequestQ :: TQueue (User, AgentInvId, Maybe C.PublicKeyEd25519, J.Object), - chatRedeemQ :: TQueue (Contact, T.Text) + chatRedeemQ :: TQueue (Contact, T.Text), + storeVerifier :: StoreVerifier } +-- | No store verifier exists yet, so every store receipt not already credited is answered +-- provider_not_configured, terminal for the request: retrying cannot deploy one. newServiceState :: IO ServiceState newServiceState = do serviceCC <- newEmptyTMVarIO serviceRequestQ <- newTQueueIO chatRedeemQ <- newTQueueIO - pure ServiceState {serviceCC, serviceRequestQ, chatRedeemQ} + pure ServiceState {serviceCC, serviceRequestQ, chatRedeemQ, storeVerifier = noStoreVerifier} welcomeGetOpts :: IO BadgeServiceOpts welcomeGetOpts = do @@ -123,6 +133,13 @@ readConfigOrExit path = Left e -> putStrLn (path <> ": " <> e) >> exitFailure Right sc -> pure sc +devStoreVerifier :: Maybe ServiceConfig -> ServiceState -> IO ServiceState +devStoreVerifier serviceCfg env + | maybe False devAcceptUnverifiedStoreReceipts serviceCfg = do + logWarn "[dev] accept_unverified_store_receipts is on: any store receipt is accepted without verification" + pure env {storeVerifier = mockStoreVerifier} + | otherwise = pure env + badgeService :: BadgeServiceOpts -> ChatConfig -> ServiceState -> IO () badgeService opts@BadgeServiceOpts {serviceConfigFile} cfg env = do serviceCfg <- traverse readConfigOrExit serviceConfigFile @@ -136,6 +153,7 @@ badgeService opts@BadgeServiceOpts {serviceConfigFile} cfg env = do preCmdHook = Just badgeCmdHook } when devRedeem $ logWarn "[dev] chat_redeem is on: /redeem over chat hands out credentials this service can link" + requestEnv <- devStoreVerifier serviceCfg env -- The reader must not block, since outputQ carries every chat event. simplexChatCore cfg {chatHooks} (mkChatOpts opts) $ \_ cc -> do lanes <- maybe (pure []) (serviceLanes waiters cc) serviceCfg @@ -147,7 +165,7 @@ badgeService opts@BadgeServiceOpts {serviceConfigFile} cfg env = do (_, Right CEvtNewChatItems {chatItems = AChatItem _ SMDRcv (DirectChat ct) ChatItem {content = mc@CIRcvMsgContent {}} : _}) | devRedeem -> atomically $ writeTQueue (chatRedeemQ env) (ct, ciContentToText mc) _ -> pure (), - processQueuedRequests key env + processQueuedRequests key requestEnv ] <> [processChatRedeems key env | devRedeem] <> lanes @@ -178,13 +196,12 @@ badgeServiceCLI :: BadgeServiceOpts -> IO () badgeServiceCLI opts@BadgeServiceOpts {serviceConfigFile} = do serviceCfg <- traverse readConfigOrExit serviceConfigFile key <- requireIssuerKey opts serviceCfg terminalChatConfig - env <- newServiceState - let eventHook _cc ev = do - case ev of - Right (CEvtServiceRequest u reqId sigKey reqData) -> - atomically $ writeTQueue (serviceRequestQ env) (u, reqId, sigKey, reqData) - _ -> pure () - pure ev + env <- newServiceState >>= devStoreVerifier serviceCfg + let eventHook _cc = \case + Right (CEvtServiceRequest u reqId sigKey reqData) -> do + atomically $ writeTQueue (serviceRequestQ env) (u, reqId, sigKey, reqData) + pure $ Right $ CEvtServiceRequest u reqId sigKey (shownServiceRequest reqData) + ev -> pure ev chatHooks = defaultChatHooks { preStartHook = Just $ badgePreStartHook opts, @@ -197,6 +214,12 @@ badgeServiceCLI opts@BadgeServiceOpts {serviceConfigFile} = do processQueuedRequests key env ] +-- | The terminal prints each request, and requests carry codes and store receipts, which are bearer secrets. +shownServiceRequest :: J.Object -> J.Object +shownServiceRequest reqData = case KM.lookup "request" reqData of + Just (J.Object cmd) | Just t <- KM.lookup "type" cmd -> KM.singleton "request" $ J.object ["type" J..= t] + _ -> KM.empty + badgeCmdHook :: ChatController -> ChatCommand -> IO (Either (Either ChatError ChatResponse) ChatCommand) badgeCmdHook cc = \case CustomChatCommand cmd -> Left <$> runBadgeCmd cc cmd @@ -272,14 +295,19 @@ processQueuedRequests key env = do cc <- atomically $ readTMVar $ serviceCC env forever $ do (u, reqId, sigKey, reqData) <- atomically $ readTQueue $ serviceRequestQ env - handleServiceRequest key cc u reqId sigKey reqData + survive ("request " <> safeDecodeUtf8 (strEncode reqId)) $ handleServiceRequest key (storeVerifier env) cc u reqId sigKey reqData processChatRedeems :: BadgeIssuerKey -> ServiceState -> IO () processChatRedeems key env = do cc <- atomically $ readTMVar $ serviceCC env forever $ do (ct, msg) <- atomically $ readTQueue $ chatRedeemQ env - chatRedeem key cc ct msg + survive "a chat redemption" $ chatRedeem key cc ct msg + +-- | Cancellation is rethrown, since that is how the race stops this thread. The +-- exception itself is not logged: it can quote the request, which carries codes and store receipts. +survive :: T.Text -> IO () -> IO () +survive what action = action `catchOwn'` \_ -> logError $ "badge service: " <> what <> " failed; the next one will be handled" -- | Here the service generates the master key and can link the badge, so [dev] chat_redeem gates this. chatRedeem :: BadgeIssuerKey -> ChatController -> Contact -> T.Text -> IO () @@ -308,11 +336,13 @@ badgePostStartHook BadgeServiceOpts {noAddress, testing} devRedeem env cc = do unless noAddress $ initializeBotAddress' (not testing) (Just True) devRedeem cc void $ atomically $ tryPutTMVar (serviceCC env) cc -handleServiceRequest :: BadgeIssuerKey -> ChatController -> User -> AgentInvId -> Maybe C.PublicKeyEd25519 -> J.Object -> IO () -handleServiceRequest key cc User {userId} reqId sigKey reqData = do +handleServiceRequest :: BadgeIssuerKey -> StoreVerifier -> ChatController -> User -> AgentInvId -> Maybe C.PublicKeyEd25519 -> J.Object -> IO () +handleServiceRequest key verifier cc User {userId} reqId sigKey reqData = do let reqIdT = safeDecodeUtf8 (strEncode reqId) logInfo $ "badge service request " <> reqIdT - resp <- badgeServiceResponse key cc sigKey reqData + resp <- + badgeServiceResponse key verifier cc sigKey reqData `catchOwn'` \_ -> + logError ("badge service request " <> reqIdT <> " failed") $> errorResponse BSEInternal sendChatCmd cc (APISendServiceResponse userId reqId (responseObject resp)) >>= \case Right _ -> pure () Left e -> logError $ "badge service response failed for " <> reqIdT <> ": " <> tshow e @@ -334,8 +364,8 @@ badgeErrorRetryAfter = \case -- | The agent verified the signature, so sigKey is a key the sender holds; a differing purchaseKey would let a client claim a purchase it cannot sign for. -badgeServiceResponse :: BadgeIssuerKey -> ChatController -> Maybe C.PublicKeyEd25519 -> J.Object -> IO BadgeServiceResponse -badgeServiceResponse key cc sigKey reqData = case J.fromJSON (J.Object reqData) of +badgeServiceResponse :: BadgeIssuerKey -> StoreVerifier -> ChatController -> Maybe C.PublicKeyEd25519 -> J.Object -> IO BadgeServiceResponse +badgeServiceResponse key verifier cc sigKey reqData = case J.fromJSON (J.Object reqData) of J.Error _ -> pure $ errorResponse BSEBadRequest J.Success BadgeServiceRequest {version, purchaseKey, request} | not (version `isCompatible` supportedBadgeServiceVRange) -> pure $ errorResponse BSEUnsupportedVersion @@ -344,10 +374,16 @@ badgeServiceResponse key cc sigKey reqData = case J.fromJSON (J.Object reqData) BSCRedeemBadgeCode {masterKey, code} -> case purchaseKey of Just k -> redeemCode key cc k masterKey code Nothing -> pure $ errorResponse BSEBadRequest + BSCPurchaseBadge {masterKey, payment, upgrade} + | Just receipt_ <- toStoreReceipt verifier payment -> case (purchaseKey, upgrade) of + (Just k, Nothing) -> either storeRefusalResponse (purchaseWithReceipt key cc k masterKey) receipt_ + -- store upgrades are not built, and ignoring one would credit its months at the discounted price + (Just _, Just _) -> pure $ errorResponse BSEBadRequest + (Nothing, _) -> pure $ errorResponse BSEBadRequest BSCIssueBadge {balance} -> case purchaseKey of Just k -> issueBadgeCmd key cc k balance Nothing -> pure $ errorResponse BSEBadRequest - -- Every command but redeemBadgeCode needs a key the service already knows; that one creates the purchase, so its key is unknown on a first redemption. + -- Every command but redeemBadgeCode and purchaseBadge from a store needs a key the service already knows; those two create the purchase, so their key is unknown on a first purchase. _ -> case purchaseKey of Nothing -> pure $ errorResponse BSEUnsupportedVersion Just k -> @@ -384,29 +420,19 @@ redeemCode key cc purchaseKey masterKey codeText = case parseBadgeCode codeText withDB "getBadgeCode" cc (readCode now code) >>= \case Left _ -> pure $ errorResponse BSEInternal Right (Left resp) -> pure resp - Right (Right IssuedCode {badgeCodeId, badgeType, months}) -> do - (grantUuid, issueUuid) <- (,) <$> randomId cc <*> randomId cc - -- TODO [badges] a top-up grants onto an existing ledger, and must lapse before it or the - -- months it adds are counted from a start already in the past - let granted = grantEntry now grantUuid months SCCode $ emptyEntry now badgeType - -- A grant of at least one month starting now always has a month to issue. - case issueEntry now issueUuid granted of - Nothing -> pure $ errorResponse BSEInternal - Just issued -> credentialForEntry key masterKey issued >>= \case - Left e -> logError ("badge service signing failed: " <> T.pack e) $> errorResponse BSEInternal - Right signed -> do - -- If the code was revoked or redeemed while signing, the claim fails. Read the code again to tell the client why. - r <- withDB "writeCodeRedemption" cc $ \db -> - liftIO (createCodePurchase db NewCodePurchase {badgeCodeId, purchaseKey, masterKey, badgeType} now) >>= \case - Nothing -> - readCode now code db >>= \case - Left resp -> pure resp - Right _ -> logError "badge service: redeeming a code failed, but the code is neither redeemed nor revoked" $> errorResponse BSEInternal - Just purchaseId -> liftIO $ do - appendLedgerPlan db purchaseId [granted] $ Just $ issuanceAfter granted signed - entries_ <- getLedgerEntries db purchaseId 0 - pure $ maybe (errorResponse BSEInternal) (credentialResponse (Just $ snd signed) Nothing) entries_ - pure $ fromRight (errorResponse BSEInternal) r + Right (Right IssuedCode {badgeCodeId, badgeType, months}) -> + signFirstMonth key cc masterKey badgeType months SCCode now >>= \case + Left resp -> pure resp + Right firstMonth -> do + -- If the code was revoked or redeemed while signing, the claim fails. Read the code again to tell the client why. + r <- withDB "writeCodeRedemption" cc $ \db -> + liftIO (createCodePurchase db NewCodePurchase {badgeCodeId, purchaseKey, masterKey, badgeType} now) >>= \case + Nothing -> + readCode now code db >>= \case + Left resp -> pure resp + Right _ -> logError "badge service: redeeming a code failed, but the code is neither redeemed nor revoked" $> errorResponse BSEInternal + Just purchaseId -> liftIO $ firstMonthResponse db purchaseId Nothing firstMonth + pure $ fromRight (errorResponse BSEInternal) r where readCode now code db = liftIO $ getBadgeCode db (badgeCodeHash code) >>= \case @@ -417,19 +443,99 @@ redeemCode key cc purchaseKey masterKey codeText = case parseBadgeCode codeText -- Redeeming an unpaid code would issue a free badge, so unpaid is refused. | CPSUnpaid <- paymentStatus -> pure $ Left $ errorResponse BSEPaymentPending | otherwise -> - checkUnspent db redemption >>= \case + creditedResponse db BSECodeUsed purchaseKey redemption >>= \case Left resp -> pure $ Left resp Right () | maybe False (now >=) expiresAt -> pure $ Left $ errorResponse BSECodeExpired | otherwise -> pure $ Right c - checkUnspent db = \case - CodeUnredeemed -> pure $ Right () - CodeRedeemedUnreadable -> pure $ Left $ errorResponse BSEInternal - CodeRedeemed RedeemedCode {purchaseKey = k, badgePurchaseId, credential} - | k /= purchaseKey -> pure $ Left $ errorResponse BSECodeUsed - | otherwise -> - maybe (Left $ errorResponse BSEInternal) (Left . credentialResponse (Just credential) Nothing) - <$> getLedgerEntries db badgePurchaseId 0 + +-- | Every refusal is answered before anything is written, so it leaves the receipt unclaimed; and +-- nothing is written until the credential is signed. +purchaseWithReceipt :: BadgeIssuerKey -> ChatController -> C.PublicKeyEd25519 -> BadgeMasterKey -> StoreReceipt -> IO BadgeServiceResponse +purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTransactionRef {provider, transactionRef = providerRef}, verifyReceipt} = + withDB' "getStorePayment" cc (\db -> getStorePaymentCredit db provider providerRef) >>= \case + Left _ -> pure $ errorResponse BSEInternal + Right credit + -- only the key it credited can ask, and it is told only what it was given, so the store is not asked + | creditedBy credit -> answerCredit credit + | otherwise -> + verifyReceipt >>= \case + Left refusal -> storeRefusalResponse refusal + -- the claim was read from the evidence before it was verified, so it must name the transaction the store vouched for + Right VerifiedStoreTransaction {transactionRef} + | transactionRef /= providerRef -> storeRefusalResponse $ SRVerifierFailed "verified a transaction other than the one claimed" + Right VerifiedStoreTransaction {quantity} + | quantity /= 1 -> storeRefusalResponse $ SRVerifierFailed $ "verified a quantity of " <> tshow quantity + Right VerifiedStoreTransaction {testPurchase = True} -> storeRefusalResponse $ SRInvalid "test purchase" + -- another key's credit is told only once the store vouched for the receipt, or it would reveal which transactions were credited + Right tx -> case credit of + Uncredited -> newPurchase tx + _ -> answerCredit credit + where + creditedBy = \case + Credited CreditedPurchase {purchaseKey = k} -> k == purchaseKey + _ -> False + answerCredit credit = + withDB' "answerStoreCredit" cc (\db -> creditedResponse db BSEReceiptUsed purchaseKey credit) <&> \case + Right (Left resp) -> resp + _ -> errorResponse BSEInternal + -- the product is read only for a receipt not yet credited, so retiring it leaves its replays answered + newPurchase VerifiedStoreTransaction {productId, paid} = case storeProduct provider productId of + Nothing -> pure $ errorResponse BSEProductUnavailable + Just StoreProduct {badgeType, months} -> do + now <- badgeNow cc + signFirstMonth key cc masterKey badgeType months (SCPayment Nothing) now >>= \case + Left resp -> pure resp + Right firstMonth -> do + paymentId <- randomId cc + r <- withDB "writeStorePurchase" cc $ \db -> + liftIO (createStorePurchase db NewStorePurchase {paymentId, provider, providerRef, paid, purchaseKey, masterKey, badgeType} now) >>= \case + -- Credited to another key, or to this one by a request that ran alongside it, while signing. + Nothing -> + liftIO (getStorePaymentCredit db provider providerRef >>= creditedResponse db BSEReceiptUsed purchaseKey) >>= \case + Left resp -> pure resp + Right () -> logError ("badge service: a payment for " <> providerRef <> " exists but funds no purchase") $> errorResponse BSEInternal + Just purchaseId -> liftIO $ firstMonthResponse db purchaseId (Just paymentId) firstMonth + pure $ fromRight (errorResponse BSEInternal) r + +-- | The client learns only the code: a forged receipt, a refunded purchase and a test one are all receipt_invalid. +storeRefusalResponse :: StoreRefusal -> IO BadgeServiceResponse +storeRefusalResponse = \case + SRInvalid reason -> logInfo ("store receipt refused: " <> reason) $> errorResponse BSEReceiptInvalid + SRPending -> pure $ errorResponse BSEPaymentPending + SRUnreachable reason -> logWarn ("store unreachable: " <> reason) $> errorResponse BSEProviderUnavailable + SRVerifierFailed reason -> logError ("store receipt not verified: " <> reason) $> errorResponse BSEInternal + SRNotConfigured -> logWarn "store receipt refused: no verifier for this store is configured" $> errorResponse BSEProviderNotConfigured + +creditedResponse :: DB.Connection -> BadgeServiceErrorCode -> C.PublicKeyEd25519 -> FundingCredit -> IO (Either BadgeServiceResponse ()) +creditedResponse db usedCode purchaseKey = \case + Uncredited -> pure $ Right () + CreditedUnreadable -> pure $ Left $ errorResponse BSEInternal + Credited CreditedPurchase {purchaseKey = k, badgePurchaseId, credential} + | k /= purchaseKey -> pure $ Left $ errorResponse usedCode + | otherwise -> + maybe (Left $ errorResponse BSEInternal) (Left . credentialResponse (Just credential) Nothing) + <$> getLedgerEntries db badgePurchaseId 0 + +signFirstMonth :: BadgeIssuerKey -> ChatController -> BadgeMasterKey -> BadgeType -> Int -> StatementCreditType -> UTCTime -> IO (Either BadgeServiceResponse (StatementEntry, (StatementEntry, BadgeCredential))) +signFirstMonth key cc masterKey badgeType months credit now = do + (grantUuid, issueUuid) <- (,) <$> randomId cc <*> randomId cc + -- TODO [badges] a top-up grants onto an existing ledger, and must lapse before it or the + -- months it adds are counted from a start already in the past + let granted = grantEntry now grantUuid months credit $ emptyEntry now badgeType + -- A grant of at least one month starting now always has a month to issue. + case issueEntry now issueUuid granted of + Nothing -> pure $ Left $ errorResponse BSEInternal + Just issued -> + credentialForEntry key masterKey issued >>= \case + Left e -> logError ("badge service signing failed: " <> T.pack e) $> Left (errorResponse BSEInternal) + Right signed -> pure $ Right (granted, signed) + +firstMonthResponse :: DB.Connection -> Int64 -> Maybe T.Text -> (StatementEntry, (StatementEntry, BadgeCredential)) -> IO BadgeServiceResponse +firstMonthResponse db purchaseId creditPaymentId_ (granted, signed) = do + appendLedgerPlan db purchaseId creditPaymentId_ [granted] $ Just $ issuanceAfter granted signed + entries_ <- getLedgerEntries db purchaseId 0 + pure $ maybe (errorResponse BSEInternal) (credentialResponse (Just $ snd signed) Nothing) entries_ -- | The purchase is reached through the verified signer key and no other way. issueBadgeCmd :: BadgeIssuerKey -> ChatController -> C.PublicKeyEd25519 -> BadgeBalance -> IO BadgeServiceResponse @@ -458,7 +564,7 @@ issueBadgeCmd key cc purchaseKey BadgeBalance {lastEntry} = do writeIssued purchaseId tip rows t issuance_ = do r <- withDB "issueBadge" cc $ \db -> liftIO $ do tip' <- getLedgerTip db purchaseId - when (fmap entryId tip' == fmap entryId tip) $ appendLedgerPlan db purchaseId rows issuance_ + when (fmap entryId tip' == fmap entryId tip) $ appendLedgerPlan db purchaseId Nothing rows issuance_ issueResponse db purchaseId t pure $ fromRight (errorResponse BSEInternal) r -- Only the asserted entry's identity is read, never the months it claims. diff --git a/apps/simplex-badge-service/src/BadgeService/Store.hs b/apps/simplex-badge-service/src/BadgeService/Store.hs index d8ab44c268..f81fbe4fe8 100644 --- a/apps/simplex-badge-service/src/BadgeService/Store.hs +++ b/apps/simplex-badge-service/src/BadgeService/Store.hs @@ -4,14 +4,17 @@ {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE QuasiQuotes #-} {-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeOperators #-} module BadgeService.Store ( IssuedCode (..), - CodeRedemption (..), - RedeemedCode (..), + FundingCredit (..), + CreditedPurchase (..), NewCodePurchase (..), + NewStorePurchase (..), ServicePurchase (..), getBadgeCode, + getStorePaymentCredit, purchaseKeyExists, getPurchaseByKey, getLedgerTip, @@ -20,13 +23,14 @@ module BadgeService.Store getCurrentIssuance, appendLedgerPlan, createCodePurchase, + createStorePurchase, insertBadgeCode, RevokeResult (..), revokeCode, ) where -import BadgeService.Store.Invoices (executeChanging) +import BadgeService.Store.Invoices (executeChanging, paymentStatusText) import qualified Data.Aeson as J import Data.ByteString.Char8 (ByteString) import qualified Data.ByteString.Lazy.Char8 as LB @@ -35,12 +39,14 @@ import Data.Text (Text) import Data.Time.Clock (UTCTime) import Simplex.Chat.Badges (BadgeCredential, BadgeMasterKey (..), BadgeType) import Simplex.Chat.Badges.Ledger -import Simplex.Chat.Badges.Service (StatementEntry (..)) +import Simplex.Chat.Badges.Service (StatementCreditType (..), StatementEntry (..), StatementEntryType (..)) import Simplex.Chat.Badges.Types (BadgeCodePaymentStatus, BadgePurchaseStatus (..)) +import Simplex.Chat.PaymentService.Types (CurrencyAmount (..), InvoiceId (..), PaymentProvider, PaymentStatus (..)) import Simplex.Chat.Store.Shared (insertedRowId) import Simplex.Messaging.Agent.Store.DB (Binary (..)) import qualified Simplex.Messaging.Agent.Store.DB as DB import qualified Simplex.Messaging.Crypto as C +import Simplex.Messaging.Encoding.String (textEncode) import Simplex.Messaging.Util (maybeFirstRow, maybeFirstRow') #if defined(dbPostgres) @@ -58,15 +64,15 @@ data IssuedCode = IssuedCode paymentStatus :: BadgeCodePaymentStatus, revokedAt :: Maybe UTCTime, expiresAt :: Maybe UTCTime, - redemption :: CodeRedemption + redemption :: FundingCredit } -data CodeRedemption - = CodeUnredeemed - | CodeRedeemed RedeemedCode - | CodeRedeemedUnreadable +data FundingCredit + = Uncredited + | Credited CreditedPurchase + | CreditedUnreadable -data RedeemedCode = RedeemedCode +data CreditedPurchase = CreditedPurchase { badgePurchaseId :: Int64, purchaseKey :: C.PublicKeyEd25519, credential :: BadgeCredential @@ -79,6 +85,16 @@ data NewCodePurchase = NewCodePurchase badgeType :: BadgeType } +data NewStorePurchase = NewStorePurchase + { paymentId :: Text, + provider :: PaymentProvider, + providerRef :: Text, + paid :: Maybe (CurrencyAmount, Text), + purchaseKey :: C.PublicKeyEd25519, + masterKey :: BadgeMasterKey, + badgeType :: BadgeType + } + data ServicePurchase = ServicePurchase { badgePurchaseId :: Int64, masterKey :: BadgeMasterKey, @@ -103,12 +119,31 @@ getBadgeCode db codeHash = (Only (Binary codeHash)) where toCode (badgeCodeId, badgeType, months, paymentStatus, revokedAt, expiresAt, purchaseId_, purchaseKey_, credential_) = - IssuedCode {badgeCodeId, badgeType, months, paymentStatus, revokedAt, expiresAt, redemption = codeRedemption purchaseId_ purchaseKey_ credential_} - codeRedemption purchaseId_ purchaseKey_ credential_ = case (purchaseId_, purchaseKey_) of - (Just badgePurchaseId, Just purchaseKey) -> case decodeCredential =<< credential_ of - Just credential -> CodeRedeemed RedeemedCode {badgePurchaseId, purchaseKey, credential} - Nothing -> CodeRedeemedUnreadable - _ -> CodeUnredeemed + IssuedCode {badgeCodeId, badgeType, months, paymentStatus, revokedAt, expiresAt, redemption = fundingCredit purchaseId_ purchaseKey_ credential_} + +getStorePaymentCredit :: DB.Connection -> PaymentProvider -> Text -> IO FundingCredit +getStorePaymentCredit db provider providerRef = + maybeFirstRow' Uncredited (\(purchaseId, purchaseKey, credential_) -> fundingCredit (Just purchaseId) (Just purchaseKey) credential_) $ + DB.query + db + [sql| + SELECT p.badge_purchase_id, p.purchase_key, i.credential + FROM sx_badge_service_payments pay + JOIN sx_badge_service_badge_purchases p ON p.payment_id = pay.payment_id + LEFT JOIN sx_badge_service_badge_issuances i ON i.badge_purchase_id = p.badge_purchase_id + WHERE pay.provider = ? AND pay.provider_ref = ? + ORDER BY i.period_end DESC + LIMIT 1 + |] + (textEncode provider, providerRef) + +fundingCredit :: Maybe Int64 -> Maybe C.PublicKeyEd25519 -> Maybe (Binary ByteString) -> FundingCredit +fundingCredit purchaseId_ purchaseKey_ credential_ = case (purchaseId_, purchaseKey_) of + (Just badgePurchaseId, Just purchaseKey) -> case decodeCredential =<< credential_ of + Just credential -> Credited CreditedPurchase {badgePurchaseId, purchaseKey, credential} + Nothing -> CreditedUnreadable + _ -> Uncredited + where decodeCredential (Binary bs) = J.decodeStrict' bs purchaseKeyExists :: DB.Connection -> C.PublicKeyEd25519 -> IO Bool @@ -137,11 +172,12 @@ getLedgerTip db purchaseId = DB.query db [sql| - SELECT entry_uuid, change_months, balance_months, balance_start_ts, balance_anchor_ts, balance_badge_type, - entry_type, entry_credit_type, entry_debit_type, service_created_at - FROM sx_badge_service_badge_ledger - WHERE badge_purchase_id = ? - ORDER BY entry_id DESC + SELECT l.entry_uuid, l.change_months, l.balance_months, l.balance_start_ts, l.balance_anchor_ts, l.balance_badge_type, + l.entry_type, l.entry_credit_type, l.entry_debit_type, l.service_created_at, l.payment_id, pay.invoice_id + FROM sx_badge_service_badge_ledger l + LEFT JOIN sx_badge_service_payments pay ON pay.payment_id = l.payment_id + WHERE l.badge_purchase_id = ? + ORDER BY l.entry_id DESC LIMIT 1 |] (Only purchaseId) @@ -161,18 +197,19 @@ getLedgerEntries db purchaseId afterEntryId = <$> DB.query db [sql| - SELECT entry_uuid, change_months, balance_months, balance_start_ts, balance_anchor_ts, balance_badge_type, - entry_type, entry_credit_type, entry_debit_type, service_created_at - FROM sx_badge_service_badge_ledger - WHERE badge_purchase_id = ? AND entry_id > ? - ORDER BY entry_id + SELECT l.entry_uuid, l.change_months, l.balance_months, l.balance_start_ts, l.balance_anchor_ts, l.balance_badge_type, + l.entry_type, l.entry_credit_type, l.entry_debit_type, l.service_created_at, l.payment_id, pay.invoice_id + FROM sx_badge_service_badge_ledger l + LEFT JOIN sx_badge_service_payments pay ON pay.payment_id = l.payment_id + WHERE l.badge_purchase_id = ? AND l.entry_id > ? + ORDER BY l.entry_id |] (purchaseId, afterEntryId) -toEntry :: (Text, Int, Int, UTCTime, UTCTime, BadgeType, Text, Maybe Text, Maybe Text, UTCTime) -> Maybe StatementEntry -toEntry (entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType, entryType_, credit_, debit_, createdAt) = +toEntry :: (Text, Int, Int, UTCTime, UTCTime, BadgeType, Text, Maybe Text, Maybe Text, UTCTime) :. (Maybe Text, Maybe Text) -> Maybe StatementEntry +toEntry ((entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType, entryType_, credit_, debit_, createdAt) :. (paymentId_, invoiceId_)) = (\entryType -> StatementEntry {entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType, wasPausedSince = Nothing, createdAt, entryType}) - <$> entryTypeFromColumns entryType_ credit_ debit_ + <$> entryTypeFromColumns ((InvoiceId <$> invoiceId_) <$ paymentId_) entryType_ credit_ debit_ getCurrentIssuance :: DB.Connection -> Int64 -> UTCTime -> IO (Maybe BadgeCredential) getCurrentIssuance db purchaseId now = do @@ -190,9 +227,10 @@ getCurrentIssuance db purchaseId now = do [Only (Binary bs)] -> J.decodeStrict' bs _ -> Nothing --- TODO write the reference columns (payment_id, charge_id, from_purchase_id, to_purchase_id) for entry types that carry one; only the tag is written today. -appendLedgerPlan :: DB.Connection -> Int64 -> [StatementEntry] -> Maybe (StatementEntry, StatementEntry, BadgeCredential) -> IO () -appendLedgerPlan db purchaseId rows issuance_ = do +-- | creditPaymentId_ names the payment behind a payment credit among the rows. +-- TODO write the other reference columns (charge_id, from_purchase_id, to_purchase_id) for entry types that carry one; only the tag is written today. +appendLedgerPlan :: DB.Connection -> Int64 -> Maybe Text -> [StatementEntry] -> Maybe (StatementEntry, StatementEntry, BadgeCredential) -> IO () +appendLedgerPlan db purchaseId creditPaymentId_ rows issuance_ = do mapM_ appendRow rows case issuance_ of Nothing -> pure () @@ -211,15 +249,18 @@ appendLedgerPlan db purchaseId rows issuance_ = do where appendRow StatementEntry {entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType, createdAt, entryType} = do let (entryTypeT, creditType, debitType) = entryTypeColumns entryType + paymentId_ = case entryType of + SECredit SCPayment {} -> creditPaymentId_ + _ -> Nothing DB.execute db [sql| INSERT INTO sx_badge_service_badge_ledger (entry_uuid, badge_purchase_id, change_months, balance_months, balance_start_ts, balance_anchor_ts, - balance_badge_type, service_created_at, created_at, entry_type, entry_credit_type, entry_debit_type) - VALUES (?,?,?,?,?,?,?,?,?,?,?,?) + balance_badge_type, service_created_at, created_at, entry_type, entry_credit_type, entry_debit_type, payment_id) + VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?) |] - ((entryId, purchaseId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs) :. (balanceBadgeType, createdAt, createdAt, entryTypeT, creditType, debitType)) + ((entryId, purchaseId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs) :. (balanceBadgeType, createdAt, createdAt, entryTypeT, creditType, debitType, paymentId_)) insertedRowId db -- redeemed_at is stamped here, so this must run in the same transaction as the credential rows. @@ -245,6 +286,32 @@ createCodePurchase db NewCodePurchase {badgeCodeId, purchaseKey, masterKey = Bad (purchaseKey, Binary mk, badgeType, badgeType, PSIssued, badgeCodeId, now, now) Just <$> insertedRowId db +-- | In the transaction of the credential rows. The payment's unique (provider, provider_ref) is the +-- claim: a transaction presented twice at once, or under another key, inserts nothing the second time. +createStorePurchase :: DB.Connection -> NewStorePurchase -> UTCTime -> IO (Maybe Int64) +createStorePurchase db NewStorePurchase {paymentId, provider, providerRef, paid, purchaseKey, masterKey = BadgeMasterKey mk, badgeType} now = do + claimed <- + executeChanging + db + [sql| + INSERT INTO sx_badge_service_payments (payment_id, provider, provider_ref, amount, currency, status, created_at, updated_at) + VALUES (?,?,?,?,?,?,?,?) + ON CONFLICT (provider, provider_ref) DO NOTHING + |] + (paymentId, textEncode provider, providerRef, (\(CurrencyAmount a) -> a) . fst <$> paid, snd <$> paid, paymentStatusText PSSettled, now, now) + if claimed == 0 + then pure Nothing + else do + DB.execute + db + [sql| + INSERT INTO sx_badge_service_badge_purchases + (purchase_key, master_key, initial_badge_type, current_badge_type, status, payment_id, created_at, updated_at) + VALUES (?,?,?,?,?,?,?,?) + |] + (purchaseKey, Binary mk, badgeType, badgeType, PSIssued, paymentId, now, now) + Just <$> insertedRowId db + data RevokeResult = Revoked | AlreadyRevoked | AlreadyRedeemed | NoSuchCode deriving (Eq, Show) diff --git a/apps/simplex-badge-service/src/BadgeService/Store/Invoices.hs b/apps/simplex-badge-service/src/BadgeService/Store/Invoices.hs index a3e177400e..57f9341308 100644 --- a/apps/simplex-badge-service/src/BadgeService/Store/Invoices.hs +++ b/apps/simplex-badge-service/src/BadgeService/Store/Invoices.hs @@ -17,7 +17,6 @@ module BadgeService.Store.Invoices getInvoice, getInvoiceByProviderRef, unpaidRefs, - providerText, codeHashExists, OverdueInvoice (..), overdueInvoices, @@ -59,7 +58,7 @@ import Simplex.Chat.Store.Shared (insertedRowId) import Simplex.Chat.PaymentService.Types (CardProvider (..), CryptoCurrency (..), CurrencyAmount (..), InvoiceId (..), InvoiceStatus (..), PaymentProvider (..), PaymentStatus (..), ServicePaymentDestination (..)) import Simplex.Messaging.Agent.Store.Common (DBStore, withConnection, withTransaction) import qualified Simplex.Messaging.Agent.Store.DB as DB -import Simplex.Messaging.Encoding.String (textEncode) +import Simplex.Messaging.Encoding.String (textDecode, textEncode) import Simplex.Messaging.Util (safeDecodeUtf8, tshow) #if defined(dbPostgres) @@ -290,25 +289,6 @@ qSeedBadgeOffer = "INSERT INTO @badge_offers (offer_id, price_id, months, free_months, discount, status, created_at) " <> "VALUES (?,?,?,?,?,?,?) ON CONFLICT (offer_id) DO NOTHING" -providerText :: PaymentProvider -> Text -providerText = \case - PPApple -> "apple" - PPGoogle -> "google" - PPStripe -> "stripe" - PPCrypto -> "crypto" - PPCode -> "code" - PPReceipt -> "receipt" - -textToProvider :: Text -> Maybe PaymentProvider -textToProvider = \case - "apple" -> Just PPApple - "google" -> Just PPGoogle - "stripe" -> Just PPStripe - "crypto" -> Just PPCrypto - "code" -> Just PPCode - "receipt" -> Just PPReceipt - _ -> Nothing - cryptoCurrencyText :: CryptoCurrency -> Text cryptoCurrencyText CCBtc = "btc" cryptoCurrencyText CCXmr = "xmr" @@ -380,7 +360,7 @@ mkInvoiceRow :. (cryptoAmt, expiresAt, statusTxt, createdAt) :. (pAmount, pCryptoPaid, pCryptoDue, pPaidInFull, pStatus, pUpdatedAt) ) = do - provider <- note "invoices.provider" (textToProvider providerTxt) + provider <- note "invoices.provider" (textDecode providerTxt) status <- note "invoices.status" (textToInvoiceStatus statusTxt) destination <- note "invoice payment destination" (mkDestination url addr cryptoCur cryptoAmt) pure @@ -462,7 +442,7 @@ insertInvoiceRows db NewInvoice {..} = do DB.execute db qInsertInvoice - ( (invId, providerText niProvider, price, discountAmount, Nothing :: Maybe Word32, amount, niCurrency) + ( (invId, textEncode niProvider, price, discountAmount, Nothing :: Maybe Word32, amount, niCurrency) :. (url, addr, cryptoCur, cryptoAmt, expiresAt, invoiceStatusText ISOpen, createdAt, createdAt) ) DB.execute @@ -526,7 +506,7 @@ overdueInvoices st cutoff = withConnection st $ \db -> do rows <- DB.query db qOverdueInvoices (Only (truncateToSecond cutoff)) either (E.throwIO . StoreDecodeError) pure (traverse toOverdue rows) where - toOverdue (i, providerTxt, oiProviderRef, oiCreatedAt) = case textToProvider providerTxt of + toOverdue (i, providerTxt, oiProviderRef, oiCreatedAt) = case textDecode providerTxt of Just oiProvider -> Right OverdueInvoice {oiInvoiceId = InvoiceId i, oiProvider, oiProviderRef, oiCreatedAt} Nothing -> Left ("invoices.provider: " <> providerTxt) @@ -591,7 +571,7 @@ upsertPayment db InvoiceRow {irInvoiceId, irProvider, irProviderRef, irCurrency} DB.execute db qUpsertPayment - ( (invId, invId, providerText irProvider, irProviderRef, amount) + ( (invId, invId, textEncode irProvider, irProviderRef, amount) :. (irCurrency, cryptoAmount, cryptoDue, if paidInFull then 1 :: Int else 0, paymentStatusText status, at, at) ) where diff --git a/apps/simplex-badge-service/src/BadgeService/Store/Postgres/Migrations.hs b/apps/simplex-badge-service/src/BadgeService/Store/Postgres/Migrations.hs index c8179d5df2..a58df6d02b 100644 --- a/apps/simplex-badge-service/src/BadgeService/Store/Postgres/Migrations.hs +++ b/apps/simplex-badge-service/src/BadgeService/Store/Postgres/Migrations.hs @@ -17,7 +17,8 @@ badgeServiceSchemaMigrations = sortOn name $ map migration schemaMigrations schemaMigrations :: [(String, Text, Maybe Text)] schemaMigrations = - [ ("20260915_badge_service_schema", m20260915_badge_service_schema, Just down_m20260915_badge_service_schema) + [ ("20260915_badge_service_schema", m20260915_badge_service_schema, Just down_m20260915_badge_service_schema), + ("20260925_badge_store_receipts", m20260925_badge_store_receipts, Just down_m20260925_badge_store_receipts) ] -- | The client tables share this database, so the service tables are the same names behind a prefix. @@ -109,6 +110,44 @@ DROP INDEX @idx_badge_purchases_code; DROP TABLE @badge_codes; |] +m20260925_badge_store_receipts :: Text +m20260925_badge_store_receipts = + withPrefix + servicePrefix + -- The unique provider_ref is what makes one store transaction fund one purchase: presented twice + -- at once, or under two keys, only one insert of its payment succeeds. + [r| +DROP INDEX @idx_payments_provider_ref; + +CREATE UNIQUE INDEX @idx_payments_provider_ref ON @payments(provider, provider_ref); + +ALTER TABLE @badge_purchases ADD COLUMN payment_id TEXT REFERENCES @payments; + +CREATE UNIQUE INDEX @idx_badge_purchases_payment ON @badge_purchases(payment_id); + +ALTER TABLE @badge_ledger ADD COLUMN payment_id TEXT REFERENCES @payments; + +CREATE INDEX @idx_badge_ledger_payment ON @badge_ledger(payment_id); +|] + +down_m20260925_badge_store_receipts :: Text +down_m20260925_badge_store_receipts = + withPrefix + servicePrefix + [r| +DROP INDEX @idx_badge_ledger_payment; + +ALTER TABLE @badge_ledger DROP COLUMN payment_id; + +DROP INDEX @idx_badge_purchases_payment; + +ALTER TABLE @badge_purchases DROP COLUMN payment_id; + +DROP INDEX @idx_payments_provider_ref; + +CREATE INDEX @idx_payments_provider_ref ON @payments(provider, provider_ref); +|] + {- TODO [badges] deferred with the draft in M20260915_user_badges, service only. ALTER TABLE @payments ADD COLUMN receipt_hash BYTEA; diff --git a/apps/simplex-badge-service/src/BadgeService/Store/SQLite/Migrations.hs b/apps/simplex-badge-service/src/BadgeService/Store/SQLite/Migrations.hs index bf022f189c..fed5fd5ed0 100644 --- a/apps/simplex-badge-service/src/BadgeService/Store/SQLite/Migrations.hs +++ b/apps/simplex-badge-service/src/BadgeService/Store/SQLite/Migrations.hs @@ -18,7 +18,8 @@ badgeServiceSchemaMigrations = sortOn name $ map migration schemaMigrations schemaMigrations :: [(String, Query, Maybe Query)] schemaMigrations = - [ ("20260915_badge_service_schema", m20260915_badge_service_schema, Just down_m20260915_badge_service_schema) + [ ("20260915_badge_service_schema", m20260915_badge_service_schema, Just down_m20260915_badge_service_schema), + ("20260925_badge_store_receipts", m20260925_badge_store_receipts, Just down_m20260925_badge_store_receipts) ] -- | The client tables share this database, so the service tables are the same names behind a prefix. @@ -110,6 +111,44 @@ DROP INDEX @idx_badge_purchases_code; DROP TABLE @badge_codes; |] +m20260925_badge_store_receipts :: Query +m20260925_badge_store_receipts = + withPrefix + servicePrefix + -- The unique provider_ref is what makes one store transaction fund one purchase: presented twice + -- at once, or under two keys, only one insert of its payment succeeds. + [sql| +DROP INDEX @idx_payments_provider_ref; + +CREATE UNIQUE INDEX @idx_payments_provider_ref ON @payments(provider, provider_ref); + +ALTER TABLE @badge_purchases ADD COLUMN payment_id TEXT REFERENCES @payments; + +CREATE UNIQUE INDEX @idx_badge_purchases_payment ON @badge_purchases(payment_id); + +ALTER TABLE @badge_ledger ADD COLUMN payment_id TEXT REFERENCES @payments; + +CREATE INDEX @idx_badge_ledger_payment ON @badge_ledger(payment_id); +|] + +down_m20260925_badge_store_receipts :: Query +down_m20260925_badge_store_receipts = + withPrefix + servicePrefix + [sql| +DROP INDEX @idx_badge_ledger_payment; + +ALTER TABLE @badge_ledger DROP COLUMN payment_id; + +DROP INDEX @idx_badge_purchases_payment; + +ALTER TABLE @badge_purchases DROP COLUMN payment_id; + +DROP INDEX @idx_payments_provider_ref; + +CREATE INDEX @idx_payments_provider_ref ON @payments(provider, provider_ref); +|] + {- TODO [badges] deferred with the draft in M20260915_user_badges, service only. ALTER TABLE @payments ADD COLUMN receipt_hash BLOB; diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs new file mode 100644 index 0000000000..b623944c46 --- /dev/null +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs @@ -0,0 +1,101 @@ +{-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} + +module BadgeService.StoreReceipts + ( VerifiedStoreTransaction (..), + StoreRefusal (..), + StoreVerifier (..), + StoreReceipt (..), + noStoreVerifier, + toStoreReceipt, + ) +where + +import Control.Exception (evaluate) +import Data.Bifunctor (first) +import Data.Char (isAsciiLower, isAsciiUpper, isDigit) +import Data.Maybe (fromMaybe) +import Data.Text (Text) +import qualified Data.Text as T +import Simplex.Chat.PaymentService (ServicePayment (..), appleTransactionId, googlePurchaseRef) +import Simplex.Chat.PaymentService.Types (CurrencyAmount, PaymentProvider (..), StoreTransactionRef (..)) +import Simplex.Messaging.Util (catchOwn') +import System.Timeout (timeout) + +-- | What a store vouches for about one completed transaction. +-- TODO [badges] PaymentFunding's PFApple and PFGoogle sketch the same thing and have no producer; +-- delete them, or build them out and reconcile. +data VerifiedStoreTransaction = VerifiedStoreTransaction + { transactionRef :: Text, -- from what was verified: Apple's transactionId, googlePurchaseRef of the token asked about + productId :: Text, + quantity :: Int, -- as the store reported it; the service refuses any but 1, as the apps never buy more + -- costs the buyer nothing: Apple's Sandbox, which a public TestFlight build buys in, and Google's license testers + testPurchase :: Bool, + paid :: Maybe (CurrencyAmount, Text) -- in minor units; Google's purchase record carries no price + } + deriving (Eq, Show) + +-- | The reasons are for the service's log alone and must never quote the receipt. +data StoreRefusal + = SRInvalid Text -- a verdict that cannot change, and the client consumes the purchase: forged, malformed, another app's, refunded + | SRPending -- a real purchase the store has not settled; it may yet + | SRUnreachable Text -- no verdict: the store was not asked, did not answer, or does not know the token (a Play 404 may be lag) + | SRVerifierFailed Text -- a bug, not the store's answer + | SRNotConfigured -- no verifier for this store is deployed; the purchase may be real + deriving (Eq, Show) + +-- | Apple signs its receipt and ships the certificate chain in it, so it is verified with no network +-- call; a Play token is opaque and must be asked about, which is why only that field is in IO. +data StoreVerifier = StoreVerifier + { verifyApple :: Maybe (Text -> Either Text VerifiedStoreTransaction), -- the JWS; Left is why Apple did not sign it + verifyGoogle :: Maybe (Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction)), -- the product id and the token + -- microseconds; requests are answered one at a time, so a verifier that does not finish holds up every other one + verifyTimeout :: Int + } + +-- | A store payment, named by the store's own reference before anything is verified. +data StoreReceipt = StoreReceipt + { txRef :: StoreTransactionRef, + verifyReceipt :: IO (Either StoreRefusal VerifiedStoreTransaction) + } + +noStoreVerifier :: StoreVerifier +noStoreVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Nothing, verifyTimeout = 10000000} + +-- | Nothing for a payment no store made. Exceptions are not logged, since they can quote the receipt +-- or, from Google, a URL holding the token. +toStoreReceipt :: StoreVerifier -> ServicePayment -> Maybe (Either StoreRefusal StoreReceipt) +toStoreReceipt StoreVerifier {verifyApple, verifyGoogle, verifyTimeout} = \case + SPApple {jws} -> Just $ case appleTransactionId jws of + Nothing -> Left $ SRInvalid "names no transaction" + Just ref -> Right $ StoreReceipt (StoreTransactionRef PPApple ref) $ maybe unconfigured (\verify -> offline $ first SRInvalid $ verify jws) verifyApple + SPGoogle {productId, token} + -- the claim is the token's hash, so neither string may name any purchase but the one it claims, + -- whatever path a verifier builds from them + | not (googleProductId productId) -> Just $ Left $ SRInvalid "not a Play product id" + -- Play documents no token grammar, so this is our guess, and refusing to ask Play is not its verdict + | not (googleToken token) -> Just $ Left $ SRUnreachable "a Play token this service will not send" + | otherwise -> Just $ Right $ StoreReceipt (StoreTransactionRef PPGoogle (googlePurchaseRef token)) $ maybe unconfigured (\verify -> online $ verify productId token) verifyGoogle + SPInvoice {} -> Nothing + SPReceipt {} -> Nothing + where + unconfigured = pure $ Left SRNotConfigured + -- nothing was fetched, so a throw or an overrun is a bug or a malformed receipt, never an outage + offline verdict = + (fromMaybe (Left $ SRVerifierFailed "apple verifier timed out") <$> timeout verifyTimeout (forced verdict)) + `catchOwn'` \_ -> pure $ Left $ SRVerifierFailed "apple verifier threw" + online verify = + (fromMaybe (Left $ SRUnreachable "google verifier timed out") <$> timeout verifyTimeout (verify >>= forced)) + `catchOwn'` \_ -> pure $ Left $ SRUnreachable "google verifier threw" + -- a verdict holding a thunk that throws would otherwise throw later, outside these handlers + forced = either (fmap Left . evaluate) (fmap Right . evaluate) + +googleProductId :: Text -> Bool +googleProductId pid = case T.uncons pid of + Just (c, _) -> T.length pid <= 150 && (isAsciiLower c || isDigit c) && T.all (\x -> isAsciiLower x || isDigit x || x == '_' || x == '.') pid + Nothing -> False + +googleToken :: Text -> Bool +googleToken t = not (T.null t) && T.length t <= 4096 && T.all (\x -> isAsciiLower x || isAsciiUpper x || isDigit x || x == '.' || x == '_' || x == '-') t diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs new file mode 100644 index 0000000000..c2fd1ab63d --- /dev/null +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs @@ -0,0 +1,41 @@ +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} + +module BadgeService.StoreReceipts.Mock (mockStoreVerifier) where + +import BadgeService.StoreReceipts +import qualified Data.Aeson as J +import qualified Data.Aeson.KeyMap as JM +import qualified Data.ByteString.Base64.URL as B64U +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) +import Simplex.Chat.PaymentService (appleTransactionId, googlePurchaseRef) +import Simplex.Messaging.Util (eitherToMaybe) + +-- | Vouches for any well-formed receipt without verifying anything. Each transaction is named by +-- the same function its claim is named by, so the two cannot differ. +mockStoreVerifier :: StoreVerifier +mockStoreVerifier = noStoreVerifier {verifyApple = Just mockApple, verifyGoogle = Just mockGoogle} + +mockApple :: Text -> Either Text VerifiedStoreTransaction +mockApple signed = case T.splitOn "." signed of + [_, payload, _] -> do + o <- case J.decodeStrict' =<< eitherToMaybe (B64U.decodeUnpadded $ encodeUtf8 payload) of + Just (J.Object obj) -> Right obj + _ -> Left "payload is not base64url JSON" + productId <- case JM.lookup "productId" o of + Just (J.String p) -> Right p + _ -> Left "no productId" + transactionRef <- maybe (Left "no transactionId") Right $ appleTransactionId signed + Right $ vouched transactionRef productId + _ -> Left "not three dot-separated parts" + +mockGoogle :: Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +mockGoogle productId token = pure $ Right $ vouched (googlePurchaseRef token) productId + +vouched :: Text -> Text -> VerifiedStoreTransaction +vouched transactionRef productId = + -- not a test purchase, though nothing was paid: a test purchase is refused as receipt_invalid, which is + -- terminal and drops the client's keys, so every dev purchase would fail for good + VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase = False, paid = Nothing} diff --git a/apps/simplex-badge-service/test-fixtures/apple/transaction-legend.json b/apps/simplex-badge-service/test-fixtures/apple/transaction-legend.json new file mode 100644 index 0000000000..72ee85416c --- /dev/null +++ b/apps/simplex-badge-service/test-fixtures/apple/transaction-legend.json @@ -0,0 +1,19 @@ +{ + "transactionId": "2000000812345672", + "originalTransactionId": "2000000812345672", + "bundleId": "chat.simplex.app", + "productId": "BADGE_LEGEND_01", + "purchaseDate": 1790000000000, + "originalPurchaseDate": 1790000000000, + "quantity": 1, + "type": "Consumable", + "appAccountToken": "0b6a7e1d-5c3f-4a8e-b2d4-9e1f6c7a8b20", + "inAppOwnershipType": "PURCHASED", + "signedDate": 1790000001000, + "environment": "Production", + "transactionReason": "PURCHASE", + "storefront": "USA", + "storefrontId": "143441", + "price": 70000, + "currency": "USD" +} diff --git a/apps/simplex-badge-service/test-fixtures/apple/transaction-sandbox.json b/apps/simplex-badge-service/test-fixtures/apple/transaction-sandbox.json new file mode 100644 index 0000000000..e61c63d2a7 --- /dev/null +++ b/apps/simplex-badge-service/test-fixtures/apple/transaction-sandbox.json @@ -0,0 +1,19 @@ +{ + "transactionId": "2000000812345673", + "originalTransactionId": "2000000812345673", + "bundleId": "chat.simplex.app", + "productId": "BADGE_LEGEND_01", + "purchaseDate": 1790000000000, + "originalPurchaseDate": 1790000000000, + "quantity": 1, + "type": "Consumable", + "appAccountToken": "4d2c9a61-8e3b-4f70-a1c5-6b0e9d2f3a47", + "inAppOwnershipType": "PURCHASED", + "signedDate": 1790000001000, + "environment": "Sandbox", + "transactionReason": "PURCHASE", + "storefront": "USA", + "storefrontId": "143441", + "price": 70000, + "currency": "USD" +} diff --git a/apps/simplex-badge-service/test-fixtures/apple/transaction-supporter.json b/apps/simplex-badge-service/test-fixtures/apple/transaction-supporter.json new file mode 100644 index 0000000000..267184c036 --- /dev/null +++ b/apps/simplex-badge-service/test-fixtures/apple/transaction-supporter.json @@ -0,0 +1,19 @@ +{ + "transactionId": "2000000812345671", + "originalTransactionId": "2000000812345671", + "bundleId": "chat.simplex.app", + "productId": "BADGE_SUPPORTER_01", + "purchaseDate": 1790000000000, + "originalPurchaseDate": 1790000000000, + "quantity": 1, + "type": "Consumable", + "appAccountToken": "7f7c0f43-4b7b-4c2e-9d57-1b7a2b1f3c11", + "inAppOwnershipType": "PURCHASED", + "signedDate": 1790000001000, + "environment": "Production", + "transactionReason": "PURCHASE", + "storefront": "USA", + "storefrontId": "143441", + "price": 7000, + "currency": "USD" +} diff --git a/bots/api/TYPES.md b/bots/api/TYPES.md index f1122979a9..338fa6c206 100644 --- a/bots/api/TYPES.md +++ b/bots/api/TYPES.md @@ -441,6 +441,9 @@ Remote controller app version range (min and max as version strings). InvalidCode: - type: "invalidCode" +InvalidReceipt: +- type: "invalidReceipt" + ServiceNotConfigured: - type: "serviceNotConfigured" @@ -477,6 +480,7 @@ CredentialNotVerified: - "payment_not_entitled" - "payment_pending" - "provider_unavailable" +- "provider_not_configured" - "rate_limited" - "code_invalid" - "code_used" diff --git a/bots/src/API/Docs/Commands.hs b/bots/src/API/Docs/Commands.hs index 4ffba7bfbe..ae1789f47e 100644 --- a/bots/src/API/Docs/Commands.hs +++ b/bots/src/API/Docs/Commands.hs @@ -361,6 +361,7 @@ undocumentedCommands = "APIConnectPreparedGroup", "APIContactInfo", "APIContactQueueInfo", + "APICreateBadgeInvoice", "APICreateChatItems", "APICreateChatTag", "APICreateMemberContact", @@ -407,6 +408,7 @@ undocumentedCommands = "APIPlanForwardChatItems", "APIPrepareContact", "APIPrepareGroup", + "APIPurchaseBadge", "APIRedeemBadgeCode", "APIRegisterToken", "APIRejectCall", diff --git a/bots/src/API/Docs/Events.hs b/bots/src/API/Docs/Events.hs index dab06e9262..e35cd6ffe5 100644 --- a/bots/src/API/Docs/Events.hs +++ b/bots/src/API/Docs/Events.hs @@ -221,6 +221,7 @@ undocumentedEvents = "CEvtSndFileRedirectStartXFTP", "CEvtSndFileStart", -- legacy SMP files "CEvtSndStandaloneFileComplete", + "CEvtStorePurchaseResolved", "CEvtConnectionsDiff", "CEvtSubscriptionEnd", "CEvtTerminalEvent", diff --git a/bots/src/API/Docs/Responses.hs b/bots/src/API/Docs/Responses.hs index 18392ae1b5..674620487f 100644 --- a/bots/src/API/Docs/Responses.hs +++ b/bots/src/API/Docs/Responses.hs @@ -134,6 +134,7 @@ undocumentedResponses = "CRAppSettings", "CRArchiveExported", "CRArchiveImported", + "CRBadgeInvoice", "CRBadgeLedger", "CRBadgeRedeemed", "CRBadgeState", diff --git a/docs/protocol/badges-rpc.md b/docs/protocol/badges-rpc.md index 8ea70e1d19..b35e6b8001 100644 --- a/docs/protocol/badges-rpc.md +++ b/docs/protocol/badges-rpc.md @@ -20,21 +20,28 @@ A timeout hides the outcome, so the client repeats the identical signed request - `getBadgeInvoice` — returns the open invoice again; a new invoice is created only when none is open. - `redeemBadgeCode` — a code already redeemed by the signing key returns the same `badgeCredential` and writes nothing; redeemed by another key, `code_used`. The client must therefore keep the key it first signed with, or a retry cannot be recognised. -- `purchaseBadge` — a payment already credited returns the same `badgeCredential` and writes nothing. +- `purchaseBadge` — a payment already credited returns the same `badgeCredential` and writes nothing; a store payment credited to another key, `receipt_used`. - `upgradeBadgeSubscription` — evidence already applied returns the same result and writes nothing. - `issueBadge` — repeated within an issued period, returns the cached credential and writes nothing. -- `purchaseBadge` with a `receipt` — presented again by the same key it returns the same result; presented by another key, `receipt_used`. +- `purchaseBadge` with the recovery `receipt` — presented again by the same key it returns the same result; presented by another key, `receipt_used`. ## Commands -`purchaseBadge` and `upgradeBadgeSubscription` carry `badgeRequest`, the signer's input (`BadgeRequest`, `Simplex.Chat.Badges`): the service signs exactly this content or rejects the command. The proposed `badgeExpiry` is capped by the funded coverage (`sundayAfter`, model §3) and is required — a credential always expires, and a badge that does not is expressed as a long finite term; `badgeExtra` is reserved and must be empty. `issueBadge` carries no `badgeRequest`: the tier, the master key and the expiry are all the service's own, so there is nothing for the client to state. +The client never states what is signed. The tier is that of whatever funded the purchase; the expiry is the `sundayAfter` of the period issued (`endOfMondayAfter` in code), shared by every credential of that week; `badgeExtra` is reserved and empty. A client-proposed expiry, even one capped by the funded coverage, would fall off that shared boundary and single its holder out of the week's anonymity set — so no command carries `badgeRequest`. `upgradeBadgeSubscription` still has the field in the schema; that is wrong and it must be dropped when the command is implemented. - `getBadgeCatalog` → `badgeCatalog` — the prices and offers; signed, also the purchase's `badgeStatement`. Store builds never send it: prices come from the store and SKUs from app config. - `getBadgeInvoice` → `badgeInvoice` — prices the purchase for `badgeInfo` and `paymentVia` (`card` — Stripe; `crypto` — btc, xmr). The response holds the generic `invoice` — `invoiceId`, `price`, `discount`, the upgrade `credit`, `amount` = price − discount − credit, `currency`, `expiresAt`, and `paymentTo` (`url` for card; `address` and `cryptoAmount` for crypto) — beside the badge part, `badgeType` and `months`. `priceId` pins the price the client displayed; `offerId` selects a discounted duration, and its absence buys one month at that price. Price and offer status is checked here only: `deprecated` is still accepted, `disabled` is rejected; a badge type with no active price yields `product_unavailable`. - `redeemBadgeCode` → `badgeCredential` — redeems a code, records the credit, and issues the first credential, in one round trip. It carries `masterKey` and `code` and no `badgeRequest`: a code states no tier and no expiry, so the credential is what reports them. Errors: `code_invalid` for an unknown or malformed code, `code_used` when another key redeemed it, `code_expired` past a redemption deadline. -- `purchaseBadge` → `badgeCredential` — verifies the funding (`apple` JWS offline; `google` token via the Publisher API; `invoice` against webhook-confirmed settlement, `payment_pending` until it lands; `receipt`), records the credit, and issues the first credential, in one round trip. The response `receipt` is the recovery bearer secret (model § recovery); the service stores its hash; lifetime badges receive none. +- `purchaseBadge` → `badgeCredential` — verifies the funding (`apple` JWS offline; `google` product id and token via the Publisher API; `invoice` against webhook-confirmed settlement, `payment_pending` until it lands; `receipt`), records the credit, and issues the first credential, in one round trip. It carries `masterKey` and no `badgeRequest`. The response `receipt` is the recovery bearer secret (model § recovery); the service stores its hash; lifetime badges receive none. + - A store transaction is claimed by its own id, read from the evidence before verification, and credited only when the verified transaction carries that same id. A receipt already credited to the signing key is answered from the record, without asking the store. + - Errors: `receipt_invalid`, `payment_pending`, `provider_unavailable` — see the classes below; `receipt_used` when another key was credited with it; `product_unavailable` for a product this service does not price; `provider_not_configured` when this deployment has no verifier for the store, terminal for the request since retrying cannot deploy one. `receipt_invalid` and `receipt_used` are the only answers on which the client drops the keys it signed with and finishes the store transaction. Every other answer records nothing and leaves the purchase with its keys, to be presented again at the next trigger. + - **Which class an answer belongs to.** The two mistakes do not cost the same, so when it is not certain, answer unreachable. `receipt_invalid` tells the client the purchase is dead: it drops the keys it signed with and finishes the store transaction — consumed on Play, finished on StoreKit — and nothing can present it again, so a buyer answered this by mistake has paid for a badge they can never receive. Answering unreachable by mistake costs one more verification request each time the app presents the purchase again, and a Play purchase left unacknowledged for three days is refunded to the buyer. + - **Terminal**, `receipt_invalid` — the store answered about this purchase and cannot change its mind: an Apple signature or certificate chain that does not verify, another app's bundle id, a test purchase (Apple Sandbox, Play `purchaseType` test), a refunded or revoked purchase, Play `purchaseState` canceled. + - **Pending**, `payment_pending` — Play `purchaseState` pending. + - **Unreachable**, `provider_unavailable` — the store was not asked or did not answer: network, timeout, 5xx, quota, this service's own auth or permission failures, and every Play error response, a 404 from `purchases.products.get` or `purchases.subscriptionsv2.get` and a 400 or 410 calling the token invalid included. A 404 decides nothing: Play answers it both for a token it has just issued and not yet recorded, and for one that was never a purchase. Only a purchase record is a verdict. A token whose characters this service will not send is never sent, so Play never answers about it — and Play documents no token grammar, so that check is our guess, not its verdict. A product id outside the characters Play does document is terminal, since no product of this app can have one. + - Apple is verified offline, so it has no "not yet" and a negative answer about the signed evidence is terminal. Two things are not the store's answer and leave the client holding the purchase: the verifier's own failure, such as a root certificate it could not load, which is `internal`; and a product this service does not price, which is `product_unavailable` — the verifier vouched for the transaction either way. - Funding by `receipt` is a transfer (post-MVP): the unissued months of the purchase that receipt belongs to move to the signing key, recorded as `debit(transferOut)` on the source and `credit(transferIn)` on the new purchase, and the presented receipt is retired for a fresh one. The transferred period's issuance debits a month like any other. Lifetime badges hold no receipt, so support handles them. -- `upgradeBadgeSubscription` → `badgeCredential` — the app-led store subscription change, on the same key: verifies the store evidence of the replaced subscription and records the new plan; an immediate upgrade returns the new credential, a deferred change returns none. +- `upgradeBadgeSubscription` → `badgeCredential` — the app-led store subscription change, on the same key: verifies the store evidence of the replaced subscription and records the new plan; an immediate upgrade returns the new credential, a deferred change returns none. Its `badgeRequest` is to be dropped (see above). - `issueBadge` → `badgeCredential` — issues the next period from the balance, the only source of issuance. It carries `balance` alone: the credential is signed with the purchase's stored master key, for the type the balance funds, expiring at the `sundayAfter` of the period issued. The ledger is advanced first; the credential is signed before the `debit(badge)` and issuance rows are written, in one transaction. An exhausted balance yields no `credential`; the `statement` shows why. Issuing on a paused badge resumes it (model 2.13). - `pauseBadge` (post-MVP) → `badgeCredential` — suspends issuance and lapse (model 2.13). @@ -63,4 +70,4 @@ An assertion that names an entry the service holds is a prefix: the service proc ## Errors -`retryAfter` marks the transient codes: `payment_pending`, `provider_unavailable`, `rate_limited`. `offer_disabled` calls for a catalog refresh. `code_invalid` covers unknown, malformed and revoked codes alike, so a guesser learns nothing from the difference; `code_used` — redeemed under another key; `code_expired` — past its redemption deadline. `receipt_invalid` covers unknown receipts. All other codes are terminal for the attempted command. +`retryAfter` marks the transient codes: `payment_pending`, `provider_unavailable`, `rate_limited`. `offer_disabled` calls for a catalog refresh. `code_invalid` covers unknown, malformed and revoked codes alike, so a guesser learns nothing from the difference; `code_used` — redeemed under another key; `code_expired` — past its redemption deadline. `receipt_invalid` covers forged, malformed, another app's, refunded and test receipts alike, so a guesser learns nothing from the difference; `receipt_used` — credited to another key; `provider_not_configured` — no verifier for that store is deployed, so the receipt is neither credited nor refused. All other codes are terminal for the attempted command. diff --git a/docs/protocol/badges-rpc.schema.json b/docs/protocol/badges-rpc.schema.json index 01581a5bac..f9ca9d4a14 100644 --- a/docs/protocol/badges-rpc.schema.json +++ b/docs/protocol/badges-rpc.schema.json @@ -95,7 +95,7 @@ "properties": {"jws": {"type": "string"}} }, "google": { - "properties": {"token": {"type": "string"}} + "properties": {"productId": {"type": "string"}, "token": {"type": "string"}} }, "invoice": { "properties": {"invoiceId": {"type": "string"}} @@ -309,7 +309,7 @@ }, "purchaseBadge": { "properties": { - "badgeRequest": {"ref": "badgeRequest"}, + "masterKey": {"ref": "base64url"}, "payment": {"ref": "payment"} }, "optionalProperties": { @@ -321,7 +321,10 @@ }, "upgradeBadgeSubscription": { "properties": { - "badgeRequest": {"ref": "badgeRequest"}, + "badgeRequest": { + "ref": "badgeRequest", + "metadata": {"comment": "known wrong: to be dropped when implemented, see badges-rpc.md"} + }, "payment": { "ref": "payment", "metadata": {"comment": "store payments only"} diff --git a/packages/simplex-chat-client/types/typescript/src/types.ts b/packages/simplex-chat-client/types/typescript/src/types.ts index d7db7f259f..56fa0b389e 100644 --- a/packages/simplex-chat-client/types/typescript/src/types.ts +++ b/packages/simplex-chat-client/types/typescript/src/types.ts @@ -249,6 +249,7 @@ export interface BadgeProof { export type BadgeRedeemError = | BadgeRedeemError.InvalidCode + | BadgeRedeemError.InvalidReceipt | BadgeRedeemError.ServiceNotConfigured | BadgeRedeemError.BadgeActive | BadgeRedeemError.ServiceError @@ -259,6 +260,7 @@ export type BadgeRedeemError = export namespace BadgeRedeemError { export type Tag = | "invalidCode" + | "invalidReceipt" | "serviceNotConfigured" | "badgeActive" | "serviceError" @@ -274,6 +276,10 @@ export namespace BadgeRedeemError { type: "invalidCode" } + export interface InvalidReceipt extends Interface { + type: "invalidReceipt" + } + export interface ServiceNotConfigured extends Interface { type: "serviceNotConfigured" } @@ -312,6 +318,7 @@ export enum BadgeServiceErrorCode { Payment_not_entitled = "payment_not_entitled", Payment_pending = "payment_pending", Provider_unavailable = "provider_unavailable", + Provider_not_configured = "provider_not_configured", Rate_limited = "rate_limited", Code_invalid = "code_invalid", Code_used = "code_used", diff --git a/packages/simplex-chat-python/src/simplex_chat/types/_types.py b/packages/simplex-chat-python/src/simplex_chat/types/_types.py index ab06a24f53..eca43f04ed 100644 --- a/packages/simplex-chat-python/src/simplex_chat/types/_types.py +++ b/packages/simplex-chat-python/src/simplex_chat/types/_types.py @@ -188,6 +188,9 @@ class BadgeProof(TypedDict): class BadgeRedeemError_invalidCode(TypedDict): type: Literal["invalidCode"] +class BadgeRedeemError_invalidReceipt(TypedDict): + type: Literal["invalidReceipt"] + class BadgeRedeemError_serviceNotConfigured(TypedDict): type: Literal["serviceNotConfigured"] @@ -210,6 +213,7 @@ class BadgeRedeemError_credentialNotVerified(TypedDict): BadgeRedeemError = ( BadgeRedeemError_invalidCode + | BadgeRedeemError_invalidReceipt | BadgeRedeemError_serviceNotConfigured | BadgeRedeemError_badgeActive | BadgeRedeemError_serviceError @@ -218,9 +222,9 @@ BadgeRedeemError = ( | BadgeRedeemError_credentialNotVerified ) -BadgeRedeemError_Tag = Literal["invalidCode", "serviceNotConfigured", "badgeActive", "serviceError", "invalidResponse", "unknownKeyIndex", "credentialNotVerified"] +BadgeRedeemError_Tag = Literal["invalidCode", "invalidReceipt", "serviceNotConfigured", "badgeActive", "serviceError", "invalidResponse", "unknownKeyIndex", "credentialNotVerified"] -BadgeServiceErrorCode = Literal["bad_request", "unsupported_version", "unknown_purchase_key", "unknown_offer_id", "offer_disabled", "offer_mismatch", "product_unavailable", "payment_not_entitled", "payment_pending", "provider_unavailable", "rate_limited", "code_invalid", "code_used", "code_expired", "receipt_invalid", "receipt_used", "internal"] +BadgeServiceErrorCode = Literal["bad_request", "unsupported_version", "unknown_purchase_key", "unknown_offer_id", "offer_disabled", "offer_mismatch", "product_unavailable", "payment_not_entitled", "payment_pending", "provider_unavailable", "provider_not_configured", "rate_limited", "code_invalid", "code_used", "code_expired", "receipt_invalid", "receipt_used", "internal"] BadgeStatus = Literal["active", "expired", "expiredOld", "failed", "unknownKey"] diff --git a/plans/2026-09-24-badge-buy-in-browser.md b/plans/2026-09-24-badge-buy-in-browser.md index d0a4b9c18f..826d8766a5 100644 --- a/plans/2026-09-24-badge-buy-in-browser.md +++ b/plans/2026-09-24-badge-buy-in-browser.md @@ -80,7 +80,7 @@ Getting the URL to an app that is already running is the part that half exists. The browser lane needs nothing. The store lane needs `purchaseBadge` to accept a store receipt and verify it — Apple's JWS offline, Google's token through the Publisher API, per `docs/protocol/badges-rpc.md`. No provider adapter for either exists today. -Two properties matter more than the plumbing. It must be idempotent per signing key, since the app will retry. And an unknown or invalid token must be a plain refusal, not a retryable error — Android has no local verification, so tampered clients will send junk tokens as a matter of course, and a retryable answer would leave the worker grinding on one that can never become valid. +Two properties matter more than the plumbing. It must be idempotent per signing key, since the app will retry. And only a store's verdict about a purchase may be a plain refusal: the client consumes a purchase answered `receipt_invalid`, so a store that has merely not answered — or that does not yet know a token it has just issued — must be answered retryably, or a paid badge is thrown away. Junk tokens from tampered clients are the cheap side of that trade: each costs one request per client trigger, nothing loops on the service, and Play refunds an unacknowledged purchase after three days. `docs/protocol/badges-rpc.md` has the classes. `badges-rpc.md` also specifies `getBadgeCatalog` and `getBadgeInvoice`. Neither is needed by anything here and neither should be built: the page owns the catalog and the invoice. diff --git a/scripts/badge-service/badge_service.ini.example b/scripts/badge-service/badge_service.ini.example index 09ca430fc7..1dfaaef95c 100644 --- a/scripts/badge-service/badge_service.ini.example +++ b/scripts/badge-service/badge_service.ini.example @@ -42,5 +42,10 @@ idle_seconds = 60 index = 1 private_key = replace-me +; local testing only: signs a credential for anyone who sends /redeem over chat, +; with a master key this service generates and can therefore link [dev] -chat_redeem = on +chat_redeem = off +; local testing only, in both run modes: accepts any well-formed App Store or Play receipt without +; verifying it, so anyone who can reach this service can mint badges +accept_unverified_store_receipts = off diff --git a/simplex-chat.cabal b/simplex-chat.cabal index e759fbdd3e..4a5fa0e5a7 100644 --- a/simplex-chat.cabal +++ b/simplex-chat.cabal @@ -168,6 +168,7 @@ library Simplex.Chat.Store.Postgres.Migrations.M20260915_user_badges Simplex.Chat.Store.Postgres.Migrations.M20260918_badge_issue_errors Simplex.Chat.Store.Postgres.Migrations.M20260923_preferences_json + Simplex.Chat.Store.Postgres.Migrations.M20260925_badge_store_receipts else exposed-modules: Simplex.Chat.Archive @@ -345,6 +346,7 @@ library Simplex.Chat.Store.SQLite.Migrations.M20260915_user_badges Simplex.Chat.Store.SQLite.Migrations.M20260918_badge_issue_errors Simplex.Chat.Store.SQLite.Migrations.M20260923_preferences_json + Simplex.Chat.Store.SQLite.Migrations.M20260925_badge_store_receipts other-modules: Paths_simplex_chat hs-source-dirs: @@ -441,6 +443,8 @@ executable simplex-badge-service BadgeService.Store BadgeService.Store.Invoices BadgeService.Store.Migrate + BadgeService.StoreReceipts + BadgeService.StoreReceipts.Mock BadgeService.Waiters BadgeService.Web.Server Paths_simplex_chat @@ -729,6 +733,8 @@ test-suite simplex-chat-test BadgeService.Store BadgeService.Store.Invoices BadgeService.Store.Migrate + BadgeService.StoreReceipts + BadgeService.StoreReceipts.Mock BadgeService.Waiters BadgeService.Web.Server Bots.BadgeService.BTCPayTests @@ -736,6 +742,7 @@ test-suite simplex-chat-test Bots.BadgeService.CatalogTests Bots.BadgeService.ConfigTests Bots.BadgeService.FakeBTCPay + Bots.BadgeService.FakeStore Bots.BadgeService.FakeStripe Bots.BadgeService.StripeTests Bots.BadgeService.WaitersTests diff --git a/src/Simplex/Chat.hs b/src/Simplex/Chat.hs index 3e6fb7e229..d80184d4a0 100644 --- a/src/Simplex/Chat.hs +++ b/src/Simplex/Chat.hs @@ -72,6 +72,7 @@ defaultChatConfig = badgeServiceAddress = Just $ either error id $ strDecode "https://smp5.simplex.im/a#ooSNWlEZTO2RPE0Ff5ZoybAs5zEhWLMlQrXesnhaZHM", badgeCurrentTime = getCurrentTime, badgeRetryInterval = RetryInterval {initialInterval = 30_000000, increaseAfter = 0, maxInterval = 3600_000000}, + badgeConsecutiveRetries = 3, confirmMigrations = MCConsole, -- this property should NOT use operator = Nothing -- non-operator servers can be passed via options @@ -195,6 +196,7 @@ newChatController deliveryJobWorkers <- TM.emptyIO relayRequestWorkers <- TM.emptyIO badgeWorkers <- TM.emptyIO + storeReceiptWorkers <- TM.emptyIO badgeSeq <- newTVarIO 0 relayGroupLinkChecksAsync <- newTVarIO Nothing webPreviewState <- forM webPreviewConfig $ \_ -> newWebPreviewState @@ -243,6 +245,7 @@ newChatController deliveryJobWorkers, relayRequestWorkers, badgeWorkers, + storeReceiptWorkers, badgeSeq, relayGroupLinkChecksAsync, webPreviewState, diff --git a/src/Simplex/Chat/Badges/Ledger.hs b/src/Simplex/Chat/Badges/Ledger.hs index 2f31773d2d..870820d7c8 100644 --- a/src/Simplex/Chat/Badges/Ledger.hs +++ b/src/Simplex/Chat/Badges/Ledger.hs @@ -26,6 +26,7 @@ import Data.Time.Calendar.WeekDate (toWeekDate) import Data.Time.Clock (NominalDiffTime, UTCTime (..), addUTCTime) import Simplex.Chat.Badges (BadgeType) import Simplex.Chat.Badges.Service (StatementCreditType (..), StatementDebitType (..), StatementEntry (..), StatementEntryType (..)) +import Simplex.Chat.PaymentService.Types (InvoiceId) -- The calendar difference overshoots by at most one month, so one comparison settles it. monthsBetween :: UTCTime -> UTCTime -> Integer @@ -204,13 +205,15 @@ debitTypeTag = \case SDLapse -> "lapse" SDUnknown {tag} -> tag --- | Only the types a tag alone rebuilds, which is those whose constructor has no fields; the rest --- answer Nothing rather than a type with an invented payload. The client also stores each type's --- JSON and reads that first, so this is its fallback; the service has no such column. --- TODO [badges] take the reference columns and rebuild payment, charge, transferIn, upgrade and --- transferOut, without which the service cannot re-emit a statement carrying one. -entryTypeFromColumns :: Text -> Maybe Text -> Maybe Text -> Maybe StatementEntryType -entryTypeFromColumns entryType credit_ debit_ = case (entryType, credit_, debit_) of +-- | Rebuilds only what the columns determine: constructors with no fields, and a payment credit. +-- payment_ is Nothing when the row references no payment, and Just Nothing when that payment had no +-- invoice, as a store purchase has none. The rest answer Nothing rather than invent a payload. +-- The client stores each type's JSON and reads that first, so this is its fallback; the service has none. +-- TODO [badges] rebuild charge, transferIn, upgrade and transferOut from their reference columns, +-- without which the service cannot re-emit a statement carrying one. +entryTypeFromColumns :: Maybe (Maybe InvoiceId) -> Text -> Maybe Text -> Maybe Text -> Maybe StatementEntryType +entryTypeFromColumns payment_ entryType credit_ debit_ = case (entryType, credit_, debit_) of + ("credit", Just "payment", _) -> SECredit . SCPayment <$> payment_ ("credit", Just t, _) -> SECredit <$> creditType t ("debit", _, Just t) -> SEDebit <$> debitType t _ -> Nothing diff --git a/src/Simplex/Chat/Badges/Service.hs b/src/Simplex/Chat/Badges/Service.hs index 725009d839..80ee632c25 100644 --- a/src/Simplex/Chat/Badges/Service.hs +++ b/src/Simplex/Chat/Badges/Service.hs @@ -87,12 +87,12 @@ data BadgeServiceCommand code :: Text -- no badgeRequest: a code carries no tier for the client to state } | BSCPurchaseBadge - { badgeRequest :: BadgeRequest, + { masterKey :: BadgeMasterKey, -- no badgeRequest: the tier is the product's, the expiry the one every credential of that week shares payment :: ServicePayment, upgrade :: Maybe BadgeUpgrade -- upgrade store 1-time badge } | BSCUpgradeBadgeSubscription - { badgeRequest :: BadgeRequest, + { badgeRequest :: BadgeRequest, -- TODO [badges] drop when implemented: a client-stated expiry leaves the week's anonymity set payment :: ServicePayment, -- store payments only balance :: BadgeBalance } diff --git a/src/Simplex/Chat/Badges/Types.hs b/src/Simplex/Chat/Badges/Types.hs index 1038b2b64f..376869f584 100644 --- a/src/Simplex/Chat/Badges/Types.hs +++ b/src/Simplex/Chat/Badges/Types.hs @@ -30,6 +30,7 @@ module Simplex.Chat.Badges.Types BadgeAlert (..), BadgeAlertPrice (..), BadgeState (..), + OpenStorePurchase (..), ) where import Control.Applicative ((<|>)) @@ -43,7 +44,7 @@ import Data.Text.Encoding (decodeLatin1, encodeUtf8) import Data.Time.Clock (UTCTime) import Data.Word (Word8) import Simplex.Chat.Badges hiding (BadgePurchase (..)) -import Simplex.Chat.PaymentService.Types (InvoiceId, PaymentId, StoredPayment) +import Simplex.Chat.PaymentService.Types (InvoiceId, PaymentId) import Simplex.Chat.Types (BoolDef (..)) import Simplex.Messaging.Agent.Protocol (UserId) import Simplex.Messaging.Agent.Store.DB (fromTextField_) @@ -236,6 +237,7 @@ data BadgeServiceErrorCode | BSEPaymentNotEntitled | BSEPaymentPending | BSEProviderUnavailable + | BSEProviderNotConfigured -- no verifier deployed: a dev service, not the store failing to answer | BSERateLimited | BSECodeInvalid | BSECodeUsed @@ -281,6 +283,17 @@ data BadgeState = BadgeState } deriving (Show) +-- | One of a profile's store purchases that no receipt has reached yet, or whose receipt is held until +-- the service credits it; transactionRef is set once a receipt arrived. Neither reference is a secret: +-- Apple's is the transaction id, Google's is a hash of the token. creditError is set only while the +-- held receipt's last attempt failed in a way that cannot clear on its own. +data OpenStorePurchase = OpenStorePurchase + { invoiceId :: Maybe Text, + transactionRef :: Maybe Text, + creditError :: Maybe BadgeIssueFailure + } + deriving (Show) + instance TextEncoding BadgePurchaseStatus where textEncode = \case PSAcquiring -> "acquiring" @@ -325,6 +338,7 @@ instance TextEncoding BadgeServiceErrorCode where BSEPaymentNotEntitled -> "payment_not_entitled" BSEPaymentPending -> "payment_pending" BSEProviderUnavailable -> "provider_unavailable" + BSEProviderNotConfigured -> "provider_not_configured" BSERateLimited -> "rate_limited" BSECodeInvalid -> "code_invalid" BSECodeUsed -> "code_used" @@ -344,6 +358,7 @@ instance TextEncoding BadgeServiceErrorCode where "payment_not_entitled" -> BSEPaymentNotEntitled "payment_pending" -> BSEPaymentPending "provider_unavailable" -> BSEProviderUnavailable + "provider_not_configured" -> BSEProviderNotConfigured "rate_limited" -> BSERateLimited "code_invalid" -> BSECodeInvalid "code_used" -> BSECodeUsed @@ -410,3 +425,5 @@ $(JQ.deriveJSON (sumTypeJSON $ dropPrefix "BIF") ''BadgeIssueFailure) $(JQ.deriveJSON defaultJSON ''BadgeIssueError) $(JQ.deriveJSON defaultJSON ''BadgeState) + +$(JQ.deriveJSON defaultJSON ''OpenStorePurchase) diff --git a/src/Simplex/Chat/Controller.hs b/src/Simplex/Chat/Controller.hs index 9cc80fc54b..2719c588d8 100644 --- a/src/Simplex/Chat/Controller.hs +++ b/src/Simplex/Chat/Controller.hs @@ -85,7 +85,8 @@ import Simplex.Messaging.Client (HostMode (..), SMPProxyFallback (..), SMPProxyM import qualified Simplex.Messaging.Crypto as C import Simplex.Chat.Badges (BadgeCredential, FileSizeLimits, LocalBadge) import Simplex.Chat.Badges.Service (BadgeServiceErrorCode, StatementEntry) -import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind, BadgeState (..)) +import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind, BadgeState (..), OpenStorePurchase (..)) +import Simplex.Chat.PaymentService (ServicePayment) import Simplex.Messaging.Crypto.BBS (BBSPublicKey) import Simplex.Messaging.Crypto.File (CryptoFile (..)) import qualified Simplex.Messaging.Crypto.File as CF @@ -152,6 +153,8 @@ data ChatConfig = ChatConfig badgeCurrentTime :: IO UTCTime, -- how long a badge worker waits before repeating a renewal that failed for a passing reason badgeRetryInterval :: RetryInterval, + -- attempts a store receipt gets in one turn before its next one waits for the stored schedule + badgeConsecutiveRetries :: Int, confirmMigrations :: MigrationConfirmation, presetServers :: PresetServers, shortLinkPresetServers :: NonEmpty SMPServer, @@ -327,6 +330,7 @@ data ChatController = ChatController relayRequestWorkers :: TMap Int Worker, -- single global worker with key 1 is used to fit into existing worker management framework -- one badge worker per user: badge state is per profile, and one profile must not stall another badgeWorkers :: TMap UserId (SessionVar BadgeWorker), + storeReceiptWorkers :: TMap UserId Worker, badgeSeq :: TVar Int, relayGroupLinkChecksAsync :: TVar (Maybe (Async ())), webPreviewState :: Maybe WebPreviewState, @@ -659,6 +663,8 @@ data ChatCommand | UpdateProfileImageFromFile FilePath -- set profile image from a .png/.jpg/.jpeg file | AddBadge BadgeCredential -- attach an issued badge credential (testing; credential from `simplex-chat badge sign`) | APIRedeemBadgeCode {userId :: UserId, code :: Text} -- redeem a badge code with the configured badge service + | APIPurchaseBadge {userId :: UserId, echoedInvoiceId :: Maybe Text, payment :: ServicePayment} -- hand over an App Store or Google Play receipt, held until a worker credits it; answers from the record and sends nothing + | APICreateBadgeInvoice {userId :: UserId} -- the record of a store purchase, created before the store charges; answers the id the store echoes | APIGetBadgeState {userId :: UserId} -- the user's badges, their balances and any current alert | APIGetBadgeLedger {userId :: UserId, badgePurchaseId :: Int64} -- the purchase's ledger, oldest first -- episode is last because it is free text: it is the value that makes one occurrence of an @@ -869,7 +875,8 @@ data ChatResponse | CRServiceResponse {user :: User, responseData :: J.Object} | CRServiceReplyAccepted {user :: User, connectionId :: AgentConnId} | CRBadgeRedeemed {user :: User, redeemedBadge :: LocalBadge, newBadge :: Bool, badgeState :: Maybe BadgeState} - | CRBadgeState {user :: User, badgeState :: Maybe BadgeState} + | CRBadgeInvoice {user :: User, invoiceId :: Text} + | CRBadgeState {user :: User, badgeState :: Maybe BadgeState, storePurchases :: [OpenStorePurchase]} | CRBadgeLedger {user :: User, badgeLedger :: [StatementEntry]} | CRUserAcceptedGroupSent {user :: User, groupInfo :: GroupInfo, hostContact :: Maybe Contact} | CRUserDeletedMembers {user :: User, groupInfo :: GroupInfo, members :: [GroupMember], withMessages :: Bool, msgSigned :: Bool} @@ -990,6 +997,7 @@ data ChatEvent | CEvtServiceReplySent {connectionId :: AgentConnId} | CEvtBadgeChanged {user :: User, badgeState :: Maybe BadgeState} -- badge state changed, including a renewal that arrived without a command | CEvtBadgeAlert {user :: User, badgeAlert :: BadgeAlert} + | CEvtStorePurchaseResolved {user :: User} -- a held store receipt was credited or refused, so its store transaction can be finished | CEvtContactRequestRejected {user :: User, contact :: Contact, rejectionReason :: Maybe ContactRejectionReason} | CEvtAcceptingContactRequest {user :: User, contact :: Contact} -- there is the same command response | CEvtAcceptingBusinessRequest {user :: User, groupInfo :: GroupInfo} @@ -1479,8 +1487,10 @@ data SimplexDomainError | SDEUnknownDomain -- the resolved link's profile has no name, or a different name deriving (Eq, Show) +-- | Why acquiring a badge failed, for a code and for a store purchase alike. data BadgeRedeemError = BREInvalidCode -- format or check character + | BREInvalidReceipt -- names no transaction, or is not a store payment | BREServiceNotConfigured | BREBadgeActive | BREServiceError {serviceError :: BadgeServiceErrorCode} diff --git a/src/Simplex/Chat/Library/Commands.hs b/src/Simplex/Chat/Library/Commands.hs index d02a189b1d..043b06d829 100644 --- a/src/Simplex/Chat/Library/Commands.hs +++ b/src/Simplex/Chat/Library/Commands.hs @@ -61,7 +61,7 @@ import Crypto.Random (ChaChaDRG) import Simplex.Messaging.Session (SessionVar (..), withGetSessVar') import Simplex.Chat.Badges (BadgeCredential (..), BadgeInfo (..), BadgeMasterKey, BadgeType, LocalBadge (..), badgeServerCredential, mkBadgeStatus, maxSndXFTPFileSize, verifyCredential) import qualified Simplex.Chat.Badges.Ledger as L -import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind (..), BadgeIssueError (..), BadgeIssueFailure (..), BadgeState (..)) +import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind (..), BadgeIssueError (..), BadgeIssueFailure (..), BadgeState (..), OpenStorePurchase (..)) import Simplex.Chat.Badges.Code (badgeCodeText, parseBadgeCode) import Simplex.Chat.Badges.Service (BadgeBalance (..), BadgeServiceCommand (..), BadgeServiceErrorCode (..), BadgeServiceRequest (..), BadgeServiceResponse (..), BadgeStatement (..), StatementDebitType (..), StatementEntry (..), StatementEntryType (..), currentBadgeServiceVersion) import Simplex.Chat.Names (SimplexDomainProof (..), SimplexDomainClaim (..), claimDomain, mkDomainClaim) @@ -76,6 +76,8 @@ import Simplex.Chat.Messages.CIContent import Simplex.Chat.Messages.CIContent.Events import Simplex.Chat.Operators import Simplex.Chat.Options +import Simplex.Chat.PaymentService (ServicePayment (..), appleTransactionId, googlePurchaseRef) +import Simplex.Chat.PaymentService.Types (PaymentProvider (..), StoreTransactionRef (..)) import Simplex.Chat.ProfileGenerator (generateRandomProfile) import Simplex.Chat.Protocol import Simplex.Chat.Remote @@ -103,9 +105,10 @@ import qualified Simplex.Chat.Util as U import Simplex.Chat.Web (webPreviewWorker) import Simplex.FileTransfer.Description (FileDescriptionURI (..), maxFileSizeHard) import Simplex.Messaging.Agent -import Simplex.Messaging.Agent.Env.SQLite (ServerCfg (..), ServerRoles (..), allRoles) +import Simplex.Messaging.Agent.Client (getAgentWorker, waitForUserNetwork, waitForWork, waitWhileSuspended, withWork_) +import Simplex.Messaging.Agent.Env.SQLite (ServerCfg (..), ServerRoles (..), Worker (..), allRoles) import Simplex.Messaging.Agent.Protocol -import Simplex.Messaging.Agent.RetryInterval (RetryInterval (..), withRetryInterval) +import Simplex.Messaging.Agent.RetryInterval (RetryInterval (..), nextRetryDelay, withRetryInterval, withRetryIntervalCount) import Simplex.Messaging.Agent.Store.Entity import Simplex.Messaging.Agent.Store.Interface (execSQL) import Simplex.Messaging.Agent.Store.Shared (upMigration) @@ -261,6 +264,7 @@ startChatController mainApp enableSndFiles serviceRequests = do startRelayRequestWorker_ startCleanupManager mapM_ startBadgeWork users + startStoreReceiptWorkers users void $ forkIO $ mapM_ startExpireCIs users startRelayChecks users startWebPreview users @@ -279,6 +283,10 @@ startChatController mainApp enableSndFiles serviceRequests = do runExceptT startRelayRequestWorker >>= \case Left e -> liftIO $ putStrLn $ "Error starting relay request worker: " <> show e Right _ -> pure () + startStoreReceiptWorkers users = + runExceptT (mapM_ startStoreReceiptWork users) >>= \case + Left e -> liftIO $ putStrLn $ "Error starting store receipt workers: " <> show e + Right _ -> pure () startCleanupManager = do cleanupAsync <- asks cleanupManagerAsync readTVarIO cleanupAsync >>= \case @@ -357,7 +365,7 @@ restoreCalls = do atomically $ writeTVar calls callsMap stopChatController :: ChatController -> IO () -stopChatController ChatController {smpAgent, agentAsync = s, sndFiles, rcvFiles, expireCIFlags, remoteHostSessions, remoteCtrlSession, cleanupManagerAsync, relayGroupLinkChecksAsync, webPreviewState, expireCIThreads, timedItemThreads, deliveryTaskWorkers, deliveryJobWorkers, relayRequestWorkers, badgeWorkers} = do +stopChatController ChatController {smpAgent, agentAsync = s, sndFiles, rcvFiles, expireCIFlags, remoteHostSessions, remoteCtrlSession, cleanupManagerAsync, relayGroupLinkChecksAsync, webPreviewState, expireCIThreads, timedItemThreads, deliveryTaskWorkers, deliveryJobWorkers, relayRequestWorkers, badgeWorkers, storeReceiptWorkers} = do readTVarIO remoteHostSessions >>= mapM_ (cancelRemoteHost False . snd) atomically (stateTVar remoteCtrlSession (,Nothing)) >>= mapM_ (cancelRemoteCtrl False . snd) disconnectAgentClient smpAgent @@ -371,6 +379,7 @@ stopChatController ChatController {smpAgent, agentAsync = s, sndFiles, rcvFiles, clearMap deliveryJobWorkers >>= mapM_ cancelWorker clearMap relayRequestWorkers >>= mapM_ cancelWorker stopBadgeWorkers badgeWorkers + clearMap storeReceiptWorkers >>= mapM_ cancelWorker closeFiles sndFiles closeFiles rcvFiles atomically $ do @@ -603,6 +612,7 @@ processChatCommand cxt nm = \case void . forkIO $ startFilesToReceive users setAllExpireCIFlags True mapM_ startBadgeWork users + mapM_ startStoreReceiptWork users ok_ APISuspendChat t -> do chatWriteVar chatActivated False @@ -3562,10 +3572,19 @@ processChatCommand cxt nm = \case ShowProfile -> withUser $ \user@User {profile} -> pure $ CRUserProfile user (fromLocalProfile profile) AddBadge cred -> withUser $ \user -> addUserBadge user cred >> ok user APIRedeemBadgeCode userId codeText -> withUserId userId $ \user -> redeemBadgeCode nm user codeText + APIPurchaseBadge userId echoedInvoiceId payment -> withUserId userId $ \user -> handOverStoreReceipt user echoedInvoiceId payment + APICreateBadgeInvoice userId -> withUserId userId $ \user -> do + void requireBadgeService + refuseWhileBadgeHeld user + g <- asks random + now <- badgeNow + invoiceId <- UUID.toText <$> liftIO V4.nextRandom + withStore' $ \db -> createBadgeStoreReceipt db g user invoiceId now + pure $ CRBadgeInvoice user invoiceId APIGetBadgeState userId -> withUserId' userId $ \user -> do -- the read also signals the worker, whose results follow as CEvtBadgeChanged lift $ startBadgeWork user - CRBadgeState user <$> getUserBadgeState user + badgeStateResponse user APIGetBadgeLedger userId badgePurchaseId -> withUserId userId $ \user -> CRBadgeLedger user <$> withStore' (\db -> getBadgeLedger db user badgePurchaseId) APIAckBadgeAlert userId badgePurchaseId alertKind snooze episode -> withUserId userId $ \user -> do @@ -3574,7 +3593,7 @@ processChatCommand cxt nm = \case withStore' $ \db -> setBadgeAlertAcked db user badgePurchaseId alertKind episode snoozeUntil -- after the write, so the pass it signals arms a wake for the snooze rather than raising again lift $ startBadgeWork user - CRBadgeState user <$> getUserBadgeState user + badgeStateResponse user SetBotCommands commands -> withUser $ \user@User {profile} -> do let LocalProfile {preferences} = profile prefs = Just (fromMaybe emptyChatPrefs preferences :: Preferences) {commands = Just commands} @@ -5219,30 +5238,20 @@ presentUserBadgeToContacts user'@User {userId, profile = LocalProfile {localBadg redeemBadgeCode :: NetworkRequestMode -> User -> Text -> CM ChatResponse redeemBadgeCode nm user@User {userId} codeText = do code <- maybe (throwRedeemError BREInvalidCode) pure $ parseBadgeCode codeText - sendTarget <- asks (badgeServiceAddress . config) >>= maybe (throwRedeemError BREServiceNotConfigured) pure + sendTarget <- requireBadgeService g <- asks random now <- liftIO getCurrentTime let codeSent = badgeCodeText code -- the guard, the request and the write are one section: without it two codes redeemed at once -- both pass the guard and are both spent, for one badge (present_, redeemed) <- withEntityLock "badgeRedeem" (CLBadgeUser userId) $ do - redemption_ <- withStore' $ \db -> getBadgeCodeRedemption db user codeSent - -- a code already redeemed here is allowed through: re-sending it returns the badge it bought - -- and adds nothing. Refused before its keys are stashed and before the request, so it stays unspent - replaying <- maybe (pure False) (\r -> withStore' $ \db -> isJust <$> getCodeBadgePurchase db r) redemption_ - unless replaying $ whenM (withStore' (`userHasBadge` user)) $ throwRedeemError BREBadgeActive - redemption@BadgeCodeRedemption {purchaseKey, purchasePrivKey, masterKey} <- - maybe (withStore' $ \db -> createBadgeCodeRedemption db g user codeSent now) pure redemption_ - let req = BadgeServiceRequest {version = currentBadgeServiceVersion, purchaseKey = Just purchaseKey, request = BSCRedeemBadgeCode {masterKey, code = codeSent}} - respBytes <- sendServiceRequestBytes nm user sendTarget Nothing (Just purchasePrivKey) req - respData <- either (const $ throwRedeemError $ BREInvalidResponse "not JSON") pure $ J.eitherDecodeStrict' respBytes - case J.fromJSON (J.Object respData) of - J.Error _ -> throwRedeemError $ BREInvalidResponse "not a badge service response" - J.Success BSPError {code = errCode} -> do - when (terminalCodeError errCode) $ withStore' $ \db -> deleteBadgeCodeRedemption db (redemptionId redemption) + stash_ <- withStore' $ \db -> getBadgeCodeRedemption db user codeSent + stash@BadgeStash {masterKey} <- stashBadgeKeys user stash_ $ \db -> createBadgeCodeRedemption db g user codeSent now + requestBadgeStash nm user sendTarget stash BSCRedeemBadgeCode {masterKey, code = codeSent} >>= \case + Left (errCode, _) -> do + when (terminalCodeError errCode) $ withStore' $ \db -> deleteBadgeCodeRedemption db user codeSent throwRedeemError $ BREServiceError errCode - J.Success BSPBadgeCredential {credential = Just cred, statement} -> storeRedeemedBadge user redemption cred statement - J.Success _ -> throwRedeemError $ BREInvalidResponse "unexpected response type" + Right redeemed -> pure redeemed -- outside the badge lock: the chat lock must not be taken under it mapM_ presentUserBadgeToContacts present_ pure redeemed @@ -5254,6 +5263,69 @@ redeemBadgeCode nm user@User {userId} codeText = do BSECodeExpired -> True _ -> False +-- | The app hands a receipt over until it is answered credited or refused, under whichever profile is +-- active; the answer is the owner's, read from the record. Nothing is sent: the owner's receipt worker is. +handOverStoreReceipt :: User -> Maybe Text -> ServicePayment -> CM ChatResponse +handOverStoreReceipt presentingUser echoedInvoiceId payment = do + txRef <- maybe (throwRedeemError BREInvalidReceipt) pure $ storeTransactionRef payment + void requireBadgeService + g <- asks random + now <- badgeNow + BadgeReceiptRecord {ownerId, status} <- + withStore' (\db -> holdStoreReceipt db g presentingUser echoedInvoiceId txRef payment now) + >>= maybe (throwChatError $ CEInternalError "store receipt was not recorded") pure + owner <- withStore $ \db -> getUser db ownerId + case status of + RSHeld {} -> lift (resumeStoreReceiptWork ownerId) >> badgeStateResponse owner + RSCredited {badgePurchaseId} -> do + cred_ <- withStore' (`getLatestIssuedCredential` badgePurchaseId) + cred@(BadgeCredential _ _ _ info) <- maybe (throwChatError $ CEInternalError "credited store purchase has no credential") pure cred_ + CRBadgeRedeemed owner (OwnBadge cred (mkBadgeStatus now (Just True) info)) False <$> getUserBadgeState owner + RSRefused {refusal = Just BIFServiceError {code}} -> throwRedeemError $ BREServiceError code + RSRefused {} -> throwChatError $ CEInternalError "store purchase refused for no recorded reason" + +-- | The receipt will never be credited to its key; any other refusal may pass on a retry. +storeReceiptRefused :: BadgeServiceErrorCode -> Bool +storeReceiptRefused = \case + BSEReceiptInvalid -> True + BSEReceiptUsed -> True + _ -> False + +-- | The same reference the service claims a transaction by, read without verifying anything. +storeTransactionRef :: ServicePayment -> Maybe StoreTransactionRef +storeTransactionRef = \case + SPApple {jws} -> StoreTransactionRef PPApple <$> appleTransactionId jws + SPGoogle {token} -> Just $ StoreTransactionRef PPGoogle $ googlePurchaseRef token + SPInvoice {} -> Nothing + SPReceipt {} -> Nothing + +-- | A stash that already bought a badge here passes, as re-sending it adds nothing; any other is +-- refused while a badge is held, before its keys are stashed or sent, so the funding stays unspent. +stashBadgeKeys :: User -> Maybe BadgeStash -> (DB.Connection -> IO BadgeStash) -> CM BadgeStash +stashBadgeKeys user stash_ createStash = do + replaying <- maybe (pure False) (\s -> withStore' $ \db -> isJust <$> getStashBadgePurchase db s) stash_ + unless replaying $ refuseWhileBadgeHeld user + maybe (withStore' createStash) pure stash_ + +requireBadgeService :: CM (ConnectTarget 'CMContact) +requireBadgeService = asks (badgeServiceAddress . config) >>= maybe (throwRedeemError BREServiceNotConfigured) pure + +refuseWhileBadgeHeld :: User -> CM () +refuseWhileBadgeHeld user = whenM (withStore' (`userHasBadge` user)) $ throwRedeemError BREBadgeActive + +-- | One attempt to turn a stash into a badge. A refusal is answered rather than thrown, with the +-- service's retryAfter. +requestBadgeStash :: NetworkRequestMode -> User -> ConnectTarget 'CMContact -> BadgeStash -> BadgeServiceCommand -> CM (Either (BadgeServiceErrorCode, Maybe Word32) (Maybe User, ChatResponse)) +requestBadgeStash nm user sendTarget stash@BadgeStash {purchaseKey, purchasePrivKey} request = do + let req = BadgeServiceRequest {version = currentBadgeServiceVersion, purchaseKey = Just purchaseKey, request} + respBytes <- sendServiceRequestBytes nm user sendTarget Nothing (Just purchasePrivKey) req + respData <- either (const $ throwRedeemError $ BREInvalidResponse "not JSON") pure $ J.eitherDecodeStrict' respBytes + case J.fromJSON (J.Object respData) of + J.Error _ -> throwRedeemError $ BREInvalidResponse "not a badge service response" + J.Success BSPError {code, retryAfter} -> pure $ Left (code, retryAfter) + J.Success BSPBadgeCredential {credential = Just cred, statement} -> Right <$> storeRedeemedBadge user stash cred statement + J.Success _ -> throwRedeemError $ BREInvalidResponse "unexpected response type" + throwRedeemError :: BadgeRedeemError -> CM a throwRedeemError = throwChatError . CEBadgeRedeemError @@ -5362,6 +5434,89 @@ waitBadgeWake badgeWork now = \case badgeMaxWake :: NominalDiffTime badgeMaxWake = 100 * 365 * nominalDay +startStoreReceiptWork :: User -> CM () +startStoreReceiptWork User {userId} = do + held <- withStore' $ \db -> getNextHeldStoreReceipt db userId + when (either (const False) isJust held) $ lift $ resumeStoreReceiptWork userId + +resumeStoreReceiptWork :: UserId -> CM' () +resumeStoreReceiptWork userId = do + ws <- asks storeReceiptWorkers + a <- asks smpAgent + void $ getAgentWorker "store_receipt" True a userId ws $ runStoreReceiptWorker a userId + +runStoreReceiptWorker :: AgentClient -> UserId -> Worker -> CM () +runStoreReceiptWorker a userId Worker {doWork} = do + scheduled <- newTVarIO S.empty + forever $ do + lift $ waitForWork doWork + withWork_ a doWork (getDueReceipt scheduled) $ \case + BadgeReceiptRecord {receiptId, status = RSHeld {stash, payment, retryDelay}} -> creditStoreReceipt a userId receiptId stash payment retryDelay + BadgeReceiptRecord {receiptId} -> notHeld receiptId + where + getDueReceipt scheduled = + withStore' (`getNextHeldStoreReceipt` userId) >>= \case + Right (Just r@BadgeReceiptRecord {receiptId, status = RSHeld {nextAttemptAt}}) -> do + now <- badgeNow + if nextAttemptAt <= now + then pure $ Right (Just r) + else Right Nothing <$ scheduleReceipt scheduled receiptId (diffUTCTime nextAttemptAt now) + Right (Just BadgeReceiptRecord {receiptId}) -> Right Nothing <$ notHeld receiptId + r -> pure r + -- getNextHeldStoreReceipt reads held rows only, so this says its query and its result type disagree + notHeld receiptId = eToView $ ChatError $ CEInternalError $ "store receipt " <> show receiptId <> " is not held" + scheduleReceipt scheduled receiptId delay = do + new <- atomically $ stateTVar scheduled $ \ids -> (S.notMember receiptId ids, S.insert receiptId ids) + when new . void . liftIO . forkIO $ do + threadDelay' $ diffToMicroseconds delay + atomically $ modifyTVar' scheduled $ S.delete receiptId + void $ atomically $ tryPutTMVar doWork () + +data StoreReceiptOutcome = SROCredited (Maybe User) | SRORefused | SRORetry | SRODeferred + +-- | Under the owner's badge lock, which keeps a profile's requests to the service serial. +creditStoreReceipt :: AgentClient -> UserId -> Int64 -> BadgeStash -> Text -> Maybe Int64 -> CM () +creditStoreReceipt a userId receiptId stash@BadgeStash {masterKey} payment retryDelay = do + ChatConfig {badgeRetryInterval = ri, badgeConsecutiveRetries} <- asks config + withRetryIntervalCount (maybe ri (\d -> ri {initialInterval = d, increaseAfter = 0}) retryDelay) $ \n delay loop -> do + liftIO $ waitWhileSuspended a + liftIO $ waitForUserNetwork a + outcome <- withEntityLock "badgePurchase" (CLBadgeUser userId) $ + tryAllErrors attempt >>= \case + Right (Right (present_, _)) -> pure $ SROCredited present_ + Right (Left (code, retryAfter)) + | storeReceiptRefused code -> SRORefused <$ withStore' (\db -> refuseStoreReceipt db receiptId $ serviceFailure code retryAfter) + | otherwise -> failed ri delay (serviceFailure code retryAfter) retryAfter + Left e -> failed ri delay (badgeIssueFailure e) Nothing + -- only a settlement is announced, and the sweep it prompts signals this worker only for a receipt still held, so it cannot loop + case outcome of + SROCredited present_ -> do + user <- withStore $ \db -> getUser db userId + toView . CEvtBadgeChanged user =<< getUserBadgeState user + toView $ CEvtStorePurchaseResolved user + -- last, so a failed broadcast cannot lose the settlement; outside the badge lock, as it takes the chat lock + mapM_ presentUserBadgeToContacts present_ + SRORefused -> withStore (`getUser` userId) >>= toView . CEvtStorePurchaseResolved + SRORetry | n + 1 < badgeConsecutiveRetries -> loop + _ -> pure () + where + attempt = do + user <- withStore $ \db -> getUser db userId + refuseWhileBadgeHeld user + sendTarget <- requireBadgeService + payment' <- maybe (throwChatError $ CEInternalError "held store payment does not decode") pure $ decodeJSON payment + requestBadgeStash NRMBackground user sendTarget stash BSCPurchaseBadge {masterKey, payment = payment', upgrade = Nothing} + serviceFailure code retryAfter = BIFServiceError {code = boundedServiceErrorCode code, retryable = isJust retryAfter} + failed ri delay failure retryAfter = do + now <- badgeNow + let (retryIn, outcome) + | isJust retryAfter = (badgeRetryAfter ri retryAfter, SRODeferred) + -- a buyer is waiting, so unlike a renewal a failure that can clear on its own never waits the day + | badgeFailureTransient failure = (fromIntegral delay / 1000000, SRORetry) + | otherwise = (badgeStalledInterval, SRODeferred) + withStore' $ \db -> recordStoreReceiptFailure db receiptId (nextRetryDelay 0 delay ri) (retryIn `addUTCTime` now) failure + pure outcome + -- | Retire what has ended, renew what is due, then report the next wake. Waking early, late or not -- at all changes only timing: each run reads stored state and works out what to do. updateUserBadge :: UserId -> TVar (Maybe BadgeOccurrence) -> UTCTime -> CM (Maybe UTCTime) @@ -5439,6 +5594,15 @@ emitBadgeAlert user emitted p@UserBadgePurchase {alertSnoozeUntil} shownCred now raised <- atomically $ stateTVar emitted (,occurrence) when (raised /= occurrence) $ toView $ CEvtBadgeAlert user alert +-- | Scoped to one profile, so another profile's store purchase, which may be hidden, never shows under it. +badgeStateResponse :: User -> CM ChatResponse +badgeStateResponse user = do + badgeState <- getUserBadgeState user + CRBadgeState user badgeState . map finalError <$> withStore' (`getOpenStorePurchases` user) + where + -- like a renewal's, only a failure that cannot clear on its own is the user's to know about + finalError p@OpenStorePurchase {creditError} = p {creditError = find (not . badgeFailureTransient) creditError} + -- | Read from stored rows alone; the worker's results follow as CEvtBadgeChanged. getUserBadgeState :: User -> CM (Maybe BadgeState) getUserBadgeState user = do @@ -5472,9 +5636,10 @@ badgeStalledInterval = nominalDay -- | The wait after a service refusal, floored at initialInterval so answering 0 cannot spin the -- worker, and uncapped above it. badgeRetryAfter :: RetryInterval -> Maybe Word32 -> NominalDiffTime -badgeRetryAfter RetryInterval {initialInterval} = maybe badgeStalledInterval (max floorWait . fromIntegral) - where - floorWait = fromIntegral initialInterval / 1000000 +badgeRetryAfter ri = maybe badgeStalledInterval (max (retryFloor ri) . fromIntegral) + +retryFloor :: RetryInterval -> NominalDiffTime +retryFloor RetryInterval {initialInterval} = fromIntegral initialInterval / 1000000 -- | How far ahead of the shown credential's expiry the renewal is requested - a day, so a failure -- has that long to retry. The wake and the due check both derive from it and have to agree. @@ -5531,6 +5696,8 @@ badgeIssueFailure e = case e of | otherwise -> BIFUnexpected {message = tshow agentError} ChatError (CECommandError m) -> BIFUnexpected {message = T.pack m} ChatError (CEInternalError m) -> BIFUnexpected {message = T.pack m} + ChatError (CEBadgeRedeemError BREUnknownKeyIndex) -> BIFInvalidCredential + ChatError (CEBadgeRedeemError BRECredentialNotVerified) -> BIFInvalidCredential _ -> BIFUnexpected {message = tshow e} -- | Whether a failure can clear on its own, which decides whether the alert waits for the shown @@ -5654,8 +5821,8 @@ stopBadgeWorkers workers = -- | Verify the credential before writing anything; the purchase, the statement's rows, the -- issuance and the profile's badge go in one transaction. Answers the user to tell contacts about, -- which the caller does once the badge lock is released. -storeRedeemedBadge :: User -> BadgeCodeRedemption -> BadgeCredential -> BadgeStatement -> CM (Maybe User, ChatResponse) -storeRedeemedBadge user@User {userId} redemption@BadgeCodeRedemption {masterKey} cred@(BadgeCredential _ credMasterKey _ info@BadgeInfo {badgeType}) statement = +storeRedeemedBadge :: User -> BadgeStash -> BadgeCredential -> BadgeStatement -> CM (Maybe User, ChatResponse) +storeRedeemedBadge user@User {userId} stash@BadgeStash {masterKey} cred@(BadgeCredential _ credMasterKey _ info@BadgeInfo {badgeType}) statement = verifyOwnBadge cred >>= \case Nothing -> throwRedeemError BREUnknownKeyIndex Just False -> throwRedeemError BRECredentialNotVerified @@ -5668,7 +5835,7 @@ storeRedeemedBadge user@User {userId} redemption@BadgeCodeRedemption {masterKey} let badge = OwnBadge cred (mkBadgeStatus now (Just True) info) -- TODO [badges] retire a previously held badge (user', newBadge, applied) <- withStore $ \db -> do - (purchaseId, newBadge) <- liftIO $ createCodeBadgePurchase db user redemption cred now + (purchaseId, newBadge) <- liftIO $ createStashBadgePurchase db user stash cred now applied <- liftIO $ applyBadgeStatement db g purchaseId badgeType statement (Just cred) now -- a replay must not put a superseded badge back, or tell every contact again user' <- if newBadge then setUserBadge db user (Just badge) else getUser db userId @@ -5818,6 +5985,7 @@ cleanupManager = do cleanupDeliveryJobs `catchAllErrors` eToView -- TODO possibly, also cleanup async commands cleanupProbes `catchAllErrors` eToView + cleanupStoreReceipts `catchAllErrors` eToView liftIO $ threadDelay' $ diffToMicroseconds interval where runWithoutInitialDelay cleanupInterval = flip catchAllErrors eToView $ do @@ -5887,6 +6055,11 @@ cleanupManager = do ts <- liftIO getCurrentTime let cutoffTs = addUTCTime (-(14 * nominalDay)) ts withStore' (`deleteOldProbes` cutoffTs) + -- the badge clock, which the records are written with + cleanupStoreReceipts = do + ts <- badgeNow + let cutoffTs = addUTCTime (-(30 * nominalDay)) ts + withStore' (`deleteUnfundedStoreReceipts` cutoffTs) deleteInProgressGroup :: User -> GroupInfo -> CM () deleteInProgressGroup user gInfo = do @@ -6109,6 +6282,8 @@ chatCommandP = "/_reject " *> (APIRejectContact <$> A.decimal <*> (" notify=" *> onOffP <|> pure False)), "/_service_request " *> (APISendServiceRequest <$> A.decimal <* A.space <*> strP <*> optional (" timeout=" *> (realToFrac <$> A.double)) <*> optional (" sign_key=" *> strP) <* A.space <*> jsonP), "/_redeem_badge_code " *> (APIRedeemBadgeCode <$> A.decimal <* A.space <*> textP), + "/_badge purchase " *> (APIPurchaseBadge <$> A.decimal <*> optional (" invoice=" *> (safeDecodeUtf8 <$> A.takeTill (== ' '))) <* A.space <*> jsonP), + "/_badge invoice " *> (APICreateBadgeInvoice <$> A.decimal), "/_badge state " *> (APIGetBadgeState <$> A.decimal), "/_badge ledger " *> (APIGetBadgeLedger <$> A.decimal <* A.space <*> A.decimal), "/_badge ack " *> (APIAckBadgeAlert <$> A.decimal <* A.space <*> A.decimal <* A.space <*> badgeAlertKindP <* A.space <*> onOffP <* A.space <*> textP), diff --git a/src/Simplex/Chat/PaymentService.hs b/src/Simplex/Chat/PaymentService.hs index 38f94b2118..91b7a9fde1 100644 --- a/src/Simplex/Chat/PaymentService.hs +++ b/src/Simplex/Chat/PaymentService.hs @@ -1,17 +1,28 @@ {-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TemplateHaskell #-} module Simplex.Chat.PaymentService ( ServiceInvoice (..), ServicePayment (..), + appleTransactionId, + googlePurchaseRef, module Simplex.Chat.PaymentService.Types, ) where +import qualified Data.Aeson as J +import qualified Data.Aeson.KeyMap as JM import qualified Data.Aeson.TH as JQ +import qualified Data.ByteString.Base64.URL as B64U import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) import Data.Time.Clock (UTCTime) import Simplex.Chat.PaymentService.Types +import qualified Simplex.Messaging.Crypto as C +import Simplex.Messaging.Encoding.String (strEncode) import Simplex.Messaging.Parsers (defaultJSON, dropPrefix, taggedObjectJSON) +import Simplex.Messaging.Util (eitherToMaybe, safeDecodeUtf8) data ServiceInvoice = ServiceInvoice { invoiceId :: InvoiceId, @@ -27,11 +38,24 @@ data ServiceInvoice = ServiceInvoice data ServicePayment = SPApple {jws :: Text} - | SPGoogle {token :: Text} + | SPGoogle {productId :: Text, token :: Text} -- the Publisher API finds a purchase by product and token | SPInvoice {invoiceId :: InvoiceId} | SPReceipt {receipt :: Text} -- transfer of unissued months deriving (Show) +-- | Read without verifying the signature: it names the transaction, and proves nothing about it. +appleTransactionId :: Text -> Maybe Text +appleTransactionId signed = case T.splitOn "." signed of + [_, payload, _] -> do + J.Object o <- J.decodeStrict' =<< eitherToMaybe (B64U.decodeUnpadded $ encodeUtf8 payload) + J.String txId <- JM.lookup "transactionId" o + pure txId + _ -> Nothing + +-- | A purchase token is a bearer secret, so a purchase is named by its hash. +googlePurchaseRef :: Text -> Text +googlePurchaseRef = safeDecodeUtf8 . strEncode . C.sha256Hash . encodeUtf8 + $(JQ.deriveJSON defaultJSON ''ServiceInvoice) $(JQ.deriveJSON (taggedObjectJSON $ dropPrefix "SP") ''ServicePayment) diff --git a/src/Simplex/Chat/PaymentService/Types.hs b/src/Simplex/Chat/PaymentService/Types.hs index 067e170e90..fe05ecbca4 100644 --- a/src/Simplex/Chat/PaymentService/Types.hs +++ b/src/Simplex/Chat/PaymentService/Types.hs @@ -1,6 +1,9 @@ +{-# LANGUAGE CPP #-} {-# LANGUAGE DerivingStrategies #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE TemplateHaskell #-} module Simplex.Chat.PaymentService.Types @@ -8,6 +11,7 @@ module Simplex.Chat.PaymentService.Types InvoiceId (..), PaymentId (..), PaymentProvider (..), + StoreTransactionRef (..), CardProvider (..), CryptoCurrency (..), ServicePaymentMethod (..), @@ -26,7 +30,16 @@ import Data.ByteString.Char8 (ByteString) import Data.Text (Text) import Data.Time.Clock (UTCTime) import Data.Word (Word32) +import Simplex.Messaging.Agent.Store.DB (fromTextField_) +import Simplex.Messaging.Encoding.String (TextEncoding (..)) import Simplex.Messaging.Parsers (dropPrefix, enumJSON, taggedObjectJSON) +#if defined(dbPostgres) +import Database.PostgreSQL.Simple.FromField (FromField (..)) +import Database.PostgreSQL.Simple.ToField (ToField (..)) +#else +import Database.SQLite.Simple.FromField (FromField (..)) +import Database.SQLite.Simple.ToField (ToField (..)) +#endif -- USD etc. are in minor units, following Stripe etc. convention newtype CurrencyAmount = CurrencyAmount Word32 @@ -45,6 +58,31 @@ newtype PaymentId = PaymentId Text data PaymentProvider = PPApple | PPGoogle | PPStripe | PPCrypto | PPCode | PPReceipt deriving (Eq, Show) +instance TextEncoding PaymentProvider where + textEncode = \case + PPApple -> "apple" + PPGoogle -> "google" + PPStripe -> "stripe" + PPCrypto -> "crypto" + PPCode -> "code" + PPReceipt -> "receipt" + textDecode = \case + "apple" -> Just PPApple + "google" -> Just PPGoogle + "stripe" -> Just PPStripe + "crypto" -> Just PPCrypto + "code" -> Just PPCode + "receipt" -> Just PPReceipt + _ -> Nothing + +instance FromField PaymentProvider where fromField = fromTextField_ textDecode + +instance ToField PaymentProvider where toField = toField . textEncode + +-- | The stable name of one store transaction, by which a retry resolves to the same row. +data StoreTransactionRef = StoreTransactionRef {provider :: PaymentProvider, transactionRef :: Text} + deriving (Eq, Show) + data CardProvider = CPStripe deriving (Eq, Show) diff --git a/src/Simplex/Chat/Store/Badges.hs b/src/Simplex/Chat/Store/Badges.hs index 19d6d2efef..e749a7fc37 100644 --- a/src/Simplex/Chat/Store/Badges.hs +++ b/src/Simplex/Chat/Store/Badges.hs @@ -7,7 +7,8 @@ {-# LANGUAGE TypeOperators #-} module Simplex.Chat.Store.Badges - ( BadgeCodeRedemption (..), + ( BadgeStash (..), + BadgeStashRef (..), UserBadgePurchase (..), getUserBadgePurchase, getBadgePurchase, @@ -18,9 +19,18 @@ module Simplex.Chat.Store.Badges clearShownBadge, getBadgeCodeRedemption, createBadgeCodeRedemption, + BadgeReceiptRecord (..), + BadgeReceiptStatus (..), + holdStoreReceipt, + createBadgeStoreReceipt, + getOpenStorePurchases, + getNextHeldStoreReceipt, + recordStoreReceiptFailure, + refuseStoreReceipt, + deleteUnfundedStoreReceipts, deleteBadgeCodeRedemption, - createCodeBadgePurchase, - getCodeBadgePurchase, + createStashBadgePurchase, + getStashBadgePurchase, storeBadgeIssuance, getLatestIssuedCredential, storeBadgeStatement, @@ -31,8 +41,10 @@ module Simplex.Chat.Store.Badges where import Control.Concurrent.STM (TVar, atomically) +import Control.Monad (forM, forM_, join) import Crypto.Random (ChaChaDRG) import qualified Data.Aeson as J +import Data.ByteString.Char8 (ByteString) import qualified Data.ByteString.Lazy.Char8 as LB import Data.Int (Int64) import Data.Maybe (isJust, mapMaybe) @@ -41,9 +53,12 @@ import Data.Time.Clock (UTCTime) import Simplex.Chat.Badges import Simplex.Chat.Badges.Ledger import Simplex.Chat.Badges.Service (StatementCreditType (..), StatementDebitType (..), StatementEntry (..), StatementEntryType (..)) -import Simplex.Chat.Badges.Types (BadgeAlertKind, BadgeIssueError (..), BadgeIssueFailure, BadgePurchaseStatus (..)) -import Simplex.Chat.Store.Shared (insertedRowId) +import Simplex.Chat.Badges.Types (BadgeAlertKind, BadgeIssueError (..), BadgeIssueFailure, BadgePurchaseStatus (..), OpenStorePurchase (..)) +import Simplex.Chat.PaymentService (ServicePayment) +import Simplex.Chat.PaymentService.Types (StoreTransactionRef (..)) +import Simplex.Chat.Store.Shared (StoreError, insertedRowId) import Simplex.Chat.Types +import Simplex.Messaging.Agent.Protocol (UserId) import Simplex.Messaging.Agent.Store.DB (Binary (..), BoolInt (..)) import qualified Simplex.Messaging.Agent.Store.DB as DB import qualified Simplex.Messaging.Crypto as C @@ -58,18 +73,20 @@ import Database.SQLite.Simple (Only (..), (:.) (..)) import Database.SQLite.Simple.QQ (sql) #endif --- | The keys one redemption attempt is signed with, stashed before the request is sent so that a --- retry reaches the service as the same signer and is answered with the credential already issued. -data BadgeCodeRedemption = BadgeCodeRedemption - { redemptionId :: Int64, +-- | The keys one attempt to fund a badge is signed with, stashed before the request is sent so that +-- a retry reaches the service as the same signer and is answered with the credential already issued. +data BadgeStash = BadgeStash + { stashRef :: BadgeStashRef, purchaseKey :: C.PublicKeyEd25519, purchasePrivKey :: C.PrivateKeyEd25519, masterKey :: BadgeMasterKey } -getBadgeCodeRedemption :: DB.Connection -> User -> Text -> IO (Maybe BadgeCodeRedemption) +data BadgeStashRef = BSRCodeRedemption Int64 | BSRStoreReceipt Int64 + +getBadgeCodeRedemption :: DB.Connection -> User -> Text -> IO (Maybe BadgeStash) getBadgeCodeRedemption db User {userId} code = - maybeFirstRow toRedemption $ + maybeFirstRow (toBadgeStash BSRCodeRedemption) $ DB.query db [sql| @@ -78,11 +95,8 @@ getBadgeCodeRedemption db User {userId} code = WHERE user_id = ? AND code = ? |] (userId, code) - where - toRedemption (redemptionId, purchaseKey, purchasePrivKey, Binary mk) = - BadgeCodeRedemption {redemptionId, purchaseKey, purchasePrivKey, masterKey = BadgeMasterKey mk} -createBadgeCodeRedemption :: DB.Connection -> TVar ChaChaDRG -> User -> Text -> UTCTime -> IO BadgeCodeRedemption +createBadgeCodeRedemption :: DB.Connection -> TVar ChaChaDRG -> User -> Text -> UTCTime -> IO BadgeStash createBadgeCodeRedemption db g User {userId} code now = do (purchaseKey, purchasePrivKey) <- atomically $ C.generateKeyPair g masterKey@(BadgeMasterKey mk) <- generateMasterKey g @@ -94,42 +108,205 @@ createBadgeCodeRedemption db g User {userId} code now = do |] (userId, code, purchaseKey, purchasePrivKey, Binary mk, now) redemptionId <- insertedRowId db - pure BadgeCodeRedemption {redemptionId, purchaseKey, purchasePrivKey, masterKey} + pure BadgeStash {stashRef = BSRCodeRedemption redemptionId, purchaseKey, purchasePrivKey, masterKey} --- | Drop a stashed attempt whose code the service refused for good, unless a purchase already --- came from it - badge_purchases references this row. -deleteBadgeCodeRedemption :: DB.Connection -> Int64 -> IO () -deleteBadgeCodeRedemption db redemptionId = +-- | Our record of a store receipt, as against the receipt itself: held until the service credits or refuses it. +data BadgeReceiptRecord = BadgeReceiptRecord + { receiptId :: Int64, + ownerId :: UserId, + status :: BadgeReceiptStatus + } + +data BadgeReceiptStatus + = RSHeld {stash :: BadgeStash, payment :: Text, nextAttemptAt :: UTCTime, retryDelay :: Maybe Int64} + | RSCredited {badgePurchaseId :: Int64} + | RSRefused {refusal :: Maybe BadgeIssueFailure} + +-- | Resolves a store transaction to the record that owns it, looking up by its reference again after each step +-- rather than trusting the write: finding none still leaves the echoed invoice's record to attach it to, and a +-- concurrent hand-over of the same transaction may win either write. It stays with the record that already has +-- it, whose keys the service may have credited; failing that it joins the record Buy created; and only when the +-- store echoed no invoice does the presenting profile get a new one, nothing else saying who paid. +holdStoreReceipt :: DB.Connection -> TVar ChaChaDRG -> User -> Maybe Text -> StoreTransactionRef -> ServicePayment -> UTCTime -> IO (Maybe BadgeReceiptRecord) +holdStoreReceipt db g User {userId} invoiceId_ txRef@StoreTransactionRef {provider, transactionRef} payment now = + getReceiptRecord db txRef >>= \case + Just r@BadgeReceiptRecord {receiptId} -> do + -- a resolved record stays resolved, so a hand-over landing just after its credit cannot hold it again + DB.execute db "UPDATE badge_store_receipts SET payment = ? WHERE badge_store_receipt_id = ? AND payment IS NOT NULL" (paymentJSON, receiptId) + pure $ Just r + Nothing -> do + forM_ invoiceId_ $ \invoiceId -> + DB.execute + db + "UPDATE badge_store_receipts SET provider = ?, transaction_ref = ?, payment = ?, next_attempt_at = ? WHERE invoice_id = ? AND transaction_ref IS NULL" + (provider, transactionRef, paymentJSON, now, invoiceId) + getReceiptRecord db txRef >>= \case + Just r -> pure $ Just r + Nothing -> do + insertReceipt + getReceiptRecord db txRef + where + paymentJSON = safeDecodeUtf8 . LB.toStrict $ J.encode payment + insertReceipt = do + (purchaseKey, purchasePrivKey) <- atomically (C.generateKeyPair g) :: IO C.KeyPairEd25519 + BadgeMasterKey mk <- generateMasterKey g + -- an invoice id another record holds is not repeated: this record is then keyed by its transaction alone + invoiceId' <- fmap join . forM invoiceId_ $ \invoiceId -> do + taken <- DB.query db "SELECT badge_store_receipt_id FROM badge_store_receipts WHERE invoice_id = ?" (Only invoiceId) :: IO [Only Int64] + pure $ if null taken then Just invoiceId else Nothing + DB.execute + db + [sql| + INSERT INTO badge_store_receipts + (user_id, invoice_id, provider, transaction_ref, payment, next_attempt_at, purchase_key, purchase_priv_key, master_key, created_at) + VALUES (?,?,?,?,?,?,?,?,?,?) + ON CONFLICT DO NOTHING + |] + ((userId, invoiceId', provider, transactionRef, paymentJSON, now) :. (purchaseKey, purchasePrivKey, Binary mk, now)) + +getReceiptRecord :: DB.Connection -> StoreTransactionRef -> IO (Maybe BadgeReceiptRecord) +getReceiptRecord db StoreTransactionRef {provider, transactionRef} = + maybeFirstRow toReceiptRecord $ + DB.query + db + [sql| + SELECT r.badge_store_receipt_id, r.user_id, r.purchase_key, r.purchase_priv_key, r.master_key, + r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error + FROM badge_store_receipts r + LEFT JOIN badge_purchases p ON p.badge_store_receipt_id = r.badge_store_receipt_id + WHERE r.provider = ? AND r.transaction_ref = ? + |] + (provider, transactionRef) + where + toReceiptRecord ((receiptId, ownerId, purchaseKey, purchasePrivKey, mk) :. (payment_, nextAttemptAt_, retryDelay, purchaseId_, refusal)) = + BadgeReceiptRecord {receiptId, ownerId, status} + where + status = case (payment_, nextAttemptAt_) of + (Just payment, Just nextAttemptAt) -> RSHeld {stash = toBadgeStash BSRStoreReceipt (receiptId, purchaseKey, purchasePrivKey, mk), payment, nextAttemptAt, retryDelay} + _ -> maybe (RSRefused refusal) RSCredited purchaseId_ + +-- | The record made when Buy is tapped, before any receipt: the store echoes its invoice id. +createBadgeStoreReceipt :: DB.Connection -> TVar ChaChaDRG -> User -> Text -> UTCTime -> IO () +createBadgeStoreReceipt db g User {userId} invoiceId now = do + (purchaseKey, purchasePrivKey) <- atomically (C.generateKeyPair g) :: IO C.KeyPairEd25519 + BadgeMasterKey mk <- generateMasterKey g + DB.execute + db + [sql| + INSERT INTO badge_store_receipts (user_id, invoice_id, purchase_key, purchase_priv_key, master_key, created_at) + VALUES (?,?,?,?,?,?) + |] + (userId, invoiceId, purchaseKey, purchasePrivKey, Binary mk, now) + +-- | No receipt yet, or one held: a credited or refused record is resolved and not listed. +getOpenStorePurchases :: DB.Connection -> User -> IO [OpenStorePurchase] +getOpenStorePurchases db User {userId} = + map toOpenStorePurchase + <$> DB.query + db + [sql| + SELECT invoice_id, transaction_ref, credit_error + FROM badge_store_receipts + WHERE user_id = ? AND (transaction_ref IS NULL OR payment IS NOT NULL) + ORDER BY badge_store_receipt_id + |] + (Only userId) + where + toOpenStorePurchase (invoiceId, transactionRef, creditError) = OpenStorePurchase {invoiceId, transactionRef, creditError} + +getNextHeldStoreReceipt :: DB.Connection -> UserId -> IO (Either StoreError (Maybe BadgeReceiptRecord)) +getNextHeldStoreReceipt db userId = + fmap Right . maybeFirstRow toHeld $ + DB.query + db + [sql| + SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.payment, r.next_attempt_at, r.retry_delay + FROM badge_store_receipts r + JOIN users u ON u.user_id = r.user_id + WHERE r.user_id = ? AND r.payment IS NOT NULL AND u.shown_badge_id IS NULL + ORDER BY r.next_attempt_at, r.retry_count, r.badge_store_receipt_id + LIMIT 1 + |] + (Only userId) + where + toHeld (stashRow@(receiptId, _, _, _) :. (payment, nextAttemptAt, retryDelay)) = + BadgeReceiptRecord {receiptId, ownerId = userId, status = RSHeld {stash = toBadgeStash BSRStoreReceipt stashRow, payment, nextAttemptAt, retryDelay}} + +recordStoreReceiptFailure :: DB.Connection -> Int64 -> Int64 -> UTCTime -> BadgeIssueFailure -> IO () +recordStoreReceiptFailure db receiptId retryDelay nextAttemptAt failure = + DB.execute + db + [sql| + UPDATE badge_store_receipts + SET retry_delay = ?, next_attempt_at = ?, retry_count = retry_count + 1, credit_error = ? + WHERE badge_store_receipt_id = ? AND payment IS NOT NULL + |] + (retryDelay, nextAttemptAt, failure, receiptId) + +-- | Kept rather than deleted, so that a later hand-over of the same transaction is answered from the record. +refuseStoreReceipt :: DB.Connection -> Int64 -> BadgeIssueFailure -> IO () +refuseStoreReceipt db receiptId refusal = + DB.execute + db + "UPDATE badge_store_receipts SET payment = NULL, next_attempt_at = NULL, retry_delay = NULL, retry_count = 0, credit_error = ? WHERE badge_store_receipt_id = ?" + (refusal, receiptId) + +-- | A held record is paid for and a credited one is referenced by its purchase, so neither is deleted. +deleteUnfundedStoreReceipts :: DB.Connection -> UTCTime -> IO () +deleteUnfundedStoreReceipts db createdBefore = + DB.execute + db + [sql| + DELETE FROM badge_store_receipts + WHERE payment IS NULL AND created_at < ? + AND NOT EXISTS (SELECT 1 FROM badge_purchases p WHERE p.badge_store_receipt_id = badge_store_receipts.badge_store_receipt_id) + |] + (Only createdBefore) + +toBadgeStash :: (Int64 -> BadgeStashRef) -> (Int64, C.PublicKeyEd25519, C.PrivateKeyEd25519, Binary ByteString) -> BadgeStash +toBadgeStash ref (stashId, purchaseKey, purchasePrivKey, Binary mk) = + BadgeStash {stashRef = ref stashId, purchaseKey, purchasePrivKey, masterKey = BadgeMasterKey mk} + +-- | Drop the keys stashed for a code the service refused for good, unless a purchase already came +-- from them - badge_purchases references their row. +deleteBadgeCodeRedemption :: DB.Connection -> User -> Text -> IO () +deleteBadgeCodeRedemption db User {userId} code = DB.execute db [sql| DELETE FROM badge_code_redemptions - WHERE badge_code_redemption_id = ? - AND NOT EXISTS (SELECT 1 FROM badge_purchases WHERE badge_code_redemption_id = ?) + WHERE user_id = ? AND code = ? + AND NOT EXISTS (SELECT 1 FROM badge_purchases p WHERE p.badge_code_redemption_id = badge_code_redemptions.badge_code_redemption_id) |] - (redemptionId, redemptionId) + (userId, code) --- | 'False' when the code was already redeemed here: the service replays the credential it +-- | 'False' when the stash already funded a purchase here: the service replays the credential it -- issued, and that must add no purchase and leave the shown badge alone. -createCodeBadgePurchase :: DB.Connection -> User -> BadgeCodeRedemption -> BadgeCredential -> UTCTime -> IO (Int64, Bool) -createCodeBadgePurchase db User {userId} redemption credential now = - getCodeBadgePurchase db redemption >>= \case +createStashBadgePurchase :: DB.Connection -> User -> BadgeStash -> BadgeCredential -> UTCTime -> IO (Int64, Bool) +createStashBadgePurchase db User {userId} stash credential now = do + -- the credit settles a held receipt in the transaction that stores its purchase, a replay included + forM_ storeReceiptId_ $ \storeReceiptId -> DB.execute db "UPDATE badge_store_receipts SET payment = NULL, next_attempt_at = NULL, retry_delay = NULL, retry_count = 0 WHERE badge_store_receipt_id = ?" (Only storeReceiptId) + getStashBadgePurchase db stash >>= \case Just purchaseId -> pure (purchaseId, False) Nothing -> do DB.execute db [sql| INSERT INTO badge_purchases - (user_id, purchase_key, purchase_priv_key, master_key, initial_badge_type, current_badge_type, status, badge_code_redemption_id, created_at, updated_at) - VALUES (?,?,?,?,?,?,?,?,?,?) + (user_id, purchase_key, purchase_priv_key, master_key, initial_badge_type, current_badge_type, status, + badge_code_redemption_id, badge_store_receipt_id, created_at, updated_at) + VALUES (?,?,?,?,?,?,?,?,?,?,?) |] - (userId, purchaseKey, purchasePrivKey, Binary mk, badgeType, badgeType, PSIssued, redemptionId, now, now) + ((userId, purchaseKey, purchasePrivKey, Binary mk, badgeType, badgeType) :. (PSIssued, redemptionId_, storeReceiptId_, now, now)) purchaseId <- insertedRowId db DB.execute db "UPDATE users SET shown_badge_id = ? WHERE user_id = ?" (purchaseId, userId) pure (purchaseId, True) where - BadgeCodeRedemption {redemptionId, purchaseKey, purchasePrivKey, masterKey = BadgeMasterKey mk} = redemption + BadgeStash {stashRef, purchaseKey, purchasePrivKey, masterKey = BadgeMasterKey mk} = stash BadgeCredential {badgeInfo = BadgeInfo {badgeType}} = credential + (redemptionId_, storeReceiptId_) = case stashRef of + BSRCodeRedemption redemptionId -> (Just redemptionId, Nothing) + BSRStoreReceipt storeReceiptId -> (Nothing, Just storeReceiptId) -- | The period comes from the ledger, the expiry from the credential, which runs a week longer. -- 'False' means no issuance row was written, which the caller reports rather than drop in silence. @@ -194,10 +371,13 @@ getIssuedPeriod db badgePurchaseId entryId = do [(Just periodStart, periodEnd)] -> Just (periodStart, periodEnd) _ -> Nothing -getCodeBadgePurchase :: DB.Connection -> BadgeCodeRedemption -> IO (Maybe Int64) -getCodeBadgePurchase db BadgeCodeRedemption {redemptionId} = - maybeFirstRow fromOnly $ - DB.query db "SELECT badge_purchase_id FROM badge_purchases WHERE badge_code_redemption_id = ?" (Only redemptionId) +getStashBadgePurchase :: DB.Connection -> BadgeStash -> IO (Maybe Int64) +getStashBadgePurchase db BadgeStash {stashRef} = + maybeFirstRow fromOnly $ case stashRef of + BSRCodeRedemption redemptionId -> + DB.query db "SELECT badge_purchase_id FROM badge_purchases WHERE badge_code_redemption_id = ?" (Only redemptionId) + BSRStoreReceipt storeReceiptId -> + DB.query db "SELECT badge_purchase_id FROM badge_purchases WHERE badge_store_receipt_id = ?" (Only storeReceiptId) data UserBadgePurchase = UserBadgePurchase { badgePurchaseId :: Int64, @@ -370,7 +550,7 @@ getBadgeLedger db User {userId} badgePurchaseId = toStatementEntry :: (Text, Int, Int, UTCTime, UTCTime, BadgeType) :. (Maybe UTCTime, UTCTime, Text, Maybe Text, Maybe Text, Maybe Text) -> Maybe StatementEntry toStatementEntry ((entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType) :. (wasPausedSince, createdAt, entryType_, credit_, debit_, value_)) = (\entryType -> StatementEntry {entryId, changeMonths, balanceMonths, balanceStartTs, balanceAnchorTs, balanceBadgeType, wasPausedSince, createdAt, entryType}) - <$> maybe (entryTypeFromColumns entryType_ credit_ debit_) (entryTypeFromValue entryType_) value_ + <$> maybe (entryTypeFromColumns Nothing entryType_ credit_ debit_) (entryTypeFromValue entryType_) value_ -- | Decodes the stored JSON rather than rebuilding from the tag, so a version that has since -- learnt the type reads it with its fields, and one that has not still gets it back verbatim. diff --git a/src/Simplex/Chat/Store/Postgres/Migrations.hs b/src/Simplex/Chat/Store/Postgres/Migrations.hs index 24ed45c9a9..dd5e812595 100644 --- a/src/Simplex/Chat/Store/Postgres/Migrations.hs +++ b/src/Simplex/Chat/Store/Postgres/Migrations.hs @@ -53,6 +53,7 @@ import Simplex.Chat.Store.Postgres.Migrations.M20260904_file_badges import Simplex.Chat.Store.Postgres.Migrations.M20260915_user_badges import Simplex.Chat.Store.Postgres.Migrations.M20260918_badge_issue_errors import Simplex.Chat.Store.Postgres.Migrations.M20260923_preferences_json +import Simplex.Chat.Store.Postgres.Migrations.M20260925_badge_store_receipts import Simplex.Messaging.Agent.Store.Shared (Migration (..)) schemaMigrations :: [(String, Text, Maybe Text)] @@ -105,7 +106,8 @@ schemaMigrations = ("20260904_file_badges", m20260904_file_badges, Just down_m20260904_file_badges), ("20260915_user_badges", m20260915_user_badges, Just down_m20260915_user_badges), ("20260918_badge_issue_errors", m20260918_badge_issue_errors, Just down_m20260918_badge_issue_errors), - ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json) + ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json), + ("20260925_badge_store_receipts", m20260925_badge_store_receipts, Just down_m20260925_badge_store_receipts) ] -- | The list of migrations in ascending order by date diff --git a/src/Simplex/Chat/Store/Postgres/Migrations/M20260915_user_badges.hs b/src/Simplex/Chat/Store/Postgres/Migrations/M20260915_user_badges.hs index 98bdd53db7..20fc4fa99d 100644 --- a/src/Simplex/Chat/Store/Postgres/Migrations/M20260915_user_badges.hs +++ b/src/Simplex/Chat/Store/Postgres/Migrations/M20260915_user_badges.hs @@ -152,6 +152,7 @@ DROP TABLE @badge_prices; |] {- TODO [badges] deferred draft schema for paid purchases, subscriptions, upgrades and transfers. +The service added @badge_purchases.payment_id and @badge_ledger.payment_id in its 20260925_badge_store_receipts, so they left this draft; the client's stay deferred with the rest, as nothing writes its @payments yet. CREATE TABLE @subscription_charges( charge_id TEXT NOT NULL PRIMARY KEY, @@ -165,10 +166,6 @@ CREATE TABLE @subscription_charges( UNIQUE(payment_id, provider_charge_ref) ); -ALTER TABLE @badge_purchases ADD COLUMN payment_id TEXT REFERENCES @payments; - -CREATE UNIQUE INDEX @idx_badge_purchases_payment ON @badge_purchases(payment_id); - CREATE TABLE @badge_invoices( invoice_id TEXT NOT NULL PRIMARY KEY REFERENCES @invoices ON DELETE CASCADE, badge_purchase_id BIGINT NOT NULL REFERENCES @badge_purchases ON DELETE CASCADE, @@ -200,16 +197,12 @@ CREATE TABLE @badge_subscription_changes( CREATE INDEX @idx_badge_subscription_changes_purchase ON @badge_subscription_changes(badge_purchase_id); -ALTER TABLE @badge_ledger ADD COLUMN payment_id TEXT REFERENCES @payments; - ALTER TABLE @badge_ledger ADD COLUMN charge_id TEXT REFERENCES @subscription_charges; ALTER TABLE @badge_ledger ADD COLUMN from_purchase_id BIGINT REFERENCES @badge_purchases; ALTER TABLE @badge_ledger ADD COLUMN to_purchase_id BIGINT REFERENCES @badge_purchases; -CREATE INDEX @idx_badge_ledger_payment ON @badge_ledger(payment_id); - CREATE INDEX @idx_badge_ledger_charge ON @badge_ledger(charge_id); CREATE INDEX @idx_badge_ledger_from_purchase ON @badge_ledger(from_purchase_id); @@ -217,11 +210,9 @@ CREATE INDEX @idx_badge_ledger_from_purchase ON @badge_ledger(from_purchase_id); CREATE INDEX @idx_badge_ledger_to_purchase ON @badge_ledger(to_purchase_id); -- down -DROP INDEX @idx_badge_ledger_payment; DROP INDEX @idx_badge_ledger_charge; DROP INDEX @idx_badge_ledger_from_purchase; DROP INDEX @idx_badge_ledger_to_purchase; -ALTER TABLE @badge_ledger DROP COLUMN payment_id; ALTER TABLE @badge_ledger DROP COLUMN charge_id; ALTER TABLE @badge_ledger DROP COLUMN from_purchase_id; ALTER TABLE @badge_ledger DROP COLUMN to_purchase_id; @@ -231,8 +222,6 @@ DROP INDEX @idx_badge_invoices_purchase; DROP INDEX @idx_badge_invoices_offer; DROP INDEX @idx_badge_invoices_price; DROP TABLE @badge_invoices; -DROP INDEX @idx_badge_purchases_payment; -ALTER TABLE @badge_purchases DROP COLUMN payment_id; DROP TABLE @subscription_charges; -} diff --git a/src/Simplex/Chat/Store/Postgres/Migrations/M20260925_badge_store_receipts.hs b/src/Simplex/Chat/Store/Postgres/Migrations/M20260925_badge_store_receipts.hs new file mode 100644 index 0000000000..093031e21d --- /dev/null +++ b/src/Simplex/Chat/Store/Postgres/Migrations/M20260925_badge_store_receipts.hs @@ -0,0 +1,51 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} + +module Simplex.Chat.Store.Postgres.Migrations.M20260925_badge_store_receipts where + +import Data.Text (Text) +import Text.RawString.QQ (r) + +-- | invoice_id is null for a receipt naming one another row holds: the transaction still has to be +-- creditable, and its reference identifies it. provider and transaction_ref are null until a receipt +-- arrives, and distinct NULLs let several rows await one at once. payment is held from the receipt's +-- arrival until the service credits or refuses it; a refused row keeps its refusal in credit_error. +m20260925_badge_store_receipts :: Text +m20260925_badge_store_receipts = + [r| +CREATE TABLE badge_store_receipts( + badge_store_receipt_id BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY, + user_id BIGINT NOT NULL REFERENCES users ON DELETE CASCADE, + invoice_id TEXT UNIQUE, + provider TEXT, + transaction_ref TEXT, + purchase_key BYTEA NOT NULL, + purchase_priv_key BYTEA NOT NULL, + master_key BYTEA NOT NULL, + created_at TIMESTAMPTZ NOT NULL, + payment TEXT, + next_attempt_at TIMESTAMPTZ, + retry_delay BIGINT, + retry_count BIGINT NOT NULL DEFAULT 0, + credit_error TEXT, + UNIQUE(provider, transaction_ref) +); + +CREATE INDEX idx_badge_store_receipts_user ON badge_store_receipts(user_id); + +ALTER TABLE badge_purchases ADD COLUMN badge_store_receipt_id BIGINT REFERENCES badge_store_receipts; + +CREATE UNIQUE INDEX idx_badge_purchases_store_receipt ON badge_purchases(badge_store_receipt_id); +|] + +down_m20260925_badge_store_receipts :: Text +down_m20260925_badge_store_receipts = + [r| +DROP INDEX idx_badge_purchases_store_receipt; + +ALTER TABLE badge_purchases DROP COLUMN badge_store_receipt_id; + +DROP INDEX idx_badge_store_receipts_user; + +DROP TABLE badge_store_receipts; +|] diff --git a/src/Simplex/Chat/Store/Postgres/Migrations/chat_schema.sql b/src/Simplex/Chat/Store/Postgres/Migrations/chat_schema.sql index ad975874db..faf872db07 100644 --- a/src/Simplex/Chat/Store/Postgres/Migrations/chat_schema.sql +++ b/src/Simplex/Chat/Store/Postgres/Migrations/chat_schema.sql @@ -279,7 +279,8 @@ CREATE TABLE test_chat_schema.badge_purchases ( issue_failed_since timestamp with time zone, issue_error_at timestamp with time zone, issue_error text, - next_wake_at timestamp with time zone + next_wake_at timestamp with time zone, + badge_store_receipt_id bigint ); @@ -295,6 +296,36 @@ ALTER TABLE test_chat_schema.badge_purchases ALTER COLUMN badge_purchase_id ADD +CREATE TABLE test_chat_schema.badge_store_receipts ( + badge_store_receipt_id bigint NOT NULL, + user_id bigint NOT NULL, + invoice_id text, + provider text, + transaction_ref text, + purchase_key bytea NOT NULL, + purchase_priv_key bytea NOT NULL, + master_key bytea NOT NULL, + created_at timestamp with time zone NOT NULL, + payment text, + next_attempt_at timestamp with time zone, + retry_delay bigint, + retry_count bigint DEFAULT 0 NOT NULL, + credit_error text +); + + + +ALTER TABLE test_chat_schema.badge_store_receipts ALTER COLUMN badge_store_receipt_id ADD GENERATED ALWAYS AS IDENTITY ( + SEQUENCE NAME test_chat_schema.badge_store_receipts_badge_store_receipt_id_seq + START WITH 1 + INCREMENT BY 1 + NO MINVALUE + NO MAXVALUE + CACHE 1 +); + + + CREATE TABLE test_chat_schema.calls ( call_id bigint NOT NULL, contact_id bigint NOT NULL, @@ -1793,6 +1824,21 @@ ALTER TABLE ONLY test_chat_schema.badge_purchases +ALTER TABLE ONLY test_chat_schema.badge_store_receipts + ADD CONSTRAINT badge_store_receipts_invoice_id_key UNIQUE (invoice_id); + + + +ALTER TABLE ONLY test_chat_schema.badge_store_receipts + ADD CONSTRAINT badge_store_receipts_pkey PRIMARY KEY (badge_store_receipt_id); + + + +ALTER TABLE ONLY test_chat_schema.badge_store_receipts + ADD CONSTRAINT badge_store_receipts_provider_transaction_ref_key UNIQUE (provider, transaction_ref); + + + ALTER TABLE ONLY test_chat_schema.calls ADD CONSTRAINT calls_pkey PRIMARY KEY (call_id); @@ -2192,10 +2238,18 @@ CREATE UNIQUE INDEX idx_badge_purchases_code_redemption ON test_chat_schema.badg +CREATE UNIQUE INDEX idx_badge_purchases_store_receipt ON test_chat_schema.badge_purchases USING btree (badge_store_receipt_id); + + + CREATE INDEX idx_badge_purchases_user ON test_chat_schema.badge_purchases USING btree (user_id); +CREATE INDEX idx_badge_store_receipts_user ON test_chat_schema.badge_store_receipts USING btree (user_id); + + + CREATE INDEX idx_calls_chat_item_id ON test_chat_schema.calls USING btree (chat_item_id); @@ -2994,11 +3048,21 @@ ALTER TABLE ONLY test_chat_schema.badge_purchases +ALTER TABLE ONLY test_chat_schema.badge_purchases + ADD CONSTRAINT badge_purchases_badge_store_receipt_id_fkey FOREIGN KEY (badge_store_receipt_id) REFERENCES test_chat_schema.badge_store_receipts(badge_store_receipt_id); + + + ALTER TABLE ONLY test_chat_schema.badge_purchases ADD CONSTRAINT badge_purchases_user_id_fkey FOREIGN KEY (user_id) REFERENCES test_chat_schema.users(user_id) ON DELETE CASCADE; +ALTER TABLE ONLY test_chat_schema.badge_store_receipts + ADD CONSTRAINT badge_store_receipts_user_id_fkey FOREIGN KEY (user_id) REFERENCES test_chat_schema.users(user_id) ON DELETE CASCADE; + + + ALTER TABLE ONLY test_chat_schema.calls ADD CONSTRAINT calls_chat_item_id_fkey FOREIGN KEY (chat_item_id) REFERENCES test_chat_schema.chat_items(chat_item_id) ON DELETE CASCADE; diff --git a/src/Simplex/Chat/Store/SQLite/Migrations.hs b/src/Simplex/Chat/Store/SQLite/Migrations.hs index 4dcefa1598..a5cb6b012d 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations.hs +++ b/src/Simplex/Chat/Store/SQLite/Migrations.hs @@ -176,6 +176,7 @@ import Simplex.Chat.Store.SQLite.Migrations.M20260904_file_badges import Simplex.Chat.Store.SQLite.Migrations.M20260915_user_badges import Simplex.Chat.Store.SQLite.Migrations.M20260918_badge_issue_errors import Simplex.Chat.Store.SQLite.Migrations.M20260923_preferences_json +import Simplex.Chat.Store.SQLite.Migrations.M20260925_badge_store_receipts import Simplex.Messaging.Agent.Store.Shared (Migration (..)) schemaMigrations :: [(String, Query, Maybe Query)] @@ -351,7 +352,8 @@ schemaMigrations = ("20260904_file_badges", m20260904_file_badges, Just down_m20260904_file_badges), ("20260915_user_badges", m20260915_user_badges, Just down_m20260915_user_badges), ("20260918_badge_issue_errors", m20260918_badge_issue_errors, Just down_m20260918_badge_issue_errors), - ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json) + ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json), + ("20260925_badge_store_receipts", m20260925_badge_store_receipts, Just down_m20260925_badge_store_receipts) ] -- | The list of migrations in ascending order by date diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/M20260915_user_badges.hs b/src/Simplex/Chat/Store/SQLite/Migrations/M20260915_user_badges.hs index 3462db9bc1..8646d8b29e 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/M20260915_user_badges.hs +++ b/src/Simplex/Chat/Store/SQLite/Migrations/M20260915_user_badges.hs @@ -153,6 +153,7 @@ DROP TABLE @badge_prices; |] {- TODO [badges] deferred draft schema for paid purchases, subscriptions, upgrades and transfers. +The service added @badge_purchases.payment_id and @badge_ledger.payment_id in its 20260925_badge_store_receipts, so they left this draft; the client's stay deferred with the rest, as nothing writes its @payments yet. CREATE TABLE @subscription_charges( charge_id TEXT NOT NULL PRIMARY KEY, @@ -166,10 +167,6 @@ CREATE TABLE @subscription_charges( UNIQUE(payment_id, provider_charge_ref) ) STRICT; -ALTER TABLE @badge_purchases ADD COLUMN payment_id TEXT REFERENCES @payments; - -CREATE UNIQUE INDEX @idx_badge_purchases_payment ON @badge_purchases(payment_id); - CREATE TABLE @badge_invoices( invoice_id TEXT NOT NULL PRIMARY KEY REFERENCES @invoices ON DELETE CASCADE, badge_purchase_id INTEGER NOT NULL REFERENCES @badge_purchases ON DELETE CASCADE, @@ -201,16 +198,12 @@ CREATE TABLE @badge_subscription_changes( CREATE INDEX @idx_badge_subscription_changes_purchase ON @badge_subscription_changes(badge_purchase_id); -ALTER TABLE @badge_ledger ADD COLUMN payment_id TEXT REFERENCES @payments; - ALTER TABLE @badge_ledger ADD COLUMN charge_id TEXT REFERENCES @subscription_charges; ALTER TABLE @badge_ledger ADD COLUMN from_purchase_id INTEGER REFERENCES @badge_purchases; ALTER TABLE @badge_ledger ADD COLUMN to_purchase_id INTEGER REFERENCES @badge_purchases; -CREATE INDEX @idx_badge_ledger_payment ON @badge_ledger(payment_id); - CREATE INDEX @idx_badge_ledger_charge ON @badge_ledger(charge_id); CREATE INDEX @idx_badge_ledger_from_purchase ON @badge_ledger(from_purchase_id); @@ -218,11 +211,9 @@ CREATE INDEX @idx_badge_ledger_from_purchase ON @badge_ledger(from_purchase_id); CREATE INDEX @idx_badge_ledger_to_purchase ON @badge_ledger(to_purchase_id); -- down -DROP INDEX @idx_badge_ledger_payment; DROP INDEX @idx_badge_ledger_charge; DROP INDEX @idx_badge_ledger_from_purchase; DROP INDEX @idx_badge_ledger_to_purchase; -ALTER TABLE @badge_ledger DROP COLUMN payment_id; ALTER TABLE @badge_ledger DROP COLUMN charge_id; ALTER TABLE @badge_ledger DROP COLUMN from_purchase_id; ALTER TABLE @badge_ledger DROP COLUMN to_purchase_id; @@ -232,8 +223,6 @@ DROP INDEX @idx_badge_invoices_purchase; DROP INDEX @idx_badge_invoices_offer; DROP INDEX @idx_badge_invoices_price; DROP TABLE @badge_invoices; -DROP INDEX @idx_badge_purchases_payment; -ALTER TABLE @badge_purchases DROP COLUMN payment_id; DROP TABLE @subscription_charges; -} diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/M20260925_badge_store_receipts.hs b/src/Simplex/Chat/Store/SQLite/Migrations/M20260925_badge_store_receipts.hs new file mode 100644 index 0000000000..bf02837cb9 --- /dev/null +++ b/src/Simplex/Chat/Store/SQLite/Migrations/M20260925_badge_store_receipts.hs @@ -0,0 +1,50 @@ +{-# LANGUAGE QuasiQuotes #-} + +module Simplex.Chat.Store.SQLite.Migrations.M20260925_badge_store_receipts where + +import Database.SQLite.Simple (Query) +import Database.SQLite.Simple.QQ (sql) + +-- | invoice_id is null for a receipt naming one another row holds: the transaction still has to be +-- creditable, and its reference identifies it. provider and transaction_ref are null until a receipt +-- arrives, and distinct NULLs let several rows await one at once. payment is held from the receipt's +-- arrival until the service credits or refuses it; a refused row keeps its refusal in credit_error. +m20260925_badge_store_receipts :: Query +m20260925_badge_store_receipts = + [sql| +CREATE TABLE badge_store_receipts( + badge_store_receipt_id INTEGER PRIMARY KEY AUTOINCREMENT, + user_id INTEGER NOT NULL REFERENCES users ON DELETE CASCADE, + invoice_id TEXT UNIQUE, + provider TEXT, + transaction_ref TEXT, + purchase_key BLOB NOT NULL, + purchase_priv_key BLOB NOT NULL, + master_key BLOB NOT NULL, + created_at TEXT NOT NULL, + payment TEXT, + next_attempt_at TEXT, + retry_delay INTEGER, + retry_count INTEGER NOT NULL DEFAULT 0, + credit_error TEXT, + UNIQUE(provider, transaction_ref) +) STRICT; + +CREATE INDEX idx_badge_store_receipts_user ON badge_store_receipts(user_id); + +ALTER TABLE badge_purchases ADD COLUMN badge_store_receipt_id INTEGER REFERENCES badge_store_receipts; + +CREATE UNIQUE INDEX idx_badge_purchases_store_receipt ON badge_purchases(badge_store_receipt_id); +|] + +down_m20260925_badge_store_receipts :: Query +down_m20260925_badge_store_receipts = + [sql| +DROP INDEX idx_badge_purchases_store_receipt; + +ALTER TABLE badge_purchases DROP COLUMN badge_store_receipt_id; + +DROP INDEX idx_badge_store_receipts_user; + +DROP TABLE badge_store_receipts; +|] diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt index 152d6c0c8d..6886687a23 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt +++ b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt @@ -1223,8 +1223,17 @@ Plan: Query: INSERT INTO badge_purchases - (user_id, purchase_key, purchase_priv_key, master_key, initial_badge_type, current_badge_type, status, badge_code_redemption_id, created_at, updated_at) + (user_id, purchase_key, purchase_priv_key, master_key, initial_badge_type, current_badge_type, status, + badge_code_redemption_id, badge_store_receipt_id, created_at, updated_at) + VALUES (?,?,?,?,?,?,?,?,?,?,?) + +Plan: + +Query: + INSERT INTO badge_store_receipts + (user_id, invoice_id, provider, transaction_ref, payment, next_attempt_at, purchase_key, purchase_priv_key, master_key, created_at) VALUES (?,?,?,?,?,?,?,?,?,?) + ON CONFLICT DO NOTHING Plan: @@ -4034,6 +4043,15 @@ Query: Plan: SCAN group_members +Query: + SELECT invoice_id, transaction_ref, credit_error + FROM badge_store_receipts + WHERE user_id = ? AND (transaction_ref IS NULL OR payment IS NOT NULL) + ORDER BY badge_store_receipt_id + +Plan: +SEARCH badge_store_receipts USING INDEX idx_badge_store_receipts_user (user_id=?) + Query: SELECT l.entry_uuid, l.change_months, l.balance_months, l.balance_start_ts, l.balance_anchor_ts, l.balance_badge_type, l.was_paused_since, l.service_created_at, l.entry_type, l.entry_credit_type, l.entry_debit_type, l.entry_type_value @@ -4092,6 +4110,30 @@ Query: Plan: SEARCH file_badge_proofs USING INDEX idx_file_badge_proofs_file_id_kind (file_id=?) +Query: + SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.payment, r.next_attempt_at, r.retry_delay + FROM badge_store_receipts r + JOIN users u ON u.user_id = r.user_id + WHERE r.user_id = ? AND r.payment IS NOT NULL AND u.shown_badge_id IS NULL + ORDER BY r.next_attempt_at, r.retry_count, r.badge_store_receipt_id + LIMIT 1 + +Plan: +SEARCH u USING INTEGER PRIMARY KEY (rowid=?) +SEARCH r USING INDEX idx_badge_store_receipts_user (user_id=?) +USE TEMP B-TREE FOR ORDER BY + +Query: + SELECT r.badge_store_receipt_id, r.user_id, r.purchase_key, r.purchase_priv_key, r.master_key, + r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error + FROM badge_store_receipts r + LEFT JOIN badge_purchases p ON p.badge_store_receipt_id = r.badge_store_receipt_id + WHERE r.provider = ? AND r.transaction_ref = ? + +Plan: +SEARCH r USING INDEX sqlite_autoindex_badge_store_receipts_2 (provider=? AND transaction_ref=?) +SEARCH p USING COVERING INDEX idx_badge_purchases_store_receipt (badge_store_receipt_id=?) LEFT-JOIN + Query: SELECT r.contact_id, g.group_id, r.group_member_id FROM received_probes r @@ -4427,15 +4469,26 @@ SEARCH ug USING AUTOMATIC COVERING INDEX (group_id=?) Query: DELETE FROM badge_code_redemptions - WHERE badge_code_redemption_id = ? - AND NOT EXISTS (SELECT 1 FROM badge_purchases WHERE badge_code_redemption_id = ?) + WHERE user_id = ? AND code = ? + AND NOT EXISTS (SELECT 1 FROM badge_purchases p WHERE p.badge_code_redemption_id = badge_code_redemptions.badge_code_redemption_id) Plan: -SEARCH badge_code_redemptions USING INTEGER PRIMARY KEY (rowid=?) -SCALAR SUBQUERY 1 -SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_code_redemption (badge_code_redemption_id=?) +SEARCH badge_code_redemptions USING INDEX sqlite_autoindex_badge_code_redemptions_1 (user_id=? AND code=?) +CORRELATED SCALAR SUBQUERY 1 +SEARCH p USING COVERING INDEX idx_badge_purchases_code_redemption (badge_code_redemption_id=?) SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_code_redemption (badge_code_redemption_id=?) +Query: + DELETE FROM badge_store_receipts + WHERE payment IS NULL AND created_at < ? + AND NOT EXISTS (SELECT 1 FROM badge_purchases p WHERE p.badge_store_receipt_id = badge_store_receipts.badge_store_receipt_id) + +Plan: +SCAN badge_store_receipts +CORRELATED SCALAR SUBQUERY 1 +SEARCH p USING COVERING INDEX idx_badge_purchases_store_receipt (badge_store_receipt_id=?) +SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_store_receipt (badge_store_receipt_id=?) + Query: DELETE FROM chat_items WHERE group_scope_group_member_id = ? @@ -4928,6 +4981,12 @@ Query: Plan: +Query: + INSERT INTO badge_store_receipts (user_id, invoice_id, purchase_key, purchase_priv_key, master_key, created_at) + VALUES (?,?,?,?,?,?) + +Plan: + Query: INSERT INTO calls (contact_id, shared_call_id, call_uuid, chat_item_id, call_state, call_ts, user_id, created_at, updated_at) @@ -5162,6 +5221,14 @@ Query: Plan: SEARCH badge_purchases USING INTEGER PRIMARY KEY (rowid=?) +Query: + UPDATE badge_store_receipts + SET retry_delay = ?, next_attempt_at = ?, retry_count = retry_count + 1, credit_error = ? + WHERE badge_store_receipt_id = ? AND payment IS NOT NULL + +Plan: +SEARCH badge_store_receipts USING INTEGER PRIMARY KEY (rowid=?) + Query: UPDATE chat_items SET item_content = ?, item_text = ?, item_status = ?, item_deleted = ?, item_deleted_ts = ?, item_edited = ?, item_live = ?, updated_at = ?, timed_ttl = ?, timed_delete_at = ? @@ -7109,6 +7176,7 @@ SEARCH connections USING COVERING INDEX idx_connections_user_contact_link_id (us Query: DELETE FROM users WHERE user_id = ? Plan: SEARCH users USING INTEGER PRIMARY KEY (rowid=?) +SEARCH badge_store_receipts USING COVERING INDEX idx_badge_store_receipts_user (user_id=?) SEARCH badge_code_redemptions USING COVERING INDEX idx_badge_code_redemptions_user (user_id=?) SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_user (user_id=?) SEARCH chat_relays USING COVERING INDEX idx_chat_relays_user_id (user_id=?) @@ -7266,6 +7334,14 @@ Query: SELECT 1 FROM settings WHERE user_id = ? LIMIT 1 Plan: SEARCH settings USING COVERING INDEX idx_settings_user_id (user_id=?) +Query: SELECT COUNT(*) FROM badge_store_receipts +Plan: +SCAN badge_store_receipts USING COVERING INDEX idx_badge_store_receipts_user + +Query: SELECT COUNT(*) FROM badge_store_receipts WHERE payment IS NOT NULL +Plan: +SCAN badge_store_receipts + Query: SELECT COUNT(*) FROM groups WHERE relay_own_status IS NOT NULL Plan: SCAN groups @@ -7365,6 +7441,14 @@ Query: SELECT badge_purchase_id FROM badge_purchases WHERE badge_code_redemption Plan: SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_code_redemption (badge_code_redemption_id=?) +Query: SELECT badge_purchase_id FROM badge_purchases WHERE badge_store_receipt_id = ? +Plan: +SEARCH badge_purchases USING COVERING INDEX idx_badge_purchases_store_receipt (badge_store_receipt_id=?) + +Query: SELECT badge_store_receipt_id FROM badge_store_receipts WHERE invoice_id = ? +Plan: +SEARCH badge_store_receipts USING COVERING INDEX sqlite_autoindex_badge_store_receipts_1 (invoice_id=?) + Query: SELECT balance_checked FROM badge_ledger ORDER BY entry_id Plan: SCAN badge_ledger @@ -7502,6 +7586,10 @@ Query: SELECT count(1) FROM pending_group_messages Plan: SCAN pending_group_messages USING COVERING INDEX idx_pending_group_messages_group_member_id +Query: SELECT credit_error FROM badge_store_receipts WHERE payment IS NOT NULL AND credit_error IS NOT NULL +Plan: +SCAN badge_store_receipts + Query: SELECT entry_id FROM badge_ledger WHERE badge_purchase_id = ? AND entry_uuid = ? Plan: SEARCH badge_ledger USING INDEX idx_badge_ledger_uuid (entry_uuid=?) @@ -7768,6 +7856,10 @@ Query: SELECT user_id FROM users WHERE local_display_name = ? Plan: SEARCH users USING COVERING INDEX sqlite_autoindex_users_2 (local_display_name=?) +Query: SELECT user_id, invoice_id, transaction_ref IS NOT NULL FROM badge_store_receipts ORDER BY badge_store_receipt_id +Plan: +SCAN badge_store_receipts + Query: SELECT via_contact_uri FROM connections WHERE connection_id = ? Plan: SEARCH connections USING INTEGER PRIMARY KEY (rowid=?) @@ -7792,6 +7884,26 @@ Query: UPDATE badge_purchases SET next_wake_at = ? WHERE badge_purchase_id = ? Plan: SEARCH badge_purchases USING INTEGER PRIMARY KEY (rowid=?) +Query: UPDATE badge_store_receipts SET payment = ? +Plan: +SCAN badge_store_receipts + +Query: UPDATE badge_store_receipts SET payment = ? WHERE badge_store_receipt_id = ? AND payment IS NOT NULL +Plan: +SEARCH badge_store_receipts USING INTEGER PRIMARY KEY (rowid=?) + +Query: UPDATE badge_store_receipts SET payment = NULL, next_attempt_at = NULL, retry_delay = NULL, retry_count = 0 WHERE badge_store_receipt_id = ? +Plan: +SEARCH badge_store_receipts USING INTEGER PRIMARY KEY (rowid=?) + +Query: UPDATE badge_store_receipts SET payment = NULL, next_attempt_at = NULL, retry_delay = NULL, retry_count = 0, credit_error = ? WHERE badge_store_receipt_id = ? +Plan: +SEARCH badge_store_receipts USING INTEGER PRIMARY KEY (rowid=?) + +Query: UPDATE badge_store_receipts SET provider = ?, transaction_ref = ?, payment = ?, next_attempt_at = ? WHERE invoice_id = ? AND transaction_ref IS NULL +Plan: +SEARCH badge_store_receipts USING INDEX sqlite_autoindex_badge_store_receipts_1 (invoice_id=?) + Query: UPDATE chat_items SET item_msg_body = ?, item_chat_binding = ?, item_signatures = ?, item_signed_by_group_member_id = ? WHERE chat_item_id = ? AND include_in_history = 1 Plan: SEARCH chat_items USING INTEGER PRIMARY KEY (rowid=?) diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql b/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql index 995497d5ee..9ef56d8aa9 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql +++ b/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql @@ -938,6 +938,7 @@ CREATE TABLE badge_purchases( issue_error_at TEXT, issue_error TEXT, next_wake_at TEXT, + badge_store_receipt_id INTEGER REFERENCES badge_store_receipts, UNIQUE(purchase_key) ) STRICT; CREATE TABLE badge_ledger( @@ -981,6 +982,23 @@ CREATE TABLE badge_code_redemptions( created_at TEXT NOT NULL, UNIQUE(user_id, code) ) STRICT; +CREATE TABLE badge_store_receipts( + badge_store_receipt_id INTEGER PRIMARY KEY AUTOINCREMENT, + user_id INTEGER NOT NULL REFERENCES users ON DELETE CASCADE, + invoice_id TEXT UNIQUE, + provider TEXT, + transaction_ref TEXT, + purchase_key BLOB NOT NULL, + purchase_priv_key BLOB NOT NULL, + master_key BLOB NOT NULL, + created_at TEXT NOT NULL, + payment TEXT, + next_attempt_at TEXT, + retry_delay INTEGER, + retry_count INTEGER NOT NULL DEFAULT 0, + credit_error TEXT, + UNIQUE(provider, transaction_ref) +) STRICT; CREATE INDEX contact_profiles_index ON contact_profiles( display_name, full_name @@ -1544,6 +1562,10 @@ CREATE INDEX idx_badge_code_redemptions_user ON badge_code_redemptions( CREATE UNIQUE INDEX idx_badge_purchases_code_redemption ON badge_purchases( badge_code_redemption_id ); +CREATE INDEX idx_badge_store_receipts_user ON badge_store_receipts(user_id); +CREATE UNIQUE INDEX idx_badge_purchases_store_receipt ON badge_purchases( + badge_store_receipt_id +); CREATE TRIGGER on_group_members_insert_update_summary AFTER INSERT ON group_members FOR EACH ROW diff --git a/src/Simplex/Chat/View.hs b/src/Simplex/Chat/View.hs index 1c62bc267b..30211ea181 100644 --- a/src/Simplex/Chat/View.hs +++ b/src/Simplex/Chat/View.hs @@ -46,7 +46,7 @@ import Simplex.Chat.Markdown import Simplex.Chat.Badges (BadgeInfo (..), BadgeStatus (..), BadgeType (..), LocalBadge, localBadgeInfo, localBadgeStatus) import Simplex.Chat.Badges.Ledger (creditTypeTag, debitTypeTag) import Simplex.Chat.Badges.Service (StatementEntry (..), StatementEntryType (..)) -import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeIssueError (..), BadgeState (..)) +import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeIssueError (..), BadgeState (..), OpenStorePurchase (..)) import Simplex.Chat.Messages hiding (NewChatItem (..)) import Simplex.Chat.Messages.CIContent import Simplex.Chat.Operators @@ -193,7 +193,8 @@ chatResponseToView hu cfg@ChatConfig {logLevel, showReactions, showFullLinks, te CRServiceReplyAccepted u (AgentConnId cId) -> ttyUser u [plain $ "service reply accepted, connection id: " <> safeDecodeUtf8 (strEncode cId)] -- the badge is only shown when it is the one now on the profile; a replayed code's badge may not be CRBadgeRedeemed u badge newBadge _ -> ttyUser u $ if newBadge then "badge redeemed" : viewContactBadge (Just badge) else ["badge already redeemed"] - CRBadgeState u st -> ttyUser u $ viewUserBadgeState st + CRBadgeInvoice u invoiceId -> ttyUser u ["badge invoice: " <> plain invoiceId] + CRBadgeState u st storePurchases -> ttyUser u $ viewUserBadgeState st <> map viewOpenStorePurchase storePurchases CRBadgeLedger u entries -> ttyUser u $ viewBadgeLedger entries CRGroupCreated u g -> ttyUser u $ viewGroupCreated g testView CRPublicGroupCreated u g _groupLink _relays -> ttyUser u $ viewGroupCreated g testView @@ -483,6 +484,7 @@ chatEventToView hu ChatConfig {logLevel, showReactions, showReceipts, testView} CEvtServiceReplySent (AgentConnId cId) -> [plain $ "service reply sent, connection id: " <> safeDecodeUtf8 (strEncode cId)] CEvtBadgeChanged u st -> ttyUser u $ viewUserBadgeState st CEvtBadgeAlert u alert -> ttyUser u $ viewBadgeAlert alert + CEvtStorePurchaseResolved u -> ttyUser u ["store purchase resolved"] CEvtContactRequestRejected u Contact {localDisplayName = c} _reason -> ttyUser u [ttyContact c <> ": contact request rejected"] CEvtRcvFileStart u ci -> ttyUser u $ receivingFile_' hu testView "started" ci CEvtRcvFileComplete u ci -> ttyUser u $ receivingFile_' hu testView "completed" ci @@ -1863,6 +1865,14 @@ viewBadgeIssueError BadgeIssueError {failedSince, lastAttemptAt, reason} = viewBadgeAlert :: BadgeAlert -> [StyledString] viewBadgeAlert BadgeAlert {kind, date} = [plain $ "badge alert: " <> textEncode kind <> " " <> day date] +viewOpenStorePurchase :: OpenStorePurchase -> StyledString +viewOpenStorePurchase OpenStorePurchase {invoiceId, transactionRef, creditError} = + plain $ + "store purchase open: invoice " + <> fromMaybe "none" invoiceId + <> maybe "" (", transaction " <>) transactionRef + <> maybe "" ((", not credited: " <>) . safeDecodeUtf8 . strEncode) creditError + viewBadgeLedger :: [StatementEntry] -> [StyledString] viewBadgeLedger [] = ["no ledger entries"] viewBadgeLedger entries = map viewEntry entries @@ -2867,13 +2877,14 @@ viewChatError isCmd logLevel testView = \case CEBadgeRedeemError e -> let reason = case e of BREInvalidCode -> "invalid code" + BREInvalidReceipt -> "invalid store receipt" BREServiceNotConfigured -> "badge service not configured" BREBadgeActive -> "badge already active" BREServiceError code -> "badge service error: " <> T.unpack (badgeServiceErrorText code) BREInvalidResponse m -> "invalid service response: " <> m BREUnknownKeyIndex -> "credential names an unknown badge key index" BRECredentialNotVerified -> "credential does not verify against configured key" - in ["cannot redeem badge code: " <> plain reason] + in ["cannot get badge: " <> plain reason] CEAgentCommandError e -> ["agent command error: " <> plain e] CEInvalidFileDescription e -> ["invalid file description: " <> plain e] CEConnectionIncognitoChangeProhibited -> ["incognito mode change prohibited"] diff --git a/tests/BadgeTests.hs b/tests/BadgeTests.hs index bd8f62d3fd..6bb4b14aa7 100644 --- a/tests/BadgeTests.hs +++ b/tests/BadgeTests.hs @@ -9,19 +9,26 @@ module BadgeTests (badgeTests) where -import BadgeService.Service (badgeErrorRetryAfter) +import BadgeService.Service (badgeErrorRetryAfter, shownServiceRequest, survive) +import BadgeService.StoreReceipts (StoreReceipt (..), StoreRefusal (..), StoreVerifier (..), VerifiedStoreTransaction (..), toStoreReceipt) +import BadgeService.StoreReceipts.Mock (mockStoreVerifier) +import Control.Concurrent (forkIO, killThread, threadDelay) +import Control.Concurrent.MVar (newEmptyMVar, putMVar, takeMVar) import Control.Concurrent.STM (atomically) +import Control.Exception (SomeAsyncException, SomeException, catch, fromException, throwIO) import Data.ByteString.Char8 (ByteString) +import qualified Data.ByteString.Base64.URL as B64U import Data.Map.Strict (Map) import qualified Data.Map.Strict as M import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) import Data.Time.Calendar (fromGregorian) import Data.Time.Calendar.WeekDate (toWeekDate) import Data.Time.Clock (NominalDiffTime, UTCTime (..), addUTCTime, diffUTCTime, getCurrentTime, nominalDay) import Data.Time.Clock.POSIX (posixSecondsToUTCTime) import qualified Data.Aeson as J import qualified Data.Aeson.KeyMap as KM -import Data.Maybe (fromMaybe, isNothing, maybeToList) +import Data.Maybe (fromMaybe, isJust, isNothing, maybeToList) import qualified Simplex.Messaging.Crypto as C import Simplex.Chat.Badges import Simplex.Chat.Badges.Code @@ -29,14 +36,16 @@ import Simplex.Chat.Badges.Ledger import Simplex.Chat.Badges.Service import Simplex.Chat.Badges.Types (BadgeIssueFailure (..)) import Simplex.Chat (defaultChatConfig) -import Simplex.Chat.Controller (ChatError (..), ChatErrorType (..), badgeRetryInterval, chatErrorAgent) -import Simplex.Chat.Library.Commands (badgeErrorRetry, badgeFailureTransient, badgeIssueFailure, badgeRetryAfter, badgeServiceErrorText, badgeStalledInterval) +import Simplex.Chat.Controller (BadgeRedeemError (..), ChatError (..), ChatErrorType (..), badgeRetryInterval, chatErrorAgent) +import Simplex.Chat.Library.Commands (badgeErrorRetry, badgeFailureTransient, badgeIssueFailure, badgeRetryAfter, badgeServiceErrorText, badgeStalledInterval, storeTransactionRef) +import Simplex.Chat.PaymentService (ServicePayment (..)) +import Simplex.Chat.PaymentService.Types (InvoiceId (..), PaymentProvider (..), StoreTransactionRef (..)) import Simplex.Messaging.Agent.Protocol (AgentErrorType (..), AgentServiceError (..), SMPAgentError (..)) import Simplex.Messaging.Agent.RetryInterval (RetryInterval (..), nextRetryDelay) import Simplex.Messaging.Crypto.BBS import Simplex.Messaging.Encoding.String import Simplex.Messaging.Protocol (BrokerErrorType (..), ErrorType (AUTH), NetworkError (..)) -import Simplex.Messaging.Util (tshow) +import Simplex.Messaging.Util (safeDecodeUtf8, tshow) import Simplex.Messaging.Version.Internal (Version (..)) import Test.Hspec @@ -92,9 +101,18 @@ badgeTests = do it "bounds and strips a code this version does not know" testServiceErrorCodeBounded describe "service protocol JSON" $ do it "redeemBadgeCode request matches the schema" testRedeemRequestJSON + it "purchaseBadge request matches the schema" testPurchaseRequestJSON it "badgeCredential response matches the schema" testCredentialResponseJSON it "error response matches the schema" testErrorResponseJSON it "statement entries round-trip, unknown entry types verbatim" testStatementJSON + describe "store purchases" $ do + it "keys a purchase by the store's transaction id, not by the evidence signed over it" testStoreTransactionRef + it "shows a service request in the terminal as its type alone" testShownServiceRequest + it "refuses for good a Play product id that could name another purchase, before any verifier" testGoogleProductIdPath + it "does not send a Play token that could name another purchase, and leaves it retryable" testGoogleTokenPath + it "has the dev mock vouch for the transaction its claim names, as a production purchase" testMockVouchesForClaim + describe "badge service request loop" $ do + it "survives a request that throws, and still stops when cancelled" testSurviveRequestFailure proofOf :: BadgeProof -> BBSProof proofOf (BadgeProof _ _ p _) = p @@ -682,7 +700,7 @@ testServiceRetryAfter = do badgeErrorRetryAfter BSEInternal `shouldBe` Nothing mapM_ (\code -> badgeErrorRetryAfter code `shouldBe` Nothing) - [BSEBadRequest, BSEUnsupportedVersion, BSEUnknownPurchaseKey, BSECodeInvalid, BSECodeUsed, BSECodeExpired, BSEUnknown "future_code"] + [BSEBadRequest, BSEUnsupportedVersion, BSEUnknownPurchaseKey, BSECodeInvalid, BSECodeUsed, BSECodeExpired, BSEProviderNotConfigured, BSEUnknown "future_code"] -- The app shows the recorded failure in a sentence, so an agent error is stored as the agent -- error and not as the chat error wrapping it, whether or not it can clear on its own. @@ -695,6 +713,8 @@ testIssueFailureClassification = do failureFor timeout `shouldBe` BIFNetwork {agentError = tshow timeout} failureFor auth `shouldBe` BIFUnexpected {message = tshow auth} badgeIssueFailure (ChatError (CECommandError "unexpected badge service response")) `shouldBe` BIFUnexpected {message = "unexpected badge service response"} + badgeIssueFailure (ChatError (CEBadgeRedeemError BREUnknownKeyIndex)) `shouldBe` BIFInvalidCredential + badgeIssueFailure (ChatError (CEBadgeRedeemError BRECredentialNotVerified)) `shouldBe` BIFInvalidCredential -- A refusal the service marks transient is not worth a word before the credential lapses. Internal -- comes without retryAfter so that a failing service is not pressed, not because the fault is @@ -753,12 +773,18 @@ testEntryTypeColumns = do debits = [SDRefund, SDUpgrade k, SDTransferOut k, SDSupport, SDBadge, SDLapse] mapM_ (\c -> wireTag (J.toJSON (SECredit c)) "credit" `shouldBe` Just (creditTypeTag c)) credits mapM_ (\d -> wireTag (J.toJSON (SEDebit d)) "debit" `shouldBe` Just (debitTypeTag d)) debits - -- the three types this version writes survive a round trip through the columns + -- the types this version writes survive a round trip through the columns, a payment credit + -- through the payment its row references mapM_ - (\t -> uncurry3 entryTypeFromColumns (entryTypeColumns t) `shouldSatisfy` sameEntryType t) + (\t -> uncurry3 (entryTypeFromColumns Nothing) (entryTypeColumns t) `shouldSatisfy` sameEntryType t) [SECredit SCCode, SEDebit SDBadge, SEDebit SDLapse] + let storeCredit = SECredit (SCPayment Nothing) + invoiceCredit = SECredit (SCPayment (Just (InvoiceId "inv1"))) + uncurry3 (entryTypeFromColumns (Just Nothing)) (entryTypeColumns storeCredit) `shouldSatisfy` sameEntryType storeCredit + uncurry3 (entryTypeFromColumns (Just (Just (InvoiceId "inv1")))) (entryTypeColumns invoiceCredit) `shouldSatisfy` sameEntryType invoiceCredit -- a type that needs a reference column is not silently read back as something else - uncurry3 entryTypeFromColumns (entryTypeColumns (SECredit (SCCharge "ch1"))) `shouldSatisfy` isNothing + uncurry3 (entryTypeFromColumns Nothing) (entryTypeColumns storeCredit) `shouldSatisfy` isNothing + uncurry3 (entryTypeFromColumns Nothing) (entryTypeColumns (SECredit (SCCharge "ch1"))) `shouldSatisfy` isNothing -- which is why every type is stored as its own JSON as well, and read from that first: the -- columns alone would answer a row naming an invoice or a purchase as no row at all mapM_ roundTrips credits @@ -790,6 +816,106 @@ testRedeemRequestJSON = do `shouldBe` J.object ["version" J..= (1 :: Int), "request" J..= J.object ["type" J..= ("getBadgeCatalog" :: T.Text)]] roundTrips req +testPurchaseRequestJSON :: IO () +testPurchaseRequestJSON = do + drg <- C.newRandom + mk <- generateMasterKey drg + (k, _) <- atomically $ C.generateKeyPair drg :: IO (C.KeyPair 'C.Ed25519) + let payment = SPGoogle {productId = "badge_supporter_01", token = "token"} + req = BadgeServiceRequest {version = Version 1, purchaseKey = Just k, request = BSCPurchaseBadge {masterKey = mk, payment, upgrade = Nothing}} + -- the client states its master key and the store's evidence, and nothing a receipt already decides + J.toJSON req + `shouldBe` J.object + [ "version" J..= (1 :: Int), + "purchaseKey" J..= k, + "request" + J..= J.object + [ "type" J..= ("purchaseBadge" :: T.Text), + "masterKey" J..= mk, + "payment" J..= J.object ["type" J..= ("google" :: T.Text), "productId" J..= ("badge_supporter_01" :: T.Text), "token" J..= ("token" :: T.Text)] + ] + ] + J.toJSON SPApple {jws = "a.b.c"} `shouldBe` J.object ["type" J..= ("apple" :: T.Text), "jws" J..= ("a.b.c" :: T.Text)] + roundTrips req + +testStoreTransactionRef :: IO () +testStoreTransactionRef = do + let jws transactionId signature = T.intercalate "." [part "{\"alg\":\"ES256\"}", part ("{\"transactionId\":\"" <> transactionId <> "\",\"productId\":\"BADGE_SUPPORTER_01\"}"), signature] + part = safeDecodeUtf8 . B64U.encodeUnpadded . encodeUtf8 + apple = storeTransactionRef . SPApple + -- the store may sign the same transaction again, and a retry must find the keys it stashed + apple (jws "2000000812345671" "c2lnbmVkIG9uY2U") `shouldBe` Just (StoreTransactionRef PPApple "2000000812345671") + apple (jws "2000000812345671" "c2lnbmVkIGFnYWlu") `shouldBe` apple (jws "2000000812345671" "c2lnbmVkIG9uY2U") + apple (jws "2000000812345672" "c2lnbmVkIG9uY2U") `shouldNotBe` apple (jws "2000000812345671" "c2lnbmVkIG9uY2U") + apple "not.a-jws" `shouldBe` Nothing + apple (T.intercalate "." [part "{}", part "{\"productId\":\"BADGE_SUPPORTER_01\"}", "sig"]) `shouldBe` Nothing + -- a Play token is a bearer secret, so it is kept only as its hash + let google = storeTransactionRef SPGoogle {productId = "badge_supporter_01", token = "play-token"} + google `shouldSatisfy` maybe False (\(StoreTransactionRef provider ref) -> provider == PPGoogle && ref /= "play-token") + google `shouldBe` storeTransactionRef SPGoogle {productId = "badge_supporter_01", token = "play-token"} + storeTransactionRef SPInvoice {invoiceId = InvoiceId "inv"} `shouldBe` Nothing + +testShownServiceRequest :: IO () +testShownServiceRequest = do + drg <- C.newRandom + mk <- generateMasterKey drg + (k, _) <- atomically $ C.generateKeyPair drg :: IO (C.KeyPair 'C.Ed25519) + let shown request = case J.toJSON BadgeServiceRequest {version = Version 1, purchaseKey = Just k, request} of + J.Object o -> J.Object (shownServiceRequest o) + _ -> J.Null + typeOnly t = J.object ["request" J..= J.object ["type" J..= (t :: T.Text)]] + shown BSCPurchaseBadge {masterKey = mk, payment = SPApple {jws = "a.b.c"}, upgrade = Nothing} `shouldBe` typeOnly "purchaseBadge" + shown BSCRedeemBadgeCode {masterKey = mk, code = "SB-00000-00000-00000-00001"} `shouldBe` typeOnly "redeemBadgeCode" + +testGoogleProductIdPath :: IO () +testGoogleProductIdPath = do + let refused productId = case toStoreReceipt uncalledVerifier SPGoogle {productId, token = validPlayToken} of + Just (Left SRInvalid {}) -> True + _ -> False + mapM_ (\p -> refused p `shouldBe` True) ["badge_legend_01/tokens/other?", "badge_legend_01?x", "badge_legend_01#x", "..", "../badge_legend_01", "Badge_legend_01", ""] + case toStoreReceipt uncalledVerifier SPGoogle {productId = "badge_supporter_01", token = validPlayToken} of + Just (Right StoreReceipt {txRef = StoreTransactionRef {provider}}) -> provider `shouldBe` PPGoogle + _ -> expectationFailure "a valid product id and token were refused" + +testGoogleTokenPath :: IO () +testGoogleTokenPath = do + let unsent token = case toStoreReceipt uncalledVerifier SPGoogle {productId = "badge_supporter_01", token} of + Just (Left SRUnreachable {}) -> True + _ -> False + mapM_ (\t -> unsent t `shouldBe` True) ["a/b", "../x", "t?x", "t#x", "t x", ""] + +uncalledVerifier :: StoreVerifier +uncalledVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Just $ \_ _ -> error "verifier called", verifyTimeout = 500000} + +validPlayToken :: T.Text +validPlayToken = "fake-play-token.AO-J1Oz9x2kqE7wYt3" + +testMockVouchesForClaim :: IO () +testMockVouchesForClaim = do + let part = safeDecodeUtf8 . B64U.encodeUnpadded . encodeUtf8 + signed = T.intercalate "." [part "{\"alg\":\"ES256\"}", part "{\"transactionId\":\"2000000812345671\",\"productId\":\"BADGE_SUPPORTER_01\"}", "c2lnbmVk"] + vouchesForClaim payment = case toStoreReceipt mockStoreVerifier payment of + Just (Right StoreReceipt {txRef = StoreTransactionRef {transactionRef = providerRef}, verifyReceipt}) -> + verifyReceipt >>= \case + Right VerifiedStoreTransaction {transactionRef, testPurchase} -> (transactionRef, testPurchase) `shouldBe` (providerRef, False) + Left refusal -> expectationFailure ("the mock refused: " <> show refusal) + _ -> expectationFailure "refused before the mock was asked" + vouchesForClaim SPApple {jws = signed} + vouchesForClaim SPGoogle {productId = "badge_supporter_01", token = "fake-play-token.AO-J1Oz9x2kqE7wYt3"} + +testSurviveRequestFailure :: IO () +testSurviveRequestFailure = do + survive "a request" (throwIO $ userError "failed") `shouldReturn` () + started <- newEmptyMVar + stopped <- newEmptyMVar + t <- forkIO $ survive "a request" (putMVar started () >> threadDelay 10000000) `catch` (putMVar stopped . asyncException) + takeMVar started + killThread t + takeMVar stopped `shouldReturn` True + where + asyncException :: SomeException -> Bool + asyncException e = isJust (fromException e :: Maybe SomeAsyncException) + testCredentialResponseJSON :: IO () testCredentialResponseJSON = do Right (_, sk) <- bbsKeyGen diff --git a/tests/Bots/BadgeService/BotTests.hs b/tests/Bots/BadgeService/BotTests.hs index c11af7f4d1..93b24fd427 100644 --- a/tests/Bots/BadgeService/BotTests.hs +++ b/tests/Bots/BadgeService/BotTests.hs @@ -4,6 +4,7 @@ {-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE PostfixOperators #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE TupleSections #-} {-# OPTIONS_GHC -fno-warn-ambiguous-fields #-} @@ -12,9 +13,12 @@ module Bots.BadgeService.BotTests where import BadgeService.Config (BadgeIssuerKey (..), readServiceConfig) import Bots.BadgeService.ConfigTests (withIssuer) +import Bots.BadgeService.FakeStore import BadgeService.Options import BadgeService.Service +import BadgeService.Store (NewStorePurchase (..), createStorePurchase) import BadgeService.Store.Invoices (markCodePaid) +import BadgeService.StoreReceipts (StoreRefusal (..), StoreVerifier (..), noStoreVerifier) import Simplex.Messaging.Agent.Store.DB (Binary (..)) import qualified Simplex.Messaging.Agent.Store.DB as DB import ChatClient @@ -27,10 +31,12 @@ import Control.Exception (finally) import qualified Data.Aeson as J import Data.ByteString.Char8 (ByteString) import qualified Data.ByteString.Char8 as B +import qualified Data.ByteString.Lazy.Char8 as LB import Data.Char (toLower) import Data.Either (isLeft, isRight) import Data.Int (Int64) -import Data.IORef (IORef, newIORef, readIORef, writeIORef) +import Data.IORef (IORef, modifyIORef', newIORef, readIORef, writeIORef) +import Data.List (isPrefixOf, stripPrefix) import qualified Data.Map.Strict as M import Data.Maybe (isJust, isNothing) import Data.String (fromString) @@ -39,15 +45,19 @@ import Data.Text (Text) import qualified Data.Text as T import Data.Time.Clock (NominalDiffTime, UTCTime, addUTCTime, diffUTCTime, getCurrentTime, nominalDay) import Data.Time.Format (defaultTimeLocale, formatTime) +import Data.Word (Word32) import Simplex.Chat.Badges (BadgeCredential (..), BadgeInfo (..), BadgeMasterKey, BadgeType (..), generateMasterKey) import Simplex.Chat.Badges.Code (BadgeCode, badgeCodeHash, badgeCodeText, formatBadgeCode, parseBadgeCode, randomBadgeCode) -import Simplex.Chat.Badges.Ledger (addMonths, creditTypeTag, debitTypeTag, endOfMondayAfter) +import Simplex.Chat.Badges.Ledger (addMonths, creditTypeTag, debitTypeTag, emptyEntry, endOfMondayAfter) import Simplex.Chat.Badges.Service import Simplex.Chat.Bot.Store (withDB') import Simplex.Chat.Controller (ChatConfig (..), ChatController (..), ChatResponse (CRCustomChatResponse)) import Simplex.Chat.Core (sendChatCmdStr) import Simplex.Chat.Options (CoreChatOpts (..)) import Simplex.Chat.Options.DB +import Simplex.Chat.PaymentService (ServicePayment (..)) +import Simplex.Chat.PaymentService.Types (InvoiceId (..), PaymentProvider (..)) +import Simplex.Chat.Store.Badges (getNextHeldStoreReceipt) import Simplex.Messaging.Agent.Env.SQLite (AgentConfig (..)) import Simplex.Messaging.Agent.RetryInterval (RetryInterval (..)) import Simplex.Messaging.Agent.Store.Common (withTransaction) @@ -106,6 +116,56 @@ badgeServiceTests = do it "should renew a badge on a profile that is not active, without switching to it" testRenewalKeepsActiveProfile it "should broadcast the current profile when a renewal presents a badge" testRenewalKeepsProfileEdits it "should present the month already issued when a previous pass did not" testPresentationCatchesUp + describe "store purchases" $ do + describe "what the store answers" $ do + it "should credit the months a store receipt paid for and issue the first" testStorePurchase + it "should return the same credential for a receipt its key presents again, writing nothing" testStorePurchaseReplay + it "should refuse a receipt another key was credited with" testStoreReceiptUsed + it "should refuse a receipt the store does not vouch for, with no retry" testStoreReceiptInvalid + it "should answer a store it cannot reach as retryable, writing nothing" testStoreUnreachable + it "should write nothing for a pending purchase, and credit it once when it settles" testStorePending + it "should refuse a product that grants no badge" testStoreUnknownProduct + it "should refuse a store purchase that carries an upgrade" testStoreUpgradeRefused + it "should grant the badge of the product the receipt proves" testStoreBadgeTypeFromProduct + it "should keep refusing invoice and receipt funding" testNonStoreFundingRefused + it "should replay a receipt to its own key while the store is down, and to no other" testStoreReplayWhileStoreDown + it "should answer a throwing Apple verifier as internal, and a failing or hanging Google one as retryable" testStoreVerifierFailures + describe "claim races" $ do + it "should credit a transaction claimed twice at once only once" testStoreClaimRace + it "should answer a request that lost the claim race with the credential the winner was given" testStorePurchaseRace + it "should refuse as receipt_used a key that lost the claim race to another key, crediting nothing" testStorePurchaseRaceOtherKey + describe "the service's own checks" $ do + it "should refuse a store with no verifier with no retry, and the client should hold the receipt, showing why it is not credited" testPurchaseWithNoVerifier + it "should credit nothing when the verified transaction is not the one the evidence names" testStoreVerifiedOtherTransaction + it "should refuse a verified quantity other than one as internal, and the client should hold the receipt" testStoreQuantityRefused + it "should refuse a store purchase whose purchaseKey is not the verified signer" testStorePurchaseKeyMismatch + describe "the hand-over" $ do + it "should hold a Play receipt until the worker credits it, and answer it as credited after" testPurchaseBadge + it "should credit an App Store purchase by its JWS" testPurchaseBadgeAppStore + it "should keep a refusal on the record, and hold a pending receipt until it settles" testPurchaseStash + it "should keep a receipt credited to another key as refused" testPurchaseStashReceiptUsed + it "should hold a Play token the service will not send to Play" testPurchaseUnsentPlayToken + it "should hold a store receipt while a badge is held, without attempting it" testPurchaseWhileBadgeHeld + it "should answer a receipt handed over under a second profile as the profile that bought it" testPurchaseSameReceiptOtherProfile + it "should credit a purchase first handed over under another profile to that profile" testPurchaseStrandedUnderOtherProfile + it "should credit a purchase to a hidden profile without naming it" testPurchaseDeliveredToHiddenProfile + describe "invoice first" $ do + it "should credit a receipt to the profile that created its invoice, and answer as that profile" testInvoiceOtherProfile + it "should resolve the same receipt to the same record, and answer it as credited" testInvoiceSameReceiptTwice + it "should credit a receipt naming an unknown invoice to the presenting profile" testInvoiceUnknown + it "should attach a late receipt to its record, and credit the profile that created it" testInvoiceLateReceipt + it "should list a record however old until a receipt reaching it is settled" testInvoiceAgedOut + it "should refuse an invoice with no service configured or while a badge is held, creating no record" testInvoiceRefusedBeforeCharge + it "should hold a receipt for an invoice while a badge is held, without attempting it" testInvoiceWhileBadgeHeld + it "should list only the asking profile's open store purchases" testInvoiceStateOtherProfile + describe "the receipt worker" $ do + it "should retry a receipt the service could not verify, and credit it with no trigger at all" testStoreReceiptRetried + it "should credit a second receipt while an earlier one waits for the store" testStoreReceiptNotBlocked + it "should answer a refused receipt from the record, sending nothing, and not list it" testStoreRefusalKept + it "should announce a settlement to an owner that is not active, and print nothing for a hidden one" testStoreSettledOtherProfile + it "should resolve one new transaction handed over twice at once to one record" testStoreReceiptTwoAtOnce + it "should delete a month-old record that will fund no badge, and keep held and credited ones" testStoreReceiptCleanup + it "should keep a receipt whose attempt throws" testStoreReceiptAttemptThrows badgeProfile :: Profile badgeProfile = Profile {displayName = "SimpleX Badges", fullName = "", shortDescr = Nothing, description = Nothing, image = Nothing, contactLink = Nothing, peerType = Just CPTBot, preferences = Nothing, badge = Nothing, contactDomain = Nothing} @@ -157,7 +217,9 @@ data BadgeServiceEnv = BadgeServiceEnv bsClock :: TestClock, bsClientCfg :: ChatConfig, bsAddress :: String, - bsController :: ChatController + bsController :: ChatController, + bsStore :: FakeStore, + bsVerifier :: StoreVerifier } -- | Stop the service for good: requests sent after it go unanswered until they time out. Stopping @@ -170,13 +232,18 @@ withBadgeService ps test = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsAddress, bsController} -> test bsClientCfg bsAddress bsController withBadgeServiceEnv :: HasCallStack => TestParams -> (BadgeServiceEnv -> IO ()) -> IO () -withBadgeServiceEnv ps test = do +withBadgeServiceEnv ps = withBadgeServiceVerifier ps fakeVerifier + +withBadgeServiceVerifier :: HasCallStack => TestParams -> (FakeStore -> StoreVerifier) -> (BadgeServiceEnv -> IO ()) -> IO () +withBadgeServiceVerifier ps verifierOf test = do Right (pk, sk) <- bbsKeyGen clock <- newTestClock + store <- newFakeStore let opts = mkBadgeServiceOpts ps sk svcCfg = testCfg {badgePublicKeys = M.singleton testIssuerKeyIdx pk, badgeCurrentTime = testClockTime clock} + verifier = verifierOf store withNewTestChatCfg ps testCfg serviceDbPrefix badgeProfile $ \_ -> pure () - runBadgeService svcCfg opts $ \_ -> pure () + runBadgeService verifier svcCfg opts $ \_ -> pure () bsLink <- withTestChat ps serviceDbPrefix $ \bs -> do bs <## "subscribed 1 connections on server localhost" bs ##> "/sa" @@ -185,9 +252,9 @@ withBadgeServiceEnv ps test = do pure sLink let clientCfg = svcCfg {badgeServiceAddress = Just $ either (error . ("bad badge service address: " <>)) id $ strDecode (B.pack bsLink)} - runBadgeService svcCfg opts $ \env -> do + runBadgeService verifier svcCfg opts $ \env -> do cc <- atomically $ readTMVar $ serviceCC env - test BadgeServiceEnv {bsIssuerKey = BadgeIssuerKey {keyIdx = testIssuerKeyIdx, secretKey = sk}, bsClock = clock, bsClientCfg = clientCfg, bsAddress = bsLink, bsController = cc} + test BadgeServiceEnv {bsIssuerKey = BadgeIssuerKey {keyIdx = testIssuerKeyIdx, secretKey = sk}, bsClock = clock, bsClientCfg = clientCfg, bsAddress = bsLink, bsController = cc, bsStore = store, bsVerifier = verifier} issueCode :: HasCallStack => ChatController -> BadgeType -> Int -> IO BadgeCode issueCode cc badgeType months = issueCodeAs cc badgeType months "free" @@ -208,9 +275,9 @@ issueCodeAs cc badgeType months status = r -> error $ "issue failed: " <> show (() <$ r) -- | The post-start hook fills serviceCC once the address exists, so the test waits on it rather than on a fixed delay that would race with startup and let one start's address output arrive during the next test. -runBadgeService :: ChatConfig -> BadgeServiceOpts -> (ServiceState -> IO ()) -> IO () -runBadgeService cfg opts action = do - env <- newServiceState +runBadgeService :: StoreVerifier -> ChatConfig -> BadgeServiceOpts -> (ServiceState -> IO ()) -> IO () +runBadgeService verifier cfg opts action = do + env <- (\s -> s {storeVerifier = verifier}) <$> newServiceState t <- forkIO $ badgeService opts cfg env ready <- timeout 30000000 $ atomically $ readTMVar $ serviceCC env when (isNothing ready) $ killThread t >> error "badge service did not start" @@ -276,10 +343,10 @@ testRedeemUnknownCode ps = g <- C.newRandom unknown <- randomBadgeCode g alice ##> ("/_redeem_badge_code 1 " <> codeArg unknown) - alice <## "cannot redeem badge code: badge service error: code_invalid" + alice <## "cannot get badge: badge service error: code_invalid" -- a failed check character is refused before anything leaves the device alice ##> "/_redeem_badge_code 1 SB-00000-00000-00000-00001" - alice <## "cannot redeem badge code: invalid code" + alice <## "cannot get badge: invalid code" -- sent straight to the service, past the client's own check, the two are one answer (_, redeemPriv) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) redeemDirect alice bsLink redeemPriv (T.unpack $ badgeCodeText unknown) @@ -330,7 +397,7 @@ testRedeemSecondCode ps = alice <## "supporter badge - active" alice <##. "expires " alice ##> ("/_redeem_badge_code 1 " <> codeArg legend) - alice <## "cannot redeem badge code: badge already active" + alice <## "cannot get badge: badge already active" alice ##> "/p" showActiveUser alice "alice (Alice, * supporter)" alice ##> "/create user alisa" @@ -352,15 +419,15 @@ testRedeemSameCodeOtherProfile ps = alice ##> "/create user alisa" showActiveUser alice "alisa" alice ##> ("/_redeem_badge_code 2 " <> codeArg code) - alice <## "cannot redeem badge code: badge service error: code_used" + alice <## "cannot get badge: badge service error: code_used" alice ##> "/p" showActiveUser alice "alisa" alice ##> "/user alice" showActiveUser alice "alice (Alice, * supporter)" serviceCmd :: HasCallStack => BadgeServiceEnv -> C.PublicKeyEd25519 -> BadgeServiceCommand -> IO BadgeServiceResponse -serviceCmd BadgeServiceEnv {bsIssuerKey, bsController} purchaseKey request = - badgeServiceResponse bsIssuerKey bsController (Just purchaseKey) reqObject +serviceCmd BadgeServiceEnv {bsIssuerKey, bsController, bsVerifier} purchaseKey request = + badgeServiceResponse bsIssuerKey bsVerifier bsController (Just purchaseKey) reqObject where reqObject = case J.toJSON BadgeServiceRequest {version = currentBadgeServiceVersion, purchaseKey = Just purchaseKey, request} of J.Object o -> o @@ -1267,7 +1334,7 @@ testRedeemUnpaidCode ps = withNewTestChatCfg ps clientCfg "alice" aliceProfile $ \alice -> do unpaid <- issueCodeAs cc BTSupporter 1 "unpaid" alice ##> ("/_redeem_badge_code 1 " <> codeArg unpaid) - alice <## "cannot redeem badge code: badge service error: payment_pending" + alice <## "cannot get badge: badge service error: payment_pending" paid <- issueCodeAs cc BTSupporter 1 "paid" alice ##> ("/_redeem_badge_code 1 " <> codeArg paid) alice <## "badge redeemed" @@ -1284,7 +1351,7 @@ testExpiredCode ps = withDB' "markCodePaid" cc (\db -> markCodePaid db (badgeCodeHash code) (addUTCTime (-60) now)) `shouldReturn` Right () alice ##> ("/_redeem_badge_code 1 " <> codeArg code) - alice <## "cannot redeem badge code: badge service error: code_expired" + alice <## "cannot get badge: badge service error: code_expired" testRedeemedBeforeTheDeadline :: HasCallStack => TestParams -> IO () testRedeemedBeforeTheDeadline ps = @@ -1338,6 +1405,784 @@ testRevokedCode ps = paid <- issueCodeAs cc BTSupporter 1 "paid" revokeCodeAs cc paid `shouldReturn` "revoked" alice ##> ("/_redeem_badge_code 1 " <> codeArg paid) - alice <## "cannot redeem badge code: badge service error: code_invalid" + alice <## "cannot get badge: badge service error: code_invalid" second <- revokeCodeAs cc paid second `shouldSatisfy` T.isInfixOf "revoked already" + +purchaseCmd :: BadgeMasterKey -> ServicePayment -> BadgeServiceCommand +purchaseCmd masterKey payment = BSCPurchaseBadge {masterKey, payment, upgrade = Nothing} + +supporterPlay :: ServicePayment +supporterPlay = googlePayment "badge_supporter_01" googleSupporterToken + +paymentArg :: ServicePayment -> String +paymentArg = LB.unpack . J.encode + +refusalOf :: HasCallStack => BadgeServiceResponse -> (BadgeServiceErrorCode, Maybe Word32) +refusalOf = \case + BSPError {code, retryAfter} -> (code, retryAfter) + r -> error $ "expected an error, got " <> show (J.toJSON r) + +badgeTypeOf :: HasCallStack => BadgeServiceResponse -> Maybe BadgeType +badgeTypeOf r = (\(BadgeCredential _ _ _ BadgeInfo {badgeType}) -> badgeType) <$> credentialOf r + +rowCount :: ChatController -> String -> IO Int +rowCount ChatController {chatStore} table = + withTransaction chatStore $ \db -> do + [Only n] <- DB.query_ db $ fromString $ "SELECT COUNT(*) FROM " <> table + pure n + +-- | Each store payment's provider, amount and currency, and the ledger rows that name it. +storePayments :: ChatController -> IO [(Text, Maybe Int, Maybe Text, Int)] +storePayments ChatController {chatStore} = + withTransaction chatStore $ \db -> + DB.query_ db . fromString $ + "SELECT pay.provider, pay.amount, pay.currency, COUNT(l.entry_id) FROM sx_badge_service_payments pay " + <> "LEFT JOIN sx_badge_service_badge_ledger l ON l.payment_id = pay.payment_id " + <> "GROUP BY pay.payment_id, pay.provider, pay.amount, pay.currency ORDER BY pay.provider" + +nothingPurchased :: HasCallStack => ChatController -> IO () +nothingPurchased cc = do + rowCount cc "sx_badge_service_payments" `shouldReturn` 0 + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 0 + +testStorePurchase :: HasCallStack => TestParams -> IO () +testStorePurchase ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + purchased <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + let (entries, previousEntryId) = statementOf purchased + previousEntryId `shouldBe` Nothing + map entryTag entries `shouldBe` ["payment", "badge"] + map (\e -> let (c, m, _) = entryOf e in (c, m)) entries `shouldBe` [(1, 1), (-1, 0)] + badgeTypeOf purchased `shouldBe` Just BTSupporter + masterKeyOf purchased `shouldBe` Just masterKey + map (\(_, c, m, _, _, t) -> (c, m, t)) <$> ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` [(1, 1, Just "payment"), (-1, 0, Just "badge")] + -- Play reports no price, and only the credit names the payment + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + +testStorePurchaseReplay :: HasCallStack => TestParams -> IO () +testStorePurchaseReplay ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + purchased <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + ledger <- ledgerRows cc "sx_badge_service_badge_ledger" + replayed <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + credentialOf replayed `shouldBe` credentialOf purchased + map entryTag (fst $ statementOf replayed) `shouldBe` map entryTag (fst $ statementOf purchased) + ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStoreReceiptUsed :: HasCallStack => TestParams -> IO () +testStoreReceiptUsed ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (firstKey, firstMasterKey) <- newPurchaseKeys + _ <- serviceCmd env firstKey $ purchaseCmd firstMasterKey supporterPlay + ledger <- ledgerRows cc "sx_badge_service_badge_ledger" + (otherKey, otherMasterKey) <- newPurchaseKeys + used <- serviceCmd env otherKey $ purchaseCmd otherMasterKey supporterPlay + refusalOf used `shouldBe` (BSEReceiptUsed, Nothing) + ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStoreReceiptInvalid :: HasCallStack => TestParams -> IO () +testStoreReceiptInvalid ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = FakeStore {appleSandboxJWS}} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + let refused payment = refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey payment) + refused (googlePayment "badge_supporter_01" "not-a-purchase") `shouldReturn` (BSEReceiptInvalid, Nothing) + refused SPApple {jws = "not.a.jws"} `shouldReturn` (BSEReceiptInvalid, Nothing) + -- refused by the service, which the store would have vouched for + refused SPApple {jws = appleSandboxJWS} `shouldReturn` (BSEReceiptInvalid, Nothing) + nothingPurchased cc + +testStoreUnreachable :: HasCallStack => TestParams -> IO () +testStoreUnreachable ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + unreachable <- serviceCmd env purchaseKey $ purchaseCmd masterKey $ googlePayment "badge_supporter_01" googleUnreachableToken + refusalOf unreachable `shouldSatisfy` \(code, retryAfter) -> code == BSEProviderUnavailable && isJust retryAfter + nothingPurchased cc + +testStorePending :: HasCallStack => TestParams -> IO () +testStorePending ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = store} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + let unsettled = purchaseCmd masterKey $ googlePayment "badge_supporter_01" googlePendingToken + waiting <- serviceCmd env purchaseKey unsettled + refusalOf waiting `shouldSatisfy` \(code, retryAfter) -> code == BSEPaymentPending && isJust retryAfter + nothingPurchased cc + settlePending store + settled <- serviceCmd env purchaseKey unsettled + badgeTypeOf settled `shouldBe` Just BTSupporter + again <- serviceCmd env purchaseKey unsettled + credentialOf again `shouldBe` credentialOf settled + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + +testStoreUnknownProduct :: HasCallStack => TestParams -> IO () +testStoreUnknownProduct ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + -- a real purchase of a subscription, whose renewals nothing adds to a badge yet + subscription <- serviceCmd env purchaseKey $ purchaseCmd masterKey $ googlePayment "subscr_badge_supporter_01" googleSubscriptionToken + refusalOf subscription `shouldBe` (BSEProductUnavailable, Nothing) + nothingPurchased cc + +testStoreUpgradeRefused :: HasCallStack => TestParams -> IO () +testStoreUpgradeRefused ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + g <- C.newRandom + (fromPurchaseKey, fromPriv) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) + now <- getCurrentTime + let upgrade = BadgeUpgrade {fromPurchaseKey, receipt = "receipt", receiptSignature = C.sign' fromPriv "receipt", balance = BadgeBalance {lastEntry = emptyEntry now BTSupporter}} + upgraded <- serviceCmd env purchaseKey BSCPurchaseBadge {masterKey, payment = supporterPlay, upgrade = Just upgrade} + refusalOf upgraded `shouldBe` (BSEBadRequest, Nothing) + nothingPurchased cc + +testStoreBadgeTypeFromProduct :: HasCallStack => TestParams -> IO () +testStoreBadgeTypeFromProduct ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = FakeStore {appleLegendJWS}} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + legend <- serviceCmd env purchaseKey $ purchaseCmd masterKey SPApple {jws = appleLegendJWS} + badgeTypeOf legend `shouldBe` Just BTLegend + map (\StatementEntry {balanceBadgeType} -> balanceBadgeType) (fst $ statementOf legend) `shouldBe` [BTLegend, BTLegend] + storePayments cc `shouldReturn` [("apple", Just 7000, Just "USD", 1)] + +testNonStoreFundingRefused :: HasCallStack => TestParams -> IO () +testNonStoreFundingRefused ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + invoice <- serviceCmd env purchaseKey $ purchaseCmd masterKey SPInvoice {invoiceId = InvoiceId "inv"} + refusalOf invoice `shouldBe` (BSEUnknownPurchaseKey, Nothing) + transfer <- serviceCmd env purchaseKey $ purchaseCmd masterKey SPReceipt {receipt = "receipt"} + refusalOf transfer `shouldBe` (BSEUnknownPurchaseKey, Nothing) + nothingPurchased cc + +testStoreReplayWhileStoreDown :: HasCallStack => TestParams -> IO () +testStoreReplayWhileStoreDown ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = store} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + purchased <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + ledger <- ledgerRows cc "sx_badge_service_badge_ledger" + setGoogleDown store True + -- the key it was credited to is answered from the record + replayed <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + credentialOf replayed `shouldBe` credentialOf purchased + -- any other key waits for the store, or the answer would tell it which purchases were credited + (otherKey, otherMasterKey) <- newPurchaseKeys + other <- serviceCmd env otherKey $ purchaseCmd otherMasterKey supporterPlay + fst (refusalOf other) `shouldBe` BSEProviderUnavailable + ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger + +testStoreVerifierFailures :: HasCallStack => TestParams -> IO () +testStoreVerifierFailures ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = FakeStore {appleThrowingJWS}} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + let answer payment = refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey payment) + -- Apple is checked offline, so a verifier that throws was answered by nothing but its own bug + answer SPApple {jws = appleThrowingJWS} `shouldReturn` (BSEInternal, Nothing) + answer (googlePayment "badge_supporter_01" googleThrowingToken) >>= (`shouldSatisfy` \(code, retryAfter) -> code == BSEProviderUnavailable && isJust retryAfter) + answer (googlePayment "badge_supporter_01" googleHangingToken) >>= (`shouldSatisfy` \(code, retryAfter) -> code == BSEProviderUnavailable && isJust retryAfter) + nothingPurchased cc + +testStoreVerifiedOtherTransaction :: HasCallStack => TestParams -> IO () +testStoreVerifiedOtherTransaction ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = FakeStore {appleMisnamedJWS}} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey SPApple {jws = appleMisnamedJWS}) `shouldReturn` (BSEInternal, Nothing) + nothingPurchased cc + +testStoreQuantityRefused :: HasCallStack => TestParams -> IO () +testStoreQuantityRefused ps = + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsClientCfg, bsController = cc, bsStore = FakeStore {appleQuantityJWS}} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey SPApple {jws = appleQuantityJWS}) `shouldReturn` (BSEInternal, Nothing) + nothingPurchased cc + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleQuantityJWS}) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error final internal" + heldStoreReceipts (chatController alice) `shouldReturn` 1 + nothingPurchased cc + +testPurchaseWithNoVerifier :: HasCallStack => TestParams -> IO () +testPurchaseWithNoVerifier ps = + withBadgeServiceVerifier ps (const noStoreVerifier) $ \env@BadgeServiceEnv {bsClientCfg, bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey supporterPlay) `shouldReturn` (BSEProviderNotConfigured, Nothing) + nothingPurchased cc + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + storePurchaseOpen alice "" + -- not yet rather than never, so the receipt stays held for the retry once a verifier is deployed + waitStoreReceiptError (chatController alice) "service_error final provider_not_configured" + heldStoreReceipts (chatController alice) `shouldReturn` 1 + alice ##> "/_badge state 1" + alice .<## ", not credited: service_error final provider_not_configured" + +testStoreClaimRace :: HasCallStack => TestParams -> IO () +testStoreClaimRace ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsController = cc} -> do + (firstKey, firstMasterKey) <- newPurchaseKeys + (otherKey, otherMasterKey) <- newPurchaseKeys + now <- getCurrentTime + let claim paymentId purchaseKey masterKey = + withDB' "claim" cc $ \db -> + createStorePurchase db NewStorePurchase {paymentId, provider = PPGoogle, providerRef = "ref", paid = Nothing, purchaseKey, masterKey, badgeType = BTSupporter} now + -- the second insert meets the first's claim, as a request that read before the first wrote would + claim "p1" firstKey firstMasterKey >>= (`shouldSatisfy` either (const False) isJust) + claim "p2" otherKey otherMasterKey `shouldReturn` Right Nothing + rowCount cc "sx_badge_service_payments" `shouldReturn` 1 + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStorePurchaseRace :: HasCallStack => TestParams -> IO () +testStorePurchaseRace ps = do + hook <- newIORef (pure ()) + withBadgeServiceVerifier ps (googleVerifierWithHook hook) $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + winner <- newIORef Nothing + -- the same purchase is presented again while the first is with the store, and credited first + writeIORef hook $ serviceCmd env purchaseKey (purchaseCmd masterKey supporterPlay) >>= writeIORef winner . Just + raced <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + Just credited <- readIORef winner + credentialOf credited `shouldSatisfy` isJust + credentialOf raced `shouldBe` credentialOf credited + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStorePurchaseRaceOtherKey :: HasCallStack => TestParams -> IO () +testStorePurchaseRaceOtherKey ps = do + hook <- newIORef (pure ()) + withBadgeServiceVerifier ps (googleVerifierWithHook hook) $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + (otherKey, otherMasterKey) <- newPurchaseKeys + winner <- newIORef Nothing + -- another key presents the same purchase while the first is with the store, and is credited first + writeIORef hook $ serviceCmd env otherKey (purchaseCmd otherMasterKey supporterPlay) >>= writeIORef winner . Just + raced <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay + refusalOf raced `shouldBe` (BSEReceiptUsed, Nothing) + Just credited <- readIORef winner + masterKeyOf credited `shouldBe` Just otherMasterKey + ledger <- ledgerRows cc "sx_badge_service_badge_ledger" + replayed <- serviceCmd env otherKey $ purchaseCmd otherMasterKey supporterPlay + credentialOf replayed `shouldBe` credentialOf credited + ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStorePurchaseKeyMismatch :: HasCallStack => TestParams -> IO () +testStorePurchaseKeyMismatch ps = + withBadgeService ps $ \clientCfg bsLink cc -> + withNewTestChatCfg ps clientCfg "alice" aliceProfile $ \alice -> do + g <- C.newRandom + (_, signPriv) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) + (claimedPub, _) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) + let signKey = B.unpack $ strEncode (C.StoredPrivateKey signPriv) + claimed = B.unpack $ strEncode claimedPub + req = + "{\"version\":1,\"purchaseKey\":\"" <> claimed + <> "\",\"request\":{\"type\":\"purchaseBadge\",\"masterKey\":\"" <> testMasterKeyB64 + <> "\",\"payment\":" <> paymentArg supporterPlay <> "}}" + alice ##> ("/_service_request 1 " <> bsLink <> " sign_key=" <> signKey <> " " <> req) + alice <## "service response: {\"code\":\"bad_request\",\"type\":\"error\"}" + nothingPurchased cc + +testPurchaseBadge :: HasCallStack => TestParams -> IO () +testPurchaseBadge ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + let purchase = "/_badge purchase 1 " <> paymentArg supporterPlay + alice ##> purchase + inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + -- the app hands a purchase over until it is answered credited, and one already credited adds nothing + alice ##> purchase + alice <## "badge already redeemed" + alice ##> "/p" + alice <## "user profile: alice (Alice, * supporter)" + alice <## "use /p [] to change it" + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + map (\(_, c, m, _, _, t) -> (c, m, t)) <$> ledgerRows (chatController alice) "badge_ledger" `shouldReturn` [(1, 1, Just "payment"), (-1, 0, Just "badge")] + +testPurchaseBadgeAppStore :: HasCallStack => TestParams -> IO () +testPurchaseBadgeAppStore ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc, bsStore = FakeStore {appleLegendJWS}} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleLegendJWS}) + inAnyOrder alice [[openPurchase ""], creditedLines "" "1: legend"] + storePayments cc `shouldReturn` [("apple", Just 7000, Just "USD", 1)] + +testPurchaseStash :: HasCallStack => TestParams -> IO () +testPurchaseStash ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + let records = rowCount (chatController alice) "badge_store_receipts" + refused = "/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase") + -- the store does not vouch for it, so it can never be credited, and the record says so + alice ##> refused + inAnyOrder alice [[openPurchase ""], ["store purchase resolved"]] + alice ##> refused + alice <## "cannot get badge: badge service error: receipt_invalid" + records `shouldReturn` 1 + heldStoreReceipts (chatController alice) `shouldReturn` 0 + -- no store transaction to key a record by, so nothing is held or sent + alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = "not.a-jws"}) + alice <## "cannot get badge: invalid store receipt" + records `shouldReturn` 1 + nothingPurchased cc + -- pending keeps the receipt held + alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" googlePendingToken)) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error retry payment_pending" + records `shouldReturn` 2 + heldStoreReceipts (chatController alice) `shouldReturn` 1 + nothingPurchased cc + +testPurchaseStashReceiptUsed :: HasCallStack => TestParams -> IO () +testPurchaseStashReceiptUsed ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> + withNewTestChatCfg ps bsClientCfg "bob" bobProfile $ \bob -> do + let purchase = "/_badge purchase 1 " <> paymentArg supporterPlay + alice ##> purchase + inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + bob ##> purchase + inAnyOrder bob [[openPurchase ""], ["store purchase resolved"]] + bob ##> purchase + bob <## "cannot get badge: badge service error: receipt_used" + storeReceiptRows (chatController bob) `shouldReturn` [(1, Nothing, True)] + heldStoreReceipts (chatController bob) `shouldReturn` 0 + rowCount (chatController alice) "badge_store_receipts" `shouldReturn` 1 + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + bob ##> "/p" + showActiveUser bob "bob (Bob)" + +testPurchaseUnsentPlayToken :: HasCallStack => TestParams -> IO () +testPurchaseUnsentPlayToken ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "token/other")) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error retry provider_unavailable" + heldStoreReceipts (chatController alice) `shouldReturn` 1 + nothingPurchased cc + +testPurchaseWhileBadgeHeld :: HasCallStack => TestParams -> IO () +testPurchaseWhileBadgeHeld ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + code <- issueCode cc BTSupporter 1 + redeemFirstBadge alice code + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + alice <##. "1: supporter" + storePurchaseOpen alice "" + storeReceiptDue (chatController alice) 1 `shouldReturn` False + heldStoreReceipts (chatController alice) `shouldReturn` 1 + rowCount cc "sx_badge_service_payments" `shouldReturn` 0 + +testPurchaseSameReceiptOtherProfile :: HasCallStack => TestParams -> IO () +testPurchaseSameReceiptOtherProfile ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + alice ##> "/create user alisa" + showActiveUser alice "alisa" + -- the store transaction is the device's, so it stays with the profile it was bought under + alice ##> ("/_badge purchase 2 " <> paymentArg supporterPlay) + alice <## "[user: alice] badge already redeemed" + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + alice ##> "/p" + showActiveUser alice "alisa" + +testPurchaseStrandedUnderOtherProfile :: HasCallStack => TestParams -> IO () +testPurchaseStrandedUnderOtherProfile ps = do + broken <- newIORef True + withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do + let purchase userId = "/_badge purchase " <> show (userId :: Int) <> " " <> paymentArg supporterPlay + alice ##> purchase 1 + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error final internal" + alice ##> "/create user alisa" + showActiveUser alice "alisa" + -- handed over again under whichever profile is active, the purchase stays with the keys alice holds + alice ##> purchase 2 + storePurchaseOpen alice "[user: alice] " + writeIORef broken False + mapM_ (alice <##.) $ creditedLines "[user: alice] " "1: supporter" + (alice "/user alice" + showActiveUser alice "alice (Alice, * supporter)" + +testPurchaseDeliveredToHiddenProfile :: HasCallStack => TestParams -> IO () +testPurchaseDeliveredToHiddenProfile ps = do + broken <- newIORef True + withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do + let purchase userId = "/_badge purchase " <> show (userId :: Int) <> " " <> paymentArg supporterPlay + alice ##> purchase 1 + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error final internal" + alice ##> "/create user alisa" + showActiveUser alice "alisa" + alice ##> "/_hide user 1 \"password\"" + alice <## "user alice:" + alice <## "messages are hidden (use /tail to view)" + alice <## "profile is hidden" + -- the answer and the credit are the hidden owner's, so the view prints none of them + alice ##> purchase 2 + (alice "/user alice password" + showActiveUser alice "alice (Alice, * supporter)" + +testInvoiceOtherProfile :: HasCallStack => TestParams -> IO () +testInvoiceOtherProfile ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + alice ##> "/create user alisa" + showActiveUser alice "alisa" + alice ##> purchaseWithInvoice 2 invoiceId supporterPlay + inAnyOrder alice [["[user: alice] store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "[user: alice] " "1: supporter"] + (alice "/user alice" + showActiveUser alice "alice (Alice, * supporter)" + +testInvoiceSameReceiptTwice :: HasCallStack => TestParams -> IO () +testInvoiceSameReceiptTwice ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + inAnyOrder alice [["store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "" "1: supporter"] + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + alice <## "badge already redeemed" + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testInvoiceUnknown :: HasCallStack => TestParams -> IO () +testInvoiceUnknown ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + alice ##> "/create user alisa" + showActiveUser alice "alisa" + -- a reinstall or a second device: the store echoes an invoice this database never created + let unknown = "0b6a5e6c-4f3e-4d51-9f55-3a0f7c2f9e11" + alice ##> purchaseWithInvoice 2 unknown supporterPlay + inAnyOrder alice [["store purchase open: invoice " <> unknown <> ", transaction "], creditedLines "" "1: supporter"] + storeReceiptRows (chatController alice) `shouldReturn` [(2, Just (T.pack unknown), True)] + +testInvoiceLateReceipt :: HasCallStack => TestParams -> IO () +testInvoiceLateReceipt ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsClock = clock} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + getCurrentTime >>= setClockAt clock . addUTCTime (8 * nominalDay) + alice ##> "/create user alisa" + showActiveUser alice "alisa" + alice ##> purchaseWithInvoice 2 invoiceId supporterPlay + inAnyOrder alice [["[user: alice] store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "[user: alice] " "1: supporter"] + (alice TestParams -> IO () +testInvoiceAgedOut ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsClock = clock} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + unpaid <- createInvoice alice 1 + presented <- createInvoice alice 1 + refused <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 refused (googlePayment "badge_supporter_01" "not-a-purchase") + inAnyOrder + alice + [ [ "store purchase open: invoice " <> unpaid, + "store purchase open: invoice " <> presented, + "store purchase open: invoice " <> refused <> ", transaction " + ], + ["store purchase resolved"] + ] + alice ##> purchaseWithInvoice 1 presented (googlePayment "badge_supporter_01" googlePendingToken) + alice <## ("store purchase open: invoice " <> unpaid) + alice <##. ("store purchase open: invoice " <> presented <> ", transaction ") + waitStoreReceiptError (chatController alice) "service_error retry payment_pending" + -- no age hides a record: one with no receipt and one held stay listed, and only a settled one goes + getCurrentTime >>= setClockAt clock . addUTCTime (8 * nominalDay) + alice ##> "/_badge state 1" + alice <## ("store purchase open: invoice " <> unpaid) + alice <##. ("store purchase open: invoice " <> presented <> ", transaction ") + (alice TestParams -> IO () +testInvoiceRefusedBeforeCharge ps = do + withNewTestChatCfg ps testCfg {badgeServiceAddress = Nothing} "bob" bobProfile $ \bob -> do + bob ##> "/_badge invoice 1" + bob <## "cannot get badge: badge service not configured" + storeReceiptRows (chatController bob) `shouldReturn` [] + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + code <- issueCode cc BTSupporter 1 + redeemFirstBadge alice code + alice ##> "/_badge invoice 1" + alice <## "cannot get badge: badge already active" + storeReceiptRows (chatController alice) `shouldReturn` [] + +testInvoiceWhileBadgeHeld :: HasCallStack => TestParams -> IO () +testInvoiceWhileBadgeHeld ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + code <- issueCode cc BTSupporter 1 + redeemFirstBadge alice code + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + alice <##. "1: supporter" + alice <##. ("store purchase open: invoice " <> invoiceId <> ", transaction ") + storeReceiptDue (chatController alice) 1 `shouldReturn` False + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True)] + heldStoreReceipts (chatController alice) `shouldReturn` 1 + rowCount cc "sx_badge_service_payments" `shouldReturn` 0 + +testInvoiceStateOtherProfile :: HasCallStack => TestParams -> IO () +testInvoiceStateOtherProfile ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + _ <- createInvoice alice 1 + alice ##> "/create user alisa" + showActiveUser alice "alisa" + alice ##> "/_hide user 1 \"password\"" + alice <## "user alice:" + alice <## "messages are hidden (use /tail to view)" + alice <## "profile is hidden" + invoiceId <- createInvoice alice 2 + alice ##> "/_badge state 2" + alice <## ("store purchase open: invoice " <> invoiceId) + (alice TestParams -> IO () +testStoreReceiptRetried ps = do + broken <- newIORef True + withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error final internal" + writeIORef broken False + mapM_ (alice <##.) $ creditedLines "" "1: supporter" + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + +testStoreReceiptNotBlocked :: HasCallStack => TestParams -> IO () +testStoreReceiptNotBlocked ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsStore = store@FakeStore {appleSupporterJWS}} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + setGoogleDown store True + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error retry provider_unavailable" + alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) + inAnyOrder alice [[openPurchase "", openPurchase ""], creditedLines "" "1: supporter"] + heldStoreReceipts (chatController alice) `shouldReturn` 1 + +testStoreRefusalKept :: HasCallStack => TestParams -> IO () +testStoreRefusalKept ps = do + hook <- newIORef (pure ()) + verifications <- countGoogleVerifications hook + withBadgeServiceVerifier ps (googleVerifierWithHook hook) $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + let refused = "/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase") + alice ##> refused + inAnyOrder alice [[openPurchase ""], ["store purchase resolved"]] + alice ##> refused + alice <## "cannot get badge: badge service error: receipt_invalid" + alice ##> "/_badge state 1" + (alice TestParams -> IO () +testStoreSettledOtherProfile ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + shown <- createInvoice alice 1 + hidden <- createInvoice alice 1 + alice ##> "/create user alisa" + showActiveUser alice "alisa" + -- the invoice makes alice the owner, so the hand-over's answer and the settlement are hers + alice ##> purchaseWithInvoice 2 shown (googlePayment "badge_supporter_01" "not-a-purchase") + inAnyOrder + alice + [ ["[user: alice] store purchase open: invoice " <> shown <> ", transaction ", "store purchase open: invoice " <> hidden], + ["[user: alice] store purchase resolved"] + ] + alice ##> "/_hide user 1 \"password\"" + alice <## "user alice:" + alice <## "messages are hidden (use /tail to view)" + alice <## "profile is hidden" + alice ##> purchaseWithInvoice 2 hidden (googlePayment "badge_supporter_01" "not-a-purchase-either") + (alice TestParams -> IO () +testStoreReceiptTwoAtOnce ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + let handOver = void $ sendChatCmdStr (chatController alice) ("/_badge purchase 1 " <> paymentArg supporterPlay) + concurrentlyN_ [handOver, handOver] + mapM_ (alice <##.) $ creditedLines "" "1: supporter" + (alice TestParams -> IO () +testStoreReceiptCleanup ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsClock, bsStore = FakeStore {appleSupporterJWS}} -> do + let cfg = bsClientCfg {initialCleanupManagerDelay = 0, cleanupManagerInterval = 1, cleanupManagerStepDelay = 0} + withNewTestChatCfg ps cfg "alice" aliceProfile $ \alice -> do + unpaid <- createInvoice alice 1 + alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase")) + inAnyOrder alice [["store purchase open: invoice " <> unpaid, openPurchase ""], ["store purchase resolved"]] + alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) + inAnyOrder alice [["store purchase open: invoice " <> unpaid, openPurchase ""], creditedLines "" "1: supporter"] + alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" googleUnreachableToken)) + alice <##. "1: supporter" + alice <## ("store purchase open: invoice " <> unpaid) + storePurchaseOpen alice "" + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack unpaid), False), (1, Nothing, True), (1, Nothing, True), (1, Nothing, True)] + -- a month on, the record no receipt reached and the refusal go; the credited and the held one stay + testClockTime bsClock >>= setClockAt bsClock . addUTCTime (31 * nominalDay) + -- the move also ends the badge credited above; whether its worker wakes alone or on this signal, its lines are read here + alice `send` "/_app activate" + inAnyOrder alice [["/_app activate"], ["ok"], ["badge alert: support_ended "], ["1: supporter", "badge alert: support_ended "]] + waitStoreReceiptRows (chatController alice) 2 `shouldReturn` [(1, Nothing, True), (1, Nothing, True)] + heldStoreReceipts (chatController alice) `shouldReturn` 1 + -- a receipt for the deleted invoice now arrives with no record to name its profile, so the presenting one gets it + alice ##> "/create user alisa" + showActiveUser alice "alisa" + alice ##> purchaseWithInvoice 2 unpaid (googlePayment "badge_supporter_01" googlePendingToken) + alice <##. ("store purchase open: invoice " <> unpaid <> ", transaction ") + waitStoreReceiptRows (chatController alice) 3 >>= (`shouldContain` [(2, Just (T.pack unpaid), True)]) + +testStoreReceiptAttemptThrows :: HasCallStack => TestParams -> IO () +testStoreReceiptAttemptThrows ps = do + broken <- newIORef True + withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg} -> + withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + storePurchaseOpen alice "" + waitStoreReceiptError (chatController alice) "service_error final internal" + -- a stored payment this version cannot read makes the attempt throw before anything is sent + setStoreReceiptPayment (chatController alice) "not a payment" + waitStoreReceiptError (chatController alice) "unexpected held store payment does not decode" + (alice TestCC -> Int -> IO String +createInvoice cc userId = do + cc ##> ("/_badge invoice " <> show userId) + line <- getTermLine cc + maybe (error $ "expected an invoice, got " <> line) pure $ stripPrefix "badge invoice: " line + +purchaseWithInvoice :: Int -> String -> ServicePayment -> String +purchaseWithInvoice userId invoiceId payment = "/_badge purchase " <> show userId <> " invoice=" <> invoiceId <> " " <> paymentArg payment + +-- | Each store purchase record's profile, invoice id, and whether a receipt reached it. +storeReceiptRows :: ChatController -> IO [(Int64, Maybe Text, Bool)] +storeReceiptRows ChatController {chatStore} = + withTransaction chatStore $ \db -> + DB.query_ db $ + "SELECT user_id, invoice_id, transaction_ref IS NOT NULL " + <> "FROM badge_store_receipts ORDER BY badge_store_receipt_id" + +waitStoreReceiptRows :: HasCallStack => ChatController -> Int -> IO [(Int64, Maybe Text, Bool)] +waitStoreReceiptRows cc n = loop (100 :: Int) + where + loop 0 = storeReceiptRows cc >>= \rows -> error $ "expected " <> show n <> " store purchase records, got " <> show rows + loop i = do + rows <- storeReceiptRows cc + if length rows == n then pure rows else threadDelay 50000 >> loop (i - 1) + +storeReceiptDue :: ChatController -> Int64 -> IO Bool +storeReceiptDue ChatController {chatStore} userId = + withTransaction chatStore $ \db -> + getNextHeldStoreReceipt db userId >>= either (error . show) (pure . isJust) + +heldStoreReceipts :: ChatController -> IO Int +heldStoreReceipts ChatController {chatStore} = + withTransaction chatStore $ \db -> do + [Only n] <- DB.query_ db "SELECT COUNT(*) FROM badge_store_receipts WHERE payment IS NOT NULL" + pure n + +waitHeldStoreReceipts :: HasCallStack => ChatController -> Int -> IO () +waitHeldStoreReceipts cc n = loop (100 :: Int) + where + loop 0 = heldStoreReceipts cc >>= (`shouldBe` n) + loop i = heldStoreReceipts cc >>= \held -> if held == n then pure () else threadDelay 50000 >> loop (i - 1) + +waitStoreReceiptError :: HasCallStack => ChatController -> Text -> IO () +waitStoreReceiptError ChatController {chatStore} failure = loop (100 :: Int) + where + loop 0 = heldFailures >>= (`shouldContain` [failure]) + loop i = heldFailures >>= \failures -> if failure `elem` failures then pure () else threadDelay 50000 >> loop (i - 1) + heldFailures = + withTransaction chatStore $ \db -> + map fromOnly <$> DB.query_ db "SELECT credit_error FROM badge_store_receipts WHERE payment IS NOT NULL AND credit_error IS NOT NULL" + +setStoreReceiptPayment :: ChatController -> Text -> IO () +setStoreReceiptPayment ChatController {chatStore} payment = + withTransaction chatStore $ \db -> DB.execute db "UPDATE badge_store_receipts SET payment = ?" (Only payment) + +fastRetryCfg :: ChatConfig -> ChatConfig +fastRetryCfg cfg = cfg {badgeRetryInterval = RetryInterval {initialInterval = 100000, increaseAfter = 0, maxInterval = 500000}} + +-- | The fake store's Google verdicts, failing as a verifier bug while broken is set: internal, with no retryAfter. +brokenGoogle :: IORef Bool -> FakeStore -> StoreVerifier +brokenGoogle broken FakeStore {fakeVerifier = v@StoreVerifier {verifyGoogle}} = + v {verifyGoogle = unlessBroken <$> verifyGoogle} + where + unlessBroken verify productId token = + readIORef broken >>= \case + True -> pure $ Left $ SRVerifierFailed "fake verifier bug" + False -> verify productId token + +-- | Each block's lines in order, the blocks in any order: the worker is signalled before the command that +-- signalled it has answered, so its events can print first. Every line is matched as a prefix. +inAnyOrder :: HasCallStack => TestCC -> [[String]] -> IO () +inAnyOrder _ [] = pure () +inAnyOrder cc blocks = do + line <- getTermLine cc + case break (startsWith line) blocks of + (earlier, (_ : rest) : others) -> do + mapM_ (cc <##.) rest + inAnyOrder cc (earlier <> others) + _ -> error $ "expected a line starting one of " <> show blocks <> ", got " <> show line + where + startsWith l = \case + start : _ -> start `isPrefixOf` l + [] -> False + +-- | Counts the Google verifications the service makes, re-arming the one-shot hook each time. +countGoogleVerifications :: IORef (IO ()) -> IO (IO Int) +countGoogleVerifications hook = do + n <- newIORef 0 + let count = modifyIORef' n (+ 1) >> writeIORef hook count + writeIORef hook count + pure $ readIORef n + +storePurchaseOpen :: HasCallStack => TestCC -> String -> IO () +storePurchaseOpen cc userPrefix = cc <##. openPurchase userPrefix + +openPurchase :: String -> String +openPurchase userPrefix = userPrefix <> "store purchase open: invoice none, transaction " + +-- | The worker's credit as the owner's terminal shows it: the badge, then the settlement. +creditedLines :: String -> String -> [String] +creditedLines userPrefix badge = [userPrefix <> badge, userPrefix <> "store purchase resolved"] diff --git a/tests/Bots/BadgeService/ConfigTests.hs b/tests/Bots/BadgeService/ConfigTests.hs index d27698622d..4e797e6335 100644 --- a/tests/Bots/BadgeService/ConfigTests.hs +++ b/tests/Bots/BadgeService/ConfigTests.hs @@ -50,6 +50,10 @@ badgeConfigTests = describe "badge service config" $ do it "reads chat_redeem = on" testDevRedeemOn it "reads chat_redeem = off" testDevRedeemOff it "refuses a chat_redeem that is not on or off" testDevRedeemNotBoolean + it "verifies store receipts when the dev section is absent" testDevUnverifiedReceiptsAbsent + it "reads accept_unverified_store_receipts = on" testDevUnverifiedReceiptsOn + it "reads accept_unverified_store_receipts = off" testDevUnverifiedReceiptsOff + it "refuses an accept_unverified_store_receipts that is not on or off" testDevUnverifiedReceiptsNotBoolean fullIni :: T.Text fullIni = @@ -365,5 +369,25 @@ testDevRedeemNotBoolean = withDev "chat_redeem = true\n" $ \r -> case r of Left e -> e `shouldContain` "chat_redeem" Right _ -> expectationFailure "only on and off are accepted, so a typo cannot silently disarm the gate" +testDevUnverifiedReceiptsAbsent :: IO () +testDevUnverifiedReceiptsAbsent = withIni fullIni $ \p -> do + Right cfg <- readServiceConfig p + devAcceptUnverifiedStoreReceipts cfg `shouldBe` False + +testDevUnverifiedReceiptsOn :: IO () +testDevUnverifiedReceiptsOn = withDev "accept_unverified_store_receipts = on\n" $ \r -> case r of + Right cfg -> devAcceptUnverifiedStoreReceipts cfg `shouldBe` True + Left e -> expectationFailure ("[dev] accept_unverified_store_receipts = on is legal: " <> e) + +testDevUnverifiedReceiptsOff :: IO () +testDevUnverifiedReceiptsOff = withDev "accept_unverified_store_receipts = off\n" $ \r -> case r of + Right cfg -> devAcceptUnverifiedStoreReceipts cfg `shouldBe` False + Left e -> expectationFailure ("[dev] accept_unverified_store_receipts = off is legal: " <> e) + +testDevUnverifiedReceiptsNotBoolean :: IO () +testDevUnverifiedReceiptsNotBoolean = withDev "accept_unverified_store_receipts = yes\n" $ \r -> case r of + Left e -> e `shouldContain` "accept_unverified_store_receipts" + Right _ -> expectationFailure "only on and off are accepted, so a typo cannot silently arm the mock" + withDev :: T.Text -> (Either String ServiceConfig -> IO a) -> IO a withDev keys act = withIni (fullIni <> "[dev]\n" <> keys) $ \p -> readServiceConfig p >>= act diff --git a/tests/Bots/BadgeService/FakeStore.hs b/tests/Bots/BadgeService/FakeStore.hs new file mode 100644 index 0000000000..986351c47f --- /dev/null +++ b/tests/Bots/BadgeService/FakeStore.hs @@ -0,0 +1,141 @@ +{-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TupleSections #-} + +module Bots.BadgeService.FakeStore + ( FakeStore (..), + newFakeStore, + googleVerifierWithHook, + settlePending, + setGoogleDown, + googleSupporterToken, + googlePendingToken, + googleUnreachableToken, + googleThrowingToken, + googleHangingToken, + googleSubscriptionToken, + googlePayment, + unsignedJWS, + ) +where + +import BadgeService.StoreReceipts +import Control.Concurrent (threadDelay) +import Control.Monad (forever) +import qualified Data.Aeson as J +import qualified Data.ByteString.Base64.URL as B64U +import qualified Data.ByteString.Char8 as B +import qualified Data.ByteString.Lazy as LB +import Data.IORef (IORef, atomicModifyIORef', newIORef, readIORef, writeIORef) +import Data.Text (Text) +import Simplex.Chat.PaymentService (ServicePayment (..), googlePurchaseRef) +import Simplex.Chat.PaymentService.Types (CurrencyAmount (..)) +import Simplex.Messaging.Util (safeDecodeUtf8) +import System.FilePath (()) + +fixtureDir :: FilePath +fixtureDir = "apps" "simplex-badge-service" "test-fixtures" "apple" + +-- | The Apple JWS are the fixtures under no real signature, so they are accepted as these exact +-- strings only, never because a payload decodes - which a real verifier must refuse to do. +data FakeStore = FakeStore + { appleSupporterJWS :: Text, + appleLegendJWS :: Text, + appleSandboxJWS :: Text, + appleThrowingJWS :: Text, + appleMisnamedJWS :: Text, + appleQuantityJWS :: Text, + pendingSettled :: IORef Bool, + googleDown :: IORef Bool, + fakeVerifier :: StoreVerifier + } + +newFakeStore :: IO FakeStore +newFakeStore = do + appleSupporterJWS <- fixtureJWS "transaction-supporter.json" + appleLegendJWS <- fixtureJWS "transaction-legend.json" + appleSandboxJWS <- fixtureJWS "transaction-sandbox.json" + let appleThrowingJWS = unsignedJWS "{\"transactionId\":\"2000000812345679\",\"productId\":\"BADGE_SUPPORTER_01\"}" + appleMisnamedJWS = unsignedJWS "{\"transactionId\":\"2000000812345698\",\"productId\":\"BADGE_SUPPORTER_01\"}" + appleQuantityJWS = unsignedJWS "{\"transactionId\":\"2000000812345697\",\"productId\":\"BADGE_SUPPORTER_01\"}" + pendingSettled <- newIORef False + googleDown <- newIORef False + let appleReceipts = + [ (appleSupporterJWS, appleTransaction "2000000812345671" "BADGE_SUPPORTER_01" False 700), + (appleLegendJWS, appleTransaction "2000000812345672" "BADGE_LEGEND_01" False 7000), + (appleSandboxJWS, appleTransaction "2000000812345673" "BADGE_LEGEND_01" True 7000), + -- a verifier vouching for another transaction than the one the evidence names + (appleMisnamedJWS, appleTransaction "2000000812345671" "BADGE_SUPPORTER_01" False 700), + (appleQuantityJWS, (appleTransaction "2000000812345697" "BADGE_SUPPORTER_01" False 1400) {quantity = 2}) + ] + verifyApple jws + | jws == appleThrowingJWS = error "fake verifier bug" + | otherwise = maybe (Left "not a fake receipt") Right $ lookup jws appleReceipts + verifyGoogle = googleVerdict pendingSettled googleDown + pure + FakeStore + { appleSupporterJWS, + appleLegendJWS, + appleSandboxJWS, + appleThrowingJWS, + appleMisnamedJWS, + appleQuantityJWS, + pendingSettled, + googleDown, + fakeVerifier = StoreVerifier {verifyApple = Just verifyApple, verifyGoogle = Just verifyGoogle, verifyTimeout = 500000} + } + where + fixtureJWS name = unsignedJWS <$> B.readFile (fixtureDir name) + appleTransaction transactionRef productId testPurchase cents = + VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase, paid = Just (CurrencyAmount cents, "USD")} + +googleVerdict :: IORef Bool -> IORef Bool -> Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +googleVerdict pendingSettled googleDown productId token = + readIORef googleDown >>= \case + True -> pure $ Left $ SRUnreachable "fake store is down" + False + | (productId, token) == ("badge_supporter_01", googleSupporterToken) -> pure $ Right purchased + | (productId, token) == ("subscr_badge_supporter_01", googleSubscriptionToken) -> pure $ Right purchased + | (productId, token) == ("badge_supporter_01", googlePendingToken) -> do + settled <- readIORef pendingSettled + pure $ if settled then Right purchased else Left SRPending + | token == googleUnreachableToken -> pure $ Left $ SRUnreachable "fake store is down" + | token == googleThrowingToken -> ioError $ userError "fake connection reset" + | token == googleHangingToken -> forever $ threadDelay 1000000 + | otherwise -> pure $ Left $ SRInvalid "not a fake purchase" + where + purchased = VerifiedStoreTransaction {transactionRef = googlePurchaseRef token, productId, quantity = 1, testPurchase = False, paid = Nothing} + +-- | The fake store, running the hook's action once, inside the first Google verification, before it answers. +googleVerifierWithHook :: IORef (IO ()) -> FakeStore -> StoreVerifier +googleVerifierWithHook hook FakeStore {fakeVerifier = v@StoreVerifier {verifyGoogle}} = + v {verifyGoogle = hooked <$> verifyGoogle, verifyTimeout = 10000000} + where + hooked verify productId token = do + action <- atomicModifyIORef' hook (pure (),) + action + verify productId token + +settlePending :: FakeStore -> IO () +settlePending FakeStore {pendingSettled} = writeIORef pendingSettled True + +setGoogleDown :: FakeStore -> Bool -> IO () +setGoogleDown FakeStore {googleDown} = writeIORef googleDown + +googleSupporterToken, googlePendingToken, googleUnreachableToken, googleThrowingToken, googleHangingToken, googleSubscriptionToken :: Text +googleSupporterToken = "fake-play-token-supporter.AO-J1Oz9x2kqE7wYt3" +googlePendingToken = "fake-play-token-pending.AO-J1Oy8w1jpD6vXs2" +googleUnreachableToken = "fake-play-token-unreachable.AO-J1Ox7v0ioC5uWr1" +googleThrowingToken = "fake-play-token-throwing.AO-J1Ov5t8gmA3sUp9" +googleHangingToken = "fake-play-token-hanging.AO-J1Ou4s7flZ2rTo8" +googleSubscriptionToken = "fake-play-token-subscription.AO-J1Ow6u9hnB4tVq0" + +googlePayment :: Text -> Text -> ServicePayment +googlePayment productId token = SPGoogle {productId, token} + +unsignedJWS :: B.ByteString -> Text +unsignedJWS payload = safeDecodeUtf8 $ B.intercalate "." $ map B64U.encodeUnpadded [header, payload, "not a signature"] + where + header = LB.toStrict $ J.encode $ J.object ["alg" J..= ("ES256" :: Text), "x5c" J..= (["leaf", "intermediate", "root"] :: [Text])] diff --git a/tests/Bots/BadgeService/WebTests.hs b/tests/Bots/BadgeService/WebTests.hs index dd21c820dd..bd8b166094 100644 --- a/tests/Bots/BadgeService/WebTests.hs +++ b/tests/Bots/BadgeService/WebTests.hs @@ -14,7 +14,7 @@ import BadgeService.Poller import BadgeService.Providers import BadgeService.Providers.BTCPay (btcpayProvider, listPageSize, maxListPages) import BadgeService.Providers.Stripe (stripeProvider) -import BadgeService.Store (CodeRedemption (..), IssuedCode (..), NewCodePurchase (..), RevokeResult (..), createCodePurchase, getBadgeCode, insertBadgeCode, revokeCode) +import BadgeService.Store (FundingCredit (..), IssuedCode (..), NewCodePurchase (..), RevokeResult (..), createCodePurchase, getBadgeCode, insertBadgeCode, revokeCode) import BadgeService.Store.Invoices import BadgeService.Waiters (awaitStatus, newWaiters, publish, waitingCount) import BadgeService.Web.Server @@ -471,7 +471,7 @@ testRevokeAndRedeemExcludeEachOther = withServiceStore $ \st -> do revoke codeHash = withTransaction st $ \db -> revokeCode db codeHash now unredeemed codeHash = withTransaction st (`getBadgeCode` codeHash) >>= \case - Just IssuedCode {redemption = CodeUnredeemed} -> pure True + Just IssuedCode {redemption = Uncredited} -> pure True _ -> pure False revokedFirst <- newCode "revoked-first" revoke "revoked-first" `shouldReturn` Revoked @@ -801,7 +801,8 @@ testServiceConfig staticDir trustForwarded = stripe = Nothing, poll = PollConfig {pWaitingSeconds = 3, pIdleSeconds = 60}, issuer = Nothing, - devChatRedeem = False + devChatRedeem = False, + devAcceptUnverifiedStoreReceipts = False } testServeWebappOff :: IO () From b4f12494367f4e95576704a62df2f889bfc1d604 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Thu, 8 Oct 2026 13:46:27 +0000 Subject: [PATCH 05/26] core, ios, android: name the resolved store purchase so the app finishes it without a sweep (#7659) --- apps/ios/Shared/Model/AppAPITypes.swift | 9 +- apps/ios/Shared/Model/SimpleXAPI.swift | 7 +- apps/ios/Shared/Views/Badges/BadgeStore.swift | 39 ++++++-- apps/ios/Shared/Views/Badges/BadgesView.swift | 6 -- .../Views/Badges/BadgesYourBadgeView.swift | 10 -- .../chat/simplex/common/model/SimpleXAPI.kt | 16 ++-- .../simplex/common/views/badges/BadgeStore.kt | 47 ++++++--- .../views/badges/BadgesCheckOrderView.kt | 2 +- .../views/badges/BadgesPurchaseStateView.kt | 2 +- .../simplex/common/views/badges/BadgesView.kt | 12 +-- .../views/badges/BadgesYourBadgeView.kt | 8 -- .../moko-resources/base/strings.xml | 2 - bots/src/API/Docs/Events.hs | 3 +- src/Simplex/Chat/Controller.hs | 5 +- src/Simplex/Chat/Library/Commands.hs | 23 +++-- src/Simplex/Chat/Store/Badges.hs | 14 +-- src/Simplex/Chat/View.hs | 3 +- tests/Bots/BadgeService/BotTests.hs | 95 +++++++++++-------- 18 files changed, 174 insertions(+), 129 deletions(-) diff --git a/apps/ios/Shared/Model/AppAPITypes.swift b/apps/ios/Shared/Model/AppAPITypes.swift index bf7ee67a7e..7099fc4d7f 100644 --- a/apps/ios/Shared/Model/AppAPITypes.swift +++ b/apps/ios/Shared/Model/AppAPITypes.swift @@ -1283,7 +1283,8 @@ enum ChatEvent: Decodable, ChatAPIResult { // badges case badgeChanged(user: User, badgeState: BadgeState?) case badgeAlert(user: UserRef, badgeAlert: BadgeAlert) - case storePurchaseResolved(user: UserRef) + case storePurchaseCredited(user: UserRef, invoiceId: String) + case storePurchaseRefused(user: UserRef, invoiceId: String, refusal: BadgeIssueFailure) var responseType: String { switch self { @@ -1358,7 +1359,8 @@ enum ChatEvent: Decodable, ChatAPIResult { case .contactPQEnabled: "contactPQEnabled" case .badgeChanged: "badgeChanged" case .badgeAlert: "badgeAlert" - case .storePurchaseResolved: "storePurchaseResolved" + case .storePurchaseCredited: "storePurchaseCredited" + case .storePurchaseRefused: "storePurchaseRefused" } } @@ -1443,7 +1445,8 @@ enum ChatEvent: Decodable, ChatAPIResult { case let .contactPQEnabled(u, contact, pqEnabled): return withUser(u, "contact: \(String(describing: contact))\npqEnabled: \(pqEnabled)") case let .badgeChanged(u, badgeState): return withUser(u, String(describing: badgeState)) case let .badgeAlert(u, badgeAlert): return withUser(u, String(describing: badgeAlert)) - case .storePurchaseResolved: return noDetails + case let .storePurchaseCredited(u, invoiceId): return withUser(u, "invoiceId: \(invoiceId)") + case let .storePurchaseRefused(u, invoiceId, refusal): return withUser(u, "invoiceId: \(invoiceId)\nrefusal: \(refusal.tag)") } } } diff --git a/apps/ios/Shared/Model/SimpleXAPI.swift b/apps/ios/Shared/Model/SimpleXAPI.swift index bcb592ee1a..2a9c82a966 100644 --- a/apps/ios/Shared/Model/SimpleXAPI.swift +++ b/apps/ios/Shared/Model/SimpleXAPI.swift @@ -3094,9 +3094,10 @@ func processReceivedMsg(_ res: ChatEvent) async { BadgeModel.shared.setAlert(userId: user.userId, alert: badgeAlert) } } - case .storePurchaseResolved: - // whichever profile owns it: only the app can finish the store transaction - Task { await BadgeStore.shared.presentUnfinished() } + case let .storePurchaseCredited(user, invoiceId): + Task { await BadgeStore.shared.storePurchaseResolved(user, invoiceId) } + case let .storePurchaseRefused(user, invoiceId, refusal): + Task { await BadgeStore.shared.storePurchaseRefused(user, invoiceId, refusal) } default: logger.debug("unsupported event: \(res.responseType)") } diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index 0c338655cd..f5da8d62e1 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -111,7 +111,6 @@ final class BadgeStore: ObservableObject { // set once presentUnfinished has read the store: until then, an Ask to Buy approved while the app was // closed, or a purchase it died before handing over, are both unknown, so canBuy refuses to buy again @Published private var reconciledOnce = false - let refusals = PassthroughSubject() private var transactionUpdates: Task? = nil private init() {} @@ -233,7 +232,7 @@ final class BadgeStore: ObservableObject { // or refused, as an unfinished transaction is what the store re-delivers if anything is lost on the way. private func handOver(_ receipt: BadgeStoreReceipt) async throws { guard let userId = await MainActor.run(body: { ChatModel.shared.currentUser?.userId }) else { return } - // a refusal is announced where it reads as its own, so only an unexpected answer reaches the buyer + // a refusal is announced from core's event for it, so only an unexpected answer reaches the buyer do { switch try await apiPurchaseBadge(userId, receipt.echoedInvoiceId, .apple(jws: receipt.jws)) { case let .held(user, badgeState, storePurchases): @@ -252,22 +251,41 @@ final class BadgeStore: ObservableObject { if badgeState?.shown == true { UserDefaults.standard.set(true, forKey: DEFAULT_SUPPORTER_BANNER_SHOWN) } } } - await resolve(receipt, refusal: nil) + await receipt.transaction.finish() } } catch let error where badgeReceiptRefused(error) { logger.error("BadgeStore.handOver: \(responseError(error))") - await resolve(receipt, refusal: error) + await receipt.transaction.finish() } } - private func resolve(_ receipt: BadgeStoreReceipt, refusal: Error?) async { - await receipt.transaction.finish() - if let refusal { - await MainActor.run { refusals.send(refusal) } + func storePurchaseRefused(_ user: UserRef, _ invoiceId: String, _ refusal: BadgeIssueFailure) async { + await MainActor.run { + if active(user) && openStorePurchases(user.userId).contains(where: { $0.invoiceId == invoiceId }) { + showAlert(NSLocalizedString("Purchase error", comment: "alert title"), message: refusal.purchaseText) + } + } + await storePurchaseResolved(user, invoiceId) + } + + func storePurchaseResolved(_ user: UserRef, _ invoiceId: String) async { + // the row goes before the store is read, or the screen shows it open while the store answers; + // the transaction is finished whoever owns it, as only the app can, while the cached row is the active profile's + await MainActor.run { + if active(user), let open = storePurchases, open.userId == user.userId { + storePurchases = (open.userId, open.purchases.filter { $0.invoiceId != invoiceId }) + } + } + for await verification in Transaction.unfinished { + let receipt = storeReceipt(verification) + if receipt.echoedInvoiceId == invoiceId { + await receipt.transaction.finish() + return + } } } - // at launch, on return to the foreground, on a profile switch and when core resolves a purchase, never on a timer + // at launch, on return to the foreground and on a profile switch, never on a timer func presentUnfinished() async { await listenForTransactions() for await verification in Transaction.unfinished { @@ -339,7 +357,8 @@ private func storeReceipt(_ verification: VerificationResult) -> Ba ) } -// the codes core refuses a receipt with for good, after which the store may stop re-delivering it +// the codes core refuses a receipt with for good, after which the store may stop re-delivering it; +// a sweep that hands over a receipt refused while the app was not running learns it only from this answer private func badgeReceiptRefused(_ error: Error) -> Bool { if case let .error(.badgeRedeemError(.serviceError(code))) = error as? ChatError { return code == .receiptInvalid || code == .receiptUsed diff --git a/apps/ios/Shared/Views/Badges/BadgesView.swift b/apps/ios/Shared/Views/Badges/BadgesView.swift index 28fa1a02e8..2d37860c45 100644 --- a/apps/ios/Shared/Views/Badges/BadgesView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesView.swift @@ -30,12 +30,6 @@ struct BadgesView: View { // holds the purchase screens' slot, so a consumable cannot be bought twice BadgesPurchaseStateView(title: purchaseState.title, message: purchaseState.message, failure: store.creditError(chatModel.currentUser?.userId), showsAsSheet: showsAsSheet) .transition(.opacity) - .onReceive(store.refusals) { refusal in - // only the issuing screen belongs to the active profile's held purchase, so a refusal shown there reads as its own - if purchaseState == .issuing { - showAlert(NSLocalizedString("Purchase error", comment: "alert title"), message: redeemErrorText(refusal, purchase: true)) - } - } } else if store.checkingPurchases { BadgesPurchaseStateView(title: "Checking your purchases", showsAsSheet: showsAsSheet) .transition(.opacity) diff --git a/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift b/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift index 6a67dad8c2..60c6a0ab77 100644 --- a/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesYourBadgeView.swift @@ -14,7 +14,6 @@ struct BadgesYourBadgeView: View { @EnvironmentObject var chatModel: ChatModel @Environment(\.dismiss) private var dismiss @AppStorage(DEFAULT_DEVELOPER_TOOLS) private var developerTools = false - @ObservedObject private var store = BadgeStore.shared let badgeState: BadgeState var showsAsSheet: Bool = false @@ -79,15 +78,6 @@ struct BadgesYourBadgeView: View { } } } - if store.purchaseState(chatModel.currentUser?.userId) != nil { - Section { - Text("A store purchase is being processed.") - .foregroundColor(theme.colors.secondary) - } header: { - Text("Store purchase") - .foregroundColor(theme.colors.secondary) - } - } if developerTools { Section(header: Text("Credential").foregroundColor(theme.colors.secondary)) { if let badge = chatModel.currentUser?.profile.localBadge { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt index 91424ec8f2..3c0443090b 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt @@ -3612,9 +3612,10 @@ object ChatController { BadgeModel.setAlert(rhId, r.user.userId, r.badgeAlert) } } - is CR.StorePurchaseResolved -> - // whichever profile owns it: only the app can finish the store purchase - withLongRunningApi { BadgeStore.presentUnfinished() } + is CR.StorePurchaseCredited -> + withLongRunningApi { BadgeStore.storePurchaseResolved(rhId, r.user, r.invoiceId) } + is CR.StorePurchaseRefused -> + withLongRunningApi { BadgeStore.storePurchaseRefused(rhId, r.user, r.invoiceId, r.refusal) } else -> Log.d(TAG , "unsupported event: ${msg.responseType}") } @@ -6963,7 +6964,8 @@ sealed class CR { @Serializable @SerialName("badgeLedger") class BadgeLedger(val user: UserRef, val badgeLedger: List): CR() @Serializable @SerialName("badgeChanged") class BadgeChanged(val user: User, val badgeState: BadgeState?): CR() @Serializable @SerialName("badgeAlert") class BadgeAlertR(val user: UserRef, val badgeAlert: BadgeAlert): CR() - @Serializable @SerialName("storePurchaseResolved") class StorePurchaseResolved(val user: UserRef): CR() + @Serializable @SerialName("storePurchaseCredited") class StorePurchaseCredited(val user: UserRef, val invoiceId: String): CR() + @Serializable @SerialName("storePurchaseRefused") class StorePurchaseRefused(val user: UserRef, val invoiceId: String, val refusal: BadgeIssueFailure): CR() // general @Serializable class Response(val type: String, val json: String): CR() @Serializable class Invalid(val str: String): CR() @@ -7156,7 +7158,8 @@ sealed class CR { is BadgeLedger -> "badgeLedger" is BadgeChanged -> "badgeChanged" is BadgeAlertR -> "badgeAlert" - is StorePurchaseResolved -> "storePurchaseResolved" + is StorePurchaseCredited -> "storePurchaseCredited" + is StorePurchaseRefused -> "storePurchaseRefused" is Response -> "* $type" is Invalid -> "* invalid json" } @@ -7366,7 +7369,8 @@ sealed class CR { is BadgeLedger -> withUser(user, json.encodeToString(badgeLedger)) is BadgeChanged -> withUser(user, json.encodeToString(badgeState)) is BadgeAlertR -> withUser(user, json.encodeToString(badgeAlert)) - is StorePurchaseResolved -> withUser(user, noDetails()) + is StorePurchaseCredited -> withUser(user, "invoiceId: $invoiceId") + is StorePurchaseRefused -> withUser(user, "invoiceId: $invoiceId\nrefusal: ${refusal.tag}") is Response -> json is Invalid -> str } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index ae6ecd3876..6e846678c2 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -6,10 +6,12 @@ import androidx.compose.runtime.mutableStateOf import chat.simplex.common.model.* import chat.simplex.common.model.ChatController.appPrefs import chat.simplex.common.platform.* +import chat.simplex.common.views.helpers.AlertManager +import chat.simplex.common.views.helpers.generalGetString +import chat.simplex.res.* import kotlinx.coroutines.CancellationException import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.NonCancellable -import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.withContext import java.text.NumberFormat import java.util.Currency @@ -157,7 +159,6 @@ object BadgeStore { // set once presentUnfinished has read the store, or failed to: until then, a slow payment completed while // the app was closed, or a purchase it died before handing over, are both unknown, so canBuy refuses private val reconciledOnce = mutableStateOf(false) - val refusals = MutableSharedFlow() fun purchaseState(userId: Long?): BadgePurchaseState? { if (!badgeStoreAvailable) return null @@ -292,27 +293,50 @@ object BadgeStore { if (r.badgeState?.shown == true) appPrefs.supporterBannerShown.set(true) } } - resolve(receipt, refusal = null) + finish(receipt) } - // a refusal is announced where it reads as its own, so only an unexpected answer reaches the buyer + // a refusal is announced from core's event for it, so only an unexpected answer reaches the buyer is BadgePurchaseResult.Failed -> if (badgeReceiptRefused(r.err)) { Log.e(TAG, "BadgeStore.handOver: ${r.err?.string}") - resolve(receipt, refusal = r.err) + finish(receipt) } else { throw r.err?.let(BadgeStoreError::ApiError) ?: Exception("apiPurchaseBadge: unexpected response") } } } - private suspend fun resolve(receipt: BadgeStoreReceipt, refusal: ChatError?) { - finish(receipt) - if (refusal != null) { - withContext(Dispatchers.Main) { refusals.emit(refusal) } + suspend fun storePurchaseRefused(rhId: Long?, user: UserRef, invoiceId: String, refusal: BadgeIssueFailure) { + withContext(Dispatchers.Main) { + if (chatModel.controller.activeUser(rhId, user) && openStorePurchases(user.userId).any { it.invoiceId == invoiceId }) { + AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.badges_purchase_error), text = refusal.purchaseText) + } + } + storePurchaseResolved(rhId, user, invoiceId) + } + + suspend fun storePurchaseResolved(rhId: Long?, user: UserRef, invoiceId: String) { + // the row goes before the store is read, or the screen shows it open while the store answers; + // the purchase is finished whoever owns it, as only the app can, while the cached row is the active profile's + withContext(Dispatchers.Main) { + val (readOn, readFor, purchases) = storePurchases.value ?: return@withContext + if (chatModel.controller.activeUser(rhId, user) && readOn == rhId && readFor == user.userId) { + storePurchases.value = Triple(readOn, readFor, purchases.filter { it.invoiceId != invoiceId }) + } + } + if (rhId != null || useBadgeTestProducts || !platform.androidHasPlatformStore) return + try { + platform.androidUnfinishedBadgePurchases() + .firstNotNullOfOrNull { (it as? BadgePurchaseOutcome.Purchased)?.receipt?.takeIf { r -> r.invoiceId == invoiceId } } + ?.let { finish(it) } + } catch (e: Exception) { + if (e is CancellationException) throw e + // the purchase stays unfinished, and the next sweep hands it over and finishes it + Log.e(TAG, "BadgeStore.storePurchaseResolved: ${e.message}") } } - // at launch, on return to the foreground, on a profile switch and when core resolves a purchase, never on a timer + // at launch, on return to the foreground and on a profile switch, never on a timer suspend fun presentUnfinished() { try { if (!useBadgeTestProducts && platform.androidHasPlatformStore) { @@ -390,7 +414,8 @@ private fun compactPrice(product: BadgeProduct): String { } } -// the codes core refuses a receipt with for good, after which the store may stop re-delivering it +// the codes core refuses a receipt with for good, after which the store may stop re-delivering it; +// a sweep that hands over a receipt refused while the app was not running learns it only from this answer private fun badgeReceiptRefused(err: ChatError?): Boolean { val redeemError = ((err as? ChatError.ChatErrorChat)?.errorType as? ChatErrorType.CEBadgeRedeemError)?.badgeRedeemError val code = (redeemError as? BadgeRedeemError.ServiceError)?.serviceError diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt index 90f459a520..fbb3d1a017 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesCheckOrderView.kt @@ -17,7 +17,7 @@ import chat.simplex.common.platform.* import chat.simplex.common.ui.theme.* import chat.simplex.common.views.helpers.* import chat.simplex.common.views.onboarding.OnboardingActionButton -import chat.simplex.res.MR +import chat.simplex.res.* @Composable fun BadgesCheckOrderView(level: BadgeLevel, period: BadgePeriod, modalManager: ModalManager, unwindToDepth: Int) { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt index 4c808d60a6..4648a12774 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesPurchaseStateView.kt @@ -16,7 +16,7 @@ import dev.icerock.moko.resources.compose.stringResource import chat.simplex.common.model.BadgeIssueFailure import chat.simplex.common.platform.ColumnWithScrollBar import chat.simplex.common.views.onboarding.TextButtonBelowOnboardingButton -import chat.simplex.res.MR +import chat.simplex.res.* @Composable fun BadgesPurchaseStateView(title: StringResource, message: StringResource?, failure: BadgeIssueFailure? = null, onDismiss: () -> Unit) { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt index d631735e3e..c0050c8406 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt @@ -7,11 +7,9 @@ import androidx.compose.runtime.remember import chat.simplex.common.model.BadgeModel import chat.simplex.common.model.BadgeState import chat.simplex.common.platform.chatModel -import chat.simplex.common.views.helpers.AlertManager import chat.simplex.common.views.helpers.ModalManager import chat.simplex.common.views.helpers.ModalView -import chat.simplex.common.views.helpers.generalGetString -import chat.simplex.res.MR +import chat.simplex.res.* @OptIn(ExperimentalAnimationApi::class) @Composable @@ -31,14 +29,6 @@ fun BadgesView(modalManager: ModalManager, close: () -> Unit) { } else if (purchaseState != null) { // holds the purchase screens' slot, so a consumable cannot be bought twice BadgesPurchaseStateView(purchaseState.title, purchaseState.message, BadgeStore.creditError(chatModel.currentUser.value?.userId), onDismiss = close) - LaunchedEffect(purchaseState) { - BadgeStore.refusals.collect { refusal -> - // only the issuing screen belongs to the active profile's held purchase, so a refusal shown there reads as its own - if (purchaseState == BadgePurchaseState.Issuing) { - AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.badges_purchase_error), text = chatModel.controller.redeemErrorText(refusal, purchase = true)) - } - } - } } else if (checkingPurchases) { BadgesPurchaseStateView(MR.strings.badges_checking_purchases_title, null, onDismiss = close) } else { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt index c40a80f774..f6f6ecb12d 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesYourBadgeView.kt @@ -78,14 +78,6 @@ fun BadgesYourBadgeView(badgeState: BadgeState, modalManager: ModalManager) { } SectionSpacer() } - if (BadgeStore.purchaseState(chatModel.currentUser.value?.userId) != null) { - SectionView(stringResource(MR.strings.badges_store_purchase_title)) { - SectionItemView { - Text(stringResource(MR.strings.badges_store_purchase_processing), color = MaterialTheme.colors.secondary) - } - } - SectionSpacer() - } if (appPrefs.developerTools.get()) { val clipboard = LocalClipboardManager.current SectionView(stringResource(MR.strings.badges_credential)) { diff --git a/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml b/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml index 280096d38d..2990970884 100644 --- a/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml +++ b/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml @@ -3196,8 +3196,6 @@ Waiting for approval Nothing has been charged. Checking your purchases - Store purchase - A store purchase is being processed. Buy in browser Redeem code Add badge to your profile? diff --git a/bots/src/API/Docs/Events.hs b/bots/src/API/Docs/Events.hs index e35cd6ffe5..c43b0fe3e4 100644 --- a/bots/src/API/Docs/Events.hs +++ b/bots/src/API/Docs/Events.hs @@ -221,7 +221,8 @@ undocumentedEvents = "CEvtSndFileRedirectStartXFTP", "CEvtSndFileStart", -- legacy SMP files "CEvtSndStandaloneFileComplete", - "CEvtStorePurchaseResolved", + "CEvtStorePurchaseCredited", + "CEvtStorePurchaseRefused", "CEvtConnectionsDiff", "CEvtSubscriptionEnd", "CEvtTerminalEvent", diff --git a/src/Simplex/Chat/Controller.hs b/src/Simplex/Chat/Controller.hs index 1c9fd9d68b..e8fe0b44f8 100644 --- a/src/Simplex/Chat/Controller.hs +++ b/src/Simplex/Chat/Controller.hs @@ -85,7 +85,7 @@ import Simplex.Messaging.Client (HostMode (..), SMPProxyFallback (..), SMPProxyM import qualified Simplex.Messaging.Crypto as C import Simplex.Chat.Badges (BadgeCredential, FileSizeLimits, LocalBadge) import Simplex.Chat.Badges.Service (BadgeServiceErrorCode, StatementEntry) -import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind, BadgeState (..), OpenStorePurchase (..)) +import Simplex.Chat.Badges.Types (BadgeAlert (..), BadgeAlertKind, BadgeIssueFailure, BadgeState (..), OpenStorePurchase (..)) import Simplex.Chat.PaymentService (ServicePayment) import Simplex.Messaging.Crypto.BBS (BBSPublicKey) import Simplex.Messaging.Crypto.File (CryptoFile (..)) @@ -999,7 +999,8 @@ data ChatEvent | CEvtServiceReplySent {connectionId :: AgentConnId} | CEvtBadgeChanged {user :: User, badgeState :: Maybe BadgeState} -- badge state changed, including a renewal that arrived without a command | CEvtBadgeAlert {user :: User, badgeAlert :: BadgeAlert} - | CEvtStorePurchaseResolved {user :: User} -- a held store receipt was credited or refused, so its store transaction can be finished + | CEvtStorePurchaseCredited {user :: User, invoiceId :: Text} -- the held store receipt of this invoice was credited, so its store transaction can be finished + | CEvtStorePurchaseRefused {user :: User, invoiceId :: Text, refusal :: BadgeIssueFailure} -- the held store receipt of this invoice was refused | CEvtContactRequestRejected {user :: User, contact :: Contact, rejectionReason :: Maybe ContactRejectionReason} | CEvtAcceptingContactRequest {user :: User, contact :: Contact} -- there is the same command response | CEvtAcceptingBusinessRequest {user :: User, groupInfo :: GroupInfo} diff --git a/src/Simplex/Chat/Library/Commands.hs b/src/Simplex/Chat/Library/Commands.hs index b309687589..d7c7d70226 100644 --- a/src/Simplex/Chat/Library/Commands.hs +++ b/src/Simplex/Chat/Library/Commands.hs @@ -5458,7 +5458,7 @@ runStoreReceiptWorker a userId Worker {doWork} = do forever $ do lift $ waitForWork doWork withWork_ a doWork (getDueReceipt scheduled) $ \case - BadgeReceiptRecord {receiptId, status = RSHeld {stash, payment, retryDelay}} -> creditStoreReceipt a userId receiptId stash payment retryDelay + BadgeReceiptRecord {receiptId, status = RSHeld {stash, invoiceId, payment, retryDelay}} -> creditStoreReceipt a userId receiptId stash invoiceId payment retryDelay BadgeReceiptRecord {receiptId} -> notHeld receiptId where getDueReceipt scheduled = @@ -5479,31 +5479,36 @@ runStoreReceiptWorker a userId Worker {doWork} = do atomically $ modifyTVar' scheduled $ S.delete receiptId void $ atomically $ tryPutTMVar doWork () -data StoreReceiptOutcome = SROCredited (Maybe User) | SRORefused | SRORetry | SRODeferred +data StoreReceiptOutcome = SROCredited (Maybe User) | SRORefused BadgeIssueFailure | SRORetry | SRODeferred -- | Under the owner's badge lock, which keeps a profile's requests to the service serial. -creditStoreReceipt :: AgentClient -> UserId -> Int64 -> BadgeStash -> Text -> Maybe Int64 -> CM () -creditStoreReceipt a userId receiptId stash@BadgeStash {masterKey} payment retryDelay = do +creditStoreReceipt :: AgentClient -> UserId -> Int64 -> BadgeStash -> Maybe Text -> Text -> Maybe Int64 -> CM () +creditStoreReceipt a userId receiptId stash@BadgeStash {masterKey} invoiceId_ payment retryDelay = do ChatConfig {badgeRetryInterval = ri, badgeConsecutiveRetries} <- asks config withRetryIntervalCount (maybe ri (\d -> ri {initialInterval = d, increaseAfter = 0}) retryDelay) $ \n delay loop -> do liftIO $ waitWhileSuspended a liftIO $ waitForUserNetwork a + -- decided under the lock and acted on outside it: the retry sleeps, and announcing takes the chat lock outcome <- withEntityLock "badgePurchase" (CLBadgeUser userId) $ tryAllErrors attempt >>= \case Right (Right (present_, _)) -> pure $ SROCredited present_ Right (Left (code, retryAfter)) - | storeReceiptRefused code -> SRORefused <$ withStore' (\db -> refuseStoreReceipt db receiptId $ serviceFailure code retryAfter) + | storeReceiptRefused code -> do + let failure = serviceFailure code retryAfter + SRORefused failure <$ withStore' (\db -> refuseStoreReceipt db receiptId failure) | otherwise -> failed ri delay (serviceFailure code retryAfter) retryAfter Left e -> failed ri delay (badgeIssueFailure e) Nothing - -- only a settlement is announced, and the sweep it prompts signals this worker only for a receipt still held, so it cannot loop + -- the invoice id is the app's only key to the store transaction, so without one nothing is emitted and its sweep finishes it case outcome of SROCredited present_ -> do user <- withStore $ \db -> getUser db userId toView . CEvtBadgeChanged user =<< getUserBadgeState user - toView $ CEvtStorePurchaseResolved user - -- last, so a failed broadcast cannot lose the settlement; outside the badge lock, as it takes the chat lock + forM_ invoiceId_ $ toView . CEvtStorePurchaseCredited user + -- last, so a failed broadcast cannot lose the settlement mapM_ presentUserBadgeToContacts present_ - SRORefused -> withStore (`getUser` userId) >>= toView . CEvtStorePurchaseResolved + SRORefused failure -> forM_ invoiceId_ $ \invoiceId -> do + user <- withStore (`getUser` userId) + toView $ CEvtStorePurchaseRefused user invoiceId failure SRORetry | n + 1 < badgeConsecutiveRetries -> loop _ -> pure () where diff --git a/src/Simplex/Chat/Store/Badges.hs b/src/Simplex/Chat/Store/Badges.hs index e749a7fc37..28db3e5d67 100644 --- a/src/Simplex/Chat/Store/Badges.hs +++ b/src/Simplex/Chat/Store/Badges.hs @@ -118,7 +118,7 @@ data BadgeReceiptRecord = BadgeReceiptRecord } data BadgeReceiptStatus - = RSHeld {stash :: BadgeStash, payment :: Text, nextAttemptAt :: UTCTime, retryDelay :: Maybe Int64} + = RSHeld {stash :: BadgeStash, invoiceId :: Maybe Text, payment :: Text, nextAttemptAt :: UTCTime, retryDelay :: Maybe Int64} | RSCredited {badgePurchaseId :: Int64} | RSRefused {refusal :: Maybe BadgeIssueFailure} @@ -171,18 +171,18 @@ getReceiptRecord db StoreTransactionRef {provider, transactionRef} = db [sql| SELECT r.badge_store_receipt_id, r.user_id, r.purchase_key, r.purchase_priv_key, r.master_key, - r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error + r.invoice_id, r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error FROM badge_store_receipts r LEFT JOIN badge_purchases p ON p.badge_store_receipt_id = r.badge_store_receipt_id WHERE r.provider = ? AND r.transaction_ref = ? |] (provider, transactionRef) where - toReceiptRecord ((receiptId, ownerId, purchaseKey, purchasePrivKey, mk) :. (payment_, nextAttemptAt_, retryDelay, purchaseId_, refusal)) = + toReceiptRecord ((receiptId, ownerId, purchaseKey, purchasePrivKey, mk) :. (invoiceId, payment_, nextAttemptAt_, retryDelay, purchaseId_, refusal)) = BadgeReceiptRecord {receiptId, ownerId, status} where status = case (payment_, nextAttemptAt_) of - (Just payment, Just nextAttemptAt) -> RSHeld {stash = toBadgeStash BSRStoreReceipt (receiptId, purchaseKey, purchasePrivKey, mk), payment, nextAttemptAt, retryDelay} + (Just payment, Just nextAttemptAt) -> RSHeld {stash = toBadgeStash BSRStoreReceipt (receiptId, purchaseKey, purchasePrivKey, mk), invoiceId, payment, nextAttemptAt, retryDelay} _ -> maybe (RSRefused refusal) RSCredited purchaseId_ -- | The record made when Buy is tapped, before any receipt: the store echoes its invoice id. @@ -220,7 +220,7 @@ getNextHeldStoreReceipt db userId = DB.query db [sql| - SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.payment, r.next_attempt_at, r.retry_delay + SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.invoice_id, r.payment, r.next_attempt_at, r.retry_delay FROM badge_store_receipts r JOIN users u ON u.user_id = r.user_id WHERE r.user_id = ? AND r.payment IS NOT NULL AND u.shown_badge_id IS NULL @@ -229,8 +229,8 @@ getNextHeldStoreReceipt db userId = |] (Only userId) where - toHeld (stashRow@(receiptId, _, _, _) :. (payment, nextAttemptAt, retryDelay)) = - BadgeReceiptRecord {receiptId, ownerId = userId, status = RSHeld {stash = toBadgeStash BSRStoreReceipt stashRow, payment, nextAttemptAt, retryDelay}} + toHeld (stashRow@(receiptId, _, _, _) :. (invoiceId, payment, nextAttemptAt, retryDelay)) = + BadgeReceiptRecord {receiptId, ownerId = userId, status = RSHeld {stash = toBadgeStash BSRStoreReceipt stashRow, invoiceId, payment, nextAttemptAt, retryDelay}} recordStoreReceiptFailure :: DB.Connection -> Int64 -> Int64 -> UTCTime -> BadgeIssueFailure -> IO () recordStoreReceiptFailure db receiptId retryDelay nextAttemptAt failure = diff --git a/src/Simplex/Chat/View.hs b/src/Simplex/Chat/View.hs index 30211ea181..76c588776c 100644 --- a/src/Simplex/Chat/View.hs +++ b/src/Simplex/Chat/View.hs @@ -484,7 +484,8 @@ chatEventToView hu ChatConfig {logLevel, showReactions, showReceipts, testView} CEvtServiceReplySent (AgentConnId cId) -> [plain $ "service reply sent, connection id: " <> safeDecodeUtf8 (strEncode cId)] CEvtBadgeChanged u st -> ttyUser u $ viewUserBadgeState st CEvtBadgeAlert u alert -> ttyUser u $ viewBadgeAlert alert - CEvtStorePurchaseResolved u -> ttyUser u ["store purchase resolved"] + CEvtStorePurchaseCredited u invoiceId -> ttyUser u ["store purchase credited: invoice " <> plain invoiceId] + CEvtStorePurchaseRefused u invoiceId refusal -> ttyUser u ["store purchase refused: invoice " <> plain invoiceId <> ", " <> plain (safeDecodeUtf8 $ strEncode refusal)] CEvtContactRequestRejected u Contact {localDisplayName = c} _reason -> ttyUser u [ttyContact c <> ": contact request rejected"] CEvtRcvFileStart u ci -> ttyUser u $ receivingFile_' hu testView "started" ci CEvtRcvFileComplete u ci -> ttyUser u $ receivingFile_' hu testView "completed" ci diff --git a/tests/Bots/BadgeService/BotTests.hs b/tests/Bots/BadgeService/BotTests.hs index 82d8eeed1c..13e90fe7e2 100644 --- a/tests/Bots/BadgeService/BotTests.hs +++ b/tests/Bots/BadgeService/BotTests.hs @@ -1941,9 +1941,10 @@ testPurchaseBadge :: HasCallStack => TestParams -> IO () testPurchaseBadge ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - let purchase = "/_badge purchase 1 " <> paymentArg supporterPlay + invoiceId <- createInvoice alice 1 + let purchase = purchaseWithInvoice 1 invoiceId supporterPlay alice ##> purchase - inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] -- the app hands a purchase over until it is answered credited, and one already credited adds nothing alice ##> purchase alice <## "badge already redeemed" @@ -1957,19 +1958,21 @@ testPurchaseBadgeAppStore :: HasCallStack => TestParams -> IO () testPurchaseBadgeAppStore ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc, bsStore = FakeStore {appleLegendJWS}} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleLegendJWS}) - inAnyOrder alice [[openPurchase ""], creditedLines "" "1: legend"] + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId SPApple {jws = appleLegendJWS} + inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: legend"] storePayments cc `shouldReturn` [("apple", Just 7000, Just "USD", 1)] testPurchaseStash :: HasCallStack => TestParams -> IO () testPurchaseStash ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 let records = rowCount (chatController alice) "badge_store_receipts" - refused = "/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase") + refused = purchaseWithInvoice 1 invoiceId (googlePayment "badge_supporter_01" "not-a-purchase") -- the store does not vouch for it, so it can never be credited, and the record says so alice ##> refused - alice <### [StartsWith (openPurchase ""), "store purchase resolved"] + alice <### [StartsWith (invoicePurchase "" invoiceId), ConsoleString (refusedLine "" invoiceId "service_error final receipt_invalid")] alice ##> refused alice <## "cannot get badge: badge service error: receipt_invalid" records `shouldReturn` 1 @@ -1992,14 +1995,16 @@ testPurchaseStashReceiptUsed ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> withNewTestChatCfg ps bsClientCfg "bob" bobProfile $ \bob -> do - let purchase = "/_badge purchase 1 " <> paymentArg supporterPlay + invoiceId <- createInvoice alice 1 + -- the store echoes the buyer's invoice on any device the purchase reaches + let purchase = purchaseWithInvoice 1 invoiceId supporterPlay alice ##> purchase - inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] bob ##> purchase - bob <### [StartsWith (openPurchase ""), "store purchase resolved"] + bob <### [StartsWith (invoicePurchase "" invoiceId), ConsoleString (refusedLine "" invoiceId "service_error final receipt_used")] bob ##> purchase bob <## "cannot get badge: badge service error: receipt_used" - storeReceiptRows (chatController bob) `shouldReturn` [(1, Nothing, True)] + storeReceiptRows (chatController bob) `shouldReturn` [(1, Just (T.pack invoiceId), True)] heldStoreReceipts (chatController bob) `shouldReturn` 0 rowCount (chatController alice) "badge_store_receipts" `shouldReturn` 1 rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 @@ -2033,12 +2038,13 @@ testPurchaseSameReceiptOtherProfile :: HasCallStack => TestParams -> IO () testPurchaseSameReceiptOtherProfile ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) - inAnyOrder alice [[openPurchase ""], creditedLines "" "1: supporter"] + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] alice ##> "/create user alisa" showActiveUser alice "alisa" -- the store transaction is the device's, so it stays with the profile it was bought under - alice ##> ("/_badge purchase 2 " <> paymentArg supporterPlay) + alice ##> purchaseWithInvoice 2 invoiceId supporterPlay alice <## "[user: alice] badge already redeemed" rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 alice ##> "/p" @@ -2049,17 +2055,18 @@ testPurchaseStrandedUnderOtherProfile ps = do broken <- newIORef True withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do - let purchase userId = "/_badge purchase " <> show (userId :: Int) <> " " <> paymentArg supporterPlay + invoiceId <- createInvoice alice 1 + let purchase userId = purchaseWithInvoice userId invoiceId supporterPlay alice ##> purchase 1 - storePurchaseOpen alice "" + alice <##. invoicePurchase "" invoiceId waitStoreReceiptError (chatController alice) "service_error final internal" alice ##> "/create user alisa" showActiveUser alice "alisa" -- handed over again under whichever profile is active, the purchase stays with the keys alice holds alice ##> purchase 2 - storePurchaseOpen alice "[user: alice] " + alice <##. invoicePurchase "[user: alice] " invoiceId writeIORef broken False - mapM_ (alice <##.) $ creditedLines "[user: alice] " "1: supporter" + mapM_ (alice <##.) $ creditedLines "[user: alice] " invoiceId "1: supporter" (alice "/create user alisa" showActiveUser alice "alisa" alice ##> purchaseWithInvoice 2 invoiceId supporterPlay - inAnyOrder alice [["[user: alice] store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "[user: alice] " "1: supporter"] + inAnyOrder alice [[invoicePurchase "[user: alice] " invoiceId], creditedLines "[user: alice] " invoiceId "1: supporter"] (alice "/user alice" @@ -2110,7 +2117,7 @@ testInvoiceSameReceiptTwice ps = withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do invoiceId <- createInvoice alice 1 alice ##> purchaseWithInvoice 1 invoiceId supporterPlay - inAnyOrder alice [["store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "" "1: supporter"] + inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] alice ##> purchaseWithInvoice 1 invoiceId supporterPlay alice <## "badge already redeemed" storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True)] @@ -2125,7 +2132,7 @@ testInvoiceUnknown ps = -- a reinstall or a second device: the store echoes an invoice this database never created let unknown = "0b6a5e6c-4f3e-4d51-9f55-3a0f7c2f9e11" alice ##> purchaseWithInvoice 2 unknown supporterPlay - inAnyOrder alice [["store purchase open: invoice " <> unknown <> ", transaction "], creditedLines "" "1: supporter"] + inAnyOrder alice [[invoicePurchase "" unknown], creditedLines "" unknown "1: supporter"] storeReceiptRows (chatController alice) `shouldReturn` [(2, Just (T.pack unknown), True)] testInvoiceLateReceipt :: HasCallStack => TestParams -> IO () @@ -2137,7 +2144,7 @@ testInvoiceLateReceipt ps = alice ##> "/create user alisa" showActiveUser alice "alisa" alice ##> purchaseWithInvoice 2 invoiceId supporterPlay - inAnyOrder alice [["[user: alice] store purchase open: invoice " <> invoiceId <> ", transaction "], creditedLines "[user: alice] " "1: supporter"] + inAnyOrder alice [[invoicePurchase "[user: alice] " invoiceId], creditedLines "[user: alice] " invoiceId "1: supporter"] (alice unpaid), ConsoleString ("store purchase open: invoice " <> presented), - StartsWith ("store purchase open: invoice " <> refused <> ", transaction "), - "store purchase resolved" + StartsWith (invoicePurchase "" refused), + ConsoleString (refusedLine "" refused "service_error final receipt_invalid") ] alice ##> purchaseWithInvoice 1 presented (googlePayment "badge_supporter_01" googlePendingToken) alice <## ("store purchase open: invoice " <> unpaid) @@ -2216,11 +2223,12 @@ testStoreReceiptRetried ps = do broken <- newIORef True withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do - alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) - storePurchaseOpen alice "" + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + alice <##. invoicePurchase "" invoiceId waitStoreReceiptError (chatController alice) "service_error final internal" writeIORef broken False - mapM_ (alice <##.) $ creditedLines "" "1: supporter" + mapM_ (alice <##.) $ creditedLines "" invoiceId "1: supporter" rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 testStoreReceiptNotBlocked :: HasCallStack => TestParams -> IO () @@ -2231,8 +2239,9 @@ testStoreReceiptNotBlocked ps = alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) storePurchaseOpen alice "" waitStoreReceiptError (chatController alice) "service_error retry provider_unavailable" - alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) - inAnyOrder alice [[openPurchase "", openPurchase ""], creditedLines "" "1: supporter"] + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId SPApple {jws = appleSupporterJWS} + inAnyOrder alice [[openPurchase "", invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] heldStoreReceipts (chatController alice) `shouldReturn` 1 testStoreRefusalKept :: HasCallStack => TestParams -> IO () @@ -2243,7 +2252,10 @@ testStoreRefusalKept ps = do withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do let refused = "/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase") alice ##> refused - alice <### [StartsWith (openPurchase ""), "store purchase resolved"] + storePurchaseOpen alice "" + -- with no invoice id the app has no key to the store transaction, so the refusal is not announced + waitHeldStoreReceipts (chatController alice) 0 + (alice refused alice <## "cannot get badge: badge service error: receipt_invalid" alice ##> "/_badge state 1" @@ -2264,7 +2276,7 @@ testStoreSettledOtherProfile ps = alice <### [ StartsWith ("[user: alice] store purchase open: invoice " <> shown <> ", transaction "), ConsoleString ("store purchase open: invoice " <> hidden), - "[user: alice] store purchase resolved" + ConsoleString (refusedLine "[user: alice] " shown "service_error final receipt_invalid") ] alice ##> "/_hide user 1 \"password\"" alice <## "user alice:" @@ -2280,11 +2292,12 @@ testStoreReceiptTwoAtOnce :: HasCallStack => TestParams -> IO () testStoreReceiptTwoAtOnce ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - let handOver = void $ sendChatCmdStr (chatController alice) ("/_badge purchase 1 " <> paymentArg supporterPlay) + invoiceId <- createInvoice alice 1 + let handOver = void $ sendChatCmdStr (chatController alice) (purchaseWithInvoice 1 invoiceId supporterPlay) concurrentlyN_ [handOver, handOver] - mapM_ (alice <##.) $ creditedLines "" "1: supporter" + mapM_ (alice <##.) $ creditedLines "" invoiceId "1: supporter" (alice TestParams -> IO () @@ -2294,9 +2307,11 @@ testStoreReceiptCleanup ps = withNewTestChatCfg ps cfg "alice" aliceProfile $ \alice -> do unpaid <- createInvoice alice 1 alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase")) - alice <### [ConsoleString ("store purchase open: invoice " <> unpaid), StartsWith (openPurchase ""), "store purchase resolved"] + alice <## ("store purchase open: invoice " <> unpaid) + storePurchaseOpen alice "" + waitHeldStoreReceipts (chatController alice) 0 alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) - inAnyOrder alice [["store purchase open: invoice " <> unpaid, openPurchase ""], creditedLines "" "1: supporter"] + alice <### [ConsoleString ("store purchase open: invoice " <> unpaid), StartsWith (openPurchase ""), StartsWith "1: supporter"] alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" googleUnreachableToken)) alice <##. "1: supporter" alice <## ("store purchase open: invoice " <> unpaid) @@ -2435,6 +2450,12 @@ storePurchaseOpen cc userPrefix = cc <##. openPurchase userPrefix openPurchase :: String -> String openPurchase userPrefix = userPrefix <> "store purchase open: invoice none, transaction " +invoicePurchase :: String -> String -> String +invoicePurchase userPrefix invoiceId = userPrefix <> "store purchase open: invoice " <> invoiceId <> ", transaction " + -- | The worker's credit as the owner's terminal shows it: the badge, then the settlement. -creditedLines :: String -> String -> [String] -creditedLines userPrefix badge = [userPrefix <> badge, userPrefix <> "store purchase resolved"] +creditedLines :: String -> String -> String -> [String] +creditedLines userPrefix invoiceId badge = [userPrefix <> badge, userPrefix <> "store purchase credited: invoice " <> invoiceId] + +refusedLine :: String -> String -> String -> String +refusedLine userPrefix invoiceId failure = userPrefix <> "store purchase refused: invoice " <> invoiceId <> ", " <> failure From efab293609c760a1a506e529cdcb08e3380abc06 Mon Sep 17 00:00:00 2001 From: sh <37271604+shumvgolove@users.noreply.github.com> Date: Thu, 8 Oct 2026 18:48:50 +0400 Subject: [PATCH 06/26] desktop: deep links on macOS, Windows and Linux (#7605) * tests: close the walk stream in withTempDir * desktop: receive app links from args and macOS * desktop: forward an app link to the running app * desktop: initialize the desktop platform lazily * tests: share the temp directory helper * desktop: register simplexchat scheme in packages * desktop: register simplexchat scheme at runtime * ui: end the badge page with a link on desktop * desktop: raise the window over other apps * docs: describe desktop deep links in the spec * docs: plan desktop deep links * docs: report on desktop deep links * desktop: open simplex connection links * docs: describe simplex links on desktop * desktop: keep a link from opening twice * desktop: retry taking a signal held open * desktop: keep the user's AppImage link handler * desktop: register Windows links through Capabilities * desktop: add %u to the deb entry only once * docs: describe the review fixes * ui: open the badge link screen on the left * ui: import moko accessors in the badge screens --------- Co-authored-by: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> --- apps/multiplatform/CODE.md | 6 +- .../common/platform/AppCommon.android.kt | 3 + .../chat/simplex/common/platform/AppCommon.kt | 2 + .../simplex/common/views/badges/BadgeStore.kt | 6 +- .../views/badges/BadgesRedeemCodeView.kt | 8 +- .../views/badges/BadgesSupportSimplexView.kt | 9 +- .../common/views/chatlist/ChatListView.kt | 6 +- .../chat/simplex/app/BadgePageUrlTest.kt | 19 + .../kotlin/chat/simplex/common/AppLinks.kt | 33 + .../kotlin/chat/simplex/common/DesktopApp.kt | 5 + .../chat/simplex/common/SingleInstance.kt | 193 ++++- .../chat/simplex/common/WindowActivation.kt | 63 ++ .../common/platform/AppLinkScheme.desktop.kt | 368 ++++++++++ .../common/platform/Platform.desktop.kt | 6 +- .../chat/simplex/app/AppLinkFixtures.kt | 14 + .../chat/simplex/app/AppLinkSchemeTest.kt | 680 ++++++++++++++++++ .../kotlin/chat/simplex/app/AppLinksTest.kt | 71 ++ .../chat/simplex/app/SingleInstanceTest.kt | 281 +++++++- .../kotlin/chat/simplex/app/TempDir.kt | 20 + .../chat/simplex/app/WindowActivationTest.kt | 86 +++ apps/multiplatform/desktop/build.gradle.kts | 12 + .../kotlin/chat/simplex/desktop/Main.kt | 19 +- .../resources/distribute/SimpleX.desktop | 3 +- apps/multiplatform/product/concepts.md | 1 + apps/multiplatform/product/gaps.md | 33 + apps/multiplatform/spec/README.md | 8 +- apps/multiplatform/spec/architecture.md | 18 +- apps/multiplatform/spec/client/navigation.md | 8 +- apps/multiplatform/spec/impact.md | 4 + plans/2026-09-24-badge-buy-in-browser.md | 12 +- plans/2026-09-28-desktop-deep-links-report.md | 150 ++++ plans/2026-09-28-desktop-deep-links.md | 145 ++++ scripts/desktop/make-appimage-linux.sh | 2 +- scripts/desktop/make-deb-linux.sh | 4 + scripts/flatpak/chat.simplex.simplex.desktop | 1 + 35 files changed, 2219 insertions(+), 80 deletions(-) create mode 100644 apps/multiplatform/common/src/commonTest/kotlin/chat/simplex/app/BadgePageUrlTest.kt create mode 100644 apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt create mode 100644 apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt create mode 100644 apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt create mode 100644 apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkFixtures.kt create mode 100644 apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkSchemeTest.kt create mode 100644 apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinksTest.kt create mode 100644 apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/TempDir.kt create mode 100644 apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/WindowActivationTest.kt create mode 100644 plans/2026-09-28-desktop-deep-links-report.md create mode 100644 plans/2026-09-28-desktop-deep-links.md diff --git a/apps/multiplatform/CODE.md b/apps/multiplatform/CODE.md index 30462d18e8..d27b4b9718 100644 --- a/apps/multiplatform/CODE.md +++ b/apps/multiplatform/CODE.md @@ -285,9 +285,13 @@ desktop/src/jvmMain/kotlin/chat/simplex/desktop/ -- Desktop app (1 file) | Source Location | Spec Document | Product Document | |----------------|---------------|-----------------| -| desktop/.../desktop/Main.kt | spec/architecture.md | product/flows/onboarding.md | +| desktop/.../desktop/Main.kt | spec/architecture.md, spec/client/navigation.md | product/flows/onboarding.md | | common/.../common/DesktopApp.kt (desktopMain) | spec/architecture.md | product/views/chat-list.md | | common/.../common/StoreWindowState.kt (desktopMain) | spec/architecture.md | product/views/settings.md | +| common/.../common/AppLinks.kt (desktopMain) | spec/client/navigation.md | product/views/settings.md | +| common/.../common/SingleInstance.kt (desktopMain) | spec/architecture.md, spec/client/navigation.md | product/flows/onboarding.md | +| common/.../common/WindowActivation.kt (desktopMain) | spec/architecture.md | product/views/chat-list.md | +| common/.../common/platform/AppLinkScheme.desktop.kt (desktopMain) | spec/client/navigation.md | product/views/settings.md | | common/.../common/model/NtfManager.desktop.kt (desktopMain) | spec/services/notifications.md | product/flows/messaging.md | | common/.../common/views/helpers/AppUpdater.kt (desktopMain) | spec/architecture.md | product/views/settings.md | | common/.../common/platform/AnimatedImage.desktop.kt (desktopMain) | spec/client/chat-view.md | product/views/chat.md | diff --git a/apps/multiplatform/common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt b/apps/multiplatform/common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt index a5e105ce93..f192b4da35 100644 --- a/apps/multiplatform/common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt +++ b/apps/multiplatform/common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt @@ -25,6 +25,9 @@ val defaultLocale: Locale = Locale.getDefault() actual fun isAppVisibleAndFocused(): Boolean = isAppOnForeground +// the manifest declares the scheme +actual fun appLinkSchemeRegistered(): Boolean = true + @SuppressLint("StaticFieldLeak") lateinit var androidAppContext: Context var mainActivity: WeakReference = WeakReference(null) diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt index a6ede20e41..1da9d8ff40 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt @@ -25,6 +25,8 @@ expect val deviceName: String expect fun isAppVisibleAndFocused(): Boolean +expect fun appLinkSchemeRegistered(): Boolean + val appVersionInfo: Pair = if (appPlatform == AppPlatform.ANDROID) BuildConfigCommon.ANDROID_VERSION_NAME to BuildConfigCommon.ANDROID_VERSION_CODE else diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index 6e846678c2..5f63f38670 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -52,10 +52,10 @@ fun newBadgeInvoiceId(): String = UUID.randomUUID().toString() // the page's app flag rides in the fragment, which never reaches the service // TEST ONLY: pointed at the dev deployment; restore the two lines below before merging -val badgePageUrl: String = - if (appPlatform.isAndroid) "https://smp7.simplex.im/#/tier?app=true" +fun badgePageUrl(linkReturns: Boolean): String = + if (linkReturns) "https://smp7.simplex.im/#/tier?app=true" else "https://smp7.simplex.im/#/tier?app=desktop" -// if (appPlatform.isAndroid) "https://badges.simplex.chat/#/tier?app=true" +// if (linkReturns) "https://badges.simplex.chat/#/tier?app=true" // else "https://badges.simplex.chat/#/tier?app=desktop" // where the store allows a link out to the badge page: the US for now, a set expected to widen. diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt index 5c943b254c..b3e74d3e2c 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt @@ -262,7 +262,7 @@ private fun SubmitButton(enabled: Boolean, onClick: () -> Unit) { private var badgeLinkStep: MutableState? = null private fun isBadgeLinkOpen(): Boolean = - ModalManager.end.hasModalOpen(ModalViewId.BADGE_LINK) + ModalManager.start.hasModalOpen(ModalViewId.BADGE_LINK) fun isBadgeLinkIssuing(): Boolean = isBadgeLinkOpen() && badgeLinkStep?.value == BadgeLinkStep.Issuing @@ -275,7 +275,7 @@ fun openBadgeLink(rhId: Long?, codeText: String) { // held by the modal, not remembered: a modal is composed only while on top, and rotation recreates the activity, // either of which would reset remembered state to Confirming with a request in flight val step = mutableStateOf(BadgeLinkStep.Confirming) - ModalManager.end.showCustomModal(id = ModalViewId.BADGE_LINK) { close -> + ModalManager.start.showCustomModal(id = ModalViewId.BADGE_LINK) { close -> BadgesRedeemLinkView(rhId, code, step, close) } badgeLinkStep = step @@ -298,7 +298,7 @@ fun BadgesRedeemLinkView(rhId: Long?, code: String, step: MutableState ModalView(::closeIfShowing) { BeingIssued(onDismiss = ::closeIfShowing) } - BadgeLinkStep.Redeemed, BadgeLinkStep.ViewingBadge -> BadgesView(ModalManager.end, close) + BadgeLinkStep.Redeemed, BadgeLinkStep.ViewingBadge -> BadgesView(ModalManager.start, close) } } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt index 040a2c6e19..f81d561120 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesSupportSimplexView.kt @@ -130,7 +130,7 @@ private fun BuyInBrowserTextButton() { val uriHandler = LocalUriHandler.current TextButtonBelowOnboardingButton( text = stringResource(MR.strings.badges_buy_in_browser), - onClick = { uriHandler.openUriCatching(badgePageUrl) } + onClick = { uriHandler.openUriCatching(badgePageUrl(appLinkSchemeRegistered())) } ) } @@ -142,9 +142,10 @@ private fun BuyInBrowserButton(modalManager: ModalManager, unwindToDepth: Int) { labelId = MR.strings.badges_buy_in_browser, onboarding = null, onclick = { - uriHandler.openUriCatching(badgePageUrl) - // desktop has no scheme to bring the code back, so the code is pasted into this screen, opened beside the browser - if (appPlatform.isDesktop && !modalManager.hasModalOpen(ModalViewId.BADGE_REDEEM_CODE)) { + val linkReturns = appLinkSchemeRegistered() + uriHandler.openUriCatching(badgePageUrl(linkReturns)) + // with no scheme to bring the code back, the code is pasted into this screen, opened beside the browser + if (!linkReturns && !modalManager.hasModalOpen(ModalViewId.BADGE_REDEEM_CODE)) { modalManager.showModal(id = ModalViewId.BADGE_REDEEM_CODE) { BadgesRedeemCodeView(modalManager, unwindToDepth) } } } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt index ba64f807ba..31dfc4f64d 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt @@ -789,13 +789,17 @@ fun connectIfOpenedViaUri(rhId: Long?, uri: String, chatModel: ChatModel) { } // the app's own scheme, for every link that is not a connection link, which stays on simplex: -private const val appLinkScheme = "simplexchat" +internal const val appLinkScheme = "simplexchat" +internal const val connectionLinkScheme = "simplex" private const val badgeLinkPath = "/badge/code/" // the prefix of the raw text, not a parsed URI: a link that does not parse is still an app link fun isAppLink(uri: String): Boolean = uri.startsWith("$appLinkScheme:", ignoreCase = true) +fun isConnectionLink(uri: String): Boolean = + uri.startsWith("$connectionLinkScheme:", ignoreCase = true) + // a link type added in a later version reaches this build too, so an unknown path asks for an update private fun openAppLink(rhId: Long?, uri: String) { // a link that does not parse is dropped, as iOS never receives one; one that parses without diff --git a/apps/multiplatform/common/src/commonTest/kotlin/chat/simplex/app/BadgePageUrlTest.kt b/apps/multiplatform/common/src/commonTest/kotlin/chat/simplex/app/BadgePageUrlTest.kt new file mode 100644 index 0000000000..c6baf89fcb --- /dev/null +++ b/apps/multiplatform/common/src/commonTest/kotlin/chat/simplex/app/BadgePageUrlTest.kt @@ -0,0 +1,19 @@ +package chat.simplex.app + +import chat.simplex.common.views.badges.badgePageUrl +import kotlin.test.Test +import kotlin.test.assertTrue + +class BadgePageUrlTest { + @Test + fun pageEndsWithALinkBackWhenTheLinkReturnsToTheApp() { + val url = badgePageUrl(linkReturns = true) + assertTrue(url.endsWith("#/tier?app=true"), "url: $url") + } + + @Test + fun pageEndsWithACodeToPasteWhenNoLinkReturns() { + val url = badgePageUrl(linkReturns = false) + assertTrue(url.endsWith("#/tier?app=desktop"), "url: $url") + } +} diff --git a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt new file mode 100644 index 0000000000..067d4edfd6 --- /dev/null +++ b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt @@ -0,0 +1,33 @@ +package chat.simplex.common + +import chat.simplex.common.platform.chatModel +import chat.simplex.common.views.chatlist.isAppLink +import chat.simplex.common.views.chatlist.isConnectionLink +import java.awt.Desktop + +// A one-time link with its post-quantum key is about 2 KB, near 4 KB with a second such key; +// the bound caps what the app accepts from outside. +internal const val MAX_LINK_BYTES = 8192 + +internal fun isAcceptedLink(uri: String): Boolean = + uri.toByteArray(Charsets.UTF_8).size <= MAX_LINK_BYTES && (isAppLink(uri) || isConnectionLink(uri)) + +fun linkFromArgs(args: Array): String? = + args.singleOrNull()?.takeIf(::isAcceptedLink) + +// The link is stored before showWindow, so a failure to show the window cannot lose it. +internal fun openDesktopLink(uri: String) { + chatModel.appOpenUrl.value = chatModel.remoteHostId() to uri + showWindow() +} + +// macOS delivers a link as an Apple Event, never in args; the JDK queues it until a handler is set +fun installOpenUriHandler() { + if (!Desktop.isDesktopSupported()) return + val desktop = Desktop.getDesktop() + if (!desktop.isSupported(Desktop.Action.APP_OPEN_URI)) return + desktop.setOpenURIHandler { event -> + val uri = event.uri.toString() + if (isAcceptedLink(uri)) openDesktopLink(uri) + } +} diff --git a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt index 3e48621d03..77dad81aa4 100644 --- a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt +++ b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt @@ -259,11 +259,16 @@ private fun ApplicationScope.handleCloseRequest(closedByError: MutableState { lockHandle = result.lock singleInstanceLock = true - deleteShowFile() - startShowFileWatcher() + deleteStaleSignalFiles(dataDir.toPath(), lockAttemptTime) return true } LockResult.Failed -> { return true } LockResult.Taken -> { - // Ensure the signal file exists (createShowFile is a no-op if it does) - // and wait up to 1s for the primary's watcher to consume it. If still - // there after the wait, the primary is hung — let the user decide. - createShowFile() - val deadline = System.currentTimeMillis() + 1000 - while (Files.exists(showPath) && System.currentTimeMillis() < deadline) { - try { Thread.sleep(50) } catch (_: InterruptedException) { break } - } - if (!Files.exists(showPath)) return false - val start = showSingleInstanceAlert() - if (start) deleteShowFile() - return start + if (desktopPlatform.isWindows()) allowPrimaryForeground() + return startDespiteRunningInstance(dataDir.toPath(), link, SIGNAL_WAIT_MILLIS, ::showSingleInstanceAlert) } } } @@ -84,20 +90,129 @@ private fun tryAcquireLock(): LockResult { } } -private fun deleteShowFile() { - try { Files.deleteIfExists(showPath) } catch (e: IOException) { - Log.w(TAG, "single-instance: cannot delete show file: ${e.message}") +// A signal still present after the wait means the running instance is hung, so the user decides. +internal fun startDespiteRunningInstance(dir: Path, link: String?, waitMillis: Long, askToStart: () -> Boolean): Boolean { + signalRunningInstance(dir, link) + val show = dir.resolve(SHOW_FILE) + val deadline = System.currentTimeMillis() + waitMillis + while (Files.exists(show) && System.currentTimeMillis() < deadline) { + try { Thread.sleep(SIGNAL_POLL_MILLIS) } catch (_: InterruptedException) { break } + } + if (!Files.exists(show) || !askToStart()) return false + // The running instance can recover while the alert is up; once it has taken the signal, it opens the link itself. + return try { + Files.deleteIfExists(show) + } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot withdraw signal file: ${e.message}") + true } } -private fun createShowFile() { - try { Files.createFile(showPath) } catch (_: FileAlreadyExistsException) { - // Another duplicate already signalled; primary will pick it up. - } catch (e: IOException) { - Log.w(TAG, "single-instance: cannot create show file: ${e.message}") +private fun deleteSignalFile(path: Path) { + try { Files.deleteIfExists(path) } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot delete signal file: ${e.message}") } } +internal fun deleteStaleSignalFiles(dir: Path, lockAttemptTime: FileTime) { + val staleBefore = FileTime.from(lockAttemptTime.toInstant().minus(FILE_TIME_TOLERANCE)) + try { + // only a running instance takes a signal, so a taken file at startup was left by a crash + Files.deleteIfExists(dir.resolve(TAKEN_SHOW_FILE)) + Files.newDirectoryStream(dir, "$SHOW_FILE*").use { files -> + files.forEach { file -> + try { + if (Files.getLastModifiedTime(file) < staleBefore) Files.deleteIfExists(file) + } catch (_: NoSuchFileException) { + // a second process renamed its temp file meanwhile + } + } + } + } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot delete stale signal files: ${e.message}") + } catch (e: DirectoryIteratorException) { + Log.w(TAG, "single-instance: cannot delete stale signal files: ${e.cause?.message}") + } +} + +// The temp file is owner-only on POSIX, as the link is a bearer secret, and the rename makes it appear whole. +internal fun signalRunningInstance(dir: Path, link: String?) { + var tmp: Path? = null + try { + tmp = Files.createTempFile(dir, SHOW_FILE, SHOW_TMP_SUFFIX) + Files.write(tmp, (link ?: "").toByteArray(Charsets.UTF_8)) + Files.move(tmp, dir.resolve(SHOW_FILE), ATOMIC_MOVE) + } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot signal running instance: ${e.message}") + tmp?.let(::deleteSignalFile) + // an empty signal needs no free space and still brings the running instance forward + try { + Files.createFile(dir.resolve(SHOW_FILE)) + } catch (_: FileAlreadyExistsException) { + // another process has already signalled + } catch (createError: IOException) { + Log.w(TAG, "single-instance: cannot create signal file: ${createError.message}") + } + } +} + +// The signal is renamed before it is read, so a newer signal renamed over it meanwhile is not deleted unread. +internal fun takeSignal(dir: Path, move: (Path, Path) -> Unit = ::moveAtomically): ShowSignal? { + val taken = dir.resolve(TAKEN_SHOW_FILE) + try { + moveWithRetry(dir.resolve(SHOW_FILE), taken, move) + } catch (_: NoSuchFileException) { + return null + } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot take signal file: ${e.message}") + return ShowSignal(null) + } + val bytes = try { + Files.newInputStream(taken).use { it.readNBytes(MAX_LINK_BYTES + 1) } + } catch (e: IOException) { + Log.w(TAG, "single-instance: cannot read signal file: ${e.message}") + null + } finally { + deleteSignalFile(taken) + } + return ShowSignal(bytes?.toString(Charsets.UTF_8)?.takeIf(::isAcceptedLink)) +} + +private fun moveAtomically(from: Path, to: Path) { + Files.move(from, to, ATOMIC_MOVE) +} + +// Another program, such as an antivirus scanner on Windows, can hold the file open for a moment. +private fun moveWithRetry(from: Path, to: Path, move: (Path, Path) -> Unit) { + try { + move(from, to) + } catch (e: NoSuchFileException) { + throw e + } catch (e: IOException) { + try { + Thread.sleep(SIGNAL_RETRY_MILLIS) + } catch (_: InterruptedException) { + Thread.currentThread().interrupt() + throw e + } + move(from, to) + } +} + +// Win32 ASFW_ANY lets every process take the foreground +private const val ASFW_ANY = -1 + +// Windows lets only the foreground process raise a window; the launching browser passed that right to this process. +private fun allowPrimaryForeground() { + val allowed = try { + NativeLibrary.getInstance("user32").getFunction("AllowSetForegroundWindow").invokeInt(arrayOf(ASFW_ANY)) != 0 + } catch (e: UnsatisfiedLinkError) { + Log.w(TAG, "single-instance: AllowSetForegroundWindow unavailable: ${e.message}") + return + } + if (!allowed) Log.w(TAG, "single-instance: AllowSetForegroundWindow refused") +} + private fun showSingleInstanceAlert(): Boolean { val title = chat.simplex.common.views.helpers.generalGetString(chat.simplex.res.MR.strings.another_instance_title) val message = chat.simplex.common.views.helpers.generalGetString(chat.simplex.res.MR.strings.another_instance_not_responding) @@ -109,26 +224,34 @@ private fun showSingleInstanceAlert(): Boolean { return result == javax.swing.JOptionPane.YES_OPTION } -private fun startShowFileWatcher() { +fun startShowFileWatcher() { if (watcher != null) return + val dir = dataDir.toPath() val ws = try { - dataDir.toPath().fileSystem.newWatchService() + dir.fileSystem.newWatchService() } catch (e: IOException) { Log.w(TAG, "single-instance: WatchService failed: ${e.message}") return } - dataDir.toPath().register(ws, StandardWatchEventKinds.ENTRY_CREATE) + dir.register(ws, StandardWatchEventKinds.ENTRY_CREATE) watcher = ws thread(name = "simplex-single-instance", isDaemon = true) { - while (true) { - val key = try { ws.take() } catch (_: ClosedWatchServiceException) { return@thread } catch (_: InterruptedException) { return@thread } - for (event in key.pollEvents()) { - if ((event.context() as? Path)?.fileName?.toString() == "simplex.show") { - deleteShowFile() - SwingUtilities.invokeLater { showWindow() } - } + watchShowSignals(ws, dir) { signal -> + SwingUtilities.invokeLater { + if (signal.link != null) openDesktopLink(signal.link) else showWindow() } - if (!key.reset()) return@thread } } } + +// dir must already be registered with ws; a signal written before that raised no event, so it is taken first. +internal fun watchShowSignals(ws: WatchService, dir: Path, onSignal: (ShowSignal) -> Unit) { + takeSignal(dir)?.let(onSignal) + while (true) { + val key = try { ws.take() } catch (_: ClosedWatchServiceException) { return } catch (_: InterruptedException) { return } + for (event in key.pollEvents()) { + if ((event.context() as? Path)?.fileName?.toString() == SHOW_FILE) takeSignal(dir)?.let(onSignal) + } + if (!key.reset()) return + } +} diff --git a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt new file mode 100644 index 0000000000..0859a75225 --- /dev/null +++ b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt @@ -0,0 +1,63 @@ +package chat.simplex.common + +import chat.simplex.common.platform.Log +import chat.simplex.common.platform.TAG +import com.sun.jna.Native +import com.sun.jna.NativeLong +import com.sun.jna.platform.unix.X11 +import java.awt.Toolkit +import java.awt.Window + +// EWMH source indication of a pager, which window managers exempt from focus stealing prevention +private const val NET_ACTIVE_WINDOW_SOURCE_PAGER = 2L +private const val CLIENT_MESSAGE_FORMAT_BITS = 32 + +// AWT's toFront() sends only XRaiseWindow, which wlroots compositors (Sway) drop and focus stealing +// prevention refuses; _NET_ACTIVE_WINDOW is the request X11 and XWayland window managers act on. +internal fun requestX11Activation(window: Window) { + val x11: X11 + val windowId: Long + try { + x11 = X11.INSTANCE + windowId = Native.getWindowID(window) + } catch (e: LinkageError) { + Log.w(TAG, "window activation: native library unavailable: ${e.message}") + return + } catch (e: IllegalStateException) { + Log.w(TAG, "window activation: no native window: ${e.message}") + return + } + // The map request goes out on AWT's connection; flushing it first lets the window manager map the window before activating it. + Toolkit.getDefaultToolkit().sync() + sendActivation(x11, windowId) +} + +internal fun sendActivation(x11: X11, windowId: Long) { + val display = x11.XOpenDisplay(null) + if (display == null) { + Log.w(TAG, "window activation: cannot open the X display") + return + } + try { + val event = activationEvent(X11.Window(windowId), x11.XInternAtom(display, "_NET_ACTIVE_WINDOW", false)) + val mask = NativeLong((X11.SubstructureRedirectMask or X11.SubstructureNotifyMask).toLong()) + x11.XSendEvent(display, x11.XDefaultRootWindow(display), 0, mask, event) + x11.XFlush(display) + } finally { + x11.XCloseDisplay(display) + } +} + +internal fun activationEvent(window: X11.Window, activeWindowAtom: X11.Atom): X11.XEvent { + val event = X11.XEvent() + event.setType(X11.XClientMessageEvent::class.java) + event.xclient.type = X11.ClientMessage + event.xclient.window = window + event.xclient.message_type = activeWindowAtom + event.xclient.format = CLIENT_MESSAGE_FORMAT_BITS + event.xclient.data.setType(Array::class.java) + event.xclient.data.l[0] = NativeLong(NET_ACTIVE_WINDOW_SOURCE_PAGER) + // the request carries no user interaction timestamp + event.xclient.data.l[1] = NativeLong(X11.CurrentTime.toLong()) + return event +} diff --git a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt new file mode 100644 index 0000000000..1187316959 --- /dev/null +++ b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt @@ -0,0 +1,368 @@ +package chat.simplex.common.platform + +import chat.simplex.common.views.chatlist.appLinkScheme +import chat.simplex.common.views.chatlist.connectionLinkScheme +import com.sun.jna.NativeLibrary +import com.sun.jna.WString +import com.sun.jna.platform.win32.Advapi32Util +import com.sun.jna.platform.win32.Win32Exception +import com.sun.jna.platform.win32.WinReg.HKEY +import com.sun.jna.platform.win32.WinReg.HKEY_CURRENT_USER +import com.sun.jna.platform.win32.WinReg.HKEY_LOCAL_MACHINE +import com.sun.jna.ptr.IntByReference +import java.io.File +import java.io.IOException +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.attribute.PosixFileAttributes +import java.nio.file.attribute.PosixFilePermission +import java.util.concurrent.TimeUnit +import kotlin.concurrent.thread + +internal const val APP_LINK_MIME_TYPE = "x-scheme-handler/$appLinkScheme" +internal const val CONNECTION_LINK_MIME_TYPE = "x-scheme-handler/$connectionLinkScheme" +private const val WINDOWS_CLASSES_KEY = "Software\\Classes" +private const val WINDOWS_PROG_ID_PREFIX = "SimpleX." +private const val WINDOWS_CAPABILITIES_KEY = "Software\\chat.simplex.app\\Capabilities" +private const val WINDOWS_REGISTERED_APPLICATIONS_KEY = "Software\\RegisteredApplications" +private const val APP_DESCRIPTION = "Private and secure open-source messenger - no user IDs (not even random numbers)" +private const val WINDOWS_FIRST_ICON_INDEX = 0 +// values from shlwapi.h and shlobj_core.h +private const val ASSOCF_IS_PROTOCOL = 0x1000 +private const val ASSOCSTR_EXECUTABLE = 2 +private const val S_OK = 0 +private const val S_FALSE = 1 +private const val SHCNE_ASSOCCHANGED = 0x08000000 +private const val SHCNF_IDLIST = 0 +// the Win32 name of a key's default value +private const val REGISTRY_DEFAULT_VALUE = "" +internal const val APPIMAGE_ENTRY_NAME = "chat.simplex.app-links.desktop" +private const val APPLICATIONS_DIR = "applications" +// the XDG Base Directory default when XDG_DATA_DIRS is unset +private const val DEFAULT_XDG_DATA_DIRS = "/usr/local/share:/usr/share" +private const val APP_DISPLAY_NAME = "SimpleX Chat" +private const val XDG_MIME = "xdg-mime" +// jpackage names the deb's desktop entry -.desktop +private const val DEB_ENTRY_NAME = "simplex-simplex.desktop" +private const val PROCESS_TIMEOUT_SECONDS = 5L +private const val ROOT_USER = "root" +// the characters the desktop entry spec requires an Exec argument to quote +private const val EXEC_RESERVED_CHARACTERS = " \t\n\"'\\><~|&;$*?#()`" + +internal sealed interface DesktopInstallation { + data object MacBundle : DesktopInstallation + data class WindowsExe(val path: String) : DesktopInstallation + data object Flatpak : DesktopInstallation + data class AppImage(val path: String) : DesktopInstallation + data object LinuxPackage : DesktopInstallation + data object Unpackaged : DesktopInstallation +} + +// Only simplexchat: decides how the badge page ends, so simplex: is registered without being checked here. +@Volatile +private var registered = false + +actual fun appLinkSchemeRegistered(): Boolean = registered + +fun registerLinkSchemes() { + thread(name = "simplex-link-schemes", isDaemon = true) { + registered = registerForThisInstallation() + } +} + +// appPath is jpackage.app-path, set by jpackage's launcher, so only a packaged app has one. +internal fun desktopInstallation(platform: DesktopPlatform, appPath: String?, env: Map): DesktopInstallation { + val appImage = env["APPIMAGE"] + val appDir = env["APPDIR"] + return when { + appPath == null -> DesktopInstallation.Unpackaged + platform.isMac() -> DesktopInstallation.MacBundle + platform.isWindows() -> DesktopInstallation.WindowsExe(appPath) + env["container"] == "flatpak" -> DesktopInstallation.Flatpak + // The AppImage runtime exports APPIMAGE to every child process, so it describes this app only + // when the launcher runs from the AppImage's own mount. + appImage != null && appDir != null && Path.of(appPath).startsWith(realPathOrSelf(appDir)) -> DesktopInstallation.AppImage(appImage) + else -> DesktopInstallation.LinuxPackage + } +} + +// jpackage.app-path is resolved through /proc/self/exe, while APPDIR keeps any symlink in TMPDIR. +private fun realPathOrSelf(path: String): Path = + try { + Path.of(path).toRealPath() + } catch (_: IOException) { + Path.of(path) + } + +private fun registerForThisInstallation(): Boolean = + when (val installation = desktopInstallation(desktopPlatform, System.getProperty("jpackage.app-path"), System.getenv())) { + // The bundle's Info.plist and the Flatpak's exported desktop entry register the schemes. + DesktopInstallation.MacBundle, DesktopInstallation.Flatpak -> true + is DesktopInstallation.WindowsExe -> registerWindowsSchemes(installation.path, SystemWindowsShell) + is DesktopInstallation.AppImage -> + registerAppImageScheme(installation.path, File(unixDataHome, APPLICATIONS_DIR), systemApplicationsDirs(), ::runProcess) + DesktopInstallation.LinuxPackage -> linuxPackageRegistered(::runProcess) + DesktopInstallation.Unpackaged -> false + } + +internal fun windowsOpenCommand(appPath: String): String = "\"$appPath\" \"%1\"" + +internal fun windowsCommandProgram(command: String): String = + if (command.startsWith("\"")) command.substring(1).substringBefore('"') else command.substringBefore(' ') + +internal data class RegistryValue(val key: String, val name: String, val value: String) + +private fun windowsSchemeKey(scheme: String): String = "$WINDOWS_CLASSES_KEY\\$scheme" + +private fun windowsCommandKey(scheme: String): String = "${windowsSchemeKey(scheme)}\\shell\\open\\command" + +private fun windowsProgId(scheme: String): String = "$WINDOWS_PROG_ID_PREFIX$scheme" + +private fun windowsProgIdKey(scheme: String): String = "$WINDOWS_CLASSES_KEY\\${windowsProgId(scheme)}" + +private fun windowsProgIdCommandKey(scheme: String): String = "${windowsProgIdKey(scheme)}\\shell\\open\\command" + +private fun windowsIcon(appPath: String): String = "\"$appPath\",$WINDOWS_FIRST_ICON_INDEX" + +// The scheme key declares the URL scheme, but its command opens links only while no app registered through +// Capabilities claims the scheme: Windows settings offer only the ProgIds that Capabilities name. +internal fun windowsSchemeValues(scheme: String, appPath: String): List { + val schemeKey = windowsSchemeKey(scheme) + return listOf( + RegistryValue(key = schemeKey, name = REGISTRY_DEFAULT_VALUE, value = "URL:$APP_DISPLAY_NAME"), + // without this value Windows does not treat the key as a URL scheme + RegistryValue(key = schemeKey, name = "URL Protocol", value = ""), + RegistryValue(key = "$schemeKey\\DefaultIcon", name = REGISTRY_DEFAULT_VALUE, value = windowsIcon(appPath)), + RegistryValue(key = windowsCommandKey(scheme), name = REGISTRY_DEFAULT_VALUE, value = windowsOpenCommand(appPath)), + RegistryValue(key = "$WINDOWS_CAPABILITIES_KEY\\URLAssociations", name = scheme, value = windowsProgId(scheme)), + ) +} + +// The ProgId is what links resolve to once the user picks SimpleX in settings, so it is repaired even while +// another program holds the scheme key, but another installed copy's ProgId is kept like any other handler. +internal fun windowsProgIdValues(scheme: String, appPath: String): List { + val progIdKey = windowsProgIdKey(scheme) + return listOf( + RegistryValue(key = progIdKey, name = REGISTRY_DEFAULT_VALUE, value = "URL:$APP_DISPLAY_NAME"), + RegistryValue(key = "$progIdKey\\DefaultIcon", name = REGISTRY_DEFAULT_VALUE, value = windowsIcon(appPath)), + RegistryValue(key = windowsProgIdCommandKey(scheme), name = REGISTRY_DEFAULT_VALUE, value = windowsOpenCommand(appPath)), + ) +} + +// The application is listed last, so Windows never lists it before its capabilities are complete. +internal val windowsApplicationValues: List = listOf( + RegistryValue(key = WINDOWS_CAPABILITIES_KEY, name = "ApplicationName", value = APP_DISPLAY_NAME), + RegistryValue(key = WINDOWS_CAPABILITIES_KEY, name = "ApplicationDescription", value = APP_DESCRIPTION), + RegistryValue(key = WINDOWS_REGISTERED_APPLICATIONS_KEY, name = APP_DISPLAY_NAME, value = WINDOWS_CAPABILITIES_KEY), +) + +internal interface WindowsShell { + fun readUser(key: String, name: String): String? + fun readMachine(key: String, name: String): String? + fun writeUser(value: RegistryValue) + // the program the shell starts for a link, after any choice made in Windows settings + fun linkHandler(scheme: String): String? + fun notifyAssociationsChanged() +} + +internal fun registerWindowsSchemes(appPath: String, shell: WindowsShell): Boolean { + var changed = false + val tracked = object : WindowsShell by shell { + override fun writeUser(value: RegistryValue) { + shell.writeUser(value) + changed = true + } + } + val associated = listOf(appLinkScheme, connectionLinkScheme).filter { registerWindowsScheme(it, appPath, tracked) } + if (associated.isNotEmpty()) writeMissing(windowsApplicationValues, tracked, "the application") + // The notification also clears Explorer's icon cache, so it is sent only after a change. + if (changed) shell.notifyAssociationsChanged() + return shell.linkHandler(appLinkScheme)?.let { isThisProgram(it, appPath) } == true +} + +private fun registerWindowsScheme(scheme: String, appPath: String, shell: WindowsShell): Boolean = + !heldByAnotherProgram(windowsProgIdCommandKey(scheme), appPath, shell) && + writeMissing(windowsProgIdValues(scheme, appPath), shell, "the $scheme: ProgId") && + !heldByAnotherProgram(windowsCommandKey(scheme), appPath, shell) && + writeMissing(windowsSchemeValues(scheme, appPath), shell, "the $scheme: scheme") + +private fun isThisProgram(program: String, appPath: String): Boolean = + File(program).absolutePath.equals(File(appPath).absolutePath, ignoreCase = true) + +// A per-user key hides the machine-wide one, so the machine-wide command counts only without it. +private fun heldByAnotherProgram(commandKey: String, appPath: String, shell: WindowsShell): Boolean = + try { + val current = shell.readUser(commandKey, REGISTRY_DEFAULT_VALUE) ?: shell.readMachine(commandKey, REGISTRY_DEFAULT_VALUE) + val program = current?.let(::windowsCommandProgram) + program != null && !isThisProgram(program, appPath) && File(program).isFile + } catch (e: Win32Exception) { + Log.w(TAG, "link scheme: cannot read the handler under $commandKey: ${e.message}") + true + } + +private fun writeMissing(values: List, shell: WindowsShell, what: String): Boolean { + fun stored() = values.all { shell.readUser(it.key, it.name) == it.value } + return try { + if (!stored()) values.forEach(shell::writeUser) + stored() + } catch (e: Win32Exception) { + Log.w(TAG, "link scheme: cannot register $what in the registry: ${e.message}") + false + } +} + +private object SystemWindowsShell : WindowsShell { + override fun readUser(key: String, name: String): String? = registryString(HKEY_CURRENT_USER, key, name) + + override fun readMachine(key: String, name: String): String? = registryString(HKEY_LOCAL_MACHINE, key, name) + + override fun writeUser(value: RegistryValue) { + Advapi32Util.registryCreateKey(HKEY_CURRENT_USER, value.key) + Advapi32Util.registrySetStringValue(HKEY_CURRENT_USER, value.key, value.name, value.value) + } + + // jna-platform 5.14 binds neither AssocQueryStringW nor SHChangeNotify. + override fun linkHandler(scheme: String): String? = + try { + val assocQueryString = NativeLibrary.getInstance("shlwapi").getFunction("AssocQueryStringW") + val length = IntByReference(0) + // with no buffer the call reports the length it needs + val sized = assocQueryString.invokeInt(arrayOf(ASSOCF_IS_PROTOCOL, ASSOCSTR_EXECUTABLE, WString(scheme), null, null, length)) + if (sized != S_FALSE) { + null + } else { + val out = CharArray(length.value) + val result = assocQueryString.invokeInt(arrayOf(ASSOCF_IS_PROTOCOL, ASSOCSTR_EXECUTABLE, WString(scheme), null, out, length)) + if (result == S_OK) String(out).substringBefore('\u0000') else null + } + } catch (e: UnsatisfiedLinkError) { + Log.w(TAG, "link scheme: cannot query the $scheme: handler: ${e.message}") + null + } + + override fun notifyAssociationsChanged() { + try { + NativeLibrary.getInstance("shell32").getFunction("SHChangeNotify").invokeVoid(arrayOf(SHCNE_ASSOCCHANGED, SHCNF_IDLIST, null, null)) + } catch (e: UnsatisfiedLinkError) { + Log.w(TAG, "link scheme: cannot announce changed associations: ${e.message}") + } + } +} + +// registryGetStringValue throws a RuntimeException for a value of another type, which another program could write. +private fun registryString(hive: HKEY, key: String, name: String): String? = + if (Advapi32Util.registryValueExists(hive, key, name)) { + Advapi32Util.registryGetValue(hive, key, name) as? String + } else { + null + } + +// Per the desktop entry spec, quoting escapes " ` $ \ and the string escape then doubles every backslash. +// xdg-open 1.1.3 cannot run a quoted program, so quotes are added only when required. +internal fun desktopExecArgument(arg: String): String { + if (arg.none { it in EXEC_RESERVED_CHARACTERS }) return arg + val quoted = arg.replace("\\", "\\\\").replace("\"", "\\\"").replace("`", "\\`").replace("$", "\\$") + return "\"" + quoted.replace("\\", "\\\\") + "\"" +} + +internal fun appImageDesktopEntry(appImagePath: String): String? { + // A line break would end the Exec value and start a key of the path's choosing. + // GLib looks the program up before it expands %%, so no escaping lets it find a path containing %. + if (appImagePath.any { it == '\n' || it == '\r' || it == '%' }) return null + return """ + |[Desktop Entry] + |Type=Application + |Name=$APP_DISPLAY_NAME + |NoDisplay=true + |Exec=${desktopExecArgument(appImagePath)} %u + |MimeType=$APP_LINK_MIME_TYPE;$CONNECTION_LINK_MIME_TYPE; + |""".trimMargin() +} + +// The entry runs this file for every link, so neither it nor any directory above it may be replaceable by another user, +// including the user's own directory inside /tmp, which can be cleaned away and recreated by anyone. +internal fun onlyOwnerCanReplace(path: Path, user: String): Boolean = + try { + generateSequence(path) { it.parent }.all { onlyOwnerCanWrite(Files.readAttributes(it, PosixFileAttributes::class.java), user) } + } catch (_: IOException) { + false + } + +// A group named after the user is a user private group, which umask 002 systems make group-writable. +internal fun onlyOwnerCanWrite(attributes: PosixFileAttributes, user: String): Boolean { + val permissions = attributes.permissions() + return attributes.owner().name in setOf(user, ROOT_USER) && + PosixFilePermission.OTHERS_WRITE !in permissions && + (PosixFilePermission.GROUP_WRITE !in permissions || attributes.group().name == user) +} + +internal fun registerAppImageScheme(appImagePath: String, applicationsDir: File, systemApplicationsDirs: List, run: (List) -> String?): Boolean { + if (!onlyOwnerCanReplace(Path.of(appImagePath), System.getProperty("user.name"))) { + Log.w(TAG, "link scheme: not registered, as other users may replace $appImagePath") + return false + } + val content = appImageDesktopEntry(appImagePath) ?: return false + val entry = File(applicationsDir, APPIMAGE_ENTRY_NAME) + try { + if (!entry.isFile || entry.readText() != content) { + applicationsDir.mkdirs() + entry.writeText(content) + run(listOf("update-desktop-database", applicationsDir.path)) + } + } catch (e: IOException) { + Log.w(TAG, "link scheme: cannot write desktop entry: ${e.message}") + return false + } + val entryDirs = listOf(applicationsDir) + systemApplicationsDirs + val registered = makeAppImageEntryDefault(APP_LINK_MIME_TYPE, entryDirs, run) + makeAppImageEntryDefault(CONNECTION_LINK_MIME_TYPE, entryDirs, run) + return registered +} + +private fun makeAppImageEntryDefault(mimeType: String, entryDirs: List, run: (List) -> String?): Boolean { + val current = xdgDefaultSchemeHandler(mimeType, run) + if (current == APPIMAGE_ENTRY_NAME) return true + // another installed handler keeps the default; only a missing one is replaced + if (current != null && entryDirs.any { File(it, current).isFile }) return false + run(listOf(XDG_MIME, "default", APPIMAGE_ENTRY_NAME, mimeType)) + return xdgDefaultSchemeHandler(mimeType, run) == APPIMAGE_ENTRY_NAME +} + +private fun xdgDefaultSchemeHandler(mimeType: String, run: (List) -> String?): String? = + run(listOf(XDG_MIME, "query", "default", mimeType))?.trim()?.takeIf { it.isNotEmpty() } + +private fun systemApplicationsDirs(): List = + (System.getenv("XDG_DATA_DIRS")?.takeIf { it.isNotEmpty() } ?: DEFAULT_XDG_DATA_DIRS).split(File.pathSeparator).map { File(it, APPLICATIONS_DIR) } + +internal fun linuxPackageRegistered(run: (List) -> String?): Boolean = + xdgDefaultSchemeHandler(APP_LINK_MIME_TYPE, run) == DEB_ENTRY_NAME + +internal fun runProcess(command: List): String? { + val process = try { + ProcessBuilder(command).redirectError(ProcessBuilder.Redirect.DISCARD).start() + } catch (e: IOException) { + Log.w(TAG, "link scheme: cannot run ${command.first()}: ${e.message}") + return null + } + return try { + process.outputStream.close() + if (!process.waitFor(PROCESS_TIMEOUT_SECONDS, TimeUnit.SECONDS)) { + process.destroyForcibly() + Log.w(TAG, "link scheme: ${command.first()} timed out") + null + } else if (process.exitValue() == 0) { + process.inputStream.bufferedReader().readText() + } else { + null + } + } catch (e: IOException) { + Log.w(TAG, "link scheme: ${command.first()} failed: ${e.message}") + null + } catch (_: InterruptedException) { + process.destroyForcibly() + Thread.currentThread().interrupt() + null + } finally { + process.inputStream.close() + } +} diff --git a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/Platform.desktop.kt b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/Platform.desktop.kt index 7ea41d3593..8dd4ba96b6 100644 --- a/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/Platform.desktop.kt +++ b/apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/Platform.desktop.kt @@ -5,8 +5,10 @@ import java.util.* private val home = System.getProperty("user.home") private val unixConfigPath = (System.getenv("XDG_CONFIG_HOME") ?: "$home/.config") + "/simplex" -private val unixDataPath = (System.getenv("XDG_DATA_HOME") ?: "$home/.local/share") + "/simplex" -val desktopPlatform = detectDesktopPlatform() +internal val unixDataHome = System.getenv("XDG_DATA_HOME") ?: "$home/.local/share" +private val unixDataPath = "$unixDataHome/simplex" +// DesktopPlatform's constants read this file's paths, so an eager value is null when the enum initializes first. +val desktopPlatform by lazy { detectDesktopPlatform() } enum class DesktopPlatform(val libExtension: String, val configPath: String, val dataPath: String, val githubAssetName: String) { LINUX_X86_64("so", unixConfigPath, unixDataPath, "simplex-desktop-x86_64.AppImage"), diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkFixtures.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkFixtures.kt new file mode 100644 index 0000000000..0723c12ec3 --- /dev/null +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkFixtures.kt @@ -0,0 +1,14 @@ +package chat.simplex.app + +internal const val BADGE_LINK_PREFIX = "simplexchat:/badge/code/" +internal const val BADGE_LINK = "${BADGE_LINK_PREFIX}SB0000000000000000000" +internal const val OTHER_BADGE_LINK = "${BADGE_LINK_PREFIX}SB1111111111111111111" + +internal fun badgeLinkOfBytes(size: Int): String = BADGE_LINK_PREFIX + "A".repeat(size - BADGE_LINK_PREFIX.length) + +internal const val SHORT_CONNECTION_LINK = "simplex:/a#lrdvu2d8A1GumSmoKb2krQmtKhWXq-tyGpHuM7aMwsw?h=smp6.simplex.im" +private const val ONE_TIME_LINK_PREFIX = "simplex:/invitation#/?v=2-7&smp=smp%3A%2F%2Fexample&e2e=v%3D2-3%26kem_key%3D" +// an sntrup761 public key is 1158 bytes, 1544 characters in base64url +private const val KEM_KEY_CHARACTERS = 1544 + +internal fun oneTimeLinkWithKemKey(): String = ONE_TIME_LINK_PREFIX + "A".repeat(KEM_KEY_CHARACTERS) diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkSchemeTest.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkSchemeTest.kt new file mode 100644 index 0000000000..b86ead9733 --- /dev/null +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinkSchemeTest.kt @@ -0,0 +1,680 @@ +package chat.simplex.app + +import chat.simplex.common.platform.APPIMAGE_ENTRY_NAME +import chat.simplex.common.platform.DesktopInstallation +import chat.simplex.common.platform.DesktopPlatform +import chat.simplex.common.platform.RegistryValue +import chat.simplex.common.platform.APP_LINK_MIME_TYPE +import chat.simplex.common.platform.CONNECTION_LINK_MIME_TYPE +import chat.simplex.common.platform.appImageDesktopEntry +import chat.simplex.common.platform.desktopExecArgument +import chat.simplex.common.platform.desktopInstallation +import chat.simplex.common.platform.linuxPackageRegistered +import chat.simplex.common.platform.onlyOwnerCanReplace +import chat.simplex.common.platform.onlyOwnerCanWrite +import chat.simplex.common.platform.registerAppImageScheme +import chat.simplex.common.platform.registerWindowsSchemes +import chat.simplex.common.platform.runProcess +import chat.simplex.common.platform.windowsCommandProgram +import chat.simplex.common.platform.windowsApplicationValues +import chat.simplex.common.platform.windowsOpenCommand +import chat.simplex.common.platform.WindowsShell +import chat.simplex.common.platform.windowsProgIdValues +import chat.simplex.common.platform.windowsSchemeValues +import com.sun.jna.platform.win32.Win32Exception +import com.sun.jna.platform.win32.WinError +import com.sun.jna.platform.win32.WinNT +import org.junit.Assume.assumeNoException +import org.junit.Assume.assumeTrue +import java.io.File +import java.lang.reflect.Proxy +import java.nio.file.FileSystemException +import java.nio.file.FileSystems +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.attribute.GroupPrincipal +import java.nio.file.attribute.PosixFileAttributes +import java.nio.file.attribute.PosixFilePermission +import java.nio.file.attribute.PosixFilePermissions +import java.nio.file.attribute.UserPrincipal +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertFalse +import kotlin.test.assertNull +import kotlin.test.assertTrue + +private const val OWNER_WRITABLE = "rwxr-xr-x" +private const val GROUP_WRITABLE = "rwxrwxr-x" +private const val OTHERS_WRITABLE = "rwxr-xrwx" +private const val WORLD_WRITABLE = "rwxrwxrwx" +private const val APPIMAGE_FILE_NAME = "SimpleX.AppImage" +private const val XDG_MIME = "xdg-mime" + +class AppLinkSchemeTest { + private val windowsExe = "C:\\Program Files\\SimpleX\\SimpleX.exe" + private val appLinkCommandKey = "Software\\Classes\\simplexchat\\shell\\open\\command" + private val connectionCommandKey = "Software\\Classes\\simplex\\shell\\open\\command" + private val appLinkCommand = appLinkCommandKey to "" + private val connectionCommand = connectionCommandKey to "" + private val olderWindowsCommand = "\"C:\\Old\\SimpleX.exe\" \"%1\"" + private val appImagePath = "/home/user/$APPIMAGE_FILE_NAME" + + @Test + fun windowsCommandQuotesTheAppAndTheLink() { + assertEquals( + "\"C:\\Program Files\\SimpleX\\SimpleX.exe\" \"%1\"", + windowsOpenCommand(windowsExe) + ) + } + + @Test + fun windowsSchemeIsAUrlProtocolNamingItsProgId() { + assertEquals( + listOf( + RegistryValue(key = "Software\\Classes\\simplexchat", name = "", value = "URL:SimpleX Chat"), + RegistryValue(key = "Software\\Classes\\simplexchat", name = "URL Protocol", value = ""), + RegistryValue(key = "Software\\Classes\\simplexchat\\DefaultIcon", name = "", value = "\"$windowsExe\",0"), + RegistryValue(key = appLinkCommandKey, name = "", value = "\"$windowsExe\" \"%1\""), + RegistryValue(key = "Software\\chat.simplex.app\\Capabilities\\URLAssociations", name = "simplexchat", value = "SimpleX.simplexchat"), + ), + windowsSchemeValues("simplexchat", windowsExe), + "app link scheme" + ) + assertEquals( + listOf( + RegistryValue(key = "Software\\Classes\\simplex", name = "", value = "URL:SimpleX Chat"), + RegistryValue(key = "Software\\Classes\\simplex", name = "URL Protocol", value = ""), + RegistryValue(key = "Software\\Classes\\simplex\\DefaultIcon", name = "", value = "\"$windowsExe\",0"), + RegistryValue(key = connectionCommandKey, name = "", value = "\"$windowsExe\" \"%1\""), + RegistryValue(key = "Software\\chat.simplex.app\\Capabilities\\URLAssociations", name = "simplex", value = "SimpleX.simplex"), + ), + windowsSchemeValues("simplex", windowsExe), + "connection link scheme" + ) + } + + @Test + fun windowsProgIdOpensTheExe() { + assertEquals( + listOf( + RegistryValue(key = "Software\\Classes\\SimpleX.simplexchat", name = "", value = "URL:SimpleX Chat"), + RegistryValue(key = "Software\\Classes\\SimpleX.simplexchat\\DefaultIcon", name = "", value = "\"$windowsExe\",0"), + RegistryValue(key = "Software\\Classes\\SimpleX.simplexchat\\shell\\open\\command", name = "", value = "\"$windowsExe\" \"%1\""), + ), + windowsProgIdValues("simplexchat", windowsExe) + ) + } + + @Test + fun windowsApplicationIsListedInDefaultAppsAfterItsCapabilities() { + assertEquals( + listOf( + RegistryValue(key = "Software\\chat.simplex.app\\Capabilities", name = "ApplicationName", value = "SimpleX Chat"), + RegistryValue( + key = "Software\\chat.simplex.app\\Capabilities", + name = "ApplicationDescription", + value = "Private and secure open-source messenger - no user IDs (not even random numbers)" + ), + RegistryValue(key = "Software\\RegisteredApplications", name = "SimpleX Chat", value = "Software\\chat.simplex.app\\Capabilities"), + ), + windowsApplicationValues + ) + } + + @Test + fun windowsRegistrationWritesEveryValueWhenTheCommandsPointAtAMissingProgram() { + val shell = FakeWindowsShell(user = mutableMapOf(appLinkCommand to olderWindowsCommand, connectionCommand to olderWindowsCommand)) + registerWindowsSchemes(windowsExe, shell) + assertEquals(fullRegistration(), shell.writes) + assertTrue(shell.notified, "Windows is told that associations changed") + } + + @Test + fun windowsCommandProgramIsTheQuotedOrFirstArgument() { + assertEquals("C:\\Program Files\\Other\\Other.exe", windowsCommandProgram("\"C:\\Program Files\\Other\\Other.exe\" \"%1\""), "quoted") + assertEquals("C:\\Other\\Other.exe", windowsCommandProgram("C:\\Other\\Other.exe %1"), "unquoted") + assertEquals("C:\\Other\\Other.exe", windowsCommandProgram("C:\\Other\\Other.exe"), "no arguments") + } + + @Test + fun windowsRegistrationLeavesAFullRegistrationAlone() { + val shell = FakeWindowsShell(user = registered()) + registerWindowsSchemes(windowsExe, shell) + assertEquals(listOf(), shell.writes, "nothing is written again") + assertFalse(shell.notified, "an unchanged registration does not clear Explorer's caches") + } + + @Test + fun windowsRegistrationRepairsAValueMissingBesideAMatchingCommand() { + val shell = FakeWindowsShell(user = registered().apply { remove("Software\\Classes\\simplexchat" to "URL Protocol") }) + registerWindowsSchemes(windowsExe, shell) + assertEquals(windowsSchemeValues("simplexchat", windowsExe), shell.writes, "only the incomplete scheme is rewritten") + } + + @Test + fun windowsRegistrationAnnouncesARepairedApplicationListing() { + val shell = FakeWindowsShell(user = registered().apply { remove("Software\\RegisteredApplications" to "SimpleX Chat") }) + registerWindowsSchemes(windowsExe, shell) + assertEquals(windowsApplicationValues, shell.writes, "only the application listing is rewritten") + assertTrue(shell.notified, "Windows is told that associations changed") + } + + @Test + fun windowsRegistrationKeepsAnotherInstalledHandler() = withTempDir { dir -> + val otherCommand = "\"${Files.createFile(dir.resolve("Other.exe"))}\" \"%1\"" + val shell = FakeWindowsShell(user = mutableMapOf(appLinkCommand to otherCommand, connectionCommand to otherCommand)) + registerWindowsSchemes(windowsExe, shell) + assertEquals( + windowsProgIdValues("simplexchat", windowsExe) + windowsProgIdValues("simplex", windowsExe), + shell.writes, + "only this app's own ProgIds are written; no scheme is taken and no application is listed without one" + ) + } + + @Test + fun windowsRegistrationKeepsAMachineWideHandler() = withTempDir { dir -> + val otherCommand = "\"${Files.createFile(dir.resolve("Other.exe"))}\" \"%1\"" + val shell = FakeWindowsShell(machine = mutableMapOf(appLinkCommand to otherCommand)) + registerWindowsSchemes(windowsExe, shell) + assertTrue(shell.writes.none { it.key == appLinkCommandKey }, "a per-user key would hide the machine-wide handler") + assertTrue(windowsSchemeValues("simplex", windowsExe).all { it in shell.writes }, "the free scheme is taken") + } + + @Test + fun windowsRegistrationRepairsItsProgIdWhileAnotherProgramHoldsTheScheme() = withTempDir { dir -> + val otherCommand = "\"${Files.createFile(dir.resolve("Other.exe"))}\" \"%1\"" + val staleProgId = windowsProgIdValues("simplexchat", "C:\\Old\\SimpleX.exe").associate { (it.key to it.name) to it.value } + val shell = FakeWindowsShell(user = (staleProgId + (appLinkCommand to otherCommand)).toMutableMap()) + registerWindowsSchemes(windowsExe, shell) + assertEquals(windowsProgIdValues("simplexchat", windowsExe), shell.writes.take(3), "the ProgId points at this exe again") + } + + @Test + fun windowsRegistrationReportsTheProgramTheShellStarts() { + assertFalse(registerWindowsSchemes(windowsExe, FakeWindowsShell(user = registered(), handler = "C:\\Other\\Other.exe")), "another app picked in settings") + assertTrue(registerWindowsSchemes(windowsExe, FakeWindowsShell(user = registered(), handler = windowsExe.uppercase())), "paths differ only in case") + assertFalse(registerWindowsSchemes(windowsExe, FakeWindowsShell(user = registered(), handler = null)), "the shell has no answer") + } + + @Test + fun windowsRegistrationContinuesPastARegistryError() { + val shell = FakeWindowsShell(failingWrites = setOf("Software\\Classes\\simplexchat")) + registerWindowsSchemes(windowsExe, shell) + assertTrue(windowsSchemeValues("simplexchat", windowsExe).none { it in shell.writes }, "the app link scheme could not be written") + assertTrue(windowsSchemeValues("simplex", windowsExe).all { it in shell.writes }, "the connection link scheme is still written") + assertTrue(windowsApplicationValues.all { it in shell.writes }, "the application is listed for the scheme that is ours") + } + + @Test + fun windowsRegistrationTakesNoSchemeWhoseHandlerCannotBeRead() { + val shell = FakeWindowsShell(failingReads = setOf(appLinkCommandKey, connectionCommandKey)) + registerWindowsSchemes(windowsExe, shell) + assertEquals( + windowsProgIdValues("simplexchat", windowsExe) + windowsProgIdValues("simplex", windowsExe), + shell.writes, + "an unreadable handler is left alone, and no application is listed without a scheme" + ) + } + + @Test + fun windowsRegistrationTakesNoSchemeWhoseMachineWideHandlerCannotBeRead() { + val shell = FakeWindowsShell(failingMachineReads = setOf(appLinkCommandKey)) + registerWindowsSchemes(windowsExe, shell) + assertTrue(windowsSchemeValues("simplexchat", windowsExe).none { it in shell.writes }, "the app link scheme is left alone") + assertTrue(windowsSchemeValues("simplex", windowsExe).all { it in shell.writes }, "the readable scheme is taken") + } + + @Test + fun windowsRegistrationTakesNoSchemeWhoseProgIdCannotBeWritten() { + val shell = FakeWindowsShell(failingWrites = setOf("Software\\Classes\\SimpleX.simplexchat")) + registerWindowsSchemes(windowsExe, shell) + assertTrue(windowsSchemeValues("simplexchat", windowsExe).none { it in shell.writes }, "URLAssociations must not name a missing ProgId") + } + + @Test + fun windowsRegistrationKeepsAnotherInstalledCopysProgId() = withTempDir { dir -> + val otherCopy = Files.createFile(dir.resolve("SimpleX.exe")).toString() + val otherProgId = windowsProgIdValues("simplexchat", otherCopy).associate { (it.key to it.name) to it.value } + val shell = FakeWindowsShell(user = otherProgId.toMutableMap()) + registerWindowsSchemes(windowsExe, shell) + assertTrue(shell.writes.none { it.key.contains("simplexchat") }, "links picked for the other copy keep reaching it: neither its ProgId nor the scheme is taken") + } + + @Test + fun windowsRegistrationTreatsItsOwnProgramAsItsOwnHandler() = withTempDir { dir -> + val exe = Files.createFile(dir.resolve("SimpleX.exe")).toString() + val otherExe = Files.createFile(dir.resolve("Other.exe")).toString() + val shell = FakeWindowsShell( + user = mutableMapOf(appLinkCommand to "\"$exe\" %1"), + machine = mutableMapOf(appLinkCommand to "\"$otherExe\" \"%1\""), + ) + registerWindowsSchemes(exe, shell) + assertTrue(windowsSchemeValues("simplexchat", exe).all { it in shell.writes }, "a command for this exe is updated, and the hidden machine-wide one is ignored") + } + + private fun fullRegistration(): List = + windowsProgIdValues("simplexchat", windowsExe) + windowsSchemeValues("simplexchat", windowsExe) + + windowsProgIdValues("simplex", windowsExe) + windowsSchemeValues("simplex", windowsExe) + windowsApplicationValues + + private fun registered(): MutableMap, String> = + fullRegistration().associate { (it.key to it.name) to it.value }.toMutableMap() + + private inner class FakeWindowsShell( + private val user: MutableMap, String> = mutableMapOf(), + private val machine: Map, String> = mapOf(), + private val handler: String? = windowsExe, + private val failingReads: Set = setOf(), + private val failingMachineReads: Set = setOf(), + private val failingWrites: Set = setOf(), + ) : WindowsShell { + val writes = mutableListOf() + var notified = false + + override fun readUser(key: String, name: String): String? { + if (key in failingReads) throw AccessDenied() + return user[key to name] + } + + override fun readMachine(key: String, name: String): String? { + if (key in failingMachineReads) throw AccessDenied() + return machine[key to name] + } + + override fun writeUser(value: RegistryValue) { + if (value.key in failingWrites) throw AccessDenied() + writes += value + user[value.key to value.name] = value.value + } + + override fun linkHandler(scheme: String): String? = handler + + override fun notifyAssociationsChanged() { + notified = true + } + } + + // Win32Exception's public constructors format the message through kernel32, which only Windows has. + private class AccessDenied : Win32Exception(WinError.ERROR_ACCESS_DENIED, WinNT.HRESULT(WinError.ERROR_ACCESS_DENIED), "access denied") + + @Test + fun execArgumentOfAPlainPathIsLeftBare() { + assertEquals("/home/user/Downloads/simplex-desktop-x86_64.AppImage", desktopExecArgument("/home/user/Downloads/simplex-desktop-x86_64.AppImage")) + } + + @Test + fun execArgumentIsQuotedForEveryReservedCharacter() { + for (c in " \t\n\"'\\><~|&;$*?#()`") { + val arg = desktopExecArgument("/a${c}b") + assertTrue(arg.startsWith("\"") && arg.endsWith("\""), "reserved character ${c.code} must be quoted, got $arg") + } + } + + @Test + fun execArgumentKeepsSpacesInsideTheQuotes() { + assertEquals("\"/home/user/My Apps/simplex.AppImage\"", desktopExecArgument("/home/user/My Apps/simplex.AppImage")) + } + + @Test + fun execArgumentEscapesReservedCharacters() { + assertEquals("\"/a\\\\\"b\"", desktopExecArgument("/a\"b"), "double quote") + assertEquals("\"/a\\\\`b\"", desktopExecArgument("/a`b"), "backtick") + assertEquals("\"/a\\\\\$b\"", desktopExecArgument("/a\$b"), "dollar") + } + + @Test + fun execArgumentTurnsABackslashIntoFour() { + assertEquals("\"/a\\\\\\\\b\"", desktopExecArgument("/a\\b")) + } + + @Test + fun appImageEntryHandlesTheSchemeAndStaysOutOfMenus() { + assertEquals( + """ + |[Desktop Entry] + |Type=Application + |Name=SimpleX Chat + |NoDisplay=true + |Exec="/home/user/My Apps/simplex.AppImage" %u + |MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex; + |""".trimMargin(), + appImageDesktopEntry("/home/user/My Apps/simplex.AppImage") + ) + } + + @Test + fun appImageEntryIsRefusedForAPathItCannotRun() { + assertNull(appImageDesktopEntry("/a\nExec=evil"), "line feed") + assertNull(appImageDesktopEntry("/a\rb"), "carriage return") + assertNull(appImageDesktopEntry("/a%1.AppImage"), "percent") + } + + private val linux = DesktopPlatform.LINUX_X86_64 + private val linuxAppPath = "/opt/simplex/bin/simplex" + + @Test + fun unpackagedRunHasNoInstallation() { + assertEquals(DesktopInstallation.Unpackaged, desktopInstallation(linux, null, mapOf()), "linux") + assertEquals(DesktopInstallation.Unpackaged, desktopInstallation(DesktopPlatform.MAC_AARCH64, null, mapOf()), "macOS") + assertEquals(DesktopInstallation.Unpackaged, desktopInstallation(DesktopPlatform.WINDOWS_X86_64, null, mapOf()), "windows") + } + + @Test + fun packagedMacAndWindowsAreRecognised() { + assertEquals(DesktopInstallation.MacBundle, desktopInstallation(DesktopPlatform.MAC_AARCH64, "/Applications/SimpleX.app/Contents/MacOS/SimpleX", mapOf())) + assertEquals(DesktopInstallation.WindowsExe(windowsExe), desktopInstallation(DesktopPlatform.WINDOWS_X86_64, windowsExe, mapOf())) + } + + @Test + fun flatpakWinsWhenTheAppImageCheckWouldAlsoMatch() { + val env = mapOf("container" to "flatpak", "APPIMAGE" to "/home/user/a.AppImage", "APPDIR" to "/tmp/.mount_a") + assertEquals(DesktopInstallation.Flatpak, desktopInstallation(linux, "/tmp/.mount_a/usr/bin/simplex", env)) + } + + @Test + fun appImageIsRecognisedWhenTheLauncherRunsFromItsMount() { + val env = mapOf("APPIMAGE" to appImagePath, "APPDIR" to "/tmp/.mount_Simple") + assertEquals( + DesktopInstallation.AppImage(appImagePath), + desktopInstallation(linux, "/tmp/.mount_Simple/usr/bin/simplex", env) + ) + } + + @Test + fun appImageIsRecognisedWhenItsMountIsReachedThroughASymlink() = withTempDir { tmp -> + val mount = Files.createDirectories(tmp.resolve("real/.mount_Simple/usr/bin")) + val linkedTmp = try { + Files.createSymbolicLink(tmp.resolve("linked"), tmp.resolve("real")) + } catch (e: FileSystemException) { + assumeNoException("symbolic links cannot be created here", e) + return@withTempDir + } + val env = mapOf("APPIMAGE" to appImagePath, "APPDIR" to linkedTmp.resolve(".mount_Simple").toString()) + assertEquals( + DesktopInstallation.AppImage(appImagePath), + desktopInstallation(linux, mount.toRealPath().resolve("simplex").toString(), env) + ) + } + + @Test + fun inheritedAppImageVariablesDoNotMakeTheDebAnAppImage() { + val inherited = mapOf("APPIMAGE" to "/home/user/Terminal.AppImage", "APPDIR" to "/tmp/.mount_Termin") + assertEquals(DesktopInstallation.LinuxPackage, desktopInstallation(linux, linuxAppPath, inherited), "another AppImage's mount") + assertEquals(DesktopInstallation.LinuxPackage, desktopInstallation(linux, linuxAppPath, mapOf("APPIMAGE" to "/home/user/a.AppImage")), "no APPDIR") + val prefix = mapOf("APPIMAGE" to "/home/user/a.AppImage", "APPDIR" to "/tmp/.mount_ab") + assertEquals(DesktopInstallation.LinuxPackage, desktopInstallation(linux, "/tmp/.mount_abc/usr/bin/simplex", prefix), "mount path that only shares a prefix") + } + + @Test + fun fileOnlyItsOwnerCanWriteIsAccepted() { + assertTrue(onlyOwnerCanWrite(attributes(owner = "alice", group = "staff", OWNER_WRITABLE), user = "alice")) + } + + @Test + fun rootOwnedFileIsAccepted() { + assertTrue(onlyOwnerCanWrite(attributes(owner = "root", group = "root", OWNER_WRITABLE), user = "alice")) + } + + @Test + fun fileOfAnotherOwnerIsRefused() { + assertFalse(onlyOwnerCanWrite(attributes(owner = "bob", group = "staff", OWNER_WRITABLE), user = "alice")) + } + + @Test + fun worldWritableFileIsRefused() { + assertFalse(onlyOwnerCanWrite(attributes(owner = "alice", group = "alice", OTHERS_WRITABLE), user = "alice")) + } + + @Test + fun groupWritableFileIsRefusedForASharedGroup() { + assertFalse(onlyOwnerCanWrite(attributes(owner = "alice", group = "staff", GROUP_WRITABLE), user = "alice")) + } + + @Test + fun groupWritableFileIsAcceptedForTheUsersOwnGroup() { + assertTrue(onlyOwnerCanWrite(attributes(owner = "alice", group = "alice", GROUP_WRITABLE), user = "alice"), "owned by the user") + assertTrue(onlyOwnerCanWrite(attributes(owner = "root", group = "alice", GROUP_WRITABLE), user = "alice"), "owned by root") + assertFalse(onlyOwnerCanWrite(attributes(owner = "root", group = "root", GROUP_WRITABLE), user = "alice"), "root's own group") + } + + private fun attributes(owner: String, group: String, permissions: String): PosixFileAttributes = + Proxy.newProxyInstance(javaClass.classLoader, arrayOf(PosixFileAttributes::class.java)) { _, method, _ -> + when (method.name) { + "owner" -> UserPrincipal { owner } + "group" -> GroupPrincipal { group } + "permissions" -> PosixFilePermissions.fromString(permissions) + else -> throw UnsupportedOperationException(method.name) + } + } as PosixFileAttributes + + @Test + fun appImageOnlyItsOwnerCanWriteIsAccepted() = withAppImage { + assertTrue(onlyOwnerCanReplace(it, Files.getOwner(it).name)) + } + + @Test + fun appImageInAWorldWritableDirectoryIsRefused() = withAppImage(directoryPermissions = WORLD_WRITABLE) { + assertFalse(onlyOwnerCanReplace(it, Files.getOwner(it).name), "the directory must be checked as well as the file") + } + + @Test + fun appImageUnderAWorldWritableAncestorIsRefused() = withAppImage(ancestorPermissions = WORLD_WRITABLE) { + assertFalse(onlyOwnerCanReplace(it, Files.getOwner(it).name), "every directory up to the root must be checked") + } + + @Test + fun worldWritableAppImageIsRefused() = withAppImage(filePermissions = OTHERS_WRITABLE) { + assertFalse(onlyOwnerCanReplace(it, Files.getOwner(it).name)) + } + + @Test + fun appImageOfAnotherOwnerIsRefused() = withAppImage { + val owner = Files.getOwner(it).name + assumeTrue("root is accepted as an owner", owner != "root") + assertFalse(onlyOwnerCanReplace(it, "$owner-other"), "a file owned by $owner checked for $owner-other") + } + + @Test + fun missingAppImageIsRefused() { + assumePosix() + assertFalse(onlyOwnerCanReplace(Path.of("/nonexistent-simplex-dir/SimpleX.AppImage"), "root")) + } + + // Built under the module's build directory, as the check walks up to the root and the system temp directory is open to everyone. + private fun withAppImage( + directoryPermissions: String = OWNER_WRITABLE, + filePermissions: String = OWNER_WRITABLE, + ancestorPermissions: String = OWNER_WRITABLE, + fileName: String = APPIMAGE_FILE_NAME, + check: (Path) -> Unit + ) { + assumePosix() + val base = Path.of("build").toAbsolutePath() + val user = System.getProperty("user.name") + assumeTrue( + "$base and every directory above it must be owned by $user or root and closed to others", + Files.isDirectory(base) && generateSequence(base) { it.parent }.all { + val attributes = Files.readAttributes(it, PosixFileAttributes::class.java) + attributes.owner().name in setOf(user, "root") && + PosixFilePermission.OTHERS_WRITE !in attributes.permissions() && + (PosixFilePermission.GROUP_WRITE !in attributes.permissions() || attributes.group().name == user) + } + ) + withTempDir(base) { tmp -> + val ancestor = Files.createDirectory(tmp.resolve("shared")) + val dir = Files.createDirectory(ancestor.resolve("apps")) + val appImage = Files.createFile(dir.resolve(fileName)) + Files.setPosixFilePermissions(appImage, PosixFilePermissions.fromString(filePermissions)) + Files.setPosixFilePermissions(dir, PosixFilePermissions.fromString(directoryPermissions)) + Files.setPosixFilePermissions(ancestor, PosixFilePermissions.fromString(ancestorPermissions)) + check(appImage) + } + } + + private fun assumePosix() = + assumeTrue("needs POSIX permissions", "posix" in FileSystems.getDefault().supportedFileAttributeViews()) + + @Test + fun runProcessReturnsTheOutputOfASuccessfulRun() { + assumeShell() + assertEquals("x\n", runProcess(listOf("sh", "-c", "echo x"))) + } + + @Test + fun runProcessKeepsErrorOutputOutOfTheResult() { + assumeShell() + // more than a pipe holds, so error output left in a pipe would block the process until the timeout + assertEquals("x\n", runProcess(listOf("sh", "-c", "head -c 100000 /dev/zero >&2; echo x"))) + } + + @Test + fun runProcessGivesTheProcessAnEndOfInput() { + assumeShell() + assertEquals("x\n", runProcess(listOf("sh", "-c", "cat >/dev/null; echo x")), "a process reading its input must not wait for the timeout") + } + + @Test + fun runProcessReturnsNothingForAFailedRun() { + assumeShell() + assertNull(runProcess(listOf("sh", "-c", "echo x; exit 3"))) + } + + private fun queryDefault(mimeType: String) = listOf(XDG_MIME, "query", "default", mimeType) + private fun setDefault(mimeType: String) = listOf(XDG_MIME, "default", APPIMAGE_ENTRY_NAME, mimeType) + private val queryBothDefaults = listOf(queryDefault(APP_LINK_MIME_TYPE), queryDefault(CONNECTION_LINK_MIME_TYPE)) + private val setBothDefaults = listOf( + queryDefault(APP_LINK_MIME_TYPE), setDefault(APP_LINK_MIME_TYPE), queryDefault(APP_LINK_MIME_TYPE), + queryDefault(CONNECTION_LINK_MIME_TYPE), setDefault(CONNECTION_LINK_MIME_TYPE), queryDefault(CONNECTION_LINK_MIME_TYPE), + ) + + @Test + fun appImageRegistrationWritesTheEntryAndMakesItTheDefault() = withRegistration { appImage, applicationsDir -> + val xdg = FakeXdgMime(default = null) + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run), "the entry became the default handler") + assertEquals(appImageDesktopEntry(appImage), File(applicationsDir, APPIMAGE_ENTRY_NAME).readText(), "the missing directory is created") + assertEquals(listOf(updateDatabase(applicationsDir)) + setBothDefaults, xdg.calls) + } + + @Test + fun appImageRegistrationLeavesAnUnchangedEntryThatIsAlreadyTheDefault() = withRegistration { appImage, applicationsDir -> + applicationsDir.mkdirs() + File(applicationsDir, APPIMAGE_ENTRY_NAME).writeText(appImageDesktopEntry(appImage)!!) + val xdg = FakeXdgMime(default = APPIMAGE_ENTRY_NAME) + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run)) + assertEquals(queryBothDefaults, xdg.calls, "nothing is rewritten or set again") + } + + @Test + fun appImageRegistrationTakesTheDefaultFromAHandlerNoLongerInstalled() = withRegistration { appImage, applicationsDir -> + applicationsDir.mkdirs() + File(applicationsDir, APPIMAGE_ENTRY_NAME).writeText(appImageDesktopEntry(appImage)!!) + val xdg = FakeXdgMime(default = "other.desktop") + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run), "the entry became the default handler again") + assertEquals(setBothDefaults, xdg.calls, "the entry is not rewritten, only made the default") + } + + @Test + fun appImageRegistrationSetsOnlyTheDefaultThatPointsElsewhere() = withRegistration { appImage, applicationsDir -> + applicationsDir.mkdirs() + File(applicationsDir, APPIMAGE_ENTRY_NAME).writeText(appImageDesktopEntry(appImage)!!) + val xdg = FakeXdgMime(default = APPIMAGE_ENTRY_NAME, connectionDefault = "other.desktop") + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run)) + assertEquals( + listOf(queryDefault(APP_LINK_MIME_TYPE), queryDefault(CONNECTION_LINK_MIME_TYPE), setDefault(CONNECTION_LINK_MIME_TYPE), queryDefault(CONNECTION_LINK_MIME_TYPE)), + xdg.calls + ) + } + + @Test + fun appImageRegistrationRewritesTheEntryOfAMovedAppImage() = withRegistration { appImage, applicationsDir -> + applicationsDir.mkdirs() + File(applicationsDir, APPIMAGE_ENTRY_NAME).writeText(appImageDesktopEntry("/old/SimpleX.AppImage")!!) + val xdg = FakeXdgMime(default = APPIMAGE_ENTRY_NAME) + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run)) + assertEquals(appImageDesktopEntry(appImage), File(applicationsDir, APPIMAGE_ENTRY_NAME).readText()) + assertEquals(listOf(updateDatabase(applicationsDir)) + queryBothDefaults, xdg.calls) + } + + @Test + fun appImageRegistrationFailsWhenAnotherHandlerKeepsTheAppLinkDefault() = withRegistration { appImage, applicationsDir -> + val xdg = FakeXdgMime(default = "other.desktop", keptMimeTypes = setOf(APP_LINK_MIME_TYPE)) + assertFalse(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run), "the default handler did not change") + assertEquals(listOf(updateDatabase(applicationsDir)) + setBothDefaults, xdg.calls, "the connection link default is still set") + } + + @Test + fun appImageRegistrationSucceedsWhenAnotherHandlerKeepsOnlyTheConnectionDefault() = withRegistration { appImage, applicationsDir -> + val xdg = FakeXdgMime(default = "other.desktop", keptMimeTypes = setOf(CONNECTION_LINK_MIME_TYPE)) + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run), "only simplexchat: decides the badge page") + assertEquals(listOf(updateDatabase(applicationsDir)) + setBothDefaults, xdg.calls) + } + + @Test + fun appImageRegistrationKeepsAnotherInstalledHandler() = withRegistration { appImage, applicationsDir -> + val systemDir = File(applicationsDir.parentFile, "system-applications").apply { mkdirs() } + File(systemDir, "other.desktop").writeText("[Desktop Entry]\n") + val xdg = FakeXdgMime(default = "other.desktop") + assertFalse(registerAppImageScheme(appImage, applicationsDir, listOf(systemDir), xdg::run), "links stay with the installed handler") + assertEquals(listOf(updateDatabase(applicationsDir)) + queryBothDefaults, xdg.calls, "the user's handler is not replaced") + } + + @Test + fun appImageRegistrationKeepsAnotherInstalledConnectionHandlerOnly() = withRegistration { appImage, applicationsDir -> + val systemDir = File(applicationsDir.parentFile, "system-applications").apply { mkdirs() } + File(systemDir, "other.desktop").writeText("[Desktop Entry]\n") + val xdg = FakeXdgMime(default = null, connectionDefault = "other.desktop") + assertTrue(registerAppImageScheme(appImage, applicationsDir, listOf(systemDir), xdg::run), "app links have no handler, so the entry takes them") + assertEquals( + listOf( + updateDatabase(applicationsDir), queryDefault(APP_LINK_MIME_TYPE), setDefault(APP_LINK_MIME_TYPE), queryDefault(APP_LINK_MIME_TYPE), + queryDefault(CONNECTION_LINK_MIME_TYPE), + ), + xdg.calls + ) + } + + @Test + fun appImageRegistrationIsRefusedForAPathTheEntryCannotRun() = + withRegistration(fileName = "Simple%X.AppImage") { appImage, applicationsDir -> + val xdg = FakeXdgMime(default = null) + assertFalse(registerAppImageScheme(appImage, applicationsDir, listOf(), xdg::run), "a path with % cannot be registered") + assertEquals(listOf(), xdg.calls, "nothing is run") + assertFalse(applicationsDir.exists(), "no entry is written") + } + + @Test + fun linuxPackageCountsAsRegisteredOnlyWhenItsEntryIsTheDefault() { + assertTrue(linuxPackageRegistered(FakeXdgMime(default = "simplex-simplex.desktop")::run), "the deb's own entry") + assertFalse(linuxPackageRegistered(FakeXdgMime(default = "other.desktop")::run), "another handler") + assertFalse(linuxPackageRegistered(FakeXdgMime(default = null)::run), "no handler") + assertFalse( + linuxPackageRegistered(FakeXdgMime(default = "other.desktop", connectionDefault = "simplex-simplex.desktop")::run), + "only the connection link handler" + ) + } + + private fun updateDatabase(applicationsDir: File) = listOf("update-desktop-database", applicationsDir.path) + + private class FakeXdgMime(default: String?, connectionDefault: String? = default, private val keptMimeTypes: Set = setOf()) { + private val defaults = mutableMapOf(APP_LINK_MIME_TYPE to default, CONNECTION_LINK_MIME_TYPE to connectionDefault) + val calls = mutableListOf>() + + fun run(command: List): String? { + calls += command + if (command.take(3) == listOf(XDG_MIME, "query", "default")) return defaults[command[3]]?.let { "$it\n" } + // xdg-mime sets the default only when given an entry and then a MIME type, the order it requires + if (command.size == 4 && command[1] == "default" && command[2].endsWith(".desktop") && command[3] !in keptMimeTypes) { + defaults[command[3]] = command[2] + } + return "" + } + } + + private fun withRegistration(fileName: String = APPIMAGE_FILE_NAME, test: (appImage: String, applicationsDir: File) -> Unit) = + withAppImage(fileName = fileName) { appImage -> + assumeTrue("the AppImage must be owned by user.name", Files.getOwner(appImage).name == System.getProperty("user.name")) + test(appImage.toString(), appImage.parent.parent.parent.resolve("share/applications").toFile()) + } + + private fun assumeShell() = + assumeTrue("needs sh", System.getenv("PATH")?.split(File.pathSeparator)?.any { Files.isExecutable(Path.of(it, "sh")) } == true) +} diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinksTest.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinksTest.kt new file mode 100644 index 0000000000..59c3c8c667 --- /dev/null +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/AppLinksTest.kt @@ -0,0 +1,71 @@ +package chat.simplex.app + +import chat.simplex.common.MAX_LINK_BYTES +import chat.simplex.common.linkFromArgs +import chat.simplex.common.isAcceptedLink +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertFalse +import kotlin.test.assertNull +import kotlin.test.assertTrue + +class AppLinksTest { + @Test + fun acceptsTheOnlyArgumentWhenItIsAnAppLink() { + assertEquals(BADGE_LINK, linkFromArgs(arrayOf(BADGE_LINK))) + } + + @Test + fun acceptsTheSchemeInAnyCase() { + val link = "SimplexChat:/badge/code/SB0000000000000000000" + assertEquals(link, linkFromArgs(arrayOf(link))) + } + + @Test + fun ignoresNoArguments() { + assertNull(linkFromArgs(arrayOf())) + } + + @Test + fun acceptsAConnectionLink() { + assertEquals(SHORT_CONNECTION_LINK, linkFromArgs(arrayOf(SHORT_CONNECTION_LINK)), "short link") + val oneTimeLink = oneTimeLinkWithKemKey() + assertEquals(oneTimeLink, linkFromArgs(arrayOf(oneTimeLink)), "one-time link of ${oneTimeLink.length} bytes with its post-quantum key") + val upperCase = "SimpleX:/a#lrdvu2d8A1GumSmoKb2krQmtKhWXq-tyGpHuM7aMwsw?h=smp6.simplex.im" + assertEquals(upperCase, linkFromArgs(arrayOf(upperCase)), "scheme in another case") + } + + @Test + fun ignoresWebAndOtherLinks() { + assertNull(linkFromArgs(arrayOf("https://simplex.chat/contact#/?v=2-7")), "web link") + assertNull(linkFromArgs(arrayOf("simplexfile:/x")), "another scheme sharing the prefix") + assertNull(linkFromArgs(arrayOf("/home/user/simplex:/a")), "path") + } + + @Test + fun ignoresALinkThatIsNotTheOnlyArgument() { + // a URL split by quotes in a handler command arrives as several arguments + assertNull(linkFromArgs(arrayOf("--flag", BADGE_LINK)), "flag before link") + assertNull(linkFromArgs(arrayOf(BADGE_LINK, "extra")), "argument after link") + } + + @Test + fun ignoresAnEmptyArgument() { + assertNull(linkFromArgs(arrayOf(""))) + } + + @Test + fun lengthBoundIsInclusive() { + val atLimit = badgeLinkOfBytes(MAX_LINK_BYTES) + val overLimit = atLimit + "A" + assertTrue(isAcceptedLink(atLimit), "link of exactly $MAX_LINK_BYTES bytes") + assertFalse(isAcceptedLink(overLimit), "link of ${overLimit.length} bytes") + assertNull(linkFromArgs(arrayOf(overLimit))) + } + + @Test + fun lengthBoundCountsUtf8Bytes() { + // The link has 4213 characters but 8413 bytes, so a bound counted in characters would accept it. + assertNull(linkFromArgs(arrayOf("simplexchat:/" + "é".repeat(4200)))) + } +} diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/SingleInstanceTest.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/SingleInstanceTest.kt index 1b495c1774..0bfa16b4d3 100644 --- a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/SingleInstanceTest.kt +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/SingleInstanceTest.kt @@ -1,14 +1,48 @@ package chat.simplex.app +import chat.simplex.common.FILE_TIME_TOLERANCE +import chat.simplex.common.MAX_LINK_BYTES +import chat.simplex.common.SHOW_FILE +import chat.simplex.common.SHOW_TMP_SUFFIX +import chat.simplex.common.ShowSignal +import chat.simplex.common.TAKEN_SHOW_FILE +import chat.simplex.common.deleteStaleSignalFiles +import chat.simplex.common.signalRunningInstance +import chat.simplex.common.startDespiteRunningInstance +import chat.simplex.common.takeSignal +import chat.simplex.common.watchShowSignals +import org.junit.Assume.assumeFalse +import org.junit.Assume.assumeTrue import java.nio.channels.FileChannel import java.nio.channels.OverlappingFileLockException +import java.nio.file.FileSystemException import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.StandardCopyOption import java.nio.file.StandardOpenOption.CREATE import java.nio.file.StandardOpenOption.READ import java.nio.file.StandardOpenOption.WRITE +import java.nio.file.StandardWatchEventKinds +import java.nio.file.attribute.FileTime +import java.nio.file.attribute.PosixFileAttributeView +import java.nio.file.attribute.PosixFilePermission +import java.time.Instant +import java.time.temporal.ChronoUnit +import java.util.concurrent.LinkedBlockingQueue +import java.util.concurrent.TimeUnit +import kotlin.concurrent.thread import kotlin.test.Test +import kotlin.test.assertEquals import kotlin.test.assertFailsWith +import kotlin.test.assertFalse import kotlin.test.assertNotNull +import kotlin.test.assertNull +import kotlin.test.assertTrue + +// generous for a loaded build machine; the watcher normally delivers within milliseconds +private const val SIGNAL_WAIT_SECONDS = 15L +// short, as the running instance in these tests never answers within the wait +private const val RUNNING_INSTANCE_WAIT_MILLIS = 300L class SingleInstanceTest { @Test @@ -43,14 +77,245 @@ class SingleInstanceTest { second.close() } - private fun withTempDir(block: (java.nio.file.Path) -> Unit) { - val tmp = Files.createTempDirectory("simplex-singleinstance-test") - try { - block(tmp) - } finally { - Files.walk(tmp).sorted(Comparator.reverseOrder()).forEach { - try { Files.delete(it) } catch (_: java.io.IOException) {} - } + @Test + fun secondProcessExitsWhenTheRunningInstanceTakesTheSignal() = withTempDir { dir -> + val taken = LinkedBlockingQueue() + val runningInstance = thread { + while (!Files.exists(dir.resolve(SHOW_FILE))) Thread.sleep(5) + takeSignal(dir)?.let(taken::add) + } + val start = startDespiteRunningInstance(dir, BADGE_LINK, TimeUnit.SECONDS.toMillis(SIGNAL_WAIT_SECONDS)) { + error("a responsive instance must not raise the alert") + } + runningInstance.join() + assertFalse(start, "the second process must exit") + assertEquals(BADGE_LINK, taken.poll()?.link, "the running instance opens the link") + } + + @Test + fun secondProcessExitsWhenTheUserDeclinesToStart() = withTempDir { dir -> + assertFalse(startDespiteRunningInstance(dir, BADGE_LINK, RUNNING_INSTANCE_WAIT_MILLIS) { false }) + assertEquals(BADGE_LINK, takeSignal(dir)?.link, "the signal stays for the running instance to take once it recovers") + } + + @Test + fun secondProcessStartsAndWithdrawsTheSignalWhenTheUserStartsAnyway() = withTempDir { dir -> + assertTrue(startDespiteRunningInstance(dir, BADGE_LINK, RUNNING_INSTANCE_WAIT_MILLIS) { true }) + assertEquals(listOf(), fileNames(dir), "the withdrawn signal must not open the link in the running instance too") + } + + @Test + fun secondProcessExitsWhenTheRunningInstanceRecoversDuringTheAlert() = withTempDir { dir -> + var opened: String? = null + val start = startDespiteRunningInstance(dir, BADGE_LINK, RUNNING_INSTANCE_WAIT_MILLIS) { + opened = takeSignal(dir)?.link + true + } + assertEquals(BADGE_LINK, opened, "the recovered instance opened the link") + assertFalse(start, "starting anyway would open the same link a second time") + } + + @Test + fun signalCarriesTheLinkAndIsTakenOnce() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + assertEquals(listOf(SHOW_FILE), fileNames(dir), "only the signal may exist after signalling") + assertEquals(BADGE_LINK, takeSignal(dir)?.link) + assertEquals(listOf(), fileNames(dir), "taking the signal must leave no file behind") + assertNull(takeSignal(dir), "a signal already taken must not be taken again") + } + + @Test + fun signalCarriesAOneTimeLinkWithItsPostQuantumKey() = withTempDir { dir -> + val link = oneTimeLinkWithKemKey() + signalRunningInstance(dir, link) + assertEquals(link, takeSignal(dir)?.link, "a connection link of ${link.length} bytes") + } + + @Test + fun signalWithoutLinkIsTakenWithNoLink() = withTempDir { dir -> + signalRunningInstance(dir, null) + val signal = takeSignal(dir) + assertNotNull(signal, "an empty signal must still be taken") + assertNull(signal.link, "an empty signal carries no link") + assertEquals(listOf(), fileNames(dir), "taking the signal must leave no file behind") + assertNull(takeSignal(dir), "a signal already taken must not be taken again") + } + + @Test + fun laterSignalReplacesAnUntakenOne() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + signalRunningInstance(dir, OTHER_BADGE_LINK) + assertEquals(listOf(SHOW_FILE), fileNames(dir), "the later signal must replace the earlier one") + assertEquals(OTHER_BADGE_LINK, takeSignal(dir)?.link) + } + + @Test + fun signalIsReadableOnlyByItsOwner() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + val view = Files.getFileAttributeView(dir.resolve(SHOW_FILE), PosixFileAttributeView::class.java) + assumeTrue("POSIX file permissions are not supported here", view != null) + assertEquals( + setOf(PosixFilePermission.OWNER_READ, PosixFilePermission.OWNER_WRITE), + view.readAttributes().permissions() + ) + } + + @Test + fun takeSignalReplacesATakenFileLeftByACrash() = withTempDir { dir -> + Files.writeString(dir.resolve(TAKEN_SHOW_FILE), OTHER_BADGE_LINK) + signalRunningInstance(dir, BADGE_LINK) + assertEquals(BADGE_LINK, takeSignal(dir)?.link, "the new signal, not the leftover, must be read") + assertEquals(listOf(), fileNames(dir), "taking the signal must leave no file behind") + } + + @Test + fun takeSignalRetriesAMoveThatFailsOnce() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + var attempts = 0 + val signal = takeSignal(dir) { from, to -> + attempts++ + if (attempts == 1) throw FileSystemException(from.toString(), null, "held open by another program") + Files.move(from, to, StandardCopyOption.ATOMIC_MOVE) + } + assertEquals(2, attempts, "one failed attempt and one retry") + assertEquals(BADGE_LINK, signal?.link, "the retry must still deliver the link") + assertEquals(listOf(), fileNames(dir), "taking the signal must leave no file behind") + } + + @Test + fun takeSignalLeavesTheSignalWhenTheRetryFailsToo() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + var attempts = 0 + val signal = takeSignal(dir) { from, _ -> + attempts++ + throw FileSystemException(from.toString(), null, "held open by another program") + } + assertEquals(2, attempts, "one failed attempt and one retry") + assertNotNull(signal, "the window still comes forward") + assertNull(signal.link, "a signal that cannot be read carries no link") + assertEquals(BADGE_LINK, takeSignal(dir)?.link, "the signal stays for the next attempt") + } + + @Test + fun takeSignalAcceptsALinkOfExactlyTheBound() = withTempDir { dir -> + val atBound = badgeLinkOfBytes(MAX_LINK_BYTES) + signalRunningInstance(dir, atBound) + assertEquals(atBound, takeSignal(dir)?.link, "a link of exactly $MAX_LINK_BYTES bytes") + } + + @Test + fun takeSignalDropsContentThatIsNotAnAcceptedLink() = withTempDir { dir -> + val show = dir.resolve(SHOW_FILE) + fun assertTakenWithoutLink(case: String) { + val signal = takeSignal(dir) + assertNotNull(signal, "$case: rejected content is still a signal, so the window comes forward") + assertNull(signal.link, case) + } + Files.writeString(show, "https://simplex.chat/contact#/?v=2-7") + assertTakenWithoutLink("web link") + assertEquals(listOf(), fileNames(dir), "a rejected signal must still be removed") + + Files.writeString(show, badgeLinkOfBytes(MAX_LINK_BYTES + 1)) + assertTakenWithoutLink("link over the length bound") + + // 4214 characters but 8414 bytes; a read cut at the bound would end on a whole character and decode to an accepted link + Files.writeString(show, "simplexchat:/x" + "é".repeat(4200)) + assertTakenWithoutLink("multi-byte link over the byte bound") + assertEquals(listOf(), fileNames(dir), "a rejected signal must still be removed") + } + + @Test + fun deleteStaleSignalFilesRemovesOldTempAndTakenFilesOnly() = withTempDir { dir -> + val lockAttemptTime = Instant.now().truncatedTo(ChronoUnit.SECONDS) + val old = FileTime.from(lockAttemptTime.minusSeconds(3600)) + Files.setLastModifiedTime(Files.createFile(dir.resolve("simplex.started")), old) + Files.setLastModifiedTime(Files.createFile(dir.resolve("simplex_v1_chat.db")), old) + Files.setLastModifiedTime(Files.createFile(dir.resolve("other.tmp")), old) + Files.setLastModifiedTime(Files.createFile(dir.resolve("${SHOW_FILE}123$SHOW_TMP_SUFFIX")), old) + Files.createFile(dir.resolve("${SHOW_FILE}456$SHOW_TMP_SUFFIX")) + Files.createFile(dir.resolve(TAKEN_SHOW_FILE)) + Files.createFile(dir.resolve(SHOW_FILE)) + deleteStaleSignalFiles(dir, FileTime.from(lockAttemptTime)) + assertEquals( + listOf("other.tmp", SHOW_FILE, "${SHOW_FILE}456$SHOW_TMP_SUFFIX", "simplex.started", "simplex_v1_chat.db"), + fileNames(dir), + "an old temp file and a taken file must go; a fresh temp file is a signal being written, and the lock and database stay" + ) + } + + @Test + fun deleteStaleSignalFilesKeepsASignalWithinTheToleranceAndDropsAnOlderOne() = withTempDir { dir -> + val lockAttemptTime = Instant.now().truncatedTo(ChronoUnit.SECONDS) + val show = dir.resolve(SHOW_FILE) + signalRunningInstance(dir, BADGE_LINK) + Files.setLastModifiedTime(show, FileTime.from(lockAttemptTime.minus(FILE_TIME_TOLERANCE))) + deleteStaleSignalFiles(dir, FileTime.from(lockAttemptTime)) + assertEquals(listOf(SHOW_FILE), fileNames(dir), "a signal exactly at the tolerance must be kept") + + Files.setLastModifiedTime(show, FileTime.from(lockAttemptTime.minusSeconds(1))) + deleteStaleSignalFiles(dir, FileTime.from(lockAttemptTime)) + assertEquals(listOf(SHOW_FILE), fileNames(dir), "a signal one second behind the lock attempt must be kept") + + Files.setLastModifiedTime(show, FileTime.from(lockAttemptTime.minus(FILE_TIME_TOLERANCE).minusSeconds(1))) + deleteStaleSignalFiles(dir, FileTime.from(lockAttemptTime)) + assertEquals(listOf(), fileNames(dir), "a signal older than the tolerance must be deleted") + } + + @Test + fun watcherTakesASignalWrittenBeforeItsWatch() = withTempDir { dir -> + signalRunningInstance(dir, BADGE_LINK) + watch(dir) { signals -> + assertEquals(BADGE_LINK, signals.poll(SIGNAL_WAIT_SECONDS, TimeUnit.SECONDS)?.link, "a signal written before the watch raised no event") } } + + @Test + fun watcherTakesEverySignalArrivingWhileItWatches() = withTempDir { dir -> + assumeWatchServiceReportsEachCreation(dir) + watch(dir) { signals -> + // Each signal is written after the previous one arrived, so later ones can come only from watch events. + signalRunningInstance(dir, BADGE_LINK) + assertEquals(BADGE_LINK, signals.poll(SIGNAL_WAIT_SECONDS, TimeUnit.SECONDS)?.link, "first signal") + signalRunningInstance(dir, OTHER_BADGE_LINK) + assertEquals(OTHER_BADGE_LINK, signals.poll(SIGNAL_WAIT_SECONDS, TimeUnit.SECONDS)?.link, "second signal, seen as a creation") + signalRunningInstance(dir, BADGE_LINK) + assertEquals(BADGE_LINK, signals.poll(SIGNAL_WAIT_SECONDS, TimeUnit.SECONDS)?.link, "third signal, after the watch key was reset") + } + } + + @Test + fun signalIsWrittenThroughATempFileBesideIt() = withTempDir { dir -> + // a temp file elsewhere may sit on another file system, where the atomic move fails and the link is dropped + assumeWatchServiceReportsEachCreation(dir) + val created = dir.fileSystem.newWatchService().use { ws -> + dir.register(ws, StandardWatchEventKinds.ENTRY_CREATE) + signalRunningInstance(dir, BADGE_LINK) + ws.poll(SIGNAL_WAIT_SECONDS, TimeUnit.SECONDS)?.pollEvents()?.map { it.context().toString() }.orEmpty() + } + assertTrue( + created.any { it != TAKEN_SHOW_FILE && it.startsWith(SHOW_FILE) && it.endsWith(SHOW_TMP_SUFFIX) }, + "a temp file must be created in the signal directory, created: $created" + ) + } + + // macOS polls the directory and keeps a taken name cached, so it misses short-lived files and reports a reused name as a modification + private fun assumeWatchServiceReportsEachCreation(dir: Path) = + assumeFalse("needs a watch service that reports each creation", dir.fileSystem.newWatchService().use { it.javaClass.simpleName == "PollingWatchService" }) + + private fun watch(dir: Path, test: (signals: LinkedBlockingQueue) -> Unit) { + val signals = LinkedBlockingQueue() + val watcherThread = dir.fileSystem.newWatchService().use { ws -> + dir.register(ws, StandardWatchEventKinds.ENTRY_CREATE) + thread(isDaemon = true) { watchShowSignals(ws, dir) { signals.put(it) } }.also { + test(signals) + // a second, duplicate delivery would arrive within this wait + assertNull(signals.poll(1, TimeUnit.SECONDS), "each signal is taken once") + } + } + watcherThread.join(TimeUnit.SECONDS.toMillis(SIGNAL_WAIT_SECONDS)) + assertFalse(watcherThread.isAlive, "closing the watch service ends the watcher") + } + + private fun fileNames(dir: Path): List = + Files.list(dir).use { files -> files.map { it.fileName.toString() }.sorted().toList() } } diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/TempDir.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/TempDir.kt new file mode 100644 index 0000000000..95b65da588 --- /dev/null +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/TempDir.kt @@ -0,0 +1,20 @@ +package chat.simplex.app + +import java.io.IOException +import java.nio.file.Files +import java.nio.file.Path + +private const val TEMP_DIR_PREFIX = "simplex-desktop-test" + +internal fun withTempDir(parent: Path? = null, block: (Path) -> Unit) { + val tmp = if (parent == null) Files.createTempDirectory(TEMP_DIR_PREFIX) else Files.createTempDirectory(parent, TEMP_DIR_PREFIX) + try { + block(tmp) + } finally { + Files.walk(tmp).use { paths -> + paths.sorted(Comparator.reverseOrder()).forEach { + try { Files.delete(it) } catch (_: IOException) {} + } + } + } +} diff --git a/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/WindowActivationTest.kt b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/WindowActivationTest.kt new file mode 100644 index 0000000000..76dd2b46fb --- /dev/null +++ b/apps/multiplatform/common/src/desktopTest/kotlin/chat/simplex/app/WindowActivationTest.kt @@ -0,0 +1,86 @@ +package chat.simplex.app + +import chat.simplex.common.activationEvent +import chat.simplex.common.sendActivation +import com.sun.jna.NativeLong +import com.sun.jna.platform.unix.X11 +import org.junit.Assume.assumeNoException +import java.lang.reflect.Proxy +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertFailsWith +import kotlin.test.assertNull +import kotlin.test.assertSame + +private const val WINDOW_ID = 42L +private const val ATOM_ID = 7L + +class WindowActivationTest { + @Test + fun activationEventAsksTheWindowManagerToActivateTheWindowAsAPager() { + assumeLibX11() + val atom = X11.Atom(ATOM_ID) + val event = activationEvent(X11.Window(WINDOW_ID), atom) + val message = event.xclient + assertEquals(WINDOW_ID, message.window.toLong(), "target window") + assertEquals(atom, message.message_type, "_NET_ACTIVE_WINDOW atom") + assertEquals(32, message.format, "data format in bits") + // JNA writes only the selected member of a union, so the bytes XSendEvent receives are checked too + event.write() + assertEquals(X11.ClientMessage, event.pointer.getInt(0), "event type in native memory") + assertEquals(2L, message.data.pointer.getNativeLong(0).toLong(), "source indication in native memory: a pager, which focus stealing prevention lets through") + assertEquals(0L, message.data.pointer.getNativeLong(NativeLong.SIZE.toLong()).toLong(), "timestamp in native memory: CurrentTime") + } + + @Test + fun activationIsSentToTheRootWindowAndTheDisplayIsClosed() { + assumeLibX11() + val x11 = FakeX11() + sendActivation(x11.proxy, WINDOW_ID) + assertEquals(listOf("XOpenDisplay", "XInternAtom", "XDefaultRootWindow", "XSendEvent", "XFlush", "XCloseDisplay"), x11.calls) + assertNull(x11.displayName, "the display named by DISPLAY") + assertEquals("_NET_ACTIVE_WINDOW", x11.atomName, "atom of the request") + val send = x11.sendArgs + assertSame(x11.display, send[0], "display") + assertEquals(x11.root, send[1], "the request goes to the root window, where the window manager listens") + assertEquals(NativeLong((X11.SubstructureRedirectMask or X11.SubstructureNotifyMask).toLong()), send[3], "event mask the window manager selects") + val event = (send[4] as X11.XEvent).xclient + assertEquals(WINDOW_ID, event.window.toLong(), "window to activate") + assertEquals(x11.atom, event.message_type, "the interned atom is the request type") + } + + @Test + fun displayIsClosedWhenSendingFails() { + assumeLibX11() + val x11 = FakeX11(sendFails = true) + assertFailsWith { sendActivation(x11.proxy, WINDOW_ID) } + assertEquals("XCloseDisplay", x11.calls.last(), "the display must be closed after a failure") + } + + private class FakeX11(private val sendFails: Boolean = false) { + val display = X11.Display() + val root = X11.Window(1) + val atom = X11.Atom(ATOM_ID) + val calls = mutableListOf() + var displayName: Any? = null + var atomName: Any? = null + var sendArgs: Array = emptyArray() + + val proxy = Proxy.newProxyInstance(X11::class.java.classLoader, arrayOf(X11::class.java)) { _, method, args -> + calls += method.name + when (method.name) { + "XOpenDisplay" -> { displayName = args[0]; display } + "XInternAtom" -> { atomName = args[1]; atom } + "XDefaultRootWindow" -> root + "XSendEvent" -> { sendArgs = args.copyOf(); if (sendFails) throw IllegalStateException("send failed"); 1 } + "XFlush", "XCloseDisplay" -> 0 + else -> throw UnsupportedOperationException(method.name) + } + } as X11 + } + + // JNA loads libX11 to lay out any X11 structure, and only X11 desktops have it + private fun assumeLibX11() { + try { X11.INSTANCE } catch (e: LinkageError) { assumeNoException("libX11 is not available", e) } + } +} diff --git a/apps/multiplatform/desktop/build.gradle.kts b/apps/multiplatform/desktop/build.gradle.kts index 7c7455c7f3..caaa1ba272 100644 --- a/apps/multiplatform/desktop/build.gradle.kts +++ b/apps/multiplatform/desktop/build.gradle.kts @@ -85,6 +85,18 @@ compose { extraKeysRawXml = """ NSMicrophoneUsageDescription SimpleX needs microphone access to record voice messages + CFBundleURLTypes + + + CFBundleURLName + $bundleID + CFBundleURLSchemes + + simplexchat + simplex + + + """ } val identity = rootProject.extra["desktop.mac.signing.identity"] as String? diff --git a/apps/multiplatform/desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt b/apps/multiplatform/desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt index e407448d1b..46640b3dbb 100644 --- a/apps/multiplatform/desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt +++ b/apps/multiplatform/desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt @@ -9,19 +9,27 @@ import androidx.compose.ui.ExperimentalComposeUiApi import androidx.compose.ui.Modifier import androidx.compose.ui.input.pointer.* import chat.simplex.common.acquireSingleInstance +import chat.simplex.common.installOpenUriHandler +import chat.simplex.common.linkFromArgs import chat.simplex.common.model.ChatController.appPrefs import chat.simplex.common.model.size import chat.simplex.common.platform.* import chat.simplex.common.platform.DesktopPlatform import chat.simplex.common.showApp +import chat.simplex.common.singleInstanceLock +import chat.simplex.common.startShowFileWatcher import chat.simplex.common.views.helpers.* import chat.simplex.common.views.onboarding.OnboardingStage import kotlinx.coroutines.* import java.io.File -fun main() { +fun main(args: Array) { try { - if (!acquireSingleInstance()) return + val link = linkFromArgs(args) + if (!acquireSingleInstance(link)) return + link?.let { chatModel.appOpenUrl.value = null to it } + // started after the launch link is stored, so a link it forwards later is not overwritten + if (singleInstanceLock) startShowFileWatcher() // Clean shared temp dirs only in the owning instance (not in a Files.desktop val // initializer, which a transient second instance would also run). Early: before settings writes. preferencesTmpDir.deleteRecursively() @@ -31,13 +39,14 @@ fun main() { runMigrations() setupUpdateChecker() initApp() + registerLinkSchemes() tmpDir.deleteRecursively() tmpDir.mkdir() // Only the owning instance cleans tmpDir on exit (see preferencesTmpDir above). tmpDir.deleteOnExit() - // showApp is inside the try: its first statements (SystemTray probe, Compose setup) are the - // process's first AWT init, which is itself a known startup failure cause (#4146). Crashes - // after the window appears are handled by the WindowExceptionHandler in showApp instead. + // installOpenUriHandler and showApp stay inside the try: whichever touches AWT first makes the process's + // first AWT init, a known startup failure cause (#4146); later crashes go to showApp's WindowExceptionHandler. + if (desktopPlatform.isMac()) installOpenUriHandler() return showApp() } catch (e: Throwable) { showStartupError(e) // the jpackage launcher otherwise hides the error behind "Failed to launch JVM" (#4146) diff --git a/apps/multiplatform/desktop/src/jvmMain/resources/distribute/SimpleX.desktop b/apps/multiplatform/desktop/src/jvmMain/resources/distribute/SimpleX.desktop index 79281a4dc8..68844ed5e6 100644 --- a/apps/multiplatform/desktop/src/jvmMain/resources/distribute/SimpleX.desktop +++ b/apps/multiplatform/desktop/src/jvmMain/resources/distribute/SimpleX.desktop @@ -2,6 +2,7 @@ Type=Application Name=SimpleX Chat Comment=Private and secure open-source messenger - no user IDs (not even random numbers) -Exec=/opt/simplex/bin/simplex +Exec=/opt/simplex/bin/simplex %u Icon=/opt/simplex/lib/simplex Categories=Network;Chat; +MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex; diff --git a/apps/multiplatform/product/concepts.md b/apps/multiplatform/product/concepts.md index d29ac5c2e5..bb44f5ab01 100644 --- a/apps/multiplatform/product/concepts.md +++ b/apps/multiplatform/product/concepts.md @@ -101,6 +101,7 @@ Key files that exist only on one platform, grouped by concern. | `desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt` | JVM entry point, Haskell/VLC init, PlatformInterface setup | | `common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt` | Compose Desktop window creation and lifecycle | | `common/src/desktopMain/kotlin/chat/simplex/common/StoreWindowState.kt` | Window position/size persistence | +| `common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt` | Deep link handling from launch arguments and macOS | | `common/src/desktopMain/kotlin/chat/simplex/common/views/helpers/AppUpdater.kt` | In-app update checker | | `common/src/desktopMain/kotlin/chat/simplex/common/platform/Videos.desktop.kt` | VLC-based video detection | | `common/src/desktopMain/kotlin/chat/simplex/common/platform/VideoPlayer.desktop.kt` | VLC video player implementation | diff --git a/apps/multiplatform/product/gaps.md b/apps/multiplatform/product/gaps.md index aae24bdca8..a17a2ed2cc 100644 --- a/apps/multiplatform/product/gaps.md +++ b/apps/multiplatform/product/gaps.md @@ -13,6 +13,7 @@ This document catalogs known gaps in the multiplatform codebase (Android and Des 5. [Documentation: Haskell Store Layer Not Fully Specified](#gap-05-documentation-haskell-store-layer-not-fully-specified) 6. [Desktop: Recording Not Implemented](#gap-06-desktop-recording-not-implemented) 7. [Desktop: Cryptor Not Implemented](#gap-07-desktop-cryptor-not-implemented) +8. [Desktop: App Link Registration](#gap-08-desktop-app-link-registration) --- @@ -289,3 +290,35 @@ This directly undermines RULE-02 (Database Encryption at Rest) and RULE-04 (Self - GAP-03 (Database Passphrase Not Enforced) is compounded by this gap on Desktop. - The `testCrypto()` function referenced in `AppCommon.desktop.kt:39` is commented out with a `// LALAL` marker, suggesting crypto testing was planned but never completed. + +--- + +## GAP-08: Desktop: App Link Registration + +**Severity:** Low +**Category:** Platform +**Platform:** Desktop only + +### Description + +Desktop registers the `simplexchat:` scheme so the badge page can return to the app, and the `simplex:` scheme so connection links open in it. The registration has known limits: + +- Uninstalling or deleting the app leaves the per-user registration behind: the HKCU keys on Windows (the scheme keys, the ProgIds, `Capabilities` and the `RegisteredApplications` entry) and the hidden AppImage desktop entry on Linux. A later link then points at a missing program. On Windows, if the app was installed into a folder other users can write to (for example a custom folder at the root of `C:\`), another user could put a program at that path and have it run on the next link; the default Program Files install is not affected. This risk is accepted. +- A Flatpak counts as registered without a check, as it cannot query the host's default handler. It works only once the Flathub release pins a commit with the desktop file's MimeType line and its wrapper passes `"$@"` to the app. +- On macOS a second copy of the app does not forward a link to the running one; macOS delivers the link to the running bundle itself. +- With two installations (a deb and an AppImage, or two installed copies of the Windows app), the scheme stays with whichever registered first while it is installed; the other gets `app=desktop`. On Windows, when several apps registered through `Capabilities` handle a scheme and none was picked, Windows chooses or asks; the app cannot set `UserChoice` itself. +- The link arrives as a command-line argument, which other local users can read through `/proc` on Linux. This risk is accepted. + +### Affected Locations + +- `common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt` -- registration and its result for the badge page +- `common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt` -- forwarding to a running instance + +### Impact + +A stale registration or an unregistered Flatpak sends the user back to a link that opens nothing; the badge page's *Show code* and the Redeem code screen remain. + +### Recommendation + +1. Remove the registration in an uninstaller where one exists (MSI), and on AppImage when the entry's file is gone. +2. Removing the command-line exposure needs the page to encrypt the code to a key the app passes in the URL fragment. diff --git a/apps/multiplatform/spec/README.md b/apps/multiplatform/spec/README.md index c6dbf1abf2..59f3fbe78a 100644 --- a/apps/multiplatform/spec/README.md +++ b/apps/multiplatform/spec/README.md @@ -107,7 +107,7 @@ Common Module (commonMain) | Concepts | [product/concepts.md](../product/concepts.md) | 30 product concepts (PC1-PC30) mapped to docs + source | | Glossary | [product/glossary.md](../product/glossary.md) | Domain term definitions (9 sections) | | Rules | [product/rules.md](../product/rules.md) | 18 business rules in 6 categories | -| Gaps | [product/gaps.md](../product/gaps.md) | 7 known gaps with recommendations | +| Gaps | [product/gaps.md](../product/gaps.md) | 8 known gaps with recommendations | | Flows | [product/flows/](../product/flows/) | onboarding, messaging, connection, calling, file-transfer, group-lifecycle | | Views | [product/views/](../product/views/) | chat-list, chat, settings, onboarding, call, new-chat, contact-info, group-info, user-profiles | @@ -119,7 +119,7 @@ Common Module (commonMain) |---|---|---|---| | Android Application | [`SimplexApp.kt`](../android/src/main/java/chat/simplex/app/SimplexApp.kt#L41) | `class SimplexApp` | 41 | | Android Activity | [`MainActivity.kt`](../android/src/main/java/chat/simplex/app/MainActivity.kt#L27) | `class MainActivity` | 27 | -| Desktop Entry | [`Main.kt`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L21) | `fun main()` | 21 | +| Desktop Entry | [`Main.kt`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L26) | `fun main(args: Array)` | 26 | | Desktop App Window | [`DesktopApp.kt`](../common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt#L33) | `fun showApp()` | 33 | | Desktop Init | [`AppCommon.desktop.kt`](../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppCommon.desktop.kt#L21) | `fun initApp()` | 21 | | Common App Screen | [`App.kt`](../common/src/commonMain/kotlin/chat/simplex/common/App.kt#L47) | `fun AppScreen()` | 47 | @@ -130,8 +130,8 @@ Common Module (commonMain) | Platform Interface | [`Platform.kt`](../common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt#L15) | `interface PlatformInterface` | 15 | | Notification Manager | [`NtfManager.kt`](../common/src/commonMain/kotlin/chat/simplex/common/platform/NtfManager.kt#L20) | `abstract class NtfManager` | 20 | | Theme Manager | [`ThemeManager.kt`](../common/src/commonMain/kotlin/chat/simplex/common/ui/theme/ThemeManager.kt#L18) | `object ThemeManager` | 18 | -| Android Haskell Init | [`AppCommon.android.kt`](../common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt#L33) | `fun initHaskell(packageName: String)` | 33 | -| Common Migrations | [`AppCommon.kt`](../common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt#L41) | `fun runMigrations()` | 41 | +| Android Haskell Init | [`AppCommon.android.kt`](../common/src/androidMain/kotlin/chat/simplex/common/platform/AppCommon.android.kt#L36) | `fun initHaskell(packageName: String)` | 36 | +| Common Migrations | [`AppCommon.kt`](../common/src/commonMain/kotlin/chat/simplex/common/platform/AppCommon.kt#L48) | `fun runMigrations()` | 48 | | Android Service | [`SimplexService.kt`](../android/src/main/java/chat/simplex/app/SimplexService.kt#L41) | `class SimplexService` | 41 | | Gradle Root | [`settings.gradle.kts`](../settings.gradle.kts#L22) | `include(":android", ":desktop", ":common")` | 22 | | Common Build | [`build.gradle.kts`](../common/build.gradle.kts#L14) | `kotlin { androidTarget(); jvm("desktop") }` | 14 | diff --git a/apps/multiplatform/spec/architecture.md b/apps/multiplatform/spec/architecture.md index 9911a2670f..cdc43a794a 100644 --- a/apps/multiplatform/spec/architecture.md +++ b/apps/multiplatform/spec/architecture.md @@ -222,21 +222,29 @@ Lifecycle callbacks in `SimplexApp` (implements `LifecycleEventObserver`): ### Desktop -Entry: [`main()`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L21) +Entry: [`main()`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L26) ``` -main() +main(args) + +-- linkFromArgs(args) // A simplexchat: or simplex: link passed by the OS + +-- acquireSingleInstance(link) // Or forward the link to the running instance and exit + +-- appOpenUrl = link // Stored before the watcher can forward a newer link + +-- startShowFileWatcher() // Only while holding the single-instance lock +-- initHaskell() // Load native lib from resources dir, call initHS() | +-- System.load(libapp-lib.so/dll/dylib) | +-- initHS() +-- runMigrations() +-- setupUpdateChecker() +-- initApp() // Set ntfManager, applyAppLocale, initChatControllerOnStart + +-- registerLinkSchemes() // Background thread, per-OS registration and detection + +-- installOpenUriHandler() // macOS only: links arrive as Apple Events +-- showApp() // Compose window with AppScreen() ``` [`showApp()`](../common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt#L33) creates a Compose `Window` with error recovery -- if a crash occurs, it closes the offending modal/view and re-opens the window. +[`showWindow()`](../common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt#L258) un-minimizes and raises the window when a second launch or a link reaches the running app. On Linux it also sends `_NET_ACTIVE_WINDOW` through [`requestX11Activation()`](../common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt#L17), because wlroots compositors such as Sway ignore the raise that AWT's `toFront()` sends under XWayland. On Windows the second process, which the browser left holding the foreground right, calls `AllowSetForegroundWindow` before it signals so that the running instance may raise its window. During a crash restart `showWindow()` skips the disposed window, so it does not come back; the new window opens visible. + [`initApp()`](../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppCommon.desktop.kt#L21) sets the `ntfManager` implementation (desktop notifications via `NtfManager` in `common/model/`) and calls `initChatControllerOnStart()`. --- @@ -341,8 +349,8 @@ Examples from platform files: [`PlatformInterface`](../common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt#L15) is an interface with default no-op implementations. It is assigned at runtime by each platform entry point: -- **Android**: assigned in [`SimplexApp.initMultiplatform()`](../android/src/main/java/chat/simplex/app/SimplexApp.kt#L187) (line 187) -- **Desktop**: assigned in [`Main.kt initHaskell()`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L50) (line 50) +- **Android**: assigned in [`SimplexApp.initMultiplatform()`](../android/src/main/java/chat/simplex/app/SimplexApp.kt#L193) +- **Desktop**: assigned in [`Main.kt initHaskell()`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L59) The global variable is declared at [`Platform.kt line 50`](../common/src/commonMain/kotlin/chat/simplex/common/platform/Platform.kt#L50): ```kotlin @@ -417,6 +425,8 @@ var platform: PlatformInterface = object : PlatformInterface {} | SimplexService.kt | [`android/src/main/java/chat/simplex/app/SimplexService.kt`](../android/src/main/java/chat/simplex/app/SimplexService.kt) | Android foreground service | | Main.kt | [`desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt`](../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt) | Desktop `main()` | | DesktopApp.kt | [`common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt`](../common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt) | `showApp()`, `SimplexWindowState` | +| SingleInstance.kt | [`common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt`](../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt) | `acquireSingleInstance()`, `startShowFileWatcher()`, signal file hand-over | +| WindowActivation.kt | [`common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt`](../common/src/desktopMain/kotlin/chat/simplex/common/WindowActivation.kt) | `requestX11Activation()`, `sendActivation()`, `activationEvent()` | ### Theme diff --git a/apps/multiplatform/spec/client/navigation.md b/apps/multiplatform/spec/client/navigation.md index 9cad3d3901..d6d5670c2f 100644 --- a/apps/multiplatform/spec/client/navigation.md +++ b/apps/multiplatform/spec/client/navigation.md @@ -109,9 +109,11 @@ When onboarding is complete: ### URL Deep Link -On Android, [`processIntent()`](../../android/src/main/java/chat/simplex/app/MainActivity.kt#L144) puts the URI of a VIEW intent into `chatModel.appOpenUrl`. Once onboarding is complete, a `LaunchedEffect` in `MainScreen` ([`App.kt`](../../common/src/commonMain/kotlin/chat/simplex/common/App.kt#L241)) hands it to [`connectIfOpenedViaUri()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L775), which re-queues it while no profile is active. Desktop registers no URL scheme. +On Android, [`processIntent()`](../../android/src/main/java/chat/simplex/app/MainActivity.kt#L144) puts the URI of a VIEW intent into `chatModel.appOpenUrl`. Once onboarding is complete, a `LaunchedEffect` in `MainScreen` ([`App.kt`](../../common/src/commonMain/kotlin/chat/simplex/common/App.kt#L241)) hands it to [`connectIfOpenedViaUri()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L775), which re-queues it while no profile is active. -App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectIfOpenedViaUri()` branches on that scheme before the connection dispatch, so an app link never reaches `planAndConnect()`. [`isAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L796) tests the raw prefix, since text that does not parse as a URI is still an app link, and [`openAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L800) dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to [`openBadgeLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L268), which shows `BadgesRedeemLinkView` as a `ModalManager.end` modal with `ModalViewId.BADGE_LINK`. Once the code parses, every modal is closed first, so the screen opens over the chat list, as iOS dismisses every sheet before a link; a code that does not parse gets an alert and closes nothing. The screen names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the screen composes), which core would refuse, the screen does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or back closes the screen without cancelling anything; if the redemption then succeeds with the screen closed or covered, an alert says the badge was added. Its step is held by the modal rather than remembered by the composition, so rotation and being covered do not reset it. While the screen shows a redemption in flight ([`isBadgeLinkIssuing()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L265)), a further app link is ignored. Any other path is a link type from a later version, and gets an alert asking to check for app updates; text that does not parse is dropped. An app link can carry a secret, and nothing on this path logs the URI: `processIntent()` logs nothing, and `connectIfOpenedViaUri()` logs a fixed string. +On desktop the same state is set from three places, for `simplexchat:` app links and `simplex:` connection links alike. [`isAcceptedLink()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L12) accepts either scheme within 8192 bytes in UTF-8, which leaves room for a one-time link with its post-quantum key (about 2 KB) and for a second such key. A link that starts the app arrives as the only argument of [`main()`](../../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L26) on Windows and Linux ([`linkFromArgs()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L15)). A link for an app that is already running starts a second process, which writes it into the single-instance signal file ([`signalRunningInstance()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L138)); the running instance renames the file before reading and deleting it ([`takeSignal()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L159)), retrying once if another program holds the file open, handles a signal already present when its watcher ([`watchShowSignals()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L247)) starts unless it predates the lock attempt by more than 2 s ([`deleteStaleSignalFiles()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L116)), and passes the link to [`openDesktopLink()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L19), which queues it for the active host and shows the window. If the running instance does not take the signal within 1 s, the second process asks whether to start anyway ([`startDespiteRunningInstance()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L93)); on *Yes* it withdraws the signal first and exits instead if the running instance has recovered and taken it, so the link opens once. On macOS the link is an Apple Event handled by [`installOpenUriHandler()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L25). From there `connectIfOpenedViaUri()` handles the link as on Android: a connection link goes to `planAndConnect()`, which asks before connecting. Both schemes are declared by the macOS Info.plist, the deb, AppImage and Flatpak desktop entries, and at runtime by [`registerLinkSchemes()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L67) (HKCU on Windows, a hidden desktop entry for an AppImage). Only `simplexchat:` is checked: [`appLinkSchemeRegistered()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L65) decides the badge page's ending through [`badgePageUrl()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt#L53): `app=true` when a link is expected to reach this installation, otherwise `app=desktop` with the Redeem code screen opened beside the browser. [`desktopInstallation()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L74) tells the installation kind apart. A packaged macOS app and a Flatpak count as registered without a check, since a Flatpak cannot query the host's default handler ([GAP](../../product/gaps.md#gap-08-desktop-app-link-registration)); Windows, where each scheme key is paired with a `SimpleX.` ProgId named in `Capabilities` and listed in `RegisteredApplications`, so the app appears in Windows default-app settings for each scheme that no other program holds, when the shell (`AssocQueryStringW`) reports this exe as the program that opens `simplexchat:` links, which accounts for any app picked in settings ([`registerWindowsSchemes()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L168)); an AppImage ([`registerAppImageScheme()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L299)) or deb when its own desktop entry is the default `simplexchat:` handler. Registration takes a scheme only when no handler is set or the current one is no longer installed: another installed program, such as a deb beside an AppImage or on Windows a per-user or machine-wide handler, keeps it, while this app still repairs its own ProgId unless another installed copy holds it, and the page then ends with `app=desktop`. An AppImage is not registered ([`onlyOwnerCanReplace()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L284)) when its file or any directory above it belongs to a user other than this user or root, or has permission bits that let others write it (POSIX ACLs are not inspected), or when its path contains a line break or `%`. An unpackaged run registers nothing. + +App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectIfOpenedViaUri()` branches on that scheme before the connection dispatch, so an app link never reaches `planAndConnect()`. [`isAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L797) tests the raw prefix, since text that does not parse as a URI is still an app link, and [`openAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L804) dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to [`openBadgeLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L268), which shows `BadgesRedeemLinkView` as a `ModalManager.start` modal with `ModalViewId.BADGE_LINK`. Once the code parses, every modal is closed first, so the screen opens over the chat list, as iOS dismisses every sheet before a link; a code that does not parse gets an alert and closes nothing. The screen names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the screen composes), which core would refuse, the screen does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or back closes the screen without cancelling anything; if the redemption then succeeds with the screen closed or covered, an alert says the badge was added. Its step is held by the modal rather than remembered by the composition, so rotation and being covered do not reset it. While the screen shows a redemption in flight ([`isBadgeLinkIssuing()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L265)), a further app link is ignored. Any other path is a link type from a later version, and gets an alert asking to check for app updates; text that does not parse is dropped. An app link can carry a secret, and nothing on this path logs the URI: `processIntent()` logs nothing, and `connectIfOpenedViaUri()` logs a fixed string. ### Overlay Layers (bottom of MainScreen) @@ -382,3 +384,5 @@ The stage value is stored in `appPrefs.onboardingStage` and persisted across app | `views/SplashView.kt` | Splash / loading screen | | `views/call/CallView.kt` | In-call fullscreen view (ActiveCallView) | | `views/localauth/PasswordEntry.kt` | Column divider utility (contains VerticalDivider) | +| `AppLinks.kt` (desktopMain) | Desktop app links from launch arguments and macOS Apple Events | +| `platform/AppLinkScheme.desktop.kt` (desktopMain) | Runtime `simplexchat:` registration and its result for the badge page | diff --git a/apps/multiplatform/spec/impact.md b/apps/multiplatform/spec/impact.md index ec302e30b5..1400dc25ae 100644 --- a/apps/multiplatform/spec/impact.md +++ b/apps/multiplatform/spec/impact.md @@ -415,6 +415,10 @@ Path prefix: `common/src/desktopMain/kotlin/chat/simplex/common/` |-------------|--------------------------|------------|-------| | `DesktopApp.kt` | PC1, PC2, PC3 | High | Desktop Compose window — window lifecycle, crash recovery | | `StoreWindowState.kt` | — | Low | Window position/size persistence | +| `AppLinks.kt` | — | Medium | `simplexchat:` and `simplex:` links from launch arguments and macOS Apple Events | +| `SingleInstance.kt` | — | Medium | Single-instance lock; forwards a second launch and its link to the running app | +| `WindowActivation.kt` | — | Low | `_NET_ACTIVE_WINDOW` request that raises the window on X11 and XWayland | +| `platform/AppLinkScheme.desktop.kt` | — | Medium | Runtime `simplexchat:` and `simplex:` scheme registration (Windows HKCU, AppImage desktop entry) | | `model/NtfManager.desktop.kt` | PC18 | Medium | Desktop system tray notification display | | `platform/AppCommon.desktop.kt` | PC1 through PC31 | Medium | Desktop app initialization actual declarations | | `platform/SimplexService.desktop.kt` | PC18 | Low | Desktop background receiver (no foreground service) | diff --git a/plans/2026-09-24-badge-buy-in-browser.md b/plans/2026-09-24-badge-buy-in-browser.md index 826d8766a5..ec79f0564e 100644 --- a/plans/2026-09-24-badge-buy-in-browser.md +++ b/plans/2026-09-24-badge-buy-in-browser.md @@ -22,7 +22,7 @@ Everything in the app sections below is both platforms unless it says otherwise. 4. **`purchaseBadge` with store receipts**, which depends on none of the above and can run alongside it. 5. **The app's store lane**, last, because nothing in it completes without 4. -(*) **Desktop deep links** sit outside this order entirely — any time or never, blocking nothing. Own section below. +(*) **Desktop deep links** sat outside this order entirely. ## The page @@ -66,15 +66,17 @@ Two invariants that are easy to miss. A store transaction must not be finished u ## Desktop (D1, D2) -No deep link. *Buy in browser* opens the page with `app=desktop` and the Redeem code screen at the same time, so the code has somewhere to go the moment it appears. This is also the fallback for any platform where the scheme turns out not to work: nothing else in the app depends on the link existing. +Where the scheme is not registered, there is no deep link: *Buy in browser* opens the page with `app=desktop` and the Redeem code screen at the same time, so the code has somewhere to go the moment it appears. This is also the fallback for any platform where the scheme turns out not to work: nothing else in the app depends on the link existing. ## Desktop deep links (*) -Optional, off the critical path, and blocking nothing — D1 works without it. Worth investigating on its own; if it lands, desktop joins lane A and D1 becomes the fallback rather than the design. +This was optional and off the critical path, and it blocked nothing, since D1 works without it. -Nothing registers a scheme on desktop today. `appOpenUrl` is wired in commonMain with no desktop implementation behind it, and `desktop/build.gradle.kts` declares Deb, Dmg, Msi and Exe with no protocol entry. Registration is per-OS, three separate small jobs: `CFBundleURLTypes` in the bundle plist plus `Desktop.setOpenURIHandler` on macOS, registry keys under `HKCU\Software\Classes` that the installer would have to write on Windows, and a `.desktop` entry with `MimeType=x-scheme-handler/simplexchat` on Linux. None of them covers an unpackaged run, so the fallback stays either way. +The plan is `plans/2026-09-28-desktop-deep-links.md`. The feature is implemented, and verification on real machines is pending. Desktop joins lane A wherever the scheme is registered, and D1 is the fallback rather than the design. -Getting the URL to an app that is already running is the part that half exists. `SingleInstance.kt` takes a file lock and uses a watched file to bring the running instance forward on a second launch; carrying a URL means giving that channel a payload rather than inventing IPC for it. +Before that work, nothing registered a scheme on desktop. `appOpenUrl` was wired in commonMain with no desktop implementation behind it, and `desktop/build.gradle.kts` declared Deb, Dmg, Msi and Exe with no protocol entry. Registration is per-OS, three separate small jobs: `CFBundleURLTypes` in the bundle plist plus `Desktop.setOpenURIHandler` on macOS, registry keys under `HKCU\Software\Classes` on Windows (the app now writes them at runtime), and a `.desktop` entry with `MimeType=x-scheme-handler/simplexchat` on Linux. None of them covers an unpackaged run, so the fallback stays either way. + +Getting the URL to an app that is already running was the part that half existed. `SingleInstance.kt` took a file lock and used a watched file to bring the running instance forward on a second launch; the implementation gives that channel a payload rather than inventing IPC for it. ## The service diff --git a/plans/2026-09-28-desktop-deep-links-report.md b/plans/2026-09-28-desktop-deep-links-report.md new file mode 100644 index 0000000000..08561f6808 --- /dev/null +++ b/plans/2026-09-28-desktop-deep-links-report.md @@ -0,0 +1,150 @@ +# Desktop deep links: report + +Packaged desktop builds on macOS, Windows and Linux receive `simplexchat:` links from the badge page, and `simplex:` connection links, with the app closed, running or hidden in the tray. Unit tests and builds pass; no packaged build has been run on real machines yet, so the manual checklist below is open. + +The plan is `plans/2026-09-28-desktop-deep-links.md`. + +## Flow + +``` +page: Return to SimpleX → simplexchat:/badge/code/ + macOS Apple Event → installOpenUriHandler → openDesktopLink + Windows, Linux new process main(args) → linkFromArgs + lock acquired → chatModel.appOpenUrl (cold start), then the watcher starts + lock taken → simplex.show with the link → running app → openDesktopLink +openDesktopLink: chatModel.appOpenUrl = remoteHostId() to link, then showWindow() +App.kt LaunchedEffect → connectIfOpenedViaUri → openAppLink → BadgesRedeemLinkView (asks before redeeming) +``` + +## Registration + +| Build | Registered by | What is written | Registered when | +|---|---|---|---| +| macOS `.dmg` | Info.plist, at build | `CFBundleURLTypes` with schemes `simplexchat` and `simplex` in `desktop/build.gradle.kts` | copied to /Applications; LaunchServices picks it up | +| Windows `.msi`, `.exe` | the app, each start | `HKCU\Software\Classes\simplexchat` and `\simplex`: `URL Protocol`, `DefaultIcon`, `shell\open\command = "" "%1"`; ProgIds `SimpleX.simplexchat` and `SimpleX.simplex` with the same command; `HKCU\Software\chat.simplex.app\Capabilities` with `URLAssociations`, listed in `HKCU\Software\RegisteredApplications` | first launch per user; rewritten when a value is missing or the command's program is gone, not while another installed program, per-user or machine-wide, holds it; registered when Windows (`AssocQueryStringW`) names this exe as the program for `simplexchat:` | +| Linux `.deb` | `make-deb-linux.sh`, at build | jpackage's `simplex-simplex.desktop` gets `Exec=... %u` and `MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex;` | install; postinst `xdg-desktop-menu install` refreshes the MIME cache | +| AppImage | the app, each start; also the bundled entry | hidden `$XDG_DATA_HOME/applications/chat.simplex.app-links.desktop` with `Exec= %u`, the path quoted only when the desktop-entry spec requires it, then `xdg-mime default` for each scheme; the bundled `chat.simplex.app.desktop` declares the MimeType for AppImage integration tools | first launch; rewritten if the AppImage moved; the default is set only when none is set or the current handler's entry is no longer installed | +| Flatpak | `scripts/flatpak/chat.simplex.simplex.desktop` | `MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex;` (Exec already has `%U`) | install of a Flathub release whose pinned commit includes this file | + +The registration code is in `common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt`. It runs once on a background thread after `initApp()`. The installation kind comes from `desktopInstallation(platform, appPath, env)`. An unpackaged run (no `jpackage.app-path`) registers nothing, and `APPIMAGE` counts only when the launcher runs from `APPDIR`, resolved through symlinks, because the AppImage runtime exports it to every child process. The AppImage entry is rewritten, followed by `update-desktop-database`, only when its content changed. An AppImage is not registered when its file or any directory above it belongs to a user other than this user or root, or has permission bits that let others write it, since the entry would run that file for every link; POSIX ACLs are not inspected. A path with a line break or `%` is not registered either, since GLib looks the program up before it expands `%%`. The path in `Exec` is quoted only when the desktop-entry spec requires it, because `xdg-open` 1.1.3 (Debian 12, Ubuntu 24.04) cannot run a quoted program in its generic mode, which Sway and other desktops it does not recognise use. + +## Receiving the link + +- **Closed, Windows and Linux:** the link is the only argument of `main`. `linkFromArgs` accepts it only when it is the single argument, starts with `simplexchat:` or `simplex:` and is at most 8192 bytes in UTF-8, enough for a one-time link with its post-quantum key (about 2 KB) and for a second such key. +- **Running, Windows and Linux:** the second process writes the link to an owner-only temp file in `dataDir` and renames it to `simplex.show`; if that fails, it writes an empty signal, which still raises the running app. The running app renames it to a private name, accepts at most 8192 bytes, deletes it, opens the link and shows its window. A signal present when the watcher starts is handled too, unless it predates the lock attempt by more than a 2 s tolerance for file time granularity; such a signal is left by an earlier session and is deleted instead, as are old temp files and a taken file left by a crash. On Windows the second process first calls `AllowSetForegroundWindow` so the window can come to the front, and logs a refusal. +- **Hung running app:** the existing "not responding" alert stays. "Start anyway" withdraws the signal and the new process opens the link itself; if the running app recovered and took the signal while the alert was up, the new process exits instead, so the link opens once. If renaming the signal fails, for example while another program holds it open, the running app retries once after 100 ms. +- **macOS:** the link arrives as an Apple Event, closed or running. `installOpenUriHandler` sets the handler on macOS only; the JDK holds an event that arrives during startup until then. +- **Bringing the window forward on Linux:** AWT's `toFront()` sends only `XRaiseWindow`, which Sway drops and focus stealing prevention refuses. `showWindow` makes the window visible at once and also sends `_NET_ACTIVE_WINDOW` (pager source) through JNA, after syncing AWT's connection so the map request comes first. On Sway the result follows `focus_on_window_activation`: the default `urgent` marks the window urgent, `smart` or `focus` focuses it. This was verified on headless Sway 1.9 with XWayland. + +## Badge page ending + +`appLinkSchemeRegistered()` decides the page flag when *Buy in browser* is tapped: + +| Result | Page URL | App side | +|---|---|---| +| registered | `#/tier?app=true` | page ends with *Return to SimpleX* and *Show code* | +| not registered | `#/tier?app=desktop` | Redeem code screen opens beside the browser (fallback) | + +Only `simplexchat:` counts here; `simplex:` is registered alongside it without being checked. By build, macOS is registered when packaged; Windows when the shell (`AssocQueryStringW`) names this exe as the program for `simplexchat:`; Flatpak always; AppImage and deb when `xdg-mime` reports their own entry as default. Android always reports registered. The button reads the flag once, so the URL and the fallback screen agree. + +## Security + +- The link is a bearer token. No log line on this path includes it. +- Any web page or program can send a link. The redeem screen from #7592 asks before redeeming and names the profile. +- The code arrives as a command-line argument. On Linux any local user can read it through `/proc//cmdline` unless `/proc` is mounted with `hidepid`; on a cold start the argument belongs to the app itself and stays readable until it exits, otherwise to the second process for about a second. On Windows only the same user and administrators can read it. This is an accepted risk; removing it needs the page to encrypt the code to a key the app passes in the URL fragment. +- The signal file holding the link is owner-only on POSIX and deleted as soon as it is read. It stays on disk only if the running app is hung. A later start that takes the lock deletes it without opening the link once it is more than 2 s older than the lock attempt; while the hung app still holds the lock, a later launch replaces the file and shows the alert again. +- Another program can claim the same scheme (on Windows, an app registered through `Capabilities` or picked in default-app settings wins; on Linux, the last `xdg-mime default` wins). That risk is accepted, and *Show code* on the page remains. + +## Automated verification (done) + +- `./gradlew :common:desktopTest`: all tests pass; this work adds `AppLinksTest`, `AppLinkSchemeTest`, `BadgePageUrlTest`, `WindowActivationTest` and nineteen `SingleInstanceTest` cases. + - `AppLinksTest`: accepts `simplexchat:` and `simplex:` in any case, including a one-time link with its post-quantum key; rejects `https:`, another scheme sharing the prefix, a path, empty, a link that is not the only argument, and a link over 8192 bytes, including a multi-byte one shorter than that in characters. + - `SingleInstanceTest`: link and empty signals round trip and are taken once; a later signal replaces an untaken one, and a taken file left by a crash is replaced; the file is owner-only (on POSIX); a link of exactly 8192 bytes and a one-time link with its post-quantum key are accepted; non-link content, an oversized link and a multi-byte link over the byte bound are dropped and still removed; the temp file is created beside the signal (skipped where the watch service polls, as on macOS); the startup sweep removes old temp files and a taken file but keeps a fresh temp file and the old lock and database files, and keeps a signal within the 2 s tolerance but drops an older one; the watcher takes a signal written before its watch, and successive signals arriving while it watches (skipped where the watch service polls, as on macOS), through a real `WatchService`, each once. + - `AppLinkSchemeTest`: Windows command quoting, the registry values, the deb counting as registered only when its own entry is the default, the ProgIds and the application listing, and registration with a stand-in shell (writing every value when the commands point at a missing program, leaving a full registration alone without notifying Windows, repairing a missing value or a missing application listing and notifying, keeping another installed program's or another copy's handler per-user or machine-wide, repairing this app's ProgId while another program holds the scheme, updating a command for this exe with other arguments, leaving a scheme alone when its handler cannot be read or its ProgId cannot be written, and reporting registered only when the shell names this exe, in any letter case); desktop-entry quoting that leaves a plain path bare, quotes every reserved character, keeps spaces inside the quotes and escapes `"`, `` ` ``, `$` and `\`; the full AppImage entry and its refusal of line breaks and `%`; `desktopInstallation` precedence, including Flatpak over a matching AppImage, inherited AppImage variables, a mount path that only shares a prefix, and a mount reached through a symlink; the AppImage ownership check for world-writable and group-writable files and directories, a world-writable ancestor, another owner, a root-owned file, and a missing file; AppImage registration writing the entry into a missing directory and setting both defaults, leaving unchanged defaults alone, setting the defaults again for an unchanged entry, setting only the default that points elsewhere, rewriting the entry of a moved AppImage, failing when another handler keeps the `simplexchat:` default, succeeding when it keeps only the `simplex:` one, and refusing a path the entry cannot run; `runProcess` output, discarded error output, an end of input and failure. + The ownership, AppImage registration and `runProcess` cases need POSIX permissions and `sh`, and the symlinked-mount case needs symlink rights, so they are skipped on Windows. + - `BadgePageUrlTest`: `app=true` when the link returns, `app=desktop` otherwise. + - `WindowActivationTest`: the `_NET_ACTIVE_WINDOW` client message targets the window with the pager source and `CurrentTime`, checked in native memory; it is sent to the root window with the window manager's event mask, and the display is closed even when sending fails (skipped where libX11 cannot load, as on Windows and macOS). +- `./gradlew :desktop:compileKotlinJvm` and `./gradlew :common:compileDebugKotlinAndroid`: succeed, no new warnings. +- The `make-deb-linux.sh` sed applied to the v7.0.3 deb's desktop file gives the intended lines, and `update-desktop-database` lists it for `x-scheme-handler/simplexchat`. +- The AppImage entry passes `desktop-file-validate` and reaches the MIME cache. + +## Manual verification (to do) + +Test with `simplexchat:/badge/code/` from a real purchase, or with the page mock (`apps/simplex-badge-service/web/mock/server.py`, open `#/tier?app=true` in a private window, settle with `/control/settle/`). + +### macOS (signed `.dmg`, installed to /Applications) +- [ ] `lsregister -dump | grep simplexchat` lists the installed app +- [ ] app closed: `open 'simplexchat:/badge/code/'` starts it and shows the redeem screen +- [ ] app running, window behind others: link raises it and shows the redeem screen +- [ ] app hidden in the tray: link shows the window +- [ ] dmg still mounted beside the installed copy: the installed copy opens +- [ ] Safari, Chrome, Firefox: *Return to SimpleX* prompts, then opens the app + +### Windows (`.msi` install) +- [ ] after first launch, `HKCU\Software\Classes\simplexchat\shell\open\command` is `"C:\Program Files\SimpleX\SimpleX.exe" "%1"` +- [ ] app closed: `start simplexchat:/badge/code/` starts it and shows the redeem screen +- [ ] app running: link reaches the running app, window comes to the front +- [ ] app hidden in the tray: link shows the window +- [ ] the argument arrives as one piece after the launcher restarts itself +- [ ] Edge, Chrome, Firefox: *Return to SimpleX* prompts, then opens the app +- [ ] after an MSI upgrade, the key still points at the installed exe +- [ ] SimpleX is offered under *Settings → Default apps → SIMPLEXCHAT*; picking another app there makes the page end with `app=desktop` after a restart +- [ ] fresh install, no choice made: the page ends with `app=true`, and `start simplexchat:/badge/code/` opens SimpleX +- [ ] with another app registered through `Capabilities` and no choice made: the page's ending matches what `start simplexchat:` actually opens (`app=true` only if SimpleX opens) + +### Linux +- [ ] deb on GNOME and KDE: `xdg-mime query default x-scheme-handler/simplexchat` gives `simplex-simplex.desktop` +- [ ] deb, app closed and running: `xdg-open 'simplexchat:/badge/code/'` shows the redeem screen +- [ ] AppImage: after first launch the hidden entry exists and is the default; moving the AppImage and relaunching updates it +- [ ] Flatpak: link opens the Flatpak app (needs the Flathub update) +- [ ] Firefox and Chrome from the distribution, snap Firefox on Ubuntu, Flatpak Firefox: *Return to SimpleX* opens the app +- [ ] GNOME on Wayland: window comes forward +- [ ] Sway: default config marks SimpleX urgent; with `focus_on_window_activation focus` the link focuses it +- [ ] deb and AppImage: `xdg-mime query default x-scheme-handler/simplex` names the app's entry + +### All platforms +- [ ] app locked with a passcode: the redeem screen appears after unlock +- [ ] no active profile: the link waits until a profile is active +- [ ] desktop connected to a mobile: the badge goes to the active remote profile +- [ ] a second link while one redeems is ignored +- [ ] no log file or console output contains the code +- [ ] a `simplex:` contact or one-time link from a browser, app closed and running: the connect dialog opens and asks before connecting +- [ ] unpackaged `./gradlew run`: page gets `app=desktop`, Redeem code screen opens beside the browser +- [ ] `./gradlew runDistributable` and the installed app keep each other's registration while both exes exist; delete the build output (or the HKCU keys) to give links back to the installed app +- [ ] two installed copies: the scheme stays with the first; after uninstalling it, the next start of the other copy takes the scheme + +## Known gaps + +The registration gaps below are also recorded as GAP-08 in `apps/multiplatform/product/gaps.md`. + +- A Flatpak always counts as registered, since the sandbox cannot query the host's default handler. If another installation holds the default, the page sends `app=true` and the link opens that installation; *Show code* still works. +- On Sway the window only becomes urgent unless the user sets `focus_on_window_activation smart` or `focus`. No client-side request can do more: Sway accepts activation tokens only for native Wayland windows. +- The Flathub release bump must pin a simplex-chat commit that includes the desktop file's MimeType line, and the Flathub wrapper must pass `"$@"` (done on its `update` branch). +- The HKCU key and the AppImage entry stay after uninstalling or deleting the app. On Windows, after an install into a folder other users can write to (such as a custom folder at the root of `C:\`), another user could place a program at the registered path; this accepted risk does not apply to the default Program Files install. +- On macOS, if LaunchServices starts a second copy of the app while one runs, that copy forwards no link: the URL arrives as an Apple Event the second copy never handles. +- jpackage's deb desktop file already has `Categories=Unknown`, which `desktop-file-validate` rejects, and a generic `Name=simplex`. The scheme still registers, and this work leaves both as they are. + +## Commits + +| Commit | Change | +|---|---| +| `tests: close the walk stream in withTempDir` | `Files.walk` closed in the existing `SingleInstanceTest` helper | +| `desktop: receive app links from args and macOS` | `AppLinks.kt`, `main(args)`, macOS handler | +| `desktop: forward an app link to the running app` | signal file payload in `SingleInstance.kt` | +| `desktop: initialize the desktop platform lazily` | `desktopPlatform` class initialization cycle | +| `tests: share the temp directory helper` | `withTempDir` moved to `TempDir.kt` for the scheme tests | +| `desktop: register simplexchat scheme in packages` | Info.plist, deb, AppImage and Flatpak desktop entries | +| `desktop: register simplexchat scheme at runtime` | `AppLinkScheme.desktop.kt` (Windows, AppImage, detection) | +| `ui: end the badge page with a link on desktop` | `appLinkSchemeRegistered()`, `badgePageUrl(linkReturns)`, fallback | +| `desktop: raise the window over other apps` | `isVisible` in `showWindow` and its skip of a disposed window during a crash restart, `_NET_ACTIVE_WINDOW` in `WindowActivation.kt`, `AllowSetForegroundWindow` on Windows | +| `docs: describe desktop deep links in the spec` | `navigation.md`, `architecture.md`, spec `README.md`, `impact.md`, `CODE.md` Document Map, `concepts.md`, `gaps.md` (GAP-08) | +| `docs: plan desktop deep links` | badge plan, plan | +| `docs: report on desktop deep links` | this report | +| `desktop: open simplex connection links` | `simplex:` accepted and registered beside `simplexchat:`, one 8192-byte bound, desktop link names without `App` | +| `docs: describe simplex links on desktop` | spec, `gaps.md`, plan and this report | +| `desktop: keep a link from opening twice` | `startDespiteRunningInstance()`: "Start anyway" withdraws the signal, and exits if the running app already took it | +| `desktop: retry taking a signal held open` | `takeSignal` retries a failed rename once | +| `desktop: keep the user's AppImage link handler` | the AppImage takes a scheme only when no handler is set or the current handler's entry is no longer installed | +| `desktop: register Windows links through Capabilities` | scheme keys and `SimpleX.` ProgIds, `Capabilities` with `URLAssociations` and `RegisteredApplications`; every value compared and repaired; another installed program's or copy's handler kept, per-user or machine-wide; registered when `AssocQueryStringW` names this exe; `SHChangeNotify` only after a change | +| `desktop: add %u to the deb entry only once` | the deb's `Exec` sed skips a line that already has a field code | +| `docs: describe the review fixes` | spec, `gaps.md`, plan and this report | diff --git a/plans/2026-09-28-desktop-deep-links.md b/plans/2026-09-28-desktop-deep-links.md new file mode 100644 index 0000000000..1097cab987 --- /dev/null +++ b/plans/2026-09-28-desktop-deep-links.md @@ -0,0 +1,145 @@ +# Desktop deep links: `simplexchat:` on Linux, Windows, macOS + +## Context + +The badge page (`badges.simplex.chat`) ends a purchase opened from the app with *Return to SimpleX*, which navigates to `simplexchat:/badge/code/`. Android and iOS handle it since #7592 (`isAppLink` → `openAppLink` → `openBadgeLink` → `BadgesRedeemLinkView`, which confirms before redeeming). Desktop registers no scheme, so it opens the page with `app=desktop` and relies on the user pasting the code (D1). Goal: every packaged desktop build receives the link, cold or running, and sends `app=true` only when a link is expected to reach this installation. D1 stays as the fallback. + +The decisions were to build on #7592, forward to a running instance through the existing signal file with a payload, register `simplexchat:` only (`simplex:` connection links were added afterwards, see the last section), and self-register at runtime on Windows (HKCU) and AppImage. + +## Research summary + +- **macOS**: `CFBundleURLTypes` in Info.plist; LaunchServices registers on copy to /Applications. URL arrives only as an Apple Event through `Desktop.setOpenURIHandler`; JDK 17 queues it until the handler is set (`_OpenURIDispatcher`), so cold start is safe for AWT/Compose. The running app receives it in-process, so no second process starts. +- **Windows**: `HKCU\Software\Classes\simplexchat` with `URL Protocol`, `shell\open\command = "" "%1"`. Compose 1.8.2 exposes no `--resource-dir`, so installer registration needs a WiX fork; runtime HKCU is what Signal, Element, Telegram do. URL arrives as argv of a new process. `jpackage.app-path` is set by the jpackage launcher (JDK 16+). +- **Linux**: `.desktop` with `MimeType=x-scheme-handler/simplexchat;` and `Exec=... %u`, visible once `mimeinfo.cache` is rebuilt. The v7.0.3 deb ships `/opt/simplex/lib/simplex-simplex.desktop` with `Exec=/opt/simplex/bin/simplex` and empty `MimeType=`; its postinst runs `xdg-desktop-menu install`, which runs `update-desktop-database`. AppImage has no install step, so it self-registers in `~/.local/share/applications`. Flatpak exports the `.desktop` MimeType (file is in `scripts/flatpak/`). +- **Browsers**: all prompt before launching; Chrome needs a user gesture (the page's button provides it). No reliable way for the page to know the app opened, so *Show code* stays. +- **Security**: link is a bearer token in argv, which on Linux other local users can read through `/proc` (for the whole session after a cold start); this risk is accepted. The lane already confirms before redeeming. Nothing may log the URI. + +## Flow + +``` +browser ─ simplexchat:/badge/code/X + macOS: Apple Event → setOpenURIHandler → openDesktopLink + Windows/Linux: new process main(args) → linkFromArgs + lock acquired → chatModel.appOpenUrl (cold start), then the watcher starts + lock taken → simplex.show payload → primary watcher → openDesktopLink +openDesktopLink: chatModel.appOpenUrl = remoteHostId() to uri; showWindow() +App.kt LaunchedEffect (existing) → connectIfOpenedViaUri → openAppLink (lane) +``` + +## Changes + +1. **`common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt`** (new, beside `SingleInstance.kt`) + - `isAcceptedLink(uri)`: `isAppLink` (`ChatListView.kt`) within `MAX_LINK_BYTES` UTF-8 bytes. + - `linkFromArgs(args)`: the only argument, when it is an accepted link; anything else is ignored. + - `openDesktopLink(uri)`: on the EDT, `chatModel.appOpenUrl.value = chatModel.remoteHostId() to uri`, then `showWindow()` (`DesktopApp.kt:258`), so a failure to show the window cannot lose the link. `remoteHostId()` matches the redeem screen (`BadgesRedeemCodeView.kt:98`). + - `installOpenUriHandler()`: called on macOS only (so Windows and Linux do not start AWT early); sets a handler that forwards accepted links to `openDesktopLink`. + +2. **`desktop/.../Main.kt`**: `main(args)`. Compute the link and pass it to `acquireSingleInstance(link)`; when this process runs, put it into `chatModel.appOpenUrl` (`null` host), then start the watcher if this process holds the lock, so a link the watcher forwards later is not overwritten. A short-lived second process never touches `chatModel`. After `initApp()`: start registration (step 4) and `installOpenUriHandler()`. Keep everything inside the existing try. + +3. **`SingleInstance.kt`**: the signal carries an optional payload. + - Second process: `Files.createTempFile(dataDir, "simplex.show", ".tmp")` (owner-only on POSIX), write the link or nothing, then `Files.move(tmp, showPath, ATOMIC_MOVE)`, which replaces an untaken signal on Linux and Windows. If that fails, fall back to an empty signal, which still brings the running instance forward. The rename arrives as `ENTRY_CREATE` on inotify and Windows. Existing 1 s wait and hung-primary alert stay; on "start anyway" the payload file is deleted and `main` handles the link itself. + - Primary watcher: rename `simplex.show` to a private temp name, so a newer signal renamed over it is not deleted unread, then accept at most `MAX_LINK_BYTES` bytes, delete it, and post `openDesktopLink(link)` or `showWindow()`. + - Primary start deletes a taken file left by a crash, and any `simplex.show*` file older than its lock attempt minus a 2 s tolerance for file time granularity: such a signal or temp file was left by an earlier session, while a fresh temp file is a signal being written. `main` then starts the watcher, which registers the watch and handles a signal already present, which raised no event. + - Windows: call `AllowSetForegroundWindow(ASFW_ANY)` before signalling so the primary can come forward (best effort). jna-platform 5.14 does not bind it, so it is looked up through `NativeLibrary`. + - Take the directory as a parameter internally so tests can use a temp dir. + - No log line includes the link. + +4. **`common/src/desktopMain/.../platform/AppLinkScheme.desktop.kt`** (new): `registerLinkSchemes()` runs once on a background thread and sets a `@Volatile` result read by the UI. `unixDataHome` is exposed from `Platform.desktop.kt` and `appLinkScheme` from `ChatListView.kt` for reuse. + - macOS: registered when `jpackage.app-path` is set (packaged bundle). + - Windows: when `jpackage.app-path` is set, read the HKCU command via `Advapi32Util`. If it differs from `"" "%1"`, write the default value `URL:SimpleX Chat`, `URL Protocol`, `DefaultIcon`, and `shell\open\command`. Registered if the key now matches. + - Linux: + - `container=flatpak` set (the check `AppUpdater` uses) → registered. + - AppImage, when `APPIMAGE` and `APPDIR` are set and the launcher runs from `APPDIR`, resolved through symlinks (the runtime exports `APPIMAGE` to every child process) → write `$XDG_DATA_HOME/applications/chat.simplex.app-links.desktop`: `NoDisplay=true`, `Exec= %u` with the path quoted only when the desktop-entry spec requires it (`xdg-open` 1.1.3 cannot run a quoted program), and the MimeType line; a path with a line break or `%` is refused (GLib looks the program up before it expands `%%`), and so is an AppImage whose file or any directory above it another user could replace (owned by anyone but the user or root, writable by others, or group-writable by a group other than the user's own; POSIX ACLs are not inspected). Rewrite it and run `update-desktop-database` only when the content differs, then run `xdg-mime default` unless the entry is already the default. + - Otherwise (deb): registered when `xdg-mime query default x-scheme-handler/simplexchat` names the deb's own `simplex-simplex.desktop`. Processes are run without a shell and with a timeout. + - The decision is the function `desktopInstallation(platform, appPath, env)`, so it is unit tested. + - `desktopPlatform` becomes lazy in its own commit: the new tests reference a `DesktopPlatform` constant first, and the eager value was then null through a class initialization cycle. + - Unpackaged runs register nothing and report false. + +5. **Common UI** + - `expect fun appLinkSchemeRegistered(): Boolean` in `platform/AppCommon.kt`, with Android actual `true` and desktop actual returning step 4's result. + - `BadgeStore.kt`: `badgePageUrl(linkReturns)` returns `app=true` or `app=desktop`; the button reads the flag once and passes it, so the URL and the fallback screen agree. + - `BadgesSupportSimplexView.kt` `BuyInBrowserButton`: open the Redeem code screen beside the browser only when not registered (replaces `appPlatform.isDesktop`), and update its comment. + +6. **Packaging** + - `desktop/build.gradle.kts`: add `CFBundleURLTypes` (`CFBundleURLName` `chat.simplex.app`, scheme `simplexchat`) to the existing `extraKeysRawXml`. + - `scripts/desktop/make-deb-linux.sh`: after `dpkg-deb -R`, sed `extracted/opt/*imple*/lib/*.desktop` so `Exec` ends in ` %u` and `MimeType=x-scheme-handler/simplexchat;`, and fail if the MimeType line is missing. This must run before the timestamp `touch`. + - `desktop/src/jvmMain/resources/distribute/SimpleX.desktop` (AppImage only): add the MimeType line and `%u` to Exec. In `scripts/desktop/make-appimage-linux.sh`, make the Exec sed replace only the program, so `%u` is kept. + - `scripts/flatpak/chat.simplex.simplex.desktop`: add the MimeType line. Confirm the Flathub manifest takes this file. + +7. **Window activation** (`WindowActivation.kt`, `DesktopApp.kt showWindow`): `showWindow` skips a disposed window (during a crash restart), sets `isVisible` immediately, and on Linux also sends `_NET_ACTIVE_WINDOW` (pager source) through JNA after syncing AWT's connection, because AWT's `toFront()` sends only `XRaiseWindow`, which Sway drops. + +8. **Docs** + - `apps/multiplatform/spec/client/navigation.md`: replace "Desktop registers no URL scheme" with the desktop paths. + - `apps/multiplatform/spec/architecture.md` and `spec/README.md`: the desktop `main()` steps, `showWindow()` and the line references they shift. + - `spec/impact.md` and the `CODE.md` Document Map: rows for the new desktop files, with `Main.kt` and `SingleInstance.kt` mapped to `navigation.md` as well; the Source Files tables in `navigation.md` and `architecture.md`; `product/concepts.md`: a row for `AppLinks.kt`; `product/gaps.md`: GAP-08 for the known registration gaps, marked `[GAP]` in `navigation.md`. + - `plans/2026-09-24-badge-buy-in-browser.md`: mark the desktop deep links section as done. + +## Commits + +1. `tests: close the walk stream in withTempDir` +2. `desktop: receive app links from args and macOS` +3. `desktop: forward an app link to the running app` +4. `desktop: initialize the desktop platform lazily` +5. `tests: share the temp directory helper` +6. `desktop: register simplexchat scheme in packages` +7. `desktop: register simplexchat scheme at runtime` +8. `ui: end the badge page with a link on desktop` +9. `desktop: raise the window over other apps` +10. `docs: describe desktop deep links in the spec` +11. `docs: plan desktop deep links` +12. `docs: report on desktop deep links` +13. `desktop: open simplex connection links` +14. `docs: describe simplex links on desktop` +15. `desktop: keep a link from opening twice` +16. `desktop: retry taking a signal held open` +17. `desktop: keep the user's AppImage link handler` +18. `desktop: register Windows links through Capabilities` +19. `desktop: add %u to the deb entry only once` +20. `docs: describe the review fixes` + +## Verification + +- **Unit tests** (`common/src/desktopTest`, beside `SingleInstanceTest.kt`): + - `linkFromArgs`: accepts `simplexchat:` in any case; rejects `https:`, empty args, a link that is not the only argument, and a link over the bound in bytes, including a multi-byte one within it in characters. + - Signal payload: link and empty round trip, taken once, replace of an untaken signal and of a taken file left by a crash, owner-only file on POSIX, a link of exactly the byte bound, rejected content including a multi-byte link over the bound, a temp file created beside the signal, a sweep that removes old temp files and a taken file but keeps a fresh temp file and the old lock and database files, keeps a signal within the 2 s tolerance and drops an older one, a watcher that takes a signal written before its watch, and successive signals arriving while it watches, each once, through a real `WatchService`. + - The Windows command string, the registry values and registration with a stand-in registry, the deb's registered check, the AppImage desktop entry for a path with spaces, Exec quoting that leaves a plain path bare and quotes and escapes reserved characters, its refusal of line breaks and `%`, `runProcess` output, discarded error output, an end of input and failure, and `desktopInstallation` precedence including Flatpak over AppImage, inherited AppImage variables, a mount path that only shares a prefix, and a mount reached through a symlink; the AppImage ownership check for world-writable and group-writable files and directories, a world-writable ancestor, another owner, a root-owned file, and a missing file; AppImage registration with a stand-in for `xdg-mime`: a new entry in a missing directory, an unchanged default, an unchanged entry that is no longer the default, a moved AppImage, a default that does not change, and a path the entry cannot run. + - `badgePageUrl` (in `common/src/commonTest`): `app=true` when the link returns, `app=desktop` otherwise. + - `activationEvent` and `sendActivation`: a `_NET_ACTIVE_WINDOW` client message for the window, with the pager source and `CurrentTime`, checked in native memory, sent to the root window through a stand-in for libX11 that also checks the display is closed. +- **Commands**: `./gradlew :common:desktopTest`, `./gradlew :desktop:compileKotlinJvm` and `./gradlew :common:compileDebugKotlinAndroid`, with no new warnings. +- **Manual matrix** on packaged builds. States: app closed, running, hidden in tray, locked with passcode, no active profile. + - Launch commands: `open 'simplexchat:/badge/code/'`, `start simplexchat:/badge/code/`, `xdg-open ...`. + - End to end through the page mock (`apps/simplex-badge-service/web/mock/server.py`, `#/tier?app=true`, settle via `/control/settle/`) in Chrome, Firefox and Safari. + - Linux: deb on GNOME and KDE, snap Firefox, Flatpak, AppImage. + - Check `lsregister -dump | grep simplexchat` on macOS and the HKCU key on Windows. + - Confirm that no log contains the code. +- **Unpackaged `./gradlew run`**: reports not registered and keeps D1. + +## Risks to confirm on hardware + +- How the Windows launcher re-quotes argv when it restarts itself. +- macOS cold start with Compose 1.8.2. +- Snap Firefox on Ubuntu opening custom schemes. +- GNOME Wayland raising the window (best effort). +- Stale HKCU keys and AppImage entries stay after uninstall or deletion; the plan accepts that. +- The deb's existing `Categories=Unknown`, which `desktop-file-validate` rejects, is out of scope and left as is. + +## `simplex:` connection links + +Android already opens `simplex:` links through `connectIfOpenedViaUri`, which sends them to `planAndConnect` (it asks before connecting). Desktop now receives them by the same paths as app links. + +- `isAcceptedLink` accepts `isAppLink` or `isConnectionLink` (`ChatListView.kt`). One bound covers both: `MAX_LINK_BYTES` is 8192, as a one-time link with its post-quantum key is about 2 KB and a second such key would bring it near 4 KB (the sntrup761 key alone is 1544 characters in base64url). The desktop names lose the `App` part: `linkFromArgs`, `openDesktopLink`, `registerLinkSchemes`. +- Every registration declares both schemes: the Info.plist, the deb, AppImage and Flatpak desktop entries, an HKCU key per scheme on Windows, and `xdg-mime default` per MIME type for an AppImage. +- `appLinkSchemeRegistered()` still reports `simplexchat:` only, as it decides how the badge page ends; `simplex:` is registered without being checked. +- Tests: a short link, a one-time link with its key, and the scheme in another case are accepted; another scheme sharing the prefix and a path are not; a forwarded one-time link round trips through the signal file; Windows and AppImage registration write both schemes, and only `simplexchat:` decides the result. + +## Review fixes + +- "Start anyway" after the not-responding alert withdraws the signal with `deleteIfExists`; when the running instance has already taken it, the second process exits, so the link opens once (`startDespiteRunningInstance`, extracted from `acquireSingleInstance` so it is tested). +- `takeSignal` retries a failed rename once after 100 ms, as another program (an antivirus scanner on Windows) can hold the file open for a moment. The move is a parameter, so tests make it fail. +- Windows registration compares and repairs every value, not only the command; reads a value of another type as missing instead of letting JNA's `RuntimeException` end the registration thread; and reports not registered when `UserChoice` names another ProgId (replaced later by asking the shell, below). +- Registration takes a scheme only when no handler is set or the current one is no longer installed: on Windows when the command's program file is missing, for an AppImage when the current default's desktop entry is in no applications directory. Another installation keeps it, and the badge page falls back to `app=desktop`. +- The deb's `Exec` sed adds `%u` only to a line without a field code. +- Windows: a test on Windows 11 showed that a scheme key alone loses to any app registered through `Capabilities`: links went to that app without asking, and default-app settings did not offer SimpleX. Each scheme now also gets a `SimpleX.` ProgId named in `HKCU\Software\chat.simplex.app\Capabilities\URLAssociations`, and the application is listed in `HKCU\Software\RegisteredApplications` last. `UserChoice` was compared with that ProgId until the shell check below replaced it. The scheme key stays, as it declares the URL scheme to Windows. +- Not changed: stale-signal detection still compares file times with the local clock (network file systems with clock skew above 2 s are an accepted edge case). +- A second review of the Windows change: Windows 11 can keep the user's pick in `UserChoiceLatest` and stop updating `UserChoice`, and with several capable apps and no pick Windows chooses or asks. So the registered check no longer reads either key: it asks the shell which program opens `simplexchat:` links (`AssocQueryStringW` with `ASSOCSTR_EXECUTABLE`) and compares it with this exe. This app's own ProgId is rewritten even while another program holds the scheme, so a pick in settings keeps working after a reinstall elsewhere; the "another program" check also reads `HKLM\Software\Classes`, which a per-user key would otherwise hide; the application is listed only when at least one scheme is this app's; and `SHChangeNotify(SHCNE_ASSOCCHANGED)` follows any write. Both functions are called through `NativeLibrary`, as jna-platform 5.14 binds neither. +- A third review: `SHChangeNotify` also clears Explorer's icon cache, so it is sent only after a write. Another installed copy's ProgId (its command names an existing exe other than this one) is kept like any other handler, so two installed copies do not take the user's pick from each other at every start. A command naming this exe with other arguments or letter case counts as this app's own and is updated. A ProgId that cannot be written keeps its scheme unregistered, so `URLAssociations` never names a missing ProgId. diff --git a/scripts/desktop/make-appimage-linux.sh b/scripts/desktop/make-appimage-linux.sh index 650c98d522..ae10710174 100755 --- a/scripts/desktop/make-appimage-linux.sh +++ b/scripts/desktop/make-appimage-linux.sh @@ -39,7 +39,7 @@ cp usr/lib/simplex.png usr/share/icons ln -s usr/bin/*imple* AppRun cp $multiplatform_dir/desktop/src/jvmMain/resources/distribute/*imple*.desktop chat.simplex.app.desktop -sed -i 's|Exec=.*|Exec=simplex|g' *imple*.desktop +sed -i 's|^Exec=[^ ]*|Exec=simplex|' *imple*.desktop sed -i 's|Icon=.*|Icon=simplex|g' *imple*.desktop cp *imple*.desktop usr/share/applications/ cp $multiplatform_dir/desktop/src/jvmMain/resources/distribute/*.appdata.xml usr/share/metainfo diff --git a/scripts/desktop/make-deb-linux.sh b/scripts/desktop/make-deb-linux.sh index 0fa543a81d..5231dea0dd 100755 --- a/scripts/desktop/make-deb-linux.sh +++ b/scripts/desktop/make-deb-linux.sh @@ -48,6 +48,10 @@ dpkg-deb -R ./release/main/deb/simplex*.deb ./extracted rm -f ./extracted/opt/*imple*/lib/app/*skiko-awt-runtime-linux* sed -i -e '/skiko-awt-runtime-linux/d' ./extracted/opt/*imple*/lib/app/simplex.cfg sed -i "/Version/ s/\$/~$VERSION_CODENAME/" ./extracted/DEBIAN/control +# jpackage's desktop entry passes no URL and handles no MIME type; this registers the simplexchat: and simplex: schemes +SCHEME_MIME_TYPE_LINE='MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex;' +sed -i -e '/%[uU]/!s|^Exec=.*|& %u|' -e "s|^MimeType=.*|$SCHEME_MIME_TYPE_LINE|" ./extracted/opt/*imple*/lib/*.desktop +grep -qxF "$SCHEME_MIME_TYPE_LINE" ./extracted/opt/*imple*/lib/*.desktop || { echo "desktop entry does not register simplexchat: and simplex:" >&2; exit 1; } find ./extracted/ -exec touch -d "@$SOURCE_DATE_EPOCH" {} + dpkg-deb --build --root-owner-group --uniform-compression ./extracted ./release/main/deb/simplex_${ARCH}.deb diff --git a/scripts/flatpak/chat.simplex.simplex.desktop b/scripts/flatpak/chat.simplex.simplex.desktop index 4f4cd4eece..d18285b278 100644 --- a/scripts/flatpak/chat.simplex.simplex.desktop +++ b/scripts/flatpak/chat.simplex.simplex.desktop @@ -8,3 +8,4 @@ Categories=Utility;Chat;InstantMessaging; Exec=simplex %U Icon=chat.simplex.simplex StartupWMClass=simplex-chat +MimeType=x-scheme-handler/simplexchat;x-scheme-handler/simplex; From 75e6fe8f5d4489d812afa49591725603c263c857 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Thu, 8 Oct 2026 15:29:05 +0000 Subject: [PATCH 07/26] ios, android: tell the buyer a badge was added when the store purchase completes off screen (#7662) --- apps/ios/Shared/Model/SimpleXAPI.swift | 2 +- apps/ios/Shared/Views/Badges/BadgeStore.swift | 10 +++++++++- .../Views/Badges/BadgesRedeemCodeView.swift | 16 ++++++++++------ apps/ios/Shared/Views/Badges/BadgesView.swift | 4 ++++ apps/ios/spec/client/navigation.md | 2 +- .../chat/simplex/common/model/SimpleXAPI.kt | 2 +- .../simplex/common/views/badges/BadgeStore.kt | 14 +++++++++++++- .../views/badges/BadgesRedeemCodeView.kt | 19 +++++++++++++------ .../simplex/common/views/badges/BadgesView.kt | 3 ++- .../common/views/chatlist/ChatListView.kt | 6 +++--- .../simplex/common/views/helpers/ModalView.kt | 3 ++- .../common/views/usersettings/SettingsView.kt | 2 +- apps/multiplatform/spec/client/navigation.md | 2 +- 13 files changed, 61 insertions(+), 24 deletions(-) diff --git a/apps/ios/Shared/Model/SimpleXAPI.swift b/apps/ios/Shared/Model/SimpleXAPI.swift index 2a9c82a966..cfd857c035 100644 --- a/apps/ios/Shared/Model/SimpleXAPI.swift +++ b/apps/ios/Shared/Model/SimpleXAPI.swift @@ -3095,7 +3095,7 @@ func processReceivedMsg(_ res: ChatEvent) async { } } case let .storePurchaseCredited(user, invoiceId): - Task { await BadgeStore.shared.storePurchaseResolved(user, invoiceId) } + Task { await BadgeStore.shared.storePurchaseCredited(user, invoiceId) } case let .storePurchaseRefused(user, invoiceId, refusal): Task { await BadgeStore.shared.storePurchaseRefused(user, invoiceId, refusal) } default: diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index f5da8d62e1..8194abcc46 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -259,6 +259,14 @@ final class BadgeStore: ObservableObject { } } + func storePurchaseCredited(_ user: UserRef, _ invoiceId: String) async { + await MainActor.run { + // an open badges screen is the notice only for the active profile, whose badge it shows + if !active(user) || !badgesViewShown { showBadgeAddedAlert(user) } + } + await storePurchaseResolved(user, invoiceId) + } + func storePurchaseRefused(_ user: UserRef, _ invoiceId: String, _ refusal: BadgeIssueFailure) async { await MainActor.run { if active(user) && openStorePurchases(user.userId).contains(where: { $0.invoiceId == invoiceId }) { @@ -268,7 +276,7 @@ final class BadgeStore: ObservableObject { await storePurchaseResolved(user, invoiceId) } - func storePurchaseResolved(_ user: UserRef, _ invoiceId: String) async { + private func storePurchaseResolved(_ user: UserRef, _ invoiceId: String) async { // the row goes before the store is read, or the screen shows it open while the store answers; // the transaction is finished whoever owns it, as only the app can, while the cached row is the active profile's await MainActor.run { diff --git a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift index 322dbf1864..0cf0ec0673 100644 --- a/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesRedeemCodeView.swift @@ -67,6 +67,15 @@ func showCannotRedeemAlert(_ message: String) { showAlert(NSLocalizedString("Cannot redeem code", comment: "alert title"), message: message) } +// a hidden profile is named only while it is the active one, which is unlocked and on screen +func showBadgeAddedAlert(_ user: any UserLike) { + guard let owner = ChatModel.shared.getUser(user.userId), active(owner) || !owner.hidden else { return } + showAlert( + NSLocalizedString("Badge added", comment: "alert title"), + message: String.localizedStringWithFormat(NSLocalizedString("The badge was added to the profile %@.", comment: "alert message"), owner.displayName) + ) +} + struct BadgesRedeemCodeView: View { @EnvironmentObject var theme: AppTheme @EnvironmentObject var chatModel: ChatModel @@ -396,12 +405,7 @@ struct BadgesRedeemLinkView: View { await MainActor.run { switch outcome { case .redeemed: - if !isShowing { - showAlert( - NSLocalizedString("Badge added", comment: "alert title"), - message: String.localizedStringWithFormat(NSLocalizedString("The badge was added to the profile %@.", comment: "alert message"), user.displayName) - ) - } + if !isShowing { showBadgeAddedAlert(user) } // a covered screen is not left on the spinner; a closed one is not written to if isOpen { state.step = .redeemed } case let .refused(message): closeIfShowing { showCannotRedeemAlert(message) } diff --git a/apps/ios/Shared/Views/Badges/BadgesView.swift b/apps/ios/Shared/Views/Badges/BadgesView.swift index 2d37860c45..c6a9749dd4 100644 --- a/apps/ios/Shared/Views/Badges/BadgesView.swift +++ b/apps/ios/Shared/Views/Badges/BadgesView.swift @@ -41,9 +41,13 @@ struct BadgesView: View { .animation(.default, value: shownBadge != nil) .animation(.default, value: store.purchaseState(chatModel.currentUser?.userId)) .animation(.default, value: store.checkingPurchases) + .onAppear { badgesViewShown = true } + .onDisappear { badgesViewShown = false } } } +private(set) var badgesViewShown = false + var supportSimpleXAlertAction: UIAlertAction { UIAlertAction(title: NSLocalizedString("Support SimpleX", comment: "alert button"), style: .default) { _ in openBadgesView() diff --git a/apps/ios/spec/client/navigation.md b/apps/ios/spec/client/navigation.md index 329f764efa..81965dcd8d 100644 --- a/apps/ios/spec/client/navigation.md +++ b/apps/ios/spec/client/navigation.md @@ -200,7 +200,7 @@ SimpleX links (`simplex:/chat#...`) are handled via [`connectViaUrl()`](../../Sh URL processing routes to the appropriate connection flow (join group, add contact, etc.) via [`planAndConnect()`](../../Shared/Views/NewChat/NewChatView.swift#L1181). -App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectViaUrl_()` branches on that scheme before the path switch, so an app link never reaches `planAndConnect()`, and `openAppLink()` dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to `openBadgeLink()` in [`BadgesRedeemCodeView.swift`](../../Shared/Views/Badges/BadgesRedeemCodeView.swift), which presents `BadgesRedeemLinkView` as an app sheet. The sheet names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the sheet renders), which core would refuse, the sheet does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or a swipe closes the sheet without cancelling anything; if the redemption then succeeds with the sheet closed or covered, an alert says the badge was added. While the sheet shows a redemption in flight (`isBadgeLinkIssuing()`), `connectViaUrl_()` ignores a further app link; otherwise it dismisses the sheets as for any link, which replaces an earlier badge link sheet. Any other path is a link type from a later version, and gets an alert asking to check for app updates. An app link can carry a secret, so `onOpenURL` logs it as "app link" rather than the URL. +App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectViaUrl_()` branches on that scheme before the path switch, so an app link never reaches `planAndConnect()`, and `openAppLink()` dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to `openBadgeLink()` in [`BadgesRedeemCodeView.swift`](../../Shared/Views/Badges/BadgesRedeemCodeView.swift), which presents `BadgesRedeemLinkView` as an app sheet. The sheet names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the sheet renders), which core would refuse, the sheet does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or a swipe closes the sheet without cancelling anything; if the redemption then succeeds with the sheet closed or covered, an alert says the badge was added and names the profile, unless the profile is hidden and no longer active, when nothing is shown (`showBadgeAddedAlert()`, which the store lane shares). While the sheet shows a redemption in flight (`isBadgeLinkIssuing()`), `connectViaUrl_()` ignores a further app link; otherwise it dismisses the sheets as for any link, which replaces an earlier badge link sheet. Any other path is a link type from a later version, and gets an alert asking to check for app updates. An app link can carry a secret, so `onOpenURL` logs it as "app link" rather than the URL. ### Call Deep Link diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt index 3c0443090b..53355e90f6 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt @@ -3613,7 +3613,7 @@ object ChatController { } } is CR.StorePurchaseCredited -> - withLongRunningApi { BadgeStore.storePurchaseResolved(rhId, r.user, r.invoiceId) } + withLongRunningApi { BadgeStore.storePurchaseCredited(rhId, r.user, r.invoiceId) } is CR.StorePurchaseRefused -> withLongRunningApi { BadgeStore.storePurchaseRefused(rhId, r.user, r.invoiceId, r.refusal) } else -> diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index 5f63f38670..3b82ac1371 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -7,6 +7,8 @@ import chat.simplex.common.model.* import chat.simplex.common.model.ChatController.appPrefs import chat.simplex.common.platform.* import chat.simplex.common.views.helpers.AlertManager +import chat.simplex.common.views.helpers.ModalManager +import chat.simplex.common.views.helpers.ModalViewId import chat.simplex.common.views.helpers.generalGetString import chat.simplex.res.* import kotlinx.coroutines.CancellationException @@ -306,6 +308,16 @@ object BadgeStore { } } + suspend fun storePurchaseCredited(rhId: Long?, user: UserRef, invoiceId: String) { + withContext(Dispatchers.Main) { + // not isLastModalOpen: the purchase screens pushed over the badges screen close once the badge appears + val badgesOpen = ModalManager.start.hasModalOpen(ModalViewId.BADGES) || ModalManager.end.hasModalOpen(ModalViewId.BADGES) + // an open badges screen is the notice only for the active profile, whose badge it shows + if (!chatModel.controller.activeUser(rhId, user) || !badgesOpen) showBadgeAddedAlert(rhId, user) + } + storePurchaseResolved(rhId, user, invoiceId) + } + suspend fun storePurchaseRefused(rhId: Long?, user: UserRef, invoiceId: String, refusal: BadgeIssueFailure) { withContext(Dispatchers.Main) { if (chatModel.controller.activeUser(rhId, user) && openStorePurchases(user.userId).any { it.invoiceId == invoiceId }) { @@ -315,7 +327,7 @@ object BadgeStore { storePurchaseResolved(rhId, user, invoiceId) } - suspend fun storePurchaseResolved(rhId: Long?, user: UserRef, invoiceId: String) { + private suspend fun storePurchaseResolved(rhId: Long?, user: UserRef, invoiceId: String) { // the row goes before the store is read, or the screen shows it open while the store answers; // the purchase is finished whoever owns it, as only the app can, while the cached row is the active profile's withContext(Dispatchers.Main) { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt index b3e74d3e2c..094f623032 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt @@ -93,6 +93,18 @@ fun showCannotRedeemAlert(message: String) { AlertManager.shared.showAlertMsg(title = generalGetString(MR.strings.badges_error_title), text = message) } +// a hidden profile is named only while it is the active one, which is unlocked and on screen +fun showBadgeAddedAlert(rhId: Long?, user: UserLike) { + val owner = if (chatModel.controller.activeUser(rhId, user)) chatModel.currentUser.value + else chatModel.users.firstOrNull { it.user.remoteHostId == rhId && it.user.userId == user.userId }?.user?.takeIf { !it.hidden } + if (owner != null) { + AlertManager.shared.showAlertMsg( + title = generalGetString(MR.strings.badges_link_added_title), + text = String.format(generalGetString(MR.strings.badges_link_added_profile), owner.displayName) + ) + } +} + @Composable fun BadgesRedeemCodeView(modalManager: ModalManager, unwindToDepth: Int) { val rhId = remember { chatModel.remoteHostId() } @@ -320,12 +332,7 @@ fun BadgesRedeemLinkView(rhId: Long?, code: String, step: MutableState { - if (!isShowing()) { - AlertManager.shared.showAlertMsg( - title = generalGetString(MR.strings.badges_link_added_title), - text = String.format(generalGetString(MR.strings.badges_link_added_profile), user.displayName) - ) - } + if (!isShowing()) showBadgeAddedAlert(rhId, user) // a covered screen is not left on the spinner; a closed one is not written to if (isOpen()) step.value = BadgeLinkStep.Redeemed } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt index c0050c8406..0e91b9ec7a 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesView.kt @@ -9,6 +9,7 @@ import chat.simplex.common.model.BadgeState import chat.simplex.common.platform.chatModel import chat.simplex.common.views.helpers.ModalManager import chat.simplex.common.views.helpers.ModalView +import chat.simplex.common.views.helpers.ModalViewId import chat.simplex.res.* @OptIn(ExperimentalAnimationApi::class) @@ -58,5 +59,5 @@ fun CloseWhenSupportGivesWay(modalManager: ModalManager, unwindToDepth: Int) { // ModalManager.end, not start: every caller is in the chat, which on desktop is the right pane fun openBadgesView() { - ModalManager.end.showCustomModal { close -> BadgesView(ModalManager.end, close) } + ModalManager.end.showCustomModal(id = ModalViewId.BADGES) { close -> BadgesView(ModalManager.end, close) } } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt index 31dfc4f64d..0615f6e5dd 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt @@ -1081,7 +1081,7 @@ private fun BoxScope.ChatList(searchText: MutableState, listStat SupportSimpleXBanner( title = stringResource(MR.strings.badges_support_ended), subtitle = String.format(stringResource(MR.strings.badges_support_ended_on), alert.dateText), - onTap = { ModalManager.start.showCustomModal { close -> BadgesView(ModalManager.start, close) } }, + onTap = { ModalManager.start.showCustomModal(id = ModalViewId.BADGES) { close -> BadgesView(ModalManager.start, close) } }, onDismiss = { showBadgeAlertDismissAlert(generalGetString(MR.strings.badges_support_ended)) } ) } @@ -1094,7 +1094,7 @@ private fun BoxScope.ChatList(searchText: MutableState, listStat title = stringResource(MR.strings.badges_renewal_failed), subtitle = stringResource(MR.strings.badges_tap_for_details), warning = true, - onTap = { ModalManager.start.showCustomModal { close -> BadgesView(ModalManager.start, close) } }, + onTap = { ModalManager.start.showCustomModal(id = ModalViewId.BADGES) { close -> BadgesView(ModalManager.start, close) } }, onDismiss = { showBadgeAlertDismissAlert(generalGetString(MR.strings.badges_renewal_failed)) } ) } @@ -1107,7 +1107,7 @@ private fun BoxScope.ChatList(searchText: MutableState, listStat showDismiss = supporterBannerTapped.value, onTap = { appPrefs.supporterBannerTapped.set(true) - ModalManager.start.showCustomModal { close -> BadgesView(ModalManager.start, close) } + ModalManager.start.showCustomModal(id = ModalViewId.BADGES) { close -> BadgesView(ModalManager.start, close) } }, onDismiss = ::showSupportSimpleXDismissAlert ) diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt index 0511bb1cba..7422d673d5 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/helpers/ModalView.kt @@ -93,7 +93,8 @@ enum class ModalViewId { SECONDARY_CHAT, CONTEXT_USER_PICKER_INCOGNITO, BADGE_LINK, - BADGE_REDEEM_CODE + BADGE_REDEEM_CODE, + BADGES } class ModalManager(private val placement: ModalPlacement? = null) { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/usersettings/SettingsView.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/usersettings/SettingsView.kt index bd929bc2f7..3e36ebda0f 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/usersettings/SettingsView.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/usersettings/SettingsView.kt @@ -110,7 +110,7 @@ fun SettingsLayout( SectionView { // Direct showModal (no settings / cardScreen flags) — settings-style card chrome would render // a gray top bar / back button that badges views don't want (they have their own inline titles). - SectionItemView(click = { ModalManager.start.showCustomModal { close -> BadgesView(ModalManager.start, close) } }) { + SectionItemView(click = { ModalManager.start.showCustomModal(id = ModalViewId.BADGES) { close -> BadgesView(ModalManager.start, close) } }) { val badgeType = chatModel.currentUser.value?.profile?.localBadge?.badge?.badgeType ?: BadgeType.Supporter Image(painterResource(badgeImage(badgeType)), stringResource(MR.strings.supporter_perks), Modifier.size(24.dp)) TextIconSpaced() diff --git a/apps/multiplatform/spec/client/navigation.md b/apps/multiplatform/spec/client/navigation.md index d6d5670c2f..ee0eb60f77 100644 --- a/apps/multiplatform/spec/client/navigation.md +++ b/apps/multiplatform/spec/client/navigation.md @@ -113,7 +113,7 @@ On Android, [`processIntent()`](../../android/src/main/java/chat/simplex/app/Mai On desktop the same state is set from three places, for `simplexchat:` app links and `simplex:` connection links alike. [`isAcceptedLink()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L12) accepts either scheme within 8192 bytes in UTF-8, which leaves room for a one-time link with its post-quantum key (about 2 KB) and for a second such key. A link that starts the app arrives as the only argument of [`main()`](../../desktop/src/jvmMain/kotlin/chat/simplex/desktop/Main.kt#L26) on Windows and Linux ([`linkFromArgs()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L15)). A link for an app that is already running starts a second process, which writes it into the single-instance signal file ([`signalRunningInstance()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L138)); the running instance renames the file before reading and deleting it ([`takeSignal()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L159)), retrying once if another program holds the file open, handles a signal already present when its watcher ([`watchShowSignals()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L247)) starts unless it predates the lock attempt by more than 2 s ([`deleteStaleSignalFiles()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L116)), and passes the link to [`openDesktopLink()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L19), which queues it for the active host and shows the window. If the running instance does not take the signal within 1 s, the second process asks whether to start anyway ([`startDespiteRunningInstance()`](../../common/src/desktopMain/kotlin/chat/simplex/common/SingleInstance.kt#L93)); on *Yes* it withdraws the signal first and exits instead if the running instance has recovered and taken it, so the link opens once. On macOS the link is an Apple Event handled by [`installOpenUriHandler()`](../../common/src/desktopMain/kotlin/chat/simplex/common/AppLinks.kt#L25). From there `connectIfOpenedViaUri()` handles the link as on Android: a connection link goes to `planAndConnect()`, which asks before connecting. Both schemes are declared by the macOS Info.plist, the deb, AppImage and Flatpak desktop entries, and at runtime by [`registerLinkSchemes()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L67) (HKCU on Windows, a hidden desktop entry for an AppImage). Only `simplexchat:` is checked: [`appLinkSchemeRegistered()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L65) decides the badge page's ending through [`badgePageUrl()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt#L53): `app=true` when a link is expected to reach this installation, otherwise `app=desktop` with the Redeem code screen opened beside the browser. [`desktopInstallation()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L74) tells the installation kind apart. A packaged macOS app and a Flatpak count as registered without a check, since a Flatpak cannot query the host's default handler ([GAP](../../product/gaps.md#gap-08-desktop-app-link-registration)); Windows, where each scheme key is paired with a `SimpleX.` ProgId named in `Capabilities` and listed in `RegisteredApplications`, so the app appears in Windows default-app settings for each scheme that no other program holds, when the shell (`AssocQueryStringW`) reports this exe as the program that opens `simplexchat:` links, which accounts for any app picked in settings ([`registerWindowsSchemes()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L168)); an AppImage ([`registerAppImageScheme()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L299)) or deb when its own desktop entry is the default `simplexchat:` handler. Registration takes a scheme only when no handler is set or the current one is no longer installed: another installed program, such as a deb beside an AppImage or on Windows a per-user or machine-wide handler, keeps it, while this app still repairs its own ProgId unless another installed copy holds it, and the page then ends with `app=desktop`. An AppImage is not registered ([`onlyOwnerCanReplace()`](../../common/src/desktopMain/kotlin/chat/simplex/common/platform/AppLinkScheme.desktop.kt#L284)) when its file or any directory above it belongs to a user other than this user or root, or has permission bits that let others write it (POSIX ACLs are not inspected), or when its path contains a line break or `%`. An unpackaged run registers nothing. -App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectIfOpenedViaUri()` branches on that scheme before the connection dispatch, so an app link never reaches `planAndConnect()`. [`isAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L797) tests the raw prefix, since text that does not parse as a URI is still an app link, and [`openAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L804) dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to [`openBadgeLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L268), which shows `BadgesRedeemLinkView` as a `ModalManager.start` modal with `ModalViewId.BADGE_LINK`. Once the code parses, every modal is closed first, so the screen opens over the chat list, as iOS dismisses every sheet before a link; a code that does not parse gets an alert and closes nothing. The screen names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the screen composes), which core would refuse, the screen does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or back closes the screen without cancelling anything; if the redemption then succeeds with the screen closed or covered, an alert says the badge was added. Its step is held by the modal rather than remembered by the composition, so rotation and being covered do not reset it. While the screen shows a redemption in flight ([`isBadgeLinkIssuing()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L265)), a further app link is ignored. Any other path is a link type from a later version, and gets an alert asking to check for app updates; text that does not parse is dropped. An app link can carry a secret, and nothing on this path logs the URI: `processIntent()` logs nothing, and `connectIfOpenedViaUri()` logs a fixed string. +App links use the app's own scheme, `simplexchat:`, for everything that is not a connection link. `connectIfOpenedViaUri()` branches on that scheme before the connection dispatch, so an app link never reaches `planAndConnect()`. [`isAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L797) tests the raw prefix, since text that does not parse as a URI is still an app link, and [`openAppLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatListView.kt#L804) dispatches on its path. A badge link (`simplexchat:/badge/code/`) goes to [`openBadgeLink()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L282), which shows `BadgesRedeemLinkView` as a `ModalManager.start` modal with `ModalViewId.BADGE_LINK`. Once the code parses, every modal is closed first, so the screen opens over the chat list, as iOS dismisses every sheet before a link; a code that does not parse gets an alert and closes nothing. The screen names the active profile and asks before redeeming, since any web page can send the link and a profile holds one badge at a time. On *Add badge* it redeems the code into that profile and then shows `BadgesView`; *Cancel* sends nothing. If that profile already shows a badge (read from `BadgeModel` when the screen composes), which core would refuse, the screen does not offer to add it: it says nothing was added, says where a code for another badge is (on the page it was bought on, under *Show code*), and offers *View your badge*; it cannot tell a repeated link for the badge it shows from another badge's code, so it asserts neither. While the code is being redeemed, *Dismiss* or back closes the screen without cancelling anything; if the redemption then succeeds with the screen closed or covered, an alert says the badge was added and names the profile, unless the profile is hidden and no longer active, when nothing is shown ([`showBadgeAddedAlert()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L97), which the store lane shares). Its step is held by the modal rather than remembered by the composition, so rotation and being covered do not reset it. While the screen shows a redemption in flight ([`isBadgeLinkIssuing()`](../../common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgesRedeemCodeView.kt#L279)), a further app link is ignored. Any other path is a link type from a later version, and gets an alert asking to check for app updates; text that does not parse is dropped. An app link can carry a secret, and nothing on this path logs the URI: `processIntent()` logs nothing, and `connectIfOpenedViaUri()` logs a fixed string. ### Overlay Layers (bottom of MainScreen) From b071285d15e4b5e0df3f08c3e63b82fb1769ab07 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Thu, 8 Oct 2026 15:45:12 +0000 Subject: [PATCH 08/26] tests: drop store purchase tests covered by their neighbours, and pin the rules none covered (#7665) --- src/Simplex/Chat/Store/Badges.hs | 5 +- tests/Bots/BadgeService/BotTests.hs | 272 +++++++++------------------- 2 files changed, 86 insertions(+), 191 deletions(-) diff --git a/src/Simplex/Chat/Store/Badges.hs b/src/Simplex/Chat/Store/Badges.hs index 28db3e5d67..12a914d35f 100644 --- a/src/Simplex/Chat/Store/Badges.hs +++ b/src/Simplex/Chat/Store/Badges.hs @@ -125,8 +125,9 @@ data BadgeReceiptStatus -- | Resolves a store transaction to the record that owns it, looking up by its reference again after each step -- rather than trusting the write: finding none still leaves the echoed invoice's record to attach it to, and a -- concurrent hand-over of the same transaction may win either write. It stays with the record that already has --- it, whose keys the service may have credited; failing that it joins the record Buy created; and only when the --- store echoed no invoice does the presenting profile get a new one, nothing else saying who paid. +-- it, whose keys the service may have credited; failing that it joins the record Buy created; and when no record +-- can take it - the store echoed no invoice, or the one it echoed is already held by another transaction - the +-- presenting profile gets a new one, nothing else saying who paid. holdStoreReceipt :: DB.Connection -> TVar ChaChaDRG -> User -> Maybe Text -> StoreTransactionRef -> ServicePayment -> UTCTime -> IO (Maybe BadgeReceiptRecord) holdStoreReceipt db g User {userId} invoiceId_ txRef@StoreTransactionRef {provider, transactionRef} payment now = getReceiptRecord db txRef >>= \case diff --git a/tests/Bots/BadgeService/BotTests.hs b/tests/Bots/BadgeService/BotTests.hs index 13e90fe7e2..78d3faa9d4 100644 --- a/tests/Bots/BadgeService/BotTests.hs +++ b/tests/Bots/BadgeService/BotTests.hs @@ -18,7 +18,7 @@ import Bots.BadgeService.ConfigTests (withIssuer) import Bots.BadgeService.FakeStore import BadgeService.Options import BadgeService.Service -import BadgeService.Store (IssuedCode (..), NewStorePurchase (..), createStorePurchase, getBadgeCode) +import BadgeService.Store (IssuedCode (..), getBadgeCode) import BadgeService.Store.Invoices (markCodePaid) import BadgeService.StoreReceipts (StoreRefusal (..), StoreVerifier (..), noStoreVerifier) import Simplex.Messaging.Agent.Store.DB (Binary (..)) @@ -60,7 +60,7 @@ import Simplex.Chat.Core (sendChatCmdStr) import Simplex.Chat.Options (ChatOpts (..), CoreChatOpts (..)) import Simplex.Chat.Options.DB import Simplex.Chat.PaymentService (ServicePayment (..)) -import Simplex.Chat.PaymentService.Types (InvoiceId (..), PaymentProvider (..)) +import Simplex.Chat.PaymentService.Types (InvoiceId (..)) import Simplex.Chat.Store.Badges (getNextHeldStoreReceipt) import Simplex.Messaging.Agent (disposeAgentClient) import Simplex.Messaging.Agent.Env.SQLite (AgentConfig (..)) @@ -131,10 +131,8 @@ badgeServiceTests = do describe "store purchases" $ do describe "what the store answers" $ do it "should credit the months a store receipt paid for and issue the first" testStorePurchase - it "should return the same credential for a receipt its key presents again, writing nothing" testStorePurchaseReplay it "should refuse a receipt another key was credited with" testStoreReceiptUsed it "should refuse a receipt the store does not vouch for, with no retry" testStoreReceiptInvalid - it "should answer a store it cannot reach as retryable, writing nothing" testStoreUnreachable it "should write nothing for a pending purchase, and credit it once when it settles" testStorePending it "should refuse a product that grants no badge" testStoreUnknownProduct it "should refuse a store purchase that carries an upgrade" testStoreUpgradeRefused @@ -143,29 +141,25 @@ badgeServiceTests = do it "should replay a receipt to its own key while the store is down, and to no other" testStoreReplayWhileStoreDown it "should answer a throwing Apple verifier as internal, and a failing or hanging Google one as retryable" testStoreVerifierFailures describe "claim races" $ do - it "should credit a transaction claimed twice at once only once" testStoreClaimRace it "should answer a request that lost the claim race with the credential the winner was given" testStorePurchaseRace it "should refuse as receipt_used a key that lost the claim race to another key, crediting nothing" testStorePurchaseRaceOtherKey describe "the service's own checks" $ do it "should refuse a store with no verifier with no retry, and the client should hold the receipt, showing why it is not credited" testPurchaseWithNoVerifier it "should credit nothing when the verified transaction is not the one the evidence names" testStoreVerifiedOtherTransaction - it "should refuse a verified quantity other than one as internal, and the client should hold the receipt" testStoreQuantityRefused + it "should refuse a verified quantity other than one as internal, writing nothing" testStoreQuantityRefused it "should refuse a store purchase whose purchaseKey is not the verified signer" testStorePurchaseKeyMismatch + it "should refuse a Play product id it will not send to Play, without asking Play" testStoreUnsentProductId describe "the hand-over" $ do - it "should hold a Play receipt until the worker credits it, and answer it as credited after" testPurchaseBadge - it "should credit an App Store purchase by its JWS" testPurchaseBadgeAppStore - it "should keep a refusal on the record, and hold a pending receipt until it settles" testPurchaseStash + it "should hold a Play receipt until the worker credits it, and answer it as credited to its owner under any profile" testPurchaseBadge + it "should refuse an App Store receipt that names no transaction, recording nothing" testPurchaseNamesNoTransaction it "should keep a receipt credited to another key as refused" testPurchaseStashReceiptUsed it "should hold a Play token the service will not send to Play" testPurchaseUnsentPlayToken - it "should hold a store receipt while a badge is held, without attempting it" testPurchaseWhileBadgeHeld - it "should answer a receipt handed over under a second profile as the profile that bought it" testPurchaseSameReceiptOtherProfile it "should credit a purchase first handed over under another profile to that profile" testPurchaseStrandedUnderOtherProfile it "should credit a purchase to a hidden profile without naming it" testPurchaseDeliveredToHiddenProfile describe "invoice first" $ do - it "should credit a receipt to the profile that created its invoice, and answer as that profile" testInvoiceOtherProfile - it "should resolve the same receipt to the same record, and answer it as credited" testInvoiceSameReceiptTwice + it "should credit a receipt to the profile that created its invoice however late it arrives, and answer as that profile" testInvoiceOtherProfile it "should credit a receipt naming an unknown invoice to the presenting profile" testInvoiceUnknown - it "should attach a late receipt to its record, and credit the profile that created it" testInvoiceLateReceipt + it "should record a receipt echoing an invoice another record holds by its transaction alone, and credit it" testInvoiceHeldByAnotherRecord it "should list a record however old until a receipt reaching it is settled" testInvoiceAgedOut it "should refuse an invoice with no service configured or while a badge is held, creating no record" testInvoiceRefusedBeforeCharge it "should hold a receipt for an invoice while a badge is held, without attempting it" testInvoiceWhileBadgeHeld @@ -178,6 +172,7 @@ badgeServiceTests = do it "should resolve one new transaction handed over twice at once to one record" testStoreReceiptTwoAtOnce it "should delete a month-old record that will fund no badge, and keep held and credited ones" testStoreReceiptCleanup it "should keep a receipt whose attempt throws" testStoreReceiptAttemptThrows + it "should credit a held receipt after the app restarts" testStoreReceiptAfterRestart badgeBotName :: Text badgeBotName = "SimpleX Badges" @@ -1708,19 +1703,6 @@ testStorePurchase ps = -- Play reports no price, and only the credit names the payment storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] -testStorePurchaseReplay :: HasCallStack => TestParams -> IO () -testStorePurchaseReplay ps = - withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do - (purchaseKey, masterKey) <- newPurchaseKeys - purchased <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay - ledger <- ledgerRows cc "sx_badge_service_badge_ledger" - replayed <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay - credentialOf replayed `shouldBe` credentialOf purchased - map entryTag (fst $ statementOf replayed) `shouldBe` map entryTag (fst $ statementOf purchased) - ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger - storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] - rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 - testStoreReceiptUsed :: HasCallStack => TestParams -> IO () testStoreReceiptUsed ps = withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do @@ -1740,18 +1722,11 @@ testStoreReceiptInvalid ps = let refused payment = refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey payment) refused (googlePayment "badge_supporter_01" "not-a-purchase") `shouldReturn` (BSEReceiptInvalid, Nothing) refused SPApple {jws = "not.a.jws"} `shouldReturn` (BSEReceiptInvalid, Nothing) + refused SPApple {jws = unsignedJWS "{\"transactionId\":\"2000000812345699\",\"productId\":\"BADGE_SUPPORTER_01\"}"} `shouldReturn` (BSEReceiptInvalid, Nothing) -- refused by the service, which the store would have vouched for refused SPApple {jws = appleSandboxJWS} `shouldReturn` (BSEReceiptInvalid, Nothing) nothingPurchased cc -testStoreUnreachable :: HasCallStack => TestParams -> IO () -testStoreUnreachable ps = - withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do - (purchaseKey, masterKey) <- newPurchaseKeys - unreachable <- serviceCmd env purchaseKey $ purchaseCmd masterKey $ googlePayment "badge_supporter_01" googleUnreachableToken - refusalOf unreachable `shouldSatisfy` \(code, retryAfter) -> code == BSEProviderUnavailable && isJust retryAfter - nothingPurchased cc - testStorePending :: HasCallStack => TestParams -> IO () testStorePending ps = withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = store} -> do @@ -1818,11 +1793,14 @@ testStoreReplayWhileStoreDown ps = -- the key it was credited to is answered from the record replayed <- serviceCmd env purchaseKey $ purchaseCmd masterKey supporterPlay credentialOf replayed `shouldBe` credentialOf purchased + map entryTag (fst $ statementOf replayed) `shouldBe` map entryTag (fst $ statementOf purchased) -- any other key waits for the store, or the answer would tell it which purchases were credited (otherKey, otherMasterKey) <- newPurchaseKeys other <- serviceCmd env otherKey $ purchaseCmd otherMasterKey supporterPlay fst (refusalOf other) `shouldBe` BSEProviderUnavailable ledgerRows cc "sx_badge_service_badge_ledger" `shouldReturn` ledger + storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 testStoreVerifierFailures :: HasCallStack => TestParams -> IO () testStoreVerifierFailures ps = @@ -1844,16 +1822,10 @@ testStoreVerifiedOtherTransaction ps = testStoreQuantityRefused :: HasCallStack => TestParams -> IO () testStoreQuantityRefused ps = - withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsClientCfg, bsController = cc, bsStore = FakeStore {appleQuantityJWS}} -> do + withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc, bsStore = FakeStore {appleQuantityJWS}} -> do (purchaseKey, masterKey) <- newPurchaseKeys refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey SPApple {jws = appleQuantityJWS}) `shouldReturn` (BSEInternal, Nothing) nothingPurchased cc - withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleQuantityJWS}) - storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error final internal" - heldStoreReceipts (chatController alice) `shouldReturn` 1 - nothingPurchased cc testPurchaseWithNoVerifier :: HasCallStack => TestParams -> IO () testPurchaseWithNoVerifier ps = @@ -1865,26 +1837,11 @@ testPurchaseWithNoVerifier ps = alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) storePurchaseOpen alice "" -- not yet rather than never, so the receipt stays held for the retry once a verifier is deployed - waitStoreReceiptError (chatController alice) "service_error final provider_not_configured" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final provider_not_configured"] heldStoreReceipts (chatController alice) `shouldReturn` 1 alice ##> "/_badge state 1" alice .<## ", not credited: service_error final provider_not_configured" -testStoreClaimRace :: HasCallStack => TestParams -> IO () -testStoreClaimRace ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsController = cc} -> do - (firstKey, firstMasterKey) <- newPurchaseKeys - (otherKey, otherMasterKey) <- newPurchaseKeys - now <- getCurrentTime - let claim paymentId purchaseKey masterKey = - withDB' "claim" cc $ \db -> - createStorePurchase db NewStorePurchase {paymentId, provider = PPGoogle, providerRef = "ref", paid = Nothing, purchaseKey, masterKey, badgeType = BTSupporter} now - -- the second insert meets the first's claim, as a request that read before the first wrote would - claim "p1" firstKey firstMasterKey >>= (`shouldSatisfy` either (const False) isJust) - claim "p2" otherKey otherMasterKey `shouldReturn` Right Nothing - rowCount cc "sx_badge_service_payments" `shouldReturn` 1 - rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 - testStorePurchaseRace :: HasCallStack => TestParams -> IO () testStorePurchaseRace ps = do hook <- newIORef (pure ()) @@ -1937,57 +1894,44 @@ testStorePurchaseKeyMismatch ps = alice <## "service response: {\"code\":\"bad_request\",\"type\":\"error\"}" nothingPurchased cc +testStoreUnsentProductId :: HasCallStack => TestParams -> IO () +testStoreUnsentProductId ps = do + hook <- newIORef (pure ()) + verifications <- countGoogleVerifications hook + withBadgeServiceVerifier ps (googleVerifierWithHook hook) $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + refusalOf <$> serviceCmd env purchaseKey (purchaseCmd masterKey $ googlePayment "badge_supporter_01/../other" googleSupporterToken) `shouldReturn` (BSEReceiptInvalid, Nothing) + verifications `shouldReturn` 0 + nothingPurchased cc + testPurchaseBadge :: HasCallStack => TestParams -> IO () testPurchaseBadge ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do invoiceId <- createInvoice alice 1 - let purchase = purchaseWithInvoice 1 invoiceId supporterPlay - alice ##> purchase + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] + alice ##> "/create user alisa" + showActiveUser alice "alisa" -- the app hands a purchase over until it is answered credited, and one already credited adds nothing - alice ##> purchase - alice <## "badge already redeemed" - alice ##> "/p" - alice <## "user profile: alice (Alice, * supporter)" - alice <## "use /p [] to change it" + alice ##> purchaseWithInvoice 2 invoiceId supporterPlay + alice <## "[user: alice] badge already redeemed" + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True)] rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 map (\(_, c, m, _, _, t) -> (c, m, t)) <$> ledgerRows (chatController alice) "badge_ledger" `shouldReturn` [(1, 1, Just "payment"), (-1, 0, Just "badge")] + alice ##> "/p" + showActiveUser alice "alisa" + alice ##> "/user alice" + showActiveUser alice "alice (Alice, * supporter)" -testPurchaseBadgeAppStore :: HasCallStack => TestParams -> IO () -testPurchaseBadgeAppStore ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc, bsStore = FakeStore {appleLegendJWS}} -> - withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - invoiceId <- createInvoice alice 1 - alice ##> purchaseWithInvoice 1 invoiceId SPApple {jws = appleLegendJWS} - inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: legend"] - storePayments cc `shouldReturn` [("apple", Just 7000, Just "USD", 1)] - -testPurchaseStash :: HasCallStack => TestParams -> IO () -testPurchaseStash ps = +testPurchaseNamesNoTransaction :: HasCallStack => TestParams -> IO () +testPurchaseNamesNoTransaction ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do invoiceId <- createInvoice alice 1 - let records = rowCount (chatController alice) "badge_store_receipts" - refused = purchaseWithInvoice 1 invoiceId (googlePayment "badge_supporter_01" "not-a-purchase") - -- the store does not vouch for it, so it can never be credited, and the record says so - alice ##> refused - alice <### [StartsWith (invoicePurchase "" invoiceId), ConsoleString (refusedLine "" invoiceId "service_error final receipt_invalid")] - alice ##> refused - alice <## "cannot get badge: badge service error: receipt_invalid" - records `shouldReturn` 1 - heldStoreReceipts (chatController alice) `shouldReturn` 0 - -- no store transaction to key a record by, so nothing is held or sent - alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = "not.a-jws"}) + alice ##> purchaseWithInvoice 1 invoiceId SPApple {jws = "not.a-jws"} alice <## "cannot get badge: invalid store receipt" - records `shouldReturn` 1 - nothingPurchased cc - -- pending keeps the receipt held - alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" googlePendingToken)) - storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error retry payment_pending" - records `shouldReturn` 2 - heldStoreReceipts (chatController alice) `shouldReturn` 1 + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), False)] nothingPurchased cc testPurchaseStashReceiptUsed :: HasCallStack => TestParams -> IO () @@ -2017,39 +1961,10 @@ testPurchaseUnsentPlayToken ps = withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "token/other")) storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error retry provider_unavailable" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error retry provider_unavailable"] heldStoreReceipts (chatController alice) `shouldReturn` 1 nothingPurchased cc -testPurchaseWhileBadgeHeld :: HasCallStack => TestParams -> IO () -testPurchaseWhileBadgeHeld ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> - withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - code <- issueCode cc BTSupporter 1 - redeemFirstBadge alice code - alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) - alice <##. "1: supporter" - storePurchaseOpen alice "" - storeReceiptDue (chatController alice) 1 `shouldReturn` False - heldStoreReceipts (chatController alice) `shouldReturn` 1 - rowCount cc "sx_badge_service_payments" `shouldReturn` 0 - -testPurchaseSameReceiptOtherProfile :: HasCallStack => TestParams -> IO () -testPurchaseSameReceiptOtherProfile ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> - withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - invoiceId <- createInvoice alice 1 - alice ##> purchaseWithInvoice 1 invoiceId supporterPlay - inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] - alice ##> "/create user alisa" - showActiveUser alice "alisa" - -- the store transaction is the device's, so it stays with the profile it was bought under - alice ##> purchaseWithInvoice 2 invoiceId supporterPlay - alice <## "[user: alice] badge already redeemed" - rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 - alice ##> "/p" - showActiveUser alice "alisa" - testPurchaseStrandedUnderOtherProfile :: HasCallStack => TestParams -> IO () testPurchaseStrandedUnderOtherProfile ps = do broken <- newIORef True @@ -2059,7 +1974,7 @@ testPurchaseStrandedUnderOtherProfile ps = do let purchase userId = purchaseWithInvoice userId invoiceId supporterPlay alice ##> purchase 1 alice <##. invoicePurchase "" invoiceId - waitStoreReceiptError (chatController alice) "service_error final internal" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final internal"] alice ##> "/create user alisa" showActiveUser alice "alisa" -- handed over again under whichever profile is active, the purchase stays with the keys alice holds @@ -2081,7 +1996,7 @@ testPurchaseDeliveredToHiddenProfile ps = do let purchase userId = "/_badge purchase " <> show (userId :: Int) <> " " <> paymentArg supporterPlay alice ##> purchase 1 storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error final internal" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final internal"] alice ##> "/create user alisa" showActiveUser alice "alisa" alice ##> "/_hide user 1 \"password\"" @@ -2092,16 +2007,17 @@ testPurchaseDeliveredToHiddenProfile ps = do alice ##> purchase 2 (alice "/user alice password" showActiveUser alice "alice (Alice, * supporter)" testInvoiceOtherProfile :: HasCallStack => TestParams -> IO () testInvoiceOtherProfile ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsClock = clock} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do invoiceId <- createInvoice alice 1 + getCurrentTime >>= setClockAt clock . addUTCTime (8 * nominalDay) alice ##> "/create user alisa" showActiveUser alice "alisa" alice ##> purchaseWithInvoice 2 invoiceId supporterPlay @@ -2111,18 +2027,6 @@ testInvoiceOtherProfile ps = alice ##> "/user alice" showActiveUser alice "alice (Alice, * supporter)" -testInvoiceSameReceiptTwice :: HasCallStack => TestParams -> IO () -testInvoiceSameReceiptTwice ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> - withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do - invoiceId <- createInvoice alice 1 - alice ##> purchaseWithInvoice 1 invoiceId supporterPlay - inAnyOrder alice [[invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] - alice ##> purchaseWithInvoice 1 invoiceId supporterPlay - alice <## "badge already redeemed" - storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True)] - rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 - testInvoiceUnknown :: HasCallStack => TestParams -> IO () testInvoiceUnknown ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> @@ -2135,18 +2039,17 @@ testInvoiceUnknown ps = inAnyOrder alice [[invoicePurchase "" unknown], creditedLines "" unknown "1: supporter"] storeReceiptRows (chatController alice) `shouldReturn` [(2, Just (T.pack unknown), True)] -testInvoiceLateReceipt :: HasCallStack => TestParams -> IO () -testInvoiceLateReceipt ps = - withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsClock = clock} -> +testInvoiceHeldByAnotherRecord :: HasCallStack => TestParams -> IO () +testInvoiceHeldByAnotherRecord ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsController = cc} -> withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do invoiceId <- createInvoice alice 1 - getCurrentTime >>= setClockAt clock . addUTCTime (8 * nominalDay) - alice ##> "/create user alisa" - showActiveUser alice "alisa" - alice ##> purchaseWithInvoice 2 invoiceId supporterPlay - inAnyOrder alice [[invoicePurchase "[user: alice] " invoiceId], creditedLines "[user: alice] " invoiceId "1: supporter"] - (alice purchaseWithInvoice 1 invoiceId (googlePayment "badge_supporter_01" "not-a-purchase") + alice <### [StartsWith (invoicePurchase "" invoiceId), ConsoleString (refusedLine "" invoiceId "service_error final receipt_invalid")] + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + inAnyOrder alice [[openPurchase ""], ["1: supporter"]] + storeReceiptRows (chatController alice) `shouldReturn` [(1, Just (T.pack invoiceId), True), (1, Nothing, True)] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 testInvoiceAgedOut :: HasCallStack => TestParams -> IO () testInvoiceAgedOut ps = @@ -2165,7 +2068,7 @@ testInvoiceAgedOut ps = alice ##> purchaseWithInvoice 1 presented (googlePayment "badge_supporter_01" googlePendingToken) alice <## ("store purchase open: invoice " <> unpaid) alice <##. ("store purchase open: invoice " <> presented <> ", transaction ") - waitStoreReceiptError (chatController alice) "service_error retry payment_pending" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error retry payment_pending"] -- no age hides a record: one with no receipt and one held stay listed, and only a settled one goes getCurrentTime >>= setClockAt clock . addUTCTime (8 * nominalDay) alice ##> "/_badge state 1" @@ -2226,7 +2129,7 @@ testStoreReceiptRetried ps = do invoiceId <- createInvoice alice 1 alice ##> purchaseWithInvoice 1 invoiceId supporterPlay alice <##. invoicePurchase "" invoiceId - waitStoreReceiptError (chatController alice) "service_error final internal" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final internal"] writeIORef broken False mapM_ (alice <##.) $ creditedLines "" invoiceId "1: supporter" rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 @@ -2238,7 +2141,7 @@ testStoreReceiptNotBlocked ps = setGoogleDown store True alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error retry provider_unavailable" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error retry provider_unavailable"] invoiceId <- createInvoice alice 1 alice ##> purchaseWithInvoice 1 invoiceId SPApple {jws = appleSupporterJWS} inAnyOrder alice [[openPurchase "", invoicePurchase "" invoiceId], creditedLines "" invoiceId "1: supporter"] @@ -2254,7 +2157,7 @@ testStoreRefusalKept ps = do alice ##> refused storePurchaseOpen alice "" -- with no invoice id the app has no key to the store transaction, so the refusal is not announced - waitHeldStoreReceipts (chatController alice) 0 + heldStoreReceipts (chatController alice) `shouldEventuallyReturn` 0 (alice refused alice <## "cannot get badge: badge service error: receipt_invalid" @@ -2284,7 +2187,7 @@ testStoreSettledOtherProfile ps = alice <## "profile is hidden" alice ##> purchaseWithInvoice 2 hidden (googlePayment "badge_supporter_01" "not-a-purchase-either") (alice ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" "not-a-purchase")) alice <## ("store purchase open: invoice " <> unpaid) storePurchaseOpen alice "" - waitHeldStoreReceipts (chatController alice) 0 + heldStoreReceipts (chatController alice) `shouldEventuallyReturn` 0 alice ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) alice <### [ConsoleString ("store purchase open: invoice " <> unpaid), StartsWith (openPurchase ""), StartsWith "1: supporter"] alice ##> ("/_badge purchase 1 " <> paymentArg (googlePayment "badge_supporter_01" googleUnreachableToken)) @@ -2328,14 +2231,8 @@ testStoreReceiptCleanup ps = StartsWith "1: supporter", StartsWith "badge alert: support_ended " ] - waitStoreReceiptRows (chatController alice) 2 `shouldReturn` [(1, Nothing, True), (1, Nothing, True)] + storeReceiptRows (chatController alice) `shouldEventuallyReturn` [(1, Nothing, True), (1, Nothing, True)] heldStoreReceipts (chatController alice) `shouldReturn` 1 - -- a receipt for the deleted invoice now arrives with no record to name its profile, so the presenting one gets it - alice ##> "/create user alisa" - showActiveUser alice "alisa" - alice ##> purchaseWithInvoice 2 unpaid (googlePayment "badge_supporter_01" googlePendingToken) - alice <##. ("store purchase open: invoice " <> unpaid <> ", transaction ") - waitStoreReceiptRows (chatController alice) 3 >>= (`shouldContain` [(2, Just (T.pack unpaid), True)]) testStoreReceiptAttemptThrows :: HasCallStack => TestParams -> IO () testStoreReceiptAttemptThrows ps = do @@ -2344,13 +2241,29 @@ testStoreReceiptAttemptThrows ps = do withNewTestChatCfg ps (fastRetryCfg bsClientCfg) "alice" aliceProfile $ \alice -> do alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) storePurchaseOpen alice "" - waitStoreReceiptError (chatController alice) "service_error final internal" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final internal"] -- a stored payment this version cannot read makes the attempt throw before anything is sent setStoreReceiptPayment (chatController alice) "not a payment" - waitStoreReceiptError (chatController alice) "unexpected held store payment does not decode" + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["unexpected held store payment does not decode"] (alice TestParams -> IO () +testStoreReceiptAfterRestart ps = do + broken <- newIORef True + withBadgeServiceVerifier ps (brokenGoogle broken) $ \BadgeServiceEnv {bsClientCfg} -> do + let cfg = fastRetryCfg bsClientCfg + invoiceId <- withNewTestChatCfg ps cfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + alice ##> purchaseWithInvoice 1 invoiceId supporterPlay + alice <##. invoicePurchase "" invoiceId + heldStoreReceiptErrors (chatController alice) `shouldEventuallyReturn` ["service_error final internal"] + pure invoiceId + writeIORef broken False + withTestChatCfg ps cfg "alice" $ \alice -> do + inAnyOrder alice [["subscribed 1 connections on server localhost"], creditedLines "" invoiceId "1: supporter"] + heldStoreReceipts (chatController alice) `shouldReturn` 0 + createInvoice :: HasCallStack => TestCC -> Int -> IO String createInvoice cc userId = do cc ##> ("/_badge invoice " <> show userId) @@ -2368,15 +2281,6 @@ storeReceiptRows ChatController {chatStore} = "SELECT user_id, invoice_id, transaction_ref IS NOT NULL " <> "FROM badge_store_receipts ORDER BY badge_store_receipt_id" --- The store receipt waits poll for 20 seconds, as long as getTermLine waits, since a parallel run can delay the worker that long. -waitStoreReceiptRows :: HasCallStack => ChatController -> Int -> IO [(Int64, Maybe Text, Bool)] -waitStoreReceiptRows cc n = loop (400 :: Int) - where - loop 0 = storeReceiptRows cc >>= \rows -> error $ "expected " <> show n <> " store purchase records, got " <> show rows - loop i = do - rows <- storeReceiptRows cc - if length rows == n then pure rows else threadDelay 50000 >> loop (i - 1) - storeReceiptDue :: ChatController -> Int64 -> IO Bool storeReceiptDue ChatController {chatStore} userId = withTransaction chatStore $ \db -> @@ -2388,20 +2292,10 @@ heldStoreReceipts ChatController {chatStore} = [Only n] <- DB.query_ db "SELECT COUNT(*) FROM badge_store_receipts WHERE payment IS NOT NULL" pure n -waitHeldStoreReceipts :: HasCallStack => ChatController -> Int -> IO () -waitHeldStoreReceipts cc n = loop (400 :: Int) - where - loop 0 = heldStoreReceipts cc >>= (`shouldBe` n) - loop i = heldStoreReceipts cc >>= \held -> if held == n then pure () else threadDelay 50000 >> loop (i - 1) - -waitStoreReceiptError :: HasCallStack => ChatController -> Text -> IO () -waitStoreReceiptError ChatController {chatStore} failure = loop (400 :: Int) - where - loop 0 = heldFailures >>= (`shouldContain` [failure]) - loop i = heldFailures >>= \failures -> if failure `elem` failures then pure () else threadDelay 50000 >> loop (i - 1) - heldFailures = - withTransaction chatStore $ \db -> - map fromOnly <$> DB.query_ db "SELECT credit_error FROM badge_store_receipts WHERE payment IS NOT NULL AND credit_error IS NOT NULL" +heldStoreReceiptErrors :: ChatController -> IO [Text] +heldStoreReceiptErrors ChatController {chatStore} = + withTransaction chatStore $ \db -> + map fromOnly <$> DB.query_ db "SELECT credit_error FROM badge_store_receipts WHERE payment IS NOT NULL AND credit_error IS NOT NULL" setStoreReceiptPayment :: ChatController -> Text -> IO () setStoreReceiptPayment ChatController {chatStore} payment = From cf3d6c45d0a964198cc334e99a20e7e5d02cba5b Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Fri, 9 Oct 2026 11:59:39 +0000 Subject: [PATCH 09/26] ios, android: tell the buyer once a run when a swept purchase cannot be handed over (#7674) --- apps/ios/Shared/Views/Badges/BadgeStore.swift | 12 +++++++++++- .../chat/simplex/common/views/badges/BadgeStore.kt | 14 +++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index 8194abcc46..2b265b01ab 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -111,6 +111,8 @@ final class BadgeStore: ObservableObject { // set once presentUnfinished has read the store: until then, an Ask to Buy approved while the app was // closed, or a purchase it died before handing over, are both unknown, so canBuy refuses to buy again @Published private var reconciledOnce = false + // the sweep has no buyer waiting and runs at four triggers, so a failure that cannot clear is told once a run + private var sweepFailureShown = false private var transactionUpdates: Task? = nil private init() {} @@ -321,9 +323,17 @@ final class BadgeStore: ObservableObject { if !badgeOneTimeProductIds.contains(receipt.productId) { await receipt.transaction.finish() } else if receipt.signatureVerified { - // no buyer to tell: the receipt stays unfinished and the next sweep hands it over again + // the receipt stays unfinished, so the next sweep hands it over again do { try await handOver(receipt) } catch let error { logger.error("BadgeStore.reconcile: \(responseError(error))") + await MainActor.run { + // showAlert presents on the top view controller, which the launch sweep can precede; + // an alert with nowhere to go must not spend the one this run gets + if !sweepFailureShown, getTopViewController() != nil { + sweepFailureShown = true + showAlert(NSLocalizedString("Purchase error", comment: "alert title"), message: redeemErrorText(error, purchase: true)) + } + } } } } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index 3b82ac1371..c9b413221d 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -161,6 +161,8 @@ object BadgeStore { // set once presentUnfinished has read the store, or failed to: until then, a slow payment completed while // the app was closed, or a purchase it died before handing over, are both unknown, so canBuy refuses private val reconciledOnce = mutableStateOf(false) + // the sweep has no buyer waiting and runs at four triggers, so a failure that cannot clear is told once a run + private var sweepFailureShown = false fun purchaseState(userId: Long?): BadgePurchaseState? { if (!badgeStoreAvailable) return null @@ -372,12 +374,22 @@ object BadgeStore { when (outcome) { is BadgePurchaseOutcome.Purchased -> if (outcome.receipt.productId !in badgeOneTimeProductIds) finish(outcome.receipt) - // no buyer to tell: the purchase stays unfinished and the next sweep hands it over again + // the purchase stays unfinished, so the next sweep hands it over again else try { handOver(outcome.receipt) } catch (e: Exception) { if (e is CancellationException) throw e Log.e(TAG, "BadgeStore.reconcile: ${e.stackTraceToString()}") + withContext(Dispatchers.Main) { + if (!sweepFailureShown) { + sweepFailureShown = true + AlertManager.shared.showAlertMsg( + title = generalGetString(MR.strings.badges_purchase_error), + text = if (e is BadgeStoreError.ApiError) chatModel.controller.redeemErrorText(e.err, purchase = true) + else "${generalGetString(MR.strings.error_prefix)}: ${e.message ?: e}" + ) + } + } } is BadgePurchaseOutcome.Pending -> if (outcome.invoiceId != null) withContext(Dispatchers.Main) { waitingForApproval.value += outcome.invoiceId } From 5cddbffaa1846c1a8a36cc5fe230085dbcb87ae8 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Fri, 9 Oct 2026 17:18:09 +0400 Subject: [PATCH 10/26] core: update query plans --- src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt index a30f42369a..38fbea289a 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt +++ b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt @@ -4124,7 +4124,7 @@ Plan: SEARCH file_badge_proofs USING INDEX idx_file_badge_proofs_file_id_kind (file_id=?) Query: - SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.payment, r.next_attempt_at, r.retry_delay + SELECT r.badge_store_receipt_id, r.purchase_key, r.purchase_priv_key, r.master_key, r.invoice_id, r.payment, r.next_attempt_at, r.retry_delay FROM badge_store_receipts r JOIN users u ON u.user_id = r.user_id WHERE r.user_id = ? AND r.payment IS NOT NULL AND u.shown_badge_id IS NULL @@ -4138,7 +4138,7 @@ USE TEMP B-TREE FOR ORDER BY Query: SELECT r.badge_store_receipt_id, r.user_id, r.purchase_key, r.purchase_priv_key, r.master_key, - r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error + r.invoice_id, r.payment, r.next_attempt_at, r.retry_delay, p.badge_purchase_id, r.credit_error FROM badge_store_receipts r LEFT JOIN badge_purchases p ON p.badge_store_receipt_id = r.badge_store_receipt_id WHERE r.provider = ? AND r.transaction_ref = ? From 59c588932ea6a253caa990d525a44a4a33ec37fb Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Tue, 13 Oct 2026 15:24:07 +0000 Subject: [PATCH 11/26] badge-service: verify App Store and Google Play purchases (#7654) --- apps/ios/Shared/Views/Badges/BadgeStore.swift | 4 +- apps/ios/SimpleXChat/APITypes.swift | 4 + apps/ios/SimpleXChat/ChatTypes.swift | 8 + .../chat/simplex/common/model/SimpleXAPI.kt | 4 + .../simplex/common/views/badges/BadgeStore.kt | 2 +- .../moko-resources/base/strings.xml | 1 + apps/simplex-badge-service/README.md | 43 +- .../badge_service.ini.example | 21 +- .../src/BadgeService/Config.hs | 48 +- .../src/BadgeService/Service.hs | 84 ++- .../src/BadgeService/StoreReceipts.hs | 63 +- .../src/BadgeService/StoreReceipts/Apple.hs | 181 ++++++ .../src/BadgeService/StoreReceipts/Google.hs | 233 ++++++++ .../src/BadgeService/StoreReceipts/Mock.hs | 12 +- bots/api/TYPES.md | 1 + docs/protocol/badges-rpc.md | 29 +- .../types/typescript/src/types.ts | 1 + .../src/simplex_chat/types/_types.py | 2 +- .../badge-service/badge_service.ini.example | 19 +- scripts/badge-service/compose.yml | 2 + simplex-chat.cabal | 13 + src/Simplex/Chat/Badges/Types.hs | 3 + src/Simplex/Chat/Library/Commands.hs | 1 + tests/BadgeTests.hs | 4 +- tests/Bots/BadgeService/BotTests.hs | 71 ++- tests/Bots/BadgeService/ConfigTests.hs | 50 ++ tests/Bots/BadgeService/FakePlay.hs | 181 ++++++ tests/Bots/BadgeService/FakeStore.hs | 4 +- tests/Bots/BadgeService/StoreVerifierTests.hs | 560 ++++++++++++++++++ tests/Bots/BadgeService/WebTests.hs | 2 + tests/Test.hs | 2 + 31 files changed, 1574 insertions(+), 79 deletions(-) create mode 100644 apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs create mode 100644 apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs create mode 100644 tests/Bots/BadgeService/FakePlay.hs create mode 100644 tests/Bots/BadgeService/StoreVerifierTests.hs diff --git a/apps/ios/Shared/Views/Badges/BadgeStore.swift b/apps/ios/Shared/Views/Badges/BadgeStore.swift index 2b265b01ab..87485ec06d 100644 --- a/apps/ios/Shared/Views/Badges/BadgeStore.swift +++ b/apps/ios/Shared/Views/Badges/BadgeStore.swift @@ -272,7 +272,7 @@ final class BadgeStore: ObservableObject { func storePurchaseRefused(_ user: UserRef, _ invoiceId: String, _ refusal: BadgeIssueFailure) async { await MainActor.run { if active(user) && openStorePurchases(user.userId).contains(where: { $0.invoiceId == invoiceId }) { - showAlert(NSLocalizedString("Purchase error", comment: "alert title"), message: refusal.purchaseText) + showAlert(refusal.purchaseAlertTitle, message: refusal.purchaseText) } } await storePurchaseResolved(user, invoiceId) @@ -379,7 +379,7 @@ private func storeReceipt(_ verification: VerificationResult) -> Ba // a sweep that hands over a receipt refused while the app was not running learns it only from this answer private func badgeReceiptRefused(_ error: Error) -> Bool { if case let .error(.badgeRedeemError(.serviceError(code))) = error as? ChatError { - return code == .receiptInvalid || code == .receiptUsed + return code == .receiptInvalid || code == .receiptUsed || code == .testPurchase } return false } diff --git a/apps/ios/SimpleXChat/APITypes.swift b/apps/ios/SimpleXChat/APITypes.swift index 9b38dae9a9..6f5f62daf3 100644 --- a/apps/ios/SimpleXChat/APITypes.swift +++ b/apps/ios/SimpleXChat/APITypes.swift @@ -855,6 +855,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case codeExpired case receiptInvalid case receiptUsed + case testPurchase case internalError case unknown(String) @@ -876,6 +877,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case .codeUsed: "code_used" case .codeExpired: "code_expired" case .receiptInvalid: "receipt_invalid" + case .testPurchase: "test_purchase" case .receiptUsed: "receipt_used" case .internalError: "internal" case let .unknown(s): s @@ -900,6 +902,7 @@ public enum BadgeServiceErrorCode: Decodable, Hashable { case "code_used": self = .codeUsed case "code_expired": self = .codeExpired case "receipt_invalid": self = .receiptInvalid + case "test_purchase": self = .testPurchase case "receipt_used": self = .receiptUsed case "internal": self = .internalError case let s: self = .unknown(s) @@ -917,6 +920,7 @@ public func badgeServiceErrorText(_ code: BadgeServiceErrorCode) -> String? { case .unknownPurchaseKey: NSLocalizedString("The badge service does not recognize this badge.", comment: "alert message") case .internalError: NSLocalizedString("The badge service reported an internal error.", comment: "alert message") case .receiptInvalid: NSLocalizedString("The store did not confirm this purchase.", comment: "alert message") + case .testPurchase: NSLocalizedString("Sandbox purchases are not credited. Badges can only be bought in the App Store version of the app.", comment: "alert message") case .receiptUsed: NSLocalizedString("This purchase was already credited to a badge on another device or profile.", comment: "alert message") case .paymentPending: NSLocalizedString("The payment has not been confirmed yet.", comment: "alert message") case .providerUnavailable: NSLocalizedString("The store could not be reached.", comment: "alert message") diff --git a/apps/ios/SimpleXChat/ChatTypes.swift b/apps/ios/SimpleXChat/ChatTypes.swift index 252ffad974..bf4440a810 100644 --- a/apps/ios/SimpleXChat/ChatTypes.swift +++ b/apps/ios/SimpleXChat/ChatTypes.swift @@ -379,6 +379,14 @@ public enum BadgeIssueFailure: Decodable, Hashable { } } + public var purchaseAlertTitle: String { + switch self { + case .serviceError(.testPurchase, _): + NSLocalizedString("Sandbox purchase", comment: "alert title") + default: NSLocalizedString("Purchase error", comment: "alert title") + } + } + // the stored form, for support public var tag: String { switch self { diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt index d6f605dc8b..7c4acafe0b 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt @@ -7475,6 +7475,7 @@ sealed class BadgeServiceErrorCode { object CodeExpired: BadgeServiceErrorCode() object ReceiptInvalid: BadgeServiceErrorCode() object ReceiptUsed: BadgeServiceErrorCode() + object TestPurchase: BadgeServiceErrorCode() object Internal: BadgeServiceErrorCode() data class Unknown(val code: String): BadgeServiceErrorCode() @@ -7497,6 +7498,7 @@ sealed class BadgeServiceErrorCode { is CodeExpired -> "code_expired" is ReceiptInvalid -> "receipt_invalid" is ReceiptUsed -> "receipt_used" + is TestPurchase -> "test_purchase" is Internal -> "internal" is Unknown -> code } @@ -7511,6 +7513,7 @@ fun badgeServiceErrorText(code: BadgeServiceErrorCode): String? = when (code) { is BadgeServiceErrorCode.UnknownPurchaseKey -> generalGetString(MR.strings.badges_error_unknown_purchase) is BadgeServiceErrorCode.Internal -> generalGetString(MR.strings.badges_error_service_internal) is BadgeServiceErrorCode.ReceiptInvalid -> generalGetString(MR.strings.badges_error_receipt_invalid) + is BadgeServiceErrorCode.TestPurchase -> generalGetString(MR.strings.badges_error_test_purchase) is BadgeServiceErrorCode.ReceiptUsed -> generalGetString(MR.strings.badges_error_receipt_used) is BadgeServiceErrorCode.PaymentPending -> generalGetString(MR.strings.badges_error_payment_pending) is BadgeServiceErrorCode.ProviderUnavailable -> generalGetString(MR.strings.badges_error_provider_unavailable) @@ -7540,6 +7543,7 @@ object BadgeServiceErrorCodeSerializer : KSerializer { "code_expired" -> BadgeServiceErrorCode.CodeExpired "receipt_invalid" -> BadgeServiceErrorCode.ReceiptInvalid "receipt_used" -> BadgeServiceErrorCode.ReceiptUsed + "test_purchase" -> BadgeServiceErrorCode.TestPurchase "internal" -> BadgeServiceErrorCode.Internal else -> BadgeServiceErrorCode.Unknown(v) } diff --git a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt index c9b413221d..4b37c6c7ba 100644 --- a/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt +++ b/apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/badges/BadgeStore.kt @@ -443,5 +443,5 @@ private fun compactPrice(product: BadgeProduct): String { private fun badgeReceiptRefused(err: ChatError?): Boolean { val redeemError = ((err as? ChatError.ChatErrorChat)?.errorType as? ChatErrorType.CEBadgeRedeemError)?.badgeRedeemError val code = (redeemError as? BadgeRedeemError.ServiceError)?.serviceError - return code is BadgeServiceErrorCode.ReceiptInvalid || code is BadgeServiceErrorCode.ReceiptUsed + return code is BadgeServiceErrorCode.ReceiptInvalid || code is BadgeServiceErrorCode.ReceiptUsed || code is BadgeServiceErrorCode.TestPurchase } diff --git a/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml b/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml index f7fc6e94b5..5b0227b3a4 100644 --- a/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml +++ b/apps/multiplatform/common/src/commonMain/moko-resources/base/strings.xml @@ -3230,6 +3230,7 @@ The badge service reported an internal error. The store did not confirm this purchase. This purchase was already credited to a badge on another device or profile. + Test purchases are not credited. Badges can only be bought with a real purchase. The payment has not been confirmed yet. The store could not be reached. Badges cannot be bought in the app yet. diff --git a/apps/simplex-badge-service/README.md b/apps/simplex-badge-service/README.md index 6de3e53d2f..5340314da5 100644 --- a/apps/simplex-badge-service/README.md +++ b/apps/simplex-badge-service/README.md @@ -51,7 +51,7 @@ simplex-badge-service --help `simplex-directory-service --run-cli`). This mode is the chat/RPC side and the `//` commands below: it starts no web listener and no poller, and serves no group commands, whatever `--service-config` says. It still updates a code's group message when the code is redeemed or - revoked. `[dev] accept_unverified_store_receipts` applies to it. + revoked. `[apple]`, `[google]` and `[dev] accept_unverified_store_receipts` apply to it. - `--no-address`: skip address creation on start-up (for operators who provision the address themselves). The service cannot sign credentials without an issuer key and refuses to start without one: @@ -84,7 +84,7 @@ Other options: - `--service-config INI_FILE`: path to `badge_service.ini`. Omit it to run the chat/RPC side only; the process never starts a web listener without it, and never starts one under `--run-cli`, which parses and validates the whole file (`[listener] static_dir` included) but - uses only its `[issuer]` section and `[dev] accept_unverified_store_receipts`. An issuer key is + uses only its `[issuer]`, `[apple]` and `[google]` sections and `[dev] accept_unverified_store_receipts`. An issuer key is still required either way. - `--service-name NAME`: the bot's display name, without `*`s or spaces (default `SimpleX Badges`). - `--client-service`: use the client service certificate. @@ -209,6 +209,43 @@ the exception: each answers 200, 400 or 413 with an empty body, because its prov caller and nothing it could read would change what the route does. A wrong verb on any route, those two included, answers `method_not_allowed`. +### Store purchases (App Store and Google Play) + +Each store is verified only when its section is present; without one, every receipt from that store +is answered `provider_not_configured` and the app keeps the purchase to present again. A section +missing a key, an unreadable root certificate or service account key, or either section beside +`[dev] accept_unverified_store_receipts = on`, stops the service at startup. + +```ini +[apple] +bundle_id = chat.simplex.app +root_certificate = /etc/simplex-badge-service/AppleRootCA-G3.cer + +[google] +package_name = chat.simplex.app +service_account_file = /etc/simplex-badge-service/play-service-account.json +``` + +- `[apple]` verifies the signed transaction offline, against Apple Root CA - G3 in DER as Apple + publishes it at . A transaction + for another bundle id, or a chain this root does not verify, is answered `internal` and logged as + an error rather than refused, since `bundle_id` or `root_certificate` may be the wrong one; check + both when those errors appear, unless the purchase was made in Xcode's StoreKit testing, which + the App Store does not sign, so no root verifies it. +- `[google]` asks the Google Play Developer API about each purchase, and acknowledges it before + crediting it, as the service account whose JSON key `service_account_file` holds. The account + needs both Play Console permissions Google's + [getting started](https://developers.google.com/android-publisher/getting_started) lists for its + billing APIs: "View financial data, orders, and cancellation survey responses" to read a + purchase, and "Manage orders and subscriptions" to acknowledge it. Without the second, a Play + purchase the app has not already acknowledged itself is answered `internal` and logged as an + error naming the acknowledgement, and the app presents it again once the permission is granted, + which must be within three days, before Play refunds it. The key signs in + for an access token, so keep the file readable by this service alone. + +Which answers are terminal for a purchase and which leave it to be presented again is listed per +store in [`docs/protocol/badges-rpc.md`](../../docs/protocol/badges-rpc.md#commands). + ### Accepting store receipts unverified, for local testing ```ini @@ -221,7 +258,7 @@ the service accepts any well-formed receipt without asking or verifying anything the `transactionId` and `productId` its payload names, unsigned or not, and a Play product id and token as given. It applies to both run modes, since `--run-cli` answers service requests too, and the service logs a warning at every start while it is on. Off by default, and only `on`/`off` -parse. +parse. The service refuses to start with it on beside an `[apple]` or `[google]` section. With it on, anyone who can reach the service address can mint badges by sending a made-up receipt. That is harmless only while this deployment signs with an issuer key released apps do not carry, so diff --git a/apps/simplex-badge-service/badge_service.ini.example b/apps/simplex-badge-service/badge_service.ini.example index e9ca861806..20d4e8614b 100644 --- a/apps/simplex-badge-service/badge_service.ini.example +++ b/apps/simplex-badge-service/badge_service.ini.example @@ -40,6 +40,24 @@ session_minutes = 60 waiting_seconds = 3 idle_seconds = 60 +; verifies App Store purchases offline. Omit the whole section and the service answers every App Store +; receipt provider_not_configured, which the app retries later. +; root_certificate is Apple Root CA - G3 as Apple publishes it, in DER: +; https://www.apple.com/certificateauthority/AppleRootCA-G3.cer +;[apple] +;bundle_id = chat.simplex.app +;root_certificate = /etc/simplex-badge-service/AppleRootCA-G3.cer + +; verifies Play purchases with the Google Play Developer API. Omit the whole section and the service answers +; every Play receipt provider_not_configured, which the app retries later. +; service_account_file is the JSON key Google issues for a service account with the Play Console +; permissions "View financial data, orders, and cancellation survey responses" and "Manage orders and +; subscriptions", to read and acknowledge purchases. Without the second, a purchase the app has not +; already acknowledged itself is answered internal until the permission is granted. Keep the file readable by this service alone. +;[google] +;package_name = chat.simplex.app +;service_account_file = /etc/simplex-badge-service/play-service-account.json + ; the key this service signs credentials with. index is the index clients verify against, so ; private_key has to be one whose public half already ships in the apps at that index: a fresh ; `simplex-chat badge keygen` pair is refused until it does. @@ -62,6 +80,7 @@ idle_seconds = 60 ;description = Welcome to the badges group ; local testing only, in both run modes: accepts any well-formed App Store or Play receipt without -; verifying it, so anyone who can reach this service can mint badges +; verifying it, so anyone who can reach this service can mint badges. The service refuses to start +; with this on beside an [apple] or [google] section. [dev] accept_unverified_store_receipts = off diff --git a/apps/simplex-badge-service/src/BadgeService/Config.hs b/apps/simplex-badge-service/src/BadgeService/Config.hs index 8b24956a57..493c95c27e 100644 --- a/apps/simplex-badge-service/src/BadgeService/Config.hs +++ b/apps/simplex-badge-service/src/BadgeService/Config.hs @@ -10,6 +10,8 @@ module BadgeService.Config SpeedPolicy (..), speedPolicyName, PollConfig (..), + AppleStoreConfig (..), + PlayStoreConfig (..), BadgeIssuerKey (..), GroupConfig (..), ServiceConfig (..), @@ -22,11 +24,11 @@ where import qualified Control.Exception as E import BadgeService.Log (logWarn) -import Control.Monad (mfilter) +import Control.Monad (mfilter, when) import Data.Attoparsec.Text (Parser, endOfInput, isEndOfLine, parseOnly, satisfy, skipMany, skipSpace, skipWhile) import qualified Data.ByteString.Char8 as B import Data.Ini (Ini, iniGlobals, iniParser, keys, lookupValue, sections) -import Data.Maybe (fromMaybe) +import Data.Maybe (fromMaybe, isJust) import Data.Text (Text) import qualified Data.Text as T import qualified Data.Text.IO as TIO @@ -91,6 +93,20 @@ instance Show StripeConfig where data PollConfig = PollConfig {pWaitingSeconds :: Int, pIdleSeconds :: Int} deriving (Eq, Show) +data AppleStoreConfig = AppleStoreConfig + { aBundleId :: Text, + aRootCertificate :: FilePath + } + deriving (Eq, Show) + +data PlayStoreConfig = PlayStoreConfig + { gPackageName :: Text, + gServiceAccountFile :: FilePath, + gApiHost :: Text, + gTokenUrl :: Text + } + deriving (Eq, Show) + data BadgeIssuerKey = BadgeIssuerKey { keyIdx :: Int, secretKey :: BBSSecretKey @@ -112,6 +128,8 @@ data ServiceConfig = ServiceConfig btcpay :: Maybe BTCPayConfig, stripe :: Maybe StripeConfig, poll :: PollConfig, + appleStore :: Maybe AppleStoreConfig, + playStore :: Maybe PlayStoreConfig, issuer :: Maybe BadgeIssuerKey, group :: Maybe GroupConfig, -- Local testing only; anyone who can reach the service can mint badges with any well-formed receipt. @@ -128,6 +146,12 @@ defaultStripeHost = "https://api.stripe.com" defaultSessionMinutes :: Int defaultSessionMinutes = 60 +defaultPlayApiHost :: Text +defaultPlayApiHost = "https://androidpublisher.googleapis.com" + +defaultPlayTokenUrl :: Text +defaultPlayTokenUrl = "https://oauth2.googleapis.com/token" + -- | At most one day, so a card order expires long before the poller stops checking it at 72 hours. minSessionMinutes, maxSessionMinutes :: Int minSessionMinutes = 1 @@ -166,6 +190,8 @@ knownSettings = ("btcpay", ["host", "api_key", "store_id", "webhook_secret", "expiry_minutes", "speed_policy", "payment_tolerance"]), ("stripe", ["secret_key", "publishable_key", "webhook_secret", "session_minutes"]), ("poll", ["waiting_seconds", "idle_seconds"]), + ("apple", ["bundle_id", "root_certificate"]), + ("google", ["package_name", "service_account_file"]), ("group", ["display_name", "description"]), ("dev", ["accept_unverified_store_receipts"]), ("issuer", ["index", "private_key"]) @@ -199,13 +225,19 @@ parseConfig ini = do grp <- groupSection pWaitingSeconds <- cadence "waiting_seconds" 3 pIdleSeconds <- cadence "idle_seconds" 60 + apple <- appleSection + google <- googleSection devUnverifiedReceipts <- bool "dev" "accept_unverified_store_receipts" False + when (devUnverifiedReceipts && (isJust apple || isJust google)) $ + Left "[dev] accept_unverified_store_receipts must be off where [apple] or [google] verifies store receipts" pure ServiceConfig { listener = ListenerConfig {lHost, lPort, lStaticDir, lServeWebapp, lWebappExportDir, lTrustForwardedFor}, btcpay = btc, stripe = str, poll = PollConfig {pWaitingSeconds, pIdleSeconds}, + appleStore = apple, + playStore = google, issuer = iss, group = grp, devAcceptUnverifiedStoreReceipts = devUnverifiedReceipts @@ -300,6 +332,18 @@ parseConfig ini = do sSessionMinutes <- sessionMinutes let sHost = defaultStripeHost pure (Just StripeConfig {sSecretKey, sPublishableKey, sWebhookSecret, sSessionMinutes, sHost}) + appleSection + | not (hasSection "apple") = Right Nothing + | otherwise = do + aBundleId <- required "apple" "bundle_id" + aRootCertificate <- T.unpack <$> required "apple" "root_certificate" + pure (Just AppleStoreConfig {aBundleId, aRootCertificate}) + googleSection + | not (hasSection "google") = Right Nothing + | otherwise = do + gPackageName <- required "google" "package_name" + gServiceAccountFile <- T.unpack <$> required "google" "service_account_file" + pure (Just PlayStoreConfig {gPackageName, gServiceAccountFile, gApiHost = defaultPlayApiHost, gTokenUrl = defaultPlayTokenUrl}) sessionMinutes = do v <- num "stripe" "session_minutes" defaultSessionMinutes if v >= minSessionMinutes && v <= maxSessionMinutes diff --git a/apps/simplex-badge-service/src/BadgeService/Service.hs b/apps/simplex-badge-service/src/BadgeService/Service.hs index 8eafc16f2e..92eeeb195b 100644 --- a/apps/simplex-badge-service/src/BadgeService/Service.hs +++ b/apps/simplex-badge-service/src/BadgeService/Service.hs @@ -7,6 +7,7 @@ module BadgeService.Service ( ServiceState (..), newServiceState, + configureStoreVerifier, welcomeGetOpts, checkIssuerKey, badgeService, @@ -22,7 +23,7 @@ where import BadgeService.Catalog (StoreProduct (..), defaultCatalog, storeProduct) import BadgeService.Codes (issueFailedText, issueOneCode, singleUse) -import BadgeService.Config (BadgeIssuerKey (..), ServiceConfig (..), readServiceConfig) +import BadgeService.Config (AppleStoreConfig (..), BadgeIssuerKey (..), PlayStoreConfig (..), ServiceConfig (..), readServiceConfig) import BadgeService.Group (GroupEvent, ensureManagedGroup, groupEvent, hasTracker, refreshTracker, revokeWithTracker, runGroupLane) import BadgeService.Group.Command (badgeTypeP, codeP, maxMonths, textTokenP) import BadgeService.Log (logError, logInfo, logWarn) @@ -34,6 +35,8 @@ import BadgeService.Store import BadgeService.Store.Invoices (seedCatalog, truncateToSecond) import BadgeService.Store.Migrate (runBadgeServiceMigrations) import BadgeService.StoreReceipts +import BadgeService.StoreReceipts.Apple (readAppleRoot, verifyAppleTransaction) +import BadgeService.StoreReceipts.Google (playStoreVerifier) import BadgeService.StoreReceipts.Mock (mockStoreVerifier) import BadgeService.Waiters (Waiters, newWaiters) import BadgeService.Web.Server (exportWebapp, newWebEnv, runWebListener) @@ -84,8 +87,8 @@ data ServiceState = ServiceState storeVerifier :: StoreVerifier } --- | No store verifier exists yet, so every store receipt not already credited is answered --- provider_not_configured, terminal for the request: retrying cannot deploy one. +-- | With no store verifier, which badge_service.ini configures, every store receipt not already credited +-- is answered provider_not_configured. newServiceState :: IO ServiceState newServiceState = do serviceCC <- newEmptyTMVarIO @@ -130,19 +133,37 @@ readConfigOrExit path = Left e -> putStrLn (path <> ": " <> e) >> exitFailure Right sc -> pure sc -devStoreVerifier :: Maybe ServiceConfig -> ServiceState -> IO ServiceState -devStoreVerifier serviceCfg env - | maybe False devAcceptUnverifiedStoreReceipts serviceCfg = do - logWarn "[dev] accept_unverified_store_receipts is on: any store receipt is accepted without verification" - pure env {storeVerifier = mockStoreVerifier} - | otherwise = pure env +-- | The config refuses the dev flag beside a real verifier, so only one of them applies. +configureStoreVerifier :: Maybe ServiceConfig -> ServiceState -> IO ServiceState +configureStoreVerifier serviceCfg env@ServiceState {storeVerifier = v} = case serviceCfg of + Just ServiceConfig {devAcceptUnverifiedStoreReceipts = True} -> do + logWarn "[dev] accept_unverified_store_receipts is on: any store receipt is accepted without verification" + pure env {storeVerifier = mockStoreVerifier} + Just ServiceConfig {appleStore, playStore} -> do + apple <- forM appleStore $ \AppleStoreConfig {aBundleId, aRootCertificate} -> + (\root -> verifyAppleTransaction root aBundleId) <$> orExit (readAppleRoot aRootCertificate) + google <- forM playStore $ orExit . playStoreVerifier + forM_ appleStore $ \AppleStoreConfig {aBundleId} -> logInfo $ "verifying App Store receipts for " <> aBundleId + forM_ playStore $ \PlayStoreConfig {gPackageName} -> logInfo $ "verifying Play purchases for " <> gPackageName + pure + env + { storeVerifier = + v + { verifyApple = maybe (verifyApple v) Just apple, + verifyGoogle = maybe (verifyGoogle v) (Just . fst) google, + acknowledgeGoogle = maybe (acknowledgeGoogle v) (Just . snd) google + } + } + Nothing -> pure env + where + orExit = (>>= either (\e -> putStrLn ("Error: " <> e) >> exitFailure) pure) badgeService :: BadgeServiceOpts -> ChatConfig -> ServiceState -> IO () badgeService opts@BadgeServiceOpts {serviceConfigFile} cfg env = do serviceCfg <- traverse readConfigOrExit serviceConfigFile key <- requireIssuerKey opts serviceCfg cfg waiters <- newWaiters - requestEnv <- devStoreVerifier serviceCfg env + requestEnv <- configureStoreVerifier serviceCfg env let groupCfg = serviceCfg >>= \ServiceConfig {group} -> group trackerQ_ = groupEventQ env <$ groupCfg readEvents cc = @@ -193,7 +214,7 @@ badgeServiceCLI :: BadgeServiceOpts -> IO () badgeServiceCLI opts@BadgeServiceOpts {serviceConfigFile} = do serviceCfg <- traverse readConfigOrExit serviceConfigFile key <- requireIssuerKey opts serviceCfg terminalChatConfig - env <- newServiceState >>= devStoreVerifier serviceCfg + env <- newServiceState >>= configureStoreVerifier serviceCfg let eventHook _cc = \case Right (CEvtServiceRequest u reqId sigKey reqData) -> do atomically $ writeTQueue (serviceRequestQ env) (u, reqId, sigKey, reqData) @@ -416,7 +437,7 @@ redeemCode key cc trackerQ_ purchaseKey masterKey codeText = case parseBadgeCode -- | Every refusal is answered before anything is written, so it leaves the receipt unclaimed; and -- nothing is written until the credential is signed. purchaseWithReceipt :: BadgeIssuerKey -> ChatController -> C.PublicKeyEd25519 -> BadgeMasterKey -> StoreReceipt -> IO BadgeServiceResponse -purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTransactionRef {provider, transactionRef = providerRef}, verifyReceipt} = +purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTransactionRef {provider, transactionRef = providerRef}, verifyReceipt, acknowledgeReceipt} = withDB' "getStorePayment" cc (\db -> getStorePaymentCredit db provider providerRef) >>= \case Left _ -> pure $ errorResponse BSEInternal Right credit @@ -430,7 +451,7 @@ purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTran | transactionRef /= providerRef -> storeRefusalResponse $ SRVerifierFailed "verified a transaction other than the one claimed" Right VerifiedStoreTransaction {quantity} | quantity /= 1 -> storeRefusalResponse $ SRVerifierFailed $ "verified a quantity of " <> tshow quantity - Right VerifiedStoreTransaction {testPurchase = True} -> storeRefusalResponse $ SRInvalid "test purchase" + Right VerifiedStoreTransaction {testPurchase = True} -> storeRefusalResponse SRTestPurchase -- another key's credit is told only once the store vouched for the receipt, or it would reveal which transactions were credited Right tx -> case credit of Uncredited -> newPurchase tx @@ -446,26 +467,31 @@ purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTran -- the product is read only for a receipt not yet credited, so retiring it leaves its replays answered newPurchase VerifiedStoreTransaction {productId, paid} = case storeProduct provider productId of Nothing -> pure $ errorResponse BSEProductUnavailable - Just StoreProduct {badgeType, months} -> do - now <- badgeNow cc - signFirstMonth key cc masterKey badgeType months (SCPayment Nothing) now >>= \case - Left resp -> pure resp - Right firstMonth -> do - paymentId <- randomId cc - r <- withDB "writeStorePurchase" cc $ \db -> - liftIO (createStorePurchase db NewStorePurchase {paymentId, provider, providerRef, paid, purchaseKey, masterKey, badgeType} now) >>= \case - -- Credited to another key, or to this one by a request that ran alongside it, while signing. - Nothing -> - liftIO (getStorePaymentCredit db provider providerRef >>= creditedResponse db purchaseKey) >>= \case - Left resp -> pure resp - Right () -> logError ("badge service: a payment for " <> providerRef <> " exists but funds no purchase") $> errorResponse BSEInternal - Just purchaseId -> liftIO $ firstMonthResponse db purchaseId (Just paymentId) firstMonth - pure $ fromRight (errorResponse BSEInternal) r + Just StoreProduct {badgeType, months} -> + fromMaybe (pure $ Right ()) acknowledgeReceipt >>= \case + Left refusal -> storeRefusalResponse refusal + Right () -> do + now <- badgeNow cc + signFirstMonth key cc masterKey badgeType months (SCPayment Nothing) now >>= \case + Left resp -> pure resp + Right firstMonth -> do + paymentId <- randomId cc + r <- withDB "writeStorePurchase" cc $ \db -> + liftIO (createStorePurchase db NewStorePurchase {paymentId, provider, providerRef, paid, purchaseKey, masterKey, badgeType} now) >>= \case + -- Credited to another key, or to this one by a request that ran alongside it, while signing. + Nothing -> + liftIO (getStorePaymentCredit db provider providerRef >>= creditedResponse db purchaseKey) >>= \case + Left resp -> pure resp + Right () -> logError ("badge service: a payment for " <> providerRef <> " exists but funds no purchase") $> errorResponse BSEInternal + Just purchaseId -> liftIO $ firstMonthResponse db purchaseId (Just paymentId) firstMonth + pure $ fromRight (errorResponse BSEInternal) r --- | The client learns only the code: a forged receipt, a refunded purchase and a test one are all receipt_invalid. +-- | A forged receipt and a refunded one are both receipt_invalid, so the client learns nothing a +-- forger could iterate on. A test purchase is named, since the device that made it already knows. storeRefusalResponse :: StoreRefusal -> IO BadgeServiceResponse storeRefusalResponse = \case SRInvalid reason -> logInfo ("store receipt refused: " <> reason) $> errorResponse BSEReceiptInvalid + SRTestPurchase -> logInfo "store receipt refused: test purchase" $> errorResponse BSETestPurchase SRPending -> pure $ errorResponse BSEPaymentPending SRUnreachable reason -> logWarn ("store unreachable: " <> reason) $> errorResponse BSEProviderUnavailable SRVerifierFailed reason -> logError ("store receipt not verified: " <> reason) $> errorResponse BSEInternal diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs index b623944c46..952a4d0152 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs @@ -14,14 +14,13 @@ module BadgeService.StoreReceipts where import Control.Exception (evaluate) -import Data.Bifunctor (first) -import Data.Char (isAsciiLower, isAsciiUpper, isDigit) +import Data.Char (isAlphaNum, isAscii, isAsciiLower, isAsciiUpper, isControl, isDigit, isPrint, isSpace) import Data.Maybe (fromMaybe) import Data.Text (Text) import qualified Data.Text as T import Simplex.Chat.PaymentService (ServicePayment (..), appleTransactionId, googlePurchaseRef) import Simplex.Chat.PaymentService.Types (CurrencyAmount, PaymentProvider (..), StoreTransactionRef (..)) -import Simplex.Messaging.Util (catchOwn') +import Simplex.Messaging.Util (catchOwn', tshow) import System.Timeout (timeout) -- | What a store vouches for about one completed transaction. @@ -38,19 +37,24 @@ data VerifiedStoreTransaction = VerifiedStoreTransaction deriving (Eq, Show) -- | The reasons are for the service's log alone and must never quote the receipt. +-- SRInvalid and SRTestPurchase are terminal: the client drops the purchase's keys and nothing +-- presents it again. So only a verdict no later attempt could change is either; when in doubt, SRUnreachable. data StoreRefusal - = SRInvalid Text -- a verdict that cannot change, and the client consumes the purchase: forged, malformed, another app's, refunded + = SRInvalid Text -- a verdict that cannot change, and the client consumes the purchase: forged, malformed, refunded + | SRTestPurchase -- the store vouched for it, but it cost nothing; terminal, and named so the app can say why | SRPending -- a real purchase the store has not settled; it may yet | SRUnreachable Text -- no verdict: the store was not asked, did not answer, or does not know the token (a Play 404 may be lag) - | SRVerifierFailed Text -- a bug, not the store's answer + | SRVerifierFailed Text -- this service's own failure, its bug or misconfiguration, never the store's answer | SRNotConfigured -- no verifier for this store is deployed; the purchase may be real deriving (Eq, Show) -- | Apple signs its receipt and ships the certificate chain in it, so it is verified with no network --- call; a Play token is opaque and must be asked about, which is why only that field is in IO. +-- call; a Play token is opaque and must be asked about, which is why only the Play fields are in IO. data StoreVerifier = StoreVerifier - { verifyApple :: Maybe (Text -> Either Text VerifiedStoreTransaction), -- the JWS; Left is why Apple did not sign it + { -- the JWS + verifyApple :: Maybe (Text -> Either StoreRefusal VerifiedStoreTransaction), verifyGoogle :: Maybe (Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction)), -- the product id and the token + acknowledgeGoogle :: Maybe (Text -> Text -> IO (Either StoreRefusal ())), -- microseconds; requests are answered one at a time, so a verifier that does not finish holds up every other one verifyTimeout :: Int } @@ -58,37 +62,43 @@ data StoreVerifier = StoreVerifier -- | A store payment, named by the store's own reference before anything is verified. data StoreReceipt = StoreReceipt { txRef :: StoreTransactionRef, - verifyReceipt :: IO (Either StoreRefusal VerifiedStoreTransaction) + verifyReceipt :: IO (Either StoreRefusal VerifiedStoreTransaction), + acknowledgeReceipt :: Maybe (IO (Either StoreRefusal ())) } noStoreVerifier :: StoreVerifier -noStoreVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Nothing, verifyTimeout = 10000000} +noStoreVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Nothing, acknowledgeGoogle = Nothing, verifyTimeout = 10000000} -- | Nothing for a payment no store made. Exceptions are not logged, since they can quote the receipt -- or, from Google, a URL holding the token. toStoreReceipt :: StoreVerifier -> ServicePayment -> Maybe (Either StoreRefusal StoreReceipt) -toStoreReceipt StoreVerifier {verifyApple, verifyGoogle, verifyTimeout} = \case +toStoreReceipt StoreVerifier {verifyApple, verifyGoogle, acknowledgeGoogle, verifyTimeout} = \case SPApple {jws} -> Just $ case appleTransactionId jws of Nothing -> Left $ SRInvalid "names no transaction" - Just ref -> Right $ StoreReceipt (StoreTransactionRef PPApple ref) $ maybe unconfigured (\verify -> offline $ first SRInvalid $ verify jws) verifyApple + Just ref -> Right $ StoreReceipt (StoreTransactionRef PPApple ref) (maybe unconfigured (\verify -> offline $ verify jws) verifyApple) Nothing SPGoogle {productId, token} -- the claim is the token's hash, so neither string may name any purchase but the one it claims, -- whatever path a verifier builds from them | not (googleProductId productId) -> Just $ Left $ SRInvalid "not a Play product id" -- Play documents no token grammar, so this is our guess, and refusing to ask Play is not its verdict - | not (googleToken token) -> Just $ Left $ SRUnreachable "a Play token this service will not send" - | otherwise -> Just $ Right $ StoreReceipt (StoreTransactionRef PPGoogle (googlePurchaseRef token)) $ maybe unconfigured (\verify -> online $ verify productId token) verifyGoogle + | not (googleToken token) -> Just $ Left $ SRUnreachable $ "a Play token this service will not send: " <> tokenShape token + | otherwise -> + Just $ Right $ + StoreReceipt + (StoreTransactionRef PPGoogle (googlePurchaseRef token)) + (maybe unconfigured (\verify -> online "google verifier" $ verify productId token) verifyGoogle) + ((\acknowledge -> online "acknowledging: google" $ acknowledge productId token) <$> acknowledgeGoogle) SPInvoice {} -> Nothing SPReceipt {} -> Nothing where unconfigured = pure $ Left SRNotConfigured - -- nothing was fetched, so a throw or an overrun is a bug or a malformed receipt, never an outage + -- nothing was fetched, so a throw or an overrun is this service's failure or a shape it does not know, never an outage offline verdict = (fromMaybe (Left $ SRVerifierFailed "apple verifier timed out") <$> timeout verifyTimeout (forced verdict)) `catchOwn'` \_ -> pure $ Left $ SRVerifierFailed "apple verifier threw" - online verify = - (fromMaybe (Left $ SRUnreachable "google verifier timed out") <$> timeout verifyTimeout (verify >>= forced)) - `catchOwn'` \_ -> pure $ Left $ SRUnreachable "google verifier threw" + online what call = + (fromMaybe (Left $ SRUnreachable $ what <> " timed out") <$> timeout verifyTimeout (call >>= forced)) + `catchOwn'` \_ -> pure $ Left $ SRUnreachable $ what <> " threw" -- a verdict holding a thunk that throws would otherwise throw later, outside these handlers forced = either (fmap Left . evaluate) (fmap Right . evaluate) @@ -97,5 +107,22 @@ googleProductId pid = case T.uncons pid of Just (c, _) -> T.length pid <= 150 && (isAsciiLower c || isDigit c) && T.all (\x -> isAsciiLower x || isDigit x || x == '_' || x == '.') pid Nothing -> False +-- | Not empty or only dots, which a URL path resolves away. googleToken :: Text -> Bool -googleToken t = not (T.null t) && T.length t <= 4096 && T.all (\x -> isAsciiLower x || isAsciiUpper x || isDigit x || x == '.' || x == '_' || x == '-') t +googleToken t = not (T.all (== '.') t) && T.length t <= 4096 && T.all (\x -> isAsciiLower x || isAsciiUpper x || isDigit x || x == '.' || x == '_' || x == '-') t + +-- | What the log may say about a token: its length and the kinds of character in it, never any of them. +tokenShape :: Text -> Text +tokenShape t = tshow (T.length t) <> " characters: " <> T.intercalate ", " [kind | (kind, isKind) <- kinds, T.any isKind t] + where + kinds = + [ ("lowercase", isAsciiLower), + ("uppercase", isAsciiUpper), + ("digits", isDigit), + ("'.'", (== '.')), + ("'_'", (== '_')), + ("'-'", (== '-')), + ("other printable ASCII", \c -> isAscii c && isPrint c && not (isAlphaNum c) && c `notElem` ("._-" :: String)), + ("whitespace or control", \c -> isSpace c || isControl c), + ("non-ASCII", not . isAscii) + ] diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs new file mode 100644 index 0000000000..90cc69915c --- /dev/null +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs @@ -0,0 +1,181 @@ +{-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} + +module BadgeService.StoreReceipts.Apple + ( verifyAppleTransaction, + readAppleRoot, + ) +where + +import BadgeService.StoreReceipts (StoreRefusal (..), VerifiedStoreTransaction (..)) +import Control.Exception (IOException, try) +import Control.Monad (guard, unless) +import Crypto.Hash.Algorithms (SHA256 (..)) +import Crypto.Number.Serialize (os2ip) +import qualified Crypto.PubKey.ECC.ECDSA as ECDSA +import qualified Crypto.PubKey.ECC.Types as ECC +import qualified Data.Aeson as J +import qualified Data.Aeson.KeyMap as JM +import qualified Data.Aeson.Types as JT +import Data.ByteString (ByteString) +import qualified Data.ByteString as B +import qualified Data.ByteString.Base64 as B64 +import qualified Data.ByteString.Base64.URL as B64U +import Data.Foldable (toList) +import Data.Maybe (isJust) +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) +import Data.Word (Word32) +import Data.X509 +import Data.X509.EC (unserializePoint) +import Data.X509.Validation (SignatureFailure (..), SignatureVerification (..), verifySignedSignature) +import Simplex.Chat.PaymentService.Types (CurrencyAmount (..)) +import Simplex.Messaging.Util (eitherToMaybe) + +verifyAppleTransaction :: SignedCertificate -> Text -> Text -> Either StoreRefusal VerifiedStoreTransaction +verifyAppleTransaction root ourBundleId jws = case T.splitOn "." jws of + [header, payload, signature] -> do + leaf <- signingChain root =<< certificateChain header + sig <- jwsSignature signature + key <- leafKey leaf + unless (ECDSA.verify SHA256 key sig (encodeUtf8 $ header <> "." <> payload)) $ + refused "the signature does not verify" + tx <- either (const $ failed "the payload Apple signed is not a transaction") Right $ do + o <- maybe (Left "not base64url JSON") Right $ jsonObject payload + JT.parseEither appleTransactionP o + transaction ourBundleId tx + _ -> refused "not three dot-separated parts" + +-- | A header or chain in a shape Apple may yet adopt proves no forgery, so it fails rather than refuses. +certificateChain :: Text -> Either StoreRefusal [ByteString] +certificateChain header = do + o <- maybe (refused "the header is not base64url JSON") Right $ jsonObject header + case JM.lookup "alg" o of + Just (J.String "ES256") -> Right () + _ -> failed "the header does not name ES256" + case JM.lookup "x5c" o of + Just (J.Array certs) -> traverse der $ toList certs + _ -> failed "the header carries no x5c chain" + where + der = \case + J.String c | Right bs <- B64.decode (encodeUtf8 c) -> Right bs + _ -> refused "an x5c certificate is not base64" + +-- | The root in the chain is ignored: trust comes from the configured one alone. +signingChain :: SignedCertificate -> [ByteString] -> Either StoreRefusal SignedCertificate +signingChain root = \case + [leafDer, intermediateDer, _] -> do + leaf <- certificate leafDer + intermediate <- certificate intermediateDer + -- the configured root may be stale or wrong as likely as the receipt forged, so this retries rather than refuses + unless (signedBy root intermediate) $ failed "the intermediate is not signed by the configured root" + case verifySignedSignature leaf (certPubKey $ getCertificate intermediate) of + SignaturePass -> Right () + SignatureFailed SignatureInvalid -> refused "the leaf is not signed by the intermediate" + SignatureFailed _ -> failed "the intermediate's key cannot check the leaf's signature algorithm" + -- Apple issues other certificates under this root, developers' among them; only these two mark the receipt-signing chain + unless (marked receiptSigningLeaf leaf && marked appleIntermediate intermediate) $ + failed "Apple issued this chain, but not to sign receipts" + pure leaf + _ -> failed "x5c is not leaf, intermediate and root" + where + certificate = either (const $ failed "an x5c certificate does not decode") Right . decodeSignedCertificate + signedBy issuer cert = verifySignedSignature cert (certPubKey $ getCertificate issuer) == SignaturePass + marked oid cert = case certExtensions (getCertificate cert) of + Extensions (Just exts) -> any ((== oid) . extRawOID) exts + Extensions Nothing -> False + receiptSigningLeaf = [1, 2, 840, 113635, 100, 6, 11, 1] + appleIntermediate = [1, 2, 840, 113635, 100, 6, 2, 1] + +leafKey :: SignedCertificate -> Either StoreRefusal ECDSA.PublicKey +leafKey leaf = case certPubKey (getCertificate leaf) of + PubKeyEC (PubKeyEC_Named ECC.SEC_p256r1 pt) | Just p <- unserializePoint p256 pt -> Right $ ECDSA.PublicKey p256 p + _ -> failed "the leaf Apple issued holds no P-256 key" + where + p256 = ECC.getCurveByName ECC.SEC_p256r1 + +-- | JWS carries ES256 as r and s, 32 bytes each, not the DER a certificate uses. +jwsSignature :: Text -> Either StoreRefusal ECDSA.Signature +jwsSignature s = case B64U.decodeUnpadded (encodeUtf8 s) of + Right bs | B.length bs == 64 -> let (r, s') = B.splitAt 32 bs in Right $ ECDSA.Signature (os2ip r) (os2ip s') + _ -> refused "the signature is not 64 base64url bytes" + +data AppleTransaction = AppleTransaction + { transactionId :: Text, + productId :: Text, + bundleId :: Text, + environment :: Text, + quantity :: Int, + revoked :: Bool, + price :: Maybe Integer, + currency :: Maybe Text + } + +appleTransactionP :: J.Object -> JT.Parser AppleTransaction +appleTransactionP o = do + transactionId <- o J..: "transactionId" + productId <- o J..: "productId" + bundleId <- o J..: "bundleId" + environment <- o J..: "environment" + quantity <- o J..: "quantity" + revoked <- isJust <$> (o J..:? "revocationDate" :: JT.Parser (Maybe J.Value)) + price <- o J..:? "price" + currency <- o J..:? "currency" + pure AppleTransaction {transactionId, productId, bundleId, environment, quantity, revoked, price, currency} + +transaction :: Text -> AppleTransaction -> Either StoreRefusal VerifiedStoreTransaction +transaction ourBundleId AppleTransaction {transactionId, productId, bundleId, environment, quantity, revoked, price, currency} + -- the configured bundle id may be the wrong one, and refusing for good would destroy every genuine purchase + | bundleId /= ourBundleId = failed "another app's bundle id, or ours misconfigured" + | revoked = refused "refunded or revoked" + | otherwise = do + testPurchase <- case environment of + "Production" -> Right False + "Sandbox" -> Right True + _ -> failed "an environment this verifier does not know" + Right + VerifiedStoreTransaction + { transactionRef = transactionId, + productId, + quantity, + testPurchase, + paid = paidOf price currency + } + +-- | Apple's price is in milliunits of the currency, whatever its minor unit. +paidOf :: Maybe Integer -> Maybe Text -> Maybe (CurrencyAmount, Text) +paidOf price_ currency_ = do + milliunits <- price_ + code <- currency_ + digits <- minorUnitDigits code + let (minor, rest) = (milliunits * 10 ^ digits) `divMod` 1000 + guard $ rest == 0 && minor >= 0 && minor <= toInteger (maxBound :: Word32) + pure (CurrencyAmount $ fromInteger minor, code) + +-- | ISO 4217 as of its 2026-09-17 list; four-digit and non-currency codes are not recorded. +minorUnitDigits :: Text -> Maybe Integer +minorUnitDigits c + | c `elem` ["BIF", "CLP", "DJF", "GNF", "ISK", "JPY", "KMF", "KRW", "PYG", "RWF", "UGX", "VND", "VUV", "XAF", "XOF", "XPF"] = Just 0 + | c `elem` ["BHD", "IQD", "JOD", "KWD", "LYD", "OMR", "TND"] = Just 3 + | c `elem` ["CLF", "UYW", "UYI", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XDR", "XPD", "XPT", "XSU", "XTS", "XUA", "XXX"] = Nothing + | T.length c == 3 && T.all (\x -> x >= 'A' && x <= 'Z') c = Just 2 + | otherwise = Nothing + +jsonObject :: Text -> Maybe J.Object +jsonObject part = J.decodeStrict' =<< eitherToMaybe (B64U.decodeUnpadded $ encodeUtf8 part) + +refused :: Text -> Either StoreRefusal a +refused = Left . SRInvalid + +failed :: Text -> Either StoreRefusal a +failed = Left . SRVerifierFailed . ("apple verifier: " <>) + +readAppleRoot :: FilePath -> IO (Either String SignedCertificate) +readAppleRoot path = + try (B.readFile path) >>= \case + Left (_ :: IOException) -> pure $ Left $ path <> ": could not be read" + Right der -> pure $ either (const $ Left $ path <> ": is not a DER certificate") Right $ decodeSignedCertificate der diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs new file mode 100644 index 0000000000..f70d8cba77 --- /dev/null +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs @@ -0,0 +1,233 @@ +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TupleSections #-} + +module BadgeService.StoreReceipts.Google (playStoreVerifier) where + +import BadgeService.Config (PlayStoreConfig (..)) +import BadgeService.StoreReceipts (StoreRefusal (..), VerifiedStoreTransaction (..)) +import Control.Concurrent.STM +import Control.Exception (IOException, try) +import Crypto.Hash.Algorithms (SHA256 (..)) +import qualified Crypto.PubKey.RSA as RSA +import qualified Crypto.PubKey.RSA.PKCS15 as RSA +import qualified Data.Aeson as J +import Data.Bifunctor (bimap) +import Data.ByteString (ByteString) +import qualified Data.ByteString as B +import qualified Data.ByteString.Base64.URL as B64U +import qualified Data.ByteString.Lazy as LB +import Data.Functor (($>)) +import Data.Int (Int64) +import Data.Maybe (fromMaybe) +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) +import Data.Time.Clock (NominalDiffTime, UTCTime, addUTCTime, getCurrentTime) +import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds) +import Data.X509 (PrivKey (..)) +import Data.X509.Memory (readKeyFileFromMemory) +import Network.HTTP.Client + ( HttpException (..), + Manager, + Request (..), + RequestBody (..), + Response (..), + brReadSome, + parseRequest, + withResponse, + ) +import Network.HTTP.Client.TLS (newTlsManager) +import Network.HTTP.Types (Status (..), hAuthorization, hContentType, methodPost, renderSimpleQuery) +import Simplex.Chat.PaymentService (googlePurchaseRef) +import Simplex.Messaging.Util (tshow) + +data ServiceAccount = ServiceAccount {clientEmail :: Text, privateKey :: RSA.PrivateKey} + +data PlayEnv = PlayEnv + { config :: PlayStoreConfig, + account :: ServiceAccount, + manager :: Manager, + accessToken :: TVar (Maybe (ByteString, UTCTime)) + } + +playStoreVerifier :: PlayStoreConfig -> IO (Either String (Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction), Text -> Text -> IO (Either StoreRefusal ()))) +playStoreVerifier config@PlayStoreConfig {gServiceAccountFile} = + readServiceAccount gServiceAccountFile >>= \case + Left e -> pure $ Left e + Right account -> do + manager <- newTlsManager + accessToken <- newTVarIO Nothing + let env = PlayEnv {config, account, manager, accessToken} + pure $ Right (verifyPurchase env, acknowledgePurchase env) + +readServiceAccount :: FilePath -> IO (Either String ServiceAccount) +readServiceAccount path = + try (B.readFile path) >>= \case + Left (_ :: IOException) -> pure $ Left $ path <> ": could not be read" + Right s -> pure $ case J.decodeStrict' s of + Just (ServiceAccountFile clientEmail pem) -> case readKeyFileFromMemory (encodeUtf8 pem) of + [PrivKeyRSA privateKey] -> Right ServiceAccount {clientEmail, privateKey} + _ -> Left $ path <> ": private_key is not one RSA key" + Nothing -> Left $ path <> ": is not a service account key with client_email and private_key" + +data ServiceAccountFile = ServiceAccountFile Text Text + +instance J.FromJSON ServiceAccountFile where + parseJSON = J.withObject "service account key" $ \o -> ServiceAccountFile <$> o J..: "client_email" <*> o J..: "private_key" + +verifyPurchase :: PlayEnv -> Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +verifyPurchase env productId token = (>>= purchaseVerdict productId token) <$> readPurchase env productId token + +-- | Acknowledged, never consumed: consuming drops the purchase from the app's purchase query, +-- which is how the app finds a purchase it has not yet settled. +acknowledgePurchase :: PlayEnv -> Text -> Text -> IO (Either StoreRefusal ()) +acknowledgePurchase env productId token = + readPurchase env productId token >>= \case + Left refusal -> pure $ Left $ acknowledging refusal + Right ProductPurchase {alreadyAcknowledged = True} -> pure $ Right () + Right _ -> bimap acknowledging (const ()) <$> playCall env (\req -> req {method = methodPost}) (purchaseUrl env productId token <> ":acknowledge") + where + acknowledging = \case + SRUnreachable reason -> SRUnreachable $ "acknowledging: " <> reason + SRVerifierFailed reason -> SRVerifierFailed $ "acknowledging: " <> reason + refusal -> refusal + +readPurchase :: PlayEnv -> Text -> Text -> IO (Either StoreRefusal ProductPurchase) +readPurchase env productId token = (>>= decoded) <$> playCall env id (purchaseUrl env productId token) + where + decoded = either (const $ Left $ SRVerifierFailed "could not read Play's purchase record") Right . J.eitherDecode' + +purchaseUrl :: PlayEnv -> Text -> Text -> Text +purchaseUrl PlayEnv {config = PlayStoreConfig {gApiHost, gPackageName}} productId token = + T.intercalate "/" [gApiHost, "androidpublisher/v3/applications", gPackageName, "purchases/products", productId, "tokens", token] + +playCall :: PlayEnv -> (Request -> Request) -> Text -> IO (Either StoreRefusal LB.ByteString) +playCall env@PlayEnv {accessToken} prepare url = + bearerToken env >>= \case + Left refusal -> pure $ Left refusal + Right bearer -> + playRequest env (\req -> (prepare req) {requestHeaders = [(hAuthorization, "Bearer " <> bearer)]}) url >>= \case + Left refusal -> pure $ Left refusal + Right (code, body) | code >= 200 && code < 300 -> pure $ Right body + Right (401, _) -> atomically (writeTVar accessToken Nothing) $> Left (SRVerifierFailed "Play refused this service's access token") + Right (403, _) -> pure $ Left $ SRVerifierFailed "the service account lacks the Play Console permission for this call" + -- a 404 among them, which Play may answer for a token it issued but has not yet recorded + Right (code, _) -> pure $ Left $ SRUnreachable $ "Play answered HTTP " <> tshow code + +purchaseVerdict :: Text -> Text -> ProductPurchase -> Either StoreRefusal VerifiedStoreTransaction +purchaseVerdict productId token ProductPurchase {purchaseState, purchaseType, purchaseQuantity, purchaseProductId} + | maybe False (/= productId) purchaseProductId = Left $ SRVerifierFailed "Play answered about another product" + | otherwise = case purchaseState of + 0 -> purchased <$> testPurchaseOf purchaseType + -- a canceled purchase stays canceled, and buying again issues a new token + 1 -> Left $ SRInvalid "canceled" + 2 -> Left SRPending + s -> Left $ SRVerifierFailed $ "an unknown purchaseState " <> tshow s + where + purchased testPurchase = + VerifiedStoreTransaction + { transactionRef = googlePurchaseRef token, + productId, + quantity = fromMaybe 1 purchaseQuantity, + testPurchase, + paid = Nothing + } + testPurchaseOf = \case + Nothing -> Right False + Just 0 -> Right True + -- a promo code, which only this app's developer can issue + Just 1 -> Right False + Just t -> Left $ SRVerifierFailed $ "a purchaseType this service does not credit: " <> tshow t + +data ProductPurchase = ProductPurchase + { purchaseState :: Int, + purchaseType :: Maybe Int, + purchaseQuantity :: Maybe Int, + purchaseProductId :: Maybe Text, + alreadyAcknowledged :: Bool + } + +instance J.FromJSON ProductPurchase where + parseJSON = J.withObject "ProductPurchase" $ \o -> do + purchaseState <- o J..: "purchaseState" + purchaseType <- o J..:? "purchaseType" + purchaseQuantity <- o J..:? "quantity" + purchaseProductId <- o J..:? "productId" + acknowledgementState <- o J..:? "acknowledgementState" + consumptionState <- o J..:? "consumptionState" + let alreadyAcknowledged = acknowledgementState == Just (1 :: Int) || consumptionState == Just (1 :: Int) + pure ProductPurchase {purchaseState, purchaseType, purchaseQuantity, purchaseProductId, alreadyAcknowledged} + +bearerToken :: PlayEnv -> IO (Either StoreRefusal ByteString) +bearerToken env@PlayEnv {accessToken} = do + now <- getCurrentTime + readTVarIO accessToken >>= \case + Just (bearer, validUntil) | now < validUntil -> pure $ Right bearer + _ -> requestAccessToken env now + +requestAccessToken :: PlayEnv -> UTCTime -> IO (Either StoreRefusal ByteString) +requestAccessToken env@PlayEnv {config = PlayStoreConfig {gTokenUrl}, account, accessToken} now = + signedAssertion account gTokenUrl now >>= \case + Nothing -> pure $ Left $ SRVerifierFailed "could not sign the service account assertion" + Just assertion -> + playRequest env (tokenForm assertion) gTokenUrl >>= \case + Left refusal -> pure $ Left refusal + Right (200, body) -> case J.eitherDecode' body of + Right (GrantedToken bearer expiresIn) -> do + atomically $ writeTVar accessToken $ Just (bearer, addUTCTime (fromIntegral expiresIn - refreshMargin) now) + pure $ Right bearer + Left _ -> pure $ Left $ SRVerifierFailed "could not read Google's access token" + Right (code, _) + | code >= 500 || code == 429 -> pure $ Left $ SRUnreachable $ "Google's token endpoint answered HTTP " <> tshow code + | otherwise -> pure $ Left $ SRVerifierFailed $ "Google refused the service account assertion: HTTP " <> tshow code + where + tokenForm assertion req = + req + { method = methodPost, + requestHeaders = [(hContentType, "application/x-www-form-urlencoded")], + requestBody = RequestBodyBS $ renderSimpleQuery False [("grant_type", "urn:ietf:params:oauth:grant-type:jwt-bearer"), ("assertion", assertion)] + } + +refreshMargin :: NominalDiffTime +refreshMargin = 300 + +data GrantedToken = GrantedToken ByteString Int + +instance J.FromJSON GrantedToken where + parseJSON = J.withObject "access token" $ \o -> GrantedToken . encodeUtf8 <$> o J..: "access_token" <*> o J..: "expires_in" + +signedAssertion :: ServiceAccount -> Text -> UTCTime -> IO (Maybe ByteString) +signedAssertion ServiceAccount {clientEmail, privateKey} audience now = + either (const Nothing) (\sig -> Just $ signingInput <> "." <> B64U.encodeUnpadded sig) <$> RSA.signSafer (Just SHA256) privateKey signingInput + where + issuedAt = floor (utcTimeToPOSIXSeconds now) :: Int64 + signingInput = segment (J.object ["alg" J..= ("RS256" :: Text), "typ" J..= ("JWT" :: Text)]) <> "." <> segment claims + claims = + J.object + [ "iss" J..= clientEmail, + "scope" J..= ("https://www.googleapis.com/auth/androidpublisher" :: Text), + "aud" J..= audience, + "iat" J..= issuedAt, + "exp" J..= (issuedAt + 3600) + ] + segment = B64U.encodeUnpadded . LB.toStrict . J.encode + +playRequest :: PlayEnv -> (Request -> Request) -> Text -> IO (Either StoreRefusal (Int, LB.ByteString)) +playRequest PlayEnv {manager} prepare url = + try (parseRequest (T.unpack url) >>= \req -> withResponse (prepare req) manager readBody) >>= \case + -- http-client's exceptions show the request, whose URL can hold the purchase token, so only the kind is kept + Left (e :: HttpException) -> pure $ Left $ SRUnreachable $ "request to Google failed: " <> failureKind e + Right (code, body) + | LB.length body > maxPlayBytes -> pure $ Left $ SRVerifierFailed $ "Google answered HTTP " <> tshow code <> " with over " <> tshow maxPlayBytes <> " bytes" + | otherwise -> pure $ Right (code, body) + where + readBody resp = (statusCode (responseStatus resp),) <$> brReadSome (responseBody resp) (fromIntegral maxPlayBytes + 1) + failureKind = \case + HttpExceptionRequest _ content -> T.pack $ takeWhile (/= ' ') $ show content + InvalidUrlException _ _ -> "InvalidUrlException" + +maxPlayBytes :: Int64 +maxPlayBytes = 1024 * 1024 diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs index c2fd1ab63d..5de05fbf99 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs @@ -18,24 +18,24 @@ import Simplex.Messaging.Util (eitherToMaybe) mockStoreVerifier :: StoreVerifier mockStoreVerifier = noStoreVerifier {verifyApple = Just mockApple, verifyGoogle = Just mockGoogle} -mockApple :: Text -> Either Text VerifiedStoreTransaction +mockApple :: Text -> Either StoreRefusal VerifiedStoreTransaction mockApple signed = case T.splitOn "." signed of [_, payload, _] -> do o <- case J.decodeStrict' =<< eitherToMaybe (B64U.decodeUnpadded $ encodeUtf8 payload) of Just (J.Object obj) -> Right obj - _ -> Left "payload is not base64url JSON" + _ -> Left $ SRInvalid "payload is not base64url JSON" productId <- case JM.lookup "productId" o of Just (J.String p) -> Right p - _ -> Left "no productId" - transactionRef <- maybe (Left "no transactionId") Right $ appleTransactionId signed + _ -> Left $ SRInvalid "no productId" + transactionRef <- maybe (Left $ SRInvalid "no transactionId") Right $ appleTransactionId signed Right $ vouched transactionRef productId - _ -> Left "not three dot-separated parts" + _ -> Left $ SRInvalid "not three dot-separated parts" mockGoogle :: Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) mockGoogle productId token = pure $ Right $ vouched (googlePurchaseRef token) productId vouched :: Text -> Text -> VerifiedStoreTransaction vouched transactionRef productId = - -- not a test purchase, though nothing was paid: a test purchase is refused as receipt_invalid, which is + -- not a test purchase, though nothing was paid: a test purchase is refused as test_purchase, which is -- terminal and drops the client's keys, so every dev purchase would fail for good VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase = False, paid = Nothing} diff --git a/bots/api/TYPES.md b/bots/api/TYPES.md index 338fa6c206..fe79d847e2 100644 --- a/bots/api/TYPES.md +++ b/bots/api/TYPES.md @@ -487,6 +487,7 @@ CredentialNotVerified: - "code_expired" - "receipt_invalid" - "receipt_used" +- "test_purchase" - "internal" diff --git a/docs/protocol/badges-rpc.md b/docs/protocol/badges-rpc.md index 42b602f4d2..80285fd383 100644 --- a/docs/protocol/badges-rpc.md +++ b/docs/protocol/badges-rpc.md @@ -34,12 +34,27 @@ The client never states what is signed. The tier is that of whatever funded the - `redeemBadgeCode` → `badgeCredential` — redeems a code, records the credit, and issues the first credential, in one round trip. It carries `masterKey` and `code` and no `badgeRequest`: a code states no tier and no expiry, so the credential is what reports them. Errors: `code_invalid` for an unknown or malformed code, `code_used` when other keys have taken all its uses (a code has one use unless issued with more), `code_expired` past a redemption deadline. - `purchaseBadge` → `badgeCredential` — verifies the funding (`apple` JWS offline; `google` product id and token via the Publisher API; `invoice` against webhook-confirmed settlement, `payment_pending` until it lands; `receipt`), records the credit, and issues the first credential, in one round trip. It carries `masterKey` and no `badgeRequest`. The response `receipt` is the recovery bearer secret (model § recovery); the service stores its hash; lifetime badges receive none. - A store transaction is claimed by its own id, read from the evidence before verification, and credited only when the verified transaction carries that same id. A receipt already credited to the signing key is answered from the record, without asking the store. - - Errors: `receipt_invalid`, `payment_pending`, `provider_unavailable` — see the classes below; `receipt_used` when another key was credited with it; `product_unavailable` for a product this service does not price; `provider_not_configured` when this deployment has no verifier for the store, terminal for the request since retrying cannot deploy one. `receipt_invalid` and `receipt_used` are the only answers on which the client drops the keys it signed with and finishes the store transaction. Every other answer records nothing and leaves the purchase with its keys, to be presented again at the next trigger. - - **Which class an answer belongs to.** The two mistakes do not cost the same, so when it is not certain, answer unreachable. `receipt_invalid` tells the client the purchase is dead: it drops the keys it signed with and finishes the store transaction — consumed on Play, finished on StoreKit — and nothing can present it again, so a buyer answered this by mistake has paid for a badge they can never receive. Answering unreachable by mistake costs one more verification request each time the app presents the purchase again, and a Play purchase left unacknowledged for three days is refunded to the buyer. - - **Terminal**, `receipt_invalid` — the store answered about this purchase and cannot change its mind: an Apple signature or certificate chain that does not verify, another app's bundle id, a test purchase (Apple Sandbox, Play `purchaseType` test), a refunded or revoked purchase, Play `purchaseState` canceled. - - **Pending**, `payment_pending` — Play `purchaseState` pending. - - **Unreachable**, `provider_unavailable` — the store was not asked or did not answer: network, timeout, 5xx, quota, this service's own auth or permission failures, and every Play error response, a 404 from `purchases.products.get` or `purchases.subscriptionsv2.get` and a 400 or 410 calling the token invalid included. A 404 decides nothing: Play answers it both for a token it has just issued and not yet recorded, and for one that was never a purchase. Only a purchase record is a verdict. A token whose characters this service will not send is never sent, so Play never answers about it — and Play documents no token grammar, so that check is our guess, not its verdict. A product id outside the characters Play does document is terminal, since no product of this app can have one. - - Apple is verified offline, so it has no "not yet" and a negative answer about the signed evidence is terminal. Two things are not the store's answer and leave the client holding the purchase: the verifier's own failure, such as a root certificate it could not load, which is `internal`; and a product this service does not price, which is `product_unavailable` — the verifier vouched for the transaction either way. + - Errors: `receipt_invalid`, `test_purchase`, `payment_pending`, `provider_unavailable` — see the classes below; `receipt_used` when another key was credited with it; `product_unavailable` for a product this service does not price; `provider_not_configured` when this deployment has no verifier for the store. `receipt_invalid`, `test_purchase` and `receipt_used` are the only answers on which the client drops the keys it signed with and finishes the store transaction. Every other answer records nothing and leaves the purchase with its keys, to be presented again at the next trigger. + - **Which class an answer belongs to.** The two mistakes do not cost the same, so when it is not certain, answer unreachable. `receipt_invalid` tells the client the purchase is dead: it drops the keys it signed with and finishes the store transaction — consumed on Play, finished on StoreKit — and nothing can present it again, so a buyer answered this by mistake has paid for a badge they can never receive. Answering unreachable by mistake costs one more verification request each time the app presents the purchase again, and a Play purchase left unacknowledged for three days is refunded to the buyer. It also locks the buyer out: the app offers no Buy while a purchase is open, so until that receipt settles the profile holding it cannot buy any badge, and an answer that never changes leaves it that way for good. + - **Terminal**, `receipt_invalid` — only a verdict no later attempt could change: the store answered about this purchase and cannot change its mind, or the evidence can never verify. Anything that might answer differently later — the store's lag, an outage, this service's own misconfiguration or bug, a shape of evidence this service does not know yet — is one of the other classes. + - **Terminal and named**, `test_purchase` — the store vouched for a purchase that cost nothing: Apple's `Sandbox`, or Play's `purchaseType` test. It is separated from `receipt_invalid` for one reason: the device that made the purchase already knows it was a test one, so naming it reveals nothing a forger could iterate on, and it lets the app say why instead of reporting a generic failure. Every other refusal stays lumped together for exactly that reason. + - **Pending**, `payment_pending` — a real purchase the store has not settled. + - **Unreachable**, `provider_unavailable` — the store was not asked or did not answer. + - **Internal**, `internal` — this service's own failure, never the store's answer. + - **App Store.** Apple is verified offline, so it has no "not yet". + - `receipt_invalid`: a JWS that is not three base64url parts or names no `transactionId`; an `x5c` certificate that is not base64; a JWS signature that is not 64 bytes; a leaf whose signature does not verify against the intermediate; a JWS signature that does not verify against the leaf; a transaction with a `revocationDate`, refunded or revoked. + - `test_purchase`: refused by the service after the verifier vouched for it, a `Sandbox` transaction. + - `internal`: whatever this service's own configuration decides — an intermediate whose signature does not verify against the configured root, and another app's `bundleId`, since the configured root or bundle id may be the wrong one as likely as the receipt forged; a transaction from Xcode's StoreKit testing, which Xcode signs and not the App Store, so the configured root does not verify it; evidence in a shape this service does not know — a header that does not name `ES256` or carries no `x5c` of exactly three certificates, a certificate that does not decode, a leaf signature the intermediate's key cannot check, an algorithm or key type the library does not support, a chain without Apple's receipt-signing marker extensions, a leaf key that is not P-256, a payload with a missing or mistyped field or an unknown `environment`; the verifier's own failure or overrun; and, refused by the service, a verified transaction other than the one claimed, or a quantity other than 1. + - `product_unavailable`: a product this service does not price — the verifier vouched for the transaction either way. + - `provider_not_configured`: the deployment has no `[apple]` section. + - **Google Play.** Only a purchase record is a verdict. + - `receipt_invalid`: `purchaseState` canceled, which a purchase token never leaves, and a product id outside the characters Play documents, since no product of this app can have one. + - `test_purchase`: refused by the service after the verifier vouched for it, `purchaseType` test, a license tester's purchase. + - `payment_pending`: `purchaseState` pending. + - `provider_unavailable`: network failure or timeout, and every error response from `purchases.products.get` but 401 and 403 — a 404 included, which Play may answer both for a token it has just issued and not yet recorded and for one that was never a purchase, and a 400 or 410 calling the token invalid; a 5xx or 429 from the token endpoint; and a token this service will not send — whose characters fall outside the grammar it accepts, which is our guess since Play documents none, or which is only dots, which a URL path would resolve away. + - `internal`: Google refusing this service's credentials or permissions — a 401 or 403 from `purchases.products.get`, and any other refusal from the token endpoint; a response that cannot be read, is too large, or names another product; a `purchaseState` this service does not know; and a `purchaseType` other than test or promo — a promo code, which only this app's developer issues, is credited like a purchase. + - `product_unavailable` and `provider_not_configured` as for the App Store, the latter without a `[google]` section. + - Before crediting a purchase of a product it prices, the service acknowledges it, unless Play already reports it acknowledged or consumed. It acknowledges and never consumes, so the app's purchase query still lists the purchase. The app may not be honest, and only acknowledgement stops Play refunding the purchase after three days, so nothing is credited unacknowledged. A failed acknowledgement credits nothing and is answered like a failed read — `provider_unavailable` when Play does not answer, `internal` when it refuses this service, both logged with "acknowledging" in the reason — and the app presents the purchase again. A deployment whose service account lacks the permission to acknowledge therefore answers `internal` to every Play purchase the app has not already acknowledged itself. - Funding by `receipt` is a transfer (post-MVP): the unissued months of the purchase that receipt belongs to move to the signing key, recorded as `debit(transferOut)` on the source and `credit(transferIn)` on the new purchase, and the presented receipt is retired for a fresh one. The transferred period's issuance debits a month like any other. Lifetime badges hold no receipt, so support handles them. - `upgradeBadgeSubscription` → `badgeCredential` — the app-led store subscription change, on the same key: verifies the store evidence of the replaced subscription and records the new plan; an immediate upgrade returns the new credential, a deferred change returns none. Its `badgeRequest` is to be dropped (see above). - `issueBadge` → `badgeCredential` — issues the next period from the balance, the only source of issuance. It carries `balance` alone: the credential is signed with the purchase's stored master key, for the type the balance funds, expiring at the `sundayAfter` of the period issued. The ledger is advanced first; the credential is signed before the `debit(badge)` and issuance rows are written, in one transaction. An exhausted balance yields no `credential`; the `statement` shows why. Issuing on a paused badge resumes it (model 2.13). @@ -70,4 +85,4 @@ An assertion that names an entry the service holds is a prefix: the service proc ## Errors -`retryAfter` marks the transient codes: `payment_pending`, `provider_unavailable`, `rate_limited`. `offer_disabled` calls for a catalog refresh. `code_invalid` covers unknown, malformed and revoked codes alike, so a guesser learns nothing from the difference; `code_used` — all its uses taken by other keys; `code_expired` — past its redemption deadline. `receipt_invalid` covers forged, malformed, another app's, refunded and test receipts alike, so a guesser learns nothing from the difference; `receipt_used` — credited to another key; `provider_not_configured` — no verifier for that store is deployed, so the receipt is neither credited nor refused. All other codes are terminal for the attempted command. +`retryAfter` marks the transient codes: `payment_pending`, `provider_unavailable`, `rate_limited`. `offer_disabled` calls for a catalog refresh. `code_invalid` covers unknown, malformed and revoked codes alike, so a guesser learns nothing from the difference; `code_used` — all its uses taken by other keys; `code_expired` — past its redemption deadline. `receipt_invalid` covers forged, malformed and refunded receipts alike, so a guesser learns nothing from the difference; `test_purchase` is named apart from them because the device that bought it already knows; `receipt_used` — credited to another key; `provider_not_configured` — no verifier for that store is deployed, so the receipt is neither credited nor refused. All other codes are terminal for the attempted command. diff --git a/packages/simplex-chat-client/types/typescript/src/types.ts b/packages/simplex-chat-client/types/typescript/src/types.ts index 56fa0b389e..cebc68abb4 100644 --- a/packages/simplex-chat-client/types/typescript/src/types.ts +++ b/packages/simplex-chat-client/types/typescript/src/types.ts @@ -325,6 +325,7 @@ export enum BadgeServiceErrorCode { Code_expired = "code_expired", Receipt_invalid = "receipt_invalid", Receipt_used = "receipt_used", + Test_purchase = "test_purchase", Internal = "internal", } diff --git a/packages/simplex-chat-python/src/simplex_chat/types/_types.py b/packages/simplex-chat-python/src/simplex_chat/types/_types.py index eca43f04ed..1befa750c3 100644 --- a/packages/simplex-chat-python/src/simplex_chat/types/_types.py +++ b/packages/simplex-chat-python/src/simplex_chat/types/_types.py @@ -224,7 +224,7 @@ BadgeRedeemError = ( BadgeRedeemError_Tag = Literal["invalidCode", "invalidReceipt", "serviceNotConfigured", "badgeActive", "serviceError", "invalidResponse", "unknownKeyIndex", "credentialNotVerified"] -BadgeServiceErrorCode = Literal["bad_request", "unsupported_version", "unknown_purchase_key", "unknown_offer_id", "offer_disabled", "offer_mismatch", "product_unavailable", "payment_not_entitled", "payment_pending", "provider_unavailable", "provider_not_configured", "rate_limited", "code_invalid", "code_used", "code_expired", "receipt_invalid", "receipt_used", "internal"] +BadgeServiceErrorCode = Literal["bad_request", "unsupported_version", "unknown_purchase_key", "unknown_offer_id", "offer_disabled", "offer_mismatch", "product_unavailable", "payment_not_entitled", "payment_pending", "provider_unavailable", "provider_not_configured", "rate_limited", "code_invalid", "code_used", "code_expired", "receipt_invalid", "receipt_used", "test_purchase", "internal"] BadgeStatus = Literal["active", "expired", "expiredOld", "failed", "unknownKey"] diff --git a/scripts/badge-service/badge_service.ini.example b/scripts/badge-service/badge_service.ini.example index 2dfcecf3f4..542fe5842b 100644 --- a/scripts/badge-service/badge_service.ini.example +++ b/scripts/badge-service/badge_service.ini.example @@ -36,6 +36,22 @@ session_minutes = 60 waiting_seconds = 3 idle_seconds = 60 +; optional; without it every App Store receipt is answered provider_not_configured, which the app retries later. +; root_certificate is https://www.apple.com/certificateauthority/AppleRootCA-G3.cer, in DER; +; uncomment its mount in compose.yml. +;[apple] +;bundle_id = chat.simplex.app +;root_certificate = /etc/simplex-badge-service/AppleRootCA-G3.cer + +; optional; without it every Play receipt is answered provider_not_configured, which the app retries later. +; service_account_file is the JSON key of a service account with the Play Console permissions "View +; financial data, orders, and cancellation survey responses" and "Manage orders and subscriptions", to +; read and acknowledge purchases. Without the second, a purchase the app has not already acknowledged +; itself is answered internal until the permission is granted. Uncomment its mount in compose.yml; the file must be readable by the service's user alone. +;[google] +;package_name = chat.simplex.app +;service_account_file = /etc/simplex-badge-service/play-service-account.json + ; index is the one clients verify against; private_key is from `simplex-chat badge keygen`. ; To rotate, change both together, once clients trust the new index. [issuer] @@ -54,6 +70,7 @@ private_key = replace-me ;description = Welcome to the badges group ; local testing only, in both run modes: accepts any well-formed App Store or Play receipt without -; verifying it, so anyone who can reach this service can mint badges +; verifying it, so anyone who can reach this service can mint badges. The service refuses to start +; with this on beside an [apple] or [google] section. [dev] accept_unverified_store_receipts = off diff --git a/scripts/badge-service/compose.yml b/scripts/badge-service/compose.yml index 1c7e485e08..0656835b9d 100644 --- a/scripts/badge-service/compose.yml +++ b/scripts/badge-service/compose.yml @@ -20,5 +20,7 @@ services: - "/etc/simplex-badge-service/badge_service.ini" volumes: - ./badge_service.ini:/etc/simplex-badge-service/badge_service.ini:ro + # - ./AppleRootCA-G3.cer:/etc/simplex-badge-service/AppleRootCA-G3.cer:ro + # - ./play-service-account.json:/etc/simplex-badge-service/play-service-account.json:ro - ./web:/srv/webapp stop_grace_period: 10s diff --git a/simplex-chat.cabal b/simplex-chat.cabal index d233583511..871eabc140 100644 --- a/simplex-chat.cabal +++ b/simplex-chat.cabal @@ -447,6 +447,8 @@ executable simplex-badge-service BadgeService.Store.Invoices BadgeService.Store.Migrate BadgeService.StoreReceipts + BadgeService.StoreReceipts.Apple + BadgeService.StoreReceipts.Google BadgeService.StoreReceipts.Mock BadgeService.Waiters BadgeService.Web.Server @@ -459,6 +461,9 @@ executable simplex-badge-service , base64-bytestring >=1.0 && <1.3 , containers ==0.6.* , crypton ==0.34.* + , crypton-x509 ==1.7.* + , crypton-x509-store ==1.6.* + , crypton-x509-validation ==1.6.* , directory ==1.3.* , filepath ==1.4.* , http-client ==0.7.* @@ -740,6 +745,8 @@ test-suite simplex-chat-test BadgeService.Store.Invoices BadgeService.Store.Migrate BadgeService.StoreReceipts + BadgeService.StoreReceipts.Apple + BadgeService.StoreReceipts.Google BadgeService.StoreReceipts.Mock BadgeService.Waiters BadgeService.Web.Server @@ -748,10 +755,12 @@ test-suite simplex-chat-test Bots.BadgeService.CatalogTests Bots.BadgeService.ConfigTests Bots.BadgeService.FakeBTCPay + Bots.BadgeService.FakePlay Bots.BadgeService.FakeStore Bots.BadgeService.FakeStripe Bots.BadgeService.GroupIntegrationTests Bots.BadgeService.GroupTests + Bots.BadgeService.StoreVerifierTests Bots.BadgeService.StripeTests Bots.BadgeService.WaitersTests Bots.BadgeService.WebTests @@ -798,10 +807,14 @@ test-suite simplex-chat-test , composition ==1.0.* , containers ==0.6.* , crypton ==0.34.* + , crypton-x509 ==1.7.* + , crypton-x509-store ==1.6.* + , crypton-x509-validation ==1.6.* , deepseq ==1.4.* , directory ==1.3.* , filepath ==1.4.* , generic-random ==1.5.* + , hourglass ==0.2.* , http-client ==0.7.* , http-client-tls ==0.3.* , http-types ==0.12.* diff --git a/src/Simplex/Chat/Badges/Types.hs b/src/Simplex/Chat/Badges/Types.hs index 376869f584..f4949848f1 100644 --- a/src/Simplex/Chat/Badges/Types.hs +++ b/src/Simplex/Chat/Badges/Types.hs @@ -244,6 +244,7 @@ data BadgeServiceErrorCode | BSECodeExpired | BSEReceiptInvalid | BSEReceiptUsed + | BSETestPurchase -- the store vouched for a purchase that cost nothing: Apple's sandbox, a Play license tester | BSEInternal | BSEUnknown Text -- forwards-compatible: service is deployed ahead of clients deriving (Eq, Show) @@ -345,6 +346,7 @@ instance TextEncoding BadgeServiceErrorCode where BSECodeExpired -> "code_expired" BSEReceiptInvalid -> "receipt_invalid" BSEReceiptUsed -> "receipt_used" + BSETestPurchase -> "test_purchase" BSEInternal -> "internal" BSEUnknown t -> t textDecode s = Just $ case s of @@ -365,6 +367,7 @@ instance TextEncoding BadgeServiceErrorCode where "code_expired" -> BSECodeExpired "receipt_invalid" -> BSEReceiptInvalid "receipt_used" -> BSEReceiptUsed + "test_purchase" -> BSETestPurchase "internal" -> BSEInternal t -> BSEUnknown t diff --git a/src/Simplex/Chat/Library/Commands.hs b/src/Simplex/Chat/Library/Commands.hs index 367b2d8a75..f5c48c7e2c 100644 --- a/src/Simplex/Chat/Library/Commands.hs +++ b/src/Simplex/Chat/Library/Commands.hs @@ -5308,6 +5308,7 @@ storeReceiptRefused :: BadgeServiceErrorCode -> Bool storeReceiptRefused = \case BSEReceiptInvalid -> True BSEReceiptUsed -> True + BSETestPurchase -> True _ -> False -- | The same reference the service claims a transaction by, read without verifying anything. diff --git a/tests/BadgeTests.hs b/tests/BadgeTests.hs index da147f81d7..c2410e0423 100644 --- a/tests/BadgeTests.hs +++ b/tests/BadgeTests.hs @@ -716,7 +716,7 @@ testServiceRetryAfter = do badgeErrorRetryAfter BSEInternal `shouldBe` Nothing mapM_ (\code -> badgeErrorRetryAfter code `shouldBe` Nothing) - [BSEBadRequest, BSEUnsupportedVersion, BSEUnknownPurchaseKey, BSECodeInvalid, BSECodeUsed, BSECodeExpired, BSEProviderNotConfigured, BSEUnknown "future_code"] + [BSEBadRequest, BSEUnsupportedVersion, BSEUnknownPurchaseKey, BSECodeInvalid, BSECodeUsed, BSECodeExpired, BSEProviderNotConfigured, BSETestPurchase, BSEUnknown "future_code"] -- The app shows the recorded failure in a sentence, so an agent error is stored as the agent -- error and not as the chat error wrapping it, whether or not it can clear on its own. @@ -901,7 +901,7 @@ testGoogleTokenPath = do mapM_ (\t -> unsent t `shouldBe` True) ["a/b", "../x", "t?x", "t#x", "t x", ""] uncalledVerifier :: StoreVerifier -uncalledVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Just $ \_ _ -> error "verifier called", verifyTimeout = 500000} +uncalledVerifier = StoreVerifier {verifyApple = Nothing, verifyGoogle = Just $ \_ _ -> error "verifier called", acknowledgeGoogle = Nothing, verifyTimeout = 500000} validPlayToken :: T.Text validPlayToken = "fake-play-token.AO-J1Oz9x2kqE7wYt3" diff --git a/tests/Bots/BadgeService/BotTests.hs b/tests/Bots/BadgeService/BotTests.hs index 78d3faa9d4..2c52cc3445 100644 --- a/tests/Bots/BadgeService/BotTests.hs +++ b/tests/Bots/BadgeService/BotTests.hs @@ -28,7 +28,7 @@ import ChatTests.DBUtils import ChatTests.Utils import Control.Concurrent (threadDelay) import Control.Concurrent.Async (async, cancel) -import Control.Concurrent.STM (TQueue, atomically, readTMVar) +import Control.Concurrent.STM (TQueue, atomically, readTMVar, readTQueue) import Control.Monad (forM_, void, when) import Control.Exception (finally) import qualified Data.Aeson as J @@ -134,6 +134,7 @@ badgeServiceTests = do it "should refuse a receipt another key was credited with" testStoreReceiptUsed it "should refuse a receipt the store does not vouch for, with no retry" testStoreReceiptInvalid it "should write nothing for a pending purchase, and credit it once when it settles" testStorePending + it "should acknowledge a Play purchase before crediting it, and credit nothing when acknowledging fails" testStoreAcknowledgesBeforeCrediting it "should refuse a product that grants no badge" testStoreUnknownProduct it "should refuse a store purchase that carries an upgrade" testStoreUpgradeRefused it "should grant the badge of the product the receipt proves" testStoreBadgeTypeFromProduct @@ -168,6 +169,7 @@ badgeServiceTests = do it "should retry a receipt the service could not verify, and credit it with no trigger at all" testStoreReceiptRetried it "should credit a second receipt while an earlier one waits for the store" testStoreReceiptNotBlocked it "should answer a refused receipt from the record, sending nothing, and not list it" testStoreRefusalKept + it "should refuse a test purchase for good, and answer it from the record" testStoreTestPurchaseRefused it "should announce a settlement to an owner that is not active, and print nothing for a hidden one" testStoreSettledOtherProfile it "should resolve one new transaction handed over twice at once to one record" testStoreReceiptTwoAtOnce it "should delete a month-old record that will fund no badge, and keep held and credited ones" testStoreReceiptCleanup @@ -1723,8 +1725,8 @@ testStoreReceiptInvalid ps = refused (googlePayment "badge_supporter_01" "not-a-purchase") `shouldReturn` (BSEReceiptInvalid, Nothing) refused SPApple {jws = "not.a.jws"} `shouldReturn` (BSEReceiptInvalid, Nothing) refused SPApple {jws = unsignedJWS "{\"transactionId\":\"2000000812345699\",\"productId\":\"BADGE_SUPPORTER_01\"}"} `shouldReturn` (BSEReceiptInvalid, Nothing) - -- refused by the service, which the store would have vouched for - refused SPApple {jws = appleSandboxJWS} `shouldReturn` (BSEReceiptInvalid, Nothing) + -- named rather than lumped in with a forgery, since the device that bought it already knows + refused SPApple {jws = appleSandboxJWS} `shouldReturn` (BSETestPurchase, Nothing) nothingPurchased cc testStorePending :: HasCallStack => TestParams -> IO () @@ -1743,6 +1745,34 @@ testStorePending ps = rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 storePayments cc `shouldReturn` [("google", Nothing, Nothing, 1)] +testStoreAcknowledgesBeforeCrediting :: HasCallStack => TestParams -> IO () +testStoreAcknowledgesBeforeCrediting ps = do + acknowledged <- newIORef [] + acknowledgement <- newIORef $ Right () + let acknowledging store = (fakeVerifier store) {acknowledgeGoogle = Just $ \_ token -> modifyIORef' acknowledged (token :) >> readIORef acknowledgement} + withBadgeServiceVerifier ps acknowledging $ \env@BadgeServiceEnv {bsController = cc} -> do + (purchaseKey, masterKey) <- newPurchaseKeys + let purchase payment = serviceCmd env purchaseKey $ purchaseCmd masterKey payment + unsettled <- purchase $ googlePayment "badge_supporter_01" googlePendingToken + fst (refusalOf unsettled) `shouldBe` BSEPaymentPending + unpriced <- purchase $ googlePayment "subscr_badge_supporter_01" googleSubscriptionToken + refusalOf unpriced `shouldBe` (BSEProductUnavailable, Nothing) + readIORef acknowledged `shouldReturn` [] + writeIORef acknowledgement $ Left $ SRUnreachable "acknowledging: fake store is down" + unacknowledged <- purchase supporterPlay + refusalOf unacknowledged `shouldSatisfy` \(code, retryAfter) -> code == BSEProviderUnavailable && isJust retryAfter + writeIORef acknowledgement $ Left $ SRVerifierFailed "acknowledging: the service account lacks the Play Console permission for this call" + forbidden <- purchase supporterPlay + refusalOf forbidden `shouldBe` (BSEInternal, Nothing) + nothingPurchased cc + writeIORef acknowledgement $ Right () + purchased <- purchase supporterPlay + badgeTypeOf purchased `shouldBe` Just BTSupporter + replayed <- purchase supporterPlay + credentialOf replayed `shouldBe` credentialOf purchased + readIORef acknowledged `shouldReturn` replicate 3 googleSupporterToken + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 1 + testStoreUnknownProduct :: HasCallStack => TestParams -> IO () testStoreUnknownProduct ps = withBadgeServiceEnv ps $ \env@BadgeServiceEnv {bsController = cc} -> do @@ -2166,6 +2196,18 @@ testStoreRefusalKept ps = do verifications `shouldReturn` 1 storeReceiptRows (chatController alice) `shouldReturn` [(1, Nothing, True)] +testStoreTestPurchaseRefused :: HasCallStack => TestParams -> IO () +testStoreTestPurchaseRefused ps = + withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg, bsStore = FakeStore {appleSandboxJWS}} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> do + invoiceId <- createInvoice alice 1 + let purchase = purchaseWithInvoice 1 invoiceId SPApple {jws = appleSandboxJWS} + alice ##> purchase + alice <### [StartsWith (invoicePurchase "" invoiceId), ConsoleString (refusedLine "" invoiceId "service_error final test_purchase")] + heldStoreReceipts (chatController alice) `shouldReturn` 0 + alice ##> purchase + alice <## "cannot get badge: badge service error: test_purchase" + testStoreSettledOtherProfile :: HasCallStack => TestParams -> IO () testStoreSettledOtherProfile ps = withBadgeServiceEnv ps $ \BadgeServiceEnv {bsClientCfg} -> @@ -2261,7 +2303,7 @@ testStoreReceiptAfterRestart ps = do pure invoiceId writeIORef broken False withTestChatCfg ps cfg "alice" $ \alice -> do - inAnyOrder alice [["subscribed 1 connections on server localhost"], creditedLines "" invoiceId "1: supporter"] + expectLinesWithin 60 alice (creditedLines "" invoiceId "1: supporter") ["subscribed 1 connections on server localhost"] heldStoreReceipts (chatController alice) `shouldReturn` 0 createInvoice :: HasCallStack => TestCC -> Int -> IO String @@ -2330,6 +2372,27 @@ inAnyOrder cc blocks = do start : _ -> start `isPrefixOf` l [] -> False +-- | The required lines under one budget in any order, and the tolerated ones only if they come at +-- all: the agent announces UP for a subscription that was still pending in the session answering it +-- (simplexmq processSubOk), so "subscribed N connections" may never be printed, and when it is it +-- races a settlement that arrived in the same batch. getTermLine' would bound each line at 20s. +expectLinesWithin :: HasCallStack => Int -> TestCC -> [String] -> [String] -> IO () +expectLinesWithin seconds cc@TestCC {termQ, printOutput} required tolerated = go (seconds * 10) required + where + go n outstanding = + 100000 `timeout` atomically (readTQueue termQ) >>= \case + Just line -> do + when printOutput $ userName cc >>= \name -> putStrLn $ name <> ": " <> line + case break (`isPrefixOf` line) outstanding of + (earlier, _ : others) -> go n (earlier <> others) + _ + | any (`isPrefixOf` line) tolerated -> go n outstanding + | otherwise -> error $ "unexpected " <> show line <> ", awaiting " <> show outstanding + Nothing + | null outstanding -> pure () + | n > 0 -> go (n - 1) outstanding + | otherwise -> error $ "no line starting one of " <> show outstanding <> " in " <> show seconds <> " seconds" + -- | Counts the Google verifications the service makes, re-arming the one-shot hook each time. countGoogleVerifications :: IORef (IO ()) -> IO (IO Int) countGoogleVerifications hook = do diff --git a/tests/Bots/BadgeService/ConfigTests.hs b/tests/Bots/BadgeService/ConfigTests.hs index f8ce3038f5..1542c7a7eb 100644 --- a/tests/Bots/BadgeService/ConfigTests.hs +++ b/tests/Bots/BadgeService/ConfigTests.hs @@ -1,3 +1,4 @@ +{-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} @@ -51,6 +52,10 @@ badgeConfigTests = describe "badge service config" $ do it "reads accept_unverified_store_receipts = on" testDevUnverifiedReceiptsOn it "reads accept_unverified_store_receipts = off" testDevUnverifiedReceiptsOff it "refuses an accept_unverified_store_receipts that is not on or off" testDevUnverifiedReceiptsNotBoolean + it "configures no store verifier when [apple] and [google] are absent" testStoresAbsent + it "reads [apple] and [google], defaulting Google's endpoints" testStoresRead + it "refuses an incomplete [apple] or [google], naming the key" testStoresIncomplete + it "refuses accept_unverified_store_receipts beside a real store verifier" testDevUnverifiedBesideVerifier groupConfigTests fullIni :: T.Text @@ -380,6 +385,51 @@ testDevUnverifiedReceiptsNotBoolean = withDev "accept_unverified_store_receipts withDev :: T.Text -> (Either String ServiceConfig -> IO a) -> IO a withDev keys act = withIni (fullIni <> "[dev]\n" <> keys) $ \p -> readServiceConfig p >>= act +appleIni, googleIni :: T.Text +appleIni = "[apple]\nbundle_id = chat.simplex.app\nroot_certificate = /etc/badges/AppleRootCA-G3.cer\n" +googleIni = "[google]\npackage_name = chat.simplex.app\nservice_account_file = /etc/badges/play.json\n" + +testStoresAbsent :: IO () +testStoresAbsent = withIni fullIni $ \p -> do + Right cfg <- readServiceConfig p + appleStore cfg `shouldBe` Nothing + playStore cfg `shouldBe` Nothing + +testStoresRead :: IO () +testStoresRead = withIni (fullIni <> appleIni <> googleIni) $ \p -> do + Right cfg <- readServiceConfig p + appleStore cfg `shouldBe` Just AppleStoreConfig {aBundleId = "chat.simplex.app", aRootCertificate = "/etc/badges/AppleRootCA-G3.cer"} + playStore cfg + `shouldBe` Just + PlayStoreConfig + { gPackageName = "chat.simplex.app", + gServiceAccountFile = "/etc/badges/play.json", + gApiHost = "https://androidpublisher.googleapis.com", + gTokenUrl = "https://oauth2.googleapis.com/token" + } + +testStoresIncomplete :: IO () +testStoresIncomplete = do + refused (T.replace "bundle_id = chat.simplex.app\n" "" appleIni) "apple.bundle_id" + refused (T.replace "root_certificate = /etc/badges/AppleRootCA-G3.cer\n" "" appleIni) "apple.root_certificate" + refused (T.replace "package_name = chat.simplex.app\n" "" googleIni) "google.package_name" + refused (T.replace "service_account_file = /etc/badges/play.json\n" "" googleIni) "google.service_account_file" + where + refused section key = + withIni (fullIni <> section) readServiceConfig >>= \case + Left e -> e `shouldContain` key + Right _ -> expectationFailure ("an incomplete section must fail at boot, naming " <> key) + +testDevUnverifiedBesideVerifier :: IO () +testDevUnverifiedBesideVerifier = + mapM_ + ( \stores -> + withIni (fullIni <> stores <> "[dev]\naccept_unverified_store_receipts = on\n") readServiceConfig >>= \case + Left e -> e `shouldContain` "accept_unverified_store_receipts" + Right _ -> expectationFailure "a service that verifies store receipts must not also accept unverified ones" + ) + [appleIni, googleIni] + parseIni :: T.Text -> IO (Either String ServiceConfig) parseIni t = withIni t readServiceConfig diff --git a/tests/Bots/BadgeService/FakePlay.hs b/tests/Bots/BadgeService/FakePlay.hs new file mode 100644 index 0000000000..cc479853c7 --- /dev/null +++ b/tests/Bots/BadgeService/FakePlay.hs @@ -0,0 +1,181 @@ +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} + +module Bots.BadgeService.FakePlay + ( FakePlay (..), + PlayAnswer (..), + withFakePlay, + answerPurchase, + answerAcknowledgements, + answerTokenRequests, + grantTokensFor, + fakePackageName, + ) +where + +import BadgeService.Config (PlayStoreConfig (..)) +import Control.Concurrent (threadDelay) +import Control.Concurrent.STM +import Control.Monad (forever) +import Crypto.Hash.Algorithms (SHA256 (..)) +import Crypto.Number.Serialize (i2osp) +import qualified Crypto.PubKey.RSA as RSA +import qualified Crypto.PubKey.RSA.PKCS15 as RSA +import qualified Data.Aeson as J +import qualified Data.Aeson.KeyMap as KM +import qualified Data.ByteString as B +import qualified Data.ByteString.Base64 as B64 +import qualified Data.ByteString.Base64.URL as B64U +import qualified Data.ByteString.Char8 as B8 +import qualified Data.ByteString.Lazy as LB +import qualified Data.Map.Strict as M +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (decodeUtf8) +import Network.HTTP.Types (Status, badRequest400, hAuthorization, hContentType, methodGet, methodPost, mkStatus, notFound404, ok200, parseSimpleQuery, unauthorized401) +import Network.Wai (Application, Response, pathInfo, requestHeaders, requestMethod, responseLBS, strictRequestBody) +import qualified Network.Wai.Handler.Warp as Warp +import System.Directory (createDirectoryIfMissing) +import System.FilePath (()) +import UnliftIO.Temporary (withTempDirectory) + +data PlayAnswer = PlayRecord J.Value | PlayBody LB.ByteString | PlayStatus Int | PlayHang + +data FakePlay = FakePlay + { fpConfig :: PlayStoreConfig, + fpAnswers :: TVar (M.Map Text PlayAnswer), + -- a status the token endpoint answers instead of granting + fpTokenRefusal :: TVar (Maybe Int), + fpTokenSeconds :: TVar Int, + fpGrantedTokens :: TVar [B.ByteString], + fpPurchasePaths :: TVar [[Text]], + fpAcknowledgeRefusal :: TVar (Maybe Int), + fpAcknowledged :: TVar [Text] + } + +fakePackageName :: Text +fakePackageName = "chat.simplex.app" + +fakeClientEmail :: Text +fakeClientEmail = "badge-verifier@simplex-badges-test.iam.gserviceaccount.com" + +-- | Warp chooses the port, so a server left over from an earlier run cannot answer instead. +-- The service account key is made per run, since a committed one trips secret scanning. +withFakePlay :: (FakePlay -> IO a) -> IO a +withFakePlay action = do + (key, privateKey) <- RSA.generate 128 65537 + fpAnswers <- newTVarIO M.empty + fpTokenRefusal <- newTVarIO Nothing + fpTokenSeconds <- newTVarIO 3600 + fpGrantedTokens <- newTVarIO [] + fpPurchasePaths <- newTVarIO [] + fpAcknowledgeRefusal <- newTVarIO Nothing + fpAcknowledged <- newTVarIO [] + createDirectoryIfMissing True "tests/tmp" + withTempDirectory "tests/tmp" "fake-play" $ \d -> do + let accountFile = d "service-account.json" + fake base = + FakePlay + { fpConfig = PlayStoreConfig {gPackageName = fakePackageName, gServiceAccountFile = accountFile, gApiHost = base, gTokenUrl = base <> "/token"}, + fpAnswers, + fpTokenRefusal, + fpTokenSeconds, + fpGrantedTokens, + fpPurchasePaths, + fpAcknowledgeRefusal, + fpAcknowledged + } + LB.writeFile accountFile $ J.encode $ J.object ["client_email" J..= fakeClientEmail, "private_key" J..= decodeUtf8 (pkcs8Pem privateKey)] + Warp.testWithApplication (pure $ \req respond -> fakeApp key (fake $ origin req) req respond) $ \prt -> + action (fake $ "http://127.0.0.1:" <> T.pack (show prt)) + where + -- the app needs the base URL for the audience it checks, and the request names the port it reached + origin req = maybe "" (("http://" <>) . T.pack . B8.unpack) (lookup "Host" (requestHeaders req)) + +-- | The PKCS#8 PEM Google puts in a service account key, so the service's own parser reads it. +pkcs8Pem :: RSA.PrivateKey -> B.ByteString +pkcs8Pem k = + "-----BEGIN PRIVATE KEY-----\n" <> B8.unlines (chunks $ B64.encode pkcs8) <> "-----END PRIVATE KEY-----\n" + where + RSA.PublicKey {RSA.public_n, RSA.public_e} = RSA.private_pub k + pkcs8 = der 0x30 $ derInteger 0 <> der 0x30 (rsaEncryption <> "\x05\x00") <> der 0x04 pkcs1 + pkcs1 = der 0x30 $ foldMap derInteger [0, public_n, public_e, RSA.private_d k, RSA.private_p k, RSA.private_q k, RSA.private_dP k, RSA.private_dQ k, RSA.private_qinv k] + rsaEncryption = der 0x06 "\x2a\x86\x48\x86\xf7\x0d\x01\x01\x01" + derInteger n = der 0x02 $ case i2osp n of + bs | B.null bs || B.head bs >= 0x80 -> B.cons 0 bs + bs -> bs + der tag content = B.pack (tag : derLength (B.length content)) <> content + derLength n + | n < 0x80 = [fromIntegral n] + | otherwise = let bs = B.unpack (i2osp $ toInteger n) in 0x80 + fromIntegral (length bs) : bs + chunks bs + | B.null bs = [] + | otherwise = let (line, rest) = B.splitAt 64 bs in line : chunks rest + +answerPurchase :: FakePlay -> Text -> PlayAnswer -> IO () +answerPurchase FakePlay {fpAnswers} token answer = atomically $ modifyTVar' fpAnswers $ M.insert token answer + +answerTokenRequests :: FakePlay -> Maybe Int -> IO () +answerTokenRequests FakePlay {fpTokenRefusal} = atomically . writeTVar fpTokenRefusal + +grantTokensFor :: FakePlay -> Int -> IO () +grantTokensFor FakePlay {fpTokenSeconds} = atomically . writeTVar fpTokenSeconds + +answerAcknowledgements :: FakePlay -> Maybe Int -> IO () +answerAcknowledgements FakePlay {fpAcknowledgeRefusal} = atomically . writeTVar fpAcknowledgeRefusal + +fakeApp :: RSA.PublicKey -> FakePlay -> Application +fakeApp key FakePlay {fpConfig = PlayStoreConfig {gTokenUrl}, fpAnswers, fpTokenRefusal, fpTokenSeconds, fpGrantedTokens, fpPurchasePaths, fpAcknowledgeRefusal, fpAcknowledged} req respond = + case (requestMethod req, pathInfo req) of + (m, ["token"]) | m == methodPost -> strictRequestBody req >>= grant + (m, path@["androidpublisher", "v3", "applications", pkg, "purchases", "products", _, "tokens", token]) + | m == methodGet && pkg == fakePackageName -> authorized $ do + atomically $ modifyTVar' fpPurchasePaths (<> [path]) + purchase token + | m == methodPost && pkg == fakePackageName, Just acknowledgedToken <- T.stripSuffix ":acknowledge" token -> authorized $ acknowledge acknowledgedToken + _ -> respond $ status notFound404 + where + authorized act = do + granted <- readTVarIO fpGrantedTokens + case lookup hAuthorization (requestHeaders req) of + Just auth | Just bearer <- B.stripPrefix "Bearer " auth, take 1 (reverse granted) == [bearer] -> act + _ -> respond $ status unauthorized401 + acknowledge token = + readTVarIO fpAcknowledgeRefusal >>= \case + Just code -> respond $ status (mkStatus code "Refused") + Nothing -> do + atomically $ modifyTVar' fpAcknowledged (<> [token]) + respond $ responseLBS ok200 [] "" + grant body = + readTVarIO fpTokenRefusal >>= \case + Just code -> respond $ status (mkStatus code "Refused") + Nothing + | validAssertion (parseSimpleQuery $ LB.toStrict body) -> do + bearer <- atomically $ stateTVar fpGrantedTokens $ \ts -> let t = "fake-access-" <> B8.pack (show (length ts)) in (t, ts <> [t]) + seconds <- readTVarIO fpTokenSeconds + respond $ json ok200 $ J.object ["access_token" J..= B8.unpack bearer, "expires_in" J..= seconds, "token_type" J..= ("Bearer" :: Text)] + | otherwise -> respond $ json badRequest400 $ J.object ["error" J..= ("invalid_grant" :: Text)] + validAssertion form = case (lookup "grant_type" form, B8.split '.' <$> lookup "assertion" form) of + (Just "urn:ietf:params:oauth:grant-type:jwt-bearer", Just [header, claims, sig]) + | Right sigBytes <- B64U.decodeUnpadded sig, + RSA.verify (Just SHA256) key (header <> "." <> claims) sigBytes, + Right claimBytes <- B64U.decodeUnpadded claims, + Just (J.Object c) <- J.decodeStrict' claimBytes -> + KM.lookup "aud" c == Just (J.String gTokenUrl) + && KM.lookup "scope" c == Just (J.String "https://www.googleapis.com/auth/androidpublisher") + && KM.lookup "iss" c == Just (J.String fakeClientEmail) + _ -> False + purchase token = + M.lookup token <$> readTVarIO fpAnswers >>= \case + Just (PlayRecord v) -> respond $ json ok200 v + Just (PlayBody b) -> respond $ responseLBS ok200 [(hContentType, "application/json")] b + Just (PlayStatus code) -> respond $ status (mkStatus code "Answer") + Just PlayHang -> forever $ threadDelay 1000000 + Nothing -> respond $ status notFound404 + +json :: Status -> J.Value -> Response +json st = responseLBS st [(hContentType, "application/json")] . J.encode + +status :: Status -> Response +status st = json st $ J.object ["error" J..= J.object ["code" J..= show st]] diff --git a/tests/Bots/BadgeService/FakeStore.hs b/tests/Bots/BadgeService/FakeStore.hs index 986351c47f..bede2de8e7 100644 --- a/tests/Bots/BadgeService/FakeStore.hs +++ b/tests/Bots/BadgeService/FakeStore.hs @@ -72,7 +72,7 @@ newFakeStore = do ] verifyApple jws | jws == appleThrowingJWS = error "fake verifier bug" - | otherwise = maybe (Left "not a fake receipt") Right $ lookup jws appleReceipts + | otherwise = maybe (Left $ SRInvalid "not a fake receipt") Right $ lookup jws appleReceipts verifyGoogle = googleVerdict pendingSettled googleDown pure FakeStore @@ -84,7 +84,7 @@ newFakeStore = do appleQuantityJWS, pendingSettled, googleDown, - fakeVerifier = StoreVerifier {verifyApple = Just verifyApple, verifyGoogle = Just verifyGoogle, verifyTimeout = 500000} + fakeVerifier = StoreVerifier {verifyApple = Just verifyApple, verifyGoogle = Just verifyGoogle, acknowledgeGoogle = Nothing, verifyTimeout = 500000} } where fixtureJWS name = unsignedJWS <$> B.readFile (fixtureDir name) diff --git a/tests/Bots/BadgeService/StoreVerifierTests.hs b/tests/Bots/BadgeService/StoreVerifierTests.hs new file mode 100644 index 0000000000..be4e6f2e26 --- /dev/null +++ b/tests/Bots/BadgeService/StoreVerifierTests.hs @@ -0,0 +1,560 @@ +{-# LANGUAGE DuplicateRecordFields #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} + +module Bots.BadgeService.StoreVerifierTests (badgeStoreVerifierTests) where + +import BadgeService.Config (PlayStoreConfig (..), ServiceConfig (..), readServiceConfig) +import BadgeService.Service (ServiceState (..), configureStoreVerifier, newServiceState) +import BadgeService.StoreReceipts +import BadgeService.StoreReceipts.Apple (readAppleRoot, verifyAppleTransaction) +import BadgeService.StoreReceipts.Google (playStoreVerifier) +import Bots.BadgeService.FakePlay +import Control.Concurrent.STM (readTVarIO) +import Control.Monad (forM_) +import Crypto.Hash.Algorithms (SHA256 (..)) +import Crypto.Number.Serialize (i2osp, i2ospOf_) +import qualified Crypto.PubKey.ECC.ECDSA as ECDSA +import qualified Crypto.PubKey.ECC.Generate as ECC +import qualified Crypto.PubKey.ECC.Types as ECC +import qualified Data.Aeson as J +import qualified Data.Aeson.KeyMap as KM +import Data.ByteString (ByteString) +import qualified Data.ByteString as B +import qualified Data.ByteString.Base64 as B64 +import qualified Data.ByteString.Base64.URL as B64U +import qualified Data.ByteString.Lazy as LB +import Data.Hourglass (Date (..), DateTime (..), Month (..), TimeOfDay (..)) +import Data.List (isInfixOf) +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (decodeUtf8) +import Data.X509 +import Simplex.Chat.PaymentService (ServicePayment (..), appleTransactionId, googlePurchaseRef) +import Simplex.Chat.PaymentService.Types (CurrencyAmount (..)) +import System.Directory (createDirectoryIfMissing) +import System.FilePath (takeDirectory, ()) +import Test.Hspec +import UnliftIO.Temporary (withTempDirectory) + +badgeStoreVerifierTests :: Spec +badgeStoreVerifierTests = describe "badge store verifiers" $ do + describe "App Store signed transactions" $ do + it "vouches for a transaction a chain to the trusted root signed, naming the transaction it was claimed by" testAppleVerdict + it "fails, rather than refuses, an intermediate the trusted root did not sign, since the root may be misconfigured" testAppleRootNotTrusted + it "refuses a leaf the intermediate did not sign, though the intermediate is genuine" testAppleForgedLeaf + it "fails, rather than refuses, a leaf signature the library cannot check" testAppleLeafUncheckable + it "refuses a tampered payload" testAppleTamperedPayload + it "fails, rather than refuses, a chain that is not exactly leaf, intermediate and root, a shape Apple may yet adopt" testAppleChainLength + it "fails, rather than refuses, a header that names another algorithm, a shape Apple may yet adopt" testAppleOtherAlgorithm + it "fails, rather than refuses, another app's bundle id, since ours may be misconfigured" testAppleOtherBundle + it "refuses a refunded transaction" testAppleRevoked + it "reports a Sandbox transaction as a test purchase" testAppleSandbox + it "fails, rather than refuses, a chain Apple did not mark for signing receipts" testAppleUnmarkedChain + it "fails, rather than refuses, a payload Apple signed in a shape it does not know" testAppleUnknownShape + it "fails, rather than refuses, a leaf holding a key it cannot read" testAppleLeafKey + it "records the price in the currency's minor units, or not at all" testApplePrice + it "reads the trusted root from a DER file, and reports one it cannot read" testReadAppleRoot + it "has nothing to acknowledge" testAppleNoAcknowledgement + describe "Google Play purchases" $ do + it "vouches for a purchased token, asking Play about that token in this app" testPlayPurchased + it "reports a license tester's purchase as a test purchase, and a promo code's as paid" testPlayTestAndPromo + it "refuses a canceled purchase" testPlayCanceled + it "answers a pending purchase as pending" testPlayPending + it "answers 404, 5xx and every other error but 401 and 403 as unreachable" testPlayErrorStatuses + it "fails on 401 and 403, and asks for a new access token after a 401" testPlayCredentialsRefused + it "fails when the token endpoint refuses the assertion, and is unreachable when it is down" testPlayTokenEndpoint + it "fails on a body it cannot read, another product, or an unknown state" testPlayUnreadable + it "answers a Play that does not answer, or cannot be reached, as unreachable" testPlayHangsOrIsGone + it "reuses its access token while it is valid" testPlayTokenCached + it "asks for a new access token once the one it holds is about to expire" testPlayTokenExpires + it "sends no token that is only dots, and describes a token outside the grammar without quoting it" testPlayTokensNotSent + it "acknowledges a purchase, unless it is acknowledged or consumed already" testPlayAcknowledges + it "reports an acknowledgement Play refuses or does not answer" testPlayAcknowledgementFails + it "acknowledges through the verifier a [google] section configures" testPlayConfiguredAcknowledges + +-- * App Store + +-- TestPurchase is the service's own refusal after a verifier vouched, so no verifier returns it here +data Outcome = Invalid | TestPurchase | Pending | Unreachable | Failed | NotConfigured | Verdict + deriving (Eq, Show) + +outcome :: Either StoreRefusal a -> Outcome +outcome = \case + Left (SRInvalid _) -> Invalid + Left SRTestPurchase -> TestPurchase + Left SRPending -> Pending + Left (SRUnreachable _) -> Unreachable + Left (SRVerifierFailed _) -> Failed + Left SRNotConfigured -> NotConfigured + Right _ -> Verdict + +reason :: Either StoreRefusal a -> Text +reason = \case + Left (SRInvalid r) -> r + Left (SRUnreachable r) -> r + Left (SRVerifierFailed r) -> r + _ -> "" + +seamVerdict :: StoreVerifier -> ServicePayment -> IO (Either StoreRefusal VerifiedStoreTransaction) +seamVerdict verifier payment = case toStoreReceipt verifier payment of + Just (Right StoreReceipt {verifyReceipt}) -> verifyReceipt + Just (Left refusal) -> pure $ Left refusal + Nothing -> expectationFailure "not a store payment" >> undefined + +ourBundleId :: Text +ourBundleId = "chat.simplex.app" + +appleVerdict :: SignedCertificate -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +appleVerdict root jws = seamVerdict noStoreVerifier {verifyApple = Just (verifyAppleTransaction root ourBundleId)} SPApple {jws} + +data TestChain = TestChain + { rootCert :: SignedCertificate, + intermediateCert :: SignedCertificate, + leafCert :: SignedCertificate, + intermediateKey :: ECDSA.PrivateKey, + leafKey :: ECDSA.PrivateKey + } + +appleRootName, otherRootName, intermediateName, leafName :: DistinguishedName +appleRootName = DistinguishedName [([2, 5, 4, 3], "Apple Root CA - G3")] +otherRootName = DistinguishedName [([2, 5, 4, 3], "Some Other Root")] +intermediateName = DistinguishedName [([2, 5, 4, 3], "Apple Worldwide Developer Relations Certification Authority")] +leafName = DistinguishedName [([2, 5, 4, 3], "Prod ECC Mac App Store and iTunes Store Receipt Signing")] + +receiptLeafMarker, intermediateMarker :: [Integer] +receiptLeafMarker = [1, 2, 840, 113635, 100, 6, 11, 1] +intermediateMarker = [1, 2, 840, 113635, 100, 6, 2, 1] + +-- | Shaped as Apple's chain, under a root of the given name; the intermediate and the leaf carry the given markers. +newChain :: DistinguishedName -> [[Integer]] -> [[Integer]] -> IO TestChain +newChain rootName intermediateMarkers leafMarkers = do + (rootKey, rootPub) <- newKeyPair + (intermediateKey, intermediatePub) <- newKeyPair + (leafKey, leafPub) <- newKeyPair + rootCert <- certify rootKey rootName rootName rootPub [] + intermediateCert <- certify rootKey rootName intermediateName intermediatePub intermediateMarkers + leafCert <- certify intermediateKey intermediateName leafName leafPub leafMarkers + pure TestChain {rootCert, intermediateCert, leafCert, intermediateKey, leafKey} + +trustedChain :: IO TestChain +trustedChain = newChain appleRootName [intermediateMarker] [receiptLeafMarker] + +newKeyPair :: IO (ECDSA.PrivateKey, PubKey) +newKeyPair = do + (ECDSA.PublicKey _ q, k) <- ECC.generate p256 + case q of + ECC.Point x y -> pure (k, PubKeyEC $ PubKeyEC_Named ECC.SEC_p256r1 $ SerializedPoint $ B.cons 4 $ i2ospOf_ 32 x <> i2ospOf_ 32 y) + ECC.PointO -> newKeyPair + +p256 :: ECC.Curve +p256 = ECC.getCurveByName ECC.SEC_p256r1 + +certify :: ECDSA.PrivateKey -> DistinguishedName -> DistinguishedName -> PubKey -> [[Integer]] -> IO SignedCertificate +certify = certifyWith $ SignatureALG HashSHA256 PubKeyALG_EC + +certifyWith :: SignatureALG -> ECDSA.PrivateKey -> DistinguishedName -> DistinguishedName -> PubKey -> [[Integer]] -> IO SignedCertificate +certifyWith alg issuerKey issuerName subjectName subjectKey markers = + objectToSignedExactF sign certificate + where + certificate = + Certificate + { certVersion = 2, + certSerial = 1, + certSignatureAlg = alg, + certIssuerDN = issuerName, + certValidity = (DateTime (Date 2020 January 1) (TimeOfDay 0 0 0 0), DateTime (Date 2040 January 1) (TimeOfDay 0 0 0 0)), + certSubjectDN = subjectName, + certPubKey = subjectKey, + certExtensions = Extensions $ Just [ExtensionRaw oid False "\x05\x00" | oid <- markers] + } + sign tbs = (\(ECDSA.Signature r s) -> (derSignature r s, alg)) <$> ECDSA.sign issuerKey SHA256 tbs + derSignature r s = der 0x30 (der 0x02 (unsigned r) <> der 0x02 (unsigned s)) + der tag content = B.pack [tag, fromIntegral (B.length content)] <> content + unsigned n = let bs = i2osp n in if B.head bs >= 0x80 then B.cons 0 bs else bs + +transactionPayload :: [(J.Key, J.Value)] -> [J.Key] -> J.Value +transactionPayload overrides removed = + J.Object $ foldr KM.delete (KM.fromList overrides `KM.union` base) removed + where + base = + KM.fromList + [ ("transactionId", "2000000900000001"), + ("originalTransactionId", "2000000900000001"), + ("bundleId", J.String ourBundleId), + ("productId", "BADGE_SUPPORTER_01"), + ("purchaseDate", J.toJSON (1790000000000 :: Int)), + ("quantity", J.toJSON (1 :: Int)), + ("type", "Consumable"), + ("inAppOwnershipType", "PURCHASED"), + ("signedDate", J.toJSON (1790000001000 :: Int)), + ("environment", "Production"), + ("transactionReason", "PURCHASE"), + ("storefront", "USA"), + ("price", J.toJSON (7000 :: Int)), + ("currency", "USD") + ] + +signedTransaction :: TestChain -> [SignedCertificate] -> J.Value -> J.Value -> IO Text +signedTransaction TestChain {leafKey} x5c header payload = do + let signingInput = segment header' <> "." <> segment payload + header' = case header of + J.Object h -> J.Object $ KM.insert "x5c" (J.toJSON $ map (decodeUtf8 . B64.encode . encodeSignedObject) x5c) h + v -> v + ECDSA.Signature r s <- ECDSA.sign leafKey SHA256 signingInput + pure $ decodeUtf8 $ signingInput <> "." <> B64U.encodeUnpadded (i2ospOf_ 32 r <> i2ospOf_ 32 s) + +segment :: J.Value -> ByteString +segment = B64U.encodeUnpadded . LB.toStrict . J.encode + +es256 :: J.Value +es256 = J.object ["alg" J..= ("ES256" :: Text)] + +signedBy :: TestChain -> J.Value -> IO Text +signedBy chain@TestChain {rootCert, intermediateCert, leafCert} = signedTransaction chain [leafCert, intermediateCert, rootCert] es256 + +testAppleVerdict :: IO () +testAppleVerdict = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [] [] + appleVerdict (rootCert chain) jws + `shouldReturn` Right VerifiedStoreTransaction {transactionRef = "2000000900000001", productId = "BADGE_SUPPORTER_01", quantity = 1, testPurchase = False, paid = Just (CurrencyAmount 700, "USD")} + appleTransactionId jws `shouldBe` Just "2000000900000001" + +testAppleRootNotTrusted :: IO () +testAppleRootNotTrusted = do + trusted <- trustedChain + forM_ [appleRootName, otherRootName] $ \rootName -> do + untrusted <- newChain rootName [intermediateMarker] [receiptLeafMarker] + jws <- signedBy untrusted $ transactionPayload [] [] + r <- appleVerdict (rootCert trusted) jws + outcome r `shouldBe` Failed + reason r `shouldSatisfy` ("configured root" `T.isInfixOf`) + +testAppleForgedLeaf :: IO () +testAppleForgedLeaf = do + chain@TestChain {rootCert, intermediateCert} <- trustedChain + (forgedKey, forgedPub) <- newKeyPair + forgedLeaf <- certify forgedKey intermediateName leafName forgedPub [receiptLeafMarker] + jws <- signedTransaction chain {leafKey = forgedKey} [forgedLeaf, intermediateCert, rootCert] es256 $ transactionPayload [] [] + outcome <$> appleVerdict rootCert jws `shouldReturn` Invalid + +testAppleLeafUncheckable :: IO () +testAppleLeafUncheckable = do + chain@TestChain {rootCert, intermediateCert} <- trustedChain + (otherKey, otherPub) <- newKeyPair + rsaLabelled <- certifyWith (SignatureALG HashSHA256 PubKeyALG_RSA) otherKey intermediateName leafName otherPub [receiptLeafMarker] + jws <- signedTransaction chain {leafKey = otherKey} [rsaLabelled, intermediateCert, rootCert] es256 $ transactionPayload [] [] + r <- appleVerdict rootCert jws + outcome r `shouldBe` Failed + reason r `shouldSatisfy` ("cannot check" `T.isInfixOf`) + +testAppleTamperedPayload :: IO () +testAppleTamperedPayload = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [] [] + case T.splitOn "." jws of + [header, _, signature] -> do + let tampered = T.intercalate "." [header, decodeUtf8 $ segment $ transactionPayload [("productId", "BADGE_LEGEND_01")] [], signature] + outcome <$> appleVerdict (rootCert chain) tampered `shouldReturn` Invalid + _ -> expectationFailure "not a JWS" + +testAppleChainLength :: IO () +testAppleChainLength = do + chain@TestChain {rootCert, intermediateCert, leafCert} <- trustedChain + forM_ [[leafCert, rootCert], [leafCert, intermediateCert], [leafCert, intermediateCert, rootCert, rootCert]] $ \x5c -> do + jws <- signedTransaction chain x5c es256 $ transactionPayload [] [] + outcome <$> appleVerdict rootCert jws `shouldReturn` Failed + +testAppleOtherAlgorithm :: IO () +testAppleOtherAlgorithm = do + chain@TestChain {rootCert, intermediateCert, leafCert} <- trustedChain + let x5c = [leafCert, intermediateCert, rootCert] + forM_ ["none", "HS256", "ES384"] $ \alg -> do + jws <- signedTransaction chain x5c (J.object ["alg" J..= (alg :: Text)]) $ transactionPayload [] [] + outcome <$> appleVerdict rootCert jws `shouldReturn` Failed + +testAppleOtherBundle :: IO () +testAppleOtherBundle = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [("bundleId", "com.example.other")] [] + r <- appleVerdict (rootCert chain) jws + outcome r `shouldBe` Failed + reason r `shouldSatisfy` ("bundle id" `T.isInfixOf`) + +testAppleRevoked :: IO () +testAppleRevoked = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [("revocationDate", J.toJSON (1790000500000 :: Int)), ("revocationReason", J.toJSON (0 :: Int))] [] + outcome <$> appleVerdict (rootCert chain) jws `shouldReturn` Invalid + +testAppleSandbox :: IO () +testAppleSandbox = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [("environment", "Sandbox")] [] + fmap testPurchase <$> appleVerdict (rootCert chain) jws `shouldReturn` Right True + +testAppleUnmarkedChain :: IO () +testAppleUnmarkedChain = + forM_ [([intermediateMarker], []), ([], [receiptLeafMarker])] $ \(intermediateMarkers, leafMarkers) -> do + unmarked <- newChain appleRootName intermediateMarkers leafMarkers + jws <- signedBy unmarked $ transactionPayload [] [] + outcome <$> appleVerdict (rootCert unmarked) jws `shouldReturn` Failed + +testAppleUnknownShape :: IO () +testAppleUnknownShape = do + chain <- trustedChain + let failsOn payload = do + jws <- signedBy chain payload + outcome <$> appleVerdict (rootCert chain) jws `shouldReturn` Failed + failsOn $ transactionPayload [("environment", "Staging")] [] + failsOn $ transactionPayload [("environment", "Xcode")] [] + failsOn $ transactionPayload [("environment", "LocalTesting")] [] + failsOn $ transactionPayload [] ["productId"] + failsOn $ transactionPayload [("quantity", "1")] [] + +-- | The key is read before the signature it would check, so the chain and the payload are genuine. +testAppleLeafKey :: IO () +testAppleLeafKey = do + chain@TestChain {rootCert, intermediateCert, intermediateKey} <- trustedChain + let failsOnLeafKey pub = do + leaf <- certify intermediateKey intermediateName leafName pub [receiptLeafMarker] + jws <- signedTransaction chain [leaf, intermediateCert, rootCert] es256 $ transactionPayload [] [] + outcome <$> appleVerdict rootCert jws `shouldReturn` Failed + failsOnLeafKey $ PubKeyEC $ PubKeyEC_Named ECC.SEC_p384r1 $ SerializedPoint $ B.cons 4 $ B.replicate 64 1 + failsOnLeafKey $ PubKeyEC $ PubKeyEC_Named ECC.SEC_p256r1 $ SerializedPoint "\x04" + +testApplePrice :: IO () +testApplePrice = do + chain <- trustedChain + let paidFor fields removed = do + jws <- signedBy chain $ transactionPayload fields removed + fmap paid <$> appleVerdict (rootCert chain) jws + priced price currency = paidFor [("price", J.toJSON (price :: Int)), ("currency", currency)] [] + -- Apple's own examples: $1.99, JPY 300 and KRW 3300 + priced 1990 "USD" `shouldReturn` Right (Just (CurrencyAmount 199, "USD")) + priced 300000 "JPY" `shouldReturn` Right (Just (CurrencyAmount 300, "JPY")) + priced 3300000 "KRW" `shouldReturn` Right (Just (CurrencyAmount 3300, "KRW")) + priced 1234 "KWD" `shouldReturn` Right (Just (CurrencyAmount 1234, "KWD")) + priced 1995 "USD" `shouldReturn` Right Nothing + priced 1000 "CLF" `shouldReturn` Right Nothing + priced 1000 "usd" `shouldReturn` Right Nothing + paidFor [] ["price", "currency"] `shouldReturn` Right Nothing + +testReadAppleRoot :: IO () +testReadAppleRoot = do + TestChain {rootCert} <- trustedChain + createDirectoryIfMissing True "tests/tmp" + withTempDirectory "tests/tmp" "apple-root" $ \d -> do + B.writeFile (d "root.cer") (encodeSignedObject rootCert) + readAppleRoot (d "root.cer") `shouldReturn` Right rootCert + B.writeFile (d "root.pem") "-----BEGIN CERTIFICATE-----\n" + readAppleRoot (d "root.pem") >>= (`shouldSatisfy` either ("not a DER certificate" `isInfixOf`) (const False)) + readAppleRoot (d "absent.cer") >>= (`shouldSatisfy` either ("could not be read" `isInfixOf`) (const False)) + +testAppleNoAcknowledgement :: IO () +testAppleNoAcknowledgement = do + chain <- trustedChain + jws <- signedBy chain $ transactionPayload [] [] + withFakePlay $ \fake -> do + verifier <- playVerifier fake + acknowledgement verifier {verifyApple = Just (verifyAppleTransaction (rootCert chain) ourBundleId)} SPApple {jws} `shouldReturn` Nothing + +-- * Google Play + +playVerifier :: FakePlay -> IO StoreVerifier +playVerifier fake = + playStoreVerifier (fpConfig fake) >>= \case + Right (verify, acknowledge) -> pure noStoreVerifier {verifyGoogle = Just verify, acknowledgeGoogle = Just acknowledge, verifyTimeout = 2000000} + Left e -> expectationFailure e >> undefined + +acknowledgement :: StoreVerifier -> ServicePayment -> IO (Maybe (Either StoreRefusal ())) +acknowledgement verifier payment = case toStoreReceipt verifier payment of + Just (Right StoreReceipt {acknowledgeReceipt}) -> sequence acknowledgeReceipt + _ -> expectationFailure "not a store receipt" >> undefined + +playVerdict :: StoreVerifier -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +playVerdict verifier token = seamVerdict verifier SPGoogle {productId = "badge_supporter_01", token} + +purchaseRecord :: Int -> [(J.Key, J.Value)] -> J.Value +purchaseRecord state fields = + J.Object $ + KM.fromList fields + `KM.union` KM.fromList + [ ("kind", "androidpublisher#productPurchase"), + ("purchaseTimeMillis", "1790000000000"), + ("purchaseState", J.toJSON state), + ("consumptionState", J.toJSON (0 :: Int)), + ("orderId", "GPA.3312-4521-8899-01234"), + ("acknowledgementState", J.toJSON (0 :: Int)), + ("regionCode", "US") + ] + +testToken :: Text +testToken = "fake-play-token.AO-J1Oz9x2kqE7wYt3" + +-- | Every reason reaches the service's log, which must never hold the token. +answeredAs :: StoreVerifier -> Text -> Outcome -> IO () +answeredAs verifier token expected = do + r <- playVerdict verifier token + outcome r `shouldBe` expected + reason r `shouldNotSatisfy` (token `T.isInfixOf`) + +testPlayPurchased :: IO () +testPlayPurchased = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + playVerdict verifier testToken + `shouldReturn` Right VerifiedStoreTransaction {transactionRef = googlePurchaseRef testToken, productId = "badge_supporter_01", quantity = 1, testPurchase = False, paid = Nothing} + readTVarIO (fpPurchasePaths fake) + `shouldReturn` [["androidpublisher", "v3", "applications", fakePackageName, "purchases", "products", "badge_supporter_01", "tokens", testToken]] + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [("quantity", J.toJSON (2 :: Int)), ("productId", "badge_supporter_01")] + fmap quantity <$> playVerdict verifier testToken `shouldReturn` Right 2 + +testPlayTestAndPromo :: IO () +testPlayTestAndPromo = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [("purchaseType", J.toJSON (0 :: Int))] + fmap testPurchase <$> playVerdict verifier testToken `shouldReturn` Right True + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [("purchaseType", J.toJSON (1 :: Int))] + fmap testPurchase <$> playVerdict verifier testToken `shouldReturn` Right False + +testPlayCanceled :: IO () +testPlayCanceled = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 1 [] + answeredAs verifier testToken Invalid + +testPlayPending :: IO () +testPlayPending = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 2 [] + answeredAs verifier testToken Pending + +testPlayErrorStatuses :: IO () +testPlayErrorStatuses = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answeredAs verifier testToken Unreachable + forM_ [400, 404, 410, 429, 500, 503] $ \code -> do + answerPurchase fake testToken $ PlayStatus code + answeredAs verifier testToken Unreachable + +testPlayCredentialsRefused :: IO () +testPlayCredentialsRefused = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayStatus 403 + answeredAs verifier testToken Failed + answerPurchase fake testToken $ PlayStatus 401 + answeredAs verifier testToken Failed + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + answeredAs verifier testToken Verdict + length <$> readTVarIO (fpGrantedTokens fake) `shouldReturn` 2 + +testPlayTokenEndpoint :: IO () +testPlayTokenEndpoint = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + forM_ [400, 401] $ \code -> do + answerTokenRequests fake $ Just code + answeredAs verifier testToken Failed + forM_ [429, 503] $ \code -> do + answerTokenRequests fake $ Just code + answeredAs verifier testToken Unreachable + answerTokenRequests fake Nothing + answeredAs verifier testToken Verdict + readTVarIO (fpPurchasePaths fake) >>= (`shouldSatisfy` ((== 1) . length)) + +testPlayUnreadable :: IO () +testPlayUnreadable = withFakePlay $ \fake -> do + verifier <- playVerifier fake + forM_ + [ PlayBody "not json", + PlayBody "{\"purchaseState\":\"0\"}", + PlayRecord $ J.object ["kind" J..= ("androidpublisher#productPurchase" :: Text)], + PlayRecord $ purchaseRecord 0 [("productId", "badge_legend_01")], + PlayRecord $ purchaseRecord 3 [], + PlayRecord $ purchaseRecord 0 [("purchaseType", J.toJSON (2 :: Int))], + PlayBody $ J.encode (purchaseRecord 0 []) <> LB.replicate (1024 * 1024) 32 + ] + $ \answer -> do + answerPurchase fake testToken answer + answeredAs verifier testToken Failed + +testPlayHangsOrIsGone :: IO () +testPlayHangsOrIsGone = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken PlayHang + r <- playVerdict verifier testToken + (outcome r, reason r) `shouldBe` (Unreachable, "google verifier timed out") + -- not a stopped stub's port, which a test running alongside may already have been given + gone <- playVerifier fake {fpConfig = (fpConfig fake) {gApiHost = "http://127.0.0.1:1"}} + answeredAs gone testToken Unreachable + +testPlayTokenCached :: IO () +testPlayTokenCached = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + answeredAs verifier testToken Verdict + answeredAs verifier testToken Verdict + length <$> readTVarIO (fpGrantedTokens fake) `shouldReturn` 1 + +testPlayTokenExpires :: IO () +testPlayTokenExpires = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + grantTokensFor fake 300 + answeredAs verifier testToken Verdict + answeredAs verifier testToken Verdict + length <$> readTVarIO (fpGrantedTokens fake) `shouldReturn` 2 + +testPlayTokensNotSent :: IO () +testPlayTokensNotSent = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answeredAs verifier ".." Unreachable + let outside = "fake/play+token=AO-J1Oz9x2kqE7wYt3" + r <- playVerdict verifier outside + outcome r `shouldBe` Unreachable + reason r `shouldBe` "a Play token this service will not send: 34 characters: lowercase, uppercase, digits, '-', other printable ASCII" + readTVarIO (fpPurchasePaths fake) `shouldReturn` [] + +testPlayAcknowledges :: IO () +testPlayAcknowledges = withFakePlay $ \fake -> do + verifier <- playVerifier fake + let acknowledging = acknowledgement verifier SPGoogle {productId = "badge_supporter_01", token = testToken} + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + acknowledging `shouldReturn` Just (Right ()) + readTVarIO (fpAcknowledged fake) `shouldReturn` [testToken] + forM_ ["acknowledgementState", "consumptionState"] $ \state -> do + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [(state, J.toJSON (1 :: Int))] + acknowledging `shouldReturn` Just (Right ()) + readTVarIO (fpAcknowledged fake) `shouldReturn` [testToken] + +testPlayAcknowledgementFails :: IO () +testPlayAcknowledgementFails = withFakePlay $ \fake -> do + verifier <- playVerifier fake + let acknowledgedAs expected = do + r <- acknowledgement verifier SPGoogle {productId = "badge_supporter_01", token = testToken} + outcome <$> r `shouldBe` Just expected + maybe "" reason r `shouldSatisfy` ("acknowledging: " `T.isPrefixOf`) + maybe "" reason r `shouldNotSatisfy` (testToken `T.isInfixOf`) + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + answerAcknowledgements fake $ Just 403 + acknowledgedAs Failed + answerAcknowledgements fake $ Just 503 + acknowledgedAs Unreachable + answerAcknowledgements fake Nothing + answerPurchase fake testToken PlayHang + acknowledgedAs Unreachable + readTVarIO (fpAcknowledged fake) `shouldReturn` [] + +testPlayConfiguredAcknowledges :: IO () +testPlayConfiguredAcknowledges = withFakePlay $ \fake@FakePlay {fpConfig} -> do + let ini = takeDirectory (gServiceAccountFile fpConfig) "badge_service.ini" + writeFile ini "[listener]\nstatic_dir = /srv/badges\n" + Right cfg <- readServiceConfig ini + ServiceState {storeVerifier} <- newServiceState >>= configureStoreVerifier (Just cfg {playStore = Just fpConfig}) + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] + acknowledgement storeVerifier SPGoogle {productId = "badge_supporter_01", token = testToken} `shouldReturn` Just (Right ()) + readTVarIO (fpAcknowledged fake) `shouldReturn` [testToken] + diff --git a/tests/Bots/BadgeService/WebTests.hs b/tests/Bots/BadgeService/WebTests.hs index 8365d80b6e..65c5cc3017 100644 --- a/tests/Bots/BadgeService/WebTests.hs +++ b/tests/Bots/BadgeService/WebTests.hs @@ -978,6 +978,8 @@ testServiceConfig staticDir trustForwarded = btcpay = Nothing, stripe = Nothing, poll = PollConfig {pWaitingSeconds = 3, pIdleSeconds = 60}, + appleStore = Nothing, + playStore = Nothing, issuer = Nothing, group = Nothing, devAcceptUnverifiedStoreReceipts = False diff --git a/tests/Test.hs b/tests/Test.hs index 4517a8edb2..ac34f15b0b 100644 --- a/tests/Test.hs +++ b/tests/Test.hs @@ -9,6 +9,7 @@ import Bots.BadgeService.CatalogTests import Bots.BadgeService.ConfigTests import Bots.BadgeService.GroupIntegrationTests import Bots.BadgeService.GroupTests +import Bots.BadgeService.StoreVerifierTests import Bots.BadgeService.StripeTests import Bots.BadgeService.WaitersTests import Bots.BadgeService.WebTests @@ -83,6 +84,7 @@ main = do badgeWaitersTests badgeBTCPayTests badgeStripeTests + badgeStoreVerifierTests describe "SimpleX chat markdown" markdownTests describe "JSON Tests" jsonTests describe "Member relations" memberRelationsTests From 263ac949f3e3b9a0ef0886c852720aee430b8b44 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Tue, 13 Oct 2026 15:25:54 +0000 Subject: [PATCH 12/26] docs: plan for badge top-ups and store subscriptions (#7692) --- .../2026-10-09-badge-topups-subscriptions.md | 447 ++++++++++++++++++ .../2026-10-13-badge-subscription-renewals.md | 353 ++++++++++++++ 2 files changed, 800 insertions(+) create mode 100644 plans/2026-10-09-badge-topups-subscriptions.md create mode 100644 plans/2026-10-13-badge-subscription-renewals.md diff --git a/plans/2026-10-09-badge-topups-subscriptions.md b/plans/2026-10-09-badge-topups-subscriptions.md new file mode 100644 index 0000000000..f43f5d50aa --- /dev/null +++ b/plans/2026-10-09-badge-topups-subscriptions.md @@ -0,0 +1,447 @@ +# Badge top-ups and store subscriptions — design space + +Branch `badge-in-app-checkout` builds a store lane for one-time badge purchases. It is not released. Two things are not built: + +- **Top-up:** buying more months while a badge is shown. +- **Subscriptions:** the stores' monthly and annual plans. + +This document compares two top-up designs, sets out how top-up and subscriptions depend on each other, lists the work and external waits of each step, and lists what the product lead must decide. It is a design space, not an implementation plan. + +## Summary + +**Does one need the other?** + +- Subscriptions do not need top-up, if Subscribe is offered only when no badge is shown and tier changes use a tier-changing grant. +- Top-up A needs nothing from subscriptions. +- Top-up B shares machinery with same-ledger subscriptions: lapse-before-grant and the late-landing problem. + +**Smallest correct top-up: design A.** Store Buy opens in a short window before the shown badge ends. The payment is credited at once as a new purchase that becomes the shown badge. Nothing changes in the service or the ledger. The buyer gives up the overlap, at most the window. + +**Subscriptions on top cost:** + +- service: a charges table, a ledger reader that understands charges, renewal discovery, a database lock, a tier-changing grant, and a verify path for Play subscriptions; +- client core: asking the service at zero months, keeping the badge on until it answers, and the store's expiry on the wire; +- apps: sale, restore, manage and cancel screens; +- external: store subscription setup, notifications, Pub/Sub, quotas, translations. + +**Late-presented renewals.** A grant added before unused months are written off loses the paid month. Writing off first fixes that, but coverage then restarts at presentation, 0–7 days late by default. Dating the grant to the store's billing period removes the drift. + +**Recommendations** (judgement): A for top-up, if subscriptions are far off; same-ledger subscriptions over A-style ones. + +**Decisions for the lead:** review test purchases; A, B, both or neither; A's window and downgrades; subscribing while a badge is shown; Family Sharing; refund clawback in the first release; Play App Signing custody. + +**Top risks:** the store product type; Play's owned-product rule and product identity; refunds while a payment is held; synchronised renewal requests. + +**Biggest open engineering question:** same-ledger subscriptions need a design for charges that land after the badge came off. The only worked fix is broad. + +## Reading notes + +**Labels.** + +- **Fact:** read in code at the place cited, or traced through it. +- **Model:** stated in the draft model, cited by section or line. +- **Judgement:** a conclusion drawn here. +- **Inference:** a consequence of cited facts, not run. +- **Unverified:** Apple or Google behaviour, and intent read from code comments. + +**Sources.** + +- Code is `badge-in-app-checkout` unless marked "vb", the unmerged `f/badge-store-verifiers`. "mq" is simplexmq at `e24d537`. +- The service is under `apps/simplex-badge-service/src/BadgeService/`. Its deployed backend is Postgres, so its `Migrations.hs` is `Store/Postgres/Migrations.hs`. +- Core is under `src/Simplex/Chat/`: `Library/Commands.hs`, `Badges/Ledger.hs`, `Store/Badges.hs`. `Chat.hs` is `src/Simplex/Chat.hs`. +- `M20260915_user_badges.hs` lines are the SQLite variant; the Postgres one is a line earlier. +- `badges-rpc.md` and `badges-overview.md` are under `docs/protocol/`. +- Swift files are under `apps/ios/Shared/`, Kotlin ones under `apps/multiplatform/`. `PlayStore.kt` is the `google` flavour's. +- **Model** is the draft `plans/2026-07-30-supporter-badges-v3-ux.md`. + +**Terms.** + +- **Shown badge:** the purchase in `users.shown_badge_id`. +- **Retirement:** taking the shown badge off at paid-through. +- **Held payment:** a store payment reaching a profile with a shown badge. It waits until retirement. +- **Hand-over:** the app passing a store receipt to core (`APIPurchaseBadge`). A **sweep** hands over every unfinished store purchase. +- **Tip:** a purchase's last ledger entry. **Run:** the months since the ledger's anchor. **Coverage** ends at paid-through. +- **Re-bind:** moving a purchase to new keys after the old keys are lost. +- **Step 1** is the one-time lane's release, which both features build on. + +## How it works today + +**Only the newest purchase is managed** (fact). + +- The badge worker and badge state read the newest purchase (`Store/Badges.hs:398-411`; `Commands.hs:5549`, `:5634`). +- Requests need a shown credential (`Commands.hs:5687-5691`). +- Retirement acts only on a shown newest purchase (`Commands.hs:5827-5835`). + +**While a badge is shown, nothing creates a purchase** (fact). Four guards refuse: + +- invoice creation (`Commands.hs:3587`); +- code redemption (`Commands.hs:5326`); +- store-receipt selection (`Store/Badges.hs:227`); +- store-receipt attempt (`Commands.hs:5529`). + +**When a held payment is credited** (fact unless marked). + +- Only retirement clears the shown badge. +- On iOS, retirement waits for a chat run; background refresh counts. +- On Kotlin, chat is never suspended (`Chat.hs:211`), so retirement happens at paid-through (`Commands.hs:5699-5707`). +- Credit then waits for chat start (`Commands.hs:269`), iOS activation (`:619`) or a hand-over (`:5298`). +- At start and activation, retirement runs asynchronously after the held-receipt check, so credit likely slips to a later trigger (inference). + +**A held payment while it waits.** + +- Its store transaction stays unfinished (fact, `BadgeStore.swift:240-261`). +- On Play it is acknowledged at hand-over but not consumed (fact, `BadgeStore.kt:281-283`), so Play's 3-day auto-refund does not apply. +- Play verification is online; a canceled `purchaseState` is refused (fact, vb `Google.hs:122-128`). Whether a refund sets that state is unverified. +- Apple verification is offline, over the stored transaction (fact, vb `Apple.hs:39-49`; `Store/Badges.hs:136`). A refund during the hold is credited unless the app re-hands a fresh transaction. +- Its product is mapped only at credit (fact, `Service.hs:446-448`; `Catalog.hs:148-154`). An unmapped product is retried daily and never finished (`Commands.hs:5507-5511`, `:5534-5541`). +- Another device on the same Play account sweeps unconsumed purchases (fact, `BadgeStore.kt:353-361`; `PlayStore.kt:103-116`). It records the purchase under its own profile and can credit it first (`Store/Badges.hs:144-148`). The buyer then gets `receipt_used` (`Service.hs:479`). Whether Play lists the purchase there is unverified. +- Whether Apple delivers another device's unfinished consumable is unverified. + +**The ledger** (fact, `Ledger.hs:93-101`). + +- `grantEntry` adds to the balance and keeps the anchor and tier. +- It restarts the run only when the balance is zero. + +**A grant must follow a lapse** (fact, traced). + +- A 2-month code is redeemed on 2 Oct, leaving 1 month unissued from 2 Nov. The app is away until 15 Feb. +- A bare +1 grant gives 2 months from 2 Nov. The next issue writes off min(2, 3) = 2, so the new month is lost. +- Lapsing first writes off 1, and the grant restarts the run on 15 Feb. + +**The service never grants onto an existing purchase** (fact). + +- A purchase starts from an empty ledger (`Service.hs:447-463`, `:489`). +- A receipt under a known key fails on `UNIQUE(purchase_key)` (`M20260915_user_badges.hs:92`) and is answered `internal`. The Play purchase is already acknowledged, so it is paid and never credited. +- Every refusal is answered before any database write (`Service.hs:420-463`). + +**Other facts.** + +- Store one-time months are issued at credit (`Catalog.hs:150-153`; `Service.hs:489-491`). An issued credential stays valid after a refund (model §3, O6). +- A Play quantity other than 1 is answered `internal` (`Service.hs:431-432`, `:471`) and retried forever (`Commands.hs:5732`). It is paid and never credited. +- With vb, Sandbox and licence-tester purchases are refused as `receipt_invalid` (`Service.hs:433`). +- Without vb, a well-formed receipt not credited to the presenting key is answered `provider_not_configured` (`Service.hs:424-427`). A malformed one is refused first, except a Play token failing the grammar check, which is retried as `provider_unavailable` (`StoreReceipts.hs:71-80`). +- vb will not start its dev mock beside a real verifier (vb `Config.hs:231-232`). + +## Top-up A: a new purchase from inside a window + +**What it is** (judgement; recommended). + +- Store Buy is allowed in a short window before the shown badge's paid-through, for example its last 7 days, until retirement. +- The payment is credited at once as a new purchase under new keys. It becomes the shown badge and is presented at once, as every credit is today (`Commands.hs:5865`, `:5515-5520`) and as the model's MVP says (model 2.5, line 486). +- Today Buy works only after retirement (fact, `Commands.hs:3587`; `Store/Badges.hs:227`). A's gain: the buyer pays before the badge ends, and the badge never goes off. + +**Why credit at hand-over, not at retirement** (judgement). + +- At hand-over, the new month starts at credit (`Service.hs:489`). The buyer loses the overlap, bounded by the window. +- At retirement, no days are lost, but every payment is held with the exposures above. +- Contacts would also see the badge removed and re-added. +- A warm iOS background refresh (`BGManager.swift:129`) and a backgrounded Kotlin app need new trigger plumbing to credit at retirement. + +**Changes.** + +- The invoice and receipt guards admit a purchase inside the window (`Commands.hs:3587`, `:5529`). +- The selection guard is SQL on `shown_badge_id IS NULL` (`Store/Badges.hs:227`), but paid-through is computed in Haskell, so that query is restructured. +- The query should filter by window, and the worker should wake when the window opens (judgement). Otherwise each refused attempt shows the buyer a `BIFUnexpected` error until a daily retry succeeds (`Commands.hs:5537-5541`, `:5725`, `:5625-5628`). +- The purchase is credited as its own tier (`Service.hs:447-449`), so no tier rule is needed for correctness. Downgrades are decision 3. +- The guards live in client core, so they bind honest clients only. +- The badge screens on both platforms rework their state. A shown badge replaces the purchase flow on iOS (`BadgesView.swift:26-31`) and closes purchase screens on Kotlin (`BadgesView.kt:28-32`, `:51-57`). + +**Recommended, cosmetic: tolerate a credit landing during retirement** (judgement). + +- Credit takes the badge lock; retirement takes the profile lock (`Commands.hs:5504`, `:5830`). +- Retirement reads the purchase once (`:5549`), then clears the profile badge unguarded (`:5833`). +- A credit committing in between makes contacts see the badge removed, then re-added on the next pass (`:5824`, `:5869`) (inference). +- The stale pass also raises "support ended" for the old purchase (`:5567`, `:5573`, `:5592`). The app may keep it until its next reload. +- Fix: clear the profile badge conditionally in retirement's transaction, and derive the alert from the shown purchase. + +**Optional** (judgement). + +- A prepaid-ending alert three days before paid-through. Without it the window is found only on the badge screen, because the chat-list pitch is hidden while a badge is shown (`BadgesView.swift:67-69`; `OnboardingCards.kt:66-67`). The apps render only two alert kinds today (`ChatListView.swift:389`, `:393`), so it is new UI. +- Deferring presentation until the old credential expires, as renewals do (`Commands.hs:5822-5824`). It keeps the request and the profile update on different days (objective 3, `badges-overview.md:205`). It must skip downgrades, and delays a higher tier's perks by up to 8 days. + +**Limits.** + +- The apps allow one pending purchase per profile (`BadgeStore.swift:120-135`, `BadgeStore.kt:167-183`). +- A is store-only. Codes still wait for retirement, so foss, desktop and link-out buyers get no top-up. +- A sold code expires 365 days after sale (`Orders.hs:21-22`, `:112`; `Service.hs:413`). A code bought d days into a 12-month badge stays redeemable on that profile for about d days after retirement. It can be redeemed on another profile at any time. +- Admitting codes in the window would fix both, at the cost of the code-screen rework (`BadgesRedeemCodeView.swift:288-310`, `BadgesRedeemCodeView.kt:369-377`). + +**What it links.** No payments by key. Timing links them: the new purchase starts near the old paid-through. + +## Top-up B: credit onto the shown badge + +**What it is** (judgement). The payment's months extend the shown badge's ledger, under its key. The badge is never retired and re-added. + +**Service.** + +- The request carries a store payment and the client's last ledger entry, signed by the purchase key. +- `upgradeBadgeSubscription` already has that shape (`Badges/Service.hs:94-98`; `badges-rpc.md:44`), less its `badgeRequest` field, which must be dropped (`badges-rpc.md:30`). It is unimplemented (`Service.hs:341-348`). +- The service lapses the tip, then grants, then issues if due. Lapsing first is required (see the grant trace above). +- Today's issue path writes only if the tip has not moved, but replies normally either way (`Service.hs:519-532`). B must answer a skipped write as an error. Otherwise the client marks the payment credited with nothing credited. +- Payments must be looked up through the ledger. Today's lookup joins only `badge_purchases.payment_id` (`Store.hs:204-218`), so a top-up re-presented by another device would get `internal` forever (`Service.hs:457-461`). +- A SKU of another tier is refused before any write. `grantEntry` keeps the ledger's tier, so crediting it would grant months at the wrong tier: legend months for a supporter payment, or the reverse. +- B is store-only. Admitting codes would also need the code lookup moved to the ledger, or a retried multi-use code would grant twice (`Store.hs:185-202`). + +**Client.** + +- The invoice and receipt guards admit a top-up in the window. The code guard stays: a code redeemed while a badge is shown would become newest and strand the stacked months (`Store/Badges.hs:303`, `:398-411`). +- The receipt row is marked as a top-up of the shown purchase at Buy, and signs with that purchase's keys. +- The row can fall back to A until its first request is sent, not after (`Service.hs:474-482`). +- A top-up during coverage usually issues nothing (`Ledger.hs:106`), but `requestBadgeStash` rejects a reply without a credential (`Commands.hs:5344-5346`). That path changes. +- A credited row with no purchase reads as refused today (`Store/Badges.hs:185-187`, `:289`). A credited mark fixes that. +- Retirement must re-read the tip in its own transaction; today it uses a stale one (`Commands.hs:5552`, `:5556`). + +**Late landing.** + +- Suppose the target retires and another purchase becomes newest before the credit lands. +- Re-showing the target strands the newer purchase and locks out later Buys and codes (`Store/Badges.hs:446-452`). Not re-showing it strands the new months. +- Fix one: defer retirement while a sent request's outcome is unknown. It has no bound while the device is offline. +- Fix two: manage every purchase with unissued months or an active store charge. That is broad: newest-only is assumed by `getUserBadgePurchase`, the single `BadgeState` (`Badges/Types.hs:270-284`), alert derivation (`Commands.hs:5590-5612`), retirement and both apps. + +**Costs.** + +- Stacked months are lost with the chat database. Re-bind cannot recover a finished one-time purchase if the store does not re-deliver it (unverified). +- A topped-up month lapses if the app does not run during it. Today every store month is issued at credit. +- Unissued months keep their value after a refund, unless a stacking cap or refund handling exists. +- It links payments by key, including a store payment to a code-funded badge's key. That goes beyond the exceptions at `badges-rpc.md:13` and against `badges-overview.md:206`. + +## How top-up and subscriptions depend on each other + +**Top-up A needs nothing from subscriptions** (judgement). + +- Exception: if Apple requires a month of access to be a non-renewing subscription (unverified), restore work moves into step 1 (risk 1). + +**Subscriptions need nothing from top-up, under conditions** (judgement). + +- The first charge: offer Subscribe only when no badge is shown, as one-time Buy works today. Then existing holders wait for retirement to subscribe. +- Tier changes always reach a profile showing that subscription's badge, and Apple's store UI can change tier without the app (unverified). Same-ledger subscriptions need a tier-changing grant anyway (Subscriptions), which handles this. +- Subscribing while a badge is shown would reuse A's guards and screens. + +**Two ways to credit renewals.** + +- **Same-ledger:** each renewal credits the subscription's own purchase. +- **A-style:** each renewal is credited as a new purchase under fresh keys. + +**What same-ledger shares with B** (judgement). + +- Lapse-before-grant on an existing ledger. +- Keeping the badge on until the service answers whether a charge landed. +- The late-landing problem: a subscription revived after grace (Apple billing retry, Play account hold, resubscription; unverified) can land after another purchase became newest. B's broad fix two solves it. +- If the app also hands renewals over: B's client half, its ledger payment lookup, and the tip re-read at retirement. +- Not shared: B's cross-tier refusal, its top-up rows, and stacking. + +**What A-style costs** (judgement; not recommended). + +- On iOS, a renewal handed over at launch races retirement, so the badge can come off and on (inference). Avoiding that needs the same retirement deferral as same-ledger. +- Each renewal's month starts at its credit (`Service.hs:489-491`). A backlog handed over together forfeits all but one month. +- On Apple, a renewal is filed under whichever profile is active at hand-over (`Store/Badges.hs:139-157`). +- On Play, renewals share one token (unverified), so a renewal resolves to the old record and is never credited (`Commands.hs:5299-5302`). +- Fresh keys buy no unlinkability: the stores link renewals anyway (unverified). + +**Either way.** + +- Step 4 must keep subscription badges out of A's window, or a top-up and a renewal compete for the next credit (`Store/Badges.hs:228`). +- That needs a way to tell a subscription-funded badge apart. The client keeps no product column (`Store/Badges.hs:289`, `:296-301`), though ledger rows store their credit type. + +**The model is split** (judgement). + +- Its ledger example tops up on the same ledger (model line 379). Its same-row upgrade (§2.10) is B's credit, deferred to phase 2 (§7). +- But it creates a row per purchase (model line 417). +- On subscription tier changes, the model makes a new row with new keys (§2.10), while the protocol keeps the key (`badges-rpc.md:50`, `:54`). + +## Subscriptions: the work + +**Crediting time** (judgement, traced through `Ledger.hs:93-116`). + +- A charge learned while coverage runs is added, and issued at the next request. +- A charge learned after coverage ended restarts the run, so coverage drifts by the gap. +- Today there is no request at zero months (`Commands.hs:5689`). An added one would naturally fall a day before the credential expires, 0–7 days after paid-through (`Ledger.hs:240-243`), so drift is the default (inference). +- So the grant should be dated to the store's period start (model O2). +- On an existing ledger, the client's check marks such a grant backdated if it predates the tip (`Ledger.hs:164`). That check changes. +- For a new ledger, the service seeds at now (`Service.hs:489`). Seeding at the period start also needs `signFirstMonth` to lapse first (`Service.hs:489-491`), or it issues an elapsed month. + +**Tier changes.** + +- Apple: a subscription group lets the store's UI change tier (unverified). Play: tiers are separate products (fact, `BadgeStore.kt:31`, `:36`). +- The protocol has the service discover changes (`badges-rpc.md:55`). No such path exists (`Service.hs:341-348`). +- `grantEntry` keeps the tier, so a tier-changing grant is needed. The service signs from the tip's tier (`Service.hs:358`). +- The client stores the tier once (`Store/Badges.hs:297`) and must update it. +- An immediate Apple upgrade refunds the old plan pro rata (unverified), so it needs refund handling. + +**Charges.** + +- Use the commented draft schema (`M20260915_user_badges.hs:155-227`). +- The ledger reader has no charge case (fact, `Ledger.hs:214-225`). A charge row breaks the statement read (`Store.hs:272-290`), so the purchase stops issuing and every reply fails. + +**Discovery.** + +- Use Apple's App Store Server API and Play's `subscriptionsv2` (unverified). +- Reading them when the client asks avoids a background writer. But renewal requests arrive together each week (`Ledger.hs:236-243`; `Commands.hs:5696-5707`), and each store call takes up to 10 s (`StoreReceipts.hs:65`) against a 30 s client deadline. +- A background lane is a second ledger writer. The deployed Postgres runs today's check-then-append at default isolation (`Service.hs:527-533`), so it needs a lock before reading the tip. +- A renewal the app hands over is claimed by its own transaction id (`Commands.hs:5316`), and must be mapped to the original. +- Handed-over Play subscriptions need a verify path: vb checks only one-time purchases (vb `Google.hs:105-107`). +- Store API quotas and raising them are external (unverified). + +**Client core.** + +- At zero months, ask the service whether a charge landed, and keep the badge on until it answers. That needs the store's expiry on the client; no response carries it today (`Badges/Service.hs:121-125`). +- Raise the subscription alerts the code names but never raises (`Badges/Types.hs:120`). + +**Re-bind and restore.** + +- The model's store re-bind is unbuilt. Apple requires a restore mechanism (unverified). +- The ledger reader has no transfer or upgrade case either (`Ledger.hs:212-219`), so re-bind rows would break it like charge rows. + +**Apps.** Subscriptions are not for sale today (fact, `BadgeStore.swift:35`, `BadgeStore.kt:49`). Selling needs the sale screens, hand-over, restore, manage and cancel, and store disclosures. + +## Order, work and waits + +**Order** (judgement), assuming refund clawback is not in the first release (decision 6): + +1. Release the one-time lane. +2. Top-up A, if subscriptions are far off (decision 2). +3. Refund handling. +4. Subscriptions, same-ledger, after the late-landing design. + +Every external item below is unverified: external state cannot be checked from the repo. + +### Step 1: the one-time lane + +**Ours.** + +- Merge `badge-in-app-checkout` and vb. Revert the TEST ONLY URLs (`BadgeStore.swift:42-44`, `BadgeStore.kt:56-61`). +- Deploy the verifiers with a production issuer key at index 1–8 (mq `Crypto/Entitlement.hs:132-143`) and the Apple root certificate. +- Deploy the production service holding the keys of the address compiled into core (`Chat.hs:74`), or replace that address before the release build. It cannot change without an app release. +- Publish a stable simplexmq server release with entitlement support, upgrade our XFTP servers, and configure retention, which is opt-in per server (mq `FileTransfer/Server/Main.hs:166-170`). +- Build the Google Play bundle the repo documents (`apps/multiplatform/README.md:27-28`). No script or CI job builds it (`scripts/android/build-android.sh:137`). +- Spread the weekly renewal requests across their day-long lead, as the TODO at `Commands.hs:5696-5698` designs. +- Drop queued requests older than the client's deadline. The queue records no receive time today (`Service.hs:82`). +- If a load test shows it is needed, take store calls off the serial request loop, where one Play credit can block it for about 20 s (vb `Service.hs:444`, `:468`). Concurrent requests then need the Postgres tip lock. +- A test deployment: a separate service with its own address and the index-9 key, both compiled into core (`Chat.hs:73-74`). That means separate core builds per platform. XFTP retention cannot be tested, since servers trust keys 1–8 only (mq `Agent/Env/SQLite.hs:234`). +- A badge-service section in `PRIVACY.md`; terms of sale and a refund policy for the web checkout. +- The model's prerequisites: a release with the 7-day recipient display grace before purchases ship (model line 518). It is in 7.1 (`Badges.hs:166-182`) but not stable 7.0.4. The model's Monday removal updates are not assumed here; the code removes at paid-through (`Commands.hs:5829-5834`). + +**External.** + +- How 7.0.x reached Play. The `stable` branch already carries the Play Billing flavour (`origin/stable:apps/multiplatform/android/build.gradle.kts:38-42`). If it shipped as a bundle, Play App Signing and a billing build on a track already exist. +- Play App Signing, if not already enrolled (decision 7). The F-Droid recipe must build `assembleFossRelease` (`apps/multiplatform/README.md:33`). +- The 7.1 release with display grace, its store reviews, and recipients updating. +- Apple's Paid Applications Agreement and Google's payments profile, first, since they likely gate all test purchases. +- Products, created only after the product type is settled (risk 1). Play's multi-quantity off. Some products may already exist (`BadgeStore.kt:31`; `BadgeStore.swift:19-23`), and ids cannot be reused (unverified). +- Subscription products created now fix their group and base-plan structure now. Testing subscriptions (risk 6) can use throwaway ids in a separate group. +- Any existing subscription SKUs deactivated. The app finishes or acknowledges a subscription without crediting it (`BadgeStore.swift:196-199`; `BadgeStore.kt:238-241`), so a buyer would be charged and get nothing. +- Play: a Cloud project, a service-account key and two Console permissions (vb README). The order permission likely also allows refunds (unverified), so the test deployment's key needs production custody. +- Store policy and consumer law on holding a paid purchase behind a shown badge, which step 1 already does. +- App Privacy and Data safety declarations, and EU trader status. +- TestFlight beta review and Play testing-track review for test builds. +- Translations by volunteers on Weblate (`README.md:109`). +- Flux: six preset XFTP servers, three chosen at random (`Operators/Presets.hs:118-127`; `Chat.hs:320-337`). Retention must be configured on all six, and they must accept 2 and 5 GB files, which clients allow from launch (`Badges.hs:259-267`). +- Store review and policy: the first in-app purchase, the US link-out, a web-bought code unlocking a perk, and test purchases in review (decision 1). +- The web checkout `badges.simplex.chat`: DNS and TLS, Stripe activation (needs published terms), a BTCPay Server with Bitcoin and Monero (`badges-rpc.md:33`), merchant and tax registration. Deploying the site itself is ours (`scripts/badge-service/Dockerfile:12-18`). +- Sandbox tests: an account-stable `appTransactionId` (risk 3) and a refund of an unfinished purchase (risk 4). +- A Play licence-tester check that a supporter token under the legend product is refused (risk 2). +- Staff purchases on both stores' production paths after approval, since test purchases are refused (vb `Google.hs:140-145`). + +### Step 2: top-up A + +- Store review, with a demo profile near paid-through or a screen recording, if the reviewer tries the new Buy entry. +- Store policy and consumer law on forfeiting the overlap (unverified). +- Translations. + +### Step 3: refunds + +**Ours, all new** (fact: the service has no refund code; the client already decodes refund debits, `Ledger.hs:144`, `:229`). + +- A refund debit write path, an Apple notification endpoint, and a voided-purchase poller. +- They write beside the request loop (`Service.hs:160`, `:181`), so they need the Postgres lock. +- A record of refunded transactions, checked at credit. A refund during a hold has no ledger yet (`Service.hs:455-456`), and Apple's JWS shows a refund only if re-delivered (vb `Apple.hs:122`, `:131`). +- A per-payment debit rule for ledgers holding several payments (B, same-ledger subscriptions). The model's refund debits the whole balance (model lines 297, 347), which would wipe months other payments bought. + +**External.** Play's Voided Purchases API; Apple's Server Notifications V2 with an API key; Stripe disputes. + +### Step 4: subscriptions + +- The App Store subscription group: SKUs, ranking, prices, localization, review, grace period. +- Play subscriptions with grace and account-hold settings. +- Family Sharing (decision 5). +- Pub/Sub for push discovery. +- Terms and privacy links, and translations. + +## Decisions for the lead + +**1. Test purchases in store review.** App Review likely buys with test money (unverified), which is refused, and the app shows "Purchase error" (`BadgeStore.swift:272-276`). Options: + +- Accept test purchases. That gives public TestFlight users free badges (inference, `StoreReceipts.hs:34`). +- Accept them, and restrict public TestFlight meanwhile. +- Keep refusing, with clearer copy and a note to reviewers. Whether review accepts that is unverified; a rejection blocks step 1. + +**2. A, B, both, or neither before subscriptions?** + +- Recommended same-ledger subscriptions need nothing from A, and give store buyers continuity on their own. A is worth building first only if subscriptions are far off. +- B adds to A: one key per badge, no lost overlap, and the model's same-row upgrade. +- B costs: the late-landing fix, a stacking cap or refund handling, months that lapse if the app does not run, and linked payments. + +**3. A's window length, and downgrades.** + +- A longer window is more convenient, but costs more overlap. +- A legend holder buying a supporter month in a 7-day window gives up about $16 of legend for a $7 month (web prices, `Catalog.hs:109-110`). Refuse, warn, or allow? + +**4. Subscribing while a badge is shown?** + +- Not at all: subscriptions need nothing from A, and existing holders wait for retirement. +- Store-funded holders: supersede the badge as A does, losing up to a month. +- Multi-month code holders: forfeit the code's remaining months, use B, or wait. + +**5. Family Sharing for subscriptions?** It cannot be turned off once on (unverified), and creates claimants on other devices. + +**6. Refund clawback in the first release?** + +- The draft model requires it (§7). +- It saves nothing on store one-time months, which are issued at credit. +- It saves a month refunded during a hold, or a web purchase of 3 or 12 months. +- The model's other first-release items are also unbuilt: a Stripe statement descriptor, and receipts (`Service.hs:367`). + +**7. Play App Signing custody**, if not already enrolled: hand Google the signing key, or reverse the documented bundle path. + +## Risks and open questions + +Ranked by cost if wrong. + +**1. The product type** (unverified). + +- Both stores fix it when a product is created. Ids are hard-coded (`Catalog.hs:150-153`; `BadgeStore.kt:28-38`). +- If a month of access must be a non-renewing subscription, restore moves into step 1. +- Settle from the stores' guidance, and check which products exist. + +**2. Owned-product rules and product identity** (unverified). + +- A held Play purchase may block buying its tier on other devices of the same account (`PlayStore.kt:234`). The same question applies to an unfinished iOS consumable. +- vb trusts the client's product id when Play's record omits it (vb `Google.hs:105-107`, `:124`), so cross-tier integrity rests on Play refusing a mismatched token. +- Settle with a licence tester and a Sandbox account. + +**3. Account-stable `appTransactionId`** (unverified). If present, every Apple purchase is linkable anyway, so A's timing linkage matters on Play only. + +**4. Refunds during a hold.** + +- On Apple, a modified client can withhold the revoked transaction. +- An honest one can also lose a race at launch: the receipt worker may present the stored JWS before the sweep replaces it (`Commands.hs:269`; `SimpleXAPI.swift:2397`). +- Only step 3 closes this. The loss equals today's refund-after-credit baseline. + +**5. Synchronised renewal requests** (inference). + +- Every request fires a day before the shared weekly expiry, at the same instant on Android and desktop. +- The service answers one at a time (`Service.hs:267-272`) against a 30 s client deadline. Per-request time is unmeasured. +- The queue has no age check, so a backlog serves clients that have already gone. +- Spreading and dropping stale requests (step 1) is the fix; a load test sizes it. + +**6. Renewal visibility and revival** (unverified). Whether Play renewals reach the app, which Apple fields persist, and how subscriptions are revived. Settle with test subscriptions. + +**7. The late-landing design for same-ledger subscriptions.** The only worked fix is broad. A narrower one, crediting a revival after grace as a fresh purchase, is unexamined. + +**8. Open checks.** + +- How 7.0.x reached Play. +- Whether a subscription can move between groups. +- Whether App Review accepts "Purchase error". +- Store API quotas. +- Binding a store payment to its purchase key, against another device's claim. The invoice id the apps send is a random UUID any device can read back (`Commands.hs:3590`; `BadgeStore.swift:372`), so this needs a key-derived token and a protocol change. diff --git a/plans/2026-10-13-badge-subscription-renewals.md b/plans/2026-10-13-badge-subscription-renewals.md new file mode 100644 index 0000000000..056c059810 --- /dev/null +++ b/plans/2026-10-13-badge-subscription-renewals.md @@ -0,0 +1,353 @@ +# Plan: store subscription renewals for supporter badges + +Run: 001-badge-subscriptions · Base branch: `f/badge-subscriptions`, cut from `badge-in-app-checkout` once `f/badge-store-verifiers` is merged into it · Repos: simplex-chat-2 · Estimated diff: ~1700 changed lines (~900 code and docs, ~800 tests), one PR in eight slices + +This run makes App Store and Google Play subscriptions renew badges: in the badge service, including its real connections to Apple's App Store Server API and Google Play's subscriptions API, and in the shared app core. It changes no iOS or Android screens, so nothing here puts a subscription on sale. + +Sources: the draft model `plans/2026-07-30-supporter-badges-v3-ux.md` (§3 charges and O2, §5, §7), `plans/2026-08-04-badges-mvp-scope.md` milestone 4, and `docs/protocol/badges-rpc.md`. + +Code is named by file and function, never by line, because `f/badge-store-verifiers` lands first and moves lines. That branch's store verifiers are the starting point: + +- Apple JWS verification, offline and pinned to Apple's root: `verifyAppleTransaction` in `BadgeService/StoreReceipts/Apple.hs`. +- Play reads and acknowledgement of one-time products, with a cached service-account token: `playStoreVerifier`, `playCall`, `bearerToken` in `BadgeService/StoreReceipts/Google.hs`. +- Store config: `AppleStoreConfig`, `PlayStoreConfig` in `BadgeService/Config.hs`. +- Refusal classes, including `SRTestPurchase` answered `test_purchase`: `StoreRefusal` in `BadgeService/StoreReceipts.hs`. + +Service paths below are under `apps/simplex-badge-service/src/`; core paths under `src/Simplex/Chat/`. + +## 1. Goal and acceptance criteria + +A badge bought as a store subscription keeps renewing. When its paid months run out, the app sends its usual signed issue request at the usual weekly moment. The service asks the store whether the subscription charged again, grants the charge's months dated to the store's billing period, and returns the next credential. The app keeps the badge until the service says the subscription has ended. + +Renewal mechanics, tested with an in-process fake store: + +- AC1: A verified subscription receipt creates a purchase whose ledger is one `charge` credit dated to the store's period start and one badge debit, records one charge row, issues the first month, and answers with `subscription = renewing`. A test purchase is answered `test_purchase`. Test: `testSubscriptionPurchase`. +- AC2: At zero months a subscription purchase is still asked about, a day before its shown credential expires. The badge stays shown past paidThrough. A new store charge is granted at its period start, and the next credential is issued and presented when the old one expires, so neither the user nor their contacts see a gap. Test: `testSubscriptionRenews`. +- AC3: When the store has not charged yet (billing retry), the service answers with no credential and `subscription = billingRetry` and writes no ledger row; the client records no failure, keeps the badge and asks again a day later. Once the charge lands, its month is issued with coverage from the store's period start. Test: `testSubscriptionAwaitsCharge`. +- AC4: When the service answers `subscription = ended` at or after paidThrough, the client retires the badge, raises the support-ended alert and sends no further requests for that purchase. Test: `testSubscriptionEnds`. +- AC5: Each store charge is granted at most once. A repeated issue request inside the issued period returns the same credential without asking the store, and a store reporting the same charge again adds no second grant and no second charge row. Test: `testSubscriptionChargeGrantedOnce`. +- AC6: The store is asked only when a subscription purchase's paid coverage has ended, and at most once per subscription per check interval (one hour), whether or not the store answered. Requests in between are answered from the stored state. Test: `testSubscriptionStoreChecksBounded`. +- AC7: On a renewal check, a revoked charge, a charge for another tier, a charge in a trial or introductory offer, and one whose period has not started or has already ended are recorded and not granted. Test: `testSubscriptionChargeNotGranted`. +- AC8: An unreachable store during a renewal check answers `provider_unavailable` with `retryAfter` of the check interval, stamps the check time, and writes no charge or ledger row. Test: `testSubscriptionStoreUnreachable`. +- AC9: A first purchase with no grantable charge is answered per §4's purchase rule and writes nothing. Test: `testSubscriptionPurchaseNotGrantable`. +- AC10: Every row the charge planner produces verifies on the client: `balanceChecked` gives `Just True` for the charge credit, the lapses and the badge debit. Cases: a first charge, a monthly renewal, an annual renewal with a month left at the period start, a renewal after billing-retry recovery, an annual subscriber away past the year end whose charge recovers inside the store's grace period, and a period start equal to the balance start. Test: `testChargeRowsVerify` (unit). +- AC11: A ledger holding a charge row is stored and read back by the service, and `entryTypeFromColumns` rebuilds `SCCharge` from its charge id. Tests: `testEntryTypeColumns`, the service schema down/up cycle. +- AC12: An Apple auto-renewable transaction is claimed by its `originalTransactionId`, every other Apple transaction by its `transactionId`, and the real Apple verifier vouches with the same ref. A renewal transaction handed over by the app resolves to the credited receipt record and creates no purchase; a held record that adopts a renewal JWS before it is credited is still credited. Tests: `testAppleTransactionRef` (unit), an Apple renewal-payload case in `StoreVerifierTests`, `testAppleRenewalResolvesToPurchase`. +- AC13: The `subscription` response field round-trips in JSON, is absent for prepaid purchases, and an unknown state decodes as `SSUnknown` rather than failing the response. Test: credential response JSON tests (unit). + +Store connections, tested against fake HTTP stores: + +- AC14: The Apple subscription check signs an App Store Server API token with the configured in-app purchase key, reads the subscription's status by its original transaction id, verifies the signed transaction and renewal info against the pinned Apple root, and maps them to a `SubscriptionCheck`. Its HTTP answers map to refusal classes as §4 says. Test: Apple subscription cases in `StoreVerifierTests`. +- AC15: The Play subscription check reads `purchases.subscriptionsv2` by token through the existing service-account client, maps state, plan, period and order id, and acknowledges an unacknowledged subscription before it is credited. Test: Play subscription cases in `StoreVerifierTests`. +- AC16: A service configured without the Apple API key, or without Play, answers that store's subscription receipts `provider_not_configured`, and its one-time purchases behave as before. Test: `ConfigTests` and a service test. + +Unchanged: + +- AC17: Prepaid purchases (codes and one-time store purchases) behave exactly as before. The existing "Supporter badges", "SimpleX badge service" and "SimpleX badge service e2e" suites pass, except two tests that pin `subscr_badge_supporter_01` as `product_unavailable`: `testStoreUnknownProduct`, whose subscription case moves to AC1, and `testStoreAcknowledgesBeforeCrediting`, whose unpriced case switches to a product no catalog maps (for example `badge_unknown_01`). + +## 2. Non-goals + +- Tier changes (upgrades and downgrades): a charge for another tier is recorded and not granted. +- Refunds: no refund handling or debit. A charge the store reports as revoked is simply not granted. +- Store notifications (App Store Server Notifications, Play real-time notifications). +- Resubscription after the badge was removed, and restoring on a new device. +- Spreading the weekly request moment, and taking store calls off the serial request loop. +- App screens, and handing subscription transactions over from the apps; the dev mock verifier's subscription support comes with them. +- Family Sharing, which stays off: family-shared Apple transactions are refused. + +## 3. Current state + +What the code does on `badge-in-app-checkout` with `f/badge-store-verifiers` merged: + +- **The client stops at zero months.** `badgeRequestDue` (`Library/Commands.hs`) requires months left and a shown credential. `retireExpiredBadge` takes the badge off at paidThrough, after which the purchase is never asked about. Both rules rest on one premise: no months arrive after paidThrough. Subscriptions remove that premise, so both change together. +- **The service never reads a store after the first purchase and never grants onto an existing ledger.** `issueBadgeCmd` (`BadgeService/Service.hs`) lapses and issues. `signFirstMonth` seeds an empty ledger at `now` and issues without lapsing. `writeIssued` answers through `issueResponse`, which returns the current issuance, even when it skipped its write. +- **A charge row cannot be stored or read by the service.** `appendLedgerPlan` (`BadgeService/Store.hs`) writes no charge reference. `entryTypeFromColumns` (`Badges/Ledger.hs`) has no charge case, so a charge row reads as an empty ledger at the tip and fails any statement read. No charges table and no ledger `charge_id` exist on either side. +- **Apple renewals are not tied to their purchase.** Claims use `appleTransactionId` (`PaymentService.hs`), the transaction's own id, both in the client's `storeTransactionRef` and in the service's `toStoreReceipt`. A renewal has a new id, so the client's `holdStoreReceipt` (`Store/Badges.hs`) would give it a new receipt row with fresh keys. A Play renewal keeps its token and already resolves to the credited row. +- **The catalog sells no subscription.** `storeProduct` (`BadgeService/Catalog.hs`) maps only the four one-time SKUs; `testStoreUnknownProduct` pins `subscr_badge_supporter_01` as `product_unavailable`. +- **The verifiers read one-time purchases only.** Apple's is offline and parses no `originalTransactionId`, `expiresDate`, `type` or offer fields; it calls no App Store Server API. Google's reads `purchases/products` and acknowledges products only. +- **The client's statement check** (`balanceChecked`, `Badges/Ledger.hs`) re-runs each credit through `grantEntry` at its `createdAt` and flags a row dated before its predecessor. Its verdict is stored in `balance_checked` and read by nothing. +- **The client's "issued no credential" check** in `requestBadgeIssue` fires when the stored tip still has months left after an answer with no credential. +- **Wire:** version 1, aeson with unknown fields ignored and `Maybe` fields optional. `BSPBadgeCredential {credential, receipt, statement}` (`Badges/Service.hs`). `SCCharge {chargeId}` already exists. An unknown enum value fails the whole response unless its type has a fallback constructor, as `BSEUnknown`, `SCUnknown` and `SDUnknown` do. +- **Timing today:** a credential expires at the end of the Monday after its paid month (`endOfMondayAfter`), 1-8 days after paidThrough. The app asks for the next one a day before that and shows it at that moment. Recipients show a badge as active until 7 days after its expiry, then faded as expired for a month, then hide it (`mkBadgeStatus`, `Badges.hs`); servers honour file perks for a day after expiry. + +Invariants this run keeps: + +- The serial request loop is the only ledger writer. +- Every row is its operation re-run at its `createdAt`, and `createdAt` never decreases along a ledger. +- Lapse comes before grant. +- The tier comes from what the store charged, never from the client. +- A refusal writes no ledger row, and no ledger row or issuance is written before the credential is signed. (A renewal check does record its check time, the subscription's state and any charge it saw.) +- Claims are by the store's own reference. + +## 4. Design + +The core change: + +- A subscription purchase is an ordinary purchase whose ledger is refilled by store charges instead of being paid once. +- Its store identity is the subscription, not one transaction: Apple's original transaction id (Play's token already is). Every renewal therefore resolves to the same purchase and the same receipt record on both sides, and the service has one thing to ask the store about. +- Months enter a subscription ledger only as `charge` credits whose operation time is the store's billing period start. The grant row's `createdAt` is that period start, as `grantEntry` already stamps its `t`. Coverage follows the store's periods without drift, every row verifies by re-running its operation at its `createdAt`, and `StatementEntry` gains no field. +- The first charge and every renewal go through one pure planner: lapse what ran out before the period start, grant the charge's months at the period start, lapse what ran out since, then issue at now. +- The service asks the store only when a subscription purchase's paid coverage has ended, and writes nothing unless a charge is granted. +- The client keeps asking at the shared weekly moment and keeps the badge until the service answers that the subscription has ended. + +### Timing and grace, end to end + +- The app asks at the shared weekly moment, a day before the shown credential's expiry. That moment always falls after paidThrough (expiry is 1-8 days after it), and stores charge at the period's end, so a renewed subscription gets its new credential before the old one expires and swaps it in at expiry. The badge stays active for the user and their contacts throughout, and requests stay indistinguishable by timing. +- If the store has not charged (billing retry), no month is issued without a charge. The badge stays active by the existing rules alone: servers honour file perks until a day after the last credential's expiry, and contacts show it as active until 7 days after it. After that, contacts show it faded as expired, as for any lapsed badge. The app asks once a day meanwhile. +- The badge stays on the profile until the service answers `ended`, so a payment the store recovers late re-activates it with a fresh credential. Taking it off at the end of grace would need the resubscription work this run leaves out, since a removed purchase is never asked about again. +- While it stays shown, the profile cannot start a store purchase or redeem a code, and held receipts wait, because every purchase path refuses while a badge is shown. Nothing is charged meanwhile, so no money is lost; the iOS run decides what the user is told. +- The stores bound the wait themselves (Apple retries for up to 60 days, Play holds for up to 30; unverified), after which the service answers `ended` and the app removes the badge. +- Store grace periods are off. During a store's grace period the subscriber keeps uninterrupted paid service, but this run issues nothing until the charge lands, so a subscriber who recovers inside grace could go without file perks for part of what they paid for. With Apple's Billing Grace Period off (it is opt-in, and offers only 3, 16 or 28 days), "the subscriber's days of paid service pause until Apple is able to collect payment", which is exactly this run's rule; Play's grace is set to its minimum (reportedly 0, with about a day applied; unverified). Contacts still see the badge as active until 7 days after the last credential's expiry. + +### Shared code (`src/Simplex/Chat/`) + +- `PaymentService.hs`: + - `appleTransactionId` becomes `appleTransactionRef` (structural rename, slice 1). + - It then returns the payload's `originalTransactionId` when `type` is `"Auto-Renewable Subscription"`, the `transactionId` otherwise (slice 3a). + - The client's `storeTransactionRef` and the service's `toStoreReceipt` keep calling this one function, so client and service claims cannot disagree. + - The real Apple verifier must vouch with the same ref, because `purchaseWithReceipt` answers `internal` whenever the verified ref differs from the claim. So in the same slice, `transaction` in `StoreReceipts/Apple.hs` parses `type` and `originalTransactionId` and vouches with the original id for an auto-renewable transaction, as the dev mock already does by calling the claim function. Without this, a held Apple subscription record that adopts a renewal JWS would be answered `internal` on every attempt, and the buyer would never be credited. + - The `googlePurchaseRef` comment states that the hash stays the claim while the service also keeps a subscription's token to ask Play about it. +- `Badges/Service.hs`: + - New enum `SubscriptionState = SSRenewing | SSCancelled | SSBillingRetry | SSEnded | SSUnknown Text`, JSON `renewing`, `cancelled`, `billingRetry`, `ended`, and any other string as `SSUnknown`. + - Meaning, as the service last read the store: renewing (auto-renew on), cancelled (auto-renew off, the paid period still runs), billingRetry (a charge failed and the store is retrying it: grace, retry or hold), ended (no charge will come: expired, revoked or refunded). The client reads `SSUnknown` as "not ended". + - `BSPBadgeCredential` gains `subscription :: Maybe SubscriptionState`, present exactly when the purchase is funded by a subscription. The version stays 1: the field is optional, and older clients ignore it. +- `Badges/Ledger.hs`: + - `entryTypeFromColumns` takes the row's charge id and rebuilds `SCCharge` from it (slice 2). + - A pure planner (suggested name `chargeEntries`) takes the tip or a seed, the charge's period start, its months, the charge id, `now` and fresh entry ids. It returns `lapse periodStart` (if any), `grant periodStart months (SCCharge chargeId)`, `lapse now` (if any). The caller issues at `now` with `issueEntry` as today. + - The rows' `createdAt` are non-decreasing whenever the period start is not before the tip's `createdAt`. That holds on every path: the tip was issued before its month ended, the next charge's period starts around that month's end, and the service writes no row while a subscription waits for its charge. + +### Badge service (`apps/simplex-badge-service/src/BadgeService/`) + +- Catalog (`Catalog.hs`): + - `storeProduct` answers a sum: `StoreOneTime {badgeType, months}` for today's four SKUs, `StoreSubscription` for the subscription products (Apple `SUBSCR_BADGE_{SUPPORTER,LEGEND}_{MONTH,YEAR}_01`, Play `subscr_badge_{supporter,legend}_01`). + - A new `storePlan provider planId` maps what a charge was for to `(badgeType, months)`. Apple plans are those four product ids. Play plans are the base plans `subscr-badge-supporter-month-02`, `subscr-badge-supporter-year-01`, `subscr-badge-legend-month-01`, `subscr-badge-legend-year-01`, because a Play receipt names the product and only Play's subscription record names the base plan. + - Months are 1 or 12 and come from the plan, never from the period's length. +- Verifier interface (`StoreReceipts.hs`): + - `StoreVerifier` gains `checkSubscription :: Maybe (SubscriptionRef -> IO (Either StoreRefusal SubscriptionCheck))`, run under the verifier timeout. Timeouts and other throws are unreachable, as for the online Google calls; a `StoreVerifierFailure`, which the Apple chain check throws for a chain it cannot place, is caught first and is a verifier failure (`internal`), as the offline Apple path treats it. + - `SubscriptionRef` names what to ask about: Apple's original transaction id, or Play's token alone (`subscriptionsv2.get` needs nothing else). The Play product id is needed only by the purchase-path acknowledgement, which has it from the receipt. + - `SubscriptionCheck` holds the `SubscriptionState`, a test-purchase flag, and the latest paid period if any, as `StoreCharge {chargeRef, planId, periodStart, periodEnd, paid, revoked, offer}`. `chargeRef` is Apple's `transactionId` or Play's order id; `revoked` is true when the store reports that charge refunded or revoked; `offer` is true when the charge is in a trial or introductory offer. + - `noStoreVerifier` and the dev mock leave it `Nothing`, which answers `provider_not_configured`. +- Store connections (`StoreReceipts/Apple.hs`, `StoreReceipts/Google.hs`, `Config.hs`): + - Apple: `AppleStoreConfig` gains the App Store Server API key (key id, issuer id, the `.p8` private key file) and an API host defaulting to production. Without the key, Apple one-time purchases verify as today and Apple subscriptions answer `provider_not_configured`. + - The Apple check calls "Get All Subscription Statuses" for the original transaction id, authenticated by an ES256 JWT (issuer id, key id, bundle id, audience `appstoreconnect-v1`, short expiry, reused until near expiry). It verifies each signed transaction and signed renewal info with the same pinned-root chain check `verifyAppleTransaction` uses, refactored so the chain check and payload parsing are separate functions. + - Apple mapping: status 1 is renewing or cancelled by the renewal info's `autoRenewStatus`; 3 (billing retry) and 4 (grace) are billingRetry; 2 (expired) and 5 (revoked) are ended. The latest transaction gives `transactionId`, `productId` (the plan), `purchaseDate` and `expiresDate` (the period), `revocationDate` (revoked), `offerType` (offer), `environment` (test purchase) and `inAppOwnershipType` (`FAMILY_SHARED` is refused as `receipt_invalid`). + - Apple HTTP answers: 401 and 403 are this service's failure (`internal`, logged); 404, 429, 5xx, timeouts and transport errors are unreachable; a body whose signed transaction or renewal info does not verify against the pinned root, whether the check returns `Left` or throws, is a verifier failure, never a refusal. + - The production host answers 404 for a Sandbox transaction id, so a test purchase must never reach it: on the purchase path the offline JWS check's `environment` refuses a test purchase as `test_purchase` before `checkSubscription` is called. The API transaction's `environment` is checked again as a defence, which only a Sandbox host would exercise. + - Play: the check calls `purchases.subscriptionsv2.get` by token through the existing `playCall` and `bearerToken`, with the same HTTP classes as today's product reads. + - Play mapping: `SUBSCRIPTION_STATE_ACTIVE` is renewing or cancelled by `autoRenewingPlan.autoRenewEnabled`; `IN_GRACE_PERIOD` and `ON_HOLD` are billingRetry; `CANCELED` is cancelled until `expiryTime`; `EXPIRED` and `PENDING_PURCHASE_CANCELED` are ended; `PENDING` is answered `payment_pending` as a pending refusal. The line item gives the plan (`offerDetails.basePlanId`), the period end (`expiryTime`), the charge ref (`latestSuccessfulOrderId`) and the offer flag from its current phase (`offerPhase` in a free trial or introductory price). `offerDetails` is not the flag: it names the offer the subscription was bought with and stays for its life, so reading it would refuse every later full-price renewal of a subscription bought on an offer. Play reports no current-period start, so it is the period end minus the plan's length. `testPurchase` present marks a test purchase. Play's revocation of an order shows only as the subscription ending, so Play charges are never `revoked`. + - Play acknowledgement: an unacknowledged subscription is acknowledged with `purchases.subscriptions.acknowledge` before it is credited, as one-time purchases are today, so Play's three-day refund never hits a credited subscription. +- Schema: one new service migration `20261012_badge_subscriptions`, SQLite and Postgres, appended to both lists. It follows the commented draft in the client migration `M20260915_user_badges` for the parts this run uses, and the draft drops those parts, as the service's `20260925_badge_store_receipts` did for `payment_id`. + - `@subscription_charges(charge_id TEXT PK, payment_id → @payments ON DELETE CASCADE, provider_charge_ref, plan_id, period_start, period_end, amount NULL, currency NULL, created_at, UNIQUE(payment_id, provider_charge_ref))`. Amount and currency are nullable because Play reports no price; `charged_at` is not stored. + - `@badge_ledger.charge_id → @subscription_charges`, with an index. + - `@payments.subscription_state`, `@payments.subscription_checked_at`, `@payments.provider_token`. + - The service's never-written `@payments.subscription_renews_at`, `grace_until` and `cancelled` are dropped (and restored by the down migration), so the state has one representation. The client schema does not change. +- The Play token: kept only for subscription payments, because every renewal check needs it and the client no longer holds it once credited (`createStashBadgePurchase` clears it). It is never logged, never returned and never exported. The claim stays its hash. +- Charge ids are `randomId` text, like payment ids. This settles the MVP scope's two "settle before milestone 4" items: the wire `chargeId` is a service-assigned random id, and ledger entries reference payments and charges by those ids and purchases by key, never by a local integer. +- Storage (`Store.hs`): + - `appendLedgerPlan` writes `charge_id` from the `SCCharge` it is given, and the ledger reads select it (slice 2). + - New functions read a purchase's subscription from its payment row, insert a charge if new (`ON CONFLICT (payment_id, provider_charge_ref) DO NOTHING`), tell whether a charge is granted (a ledger row references it), and record the state and check time. +- Grant rule, for both paths: a charge is grantable when no ledger row references it, it is not revoked, it is not in an offer, the state is not `ended`, its plan's tier is the ledger's (or, on a first purchase, any plan of the catalog), and `periodStart <= now < periodEnd`. +- Purchase (`Service.hs` `purchaseWithReceipt`/`newPurchase`), for a subscription product: + - Play: the receipt is verified by one `checkSubscription` call, routed on the receipt's product id; the one-time `verifyGoogle` is not called. + - Apple: the JWS is verified offline as today; a test purchase is refused there; then one `checkSubscription` call. + - A test purchase is answered `test_purchase`, as one-time purchases are. + - With a grantable charge: acknowledge it (Play), plan from `emptyEntry periodStart tier`, sign the issued month, and write payment (claimed by `(provider, subscription ref)` as today), purchase, charge, ledger rows, issuance, state and token in one transaction. + - With no grantable charge, the receipt worker reschedules at whatever `retryAfter` the answer gives, with no cap on attempts, and no payment row exists yet to bound checks by. So: + - The period has not started yet, or the store answers pending: `payment_pending` with today's 300 s. + - Play, with the state `ended`: `receipt_invalid`, terminal. Play issues a new token when a subscription is bought again after it ended, so this one can never be credited again; this is the same premise as the existing one-time rule that "a canceled purchase stays canceled, and buying again issues a new token". + - Anything else (a revoked or offer charge while the state is not `ended`, a period over while the store still retries, no charge yet, an unknown plan, and an Apple subscription whose state is `ended`): `payment_pending` with `retryAfter` of a day. The record stays presentable, so a later charge on the same token, or an Apple resubscription under the same original id, can still be credited from it. + - The implementer confirms each case against the refusal classes `StoreRefusal` documents; a case that does not fit them is escalated, not guessed. +- Renewal (`Service.hs` `issueBadgeCmd`), for a subscription purchase: + - While its paid coverage runs (`paidThrough tip > now`), the path is today's: lapse, issue if a month is due, otherwise answer the current issuance. No store call. + - Once coverage has ended, the service asks the store, unless a check of this subscription was attempted within the check interval (one hour). Every attempt stamps `subscription_checked_at`. + - Inside the interval it answers from the stored state without calling the store. A failed check answers `provider_unavailable` with `retryAfter` of the whole interval. + - A grantable charge: the planner's rows from the tip, sign, then one transaction that re-reads the tip and writes charge, rows, issuance and state. If the tip moved, nothing is written and the answer is `internal`, never a reply that looks credited. + - No grantable charge: record the charge (if any) and the state, log a charge that is not grantable, write no ledger row. + - A charge whose period does not end after its start is a verifier failure (`internal`, logged). +- Answers: every `BSPBadgeCredential` for a subscription purchase is built by `issueResponse` (the statement after the asserted entry and the current issuance) plus `subscription`. Purchase replays answered from the record carry it too (`credentialResponse` takes it). + +### Client core (`src/Simplex/Chat/`) + +- `Store/Badges.hs`: `UserBadgePurchase` gains a named kind (suggested `PurchaseKind = PKPrepaid | PKSubscription`; `BadgeFunding` is taken), read in `getBadgePurchase` as `CASE WHEN EXISTS (a charge credit in this purchase's badge_ledger) THEN 1 ELSE 0 END`. A purchase is a subscription exactly when its months came from charges. The replica already says so, so there is no column and no client migration. +- `Library/Commands.hs`, in the pass (`updateUserBadge`): + - A prepaid purchase is retired before the request, as today. + - A subscription purchase is not retired at paidThrough. It is retired after a request whose answer is `SSEnded`, through the same `retireExpiredBadge`, whose own `paidThrough <= now` guard still applies. +- `badgeRequestDue`: a subscription purchase is due at zero months on the same condition as a prepaid one with months left: the latest credential is the shown one and it expires within a day. A request that issued nothing re-arms a day later (`stalledAt` in `updateUserBadge`), which is the retry cadence while the store has not charged. +- `requestBadgeIssue` returns the answer's `subscription` beside the balance. Its "issued no credential" check fires only while the ledger still owes a month (`paidThrough > now`), instead of while `balanceMonths > 0`. Every prepaid path gives the same answer, since the service lapses before it answers; a subscription tip whose months elapsed unlapsed (the service writes nothing while waiting) owes nothing. +- `derivedBadgeAlert` raises no `BASupportEnded` for a subscription purchase that is still shown: it is waiting for its renewal, not ended. + +### What gets removed or simplified + +- The premise "no months after paidThrough" becomes one rule per purchase kind, stated where the pass branches. +- `testStoreUnknownProduct`'s subscription case, and the catalog comment "subscriptions wait until renewals add months". +- The service's three never-written subscription columns on `@payments`. +- The draft charge schema in the released client migration's comment (the parts the service migration now implements). +- Not added: a client column or client migration. The purchase kind is derived from the replica, so there is nothing to keep in sync. + +### Alternatives considered, and why each was rejected + +- **Date the grant at request time** (as prepaid grants are): coverage drifts by the 0-7 days between paidThrough and the weekly request, every month, and the app's "Renews" date stops matching the store's. +- **Add the period start to the charge entry** instead of using `createdAt`: a new `StatementEntry` field is dropped by the client replica, which stores fixed columns, and needs a new client check, while `createdAt` already is the operation's time. +- **Ask the store from a background lane or notifications only**, keeping the issue path DB-only: a second ledger writer that needs a Postgres lock, and notifications need external setup. Left for later work, which can feed the same charges table. +- **The app hands renewals over** (a new purchase per renewal, or a top-up of the shown badge): an Apple renewal would get fresh keys under whichever profile is active, and the top-up machinery would be needed. +- **Keep a subscription flag or state on the client purchase**: a client migration now, and two sources of the same fact. The app screens can add stored state if they need it. +- **Request at the store's renewal time** (model §2.9, "after `renews_at`"): a per-user request time links requests (objectives 3 and 4 in `docs/protocol/badges-overview.md`). The shared weekly moment already falls after paidThrough. +- **Retire at paidThrough and re-show on renewal**: contacts see the badge removed and re-added every month, and a retired purchase is never asked about again. +- **Remove the badge when recipients' grace ends**, while the store still retries: a payment the store recovers afterwards could not re-activate it without resubscription work, so the buyer would pay for a month they never see. Contacts already see it faded as expired by then. +- **Write the lapse at `now` when no charge is grantable** (as prepaid does): it is dated after a charge that may later be granted at an earlier period start, and it moves the client's tip so the pass counts as issued and stops retrying. +- **Read the Apple subscription from the JWS the app hands over**, without the App Store Server API: the app is not involved in renewals, so only the service's own read sees them. + +## 5. Compatibility and security + +- **Wire:** one optional response field, `badgeCredential.subscription`, version unchanged. + - An older client ignores the field (aeson `rejectUnknownFields = False`). + - A newer client reading an older service gets `Nothing`, and an older service never writes a charge, so nothing is derived as a subscription. + - A state added later decodes as `SSUnknown` on this client and does not fail the response. + - Apple claim refs change only for auto-renewable transactions, which no client hands over today (the apps finish them uncredited). + - `docs/protocol/badges-rpc.md` and `badges-rpc.schema.json` gain the field, the `charge` credit's dating, `issueBadge`'s renewal behaviour, and the subscription answers of `purchaseBadge`. The doc's sentence that "each renewal credits months of the charged badge type" changes to say a charge for another tier is recorded and not granted until tier changes are supported. +- **Database:** one new service migration with up and down, SQLite and Postgres, covered by the service schema down/up cycle. No client migration. The client query in `getBadgePurchase` changes, so `chat_query_plans.txt` changes; only the full local run regenerates it, since it is rewritten from every query a full run records. +- **Config:** new optional keys in the `[apple]` section for the App Store Server API key and host. A deployment without them keeps verifying Apple one-time purchases. +- **Older and newer clients:** an older client never holds a subscription purchase, since no app sells one. An app downgraded to an older core retires a subscription badge at paidThrough and never asks again, so it loses every renewal the store keeps charging. +- **Adversary:** + - Quota exhaustion: a client holding a subscription key repeats issue requests to make the service hammer a store's API quota, which every subscriber shares. For an existing purchase the store is asked only once coverage has ended, and at most once per subscription per hour, failures included; requests in between are answered from the stored state. On the purchase path there is no payment row to stamp: an honest client retries a period that has not started, or a pending payment, every 300 s only until it starts or settles, stops on a Play subscription whose state is `ended`, and retries every other case once a day; a client that ignores `retryAfter` can repeat a purchase as it can today (each attempt is one store call, as one-time Play purchases already are). + - Replay: a charge is unique per `(payment, provider charge ref)` and granted only if no ledger row references it, in the transaction that re-reads the tip. A replay inside the issued period gets the cached credential. + - Forged renewal evidence: none is accepted from a client. Renewals come only from the service's own store read, and Apple's answers are verified against the pinned root, so a client cannot name a charge, a period or a tier. + - Another key presenting the same subscription: the claim is the subscription's identity, so another key gets `receipt_used`, as today. + - Store data out of range (period end not after start, unknown plan, another tier, an offer): not granted; a malformed period is a verifier failure, logged. + - A dishonest service dating grants: grants are legitimately dated up to about a month back, so the client's check accepts any date between the previous row's and now; it still flags a row dated before its predecessor. Accepted: the verdict is stored and nothing reads it. + - Metadata: the zero-month request goes out at the same shared weekly moment as every renewal, so it adds no per-user timing. The service links a subscription's renewals to its purchase key, as it already links monthly issuance. + - Secrets at rest: the Play token and the Apple API private key are usable only with our store accounts. Neither is logged or returned; the Apple key file is read like the Play service-account file. + - Resource use: each check is one store call of at most the verifier timeout on the serial loop, bounded per subscription here. The aggregate load at the weekly moment is a known limit (§8). + +## 6. Slices + +Before slice 1, the user creates the branch on the host, after `f/badge-store-verifiers` is merged into `badge-in-app-checkout`: `git switch -c f/badge-subscriptions badge-in-app-checkout`. + +The implementer runs `cabal build` and the tests in every slice. Every slice runs `cabal build` (project default flags, never `-O0`), then the scoped suites named in it, from `/workspace/simplex-chat-2`. Check the example counts, not only the exit status. hspec `-m` matches a substring of the example path, and several `-m` are alternatives. The new service and client subscription tests go under a `describe "subscriptions"` inside `badgeServiceTests` (`tests/Bots/BadgeService/BotTests.hs`), so `-m "SimpleX badge service e2e/subscriptions"` runs exactly them. + +### Slice 1: name Apple claims by reference (structural) + +- Files: `src/Simplex/Chat/PaymentService.hs`, `src/Simplex/Chat/Library/Commands.hs`, `BadgeService/StoreReceipts.hs`, `BadgeService/StoreReceipts/Mock.hs`, and any test that calls the function. +- Change: rename `appleTransactionId` to `appleTransactionRef`, matching `googlePurchaseRef` and `StoreTransactionRef`; no behaviour change. Slice 3a makes it return a subscription's original id, which the old name would misstate. +- Verify: `cabal test simplex-chat-test --test-options='-m "Supporter badges"'`. +- Done when: it builds and the suite passes with the same example count. + +### Slice 2: charge storage and the response field (structural) + +- Files: `BadgeService/Store/{SQLite,Postgres}/Migrations.hs`, `BadgeService/{Store,Service}.hs`, `src/Simplex/Chat/Badges/{Ledger,Service}.hs`, `src/Simplex/Chat/Store/Badges.hs` (the fallback `entryTypeFromColumns` call), the client migration `M20260915_user_badges` in both backends (draft comment only), `tests/BadgeTests.hs`, `tests/Bots/BadgeService/WebTests.hs`. +- Change: + - The `20261012_badge_subscriptions` migration (§4). + - `appendLedgerPlan` writes `charge_id` for an `SCCharge` row; the ledger tip and statement reads select it; `entryTypeFromColumns` gains the charge id; the client's fallback call passes `Nothing`. + - `SubscriptionState` and the `subscription` field; `credentialResponse` takes it, and every caller passes `Nothing`. + - Nothing writes a charge or a state yet, so no behaviour changes. +- Tests: `testEntryTypeColumns` asserts the `SCCharge` round trip with a charge id and `Nothing` without one; JSON tests for the field (present, absent, unknown state); `testServiceColumns` covers the new and dropped columns; the down/up cycle covers the migration. +- Verify: `cabal test simplex-chat-test --test-options='-m "Supporter badges" -m "SimpleX badge service"'` (this also runs the e2e suite). +- Done when: the suites pass, the down/up cycle includes the new migration, and AC11 and AC13 hold. + +### Slice 3a: the charge planner and Apple subscription claims (behavioural, pure) + +- Files: `src/Simplex/Chat/Badges/Ledger.hs`, `src/Simplex/Chat/PaymentService.hs`, `BadgeService/StoreReceipts/Apple.hs`, `tests/BadgeTests.hs`, `tests/Bots/BadgeService/StoreVerifierTests.hs`; the comments on `VerifiedStoreTransaction.transactionRef` and `OpenStorePurchase` that call Apple's ref the transaction id. +- Change: the planner; `appleTransactionRef` returns the original id for auto-renewable transactions, and the Apple verifier's `transaction` vouches with that same ref. +- Tests: `testChargeRowsVerify` (AC10, every case listed there); `testAppleTransactionRef` (subscription, consumable, missing type); a `StoreVerifierTests` case with a renewal payload (`transactionId` different from `originalTransactionId`, type auto-renewable) asserting the verified ref equals `appleTransactionRef` of the JWS. +- Verify: `cabal test simplex-chat-test --test-options='-m "Supporter badges" -m "badge store verifiers"'`. +- Done when: AC10, the AC12 unit test and the new renewal-payload case hold, and the existing Apple verifier cases still pass. This slice tests the riskiest assumption (§8) before any service code depends on it. + +### Slice 3b: credit a subscription purchase, against the fake store (behavioural) + +- Files: `BadgeService/{Catalog,StoreReceipts,Service,Store}.hs`, `tests/Bots/BadgeService/{FakeStore,BotTests}.hs`, `tests/BadgeTests.hs` (its `uncalledVerifier` builds `StoreVerifier` directly and needs the new field), `docs/protocol/badges-rpc.md`, `docs/protocol/badges-rpc.schema.json`. +- Change: catalog `StoreProduct` sum and `storePlan`; `checkSubscription`, `SubscriptionRef`, `SubscriptionCheck`, `StoreCharge`; the grant rule; the purchase branch for subscription products, with its no-grantable-charge answers; replays carry the state. +- FakeStore gains subscriptions: Google keyed by token and Apple keyed by original id, each with a mutable state and latest charge, and a check counter. Its Apple subscription fixtures (`unsignedJWS` with `type` and `originalTransactionId`) vouch with the original id, which is the claim `appleTransactionRef` reads. +- Tests: `testSubscriptionPurchase` (AC1), `testSubscriptionPurchaseNotGrantable` (AC9: a period not started, `payment_pending` 300 s; a Play subscription whose state is `ended`, `receipt_invalid`; a Play revoked or offer charge while renewing and an Apple subscription whose state is `ended`, `payment_pending` with a day; each writing nothing); `testStoreUnknownProduct` and `testStoreAcknowledgesBeforeCrediting` keep their unpriced cases with a product no catalog maps instead of `subscr_badge_supporter_01`. FakeStore vouches for that product with its own token, so the request reaches `storeProduct` and is answered `product_unavailable` rather than refused by the fake verifier. +- Verify: `cabal test simplex-chat-test --test-options='-m "SimpleX badge service e2e/store purchases" -m "SimpleX badge service e2e/subscriptions"'`. +- Done when: AC1 and AC9 hold and the store purchase examples still pass. + +### Slice 4: renew once coverage ends, on the service (behavioural) + +- Files: `BadgeService/{Service,Store}.hs`, `tests/Bots/BadgeService/{BotTests,FakeStore}.hs`, `docs/protocol/badges-rpc.md`. +- Change: the renewal step in `issueBadgeCmd`, the check interval stamped on every attempt, the one-transaction write that answers `internal` when the tip moved, answers through `issueResponse`. +- Tests (service, through `serviceCmd` with the shared test clock): `testSubscriptionChargeGrantedOnce` (AC5, with the replay inside the issued period), `testSubscriptionStoreChecksBounded` (AC6: coverage running makes no check; two requests after coverage ended within the hour make one; a failed check also holds the next for the hour), `testSubscriptionChargeNotGranted` (AC7: revoked, other tier, offer, period not started, period ended), `testSubscriptionStoreUnreachable` (AC8). +- Verify: `cabal test simplex-chat-test --test-options='-m "SimpleX badge service e2e"'`. +- Done when: AC5-AC8 hold and the existing e2e examples still pass. + +### Slice 5: keep asking at zero months, on the client (behavioural) + +- Files: `src/Simplex/Chat/Store/Badges.hs`, `src/Simplex/Chat/Library/Commands.hs`, `tests/Bots/BadgeService/BotTests.hs`. +- Change: the purchase kind on `UserBadgePurchase`; `badgeRequestDue` at zero months for a subscription; retirement on `SSEnded` after the request; the "issued no credential" check on owed months; no support-ended alert while a subscription is shown. +- Tests (real client and service, test clock, `renewalMoments`/`armWakeAt`): `testSubscriptionRenews` (AC2, including that the new credential is presented at the old one's expiry with no gap), `testSubscriptionAwaitsCharge` (AC3), `testSubscriptionEnds` (AC4), `testAppleRenewalResolvesToPurchase` (AC12: two Apple JWS with one original id and two transaction ids resolve to one receipt record and one purchase; and a held record whose first attempt is answered `payment_pending`, then adopts the renewal JWS, is credited at its next attempt). `testNoCredentialMonthsRanOut` and `testNoCredentialMonthsLeft` stay green under the changed check. +- Verify: `cabal test simplex-chat-test --test-options='-m "SimpleX badge service e2e"'`, then `--test-options='-m "Supporter badges"'`. `chat_query_plans.txt` is left to the full run (§7); a scoped run must not be used to regenerate it. +- Done when: AC2-AC4, AC12 and AC17 hold. + +### Slice 6: Apple subscription check (behavioural) + +- Files: `BadgeService/StoreReceipts/Apple.hs`, `BadgeService/{Config,Service}.hs`, `apps/simplex-badge-service/badge_service.ini.example`, `scripts/badge-service/badge_service.ini.example`, `apps/simplex-badge-service/README.md`, `tests/Bots/BadgeService/{StoreVerifierTests,ConfigTests}.hs`, a new fake App Store API (for example `tests/Bots/BadgeService/FakeAppStore.hs`, a Warp server like `FakePlay`). +- Change: + - Separate the pinned-root chain check from the transaction parser in `Apple.hs`, so the API's signed transactions and renewal info reuse it; parse the subscription fields (§4). + - The API key config, the ES256 JWT with reuse, "Get All Subscription Statuses", the status mapping, the HTTP classes, and `FAMILY_SHARED` refusal. + - `configureStoreVerifier` sets `checkSubscription` for Apple when the key is configured. +- Tests: Apple subscription cases in `StoreVerifierTests` against the fake API, signed with the test chain the existing Apple cases build: each status and its mapping, cancelled versus renewing by `autoRenewStatus`, revoked, offer, family-shared, a body signed by another root and a chain the check throws on, and a signed transaction or renewal info whose leaf the intermediate did not sign or whose signature does not verify (the check's `Left`), all verifier failures, never a refusal, 401/403 (internal), 404/429/5xx/timeout (unreachable), the JWT's claims and header checked by the fake. A service test: an Apple Sandbox subscription JWS is answered `test_purchase` without any call to the fake API. The API-side Sandbox case is a defence only a Sandbox host would exercise. `ConfigTests`: the key keys, an incomplete key, the default host. +- Verify: `cabal test simplex-chat-test --test-options='-m "SimpleX badge service"'`. +- Done when: AC14 and AC16's Apple part hold, and the existing Apple verifier cases pass. + +### Slice 7: Play subscription check and acknowledgement (behavioural) + +- Files: `BadgeService/StoreReceipts/Google.hs`, `BadgeService/{StoreReceipts,Service}.hs`, `tests/Bots/BadgeService/{StoreVerifierTests,FakePlay}.hs`. +- Change: `subscriptionsv2.get` through `playCall`; the state, plan, period, order and offer mapping; test purchases; the subscription acknowledgement, called before a subscription is credited and skipped when Play reports it acknowledged; `configureStoreVerifier` sets `checkSubscription` for Play; a Play subscription receipt is verified by `checkSubscription` alone. +- FakePlay gains the `purchases/subscriptionsv2/tokens/{token}` and `purchases/subscriptions/{productId}/tokens/{token}:acknowledge` routes; its existing `PlayRecord` answers serve subscription bodies. +- Tests: Play subscription cases in `StoreVerifierTests`: each state and its mapping, cancelled versus renewing, the derived period start for monthly and annual plans, an unknown base plan, a line item in a free-trial or introductory `offerPhase` (offer) and one bought on an offer now in its base-price phase (not an offer), a test purchase, a pending subscription, acknowledgement made once and skipped when already acknowledged, a failed acknowledgement crediting nothing, and the existing HTTP classes. A service test buys a Play subscription through FakePlay end to end. +- Verify: `cabal test simplex-chat-test --test-options='-m "SimpleX badge service"'`. +- Done when: AC15 and AC16's Play part hold, and the existing Play verifier cases pass. + +## 7. Test plan + +- New tests and what each proves: listed per acceptance criterion in §1 and per slice in §6. The pure planner test (AC10) proves the dating choice against the client's own check. The service tests prove grant-once, replays, bounded store use and the refusal classes. The client tests prove the badge stays on across paidThrough with no gap and comes off only on `ended`. The store tests prove each store's answers map to the right state and refusal class, and that Apple's answers are trusted only through the pinned root. +- Existing tests that must stay green: "Supporter badges" (ledger transitions, statement checks, JSON, store purchases, request loop), "SimpleX badge service" (config, web, catalog, schema cycle, store verifiers), "SimpleX badge service e2e" (renewals, lapses, retirement, alerts, store purchases, receipt worker). `testStoreUnknownProduct` changes as described. +- Full-suite check, at the end: + - `cabal test simplex-chat-test`, which also rewrites `src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt` for the changed purchase query. + - On the host, a Postgres build of the service, `cabal build --flags=+client_postgres exe:simplex-badge-service`, and a Postgres run of `cabal test --flags=+client_postgres simplex-chat-test --test-options='-m "badge service schema"'`, which executes the new migration's Postgres SQL. The deployed service is Postgres-only, and CI tests SQLite only. + +## 8. Risks + +- **Riskiest assumption, and how the first slice tests it early:** that dating every charge grant to the store's period start keeps `createdAt` non-decreasing and every row verifiable on all renewal paths, including annual renewals and recovery after billing retry or grace. Slice 3a's `testChargeRowsVerify` runs the planner's rows through the client's own `balanceChecked` before any service code depends on them. A failure there changes the design (to an explicit period field) before slices 3b-7 are built. +- **Store behaviour assumed from documentation, confirmed only with real store accounts** (Sandbox and licence testers, after this run): that Apple renewals keep `originalTransactionId` and a resubscription in the same group keeps it too; that Apple's "Get All Subscription Statuses" answers by original transaction id with the latest signed transaction; that Play keeps the token across renewals and issues a new one on resubscription after the subscription ended; that Play's period start is the period end minus the plan's length. The fake stores follow the documentation, so tests cannot catch a mismatch. If one is wrong, `SubscriptionCheck` mapping changes; the planner, the ledger and the client do not. The Play terminal answer for an ended subscription depends on the new-token premise; if Play reused the token, it becomes the day-long `payment_pending`. +- **Load:** every subscriber renewing in a week asks at the same instant (the TODO above `badgeBoundary`), and each check is up to the verifier timeout on the serial loop against a 30 s client deadline. A large renewal cohort times out and retries until requests are spread across the lead day and store calls leave the serial loop. +- **The derived purchase kind:** a purchase is a subscription exactly when its replica holds a charge credit. A future re-bind, transfer or `opening` restatement (which the protocol specifies for new devices) must keep a charge credit in the replica, or the client would retire a live subscription at paidThrough. +- **A badge waiting for a charge blocks new purchases:** while a subscription badge waits for its store to charge, the profile cannot buy or redeem another badge, for up to the store's retry window, or indefinitely if a store never reports `ended` (for example after an Apple tier change, which this run does not grant). +- **One `ended` answer is final:** the client retires on the first `ended` at or after paidThrough, and a retired purchase is not asked about again. If a store briefly reports a subscription as expired around a renewal, the renewals after it are lost until resubscription support exists. +- **Before subscriptions can be sold** (not this run, each a pay-and-get-nothing or more-than-paid case): spreading the weekly requests and moving store calls off the serial loop; resubscription after the badge was removed and restore on a new device (an Apple resubscription after retirement resolves to the old, credited receipt record); tier changes (iOS lets a user switch tier from Settings, and the new tier's charges are recorded and never granted); refund handling (a refunded annual keeps issuing until its months run out); the app screens and hand-over. + +## 9. Open questions + +None. The timing and grace behaviour, the branch, who runs builds, tier changes, Family Sharing, the first-purchase answers and the store connections are decided in §2, §4 and §6. + +## 10. Out of scope (noticed, not doing) + +- `writeIssued` answers a skipped issuance as success. Harmless for issuance; only the charge path changes here. +- The prepaid-ending alert TODO above `derivedBadgeAlert`. +- Unused drafts: `PaymentTerm`/`PTSubscription` (`PaymentService/Types.hs`), `BadgeCharge` and `BadgePlan` (`Badges/Types.hs`), `BSCUpgradeBadgeSubscription`'s `badgeRequest` (`Badges/Service.hs`). +- The Apple verifier checks no certificate validity dates or revocation. +- A Play subscription purchase is offered by the first offer on its base plan, not a named offer (`PlayStore.kt`). +- Retirement does not signal the receipt worker. +- After a renewal that lands once the shown credential has expired (billing-retry recovery), the request and the profile update happen in the same pass, because `presentIssuedBadge` presents as soon as the shown credential has expired. This already happens to late prepaid renewals; it weakens objective 3 for recovered subscriptions. + +## 11. Follow-up runs + +Each item marked **(blocks sale)** must land before subscriptions are offered in either app. + +- **(blocks sale)** Load and timing: spread requests across the lead day, drop queued requests older than the client deadline, take store calls off the serial loop behind a Postgres row lock on the purchase. +- **(blocks sale)** Resubscription and restore: a resubscription after the badge was removed and a new device's restore re-bind the subscription to the presenting key and show it again (model § recovery, "re-bind, capped per payment and period"). +- **(blocks sale)** Tier changes: a tier-changing grant for Apple upgrades and downgrades and Play replacements, and the client updating `current_badge_type`. +- **(blocks sale)** Refunds: a per-charge refund debit, so a refunded annual stops issuing; Play's Voided Purchases API. +- Store notifications: App Store Server Notifications V2 and Play real-time notifications updating charges and state between requests (a second writer, after the row lock). +- **(blocks sale)** iOS app: sell monthly and annual, hand subscription transactions over instead of finishing them, "Renews"/"Ends"/"Payment problem" on Your badge, the manage-subscriptions sheet, Restore purchases, the subscription alerts, disclosures, dev mock subscriptions. A subscription receipt must not wait behind a shown badge while the store charges (refuse code redemption while the profile has an open store purchase, or hand subscription receipts over regardless). A held subscription record adopts the newest JWS; a revoked renewal's terminal refusal must not refuse the whole subscription, and adopting a newer transaction should make the record due at once. While a subscription badge waits for its store to charge, the profile cannot buy or redeem another badge; the app should say so. +- **(blocks sale)** Kotlin port of the iOS run, plus the Play sweep querying subscriptions and offer selection by base plan. + +External waits before sale (not runs): + +- The App Store Connect subscription group and products, with Billing Grace Period off; Play subscription products with the grace period at its minimum, account hold, and subscription pausing off (§4 Timing). +- No trial or introductory offers on any subscription plan. +- Family Sharing off for the subscription products; it cannot be undone once on. +- The subscription products stay unbuyable (not live, or not offered by any app build) until sale: today's apps finish a subscription transaction without crediting it, so a buyer would pay and get nothing. +- An App Store Server API key; a Play service account with order permissions. +- Store API quotas for the expected renewal checks, raised if needed. +- Store review of the subscription screens, including how review purchases are handled: Sandbox and licence-tester purchases are answered `test_purchase`, the same open question as the one-time lane's. +- Terms and privacy links; translations. From 4278eb254e2450a0d937ca52594f25a0f84eaeb4 Mon Sep 17 00:00:00 2001 From: sh <37271604+shumvgolove@users.noreply.github.com> Date: Wed, 14 Oct 2026 10:38:10 +0400 Subject: [PATCH 13/26] badge-service: fail on missing bind mount sources (#7705) --- scripts/badge-service/compose.yml | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/scripts/badge-service/compose.yml b/scripts/badge-service/compose.yml index 0656835b9d..5047f2725f 100644 --- a/scripts/badge-service/compose.yml +++ b/scripts/badge-service/compose.yml @@ -19,8 +19,23 @@ services: - "--service-config" - "/etc/simplex-badge-service/badge_service.ini" volumes: - - ./badge_service.ini:/etc/simplex-badge-service/badge_service.ini:ro - # - ./AppleRootCA-G3.cer:/etc/simplex-badge-service/AppleRootCA-G3.cer:ro - # - ./play-service-account.json:/etc/simplex-badge-service/play-service-account.json:ro + - type: bind + source: ./badge_service.ini + target: /etc/simplex-badge-service/badge_service.ini + read_only: true + bind: + create_host_path: false + # - type: bind + # source: ./AppleRootCA-G3.cer + # target: /etc/simplex-badge-service/AppleRootCA-G3.cer + # read_only: true + # bind: + # create_host_path: false + # - type: bind + # source: ./play-service-account.json + # target: /etc/simplex-badge-service/play-service-account.json + # read_only: true + # bind: + # create_host_path: false - ./web:/srv/webapp stop_grace_period: 10s From 5db181c10e6fa3f2150cf2ea8a9e69e77dc21508 Mon Sep 17 00:00:00 2001 From: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> Date: Wed, 14 Oct 2026 10:40:34 +0000 Subject: [PATCH 14/26] badge-service: answer Play purchases on a lane of their own (#7712) --- apps/simplex-badge-service/README.md | 2 + .../src/BadgeService/Service.hs | 24 +++++++++--- .../src/BadgeService/StoreReceipts.hs | 9 +++-- .../src/BadgeService/StoreReceipts/Apple.hs | 3 +- .../src/BadgeService/StoreReceipts/Google.hs | 11 +++--- .../src/BadgeService/StoreReceipts/Mock.hs | 2 +- tests/Bots/BadgeService/BotTests.hs | 38 ++++++++++++++++++- tests/Bots/BadgeService/FakePlay.hs | 17 +++++---- tests/Bots/BadgeService/FakeStore.hs | 4 +- tests/Bots/BadgeService/StoreVerifierTests.hs | 29 ++++++++++---- 10 files changed, 105 insertions(+), 34 deletions(-) diff --git a/apps/simplex-badge-service/README.md b/apps/simplex-badge-service/README.md index 5340314da5..ef48a072ba 100644 --- a/apps/simplex-badge-service/README.md +++ b/apps/simplex-badge-service/README.md @@ -242,6 +242,8 @@ service_account_file = /etc/simplex-badge-service/play-service-account.json error naming the acknowledgement, and the app presents it again once the permission is granted, which must be within three days, before Play refunds it. The key signs in for an access token, so keep the file readable by this service alone. + Play purchases are verified on a lane of their own, so a slow or unreachable Play delays only + other Play purchases, not code redemptions, renewals or App Store purchases. Which answers are terminal for a purchase and which leave it to be presented again is listed per store in [`docs/protocol/badges-rpc.md`](../../docs/protocol/badges-rpc.md#commands). diff --git a/apps/simplex-badge-service/src/BadgeService/Service.hs b/apps/simplex-badge-service/src/BadgeService/Service.hs index 92eeeb195b..98a0a4c7ae 100644 --- a/apps/simplex-badge-service/src/BadgeService/Service.hs +++ b/apps/simplex-badge-service/src/BadgeService/Service.hs @@ -66,6 +66,7 @@ import Simplex.Chat.Bot.Store (withDB, withDB') import Simplex.Chat.Controller import Simplex.Chat.Core (sendChatCmd, simplexChatCore) import Simplex.Chat.Options (printDbOpts) +import Simplex.Chat.PaymentService (ServicePayment (..)) import Simplex.Chat.PaymentService.Types (StoreTransactionRef (..)) import Simplex.Chat.Terminal (terminalChatConfig) import Simplex.Chat.Terminal.Main (simplexChatCLI') @@ -288,9 +289,22 @@ issueBadgeCode cc IssueCodeOpts {badgeType, months, paymentStatus} = processQueuedRequests :: BadgeIssuerKey -> Maybe (TQueue GroupEvent) -> ServiceState -> IO () processQueuedRequests key trackerQ_ env = do cc <- atomically $ readTMVar $ serviceCC env - forever $ do - (u, reqId, sigKey, reqData) <- atomically $ readTQueue $ serviceRequestQ env - survive ("request " <> safeDecodeUtf8 (strEncode reqId)) $ handleServiceRequest key (storeVerifier env) cc trackerQ_ u reqId sigKey reqData + -- a Play hand-over can wait two verifyTimeouts on Play, so it waits on a lane of its own + playQ <- newTQueueIO + let answer (u, reqId, sigKey, reqData) = handleServiceRequest key (storeVerifier env) cc trackerQ_ u reqId sigKey reqData + route req@(_, _, _, reqData) + | presentsPlayReceipt reqData = atomically $ writeTQueue playQ req + | otherwise = answer req + lane q act = forever $ do + req@(_, reqId, _, _) <- atomically $ readTQueue q + survive ("request " <> safeDecodeUtf8 (strEncode reqId)) $ act req + raceAny_ [lane (serviceRequestQ env) route, lane playQ answer] + +-- | Only what creates a purchase leaves the main lane: an append to an existing ledger is guarded by nothing but that lane being serial. +presentsPlayReceipt :: J.Object -> Bool +presentsPlayReceipt reqData = case J.fromJSON (J.Object reqData) of + J.Success BadgeServiceRequest {request = BSCPurchaseBadge {payment = SPGoogle {}, upgrade = Nothing}} -> True + _ -> False -- | Cancellation is rethrown, since that is how the race stops this thread. The -- exception itself is not logged: it can quote the request, which carries codes and store receipts. @@ -465,10 +479,10 @@ purchaseWithReceipt key cc purchaseKey masterKey StoreReceipt {txRef = StoreTran Right (Left resp) -> resp _ -> errorResponse BSEInternal -- the product is read only for a receipt not yet credited, so retiring it leaves its replays answered - newPurchase VerifiedStoreTransaction {productId, paid} = case storeProduct provider productId of + newPurchase tx@VerifiedStoreTransaction {productId, paid} = case storeProduct provider productId of Nothing -> pure $ errorResponse BSEProductUnavailable Just StoreProduct {badgeType, months} -> - fromMaybe (pure $ Right ()) acknowledgeReceipt >>= \case + maybe (pure $ Right ()) ($ tx) acknowledgeReceipt >>= \case Left refusal -> storeRefusalResponse refusal Right () -> do now <- badgeNow cc diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs index 952a4d0152..2789e80c54 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts.hs @@ -32,7 +32,8 @@ data VerifiedStoreTransaction = VerifiedStoreTransaction quantity :: Int, -- as the store reported it; the service refuses any but 1, as the apps never buy more -- costs the buyer nothing: Apple's Sandbox, which a public TestFlight build buys in, and Google's license testers testPurchase :: Bool, - paid :: Maybe (CurrencyAmount, Text) -- in minor units; Google's purchase record carries no price + paid :: Maybe (CurrencyAmount, Text), -- in minor units; Google's purchase record carries no price + alreadyAcknowledged :: Bool -- Play's record says acknowledged or consumed; other stores have nothing to acknowledge } deriving (Eq, Show) @@ -55,7 +56,7 @@ data StoreVerifier = StoreVerifier verifyApple :: Maybe (Text -> Either StoreRefusal VerifiedStoreTransaction), verifyGoogle :: Maybe (Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction)), -- the product id and the token acknowledgeGoogle :: Maybe (Text -> Text -> IO (Either StoreRefusal ())), - -- microseconds; requests are answered one at a time, so a verifier that does not finish holds up every other one + -- microseconds; a lane answers one request at a time, so a verifier that does not finish holds up the rest of its lane verifyTimeout :: Int } @@ -63,7 +64,7 @@ data StoreVerifier = StoreVerifier data StoreReceipt = StoreReceipt { txRef :: StoreTransactionRef, verifyReceipt :: IO (Either StoreRefusal VerifiedStoreTransaction), - acknowledgeReceipt :: Maybe (IO (Either StoreRefusal ())) + acknowledgeReceipt :: Maybe (VerifiedStoreTransaction -> IO (Either StoreRefusal ())) } noStoreVerifier :: StoreVerifier @@ -87,7 +88,7 @@ toStoreReceipt StoreVerifier {verifyApple, verifyGoogle, acknowledgeGoogle, veri StoreReceipt (StoreTransactionRef PPGoogle (googlePurchaseRef token)) (maybe unconfigured (\verify -> online "google verifier" $ verify productId token) verifyGoogle) - ((\acknowledge -> online "acknowledging: google" $ acknowledge productId token) <$> acknowledgeGoogle) + ((\acknowledge VerifiedStoreTransaction {alreadyAcknowledged} -> if alreadyAcknowledged then pure (Right ()) else online "acknowledging: google" $ acknowledge productId token) <$> acknowledgeGoogle) SPInvoice {} -> Nothing SPReceipt {} -> Nothing where diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs index 90cc69915c..42200fcc0c 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs @@ -143,7 +143,8 @@ transaction ourBundleId AppleTransaction {transactionId, productId, bundleId, en productId, quantity, testPurchase, - paid = paidOf price currency + paid = paidOf price currency, + alreadyAcknowledged = False } -- | Apple's price is in milliunits of the currency, whatever its minor unit. diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs index f70d8cba77..98cb1fc050 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Google.hs @@ -1,3 +1,4 @@ +{-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} @@ -85,10 +86,7 @@ verifyPurchase env productId token = (>>= purchaseVerdict productId token) <$> r -- which is how the app finds a purchase it has not yet settled. acknowledgePurchase :: PlayEnv -> Text -> Text -> IO (Either StoreRefusal ()) acknowledgePurchase env productId token = - readPurchase env productId token >>= \case - Left refusal -> pure $ Left $ acknowledging refusal - Right ProductPurchase {alreadyAcknowledged = True} -> pure $ Right () - Right _ -> bimap acknowledging (const ()) <$> playCall env (\req -> req {method = methodPost}) (purchaseUrl env productId token <> ":acknowledge") + bimap acknowledging (const ()) <$> playCall env (\req -> req {method = methodPost}) (purchaseUrl env productId token <> ":acknowledge") where acknowledging = \case SRUnreachable reason -> SRUnreachable $ "acknowledging: " <> reason @@ -118,7 +116,7 @@ playCall env@PlayEnv {accessToken} prepare url = Right (code, _) -> pure $ Left $ SRUnreachable $ "Play answered HTTP " <> tshow code purchaseVerdict :: Text -> Text -> ProductPurchase -> Either StoreRefusal VerifiedStoreTransaction -purchaseVerdict productId token ProductPurchase {purchaseState, purchaseType, purchaseQuantity, purchaseProductId} +purchaseVerdict productId token ProductPurchase {purchaseState, purchaseType, purchaseQuantity, purchaseProductId, alreadyAcknowledged} | maybe False (/= productId) purchaseProductId = Left $ SRVerifierFailed "Play answered about another product" | otherwise = case purchaseState of 0 -> purchased <$> testPurchaseOf purchaseType @@ -133,7 +131,8 @@ purchaseVerdict productId token ProductPurchase {purchaseState, purchaseType, pu productId, quantity = fromMaybe 1 purchaseQuantity, testPurchase, - paid = Nothing + paid = Nothing, + alreadyAcknowledged } testPurchaseOf = \case Nothing -> Right False diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs index 5de05fbf99..f7b1a14c9b 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Mock.hs @@ -38,4 +38,4 @@ vouched :: Text -> Text -> VerifiedStoreTransaction vouched transactionRef productId = -- not a test purchase, though nothing was paid: a test purchase is refused as test_purchase, which is -- terminal and drops the client's keys, so every dev purchase would fail for good - VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase = False, paid = Nothing} + VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase = False, paid = Nothing, alreadyAcknowledged = False} diff --git a/tests/Bots/BadgeService/BotTests.hs b/tests/Bots/BadgeService/BotTests.hs index 2c52cc3445..dcc53d30b2 100644 --- a/tests/Bots/BadgeService/BotTests.hs +++ b/tests/Bots/BadgeService/BotTests.hs @@ -26,7 +26,7 @@ import qualified Simplex.Messaging.Agent.Store.DB as DB import ChatClient import ChatTests.DBUtils import ChatTests.Utils -import Control.Concurrent (threadDelay) +import Control.Concurrent (newEmptyMVar, putMVar, takeMVar, threadDelay) import Control.Concurrent.Async (async, cancel) import Control.Concurrent.STM (TQueue, atomically, readTMVar, readTQueue) import Control.Monad (forM_, void, when) @@ -175,6 +175,8 @@ badgeServiceTests = do it "should delete a month-old record that will fund no badge, and keep held and credited ones" testStoreReceiptCleanup it "should keep a receipt whose attempt throws" testStoreReceiptAttemptThrows it "should credit a held receipt after the app restarts" testStoreReceiptAfterRestart + describe "the Play lane" $ do + it "should answer other requests while a Play receipt is with the store, and credit it once Play answers" testPlayHoldsNoOtherRequest badgeBotName :: Text badgeBotName = "SimpleX Badges" @@ -2306,6 +2308,40 @@ testStoreReceiptAfterRestart ps = do expectLinesWithin 60 alice (creditedLines "" invoiceId "1: supporter") ["subscribed 1 connections on server localhost"] heldStoreReceipts (chatController alice) `shouldReturn` 0 +testPlayHoldsNoOtherRequest :: HasCallStack => TestParams -> IO () +testPlayHoldsNoOtherRequest ps = do + entered <- newEmptyMVar + release <- newEmptyMVar + hook <- newIORef $ putMVar entered () >> takeMVar release + -- past the 20s line wait, so a request queued behind the held call cannot be answered in time + let holding store = (googleVerifierWithHook hook store) {verifyTimeout = 60000000} + withBadgeServiceVerifier ps holding $ \BadgeServiceEnv {bsClientCfg, bsAddress, bsController = cc, bsStore = FakeStore {appleSupporterJWS}} -> + withNewTestChatCfg ps bsClientCfg "alice" aliceProfile $ \alice -> + withNewTestChatCfg ps bsClientCfg "bob" bobProfile $ \bob -> + withNewTestChatCfg ps bsClientCfg "cath" cathProfile $ \cath -> do + alice ##> ("/_badge purchase 1 " <> paymentArg supporterPlay) + storePurchaseOpen alice "" + timeout 30000000 (takeMVar entered) `shouldReturn` Just () + code <- issueCode cc BTSupporter 1 + bob ##> ("/_redeem_badge_code 1 " <> codeArg code) + bob <## "badge redeemed" + bob <## "supporter badge - active" + bob <##. "expires " + cath ##> ("/_badge purchase 1 " <> paymentArg SPApple {jws = appleSupporterJWS}) + cath <### [StartsWith (openPurchase ""), StartsWith "1: supporter"] + g <- C.newRandom + (upgradeKey, upgradePriv) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) + (fromPurchaseKey, fromPriv) <- atomically $ C.generateKeyPair g :: IO (C.KeyPair 'C.Ed25519) + masterKey <- generateMasterKey g + now <- getCurrentTime + let upgrade = BadgeUpgrade {fromPurchaseKey, receipt = "receipt", receiptSignature = C.sign' fromPriv "receipt", balance = BadgeBalance {lastEntry = emptyEntry now BTSupporter}} + upgradeReq = LB.unpack $ J.encode $ requestObject upgradeKey BSCPurchaseBadge {masterKey, payment = supporterPlay, upgrade = Just upgrade} + bob ##> ("/_service_request 1 " <> bsAddress <> " sign_key=" <> B.unpack (strEncode $ C.StoredPrivateKey upgradePriv) <> " " <> upgradeReq) + bob <## "service response: {\"code\":\"bad_request\",\"type\":\"error\"}" + putMVar release () + expectLinesWithin 60 alice ["1: supporter"] [] + rowCount cc "sx_badge_service_badge_purchases" `shouldReturn` 3 + createInvoice :: HasCallStack => TestCC -> Int -> IO String createInvoice cc userId = do cc ##> ("/_badge invoice " <> show userId) diff --git a/tests/Bots/BadgeService/FakePlay.hs b/tests/Bots/BadgeService/FakePlay.hs index cc479853c7..f5b346a5e3 100644 --- a/tests/Bots/BadgeService/FakePlay.hs +++ b/tests/Bots/BadgeService/FakePlay.hs @@ -50,7 +50,8 @@ data FakePlay = FakePlay fpTokenSeconds :: TVar Int, fpGrantedTokens :: TVar [B.ByteString], fpPurchasePaths :: TVar [[Text]], - fpAcknowledgeRefusal :: TVar (Maybe Int), + -- what the acknowledge endpoint answers instead of acknowledging + fpAcknowledgeRefusal :: TVar (Maybe PlayAnswer), fpAcknowledged :: TVar [Text] } @@ -122,7 +123,7 @@ answerTokenRequests FakePlay {fpTokenRefusal} = atomically . writeTVar fpTokenRe grantTokensFor :: FakePlay -> Int -> IO () grantTokensFor FakePlay {fpTokenSeconds} = atomically . writeTVar fpTokenSeconds -answerAcknowledgements :: FakePlay -> Maybe Int -> IO () +answerAcknowledgements :: FakePlay -> Maybe PlayAnswer -> IO () answerAcknowledgements FakePlay {fpAcknowledgeRefusal} = atomically . writeTVar fpAcknowledgeRefusal fakeApp :: RSA.PublicKey -> FakePlay -> Application @@ -143,7 +144,7 @@ fakeApp key FakePlay {fpConfig = PlayStoreConfig {gTokenUrl}, fpAnswers, fpToken _ -> respond $ status unauthorized401 acknowledge token = readTVarIO fpAcknowledgeRefusal >>= \case - Just code -> respond $ status (mkStatus code "Refused") + Just answer -> answerWith answer Nothing -> do atomically $ modifyTVar' fpAcknowledged (<> [token]) respond $ responseLBS ok200 [] "" @@ -168,11 +169,13 @@ fakeApp key FakePlay {fpConfig = PlayStoreConfig {gTokenUrl}, fpAnswers, fpToken _ -> False purchase token = M.lookup token <$> readTVarIO fpAnswers >>= \case - Just (PlayRecord v) -> respond $ json ok200 v - Just (PlayBody b) -> respond $ responseLBS ok200 [(hContentType, "application/json")] b - Just (PlayStatus code) -> respond $ status (mkStatus code "Answer") - Just PlayHang -> forever $ threadDelay 1000000 + Just answer -> answerWith answer Nothing -> respond $ status notFound404 + answerWith = \case + PlayRecord v -> respond $ json ok200 v + PlayBody b -> respond $ responseLBS ok200 [(hContentType, "application/json")] b + PlayStatus code -> respond $ status (mkStatus code "Answer") + PlayHang -> forever $ threadDelay 1000000 json :: Status -> J.Value -> Response json st = responseLBS st [(hContentType, "application/json")] . J.encode diff --git a/tests/Bots/BadgeService/FakeStore.hs b/tests/Bots/BadgeService/FakeStore.hs index bede2de8e7..c8c7048a48 100644 --- a/tests/Bots/BadgeService/FakeStore.hs +++ b/tests/Bots/BadgeService/FakeStore.hs @@ -89,7 +89,7 @@ newFakeStore = do where fixtureJWS name = unsignedJWS <$> B.readFile (fixtureDir name) appleTransaction transactionRef productId testPurchase cents = - VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase, paid = Just (CurrencyAmount cents, "USD")} + VerifiedStoreTransaction {transactionRef, productId, quantity = 1, testPurchase, paid = Just (CurrencyAmount cents, "USD"), alreadyAcknowledged = False} googleVerdict :: IORef Bool -> IORef Bool -> Text -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) googleVerdict pendingSettled googleDown productId token = @@ -106,7 +106,7 @@ googleVerdict pendingSettled googleDown productId token = | token == googleHangingToken -> forever $ threadDelay 1000000 | otherwise -> pure $ Left $ SRInvalid "not a fake purchase" where - purchased = VerifiedStoreTransaction {transactionRef = googlePurchaseRef token, productId, quantity = 1, testPurchase = False, paid = Nothing} + purchased = VerifiedStoreTransaction {transactionRef = googlePurchaseRef token, productId, quantity = 1, testPurchase = False, paid = Nothing, alreadyAcknowledged = False} -- | The fake store, running the hook's action once, inside the first Google verification, before it answers. googleVerifierWithHook :: IORef (IO ()) -> FakeStore -> StoreVerifier diff --git a/tests/Bots/BadgeService/StoreVerifierTests.hs b/tests/Bots/BadgeService/StoreVerifierTests.hs index be4e6f2e26..e428e0ed1e 100644 --- a/tests/Bots/BadgeService/StoreVerifierTests.hs +++ b/tests/Bots/BadgeService/StoreVerifierTests.hs @@ -71,6 +71,7 @@ badgeStoreVerifierTests = describe "badge store verifiers" $ do it "asks for a new access token once the one it holds is about to expire" testPlayTokenExpires it "sends no token that is only dots, and describes a token outside the grammar without quoting it" testPlayTokensNotSent it "acknowledges a purchase, unless it is acknowledged or consumed already" testPlayAcknowledges + it "reads a purchase once to verify and acknowledge it, and acknowledges only what that read found unacknowledged" testPlayReadsPurchaseOnce it "reports an acknowledgement Play refuses or does not answer" testPlayAcknowledgementFails it "acknowledges through the verifier a [google] section configures" testPlayConfiguredAcknowledges @@ -219,7 +220,7 @@ testAppleVerdict = do chain <- trustedChain jws <- signedBy chain $ transactionPayload [] [] appleVerdict (rootCert chain) jws - `shouldReturn` Right VerifiedStoreTransaction {transactionRef = "2000000900000001", productId = "BADGE_SUPPORTER_01", quantity = 1, testPurchase = False, paid = Just (CurrencyAmount 700, "USD")} + `shouldReturn` Right VerifiedStoreTransaction {transactionRef = "2000000900000001", productId = "BADGE_SUPPORTER_01", quantity = 1, testPurchase = False, paid = Just (CurrencyAmount 700, "USD"), alreadyAcknowledged = False} appleTransactionId jws `shouldBe` Just "2000000900000001" testAppleRootNotTrusted :: IO () @@ -371,7 +372,10 @@ playVerifier fake = acknowledgement :: StoreVerifier -> ServicePayment -> IO (Maybe (Either StoreRefusal ())) acknowledgement verifier payment = case toStoreReceipt verifier payment of - Just (Right StoreReceipt {acknowledgeReceipt}) -> sequence acknowledgeReceipt + Just (Right StoreReceipt {verifyReceipt, acknowledgeReceipt}) -> + verifyReceipt >>= \case + Right tx -> traverse ($ tx) acknowledgeReceipt + Left refusal -> expectationFailure ("not verified: " <> show refusal) >> undefined _ -> expectationFailure "not a store receipt" >> undefined playVerdict :: StoreVerifier -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) @@ -406,7 +410,7 @@ testPlayPurchased = withFakePlay $ \fake -> do verifier <- playVerifier fake answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] playVerdict verifier testToken - `shouldReturn` Right VerifiedStoreTransaction {transactionRef = googlePurchaseRef testToken, productId = "badge_supporter_01", quantity = 1, testPurchase = False, paid = Nothing} + `shouldReturn` Right VerifiedStoreTransaction {transactionRef = googlePurchaseRef testToken, productId = "badge_supporter_01", quantity = 1, testPurchase = False, paid = Nothing, alreadyAcknowledged = False} readTVarIO (fpPurchasePaths fake) `shouldReturn` [["androidpublisher", "v3", "applications", fakePackageName, "purchases", "products", "badge_supporter_01", "tokens", testToken]] answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [("quantity", J.toJSON (2 :: Int)), ("productId", "badge_supporter_01")] @@ -530,6 +534,18 @@ testPlayAcknowledges = withFakePlay $ \fake -> do acknowledging `shouldReturn` Just (Right ()) readTVarIO (fpAcknowledged fake) `shouldReturn` [testToken] +testPlayReadsPurchaseOnce :: IO () +testPlayReadsPurchaseOnce = do + requestsFor [] `shouldReturn` (1, [testToken]) + forM_ ["acknowledgementState", "consumptionState"] $ \state -> + requestsFor [(state, J.toJSON (1 :: Int))] `shouldReturn` (1, []) + where + requestsFor fields = withFakePlay $ \fake -> do + verifier <- playVerifier fake + answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 fields + acknowledgement verifier SPGoogle {productId = "badge_supporter_01", token = testToken} `shouldReturn` Just (Right ()) + (,) <$> (length <$> readTVarIO (fpPurchasePaths fake)) <*> readTVarIO (fpAcknowledged fake) + testPlayAcknowledgementFails :: IO () testPlayAcknowledgementFails = withFakePlay $ \fake -> do verifier <- playVerifier fake @@ -539,12 +555,11 @@ testPlayAcknowledgementFails = withFakePlay $ \fake -> do maybe "" reason r `shouldSatisfy` ("acknowledging: " `T.isPrefixOf`) maybe "" reason r `shouldNotSatisfy` (testToken `T.isInfixOf`) answerPurchase fake testToken $ PlayRecord $ purchaseRecord 0 [] - answerAcknowledgements fake $ Just 403 + answerAcknowledgements fake $ Just $ PlayStatus 403 acknowledgedAs Failed - answerAcknowledgements fake $ Just 503 + answerAcknowledgements fake $ Just $ PlayStatus 503 acknowledgedAs Unreachable - answerAcknowledgements fake Nothing - answerPurchase fake testToken PlayHang + answerAcknowledgements fake $ Just PlayHang acknowledgedAs Unreachable readTVarIO (fpAcknowledged fake) `shouldReturn` [] From daa7c4f3d8315005e03d78c86cec2ca988f594d2 Mon Sep 17 00:00:00 2001 From: sh <37271604+shumvgolove@users.noreply.github.com> Date: Wed, 14 Oct 2026 14:43:53 +0400 Subject: [PATCH 15/26] badge-service: accept a list of Apple roots (#7707) * badge-service: accept a list of Apple roots * badge-service: document root_certificates --------- Co-authored-by: spaced4ndy <8711996+spaced4ndy@users.noreply.github.com> --- apps/simplex-badge-service/README.md | 21 ++++++++------ .../badge_service.ini.example | 7 +++-- .../src/BadgeService/Config.hs | 14 ++++++--- .../src/BadgeService/Service.hs | 4 +-- .../src/BadgeService/StoreReceipts/Apple.hs | 27 +++++++++++------- .../test-fixtures/apple/AppleRootCA-G3.cer | Bin 0 -> 583 bytes docs/protocol/badges-rpc.md | 2 +- .../badge-service/badge_service.ini.example | 7 +++-- tests/Bots/BadgeService/ConfigTests.hs | 7 +++-- tests/Bots/BadgeService/StoreVerifierTests.hs | 25 +++++++++++++--- 10 files changed, 76 insertions(+), 38 deletions(-) create mode 100644 apps/simplex-badge-service/test-fixtures/apple/AppleRootCA-G3.cer diff --git a/apps/simplex-badge-service/README.md b/apps/simplex-badge-service/README.md index ef48a072ba..bb1cec2230 100644 --- a/apps/simplex-badge-service/README.md +++ b/apps/simplex-badge-service/README.md @@ -213,25 +213,30 @@ two included, answers `method_not_allowed`. Each store is verified only when its section is present; without one, every receipt from that store is answered `provider_not_configured` and the app keeps the purchase to present again. A section -missing a key, an unreadable root certificate or service account key, or either section beside +missing a key, a root certificate that cannot be read or is not a root, an unreadable service +account key, or either section beside `[dev] accept_unverified_store_receipts = on`, stops the service at startup. ```ini [apple] bundle_id = chat.simplex.app -root_certificate = /etc/simplex-badge-service/AppleRootCA-G3.cer +root_certificates = /etc/simplex-badge-service/AppleRootCA-G3.cer [google] package_name = chat.simplex.app service_account_file = /etc/simplex-badge-service/play-service-account.json ``` -- `[apple]` verifies the signed transaction offline, against Apple Root CA - G3 in DER as Apple - publishes it at . A transaction - for another bundle id, or a chain this root does not verify, is answered `internal` and logged as - an error rather than refused, since `bundle_id` or `root_certificate` may be the wrong one; check - both when those errors appear, unless the purchase was made in Xcode's StoreKit testing, which - the App Store does not sign, so no root verifies it. +- `[apple]` verifies the signed transaction offline, against the roots `root_certificates` lists, + comma-separated, each in DER. Today that is Apple Root CA - G3 as Apple publishes it at + . Each must be self-signed. + Verification reads no validity period, so an expired root keeps verifying. A transaction for + another bundle id, or an intermediate no listed root signed, is answered `internal` and logged as + an error rather than refused, since `bundle_id` may be wrong or a root missing; check both when those errors appear, unless the purchase was made in Xcode's + StoreKit testing, which the App Store does not sign, so no root verifies it. When Apple signs + under a new root, list it beside the old one rather than in its place: a purchase signed under the + old root still verifies, and one answered `internal` meanwhile is credited when the app presents + it again. - `[google]` asks the Google Play Developer API about each purchase, and acknowledges it before crediting it, as the service account whose JSON key `service_account_file` holds. The account needs both Play Console permissions Google's diff --git a/apps/simplex-badge-service/badge_service.ini.example b/apps/simplex-badge-service/badge_service.ini.example index 20d4e8614b..26abb5aa7e 100644 --- a/apps/simplex-badge-service/badge_service.ini.example +++ b/apps/simplex-badge-service/badge_service.ini.example @@ -42,11 +42,12 @@ idle_seconds = 60 ; verifies App Store purchases offline. Omit the whole section and the service answers every App Store ; receipt provider_not_configured, which the app retries later. -; root_certificate is Apple Root CA - G3 as Apple publishes it, in DER: -; https://www.apple.com/certificateauthority/AppleRootCA-G3.cer +; root_certificates lists, comma-separated, the roots trusted to sign receipts, each in DER. Today that +; is Apple Root CA - G3 as Apple publishes it: https://www.apple.com/certificateauthority/AppleRootCA-G3.cer +; When Apple adds a root, list it beside the old one rather than in its place. ;[apple] ;bundle_id = chat.simplex.app -;root_certificate = /etc/simplex-badge-service/AppleRootCA-G3.cer +;root_certificates = /etc/simplex-badge-service/AppleRootCA-G3.cer ; verifies Play purchases with the Google Play Developer API. Omit the whole section and the service answers ; every Play receipt provider_not_configured, which the app retries later. diff --git a/apps/simplex-badge-service/src/BadgeService/Config.hs b/apps/simplex-badge-service/src/BadgeService/Config.hs index 493c95c27e..72e774fdac 100644 --- a/apps/simplex-badge-service/src/BadgeService/Config.hs +++ b/apps/simplex-badge-service/src/BadgeService/Config.hs @@ -28,6 +28,8 @@ import Control.Monad (mfilter, when) import Data.Attoparsec.Text (Parser, endOfInput, isEndOfLine, parseOnly, satisfy, skipMany, skipSpace, skipWhile) import qualified Data.ByteString.Char8 as B import Data.Ini (Ini, iniGlobals, iniParser, keys, lookupValue, sections) +import Data.List.NonEmpty (NonEmpty) +import qualified Data.List.NonEmpty as L import Data.Maybe (fromMaybe, isJust) import Data.Text (Text) import qualified Data.Text as T @@ -95,7 +97,7 @@ data PollConfig = PollConfig {pWaitingSeconds :: Int, pIdleSeconds :: Int} data AppleStoreConfig = AppleStoreConfig { aBundleId :: Text, - aRootCertificate :: FilePath + aRootCertificates :: NonEmpty FilePath } deriving (Eq, Show) @@ -190,7 +192,7 @@ knownSettings = ("btcpay", ["host", "api_key", "store_id", "webhook_secret", "expiry_minutes", "speed_policy", "payment_tolerance"]), ("stripe", ["secret_key", "publishable_key", "webhook_secret", "session_minutes"]), ("poll", ["waiting_seconds", "idle_seconds"]), - ("apple", ["bundle_id", "root_certificate"]), + ("apple", ["bundle_id", "root_certificates"]), ("google", ["package_name", "service_account_file"]), ("group", ["display_name", "description"]), ("dev", ["accept_unverified_store_receipts"]), @@ -336,8 +338,12 @@ parseConfig ini = do | not (hasSection "apple") = Right Nothing | otherwise = do aBundleId <- required "apple" "bundle_id" - aRootCertificate <- T.unpack <$> required "apple" "root_certificate" - pure (Just AppleStoreConfig {aBundleId, aRootCertificate}) + aRootCertificates <- rootCertificates + pure (Just AppleStoreConfig {aBundleId, aRootCertificates}) + rootCertificates = do + v <- required "apple" "root_certificates" + maybe (Left "apple.root_certificates must list at least one file") Right $ + L.nonEmpty $ map T.unpack $ filter (not . T.null) $ map T.strip $ T.splitOn "," v googleSection | not (hasSection "google") = Right Nothing | otherwise = do diff --git a/apps/simplex-badge-service/src/BadgeService/Service.hs b/apps/simplex-badge-service/src/BadgeService/Service.hs index 98a0a4c7ae..72389c8cc7 100644 --- a/apps/simplex-badge-service/src/BadgeService/Service.hs +++ b/apps/simplex-badge-service/src/BadgeService/Service.hs @@ -141,8 +141,8 @@ configureStoreVerifier serviceCfg env@ServiceState {storeVerifier = v} = case se logWarn "[dev] accept_unverified_store_receipts is on: any store receipt is accepted without verification" pure env {storeVerifier = mockStoreVerifier} Just ServiceConfig {appleStore, playStore} -> do - apple <- forM appleStore $ \AppleStoreConfig {aBundleId, aRootCertificate} -> - (\root -> verifyAppleTransaction root aBundleId) <$> orExit (readAppleRoot aRootCertificate) + apple <- forM appleStore $ \AppleStoreConfig {aBundleId, aRootCertificates} -> + (\roots -> verifyAppleTransaction roots aBundleId) <$> mapM (orExit . readAppleRoot) aRootCertificates google <- forM playStore $ orExit . playStoreVerifier forM_ appleStore $ \AppleStoreConfig {aBundleId} -> logInfo $ "verifying App Store receipts for " <> aBundleId forM_ playStore $ \PlayStoreConfig {gPackageName} -> logInfo $ "verifying Play purchases for " <> gPackageName diff --git a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs index 42200fcc0c..c94c6dec61 100644 --- a/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs +++ b/apps/simplex-badge-service/src/BadgeService/StoreReceipts/Apple.hs @@ -25,6 +25,7 @@ import qualified Data.ByteString as B import qualified Data.ByteString.Base64 as B64 import qualified Data.ByteString.Base64.URL as B64U import Data.Foldable (toList) +import Data.List.NonEmpty (NonEmpty) import Data.Maybe (isJust) import Data.Text (Text) import qualified Data.Text as T @@ -36,10 +37,10 @@ import Data.X509.Validation (SignatureFailure (..), SignatureVerification (..), import Simplex.Chat.PaymentService.Types (CurrencyAmount (..)) import Simplex.Messaging.Util (eitherToMaybe) -verifyAppleTransaction :: SignedCertificate -> Text -> Text -> Either StoreRefusal VerifiedStoreTransaction -verifyAppleTransaction root ourBundleId jws = case T.splitOn "." jws of +verifyAppleTransaction :: NonEmpty SignedCertificate -> Text -> Text -> Either StoreRefusal VerifiedStoreTransaction +verifyAppleTransaction roots ourBundleId jws = case T.splitOn "." jws of [header, payload, signature] -> do - leaf <- signingChain root =<< certificateChain header + leaf <- signingChain roots =<< certificateChain header sig <- jwsSignature signature key <- leafKey leaf unless (ECDSA.verify SHA256 key sig (encodeUtf8 $ header <> "." <> payload)) $ @@ -65,14 +66,14 @@ certificateChain header = do J.String c | Right bs <- B64.decode (encodeUtf8 c) -> Right bs _ -> refused "an x5c certificate is not base64" --- | The root in the chain is ignored: trust comes from the configured one alone. -signingChain :: SignedCertificate -> [ByteString] -> Either StoreRefusal SignedCertificate -signingChain root = \case +-- | The root in the chain is ignored: trust comes from the configured ones alone. +signingChain :: NonEmpty SignedCertificate -> [ByteString] -> Either StoreRefusal SignedCertificate +signingChain roots = \case [leafDer, intermediateDer, _] -> do leaf <- certificate leafDer intermediate <- certificate intermediateDer - -- the configured root may be stale or wrong as likely as the receipt forged, so this retries rather than refuses - unless (signedBy root intermediate) $ failed "the intermediate is not signed by the configured root" + -- a root may be missing or wrong as likely as the receipt forged, so this retries rather than refuses + unless (any (`signedBy` intermediate) roots) $ failed "the intermediate is not signed by a configured root" case verifySignedSignature leaf (certPubKey $ getCertificate intermediate) of SignaturePass -> Right () SignatureFailed SignatureInvalid -> refused "the leaf is not signed by the intermediate" @@ -84,7 +85,6 @@ signingChain root = \case _ -> failed "x5c is not leaf, intermediate and root" where certificate = either (const $ failed "an x5c certificate does not decode") Right . decodeSignedCertificate - signedBy issuer cert = verifySignedSignature cert (certPubKey $ getCertificate issuer) == SignaturePass marked oid cert = case certExtensions (getCertificate cert) of Extensions (Just exts) -> any ((== oid) . extRawOID) exts Extensions Nothing -> False @@ -175,8 +175,15 @@ refused = Left . SRInvalid failed :: Text -> Either StoreRefusal a failed = Left . SRVerifierFailed . ("apple verifier: " <>) +signedBy :: SignedCertificate -> SignedCertificate -> Bool +signedBy issuer cert = verifySignedSignature cert (certPubKey $ getCertificate issuer) == SignaturePass + readAppleRoot :: FilePath -> IO (Either String SignedCertificate) readAppleRoot path = try (B.readFile path) >>= \case Left (_ :: IOException) -> pure $ Left $ path <> ": could not be read" - Right der -> pure $ either (const $ Left $ path <> ": is not a DER certificate") Right $ decodeSignedCertificate der + Right der -> pure $ either (const $ Left $ path <> ": is not a DER certificate") checkRoot $ decodeSignedCertificate der + where + checkRoot root + | signedBy root root = Right root + | otherwise = Left $ path <> ": is not a self-signed root certificate" diff --git a/apps/simplex-badge-service/test-fixtures/apple/AppleRootCA-G3.cer b/apps/simplex-badge-service/test-fixtures/apple/AppleRootCA-G3.cer new file mode 100644 index 0000000000000000000000000000000000000000..228bfa39cbd5acfe53fb9d196e3c1bbbd28649f8 GIT binary patch literal 583 zcmXqLVsbWUVm!HknTe5!i9`43pN>mMy{8&*v2kd%d7QIlVP-Z+HbQ8gAnH8xlJyL^4LCu9Y{E>T!3J{TyoM$QCdLMa7KWAvW>Mn2#+FE2`Z=V` zK!A-M?0+UkHdgIM76v8eBnFllFZFF5ik7^ctW?w}EOS?2>c^vt{R;1hh~4CSx{Ot; zJf%9`&*JiK8JDf~U*)$MCB>e6*%Iw<;4c`(@HZlYXX#gd9ba~L;nG{vr%%r}jCrd) zw_3sa#?FwNaWj`#1#%fKb~11^i`@ju(^Y`3K= md8u*U (Either String ServiceConfig -> IO a) -> IO a withDev keys act = withIni (fullIni <> "[dev]\n" <> keys) $ \p -> readServiceConfig p >>= act appleIni, googleIni :: T.Text -appleIni = "[apple]\nbundle_id = chat.simplex.app\nroot_certificate = /etc/badges/AppleRootCA-G3.cer\n" +appleIni = "[apple]\nbundle_id = chat.simplex.app\nroot_certificates = /etc/badges/AppleRootCA-G3.cer ,/etc/badges/AppleRootCA-G4.cer,\n" googleIni = "[google]\npackage_name = chat.simplex.app\nservice_account_file = /etc/badges/play.json\n" testStoresAbsent :: IO () @@ -398,7 +399,7 @@ testStoresAbsent = withIni fullIni $ \p -> do testStoresRead :: IO () testStoresRead = withIni (fullIni <> appleIni <> googleIni) $ \p -> do Right cfg <- readServiceConfig p - appleStore cfg `shouldBe` Just AppleStoreConfig {aBundleId = "chat.simplex.app", aRootCertificate = "/etc/badges/AppleRootCA-G3.cer"} + appleStore cfg `shouldBe` Just AppleStoreConfig {aBundleId = "chat.simplex.app", aRootCertificates = "/etc/badges/AppleRootCA-G3.cer" :| ["/etc/badges/AppleRootCA-G4.cer"]} playStore cfg `shouldBe` Just PlayStoreConfig @@ -411,7 +412,7 @@ testStoresRead = withIni (fullIni <> appleIni <> googleIni) $ \p -> do testStoresIncomplete :: IO () testStoresIncomplete = do refused (T.replace "bundle_id = chat.simplex.app\n" "" appleIni) "apple.bundle_id" - refused (T.replace "root_certificate = /etc/badges/AppleRootCA-G3.cer\n" "" appleIni) "apple.root_certificate" + refused (T.replace "root_certificates = /etc/badges/AppleRootCA-G3.cer ,/etc/badges/AppleRootCA-G4.cer,\n" "" appleIni) "apple.root_certificates" refused (T.replace "package_name = chat.simplex.app\n" "" googleIni) "google.package_name" refused (T.replace "service_account_file = /etc/badges/play.json\n" "" googleIni) "google.service_account_file" where diff --git a/tests/Bots/BadgeService/StoreVerifierTests.hs b/tests/Bots/BadgeService/StoreVerifierTests.hs index e428e0ed1e..27e73c7154 100644 --- a/tests/Bots/BadgeService/StoreVerifierTests.hs +++ b/tests/Bots/BadgeService/StoreVerifierTests.hs @@ -25,8 +25,10 @@ import qualified Data.ByteString as B import qualified Data.ByteString.Base64 as B64 import qualified Data.ByteString.Base64.URL as B64U import qualified Data.ByteString.Lazy as LB +import Data.Either (isRight) import Data.Hourglass (Date (..), DateTime (..), Month (..), TimeOfDay (..)) import Data.List (isInfixOf) +import Data.List.NonEmpty (NonEmpty (..)) import Data.Text (Text) import qualified Data.Text as T import Data.Text.Encoding (decodeUtf8) @@ -42,6 +44,7 @@ badgeStoreVerifierTests :: Spec badgeStoreVerifierTests = describe "badge store verifiers" $ do describe "App Store signed transactions" $ do it "vouches for a transaction a chain to the trusted root signed, naming the transaction it was claimed by" testAppleVerdict + it "verifies a transaction under any of the trusted roots" testAppleAnyTrustedRoot it "fails, rather than refuses, an intermediate the trusted root did not sign, since the root may be misconfigured" testAppleRootNotTrusted it "refuses a leaf the intermediate did not sign, though the intermediate is genuine" testAppleForgedLeaf it "fails, rather than refuses, a leaf signature the library cannot check" testAppleLeafUncheckable @@ -55,7 +58,7 @@ badgeStoreVerifierTests = describe "badge store verifiers" $ do it "fails, rather than refuses, a payload Apple signed in a shape it does not know" testAppleUnknownShape it "fails, rather than refuses, a leaf holding a key it cannot read" testAppleLeafKey it "records the price in the currency's minor units, or not at all" testApplePrice - it "reads the trusted root from a DER file, and reports one it cannot read" testReadAppleRoot + it "reads the trusted root from a DER file, and reports one it cannot read or that is not a root" testReadAppleRoot it "has nothing to acknowledge" testAppleNoAcknowledgement describe "Google Play purchases" $ do it "vouches for a purchased token, asking Play about that token in this app" testPlayPurchased @@ -108,7 +111,10 @@ ourBundleId :: Text ourBundleId = "chat.simplex.app" appleVerdict :: SignedCertificate -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) -appleVerdict root jws = seamVerdict noStoreVerifier {verifyApple = Just (verifyAppleTransaction root ourBundleId)} SPApple {jws} +appleVerdict root = appleVerdictUnder (root :| []) + +appleVerdictUnder :: NonEmpty SignedCertificate -> Text -> IO (Either StoreRefusal VerifiedStoreTransaction) +appleVerdictUnder roots jws = seamVerdict noStoreVerifier {verifyApple = Just (verifyAppleTransaction roots ourBundleId)} SPApple {jws} data TestChain = TestChain { rootCert :: SignedCertificate, @@ -223,6 +229,14 @@ testAppleVerdict = do `shouldReturn` Right VerifiedStoreTransaction {transactionRef = "2000000900000001", productId = "BADGE_SUPPORTER_01", quantity = 1, testPurchase = False, paid = Just (CurrencyAmount 700, "USD"), alreadyAcknowledged = False} appleTransactionId jws `shouldBe` Just "2000000900000001" +testAppleAnyTrustedRoot :: IO () +testAppleAnyTrustedRoot = do + old <- trustedChain + new <- newChain otherRootName [intermediateMarker] [receiptLeafMarker] + forM_ [old, new] $ \chain -> do + jws <- signedBy chain $ transactionPayload [] [] + fmap transactionRef <$> appleVerdictUnder (rootCert old :| [rootCert new]) jws `shouldReturn` Right "2000000900000001" + testAppleRootNotTrusted :: IO () testAppleRootNotTrusted = do trusted <- trustedChain @@ -345,7 +359,8 @@ testApplePrice = do testReadAppleRoot :: IO () testReadAppleRoot = do - TestChain {rootCert} <- trustedChain + TestChain {rootCert, intermediateCert} <- trustedChain + readAppleRoot ("apps" "simplex-badge-service" "test-fixtures" "apple" "AppleRootCA-G3.cer") >>= (`shouldSatisfy` isRight) createDirectoryIfMissing True "tests/tmp" withTempDirectory "tests/tmp" "apple-root" $ \d -> do B.writeFile (d "root.cer") (encodeSignedObject rootCert) @@ -353,6 +368,8 @@ testReadAppleRoot = do B.writeFile (d "root.pem") "-----BEGIN CERTIFICATE-----\n" readAppleRoot (d "root.pem") >>= (`shouldSatisfy` either ("not a DER certificate" `isInfixOf`) (const False)) readAppleRoot (d "absent.cer") >>= (`shouldSatisfy` either ("could not be read" `isInfixOf`) (const False)) + B.writeFile (d "intermediate.cer") (encodeSignedObject intermediateCert) + readAppleRoot (d "intermediate.cer") >>= (`shouldSatisfy` either ("not a self-signed root certificate" `isInfixOf`) (const False)) testAppleNoAcknowledgement :: IO () testAppleNoAcknowledgement = do @@ -360,7 +377,7 @@ testAppleNoAcknowledgement = do jws <- signedBy chain $ transactionPayload [] [] withFakePlay $ \fake -> do verifier <- playVerifier fake - acknowledgement verifier {verifyApple = Just (verifyAppleTransaction (rootCert chain) ourBundleId)} SPApple {jws} `shouldReturn` Nothing + acknowledgement verifier {verifyApple = Just (verifyAppleTransaction (rootCert chain :| []) ourBundleId)} SPApple {jws} `shouldReturn` Nothing -- * Google Play From 7c3e516998571eb88083e528bd9325d172a29115 Mon Sep 17 00:00:00 2001 From: sh <37271604+shumvgolove@users.noreply.github.com> Date: Wed, 14 Oct 2026 15:13:22 +0400 Subject: [PATCH 16/26] badge-service: mount config folder, ignore .env (#7715) --- .gitignore | 6 ------ scripts/badge-service/.gitignore | 4 ++++ scripts/badge-service/badge_service.ini.example | 6 +++--- scripts/badge-service/compose.yml | 16 ++-------------- 4 files changed, 9 insertions(+), 23 deletions(-) create mode 100644 scripts/badge-service/.gitignore diff --git a/.gitignore b/.gitignore index 4ceea4d1a1..1bb18ef356 100644 --- a/.gitignore +++ b/.gitignore @@ -89,9 +89,3 @@ apps/android/app/release apps/multiplatform/.kotlin/sessions # anywhere in the tree: this file holds a real BTCPay api_key and webhook_secret badge_service.ini - -# Badge service Docker deployment: the Dockerfile, compose, and example config are tracked; the -# live config (a secret) and its data volume are not. -scripts/badge-service/badge_service.ini -scripts/badge-service/data/ -scripts/badge-service/web/ diff --git a/scripts/badge-service/.gitignore b/scripts/badge-service/.gitignore new file mode 100644 index 0000000000..78d3246083 --- /dev/null +++ b/scripts/badge-service/.gitignore @@ -0,0 +1,4 @@ +.env +config/ +data/ +web/ diff --git a/scripts/badge-service/badge_service.ini.example b/scripts/badge-service/badge_service.ini.example index e919294d70..f0dea005ac 100644 --- a/scripts/badge-service/badge_service.ini.example +++ b/scripts/badge-service/badge_service.ini.example @@ -37,8 +37,8 @@ waiting_seconds = 3 idle_seconds = 60 ; optional; without it every App Store receipt is answered provider_not_configured, which the app retries later. -; root_certificates lists, comma-separated, the roots trusted to sign receipts, each in DER and mounted -; in compose.yml. Today that is https://www.apple.com/certificateauthority/AppleRootCA-G3.cer. +; root_certificates lists, comma-separated, the roots trusted to sign receipts, each in DER and placed +; in config/. Today that is https://www.apple.com/certificateauthority/AppleRootCA-G3.cer. ; When Apple adds a root, list it beside the old one rather than in its place. ;[apple] ;bundle_id = chat.simplex.app @@ -48,7 +48,7 @@ idle_seconds = 60 ; service_account_file is the JSON key of a service account with the Play Console permissions "View ; financial data, orders, and cancellation survey responses" and "Manage orders and subscriptions", to ; read and acknowledge purchases. Without the second, a purchase the app has not already acknowledged -; itself is answered internal until the permission is granted. Uncomment its mount in compose.yml; the file must be readable by the service's user alone. +; itself is answered internal until the permission is granted. Place it in config/; the file must be readable by the service's user alone. ;[google] ;package_name = chat.simplex.app ;service_account_file = /etc/simplex-badge-service/play-service-account.json diff --git a/scripts/badge-service/compose.yml b/scripts/badge-service/compose.yml index 5047f2725f..6a81ac8200 100644 --- a/scripts/badge-service/compose.yml +++ b/scripts/badge-service/compose.yml @@ -20,22 +20,10 @@ services: - "/etc/simplex-badge-service/badge_service.ini" volumes: - type: bind - source: ./badge_service.ini - target: /etc/simplex-badge-service/badge_service.ini + source: ./config + target: /etc/simplex-badge-service read_only: true bind: create_host_path: false - # - type: bind - # source: ./AppleRootCA-G3.cer - # target: /etc/simplex-badge-service/AppleRootCA-G3.cer - # read_only: true - # bind: - # create_host_path: false - # - type: bind - # source: ./play-service-account.json - # target: /etc/simplex-badge-service/play-service-account.json - # read_only: true - # bind: - # create_host_path: false - ./web:/srv/webapp stop_grace_period: 10s From e8c98e82316cc9444fd24ebfa1bd388d9d8877f1 Mon Sep 17 00:00:00 2001 From: Evgeny Date: Thu, 15 Oct 2026 08:41:57 +0100 Subject: [PATCH 17/26] core, ios: fix notifications for forwarded and channel messages (#7706) * plan: add notification flag for forwarded messages * core, ui: fix notifications for forwarded and relay messages * improvements * only send duplicate message event in NSE * query plans --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> --- apps/ios/SimpleX NSE/NSEAPITypes.swift | 3 + .../ios/SimpleX NSE/NotificationService.swift | 20 +- apps/ios/SimpleXChat/ChatTypes.swift | 11 +- bots/src/API/Docs/Events.hs | 1 + .../2026-10-13-forwarded-notification-flag.md | 330 ++++++++++++++++++ simplex-chat.cabal | 2 + src/Simplex/Chat/Controller.hs | 1 + src/Simplex/Chat/Delivery.hs | 1 + src/Simplex/Chat/Library/Commands.hs | 2 +- src/Simplex/Chat/Library/Internal.hs | 43 ++- src/Simplex/Chat/Library/Subscriber.hs | 17 +- src/Simplex/Chat/Protocol.hs | 5 + src/Simplex/Chat/Store/Delivery.hs | 18 +- src/Simplex/Chat/Store/Postgres/Migrations.hs | 4 +- .../M20261012_delivery_job_notification.hs | 19 + src/Simplex/Chat/Store/SQLite/Migrations.hs | 4 +- .../M20261012_delivery_job_notification.hs | 18 + .../SQLite/Migrations/agent_query_plans.txt | 13 +- .../SQLite/Migrations/chat_query_plans.txt | 10 +- .../Store/SQLite/Migrations/chat_schema.sql | 3 +- src/Simplex/Chat/View.hs | 1 + tests/ChatTests/Groups.hs | 208 ++++++++++- 22 files changed, 674 insertions(+), 60 deletions(-) create mode 100644 plans/2026-10-13-forwarded-notification-flag.md create mode 100644 src/Simplex/Chat/Store/Postgres/Migrations/M20261012_delivery_job_notification.hs create mode 100644 src/Simplex/Chat/Store/SQLite/Migrations/M20261012_delivery_job_notification.hs diff --git a/apps/ios/SimpleX NSE/NSEAPITypes.swift b/apps/ios/SimpleX NSE/NSEAPITypes.swift index 35a838fff9..28073ef342 100644 --- a/apps/ios/SimpleX NSE/NSEAPITypes.swift +++ b/apps/ios/SimpleX NSE/NSEAPITypes.swift @@ -89,6 +89,7 @@ enum NSEChatEvent: Decodable, ChatAPIResult { case contactConnected(user: UserRef, contact: Contact, userCustomProfile: Profile?) case receivedContactRequest(user: UserRef, contactRequest: UserContactRequest) case newChatItems(user: UserRef, chatItems: [AChatItem]) + case duplicateGroupMessage(user: UserRef, member: GroupMember) case rcvFileSndCancelled(user: UserRef, chatItem: AChatItem, rcvFileTransfer: RcvFileTransfer) case sndFileComplete(user: UserRef, chatItem: AChatItem, sndFileTransfer: SndFileTransfer) case sndFileRcvCancelled(user: UserRef, chatItem_: AChatItem?, sndFileTransfer: SndFileTransfer) @@ -101,6 +102,7 @@ enum NSEChatEvent: Decodable, ChatAPIResult { case .contactConnected: "contactConnected" case .receivedContactRequest: "receivedContactRequest" case .newChatItems: "newChatItems" + case .duplicateGroupMessage: "duplicateGroupMessage" case .rcvFileSndCancelled: "rcvFileSndCancelled" case .sndFileComplete: "sndFileComplete" case .sndFileRcvCancelled: "sndFileRcvCancelled" @@ -117,6 +119,7 @@ enum NSEChatEvent: Decodable, ChatAPIResult { case let .newChatItems(u, chatItems): let itemsString = chatItems.map { chatItem in String(describing: chatItem) }.joined(separator: "\n") return withUser(u, itemsString) + case let .duplicateGroupMessage(u, member): return withUser(u, String(describing: member)) case let .rcvFileSndCancelled(u, chatItem, _): return withUser(u, String(describing: chatItem)) case let .sndFileComplete(u, chatItem, _): return withUser(u, String(describing: chatItem)) case let .sndFileRcvCancelled(u, chatItem, _): return withUser(u, String(describing: chatItem)) diff --git a/apps/ios/SimpleX NSE/NotificationService.swift b/apps/ios/SimpleX NSE/NotificationService.swift index 25df063f82..38e1b604be 100644 --- a/apps/ios/SimpleX NSE/NotificationService.swift +++ b/apps/ios/SimpleX NSE/NotificationService.swift @@ -73,6 +73,16 @@ public enum NSENotificationData { default: nil } } + + func replaces(_ bestAttempt: NSENotificationData) -> Bool { + switch (self, bestAttempt) { + case (.noNtf, .connectionEvent): true + case (.noNtf, _): false + case (.callInvitation, _): true + case (_, .callInvitation): false + default: true + } + } } // Once the last thread in the process completes processing chat controller is suspended, and the database is closed, to avoid @@ -573,9 +583,9 @@ class NotificationService: UNNotificationServiceExtension { // A better logic could be to check whether we have a call in the best attempt while processing .msgInfo marker above. // If the best attempt is a call, and its marker is received, and the call is recent (e.g., the last 30 seconds), it would deliver at once, // instead of requesting further messages. - if ntfEntity.msgBestAttemptNtf.callInvitation == nil || ntf.callInvitation != nil { + if let bestAttempt = notificationEntities[id]?.msgBestAttemptNtf, ntf.replaces(bestAttempt) { notificationEntities[id]?.msgBestAttemptNtf = ntf - } // otherwise keep call as best attempt + } return false } else { // We should not get to this branch, as notifications are not delivered for muted users. @@ -1022,8 +1032,8 @@ func receivedMsgNtf(_ res: NSEChatEvent) async -> (String, NSENotificationData)? cItem = autoReceiveFile(file) ?? cItem } let ntf: NSENotificationData = (cInfo.ntfsEnabled(chatItem: cItem) && cItem.showNotification) ? .messageReceived(user, cInfo, cItem) : .noNtf - let chatIdOrMemberId = if case let .groupRcv(groupMember) = chatItem.chatItem.chatDir { - groupMember.id + let chatIdOrMemberId = if case let .group(groupInfo, _) = cInfo, let memberId = cItem.meta.forwardedByMember ?? cItem.chatDir.groupMemberId { + groupMemberEntityId(groupInfo.groupId, memberId) } else { chatItem.chatInfo.id } @@ -1031,6 +1041,8 @@ func receivedMsgNtf(_ res: NSEChatEvent) async -> (String, NSENotificationData)? } else { return nil } + case let .duplicateGroupMessage(_, member): + return (member.id, .noNtf) case let .rcvFileSndCancelled(_, aChatItem, _): cleanupFile(aChatItem) return nil diff --git a/apps/ios/SimpleXChat/ChatTypes.swift b/apps/ios/SimpleXChat/ChatTypes.swift index a8c5de3672..186d7dab64 100644 --- a/apps/ios/SimpleXChat/ChatTypes.swift +++ b/apps/ios/SimpleXChat/ChatTypes.swift @@ -3255,7 +3255,7 @@ public struct GroupMember: Identifiable, Decodable, Hashable { public var relayLink: String? public var memberVerifiedCode: SecurityCode? - public var id: String { "#\(groupId) @\(groupMemberId)" } + public var id: String { groupMemberEntityId(groupId, groupMemberId) } public var ready: Bool { get { activeConn?.connStatus == .ready } } public var sndReady: Bool { get { ready || activeConn?.connStatus == .sndReady } } public var sendMsgEnabled: Bool { get { @@ -3444,6 +3444,10 @@ public struct GroupMember: Identifiable, Decodable, Hashable { ) } +public func groupMemberEntityId(_ groupId: Int64, _ groupMemberId: Int64) -> String { + "#\(groupId) @\(groupMemberId)" +} + public struct GroupSupportChat: Codable, Hashable { public var chatTs: Date public var unread: Int @@ -4217,6 +4221,10 @@ public enum CIDirection: Decodable, Hashable { } } + public var groupMemberId: Int64? { + if case let .groupRcv(groupMember) = self { groupMember.groupMemberId } else { nil } + } + public func sameDirection(_ dir: CIDirection) -> Bool { switch (self, dir) { case let (.groupRcv(m1), .groupRcv(m2)): m1.groupMemberId == m2.groupMemberId @@ -4242,6 +4250,7 @@ public struct CIMeta: Decodable, Hashable { public var userMention: Bool public var deletable: Bool public var editable: Bool + public var forwardedByMember: Int64? public var showGroupAsSender: Bool public var msgVerified: MsgVerified? diff --git a/bots/src/API/Docs/Events.hs b/bots/src/API/Docs/Events.hs index 48f307f6e4..e310fd54ef 100644 --- a/bots/src/API/Docs/Events.hs +++ b/bots/src/API/Docs/Events.hs @@ -203,6 +203,7 @@ undocumentedEvents = "CEvtContactRequestRejected", "CEvtContactSwitch", "CEvtCustomChatEvent", + "CEvtDuplicateGroupMessage", "CEvtGroupMemberRatchetSync", "CEvtGroupMemberSwitch", "CEvtServiceSubStatus", diff --git a/plans/2026-10-13-forwarded-notification-flag.md b/plans/2026-10-13-forwarded-notification-flag.md new file mode 100644 index 0000000000..a1962a6e0f --- /dev/null +++ b/plans/2026-10-13-forwarded-notification-flag.md @@ -0,0 +1,330 @@ +# Notification flag of forwarded messages + +Date: 2026-10-13. + +A message forwarded by a chat relay or by a forwarding group host is sent with the SMP notification flag when its original event has the flag by the rule of `hasNotification`. + +References are to `/code/simplex-chat-4`, branch `master`, commit `2f4a443dd`. Haskell paths without a directory are in `src/Simplex/Chat/`. `SMQ/` is `dist-newstyle/src/simplexmq-f058c38b0eecb6c0/src/Simplex/Messaging/`. `NSE` is `apps/ios/SimpleX NSE/NotificationService.swift`. + +## 1. Present behaviour +Path of a forwarded message: +``` +received Library/Subscriber.hs:1014 MSG of a member connection; the flag of the received SMP message is ignored + Library/Subscriber.hs:1069-1144 processEvent: a NewMessageDeliveryTask is returned for each event to forward +task Library/Subscriber.hs:1022 created when the user is the relay of a channel, or an admin or owner of a group (:3800), and the author is not blocked by an admin + Library/Subscriber.hs:1158-1176 createDeliveryTasks; createMsgDeliveryTask (Store/Delivery.hs:78) is called at :1165 and :1172 only + Store/Delivery.hs:137-170 the task is read with its message: msg_body is decoded to verifiedMsg, the original event +job Library/Subscriber.hs:4233-4240 DJDeliveryJob: accepted tasks of one scope (Store/Delivery.hs:178) are batched into one job (Messages/Batch.hs:84) + Library/Subscriber.hs:4246-4251 DJRelayRemoved: one job for one task + Library/Commands.hs:3256-3265 leaveChannelRelay: one job with the x.grp.leave of the relay + Store/Delivery.hs:285-328 the job is read as scope, sender ids, body and cursor; its events are stored only as the encoded body +sent Library/Subscriber.hs:4379-4423 channel: for each recipient, overflow profile batches, then the body; MsgFlags False (:4416) + Library/Subscriber.hs:4424-4487 channel support scope and regular group: deliver; MsgFlags False (:4483) +``` +Types (`Delivery.hs`): +``` +DeliveryTaskContext :48 + jobScope :: DeliveryJobScope + sentAsGroup :: ShowGroupAsSender +DeliveryJobScope :54 + DJSGroup {jobSpec :: DeliveryJobSpec} + DJSMemberSupport {supportGMId :: GroupMemberId} +DeliveryJobSpec :60 + DJDeliveryJob {includePending :: Bool} + DJRelayRemoved +NewMessageDeliveryTask :122 + messageId :: MessageId + taskContext :: DeliveryTaskContext +MessageDeliveryTask :128 + taskId :: Int64 + jobScope :: DeliveryJobScope + senderGMId :: GroupMemberId + fwdSender :: FwdSender + brokerTs :: UTCTime + verifiedMsg :: VerifiedMsg 'Json +MessageDeliveryJob :161 + jobId :: Int64 + jobScope :: DeliveryJobScope + senderGMIds :: [GroupMemberId] + body :: ByteString + cursorGMId_ :: Maybe GroupMemberId +``` +Tables (`Store/SQLite/Migrations/M20250813_delivery_tasks.hs:54, :103`, `M20260529_delivery_job_senders.hs:17`; the same columns in Postgres): +``` +both tables + group_id + worker_scope + job_scope_spec_tag + job_scope_include_pending + job_scope_support_gm_id + failed + created_at + updated_at +delivery_tasks + delivery_task_id + sender_group_member_id + message_id -- messages.chat_msg_event: the tag; messages.msg_body: the original event + message_from_channel + task_status + task_err_reason +delivery_jobs + delivery_job_id + sender_group_member_ids + body + cursor_group_member_id + job_status + job_err_reason +``` +The flag, from the forwarder to the notification: +``` +forwarder agent SMQ/Agent.hs:2186-2203, 2563 one flag for each MsgReq, stored with the sent message; a body shared by VRRef is sent with the flag of each request + SMQ/Agent.hs:2637-2644 the flag is a parameter of SEND +SMP server SMQ/Server.hs:2038-2039 a notification is stored for a flagged message to a queue with notifier credentials (:2131-2136), and for such a message only + SMQ/Server.hs:361-414 the stored notification is sent as NMSG to the subscriber of the notifier, the notification server +notification server SMQ/Notifications/Server.hs:545-553 NMSG: a push notification with the last notifications of the device token is sent to the push provider (:693-702) +recipient Library/Subscriber.hs:890 the notification subscription of a member connection is created unless the chat is muted, MFNone (Library/Commands.hs:1922-1929; SMQ/Agent.hs:3345-3361) + SMQ/Agent.hs:2093-2144, 3741 the agent gets the message of the notified queue and passes MSG with the flag; forwarded content is opaque to the agent + Library/Subscriber.hs:1014 the core ignores the flag; the item is created from the forwarded event (:4008-4064) +``` +iOS notification extension, for a forwarded message: +``` +entity key NSE:489-498 id of the notified connection: "# @" of the relay or the host (apps/ios/SimpleXChat/ChatTypes.swift:3624-3632, :3258) +item key NSE:1025-1029 the member of the item, its author, for groupRcv; "#" for channelRcv +forwarded item NSE:173-187 the keys are different: the notification of the item is added to droppedNotifications, outside the entity of the notified connection +shown NSE:1196-1216 the default of the connection: MFAll: title "# :", text "message received" (apps/ios/SimpleXChat/Notifications.swift:102); MFMentions: empty content +``` +- With the flag alone the push notification is sent, and the message is received by the core of the NSE: the item is created. The shown notification is the default one. The NSE change of section 7 is required for a notification with the message text. + +Regular groups, the same message sent to a member by its author and by the host: +``` +author Library/Internal.hs:2847-2865 member with a ready connection: sent to the member; otherwise forwarded by the host (MSAForwarded) or stored as pending +host Library/Subscriber.hs:4447-4458 job recipients: members whose relation with the sender is MRIntroduced +both sent while the author is connected to the member and the relation at the host is MRIntroduced + the second copy is a duplicate: one item; the recipient sends x.grp.mem.con (Library/Internal.hs:2939-2945, 2958-2968), the host stops forwarding (Library/Subscriber.hs:3724-3729) +rule each copy of x.msg.new is flagged: two notifications for one item in that interval, one otherwise +``` + +## 2. Rule +``` +forwarded message flag = hasNotification of the tag of its original event (Protocol.hs:1338) + the flag of the received SMP message is unused +SMP message notification = True when the flag of any forwarded message of its body is True, as for sent events (Library/Internal.hs:2248, 2748) +job one value for the body, computed when the job is created; the same for every recipient, scope and cursor page +channel pieces body (id 0) and extBody, profiles with the body (id 1): the job value + overflow profile batches (id 2 and above): False; their elements are x.grp.mem.new of the relay (Library/Subscriber.hs:4277) +``` +Events (handlers at `Library/Subscriber.hs:1080-1132`; forwarded events are those of `isForwardedGroupMsg`, `Protocol.hs:528`): +``` +event flag +x.msg.new True every content message, with or without a file +x.grp.del True forwarded by the relay-removed job (:1118) +x.msg.file.descr False +x.msg.update False +x.msg.del False +x.msg.react False +x.file.cancel False +x.info False +x.grp.relay.new False +x.grp.mem.new False +x.grp.mem.role False +x.grp.mem.restrict False +x.grp.mem.del False also the relay-removed job of a removed relay or host (:3746) +x.grp.leave False also the job of a relay that leaves (Library/Commands.hs:3263) +x.grp.info False +x.grp.prefs False +x.grp.roster False +x.file True handled without a delivery task (:1096) +x.grp.mem.fwd True handled without a delivery task (:1110) +x.grp.inv True handled without a delivery task (:1124) +x.call.inv True handled without a delivery task (:1132) +x.contact True handled without a delivery task (:1132) +``` + +## 3. Core changes +``` +Protocol.hs + msgHasNotification new, next to hasNotification (:1338): VerifiedMsg e -> Bool + hasNotification of the tag of the event of the message (verifiedChatMsg, :1583) +Delivery.hs + MessageDeliveryJob (:161) notification :: Bool -- new, after body +Store/Delivery.hs + createMsgDeliveryJob (:251) new parameter notification :: Bool, before body; written to delivery_jobs.notification + MessageDeliveryJobRow (:283) BoolInt added after the body + getNextDeliveryJob (:309-328) notification selected after body; set in MessageDeliveryJob +Library/Subscriber.hs + processDeliveryTask (:4235) notification: True when msgHasNotification of verifiedMsg is True for any of acceptedTasks; computed next to senderGMIds, passed at :4237 + (:4250) msgHasNotification verifiedMsg of the task is passed + processDeliveryJob (:4331) notification is bound from the job + recipientBodyPieces (:4417) each piece is returned with its flag: overflow batch False; extBody and body: notification + addPiece (:4410-4416) MsgFlags {notification = the flag of the piece} + deliver (:4483) MsgFlags {notification} +Library/Commands.hs + leaveChannelRelay (:3263) hasNotification XGrpLeave_ is passed +Library/Internal.hs + sendFwdMemberMessage (:2903) MsgFlags {notification = msgHasNotification verifiedMsg} + False for both callers: x.grp.roster (:1307), x.grp.mem.del (Library/Subscriber.hs:3798) +``` +Sites with a fixed flag, unchanged: +``` +Library/Internal.hs:1428 sendHistory: history for a new member, with the welcome message of a group; MsgFlags False (open question 1) +Library/Internal.hs:2459 sendGroupMemberMessages: events of the user to one member; notification = True +Library/Internal.hs:2910 sendPendingGroupMessages: pending messages of the user to one member; notification = True +tests/ChatTests/Groups.hs:5681, 10907, 13320, 13452, 13608, 13701 elements sent by tests through the agent; MsgFlags False +``` +- Every other `MsgFlags` value of the repository is built for events of the user, from `hasNotification` of their tags: `Library/Internal.hs:2248, 2552, 2748`; `Library/Commands.hs:2672, 4131`; `Library/Subscriber.hs:356`. +- Forwarded content is sent as `>` elements only (`encodeFwdElement`, `Messages/Batch.hs:125`; used at `:98`, `Library/Subscriber.hs:4248`, `Library/Internal.hs:1423, 2902`). `XGrpMsgForward` events are only received (`Library/Subscriber.hs:1127`). + +## 4. Storage +Migration `M20261012_delivery_job_notification`, SQLite and Postgres, registered in `Store/SQLite/Migrations.hs` (`:180`, `:358`), `Store/Postgres/Migrations.hs` (`:57`, `:112`) and `simplex-chat.cabal` (`:172`, `:351`). It is one `ADD COLUMN`; indexes are unchanged. +``` +delivery_jobs + notification INTEGER NOT NULL DEFAULT 0 -- SMALLINT in Postgres +``` +- Down migration: the column is dropped. `delivery_tasks` is unchanged: the event of a task is read with its message. +- Applied migrations must be a prefix of the list sorted by name (`SMQ/Agent/Store/Migrations.hs:23-34`; `Store/SQLite/Migrations.hs:363`). The name is ordered after `20261010_invite_member_via_group` and before the unreleased `20261013_chat_layout` and `20261013_msg_priority` of branch `ep/llm-ux` (open question 3). +- The schema dumps and `chat_query_plans.txt` are regenerated by the tests "verify and overwrite schema dump" (`tests/SchemaDump.hs:58`, `tests/PostgresSchemaDump.hs:29`) and "verify and overwrite query plans" (`tests/SchemaDump.hs:165`); they are never edited by hand. + +## 5. Compatibility and cost +``` +chat protocol unchanged; the flag is a parameter of SMP SEND (SMQ/Protocol.hs:598) +recipient every version; the flag is used by the SMP server only +earlier relay or host sends without the flag, as now; a channel member is notified by each relay of this release +job of an earlier release notification = 0: sent without the flag +downgrade the column is dropped +traffic count and size of SMP messages unchanged +notifications one for each flagged SMP message to a queue with notifier credentials: a device with a notification token and the chat set to MFAll or MFMentions + one job is one flagged SMP message for a recipient, for all its events +channel a post is sent by each relay to each member (Library/Internal.hs:2843-2845; Store/Delivery.hs:352) + with N members and R relays up to N × R notifications are sent for a post; one item is created (Library/Internal.hs:2958-2959) + shown on iOS: one notification for a post; a duplicate copy is shown with empty content (section 7) +profile overflow batches unflagged +``` + +## 6. Tests +`tests/ChatTests/Groups.hs`, helpers next to `relayConnIdToMember` (`:13140`): +``` +agentSendBody cc connId body body sent to the connection by the agent of cc, MsgFlags False; a failure is a test failure +lastSndMsgFlags cc connId n msg_flags, "T" or "F", of the last n sent rows of type A_MSG ("M") of agent table messages for the connection, in sending order; withCCAgentTransaction (tests/ChatTests/Utils.hs:675) +lastJobNotification cc notification of the last row of delivery_jobs; withCCTransaction +``` +- The agent row of a sent message is kept after delivery until its receipt (`SMQ/Agent/Store/AgentStore.hs:1318-1349`; `SMQ/Agent.hs:2866-2869`): recipients run `/set receipts all off` before the checked messages (as `:1561`). + +New tests: +``` +group message forwarding (:191) + testGroupMsgForwardNotification createGroup3, setupGroupForwarding (:5802); bob sends a message: alice to cath "T", job True; bob edits it: "F", job False +relay delivery, single relay (:283) + testChannels1RelayDeliverNotification createChannel1Relay (:9523); alice posts: bob to cath, dan and eve "T", job True; cath adds a reaction: bob to dan and eve "F", job False +deliver member profiles via relay (:295) + testChannelOverflowProfileNotification the scenario of testChannelLargeProfileFits (:9956) with an image of 10000 characters and a message of 7000 characters, so that the profile is sent in an overflow batch: bob to dan, the rows added by the message: "F" for the overflow profile batch, "T" for the message +``` +- One sender and one message give one job. +Assertions added to present tests, on `delivery_jobs` only (the connections and their agent rows are deleted after the job, `Library/Subscriber.hs:4328`): +``` +testGroupMsgForwardGroupDeletion (:6135) alice: job True, x.grp.del +testChannelDeleteGroupSigned (:11031) bob: job True, x.grp.del +testGroupMsgForwardAdminRemoval (:6096) alice: job False, x.grp.mem.del +testChannelRelayLeave (:11220) bob: job False, x.grp.leave +``` +Present tests of delivery jobs, unchanged: "group message forwarding" (`:191-206`), "group scoped messages" (`:255-264`), "relay delivery" (`:282-292`), "deliver member profiles via relay" (`:295-301`), `testRelayBatchAllLarge` and `testRelayBatchSingletonOverflow` (`tests/MessageBatching.hs:164, 186`). + +## 7. iOS notification of a forwarded message and of a duplicate copy +Event, `Controller.hs:1048`, next to `CEvtUnknownMemberAnnounced`: +``` +CEvtDuplicateGroupMessage JSON type duplicateGroupMessage + user :: User + member :: GroupMember -- the member whose connection delivered the copy +``` +Emission, `Library/Internal.hs`, before the present handling of the duplicate, only when the chat is started with `main=off` (the NSE and the share extension): +``` +isMainApp :2976 subscriptionMode is SMSubscribe; startChatController sets SMOnlyCreate for main=off (Library/Commands.hs:235) +saveGroupRcvMsg :2925 direct copy; member: the member of the connection; every SEDuplicateGroupMessage + x.grp.mem.con to the forwarding member when the stored copy was forwarded, as now (:2940-2944) +saveGroupFwdRcvMsg :2959 channel; member: the forwarding relay; Nothing is returned, as now + :2960-2969 group; member: the forwarding host; x.grp.mem.con and the error, as now +``` +Consumers: +``` +terminal view View.hs:471: no output, as CEvtNtfMessage (:547) +API docs bots/src/API/Docs/Events.hs:205: in undocumentedEvents, as CEvtUnknownMemberCreated +apps, CLI, bots not emitted: started with main=on +NSE decoded: case duplicateGroupMessage (SimpleX NSE/NSEAPITypes.swift:91) +``` +Swift types, `apps/ios/SimpleXChat/ChatTypes.swift`: +``` +CIMeta.forwardedByMember :4253 Int64?, after editable, as in core CIMeta (Messages.hs:525); omitted in JSON for Nothing +groupMemberEntityId :3447 (groupId, groupMemberId) -> "# @"; used by GroupMember.id (:3258) and the NSE +CIDirection.groupMemberId :4224 groupMemberId of the member of groupRcv; nil for other directions +``` + +NSE, `apps/ios/SimpleX NSE/NotificationService.swift`: +``` +receivedMsgNtf (:1035-1039) + newChatItems key of a group item: groupMemberEntityId of the group and of the member whose connection delivered the item: + forwardedByMember, otherwise chatDir.groupMemberId; the id of the connection entity (ChatTypes.swift:3624-3632) + other items, and channelRcv without forwardedByMember: chatInfo.id, as now + duplicateGroupMessage key: member.id; notification: .noNtf +processReceivedNtf (:586-588): the best attempt of the entity is read from notificationEntities[id] and replaced when ntf.replaces(bestAttempt) +NSENotificationData.replaces (:77-85), new notification, best attempt: + .noNtf, .connectionEvent true: the default of the connection + .noNtf, other false + .callInvitation, any true + other, .callInvitation false + other, other true +``` +- `.noNtf` is used: `.connectionEvent` is created only as the default (`defaultBestAttemptNtf`, `:1208-1229`). A received item, a contact event and a call are never replaced by `.noNtf`. +- The best attempt is read from `notificationEntities[id]`: `processDroppedNotifications` (`:514-529`) passes the entity copied before its notifications are processed. + +Results: +``` +forwarded post, MFAll the text of the post (createMessageReceivedNtf, apps/ios/SimpleXChat/Notifications.swift:66) +forwarded post, MFMentions the text for a mention or a reply; empty content otherwise +duplicate copy empty content, unless an item of the same push notification is shown +mention, then other item the mention is shown; before this patch, .noNtf of the other item replaced it +``` +Tests, `tests/ChatTests/Groups.hs`; helpers next to `lastJobNotification`: +``` +duplicateMessageEventsCfg testCfg with an eventHook (Controller.hs:257) that records the member names of CEvtDuplicateGroupMessage +setMainAppOff cc subscriptionMode of cc set to SMOnlyCreate, as by /_start main=off; called after the group is created +``` +Copies are sent through the agent of the sender by `agentSendBody`, as in `testGroupMsgForwardOwnMembershipRejected` (`:5666`), so that the order of copies is fixed: +``` +group message forwarding (:191) + testGroupMsgForwardDuplicateEvent createGroup3; bob's message is received by cath directly; alice's agent sends a forwarded copy + (Library/Internal.hs:2960-2969): cath "duplicate group message, group id: 1"; no event + setMainAppOff cath; alice's agent sends the copy again: the same line; event member alice + testGroupMsgDirectDuplicateEvent alice's agent sends a forwarded copy; setMainAppOff cath; bob's agent sends the direct copy + (Library/Internal.hs:2939-2946): cath "duplicate group message, group id: 1"; event member bob +relay delivery, single relay (:283) + testChannelDuplicateEvent createChannel1Relay; alice posts; setMainAppOff cath; bob's agent sends a second forwarded copy + (Library/Internal.hs:2959): event member bob; cath without output +``` +- The NSE and the Swift types are not compiled on this machine. Manual checks on iOS: a post in a channel with 2 relays, with MFAll and with MFMentions; a forwarded message in a group; a mention followed by an ordinary message in one push notification. + +## Interfaces +``` +core functions msgHasNotification :: VerifiedMsg e -> Bool + createMsgDeliveryJob, new parameter notification + isMainApp :: CM Bool +core types MessageDeliveryJob.notification +core events CEvtDuplicateGroupMessage, JSON type duplicateGroupMessage +storage delivery_jobs.notification + migration M20261012_delivery_job_notification +iOS CIMeta.forwardedByMember + groupMemberEntityId + CIDirection.groupMemberId + NSEChatEvent.duplicateGroupMessage + NSENotificationData.replaces +test helpers agentSendBody + lastSndMsgFlags + lastJobNotification + duplicateMessageEventsCfg + setMainAppOff +``` +- `eventHasNotification :: ChatMsgEvent e -> Bool` of `2026-10-13-message-priority.md` is accepted by one change: `msgHasNotification` is computed as `eventHasNotification` of the event of the message. Its three uses, the job column and `hasNotification XGrpLeave_` in `leaveChannelRelay` are unchanged. +- With that change a forwarded `x.msg.update` that raises priority is flagged. The line of the priority plan, section 4, "delivery jobs of relays and forwarding hosts, MsgFlags False for every message" is replaced by this plan. + +## Open questions +1. History and the welcome message (`sendHistory`), flagged until commit `93831a0f2` (2026-07-17) and unflagged since: apply the rule? Recommended: unchanged, sent without the flag. +2. The job flag as a column, or computed by the job worker from the decoded body, without a migration? Recommended: the column, computed where the events of the tasks are read. +3. Release order with `ep/llm-ux`. Recommended: this correction first, with date `20261012` in the migration name; otherwise a date after the last released migration. diff --git a/simplex-chat.cabal b/simplex-chat.cabal index c9a29b3ac8..205939a9a2 100644 --- a/simplex-chat.cabal +++ b/simplex-chat.cabal @@ -170,6 +170,7 @@ library Simplex.Chat.Store.Postgres.Migrations.M20260923_preferences_json Simplex.Chat.Store.Postgres.Migrations.M20260925_badge_bindings Simplex.Chat.Store.Postgres.Migrations.M20261010_invite_member_via_group + Simplex.Chat.Store.Postgres.Migrations.M20261012_delivery_job_notification else exposed-modules: Simplex.Chat.Archive @@ -349,6 +350,7 @@ library Simplex.Chat.Store.SQLite.Migrations.M20260923_preferences_json Simplex.Chat.Store.SQLite.Migrations.M20260925_badge_bindings Simplex.Chat.Store.SQLite.Migrations.M20261010_invite_member_via_group + Simplex.Chat.Store.SQLite.Migrations.M20261012_delivery_job_notification other-modules: Paths_simplex_chat hs-source-dirs: diff --git a/src/Simplex/Chat/Controller.hs b/src/Simplex/Chat/Controller.hs index 2d553bdc9b..65c70e75fe 100644 --- a/src/Simplex/Chat/Controller.hs +++ b/src/Simplex/Chat/Controller.hs @@ -1046,6 +1046,7 @@ data ChatEvent | CEvtUnknownMemberCreated {user :: User, groupInfo :: GroupInfo, forwardedByMember :: GroupMember, member :: GroupMember} | CEvtUnknownMemberBlocked {user :: User, groupInfo :: GroupInfo, blockedByMember :: GroupMember, member :: GroupMember} | CEvtUnknownMemberAnnounced {user :: User, groupInfo :: GroupInfo, announcingMember :: GroupMember, unknownMember :: GroupMember, announcedMember :: GroupMember} + | CEvtDuplicateGroupMessage {user :: User, member :: GroupMember} | CEvtGroupDeleted {user :: User, groupInfo :: GroupInfo, member :: GroupMember, msgSigned :: Maybe MsgSigStatus} | CEvtGroupUpdated {user :: User, fromGroup :: GroupInfo, toGroup :: GroupInfo, member_ :: Maybe GroupMember, msgSigned :: Maybe MsgSigStatus} -- there is the same command response | CEvtAcceptingGroupJoinRequestMember {user :: User, groupInfo :: GroupInfo, member :: GroupMember} diff --git a/src/Simplex/Chat/Delivery.hs b/src/Simplex/Chat/Delivery.hs index a6ccc74247..a83c624274 100644 --- a/src/Simplex/Chat/Delivery.hs +++ b/src/Simplex/Chat/Delivery.hs @@ -163,6 +163,7 @@ data MessageDeliveryJob = MessageDeliveryJob jobScope :: DeliveryJobScope, senderGMIds :: [GroupMemberId], body :: ByteString, + notification :: Bool, cursorGMId_ :: Maybe GroupMemberId } deriving (Show) diff --git a/src/Simplex/Chat/Library/Commands.hs b/src/Simplex/Chat/Library/Commands.hs index c37c45ec90..7a4e6d2d36 100644 --- a/src/Simplex/Chat/Library/Commands.hs +++ b/src/Simplex/Chat/Library/Commands.hs @@ -3260,7 +3260,7 @@ processChatCommand cxt nm = \case withFastStore' $ \db -> do deleteGroupDeliveryTasks db gInfo deleteGroupDeliveryJobs db gInfo - createMsgDeliveryJob db gInfo (DJSGroup {jobSpec = DJRelayRemoved}) [] body + createMsgDeliveryJob db gInfo (DJSGroup {jobSpec = DJRelayRemoved}) [] (hasNotification XGrpLeave_) body lift . void $ getDeliveryJobWorker True (groupId, DWSGroup) pure msg leaveGroupSendMsg user g@(GIK gInfo _) = do diff --git a/src/Simplex/Chat/Library/Internal.hs b/src/Simplex/Chat/Library/Internal.hs index 6ea428ac1f..418d454ada 100644 --- a/src/Simplex/Chat/Library/Internal.hs +++ b/src/Simplex/Chat/Library/Internal.hs @@ -2900,7 +2900,7 @@ sendFwdMemberMessage :: GroupMember -> GrpMsgForward -> VerifiedMsg 'Json -> CM sendFwdMemberMessage member fwd verifiedMsg = forM_ (readyMemberConn member) $ \(_, conn) -> do let body = encodeBinaryBatch [encodeFwdElement fwd verifiedMsg] - void $ withAgent $ \a -> sendMessages a [(aConnId conn, PQEncOff, MsgFlags False, VRValue Nothing body)] + void $ withAgent $ \a -> sendMessages a [(aConnId conn, PQEncOff, MsgFlags {notification = msgHasNotification verifiedMsg}, VRValue Nothing body)] -- TODO ensure order - pending messages interleave with user input messages sendPendingGroupMessages :: User -> GroupInfo -> GroupMember -> Connection -> CM () @@ -2937,11 +2937,13 @@ saveGroupRcvMsg user groupId authorMember conn@Connection {connId} agentMsgMeta msg <- withStore (\db -> createNewMessageAndRcvMsgDelivery db (GroupId groupId) newMsg sharedMsgId_ rcvMsgDelivery $ Just amGroupMemId) `catchAllErrors` \e -> case e of - ChatErrorStore (SEDuplicateGroupMessage _ _ _ (Just forwardedByGroupMemberId)) -> do - cxt <- chatStoreCxt - fm <- withStore $ \db -> getGroupMember db cxt user groupId forwardedByGroupMemberId - forM_ (memberConn fm) $ \fmConn -> - void $ sendDirectMemberMessage fmConn (XGrpMemCon amMemId) groupId + ChatErrorStore (SEDuplicateGroupMessage _ _ _ forwardedByGroupMemberId_) -> do + unlessM isMainApp $ toView $ CEvtDuplicateGroupMessage user am' + forM_ forwardedByGroupMemberId_ $ \forwardedByGroupMemberId -> do + cxt <- chatStoreCxt + fm <- withStore $ \db -> getGroupMember db cxt user groupId forwardedByGroupMemberId + forM_ (memberConn fm) $ \fmConn -> + void $ sendDirectMemberMessage fmConn (XGrpMemCon amMemId) groupId throwError e _ -> throwError e pure (am', conn', msg) @@ -2955,20 +2957,25 @@ saveGroupFwdRcvMsg user gInfo@GroupInfo {groupId} forwardingMember refAuthorMemb -- TODO [relays] TBC highlighting difference between deduplicated messages (useRelays branch) withStore' (\db -> runExceptT $ createNewRcvMessage db (GroupId groupId) newMsg sharedMsgId_ refAuthorId fwdMemberId) >>= \case Right msg -> pure $ Just msg - Left e@SEDuplicateGroupMessage {authorGroupMemberId, forwardedByGroupMemberId} - | useRelays' gInfo -> pure Nothing -- with chat relays, duplicates are expected - | otherwise -> case (authorGroupMemberId, forwardedByGroupMemberId) of - (Just authorGMId, Nothing) -> do - cxt <- chatStoreCxt - am@GroupMember {memberId = amMemberId} <- withStore $ \db -> getGroupMember db cxt user groupId authorGMId - if maybe False (\ref -> sameMemberId (memberId' ref) am) refAuthorMember_ - then forM_ (memberConn forwardingMember) $ \fmConn -> - void $ sendDirectMemberMessage fmConn (XGrpMemCon amMemberId) groupId - else toView $ CEvtMessageError user "error" "saveGroupFwdRcvMsg: referenced author member id doesn't match message member id" - throwError $ ChatErrorStore e - _ -> throwError $ ChatErrorStore e + Left e@SEDuplicateGroupMessage {authorGroupMemberId, forwardedByGroupMemberId} -> do + unlessM isMainApp $ toView $ CEvtDuplicateGroupMessage user forwardingMember + if + | useRelays' gInfo -> pure Nothing -- with chat relays, duplicates are expected + | otherwise -> case (authorGroupMemberId, forwardedByGroupMemberId) of + (Just authorGMId, Nothing) -> do + cxt <- chatStoreCxt + am@GroupMember {memberId = amMemberId} <- withStore $ \db -> getGroupMember db cxt user groupId authorGMId + if maybe False (\ref -> sameMemberId (memberId' ref) am) refAuthorMember_ + then forM_ (memberConn forwardingMember) $ \fmConn -> + void $ sendDirectMemberMessage fmConn (XGrpMemCon amMemberId) groupId + else toView $ CEvtMessageError user "error" "saveGroupFwdRcvMsg: referenced author member id doesn't match message member id" + throwError $ ChatErrorStore e + _ -> throwError $ ChatErrorStore e Left e -> throwError $ ChatErrorStore e +isMainApp :: CM Bool +isMainApp = (SMSubscribe ==) <$> chatReadVar subscriptionMode + saveSndChatItem :: ChatTypeI c => User -> ChatDirection c 'MDSnd -> SndMessage -> CIContent 'MDSnd -> CM (ChatItem c 'MDSnd) saveSndChatItem user cd msg content = saveSndChatItem' user cd msg content Nothing Nothing Nothing Nothing False diff --git a/src/Simplex/Chat/Library/Subscriber.hs b/src/Simplex/Chat/Library/Subscriber.hs index a1e748831c..9047ca1532 100644 --- a/src/Simplex/Chat/Library/Subscriber.hs +++ b/src/Simplex/Chat/Library/Subscriber.hs @@ -4233,8 +4233,9 @@ runDeliveryTaskWorker a deliveryKey Worker {doWork} = do withWorkItems a doWork (withStore' $ \db -> getNextDeliveryTasks db gInfo task) $ \nextTasks -> do let (body_, acceptedTasks, largeTasks) = batchDeliveryTasks1 (vr cxt) maxForwardBatchLength nextTasks senderGMIds = S.toList . S.fromList $ map (\MessageDeliveryTask {senderGMId} -> senderGMId) acceptedTasks + notification = any (\MessageDeliveryTask {verifiedMsg} -> msgHasNotification verifiedMsg) acceptedTasks withStore' $ \db -> do - forM_ body_ $ \body -> createMsgDeliveryJob db gInfo jobScope senderGMIds body + forM_ body_ $ \body -> createMsgDeliveryJob db gInfo jobScope senderGMIds notification body forM_ acceptedTasks $ \t -> updateDeliveryTaskStatus db (deliveryTaskId t) DTSProcessed forM_ largeTasks $ \t -> setDeliveryTaskErrStatus db (deliveryTaskId t) "large" when (isJust body_) . lift . void $ getDeliveryJobWorker True deliveryKey @@ -4247,7 +4248,7 @@ runDeliveryTaskWorker a deliveryKey Worker {doWork} = do fwd = GrpMsgForward {fwdSender, fwdBrokerTs} body = encodeBinaryBatch [encodeFwdElement fwd verifiedMsg] withStore' $ \db -> do - createMsgDeliveryJob db gInfo jobScope [senderGMId] body + createMsgDeliveryJob db gInfo jobScope [senderGMId] (msgHasNotification verifiedMsg) body updateDeliveryTaskStatus db (deliveryTaskId task) DTSProcessed lift . void $ getDeliveryJobWorker True deliveryKey @@ -4328,7 +4329,7 @@ runDeliveryJobWorker a deliveryKey Worker {doWork} = do deleteGroupConnections user gInfo True withStore' $ \db -> updateDeliveryJobStatus db jobId DJSComplete where - MessageDeliveryJob {jobId, jobScope, senderGMIds, body, cursorGMId_ = startingCursor} = job + MessageDeliveryJob {jobId, jobScope, senderGMIds, body, notification, cursorGMId_ = startingCursor} = job singleSenderGMId_ = case senderGMIds of [s] -> Just s _ -> Nothing @@ -4407,16 +4408,16 @@ runDeliveryJobWorker a deliveryKey Worker {doWork} = do addRecipient acc r = case readyMemberConn r of Just (_, conn) -> snd $ foldl' (addPiece conn) (0 :: Int, acc) (recipientBodyPieces r) Nothing -> acc - addPiece conn (k, (issued, reqs)) (bid, msgBody) = + addPiece conn (k, (issued, reqs)) (bid, ntf, msgBody) = let vor | IS.member bid issued = VRRef bid | otherwise = VRValue (Just bid) msgBody issued' = IS.insert bid issued connId = if k == 0 then aConnId conn else B.empty - in (k + 1, (issued', (connId, PQEncOff, MsgFlags False, vor) : reqs)) + in (k + 1, (issued', (connId, PQEncOff, MsgFlags {notification = ntf}, vor) : reqs)) recipientBodyPieces r = - [(i, b) | (i, (b, ss)) <- overflowWithIds, any missing ss] - <> [if any missing inBodySenders then (1, extBody) else (0, body)] + [(i, False, b) | (i, (b, ss)) <- overflowWithIds, any missing ss] + <> [if any missing inBodySenders then (1, notification, extBody) else (0, notification, body)] where missing s = case M.lookup (groupMemberId' s) senderVec of Just vec -> getRelation (indexInGroup r) vec == MRNew @@ -4480,7 +4481,7 @@ runDeliveryJobWorker a deliveryKey Worker {doWork} = do addReq conn (memIdx_, reqs) = (subtract 1 <$> memIdx_, req : reqs) where - req = (aConnId conn, PQEncOff, MsgFlags False, vrValue_) + req = (aConnId conn, PQEncOff, MsgFlags {notification}, vrValue_) vrValue_ = case memIdx_ of Nothing -> VRValue Nothing msgBody -- sending to one member, do not reference body Just 1 -> VRValue (Just 1) msgBody diff --git a/src/Simplex/Chat/Protocol.hs b/src/Simplex/Chat/Protocol.hs index 1266104e0e..a4fb12cc72 100644 --- a/src/Simplex/Chat/Protocol.hs +++ b/src/Simplex/Chat/Protocol.hs @@ -1346,6 +1346,11 @@ hasNotification = \case XCallInv_ -> True _ -> False +msgHasNotification :: VerifiedMsg e -> Bool +msgHasNotification verifiedMsg = hasNotification $ toCMEventTag chatMsgEvent + where + ChatMessage {chatMsgEvent} = verifiedChatMsg verifiedMsg + hasDeliveryReceipt :: CMEventTag e -> Bool hasDeliveryReceipt = \case XMsgNew_ -> True diff --git a/src/Simplex/Chat/Store/Delivery.hs b/src/Simplex/Chat/Store/Delivery.hs index c80264da7a..c8875baab2 100644 --- a/src/Simplex/Chat/Store/Delivery.hs +++ b/src/Simplex/Chat/Store/Delivery.hs @@ -248,8 +248,8 @@ deleteDoneDeliveryTasks db createdAtCutoff = do |] (createdAtCutoff, DTSProcessed, DTSError) -createMsgDeliveryJob :: DB.Connection -> GroupInfo -> DeliveryJobScope -> [GroupMemberId] -> ByteString -> IO () -createMsgDeliveryJob db gInfo jobScope senderGMIds body = do +createMsgDeliveryJob :: DB.Connection -> GroupInfo -> DeliveryJobScope -> [GroupMemberId] -> Bool -> ByteString -> IO () +createMsgDeliveryJob db gInfo jobScope senderGMIds notification body = do currentTs <- getCurrentTime DB.execute db @@ -257,10 +257,10 @@ createMsgDeliveryJob db gInfo jobScope senderGMIds body = do INSERT INTO delivery_jobs ( group_id, worker_scope, job_scope_spec_tag, job_scope_include_pending, job_scope_support_gm_id, - sender_group_member_ids, body, job_status, created_at, updated_at - ) VALUES (?,?,?,?,?,?,?,?,?,?) + sender_group_member_ids, body, notification, job_status, created_at, updated_at + ) VALUES (?,?,?,?,?,?,?,?,?,?,?) |] - ((Only groupId) :. jobScopeRow_ jobScope :. (senderColumn, Binary body, DJSPending, currentTs, currentTs)) + ((Only groupId) :. jobScopeRow_ jobScope :. (senderColumn, Binary body, BI notification, DJSPending, currentTs, currentTs)) where GroupInfo {groupId} = gInfo -- NULL ↔ []; non-empty list ↔ comma-separated decimal Int64s. @@ -280,7 +280,7 @@ getPendingDeliveryJobScopes db = |] (Only DJSPending) -type MessageDeliveryJobRow = (Only Int64) :. DeliveryJobScopeRow :. (Maybe Text, Binary ByteString, Maybe GroupMemberId) +type MessageDeliveryJobRow = (Only Int64) :. DeliveryJobScopeRow :. (Maybe Text, Binary ByteString, BoolInt, Maybe GroupMemberId) getNextDeliveryJob :: DB.Connection -> DeliveryWorkerKey -> IO (Either StoreError (Maybe MessageDeliveryJob)) getNextDeliveryJob db deliveryKey = do @@ -310,14 +310,14 @@ getNextDeliveryJob db deliveryKey = do SELECT delivery_job_id, worker_scope, job_scope_spec_tag, job_scope_include_pending, job_scope_support_gm_id, - sender_group_member_ids, body, cursor_group_member_id + sender_group_member_ids, body, notification, cursor_group_member_id FROM delivery_jobs WHERE delivery_job_id = ? |] (Only jobId) where toDeliveryJob :: MessageDeliveryJobRow -> Either StoreError MessageDeliveryJob - toDeliveryJob ((Only jobId') :. jobScopeRow :. (senderGMIdsText_, Binary body, cursorGMId_)) = do + toDeliveryJob ((Only jobId') :. jobScopeRow :. (senderGMIdsText_, Binary body, BI notification, cursorGMId_)) = do jobScope <- maybe (Left $ SEInvalidDeliveryJob jobId') Right $ toJobScope_ jobScopeRow -- NULL or empty string means []; otherwise the value must parse -- as a comma-separated decimal Int64 list. An unparseable @@ -325,7 +325,7 @@ getNextDeliveryJob db deliveryKey = do senderGMIds <- case senderGMIdsText_ of Nothing -> Right [] Just t -> maybe (Left $ SEInvalidDeliveryJob jobId') Right $ parseSenderGMIds t - Right $ MessageDeliveryJob {jobId = jobId', jobScope, senderGMIds, body, cursorGMId_} + Right $ MessageDeliveryJob {jobId = jobId', jobScope, senderGMIds, body, notification, cursorGMId_} parseSenderGMIds :: Text -> Maybe [GroupMemberId] parseSenderGMIds t | T.null t = Just [] diff --git a/src/Simplex/Chat/Store/Postgres/Migrations.hs b/src/Simplex/Chat/Store/Postgres/Migrations.hs index dc2de08739..7fceb20dfe 100644 --- a/src/Simplex/Chat/Store/Postgres/Migrations.hs +++ b/src/Simplex/Chat/Store/Postgres/Migrations.hs @@ -55,6 +55,7 @@ import Simplex.Chat.Store.Postgres.Migrations.M20260918_badge_issue_errors import Simplex.Chat.Store.Postgres.Migrations.M20260923_preferences_json import Simplex.Chat.Store.Postgres.Migrations.M20260925_badge_bindings import Simplex.Chat.Store.Postgres.Migrations.M20261010_invite_member_via_group +import Simplex.Chat.Store.Postgres.Migrations.M20261012_delivery_job_notification import Simplex.Messaging.Agent.Store.Shared (Migration (..)) schemaMigrations :: [(String, Text, Maybe Text)] @@ -109,7 +110,8 @@ schemaMigrations = ("20260918_badge_issue_errors", m20260918_badge_issue_errors, Just down_m20260918_badge_issue_errors), ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json), ("20260925_badge_bindings", m20260925_badge_bindings, Just down_m20260925_badge_bindings), - ("20261010_invite_member_via_group", m20261010_invite_member_via_group, Just down_m20261010_invite_member_via_group) + ("20261010_invite_member_via_group", m20261010_invite_member_via_group, Just down_m20261010_invite_member_via_group), + ("20261012_delivery_job_notification", m20261012_delivery_job_notification, Just down_m20261012_delivery_job_notification) ] -- | The list of migrations in ascending order by date diff --git a/src/Simplex/Chat/Store/Postgres/Migrations/M20261012_delivery_job_notification.hs b/src/Simplex/Chat/Store/Postgres/Migrations/M20261012_delivery_job_notification.hs new file mode 100644 index 0000000000..b8e025f53e --- /dev/null +++ b/src/Simplex/Chat/Store/Postgres/Migrations/M20261012_delivery_job_notification.hs @@ -0,0 +1,19 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE QuasiQuotes #-} + +module Simplex.Chat.Store.Postgres.Migrations.M20261012_delivery_job_notification where + +import Data.Text (Text) +import Text.RawString.QQ (r) + +m20261012_delivery_job_notification :: Text +m20261012_delivery_job_notification = + [r| +ALTER TABLE delivery_jobs ADD COLUMN notification SMALLINT NOT NULL DEFAULT 0; +|] + +down_m20261012_delivery_job_notification :: Text +down_m20261012_delivery_job_notification = + [r| +ALTER TABLE delivery_jobs DROP COLUMN notification; +|] diff --git a/src/Simplex/Chat/Store/SQLite/Migrations.hs b/src/Simplex/Chat/Store/SQLite/Migrations.hs index 3e6d6694c6..6ed3e81d1f 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations.hs +++ b/src/Simplex/Chat/Store/SQLite/Migrations.hs @@ -178,6 +178,7 @@ import Simplex.Chat.Store.SQLite.Migrations.M20260918_badge_issue_errors import Simplex.Chat.Store.SQLite.Migrations.M20260923_preferences_json import Simplex.Chat.Store.SQLite.Migrations.M20260925_badge_bindings import Simplex.Chat.Store.SQLite.Migrations.M20261010_invite_member_via_group +import Simplex.Chat.Store.SQLite.Migrations.M20261012_delivery_job_notification import Simplex.Messaging.Agent.Store.Shared (Migration (..)) schemaMigrations :: [(String, Query, Maybe Query)] @@ -355,7 +356,8 @@ schemaMigrations = ("20260918_badge_issue_errors", m20260918_badge_issue_errors, Just down_m20260918_badge_issue_errors), ("20260923_preferences_json", m20260923_preferences_json, Just down_m20260923_preferences_json), ("20260925_badge_bindings", m20260925_badge_bindings, Just down_m20260925_badge_bindings), - ("20261010_invite_member_via_group", m20261010_invite_member_via_group, Just down_m20261010_invite_member_via_group) + ("20261010_invite_member_via_group", m20261010_invite_member_via_group, Just down_m20261010_invite_member_via_group), + ("20261012_delivery_job_notification", m20261012_delivery_job_notification, Just down_m20261012_delivery_job_notification) ] -- | The list of migrations in ascending order by date diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/M20261012_delivery_job_notification.hs b/src/Simplex/Chat/Store/SQLite/Migrations/M20261012_delivery_job_notification.hs new file mode 100644 index 0000000000..9a582823b5 --- /dev/null +++ b/src/Simplex/Chat/Store/SQLite/Migrations/M20261012_delivery_job_notification.hs @@ -0,0 +1,18 @@ +{-# LANGUAGE QuasiQuotes #-} + +module Simplex.Chat.Store.SQLite.Migrations.M20261012_delivery_job_notification where + +import Database.SQLite.Simple (Query) +import Database.SQLite.Simple.QQ (sql) + +m20261012_delivery_job_notification :: Query +m20261012_delivery_job_notification = + [sql| +ALTER TABLE delivery_jobs ADD COLUMN notification INTEGER NOT NULL DEFAULT 0; +|] + +down_m20261012_delivery_job_notification :: Query +down_m20261012_delivery_job_notification = + [sql| +ALTER TABLE delivery_jobs DROP COLUMN notification; +|] diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/agent_query_plans.txt b/src/Simplex/Chat/Store/SQLite/Migrations/agent_query_plans.txt index d12b3c98cf..dc8ad0f248 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/agent_query_plans.txt +++ b/src/Simplex/Chat/Store/SQLite/Migrations/agent_query_plans.txt @@ -614,15 +614,6 @@ Query: Plan: SEARCH address_ratchet_keys USING INDEX idx_address_ratchet_keys (conn_id=? AND ratchet_key_id=?) -Query: - UPDATE rcv_messages - SET receive_attempts = receive_attempts + 1 - WHERE conn_id = ? AND internal_id = ? - RETURNING receive_attempts - -Plan: -SEARCH rcv_messages USING COVERING INDEX idx_rcv_messages_conn_id_internal_id (conn_id=? AND internal_id=?) - Query: DELETE FROM address_ratchet_keys WHERE conn_id = ? @@ -1431,6 +1422,10 @@ Query: SELECT last_insert_rowid() Plan: SCAN CONSTANT ROW +Query: SELECT msg_flags FROM messages WHERE conn_id = ? AND internal_snd_id IS NOT NULL AND msg_type = ? ORDER BY internal_id DESC LIMIT ? +Plan: +SEARCH messages USING PRIMARY KEY (conn_id=?) + Query: SELECT ratchet_state FROM ratchets WHERE conn_id = ? Plan: SEARCH ratchets USING PRIMARY KEY (conn_id=?) diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt index 433c2ec43f..64aea20620 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt +++ b/src/Simplex/Chat/Store/SQLite/Migrations/chat_query_plans.txt @@ -774,7 +774,7 @@ Query: SELECT delivery_job_id, worker_scope, job_scope_spec_tag, job_scope_include_pending, job_scope_support_gm_id, - sender_group_member_ids, body, cursor_group_member_id + sender_group_member_ids, body, notification, cursor_group_member_id FROM delivery_jobs WHERE delivery_job_id = ? @@ -5058,8 +5058,8 @@ Query: INSERT INTO delivery_jobs ( group_id, worker_scope, job_scope_spec_tag, job_scope_include_pending, job_scope_support_gm_id, - sender_group_member_ids, body, job_status, created_at, updated_at - ) VALUES (?,?,?,?,?,?,?,?,?,?) + sender_group_member_ids, body, notification, job_status, created_at, updated_at + ) VALUES (?,?,?,?,?,?,?,?,?,?,?) Plan: @@ -7838,6 +7838,10 @@ Query: SELECT note_folder_id FROM note_folders WHERE user_id = ? LIMIT 1 Plan: SEARCH note_folders USING COVERING INDEX note_folders_user_id (user_id=?) +Query: SELECT notification FROM delivery_jobs ORDER BY delivery_job_id DESC LIMIT 1 +Plan: +SCAN delivery_jobs + Query: SELECT purchase_key FROM badge_code_redemptions Plan: SCAN badge_code_redemptions diff --git a/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql b/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql index d60a41047f..71abf5d37f 100644 --- a/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql +++ b/src/Simplex/Chat/Store/SQLite/Migrations/chat_schema.sql @@ -806,7 +806,8 @@ CREATE TABLE delivery_jobs( created_at TEXT NOT NULL DEFAULT(datetime('now')), updated_at TEXT NOT NULL DEFAULT(datetime('now')) , - sender_group_member_ids TEXT + sender_group_member_ids TEXT, + notification INTEGER NOT NULL DEFAULT 0 ) STRICT; CREATE TABLE group_member_status_predicates( member_status TEXT NOT NULL PRIMARY KEY, diff --git a/src/Simplex/Chat/View.hs b/src/Simplex/Chat/View.hs index e3e58cdf49..03b116202b 100644 --- a/src/Simplex/Chat/View.hs +++ b/src/Simplex/Chat/View.hs @@ -469,6 +469,7 @@ chatEventToView hu ChatConfig {logLevel, showReactions, showReceipts, testView} CEvtUnknownMemberCreated u g fwdM um -> ttyUser u [ttyGroup' g <> ": " <> ttyMember fwdM <> " forwarded a message from an unknown member, creating unknown member record " <> ttyMember um] CEvtUnknownMemberBlocked u g byM um -> ttyUser u [ttyGroup' g <> ": " <> ttyMember byM <> " blocked an unknown member, creating unknown member record " <> ttyMember um] CEvtUnknownMemberAnnounced u g _ um m -> ttyUser u [ttyGroup' g <> ": unknown member " <> ttyMember um <> " updated to " <> ttyMember m] + CEvtDuplicateGroupMessage {} -> [] CEvtRcvFileDescrReady _ _ _ _ -> [] CEvtRcvFileAccepted u ci -> ttyUser u $ savingFile' ci CEvtRcvFileAcceptedSndCancelled u ft -> ttyUser u $ viewRcvFileSndCancelled ft diff --git a/tests/ChatTests/Groups.hs b/tests/ChatTests/Groups.hs index a127b160f5..58c1c9c51c 100644 --- a/tests/ChatTests/Groups.hs +++ b/tests/ChatTests/Groups.hs @@ -18,7 +18,7 @@ import ChatTests.Profiles (addTestBadge, futureDate, issueTestBadge, testBadgeKe import ChatTests.Utils import Control.Concurrent (threadDelay) import Control.Concurrent.Async (concurrently_) -import Control.Concurrent.STM (atomically) +import Control.Concurrent.STM (TVar, atomically, modifyTVar', newTVarIO, readTVarIO, writeTVar) import Control.Monad (forM_, void, when) import Control.Monad.Except (runExceptT) import Control.Monad.Reader (runReaderT) @@ -32,14 +32,14 @@ import Data.List (intercalate, isInfixOf, isSuffixOf) import qualified Data.Map.Strict as M import qualified Data.Text as T import Simplex.Chat.Badges (FileSizeLimits (..)) -import Simplex.Chat.Controller (ChatController (ChatController, smpAgent), ChatConfig (..), ChatHooks (..), ChatLogLevel (..), defaultChatHooks, withAgent) +import Simplex.Chat.Controller (ChatController (ChatController, smpAgent, subscriptionMode), ChatConfig (..), ChatEvent (CEvtDuplicateGroupMessage), ChatHooks (..), ChatLogLevel (..), defaultChatHooks, withAgent) import Simplex.Chat.Library.Internal (encodeConnInfo, getShortLinkConnReq, uniqueMsgMentions, updatedMentionNames) import Simplex.Chat.Markdown (parseMaybeMarkdownList) import Simplex.Chat.Messages (CIMention (..), CIMentionMember (..), ChatItemId) import Simplex.Chat.Messages.Batch (encodeBinaryBatch, encodeFwdElement) import Simplex.Chat.Messages.CIContent (publicGroupNoE2EText) import Simplex.Chat.Options -import Simplex.Chat.Protocol (ChatMessage (ChatMessage), ChatMsgEvent (XGrpMemNew, XGrpRelayInv, XInfo, XMsgUpdate, XMsgNew, XMsgDel), FwdSender (FwdMember, FwdChannel), GrpMsgForward (GrpMsgForward), MsgContainer (..), MsgMention (..), MsgContent (..), VerifiedMsg (VMUnsigned), mcSimple, msgContentText) +import Simplex.Chat.Protocol (ChatMessage (ChatMessage), ChatMsgEvent (XGrpMemNew, XGrpRelayInv, XInfo, XMsgUpdate, XMsgNew, XMsgDel), FwdSender (FwdMember, FwdChannel), GrpMsgForward (GrpMsgForward), MsgContainer (..), MsgMention (..), MsgContent (..), VerifiedMsg (VMUnsigned), chatMsgToBody, mcSimple, msgContentText) import Simplex.Chat.Types import Simplex.Chat.Types.MemberRelations (MemberRelation (..), getRelation, setRelation) import Simplex.Chat.Types.Shared (GroupMemberRole (..), GroupAcceptance (..)) @@ -47,7 +47,7 @@ import Simplex.Messaging.Agent (joinConnection, prepareConnectionToJoin, sendMes import Simplex.Messaging.Agent.Env.SQLite import Simplex.Messaging.Agent.RetryInterval import qualified Simplex.Messaging.Agent.Store.DB as DB -import Simplex.Messaging.Agent.Store.DB (Binary (..)) +import Simplex.Messaging.Agent.Store.DB (Binary (..), BoolInt (..)) import qualified Simplex.Messaging.Crypto as C import Simplex.Messaging.Crypto.BBS (bbsKeyGen) import Simplex.Messaging.Client (pattern NRMInteractive) @@ -194,7 +194,10 @@ chatGroupTests = do it "forward batched messages" testGroupMsgForwardBatched it "forward reports to moderators, don't forward to members (x.msg.new, MCReport)" testGroupMsgForwardReport it "deduplicate forwarded messages" testGroupMsgForwardDeduplicate + it "report duplicate when forwarded copy is received after direct copy" testGroupMsgForwardDuplicateEvent + it "report duplicate when direct copy is received after forwarded copy" testGroupMsgDirectDuplicateEvent it "forward message edit (x.msg.update)" testGroupMsgForwardEdit + it "set notification flag of forwarded messages by the original event" testGroupMsgForwardNotification it "forward message reaction (x.msg.react)" testGroupMsgForwardReaction it "forward message deletion (x.msg.del)" testGroupMsgForwardDeletion it "forward file (x.msg.file.descr)" testGroupMsgForwardFile @@ -282,6 +285,8 @@ chatGroupTests = do describe "relay delivery" $ do describe "single relay" $ do it "should deliver messages to members" testChannels1RelayDeliver + it "should set notification flag of delivered messages" testChannels1RelayDeliverNotification + it "should report duplicate message delivered by relay" testChannelDuplicateEvent describe "should deliver messages in a loop over members" $ do it "number of recipients is multiple of bucket size (3/1)" (testChannels1RelayDeliverLoop 1) it "number of recipients is NOT multiple of bucket size (3/2)" (testChannels1RelayDeliverLoop 2) @@ -298,6 +303,7 @@ chatGroupTests = do it "multi senders disseminate independently" testChannelMultiSendersIndependent it "large profile fits in body" testChannelLargeProfileFits it "multiple large profiles pack across batches in one multi-sender job" testChannelMultipleLargeProfiles + it "overflow profile batch is sent without notification flag" testChannelOverflowProfileNotification it "profile update reuses existing announcement (no re-prepend)" testChannelProfileUpdateNoRePrepend describe "channel operations" $ do it "should update channel profile (signed)" testChannelUpdateProfileSigned @@ -5912,6 +5918,53 @@ testGroupMsgForwardDeduplicate = cath <#. "#team bob> hi there" cath <# "#team hey team" +testGroupMsgForwardDuplicateEvent :: HasCallStack => TestParams -> IO () +testGroupMsgForwardDuplicateEvent ps = do + (dups, cfg) <- duplicateMessageEventsCfg + withNewTestChat ps "alice" aliceProfile $ \alice -> + withNewTestChat ps "bob" bobProfile $ \bob -> + withNewTestChatCfg ps cfg "cath" cathProfile $ \cath -> do + createGroup3 "team" alice bob cath + groupForwardingRelations alice "bob" "cath" `shouldEventuallyReturn` (MRConnected, MRConnected) + + bob #> "#team hi there" + [alice, cath] *<# "#team bob> hi there" + + sharedMsgId <- itemSharedMsgId cath + bobMemId <- memberIdByName cath "bob" + connId <- relayConnIdToMember alice "cath" + ts <- getCurrentTime + let chatMsg = ChatMessage chatInitialVRange (Just sharedMsgId) (XMsgNew $ mcSimple $ MCText "hi there") + sendForwardedCopy = agentSendBody alice connId $ encodeBinaryBatch [encodeFwdElement (GrpMsgForward (FwdMember bobMemId "bob") ts) (VMUnsigned chatMsg)] + sendForwardedCopy + cath <##. "duplicate group message, group id: 1" + readTVarIO dups `shouldReturn` [] + setMainAppOff cath + sendForwardedCopy + cath <##. "duplicate group message, group id: 1" + readTVarIO dups `shouldReturn` ["alice"] + +testGroupMsgDirectDuplicateEvent :: HasCallStack => TestParams -> IO () +testGroupMsgDirectDuplicateEvent ps = do + (dups, cfg) <- duplicateMessageEventsCfg + withNewTestChat ps "alice" aliceProfile $ \alice -> + withNewTestChat ps "bob" bobProfile $ \bob -> + withNewTestChatCfg ps cfg "cath" cathProfile $ \cath -> do + createGroup3 "team" alice bob cath + + bobMemId <- memberIdByName cath "bob" + aliceConnId <- relayConnIdToMember alice "cath" + bobConnId <- relayConnIdToMember bob "cath" + ts <- getCurrentTime + let chatMsg = ChatMessage chatInitialVRange (Just $ SharedMsgId "duplicate_msg1") (XMsgNew $ mcSimple $ MCText "hi there") + agentSendBody alice aliceConnId $ encodeBinaryBatch [encodeFwdElement (GrpMsgForward (FwdMember bobMemId "bob") ts) (VMUnsigned chatMsg)] + cath <# "#team bob> hi there [>>]" + + setMainAppOff cath + agentSendBody bob bobConnId $ chatMsgToBody chatMsg + cath <##. "duplicate group message, group id: 1" + readTVarIO dups `shouldReturn` ["bob"] + testGroupMsgForwardEdit :: HasCallStack => TestParams -> IO () testGroupMsgForwardEdit = testChat3 aliceProfile bobProfile cathProfile $ @@ -5936,6 +5989,29 @@ testGroupMsgForwardEdit = cath ##> "/tail #team 1" cath <# "#team bob> hello there [>>]" +testGroupMsgForwardNotification :: HasCallStack => TestParams -> IO () +testGroupMsgForwardNotification = + testChat3 aliceProfile bobProfile cathProfile $ + \alice bob cath -> do + createGroup3 "team" alice bob cath + setupGroupForwarding alice bob cath + cath ##> "/set receipts all off" + cath <## "ok" + cathConnId <- relayConnIdToMember alice "cath" + + bob #> "#team hi there" + alice <# "#team bob> hi there" + cath <# "#team bob> hi there [>>]" + lastSndMsgFlags alice cathConnId 1 `shouldReturn` ["T"] + lastJobNotification alice `shouldReturn` True + + bob ##> "! #team hello there" + bob <# "#team [edited] hello there" + alice <# "#team bob> [edited] hello there" + cath <# "#team bob> [edited] hello there" + lastSndMsgFlags alice cathConnId 1 `shouldReturn` ["F"] + lastJobNotification alice `shouldReturn` False + testGroupMsgForwardReaction :: HasCallStack => TestParams -> IO () testGroupMsgForwardReaction = testChat3 aliceProfile bobProfile cathProfile $ @@ -6118,6 +6194,7 @@ testGroupMsgForwardAdminRemoval = alice <## "use /d #team to delete the group", cath <## "#team: bob removed alice from the group (signed)" ] + lastJobNotification alice `shouldReturn` False -- there is no forwarding admin anymore between bob and cath, so messages don't get delivered -- (this is not a desired behavior, just a test demonstration/proof of current implementation) @@ -6159,6 +6236,7 @@ testGroupMsgForwardGroupDeletion = cath <## "#team: bob deleted the group (signed)" cath <## "use /d #team to delete the local copy of the group" ] + lastJobNotification alice `shouldReturn` True alice ##> "/groups" alice <## "#team (group deleted, delete local copy: /d #team)" @@ -9520,6 +9598,65 @@ testChannels1RelayDeliver ps = cath <## "group ID: 1" cath <## "subscribers: 4" +testChannels1RelayDeliverNotification :: HasCallStack => TestParams -> IO () +testChannels1RelayDeliverNotification ps = + withNewTestChat ps "alice" aliceProfile $ \alice -> do + withNewTestChatOpts ps relayTestOpts "bob" bobProfile $ \bob -> do + withNewTestChat ps "cath" cathProfile $ \cath -> do + withNewTestChat ps "dan" danProfile $ \dan -> do + withNewTestChat ps "eve" eveProfile $ \eve -> do + createChannel1Relay "team" alice bob cath dan eve + forM_ [cath, dan, eve] $ \cc -> do + cc ##> "/set receipts all off" + cc <## "ok" + cathConnId <- relayConnIdToMember bob "cath" + danConnId <- relayConnIdToMember bob "dan" + eveConnId <- relayConnIdToMember bob "eve" + + alice #> "#team hi" + bob <# "#team> hi" + [cath, dan, eve] *<# "#team> hi [>>]" + forM_ [cathConnId, danConnId, eveConnId] $ \connId -> + lastSndMsgFlags bob connId 1 `shouldReturn` ["T"] + lastJobNotification bob `shouldReturn` True + + cath ##> "+1 #team hi" + cath <## "added 👍" + bob <# "#team cath> > hi" + bob <## " + 👍" + alice <# "#team cath> > hi" + alice <## " + 👍" + dan <## "#team: bob introduced cath (Catherine) in the channel" + dan <# "#team cath> > hi" + dan <## " + 👍" + eve <## "#team: bob introduced cath (Catherine) in the channel" + eve <# "#team cath> > hi" + eve <## " + 👍" + forM_ [danConnId, eveConnId] $ \connId -> + lastSndMsgFlags bob connId 1 `shouldReturn` ["F"] + lastJobNotification bob `shouldReturn` False + +testChannelDuplicateEvent :: HasCallStack => TestParams -> IO () +testChannelDuplicateEvent ps = do + (dups, cfg) <- duplicateMessageEventsCfg + withNewTestChat ps "alice" aliceProfile $ \alice -> + withNewTestChatOpts ps relayTestOpts "bob" bobProfile $ \bob -> + withNewTestChatCfg ps cfg "cath" cathProfile $ \cath -> + withNewTestChat ps "dan" danProfile $ \dan -> + withNewTestChat ps "eve" eveProfile $ \eve -> do + createChannel1Relay "team" alice bob cath dan eve + alice #> "#team hi" + bob <# "#team> hi" + [cath, dan, eve] *<# "#team> hi [>>]" + + sharedMsgId <- itemSharedMsgId cath + connId <- relayConnIdToMember bob "cath" + ts <- getCurrentTime + let chatMsg = ChatMessage chatInitialVRange (Just sharedMsgId) (XMsgNew $ mcSimple $ MCText "hi") + setMainAppOff cath + agentSendBody bob connId $ encodeBinaryBatch [encodeFwdElement (GrpMsgForward FwdChannel ts) (VMUnsigned chatMsg)] + readTVarIO dups `shouldEventuallyReturn` ["bob"] + createChannel1Relay :: String -> TestCC -> TestCC -> TestCC -> TestCC -> TestCC -> IO () createChannel1Relay gName owner relay cath dan eve = do (shortLink, fullLink) <- prepareChannel1Relay gName owner relay @@ -9979,6 +10116,34 @@ testChannelLargeProfileFits ps = memberIntroducedTo bob "cath" "dan" +testChannelOverflowProfileNotification :: HasCallStack => TestParams -> IO () +testChannelOverflowProfileNotification ps = + withNewTestChat ps "alice" aliceProfile $ \alice -> do + withNewTestChatOpts ps relayTestOpts "bob" bobProfile $ \bob -> do + withNewTestChat ps "cath" cathProfile $ \cath -> do + withNewTestChat ps "dan" danProfile $ \dan -> do + (shortLink, fullLink) <- prepareChannel1Relay "team" alice bob + memberJoinChannel "team" [bob] [alice] shortLink fullLink cath + memberJoinChannel "team" [bob] [alice] shortLink fullLink dan + promoteChannelMember "team" alice bob cath [dan] + dan ##> "/set receipts all off" + dan <## "ok" + danConnId <- relayConnIdToMember bob "dan" + + let bigImage = T.pack ("data:image/png;base64," <> replicate 10000 'A') + longText = replicate 7000 'x' + withCCTransaction bob $ \db -> + DB.execute db "UPDATE contact_profiles SET image = ? WHERE display_name = ?" (bigImage, "cath" :: T.Text) + sentBefore <- length <$> lastSndMsgFlags bob danConnId 100 + + cath #> ("#team " <> longText) + bob <# ("#team cath> " <> longText) + alice <# ("#team cath> " <> longText <> " [>>]") + dan <### [EndsWith "updated to cath"] + dan <## "#team: bob introduced cath (Catherine) in the channel" + dan <# ("#team cath> " <> longText <> " [>>]") + drop sentBefore <$> lastSndMsgFlags bob danConnId 100 `shouldReturn` ["F", "T"] + testChannelMultipleLargeProfiles :: HasCallStack => TestParams -> IO () testChannelMultipleLargeProfiles ps = withNewTestChat ps "alice" aliceProfile $ \alice -> do @@ -11053,6 +11218,7 @@ testChannelDeleteGroupSigned ps = eve <## "#team: alice deleted the group (signed)" eve <## "use /d #team to delete the local copy of the group" ] + lastJobNotification bob `shouldReturn` True testChannelDeleteGroupCleanup :: HasCallStack => TestParams -> IO () testChannelDeleteGroupCleanup ps = @@ -11246,6 +11412,7 @@ testChannelRelayLeave ps = dan <## "#team: bob left the group (signed)", eve <## "#team: bob left the group (signed)" ] + lastJobNotification bob `shouldReturn` False -- verify relay1 member status is "left" on all clients that know bob checkMemberStatus alice "bob" (Just "left") @@ -13149,6 +13316,39 @@ relayConnIdToMember cc name = do (Only connId : _) -> pure connId _ -> fail $ "no relay connection to member " <> T.unpack name +agentSendBody :: TestCC -> ByteString -> ByteString -> IO () +agentSendBody cc connId body = do + let ChatController {smpAgent} = chatController cc + runExceptT (sendMessages smpAgent [(connId, PQEncOff, MsgFlags False, vrValue body)]) >>= either (fail . show) (const $ pure ()) + +lastSndMsgFlags :: TestCC -> ByteString -> Int -> IO [T.Text] +lastSndMsgFlags cc connId n = do + rows <- withCCAgentTransaction cc $ \db -> + DB.query + db + "SELECT msg_flags FROM messages WHERE conn_id = ? AND internal_snd_id IS NOT NULL AND msg_type = ? ORDER BY internal_id DESC LIMIT ?" + (connId, Binary ("M" :: ByteString), n) + pure $ reverse $ map fromOnly rows + +lastJobNotification :: TestCC -> IO Bool +lastJobNotification cc = do + [Only (BI ntf)] <- withCCTransaction cc $ \db -> + DB.query_ db "SELECT notification FROM delivery_jobs ORDER BY delivery_job_id DESC LIMIT 1" + pure ntf + +duplicateMessageEventsCfg :: IO (TVar [ContactName], ChatConfig) +duplicateMessageEventsCfg = do + dups <- newTVarIO [] + let hook _ evt = do + case evt of + Right (CEvtDuplicateGroupMessage _ GroupMember {localDisplayName}) -> atomically $ modifyTVar' dups (<> [localDisplayName]) + _ -> pure () + pure evt + pure (dups, testCfg {chatHooks = defaultChatHooks {eventHook = Just hook}}) + +setMainAppOff :: TestCC -> IO () +setMainAppOff cc = atomically $ writeTVar (subscriptionMode $ chatController cc) SMOnlyCreate + itemSharedMsgId :: TestCC -> IO SharedMsgId itemSharedMsgId cc = do rows <- withCCTransaction cc $ \db -> From 41f0c429b3d250249b3a748619d96b418c8de882 Mon Sep 17 00:00:00 2001 From: Evgeny Date: Thu, 15 Oct 2026 12:50:38 +0100 Subject: [PATCH 18/26] website: update home page (#7724) * website: update home page * update --------- Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com> --- website/langs/ar.json | 10 +- website/langs/cs.json | 10 +- website/langs/de.json | 9 +- website/langs/en.json | 10 +- website/langs/es.json | 9 +- website/langs/fr.json | 9 +- website/langs/hu.json | 9 +- website/langs/id.json | 10 +- website/langs/it.json | 9 +- website/langs/ja.json | 10 +- website/langs/pl.json | 10 +- website/langs/pt_BR.json | 10 +- website/langs/ru.json | 10 +- website/langs/zh_Hans.json | 2 +- website/src/crowdfunding.html | 26 +- website/src/css/design3-nav.css | 14 +- website/src/css/design3.css | 367 +++++++++++++++++++++------ website/src/css/livestream.css | 2 +- website/src/fdroid.html | 5 + website/src/img/new/f_droid_icon.svg | 50 ++++ website/src/index.html | 97 +++---- website/src/js/design3.js | 5 +- website/src/livestream.html | 8 +- 23 files changed, 507 insertions(+), 194 deletions(-) create mode 100644 website/src/img/new/f_droid_icon.svg diff --git a/website/langs/ar.json b/website/langs/ar.json index 39d72effc2..92d7ddb72a 100644 --- a/website/langs/ar.json +++ b/website/langs/ar.json @@ -261,7 +261,13 @@ "about-and-contact-us": "عن واتصل بنا", "index-hero-h1": "كن
حراً", "index-hero-h2": "في شبكتك", - "index-hero-p1": "أول شبكة بدون معرّفات مستخدمين.
أنت تملك جهات اتصالك ومجموعاتك وقنواتك.", + "index-hero-p1": "شبكة المراسلة الوحيدة بدون أي معرّفات للمستخدمين.
أنت تملك جهات اتصالك ومجموعاتك وقنواتك.", + "index-hero-own-part": "امتلك جزءًا منها.", + "index-hero-invest": "استثمر في SimpleX Chat.", + "index-hero-downloads": "تنزيلات", + "index-hero-monthly-users": "مستخدمون شهريًا", + "index-hero-countdown-lead": "إطلاق نطاقات SimpleX", + "index-hero-countdown-done": "احصل على نطاق SimpleX", "index-hero-download-desktop-btn-title": "نزّل تطبيق سطح مكتب SimpleX", "index-testflight-title": "إصدار SimpleX التجريبي ل iOS على TestFlight", "index-f-droid-title": "تطبيق SimpleX من خلال F-Droid", @@ -296,7 +302,7 @@ "index-roadmap-3-title": "اجعل مجتمعاتك تنمو", "index-roadmap-3-desc": "أدوات لتعزيز مجتمعاتك", "index-directory-h2": "انضم إلى مجتمعات SimpleX", - "index-directory-p1": "أكثر من 2 مليون شخص قاموا بتنزيل تطبيقات SimpleX.", + "index-directory-p1": "أكثر من 3 ملايين شخص قاموا بتنزيل تطبيقات SimpleX.", "index-directory-p2": "ابحث عن قنواتك ومجتمعاتك في الدليل وأنشئ قنواتك الخاصة!", "index-directory-cta": "اعرض دليل SimpleX", "index-directory-users-group-title": "مجموعة مستخدمي SimpleX", diff --git a/website/langs/cs.json b/website/langs/cs.json index 0df72eeab9..800578e2c4 100644 --- a/website/langs/cs.json +++ b/website/langs/cs.json @@ -262,7 +262,13 @@ "navbar-token": "Token", "index-hero-h1": "
Žijte
svobodně", "index-hero-h2": "Ve Své Síti", - "index-hero-p1": "První síť bez uživatelských ID.
Vaše kontakty, skupiny a kanály patří vám.", + "index-hero-p1": "Jediná síť pro zasílání zpráv bez jakýchkoli uživatelských identifikátorů.
Vaše kontakty, skupiny a kanály patří vám.", + "index-hero-own-part": "Vlastněte její část.", + "index-hero-invest": "Investujte do SimpleX Chat.", + "index-hero-downloads": "Stažení", + "index-hero-monthly-users": "Uživatelů měsíčně", + "index-hero-countdown-lead": "Spuštění domén SimpleX", + "index-hero-countdown-done": "Získejte doménu SimpleX", "index-hero-download-desktop-btn-title": "Stáhněte si desktopovou aplikaci SimpleX", "index-testflight-title": "Beta verze SimpleX pro iOS na TestFlight", "index-f-droid-title": "Stáhnout aplikaci SimpleX přes F-Droid", @@ -300,7 +306,7 @@ "index-roadmap-3-title": "Pomozte své komunitě růst", "index-roadmap-3-desc": "Nástroje na podporu vašich komunit", "index-directory-h2": "Zapojte se do komunit SimpleX", - "index-directory-p1": "Více než 2 miliony lidí si stáhly aplikace SimpleX.", + "index-directory-p1": "Více než 3 miliony lidí si stáhly aplikace SimpleX.", "index-directory-p2": "Najděte své kanály a komunity v katalogu a vytvořte si vlastní!", "index-directory-cta": "Zobrazit katalog SimpleX", "index-directory-users-group-title": "Uživatelské skupiny SimpleX", diff --git a/website/langs/de.json b/website/langs/de.json index 34cecb8e4d..0f144010ea 100644 --- a/website/langs/de.json +++ b/website/langs/de.json @@ -261,7 +261,12 @@ "directory": "Verzeichnis", "index-hero-h1": "Sei
frei", "index-hero-h2": "In Deinem Netzwerk", - "index-hero-p1": "Das erste Netzwerk ohne Benutzer-IDs.
Ihre Kontakte, Gruppen und Kanäle gehören Ihnen.", + "index-hero-p1": "Das einzige Messaging-Netzwerk ohne jegliche Benutzerkennungen.
Ihre Kontakte, Gruppen und Kanäle gehören Ihnen.", + "index-hero-own-part": "Besitzen Sie einen Teil davon.", + "index-hero-downloads": "Downloads", + "index-hero-monthly-users": "Monatliche Nutzer", + "index-hero-countdown-lead": "Start der SimpleX-Domains", + "index-hero-countdown-done": "SimpleX-Domain sichern", "index-hero-download-desktop-btn-title": "Download der SimpleX Desktop-App", "index-testflight-title": "Öffentlicher iOS-Preview auf TestFlight", "index-f-droid-title": "SimpleX-App über das F-Droid-Repository", @@ -299,7 +304,7 @@ "index-roadmap-3-title": "Lassen Sie Ihre Communitys wachsen", "index-roadmap-3-desc": "Tools zur Förderung Ihrer Communitys", "index-directory-h2": "Treten Sie SimpleX-Communitys bei", - "index-directory-p1": "Mehr als 2 Millionen Nutzer haben schon SimpleX-Apps heruntergeladen.", + "index-directory-p1": "Mehr als 3 Millionen Nutzer haben schon SimpleX-Apps heruntergeladen.", "index-directory-p2": "Finden Sie Kanäle und Communitys im Verzeichnis oder erstellen Sie Ihre Eigenen!", "index-directory-cta": "SimpleX-Verzeichnis anzeigen", "index-directory-users-group-title": "SimpleX-Nutzergruppe", diff --git a/website/langs/en.json b/website/langs/en.json index 6138b34c8c..1293d83aff 100644 --- a/website/langs/en.json +++ b/website/langs/en.json @@ -255,6 +255,7 @@ "stable-and-beta-versions-built-by-developers": "Stable and beta versions built by the developers", "f-droid-page-simplex-chat-repo-section-text": "To add it to your F-Droid client, scan the QR code or use this URL:", "signing-key-fingerprint": "Signing key fingerprint (SHA-256)", + "f-droid-page-apk-text": "Or download the APK directly:", "f-droid-org-repo": "F-Droid.org repo", "stable-versions-built-by-f-droid-org": "Stable versions built by F-Droid.org", "releases-to-this-repo-are-done-1-2-days-later": "The releases to this repo are done several days later", @@ -264,9 +265,14 @@ "please-use-link-in-mobile-app": "Please use the link in the mobile app", "index-hero-h1": "Be
Free", "index-hero-h2": "In Your Network", - "index-hero-p1": "The first network without user IDs.
You own your contacts, groups and channels.", + "index-hero-p1": "The only messaging network without any user identifiers.
You own your contacts, groups and channels.", "index-hero-invest": "Invest in SimpleX Chat.", "index-hero-invest-cta": "Learn more on Wefunder.", + "index-hero-own-part": "Own a part of it.", + "index-hero-downloads": "Downloads", + "index-hero-monthly-users": "Monthly users", + "index-hero-countdown-lead": "SimpleX domains launch", + "index-hero-countdown-done": "Get SimpleX domain", "index-hero-download-desktop-btn-title": "Download SimpleX Desktop App", "index-testflight-title": "SimpleX iOS beta-release on TestFlight", "index-f-droid-title": "SimpleX app via F-Droid", @@ -304,7 +310,7 @@ "index-roadmap-3-title": "Make Your Communities Grow", "index-roadmap-3-desc": "Tools to promote your communities", "index-directory-h2": "Join SimpleX Communities", - "index-directory-p1": "More than 2 million people downloaded SimpleX apps.", + "index-directory-p1": "More than 3 million people downloaded SimpleX apps.", "index-directory-p2": "Find your channels and communities in directory and create your own!", "index-directory-cta": "View SimpleX Directory", "index-directory-users-group-title": "SimpleX users group", diff --git a/website/langs/es.json b/website/langs/es.json index 22b69cfbeb..1e9d4e6159 100644 --- a/website/langs/es.json +++ b/website/langs/es.json @@ -261,7 +261,12 @@ "about-and-contact-us": "Quiénes somos & Contacto", "index-hero-h1": "Sé
Libre", "index-hero-h2": "En Tu Red", - "index-hero-p1": "La primera red sin IDs de usuario.
Tus contactos, grupos y canales te pertenecen.", + "index-hero-p1": "La única red de mensajería sin ningún identificador de usuario.
Tus contactos, grupos y canales te pertenecen.", + "index-hero-own-part": "Hazte dueño de una parte.", + "index-hero-downloads": "Descargas", + "index-hero-monthly-users": "Usuarios mensuales", + "index-hero-countdown-lead": "Lanzamiento de dominios SimpleX", + "index-hero-countdown-done": "Obtén un dominio SimpleX", "index-hero-download-desktop-btn-title": "Descargar SimpleX Desktop App", "index-testflight-title": "Betas SimpleX para iOS en TestFlight", "index-f-droid-title": "SimpleX app vía F-Droid", @@ -299,7 +304,7 @@ "index-roadmap-3-title": "Haz Crecer Tus Comunidades", "index-roadmap-3-desc": "Herramientas para la promoción", "index-directory-h2": "Únete a las Comunidades SimpleX", - "index-directory-p1": "Más de 2 millones de personas descargaron las aplicaciones SimpleX.", + "index-directory-p1": "Más de 3 millones de personas descargaron las aplicaciones SimpleX.", "index-directory-p2": "¡Encuentra tus canales y comunidades en el directorio y crea los tuyos!", "index-directory-cta": "Ir al Directorio SimpleX", "index-directory-users-group-title": "SimpleX users group", diff --git a/website/langs/fr.json b/website/langs/fr.json index 124c7ddc67..b53bd0a14e 100644 --- a/website/langs/fr.json +++ b/website/langs/fr.json @@ -263,7 +263,12 @@ "about-and-contact-us": "À propos & Contactez-nous", "index-hero-h1": "Soyez
Libre", "index-hero-h2": "Dans Votre Réseau", - "index-hero-p1": "Le premier réseau sans identifiants d'utilisateur.
Vos contacts, groupes et canaux vous appartiennent.", + "index-hero-p1": "Le seul réseau de messagerie sans aucun identifiant d'utilisateur.
Vos contacts, groupes et canaux vous appartiennent.", + "index-hero-own-part": "Possédez-en une part.", + "index-hero-downloads": "Téléchargements", + "index-hero-monthly-users": "Utilisateurs mensuels", + "index-hero-countdown-lead": "Lancement des domaines SimpleX", + "index-hero-countdown-done": "Obtenez un domaine SimpleX", "index-hero-download-desktop-btn-title": "Téléchargez l’application de bureau SimpleX", "index-testflight-title": "Version bêta de SimpleX pour iOS sur TestFlight", "index-f-droid-title": "Application SimpleX via F-Droid", @@ -301,7 +306,7 @@ "index-token-cta-cf": "Investir dans SimpleX Chat", "index-token-p2": "Cela couvrira l'infrastructure, le développement logiciel et la gouvernance du réseau.", "index-directory-h2": "Rejoindre les communautés SimpleX", - "index-directory-p1": "Plus de 2 millions de personnes ont téléchargé les applications SimpleX.", + "index-directory-p1": "Plus de 3 millions de personnes ont téléchargé les applications SimpleX.", "index-directory-p2": "Trouvez vos chaînes et communautés dans l'annuaire et créez-en les vôtres !", "index-directory-cta": "Afficher l’annuaire SimpleX", "index-directory-users-group-title": "Groupe d'utilisateurs SimpleX", diff --git a/website/langs/hu.json b/website/langs/hu.json index 1b3a4f5869..fec3633ed9 100644 --- a/website/langs/hu.json +++ b/website/langs/hu.json @@ -260,7 +260,12 @@ "directory": "Csoportjegyzék", "about-and-contact-us": "Névjegy és kapcsolat", "index-hero-h1": "
Legyen
szabad
", - "index-hero-p1": "Az első hálózat felhasználói azonosítók nélkül.
A saját partnerei, csoportjai és csatornái felett Ön rendelkezik.", + "index-hero-p1": "Az egyetlen üzenetküldő hálózat semmilyen felhasználói azonosító nélkül.
A saját partnerei, csoportjai és csatornái felett Ön rendelkezik.", + "index-hero-own-part": "Legyen résztulajdonos.", + "index-hero-downloads": "Letöltés", + "index-hero-monthly-users": "Havi felhasználó", + "index-hero-countdown-lead": "A SimpleX domainek indulása", + "index-hero-countdown-done": "Szerezzen SimpleX domaint", "index-hero-download-desktop-btn-title": "SimpleX számítógépes alkalmazásának letöltése", "index-security-assessment-title": "Biztonsági auditok", "index-security-review-2022-title": "Biztonsági audit 2022", @@ -299,7 +304,7 @@ "index-roadmap-3-title": "Közösségek növelése", "index-roadmap-3-desc": "Eszközök biztosítása a közösségek népszerűsítéséhez", "index-directory-h2": "Csatlakozzon a SimpleX közösségekhez", - "index-directory-p1": "Több mint 2 millió ember töltötte le a SimpleX alkalmazások egyikét.", + "index-directory-p1": "Több mint 3 millió ember töltötte le a SimpleX alkalmazások egyikét.", "index-directory-p2": "Találja meg a kedvenc csatornáit és közösségeit a csoportjegyzékben, vagy hozza létre a sajátját!", "index-directory-cta": "SimpleX-csoportjegyzék megtekintése", "index-directory-users-group-title": "SimpleX felhasználók csoportja", diff --git a/website/langs/id.json b/website/langs/id.json index b1134bcaff..a88a5aaff3 100644 --- a/website/langs/id.json +++ b/website/langs/id.json @@ -261,7 +261,13 @@ "get-simplex": "Dapatkan aplikasi desktop SimpleX", "index-hero-h1": "
Bebaslah
", "index-hero-h2": "Di Jaringan Anda", - "index-hero-p1": "Jaringan pertama tanpa ID pengguna.
Anda pemilik kontak, grup, dan kanal Anda.", + "index-hero-p1": "Satu-satunya jaringan pesan tanpa pengenal pengguna apa pun.
Anda pemilik kontak, grup, dan kanal Anda.", + "index-hero-own-part": "Miliki sebagian darinya.", + "index-hero-invest": "Berinvestasi di SimpleX Chat.", + "index-hero-downloads": "Unduhan", + "index-hero-monthly-users": "Pengguna bulanan", + "index-hero-countdown-lead": "Peluncuran domain SimpleX", + "index-hero-countdown-done": "Dapatkan domain SimpleX", "index-hero-download-desktop-btn-title": "Unduh Aplikasi Desktop SimpleX", "index-testflight-title": "Pratinjau iOS publik di TestFlight", "index-f-droid-title": "Aplikasi SimpleX via F-Droid", @@ -299,7 +305,7 @@ "index-roadmap-3-title": "Buat Komunitas Anda Meningkat", "index-roadmap-3-desc": "Alat untuk promosikan komunitas Anda", "index-directory-h2": "Gabung ke Komunitas SimpleX", - "index-directory-p1": "Lebih dari 2 juta orang telah mengunduh aplikasi SimpleX.", + "index-directory-p1": "Lebih dari 3 juta orang telah mengunduh aplikasi SimpleX.", "index-directory-p2": "Temukan kanal dan komunitas Anda di direktori dan buat milik Anda sendiri!", "index-directory-cta": "Lihat Direktori SimpleX", "index-directory-users-group-title": "Grup pengguna SimpleX", diff --git a/website/langs/it.json b/website/langs/it.json index 649637b8e2..013b3be7f0 100644 --- a/website/langs/it.json +++ b/website/langs/it.json @@ -260,7 +260,12 @@ "about-and-contact-us": "Informazioni e contatti", "directory": "Directory", "index-hero-h2": "nella tua rete", - "index-hero-p1": "La prima rete senza ID utente.
I tuoi contatti, gruppi e canali sono tuoi.", + "index-hero-p1": "L'unica rete di messaggistica senza alcun identificatore utente.
I tuoi contatti, gruppi e canali sono tuoi.", + "index-hero-own-part": "Possiedine una parte.", + "index-hero-downloads": "Download", + "index-hero-monthly-users": "Utenti mensili", + "index-hero-countdown-lead": "Lancio dei domini SimpleX", + "index-hero-countdown-done": "Ottieni un dominio SimpleX", "index-hero-download-desktop-btn-title": "Scarica l'app desktop di SimpleX", "index-testflight-title": "Anteprima pubblica per iOS su TestFlight", "index-f-droid-title": "SimpleX via F-Droid", @@ -299,7 +304,7 @@ "index-roadmap-3-title": "Fare crescere le tue comunità", "index-roadmap-3-desc": "Strumenti per promuovere le tue comunità", "index-directory-h2": "Unisciti alle comunità di SimpleX", - "index-directory-p1": "Più di 2 milioni di persone hanno scaricato le app SimpleX.", + "index-directory-p1": "Più di 3 milioni di persone hanno scaricato le app SimpleX.", "index-directory-p2": "Trova i tuoi canali e le comunità nella directory e creane di tuoi!", "index-directory-cta": "Vedi la directory di SimpleX", "index-directory-users-group-title": "Gruppo utenti SimpleX", diff --git a/website/langs/ja.json b/website/langs/ja.json index 4c850853e4..af2e29e26f 100644 --- a/website/langs/ja.json +++ b/website/langs/ja.json @@ -261,7 +261,13 @@ "about-and-contact-us": "概要・お問い合わせ", "index-hero-h1": "自由で
あれ", "index-hero-h2": "あなたのネットワークで", - "index-hero-p1": "ユーザーIDのない世界初のネットワーク。
連絡先、グループ、チャンネルはあなたのものです。", + "index-hero-p1": "ユーザー識別子を一切持たない唯一のメッセージングネットワーク。
連絡先、グループ、チャンネルはあなたのものです。", + "index-hero-own-part": "その一部を所有しよう。", + "index-hero-invest": "SimpleX Chatに投資しよう。", + "index-hero-downloads": "ダウンロード", + "index-hero-monthly-users": "月間ユーザー", + "index-hero-countdown-lead": "SimpleXドメイン公開", + "index-hero-countdown-done": "SimpleXドメインを取得", "index-hero-download-desktop-btn-title": "SimpleX デスクトップアプリをダウンロード", "index-security-assessment-title": "セキュリティ監査", "index-security-review-2022-title": "セキュリティ監査 2022", @@ -291,7 +297,7 @@ "index-roadmap-3-title": "コミュニティの成長", "index-roadmap-3-desc": "コミュニティを広げるツール", "index-directory-h2": "SimpleXコミュニティに参加する", - "index-directory-p1": "200万人以上がSimpleXアプリをダウンロードしました。", + "index-directory-p1": "300万人以上がSimpleXアプリをダウンロードしました。", "index-directory-p2": "ディレクトリでチャンネルやコミュニティを見つけて、あなた自身のものを作成しましょう！", "index-directory-cta": "SimpleXディレクトリを見る", "index-directory-users-group-title": "SimpleXユーザグループ", diff --git a/website/langs/pl.json b/website/langs/pl.json index a760dc34cf..90690c2c1c 100644 --- a/website/langs/pl.json +++ b/website/langs/pl.json @@ -262,7 +262,13 @@ "about-and-contact-us": "O nas i Kontakt", "index-hero-h1": "Bądź
Wolny", "index-hero-h2": "W Swojej Sieci", - "index-hero-p1": "Pierwsza sieć bez identyfikatorów użytkowników.
Twoje kontakty, grupy i kanały należą do Ciebie.", + "index-hero-p1": "Jedyna sieć komunikacyjna bez żadnych identyfikatorów użytkowników.
Twoje kontakty, grupy i kanały należą do Ciebie.", + "index-hero-own-part": "Miej w niej udział.", + "index-hero-invest": "Zainwestuj w SimpleX Chat.", + "index-hero-downloads": "Pobrań", + "index-hero-monthly-users": "Użytkowników miesięcznie", + "index-hero-countdown-lead": "Start domen SimpleX", + "index-hero-countdown-done": "Zdobądź domenę SimpleX", "index-hero-download-desktop-btn-title": "Pobierz Aplikację SimpleX na Komputer", "index-testflight-title": "SimpleX iOS beta-wydanie na TestFlight", "index-f-droid-title": "SimpleX app z F-Droid", @@ -300,7 +306,7 @@ "index-roadmap-3-title": "Spraw, aby Twoje społeczności Rosły", "index-roadmap-3-desc": "Narzędzia do promowania Twoich społeczności", "index-directory-h2": "Dołącz do Społeczności SimpleX", - "index-directory-p1": "Ponad 2 miliony osób pobrało aplikacje SimpleX.", + "index-directory-p1": "Ponad 3 miliony osób pobrało aplikacje SimpleX.", "index-directory-p2": "Znajdź swoje kanały i społeczności w katalogu i stwórz własne!", "index-directory-cta": "Zobacz katalog SimpleX", "index-directory-users-group-title": "Grupa użytkowników SimpleX", diff --git a/website/langs/pt_BR.json b/website/langs/pt_BR.json index 4b663e75ec..22f7a1dc45 100644 --- a/website/langs/pt_BR.json +++ b/website/langs/pt_BR.json @@ -262,7 +262,13 @@ "navbar-token": "Token", "index-hero-h1": "Seja
Livre", "index-hero-h2": "Na Sua Rede", - "index-hero-p1": "A primeira rede sem IDs de usuário.
Seus contatos, grupos e canais pertencem a você.", + "index-hero-p1": "A única rede de mensagens sem nenhum identificador de usuário.
Seus contatos, grupos e canais pertencem a você.", + "index-hero-own-part": "Seja dono de uma parte dela.", + "index-hero-invest": "Invista no SimpleX Chat.", + "index-hero-downloads": "Downloads", + "index-hero-monthly-users": "Usuários mensais", + "index-hero-countdown-lead": "Lançamento de domínios SimpleX", + "index-hero-countdown-done": "Obtenha um domínio SimpleX", "index-hero-download-desktop-btn-title": "Baixe o aplicativo SimpleX Desktop", "index-testflight-title": "SimpleX iOS - versão beta no TestFlight", "index-f-droid-title": "Aplicativo SimpleX no F-Droid", @@ -300,7 +306,7 @@ "index-roadmap-3-title": "Faça Suas Comunidades Crescerem", "index-roadmap-3-desc": "Ferramentas para promover suas comunidades", "index-directory-h2": "Participe das Comunidades SimpleX", - "index-directory-p1": "Mais de 2 milhões de pessoas baixaram os aplicativos SimpleX.", + "index-directory-p1": "Mais de 3 milhões de pessoas baixaram os aplicativos SimpleX.", "index-directory-p2": "Encontre seus canais e comunidades no diretório e crie os seus próprios!", "index-directory-cta": "Ver diretório do SimpleX", "how-secure-comparison-title": "Comparação da segurança da criptografia de ponta a ponta em diferentes mensageiros", diff --git a/website/langs/ru.json b/website/langs/ru.json index a8bdfa8725..687e5481b2 100644 --- a/website/langs/ru.json +++ b/website/langs/ru.json @@ -261,7 +261,13 @@ "docs-dropdown-14": "SimpleX для бизнеса", "index-hero-h1": "
Будь
Свободен
", "index-hero-h2": "В Своей Сети", - "index-hero-p1": "Первая сеть без идентификаторов пользователей.
Ваши контакты, группы и каналы принадлежат Вам.", + "index-hero-p1": "Единственная сеть обмена сообщениями без идентификаторов пользователей.
Ваши контакты, группы и каналы принадлежат Вам.", + "index-hero-own-part": "Владейте её частью.", + "index-hero-invest": "Инвестируйте в SimpleX Chat.", + "index-hero-downloads": "Загрузок", + "index-hero-monthly-users": "Пользователей в месяц", + "index-hero-countdown-lead": "Запуск доменов SimpleX", + "index-hero-countdown-done": "Получите домен SimpleX", "index-hero-download-desktop-btn-title": "Загрузить приложение SimpleX для компьютера", "index-testflight-title": "Бета-релиз для iOS на TestFlight", "index-f-droid-title": "Загрузить через F-Droid", @@ -299,7 +305,7 @@ "index-roadmap-3-title": "Поддержка роста Ваших групп", "index-roadmap-3-desc": "Инструменты для продвижения групп", "index-directory-h2": "Вступайте в Группы SimpleX", - "index-directory-p1": "Более 2 миллионов человек скачали приложения SimpleX.", + "index-directory-p1": "Более 3 миллионов человек скачали приложения SimpleX.", "index-directory-p2": "Найдите каналы и сообщества в каталоге и создайте свои!", "index-directory-cta": "Открыть каталог SimpleX", "index-directory-users-group-title": "Группа пользователей SimpleX", diff --git a/website/langs/zh_Hans.json b/website/langs/zh_Hans.json index 45cee06f5a..ac7afb074e 100644 --- a/website/langs/zh_Hans.json +++ b/website/langs/zh_Hans.json @@ -296,7 +296,7 @@ "index-roadmap-3-title": "促进社区发展", "index-roadmap-3-desc": "用于推广社区的工具", "index-directory-h2": "加入 SimpleX 社区", - "index-directory-p1": "超过 200 万人下载了 SimpleX 应用。", + "index-directory-p1": "超过 300 万人下载了 SimpleX 应用。", "index-directory-p2": "在目录中找到您的频道和社区，并创建您自己的！", "index-directory-cta": "查看 SimpleX 目录", "index-directory-users-group-title": "SimpleX 用户群组", diff --git a/website/src/crowdfunding.html b/website/src/crowdfunding.html index 3b0b293f02..11d28742b9 100644 --- a/website/src/crowdfunding.html +++ b/website/src/crowdfunding.html @@ -65,7 +65,7 @@ templateEngineOverride: njk --cf-area-off: calc((var(--sec-h) - 100svh) / 2); } - @media screen and (max-width: 959px) and (orientation: portrait) { + @media screen and (max-width: 1015px) and (orientation: portrait) { :root { --cf-grad-light: linear-gradient(30deg, #e8f3ff 0%, #c0e2ff 40%, #e9ffff 80%, #ffefd6 90%); --cf-grad-dark: linear-gradient(30deg, #000000 0%, #131d49 52%, #3f5598 65%, #c3faff 85%, #fff6e0 90%); @@ -379,7 +379,7 @@ templateEngineOverride: njk .cf-pill svg { height: 30px; width: auto; display: block; transform: translateY(-3.5px); } - @media screen and (min-width: 960px), screen and (max-width: 959px) and (orientation: landscape) { + @media screen and (min-width: 1016px), screen and (max-width: 1015px) and (orientation: landscape) { .cf-pill { width: 252px; justify-content: center; } } @@ -389,7 +389,7 @@ templateEngineOverride: njk .cf-cta-link:hover, .cf .text-container a.gradient-text:hover { filter: brightness(1.12); } - @media screen and (min-width: 960px), screen and (max-width: 959px) and (orientation: landscape) { + @media screen and (min-width: 1016px), screen and (max-width: 1015px) and (orientation: landscape) { .cf-network .text-container h2 { max-width: calc(var(--sec-vwu) * 23.5) !important; } .cf-network .text-container p { max-width: calc(var(--sec-vwu) * 31) !important; } .cf-network .text-container a { max-width: calc(var(--sec-vwu) * 31) !important; } @@ -429,7 +429,7 @@ templateEngineOverride: njk #navbar.on-light > a.logo.logo-light { display: flex; } #navbar.on-light > a.logo.logo-dark { display: none; } - @media screen and (min-width: 960px), screen and (max-width: 959px) and (orientation: landscape) { + @media screen and (min-width: 1016px), screen and (max-width: 1015px) and (orientation: landscape) { header#navbar { height: 74px; } header#navbar > a.logo { top: 0; @@ -443,7 +443,7 @@ templateEngineOverride: njk } /* keep the navbar visible on mobile (no slide-in menu here) */ - @media screen and (max-width: 959px) { + @media screen and (max-width: 1015px) { header#navbar { visibility: visible !important; opacity: 1 !important; @@ -451,7 +451,7 @@ templateEngineOverride: njk background: transparent !important; } } - @media screen and (max-width: 959px) and (orientation: portrait) { + @media screen and (max-width: 1015px) and (orientation: portrait) { header#navbar { height: 54px !important; } header#navbar > a.logo { top: 0 !important; height: 100% !important; align-items: center; transform: translateY(var(--cf-nav-shift)); } [dir="ltr"] header#navbar > a.logo { padding-left: var(--cf-text-pad); } @@ -459,7 +459,7 @@ templateEngineOverride: njk } /* ---- mobile: portrait art on top, text at the bottom (home page system) ---- */ - @media screen and (max-width: 959px) and (orientation: portrait) { + @media screen and (max-width: 1015px) and (orientation: portrait) { .cf .text-container h2 { font-size: calc(var(--sec-vwu) * 9.4); } .cf .text-container { margin-left: 0 !important; @@ -751,15 +751,15 @@ templateEngineOverride: njk .cf-tag .n { font-weight: 700; font-size: calc(var(--sec-vwu) * 1.5); line-height: 1.35; } .cf-tag .v { font-weight: 500; font-size: calc(var(--sec-vwu) * 1.2); line-height: 1.45; } .cf-tag .v b { font-weight: 700; } - @media screen and (min-width: 960px), screen and (max-width: 959px) and (orientation: landscape) { + @media screen and (min-width: 1016px), screen and (max-width: 1015px) and (orientation: landscape) { .cf-tags-art, .cf-art { display: none; } } - @media screen and (max-width: 959px) and (orientation: portrait) { + @media screen and (max-width: 1015px) and (orientation: portrait) { .cf-tag .n { font-size: 3.54cqh; line-height: 1.3; } } - @media screen and (max-width: 959px) and (orientation: portrait) and (max-aspect-ratio: 62/100) { + @media screen and (max-width: 1015px) and (orientation: portrait) and (max-aspect-ratio: 62/100) { .cf-hero h1 { font-size: calc(var(--sec-vwu) * 9.6); } :root { --cf-hero-text-b: calc(var(--cf-top-base) + max(0px, calc(-1 * var(--cf-area-off))) + 72.8vw); } } @@ -800,7 +800,7 @@ templateEngineOverride: njk .cf-fine-links a { color: #9fb2d8; text-decoration: none; } .cf-fine-links a:hover { color: #ffffff; } - @media screen and (max-width: 959px) and (orientation: portrait) { + @media screen and (max-width: 1015px) and (orientation: portrait) { /* padding-bottom comes from .safari-ios section.page, which a fit-content footer does not need */ section.page.cf.cf-footer { height: fit-content; min-height: fit-content; padding-bottom: 0; } @@ -935,7 +935,7 @@ templateEngineOverride: njk .cf-modal-panel { padding: 28px 20px; } .cf-form-submit { padding: 0 12px; font-size: 15px; } } - @media screen and (max-width: 959px) and (orientation: landscape) { + @media screen and (max-width: 1015px) and (orientation: landscape) { :root { --cover-bg-w: calc(min((3200 / 1920) * 100vw, (3200 / 1080) * 100svh)); --cover-bg-h: calc(min((1800 / 1920) * 100vw, (1800 / 1080) * 100svh)); @@ -1322,7 +1322,7 @@ templateEngineOverride: njk var hero = block.closest('section'); var leadShort = document.querySelector('.cf-hero .lead-short'); var logos = document.querySelectorAll('#navbar .logo img'); - var narrow = window.matchMedia('(max-width: 959px) and (orientation: portrait)'); + var narrow = window.matchMedia('(max-width: 1015px) and (orientation: portrait)'); function logoBottom() { var bottom = 0; for (var i = 0; i < logos.length; i++) { var r = logos[i].getBoundingClientRect(); if (r.height > 0) bottom = Math.max(bottom, r.bottom); } diff --git a/website/src/css/design3-nav.css b/website/src/css/design3-nav.css index f6f91a8567..1e3883caaa 100644 --- a/website/src/css/design3-nav.css +++ b/website/src/css/design3-nav.css @@ -10,7 +10,7 @@ body.change-nav-color { --nav-color: #001796; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { .logo { background: rgba(255, 255, 255, 0.05); backdrop-filter: blur(10px); @@ -182,7 +182,7 @@ header#navbar ul a { white-space: nowrap; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { header#navbar ul .nav-link a, header#navbar ul .nav-link-text { font-size: 18px; @@ -258,7 +258,7 @@ header#navbar ul a span svg { fill: #fff; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { header#navbar nav#menu>ul>li>a { color: var(--nav-color); } @@ -366,7 +366,7 @@ header#navbar .nav-link:focus-within .sub-menu { fill: white; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { .flag-container>a { color: var(--nav-color) !important; } @@ -427,7 +427,7 @@ header#navbar button.theme-switch-btn svg path { fill: white; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { header#navbar button.theme-switch-btn svg path { fill: var(--nav-color) !important; transition: all 0.3s ease; @@ -497,7 +497,7 @@ button#cross-btn { height: auto; } -@media (min-width: 960px) { +@media (min-width: 1016px) { @media (max-width: 1050px) { header#navbar nav#menu .nav-link.send-file { display: none; @@ -505,7 +505,7 @@ button#cross-btn { } } -@media (max-width: 959px) { +@media (max-width: 1015px) { #mobile-header { position: fixed; top: 0; diff --git a/website/src/css/design3.css b/website/src/css/design3.css index 4b645804eb..6ebbf92198 100644 --- a/website/src/css/design3.css +++ b/website/src/css/design3.css @@ -171,7 +171,7 @@ #fff6e0 90%); } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { :root { --bg-grad: linear-gradient(30deg, #e8f3ff 0%, @@ -225,7 +225,7 @@ body { background: #0a0f2b; } -@media screen and (min-width: 960px) { +@media screen and (min-width: 1016px) { html { overscroll-behavior: none; } @@ -364,55 +364,104 @@ section.page .area { /* --- COVER --- */ section.cover { + --cover-area-off: calc((var(--sec-h) - 100svh) / 2); + --cover-fade-rgb: 33, 70, 110; background-image: url("/img/design_3/cover-light.webp"); background-size: var(--cover-bg-w) var(--cover-bg-h); - background-position: center; + background-position: calc(50% + var(--sec-vwu) * 8.5) center; background-repeat: no-repeat; + overflow: hidden; z-index: 12; } .dark section.cover { + --cover-fade-rgb: 2, 7, 29; background-image: url("/img/design_3/cover.webp"); } .chrome-ios section.cover, .safari-ios section.cover { - background-position: center calc(50% - calc(110lvh - 100svh) / 2); + --cover-bottom-ext: calc(110lvh - 100svh); + background-position: calc(50% + var(--sec-vwu) * 8.5) calc(50% - calc(110lvh - 100svh) / 2); } .chrome-android section.cover { - background-position: center calc(50% - calc(100lvh - 100svh) / 2); + --cover-bottom-ext: calc(100lvh - 100svh); + background-position: calc(50% + var(--sec-vwu) * 8.5) calc(50% - calc(100lvh - 100svh) / 2); +} + +.cover-art { + position: absolute; + width: var(--sec-w); + height: var(--sec-h); + z-index: 1; + pointer-events: none; +} + +.cover-phone { + position: absolute; + right: calc(var(--sec-vwu) * 4); + bottom: calc(var(--sec-vhu) * -55.56); + height: calc(var(--sec-vhu) * 129.96); + width: auto; +} + +.cover-fade { + position: absolute; + right: calc(var(--sec-vwu) * 4); + width: calc(var(--sec-vhu) * 129.96 * 0.4914); + bottom: var(--cover-area-off); + height: calc(var(--sec-vhu) * 38); + background: linear-gradient(to top, rgb(var(--cover-fade-rgb)) 22%, rgba(var(--cover-fade-rgb), .8) 52%, rgba(var(--cover-fade-rgb), 0) 100%); } section.cover div.content { display: flex; flex-direction: column; justify-content: center; - align-items: center; - text-align: center; + align-items: flex-start; + text-align: start; gap: calc(var(--sec-vhu) * 3.5); width: var(--sec-w); height: var(--sec-h); + padding-left: calc(var(--sec-vwu) * 4); +} + +@media (min-width: 1016px), (max-width: 1015px) and (orientation: landscape) { + [dir="rtl"] section.cover div.content { + padding-left: 0; + padding-right: calc(var(--sec-vwu) * 4); + } + + [dir="rtl"] .cover-phone, + [dir="rtl"] .cover-fade { + left: calc(var(--sec-vwu) * 4); + right: auto; + } + + [dir="rtl"] .cover-stats { + left: 30px; + right: auto; + } } section.cover div.content h1 { font-family: "GT-Walsheim", sans-serif; font-weight: 700; - font-size: calc(var(--sec-vwu) * 11.7); + font-size: calc(var(--sec-vwu) * 10); line-height: 0.9; letter-spacing: -0.025em; color: #ffffff; - text-align: center; } section.cover div.content h1 .small { - font-size: calc(var(--sec-vwu) * 8); + font-size: calc(var(--sec-vwu) * 6.85); line-height: 1; margin-bottom: -10px; } section.cover div.content h1 .medium { - font-size: calc(var(--sec-vwu) * 10); + font-size: calc(var(--sec-vwu) * 8.55); line-height: 1; margin-bottom: -10px; } @@ -431,7 +480,12 @@ section.cover div.content p { font-size: calc(var(--sec-vwu) * 2.14); align-items: center; color: #ffffff; - max-width: calc(var(--sec-vwu) * 53); + max-width: calc(var(--sec-vwu) * 55); + text-wrap: balance; +} + +section.cover div.content p .nowrap { + white-space: nowrap; } section.cover div.content p.invest { @@ -444,39 +498,65 @@ section.cover div.content p.invest a { white-space: nowrap; } -.publications-btns { +html:not(.dark) section.cover div.content p { + font-weight: 300; + max-width: calc(var(--sec-vwu) * 55.2); +} + +html:not(.dark) section.cover div.content p.invest { + font-weight: 400; +} + +html:not(.dark) section.cover div.content p.invest a { + font-weight: 600; +} + +html:not(.dark) section.cover div.content .gradient-text { + background: linear-gradient(90deg, + #ffb55d 0%, + #fff494 50%, + #fbffdd 100%); + -webkit-background-clip: text; + background-clip: text; +} + +.cover-stats { position: absolute; - bottom: 24px; - display: flex; - flex-wrap: wrap; - align-items: center; - justify-content: center; - gap: 12px; -} - -[dir="ltr"] .publications-btns { - left: 30px; -} - -[dir="rtl"] .publications-btns { right: 30px; + bottom: calc(74px + var(--cover-bottom-ext, 0px)); + display: flex; + align-items: center; + gap: 48px; } -.publications-btns img { - width: 32px; +.cover-stat { + display: flex; + align-items: center; + gap: 13px; } -.publications-btns img.kuketz { - width: 38px; +.cover-stat b { + font-family: "Manrope", sans-serif; + font-weight: 700; + font-size: 37px; + line-height: 1.1; + color: #ffffff; } -.publications-btns img.whonix { - width: 30px; +.cover-stat span { + font-family: "Manrope", sans-serif; + font-weight: 400; + font-size: 18px; + color: #ffffff; +} + +.dark .cover-stat span { + color: #dfeaff; } .security-btns { position: absolute; - bottom: 24px; + bottom: calc(24px + var(--cover-bottom-ext, 0px)); display: flex; flex-wrap: wrap; align-items: center; @@ -485,13 +565,11 @@ section.cover div.content p.invest a { } [dir="ltr"] .security-btns { - left: 0; - transform: translateX(calc((100vw / 2) - 50%)); + left: 30px; } [dir="rtl"] .security-btns { - right: 0; - transform: translateX(calc(-1 * ((100vw / 2) - 50%))); + right: 30px; } .security-btns img { @@ -514,26 +592,9 @@ section.cover div.content p.invest a { text-align: right; } -@media screen and (max-width: 1279px) { - .publications-btns { - display: none; - visibility: hidden; - } - - [dir="ltr"] .security-btns { - transform: translateX(0); - left: 16px; - } - - [dir="rtl"] .security-btns { - transform: translateX(0); - right: 16px; - } -} - .socials { position: absolute; - bottom: 22px; + bottom: calc(22px + var(--cover-bottom-ext, 0px)); display: flex; align-items: center; justify-content: center; @@ -541,7 +602,7 @@ section.cover div.content p.invest a { flex-wrap: wrap; } -@media (min-width: 960px) { +@media (min-width: 1016px) { .socials .desktop-app-btn, .socials .apple-store-btn, .socials .google-play-btn { @@ -603,14 +664,7 @@ section.cover div.content p.invest a { gap: 6px; } -@media screen and (max-width: 959px) { - - .publications-btns, - .security-btns, - .socials { - position: static; - } - +@media screen and (max-width: 1015px) and (orientation: portrait) { .socials { min-height: 42px; } @@ -722,7 +776,7 @@ main .section-bg { background-image: url("/img/design_3/section-5-desktop.webp"); } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { .page-2 { background-image: url("/img/design_3/section-2-mobile-light.webp"); background-size: auto calc(var(--cover-bg-h) * 0.84); @@ -967,41 +1021,154 @@ main .section-bg { display: none; } -@media (max-width: 959px) { - section.cover div.content { - gap: calc(var(--sec-vhu) * 2.5); - transform: translateY(calc(var(--sec-vhu) * 3)); +@media (max-width: 1015px) and (orientation: portrait) { + section.cover { + --cover-crest: 10px; + --cover-text-top: calc(var(--cover-crest) + var(--cover-bg-w) * 0.0125); + --cover-text-b: calc(var(--cover-text-top) + var(--cover-bg-w) * 0.19); + --cover-phone-w: 82vw; + --cover-phone-top: calc(var(--cover-text-b) + 16px + var(--cover-area-off)); + --cover-cta-bottom: max(12px, env(safe-area-inset-bottom, 0px)); + --cover-audits-top: calc(100svh - var(--cover-cta-bottom) - 36px); + --cover-socials-top: calc(var(--cover-audits-top) - 66px); + --cover-row-gap: clamp(14px, 4.5vw, 20px); + --cover-row-start: calc(50% - (var(--cover-socials-w, 165px) + var(--cover-row-gap) + var(--cover-stats-w, 141px)) / 2); + --cover-fade-ext: max(0px, calc(110lvh - 100svh)); + --cover-fade-dyn: max(0px, calc(110lvh - 100dvh)); + --cover-fade-base: calc(var(--cover-fade-dyn) + var(--cover-cta-bottom) + 114px); + --cover-fade-ramp: 48px; } - .publications-btns, - .security-btns, - .socials { - margin-top: calc(var(--sec-vhu) * 2); + section.cover, + .chrome-ios section.cover, + .safari-ios section.cover, + .chrome-android section.cover { + background-position: 50% calc(var(--cover-crest) - var(--cover-bg-h) * 0.2678); + } + + .cover-phone { + left: 50%; + right: auto; + transform: translateX(-50%); + top: var(--cover-phone-top); + bottom: auto; + width: var(--cover-phone-w); + height: auto; + } + + .cover-fade { + left: 50%; + right: auto; + transform: translateX(-50%); + width: 100vw; + bottom: calc(var(--cover-area-off) - var(--cover-fade-ext)); + height: calc(var(--cover-fade-base) + var(--cover-fade-ramp)); + background: linear-gradient(to top, rgba(var(--cover-fade-rgb), .9) var(--cover-fade-base), rgba(var(--cover-fade-rgb), 0) 100%); + } + + [dir="ltr"] .socials { + top: var(--cover-socials-top); + bottom: auto; + left: var(--cover-row-start); + right: auto; + } + + [dir="rtl"] .socials { + top: var(--cover-socials-top); + bottom: auto; + left: auto; + right: var(--cover-row-start); + } + + [dir="ltr"] .cover-stats { + top: var(--cover-socials-top); + bottom: auto; + left: calc(var(--cover-row-start) + var(--cover-socials-w, 165px) + var(--cover-row-gap)); + right: auto; + } + + [dir="rtl"] .cover-stats { + top: var(--cover-socials-top); + bottom: auto; + left: auto; + right: calc(var(--cover-row-start) + var(--cover-socials-w, 165px) + var(--cover-row-gap)); + } + + [dir="ltr"] .security-btns, + [dir="rtl"] .security-btns { + top: var(--cover-audits-top); + bottom: auto; + left: 0; + right: 0; + } +} + +@media (max-width: 1015px) and (orientation: landscape) { + section.cover { + --cover-bg-w: calc(min((3200 / 1920) * 100vw, (3200 / 1080) * 100svh)); + --cover-bg-h: calc(min((1800 / 1920) * 100vw, (1800 / 1080) * 100svh)); + --sec-w: calc(min(100vw, (1920 / 1080) * 100svh)); + --sec-h: calc(min((1080 / 1920) * 100vw, 100svh)); + --sec-vwu: calc(var(--sec-w) / 100); + --sec-vhu: calc(var(--sec-h) / 100); + } +} + +@media (max-width: 1015px) and (orientation: landscape) and (max-height: 500px) { + section.cover div.content h1 br { + display: none; + } + + .cover-stats { + gap: 24px; + } + + .cover-stat { + gap: 8px; + } + + .cover-stat b { + font-size: 24px; + } + + .cover-stat span { + font-size: 13px; + } +} + +@media (max-width: 1015px) and (orientation: portrait) { + section.cover div.content { + justify-content: flex-start; + align-items: center; + text-align: center; + gap: calc(var(--sec-vwu) * 3); + margin-top: min(0px, calc(var(--cover-text-top) + var(--cover-area-off))); + padding: max(0px, calc(var(--cover-text-top) + var(--cover-area-off))) 21.6px 0; } section.cover div.content h1 { line-height: 0.85; font-weight: 700; - font-size: calc(var(--sec-vwu) * 30); + font-size: calc(var(--sec-vwu) * 24.75); } section.cover div.content h1 .small { - font-size: calc(var(--sec-vwu) * 16); + font-size: calc(var(--sec-vwu) * 13.2); } section.cover div.content h1 .medium { - font-size: calc(var(--sec-vwu) * 24); + font-size: calc(var(--sec-vwu) * 19.8); } section.cover div.content h2 { font-weight: 500; - font-size: calc(var(--sec-vwu) * 12.85); + font-size: calc(var(--sec-vwu) * 10.6); } section.cover div.content p { font-weight: 400; - font-size: calc(var(--sec-vwu) * 5.5); - max-width: calc(var(--sec-vwu) * 93); + font-size: calc(var(--sec-vwu) * 4.1); + max-width: none; } section.cover div.content p.invest { @@ -1012,6 +1179,40 @@ main .section-bg { font-weight: 600; } + html:not(.dark) section.cover div.content p, + html:not(.dark) section.cover div.content p.invest { + font-weight: 500; + max-width: none; + } + + html:not(.dark) section.cover div.content p.invest a { + font-weight: 700; + } + + .cover-stats { + height: 42px; + gap: clamp(12px, 4vw, 16px); + } + + .cover-stat { + display: block; + text-align: start; + } + + .cover-stat b { + display: block; + font-size: clamp(19px, 5.6vw, 22px); + line-height: 1.05; + } + + .cover-stat span { + display: block; + font-size: clamp(10px, 2.8vw, 11px); + line-height: 1.25; + } +} + +@media (max-width: 1015px) { /* --- MAIN SECTIONS --- */ .page .text-container { justify-content: flex-end; @@ -1108,7 +1309,7 @@ main .section-bg { border-radius: calc(var(--sec-vhu) * 1.8); } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { .page-6 .group-images { width: 100%; height: 10%; @@ -1321,7 +1522,7 @@ main .section-bg { margin: calc(var(--sec-vhu) * 2); } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { .page-6 .group-images>a.group-image:nth-child(1) { --c: 3; --r: 1; @@ -1525,7 +1726,7 @@ section.page.footer { min-height: fit-content; } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { section.page.footer { height: 100lvh; min-height: 100lvh; @@ -1560,7 +1761,7 @@ section.page.footer { } } -@media (min-width: 960px) { +@media (min-width: 1016px) { .footer .container-md, .footer .container-sm, diff --git a/website/src/css/livestream.css b/website/src/css/livestream.css index 831f4a0569..bb8ab8d373 100644 --- a/website/src/css/livestream.css +++ b/website/src/css/livestream.css @@ -126,7 +126,7 @@ main .section-bg { color: #000000; } -@media screen and (max-width: 959px) { +@media screen and (max-width: 1015px) { .livestream { background-image: url("/img/design_3/section-4-mobile-light.webp"); background-size: auto calc(var(--cover-bg-h) * 0.78); diff --git a/website/src/fdroid.html b/website/src/fdroid.html index 67e4821e20..c3441d9680 100644 --- a/website/src/fdroid.html +++ b/website/src/fdroid.html @@ -38,6 +38,11 @@ templateEngineOverride: njk 9F 35 8F F2 84 D1 F7 16 56 A2 BF AF 0E 00 5D EA E6 AA 14 14 37 20 E0 89 F1 1F F2 DD CF EB 01 BA

+

+ {{ "f-droid-page-apk-text" | i18n({}, lang ) | safe }} + aarch64, + armv7 +