Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature(demo-game): obfuscate dice outcome #79

Merged
merged 1 commit into from
Jan 6, 2025
Merged

Conversation

jajakob
Copy link
Collaborator

@jajakob jajakob commented Dec 28, 2024

Summary by CodeRabbit

  • New Features

    • Implemented Base64 encoding for segment data transmission.
    • Enhanced data loading and validation in the forecast component.
  • Bug Fixes

    • Improved error handling during data retrieval.
  • Refactor

    • Streamlined data processing in forecast and game management components.
    • Standardized URL parameter encoding method.

@jajakob jajakob requested a review from rschlaefli December 28, 2024 10:43
@jajakob jajakob self-assigned this Dec 28, 2024
Copy link

vercel bot commented Dec 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
gbl-uzh ❌ Failed (Inspect) Jan 6, 2025 5:16am

Copy link
Contributor

coderabbitai bot commented Dec 28, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request introduces refactoring in two components of a demo game application: the Forecast component and the ManageGame component. The changes focus on enhancing the handling of the roll query parameter through Base64 decoding and improving the URL parameter construction by consolidating data into a Base64-encoded JSON string. Additionally, the validation checks for essential data have been strengthened to ensure proper rendering only when all necessary information is available.

Changes

File Change Summary
apps/demo-game/src/pages/admin/dice/[id]/[...roll].tsx - Refactored data retrieval in Forecast component
- Added Base64 decoding for roll query parameter
- Enhanced validation checks for diceBonds, diceShared, and diceStocks
apps/demo-game/src/pages/admin/games/[id].tsx - Introduced Base64 encoding for segment link data
- Created dataToEncode object for URL parameter consolidation
- Updated href in Link component to use Base64-encoded JSON string

📜 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 fd57408 and 301cc66.

📒 Files selected for processing (2)
  • apps/demo-game/src/pages/admin/dice/[id]/[...roll].tsx (1 hunks)
  • apps/demo-game/src/pages/admin/games/[id].tsx (2 hunks)

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

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: 1

🧹 Nitpick comments (3)
apps/demo-game/src/pages/admin/dice/[id]/[...roll].tsx (1)

72-73: Consider handling invalid or missing query parameters
Currently, the component returns a simple <div>Loading...</div> if router.query.roll[0] is absent. You might want to differentiate between a truly loading state and an invalid state where roll is missing or malformed, to inform the user appropriately.

apps/demo-game/src/pages/admin/games/[id].tsx (2)

395-406: Ensure safe usage of Base64 encoding
Storing complex data in Base64 is convenient, but can grow large for bigger objects. Also, consider whether the encoded data might ever be manipulated in transit (e.g., tampered). If data security or integrity is crucial, you may want encryption or server-side validation.


451-451: Add security consideration for external links
When using target="_blank", consider adding rel="noopener noreferrer" to prevent potential reverse tabnabbing security concerns.

- href={`/admin/dice/${segment.id}/${encoded}`} target="_blank"
+ href={`/admin/dice/${segment.id}/${encoded}`} target="_blank" rel="noopener noreferrer"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3c03a4e and fd57408.

📒 Files selected for processing (2)
  • apps/demo-game/src/pages/admin/dice/[id]/[...roll].tsx (1 hunks)
  • apps/demo-game/src/pages/admin/games/[id].tsx (11 hunks)
🔇 Additional comments (11)
apps/demo-game/src/pages/admin/dice/[id]/[...roll].tsx (1)

76-84: Verify object shape before destructuring
You rely on decodedData having specific properties (diceBonds, diceShared, etc.). Ensure you validate or check for them and consider fallback values to avoid runtime errors if the fields are missing.

apps/demo-game/src/pages/admin/games/[id].tsx (10)

11-12: Migrated form fields look good
Switching from custom NewFromikNumberField/NewFormikTextField to FormikNumberField/FormikTextField standardizes form usage and improves consistency.


686-686: Good consistency in field labels
Adding a field for "Period Name" with FormikTextField is consistent with the rest of the form approach.


693-693: Numeric field transition looks proper
Switching to FormikNumberField for segment count is clear and ensures numeric validation is easily handled.


712-712: Seed field uses correct numeric type
Making "Seed" a numeric field clarifies that it must be an integer.


726-726: Interest field benefits from numeric validation
Using FormikNumberField for "Saving Interest" makes sense to prevent invalid inputs.


740-740: Bonds trend field updated
The numeric input for Bond Trend ensures consistent user input.


749-749: Bonds gap field updated
Gap is now explicitly numeric, reducing user input errors.


763-763: Stocks trend numeric field
Expanding numeric input usage to Stock Trend aligns with the rest of the scenario parameters.


772-772: Stocks gap numeric field
Using a numeric field for Stock Gap is consistent and helps with validations.


829-829: Countdown field design
Applying FormikNumberField for the countdown fosters clarity on input constraints and is aligned with the rest of the form.

const gapStocks = parseFloat(nums[12])
if (!router.query?.roll?.[0]) return <div>Loading...</div>

const decodedData = JSON.parse(atob(router.query?.roll?.[0]))
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling for decoding
Performing JSON.parse(atob(...)) can throw if the encoded string is corrupted or not valid JSON, leading to a runtime error. Consider wrapping this in a try/catch block or adding defensive checks to gracefully handle such cases.

- const decodedData = JSON.parse(atob(router.query?.roll?.[0]))
+ let decodedData
+ try {
+   decodedData = JSON.parse(atob(router.query?.roll?.[0]))
+ } catch (err) {
+   console.error('Error decoding data', err)
+   return <div>Invalid data</div>
+ }
📝 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
const decodedData = JSON.parse(atob(router.query?.roll?.[0]))
let decodedData
try {
decodedData = JSON.parse(atob(router.query?.roll?.[0]))
} catch (err) {
console.error('Error decoding data', err)
return <div>Invalid data</div>
}

Copy link
Member

@rschlaefli rschlaefli left a comment

Choose a reason for hiding this comment

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

LGTM :)

@jajakob jajakob force-pushed the jakob/obfuscate-dice branch from fd57408 to 301cc66 Compare January 6, 2025 05:13
@jajakob jajakob merged commit 78c2720 into dev Jan 6, 2025
1 of 3 checks passed
@jajakob jajakob deleted the jakob/obfuscate-dice branch January 6, 2025 05:14
Copy link

sonarqubecloud bot commented Jan 6, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants