Moved MarkersViewNotifier to its own file

Author: tjcouch-sil

extensions/src/platform-scripture-editor/src/main.ts

@@ -1,8 +1,6 @@
-// eslint-disable-next-line max-classes-per-file
-import papi, { logger, WebViewFactory } from '@papi/backend';
+import papi, { logger, WebViewFactory } from '@papi/backend';
 import type {
   ExecutionActivationContext,
-  ExecutionToken,
   IWebViewProvider,
   OpenWebViewOptions,
   SavedWebViewDefinition,
@@ -12,14 +10,9 @@ import { SerializedVerseRef } from '@sillsdev/scripture';
 import {
   getErrorMessage,
   serialize,
-  Unsubscriber,
-  UnsubscriberAsync,
   USFM_MARKERS_MAP_PARATEXT_3_0,
   UsjNodeAndDocumentLocation,
   UsjReaderWriter,
-  Mutex,
-  MutexMap,
-  formatReplacementString,
 } from 'platform-bible-utils';
 import {
   EditorDecorations,
@@ -32,21 +25,14 @@ import { AnnotationStyleDataProviderEngine } from './annotation-style.data-provi
 import { mergeDecorations } from './decorations.util';
 import platformScriptureEditorWebViewStyles from './platform-scripture-editor.web-view.scss?inline';
 import platformScriptureEditorWebView from './platform-scripture-editor.web-view?inline';
-import { formatEditorTitle } from './platform-scripture-editor.utils';
+import {
+  formatEditorTitle,
+  SCRIPTURE_EDITOR_WEBVIEW_TYPE,
+} from './platform-scripture-editor.utils';
+import { MarkersViewNotifier } from './markers-view-notifier.model';
 
 logger.debug('Scripture Editor is importing!');
 
-const scriptureEditorWebViewType = 'platformScriptureEditor.react';
-
-/**
- * Time in milliseconds to wait before sending another notification informing the user that the
- * editor is read-only because they are in the markers view
- */
-const READONLY_NOTIFICATION_DISMISS_DURATION_MS = 24 * 60 * 60 * 1000;
-
-/** Time in milliseconds to throttle repeat notifications for the same project */
-const READONLY_NOTIFICATION_THROTTLE_MS = 5 * 1000;
-
 interface PlatformScriptureEditorOptions extends OpenWebViewOptions {
   projectId: string | undefined;
   isReadOnly: boolean;
@@ -194,7 +180,7 @@ async function insertFootnoteAtSelection(webViewId: string | undefined): Promise
   }
 
   const webViewController = await papi.webViews.getWebViewController(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     webViewId,
   );
 
@@ -213,7 +199,7 @@ async function insertCrossReferenceAtSelection(webViewId: string | undefined): P
   }
 
   const webViewController = await papi.webViews.getWebViewController(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     webViewId,
   );
 
@@ -284,7 +270,7 @@ async function open(
     // REVIEW: If an editor is already open for the selected project, we open another.
     // This matches the current behavior in P9, though it might not be what we want long-term.
     return papi.webViews.openWebView(
-      scriptureEditorWebViewType,
+      SCRIPTURE_EDITOR_WEBVIEW_TYPE,
       existingTabIdToReplace
         ? { type: 'replace-tab', targetTabId: existingTabIdToReplace }
         : undefined,
@@ -306,13 +292,13 @@ async function changeScriptureView(webViewId: string | undefined): Promise<void>
     return;
   }
 
-  if (webViewDefinition.webViewType !== scriptureEditorWebViewType) {
+  if (webViewDefinition.webViewType !== SCRIPTURE_EDITOR_WEBVIEW_TYPE) {
     logger.debug(`WebView is not a Scripture editor!`);
     return;
   }
 
   const controller = await papi.webViews.getWebViewController(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     webViewId,
   );
 
@@ -336,13 +322,13 @@ async function toggleFootnotesPane(webViewId: string | undefined): Promise<void>
     return;
   }
 
-  if (webViewDefinition.webViewType !== scriptureEditorWebViewType) {
+  if (webViewDefinition.webViewType !== SCRIPTURE_EDITOR_WEBVIEW_TYPE) {
     logger.debug(`WebView is not a Scripture editor!`);
     return;
   }
 
   const controller = await papi.webViews.getWebViewController(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     webViewId,
   );
 
@@ -366,13 +352,13 @@ async function changeFootnotesPaneLocation(webViewId: string | undefined): Promi
     return;
   }
 
-  if (webViewDefinition.webViewType !== scriptureEditorWebViewType) {
+  if (webViewDefinition.webViewType !== SCRIPTURE_EDITOR_WEBVIEW_TYPE) {
     logger.debug(`WebView is not a Scripture editor!`);
     return;
   }
 
   const controller = await papi.webViews.getWebViewController(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     webViewId,
   );
 
@@ -385,18 +371,18 @@ async function changeFootnotesPaneLocation(webViewId: string | undefined): Promi
 }
 
 /** Simple WebView provider so PAPI can get a Scripture Editor upon request */
-class ScriptureEditorWebViewFactory extends WebViewFactory<typeof scriptureEditorWebViewType> {
+class ScriptureEditorWebViewFactory extends WebViewFactory<typeof SCRIPTURE_EDITOR_WEBVIEW_TYPE> {
   constructor() {
-    super(scriptureEditorWebViewType);
+    super(SCRIPTURE_EDITOR_WEBVIEW_TYPE);
   }
 
   override async getWebViewDefinition(
     savedWebView: SavedWebViewDefinition,
     getWebViewOptions: PlatformScriptureEditorOptions,
   ): Promise<WebViewDefinition | undefined> {
-    if (savedWebView.webViewType !== scriptureEditorWebViewType)
+    if (savedWebView.webViewType !== SCRIPTURE_EDITOR_WEBVIEW_TYPE)
       throw new Error(
-        `${scriptureEditorWebViewType} provider received request to provide a ${savedWebView.webViewType} WebView`,
+        `${SCRIPTURE_EDITOR_WEBVIEW_TYPE} provider received request to provide a ${savedWebView.webViewType} WebView`,
       );
 
     // We know that the projectId (if present in the state) will be a string.
@@ -724,183 +710,6 @@ class ScriptureEditorWebViewFactory extends WebViewFactory<typeof scriptureEdito
 }
 const scriptureEditorWebViewProvider: IWebViewProvider = new ScriptureEditorWebViewFactory();
 
-/**
- * Notifier that alerts users when a Scripture Editor WebView is opened or updated with
- * `state.viewType === 'markers'`. Allows dismissing notifications per-project for 24 hours.
- */
-class MarkerViewNotifier {
-  /** UserData storage key for the disabled map */
-  private readonly disabledMapUserDataKey =
-    'platformScriptureEditor.markerViewNotificationDisabled';
-
-  /** Map of notification IDs to project IDs */
-  private readonly projectIdsByNotificationId = new Map<string | number, string>();
-
-  /** Map of project IDs to the time (in milliseconds) they were disabled */
-  private disabledMap: Record<string, number> = {};
-  /** Map of project IDs to timestamp (ms) of the last sent notification */
-  private lastNotificationByProject: Record<string, number> = {};
-  /** Map of per-project mutexes to avoid races when checking/updating last notification timestamps */
-  private projectMutexes = new MutexMap();
-
-  constructor(
-    private papiInstance: typeof papi,
-    private executionToken: ExecutionToken,
-  ) {}
-
-  /**
-   * Starts the notifier by loading persisted state and registering necessary commands and listeners
-   *
-   * @returns Array of disposables for the registered commands and listeners
-   */
-  async start(): Promise<(Unsubscriber | UnsubscriberAsync)[]> {
-    // Load persisted disable map once and cache it in memory
-    try {
-      const rawDisableMap =
-        (await this.papiInstance.storage.readUserData(
-          this.executionToken,
-          this.disabledMapUserDataKey,
-        )) ?? '{}';
-      this.disabledMap = JSON.parse(rawDisableMap);
-    } catch (e) {
-      logger.warn(`Failed to load marker-view disable map from storage: ${getErrorMessage(e)}`);
-      this.disabledMap = {};
-    }
-    // Register command to dismiss for a project for 24 hours
-    const dismissCommand = this.papiInstance.commands.registerCommand(
-      'platformScriptureEditor.dismissMarkerNotificationForProjectToday',
-      async (notificationId) => {
-        if (!notificationId) return;
-        const projectId = this.projectIdsByNotificationId.get(notificationId);
-        if (!projectId) return;
-        // Update in-memory map and persist
-        this.disabledMap[projectId] = Date.now();
-        try {
-          await this.papiInstance.storage.writeUserData(
-            this.executionToken,
-            this.disabledMapUserDataKey,
-            JSON.stringify(this.disabledMap),
-          );
-        } catch (e) {
-          logger.warn(
-            `Failed to persist marker-view disable map for project ${projectId}: ${getErrorMessage(e)}`,
-          );
-        }
-        // Clean up the runtime mapping
-        this.projectIdsByNotificationId.delete(notificationId);
-      },
-      {
-        method: {
-          summary: "Don't show marker view readonly notification for this project for 24 hours",
-          params: [{ name: 'notificationId', required: true, schema: { type: 'string' } }],
-          result: { name: 'return value', schema: { type: 'null' } },
-        },
-      },
-    );
-
-    // Listeners for new or updated webviews
-    const onOpen = this.papiInstance.webViews.onDidOpenWebView(({ webView }) =>
-      this.handleWebView(webView),
-    );
-    const onUpdate = this.papiInstance.webViews.onDidUpdateWebView(({ webView }) =>
-      this.handleWebView(webView),
-    );
-
-    return [await dismissCommand, onOpen, onUpdate];
-  }
-
-  /**
-   * Handles a WebView being opened or updated, sending a notification if it is a markers view and
-   * notifications are not disabled for its project
-   *
-   * @param webViewDefinition WebView that was opened or updated
-   */
-  private async handleWebView(webViewDefinition: SavedWebViewDefinition | WebViewDefinition) {
-    try {
-      // We are only interested in our editor WebViews, so ignore others
-      if (webViewDefinition.webViewType !== scriptureEditorWebViewType) return;
-      // TypeScript doesn't know the shape of state, but we know viewType (if present) is string
-      // eslint-disable-next-line no-type-assertion/no-type-assertion
-      const viewType = webViewDefinition.state?.viewType as string | undefined;
-
-      // Only need to send a notification if this is the markers view which is currently readonly
-      if (viewType !== 'markers') return;
-
-      const { projectId, state } = webViewDefinition;
-      // If no projectId, can't proceed. Just warn and be done
-      if (!projectId) {
-        logger.warn(
-          `MarkerViewNotifier found an editor view WebView (${webViewDefinition.id}) with no projectId!`,
-        );
-        return;
-      }
-
-      // If the view is already read-only, no need to notify
-      if (state?.isReadOnly) return;
-
-      // Check if this notification is disabled for this project
-      const disabledTime = this.disabledMap[projectId];
-      // If the disable time hasn't elapsed yet, don't send another notification
-      if (disabledTime && Date.now() < disabledTime + READONLY_NOTIFICATION_DISMISS_DURATION_MS)
-        return;
-
-      // Acquire a per-project mutex and atomically check/reserve the last-notification timestamp
-      // so we don't send the same notification multiple times in quick succession
-      const projectMutex: Mutex = this.projectMutexes.get(projectId);
-      await projectMutex.runExclusive(async () => {
-        const lastSent = this.lastNotificationByProject[projectId];
-        if (lastSent && Date.now() < lastSent + READONLY_NOTIFICATION_THROTTLE_MS) return;
-
-        // Resolve project name if possible
-        let projectName = projectId;
-        try {
-          const pdp = await this.papiInstance.projectDataProviders.get('platform.base', projectId);
-          projectName = (await pdp.getSetting('platform.name')) ?? projectId;
-        } catch (e) {
-          // fall back to id
-          logger.warn(
-            `MarkerViewNotifier failed to get project name for project ${projectId}: ${getErrorMessage(
-              e,
-            )}`,
-          );
-        }
-
-        // Localize and format the notification message and click label
-        const messageKey = '%platformScriptureEditor_markersView_readonly_message_format%';
-        const clickLabelKey = '%platformScriptureEditor_markersView_readonly_dismiss%';
-        let localizedMessageTemplate = messageKey;
-        let localizedClickLabel = clickLabelKey;
-        try {
-          const localized = await this.papiInstance.localization.getLocalizedStrings({
-            localizeKeys: [messageKey, clickLabelKey],
-          });
-          localizedMessageTemplate = localized[messageKey] ?? messageKey;
-          localizedClickLabel = localized[clickLabelKey] ?? localizedClickLabel;
-        } catch (e) {
-          logger.warn(
-            `Failed to get localized strings for marker-view notification: ${getErrorMessage(e)}`,
-          );
-        }
-
-        const message = formatReplacementString(localizedMessageTemplate, { projectName });
-
-        // Send notification informing that markers view is read-only for this WebView/project
-        const notificationId = await this.papiInstance.notifications.send({
-          severity: 'info',
-          message,
-          clickCommand: 'platformScriptureEditor.dismissMarkerNotificationForProjectToday',
-          clickCommandLabel: localizedClickLabel,
-        });
-        this.projectIdsByNotificationId.set(notificationId, projectId);
-
-        // Record the last-send time so we don't send duplicates too quickly
-        this.lastNotificationByProject[projectId] = Date.now();
-      });
-    } catch (e) {
-      logger.warn(`MarkerViewNotifier failed handling WebView: ${getErrorMessage(e)}`);
-    }
-  }
-}
 export async function activate(context: ExecutionActivationContext): Promise<void> {
   logger.debug('Scripture editor is activating!');
 
@@ -1012,7 +821,7 @@ export async function activate(context: ExecutionActivationContext): Promise<voi
   );
 
   const scriptureEditorWebViewProviderPromise = papi.webViewProviders.registerWebViewProvider(
-    scriptureEditorWebViewType,
+    SCRIPTURE_EDITOR_WEBVIEW_TYPE,
     scriptureEditorWebViewProvider,
   );
 
@@ -1084,7 +893,7 @@ export async function activate(context: ExecutionActivationContext): Promise<voi
   );
 
   // Await the registration promises at the end so we don't hold everything else up
-  const markerNotifier = new MarkerViewNotifier(papi, context.executionToken);
+  const markerNotifier = new MarkersViewNotifier(papi, context.executionToken);
   const markerNotifierUnsubscribers = await markerNotifier.start();
 
   context.registrations.add(