Global State

devContext

Setting devContext(true) bypasses try catch (err) code block and in some cases enables enhanced logging

getDevContext(true);

---

getState

Returns a deep copy of tournamentRecords which have been loaded, along with currently selected tournamentId.

const { tournamentId, tournamentRecords } = getState({
  convertExtensions, // optional - convert extensions to '_' prefixed attributes
  removeExtensions, // optional - strip all extensions out of tournamentRecord
});

---

removeTournamentRecord

Removes a tournamentRecord from shared state.

removeTournamentRecord(tournamentId);

---

setState

Loads tournament records into Global State; supports both an array of tournamentRecords and an object with tournamentId keys.

const tournamentRecords = [tournamentRecord];
// or const tournamentRecords = { [tournamentId]: tournamentRecord }

setsState(tournamentRecords, deepCopy, deepCopyConfig);

info

By default a deep copy of the tournamentRecords is made so that mutations do not affect the source objects. An optional boolean parameter, deepCopy can be set to false to override this default behavior.

note

deepCopyConfig is an optional configuration for makeDeepCopy. In server configurations when deepCopy is FALSE and tournamentRecords are retrieved from Mongo, for instance, there are scenarios where nodes of the JSON structure contain prototypes which cannot be converted.

const deepCopyConfig = {
  ignore, // optional - either an array of attributes to ignore or a function which processes attributes to determine whether to ignore them
  toJSON, // optional - an array of attributes to convert to JSON if the attribute in question is an object with .toJSON property
  stringify, // optional - an array of attributes to stringify
  modulate, // optional - function to process every attribute and return custom values, or undefined, which continues normal processing
};

---

setTournamentRecord

Adds a tournamentRecord to shared engine state, or overwrite/replace an existing tournamentRecord with the same tournamentId.

setTournamentRecord(tournamentRecord);

---

setTournamentId

Sets a tournamentRecord in shared state as the 'default' tournament for invoked functions.

setTournamentId(tournamentId);

---

setOutcomePipeline

Sets which outcome pipeline implementation decides, process-wide: 'v1' (the default), 'v2' or 'differential'. No argument restores 'v1'; any other value is refused with INVALID_VALUES. Engines expose the same setting as engine.outcomePipeline, which is the usual way to reach it; getOutcomePipeline() returns the current mode. Added in 7.5.0.

import { globalState } from 'tods-competition-factory';

globalState.setOutcomePipeline('differential');
globalState.setOutcomePipeline(); // back to 'v1'

---

setInvokeObserver

Registers a process-wide observer of every engine method execution. It is called with phase: 'before' and the caller's params, then with phase: 'after' and the result, along with methodName and engineType. Nothing in production sets it: it exists for the golden corpus recorder, which uses it to harvest the test suite into scenarios. An observer that calls engine queries from its after phase must guard its own re-entrancy, because those calls are observed too. No argument removes the observer; a non-function is refused with INVALID_VALUES. Added in 7.5.0.

import { globalState } from 'tods-competition-factory';

globalState.setInvokeObserver(({ phase, methodName }) => console.log(phase, methodName));
globalState.setInvokeObserver(); // remove

---