Skip to content

Latest commit

 

History

History
537 lines (422 loc) · 23.3 KB

TODO.md

File metadata and controls

537 lines (422 loc) · 23.3 KB

todo.md

this is my own scratchpad for keeping track of things. it gets truncated frequently.

see CHANGELOG.md for a more formal list of changes by release

done

todo

todo bucket (no particular order)

  • gui, when installing an addon from file, allow the following options
    • test-only?
    • unpin-pinned?
    • overwrite-ignored?

bug: clear button isn't clearing search

bug: select github + wowi search for 'alto' - 3 results, 2 github, 1 wowi deselect 'github' - no results select gitlab (so wowi and gitlab are selected) - wowi result

bug: search, next and previous buttons should take me to top of search results

  • patch tooltip, support multiple game versions

  • flathub, remove '(Flathub)' from .desktop file

  • remove support for parsing templated .toc keyvals: '# ## Key: Value'

  • gui, 'set-icon' is taking a long time to do it's thing.

  • nfo, replace the URL as the group-id with something random

  • github, catalogue, no download counts.

  • github, catalogue, add any tags if they exist

  • github, catalogue, add 'created date'

  • no errors displayed when installing from addon detail page

  • generate a .flatpakref file as an asset for release.

  • possible bug? installing combuctor 8.1.1 from file matches against the catalogue (good), then installing 9.1.3 file loses the match.

    • mutual dependencies information is mostly blank
    • I think this was fixed in 6.1.0 but check anyway
      • "ignored addons in the addon detail pane now display mutual dependencies (if any)."

  • catalogue/search results, if there are addons from the same host (github) with the same name (tukui), disambiguate them

    • 'tukui' in the search results shouldn't mean 'ogri-la/tukui' if 'tukui.org/tukui' is also available
      • which it isn't, but that's not the point.

  • metrics, add a 'catalogue is N days old'

    • add an 'oldest' addon (days since created date)?
    • add a 'most stale' addon (days since last update)?
    • pretty useless ;)

  • wowinterface, catalogue, revisit v4 api

  • gui, try replacing the auto fit columns with something like this:

  • checkbox column for selecting addon rows

    • might be nicer than ctrl-click

  • expand-summary, can the game track wrangling logic be made generic rather than per-host?

    • this would tie in with returning all releases from a host
    • it would insulate host logic from selected game tracks and game track strictness
    • it would handle pinned logic as well
      • currently handled in catalogue

  • addon detail, 'releases' widget, including all possible releases to download and install

    • add an 'WoW' column to know which game-track/interface
    • disable releases excluded by selected game-track/strictness setting

  • alpha/beta opt-in

    • user can opt to install alpha/beta releases per-addon
    • make it a simple preference

  • manually select the primary addon in a group of addons to prevent synthetic titles

  • http, add with-backoff support to download-file

    • just had a wowinterface addon download timeout

  • gui, right-click column header and show columns to disable

    • right now it's registering as a regular click

  • bug, trade skill master string-converter changed directory names between 2.0.7 and 2.1.0

    • see also Combuctor 9.1.3 vs Combuctor 8.1.1 with 'BagBrother' in old addons
      • BagBrother was removed but also got 00:35:37.982 [info] [BagBrother] downloading 'Combuctor' version '8.1.1' 00:35:38.017 [info] [BagBrother] removing "Combuctor" version "9.1.3" 00:35:38.017 [error] [BagBrother] addon not removed, path is not a directory: /home/torkus/old-addons/BagBrother 00:35:38.021 [info] [BagBrother] installing "Combuctor" version "8.1.1" 00:35:38.042 [warn] [BagBrother] failed to find any .toc files: /home/torkus/old-addons/Sound
    • this can be replicated by: install combuctor 9.1.3 find 'combuctor' and install from wowi (8.1.1) get weird orphaned BagBrother addon
    • 2022-06-27, returned to bucket
      • I don't have a solution for this, good or bad.

  • bug, BigWigs_Classic from Github cannot be installed when 'retail strict' is set

    • it can be installed from wowi fine
      • perhaps check the addon name isn't prefixed with '_Classic' ?
        • how many would be affected by this?

  • ux, offer to clean up .nfo files when removing an addon directory

    • not just .nfo files, but .zip files matching a pattern too

  • zip, switch to apache commons compress for decompressing

  • user catalogue, refreshing may guarantee exceeding github limit.

    • if we know this, add a warning? refuse? stop?

  • gui, bug, sorting isn't preserved between addon dir switches

    • for example, sorting by 'size' in one addon dir, then switching to another will see random sorting

  • git, add support for cloning repositories

    • this is to get around addon repositories not uploading 'releases' when tagging
    • switch between branches
    • switch between tags
    • could branches/tags be considered 'releases'?
      • and what if we switch to a different branch and the folder structure changes?
        • perhaps what we need is a separate place to clone these, and then copy them into the addons directory
    • only available if local git available
    • how to deal with local changes?
      • have a policy of wiping out changes. or stashing changes.
    • how to deal with repository being a mutual dependency?
      • like, some other addon tries to overwrite it with their own version?
        • we have ignore rules and pin rules already.
          • can pinned addons be replaced? I've forgotten.
    • how about a shallow clone?
      • just the files are cloned to a directory

  • github, install addon from the auto-generated .zip files

    • it looks like auctionator has disabled/deleted their 'releases' and put a link to their curseforge page up
    • we'll have to do some directory name munging

  • grouping addons

    • I think the tree-table-view allows us to 'group' things now ...
      • it's 'flat' at the moment, but it could be grouped by 'ignored', 'pinned', 'updates available'
        • ignored are collapsed
      • custom/named groups!

  • wowinterface, fetch addon data from secondary source

    • augment what is currently implemented with my own source
      • failure to fetch this other data shouldn't prevent wowi updates from working normally
    • this source is hosted on github as static content, updated daily.

  • github authentication

    • so user doesn't get capped
      • or have to wrangle GITHUB_AUTH tokens

  • bug, addon detail, highlighted installed version is causing rows to be highlighted in the raw data column?

    • looks like a javafx problem, no idea how to fix
    • try reducing to smallest possible reproduction

  • create a parser for that shit markup that is preventing reconcilation

  • finer grained control over grouping of addons

    • like what?
    • like a grouped addon or grouping lists of addons?

