chore: better logging in automap plugin

[carlbrugger]

Please explain how to summarize this PR for the Changelog:

This PR adds more logging to the automap plugin

Closes https://github.com/FlatFilers/support-triage/issues/1704

Tell code reviewer how and what to test:

[coderabbitai]

Walkthrough

This pull request introduces enhancements to the logging capabilities of the @flatfile/plugin-automap package, specifically within the AutomapService class. Key changes include the addition of debug log statements in various methods to improve visibility into the plugin's operations, particularly during error handling and file extraction processes. These updates aim to facilitate better tracking and troubleshooting of issues encountered during execution.

Changes

File Path	Change Summary
.changeset/proud-snails-jam.md	Added debug messaging to the automap plugin for improved logging capabilities.
plugins/automap/src/automap.service.ts	Enhanced error handling and logging in AutomapService: added debug logs in handleFileExtraction, getTargetWorkbook, and getMappingJobs methods.

Possibly related PRs

• feat: remove remeda & add disableFileNameUpdate option #672: This PR modifies the AutomapService class in automap.service.ts, enhancing logging mechanisms, which is directly related to the logging improvements made in the main PR.
• fixes dataRowAndSubHeaderDetection algorithm #687: This PR addresses issues in the header detection algorithm, which may involve logging changes similar to those in the main PR, although it focuses on a different aspect of the plugin's functionality.

Suggested reviewers

• bangarang

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)

plugins/automap/src/automap.service.ts (4)

93-101: Enhance error message with source sheet details

While the error logging is well-placed, the message could be more informative by including details about the source sheet to aid in debugging.

 if (this.isNil(destinationSheetId)) {
   if (this.options.debug) {
     logError(
       '@flatfile/plugin-automap',
-      'Unable to determine destination sheet'
+      `Unable to determine destination sheet for target "${target}" (source sheet: ${source})`
     )
   }
   return
 }

---

168-173: Consider using logWarn instead of logError

The absence of workbooks might be an expected scenario in some cases, making it more appropriate to use logWarn instead of logError. This would better reflect that this is a validation state rather than a system error.

 if (targets.length === 0) {
   if (this.options.debug) {
-    logError(
+    logWarn(
       '@flatfile/plugin-automap',
       'No workbooks found, skipping automap'
     )
   }
   return undefined

---

350-355: Add context to the warning message

The warning message could be more helpful by explaining why the mapping couldn't be determined (multiple sheets present and no selection function).

 if (this.options.debug) {
   logWarn(
     '@flatfile/plugin-automap',
-    'Unable to determine mapping between source and destination sheets, skipping automap'
+    `Unable to determine sheet mapping: found ${sheets.length} sheets but no sheet selection function provided, skipping automap`
   )
 }

---

Line range hint 1-3: Extract module name to a constant

To maintain consistency and avoid typos, consider extracting the module name used in logging statements to a constant.

 import { Flatfile, FlatfileClient } from '@flatfile/api'
 import type { FlatfileEvent, FlatfileListener } from '@flatfile/listener'
 import { logError, logInfo, logWarn } from '@flatfile/util-common'
+
+const MODULE_NAME = '@flatfile/plugin-automap'

Then use it in all logging calls:

-logError('@flatfile/plugin-automap', 'No Workbook Id found')
+logError(MODULE_NAME, 'No Workbook Id found')

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2d1acee and 392387c.

📒 Files selected for processing (2)

• .changeset/proud-snails-jam.md (1 hunks)
• plugins/automap/src/automap.service.ts (3 hunks)

✅ Files skipped from review due to trivial changes (1)

• .changeset/proud-snails-jam.md