Refactor to use a impacted files enum as requested.

codecov · Oct 26, 2023 · 6bea3b5 · 6bea3b5
1 parent 0cb7bf5
commit 6bea3b5
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 26 deletions.
diff --git a/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/FilesChanged.jsx b/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/FilesChanged.jsx
@@ -2,6 +2,7 @@ import isNil from 'lodash/isNil'
 
 import { CommitStateEnum } from 'shared/utils/commit'
 import { ComparisonReturnType } from 'shared/utils/comparison'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 import Spinner from 'ui/Spinner'
 
 import { useImpactedFilesTable } from './hooks'
@@ -53,7 +54,7 @@ function FilesChangedTab() {
     )
   }
 
-  if (data?.impactedFilesType === 'UnknownFlags') {
+  if (data?.impactedFilesType === ImpactedFilesReturnType.UNKNOWN_FLAGS) {
     return (
       <div className="flex flex-col gap-2">
         <p className="mt-4">
@@ -65,7 +66,7 @@ function FilesChangedTab() {
   }
 
   if (
-    data?.impactedFilesType === 'ImpactedFiles' &&
+    data?.impactedFilesType === ImpactedFilesReturnType.IMPACTED_FILES &&
     data?.impactedFiles.length > 0
   ) {
     return (

diff --git a/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/FilesChanged.spec.jsx b/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/FilesChanged.spec.jsx
@@ -7,6 +7,7 @@ import { MemoryRouter, Route } from 'react-router-dom'
 
 import { CommitStateEnum } from 'shared/utils/commit'
 import { ComparisonReturnType } from 'shared/utils/comparison'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 
 import FilesChanged from './FilesChanged'
 
@@ -68,7 +69,7 @@ const mockPull = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: mockImpactedFiles,
           },
         },
@@ -148,7 +149,10 @@ describe('FilesChanged', () => {
                   percentCovered: 27.35,
                 },
                 changeCoverage: 38.94,
-                impactedFiles: { __typename: 'ImpactedFiles', results: [] },
+                impactedFiles: {
+                  __typename: ImpactedFilesReturnType.IMPACTED_FILES,
+                  results: [],
+                },
               },
             },
           },

diff --git a/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/Table/Table.spec.jsx b/src/pages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/Table/Table.spec.jsx
@@ -7,6 +7,8 @@ import { graphql } from 'msw'
 import { setupServer } from 'msw/node'
 import { MemoryRouter, Route } from 'react-router-dom'
 
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
+
 import Table from './Table'
 
 jest.mock('../../shared/FileDiff', () => () => 'FileDiff Component')
@@ -48,7 +50,10 @@ const mockPull = {
             percentCovered: 27.35,
           },
           changeCoverage: 38.94,
-          impactedFiles: { __typename: 'ImpactedFiles', results: mockTable },
+          impactedFiles: {
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
+            results: mockTable,
+          },
         },
       },
     },
@@ -75,7 +80,10 @@ const mockNoTable = {
             percentCovered: 27.35,
           },
           changeCoverage: 38.94,
-          impactedFiles: { __typename: 'ImpactedFiles', results: [] },
+          impactedFiles: {
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
+            results: [],
+          },
         },
       },
     },
