invenio-app-ils 6.0.0__tar.gz → 6.1.0__tar.gz

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/CHANGES.rst

@@ -8,6 +8,14 @@
 Changes
 =======
 
+Version 6.1.0 (released 2025-10-05)
+
+- fix: make terms query that gets eitems by creator use correct keyword
+- stats: record change ids only contain `user_id` when it is not None
+- global: include python files inside invenio_app_ils in manifest
+- stats: move file `test_stats` into folder for stats
+- stats: add stats to track ILSRecord insertions, deletions and updates
+
 Version 6.0.0 (released 2025-10-03)
 
 - breaking change: permissions: turn permission that checks if user can see notifications into read permission

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/MANIFEST.in

@@ -64,6 +64,7 @@ recursive-include invenio_app_ils *.ttf
 recursive-include invenio_app_ils *.woff
 recursive-include invenio_app_ils *.woff2
 recursive-include invenio_app_ils *.config
+recursive-include invenio_app_ils *.py
 recursive-include tests *.py
 recursive-include tests *.json
 recursive-include tests *.html

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invenio-app-ils
-Version: 6.0.0
+Version: 6.1.0
 Summary: Invenio Integrated Library System.
 Home-page: https://github.com/inveniosoftware/invenio-app-ils
 Author: CERN
@@ -103,6 +103,14 @@ https://invenioils.docs.cern.ch
 Changes
 =======
 
+Version 6.1.0 (released 2025-10-05)
+
+- fix: make terms query that gets eitems by creator use correct keyword
+- stats: record change ids only contain `user_id` when it is not None
+- global: include python files inside invenio_app_ils in manifest
+- stats: move file `test_stats` into folder for stats
+- stats: add stats to track ILSRecord insertions, deletions and updates
+
 Version 6.0.0 (released 2025-10-03)
 
 - breaking change: permissions: turn permission that checks if user can see notifications into read permission

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/invenio_app_ils/__init__.py

@@ -7,6 +7,6 @@
 
 """invenio-app-ils."""
 
-__version__ = "6.0.0"
+__version__ = "6.1.0"
 
 __all__ = ("__version__",)

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/invenio_app_ils/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2018-2020 CERN.
+# Copyright (C) 2018-2025 CERN.
 #
 # invenio-app-ils is free software; you can redistribute it and/or modify it
 # under the terms of the MIT License; see LICENSE file for more details.
@@ -15,6 +15,7 @@ You overwrite and set instance-specific configuration by either:
 
 import datetime
 from datetime import timedelta
