add rbac_permissions to current-user response + rbac_enabled to current-org response #2611

joeyorlando · 2023-07-21T07:15:49Z

What this PR does

unblocks https://github.com/grafana/oncall-mobile-app/issues/152

Checklist

Unit, integration, and e2e (if applicable) tests updated
Documentation added (or pr:no public docs PR label added if not required)
CHANGELOG.md updated (or pr:no changelog PR label added if not required)

endpoint response schemas

joeyorlando · 2023-07-21T07:19:59Z

@imtoori you can use these as such:

GET /api/internal/v1/current_team/ (not aptly named imo, actually represents the currently authenticated user's organization)

{
    "pk": "OJLC8P3BPHABN",
    "name": "Self-Hosted Organization",
    "slack_team_identity": null,
    "slack_channel": null,
    "rbac_enabled": true,
    "is_resolution_note_required": false,
    "env_status": {
        "telegram_configured": true,
        "phone_provider": {
            "configured": true,
            "test_sms": false,
            "test_call": true,
            "verification_call": false,
            "verification_sms": true
        }
    },
    "banner": {
        "body": null,
        "title": null
    }
}

GET /api/internal/v1/user/ - I believe you're already using this one

{
    ...<other stuff>
    "role": 0,
    "rbac_permissions": [
        {
            "action": "grafana-oncall-app.alert-groups:read"
        },
        {
            "action": "grafana-oncall-app.alert-groups:write"
        },
        ...<big list of permissions>
    ]
}

…ub.com:grafana/oncall into jorlando/add-rbac-permissions-to-user-response

vstpme

LGTM

vstpme · 2023-07-21T09:55:40Z

@joeyorlando I think current_team is used as the endpoint path because organization was called team in the past. I think a good solution would be to register the same view under an additional current_organization (or just organization) path, and update plugin & mobile app accordingly. It's probably out of the scope of this PR, but if it's a one line change consider adding it here so the mobile app uses the correct route right away.

joeyorlando · 2023-07-21T10:47:14Z

I think a good solution would be to register the same view under an additional current_organization (or just organization) path, and update plugin & mobile app accordingly

I like this idea, especially because it's easier to deprecate current_team if the mobile app isn't already consuming it. will give it a go 👍

joeyorlando · 2023-07-21T13:49:43Z

engine/apps/api/urls.py

@@ -106,5 +108,3 @@
    path(r"login/<backend>/", auth.overridden_login_slack_auth, name="slack-auth"),
    path(r"complete/<backend>/", auth.overridden_complete_slack_auth, name="complete-slack-auth"),
 ]
-
-urlpatterns += router.urls


this line is essentially a duplicate of line 69 and can be removed:

joeyorlando · 2023-07-21T14:02:53Z

@grafana/grafana-oncall-frontend can I get some 👀 ?

the main changes here are renaming teamStore -> organizationStore. the naming of teamStore was a bit misleading as it represents an organization, just needed to be updated (grafanaTeamStore === "team store"). Also updated the API calls to move calls to /current_team/ to /organization/. /current_team/ will be deprecated in the near future.

joeyorlando · 2023-07-21T14:12:04Z

grafana-plugin/src/models/organization/organization.ts

moved from TeamStore. There were a few things on TeamStore that were also removed as they were no longer used:

@observable redirectingToProperTeam = false; @observable.shallow teams: { [id: number]: Team[] } = {};

joeyorlando · 2023-07-21T14:15:32Z

grafana-plugin/src/models/organization/organization.ts

