ableton-js 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -4,8 +4,23 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v3.1.2](https://github.com/leolabs/ableton.js/compare/v3.1.1...v3.1.2)
+
+- :sparkles: Keep a handle to the client port file open for faster read performance [`2a0295d`](https://github.com/leolabs/ableton.js/commit/2a0295dff3022e3812c2a0f6077ffb7bdcd00bf0)
+- :sparkles: Try re-using the previous port for a quicker reconnect [`5c77760`](https://github.com/leolabs/ableton.js/commit/5c777606ce97295429dcac1a5685a34c8aa5abe3)
+- :bug: Fix double disconnect/connect event [`2f960be`](https://github.com/leolabs/ableton.js/commit/2f960be4c6d18b2668d15258914cd3b763be0f4a)
+
+#### [v3.1.1](https://github.com/leolabs/ableton.js/compare/v3.1.0...v3.1.1)
+
+> 25 February 2023
+
+- :loud_sound: Log connect and disconnect events [`e69f610`](https://github.com/leolabs/ableton.js/commit/e69f61098d61fd4027db4e94aad8155db5dbb504)
+- :bug: Don't count a failed ping as a successful connection event [`217e91e`](https://github.com/leolabs/ableton.js/commit/217e91ed936326c29a391ace9dcbe831125f4fa2)
+
 #### [v3.1.0](https://github.com/leolabs/ableton.js/compare/v3.0.1...v3.1.0)
 
+> 25 February 2023
+
 - :art: Extract connect and disconnect handlers into separate functions [`955a6cb`](https://github.com/leolabs/ableton.js/commit/955a6cbf132a38c6616e5e61cb8304507557d32f)
 - :sparkles: Add a `waitForConnection` function that returns a Promise that resolves when Live is connected [`3323d3d`](https://github.com/leolabs/ableton.js/commit/3323d3dba256fe86eeb85c0c6931de73337f4369)
 - :sparkles: Try a ping request in addition to waiting for the connection event [`c019e68`](https://github.com/leolabs/ableton.js/commit/c019e68b7e9744698e331b9d1fcad92b520d1a95)

package/index.d.ts

@@ -63,6 +63,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private serverPortFile;
     private logger;
     private clientState;
+    private cancelDisconnectEvent;
     constructor(options?: AbletonOptions | undefined);
     private handleConnect;
     private handleDisconnect;

package/index.js

@@ -132,6 +132,7 @@ var Ableton = /** @class */ (function (_super) {
         _this.internal = new internal_1.Internal(_this);
         _this.midi = new midi_1.Midi(_this);
         _this.clientState = "closed";
+        _this.cancelDisconnectEvent = false;
         _this.logger = options === null || options === void 0 ? void 0 : options.logger;
         _this.cache = new lru_cache_1.default(__assign({ max: 500, ttl: 1000 * 60 * 10 }, options === null || options === void 0 ? void 0 : options.cacheOptions));
         _this.clientPortFile = path_1.default.join(os_1.default.tmpdir(), (_b = (_a = _this.options) === null || _a === void 0 ? void 0 : _a.clientPortFile) !== null && _b !== void 0 ? _b : CLIENT_PORT_FILE);
@@ -139,17 +140,21 @@ var Ableton = /** @class */ (function (_super) {
         return _this;
     }
     Ableton.prototype.handleConnect = function (type) {
+        var _a;
         if (!this._isConnected) {
             this._isConnected = true;
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info("Live connected", { type: type });
             this.emit("connect", type);
         }
     };
     Ableton.prototype.handleDisconnect = function (type) {
+        var _a;
         if (this._isConnected) {
             this._isConnected = false;
             this.eventListeners.clear();
             this.msgMap.forEach(function (msg) { return msg.clearTimeout(); });
             this.msgMap.clear();
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info("Live disconnected", { type: type });
             this.emit("disconnect", type);
         }
     };
@@ -167,7 +172,7 @@ var Ableton = /** @class */ (function (_super) {
                 else {
                     return [2 /*return*/, Promise.race([
                             new Promise(function (res) { return _this.once("connect", res); }),
-                            this.internal.get("ping").catch(function () { }),
+                            this.internal.get("ping").catch(function () { return new Promise(function () { }); }),
                         ])];
                 }
                 return [2 /*return*/];
@@ -286,17 +291,22 @@ var Ableton = /** @class */ (function (_super) {
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
-                                        _a.trys.push([0, 2, , 3]);
+                                        _a.trys.push([0, 2, 3, 4]);
                                         return [4 /*yield*/, this.internal.get("ping")];
                                     case 1:
                                         _a.sent();
                                         this.handleConnect("heartbeat");
-                                        return [3 /*break*/, 3];
+                                        return [3 /*break*/, 4];
                                     case 2:
                                         e_2 = _a.sent();
-                                        this.handleDisconnect("heartbeat");
-                                        return [3 /*break*/, 3];
-                                    case 3: return [2 /*return*/];
+                                        if (!this.cancelDisconnectEvent) {
+                                            this.handleDisconnect("heartbeat");
+                                        }
+                                        return [3 /*break*/, 4];
+                                    case 3:
+                                        this.cancelDisconnectEvent = false;
+                                        return [7 /*endfinally*/];
+                                    case 4: return [2 /*return*/];
                                 }
                             });
                         }); };
@@ -391,6 +401,9 @@ var Ableton = /** @class */ (function (_super) {
             return this.handleDisconnect("realtime");
         }
         if (data.event === "connect") {
+            // If some heartbeat ping from the old connection is still pending,
+            // cancel it to prevent a double disconnect/connect event.
+            this.cancelDisconnectEvent = true;
             if (data.data.port && data.data.port !== this.serverPort) {
                 (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info("Got new server port via connect:", {
                     port: data.data.port,

package/midi-script/Internal.py

@@ -13,4 +13,4 @@ class Internal(Interface):
         return True
 
     def get_version(self, ns):
-        return "3.1.0"
+        return "3.1.2"

package/midi-script/Socket.py

@@ -37,48 +37,79 @@ class Socket(object):
         self.input_handler = handler
         self._server_addr = ('127.0.0.1', 0)
         self._client_addr = ('127.0.0.1', 39031)
+        self.remote_port_file = None
         self.read_remote_port()
         self.init_socket()
 
+    def read_last_server_port(self):
+        try:
+            with open(server_port_path) as file:
+                port = int(file.read())
+
+            self.log_message("Stored server port: " + str(port))
+            return port
+        except Exception as e:
+            self.log_message(
+                "Couldn't read stored server port: " + str(e.args))
+            return None
+
     def read_remote_port(self):
         '''Reads the port our client is listening on'''
         try:
-            with open(client_port_path) as file:
-                port = int(file.read())
-                if port != self._client_addr[1]:
-                    self.log_message("Client port changed: " + str(port))
-                    self._client_addr = ('127.0.0.1', port)
+            if self.remote_port_file == None or self.remote_port_file.closed:
+                self.log_message("Opening remote port file...")
+                self.remote_port_file = open(client_port_path)
+
+            self.remote_port_file.seek(0)
+            port = int(self.remote_port_file.read())
+
+            if port != self._client_addr[1]:
+                self.log_message("Client port changed: " + str(port))
+                self._client_addr = ('127.0.0.1', port)
 
-                    if hasattr(self, "_socket"):
-                        self.send("connect", {"port": self._server_addr[1]})
+                if hasattr(self, "_socket"):
+                    self.send("connect", {"port": self._server_addr[1]})
         except Exception as e:
             self.log_message("Couldn't read remote port:", str(e.args))
+            if self.remote_port_file:
+                self.remote_port_file.close()
 
-        t = Timer(1, self.read_remote_port)
-        t.start()
+        Timer(1, self.read_remote_port).start()
 
     def init_socket(self):
         self._socket = socket.socket(
             socket.AF_INET, socket.SOCK_DGRAM)
         self._socket.setblocking(0)
 
-        self.bind()
+        self.bind(True)
 
     def shutdown(self):
         self._socket.close()
+        if self.remote_port_file:
+            self.remote_port_file.close()
 
-    def bind(self):
+    def bind(self, try_stored=False):
         try:
+            stored_port = self.read_last_server_port()
+
+            # Try the port we used last time first
+            if try_stored and stored_port:
+                self._server_addr = ("127.0.0.1", stored_port)
+            else:
+                self._server_addr = ("127.0.0.1", 0)
+
             self._socket.bind(self._server_addr)
             port = self._socket.getsockname()[1]
 
             # Write the chosen port to a file
-            with open(server_port_path, "w") as file:
-                file.write(str(port))
+            if stored_port != port:
+                with open(server_port_path, "w") as file:
+                    file.write(str(port))
 
             self.send("connect", {"port": port})
+            self.show_message("Started server on port " + str(port))
 
-            self.log_message('Starting on: ' + str(self._socket.getsockname()) +
+            self.log_message('Started on: ' + str(self._socket.getsockname()) +
                              ', remote addr: ' + str(self._client_addr))
         except Exception as e:
             msg = 'ERROR: Cannot bind to ' + \
@@ -117,8 +148,10 @@ class Socket(object):
                 {"event": name, "data": obj, "uuid": uuid}, default=jsonReplace, ensure_ascii=False))
         except socket.error as e:
             self.log_message("Socket error: " + str(e.args))
+            self.log_message("Server: " + str(self._server_addr) +
+                             ", client: " + str(self._client_addr))
             self.log_message("Restarting socket...")
-            self.shutdown()
+            self._socket.close()
             self.init_socket()
         except Exception as e:
             error = str(type(e).__name__) + ': ' + str(e.args)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",