move document urls outside the feature disable pages toggle. (#3717)

* move document urls outside the feature disable pages toggle.

* fix importing folder

* update yarn-audit-known-issues

* clean up importing document paths + move tests

* clean up

* clean up (2)

* clean up

* sonar ignore

Author: velimd

src/main/app.ts

@@ -16,6 +16,7 @@ import { Nunjucks } from 'modules/nunjucks'
 import * as moment from 'moment'
 import { Feature as EligibilityFeature } from 'eligibility/index'
 import { Feature as ClaimIssueFeature } from 'claim/index'
+import { Feature as ClaimDocumentsFeature } from 'claim-documents/index'
 import { Feature as DefendantFirstContactFeature } from 'first-contact/index'
 import { Feature as DefendantResponseFeature } from 'response/index'
 import { Feature as SettlementAgreementFeature } from 'settlement-agreement/index'
@@ -96,6 +97,9 @@ if (env !== 'mocha') {
 logger.info('Loading DashboardFeature')
 new DashboardFeature().enableFor(app)
 
+logger.info('Loading ClaimDocumentsFeature')
+new ClaimDocumentsFeature().enableFor(app)
+
 if (!FeatureToggles.isEnabled('disablePages')) {
   logger.info('Loading EligibilityFeature')
   new EligibilityFeature().enableFor(app)

src/main/features/claim-documents/index.ts

@@ -0,0 +1,31 @@
+import * as express from 'express'
+import * as path from 'path'
+
+import { Paths } from 'claim-documents/paths'
+
+import { RouterFinder } from 'shared/router/routerFinder'
+import { OAuthHelper } from 'idam/oAuthHelper'
+import { AuthorizationMiddleware } from 'idam/authorizationMiddleware'
+
+export function claimIssueRequestHandler (): express.RequestHandler {
+  function accessDeniedCallback (req: express.Request, res: express.Response): void {
+    res.redirect(OAuthHelper.forLogin(req, res))
+  }
+
+  const requiredRoles = [
+    'citizen'
+  ]
+  const unprotectedPaths = []
+  return AuthorizationMiddleware.requestHandler(requiredRoles, accessDeniedCallback, unprotectedPaths)
+}
+
+export class Feature {
+  enableFor (app: express.Express) {
+    if (app.settings.nunjucksEnv && app.settings.nunjucksEnv.globals) {
+      app.settings.nunjucksEnv.globals.ClaimDocumentsPaths = Paths
+    }
+
+    app.all('/claim/*', claimIssueRequestHandler())
+    app.use('/', RouterFinder.findAll(path.join(__dirname, 'routes')))
+  }
+}

src/main/features/claim-documents/paths.ts

@@ -0,0 +1,7 @@
+import { RoutablePath } from 'shared/router/routablePath'
+
+export class Paths {
+  static readonly receiptReceiver = new RoutablePath('/claim/:externalId/receipt')
+  static readonly sealedClaimPdfReceiver = new RoutablePath('/claim/:externalId/sealed-claim')
+  static readonly documentPage = new RoutablePath('/claim/:externalId/document/:documentURI')
+}

src/main/features/claim/routes/document.ts renamed to src/main/features/claim-documents/routes/document.ts

@@ -1,5 +1,5 @@
 import * as express from 'express'
-import { Paths } from 'claim/paths'
+import { Paths } from 'claim-documents/paths'
 
 import { Claim } from 'claims/models/claim'
 import { ClaimMiddleware } from 'claims/claimMiddleware'
@@ -16,7 +16,7 @@ const documentsClient: DocumentsClient = new DocumentsClient()
 const scannedDocumentsClient: ScannedDocumentsClient = new ScannedDocumentsClient()
 
 function getDocumentPath (path: string): string {
-  return path.match(`[^\/]+$`)[0]
+  return path.match(`[^\/]+$`)[0]// NOSONAR
 }
 /* tslint:disable:no-default-export */
 export default express.Router()

src/main/features/claim-documents/routes/receipt.ts

@@ -0,0 +1,23 @@
+import * as express from 'express'
+import { Paths } from 'claim-documents/paths'
+
+import { Claim } from 'claims/models/claim'
+import { ClaimMiddleware } from 'claims/claimMiddleware'
+import { DocumentsClient } from 'documents/documentsClient'
+
+import { ErrorHandling } from 'shared/errorHandling'
+
+import { DownloadUtils } from 'utils/downloadUtils'
+
+const documentsClient: DocumentsClient = new DocumentsClient()
+
+/* tslint:disable:no-default-export */
+export default express.Router()
+  .get(Paths.receiptReceiver.uri,
+    ClaimMiddleware.retrieveByExternalId,
+    ErrorHandling.apply(async (req: express.Request, res: express.Response): Promise<void> => {
+      const claim: Claim = res.locals.claim
+
+      const pdf: Buffer = await documentsClient.getClaimIssueReceiptPDF(claim.externalId, res.locals.user.bearerToken)
+      DownloadUtils.downloadPDF(res, pdf, `${claim.claimNumber}-claim-form-claimant-copy`)
+    }))

src/main/features/claim/routes/sealed-claim.ts renamed to src/main/features/claim-documents/routes/sealed-claim.ts

@@ -1,5 +1,5 @@
 import * as express from 'express'
-import { Paths } from 'claim/paths'
+import { Paths } from 'claim-documents/paths'
 
 import { ErrorHandling } from 'shared/errorHandling'
 import { ClaimMiddleware } from 'claims/claimMiddleware'

src/main/features/claim/index.ts

@@ -3,33 +3,20 @@ import * as path from 'path'
 
 import { Paths } from 'claim/paths'
 
-import { AuthorizationMiddleware } from 'idam/authorizationMiddleware'
 import { ClaimEligibilityGuard } from 'claim/guards/claimEligibilityGuard'
 import { RouterFinder } from 'shared/router/routerFinder'
 import { DraftMiddleware } from '@hmcts/cmc-draft-store-middleware'
 import { DraftService } from 'services/draftService'
 import { DraftClaim } from 'drafts/models/draftClaim'
-import { OAuthHelper } from 'idam/oAuthHelper'
-
-function claimIssueRequestHandler (): express.RequestHandler {
-  function accessDeniedCallback (req: express.Request, res: express.Response): void {
-    res.redirect(OAuthHelper.forLogin(req, res))
-  }
-
-  const requiredRoles = [
-    'citizen'
-  ]
-  const unprotectedPaths = []
-  return AuthorizationMiddleware.requestHandler(requiredRoles, accessDeniedCallback, unprotectedPaths)
-}
+// import { claimIssueRequestHandler } from 'claim-documents/index'
 
 export class Feature {
   enableFor (app: express.Express) {
     if (app.settings.nunjucksEnv && app.settings.nunjucksEnv.globals) {
       app.settings.nunjucksEnv.globals.ClaimPaths = Paths
     }
-
-    app.all('/claim/*', claimIssueRequestHandler())
+    // commented out as claim document index.ts will handle this
+    // app.all('/claim/*', claimIssueRequestHandler())
     app.all(/^\/claim\/(?!start|amount-exceeded|new-features-consent|.+\/confirmation|.+\/receipt|.+\/draftReceipt|.+\/sealed-claim).*$/,
       DraftMiddleware.requestHandler(new DraftService(), 'claim', 100, (value: any): DraftClaim => {
         return new DraftClaim().deserialize(value)

src/main/features/claim/paths.ts

@@ -35,14 +35,11 @@ export class Paths {
   static readonly startPaymentReceiver = new RoutablePath('/claim/pay')
   static readonly finishPaymentReceiver = new RoutablePath('/claim/pay/:externalId/receiver')
   static readonly confirmationPage = new RoutablePath('/claim/:externalId/confirmation')
-  static readonly receiptReceiver = new RoutablePath('/claim/:externalId/receipt')
   static readonly claimantPartyTypeSelectionPage = new RoutablePath('/claim/claimant-party-type-selection')
   static readonly defendantPartyTypeSelectionPage = new RoutablePath('/claim/defendant-party-type-selection')
   static readonly incompleteSubmissionPage = new RoutablePath('/claim/incomplete-submission')
-  static readonly sealedClaimPdfReceiver = new RoutablePath('/claim/:externalId/sealed-claim')
   static readonly initiatePaymentController = new RoutablePath('/claim/initiate-payment')
   static readonly finishPaymentController = new RoutablePath('/claim/:externalId/finish-payment')
-  static readonly documentPage = new RoutablePath('/claim/:externalId/document/:documentURI')
   static readonly draftReceiptReceiver = new RoutablePath('/claim/:externalId/draftReceipt')
 }
 

src/main/features/claim/routes/receipt.ts

@@ -1,7 +1,6 @@
 import * as express from 'express'
 import { Paths } from 'claim/paths'
 
-import { Claim } from 'claims/models/claim'
 import { ClaimMiddleware } from 'claims/claimMiddleware'
 import { DocumentsClient } from 'documents/documentsClient'
 
@@ -13,15 +12,6 @@ const documentsClient: DocumentsClient = new DocumentsClient()
 
 /* tslint:disable:no-default-export */
 export default express.Router()
-  .get(Paths.receiptReceiver.uri,
-    ClaimMiddleware.retrieveByExternalId,
-    ErrorHandling.apply(async (req: express.Request, res: express.Response): Promise<void> => {
-      const claim: Claim = res.locals.claim
-
-      const pdf: Buffer = await documentsClient.getClaimIssueReceiptPDF(claim.externalId, res.locals.user.bearerToken)
-      DownloadUtils.downloadPDF(res, pdf, `${claim.claimNumber}-claim-form-claimant-copy`)
-    }))
-
   .get(Paths.draftReceiptReceiver.uri,
     ClaimMiddleware.retrieveByExternalId,
     ErrorHandling.apply(async (req: express.Request, res: express.Response): Promise<void> => {

src/main/features/claim/views/macro/claim-confirmation.njk

@@ -9,7 +9,7 @@
         <h1 class="bold-large">{{ claim.claimNumber }}</h1>
     </div>
     <p class="receipt-download-container">
-        {{ internalLink(t('Download your claim form'), ClaimPaths.receiptReceiver.evaluateUri({ externalId: claim.externalId})) }}
+        {{ internalLink(t('Download your claim form'), ClaimDocumentsPaths.receiptReceiver.evaluateUri({ externalId: claim.externalId})) }}
     </p>
 </div>
 <h2 class="heading-medium">{{ t('What happens next') }}</h2>
@@ -24,4 +24,4 @@
 
 <h2 class="heading-medium">{{ t('If the defendant pays you') }}</h2>
 <p>{{ t('You need to sign in to your account to tell us you’ve been paid.') }}</p>
-{% endmacro %}
+{% endmacro %}