feat(events): use self_html link for hash with type-specific overridable context; focused -> focussed; error i18n

Author: palkerecsenyi

invenio_requests/assets/semantic-ui/js/invenio_requests/api/InvenioRequestApi.js

@@ -6,13 +6,18 @@
 
 import _isEmpty from "lodash/isEmpty";
 import { http } from "react-invenio-forms";
+import { i18next } from "@translations/invenio_requests/i18next";
 
 export class RequestLinksExtractor {
   #urls;
 
   constructor(request) {
     if (!request?.links) {
-      throw TypeError("Request resource links are undefined");
+      throw TypeError(
+        i18next.t("{{link_name}} links are undefined. Please refresh the page.", {
+          link_name: "Request resource",
+        })
+      );
     }
     this.#urls = request.links;
   }
@@ -23,28 +28,44 @@ export class RequestLinksExtractor {
 
   get timeline() {
     if (!this.#urls.timeline) {
-      throw TypeError("Timeline link missing from resource.");
+      throw TypeError(
+        i18next.t("{{link_name}} link missing from resource.", {
+          link_name: "Timeline",
+        })
+      );
     }
     return this.#urls.timeline;
   }
 
-  get timelineFocussed() {
+  get timelineFocused() {
     if (!this.#urls.timeline) {
-      throw TypeError("Timeline focussed link missing from resource.");
+      throw TypeError(
+        i18next.t("{{link_name}} link missing from resource.", {
+          link_name: "Focused timeline",
+        })
+      );
     }
-    return this.#urls.timeline_focussed;
+    return this.#urls.timeline_focused;
   }
 
   get comments() {
     if (!this.#urls.comments) {
-      throw TypeError("Comments link missing from resource.");
+      throw TypeError(
+        i18next.t("{{link_name}} link missing from resource.", {
+          link_name: "Comments",
+        })
+      );
     }
     return this.#urls.comments;
   }
 
   get actions() {
     if (!this.#urls.actions) {
-      throw TypeError("Actions link missing from resource.");
+      throw TypeError(
+        i18next.t("{{link_name}} link missing from resource.", {
+          link_name: "Actions",
+        })
+      );
     }
     return this.#urls.actions;
   }
@@ -70,8 +91,8 @@ export class InvenioRequestsAPI {
     });
   };
 
-  getTimelineFocussed = async (focusEventId, params) => {
-    return await http.get(this.#urls.timelineFocussed, {
+  getTimelineFocused = async (focusEventId, params) => {
+    return await http.get(this.#urls.timelineFocused, {
       params: {
         expand: 1,
         focus_event_id: focusEventId,

invenio_requests/assets/semantic-ui/js/invenio_requests/api/InvenioRequestEventsApi.js

@@ -4,6 +4,7 @@
 // Invenio RDM Records is free software; you can redistribute it and/or modify it
 // under the terms of the MIT License; see LICENSE file for more details.
 import { http } from "react-invenio-forms";
+import { i18next } from "@translations/invenio_requests/i18next";
 
 export class RequestEventsLinksExtractor {
   #links;
@@ -14,7 +15,11 @@ export class RequestEventsLinksExtractor {
 
   get eventUrl() {
     if (!this.#links.self) {
-      throw TypeError("Self link missing from resource.");
+      throw TypeError(
+        i18next.t("{{link_name}} link missing from resource.", {
+          link_name: "Self",
+        })
+      );
     }
     return this.#links.self;
   }

invenio_requests/assets/semantic-ui/js/invenio_requests/timeline/state/actions.js

@@ -38,7 +38,7 @@ export const fetchTimeline = (focusEventId = undefined) => {
     try {
       let response;
       if (focusEventId) {
-        response = await config.requestsApi.getTimelineFocussed(focusEventId, {
+        response = await config.requestsApi.getTimelineFocused(focusEventId, {
           size: size,
         });
       } else {
@@ -102,6 +102,9 @@ export const setPage = (page) => {
       type: CHANGE_PAGE,
       payload: page,
     });
+    dispatch({
+      type: IS_LOADING,
+    });
 
     await dispatch(fetchTimeline());
   };

invenio_requests/assets/semantic-ui/js/invenio_requests/timelineEvents/TimelineCommentEvent.js

@@ -16,7 +16,7 @@ import { RichEditor } from "react-invenio-forms";
 import RequestsFeed from "../components/RequestsFeed";
 import { TimelineEventBody } from "../components/TimelineEventBody";
 import { toRelativeTime } from "react-invenio-forms";
-import { copyUrlForEvent, getEventIdFromUrl } from "./utils";
+import { getEventIdFromUrl } from "./utils";
 
 class TimelineCommentEvent extends Component {
   constructor(props) {
@@ -61,9 +61,11 @@ class TimelineCommentEvent extends Component {
 
   copyLink() {
     const {
-      event: { id: eventId },
+      event: {
+        links: { self_html },
+      },
     } = this.props;
-    copyUrlForEvent(eventId);
+    navigator.clipboard.writeText(self_html);
   }
 
   render() {

invenio_requests/assets/semantic-ui/js/invenio_requests/timelineEvents/utils.js

@@ -4,12 +4,6 @@
 // Invenio Requests is free software; you can redistribute it and/or modify it
 // under the terms of the MIT License; see LICENSE file for more details.
 
-export const copyUrlForEvent = (eventId) => {
-  const currentUrl = new URL(window.location.href);
-  currentUrl.hash = `commentevent-${eventId}`;
-  navigator.clipboard.writeText(currentUrl.toString());
-};
-
 export const getEventIdFromUrl = () => {
   const currentUrl = new URL(window.location.href);
   const hash = currentUrl.hash;

invenio_requests/resources/events/config.py

@@ -32,7 +32,7 @@ class RequestCommentsResourceConfig(RecordResourceConfig):
         "list": "/<request_id>/comments",
         "item": "/<request_id>/comments/<comment_id>",
         "timeline": "/<request_id>/timeline",
-        "timeline_focussed": "/<request_id>/timeline_focussed",
+        "timeline_focused": "/<request_id>/timeline_focused",
     }
 
     # Input

invenio_requests/resources/events/resource.py

@@ -61,7 +61,7 @@ def create_url_rules(self):
             route("PUT", routes["item"], self.update),
             route("DELETE", routes["item"], self.delete),
             route("GET", routes["timeline"], self.search),
-            route("GET", routes["timeline_focussed"], self.focussed_list),
+            route("GET", routes["timeline_focused"], self.focused_list),
         ]
 
     @list_view_args_parser
@@ -145,9 +145,9 @@ def search(self):
     @request_extra_args
     @search_args_parser
     @response_handler(many=True)
-    def focussed_list(self):
+    def focused_list(self):
         """List the page containing the event with ID focus_event_id, or the first page of results if this is not found."""
-        hits = self.service.focussed_list(
+        hits = self.service.focused_list(
             identity=g.identity,
             request_id=resource_requestctx.view_args["request_id"],
             focus_event_id=resource_requestctx.args.get("focus_event_id"),

invenio_requests/services/events/config.py

@@ -18,6 +18,11 @@
 from invenio_records_resources.services.records.links import pagination_links
 from invenio_records_resources.services.records.results import RecordItem, RecordList
 
+from invenio_requests.proxies import (
+    current_request_type_registry,
+    current_requests_service,
+)
+
 from ...records.api import Request, RequestEvent
 from ..permissions import PermissionPolicy
 from ..schemas import RequestEventSchema
@@ -67,9 +72,11 @@ class RequestEventLink(Link):
     """Link variables setter for RequestEvent links."""
 
     @staticmethod
-    def vars(record, vars):
+    def vars(obj, vars):
         """Variables for the URI template."""
-        vars.update({"id": record.id, "request_id": record.request_id})
+        request_type = current_request_type_registry.lookup(vars["request_type"])
+        vars.update({"id": obj.id, "request_id": obj.request_id})
+        vars.update(request_type._update_link_config(**vars))
 
 
 class RequestEventsServiceConfig(RecordServiceConfig, ConfiguratorMixin):
@@ -90,6 +97,7 @@ class RequestEventsServiceConfig(RecordServiceConfig, ConfiguratorMixin):
     # ResultItem configurations
     links_item = {
         "self": RequestEventLink("{+api}/requests/{request_id}/comments/{id}"),
+        "self_html": RequestEventLink("{+ui}/requests/{request_id}#commentevent-{id}"),
     }
     links_search = pagination_links("{+api}/requests/{request_id}/timeline{?args*}")
 

invenio_requests/services/events/service.py

@@ -45,6 +45,16 @@ def expandable_fields(self):
         """Get expandable fields."""
         return [EntityResolverExpandableField("created_by")]
 
+    def links_item_tpl_for_request(self, request):
+        """Include the request's type ID in the link template.
+
+        This way, the link URL can be contextualised depending on the type of the event's
+        parent request.
+        """
+        return LinksTemplate(
+            self.config.links_item, context={"request_type": str(request.type)}
+        )
+
     @unit_of_work()
     def create(
         self,
@@ -119,7 +129,7 @@ def create(
             identity,
             event,
             schema=schema,
-            links_tpl=self.links_item_tpl,
+            links_tpl=self.links_item_tpl_for_request(request),
             expandable_fields=self.expandable_fields,
             expand=expand,
         )
@@ -136,7 +146,7 @@ def read(self, identity, id_, expand=False):
             identity,
             event,
             schema=self._wrap_schema(event.type.marshmallow_schema()),
-            links_tpl=self.links_item_tpl,
+            links_tpl=self.links_item_tpl_for_request(request),
             expandable_fields=self.expandable_fields,
             expand=expand,
         )
@@ -183,7 +193,7 @@ def update(self, identity, id_, data, revision_id=None, uow=None, expand=False):
             identity,
             event,
             schema=schema,
-            links_tpl=self.links_item_tpl,
+            links_tpl=self.links_item_tpl_for_request(request),
             expandable_fields=self.expandable_fields,
             expand=expand,
         )
@@ -269,12 +279,12 @@ def search(
                 self.config.links_search,
                 context={"request_id": str(request.id), "args": params},
             ),
-            links_item_tpl=self.links_item_tpl,
+            links_item_tpl=self.links_item_tpl_for_request(request),
             expandable_fields=self.expandable_fields,
             expand=expand,
         )
 
-    def focussed_list(
+    def focused_list(
         self,
         identity,
         request_id,
@@ -283,7 +293,7 @@ def focussed_list(
         expand=False,
         search_preference=None,
     ):
-        """Return a page of results focussed on a given event, or the first page if the event is not found."""
+        """Return a page of results focused on a given event, or the first page if the event is not found."""
         # Permissions - guarded by the request's can_read.
         request = self._get_request(request_id)
         self.require_permission(identity, "read", request=request)
@@ -332,7 +342,7 @@ def focussed_list(
                 self.config.links_search,
                 context={"request_id": str(request.id), "args": params},
             ),
-            links_item_tpl=self.links_item_tpl,
+            links_item_tpl=self.links_item_tpl_for_request(request),
             expandable_fields=self.expandable_fields,
             expand=expand,
         )

invenio_requests/services/requests/config.py

@@ -107,7 +107,7 @@ class RequestsServiceConfig(RecordServiceConfig, ConfiguratorMixin):
         "self_html": RequestLink("{+ui}/requests/{id}"),
         "comments": RequestLink("{+api}/requests/{id}/comments"),
         "timeline": RequestLink("{+api}/requests/{id}/timeline"),
-        "timeline_focussed": RequestLink("{+api}/requests/{id}/timeline_focussed"),
+        "timeline_focused": RequestLink("{+api}/requests/{id}/timeline_focused"),
     }
     links_search = pagination_links("{+api}/requests{?args*}")
     links_user_requests_search = pagination_links("{+api}/user/requests{?args*}")