v0.6.7 proposal

.gitignore

@@ -5,7 +5,6 @@ node_modules
 *.heapsnapshot
 
 # Development helpers
-crlf.js
 dev/
 
 # Project files

.mailmap

@@ -0,0 +1,5 @@
+Alexey Orlenko <eaglexrlnk@gmail.com>
+Dmitry Borisov <dimon.durak@gmail.com> <Dimon Durak>
+Mykola Bilochub <nbelochub@gmail.com>
+Timur Shemsedinov <timur.shemsedinov@gmail.com>
+Vlad Dziuba <dzyubavlad@gmail.com> <Dzyubavlad@gmail.com>

.npmignore

@@ -4,7 +4,6 @@
 *.heapsnapshot
 
 # Development helpers
-crlf.js
 dev/
 
 # Project files
@@ -14,8 +13,10 @@ dev/
 # node-gyp build
 build/
 
-# Built docs
+# Docs
+doc/
 site/
+mkdocs.yml
 
 # Python bytecode
 *.pyc

.travis.yml

@@ -10,12 +10,15 @@ node_js:
   - "6.7"
   - "6.8"
   - "6.9"
+  - "6.10"
   - "7.0"
   - "7.1"
   - "7.2"
   - "7.3"
   - "7.4"
   - "7.5"
+  - "7.6"
+  - "7.7"
 env:
   - CXX=g++-6
 addons:

AUTHORS

@@ -1,3 +1,6 @@
 Timur Shemsedinov <timur.shemsedinov@gmail.com>
+Dmitry Borisov <dimon.durak@gmail.com>
+Artem Chernenkiy <notthewhite@gmail.com>
 Alexey Orlenko <eaglexrlnk@gmail.com>
 Mykola Bilochub <nbelochub@gmail.com>
+Vlad Dziuba <dzyubavlad@gmail.com>

CHANGELOG.md

@@ -1,5 +1,78 @@
 # `metarhia-jstp` changelog
 
