Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename AdSense GET:earnings endpoint to GET:report #4914

Closed
felixarntz opened this issue Mar 3, 2022 · 2 comments
Closed

Rename AdSense GET:earnings endpoint to GET:report #4914

felixarntz opened this issue Mar 3, 2022 · 2 comments
Labels
Module: AdSense Google AdSense module related issues P1 Medium priority Type: Infrastructure Engineering infrastructure & tooling

Comments

@felixarntz
Copy link
Member

felixarntz commented Mar 3, 2022

For more consistent naming (both with the actual AdSense API endpoint and our other reporting endpoints in the plugin), the AdSense datapoint GET:earnings should be renamed to GET:report.


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

Acceptance criteria

  • The AdSense GET:earnings endpoint should be renamed to GET:report.
  • All references using that endpoint need to be adjusted accordingly.

Implementation Brief

  • Using includes/Modules/AdSense.php, update GET:earnings to GET:reports across the file.
  • Using assets/js/modules/adsense/datastore/report.js, replace earnings by reports in controlCallback.

Test Coverage

  • Update tests/phpunit/integration/Modules/AdSenseTest.php and assets/js/modules/adsense/datastore/report.test.js to reflect above changes.

QA Brief

  • This doesn't have any visual effect on the interface, just changes a bit of the way how the AdSense module in the front-end interacts with the back-end and data source.
  • QAing this would require making sure the AdSense module displays the data as expected without any errors or anomalies.

Changelog entry

  • Rename AdSense REST data point GET:earnings to GET:report.
@felixarntz felixarntz added P1 Medium priority Module: AdSense Google AdSense module related issues Type: Infrastructure Engineering infrastructure & tooling labels Mar 3, 2022
@felixarntz felixarntz assigned felixarntz and unassigned felixarntz Mar 3, 2022
@asvinb asvinb assigned asvinb and unassigned asvinb Mar 4, 2022
@tofumatt tofumatt self-assigned this Mar 7, 2022
@tofumatt
Copy link
Collaborator

tofumatt commented Mar 7, 2022

IB ✅

@tofumatt tofumatt removed their assignment Mar 7, 2022
@nfmohit nfmohit self-assigned this May 23, 2022
@nfmohit nfmohit removed their assignment May 23, 2022
@kuasha420 kuasha420 assigned kuasha420 and unassigned kuasha420 May 23, 2022
@techanvil techanvil assigned techanvil and unassigned techanvil May 24, 2022
@wpdarren wpdarren self-assigned this May 24, 2022
@wpdarren
Copy link
Collaborator

wpdarren commented May 24, 2022

QA Update: ✅

Verified:

  • The AdSense module displays the data as expected without any errors on FE or within console.
  • Tested this on a site without tester plugin, data displays as expected.
  • Tested this on a site with tester plugin, data displays as expected.
  • Tested this with AdSense V2 feature flag enabled and disabled.
ads-data.mp4

@wpdarren wpdarren removed their assignment May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Module: AdSense Google AdSense module related issues P1 Medium priority Type: Infrastructure Engineering infrastructure & tooling
Projects
None yet
Development

No branches or pull requests

7 participants