From 45c5c82905708ee391b3a1612b85fb48f64b30bd Mon Sep 17 00:00:00 2001
From: rxdn <29165304+rxdn@users.noreply.github.com>
Date: Thu, 21 Jul 2022 22:52:58 +0100
Subject: [PATCH] Integration descriptions

---
 .../api/integrations/createintegration.go     |  6 ++--
 .../api/integrations/getintegration.go        |  2 +-
 .../api/integrations/listintegrations.go      |  2 +-
 .../api/integrations/ownedintegrations.go     |  2 +-
 .../api/integrations/updateintegration.go     | 10 +++---
 .../src/components/IntegrationEditor.svelte   | 33 ++++++++++++++-----
 .../src/views/integrations/Activate.svelte    |  3 +-
 frontend/src/views/integrations/Manage.svelte |  3 +-
 go.mod                                        |  2 +-
 go.sum                                        |  2 ++
 utils/netutils.go                             | 10 ++++++
 11 files changed, 55 insertions(+), 20 deletions(-)

diff --git a/app/http/endpoints/api/integrations/createintegration.go b/app/http/endpoints/api/integrations/createintegration.go
index 21b6254..2a9819e 100644
--- a/app/http/endpoints/api/integrations/createintegration.go
+++ b/app/http/endpoints/api/integrations/createintegration.go
@@ -20,7 +20,8 @@ type integrationCreateBody struct {
 	WebhookUrl string `json:"webhook_url" validate:"required,webhook,max=255"`
 
 	Secrets []struct {
-		Name string `json:"name" validate:"required,min=1,max=32,excludesall=% "`
+		Name        string  `json:"name" validate:"required,min=1,max=32,excludesall=% "`
+		Description *string `json:"description" validate:"omitempty,max=255"`
 	} `json:"secrets" validate:"dive,omitempty,min=0,max=5"`
 
 	Headers []struct {
@@ -84,7 +85,8 @@ func CreateIntegrationHandler(ctx *gin.Context) {
 		secrets := make([]database.CustomIntegrationSecret, len(data.Secrets))
 		for i, secret := range data.Secrets {
 			secrets[i] = database.CustomIntegrationSecret{
-				Name: secret.Name,
+				Name:        secret.Name,
+				Description: secret.Description,
 			}
 		}
 
diff --git a/app/http/endpoints/api/integrations/getintegration.go b/app/http/endpoints/api/integrations/getintegration.go
index 837dce4..84b3dd4 100644
--- a/app/http/endpoints/api/integrations/getintegration.go
+++ b/app/http/endpoints/api/integrations/getintegration.go
@@ -88,7 +88,7 @@ func GetIntegrationHandler(ctx *gin.Context) {
 	ctx.JSON(200, integrationResponse{
 		Id:               integration.Id,
 		OwnerId:          integration.OwnerId,
-		WebhookHost:      utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", "")),
+		WebhookHost:      utils.SecondLevelDomain(utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", ""))),
 		Name:             integration.Name,
 		Description:      integration.Description,
 		ImageUrl:         integration.ImageUrl,
diff --git a/app/http/endpoints/api/integrations/listintegrations.go b/app/http/endpoints/api/integrations/listintegrations.go
index 360f135..f362ff7 100644
--- a/app/http/endpoints/api/integrations/listintegrations.go
+++ b/app/http/endpoints/api/integrations/listintegrations.go
@@ -56,7 +56,7 @@ func ListIntegrationsHandler(ctx *gin.Context) {
 			integrationResponse: integrationResponse{
 				Id:               integration.Id,
 				OwnerId:          integration.OwnerId,
-				WebhookHost:      utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", "")),
+				WebhookHost:      utils.SecondLevelDomain(utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", ""))),
 				Name:             integration.Name,
 				Description:      integration.Description,
 				ImageUrl:         integration.ImageUrl,
diff --git a/app/http/endpoints/api/integrations/ownedintegrations.go b/app/http/endpoints/api/integrations/ownedintegrations.go
index 9216558..3eec3db 100644
--- a/app/http/endpoints/api/integrations/ownedintegrations.go
+++ b/app/http/endpoints/api/integrations/ownedintegrations.go
@@ -57,7 +57,7 @@ func GetOwnedIntegrationsHandler(ctx *gin.Context) {
 			integrationResponse: integrationResponse{
 				Id:               integration.Id,
 				OwnerId:          integration.OwnerId,
-				WebhookHost:      utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", "")),
+				WebhookHost:      utils.SecondLevelDomain(utils.GetUrlHost(strings.ReplaceAll(integration.WebhookUrl, "%", ""))),
 				Name:             integration.Name,
 				Description:      integration.Description,
 				ImageUrl:         integration.ImageUrl,
diff --git a/app/http/endpoints/api/integrations/updateintegration.go b/app/http/endpoints/api/integrations/updateintegration.go
index aacbae5..3a40963 100644
--- a/app/http/endpoints/api/integrations/updateintegration.go
+++ b/app/http/endpoints/api/integrations/updateintegration.go
@@ -21,8 +21,9 @@ type integrationUpdateBody struct {
 	WebhookUrl string `json:"webhook_url" validate:"required,webhook,max=255"`
 
 	Secrets []struct {
-		Id   int    `json:"id" validate:"omitempty,min=1"`
-		Name string `json:"name" validate:"required,min=1,max=32,excludesall=% "`
+		Id          int     `json:"id" validate:"omitempty,min=1"`
+		Name        string  `json:"name" validate:"required,min=1,max=32,excludesall=% "`
+		Description *string `json:"description" validate:"omitempty,max=255"`
 	} `json:"secrets" validate:"dive,omitempty,min=0,max=5"`
 
 	Headers []struct {
@@ -254,8 +255,9 @@ func (b *integrationUpdateBody) updateSecrets(ctx *gin.Context, integrationId in
 	secrets := make([]database.CustomIntegrationSecret, len(b.Secrets))
 	for i, secret := range b.Secrets {
 		secrets[i] = database.CustomIntegrationSecret{
-			Id:   secret.Id,
-			Name: secret.Name,
+			Id:          secret.Id,
+			Name:        secret.Name,
+			Description: secret.Description,
 		}
 	}
 
diff --git a/frontend/src/components/IntegrationEditor.svelte b/frontend/src/components/IntegrationEditor.svelte
index 3b887aa..80738ce 100644
--- a/frontend/src/components/IntegrationEditor.svelte
+++ b/frontend/src/components/IntegrationEditor.svelte
@@ -105,17 +105,26 @@
 
                   <div class="col">
                     {#each data.secrets as secret, i}
-                      <div class="row">
-                        {#if i === 0}
-                          <Input col1 label="Secret Name" placeholder="api_key" bind:value={secret.name}/>
-                          <div class="button-anchor">
-                            <Button danger iconOnly icon="fas fa-trash-can" on:click={() => deleteSecret(i)}/>
-                          </div>
-                        {:else}
-                          <Input col1 placeholder="api_key" bind:value={secret.name}/>
+                      <div class="col">
+                        <div class="row">
+                          {#if i === 0}
+                            <Input col1 label="Secret Name" placeholder="api_key" bind:value={secret.name}/>
+                          {:else}
+                            <Input col1 placeholder="api_key" bind:value={secret.name}/>
+                          {/if}
+
                           <div class="button-anchor">
                             <Button danger iconOnly icon="fas fa-trash-can" on:click={() => deleteSecret(i)}/>
                           </div>
+                        </div>
+
+                        <div class="row">
+                          <Textarea col1 minHeight="60px" label="Description" bind:value={secret.description}
+                                    placeholder="Tell users what value to enter for this secret, in up to 255 characters"/>
+                        </div>
+
+                        {#if i !== data.secrets.length - 1}
+                          <hr/>
                         {/if}
                       </div>
                     {/each}
@@ -488,6 +497,14 @@
         row-gap: 1vh;
     }
 
+    hr {
+        border-top: 1px solid #777;
+        border-bottom: 0;
+        border-left: 0;
+        border-right: 0;
+        width: 100%;
+    }
+
     @media only screen and (max-width: 950px) {
         .outer-row {
             flex-direction: column;
diff --git a/frontend/src/views/integrations/Activate.svelte b/frontend/src/views/integrations/Activate.svelte
index 7e0e7aa..50e3651 100644
--- a/frontend/src/views/integrations/Activate.svelte
+++ b/frontend/src/views/integrations/Activate.svelte
@@ -16,7 +16,8 @@
               <div class="secret-container">
                 {#each integration.secrets as secret}
                   <div class="secret-input">
-                    <Input col1 label="{secret.name}" placeholder="{secret.name}" bind:value={secretValues[secret.name]}/>
+                    <Input label="{secret.name}" placeholder="{secret.name}" bind:value={secretValues[secret.name]}/>
+                    <p>{secret.description}</p>
                   </div>
                 {/each}
               </div>
diff --git a/frontend/src/views/integrations/Manage.svelte b/frontend/src/views/integrations/Manage.svelte
index 0486a71..6ec7c82 100644
--- a/frontend/src/views/integrations/Manage.svelte
+++ b/frontend/src/views/integrations/Manage.svelte
@@ -19,7 +19,8 @@
               <div class="secret-container">
                 {#each integration.secrets as secret}
                   <div class="secret-input">
-                    <Input col1 label="{secret.name}" placeholder="{secret.name}" bind:value={secretValues[secret.name]}/>
+                    <Input label="{secret.name}" placeholder="{secret.name}" bind:value={secretValues[secret.name]}/>
+                    <p>{secret.description}</p>
                   </div>
                 {/each}
               </div>
diff --git a/go.mod b/go.mod
index 30129e9..02bbef8 100644
--- a/go.mod
+++ b/go.mod
@@ -6,7 +6,7 @@ require (
 	github.com/BurntSushi/toml v0.3.1
 	github.com/TicketsBot/archiverclient v0.0.0-20220326163414-558fd52746dc
 	github.com/TicketsBot/common v0.0.0-20220703211704-f792aa9f0c42
-	github.com/TicketsBot/database v0.0.0-20220712212403-61804b8beb18
+	github.com/TicketsBot/database v0.0.0-20220721214509-131e86b1a06c
 	github.com/TicketsBot/logarchiver v0.0.0-20220326162808-cdf0310f5e1c
 	github.com/TicketsBot/worker v0.0.0-20220710121124-cd5ec72739f9
 	github.com/apex/log v1.1.2
diff --git a/go.sum b/go.sum
index c4ae1d7..6cd55db 100644
--- a/go.sum
+++ b/go.sum
@@ -7,6 +7,8 @@ github.com/TicketsBot/common v0.0.0-20220703211704-f792aa9f0c42 h1:3/qnbrEfL8gqS
 github.com/TicketsBot/common v0.0.0-20220703211704-f792aa9f0c42/go.mod h1:WxHh6bY7KhIqdayeOp5f0Zj2NNi/7QqCQfMEqHnpdAM=
 github.com/TicketsBot/database v0.0.0-20220712212403-61804b8beb18 h1:p3rr325yK5CqWQMBML1SzkC+mXx+SSaBq4PnyxeBYXA=
 github.com/TicketsBot/database v0.0.0-20220712212403-61804b8beb18/go.mod h1:F57cywrZsnper1cy56Bx0c/HEsxQBLHz3Pl98WXblWw=
+github.com/TicketsBot/database v0.0.0-20220721214509-131e86b1a06c h1:eyAFQuKihRkfkSNg1xeIm9nHQZ1z2Qg46kS7LcLZNxk=
+github.com/TicketsBot/database v0.0.0-20220721214509-131e86b1a06c/go.mod h1:F57cywrZsnper1cy56Bx0c/HEsxQBLHz3Pl98WXblWw=
 github.com/TicketsBot/logarchiver v0.0.0-20220326162808-cdf0310f5e1c h1:OqGjFH6mbE6gd+NqI2ARJdtH3UUvhiAkD0r0fhGJK2s=
 github.com/TicketsBot/logarchiver v0.0.0-20220326162808-cdf0310f5e1c/go.mod h1:jgi2OXQKsd5nUnTIRkwvPmeuD/i7OhN68LKMssuQY1c=
 github.com/TicketsBot/ttlcache v1.6.1-0.20200405150101-acc18e37b261 h1:NHD5GB6cjlkpZFjC76Yli2S63/J2nhr8MuE6KlYJpQM=
diff --git a/utils/netutils.go b/utils/netutils.go
index b0aa6ca..72e3790 100644
--- a/utils/netutils.go
+++ b/utils/netutils.go
@@ -2,6 +2,7 @@ package utils
 
 import (
 	"net/url"
+	"strings"
 )
 
 func GetUrlHost(rawUrl string) string {
@@ -12,3 +13,12 @@ func GetUrlHost(rawUrl string) string {
 
 	return parsed.Hostname()
 }
+
+func SecondLevelDomain(domain string) string {
+	split := strings.Split(strings.TrimRight(domain, "."), ".")
+	if len(split) > 2 {
+		return strings.Join(split[len(split)-2:len(split)], ".")
+	} else {
+		return strings.Join(split, ".")
+	}
+}