ableton-js 3.2.5 → 3.2.7

package/CHANGELOG.md

@@ -4,8 +4,24 @@ 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.2.7](https://github.com/leolabs/ableton.js/compare/v3.2.6...v3.2.7)
+
+- :white_check_mark: Switch from Jest to Vitest for faster testing [`d2af8b7`](https://github.com/leolabs/ableton.js/commit/d2af8b756ff9dfe2d76927d2695fba55226ab480)
+- :mute: Don't log the result of setting the client port [`2206ab7`](https://github.com/leolabs/ableton.js/commit/2206ab74afc9d2388059d88a863dc8e5eed5a32f)
+- :sparkles: When client is already starting or started, return a promise that waits for a connection [`97c2e1a`](https://github.com/leolabs/ableton.js/commit/97c2e1a81cbe3e8e7ee2f8ef7d349903b728e67e)
+
+#### [v3.2.6](https://github.com/leolabs/ableton.js/compare/v3.2.5...v3.2.6)
+
+> 5 July 2023
+
+- :bug: Fix Live 11.3.3 hanging in some scenarios [`f3933b1`](https://github.com/leolabs/ableton.js/commit/f3933b1b714d1d87a1e4952bc142d017d513242b)
+- :mute: Make logging less noisy when the heartbeat to Live fails [`2f46968`](https://github.com/leolabs/ableton.js/commit/2f46968db10ce82288fb221d5c6e22e5fb0c6972)
+- :loud_sound: Truncate arguments in the error message when a command times out [`8bd0a9c`](https://github.com/leolabs/ableton.js/commit/8bd0a9cd7f1b4864e163fd22d87997f0d1c3dc30)
+
 #### [v3.2.5](https://github.com/leolabs/ableton.js/compare/v3.2.4...v3.2.5)
 
+> 27 June 2023
+
 - :label: Add missing types for color_index props [`23e0edb`](https://github.com/leolabs/ableton.js/commit/23e0edb13e2972264b8748afa2bcb31a94d47348)
 
 #### [v3.2.4](https://github.com/leolabs/ableton.js/compare/v3.2.3...v3.2.4)

package/index.d.ts

@@ -118,7 +118,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
      * If set, the function will throw an error if it can't establish a connection
      * in the given time. Should be higher than 2000ms to avoid false positives.
      */
-    start(timeoutMs?: number): Promise<void>;
+    start(timeoutMs?: number): Promise<unknown>;
     /** Closes the client */
     close(): Promise<void>;
     /**

package/index.js

@@ -7,6 +7,7 @@ exports.getPackageVersion = exports.Ableton = exports.TimeoutError = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const dgram_1 = __importDefault(require("dgram"));
+const lodash_1 = require("lodash");
 const events_1 = require("events");
 const uuid_1 = require("uuid");
 const semver_1 = __importDefault(require("semver"));
@@ -106,7 +107,7 @@ class Ableton extends events_1.EventEmitter {
     async start(timeoutMs) {
         if (this.clientState !== "closed") {
             this.logger?.warn("Tried calling start, but client is already " + this.clientState);
-            return;
+            return this.waitForConnection();
         }
         this.clientState = "starting";
         this.client = dgram_1.default.createSocket({ type: "udp4" });
@@ -114,23 +115,10 @@ class Ableton extends events_1.EventEmitter {
         this.client.addListener("listening", async () => {
             const port = this.client?.address().port;
             this.logger?.info("Client is bound and listening", { port });
-            // Write used port to a file so Live can read from it
+            // Write used port to a file so Live can read from it on startup
             await (0, promises_1.writeFile)(this.clientPortFile, String(port));
         });
-        try {
-            // Try binding to the port that was used last for better start performance
-            this.logger?.info("Checking if a stored port exists", {
-                file: this.clientPortFile,
-            });
-            const clientPort = await (0, promises_1.readFile)(this.clientPortFile);
-            const port = Number(clientPort.toString());
-            this.logger?.info("Trying to bind to the most recent port", { port });
-            this.client.bind(port, "127.0.0.1");
-        }
-        catch (error) {
-            this.logger?.info("Couldn't bind to last port, binding to any free port instead", { error });
-            this.client.bind(undefined, "127.0.0.1");
-        }
+        this.client.bind(undefined, "127.0.0.1");
         // Wait for the server port file to exist
         await new Promise(async (res) => {
             try {
@@ -139,7 +127,9 @@ class Ableton extends events_1.EventEmitter {
                 this.logger?.info("Server port:", { port: this.serverPort });
                 res();
             }
-            catch (e) { }
+            catch (e) {
+                this.logger?.info("Server doesn't seem to be online yet, waiting for it to go online...");
+            }
             // Set up a watcher in case the server port changes
             (0, fs_1.watchFile)(this.serverPortFile, async (curr) => {
                 if (curr.isFile()) {
@@ -153,6 +143,15 @@ class Ableton extends events_1.EventEmitter {
                 }
             });
         });
+        // Send used port to Live in case the plugin is already started
+        try {
+            const port = this.client.address().port;
+            this.logger?.info("Sending port to Live:", { port });
+            await this.setProp("internal", "", "client_port", port);
+        }
+        catch (e) {
+            this.logger?.info("Live doesn't seem to be loaded yet, waiting...");
+        }
         this.logger?.info("Checking connection...");
         const connection = this.waitForConnection();
         if (timeoutMs) {
@@ -178,9 +177,9 @@ class Ableton extends events_1.EventEmitter {
                 this.handleConnect("heartbeat");
             }
             catch (e) {
-                this.logger?.warn("Heartbeat failed:", { error: e, canceled });
                 // If the heartbeat has been canceled, don't emit a disconnect event
-                if (!canceled) {
+                if (!canceled && this._isConnected) {
+                    this.logger?.warn("Heartbeat failed:", { error: e, canceled });
                     this.handleDisconnect("heartbeat");
                 }
             }
@@ -296,7 +295,7 @@ class Ableton extends events_1.EventEmitter {
             const msg = JSON.stringify(payload);
             const timeout = this.options?.commandTimeoutMs ?? 2000;
             const timeoutId = setTimeout(() => {
-                const arg = JSON.stringify(command.args);
+                const arg = (0, lodash_1.truncate)(JSON.stringify(command.args), { length: 100 });
                 const cls = command.nsid
                     ? `${command.ns}(${command.nsid})`
                     : command.ns;

package/midi-script/Internal.py

@@ -15,3 +15,7 @@ class Internal(Interface):
 
     def get_version(self, ns):
         return version
+
+    def set_client_port(self, nsid, port):
+        self.socket.set_client_port(port)
+        return True

package/midi-script/Socket.py

@@ -19,8 +19,8 @@ def split_by_n(seq, n):
 server_port_file = "ableton-js-server.port"
 client_port_file = "ableton-js-client.port"
 
-client_port_path = os.path.join(tempfile.gettempdir(), client_port_file)
 server_port_path = os.path.join(tempfile.gettempdir(), server_port_file)
+client_port_path = os.path.join(tempfile.gettempdir(), client_port_file)
 
 
 class Socket(object):
@@ -37,22 +37,22 @@ class Socket(object):
         self.input_handler = handler
         self._server_addr = ("127.0.0.1", 0)
         self._client_addr = ("127.0.0.1", 39031)
-        self._port_file_last_modified = 0
         self._last_error = ""
         self._socket = None
 
         self.read_remote_port()
         self.init_socket(True)
 
-        self.file_timer = Live.Base.Timer(callback=self.read_remote_port,
-                                          interval=1000, repeat=True)
-        self.file_timer.start()
-
     def log_once(self, msg):
         if self._last_error != msg:
             self._last_error = msg
             self.log_message(msg)
 
+    def set_client_port(self, port):
+        self.log_message("Setting client port: ", str(port))
+        self.show_message("Client connected on port " + str(port))
+        self._client_addr = ("127.0.0.1", int(port))
+
     def read_last_server_port(self):
         try:
             with open(server_port_path) as file:
@@ -69,16 +69,7 @@ class Socket(object):
         '''Reads the port our client is listening on'''
 
         try:
-            file = os.stat(client_port_path)
-
-            print("Client port file modified: " + str(file.st_mtime) +
-                  " – last: " + str(self._port_file_last_modified))
-
-            if file.st_mtime > self._port_file_last_modified:
-                self._port_file_last_modified = file.st_mtime
-            else:
-                # If the file hasn't changed, don't try to open it
-                return
+            os.stat(client_port_path)
         except Exception as e:
             self.log_once("Couldn't stat remote port file: " + str(e.args))
             return
@@ -101,7 +92,6 @@ class Socket(object):
 
     def shutdown(self):
         self.log_message("Shutting down...")
-        self.file_timer.stop()
         self._socket.close()
 
     def init_socket(self, try_stored=False):

package/midi-script/version.py

@@ -1 +1 @@
-version = "3.2.5"
+version = "3.2.7"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.2.5",
+  "version": "3.2.7",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
@@ -27,23 +27,20 @@
     "build:doc": "jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json > ./API.md",
     "version": "node hooks/prepublish.js && git add midi-script/version.py && auto-changelog -p -l 100 && git add CHANGELOG.md",
     "build": "tsc",
-    "test": "jest --runInBand"
+    "test": "vitest --run --no-threads"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
     "@types/lodash": "^4.14.194",
     "@types/node": "^20.3.0",
     "@types/node-uuid": "^0.0.28",
     "@types/semver": "^7.3.6",
     "@types/uuid": "^8.3.0",
     "auto-changelog": "^2.3.0",
-    "jest": "^27.0.3",
-    "jest-extended": "^0.11.5",
     "lodash": "^4.17.21",
     "p-all": "^3",
-    "ts-jest": "^29.1.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.3"
+    "tsx": "^3.12.7",
+    "typescript": "^5.1.3",
+    "vitest": "^0.32.4"
   },
   "dependencies": {
     "lru-cache": "^7.14.0",

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  roots: ["<rootDir>/src"],
-  transform: {
-    "^.+\\.tsx?$": "ts-jest",
-  },
-  setupFilesAfterEnv: ["jest-extended"],
-};

package/ns/application-view.spec.d.ts

@@ -1 +0,0 @@
-import "jest-extended";

package/ns/application-view.spec.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tests_1 = require("../util/tests");
-require("jest-extended");
-const gettableProps = [
-    "browse_mode",
-    "focused_document_view",
-];
-describe("Application", () => {
-    it("should be able to read all properties without erroring", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            await Promise.all(gettableProps.map((p) => ab.application.view.get(p)));
-        });
-    });
-});

package/ns/application.spec.d.ts

@@ -1 +0,0 @@
-import "jest-extended";

package/ns/application.spec.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tests_1 = require("../util/tests");
-require("jest-extended");
-const gettableProps = [
-    "major_version",
-    "minor_version",
-    "bugfix_version",
-    "version",
-    "open_dialog_count",
-    "current_dialog_message",
-    "current_dialog_button_count",
-];
-describe("Application", () => {
-    it("should be able to read all properties without erroring", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            await Promise.all(gettableProps.map((p) => ab.application.get(p)));
-        });
-    });
-});

package/ns/mixer-device.spec.d.ts

@@ -1 +0,0 @@
-import "jest-extended";

package/ns/mixer-device.spec.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tests_1 = require("../util/tests");
-require("jest-extended");
-const gettableProps = [
-    //"crossfade_assign", (not applicable to the master track)
-    "crossfader",
-    "cue_volume",
-    "left_split_stereo",
-    "panning",
-    "panning_mode",
-    "right_split_stereo",
-    "sends",
-    "song_tempo",
-    "track_activator",
-    "volume",
-];
-describe("Mixer Device", () => {
-    it("should be able to read all properties without erroring", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            const masterTrack = await ab.song.get("master_track");
-            const mixerDevice = await masterTrack.get("mixer_device");
-            await Promise.all(gettableProps.map((p) => mixerDevice.get(p)));
-        });
-    });
-});

package/ns/song-view.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/ns/song-view.spec.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tests_1 = require("../util/tests");
-const gettableProps = [
-    "detail_clip",
-    "draw_mode",
-    "follow_song",
-    "highlighted_clip_slot",
-    "selected_chain",
-    "selected_parameter",
-    "selected_scene",
-    "selected_track",
-];
-describe("Song View", () => {
-    it("should be able to read all properties without erroring", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            await Promise.all(gettableProps.map((p) => ab.song.view.get(p)));
-        });
-    });
-});

package/ns/song.spec.d.ts

@@ -1 +0,0 @@
-import "jest-extended";

package/ns/song.spec.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tests_1 = require("../util/tests");
-require("jest-extended");
-const gettableProps = [
-    "arrangement_overdub",
-    "back_to_arranger",
-    "can_capture_midi",
-    "can_jump_to_next_cue",
-    "can_jump_to_prev_cue",
-    "can_redo",
-    "can_undo",
-    "clip_trigger_quantization",
-    "count_in_duration",
-    "cue_points",
-    "current_song_time",
-    "exclusive_arm",
-    "exclusive_solo",
-    "groove_amount",
-    "is_counting_in",
-    "is_playing",
-    "last_event_time",
-    "loop",
-    "loop_length",
-    "loop_start",
-    "master_track",
-    "metronome",
-    "midi_recording_quantization",
-    "nudge_down",
-    "nudge_up",
-    "overdub",
-    "punch_in",
-    "punch_out",
-    "re_enable_automation_enabled",
-    "record_mode",
-    "return_tracks",
-    "root_note",
-    "scale_name",
-    "scenes",
-    "select_on_launch",
-    "session_automation_record",
-    "session_record",
-    "session_record_status",
-    "signature_denominator",
-    "signature_numerator",
-    "song_length",
-    "swing_amount",
-    "tempo",
-    "tracks",
-    "visible_tracks",
-];
-describe("Song", () => {
-    it("should be able to read all properties without erroring", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            await Promise.all(gettableProps.map((p) => ab.song.get(p)));
-        });
-    });
-    it("should return the proper types for properties", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            const songTime = await ab.song.get("current_song_time");
-            expect(songTime).toBeNumber();
-            const clipTriggerQuantization = await ab.song.get("clip_trigger_quantization");
-            expect(clipTriggerQuantization).toBeString();
-            const isPlaying = await ab.song.get("is_playing");
-            expect(isPlaying).toBeBoolean();
-        });
-    });
-    it("should be able to write and read large objects from the project", async () => {
-        await (0, tests_1.withAbleton)(async (ab) => {
-            const largeArray = [];
-            for (let i = 0; i < 100000; i++) {
-                largeArray.push(i);
-            }
-            await ab.song.setData("abletonjs_test", largeArray);
-            const received = await ab.song.getData("abletonjs_test");
-            expect(received).toEqual(largeArray);
-        });
-    });
-});

package/util/package-version.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/util/package-version.spec.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const package_version_1 = require("./package-version");
-const semver_1 = require("semver");
-describe("Package Version", () => {
-    it("should get a valid package version without erroring", () => {
-        const version = (0, package_version_1.getPackageVersion)();
-        expect((0, semver_1.valid)(version)).toBeTruthy();
-    });
-});