CHANGELOG.md

   1 Version 1.2.0 - 2022-06-24
   2 ==========================
   3
   4 General changes to game and UI
   5 ------------------------------
   6
   7  * Counting pickup decks, hands, etc., now include un-occulatable
   8    pieces in their count, not only occultable ones.  This means
   9    counting piles can now be used to count unoccultable pieces.
  10
  11  * Fiddle with CSS to try to get mouse cursor to update more promptly.
  12    (This is still not perfect, probably due to browser misbehaviour.)
  13
  14  * otter(1): When printing game access URL, say in message that it's private
  15
  16  * Change monospace font to DejaVu Sans.  Reportedly the previous font
  17    was not always available, causing the chess clock to perhaps misrender.
  18
  19  * Add piece descriptions to more messages.
  20
  21  * UI improvements relating to selecting, wresting, and dragging:
  22    - Mouse cursor shows differently when in wresting mode.
  23    - Allow backspace to delete typed special count.
  24    - Leave wresting mode when the user presses space.
  25    - Allow rectangle select drag to start on pinned pieces. hands, etc.
  26
  27 Otter CLI
  28 ---------
  29
  30  * Provide set-access subcommand.  Previously the game ACL could only
  31    be adjusted by resetting the whole game, or abstruse alter-game-* runes.
  32
  33  * fix typo in usage message part concerning `otter reset`.
  34
  35 Game client UI fixes
  36 --------------------
  37
  38  * Split a banknote (currency) when the user makes a counted click,
  39    even if they are currently holding the note itself.
  40    (previously this would simply unselect it).
  41
  42  * When pieces are newly inserted (inclidng on game reset), properly
  43    record their description (for use in messages) and bbox.
  44    Previously, the description would show as "undefined" until page reload.
  45
  46  * When pieces are deleted (including on game reset), properly remove
  47    the client's idea of any active occultations they might have had.
  48    Previously, "ghost" occultations would remain, causing dotted-line
  49    grasp highlighting in places where the hands etc. were.
  50
  51  * When a player changes their nick, update this in the clients, so
  52    that the new nick appears in the info pane and in the various affordances.
  53
  54  * Fix minor bugs in mouse click handling corner cases.
  55
  56 Documentation
  57 -------------
  58
  59  * Correct the description of the shapelib group parameter `desc_template`.
  60    (Previously this wrongly said the parameter was `desc`.)
  61
  62 Demo (testing) game changes
  63 ---------------------------
  64
  65  * Increase table size.
  66  * Add a pickup deck.
  67  * Fix a misindent in the spec file.
  68
  69 Internal and testing chnages
  70 -----------------------------
  71
  72  * Server/client protocol change: Rename AddPlayer to SetPlayer.
  73  * apitest: Suppress some hyper log messages by default.
  74  * Add two debug console.log's to the JS code.
  75  * Refactorings and internal comment updates.
  76
  77
  78 Version 1.1.0 - 2022-05-26
  79 ==========================
  80
  81 Bundle format
  82 -------------
  83
  84 Introduced bundle format versions, and bundle format version `2`.
  85 Bundle format version `1` is still supported.  There are significant
  86 changes and improvements in version `2`, available by writing
  87 `format=2`.  See "Bundle compatibility" in the documentation.
  88
  89  * Handling of piece size and angle specification overhauled.
  90  * New and better template substitution syntax.
  91  * Fixed piece angle specification in game specs.
  92
  93 Breaking change to otterlib CLI program
  94 ---------------------------------------
  95
  96  * otterlib (the library preview utility, not normally needed for bundle
  97    development) now needs to know the nwtemplates directory (so it can
  98    properly process etc. magic library items).
  99
 100 New features
 101 ------------
 102
 103  * Dice, via the `Die` piece type.
 104  * Currency (money, and similar things), via the `Currency` piece type.
 105  * Shape libraries can provide canned "magic" items
 106    (which are then based on the library's own image(s).
 107  * `stack_pos` parameter for `PickupDeck` pieces, specifying where the
 108    "neat pickup deck" should appear, so it doesn't have to central.
 109  * otter CLI client: Allow uploading a directory directly as a
 110    bundle zipfile (helpful for bundle development).
 111  * Include piece description in some log messages.
 112
 113 Fixes and improvements
 114 ----------------------
 115
 116  * Do not randomly panic when trying to print truncated debug output
 117    for non-ASCII piece HTML.
 118  * Set default fonts for SVG processing: in bundle SVGs, at all (so
 119    that text is not elided); in builtin libraries, more widely
 120    (without effect on the existing pieces).
 121  * Notice errors during JS startup, and display them.
 122  * Correct sense of pin/unpin log message.
 123  * Shape library previews: fix (and improve) the HTML (from otterlib).
 124  * Fix a tiny rendering error in arrowheads.
 125  * Test suite: `childio`: work around a Linux kernel race bug: you can
 126    sometimes reap a child and then write to its pipe without EPIPE.
 127  * Build system: run miri with +nightly, so that tests work when stable
 128    Rust is the default.  Document that these tests require nightly.
 129  * Correct an error message about JSON serialisation.
 130  * Remove some direct stderr debug prints from production code.
 131  * Log message colourisation on a tty now leaves the logs more readable.
 132  * Some improvements to bundle/shapelib loading error messages.
 133
 134 Docs
 135 ----
 136
 137  * Dcouemnt the semver stability promises.
 138  * Publish the docs to an Otter-version-specific directory, so that
 139    old docs versions are retained.
 140  * Fix some formatting errors and typos.
 141  * Correct some leftover todos.
 142  * Clarify extra field syntax in shape library catalogue `files` entries.
 143
 144 Protocol and model enhancements
 145 -------------------------------
 146
 147  * `multigrab`: pieces that can capture the number of pieces the user
 148    says to grab, and instead handle the whole multigrab operation.
 149  * `fastsplit`: pieces that can be split and merged during play
 150    without having to rewrite the aux save file (containing SVG images).
 151  * Non-mixing OccultIlk, for pieces which always remain distinguishable.
 152  * Special rendering instructions, for pieces whose display involves
 153    bespoke code in the TypeScript.
 154  * OpOutcomeThunk system to allow piece implementations to be reinvoked
 155    with an ability to make much wider mutable borrows.
 156
 157 Build system, internal changes, etc.
 158 ------------------------------
 159
 160  * Update to Rust 2021.
 161  * Break out an additional `otter-support` crate (to try to
 162    improve incremental build times).
 163  * Use `ambassador` macro crate to help delegate trait impls.
 164  * When formatting the Rust docs, pass `--document-private-items`.
 165    (The Rust doc tree is for Otter developers.)
 166  * Rationalised and sanitised the item import (`use`) practices.
 167  * Refactoring in the test suite to support new tests.
 168  * Fake time facility for testing.
 169  * Concrete protocol: more Quiet PieceUpdateOps.
 170  * Work around inkscape extension fail-to-save bug (seen in recolour).
 171  * Reorganised and shuffled about `Outline` types.
 172  * Avoid saving various things to savefiles that aren't needed
 173    (mostly `None`s).
 174  * Add some internal documentation about `ModifyingPieces`.
 175  * Code motion to better organise shapelib.rs and utils.rs
 176  * Centralised some UI properties in ui.rs.
 177  * Made some type names more consistent (eg `GOccults`, `Catalogue`).
 178  * Renamed some PacketFrame types etc. from MgmtChannel.
 179  * Other minor improvements.
 180
 181
 182 Version 1.0.0 - 2022-04-02
 183 ==========================
 184
 185 Significant changes
 186 -------------------
 187
 188  * Compile on stable Rust.
 189  * Uses actix-web rather than Rocket (should be similar in overall
 190    functionality but there may well be behavioural changes).
 191  * Always listen on localhost:8000 by default regardless of `debug` config.
 192    But, support explicit configuration of listening addresses.
 193  * Do not sometimes leak (in game log) piece identity of face-down cards.
 194
 195 Minor improvements
 196 ------------------
 197
 198  * Add short crate-level docs with reference to website etc.
 199  * Fix inconsequential misacceptance of some odd-length hex byte strings.
 200  * Fix some almost-incosequential short write bugs (might manifest as races).
 201  * Typo fix in one error message.
 202
 203 Build system
 204 ------------
 205
 206  * Turn on integer overflow checks for release builds.
 207  * Don't override environment's SPHINXBUILD or NAILING_CARGO.
 208  * Update dependency versions.
 209  * Skip some unnecessaary miri runs of certain tests.
 210  * Support for controlling the Rust version via RUST_VERSION.
 211  * `make deploy` MUSL build is in release mode by default.
 212  * Document that build now requires 6G rather than 10G.
 213
 214 Internal improvements
 215 ---------------------
 216
 217  * Drop wee-alloc as allocator from WASM.
 218  * Many internal code style improvements prompted by rust-clippy.
 219  * Remove some unused internal bits and bobs.
 220  * Require layout parameter in session URL loads.
 221  * Miscellanous Other cleanups.
 222
 223
 224 Version 0.7.3 - 2021-07-25
 225 ==========================
 226
 227 Build system bugfixes
 228 ---------------------
 229
 230  * `cargo` publication in `make-release` uses better pre-clean
 231    approach.  (Removes some junk from caago packages.)
 232
 233 drop our own directory from cargo.nail
 234
 235 Version 0.7.2 - 2021-07-25
 236 ==========================
 237
 238 Bugfixes
 239 --------
 240
 241  * Complete overhaul of Z coordinate (stacking order) handling, including
 242    reworked Z lowering algorithm (`b` key function).  Changes and
 243    consequences include:
 244
 245     - On page load, use player's view of the Z coordinate for sort order (Z
 246       display order) of occulted pieces, not actual Z (!)  avoiding
 247       incoherent client state and arbitrary behaviours eg:
 248     - Now we no longer ever raise a piece when user asks to lower (!!)
 249     - Occulters (hands and decks) more uniformly try to be low down.
 250     - e.g. user will no longer accidentally put card under their hand (!!)
 251     - Do not derange relative ordering of multiple lowered pieces.
 252     - Fix a logic errors and panics in Z coordinate handling which
 253       might prevent some attmepts to lower (or, mayby, raise) pieces.
 254     - When the user asks to raise but nothing can be raised, log a message.
 255     - Automatically lower occulting pieces when they are enabled, and
 256       pieces which are being pinned (insofar as reasonable); this
 257       significantly reduces the probability of mysterious trouble
 258       lowering a piece ("would disturb a piece held by another player").
 259
 260  * Substantial overhaul of error handling for problems detected when
 261    processing client API requests:
 262
 263     - It should no longer be possible for the user to cause JS exceptions or
 264       other lossage merely by asking to do things which it happens that the
 265       server (unbeknownst to user or client script.ts) won't permit.  Report
 266       these errors in the user-facing client log window, instead.
 267     - New discussion of inapplicable-api-op etc. error handling in
 268       `PROTOCOL.md`, and implementation of the new scheme.
 269     - Principled client decisions about what to show the user - which
 270       things are errors, which things are to be rported as conflicts, and
 271       generally what to put in the user-facing message log.
 272
 273  * Do not re-raise things during drag if the user explicitly lowered
 274    them with `b` (since the user grasped them).
 275
 276  * Fix JS exception if user selected multiple pieces which used the same key
 277    for different purposes.  (Even transiently, for example by selecting
 278    multiple hand repositories and claiming them all - you'd briefly have `C`
 279    for claim for some, and `C` for unclaim for others, triggering the bug.)
 280
 281 New features
 282 ------------
 283
 284  * New general `t` keystroke to bring a piece to the top of the
 285    stacking order.
 286
 287  * Player hands now show the count of contained pieces.
 288
 289  * New loosely synchronised approach to "regrab", to enable a player
 290    to release a piece (eg, a card they have just drawn) and
 291    immediately, asynchronously, regrab it, while the server is sending
 292    an update (eg resulting from an occultation status change).  I.e.:
 293      - You can now draw a card into your hand in Mao and immediately regrasp
 294        it, planning to decide whether to play it - and you can do the regrasp
 295        without waiting for the server to show you the card.  Your regrasp and
 296        the server update run concurrently.
 297
 298 Other user-facing changes
 299 -------------------------
 300
 301  * `vatikan` game spec: Make the two hand repositoriess at the bottom bigger.
 302  * Deck card count uses a monospaced font.
 303  * Demo game: Add a label to the test hand.
 304
 305 Internal and development/test changes
 306 -------------------------------------
 307
 308 New tests (and new checks in existing tests):
 309
 310  * Test Z lowering algorithm with new test facility.
 311  * Test handling of UI actions which server decides (unpredictably
 312    from client POV) cannot be performed.
 313  * Add more tests of the zcoord module.
 314  * Webdriver tests: check that there were no JS exceptions.
 315  * Add in-browser testing of inapplicable-api-op error handling.
 316  * Test new regrab feature, and adjust tests to cope with regrab
 317    feature's somewhat different reporting of simultaneous-drag-attempts.
 318  * Tests do a consistency check of the Z coordinates vs the in-SVG
 319    subelement stacking order.
 320
 321 Testing, supporting changes:
 322
 323  * New jstest facility for running for-browser JS in a nodejs
 324    environment with some cheesy mockups.  (New `otter-nodejs-tests`
 325    crate; involves a separate invocation of `wasm-bindgen`.)
 326  * Webdriver tests: pass window size arguments to firefox so we
 327    get a window big enough for the provided game specs.  Involves
 328    wrapper script for `firefox`.  Also Xvfb server screen size.
 329
 330 Internal and protocol improvements:
 331
 332  * New "loose" update (api op) concept to support new regrab feature.
 333  * Fix a wdriver synch race which could lead to spurious tests failures.
 334  * Improve defensive programming in the zcoord module.
 335  * Abolish the incoherent `OnlineError` error type and replace it
 336    with `Inapplicable` and `Fatal`.
 337  * Abolish old incoherent and ununused `conflict_expected` in client JS.
 338  * Improved debug output in various places (when enabled or in tests).
 339  * Cleaned up a few flabby idioms in some tests.
 340  * Promote some debugging support to otter-base.
 341
 342 Internal docs improvements:
 343
 344  * Fix some bogus links in internal docs.
 345  * Add some more internal documentation to the zcoord module.
 346  * Tidy up some leftover comments etc.
 347  * Typo and formatting fixes in `PROTOCOL.md`.
 348  * Fixes to `cargo doc` build.
 349
 350 Build system and dependencies:
 351
 352  * Update many dependencies to new versions.
 353  * Tested build with Rust nightly-2021-07-15.
 354  * Dependencies on tera templating engine slightly rationalised.
 355  * Maekfile: avoid rebuilding the otter cli over and over again,
 356    by touching it when we rebuild it.
 357
 358
 359 Version 0.7.1 - 2021-06-09
 360 ==========================
 361
 362 Bugfixes
 363 --------
 364
 365  * `make shapelib` builds, and reports a URL for, the actual
 366    documentation for shape library layout and spec syntax, not to an
 367    obsolete location.
 368
 369 Installation and deployment changes
 370 -----------------------------------
 371
 372  * Better documentation of how to install just the command line
 373    game management client (eg for use via ssh).
 374
 375  * Update Rocket dependency in Cargo.lock to one which builds with
 376    recent Nightly Rust.
 377
 378  * Update usvg dependency in Cargo.toml to a version with revised
 379    less-insane command line parsing, and adjust all calls to it.
 380
 381  * Updated other dependencies.
 382
 383  * Work around a cargo bug which breaks the docs build:
 384     https://github.com/rust-lang/cargo/issues/9564
 385
 386 Installation and deployment changes
 387 -----------------------------------
 388
 389  * Improvements to release checklist and release script.  Notably,
 390    add a checklist item for checking the build on recent Nightly.
 391
 392
 393 Version 0.7.0 - 2021-06-08
 394 ==========================
 395
 396 New features
 397 ------------
 398
 399  * Game spec files can now be processed with Tera for templating.
 400
 401  * ssh-based access for `otter` cli, including appropriately-
 402    restricted access via authorized_keys in the server role account,
 403    and a mechanism for self-service public key management.
 404
 405  * `otter` cli can now read a preferences file
 406    (`~/.config/otter/prefs.toml` by default) to allow pre-configuring
 407    commonly-required command line options like `--game` and `--ssh`.
 408    See `otter --help` for documentation.
 409
 410  * Mao and Penultima slightly updated (and, those game specs now
 411    use the new templating feature).
 412
 413 Bugfixes
 414 --------
 415
 416  * UI: When multiple pieces are selected and are to be raised (whether
 417    by explicit request, or because of drag distance), their relative
 418    ordering is preserved.  So dragging a group of pieces no longer
 419    scrambles their z order.
 420
 421  * UI: When the SSE connection auto-reconnects, do not declare it an
 422    error and suggest to the user that reloading might help.  Instead,
 423    simply hope that it is going to be OK (since it generally is).  If
 424    the SSE connection declares failure (state 2), report a scarier
 425    message.
 426
 427  * Docs: Fixes to some documentation errors (including a fix
 428    contributed by Simon Tatham).
 429
 430  * CLI etc.: Improve a number of error messages; in particular,
 431    replace several "debug prints" of error messages with proper
 432    formatting, and print a better program kname.
 433
 434  * CLI: Much better handling of stdout write errors.
 435
 436 Installation and deployment changes
 437 -----------------------------------
 438
 439  * The `otter` command line utility is now in its own Rust package
 440    `otter-cli`.
 441
 442  * Better logging by server of events on command connections.
 443
 444 Internal and development changes
 445 --------------------------------
 446
 447  * make-release now polls crates.io's github view to work around
 448    cargo/crates.io bug https://github.com/rust-lang/cargo/issues/9507
 449    and has a release checklist in it.
 450
 451  * Some internal renamings for clarity, especially regarding
 452    Authorisation proof tokens.
 453
 454  * Reworked the types involved in management command channels, to
 455    use a different stacking of read/write adapters.  In particular,
 456    a new `childio` facility for handling conversations with a child
 457    process (in support of using `ssh` as a command conn transport).
 458
 459  * `otter` cli no longer uses println!.  Instead we have a special
 460    wrapper for stdout which handles the errors and buffering for us.
 461
 462  * `otter` cli subcommand dispatch made nicer and the program's code
 463    broken out into multiple files.
 464
 465  * Internal apitest case code restructured somewhat.
 466
 467
 468 Version 0.6.0 - 2021-05-23
 469 ==========================
 470
 471 New features
 472 ------------
 473
 474  * Support uploading bundles of game materials, so games can be played
 475    that are not playable with Otter's provided piece libraries.
 476
 477  * New `vatikan.game.toml`, suitable for many variants of
 478    Manipulation Rummy.
 479
 480  * New `private.table.toml` and `same-scope.table.toml` for
 481    less-public games.
 482
 483 Command line usage changes, etc.
 484 --------------------------------
 485
 486  * otter(1) now takes the game name using a `--game` (`-g`) global
 487    option rather than a per-subcommand positional argument.
 488
 489  * Library listing, piece identification, and so on, changed,
 490    including changes to `otter library-add` and `otter library-list`.
 491    Specifically, per-game libraries mean that `library-list` now
 492    needs the `--game` option.
 493
 494  * otter(1) and otterlib(!) now honour `OTTER_CLI_LOG`
 495    (in Rust env_logger format).
 496
 497  * otter(1) no longer acts on change_directory server config
 498    setting (but still resolves paths in config relative to that dir).
 499
 500  * Much better reporting of errors, especially from otter(1).
 501    Previously even straightforward errors would result in a controlled
 502    `panic`; now a prettier message is printed.
 503
 504  * Default table size is now 300,200 (like `penultima` and `mao`; was
 505    400,200).
 506
 507   * otter(1) can be used to issue adhoc management commands supplied
 508     on the command line in JSON or RON format.
 509
 510 Bugfixes
 511 --------
 512
 513  * Fix a serious bug with acl handling which might allow players who
 514    can access a game more access than intended.
 515
 516  * Occult ilks are properly sorted out during piece load and game
 517    save/load.  Previously a game with occulted pieces might not be
 518    reloadable.
 519
 520  * Test suite might previously fail with EBADF due to off-by-one error
 521    in fd cleanup routiine.
 522
 523 Documentation
 524 -------------
 525
 526  * Document uploadable bundle format.
 527
 528 n * Document game and piece spec format.
 529
 530  * Document shape library catalogue format (previously this was done
 531    with rustdoc annotations on Rust structs used with serde, which
 532    produced incomplete and very hard to understand information).
 533
 534  * De-emphasize docs for for amending the builtin shape libraries;
 535    suggest making bundles instead.
 536
 537  * Examples, of game specs, shape libs, buncdles.
 538
 539 Installation and deployment changes
 540 -----------------------------------
 541
 542  * usvg is now built shipped by the otter build system.
 543
 544  * server-config.toml can specify the path to `usvg`, `libexec`,
 545    etc.
 546
 547 Compatibility notes
 548 -------------------
 549
 550  * The otter(1) command line interface has changed and many common
 551    operations need to be specified differently.
 552
 553  * The management API protocol has completely changed.  Old otter(1)
 554    clients will not work.
 555
 556  * Savefiles from older versions of Otter are not loadable.
 557
 558 Internal and development changes
 559 --------------------------------
 560
 561  * Change CLI to server management wire protocol to binary-framed
 562    MessagePack (was newline-framed JSON).
 563
 564  * Update dependencies.
 565
 566  * Build system and test suite improvements and fixes.
 567
 568  * Move game spec parsing from client to server.
 569
 570  * Better error messages, especially from otter(1)
 571
 572  * Tests have better error reporting and output capturing.
 573
 574  * Various substantial refactorings to tests.
 575
 576  * Test the supplied game specs.
 577
 578  * Test game save/load.
 579
 580  * Use the sphinx feature sphinx.ext.autosectionlabel for xrefs.
 581
 582  * Server management channel now has an idle timout.  Should not be
 583    relevant with the supplied otter(1) client.
 584
 585  * Much internal refactoring, new macros etc., to support the other
 586    work.
 587
 588  * Reset game (game spec parsing and implemnetation) is now
 589    done in the server rather than the client.
 590
 591  * Improvements and bugfixes to `make-release` and `update-version`
 592    scripts.  Fix anomalous (but working) `Cargo.toml` version
 593    dependency syntax.
 594
 595 Version 0.5.1 - 2021-04-19
 596 ==========================
 597
 598 This was the first public release.
 599
 600 [comment]: # Local variables:
 601 [comment]: # mode: text
 602 [comment]: # End: