[Events] Add project notification settings #18
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
ghstack-source-id: f1d3b7830b6178271fd27d399d03903282ef5ec8 Pull Request resolved: #18
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
ghstack-source-id: f1d3b7830b6178271fd27d399d03903282ef5ec8 Pull Request resolved: #18
|
This is still not ready for review, I'm doing more changes. |
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings @examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "[email protected]",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`.
1. Adds a the model to the db model in metadata_svc and exposed it in the project store.
2. Expose setters/getters to notification settings in metadata svc.
3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience.
Later, we can also add this to the CLI.
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings @examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "[email protected]",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904 Pull Request resolved: #18 This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`. 1. Adds a the model to the db model in metadata_svc and exposed it in the project store. 2. Expose setters/getters to notification settings in metadata svc. 3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience. Later, we can also add this to the CLI. Test plan: ``` ~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130 Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully. ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings @examples/notifications.json ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings { "channels": { "email": { "address": "[email protected]", "type": "email", "verified": false } }, "subscriptions": [ { "channel_names": [ "email" ], "event": { "type": "on_run_failure" } } ] } ```
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
[Events] Add project notification settings
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`.
1. Adds a the model to the db model in metadata_svc and exposed it in the project store.
2. Expose setters/getters to notification settings in metadata svc.
3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience.
Later, we can also add this to the CLI.
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "testgmail.com",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
[ghstack-poisoned]
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
ghstack-source-id: 2452ad00e890fa87497a785348ac29808eec1a40 Pull Request resolved: #18 This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`. 1. Adds a the model to the db model in metadata_svc and exposed it in the project store. 2. Expose setters/getters to notification settings in metadata svc. 3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience. Later, we can also add this to the CLI. Test plan: ``` ~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130 Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully. ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings @examples/notifications.json ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings { "channels": { "email": { "address": "[email protected]", "type": "email", "verified": false } }, "subscriptions": [ { "channel_names": [ "email" ], "event": { "type": "on_run_failure" } } ] } ```
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
[Events] Add project notification settings
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`.
1. Adds a the model to the db model in metadata_svc and exposed it in the project store.
2. Expose setters/getters to notification settings in metadata svc.
3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience.
Later, we can also add this to the CLI.
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "testgmail.com",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
[ghstack-poisoned]
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
[Events] Add project notification settings
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`.
1. Adds a the model to the db model in metadata_svc and exposed it in the project store.
2. Expose setters/getters to notification settings in metadata svc.
3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience.
Later, we can also add this to the CLI.
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "testgmail.com",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
[ghstack-poisoned]
MohamedBassem
added a commit
that referenced
this pull request
Jul 26, 2023
[Events] Add project notification settings
ghstack-source-id: 2b4044a63b5cc394bfe66af8706764450703d904
Pull Request resolved: #18
This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`.
1. Adds a the model to the db model in metadata_svc and exposed it in the project store.
2. Expose setters/getters to notification settings in metadata svc.
3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience.
Later, we can also add this to the CLI.
Test plan:
```
~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130
Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully.
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json
~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings
{
"channels": {
"email": {
"address": "testgmail.com",
"type": "email",
"verified": false
}
},
"subscriptions": [
{
"channel_names": [
"email"
],
"event": {
"type": "on_run_failure"
}
}
]
}
```
[ghstack-poisoned]
AhmedSoliman
previously approved these changes
Jul 26, 2023
| let resp = metadata | ||
| .get_project_notification_settings( | ||
| GetProjectNotificationSettingsRequest { | ||
| id: Some(project_id.into()), |
There was a problem hiding this comment.
It's worth noting that because you are using ScopedGrpcClient. project_id is sent automatically via extensions.
There was a problem hiding this comment.
Currently, all the metadata APIs take the project id as part of the request. So this is here for consistency.
To be honest, I don't have strong opinions on whether we should keep them in request bodies or not. In one hand, it's in the request context as you mentioned, on the other hand, I find the empty request body to be slightly weird for "project" management APIs. No strong opinions though.
Comment on lines
+147
to
+155
| let req = request.into_inner(); | ||
| let project_id: ProjectId = req.id.unwrap().into(); | ||
| let project_id = project_id | ||
| .validated() | ||
| .map_err(|e| Status::invalid_argument(e.to_string()))?; |
There was a problem hiding this comment.
validated ProjectId is available in request.context()? (defined in TonicRequestExt which is available in lib::prelude::*).
Comment on lines
+200
to
+205
| .await | ||
| .map_err(ProjectStoreHandlerError::Store)?; |
There was a problem hiding this comment.
I think we should explore a better way for error handling, the number of .map_err is pretty high. I'll give it some thought.
ghstack-source-id: 2452ad00e890fa87497a785348ac29808eec1a40 Pull Request resolved: #18 This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`. 1. Adds a the model to the db model in metadata_svc and exposed it in the project store. 2. Expose setters/getters to notification settings in metadata svc. 3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience. Later, we can also add this to the CLI. Test plan: ``` ~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130 Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully. ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings @examples/notifications.json ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings { "channels": { "email": { "address": "[email protected]", "type": "email", "verified": false } }, "subscriptions": [ { "channel_names": [ "email" ], "event": { "type": "on_run_failure" } } ] } ```
MohamedBassem
force-pushed
the
gh/MohamedBassem/0/head
branch
from
76c949f
to
a24ed9f
Compare
MohamedBassem
dismissed
AhmedSoliman’s stale review
The base branch was changed.
[Events] Add project notification settings ghstack-source-id: 2452ad00e890fa87497a785348ac29808eec1a40 Pull Request resolved: #18 This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`. 1. Adds a the model to the db model in metadata_svc and exposed it in the project store. 2. Expose setters/getters to notification settings in metadata svc. 3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience. Later, we can also add this to the CLI. Test plan: ``` ~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130 Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully. ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings { "channels": { "email": { "address": "testgmail.com", "type": "email", "verified": false } }, "subscriptions": [ { "channel_names": [ "email" ], "event": { "type": "on_run_failure" } } ] } ``` [ghstack-poisoned]
[Events] Add project notification settings ghstack-source-id: 2452ad00e890fa87497a785348ac29808eec1a40 Pull Request resolved: #18 This PR adds a new model for project notifications. The semantics of the model is explained in `notifications.proto`. 1. Adds a the model to the db model in metadata_svc and exposed it in the project store. 2. Expose setters/getters to notification settings in metadata svc. 3. Expose APIs to manipulate the notification settings. I opted into having a single endpoint for updating the notification setting json for convenience. Later, we can also add this to the CLI. Test plan: ``` ~/repos/cronback/cronback ❯❯❯ cargo cli --localhost --secret-token adminkey admin projects create ✘ 130 Project 'prj_026601H699SE7VY0YEFHRXXE75117B' was created successfully. ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer POST http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings examples/notifications.json ~/repos/cronback/cronback ❯❯❯ http -b --auth adminkey --auth-type bearer GET http://localhost:8888/v1/admin/projects/prj_026601H699SE7VY0YEFHRXXE75117B/notification_settings { "channels": { "email": { "address": "testgmail.com", "type": "email", "verified": false } }, "subscriptions": [ { "channel_names": [ "email" ], "event": { "type": "on_run_failure" } } ] } ``` [ghstack-poisoned]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[Events] Add project notification settings
ghstack-source-id: 2452ad00e890fa87497a785348ac29808eec1a40
Pull Request resolved: #18
This PR adds a new model for project notifications. The semantics of the model is explained in
notifications.proto.Later, we can also add this to the CLI.
Test plan: