All files / sportident/src/SiStation SiTargetMultiplexer.ts

93.85% Statements 107/114
77.77% Branches 21/27
93.54% Functions 29/31
93.69% Lines 104/111

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 2614x 4x 4x   4x 4x 4x 4x     4x                 4x         4x   26x 3x   23x 23x 23x 3x   23x 13x     23x     28x 28x   28x 28x 28x         28x         23x             3x   2x 1x     3x 3x 3x         2x       3x 1x         13x 13x 13x 13x 13x 13x       13x 3x         13x 1x                 13x       1x 1x 1x   13x 4x   9x             9x     9x 1x 1x   8x     8x 8x     8x 1x 1x   1x   7x                 7x 3x           7x 1x   6x           6x 6x 2x   4x 4x         3x 1x   2x     2x 2x 2x                 23x 23x         13x 13x     13x 13x     9x 9x     9x 9x     23x 23x         45x           25x     20x 20x 20x       20x   18x 18x 8x       2x 2x           4x  
import {proto} from '../constants';
import * as utils from '../utils';
import * as siProtocol from '../siProtocol';
import {ISiStation} from './ISiStation';
import {_ISiTargetMultiplexerTestData, ISiTargetMultiplexer, SiTargetMultiplexerDirectMessageEvent, SiTargetMultiplexerEvents, SiTargetMultiplexerMessageEvent, SiTargetMultiplexerRemoteMessageEvent, SiTargetMultiplexerTarget} from './ISiTargetMultiplexer';
import {ISiDevice, ISiDeviceDriverData, SiDeviceState} from '../SiDevice/ISiDevice';
import {SiSendTaskState} from './ISiSendTask';
import {SiSendTask} from './SiSendTask';
 
/** Commands that can only be sent from a direct station. */
export const DIRECT_DEVICE_INITIATED_COMMANDS: {[command: number]: boolean} = {
    [proto.cmd.TRANS_REC]: true,
    [proto.cmd.SI5_DET]: true,
    [proto.cmd.SI6_DET]: true,
    [proto.cmd.SI8_DET]: true,
    [proto.cmd.SI_REM]: true,
};
 
/** Commands that are sent from a station without prior request. */
const DEVICE_INITIATED_COMMANDS: {[command: number]: boolean} = {
    ...DIRECT_DEVICE_INITIATED_COMMANDS,
    [proto.cmd.SRR_PING]: true,
};
 
export class SiTargetMultiplexer implements ISiTargetMultiplexer {
    static fromSiDevice(siDevice: ISiDevice<ISiDeviceDriverData<unknown>>): ISiTargetMultiplexer {
        if (siDevice.siTargetMultiplexer) {
            return siDevice.siTargetMultiplexer;
        }
        const instance = new this(siDevice);
        siDevice.siTargetMultiplexer = instance;
        siDevice.addEventListener('stateChange', (e) => {
            instance.handleDeviceStateChange(e.state);
        });
        siDevice.addEventListener('receive', (e) => {
            instance.handleReceive(e.uint8Data);
        });
        // TODO: deregister/close
        return instance;
    }
 
    public stations: {[Target in SiTargetMultiplexerTarget]?: ISiStation<Target>} = {};
    public target: SiTargetMultiplexerTarget = SiTargetMultiplexerTarget.Unknown;
    // the target of the latest command scheduled
    public latestTarget: SiTargetMultiplexerTarget = SiTargetMultiplexerTarget.Unknown;
    private receiveBuffer: number[] = [];
    private sendQueue: SiSendTask[] = [];
 
 
    // eslint-disable-next-line no-useless-constructor
    constructor(
                public siDevice: ISiDevice<ISiDeviceDriverData<unknown>>,
    // eslint-disable-next-line no-empty-function
    ) {}
 
    get _test(): _ISiTargetMultiplexerTestData {
        return {
            latestTarget: this.latestTarget,
            sendQueue: this.sendQueue,
        };
    }
 
    handleDeviceStateChange(newState: SiDeviceState): void {
        const actionByNewState: {[state in SiDeviceState]: () => void} = {
            [SiDeviceState.Opening]: () => undefined,
            [SiDeviceState.Opened]: () => this.startProcessingSendQueue(),
            [SiDeviceState.Closing]: () => this.abortProcessingSendQueue(),
            [SiDeviceState.Closed]: () => this.abortProcessingSendQueue(),
        };
        const actionToPerform = actionByNewState[newState];
        if (actionToPerform) {
            actionToPerform();
        }
    }
 
    startProcessingSendQueue(): void {
        setTimeout(() => this._processSendQueue(), 1);
    }
 
    abortProcessingSendQueue(): void {
        this.sendQueue.forEach((sendTask) => {
            sendTask.fail();
        });
    }
 
    handleReceive(uint8Data: number[]): void {
        this.receiveBuffer.push(...uint8Data);
        const {messages, remainder} = siProtocol.parseAll(this.receiveBuffer);
        this.receiveBuffer = remainder;
        messages.forEach((message) => {
            this.updateSendQueueWithReceivedMessage(message);
            this.dispatchEvent(
                'message',
                new SiTargetMultiplexerMessageEvent(this, message),
            );
            if (this.target === SiTargetMultiplexerTarget.Direct) {
                this.dispatchEvent(
                    'directMessage',
                    new SiTargetMultiplexerDirectMessageEvent(this, message),
                );
            }
            if (this.target === SiTargetMultiplexerTarget.Remote) {
                this.dispatchEvent(
                    'remoteMessage',
                    new SiTargetMultiplexerRemoteMessageEvent(this, message),
                );
            }
        });
    }
 
