Initial implementation of a browser extension to add puzzles. #2392
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When adding a puzzle, we start a transaction to atomically check if a puzzle already exists with that URL and only add it if either no such puzzle exists or if the client indicates that duplicate URLs are allowed. In the event of a transaction failure, we delete the Google document that was created optimistically before saving the puzzle. On the client side, we add a new checkbox to allow duplicate URLs, unchecked by default. If we encounter a duplicate URL error, we show an error indicating that the puzzle may be a dupe and telling the user what to check if the duplicate URLs are intentional.
- Propagate user ID to API methods in authenticator - Add API to list hunts - Add API to list tags for a hunt (for autocompletion) - Add API to create a puzzle Most of the complexity is in the latter. The bulk of the implementation is shared with the existing flow for creating puzzles, but there is some jank: - Wherever we were looking at this.userId, which is populated for Meteor method execution but not this API path, we need to pass an explicit userId instead. One pain point is the auto-inferred userId for the createdBy column of many tables. - We check the types of the input in both the Meteor method (to take advantage of the validate scaffolding) as well as the shared logic (so it's there for API calls).
Allows users to (re)generate and copy-paste a key for external use.
Supports (at least) Chrome and Firefox. Includes a settings page to input the Jolly Roger instance and API key, and a popup menu which reads the URL and title from the current page and provides a form to add it to a particular hunt on that instance. The form is modeled off of PuzzleModalForm, but condensed vertically to try to avoid scrolling in the height-limited popup window. We also surface recently-used tags to make it easier to add multiple puzzles in the same round/group. Built as a mostly-independent module in the extension/ folder using npm; could be split into a separate repository if desired. There is a small bit of duplication with Jolly Roger proper, but this seems reasonable to avoid unduly tight coupling and allow using more modern dependencies than Meteor currently permits. Uses React Bootstrap and consistent UI components with Jolly Roger, but is powered by the REST API rather than Meteor, which seems like it would introduce significant complexity for limited value. Also covered by the root project's eslint and prettier configs; Typescript checking is covered by the Webpack compilation. Some checks are disabled because they require "npm install" to be run from the extension directory. In general, we probably need to align on an organizational structure before devoting too much time to making the linters work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(More details in individual commit messages - this PR is a stack of a few open requests).
See #237