Skip to content

Latest commit

 

History

History
221 lines (154 loc) · 7.35 KB

CHANGELOG.md

File metadata and controls

221 lines (154 loc) · 7.35 KB

[2.1.1] - 2016-12-21

Bug Fixes

  • Fixed the generated dist release files

[2.1.0] - 2016-12-20

Features

  • Record write acknowledgement. Records are now able to be set with an optional callback which will be called with any errors from storing the record in cache/storage #290

Enhancements

  • Additional tests around presence and records #284 and #285
  • Allow passing of node socket options into constructor #289

Bug Fixes

  • Fix bug in JSON path when updating nested null values #281
  • Adding check for undefined entries in single notifier #291

[2.0.0] - 2016-11-18

Features

  • Added support for the deepstream presence API, enabling querying and subscribing to who is online within a cluster. For example: 
    ds.presence.getAll((users) => {
  users.forEach((username) => {
    console.log(`${username} is online`)
  })
})
ds.presence.subscribe((username, loggedIn) => {
  if (loggedIn) {
    console.log(`${username} has logged in`)
  } else {
    console.log(`${username} has logged out`)
  }
})

Enhancements

  • Added heartbeats over WebSocket connection
  • Presence has been added to query and subscribe to who is online with the cluster
  • E2E tests refactored

Breaking Changes

  • Supports deepstream.io v2.0.0+ only
  • Changed format of RPC request ACK messages to be more consistent with the rest of the specs #408
  • We now depend only on browser/node.js WebSockets, removing support for TCP and engine.io
  • Support for webRTC has been removed

[1.1.1] - 2016-09-30

Bug Fixes

  • Connection errors now occur on the CONNECTION topic
  • Message denied clears down associated ACK timeout messages

Enhancements

  • Optimize and refactor records by @ronag

Misc

  • Porting over remaining e2e tests
  • Adding specs as part of the client project and build

[1.1.0] - 2016-09-08

Bug Fixes

  • fix leaking internal reference to the record data #202 by @ronag

Enhancements

listen(pattern, isSubscribed, response)

add a third argument for the listen callback (client.record.listen and client.event.listen) which contains an object which two functions (accept and reject). One of these functions needs to be called otherwise you will get a deprecated message. #203 #212

This enhancements fixes some issues like #74 #155 #170

provider flag and event

Records supports now a boolean flag (record.hasProvider) which indicates whether a listener has accepted providing data. You can also subscribe to event which is triggered when the flag changes:

record.on('hasProviderChanged', hasProvider => {
  /* do something */
})
API checks are now in place that throw an error if you provide the incorrect argument amount or types #207 by @ronag

Misc

Gherkin tests are now used for E2E testing, allowing e2e tests to be run against any language rather than just node, and allows writing more scenarios much easier

[1.0.2] - 2016-07-28

Bug Fixes

  • allow do create and discard the same record in a synchronous loop #167
  • record snapshots are not waiting for isReady #140
  • record subscriptions are not waiting for isReady in combination with triggerNow #138
  • broken unsubscribe due to wrong internal argument delegation #190

Enhancements

  • provide a MAX_RECONNECTION_ATTEMPTS_REACHED event #175
  • provide a maxReconnectInterval option #176

Features

  • Terminate unauthenticated connections after a timeout #226

[1.0.1] - 2016-07-19

Bug Fixes

  • Fixed issue where deleted record was not getting removed

[1.0.0] - 2016-07-10

Features

Merge Conflict Resolution #4

Users can now set a global and per record merge strategy. This allows the application to respond to VERSION_EXISTS and use a REMOTE_WINS, LOCAL_WINS or a custom merge strategy

Global:

const client = deepstream( 'localhost:6020', {
    mergeStrategy: deepstream.MERGE_STRATEGIES.REMOTE_WINS
});

Local:

const record = client.record.getRecord( 'user/1' )
record.setMergeStrategy( ( record, remoteValue, remoteVersion, callback ) => {
  callback( null, remoteValue )
} )

Enhancements

Connection Redirects

deepstream protocol now has a connection establishment handshake that allows the client to be redirected to another deepstream before requesting/publishing data

Record deletes #111

Users can now delete content within records by setting it to undefined

record.set( path, undefined )
Reduced client size #75

Client size bundle has been reduced by not including mocks for the tcp connection

Discard/Delete only on ready #94

Record discards and deletes now get called after when ready, which makes the API cleaner

Before:

record = client.record.getRecord( 'user1' )
record.set( 'name', 'bob' )
record.onReady( () => {
  record.discard()
})

Now:

record = client.record.getRecord( 'user1' )
record
  .set( 'name', 'bob' )
  .discard()
Exposed Constants

You can now access constants on deepstream

// on the constructor
const C = deepstream.CONSTANTS;
// and instance
const client = deepstream( 'localhost:6020' )
CONST C = client.CONSTANTS;

Breaking Changes

Login callback

The login callback now only takes two arguments instead of three. This is to make it easier for the user to send their own custom data from an authentication hander or when using the http authentication handler

client.login( {}, ( success, data ) => {
  if( success ) {
    // data is meta data associated with user session
    // or null
  } else {
    // data is error message or custom error object
    // with reason why or null
  }
} )
EngineIO Default Path

We now use deepstream instead of engine.io as the default engineio path

Bug Fixes

  • Login after logout doesn't overide auth parameters #88

  • Deepstream not updating object properties #96 ( @drsirmrpresidentfathercharles )