updated examples (#16)

yarikos · web-flow · commit 2daaf933a8a9 · 2018-03-22T16:54:58.000+02:00
diff --git a/README.md b/README.md
@@ -9,35 +9,89 @@ Provides
 ## Getting Started
 ### RPC
 
-To create a new instance of RPC server/client for RabbitMQ:
+There are two ways to run AMQPRPCServer/Client:
 
+#### temporary queue
+1. The server starts without any predefined queueName, asserts temporary queue.
+2. Generated `queueName` retrieved from the `server` instance and passed somehow to the `client` (one or many). It's supposed, that this transfer isn't covered by `amqp-rpc` lib and it should be implemented somehow by the developer of code, which uses `amqp-rpc`.
+3. Each client gets this queueName and uses it before initialization.
+
+#### permanent queue
+1. A queue is created somehow by an external service.
+2. `server` gets the name of the queue before initialization and starts listening.
+3. `client` gets the same name before initialization and uses it for sending requests.
+
+
+#####Example with temporary queue:
+
+Server:
 ```javascript
-const amqplib = require('ampqlib');
+const amqplib = require('amqplib');
 const {AMQPRPCServer, AMQPRPCClient} = require('@elasic.io/amqp-rpc');
-const exchange = 'EXCHANGE';
-const key = 'KEY';
+
 
 async function init() {
   const connection = await amqplib.connect('amqp://localhost');
+  
+  // server start
   const server = new AMQPRPCServer(connection);
+  server.addCommand('hello', (name) => ({message: `Hello, ${name}!`}));  
   await server.start();
+  
+  // name of temporary queue, has to be passed somehow to client by external service
   const requestsQueue = server.requestsQueue;
   
+  // client start
   const client = new AMQPRPCClient(connection, {requestsQueue});
   await client.start();
+  const response = await client.sendCommand('hello', ['Alisa']);
+  console.log('Alisa got response:', response);
   
   return {server, client};
 }
 ```
+Full working example you could find [here](examples/amqp-rpc-with-tmp-queue.js).
 
-To register a new RPC command in the server, use `addCommand()` method:
+
+######Example with permanent queue:
 
 ```javascript
-server.addCommand('print-hello-world', (name) => {
-  console.log('Hello, ${name}!');
+const amqplib = require('amqplib');
+const {AMQPRPCServer, AMQPRPCClient} = require('@elasic.io/amqp-rpc');
+
+
+async function init() {
+  
+  const connection = await amqplib.connect('amqp://localhost');
+  
+  // initial setup (e.g. should be provided on first launch)
+  const queueName = 'predefined-queue-name';
+  const channel = await connection.createChannel();
+  await channel.assertQueue(queueName);
   
-  return {foo: 'bar'};
-});
+  // server start
+  const server = new AMQPRPCServer(connection, {queueName});
+  server.addCommand('hello', (name) => ({message: `Hello, ${name}!`}));
+  await server.start();
+  
+  // client start
+  const client = new AMQPRPCClient(connection, {requestsQueue:queueName});
+  await client.start();
+  const response = await client.sendCommand('hello', ['Alisa']);
+  console.log('Alisa got response:', response);
+  
+  return {server, client};
+}
+```
+
+Full working example you could find [here](examples/amqp-rpc-with-permanent-queue.js).
+
+#### Server handlers
+
+To register a new RPC command in the server, use `addCommand()` method:
+
+```javascript
+server.addCommand('hello', (name) => ({message: `Hello, ${name}!`}));
 ```
 
 Handler could also return a promise or async function, e.g.:
@@ -52,10 +106,9 @@ To call an RPC command from the client, use `sendCommand()` method:
 const result = await client.sendCommand('print-hello-world', [
   'World'
 ]);
-
-assert.deepEqual(result, {foo: 'bar'});
 ```
 
+
 ### Event Emitter
 Events receiver side code
 ````javascript
diff --git a/examples/amqp-rpc-with-permanent-queue.js b/examples/amqp-rpc-with-permanent-queue.js
@@ -0,0 +1,97 @@
+/* eslint-disable no-console  */
+/* eslint-disable import/no-extraneous-dependencies */
+
+const amqplib = require('amqplib');
+const {AMQPRPCClient, AMQPRPCServer} = require('..');
+
+
+function delay(ms) {
+  return new Promise(resolve => {
+    setTimeout(resolve, ms);
+  })
+}
+
+/**
+ *
+ * @return {Promise<String>} queueName when server listens on for requests
+ */
+async function initialSetup(queueName) {
+  const connection = await amqplib.connect('amqp://localhost');
+  const channel = await connection.createChannel();
+  await channel.assertQueue(queueName);
+}
+
+/**
+ *
+ * @param requestsQueue
+ * @return {Promise<void>}
+ */
+async function initServer(requestsQueue) {
+  console.log('Server starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const server = new AMQPRPCServer(connection, {requestsQueue});
+
+  server.addCommand('hello', (name) => ({message: `Hello, ${name}!`}));
+
+  server.addCommand('get-time', () => ({time: new Date()}));
+
+  await server.start();
+  console.log('Server is ready');
+}
+
+/**
+ *
+ * @param requestsQueue
+ * @return {Promise<void>}
+ */
+async function initClient1(requestsQueue) {
+  console.log('Tom starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const client = new AMQPRPCClient(connection, {requestsQueue});
+  await client.start();
+
+  const response1 = await client.sendCommand('hello', ['Tom']);
+  console.log(`Tom got hello response ${response1.message}`);
+
+  await delay(100);
+
+  const response2 = await client.sendCommand('get-time', []);
+  console.log(`Tom got 1st response for get-time: ${response2.time}`);
+
+  await delay(100);
+
+  const response3 = await client.sendCommand('get-time', []);
+  console.log(`Tom got 2nd response for get-time: ${response3.time}`);
+}
+
+async function initClient2(requestsQueue) {
+  console.log('Alisa starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const client = new AMQPRPCClient(connection, {requestsQueue});
+  await client.start();
+
+  const response1 = await client.sendCommand('hello', ['Alisa']);
+  console.log(`Alisa got hello response ${response1.message}`);
+
+  await delay(150);
+
+  const response2 = await client.sendCommand('get-time', []);
+  console.log(`Alisa got response for get-time: ${response2.time}`);
+}
+
+
+(async function main() {
+  console.info('\n setup\n');
+  const queueName = 'predefined-queue-name';
+  await initialSetup(queueName);
+
+  console.info('\n launch server:\n');
+  await initServer(queueName);
+
+  console.info('\n launch clients:\n');
+  await Promise.all([
+    initClient1(queueName),
+    initClient2(queueName)
+  ]);
+})().catch(console.error.bind(console, 'General error:'));
+
diff --git a/examples/amqp-rpc-with-tmp-queue.js b/examples/amqp-rpc-with-tmp-queue.js
@@ -0,0 +1,83 @@
+/* eslint-disable no-console  */
+/* eslint-disable import/no-extraneous-dependencies */
+
+const amqplib = require('amqplib');
+const {AMQPRPCClient, AMQPRPCServer} = require('..');
+
+
+function delay(ms) {
+  return new Promise(resolve => {
+    setTimeout(resolve, ms);
+  })
+}
+
+/**
+ *
+ * @return {Promise<String>} queueName when server listens on for requests
+ */
+async function initServer() {
+  console.log('Server starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const server = new AMQPRPCServer(connection);
+
+  server.addCommand('hello', (name) => ({message: `Hello, ${name}!`}));
+
+  server.addCommand('get-time', () => ({time: new Date()}));
+
+  await server.start();
+  console.log('Server is ready');
+  return server.requestsQueue;
+}
+
+/**
+ *
+ * @param requestsQueue
+ * @return {Promise<void>}
+ */
+async function initClient1(requestsQueue) {
+  console.log('Tom starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const client = new AMQPRPCClient(connection, {requestsQueue});
+  await client.start();
+
+  const response1 = await client.sendCommand('hello', ['Tom']);
+  console.log(`Tom got hello response ${response1.message}`);
+
+  await delay(100);
+
+  const response2 = await client.sendCommand('get-time', []);
+  console.log(`Tom got 1st response for get-time: ${response2.time}`);
+
+  await delay(100);
+
+  const response3 = await client.sendCommand('get-time', []);
+  console.log(`Tom got 2nd response for get-time: ${response3.time}`);
+}
+
+async function initClient2(requestsQueue) {
+  console.log('Alisa starting');
+  const connection = await amqplib.connect('amqp://localhost');
+  const client = new AMQPRPCClient(connection, {requestsQueue});
+  await client.start();
+
+  const response1 = await client.sendCommand('hello', ['Alisa']);
+  console.log(`Alisa got hello response ${response1.message}`);
+
+  await delay(150);
+
+  const response2 = await client.sendCommand('get-time', []);
+  console.log(`Alisa got response for get-time: ${response2.time}`);
+}
+
+
+(async function main() {
+  console.info('\n launch server:\n');
+  const tmpQueueName = await initServer();
+
+  console.info('\n launch clients:\n');
+  await Promise.all([
+    initClient1(tmpQueueName),
+    initClient2(tmpQueueName)
+  ]);
+})().catch(console.error.bind(console, 'General error:'));
+
