Merge pull request #111 from cabinetoffice/NTRNL-529-update-endpoints…

…-for-the-github-additional-requests-page-to-match-the-new-structure

Ntrnl 529 update endpoints for the GitHub additional requests page to match the new structure

src/config/index.ts

@@ -51,7 +51,7 @@ export const TEAM_MEMBER = 'team-member';
 export const REPO = 'repo';
 export const COLLABORATOR = 'collaborator';
 export const CHECK_YOUR_REQUESTS = 'check-your-requests';
-export const ADDITIONAL_REQUESTS = 'additional-requests';
+export const ADDITIONAL_REQUEST = 'additional-request';
 export const ACCESSIBILITY_STATEMENT = 'accessibility-statement';
 export const COOKIES = 'cookies';
 export const CONTACT_US = 'contact-us';
@@ -68,7 +68,7 @@ export const TEAM_MEMBER_URL = '/team-member';
 export const REPO_URL = '/repo';
 export const COLLABORATOR_URL = '/collaborator';
 export const CHECK_YOUR_REQUESTS_URL = '/check-your-requests';
-export const ADDITIONAL_REQUESTS_URL = '/additional-requests';
+export const ADDITIONAL_REQUEST_URL = '/additional-request';
 export const ACCESSIBILITY_STATEMENT_URL = '/accessibility-statement';
 export const COOKIES_URL = '/cookies';
 export const CONTACT_US_URL = '/contact-us';

src/controller/additional-requests.controller.ts → src/controller/github/additional-request.controller.ts

@@ -7,24 +7,24 @@ import {
 } from '@co-digital/login';
 import { v4 as uuidv4 } from 'uuid';
 
-import * as config from '../config';
-import { log } from '../utils/logger';
+import * as config from '../../config';
+import { log } from '../../utils/logger';
 
