feat: add more logging to media

src/LegacySocket/messages.ts

@@ -517,12 +517,12 @@ const makeMessagesSocket = (config: LegacySocketConfig) => {
 					jid,
 					content,
 					{
-						...options,
 						logger,
 						userJid: userJid,
 						getUrlInfo: generateUrlInfo,
 						upload: waUploadToServer,
-						mediaCache: config.mediaCache
+						mediaCache: config.mediaCache,
+						...options,
 					}
 				)
 				

src/Socket/messages-send.ts

@@ -451,13 +451,13 @@ export const makeMessagesSocket = (config: SocketConfig) => {
 					jid,
 					content,
 					{
-						...options,
 						logger,
 						userJid,
                         // multi-device does not have this yet
 						//getUrlInfo: generateUrlInfo,
 						upload: waUploadToServer,
                         mediaCache: config.mediaCache,
+						...options,
 					}
 				)
                 const isDeleteMsg = 'delete' in content && !!content.delete

src/Utils/messages-media.ts

@@ -222,10 +222,13 @@ export const getGotStream = async(url: string | URL, options: Options & { isStre
 export const encryptedStream = async(
     media: WAMediaUpload, 
     mediaType: MediaType,
-    saveOriginalFileIfRequired = true
+    saveOriginalFileIfRequired = true,
+    logger?: Logger
 ) => {
     const { stream, type } = await getStream(media)
 
+    logger?.debug('fetched media stream')
+
     const mediaKey = Crypto.randomBytes(32)
     const {cipherKey, iv, macKey} = getMediaKeys(mediaKey, mediaType)
     // random name
@@ -277,6 +280,8 @@ export const encryptedStream = async(
         encWriteStream.push(null)
     
         writeStream && writeStream.end()
+
+        logger?.debug('encrypted data successfully')
     
         return {
             mediaKey,

src/Utils/messages.ts

@@ -1,5 +1,5 @@
 import { Boom } from '@hapi/boom'
-import { createReadStream, promises as fs } from "fs"
+import { promises as fs } from "fs"
 import { proto } from '../../WAProto'
 import { MEDIA_KEYS, URL_REGEX, WA_DEFAULT_EPHEMERAL } from "../Defaults"
 import { 
@@ -56,6 +56,8 @@ export const prepareWAMessageMedia = async(
 	message: AnyMediaMessageContent, 
 	options: MediaGenerationOptions
 ) => {
+	const logger = options.logger
+
 	let mediaType: typeof MEDIA_KEYS[number]
 	for(const key of MEDIA_KEYS) {
 		if(key in message) {
@@ -79,9 +81,11 @@ export const prepareWAMessageMedia = async(
 	if(cacheableKey) {
 		const mediaBuff: Buffer = options.mediaCache!.get(cacheableKey)
 		if(mediaBuff) {
+			logger?.debug({ cacheableKey }, `got media cache hit`)
 			return WAProto.Message.decode(mediaBuff)
 		}
 	}
+
 	if(mediaType === 'document' && !uploadData.fileName) {
 		uploadData.fileName = 'file'
 	}
@@ -110,22 +114,26 @@ export const prepareWAMessageMedia = async(
 	)
 
 	const [{ mediaUrl, directPath }] = await Promise.all([
-		(() => {
+		(async() => {
-			return options.upload(
+			const result = await options.upload(
 				encWriteStream,
 				{ fileEncSha256B64, mediaType, timeoutMs: options.mediaUploadTimeoutMs }
 			)
+			logger?.debug(`uploaded media`)
+			return result
 		})(),
 		(async() => {
 			try {
 				if(requiresThumbnailComputation) {
 					uploadData.jpegThumbnail = await generateThumbnail(bodyPath, mediaType as any, options)
+					logger?.debug(`generated thumbnail`)
 				}
 				if (requiresDurationComputation) {
 					uploadData.seconds = await getAudioDuration(bodyPath)
+					logger?.debug(`computed audio duration`)
 				}
 			} catch (error) {
-				options.logger?.info({ trace: error.stack }, 'failed to obtain extra info')
+				logger?.warn({ trace: error.stack }, 'failed to obtain extra info')
 			}
 		})(),
 	])
@@ -133,7 +141,10 @@ export const prepareWAMessageMedia = async(
 		async() => {
 			encWriteStream.destroy()
 			// remove tmp files
-			didSaveToTmpPath && bodyPath && await fs.unlink(bodyPath)
+			if(didSaveToTmpPath && bodyPath) {
+				await fs.unlink(bodyPath)
+				logger?.debug('removed tmp files')
+			}
 		}
 	)
 
@@ -155,6 +166,7 @@ export const prepareWAMessageMedia = async(
 	})
 
 	if(cacheableKey) {
+		logger.debug({ cacheableKey }, `set cache`)
 		options.mediaCache!.set(cacheableKey, WAProto.Message.encode(obj).finish())
 	}
 
@@ -278,14 +290,14 @@ export const generateWAMessageContent = async(
 		}
 
 		m = { buttonsMessage }
-	} else if ('templateButtons' in message && !!message.templateButtons) {
+	} else if('templateButtons' in message && !!message.templateButtons) {
 		const templateMessage: proto.ITemplateMessage = {
 			hydratedTemplate: {
 				hydratedButtons: message.templateButtons
 			}
 		}
 		
-		if ('text' in message) {
+		if('text' in message) {
 			templateMessage.hydratedTemplate.hydratedContentText = message.text
 		} else {
 
@@ -296,7 +308,7 @@ export const generateWAMessageContent = async(
 			Object.assign(templateMessage.hydratedTemplate, m)
 		}
 
-		if ('footer' in message && !!message.footer) {
+		if('footer' in message && !!message.footer) {
 			templateMessage.hydratedTemplate.hydratedFooterText = message.footer
 		}
 
@@ -377,8 +389,10 @@ export const generateWAMessage = async(
 	jid: string,
 	content: AnyMessageContent,
 	options: MessageGenerationOptions,
-) => (
+) => {
-	generateWAMessageFromContent(
+	// ensure msg ID is with every log
+	options.logger = options?.logger?.child({ msgId: options.messageId })
+	return generateWAMessageFromContent(
 		jid,
 		await generateWAMessageContent(
 			content,
@@ -386,7 +400,7 @@ export const generateWAMessage = async(
 		),
 		options
 	)
-)
+}
 
 /**
  * Extract the true message content from a message