├── .gitignore ├── LICENSE ├── README.md ├── package.json └── src └── index.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ -------------------------------------------------------------------------------- /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 | <<<<<<< HEAD 190 | Copyright [yyyy] [name of copyright owner] 191 | ======= 192 | Copyright [2021] [JoaoOtavioS] 193 | >>>>>>> fd9bea9 (1.0.0) 194 | 195 | Licensed under the Apache License, Version 2.0 (the "License"); 196 | you may not use this file except in compliance with the License. 197 | You may obtain a copy of the License at 198 | 199 | http://www.apache.org/licenses/LICENSE-2.0 200 | 201 | Unless required by applicable law or agreed to in writing, software 202 | distributed under the License is distributed on an "AS IS" BASIS, 203 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 204 | See the License for the specific language governing permissions and 205 | limitations under the License. 206 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Information 2 | A simple way to use something similar to the Map in javascript, but synchronized with the power of Redis. 3 | 4 | ## Install 5 | ``` 6 | npm install @squarecloudofc/redis-map 7 | ``` 8 | 9 | ## Example of usage 10 | ```javascript 11 | const { RedisAPI, RedisMap } = require("@squarecloudofc/redis-map"); 12 | 13 | (async () => { 14 | 15 | const connections = await new RedisAPI({ 16 | url: process.env.REDIS, 17 | monitor: (type, message) => { 18 | console.log(`[REDIS] ${type}: ${message}`); 19 | } 20 | }).connect(); 21 | 22 | // Example using same connection (for two maps); 23 | 24 | // first map; 25 | const cacheUsers = new RedisMap({ 26 | connections, 27 | name: "example:cache:users", 28 | monitor: (type, message, name) => { 29 | console.log(name, type, message); 30 | } 31 | }); 32 | 33 | // second map; 34 | const cacheApps = new RedisMap({ 35 | connections, 36 | name: "example:cache:apps", 37 | sync: false // disable sync with redis; 38 | }); 39 | 40 | await cacheUsers.set("joao", { plan: "free", balance: 1000 }); 41 | console.log(cacheUsers.get("joao"), "\n"); 42 | 43 | await cacheApps.set("water_man", { protection: 10, shield: 50 }); 44 | console.log(cacheApps.get("water_man"), "\n"); 45 | 46 | connections.disconnect(); 47 | 48 | })(); 49 | ``` 50 | 51 | ## LICENSE 52 | This project is licensed under the Apache License 2.0. 53 | 54 | Sponsored by [Square Cloud](https://squarecloud.app/). -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@squarecloudofc/redis-map", 3 | "version": "1.0.1", 4 | "description": "A simple way to use something similar to the Map in javascript, but synchronized with the power of Redis.", 5 | "main": "src/index.js", 6 | "dependencies": { 7 | "redis": "^4.6.10" 8 | }, 9 | "scripts": { 10 | "test": "echo \"Error: no test specified\" && exit 1" 11 | }, 12 | "keywords": [ 13 | "redis", 14 | "map", 15 | "synchronized" 16 | ], 17 | "author": "JoaoOtavioS", 18 | "license": "Apache-2.0", 19 | "repository": { 20 | "type": "git", 21 | "url": "git+https://github.com/squarecloudofc/redis-map.git" 22 | }, 23 | "bugs": { 24 | "url": "https://github.com/squarecloudofc/redis-map/issues" 25 | }, 26 | "homepage": "https://github.com/squarecloudofc/redis-map#readme" 27 | } 28 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | // Created with ❤️ by @joaootavios to @squarecloudofc 2 | const redis = require("redis"); 3 | 4 | const Action = { 5 | SET: 1, 6 | DELETE: 2, 7 | CLEAR: 3 8 | }; 9 | 10 | class RedisAPI { 11 | 12 | #redis; 13 | #pubsub; 14 | #monitor; 15 | 16 | /** 17 | * Initialize the RedisMap class. 18 | * @param {Object} options Options. 19 | * @param {String} options.url Redis url. 20 | * @param {Function} options.monitor Callback function. Args: (type = "state / error", message = string). 21 | * @param {Object} options.redisOptions Redis options. (Default: {}). 22 | */ 23 | constructor(options) { 24 | 25 | const url = options?.url; 26 | 27 | if (!url || !url.match(/redis:\/\//g)) { 28 | throw new Error("[redis-map] Invalid redis url!"); 29 | }; 30 | 31 | this.#redis = redis.createClient({ url, ...options?.redisOptions }); 32 | this.#pubsub = this.#redis.duplicate(); 33 | this.#monitor = options?.monitor; 34 | 35 | this.#redis.on("connect", () => this.#log("state", "[redis-map] Redis client connected!")); 36 | this.#pubsub.on("connect", () => this.#log("state", "[redis-map] Redis pubsub connected!")); 37 | 38 | this.#redis.on("error", (err) => this.#log("error", `[redis-map] Redis error: ${err}`)); 39 | this.#pubsub.on("error", (err) => this.#log("error", `[redis-map] Redis pubsub error: ${err}`)); 40 | 41 | } 42 | 43 | /** 44 | * Connect to Redis. 45 | * @returns {Object} Redis connection information. 46 | */ 47 | async connect() { 48 | 49 | if (this.#pubsub.isOpen && this.#redis.isOpen) return; 50 | await Promise.all([this.#redis.connect(), this.#pubsub.connect()]); 51 | 52 | // Enable expired events for keyspace notifications in all maps. 53 | this.#pubsub.configSet("notify-keyspace-events", "Ex"); 54 | 55 | return { 56 | redis: this.#redis, 57 | pubsub: this.#pubsub, 58 | disconnect: this.disconnect.bind(this) 59 | } 60 | } 61 | 62 | /** 63 | * Disconnect from Redis. 64 | */ 65 | async disconnect() { 66 | if (!this.#pubsub.isOpen && !this.#redis.isOpen) return; 67 | await Promise.all([ 68 | this.#redis.quit(), 69 | this.#pubsub.quit() 70 | ]); 71 | } 72 | 73 | /** 74 | * Log a message. 75 | * @param {String} type Log type. 76 | * @param {String} message Log message. 77 | */ 78 | #log(type, message) { 79 | if (this.#monitor) this.#monitor(type, message); 80 | } 81 | 82 | } 83 | 84 | class RedisMap { 85 | #redis; 86 | #pubsub; 87 | #options; 88 | 89 | /** 90 | * Initialize the RedisMap class. 91 | * @param {Object} options Options. 92 | * @param {String} options.name Name of the map. (Default: redis-map). 93 | * @param {Boolean} options.sync Sync data from redis on init. (Default: true). 94 | * @param {Function} options.monitor Callback function. Args: (type = "state / info / error", message = string, name = name of the map). 95 | */ 96 | constructor(options) { 97 | 98 | this.name = options?.name || "redis-map"; 99 | this.#options = options; 100 | this.data = {}; 101 | 102 | this.#redis = options?.connections?.redis; 103 | this.#pubsub = options?.connections?.pubsub; 104 | 105 | if (!(this.#redis.isOpen || this.#pubsub.isOpen)) { 106 | throw new Error("[redis-map] Redis client is not connected!"); 107 | }; 108 | 109 | if (this.#options?.sync !== false) this.sync(); 110 | this.#subscribe(); 111 | } 112 | 113 | get(key) { 114 | return this.data[key] || null; 115 | } 116 | 117 | has(key) { 118 | return key in this.data; 119 | } 120 | 121 | entries() { 122 | return Object.entries(this.data); 123 | } 124 | 125 | /** 126 | * Set a value to the map in local cache and redis. 127 | * @param {String} key Key 128 | * @param {*} value Value 129 | * @param {Number} expire Expire key in seconds. 130 | */ 131 | async set(key, value, expire) { 132 | this.data[key] = value; 133 | 134 | const pipeline = this.#redis.multi(); 135 | 136 | pipeline.set(this.name, JSON.stringify(value)); 137 | pipeline.publish(this.name, JSON.stringify({ a: Action.SET, key, value })); 138 | 139 | if (expire) { 140 | pipeline.set(`rmap-${this.name}-ex=${key}`, 0, { EX: expire }); 141 | } 142 | 143 | await pipeline.exec(); 144 | } 145 | 146 | /** 147 | * Delete a value from the map in local cache and redis. 148 | * @param {String} key 149 | */ 150 | async delete(key) { 151 | delete this.data[key]; 152 | 153 | const pipeline = this.#redis.multi(); 154 | 155 | pipeline.set(this.name, JSON.stringify(this.data)); 156 | pipeline.publish(this.name, JSON.stringify({ a: Action.DELETE, key })); 157 | 158 | await pipeline.exec(); 159 | } 160 | 161 | /** 162 | * WARNING: This method will clear all data from the map in local cache and redis. 163 | */ 164 | async clear() { 165 | const pipeline = this.#redis.multi(); 166 | 167 | pipeline.del(this.name); 168 | pipeline.publish(this.name, JSON.stringify({ a: Action.CLEAR })); 169 | 170 | await pipeline.exec(); 171 | } 172 | 173 | async sync() { 174 | const data = await this.#redis.get(this.name).catch(() => null); 175 | 176 | if (data) { 177 | this.data = JSON.parse(data); 178 | this.#log("info", `[${this.name}] Redis data synced!`); 179 | } else { 180 | this.#log("info", `[${this.name}] No data found on redis to sync!`); 181 | } 182 | } 183 | 184 | #log(type, message) { 185 | if (this.#options?.monitor) this.#options.monitor(type, message, this.name); 186 | } 187 | 188 | #subscribe() { 189 | 190 | this.#pubsub.pSubscribe("__keyevent@0__:expired", (data) => { 191 | if (data.startsWith(`rmap-${this.name}-ex`)) { 192 | delete this.data[data.split("=")[1]]; 193 | } 194 | }); 195 | 196 | this.#pubsub.subscribe(this.name, (message) => { 197 | const { a: action, key, value } = JSON.parse(message); 198 | 199 | this.#log("info", { action, key, value }); 200 | 201 | switch (action) { 202 | case Action.SET: 203 | this.data[key] = value; 204 | break; 205 | case Action.DELETE: 206 | delete this.data[key]; 207 | break; 208 | case Action.CLEAR: 209 | this.data = {}; 210 | break; 211 | } 212 | }); 213 | } 214 | 215 | } 216 | 217 | module.exports = { 218 | RedisAPI, 219 | RedisMap 220 | }; 221 | --------------------------------------------------------------------------------