Pdf export feature #2331

chesterkmr · 2024-05-01T09:53:48Z

User description

Description

Implemented certificate generation for cases.

Sample PDF

certificate).pdf
empty states .pdf

Type

enhancement

Description

Added various PDF rendering logics for different types of data including company ownership, sanctions, identity verifications, and more.
Implemented a new component CaseOptions with functionality to download PDF certificates.
Introduced an abstract class IPDFRenderer to standardize PDF rendering operations.
Enhanced several components and hooks to support new features related to PDF handling and customer data management.

Changes walkthrough

Relevant files

Enhancement

14 files

svg-to-png.ts `Add SVG to PNG Conversion Utility` apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts Added a new utility function `svgToPng` to convert SVG images to PNG format.	+23/-0
fetchers.ts `Refactor Customer Data Schema Definition` apps/backoffice-v2/src/domains/customer/fetchers.ts Refactored the schema definition for customer data into a separate constant `CustomerSchema`. Updated the `fetchCustomer` function to use the new `CustomerSchema`.	+19/-15
fetchers.ts `Enhance Workflow Fetchers with New Schemas and Fields` apps/backoffice-v2/src/domains/workflows/fetchers.ts Added imports and adjusted the order of existing imports. Introduced new schema `WorkflowDefinitionByIdSchema` and `AmlSchema`. Added a new optional field `childWorkflows` to `BaseWorkflowByIdSchema`.	+8/-7
useUbosRegistryProvidedBlock.tsx `Export Ubo Type from useUbosRegistryProvidedBlock Hook` apps/backoffice-v2/src/lib/blocks/hooks/useUbosRegistryProvidedBlock/useUbosRegistryProvidedBlock.tsx Changed the type `Ubo` from local to exported.	+3/-3
Case.Actions.tsx `Integrate CaseOptions Component into Case Actions` apps/backoffice-v2/src/pages/Entity/components/Case/Case.Actions.tsx Added import for `CaseOptions`. Modified class names to adjust layout. Integrated `CaseOptions` component into the UI.	+3/-1
CaseOptions.tsx `Implement CaseOptions Component with PDF Download` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/CaseOptions.tsx Implemented `CaseOptions` component with dropdown menu for downloading PDF certificates.	+27/-0
company-ownership-page.pdf.tsx `Add Company Ownership PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/company-ownership-page.pdf.tsx Added PDF rendering logic for company ownership data.	+50/-0
company-sanctions-page.pdf.tsx `Add Company Sanctions PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/company-sanctions-page.pdf.tsx Added PDF rendering logic for company sanctions data.	+55/-0
identity-verifications-page.pdf.tsx `Add Identity Verifications PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/identity-verifications-page.pdf.tsx Added PDF rendering logic for identity verifications data.	+69/-0
individual-sanctions-page.pdf.tsx `Add Individual Sanctions PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/individual-sanctions-page.pdf.tsx Added PDF rendering logic for individual sanctions data.	+119/-0
pdf-renderer.abstract.ts `Introduce Abstract PDF Renderer Class` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/pdf-renderer.abstract.ts Introduced an abstract class `IPDFRenderer` for PDF rendering operations.	+19/-0
registry-page.pdf.tsx `Add Registry Page PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx Added PDF rendering logic for registry page data.	+82/-0
title-page.pdf.tsx `Add Title Page PDF Rendering Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/title-page.pdf.tsx Added PDF rendering logic for title page data.	+32/-0
useCaseOptionsLogic.tsx `Implement PDF Certificate Generation and Download Logic` apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/useCaseOptionsLogic.tsx Implemented logic for generating and downloading a PDF certificate.	+72/-0

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

Summary by CodeRabbit

New Features
- Added PDF generation capabilities for various document types like company ownership, company sanctions, identity verifications, and individual sanctions.
- Introduced new CaseOptions component with dropdown menu for generating and opening PDF certificates.
- Added support for displaying error messages specific to PDF certificate opening.
Bug Fixes
- Improved styling for case actions to better distribute space and align elements.
Documentation
- Added new translations for error messages related to PDF certificates.
Refactor
- Updated schema organization and usage for workflows and customer data.
- Streamlined import and export statements across multiple files for better modularity.
Chores
- Updated dependencies for better PDF rendering and utility functions.

changeset-bot · 2024-05-01T09:53:51Z

⚠️ No Changeset found

Latest commit: 85c6f4c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2024-05-01T09:54:09Z

Walkthrough

