README.md

Sails JavaScript Client SDK

   

JavaScript SDK for communicating w/ Sails via sockets from Node.js or the browser.

For Node.js

Why would I use this from a Node script?

Most commonly, this SDK is useful on the backend when writing tests. However, any time you'd want to use a WebSocket or Socket.io client from Node to talk to a Sails server, you can use this module to allow for the ordinary usage you're familiar with in the browser-- namely using the socket interpreter to simulate HTTP over WebSockets.

Installation

$ npm install socket.io-client --save
$ npm install sails.io.js --save

Basic Usage

var socketIOClient = require('socket.io-client');
var sailsIOClient = require('sails.io.js');

// Instantiate the socket client (`io`)
// (for now, you must explicitly pass in the socket.io client when using this library from Node.js)
var io = sailsIOClient(socketIOClient);

// Set some options:
// (you have to specify the host and port of the Sails backend when using this library from Node.js)
io.sails.url = 'http://localhost:1337';
// ...

// Send a GET request to `http://localhost:1337/hello`:
io.socket.get('/hello', function serverResponded (body, JWR) {
  // body === JWR.body
  console.log('Sails responded with: ', body);
  console.log('with headers: ', JWR.headers);
  console.log('and with status code: ', JWR.statusCode);

  // ...
  // more stuff
  // ...


  // When you are finished with `io.socket`, or any other sockets you connect manually,
  // you should make sure and disconnect them, e.g.:
  io.socket.disconnect();

  // (note that there is no callback argument to the `.disconnect` method)
});

See the tests in this repository for more examples.

========================================

For the browser

The sails.io.js client comes automatically installed in new Sails projects, but there is nothing app-specific about the client SDK. You can just as easily copy and paste it yourself, get it from Bower, or just link a script tag directly to a hosted CDN.

Always use the version of sails.io.js that is compatible with your version of Sails. The master branch of this repository includes the bleeding edge version of sails.io.js that is compatible with the master branch of Sails core and of sails-hook-sockets. If you have an older install, use the copy of sails.io.js that is included in the assets/ folder of your Sails app.

  </body>

  <!-- Import SDK (if using the linker, then this will be injected automatically) -->
  <script type="text/javascript" src="/dependencies/sails.io.js"></script>

  <!-- Example usage -->
  <script type="text/javascript">

    // `io` is available as a global.
    // `io.socket` will connect automatically, but at this point in the DOM, it is not ready yet
    // (think of $(document).ready() from jQuery)
    //
    // Fortunately, this library provides an abstraction to avoid this issue.
    // Requests you make before `io` is ready will be queued and replayed automatically when the socket connects.
    // To disable this behavior or configure other things, you can set properties on `io.sails`.
    // You have one cycle of the event loop to set `io.sails.autoConnect` to false before the auto-connection
    // behavior starts.

    io.socket.get('/hello', function serverResponded (body, JWR) {

      // JWR ==> "JSON WebSocket Response"
      console.log('Sails responded with: ', body);
      console.log('with headers: ', JWR.headers);
      console.log('and with status code: ', JWR.statusCode);

      // first argument `body` === `JWR.body`
      // (just for convenience, and to maintain familiar usage, a la `JQuery.get()`)
    });
  </script>
</html>

========================================

Advanced usage

The io.sails config functions as the default for all connected sockets, allowing you to change client behavior globally. It can be overridden on a socket-by-socket basis by passing in an object to io.sails.connect(opts)

Cross-domain

Connect to a server other than the one that served ths project (i.e. on a different domain/subdomain):

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.url = 'https://api.mysite.com';
</script>

Note that in order for req.session on a cross-domain server to work, there is a bit of pregaming that sails.io.js does behind the scenes. This is because it relies on cookies, and browsers (thankfully) do not let us access cross-origin cookies. This JavaScript SDK circumvents that issue by (1) detecting a cross-origin scenario by examining window.location (if available) and comparing it with the connection base URL, then (2) sending a JSONP request to the cross-origin server in order to gain access to a cookie. In order for that to work, the cross-origin sails server must have CORS enabled for http://yourdomain.com so that 3rd-party cookies are granted with the JSONP request. Fortunately, Sails supports this behavior out of the box.

