All files tus.ts

87.89% Statements 138/157
81.69% Branches 58/71
75.86% Functions 22/29
88.19% Lines 127/144

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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335                                            61x 61x                                                                             48x   48x 48x   48x 48x   64x     48x       67x   67x 67x     67x   67x 60x 60x 60x           48x   48x 48x     63x   63x 63x     63x 63x   63x   63x 63x     7x 7x     63x 163x     163x 163x 499x       163x 65x     65x             63x   63x             63x 63x 63x 63x 63x 109x 58x 58x   63x 9x 4x 4x       63x 63x 63x 63x 63x           63x 63x   63x 63x   63x 1x 1x     63x 63x 1x 1x       62x             62x 53x 53x 53x 53x   62x 9x 9x 9x 9x       62x                   115x 115x 115x   114x   3x 3x   111x   115x                   55x 55x 55x   55x 55x           63x     52x   52x 52x     53x 53x   53x 53x 53x 52x     53x 46x   53x     44x             62x 62x 62x   62x     62x 52x 6x 6x   52x     62x     63x 63x 53x 53x                     48x   38x   38x 38x 38x             38x    
import type { Readable } from 'node:stream'
 
import type {
  FileSource,
  HttpRequest,
  HttpResponse,
  OnSuccessPayload,
  SliceResult,
  UploadOptions,
} from 'tus-js-client'
 
import type { AssemblyStatus } from './alphalib/types/assemblyStatus.ts'
import type { UploadProgress } from './Transloadit.ts'
 
import { ReadStream } from 'node:fs'
import { stat } from 'node:fs/promises'
import { basename } from 'node:path'
 
import debug from 'debug'
import pMap from 'p-map'
import { defaultOptions, Upload } from 'tus-js-client'
 
const log = debug('transloadit')
const logWarn = debug('transloadit:warn')
 
export type UploadBehavior = 'await' | 'background' | 'none'
 
export interface Stream {
  path?: string
  stream: Readable
}
 
interface SendTusRequestOptions {
  streamsMap: Record<string, Stream>
  assembly: AssemblyStatus
  requestedChunkSize: number
  uploadConcurrency: number
  onProgress: (options: UploadProgress) => void
  signal?: AbortSignal
  uploadUrls?: Record<string, string>
  uploadBehavior?: UploadBehavior
  onFileStreamOpened?: (stream: ReadStream) => void
  onFileSliceStarted?: (slice: Promise<unknown>) => void
}
 
interface SendTusRequestResult {
  uploadUrls: Record<string, string>
  uploadsComplete?: Promise<unknown>
}
 
