Use a deep copy when comparing a puzzle to detect state modifications

Since the recent tags is an array, we need a deep copy of the puzzle dict
in order to be able to reliably compare the puzzle prior to the copy with
the one after the copy where a tag has been added or removed.

With this fix, adding or removing a tag now reliably updates the channel
description.

Add a /tag command to add or remove tags from puzzle

And put the tag values everywhere we have the state string already.

Add two new shortcut commands:

/new Which is the same as: /puzzle new
        /edit Which is the same as: /puzzle edit

I don't know if this is cleaner or messier, but I can at least put it
out there as an option.

For /puzzle on meta puzzles print all titles/answers of feeder puzzles

Where feeder puzzles are specifically defined as puzzle belonging to the
same round.

Put solution after puzzle name in /hunt reports

The concept here is to keep the puzzle names aligned to make it easier
to find a puzzle of interest in the sorted list.

Add a divider between rounds in the /hunt output

Just to make it a little easier to see the grouping of rounds.

TODO: Update for two recently-completed meta items

The punch list is getting short now...

Sort all meta puzzles before all non-meta puzzle in puzzle lists

This is in the output of /hunt, /round, and the Turbot home view.

new_puzzle_submission: Create a puzzle dict before shoving it into the DB

This will be handy for calling some puzzle.py functions that expect a dict.

Add a "meta" checkbox when creating/editing a puzzle

And display all meta puzzles with a bold "META" prefix.

Fix a typo in a comment

This comment was supposed to refer to puzzle_id, not hunt_id, which
made it confusing for me until I fixed it as in this commit.

Implement a /round command

This is much like the /hunt command with searching, etc. but with two
differences:

  1. It is limited to display puzzles in the same round(s) as the
     current puzzle

  2. It defaults to display all puzzles rather than unsolved puzzles
     like /hunt does

Implement a `/puzzle edit` command

As a simple shortcut rather than making the user type `/puzzle` and
then click the pencil icon.

Report change in a puzzle's solved status to the main hunt channel

We were already doing this from the /solved command but now we do it
for puzzle edits as well.

Put a message into the channel when a user edits a puzzle

So that other members of the puzzle are informed that something has changed.

Add display of round(s) in /puzzle output

Making the output more complete (while still remaining quite compact).

Add new /puzzle command which simply prints the current puzzle

This is the same format one could get from the /hunt command, but
limited to the current puzzle. This is a very convenient way to see
all the puzzle fields and to get access to the pencil button to edit
the current puzzle.

Rename puzzle creation command from "/puzzle" to "/puzzle new"

This is to create space for other commands later, (such as "/puzzle edit"
and a new status-reporting "/puzzle" command).

Don't re-set channel and sheet name or channel topic to the same value as before

The puzzle_update_channel_and_sheet function is modified here to
accept an old_puzzle argument in addition to the puzzle argument. By
using this it can decide whether there's any change in the sheet or
channel data before setting it.

This optimization avoids Slack reporting things like:

    Turbot renamed the channel from "hunt-puzzle" to "hunt-puzzle"

Which is obviously just noise.

Unify code to rename channel, set channel description, and rename sheet

With this code, all of those changes are made consistently regardless of
whether the change happens from /state, /solved, or a puzzle edit (which
could set status to either "solved" or "unsolved").

Reject puzzle edit if "solved" and "solution" are inconsistent

There's an argument here that we really shouldn't be giving the user
two different fields if we're forcing them to be edited together, but
that's what we have right now.

Update TODO file now that puzzle edit dialog has been edited

And just as the TODO file predicted, right now it's only possible to
get at this functionality through the pencil icon.

Implement update of puzzle when edit_puzzle dialog is submitted

Processing all user input and updating the database with the changes.

This isn't _quite_ updating everything in the channel and the sheet
that should be changed. To do that we simply need to refactor the code
that's currently doing that in various places to do it all in one
place.

Implement a dialog box to edit a puzzle

This is connected to the "pencil" buttons that were recently added to
the /hunt output as well as the Turbot home view.

