Email notifications for create,update,delete deployment #182

SachinSogoduRaju · 2023-09-15T12:16:17Z

No description provided.

github-actions · 2023-09-15T12:38:22Z

Thank you for raising the request! RAD Lab admins have been notified.

github-actions · 2023-09-15T12:39:00Z

Apache 2.0 License check successful!

SachinSogoduRaju · 2023-09-22T14:53:04Z

-Feature: Enable Email notifications to Trusted and Owner Users / Groups for RAD Lab module updates
-Steps to Test :

Login as RAD Lab admin.
Navigate to Set up page.
Update required fields and move to step 4 to enable email notifications and update mail box email and password.
Create a new RAD Lab deployment/ update with Trusted and Owner Users/Groups email ids and also email will trigger to deployer of the module by default.(Email will trigger for create/update/delete modules)

acolver

It's unclear to me what to provide as "Mail Box Email" and "Mail Box Password". I think we need to document this much more (in a subsection under Troubleshooting) and we need to link to that on the admin variable page; otherwise, it's unclear what to put here.

radlab-ui/webapp/src/components/forms/DefaultStepCreator.tsx

acolver · 2023-09-25T15:44:22Z

radlab-ui/webapp/src/pages/api/secret.ts

+        userManaged: {
+          replicas: [
+            {
+              location: "us-central1",


Do we need this region? If so, it can't be hard coded. It needs to be set as an environment variable and documented here: https://googlecloudplatform.github.io/rad-lab/docs/rad-lab-ui/ui_installation/env-variables/

Yes its required hence storing it as env and updated the document.

radlab-ui/webapp/src/pages/api/secret.ts

radlab-ui/webapp/src/utils/mailHandler.ts

Co-authored-by: Alan Colver <[email protected]>

acolver

Will you please write documentation as indicated in my previous review?

acolver · 2023-09-26T14:34:09Z

radlab-ui/webapp/src/components/forms/DefaultCreateForm.tsx

+  const saveMailBoxCred = async (payload: ISecretManagerReq) => {
+    try {
+      await axios.post("/api/secret", payload)
+    } catch (error: any) {


Can we put a proper type here? I believe it's some sort of AxiosErrorResponse

catch clause accept only any or unknown type hence used any here

acolver · 2023-09-26T14:36:15Z

radlab-ui/webapp/src/pages/api/deployments/index.ts

+  await configureEmailAndSend(
+    "RAD Lab Module has been created for you!",
+    response,
+  )


These probably should've been done as Pub/Sub topic publishes, and the email sending as a Subscriber. If we have to do another async feature like this, we will rewrite both to Pub/Sub.

No action needed at this time.

radlab-ui/webapp/src/pages/api/secret.ts

acolver · 2023-09-26T14:39:16Z

radlab-ui/webapp/src/utils/mailHandler.ts

+    },
+  })
+
+  transporter.verify().then(console.log).catch(console.error)


I think you need to await this. And do we need to console.log on success?

Updated to await and removed then block

radlab-ui/webapp/src/utils/mailHandler.ts

docs/docs/rad-lab-ui/ui_installation/env-variables.md

Co-authored-by: Alan Colver <[email protected]>

docs/docs/rad-lab-ui/troubleshooting.md

Co-authored-by: Alan Colver <[email protected]>

…escriptions

docs/docs/rad-lab-ui/troubleshooting.md

guptamukul-google · 2023-09-28T22:54:38Z

docs/docs/rad-lab-ui/troubleshooting.md

@@ -4,3 +4,20 @@ sidebar_position: 4
 # Troubleshooting

 Please feel free to reach out and to create a [GitHub issue](https://github.com/GoogleCloudPlatform/rad-lab/issues) in case of any issues or concerns.
+
+## Email Notifications


I think the best place for this section is under Global Admin Variables section compared to Troubleshooting section.

And also we should remove the mention of Preferred Google Cloud Region and Zone from Global Admin Variables.

Moved Email Notifications section to Global Admin Variables

guptamukul-google · 2023-09-28T23:08:11Z

docs/docs/rad-lab-ui/ui_installation/env-variables.md

@@ -35,6 +35,7 @@ Firebase environment variables can be found in project settings section of your
 - `NEXT_PUBLIC_NOTIFICATION_TOPIC` - Topic created for notifications
 - `NEXT_PUBLIC_NOTIFICATION_SUB` - Subscription created for notifications
 - `NEXT_PUBLIC_GIT_API_URL` - Url of the public repo to pull the deployment modules
+- `SECRET_MANAGER_LOCATION` - Google Cloud region of the Secret Manager instance


2 Questions:

How are we setting this Environment variable ? Are we needing admins to manually update the .env file with the region before UI deployment or using the existing bash script which creates the .env file.

What is the default value of this variable ? Is it the same as app_engine_location variable ?

SOLUTION: If its manually set and we want to automate it like other variables we can expose the above app_engine_location variable as a TF output and we can use the existing bash script to create the .env with the same.

app_engine_location and Secret Manager Location are different things so created new env in outputs and updated in bash script file.

guptamukul-google

I have added my feedback / review. There may be some changes needed to automatically set SECRET_MANAGER_LOCATION env variable, Please let me know if you need any clarifications.

guptamukul-google

Everything looks good! Thanks for working on this guys :)

guptamukul-google · 2023-09-29T21:49:02Z

Release for #141

Email notifications

069e07d

SachinSogoduRaju requested review from guptamukul-google, acolver and debakkerb as code owners September 15, 2023 12:16

SachinSogoduRaju added 2 commits September 20, 2023 14:26

email notification changes

7006df1

email notification implementation

70c05fe

Description of email notification check box updated

5286bf0

acolver requested changes Sep 25, 2023

View reviewed changes

SachinSogoduRaju and others added 4 commits September 26, 2023 08:32

Update radlab-ui/webapp/src/components/forms/DefaultStepCreator.tsx

4f3b044

Co-authored-by: Alan Colver <[email protected]>

Update radlab-ui/webapp/src/utils/mailHandler.ts

02fd980

Co-authored-by: Alan Colver <[email protected]>

Update radlab-ui/webapp/src/utils/mailHandler.ts

d22a83d

Co-authored-by: Alan Colver <[email protected]>

PR review Changes

9d0deba

SachinSogoduRaju requested review from agussman, BrianReevz and hradhakrishnan as code owners September 26, 2023 09:24

acolver requested changes Sep 26, 2023

View reviewed changes

SachinSogoduRaju and others added 3 commits September 26, 2023 15:50

Update radlab-ui/webapp/src/utils/mailHandler.ts

b9a5dc9

Co-authored-by: Alan Colver <[email protected]>

Update docs/docs/rad-lab-ui/ui_installation/env-variables.md

e500a51

Co-authored-by: Alan Colver <[email protected]>

updated mailhandler function

fa42080

acolver requested changes Sep 26, 2023

View reviewed changes

docs/docs/rad-lab-ui/troubleshooting.md Outdated Show resolved Hide resolved

SachinSogoduRaju and others added 3 commits September 26, 2023 16:39

Update docs/docs/rad-lab-ui/troubleshooting.md

1d1fb57

Co-authored-by: Alan Colver <[email protected]>

Add fallback value to SECRET_MANAGER_LOCATION. Update some variable d…

fc5579d

…escriptions

updated troubleshooting doc

d176819

acolver reviewed Sep 27, 2023

View reviewed changes

docs/docs/rad-lab-ui/troubleshooting.md Outdated Show resolved Hide resolved

Update docs/docs/rad-lab-ui/troubleshooting.md

bf43e99

acolver previously approved these changes Sep 27, 2023

View reviewed changes

guptamukul-google reviewed Sep 28, 2023

View reviewed changes

guptamukul-google requested changes Sep 28, 2023

View reviewed changes

Update docs fro email notifications and env moved to terraform output

3e8ea66

SachinSogoduRaju dismissed acolver’s stale review via 3e8ea66 September 29, 2023 14:01

guptamukul-google approved these changes Sep 29, 2023

View reviewed changes

guptamukul-google mentioned this pull request Sep 29, 2023

Send Email notifications to the Trusted Users/Groups & Owner Users/Groups #141

Closed

acolver merged commit 1ff718e into GoogleCloudPlatform:staging Sep 29, 2023
4 checks passed

acolver deleted the email_trigger branch September 29, 2023 16:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Email notifications for create,update,delete deployment #182

Email notifications for create,update,delete deployment #182

SachinSogoduRaju commented Sep 15, 2023

github-actions bot commented Sep 15, 2023

github-actions bot commented Sep 15, 2023

SachinSogoduRaju commented Sep 22, 2023

acolver left a comment

acolver Sep 25, 2023

SachinSogoduRaju Sep 26, 2023

acolver left a comment

acolver Sep 26, 2023

SachinSogoduRaju Sep 26, 2023

acolver Sep 26, 2023

acolver Sep 26, 2023

acolver Sep 26, 2023

SachinSogoduRaju Sep 26, 2023

guptamukul-google Sep 28, 2023

SachinSogoduRaju Sep 29, 2023

guptamukul-google Sep 28, 2023

SachinSogoduRaju Sep 29, 2023 •

edited

Loading

guptamukul-google left a comment

guptamukul-google left a comment

guptamukul-google commented Sep 29, 2023

Email notifications for create,update,delete deployment #182

Email notifications for create,update,delete deployment #182

Conversation

SachinSogoduRaju commented Sep 15, 2023

github-actions bot commented Sep 15, 2023

github-actions bot commented Sep 15, 2023

SachinSogoduRaju commented Sep 22, 2023

acolver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acolver left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SachinSogoduRaju Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

guptamukul-google left a comment

Choose a reason for hiding this comment

guptamukul-google left a comment

Choose a reason for hiding this comment

guptamukul-google commented Sep 29, 2023

SachinSogoduRaju Sep 29, 2023 •

edited

Loading