Skip to content

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

Improve the segment modals (#6718)

Sanne de Vriesb89b749cd1be
diff --git a/assets/js/dashboard/components/form-elements.tsx b/assets/js/dashboard/components/form-elements.tsx
index db1ec30948..7b4238792f 100644
--- a/assets/js/dashboard/components/form-elements.tsx
+++ b/assets/js/dashboard/components/form-elements.tsx
@@ -1,4 +1,4 @@
-import React, { ReactNode } from 'react'
+import React, { ReactNode, useEffect, useRef } from 'react'
import classNames from 'classnames'
import { Tooltip } from '../util/tooltip'
@@ -52,20 +52,36 @@ export const LabeledTextInput = ({
value,
onChange,
placeholder,
- maxLength
-}: LabeledFieldProps) => (
- <LabeledField label={label} id={id} value={value} maxLength={maxLength}>
- <input
- autoComplete="off"
- id={id}
- value={value}
- onChange={(e) => onChange(e.target.value)}
- placeholder={placeholder}
- aria-describedby={maxLength !== undefined ? `${id}-counter` : undefined}
- className={fieldClassName}
- />
- </LabeledField>
-)
+ maxLength,
+ focusOnMount = false
+}: LabeledFieldProps & {
+ focusOnMount?: boolean
+}) => {
+ const inputRef = useRef<HTMLInputElement>(null)
+
+ useEffect(() => {
+ const input = inputRef.current
+ if (focusOnMount && input) {
+ input.focus()
+ input.setSelectionRange(input.value.length, input.value.length)
+ }
+ }, [focusOnMount])
+
+ return (
+ <LabeledField label={label} id={id} value={value} maxLength={maxLength}>
+ <input
+ ref={inputRef}
+ autoComplete="off"
+ id={id}
+ value={value}
+ onChange={(e) => onChange(e.target.value)}
+ placeholder={placeholder}
+ aria-describedby={maxLength !== undefined ? `${id}-counter` : undefined}
+ className={fieldClassName}
+ />
+ </LabeledField>
+ )
+}
export const LabeledTextarea = ({
label,
diff --git a/assets/js/dashboard/components/modal-layout.tsx b/assets/js/dashboard/components/modal-layout.tsx
index 46f37b791f..52cc17cf12 100644
--- a/assets/js/dashboard/components/modal-layout.tsx
+++ b/assets/js/dashboard/components/modal-layout.tsx
@@ -7,7 +7,7 @@ export function ModalLayout({
title,
onClose,
children,
- maxWidth = '460px'
+ maxWidth = '500px'
}: {
title: ReactNode
onClose: () => void
diff --git a/assets/js/dashboard/components/toast.test.tsx b/assets/js/dashboard/components/toast.test.tsx
new file mode 100644
index 0000000000..727ec82dd1
--- /dev/null
+++ b/assets/js/dashboard/components/toast.test.tsx
@@ -0,0 +1,23 @@
+import React from 'react'
+import { render, screen, act, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
+import { showToast, ToastHost } from './toast'
+
+test('shows a success toast and hides it after close', async () => {
+ render(<ToastHost />)
+
+ act(() => {
+ showToast({ message: 'Segment created' })
+ })
+
+ await waitFor(() => {
+ expect(screen.getByText('Success!')).toBeVisible()
+ })
+ expect(screen.getByText('Segment created')).toBeVisible()
+
+ await userEvent.click(screen.getByRole('button', { name: 'Close toast' }))
+
+ await waitFor(() => {
+ expect(screen.queryByText('Segment created')).toBeNull()
+ })
+})
diff --git a/assets/js/dashboard/components/toast.tsx b/assets/js/dashboard/components/toast.tsx
new file mode 100644
index 0000000000..f30131b34a
--- /dev/null
+++ b/assets/js/dashboard/components/toast.tsx
@@ -0,0 +1,100 @@
+import React, { useEffect, useState } from 'react'
+import classNames from 'classnames'
+import { CheckCircleIcon } from '@heroicons/react/24/outline'
+import { XMarkIcon } from '@heroicons/react/20/solid'
+
+type Toast = {
+ title?: string
+ message: string
+}
+
+const TOAST_TTL_MS = 4000
+const TOAST_LEAVE_MS = 100
+
+type Phase = 'shown' | 'leave'
+type Listener = (toast: Toast) => void
+
+const listeners = new Set<Listener>()
+
+export function showToast(toast: Toast) {
+ listeners.forEach((listener) => listener(toast))
+}
+
+export function ToastHost() {
+ const [toast, setToast] = useState<Toast | null>(null)
+ const [phase, setPhase] = useState<Phase>('shown')
+
+ useEffect(() => {
+ const listener: Listener = (next) => {
+ setToast(next)
+ setPhase('shown')
+ }
+ listeners.add(listener)
+ return () => {
+ listeners.delete(listener)
+ }
+ }, [])
+
+ useEffect(() => {
+ if (!toast || phase !== 'shown') {
+ return
+ }
+ const hide = window.setTimeout(() => setPhase('leave'), TOAST_TTL_MS)
+ return () => window.clearTimeout(hide)
+ }, [toast, phase])
+
+ useEffect(() => {
+ if (!toast || phase !== 'leave') {
+ return
+ }
+ const clear = window.setTimeout(() => setToast(null), TOAST_LEAVE_MS)
+ return () => window.clearTimeout(clear)
+ }, [toast, phase])
+
+ if (!toast) {
+ return null
+ }
+
+ return (
+ <div className="z-50 fixed inset-0 flex items-end justify-center px-4 py-6 pointer-events-none sm:p-6 sm:items-start sm:justify-end">
+ <div
+ role="status"
+ className={classNames(
+ 'max-w-sm w-full bg-white dark:bg-gray-800 shadow-lg rounded-lg pointer-events-auto',
+ 'starting:translate-y-2 starting:opacity-0 sm:starting:translate-y-0 sm:starting:translate-x-2',
+ phase === 'shown' &&
+ 'transform transition ease-out duration-300 translate-y-0 opacity-100 sm:translate-x-0',
+ phase === 'leave' && 'transition ease-in duration-100 opacity-0'
+ )}
+ >
+ <div className="rounded-lg ring-1/5 ring-black overflow-hidden">
+ <div className="p-4">
+ <div className="flex items-start">
+ <div className="shrink-0">
+ <CheckCircleIcon className="size-6 text-green-400" />
+ </div>
+ <div className="ml-3 w-0 flex-1 pt-0.5">
+ <p className="text-sm leading-5 font-medium text-gray-900 dark:text-gray-100">
+ {toast.title ?? 'Success!'}
+ </p>
+ <p className="mt-1 text-sm leading-5 text-gray-500 dark:text-gray-200">
+ {toast.message}
+ </p>
+ </div>
+ <div className="ml-4 shrink-0 flex">
+ <button
+ type="button"
+ className="inline-flex text-gray-400 focus:outline-hidden focus:text-gray-500 dark:focus:text-gray-200 transition ease-in-out duration-150"
+ aria-label="Close toast"
+ onClick={() => setPhase('leave')}
+ >
+ <XMarkIcon className="size-5" />
+ </button>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ )
+}
diff --git a/assets/js/dashboard/router.tsx b/assets/js/dashboard/router.tsx
index 54d3a0d598..2fdc654208 100644
--- a/assets/js/dashboard/router.tsx
+++ b/assets/js/dashboard/router.tsx
@@ -27,6 +27,7 @@ import { RoutelessSegmentModals } from './segments/routeless-segment-modals'
import { GOOGLE_SEARCH_TERMS_DETAILS_PATH } from './stats/sources/fetch-search-terms'
import { SourcesDetails } from './stats/sources/details'
import { RoutelessAnnotationModals } from './annotations/routeless-annotations-modals'
+import { ToastHost } from './components/toast'
const queryClient = new QueryClient({
defaultOptions: {
@@ -48,6 +49,7 @@ function DashboardElement() {
<Outlet />
<RoutelessSegmentModals />
<RoutelessAnnotationModals />
+ <ToastHost />
</DashboardStateContextProvider>
</RoutelessModalsContextProvider>
</QueryClientProvider>
diff --git a/assets/js/dashboard/segments/routeless-segment-modals.tsx b/assets/js/dashboard/segments/routeless-segment-modals.tsx
index f0a6a8d528..b018ee96fe 100644
--- a/assets/js/dashboard/segments/routeless-segment-modals.tsx
+++ b/assets/js/dashboard/segments/routeless-segment-modals.tsx
@@ -4,23 +4,16 @@ import {
DeleteSegmentModal,
UpdateSegmentModal
} from './segment-modals'
-import {
- getSearchToSetSegmentFilter,
- getSegmentNamePlaceholder,
- handleSegmentResponse,
- SavedSegment,
- SegmentData,
- SegmentDataFromApi
-} from '../filtering/segments'
-import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { getSegmentNamePlaceholder } from '../filtering/segments'
import { useSiteContext } from '../site-context'
-import { cleanLabels, remapToApiFilters } from '../util/filters'
-import { useAppNavigate } from '../navigation/use-app-navigate'
import { useDashboardStateContext } from '../dashboard-state-context'
import { useUserContext } from '../user-context'
-import { mutation } from '../api'
import { useRoutelessModalsContext } from '../navigation/routeless-modals-context'
-import { useSegmentsContext } from '../filtering/segments-context'
+import {
+ useCreateSegment,
+ useDeleteSegment,
+ usePatchSegment
+} from './use-segment-mutations'
export type RoutelessSegmentModal =
| { type: 'create-segment' }
@@ -28,127 +21,13 @@ export type RoutelessSegmentModal =
| { type: 'delete-segment' }
export const RoutelessSegmentModals = () => {
- const { updateOne, addOne, removeOne } = useSegmentsContext()
- const navigate = useAppNavigate()
- const queryClient = useQueryClient()
const site = useSiteContext()
const { modal, setModal } = useRoutelessModalsContext()
const { dashboardState, expandedSegment } = useDashboardStateContext()
const user = useUserContext()
-
- const patchSegment = useMutation({
- mutationFn: async ({
- id,
- name,
- type,
- segment_data
- }: Pick<SavedSegment, 'id'> &
- Partial<Pick<SavedSegment, 'name' | 'type'>> & {
- segment_data?: SegmentData
- }) => {
- const response: SavedSegment & { segment_data: SegmentDataFromApi } =
- await mutation(
- `/api/${encodeURIComponent(site.domain)}/segments/${id}`,
- {
- method: 'PATCH',
- body: {
- name,
- type,
- ...(segment_data && {
- segment_data: {
- filters: remapToApiFilters(segment_data.filters),
- labels: cleanLabels(segment_data.filters, segment_data.labels)
- }
- })
- }
- }
- )
-
- return handleSegmentResponse(response)
- },
- onSuccess: async (segment) => {
- updateOne(segment)
- queryClient.invalidateQueries({ queryKey: ['segments'] })
- navigate({
- search: getSearchToSetSegmentFilter(segment, {
- omitAllOtherFilters: true
- }),
- state: {
- expandedSegment: null
- }
- })
- setModal(null)
- }
- })
-
- const createSegment = useMutation({
- mutationFn: async ({
- name,
- type,
- segment_data
- }: {
- name: string
- type: 'personal' | 'site'
- segment_data: SegmentData
- }) => {
- const response: SavedSegment & { segment_data: SegmentDataFromApi } =
- await mutation(`/api/${encodeURIComponent(site.domain)}/segments`, {
- method: 'POST',
- body: {
- name,
- type,
- segment_data: {
- filters: remapToApiFilters(segment_data.filters),
- labels: cleanLabels(segment_data.filters, segment_data.labels)
- }
- }
- })
- return handleSegmentResponse(response)
- },
- onSuccess: async (segment) => {
- addOne(segment)
- queryClient.invalidateQueries({ queryKey: ['segments'] })
- navigate({
- search: getSearchToSetSegmentFilter(segment, {
- omitAllOtherFilters: true
- }),
- state: {
- expandedSegment: null
- }
- })
- setModal(null)
- }
- })
-
- const deleteSegment = useMutation({
- mutationFn: async (data: Pick<SavedSegment, 'id'>) => {
- const response: SavedSegment & { segment_data: SegmentDataFromApi } =
- await mutation(
- `/api/${encodeURIComponent(site.domain)}/segments/${data.id}`,
- {
- method: 'DELETE'
- }
- )
- return handleSegmentResponse(response)
- },
- onSuccess: (segment): void => {
- removeOne(segment)
- queryClient.invalidateQueries({ queryKey: ['segments'] })
- navigate({
- search: (s) => {
- return {
- ...s,
- filters: null,
- labels: null
- }
- },
- state: {
- expandedSegment: null
- }
- })
- setModal(null)
- }
- })
+ const patchSegment = usePatchSegment()
+ const createSegment = useCreateSegment()
+ const deleteSegment = useDeleteSegment()
if (!user.loggedIn) {
return null
@@ -186,7 +65,7 @@ export const RoutelessSegmentModals = () => {
<CreateSegmentModal
user={user}
siteSegmentsAvailable={site.siteSegmentsAvailable}
- namePlaceholder={getSegmentNamePlaceholder(dashboardState)}
+ suggestedName={getSegmentNamePlaceholder(dashboardState)}
segment={expandedSegment ?? undefined}
onClose={() => {
setModal(null)
diff --git a/assets/js/dashboard/segments/segment-modals.test.tsx b/assets/js/dashboard/segments/segment-modals.test.tsx
index a22160928e..473ffc852a 100644
--- a/assets/js/dashboard/segments/segment-modals.test.tsx
+++ b/assets/js/dashboard/segments/segment-modals.test.tsx
@@ -1,7 +1,13 @@
import React from 'react'
import { render, screen } from '@testing-library/react'
-import { SegmentModal } from './segment-modals'
+import userEvent from '@testing-library/user-event'
+import {
+ DeleteSegmentModal,
+ SegmentModal,
+ UpdateSegmentModal
+} from './segment-modals'
import { TestContextProviders } from '../../../test-utils/app-context-providers'
+import { MockAPI } from '../../../test-utils/mock-api'
import {
SavedSegment,
SavedSegmentPublic,
@@ -12,12 +18,167 @@ import {
import { Role, UserContextValue } from '../user-context'
import { PlausibleSite } from '../site-context'
+const domain = 'dummy.site'
+
+let mockAPI: MockAPI
+
+beforeAll(() => {
+ mockAPI = new MockAPI().start()
+})
+
+afterAll(() => {
+ mockAPI.stop()
+})
+
beforeEach(() => {
+ mockAPI.clear()
const modalRoot = document.createElement('div')
modalRoot.id = 'modal_root'
document.body.appendChild(modalRoot)
})
+const owner: UserContextValue = {
+ loggedIn: true,
+ role: Role.editor,
+ id: 1,
+ team: { identifier: null, hasConsolidatedView: false }
+}
+
+const anySegment: SavedSegment & { segment_data: SegmentData } = {
+ id: 100,
+ type: SegmentType.personal,
+ owner_id: owner.id,
+ owner_name: 'Jane Smith',
+ name: 'Blog or About',
+ segment_data: {
+ filters: [['is', 'page', ['/blog', '/about']]],
+ labels: {}
+ },
+ inserted_at: '2025-03-13T13:00:00',
+ updated_at: '2025-03-13T16:00:00'
+}
+
+describe('Update segment modal', () => {
+ it('shows and focuses the segment name', () => {
+ render(
+ <UpdateSegmentModal
+ user={owner}
+ siteSegmentsAvailable={true}
+ segment={anySegment}
+ namePlaceholder="Page is /blog or /about"
+ onClose={jest.fn()}
+ onSave={jest.fn()}
+ status="idle"
+ error={null}
+ reset={jest.fn()}
+ />,
+ {
+ wrapper: (props) => (
+ <TestContextProviders
+ user={owner}
+ siteOptions={{ siteSegmentsAvailable: true }}
+ {...props}
+ />
+ )
+ }
+ )
+
+ expect(
+ screen.getByRole('heading', { name: 'Update segment' })
+ ).toBeVisible()
+ expect(screen.getByLabelText('Segment name')).toHaveValue(anySegment.name)
+ expect(screen.getByLabelText('Segment name')).toHaveFocus()
+ })
+})
+
+describe('Delete segment modal', () => {
+ it.each([
+ {
+ case: 'personal segment without shared links',
+ type: SegmentType.personal,
+ links: [],
+ notice: 'Are you sure?',
+ checkbox: null,
+ deleteButton: 'Delete'
+ },
+ {
+ case: 'site segment without shared links',
+ type: SegmentType.site,
+ links: [],
+ notice:
+ 'This site segment will be removed for everyone with access to this dashboard. Are you sure?',
+ checkbox: null,
+ deleteButton: 'Delete'
+ },
+ {
+ case: 'segment with one shared link',
+ type: SegmentType.site,
+ links: ['Agency link'],
+ notice:
+ 'This segment is used by a shared link. To delete the segment, this link must also be deleted:',
+ checkbox: 'Also delete this shared link',
+ deleteButton: 'Delete segment and link'
+ },
+ {
+ case: 'segment with more shared links',
+ type: SegmentType.site,
+ links: ['Agency link', 'Client link'],
+ notice:
+ 'This segment is used by 2 shared links. To delete the segment, these links must also be deleted:',
+ checkbox: 'Also delete these 2 shared links',
+ deleteButton: 'Delete segment and links'
+ }
+ ])(
+ 'shows the correct notice and actions for a $case',
+ async ({ type, links, notice, checkbox, deleteButton }) => {
+ const segment = { ...anySegment, type }
+ mockAPI.get(`/api/${domain}/segments/${segment.id}/shared-links`, links)
+ const onSave = jest.fn()
+
+ render(
+ <DeleteSegmentModal
+ segment={segment}
+ onClose={jest.fn()}
+ onSave={onSave}
+ status="idle"
+ error={null}
+ reset={jest.fn()}
+ />,
+ {
+ wrapper: (props) => (
+ <TestContextProviders
+ user={owner}
+ siteOptions={{ domain }}
+ {...props}
+ />
+ )
+ }
+ )
+
+ expect(
+ await screen.findByText(notice, { exact: false })
+ ).toBeInTheDocument()
+ expect(
+ links.map((name) =>
+ screen.getByRole('link', { name }).getAttribute('href')
+ )
+ ).toEqual(links.map(() => `/${domain}/settings/visibility`))
+
+ const button = screen.getByRole('button', { name: deleteButton })
+ if (checkbox) {
+ expect(button).toBeDisabled()
+ await userEvent.click(screen.getByLabelText(checkbox))
+ } else {
+ expect(screen.queryByRole('checkbox')).not.toBeInTheDocument()
+ }
+ expect(button).toBeEnabled()
+
+ await userEvent.click(button)
+ expect(onSave).toHaveBeenCalledWith({ id: segment.id })
+ }
+ )
+})
+
describe('Segment details modal - errors', () => {
const anySegment: SavedSegment & { segment_data: SegmentData } = {
id: 1,
diff --git a/assets/js/dashboard/segments/segment-modals.tsx b/assets/js/dashboard/segments/segment-modals.tsx
index 19162724ef..e478813026 100644
--- a/assets/js/dashboard/segments/segment-modals.tsx
+++ b/assets/js/dashboard/segments/segment-modals.tsx
@@ -53,7 +53,6 @@ interface SegmentModalProps {
user: UserContextValue
siteSegmentsAvailable: boolean
onClose: () => void
- namePlaceholder: string
}
export const CreateSegmentModal = ({
@@ -62,18 +61,19 @@ export const CreateSegmentModal = ({
onSave,
siteSegmentsAvailable: siteSegmentsAvailable,
user,
- namePlaceholder,
+ suggestedName,
error,
reset,
status
}: SegmentModalProps &
ApiRequestProps & {
segment?: SavedSegment
+ suggestedName: string
onSave: (input: Pick<SavedSegment, 'name' | 'type'>) => void
}) => {
const defaultName = segment?.name
? `Copy of ${segment.name}`.slice(0, 255)
- : ''
+ : suggestedName
const [name, setName] = useState(defaultName)
const defaultType =
segment?.type === SegmentType.site &&
@@ -96,9 +96,10 @@ export const CreateSegmentModal = ({
<ModalLayout title="Create segment" onClose={onClose}>
<LabeledTextInput
{...nameInputProps}
+ focusOnMount
value={name}
onChange={setName}
- placeholder={namePlaceholder}
+ placeholder={suggestedName}
/>
<SegmentTypeSelector
type={type}
@@ -115,7 +116,7 @@ export const CreateSegmentModal = ({
const trimmedName = name.trim()
const saveableName = trimmedName.length
? trimmedName
- : namePlaceholder
+ : suggestedName
onSave({ name: saveableName, type })
}}
/>
@@ -135,10 +136,17 @@ export const CreateSegmentModal = ({
)
}
-function getLinksDeleteNotice(links: string[]) {
- return links.length === 1
- ? 'This segment is used in a shared link. To delete it, you also need to delete the shared link.'
- : `This segment is used in ${links.length} shared links. To delete it, you also need to delete the shared links.`
+function getDeleteNotice(segment: SavedSegment, links: string[]) {
+ if (links.length === 1) {
+ return 'This segment is used by a shared link. To delete the segment, this link must also be deleted:'
+ }
+ if (links.length > 1) {
+ return `This segment is used by ${links.length} shared links. To delete the segment, these links must also be deleted:`
+ }
+ if (segment.type === SegmentType.site) {
+ return 'This site segment will be removed for everyone with access to this dashboard. Are you sure?'
+ }
+ return 'Are you sure?'
}
export const DeleteSegmentModal = ({
@@ -151,7 +159,7 @@ export const DeleteSegmentModal = ({
}: {
onClose: () => void
onSave: (input: Pick<SavedSegment, 'id'>) => void
- segment: SavedSegment & { segment_data?: SegmentData }
+ segment: SavedSegment
} & ApiRequestProps) => {
const site = useSiteContext()
const [confirmed, setConfirmed] = useState(false)
@@ -166,58 +174,55 @@ export const DeleteSegmentModal = ({
}
})
+ const links = linksQuery.data ?? []
const deleteDisabled =
status === 'pending' ||
linksQuery.status !== 'success' ||
- (!!linksQuery.data?.length && !confirmed)
+ (!!links.length && !confirmed)
return (
<ModalLayout
title={`Delete ${SEGMENT_TYPE_LABELS[segment.type].toLowerCase()}`}
onClose={onClose}
>
- <div className="flex flex-col gap-y-2">
- <p className="text-sm dark:text-gray-100">
- {`You're about to delete `}
- <span className="break-all font-semibold">{`"${segment.name}"`}</span>
- {`. Are you sure?`}
- </p>
- {linksQuery.status === 'pending' && (
- <div className="loading sm">
- <div />
- </div>
- )}
- {linksQuery.status === 'success' && !!linksQuery.data?.length && (
- <ErrorPanel
- errorMessage={
- <span className="break-normal">
- {getLinksDeleteNotice(linksQuery.data)}
- </span>
- }
- />
- )}
- {linksQuery.status === 'error' && (
- <ErrorPanel
- errorMessage="Error loading related shared links"
- onRetry={linksQuery.refetch}
- />
- )}
- </div>
- {!!segment.segment_data && (
- <FiltersInSegment
- segment_data={segment.segment_data}
- className={linksQuery.data?.length ? undefined : 'mb-4'}
+ <p className="text-sm dark:text-gray-100">
+ {`You’re about to delete `}
+ <span className="break-all font-semibold">{`“${segment.name}”`}</span>
+ {'. '}
+ {linksQuery.status === 'success' && getDeleteNotice(segment, links)}
+ </p>
+ {linksQuery.status === 'pending' && (
+ <div className="loading sm">
+ <div />
+ </div>
+ )}
+ {linksQuery.status === 'error' && (
+ <ErrorPanel
+ errorMessage="Error loading related shared links"
+ onRetry={linksQuery.refetch}
/>
)}
- {!!linksQuery.data?.length && (
+ {!!links.length && (
<>
- <RelatedSharedLinks sharedLinks={linksQuery.data} />
+ <div className="flex flex-col items-start gap-y-1 text-sm">
+ {links.map((name, index) => (
+ <a
+ key={index}
+ href={`/${encodeURIComponent(site.domain)}/settings/visibility`}
+ className="break-words text-indigo-600 hover:text-indigo-700 dark:text-indigo-500 dark:hover:text-indigo-400"
+ >
+ {name}
+ </a>
+ ))}
+ </div>
<Checkbox
id="confirm"
checked={confirmed}
onChange={(e) => setConfirmed(e.currentTarget.checked)}
>
- Yes, delete the associated shared links
+ {links.length === 1
+ ? 'Also delete this shared link'
+ : `Also delete these ${links.length} shared links`}
</Checkbox>
</>
)}
@@ -237,7 +242,11 @@ export const DeleteSegmentModal = ({
}
}
>
- Delete
+ {links.length === 0
+ ? 'Delete'
+ : links.length === 1
+ ? 'Delete segment and link'
+ : 'Delete segment and links'}
</Button>
</ModalFooter>
{error !== null && (
@@ -255,21 +264,6 @@ export const DeleteSegmentModal = ({
)
}
-const RelatedSharedLinks = ({ sharedLinks }: { sharedLinks: string[] }) => {
- return (
- <div className="flex flex-col gap-y-2">
- <p className={inModalSectionLabelClassName}>Shared links</p>
- <FilterPillsList
- className="flex-wrap"
- pills={sharedLinks.map((name) => ({
- plainText: name,
- children: name
- }))}
- />
- </div>
- )
-}
-
const getSiteSegmentDisabledMessage = ({
siteSegmentsAvailable,
user
@@ -358,6 +352,7 @@ export const UpdateSegmentModal = ({
reset
}: SegmentModalProps &
ApiRequestProps & {
+ namePlaceholder: string
onSave: (input: Pick<SavedSegment, 'id' | 'name' | 'type'>) => void
segment: SavedSegment
}) => {
@@ -376,6 +371,7 @@ export const UpdateSegmentModal = ({
<ModalLayout title="Update segment" onClose={onClose}>
<LabeledTextInput
{...nameInputProps}
+ focusOnMount
value={name}
onChange={setName}
placeholder={namePlaceholder}
diff --git a/assets/js/dashboard/segments/use-segment-mutations.ts b/assets/js/dashboard/segments/use-segment-mutations.ts
new file mode 100644
index 0000000000..8c5dffdad9
--- /dev/null
+++ b/assets/js/dashboard/segments/use-segment-mutations.ts
@@ -0,0 +1,153 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+import { mutation } from '../api'
+import { showToast } from '../components/toast'
+import { useSiteContext } from '../site-context'
+import { useAppNavigate } from '../navigation/use-app-navigate'
+import { useRoutelessModalsContext } from '../navigation/routeless-modals-context'
+import { useSegmentsContext } from '../filtering/segments-context'
+import { cleanLabels, remapToApiFilters } from '../util/filters'
+import {
+ getSearchToSetSegmentFilter,
+ handleSegmentResponse,
+ SavedSegment,
+ SegmentData,
+ SegmentDataFromApi
+} from '../filtering/segments'
+
+const toApiSegmentData = (segment_data: SegmentData) => ({
+ filters: remapToApiFilters(segment_data.filters),
+ labels: cleanLabels(segment_data.filters, segment_data.labels)
+})
+
+export function useCreateSegment() {
+ const { addOne } = useSegmentsContext()
+ const navigate = useAppNavigate()
+ const queryClient = useQueryClient()
+ const site = useSiteContext()
+ const { setModal } = useRoutelessModalsContext()
+
+ return useMutation({
+ mutationFn: async ({
+ name,
+ type,
+ segment_data
+ }: {
+ name: string
+ type: 'personal' | 'site'
+ segment_data: SegmentData
+ }) => {
+ const response: SavedSegment & { segment_data: SegmentDataFromApi } =
+ await mutation(`/api/${encodeURIComponent(site.domain)}/segments`, {
+ method: 'POST',
+ body: {
+ name,
+ type,
+ segment_data: toApiSegmentData(segment_data)
+ }
+ })
+ return handleSegmentResponse(response)
+ },
+ onSuccess: async (segment) => {
+ addOne(segment)
+ queryClient.invalidateQueries({ queryKey: ['segments'] })
+ navigate({
+ search: getSearchToSetSegmentFilter(segment, {
+ omitAllOtherFilters: true
+ }),
+ state: {
+ expandedSegment: null
+ }
+ })
+ setModal(null)
+ showToast({ message: 'Segment created' })
+ }
+ })
+}
+
+export function usePatchSegment() {
+ const { updateOne } = useSegmentsContext()
+ const navigate = useAppNavigate()
+ const queryClient = useQueryClient()
+ const site = useSiteContext()
+ const { setModal } = useRoutelessModalsContext()
+
+ return useMutation({
+ mutationFn: async ({
+ id,
+ name,
+ type,
+ segment_data
+ }: Pick<SavedSegment, 'id'> &
+ Partial<Pick<SavedSegment, 'name' | 'type'>> & {
+ segment_data?: SegmentData
+ }) => {
+ const response: SavedSegment & { segment_data: SegmentDataFromApi } =
+ await mutation(
+ `/api/${encodeURIComponent(site.domain)}/segments/${id}`,
+ {
+ method: 'PATCH',
+ body: {
+ name,
+ type,
+ ...(segment_data && {
+ segment_data: toApiSegmentData(segment_data)
+ })
+ }
+ }
+ )
+
+ return handleSegmentResponse(response)
+ },
+ onSuccess: async (segment) => {
+ updateOne(segment)
+ queryClient.invalidateQueries({ queryKey: ['segments'] })
+ navigate({
+ search: getSearchToSetSegmentFilter(segment, {
+ omitAllOtherFilters: true
+ }),
+ state: {
+ expandedSegment: null
+ }
+ })
+ setModal(null)
+ showToast({ message: 'Segment updated' })
+ }
+ })
+}
+
+export function useDeleteSegment() {
+ const { removeOne } = useSegmentsContext()
+ const navigate = useAppNavigate()
+ const queryClient = useQueryClient()
+ const site = useSiteContext()
+ const { setModal } = useRoutelessModalsContext()
+
+ return useMutation({
+ mutationFn: async ({ id }: Pick<SavedSegment, 'id'>) => {
+ const response: SavedSegment & { segment_data: SegmentDataFromApi } =
+ await mutation(
+ `/api/${encodeURIComponent(site.domain)}/segments/${id}`,
+ {
+ method: 'DELETE'
+ }
+ )
+ return handleSegmentResponse(response)
+ },
+ onSuccess: (segment): void => {
+ removeOne(segment)
+ queryClient.invalidateQueries({ queryKey: ['segments'] })
+ navigate({
+ search: (s) => ({
+ ...s,
+ filters: null,
+ labels: null
+ }),
+ state: {
+ expandedSegment: null
+ }
+ })
+ setModal(null)
+ showToast({ message: 'Segment deleted' })
+ }
+ })
+}
diff --git a/assets/test-utils/mock-api.ts b/assets/test-utils/mock-api.ts
index b68b631a5a..1a379ac1dd 100644
--- a/assets/test-utils/mock-api.ts
+++ b/assets/test-utils/mock-api.ts
@@ -22,7 +22,12 @@ export class MockAPI {
// sets get handler
public get(
urlWithoutQueryString: string,
- responseHandler: typeof fetch | Record<string, unknown> | number | null
+ responseHandler:
+ | typeof fetch
+ | Record<string, unknown>
+ | unknown[]
+ | number
+ | null
): jest.Mock {
return this.register('get', urlWithoutQueryString, responseHandler)
}
@@ -46,7 +51,12 @@ export class MockAPI {
private register(
method: string,
urlWithoutQueryString: string,
- responseHandler: typeof fetch | Record<string, unknown> | number | null
+ responseHandler:
+ | typeof fetch
+ | Record<string, unknown>
+ | unknown[]
+ | number
+ | null
): jest.Mock {
const handler: typeof fetch =
typeof responseHandler === 'function'
diff --git a/e2e/tests/dashboard/segments.spec.ts b/e2e/tests/dashboard/segments.spec.ts
index 90242a21a7..dcaf51024e 100644
--- a/e2e/tests/dashboard/segments.spec.ts
+++ b/e2e/tests/dashboard/segments.spec.ts
@@ -102,9 +102,9 @@ test('saving a segment', async ({ page, request }) => {
modal(page).getByRole('heading', { name: 'Create segment' })
).toBeVisible()
- await expect(
- modal(page).getByPlaceholder('Source is Facebook')
- ).toHaveAccessibleName('Segment name')
+ await expect(modal(page).getByLabel('Segment name')).toHaveValue(
+ 'Source is Facebook'
+ )
await expect(
modal(page).getByRole('radio', { name: 'Personal segment' })
@@ -180,9 +180,9 @@ test('saving a segment', async ({ page, request }) => {
modal(page).getByRole('heading', { name: 'Create segment' })
).toBeVisible()
- await expect(
- modal(page).getByPlaceholder('UTM source is Adwords and Source is Google')
- ).toHaveAccessibleName('Segment name')
+ await expect(modal(page).getByLabel('Segment name')).toHaveValue(
+ 'UTM source is Adwords and Source is Google'
+ )
await modal(page).getByLabel('Segment name').fill('Ads from Google')
@@ -272,6 +272,10 @@ test('editing an existing segment', async ({ page, request }) => {
modal(page).getByRole('heading', { name: 'Update segment' })
).toBeVisible()
+ await expect(modal(page).getByLabel('Segment name')).toHaveValue(
+ 'Traffic from Google'
+ )
+
await modal(page).getByLabel('Segment name').fill('Ads from Google')
await modal(page).getByRole('button', { name: 'Save' }).click()