feat: request to unpublish and cancel requests

fixes #105

Author: marisademeglio

src/emails.js

@@ -91,11 +91,11 @@ If it was not you, then please disregard this message.</p>
 };
 
 let newRequest = {
-        subject: 'New request to publish results on epubtest.org',
+        subject: 'New request on epubtest.org',
         text: answerSet => `
 Hello,
 
-Someone has requested to publish results for ${answerSet.testingEnvironment.readingSystem.name} ${answerSet.testingEnvironment.readingSystem.version} 
+Someone has requested to publish or unpublish results for ${answerSet.testingEnvironment.readingSystem.name} ${answerSet.testingEnvironment.readingSystem.version} 
 on epubtest.org. Please login and go to https://epubtest.org/admin/requests to manage and approve pending requests.
 
 - epubtest.org

src/pages/css/forms.css

@@ -44,3 +44,7 @@ button:hover, input[type=submit]:hover {
     gap: 0.5rem;
 }
 
+/* very specific and brittle selector but i don't want to inadvertently affect other forms */
+form[action='/forms/login'] {
+    gap: 1rem;
+}

src/pages/templates/admin/requests.njk

@@ -18,6 +18,7 @@
                     <th>Testing environment</th>
                     <th>Date requested</th>
                     <th>User</th>
+                    <th>Request type</th>
                     <th>Actions</th>
                 </tr>
             </thead>
@@ -28,6 +29,7 @@
                     <td>{{ testingEnvironmentLabels.TestingEnvironmentLink(request.answerSet.testingEnvironment) }}</td>
                     <td>{{ dayjs(request.created).format("YYYY-MM-DD HH:mm:ss") }}</td>
                     <td>{{ request.answerSet.user.name }}</td>
+                    <td>{%- if request.reqType == 'PUBLISH' -%}Publish{%- else -%}Unpublish{%- endif -%}</td>
                     <td>
                         <form method="POST" action="/admin/forms/handle-request" style="gap: .5rem;">
                             <input type="hidden" name="requestId" value="{{request.id}}"></input>

src/pages/templates/admin/testing-environment.njk

@@ -102,13 +102,13 @@
                     <th>Score</th>
                     <th>Edit</th>
                     <th>Status</th>
-                    <th>Publishing requested</th>
+                    <th>Request</th>
                     <th>Share</th>
                 </tr>
             </thead>
             <tbody>
             {%- for answerSet in testingEnvironment.answerSets -%}
-            {%- set requestToPublish=getRequestToPublish(answerSet.id) -%}
+            
             {%- set answerSetStatus = displayUtils.answerSetCompletedStatus(answerSet) -%}
             <tr id="{{answerSet.testBook.topic.id}}-{{answerSet.testBook.version}}">
                 <td>{{answerSet.id}}</td>
@@ -170,10 +170,14 @@
                     {%- endif -%}
                 </td>
                 <td>
-                    {%- if requestsToPublish[answerSet.id] -%}
-                    Yes
+                    {%- if publishRequests[answerSet.id] -%}
+                    {%- if publishRequests[answerSet.id].type == 'PUBLISH' -%}
+                        Request to publish
+                    {%- else -%}
+                        Request to unpublish
+                    {%- endif -%})
                     {%- else -%}
-                    No
+                    No request
                     {%- endif -%}
                 </td>
                 <td>

src/pages/templates/dashboard-details.njk

@@ -92,14 +92,28 @@
                     {%- if answerSet.isPublic -%}
                     <a href="/results/{{testingEnvironment.id}}#{{answerSet.testBook.topic.id}}">Published</a>
                     {%- else -%}
-                        {%- if getRequestToPublish(answerSet.id) -%}
-                        <span>Request pending</span>
-                        {%- else -%}
-                        <form method="POST" action="/user/forms/request-to-publish">
+                    Unpublished
+                    {%- endif -%}
+                    {%- if getPublishRequest(answerSet.id) -%}
+                    <span>Request to {%- if getPublishRequest(answerSet.id).type == 'PUBLISH' %} publish {% else %} unpublish {%- endif %}
+                            submitted</span>
+                        <form method="POST" action="/user/forms/cancel-request">
                             <input type="hidden" name="answerSetId" value="{{answerSet.id}}"/>
-                            <input type="submit" name="submit" value="Request to publish"/>
+                            <input type="hidden" name="testEnvId" value="{{answerSet.testingEnvironment.id}}"/>
+                            <input type="submit" name="submit" value="Cancel request"/>
                         </form>
+                    {%- else -%}
+                    <form method="POST" action="/user/forms/request">
+                        <input type="hidden" name="answerSetId" value="{{answerSet.id}}"/>
+                        <input type="hidden" name="testEnvId" value="{{answerSet.testingEnvironment.id}}"/>
+                        {%- if answerSet.isPublic -%}
+                        <input type="submit" name="submit" value="Request to unpublish"/>
+                        <input type="hidden" name="requestType" value="UNPUBLISH"/>
+                        {%- else -%}
+                        <input type="submit" name="submit" value="Request to publish"/>
+                        <input type="hidden" name="requestType" value="PUBLISH"/>
                         {%- endif -%}
+                    </form>
                     {%- endif -%}
                 {%- endif -%}
                 <td>

src/queries/requests.js

@@ -12,6 +12,7 @@ import * as answerSets from './answerSets.js';
 const FIELDS = () => `
 id
 created
+reqType
 answerSet {
     ${answerSets.FIELDS()}
 }`;

src/routes/admin-forms.js

@@ -104,6 +104,30 @@ router.post('/unpublish', async (req, res, next) => {
         return next(err);
     }
 
+    // also clear any requests for unpublishing that this answer set might have had
+    dbres = await db.query(
+        Q.REQUESTS.GET_FOR_ANSWERSETS(), 
+        { ids: [parseInt(req.body.answerSetId)]},
+        req.cookies.jwt
+    );
+
+    if (!dbres.success) {
+        let err = new Error("Could not get requests.");
+        return next(err);
+    }
+
+    if (dbres.data && dbres.data.requests.length > 0) {
+        dbres = await db.query(Q.REQUESTS.DELETE(), 
+            { id: dbres.data.requests[0].id },
+            req.cookies.jwt);
+        
+        if (!dbres.success) {
+            let err = new Error("Could not delete request to unpublish.");
+            return next(err);
+        }
+    }
+
+
     let nextUrl = req.body.next ?? `/admin/testing-environment/${req.body.testingEnvironmentId}`
     return res.redirect(nextUrl);
 });

src/routes/admin.js

@@ -84,23 +84,19 @@ router.get('/testing-environment/:id', async (req, res, next) => {
         return next(err);
     }
     let requests = dbres.data.requests;
-    let requestsToPublish = {};
+    let publishRequests = {};
     testingEnvironment.answerSets.map(aset => {
         let foundRequest = requests.find(r => r.answerSet.id == aset.id);
         if (foundRequest) {
-            requestsToPublish[aset.id] = foundRequest;
+            publishRequests[aset.id] = foundRequest;
         }
     });
 
     return res.render('admin/testing-environment.njk', 
         {
             testingEnvironment,
             users,
-            requestsToPublish,
-            getRequestToPublish: answerSetId => {
-                let retval = requests.find(r => r.answerSet.id === answerSetId);
-                return retval;
-            },
+            publishRequests,
             displayUtils
         }
     );

src/routes/user-forms.js

@@ -11,19 +11,19 @@ const { validator, validationResult, body } = expressValidator;
 const router = express.Router()
 
 // submit request to publish
-router.post('/request-to-publish', async (req, res, next) => {
+router.post('/request', async (req, res, next) => {
     let dbres = await db.query(
         Q.REQUESTS.CREATE(),  
         { 
             input: {
                 answerSetId: parseInt(req.body.answerSetId),
-                type: 'PUBLISH'
+                reqType: req.body.requestType
             }
         }, 
         req.cookies.jwt);
 
     if (!dbres.success) {
-        let err = new Error("Could not create request to publish");
+        let err = new Error("Could not create request to publish/unpublish");
         return next(err);
     }
 
@@ -43,7 +43,30 @@ router.post('/request-to-publish', async (req, res, next) => {
         emails.newRequest.subject, 
         emails.newRequest.text(dbres.data.answerSet), 
         emails.newRequest.html(dbres.data.answerSet));   
-    res.redirect('/user/dashboard');
+    res.redirect(`/user/dashboard/testing/${dbres.data.answerSet.testingEnvironment.id}`);
+});
+router.post('/cancel-request', async (req, res, next) => {
+    let dbres = await db.query(
+        Q.REQUESTS.GET_FOR_ANSWERSETS(), 
+        { ids: [parseInt(req.body.answerSetId)]},
+        req.cookies.jwt
+    );
+
+    if (!dbres.success || dbres.data.requests.length < 1) {
+        let err = new Error("Could not get requests.");
+        return next(err);
+    }
+
+    dbres = await db.query(
+        Q.REQUESTS.DELETE(),  
+        { id: dbres.data.requests[0].id},
+        req.cookies.jwt);
+    
+    if (!dbres.success) {
+        let err = new Error("Could not cancel request");
+        return next(err);
+    }
+    res.redirect(`/user/dashboard/testing/${req.body.testEnvId}`);
 });
 
 // submit results

src/routes/user.js

@@ -48,7 +48,7 @@ router.get('/dashboard/testing/:testingEnvironmentId', async (req, res, next) =>
     return res.render('dashboard-details.njk', 
         {
             testingEnvironment,
-            getRequestToPublish: answerSetId => {
+            getPublishRequest: answerSetId => {
                 let retval = requests.find(r => r.answerSet.id === answerSetId);
                 return retval;
             },