Skip to content

Conversation

@chewenye
Copy link
Contributor

@chewenye chewenye commented Jun 12, 2025

Description

扩展组件:packages\effects\common-ui\src\components\json-viewer\index.vue

支持显示 bigint 数据,如较长的订单号

[{"id":1234567890123456789}]

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Enhanced JSON viewer to support displaying JSON data containing bigint values.

@changeset-bot
Copy link

changeset-bot bot commented Jun 12, 2025

⚠️ No Changeset found

Latest commit: 30384ea

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
Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

Walkthrough

The changes update the @vben/common-ui package by adding the json-bigint dependency and modifying the JSON viewer component to use this library for parsing JSON strings. This enables correct handling and display of JSON data containing bigint values within the component.

Changes

File(s) Change Summary
packages/effects/common-ui/package.json Added json-bigint as a dependency with version source "catalog:".
packages/effects/common-ui/src/components/json-viewer/index.vue Integrated json-bigint for parsing; added jsonData computed property for bigint support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant JsonViewerComponent
    participant JsonBigint

    User->>JsonViewerComponent: Passes JSON string (may contain bigint)
    JsonViewerComponent->>JsonBigint: Parses JSON string with storeAsString: true
    JsonBigint-->>JsonViewerComponent: Returns parsed JSON (bigints as strings)
    JsonViewerComponent->>User: Displays parsed JSON data
Loading

Suggested reviewers

  • mynetfan
  • anncwb
  • vince292007
  • jinmao88

Poem

A hop and a leap, a bigint in tow,
Now JSON can grow as large as we know.
With json-bigint, our viewer’s delight,
Handles big numbers, both day and night.
So let the data flow, no matter the size—
This rabbit’s code sees through every disguise! 🐇


📜 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 e1db9e3 and 30384ea.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • packages/effects/common-ui/package.json (1 hunks)
  • packages/effects/common-ui/src/components/json-viewer/index.vue (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/effects/common-ui/package.json
  • packages/effects/common-ui/src/components/json-viewer/index.vue
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🔭 Outside diff range comments (1)
packages/effects/common-ui/src/components/json-viewer/index.vue (1)

93-100: 💡 Verification agent

🧩 Analysis chain

bindProps.value now always overrides with jsonData; confirm click-handler consistency

bindProps feeds the parsed jsonData to the underlying viewer, but the click-handler (line 67-69) still uses plain JSON.parse, which cannot round-trip bigint values.
After switching to json-bigint at the top-level, consider updating that handler too:

-    param.value = JSON.parse(param.value);
+    try {
+      param.value = JSONbig.parse(param.value);
+    } catch { /* fall back */ }

Otherwise the viewer shows correct values while click events emit truncated numbers.


To confirm whether the click handler still uses JSON.parse (and has not yet been switched to JSONbig.parse), let’s inspect its definition and parsing calls in index.vue:


🏁 Script executed:

#!/bin/bash
# Locate handleClick definition and nearby context
rg "function handleClick" -C3 -n packages/effects/common-ui/src/components/json-viewer/index.vue

# Search for any JSON.parse calls in this file
rg "JSON.parse" -C3 -n packages/effects/common-ui/src/components/json-viewer/index.vue || echo "No JSON.parse calls found"

# Check for JSONbig.parse usage (should be present if already updated)
rg "JSONbig.parse" -C3 -n packages/effects/common-ui/src/components/json-viewer/index.vue || echo "No JSONbig.parse calls found"

Length of output: 988


To ensure consistency with big‐integer support, the click handler must use the same json-bigint parser as the top‐level binding. Let’s confirm the import name:


🏁 Script executed:

#!/bin/bash
# Find how json-bigint is imported in this file
rg "import .*json-bigint" -n packages/effects/common-ui/src/components/json-viewer/index.vue

Length of output: 135


Update click-handler to use JsonBigint for consistency

The click handler in packages/effects/common-ui/src/components/json-viewer/index.vue still does:

param.value = JSON.parse(param.value);

but the top-level parsing now uses JsonBigint({ storeAsString: true }), so big integers will be truncated here. Let’s switch the handler to the same parser with a JSON fallback:

  • File: packages/effects/common-ui/src/components/json-viewer/index.vue
  • Lines: ~67–69
-    param.value = JSON.parse(param.value);
+    try {
+      param.value = JsonBigint({ storeAsString: true }).parse(param.value);
+    } catch {
+      // fall back to native JSON.parse on invalid bigint strings
+      param.value = JSON.parse(param.value);
+    }

This ensures click events emit full bigint values just like the viewer.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c0962fe and 66ff926.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • packages/effects/common-ui/package.json (1 hunks)
  • packages/effects/common-ui/src/components/json-viewer/index.vue (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Lint (ubuntu-latest)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (1)
packages/effects/common-ui/package.json (1)

41-45: Pin or document the source for the newly-added json-bigint dependency

"json-bigint": "catalog:" follows the same placeholder version strategy as the other deps, but it leaves the actual resolved version opaque.
Given that json-bigint is a trans-piled CommonJS package, subtle breaking changes between minor versions could slip in unnoticed. Consider either:

  • replacing catalog: with an explicit semver range ("^1.0.0" is current), or
  • documenting in the repo how catalog: is resolved in your internal tooling.

This will make reproducible builds and future audits simpler.

@chewenye chewenye force-pushed the U_CWY_json-viewer_bigint branch 2 times, most recently from 2f125f9 to e1db9e3 Compare June 12, 2025 05:44
@chewenye chewenye force-pushed the U_CWY_json-viewer_bigint branch from e1db9e3 to 30384ea Compare June 20, 2025 06:28
@jinmao88 jinmao88 merged commit b78bc65 into vbenjs:main Jun 28, 2025
14 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jul 29, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants