migrated from dataset to sqlalchemy

app/main.py

@@ -17,16 +17,18 @@ from jose import jws, jwk, jwt
 from jose.constants import ALGORITHMS
 from starlette.middleware.cors import CORSMiddleware
 from starlette.responses import StreamingResponse, JSONResponse, HTMLResponse
-import dataset
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
 from Crypto.PublicKey import RSA
 from Crypto.PublicKey.RSA import RsaKey
 
+from orm import Origin, Lease, Auth
+
 logger = logging.getLogger()
 load_dotenv('../version.env')
 
 VERSION, COMMIT, DEBUG = getenv('VERSION', 'unknown'), getenv('COMMIT', 'unknown'), bool(getenv('DEBUG', False))
 
-
 def load_file(filename) -> bytes:
     with open(filename, 'rb') as file:
         content = file.read()
@@ -45,7 +47,7 @@ __details = dict(
     version=VERSION,
 )
 
-app, db = FastAPI(**__details), dataset.connect(str(getenv('DATABASE', 'sqlite:///db.sqlite')))
+app, db = FastAPI(**__details), create_engine(url=str(getenv('DATABASE', 'sqlite:///db.sqlite')))
 
 TOKEN_EXPIRE_DELTA = relativedelta(hours=1)  # days=1
 LEASE_EXPIRE_DELTA = relativedelta(days=int(getenv('LEASE_EXPIRE_DAYS', 90)))
@@ -93,13 +95,17 @@ async def status(request: Request):
 
 @app.get('/-/origins')
 async def _origins(request: Request):
-    response = list(map(lambda x: jsonable_encoder(x), db['origin'].all()))
+    session = sessionmaker(autocommit=False, autoflush=False, bind=db)()
+    response = list(map(lambda x: jsonable_encoder(x), session.query(Origin).all()))
+    session.close()
     return JSONResponse(response)
 
 
 @app.get('/-/leases')
 async def _leases(request: Request):
-    response = list(map(lambda x: jsonable_encoder(x), db['lease'].all()))
+    session = sessionmaker(autocommit=False, autoflush=False, bind=db)()
+    response = list(map(lambda x: jsonable_encoder(x), session.query(Lease).all()))
+    session.close()
     return JSONResponse(response)
 
 
@@ -160,14 +166,14 @@ async def auth_v1_origin(request: Request):
     origin_ref = j['candidate_origin_ref']
     logging.info(f'> [  origin  ]: {origin_ref}: {j}')
 
-    data = dict(
+    data = Origin(
         origin_ref=origin_ref,
         hostname=j['environment']['hostname'],
         guest_driver_version=j['environment']['guest_driver_version'],
         os_platform=j['environment']['os_platform'], os_version=j['environment']['os_version'],
     )
 
-    db['origin'].upsert(data, ['origin_ref'])
+    Origin.create_or_update(db, data)
 
     cur_time = datetime.utcnow()
     response = {
@@ -208,8 +214,9 @@ async def auth_v1_code(request: Request):
 
     auth_code = jws.sign(payload, key=jwt_encode_key, headers={'kid': payload.get('kid')}, algorithm=ALGORITHMS.RS256)
 
-    db['auth'].delete(origin_ref=origin_ref, expires={'<=': cur_time - delta})
+    Auth.cleanup(db, origin_ref, cur_time - delta)
-    db['auth'].insert(dict(origin_ref=origin_ref, code_challenge=j['code_challenge'], expires=expires))
+    data = Auth(origin_ref=origin_ref, code_challenge=j['code_challenge'], expires=expires)
+    Auth.create(db, data)
 
     response = {
         "auth_code": auth_code,
@@ -230,7 +237,10 @@ async def auth_v1_token(request: Request):
 
     code_challenge = payload['origin_ref']
 
-    origin_ref = db['auth'].find_one(code_challenge=code_challenge)['origin_ref']
+    entity = Auth.find_by_code_challenge(db, code_challenge)
+    if entity is None:
+        raise HTTPException(status_code=400, detail='code challenge not found')
+    origin_ref = entity.origin_ref
     logging.info(f'> [   auth   ]: {origin_ref} ({code_challenge}): {j}')
 
     # validate the code challenge
@@ -270,8 +280,10 @@ async def leasing_v1_lessor(request: Request):
     code_challenge = token['origin_ref']
     scope_ref_list = j['scope_ref_list']
 
-    origin_ref = db['auth'].find_one(code_challenge=code_challenge)['origin_ref']
+    entity = Auth.find_by_code_challenge(db, code_challenge)
-
+    if entity is None:
+        raise HTTPException(status_code=400, detail='code challenge not found')
+    origin_ref = entity.origin_ref
     logging.info(f'> [  create  ]: {origin_ref} ({code_challenge}): create leases for scope_ref_list {scope_ref_list}')
 
     cur_time = datetime.utcnow()
@@ -292,8 +304,8 @@ async def leasing_v1_lessor(request: Request):
             }
         })
 
