feat(comment-file): file upload and delete and get content

Author: ptamarit

invenio_requests/alembic/1763728177_create_request_files_table.py

@@ -73,15 +73,9 @@ def upgrade():
         ["object_version_id"],
         unique=False,
     )
-    # TODO: Is ix_request_files_record_id needed? (We do not have it in Zenodo prod for communities)
     op.create_index(
         op.f("ix_request_files_record_id"), "request_files", ["record_id"], unique=False
     )
-    # TODO: Create an index like this similarly to what is done for communities with uidx_communities_files_id_key?
-    # op.create_index(
-    #     "uidx_request_files_id_key", "request_files", ["id", "key"], unique=True
-    # )
-    # TODO: Is uidx_request_files_record_id_key needed? (We do not have it in Zenodo prod for communities, but instead have uidx_request_files_id_key)
     op.create_index(
         "uidx_request_files_record_id_key",
         "request_files",
@@ -118,7 +112,6 @@ def downgrade():
     )
     op.drop_column("request_metadata", "bucket_id")
     op.drop_index("uidx_request_files_record_id_key", table_name="request_files")
-    # op.drop_index(op.f("uidx_request_files_id_key"), table_name="request_files")
     op.drop_index(op.f("ix_request_files_record_id"), table_name="request_files")
     op.drop_index(
         op.f("ix_request_files_object_version_id"), table_name="request_files"

invenio_requests/config.py

@@ -143,3 +143,6 @@
 This limits the size of indexed documents when comments have many replies.
 Additional replies can be loaded via pagination.
 """
+
+REQUESTS_FILES_DEFAULT_QUOTA_SIZE = 100 * 10**6  # 100MB
+REQUESTS_FILES_DEFAULT_MAX_FILE_SIZE = 10 * 10**6  # 10MB

invenio_requests/customizations/request_types.py

@@ -114,6 +114,9 @@ class RequestType:
     topic_can_be_none = True
     """Determines if the ``topic`` reference accepts ``None``."""
 
+    files_can_be_none = False
+    """Determines if the ``files`` reference accepts ``None``."""
+
     allowed_creator_ref_types = ["user"]
     """A list of allowed TYPE keys for ``created_by`` reference dicts."""
 
@@ -143,6 +146,9 @@ def locking_enabled(cls):
     resolve_topic_needs = False
     """Whether to resolve needs for the topic entity."""
 
+    allowed_files_ref_types = ["enabled"]
+    """A list of allowed TYPE keys for ``files`` reference dicts."""
+
     payload_schema = None
     payload_schema_cls = None
     """Schema for supported payload fields.
@@ -205,6 +211,13 @@ def _create_marshmallow_schema(cls):
                 RefBaseSchema.create_from_dict(cls.allowed_topic_ref_types),
                 allow_none=cls.topic_can_be_none,
             ),
+            "files": ma.fields.Nested(
+                RefBaseSchema.create_from_dict(
+                    cls.allowed_files_ref_types,
+                    special_fields={"enabled": ma.fields.Boolean()},
+                ),
+                allow_none=cls.files_can_be_none,
+            ),
         }
 
         if cls.reviewers_can_be_none():

invenio_requests/ext.py

@@ -19,12 +19,16 @@
 from .resources import (
     RequestCommentsResource,
     RequestCommentsResourceConfig,
+    RequestFilesResource,
+    RequestFilesResourceConfig,
     RequestsResource,
     RequestsResourceConfig,
 )
 from .services import (
     RequestEventsService,
     RequestEventsServiceConfig,
+    RequestFilesService,
+    RequestFilesServiceConfig,
     RequestsService,
     RequestsServiceConfig,
     UserModerationRequestService,
@@ -38,7 +42,8 @@ def __init__(self, app=None):
         """Extension initialization."""
         self.requests_service = None
         self.requests_resource = None
-        self.request_comments_service = None
+        self.request_events_service = None
+        self.request_files_service = None
         self._schema_cache = {}
         self._events_schema_cache = {}
         if app:
@@ -64,6 +69,7 @@ def service_configs(self, app):
         class ServiceConfigs:
             requests = RequestsServiceConfig.build(app)
             request_events = RequestEventsServiceConfig.build(app)
+            request_files = RequestFilesServiceConfig.build(app)
 
         return ServiceConfigs
 
@@ -77,6 +83,9 @@ def init_services(self, app):
         self.request_events_service = RequestEventsService(
             config=service_configs.request_events,
         )
+        self.request_files_service = RequestFilesService(
+            config=service_configs.request_files,
+        )
         self.user_moderation_requests_service = UserModerationRequestService(
             requests_service=self.requests_service,
         )
@@ -93,6 +102,11 @@ def init_resources(self, app):
             config=RequestCommentsResourceConfig,
         )
 
