visit.js

/**
 * @copyright Copyright 2021 Kevin Locke <kevin@kevinlocke.name>
 * @license MIT
 * @module "openapi-transformer-base/visit.js"
 */

'use strict';

const assert = require('node:assert');

const toJsonPointer = require('./lib/to-json-pointer.js');

/** Visits a property being transformed by an OpenApiTransformerBase by adding
 * its name to transformPath while calling a given method with a given value.
 *
 * @template ArgsType, TransformedType
 * @param {!module:openapi-transformer-base} transformer Transformer on which
 * transformPath will be modified.
 * @param {function(this:!module:openapi-transformer-base, ...ArgsType):
 * TransformedType} method Method to be called.
 * @param {string} propName Name of property being visited.
 * @param {ArgsType} args Argument to method (usually property value).
 * @returns {TransformedType} Result of calling method on args.
 */
module.exports =
function visit(transformer, method, propName, ...args) {
  transformer.transformPath.push(propName);

  let handlingException = false;
  try {
    return method.apply(transformer, args);
  } catch (err) {
    handlingException = true;
    if (err instanceof Error && !Object.hasOwn(err, 'transformPath')) {
      err.transformPath = [...transformer.transformPath];
      err.message +=
        ` (while transforming ${toJsonPointer(err.transformPath)})`;
    }

    throw err;
  } finally {
    const popProp = transformer.transformPath.pop();

    // Avoid clobbering an exception which is already propagating
    if (!handlingException) {
      assert.strictEqual(popProp, propName);
    }
  }
};