Add form responses v2 endpoint #29043

CGastrell · 2023-02-20T15:27:33Z

Proposed changes:

This PR adds wpcom/v2/form-responses endpoint as the target for WPCOM's D102076-code

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Does this pull request change what data or activity we track or use?

Testing instructions:

On docker, add these 2 lines on plugins/jetpack/modules/contact-form.php:

add_filter( 'jetpack_contact_form_use_package', '__return_true' );
add_filter( 'jetpack_forms_dashboard_enable', '__return_true' );

Then head to http://localhost/wp-admin/admin.php?page=jetpack-forms to get a mock of the new inbox page. Open devtools and type this on the console:

wp.apiFetch({path: '/wpcom/v2/forms/responses'}).then(r=>console.log(r))

You should get a list of form responses.

github-actions · 2023-02-20T15:29:06Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
⚠️ All commits were linted before commit.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team review" label and ask someone from your team review the code.
Once you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

Jetpack plugin:

Next scheduled release: March 7, 2023.
Scheduled code freeze: February 28, 2023.

github-actions · 2023-02-20T15:29:13Z

Are you an Automattician? You can now test your Pull Request on WordPress.com. On your sandbox, run

bin/jetpack-downloader test jetpack add/form-responses-v2-endpoint

to get started. More details: p9dueE-5Nn-p2

…kage. Mapped through from .com

… testing

ice9js

Works for me! Code looks clean too, just left one comment but nothing blocking 👍

projects/packages/forms/src/class-wpcom-rest-api-v2-endpoint-forms.php

fgiannar

Nice job, Christian!

Left a couple inline comments. Many thanks for working on this!

projects/packages/forms/src/class-wpcom-rest-api-v2-endpoint-forms.php

…nd is_wpcom var

CGastrell · 2023-02-23T17:05:58Z

@fgiannar all wonderful suggestions, thanks! I think I've addressed them all.

I did search for more explicit docs on those validate_callback params (though they seem very simple) but couldn't find any. Shall you have some links on that, appreciated (.org docs didn't mention much).

fgiannar · 2023-02-24T11:30:04Z

@fgiannar all wonderful suggestions, thanks! I think I've addressed them all.

Excellent work, thank you! I only have two more suggestions:

Regarding the usage of is_user_member_of_blog : This will always return true if Multisite is not enabled so maybe it's best to use a capabilities check instead?
Not a blocker: How would you feel about adding a few unit tests for the endpoint you introduced?

I did search for more explicit docs on those validate_callback params (though they seem very simple) but couldn't find any. Shall you have some links on that, appreciated (.org docs didn't mention much).

https://shawnhooper.ca/2017/02/15/wp-rest-secrets-found-reading-core-code/

CGastrell · 2023-02-24T14:58:21Z

Regarding the usage of is_user_member_of_blog : This will always return true if Multisite is not enabled so maybe it's best to use a capabilities check instead?

Oh boy, there was a current_user_can( 'manage_options' ) there, I don't know when it went out the window 😬 Reinstated now. manage_options might sound too restrictive, but we'll start there and see how it goes.

Not a blocker: How would you feel about adding a few unit tests for the endpoint you introduced?

I've been scouting how to do so, but a lot of the rest testing libs reside only on WPCOM. We're looking to have better/more testing on the package, maybe even bring some of the libs to the package to be able to do so, but I think we can keep at it as continuous effort on further iterations. I'll look on other packages to see how they got it, but for now I'd like to move this forward.

Thanks for the reviews!

fgiannar · 2023-02-24T15:12:12Z

projects/packages/forms/src/class-wpcom-rest-api-v2-endpoint-forms.php

