[JS Addons] list addons from addons directory #10985

krmanik · 2022-04-20T07:39:11Z

Pull Request template

Purpose / Description

This is UI for addons listing in recycler view from addons directory. The list in view will contains details, remove and toggle switch button.
Also addons menu added to side bar but it will be hidden till all the PR merged.
The implementation will be used in next PR when addons listed from network for download and install.

Fixes

Fixes #7959

Approach

dist package.json made empty when package.json loaded from local directory.
Popup window class created to show info related the current clicked addons
Added a class to list addons from directory, the validated AddonModel added to adapter
Each view in list have three buttons
details button - show popup with addons info like name, author, version etc.
remove button - remove the addons from directory
toggle switch - used to enable/disable addons, for enabled addons, the content will be added to reviewer or note editor

How Has This Been Tested?

Tested on emulator and devices. (Test will be added in next PR)

Listing of empty folder
Listing when one addon added manually (currently manually, in next PR download and install will be implemented)
Info popup window test
Toggle switch test
Delete test

demo.mp4

Learning (optional, can help others)

Checklist

Please, go through these checks before submitting the PR.

You have not changed whitespace unnecessarily (it makes diffs hard to read)
You have a descriptive commit message with a short title (first line, max 50 chars).
Your code follows the style of the project (e.g. never omit braces in if statements)
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

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowser.kt

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserAdapter.kt

AnkiDroid/src/main/res/layout/addon_details.xml

AnkiDroid/src/main/res/menu/navigation_drawer.xml

mikehardy

A bunch of unrelated comments :-), I don't see anything really wrong here - a minor structural question, some Kotlin null-typing stuff and some grammar bikeshedding ... Curious for thoughts on all of them

AnkiDroid/src/main/res/values/02-strings.xml

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowser.kt

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserAdapter.kt

mikehardy · 2022-04-24T15:48:19Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserAdapter.kt