catalogue v3 / capture more addon data

  • 'website'
    • 'x-website'/'x-url' in toc
    • add 'website' to addon-detail pane next to 'browse local files' and addon host
      • depends on capturing x-website
    • add a 'website' column to installed-addons
  • 'author'
    • add an 'author' column to installed-addons
    • add to addon-detail
    • search other addons by author
  • 'releases'
    • capture full set of releases, including hashes if they exist

  • investigate better popularity metric than 'downloads'

    • if we make an effort to scrape everyday, we can generate this popularity graph ourselves

  • github, bug, multi-toc addons are getting a warning when strict? is true and the game track is changed

  • bug, test [:core :clear-addon-ignore-flag--implicit-ignore] is printing an error when game-track-list definitely exists

    • what is removing it?

  • default to keeping last three zip files by default

  • icons for browse fs, addon sources

  • preference for 'fat rows'

    • increase the padding for each row a bit

  • "developer warnings"

    • a preference that bumps certain debug messages to warnings and errors for developers
      • like if a release.json is missing assets
      • or the toc file is mangled
        • or is missing useful information
      • or the zip file is badly formed
    • stuff a regular user should gloss over but a dev might find useful
    • 2023-06: isn't just debug-level output?
      • ... we don't have debug output available in the gui. interesting.

  • a more permanent store than just cached files

    • I want to store release data permanently
      • multiple pages
      • release.json
      • why can't we do this using the nfo data?

  • github, can we support addons that have no detectable game tracks, no toc files, no release.json, nothing but downloadable assets?

  • github, can we support addons that are splitting their game track releases over separate releases?

  • toc, add support for 'Interface-Retail', 'Interface-Classic', 'Interface-BCC'

  • ux, complex export pane

    • choose format
      • json, csv, edn
    • choose to keep ignored or not
    • choose fields to keep
    • warning if not enough fields for import

  • bug, gui, 'updated' column is using dummy date in certain cases

    • I thought I fixed this?

  • gitlab, add optional API authentication like github

  • bug, stacktrace on double refresh

  • gui, toggleable highlighers as a menuitem

    • highlight unmatched
    • highlight updates
    • highlight mismatched game track
    • highlight mismatched update host
      • installing addon from a different host
    • touch of colour against each menuitem would serve as a legend
    • 2021-10: not sure about this one anymore
      • returned to the bucket.

  • gui 'wow' column is inconsistent

    • github returns new interface-version values with the update data, wowi stores this in it's fileList file.
    • wowi has UICompatibility in v3 of it's fileList and gameVersion in v4 of it's fileList, but nothing when fetching an addon's updates.
      • I'd need to combine the catalogue data (which could be a week old already) with the update data.
    • for curseforge, it's pulling it's value from :gameVersion, which may be empty
      • in which case it pulls it's value from the toc file, which may be different from the selected game track
    • the value in the gui should reflect the installed version if no update pending, else the interface version of the pending update.
    • returning to bucket 2021-10
      • it works well enough for now

  • centralised download location on filesystem

    • The Undermine Journal is large (75MB) and it sucks to download it again and again from different dirs
      • perhaps tie this in with a rename of the downloaded zip file so unambiguous reverse lookups can be done:
        • source--sourceid--version.zip => curseforge--543210--1-9-26.zip

  • centralised addon directory db

    • install an addon, then 'deactivate' it
      • essentially uninstalls the addon but it's still available at the tick of a box

  • gui, "fat rows"

    • add option to switch to fatter rows with more styled data
      • clicking on the row expands it from small to medium
      • clicking 'more' (or whatever) takes to addon detail page
    • perhaps coincide with catalogue v3 with more addon details

  • import/export, bring up the split logging pane during operation so any problems can be seen

    • or update the tab title to reflect the number of warnings/errors
      • otherwise there is zero feedback

  • export/import addons to/from github

    • I have a github account, I'd like to push/pull addons to it
      • use a gist?
      • dedicated repo?
    • other targets to publish to?
      • always keep the base import/export to a file
      • ftp? s3 bucket? ssh? gitlab?
    • feels a bit like scope creep to me
      • it would be nice and convenient, but a lot of work to build and maintain

  • http, clear non-catalogue cache after session

    • it seems reasonable that stopping and starting the app will have it re-fetch addon summaries.
    • maybe add as a preference

  • deleting an addon should also remove any of it's zip files

    • this sounds like an opt-in preference

  • http, share a pool of connections between jobs

  • preferences, "update all addons automatically"

    • update README features
    • punted back to bucket 2021-06-02

  • logging, app level 'help'

    • messages to the user that are not informational, or debug or warnings or errors, but simple helpful messages
      • 'help' messages strike me now as being 'info' level
      • perhaps attach 'detail' metadata to info messages that elaborate on the message and what can be done about it
    • it should stand out from the other messages, look friendly, etc
      • going with the further 'detail' metadata idea, adding an info icon would make it stand out

  • classic addon dir detection

    • also check for
      • 'classic' 'classic_beta' 'classic_ptr'
    • is there an official source on these somewhere?

  • bug, I should be able to re-install a pinned addon if the pinned release is available, but I'm getting an error

    • "refusing to install addon that will overwrite a pinned addon"
    • this is actually a bit more involved than it first looks. shifting to it's own ticket

  • nfo, spend some time futzing with nfo files on disk and how they can break the UI

    • I've managed to get some weird error messages by changing 'source' to an int, to a catalogue that doesn't exist, etc

  • test, can gui-diff and main/test be pushed back into the testing namespace and elided from release somehow?

  • add checksum checks after downloading

    • curseforge have an md5 that can be used
      • unfortunately no checksum in api results
      • they do have a 'fileLength' and a 'fingerprint'
        • fingerprint is 9 digits and all decimal, so not a hex digest
    • wowinterface checksum is hidden behind a javascript tabber but still available
      • wowinterface do have a md5sum in results! score

  • EOL planning

    • I'm not going away and neither is strongbox, but! should I or my free time disappear will strongbox continue being useful?
      • what can I do to ensure it is the most useful if I just give up on it tomorrow?
        • catalogues have been pushed into user config, so they can be swapped out if necessary
          • more can be done around this to make catalogue generation more accessible and safe
      • what can't I control?
        • addon hosts
          • our interface with them is their API or in wowi's case, their API and website

  • reconciliation, add dirname support

    • not sure which hosts support these

  • reconciliation, rename 'reinstall all' to 'reconcile'

    • steal from the best
    • make the reconcile automatic
      • if a nfo file isn't found
    • remove the 'first time instructions' from the readme
      • it should just fucking do it

  • add a 'tabula rasa' option that wipes everything

    • cache, catalog, config, downloaded zip files

  • no-lib

    • user can opt to prefer no-lib versions
      • what if addon only ever released one no-lib then decided not to use them again?
        • addon would be stuck on a very old version
      • addon releases would then need to be grouped into lib/no-lib

  • update check

    • ignore pre-releases
      • are these like no-lib?

  • keep a list of previously installed addons

    • eh. tie it in with downloading more release information
    • defer until after job queue
      • very large downloads are possible. just see curseforge dbm

  • import and export addons using addon urls

  • cli, exports

  • import, export, capture 'pinned' information

    • we can now import addons at a specific version
      • when importing a pinned addon, should we keep the pin?
      • or drop the pin it and display updates?
    • we can now export addons at specific versions
      • I think we already have this though ... called :version

  • import, skip importing an addon if addon already exists in addon dir

  • import, why can't an export record be matched to the catalogue and then installed that way?

    • no need for padding and dummy dirnames then
    • installing normally would also include the mutual dependency handling

  • github, importing an exported addon list with a github addon won't see that addon installed

    • unless that addon is present in the user catalogue
      • which in a fresh install where a list of addons are being restored is unlikely...
    • this is interesting actually. the exported addon list has become a mini-catalogue
      • some addons require the larger catalogue to resolve
      • github addons are resolved and installed by a different means...

  • github, gitlab, are we paginating release calls?

    • no we're not.
    • unless authenticated somehow, I wouldn't bother.

  • github, like gitlab, use presence of multiple toc files to determine game track support

  • gui, bug, changing sort order during refresh doesn't reflect which addon is being updated

    • I think changing column ordering and moving columns should be disabled while updates happen
      • just freeze or disable them or something.

  • internationalisation?

    • Akitools has no english description but it does have a "Notes-zhCN" in the toc file that could be used
    • wowman was mentioned on a french forum the other day ..

  • gui, get log window scrolling in other direction

