-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Show the new Stats Today card on the My Site dashboard #25917
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
crazytonyli
wants to merge
2
commits into
trunk
Choose a base branch
from
task/cmm-2317-my-site-new-stats-today-card
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
Modules/Sources/JetpackStats/Cards/StatsTodayCardController.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import SwiftUI | ||
|
|
||
| /// Public, controller-driven entry point for embedding the Stats "Today" card | ||
| /// outside the Stats screen (currently the My Site dashboard). | ||
| /// | ||
| /// The internal `TodayCard`/`TodayCardViewModel` load only on first appearance | ||
| /// and expose no reload path, so an embedder that keeps a card on screen across | ||
| /// appearances needs an explicit lifecycle contract. This controller owns the | ||
| /// view model and forwards the reload/cancel decisions to it, keeping the | ||
| /// module's internals private. | ||
| @MainActor | ||
| public final class StatsTodayCardController: ObservableObject { | ||
| let context: StatsContext | ||
| let viewModel: TodayCardViewModel | ||
|
|
||
| /// Called on the main actor when a load fails. The embedder uses this to log | ||
| /// the degraded state, since the dashboard installs no analytics tracker on | ||
| /// its `StatsContext` (so the module's own `trackError` is intentionally | ||
| /// silent there). | ||
| public var onLoadError: ((any Error) -> Void)? { | ||
| didSet { viewModel.onLoadFailure = onLoadError } | ||
| } | ||
|
|
||
| public init(context: StatsContext) { | ||
| self.context = context | ||
|
|
||
| let configuration = TodayCardConfiguration( | ||
| supportedMetrics: Set(context.service.supportedMetrics) | ||
| ) | ||
| self.viewModel = TodayCardViewModel( | ||
| configuration: configuration, | ||
| dateRange: context.calendar.makeDateRange(for: .today), | ||
| context: context | ||
| ) | ||
| } | ||
|
|
||
| /// Reloads the current period only when the loaded data can no longer be | ||
| /// trusted (retry after failure, midnight rollover, or TTL staleness). | ||
| /// Otherwise a no-op, preserving the service cache. | ||
| public func refreshIfNeeded() { | ||
| viewModel.refreshIfNeeded() | ||
| } | ||
|
|
||
| /// Cancels any in-flight load, so a stale response cannot land after the | ||
| /// controller is torn down (for example on a site switch). | ||
| public func cancel() { | ||
| viewModel.cancelLoading() | ||
| } | ||
| } | ||
|
|
||
| /// Renders the internal Stats "Today" card for an embedder, so the visual result | ||
| /// is identical to the Stats screen's card. | ||
| public struct StatsTodayCardView<MenuContent: View>: View { | ||
| @ObservedObject private var controller: StatsTodayCardController | ||
| private let menuContent: (() -> MenuContent)? | ||
|
|
||
| /// Renders the card with caller-supplied more-menu items. The card still | ||
| /// draws the ellipsis button itself, so only the items differ. | ||
| public init(controller: StatsTodayCardController, @ViewBuilder menuContent: @escaping () -> MenuContent) { | ||
| self.controller = controller | ||
| self.menuContent = menuContent | ||
| } | ||
|
|
||
| public var body: some View { | ||
| Group { | ||
| if let menuContent { | ||
| TodayCard(viewModel: controller.viewModel, menuContent: menuContent) | ||
| } else { | ||
| TodayCard(viewModel: controller.viewModel) | ||
| } | ||
| } | ||
| .environment(\.context, controller.context) | ||
| } | ||
| } | ||
|
|
||
| extension StatsTodayCardView where MenuContent == EmptyView { | ||
| /// Uses the card's built-in more-menu (the Stats screen's behavior). | ||
| public init(controller: StatsTodayCardController) { | ||
| self.controller = controller | ||
| self.menuContent = nil | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cancel()stops the load but leaves the card marked as still loading, so it can never refresh again. Harmless today (the card is thrown away right aftercancel()), but this one line removes the trap in case the card is ever reused instead of rebuilt.