Entry lock as table

Author: kompotkot

alembic/versions/5d4ec1330a98_entry_lock.py

@@ -0,0 +1,47 @@
+"""Entry lock
+
+Revision ID: f909b4acb52f
+Revises: 245914e1ddf9
+Create Date: 2022-09-05 10:25:46.047276
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = 'f909b4acb52f'
+down_revision = '245914e1ddf9'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('journal_entry_locks',
+    sa.Column('id', postgresql.UUID(as_uuid=True), nullable=False),
+    sa.Column('journal_entry_id', postgresql.UUID(as_uuid=True), nullable=True),
+    sa.Column('locked_by', sa.String(), nullable=False),
+    sa.Column('locked_at', sa.DateTime(timezone=True), server_default=sa.text("TIMEZONE('utc', statement_timestamp())"), nullable=False),
+    sa.ForeignKeyConstraint(['journal_entry_id'], ['journal_entries.id'], name=op.f('fk_journal_entry_locks_journal_entry_id_journal_entries'), ondelete='CASCADE'),
+    sa.PrimaryKeyConstraint('id', name=op.f('pk_journal_entry_locks')),
+    sa.UniqueConstraint('id', name=op.f('uq_journal_entry_locks_id')),
+    sa.UniqueConstraint('journal_entry_id', name=op.f('uq_journal_entry_locks_journal_entry_id'))
+    )
+    op.create_index(op.f('ix_journal_entry_locks_locked_at'), 'journal_entry_locks', ['locked_at'], unique=False)
+    op.create_index(op.f('ix_journal_entry_locks_locked_by'), 'journal_entry_locks', ['locked_by'], unique=False)
+    op.alter_column('journal_ttls', 'journal_id',
+               existing_type=postgresql.UUID(),
+               nullable=True)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('journal_ttls', 'journal_id',
+               existing_type=postgresql.UUID(),
+               nullable=False)
+    op.drop_index(op.f('ix_journal_entry_locks_locked_by'), table_name='journal_entry_locks')
+    op.drop_index(op.f('ix_journal_entry_locks_locked_at'), table_name='journal_entry_locks')
+    op.drop_table('journal_entry_locks')
+    # ### end Alembic commands ###

alembic/versions/f909b4acb52f_entry_lock.py

@@ -1,6 +1,7 @@
 """
 Journal-related actions in Spire
 """
+from asyncio import streams
 from datetime import date, timedelta, datetime
 import calendar
 import json
@@ -37,6 +38,7 @@
 from .models import (
     Journal,
     JournalEntry,
+    JournalEntryLock,
     JournalEntryTag,
     JournalPermissions,
     HolderType,
@@ -484,44 +486,45 @@ async def journal_statistics(
 
 async def create_journal_entry(
     db_session: Session,
+    journal: Journal,
     entry_request: CreateJournalEntryRequest,
-    user_group_id_list: list = None,
-    locked_by: Optional[str] = None,
-) -> JournalEntry:
+    locked_by: str,
+) -> Tuple[JournalEntry, JournalEntryLock]:
     """
     Creates an entry in a given journal. Raises InvalidJournalSpec error if the journal is
     misspecified in the creation request, and raises a JournalNotFound error if no such journal
     is found in the database.
     """
-    journal = await find_journal(
-        db_session=db_session,
-        journal_spec=entry_request.journal_spec,
-        user_group_id_list=user_group_id_list,
-    )
+    commit_list = []
 
+    entry_id = uuid4()
     entry = JournalEntry(
+        id=entry_id,
         journal_id=journal.id,
         title=entry_request.title,
         content=entry_request.content,
         context_id=entry_request.context_id,
         context_url=entry_request.context_url,
         context_type=entry_request.context_type,
         created_at=entry_request.created_at,
-        locked_by=locked_by,
     )
-    db_session.add(entry)
-    db_session.commit()
+    commit_list.append(entry)
+
+    entry_lock = JournalEntryLock(journal_entry_id=entry_id, locked_by=locked_by)
+    commit_list.append(entry_lock)
 
     if entry_request.tags is not None:
         tags = [
             JournalEntryTag(journal_entry_id=entry.id, tag=tag)
             for tag in entry_request.tags
             if tag
         ]
-        db_session.add_all(tags)
-        db_session.commit()
+        commit_list.extend(tags)
 
-    return entry
+    db_session.add_all(commit_list)
+    db_session.commit()
+
+    return entry, entry_lock
 
 
 async def create_journal_entries_pack(
@@ -651,47 +654,70 @@ async def get_journal_entry(
 
 async def get_journal_entry_with_tags(
     db_session: Session, journal_entry_id: UUID
-) -> Tuple[JournalEntry, List[JournalEntryTag]]:
+) -> Tuple[JournalEntry, List[JournalEntryTag], JournalEntryLock]:
     """
     Returns a journal entry by its id with tags.
     """
     objects = (
-        db_session.query(JournalEntry, JournalEntryTag)
+        db_session.query(JournalEntry, JournalEntryTag, JournalEntryLock)
         .join(
             JournalEntryTag,
             JournalEntryTag.journal_entry_id == JournalEntry.id,
             isouter=True,
         )
+        .join(
+            JournalEntryLock,
+            JournalEntryLock.journal_entry_id == JournalEntry.id,
+            isouter=True,
+        )
         .filter(JournalEntry.id == journal_entry_id)
         .all()
     )
     if len(objects) == 0:
         raise EntryNotFound("Entry not found")
 
     entry = objects[0][0]
+    entry_lock = objects[0][2]
     tags: List[JournalEntryTag] = []
     for object in objects:
         if object[1] is not None:
             tags.append(object[1])
-    return entry, tags
+
+    return entry, tags, entry_lock
 
 
-async def delete_journal_entry_lock(
+async def update_journal_entry(
     db_session: Session,
-    journal_entry_id: UUID,
-) -> None:
+    new_title: str,
+    new_content: str,
+    locked_by: str,
+    journal_entry: JournalEntry,
+    entry_lock: Optional[JournalEntryLock] = None,
+) -> Tuple[JournalEntry, JournalEntryLock]:
     """
