Enhance/#8786 - Implement JS entry point for RRM #8948

hussain-t · 2024-07-01T18:09:17Z

Summary

Addresses issue:

Add JS entry point for RRM #8786

Relevant technical choices

Added test files for the SetupMain, SettingsEdit, and SettingsView component.
Added storybook stories for the SetupMain, SettingsEdit, and SettingsView component.
Registers the RRM module with registerModule only when the rrmModule feature flag is enabled.
Add base test files for the datastore.
Unable to implement basic datastore tests without providing the settingSlugs to the createModuleStore. This will be implemented as part of #8793
The IB states to test the HTTPS requirements and the warning message. However, we don't test the module index file.
This PR tests the individual validation utilities, including the HHTS requirement utility.

PR Author Checklist

My code is tested and passes existing unit tests.
My code has an appropriate set of unit tests which all pass.
My code is backward-compatible with WordPress 5.2 and PHP 7.4.
My code follows the WordPress coding standards.
My code has proper inline documentation.
I have added a QA Brief on the issue linked above.
I have signed the Contributor License Agreement (see https://cla.developers.google.com/).

Do not alter or remove anything below. The following sections will be managed by moderators only.

Code Reviewer Checklist

Run the code.
Ensure the acceptance criteria are satisfied.
Reassess the implementation with the IB.
Ensure no unrelated changes are included.
Ensure CI checks pass.
Check Storybook where applicable.
Ensure there is a QA Brief.

Merge Reviewer Checklist

Ensure the PR has the correct target branch.
Double-check that the PR is okay to be merged.
Ensure the corresponding issue has a ZenHub release assigned.
Add a changelog message to the issue.

github-actions · 2024-07-01T18:16:44Z

Size Change: +10.3 kB (+0.66%)

Total Size: 1.56 MB

Filename	Size	Change
`./dist/assets/js/29-********************.js`	0 B	-2.76 kB (removed)	🏆
`./dist/assets/js/30-********************.js`	2.76 kB	+503 B (+22.32%)	🚨
`./dist/assets/js/31-********************.js`	2.25 kB	-1.39 kB (-38.14%)	🎉
`./dist/assets/js/32-********************.js`	3.64 kB	+2.71 kB (+289.73%)	🆘
`./dist/assets/js/33-********************.js`	935 B	+43 B (+4.82%)	🔍
`./dist/assets/js/34-********************.js`	892 B	-2.22 kB (-71.36%)	🏆
`./dist/assets/js/googlesitekit-activation-********************.js`	24 kB	-67 B (-0.28%)
`./dist/assets/js/googlesitekit-ad-blocking-recovery-********************.js`	59.4 kB	+3 B (+0.01%)
`./dist/assets/js/googlesitekit-adminbar-********************.js`	34.8 kB	-12 B (-0.03%)
`./dist/assets/js/googlesitekit-api-********************.js`	10.2 kB	-7 B (-0.07%)
`./dist/assets/js/googlesitekit-components-gm2-********************.js`	5.88 kB	-3 B (-0.05%)
`./dist/assets/js/googlesitekit-data-********************.js`	2.36 kB	+2 B (+0.08%)
`./dist/assets/js/googlesitekit-datastore-forms-********************.js`	9.13 kB	-6 B (-0.07%)
`./dist/assets/js/googlesitekit-datastore-location-********************.js`	2.08 kB	-2 B (-0.1%)
`./dist/assets/js/googlesitekit-datastore-site-********************.js`	19.9 kB	-83 B (-0.42%)
`./dist/assets/js/googlesitekit-datastore-ui-********************.js`	10.1 kB	-12 B (-0.12%)
`./dist/assets/js/googlesitekit-datastore-user-********************.js`	25.1 kB	-89 B (-0.35%)
`./dist/assets/js/googlesitekit-entity-dashboard-********************.js`	74 kB	-5 B (-0.01%)
`./dist/assets/js/googlesitekit-main-dashboard-********************.js`	123 kB	-49 B (-0.04%)
`./dist/assets/js/googlesitekit-modules-********************.js`	22.2 kB	-24 B (-0.11%)
`./dist/assets/js/googlesitekit-modules-ads-********************.js`	29.5 kB	-63 B (-0.21%)
`./dist/assets/js/googlesitekit-modules-adsense-********************.js`	113 kB	+11 B (+0.01%)
`./dist/assets/js/googlesitekit-modules-analytics-4-********************.js`	143 kB	+115 B (+0.08%)
`./dist/assets/js/googlesitekit-modules-pagespeed-insights-********************.js`	22.6 kB	-39 B (-0.17%)
`./dist/assets/js/googlesitekit-modules-search-console-********************.js`	58.4 kB	-457 B (-0.78%)
`./dist/assets/js/googlesitekit-modules-tagmanager-********************.js`	31.9 kB	-210 B (-0.65%)
`./dist/assets/js/googlesitekit-settings-********************.js`	61.6 kB	+19 B (+0.03%)
`./dist/assets/js/googlesitekit-splash-********************.js`	72.8 kB	-131 B (-0.18%)
`./dist/assets/js/googlesitekit-user-input-********************.js`	48.1 kB	-3 B (-0.01%)
`./dist/assets/js/googlesitekit-vendor-********************.js`	317 kB	+394 B (+0.12%)
`./dist/assets/js/googlesitekit-widgets-********************.js`	60.6 kB	-294 B (-0.48%)
`./dist/assets/js/googlesitekit-wp-dashboard-********************.js`	61.6 kB	+2 B (0%)
`./dist/assets/js/runtime-********************.js`	1.3 kB	+3 B (+0.23%)
`./dist/assets/js/35-********************.js`	3.12 kB	+3.12 kB (new file)	🆕
`./dist/assets/js/googlesitekit-modules-reader-revenue-manager-********************.js`	11.3 kB	+11.3 kB (new file)	🆕

ℹ️ View Unchanged

Filename	Size
`./dist/assets/css/googlesitekit-admin-css-********************.min.css`	55.1 kB
`./dist/assets/css/googlesitekit-adminbar-css-********************.min.css`	11.2 kB
`./dist/assets/css/googlesitekit-authorize-application-css-********************.min.css`	770 B
`./dist/assets/css/googlesitekit-wp-dashboard-css-********************.min.css`	7.47 kB
`./dist/assets/js/analytics-advanced-tracking-********************.js`	776 B
`./dist/assets/js/contact-form-7-********************.js`	645 B
`./dist/assets/js/easy-digital-downloads-********************.js`	615 B
`./dist/assets/js/googlesitekit-components-gm3-********************.js`	10.1 kB
`./dist/assets/js/googlesitekit-i18n-********************.js`	3.92 kB
`./dist/assets/js/googlesitekit-polyfills-********************.js`	377 B
`./dist/assets/js/mailchimp-********************.js`	629 B
`./dist/assets/js/ninja-forms-********************.js`	727 B
`./dist/assets/js/optin-monster-********************.js`	673 B
`./dist/assets/js/popup-maker-********************.js`	634 B
`./dist/assets/js/woocommerce-********************.js`	652 B
`./dist/assets/js/wpforms-********************.js`	632 B

_{compressed-size-action}

github-actions · 2024-07-02T06:26:43Z

Build files for 180e164 have been deleted.

…gle/site-kit-wp into enhance/#8786-add-rrm-js-entry-point.

techanvil

Thanks @hussain-t, this is most of the way there. I've left a few comments, please take a look.

assets/js/modules/reader-revenue-manager/index.js

assets/js/modules/reader-revenue-manager/utils/validation.js

assets/js/modules/reader-revenue-manager/datastore/settings.test.js

techanvil · 2024-07-02T14:16:20Z

assets/js/modules/reader-revenue-manager/datastore/settings.js

+	const { haveSettingsChanged, isDoingSubmitChanges, getPublicationID } =
+		strictSelect( MODULES_READER_REVENUE_MANAGER );
+
+	// Note: these error messages are referenced in test assertions.


This comment looks copy/pasted and doesn't seem accurate...

assets/js/modules/reader-revenue-manager/datastore/settings.js

includes/Modules/Reader_Revenue_Manager.php

assets/js/modules/reader-revenue-manager/components/settings/SettingsEdit.stories.js

assets/js/modules/reader-revenue-manager/components/settings/SettingsView.stories.js

assets/js/modules/reader-revenue-manager/components/setup/SetupMain.stories.js

assets/js/modules/reader-revenue-manager/utils/validation.js

techanvil

Thanks @hussain-t, just a few more minor points to address.

assets/js/modules/reader-revenue-manager/utils/validation.test.js

assets/js/modules/reader-revenue-manager/utils/validation.js

includes/Modules/Reader_Revenue_Manager.php

techanvil

LGTM, nice one @hussain-t!

hussain-t added 18 commits July 1, 2024 23:26

Add Reader Revenue Manager Settings components.

78579b3

Add Reader Revenue Manager module entrypoint.

0dd60bd

Add Settings constants.

cb85d3f

Add new badge for RRM in SetupModule.

2bebd7f

Add new badge for RRM in SettingsActiveModule Header.

cb5cb2b

Add Reader Revenue Manager module initialization.

3c8bfdb

Add Reader Revenue Manager SettingsEdit component.

35e600b

Add Reader Revenue Manager SettingsView component.

5968db2

Add Reader Revenue Manager SetupMain component.

cc32f18

Add RRM base data store.

45a3be2

Add RRM data store constants.

2a9f3b4

Add RRM registerStore.

e175967

Add RRM setup_assets method.

e56ecf5

Add RRM settings datastore.

c64fd97

Add RRM Validation utilities..

74b9219

Add RRM svg logo.

82c4cdb

Add RRM module entry in webpack config.

b2a4e60

Add Reader Revenue Manager Setup components.

71cbe5a

Merge branch 'develop' into enhance/#8786-add-rrm-js-entry-point.

27c1822

hussain-t added 9 commits July 2, 2024 12:09

Add rrm base data store tests.

d3b1623

Add rrm index test base.

ef74274

Merge branch 'enhance/#8786-add-rrm-js-entry-point' of github.com:goo…

127dfaa

…gle/site-kit-wp into enhance/#8786-add-rrm-js-entry-point.

Add rrm settings test base file.

f941c7d

Add Validation function tests.

c556ad5

Add SettingsEdit storybook.

306e1a6

Add SettingsEdit test file.

d0c8886

Add SettingsView storybook.

712ed3d

Add SettingsView test file.

1653114

hussain-t added 6 commits July 2, 2024 15:45

Add SetupMain storybook.

d1a9dde

Add SetupMain test file.

741087e

Add todo comment in the registerModule features.

1640fd2

Add modulesReaderRevenueManager in tests/js/utils.

35ab985

Fix settings test.

328ca75

Order imports.

cbf8f7e

techanvil requested changes Jul 2, 2024

View reviewed changes

hussain-t added 7 commits July 2, 2024 22:20

Improve isURLUsingHTTPS fn.

2761f76

Improve isURLUsingHTTPS tests.

861a464

Ensure the site info is resolved to get the home URL.

9143609

Address review feedback.

fff0ef4

Update publication ID validation to match base64 characters.

e1f755b

Fix tests for the updated validation.

3fbfd99

Merge branch 'develop' into enhance/#8786-add-rrm-js-entry-point.

361f573

techanvil requested changes Jul 3, 2024

View reviewed changes

hussain-t added 3 commits July 3, 2024 18:24

Improve isURLUsingHTTPS logic.

c802cad

Improve isURLUsingHTTPS tests.

0be6bd6

Remove datastore-forms and modules-data from RRM assets.

180e164

techanvil approved these changes Jul 3, 2024

View reviewed changes

techanvil merged commit 08388e7 into develop Jul 3, 2024
29 of 30 checks passed

techanvil deleted the enhance/#8786-add-rrm-js-entry-point branch July 3, 2024 21:58

aaemnnosttv mentioned this pull request Jul 26, 2024

Add RRM module settings. #8965

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance/#8786 - Implement JS entry point for RRM #8948

Enhance/#8786 - Implement JS entry point for RRM #8948

hussain-t commented Jul 1, 2024 •

edited by techanvil

Loading

github-actions bot commented Jul 1, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

techanvil left a comment

techanvil Jul 2, 2024

techanvil left a comment

techanvil left a comment

Enhance/#8786 - Implement JS entry point for RRM #8948

Enhance/#8786 - Implement JS entry point for RRM #8948

Conversation

hussain-t commented Jul 1, 2024 • edited by techanvil Loading

Summary

Relevant technical choices

PR Author Checklist

Code Reviewer Checklist

Merge Reviewer Checklist

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

github-actions bot commented Jul 2, 2024 • edited Loading

techanvil left a comment

Choose a reason for hiding this comment

techanvil Jul 2, 2024

Choose a reason for hiding this comment

techanvil left a comment

Choose a reason for hiding this comment

techanvil left a comment

Choose a reason for hiding this comment

hussain-t commented Jul 1, 2024 •

edited by techanvil

Loading

github-actions bot commented Jul 1, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading