Skip to content

feat: Filters prefix #2014

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 26, 2025
Merged

feat: Filters prefix #2014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d3df49a
feat(FiltersContext): add filtersNamePrefix prop
stephenlago99 Feb 5, 2025
9e1ac62
feat(FiltersUtils): remove prefix from query filters
stephenlago99 Feb 5, 2025
d4a9e06
feat(useFilters): use prefix
stephenlago99 Feb 5, 2025
2714dde
feat(useFilters): make prefix mandatory
stephenlago99 Feb 6, 2025
02f441b
feat(CustomersList): add filter prefix
stephenlago99 Feb 6, 2025
1cf6cf3
misc: make sure helpers uses filter prefix to check params
ansmonjol Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/components/creditNote/CreditNotesTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
import { AvailableFiltersEnum, Filters } from '~/components/designSystem/Filters'
import { GenericPlaceholder } from '~/components/GenericPlaceholder'
import { addToast } from '~/core/apolloClient'
import { CREDIT_NOTE_LIST_FILTER_PREFIX } from '~/core/constants/filters'
import { intlFormatNumber } from '~/core/formats/intlFormatNumber'
import { CUSTOMER_INVOICE_CREDIT_NOTE_DETAILS_ROUTE } from '~/core/router'
import { deserializeAmount } from '~/core/serializers/serializeAmount'
Expand Down Expand Up @@ -158,6 +159,7 @@ const CreditNotesTable = ({
)}
>
<Filters.Provider
filtersNamePrefix={CREDIT_NOTE_LIST_FILTER_PREFIX}
availableFilters={[
AvailableFiltersEnum.amount,
AvailableFiltersEnum.creditNoteCreditStatus,
Expand Down
83 changes: 59 additions & 24 deletions src/components/designSystem/Filters/__tests__/useFilters.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import {
isVoidedUrlParams,
} from '../utils'

const FILTER_PREFIX = 'f'

const staticFilters = {
currency: 'eur',
}
Expand All @@ -32,6 +34,7 @@ const wrapper = ({
<div>
<FilterContext.Provider
value={{
filtersNamePrefix: FILTER_PREFIX,
staticFilters: withStaticFilters ? staticFilters : undefined,
availableFilters: [AvailableFiltersEnum.status, AvailableFiltersEnum.invoiceType],
}}
Expand All @@ -49,7 +52,7 @@ describe('draft', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'status=draft'
const expectedSearchParams = 'f_status=draft'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -61,14 +64,14 @@ describe('draft', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isDraftUrlParams(draftSearchParams)).toBe(true)
expect(isDraftUrlParams({ prefix: FILTER_PREFIX, searchParams: draftSearchParams })).toBe(true)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&status=draft'
const expectedSearchParams = 'f_currency=eur&f_status=draft'

const draftSearchParams = new Map(
new URLSearchParams(`?${expectedSearchParams}`).entries(),
Expand All @@ -79,7 +82,7 @@ describe('draft', () => {
status: InvoiceStatusTypeEnum.Draft,
}),
).toEqual(expectedSearchParams)
expect(isDraftUrlParams(draftSearchParams)).toBe(true)
expect(isDraftUrlParams({ prefix: FILTER_PREFIX, searchParams: draftSearchParams })).toBe(true)
})
})

Expand All @@ -89,7 +92,7 @@ describe('outstanding', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'paymentStatus=failed,pending&status=finalized'
const expectedSearchParams = 'f_paymentStatus=failed,pending&f_status=finalized'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -102,14 +105,16 @@ describe('outstanding', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isOutstandingUrlParams(outstandingSearchParams)).toBe(true)
expect(
isOutstandingUrlParams({ prefix: FILTER_PREFIX, searchParams: outstandingSearchParams }),
).toBe(true)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&paymentStatus=failed,pending&status=finalized'
const expectedSearchParams = 'f_currency=eur&f_paymentStatus=failed,pending&f_status=finalized'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -122,7 +127,9 @@ describe('outstanding', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isOutstandingUrlParams(outstandingSearchParams)).toBe(true)
expect(
isOutstandingUrlParams({ prefix: FILTER_PREFIX, searchParams: outstandingSearchParams }),
).toBe(true)
})
})

