[usage] Add db.WorkspaceInstance model in golang

[easyCZ]

Description

Same as #10293 but for WorkspaceInstances.

Related Issue(s)

• Part of Define db models in Golang #10317
• Depends on [usage] Harden parsing of time from VarChar field #10390

How to test

Unit tests

Release Notes

NONE

Documentation

NONE

[easyCZ]

/hold

[geropl]

nit: one ID column is UUID, the other string: Why not make both strings? (so far we only have one column type for IDs: string) What's the advantange of UUID?

[easyCZ]

Workspace Instance ID is an actual UUID, but Workspace ID is something like org-repo-random-string which isn't a valid UUID

[easyCZ]

UUID allows you to parse UUIDs and validate before you even hit the DB. UUID is the more appropriate type as it's more specific. For example, it prevents you from inserting something like Workspace{ID: "my-random-string"} because it won't even compile

[geropl]

parse UUIDs and validate before you even hit the DB

Jup. My point was that it's the only point in the code that imposes that constraint, then. The only constraint we have so far is "equality".

Mentioning this to a) raise awareness and b) to think about how we see this DB layer. So far I thought about it as 100% follower of the primary implementation we have.

[easyCZ]

And it is. uuid.UUID serializes as a string. It's the same as using the UUID_COLUMN type in our TypeORM implementation.

https://github.com/gitpod-io/gitpod/blob/main/components/gitpod-db/src/typeorm/entity/db-workspace-instance.ts#L24

[geropl]

Ah! The UUID_COLUMN_TYPE is only there to ensure the width/type of the field is the same everywhere.

The key question is: does uuid.UUID influence the runtime behavior (e.g., introduces new error modes during parsing? If no I'm happy! 👍

[easyCZ]

It shouldn't, as long as what is stored in the DB is a valid UUID. I'm gonna run it against the RO replica of staging & prod to batch list all items to validate we don't have underlying violations to verify.

[geropl]

code looks good, tests are green! ✔️

/hold because of this question. I leave it up to you to handle. 🙏

[easyCZ]

/unhold

[easyCZ]

/hold

[easyCZ]

/unhold