@speckle/objectsender 1.0.0 → 1.0.2

package/src/transports/ServerTransport.ts

@@ -1,49 +1,70 @@
 import { ITransport } from './ITransport'
 import { IDisposable } from '../utils/IDisposable'
+import { retry, timeoutAt } from '@speckle/shared'
+
 /**
  * Basic object sender to a speckle server
  */
 export class ServerTransport implements ITransport, IDisposable {
-  buffer: string[]
-  maxSize: number
-  currSize: number
-  serverUrl: string
-  projectId: string
-  authToken: string
+  #buffer: string[]
+  #maxSize: number
+  #currSize: number
+  #serverUrl: string
+  #projectId: string
+  #authToken: string
+  #flushRetryCount: number
+  #flushTimeout: number
 
   constructor(
     serverUrl: string,
     projectId: string,
     authToken: string,
-    maxSize: number = 200_000
+    options?: Partial<{
+      maxSize: number
+      flushRetryCount: number
+      flushTimeout: number
+    }>
   ) {
-    this.maxSize = maxSize
-    this.currSize = 0
-    this.serverUrl = serverUrl
-    this.projectId = projectId
-    this.authToken = authToken
-    this.buffer = []
+    this.#maxSize = options?.maxSize || 200_000
+    this.#flushRetryCount = options?.flushRetryCount || 3
+    this.#flushTimeout = options?.flushTimeout || 2 * 60 * 1000
+
+    this.#currSize = 0
+    this.#serverUrl = serverUrl
+    this.#projectId = projectId
+    this.#authToken = authToken
+    this.#buffer = []
   }
 
   async write(serialisedObject: string, size: number) {
-    this.buffer.push(serialisedObject)
-    this.currSize += size
-    if (this.currSize < this.maxSize) return // return fast
+    this.#buffer.push(serialisedObject)
+    this.#currSize += size
+    if (this.#currSize < this.#maxSize) return // return fast
     await this.flush() // block until we send objects
   }
 
   async flush() {
-    if (this.buffer.length === 0) return
+    if (this.#buffer.length === 0) return
 
     const formData = new FormData()
-    const concat = '[' + this.buffer.join(',') + ']'
+    const concat = '[' + this.#buffer.join(',') + ']'
     formData.append('object-batch', new Blob([concat], { type: 'application/json' }))
-    const url = new URL(`/objects/${this.projectId}`, this.serverUrl)
-    const res = await fetch(url, {
-      method: 'POST',
-      headers: { Authorization: `Bearer ${this.authToken}` },
-      body: formData
-    })
+    const url = new URL(`/objects/${this.#projectId}`, this.#serverUrl)
+    const res = await retry(
+      async () =>
+        await Promise.race([
+          fetch(url, {
+            method: 'POST',
+            headers: { Authorization: `Bearer ${this.#authToken}` },
+            body: formData
+          }),
+          timeoutAt(this.#flushTimeout, 'Object sender flush timed out')
+        ]),
+      this.#flushRetryCount,
+      (i) => {
+        return i * 1000
+      }
+    )
 
     if (res.status !== 201) {
       throw new Error(
@@ -51,11 +72,11 @@ export class ServerTransport implements ITransport, IDisposable {
       )
     }
 
-    this.buffer = []
-    this.currSize = 0
+    this.#buffer = []
+    this.#currSize = 0
   }
 
   dispose() {
-    this.buffer = []
+    this.#buffer = []
   }
 }

package/src/utils/Sha1.spec.ts

@@ -0,0 +1,15 @@
+import { expect, describe, it } from 'vitest'
+import { SHA1 } from './Sha1'
+
+describe('SHA1 encryption', () => {
+  it.each([
+    ['le speckle', '67413ddfa55bab1b735d4d90bf5be7f5fafbcdfb'],
+    [
+      'the quick brown fox jumped over the lazy dog? i think',
+      'b724fbdc205bae3b1d7511304ec4b576af563f93'
+    ],
+    ['1', '356a192b7913b04c54574d18c28d46e6395428ab']
+  ])('SHA1(%s) should return %s', (input, expected) => {
+    expect(SHA1(input)).toBe(expected)
+  })
+})

package/src/utils/Sha1.ts

@@ -134,5 +134,5 @@ export function SHA1(msg: string) {
     H4 = (H4 + E) & 0x0ffffffff
   }
   const h = cvt_hex(H0) + cvt_hex(H1) + cvt_hex(H2) + cvt_hex(H3) + cvt_hex(H4)
-  return h.toLowerCase().substring(0, 32)
+  return h.toLowerCase().substring(0, 40)
 }

package/tsconfig.eslint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "dist", "coverage"],
+  "include": ["src", "vite.config.ts", "vitest.config.ts"]
+}

package/{vite.config.js → vite.config.ts}

@@ -1,11 +1,13 @@
+/// <reference types="vitest" />
 import pkg from './package.json'
 import { defineConfig } from 'vite'
 import { resolve } from 'path'
+import dts from 'vite-plugin-dts'
 
 export default defineConfig({
   build: {
     lib: {
-      entry: resolve(import.meta.dirname, './src/index.ts'),
+      entry: resolve(__dirname, './src/index.ts'),
       name: 'objectsender',
       fileName: 'objectsender',
       formats: ['es', 'cjs']
@@ -14,5 +16,6 @@ export default defineConfig({
     rollupOptions: {
       external: Object.keys(pkg.dependencies || {})
     }
-  }
+  },
+  plugins: [dts()]
 })

package/vitest.config.ts

@@ -0,0 +1,9 @@
+import { coverageConfigDefaults, defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    coverage: {
+      exclude: ['**/src/examples/**', ...coverageConfigDefaults.exclude]
+    }
+  }
+})