murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 1 | /** |
| 2 | * @license |
Craig Tiller | 6169d5f | 2016-03-31 07:46:18 -0700 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
murgatroid99 | dca966d | 2015-02-19 14:37:18 -0800 | [diff] [blame] | 34 | 'use strict'; |
| 35 | |
murgatroid99 | 6d6009f | 2015-10-15 09:57:31 -0700 | [diff] [blame] | 36 | var path = require('path'); |
murgatroid99 | 6f60766 | 2016-04-27 16:38:33 -0700 | [diff] [blame] | 37 | var fs = require('fs'); |
murgatroid99 | 6d6009f | 2015-10-15 09:57:31 -0700 | [diff] [blame] | 38 | |
| 39 | var SSL_ROOTS_PATH = path.resolve(__dirname, '..', '..', 'etc', 'roots.pem'); |
| 40 | |
murgatroid99 | 55739d5 | 2015-06-03 10:58:21 -0700 | [diff] [blame] | 41 | var _ = require('lodash'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 42 | |
| 43 | var ProtoBuf = require('protobufjs'); |
| 44 | |
murgatroid99 | e787955 | 2015-02-12 12:21:15 -0800 | [diff] [blame] | 45 | var client = require('./src/client.js'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 46 | |
murgatroid99 | e787955 | 2015-02-12 12:21:15 -0800 | [diff] [blame] | 47 | var server = require('./src/server.js'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 48 | |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 49 | var common = require('./src/common.js'); |
| 50 | |
murgatroid99 | 84e3cde | 2015-08-20 11:27:05 -0700 | [diff] [blame] | 51 | var Metadata = require('./src/metadata.js'); |
| 52 | |
murgatroid99 | e190f35 | 2016-01-20 13:52:08 -0800 | [diff] [blame] | 53 | var grpc = require('./src/grpc_extension'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 54 | |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 55 | var protobuf_js_5_common = require('./src/protobuf_js_5_common'); |
| 56 | var protobuf_js_6_common = require('./src/protobuf_js_6_common'); |
| 57 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 58 | var constants = require('./src/constants.js'); |
| 59 | |
murgatroid99 | 6f60766 | 2016-04-27 16:38:33 -0700 | [diff] [blame] | 60 | grpc.setDefaultRootsPem(fs.readFileSync(SSL_ROOTS_PATH, 'ascii')); |
| 61 | |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 62 | /** |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 63 | * @namespace grpc |
| 64 | */ |
| 65 | |
| 66 | /** |
| 67 | * Load a ProtoBuf.js object as a gRPC object. |
| 68 | * @memberof grpc |
| 69 | * @alias grpc.loadObject |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 70 | * @param {Object} value The ProtoBuf.js reflection object to load |
| 71 | * @param {Object=} options Options to apply to the loaded file |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 72 | * @param {bool=} [options.binaryAsBase64=false] deserialize bytes values as |
| 73 | * base64 strings instead of Buffers |
| 74 | * @param {bool=} [options.longsAsStrings=true] deserialize long values as |
| 75 | * strings instead of objects |
| 76 | * @param {bool=} [options.enumsAsStrings=true] deserialize enum values as |
| 77 | * strings instead of numbers. Only works with Protobuf.js 6 values. |
| 78 | * @param {bool=} [options.deprecatedArgumentOrder=false] use the beta method |
| 79 | * argument order for client methods, with optional arguments after the |
| 80 | * callback. This option is only a temporary stopgap measure to smooth an |
| 81 | * API breakage. It is deprecated, and new code should not use it. |
| 82 | * @param {(number|string)=} [options.protobufjsVersion='detect'] 5 and 6 |
| 83 | * respectively indicate that an object from the corresponding version of |
| 84 | * Protobuf.js is provided in the value argument. If the option is 'detect', |
| 85 | * gRPC wll guess what the version is based on the structure of the value. |
| 86 | * @return {Object<string, *>} The resulting gRPC object. |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 87 | */ |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 88 | exports.loadObject = function loadObject(value, options) { |
murgatroid99 | b1a0231 | 2017-03-17 13:45:15 -0700 | [diff] [blame] | 89 | options = _.defaults(options, common.defaultGrpcOptions); |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 90 | options = _.defaults(options, {'protobufjsVersion': 'detect'}); |
| 91 | var protobufjsVersion; |
| 92 | if (options.protobufjsVersion === 'detect') { |
| 93 | if (protobuf_js_6_common.isProbablyProtobufJs6(value)) { |
| 94 | protobufjsVersion = 6; |
| 95 | } else if (protobuf_js_5_common.isProbablyProtobufJs5(value)) { |
| 96 | protobufjsVersion = 5; |
| 97 | } else { |
| 98 | var error_message = 'Could not detect ProtoBuf.js version. Please ' + |
| 99 | 'specify the version number with the "protobufjs_version" option'; |
| 100 | throw new Error(error_message); |
| 101 | } |
murgatroid99 | b1a0231 | 2017-03-17 13:45:15 -0700 | [diff] [blame] | 102 | } else { |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 103 | protobufjsVersion = options.protobufjsVersion; |
| 104 | } |
| 105 | switch (protobufjsVersion) { |
| 106 | case 6: return protobuf_js_6_common.loadObject(value, options); |
| 107 | case 5: |
murgatroid99 | b1a0231 | 2017-03-17 13:45:15 -0700 | [diff] [blame] | 108 | return protobuf_js_5_common.loadObject(value, options); |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 109 | default: |
| 110 | throw new Error('Unrecognized protobufjsVersion', protobufjsVersion); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 111 | } |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | var loadObject = exports.loadObject; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 115 | |
| 116 | /** |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 117 | * Load a gRPC object from a .proto file. |
| 118 | * @memberof grpc |
| 119 | * @alias grpc.load |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 120 | * @param {string|{root: string, file: string}} filename The file to load |
murgatroid99 | 71dbb86 | 2015-04-20 11:22:51 -0700 | [diff] [blame] | 121 | * @param {string=} format The file format to expect. Must be either 'proto' or |
| 122 | * 'json'. Defaults to 'proto' |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 123 | * @param {Object=} options Options to apply to the loaded file |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 124 | * @param {bool=} [options.convertFieldsToCamelCase=false] Load this file with |
| 125 | * field names in camel case instead of their original case |
| 126 | * @param {bool=} [options.binaryAsBase64=false] deserialize bytes values as |
| 127 | * base64 strings instead of Buffers |
| 128 | * @param {bool=} [options.longsAsStrings=true] deserialize long values as |
| 129 | * strings instead of objects |
| 130 | * @param {bool=} [options.deprecatedArgumentOrder=false] use the beta method |
| 131 | * argument order for client methods, with optional arguments after the |
| 132 | * callback. This option is only a temporary stopgap measure to smooth an |
| 133 | * API breakage. It is deprecated, and new code should not use it. |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 134 | * @return {Object<string, *>} The resulting gRPC object |
| 135 | */ |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 136 | exports.load = function load(filename, format, options) { |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 137 | options = _.defaults(options, common.defaultGrpcOptions); |
murgatroid99 | b1c69e4 | 2017-05-02 14:01:35 -0700 | [diff] [blame] | 138 | options.protobufjsVersion = 5; |
| 139 | if (!format) { |
| 140 | format = 'proto'; |
| 141 | } |
| 142 | var convertFieldsToCamelCaseOriginal = ProtoBuf.convertFieldsToCamelCase; |
| 143 | if(options && options.hasOwnProperty('convertFieldsToCamelCase')) { |
| 144 | ProtoBuf.convertFieldsToCamelCase = options.convertFieldsToCamelCase; |
| 145 | } |
| 146 | var builder; |
| 147 | try { |
| 148 | switch(format) { |
| 149 | case 'proto': |
| 150 | builder = ProtoBuf.loadProtoFile(filename); |
| 151 | break; |
| 152 | case 'json': |
| 153 | builder = ProtoBuf.loadJsonFile(filename); |
| 154 | break; |
| 155 | default: |
| 156 | throw new Error('Unrecognized format "' + format + '"'); |
| 157 | } |
| 158 | } finally { |
| 159 | ProtoBuf.convertFieldsToCamelCase = convertFieldsToCamelCaseOriginal; |
| 160 | } |
| 161 | return loadObject(builder.ns, options); |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 162 | }; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 163 | |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 164 | var log_template = _.template( |
| 165 | '{severity} {timestamp}\t{file}:{line}]\t{message}', |
| 166 | {interpolate: /{([\s\S]+?)}/g}); |
| 167 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 168 | /** |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 169 | * Sets the logger function for the gRPC module. For debugging purposes, the C |
| 170 | * core will log synchronously directly to stdout unless this function is |
| 171 | * called. Note: the output format here is intended to be informational, and |
| 172 | * is not guaranteed to stay the same in the future. |
| 173 | * Logs will be directed to logger.error. |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 174 | * @memberof grpc |
| 175 | * @alias grpc.setLogger |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 176 | * @param {Console} logger A Console-like object. |
| 177 | */ |
| 178 | exports.setLogger = function setLogger(logger) { |
| 179 | common.logger = logger; |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 180 | grpc.setDefaultLoggerCallback(function(file, line, severity, |
| 181 | message, timestamp) { |
| 182 | logger.error(log_template({ |
| 183 | file: path.basename(file), |
| 184 | line: line, |
| 185 | severity: severity, |
| 186 | message: message, |
| 187 | timestamp: timestamp.toISOString() |
| 188 | })); |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 189 | }); |
| 190 | }; |
| 191 | |
| 192 | /** |
| 193 | * Sets the logger verbosity for gRPC module logging. The options are members |
| 194 | * of the grpc.logVerbosity map. |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 195 | * @memberof grpc |
| 196 | * @alias grpc.setLogVerbosity |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 197 | * @param {Number} verbosity The minimum severity to log |
| 198 | */ |
| 199 | exports.setLogVerbosity = function setLogVerbosity(verbosity) { |
| 200 | common.logVerbosity = verbosity; |
| 201 | grpc.setLogVerbosity(verbosity); |
| 202 | }; |
| 203 | |
murgatroid99 | 366e64d | 2015-07-15 17:01:49 -0700 | [diff] [blame] | 204 | exports.Server = server.Server; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 205 | |
murgatroid99 | 84e3cde | 2015-08-20 11:27:05 -0700 | [diff] [blame] | 206 | exports.Metadata = Metadata; |
| 207 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 208 | exports.status = constants.status; |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 209 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 210 | exports.propagate = constants.propagate; |
murgatroid99 | 0b09457 | 2015-08-14 10:48:45 -0700 | [diff] [blame] | 211 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 212 | exports.callError = constants.callError; |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 213 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 214 | exports.writeFlags = constants.writeFlags; |
murgatroid99 | 4a1474f | 2015-08-17 14:00:31 -0700 | [diff] [blame] | 215 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame] | 216 | exports.logVerbosity = constants.logVerbosity; |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 217 | |
murgatroid99 | 153b09d | 2015-09-25 16:04:03 -0700 | [diff] [blame] | 218 | exports.credentials = require('./src/credentials.js'); |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 219 | |
| 220 | /** |
| 221 | * ServerCredentials factories |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 222 | * @constructor ServerCredentials |
| 223 | * @memberof grpc |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 224 | */ |
| 225 | exports.ServerCredentials = grpc.ServerCredentials; |
murgatroid99 | 8c3ed00 | 2015-02-18 15:00:56 -0800 | [diff] [blame] | 226 | |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 227 | /** |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 228 | * Create insecure server credentials |
| 229 | * @name grpc.ServerCredentials.createInsecure |
| 230 | * @kind function |
| 231 | * @return grpc.ServerCredentials |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 232 | */ |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 233 | |
| 234 | /** |
| 235 | * A private key and certificate pair |
| 236 | * @typedef {Object} grpc.ServerCredentials~keyCertPair |
| 237 | * @property {Buffer} privateKey The server's private key |
| 238 | * @property {Buffer} certChain The server's certificate chain |
| 239 | */ |
| 240 | |
| 241 | /** |
| 242 | * Create SSL server credentials |
| 243 | * @name grpc.ServerCredentials.createInsecure |
| 244 | * @kind function |
| 245 | * @param {?Buffer} rootCerts Root CA certificates for validating client |
| 246 | * certificates |
| 247 | * @param {Array<grpc.ServerCredentials~keyCertPair>} keyCertPairs A list of |
| 248 | * private key and certificate chain pairs to be used for authenticating |
| 249 | * the server |
| 250 | * @param {boolean} [checkClientCertificate=false] Indicates that the server |
| 251 | * should request and verify the client's certificates |
| 252 | * @return grpc.ServerCredentials |
| 253 | */ |
| 254 | |
murgatroid99 | e023e98 | 2015-03-18 17:17:33 -0700 | [diff] [blame] | 255 | exports.makeGenericClientConstructor = client.makeClientConstructor; |
murgatroid99 | 76ba1ff | 2015-08-28 14:57:04 -0700 | [diff] [blame] | 256 | |
murgatroid99 | 76ba1ff | 2015-08-28 14:57:04 -0700 | [diff] [blame] | 257 | exports.getClientChannel = client.getClientChannel; |
| 258 | |
murgatroid99 | 76ba1ff | 2015-08-28 14:57:04 -0700 | [diff] [blame] | 259 | exports.waitForClientReady = client.waitForClientReady; |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame] | 260 | |
murgatroid99 | c92df4c | 2017-05-23 10:28:47 -0700 | [diff] [blame] | 261 | /** |
| 262 | * @memberof grpc |
| 263 | * @alias grpc.closeClient |
| 264 | * @param {grpc.Client} client_obj The client to close |
| 265 | */ |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame] | 266 | exports.closeClient = function closeClient(client_obj) { |
murgatroid99 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 267 | client.Client.prototype.close.apply(client_obj); |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame] | 268 | }; |
murgatroid99 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 269 | |
murgatroid99 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 270 | exports.Client = client.Client; |