drewnoakes/metadata-extractor-dotnet

Implement TgaHeaderReader.TryExtract to not use exceptions as information

Open

#297 opened on Jun 7, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (187 forks)github user discovery
help wanted

Repository metrics

Stars
 (1,059 stars)
PR merge metrics
 (Avg merge 11h 24m) (1 merged PR in 30d)

Description

The current implementation of TgaHeaderReader.TryExtract returns false from a catch block. It should, instead, use return values to indicate when extraction failed.

This is more relevant than it may seem at first, as the FileTypeDetector infrastructure uses this code path to detect whether a file is TGA or not (there is no easy way to detect TGA, so we just attempt an extraction). For bulk file processing, this exception can occur regularly. This makes debugging annoying, and can hurt performance.

Contributor guide

Research direction
Examine the current TryExtract method in TgaHeaderReader and refactor it to return a boolean with an output parameter instead of using exceptions for control flow. Ensure all callers handle the new return pattern correctly.
Tech stack
csharp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80