DoneJS StealJS jQuery++ FuncUnit DocumentJS
6.6.1
5.33.3 4.3.0 3.14.1 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-bind
      • can-compute
      • can-debug
      • can-deep-observable
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-backup
      • can-define-stream
      • can-define-stream-kefir
      • can-event-queue
      • can-kefir
      • can-list
      • can-map
      • can-map-compat
      • can-map-define
      • can-observable-array
      • can-observable-object
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Views
      • can-attribute-observable
      • can-component
      • can-observable-bindings
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-element
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-parser
      • can-view-scope
      • can-view-target
      • steal-stache
    • Data Modeling
      • can-connect
      • can-connect-ndjson
      • can-connect-tag
      • can-define-realtime-rest-model
      • can-define-rest-model
      • can-fixture
      • can-fixture-socket
        • types
          • SocketEventListener
        • properties
          • Server
            • prototype
              • emit
              • on
              • onFeathersService
              • restore
          • requestHandlerToListener
          • storeToListeners
      • can-local-store
      • can-memory-store
      • can-ndjson-stream
      • can-query-logic
      • can-realtime-rest-model
      • can-rest-model
      • can-set-legacy
      • can-super-model
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-hash
      • can-route-mock
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-diff
      • can-globals
      • can-join-uris
      • can-key
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-queues
      • can-string
      • can-string-to-any
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-child-nodes
      • can-control
      • can-dom-data
      • can-dom-events
      • can-dom-mutate
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-fragment
    • Data Validation
      • can-type
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-data-types
      • can-namespace
      • can-reflect
      • can-reflect-dependencies
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

Server

  • Edit on GitHub

Intercept socket.io messages and simulates socket.io server responses.

new Server( io )

When server is instantiated with socket.io io object it intercepts a socket.io connection and allows to mock socket.io server behaviour. On instantiation we:

  • empty io.managers object which is a cache of socket.io io.Manager instances;
  • override io.Manager.prototype to work with current instance of the mocked server.
import io from "socket.io-client";
import fixtureSocket from "can-fixture-socket";
const mockServer = new fixtureSocket.Server( io );

Parameters

  1. io {Object}:

    Imported socket.io-client object.

Use

  1. Instantiate a server to intercept socket.io connection:
import io from "socket.io-client";
import fixtureSocket from "can-fixture-socket";
const mockServer = new fixtureSocket.Server( io );
  1. Mock socket.io server behaviour:
mockServer.on( "connection", function() {
    mockServer.emit( "notifications", [ { text: "A new notification" } ] );
} );

mockServer.on( "some event", function( data, ackCb ) {
    console.log( "Client send some ", data );
    ackCb( "thanks" );
} );
  1. Test your client app:
const socket = io( "http://localhost:8080/ws" );
socket.emit( "some event", "some data", function( data ) {
    assert.equal( data, "thanks", "Server acknowledged our event" );
} );

Examples

CRUD service with fixture store

Lets see how we can test a possible implementation of a CRUD service that utilizes socket.io ACK callbacks. We will use fixture store to emulate our CRUD storage and link it to our mocked server.

import fixture from "can-fixture";

// First, lets create fixture store:
const fixtureStore = fixture.store( [
    { id: 1, title: "One", rank: "good" },
    { id: 2, title: "Two", rank: "average" },
    { id: 3, title: "Three", rank: "good" }
], new canSet.Algebra( {} ) );

// And instantiate a mocked server:
import io from "socket.io-client";

import fixtureSocket from "can-fixture-socket";
const mockServer = new fixtureSocket.Server( io );

Fixture store is designed to work with XHR requests, thus its methods take two arguments: request and response. See [can-fixture.Store.prototype.getListData] for more details. Our mocked server can listen to socket events and its event listener expects data and an optional ACK callback. To convert a request handler to an event listener we can use requestHandlerToListener:

Now we can create socket event listeners for our CRUD operations:

const toListener = fixtureSocket.requestHandlerToListener;
mockServer.on( "messages find",   toListener( fixtureStore.getListData ) );
mockServer.on( "messages get",    toListener( fixtureStore.getData     ) );
mockServer.on( "messages remove", toListener( fixtureStore.destroyData ) );
mockServer.on( "messages create", toListener( fixtureStore.createData  ) );
mockServer.on( "messages update", toListener( fixtureStore.updateData  ) );

There is also a helper storeToListeners to create all listeners at once:

var listeners = fixtureSocket.storeToListeners(messagesStore);
mockServer.on({
    "messages find": listeners.getListData,
    "messages get": listeners.getData,
    "messages remove": listeners.destroyData,
    "messages create": listeners.createData,
    "messages update": listeners.updateData
});

Now lets implement a CRUD model on our client. We define that all our ACK callbacks take an error as the first argument, and data as the second one.

const socket = io( "localhost" );

socket.emit( "messages find", { rank: "good" }, function( err, response ) {
    if ( err ) {
        console.log( "Error: ", err );
        return;
    }
    console.log( `We found ${response.count} good items`, response.data );
    assert.equal( response.count, 3 );
} );

Now lets test the rest of the methods:

socket.emit( "messages get", { id: 1 }, function( err, data ) {
    s;
    assert.deepEqual( data, { id: 1, title: "One" }, "received the item" );
} );
socket.emit( "messages update", { id: 2, title: "TwoPlus" }, function( err, data ) {
    assert.deepEqual( data, { id: 2, title: "TwoPlus" }, "received the updated item" );
} );
socket.emit( "messages get", { id: 999 }, function( err, data ) {
    assert.deepEqual( err,
        { error: 404, message: "no data" },
        "received 404 when looking for a non-existent item id"
    );
} );

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 6.6.1.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news