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

Bugfix/bai 1464 deleted access request still appearing on the "your reviews" page #1591

Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import AccessRequestModel from '../models/AccessRequest.js'
import { removeAccessRequestReviews } from '../services/review.js'

export async function up() {
const deletedAccessRequests = await (AccessRequestModel as any).findDeleted()
for (const accessRequest of deletedAccessRequests) {
await removeAccessRequestReviews(accessRequest.get('id'))
}
}

export async function down() {
/* NOOP */
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { parse } from '../../../../utils/validate.js'

export const getAccessRequestSchema = z.object({
params: z.object({
modelId: z.string(),
accessRequestId: z.string(),
}),
})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export const patchAccessRequestSchema = z.object({
metadata: accessRequestMetadata,
}),
params: z.object({
modelId: z.string(),
accessRequestId: z.string(),
}),
})
Expand Down
4 changes: 3 additions & 1 deletion backend/src/services/accessRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { convertStringToId } from '../utils/id.js'
import { authResponseToUserPermission } from '../utils/permissions.js'
import log from './log.js'
import { getModelById } from './model.js'
import { createAccessRequestReviews } from './review.js'
import { createAccessRequestReviews, removeAccessRequestReviews } from './review.js'
import { getSchemaById } from './schema.js'
import { sendWebhooks } from './webhook.js'

Expand Down Expand Up @@ -91,6 +91,8 @@ export async function removeAccessRequest(user: UserInterface, accessRequestId:

await accessRequest.delete()

await removeAccessRequestReviews(accessRequestId)

return { accessRequestId }
}

Expand Down
24 changes: 22 additions & 2 deletions backend/src/services/review.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { ReleaseDoc } from '../models/Release.js'
import Review, { ReviewDoc, ReviewInterface } from '../models/Review.js'
import { UserInterface } from '../models/User.js'
import { ReviewKind, ReviewKindKeys } from '../types/enums.js'
import { BadReq, NotFound } from '../utils/error.js'
import { BadReq, InternalError, NotFound } from '../utils/error.js'
import log from './log.js'
import { getModelById } from './model.js'
import { requestReviewForAccessRequest, requestReviewForRelease } from './smtp/smtp.js'
Expand Down Expand Up @@ -89,6 +89,26 @@ export async function createAccessRequestReviews(model: ModelDoc, accessRequest:
await Promise.all(createReviews)
}

export async function removeAccessRequestReviews(accessRequestId: string) {
// finding and then calling potentially multiple deletes is inefficient but the mongoose-softdelete
// plugin doesn't cover bulkDelete
const accessRequestReviews = await findReviewsForAccessRequests([accessRequestId])

const deletions: ReviewDoc[] = []
for (const accessRequestReview of accessRequestReviews) {
try {
deletions.push(await accessRequestReview.delete())
} catch (error) {
throw InternalError('The requested access request review could not be deleted.', {
accessRequestId,
error,
})
}
}

return deletions
}

