feat: allow passing a set of default CallOptions in new Etcd3()

.vscode/launch.json

@@ -8,17 +8,13 @@
       "type": "pwa-node",
       "request": "launch",
       "name": "Run Tests",
+      "trace": true,
       "skipFiles": ["<node_internals>/**"],
       "program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
-      "preLaunchTask": "tsc: build - tsconfig.json",
-      "args": [
-        "--timeout",
-        "60000",
-        "--require",
-        "source-map-support/register",
-        "--require",
-        "./lib/test/_setup.js",
-        "\"lib/test/**/*.test.js\""
+      "args": ["--timeout", "10000", "--require", "./lib/test/_setup.js", "lib/test/**/*.test.js"],
+      "outFiles": [
+        "${workspaceFolder}/**/*.js",
+        "!**/node_modules/**"
       ]
     }
   ]

.vscode/settings.json

@@ -1,14 +1,16 @@
 {
   "typescript.tsdk": "node_modules\\typescript\\lib",
   "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true
+  },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "search.exclude": {
     "**/lib": true,
     "**/.nyc_output": true,
-    "**/docs": true,
+    "**/docs": true
   },
   "files.exclude": {
-    "**/.nyc_output": true,
-  },
-  "debug.node.autoAttach": "off"
+    "**/.nyc_output": true
+  }
 }

.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "typescript",
+			"tsconfig": "tsconfig.json",
+			"option": "watch",
+			"problemMatcher": [
+				"$tsc-watch"
+			],
+			"group": "build",
+			"label": "tsc: watch - tsconfig.json"
+		}
+	]
+}

bin/generate-methods.js

@@ -13,6 +13,7 @@
  * create the output ourselves since it's pretty simple (~100 lines of code).
  */
 
+const prettier = require('prettier');
 const pbjs = require('protobufjs');
 const fs = require('fs');
 const _ = require('lodash');
