Release v4.1.0

[Jaifroid]

We're overdue a new release of the Browser Extension, as we have a major new feature (the Popover feature), plus some key elements of Zimit2 support and a number of bugfixes. It's been some six months since the last release, and we normally release this app quarterly...

These are the steps to complete a new release:

• Fix some important but relatively simple issues if possible
  • Translate the Store information (Mozilla, Chrome, Edge, Ubuntu) into at least French and Spanish #1118
  • Wait longer for the SW to cache assets before rebooting if the SW fails to register #1255
  • When opening a folder of archives with FSA API, do not jump straight to the first file #1254
  • Users seem confused when the Chrome extension won't do some stuff in ServiceWorkerLocal mode #1257
  • When displaying external link dialogue box from zimit2 archives, we need to decode the over-encoded querystring #1258
  • Rename "Safe Mode" to "Restricted Mode" #1259
  • Add filtering for custom URI schemata (e.g. mailto:, skype:) to the filterClickEvent to force these to open outside the sandbox #1260
• Create PR to update the changelog file
• Rename all higher milestones by incrementing their names, create a new 4.1 milestone and move open issues to this new one
• Draft the new release with desired tag
• Run Set-AppVersion script (or manually change in 8 files) the version number to v4.1.0, also run npm install to update package-lock.json, and commit
• Final tests (some can be done on https://kiwix.github.io/kiwix-js)
  • Firefox OS
  • IE11
  • Edge Legacy
  • Chromium Extension
  • Firefox Extension
  • Safari on macOS
  • Safari on iOS
• Add release date to changelog and squash/merge PR
• Publish the new release (this will create the tag and start the release workflow)
• Check that dockerfile built correctly
• Generate unsigned extensions (should be automatically triggered on GitHub Actions by the tag creation)
• Check that the PWA version was correctly set in browser-extension.kiwix.org (should be automatically triggered by tag creation)
• Upload the unsigned extensions to Stores:
  • Firefox - https://addons.mozilla.org/fr/firefox/addon/kiwix-offline/
    • Check that the minimum Firefox version is correct
  • Chrome MV3 - https://chrome.google.com/webstore/devconsole
  • Edge MV3 - https://partner.microsoft.com/en-us/dashboard/microsoftedge/
  • Ubuntu touch - https://open-store.io
• Prepare the source code for version 4.1.1 (changes should be made to 9 files, or use the Set-AppVersion script to update 8 files, followed by npm install to update package-lock.json.)
• When available, copy the signed extension binaries to https://download.kiwix.org/release/browsers/
  • Firefox - xpi downloadable from extension page
  • Chrome - crx downloadable from extension mgmt page
  • Edge - check version is published, then use direct link for Edge-specific crx
• Check that the implementation on kiwix.github.io/kiwix-js/ is synchronized automatically with main
• Publicize these new versions
• Close this issue and close the v4.1 milestone

[Jaifroid]

While testing on Firefox OS, I found that this old OS doesn't support innerText in some contexts, so I need to test for that and substitute textContent in two places in the popover code. As this is a trivial change to get the code working on Firefox OS (textContent is nearly the same as innerText, certainly for our purposes), I'll go ahead and do that so I can continue testing.

EDIT: Done in df0ec68

[Jaifroid]

And while testing fallback extensions (Manifest V2 for Firefox and Chromium, Manifest V3 for Firefox, I realized that I forgot to internationalize these manifests in line with the changes made to the Chromium Manifest V3. Again, this is a trivial change just copying the new fields to these manifests.

EDIT: Done in 8ece250

[Jaifroid]

@audiodude I've finished testing as indicated in the checked boxes above (or as we say in British English: the "ticked boxes" 😉). Apart from Chrome / Firefox / Edge extensions on Windows, plus some old browsers, I tested the offline webapp version in Safari 17 on an iPad Pro 2021, and Safari 14.1 on Big Sur (macOS) via BrowserStack.

I didn't attempt to test the packaged extensions themselves in macOS Chrome or Firefox via BrowserStack because it's not possible to test extensions that are not in one of the Stores in BrowserStack, given that access to files is severely locked down in macOS on BrowserStack. Please note we do not publish an extension for Safari, but the offline webapp version can still be used with full features in Safari. Users can install the extension in Chrome or Firefox on macOS.

My testing is pretty comprehensive, but do you want to do any further testing? If so, I can explain an easy way to test the code using the development webapp, or a more involved way of installing a temporary extension (which is a bit fiddly).

If you don't need to test further on macOS, then I'm pretty ready to start the release process once you're happy with the CHANGELOG PR.

[audiodude]

If you don't need to test further on macOS, then I'm pretty ready to start the release process once you're happy with the CHANGELOG PR.

I'll trust your judgement and do additional testing if you think it is required. I have a macOS 10.15 Catalina system with an M3.

[Jaifroid]

Thanks @audiodude I have tested now in Firefox 126 and Chrome 125 on Catalina, and in Safari on the latest Sonoma (both via BrowserStack). So I think we're covered. There is no native code running in Kiwix JS, only JavaScript, so running on any chip that supports a full copy of Firefox or Chrome (or indeed a recent Safari) works fine.

FYI, on iOS, the app only works as a webapp in Safari, because for now Apple blocks the use of Service Workers in any browser other than Safari (on iOS, not on macOS). But users would be better off using the dedicate iOS app on iOS rather than running this Extension as a webapp, so while I test on iOS to be sure that we maintain compatibility, I'm not targeting it here, or optimizing UX for it.

[Jaifroid]

The Firefox extension update is already published: https://addons.mozilla.org/en-US/firefox/addon/kiwix-offline/ (also in Spanish and French). Edge is in review with newly translated information and graphics now that the internationalization of Chromium store entries is enabled in the packages. I'll upload Ubuntu touch and Chrome tomorrow.

[audiodude]

Let me know when it's time for 🍾 and 🎉 , I'm ready!

[Jaifroid]

As the two most important browser stores (Mozilla and Chrome) have certified the extension, and people will be receiving updates, I've made some publicity for this release: see Reddit post and Mastodon post.

Even though the Edge Store is ridiculously slow to certify (they say 5 working days, and it usually does take that), people will already be seeing the update if they use the default ServiceWorker mode (the vast majority), because the extension runs as an instantly updating offline PWA in that mode due to previously mentioned severe restrictions in local Chromium browser extensions.

[Jaifroid]

Edge Store finally certified, and all publicity done, so we can close.