Fixing Mailchimp not saving name. Refactor reCaptcha file structure.

tonykieling commented 1 year ago

Web Dev Path
187

Have you updated the CHANGELOG.md file? If not, please do it.

Yes.

What is this change?

Contact and Subscribe forms are saving Name on Mailchimp.
Changed /api to have a file to check reCaptcha and another to send email.
Refactored and to handle Mailchimp and GoogleRecaptcha in one place (), and utilize the apis above mentioned.

Were there any complications while making this change?

The initial settings and get used to Mailchimp.

How did you verify this change?

Checked on Chrome, FF, and MS Edge.

When should this be merged?

After review.

netlify[bot] commented 1 year ago

Deploy Preview for webdevpathstage ready!

Name	Link
Latest commit	b1b5a5a618ad9a222a802b93222f7f4f82a47f7c
Latest deploy log	https://app.netlify.com/sites/webdevpathstage/deploys/64e78d89c3058d00081b192d
Deploy Preview	https://deploy-preview-190--webdevpathstage.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Satoshi-Sh commented 1 year ago

I would like to test this out on my end but I'm not sure how to set up MailChimp. I just signed up. If you can guide me, it would be great.

Do I need to get my own recaptcha and SendGrid keys as well? I'm not familiar with them either.

mariana-caldas commented 1 year ago

I would like to test this out on my end but I'm not sure how to set up MailChimp. I just signed up. If you can guide me, it would be great.

Do I need to get my own recaptcha and SendGrid keys as well? I'm not familiar with them either.

Hey @Satoshi-Sh !

You can follow these approaches to test it:

Recommended approach: By using an email you have access to, even the same you have already subscribed to in this format emailsubscribed+1oranyting@gmail.com, you try to subscribe to our Newsletter through both our component (the Newsletter section we see on every page but Contact) and the Contact form. If you see the expected successful messages, it means MailChimp is working as intended. I will only have to remove those "fake" test contacts from the Mailchimp list later.
By creating a Mailchimp account and list and using your keys to check if contacts go to that list properly. This approach is the best one if you are developing this feature, but I don't think it's necessary to have all that trouble as a tester...

In both cases, you don't need to create other Recaptcha or SendGrid keys.

Your question is interesting, Satoshi, and makes me wonder if we should add a section to the PR template or an explanation to our wikipedia, encouraging developers to describe how to test the features/fixes. What do you think, @cherylli and @tonykieling ?

cherylli commented 1 year ago

Wiki sounds like a good idea

Satoshi-Sh commented 1 year ago

The updated code looks nice.

I tested the two components. Let me know if you can see my name, @mariana-caldas . After that, I will approve this pull request.

mariana-caldas commented 1 year ago

The updated code looks nice.

I tested the two components. Let me know if you can see my name, @mariana-caldas . After that, I will approve this pull request.

You were subscribed correctly, @Satoshi-Sh ! I've also received your email from the contact form 🙌🏼

tonykieling commented 1 year ago

If we decide to have this info on the wiki, I could elaborate a step-by-step to set Mailchimp, Sendgrid and GoogleReCaptcha (.env) for new volunteers.

mariana-caldas commented 1 year ago

If we decide to have this info on the wiki, I could elaborate a step-by-step to set Mailchimp, Sendgrid and GoogleReCaptcha (.env) for new volunteers.

Thanks, @tonykieling ! I think we only need to add to our wiki a section explaining that depending on the feature, the developer should include how to test the feature under the PR description item "How did you verify the change" Thoughts, @cherylli ?

cherylli commented 1 year ago

If we decide to have this info on the wiki, I could elaborate a step-by-step to set Mailchimp, Sendgrid and GoogleReCaptcha (.env) for new volunteers.

Thanks, @tonykieling ! I think we only need to add to our wiki a section explaining that depending on the feature, the developer should include how to test the feature under the PR description item "How did you verify the change" Thoughts, @cherylli ?

I was more thinking like a brief explanation of how these things (mailchimp, recaptcha, etc) work together as it might be confusing for newer developers, since Tony already wrote something about it (https://github.com/Web-Dev-Path/web-dev-path/blob/06a0bc22469fa7b7a88abc71fc7a4c951e79ea9a/temp-notes.txt), I thought it might be for other future developers

mariana-caldas commented 1 year ago

If we decide to have this info on the wiki, I could elaborate a step-by-step to set Mailchimp, Sendgrid and GoogleReCaptcha (.env) for new volunteers.

Thanks, @tonykieling ! I think we only need to add to our wiki a section explaining that depending on the feature, the developer should include how to test the feature under the PR description item "How did you verify the change" Thoughts, @cherylli ?

I was more thinking like a brief explanation of how these things (mailchimp, recaptcha, etc) work together as it might be confusing for newer developers, since Tony already wrote something about it (https://github.com/Web-Dev-Path/web-dev-path/blob/06a0bc22469fa7b7a88abc71fc7a4c951e79ea9a/temp-notes.txt), I thought it might be for other future developers

I'd say it's better to redirect new developers to the official documentation of these platforms. New members need to know they have to get the .env variables because we use those API platforms, that's completely enough. Thanks, @cherylli and @tonykieling ! By the way, @cherylli , can we get your PR approval so Tony can merge this PR? Thanks!

cherylli commented 1 year ago

Sorry, i've been really busy lately, I haven't had a chance to pull and setup all my mailchimp accounts etc to test this PR, and I believe my sendgrid account is banned or something. I might be able to in the weekend but it's fathers day here so i'll probably be gone all day, or would you like me to approve without checking or running it locally?

mariana-caldas commented 1 year ago

Hey @cherylli ! To test the feature, you can use the "recommended approach" I explained above to Satoshi. You don't need to set anything. You only need to run the PR locally and try to send a request to subscribe both on the contact page and the Newsletter section. I would check our MailChimp list to validate your "tests" to remove them later. I can always merge the PR manually, so don't sweat if you can't, Cheryl! Btw, that's why I reinforce the importance of adding something to our wiki (create PR) so developers detail how to test things when necessary.

That's a great opportunity to learn from a great PR, @LuSilvaDeveloper , @sergiobtos , and @bernardoasc.

cherylli commented 1 year ago

Hey @cherylli ! To test the feature, you can use the "recommended approach" I explained above to Satoshi. You don't need to set anything. You only need to run the PR locally and try to send a request to subscribe both on the contact page and the Newsletter section. I would check our MailChimp list to validate your "tests" to remove them later. I can always merge the PR manually, so don't sweat if you can't, Cheryl! Btw, that's why I reinforce the importance of adding something to our wiki (create PR) so developers detail how to test things when necessary.

That's a great opportunity to learn from a great PR, @LuSilvaDeveloper , @sergiobtos , and @bernardoasc.

ok sure I can do that sometime in the weekend, I just prefer doing the full testing myself

Web-Dev-Path / web-dev-path