[usage] Add db.Project model in golang #10368

easyCZ · 2022-05-31T07:23:10Z

Description

Adds golang model for d_b_project table. Process similar to #10293

Related Issue(s)

Part of Define db models in Golang #10317

How to test

Unit tests

leeway build components/usage:init-testdb

Navigate to the component and do go test ./... to test this and all sub-packages.

Release Notes

NONE

Documentation

NONE

jankeromnes

Many thanks for this PR! Left a few questions in-line for now & will finish this code review later today.

jankeromnes · 2022-06-02T07:57:04Z

components/usage/pkg/db/project.go

+	TeamID sql.NullString `gorm:"column:teamId;type:char;size:36;" json:"teamId"`
+	UserID sql.NullString `gorm:"column:userId;type:char;size:36;" json:"userId"`
+
+	MarkedDeleted int32 `gorm:"column:markedDeleted;type:tinyint;default:0;" json:"markedDeleted"`


Question: Why use int32 to represent booleans?

Shouldn't this be a bool?

SQL's tinyint is one byte, so this could also be uint8 or byte

The underlying datatype in MySQL is tinyint it looks like, so here it only matches that. I'll see if using a bool results in similar behaviour.

I've updated this to bool. It works fine and gives us nicer handling with the model. Great spot!

components/usage/pkg/db/project.go

jankeromnes

Many thanks for adjusting! 👍

A few more comments in-line.

Also, how do you run the unit tests?

components/usage/pkg/db/project.go

components/usage/pkg/db/project_test.go

jankeromnes · 2022-06-02T11:13:52Z

components/usage/pkg/db/workspace.go


 	SoftDeleted sql.NullString `gorm:"column:softDeleted;type:char;size:4;" json:"softDeleted"`
-	Pinned      int32          `gorm:"column:pinned;type:tinyint;default:0;" json:"pinned"`
+	Pinned      bool           `gorm:"column:pinned;type:tinyint;default:0;" json:"pinned"`

 	// deleted is reserved for use by db-sync
 	_ int32 `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`


Suggested change

_ int32 `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`

_ bool `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`

Also,

Workspace.ID and Workspace.OwnerID could be of type uuid.UUID

Workspace.Type could be an enum [1]

Good spot. I'd like to leave this part for later PRs once we start using the data from the model and come across this. This will guide us exactly how we want to encapsulated the enum model for this.

Co-authored-by: Jan Keromnes <[email protected]>

easyCZ · 2022-06-02T11:36:58Z

Also, how do you run the unit tests?

Standard go test. Navigate to the component and do go test ./... to test this and all sub-packages.

jankeromnes · 2022-06-02T11:42:27Z

Standard go test. Navigate to the component and do go test ./... to test this and all sub-packages.

Thanks! I took the liberty to clarify the "How to test" instructions in your PR description. 😇

Also, could these eventually be run by Werft, so that we automatically detect new bugs / regressions? 👀

jankeromnes · 2022-06-02T11:53:07Z

I tried this -- did I do something wrong?

Open PR in Gitpod
👇

$ cd components/usage/
$ go test ./...
go: downloading gorm.io/driver/mysql v1.3.3
go: downloading github.com/relvacode/iso8601 v1.1.0
go: downloading gorm.io/gorm v1.23.5
go: downloading github.com/go-sql-driver/mysql v1.6.0
go: downloading gorm.io/datatypes v1.0.6
go: downloading github.com/spf13/cobra v1.4.0
go: downloading github.com/jinzhu/inflection v1.0.0
go: downloading github.com/jinzhu/now v1.1.4
?       github.com/gitpod-io/gitpod/usage       [no test files]
?       github.com/gitpod-io/gitpod/usage/cmd   [no test files]

2022/06/02 11:50:19 /workspace/gitpod/components/usage/pkg/db/conn.go:41
[error] failed to initialize database, got error dial tcp [::1]:23306: connect: connection refused
--- FAIL: TestConnectForTests (0.00s)
    conn_test.go:13: 
                Error Trace:    conn.go:55
                                                        conn_test.go:13
                Error:          Received unexpected error:
                                dial tcp [::1]:23306: connect: connection refused
                Test:           TestConnectForTests
                Messages:       Failed to establish connection to DB. In a workspace, run `leeway build components/usage:init-testdb` once to bootstrap the DB.

