Unit Tests for getNoteTags and setNoteTags and tag validation

Author: Haz3-jolt

AnkiDroid/src/main/assets/scripts/js-api.js

@@ -130,6 +130,16 @@ Object.keys(jsApiList).forEach(method => {
     }
     if (method === "ankiSetNoteTags") {
         AnkiDroidJS.prototype[method] = async function (noteId, tags) {
+            let hasSpaces = false;
+            for (let i = 0; i < tags.length; i++) {
+                if (tags[i].trim().includes(" ") || tags[i].trim().includes("\u3000")) {
+                    hasSpaces = true;
+                    break;
+                }
+            }
+            if (hasSpaces) {
+                console.warn("Tags with spaces will have them converted to underscores.");
+            }
             const endpoint = jsApiList[method];
             const data = JSON.stringify({ noteId, tags });
             return await this.handleRequest(endpoint, data);

AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt

@@ -381,6 +381,11 @@ open class AnkiDroidJsAPI(
                 val jsonObject = JSONObject(apiParams)
                 val noteId = jsonObject.getLong("noteId")
                 val tags = jsonObject.getJSONArray("tags")
+                for (i in 0 until tags.length()) {
+                    val element = tags.getString(i).trim()
+                    val modifiedElement = element.replace(" ", "_").replace("\u3000", "_")
+                    tags.put(i, modifiedElement)
+                }
                 withCol {
                     fun Note.setTagsFromList(tagList: List<String>) {
                         val tagsAsString = this@withCol.tags.join(tagList)

AnkiDroid/src/test/java/com/ichi2/anki/AnkiDroidJsAPITest.kt

@@ -27,6 +27,7 @@ import com.ichi2.utils.BASIC_MODEL_NAME
 import net.ankiweb.rsdroid.withoutUnicodeIsolation
 import org.hamcrest.CoreMatchers.equalTo
 import org.hamcrest.MatcherAssert.assertThat
+import org.json.JSONArray
 import org.json.JSONObject
 import org.junit.Ignore
 import org.junit.Test
@@ -417,6 +418,78 @@ class AnkiDroidJsAPITest : RobolectricTest() {
             assertEquals(CardType.New, cardAfterReset.type, "Card type after reset")
         }
 
+    @Test
+    fun ankiGetNoteTagsTest() =
+        runTest {
+            val n =
+                addBasicNote("Front", "Back").update {
+                    tags = mutableListOf("tag1", "tag2", "tag3")
+                }
+
+            val reviewer: Reviewer = startReviewer()
+            waitForAsyncTasksToComplete()
+
+            val jsapi = reviewer.jsApi
+
+            // test get tags for note
+            val expectedTags = n.tags
+            val response = getDataFromRequest("getNoteTags", jsapi, jsonObjectOf("noteId" to n.id))
+            val jsonResponse = JSONObject(response)
+            val actualTags = JSONArray(jsonResponse.getString("value"))
+
+            assertEquals(expectedTags.size, actualTags.length())
+            for (i in 0 until actualTags.length()) {
+                assertEquals(expectedTags[i], actualTags.getString(i))
+            }
+        }
+
+    @Test
+    fun ankiSetNoteTagsTest() =
+        runTest {
+            val n =
+                addBasicNote("Front", "Back").update {
+                    tags = mutableListOf("tag1", "tag2", "tag3")
+                }
+
+            val reviewer: Reviewer = startReviewer()
+            waitForAsyncTasksToComplete()
+
+            val jsapi = reviewer.jsApi
+
+            // test set tags for note
+            val newTags =
+                JSONArray().apply {
+                    put(" tag4") // leading whitespace
+                    put("tag5 ") // trailing whitespace
+                    put("tag 6 ") // spaces in tag
+                }
+
+            val newTagsList =
+                (0 until newTags.length()).map { index ->
+                    newTags
+                        .getString(index)
+                        .trim()
+                        .replace(" ", "_")
+                        .replace("\u3000", "_")
+                }
+
+            assertThat(
+                getDataFromRequest("setNoteTags", jsapi, jsonObjectOf("noteId" to n.id, "tags" to newTags)),
+                equalTo(formatApiResult(true)),
+            )
+            waitForAsyncTasksToComplete()
+
+            // Reload the note to ensure the tags are updated
+            val updatedNote = col.getNote(n.id)
+            println(updatedNote.tags)
+
+            // Verify the tags are updated
+            assertEquals(newTagsList.size, updatedNote.tags.size)
+            newTagsList.zip(updatedNote.tags).forEach { (newTag, updatedTag) ->
+                assertEquals(newTag, updatedTag)
+            }
+        }
+
     companion object {
         fun jsApiContract(data: String = ""): ByteArray =
             JSONObject()
@@ -450,5 +523,21 @@ class AnkiDroidJsAPITest : RobolectricTest() {
             jsAPI
                 .handleJsApiRequest(methodName, jsApiContract(apiData), false)
                 .decodeToString()
+
+        suspend fun getDataFromRequest(
+            methodName: String,
+            jsAPI: AnkiDroidJsAPI,
+            apiData: JSONObject,
+        ): String =
+            jsAPI
+                .handleJsApiRequest(methodName, jsApiContract(apiData.toString()), false)
+                .decodeToString()
     }
 }
+
+private fun jsonObjectOf(vararg pairs: Pair<String, Any>): JSONObject =
+    JSONObject().apply {
+        for ((key, value) in pairs) {
+            put(key, value)
+        }
+    }

AnkiDroid/src/test/java/com/ichi2/testutils/TestClass.kt

@@ -241,6 +241,13 @@ interface TestClass {
         col.decks.save(deckConfig)
     }
 
+    /** Helper method to update a note */
+    fun Note.update(block: Note.() -> Unit): Note {
+        block(this)
+        col.updateNote(this)
+        return this
+    }
+
     /** Helper method to all cards of a note */
     fun Note.updateCards(update: Card.() -> Unit): Note {
         cards().forEach { it.update(update) }