presidium 0.15.20 → 0.15.27

package/DynamoStream.js

@@ -155,7 +155,9 @@ DynamoStream.prototype.getRecords = async function* getRecords(
       shardId: always(Shard.ShardId),
     }))
   }
+
   while (!this.closed && records.NextShardIterator != null) {
+    await new Promise(resolve => setTimeout(resolve, this.getRecordsInterval))
     records = await this.client.getRecords({
       ShardIterator: records.NextShardIterator,
       Limit: this.getRecordsLimit
@@ -166,7 +168,6 @@ DynamoStream.prototype.getRecords = async function* getRecords(
         shardId: always(Shard.ShardId),
       }))
     }
-    await new Promise(resolve => setTimeout(resolve, this.getRecordsInterval))
   }
 }
 

package/KinesisStream.js

@@ -50,7 +50,7 @@ const KinesisStream = function (options) {
   this.name = options.name
   this.listShardsLimit = options.listShardsLimit ?? 1000
   this.getRecordsLimit = options.getRecordsLimit ?? 1000
-  this.shardUpdateInterval = options.shardUpdateInterval ?? 10000
+  this.shardUpdatePeriod = options.shardUpdatePeriod ?? 15000
   this.getRecordsInterval = options.getRecordsInterval ?? 1000
   this.shardIteratorType = options.shardIteratorType ?? 'LATEST'
   this.shardIteratorTimestamp = options.shardIteratorTimestamp
@@ -116,7 +116,6 @@ KinesisStream.prototype.delete = function deleteStream() {
  * ```
  */
 KinesisStream.prototype.putRecord = async function putRecord(data, options = {}) {
-  await this.ready
   return this.kinesis.client.putRecord({
     StreamName: this.name,
     Data: data,
@@ -142,14 +141,19 @@ KinesisStream.prototype.listShards = async function* listShards() {
     StreamName: this.name,
     MaxResults: this.listShardsLimit,
   }).promise()
-  yield* shards.Shards
+  if (shards.Shards.length > 0) {
+    yield* shards.Shards
+  }
+
   while (!this.closed && shards.NextToken != null) {
     shards = await this.kinesis.client.listShards({
       StreamName: this.name,
       MaxResults: this.listShardsLimit,
       NextToken: shards.NextToken,
     })
-    yield* shards.Shards
+    if (shards.Shards.length > 0) {
+      yield* shards.Shards
+    }
   }
 }
 
@@ -163,19 +167,24 @@ KinesisStream.prototype.getRecords = async function* getRecords(Shard) {
       Timestamp: this.shardIteratorTimestamp,
     },
   }).promise().then(get('ShardIterator'))
+
   let records = await this.kinesis.client.getRecords({
     ShardIterator: startingShardIterator,
     Limit: this.getRecordsLimit,
   }).promise()
-  await new Promise(resolve => setTimeout(resolve, this.getRecordsInterval))
-  yield* records.Records
+  if (records.Records.length > 0) {
+    yield* records.Records
+  }
+
   while (!this.closed && records.NextShardIterator != null) {
+    await new Promise(resolve => setTimeout(resolve, this.getRecordsInterval))
     records = await this.kinesis.client.getRecords({
       ShardIterator: records.NextShardIterator,
       Limit: this.getRecordsLimit,
     }).promise()
-    await new Promise(resolve => setTimeout(resolve, this.getRecordsInterval))
-    yield* records.Records
+    if (records.Records.length > 0) {
+      yield* records.Records
+    }
   }
 }
 
@@ -183,43 +192,46 @@ const SymbolUpdateShards = Symbol('UpdateShards')
 
 KinesisStream.prototype[Symbol.asyncIterator] = async function* generateRecords() {
   let shards = await transform(map(identity), [])(this.listShards())
-  let muxAsyncIterator = Mux.race(shards.map(Shard => this.getRecords(Shard)))
-  let iterationPromise = muxAsyncIterator.next()
-  let shardUpdatePromise = new Promise(resolve => setTimeout(
-    thunkify(resolve, SymbolUpdateShards),
-    this.shardUpdateInterval,
-  ))
+  let muxAsyncIterator = Mux.race([
+    ...shards.map(Shard => this.getRecords(Shard)),
+    (async function* UpdateShardsGenerator() {
+      while (!this.closed) {
+        await new Promise(resolve => {
+          setTimeout(resolve, this.shardUpdatePeriod)
+        })
+        if (!this.closed) {
+          yield SymbolUpdateShards
+        }
+      }
+    }).call(this),
+  ])
 
   while (!this.closed) {
-    const iteration = await Promise.race([
-      shardUpdatePromise,
-      iterationPromise,
-    ])
-    if (iteration == SymbolUpdateShards) {
+    const { value, done } = await muxAsyncIterator.next()
+    if (value == SymbolUpdateShards) {
       const latestShards = await transform(map(identity), [])(this.listShards())
-      const newShards = differenceWith(
-        (ShardA, ShardB) => ShardA.ShardId == ShardB.ShardId,
-        latestShards,
-      )(shards)
-      const closedShards = differenceWith(
-        (ShardA, ShardB) => ShardA.ShardId == ShardB.ShardId,
-        shards,
-      )(latestShards)
-
-      closedShards.forEach(Shard => (Shard.closed = true))
+      const newShards = pipe([
+        always(shards),
+        differenceWith(
+          (ShardA, ShardB) => ShardA.ShardId == ShardB.ShardId,
+          latestShards,
+        ),
+        map(assign({
+          ShardIteratorType: always('TRIM_HORIZON'),
+        })),
+      ])()
+
       shards = latestShards
-      muxAsyncIterator = newShards.length == 0 ? muxAsyncIterator : Mux.race([
-        ...newShards.map(Shard => this.getRecords(Shard)),
-        muxAsyncIterator,
-      ])
-      shardUpdatePromise = new Promise(resolve => setTimeout(
-        thunkify(resolve, SymbolUpdateShards), this.shardUpdateInterval))
-    } else if (iteration.done) {
+      if (newShards.length > 0) {
+        muxAsyncIterator = Mux.race([
+          ...newShards.map(Shard => this.getRecords(Shard)),
+          muxAsyncIterator,
+        ])
+      }
+    } else if (done) {
       await new Promise(resolve => setTimeout(resolve, 1000))
-      iterationPromise = muxAsyncIterator.next()
     } else {
-      yield iteration.value
-      iterationPromise = muxAsyncIterator.next()
+      yield value
     }
   }
 }

package/KinesisStream.test.js

@@ -27,6 +27,7 @@ const test = new Test('KinesisStream', KinesisStream)
   assert.deepEqual(first3, first3Again)
   this.streams.push(myStream)
 })
+
 .case({
   name: 'my-stream',
   endpoint: 'http://localhost:4567',
@@ -46,6 +47,28 @@ const test = new Test('KinesisStream', KinesisStream)
   myStream.close()
   this.streams.push(myStream)
 })
+
+.case({
+  name: 'my-stream',
+  endpoint: 'http://localhost:4567',
+  shardUpdatePeriod: 500,
+}, async function (myStream) {
+  await myStream.ready
+
+  // there shouldn't be any more records, so this should hang
+  const latestRecordPromise = asyncIterableTake(1)(myStream)
+  const raceResult = await Promise.race([
+    latestRecordPromise,
+    new Promise(resolve => setTimeout(thunkify(resolve, 'hey'), 3000))
+  ])
+  assert.equal(raceResult, 'hey')
+  // wait a second for shard update
+  await new Promise(resolve => setTimeout(thunkify(resolve, 'hey'), 1000))
+  myStream.close()
+  // ensure shards don't update after close
+  await new Promise(resolve => setTimeout(resolve, 1000))
+})
+
 .after(async function() {
   await map(stream => stream.delete())(this.streams)
 })

package/{TranscribeStreaming.js → TranscribeStream.js}

@@ -29,11 +29,11 @@ const CHECKSUM_LENGTH = 4
 const MINIMUM_MESSAGE_LENGTH = PRELUDE_LENGTH + CHECKSUM_LENGTH * 2
 
 /**
- * @name TranscribeStreaming
+ * @name TranscribeStream
  *
  * @synopsis
  * ```coffeescript [specscript]
- * const myTranscribeStream = new TranscribeStreaming(options {
+ * const myTranscribeStream = new TranscribeStream(options {
  *   accessKeyId: string,
  *   secretAccessKey: string,
  *   region: string,
@@ -44,6 +44,24 @@ const MINIMUM_MESSAGE_LENGTH = PRELUDE_LENGTH + CHECKSUM_LENGTH * 2
  *   sessionId?: string,
  *   vocabularyName?: string,
  * })
+ *
+ * myTranscribeStream.on('transcription', transcriptionHandler (transcription {
+ *   Alternatives: Array<{
+ *     Items: Array<{
+ *       Confidence?: number,
+ *       Content: string,
+ *       EndTime: number, // seconds
+ *       StartTime: number, // seconds
+ *       Type: 'pronunciation'|'punctuation',
+ *       VocabularyFilterMatch: boolean,
+ *     }>,
+ *     Transcript: string,
+ *   }>,
+ *   EndTime: number, // seconds
+ *   IsPartial: boolean,
+ *   ResultId: string, // uuid
+ *   StartTime: number, // seconds
+ * })=><>)
  * ```
  *
  * @description
@@ -59,7 +77,7 @@ const MINIMUM_MESSAGE_LENGTH = PRELUDE_LENGTH + CHECKSUM_LENGTH * 2
  *
  * `vocabularyName` - The name of the vocabulary to use when processing the transcription job, if any.
  */
-const TranscribeStreaming = function (options) {
+const TranscribeStream = function (options) {
   const {
     accessKeyId,
     secretAccessKey,
@@ -109,10 +127,10 @@ const TranscribeStreaming = function (options) {
   return this
 }
 
-TranscribeStreaming.prototype = EventEmitter.prototype
+TranscribeStream.prototype = EventEmitter.prototype
 
 /**
- * @name TranscribeStreaming.prototype.sendAudioChunk
+ * @name TranscribeStream.prototype.sendAudioChunk
  *
  * @synopsis
  * ```coffeescript [specscript]
@@ -125,7 +143,7 @@ TranscribeStreaming.prototype = EventEmitter.prototype
  * https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html
  * https://github.com/aws-samples/amazon-transcribe-comprehend-medical-twilio/blob/main/lib/transcribe-service.js
  */
-TranscribeStreaming.prototype.sendAudioChunk = function (chunk) {
+TranscribeStream.prototype.sendAudioChunk = function (chunk) {
   const headersBytes = marshalHeaders({
     ':message-type': {
       type: 'string',
@@ -273,4 +291,4 @@ const unmarshalHeaders = function (headersView) {
   return headers
 }
 
-module.exports = TranscribeStreaming
+module.exports = TranscribeStream

package/{TranscribeStreaming.test.js → TranscribeStream.test.js}

@@ -4,7 +4,7 @@ const WaveFile = require('wavefile').WaveFile
 const Test = require('thunk-test')
 const assert = require('assert')
 const rubico = require('rubico')
-const TranscribeStreaming = require('./TranscribeStreaming')
+const TranscribeStream = require('./TranscribeStream')
 const AwsCredentials = require('./internal/AwsCredentials')
 
 const {
@@ -18,7 +18,7 @@ const {
   curry, __,
 } = rubico
 
-const test = new Test('TranscribeStreaming', async function () {
+const test = new Test('TranscribeStream', async function () {
   const awsCreds = await AwsCredentials('default').catch(error => {
     if (error.code == 'ENOENT') {
       const accessKeyId = process.env.AWS_ACCESS_KEY_ID
@@ -32,13 +32,13 @@ const test = new Test('TranscribeStreaming', async function () {
   })
   awsCreds.region = 'us-east-1' // only valid region for transcribe
 
-  const testTranscribeStreaming = new TranscribeStreaming({
+  const testTranscribeStream = new TranscribeStream({
     languageCode: 'en-US',
     mediaEncoding: 'pcm',
     sampleRate: 8000,
     ...awsCreds,
   })
-  await testTranscribeStreaming.ready
+  await testTranscribeStream.ready
 
   const mediaStreamFixtureAwsKeynote =
     fs.createReadStream('./media-stream-fixture-aws-keynote.txt')
@@ -51,14 +51,14 @@ const test = new Test('TranscribeStreaming', async function () {
       const wav = new WaveFile()
       wav.fromScratch(1, 8000, '8', Buffer.from(event.media.payload, 'base64'))
       wav.fromMuLaw()
-      testTranscribeStreaming.sendAudioChunk(Buffer.from(wav.data.samples))
+      testTranscribeStream.sendAudioChunk(Buffer.from(wav.data.samples))
     } else if (event.event == 'stop') {
-      testTranscribeStreaming.websocket.close()
+      testTranscribeStream.websocket.close()
     }
   })
 
   const testTranscription = await new Promise(resolve => {
-    testTranscribeStreaming.on('transcription', transcription => {
+    testTranscribeStream.on('transcription', transcription => {
       resolve(transcription.Alternatives[0].Transcript)
     })
   })

package/index.js

@@ -31,24 +31,43 @@ const S3Bucket = require('./S3Bucket')
 // const Redshift = require('./Redshift')
 // const Gremlin = require('./Gremlin')
 const Redis = require('./Redis')
+const TranscribeStream = require('./TranscribeStream')
 
 const Presidium = {
-  Http, HttpServer,
-  WebSocket, WebSocketServer,
-  Dynamo, DynamoTable, DynamoIndex, DynamoStream,
-  Docker, DockerImage, DockerContainer, DockerSwarm, DockerService,
-  // ElasticTranscoder, ElasticTranscoderPipeline,
-  // KinesisAnalytics, KinesisAnalyticsStream,
-  // KinesisVideo, KinesisVideoStream,
-  Kinesis, KinesisStream,
-  Lambda, LambdaFunction,
-  Mongo, MongoCollection,
+  Http,
+  HttpServer,
+  WebSocket,
+  WebSocketServer,
+  Dynamo,
+  DynamoTable,
+  DynamoIndex,
+  DynamoStream,
+  Docker,
+  DockerImage,
+  DockerContainer,
+  DockerSwarm,
+  DockerService,
+  // ElasticTranscoder,
+  // ElasticTranscoderPipeline,
+  // KinesisAnalytics,
+  // KinesisAnalyticsStream,
+  // KinesisVideo,
+  // KinesisVideoStream,
+  Kinesis,
+  KinesisStream,
+  Lambda,
+  LambdaFunction,
+  Mongo,
+  MongoCollection,
   ElasticsearchIndex,
-  // SNS, SNSTopic,
-  S3, S3Bucket,
+  // SNS,
+  // SNSTopic,
+  S3,
+  S3Bucket,
   // Redshift,
   // Gremlin,
   Redis,
+  TranscribeStream,
 }
 
 module.exports = Presidium

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "0.15.20",
+  "version": "0.15.27",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",