|
| 1 | +'use strict' |
| 2 | +/* eslint-env mocha */ |
| 3 | + |
| 4 | +const chai = require('chai') |
| 5 | +chai.use(require('dirty-chai')) |
| 6 | +chai.use(require('chai-bytes')) |
| 7 | +const { expect } = chai |
| 8 | + |
| 9 | +const pDefer = require('p-defer') |
| 10 | +const PeerStore = require('../../src/peer-store') |
| 11 | + |
| 12 | +const peerUtils = require('../utils/creators/peer') |
| 13 | +const { |
| 14 | + codes: { ERR_INVALID_PARAMETERS } |
| 15 | +} = require('../../src/errors') |
| 16 | + |
| 17 | +describe('metadataBook', () => { |
| 18 | + let peerId |
| 19 | + |
| 20 | + before(async () => { |
| 21 | + [peerId] = await peerUtils.createPeerId() |
| 22 | + }) |
| 23 | + |
| 24 | + describe('metadataBook.set', () => { |
| 25 | + let peerStore, mb |
| 26 | + |
| 27 | + beforeEach(() => { |
| 28 | + peerStore = new PeerStore() |
| 29 | + mb = peerStore.metadataBook |
| 30 | + }) |
| 31 | + |
| 32 | + afterEach(() => { |
| 33 | + peerStore.removeAllListeners() |
| 34 | + }) |
| 35 | + |
| 36 | + it('throws invalid parameters error if invalid PeerId is provided', () => { |
| 37 | + try { |
| 38 | + mb.set('invalid peerId') |
| 39 | + } catch (err) { |
| 40 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 41 | + return |
| 42 | + } |
| 43 | + throw new Error('invalid peerId should throw error') |
| 44 | + }) |
| 45 | + |
| 46 | + it('throws invalid parameters error if no key provided', () => { |
| 47 | + try { |
| 48 | + mb.set(peerId) |
| 49 | + } catch (err) { |
| 50 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 51 | + return |
| 52 | + } |
| 53 | + throw new Error('no key provided should throw error') |
| 54 | + }) |
| 55 | + |
| 56 | + it('throws invalid parameters error if no value provided', () => { |
| 57 | + try { |
| 58 | + mb.set(peerId, 'location') |
| 59 | + } catch (err) { |
| 60 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 61 | + return |
| 62 | + } |
| 63 | + throw new Error('no value provided should throw error') |
| 64 | + }) |
| 65 | + |
| 66 | + it('throws invalid parameters error if value is not a buffer', () => { |
| 67 | + try { |
| 68 | + mb.set(peerId, 'location', 'mars') |
| 69 | + } catch (err) { |
| 70 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 71 | + return |
| 72 | + } |
| 73 | + throw new Error('invalid value provided should throw error') |
| 74 | + }) |
| 75 | + |
| 76 | + it('stores the content and emit change event', () => { |
| 77 | + const defer = pDefer() |
| 78 | + const metadataKey = 'location' |
| 79 | + const metadataValue = Buffer.from('mars') |
| 80 | + |
| 81 | + peerStore.once('change:metadata', ({ peerId, metadata }) => { |
| 82 | + expect(peerId).to.exist() |
| 83 | + expect(metadata).to.equal(metadataKey) |
| 84 | + defer.resolve() |
| 85 | + }) |
| 86 | + |
| 87 | + mb.set(peerId, metadataKey, metadataValue) |
| 88 | + |
| 89 | + const value = mb.getValue(peerId, metadataKey) |
| 90 | + expect(value).to.equalBytes(metadataValue) |
| 91 | + |
| 92 | + const peerMetadata = mb.get(peerId) |
| 93 | + expect(peerMetadata).to.exist() |
| 94 | + expect(peerMetadata.get(metadataKey)).to.equalBytes(metadataValue) |
| 95 | + |
| 96 | + return defer.promise |
| 97 | + }) |
| 98 | + |
| 99 | + it('emits on set if not storing the exact same content', () => { |
| 100 | + const defer = pDefer() |
| 101 | + const metadataKey = 'location' |
| 102 | + const metadataValue1 = Buffer.from('mars') |
| 103 | + const metadataValue2 = Buffer.from('saturn') |
| 104 | + |
| 105 | + let changeCounter = 0 |
| 106 | + peerStore.on('change:metadata', () => { |
| 107 | + changeCounter++ |
| 108 | + if (changeCounter > 1) { |
| 109 | + defer.resolve() |
| 110 | + } |
| 111 | + }) |
| 112 | + |
| 113 | + // set 1 |
| 114 | + mb.set(peerId, metadataKey, metadataValue1) |
| 115 | + |
| 116 | + // set 2 (same content) |
| 117 | + mb.set(peerId, metadataKey, metadataValue2) |
| 118 | + |
| 119 | + const value = mb.getValue(peerId, metadataKey) |
| 120 | + expect(value).to.equalBytes(metadataValue2) |
| 121 | + |
| 122 | + const peerMetadata = mb.get(peerId) |
| 123 | + expect(peerMetadata).to.exist() |
| 124 | + expect(peerMetadata.get(metadataKey)).to.equalBytes(metadataValue2) |
| 125 | + |
| 126 | + return defer.promise |
| 127 | + }) |
| 128 | + |
| 129 | + it('does not emit on set if it is storing the exact same content', () => { |
| 130 | + const defer = pDefer() |
| 131 | + const metadataKey = 'location' |
| 132 | + const metadataValue = Buffer.from('mars') |
| 133 | + |
| 134 | + let changeCounter = 0 |
| 135 | + peerStore.on('change:metadata', () => { |
| 136 | + changeCounter++ |
| 137 | + if (changeCounter > 1) { |
| 138 | + defer.reject() |
| 139 | + } |
| 140 | + }) |
| 141 | + |
| 142 | + // set 1 |
| 143 | + mb.set(peerId, metadataKey, metadataValue) |
| 144 | + |
| 145 | + // set 2 (same content) |
| 146 | + mb.set(peerId, metadataKey, metadataValue) |
| 147 | + |
| 148 | + // Wait 50ms for incorrect second event |
| 149 | + setTimeout(() => { |
| 150 | + defer.resolve() |
| 151 | + }, 50) |
| 152 | + |
| 153 | + return defer.promise |
| 154 | + }) |
| 155 | + }) |
| 156 | + |
| 157 | + describe('metadataBook.get', () => { |
| 158 | + let peerStore, mb |
| 159 | + |
| 160 | + beforeEach(() => { |
| 161 | + peerStore = new PeerStore() |
| 162 | + mb = peerStore.metadataBook |
| 163 | + }) |
| 164 | + |
| 165 | + it('throws invalid parameters error if invalid PeerId is provided', () => { |
| 166 | + try { |
| 167 | + mb.get('invalid peerId') |
| 168 | + } catch (err) { |
| 169 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 170 | + return |
| 171 | + } |
| 172 | + throw new Error('invalid peerId should throw error') |
| 173 | + }) |
| 174 | + |
| 175 | + it('returns undefined if no metadata is known for the provided peer', () => { |
| 176 | + const metadata = mb.get(peerId) |
| 177 | + |
| 178 | + expect(metadata).to.not.exist() |
| 179 | + }) |
| 180 | + |
| 181 | + it('returns the metadata stored', () => { |
| 182 | + const metadataKey = 'location' |
| 183 | + const metadataValue = Buffer.from('mars') |
| 184 | + |
| 185 | + mb.set(peerId, metadataKey, metadataValue) |
| 186 | + |
| 187 | + const peerMetadata = mb.get(peerId) |
| 188 | + expect(peerMetadata).to.exist() |
| 189 | + expect(peerMetadata.get(metadataKey)).to.equalBytes(metadataValue) |
| 190 | + }) |
| 191 | + }) |
| 192 | + |
| 193 | + describe('metadataBook.getValue', () => { |
| 194 | + let peerStore, mb |
| 195 | + |
| 196 | + beforeEach(() => { |
| 197 | + peerStore = new PeerStore() |
| 198 | + mb = peerStore.metadataBook |
| 199 | + }) |
| 200 | + |
| 201 | + it('throws invalid parameters error if invalid PeerId is provided', () => { |
| 202 | + try { |
| 203 | + mb.getValue('invalid peerId') |
| 204 | + } catch (err) { |
| 205 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 206 | + return |
| 207 | + } |
| 208 | + throw new Error('invalid peerId should throw error') |
| 209 | + }) |
| 210 | + |
| 211 | + it('returns undefined if no metadata is known for the provided peer', () => { |
| 212 | + const metadataKey = 'location' |
| 213 | + const metadata = mb.getValue(peerId, metadataKey) |
| 214 | + |
| 215 | + expect(metadata).to.not.exist() |
| 216 | + }) |
| 217 | + |
| 218 | + it('returns the metadata value stored for the given key', () => { |
| 219 | + const metadataKey = 'location' |
| 220 | + const metadataValue = Buffer.from('mars') |
| 221 | + |
| 222 | + mb.set(peerId, metadataKey, metadataValue) |
| 223 | + |
| 224 | + const value = mb.getValue(peerId, metadataKey) |
| 225 | + expect(value).to.exist() |
| 226 | + expect(value).to.equalBytes(metadataValue) |
| 227 | + }) |
| 228 | + |
| 229 | + it('returns undefined if no metadata is known for the provided peer and key', () => { |
| 230 | + const metadataKey = 'location' |
| 231 | + const metadataBadKey = 'nickname' |
| 232 | + const metadataValue = Buffer.from('mars') |
| 233 | + |
| 234 | + mb.set(peerId, metadataKey, metadataValue) |
| 235 | + |
| 236 | + const metadata = mb.getValue(peerId, metadataBadKey) |
| 237 | + |
| 238 | + expect(metadata).to.not.exist() |
| 239 | + }) |
| 240 | + }) |
| 241 | + |
| 242 | + describe('metadataBook.delete', () => { |
| 243 | + let peerStore, mb |
| 244 | + |
| 245 | + beforeEach(() => { |
| 246 | + peerStore = new PeerStore() |
| 247 | + mb = peerStore.metadataBook |
| 248 | + }) |
| 249 | + |
| 250 | + it('throwns invalid parameters error if invalid PeerId is provided', () => { |
| 251 | + try { |
| 252 | + mb.delete('invalid peerId') |
| 253 | + } catch (err) { |
| 254 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 255 | + return |
| 256 | + } |
| 257 | + throw new Error('invalid peerId should throw error') |
| 258 | + }) |
| 259 | + |
| 260 | + it('returns false if no records exist for the peer and no event is emitted', () => { |
| 261 | + const defer = pDefer() |
| 262 | + |
| 263 | + peerStore.on('change:metadata', () => { |
| 264 | + defer.reject() |
| 265 | + }) |
| 266 | + |
| 267 | + const deleted = mb.delete(peerId) |
| 268 | + |
| 269 | + expect(deleted).to.equal(false) |
| 270 | + |
| 271 | + // Wait 50ms for incorrect invalid event |
| 272 | + setTimeout(() => { |
| 273 | + defer.resolve() |
| 274 | + }, 50) |
| 275 | + |
| 276 | + return defer.promise |
| 277 | + }) |
| 278 | + |
| 279 | + it('returns true if the record exists and an event is emitted', () => { |
| 280 | + const defer = pDefer() |
| 281 | + const metadataKey = 'location' |
| 282 | + const metadataValue = Buffer.from('mars') |
| 283 | + |
| 284 | + mb.set(peerId, metadataKey, metadataValue) |
| 285 | + |
| 286 | + // Listen after set |
| 287 | + peerStore.on('change:metadata', () => { |
| 288 | + defer.resolve() |
| 289 | + }) |
| 290 | + |
| 291 | + const deleted = mb.delete(peerId) |
| 292 | + |
| 293 | + expect(deleted).to.equal(true) |
| 294 | + |
| 295 | + return defer.promise |
| 296 | + }) |
| 297 | + }) |
| 298 | + |
| 299 | + describe('metadataBook.deleteValue', () => { |
| 300 | + let peerStore, mb |
| 301 | + |
| 302 | + beforeEach(() => { |
| 303 | + peerStore = new PeerStore() |
| 304 | + mb = peerStore.metadataBook |
| 305 | + }) |
| 306 | + |
| 307 | + it('throws invalid parameters error if invalid PeerId is provided', () => { |
| 308 | + try { |
| 309 | + mb.deleteValue('invalid peerId') |
| 310 | + } catch (err) { |
| 311 | + expect(err.code).to.equal(ERR_INVALID_PARAMETERS) |
| 312 | + return |
| 313 | + } |
| 314 | + throw new Error('invalid peerId should throw error') |
| 315 | + }) |
| 316 | + |
| 317 | + it('returns false if no records exist for the peer and no event is emitted', () => { |
| 318 | + const defer = pDefer() |
| 319 | + const metadataKey = 'location' |
| 320 | + |
| 321 | + peerStore.on('change:metadata', () => { |
| 322 | + defer.reject() |
| 323 | + }) |
| 324 | + |
| 325 | + const deleted = mb.deleteValue(peerId, metadataKey) |
| 326 | + |
| 327 | + expect(deleted).to.equal(false) |
| 328 | + |
| 329 | + // Wait 50ms for incorrect invalid event |
| 330 | + setTimeout(() => { |
| 331 | + defer.resolve() |
| 332 | + }, 50) |
| 333 | + |
| 334 | + return defer.promise |
| 335 | + }) |
| 336 | + |
| 337 | + it('returns true if the record exists and an event is emitted', () => { |
| 338 | + const defer = pDefer() |
| 339 | + const metadataKey = 'location' |
| 340 | + const metadataValue = Buffer.from('mars') |
| 341 | + |
| 342 | + mb.set(peerId, metadataKey, metadataValue) |
| 343 | + |
| 344 | + // Listen after set |
| 345 | + peerStore.on('change:metadata', () => { |
| 346 | + defer.resolve() |
| 347 | + }) |
| 348 | + |
| 349 | + const deleted = mb.deleteValue(peerId, metadataKey) |
| 350 | + |
| 351 | + expect(deleted).to.equal(true) |
| 352 | + |
| 353 | + return defer.promise |
| 354 | + }) |
| 355 | + |
| 356 | + it('returns false if there is a record for the peer but not the given metadata key', () => { |
| 357 | + const defer = pDefer() |
| 358 | + const metadataKey = 'location' |
| 359 | + const metadataBadKey = 'nickname' |
| 360 | + const metadataValue = Buffer.from('mars') |
| 361 | + |
| 362 | + mb.set(peerId, metadataKey, metadataValue) |
| 363 | + |
| 364 | + peerStore.on('change:metadata', () => { |
| 365 | + defer.reject() |
| 366 | + }) |
| 367 | + |
| 368 | + const deleted = mb.deleteValue(peerId, metadataBadKey) |
| 369 | + |
| 370 | + expect(deleted).to.equal(false) |
| 371 | + |
| 372 | + // Wait 50ms for incorrect invalid event |
| 373 | + setTimeout(() => { |
| 374 | + defer.resolve() |
| 375 | + }, 50) |
| 376 | + |
| 377 | + return defer.promise |
| 378 | + }) |
| 379 | + }) |
| 380 | +}) |
0 commit comments