You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
new feature flag: :consolidated_view - we no longer display anything based on super_admin role; flag is not setup on production yet, meaning existing consolidated views will disappear (and no CTAs will be shown).
new billing feature: ConsolidatedView
all existing plans are updated, so that business tier includes the newly added features - either through static definitions or database migration
whenever /sites is visited an attempt is made to create consolidated view. If the team is eligible, and the feature flag is raised, the consolidated view card is shown. Otherwise a CTA card is displayed (courtesy of @sanne-san)
CTA card has several variants, depending on the context, but eventually leads to upgrade. Once the upgrade is performed, /sites will include the consolidated view card.
CTA card can be permanently dismissed per user and team; because local storage and cookies turned out to be very difficult to work with in this setup, the decision was made to introduce a new postgres table capable of storing user preferences in a team context (it's almost a 1:1 copy of the existing site user preferences table)
When CTA is dismissed, the "New Site" button becomes a prima drop-down (courtesy of @ukutaht) from which the user may restore it (by selecting "+ New consolidated view" dropdown item)
CRM now presents a more elaborate alert on deleting consolidated view, as well as the availability status (whether upgrade is required)
some minor improvements BTW:
shared links enforce regular sites,
accessing a consolidated view via pre-existing URL, while ineligible, redirects to /sites
at least 2 sites are now required to create (or even suggest) a consolidated view
ConsolidatedView.enabled?/1 has been removed, since enabling doesn't mean availability
TODO:
staging preview is currently unavailable due to pending migrations
there are visual issues with card plots and overlapping dropdowns
Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance.
Status: No audit logs: New user-triggered events to dismiss/restore the consolidated view CTA are handled without any audit logging of actor, team, action, or outcome.
Generic: Robust Error Handling and Edge Case Management
Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation
Status: Missing fallback: Preference getters/setters and consolidated view enablement rely on external calls and flags without explicit error handling or fallback behavior beyond returning errors, which may leave UI in inconsistent state if dependencies fail.
Generic: Security-First Input Validation and Data Handling
Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities
Status: Preference upsert: The upsert for team membership user preferences writes user-controlled state without explicit authorization checks in this diff, requiring verification that callers enforce membership/permission validation.
Refactor the consolidated view creation to be an explicit user action (e.g., a button click) instead of an implicit action on every /sites page load. This separates creation from display logic, improving performance and simplifying the code.
# in lib/plausible_web/live/sites.exdefmount(...,socket):
# ...
assigns =init_consolidated_view_assigns(user,team)# ...defpinit_consolidated_view_assigns(user,team):
# This is called on every page loadcaseConsolidatedView.enable(team)do{:ok,view}-># If successful, show the consolidated view card%{consolidated_view: view, ...}{:error,reason}-># If not, show a CTA card with the reason%{no_consolidated_view_reason: reason, ...}end
After:
# in lib/plausible_web/live/sites.exdefmount(...,socket):
# ...
assigns =init_consolidated_view_assigns(user,team)# ...defpinit_consolidated_view_assigns(user,team):
# On page load, only check for eligibility, don't createifConsolidatedView.get(team)do# Show existing viewelseifConsolidatedView.is_eligible_for_creation?(team)do# Show CTA with a "Create View" buttonelse# Show CTA with "Upgrade" buttonenddefhandle_event("create-consolidated-view",_,socket):
# Create the view only on explicit user action
ConsolidatedView.enable(socket.assigns.current_team)# ... update socket
Suggestion importance[1-10]: 9
__
Why: This is an excellent architectural suggestion that correctly identifies a major design issue: performing a potential write operation (ConsolidatedView.enable) on every page load (mount). Adopting this change would improve performance, adhere to RESTful principles (separating GET from state-changing actions), and significantly simplify the logic in lib/plausible_web/live/sites.ex.
High
Possible issue
Avoid potential crashes from pattern matching
Refactor cta_dismissed?/2, dismiss_cta/2, and restore_cta/2 to use a with statement to safely handle potential errors from get_team_membership and avoid MatchError exceptions.
@spec cta_dismissed?(User.t(), Team.t()) :: boolean()
def cta_dismissed?(%User{} = user, %Team{} = team) do
- {:ok, team_membership} = Teams.Memberships.get_team_membership(team, user)- Teams.Memberships.get_preference(team_membership, :consolidated_view_cta_dismissed)+ with {:ok, team_membership} <- Teams.Memberships.get_team_membership(team, user) do+ Teams.Memberships.get_preference(team_membership, :consolidated_view_cta_dismissed)+ else+ _ -> false+ end
end
@spec dismiss_cta(User.t(), Team.t()) :: :ok
def dismiss_cta(%User{} = user, %Team{} = team) do
- {:ok, team_membership} = Teams.Memberships.get_team_membership(team, user)- Teams.Memberships.set_preference(team_membership, :consolidated_view_cta_dismissed, true)+ with {:ok, team_membership} <- Teams.Memberships.get_team_membership(team, user) do+ Teams.Memberships.set_preference(team_membership, :consolidated_view_cta_dismissed, true)+ end
:ok
end
@spec restore_cta(User.t(), Team.t()) :: :ok
def restore_cta(%User{} = user, %Team{} = team) do
- {:ok, team_membership} = Teams.Memberships.get_team_membership(team, user)-- Teams.Memberships.set_preference(- team_membership,- :consolidated_view_cta_dismissed,- false- )+ with {:ok, team_membership} <- Teams.Memberships.get_team_membership(team, user) do+ Teams.Memberships.set_preference(+ team_membership,+ :consolidated_view_cta_dismissed,+ false+ )+ end
:ok
end
Apply / Chat
Suggestion importance[1-10]: 8
__
Why: The suggestion correctly identifies that pattern matching on the result of Teams.Memberships.get_team_membership/2 can cause a MatchError, and proposes a robust solution using a with statement to prevent a potential crash.
Medium
General
Inform user about redirection reason
Add a flash message before redirecting a user who has lost access to a consolidated view to inform them of the reason for the redirection.
cond do
consolidated_view? and not consolidated_view_available? and site_role != :super_admin ->
- redirect(conn, to: Routes.site_path(conn, :index))+ conn+ |> put_flash(:error, "You no longer have access to this consolidated view. Please upgrade your plan to restore access.")+ |> redirect(to: Routes.site_path(conn, :index))
(stats_start_date && can_see_stats?) || (can_see_stats? && skip_to_dashboard?) ->
Apply / Chat
Suggestion importance[1-10]: 4
__
Why: This suggestion improves user experience by adding a flash message to explain a redirect, which is helpful but not a critical bug fix.
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.
User description
Benchmark PR plausible#5866
Type: Clean (correct implementation)
Original PR Title: Consolidated View life cycle + billing integration
Original PR Description: ### Changes
This PR integrates consolidated view life cycle with billing properties.
It relies on two migrations (
included here still), extracted to separate PRs:Main changes:
:consolidated_view- we no longer display anything based onsuper_adminrole; flag is not setup on production yet, meaning existing consolidated views will disappear (and no CTAs will be shown).ConsolidatedView/sitesis visited an attempt is made to create consolidated view. If the team is eligible, and the feature flag is raised, the consolidated view card is shown. Otherwise a CTA card is displayed (courtesy of @sanne-san)/siteswill include the consolidated view card."+ New consolidated view"dropdown item)/sitesConsolidatedView.enabled?/1has been removed, since enabling doesn't mean availabilityTODO:
there are visual issues with card plots and overlapping dropdownsrecord-2025-11-10-10-29-34-year.node.norm.mp4
the dropdown doesn't respect dark modeTests
Changelog
Documentation
Dark mode
Original PR URL: plausible#5866
PR Type
Enhancement
Description
Refactored consolidated view lifecycle to use feature flags instead of super_admin role
Added user preference storage for CTA dismissal state per team membership
Integrated billing feature availability checks for consolidated view access
Enhanced UI with dropdown menu for site management and dismissible CTA cards
Updated all business plan definitions to include consolidated view feature
Diagram Walkthrough
File Walkthrough
12 files
Refactored view lifecycle with feature flags and billing checksAdded availability status display and enhanced delete confirmationAdded ConsolidatedView as new billing feature moduleAdded preference storage and retrieval for team membershipsNew schema for storing team-specific user preferencesNew dropdown component wrapper with Prima integrationUpdated consolidated view availability checks and shared link handlingRefactored consolidated view initialization with CTA management anddropdown UIAdded ConsolidatedView to API capabilities schemaAdded Dropdown hook from Prima libraryUpdated data attribute name for consolidated view availabilityUpdated template data attribute for consolidated view availability1 files
Updated filter bar styling with improved responsive layout1 files
Updated Prima dependency to version 0.1.85 files
Enabled consolidated_view feature flag in seedsUpdated test setup to enable consolidated_view flagAdded consolidated_view feature to all business plansAdded consolidated_view feature to all business plansAdded consolidated_view feature to all business plans18 files
Added ConsolidatedView to business feature testsAdded Consolidated View to business plan benefitsUpdated tests to require minimum 2 sites for consolidationComprehensive tests for CTA state and availability checksUpdated tests for consolidated view disabling logicUpdated consolidated view stats date reset testsRemoved obsolete test file for old ok_to_display signatureUpdated tests to require minimum 2 sites for consolidationUpdated query parser tests for consolidated site IDsUpdated query tests for consolidated site IDs handlingUpdated site transfer tests for consolidated view logicAdded ConsolidatedView feature to enterprise plan test setupUpdated consolidated view settings tests with site requirementsUpdated stats controller tests for availability checksUpdated customer support team tests for consolidated viewsUpdated goal form tests for consolidated view requirementsComprehensive tests for CTA display, dismissal, and restorationAdded ConsolidatedView to capabilities API tests