JS function to setTags and getTags

[Haz3-jolt]

Purpose / Description

Adds two JS API functions [set/replace]NoteTags and getTagsFromNote which act similar to PUT and GET from a REST API

Fixes

• Fixes FR: JS API function to remove a specific tag #17716

Approach

Adds two methods to allow the caller to get Tags and update/set tags.

How Has This Been Tested?

Added two unit tests both verified and passing.

Checklist

Please, go through these checks before submitting the PR.

• You have a descriptive commit message with a short title (first line, max 50 chars).
• You have commented your code, particularly in hard-to-understand areas
• You have performed a self-review of your own code
• UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
• UI Changes: You have tested your change using the Google Accessibility Scanner

[Haz3-jolt]

@david-allison Do you think we should deprecate addTagToNote? Also [set/replace]NoteTags triggers lint failure

[mikehardy]

Do you think we should deprecate addTagToNote

Yes - haven't done our deprecation strategy in a while, not sure exactly how. Is it documented anywhere? May not be, but we should be able to mark something as deprecated and have it emit a warning in console or similar

[Haz3-jolt]

Do you think we should deprecate addTagToNote

Yes - haven't done our deprecation strategy in a while, not sure exactly how. Is it documented anywhere? May not be, but we should be able to mark something as deprecated and have it emit a warning in console or similar

From some searching, the most I can find is the deprecated decorator on Kotlin side, I dunno how we would approach on js. Is there official documentation for JS api? if not we can just have a comment?

[Haz3-jolt]

Thanks for bringing this up. Here's my perspective...

Hey! Can you you elaborate further?

[mikehardy]

@Mizokuiam please stop. You are wasting everyone's time.

[Haz3-jolt]

@Mizokuiam please stop. You are wasting everyone's time.

Spammer? :(

[mikehardy]

@Haz3-jolt I assume so. Negative value contributions, banned at organization level by me now.

[Haz3-jolt]

@mikehardy How is this for a deprecation warning? Since people mainly interact on Js side

Subject: [PATCH] JS function to setTags and getTags
---
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 6d3d270e9067fbad4797f25b0f3060adc60e41cd)
+++ b/AnkiDroid/src/main/assets/scripts/js-api.js	(date 1736620228061)
@@ -121,6 +121,7 @@
 Object.keys(jsApiList).forEach(method => {
     if (method === "ankiAddTagToNote") {
         AnkiDroidJS.prototype[method] = async function (noteId, tag) {
+            console.warn("ankiAddTagToNote is deprecated. Use ankiSetNoteTags instead.");
             const endpoint = jsApiList[method];
             const data = JSON.stringify({ noteId, tag });
             return await this.handleRequest(endpoint, data);

[mikehardy]

@Haz3-jolt I believe that deprecation in javascript console is the correctly location for it

[Haz3-jolt]

@Haz3-jolt I believe that deprecation in javascript console is the correctly location for it

Amend the current commit or separate commit?

[mikehardy]

amend I think, the deprecation of the old is part of adding the new to me, it's all one piece

[Haz3-jolt]

amend I think, the deprecation of the old is part of adding the new to me, it's all one piece

Cool!

[david-allison]

Should be the last one!

[Haz3-jolt]

@david-allison Any other changes? Ive double checked that both functions are working.

[Haz3-jolt]

@david-allison although I don't think I can do it rn, any idea on how a integration test for the setTags can be done? Perhaps setting a note with the Js function in the note, and using espresso to find the button or something?

[Haz3-jolt]

@david-allison should I re base and force push to check if any conflicts are there? its been a while since this PR has been open

[Haz3-jolt]

@david-allison should I re base and force push to check if any conflicts are there? its been a while since this PR has been open

Okay so looks like no conflicts

[david-allison]

The PR will display conflicts if there are any (and it'll have Has Conflicts )

If it's sat for a while, a rebase saves a little time on our end

[david-allison]

Cheers!

[lukstbit]

Thanks, LGTM. Please squash the two commits into one and then this can be merged.

[Haz3-jolt]

Thanks, LGTM. Please squash the two commits into one and then this can be merged.

Iirc @mikehardy and @david-allison agreed seprate commits might be better because it's adding the calls and unit tests for it in a seperate commit. But yeah I'm fine with squash merge as well.