canonical-data.json

{
  "exercise": "react",
  "comments": [
    "Note that, due to the nature of this exercise,",
    "the tests are specified using their cells and a series of operations to perform on the cells.",
    "",
    "Each object in the `cells` array has a `name` and `type` (`input` or `output`).",
    "input cells have an `initial_value`, and compute cells have `inputs` and `compute_function`",
    "",
    "Each object in the `operations` array has a `type`.",
    "Depending on the type, it also has additional fields.",
    "The possible types and semantics of their fields are as follows:",
    "",
    "* expect_cell_value (`cell`, `value`): Expect that cell `cell` has value `value`.",
    "* set_value (`cell`, `value`, optionally `expect_callbacks`, `expect_callbacks_not_to_be_called`): Sets input cell `cell` to value `value`.",
    "  Expect that, as a result, all callbacks in `expect_callbacks` (if present) were called exactly once with the designated value",
    "  Expect that no callbacks in `expect_callbacks_not_to_be_called` (if present) were called as a result.",
    "* add_callback (`cell`, `name`): Adds a callback to cell `cell`. Store the callback ID in a variable named `name`.",
    "  all callbacks are assumed to simply store the values they're called with in some array.",
    "* remove_callback (`cell`, `name`): Removes the callback `name` from cell `cell`.",
    "",
    "Additional notes:",
    "",
    "These tests only describe compute cells with up to two inputs.",
    "Some languages may choose to have two functions: create_compute1 and create_compute2.",
    "The compiler can then ensure that you never pass a two-input function to a one-input compute cell.",
    "(This benefit only exists for statically typed languages).",
    "If your track does this, you should test that all combinations of",
    "(compute1, compute2) can depend on (input, compute1, compute2) are tested.",
    "Other languages simply have a single create_compute function, taking a list of input cells.",
    "Of the languages in this category, there are two subcategories:",
    "- In some languages, the compute function might take as many inputs as there are input cells.",
    "  (it might be very difficult to write the type signature for create_compute in statically typed languages!)",
    "- In other languages, the compute function might always take a single input (the list of values)",
    "  (again this gives up the ability to check that the arities match)",
    "Both subcategories using create_compute have the benefit of more flexibility in arity,",
    "fewer repetitive tests (only need to test that compute cells can depend on compute cells and input cells),",
    "and likely less repetitive code.",
    "",
    "Finally, note that all values are integers.",
    "If your language supports generics, you may consider allowing reactors to act on other types.",
    "Tests for that are not included here.",
    ""
  ],
  "cases": [
    {
      "uuid": "c51ee736-d001-4f30-88d1-0c8e8b43cd07",
      "description": "input cells have a value",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 10
          }
        ],
        "operations": [
          {
            "type": "expect_cell_value",
            "cell": "input",
            "value": 10
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "dedf0fe0-da0c-4d5d-a582-ffaf5f4d0851",
      "description": "an input cell's value can be set",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 4
          }
        ],
        "operations": [
          {
            "type": "set_value",
            "cell": "input",
            "value": 20
          },
          {
            "type": "expect_cell_value",
            "cell": "input",
            "value": 20
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "5854b975-f545-4f93-8968-cc324cde746e",
      "description": "compute cells calculate initial value",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "expect_cell_value",
            "cell": "output",
            "value": 2
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "25795a3d-b86c-4e91-abe7-1c340e71560c",
      "description": "compute cells take inputs in the right order",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "one",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "two",
            "type": "input",
            "initial_value": 2
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["one", "two"],
            "compute_function": "inputs[0] + inputs[1] * 10"
          }
        ],
        "operations": [
          {
            "type": "expect_cell_value",
            "cell": "output",
            "value": 21
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "c62689bf-7be5-41bb-b9f8-65178ef3e8ba",
      "description": "compute cells update value when dependencies are changed",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "set_value",
            "cell": "input",
            "value": 3
          },
          {
            "type": "expect_cell_value",
            "cell": "output",
            "value": 4
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "5ff36b09-0a88-48d4-b7f8-69dcf3feea40",
      "description": "compute cells can depend on other compute cells",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "times_two",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] * 2"
          },
          {
            "name": "times_thirty",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] * 30"
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["times_two", "times_thirty"],
            "compute_function": "inputs[0] + inputs[1]"
          }
        ],
        "operations": [
          {
            "type": "expect_cell_value",
            "cell": "output",
            "value": 32
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 3
          },
          {
            "type": "expect_cell_value",
            "cell": "output",
            "value": 96
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "abe33eaf-68ad-42a5-b728-05519ca88d2d",
      "description": "compute cells fire callbacks",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 3,
            "expect_callbacks": {
              "callback1": 4
            }
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "9e5cb3a4-78e5-4290-80f8-a78612c52db2",
      "description": "callback cells only fire on change",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "if inputs[0] < 3 then 111 else 222"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 2,
            "expect_callbacks_not_to_be_called": ["callback1"]
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 4,
            "expect_callbacks": {
              "callback1": 222
            }
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "ada17cb6-7332-448a-b934-e3d7495c13d3",
      "description": "callbacks do not report already reported values",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 2,
            "expect_callbacks": {
              "callback1": 3
            }
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 3,
            "expect_callbacks": {
              "callback1": 4
            }
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "ac271900-ea5c-461c-9add-eeebcb8c03e5",
      "description": "callbacks can fire from multiple cells",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "plus_one",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          },
          {
            "name": "minus_one",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] - 1"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "plus_one",
            "name": "callback1"
          },
          {
            "type": "add_callback",
            "cell": "minus_one",
            "name": "callback2"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 10,
            "expect_callbacks": {
              "callback1": 11,
              "callback2": 9
            }
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "95a82dcc-8280-4de3-a4cd-4f19a84e3d6f",
      "description": "callbacks can be added and removed",
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 11
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback2"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 31,
            "expect_callbacks": {
              "callback1": 32,
              "callback2": 32
            }
          },
          {
            "type": "remove_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback3"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 41,
            "expect_callbacks": {
              "callback2": 42,
              "callback3": 42
            },
            "expect_callbacks_not_to_be_called": ["callback1"]
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "f2a7b445-f783-4e0e-8393-469ab4915f2a",
      "description": "removing a callback multiple times doesn't interfere with other callbacks",
      "comments": [
        "Some incorrect implementations store their callbacks in an array",
        "and removing a callback repeatedly either removes an unrelated callback",
        "or causes an out of bounds access."
      ],
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback2"
          },
          {
            "type": "remove_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "remove_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "remove_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 2,
            "expect_callbacks": {
              "callback2": 3
            },
            "expect_callbacks_not_to_be_called": ["callback1"]
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "daf6feca-09e0-4ce5-801d-770ddfe1c268",
      "description": "callbacks should only be called once even if multiple dependencies change",
      "comments": [
        "Some incorrect implementations call a callback function too early,",
        "when not all of the inputs of a compute cell have propagated new values."
      ],
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "plus_one",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          },
          {
            "name": "minus_one1",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] - 1"
          },
          {
            "name": "minus_one2",
            "type": "compute",
            "inputs": ["minus_one1"],
            "compute_function": "inputs[0] - 1"
          },
          {
            "name": "output",
            "type": "compute",
            "inputs": ["plus_one", "minus_one2"],
            "compute_function": "inputs[0] * inputs[1]"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "output",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 4,
            "expect_callbacks": {
              "callback1": 10
            }
          }
        ]
      },
      "expected": {}
    },
    {
      "uuid": "9a5b159f-b7aa-4729-807e-f1c38a46d377",
      "description": "callbacks should not be called if dependencies change but output value doesn't change",
      "comments": [
        "Some incorrect implementations simply mark a compute cell as dirty when a dependency changes,",
        "then call callbacks on all dirty cells.",
        "This is incorrect since the specification indicates only to call callbacks on change."
      ],
      "property": "react",
      "input": {
        "cells": [
          {
            "name": "input",
            "type": "input",
            "initial_value": 1
          },
          {
            "name": "plus_one",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] + 1"
          },
          {
            "name": "minus_one",
            "type": "compute",
            "inputs": ["input"],
            "compute_function": "inputs[0] - 1"
          },
          {
            "name": "always_two",
            "type": "compute",
            "inputs": ["plus_one", "minus_one"],
            "compute_function": "inputs[0] - inputs[1]"
          }
        ],
        "operations": [
          {
            "type": "add_callback",
            "cell": "always_two",
            "name": "callback1"
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 2,
            "expect_callbacks_not_to_be_called": ["callback1"]
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 3,
            "expect_callbacks_not_to_be_called": ["callback1"]
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 4,
            "expect_callbacks_not_to_be_called": ["callback1"]
          },
          {
            "type": "set_value",
            "cell": "input",
            "value": 5,
            "expect_callbacks_not_to_be_called": ["callback1"]
          }
        ]
      },
      "expected": {}
    }
  ]
}