Refactor importActorProfile and validateExportStream functions to improve error handling, normalize file names, and skip system-generated files

Author: 0marSalah

src/index.ts

@@ -182,31 +182,35 @@ export async function exportActorProfile({
 /**
  * Imports an ActivityPub profile from a .tar archive stream.
  * @param tarStream - A ReadableStream containing the .tar archive.
+ * @param options - Options for the import process.
  * @returns A promise that resolves to the parsed profile data.
  */
 export async function importActorProfile(
-  tarStream: Readable
+  tarStream: Readable,
+  options: {
+    console?: Pick<Console, 'log' | 'warn' | 'error'>
+    onError?: (error: Error, context: { fileName?: string }) => void
+  } = {}
 ): Promise<Record<string, any>> {
-  console.log('🚀 Starting to process tar stream...')
+  const { console = undefined, onError = undefined } = options
   const extract = tar.extract()
   const result: Record<string, any> = {}
 
   return await new Promise((resolve, reject) => {
     extract.on('entry', (header, stream, next) => {
-      // Normalize fileName to include only `activitypub/filename`
       const originalFileName = header.name
-      const fileName = `activitypub/${path.basename(originalFileName)}`
+      const basename = path.basename(originalFileName)
+      console?.log('🚀 ~ extract.on ~ basename:', basename)
+      const fileName = `activitypub/${basename}`
 
       // Skip system-generated files
-      if (
-        fileName.startsWith('activitypub/._') ||
-        fileName.endsWith('.DS_Store')
-      ) {
-        console.warn(`Skipping system-generated file: ${fileName}`)
+      if (basename.startsWith('.')) {
+        console?.warn(`Skipping system-generated file: ${fileName}`)
         next()
+        return
       }
 
-      console.log(`Processing file: ${fileName}`)
+      console?.log(`Processing file: ${fileName}`)
       let content = ''
 
       stream.on('data', (chunk) => {
@@ -217,40 +221,58 @@ export async function importActorProfile(
         try {
           if (fileName.endsWith('.json')) {
             result[fileName] = JSON.parse(content)
-            console.log('Parsed JSON file successfully:', fileName)
+            console?.log('Parsed JSON file successfully:', fileName)
           } else if (fileName.endsWith('.yaml') || fileName.endsWith('.yml')) {
             result[fileName] = YAML.parse(content)
           } else if (fileName.endsWith('.csv')) {
             result[fileName] = content
           } else {
-            console.warn(`Unsupported file type: ${fileName}, skipping...`)
+            console?.warn(`Unsupported file type: ${fileName}, skipping...`)
           }
         } catch (error: any) {
-          console.error(`Error processing file ${fileName}:`, error.message)
+          const errorMessage = `Error processing file ${fileName}: ${error.message}`
+          if (onError) {
+            onError(new Error(errorMessage), { fileName })
+          } else {
+            reject(new Error(errorMessage))
+          }
         } finally {
           next() // Always continue
         }
       })
 
       stream.on('error', (error: any) => {
-        console.error(`Stream error on file ${fileName}:`, error.message)
+        const errorMessage = `Stream error on file ${fileName}: ${error.message}`
+        if (onError) {
+          onError(new Error(errorMessage), { fileName })
+        } else {
+          reject(new Error(errorMessage))
+        }
         next() // Continue even on stream error
       })
     })
 
     extract.on('finish', () => {
-      console.log('All files processed successfully.')
+      console?.log('All files processed successfully.')
       resolve(result)
     })
 
     extract.on('error', (error) => {
-      console.error('Error during tar extraction:', error.message)
-      reject(new Error('Failed to extract tar file.'))
+      const errorMessage = `Error during tar extraction: ${error.message}`
+      if (onError) {
+        onError(new Error(errorMessage), {})
+      } else {
+        reject(new Error(errorMessage))
+      }
     })
 
     tarStream.on('error', (error) => {
-      console.error('Error in tar stream:', error.message)
-      reject(new Error('Failed to process tar stream.'))
+      const errorMessage = `Error in tar stream: ${error.message}`
+      if (onError) {
+        onError(new Error(errorMessage), {})
+      } else {
+        reject(new Error(errorMessage))
+      }
     })
 
     tarStream.pipe(extract)

src/verify.ts

@@ -1,6 +1,7 @@
 import * as tar from 'tar-stream'
 import { type Readable } from 'stream'
 import YAML from 'yaml'
+import path from 'path'
 
 /**
  * Validates the structure and content of an exported ActivityPub tarball.
@@ -22,7 +23,20 @@ export async function validateExportStream(
 
   return await new Promise((resolve) => {
     extract.on('entry', (header, stream, next) => {
-      const fileName = header.name.toLowerCase() // Normalize file name
+      const originalFileName = header.name
+      const basename = path.basename(originalFileName)
+      console?.log('🚀 ~ extract.on ~ basename:', basename)
+      const fileName =
+        basename === 'manifest.yaml'
+          ? 'manifest.yaml'
+          : `activitypub/${basename}`
+
+      // Skip system-generated files
+      if (basename.startsWith('.')) {
+        console?.warn(`Skipping system-generated file: ${fileName}`)
+        next()
+        return
+      }
       foundFiles.add(fileName)
 
       let content = ''