-import { AdditionalRequests, AdditionalRequestsKey } from '../model/additional-requests.model';
-import { getPreviousPageUrl } from '../utils/getPreviousPageUrl';
+import { AdditionalRequest, AdditionalRequestKey } from '../../model/github/additional-request.model';
+import { getPreviousPageUrl } from '../../utils/getPreviousPageUrl';
 
 export const get = (_req: Request, res: Response) => {
-    return res.render(config.ADDITIONAL_REQUESTS);
+    return res.render(config.ADDITIONAL_REQUEST);
 };
 
 export const post = (req: Request, res: Response, next: NextFunction) => {
     try {
-        const additionalRequestsID = uuidv4();
+        const additionalRequestID = uuidv4();
         const context = req.body.context;
 
-        log.info(`Context: ${context}, Additional Requests ID: ${additionalRequestsID}`);
+        log.info(`Context: ${context}, Additional Request ID: ${additionalRequestID}`);
 
-        setApplicationDataKey(req.session, { ...req.body, [config.ID]: additionalRequestsID }, AdditionalRequestsKey);
+        setApplicationDataKey(req.session, { ...req.body, [config.ID]: additionalRequestID }, AdditionalRequestKey);
 
         return res.redirect(config.GITHUB_HOME_URL);
     } catch (err: any) {
@@ -35,12 +35,12 @@ export const post = (req: Request, res: Response, next: NextFunction) => {
 
 export const getById = (req: Request, res: Response, next: NextFunction) => {
     try {
-        const additionalRequestsID = req.params[config.ID];
-        const additionalRequestsData: AdditionalRequests = getApplicationDataByID(req.session, AdditionalRequestsKey, additionalRequestsID);
+        const additionalRequestID = req.params[config.ID];
+        const additionalRequestData: AdditionalRequest = getApplicationDataByID(req.session, AdditionalRequestKey, additionalRequestID);
 
-        log.info(`Context: ${additionalRequestsData.context}, Additional Requests ID: ${additionalRequestsID}`);
+        log.info(`Context: ${additionalRequestData.context}, Additional Request ID: ${additionalRequestID}`);
 
-        return res.render(config.ADDITIONAL_REQUESTS, { ...additionalRequestsData, [config.ID]: additionalRequestsID });
+        return res.render(config.ADDITIONAL_REQUEST, { ...additionalRequestData, [config.ID]: additionalRequestID });
     } catch (err: any) {
         log.errorRequest(req, err.message);
         next(err);
@@ -50,11 +50,11 @@ export const getById = (req: Request, res: Response, next: NextFunction) => {
 export const postById = (req: Request, res: Response, next: NextFunction) => {
     try {
         const context = req.body.context;
-        const additionalRequestsID = req.params[config.ID];
+        const additionalRequestID = req.params[config.ID];
 
-        log.info(`Context: ${context}, Additional Requests ID: ${additionalRequestsID}`);
+        log.info(`Context: ${context}, Additional Request ID: ${additionalRequestID}`);
 
-        setApplicationDataByID(req.session, { ...req.body, [config.ID]: additionalRequestsID }, AdditionalRequestsKey, additionalRequestsID);
+        setApplicationDataByID(req.session, { ...req.body, [config.ID]: additionalRequestID }, AdditionalRequestKey, additionalRequestID);
 
         return res.redirect(getPreviousPageUrl(req));
     } catch (err: any) {
@@ -65,9 +65,9 @@ export const postById = (req: Request, res: Response, next: NextFunction) => {
 
 export const removeById = (req: Request, res: Response, next: NextFunction) => {
     try {
-        log.info(`Additional Requests ID: ${req.params.id}`);
+        log.info(`Additional Request ID: ${req.params.id}`);
 
-        removeApplicationDataByID(req.session, AdditionalRequestsKey, req.params[config.ID]);
+        removeApplicationDataByID(req.session, AdditionalRequestKey, req.params[config.ID]);
 
         return res.redirect(config.GITHUB_HOME_URL);
     } catch (err: any) {

src/model/application.model.ts

@@ -2,7 +2,7 @@ import { Member } from './github/member.model';
 import { Team } from './github/team.model';
 import { Repo } from './github/repo.model';
 import { TeamMember } from './github/team-member.model';
-import { AdditionalRequests } from './additional-requests.model';
+import { AdditionalRequest } from './github/additional-request.model';
 import { Collaborator } from './github/collaborator.model';
 
 /*
@@ -15,6 +15,6 @@ export interface ApplicationData {
   repos?: Repo[]
   team_members?: TeamMember[]
   collaborators?: Collaborator[]
-  additional_requests?: AdditionalRequests[]
+  additional_requests?: AdditionalRequest[]
 }
 

src/model/github/additional-request.model.ts

@@ -0,0 +1,13 @@
+export const AdditionalRequestKey = 'additional_requests';
+
+export const AdditionalRequestMappingKeys: (keyof AdditionalRequest)[] = [
+    'id',
+    'context',
+    'description'
+];
+
+export interface AdditionalRequest {
+  id?: string;
+  context?: string;
+  description?: string;
+}

src/routes/github/additional-request.ts

@@ -0,0 +1,20 @@
+import { Router } from 'express';
+
+import { checkValidations } from '../../middleware/validation.middleware';
+import { authentication } from '../../middleware/authentication.middleware';
+import { additionalRequest as additionalRequestValidation } from '../../validation/github/additional-request.validation';
+
+import { get, post, getById, removeById, postById } from '../../controller/github/additional-request.controller';
+import * as config from '../../config';
+
+const additionalRequestRouter = Router();
+
+additionalRequestRouter.get(config.GITHUB_URL + config.CREATE + config.ADDITIONAL_REQUEST_URL, authentication, get);
+additionalRequestRouter.post(config.GITHUB_URL + config.CREATE + config.ADDITIONAL_REQUEST_URL, authentication, ...additionalRequestValidation, checkValidations, post);
+
+additionalRequestRouter.get(config.GITHUB_URL + config.REMOVE + config.ADDITIONAL_REQUEST_URL + config.PARAM_ID, authentication, removeById);
+
+additionalRequestRouter.get(config.GITHUB_URL + config.UPDATE + config.ADDITIONAL_REQUEST_URL + config.PARAM_ID, authentication, getById);
+additionalRequestRouter.post(config.GITHUB_URL + config.UPDATE + config.ADDITIONAL_REQUEST_URL + config.PARAM_ID, authentication, ...additionalRequestValidation, checkValidations, postById);
+
+export default additionalRequestRouter;

src/routes/index.ts

@@ -12,7 +12,7 @@ import teamRouter from './github/team';
 import teamMemberRouter from './github/team-member';
 import collaboratorRouter from './github/collaborator';
 import checkYourRequestsRouter from './check-your-requests';
-import additionalRequestsRouter from './additional-requests';
+import additionalRequestRouter from './github/additional-request';
 import accessibilityStatementRouter from './accessibility-statement';
 import cookiesRouter from './cookies';
 import contactUsRouter from './contact-us';
@@ -33,7 +33,7 @@ router.use(teamRouter);
 router.use(teamMemberRouter);
 router.use(collaboratorRouter);
 router.use(checkYourRequestsRouter);
-router.use(additionalRequestsRouter);
+router.use(additionalRequestRouter);
 router.use(accessibilityStatementRouter);
 router.use(cookiesRouter);
 router.use(contactUsRouter);

src/validation/github/additional-request.validation.ts

@@ -0,0 +1,7 @@
+import { body } from 'express-validator';
+import { descriptionRequiredValidation } from '../fields/description-required.validation';
+import { ErrorMessages } from '../error.messages';
+
+export const additionalRequest = [
+    body('context').notEmpty({ ignore_whitespace: true }).withMessage(ErrorMessages.CONTEXT), ...descriptionRequiredValidation
+];

src/views/additional-requests.html → src/views/additional-request.html

@@ -5,7 +5,7 @@
 {% endblock %}
 
 {% block pageContent %}
-  <h1 class="govuk-heading-l">Additional requests</h1>
+  <h1 class="govuk-heading-l">Additional request</h1>
 
   <p class="govuk-body">
     Make an additional request that is not covered by the other options. For example, removal requests or permission changes.

src/views/check-your-requests.html

@@ -34,7 +34,7 @@ <h2 class="govuk-heading-m">Collaborators details</h2>
   {% endif %}
   {% if (additional_requests and additional_requests.length > 0) %}
     <h2 class="govuk-heading-m">Additional Requests details</h2>
-    {% include "include/check-your-requests/additional-requests.html" %}
+    {% include "include/check-your-requests/additional-request.html" %}
     <br>
   {% endif %}
 

src/views/github-home.html

@@ -28,7 +28,7 @@ <h2 class="govuk-heading-m">Additional requests</h2>
   </p>
   <ul class="govuk-list govuk-list--bullet govuk-list--spaced">
     <li>
-      <a class="govuk-link" href="/additional-requests">Additional requests</a>
+      <a class="govuk-link" href="/github/create/additional-request">Additional request</a>
     </li>
   </ul>
 

src/views/include/check-your-requests/additional-requests.html → src/views/include/check-your-requests/additional-request.html

@@ -2,8 +2,8 @@
 
 {% for additional_request in additional_requests %}
 
-  {% set contextHref = "/additional-requests/" + additional_request.id + previousPageQueryParam + "#context" %}
-  {% set descriptionHref = "/additional-requests/" + additional_request.id + previousPageQueryParam + "#description" %}
+  {% set contextHref = "/github/update/additional-request/" + additional_request.id + previousPageQueryParam + "#context" %}
+  {% set descriptionHref = "/github/update/additional-request/" + additional_request.id + previousPageQueryParam + "#description" %}
 
   <br>
   {{ govukSummaryList({

src/views/include/list/added.html

@@ -30,5 +30,5 @@ <h2 class="govuk-heading-m">New collaborator requests</h2>
 {% endif %}
 {% if (additional_requests and additional_requests.length > 0) %}
   <h2 class="govuk-heading-m">Additional requests</h2>
-  {% include "include/list/additional-requests.html" %}
+  {% include "include/list/additional-request.html" %}
 {% endif %}

src/views/include/list/additional-request.html

@@ -0,0 +1,35 @@
+{% set additionalRequestSummaryData = [] %}
+
+{% for additional_request in additional_requests %}
+
+  {% set additionalRequestEditHref = "/github/update/additional-request/" + additional_request.id %}
+  {% set additionalRequestDeleteHref = "/github/remove/additional-request/" + additional_request.id %}
+
+  {% set additionalRequestSummaryData = (additionalRequestSummaryData.push({
+    key: { 
+      text: "Additional request context"
+    },
+    value: {
+      text: additional_request.context
+    },
+    actions: {
+      items: [
+        {
+          href: additionalRequestEditHref,
+          text: "Edit",
+          visuallyHiddenText: "Additional request context"
+        },
+        {
+          href: additionalRequestDeleteHref,
+          text: "Delete",
+          visuallyHiddenText: "Additional request context"
+        }
+      ]
+    }
+  }), additionalRequestSummaryData) %}
+
+{% endfor %}
+
+{{ govukSummaryList({
+  rows: additionalRequestSummaryData
+}) }}