+    private fun deleteSelectedAddonPackageDir(addonModel: AddonModel) {
+        // remove the js addon folder
+        val currentAnkiDroidDirectory = CollectionHelper.getCurrentAnkiDroidDirectory(context)
+        val addonsHomeDir = File(currentAnkiDroidDirectory, "addons")
+        val dir = File(addonsHomeDir, addonModel.name)
+
+        val deleted = BackupManager.removeDir(dir)
+


I don't want to over-engineer it, but I feel like having the filesystem code mixed in with the UI code will make it harder to test etc - you have AddonModel, Is there an AddonStorage perhaps, where the "get me the add on directory / get me the list of addons in directory / delete the addon" code could go? Then it would be really easy to have a test just for that stuff

I have created AddonStorage class. It is more cleaner and better implementation. Thanks

mikehardy · 2022-04-24T17:52:37Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserAdapter.kt

+     *
+     * @param addonModel
+     */
+    private fun deleteSelectedAddonPackageDir(addonModel: AddonModel) {


I think delete can go in the new extracted AddOnStorage object now

mikehardy

I think it's really close now - can put more into the storage class and use it by reference, and should probably do a second refactor as a follow-on to have code from previous PRs use the storage class as well and centralize all the directory / file handling (from the download/install/unpack PRs)

krmanik · 2022-04-24T18:12:07Z

I think this is good idea to handle the addons related file/folder related from a centralized class. I will do refactor in next PR. (Added to TODO)

mikehardy · 2022-05-10T15:40:38Z

I'm going to move this to draft just as a strategy to manage the PR review queue, and because I know you are focused on exams right now (as you should be!). Cheers

krmanik · 2022-05-11T04:54:22Z

I will update the PR later.

github-actions · 2022-07-10T05:37:19Z

Hello 👋, this PR has been opened for more than 2 months with no activity on it. If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing! You have 7 days until this gets closed automatically

github-actions · 2022-12-12T11:36:46Z

Hello 👋, this PR has been opened for more than 2 months with no activity on it. If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing! You have 7 days until this gets closed automatically

mikehardy · 2022-12-13T16:11:13Z

Not stale - dormant because of too much work on my end and prioritizing scoped storage but this will all happen. JS addons are the future and this is the infrastructure...

github-actions · 2023-02-16T13:40:53Z

Hello 👋, this PR has been opened for more than 2 months with no activity on it. If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing! You have 7 days until this gets closed automatically

github-actions · 2023-03-05T19:36:26Z

Hello 👋, this PR has had no activity for more than 2 weeks and needs a reply from the author. If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing! You have 7 days until this gets closed automatically

mikehardy · 2023-03-05T20:39:48Z

The JS AddOn series needs to stay open. It is perfect for 2.17 once storage is finally done

krmanik · 2023-03-06T21:49:49Z

The JS AddOn series needs to stay open. It is perfect for 2.17 once storage is finally done

I will start implementing this after scope storage.

lukstbit · 2024-10-04T08:51:19Z

@krmanik If you want I can look into fixing and updating the code in this PR to get it merged. Maybe the other related PR as well.

mikehardy · 2024-10-04T15:58:21Z

Pains me greatly that these aren't merged yet and I feel a lot of responsibility there - not sure how @krmanik feels about it but I would owe you or anyone a debt of gratitude if the work here was finally shepherded in. It's good stuff IMHO and would be a big step forward I think

david-allison · 2024-10-05T06:13:28Z

@BrayanDSO I believe you had the last conversation regarding addons in the forums. Pinging for your understanding & thoughts

BrayanDSO · 2024-10-06T10:27:04Z

Reviewer add-ons won't happen in the desktop version if they aren't 99,99% secure, and Damien apparently doesn't want it even as a per-notetype opt-in setting with a big warning or just stopped replying because he's busy with something else.

To avoid duplicating the bulletproofing job in the mobile versions, the reviewer should ideally be moved to Svelte first.

I do think that there should be a JS API and addons infrastructure as soon as possible so we can take advantage of the work of other developers. If we wait until all of those desktop issues to be solved (probably at least 3 years from now if I'm optimistic with the current development pace), we will lose a lot of work that could be done in the addons ecosystem in that meantime.

There are a lot of developers, including myself, that may have some time and motivation right now, but not in the future. I could have implemented the whole infrastructure when I created the forums post, but I lost two weeks just in discussion, and stopped getting replied. Now I don't have time for it, nor I want to do it anymore in the future.

So I strongly suggest to continue the JS addons work here in AnkiDroid. To avoid issues in the future, like when Anki implemented a different TTS syntax, I suggest consulting Damien and making him compromise with the API, with whatever is saved in the collection, and with the way that addons are distributed.
That way, things won't break if he wants to distribute things in GitHub with zip files instead of npm with tar.gz, or save the addons list ordered by creation date instead of ID (just an invented example, idk what is planned).

lukstbit · 2024-10-13T07:20:18Z

Ok, I'll be implementing the code in this PR for now.

lukstbit · 2024-10-17T09:42:15Z

I've made changes to the PR to fix the conflicts and update the UI. The feature sits behind a dev setting.
I've left the strings hardcoded, there's no need to ask for translations if this isn't near release.

krmanik · 2024-10-18T02:44:53Z

Thanks @lukstbit for continuing this PR. This is good features we can support for AnkiDroid. I still busy at the moment but willing to review if I get chance.

david-allison

I think we all want this to move forward. Let's do it

Given the nature of this feature, I'd like to see a little documentation of folder structures on the disk, and how profiles will interact with this feature when they're added.

In Anki Desktop, addons are global across profiles. This change doesn't allow for this.

I'd like to think about deep links to addons, and how/whether we'd want to accomplish this

david-allison · 2024-12-10T10:53:57Z

AnkiDroid/src/main/AndroidManifest.xml

@@ -463,6 +463,10 @@
            android:theme="@style/Theme.AppCompat.NoActionBar"
            android:configChanges="keyboardHidden|screenSize" />

+        <activity android:name=".jsaddons.AddonsBrowserActivity"


Don't use jsaddons, we can't change the package name later, and this ties us to a technology

david-allison · 2024-12-10T10:54:39Z

AnkiDroid/src/main/AndroidManifest.xml

@@ -463,6 +463,10 @@
            android:theme="@style/Theme.AppCompat.NoActionBar"
            android:configChanges="keyboardHidden|screenSize" />

+        <activity android:name=".jsaddons.AddonsBrowserActivity"
+            android:parentActivityName=".DeckPicker"


Is this correct? I suspect we're starting this from Preferences in the initial release

david-allison · 2024-12-10T10:55:55Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonData.kt

+        // package.json in tgz file does not contains dist but it is available when the file loaded
+        // from network, the dist contains .tgz url which will be used to download the file


Move to KDoc for the class, or move to a constructor which can handle fromNetwork/fromFile

david-allison · 2024-12-10T10:56:54Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonDetailsDialog.kt

+
+    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+        val addonModel =
+            BundleCompat.getParcelable(requireArguments(), KEY_ADDON_MODEL, AddonModel::class.java)


can this be extracted to a val

david-allison · 2024-12-10T10:57:07Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonDetailsDialog.kt

+    companion object {
+        private const val KEY_ADDON_MODEL = "key_addon_model"
+
+        fun newInstance(addonModel: AddonModel): AddonDetailsDialog = AddonDetailsDialog().apply {


@CheckResult

david-allison · 2024-12-10T10:59:43Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonStorage.kt

+     * @return some-addon dir e.g. AnkiDroid/addons/some-addon/
+     */
+    fun getSelectedAddonDir(addonName: String): File {
+        return File(addonsHomeDir, addonName)


⚠️ Path traversal vulnerability

david-allison · 2024-12-10T11:00:21Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonStorage.kt

+     */
+    fun deleteSelectedAddonPackageDir(addonName: String): Boolean {
+        val dir = getSelectedAddonDir(addonName)
+        return BackupManager.removeDir(dir)


use a better named API

david-allison · 2024-12-10T11:01:01Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserActivity.kt

+ */
+// TODO ===== EXTRACT RELATED STRINGS FOR TRANSLATION BEFORE RELEASE =====
+class AddonsBrowserActivity : AnkiActivity() {
+    private val addonsAdapter by lazy {


Can we move to a ViewModel here?

david-allison · 2024-12-10T11:01:34Z

AnkiDroid/src/main/java/com/ichi2/anki/jsaddons/AddonsBrowserAdapter.kt

+        return oldItem.modelRef.name == newItem.modelRef.name &&
+            oldItem.modelRef.addonType == newItem.modelRef.addonType &&
+            oldItem.modelRef.addonTitle == newItem.modelRef.addonTitle &&
+            oldItem.modelRef.author["name"] == oldItem.modelRef.author["name"] &&
+            oldItem.modelRef.author["url"] == oldItem.modelRef.author["url"] &&
+            oldItem.modelRef.version == newItem.modelRef.version &&
+            oldItem.modelRef.ankidroidJsApi == newItem.modelRef.ankidroidJsApi &&
+            oldItem.modelRef.description == newItem.modelRef.description &&
+            oldItem.modelRef.homepage == newItem.modelRef.homepage &&
+            oldItem.modelRef.license == newItem.modelRef.license &&
+            oldItem.modelRef.dist.tarball == newItem.modelRef.dist.tarball


move to the class

david-allison · 2024-12-10T11:01:55Z

AnkiDroid/src/main/res/layout/activity_addons_browser.xml

+                android:src="@drawable/ic_extension"
+                app:tint="@color/material_blue_grey_100" />
+
+            <TextView


FIxedTextVIew

mikehardy · 2024-12-10T20:36:23Z

Given the nature of this feature, I'd like to see a little documentation of folder structures on the disk, and how profiles will interact with this feature when they're added.

In Anki Desktop, addons are global across profiles. This change doesn't allow for this.

Interesting. With per-profile add-ons you can have the same add-on for everyone but you can also have "AnkiGamify" and "Ank-2-button" (I'm making those up) just for your toddler's profile as they're learning phonics without it affecting yours.

That is, per-profile is the most powerful style IMHO.

If it was one or the other, I'd say per-profile.
If global was important, then I'd say both, and it is similar to when you install software and it asks "do you want to install this for all users of the system or just yourself?"

Deep links? Perhaps we should just get it in first 😆

krmanik · 2024-12-11T09:44:25Z

@david-allison @mikehardy
Thanks for the review and comments, I will start updating this features in coming few days.

Contains the initial code to fetch and parse addons and also the basic UI to display the addons.

krmanik · 2024-12-16T08:52:38Z

Android Studio interface is changed, rebased the code, now add changes to the code.

krmanik · 2024-12-18T10:44:42Z

@david-allison Thanks for the changes, I have added it to local codebase. I have started implementing the suggested changes, will take some days to implement the features.

krmanik force-pushed the list-addons-from-dir branch from 00ebeac to 8cf509f Compare April 20, 2022 07:55

david-allison requested changes Apr 20, 2022

View reviewed changes

krmanik added the Needs Review label Apr 23, 2022

mikehardy reviewed Apr 24, 2022

View reviewed changes

AnkiDroid/src/main/res/layout/addon_details.xml Outdated Show resolved Hide resolved

mikehardy reviewed Apr 24, 2022

View reviewed changes

AnkiDroid/src/main/res/menu/navigation_drawer.xml Outdated Show resolved Hide resolved

mikehardy requested changes Apr 24, 2022

View reviewed changes

mikehardy reviewed Apr 24, 2022

View reviewed changes

mikehardy added the Needs Author Reply Waiting for a reply from the original author label Apr 24, 2022

krmanik added the Blocked by dependency Currently blocked by some other dependent / related change label Apr 25, 2022

mikehardy marked this pull request as draft May 10, 2022 15:40

github-actions bot added the Stale label Jul 10, 2022

krmanik removed the Stale label Jul 10, 2022

github-actions bot added the Stale label Dec 12, 2022

github-actions bot removed the Stale label Dec 18, 2022

github-actions bot added the Stale label Feb 16, 2023

david-allison removed the Stale label Feb 16, 2023

github-actions bot added the Stale label Mar 5, 2023

mikehardy added Keep Open avoids the stale bot and removed Stale labels Mar 5, 2023

github-actions bot added the Has Conflicts label Dec 30, 2023

lukstbit self-assigned this Oct 13, 2024

lukstbit force-pushed the list-addons-from-dir branch 3 times, most recently from 6fcb827 to b4aebcc Compare October 17, 2024 09:13

lukstbit marked this pull request as ready for review October 17, 2024 09:33

lukstbit added Priority-Low and removed Needs Author Reply Waiting for a reply from the original author Blocked by dependency Currently blocked by some other dependent / related change Has Conflicts labels Oct 17, 2024

lukstbit added this to the 2.20 Release milestone Oct 17, 2024

github-actions bot added the Has Conflicts label Dec 3, 2024

mikehardy modified the milestones: 2.20 Release, 2.21 release Dec 4, 2024

david-allison requested changes Dec 10, 2024

View reviewed changes

Add initial code for application addons

61feaa0

Contains the initial code to fetch and parse addons and also the basic UI to display the addons.

krmanik force-pushed the list-addons-from-dir branch from b4aebcc to 61feaa0 Compare December 16, 2024 08:49

This comment was marked as resolved.

Sign in to view

		// package.json in tgz file does not contains dist but it is available when the file loaded
		// from network, the dist contains .tgz url which will be used to download the file

[JS Addons] list addons from addons directory #10985

Are you sure you want to change the base?

[JS Addons] list addons from addons directory #10985

Conversation

krmanik commented Apr 20, 2022 • edited Loading

Pull Request template

Purpose / Description

Fixes

Approach

How Has This Been Tested?

Learning (optional, can help others)

Checklist

mikehardy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikehardy left a comment

Choose a reason for hiding this comment

krmanik commented Apr 24, 2022

mikehardy commented May 10, 2022

krmanik commented May 11, 2022

github-actions bot commented Jul 10, 2022

github-actions bot commented Dec 12, 2022

mikehardy commented Dec 13, 2022

github-actions bot commented Feb 16, 2023

github-actions bot commented Mar 5, 2023

mikehardy commented Mar 5, 2023

krmanik commented Mar 6, 2023

lukstbit commented Oct 4, 2024

mikehardy commented Oct 4, 2024

david-allison commented Oct 5, 2024

BrayanDSO commented Oct 6, 2024

lukstbit commented Oct 13, 2024

lukstbit commented Oct 17, 2024

krmanik commented Oct 18, 2024

david-allison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

david-allison Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikehardy commented Dec 10, 2024

krmanik commented Dec 11, 2024

krmanik commented Dec 16, 2024

This comment was marked as resolved.

krmanik commented Dec 18, 2024

krmanik commented Apr 20, 2022 •

edited

Loading

david-allison Dec 10, 2024 •

edited

Loading