export async function sendTusRequest({
  streamsMap,
  assembly,
  requestedChunkSize,
  uploadConcurrency,
  onProgress,
  signal,
  uploadUrls,
  uploadBehavior = 'await',
  onFileStreamOpened,
  onFileSliceStarted,
}: SendTusRequestOptions): Promise<SendTusRequestResult> {
  const streamLabels = Object.keys(streamsMap)
 
  let totalBytes = 0
  let lastEmittedProgress = 0
 
  const sizes: Record<string, number> = {}
  const uploadUrlsResult: Record<string, string> = { ...(uploadUrls ?? {}) }
 
  const haveUnknownLengthStreams = streamLabels.some((label) => !streamsMap[label]?.path)
 
  // Initialize size data
  await pMap(
    streamLabels,
    async (label) => {
      // Check if aborted before each operation
      Iif (signal?.aborted) throw new Error('Upload aborted')
 
      const streamInfo = streamsMap[label]
      Iif (!streamInfo) {
        throw new Error(`Stream info not found for label: ${label}`)
      }
      const { path } = streamInfo
 
      if (path) {
        const { size } = await stat(path)
        sizes[label] = size
        totalBytes += size
      }
    },
    { concurrency: 5, signal },
  )
 
  const uploadProgresses: Record<string, number> = {}
 
  const completionPromises: Array<Promise<void>> = []
  const uploadUrlPromises: Array<Promise<void>> = []
 
  async function uploadSingleStream(label: string) {
    uploadProgresses[label] = 0
 
    const streamInfo = streamsMap[label]
    Iif (!streamInfo) {
      throw new Error(`Stream info not found for label: ${label}`)
    }
    const { stream, path } = streamInfo
    const size = sizes[label]
 
    let chunkSize = requestedChunkSize
    let uploadLengthDeferred: boolean
    const isStreamLengthKnown = !!path
    if (!isStreamLengthKnown) {
      // tus-js-client requires these options to be set for unknown size streams
      // https://github.com/tus/tus-js-client/blob/master/docs/api.md#uploadlengthdeferred
      uploadLengthDeferred = true
      Eif (chunkSize === Number.POSITIVE_INFINITY) chunkSize = 50e6
    }
 
    const onTusProgress = (bytesUploaded: number): void => {
      uploadProgresses[label] = bytesUploaded
 
      // get all uploaded bytes for all files
      let uploadedBytes = 0
      for (const l of streamLabels) {
        uploadedBytes += uploadProgresses[l] ?? 0
      }
 
      // don't send redundant progress
      if (lastEmittedProgress < uploadedBytes) {
        lastEmittedProgress = uploadedBytes
        // If we have any unknown length streams, we cannot trust totalBytes
        // totalBytes should then be undefined to mimic behavior of form uploads.
        onProgress({
          uploadedBytes,
          totalBytes: haveUnknownLengthStreams ? undefined : totalBytes,
        })
      }
    }
 
    const filename = path ? basename(path) : label
 
    Iif (uploadBehavior === 'none' && uploadUrls?.[label]) {
      uploadUrlsResult[label] = uploadUrls[label]
      uploadUrlPromises.push(Promise.resolve())
      completionPromises.push(Promise.resolve())
      return
    }
 
    let urlResolved = false
    let resolveUrl: () => void = () => {}
    let rejectUrl: (err: Error) => void = () => {}
    const uploadUrlPromise = new Promise<void>((resolve, reject) => {
      resolveUrl = () => {
        if (urlResolved) return
        urlResolved = true
        resolve()
      }
      rejectUrl = (err) => {
        if (urlResolved) return
        urlResolved = true
        reject(err)
      }
    })
 
    let resolveCompletion: () => void = () => {}
    let rejectCompletion: (err: Error) => void = () => {}
    const completionPromise = new Promise<void>((resolve, reject) => {
      resolveCompletion = resolve
      rejectCompletion = reject
    })
 
    // If startPromise rejects first, pMap aborts before sendTusRequest reaches the aggregate awaits
    // below. These bookkeeping promises still need handlers so the startPromise rejection remains
    // the single error surface.
    uploadUrlPromise.catch(() => {})
    completionPromise.catch(() => {})
 
    uploadUrlPromises.push(uploadUrlPromise)
    completionPromises.push(completionPromise)
 
    if (uploadUrls?.[label]) {
      uploadUrlsResult[label] = uploadUrls[label]
      resolveUrl()
    }
 
    const startPromise = new Promise<void>((resolvePromise, rejectPromise) => {
      if (!assembly.assembly_ssl_url) {
        rejectPromise(new Error('assembly_ssl_url is not present in the assembly status'))
        return
      }
 
      // Check if already aborted before starting
      Iif (signal?.aborted) {
        rejectPromise(new Error('Upload aborted'))
        return
      }
 
      // Wrap resolve/reject to clean up abort listener
      let abortHandler: (() => void) | undefined
      const resolve = (_payload: OnSuccessPayload) => {
        if (abortHandler) signal?.removeEventListener('abort', abortHandler)
        resolveCompletion()
        resolveUrl()
        resolvePromise()
      }
      const reject = (err: unknown) => {
        if (abortHandler) signal?.removeEventListener('abort', abortHandler)
        rejectCompletion(err as Error)
        rejectUrl(err as Error)
        rejectPromise(err)
      }
 
      let tusUpload: Upload
      const tusOptions: UploadOptions = {
        endpoint: assembly.tus_url,
        uploadUrl: uploadUrls?.[label],
        metadata: {
          assembly_url: assembly.assembly_ssl_url,
          fieldname: label,
          filename,
        },
        httpStack: {
          createRequest(method: string, url: string): HttpRequest {
            const request = defaultOptions.httpStack.createRequest(method, url)
            const send = request.send.bind(request)
            request.send = (body: unknown): Promise<HttpResponse> => {
              // tus awaits pre-request hooks, so queued aborts must be checked at send itself.
              if (signal?.aborted) {
                // File setup can finish after abort() and reset tus's aborted state.
                tusUpload.abort()
                return Promise.reject(new Error('Upload aborted'))
              }
              return send(body)
            }
            return request
          },
          getName(): string {
            return defaultOptions.httpStack.getName()
          },
        },
        onError: reject,
        onProgress: onTusProgress,
        onSuccess: resolve,
        onUploadUrlAvailable: () => {
          const url = tusUpload?.url
          Eif (url) {
            uploadUrlsResult[label] = url
          }
          resolveUrl()
          Iif (uploadBehavior === 'none') {
            tusUpload.abort()
            resolveCompletion()
          }
        },
      }
      if (onFileStreamOpened) {
        // tus opens a separate ReadStream for each chunk; abort() leaves those streams open.
        // Track those chunks even when the original file stream belongs to the caller.
        tusOptions.fileReader = {
          async openFile(input: unknown, chunkSize: number): Promise<FileSource> {
            const source = await defaultOptions.fileReader.openFile(input, chunkSize)
            return {
              size: source.size,
              async slice(start: number, end: number): Promise<SliceResult> {
                Iif (signal?.aborted) throw new Error('Upload aborted')
                const reading = source.slice(start, end).then((chunk) => {
                  // tus-js-client declares platform-specific chunk values as any.
                  const value: unknown = chunk.value
                  if (value instanceof ReadStream) onFileStreamOpened(value)
                  if (signal?.aborted) throw new Error('Upload aborted')
                  return chunk
                })
                // A file slice can open its stream before the promise resolves.
                if (input instanceof ReadStream && input.path != null) {
                  onFileSliceStarted?.(reading)
                }
                return await reading
              },
              close() {
                source.close()
              },
            }
          },
        }
      }
      // tus-js-client doesn't like undefined/null
      if (size != null) tusOptions.uploadSize = size
      Eif (chunkSize) tusOptions.chunkSize = chunkSize
      if (uploadLengthDeferred) tusOptions.uploadLengthDeferred = uploadLengthDeferred
 
      tusUpload = new Upload(stream, tusOptions)
 
      // Handle abort signal
      if (signal) {
        abortHandler = () => {
          tusUpload.abort()
          reject(new Error('Upload aborted'))
        }
        signal.addEventListener('abort', abortHandler, { once: true })
      }
 
      tusUpload.start()
    })
 
    Eif (uploadBehavior === 'await') {
      await startPromise
      log(label, 'upload done')
      return
    }
 
    startPromise.catch((err) => {
      logWarn('Background upload failed', err)
    })
 
    await uploadUrlPromise
    log(label, 'upload started')
  }
 
  await pMap(streamLabels, uploadSingleStream, { concurrency: uploadConcurrency, signal })
 
  await Promise.all(uploadUrlPromises)
 
  const uploadsComplete = Promise.allSettled(completionPromises)
  if (uploadBehavior === 'await') {
    await Promise.all(completionPromises)
  } else E{
    uploadsComplete.catch((err) => {
      logWarn('Background upload failed', err)
    })
  }
 
  return { uploadUrls: uploadUrlsResult, uploadsComplete }
}