feat: pagination support for logs request

src/ahriman/web/views/v1/__init__.py

@@ -0,0 +1,36 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from ahriman.web.views.v1.service.add import AddView
+from ahriman.web.views.v1.service.pgp import PGPView
+from ahriman.web.views.v1.service.process import ProcessView
+from ahriman.web.views.v1.service.rebuild import RebuildView
+from ahriman.web.views.v1.service.remove import RemoveView
+from ahriman.web.views.v1.service.request import RequestView
+from ahriman.web.views.v1.service.search import SearchView
+from ahriman.web.views.v1.service.update import UpdateView
+from ahriman.web.views.v1.service.upload import UploadView
+
+from ahriman.web.views.v1.status.logs import LogsView
+from ahriman.web.views.v1.status.package import PackageView
+from ahriman.web.views.v1.status.packages import PackagesView
+from ahriman.web.views.v1.status.status import StatusView
+
+from ahriman.web.views.v1.user.login import LoginView
+from ahriman.web.views.v1.user.logout import LogoutView

src/ahriman/web/views/v1/status/logs.py

@@ -22,6 +22,7 @@ import aiohttp_apispec  # type: ignore[import]
 from aiohttp.web import HTTPBadRequest, HTTPNoContent, HTTPNotFound, Response, json_response
 
 from ahriman.core.exceptions import UnknownPackageError
+from ahriman.core.util import pretty_datetime
 from ahriman.models.log_record_id import LogRecordId
 from ahriman.models.user_access import UserAccess
 from ahriman.web.schemas import AuthSchema, ErrorSchema, LogSchema, LogsSchema, PackageNameSchema
@@ -103,7 +104,7 @@ class LogsView(BaseView):
         response = {
             "package_base": package_base,
             "status": status.view(),
-            "logs": logs
+            "logs": "\n".join(f"[{pretty_datetime(created)}] {message}" for created, message in logs)
         }
         return json_response(response)
 

src/ahriman/web/views/v2/__init__.py

@@ -0,0 +1,20 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from ahriman.web.views.v2.status.logs import LogsView

src/ahriman/web/views/v2/status/__init__.py

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#

src/ahriman/web/views/v2/status/logs.py

@@ -0,0 +1,87 @@
+#
+# Copyright (c) 2021-2023 ahriman team.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+import aiohttp_apispec  # type: ignore[import]
+
+from aiohttp.web import HTTPBadRequest, HTTPNotFound, Response, json_response
+
+from ahriman.core.exceptions import UnknownPackageError
+from ahriman.models.user_access import UserAccess
+from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNameSchema, PaginationSchema
+from ahriman.web.schemas.logs_schema import LogsSchemaV2
+from ahriman.web.views.base import BaseView
+
+
+class LogsView(BaseView):
+    """
+    package logs web view
+
+    Attributes:
+        GET_PERMISSION(UserAccess): (class attribute) get permissions of self
+    """
+
+    GET_PERMISSION = UserAccess.Reporter
+
+    @aiohttp_apispec.docs(
+        tags=["Packages"],
+        summary="Get paginated package logs",
+        description="Retrieve package logs and the last package status",
+        responses={
+            200: {"description": "Success response", "schema": LogsSchemaV2},
+            400: {"description": "Bad data is supplied", "schema": ErrorSchema},
+            401: {"description": "Authorization required", "schema": ErrorSchema},
+            403: {"description": "Access is forbidden", "schema": ErrorSchema},
+            404: {"description": "Package base is unknown", "schema": ErrorSchema},
+            500: {"description": "Internal server error", "schema": ErrorSchema},
+        },
+        security=[{"token": [GET_PERMISSION]}],
+    )
+    @aiohttp_apispec.cookies_schema(AuthSchema)
+    @aiohttp_apispec.match_info_schema(PackageNameSchema)
+    @aiohttp_apispec.querystring_schema(PaginationSchema)
+    async def get(self) -> Response:
+        """
+        get last package logs
+
+        Returns:
+            Response: 200 with package logs on success
+
+        Raises:
+            HTTPBadRequest: if supplied parameters are invalid
+            HTTPNotFound: if package base is unknown
+        """
+        package_base = self.request.match_info["package"]
+        try:
+            limit = int(self.request.query.getone("limit", default=-1))
+            offset = int(self.request.query.getone("offset", default=0))
+        except Exception as ex:
+            raise HTTPBadRequest(reason=str(ex))
+
+        try:
+            _, status = self.service.package_get(package_base)
+        except UnknownPackageError:
+            raise HTTPNotFound
+        logs = self.service.logs_get(package_base, limit, offset)
+
+        response = {
+            "package_base": package_base,
+            "status": status.view(),
+            "logs": logs,
+        }
+        return json_response(response)