Remove members-forward route #27040
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import {render, screen} from '@testing-library/react'; | ||
| import React from 'react'; | ||
| import {beforeEach, describe, expect, it, vi} from 'vitest'; | ||
| import {MembersRouteGate} from './members-route-gate'; | ||
|
|
||
| const {mockUseLocation, mockUseFeatureFlag} = vi.hoisted(() => ({ | ||
| mockUseLocation: vi.fn(), | ||
| mockUseFeatureFlag: vi.fn() | ||
| })); | ||
|
|
||
| vi.mock('@tryghost/admin-x-framework', () => ({ | ||
| Outlet: () => React.createElement('div', {'data-testid': 'outlet'}), | ||
| useLocation: mockUseLocation | ||
| })); | ||
|
|
||
| vi.mock('./ember-bridge', () => ({ | ||
| EmberFallback: () => React.createElement('div', {'data-testid': 'ember-fallback'}) | ||
| })); | ||
|
|
||
| vi.mock('./hooks/use-feature-flag', () => ({ | ||
| useFeatureFlag: mockUseFeatureFlag | ||
| })); | ||
|
|
||
| describe('MembersRouteGate', () => { | ||
| beforeEach(() => { | ||
| mockUseFeatureFlag.mockReturnValue(false); | ||
| mockUseLocation.mockReturnValue({pathname: '/members'}); | ||
| }); | ||
|
|
||
| it('delegates /members/ to Ember when the flag is disabled', () => { | ||
| mockUseLocation.mockReturnValue({pathname: '/members/'}); | ||
|
|
||
| render(<MembersRouteGate />); | ||
|
|
||
| expect(screen.getByTestId('ember-fallback')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('delegates /members/import to Ember when the flag is disabled', () => { | ||
| mockUseLocation.mockReturnValue({pathname: '/members/import'}); | ||
|
|
||
| render(<MembersRouteGate />); | ||
|
|
||
| expect(screen.getByTestId('ember-fallback')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('renders React routes when the flag is enabled', () => { | ||
| mockUseFeatureFlag.mockReturnValue(true); | ||
| mockUseLocation.mockReturnValue({pathname: '/members/import'}); | ||
|
|
||
| render(<MembersRouteGate />); | ||
|
|
||
| expect(screen.getByTestId('outlet')).toBeInTheDocument(); | ||
| }); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import {Outlet} from "@tryghost/admin-x-framework"; | ||
| import {EmberFallback} from "./ember-bridge"; | ||
| import {useFeatureFlag} from "./hooks/use-feature-flag"; | ||
|
|
||
| export function MembersRouteGate() { | ||
| const membersForwardEnabled = useFeatureFlag("membersForward"); | ||
|
|
||
| if (!membersForwardEnabled) { | ||
| return <EmberFallback />; | ||
jonatansberg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| return <Outlet />; | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide resolved
jonatansberg marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import {render, screen} from '@testing-library/react'; | ||
| import React from 'react'; | ||
| import {beforeEach, describe, expect, it, vi} from 'vitest'; | ||
| import {MembersRoute} from './members-route'; | ||
|
|
||
| const {mockCanManageMembers, mockUseCurrentUser} = vi.hoisted(() => ({ | ||
| mockCanManageMembers: vi.fn(), | ||
| mockUseCurrentUser: vi.fn() | ||
| })); | ||
|
|
||
| vi.mock('@tryghost/admin-x-framework', () => ({ | ||
| Navigate: ({replace, to}: {replace?: boolean; to: string}) => React.createElement('div', { | ||
| 'data-replace': String(Boolean(replace)), | ||
| 'data-testid': 'navigate', | ||
| 'data-to': to | ||
| }) | ||
| })); | ||
|
|
||
| vi.mock('@tryghost/admin-x-framework/api/current-user', () => ({ | ||
| useCurrentUser: mockUseCurrentUser | ||
| })); | ||
|
|
||
| vi.mock('@tryghost/admin-x-framework/api/users', () => ({ | ||
| canManageMembers: mockCanManageMembers | ||
| })); | ||
|
|
||
| vi.mock('./members-route-gate', () => ({ | ||
| MembersRouteGate: () => React.createElement('div', {'data-testid': 'members-route-gate'}) | ||
| })); | ||
|
|
||
| describe('MembersRoute', () => { | ||
| beforeEach(() => { | ||
| mockCanManageMembers.mockReturnValue(true); | ||
| mockUseCurrentUser.mockReturnValue({ | ||
| data: { | ||
| id: '1', | ||
| roles: [{name: 'Administrator'}] | ||
| }, | ||
| isError: false, | ||
| isLoading: false | ||
| }); | ||
| }); | ||
|
|
||
| it('renders the members route gate for authorized users', () => { | ||
| render(<MembersRoute />); | ||
|
|
||
| expect(screen.getByTestId('members-route-gate')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('redirects users without member permissions to home', () => { | ||
| mockCanManageMembers.mockReturnValue(false); | ||
|
|
||
| render(<MembersRoute />); | ||
|
|
||
| expect(screen.getByTestId('navigate')).toHaveAttribute('data-to', '/'); | ||
| expect(screen.getByTestId('navigate')).toHaveAttribute('data-replace', 'true'); | ||
| }); | ||
|
|
||
| it('renders nothing while the current user is still loading', () => { | ||
| mockUseCurrentUser.mockReturnValue({ | ||
| data: undefined, | ||
| isError: false, | ||
| isLoading: true | ||
| }); | ||
|
|
||
| const {container} = render(<MembersRoute />); | ||
|
|
||
| expect(container).toBeEmptyDOMElement(); | ||
| }); | ||
|
|
||
| it('redirects to home when the current user is unavailable after loading', () => { | ||
| mockUseCurrentUser.mockReturnValue({ | ||
| data: undefined, | ||
| isError: false, | ||
| isLoading: false | ||
| }); | ||
|
|
||
| render(<MembersRoute />); | ||
|
|
||
| expect(screen.getByTestId('navigate')).toHaveAttribute('data-to', '/'); | ||
| }); | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import {Navigate} from "@tryghost/admin-x-framework"; | ||
| import {useCurrentUser} from "@tryghost/admin-x-framework/api/current-user"; | ||
| import {canManageMembers} from "@tryghost/admin-x-framework/api/users"; | ||
| import {MembersRouteGate} from "./members-route-gate"; | ||
|
|
||
| export function MembersRoute() { | ||
| const {data: currentUser, isError, isLoading} = useCurrentUser(); | ||
|
|
||
| if (!currentUser) { | ||
| if (isError || !isLoading) { | ||
| return <Navigate replace to="/" />; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| if (!canManageMembers(currentUser)) { | ||
| return <Navigate replace to="/" />; | ||
| } | ||
|
|
||
| return <MembersRouteGate />; | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The members route gate now explicitly treats
/members/as the members list, but this check only matches'/members', so a trailing-slash URL leaves all member saved views inactive even when the filter matches. This creates inconsistent sidebar state for bookmarked/manual/members/URLs; normalizing trailing slashes here (as done in the gate) avoids that mismatch.Useful? React with 👍 / 👎.