Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Generate JobId as UUIDv7 #58

Merged
merged 2 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions backend/mypy.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[mypy]
mypy_path = stubs
5 changes: 2 additions & 3 deletions backend/oqtopus_cloud/user/routers/jobs.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import json
import uuid
from datetime import datetime
from typing import Any

Expand All @@ -12,6 +11,7 @@
from sqlalchemy.orm import (
Session,
)
from uuid_extensions import uuid7
from zoneinfo import ZoneInfo

from oqtopus_cloud.common.models.device import Device
Expand Down Expand Up @@ -120,8 +120,7 @@ def submit_jobs(
description = validate_description(request)

job = Job(
# TODO: UUIDv7
id=str(uuid.uuid4()),
id=uuid7(as_type="str"),
owner=owner,
name=name,
description=description,
Expand Down
3 changes: 3 additions & 0 deletions backend/stubs/uuid_extensions/__init__.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
__version__ = "0.1.0"

from .uuid7 import *
30 changes: 30 additions & 0 deletions backend/stubs/uuid_extensions/uuid7.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
__all__ = (
"uuid7",
"uuid7str",
"time_ns",
"check_timing_precision",
"uuid_to_datetime",
)

import datetime
import time
import uuid
from typing import Callable, Optional, Union

time_ns = time.time_ns

def uuid7(
ns: Optional[int] = None,
as_type: Optional[str] = None,
time_func: Callable[[], int] = time_ns,
_last=[0, 0, 0, 0],
_last_as_of=[0, 0, 0, 0],
) -> Union[uuid.UUID, str, int, bytes]: ...
def uuid7str(ns: Optional[int] = None) -> str: ...
def check_timing_precision(
timing_func: Optional[Callable[[], int]] = None,
) -> str: ...
def uuid_to_datetime(
s: Union[str, uuid.UUID, int],
suppress_error=True,
) -> Optional[datetime.datetime]: ...
27 changes: 27 additions & 0 deletions backend/tests/oqtopus_cloud/user/routers/test_jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,33 @@ def test_get_job_404(
assert response.json() == {"detail": "job not found with the given id"}


def test_job_sortedness(test_db):
def mk_job(n: int) -> SubmitJobRequest:
return SubmitJobRequest(
name=f"test-job-{n}",
device_id="Kawasaki",
status=JobStatus.submitted,
job_info=JobInfoSampling(job_type="sampling", code="code"),
simulator_info="{}",
transpiler_info="{}",
mitigation_info="{}",
shots=1000,
)

def is_sorted(xs: list[str]) -> bool:
return xs == sorted(xs)

test_db.flush()
job_ids: list[str] = []
for n in range(1, 10):
submit_resp = client.post("/jobs", content=mk_job(n).model_dump_json())
print(f"submit_resp={submit_resp.json()}")
job_id = SubmitJobResponse.model_validate(submit_resp.json()).job_id
job_ids.append(job_id)

assert is_sorted(job_ids)


def test_get_jobs_handler(
test_db,
):
Expand Down
94 changes: 60 additions & 34 deletions poetry.lock

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ fastapi = "^0.110.0"
aws-xray-sdk = "^2.13.0"
setuptools = "^75.1.0"
types-setuptools = "^75.1.0.20240917"
uuid7 = "^0.1.0"
uuid-v7 = "^1.0.0"


[tool.poetry.group.dev.dependencies]
Expand Down
Loading