-
Notifications
You must be signed in to change notification settings - Fork 154
Utils: Preserve omitted ability input #775
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.
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
Open
jorgefilipecosta
wants to merge
1
commit into
develop
Choose a base branch
from
codex/run-ability-omitted-input
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−9
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { executeAbility } from '@wordpress/abilities'; | ||
| import apiFetch from '@wordpress/api-fetch'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { runAbility } from '../../src/utils/run-ability'; | ||
|
|
||
| jest.mock( '@wordpress/api-fetch', () => jest.fn() ); | ||
| jest.mock( '@wordpress/core-abilities', () => ( { | ||
| ready: Promise.resolve(), | ||
| } ) ); | ||
| jest.mock( '@wordpress/abilities', () => ( { | ||
| executeAbility: jest.fn(), | ||
| } ) ); | ||
|
|
||
| describe( 'runAbility', () => { | ||
| const mockedApiFetch = apiFetch as jest.Mock; | ||
| const mockedExecuteAbility = executeAbility as jest.Mock; | ||
|
|
||
| beforeEach( () => { | ||
| jest.clearAllMocks(); | ||
| jest.spyOn( console, 'error' ).mockImplementation( () => undefined ); | ||
| jest.spyOn( console, 'warn' ).mockImplementation( () => undefined ); | ||
|
|
||
| mockedApiFetch.mockResolvedValue( 'fallback result' ); | ||
| mockedExecuteAbility.mockResolvedValue( 'client result' ); | ||
| } ); | ||
|
|
||
| afterEach( () => { | ||
| jest.restoreAllMocks(); | ||
| } ); | ||
|
|
||
| it( 'passes omitted input to the client ability as undefined', async () => { | ||
| const result = await runAbility( 'core/users' ); | ||
|
|
||
| expect( result ).toBe( 'client result' ); | ||
| expect( mockedExecuteAbility ).toHaveBeenCalledWith( | ||
| 'core/users', | ||
| undefined | ||
| ); | ||
| expect( mockedApiFetch ).not.toHaveBeenCalled(); | ||
| } ); | ||
|
|
||
| it( 'omits REST input data when fallback runs without input', async () => { | ||
| mockedExecuteAbility.mockRejectedValueOnce( | ||
| Object.assign( new Error( 'Ability not found' ), { | ||
| code: 'ability_not_found', | ||
| } ) | ||
| ); | ||
|
|
||
| const result = await runAbility( 'core/users' ); | ||
|
|
||
| expect( result ).toBe( 'fallback result' ); | ||
| expect( mockedApiFetch ).toHaveBeenCalledWith( { | ||
| path: '/wp-abilities/v1/abilities/core/users/run', | ||
| method: 'POST', | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'keeps explicit empty-object input in REST fallback data', async () => { | ||
| mockedExecuteAbility.mockRejectedValueOnce( | ||
| Object.assign( new Error( 'Ability not found' ), { | ||
| code: 'ability_not_found', | ||
| } ) | ||
| ); | ||
|
|
||
| const result = await runAbility( 'core/users', {} ); | ||
|
|
||
| expect( result ).toBe( 'fallback result' ); | ||
| expect( mockedApiFetch ).toHaveBeenCalledWith( { | ||
| path: '/wp-abilities/v1/abilities/core/users/run', | ||
| method: 'POST', | ||
| data: { | ||
| input: {}, | ||
| }, | ||
| } ); | ||
| } ); | ||
| } ); |
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.
We don't currently have any unit tests for our TS files. While I'm not opposed to getting that added, that will require more than just a single test file, we'll need all the underlying code to run those tests as well (and get those set up in CI). May be worth doing that in a separate PR instead of rolling into this one