-        data = dict(origin_ref=origin_ref, lease_ref=scope_ref, lease_created=cur_time, lease_expires=expires)
+        data = Lease(origin_ref=origin_ref, lease_ref=scope_ref, lease_created=cur_time, lease_expires=expires)
-        db['lease'].insert_ignore(data, ['origin_ref', 'lease_ref'])  # todo: handle update
+        Lease.create_or_update(db, data)
 
     response = {
         "lease_result_list": lease_result_list,
@@ -313,8 +325,11 @@ async def leasing_v1_lessor_lease(request: Request):
 
     code_challenge = token['origin_ref']
 
-    origin_ref = db['auth'].find_one(code_challenge=code_challenge)['origin_ref']
+    entity = Auth.find_by_code_challenge(db, code_challenge)
-    active_lease_list = list(map(lambda x: x['lease_ref'], db['lease'].find(origin_ref=origin_ref)))
+    if entity is None:
+        raise HTTPException(status_code=400, detail='code challenge not found')
+    origin_ref = entity.origin_ref
+    active_lease_list = list(map(lambda x: x.lease_ref, Lease.find_by_origin_ref(db, origin_ref)))
     logging.info(f'> [  leases  ]: {origin_ref} ({code_challenge}): found {len(active_lease_list)} active leases')
 
     cur_time = datetime.utcnow()
@@ -334,10 +349,14 @@ async def leasing_v1_lease_renew(request: Request, lease_ref: str):
 
     code_challenge = token['origin_ref']
 
-    origin_ref = db['auth'].find_one(code_challenge=code_challenge)['origin_ref']
+    entity = Auth.find_by_code_challenge(db, code_challenge)
+    if entity is None:
+        raise HTTPException(status_code=400, detail='code challenge not found')
+    origin_ref = entity.origin_ref
     logging.info(f'> [  renew   ]: {origin_ref} ({code_challenge}): renew {lease_ref}')
 
-    if db['lease'].count(origin_ref=origin_ref, lease_ref=lease_ref) == 0:
+    entity = Lease.find_by_origin_ref_and_lease_ref(db, origin_ref, lease_ref)
+    if entity is None:
         raise HTTPException(status_code=404, detail='requested lease not available')
 
     cur_time = datetime.utcnow()
@@ -351,8 +370,7 @@ async def leasing_v1_lease_renew(request: Request, lease_ref: str):
         "sync_timestamp": cur_time.isoformat(),
     }
 
-    data = dict(origin_ref=origin_ref, lease_ref=lease_ref, lease_expires=expires, lease_last_update=cur_time)
+    Lease.renew(db, entity, expires, cur_time)
-    db['lease'].update(data, ['origin_ref', 'lease_ref'])
 
     return JSONResponse(response)
 
@@ -363,9 +381,13 @@ async def leasing_v1_lessor_lease_remove(request: Request):
 
     code_challenge = token['origin_ref']
 
-    origin_ref = db['auth'].find_one(code_challenge=code_challenge)['origin_ref']
+    entity = Auth.find_by_code_challenge(db, code_challenge)
-    released_lease_list = list(map(lambda x: x['lease_ref'], db['lease'].find(origin_ref=origin_ref)))
+    if entity is None:
-    deletions = db['lease'].delete(origin_ref=origin_ref)
+        raise HTTPException(status_code=400, detail='code challenge not found')
+    origin_ref = entity.origin_ref
+
+    released_lease_list = list(map(lambda x: x.lease_ref, Lease.find_by_origin_ref(db, origin_ref)))
+    deletions = Lease.ceanup(db, origin_ref)
     logging.info(f'> [  remove  ]: {origin_ref} ({code_challenge}): removed {deletions} leases')
 
     cur_time = datetime.utcnow()

app/orm.py

@@ -0,0 +1,198 @@
+import datetime
+
+from sqlalchemy import Column, VARCHAR, CHAR, ForeignKey, DATETIME, UniqueConstraint, update, and_, delete
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.future import Engine
+from sqlalchemy.orm import sessionmaker
+
+Base = declarative_base()
+
+
+class Origin(Base):
+    __tablename__ = "origin"
+
+    """
+    CREATE TABLE origin (
+        id INTEGER NOT NULL, 
+        origin_ref TEXT, 
+        hostname TEXT, 
+        guest_driver_version TEXT, 
+        os_platform TEXT, 
+        os_version TEXT, 
+        PRIMARY KEY (id)
+    );
+    CREATE INDEX ix_origin_0548dd22f20de1bb ON origin (origin_ref);
+    """
+
+    """
+    1|B210CF72-FEC7-4440-9499-1156D1ACD13A|ubuntu-grid-server|525.60.13|Ubuntu 20.04|20.04.5 LTS (Focal Fossa)
+    2|230b0000-a356-4000-8a2b-0000564c0000|PC-WORKSTATION|527.41|Windows 10 Pro|10.0.19045
+    3|908B202D-CC43-420F-A2EF-FC092AAE8D38|docker-cuda-1|525.60.13|Debian GNU/Linux 10 (buster) 10|10 (buster)
+    4|41720000-FA43-4000-9472-0000E8660000|PC-Windows|527.41|Windows 10 Pro|10.0.19045
+    5|723EA079-7B0C-4E25-A8D4-DD3E89F9D177|docker-cuda-2|525.60.13|Debian GNU/Linux 10 (buster) 10|10 (buster)
+    """
+
+    origin_ref = Column(CHAR(length=36), primary_key=True, unique=True, index=True)  # uuid4
+
+    hostname = Column(VARCHAR(length=256), nullable=True)
+    guest_driver_version = Column(VARCHAR(length=10), nullable=True)
+    os_platform = Column(VARCHAR(length=256), nullable=True)
+    os_version = Column(VARCHAR(length=256), nullable=True)
+
+    def __repr__(self):
+        return f'Origin(origin_ref={self.origin_ref}, hostname={self.hostname})'
+
+    @staticmethod
+    def create_statement(engine: Engine):
+        from sqlalchemy.schema import CreateTable
+        return CreateTable(Origin.__table__).compile(engine)
+
+    @staticmethod
+    def create_or_update(engine: Engine, origin: "Origin"):
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        entity = session.query(Origin).filter(Origin.origin_ref == origin.origin_ref).first()
+        print(entity)
+        if entity is None:
+            session.add(origin)
+        else:
+            session.execute(update(Origin).where(Origin.origin_ref == origin.origin_ref).values(**origin.values()))
+        session.flush()
+        session.close()
+
+
+class Auth(Base):
+    __tablename__ = "auth"
+
+    """
+    CREATE TABLE auth (
+        id INTEGER NOT NULL, 
+        origin_ref TEXT, 
+        code_challenge TEXT, 
+        expires DATETIME, 
+        PRIMARY KEY (id)
+    );
+    """
+
+    """
+    20|B210CF72-FEC7-4440-9499-1156D1ACD13A|p8oeBJPumrosywezCQ6VQvI/J2LZbMRK0s+OfsqzAiI|2022-12-21 05:00:57.467359
+    61|723EA079-7B0C-4E25-A8D4-DD3E89F9D177|9Nnv5FMtV9nF8qYRtCKG5lfF23HGvvNCQvpCh3FUITo|2022-12-22 05:08:40.713022
+    65|230b0000-a356-4000-8a2b-0000564c0000|9PivDr3PYRfcdUgODBR5+gi2ZdAbmPb07yTO05uui4A|2022-12-22 06:22:27.409642
+    66|41720000-FA43-4000-9472-0000E8660000|VnyasehSayRX/2OD3YyP8Xn9nsIBVefZpscnIIj2Rpk|2022-12-22 08:58:04.279664
+    67|41720000-FA43-4000-9472-0000E8660000|uisrxDFKB8KuD+JvtgT1ol5pNm/GKKlhO69u2ntg7z0|2022-12-22 08:59:37.509520
+    68|908B202D-CC43-420F-A2EF-FC092AAE8D38|VtWk7It+k33FxiGjm9rlSgAg1ZigfreFJd/0tt30FgQ|2022-12-22 09:43:56.680163
+    """
+
+    _table_args__ = (
+        # this can be db.PrimaryKeyConstraint if you want it to be a primary key
+        UniqueConstraint('origin_ref', 'code_challenge'),
+    )
+
+    origin_ref = Column(CHAR(length=36), ForeignKey(Origin.origin_ref), primary_key=True, nullable=False, index=True)
+    code_challenge = Column(VARCHAR(length=43), primary_key=True, nullable=False)
+    expires = Column(DATETIME(), nullable=False)
+
+    def __repr__(self):
+        return f'Auth(origin_ref={self.origin_ref}, code_challenge={self.code_challenge}, expires={self.expires})'
+
+    @staticmethod
+    def create_statement(engine: Engine):
+        from sqlalchemy.schema import CreateTable
+        return CreateTable(Auth.__table__).compile(engine)
+
+    @staticmethod
+    def create(engine: Engine, auth: "Auth"):
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        session.add(auth)
+        session.flush()
+        session.close()
+
+    @staticmethod
+    def cleanup(engine: Engine, origin_ref: str, older_than: datetime.datetime):
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        session.execute(delete(Auth).where(and_(Auth.origin_ref == origin_ref, Auth.expires <= older_than)))
+        session.close()
+
+    @staticmethod
+    def find_by_code_challenge(engine: Engine, code_challenge: str) -> "Auth":
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        entity = session.query(Auth).filter(Auth.code_challenge == code_challenge).first()
+        session.close()
+        return entity
+
+
+class Lease(Base):
+    __tablename__ = "lease"
+
+    """
+    CREATE TABLE lease (
+        id INTEGER NOT NULL, 
+        origin_ref TEXT, 
+        lease_ref TEXT, 
+        lease_created DATETIME, 
+        lease_expires DATETIME, lease_last_update DATETIME, 
+        PRIMARY KEY (id)
+    );
+    CREATE INDEX ix_lease_11c7d13bfb17f70d ON lease (origin_ref, lease_ref);
+    """
+
+    """
+    1|B210CF72-FEC7-4440-9499-1156D1ACD13A|9c4536f9-a216-44c7-a1d3-388a15ee80be|2022-12-20 17:29:07.906668|2022-12-22 04:45:58.138211|2022-12-21 04:45:58.138211
+    2|230b0000-a356-4000-8a2b-0000564c0000|1d95e160-058d-4052-b49f-b85306b4c345|2022-12-20 17:30:25.388389|2022-12-23 06:07:29.913027|2022-12-22 06:07:29.913027
+    3|908B202D-CC43-420F-A2EF-FC092AAE8D38|9e1bca05-e247-4847-9de6-8b9a210b353e|2022-12-20 17:31:40.158003|2022-12-23 09:28:57.379008|2022-12-22 09:28:57.379008
+    4|41720000-FA43-4000-9472-0000E8660000|f2ece7fa-d0c6-4af4-901c-6d3b2c3ecf88|2022-12-20 21:03:33.403711|2022-12-23 08:44:39.998754|2022-12-22 08:44:39.998754
+    5|723EA079-7B0C-4E25-A8D4-DD3E89F9D177|5455f59b-dd70-45c1-82fa-3fd5fae6c037|2022-12-21 06:05:35.085572|2022-12-23 04:53:41.385178|2022-12-22 04:53:41.385178
+    """
+
+    origin_ref = Column(CHAR(length=36), ForeignKey(Origin.origin_ref), primary_key=True, nullable=False, index=True)
+    lease_ref = Column(CHAR(length=36), primary_key=True, nullable=False, index=True)
+    lease_created = Column(DATETIME(), nullable=False)
+    lease_expires = Column(DATETIME(), nullable=False)
+    lease_updated = Column(DATETIME(), nullable=False)
+
+    def __repr__(self):
+        return f'Lease(origin_ref={self.origin_ref}, lease_ref={self.lease_ref}, expires={self.lease_expires})'
+
+    @staticmethod
+    def create_statement(engine: Engine):
+        from sqlalchemy.schema import CreateTable
+        return CreateTable(Lease.__table__).compile(engine)
+
+    @staticmethod
+    def create_or_update(engine: Engine, lease: "Lease"):
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        entity = session.query(Lease).filter(and_(Lease.origin_ref == lease.origin_ref, Lease.lease_ref == lease.lease_ref)).first()
+        if entity is None:
+            session.add(lease)
+        else:
+            session.execute(update(Lease).where(and_(Lease.origin_ref == lease.origin_ref, Lease.lease_ref == lease.lease_ref)).values(**lease.values()))
+        session.flush()
+        session.close()
+
+    @staticmethod
+    def find_by_origin_ref(engine: Engine, origin_ref: str) -> ["Lease"]:
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        entities = session.query(Lease).filter(Lease.origin_ref == origin_ref).all()
+        session.close()
+        return entities
+
+    @staticmethod
+    def find_by_origin_ref_and_lease_ref(engine: Engine, origin_ref: str, lease_ref: str) -> "Lease":
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        entity = session.query(Lease).filter(and_(Lease.origin_ref == origin_ref, Lease.lease_ref == lease_ref)).first()
+        session.close()
+        return entity
+
+    @staticmethod
+    def renew(engine: Engine, lease: "Lease", lease_expires: datetime.datetime, lease_updated: datetime.datetime):
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        lease.lease_expires = lease_expires
+        lease.lease_updated = lease_updated
+        session.execute(update(Lease).where(and_(Lease.origin_ref == lease.origin_ref, Lease.lease_ref == lease.lease_ref)).values(**lease.values()))
+        session.close()
+
+    @staticmethod
+    def cleanup(engine: Engine, origin_ref: str) -> int:
+        session = sessionmaker(autocommit=True, autoflush=True, bind=engine)()
+        deletions = session.query(Lease).delete(Lease.origin_ref == origin_ref)
+        session.close()
+        return deletions

requirements.txt

@@ -3,6 +3,6 @@ uvicorn[standard]==0.20.0
 python-jose==3.3.0
 pycryptodome==3.16.0
 python-dateutil==2.8.2
-dataset==1.5.2
+sqlalchemy==1.4.45
 markdown==3.4.1
 python-dotenv==0.21.0