Example updates (#6)

Author: badsyntax

examples/gradle-ts-protoc-gen/.gitignore

@@ -1,6 +1,6 @@
 node_modules
-*.js
-proto/*.ts
+**/*.js
+!proto/*.js
 
 # Ignore Gradle project-specific cache directory
 .gradle

examples/gradle-ts-protoc-gen/.vscode/extensions.json

@@ -3,6 +3,7 @@
     "dbaeumer.vscode-eslint",
     "EditorConfig.EditorConfig",
     "esbenp.prettier-vscode",
-    "streetsidesoftware.code-spell-checker"
+    "streetsidesoftware.code-spell-checker",
+    "zxh404.vscode-proto3"
   ]
 }

examples/gradle-ts-protoc-gen/README.md

@@ -1,10 +1,10 @@
-# gradle-ts-protoc-gen
+# gradle-ts-protoc-gen example
 
-This examples shows how to uses [Gradle](https://gradle.org/), the [proto compiler](https://www.npmjs.com/package/grpc-tools),  [`ts-protoc-gen`](https://www.npmjs.com/package/ts-protoc-gen) & [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) to build a (not quite yet) fully typed gRPC CLI chat application that runs on Node.js.
+This examples shows how to uses [Gradle](https://gradle.org/), the [proto compiler](https://www.npmjs.com/package/grpc-tools),  [`ts-protoc-gen`](https://www.npmjs.com/package/ts-protoc-gen) & [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) to build a (not quite yet) fully typed gRPC application that runs on Node.js.
 
 The [proto compiler](https://www.npmjs.com/package/grpc-tools) and [`ts-protoc-gen`](https://www.npmjs.com/package/ts-protoc-gen) compiler plugin are used to generate JavaScript & TypeScript files from the proto definitions. The [`protobuf-gradle-plugin`](https://github.com/google/protobuf-gradle-plugin) Gradle plugin is used to run the compiler from Gradle.
 
-The generated code uses [`google-protobuf`](https://www.npmjs.com/package/google-protobuf) & [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) at runtime.
+[`google-protobuf`](https://www.npmjs.com/package/google-protobuf) & [`@grpc/grpc-js`](https://www.npmjs.com/package/@grpc/grpc-js) is used at runtime.
 
 ## App layout
 
@@ -16,31 +16,45 @@ The generated code uses [`google-protobuf`](https://www.npmjs.com/package/google
 
 ## Generating the Types
 
+Install dependencies:
+
 ```sh
-./gradlew generateProto
+npm install
 ```
 
-### Running the app
+Use Gradle & [`ts-protoc-gen`](https://www.npmjs.com/package/ts-protoc-gen) to generate the TypeScript files:
+
+```sh
+./gradlew generateProto
+```
 
-First build the types and application files:
+This is aliased as a npm script:
 
 ```sh
-npm install
-npm run build # this runs `./gradlew generateProto`
+npm run build:proto
 ```
 
-Start the server:
+### Running the App
+
+This simple app demonstrates the different gRPC calls you can perform.
+
+First generated the types and build the application files:
 
 ```sh
-npm run start:server
+npm run build
 ```
 
-Now run the client in different terminal sessions:
+Start the server:
 
 ```sh
-npm run start:client
+npm run start:server
 ```
 
-## Credits
+Now run the client by specifying which example you want to run:
 
-The chat application idea is inspired from https://techblog.fexcofts.com/2018/07/20/grpc-nodejs-chat-example/
+```bash
+npm run start:client -- --unary
+npm run start:client -- --server-streaming
+npm run start:client -- --client-streaming
+npm run start:client -- --bidi-streaming
+```

examples/gradle-ts-protoc-gen/build.gradle

@@ -60,7 +60,7 @@ protobuf {
 }
 
 task copyGeneratedProto(type: Copy) {
-  from '$protobuf.generatedFilesBaseDir/main/ts', '$protobuf.generatedFilesBaseDir/main/js'
+  from "$protobuf.generatedFilesBaseDir/main/ts", "$protobuf.generatedFilesBaseDir/main/js"
   into 'proto'
 }
 

examples/gradle-ts-protoc-gen/client.ts

@@ -1,44 +1,100 @@
 import * as grpc from '@grpc/grpc-js';
-import readline from 'readline';
-import { ChatClient } from './proto/chat_grpc_pb';
-import { ClientMessage, ServerMessage } from './proto/chat_pb';
+import { ExampleClient } from './proto/example_grpc_pb';
+import { ClientMessage, ServerMessage } from './proto/example_pb';
 
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
+const host = '0.0.0.0:9090';
 
-const client = new ChatClient(
-  '0.0.0.0:9090',
-  grpc.credentials.createInsecure()
-);
+const client = new ExampleClient(host, grpc.credentials.createInsecure());
 
 const deadline = new Date();
 deadline.setSeconds(deadline.getSeconds() + 5);
 client.waitForReady(deadline, (error?: Error) => {
   if (error) {
-    console.log(`Client error: ${error}`);
+    console.log(`Client connect error: ${error.message}`);
   } else {
-    rl.question("What's your name? ", startChat);
+    onClientReady();
   }
 });
 
-function startChat(user: string) {
+function onClientReady() {
+  switch (process.argv[process.argv.length - 1]) {
+    case '--unary':
+      doUnaryCall();
+      break;
+    case '--server-streaming':
+      doServerStreamingCall();
+      break;
+    case '--client-streaming':
+      doClientStreamingCall();
+      break;
+    case '--bidi-streaming':
+      doBidirectionalStreamingCallStreamingCall();
+      break;
+    default:
+      throw new Error('Example not specified');
+  }
+}
+
+function doUnaryCall() {
   const clientMessage = new ClientMessage();
-  clientMessage.setUser(user);
-  const channel = client.join(clientMessage);
-  channel.on('data', (message: ServerMessage) => {
-    if (message.getUser() == user) {
-      return;
+  clientMessage.setClientMessage('Message from client');
+  client.unaryCall(
+    clientMessage,
+    (error: grpc.ServiceError | null, serverMessage?: ServerMessage) => {
+      if (error) {
+        console.error(error.message);
+      } else if (serverMessage) {
+        console.log(
+          `(client) Got server message: ${serverMessage.getServerMessage()}`
+        );
+      }
     }
-    console.log(`${message.getUser()}: ${message.getText()}`);
+  );
+}
+
+function doServerStreamingCall() {
+  const clientMessage = new ClientMessage();
+  clientMessage.setClientMessage('Message from client');
+  const stream = client.serverStreamingCall(clientMessage);
+  stream.on('data', (serverMessage: ServerMessage) => {
+    console.log(
+      `(client) Got server message: ${serverMessage.getServerMessage()}`
+    );
   });
-  rl.on('line', function (text) {
-    const clientMessage = new ClientMessage();
-    clientMessage.setUser(user);
-    clientMessage.setText(text);
-    client.send(clientMessage, () => {
-      //
-    });
+}
+
+function doClientStreamingCall() {
+  const stream = client.clientStreamingCall(
+    (error: grpc.ServiceError | null, serverMessage?: ServerMessage) => {
+      if (error) {
+        console.error(error.message);
+      } else if (serverMessage) {
+        console.log(
+          `(client) Got server message: ${serverMessage.getServerMessage()}`
+        );
+      }
+    }
+  );
+  const clientMessage = new ClientMessage();
+  clientMessage.setClientMessage('Message from client');
+  stream.write(clientMessage);
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  setTimeout(() => {}, 1000);
+}
+
+function doBidirectionalStreamingCallStreamingCall() {
+  const stream = client.bidirectionalStreamingCall();
+
+  // Server stream
+  stream.on('data', (serverMessage: ServerMessage) => {
+    console.log(
+      `(client) Got server message: ${serverMessage.getServerMessage()}`
+    );
   });
+
+  // Client stream
+  const clientMessage = new ClientMessage();
+  clientMessage.setClientMessage('Message from client');
+  stream.write(clientMessage);
 }