So far, this brings up an editable dialog with the puzzle state but
doesn't actually do anything with any of the edits made when the user
saves the dialog.

Modify multi_select_block to use accessory_block, section_block, and text_block

Where this content was previously open-coded and redundant.

The commit removes more lines of code than it adds.

Revamp the TODO list

The primary thing here is a sorted list of everything we want to
complete before a feature freeze, (which we're doing one weekend
before MH 2021 and will be followed by some test hunt over the weekend
both to flush out bugs and to get more of the team comfortable with
Turbot).

Wire up a function to handle the edit_puzzle button

It doesn't actually _do_ anything yet, but should at least prevent the
warning sign which was appearing before.

And this should let us see if the action_id field is a good way of
plumbing the hunt_id and puzzle_id through to the handler for the
press of the edit_puzzle button.

Add an edit button next to each puzzle

This will appear in both the Turbot home screen as well as in the
output from the /hunt command.

Fix indentation

To keep the flake8 check passing.

Put -SOLVED as a suffix on sheet names and not a prefix to preserve
alphabetical ordering.

Modify a sheet-related TODO item after clarifying it with Nathan

This is regarding making a hunt-specific folder for sheets to live in.

Also, while thinking about this, add another item about possible
changing the way sheets are renamed.

Update TODO now that /hunt accepts a search term

Given the way the original TODO item was written, (as adding support
to both /home and to the Turbot home screen), this recent feature
addition doesn't delete an entire item from the TODO list, but it does
deserve to.

Fix error with missing search terems

Some recent change made a command like "/hunt solved" result in an error.
This commit fixes that.

Use Slack back-tick quoting for search terms

This is cleaner both for preventing misinterpreting asterisks and also
more clear than re-inserting quotation marks for search terms that
include spaces.

Tweak bolding of hunt lead-in line from search results

Using bold just for the puzzle status word. (This is an attempt to
avoid Slack seeing a '*' in a regular expression of a search term and
think that it means to make something bold.)

Add state string to list of puzzle attributes matched in searching

This is a really important one so that people can use state strings
for things like "logic" and others who want to solve a logic puzzle
can find them.

Add search terms to the /hunt command

Now, `/hunt <search-term>` can be used to list puzzles matching
<search-term>. As before, it will display only unsolved puzzles by
default, but `/hunt all <search-term>` or `/hunt solved <search-term>`
can be used to display other puzzles as well.

Drop two items from the TODO list (which we just completed)

A commit just a couple back in the series added these features.

Correct typo in hunt description verbiage

Thanks to Ken for pointing out this misspelling.

Add support for an argument to the /hunt command

This will work with three options:

/hunt all: Show all puzzles
        /hunt unsolved: Show unsolved puzzles
        /hunt solved: Show solved puzzles

Add a /hunt command

Which spits out details of the current hunt, (in a format very similar
to what appears in the Turbot home view).

Farm blocks-creation code out to various supporting files

The code will be easier to manage with separate hunt, round, puzzle,
and channel.py files each responsible for maintaining their own
functionality. We don't yet have any classes in any of these files,
(just functions that look things up in the database and that generate
Slack blocks), but we may end up doing classes later, (particularly if
we start wanting methods to update a single attribute in the database
for a given item, etc.).

Revert "Turbot home: Disable the 'Hunts you can join' section"

This reverts commit e3385b6a7da4583ab7c0729ac6776a32aa2818a0
which disabled some code to prevent a bug that was causing the
turbot Home view to fail to work.

The previous commit fixes the underyling bug so this code can now be
safely re-enabled.

hunt_link_block: Remove inadvertent trailing comma

This was creating a tuple where not intended, so causing invalid
blocks structure to be sent to Slack.

This was the cause of the recent bug preventing the Turbot Home view
from working (unless the user already belonged to every available
hunt).

TODO: Capture some recent suggestions

Ideas from various people mentioned in Slack

Turbot home: Disable the "Hunts you can join" section

Which is buggy and causing problems right now.

Prevent failure of /solved command if /state had never been run

