chore: remove multiGzipWriter #5016

Sidddddarth · 2024-08-20T16:32:02Z

Description

Use misc.GZipWriter in archiver since there's no need of a multi-file writer there.

Linear Ticket

Slack

Resolves PIPE-1440

Security

The code changed/added as part of this pull request won't create any security issues with how the software is being used.

coderabbitai · 2024-08-20T16:32:10Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 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 or @coderabbitai title 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.

lvrach

looking at the underlaying gzWriter implementation I've noticed a few issues as well:

We open a file with append flag file, err := os.OpenFile(s, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0o660) , not sure what the original intention, but the expected behaviour if we fail to write on existing file should result in an error rather appending to the end.
No error is returned gzWriter.Write
In terms of naming, I would get rid of the GZ suffix in its method

lvrach · 2024-08-22T11:14:36Z

processor/stash/stash.go

@@ -184,60 +186,66 @@ func (st *HandleT) storeErrorsToObjectStorage(jobs []*jobsdb.JobT) (errorJob []E
 			continue
 		}
 		path := fmt.Sprintf("%v%v.json.gz", tmpDirPath+localTmpDirName, fmt.Sprintf("%v.%v.%v.%v.%v", time.Now().Unix(), config.GetString("INSTANCE_ID", "1"), fmt.Sprintf("%v-%v", jobs[0].JobID, jobs[len(jobs)-1].JobID), uuid, workspaceID))


We can use https://pkg.go.dev/path/filepath#Join

lvrach · 2024-08-22T11:16:09Z

processor/stash/stash.go

+		if err != nil {
+			panic(err)
+		}
+		writerMap[workspaceID] = writer


We only need to store the writer to get the filename, so does it make sense to keep a list of filenames instead?

processor/stash/stash.go

Co-authored-by: Leonidas Vrachnis <leo.al.vra@gmail.com>

processor/stash/stash.go

Sidddddarth · 2024-08-27T10:52:46Z

We open a file with append flag file, err := os.OpenFile(s, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0o660) , not sure what the original intention, but the expected behaviour if we fail to write on existing file should result in an error rather appending to the end.

An error is returned on failing to write in any case right?

No error is returned gzWriter.Write

It is returned..?

func (w GZipWriter) Write(b []byte) (count int, err error) {
	count, err = w.BufWriter.Write(b)
	if err != nil {
		pkgLogger.Errorf(`[GZWriter]: Error writing bytes of length %d by GZipWriter.Write. Bytes written: %d. Error: %v`, len(b), count, err)
	}
	return
}

In terms of naming, I would get rid of the GZ suffix in its method

We're creating a writer to a compressed file(gz so it makes sense to keep it no?) otherwise we wouldn't know reading stash/archiver code that we write to a gz-ending file. And it's nice wrt this functionality too, explicitly describing the writer

codecov · 2024-08-28T06:40:16Z

Codecov Report

Attention: Patch coverage is 56.33803% with 31 lines in your changes missing coverage. Please review.

Project coverage is 74.68%. Comparing base (c9aa980) to head (4b05fff).
Report is 23 commits behind head on master.

Files with missing lines	Patch %	Lines
processor/stash/stash.go	59.09%	13 Missing and 5 partials ⚠️
cmd/backupfilemigrator/file_migrator.go	20.00%	4 Missing and 4 partials ⚠️
archiver/worker.go	28.57%	2 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5016      +/-   ##
==========================================
+ Coverage   74.65%   74.68%   +0.02%     
==========================================
  Files         431      435       +4     
  Lines       50127    50495     +368     
==========================================
+ Hits        37423    37712     +289     
- Misses      10257    10288      +31     
- Partials     2447     2495      +48

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

processor/stash/stash.go

cisse21

Approved with minor changes

Co-authored-by: Rohith BCS <rohith.bcs@gmail.com>

fracasula

https://jothiprasath.com/blog/gzip-vs-zstd/

zstd ftw 😝

cmd/backupfilemigrator/file_migrator.go

processor/stash/stash.go

fracasula · 2024-09-04T08:06:35Z

processor/stash/stash.go

 		}
 	}()

-	g, ctx := errgroup.WithContext(ctx)
-	g.SetLimit(config.GetInt("Processor.errorBackupWorkers", 100))
+	g, ctx := kitsync.NewEagerGroup(ctx, config.GetInt("Processor.errorBackupWorkers", 100))


Co-authored-by: Francesco Casula <fracasula@users.noreply.github.com>

chore: use misc.GZipWriter in archiver

85d596a

Sidddddarth added 3 commits August 20, 2024 22:07

fixup! chore: use misc.GZipWriter in archiver

d1489eb

chore: use misc.GZipWriter in processor/stash

1a9ba25

chore: remove multiGzipWriter

6171f77

