├── .gitignore ├── LICENSE ├── README.md ├── consumer.js ├── package-lock.json ├── package.json └── producer.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Getting Started with Redis Streams & Node.js 2 | 3 | This project shows how to use [Redis Node client](http://redis.js.org/) to publish and consume messages using consumer groups. 4 | 5 | This is a first basic example that use a single consumer. 6 | 7 | ## Build 8 | 9 | ``` 10 | > cd redis-streams-101-node 11 | 12 | > npm install 13 | 14 | 15 | ``` 16 | 17 | ## Run 18 | 19 | You have access to a Redis instance/cluster. 20 | 21 | Open 2 terminal windows 22 | 23 | ### Run the Producer 24 | 25 | ```redis-streams-101-node 26 | > cd redis-streams-101-node 27 | 28 | > node producer.js loop=1000 sleep=500 29 | ``` 30 | 31 | Where: 32 | 33 | * `loop` is the number of messages sent by the program (in a lopp) 34 | * `sleep` the time in milliseconds between each message post 35 | 36 | 37 | ### Run the Consumer 38 | 39 | ```bash 40 | > cd redis-streams-101-node 41 | 42 | > node consumer.js 43 | 44 | ``` 45 | 46 | This will print all the messages that have not yet been consumed by the group. -------------------------------------------------------------------------------- /consumer.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var async = require('async'); 4 | 5 | var redis = require('redis'); 6 | var redisClient = redis.createClient(); 7 | 8 | const STREAMS_KEY = "weather_sensor:wind"; 9 | const APPLICATION_ID = "iot_application:node_1"; 10 | var CONSUMER_ID = "consumer:1" 11 | 12 | 13 | // create the group 14 | redisClient.xgroup("CREATE", STREAMS_KEY, APPLICATION_ID, '$', function(err) { 15 | if (err) { 16 | if (err.code == 'BUSYGROUP' ) { 17 | console.log(`Group ${APPLICATION_ID} already exists`); 18 | } else { 19 | console.log(err); 20 | process.exit(); 21 | } 22 | } 23 | }); 24 | 25 | async.forever( 26 | function(next) { 27 | redisClient.xreadgroup('GROUP', APPLICATION_ID, CONSUMER_ID, 'BLOCK', 500, 'STREAMS', STREAMS_KEY , '>', function (err, stream) { 28 | if (err) { 29 | console.error(err); 30 | next(err); 31 | } 32 | 33 | if (stream) { 34 | var messages = stream[0][1]; 35 | // print all messages 36 | messages.forEach(function(message){ 37 | // convert the message into a JSON Object 38 | var id = message[0]; 39 | var values = message[1]; 40 | var msgObject = { id : id}; 41 | for (var i = 0 ; i < values.length ; i=i+2) { 42 | msgObject[values[i]] = values[i+1]; 43 | } 44 | console.log( "Message: "+ JSON.stringify(msgObject)); 45 | }); 46 | 47 | } else { 48 | // No message in the consumer buffer 49 | console.log("No new message..."); 50 | } 51 | 52 | next(); 53 | }); 54 | }, 55 | function(err) { 56 | console.log(" ERROR " + err); 57 | process.exit() 58 | } 59 | ); 60 | 61 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "redis-streams-101-node", 3 | "version": "1.0.0", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "async": { 8 | "version": "3.1.0", 9 | "resolved": "https://registry.npmjs.org/async/-/async-3.1.0.tgz", 10 | "integrity": "sha512-4vx/aaY6j/j3Lw3fbCHNWP0pPaTCew3F6F3hYyl/tHs/ndmV1q7NW9T5yuJ2XAGwdQrP+6Wu20x06U4APo/iQQ==" 11 | }, 12 | "double-ended-queue": { 13 | "version": "2.1.0-0", 14 | "resolved": "https://registry.npmjs.org/double-ended-queue/-/double-ended-queue-2.1.0-0.tgz", 15 | "integrity": "sha1-ED01J/0xUo9AGIEwyEHv3XgmTlw=" 16 | }, 17 | "redis": { 18 | "version": "2.8.0", 19 | "resolved": "https://registry.npmjs.org/redis/-/redis-2.8.0.tgz", 20 | "integrity": "sha512-M1OkonEQwtRmZv4tEWF2VgpG0JWJ8Fv1PhlgT5+B+uNq2cA3Rt1Yt/ryoR+vQNOQcIEgdCdfH0jr3bDpihAw1A==", 21 | "requires": { 22 | "double-ended-queue": "^2.1.0-0", 23 | "redis-commands": "^1.2.0", 24 | "redis-parser": "^2.6.0" 25 | } 26 | }, 27 | "redis-commands": { 28 | "version": "1.5.0", 29 | "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.5.0.tgz", 30 | "integrity": "sha512-6KxamqpZ468MeQC3bkWmCB1fp56XL64D4Kf0zJSwDZbVLLm7KFkoIcHrgRvQ+sk8dnhySs7+yBg94yIkAK7aJg==" 31 | }, 32 | "redis-parser": { 33 | "version": "2.6.0", 34 | "resolved": "https://registry.npmjs.org/redis-parser/-/redis-parser-2.6.0.tgz", 35 | "integrity": "sha1-Uu0J2srBCPGmMcB+m2mUHnoZUEs=" 36 | } 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "redis-streams-101-node", 3 | "version": "1.0.0", 4 | "description": "Getting Started with Redis Streams and Node.js", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "keywords": [ 10 | "redis", 11 | "streams", 12 | "streaming", 13 | "101", 14 | "getting-started" 15 | ], 16 | "author": "Tugdual Grall (tugdual@gmail.com)", 17 | "license": "Apache-2.0", 18 | "dependencies": { 19 | "async": "^3.1.0", 20 | "redis": "^2.8.0" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /producer.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var redis = require('redis'); 4 | var redisClient = redis.createClient(); 5 | 6 | const STREAMS_KEY = "weather_sensor:wind"; 7 | 8 | 9 | function sleep(millis) { 10 | return new Promise(resolve => setTimeout(resolve, millis)); 11 | } 12 | 13 | async function main() { 14 | 15 | // capture the paramter 16 | const args = process.argv 17 | .slice(2) 18 | .map(arg => arg.split('=')) 19 | .reduce((args, [value, key]) => { 20 | args[value] = key; 21 | return args; 22 | }, {}); 23 | 24 | var sleep_time = 200; 25 | var loop_nb = 20; 26 | if (args && args.loop && !isNaN(args.loop)) { 27 | loop_nb = args.loop; 28 | } 29 | 30 | if (args && args.sleep && !isNaN(args.sleep)) { 31 | sleep_time = args.sleep; 32 | } 33 | 34 | console.log(`\nThis program will send ${loop_nb} messages, every ${sleep_time}ms`); 35 | 36 | for (var i = 0 ; i <= loop_nb ; i++) { 37 | console.log(`\tSending message ${i}`); 38 | 39 | // create the message values: 40 | var speed = Math.round(Math.random() * 45); 41 | var direction = Math.round(Math.random() * 359); 42 | var ts = (new Date()).getTime(); 43 | 44 | // produce the message 45 | redisClient.xadd(STREAMS_KEY, '*', 46 | 'speed', speed, 47 | 'direction', direction, 48 | 'sensor_ts', ts, 49 | 'loop_info', i, 50 | function (err) { 51 | if (err) { console.log(err) }; 52 | }); 53 | 54 | await sleep(sleep_time); 55 | 56 | if (i == loop_nb) { 57 | process.exit() 58 | } 59 | 60 | } 61 | } 62 | 63 | main(); --------------------------------------------------------------------------------