src/index.ts

// Copyright 2015 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import {DebugAgentConfig, StackdriverConfig} from './agent/config';
import {Debuglet, IsReady} from './agent/debuglet';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const pjson = require('../../package.json');

import * as util from 'util';
const debuglog = util.debuglog('cdbg');

// Singleton.
let debuglet: Debuglet | undefined;

/**
 * Start the Debug agent that will make your application available for debugging
 * with Stackdriver Debug.
 *
 * @param options - Authentication and agent configuration.
 *
 * @resource [Introductory video]{@link
 * https://www.youtube.com/watch?v=tyHcK_kAOpw}
 *
 * @example
 * ```
 * debug.start();
 * ```
 */
export function start(
  options?: DebugAgentConfig | StackdriverConfig
): Debuglet | IsReady {
  options = options || {};
  const agentConfig: DebugAgentConfig = mergeConfigs(options);

  // forceNewAgent_ is for testing purposes only.
  if (debuglet && !agentConfig.forceNewAgent_) {
    throw new Error('Debug Agent has already been started');
  }

  debuglog('Running with firebase backend.');
  debuglet = new Debuglet(pjson, agentConfig);

  debuglet.start();

  return agentConfig.testMode_ ? debuglet : debuglet.isReadyManager;
}

/**
 * If the given `options` object has a `debug` property
 * of the same type, this function returns the union of the
 * properties in `options.debug` and `options` except that
 * the returned object no longer has a `debug` property.
 * If a field exists in both `options` and `options.debug`,
 * the value in `option.debug` takes precedence.
 */
function mergeConfigs<T>(options: T & {debug?: T}): T {
  if (!options.debug) {
    return options;
  }
  const result = Object.assign({}, options);
  delete result.debug;
  return Object.assign(result, options.debug);
}

/* Used to access the agent if it has been started.  Returns the agent
 * if the agent has been started.  Otherwise, `undefined` is returned.
 */
export function get(): Debuglet | undefined {
  return debuglet;
}

/**
 * Cleanly shut down the debug agent.
 *
 * This will free up all resources.  It may be necessary to call this to allow
 * your process to shut down cleanly.
 */
export function stop(): void {
  debuglet?.stop();
  debuglet = undefined;
}