export async function findReviewForResponse(
user: UserInterface,
modelId: string,
Expand Down Expand Up @@ -135,7 +155,7 @@ export async function findReviewForResponse(

//TODO This won't work for response refactor
export async function findReviewsForAccessRequests(accessRequestIds: string[]) {
const reviews = await Review.find({
const reviews: ReviewDoc[] = await Review.find({
accessRequestId: accessRequestIds,
})
return reviews.filter((review) => requiredRoles.accessRequest.includes(review.role))
Expand Down
20 changes: 20 additions & 0 deletions backend/test/services/__snapshots__/review.spec.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,23 @@ exports[`services > review > findReviews > all reviews for user 2`] = `
},
]
`;

exports[`services > review > findReviewsForAccessRequests > success 1`] = `
[
{
"accessRequestId": [
"Hello",
],
},
]
`;

exports[`services > review > removeAccessRequestReviews > successful 1`] = `
[
{
"accessRequestId": [
"Hello",
],
},
]
`;
1 change: 1 addition & 0 deletions backend/test/services/accessRequest.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ vi.mock('../../src/models/AccessRequest.js', () => ({ default: accessRequestMode
const mockReviewService = vi.hoisted(() => {
return {
createAccessRequestReviews: vi.fn(),
removeAccessRequestReviews: vi.fn(),
}
})
vi.mock('../../src/services/review.js', () => mockReviewService)
Expand Down
36 changes: 33 additions & 3 deletions backend/test/services/review.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,34 @@ import { describe, expect, test, vi } from 'vitest'
import AccessRequest from '../../src/models/AccessRequest.js'
import Model from '../../src/models/Model.js'
import Release from '../../src/models/Release.js'
import { createAccessRequestReviews, createReleaseReviews, findReviews } from '../../src/services/review.js'
import {
createAccessRequestReviews,
createReleaseReviews,
findReviews,
findReviewsForAccessRequests,
removeAccessRequestReviews,
} from '../../src/services/review.js'

vi.mock('../../src/connectors/authorisation/index.js')
vi.mock('../../src/connectors/authentication/index.js', async () => ({
default: { getEntities: vi.fn(() => ['user:test']) },
}))

const reviewModelMock = vi.hoisted(() => {
const obj: any = { kind: 'access', accessRequestId: 'Hello' }
const obj: any = { kind: 'access', accessRequestId: 'Hello', role: 'msro' }

obj.aggregate = vi.fn(() => obj)
obj.match = vi.fn(() => obj)
obj.sort = vi.fn(() => obj)
obj.lookup = vi.fn(() => obj)
obj.append = vi.fn(() => obj)
obj.find = vi.fn(() => obj)
obj.find = vi.fn(() => [obj])
obj.findOne = vi.fn(() => obj)
obj.findOneAndUpdate = vi.fn(() => obj)
obj.findByIdAndUpdate = vi.fn(() => obj)
obj.updateOne = vi.fn(() => obj)
obj.save = vi.fn(() => obj)
obj.delete = vi.fn(() => obj)
obj.limit = vi.fn(() => obj)
obj.unwind = vi.fn(() => obj)
obj.at = vi.fn(() => obj)
Expand Down Expand Up @@ -84,6 +91,12 @@ describe('services > review', () => {
expect(reviewModelMock.match.mock.calls.at(1)).toMatchSnapshot()
})

test('findReviewsForAccessRequests > success', async () => {
await findReviewsForAccessRequests([reviewModelMock.accessRequestId])

expect(reviewModelMock.find.mock.calls.at(0)).toMatchSnapshot()
})

test('createReleaseReviews > No entities found for required roles', async () => {
const result: Promise<void> = createReleaseReviews(new Model(), new Release())

Expand Down Expand Up @@ -111,4 +124,21 @@ describe('services > review', () => {
expect(reviewModelMock.save).toBeCalled()
expect(smtpMock.requestReviewForAccessRequest).toBeCalled()
})

test('removeAccessRequestReviews > successful', async () => {
await removeAccessRequestReviews(reviewModelMock.accessRequestId)

expect(reviewModelMock.find.mock.calls.at(0)).toMatchSnapshot()
expect(reviewModelMock.delete).toBeCalled()
})

test('removeAccessRequestReviews > could not delete failure', async () => {
reviewModelMock.delete.mockImplementationOnce(() => {
throw Error('Error deleting object')
})

expect(() => removeAccessRequestReviews('')).rejects.toThrowError(
/^The requested access request review could not be deleted./,
)
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
useGetAccessRequestsForModelId,
} from 'actions/accessRequest'
import { useGetModel } from 'actions/model'
import { useGetReviewRequestsForUser } from 'actions/review'
import { useGetSchema } from 'actions/schema'
import { useGetCurrentUser } from 'actions/user'
import { useRouter } from 'next/router'
Expand Down Expand Up @@ -44,6 +45,7 @@ export default function EditableAccessRequestForm({
const { schema, isSchemaLoading, isSchemaError } = useGetSchema(accessRequest.schemaId)
const { isAccessRequestError, mutateAccessRequest } = useGetAccessRequest(accessRequest.modelId, accessRequest.id)
const { mutateAccessRequests } = useGetAccessRequestsForModelId(accessRequest.modelId)
const { mutateReviews } = useGetReviewRequestsForUser()
const { model, isModelLoading, isModelError } = useGetModel(accessRequest.modelId, EntryKind.MODEL)
const { currentUser, isCurrentUserLoading, isCurrentUserError } = useGetCurrentUser()

Expand All @@ -66,16 +68,17 @@ export default function EditableAccessRequestForm({
}, [accessRequest.metadata.overview.entities, currentUser, currentUserRoles])

const handleDeleteConfirm = useCallback(async () => {
setErrorMessage('')
setDeleteErrorMessage('')
const res = await deleteAccessRequest(accessRequest.modelId, accessRequest.id)
if (!res.ok) {
setDeleteErrorMessage(await getErrorMessage(res))
} else {
mutateAccessRequests()
mutateReviews()
setOpen(false)
router.push(`/model/${accessRequest.modelId}?tab=access`)
}
}, [mutateAccessRequests, accessRequest, router])
}, [accessRequest.modelId, accessRequest.id, mutateAccessRequests, mutateReviews, router])

async function handleSubmit() {
if (schema) {
Expand Down Expand Up @@ -122,6 +125,10 @@ export default function EditableAccessRequestForm({
resetForm()
}

function handleDelete() {
setOpen(true)
}

useEffect(() => {
resetForm()
}, [resetForm])
Expand Down Expand Up @@ -173,7 +180,7 @@ export default function EditableAccessRequestForm({
onEdit={handleEdit}
onCancel={handleCancel}
onSubmit={handleSubmit}
onDelete={() => setOpen(true)}
onDelete={handleDelete}
errorMessage={errorMessage}
showDeleteButton
/>
Expand Down
Loading