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

Implement modules/thank-with-google JS store foundation #5365

Closed
felixarntz opened this issue Jun 15, 2022 · 5 comments
Closed

Implement modules/thank-with-google JS store foundation #5365

felixarntz opened this issue Jun 15, 2022 · 5 comments
Labels
Good First Issue Good first issue for new engineers Module: Thank with Google Thank with Google module related issues P0 High priority Type: Enhancement Improvement of an existing feature

Comments

@felixarntz
Copy link
Member

felixarntz commented Jun 15, 2022

Similar to #5364: We should "migrate" the modules/subscribe-with-google store to become the foundation for a new modules/thank-with-google store.


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

Acceptance criteria

  • The JS store modules/subscribe-with-google should be consistently renamed to modules/thank-with-google.
  • The JS file googlesitekit-modules-subscribe-with-google.js should be renamed to googlesitekit-modules-thank-with-google.js.
    • Its reference in PHP, including the PHP handle, should also be renamed accordingly.
    • No selectors/actions/logic/settings (anything really) should be changed in the module store as part of this issue.
  • Any references to the subscribe-with-google module slug in JS should be changed to reference the thank-with-google module slug (see Implement Thank with Google PHP module foundation #5364).
  • Any references to the swgModule feature flag in JS should be changed to reference the twgModule feature flag (see Implement Thank with Google PHP module foundation #5364).
  • Instead of using the "Google G" as icon for the (previously "Subcribe with Google") module, we should use the new Thank with Google icon which is present e.g. here in the Figma file.
  • Any references to any "Subscribe with Google" name permutations in the JS codebase should be changed to refer to the corresponding "Thank with Google" name.
  • Any @since annotations within the (renamed) assets/js/modules/thank-with-google directory should be changed to n.e.x.t., de-facto making this code new.

Implementation Brief

Note: The ACs are very close to code here already, so no need to rehash all of this. Please review the ACs closely together with the relevant code and point out any more complex changes necessary or follow-up questions.

  • Rename assets/js/modules/subscribe-with-google to assets/js/modules/thank-with-google.
    • Replace every instance of subscribe-with-google with thank-with-google in code and file names inside the directory.
    • Update the code in comments accordingly as well where it references Subscribe with Google.
  • In assets/js/modules/**thank**-with-google/datastore/constants.js
    • Export modules/subscribe-with-google as MODULES_THANK_WITH_GOOGLE.
    • Delete the STORE_NAME constant.
    • Update all usage of the above STORE_NAME with MODULES_THANK_WITH_GOOGLE constant.
  • In webpack.config.js file:
    • Update the googlesitekit-modules-subscribe-with-google entry to googlesitekit-modules-thank-with-google and use the new path (post rename).
  • In the assets registration Subscribe_With_Google/Thank_With_Google class:
    • Update the asset name and path.
  • In assets/js/modules/thank-with-google/index.js:
    • Update feature flag to use twgModule.
    • Update Icon to the new Thank With Google Logo from the figma file.
      • Add thank-with-google.svg to graphics directory.
  • Finish and merge Thank with Google JS Foundation #5392.
    • Update failing tests.

Test Coverage

  • Update failing tests and broken stories.

QA Brief

Changelog entry

  • Add foundation for new Thank with Google feature (JS).
@felixarntz felixarntz added P0 High priority Type: Enhancement Improvement of an existing feature Module: Thank with Google Thank with Google module related issues labels Jun 15, 2022
@felixarntz felixarntz self-assigned this Jun 15, 2022
@felixarntz felixarntz removed their assignment Jun 15, 2022
@kuasha420 kuasha420 self-assigned this Jun 16, 2022
@kuasha420 kuasha420 removed their assignment Jun 18, 2022
@eugene-manuilov eugene-manuilov self-assigned this Jun 21, 2022
@eugene-manuilov eugene-manuilov added the Good First Issue Good first issue for new engineers label Jun 21, 2022
@eugene-manuilov
Copy link
Collaborator

@kuasha420, please, do not use "PR as IB" approach for regular tickets, we strongly discourage this approach even if a ticket seems pretty straightforward.

IB ✔️

@eugene-manuilov eugene-manuilov removed their assignment Jun 21, 2022
@kuasha420 kuasha420 assigned kuasha420 and unassigned kuasha420 Jun 21, 2022
@asvinb asvinb assigned asvinb and kuasha420 and unassigned asvinb Jun 24, 2022
@kuasha420 kuasha420 assigned asvinb and unassigned kuasha420 Jun 24, 2022
@asvinb asvinb removed their assignment Jun 24, 2022
@techanvil techanvil assigned techanvil and unassigned techanvil Jun 27, 2022
@wpdarren wpdarren self-assigned this Jun 27, 2022
@wpdarren
Copy link
Collaborator

wpdarren commented Jun 28, 2022

QA Update: ⚠️

@kuasha420 When I am comparing figma for the Thank with Google settings to set up the module, there are no US only and Experimental labels. Will that be covered in another ticket? I had a quick look but couldn't find any mention.

image

@nfmohit
Copy link
Collaborator

nfmohit commented Jun 28, 2022

@wpdarren Just wanted to let you know that those are being handled in #5452 and #5457.

@kuasha420
Copy link
Contributor

@nfmohit Thanks for stepping in. <3

@wpdarren This should be good to go now. Cheers.

@kuasha420 kuasha420 removed their assignment Jun 28, 2022
@wpdarren
Copy link
Collaborator

wpdarren commented Jun 29, 2022

QA Update: ✅

Thank you @kuasha420 @nfmohit 👍

Verified:

  • The module name "Subscribe with Google" is changed to "Thank with Google".
  • The feature flag swgModule is changed to be called twgModule.
  • The new module description is: Let your supporters show appreciation of your work through virtual stickers and personal messages

image

@wpdarren wpdarren removed their assignment Jun 29, 2022
@nfmohit nfmohit mentioned this issue Jun 3, 2024
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good first issue for new engineers Module: Thank with Google Thank with Google module related issues P0 High priority Type: Enhancement Improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

7 participants