import/export

  • export to markdown
    • I think I'd like a simple list like:
    • of course, this would be a different type of export than the one used for import
      • although ... I could possibly parse the list ... and nah.
    • clostache?

search

  • search, order by date only orders the current page of results

cli

  • cli, update specific addon
  • cli, install specific addon
  • cli, colours!
  • cli, replace with a repl
    • lein --cli gives you access to the code directly

unified UI

this is still an interesting idea

  • remove log split
  • remove tabs
  • gui, both panes, filter by categories
  • gui, group results
    • installed
    • updates
    • category ...

wontfix

  • a user catalogue tab pane

    • context menu
      • refresh selected
      • remove selected
    • button bar
      • refresh all button
    • menu
      • 'refresh all' switches to user catalogue pane
    • 2023-06: the search tab gained a 'star' button that filters to this now essentially
      • and periodic user catalogue refreshes are now an opt-in feature if the user thinks it's a big deal

  • github, preference to sync stars with github repo, if authenticated

    • stars have come to mean 'favourited' and under the hood it adds the addon to the user-catalogue

  • search, group results

    • group by downloads/age/category?
      • it would finally be the best use for category data
    • 2023-06: categories became tags and tags became more useful. 'age' field went away.
      • grouping could still happen but the best would be grouping by host and we have filtering by host now so, ehh.

  • importing addons, skip db lookup for addon urls that don't need it

    • if we can 'expand it' then we can download it and install it.
      • yes, and the explicit url should be respected.
        • if the user imported from wowi or curseforge, that host should be used for installation
          • after installation, we can match it against the current catalogue and go from there.
            • because the addon is added to the user catalogue, it will always be available, there will always be a match.
              • but not initially.
                • no, but we have the source and source-id (or url) to match against.
        • we need to find a download url
          • wowi needs source-id
          • curse needs a source-id which comes from the db
          • tukui needs source-id and a name if the id negative
            • name could come from the url string to import
    • I think tukui, wowi can, github obs, curseforge could not
    • I'm moving this to 'wontfix'
      • it's possible for wowi and tukui, not curse
      • the error message is clear (can't find in catalogue)

  • logs, persistent addon events

    • installed, updated, pin, ignore events
    • like ... stored in addon history?
      • possible, but why? to please data freaks like me?
    • going to need a better reason than 'just cos' for this

  • add a 'Delete all' option to cache menu

    • we don't really want legitimate nfo files to be accidentally deleted

  • investigate .csv as a human-readable but more compact representation

    • might be able to save a MB on extraneous syntax
    • might be able to speed up parsing and loading
    • depends on profile task
      • update: profiling happened, it's not the json loading that is slow it was many other things.
      • reading the file and parsing the json is actually very quick, validation is slower but necessary
      • json is just more flexible all around than csv.

  • windows support

    • windows is just the worst, most awful dystopian software I've ever seen and it hurts my soul every time I try to use it
    • I just plain hate it, it epitomises the very opposite of what I stand for and I refuse to work on it ever again

  • .rar/.tar.gz addons

  • cli, interactive interface when no specific action specified

    • you have N addons installed. what do you want to do? (list, update, update-all, delete) etc
    • this is a huge amount of hassle