Allow creating and editing limited views #5925

apata · 2025-12-02T09:43:09Z

Changes

Merge shared_links schema change Add :segment_id field to shared_links schema #5924 and migrate
Allow creating and editing limited views
Indicate limited view on shared link dashboard
Ensure queries are made with the limited view

TODO

Fix regression from unexpected horizontal overflow of table cells

Tests

Automated tests have been added

Changelog

Entry has been added to changelog

Documentation

Document behavior of limited view docs#655

Dark mode

The UI has been tested both in dark and light mode

github-actions · 2025-12-02T09:43:51Z

Preview environment👷🏼‍♀️🏗️
PR-5925

- Update password UI to use a toogle switch to emphasize the optional nature of the feature - Add UI for limiting the link to a segment - Add toggle_field component for full-width label and toggle switch layout - Add optional link to the input component, showing below the input, which can be used for documentation links - Add eye icon to shared links list that indicates limited view - Add tooltips to icons in the shared links list

sanne-san

🎉

aerosol · 2025-12-12T07:09:45Z

There's some conflicts that need to be resolved

aerosol

Comments inline

aerosol · 2025-12-17T08:03:47Z

lib/plausible/segments/segments.ex

+    type = :site
+    fields = [:id, :name]
+
+    name_empty? = is_nil(name) or (is_binary(name) and String.trim(name) == "")


When do we expect this to be nil? How about call it input - following the call site - or even user_inputand assume binary in the function clause?

aerosol · 2025-12-17T08:27:00Z

lib/plausible/segments/segments.ex