For example, imagine the sails.io.js client is being used on a webpage served from a Sails server (or any other kind of server, like nginx) at http://yourdomain.com, but you need to connect a WebSocket to a different Sails server at http://api.your-other-domain.com. First, sails.io.js will send a JSONP request to the configured "cookie route" (i.e. /__getcookie by default). That particular "cookie route" comes with CORS enabled out of the box, which means it will grant cookies to 3rd party domains. In your config/sockets.js file, you can restrict cross-domain cookie access to particular domains (i.e. http://yourdomain.com, in this example)

Disable autoConnect and/or connect sockets manually

Disable io.socket and its auto-connecting behavior and/or connect 1 or more sockets manually:

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.autoConnect = false;

// e.g. at some point later, connect 3 sockets, using default settings
setTimeout(function (){

  // socket0 and socket1 will use default settings from `io.sails`
  var socket0 = io.sails.connect();
  var socket1 = io.sails.connect();

  // but socket2's `url` option will be overridden as specified:
  var socket2 = io.sails.connect('https://api.mysite.com');
}, 1000);
</script>

Send custom headers with socket handshake using initialConnectionHeaders

Disable session support for all connecting sockets

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.initialConnectionHeaders = {nosession: true};
</script>

Disable session support on a per-socket basis

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.autoConnect = false;
// socket 1 will have session disabled
var socket1 = io.sails.connect('http://localhost', {initialConnectionHeaders: {nosession: true}});
// socket 2 will have session enabled
var socket2 = io.sails.connect('http://localhost');
</script>

Set global headers to be used with each socket request

Set a x-csrf-token header to be sent with every request made using io.socket.* methods:

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
io.sails.headers = {
  "x-csrf-token": someToken,
};
// This POST request will now include the x-csrf-token header
io.socket.post("/foo", someData, someCallback);
</script>

Change the transports used to connect to the server

In some cases you may want to change the transorts that the socket client uses to connect to the server, and vice versa. For instance, some server environments--notably Heroku--do not support "sticky load balancing", causing the "polling" transport to fail. In these cases, you should first change the transports listed in the config/sockets.js file in your Sails app. Then change the transports in the client by setting io.sails.transports:

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
  io.sails.transports = ['websocket'];
</script>

Change the rejectUnauthorized setting used to connect to the server

As of socket.io-client version 1.4.6 and engine.io-client 1.6.9, if you are using SSL certificates to connect, rejectUnauthorized defaults to true if not explicitly set. To keep the old behavior (useful for development and testing/continuous integration environments), set it to false on the io.sails object:

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
  io.sails.rejectUnauthorized = false;
</script>

RequireJS/AMD Usage

To use this in an AMD environment, use the sails.io.js in the root of this repo, not in dist. The dist build bundles a version of the socket.io client which will cause errors when trying to load two anonymous AMD modules from the same file. The file in root is not bundled with socket.io

Usage with AMD will be very similar as node. Require in sails.io, socket.io, and instantiate the sails.io client:

define(['path/to/socketIOClient', 'path/to/sailsIOClient'], function(socketIOClient, sailsIOClient)  {
    var io = sailsIOClient(socketIOClient);
    io.sails.url = 'http:/example.com';

    io.socket.get('/example/path', { data: 'example' }, function(response) {
        console.log('got response', response)
    });
});

Muting console.log messages

Sails.io.js console.log messages are automatically muted in production environments. You can set the environment manually via io.sails.environment:

<script type="text/javascript" src="/dependencies/sails.io.js"></script>
<script type="text/javascript">
  io.sails.environment = 'production';
</script>

If not specified manually, sails.io.js will assume the development environment unless it is loaded from a URL that ends in *.min.js or #production, e.g. production.min.js or scripts.js#production.

========================================

Help

If you have further questions or are having trouble, click here.

Bugs  

To report a bug, click here.

Contributing  

Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.

This repository holds the socket client SDK for Sails versions 0.11.0 and up. If you're looking for the SDK for the v0.9.x releases of Sails, the source is located here. If you're looking for v0.10.x, check out the relevant tags.

License

This package is part of the Sails framework, and is free and open-source under the MIT License.