+## Version 0.6.7 (2017-03-14, @aqrln)
+
+This is a bugfix release.
+
+Notable changes:
+
+ * **lib:** make failed addon loading more informative
+   *(Alexey Orlenko)*
+   [#90](https://github.com/metarhia/JSTP/pull/90)
+ * **w3c-ws:** emit missing error event
+   *(Alexey Orlenko)*
+   [#93](https://github.com/metarhia/JSTP/pull/93)
+ * **w3c-ws:** fix invalid property access
+   *(Alexey Orlenko)*
+   [#94](https://github.com/metarhia/JSTP/pull/94)
+ * **connection:** check that method arguments exist
+   *(Alexey Orlenko)*
+   [#100](https://github.com/metarhia/JSTP/pull/100)
+
+All changes:
+
+ * **doc:** fix linter warning in CHANGELOG.md
+   *(Alexey Orlenko)*
+   [#80](https://github.com/metarhia/JSTP/pull/80)
+ * **tools:** remove crlf.js from dot-ignore files
+   *(Alexey Orlenko)*
+   [#83](https://github.com/metarhia/JSTP/pull/83)
+ * **npm:** don't include doc/ and mkdocs.yml to package
+   *(Alexey Orlenko)*
+   [#82](https://github.com/metarhia/JSTP/pull/82)
+ * **doc:** add session WG meeting
+   *(Mykola Bilochub)*
+   [#81](https://github.com/metarhia/JSTP/pull/81)
+ * **lint:** update remark
+   *(Alexey Orlenko)*
+   [#87](https://github.com/metarhia/JSTP/pull/87)
+ * **test:** add Node.js 6.10 and 7.6 to .travis.yml
+   *(Alexey Orlenko)*
+   [#86](https://github.com/metarhia/JSTP/pull/86)
+ * **tools:** move build-native.js to tools
+   *(Alexey Orlenko)*
+   [#89](https://github.com/metarhia/JSTP/pull/89)
+ * **lib:** make failed addon loading more informative
+   *(Alexey Orlenko)*
+   [#90](https://github.com/metarhia/JSTP/pull/90)
+ * **w3c-ws:** emit missing error event
+   *(Alexey Orlenko)*
+   [#93](https://github.com/metarhia/JSTP/pull/93)
+ * **w3c-ws:** fix invalid property access
+   *(Alexey Orlenko)*
+   [#94](https://github.com/metarhia/JSTP/pull/94)
+ * **test:** add Node.js 7.7 to .travis.yml
+   *(Alexey Orlenko)*
+   [#95](https://github.com/metarhia/JSTP/pull/95)
+ * **connection:** change style of a forward declaration
+   *(Alexey Orlenko)*
+   [#96](https://github.com/metarhia/JSTP/pull/96)
+ * **lib:** change multiline function signatures style
+   *(Alexey Orlenko)*
+   [#97](https://github.com/metarhia/JSTP/pull/97)
+ * **tools:** generate authors list automatically
+   *(Alexey Orlenko)*
+   [#88](https://github.com/metarhia/JSTP/pull/88)
+ * **meta:** update AUTHORS and .mailmap
+   *(Alexey Orlenko)*
+   [#88](https://github.com/metarhia/JSTP/pull/88)
+ * **meta:** fix misleading language in LICENSE
+   *(Alexey Orlenko)*
+   [#88](https://github.com/metarhia/JSTP/pull/88)
+ * **connection:** check that method arguments exist
+   *(Alexey Orlenko)*
+   [#100](https://github.com/metarhia/JSTP/pull/100)
+
 ## Version 0.6.6 (2017-02-20, @aqrln)
 
 This is mostly a bugfix release. Additionally, parser performance is improved.
@@ -28,7 +101,6 @@ Notable changes:
    *(Alexey Orlenko)*
    [#78](https://github.com/metarhia/JSTP/pull/78)
 
-
 All changes:
 
  * **server:** clean internal structures on close

LICENSE

@@ -3,9 +3,8 @@ JavaScript Transfer Protocol ("JSTP") is licensed for use as follows:
 """
 MIT License
 
-Copyright (c) 2016–2017 JSTP project authors
-(see https://github.com/metarhia/JSTP/blob/master/AUTHORS for full list)
-and other JSTP contributors.
+Copyright (c) 2016–2017 JSTP contributors
+(see https://github.com/metarhia/JSTP/blob/master/AUTHORS).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

doc/meetings/2017-02-21-sessions.md

@@ -0,0 +1,65 @@
+# Sessions WG meeting
+
+Date: 2017-02-21
+
+### Invited:
+
+ * Alexey Orlenko <eaglexrlnk@gmail.com>
+   ([@aqrln](https://github.com/aqrln)) from server team
+ * Mykola Bilochub <nbelochub@gmail.com>
+   ([@belochub](https://github.com/belochub)) from server team
+ * Denys Otrishko <shishugi@gmail.com>
+   ([@lundibundi](https://github.com/lundibundi)) from Android team
+ * Andrew Vysotskyi <firemaaaan@gmail.com>
+   ([@Gagnant](https://github.com/Gagnant)) from iOS team
+
+### Present:
+
+ * Alexey Orlenko <eaglexrlnk@gmail.com>
+   ([@aqrln](https://github.com/aqrln)) from server team
+ * Mykola Bilochub <nbelochub@gmail.com>
+   ([@belochub](https://github.com/belochub)) from server team
+ * Denys Otrishko <shishugi@gmail.com>
+   ([@lundibundi](https://github.com/lundibundi)) from Android team
+
+### Agenda:
+
+ * General way of reconnection to existing sessions;
+ * Session restoration mechanisms architecture;
+ * The problems with reconnection mobile developers encountered in our last
+   project and proper ways to solve them;
+ * Handshake packet formats (for request and response) that will be used to
+   implement reconnection to existing sessions.
+
+### Conclusions:
+
+ * To make packet numbers unique for every session, not connection like it was before;
+ * To send total count of packets sent and received by each side during the session
+   in handshake packet, like this:
+
+   ```javascript
+   { handshake: [0, 'appName'], session: ['sessionId', sent_count, received_count] }
+   ```
+
+   and answer
+
+   ```javascript
+   { handshake: [0], ok: [sent_count, received_count] }
+   ```
+
+### Post-discussion additions:
+
+1. Even though packet IDs are incremented throughout the session, not the
+   connection, handshake packets are always 0 since we don't know which packet
+   IDs to use until a handshake has been performed. After that, the order
+   continues as it should have been if there hadn't been reconnection, with an
+   extra handshake being transparent.
+
+2. The standard `ERR_AUTH_FAILED` error will be used for any handshake
+   authentication strategy, regardless of it being `login`, `session` or
+   anything we may probably add later. What it means for session restoration
+   handshakes is that if session ID is invalid, the server responds with
+
+   ```javascript
+   { handshake: [0], error: [11] }
+   ```

lib/applications.js

@@ -25,11 +25,7 @@ apps.Application = Application;
 //   callback - method callback
 //
 Application.prototype.callMethod = function(
-  connection,
-  interfaceName,
-  methodName,
-  args,
-  callback
+  connection, interfaceName, methodName, args, callback
 ) {
   const appInterface = this.api[interfaceName];
   if (!appInterface) {

lib/client.js

@@ -76,10 +76,7 @@ Client.prototype.disconnect = function(callback) {
 //   callback - callback function with signature (error, connection, sessionId)
 //
 Client.prototype.connectAndHandshake = function(
-  appName,
-  username,
-  password,
-  callback
+  appName, username, password, callback
 ) {
   this.connect((error, connection) => {
     if (error) {
@@ -107,11 +104,7 @@ Client.prototype.connectAndHandshake = function(
 //     (error, connection, sessionId, api)
 //
 Client.prototype.connectAndInspect = function(
-  appName,
-  username,
-  password,
-  interfaces,
-  callback
+  appName, username, password, interfaces, callback
 ) {
   this.connectAndHandshake(
     appName, username, password, (error, connection, sid) => {

lib/common.js

@@ -33,6 +33,7 @@ common.safeRequire = (moduleName) => {
   try {
     return require(moduleName);
   } catch (err) {
+    console.warn(err.toString());
     return null;
   }
 };

lib/connection.js

@@ -16,7 +16,7 @@ let nextConnectionId = 0;
 // Mapping of packet types to handler function names (forward declaration, see
 // definition below the Connection class).
 //
-let PACKET_HANDLERS;  // eslint-disable-line prefer-const
+let PACKET_HANDLERS = null;
 
 // JSTP connection class
 //   transport - an abstract socket
@@ -73,10 +73,7 @@ util.inherits(Connection, events.EventEmitter);
 //     has been received
 //
 Connection.prototype.callMethod = function(
-  interfaceName,
-  methodName,
-  args,
-  callback
+  interfaceName, methodName, args, callback
 ) {
   const packet = this.createPacket('call', interfaceName, methodName, args);
   const packetId = packet.call[0];
@@ -110,9 +107,7 @@ Connection.prototype.callback = function(packetId, error, result) {
 //   args - event arguments as an object
 //
 Connection.prototype.emitRemoteEvent = function(
-  interfaceName,
-  eventName,
-  args
+  interfaceName, eventName, args
 ) {
   const packet = this.createPacket('event', interfaceName, eventName, args);
   this._send(packet);
@@ -478,6 +473,10 @@ Connection.prototype._processCallPacket = function(packet, keys) {
 
   const callback = this._remoteCallbackWrapper.bind(this, packetId);
 
+  if (!args) {
+    return callback(errors.ERR_INVALID_SIGNATURE);
+  }
+
   try {
     this.application.callMethod(this,
       interfaceName, methodName, args, callback);
@@ -591,9 +590,7 @@ Connection.prototype._processPongPacket = function(packet) {
 //   result - data to send back as a result
 //
 Connection.prototype._remoteCallbackWrapper = function(
-  packetId,
-  error,
-  ...result
+  packetId, error, ...result
 ) {
   this.callback(packetId, error, result);
 };

lib/record-serialization.js

@@ -23,9 +23,9 @@ if (jstpNative) {
   }
 } else {
   console.warn(
-    'JSTP native addon is not built. ' +
+    'JSTP native addon is not built or is not functional. ' +
     'Run `npm install` in order to build it, otherwise you will get ' +
-    'poor server performance under load.'
+    'poor performance.'
   );
   module.exports = require('./record-serialization-fallback');
 }

lib/transport.ws.browser.js

@@ -55,6 +55,7 @@ W3CWebSocketClient.prototype.connect = function(callback) {
     if (callback) {
       callback(error);
     }
+    this.emit('error', error);
     return;
   }
 
@@ -82,11 +83,9 @@ W3CWebSocketClient.prototype.connect = function(callback) {
 //
 W3CWebSocketClient.prototype.disconnect = function(callback) {
   transportCommon.ensureClientConnected(this);
-
   if (callback) {
-    this.connection.once('close', callback);
+    this.socketEventEmitter.once('close', callback);
   }
-
   this.socket.close();
 };
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "metarhia-jstp",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "author": "Timur Shemsedinov <timur.shemsedinov@gmail.com>",
   "description": "JavaScript Transfer Protocol for Impress Application Server",
   "license": "MIT",
@@ -49,9 +49,9 @@
     "karma-safari-launcher": "^1.0.0",
     "karma-webpack": "^2.0.1",
     "mocha": "^3.2.0",
-    "remark-cli": "^2.1.0",
-    "remark-lint": "^5.4.0",
-    "remark-validate-links": "^5.0.0",
+    "remark-cli": "^3.0.0",
+    "remark-lint": "^6.0.0",
+    "remark-validate-links": "^6.0.0",
     "webpack": "^2.2.1"
   },
   "scripts": {
@@ -64,8 +64,8 @@
     "lint": "eslint . && remark .",
     "install": "npm run rebuild-node",
     "build": "npm run build-node && npm run build-browser",
-    "build-node": "node build-native",
-    "rebuild-node": "node build-native --rebuild",
+    "build-node": "node tools/build-native",
+    "rebuild-node": "node tools/build-native --rebuild",
     "build-browser": "webpack --progress --colors",
     "prepublish": "npm run build-browser",
     "pretest": "npm run build-node"

build-native.js → tools/build-native.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 'use strict';
 
 const fs = require('fs');