api.py 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. import logging
  2. from typing import Optional
  3. import orjson
  4. from allauth.socialaccount.models import SocialApp
  5. from allauth.socialaccount.providers.openid_connect.views import (
  6. OpenIDConnectOAuth2Adapter,
  7. )
  8. from asgiref.sync import sync_to_async
  9. from django.conf import settings
  10. from django.contrib.auth import aget_user
  11. from django.http import HttpRequest
  12. from ninja import Field, ModelSchema, NinjaAPI, Schema
  13. from ninja.errors import ValidationError
  14. from sentry_sdk import capture_exception, set_context, set_level
  15. from apps.alerts.api import router as alerts_router
  16. from apps.api_tokens.api import router as api_tokens_router
  17. from apps.api_tokens.models import APIToken
  18. from apps.api_tokens.schema import APITokenSchema
  19. from apps.environments.api import router as environments_router
  20. from apps.event_ingest.api import router as event_ingest_router
  21. from apps.event_ingest.embed_api import router as embed_router
  22. from apps.files.api import router as files_router
  23. from apps.importer.api import router as importer_router
  24. from apps.issue_events.api import router as issue_events_router
  25. from apps.organizations_ext.api import router as organizations_ext_router
  26. from apps.projects.api import router as projects_router
  27. from apps.releases.api import router as releases_router
  28. from apps.teams.api import router as teams_router
  29. from apps.users.api import router as users_router
  30. from apps.users.models import User
  31. from apps.users.schema import UserSchema
  32. from apps.users.utils import ais_user_registration_open
  33. from apps.wizard.api import router as wizard_router
  34. from glitchtip.constants import SOCIAL_ADAPTER_MAP
  35. from ..schema import CamelSchema
  36. from .authentication import SessionAuth, TokenAuth
  37. from .exceptions import ThrottleException
  38. from .parsers import EnvelopeParser
  39. try:
  40. from djstripe.settings import djstripe_settings
  41. except ImportError:
  42. pass
  43. logger = logging.getLogger(__name__)
  44. api = NinjaAPI(
  45. parser=EnvelopeParser(),
  46. title="GlitchTip API",
  47. urls_namespace="api",
  48. auth=[TokenAuth(), SessionAuth()],
  49. )
  50. api.add_router("0", api_tokens_router)
  51. api.add_router("", event_ingest_router)
  52. api.add_router("0", alerts_router)
  53. api.add_router("0", environments_router)
  54. api.add_router("0", files_router)
  55. api.add_router("0", importer_router)
  56. api.add_router("0", issue_events_router)
  57. api.add_router("0", organizations_ext_router)
  58. api.add_router("0", projects_router)
  59. api.add_router("0", teams_router)
  60. api.add_router("0", users_router)
  61. api.add_router("0", wizard_router)
  62. api.add_router("0", releases_router)
  63. api.add_router("embed", embed_router)
  64. # Would be better at the router level
  65. # https://github.com/vitalik/django-ninja/issues/442
  66. @api.exception_handler(ValidationError)
  67. def log_validation(request, exc):
  68. if request.resolver_match.route == "api/<project_id>/envelope/":
  69. set_level("warning")
  70. set_context(
  71. "incoming event", [orjson.loads(line) for line in request.body.splitlines()]
  72. )
  73. capture_exception(exc)
  74. logger.warning(f"Validation error on {request.path}", exc_info=exc)
  75. return api.create_response(request, {"detail": exc.errors}, status=422)
  76. @api.exception_handler(ThrottleException)
  77. def throttled(request: HttpRequest, exc: ThrottleException):
  78. response = api.create_response(
  79. request,
  80. {"message": "Please retry later"},
  81. status=429,
  82. )
  83. if retry_after := exc.retry_after:
  84. if isinstance(retry_after, int):
  85. response["Retry-After"] = retry_after
  86. else:
  87. response["Retry-After"] = retry_after.strftime("%a, %d %b %Y %H:%M:%S GMT")
  88. return response
  89. class SocialAppSchema(ModelSchema):
  90. scopes: list[str]
  91. authorize_url: Optional[str]
  92. class Config:
  93. model = SocialApp
  94. model_fields = ["name", "client_id", "provider"]
  95. class SettingsOut(CamelSchema):
  96. social_apps: list[SocialAppSchema]
  97. billing_enabled: bool
  98. i_paid_for_glitchtip: bool = Field(serialization_alias="iPaidForGlitchTip")
  99. enable_user_registration: bool
  100. enable_organization_creation: bool
  101. stripe_public_key: Optional[str]
  102. plausible_url: Optional[str]
  103. plausible_domain: Optional[str]
  104. chatwoot_website_token: Optional[str]
  105. sentryDSN: Optional[str]
  106. sentry_traces_sample_rate: Optional[float]
  107. environment: Optional[str]
  108. version: str
  109. server_time_zone: str
  110. @api.get("settings/", response=SettingsOut, by_alias=True, auth=None)
  111. async def get_settings(request: HttpRequest):
  112. social_apps: list[SocialApp] = []
  113. async for social_app in SocialApp.objects.order_by("name"):
  114. provider = social_app.get_provider(request)
  115. social_app.scopes = provider.get_scope()
  116. adapter_cls = SOCIAL_ADAPTER_MAP.get(social_app.provider)
  117. if adapter_cls == OpenIDConnectOAuth2Adapter:
  118. adapter = adapter_cls(request, social_app.provider_id)
  119. elif adapter_cls:
  120. adapter = adapter_cls(request)
  121. else:
  122. adapter = None
  123. if adapter:
  124. social_app.authorize_url = await sync_to_async(
  125. lambda: adapter.authorize_url
  126. )()
  127. social_app.provider = social_app.provider_id or social_app.provider
  128. social_apps.append(social_app)
  129. billing_enabled = settings.BILLING_ENABLED
  130. return {
  131. "social_apps": social_apps,
  132. "billing_enabled": billing_enabled,
  133. "i_paid_for_glitchtip": settings.I_PAID_FOR_GLITCHTIP,
  134. "enable_user_registration": await ais_user_registration_open(),
  135. "enable_organization_creation": settings.ENABLE_ORGANIZATION_CREATION,
  136. "stripe_public_key": djstripe_settings.STRIPE_PUBLIC_KEY
  137. if billing_enabled
  138. else None,
  139. "plausible_url": settings.PLAUSIBLE_URL,
  140. "plausible_domain": settings.PLAUSIBLE_DOMAIN,
  141. "chatwoot_website_token": settings.CHATWOOT_WEBSITE_TOKEN,
  142. "sentryDSN": settings.SENTRY_FRONTEND_DSN,
  143. "sentry_traces_sample_rate": settings.SENTRY_TRACES_SAMPLE_RATE,
  144. "environment": settings.ENVIRONMENT,
  145. "version": settings.GLITCHTIP_VERSION,
  146. "server_time_zone": settings.TIME_ZONE,
  147. }
  148. class APIRootSchema(Schema):
  149. version: str
  150. user: Optional[UserSchema]
  151. auth: Optional[APITokenSchema]
  152. @api.get("0/", auth=None, response=APIRootSchema)
  153. async def api_root(request: HttpRequest):
  154. """/api/0/ gives information about the server and current user"""
  155. user_data = None
  156. auth_data = None
  157. user = await aget_user(request)
  158. if user.is_authenticated:
  159. user_data = await User.objects.prefetch_related("socialaccount_set").aget(
  160. id=user.id
  161. )
  162. # Fetch api auth header to get api token
  163. openapi_scheme = "bearer"
  164. header = "Authorization"
  165. headers = request.headers
  166. auth_value = headers.get(header)
  167. if auth_value:
  168. parts = auth_value.split(" ")
  169. if len(parts) >= 2 and parts[0].lower() == openapi_scheme:
  170. token = " ".join(parts[1:])
  171. api_token = await APIToken.objects.filter(
  172. token=token, user__is_active=True
  173. ).afirst()
  174. if api_token:
  175. auth_data = api_token
  176. user_data = await User.objects.prefetch_related(
  177. "socialaccount_set"
  178. ).aget(id=api_token.user_id)
  179. return {
  180. "version": "0",
  181. "user": user_data,
  182. "auth": auth_data,
  183. }