Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Resolve segment owner names and dates in site timezone in the BE (#5119)

Artur Pata5ae2fd89f077
diff --git a/assets/js/dashboard/filtering/segments.ts b/assets/js/dashboard/filtering/segments.ts
index f480cbbd83..4760e11fcb 100644
--- a/assets/js/dashboard/filtering/segments.ts
+++ b/assets/js/dashboard/filtering/segments.ts
@@ -10,14 +10,31 @@ export enum SegmentType {
site = 'site'
}
+/** This type signifies that the owner can't be shown. */
+type SegmentOwnershipHidden = { owner_id: null; owner_name: null }
+
+/** This type signifies that the original owner has been removed from the site. */
+type SegmentOwnershipDangling = { owner_id: null; owner_name: null }
+
+type SegmentOwnership =
+ | SegmentOwnershipDangling
+ | { owner_id: number; owner_name: string }
+
export type SavedSegment = {
id: number
name: string
type: SegmentType
- owner_id: number
+ /** datetime in site timezone, example 2025-02-26 10:00:00 */
inserted_at: string
+ /** datetime in site timezone, example 2025-02-26 10:00:00 */
updated_at: string
-}
+} & SegmentOwnership
+
+export type SavedSegmentPublic = Pick<
+ SavedSegment,
+ 'id' | 'type' | 'name' | 'inserted_at' | 'updated_at'
+> &
+ SegmentOwnershipHidden
export type SegmentDataFromApi = {
filters: unknown[]
@@ -101,3 +118,8 @@ export function getSearchToApplySingleSegmentFilter(
}
}
}
+
+export const SEGMENT_TYPE_LABELS = {
+ [SegmentType.personal]: 'Personal segment',
+ [SegmentType.site]: 'Site segment'
+}
diff --git a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx b/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
index 6293ebde53..f5a9693c6a 100644
--- a/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
+++ b/assets/js/dashboard/nav-menu/segments/searchable-segments-section.tsx
@@ -8,11 +8,18 @@ import {
getFilterSegmentsByNameInsensitive,
handleSegmentResponse,
isSegmentFilter,
+ SavedSegmentPublic,
SavedSegment,
SegmentData,
- SegmentDataFromApi
+ SegmentDataFromApi,
+ SEGMENT_TYPE_LABELS
} from '../../filtering/segments'
-import { QueryFunction, useQuery, useQueryClient } from '@tanstack/react-query'
+import {
+ QueryFunction,
+ useQuery,
+ useQueryClient,
+ UseQueryResult
+} from '@tanstack/react-query'
import { cleanLabels } from '../../util/filters'
import classNames from 'classnames'
import { Tooltip } from '../../util/tooltip'
@@ -24,14 +31,19 @@ import { AppNavigationLink } from '../../navigation/use-app-navigate'
import { MenuSeparator } from '../nav-menu-components'
import { ErrorPanel } from '../../components/error-panel'
import { get } from '../../api'
+import { Role, useUserContext } from '../../user-context'
-const useSegmentsListQuery = () => {
+function useSegmentsListQuery(
+ _isPublicRequest: boolean
+): typeof _isPublicRequest extends true
+ ? UseQueryResult<SavedSegmentPublic[]>
+ : UseQueryResult<SavedSegment[]> {
const site = useSiteContext()
return useQuery({
queryKey: ['segments'],
placeholderData: (previousData) => previousData,
queryFn: async () => {
- const response: SavedSegment[] = await get(
+ const response = await get(
`/api/${encodeURIComponent(site.domain)}/segments`
)
return response
@@ -56,8 +68,11 @@ export const SearchableSegmentsSection = ({
const { query, expandedSegment } = useQueryContext()
const segmentFilter = query.filters.find(isSegmentFilter)
const appliedSegmentIds = (segmentFilter ? segmentFilter[2] : []) as number[]
+ const user = useUserContext()
+
+ const isPublicListQuery = !user.loggedIn || user.role === Role.public
+ const { data, ...listQuery } = useSegmentsListQuery(isPublicListQuery)
- const { data, ...listQuery } = useSegmentsListQuery()
const [searchValue, setSearch] = useState<string>()
const [showAll, setShowAll] = useState(false)
@@ -97,29 +112,35 @@ export const SearchableSegmentsSection = ({
)}
</div>
- {showableSlice!.map((s) => {
+ {showableSlice!.map((segment) => {
return (
<Tooltip
className="group"
- key={s.id}
+ key={segment.id}
info={
<div className="max-w-60">
- <div className="break-all">{s.name}</div>
+ <div className="break-all">{segment.name}</div>
<div className="font-normal text-xs">
- {
- {
- personal: 'Personal segment',
- site: 'Site segment'
- }[s.type]
- }
+ {SEGMENT_TYPE_LABELS[segment.type]}
</div>
- <SegmentAuthorship {...s} className="font-normal text-xs" />
+ <SegmentAuthorship
+ className="font-normal text-xs"
+ {...(isPublicListQuery
+ ? {
+ showOnlyPublicData: true,
+ segment: segment as SavedSegmentPublic
+ }
+ : {
+ showOnlyPublicData: false,
+ segment: segment as SavedSegment
+ })}
+ />
</div>
}
>
<SegmentLink
- {...s}
+ {...segment}
appliedSegmentIds={appliedSegmentIds}
closeList={closeList}
/>
@@ -229,7 +250,10 @@ const SegmentLink = ({
name,
appliedSegmentIds,
closeList
-}: SavedSegment & { appliedSegmentIds: number[]; closeList: () => void }) => {
+}: Pick<SavedSegment, 'id' | 'name'> & {
+ appliedSegmentIds: number[]
+ closeList: () => void
+}) => {
const { query } = useQueryContext()
const { prefetchSegment } = useSegmentPrefetch({ id: String(id) })
diff --git a/assets/js/dashboard/segments/segment-authorship.test.tsx b/assets/js/dashboard/segments/segment-authorship.test.tsx
new file mode 100644
index 0000000000..af7eb65ba0
--- /dev/null
+++ b/assets/js/dashboard/segments/segment-authorship.test.tsx
@@ -0,0 +1,98 @@
+/** @format */
+
+import React from 'react'
+import { render, screen } from '@testing-library/react'
+import { SegmentAuthorship } from './segment-authorship'
+import { SegmentType } from '../filtering/segments'
+
+describe('public (no "by <user>" shown)', () => {
+ const showOnlyPublicData = true
+
+ test('shows only insert date if its the same as updated at', async () => {
+ render(
+ <SegmentAuthorship
+ showOnlyPublicData={showOnlyPublicData}
+ segment={{
+ type: SegmentType.site,
+ name: 'APAC region',
+ id: 100,
+ owner_id: null,
+ owner_name: null,
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-02-01 14:00:00'
+ }}
+ />
+ )
+
+ expect(screen.getByText('Created at 1 Feb')).toBeVisible()
+ expect(screen.queryByText(/Last updated/)).toBeNull()
+ expect(screen.queryByText(/by /)).toBeNull()
+ })
+
+ test('shows both insert date and updated at', async () => {
+ render(
+ <SegmentAuthorship
+ showOnlyPublicData={showOnlyPublicData}
+ segment={{
+ type: SegmentType.site,
+ name: 'APAC region',
+ id: 100,
+ owner_id: null,
+ owner_name: null,
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-02-01 15:00:00'
+ }}
+ />
+ )
+
+ expect(screen.getByText('Created at 1 Feb')).toBeVisible()
+ expect(screen.getByText('Last updated at 1 Feb')).toBeVisible()
+ expect(screen.queryByText(/by /)).toBeNull()
+ })
+})
+
+describe('shown to a site member ("by <user>" shown)', () => {
+ const showOnlyPublicData = false
+
+ test('shows only insert date if its the same as updated at', async () => {
+ render(
+ <SegmentAuthorship
+ showOnlyPublicData={showOnlyPublicData}
+ segment={{
+ type: SegmentType.site,
+ name: 'APAC region',
+ id: 100,
+ owner_id: null,
+ owner_name: null,
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-02-01 14:00:00'
+ }}
+ />
+ )
+
+ expect(screen.getByText('Created at 1 Feb by (Removed User)')).toBeVisible()
+ expect(screen.queryByText(/Last updated/)).toBeNull()
+ })
+
+ test('shows both insert date and updated at', async () => {
+ render(
+ <SegmentAuthorship
+ showOnlyPublicData={showOnlyPublicData}
+ segment={{
+ type: SegmentType.site,
+ name: 'APAC region',
+ id: 100,
+ owner_id: 500,
+ owner_name: 'Jane Smith',
+ inserted_at: '2025-02-01 14:00:00',
+ updated_at: '2025-02-05 15:00:00'
+ }}
+ />
+ )
+
+ expect(screen.getByText('Created at 1 Feb')).toBeVisible()
+ expect(
+ screen.queryByText('Last updated at 5 Feb by Jane Smith')
+ ).toBeVisible()
+ })
+})
diff --git a/assets/js/dashboard/segments/segment-authorship.tsx b/assets/js/dashboard/segments/segment-authorship.tsx
index 7f405c471f..a3a91c0a50 100644
--- a/assets/js/dashboard/segments/segment-authorship.tsx
+++ b/assets/js/dashboard/segments/segment-authorship.tsx
@@ -1,52 +1,36 @@
/** @format */
import React from 'react'
-import { SavedSegment } from '../filtering/segments'
-import { PlausibleSite, useSiteContext } from '../site-context'
-import { dateForSite, formatDayShort } from '../util/date'
+import { SavedSegmentPublic, SavedSegment } from '../filtering/segments'
+import { formatDayShort, parseNaiveDate } from '../util/date'
-const getAuthorLabel = (
- site: Pick<PlausibleSite, 'members'>,
- owner_id: number
-) => {
- if (!site.members) {
- return ''
- }
+type SegmentAuthorshipProps = { className?: string } & (
+ | { showOnlyPublicData: true; segment: SavedSegmentPublic }
+ | { showOnlyPublicData: false; segment: SavedSegment }
+)
- if (!owner_id || !site.members[owner_id]) {
- return '(Removed User)'
- }
-
- // if (owner_id === user.id) {
- // return 'You'
- // }
-
- return site.members[owner_id]
-}
-
-export const SegmentAuthorship = ({
+export function SegmentAuthorship({
className,
- owner_id,
- inserted_at,
- updated_at
-}: Pick<SavedSegment, 'owner_id' | 'inserted_at' | 'updated_at'> & {
- className?: string
-}) => {
- const site = useSiteContext()
-
- const authorLabel = getAuthorLabel(site, owner_id)
-
+ showOnlyPublicData,
+ segment
+}: SegmentAuthorshipProps) {
+ const authorLabel =
+ showOnlyPublicData === true
+ ? null
+ : (segment.owner_name ?? '(Removed User)')
+
+ const { updated_at, inserted_at } = segment
const showUpdatedAt = updated_at !== inserted_at
return (
<div className={className}>
<div>
- {`Created at ${formatDayShort(dateForSite(inserted_at, site))}`}
+ {`Created at ${formatDayShort(parseNaiveDate(inserted_at))}`}
{!showUpdatedAt && !!authorLabel && ` by ${authorLabel}`}
</div>
{showUpdatedAt && (
<div>
- {`Last updated at ${formatDayShort(dateForSite(updated_at, site))}`}
+ {`Last updated at ${formatDayShort(parseNaiveDate(updated_at))}`}
{!!authorLabel && ` by ${authorLabel}`}
</div>
)}
diff --git a/assets/js/dashboard/segments/segment-modals.tsx b/assets/js/dashboard/segments/segment-modals.tsx
index 771f29adaf..bb45ee3076 100644
--- a/assets/js/dashboard/segments/segment-modals.tsx
+++ b/assets/js/dashboard/segments/segment-modals.tsx
@@ -5,6 +5,7 @@ import ModalWithRouting from '../stats/modals/modal'
import {
isSegmentFilter,
SavedSegment,
+ SEGMENT_TYPE_LABELS,
SegmentData,
SegmentType
} from '../filtering/segments'
@@ -162,11 +163,7 @@ export const DeleteSegmentModal = ({
return (
<SegmentActionModal onClose={onClose}>
<FormTitle>
- {
- { personal: 'Delete personal segment', site: 'Delete site segment' }[
- segment.type
- ]
- }
+ Delete {SEGMENT_TYPE_LABELS[segment.type].toLowerCase()}
<span className="break-all">{` "${segment.name}"?`}</span>
</FormTitle>
{!!segment.segment_data && (
@@ -263,13 +260,13 @@ const SegmentTypeSelector = ({
const options = [
{
type: SegmentType.personal,
- name: 'Personal segment',
+ name: SEGMENT_TYPE_LABELS[SegmentType.personal],
description: 'Visible only to you',
disabled: false
},
{
type: SegmentType.site,
- name: 'Site segment',
+ name: SEGMENT_TYPE_LABELS[SegmentType.site],
description: 'Visible to others on the site',
disabled: !userCanSelectSiteSegment || !siteSegmentsAvailable,
disabledReason: !userCanSelectSiteSegment ? (
@@ -453,12 +450,7 @@ export const SegmentModal = ({ id }: { id: SavedSegment['id'] }) => {
<div className="mt-2 text-sm/5">
<Placeholder placeholder={'Segment type'}>
- {data?.segment_data
- ? {
- [SegmentType.personal]: 'Personal segment',
- [SegmentType.site]: 'Site segment'
- }[data.type]
- : false}
+ {data?.segment_data ? SEGMENT_TYPE_LABELS[data.type] : false}
</Placeholder>
</div>
<div className="my-4 border-b border-gray-300" />
@@ -466,7 +458,11 @@ export const SegmentModal = ({ id }: { id: SavedSegment['id'] }) => {
<>
<FiltersInSegment segment_data={data.segment_data} />
- <SegmentAuthorship {...data} className="mt-4 text-sm" />
+ <SegmentAuthorship
+ segment={data}
+ showOnlyPublicData={false}
+ className="mt-4 text-sm"
+ />
<div className="mt-4">
<ButtonsRow>
<AppNavigationLink
diff --git a/assets/js/dashboard/site-context.test.tsx b/assets/js/dashboard/site-context.test.tsx
index 1ad2701104..b089b8831f 100644
--- a/assets/js/dashboard/site-context.test.tsx
+++ b/assets/js/dashboard/site-context.test.tsx
@@ -29,7 +29,6 @@ describe('parseSiteFromDataset', () => {
data-is-dbip="false"
data-current-user-role="owner"
data-current-user-id="1"
- data-members='{"1":"Test User"}'
data-flags="{}"
data-valid-intervals-by-period='{"12mo":["day","week","month"],"30d":["day","week"],"6mo":["day","week","month"],"7d":["hour","day"],"all":["week","month"],"custom":["day","week","month"],"day":["minute","hour"],"month":["day","week"],"realtime":["minute"],"year":["day","week","month"]}'
{...attrs}
@@ -67,8 +66,7 @@ describe('parseSiteFromDataset', () => {
realtime: ['minute'],
year: ['day', 'week', 'month']
},
- shared: false,
- members: { '1': 'Test User' }
+ shared: false
}
it('parses from dom string map correctly', () => {
diff --git a/assets/js/dashboard/site-context.tsx b/assets/js/dashboard/site-context.tsx
index fbd03c3f5f..400181b260 100644
--- a/assets/js/dashboard/site-context.tsx
+++ b/assets/js/dashboard/site-context.tsx
@@ -23,8 +23,7 @@ export function parseSiteFromDataset(dataset: DOMStringMap): PlausibleSite {
isDbip: dataset.isDbip === 'true',
flags: JSON.parse(dataset.flags!),
validIntervalsByPeriod: JSON.parse(dataset.validIntervalsByPeriod!),
- shared: !!dataset.sharedLinkAuth,
- members: JSON.parse(dataset.members!)
+ shared: !!dataset.sharedLinkAuth
}
}
@@ -57,8 +56,7 @@ const siteContextDefaultValue = {
isDbip: false,
flags: {} as FeatureFlags,
validIntervalsByPeriod: {} as Record<string, Array<string>>,
- shared: false,
- members: null as null | Record<number, string>
+ shared: false
}
export type PlausibleSite = typeof siteContextDefaultValue
diff --git a/assets/js/dashboard/util/date.test.ts b/assets/js/dashboard/util/date.test.ts
index ba085e7fce..2f14de4273 100644
--- a/assets/js/dashboard/util/date.test.ts
+++ b/assets/js/dashboard/util/date.test.ts
@@ -5,6 +5,7 @@ import {
formatDayShort,
formatISO,
nowForSite,
+ parseNaiveDate,
shiftMonths,
yesterday
} from './date'
@@ -119,3 +120,11 @@ describe('formatting UTC dates from database', () => {
).toEqual('2 Jan')
})
})
+
+describe('formatting site-timezoned datetimes from database works flawlessly', () => {
+ it('is able to enrich UTC date string with site timezone, formatting the value correctly', () => {
+ expect(formatDayShort(parseNaiveDate('2025-01-01 14:00:00'))).toEqual(
+ '1 Jan'
+ )
+ })
+})
diff --git a/assets/test-utils/app-context-providers.tsx b/assets/test-utils/app-context-providers.tsx
index 012d5391bc..be2b47b107 100644
--- a/assets/test-utils/app-context-providers.tsx
+++ b/assets/test-utils/app-context-providers.tsx
@@ -43,8 +43,7 @@ export const TestContextProviders = ({
isDbip: false,
flags: {},
validIntervalsByPeriod: {},
- shared: false,
- members: { 1: 'Test User' }
+ shared: false
}
const site = { ...defaultSite, ...siteOptions }
diff --git a/lib/plausible/segments/segment.ex b/lib/plausible/segments/segment.ex
index 43978b7cc3..39aabbc97c 100644
--- a/lib/plausible/segments/segment.ex
+++ b/lib/plausible/segments/segment.ex
@@ -10,17 +10,6 @@ defmodule Plausible.Segments.Segment do
@type t() :: %__MODULE__{}
- @derive {Jason.Encoder,
- only: [
- :id,
- :name,
- :type,
- :segment_data,
- :owner_id,
- :inserted_at,
- :updated_at
- ]}
-
schema "segments" do
field :name, :string
field :type, Ecto.Enum, values: @segment_types
@@ -204,3 +193,25 @@ defmodule Plausible.Segments.Segment do
end
end
end
+
+defimpl Jason.Encoder, for: Plausible.Segments.Segment do
+ def encode(%Plausible.Segments.Segment{} = segment, opts) do
+ %{
+ id: segment.id,
+ name: segment.name,
+ type: segment.type,
+ segment_data: segment.segment_data,
+ owner_id: segment.owner_id,
+ owner_name: if(is_nil(segment.owner_id), do: nil, else: segment.owner.name),
+ inserted_at:
+ segment.inserted_at
+ |> Plausible.Timezones.to_datetime_in_timezone(segment.site.timezone)
+ |> Calendar.strftime("%Y-%m-%d %H:%M:%S"),
+ updated_at:
+ segment.updated_at
+ |> Plausible.Timezones.to_datetime_in_timezone(segment.site.timezone)
+ |> Calendar.strftime("%Y-%m-%d %H:%M:%S")
+ }
+ |> Jason.Encode.map(opts)
+ end
+end
diff --git a/lib/plausible/segments/segments.ex b/lib/plausible/segments/segments.ex
index 5b30724167..5588b94b1a 100644
--- a/lib/plausible/segments/segments.ex
+++ b/lib/plausible/segments/segments.ex
@@ -87,7 +87,7 @@ defmodule Plausible.Segments do
),
:ok <-
Segment.validate_segment_data(site, params["segment_data"], true) do
- {:ok, Repo.insert!(changeset)}
+ {:ok, changeset |> Repo.insert!() |> Repo.preload(:owner)}
else
%{valid?: false, errors: errors} ->
{:error, {:invalid_segment, errors}}
@@ -120,11 +120,9 @@ defmodule Plausible.Segments do
params["segment_data"],
true
) do
- {:ok,
- Repo.update!(
- changeset,
- returning: true
- )}
+ Repo.update!(changeset)
+
+ {:ok, Repo.reload!(segment) |> Repo.preload(:owner)}
else
%{valid?: false, errors: errors} ->
{:error, {:invalid_segment, errors}}
@@ -271,7 +269,8 @@ defmodule Plausible.Segments do
from(segment in Segment,
where: segment.site_id == ^site_id,
where: segment.id == ^segment_id,
- where: segment.type == :site or segment.owner_id == ^user_id
+ where: segment.type == :site or segment.owner_id == ^user_id,
+ preload: [:owner]
)
Repo.one(query)
@@ -339,7 +338,8 @@ defmodule Plausible.Segments do
from(segment in Segment,
select: ^fields,
where: segment.site_id == ^site_id,
- order_by: [desc: segment.updated_at, desc: segment.id]
+ order_by: [desc: segment.updated_at, desc: segment.id],
+ preload: [:owner]
)
query =
@@ -370,4 +370,12 @@ defmodule Plausible.Segments do
"#{field} #{formatted_message}"
end
+
+ @doc """
+ This function enriches the segment with site, without actually querying the database for the site again.
+ Needed for Plausible.Segments.Segment custom JSON serialization.
+ """
+ def enrich_with_site(%Segment{} = segment, %Plausible.Site{} = site) do
+ Map.put(segment, :site, site)
+ end
end
diff --git a/lib/plausible_web/controllers/api/internal/segments_controller.ex b/lib/plausible_web/controllers/api/internal/segments_controller.ex
index b28db63f5d..8d0fbf7230 100644
--- a/lib/plausible_web/controllers/api/internal/segments_controller.ex
+++ b/lib/plausible_web/controllers/api/internal/segments_controller.ex
@@ -24,7 +24,10 @@ defmodule PlausibleWeb.Api.Internal.SegmentsController do
H.not_enough_permissions(conn, "Not enough permissions to get segments")
{:ok, segments} ->
- json(conn, segments)
+ json(
+ conn,
+ Enum.map(segments, fn segment -> Segments.enrich_with_site(segment, site) end)
+ )
end
end
@@ -54,7 +57,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsController do
segment_not_found(conn, params["segment_id"])
{:ok, segment} ->
- json(conn, segment)
+ json(conn, Segments.enrich_with_site(segment, site))
end
end
@@ -80,7 +83,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsController do
})
{:ok, segment} ->
- json(conn, segment)
+ json(conn, Segments.enrich_with_site(segment, site))
end
end
@@ -114,7 +117,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsController do
})
{:ok, segment} ->
- json(conn, segment)
+ json(conn, Segments.enrich_with_site(segment, site))
end
end
@@ -141,7 +144,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsController do
segment_not_found(conn, params["segment_id"])
{:ok, segment} ->
- json(conn, segment)
+ json(conn, Segments.enrich_with_site(segment, site))
end
end
diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex
index 713cceeee3..016540bef5 100644
--- a/lib/plausible_web/controllers/stats_controller.ex
+++ b/lib/plausible_web/controllers/stats_controller.ex
@@ -87,11 +87,6 @@ defmodule PlausibleWeb.StatsController do
title: title(conn, site),
demo: demo,
flags: flags,
- members:
- if(flags.saved_segments,
- do: get_members(conn.assigns[:site_role], site),
- else: nil
- ),
is_dbip: is_dbip(),
dogfood_page_path: dogfood_page_path,
load_dashboard_js: true
@@ -381,11 +376,6 @@ defmodule PlausibleWeb.StatsController do
background: conn.params["background"],
theme: conn.params["theme"],
flags: flags,
- members:
- if(flags.saved_segments,
- do: get_members(conn.assigns[:site_role], shared_link.site),
- else: nil
- ),
is_dbip: is_dbip(),
load_dashboard_js: true
)
@@ -411,30 +401,6 @@ defmodule PlausibleWeb.StatsController do
end)
|> Map.new()
- defp get_members(site_role, %Plausible.Site{} = site)
- when site_role in [:viewer, :editor, :owner, :admin, :super_admin] do
- site =
- site
- |> Plausible.Repo.preload(
- team: [team_memberships: [:user]],
- guest_memberships: [team_membership: [:user]]
- )
-
- site.guest_memberships
- |> Enum.map(fn i = %Plausible.Teams.GuestMembership{} ->
- i.team_membership
- end)
- |> Enum.concat(site.team.team_memberships)
- |> Enum.map(fn i = %Plausible.Teams.Membership{} ->
- {i.user.id, i.user.name}
- end)
- |> Map.new()
- end
-
- defp get_members(_site_role, _site) do
- nil
- end
-
defp is_dbip() do
on_ee do
false
diff --git a/lib/plausible_web/templates/stats/stats.html.heex b/lib/plausible_web/templates/stats/stats.html.heex
index d729e115b6..5cb64d4c73 100644
--- a/lib/plausible_web/templates/stats/stats.html.heex
+++ b/lib/plausible_web/templates/stats/stats.html.heex
@@ -45,7 +45,6 @@
data-current-user-id={
if user = @conn.assigns[:current_user], do: user.id, else: Jason.encode!(nil)
}
- data-members={Jason.encode!(@members)}
data-flags={Jason.encode!(@flags)}
data-valid-intervals-by-period={
Plausible.Stats.Interval.valid_by_period(site: @site) |> Jason.encode!()
diff --git a/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs b/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
index 375a7a31fe..0e849e8485 100644
--- a/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
+++ b/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
@@ -41,9 +41,10 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
"id" => s.id,
"name" => s.name,
"type" => Atom.to_string(s.type),
+ "inserted_at" => Calendar.strftime(s.inserted_at, "%Y-%m-%d %H:%M:%S"),
+ "updated_at" => Calendar.strftime(s.updated_at, "%Y-%m-%d %H:%M:%S"),
"owner_id" => nil,
- "inserted_at" => NaiveDateTime.to_iso8601(s.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(s.updated_at),
+ "owner_name" => nil,
"segment_data" => nil
}
end)
@@ -73,7 +74,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
for role <- [:viewer, :owner] do
test "returns list with personal and site segments for #{role}, avoiding segments from other site",
%{conn: conn, user: user, site: site} do
- other_user = new_user()
+ other_user = new_user(name: "Other User")
other_site = new_site(owner: other_user, team: team_of(user))
insert_list(2, :segment,
@@ -97,6 +98,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
type: :personal,
name: "a personal segment"
)
+ |> Map.put(:owner_name, user.name)
emea_site_segment =
insert(:segment,
@@ -105,6 +107,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
type: :site,
name: "EMEA region"
)
+ |> Map.put(:owner_name, other_user.name)
apac_site_segment =
insert(:segment,
@@ -113,22 +116,41 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
type: :site,
name: "APAC region"
)
+ |> Map.put(:owner_name, user.name)
+
+ dangling_site_segment =
+ insert(:segment,
+ site: site,
+ owner: nil,
+ type: :site,
+ name: "Another region"
+ )
+ |> Map.put(:owner_name, nil)
conn =
get(conn, "/api/#{site.domain}/segments")
assert json_response(conn, 200) ==
- Enum.map([apac_site_segment, emea_site_segment, personal_segment], fn s ->
- %{
- "id" => s.id,
- "name" => s.name,
- "type" => Atom.to_string(s.type),
- "owner_id" => s.owner_id,
- "inserted_at" => NaiveDateTime.to_iso8601(s.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(s.updated_at),
- "segment_data" => nil
- }
- end)
+ Enum.map(
+ [
+ dangling_site_segment,
+ apac_site_segment,
+ emea_site_segment,
+ personal_segment
+ ],
+ fn s ->
+ %{
+ "id" => s.id,
+ "name" => s.name,
+ "type" => Atom.to_string(s.type),
+ "owner_id" => s.owner_id,
+ "owner_name" => s.owner_name,
+ "inserted_at" => Calendar.strftime(s.inserted_at, "%Y-%m-%d %H:%M:%S"),
+ "updated_at" => Calendar.strftime(s.updated_at, "%Y-%m-%d %H:%M:%S"),
+ "segment_data" => nil
+ }
+ end
+ )
end
end
end
@@ -218,8 +240,9 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
test "serves 200 with segment when user is not the segment owner and segment is not personal",
%{
conn: conn,
- site: site
+ user: user
} do
+ site = new_site(owner: user, timezone: "Asia/Tokyo")
other_user = add_guest(site, role: :editor)
segment =
@@ -228,8 +251,8 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
owner: other_user,
site: site,
name: "any",
- inserted_at: "2024-09-01T10:00:00",
- updated_at: "2024-09-01T10:00:00"
+ inserted_at: "2024-09-01T22:00:00.000Z",
+ updated_at: "2024-09-01T23:00:00.000Z"
)
conn =
@@ -238,11 +261,12 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
assert json_response(conn, 200) == %{
"id" => segment.id,
"owner_id" => other_user.id,
+ "owner_name" => other_user.name,
"name" => segment.name,
"type" => Atom.to_string(segment.type),
"segment_data" => segment.segment_data,
- "inserted_at" => NaiveDateTime.to_iso8601(segment.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(segment.updated_at)
+ "inserted_at" => "2024-09-02 07:00:00",
+ "updated_at" => "2024-09-02 08:00:00"
}
end
@@ -265,11 +289,12 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
assert json_response(conn, 200) == %{
"id" => segment.id,
"owner_id" => user.id,
+ "owner_name" => user.name,
"name" => segment.name,
"type" => Atom.to_string(segment.type),
"segment_data" => segment.segment_data,
- "inserted_at" => NaiveDateTime.to_iso8601(segment.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(segment.updated_at)
+ "inserted_at" => Calendar.strftime(segment.inserted_at, "%Y-%m-%d %H:%M:%S"),
+ "updated_at" => Calendar.strftime(segment.updated_at, "%Y-%m-%d %H:%M:%S")
}
end
end
@@ -368,6 +393,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
]
}),
"owner_id" => ^user.id,
+ "owner_name" => ^user.name,
"inserted_at" => ^any(:iso8601_naive_datetime),
"updated_at" => ^any(:iso8601_naive_datetime)
}) = response
@@ -552,6 +578,7 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
]
}),
"owner_id" => ^user.id,
+ "owner_name" => ^user.name,
"inserted_at" => ^any(:iso8601_naive_datetime),
"updated_at" => ^any(:iso8601_naive_datetime)
}) = response
@@ -574,20 +601,64 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
response =
patch(conn, "/api/#{site.domain}/segments/#{segment.id}", %{
"name" => "updated name",
- "type" => Atom.to_string(:personal)
+ "type" => "personal"
})
|> json_response(200)
- assert %{
- "id" => segment.id,
- "name" => "updated name",
- "type" => Atom.to_string(:personal),
- "owner_id" => user.id,
- "segment_data" => segment.segment_data,
- "inserted_at" => NaiveDateTime.to_iso8601(segment.inserted_at)
- } == Map.drop(response, ["updated_at"])
+ assert_matches ^strict_map(%{
+ "id" => ^segment.id,
+ "name" => "updated name",
+ "type" => "personal",
+ "owner_id" => ^user.id,
+ "owner_name" => ^user.name,
+ "segment_data" => ^segment.segment_data,
+ "inserted_at" =>
+ ^any(
+ :string,
+ ~r/#{Calendar.strftime(segment.inserted_at, "%Y-%m-%d %H:%M:%S")}/
+ ),
+ "updated_at" => ^any(:iso8601_naive_datetime)
+ }) = response
+ end
+
+ test "the last editor of a dangling site segment (segment with owner_id: nil) becomes the new owner",
+ %{
+ conn: conn,
+ user: user
+ } do
+ site = new_site()
+ add_guest(site, user: user, role: :editor)
- assert response["updated_at"] > response["inserted_at"]
+ segment =
+ insert(:segment,
+ site: site,
+ name: "original name",
+ type: :site,
+ owner: nil
+ )
+
+ response =
+ patch(conn, "/api/#{site.domain}/segments/#{segment.id}", %{"name" => "updated name"})
+ |> json_response(200)
+
+ assert_matches ^strict_map(%{
+ "id" => ^segment.id,
+ "name" => "updated name",
+ "type" =>
+ ^any(
+ :string,
+ ~r/#{segment.type}/
+ ),
+ "owner_id" => ^user.id,
+ "owner_name" => ^user.name,
+ "segment_data" => ^segment.segment_data,
+ "inserted_at" =>
+ ^any(
+ :string,
+ ~r/#{Calendar.strftime(segment.inserted_at, "%Y-%m-%d %H:%M:%S")}/
+ ),
+ "updated_at" => ^any(:iso8601_naive_datetime)
+ }) = response
end
end
@@ -661,12 +732,13 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
assert %{
"owner_id" => user.id,
+ "owner_name" => user.name,
"id" => segment.id,
"name" => segment.name,
"segment_data" => segment.segment_data,
"type" => "#{unquote(type)}",
- "inserted_at" => NaiveDateTime.to_iso8601(segment.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(segment.updated_at)
+ "inserted_at" => Calendar.strftime(segment.inserted_at, "%Y-%m-%d %H:%M:%S"),
+ "updated_at" => Calendar.strftime(segment.updated_at, "%Y-%m-%d %H:%M:%S")
} == response
verify_no_segment_in_db(segment)
@@ -691,13 +763,14 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
|> json_response(200)
assert %{
+ "owner_name" => other_user.name,
"owner_id" => other_user.id,
"id" => segment.id,
"name" => segment.name,
"segment_data" => segment.segment_data,
"type" => "site",
- "inserted_at" => NaiveDateTime.to_iso8601(segment.inserted_at),
- "updated_at" => NaiveDateTime.to_iso8601(segment.updated_at)
+ "inserted_at" => Calendar.strftime(segment.inserted_at, "%Y-%m-%d %H:%M:%S"),
+ "updated_at" => Calendar.strftime(segment.updated_at, "%Y-%m-%d %H:%M:%S")
} == response
verify_no_segment_in_db(segment)
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index c94a5a27b6..b971d3b9fb 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -27,7 +27,6 @@ defmodule PlausibleWeb.StatsControllerTest do
assert text_of_attr(resp, @react_container, "data-has-props") == "false"
assert text_of_attr(resp, @react_container, "data-logged-in") == "false"
assert text_of_attr(resp, @react_container, "data-embedded") == ""
- assert text_of_attr(resp, @react_container, "data-members") == "null"
[{"div", attrs, _}] = find(resp, @react_container)
assert Enum.all?(attrs, fn {k, v} -> is_binary(k) and is_binary(v) end)
@@ -117,14 +116,11 @@ defmodule PlausibleWeb.StatsControllerTest do
describe "GET /:domain - as a logged in user" do
setup [:create_user, :log_in, :create_site]
- test "can view stats of a website I've created", %{conn: conn, site: site, user: user} do
+ test "can view stats of a website I've created", %{conn: conn, site: site} do
populate_stats(site, [build(:pageview)])
conn = get(conn, "/" <> site.domain)
resp = html_response(conn, 200)
assert text_of_attr(resp, @react_container, "data-logged-in") == "true"
-
- assert text_of_attr(resp, @react_container, "data-members") ==
- "{\"#{user.id}\":\"#{user.name}\"}"
end
test "can view stats of a website I've created, enforcing pageviews check skip", %{