@callstack/reassure-measure/lib/commonjs/measure-renders.js

Performance measurement library for React and React Native

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.buildUiToRender = buildUiToRender;
exports.measurePerformance = measurePerformance;
exports.measureRenders = measureRenders;
var React = _interopRequireWildcard(require("react"));
var logger = _interopRequireWildcard(require("@callstack/reassure-logger"));
var _config = require("./config");
var _measureHelpers = require("./measure-helpers");
var _output = require("./output");
var _polyfills = require("./polyfills");
var _redundantRenders = require("./redundant-renders");
var _testingLibrary = require("./testing-library");
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
logger.configure({
  verbose: process.env.REASSURE_VERBOSE === 'true' || process.env.REASSURE_VERBOSE === '1',
  silent: process.env.REASSURE_SILENT === 'true' || process.env.REASSURE_SILENT === '1'
});
async function measureRenders(ui, options) {
  const stats = await measureRendersInternal(ui, options);
  if (options?.writeFile !== false) {
    await (0, _output.writeTestStats)(stats, 'render');
  }
  return stats;
}

/**
 * @deprecated The `measurePerformance` function has been renamed to `measureRenders`. The `measurePerformance` alias is now deprecated and will be removed in future releases.
 */
async function measurePerformance(ui, options) {
  logger.warnOnce('The `measurePerformance` function has been renamed to `measureRenders`.\n\nThe `measurePerformance` alias is now deprecated and will be removed in future releases.');
  return await measureRenders(ui, options);
}
async function measureRendersInternal(ui, options) {
  const runs = options?.runs ?? _config.config.runs;
  const scenario = options?.scenario;
  const warmupRuns = options?.warmupRuns ?? _config.config.warmupRuns;
  const removeOutliers = options?.removeOutliers ?? _config.config.removeOutliers;
  const {
    render,
    cleanup
  } = (0, _testingLibrary.resolveTestingLibrary)();
  const testingLibrary = (0, _testingLibrary.getTestingLibrary)();
  (0, _output.showFlagsOutputIfNeeded)();
  (0, _polyfills.applyRenderPolyfills)();
  const runResults = [];
  const renderJsonTrees = [];
  let initialRenderCount = 0;
  for (let iteration = 0; iteration < runs + warmupRuns; iteration += 1) {
    await options?.beforeEach?.();
    let duration = 0;
    let count = 0;
    let renderResult = null;
    const captureRenderDetails = () => {
      // We capture render details only on the first run
      if (iteration !== 0) {
        return;
      }

      // Initial render did not finish yet, so there is no "render" result yet and we cannot analyze the element tree.
      if (renderResult == null) {
        initialRenderCount += 1;
        return;
      }
      if (testingLibrary === 'react-native') {
        renderJsonTrees.push(renderResult.toJSON());
      }
    };
    const handleRender = (_id, _phase, actualDuration) => {
      duration += actualDuration;
      count += 1;
      captureRenderDetails();
    };
    const uiToRender = buildUiToRender(ui, handleRender, options?.wrapper);
    renderResult = render(uiToRender);
    captureRenderDetails();
    if (scenario) {
      await scenario(renderResult);
    }
    cleanup();
    global.gc?.();
    await options?.afterEach?.();
    runResults.push({
      duration,
      count
    });
  }
  (0, _polyfills.revertRenderPolyfills)();
  return {
    ...(0, _measureHelpers.processRunResults)(runResults, {
      warmupRuns,
      removeOutliers
    }),
    issues: {
      initialUpdateCount: initialRenderCount - 1,
      redundantUpdates: (0, _redundantRenders.detectRedundantUpdates)(renderJsonTrees, initialRenderCount)
    }
  };
}
function buildUiToRender(ui, onRender, Wrapper) {
  const uiWithProfiler = /*#__PURE__*/React.createElement(React.Profiler, {
    id: "REASSURE_ROOT",
    onRender: onRender
  }, ui);
  return Wrapper ? /*#__PURE__*/React.createElement(Wrapper, null, uiWithProfiler) : uiWithProfiler;
}
//# sourceMappingURL=measure-renders.js.map