[Fix] Alter "Payment" Entity Table

[rahul-rocket]

PR

• Have you followed the contributing guidelines?
• Have you explained what your changes do, and why they add value?

Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.

---

Summary by CodeRabbit

• Refactor
  • Standardized payment record handling by replacing “recordedBy” with “createdByUser” for clearer user attribution across invoices, payment listings, and PDF exports.
• Chore
  • Standardized API route definitions and implemented database schema migrations to enhance data consistency and integrity.
• Style
  • Improved code formatting and added safety checks in UI interactions for more reliable performance.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request refactors payment-related code across multiple modules by renaming the property from recordedBy to createdByUser. It also restructures payment interfaces and DTOs to use new types like IPaymentCreateInput, standardizes API route definitions with leading slashes, and improves documentation through enhanced JSDoc comments. Additionally, the PR introduces a migration for altering the payment table and adds safety checks and formatting improvements in several utility files.

Changes

File(s)	Change Summary
apps/gauzy/src/app/pages/invoices/invoice-payments/payments.component.ts apps/gauzy/src/app/pages/payments/payments.component.ts packages/core/src/lib/invoice/{generate-invoice-payment-pdf.ts, invoice.service.ts}	Renamed recordedBy to createdByUser in payment handling logic, updated method signatures (e.g. adding Promise<void>), and adjusted related UI mappings.
packages/contracts/src/lib/payment.model.ts packages/core/src/lib/payment/dto/{create-payment.dto.ts, payment.dto.ts, update-payment.dto.ts} packages/core/src/lib/payment/dto/query/payment-report-query.dto.ts	Restructured interfaces and DTOs; introduced IPaymentCreateInput, modified inheritance with Intersection, Pick, Omit types, and streamlined type definitions.
packages/core/src/lib/database/migrations/1740049728884-AlterPaymentEntityTable.ts	Introduced a migration to alter the payment entity table with database-specific helper methods and rollback support.
packages/core/src/lib/payment/payment.controller.ts	Standardized API route decorators by adding leading slashes to HTTP methods.
packages/core/src/lib/payment/{payment.entity.ts, payment.subscriber.ts, payment.seed.ts}	Updated entity validations and property types (using ID), added createdByUser/createdByUserId, and adjusted subscriber assignments to reflect the renaming.
packages/core/src/lib/organization-team-join-request/organization-team-join-request.entity.ts packages/core/src/lib/payment/dto/index.ts packages/core/src/lib/payment/dto/query/index.ts packages/ui-core/shared/src/lib/directives/debounce-click.directive.ts	Improved documentation, standardized type declarations, adjusted export formatting, and added safety null-checks in directive cleanup.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant PaymentController
    participant PaymentService
    participant PaymentRepository
    participant PaymentSubscriber

    Client->>PaymentController: POST / (create payment)
    PaymentController->>PaymentService: Process DTO (IPaymentCreateInput)
    PaymentService->>PaymentRepository: Save payment entity (using createdByUser)
    PaymentRepository->>PaymentSubscriber: Trigger beforeEntityCreate hook
    PaymentSubscriber->>PaymentRepository: Assign createdByUserId and save
    PaymentRepository-->>PaymentService: Return saved payment
    PaymentService-->>PaymentController: Return success response
    PaymentController-->>Client: HTTP 201 Created

Loading

Possibly related PRs

• [Feat] Organization Project Modules management (FIx module creation && update) #8575: Refactors user identification in payment records, aligning changes in employee roles with the updated field naming.
• Feat/dashboard widget api #8624: Updates related to shifting from recordedBy to createdByUser, affecting dashboard widgets and payment data handling.
• [Fix] Table Migrations (Screening Task)  #8600: Directly addresses renaming in payment components and entities for consistent user reference across the system.

Poem

I’m a little rabbit with ears so keen,
Hopping through code where changes are seen.
“RecordedBy” has left the stage,
Now “createdByUser” sets the wage.
With a twitch of my nose and a joyful clap,
I celebrate each refactor’s tap!
🐰 Happy coding under the carrot moon!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cecbd8f and 42cb0f8.

📒 Files selected for processing (18)

• apps/gauzy/src/app/pages/invoices/invoice-payments/payments.component.ts (6 hunks)
• apps/gauzy/src/app/pages/payments/payments.component.ts (3 hunks)
• packages/contracts/src/lib/payment.model.ts (2 hunks)
• packages/core/src/lib/database/migrations/1740049728884-AlterPaymentEntityTable.ts (1 hunks)
• packages/core/src/lib/invoice/generate-invoice-payment-pdf.ts (6 hunks)
• packages/core/src/lib/invoice/invoice.service.ts (2 hunks)
• packages/core/src/lib/organization-team-join-request/organization-team-join-request.entity.ts (2 hunks)
• packages/core/src/lib/payment/dto/create-payment.dto.ts (1 hunks)
• packages/core/src/lib/payment/dto/index.ts (1 hunks)
• packages/core/src/lib/payment/dto/payment.dto.ts (1 hunks)
• packages/core/src/lib/payment/dto/query/index.ts (1 hunks)
• packages/core/src/lib/payment/dto/query/payment-report-query.dto.ts (1 hunks)
• packages/core/src/lib/payment/dto/update-payment.dto.ts (1 hunks)
• packages/core/src/lib/payment/payment.controller.ts (7 hunks)
• packages/core/src/lib/payment/payment.entity.ts (4 hunks)
• packages/core/src/lib/payment/payment.seed.ts (3 hunks)
• packages/core/src/lib/payment/payment.subscriber.ts (1 hunks)
• packages/ui-core/shared/src/lib/directives/debounce-click.directive.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit 42cb0f8.

Command	Status	Duration	Result
nx build gauzy -c=production --prod --verbose	✅ Succeeded	3m 32s	View ↗
nx build api -c=production --prod	✅ Succeeded	1m 12s	View ↗
nx build desktop-ui-lib --configuration=production	✅ Succeeded	30s	View ↗
nx build desktop-ui-lib --configuration=develop...	✅ Succeeded	30s	View ↗
nx build plugin-integration-wakatime	✅ Succeeded	<1s	View ↗
nx build desktop-lib	✅ Succeeded	<1s	View ↗
nx build desktop-window	✅ Succeeded	<1s	View ↗
nx build desktop-core	✅ Succeeded	<1s	View ↗
Additional runs (52)	✅ Succeeded	...	View ↗

---

☁️ Nx Cloud last updated this comment at 2025-02-20 15:15:27 UTC