Skip to content

Fix for empty sheets extraction#745

Merged
carlbrugger merged 1 commit intomainfrom
fix/excel-extraction-empty-sheets
Jan 29, 2025
Merged

Fix for empty sheets extraction#745
carlbrugger merged 1 commit intomainfrom
fix/excel-extraction-empty-sheets

Conversation

@carlbrugger
Copy link
Contributor

Please explain how to summarize this PR for the Changelog:

Fixes issue https://github.com/FlatFilers/support-triage/issues/1751

Tell code reviewer how and what to test:

@carlbrugger carlbrugger marked this pull request as ready for review January 29, 2025 15:55
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Walkthrough

This pull request introduces a patch for the @flatfile/plugin-xlsx-extractor plugin to improve handling of XLSX files with empty sheets. The changes focus on the convertSheet function in the parser, adding a new conditional check to return undefined when the converted rows array is empty. This modification enhances the plugin's robustness when processing XLSX files with varying sheet structures.

Changes

File Change Summary
plugins/xlsx-extractor/src/parser.ts Added early return condition in convertSheet function to handle empty sheets by returning undefined when no rows are present after conversion
.changeset/kind-eagles-protect.md Added changeset file to document the patch for the XLSX extractor plugin

Possibly related PRs

  • fix: issue 1699 #729: Modifies @flatfile/plugin-xlsx-extractor to trim trailing null header cells, complementing the current PR's improvements to XLSX file extraction

Suggested reviewers

  • damonbanks
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
plugins/xlsx-extractor/src/parser.ts (1)

124-127: LGTM! Consider adding a debug log for consistency.

The early return for empty sheets is a good addition. For consistency with other empty checks in this function, consider adding a debug log here as well.

   if (rows.length === 0) {
+    if (debug) {
+      console.log(`No rows found in '${sheetName}' during initial conversion`)
+    }
     return
   }
.changeset/kind-eagles-protect.md (1)

5-5: Consider expanding the changeset description.

While accurate, the description could be more detailed to help users understand the impact and scope of the change.

-This release fixes XLSX file extraction when the file contains empty sheets
+This release improves XLSX file extraction by properly handling files containing empty sheets. Previously, empty sheets could cause processing issues; now they are gracefully skipped during extraction.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8935a37 and c6bf3ea.

📒 Files selected for processing (2)
  • .changeset/kind-eagles-protect.md (1 hunks)
  • plugins/xlsx-extractor/src/parser.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Setup
🔇 Additional comments (1)
plugins/xlsx-extractor/src/parser.ts (1)

124-127: Verify error handling for empty sheets.

Let's verify that this change doesn't affect error reporting in the parent function.

✅ Verification successful

Error handling for empty sheets is properly maintained

The code maintains appropriate error handling by:

  • Returning undefined for empty sheets (type-safe via function signature)
  • Providing debug logging for visibility
  • Avoiding unnecessary processing through early returns
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for error handling related to empty sheets in the codebase
rg -A 5 "Failed to parse workbook" plugins/
rg -A 5 "No rows found in" plugins/

Length of output: 1117


Script:

#!/bin/bash
# Get more context around the error handling
ast-grep --pattern 'function $FUNC($$$) {
  $$$
  if (rows.length === 0) {
    $$$
  }
  $$$
}'

Length of output: 97


Script:

#!/bin/bash
# Get more context around the empty rows check and error handling
rg -B 10 -A 10 "if \(rows\.length === 0\)" plugins/xlsx-extractor/src/parser.ts

Length of output: 1211

Copy link
Contributor

@damonbanks damonbanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@carlbrugger carlbrugger merged commit 6b17584 into main Jan 29, 2025
37 checks passed
@carlbrugger carlbrugger deleted the fix/excel-extraction-empty-sheets branch January 29, 2025 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants