ableton-js 3.0.1 → 3.1.1

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.1](https://github.com/leolabs/ableton.js/compare/v3.1.0...v3.1.1)
+
+- :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)
+
 #### [v3.0.1](https://github.com/leolabs/ableton.js/compare/v3.0.0...v3.0.1)
 
+> 25 February 2023
+
 - :memo: Add breaking change reminder to the changelog [`3158328`](https://github.com/leolabs/ableton.js/commit/31583280950ac4c9a4d8d425592c05481ee7b3e7)
 - :sparkles: Don't allow starting the server multiple times [`83a42b1`](https://github.com/leolabs/ableton.js/commit/83a42b1186ede6820efa13c6cec7b599693a1bb5)
 

package/index.d.ts

@@ -18,10 +18,11 @@ interface Command {
         [k: string]: any;
     };
 }
-declare type ConnectionEventType = "realtime" | "heartbeat";
+declare type DisconnectEventType = "realtime" | "heartbeat";
+declare type ConnectEventType = DisconnectEventType | "start";
 interface ConnectionEventEmitter {
-    on(e: "connect", l: (t: ConnectionEventType) => void): this;
-    on(e: "disconnect", l: (t: ConnectionEventType) => void): this;
+    on(e: "connect", l: (t: ConnectEventType) => void): this;
+    on(e: "disconnect", l: (t: DisconnectEventType) => void): this;
     on(e: "message", l: (t: any) => void): this;
     on(e: "error", l: (t: Error) => void): this;
     on(e: "ping", l: (t: number) => void): this;
@@ -50,7 +51,6 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private eventListeners;
     private heartbeatInterval;
     private _isConnected;
-    private cancelConnectionEvent;
     private buffer;
     private latency;
     private serverPort;
@@ -64,6 +64,13 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private logger;
     private clientState;
     constructor(options?: AbletonOptions | undefined);
+    private handleConnect;
+    private handleDisconnect;
+    /**
+     * If connected, returns immediately. Otherwise,
+     * it waits for a connection event before returning.
+     */
+    waitForConnection(): Promise<unknown>;
     /**
      * Starts the server and waits for a connection with Live to be established.
      *

package/index.js

@@ -125,7 +125,6 @@ var Ableton = /** @class */ (function (_super) {
         _this.msgMap = new Map();
         _this.eventListeners = new Map();
         _this._isConnected = false;
-        _this.cancelConnectionEvent = false;
         _this.buffer = [];
         _this.latency = 0;
         _this.song = new song_1.Song(_this);
@@ -139,6 +138,46 @@ var Ableton = /** @class */ (function (_super) {
         _this.serverPortFile = path_1.default.join(os_1.default.tmpdir(), (_d = (_c = _this.options) === null || _c === void 0 ? void 0 : _c.serverPortFile) !== null && _d !== void 0 ? _d : SERVER_PORT_FILE);
         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);
+        }
+    };
+    /**
+     * If connected, returns immediately. Otherwise,
+     * it waits for a connection event before returning.
+     */
+    Ableton.prototype.waitForConnection = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                if (this._isConnected) {
+                    return [2 /*return*/];
+                }
+                else {
+                    return [2 /*return*/, Promise.race([
+                            new Promise(function (res) { return _this.once("connect", res); }),
+                            this.internal.get("ping").catch(function () { return new Promise(function () { }); }),
+                        ])];
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
     /**
      * Starts the server and waits for a connection with Live to be established.
      *
@@ -229,7 +268,7 @@ var Ableton = /** @class */ (function (_super) {
                         // Wait for the server port file to exist
                         _f.sent();
                         (_b = this.logger) === null || _b === void 0 ? void 0 : _b.info("Checking connection...");
-                        connection = new Promise(function (res) { return _this.once("connect", res); });
+                        connection = this.waitForConnection();
                         if (!timeoutMs) return [3 /*break*/, 3];
                         timeout = new Promise(function (_, rej) {
                             return setTimeout(function () { return rej("Connection timed out."); }, timeoutMs);
@@ -245,34 +284,23 @@ var Ableton = /** @class */ (function (_super) {
                     case 5:
                         (_c = this.logger) === null || _c === void 0 ? void 0 : _c.info("Got connection!");
                         this.clientState = "started";
+                        this.handleConnect("start");
                         heartbeat = function () { return __awaiter(_this, void 0, void 0, function () {
                             var e_2;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0:
-                                        this.cancelConnectionEvent = false;
-                                        _a.label = 1;
-                                    case 1:
-                                        _a.trys.push([1, 3, , 4]);
+                                        _a.trys.push([0, 2, , 3]);
                                         return [4 /*yield*/, this.internal.get("ping")];
-                                    case 2:
+                                    case 1:
                                         _a.sent();
-                                        if (!this._isConnected && !this.cancelConnectionEvent) {
-                                            this._isConnected = true;
-                                            this.emit("connect", "heartbeat");
-                                        }
-                                        return [3 /*break*/, 4];
-                                    case 3:
+                                        this.handleConnect("heartbeat");
+                                        return [3 /*break*/, 3];
+                                    case 2:
                                         e_2 = _a.sent();
-                                        if (this._isConnected && !this.cancelConnectionEvent) {
-                                            this._isConnected = false;
-                                            this.eventListeners.clear();
-                                            this.msgMap.forEach(function (msg) { return msg.clearTimeout(); });
-                                            this.msgMap.clear();
-                                            this.emit("disconnect", "heartbeat");
-                                        }
-                                        return [3 /*break*/, 4];
-                                    case 4: return [2 /*return*/];
+                                        this.handleDisconnect("heartbeat");
+                                        return [3 /*break*/, 3];
+                                    case 3: return [2 /*return*/];
                                 }
                             });
                         }); };
@@ -301,7 +329,6 @@ var Ableton = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.cancelConnectionEvent = true;
                         fs_1.unwatchFile(this.serverPortFile);
                         if (this.heartbeatInterval) {
                             clearInterval(this.heartbeatInterval);
@@ -315,6 +342,7 @@ var Ableton = /** @class */ (function (_super) {
                         _a.label = 2;
                     case 2:
                         this.clientState = "closed";
+                        this._isConnected = false;
                         return [2 /*return*/];
                 }
             });
@@ -332,6 +360,7 @@ var Ableton = /** @class */ (function (_super) {
         this.emit("ping", this.latency);
     };
     Ableton.prototype.handleIncoming = function (msg, info) {
+        var _a;
         try {
             var index = msg[0];
             var message = msg.slice(1);
@@ -344,11 +373,12 @@ var Ableton = /** @class */ (function (_super) {
         }
         catch (e) {
             this.buffer = [];
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn("Couldn't handle message:", { error: e });
             this.emit("error", e);
         }
     };
     Ableton.prototype.handleUncompressedMessage = function (msg) {
-        var _a;
+        var _a, _b;
         this.emit("raw_message", msg);
         var data = JSON.parse(msg);
         var functionCallback = this.msgMap.get(data.uuid);
@@ -362,15 +392,7 @@ var Ableton = /** @class */ (function (_super) {
             return functionCallback.rej(new Error(data.data));
         }
         if (data.event === "disconnect") {
-            this.eventListeners.clear();
-            this.msgMap.forEach(function (msg) { return msg.clearTimeout(); });
-            this.msgMap.clear();
-            if (this._isConnected === true) {
-                this._isConnected = false;
-                this.cancelConnectionEvent = true;
-                this.emit("disconnect", "realtime");
-            }
-            return;
+            return this.handleDisconnect("realtime");
         }
         if (data.event === "connect") {
             if (data.data.port && data.data.port !== this.serverPort) {
@@ -379,12 +401,7 @@ var Ableton = /** @class */ (function (_super) {
                 });
                 this.serverPort = data.data.port;
             }
-            if (this._isConnected === false) {
-                this._isConnected = true;
-                this.cancelConnectionEvent = true;
-                this.emit("connect", "realtime");
-            }
-            return;
+            return this.handleConnect(this.clientState === "starting" ? "start" : "realtime");
         }
         var eventCallback = this.eventListeners.get(data.event);
         if (eventCallback) {
@@ -392,6 +409,9 @@ var Ableton = /** @class */ (function (_super) {
         }
         if (data.uuid) {
             this.emit("error", "Message could not be assigned to any request: " + msg);
+            (_b = this.logger) === null || _b === void 0 ? void 0 : _b.warn("Message could not be assigned to any request:", {
+                msg: msg,
+            });
         }
     };
     /**

package/midi-script/Internal.py

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

package/package.json

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