Interactivity: Restore scope when yielded promise rejects #59708
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "$schema": "https://schemas.wp.org/trunk/block.json", | ||
| "apiVersion": 2, | ||
| "name": "test/generator-scope", | ||
| "title": "E2E Interactivity tests - generator scope", | ||
| "category": "text", | ||
| "icon": "heart", | ||
| "description": "", | ||
| "supports": { | ||
| "interactivity": true | ||
| }, | ||
| "textdomain": "e2e-interactivity", | ||
| "viewScriptModule": "file:./view.js", | ||
| "render": "file:./render.php" | ||
| } |
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,16 @@ | ||
| <?php | ||
| /** | ||
| * HTML for testing scope restoration with generators. | ||
| * | ||
| * @package gutenberg-test-interactive-blocks | ||
| */ | ||
| ?> | ||
|
|
||
| <div | ||
| data-wp-interactive="test/generator-scope" | ||
| <?php echo wp_interactivity_data_wp_context( array( 'result' => '' ) ); ?> | ||
| > | ||
| <input readonly data-wp-bind--value="context.result" data-testid="result" /> | ||
| <button type="button" data-wp-on--click="callbacks.resolve" data-testid="resolve">Async resolve</button> | ||
| <button type="button" data-wp-on--click="callbacks.reject" data-testid="reject">Async reject</button> | ||
| </div> |
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 @@ | ||
| <?php return array( 'dependencies' => array( '@wordpress/interactivity' ) ); |
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,23 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { store, getContext } from '@wordpress/interactivity'; | ||
|
|
||
| store( 'test/generator-scope', { | ||
| callbacks: { | ||
| *resolve() { | ||
| try { | ||
| getContext().result = yield Promise.resolve( 'ok' ); | ||
| } catch ( err ) { | ||
| getContext().result = err.toString(); | ||
| } | ||
| }, | ||
| *reject() { | ||
| try { | ||
| getContext().result = yield Promise.reject( new Error( '😘' ) ); | ||
| } catch ( err ) { | ||
| getContext().result = err.toString(); | ||
| } | ||
| }, | ||
| }, | ||
| } ); |
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,31 @@ | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { test, expect } from './fixtures'; | ||
|
|
||
| test.describe( 'async actions', () => { | ||
| test.beforeAll( async ( { interactivityUtils: utils } ) => { | ||
| await utils.activatePlugins(); | ||
| await utils.addPostWithBlock( 'test/generator-scope' ); | ||
| } ); | ||
| test.beforeEach( async ( { interactivityUtils: utils, page } ) => { | ||
| await page.goto( utils.getLink( 'test/generator-scope' ) ); | ||
| } ); | ||
| test.afterAll( async ( { interactivityUtils: utils } ) => { | ||
| await utils.deactivatePlugins(); | ||
| await utils.deleteAllPosts(); | ||
| } ); | ||
|
|
||
| test( 'Promise generator callbacks should restore scope on resolve and reject', async ( { | ||
| page, | ||
| } ) => { | ||
| const resultInput = page.getByTestId( 'result' ); | ||
| await expect( resultInput ).toHaveValue( '' ); | ||
|
|
||
| await page.getByTestId( 'resolve' ).click(); | ||
| await expect( resultInput ).toHaveValue( 'ok' ); | ||
|
|
||
| await page.getByTestId( 'reject' ).click(); | ||
| await expect( resultInput ).toHaveValue( 'Error: 😘' ); | ||
| } ); | ||
| } ); |
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.
@DAreRodz I tried 2 different approaches and they both fixed my test case. I wasn't sure why we have 2 try blocks, so my first version merge the try/finally and try/catch into one try/catch/finally. Then, since I wasn't sure what the motivation for 2 blocks were, I changed use 2 blocks. I'd like to get your insight here.
Both versions are on this branch in different commits and can be reviewed.
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.
I think this is the best approach: to have two separate try-catch blocks. The thing with async actions is that they can change the scope at any time―whenever they run―, thus leading to unexpected results when the scope is reset.
We decided here to set/reset the scope for synchronous code fragments, i.e., the generator code from one
yieldto the next one. So, from my understanding, we should reset the scope, then wait for the promise to be fulfilled (which will probably set their own scope), and if it fails, then set/reset the scope again.