lehuygiang28 / vnpay

An open-source nodejs library support to payment with VNPay (vnpay.vn)
https://vnpay.js.org
MIT License
63 stars 26 forks source link

[draft] refactor for readable and add tests #18

Closed lehuygiang28 closed 2 months ago

lehuygiang28 commented 2 months ago

Summary by Sourcery

This pull request refactors the VNPay class for better readability and maintainability, enhances date handling and logging utilities, and adds new tests to cover the changes.

Summary by CodeRabbit

vercel[bot] commented 2 months ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
vnpay βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jul 20, 2024 8:19pm
sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request refactors the VNPay module for better readability and modularity. Key changes include moving URL creation and secure hash calculation to separate utility functions, enhancing existing utility functions with additional parameters, and adding new tests. The jest configuration was also updated to enforce a minimum of 80% line coverage.

File-Level Changes

Files Changes
src/vnpay.ts
src/utils/payment.util.ts
Refactored payment URL creation and secure hash calculation into separate utility functions for better modularity and readability.
src/utils/common.ts
src/utils/logger.ts
Enhanced utility functions with additional parameters and improved functionality.

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes significantly enhance project configuration and utility functions, with a strong emphasis on code quality, maintainability, and testing. Key updates include the addition of coverage/ and .env entries to ignore lists for linting, version control, and npm packaging. New utility functions for payment processing have been introduced, along with comprehensive unit tests for various modules, ensuring robust functionality and effective error handling throughout the application.

Changes

Files Change Summary
.eslintignore, .gitignore, .npmignore, .prettierignore Added coverage/ and .env entries to ignore lists, optimizing linting and version control processes.
jest.config.ts Introduced coverageThreshold to enforce a minimum coverage requirement of 80%.
package.json Added script command "test:cov": "jest --coverage" for easier coverage testing.
src/utils/common.ts Modified getDateInGMT7 to accept an optional date parameter; updated parseDate to include timezone support.
src/utils/payment.util.ts, src/vnpay.ts Introduced new utility functions for payment URL construction and secure hash management; refactored payment handling to utilize these functions.
test/utils/common.test.ts, test/utils/logger.test.ts, test/utils/payment-util.test.ts, test/verify-return-url.test.ts Established unit tests for utility functions and the verifyReturnUrl method in VNPay, ensuring correct functionality and error handling.
.coderabbit.yaml Added tone_instructions field to guide feedback generation, enhancing customization capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VNPay
    participant PaymentUtil
    participant Logger

    User->>VNPay: Initiates payment
    VNPay->>PaymentUtil: Generates payment URL
    PaymentUtil-->>VNPay: Returns payment URL
    VNPay->>Logger: Logs payment initiation
    Logger-->>VNPay: Confirms log
    VNPay->>User: Returns payment link
sequenceDiagram
    participant User
    participant VNPay
    participant PaymentUtil
    participant Logger

    User->>VNPay: Verifies return URL
    VNPay->>PaymentUtil: Validates secure hash
    PaymentUtil-->>VNPay: Returns validation result
    VNPay->>Logger: Logs verification result
    Logger-->>VNPay: Confirms log
    VNPay->>User: Returns verification status

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
lehuygiang28 commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.