Recent updates to the backoffice-v2 and services/workflows-service modules include significant enhancements like new PDF generation capabilities, streamlined workflows, and schema reorganizations. Dependencies were added to enhance PDF rendering, with added support for handling intricate workflow data. Adjustments in imports, abstracts, and utility functions aim at improving code structure and functionality, particularly around PDF management and workflow definitions.

Changes

File/Directory	Summary
`apps/backoffice-v2/package.json`	Added dependencies: `@ballerine/react-pdf-toolkit`, `@react-pdf/renderer`, `lodash`, `@types/lodash`.
`src/domains/workflows/fetchers.ts`	Reorganized imports, added types, modified schemas, updated `fetchWorkflowById` function.
`src/pages/Entity/components/Case/Case.Actions.tsx`	Modified imports and styling classes.
`public/locales/en/toast.json`	Added new key-value pair for error message regarding PDF certificate opening failure.
`src/common/utils/svg-to-png/svg-to-png.ts`	Introduced `svgToPng` function.
`src/common/utils/value-or-none/value-or-none.ts`	Introduced `valueOrNone` function using `valueOrFallback`.
`src/domains/customer/fetchers.ts`	Organized schema declaration into a separate constant, updated schema usage in `fetchCustomer`.
`src/lib/blocks/hooks/useUbosRegistryProvidedBlock/useUbosRegistryProvidedBlock.tsx`	Exported the `Ubo` type.
`src/main.tsx`	Imported and called `registerFont` from new dependencies.
`src/pages/Entity/components/Case/components/CaseOptions/CaseOptions.tsx`	Introduced `CaseOptions` component for PDF certificate management.
`src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic.tsx`	Introduced `useCaseOptionsLogic` hook for handling case options logic.
`src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/...`	Various PDF renderer classes and hooks introduced for generating and validating different PDF pages.
`src/pages/Entity/pdfs/case-information/pages/TitlePage/index.ts`	Exported `TitlePage` component for PDF document generation.
`services/workflows-service/scripts/seed.ts`	Introduced new imports and rearranged function calls for workflow and transaction generation.
`services/workflows-service/prisma/data-migrations`	Updated subproject commit reference.

Poem

In lines of code and schemas fine,
New structures, dependencies align,
PDFs rendered with precision keen,
Fetchers, schemas now smoothly streamline.
Seed scripts dance in digital breeze,
With updates swift, like summer leaves.
Hooray to these changes, full of grace,
Our code now strides at a faster pace.

🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-05-01T09:55:49Z

PR Description updated to latest commit (da3d438)

github-actions · 2024-05-01T09:55:56Z

PR Description updated to latest commit (da3d438)

github-actions · 2024-05-01T09:56:46Z

PR Review

(Review updated until commit `8f21348`)

⏱️ Estimated effort to review [1-5]	4, due to the extensive changes across multiple files involving complex logic related to PDF generation and data handling. The PR introduces new components, utilities, and modifies existing structures which require careful review to ensure functionality and integration.
🧪 Relevant tests	No
🔍 Possible issues	Possible Bug: The canvas element created in `svgToPng` is not appended to the document before being removed, which could lead to errors or unexpected behavior.
🔍 Possible issues	Data Handling Concern: The data extraction and transformation logic in PDF rendering classes are quite complex and tightly coupled with specific data structures, which might lead to maintenance challenges or bugs if the data structure changes.
🔒 Security concerns	No

Code feedback:

relevant file	apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts
suggestion	Consider appending the canvas to the document body before removing it to avoid potential errors in the DOM manipulation process. This change ensures that the canvas element is properly managed in the DOM lifecycle. [important]
relevant line	document.body.removeChild(canvas);

relevant file	apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/company-ownership-page.pdf.tsx
suggestion	Implement error handling for data validation in the `isValid` method to manage exceptions or errors that may occur during the schema validation process. This will improve the robustness of the PDF rendering process. [important]
relevant line	CompanyOwnershipSchema.parse(data);

relevant file	apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/pdf-renderer.abstract.ts
suggestion	Add error handling for the `svgToPng` call within `getLogoUrl` to gracefully handle cases where the logo URL might be invalid or the conversion fails. This prevents the entire PDF generation process from failing due to issues with logo conversion. [important]
relevant line	return svgToPng(this.customer?.logoImageUri \|\| '');

