sphero-pwn/src/replay_channel.coffee

Driver for Sphero robots

Recording = require './recording.coffee'

fs = require 'fs-promise'

# Implements the Channel API using data from a file.
class ReplayChannel
  # Creates a channel that replays operations previously recorded to a file.
  #
  # @param {String} recordingPath the file holding the recording to be replayed
  constructor: (recordingPath) ->
    @sourceId = "replay://#{recordingPath}"
    @_recordingPath = recordingPath
    @_recording = null
    @_index = 0
    @_openPromise = null

  # @see {SerialChannel#open}
  open: ->
    @_openPromise ||= fs.readFile(@_recordingPath, encoding: 'utf8')
      .then (data) =>
        @_recording = new Recording data
        @_drainReads()

  # @see {SerialChannel#write}
  write: (data) ->
    @open()
      .then =>
        @_drainReads()
      .then =>
        if @_recording.code(@_index) isnt '>'
          throw new Error("Unexpected write")
        expectedData = @_recording.data @_index
        @_index += 1
        if data.compare(expectedData) isnt 0
          expected = Recording.bufferToHex expectedData
          got = Recording.bufferToHex data
          throw new Error("Invalid data; expected #{expected}; got #{got}")

        # NOTE: Draining reads should not block the resolution of the write
        #       promise. However, we can't just wait until the next write
        #       occurs.
        @_drainReads()

        true

  # @see {SerialChannel#onData}
  onData: (data) ->
    return

  # @see {SerialChannel#onError}
  onError: (error) ->
    return

  # @see {SerialChannel#sourceId}
  sourceId: null

  # @see {SerialChannel#close}
  close: ->
    @open()
      .then =>
        @_drainReads()
      .then =>
        opsLeft = @_recording.length - @_index
        if opsLeft isnt 0
          throw new Error("Closed before performing #{opsLeft} remaining ops")

  # @return {Promise<Boolean>} resolved to true when the next operation is a
  #   write or there is no operation left
  _drainReads: ->
    if @_recording.code(@_index) isnt '<'
      return Promise.resolve true

    new Promise (resolve, reject) =>
      data = @_recording.data @_index
      @_index += 1
      try
        @onData data
      catch onDataError
        reject onDataError
        return
      resolve @_drainReads()


module.exports = ReplayChannel