Sidddddarth marked this pull request as ready for review August 21, 2024 19:54

ktgowtham requested review from lvrach, fracasula and ktgowtham August 22, 2024 10:59

lvrach reviewed Aug 22, 2024

View reviewed changes

Sidddddarth changed the title ~~chore: use misc.GZipWriter in archiver~~ chore: remove multiGzipWriter Aug 22, 2024

Update processor/stash/stash.go

44d2e76

Co-authored-by: Leonidas Vrachnis <leo.al.vra@gmail.com>

achettyiitr reviewed Aug 27, 2024

View reviewed changes

processor/stash/stash.go Outdated Show resolved Hide resolved

fixup! Update processor/stash/stash.go

8f94a6f

Sidddddarth force-pushed the chore.gzWriter branch from 53a6d74 to 8f94a6f Compare August 27, 2024 10:59

achettyiitr approved these changes Aug 28, 2024

View reviewed changes

achettyiitr requested a review from lvrach August 29, 2024 05:05

cisse21 reviewed Sep 4, 2024

View reviewed changes

processor/stash/stash.go Outdated Show resolved Hide resolved

cisse21 reviewed Sep 4, 2024

View reviewed changes

processor/stash/stash.go Outdated Show resolved Hide resolved

cisse21 approved these changes Sep 4, 2024

View reviewed changes

Apply suggestions from code review

5a82155

Co-authored-by: Rohith BCS <rohith.bcs@gmail.com>

Sidddddarth enabled auto-merge (squash) September 4, 2024 05:25

Sidddddarth disabled auto-merge September 4, 2024 05:49

$fracasula$

fracasula approved these changes Sep 4, 2024

View reviewed changes

Sidddddarth and others added 2 commits September 4, 2024 14:03

$@fracasula$

Apply suggestions from code review

9ff34d9

Co-authored-by: Francesco Casula <fracasula@users.noreply.github.com>

Update stash.go

4b05fff

Sidddddarth enabled auto-merge (squash) September 4, 2024 12:26

Sidddddarth merged commit bbbd07f into master Sep 4, 2024
53 checks passed

Sidddddarth deleted the chore.gzWriter branch September 4, 2024 16:23

This was referenced Sep 16, 2024

chore: release 1.33.0 #5093

Closed

chore: prerelease 1.34.0-rc.1 #5094

Closed

chore: release 1.33.0 #5095

Closed

mihir20 mentioned this pull request Sep 16, 2024

chore: sync release v1.33.0 to main branch #5054

Merged

This was referenced Sep 16, 2024

chore: release 1.33.0 #5096

Closed

chore: release 1.33.0 #5097

Closed

chore: release 1.33.0 #5098

Closed

chore: release 1.33.0 #5099

Closed

chore: release 1.33.0 #5100

Closed

Sidddddarth mentioned this pull request Sep 17, 2024

chore: sync release 1.33.x to master (#5047) #5102

Merged

1 task

This was referenced Sep 17, 2024

chore: release 1.34.0 #5103

Closed

chore: prerelease 1.34.0-rc.1 #5104

Closed

chore: release 1.34.0 #5105

Merged

chore: prerelease 1.34.0-rc.1 #5106

Merged

chore: prerelease 1.34.0-rc.2 #5108

Merged

chore: prerelease 1.34.0-rc.3 #5111

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: remove multiGzipWriter #5016

chore: remove multiGzipWriter #5016

Sidddddarth commented Aug 20, 2024 •

edited

Loading

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

lvrach left a comment

lvrach Aug 22, 2024

lvrach Aug 22, 2024

Sidddddarth commented Aug 27, 2024

codecov bot commented Aug 28, 2024 •

edited

Loading

cisse21 left a comment

$@fracasula$ fracasula left a comment

$@fracasula$ fracasula Sep 4, 2024

chore: remove multiGzipWriter #5016

chore: remove multiGzipWriter #5016

Conversation

Sidddddarth commented Aug 20, 2024 • edited Loading

Description

Linear Ticket

Security

coderabbitai bot commented Aug 20, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

lvrach left a comment

Choose a reason for hiding this comment

lvrach Aug 22, 2024

Choose a reason for hiding this comment

lvrach Aug 22, 2024

Choose a reason for hiding this comment

Sidddddarth commented Aug 27, 2024

codecov bot commented Aug 28, 2024 • edited Loading

Codecov Report

cisse21 left a comment

Choose a reason for hiding this comment

fracasula left a comment

Choose a reason for hiding this comment

fracasula Sep 4, 2024

Choose a reason for hiding this comment

Sidddddarth commented Aug 20, 2024 •

edited

Loading

coderabbitai bot commented Aug 20, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Aug 28, 2024 •

edited

Loading

$@fracasula$ fracasula left a comment

$@fracasula$ fracasula Sep 4, 2024