Filters

# Keep an Up-To-Date Game Deadline

Make sure you have everything you need before proceeding:

In this section, you will:

  • Implement a deadline.
  • Work with dates.
  • Extend your unit tests.

In the previous section you introduced a FIFO that keeps the oldest games at its head and the most recently updated games at its tail.

Just because a game has not been updated in a while does not mean that it has expired. To ascertain this you need to add a new field to a game, deadline, and test against it.

# New information

To prepare the field, add in the StoredGame's Protobuf definition:

Copy message StoredGame { ... string deadline = 9; } proto checkers stored_game.proto View source

To have Ignite CLI and Protobuf recompile this file, use:

On each update the deadline will always be now plus a fixed duration. In this context, now refers to the block's time. Declare this duration as a new constant, plus how the date is to be represented - encoded in the saved game as a string:

Copy const ( MaxTurnDuration = time.Duration(24 * 3_600 * 1000_000_000) // 1 day DeadlineLayout = "2006-01-02 15:04:05.999999999 +0000 UTC" ) x checkers types keys.go View source

# Date manipulation

Helper functions can encode and decode the deadline in the storage.

  1. Define a new error:

    Copy ErrInvalidDeadline = sdkerrors.Register(ModuleName, 1109, "deadline cannot be parsed: %s") x checkers types errors.go View source
  2. Add your date helpers. A reasonable location to pick is full_game.go:

    Copy func (storedGame *StoredGame) GetDeadlineAsTime() (deadline time.Time, err error) { deadline, errDeadline := time.Parse(DeadlineLayout, storedGame.Deadline) return deadline, sdkerrors.Wrapf(errDeadline, ErrInvalidDeadline.Error(), storedGame.Deadline) } func FormatDeadline(deadline time.Time) string { return deadline.UTC().Format(DeadlineLayout) } x checkers types full_game.go View source

    Note that sdkerrors.Wrapf(err, ...) conveniently returns nil if err is nil.

  3. At the same time, add this to the Validate function:

    Copy ... _, err = storedGame.ParseGame() if err != nil { return err } _, err = storedGame.GetDeadlineAsTime() return err x checkers types full_game.go View source
  4. Add a function that encapsulates how the next deadline is calculated in the same file:

    Copy func GetNextDeadline(ctx sdk.Context) time.Time { return ctx.BlockTime().Add(MaxTurnDuration) } x checkers types full_game.go View source

# Updated deadline

Next, you need to update this new field with its appropriate value:

  1. At creation, in the message handler for game creation:

    Copy ... storedGame := types.StoredGame{ ... Deadline: types.FormatDeadline(types.GetNextDeadline(ctx)), } x checkers keeper msg_server_create_game.go View source
  2. After a move, in the message handler:

    Copy ... storedGame.MoveCount++ storedGame.Deadline = types.FormatDeadline(types.GetNextDeadline(ctx)) ... x checkers keeper msg_server_play_move.go View source

Confirm that your project still compiles:

# Unit tests

After these changes, your previous unit tests fail. Fix them by adding Deadline wherever it should be. Do not forget that the time is taken from the block's timestamp. In the case of tests, it is stored in the context's ctx.BlockTime(). In effect, you need to add this single line:

Copy ctx := sdk.UnwrapSDKContext(context) ... require.EqualValues(t, types.StoredGame{ ... Deadline: types.FormatDeadline(ctx.BlockTime().Add(types.MaxTurnDuration)), }, game) x checkers keeper msg_server_reject_game_fifo_test.go View source

Also add a couple of unit tests that confirm the GetDeadlineAsTime function works as intended (opens new window) and that the dates saved on create (opens new window) and on play (opens new window) are parseable.

# Interact via the CLI

There is not much to test here. Remember that you added a new field, but if your blockchain state already contains games then they are missing the new field:

This demonstrates some missing information:

Copy ... deadline: "" ...

In effect, your blockchain state is broken. Examine the section on migrations to see how to update your blockchain state to avoid such a breaking change. This broken state still lets you test the update of the deadline on play:

This contains:

Copy ... deadline: 2022-02-05 15:26:26.832533 +0000 UTC ...

In the same vein, you can create a new game and confirm it contains the deadline.

synopsis

To summarize, this section has explored:

  • How to implement a new deadline field and work with dates to enable the application to check whether games which have not been recently updated have expired or not.
  • How the deadline must use the block's time as its reference point, since a non-deterministic Date.now() would change with each execution.
  • How to test your code to ensure that it functions as desired.
  • How to interact with the CLI to create a new game with the deadline field in place
  • How, if your blockchain contains preexisting games, that the blockchain state is now effectively broken, since the deadline field of those games demonstrates missing information (which can be corrected through migration).