websocket.js

// --------------------------------------------------------------------------
// -- websocket.js
// -- initial author: Renick Bell (renick@gmail.com)
// -- initial creation date: Wed Jun 28 10:08:48 AM CST 2023
// -- contributors: Yiler Huang (yiler7777@gmail.com); Steve Wang (stevesg168@gmail.com)
// -- license: GPL 3.0
// --------------------------------------------------------------------------

//.load ./Organized-programming-tools.js
////seperate functions and data. tidy code. Explanation on where things are and how it works. Seperate out the samples.
//fix function names

const WebSocketServer = require("ws");

//Send Messages to Clients:
function sendMessageToClients(message) {
    let formatted = JSON.stringify(message);
    //Send to all clients
    wss.clients.forEach((x) => {
        x.send(formatted);
    });
}

//receiveCommand:
function receiveCommands(obj, client) {
    commands.forEach((x) => {
        if (obj.action == x.action) {
            x.func(obj.info);
        }
    });
}

/*
//call this changeToJSON:
function createFormat(message, color, size, log) {
    return JSON.stringify({
        message: message,
        size: size,
        color: color,
        log: log,
    });
}
*/

function messageAllClients(message) {
    let formatted = JSON.stringify(message);
    wss.clients.forEach((x) => {
        x.send(formatted);
    });
}

function messageSpecifiedClient (message, target){
    if (typeof message != 'string'){
        message = JSON.stringify(message)
    }
    if (typeof target == 'number'){
        try{
            clients[target].send(message)
        }
        catch{
            console.error('Index in clients array not found. Please provide a valid index')
        }
    }
    else if (typeof target == 'string'){
        try{
            findTargetClientByName(target).send(message)
        }
        catch{
            console.error('Target name not found! \nError from messageAllClients function. The requested target name was', target)
        }
    }
    else{
        console.error('Invalid target selection method. Provide their index in the clients array or the name given to them')
    }
}

// function findTargetClientByName (name){
//     for (let i = 0; i < clients.length; i++) {
//         if (clients[i].name == name){
//             return clients[i]
//         }
//     }
// }
function findTargetClientByName (name){
    let foundClient;
    clients.every(x => {
        if (x.name == name){
            foundClient = x
            return false
        }
        return true
    })
    return foundClient
}
//inspiration for using every: https://masteringjs.io/tutorials/fundamentals/foreach-break

async function addNewClients (){
    let newClientArray = [...wss.clients.values()]
    let originalTime = new Date().getTime()
    clients.push(newClientArray[newClientArray.length - 1])
//     for (let i = 0; i < 4; i++) {
    Array.from({length: 4}, () => {
        messageSpecifiedClient({action: 'getResponseTime'}, clients.length - 1)
    })
    clients[clients.length - 1].index = clients.length - 1
    await new Promise((resolve,reject) => {
       setInterval(() => {
            if (newResponseTimes.length == 4){
                let responseTimeInMilliseconds = newResponseTimes.map(x => {return x - originalTime})
                clients[clients.length - 1].responseTime = responseTimeInMilliseconds.reduce((a, b) => a + b, 0) / 4 
                newResponseTimes = []
                resolve(true)
            }
       },10)
    })
}

//Reduce: https://stackoverflow.com/a/43363105/19515980

function removeClient (clientToRemove){
    wipeClientData(clientToRemove)
    //might want to fix schedule too
}

function wipeClientData (clientToRemove){
    console.log("\x1b[31m", 'Removing Client', clientToRemove.index, 'data')
    console.log('clientToRemove.index', clientToRemove.index)
    clients = A.safeSplice(clients, 1, clientToRemove.index)
//     for (let i = 0; i < clients.length - clientToRemove.index; i++) {
    Array.from({length: clients.length - clientToRemove.index}).forEach((x, i) =>{
        clients[clientToRemove.index + i].index = clientToRemove.index + i
    })
    return true
}

//Color logging: https://stackoverflow.com/a/41407246/19515980

//messageAllClients({action:'loadSVG',info:filesArray[randomRange(0,filesArray.length-1)]})

//messageAllClients({action:'animate',info:['size',[0,500,100,100]]})

//Differenciate client part of inspiration from my old and this stack overflow link: https://stackoverflow.com/questions/13364243/websocketserver-node-js-how-to-differentiate-clients

//Send volume through websocket to clients in the browser to show changes in volume with the size of circle:
function visualizeVolume (info){
    let sortedInfo = {
        info: {
            shapesIndex: 0,
            time: 0.5,
            x: info.velocity * 2,
            y: info.velocity * 2,
        },
        type: 'size',
    }
    messageAllClients({action:'animate', info: sortedInfo})
    sortedInfo = {
            info: {
                shapesIndex: 0,
                time: 0.5,
                x: 10,
                y: 10,
            },
            type: 'size',
        }
    setTimeout(() => {
        messageAllClients({action:'animate', info: sortedInfo})
    }, info.noteDuration * 1000)
}

//Find availablePorts for websocketServer
function findAvailablePorts (min = 0, max){
    let WebSocketServer = require("ws");
    let availablePort;
    let tempServer;
    let currentPort = min
    while (currentPort <= max && availablePort === undefined) {
        console.log('testing', currentPort)
        try{
            tempServer = new WebSocketServer.Server({ port: currentPort })
            tempServer.close()
            tempServer = undefined
            availablePort = currentPort
        }
        catch {
        }
        currentPort++;
    }
//     console.log('Found available port at: ', availablePort)
//     return availablePort
}