bfcc0b9f29
# What this PR does
Introduces a new class,
`apps.grafana_plugin.ui_url_builder.UIURLBuilder`, which is responsible
for... building UI URLs (😄). The class mainly does two things:
- it will decide if the URL should point to `grafana-oncall-app` or
`grafana-irm-app` based on the value of
`organization.is_grafana_irm_enabled` (**NOTE**: this value isn't yet
being set + defaults to `False`; logic for setting this value will be
done in a subsequent PR)
- Adds `enum`s, `OnCallPage` and `IncidentPage` to DRYify hardcoded UI
URLs (in case we decide to change these slightly in the near future)
## 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] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
show up in the autogenerated release notes.
58 lines
2.2 KiB
Python
58 lines
2.2 KiB
Python
import typing
|
|
from urllib.parse import urljoin
|
|
|
|
from common.constants.plugin_ids import PluginID
|
|
|
|
if typing.TYPE_CHECKING:
|
|
from apps.user_management.models import Organization
|
|
|
|
|
|
class UIURLBuilder:
|
|
"""
|
|
If `base_url` is passed into the constructor, it will override using `organization.grafana_url`
|
|
"""
|
|
|
|
def __init__(self, organization: "Organization", base_url: typing.Optional[str] = None) -> None:
|
|
self.base_url = base_url if base_url else organization.grafana_url
|
|
self.is_grafana_irm_enabled = organization.is_grafana_irm_enabled
|
|
|
|
def _build_url(self, page: str, path_extra: str = "", plugin_id: typing.Optional[str] = None) -> str:
|
|
"""
|
|
Constructs an absolute URL to a Grafana plugin page.
|
|
"""
|
|
if not plugin_id:
|
|
plugin_id = PluginID.IRM if self.is_grafana_irm_enabled else PluginID.ONCALL
|
|
return urljoin(self.base_url, f"a/{plugin_id}/{page}{path_extra}")
|
|
|
|
def home(self, path_extra: str = "") -> str:
|
|
return self._build_url("", path_extra)
|
|
|
|
def alert_groups(self, path_extra: str = "") -> str:
|
|
return self._build_url("alert-groups", path_extra)
|
|
|
|
def alert_group_detail(self, id: str, path_extra: str = "") -> str:
|
|
return self._build_url(f"alert-groups/{id}", path_extra)
|
|
|
|
def integration_detail(self, id: str, path_extra: str = "") -> str:
|
|
return self._build_url(f"integrations/{id}", path_extra)
|
|
|
|
def schedules(self, path_extra: str = "") -> str:
|
|
return self._build_url("schedules", path_extra)
|
|
|
|
def schedule_detail(self, id: str, path_extra: str = "") -> str:
|
|
return self._build_url(f"schedules/{id}", path_extra)
|
|
|
|
def users(self, path_extra: str = "") -> str:
|
|
return self._build_url("users", path_extra)
|
|
|
|
def user_profile(self, path_extra: str = "") -> str:
|
|
return self._build_url("users/me", path_extra)
|
|
|
|
def chatops(self, path_extra: str = "") -> str:
|
|
return self._build_url("chat-ops", path_extra)
|
|
|
|
def settings(self, path_extra: str = "") -> str:
|
|
return self._build_url("settings", path_extra)
|
|
|
|
def declare_incident(self, path_extra: str = "") -> str:
|
|
return self._build_url("incidents/declare", path_extra, plugin_id=PluginID.INCIDENT)
|