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 | 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 | 6f60766 | 2016-04-27 16:38:33 -0700 | [diff] [blame] | 55 | grpc.setDefaultRootsPem(fs.readFileSync(SSL_ROOTS_PATH, 'ascii')); |
| 56 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 57 | /** |
| 58 | * Load a gRPC object from an existing ProtoBuf.Reflect object. |
| 59 | * @param {ProtoBuf.Reflect.Namespace} value The ProtoBuf object to load. |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 60 | * @param {Object=} options Options to apply to the loaded object |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 61 | * @return {Object<string, *>} The resulting gRPC object |
| 62 | */ |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 63 | exports.loadObject = function loadObject(value, options) { |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 64 | var result = {}; |
| 65 | if (value.className === 'Namespace') { |
| 66 | _.each(value.children, function(child) { |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 67 | result[child.name] = loadObject(child, options); |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 68 | }); |
| 69 | return result; |
| 70 | } else if (value.className === 'Service') { |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 71 | return client.makeProtobufClientConstructor(value, options); |
murgatroid99 | 97d6130 | 2015-01-20 18:06:43 -0800 | [diff] [blame] | 72 | } else if (value.className === 'Message' || value.className === 'Enum') { |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 73 | return value.build(); |
| 74 | } else { |
| 75 | return value; |
| 76 | } |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 77 | }; |
| 78 | |
| 79 | var loadObject = exports.loadObject; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 80 | |
| 81 | /** |
murgatroid99 | 654d254 | 2016-02-17 15:36:28 -0800 | [diff] [blame] | 82 | * Load a gRPC object from a .proto file. The options object can provide the |
| 83 | * following options: |
| 84 | * - convertFieldsToCamelCase: Loads this file with that option on protobuf.js |
| 85 | * set as specified. See |
| 86 | * https://github.com/dcodeIO/protobuf.js/wiki/Advanced-options for details |
| 87 | * - binaryAsBase64: deserialize bytes values as base64 strings instead of |
| 88 | * Buffers. Defaults to false |
| 89 | * - longsAsStrings: deserialize long values as strings instead of objects. |
| 90 | * Defaults to true |
murgatroid99 | 27b8d90 | 2016-03-22 14:46:37 -0700 | [diff] [blame] | 91 | * - deprecatedArgumentOrder: Use the beta method argument order for client |
| 92 | * methods, with optional arguments after the callback. Defaults to false. |
| 93 | * This option is only a temporary stopgap measure to smooth an API breakage. |
| 94 | * It is deprecated, and new code should not use it. |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 95 | * @param {string|{root: string, file: string}} filename The file to load |
murgatroid99 | 71dbb86 | 2015-04-20 11:22:51 -0700 | [diff] [blame] | 96 | * @param {string=} format The file format to expect. Must be either 'proto' or |
| 97 | * 'json'. Defaults to 'proto' |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 98 | * @param {Object=} options Options to apply to the loaded file |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 99 | * @return {Object<string, *>} The resulting gRPC object |
| 100 | */ |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 101 | exports.load = function load(filename, format, options) { |
murgatroid99 | 71dbb86 | 2015-04-20 11:22:51 -0700 | [diff] [blame] | 102 | if (!format) { |
| 103 | format = 'proto'; |
| 104 | } |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 105 | var convertFieldsToCamelCaseOriginal = ProtoBuf.convertFieldsToCamelCase; |
| 106 | if(options && options.hasOwnProperty('convertFieldsToCamelCase')) { |
| 107 | ProtoBuf.convertFieldsToCamelCase = options.convertFieldsToCamelCase; |
murgatroid99 | 71dbb86 | 2015-04-20 11:22:51 -0700 | [diff] [blame] | 108 | } |
murgatroid99 | c02910b | 2016-02-17 12:59:26 -0800 | [diff] [blame] | 109 | var builder; |
| 110 | try { |
| 111 | switch(format) { |
| 112 | case 'proto': |
| 113 | builder = ProtoBuf.loadProtoFile(filename); |
| 114 | break; |
| 115 | case 'json': |
| 116 | builder = ProtoBuf.loadJsonFile(filename); |
| 117 | break; |
| 118 | default: |
| 119 | throw new Error('Unrecognized format "' + format + '"'); |
| 120 | } |
| 121 | } finally { |
| 122 | ProtoBuf.convertFieldsToCamelCase = convertFieldsToCamelCaseOriginal; |
| 123 | } |
| 124 | return loadObject(builder.ns, options); |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 125 | }; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 126 | |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 127 | var log_template = _.template( |
| 128 | '{severity} {timestamp}\t{file}:{line}]\t{message}', |
| 129 | {interpolate: /{([\s\S]+?)}/g}); |
| 130 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 131 | /** |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 132 | * Sets the logger function for the gRPC module. For debugging purposes, the C |
| 133 | * core will log synchronously directly to stdout unless this function is |
| 134 | * called. Note: the output format here is intended to be informational, and |
| 135 | * is not guaranteed to stay the same in the future. |
| 136 | * Logs will be directed to logger.error. |
| 137 | * @param {Console} logger A Console-like object. |
| 138 | */ |
| 139 | exports.setLogger = function setLogger(logger) { |
| 140 | common.logger = logger; |
murgatroid99 | 1d2f289 | 2016-06-02 14:33:22 -0700 | [diff] [blame] | 141 | grpc.setDefaultLoggerCallback(function(file, line, severity, |
| 142 | message, timestamp) { |
| 143 | logger.error(log_template({ |
| 144 | file: path.basename(file), |
| 145 | line: line, |
| 146 | severity: severity, |
| 147 | message: message, |
| 148 | timestamp: timestamp.toISOString() |
| 149 | })); |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 150 | }); |
| 151 | }; |
| 152 | |
| 153 | /** |
| 154 | * Sets the logger verbosity for gRPC module logging. The options are members |
| 155 | * of the grpc.logVerbosity map. |
| 156 | * @param {Number} verbosity The minimum severity to log |
| 157 | */ |
| 158 | exports.setLogVerbosity = function setLogVerbosity(verbosity) { |
| 159 | common.logVerbosity = verbosity; |
| 160 | grpc.setLogVerbosity(verbosity); |
| 161 | }; |
| 162 | |
| 163 | /** |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 164 | * @see module:src/server.Server |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 165 | */ |
murgatroid99 | 366e64d | 2015-07-15 17:01:49 -0700 | [diff] [blame] | 166 | exports.Server = server.Server; |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 167 | |
| 168 | /** |
murgatroid99 | 84e3cde | 2015-08-20 11:27:05 -0700 | [diff] [blame] | 169 | * @see module:src/metadata |
| 170 | */ |
| 171 | exports.Metadata = Metadata; |
| 172 | |
| 173 | /** |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 174 | * Status name to code number mapping |
| 175 | */ |
| 176 | exports.status = grpc.status; |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 177 | |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 178 | /** |
murgatroid99 | 0b09457 | 2015-08-14 10:48:45 -0700 | [diff] [blame] | 179 | * Propagate flag name to number mapping |
| 180 | */ |
| 181 | exports.propagate = grpc.propagate; |
| 182 | |
| 183 | /** |
murgatroid99 | cca5ffa | 2015-01-15 14:06:56 -0800 | [diff] [blame] | 184 | * Call error name to code number mapping |
| 185 | */ |
| 186 | exports.callError = grpc.callError; |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 187 | |
| 188 | /** |
murgatroid99 | 4a1474f | 2015-08-17 14:00:31 -0700 | [diff] [blame] | 189 | * Write flag name to code number mapping |
| 190 | */ |
| 191 | exports.writeFlags = grpc.writeFlags; |
| 192 | |
| 193 | /** |
murgatroid99 | 9b9708a | 2016-06-01 11:42:20 -0700 | [diff] [blame] | 194 | * Log verbosity setting name to code number mapping |
| 195 | */ |
| 196 | exports.logVerbosity = grpc.logVerbosity; |
| 197 | |
| 198 | /** |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 199 | * Credentials factories |
| 200 | */ |
murgatroid99 | 153b09d | 2015-09-25 16:04:03 -0700 | [diff] [blame] | 201 | exports.credentials = require('./src/credentials.js'); |
murgatroid99 | b6ab1b4 | 2015-01-21 10:30:36 -0800 | [diff] [blame] | 202 | |
| 203 | /** |
| 204 | * ServerCredentials factories |
| 205 | */ |
| 206 | exports.ServerCredentials = grpc.ServerCredentials; |
murgatroid99 | 8c3ed00 | 2015-02-18 15:00:56 -0800 | [diff] [blame] | 207 | |
murgatroid99 | 9cd90a6 | 2015-07-27 11:23:13 -0700 | [diff] [blame] | 208 | /** |
| 209 | * @see module:src/client.makeClientConstructor |
| 210 | */ |
murgatroid99 | e023e98 | 2015-03-18 17:17:33 -0700 | [diff] [blame] | 211 | exports.makeGenericClientConstructor = client.makeClientConstructor; |
murgatroid99 | 76ba1ff | 2015-08-28 14:57:04 -0700 | [diff] [blame] | 212 | |
| 213 | /** |
| 214 | * @see module:src/client.getClientChannel |
| 215 | */ |
| 216 | exports.getClientChannel = client.getClientChannel; |
| 217 | |
| 218 | /** |
| 219 | * @see module:src/client.waitForClientReady |
| 220 | */ |
| 221 | exports.waitForClientReady = client.waitForClientReady; |
murgatroid99 | 9030c81 | 2016-09-16 13:25:08 -0700 | [diff] [blame^] | 222 | |
| 223 | exports.closeClient = function closeClient(client_obj) { |
| 224 | client.getClientChannel(client_obj).close(); |
| 225 | }; |