Update first-launch tutorial URL - #439
Conversation
Miliya-Ai
left a comment
There was a problem hiding this comment.
Question @aidanbruneel Have you deployed this branch to Unicorn? I'm trying to use the Incognito window to trigger the "first launch" logic and check if there are any requests sent to https://image.a11y.mcgill.ca/tutorial/, but I haven't observed that. However, the codebase seems fine, so I agree.
|
Hi @Miliya-Ai, Thank you for actually testing the functionality, that's a great code review habit. No, I haven't deployed or functionally tested this branch on Unicorn. I developed the change there, but Unicorn's Node.js version prevented the webpack development build from running, so my validation so far has only been source-level (as noted in the PR description). That said, browser extension isn't actually hosted on a server, it's hosted in your browser. I also took another look at the first-launch logic. It appears that opening an Incognito window would not trigger it: the first-launch page is opened by Honestly, I think the risk profile is so low, it probably isn't worth testing the actual functionality of the extension itself, since that is not the change that was requested; rather, I have changed the URL that the first-launch anchors to, so all else being equal, there is no reason this would disrupt that functionality. |
|
As a side note if anyone ever reads this, this is one of the many reasons why unit testing (and specifically, Mocking) is useful. |
|
@aidanbruneel Thanks for the detailed explanation, that clarifies things. |
Summary
Updates the browser extension's first-launch experience to point to the current IMAGE tutorial.
The accompanying first-launch documentation has also been updated so it no longer references the removed quickstart page.
Validation
src/.https://image.a11y.mcgill.ca/tutorial/.git diff --check.npm run pack:test, but the build could not run on Unicorn because its installed Node.js 12 runtime is incompatible with the repository's current webpack toolchain.Closes #437.