+              fragment(
+                "CASE
+                  WHEN lower(?) = lower(?) THEN 0                    -- exact match
+                  WHEN lower(?) LIKE lower(?) || '%' THEN 1          -- starts with


This is nice but a bit of an overkill, since there's only 4 customers with more than 20 site segments. I'd consider simplifying that query and using Enum.sort_by/3 combined with String.jaro_distance/2 to achieve similar effectiveness and arguably simpler code. Ignore if you wish.

Thanks for looking those stats up! It is indeed overkill then for this particular combobox. I liked how it came out though. I suggest we keep it and introduce it to other comboboxes as well. Server side sorting means we should query for bigger pages - it'd be good to be able to avoid it.

aerosol · 2025-12-17T08:31:56Z

lib/plausible_web/controllers/api/internal/segments_controller.ex

+    end
+  end
+
+  def get_related_shared_links(%Plug.Conn{} = conn, _params), do: invalid_request(conn)


Isn't that redundant? If no controller clause matched, phoenix should respond with a bad request, no?

Checking, thought it responds with internal server error.

Checked just now. If the endpoint handler doesn't have any matching function clauses, it returns an internal server error. These fallbacks (all of the segments endpoints have them) haven't been triggered lately, maybe never (checked some traces). Looks like our authorization plugs are pretty robust. Nothing in the FE depends on 400 over 500, so I could remove these clauses. It's just that all of these endpoints will be superfluous after LV dashboard anyway, so I don't see the point in perfecting them.

aerosol · 2025-12-17T08:34:16Z

lib/plausible_web/controllers/api/stats_controller.ex

+    if conn.assigns.shared_link && conn.assigns.shared_link.segment_id do
+      segment_id = conn.assigns.shared_link.segment_id


Could match in the function clause instead. I feel the plug name could be better here, since it's more specific to segments than filters?

Roger that on the match! Regarding the name, I specifically wanted it to be more general, so readers wouldn't need to be aware of the details of segments and limited views, just that some filters may be required.

Refactored with function clauses, kept the name: 88a80a1

aerosol · 2025-12-17T08:36:55Z

lib/plausible_web/controllers/api/stats_controller.ex

+  end
+
+  defp ensure_expected_segment_filter_present(
+         %{"filters" => filters} = _params,


will users ever run into an error like that? Unclear why do we need to enforce a filter to be "first".

Good question! They won't if they play by the rules. If they try to request stats with the wrong filters though, they'll get a bad request error. The alternative to having it first is allow it to be anywhere, which we wouldn't be able to match on. Limited view FE forces it to be first, so I thought we might as well make use of that. Will add a test for this error.

Matching on raw filters params before they go through Query parsing, as I do here, is not ideal though. If I were to match on filters after Query.from, I'd have to add this little function to every internal stats endpoint, so I went this way.

Added test: 88a80a1

aerosol · 2025-12-17T08:53:39Z

lib/plausible_web/controllers/stats_controller.ex

        current_user = conn.assigns[:current_user]
        site_role = get_fallback_site_role(conn)
-        shared_link = Plausible.Repo.preload(shared_link, site: :owners)
+        shared_link = Plausible.Repo.preload(shared_link, site: [:owners], segment: [])


The intention behind preloading an empty list is unclear here. Don't understand what's going on. Did you mean :segment? Oh and you've got Repo aliased here.

Thanks! The intent is to preload both owners and segment relation, and that's the syntax I got from Ecto docs. It works, but I'll check whether it can be simpler.

It can be simpler, just that the keyword list within a keyword list needs to be last elem: ea458fa

aerosol · 2025-12-17T08:59:05Z

lib/plausible_web/live/shared_link_settings/form.ex

+      >
+        <PlausibleWeb.Components.Generic.toggle_field
+          id="limit-view"
+          id_suffix=""


That's the default, no?

aerosol · 2025-12-17T08:59:20Z

lib/plausible_web/live/shared_link_settings/form.ex

+      >
+        <PlausibleWeb.Components.Generic.toggle_field
+          id="password-protect"
+          id_suffix=""


ditto, default, can we omit?

aerosol · 2025-12-17T09:00:10Z

lib/plausible_web/components/generic.ex

+  attr(:rest, :global)
+
+  def toggle_field(assigns) do
+    help_text_conditional = assigns[:help_text_conditional] || false


why do we need this if attr macro defines a default?

Wondering if we could simplify this. As a component user I'd have very hard time figuring out what do I need to pass to help_text_conditional, what does it do even, not to mention js_active_var. Not a fan of this interface.

Agreed that the interface was a bit clunky and mysterious. How's this? 84e6a07

aerosol · 2025-12-17T09:06:09Z

lib/plausible_web/templates/stats/stats.html.heex

    data-is-consolidated-view={Jason.encode!(@consolidated_view?)}
    data-consolidated-view-available={Jason.encode!(@consolidated_view_available?)}
    data-team-identifier={@team_identifier}
+    data-limited-to-segment-id={Jason.encode!(@limited_to_segment_id)}


Will injecting some random integer here make react request someone else's segment?

Good question, the answer is no.

There's actually no GET /segments/:id or GET /segments endpoints for the FE to call.

There used to be at one point, but there aren't any more.

The way it works now is: We stuff all the site's segments into data-segments, parse it in React, and update that FE segments list whenever the user changes or deletes one. Or the list gets updated whenever the dashboard is refreshed. It's not a great system, but does the job. LV dashboard should allow us to make it right.

If this data-limited-to-segment-id is set, it's the ID of the single segment stuffed into data-segments. If there's no such segment in data-segments, it's treated as if it was null. Because it was a shared link and the stats BE still expects segment filter to be present, all the reports get errors, which visually looks like the endless loader.

aerosol

Need someone else to look at react stuff, elixir stuff is mostly nitpicking at this point and my browser crashes trying to render the diff so not worth it

ukutaht

Looks good

ukutaht · 2025-12-22T12:54:28Z

lib/plausible_web/live/components/form.ex

        <option :if={@prompt} value="">{@prompt}</option>
        {Phoenix.HTML.Form.options_for_select(@options, @value)}
      </select>
+      <div :if={@link != [] && Enum.empty?(@errors)} class="mt-1">


Where is this used?

Good catch! It's not at the moment, but it used to be needed to link to segments doc from create shared link. Not sure why I removed it. Will add it back in

Add :limited_to_segment_id field to shared_links schema

7f161e1

apata added the preview label Dec 2, 2025

apata and others added 4 commits December 2, 2025 19:17

Refactor column name, add FK, index, and on delete cascade

924e77e

Format

0fb3035

Allow creating and editing shared links with limited views

4a027b8

apata force-pushed the limited-view/base-ui branch from 9383307 to 4a027b8 Compare December 3, 2025 09:31

apata added 3 commits December 3, 2025 13:34

Clarify search function arg names

1adcfd6

Unify function to set segment filter

32652d5

Enforce limited view segment on dashboard

befc3b7

apata force-pushed the limited-view/base-ui branch from 5ac232a to befc3b7 Compare December 3, 2025 12:04

apata added 17 commits December 3, 2025 14:07

Clarify type

d2e406b

WIP

973dd76

Merge remote-tracking branch 'origin/master' into limited-view/base-ui

426a571

Disable clear filter button for limited view segment

cb66768

Load related shared links WIP

5ec4cac

Add warning about shared links WIP

8ba440c

Merge

2bb3dea

Finalize delete modal

2f36339

Unify shared link password protection checks

889476d

WIP

aa55aaf

Give random name for shared links in tests

c9cfd00

Add tests for related shared links endpoint

e2a8144

Split components and remove nesting

21591f4

Change limited view copy

b537bb2

Fix search ranking, make segment search input DRYer, add search test

283b6b6

Fix url search params test

219d8f6

Update changelog

aee220e

apata marked this pull request as ready for review December 9, 2025 09:46

apata changed the title ~~Allow creating and editing limited views (WIP)~~ Allow creating and editing limited views Dec 9, 2025

apata requested a review from a team December 9, 2025 09:49

Fix invalid accessor

2f68df8

sanne-san approved these changes Dec 11, 2025

View reviewed changes

apata added 3 commits December 15, 2025 12:15

Merge

d1d751c

Format

ad25e4a

Merge and update tests

6475493

aerosol reviewed Dec 17, 2025

View reviewed changes

apata added 8 commits December 18, 2025 00:00

Merge remote-tracking branch 'origin/master' into limited-view/base-ui

b3e5c05

Add test for stuffing limited view segment

a8ff7f6

Simplify preload syntax

ea458fa

Add tests for validating internal stats API requests

88a80a1

Remove id_suffix default values

288ca80

Implement limited_to_segment?/1

78601ce

Refactor search_by_name

8c32794

Clarify toggle components

84e6a07

apata requested a review from aerosol December 22, 2025 09:01

aerosol approved these changes Dec 22, 2025

View reviewed changes

ukutaht approved these changes Dec 22, 2025

View reviewed changes

ukutaht reviewed Dec 22, 2025

View reviewed changes

Add tests for Shared Link form, remove unused slot

85b587f

apata added this pull request to the merge queue Dec 23, 2025

Merged via the queue into master with commit f2766e0 Dec 23, 2025
15 checks passed

		if conn.assigns.shared_link && conn.assigns.shared_link.segment_id do
		segment_id = conn.assigns.shared_link.segment_id

Uh oh!

Allow creating and editing limited views #5925

Allow creating and editing limited views #5925

Conversation

apata commented Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

TODO

Tests

Changelog

Documentation

Dark mode

Uh oh!

github-actions bot commented Dec 2, 2025

Uh oh!

sanne-san left a comment

Choose a reason for hiding this comment

Uh oh!

aerosol commented Dec 12, 2025

Uh oh!

aerosol left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apata Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apata Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aerosol left a comment

Choose a reason for hiding this comment

Uh oh!

ukutaht left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

apata commented Dec 2, 2025 •

edited

Loading

apata Dec 18, 2025 •

edited

Loading

apata Dec 18, 2025 •

edited

Loading