Contact Form: Removing code and renaming relevant references to ensure we use the package version #37157

coder-karen · 2024-05-01T14:16:08Z

Fixes step 2 of this project: pf5801-Aj-p2

Proposed changes:

This PR addresses step 2 of this project: pf5801-Aj-p2. Specifically, it focusses on the following:
- Deleting module/contact-form files.
- Updating any references to deleted files, classes or functions to use the package version

Note - before merging, this diff needs to be deployed first: D147229-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)?

Jetpack product discussion

pf5801-Aj-p2

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

No.

Testing instructions:

To test, apply this PR and make sure to test the contact form (block, also using the Classic Editor) on a test site and ensure that it continues to work as expected.
Ensure no errors are being reported in logs.

…package version will always be used

github-actions · 2024-05-01T14:17:21Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the remove/contact-form-module-code branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack remove/contact-form-module-code

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2024-05-01T14:17:21Z

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.
✅ 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 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 reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for June 4, 2024 (scheduled code freeze on May 27, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

…new package paths

projects/plugins/crm/changelog/remove-contact-form-module-code

jeherve · 2024-05-02T09:56:12Z

projects/plugins/jetpack/_inc/lib/class-jetpack-google-drive-helper.php

@@ -1,126 +0,0 @@
-<?php


Since the class or the file were not marked as deprecated before, I would recommend keeping that file around for a couple more releases, but mark them as deprecated so they throw a notice instead of a fatal for anyone that may still rely on them.

Thanks for pointing that out. Added back and marking as deprecated now in ded8b13

jeherve · 2024-05-02T09:57:02Z

projects/plugins/jetpack/class.jetpack-gutenberg.php

-				 * Prevent the registration of the blocks from extensions/blocks/contact-form
-				 * if the Forms package is enabled.
-				 */
-				'is_form_package_enabled'       => apply_filters( 'jetpack_contact_form_use_package', true ),


You should be able to add that deprecated hook to the deprecated_hooks method in the Jetpack class.

Ah good to know.

jeherve · 2024-05-02T09:58:55Z

projects/plugins/jetpack/modules/contact-form.php

@@ -35,24 +35,6 @@
 	return true; // Not returning true will cause the module to become deactivated.


Should we remove the check provided by the filter above now and deprecate the filter, since there is no other way to use the contact form anymore?

I did wonder, especially with the comment after return true. But everything works well in testing so this looks like it should be ok to deprecate. I'll add an update to the WPcom diff as well as there is one more filter mention there.

jeherve · 2024-05-02T09:59:58Z

projects/plugins/jetpack/modules/contact-form.php

-if ( is_admin() && apply_filters_deprecated( 'tmp_grunion_allow_editor_view', array( true ), '13.2.0', '', 'This functionality will be removed in an upcoming version.' ) ) {
-	require_once __DIR__ . '/contact-form/grunion-editor-view.php';
-}
-
 /**
 * Register Jetpack Form patterns


I think we should be able to remove this as well, since it is provided in the package too.

Actually to double check, what code are you referring to removing?

The code that registers the patterns, jetpack_form_register_pattern. It's also in Utils::register_pattern()

Ah right, I was busy searching for the function name instead. So since it lives elsewhere now with a different function name, presumably I'd still need to deprecate this specific function initially first before deleting it, similarly to the Google Drive Helper functions? I've assumed so initially with a new commit.

Yes, I think that's the right thing to do! 👍

jeherve · 2024-05-02T10:02:25Z

projects/plugins/jetpack/tools/webpack.config.css.js

-	'modules/contact-form/css/editor-inline-editing-style',
-	'modules/contact-form/css/editor-style',
-	'modules/contact-form/css/editor-ui',
+	'jetpack_vendor/automattic/jetpack-forms/src/contact-form/css/editor-inline-editing-style',


Couldn't we remove those altogether, since they are built in the package via the projects/packages/forms/tools/webpack.config.contact-form.js config?

Yes definitely :) I just realized the issue now on rebuilding locally, and spotting some untracked rtl CSS files being generated.

jeherve · 2024-05-02T10:05:16Z

projects/packages/forms/src/contact-form/class-editor-view.php

 			'_inc/build/contact-form/js/tinymce-plugin-form-button.min.js',
-			'modules/contact-form/js/tinymce-plugin-form-button.js'
+			'jetpack_vendor/automattic/jetpack-forms/src/contact-form/js/tinymce-plugin-form-button.js'


Could we load those 2 references relatively from the dist dir instead?
https://github.com/Automattic/jetpack-forms/tree/1facd39f1b5d34ca8ed31b7f9d0fde2d8d94c540/dist/contact-form/js

…es as this is handled in the package

…ition to prevent build failure

…on notice in a function, resulting in a check failure

monsieur-z · 2024-05-03T17:55:59Z

It works seamlessly with the Gutenberg editor. However, some paths seem to be broken when using the classic editor.

…sed contact form

…module-code

coder-karen · 2024-05-06T08:46:22Z

It works seamlessly with the Gutenberg editor. However, some paths seem to be broken when using the classic editor.

Great catch, thanks. This will be fixed now in 387bd8f

monsieur-z

LGTM!

…e we use the package version (#37157)

coder-karen added 7 commits May 1, 2024 09:53

Removing contact form module files

77c6df9

Remove references in webpack.config.css.js and exclude lists

588cd5e

Remove or change references to contact form classes and files

bc1be50

Updating test references - removing test file

5aa778c

Removing is_form_package_enabled from enqueue_block_editor_assets as …

349f477

…package version will always be used

Deleting the duplicated Google Drive helper class

7277c52

changelog

3db1ec3

coder-karen added [Status] In Progress [Block] Contact Form Form block (also see Contact Form label) [Package] Forms labels May 1, 2024

coder-karen self-assigned this May 1, 2024

github-actions bot added [Feature] Contact Form [Focus] Compatibility Ensuring our products play well with third-parties [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels May 1, 2024

coder-karen added 2 commits May 1, 2024 15:27

mce_external_plugins file path update, and phan file reference removal

700f245

Updating webpack.config.css.js to re-add contact form files but with …

08b1d4c

…new package paths

coder-karen commented May 1, 2024

View reviewed changes

projects/plugins/crm/changelog/remove-contact-form-module-code Outdated Show resolved Hide resolved

coder-karen added 2 commits May 1, 2024 16:23

Update projects/plugins/crm/changelog/remove-contact-form-module-code

5fdb20a

Updating package versions, and removing unnecessary phan line

45a5fd7

coder-karen marked this pull request as ready for review May 1, 2024 16:07

coder-karen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels May 1, 2024

coder-karen requested a review from a team May 1, 2024 16:14

jeherve reviewed May 2, 2024

View reviewed changes

jeherve added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels May 2, 2024

coder-karen added 10 commits May 2, 2024 12:46

Adding back google drive helper file and adding deprecation notices

ded8b13

Deprecating a filter and removing unneeded code

db376c1

Ensuring jetpack/tools/webpack.config.css.js doesn't generate rtl fil…

36af504

…es as this is handled in the package

Modifying JS file references to take them from the dist folder instead

3ec6595

Merge branch 'trunk' into remove/contact-form-module-code

56f3f0d

Updates (composer.lock, phan baseline formatting) to fix failing checks

1e82c72

Manually adding Jetpack plugin version to deprecated_hooks filter add…

b7dbde1

…ition to prevent build failure

Adding in deprecations for the jetpack_form_register_pattern function

5028f70

Adding a line to the phan baseline because of a newly added deprecati…

c354ed7

…on notice in a function, resulting in a check failure

Converting tabs to spaces on one line

cf85f00

coder-karen added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. 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 May 2, 2024

coder-karen added 2 commits May 6, 2024 09:29

Modify tinyme editor file path to prevent issues loading shortcode ba…

387bd8f

…sed contact form

Merge remote-tracking branch 'origin/trunk' into remove/contact-form-…

a2b125a

…module-code

coder-karen requested a review from a team May 6, 2024 11:49

monsieur-z approved these changes May 6, 2024

View reviewed changes

coder-karen merged commit 9bf534c into trunk May 6, 2024
56 checks passed

coder-karen deleted the remove/contact-form-module-code branch May 6, 2024 16:17

github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label May 6, 2024

jeherve mentioned this pull request May 7, 2024

Contact Form: Failed to load plugin url: tinymce-plugin-form-button.min.js #10919

Closed

This was referenced May 7, 2024

Contact Form: Replacing the tinymce JS file path with non minified, preventing editor errors #37270

Merged

Contact form: Unhook the deprecated jetpack_form_register_pattern function #37278

Merged

pkuliga pushed a commit that referenced this pull request May 9, 2024

Contact Form: Removing code and renaming relevant references to ensur…

6c441c4

…e we use the package version (#37157)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Contact Form: Removing code and renaming relevant references to ensure we use the package version #37157

Contact Form: Removing code and renaming relevant references to ensure we use the package version #37157

coder-karen commented May 1, 2024 •

edited

Loading

github-actions bot commented May 1, 2024 •

edited

Loading

github-actions bot commented May 1, 2024 •

edited

Loading

jeherve May 2, 2024

coder-karen May 2, 2024

jeherve May 2, 2024

coder-karen May 2, 2024

jeherve May 2, 2024

coder-karen May 2, 2024

jeherve May 2, 2024

coder-karen May 2, 2024

coder-karen May 2, 2024

jeherve May 2, 2024

coder-karen May 2, 2024 •

edited

Loading

jeherve May 3, 2024

jeherve May 2, 2024

coder-karen May 2, 2024

jeherve May 2, 2024

coder-karen May 2, 2024

monsieur-z commented May 3, 2024 •

edited

Loading

coder-karen commented May 6, 2024

monsieur-z left a comment

		@@ -35,24 +35,6 @@
		return true; // Not returning true will cause the module to become deactivated.

Contact Form: Removing code and renaming relevant references to ensure we use the package version #37157

Contact Form: Removing code and renaming relevant references to ensure we use the package version #37157

Conversation

coder-karen commented May 1, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented May 1, 2024 • edited Loading

github-actions bot commented May 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coder-karen May 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monsieur-z commented May 3, 2024 • edited Loading

coder-karen commented May 6, 2024

monsieur-z left a comment

Choose a reason for hiding this comment

coder-karen commented May 1, 2024 •

edited

Loading

github-actions bot commented May 1, 2024 •

edited

Loading

github-actions bot commented May 1, 2024 •

edited

Loading

coder-karen May 2, 2024 •

edited

Loading

monsieur-z commented May 3, 2024 •

edited

Loading