murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
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 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 34 | /** |
| 35 | * @module |
| 36 | */ |
| 37 | |
murgatroid99 | dca966d | 2015-02-19 14:37:18 -0800 | [diff] [blame] | 38 | 'use strict'; |
| 39 | |
murgatroid99 | 6d6009f | 2015-10-15 09:57:31 -0700 | [diff] [blame] | 40 | var path = require('path'); |
murgatroid99 | 6f60766 | 2016-04-27 16:38:33 -0700 | [diff] [blame] | 41 | var fs = require('fs'); |
murgatroid99 | 6d6009f | 2015-10-15 09:57:31 -0700 | [diff] [blame] | 42 | |
| 43 | var SSL_ROOTS_PATH = path.resolve(__dirname, '..', '..', 'etc', 'roots.pem'); |
| 44 | |
murgatroid99 | 55739d5 | 2015-06-03 10:58:21 -0700 | [diff] [blame] | 45 | var _ = require('lodash'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 46 | |
| 47 | var ProtoBuf = require('protobufjs'); |
| 48 | |
murgatroid99 | e787955 | 2015-02-12 12:21:15 -0800 | [diff] [blame] | 49 | var client = require('./src/client.js'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 50 | |
murgatroid99 | e787955 | 2015-02-12 12:21:15 -0800 | [diff] [blame] | 51 | var server = require('./src/server.js'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 52 | |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 53 | var common = require('./src/common.js'); |
| 54 | |
murgatroid99 | 84e3cde | 2015-08-20 11:27:05 -0700 | [diff] [blame] | 55 | var Metadata = require('./src/metadata.js'); |
| 56 | |
murgatroid99 | e190f35 | 2016-01-20 13:52:08 -0800 | [diff] [blame] | 57 | var grpc = require('./src/grpc_extension'); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 58 | |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 59 | var protobuf_js_5_common = require('./src/protobuf_js_5_common'); |
| 60 | var protobuf_js_6_common = require('./src/protobuf_js_6_common'); |
| 61 | |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 62 | var constants = require('./src/constants.js'); |
| 63 | |
murgatroid99 | 6f60766 | 2016-04-27 16:38:33 -0700 | [diff] [blame] | 64 | grpc.setDefaultRootsPem(fs.readFileSync(SSL_ROOTS_PATH, 'ascii')); |
| 65 | |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 66 | /** |
| 67 | * Load a ProtoBuf.js object as a gRPC object. The options object can provide |
| 68 | * the following options: |
| 69 | * - binaryAsBase64: deserialize bytes values as base64 strings instead of |
| 70 | * Buffers. Defaults to false |
| 71 | * - longsAsStrings: deserialize long values as strings instead of objects. |
| 72 | * Defaults to true |
murgatroid99 | ac7f90d | 2017-03-23 18:00:09 -0700 | [diff] [blame] | 73 | * - enumsAsStrings: deserialize enum values as strings instead of numbers. |
| 74 | * Defaults to true |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 75 | * - deprecatedArgumentOrder: Use the beta method argument order for client |
| 76 | * methods, with optional arguments after the callback. Defaults to false. |
| 77 | * This option is only a temporary stopgap measure to smooth an API breakage. |
| 78 | * It is deprecated, and new code should not use it. |
| 79 | * - protobufjsVersion: Available values are 5, 6, and 'detect'. 5 and 6 |
| 80 | * respectively indicate that an object from the corresponding version of |
| 81 | * ProtoBuf.js is provided in the value argument. If the option is 'detect', |
| 82 | * gRPC will guess what the version is based on the structure of the value. |
| 83 | * Defaults to 'detect'. |
| 84 | * @param {Object} value The ProtoBuf.js reflection object to load |
| 85 | * @param {Object=} options Options to apply to the loaded file |
| 86 | * @return {Object<string, *>} The resulting gRPC object |
| 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 | var deprecation_message = 'Calling grpc.loadObject with an object ' + |
| 109 | 'generated by ProtoBuf.js 5 is deprecated. Please upgrade to ' + |
| 110 | 'ProtoBuf.js 6.'; |
| 111 | common.log(grpc.logVerbosity.INFO, deprecation_message); |
| 112 | return protobuf_js_5_common.loadObject(value, options); |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 113 | default: |
| 114 | throw new Error('Unrecognized protobufjsVersion', protobufjsVersion); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 115 | } |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 116 | }; |
| 117 | |
| 118 | var loadObject = exports.loadObject; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 119 | |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 120 | function applyProtoRoot(filename, root) { |
| 121 | if (_.isString(filename)) { |
| 122 | return filename; |
| 123 | } |
| 124 | filename.root = path.resolve(filename.root) + '/'; |
| 125 | root.resolvePath = function(originPath, importPath, alreadyNormalized) { |
| 126 | return ProtoBuf.util.path.resolve(filename.root, |
| 127 | importPath, |
| 128 | alreadyNormalized); |
| 129 | }; |
| 130 | return filename.file; |
| 131 | } |
| 132 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 133 | /** |
murgatroid99 | 654d254 | 2016-02-17 15:36:28 -0800 | [diff] [blame] | 134 | * Load a gRPC object from a .proto file. The options object can provide the |
| 135 | * following options: |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 136 | * - convertFieldsToCamelCase: Load this file with field names in camel case |
| 137 | * instead of their original case |
murgatroid99 | 654d254 | 2016-02-17 15:36:28 -0800 | [diff] [blame] | 138 | * - binaryAsBase64: deserialize bytes values as base64 strings instead of |
| 139 | * Buffers. Defaults to false |
| 140 | * - longsAsStrings: deserialize long values as strings instead of objects. |
| 141 | * Defaults to true |
murgatroid99 | ac7f90d | 2017-03-23 18:00:09 -0700 | [diff] [blame] | 142 | * - enumsAsStrings: deserialize enum values as strings instead of numbers. |
| 143 | * Defaults to true |
murgatroid99 | 27b8d90 | 2016-03-22 14:46:37 -0700 | [diff] [blame] | 144 | * - deprecatedArgumentOrder: Use the beta method argument order for client |
| 145 | * methods, with optional arguments after the callback. Defaults to false. |
| 146 | * This option is only a temporary stopgap measure to smooth an API breakage. |
| 147 | * It is deprecated, and new code should not use it. |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 148 | * @param {string|{root: string, file: string}} filename The file to load |
murgatroid99 | 71dbb86 | 2015-04-20 11:22:51 -0700 | [diff] [blame] | 149 | * @param {string=} format The file format to expect. Must be either 'proto' or |
| 150 | * 'json'. Defaults to 'proto' |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 151 | * @param {Object=} options Options to apply to the loaded file |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 152 | * @return {Object<string, *>} The resulting gRPC object |
| 153 | */ |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 154 | exports.load = function load(filename, format, options) { |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 155 | /* Note: format is currently unused, because the API for loading a proto |
| 156 | file or a JSON file is identical in Protobuf.js 6. In the future, there is |
| 157 | still the possibility of adding other formats that would be loaded |
| 158 | differently */ |
| 159 | options = _.defaults(options, common.defaultGrpcOptions); |
murgatroid99 | b306854 | 2017-03-21 11:25:01 -0700 | [diff] [blame] | 160 | options.protobufjs_version = 6; |
murgatroid99 | b5b5f02 | 2017-03-16 16:42:10 -0700 | [diff] [blame] | 161 | var root = new ProtoBuf.Root(); |
| 162 | var parse_options = {keepCase: !options.convertFieldsToCamelCase}; |
| 163 | return loadObject(root.loadSync(applyProtoRoot(filename, root), |
| 164 | parse_options), |
| 165 | options); |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 166 | }; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 167 | |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 168 | var log_template = _.template( |
| 169 | '{severity} {timestamp}\t{file}:{line}]\t{message}', |
| 170 | {interpolate: /{([\s\S]+?)}/g}); |
| 171 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 172 | /** |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 173 | * Sets the logger function for the gRPC module. For debugging purposes, the C |
| 174 | * core will log synchronously directly to stdout unless this function is |
| 175 | * called. Note: the output format here is intended to be informational, and |
| 176 | * is not guaranteed to stay the same in the future. |
| 177 | * Logs will be directed to logger.error. |
| 178 | * @param {Console} logger A Console-like object. |
| 179 | */ |
| 180 | exports.setLogger = function setLogger(logger) { |
| 181 | common.logger = logger; |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 182 | grpc.setDefaultLoggerCallback(function(file, line, severity, |
| 183 | message, timestamp) { |
| 184 | logger.error(log_template({ |
| 185 | file: path.basename(file), |
| 186 | line: line, |
| 187 | severity: severity, |
| 188 | message: message, |
| 189 | timestamp: timestamp.toISOString() |
| 190 | })); |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 191 | }); |
| 192 | }; |
| 193 | |
| 194 | /** |
| 195 | * Sets the logger verbosity for gRPC module logging. The options are members |
| 196 | * of the grpc.logVerbosity map. |
| 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 | |
| 204 | /** |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 205 | * @see module:src/server.Server |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 206 | */ |
murgatroid99 | 366e64d | 2015-07-15 17:01:49 -0700 | [diff] [blame] | 207 | exports.Server = server.Server; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 208 | |
| 209 | /** |
murgatroid99 | 84e3cde | 2015-08-20 11:27:05 -0700 | [diff] [blame] | 210 | * @see module:src/metadata |
| 211 | */ |
| 212 | exports.Metadata = Metadata; |
| 213 | |
| 214 | /** |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 215 | * Status name to code number mapping |
| 216 | */ |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 217 | exports.status = constants.status; |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 218 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 219 | /** |
murgatroid99 | 0b09457 | 2015-08-14 10:48:45 -0700 | [diff] [blame] | 220 | * Propagate flag name to number mapping |
| 221 | */ |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 222 | exports.propagate = constants.propagate; |
murgatroid99 | 0b09457 | 2015-08-14 10:48:45 -0700 | [diff] [blame] | 223 | |
| 224 | /** |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 225 | * Call error name to code number mapping |
| 226 | */ |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 227 | exports.callError = constants.callError; |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 228 | |
| 229 | /** |
murgatroid99 | 4a1474f | 2015-08-17 14:00:31 -0700 | [diff] [blame] | 230 | * Write flag name to code number mapping |
| 231 | */ |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 232 | exports.writeFlags = constants.writeFlags; |
murgatroid99 | 4a1474f | 2015-08-17 14:00:31 -0700 | [diff] [blame] | 233 | |
| 234 | /** |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 235 | * Log verbosity setting name to code number mapping |
| 236 | */ |
murgatroid99 | 7229f88 | 2017-05-10 16:24:05 -0700 | [diff] [blame^] | 237 | exports.logVerbosity = constants.logVerbosity; |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 238 | |
| 239 | /** |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 240 | * Credentials factories |
| 241 | */ |
murgatroid99 | 153b09d | 2015-09-25 16:04:03 -0700 | [diff] [blame] | 242 | exports.credentials = require('./src/credentials.js'); |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 243 | |
| 244 | /** |
| 245 | * ServerCredentials factories |
| 246 | */ |
| 247 | exports.ServerCredentials = grpc.ServerCredentials; |
murgatroid99 | 8c3ed00 | 2015-02-18 15:00:56 -0800 | [diff] [blame] | 248 | |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 249 | /** |
| 250 | * @see module:src/client.makeClientConstructor |
| 251 | */ |
murgatroid99 | e023e98 | 2015-03-18 17:17:33 -0700 | [diff] [blame] | 252 | exports.makeGenericClientConstructor = client.makeClientConstructor; |
murgatroid99 | 76ba1ff | 2015-08-28 14:57:04 -0700 | [diff] [blame] | 253 | |
| 254 | /** |
| 255 | * @see module:src/client.getClientChannel |
| 256 | */ |
| 257 | exports.getClientChannel = client.getClientChannel; |
| 258 | |
| 259 | /** |
| 260 | * @see module:src/client.waitForClientReady |
| 261 | */ |
| 262 | exports.waitForClientReady = client.waitForClientReady; |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame] | 263 | |
| 264 | exports.closeClient = function closeClient(client_obj) { |
murgatroid99 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 265 | client.Client.prototype.close.apply(client_obj); |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame] | 266 | }; |
murgatroid99 | ffac55d | 2017-05-05 13:54:03 -0700 | [diff] [blame] | 267 | |
| 268 | /** |
| 269 | * @see module:src/client.Client |
| 270 | */ |
| 271 | exports.Client = client.Client; |