refactor: improve osc server design (#218)

* refactor: improve osc server design

* pr remarks

Author: ndr-brt

.github/workflows/ci.yml

@@ -16,6 +16,11 @@ jobs:
     - uses: actions/checkout@v4
     - if:  matrix.os == 'ubuntu-latest'
       run: sudo apt install libsecret-1-0
+    - uses: actions/setup-node@v4
+      with:
+       node-version: 22
+       cache: 'npm'
+    - run: npm install
     - name: Setup Pulsar Editor
       uses: pulsar-edit/[email protected]
     - name: Run the headless Pulsar Tests

lib/osc-eval.js

@@ -0,0 +1,18 @@
+'use babel'
+
+import Repl from './repl';
+import {Editors} from './editors';
+
+export function oscEvalSubscriber(tidalRepl: Repl, editors: Editors) {
+    return (message: {}): void => {
+        if (message['tab'] !== undefined) {
+            atom.workspace.getPanes()[0].setActiveItem(atom.workspace.getTextEditors()[message['tab']])
+        }
+
+        if (message['row'] && message['column']) {
+            editors.goTo(message['row'] - 1, message['column'])
+        }
+
+        tidalRepl.eval(message['type'], false);
+    }
+}

lib/osc-loader.js

@@ -1,34 +1,55 @@
 'use babel'
 
 const dgram = require('dgram');
-const oscPortProperty = 'tidalcycles.oscEval.port';
-const oscIpProperty = 'tidalcycles.oscEval.ip';
+const osc = require('osc-min');
 
 export default class OscServer {
 
     port = null;
     ip = null;
     sock = null;
     consoleView = null;
+    subscribers: Map<string, Function> = new Map();
 
-    constructor(consoleView) {
-        this.port =  atom.config.get(oscPortProperty);
-        this.ip =  atom.config.get(oscIpProperty);
+    constructor(consoleView, ip, port) {
+        this.ip = ip;
+        this.port = port;
         this.consoleView = consoleView;
         this.sock = dgram.createSocket('udp4');
     }
 
-    start() {
-        this.sock.on('error', (err) => {
-           this.consoleView.logStderr(`OSC server error: \n${err.stack}`)
-           this.sock.close();
-        });
+    start(): Promise<void> {
+        let promise = new Promise((resolve, reject) => {
+            this.sock.on('listening', () => {
+                resolve()
+            });
 
-        this.sock.on('listening', () => {
-            this.consoleView.logStdout(`Listening for external osc messages on ${this.ip}:${this.port}`)
+            this.sock.on('error', (err) => {
+                reject(err);
+            });
         });
 
         this.sock.bind(this.port, this.ip);
+
+        this.sock.on('message', (message) => {
+            let oscMessage = osc.fromBuffer(message);
+
+            let subscriber = this.subscribers.get(oscMessage.address);
+            if (subscriber) {
+                subscriber(this.#asDictionary(oscMessage.args))
+            } else {
+                this.consoleView.logStderr(`Received OSC message on unsupported ${oscMessage.address} address`);
+            }
+        });
+
+        return promise
+            .then(() => {
+                this.consoleView.logStdout(`Listening for external osc messages on ${this.ip}:${this.port}`)
+            })
+            .catch(err => {
+                this.consoleView.logStderr(`OSC server error: \n${err.stack}`)
+                this.sock.close();
+            });
     }
 
     stop() {
@@ -40,4 +61,17 @@ export default class OscServer {
     destroy() {
         this.stop();
     }
+
+    register(address: string, listener: Function) {
+        this.subscribers.set(address, listener)
+    }
+
+    #asDictionary (oscMap): {} {
+        let dictionary = {}
+        for (let i = 0; i < oscMap.length; i += 2) {
+            dictionary[oscMap[i].value] = oscMap[i+1].value
+        }
+        return dictionary
+    }
+
 }

lib/osc-server.js

@@ -3,11 +3,13 @@
 import ConsoleView from './console-view';
 import Repl from './repl';
 import TidalListenerRepl from './tidal-listener-repl';
-import OscLoader from './osc-loader';
+import {oscEvalSubscriber} from './osc-eval';
 import AutocompleteProvider from './autocomplete-provider';
 import Ghc from './ghc';
 import BootTidal from './boot-tidal';
 import SoundBrowser from './sound-browser';
+import OscServer from "./osc-server";
+
 const Status = require('./status')
 const SuperDirt = require('./superdirt')
 const { LINE, MULTI_LINE, WHOLE_EDITOR, Editors } = require('./editors')
@@ -20,6 +22,7 @@ export default {
     status: new Status(),
     editors: new Editors(),
     superDirt: new SuperDirt(),
+    oscServers: [OscServer] = [],
 
     activate() {
       if (atom.config.get('tidalcycles.superDirt.autostart')) {
@@ -38,14 +41,17 @@ export default {
         this.repl = new Repl(this.consoleView, this.ghc, this.bootTidal, this.status, this.editors);
       }
 
-      if (atom.config.get('tidalcycles.oscEval.enable')) {
-        this.oscLoader = new OscLoader(this.consoleView, this.repl, this.editors);
-        this.oscLoader.init();
+      if (atom.clonfig.get('tidalcycles.oscEval.enable')) {
+        let oscEvalServer = new OscServer(this.consoleView, atom.config.get('tidalcycles.oscEval.ip'), atom.config.get('tidalcycles.oscEval.port'));
+        oscEvalServer.register(atom.config.get('tidalcycles.oscEval.address'), oscEvalSubscriber(this.repl, this.editors));
+        this.oscServers.push(oscEvalServer);
       }
 
       this.soundBrowser = new SoundBrowser();
       this.soundBrowser.init(atom.config.get('tidalcycles.soundBrowser.folders'));
 
+      this.oscServers.forEach(server => server.start());
+
       atom.commands.add('atom-workspace', {
         'tidalcycles:boot': () => {
           if (this.editors.currentIsTidal()) {
@@ -104,8 +110,9 @@ export default {
       this.consoleView.destroy();
       this.superDirt.destroy();
       this.repl.destroy();
-      this.oscLoader.destroy();
       this.soundBrowser.destroy();
+      this.oscServers.forEach(server => server.destroy());
+      this.oscServers = [];
     },
 
     serialize() {

lib/tidalcycles.js

@@ -0,0 +1,33 @@
+const OscServer = require('../lib/osc-server')
+const osc = require('osc-min')
+const dgram = require('dgram');
+
+describe('OscServer', () => {
+
+    const port = 36111;
+    let oscServer = new OscServer({}, "127.0.0.1", port);
+
+    beforeEach((done) => {
+        oscServer.start().finally(() => done());
+    })
+
+    afterEach(() => {
+        oscServer.stop();
+    })
+
+    it('should start an osc server and receive a message', done => {
+        let listener = (message) => {
+            if (message['key'] === 'value') {
+                done();
+            } else {
+                done("failure");
+            }
+        }
+
+        oscServer.register('/address', listener);
+
+        const message = osc.toBuffer({ address: "/address", args: ["key", "value"] });
+        dgram.createSocket('udp4').send(message, 0, message.byteLength, port, "127.0.0.1")
+    })
+
+})