squiggle/packages/squiggle-lang/__tests__/TS/TestHelpers.ts

import {
  run,
  runPartial,
  bindings,
  squiggleExpression,
  errorValueToString,
  defaultImports,
  defaultBindings,
  jsImports,
} from "../../src/js/index";

export function testRun(
  x: string,
  bindings: bindings = defaultBindings,
  imports: jsImports = defaultImports
): squiggleExpression {
  let squiggleResult = run(
    x,
    bindings,
    {
      sampleCount: 1000,
      xyPointLength: 100,
    },
    imports
  );
  if (squiggleResult.tag === "Ok") {
    return squiggleResult.value;
  } else {
    throw new Error(
      `Expected squiggle expression to evaluate but got error: ${errorValueToString(
        squiggleResult.value
      )}`
    );
  }
}

export function testRunPartial(
  x: string,
  bindings: bindings = defaultBindings,
  imports: jsImports = defaultImports
): bindings {
  let squiggleResult = runPartial(
    x,
    bindings,
    {
      sampleCount: 1000,
      xyPointLength: 100,
    },
    imports
  );
  if (squiggleResult.tag === "Ok") {
    return squiggleResult.value;
  } else {
    throw new Error(
      `Expected squiggle expression to evaluate but got error: ${errorValueToString(
        squiggleResult.value
      )}`
    );
  }
}

export function failDefault() {
  expect("be reached").toBe("codepath should never");
}

/**
 * This appears also in `TestHelpers.res`. According to https://www.math.net/percent-error, it computes
 * absolute error when numerical stability concerns make me not want to compute relative error.
 * */
export function expectErrorToBeBounded(
  received: number,
  expected: number,
  epsilon: number,
  digits: number
) {
  let distance = Math.abs(received - expected);
  let expectedAbs = Math.abs(expected);
  let normalizingDenom = Math.max(expectedAbs, 1);
  let error = distance / normalizingDenom;
  expect(Math.round(10 ** digits * error) / 10 ** digits).toBeLessThanOrEqual(
    epsilon
  );
}