fix(file): return explicit error from StorageProvider.NewWriter#3175
Open
coolwednesday wants to merge 1 commit intodevelopmentfrom
Open
fix(file): return explicit error from StorageProvider.NewWriter#3175coolwednesday wants to merge 1 commit intodevelopmentfrom
coolwednesday wants to merge 1 commit intodevelopmentfrom
Conversation
Change StorageProvider.NewWriter and MetadataWriter.NewWriterWithOptions to return (io.WriteCloser, error) instead of just io.WriteCloser. This removes the failWriter pattern that silently deferred errors to Write/Close time, making error handling explicit at the point of writer creation. Fixes #3146
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
StorageProvider.NewWriterandMetadataWriter.NewWriterWithOptionsto return(io.WriteCloser, error)instead of justio.WriteCloserfailWriterpattern across all providers (local, GCS, Azure, FTP) that silently deferred errors to Write/Close timeCommonFileSystem(Create,Mkdir,handleWriteFlags,CreateWithOptions) to handle the explicit errorWhy
The previous
failWriterapproach masked initialization errors — callers only discovered problems when they tried toWrite()orClose(), making debugging harder. Returning the error explicitly at creation time is the idiomatic Go pattern.Impact
This is not a breaking change for end users.
StorageProviderandMetadataWriterare internal interfaces not exposed in the public API. Users interact with higher-levelFileSystem/FileSystemProvidermethods whose signatures are unchanged.Test plan
pkg/gofr/datasource/filetests passpkg/gofr/datasource/file/azuretests passpkg/gofr/datasource/file/ftptests passpkg/gofr/datasource/file/gcstests pass