From 0b8a143a63ca39639d5fcb89e02b69665f45e39c Mon Sep 17 00:00:00 2001
From: "Lin, Hung-Shin" <wancat@wancat.cc>
Date: Fri, 3 Nov 2023 21:32:12 +0800
Subject: [PATCH] feat: put survey and bug report url to backend (#57)

* feat: put survey and bug report url to backend

* fix: centralize hardcoded url to config

* fix: validate url before redirecting
---
 app/src/components/CompleteModal.vue  |  5 ++---
 app/src/components/GameHeaderPart.vue |  3 +--
 app/src/config.js                     |  7 +++++++
 docker-compose.prod.yml               |  2 ++
 docker-compose.testing.yml            |  2 ++
 docker-compose.yml                    |  2 ++
 server/src/api/routes/index.js        | 16 ++++++++++++++++
 server/src/config.js                  | 10 ++++++++++
 8 files changed, 42 insertions(+), 5 deletions(-)
 create mode 100644 app/src/config.js

diff --git a/app/src/components/CompleteModal.vue b/app/src/components/CompleteModal.vue
index 5ae5e1f..404cfd8 100644
--- a/app/src/components/CompleteModal.vue
+++ b/app/src/components/CompleteModal.vue
@@ -1,7 +1,6 @@
 <script setup>
 import { ref } from 'vue'
-
-const SURVEY_URL = 'https://www.surveycake.com/s/z67xG'
+import { surveyUrl } from '../config'
 
 const showModal = ref(true) // Controls whether the modal is visible or not
 
@@ -27,7 +26,7 @@ setTimeout(() => {
         如果您能撥冗填寫這份問卷，我們將不勝感激，這對我們非常重要！
       </p>
       <a
-        :href="SURVEY_URL"
+        :href="surveyUrl"
         target="_blank"
         class="inline-flex justify-center rounded-lg text-base font-black py-2 mt-3 bg-text-primary w-full"
         >填寫問卷</a
diff --git a/app/src/components/GameHeaderPart.vue b/app/src/components/GameHeaderPart.vue
index c7dcced..093047f 100644
--- a/app/src/components/GameHeaderPart.vue
+++ b/app/src/components/GameHeaderPart.vue
@@ -2,6 +2,7 @@
 import { onMounted, ref } from 'vue'
 import { useRouter } from 'vue-router'
 import { logout } from '../utils/auth'
+import { bugReportUrl } from '../config'
 import api from '../utils/api'
 
 const router = useRouter()
@@ -11,8 +12,6 @@ const handleLogout = async () => {
   router.push({ name: 'login' })
 }
 
-const bugReportUrl = 'https://www.surveycake.com/s/gOreA'
-
 const questData = ref(null)
 const questErr = ref(null)
 
diff --git a/app/src/config.js b/app/src/config.js
new file mode 100644
index 0000000..2c6d374
--- /dev/null
+++ b/app/src/config.js
@@ -0,0 +1,7 @@
+export const surveyUrl = '/api/v1/survey'
+export const bugReportUrl = '/api/v1/bug-report'
+
+export default {
+  surveyUrl,
+  bugReportUrl,
+}
diff --git a/docker-compose.prod.yml b/docker-compose.prod.yml
index 07a1ac2..4af7bf6 100644
--- a/docker-compose.prod.yml
+++ b/docker-compose.prod.yml
@@ -70,6 +70,8 @@ services:
       - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
       - GITHUB_CLIENT_ID=${GITHUB_CLIENT_ID}
       - GITHUB_CLIENT_SECRET=${GITHUB_CLIENT_SECRET}
+      - SURVEY_URL=${SURVEY_URL}
+      - BUG_REPORT_URL=${BUG_REPORT_URL}
 
   base:
     image: lancatlin/linux-odyssey:base
diff --git a/docker-compose.testing.yml b/docker-compose.testing.yml
index 6c08595..44393c3 100644
--- a/docker-compose.testing.yml
+++ b/docker-compose.testing.yml
@@ -50,6 +50,8 @@ services:
       - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
       - GITHUB_CLIENT_ID=${GITHUB_CLIENT_ID}
       - GITHUB_CLIENT_SECRET=${GITHUB_CLIENT_SECRET}
+      - SURVEY_URL=${SURVEY_URL}
+      - BUG_REPORT_URL=${BUG_REPORT_URL}
 
   db-test:
     image: mongo
diff --git a/docker-compose.yml b/docker-compose.yml
index 5697961..b2b3e9f 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -38,6 +38,8 @@ services:
       - DOCKER_NETWORK=linux-odyssey-players
       - SECRET_KEY=b1d2e917-17b9-4fce-9055-082dee6ec5d6 # Only for testing
       - TRUSTED_PROXIES=${TRUSTED_PROXIES}
+      - SURVEY_URL=${SURVEY_URL}
+      - BUG_REPORT_URL=${BUG_REPORT_URL}
       - HOST_PWD=${PWD}
       - GOOGLE_CLIENT_ID=${GOOGLE_CLIENT_ID}
       - GOOGLE_CLIENT_SECRET=${GOOGLE_CLIENT_SECRET}
diff --git a/server/src/api/routes/index.js b/server/src/api/routes/index.js
index 4fc5a87..aea4d31 100644
--- a/server/src/api/routes/index.js
+++ b/server/src/api/routes/index.js
@@ -30,4 +30,20 @@ router.use(
   commands
 )
 
+router.get('/survey', (req, res) => {
+  if (!config.surveyUrl) {
+    res.status(404).send('Survey not configured')
+    return
+  }
+  res.redirect(config.surveyUrl)
+})
+
+router.get('/bug-report', (req, res) => {
+  if (!config.bugReportUrl) {
+    res.status(404).send('Bug report not configured')
+    return
+  }
+  res.redirect(config.bugReportUrl)
+})
+
 export default router
diff --git a/server/src/config.js b/server/src/config.js
index 78ae76a..75f43d8 100644
--- a/server/src/config.js
+++ b/server/src/config.js
@@ -11,6 +11,14 @@ function getTrustProxies(key) {
     .filter((p) => validator.isIPRange(p) || validator.isIP(p))
 }
 
+function getUrl(key) {
+  const url = get(key, '')
+  if (validator.isURL(url)) {
+    return validator.trim(url)
+  }
+  return ''
+}
+
 const config = {
   host: get('HOST', 'localhost'),
   port: get('PORT', 3000),
@@ -30,6 +38,8 @@ const config = {
     clientSecret: get('GITHUB_CLIENT_SECRET', ''),
   },
   trustedProxies: getTrustProxies('TRUSTED_PROXIES'),
+  surveyUrl: getUrl('SURVEY_URL', ''),
+  bugReportUrl: getUrl('BUG_REPORT_URL', ''),
 }
 
 config.baseUrl = get('BASE_URL', `http://${config.host}:${config.port}`)