forked from kernelci/kernelci-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmain.py
More file actions
1714 lines (1482 loc) · 60.1 KB
/
main.py
File metadata and controls
1714 lines (1482 loc) · 60.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SPDX-License-Identifier: LGPL-2.1-or-later
#
# Copyright (C) 2021-2025 Collabora Limited
# Author: Guillaume Tucker <guillaume.tucker@collabora.com>
# Author: Jeny Sadadia <jeny.sadadia@collabora.com>
# Author: Denys Fedoryshchenko <denys.f@collabora.com>
# pylint: disable=unused-argument,global-statement,too-many-lines
"""KernelCI API main module"""
import os
import re
import asyncio
import traceback
import secrets
import ipaddress
from typing import List, Union, Optional
from datetime import datetime, timedelta, timezone
from contextlib import asynccontextmanager
from fastapi import (
Depends,
FastAPI,
HTTPException,
status,
Request,
Form,
Header,
Query,
Body,
Response,
)
from fastapi.encoders import jsonable_encoder
from fastapi.responses import (
JSONResponse,
PlainTextResponse,
FileResponse,
HTMLResponse
)
from fastapi.security import OAuth2PasswordRequestForm
from fastapi_pagination import add_pagination
from fastapi_versioning import VersionedFastAPI
from bson import ObjectId, errors
from fastapi_users import FastAPIUsers
from beanie import PydanticObjectId
from pydantic import BaseModel
from jose import jwt
from jose.exceptions import JWTError
from kernelci.api.models import (
Node,
Hierarchy,
PublishEvent,
parse_node_obj,
KernelVersion,
EventHistory,
)
from .auth import Authentication
from .db import Database
from .pubsub_mongo import PubSub
from .user_manager import get_user_manager, create_user_manager
from .models import (
PageModel,
Subscription,
SubscriptionStats,
User,
UserRead,
UserCreate,
UserCreateRequest,
UserInviteRequest,
UserInviteResponse,
UserUpdate,
UserUpdateRequest,
UserGroup,
UserGroupCreateRequest,
InviteAcceptRequest,
InviteUrlResponse,
)
from .metrics import Metrics
from .maintenance import purge_old_nodes
from .config import AuthSettings
SUBSCRIPTION_CLEANUP_INTERVAL_MINUTES = 15 # How often to run cleanup task
SUBSCRIPTION_MAX_AGE_MINUTES = 15 # Max age before stale
SUBSCRIPTION_CLEANUP_RETRY_MINUTES = 1 # Retry interval if cleanup fails
@asynccontextmanager
async def lifespan(app: FastAPI): # pylint: disable=redefined-outer-name
"""Lifespan functions for startup and shutdown events"""
await pubsub_startup()
await create_indexes()
await initialize_beanie()
await ensure_legacy_node_editors()
yield
# List of all the supported API versions. This is a placeholder until the API
# actually supports multiple versions with different sets of endpoints and
# models etc.
API_VERSIONS = ['v0']
metrics = Metrics()
app = FastAPI(lifespan=lifespan, debug=True, docs_url=None, redoc_url=None)
db = Database(service=(os.getenv('MONGO_SERVICE') or 'mongodb://db:27017'))
auth = Authentication(token_url="user/login")
pubsub = None # pylint: disable=invalid-name
auth_backend = auth.get_user_authentication_backend()
fastapi_users_instance = FastAPIUsers[User, PydanticObjectId](
get_user_manager,
[auth_backend],
)
user_manager = create_user_manager()
async def pubsub_startup():
"""Startup event handler to create Pub/Sub object"""
global pubsub # pylint: disable=invalid-name
pubsub = await PubSub.create()
async def subscription_cleanup_task():
"""Background task to cleanup stale subscriptions"""
while True:
try:
await asyncio.sleep(SUBSCRIPTION_CLEANUP_INTERVAL_MINUTES * 60)
cleaned = await pubsub.cleanup_stale_subscriptions(
SUBSCRIPTION_MAX_AGE_MINUTES)
if cleaned > 0:
metrics.add('subscriptions_cleaned', 1)
print(f"Cleaned up {cleaned} stale subscriptions")
except (ConnectionError, OSError, RuntimeError) as e:
print(f"Subscription cleanup error: {e}")
await asyncio.sleep(SUBSCRIPTION_CLEANUP_RETRY_MINUTES * 60)
async def start_background_tasks():
"""Start background cleanup tasks"""
asyncio.create_task(subscription_cleanup_task())
async def create_indexes():
"""Startup event handler to create database indexes"""
await db.create_indexes()
async def initialize_beanie():
"""Startup event handler to initialize Beanie"""
await db.initialize_beanie()
async def ensure_legacy_node_editors():
"""Grant legacy node edit privileges to specific users."""
legacy_usernames = {'staging.kernelci.org', 'production'}
group_name = 'node:edit:any'
group = await db.find_one(UserGroup, name=group_name)
if not group:
group = await db.create(UserGroup(name=group_name))
for username in legacy_usernames:
user = await db.find_one(User, username=username)
if not user:
continue
if any(existing.name == group_name for existing in user.groups):
continue
user.groups.append(group)
await db.update(user)
@app.exception_handler(ValueError)
async def value_error_exception_handler(request: Request, exc: ValueError):
"""Global exception handler for 'ValueError'"""
return JSONResponse(
status_code=status.HTTP_400_BAD_REQUEST,
content={"detail": str(exc)},
)
@app.exception_handler(errors.InvalidId)
async def invalid_id_exception_handler(
request: Request,
exc: errors.InvalidId):
"""Global exception handler for `errors.InvalidId`
The exception is raised from Database when invalid ObjectId is received"""
return JSONResponse(
status_code=status.HTTP_400_BAD_REQUEST,
content={"detail": str(exc)},
)
@app.get('/')
async def root():
"""Root endpoint handler"""
metrics.add('http_requests_total', 1)
root_dir = os.path.dirname(os.path.abspath(__file__))
index_path = os.path.join(root_dir, 'templates', 'index.html')
with open(index_path, 'r', encoding='utf-8') as file:
return HTMLResponse(file.read())
# -----------------------------------------------------------------------------
# Users
def get_current_user(user: User = Depends(
fastapi_users_instance.current_user(active=True))):
"""Get current active user"""
return user
def get_current_superuser(user: User = Depends(
fastapi_users_instance.current_user(active=True, superuser=True))):
"""Get current active superuser"""
return user
async def _resolve_user_groups(group_names: List[str]) -> List[UserGroup]:
groups: List[UserGroup] = []
for group_name in group_names:
group = await db.find_one(UserGroup, name=group_name)
if not group:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"User group does not exist with name: {group_name}",
)
groups.append(group)
return groups
def _create_invite_token(user: User) -> str:
settings = AuthSettings()
now = datetime.now(timezone.utc)
exp = now + timedelta(seconds=settings.invite_token_expire_seconds)
payload = {
"sub": str(user.id),
"email": user.email,
"purpose": "invite",
"iat": int(now.timestamp()),
"exp": int(exp.timestamp()),
}
return jwt.encode(
payload,
settings.secret_key,
algorithm=settings.algorithm,
)
def _decode_invite_token(token: str) -> dict:
settings = AuthSettings()
try:
payload = jwt.decode(
token,
settings.secret_key,
algorithms=[settings.algorithm],
)
except JWTError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid or expired invite token",
) from exc
if payload.get("purpose") != "invite":
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid invite token",
)
return payload
def _resolve_public_base_url(request: Request) -> str:
settings = AuthSettings()
if settings.public_base_url:
return settings.public_base_url.rstrip("/")
def _is_proxy_addr() -> bool:
client = request.client
if not client or not client.host:
return False
try:
ip_addr = ipaddress.ip_address(client.host)
except ValueError:
return False
return not ip_addr.is_global
forwarded_host = None
forwarded_proto = None
forwarded_header = request.headers.get("forwarded")
if forwarded_header and _is_proxy_addr():
first_hop = forwarded_header.split(",", 1)[0]
for pair in first_hop.split(";"):
if "=" not in pair:
continue
key, value = pair.split("=", 1)
key = key.strip().lower()
value = value.strip().strip('"')
if key == "host":
forwarded_host = value
elif key == "proto":
forwarded_proto = value
if _is_proxy_addr():
forwarded_host = forwarded_host or request.headers.get(
"x-forwarded-host"
)
forwarded_proto = forwarded_proto or request.headers.get(
"x-forwarded-proto"
)
if forwarded_host:
scheme = forwarded_proto or request.url.scheme
return (scheme + "://" + forwarded_host).rstrip("/")
return str(request.base_url).rstrip("/")
def _accept_invite_url(public_base_url: str) -> str:
return f"{public_base_url}/user/accept-invite"
async def _find_existing_user_for_invite(
invite: UserInviteRequest,
) -> User | None:
existing_by_username = await db.find_one(User, username=invite.username)
if existing_by_username:
return existing_by_username
return await db.find_one(User, email=invite.email)
def _validate_invite_resend(existing_user: User, invite: UserInviteRequest):
if not invite.resend_if_exists:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="User already exists",
)
if existing_user.is_verified:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="User already verified",
)
if existing_user.username != invite.username:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Existing user has a different username",
)
if existing_user.email != invite.email:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Existing user has a different email",
)
async def _create_user_for_invite(
request: Request,
invite: UserInviteRequest,
) -> User:
groups: List[UserGroup] = []
if invite.groups:
groups = await _resolve_user_groups(invite.groups)
random_password = secrets.token_urlsafe(32)
user_create = UserCreate(
username=invite.username,
email=invite.email,
password=random_password,
is_superuser=invite.is_superuser,
)
user_create.groups = groups
created_user = await register_router.routes[0].endpoint(
request, user_create, user_manager)
if invite.is_superuser:
user_from_id = await db.find_by_id(User, created_user.id)
user_from_id.is_superuser = True
created_user = await db.update(user_from_id)
return created_user
app.include_router(
fastapi_users_instance.get_auth_router(auth_backend,
requires_verification=True),
prefix="/user",
tags=["user"]
)
register_router = fastapi_users_instance.get_register_router(
UserRead, UserCreate)
@app.post("/user/register", response_model=UserRead, tags=["user"],
response_model_by_alias=False)
async def register(request: Request, user: UserCreateRequest,
current_user: User = Depends(get_current_superuser)):
"""User registration route
Custom user registration router to ensure unique username.
`user` from request has a list of user group name strings.
This handler will convert them to `UserGroup` objects and
insert user object to database.
"""
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="User registration is disabled; use /user/invite instead.",
)
@app.get("/user/invite", response_class=HTMLResponse, include_in_schema=False)
async def invite_user_page():
"""Web UI for inviting a user (admin token required)"""
metrics.add('http_requests_total', 1)
root_dir = os.path.dirname(os.path.abspath(__file__))
page_path = os.path.join(root_dir, 'templates', 'invite.html')
with open(page_path, 'r', encoding='utf-8') as file:
return HTMLResponse(file.read())
@app.post("/user/invite", response_model=UserInviteResponse, tags=["user"],
response_model_by_alias=False)
async def invite_user(request: Request, invite: UserInviteRequest,
current_user: User = Depends(get_current_superuser)):
"""Invite a user (admin-only)
Creates the user with a random password and sends a single invite link
to set a password and verify the account.
"""
metrics.add('http_requests_total', 1)
existing_user = await _find_existing_user_for_invite(invite)
if existing_user:
_validate_invite_resend(existing_user, invite)
created_user = existing_user
else:
created_user = await _create_user_for_invite(request, invite)
public_base_url = _resolve_public_base_url(request)
accept_invite_url = _accept_invite_url(public_base_url)
token = _create_invite_token(created_user)
invite_url = f"{accept_invite_url}?token={token}"
email_sent = False
if invite.send_email:
try:
await user_manager.send_invite_email(
created_user,
token,
invite_url,
)
email_sent = True
except Exception as exc: # pylint: disable=broad-exception-caught
print(f"Failed to send invite email: {exc}")
return UserInviteResponse(
user=created_user,
email_sent=email_sent,
public_base_url=public_base_url,
accept_invite_url=accept_invite_url,
invite_url=invite_url if invite.return_token else None,
token=token if invite.return_token else None,
)
@app.get(
"/user/accept-invite",
response_class=HTMLResponse,
include_in_schema=False,
)
async def accept_invite_page():
"""Web UI for accepting an invite (sets password + verifies)"""
metrics.add('http_requests_total', 1)
root_dir = os.path.dirname(os.path.abspath(__file__))
page_path = os.path.join(root_dir, 'templates', 'accept-invite.html')
with open(page_path, 'r', encoding='utf-8') as file:
return HTMLResponse(file.read())
@app.get("/user/invite/url", response_model=InviteUrlResponse, tags=["user"])
async def invite_url_preview(request: Request,
current_user: User = Depends(
get_current_superuser)):
"""Preview the resolved public URL used in invite links (admin-only)"""
metrics.add('http_requests_total', 1)
public_base_url = _resolve_public_base_url(request)
return InviteUrlResponse(
public_base_url=public_base_url,
accept_invite_url=_accept_invite_url(public_base_url),
)
@app.post("/user/accept-invite", response_model=UserRead, tags=["user"],
response_model_by_alias=False)
async def accept_invite(accept: InviteAcceptRequest):
"""Accept an invite token, set password, and verify the user"""
metrics.add('http_requests_total', 1)
payload = _decode_invite_token(accept.token)
user_id = payload.get("sub")
email = payload.get("email")
user_from_id = await db.find_by_id(User, user_id)
if not user_from_id:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="User not found",
)
if not user_from_id.is_active:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="User is inactive",
)
if user_from_id.email != email:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid invite token",
)
if user_from_id.is_verified:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invite already accepted",
)
user_from_id.hashed_password = user_manager.password_helper.hash(
accept.password
)
user_from_id.is_verified = True
updated_user = await db.update(user_from_id)
try:
await user_manager.send_invite_accepted_email(updated_user)
except Exception as exc: # pylint: disable=broad-exception-caught
print(f"Failed to send invite accepted email: {exc}")
return updated_user
app.include_router(
fastapi_users_instance.get_reset_password_router(),
prefix="/user",
tags=["user"],
)
users_router = fastapi_users_instance.get_users_router(
UserRead, UserUpdate, requires_verification=True)
app.add_api_route(
path="/whoami",
tags=["user"],
methods=["GET"],
description="Get current user information",
endpoint=users_router.routes[0].endpoint)
app.add_api_route(
path="/user/{id}",
tags=["user"],
methods=["GET"],
description="Get user information by ID",
dependencies=[Depends(get_current_user)],
endpoint=users_router.routes[2].endpoint)
app.add_api_route(
path="/user/{id}",
tags=["user"],
methods=["DELETE"],
description="Delete user by ID",
dependencies=[Depends(get_current_superuser)],
endpoint=users_router.routes[4].endpoint)
@app.patch("/user/me", response_model=UserRead, tags=["user"],
response_model_by_alias=False)
async def update_me(request: Request, user: UserUpdateRequest,
current_user: User = Depends(get_current_user)):
"""User update route
Custom user update router handler will only allow users to update
its own profile.
"""
metrics.add('http_requests_total', 1)
if user.groups:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="User groups can only be updated by an admin user",
)
if user.username and user.username != current_user.username:
existing_user = await db.find_one(User, username=user.username)
if existing_user:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Username already exists: {user.username}",
)
groups = []
if user.groups:
for group_name in user.groups:
group = await db.find_one(UserGroup, name=group_name)
if not group:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=(
"User group does not exist with name: "
f"{group_name}"
),
)
groups.append(group)
user_update = UserUpdate(**(user.model_dump(
exclude={'groups', 'is_superuser'}, exclude_none=True)))
if groups:
user_update.groups = groups
return await users_router.routes[1].endpoint(
request, user_update, current_user, user_manager)
@app.patch("/user/{user_id}", response_model=UserRead, tags=["user"],
response_model_by_alias=False)
async def update_user(user_id: str, request: Request, user: UserUpdateRequest,
current_user: User = Depends(get_current_superuser)):
"""Router to allow admin users to update other user account"""
metrics.add('http_requests_total', 1)
user_from_id = await db.find_by_id(User, user_id)
if not user_from_id:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"User not found with id: {user_id}",
)
if user.username and user.username != user_from_id.username:
existing_user = await db.find_one(User, username=user.username)
if existing_user:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Username already exists: {user.username}",
)
groups = []
if user.groups:
for group_name in user.groups:
group = await db.find_one(UserGroup, name=group_name)
if not group:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=(
"User group does not exist with name: "
f"{group_name}"
),
)
groups.append(group)
user_update = UserUpdate(**(user.model_dump(
exclude={'groups'}, exclude_none=True)))
if groups:
user_update.groups = groups
updated_user = await users_router.routes[3].endpoint(
user_update, request, user_from_id, user_manager
)
# Update superuser explicitly since fastapi-users update route ignores it.
if user.is_superuser is not None:
user_from_id = await db.find_by_id(User, updated_user.id)
user_from_id.is_superuser = user.is_superuser
updated_user = await db.update(user_from_id)
return updated_user
@app.get("/user-groups", response_model=PageModel, tags=["user"])
async def get_user_groups(request: Request,
current_user: User = Depends(get_current_superuser)):
"""List user groups (admin-only)."""
metrics.add('http_requests_total', 1)
query_params = dict(request.query_params)
for pg_key in ['limit', 'offset']:
query_params.pop(pg_key, None)
paginated_resp = await db.find_by_attributes(UserGroup, query_params)
paginated_resp.items = serialize_paginated_data(
UserGroup, paginated_resp.items)
return paginated_resp
@app.get("/user-groups/{group_id}", response_model=UserGroup, tags=["user"],
response_model_by_alias=False)
async def get_user_group(group_id: str,
current_user: User = Depends(get_current_superuser)):
"""Get a user group by id (admin-only)."""
metrics.add('http_requests_total', 1)
group = await db.find_by_id(UserGroup, group_id)
if not group:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"User group not found with id: {group_id}",
)
return group
@app.post("/user-groups", response_model=UserGroup, tags=["user"],
response_model_by_alias=False)
async def create_user_group(group: UserGroupCreateRequest,
current_user: User = Depends(
get_current_superuser)):
"""Create a user group (admin-only)."""
metrics.add('http_requests_total', 1)
existing = await db.find_one(UserGroup, name=group.name)
if existing:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"User group already exists with name: {group.name}",
)
return await db.create(UserGroup(name=group.name))
@app.delete("/user-groups/{group_id}", status_code=status.HTTP_204_NO_CONTENT,
tags=["user"])
async def delete_user_group(group_id: str,
current_user: User = Depends(
get_current_superuser)):
"""Delete a user group (admin-only)."""
metrics.add('http_requests_total', 1)
group = await db.find_by_id(UserGroup, group_id)
if not group:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"User group not found with id: {group_id}",
)
assigned_count = await db.count(User, {"groups.name": group.name})
if assigned_count:
raise HTTPException(
status_code=status.HTTP_409_CONFLICT,
detail=(
"User group is assigned to users and cannot be deleted. "
"Remove it from users first."
),
)
await db.delete_by_id(UserGroup, group_id)
return Response(status_code=status.HTTP_204_NO_CONTENT)
def _get_node_runtime(node: Node) -> Optional[str]:
"""Best-effort runtime lookup from node data."""
data = getattr(node, 'data', None)
if isinstance(data, dict):
return data.get('runtime')
return getattr(data, 'runtime', None)
def _user_can_edit_node(user: User, node: Node) -> bool:
"""Return True when user can update the given node."""
if user.is_superuser:
return True
if user.username == node.owner:
return True
user_group_names = {group.name for group in user.groups}
if 'node:edit:any' in user_group_names:
return True
if any(group_name in user_group_names
for group_name in getattr(node, 'user_groups', [])):
return True
runtime = _get_node_runtime(node)
if runtime:
runtime_editor = ":".join(['runtime', runtime, 'node-editor'])
runtime_admin = ":".join(['runtime', runtime, 'node-admin'])
if (runtime_editor in user_group_names
or runtime_admin in user_group_names):
return True
return False
async def authorize_user(node_id: str,
user: User = Depends(get_current_user)):
"""Return the user if active, authenticated, and authorized"""
# Only the user that created the node or any other user from the permitted
# user groups will be allowed to update the node
node_from_id = await db.find_by_id(Node, node_id)
if not node_from_id:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Node not found with id: {node_id}"
)
if not _user_can_edit_node(user, node_from_id):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Unauthorized to complete the operation"
)
return user
@app.get('/users', response_model=PageModel, tags=["user"],
response_model_exclude={"items": {"__all__": {
"hashed_password"}}})
async def get_users(request: Request,
current_user: User = Depends(get_current_user)):
"""Get all the users if no request parameters have passed.
Get the matching users otherwise."""
metrics.add('http_requests_total', 1)
query_params = dict(request.query_params)
# Drop pagination parameters from query as they're already in arguments
for pg_key in ['limit', 'offset']:
query_params.pop(pg_key, None)
paginated_resp = await db.find_by_attributes(User, query_params)
paginated_resp.items = serialize_paginated_data(
User, paginated_resp.items)
return paginated_resp
@app.post("/user/update-password", tags=["user"])
async def update_password(request: Request,
credentials: OAuth2PasswordRequestForm = Depends(),
new_password: str = Form(None)):
"""Update user password"""
metrics.add('http_requests_total', 1)
user = await user_manager.authenticate(credentials)
if user is None or not user.is_active:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="LOGIN_BAD_CREDENTIALS",
)
user_update = UserUpdate(password=new_password)
user_from_username = await db.find_one(User, username=credentials.username)
await users_router.routes[3].endpoint(
user_update, request, user_from_username, user_manager
)
# EventHistory is now stored by pubsub.publish_cloudevent()
# No need for separate _get_eventhistory function
def _parse_event_id_filter(query_params: dict, event_id: str,
event_ids: str) -> None:
"""Parse and validate event id/ids filter parameters.
Modifies query_params in place to add _id filter.
Raises HTTPException on validation errors.
"""
if event_id and event_ids:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Provide either id or ids, not both"
)
if event_id:
try:
query_params['_id'] = ObjectId(event_id)
except (errors.InvalidId, TypeError) as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid id format"
) from exc
elif event_ids:
try:
ids_list = [ObjectId(x.strip())
for x in event_ids.split(',') if x.strip()]
except (errors.InvalidId, TypeError) as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid ids format"
) from exc
if not ids_list:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="ids must contain at least one id"
)
query_params['_id'] = {'$in': ids_list}
def _build_events_query(query_params: dict) -> tuple:
"""Extract and process event query parameters.
Returns (recursive, processed_query_params).
Raises HTTPException on validation errors.
"""
# Simple filters: param_name -> query_field
simple_filters = {
'kind': 'data.kind',
'state': 'data.state',
'result': 'data.result',
'op': 'data.op',
'name': 'data.name',
'group': 'data.group',
'owner': 'data.owner',
'channel': 'channel',
}
recursive = query_params.pop('recursive', None)
limit = query_params.pop('limit', None)
from_ts = query_params.pop('from', None)
node_id = query_params.pop('node_id', None)
path = query_params.pop('path', None)
# Apply simple filters
for param, field in simple_filters.items():
value = query_params.pop(param, None)
if value:
query_params[field] = value
if node_id:
if 'data.id' in query_params:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Provide either node_id or data.id, not both"
)
query_params['data.id'] = node_id
event_id = query_params.pop('id', None)
event_ids = query_params.pop('ids', None)
_parse_event_id_filter(query_params, event_id, event_ids)
if from_ts:
if isinstance(from_ts, str):
try:
from_ts = datetime.fromisoformat(from_ts)
except ValueError as exc:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Invalid 'from' parameter, must be an ISO 8601 datetime"
) from exc
query_params['timestamp'] = {'$gt': from_ts}
if path:
query_params['data.path'] = {'$regex': path}
if limit:
query_params['limit'] = int(limit)
if recursive and (not limit or int(limit) > 1000):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Recursive limit is too large, max is 1000"
)
return recursive, query_params
# TBD: Restrict response by Pydantic model
@app.get('/events')
async def get_events(request: Request):
"""Get all the events if no request parameters have passed.
Format: [{event1}, {event2}, ...] or if recursive is set to true,
then we add to each event the node information.
Get all the matching events otherwise.
Query parameters can be used to filter the events:
- limit: Number of events to return
- from: Start timestamp (unix epoch or ISO format) to filter events
- kind: Event kind to filter events
- state: Event state to filter events
- result: Event result to filter events
- op: Operation type ('created', 'updated')
- name: Node name to filter events
- path: Node path to filter events (regex pattern)
- group: Node group to filter events
- owner: Node owner to filter events
- channel: Pub/sub channel to filter events
- id / ids: Event document id(s) to filter events
- node_id: Node id to filter events (alias for data.id)
- recursive: Retrieve node together with event
This API endpoint is under development and may change in future.
"""
metrics.add('http_requests_total', 1)
query_params = dict(request.query_params)
recursive, query_params = _build_events_query(query_params)
resp = await db.find_by_attributes_nonpaginated(EventHistory, query_params)
resp_list = []
for item in resp:
item['id'] = str(item['_id'])
item.pop('_id')
if recursive:
node = await db.find_by_id(Node, item['data']['id'])
if node:
item['node'] = node
resp_list.append(item)
json_comp = jsonable_encoder(resp_list)
return JSONResponse(content=json_comp)
# -----------------------------------------------------------------------------
# Nodes
def _get_node_event_data(operation, node, is_hierarchy=False):
return {
'op': operation,
'id': str(node.id),
'kind': node.kind,
'name': node.name,
'path': node.path,
'group': node.group,
'state': node.state,
'result': node.result,
'owner': node.owner,
'data': node.data,
'is_hierarchy': is_hierarchy,
}
async def translate_null_query_params(query_params: dict):
"""Translate null query parameters to None"""
translated = query_params.copy()
for key, value in query_params.items():
if value == 'null':
translated[key] = None
return translated
@app.get('/node/{node_id}', response_model=Union[Node, None],
response_model_by_alias=False)
async def get_node(node_id: str):
"""Get node information from the provided node id"""
metrics.add('http_requests_total', 1)
try:
return await db.find_by_id(Node, node_id)
except KeyError as error:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"Node not found with the kind: {str(error)}"
) from error