From 77a3a61063a7d9774a5f5d0e6a6a951db29c804b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Ml=C3=A1dek?= <t@mldk.cz>
Date: Sun, 5 Mar 2023 21:01:31 +0100
Subject: [PATCH] fix: various audioviewer bugs & improvements

- reflect editable state of regions
- editing regions actually works
- note is hidden in NOTE
- add logging
- select annotation by (not double) clicking
---
 .../display/blobs/AudioViewer.svelte          | 166 +++++++++++-------
 1 file changed, 103 insertions(+), 63 deletions(-)

diff --git a/webui/src/components/display/blobs/AudioViewer.svelte b/webui/src/components/display/blobs/AudioViewer.svelte
index e59b212..7eb7658 100644
--- a/webui/src/components/display/blobs/AudioViewer.svelte
+++ b/webui/src/components/display/blobs/AudioViewer.svelte
@@ -1,7 +1,7 @@
 <script lang="ts">
   import { debounce, throttle } from "lodash";
   import { onMount } from "svelte";
-  import type { IValue } from "upend/types";
+  import type { IEntry, IValue } from "upend/types";
   import type WaveSurfer from "wavesurfer.js";
   import type { Region, RegionParams } from "wavesurfer.js/src/plugin/regions";
   import {
@@ -14,6 +14,7 @@
   import { TimeFragment } from "../../../util/fragments/time";
   import Icon from "../../utils/Icon.svelte";
   import Selector from "../../utils/Selector.svelte";
+  import UpObject from "../../display/UpObject.svelte";
   import Spinner from "../../utils/Spinner.svelte";
   import { i18n } from "../../../i18n";
 
@@ -41,10 +42,6 @@
 
   type UpRegion = Region & { data: IValue };
   let currentAnnotation: UpRegion | undefined;
-  $: currentAnnotationIndex =
-    Array.from(regions)
-      .sort((a, b) => a.start - b.start)
-      .findIndex((r) => r.id === currentAnnotation.id) + 1;
 
   async function loadAnnotations() {
     const entity = await fetchEntity(address);
@@ -60,8 +57,11 @@
             wavesurfer.addRegion({
               id: `ws-region-${e.entity}`,
               color: annotation.get("COLOR") || DEFAULT_ANNOTATION_COLOR,
-              attributes: { "upend-id": annotation.address },
-              data: (annotation.attr["LBL"] || [])[0]?.value,
+              attributes: {
+                "upend-address": annotation.address,
+                label: annotation.get("LBL"),
+              },
+              data: (annotation.attr["NOTE"] || [])[0]?.value,
               ...fragment,
             } as RegionParams);
           }
@@ -69,70 +69,72 @@
       });
   }
 
-  async function createAnnotation(region: Region) {
-    const [_, uuid] = await putEntry({
-      entity: {
-        t: "Uuid",
-      },
-    });
-
-    // incorrect types, `update()` does take `attributes`
-    region.update({ attributes: { "upend-id": uuid } } as any);
-
-    await putEntry([
-      {
-        entity: uuid,
-        attribute: "ANNOTATES",
-        value: {
-          t: "Address",
-          c: address,
-        },
-      },
-      {
-        entity: uuid,
-        attribute: "W3C_FRAGMENT_SELECTOR",
-        value: {
-          t: "String",
-          c: new TimeFragment(region.start, region.end).toString(),
-        },
-      },
-    ]);
-  }
-
   $: if (wavesurfer) {
     if (editable) {
       wavesurfer.enableDragSelection({ color: DEFAULT_ANNOTATION_COLOR });
     } else {
       wavesurfer.disableDragSelection();
     }
-    regions.forEach((region) =>
-      region.update({ drag: detail, resize: detail })
-    );
+    Object.values(wavesurfer.regions.list).forEach((region) => {
+      region.update({ drag: editable, resize: editable });
+    });
   }
 
   async function updateAnnotation(region: Region) {
-    const entity = region.attributes["upend-id"];
+    let entity = region.attributes["upend-address"];
+
+    // Newly created
+    if (!entity) {
+      let [_, newEntity] = await putEntry({
+        entity: {
+          t: "Uuid",
+        },
+      });
+      entity = newEntity;
+
+      const nextAnnotationIndex = Object.values(wavesurfer.regions.list).length;
+      const label = `Annotation #${nextAnnotationIndex}`;
+
+      region.update({
+        attributes: {
+          "upend-address": entity,
+          label,
+        },
+      } as any); // incorrect types, `update()` does take `attributes`
+    }
+
+    await putEntityAttribute(entity, "LBL", {
+      t: "String",
+      c: region.attributes["label"],
+    });
+
+    await putEntityAttribute(entity, "ANNOTATES", {
+      t: "Address",
+      c: address,
+    });
+
     await putEntityAttribute(entity, "W3C_FRAGMENT_SELECTOR", {
       t: "String",
       c: new TimeFragment(region.start, region.end).toString(),
     });
 
-    await putEntityAttribute(entity, "LBL", region.data as IValue);
-
     await putEntityAttribute(entity, "COLOR", {
       t: "String",
       c: region.color,
     });
+
+    if (Object.values(region.data).length) {
+      await putEntityAttribute(entity, "NOTE", region.data as IValue);
+    }
   }
   const updateAnnotationDebounced = debounce(updateAnnotation, 250);
 
   async function deleteAnnotation(region: Region) {
-    // TODO - what if there's no id?
-    await deleteEntry(region.attributes["upend-id"]);
+    if (region.attributes["upend-address"]) {
+      await deleteEntry(region.attributes["upend-address"]);
+    }
   }
 
-  const regions = new Set<Region>();
-
   onMount(async () => {
     const WaveSurfer = await import("wavesurfer.js");
     const TimelinePlugin = await import("wavesurfer.js/src/plugin/timeline");
@@ -163,43 +165,69 @@
     });
 
     wavesurfer.on("ready", () => {
+      console.debug("wavesurfer ready");
+
       loaded = true;
       loadAnnotations();
     });
 
-    wavesurfer.on("region-created", (region: UpRegion) => {
-      regions.add(region);
-      if (!region.attributes["upend-id"]) {
-        createAnnotation(region);
-        currentAnnotation = region;
+    wavesurfer.on("region-created", async (region: UpRegion) => {
+      console.debug("wavesurfer region-created", region);
+
+      // Updating here, because if `drag` and `resize` are passed during adding,
+      // updating no longer works.
+      region.update({ drag: editable, resize: editable });
+
+      // If the region was created from the UI
+      if (!region.attributes["upend-address"]) {
+        await updateAnnotation(region);
+        // currentAnnotation = region;
       }
     });
 
     wavesurfer.on("region-updated", (region: UpRegion) => {
+      // console.debug("wavesurfer region-updated", region);
+
       currentAnnotation = region;
     });
 
     wavesurfer.on("region-update-end", (region: UpRegion) => {
+      console.debug("wavesurfer region-update-end", region);
+
       updateAnnotation(region);
       currentAnnotation = region;
     });
 
     wavesurfer.on("region-removed", (region: UpRegion) => {
+      console.debug("wavesurfer region-removed", region);
+
+      currentAnnotation = null;
       deleteAnnotation(region);
-      regions.delete(region);
     });
 
-    wavesurfer.on("region-in", (region: UpRegion) => {
+    // wavesurfer.on("region-in", (region: UpRegion) => {
+    //   console.debug("wavesurfer region-in", region);
+
+    //   currentAnnotation = region;
+    // });
+
+    // wavesurfer.on("region-out", (region: UpRegion) => {
+    //   console.debug("wavesurfer region-out", region);
+
+    //   if (currentAnnotation.id === region.id) {
+    //     currentAnnotation = undefined;
+    //   }
+    // });
+
+    wavesurfer.on("region-click", (region: UpRegion, _ev: MouseEvent) => {
+      console.debug("wavesurfer region-click", region);
+
       currentAnnotation = region;
     });
 
-    wavesurfer.on("region-out", (region: UpRegion) => {
-      if (currentAnnotation.id === region.id) {
-        currentAnnotation = undefined;
-      }
-    });
-
     wavesurfer.on("region-dblclick", (region: UpRegion, _ev: MouseEvent) => {
+      console.debug("wavesurfer region-dblclick", region);
+
       currentAnnotation = region;
       setTimeout(() => wavesurfer.setCurrentTime(region.start));
     });
@@ -231,7 +259,7 @@
   });
 </script>
 
-<div class="audio">
+<div class="audio" class:editable>
   {#if !loaded}
     <Spinner centered />
   {/if}
@@ -254,7 +282,15 @@
   <div class="wavesurfer" bind:this={containerEl} />
   {#if currentAnnotation}
     <section class="annotationEditor labelborder">
-      <header><h3>Annotation #{currentAnnotationIndex}</h3></header>
+      <header>
+        <h3>{$i18n.t("Annotation")}</h3>
+      </header>
+      {#if currentAnnotation.attributes["upend-address"]}
+        <UpObject
+          link
+          address={currentAnnotation.attributes["upend-address"]}
+        />
+      {/if}
       <div class="baseControls">
         <div class="regionControls">
           <div class="start">
@@ -310,7 +346,7 @@
         {#key currentAnnotation}
           <Selector
             type="value"
-            valueTypes={["String"]}
+            valueTypes={["String", "Address"]}
             value={currentAnnotation.data}
             disabled={!editable}
             on:input={(ev) => {
@@ -379,6 +415,10 @@
     display: none;
   }
 
+  :global(.audio:not(.editable) .wavesurfer-handle) {
+    display: none;
+  }
+
   :global(.wavesurfer-handle) {
     background: var(--foreground-lightest) !important;
   }