Standardize document type text selection (#318)

* Standardize document type text selection * Added: risk comments --------- Co-authored-by: Spyros <[email protected]>
OWASP · Jul 11, 2023 · 5d46099 · 5d46099
1 parent 55cd5f1
commit 5d46099
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 17 deletions.
diff --git a/application/frontend/src/components/DocumentNode/DocumentNode.tsx b/application/frontend/src/components/DocumentNode/DocumentNode.tsx
@@ -5,8 +5,6 @@ import React, { FunctionComponent, useContext, useEffect, useMemo, useState } fr
 import { Link, useHistory } from 'react-router-dom';
 
 import {
-  DOCUMENT_TYPES,
-  DOCUMENT_TYPE_NAMES,
   TYPE_CONTAINS,
   TYPE_IS_PART_OF,
   TYPE_RELATED,
@@ -15,7 +13,7 @@ import { useEnvironment } from '../../hooks';
 import { applyFilters } from '../../hooks/applyFilters';
 import { Document } from '../../types';
 import { getDocumentDisplayName, groupLinksByType } from '../../utils';
-import { getApiEndpoint, getInternalUrl } from '../../utils/document';
+import { getApiEndpoint, getDocumentTypeText, getInternalUrl } from '../../utils/document';
 import { FilterButton } from '../FilterButton/FilterButton';
 import { LoadingAndErrorIndicator } from '../LoadingAndErrorIndicator';
 import { Icon } from 'semantic-ui-react';
@@ -147,7 +145,7 @@ export const DocumentNode: FunctionComponent<DocumentNode> = ({
                 <div className="document-node__link-type-container" key={type}>
                   {idx > 0 && <hr/>}
                   <div>
-                    <b>Which {DOCUMENT_TYPE_NAMES[type]}</b>:
+                    <b>Which {getDocumentTypeText(type, links[0].document.doctype)}</b>:{/* Risk here of mixed doctype in here causing odd output */}
                   </div>
                   <div>
                     <div className="accordion ui fluid styled f0">

diff --git a/application/frontend/src/components/FilterButton/FilterButton.tsx b/application/frontend/src/components/FilterButton/FilterButton.tsx
@@ -3,13 +3,6 @@ import React, { FunctionComponent, useEffect, useMemo, useState } from 'react';
 import { Link, useHistory } from 'react-router-dom';
 import { Button } from 'semantic-ui-react';
 
-import {
-  DOCUMENT_TYPE_NAMES,
-  TYPE_CONTAINS,
-  TYPE_IS_PART_OF,
-  TYPE_LINKED_TO,
-  TYPE_RELATED,
-} from '../../const';
 import { useEnvironment } from '../../hooks';
 import { Document, LinkedDocument } from '../../types';
 import { getDocumentDisplayName, groupLinksByType } from '../../utils';

diff --git a/application/frontend/src/pages/BrowseRootCres/browseRootCres.tsx b/application/frontend/src/pages/BrowseRootCres/browseRootCres.tsx
@@ -7,7 +7,6 @@ import { useParams } from 'react-router-dom';
 import { DocumentNode } from '../../components/DocumentNode';
 import { ClearFilterButton, FilterButton } from '../../components/FilterButton/FilterButton';
 import { LoadingAndErrorIndicator } from '../../components/LoadingAndErrorIndicator';
-import { DOCUMENT_TYPE_NAMES } from '../../const';
 import { useEnvironment } from '../../hooks';
 import { applyFilters, filterContext } from '../../hooks/applyFilters';
 import { Document } from '../../types';

diff --git a/application/frontend/src/pages/CommonRequirementEnumeration/CommonRequirementEnumeration.tsx b/application/frontend/src/pages/CommonRequirementEnumeration/CommonRequirementEnumeration.tsx
@@ -7,12 +7,11 @@ import { useParams } from 'react-router-dom';
 import { DocumentNode } from '../../components/DocumentNode';
 import { ClearFilterButton, FilterButton } from '../../components/FilterButton/FilterButton';
 import { LoadingAndErrorIndicator } from '../../components/LoadingAndErrorIndicator';
-import { DOCUMENT_TYPE_NAMES } from '../../const';
 import { useEnvironment } from '../../hooks';
 import { applyFilters, filterContext } from '../../hooks/applyFilters';
 import { Document } from '../../types';
 import { groupLinksByType } from '../../utils';
-import { getDocumentDisplayName, orderLinksByType } from '../../utils/document';
+import { getDocumentDisplayName, getDocumentTypeText, orderLinksByType } from '../../utils/document';
 
 export const CommonRequirementEnumeration = () => {
   const { id } = useParams();
@@ -82,7 +81,7 @@ export const CommonRequirementEnumeration = () => {
               Object.entries(linksByType).map(([type, links]) => (
                 <div className="cre-page__links" key={type}>
                   <div className="cre-page__links-eader">
-                    <b>Which {DOCUMENT_TYPE_NAMES[type]}</b>:
+                    <b>Which {getDocumentTypeText(type, links[0].document.doctype)}</b>:{/* Risk here of mixed doctype in here causing odd output */}
                   </div>
                   {links.sort((a, b) => getDocumentDisplayName(a.document).localeCompare(getDocumentDisplayName(b.document))).map((link, i) => (
                     <div key={i} className="accordion ui fluid styled cre-page__links-container">

diff --git a/application/frontend/src/pages/Standard/StandardSection.tsx b/application/frontend/src/pages/Standard/StandardSection.tsx
@@ -11,6 +11,7 @@ import { DOCUMENT_TYPES, DOCUMENT_TYPE_NAMES, TOOL } from '../../const';
 import { useEnvironment } from '../../hooks';
 import { Document } from '../../types';
 import { getDocumentDisplayName, groupLinksByType } from '../../utils';
+import { getDocumentTypeText } from '../../utils/document';
 
 export const StandardSection = () => {
   const { id, section, sectionID } = useParams();
@@ -75,7 +76,7 @@ export const StandardSection = () => {
               Object.entries(linksByType).map(([type, links]) => (
                 <div className="cre-page__links" key={type}>
                   <div className="cre-page__links-header">
-                    <b>Which {DOCUMENT_TYPE_NAMES[type]}</b>:
+                    <b>Which {getDocumentTypeText(type, links[0].document.doctype)}</b>:{/* Risk here of mixed doctype in here causing odd output */}
                   </div>
                   {links.sort((a, b) => getDocumentDisplayName(a.document).localeCompare(getDocumentDisplayName(b.document))).map((link, i) => (
                     <div key={i} className="accordion ui fluid styled cre-page__links-container">

diff --git a/application/frontend/src/utils/document.ts b/application/frontend/src/utils/document.ts
@@ -1,4 +1,4 @@
-import { TYPE_CONTAINS, TYPE_IS_PART_OF, TYPE_LINKED_TO, TYPE_RELATED, TYPE_SAM, TYPE_SAME } from '../const';
+import { DOCUMENT_TYPES, DOCUMENT_TYPE_NAMES, TYPE_IS_PART_OF, TYPE_LINKED_TO } from '../const';
 import { Document, LinkedDocument } from '../types';
 
 export const getDocumentDisplayName = (document: Document) => {
@@ -72,3 +72,12 @@ export const getApiEndpoint = (doc: Document, apiUrl: string): string => {
 
   return `${apiUrl}/id/${doc.id}`;
 };
+
+export const getDocumentTypeText = (linkType, docType): string => {
+  let docText =  DOCUMENT_TYPE_NAMES[linkType];
+  if(linkType === TYPE_LINKED_TO && docType === DOCUMENT_TYPES.TYPE_CRE)
+  {
+    docText = DOCUMENT_TYPE_NAMES[TYPE_IS_PART_OF];
+  }
+  return docText
+}