September 2020 Release

[toasted-nutbread]

I am going to start creating issues when releases are nearly ready, to serve as a heads-up, use as a forum for testing notes, release notes, etc. The release frequency is roughly monthly, so I'm going to title the issues by month, but if the version number rolls over to the next month due to any delays, that's fine.

The features for this next release should be mostly ready, I'll be doing some final testing over the next few days to verify it's good to go.

@FooSoft Did you ever get any info about the Firefox release issues, as per #828 (comment)? This release doesn't have #830 implemented yet, but I can work towards that for the next major release if necessary. I'm hoping I don't have to go and implement an eval-less handlebars replacement, but I won't be surprised if it comes to that.

[toasted-nutbread]

Changes since 20.8.24.1

Features

• Added support for more flexible scanning inputs, including mouse, touch, pen, and keyboard inputs. ([feature request] Add a shortcut to see the kanji dictionary entry for the kanji you are pointing to. #79; Mouse inputs #783, Modifier key refactor #784, Fix modifier keys not being spread #785, Scanning input generalization #789, Fix scanning inputs upgrade using the wrong format #805, Input type filters #806, Fix adding new scanning inputs not working #808, Add support for pointer event input detection #810, Clear state when refreshing enabled state #811, Text scanner refactoring #812, Text scanner cause update #813, Use a grid layout for scanning inputs #814, More scanning options #815, Update TextScanner.setEnabled to not reset state if unnecessary #817, Fix location of _enabled assignment #818, Pointer events support #819, Add workaround for Firefox bug not detecting pen input type correctly #820, Add workaround for Firefox bug not detecting pen input type correctly #821, Add scan dictionary type filters #822, Settings upgrade and schema fixes #823, Mouse button modifier update #824, Scanning mouse button fixes #866, Fix data-setting attributes not being updated on index change #872)
• Added support for {clipboard-image} Anki marker. ([Feature request] Importing the content of the clipboard into a field on card creation #776; Anki note clipboard marker #780)
• Added support for {clipboard-text} Anki marker. ([Feature request] Importing text saved in the clipboard into a field, on card creation #862; Add clipboard-text Anki field #863)
• Added support for using a native window for the standard scanning popup. ([Question / Feature Request?] Native window for mouseover text #664; Add api.isTabSearchPopup #763, Popup window #773, Fix displayDetails not being properly null checked #865)
• Added support for a "delay hide" option. (Scan Delay should not affect how fast popup is automatically hidden #742; Delay hide option #774, Add missing null check #836)
• Added support for preventing the default behavior of the middle mouse button on different pages. (If "Middle mouse button scans" is enabled, disable auto scroll #781; Add middle mouse prevention option #868)
• Added support for controlling scanning and scrolling from touch events. (Is it possible to disable pop ups on mobile when dragging? #870; Add scan on touch move and prevent touch scroll options #871)
• Enabled sandboxing on Chrome browsers for Anki template generation, which should improve extension security. (Handlebars sandbox #612, Remove border/margin/padding/pointerEvents from template renderer frame #841)

Fixes

• Fixed an issue preventing touch input from being enabled. (Yomichan stopped working on kiwi browser (mobile) after latest update (v20.8.24.0) #775; Fix touch input always being disabled #772)
• Fixed an issue causing Yomichan to throw an error when a custom logo is displayed on the Chrome's new tab page. (Handle error if _waitForFrontendReady fails when creating a popup proxy #760)
• Fixed error log messages not including the correct URL. (Fix log context not being in the correct format #761)
• Fixed an issue in Chrome where opening the settings page would cause a long-running database integrity check that could block scanning in other tabs. (Popup preview slow to appear #302; Dictionary controller refactor #831)
• Fixed an issue where importing certain settings backup files could fail. (Fix settings sanitization resulting in invalid data for the schema #843)
• Fixed the "Enable scanning on search page" setting not being obeyed correctly. (Fix page type never being detected as search page correctly #867)

Internal Changes

• Improved internal handling of profile conditions. (Json schema profile conditions #758, Profile conditions cleanup #768, Remove old conditions.js references #769, Profile conditions fixes and improvements #782, Move assignment of the operating system property #786)
• Refactored dictionary operations on the settings page. (Settings dictionary import refactor #759, Dictionary delete improvements #844)
• Refactored Anki template system. (Defer assignment of marker when rendering templates #762, Fix template renderer sandbox compatibility #770, Anki API refactor #790, Anki screenshot refactor #791, Use common function for data URL mediatype/data extraction #792, Anki media injection move #793, Update the AnkiController class to use an instance of AnkiConnect directly #795, Generalize AnkiNoteBuilder to not use audioSystem directly #796, Anki note media injection move #801, Anki note api functions #802, Add api.injectAnkiNoteMedia #803, Use Anki classes directly in Display #804, Remove unused handlebars script #833, Fix typeof comparing against a string #849)
• Fixed some internal messaging issues. (Fix cross frame comm issues #765)
• Refactored code in preparation of support for Manifest v3. (Create abstraction class for parsing DOM #798, Profile controller refactor #825, Dictionary controller refactor #831, Cleanup unused utils #832, Remove window from performance object access #845)
• Refactored and simplified audio system classes. (AudioUriBuilder simplification #799, Move TextToSpeechAudio to a separate file #800, Audio system refactor #858)
• Refactored options upgrade process. (OptionsUtil refactor / options default values #807, Fix default options missing profiles #829, Fix _addFieldTemplatesBeforeEnd not being await'd #850, Delete old scanning options during update #851, Add tests for options updating #852)
• Added and organized tests and validation. (Add test-manifest to continuous integration tests #827, Dev/test script organization #846, Add lint test to validate <script>s in HTML files #848, Add tests for options updating #852, Add web-ext dev dependency #861)
• Added documentation. (Add a document listing various browser bugs that have affected Yomichan #835, Add info about the Firefox pen pointer event issues #837)
• Added icons in preparation for future changes to the settings page. (Add icons #860)
• Build system and build target updates. (Build system updates #839, Browser manifest updates #840)
• General refactoring and organization. (Popup proxy improvements #764, Refactor RequestBuilder slightly #767, Text scanner refactor #771, Fix error handling for screenshot captures #777, Add api.clipboardGetImage #778, Update the functions for upgrading anki templates to be more reusable #779, Refactor how TextScanner's public search() function is used #787, Text scanner fixes and refactoring #788, Settings controller file renaming #794, Settings scanning refactor #809, Database change event #826, Modal refactor #842, Organize background script grouping/order #847, Remove comments from . eslintrc.json #853, ClipboardReader class #854, Cache map improvements #856, Remove unused toIterable function #857, Media utility refactor #859, Send message updates #864, Move searchTerms/searchKanji to front of object definitions #873)

[FooSoft]

Sweet, this helps a ton. I'll get a new testing release queued up later today or tomorrow 🎉

The situation with the Firefox listing is not good; I have no idea where this all came from, and why a certain range of versions was arbitrarily disabled. Handlebars have been used for a really long time, so who knows why the reviewer did not just take down the extension in its entirety. My requests for clarification as to why this is happening now have thus far been ignored...

I think we have two (not necessarily mutually exclusive) things we can do regarding Firefox users:

1. Switch to eval-less Handlebars
2. Self-host the Firefox extension

Considering how dysfunctional the review process appears to be, #2 is looking pretty appealing. I think our users are pretty technically capable in general, and would not have a problem making the switch.

[toasted-nutbread]

@FooSoft Can you upload the testing release builds here https://github.com/FooSoft/yomichan/releases/tag/20.9.28.0? That will give me some testing files for experimenting with self-hosted releases.

[FooSoft]

@toasted-nutbread it should already be available here:
https://chrome.google.com/webstore/detail/yomichan-development-buil/bcknnfebhefllbjhagijobjklocakpdm

Or are you referring to something else?

[toasted-nutbread]

I mean by attaching them as files to the release tag:
https://github.com/FooSoft/yomichan/releases/edit/20.9.28.0

Attach binaries by dropping them here or selecting them.

[FooSoft]

Done! I am not actually that saavy when it comes to release management on GitHub, but easy enough 👍