Implement RRM maybeSyncPublicationOnboardingState() action

[nfmohit]

Feature Description

The maybeSyncPublicationOnboardingState() action should be implemented for the Reader Revenue Manager module that periodically dispatches the syncPublicationOnboardingState() action (once every hour) to sync the value of the publicationOnboardingState module setting.

• The maybeSyncPublicationOnboardingState() action should be dispatched in the Site Kit dashboard on load, similar to how it is done for syncGoogleTagSettings().
• See relevant section in the design doc.

---

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

Acceptance criteria

• A maybeSyncPublicationOnboardingState() action should be implemented for the modules/reader-revenue-manager data store.
• This action should check the value of the publicationOnboardingStateLastSyncedAtMs module setting and determine if it has been more than an hour since the last sync. If so, the syncPublicationOnboardingState() action should be dispatched.
• The maybeSyncPublicationOnboardingState() action should be dispatched in the Site Kit dashboard on load, similar to how it is done for syncGoogleTagSettings().

Implementation Brief

• In assets/js/components/DashboardEntryPoint.js, collect actions object of RRM module using useDispatch

      const rrmActions = useDispatch( READER_REVENUE_MANAGER );

  • Call rrmActions?.maybeSyncPublicationOnboardingState() inside useMount hook.
• Create a new generator action maybeSyncPublicationOnboardingState inside assets/js/module/reader-revenue-manager/datastore/publications.js
  • Wait for getModules to resolved.
  • Return null if module is not connected.
  • Call the getSettings selector on module and wait for it to be resolved so that settings are available before we make another check. Refer this for similar approach.
  • Call the getPublicationOnboardingStateLastSyncedAtMs selector on module. If the value is present and an hour has not passed since last sync, return from the action and do nothing. Refer here.
    • Otherwise, dispatch an action syncPublicationOnboardingState which would update the settings on server as well as in the local state for the module based on following.
      • If more than an hour has passed since last sync.
      • If the value of getPublicationOnboardingStateLastSyncedAtMs is zero.

Test Coverage

Add tests for maybeSyncPublicationOnboardingState action with different values for publicationOnboardingStateLastSyncedAtMs setting.

QA Brief

• Follow the QAB of 8796 to setup RRM module and and verify that the onboarding state is ONBOARDING_STATE_UNSPECIFIED and publicationOnboardingStateLastSyncedAtMs is zero. This can be verified by using googlesitekit.data.select('modules/reader-revenue-manager').getSettings().
• Visit Site Kit Dashboard.
• In the network tab, there should be a request to GET:modules/reader-revenue-manager/data/publications and the publicationOnboardingStateLastSyncedAtMs should be updated. Use the above snippet to verify the timestamp.
• For subsequent refreshes in the next 1 hour, there should be no request to the above endpoint and timestamp should remain unchanged.
• Once 1 hour has passed, revisiting the dashboard should do the sync again using the endpoint and update the timestamp accordingly.

Changelog entry

• Add a mechanism to synchronize the onboarding state of a publication once every hour in the Reader Revenue Manager module.

[nfmohit]

Thank you for the IB, @ankitrox ! Please take a look at my comments below:

• Return if module is not connected.

Let's also wait for getModules to resolve before we check for the module's connection status.

• If more than an hour has passed since last sync, dispatch an action syncPublicationOnboardingState which would update the settings on server as well as in the local state for the module.

It would also be beneficial to mention that this should also run if getPublicationOnboardingStateLastSyncedAtMs is not set, i.e. 0 as well.

---

Please let me know if you have any questions, thank you!

[ankitrox]

Thank you @nfmohit .

I have updated the couple of points mentioned in the feedback.

[nfmohit]

Thank you @ankitrox ! I have made some small improvements to the IB, namely:

• We do not need to return undefined if getModules has not resolved, simply using resolveSelect should be sufficient.

The IB LGTM 👍 ✅

[aaemnnosttv]

@kuasha420 has addressed this correctly in his PR but I just wanted to note how we should not be introducing any module-specific effects/coupling into core components like DashboardEntryPoint or DashboardMainApp. See #8211

[kelvinballoo]

QA Update ⚠️

Not sure if we need to update the QAB but I tried to set it up but I can't get the 'GET:modules/reader-revenue-manager/data/publications' request.

Video is attached for reference:

request.not.there.1080p.mov

[kuasha420]

Hi @kelvinballoo, I just tested develop and the endpoint is correct and is getting hit. Can you try again? I'm not sure why it didn't work for you, maybe the zip on develop didn't update correctly.

[kelvinballoo]

QA Update ⚠️

Hi @kuasha420 , thanks.
I've been able to get the request now:

From where do I actually find the time stamp though? ⚠️
I ran the snippet googlesitekit.data.select('modules/reader-revenue-manager').getSettings() but I don't see anything related to timestamp from there:

[kuasha420]

Hi @kelvinballoo Sorry for the confusion. The timestamp is stored as publicationOnboardingStateLastSyncedAtMs which is 0 in your screenshot. Hope that clears it up.

[kelvinballoo]

QA Update ⚠️

Hi @kuasha420
Noted that publicationOnboardingStateLastSyncedAtMs being 0 is the timestamped.
One follow up question from there:

Once 1 hour has passed, revisiting the dashboard should do the sync again using the endpoint and update the timestamp accordingly.

What am I expecting for the update to the timestamp? 1 for 1 hour ? Or any other value?

[kelvinballoo]

QA Update ❌

Hi @kuasha420 , as per our sync, I'm always getting the publicationOnboardingStateLastSyncedAtMs as 0, even the first round or after 1 hour+.

Assigning to you for investigation.

[aaemnnosttv]

@kelvinballoo Moving this back to QA now that #9163 has been merged, as @kuasha420 mentioned that it should address the issue here #9163 (review)

[kelvinballoo]

QA Update ✅

Tested this and it's looking good now.
Moving ticket to Approval.

• In the network tab, there is a request to GET:modules/reader-revenue-manager/data/publications and the publicationOnboardingStateLastSyncedAtMs was updated to the time the request was triggered. ✅

  

  Verified that the epoch time corresponded to the trigger time.
  

• For subsequent refreshes in the next 1 hour, there was no request to the above endpoint and timestamp remain unchanged. ✅

  There was no publication request again after refreshing within the next hour

  publicationOnboardingStateLastSyncedAtMs remained unchanged (Note: This one was for another timeframe, the requests were made 5 mins after the other and the values were the same)

  

• Once 1 hour has passed, revisiting the dashboard does the sync again using the endpoint and updates the timestamp accordingly. ✅

  After 1hour plus, publications request was made when refreshing SK dashboard.

  New timestamp was made: