From a0383b4d3a51a420c99616bb15af1816572dce9d Mon Sep 17 00:00:00 2001
From: Michael Quigley <michael@quigley.com>
Date: Tue, 4 Feb 2025 16:59:09 -0500
Subject: [PATCH] add description to 'frontends' (#834)

---
 controller/store/frontend.go                        | 13 +++++++------
 .../postgresql/031_v1_0_0_frontend_description.sql  |  3 +++
 .../sql/sqlite3/031_v1_0_0_frontend_description.sql |  3 +++
 3 files changed, 13 insertions(+), 6 deletions(-)
 create mode 100644 controller/store/sql/postgresql/031_v1_0_0_frontend_description.sql
 create mode 100644 controller/store/sql/sqlite3/031_v1_0_0_frontend_description.sql

diff --git a/controller/store/frontend.go b/controller/store/frontend.go
index 8086b4685..e24fa6851 100644
--- a/controller/store/frontend.go
+++ b/controller/store/frontend.go
@@ -15,27 +15,28 @@ type Frontend struct {
 	UrlTemplate    *string
 	Reserved       bool
 	PermissionMode PermissionMode
+	Description    *string
 }
 
 func (str *Store) CreateFrontend(envId int, f *Frontend, tx *sqlx.Tx) (int, error) {
-	stmt, err := tx.Prepare("insert into frontends (environment_id, private_share_id, token, z_id, public_name, url_template, reserved, permission_mode) values ($1, $2, $3, $4, $5, $6, $7, $8) returning id")
+	stmt, err := tx.Prepare("insert into frontends (environment_id, private_share_id, token, z_id, public_name, url_template, reserved, permission_mode, description) values ($1, $2, $3, $4, $5, $6, $7, $8, $9) returning id")
 	if err != nil {
 		return 0, errors.Wrap(err, "error preparing frontends insert statement")
 	}
 	var id int
-	if err := stmt.QueryRow(envId, f.PrivateShareId, f.Token, f.ZId, f.PublicName, f.UrlTemplate, f.Reserved, f.PermissionMode).Scan(&id); err != nil {
+	if err := stmt.QueryRow(envId, f.PrivateShareId, f.Token, f.ZId, f.PublicName, f.UrlTemplate, f.Reserved, f.PermissionMode, f.Description).Scan(&id); err != nil {
 		return 0, errors.Wrap(err, "error executing frontends insert statement")
 	}
 	return id, nil
 }
 
 func (str *Store) CreateGlobalFrontend(f *Frontend, tx *sqlx.Tx) (int, error) {
-	stmt, err := tx.Prepare("insert into frontends (token, z_id, public_name, url_template, reserved, permission_mode) values ($1, $2, $3, $4, $5, $6) returning id")
+	stmt, err := tx.Prepare("insert into frontends (token, z_id, public_name, url_template, reserved, permission_mode, description) values ($1, $2, $3, $4, $5, $6, $7) returning id")
 	if err != nil {
 		return 0, errors.Wrap(err, "error preparing global frontends insert statement")
 	}
 	var id int
-	if err := stmt.QueryRow(f.Token, f.ZId, f.PublicName, f.UrlTemplate, f.Reserved, f.PermissionMode).Scan(&id); err != nil {
+	if err := stmt.QueryRow(f.Token, f.ZId, f.PublicName, f.UrlTemplate, f.Reserved, f.PermissionMode, f.Description).Scan(&id); err != nil {
 		return 0, errors.Wrap(err, "error executing global frontends insert statement")
 	}
 	return id, nil
@@ -122,12 +123,12 @@ func (str *Store) FindFrontendsForPrivateShare(shrId int, tx *sqlx.Tx) ([]*Front
 }
 
 func (str *Store) UpdateFrontend(fe *Frontend, tx *sqlx.Tx) error {
-	sql := "update frontends set environment_id = $1, private_share_id = $2, token = $3, z_id = $4, public_name = $5, url_template = $6, reserved = $7, permission_mode = $8, updated_at = current_timestamp where id = $9"
+	sql := "update frontends set environment_id = $1, private_share_id = $2, token = $3, z_id = $4, public_name = $5, url_template = $6, reserved = $7, permission_mode = $8, description = $9, updated_at = current_timestamp where id = $10"
 	stmt, err := tx.Prepare(sql)
 	if err != nil {
 		return errors.Wrap(err, "error preparing frontends update statement")
 	}
-	_, err = stmt.Exec(fe.EnvironmentId, fe.PrivateShareId, fe.Token, fe.ZId, fe.PublicName, fe.UrlTemplate, fe.Reserved, fe.PermissionMode, fe.Id)
+	_, err = stmt.Exec(fe.EnvironmentId, fe.PrivateShareId, fe.Token, fe.ZId, fe.PublicName, fe.UrlTemplate, fe.Reserved, fe.PermissionMode, fe.Description, fe.Id)
 	if err != nil {
 		return errors.Wrap(err, "error executing frontends update statement")
 	}
diff --git a/controller/store/sql/postgresql/031_v1_0_0_frontend_description.sql b/controller/store/sql/postgresql/031_v1_0_0_frontend_description.sql
new file mode 100644
index 000000000..bd0ec6eff
--- /dev/null
+++ b/controller/store/sql/postgresql/031_v1_0_0_frontend_description.sql
@@ -0,0 +1,3 @@
+-- +migrate Up
+
+alter table frontends add column description text;
\ No newline at end of file
diff --git a/controller/store/sql/sqlite3/031_v1_0_0_frontend_description.sql b/controller/store/sql/sqlite3/031_v1_0_0_frontend_description.sql
new file mode 100644
index 000000000..bd0ec6eff
--- /dev/null
+++ b/controller/store/sql/sqlite3/031_v1_0_0_frontend_description.sql
@@ -0,0 +1,3 @@
+-- +migrate Up
+
+alter table frontends add column description text;
\ No newline at end of file