2022/06/02 11:50:19 /workspace/gitpod/components/usage/pkg/db/conn.go:41
[error] failed to initialize database, got error dial tcp [::1]:23306: connect: connection refused
--- FAIL: TestProject_ReadExistingRecords (0.00s)
    project_test.go:34: 
                Error Trace:    conn.go:55
                                                        project_test.go:34
                Error:          Received unexpected error:
                                dial tcp [::1]:23306: connect: connection refused
                Test:           TestProject_ReadExistingRecords
                Messages:       Failed to establish connection to DB. In a workspace, run `leeway build components/usage:init-testdb` once to bootstrap the DB.

2022/06/02 11:50:19 /workspace/gitpod/components/usage/pkg/db/conn.go:41
[error] failed to initialize database, got error dial tcp [::1]:23306: connect: connection refused
--- FAIL: TestRead (0.00s)
    workspace_test.go:51: 
                Error Trace:    conn.go:55
                                                        workspace_test.go:51
                Error:          Received unexpected error:
                                dial tcp [::1]:23306: connect: connection refused
                Test:           TestRead
                Messages:       Failed to establish connection to DB. In a workspace, run `leeway build components/usage:init-testdb` once to bootstrap the DB.
FAIL
FAIL    github.com/gitpod-io/gitpod/usage/pkg/db        0.008s
FAIL

easyCZ · 2022-06-02T12:05:23Z

@jankeromnes see instructions in the error message.

Failed to establish connection to DB. In a workspace, run `leeway build components/usage:init-testdb` once to bootstrap the DB.

easyCZ · 2022-06-02T12:14:05Z

Also, could these eventually be run by Werft, so that we automatically detect new bugs / regressions? 👀

The tests are already run by werft :)

See raw logs and search for usage. There are logs from the unit tests.

jankeromnes

Thanks again for helping figure out the test instructions!

All nits are addressed, the code looks good, and it works as advertised. 👍

LGTM* 🐐

*(LGTM = Let Goats Try Minecraft)

easyCZ · 2022-06-02T12:22:39Z

<3

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/S labels May 31, 2022

easyCZ mentioned this pull request May 31, 2022

Define db models in Golang #10317

Closed

roboquat added release-note-none size/M size/L and removed do-not-merge/release-note-label-needed size/S size/M labels May 31, 2022

easyCZ force-pushed the mp/usage-project-model branch 2 times, most recently from c884749 to 47991a8 Compare May 31, 2022 14:59

easyCZ marked this pull request as ready for review May 31, 2022 15:01

roboquat removed the do-not-merge/work-in-progress label May 31, 2022

easyCZ requested a review from a team May 31, 2022 15:01

github-actions bot added the team: webapp Issue belongs to the WebApp team label May 31, 2022

jankeromnes self-assigned this Jun 2, 2022

jankeromnes reviewed Jun 2, 2022

View reviewed changes

[usage] Add db.Project model in golang

5b940b2

easyCZ force-pushed the mp/usage-project-model branch from 47991a8 to 5b940b2 Compare June 2, 2022 11:05

easyCZ requested a review from jankeromnes June 2, 2022 11:06

jankeromnes reviewed Jun 2, 2022

View reviewed changes

Update components/usage/pkg/db/project.go

e84166f

Co-authored-by: Jan Keromnes <[email protected]>

jankeromnes approved these changes Jun 2, 2022

View reviewed changes

roboquat merged commit 4c83691 into main Jun 2, 2022

roboquat deleted the mp/usage-project-model branch June 2, 2022 12:19

roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Jun 9, 2022

	_ int32 `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`
	_ bool `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`

[usage] Add db.Project model in golang #10368

[usage] Add db.Project model in golang #10368

Uh oh!

Conversation

easyCZ commented May 31, 2022 • edited by jankeromnes Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue(s)

How to test

Release Notes

Documentation

Uh oh!

jankeromnes left a comment

Choose a reason for hiding this comment

Uh oh!

jankeromnes Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

easyCZ Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

easyCZ Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jankeromnes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jankeromnes Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

jankeromnes Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

easyCZ Jun 2, 2022

Choose a reason for hiding this comment

Uh oh!

easyCZ commented Jun 2, 2022

Uh oh!

jankeromnes commented Jun 2, 2022 • edited by werft-gitpod-dev-com bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

easyCZ commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

easyCZ commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jankeromnes left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

easyCZ commented Jun 2, 2022

Uh oh!

Uh oh!

easyCZ commented May 31, 2022 •

edited by jankeromnes

Loading

jankeromnes commented Jun 2, 2022 •

edited by werft-gitpod-dev-com bot

Loading

jankeromnes commented Jun 2, 2022 •

edited

Loading

easyCZ commented Jun 2, 2022 •

edited

Loading

easyCZ commented Jun 2, 2022 •

edited

Loading

jankeromnes left a comment •

edited

Loading