@@ -66,14 +67,26 @@ class MessageCollection {
 
 const messages = new MessageCollection();
 
+let result = '';
+
 function emit(string) {
   if (string) {
-    process.stdout.write(string.replace(/\n\n+/g, '\n\n'));
+    result += string;
   }
 
   return emit;
 }
 
+function writeOut() {
+  fs.writeFileSync(
+    `${__dirname}/../src/rpc.ts`,
+    prettier.format(result, {
+      ...require('../package.json').prettier,
+      parser: 'typescript',
+    }),
+  );
+}
+
 function template(name, params) {
   if (!templates[name]) {
     templates[name] = _.template(fs.readFileSync(`${__dirname}/template/${name}.tmpl`, 'utf8'));
@@ -89,7 +102,7 @@ function template(name, params) {
   emit(
     templates[name](params)
       .replace(/^\-\- *\n/gm, '')
-      .replace(/^\-\-/gm, '')
+      .replace(/^\-\-/gm, ''),
   );
 }
 
@@ -169,7 +182,7 @@ function getCommentPrefixing(substring, from = 0, indentation = 1) {
 }
 
 function generateMethodCalls(node, name) {
-  services[name] = `${name}Client`;
+  const service = (services[name] = { cls: `${name}Client`, methods: new Map() });
   template('class-header', { name });
 
   _.forOwn(node.methods, (method, mname) => {
@@ -183,8 +196,12 @@ function generateMethodCalls(node, name) {
       res,
       responseTsType: res.empty ? 'void' : formatType(method.responseType),
       service: name,
+      responseStream: method.responseStream,
+      requestStream: method.requestStream,
     };
 
+    service.methods.set(method, params);
+
     if (method.responseStream && !method.requestStream) {
       template('response-stream-method', params);
     } else if (method.responseStream && method.requestStream) {
@@ -199,6 +216,18 @@ function generateMethodCalls(node, name) {
   emit('}\n\n');
 }
 
+function generateCallContext() {
+  emit('export type CallContext = \n');
+
+  for (const service of Object.values(services)) {
+    for (const params of service.methods.values()) {
+      template('call-context', params);
+    }
+  }
+
+  emit(';\n');
+}
+
 function generateInterface(node, name) {
   const message = messages.find(name);
   template('interface', { name, node, message });
@@ -276,6 +305,7 @@ function codeGen(ast) {
   });
 
   template('service-map', { services });
+  generateCallContext();
 }
 
 new pbjs.Root()
@@ -284,5 +314,6 @@ new pbjs.Root()
     prepareForGeneration(ast.nested);
     template('rpc-prefix');
     codeGen(ast.nested);
+    writeOut();
   })
   .catch(err => console.error(err.stack));

bin/template/call-context.tmpl

@@ -0,0 +1 @@
+| { service: '<%= service %>', method: '<%= _.lowerFirst(name) %>', isStream: <%= !!(responseStream || requestStream) %>, <%= req.empty || requestStream ? '' : `params: ${requestTsType}` %> }

bin/template/class-header.tmpl

@@ -1,2 +1,2 @@
 export class <%= name %>Client {
-  constructor(private client: ICallable<unknown>) {}
+  constructor(private readonly client: ICallable<unknown>) {}

bin/template/duplex-stream-method.tmpl

@@ -2,7 +2,13 @@
   public <%= _.lowerFirst(name) %>(options?: grpc.CallOptions): Promise<IDuplexStream<<%= requestTsType %>, <%= responseTsType %>>> {
     return this.client.withConnection('<%= service %>', ({ resource, client, metadata }) => {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const stream = (<any> client).<%= _.lowerFirst(name) %>(metadata, options);
+        const resolved = resolveCallOptions(options, this.client.callOptionsFactory, {
+          service: '<%= service %>',
+          method: '<%= _.lowerFirst(name) %>',
+          isStream: true,
+        });
+
+        const stream = (<any> client).<%= _.lowerFirst(name) %>(metadata, resolved);
         stream.on('error', (err: Error) => stream.writable && this.client.markFailed(resource, err));
         return stream;
       });

bin/template/response-stream-method.tmpl

@@ -1,8 +1,13 @@
 --<%= getCommentPrefixing(`rpc ${name}(`) %>
   public <%= _.lowerFirst(name) %>(<%= req.empty ? '' : `req: ${requestTsType}, ` %>options?: grpc.CallOptions): Promise<IResponseStream<<%= responseTsType %>>> {
     return this.client.withConnection('<%= service %>', ({ resource, client, metadata }) => {
+        const resolved = resolveCallOptions(options, this.client.callOptionsFactory, {
+          service: '<%= service %>',
+          method: '<%= _.lowerFirst(name) %>', <%= req.empty ? '' : 'params: req, ' %> isStream: true,
+        });
+
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const stream = (<any> client).<%= _.lowerFirst(name) %>(metadata, options, <%= req.empty ? '{}' : 'req' %>);
+        const stream = (<any> client).<%= _.lowerFirst(name) %>(metadata, resolved, <%= req.empty ? '{}' : 'req' %>);
         stream.on('error', (err: Error) => this.client.markFailed(resource, err));
         return stream;
       });

bin/template/rpc-prefix.tmpl

@@ -7,6 +7,8 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
 
 import * as grpc from '@grpc/grpc-js';
+import type { CallOptionsFactory } from './options';
+import { resolveCallOptions } from './util';
 
 export interface ICallable<T> {
   exec<T>(
@@ -22,6 +24,8 @@ export interface ICallable<T> {
   ): Promise<R>;
 
   markFailed(resource: T, error: Error): void;
+
+  readonly callOptionsFactory: CallOptionsFactory | undefined;
 }
 
 export interface IResponseStream<T> {

bin/template/service-map.tmpl

@@ -1,5 +1,5 @@
 export const Services = {
 --<% _.forOwn(services, (clientName, serviceName) => { %>
-  <%= serviceName %>: <%= clientName %>,
+  <%= serviceName %>: <%= clientName.cls %>,
 --<% }) %>
 };

changelog.md

@@ -2,6 +2,32 @@
 
 - **fix:** update version of cockatiel to fix incompatible TypeScript types (see [#128](https://github.com/microsoft/etcd3/issues/128))
 - **fix:** don't include the deadline in inherited lease call options (see [#131](https://github.com/microsoft/etcd3/issues/131))
+- **feat:** allow passing a set of default CallOptions in new Etcd3() (see [#133](https://github.com/microsoft/etcd3/issues/133))
+
+  When constructing `Etcd3`, you can now pass `defaultCallOptions`. This can be an object, or a function which will be called for each etcd method call and should return an object. As a function, it will be called with a context object, which looks like:
+
+  ```js
+  {
+    service: 'KV',   // etcd service name
+    method: 'range', // etcd method name
+    isStream: false, // whether the call create a stream
+    params: { ... }, // arguments given to the call
+  }
+  ```
+
+  For example, this will set a 10 second timeout on all calls which are not streams:
+
+  ```js
+  const etcd3 = new Etcd3({
+    defaultCallOptions: context => context.isStream ? {} : Date.now() + 10000,
+  });
+  ```
+
+  The default options are shallow merged with any call-specific options. For example this will always result in a 5 second timeout, regardless of what the `defaultCallOptions` contains:
+
+  ```js
+  etcd3.get('foo').options({ deadline: Date.now() + 5000 })
+  ```
 
 ## 1.0.1 2020-06-21