+from functools import partial
 
 from celery.schedules import crontab
 from invenio_accounts.config import (
@@ -24,7 +25,7 @@ from invenio_records_rest.facets import terms_filter
 from invenio_records_rest.utils import allow_all, deny_all
 from invenio_stats.aggregations import StatAggregator
 from invenio_stats.processors import EventsIndexer
-from invenio_stats.queries import ESTermsQuery
+from invenio_stats.queries import DateHistogramQuery, ESTermsQuery
 
 from invenio_app_ils.document_requests.indexer import DocumentRequestIndexer
 from invenio_app_ils.documents.indexer import DocumentIndexer
@@ -41,6 +42,7 @@ from invenio_app_ils.literature.search import LiteratureSearch
 from invenio_app_ils.locations.indexer import LocationIndexer
 from invenio_app_ils.patrons.indexer import PatronIndexer
 from invenio_app_ils.series.indexer import SeriesIndexer
+from invenio_app_ils.stats.event_builders import ils_record_changed_event_builder
 from invenio_app_ils.vocabularies.indexer import VocabularyIndexer
 
 from .document_requests.api import (
@@ -95,6 +97,7 @@ from .permissions import (
     authenticated_user_permission,
     backoffice_permission,
     backoffice_read_permission,
+    superuser_permission,
     views_permissions_factory,
 )
 from .records.permissions import record_read_permission_factory
@@ -234,12 +237,20 @@ CELERY_BEAT_SCHEDULE = {
     "stats-process-events": {
         "task": "invenio_stats.tasks.process_events",
         "schedule": timedelta(minutes=30),
-        "args": [("record-view", "file-download")],
+        "args": [
+            (
+                "record-view",
+                "file-download",
+                "ils-record-changes-updates",
+                "ils-record-changes-insertions",
+                "ils-record-changes-deletions",
+            )
+        ],
     },
     "stats-aggregate-events": {
         "task": "invenio_stats.tasks.aggregate_events",
         "schedule": timedelta(hours=3),
-        "args": [("record-view-agg", "file-download-agg")],
+        "args": [("record-view-agg", "file-download-agg", "ils-record-changes-agg")],
     },
     "clean_locations_past_closures_exceptions": {
         "task": (
@@ -921,6 +932,57 @@ STATS_EVENTS = {
             "suffix": "%Y-%m",
         },
     },
+    "ils-record-changes-updates": {
+        "signal": "invenio_records.signals.after_record_update",
+        "templates": "invenio_app_ils.stats.templates.events.ils_record_changes",
+        "event_builders": [
+            partial(ils_record_changed_event_builder, method="update"),
+            "invenio_app_ils.stats.event_builders.add_librarian_user_id_to_event",
+            "invenio_app_ils.stats.event_builders.add_record_pid_to_event",
+        ],
+        "cls": EventsIndexer,
+        "params": {
+            "preprocessors": [
+                "invenio_app_ils.stats.processors.add_record_change_ids",
+            ],
+            "double_click_window": 0,
+            "suffix": "%Y",
+        },
+    },
+    "ils-record-changes-insertions": {
+        "signal": "invenio_records.signals.after_record_insert",
+        "templates": "invenio_app_ils.stats.templates.events.ils_record_changes",
+        "event_builders": [
+            partial(ils_record_changed_event_builder, method="insert"),
+            "invenio_app_ils.stats.event_builders.add_librarian_user_id_to_event",
+            "invenio_app_ils.stats.event_builders.add_record_pid_to_event",
+        ],
+        "cls": EventsIndexer,
+        "params": {
+            "preprocessors": [
+                "invenio_app_ils.stats.processors.add_record_change_ids",
+            ],
+            "double_click_window": 0,
+            "suffix": "%Y",
+        },
+    },
+    "ils-record-changes-deletions": {
+        "signal": "invenio_records.signals.after_record_delete",
+        "templates": "invenio_app_ils.stats.templates.events.ils_record_changes",
+        "event_builders": [
+            partial(ils_record_changed_event_builder, method="delete"),
+            "invenio_app_ils.stats.event_builders.add_librarian_user_id_to_event",
+            "invenio_app_ils.stats.event_builders.add_record_pid_to_event",
+        ],
+        "cls": EventsIndexer,
+        "params": {
+            "preprocessors": [
+                "invenio_app_ils.stats.processors.add_record_change_ids",
+            ],
+            "double_click_window": 0,
+            "suffix": "%Y",
+        },
+    },
 }
 
 STATS_AGGREGATIONS = {
@@ -967,6 +1029,19 @@ STATS_AGGREGATIONS = {
             ),
         ),
     ),
+    "ils-record-changes-agg": dict(
+        templates="invenio_app_ils.stats.templates.aggregations.ils_record_changes",
+        cls=StatAggregator,
+        params=dict(
+            event="ils-record-changes",
+            field="aggregation_id",
+            interval="day",
+            index_interval="year",
+            copy_fields=dict(pid_type="pid_type", method="method", user_id="user_id"),
+            metric_fields=dict(),
+            query_modifiers=[],
+        ),
+    ),
 }
 
 STATS_QUERIES = {
@@ -1003,6 +1078,44 @@ STATS_QUERIES = {
             ),
         ),
     ),
+    "ils-record-changes": dict(
+        cls=DateHistogramQuery,
+        permission_factory=backoffice_read_permission,
+        params=dict(
+            index="stats-ils-record-changes",
+            copy_fields=dict(
+                pid_type="pid_type",
+                method="method",
+            ),
+            required_filters=dict(
+                pid_type="pid_type",
+                method="method",
+            ),
+            metric_fields=dict(
+                count=("sum", "count", {}),
+            ),
+        ),
+    ),
+    "ils-record-changes-per-user": dict(
+        cls=ESTermsQuery,
+        permission_factory=superuser_permission,
+        params=dict(
+            index="stats-ils-record-changes",
+            copy_fields=dict(
+                pid_type="pid_type",
+                method="method",
+                user_id="user_id",
+            ),
+            required_filters=dict(
+                pid_type="pid_type",
+                method="method",
+            ),
+            metric_fields=dict(
+                count=("sum", "count", {}),
+            ),
+            aggregated_fields=["user_id"],
+        ),
+    ),
 }
 
 # List of available vocabularies

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/invenio_app_ils/eitems/api.py

