PT-3548: Create new comment threads

Added UsjReaderWriter.findNextMatchingNode

Tested findNextMatchingNode

Author: rolfheij-sil

assets/localization/en.json

@@ -5,6 +5,13 @@
   "%about_licenseLabel_format%": "License: {license}",
   "%about_versionLabel_format%": "Version: {version}",
   "%ariaLabel_opensInBrowser%": "Opens externally in a browser window",
+  "%menuItemName_wordList%": "Word List",
+  "%commentEditor_assignTo_label%": "Assign to",
+  "%commentEditor_cancelButton_tooltip%": "Cancel",
+  "%commentEditor_placeholder%": "Type your comment here...",
+  "%commentEditor_saveButton_tooltip%": "Save comment",
+  "%commentEditor_team%": "Team",
+  "%commentEditor_unassigned%": "Unassigned",
   "%data_loading_error_paratextData_auth_failure%": "Paratext Registration is not valid. Please update your registration information and try again.",
   "%data_loading_error_paratextData_internet_disabled%": "Internet access is disabled in “Paratext Registration Information”. Please enable it and try again.",
   "%data_loading_error_internetAccess_disabled%": "Internet access is disabled in “Internet Settings”. Please enable it and try again.",
@@ -32,7 +39,7 @@
   "%history_recent%": "Recent",
   "%history_recentSearches_ariaLabel%": "Show Recent Searches",
   "%home_dialog_title%": "Home",
-  "%insertNote%": "Insert Note",
+  "%insertComment%": "Insert Comment",
   "%mainMenu_about%": "About Platform.Bible",
   "%mainMenu_downloadInstallResources%": "Download/Install Resources",
   "%mainMenu_edit%": "Edit",
@@ -60,7 +67,6 @@
   "%mainMenu_view%": "View",
   "%mainMenu_visitSupportBible%": "Visit Support.Bible",
   "%mainMenu_window%": "Window",
-  "%menuItemName_wordList%": "Word List",
   "%product_name%": "Platform.Bible",
   "%product_shortName%": "Platform",
   "%project_full_name_missing%": "*Name Missing*",

assets/localization/es.json

@@ -127,6 +127,12 @@
   "%about_licenseLabel_format%": "Licencia: {license}",
   "%about_versionLabel_format%": "Versión: {version}",
   "%ariaLabel_opensInBrowser%": "Se abre externamente en el navegador.",
+  "%commentEditor_assignTo_label%": "Asignar a",
+  "%commentEditor_cancelButton_tooltip%": "Cancelar",
+  "%commentEditor_placeholder%": "Escribe tu comentario aquí...",
+  "%commentEditor_saveButton_tooltip%": "Guardar comentario",
+  "%commentEditor_team%": "Equipo",
+  "%commentEditor_unassigned%": "Sin asignar",
   "%data_loading_error_paratextData_auth_failure%": "La registración de Paratext no es válida. Actualice su información de registración y vuelva a intentarlo.",
   "%data_loading_error_paratextData_internet_disabled%": "El acceso a Internet está deshabilitado en “Información de Registro de Paratext”. Por favor, actívelo e intente nuevamente.",
   "%downloadUpdateProjectTab_aria_downloadable%": "proyectos descargables",
@@ -153,7 +159,7 @@
   "%history_recent%": "Recientes",
   "%history_recentSearches_ariaLabel%": "Mostrar búsquedas recientes",
   "%home_dialog_title%": "Inicio",
-  "%insertNote%": "Insertar Nota",
+  "%insertComment%": "Insertar comentario",
   "%mainMenu_about%": "Acerca de Platform.Bible",
   "%mainMenu_downloadInstallResources%": "Descargar/instalar recursos",
   "%mainMenu_downloadSlashUpdateProject%": "Descargar/actualizar proyecto",

c-sharp/Projects/ParatextProjectDataProvider.cs