The recent code to make /solved clear the /state field was buggy in
that it would result in a dispatch_failed error in Slack if /state had
never been invoked previously.

TODO: Add a low-priority item for using a URL shortener

One downside of doing something like this is that it would introduce a
dependence on another third-party service, so I'm not really all that
keen on pursuing this.

Add display of rounds in the Turbot home view

Grouping puzzles that belong to each round (and also a list of puzzles
that belong to no round).

This drops another item from the TODO list.

Drop leading/trailing spaces and empty strings when parsing rounds

Since we're dealing with user input here, it's easy for their to be
leading and trailing space (which we don't want as part of the round
name), or even an accidentally emty round (from two consecutive
commas). Drop any of those spaces and ignore any empty round strings.

Fix storage of rounds for new puzzle creation

To store an array of strings rather than storing each character from
the round string as an individual round (oops!).

That is, before this fix, if the user typed a round name of "Colors" the
database would store a rounds array for the puzzle with values of "C",
"o", "l", "o", "r", and "s".

Drop TODO item regarding audio/video calls

Nathan is planning on signing up for a paid plan with Slack
temporarily (over the period of Mystery Hunt) specifically to get
access to Slack video calls. These are already fully integrated
(allowing a call to everyone who belongs to a channel) which means
that that will allow for a call to everyone working on a given
puzzle. So I don't think we'll need any specific work to integrate
Turbot with this approach.

Restrict a Slack channel topic to 250 characters

And terminate it with an ellipsis if the user-provided state string is
too long. (It's a bit annoying that Slack returns an error rather than
just doing this same thing itself, but whatever.)

This satisfies a TODO item since users had encountered this error
during our last hunt.

Add list of available hunts to the Turbot home view

So that people can easily find active, public hunts.

Make /solved clear the state string for a puzzle

In the last test we run, we often saw stale state messages about a
puzzle being half-solve, etc. when it was actually already completely
solved. Instead of putting another chore onto solvers to have them
manually clear the state string after solving a puzzle, here we do
that automatically.

This completes another low-hanging fruit item from the TODO list.

Refuse to create a new puzzle with the same URL as an existing puzzle

Just a simple safety check when multiple people might be creating the
same puzzle at roughly the same time.

And one less item left on the TODO list.

Update TODO now that initial round selection is available

One TODO item is clearly complete here: The new multi-select field in
the modal form when creating a puzzle. That's working well enough that
I don't think we need the separate /round command so I'm dropping that
from the TODO.

Two little things are needed to really make round support complete:

  * Display/grouping of rounds in the Turbot home view

  * Select same rounds (by default) when creating a new puzzle in the
    same channel of an existing channel

Make /solved reject a missing solution string

And instead give an error to the user explaining the usage of the
/solved command.

Add a multi-select round field to puzzle creation

Actually, there are two round fields. The first is a free-form text
field for a comma-separated list of rounds. Each of these rounds will
be added to the database as an item with only two attributes:

hunt_id: <HUNT_ID>
        SK: round-<ROUND>

The other field is a multi-select field populated with the names of
all rounds that already exist in the hunt. This makes for easy
selection without having to worry about typing in names identical with
what others typed previously.

Add a handler for multi_static_select input

The documentation of the multi_static_select input block wasn't clear
that it would trigger a call to an event handler, but apparently it does.

We don't currently impose any restrictions on what a user selects,
(any combination of rounds is valid), so we simply return a lamba_ok
value for any selection. This prevents the user from seeing a warning
sign in the dialog (where hovering over it would say that the callback
returned 502).

Make the error message from /state a little more explicit

Specifically, make it clear that it was /state that caused the error.

(This is useful because the /state command doesn't get insterted into
the channel history but the error response does. So repeating this in
the error message can make things more clear if the conversation is
referred to by the user later.)

Rework code to map channel IDs to hunt or puzzle objects from the database

The old functions were named things like channel_is_puzzle,
channel_is_hunt, and fund_hunt_for_channel. These were still expecting
the old multi-table database schema so they were broken, (as was all
functionality built on top of them such as the /state and /solved
commands).