@@ -103,7 +111,7 @@ const mockNoChange = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: [
               {
                 isCriticalFile: true,

diff --git a/...ages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/hooks/useImpactedFilesTable.js b/...ages/PullRequestPage/subroute/FilesChangedTab/FilesChanged/hooks/useImpactedFilesTable.js
@@ -5,6 +5,7 @@ import { useCallback, useState } from 'react'
 import { useLocation, useParams } from 'react-router-dom'
 
 import { usePull } from 'services/pull'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 
 const orderingDirection = Object.freeze({
   desc: 'DESC',
@@ -61,7 +62,8 @@ function transformImpactedFilesData({ pull }) {
   )
   // Keep old way but just pass the plain impactedFiles if the status is not ImpactedFile
   const impactedFiles =
-    compareWithBase?.impactedFiles?.__typename === 'ImpactedFiles'
+    compareWithBase?.impactedFiles?.__typename ===
+    ImpactedFilesReturnType.IMPACTED_FILES
       ? mutatedImpactedFiles
       : compareWithBase?.impactedFiles
 

diff --git a/...PullRequestPage/subroute/FilesChangedTab/FilesChanged/hooks/useImpactedFilesTable.spec.js b/...PullRequestPage/subroute/FilesChangedTab/FilesChanged/hooks/useImpactedFilesTable.spec.js
@@ -5,6 +5,8 @@ import { setupServer } from 'msw/node'
 import { MemoryRouter, Route } from 'react-router-dom'
 import { act } from 'react-test-renderer'
 
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
+
 import {
   orderingParameter,
   useImpactedFilesTable,
@@ -66,7 +68,7 @@ let mockPull = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: mockImpactedFiles,
           },
         },
@@ -171,7 +173,7 @@ describe('useImpactedFilesTable', () => {
                 pullId: 14,
               },
             ],
-            impactedFilesType: 'ImpactedFiles',
+            impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
             pullBaseCoverage: 27.35,
             pullHeadCoverage: 74.2,
             pullPatchCoverage: 92.12,
@@ -185,7 +187,7 @@ describe('useImpactedFilesTable', () => {
     beforeEach(() => {
       const pull = mockPull
       const mockImpactedFilesWithoutCoverage = {
-        __typename: 'ImpactedFiles',
+        __typename: ImpactedFilesReturnType.IMPACTED_FILES,
         results: [
           {
             missesCount: 0,
@@ -217,7 +219,7 @@ describe('useImpactedFilesTable', () => {
 
       await waitFor(() =>
         expect(result.current.data).toEqual({
-          impactedFilesType: 'ImpactedFiles',
+          impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
           compareWithBaseType: 'Comparison',
           headState: 'PROCESSED',
           impactedFiles: [

diff --git a/...equestPage/subroute/IndirectChangesTab/IndirectChangedFiles/IndirectChangedFiles.spec.jsx b/...equestPage/subroute/IndirectChangesTab/IndirectChangedFiles/IndirectChangedFiles.spec.jsx
@@ -7,6 +7,8 @@ import { graphql } from 'msw'
 import { setupServer } from 'msw/node'
 import { MemoryRouter, Route } from 'react-router-dom'
 
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
+
 import IndirectChangedFiles from './IndirectChangedFiles'
 
 jest.mock('../FileDiff', () => () => 'FileDiff Component')
@@ -48,7 +50,7 @@ const mockPull = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: mockImpactedFiles,
           },
         },
@@ -77,7 +79,7 @@ const mockNoImpactedFiles = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: [],
           },
         },
@@ -106,7 +108,7 @@ const mockNoChange = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: [
               {
                 isCriticalFile: true,

diff --git a/...ge/subroute/IndirectChangesTab/IndirectChangedFiles/hooks/useIndirectChangedFilesTable.js b/...ge/subroute/IndirectChangesTab/IndirectChangedFiles/hooks/useIndirectChangedFilesTable.js
@@ -4,6 +4,7 @@ import { useCallback, useState } from 'react'
 import { useParams } from 'react-router-dom'
 
 import { usePull } from 'services/pull'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 
 const orderingDirection = Object.freeze({
   desc: 'DESC',
@@ -63,7 +64,8 @@ function transformIndirectChangesData({ pull }) {
 
   // Keep old way but just pass the plain impactedFiles if the status is not ImpactedFile
   const impactedFiles =
-    compareWithBase?.impactedFiles?.__typename === 'ImpactedFiles'
+    compareWithBase?.impactedFiles?.__typename ===
+    ImpactedFilesReturnType.IMPACTED_FILES
       ? mutatedImpactedFiles
       : compareWithBase?.impactedFiles
 

diff --git a/...broute/IndirectChangesTab/IndirectChangedFiles/hooks/useIndirectChangedFilesTable.spec.js b/...broute/IndirectChangesTab/IndirectChangedFiles/hooks/useIndirectChangedFilesTable.spec.js
@@ -3,6 +3,7 @@ import { useParams } from 'react-router-dom'
 import { act } from 'react-test-renderer'
 
 import { usePull } from 'services/pull'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 
 import { useIndirectChangedFilesTable } from './useIndirectChangedFilesTable'
 
@@ -50,7 +51,7 @@ let mockPull = {
         },
         changeCoverage: 38.94,
         impactedFiles: {
-          __typename: 'ImpactedFiles',
+          __typename: ImpactedFilesReturnType.IMPACTED_FILES,
           results: mockImpactedFiles,
         },
       },
@@ -132,7 +133,7 @@ describe('useRepoContentsTable', () => {
       expect(result.current.data).toEqual({
         headState: 'PROCESSED',
         compareWithBaseType: 'Comparison',
-        impactedFilesType: 'ImpactedFiles',
+        impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
         impactedFiles: [
           {
             changeCoverage: 44.85,
@@ -145,7 +146,7 @@ describe('useRepoContentsTable', () => {
             patchCoverage: 27.43,
             pullId: 14,
             compareWithBaseType: 'Comparison',
-            impactedFilesType: 'ImpactedFiles',
+            impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
           },
         ],
         pullBaseCoverage: 27.35,
@@ -158,7 +159,7 @@ describe('useRepoContentsTable', () => {
   describe('when called with no head or base coverage on the impacted files', () => {
     beforeEach(() => {
       const mockImpactedFilesWithoutCoverage = {
-        __typename: 'ImpactedFiles',
+        __typename: ImpactedFilesReturnType.IMPACTED_FILES,
         results: [
           {
             missesCount: 0,
@@ -188,11 +189,11 @@ describe('useRepoContentsTable', () => {
       expect(result.current.data).toEqual({
         headState: 'PROCESSED',
         compareWithBaseType: 'Comparison',
-        impactedFilesType: 'ImpactedFiles',
+        impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
         impactedFiles: [
           {
             compareWithBaseType: 'Comparison',
-            impactedFilesType: 'ImpactedFiles',
+            impactedFilesType: ImpactedFilesReturnType.IMPACTED_FILES,
             changeCoverage: NaN,
             fileName: 'mafs.js',
             hasHeadOrPatchCoverage: true,

diff --git a/src/pages/PullRequestPage/subroute/IndirectChangesTab/IndirectChangesTab.jsx b/src/pages/PullRequestPage/subroute/IndirectChangesTab/IndirectChangesTab.jsx
@@ -2,6 +2,7 @@ import isNil from 'lodash/isNil'
 
 import { CommitStateEnum } from 'shared/utils/commit'
 import { ComparisonReturnType } from 'shared/utils/comparison'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 import Spinner from 'ui/Spinner'
 
 import ImpactedFiles from './IndirectChangedFiles'
@@ -67,7 +68,7 @@ function IndirectChangesTab() {
   }
 
   if (
-    data?.impactedFilesType === 'ImpactedFiles' &&
+    data?.impactedFilesType === ImpactedFilesReturnType.IMPACTED_FILES &&
     data?.impactedFiles.length > 0
   ) {
     return (

diff --git a/src/pages/PullRequestPage/subroute/IndirectChangesTab/IndirectChangesTab.spec.jsx b/src/pages/PullRequestPage/subroute/IndirectChangesTab/IndirectChangesTab.spec.jsx
@@ -7,6 +7,7 @@ import { MemoryRouter, Route } from 'react-router-dom'
 
 import { CommitStateEnum } from 'shared/utils/commit'
 import { ComparisonReturnType } from 'shared/utils/comparison'
+import { ImpactedFilesReturnType } from 'shared/utils/impactedFiles'
 
 import IndirectChangesTab from './IndirectChangesTab'
 
@@ -84,7 +85,7 @@ const mockPull = {
           },
           changeCoverage: 38.94,
           impactedFiles: {
-            __typename: 'ImpactedFiles',
+            __typename: ImpactedFilesReturnType.IMPACTED_FILES,
             results: mockImpactedFiles,
           },
         },
@@ -151,7 +152,10 @@ describe('IndirectChangesTab', () => {
                     percentCovered: 27.35,
                   },
                   changeCoverage: 38.94,
-                  impactedFiles: { __typename: 'ImpactedFiles', results: [] },
+                  impactedFiles: {
+                    __typename: ImpactedFilesReturnType.IMPACTED_FILES,
+                    results: [],
+                  },
                 },
               },
             },
@@ -319,7 +323,7 @@ describe('IndirectChangesTab', () => {
                 },
                 changeCoverage: 38.94,
                 impactedFiles: {
-                  __typename: 'UnknownFlags',
+                  __typename: ImpactedFilesReturnType.UNKNOWN_FLAGS,
                   message: 'Unkown flags detected',
                 },
               },

diff --git a/src/shared/utils/impactedFiles.ts b/src/shared/utils/impactedFiles.ts
@@ -0,0 +1,4 @@
+export const ImpactedFilesReturnType = Object.freeze({
+  UNKNOWN_FLAGS: 'UnknownFlags',
+  IMPACTED_FILES: 'ImpactedFiles',
+})