+        self.request_files_resource = RequestFilesResource(
+            service=self.request_files_service,
+            config=RequestFilesResourceConfig,
+        )
+
     def init_registry(self, app):
         """Initialize the registry for Requests per type."""
         self.request_type_registry = TypeRegistry(
@@ -148,9 +162,11 @@ def init(app):
     requests_ext = app.extensions["invenio-requests"]
     requests_service = requests_ext.requests_service
     events_service = requests_ext.request_events_service
+    files_service = requests_ext.request_files_service
 
     svc_reg.register(requests_service)
     svc_reg.register(events_service)
+    svc_reg.register(files_service)
 
     idx_reg.register(requests_service.indexer, indexer_id="requests")
     idx_reg.register(events_service.indexer, indexer_id="events")

invenio_requests/records/api.py

@@ -11,19 +11,19 @@
 from enum import Enum
 from functools import partial
 
+from flask import current_app
 from invenio_records.dumpers import SearchDumper
 from invenio_records.systemfields import ConstantField, DictField, ModelField
-from invenio_records_resources.records.api import Record
-from invenio_records_resources.records.systemfields import IndexField
-from werkzeug.utils import cached_property
+from invenio_records_resources.records.api import FileRecord, Record
+from invenio_records_resources.records.systemfields import FilesField, IndexField
 
 from ..customizations import RequestState as State
 from .dumpers import (
     CalculatedFieldDumperExt,
     GrantTokensDumperExt,
     ParentChildDumperExt,
 )
-from .models import RequestEventModel, RequestMetadata
+from .models import RequestEventModel, RequestFileMetadata, RequestMetadata
 from .systemfields import (
     EntityReferenceField,
     EventTypeField,
@@ -109,6 +109,22 @@ def pre_commit(self):
         super().pre_commit()
 
 
+def get_files_quota(record=None):
+    """Get bucket quota configuration for request files."""
+    # Returns quota_size and max_file_size from Flask config
+    # with defaults (100MB total quota, 10MB max file size)
+    return dict(
+        quota_size=current_app.config.get("REQUESTS_FILES_DEFAULT_QUOTA_SIZE"),
+        max_file_size=current_app.config.get("REQUESTS_FILES_DEFAULT_MAX_FILE_SIZE"),
+    )
+
+
+class RequestFile(FileRecord):
+    """Request file API."""
+
+    model_cls = RequestFileMetadata
+
+
 class Request(Record):
     """A generic request record."""
 
@@ -183,3 +199,16 @@ class Request(Record):
 
     is_locked = DictField("is_locked")
     """Whether or not the request is locked."""
+
+    bucket_id = ModelField(dump=False)
+    bucket = ModelField(dump=False)
+
+    # Files NOT dumped or stored in JSON - internal only
+    files = FilesField(
+        store=False,  # Don't serialize to request JSON
+        dump=False,  # Don't include in dumps()
+        file_cls=RequestFile,
+        delete=False,  # Manual management via service
+        create=False,  # Lazy initialization
+        bucket_args=get_files_quota,  # Quota config
+    )

invenio_requests/records/jsonschemas/requests/request-v1.0.0.json

@@ -45,6 +45,17 @@
       "items": {
         "$ref": "local://definitions-v1.0.0.json#/entity_reference"
       }
+    },
+    "files": {
+      "type": "object",
+      "description": "Files associated with the record",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Set to false for metadata only records."
+        }
+      }
     }
   }
 }

invenio_requests/records/mappings/os-v1/requests/request-v1.0.0.json

@@ -149,6 +149,14 @@
       },
       "is_locked": {
         "type": "boolean"
+      },
+      "files": {
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "type": "boolean"
+          }
+        }
       }
     }
   }

invenio_requests/records/mappings/os-v2/requests/request-v1.0.0.json

@@ -151,6 +151,14 @@
       },
       "is_locked": {
         "type": "boolean"
+      },
+      "files": {
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "type": "boolean"
+          }
+        }
       }
     }
   }

invenio_requests/records/mappings/v7/requests/request-v1.0.0.json

@@ -151,6 +151,14 @@
       },
       "is_locked": {
         "type": "boolean"
+      },
+      "files": {
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "type": "boolean"
+          }
+        }
       }
     }
   }

invenio_requests/resources/__init__.py

@@ -11,11 +11,14 @@
 """Resources module."""
 
 from .events import RequestCommentsResource, RequestCommentsResourceConfig
+from .files import RequestFilesResource, RequestFilesResourceConfig
 from .requests import RequestsResource, RequestsResourceConfig
 
 __all__ = (
     "RequestsResource",
     "RequestsResourceConfig",
     "RequestCommentsResource",
     "RequestCommentsResourceConfig",
+    "RequestFilesResource",
+    "RequestFilesResourceConfig",
 )