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.

Sign up for GitHub

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

Feature/zars 685 rename proposal pdfs #33

Merged
merged 7 commits into from
Jan 9, 2025
Merged

Feature/zars 685 rename proposal pdfs #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
887005b
[ZARS-669][ADD]update ndoe
af-egr Dec 10, 2024
c7dc7b7
[ZARS-669][ADD]update node version in github actions
af-egr Dec 10, 2024
9d0c610
[ZARS][ADD]update nvmrc
af-egr Dec 11, 2024
35a7b9c
[ZARS-685][ADD] rename pdf proposals
af-egr Dec 11, 2024
c6188d1
[ZARS-685][ADD] add base path for proposals
af-egr Dec 11, 2024
8832158
Merge branch 'main' into feature/ZARS-685_rename_proposal_pdfs
af-egr Dec 13, 2024
bb8eded
[ZARS-685][DELETE] rollback changes for s3 proposal name
af-egr Dec 13, 2024
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
79 changes: 43 additions & 36 deletions src/modules/proposal/services/__tests__/proposal-misc.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,15 @@ describe('ProposalMiscService', () => {
} as FdpgRequest;

const proposalId = 'proposalId';
const projectAbbreviation = 'projectAbbreviation';
const researcher = {
_id: 'userId',
email: '[email protected]',
};
const participant = { researcher, participantCategory: ParticipantType.ProjectLeader };
const proposalContent = {
_id: proposalId,
projectAbbreviation: 'projectAbbreviation',
projectAbbreviation,
status: ProposalStatus.FdpgCheck,
participants: [participant],
userProject: {
Expand Down Expand Up @@ -237,8 +238,8 @@ describe('ProposalMiscService', () => {
expect(result[0].isRegistrationComplete).toEqual(true);
expect(result[0].username).toEqual('username');

expect(proposalCrudService.findDocument).toBeCalledWith(proposalId, request.user);
expect(keycloakService.getUsers).toBeCalledWith({ email: researcher.email, exact: true });
expect(proposalCrudService.findDocument).toHaveBeenCalledWith(proposalId, request.user);
expect(keycloakService.getUsers).toHaveBeenCalledWith({ email: researcher.email, exact: true });
});
});

Expand All @@ -256,11 +257,11 @@ describe('ProposalMiscService', () => {

await proposalMiscService.setStatus(proposalId, newStatus, request.user);

expect(proposalCrudService.findDocument).toBeCalledWith(proposalId, request.user, undefined, true);
expect(validateStatusChange).toBeCalledWith(proposalDocument, newStatus, request.user);
expect(statusChangeService.handleEffects).toBeCalledWith(expectedDocument, oldStatus, request.user);
expect(addHistoryItemForStatus).toBeCalledWith(expectedDocument, request.user, oldStatus);
expect(eventEngineService.handleProposalStatusChange).toBeCalledWith(
expect(proposalCrudService.findDocument).toHaveBeenCalledWith(proposalId, request.user, undefined, true);
expect(validateStatusChange).toHaveBeenCalledWith(proposalDocument, newStatus, request.user);
expect(statusChangeService.handleEffects).toHaveBeenCalledWith(expectedDocument, oldStatus, request.user);
expect(addHistoryItemForStatus).toHaveBeenCalledWith(expectedDocument, request.user, oldStatus);
expect(eventEngineService.handleProposalStatusChange).toHaveBeenCalledWith(
expect.objectContaining({ status: newStatus }),
);
});
Expand All @@ -278,11 +279,11 @@ describe('ProposalMiscService', () => {

await proposalMiscService.setStatus(proposalId, newStatus, request.user);

expect(proposalCrudService.findDocument).toBeCalledWith(proposalId, request.user, undefined, true);
expect(validateStatusChange).not.toBeCalledWith(proposalDocument, newStatus, request.user);
expect(statusChangeService.handleEffects).not.toBeCalledWith(expectedDocument, oldStatus, request.user);
expect(addHistoryItemForStatus).not.toBeCalledWith(expectedDocument, request.user, oldStatus);
expect(eventEngineService.handleProposalStatusChange).not.toBeCalledWith(
expect(proposalCrudService.findDocument).toHaveBeenCalledWith(proposalId, request.user, undefined, true);
expect(validateStatusChange).not.toHaveBeenCalledWith(proposalDocument, newStatus, request.user);
expect(statusChangeService.handleEffects).not.toHaveBeenCalledWith(expectedDocument, oldStatus, request.user);
expect(addHistoryItemForStatus).not.toHaveBeenCalledWith(expectedDocument, request.user, oldStatus);
expect(eventEngineService.handleProposalStatusChange).not.toHaveBeenCalledWith(
expect.objectContaining({ status: newStatus }),
);
});
Expand Down Expand Up @@ -313,15 +314,15 @@ describe('ProposalMiscService', () => {
const flushPromises = () => new Promise(setImmediate);
await flushPromises();

expect(proposalCrudService.findDocument).toBeCalledTimes(2);
expect(feasibilityService.getQueryContentById).toBeCalledWith(feasibilityId);
expect(getBlobName).toBeCalledWith(proposalId, UseCaseUpload.FeasibilityQuery);
expect(proposalCrudService.findDocument).toHaveBeenCalledTimes(2);
expect(feasibilityService.getQueryContentById).toHaveBeenCalledWith(feasibilityId);
expect(getBlobName).toHaveBeenCalledWith(proposalId, UseCaseUpload.FeasibilityQuery);

const expectedFile = expect.objectContaining({
originalname: 'Machbarkeits-Anfrage.json',
mimetype: SupportedMimetype.Json,
});
expect(storageService.uploadFile).toBeCalledWith('blobName', expectedFile, request.user);
expect(storageService.uploadFile).toHaveBeenCalledWith('blobName', expectedFile, request.user);
});

it('should set status for LocationCheck and get the pdf', async () => {
Expand Down Expand Up @@ -349,20 +350,20 @@ describe('ProposalMiscService', () => {
const flushPromises = () => new Promise(setImmediate);
await flushPromises();

expect(proposalCrudService.findDocument).toBeCalledTimes(2);
expect(proposalCrudService.findDocument).toHaveBeenCalledTimes(2);

const expectedDataPrivacy = [{ headline: 'headlineDE', text: 'textDE' }];
expect(pdfEngineService.createProposalPdf).toBeCalledWith(
expect(pdfEngineService.createProposalPdf).toHaveBeenCalledWith(
expect.objectContaining({ projectAbbreviation: proposalDocument.projectAbbreviation }),
expectedDataPrivacy,
);

const expectedFile = expect.objectContaining({
originalname: `${proposalDocument.projectAbbreviation}.pdf`,
originalname: `${proposalDocument.projectAbbreviation}_proposal.pdf`,
mimetype: SupportedMimetype.Pdf,
});
expect(storageService.uploadFile).toBeCalledWith('blobName', expectedFile, request.user);
expect(addUpload).toBeCalledWith(proposalDocument, expect.anything());
expect(storageService.uploadFile).toHaveBeenCalledWith('blobName', expectedFile, request.user);
expect(addUpload).toHaveBeenCalledWith(proposalDocument, expect.anything());
});
});

Expand All @@ -386,10 +387,10 @@ describe('ProposalMiscService', () => {

await proposalMiscService.getPdfProposalFile(proposalId, request.user);

expect(proposalCrudService.findDocument).toBeCalledTimes(1);
expect(proposalCrudService.findDocument).toHaveBeenCalledTimes(1);

const expectedDataPrivacy = [{ headline: 'headlineDE', text: 'textDE' }];
expect(pdfEngineService.createProposalPdf).toBeCalledWith(
expect(pdfEngineService.createProposalPdf).toHaveBeenCalledWith(
expect.objectContaining({ projectAbbreviation: proposalDocument.projectAbbreviation }),
expectedDataPrivacy,
);
Expand All @@ -410,8 +411,14 @@ describe('ProposalMiscService', () => {
proposalCrudService.findDocument.mockResolvedValueOnce(proposalDocument);

await proposalMiscService.setIsLockedStatus(proposalId, true, request.user);
expect(addHistoryItemForProposalLock).toBeCalledWith(expectedDocument, request.user, expectedDocument.isLocked);
expect(eventEngineService.handleProposalLockChange).toBeCalledWith(expect.objectContaining({ isLocked: true }));
expect(addHistoryItemForProposalLock).toHaveBeenCalledWith(
expectedDocument,
request.user,
expectedDocument.isLocked,
);
expect(eventEngineService.handleProposalLockChange).toHaveBeenCalledWith(
expect.objectContaining({ isLocked: true }),
);
});

it('should ignore the same status', async () => {
Expand All @@ -426,12 +433,12 @@ describe('ProposalMiscService', () => {
proposalCrudService.findDocument.mockResolvedValueOnce(proposalDocument);

await proposalMiscService.setIsLockedStatus(proposalId, true, request.user);
expect(addHistoryItemForProposalLock).not.toBeCalledWith(
expect(addHistoryItemForProposalLock).not.toHaveBeenCalledWith(
expectedDocument,
request.user,
expectedDocument.isLocked,
);
expect(eventEngineService.handleProposalLockChange).not.toBeCalledWith(
expect(eventEngineService.handleProposalLockChange).not.toHaveBeenCalledWith(
expect.objectContaining({ isLocked: true }),
);
});
Expand All @@ -445,8 +452,8 @@ describe('ProposalMiscService', () => {

await proposalMiscService.setFdpgChecklist(proposalId, checklist, request.user);

expect(validateFdpgCheckStatus).toBeCalledWith(proposalDocument);
expect(addFdpgChecklist).toBeCalledWith(proposalDocument, checklist);
expect(validateFdpgCheckStatus).toHaveBeenCalledWith(proposalDocument);
expect(addFdpgChecklist).toHaveBeenCalledWith(proposalDocument, checklist);
expect(proposalDocument.save).toBeCalled();
});
});
Expand All @@ -464,15 +471,15 @@ describe('ProposalMiscService', () => {

await proposalMiscService.markSectionAsDone(proposalId, sectionId, true, request.user);

expect(proposalCrudService.findDocument).toBeCalledWith(proposalId, request.user);
expect(proposalDocument.save).toBeCalled();
expect(findByKeyNested).toBeCalledWith(
expect(proposalCrudService.findDocument).toHaveBeenCalledWith(proposalId, request.user);
expect(proposalDocument.save).toHaveBeenCalled();
expect(findByKeyNested).toHaveBeenCalledWith(
expect.objectContaining({ projectAbbreviation: 'projectAbbreviation' }),
'_id',
sectionId,
);

expect(proposalDocument.set).toBeCalledWith('path.to.key.isDone', true);
expect(proposalDocument.set).toHaveBeenCalledWith('path.to.key.isDone', true);
});

it('should throw when section is not found', async () => {
Expand Down Expand Up @@ -503,8 +510,8 @@ describe('ProposalMiscService', () => {

await proposalMiscService.setFdpgCheckNotes(proposalId, text, request.user);

expect(validateFdpgCheckStatus).toBeCalledWith(proposalDocument);
expect(proposalDocument.save).toBeCalled();
expect(validateFdpgCheckStatus).toHaveBeenCalledWith(proposalDocument);
expect(proposalDocument.save).toHaveBeenCalled();
});
});
});
2 changes: 1 addition & 1 deletion src/modules/proposal/services/proposal-misc.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ export class ProposalMiscService {
const pdfBuffer = await this.createPdfBuffer(proposal, dataPrivacyTextForUsage);
const pdfFile: Express.Multer.File = {
buffer: pdfBuffer,
originalname: `${proposal.projectAbbreviation}.pdf`,
originalname: `${proposal.projectAbbreviation}_proposal.pdf`,
mimetype: SupportedMimetype.Pdf,
size: Buffer.byteLength(pdfBuffer),
} as Express.Multer.File;
Expand Down
8 changes: 7 additions & 1 deletion src/modules/proposal/utils/proposal.utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,14 @@ import { Proposal } from '../schema/proposal.schema';
import { UploadDto } from '../dto/upload.dto';
import { ReportDto } from '../dto/proposal/report.dto';

const getBasePath = (proposalId: string, type: UploadType): string => `proposal/${proposalId}/${type}/`;

const getSubPath = (subId?: string): string => {
return subId ? subId + '/' : '';
};

export const getBlobName = (proposalId: string, type: UploadType, subId?: string): string => {
return `proposal/${proposalId}/${type}/${subId ? subId + '/' : ''}${uuid()}`;
return `${getBasePath(proposalId, type)}${getSubPath(subId)}${uuid()}`;
};

export const addUpload = (proposal: Proposal, upload: UploadDto): void => {
Expand Down
Loading