FR: JS API function to remove a specific tag

[silidev]

This is a sister issue to the already released issue #16210 (comment) , just removing a tag instead of adding it.

@Haz3-jolt will implement this (source: #16210 (comment) )

[Haz3-jolt]

Working on this!

[mikehardy]

would suggest implementing "setTags", add tag is a special case of full tag set manipulation, as is remove tag
but setTags would let you do multiple if you like, and either add or remove

[Haz3-jolt]

Oh shoot, just saw this. Your right it would be better, I have a patch like 99% ready with just the unit test for the issue left. Should I scrap it or refactor later, because tbh I can't find where setTags is actually implemented.

Are you referring to this?

Anki-Android/AnkiDroid/src/main/java/com/ichi2/anki/NoteEditor.kt

Line 1542 in ea311c9

private fun setTags(tags: Array<String>) {

[mikehardy]

Unknown? I was mostly making a comment about API design.

just seems better to just cut to the chase and treat them as a set with a "set update" operation that could modify the set

I think the real lesson here is: beginning to implement a feature request prior to discussing it or seeing it marked as accepted is probably moving just a hair too quickly... any code is a maintenance burden so should be considered carefully prior to addition

[Haz3-jolt]

Got it, seemed pretty simple that was why I got into patchwork pretty fast.

Also yeah I should have waited until it was accepted, sorry about that! will be traveling for the next couple of days so might not be able to pick it up.

[Haz3-jolt]

Unknown? I was mostly making a comment about API design.

just seems better to just cut to the chase and treat them as a set with a "set update" operation that could modify the set

I think the real lesson here is: beginning to implement a feature request prior to discussing it or seeing it marked as accepted is probably moving just a hair too quickly... any code is a maintenance burden so should be considered carefully prior to addition

Ok so regarding the API if we use setTags, since it takes an Array of strings how would we remove from the existing set? a pop() function?

So we could have a function for set tags and callable methods like remove, add and set? Because it might be more easy to use then raw set operations.

[Haz3-jolt]

@mikehardy Can I start working on refactoring the add tag into a setTags API function?

[Haz3-jolt]

I think set tags with args as noteId, tags, operation (set, remove, add) is better, any comments?

[mikehardy]

I prefer REST style APIs personally, which argues for 2 APIs only, "get tags for this thing" and "set tags for this thing". The tags as a set are a "document" in a REST API style. Caller handles the set mutation to do whatever they want

[Haz3-jolt]

ohh makes sense, ok then!

[Haz3-jolt]

@mikehardy what do you think of this prelim patch? I wanna get some feedback b4 going for a PR or building testcases.

Subject: [PATCH] Unit Tests for initializeApkgExportUi and initializeNotesExportUi
---
Index: AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt b/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt
--- a/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt	(revision ae3e639c535653b2365adfff61464a67c772386e)
+++ b/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt	(date 1736447518066)
@@ -373,6 +373,29 @@
                 getColUnsafe.updateNote(note)
                 convertToByteArray(apiContract, true)
             }
+
+            "setTagsToNote" -> {
+                val jsonObject = JSONObject(apiParams)
+                val noteId = jsonObject.getLong("noteId")
+                val tags = jsonObject.getJSONArray("tags")
+                val tagsList = mutableListOf<String>()
+                for (i in 0 until tags.length()) {
+                    tagsList.add(tags.getString(i))
+                }
+                val note = getColUnsafe.getNote(noteId).apply {
+                    setTagsFromStr(getColUnsafe, tagsList.joinToString(","))
+                }
+                getColUnsafe.updateNote(note)
+                convertToByteArray(apiContract, true)
+            }
+
+            "getTagsFromNote" -> {
+                val jsonObject = JSONObject(apiParams)
+                val noteId = jsonObject.getLong("noteId")
+                val note = getColUnsafe.getNote(noteId)
+                convertToByteArray(apiContract, note.tags.joinToString(","))
+            }
+
             "sttSetLanguage" -> convertToByteArray(apiContract, speechRecognizer.setLanguage(apiParams))
             "sttStart" -> {
                 val callback =
Index: AnkiDroid/src/main/assets/scripts/js-api.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/main/assets/scripts/js-api.js b/AnkiDroid/src/main/assets/scripts/js-api.js
--- a/AnkiDroid/src/main/assets/scripts/js-api.js	(revision ae3e639c535653b2365adfff61464a67c772386e)
+++ b/AnkiDroid/src/main/assets/scripts/js-api.js	(date 1736447299376)
@@ -72,6 +72,8 @@
     ankiSttStart: "sttStart",
     ankiSttStop: "sttStop",
     ankiAddTagToNote: "addTagToNote",
+    ankiSetTagsToNote: "setTagsToNote",
+    ankiGetTagsFromNote: "getTagsFromNote",
 };
 
 class AnkiDroidJS {
@@ -125,6 +127,21 @@
         };
         return;
     }
+    if (method === "ankiSetTagsToNote") {
+        AnkiDroidJS.prototype[method] = async function (noteId, tags) {
+            const endpoint = jsApiList[method];
+            const data = JSON.stringify({ noteId, tags});
+            return await this.handleRequest(endpoint, data);
+        };
+        return;
+    }
+    if (method === "ankiGetTagsFromNote") {
+        AnkiDroidJS.prototype[method] = async function (noteId) {
+            const endpoint = jsApiList[method];
+            const data = JSON.stringify({ noteId });
+            return await this.handleRequest(endpoint, data);
+        }
+    }
     if (method === "ankiTtsSpeak") {
         AnkiDroidJS.prototype[method] = async function (text, queueMode = 0) {
             const endpoint = jsApiList[method];

[Haz3-jolt]

Also is it possible to add labels for this issue!

[Haz3-jolt]

@silidev while this is not what you exactly asked for, are you fine with this?