The new functions are built on the all-one-table database schema, so
should actually work again. They also have a cleaner interface in that
they only rely only on channel ID (and never put any special stock in
the channel name). Instead of doing magic with the channel name, the
code looks up the hunt_id from the database entry for a puzzle as
needed.

The new functions are named puzzle_for_channel and hunt_for_channel
and are implemented on top of a common, internal function:
db_entry_for_channel.

Update TODO for removed auto-invitation of users to puzzle channels

In recent commits we changed from auto-inviting all users to all new
puzzle channels to instead notify the main hunt channel whenever a new
puzzle channel becomes available.

Remove code (previously disabled) to invite users to new puzzle channel

Instead, add a message to the hunt channel with a link to the new
puzzle channel whenever a new puzzle is created.

Rename local variable from item to puzzle

The overly-generic name here was not at at useful.

With this specific name, the code will be much more clear when it says
things like hunt['channel_id'] vs. puzzle['channel_id'].

Rename primary-key attribute from PK to hunt_id

I was just about to add a separate attribut to every item in the
database named hunt_id when I realized that that was totally redundant
with our existing PK attribute (whose values were simply the hunt_id
prefixed by "hunt-" in all cases).

Since we're not using the PK field in any generalized sense, (that is,
it's _always_ populated with the hunt_id value), it's much simpler and
more efficient to just name it "hunt_id" and store the hunt_id valeu
ther directly (without any prefix).

Rename hunt_id_index to is_hunt_index

Backed, of course, by a new is_hunt attribute.

The rationale here is that the whole point of this index is to be a
sparse attribute so that the code can efficiently query all existing
hunts. But meanwhile, it's useful for puzzles to have a "hunt_id"
attribute, which would confict with the goal of having "hunt_id" be
sparse and populated only for hunts and not puzzles.

So the fix here is to make hunt_id universal, and instead have a
separate "is_hunt" attribute which is the sparse one, (and will
clearly never be populated for a puzzle).

Don't put an attribute into the database for 'url' that is left blank

The URL field, (for either a hunt or a puzzle), is an optional
parameter, (the user creating the hunt or puzzle may or may not
provide a URL). Immediately prior to this commit, if a user left the
URL field blank, the submission handler was receiving a value of None
and inserting that as an attribute in the database.

This was problematic as subsequent code, (such as sheet creation),
would be prepared for an item to have no url key at all, but was not
prepared for the key to be present but for the value to be empty.

We fix this in this commit by explicitly _not_ inserting a None value
for url as an attribute in the database item, (instead, not supplying
a url attribute at all).

Convert /puzzle puzzle creation to all-one-table database schema

So we put the hunt ID into the PK field and the puzzle ID into the SK field,
(allowing puzzle items to be distinguished from hunt items in the table).

While doing this, we also disable the feature of inviting all hunt
users to the new puzzle. This is both because that code hasn't been
ported to the new schema, and also because that feature is planned to
be eliminated anyway.

Home: Update query for finding puzzles to new all-one-table schema

Previously, we looked in a separate per-hunt table to find the puzzles
for a hunt. Now, instead, we look in the single "turbot" table and
find puzzles for a hunt by looking for items whose PK is
"hunt-<HUNT_ID>" and whose SK starts with "puzzle-".

Rework message given when bootstrapping the turbot table

This provides a little more information, (such as that a user should
wait a minute before retrying), and is a little more polite, (saying
"please").

Turbot home: Use recently added hunt_id_index to find existing hunts

This fixes the home view to correctly use the new single-table schema to
find the list of available hunts. This view is now working to display
the names of active hunts a user belongs to.

(No puzzles are listed yet. That part of the home view still needs to be
brought up to date with the latest schema.)

Turbot home: Report "you do not belong to any hunts" if that is the case

Instead of having the header "Hunts you belong to" followed by nothing.

Add a hunt_id attribute and index to the database for hunts

