ableton-js 3.1.2 → 3.1.4

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.4](https://github.com/leolabs/ableton.js/compare/v3.1.3...v3.1.4)
+
+- :loud_sound: Log the version of AbletonJS when it's loaded [`fae9799`](https://github.com/leolabs/ableton.js/commit/fae9799dc4650286ed0b9ebdce9a18b607643271)
+- :wrench: Bind server to 127.0.0.1 only [`bb73239`](https://github.com/leolabs/ableton.js/commit/bb73239c70ddcb881d6fd9b909bc7f74a49b81fb)
+
+#### [v3.1.3](https://github.com/leolabs/ableton.js/compare/v3.1.2...v3.1.3)
+
+> 26 February 2023
+
+- :bug: Fix opening a project file from within Finder closing all socket and file handles [`6cf2440`](https://github.com/leolabs/ableton.js/commit/6cf244057797dd45a7f5007af907947754449d5d)
+- :loud_sound: Log data that couldn't be sent [`e39c6c6`](https://github.com/leolabs/ableton.js/commit/e39c6c6b0b68823268ca715c486dbc1ab6ce7dec)
+- :loud_sound: Improve logging for event handlers [`a1fa33b`](https://github.com/leolabs/ableton.js/commit/a1fa33bb9c1c6b05352ea845c24b4637c7f80094)
+
 #### [v3.1.2](https://github.com/leolabs/ableton.js/compare/v3.1.1...v3.1.2)
 
+> 26 February 2023
+
 - :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)

package/hooks/prepublish.js

@@ -2,11 +2,11 @@ const fs = require("fs");
 const path = require("path");
 const package = require("../package.json");
 
-const internalPath = path.join(__dirname, "..", "midi-script", "Internal.py");
+const internalPath = path.join(__dirname, "..", "midi-script", "version.py");
 const file = fs.readFileSync(internalPath);
 
 const replaced = file
   .toString()
-  .replace(/return "(.+\..+\..+?)"$/m, `return "${package.version}"`);
+  .replace(/version = "(.+\..+\..+?)"$/m, `version = "${package.version}"`);
 
 fs.writeFileSync(internalPath, replaced);

package/index.js

@@ -384,7 +384,7 @@ var Ableton = /** @class */ (function (_super) {
         }
     };
     Ableton.prototype.handleUncompressedMessage = function (msg) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         this.emit("raw_message", msg);
         var data = JSON.parse(msg);
         var functionCallback = this.msgMap.get(data.uuid);
@@ -404,8 +404,8 @@ var Ableton = /** @class */ (function (_super) {
             // 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:", {
+            if (((_a = data.data) === null || _a === void 0 ? void 0 : _a.port) && ((_b = data.data) === null || _b === void 0 ? void 0 : _b.port) !== this.serverPort) {
+                (_c = this.logger) === null || _c === void 0 ? void 0 : _c.info("Got new server port via connect:", {
                     port: data.data.port,
                 });
                 this.serverPort = data.data.port;
@@ -418,7 +418,7 @@ 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:", {
+            (_d = this.logger) === null || _d === void 0 ? void 0 : _d.warn("Message could not be assigned to any request:", {
                 msg: msg,
             });
         }

package/midi-script/AbletonJS.py

@@ -1,5 +1,6 @@
 from __future__ import absolute_import
 
+from .version import version
 from .Socket import Socket
 from .Interface import Interface
 from .Application import Application
@@ -24,6 +25,8 @@ import Live
 class AbletonJS(ControlSurface):
     def __init__(self, c_instance):
         super(AbletonJS, self).__init__(c_instance)
+        self.log_message("Starting AbletonJS " + version + "...")
+
         self.tracked_midi = set()
 
         Socket.set_log(self.log_message)

package/midi-script/Interface.py

@@ -90,7 +90,8 @@ class Interface(object):
             value = self.get_prop(ns, prop)
             return self.socket.send(eventId, value)
 
-        self.log_message("Attaching listener")
+        self.log_message("Attaching listener: " +
+                         key + ", event ID: " + eventId)
         add_fn(fn)
         self.listeners[key] = {"id": eventId, "fn": fn}
         return eventId

package/midi-script/Internal.py

@@ -1,5 +1,6 @@
 from __future__ import absolute_import
 from .Interface import Interface
+from .version import version
 
 
 class Internal(Interface):
@@ -13,4 +14,4 @@ class Internal(Interface):
         return True
 
     def get_version(self, ns):
-        return "3.1.2"
+        return version

package/midi-script/Socket.py

@@ -35,11 +35,16 @@ class Socket(object):
 
     def __init__(self, handler):
         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._server_addr = ("127.0.0.1", 0)
+        self._client_addr = ("127.0.0.1", 39031)
+        self._socket = None
+
         self.read_remote_port()
-        self.init_socket()
+        self.init_socket(True)
+
+        self.file_timer = Live.Base.Timer(callback=self.read_remote_port,
+                                          interval=1000, repeat=True)
+        self.file_timer.start()
 
     def read_last_server_port(self):
         try:
@@ -56,39 +61,30 @@ class Socket(object):
     def read_remote_port(self):
         '''Reads the port our client is listening on'''
         try:
-            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)
+            old_port = self._client_addr[1]
 
-            self.remote_port_file.seek(0)
-            port = int(self.remote_port_file.read())
+            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 port != old_port:
+                    self.log_message("[" + str(id(self)) + "] Client port changed from " +
+                                     str(old_port) + " to " + str(port))
+                    self._client_addr = ("127.0.0.1", port)
 
-                if hasattr(self, "_socket"):
-                    self.send("connect", {"port": self._server_addr[1]})
+                    if 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()
-
-        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(True)
+            self.log_message("Couldn't read file: " + str(e.args))
 
     def shutdown(self):
+        self.log_message("Shutting down...")
+        self.file_timer.stop()
         self._socket.close()
-        if self.remote_port_file:
-            self.remote_port_file.close()
 
-    def bind(self, try_stored=False):
+    def init_socket(self, try_stored=False):
+        self.log_message(
+            "Initializing socket, from stored: " + str(try_stored))
+
         try:
             stored_port = self.read_last_server_port()
 
@@ -98,27 +94,40 @@ class Socket(object):
             else:
                 self._server_addr = ("127.0.0.1", 0)
 
+            self._socket = socket.socket(
+                socket.AF_INET, socket.SOCK_DGRAM)
+            self._socket.setblocking(0)
             self._socket.bind(self._server_addr)
             port = self._socket.getsockname()[1]
 
             # Write the chosen port to a file
-            if stored_port != port:
-                with open(server_port_path, "w") as file:
-                    file.write(str(port))
+            try:
+                if stored_port != port:
+                    with open(server_port_path, "w") as file:
+                        file.write(str(port))
+            except Exception as e:
+                self.log_message("Couldn't save port in file: " + str(e.args))
+                raise e
+
+            try:
+                self.send("connect", {"port": self._server_addr[1]})
+            except Exception as e:
+                self.log_message("Couldn't send connect to " +
+                                 str(self._client_addr) + ": " + str(e.args))
 
-            self.send("connect", {"port": port})
             self.show_message("Started server on port " + str(port))
 
-            self.log_message('Started on: ' + str(self._socket.getsockname()) +
-                             ', remote addr: ' + str(self._client_addr))
+            self.log_message('Started server on: ' + str(self._socket.getsockname()) +
+                             ', client addr: ' + str(self._client_addr))
         except Exception as e:
             msg = 'ERROR: Cannot bind to ' + \
                 str(self._server_addr) + ': ' + \
                 str(e.args) + ', trying again. ' + \
                 'If this keeps happening, try restarting your computer.'
-            self.show_message(msg)
             self.log_message(msg)
-            t = Timer(5, self.bind)
+            self.log_message("Client address: " + str(self._client_addr))
+            self.show_message(msg)
+            t = Timer(5, self.init_socket)
             t.start()
 
     def _sendto(self, msg):
@@ -143,16 +152,16 @@ class Socket(object):
                 return list(o)
             return str(o)
 
+        data = None
+
         try:
-            self._sendto(json.dumps(
-                {"event": name, "data": obj, "uuid": uuid}, default=jsonReplace, ensure_ascii=False))
+            data = json.dumps(
+                {"event": name, "data": obj, "uuid": uuid}, default=jsonReplace, ensure_ascii=False)
+            self._sendto(data)
         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._socket.close()
-            self.init_socket()
+            self.log_message("Socket error: " + str(e.args) + ", server: " + str(self._server_addr) +
+                             ", client: " + str(self._client_addr) + ", socket: " + str(self._socket))
+            self.log_message("Data:" + data)
         except Exception as e:
             error = str(type(e).__name__) + ': ' + str(e.args)
             self.log_message("Error " + name + "(" + str(uuid) + "): " + error)
@@ -175,6 +184,8 @@ class Socket(object):
                         buffer = bytes()
                         num_messages = 0
         except socket.error as e:
+            if (e.errno != 35):
+                self.log_message("Socket error: " + str(e.args))
             return
         except Exception as e:
             self.log_message("Error while processing: " + str(e.args))

package/midi-script/version.py

@@ -0,0 +1 @@
+version = "3.1.4"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.1.2",
+  "version": "3.1.4",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
@@ -20,14 +20,14 @@
     "ableton10:launch": "set -- /Applications/Ableton*10* && open \"$1\"",
     "ableton11:copy-script": "set -- /Applications/Ableton*11*/Contents/App-Resources/MIDI\\ Remote\\ Scripts && rm -rf \"$1/AbletonJS\" && cp -r \"$(pwd)/midi-script\" \"$1/AbletonJS\" && rm -rf \"$1/AbletonJS/_Framework\"",
     "ableton11:launch": "set -- /Applications/Ableton*11* && open \"$1\"",
-    "ableton:logs": "tail -f ~/Library/Preferences/Ableton/*/Log.txt | grep -i -e RemoteScriptError -e RemoteScriptMessage",
+    "ableton:logs": "tail -n 50 -f ~/Library/Preferences/Ableton/*/Log.txt | grep -i -e RemoteScriptError -e RemoteScriptMessage",
     "ableton:kill": "pkill -KILL -f \"Ableton Live\"",
     "ableton10:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton10:copy-script && yarn ableton10:launch && yarn ableton:logs",
     "ableton11:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton11:copy-script && yarn ableton11:launch && yarn ableton:logs",
     "prepublishOnly": "yarn build",
     "postinstall": "node hooks/postinstall.js",
     "build:doc": "jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json > ./API.md",
-    "version": "node hooks/prepublish.js && git add midi-script/Internal.py && auto-changelog -p -l 100 && git add CHANGELOG.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"
   },