Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Presigned url #3724

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
pre-signed-url api adjust, new hook
  • Loading branch information
RulaKhaled committed Jul 4, 2022
commit e87db580c40bc5b16fe12b588712bed3cf105f8c
4 changes: 2 additions & 2 deletions src/config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import mapKeys from 'lodash/mapKeys'

const defaultConfig = {
API_URL: '',
API_URL: 'https://stage-api.codecov.dev',
STRIPE_KEY: '',
IS_ENTERPRISE: false,
SENTRY_ENVIRONMENT: 'staging',
@@ -17,7 +17,7 @@ function removeReactAppPrefix(obj) {
const config = {
...defaultConfig,
...removeReactAppPrefix(process.env),
...window.configEnv,
// ...window.configEnv,
}

export default config
31 changes: 22 additions & 9 deletions src/pages/CommitPage/CommitPage.spec.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
import { render, screen, waitFor } from 'custom-testing-library'
import { render, screen } from 'custom-testing-library'

import { QueryClient, QueryClientProvider } from 'react-query'
import { MemoryRouter, Route } from 'react-router-dom'

import { useCommit } from 'services/commit'
import { useFileWithMainCoverage } from 'services/file'
import { useUploadPresignedUrl } from 'services/uploadPresignedUrl'

import CommitPage from './CommitPage'

jest.mock('services/commit')
jest.mock('services/file')
jest.mock('services/uploadPresignedUrl')
jest.mock('./Header/Header.js', () => () => 'The Header')
jest.mock('./subroute/CommitFileView.js', () => () => 'The Commit File View')
jest.mock(
'./Summary/CommitDetailsSummary.js',
() => () => 'Commit Details Summary'
)
const queryClient = new QueryClient()

const dataReturned = {
commit: {
@@ -92,13 +96,18 @@ describe('CommitPage', () => {
function setup(data) {
useCommit.mockReturnValue(data)
useFileWithMainCoverage.mockReturnValue(fileData)
useUploadPresignedUrl.mockReturnValue({
data: '/archive/v4/raw/2022-06-23/..',
})

render(
<MemoryRouter initialEntries={['/gh/test/test-repo/commit/abcd']}>
<Route path="/:provider/:owner/:repo/commit/:commit">
<CommitPage />
</Route>
</MemoryRouter>
<QueryClientProvider client={queryClient}>
<MemoryRouter initialEntries={['/gh/test/test-repo/commit/abcd']}>
<Route path="/:provider/:owner/:repo/commit/:commit">
<CommitPage />
</Route>
</MemoryRouter>
</QueryClientProvider>
)
}

@@ -159,6 +168,9 @@ describe('CommitPage', () => {
describe('Commits Table', () => {
function setup(data) {
useCommit.mockReturnValue(data)
useUploadPresignedUrl.mockReturnValue({
data: '/archive/v4/raw/2022-06-23/..',
})

render(
<MemoryRouter
@@ -212,6 +224,9 @@ describe('CommitPage', () => {

describe('FileViewer', () => {
function setup(data) {
useUploadPresignedUrl.mockReturnValue({
data: '/archive/v4/raw/2022-06-23/..',
})
useCommit.mockReturnValue(data)
useFileWithMainCoverage.mockReturnValue({
data: fileData,
@@ -235,9 +250,7 @@ describe('CommitPage', () => {

it('the impacted file', () => {
expect(screen.getByTestId('spinner')).toBeInTheDocument()
waitFor(() => {
expect(screen.getByText(/index.js/)).toBeInTheDocument()
})
expect(screen.getByText(/index.js/)).toBeInTheDocument()
})
})

11 changes: 3 additions & 8 deletions src/pages/CommitPage/UploadsCard/Upload.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import PropTypes from 'prop-types'

import config from 'config'

import { useUploadPresignedUrl } from 'services/uploadPresignedUrl'
import {
ErrorCodeEnum,
UploadStateEnum,
@@ -24,6 +23,7 @@ const Upload = ({
state,
}) => {
const isCarriedForward = uploadType === UploadTypeEnum.CARRIED_FORWARD
const { data: url } = useUploadPresignedUrl({ pathUrl: downloadUrl })

return (
<div className="py-2 px-4 flex flex-col gap-1">
@@ -57,12 +57,7 @@ const Upload = ({
)}
</div>
{downloadUrl && (
<A
href={`${config.API_URL}${downloadUrl}`}
hook="download report"
download
isExternal
>
<A href={url} isExternal hook="get-presigned-url">
Download
</A>
)}
21 changes: 16 additions & 5 deletions src/pages/CommitPage/UploadsCard/Upload.spec.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
import { render, screen } from '@testing-library/react'
import { QueryClient, QueryClientProvider } from 'react-query'
import { MemoryRouter, Route } from 'react-router-dom'

import { formatTimeToNow } from 'shared/utils/dates'

import Upload from './Upload'

const queryClient = new QueryClient()

describe('UploadsCard', () => {
function setup(props) {
render(<Upload {...props} />)
render(
<MemoryRouter initialEntries={['/gh/codecov/test']}>
<Route path="/:provider/:owner/:repo">
<QueryClientProvider client={queryClient}>
<Upload {...props} />
</QueryClientProvider>
</Route>
</MemoryRouter>
)
}

describe('renders', () => {
@@ -35,10 +47,9 @@ describe('UploadsCard', () => {
expect(screen.getByText(createDate)).toBeInTheDocument()
})
it('renders a download link', () => {
expect(screen.getByRole('link', { name: /Download/ })).toHaveAttribute(
'href',
'download.com'
)
expect(
screen.getByRole('link', { name: /1234 external-link.svg/ })
).toHaveAttribute('href')
})

it('renders carry-forward text', () => {
14 changes: 13 additions & 1 deletion src/pages/CommitPage/UploadsCard/UploadsCard.spec.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
import { fireEvent, render, screen } from 'custom-testing-library'

import { QueryClient, QueryClientProvider } from 'react-query'
import { MemoryRouter, Route } from 'react-router-dom'

import { useUploads } from './hooks'
import UploadsCard from './UploadsCard'

const queryClient = new QueryClient()
jest.mock('./hooks')

describe('UploadsCard', () => {
function setup(mockUploads) {
useUploads.mockReturnValue(mockUploads)
render(<UploadsCard />)
render(
<MemoryRouter initialEntries={['/gh/codecov/test']}>
<Route path="/:provider/:owner/:repo">
<QueryClientProvider client={queryClient}>
<UploadsCard />
</QueryClientProvider>
</Route>
</MemoryRouter>
)
}

describe('renders', () => {
23 changes: 23 additions & 0 deletions src/services/uploadPresignedUrl/hooks.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { useQuery } from 'react-query'
import { useParams } from 'react-router-dom'

import Api from 'shared/api'

function getPathUploadPresignedUrl({ provider, owner, repo, pathUrl }) {
return `/${provider}/${owner}/${repo}/download?path=${pathUrl}`
}

function fetchUploadPresignedUrl({ provider, owner, repo, pathUrl }) {
const path = getPathUploadPresignedUrl({ provider, owner, repo, pathUrl })
return Api.get({ path, provider }, { useUploadPath: true })
}

export function useUploadPresignedUrl({ pathUrl }) {
const { provider, owner, repo } = useParams()
return useQuery(
['uploadPresignedUrl', provider, owner, repo, pathUrl],
() => {
return fetchUploadPresignedUrl({ provider, owner, repo, pathUrl })
}
)
}
66 changes: 66 additions & 0 deletions src/services/uploadPresignedUrl/hooks.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import { renderHook } from '@testing-library/react-hooks'
import { rest } from 'msw'
import { setupServer } from 'msw/node'
import { QueryClient, QueryClientProvider } from 'react-query'
import { MemoryRouter, Route } from 'react-router-dom'

import { useUploadPresignedUrl } from './hooks'

const downloadUrl =
'v4/raw/2022-06-23/storage_hash/repo_hash/commit_id/file_name.txt'

const queryClient = new QueryClient()
const wrapper = ({ children }) => (
<MemoryRouter initialEntries={['/gh/codecov/test']}>
<Route path="/:provider/:owner/:repo">
<QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
</Route>
</MemoryRouter>
)

const server = setupServer()

beforeAll(() => server.listen())
beforeEach(() => {
server.resetHandlers()
queryClient.clear()
})
afterAll(() => server.close())

describe('useUploadPresignedUrl', () => {
let hookData

function setup() {
server.use(
rest.get(`/upload/gh/codecov/test/download`, (req, res, ctx) => {
return res(ctx.status(200), ctx.text('presigned url'))
})
)
hookData = renderHook(
() => useUploadPresignedUrl({ pathUrl: downloadUrl }),
{
wrapper,
}
)
}

describe('when called', () => {
beforeEach(() => {
setup()
})

it('renders isLoading true', () => {
expect(hookData.result.current.isLoading).toBeTruthy()
})

describe('when data is loaded', () => {
beforeEach(() => {
return hookData.waitFor(() => hookData.result.current.isSuccess)
})

it('returns the data', () => {
expect(hookData.result.current.data).toEqual('presigned url')
})
})
})
})
1 change: 1 addition & 0 deletions src/services/uploadPresignedUrl/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './hooks'
14 changes: 9 additions & 5 deletions src/shared/api/api.js
Original file line number Diff line number Diff line change
@@ -13,11 +13,14 @@ function _fetch({
body,
provider = 'gh',
extraHeaders = {},
useUploadPath,
}) {
const uri = generatePath({ path, query })
const uri = generatePath({ path, query, useUploadPath })
const headers = {
Accept: 'application/json',
'Content-Type': 'application/json; charset=utf-8',
Accept: useUploadPath ? 'text/plain' : 'application/json',
'Content-Type': useUploadPath
? 'text/plain'
: 'application/json; charset=utf-8',
...getHeaders(provider),
...extraHeaders,
}
@@ -30,7 +33,7 @@ function _fetch({
}).then(async (res) => {
let data = null
try {
data = camelizeKeys(await res.json())
data = useUploadPath ? await res.text() : camelizeKeys(await res.json())
} catch {
// nothing to do, body can be empty
}
@@ -45,10 +48,11 @@ function _fetch({
}

function prefillMethod(method) {
return (config) =>
return (config, useUploadPath) =>
_fetch({
...config,
method,
useUploadPath,
})
}

24 changes: 10 additions & 14 deletions src/shared/api/api.test.js
Original file line number Diff line number Diff line change
@@ -31,6 +31,9 @@ const server = setupServer(
const hasTokenType = Boolean(req.headers.get('token-type'))
return res(ctx.status(hasTokenType ? 200 : 401), ctx.json(rawUserData))
}),
rest.get('/upload/test', (req, res, ctx) => {
return res(ctx.status(200), ctx.text('presigned-url'))
}),
rest.post('/internal/test', (req, res, ctx) => {
return res(ctx.status(200), ctx.json(req.body))
}),
@@ -123,25 +126,18 @@ describe('when calling an endpoint with a token', () => {
})
})

describe('when using a post request', () => {
const body = {
test: 'foo',
camel_case: 'snakeCase',
}
describe('when using a get request with upload path', () => {
beforeEach(() => {
return Api.post({
path: '/test',
body,
}).then((data) => {
return Api.get(
{ path: '/test', provider: 'gh' },
{ useUploadPath: true }
).then((data) => {
result = data
})
})

it('returns the data, and transform to camelCase', () => {
expect(result).toEqual({
test: 'foo',
camelCase: 'snakeCase',
})
it('returns data as text', () => {
expect(result).toEqual('presigned-url')
})
})

6 changes: 4 additions & 2 deletions src/shared/api/helpers.js
Original file line number Diff line number Diff line change
@@ -13,8 +13,10 @@ export const ProviderCookieKeyMapping = {
bitbucket: 'bitbucket-token',
}

export function generatePath({ path, query }) {
const baseUrl = `${config.API_URL}/internal`
export function generatePath({ path, query, useUploadPath = false }) {
const baseUrl = useUploadPath
? `${config.API_URL}/upload`
: `${config.API_URL}/internal`
const queryString = qs.stringify(snakeifyKeys(query), {
arrayFormat: 'repeat',
})
6 changes: 6 additions & 0 deletions src/shared/api/helpers.spec.js
Original file line number Diff line number Diff line change
@@ -19,6 +19,12 @@ describe('generatePath', () => {
generatePath({ path: '/epic', query: { rocket: 'league', fort: 'nite' } })
).toStrictEqual(`${config.API_URL}/internal/epic?rocket=league&fort=nite`)
})

it('generates a upload report path when use useUploadPath', () => {
expect(generatePath({ path: '/epic', useUploadPath: true })).toStrictEqual(
`${config.API_URL}/upload/epic`
)
})
})

describe('getHeaders', () => {