ref: Convert file entry stuff to ts (#2698)

Part of codecov/engineering-team#588

Author: spalmurray-codecov

src/services/file/useCoverageWithFilters.js

@@ -82,7 +82,7 @@ export function useCoverageWithFilters({
           flags,
           components,
         },
-      }).then(extractCoverageFromResponse)
+      }).then((res) => extractCoverageFromResponse(res.data.owner.repository))
     },
     ...(!!opts && opts),
   })

src/services/file/useCoverageWithFilters.spec.js

@@ -46,36 +46,38 @@ describe('useCoverageWithFilters', () => {
           commit: {
             commitid: 'f00162848a3cebc0728d915763c2fd9e92132408',
             flagNames: ['a', 'b'],
-            componentNames: ['c'],
             coverageFile: {
               content:
                 'import pytest\nfrom path1 import index\n\ndef test_uncovered_if():\n    assert index.uncovered_if() == False\n\ndef test_fully_covered():\n    assert index.fully_covered() == True\n\n\n\n\n',
               coverage: [
                 {
                   line: 1,
-                  coverage: 1,
+                  coverage: 'H',
                 },
                 {
                   line: 2,
-                  coverage: 1,
+                  coverage: 'P',
                 },
                 {
-                  line: 4,
-                  coverage: 1,
+                  line: 3,
+                  coverage: 'H',
                 },
                 {
-                  line: 5,
-                  coverage: 1,
+                  line: 4,
+                  coverage: 'M',
                 },
                 {
-                  line: 7,
-                  coverage: 1,
+                  line: 5,
+                  coverage: 'H',
                 },
                 {
-                  line: 8,
-                  coverage: 1,
+                  line: 6,
+                  coverage: 'H',
                 },
               ],
+              totals: {
+                coverage: 66.67,
+              },
             },
           },
           branch: null,
@@ -99,9 +101,8 @@ describe('useCoverageWithFilters', () => {
       await waitFor(() =>
         expect(result.current.data).toEqual({
           ...data.owner.repository.commit.coverageFile,
-          totals: 0,
+          totals: 66.67,
           flagNames: ['a', 'b'],
-          componentNames: ['c'],
           coverage: _.chain(data.owner.repository.commit.coverageFile.coverage)
             .keyBy('line')
             .mapValues('coverage')

src/services/file/utils.js src/services/file/utils.ts

@@ -1,9 +1,14 @@
 import keyBy from 'lodash/keyBy'
 import mapValues from 'lodash/mapValues'
 
-export function extractCoverageFromResponse(res) {
-  const commit = res?.data?.owner?.repository?.commit
-  const branch = res?.data?.owner?.repository?.branch?.head
+import { PathContentsRepositorySchema } from 'services/pathContents/constants'
+
+export function extractCoverageFromResponse(
+  repository: PathContentsRepositorySchema | undefined | null
+) {
+  if (!repository) return null
+  const commit = repository?.commit
+  const branch = repository?.branch?.head
   const coverageSource = commit || branch
   const coverageFile = coverageSource?.coverageFile
   if (!coverageFile) return null
@@ -15,9 +20,11 @@ export function extractCoverageFromResponse(res) {
   return {
     content: coverageFile?.content,
     coverage: fileCoverage,
-    totals: isNaN(coverageTotal) ? 0 : coverageTotal,
+    totals:
+      typeof coverageTotal !== 'number' || isNaN(coverageTotal)
+        ? 0
+        : coverageTotal,
     flagNames: coverageSource?.flagNames ?? [],
-    componentNames: coverageSource?.componentNames ?? [],
     isCriticalFile: !!coverageFile?.isCriticalFile,
     ...(hashedPath && { hashedPath }),
   }

src/services/pathContents/branch/file/usePrefetchBranchFileEntry.js

@@ -40,7 +40,9 @@ export function usePrefetchBranchFileEntry({
             path,
             flags,
           },
-        }).then(extractCoverageFromResponse),
+        }).then((res) =>
+          extractCoverageFromResponse(res.data.owner.repository)
+        ),
       staleTime: 10000,
     })
 

src/services/pathContents/commit/file/usePrefetchCommitFileEntry.spec.tsx

@@ -28,22 +28,25 @@ const mockData = {
               coverage: 'P',
             },
             {
-              line: 4,
+              line: 3,
               coverage: 'H',
             },
             {
-              line: 5,
+              line: 4,
               coverage: 'M',
             },
             {
-              line: 7,
+              line: 5,
               coverage: 'H',
             },
             {
-              line: 8,
+              line: 6,
               coverage: 'H',
             },
           ],
+          totals: {
+            coverage: 66.67,
+          },
         },
       },
       branch: null,
@@ -53,7 +56,6 @@ const mockData = {
 
 const mockNotFoundError = {
   owner: {
-    isCurrentUserPartOfOrg: true,
     repository: {
       __typename: 'NotFoundError',
       message: 'commit not found',
@@ -63,7 +65,6 @@ const mockNotFoundError = {
 
 const mockOwnerNotActivatedError = {
   owner: {
-    isCurrentUserPartOfOrg: true,
     repository: {
       __typename: 'OwnerNotActivatedError',
       message: 'owner not activated',
@@ -191,16 +192,15 @@ describe('usePrefetchCommitFileEntry', () => {
         coverage: {
           '1': 'H',
           '2': 'P',
-          '4': 'H',
-          '5': 'M',
-          '7': 'H',
-          '8': 'H',
+          '3': 'H',
+          '4': 'M',
+          '5': 'H',
+          '6': 'H',
         },
         flagNames: ['a', 'b'],
-        componentNames: [],
         hashedPath: 'hashed-path',
         isCriticalFile: true,
-        totals: 0,
+        totals: 66.67,
       }
 
       await waitFor(() =>
@@ -211,7 +211,7 @@ describe('usePrefetchCommitFileEntry', () => {
     })
 
     describe('there is a null owner', () => {
-      it('returns a null value', async () => {
+      it('returns a 404', async () => {
         setup({ isNullOwner: true })
         const { result } = renderHook(
           () =>
@@ -230,7 +230,11 @@ describe('usePrefetchCommitFileEntry', () => {
           ?.at(0) as Array<any>
 
         await waitFor(() =>
-          expect(queryClient?.getQueryState(queryKey)?.data).toBe(null)
+          expect(queryClient?.getQueryState(queryKey)?.error).toEqual(
+            expect.objectContaining({
+              status: 404,
+            })
+          )
         )
       })
     })

src/services/pathContents/commit/file/usePrefetchCommitFileEntry.tsx

@@ -3,9 +3,13 @@ import { useParams } from 'react-router-dom'
 
 import { extractCoverageFromResponse } from 'services/file/utils'
 import Api from 'shared/api'
+import { NetworkErrorObject } from 'shared/api/helpers'
 import A from 'ui/A'
 
-import { queryForCommitFile as query, RequestSchema } from '../../constants'
+import {
+  PathContentsRequestSchema,
+  queryForCommitFile as query,
+} from '../../constants'
 
 interface URLParams {
   provider: string
@@ -58,13 +62,14 @@ export function usePrefetchCommitFileEntry({
             components,
           },
         }).then((res) => {
-          const parsedRes = RequestSchema.safeParse(res?.data)
+          const parsedRes = PathContentsRequestSchema.safeParse(res?.data)
 
           if (!parsedRes.success) {
             return Promise.reject({
               status: 404,
-              data: null,
-            })
+              data: {},
+              dev: 'usePrefetchCommitFileEntry - 404 schema parsing failed',
+            } satisfies NetworkErrorObject)
           }
 
           const data = parsedRes.data
@@ -73,7 +78,8 @@ export function usePrefetchCommitFileEntry({
             return Promise.reject({
               status: 404,
               data: {},
-            })
+              dev: 'usePrefetchCommitFileEntry - 404 NotFoundError',
+            } satisfies NetworkErrorObject)
           }
 
           if (
@@ -91,12 +97,21 @@ export function usePrefetchCommitFileEntry({
                   </p>
                 ),
               },
-            })
+              dev: 'usePrefetchCommitFileEntry - 403 OwnerNotActivatedError',
+            } satisfies NetworkErrorObject)
           }
 
-          const extractedResults = extractCoverageFromResponse({ data })
+          const coverage = extractCoverageFromResponse(data?.owner?.repository)
+
+          if (!coverage) {
+            return Promise.reject({
+              status: 404,
+              data: {},
+              dev: 'usePrefetchCommitFileEntry - 404 failed to find coverage file',
+            } satisfies NetworkErrorObject)
+          }
 
-          return extractedResults
+          return coverage
         })
       },
       staleTime: 10000,

src/services/pathContents/constants.ts

@@ -1,9 +1,33 @@
+import { ParsedQs } from 'qs'
 import { z } from 'zod'
 
 import {
   RepoNotFoundErrorSchema,
   RepoOwnerNotActivatedErrorSchema,
 } from 'services/repo'
+import { DisplayType } from 'shared/ContentsTable/constants'
+
+const pathContentsFiltersParam = [
+  'NAME',
+  'COVERAGE',
+  'HITS',
+  'MISSES',
+  'PARTIALS',
+  'LINES',
+] as const
+
+type PathContentsFiltersParam = (typeof pathContentsFiltersParam)[number]
+
+export type PathContentsFilters = {
+  searchValue?: string
+  displayType?: DisplayType
+  ordering?: {
+    direction: 'ASC' | 'DESC'
+    parameter: PathContentsFiltersParam
+  }
+  flags?: string[] | ParsedQs[]
+  components?: string[] | ParsedQs[]
+}
 
 const CoverageSchema = z.array(
   z
@@ -34,7 +58,7 @@ const CoverageForFileSchema = z.object({
     .nullish(),
 })
 
-const RepositorySchema = z.object({
+export const RepositorySchema = z.object({
   __typename: z.literal('Repository'),
   commit: CoverageForFileSchema.nullish(),
   branch: z
@@ -45,14 +69,16 @@ const RepositorySchema = z.object({
     .nullish(),
 })
 
-export const RequestSchema = z.object({
+export type PathContentsRepositorySchema = z.infer<typeof RepositorySchema>
+
+export const PathContentsRequestSchema = z.object({
   owner: z
     .object({
       repository: z
-        .union([
-          RepositorySchema.partial(),
-          RepoNotFoundErrorSchema.partial(),
-          RepoOwnerNotActivatedErrorSchema.partial(),
+        .discriminatedUnion('__typename', [
+          RepositorySchema,
+          RepoNotFoundErrorSchema,
+          RepoOwnerNotActivatedErrorSchema,
         ])
         .nullish(),
     })