feat: update document index status model and related components

[iziang]

• Refactored document index status to use a single status model with new states: CREATING, ACTIVE, DELETING, and DELETION_IN_PROGRESS.
• Updated related database models, API components, and service logic to accommodate the new status model.
• Adjusted index management and reconciliation processes to align with the new status definitions.
• Modified tests to reflect changes in index status handling and ensure compatibility with the updated API responses.

[cursor]

🚨 BugBot couldn't run

Something went wrong. Try again by commenting "bugbot run", or contact support (requestId: serverGenReqId_8ad2d329-132f-4331-81eb-9e80d2d182ac).

[cursor]

Bug: Incorrect Return Type Causes Serialization Errors

The delete_document service method in aperag/service/document_service.py has an incorrect return type annotation (dict) and returns a raw database model (db_models.Document) instead of the expected view_models.Document. This creates a type mismatch with the delete_document_view API endpoint in aperag/views/main.py, which is annotated to return view_models.Document, leading to runtime serialization errors.

aperag/service/document_service.py#L288-L299

ApeRAG/aperag/service/document_service.py

Lines 288 to 299 in 8c580b6

	async def delete_document(self, user: str, collection_id: str, document_id: str) -> dict:
	"""Delete a single document and trigger index reconciliation."""
	async def _delete_document_atomically(session: AsyncSession):
	return await self._delete_document(session, user, collection_id, document_id)
	result = await self.db_ops.execute_with_transaction(_delete_document_atomically)
	# Trigger reconciliation to process the deletion
	_trigger_index_reconciliation()
	return result

aperag/views/main.py#L126-L135

ApeRAG/aperag/views/main.py

Lines 126 to 135 in 8c580b6

	@router.delete("/collections/{collection_id}/documents/{document_id}")
	@audit(resource_type="document", api_name="DeleteDocument")
	async def delete_document_view(
	request: Request,
	collection_id: str,
	document_id: str,
	user: User = Depends(current_user),
	) -> view_models.Document:
	return await document_service.delete_document(str(user.id), collection_id, document_id)

Fix in Cursor

---

Bug: Incorrect Return Type Causes Serialization Errors

The delete_document method's signature declares a dict return type, but it incorrectly returns a db_models.Document object. This returned object is problematic as it has just been deleted from the session, making it detached and potentially unusable. This type inconsistency will cause serialization errors in the API response, which expects a view_models.Document or a dict. The previous implementation correctly converted the database model to a view model before returning.

aperag/service/document_service.py#L282-L299

ApeRAG/aperag/service/document_service.py

Lines 282 to 299 in 8c580b6

	# Delete the document record from the database
	await session.delete(document)
	await session.flush()
	logger.info(f"Successfully marked document {document.id} and its indexes for deletion.")
	return document
	async def delete_document(self, user: str, collection_id: str, document_id: str) -> dict:
	"""Delete a single document and trigger index reconciliation."""
	async def _delete_document_atomically(session: AsyncSession):
	return await self._delete_document(session, user, collection_id, document_id)
	result = await self.db_ops.execute_with_transaction(_delete_document_atomically)
	# Trigger reconciliation to process the deletion
	_trigger_index_reconciliation()
	return result

Fix in Cursor

---

Was this report helpful? Give feedback by reacting with 👍 or 👎