Dev (#308)

* update dev utils

* example pag

* typo fix and comments

* update api

* update

* update

* notes

* generate e2e data with serial ids

* test push

Author: danicc097

.golangci.yml

@@ -40,6 +40,8 @@ linters:
     - structcheck
     - unparam
     - wastedassign
+    # broken --fix for generated code
+    - tagalign
 
 linters-settings:
   errcheck:

.vscode/settings.json

@@ -4,8 +4,8 @@
   "go.lintFlags": [
     "--config=${workspaceFolder}/.golangci.yml",
     "--issues-exit-code=0",
-    // golangci possibly broke generated code skipping in recent releases
-    "--fix",
+    // golangci possibly broke generated code skipping in recent releases.
+    // "--fix",
     "--fast" // breaks some linters like errcheck, if its too slow then enable back
   ],
   "go.lintOnSave": "package",

bin/project

@@ -1866,8 +1866,7 @@ x.dev-utils.api-keys() {
 # to ease further updates to comments in migrations.
 x.dev-utils.show-column-comments() {
   local query="SELECT DISTINCT
-  c.relname as table,
-  a.attname::varchar AS column,
+  c.relname || '.' || a.attname AS column,
   COALESCE(col_description(format('%s.%s', n.nspname, c.relname)::regclass::oid, isc.ordinal_position), '') as column_comment
 FROM pg_attribute a
   JOIN ONLY pg_class c ON c.oid = a.attrelid
@@ -2903,7 +2902,7 @@ if [[ -n "$1" ]]; then
       err_code=$?
 
       if test -f "$failed_tool_build_marker"; then
-        echo "${YELLOW}[WARNING] At least one gen tool build failed. A gen rerun may be required"
+        err "At least one gen tool build failed. A gen rerun may be required"
       fi
 
       exit $err_code # do not quote

cmd/initial-data/e2e/models.go

@@ -1,12 +1,17 @@
 package e2e
 
-import "github.com/danicc097/openapi-go-gin-postgres-sqlc/internal/models"
+import (
+	"github.com/danicc097/openapi-go-gin-postgres-sqlc/internal/models"
+	"github.com/danicc097/openapi-go-gin-postgres-sqlc/internal/repos/postgresql/gen/db"
+)
 
 /*
  NOTE: tygo just looks the ast from the current package.
  All spec models available in tstype as `models` namespace
 */
 
+// User ids are uuids, therefore we can use any unique column for
+// e2e identifiers, which is also easier to reason about.
 type User struct {
 	Username  string        `json:"username"`
 	Email     string        `json:"email"`
@@ -16,7 +21,10 @@ type User struct {
 	Role      models.Role   `json:"role"      tstype:"models.Role"`
 }
 
+// TODO: should include ids for the rest of entities with serial ids,
+// given that e2e data will not be created concurrently.
 type Team struct {
+	TeamID      db.TeamID          `json:"teamID" tstype:"EntityIDs.TeamID"`
 	Name        string             `json:"name"`
 	ProjectName models.ProjectName `json:"projectName" tstype:"models.Project"`
 }

cmd/initial-data/main.go

@@ -200,21 +200,18 @@ func main() {
 	 **/
 	logger.Info("Creating activities...")
 
-	activity1, err := svc.Activity.Create(ctx, pool, &db.ActivityCreateParams{
-		ProjectID:    internal.ProjectIDByName[models.ProjectDemo],
+	activity1, err := svc.Activity.Create(ctx, pool, models.ProjectDemo, &db.ActivityCreateParams{
 		Name:         "Activity 1",
 		Description:  "Activity 1 description",
 		IsProductive: true,
 	})
 	handleError(err, activity1)
-	activity2, err := svc.Activity.Create(ctx, pool, &db.ActivityCreateParams{
-		ProjectID:   internal.ProjectIDByName[models.ProjectDemo],
+	activity2, err := svc.Activity.Create(ctx, pool, models.ProjectDemo, &db.ActivityCreateParams{
 		Name:        "Activity 2",
 		Description: "Activity 2 description",
 	})
 	handleError(err, activity2)
-	activity3, err := svc.Activity.Create(ctx, pool, &db.ActivityCreateParams{
-		ProjectID:   internal.ProjectIDByName[models.ProjectDemo],
+	activity3, err := svc.Activity.Create(ctx, pool, models.ProjectDemo, &db.ActivityCreateParams{
 		Name:        "Activity 3",
 		Description: "Activity 3 description",
 	})
@@ -459,8 +456,10 @@ func main() {
 						"uuid.NullUUID": "null | string /* uuid */",
 					},
 					// to import actual values from models package, do it explicitly
-					Frontmatter: `import type * as models from "client/gen/model";`,
-					OutputPath:  path.Join(e2eTestDataDir, "initial-data.ts"),
+					Frontmatter: `import type * as models from "client/gen/model";
+import type * as EntityIDs from "./entity-ids";
+`,
+					OutputPath: path.Join(e2eTestDataDir, "initial-data.ts"),
 				},
 			},
 		}
@@ -487,6 +486,7 @@ func main() {
 	tt := make([]e2e.Team, len(teams))
 	for i, t := range teams {
 		tt[i] = e2e.Team{
+			TeamID:      t.TeamID,
 			Name:        t.Name,
 			ProjectName: t.ProjectJoin.Name,
 		}

e2e/__tests__/data/entity-ids.ts

@@ -0,0 +1 @@
+../../../frontend/src/gen/entity-ids.ts

e2e/__tests__/data/initial-data.ts

@@ -1,8 +1,14 @@
 // Code generated by tygo. DO NOT EDIT.
 import type * as models from "client/gen/model";
+import type * as EntityIDs from "./entity-ids";
+
 //////////
 // source: models.go
 
+/**
+ * User ids are uuids, therefore we can use any unique column for
+ * e2e identifiers, which is also easier to reason about.
+ */
 export interface User {
   username: string;
   email: string;
@@ -11,7 +17,12 @@ export interface User {
   scopes: models.Scopes;
   role: models.Role;
 }
+/**
+ * TODO: should include ids for the rest of entities with serial ids,
+ * given that e2e data will not be created concurrently.
+ */
 export interface Team {
+  teamID: EntityIDs.TeamID;
   name: string;
   projectName: models.Project;
 }

e2e/__tests__/data/teams.json

@@ -1,13 +1,16 @@
 [
   {
+    "teamID": 1,
     "name": "Team 1",
     "projectName": "demo"
   },
   {
+    "teamID": 2,
     "name": "Team 2-1",
     "projectName": "demo_two"
   },
   {
+    "teamID": 3,
     "name": "Team 2-2",
     "projectName": "demo_two"
   }

e2e/client/gen/model/cacheDemoWorkItem.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+import type { CacheDemoWorkItemMetadata } from './cacheDemoWorkItemMetadata'
+
+export interface CacheDemoWorkItem {
+  closedAt?: Date | null
+  createdAt: Date
+  deletedAt?: Date | null
+  description: string
+  kanbanStepID: number
+  lastMessageAt: Date
+  line: string
+  metadata: CacheDemoWorkItemMetadata
+  ref: string
+  reopened: boolean
+  targetDate: Date
+  teamID: number
+  title: string
+  updatedAt: Date
+  workItemID: number
+  workItemTypeID: number
+}

e2e/client/gen/model/cacheDemoWorkItemMetadata.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+
+export type CacheDemoWorkItemMetadata = { [key: string]: unknown }