@@ -133,7 +133,7 @@ def get_eitems_for_document_by_creator(document_pid, creator, case_insensitive=F
         document_pid=document_pid
     ).filter(
         "term",
-        created_by__value={"term": creator, "case_insensitive": case_insensitive},
+        created_by__value={"value": creator, "case_insensitive": case_insensitive},
     )
 
     return creator_match

invenio_app_ils-6.1.0/invenio_app_ils/stats/event_builders.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details
+
+"""ILS stats event builders."""
+
+import datetime
+
+from flask import g
+from flask_login import current_user
+
+from invenio_app_ils.permissions import backoffice_permission
+from invenio_app_ils.records.api import IlsRecord
+
+
+def ils_record_changed_event_builder(
+    event, sender_app, method=None, record=None, **kwargs
+):
+    """Build an event for ILS record changes."""
+
+    if not method:
+        raise ValueError("Method must be provided to the event builder.")
+    if not record:
+        raise ValueError("Record must be provided to the event builder.")
+    if not isinstance(record, IlsRecord):
+        return None
+
+    # We have to get the pid_type directly through the private accessor,
+    # as the pid might not be registered directly after the record creation.
+    pid_type = record._pid_type
+
+    event_data = {
+        "timestamp": datetime.datetime.now(datetime.timezone.utc)
+        .replace(tzinfo=None)
+        .isoformat(),
+        "pid_type": pid_type,
+        "method": method,
+    }
+
+    event.update(event_data)
+    return event
+
+
+def add_librarian_user_id_to_event(event, sender_app, **kwargs):
+    """Add the user_id of the librarian performing the action to the event."""
+
+    user_id = None
+    if (
+        current_user
+        and current_user.is_authenticated
+        and backoffice_permission().allows(g.identity)
+    ):
+        user_id = current_user.get_id()
+
+    event.update({"user_id": user_id})
+
+    return event
+
+
+def add_record_pid_to_event(event, sender_app, record=None, **kwargs):
+    """Add the record pid to the event."""
+    if not record:
+        raise ValueError("Record must be provided to the event builder.")
+
+    # We have to get the pid directly from the record,
+    # as the pid might not yet be registered (e.g. after record creation).
+    event.update({"pid_value": record.get("pid")})
+
+    return event