+
+  constructor(rootStore: RootStore) {
+    super(rootStore);
+    this.path = '/organization/';


this was changed from /current_team/, see this change on the backend

joeyorlando · 2023-07-21T14:16:01Z

grafana-plugin/src/models/organization/organization.types.ts

+    channel_chat_id: string;
    channel_name: string;
-    discussion_group_chat_id: number; // TODO check if string
+    discussion_group_chat_id: string;


these two changed fields are actually strings (verified on the backend)

joeyorlando · 2023-07-21T14:23:13Z

grafana-plugin/src/models/user/user.types.ts

@@ -36,7 +35,6 @@ export interface User {
    slack_login: string;
  } | null;
  post_onboarding_entry_allowed: any;
-  teams: Team[];


this is not used

joeyorlando · 2023-07-21T14:23:53Z

grafana-plugin/src/state/rootBaseStore/index.ts

-  userStore: UserStore = new UserStore(this);
-  cloudStore: CloudStore = new CloudStore(this);
-  directPagingStore: DirectPagingStore = new DirectPagingStore(this);
-  grafanaTeamStore: GrafanaTeamStore = new GrafanaTeamStore(this);
-  alertReceiveChannelStore: AlertReceiveChannelStore = new AlertReceiveChannelStore(this);
-  outgoingWebhookStore: OutgoingWebhookStore = new OutgoingWebhookStore(this);
-
-  outgoingWebhook2Store: OutgoingWebhook2Store = new OutgoingWebhook2Store(this);
-  alertReceiveChannelFiltersStore: AlertReceiveChannelFiltersStore = new AlertReceiveChannelFiltersStore(this);
-  escalationChainStore: EscalationChainStore = new EscalationChainStore(this);
-  escalationPolicyStore: EscalationPolicyStore = new EscalationPolicyStore(this);
-  teamStore: TeamStore = new TeamStore(this);
-  telegramChannelStore: TelegramChannelStore = new TelegramChannelStore(this);
-  slackStore: SlackStore = new SlackStore(this);
-  slackChannelStore: SlackChannelStore = new SlackChannelStore(this);
-  heartbeatStore: HeartbeatStore = new HeartbeatStore(this);
-  scheduleStore: ScheduleStore = new ScheduleStore(this);
-  userGroupStore: UserGroupStore = new UserGroupStore(this);
-  alertGroupStore: AlertGroupStore = new AlertGroupStore(this);
-  resolutionNotesStore: ResolutionNotesStore = new ResolutionNotesStore(this);
-  apiTokenStore: ApiTokenStore = new ApiTokenStore(this);
-  globalSettingStore: GlobalSettingStore = new GlobalSettingStore(this);
-  filtersStore: FiltersStore = new FiltersStore(this);


typing here is redundant. these attributes are properly typed w/o the explicit typing.

…nt-org response (#2611) # What this PR does unblocks grafana/oncall-mobile-app#152 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)

joeyorlando added 2 commits July 21, 2023 08:33

add RBAC related attributes to org/current user

d916abc

endpoint response schemas

finish testing

19906fc

joeyorlando added the pr:no public docs Added to a PR that does not require public documentation updates label Jul 21, 2023

joeyorlando requested review from a team July 21, 2023 07:15

joeyorlando and others added 2 commits July 21, 2023 09:16

update changelog

6477a2d

Merge branch 'dev' into jorlando/add-rbac-permissions-to-user-response

a142fee

joeyorlando added 3 commits July 21, 2023 09:23

remove logging statements

9a94916

fix failing CI test

262430c

Merge branch 'jorlando/add-rbac-permissions-to-user-response' of gith…

6a64f0d

…ub.com:grafana/oncall into jorlando/add-rbac-permissions-to-user-response

vstpme approved these changes Jul 21, 2023

View reviewed changes

joeyorlando added 2 commits July 21, 2023 15:29

refactor teamStore to organizationStore

c327f28

undo change to makefile

d0f4f32

joeyorlando requested a review from a team July 21, 2023 13:31

update comment

71423b1

joeyorlando commented Jul 21, 2023

View reviewed changes

Merge branch 'dev' into jorlando/add-rbac-permissions-to-user-response

47eb0cb

joeyorlando requested a review from vstpme July 21, 2023 14:26

vstpme approved these changes Jul 21, 2023

View reviewed changes

Merge branch 'dev' into jorlando/add-rbac-permissions-to-user-response

d1f512f

joeyorlando merged commit 3d70876 into dev Jul 21, 2023

joeyorlando deleted the jorlando/add-rbac-permissions-to-user-response branch July 21, 2023 15:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add rbac_permissions to current-user response + rbac_enabled to current-org response #2611

add rbac_permissions to current-user response + rbac_enabled to current-org response #2611

joeyorlando commented Jul 21, 2023

joeyorlando commented Jul 21, 2023

vstpme left a comment

vstpme commented Jul 21, 2023

joeyorlando commented Jul 21, 2023

joeyorlando Jul 21, 2023

joeyorlando commented Jul 21, 2023

joeyorlando Jul 21, 2023

joeyorlando Jul 21, 2023

joeyorlando Jul 21, 2023

joeyorlando Jul 21, 2023

joeyorlando Jul 21, 2023

add rbac_permissions to current-user response + rbac_enabled to current-org response #2611

add rbac_permissions to current-user response + rbac_enabled to current-org response #2611

Conversation

joeyorlando commented Jul 21, 2023

What this PR does

Checklist

joeyorlando commented Jul 21, 2023

vstpme left a comment

Choose a reason for hiding this comment

vstpme commented Jul 21, 2023

joeyorlando commented Jul 21, 2023

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment

joeyorlando commented Jul 21, 2023

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment

joeyorlando Jul 21, 2023

Choose a reason for hiding this comment