All files / src/unpack/readTarArchive index.ts

100% Statements 99/99
100% Branches 19/19
100% Functions 3/3
100% Lines 99/99

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 1001x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 8x 8x 8x 8x 8x 1x 1x 1x 1x 1x 1x 8x 1x 8x 8x 8x 8x 8x 8x 20x 20x 20x 10x 20x 20x 20x 20x 20x 20x 20x 1x 1x 1x 19x 19x 20x 8x 8x 8x 8x 8x 8x 8x 8x 1x 20x 20x 20x 20x 20x 20x 20x 20x 1x 1x 19x 20x 8x 8x 8x 11x 20x 1x 1x 1x 1x 1x 10x 10x 10x 10x 10x 10x 10x 10x  
/**
 * Copyright 2026 nodearchive
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { Readable } from 'node:stream'
import { extract, type Headers } from 'tar-stream'
import { NodearchiveError } from '../../.errors/class.js'
import { toNodearchiveError } from '../../.helpers/toNodearchiveError/index.js'
import type { ArchiveEntry } from '../../.types/ArchiveEntry/type.js'
import type { ArchiveManifest } from '../../.types/ArchiveManifest/type.js'
import { toArchiveManifest } from '../toArchiveManifest/index.js'
 
export async function readTarArchive(
  bytes: Uint8Array
): Promise<ArchiveManifest> {
  try {
    return toArchiveManifest(await collectEntries(bytes))
  } catch (error) {
    throw toNodearchiveError(
      error,
      'ARCHIVE_INVALID_FORMAT',
      'Invalid tar archive'
    )
  }
}
 
function collectEntries(bytes: Uint8Array): Promise<ArchiveEntry[]> {
  return new Promise((resolve, reject) => {
    const entries: ArchiveEntry[] = []
    const parser = extract()
 
    parser.on('entry', (header, stream, next) => {
      const chunks: Buffer[] = []
 
      stream.on('data', (chunk) => {
        chunks.push(Buffer.from(chunk))
      })
 
      stream.on('error', reject)
      stream.on('end', () => {
        try {
          pushEntry(entries, header, chunks)
        } catch (error) {
          reject(error)
          return
        }
 
        next()
      })
    })
 
    parser.on('error', reject)
    parser.on('finish', () => resolve(entries))
 
    Readable.from(Buffer.from(bytes)).pipe(parser)
  })
}
 
function pushEntry(
  entries: ArchiveEntry[],
  header: Headers,
  chunks: Buffer[]
): void {
  const entryPath = header.name.replace(/\/+$/u, '')
 
  if (!entryPath) {
    return
  }
 
  if (header.type === 'directory') {
    entries.push({ kind: 'directory', mode: header.mode, path: entryPath })
    return
  }
 
  if (header.type !== 'file' && header.type !== 'contiguous-file') {
    throw new NodearchiveError(
      'ARCHIVE_UNSUPPORTED_ENTRY',
      `Unsupported archive entry: ${header.name}`
    )
  }
 
  entries.push({
    data: Buffer.concat(chunks).toString('base64'),
    kind: 'file',
    mode: header.mode,
    path: entryPath,
  })
}