@@ -323,6 +323,13 @@ public bool DeleteComment(string commentId)
     /// <returns>The auto-generated comment ID (format: "threadId/userName/date")</returns>
     public string CreateComment(Comment comment)
     {
+        if (comment.SelectedText.Contains('\\'))
+        {
+            throw new InvalidOperationException(
+                "Invalid selection. Selected text must be a simple word or phrase with no markers."
+            );
+        }
+
         var scrText = LocalParatextProjects.GetParatextProject(ProjectDetails.Metadata.Id);
 
         if (comment.AssignedUser != null)
@@ -661,7 +668,8 @@ public bool CanUserEditOrDeleteComment(string commentId)
             return false;
 
         // Must be the last comment in the thread
-        if (comment != thread.LastComment)
+        var lastComment = thread.LastComment;
+        if (lastComment == null || comment.Id != lastComment.Id)
             return false;
 
         // Must be the author of the comment
@@ -673,7 +681,7 @@ public bool CanUserEditOrDeleteComment(string commentId)
             return false;
 
         // Cannot edit/delete the first comment of a conflict note
-        if (thread.Type == NoteType.Conflict && thread.Comments[0] == comment)
+        if (thread.Type == NoteType.Conflict && thread.Comments[0].Id == comment.Id)
             return false;
 
         return true;

extensions/src/legacy-comment-manager/src/comment-list.web-view.tsx

@@ -10,20 +10,51 @@ import {
 } from 'platform-bible-react';
 import { useCallback, useEffect, useMemo, useState } from 'react';
 import { useLocalizedStrings, useProjectData, useProjectDataProvider } from '@papi/frontend/react';
-import { isPlatformError, LegacyCommentThread } from 'platform-bible-utils';
+import { isPlatformError, LegacyCommentThread, serialize } from 'platform-bible-utils';
 
 const DEFAULT_LEGACY_COMMENT_THREADS: LegacyCommentThread[] = [];
 
+/** Message types that can be received from the Comment List web view controller */
+type CommentListWebViewMessage = {
+  method: 'scrollToThread';
+  threadId: string;
+};
+
 global.webViewComponent = function CommentListWebView({
   useWebViewScrollGroupScrRef,
   projectId,
 }: WebViewProps) {
   const [localizedStrings] = useLocalizedStrings(COMMENT_LIST_STRING_KEYS);
   const [scrRef] = useWebViewScrollGroupScrRef();
   const [currentUserName, setCurrentUserName] = useState<string>('');
+  const [selectedThreadId, setSelectedThreadId] = useState<string | undefined>(undefined);
 
   const commentsPdp = useProjectDataProvider('legacyCommentManager.comments', projectId);
 
+  // Listen for messages from the web view controller
+  useEffect(() => {
+    const messageListener = ({ data }: MessageEvent<CommentListWebViewMessage>) => {
+      if (data.method === 'scrollToThread') {
+        logger.debug(`Comment list received scrollToThread message: ${serialize(data)}`);
+        const { threadId } = data;
+
+        // Find the thread element and scroll to it
+        const threadElement = document.getElementById(threadId);
+        if (threadElement) {
+          setSelectedThreadId(threadId);
+          threadElement.scrollIntoView({ behavior: 'smooth', block: 'center' });
+        } else {
+          logger.warn(`Could not find thread element with id: ${threadId}`);
+        }
+      }
+    };
+
+    window.addEventListener('message', messageListener);
+    return () => {
+      window.removeEventListener('message', messageListener);
+    };
+  }, []);
+
   // Fetch current user's registration data on mount
   useEffect(() => {
     let isMounted = true;
@@ -59,13 +90,13 @@ global.webViewComponent = function CommentListWebView({
           },
         ],
       };
-    }, [scrRef.book, scrRef.chapterNum, scrRef.verseNum]),
+    }, [scrRef.book, scrRef.chapterNum]),
     DEFAULT_LEGACY_COMMENT_THREADS,
   );
 
   const fetchAssignableUsers = useCallback(async () => {
     if (!commentsPdp) {
-      logger.error('Comments PDP is not available');
+      logger.debug('Comments PDP is not yet available for fetchAssignableUsers');
       return [];
     }
     return commentsPdp.findAssignableUsers();
@@ -74,7 +105,7 @@ global.webViewComponent = function CommentListWebView({
 
   const fetchCanUserAddCommentToThread = useCallback(async () => {
     if (!commentsPdp) {
-      logger.error('Comments PDP is not available');
+      logger.debug('Comments PDP is not yet available for fetchCanUserAddCommentToThread');
       return false;
     }
     return commentsPdp.canUserAddCommentToThread();
@@ -84,7 +115,7 @@ global.webViewComponent = function CommentListWebView({
   const canUserAssignThreadCallback = useCallback(
     async (threadId: string): Promise<boolean> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for canUserAssignThreadCallback');
         return false;
       }
       return commentsPdp.canUserAssignThread(threadId);
@@ -95,7 +126,7 @@ global.webViewComponent = function CommentListWebView({
   const canUserResolveThreadCallback = useCallback(
     async (threadId: string): Promise<boolean> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for canUserResolveThreadCallback');
         return false;
       }
       return commentsPdp.canUserResolveThread(threadId);
@@ -106,7 +137,7 @@ global.webViewComponent = function CommentListWebView({
   const canUserEditOrDeleteCommentCallback = useCallback(
     async (commentId: string): Promise<boolean> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for canUserEditOrDeleteCommentCallback');
         return false;
       }
       return commentsPdp.canUserEditOrDeleteComment(commentId);
@@ -117,7 +148,7 @@ global.webViewComponent = function CommentListWebView({
   const handleAddCommentToThread = useCallback(
     async (options: AddCommentToThreadOptions): Promise<string | undefined> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for handleAddCommentToThread');
         return undefined;
       }
       try {
@@ -139,7 +170,7 @@ global.webViewComponent = function CommentListWebView({
   const handleUpdateComment = useCallback(
     async (commentId: string, contents: string): Promise<boolean> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for handleUpdateComment');
         return false;
       }
       try {
@@ -156,7 +187,7 @@ global.webViewComponent = function CommentListWebView({
   const handleDeleteComment = useCallback(
     async (commentId: string): Promise<boolean> => {
       if (!commentsPdp) {
-        logger.error('Comments PDP is not available');
+        logger.debug('Comments PDP is not yet available for handleDeleteComment');
         return false;
       }
       try {
@@ -204,6 +235,8 @@ global.webViewComponent = function CommentListWebView({
           canUserAssignThreadCallback={canUserAssignThreadCallback}
           canUserResolveThreadCallback={canUserResolveThreadCallback}
           canUserEditOrDeleteCommentCallback={canUserEditOrDeleteCommentCallback}
+          selectedThreadId={selectedThreadId}
+          onSelectedThreadChange={setSelectedThreadId}
         />
       )}
     </div>