Expand All @@ -132,7 +139,7 @@ describe('payment overdue', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'paymentOverdue=true'
const expectedSearchParams = 'f_paymentOverdue=true'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -144,14 +151,19 @@ describe('payment overdue', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isPaymentOverdueUrlParams(paymentOverdueSearchParams)).toBe(true)
expect(
isPaymentOverdueUrlParams({
prefix: FILTER_PREFIX,
searchParams: paymentOverdueSearchParams,
}),
).toBe(true)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&paymentOverdue=true'
const expectedSearchParams = 'f_currency=eur&f_paymentOverdue=true'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -163,7 +175,12 @@ describe('payment overdue', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isPaymentOverdueUrlParams(paymentOverdueSearchParams)).toBe(true)
expect(
isPaymentOverdueUrlParams({
prefix: FILTER_PREFIX,
searchParams: paymentOverdueSearchParams,
}),
).toBe(true)
})
})

Expand All @@ -173,7 +190,7 @@ describe('succeeded', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'paymentStatus=succeeded&status=finalized'
const expectedSearchParams = 'f_paymentStatus=succeeded&f_status=finalized'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -186,14 +203,16 @@ describe('succeeded', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isSucceededUrlParams(succeededSearchParams)).toBe(true)
expect(
isSucceededUrlParams({ prefix: FILTER_PREFIX, searchParams: succeededSearchParams }),
).toBe(true)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&paymentStatus=succeeded&status=finalized'
const expectedSearchParams = 'f_currency=eur&f_paymentStatus=succeeded&f_status=finalized'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -206,7 +225,9 @@ describe('succeeded', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isSucceededUrlParams(succeededSearchParams)).toBe(true)
expect(
isSucceededUrlParams({ prefix: FILTER_PREFIX, searchParams: succeededSearchParams }),
).toBe(true)
})
})

Expand All @@ -216,7 +237,7 @@ describe('voided', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'status=voided'
const expectedSearchParams = 'f_status=voided'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -228,14 +249,16 @@ describe('voided', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isVoidedUrlParams(voidedSearchParams)).toBe(true)
expect(isVoidedUrlParams({ prefix: FILTER_PREFIX, searchParams: voidedSearchParams })).toBe(
true,
)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&status=voided'
const expectedSearchParams = 'f_currency=eur&f_status=voided'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -247,7 +270,9 @@ describe('voided', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isVoidedUrlParams(voidedSearchParams)).toBe(true)
expect(isVoidedUrlParams({ prefix: FILTER_PREFIX, searchParams: voidedSearchParams })).toBe(
true,
)
})
})

Expand All @@ -257,7 +282,7 @@ describe('payment dispute lost', () => {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: false }),
})

const expectedSearchParams = 'paymentDisputeLost=true'
const expectedSearchParams = 'f_paymentDisputeLost=true'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -269,14 +294,19 @@ describe('payment dispute lost', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isPaymentDisputeLostUrlParams(paymentDisputeLostSearchParams)).toBe(true)
expect(
isPaymentDisputeLostUrlParams({
prefix: FILTER_PREFIX,
searchParams: paymentDisputeLostSearchParams,
}),
).toBe(true)
})
it('should return search params with initial static filters', () => {
const { result } = renderHook(() => useFilters(), {
wrapper: ({ children }) => wrapper({ children, withStaticFilters: true }),
})

const expectedSearchParams = 'currency=eur&paymentDisputeLost=true'
const expectedSearchParams = 'f_currency=eur&f_paymentDisputeLost=true'

expect(
result.current.buildQuickFilterUrlParams({
Expand All @@ -288,6 +318,11 @@ describe('payment dispute lost', () => {
new URLSearchParams(`?${expectedSearchParams}`).entries(),
) as unknown as URLSearchParams

expect(isPaymentDisputeLostUrlParams(paymentDisputeLostSearchParams)).toBe(true)
expect(
isPaymentDisputeLostUrlParams({
prefix: FILTER_PREFIX,
searchParams: paymentDisputeLostSearchParams,
}),
).toBe(true)
})
})
1 change: 1 addition & 0 deletions src/components/designSystem/Filters/context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ interface FilterContextType {
availableFilters: AvailableFiltersEnum[]
quickFiltersType?: AvailableQuickFilters
staticFilters?: Partial<Record<AvailableFiltersEnum, unknown>>
filtersNamePrefix: string
}

export const FilterContext = createContext<FilterContextType | undefined>(undefined)
Expand Down
Loading
Loading