-    Releases journal entry lock.
+    Updates existing journal entry content.
+    If lock does not exist, it creates new, otherwise update timestamp.
     """
-    updated_rows = (
-        db_session.query(JournalEntry)
-        .filter(JournalEntry.id == journal_entry_id)
-        .update({JournalEntry.locked_by: None})
-    )
+    commit_list = []
+    update_timestamp = datetime.utcnow()
+
+    journal_entry.title = new_title
+    journal_entry.content = new_content
+    journal_entry.updated_at = update_timestamp
+
+    commit_list.append(journal_entry)
+
+    if entry_lock is None:
+        entry_lock = JournalEntryLock(
+            journal_entry_id=journal_entry.id, locked_by=locked_by
+        )
+    entry_lock.locked_at = update_timestamp
+    commit_list.append(entry_lock)
+
+    db_session.add_all(commit_list)
     db_session.commit()
 
-    if updated_rows == 0:
-        raise EntryNotFound(f"There is no entry with id: {journal_entry_id} to unlock")
+    return journal_entry, entry_lock
 
 
 async def delete_journal_entry(

spire/journal/actions.py

@@ -67,7 +67,7 @@
 )
 from ..data import VersionResponse
 from ..middleware import BroodAuthMiddleware
-from .models import Journal, JournalEntryTag
+from .models import Journal, JournalEntryLock, JournalEntryTag
 from . import search
 from ..utils.settings import (
     DEFAULT_JOURNALS_ES_INDEX,
@@ -865,10 +865,10 @@ async def create_journal_entry(
     es_index = journal.search_index
 
     try:
-        journal_entry = await actions.create_journal_entry(
-            db_session,
-            creation_request,
-            user_group_id_list=request.state.user_group_id_list,
+        journal_entry, entry_lock = await actions.create_journal_entry(
+            db_session=db_session,
+            journal=journal,
+            entry_request=creation_request,
             locked_by=request.state.user_id,
         )
     except actions.JournalNotFound:
@@ -917,7 +917,7 @@ async def create_journal_entry(
         updated_at=journal_entry.updated_at,
         context_url=journal_entry.context_url,
         context_type=journal_entry.context_type,
-        locked_by=journal_entry.locked_by,
+        locked_by=entry_lock.locked_by,
     )
 
 
@@ -1081,7 +1081,11 @@ async def get_entry(
     )
 
     try:
-        journal_entry, tag_objects = await actions.get_journal_entry_with_tags(
+        (
+            journal_entry,
+            tag_objects,
+            entry_lock,
+        ) = await actions.get_journal_entry_with_tags(
             db_session=db_session, journal_entry_id=entry_id
         )
     except actions.EntryNotFound:
@@ -1106,7 +1110,7 @@ async def get_entry(
         updated_at=journal_entry.updated_at,
         context_url=journal_entry.context_url,
         context_type=journal_entry.context_type,
-        locked_by=journal_entry.locked_by,
+        locked_by=None if entry_lock is None else entry_lock.locked_by,
     )
 
 
@@ -1198,7 +1202,11 @@ async def update_entry_content(
     es_index = journal.search_index
 
     try:
-        journal_entry, tag_objects = await actions.get_journal_entry_with_tags(
+        (
+            journal_entry,
+            tag_objects,
+            entry_lock,
+        ) = await actions.get_journal_entry_with_tags(
             db_session=db_session, journal_entry_id=entry_id
         )
         if journal_entry is None:
@@ -1211,22 +1219,26 @@ async def update_entry_content(
         logger.error(f"Error listing journal entries: {str(e)}")
         raise HTTPException(status_code=500)
 
-    if (
-        journal_entry.locked_by is not None
-        and journal_entry.locked_by != request.state.user_id
-    ):
+    if entry_lock is not None and entry_lock.locked_by != request.state.user_id:
         return JournalEntryContent(
             title=journal_entry.title,
             content=journal_entry.content,
             tags=[tag.tag for tag in tag_objects],
-            locked_by=journal_entry.locked_by,
+            locked_by=entry_lock.locked_by,
         )
 
-    journal_entry.title = api_request.title
-    journal_entry.content = api_request.content
-    journal_entry.locked_by = request.state.user_id
-    db_session.add(journal_entry)
-    db_session.commit()
+    try:
+        journal_entry, entry_lock = await actions.update_journal_entry(
+            db_session=db_session,
+            new_title=api_request.title,
+            new_content=api_request.content,
+            locked_by=request.state.user_id,
+            journal_entry=journal_entry,
+            entry_lock=entry_lock,
+        )
+    except Exception as e:
+        logger.error(f"Error updating journal entry: {str(e)}")
+        raise HTTPException(status_code=500)
 
     updated_tag_objects: List[JournalEntryTag] = []
     try:
@@ -1286,7 +1298,7 @@ async def update_entry_content(
         title=journal_entry.title,
         content=journal_entry.content,
         tags=tags,
-        locked_by=request.state.user_id,
+        locked_by=entry_lock.locked_by,
     )
 
 
@@ -1313,27 +1325,31 @@ async def delete_entry_lock(
         {JournalEntryScopes.UPDATE},
     )
     try:
-        journal_entry, tag_objects = await actions.get_journal_entry_with_tags(
+        (
+            journal_entry,
+            tag_objects,
+            entry_lock,
+        ) = await actions.get_journal_entry_with_tags(
             db_session=db_session, journal_entry_id=entry_id
         )
         if journal_entry is None:
             raise actions.EntryNotFound(
                 f"Entry not found with ID={entry_id} in journal with ID={journal_id}"
             )
-        await actions.delete_journal_entry_lock(
-            db_session=db_session,
-            journal_entry_id=entry_id,
-        )
+        if entry_lock is not None:
+            db_session.delete(entry_lock)
+            db_session.commit()
     except actions.EntryNotFound:
         raise HTTPException(status_code=404, detail="Entry not found")
-    except Exception:
+    except Exception as e:
+        logger.error(f"Error listing journal entries: {str(e)}")
         raise HTTPException(status_code=500)
 
     return JournalEntryContent(
         title=journal_entry.title,
         content=journal_entry.content,
         tags=[tag.tag for tag in tag_objects],
-        locked_by=journal_entry.locked_by,
+        locked_by=None,
     )