+			return $site_id;
+		}
+
+		if ( ! current_user_can( 'manage_options' ) || ! is_user_member_of_blog( get_current_user_id(), $site_id ) ) {


With current_user_can( 'manage_options' ) in place, then is_user_member_of_blog( get_current_user_id(), $site_id ) becomes redundant, right?

In that case we don't need the $site_id as well I guess.

User might be member of blog but not have management capabilities? Is that not a possible scenario?

No worries, doesn't hurt anyway :)

I followed up on this conversation in #35571 after discussion in p1707435111778979-slack-C05PV073SG3

fgiannar

Thanks for addressing all my comments! Appreciate your effort 👍

* [not verified] add form-responses endpoint to be handled by forms package. Mapped through from .com * [not verified] changelog * fix typo on class name * [not verified] add backend code for v2/v4 endpoint * changelog * fixup project versions * use wpcom/v2 instead of jetpack/v4 * update apiRoot backend config JS * remove unnecessary plugin endpoint file, add api-fetch dependency for testing * rename controller file to reflect forms base path * instance the right class name after change * fix route register handler name * edit comments/docblocks * use simpler validation through args props * use Jetpack\Connection\Manager to get site ID, remove unneeded code and is_wpcom var * get the date from post, not from parsed content * add capability check to the endpoint permission callback

This is a follow-up to #29043. When registering the endpoint, we used the wrong parameter to define permissions.

CGastrell self-assigned this Feb 20, 2023

github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Feb 20, 2023

github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Feb 20, 2023

CGastrell added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Feb 20, 2023

CGastrell requested review from donnchawp and ice9js February 20, 2023 15:41

CGastrell added 3 commits February 21, 2023 11:19

[not verified] add form-responses endpoint to be handled by forms pac…

b6e7c31

…kage. Mapped through from .com

[not verified] changelog

81fee64

fix typo on class name

3e9e495

CGastrell force-pushed the add/form-responses-v2-endpoint branch from 342844c to 3e9e495 Compare February 21, 2023 14:23

CGastrell added 2 commits February 21, 2023 13:10

[not verified] add backend code for v2/v4 endpoint

e109544

changelog

874df2c

github-actions bot added the [Package] Forms label Feb 21, 2023

CGastrell added 3 commits February 21, 2023 14:10

fixup project versions

13681a6

use wpcom/v2 instead of jetpack/v4

6b5c7d8

update apiRoot backend config JS

e0426c9

fgiannar self-requested a review February 22, 2023 09:43

CGastrell added 4 commits February 22, 2023 13:07

remove unnecessary plugin endpoint file, add api-fetch dependency for…

d31808d

… testing

rename controller file to reflect forms base path

618e08a

instance the right class name after change

8200b86

fix route register handler name

b2c1e07

ice9js previously approved these changes Feb 22, 2023

View reviewed changes

projects/packages/forms/src/class-wpcom-rest-api-v2-endpoint-forms.php Outdated Show resolved Hide resolved

CGastrell added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] Needs Team Review labels Feb 22, 2023

fgiannar requested changes Feb 23, 2023

View reviewed changes

CGastrell added 2 commits February 23, 2023 13:58

edit comments/docblocks

601f371

use simpler validation through args props

2738848

use Jetpack\Connection\Manager to get site ID, remove unneeded code a…

d12459e

…nd is_wpcom var

CGastrell dismissed ice9js’s stale review via d12459e February 23, 2023 17:01

CGastrell requested a review from fgiannar February 23, 2023 17:45

get the date from post, not from parsed content

a5627a7

add capability check to the endpoint permission callback

795347d

fgiannar reviewed Feb 24, 2023

View reviewed changes

fgiannar approved these changes Feb 24, 2023

View reviewed changes

fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels Feb 24, 2023

CGastrell added 2 commits February 24, 2023 12:52

Merge branch 'trunk' into add/form-responses-v2-endpoint

ba13141

Merge branch 'trunk' into add/form-responses-v2-endpoint

671aded

CGastrell enabled auto-merge (squash) February 24, 2023 17:43

CGastrell merged commit 5bf1755 into trunk Feb 24, 2023

CGastrell deleted the add/form-responses-v2-endpoint branch February 24, 2023 17:54

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Feb 24, 2023

github-actions bot added this to the jetpack/11.9 milestone Feb 24, 2023

jeherve added a commit that referenced this pull request Mar 1, 2023

Forms: fix permission check in Responses endpoint

d8e76f1

This is a follow-up to #29043. When registering the endpoint, we used the wrong parameter to define permissions.

jeherve mentioned this pull request Mar 1, 2023

Forms: fix permission check in Responses endpoint #29223

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add form responses v2 endpoint #29043

Add form responses v2 endpoint #29043

CGastrell commented Feb 20, 2023 •

edited

github-actions bot commented Feb 20, 2023 •

edited

github-actions bot commented Feb 20, 2023 •

edited

ice9js left a comment

fgiannar left a comment

CGastrell commented Feb 23, 2023

fgiannar commented Feb 24, 2023

CGastrell commented Feb 24, 2023

fgiannar Feb 24, 2023

CGastrell Feb 24, 2023

fgiannar Feb 24, 2023

jeherve Feb 9, 2024

fgiannar left a comment

Add form responses v2 endpoint #29043

Add form responses v2 endpoint #29043

Conversation

CGastrell commented Feb 20, 2023 • edited

Proposed changes:

Other information:

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Feb 20, 2023 • edited

github-actions bot commented Feb 20, 2023 • edited

ice9js left a comment

Choose a reason for hiding this comment

fgiannar left a comment

Choose a reason for hiding this comment

CGastrell commented Feb 23, 2023

fgiannar commented Feb 24, 2023

CGastrell commented Feb 24, 2023

fgiannar Feb 24, 2023

Choose a reason for hiding this comment

CGastrell Feb 24, 2023

Choose a reason for hiding this comment

fgiannar Feb 24, 2023

Choose a reason for hiding this comment

jeherve Feb 9, 2024

Choose a reason for hiding this comment

fgiannar left a comment

Choose a reason for hiding this comment

CGastrell commented Feb 20, 2023 •

edited

github-actions bot commented Feb 20, 2023 •

edited

github-actions bot commented Feb 20, 2023 •

edited