debuggee.js

/**
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * 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.
 */
'use strict';

var pjson = require('../package.json');
var _ = require('lodash');

/**
 * Creates a Debuggee service object.
 * @ref https://cloud.google.com/debugger/api/reference/rest/v2/Debuggee
 *
 * @param {object} properties - an object with properties to use for Debuggee
 *     initialization.
 * @param {object} properties.project - Google Cloud Project ID
 * @param {string} properties.uniquifier - Debuggee uniquifier within the
 *     project. Any string that identifies the application within the project
 *     can be used. Including environment and version or build IDs is
 *     recommended.
 * @param {string} properties.description - A user specified string identifying
 *     this debuggable instance.
 * @param {?string} properties.agentVersion - version ID of the agent. (default:
 *     the version of this module)
 * @param {?object} labels - a set of custom properties about the debuggee that
 *     are reported to the service.
 * @param {?array<object>} properties.sourceContexts
 * @param {?StatusMessage} properties.statusMessage - A error string to register
 *     this as an erroring debuggable instance. This is useful if we have a
 *     problem starting the debugger support, and want to report to the API so
 *     that the user has a way of noticing.
 *     TODO(ofrobots): has this been renamed to `status` in the API?
 */
function Debuggee(properties) {
  if (!(this instanceof Debuggee)) {
    return new Debuggee(properties);
  }

  properties = properties || {};

  if (!_.isString(properties.project)) {
    throw new Error('properties.project must be a string');
  }
  if (!_.isString(properties.uniquifier)) {
    throw new Error('properties.uniquifier must be a string');
  }
  if (!_.isString(properties.description)) {
    throw new Error('properties.description must be a string');
  }

  this.project = properties.project;
  this.uniquifier = properties.uniquifier;
  this.description = properties.description;
  this.agentVersion =
      properties.agentVersion || (pjson.name + '/client/v' + pjson.version);
  if (properties.labels) {
    this.labels = properties.labels;
  }
  if (properties.sourceContexts) {
    this.sourceContexts = properties.sourceContexts;
  }
  if (properties.statusMessage) {
    this.statusMessage = properties.statusMessage;
  }
}

module.exports = Debuggee;