Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: event_payload column can be JSONB or TEXT #5372

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

Sidddddarth
Copy link
Member

@Sidddddarth Sidddddarth commented Dec 13, 2024

Description

event_payload column in newly created jobs tables will be TEXT columns.

Allows migrations from one type to the other, so changing from one to the other shouldn't fail. Changing back to JSONB would allow server processes to continue, however utility postgres functions like unionjobsdb would fail as the function definition returns table with different column types.

At startup(for w, rw jobsdbs) - we either update the last DS's event_payload column if empty or create a new dataset if the last has some jobs already - both provided the event type column of the last ds is different from what's configured.

Not a reloadable selection.

Allowed creating BYTEA columns but only for benchmark purposes. TEXT seems to be doing better and also avoids other character validation problems.

Linear Ticket

Resolves PIPE-1649

Security

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

@Sidddddarth Sidddddarth marked this pull request as draft December 13, 2024 10:33
@Sidddddarth Sidddddarth force-pushed the chore.jobsdbPayloadColumnType branch from c053da4 to c5c21e3 Compare December 13, 2024 12:02
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 58.33333% with 40 lines in your changes missing coverage. Please review.

Project coverage is 74.85%. Comparing base (8a186e5) to head (a03976d).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
jobsdb/migration.go 56.16% 28 Missing and 4 partials ⚠️
jobsdb/jobsdb.go 65.21% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5372      +/-   ##
==========================================
+ Coverage   74.82%   74.85%   +0.02%     
==========================================
  Files         438      438              
  Lines       61331    61419      +88     
==========================================
+ Hits        45893    45974      +81     
- Misses      12895    12909      +14     
+ Partials     2543     2536       -7     

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

@Sidddddarth Sidddddarth changed the title chore: event_payload column can be JSONB, BYTEA or TEXT chore: event_payload column can be JSONB or TEXT Dec 23, 2024
@Sidddddarth Sidddddarth marked this pull request as ready for review December 24, 2024 06:22
jobsdb/jobsdb.go Outdated
@@ -770,6 +798,10 @@ func (jd *Handle) init() {
jd.config = config.Default
}

if jd.conf.payloadColumnType == 0 {
jd.conf.payloadColumnType = payloadColumnType(jd.config.GetIntVar(2, 1, "JobsDB.payloadColumnType"))
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
jd.conf.payloadColumnType = payloadColumnType(jd.config.GetIntVar(2, 1, "JobsDB.payloadColumnType"))
jd.conf.payloadColumnType = payloadColumnType(jd.config.GetIntVar(int(TEXT), 1, "JobsDB.payloadColumnType"))

Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we want TEXT to be default?

Copy link
Member Author

@Sidddddarth Sidddddarth Dec 26, 2024

Choose a reason for hiding this comment

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

because it's faster than using jsonb column
saw no reason to not change the default to text

jobsdb/jobsdb.go Outdated Show resolved Hide resolved
jobsdb/jobsdb.go Outdated Show resolved Hide resolved
@Sidddddarth Sidddddarth force-pushed the chore.jobsdbPayloadColumnType branch from f964bf8 to 5a4adff Compare December 26, 2024 12:29
Comment on lines 1115 to 1119
jobDB.TearDown()

conf.Set("JobsDB.payloadColumnType", 2)
textDB := &Handle{config: conf}
require.NoError(t, textDB.Setup(ReadWrite, true, strings.ToLower(rand.String(5))))
Copy link
Member

Choose a reason for hiding this comment

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

Do you think we should use a table-driven test to avoid repetition here?

Run same test for payloadColumnType: [1,2,3].

Also, payloadColumnType could be better. (separate comment)

Copy link
Member Author

Choose a reason for hiding this comment

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

done - incorporating fuzz tests is pending

jobsdb/jobsdb.go Outdated
Comment on lines 801 to 803
if jd.conf.payloadColumnType == 0 {
jd.conf.payloadColumnType = payloadColumnType(jd.config.GetIntVar(int(TEXT), 1, "JobsDB.payloadColumnType"))
}
Copy link
Member

Choose a reason for hiding this comment

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

I believe it is preferable to configure this as a text, using the original Postgres types to avoid any confusion.

Copy link
Member

Choose a reason for hiding this comment

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

Also, shouldn't the default be JSONB ?

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah will make the config change, makes sense
as for the default - I've just used the new TEXT column because it's faster..
No reason to not use it right..? We'll have to change all environments to TEXT at some point.

jobsdb/jobsdb.go Outdated Show resolved Hide resolved
jobsdb/jobsdb.go Outdated Show resolved Hide resolved
jobsdb/migration.go Outdated Show resolved Hide resolved
jobsdb/migration.go Outdated Show resolved Hide resolved
jobsdb/migration.go Outdated Show resolved Hide resolved
@@ -459,18 +459,85 @@ func (jd *Handle) getMigrationList(dsList []dataSetT) (migrateFrom []dsWithPendi
return
}

func getColumnConversion(srcType, destType string) string {
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to find a universal way to do the mapping, that will always work?

@Sidddddarth Sidddddarth force-pushed the chore.jobsdbPayloadColumnType branch from e5e9442 to b55615a Compare December 28, 2024 18:03
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.

3 participants