invenio_app_ils-6.1.0/invenio_app_ils/stats/processors.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2025 CERN.
+#
+# Invenio is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details
+
+"""ILS stats preprocessors."""
+
+
+def add_record_change_ids(doc):
+    """Add unique_id and aggregation_id to the doc."""
+
+    # We use this field to group by during aggregation.
+    # e.g. the count of created eitems by a user with id 7 is tracked under eitmid__insert__7.
+    doc["aggregation_id"] = f"{doc['pid_type']}__{doc['method']}"
+
+    # unique_id identifies each individual event and is used by invenio-stats.
+    # It automatically deduplicates events from the same second that have the same unique_id.
+    # Including the pid_value ensures distinctness between events,
+    # even when multiple records are updated within the same second.
+    # e.g. during the importer in cds-ils where many eitems are created in bulk.
+    doc["unique_id"] = f"{doc['pid_value']}__{doc['pid_type']}__{doc['method']}"
+
+    if doc["user_id"]:
+        doc["aggregation_id"] += f"__{doc['user_id']}"
+        doc["unique_id"] += f"__{doc['user_id']}"
+
+    return doc

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/aggregations/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Stats aggregations templates."""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/aggregations/ils_record_changes/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""ILS record changes aggregations templates"""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/aggregations/ils_record_changes/os-v2/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""ILS record changes aggregations templates"""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/aggregations/ils_record_changes/os-v2/aggr-ils-record-changes-v1.json

@@ -0,0 +1,41 @@
+{
+  "index_patterns": [
+    "__SEARCH_INDEX_PREFIX__stats-ils-record-changes-*"
+  ],
+  "settings": {
+    "index": {
+      "refresh_interval": "5s"
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "dynamic": false,
+    "numeric_detection": false,
+    "properties": {
+      "timestamp": {
+        "type": "date"
+      },
+      "updated_timestamp": {
+        "type": "date"
+      },
+      "pid_type": {
+        "type": "keyword"
+      },
+      "method": {
+        "type": "keyword"
+      },
+      "user_id": {
+        "type": "keyword"
+      },
+      "aggregation_id": {
+        "type": "keyword"
+      },
+      "count": {
+        "type": "integer"
+      }
+    }
+  },
+  "aliases": {
+    "__SEARCH_INDEX_PREFIX__stats-ils-record-changes": {}
+  }
+}

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/events/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""Stats events templates."""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/events/ils_record_changes/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""ILS record changes events templates."""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/events/ils_record_changes/os-v2/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2025 CERN.
+#
+# invenio-app-ils is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+
+"""ILS record changes events templates."""

invenio_app_ils-6.1.0/invenio_app_ils/stats/templates/events/ils_record_changes/os-v2/ils-record-changes-v1.json

@@ -0,0 +1,41 @@
+{
+  "index_patterns": [
+    "__SEARCH_INDEX_PREFIX__events-stats-ils-record-changes-*"
+  ],
+  "settings": {
+    "index": {
+      "refresh_interval": "5s"
+    }
+  },
+  "mappings": {
+    "date_detection": false,
+    "dynamic": false,
+    "numeric_detection": false,
+    "properties": {
+      "timestamp": {
+        "type": "date"
+      },
+      "updated_timestamp": {
+        "type": "date"
+      },
+      "pid_type": {
+        "type": "keyword"
+      },
+      "method": {
+        "type": "keyword"
+      },
+      "user_id": {
+        "type": "keyword"
+      },
+      "unique_id": {
+        "type": "keyword"
+      },
+      "aggregation_id": {
+        "type": "keyword"
+      }
+    }
+  },
+  "aliases": {
+    "__SEARCH_INDEX_PREFIX__events-stats-ils-record-changes": {}
+  }
+}

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/invenio_app_ils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invenio-app-ils
-Version: 6.0.0
+Version: 6.1.0
 Summary: Invenio Integrated Library System.
 Home-page: https://github.com/inveniosoftware/invenio-app-ils
 Author: CERN
@@ -103,6 +103,14 @@ https://invenioils.docs.cern.ch
 Changes
 =======
 
+Version 6.1.0 (released 2025-10-05)
+
+- fix: make terms query that gets eitems by creator use correct keyword
+- stats: record change ids only contain `user_id` when it is not None
+- global: include python files inside invenio_app_ils in manifest
+- stats: move file `test_stats` into folder for stats
+- stats: add stats to track ILSRecord insertions, deletions and updates
+
 Version 6.0.0 (released 2025-10-03)
 
 - breaking change: permissions: turn permission that checks if user can see notifications into read permission

{invenio_app_ils-6.0.0 → invenio_app_ils-6.1.0}/invenio_app_ils.egg-info/SOURCES.txt

@@ -409,6 +409,8 @@ invenio_app_ils/series/schemas/series/series-v2.0.0.json
 invenio_app_ils/static/images/placeholder.png
 invenio_app_ils/static_pages/search_guide.html
 invenio_app_ils/stats/__init__.py
+invenio_app_ils/stats/event_builders.py
+invenio_app_ils/stats/processors.py
 invenio_app_ils/stats/aggregations/__init__.py
 invenio_app_ils/stats/aggregations/aggr_file_download/__init__.py
 invenio_app_ils/stats/aggregations/aggr_file_download/os-v1/__init__.py
@@ -424,6 +426,14 @@ invenio_app_ils/stats/file_download/os-v2/__init__.py
 invenio_app_ils/stats/file_download/os-v2/file-download-v1.json
 invenio_app_ils/stats/file_download/v7/__init__.py
 invenio_app_ils/stats/file_download/v7/file-download-v1.json
+invenio_app_ils/stats/templates/aggregations/__init__.py
+invenio_app_ils/stats/templates/aggregations/ils_record_changes/__init__.py
+invenio_app_ils/stats/templates/aggregations/ils_record_changes/os-v2/__init__.py
+invenio_app_ils/stats/templates/aggregations/ils_record_changes/os-v2/aggr-ils-record-changes-v1.json
+invenio_app_ils/stats/templates/events/__init__.py
+invenio_app_ils/stats/templates/events/ils_record_changes/__init__.py
+invenio_app_ils/stats/templates/events/ils_record_changes/os-v2/__init__.py
+invenio_app_ils/stats/templates/events/ils_record_changes/os-v2/ils-record-changes-v1.json
 invenio_app_ils/templates/logged_out.html
 invenio_app_ils/templates/invenio_app_ils/mail/footer.html
 invenio_app_ils/templates/invenio_app_ils/notifications/footer.html