Merge branch 'master' into patch-1

andrewmbenton · web-flow · commit d8d3541bcd45 · 2023-10-12T21:26:19.000-07:00
diff --git a/README.md b/README.md
@@ -104,8 +104,8 @@ typings file will also be generated for the protobuf messages and service stub.
 in TypeScript. See **TypeScript Support** below for information on how to
 generate TypeScript files.
 
-**Note: The `commonjs+dts` and `typescript` styles are only supported by
-`--grpc-web_out=import_style=...`, not by `--js_out=import_style=...`.**
+> **Note:** The `commonjs+dts` and `typescript` styles are only supported by
+`--grpc-web_out=import_style=...`, not by `--js_out=import_style=...`.
 
 ### Wire Format Mode
 
@@ -294,9 +294,14 @@ call.on('status', (status: grpcWeb.Status) => {
 
 ### (Option) Using Promises (Limited features)
 
-NOTE: It is not possible to access the `.on(...)` callbacks (e.g. for `metadata` and `status`) when Promise is used.
+> **NOTE:** It is not possible to access the `.on(...)` callbacks (e.g. for `metadata` and `status`) when Promise is used.
 
 ```ts
+// Create a Promise client instead
+const echoService = new EchoServicePromiseClient('http://localhost:8080', null, null);
+
+... (same as above)
+
 this.echoService.echo(request, {'custom-header-1': 'value1'})
   .then((response: EchoResponse) => {
     console.log(`Received response: ${response.getMessage()}`);
@@ -308,6 +313,18 @@ this.echoService.echo(request, {'custom-header-1': 'value1'})
 For the full TypeScript example, see
 [ts-example/client.ts](net/grpc/gateway/examples/echo/ts-example/client.ts) with the [instructions](net/grpc/gateway/examples/echo/ts-example) to run.
 
+## Custom Interceptors
+
+Custom interceptors can be implemented and chained, which could be useful for features like auth, retries, etc.
+
+There are 2 types of interceptors ([interfaces](https://github.com/grpc/grpc-web/blob/3cd7e0d43493d4694fed78400e4ad78031d70c09/packages/grpc-web/index.d.ts#L55-L65)):
+
+- `UnaryInterceptor` ([doc](https://grpc.io/blog/grpc-web-interceptor/#stream-interceptor-example), [example](https://github.com/grpc/grpc-web/blob/master/packages/grpc-web/test/tsc-tests/client04.ts)) - Intercept Unary RPCs; can only be used with Promise clients.
+- `StreamInterceptor` ([doc](https://grpc.io/blog/grpc-web-interceptor/#stream-interceptor-example), [example](https://github.com/grpc/grpc-web/blob/master/packages/grpc-web/test/tsc-tests/client03.ts)) - More versatile; can be used with regular clients.
+
+For more details, see [this blog post](https://grpc.io/blog/grpc-web-interceptor/).
+
+
 ## Ecosystem
 
 ### Proxy Interoperability
diff --git a/javascript/net/grpc/web/generator/grpc_generator.cc b/javascript/net/grpc/web/generator/grpc_generator.cc
@@ -940,11 +940,12 @@ void PrintProtoDtsFile(Printer* printer, const FileDescriptor* file) {
   printer->Print("import * as jspb from 'google-protobuf'\n\n");
 
   for (int i = 0; i < file->dependency_count(); i++) {
-    const string& name = file->dependency(i)->name();
+    const string& proto_filename = file->dependency(i)->name();
     // We need to give each cross-file import an alias.
-    printer->Print("import * as $alias$ from '$dep_filename$_pb';\n", "alias",
-                   ModuleAlias(name), "dep_filename",
-                   GetRootPath(file->name(), name) + StripProto(name));
+    printer->Print("import * as $alias$ from '$dep_filename$_pb'; // proto import: \"$proto_filename$\"\n",
+                   "alias", ModuleAlias(proto_filename),
+                   "dep_filename", GetRootPath(file->name(), proto_filename) + StripProto(proto_filename),
+                   "proto_filename", proto_filename);
   }
   printer->Print("\n\n");
 
