220 services for bug reporting and feedback (#221)

* file dump init

* services for feedback

* /feedback/feedback is not a good route

* Update cd_dev.yaml

* stop if things are missing

* adding verify on main

* test results

* added docs and ES6 conversion

* what the Golden AI hell is adding imports from my docs?

Author: cubap

app.mjs

@@ -27,7 +27,10 @@ import lineRouter from './line/index.mjs'
 import userProfileRouter from './userProfile/index.mjs'
 import privateProfileRouter from './userProfile/privateProfile.mjs'
 import proxyRouter from './utilities/proxy.js'
-  
+
+// Beta Feedback routes
+import feedbackRouter from './feedback/feedbackRoutes.js'
+
 let app = express()
 
 //Middleware to use
@@ -65,6 +68,9 @@ app.use('/user', userProfileRouter)
 app.use('/my',  privateProfileRouter) 
 app.use('/proxy', proxyRouter)
 
+// Beta Feedback routes
+app.use('/beta', feedbackRouter)
+
 //catch 404 because of an invalid site path
 app.use('*', function(req, res, next) {
     let message = res.statusMessage ?? "This page does not exist"

feedback/feedbackController.js

@@ -0,0 +1,51 @@
+import { createGitHubIssue } from './githubService.js'
+import { respondWithError } from "../utilities/shared.mjs"
+
+/**
+ * 
+ * @param {user, body: page, feedback } req auth offers user and API is used with body: page:URL, feedback:String 
+ * @param {Response} res Express response object
+ * @description This function handles the submission of feedback from the user. It creates a GitHub issue with the feedback details.
+ * @returns 200 if feedback is submitted successfully, 204 if no feedback is provided, or an error response if the submission fails.
+ */
+export async function submitFeedback(req, res) {
+  const user = req.user ? `${req.user.profile.displayName} (${req.user._id})` : 'Anonymous'
+  const { page, feedback } = req.body
+
+  if (!feedback) {
+    return res.status(204).send()
+  }
+  try {
+    await createGitHubIssue('Feedback', `Feedback from ${user}`, `Page: ${page}\n\nFeedback: ${sanitizeUserInput(feedback)}`)
+    res.status(200).json({ message: 'Feedback submitted successfully' })
+  } catch (error) {
+    respondWithError(res, error.status ?? 500, error.message ?? 'Failed to submit feedback')
+  }
+}
+
+/**
+ * 
+ * @param {user, body: page, bugDescription } req auth offers user and API is used with body: page:URL, bugDescription:String 
+ * @param {Response} res Express response object
+ * @description This function handles the submission of bug reports from the user. It creates a GitHub issue with the bug details.
+ * @returns 200 if the bug report is submitted successfully, 204 if no bug description is provided, or an error response if the submission fails.
+ */
+export async function submitBug(req, res) {
+  const user = req.user ? `${req.user.profile.displayName} (${req.user._id})` : 'Anonymous'
+  const { page, bugDescription } = req.body
+
+  if (!bugDescription) {
+    return res.status(204).send()
+  }
+
+  try {
+    await createGitHubIssue('Bug Report', `Bug reported by ${user}`, `Page: ${page}\n\nBug: ${sanitizeUserInput(bugDescription)}`)
+    res.status(200).json({ message: 'Bug report submitted successfully' })
+  } catch (error) {
+    respondWithError(res, error.status ?? 500, error.message ??'Failed to submit bug report')
+  }
+}
+
+function sanitizeUserInput(input) {
+  return input.replace(/[^\w\s.,!?'"()-]/g, '')
+}

feedback/feedbackRoutes.js

@@ -0,0 +1,10 @@
+import express from 'express'
+import auth0Middleware from "../auth/index.mjs"
+import { submitFeedback, submitBug } from './feedbackController.js'
+
+const feedbackRouter = express.Router()
+
+feedbackRouter.route('/feedback').post(auth0Middleware(), submitFeedback)
+feedbackRouter.route('/bug').post(auth0Middleware(), submitBug)
+
+export default feedbackRouter

feedback/githubService.js

@@ -0,0 +1,23 @@
+export async function createGitHubIssue(label, title, body) {
+  const url = `https://api.github.com/repos/${process.env.REPO_OWNER}/${process.env.REPO_NAME}/issues`
+  const headers = {
+    Authorization: `token ${process.env.GITHUB_TOKEN}`,
+    Accept: 'application/vnd.github.v3+json',
+    'Content-Type': 'application/json'
+  }
+
+  const response = await fetch(url, {
+    method: 'POST',
+    headers,
+    body: JSON.stringify({
+      title,
+      body,
+      labels: [label]
+    })
+  })
+
+  if (!response.ok) {
+    const error = await response.json()
+    throw new Error(`GitHub API error: ${error.message}`)
+  }
+}

feedback/index.js

@@ -0,0 +1,40 @@
+import express from 'express'
+import bodyParser from 'body-parser'
+import { createGitHubIssue } from './githubService.js'
+
+const feedbackRouter = express.Router()
+feedbackRouter.use(bodyParser.json())
+
+// Endpoint for feedback form submissions
+feedbackRouter.post('/submit-feedback', async (req, res) => {
+  const { user, page, feedback } = req.body
+
+  if (!feedback) {
+    return res.status(400).json({ error: 'Feedback is required' })
+  }
+
+  try {
+    await createGitHubIssue('Feedback', `Feedback from ${user}`, `Page: ${page}\n\nFeedback: ${feedback}`)
+    res.status(200).json({ message: 'Feedback submitted successfully' })
+  } catch (error) {
+    res.status(500).json({ error: 'Failed to submit feedback' })
+  }
+})
+
+// Endpoint for bug report submissions
+feedbackRouter.post('/submit-bug', async (req, res) => {
+  const { user, page, bugDescription } = req.body
+
+  if (!bugDescription) {
+    return res.status(400).json({ error: 'Bug description is required' })
+  }
+
+  try {
+    await createGitHubIssue('Bug Report', `Bug reported by ${user}`, `Page: ${page}\n\nBug: ${bugDescription}`)
+    res.status(200).json({ message: 'Bug report submitted successfully' })
+  } catch (error) {
+    res.status(500).json({ error: 'Failed to submit bug report' })
+  }
+})
+
+export default feedbackRouter

utilities/mailer/index.mjs

@@ -36,12 +36,37 @@ export const sendMail = async (email, subject, message) => {
   htmlTemplate = htmlTemplate.replace("{{subject}}", subject)
   htmlTemplate = htmlTemplate.replace("{{messageBody}}", message)
 
+  // Stop execution if any of the required environment variables are not set
+  const requiredEnvVars = [
+    "SMTP_HOST",
+    "SMTP_PORT",
+    "TPEN_SUPPORT_EMAIL",
+    "TPEN_EMAIL_CC"
+  ]
+
+  requiredEnvVars.forEach(varName => {
+    if (!process.env[varName]) {
+      return {
+        status: 500,
+        message: `${varName} environment variable is not set.`
+      }
+    }
+  })
+
    try {
     const transporter = nodemailer.createTransport({
       host: process.env.SMTP_HOST,
       port: process.env.SMTP_PORT,
     })
 
+    transporter.verify((error, success) => {
+      if (error) {
+        console.log("Error in SMTP configuration: ", error)
+        return {status: 500, message: error.toString()}
+      }
+      console.log("Server is ready to take our messages")
+    })
+
     const mailOptions = {
       from: process.env.TPEN_SUPPORT_EMAIL,
       to: email,