    updateSendQueueWithReceivedMessage(message: siProtocol.SiMessage): void {
        if (
            message.mode === undefined
            && DIRECT_DEVICE_INITIATED_COMMANDS[message.command]
        ) {
            console.debug('Received direct device-initiated command. Assuming target Direct...');
            this.target = SiTargetMultiplexerTarget.Direct;
            this.latestTarget = SiTargetMultiplexerTarget.Direct;
        }
        if (this.sendQueue.length === 0) {
            return;
        }
        const shouldAcceptResponseInState: {[state in SiSendTaskState]: boolean} = {
            [SiSendTaskState.Queued]: false,
            [SiSendTaskState.Sending]: true, // This is mostly for testing purposes
            [SiSendTaskState.Sent]: true,
            [SiSendTaskState.Succeeded]: false,
            [SiSendTaskState.Failed]: false,
        };
        Iif (!shouldAcceptResponseInState[this.sendQueue[0].state]) {
            return;
        }
        if (message.mode === proto.NAK) {
            this.sendQueue[0].fail();
            return;
        }
        Iif (message.mode !== undefined) {
            return;
        }
        const expectedMessage = this.sendQueue[0].message;
        Iif (expectedMessage.mode !== undefined) {
            return;
        }
        if (message.command !== expectedMessage.command) {
            if (DEVICE_INITIATED_COMMANDS[message.command] !== true) {
                console.warn(`Strange Response: expected ${utils.prettyHex([expectedMessage.command])}, but got ${utils.prettyHex([message.command])}...`);
            }
            return;
        }
        this.sendQueue[0].addResponse(message.parameters);
    }
 
    sendMessage(
        target: SiTargetMultiplexerTarget,
        message: siProtocol.SiMessage,
        numResponses?: number,
        timeoutInMiliseconds?: number,
    ): Promise<number[][]> {
        return this.setTarget(target)
            .then(() => this.sendMessageToLatestTarget(message, numResponses, timeoutInMiliseconds));
    }
 
    setTarget(
        target: SiTargetMultiplexerTarget,
    ): Promise<void> {
        if (target === this.latestTarget) {
            return Promise.resolve();
        }
        const setMsParameterByTarget: {[Target in SiTargetMultiplexerTarget]: number|undefined} = {
            [SiTargetMultiplexerTarget.Direct]: proto.P_MS_DIRECT,
            [SiTargetMultiplexerTarget.Remote]: proto.P_MS_REMOTE,
            [SiTargetMultiplexerTarget.Unknown]: undefined,
            [SiTargetMultiplexerTarget.Switching]: undefined,
        };
        const setMsParameter = setMsParameterByTarget[target];
        if (setMsParameter === undefined) {
            return Promise.reject(new Error(`No such target: ${target}`));
        }
        this.latestTarget = target;
        return this.sendMessageToLatestTarget({
            command: proto.cmd.SET_MS,
            parameters: [setMsParameter],
        }, 1)
            .then((responses: number[][]) => {
                if (responses[0][2] !== setMsParameter) {
                    throw new Error('contradicting SET_MS response');
                }
                this.target = target;
            })
            .catch((err) => {
                this.abortProcessingSendQueue();
                this.target = SiTargetMultiplexerTarget.Unknown;
                throw err;
            });
    }
 
    sendMessageToLatestTarget(
        message: siProtocol.SiMessage,
        numResponses = 0,
        timeoutInMiliseconds = 10000,
    ): Promise<number[][]> {
        return new Promise((resolve, reject) => {
            const sendTask = new SiSendTask(
                message,
                numResponses,
                timeoutInMiliseconds,
                (resolvedTask) => {
                    const shifted = this.sendQueue.shift();
                    Iif (resolvedTask !== shifted) {
                        throw new Error('Resolved unexecuting SendTask');
                    }
                    setTimeout(() => this._processSendQueue(), 1);
                    resolve(resolvedTask.responses);
                },
                (rejectedTask) => {
                    const shifted = this.sendQueue.shift();
                    Iif (rejectedTask !== shifted) {
                        throw new Error('Rejected unexecuting SendTask');
                    }
                    setTimeout(() => this._processSendQueue(), 1);
                    reject(new Error('Rejection'));
                },
            );
            this.sendQueue.push(sendTask);
            this._processSendQueue();
        });
    }
 
    _processSendQueue(): void {
        if (
            this.sendQueue.length === 0
            || this.sendQueue[0].state === SiSendTaskState.Sending
            || this.sendQueue[0].state === SiSendTaskState.Sent
            || this.siDevice.state !== SiDeviceState.Opened
        ) {
            return;
        }
 
        const sendTask = this.sendQueue[0];
        sendTask.state = SiSendTaskState.Sending;
        const uint8Data = [
            proto.WAKEUP,
            ...siProtocol.render(sendTask.message),
        ];
        this.siDevice.send(uint8Data)
            .then(() => {
                sendTask.state = SiSendTaskState.Sent;
                if (sendTask.numResponses <= 0) {
                    sendTask.succeed();
                }
            })
            .catch((err: utils.SiError) => {
                console.warn(`Error sending: ${err}`);
                sendTask.fail();
            });
    }
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface SiTargetMultiplexer extends utils.EventTarget<SiTargetMultiplexerEvents> {}
utils.applyMixins(SiTargetMultiplexer, [utils.EventTarget]);