dce-expresskit/src/helpers/visitEndpointOnAnotherServer/index.ts

Shared functions, helpers, and tools for Harvard DCE Express-based servers

// Import dce-commonkit
import {
  ErrorWithCode,
  CommonKitErrorCode,
} from 'dce-commonkit';

// Import shared types
import sendServerToServerRequest from './sendServerToServerRequest';

/*------------------------------------------------------------------------*/
/* -------------------------------- Main -------------------------------- */
/*------------------------------------------------------------------------*/

/**
 * Visit an endpoint on another server
 * @author Gabe Abrams
 * @param opts object containing all arguments
 * @param opts.method the method of the endpoint
 * @param opts.path the path of the other server's endpoint
 * @param opts.host the host of the other server
 * @param [opts.params={}] query/body parameters to include
 * @param [opts.responseType=JSON] the response type from the other server
 * @param [opts.dceKitCrossServerCredentials] additional cross-server credentials
 *   that aren't in the env var list
 * @returns the body of the response from the other server
 */
const visitEndpointOnAnotherServer = async (
  opts: {
    method: 'GET' | 'POST' | 'DELETE' | 'PUT',
    path: string,
    host: string,
    params?: { [key in string]: any },
    responseType?: 'JSON' | 'Text',
    dceKitCrossServerCredentials?: string,
  },
): Promise<any> => {
  // Sanitize params: remove undefined values
  const sanitizedParams: { [key in string]: any } = {};
  Object.keys(opts.params ?? {}).forEach((key) => {
    const value = opts.params?.[key];
    if (value !== undefined) {
      sanitizedParams[key] = value;
    }
  });

  // Send the request
  const response = await sendServerToServerRequest({
    path: opts.path,
    host: opts.host,
    method: opts.method,
    params: sanitizedParams,
    responseType: opts.responseType,
    dceKitCrossServerCredentials: opts.dceKitCrossServerCredentials,
  });

  // Check for failure
  if (!response || !response.body) {
    throw new ErrorWithCode(
      'We didn\'t get a response from the other server. Please check the network between the two servers.',
      CommonKitErrorCode.NoResponse,
    );
  }
  if (!response.body.success) {
    // Other errors
    throw new ErrorWithCode(
      (
        response.body.message
        || 'An unknown error occurred. Please contact an admin.'
      ),
      (
        response.body.code
        || CommonKitErrorCode.NoCode
      ),
    );
  }

  // Success! Extract the body
  const { body } = response.body;

  // Return
  return body;
};

export default visitEndpointOnAnotherServer;