feat: use bigint instead of long

[elibosley]

Summary by CodeRabbit

• New Features
  • Improved support for large integer values in the API, allowing accurate handling of big numbers in GraphQL queries and responses.
• Bug Fixes
  • Enhanced reliability when dealing with very large numeric fields, reducing the risk of data loss or inaccuracies for disk, share, and memory statistics.
• Chores
  • Updated internal dependencies to improve handling of big integers.

[coderabbitai]

Walkthrough

The changes update the handling of large integer values in the API by replacing a custom GraphQLLong scalar with the GraphQLBigInt scalar from the graphql-scalars package. Additionally, the json-bigint-patch dependency is introduced and imported in key entry files to improve JSON handling for big integers.

Changes

File(s)	Change Summary
api/package.json	Added json-bigint-patch as a dependency.
api/src/cli.ts, api/src/index.ts	Imported json-bigint-patch for improved big integer JSON handling.
api/src/unraid-api/graph/graph.module.ts	Switched scalar import and resolver from custom GraphQLLong to external GraphQLBigInt.
api/src/unraid-api/graph/resolvers/array/array.model.ts	Changed GraphQL field decorators from GraphQLLong to GraphQLBigInt for disk/share size and count fields.
api/src/unraid-api/graph/resolvers/info/info.model.ts	Updated memory-related GraphQL fields from Int to GraphQLBigInt for larger value support.
api/src/unraid-api/graph/scalars/graphql-type-long.ts	Removed the custom GraphQLLong scalar implementation file.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant GraphQL API
    participant graphql-scalars
    participant json-bigint-patch

    Client->>GraphQL API: Query/Mutation with large integer fields
    GraphQL API->>graphql-scalars: Use GraphQLBigInt for serialization/parsing
    GraphQL API->>json-bigint-patch: Parse/serialize JSON with big integers
    graphql-scalars-->>GraphQL API: Return BigInt-compliant values
    json-bigint-patch-->>GraphQL API: Handle JSON with big integers
    GraphQL API-->>Client: Respond with accurate large integer data

Loading

Suggested reviewers

• mdatelle

Poem

Numbers once squeezed in a 52-bit song,
Now dance with BigInt, robust and strong!
No more custom scalars hiding in the night,
With external helpers, big numbers are right.
JSON grows wiser, the API feels new—
Here’s to big changes (and big ints) for you!
🎉

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (9)

api/src/unraid-api/graph/resolvers/array/array.model.ts (9)

61-66: Consistent TS typing for BigInt fields
This numReads field also uses number | null with GraphQLBigInt. Change to bigint | null to avoid overflow or precision issues.

---

68-73: Consistent TS typing for BigInt fields
Same pattern for numWrites: switch the TypeScript annotation from number | null to bigint | null.

---

75-80: Consistent TS typing for BigInt fields
numErrors needs the same fix—use bigint | null instead of number | null.

---

82-87: Consistent TS typing for BigInt fields
For fsSize, update the TS type to bigint | null to align with the BigInt scalar.

---

88-93: Consistent TS typing for BigInt fields
fsFree should also be typed as bigint | null to preserve large values.

---

94-99: Consistent TS typing for BigInt fields
Apply the same change for fsUsed: switch to bigint | null.

---

246-248: Consistent TS typing for BigInt fields
In the Share type, the free field is still number | null. Change to bigint | null for large-space precision.

---

249-251: Consistent TS typing for BigInt fields
The used field here also needs to be bigint | null rather than number | null.

---

252-253: Consistent TS typing for BigInt fields
Finally, update the size field in Share to bigint | null to match the GraphQLBigInt scalar.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7067e9e and 75829b1.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (7)

• api/package.json (1 hunks)
• api/src/cli.ts (1 hunks)
• api/src/index.ts (1 hunks)
• api/src/unraid-api/graph/graph.module.ts (2 hunks)
• api/src/unraid-api/graph/resolvers/array/array.model.ts (4 hunks)
• api/src/unraid-api/graph/resolvers/info/info.model.ts (3 hunks)
• api/src/unraid-api/graph/scalars/graphql-type-long.ts (0 hunks)

💤 Files with no reviewable changes (1)

• api/src/unraid-api/graph/scalars/graphql-type-long.ts

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Build Web App
• GitHub Check: Test API
• GitHub Check: Build API
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Cloudflare Pages

🔇 Additional comments (9)

api/package.json (1)

118-118: Added dependency for handling large integers.

Adding json-bigint-patch is appropriate for supporting JSON data with large integer values.

api/src/cli.ts (1)

2-2: Imported json-bigint-patch for big integer support.

This import ensures that big integers are properly handled in the CLI interface.

api/src/unraid-api/graph/graph.module.ts (2)

7-7: Replaced GraphQLLong with GraphQLBigInt from graphql-scalars package.

Good improvement to use a standard library scalar type instead of a custom implementation.

---

52-52: Updated Long scalar resolver to use GraphQLBigInt.

This change maintains API compatibility by keeping the scalar name as "Long" while using the better implementation from graphql-scalars.

api/src/index.ts (1)

3-3: Imported json-bigint-patch for big integer support.

This addition ensures consistent handling of large integers across the application.

api/src/unraid-api/graph/resolvers/info/info.model.ts (3)

11-11: Updated imports to include GraphQLBigInt.

Adding GraphQLBigInt alongside GraphQLJSON properly prepares for the type changes in the model.

---

293-294: Changed MemoryLayout.size type from Int to GraphQLBigInt.

Good update to handle potentially large memory sizes that could exceed JavaScript's safe integer limit.

---

329-357: Updated all memory measurement fields to use GraphQLBigInt.

This is an essential change as memory values in bytes can easily exceed the 32-bit integer limit, especially on systems with large amounts of memory. Using GraphQLBigInt ensures accurate representation of these values.

api/src/unraid-api/graph/resolvers/array/array.model.ts (1)

4-4: Verify scalar import and module registration
You’ve swapped out the custom GraphQLLong for GraphQLBigInt—great move. Please confirm that GraphQLBigInt is registered in your GraphQL module (e.g., in graph.module.ts) so these fields resolve correctly.

[coderabbitai]

⚠️ Potential issue

Mismatch between GraphQLBigInt and TS number type
GraphQLBigInt returns a JS BigInt, but the field is typed as number | null, risking precision loss. Update the TypeScript type to bigint | null.

Apply this diff:

-    @Field(() => GraphQLBigInt, { description: '(KB) Disk Size total', nullable: true })
-    size?: number | null;
+    @Field(() => GraphQLBigInt, { description: '(KB) Disk Size total', nullable: true })
+    size?: bigint | null;

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	@Field(() => GraphQLBigInt, { description: '(KB) Disk Size total', nullable: true })
	size?: number | null;
	@Field(() => GraphQLBigInt, { description: '(KB) Disk Size total', nullable: true })
	size?: bigint | null;

🤖 Prompt for AI Agents

In api/src/unraid-api/graph/resolvers/array/array.model.ts around lines 46 to
48, the TypeScript type for the size field is incorrectly set as number | null
while the GraphQL type is GraphQLBigInt, which returns a JS BigInt. Change the
TypeScript type of the size field from number | null to bigint | null to match
the GraphQLBigInt type and avoid precision loss.

[github-actions]

This plugin has been deployed to Cloudflare R2 and is available for testing.
Download it at this URL:

https://preview.dl.unraid.net/unraid-api/tag/PR1403/dynamix.unraid.net.plg