relevant file	apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/useCaseOptionsLogic.tsx
suggestion	Refactor the `genereateAndDownloadPDFCertificate` function to separate concerns, such as data preparation, PDF generation, and file handling, into distinct functions or methods. This enhances readability and maintainability. [medium]
relevant line	const genereateAndDownloadPDFCertificate = useCallback(async () => {

✨ Review tool usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

github-actions · 2024-05-01T09:56:48Z

Persistent review updated to latest commit 8f21348

github-actions · 2024-05-01T09:58:04Z

PR Code Suggestions

Category	Suggestions
Bug	Ensure the canvas is added to the document before removal to prevent errors. It's important to add the newly created canvas element to the document body before calling `removeChild` to avoid a potential error if the canvas is not found in the document. This ensures that the canvas is part of the DOM when attempting to remove it. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [16] +document.body.appendChild(canvas); document.body.removeChild(canvas);
	Rename the static property to correctly represent its content. The `PDF_NAME` static property is misleadingly named 'titlePage' which might be a copy-paste error from another renderer. It should be renamed to reflect the actual content it represents, such as 'registryPage'. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [11] -static PDF_NAME = 'titlePage'; +static PDF_NAME = 'registryPage';
	Add null check in `isEmpty` method to prevent potential runtime errors. The method `isEmpty` should handle cases where `data` might be `null` or `undefined` to prevent runtime errors. You should add a check at the beginning of the method to return `true` if `data` is falsy. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [58] private isEmpty(data: TRegistryInformationData) { + if (!data) return true; const values = [ data.registrationNumber, data.incorporationDate, data.companyType, data.companyStatus, data.registrationAddress, data.registryPage, data.lastUpdate, data.registeredAt, ];
Best practice	Clean up image resources to prevent memory leaks. To prevent potential memory leaks, it's advisable to clean up the `img` element by nullifying its `src` and removing event listeners after the image is loaded or if an error occurs. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [21] +img.onload = () => { + // existing onload code + img.src = ''; + img.onload = null; + img.onerror = null; +}; +img.onerror = error => { + // existing onerror code + img.src = ''; + img.onload = null; + img.onerror = null; +}; img.src = imageUrl;
	Enforce the implementation of `PDF_NAME` in subclasses to prevent runtime errors. To ensure that the `PDF_NAME` static property is not accidentally left unassigned in subclasses, consider making `PDF_NAME` an abstract getter in the `IPDFRenderer` class. This enforces that each subclass must provide its own implementation. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/pdf-renderer.abstract.ts [6] -static PDF_NAME: string; +abstract get PDF_NAME(): string;
	Use predefined style objects to enhance performance and code clarity. Replace inline style definitions with a predefined style object to improve readability and performance by reducing the object creation overhead on each render. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [22] -<View style={tw('mb-3')}> +const viewStyle = tw('mb-3'); +... +<View style={viewStyle}>
	Standardize the date format string across the application for consistency. Use a constant for the date format string used in the subtitle of `CaseInformationPageSectionHeader` to ensure consistency across different components or files. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [31] -subtitle={`Check conducted at: ${new Date().toISOString()}`} +const DATE_FORMAT = 'yyyy-MM-ddTHH:mm:ss.sssZ'; +... +subtitle={`Check conducted at: ${new Date().toISOString(DATE_FORMAT)}`}
	Define a constant for common text styles to reduce duplication and ease future modifications. Use a constant for repeated style values to avoid duplication and facilitate easier updates or theming in the future. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [26-72] -<Typography styles={[tw('text-[8px] leading-[1.45rem]')]} weight="bold"> +<Typography styles={[commonTextStyle]} weight="bold">
	Replace hardcoded widths with responsive design or theming system for better adaptability and consistency. Avoid using hardcoded widths in the styles. Consider using a responsive design approach or a theming system to handle different screen sizes and maintain consistency across the application. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [25-126] -<View style={tw('w-[80px]')}> -<View style={tw('w-[400px]')}> +<View style={tw('w-small')}> +<View style={tw('w-large')}>
Enhancement	Improve type safety by specifying a more detailed schema for `childWorkflows`. Consider using a more specific type than `z.any()` for the `childWorkflows` field in the schema to enhance type safety and validation. apps/backoffice-v2/src/domains/customer/fetchers.ts [97] -childWorkflows: z.any().optional(), +childWorkflows: z.array(z.object({ + id: z.string(), + status: z.enum(['Active', 'Inactive']), + // Add more specific fields here +})).optional(),
Usability	Enhance user feedback by disabling the options button during PDF generation. To improve user experience, consider disabling the button while the PDF is generating, providing feedback that an operation is in progress. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/CaseOptions.tsx [14] -<Button variant="outline">Options</Button> +<Button variant="outline" disabled={isGeneratingPDF}>{isGeneratingPDF ? 'Generating...' : 'Options'}</Button>
Maintainability	Refactor data extraction to a separate method to improve code clarity and maintainability. The `getData` method uses multiple `get` calls with default values that could be simplified or managed more cleanly using a utility function or by restructuring the data access pattern to reduce redundancy and improve maintainability. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [23-49] -const pdfData: TRegistryInformationData = { - companyName: get(this.workflow.context, 'entity.data.companyName', ''), - creationDate: new Date(), - logoUrl: await this.getLogoUrl(), - registrationNumber: get(this.workflow.context, 'entity.data.registrationNumber', ''), - incorporationDate: get( - this.workflow.context, - 'entity.data.additionalInfo.dateOfEstablishment', - null, - ), - companyType: get(this.workflow.context, 'entity.data.businessType', ''), - companyStatus: get(this.workflow.context, 'entity.data.status', ''), - registrationAddress: [ - get(this.workflow.context, 'entity.data.headquarters.street', ''), - get(this.workflow.context, 'entity.data.headquarters.streetNumber', ''), - get(this.workflow.context, 'entity.data.headquarters.city', ''), - get(this.workflow.context, 'entity.data.headquarters.country', ''), - get(this.workflow.context, 'entity.data.headquarters.postalCode', ''), - ] - .filter(Boolean) - .join(', '), - registryPage: get(this.workflow.context, 'entity.data.registryPage', ''), - lastUpdate: new Date(), - registeredAt: get(this.workflow.context, 'entity.data.registeredAt', ''), -}; +const pdfData: TRegistryInformationData = this.extractPDFData();
	Refactor inline filtering logic into a separate utility function for better reusability and testability. Extract the inline function for filtering valid URLs to a separate utility function to improve code reusability and testing. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [63] -sources={item.sources.filter(source => isValidUrl(source))} +sources={filterValidUrls(item.sources)}
	Improve code readability by using more descriptive variable names. Consider using a more descriptive variable name than `tw` for the Tailwind CSS utility function to enhance code readability. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [22] -style={tw('mb-3')} +style={tailwind('mb-3')}
	Replace inline date formatting with a utility function to enhance maintainability and consistency. Consider using a utility function to format dates instead of repeating `new` `Date(date).toISOString()` inline. This will improve code maintainability and make it easier to apply consistent date formatting or adjustments across your application. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [31-97] -<ValueOrNone value={checkDate ? new Date(checkDate).toISOString() : undefined} /> -<ValueOrNone value={dateOfBirth ? new Date(dateOfBirth).toISOString() : undefined} /> +<ValueOrNone value={formatDate(checkDate)} /> +<ValueOrNone value={formatDate(dateOfBirth)} />
	Refactor status-based conditional rendering into a separate component for clarity and reusability. Refactor the repeated conditional rendering of `Typography` components for different statuses into a separate function or component. This will make the code cleaner and more modular. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [41-56] -{status === 'approved' && ( - <Typography - styles={[tw('text-[8px] leading-[1.45rem] text-[#00BD59]')]} - weight="bold" - > - Approved - </Typography> -)} -{status === 'rejected' && ( - <Typography - styles={[tw('text-[8px] leading-[1.45rem] text-[#DF2222]')]} - weight="bold" - > - Rejected - </Typography> -)} +<StatusTypography status={status} />
	Extract repeated view structures into a separate component to enhance code modularity and readability. Extract the repeated `View` structure used for displaying attributes into a separate component to reduce code duplication and improve readability. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [24-32] -<View style={tw('flex flex-row')}> - <View style={tw('w-[80px]')}> - <Typography styles={[tw('text-[8px] leading-[1.45rem]')]} weight="bold"> - Checked at - </Typography> - </View> - <View style={tw('w-[400px]')}> - <ValueOrNone value={checkDate ? new Date(checkDate).toISOString() : undefined} /> - </View> -</View> +<AttributeRow label="Checked at" value={formatDate(checkDate)} />
Error handling	Add error handling in the `isValid` method to manage exceptions gracefully. The `isValid` method should handle potential exceptions thrown by `TitlePageSchema.parse(data)` to prevent the application from crashing due to unhandled exceptions. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [54-56] isValid(data: TRegistryInformationData) { - TitlePageSchema.parse(data); + try { + TitlePageSchema.parse(data); + } catch (error) { + console.error('Data validation failed:', error); + throw new Error('Invalid data provided for PDF generation.'); + } }
Error handling	Improve error handling in the `render` method to handle invalid data cases more effectively. The `render` method should handle the case where `pdfData` is invalid more gracefully, perhaps by logging an error or displaying a message, instead of potentially rendering an empty or incorrect page. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [13-19] async render(): Promise<JSX.Element> { const pdfData = await this.getData(); - this.isValid(pdfData); + if (!this.isValid(pdfData)) { + console.error('Invalid PDF data:', pdfData); + return <ErrorPage message="Invalid data provided for PDF rendering." />; + } if (this.isEmpty(pdfData)) return <EmptyRegistryInformationPage data={pdfData} />; return <RegistryInformationPage data={pdfData} />; }
Performance	Improve rendering performance by memoizing the `CaseInformationPageHeader` component. Consider using a memoization technique for the `CaseInformationPageHeader` component to prevent unnecessary re-renders when the parent component re-renders but the props `companyLogo` and `companyName` haven't changed. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [23] -<CaseInformationPageHeader companyLogo={logoUrl} companyName={companyName} /> +<CaseInformationPageHeader companyLogo={logoUrl} companyName={companyName} memoized />

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

github-actions · 2024-05-01T09:58:07Z

PR Code Suggestions

Category	Suggestions
Bug	Ensure the canvas is properly managed in the DOM. Ensure that the canvas element is appended to the document body before removing it to avoid errors. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [16] +document.body.appendChild(canvas); document.body.removeChild(canvas);
	Correct the PDF name to match the actual PDF being rendered. The static variable `PDF_NAME` is misleadingly set to 'titlePage' which might be a copy-paste error from another renderer. It should reflect the actual PDF being rendered, which is the 'RegistryPage'. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [11] -static PDF_NAME = 'titlePage'; +static PDF_NAME = 'registryPage';
	Use the correct schema for data validation in the `isValid` method. The `isValid` method uses `TitlePageSchema` to validate `pdfData` which might not be appropriate for `RegistryPagePDF`. Ensure that the correct schema is used for validation to prevent runtime errors. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [55] -TitlePageSchema.parse(data); +RegistryPageSchema.parse(data);
	Add a check to ensure sources is an array before filtering to prevent runtime errors. To ensure that the `isValidUrl` function is only called with valid inputs, add a check to ensure that `sources` is an array of strings before filtering. This prevents potential runtime errors if `sources` is not in the expected format. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [63] -sources={item.sources.filter(source => isValidUrl(source))} +sources={Array.isArray(item.sources) ? item.sources.filter(source => isValidUrl(source)) : []}
Enhancement	Add error handling for unsupported 2D context. Add error handling for the case when `getContext('2d')` returns null to prevent runtime errors. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [7] const context = canvas.getContext('2d'); +if (!context) { + reject(new Error('2D context not supported')); + return; +}
	Refine the condition in `isEmpty` method to handle non-string falsy values appropriately. The method `isEmpty` checks if all values are falsy or empty arrays, but does not handle cases where values might be non-string falsy values like `0` or `false` which might be valid in some contexts. Consider refining the condition to handle such cases or document the expected data types and values. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [70-76] if ( values.every(value => { if (Array.isArray(value) && !value.length) return true; - return !value; + return value === null \|\| value === undefined \|\| value === ''; }) ) { return true; }
	Simplify conditional rendering with a utility component for status. Replace inline conditional rendering with a more concise and readable utility function that handles the rendering logic based on the status. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [41-57] -{status === 'approved' && ( - <Typography - styles={[tw('text-[8px] leading-[1.45rem] text-[#00BD59]')]} - weight="bold" - > - Approved - </Typography> -)} -{status === 'rejected' && ( - <Typography - styles={[tw('text-[8px] leading-[1.45rem] text-[#DF2222]')]} - weight="bold" - > - Rejected - </Typography> -)} -{!status && <ValueOrNone value={status} />} +<StatusTypography status={status} />
Performance	Optimize memory usage by managing blob URLs. Use `URL.createObjectURL` and `URL.revokeObjectURL` for handling image URLs to manage memory more efficiently. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [21] -img.src = imageUrl; +const blob = new Blob([imageUrl], { type: 'image/svg+xml' }); +img.src = URL.createObjectURL(blob); +img.onload = () => { + URL.revokeObjectURL(img.src); + // existing onload code +};
Performance	Improve performance by memoizing the date string calculation. Consider using memoization for the `new Date().toISOString()` call in the subtitle of `CaseInformationPageSectionHeader` to avoid recalculating the date string on every render, which can improve performance in cases where the component re-renders frequently. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [31] -subtitle={`Check conducted at: ${new Date().toISOString()}`} +subtitle={`Check conducted at: ${useMemo(() => new Date().toISOString(), [])}`}
Maintainability	Use constants instead of hardcoded strings. Replace the 'Anonymous' string with a constant to avoid hardcoding and improve maintainability. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [4] -img.crossOrigin = 'Anonymous'; +const ANONYMOUS = 'Anonymous'; +img.crossOrigin = ANONYMOUS;
	Abstract repetitive `get` operations into a helper function for cleaner and more maintainable code. The method `getData` uses multiple `get` calls with default values that could be simplified or abstracted to reduce redundancy and improve maintainability. Consider creating a helper function to handle these `get` operations. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [23-51] -const pdfData: TRegistryInformationData = { - companyName: get(this.workflow.context, 'entity.data.companyName', ''), - creationDate: new Date(), - logoUrl: await this.getLogoUrl(), - registrationNumber: get(this.workflow.context, 'entity.data.registrationNumber', ''), - incorporationDate: get( - this.workflow.context, - 'entity.data.additionalInfo.dateOfEstablishment', - null, - ), - companyType: get(this.workflow.context, 'entity.data.businessType', ''), - companyStatus: get(this.workflow.context, 'entity.data.status', ''), - registrationAddress: [ - get(this.workflow.context, 'entity.data.headquarters.street', ''), - get(this.workflow.context, 'entity.data.headquarters.streetNumber', ''), - get(this.workflow.context, 'entity.data.headquarters.city', ''), - get(this.workflow.context, 'entity.data.headquarters.country', ''), - get(this.workflow.context, 'entity.data.headquarters.postalCode', ''), - ] - .filter(Boolean) - .join(', '), - registryPage: get(this.workflow.context, 'entity.data.registryPage', ''), - lastUpdate: new Date(), - registeredAt: get(this.workflow.context, 'entity.data.registeredAt', ''), -}; +const pdfData: TRegistryInformationData = this.createPDFData();
	Extract inline styles into a separate style object for better maintainability. To enhance code readability and maintainability, consider extracting the inline styles used in the `View` components into a separate style object or file. This approach helps in managing styles more efficiently and makes the JSX cleaner. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [22] -<View style={tw('mb-3')}> +<View style={styles.marginBottom}>
	Use a dedicated date formatting function to improve code maintainability and error handling. Consider using a utility function to format dates instead of inline `new` `Date().toISOString()` to handle potential exceptions and ensure consistent date formatting across your application. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [31-97] -<ValueOrNone value={checkDate ? new Date(checkDate).toISOString() : undefined} /> -<ValueOrNone value={dateOfBirth ? new Date(dateOfBirth).toISOString() : undefined} /> +<ValueOrNone value={formatDate(checkDate)} /> +<ValueOrNone value={formatDate(dateOfBirth)} />
	Refactor repetitive field rendering into a reusable sub-component. To improve readability and reduce redundancy, consider creating a sub-component for rendering each field row, passing field name and value as props. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [24-32] -<View style={tw('flex flex-row')}> - <View style={tw('w-[80px]')}> - <Typography styles={[tw('text-[8px] leading-[1.45rem]')]} weight="bold"> - Checked at - </Typography> - </View> - <View style={tw('w-[400px]')}> - <ValueOrNone value={checkDate ? new Date(checkDate).toISOString() : undefined} /> - </View> -</View> +<FieldRow label="Checked at" value={checkDate ? new Date(checkDate).toISOString() : undefined} />
Security	Validate input image format before processing. Add MIME type checks for the input `imageUrl` to ensure it's a valid SVG before processing. apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts [21] +if (!imageUrl.endsWith('.svg')) { + reject(new Error('Invalid SVG format')); + return; +} img.src = imageUrl;
Best practice	Enhance type safety and readability in the `isEmpty` method using TypeScript's utility types. The method `isEmpty` could be improved by using TypeScript's utility types for better type safety and readability. Consider using `Partial` or similar to ensure type safety. apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/registry-page.pdf.tsx [58-81] -private isEmpty(data: TRegistryInformationData) { - const values = [ - data.registrationNumber, - data.incorporationDate, - data.companyType, - data.companyStatus, - data.registrationAddress, - data.registryPage, - data.lastUpdate, - data.registeredAt, - ]; - if ( - values.every(value => { - if (Array.isArray(value) && !value.length) return true; - return !value; - }) - ) { - return true; - } - return false; +private isEmpty(data: Partial<TRegistryInformationData>) { + const values = Object.values(data); + return values.every(value => !value \|\| (Array.isArray(value) && !value.length)); }
	Use a more robust key for list items to prevent potential issues with duplicate names. Consider using a more descriptive key than `item.name` in the list rendering of `CompanySanctionsMatchSection`. Using a combination of name and index or a unique identifier would be more robust, especially if names can be duplicated. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [57] -key={item.name} +key={`${item.name}-${index}`}
	Define a constant for repeated style properties to enhance maintainability. Use a constant for repeated style values to ensure consistency and ease future modifications. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [26-72] -<Typography styles={[tw('text-[8px] leading-[1.45rem]')]} weight="bold"> +<Typography styles={[tw(STANDARD_TEXT_STYLE)]} weight="bold">
	Use descriptive prop names to improve code clarity. Consider using a more descriptive prop name than `item` to enhance code readability and maintainability. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/components/IdentityItem/IdentityItem.tsx [11] -export const IdentityItem: FunctionComponent<IIdentityItemProps> = ({ item }) => { +export const IdentityItem: FunctionComponent<IIdentityItemProps> = ({ identityVerification }) => {
Possible issue	Add safe navigation to handle potential undefined values in the sanctions array. It's a good practice to handle potential errors or exceptions when working with dynamic data. Consider adding error handling for the case where `sanctions` might be undefined or not an array, which could lead to runtime errors. apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/CompanySanctionsPage.tsx [55] -{sanctions.map((item, index) => ( +{sanctions?.map((item, index) => (

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

coderabbitai

Actionable comments posted: 10

Out of diff range and nitpick comments (6)

apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/TitlePage/title-page.schema.ts (1)

4-4: Consider adding a comment explaining the purpose of extending BaseCaseInformationPdfSchema with an empty object, especially if future properties are expected to be added.

apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanySanctionsPage/empty-company-sanctions.schema.ts (1)

4-4: Consider adding a comment explaining the purpose of extending BaseCaseInformationPdfSchema with an empty object, especially if future properties are expected to be added.

apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/CompanyOwnershipPage/empty-company-ownership-page.schema.ts (1)

4-4: Consider adding a comment explaining the purpose of extending BaseCaseInformationPdfSchema with an empty object, especially if future properties are expected to be added.

apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IdentityVerificationsPage/empty-identity-verfications.schema.ts (1)

4-4: Consider adding a comment explaining the purpose of extending BaseCaseInformationPdfSchema with an empty object, especially if future properties are expected to be added.

apps/backoffice-v2/src/pages/Entity/pdfs/case-information/pages/IndividualSanctionsPage/components/IndividualSanctionsItem/ValueOrNone.tsx (1)

27-27: Ensure type safety by explicitly handling the type conversion of valueOrNone(value).

Consider using TypeScript's type assertion or a type guard to ensure the type of valueOrNone(value) matches AnyChildren.

apps/backoffice-v2/src/lib/blocks/hooks/useUbosRegistryProvidedBlock/useUbosRegistryProvidedBlock.tsx (1)

5-5: Consider adding JSDoc comments to the useUbosRegistryProvidedBlock hook to improve code documentation and developer understanding.

Add JSDoc comments explaining the parameters and the return type of the useUbosRegistryProvidedBlock hook.

...information/pages/IndividualSanctionsPage/components/IndividualSanctionsItem/ValueOrNone.tsx

apps/backoffice-v2/src/pages/Entity/components/Case/components/CaseOptions/CaseOptions.tsx

...se/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/company-ownership-page.pdf.tsx

...se/components/CaseOptions/hooks/useCaseOptionsLogic/renderers/company-sanctions-page.pdf.tsx

...s/Entity/pdfs/case-information/pages/IdentityVerificationsPage/IdentityVerificationsPage.tsx

...mponents/CaseOptions/hooks/useCaseOptionsLogic/renderers/identity-verifications-page.pdf.tsx

...office-v2/src/lib/blocks/hooks/useUbosRegistryProvidedBlock/useUbosRegistryProvidedBlock.tsx

apps/backoffice-v2/src/common/utils/svg-to-png/svg-to-png.ts

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 533b2b2 and 39d210e.

Files selected for processing (1)

services/workflows-service/scripts/seed.ts (3 hunks)

Additional comments not posted (2)

services/workflows-service/scripts/seed.ts (2)

4-4: Import of Type from @sinclair/typebox added.

This change allows for the use of Type in defining JSON schemas which is consistent with the PR objectives to enhance schema definitions.

7-7: Import of env from ../src/env.

This import is crucial for accessing environment variables within the script, facilitating dynamic configuration.

services/workflows-service/scripts/seed.ts

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 39d210e and 85c6f4c.

Files selected for processing (1)

services/workflows-service/scripts/seed.ts (3 hunks)

Files skipped from review as they are similar to previous changes (1)

services/workflows-service/scripts/seed.ts

chesterkmr added 16 commits April 19, 2024 17:16

feat: added title page markup

6666ace

feat: added registry information page report

f92550e

feat: added company ownership page

cfb9feb

feat: added company sanctions page

e1d0ad1

feat: added identity verifications page

d33c33d

feat: added individual sanctions page

e6d42b7

Merge branch 'dev' into bal-1641

d54070c

feat: added validation schemas

dbddedb

feat: added download certificate logic & ui

5e1cf17

Merge branch 'dev' into bal-1641

420b1c1

feat: added mapping for title & registry page

f956d85

Merge branch 'dev' into bal-1641

acc752f

feat: added partial rendering of pdfs

de8484e

feat: implemented mapping for identity verifications page

f57e482

feat: implemented individual sanctions page

47eb7e1

feat: implemented empty state pages

da3d438

chesterkmr requested a review from Omri-Levy May 1, 2024 09:53

fix: lock fix

8f21348

github-actions bot added the enhancement New feature or request label May 1, 2024

github-actions bot added the Review effort [1-5]: 4 label May 1, 2024

coderabbitai bot reviewed May 1, 2024

View reviewed changes

Merge branch 'dev' into bal-1641

47c90cf

alonp99 changed the title ~~Bal 1641~~ Pdf export feature Jun 18, 2024

fix: fixed ballerine logo url

39d210e

coderabbitai bot reviewed Jun 19, 2024

View reviewed changes

services/workflows-service/scripts/seed.ts Show resolved Hide resolved

Omri-Levy and others added 2 commits June 23, 2024 18:58

fix(seed.ts): fixed bad symbol in cdn link

7a1563d

Merge branch 'dev' into bal-1641

85c6f4c

Omri-Levy approved these changes Jun 23, 2024

View reviewed changes

Omri-Levy enabled auto-merge (squash) June 23, 2024 15:59

coderabbitai bot reviewed Jun 23, 2024

View reviewed changes

Omri-Levy merged commit a9026b4 into dev Jun 23, 2024
9 checks passed

Omri-Levy deleted the bal-1641 branch June 23, 2024 16:05

This was referenced Sep 25, 2024

feat: email plugins support #2611

Merged

Feature/implement ocr button #2731

Merged

Feature/webhook plugin signing3 #2734

Closed

feature/bull_mq_integration #2735

Open

Illiar/feat/collection flow customization #2479

Closed

This was referenced Oct 2, 2024

kyckr #2746

Merged

Added swagger documentation to the run endpoint #2758

Merged

Updated swagger schema of get workflow by id endpoint #2762

Merged

Omri-Levy mentioned this pull request Nov 4, 2024

Demo envs changes #2813

Merged

coderabbitai bot mentioned this pull request Nov 6, 2024

feat: updated cf status persistance logic & updated events for iframe #2818

Merged

coderabbitai bot mentioned this pull request Nov 27, 2024

fix: fixed document cropping & layout fixes #2866

Merged

coderabbitai bot mentioned this pull request Dec 12, 2024

Date input improvements #2889

Merged

coderabbitai bot mentioned this pull request Dec 19, 2024

[bal-3193] - backward compatbility for previous alert's subject #2898

Merged

This was referenced Dec 27, 2024

feat(business-report): upgrade user-facing part of the social media data UI (BAL-2577) #2911

Merged

feat: interactive charts on home page (BAL-3246) #2925

Merged

coderabbitai bot mentioned this pull request Jan 3, 2025

Bank account verification plugin #2931

Merged

This was referenced Jan 14, 2025

feat: added csv document rendering #2958

Merged

fix: UI fixes for statistics and merchant monitoring report pages (BAL-3389, BAL-3390, BAL-3391) #2965

Merged

This was referenced Jan 21, 2025

WIP - Directors individual sanctions #2980

Merged

Store merchants in the Unified API DB #2976

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pdf export feature #2331

Pdf export feature #2331

chesterkmr commented May 1, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 1, 2024 •

edited

Loading

coderabbitai bot commented May 1, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024 •

edited

Loading

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

Pdf export feature #2331

Pdf export feature #2331

Conversation

chesterkmr commented May 1, 2024 • edited by coderabbitai bot Loading

User description

Description

Type

Description

Changes walkthrough

Summary by CodeRabbit

changeset-bot bot commented May 1, 2024 • edited Loading

⚠️ No Changeset found

coderabbitai bot commented May 1, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024 • edited Loading

PR Review

(Review updated until commit 8f21348)

github-actions bot commented May 1, 2024

github-actions bot commented May 1, 2024

PR Code Suggestions

github-actions bot commented May 1, 2024

PR Code Suggestions

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

chesterkmr commented May 1, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 1, 2024 •

edited

Loading

coderabbitai bot commented May 1, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

github-actions bot commented May 1, 2024 •

edited

Loading

(Review updated until commit `8f21348`)