This will allow the Turbot home view to scan the hunt_id_index to find
all existing hunts, (without having to scan non-hunt items from the
database).

Fix stale usage of "puzzle_table"

We no longer haave a separate table for puzzles, but instead the single
"turb.table" holds all of our data.

This doesn't fully convert this code to the new single-table schema,
but it should at least let things pass the flake8 test and deployment.

Require flake8 to pass before performing deployment

Trying to speed up debug cycles by catching errors without having to
wait for them to show up in CloudWatch logs.

Add a "make flake" recipe and clean up some style bugs flake8 noticed

We also ignore some rules about whether or not there's a space on
either side of some operators, since I fundmanetally disagree with
flake8 on some of these.

Beginning of transition to single-table database schema

This is aiming for a one-big-table approach, (which is the DynamoDB
best practice), instead of having one table for hunts and then a
separate per-hunt table for puzzles.

This new approach will be more flexible as we start adding database
items for rounds, etc. In the old approach, rounds would likely have
become yet another hunt-specific table, and the number of per-hunt
tables would have started to become rather messy.

With this new schema, rounds can instead be just another item, where
hunts, rounds, and puzzles can all be intermingled as items in the
same table.

To get this all to work, we are creating secondary indexes for
querying items from the database via attributes other than the primary
key, (for example a "channel_id" index).

As of this commit, the "New Hunt" button works in that it:

  * Creates the turbot DynamoDB table if it doesn't exist

  * Inserts a new item into the table for the hunt itself (active=False)

  * Marks the sheet_url of the item as "pending"

  * Creates a new channel for the hunt

  * Responds to the channel_created event

  * Creates a Google sheet for the hunt

  * Stores the sheet_url in the database

  * Marks the hunt as active=True in the database

  * Reports to the Slack channel that things are working

So that much is working, but everything else has yet to be converted
to the new schema. So things that don't yet work include at least:

  * The turbot "Home" view doesn't yet display anything

  * The /puzzle command doesn't work yet

Rework the TODO list to capture recent-discussed priorities

Thanks, Nathan!

Add TODO item for displaying who has current roles

This was an idea proposed during the recent hunt kickoff meeting.

Drop quotation marks from around puzzle name

This is already being formatted as a link, so we don't need quoation
marks as well.

Add (and use) a new function find_hunt_for_hunt_id

The code to call get_table_item with a hunt_id was broken, (since in
the schema, hunt_id is not the key, only channel_id is), so instead we
need to scan the table looking for a matching hunt_id. We already had
code to do this is find_hunt_for_channel, so here we factor that out
into a new function, find_hunt_for_hunt_id and call it instead of
get_table_item.

Add hunt_id to the puzzle table (instead of orig_channel_name)

A recent commit (to announce /solved in the main hunt channel)
expected to find hunt_id in this table, but it wasn't there. So we add
it in this commit. And while adding it, we drop the orig_channel_name
field, (which embedded both hunt_id and channel_id into a single field
in the database so would have made renaming of the hunt_id rather
awkward).

Fix Makefile to not hard-code python3.8

Apparently I'm using python 3.9 now. Fix the Makefile so that the
deploy recipe should work with any version of python.

Make the /solved command report to the hunt's channel

So that there's a log in the main hunt channel for when each puzzle
gets solved.

Rework find_hunt_for_channel to return a hunt dictionary

It's going to be most convenient to return hunt and puzzle dictionaries
that contain all entries from the database, (rather than a hard-coded
tuple which is likely to not contain every piece of data we'll eventually
want to have).

Use consistent formatting for channel name and spreadsheet name

Specifically, using a prefix of "SOLVED: " when a puzzle is solved.

Simply typo fix

It's AWS, not AW.

Update TODO

Append "-solved" to puzzle channel names when /solved

Update TODO

Typo

Finally I found out how to make the stupid batch API work

I am not a fan of this api's documentation

Fix function arguments

Fix typo

Rename sheets with 'SOLVED - ' prefix when /solved

Update TODO list

Quote parameters to HYPERLINK

Fix arguments to HYPERLINK