Skip to content

fix pattern and role bugs#1343

Merged
evanpelle merged 1 commit intomainfrom
evan-fix-pattern-role-bugs
Jul 4, 2025
Merged

fix pattern and role bugs#1343
evanpelle merged 1 commit intomainfrom
evan-fix-pattern-role-bugs

Conversation

@evanpelle
Copy link
Collaborator

@evanpelle evanpelle commented Jul 4, 2025

Description:

  1. this.cosmetics.role_groups[groupName] was undefined causing an error
  2. When logging out, reset the pattern. This was causing an unauthorized pattern error because it persisted after log out.

Please complete the following:

  • I have added screenshots for all UI updates
  • I process any text displayed to the user through translateText() and I've added it to the en.json file
  • I have added relevant tests to the test directory
  • I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced
  • I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors

Please put your Discord username so you can be contacted if a bug or regression is found:

evan

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 4, 2025

Walkthrough

This update renames a button variable in the client code, adds validation for selected patterns in the territory patterns modal, and improves error handling in the server privilege logic by using optional chaining to avoid runtime errors.

Changes

File(s) Change Summary
src/client/Main.ts Renamed button variable from tpButton to patternButton and updated all related references.
src/client/TerritoryPatternsModal.ts Added validation in onUserMe to reset selected pattern if not found, locked, or hidden.
src/server/Privilege.ts Added optional chaining to safely access role_groups[groupName] in isPatternAllowed.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Main
    participant TerritoryPatternsModal
    participant Server

    User->>Main: Clicks "territory-patterns-input-preview-button"
    Main->>TerritoryPatternsModal: Opens modal
    TerritoryPatternsModal->>Server: Requests user patterns (onUserMe)
    Server-->>TerritoryPatternsModal: Returns patterns and user info
    TerritoryPatternsModal->>TerritoryPatternsModal: Validate selected pattern
    alt Pattern invalid/locked/hidden
        TerritoryPatternsModal->>TerritoryPatternsModal: Reset selected pattern
    end
    TerritoryPatternsModal->>Main: Update UI
Loading

Possibly related PRs

Suggested labels

Bug Fix, UI/UX

Poem

A button gets a shiny new name,
Pattern checks now play the game.
No more errors sneak or hide,
Optional chains stand guard inside.
With careful hands, the code’s refined—
Cleaner, safer, well-aligned!
🌱✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-04T20_10_06_251Z-debug-0.log


📜 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 7a3a3a5 and d8af249.

📒 Files selected for processing (3)
  • src/client/Main.ts (2 hunks)
  • src/client/TerritoryPatternsModal.ts (1 hunks)
  • src/server/Privilege.ts (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: andrewNiziolek
PR: openfrontio/OpenFrontIO#1007
File: resources/lang/de.json:115-115
Timestamp: 2025-06-02T14:27:37.609Z
Learning: For OpenFrontIO project: When localization keys are renamed in language JSON files, the maintainers separate technical changes from translation content updates. They wait for community translators to update the actual translation values rather than attempting to translate in the same PR. This allows technical changes to proceed while ensuring accurate translations from native speakers.
src/client/Main.ts (3)
Learnt from: VariableVince
PR: openfrontio/OpenFrontIO#1110
File: src/client/Main.ts:293-295
Timestamp: 2025-06-09T02:20:43.637Z
Learning: In src/client/Main.ts, during game start in the handleJoinLobby callback, UI elements are hidden using direct DOM manipulation with classList.add("hidden") for consistency. This includes modals, buttons, and error divs. The codebase follows this pattern rather than using component APIs for hiding elements during game transitions.
Learnt from: scottanderson
PR: openfrontio/OpenFrontIO#786
File: src/client/TerritoryPatternsModal.ts:337-338
Timestamp: 2025-06-22T05:48:19.241Z
Learning: In src/client/TerritoryPatternsModal.ts, the bit shifting operators (<<) used in coordinate calculations with decoder.getScale() are intentional and should not be changed to multiplication. The user scottanderson confirmed this is functioning as intended.
Learnt from: devalnor
PR: openfrontio/OpenFrontIO#1248
File: src/client/graphics/layers/TerritoryInfoLayer.ts:20-20
Timestamp: 2025-06-22T21:51:14.990Z
Learning: In TerritoryInfoLayer.ts, the highlightedTerritory field uses both null and undefined intentionally: undefined represents initial state or inactive layer (Ctrl released), while null represents active layer with no territory being highlighted at cursor position. This distinction is important for proper state change detection.
src/server/Privilege.ts (2)
Learnt from: Aotumuri
PR: openfrontio/OpenFrontIO#709
File: src/client/Main.ts:276-296
Timestamp: 2025-05-16T12:06:01.732Z
Learning: In the OpenFrontIO codebase, `checkPermission()` function's return values need to be handled with defensive checks using `Array.isArray()`, even though its TypeScript signature indicates it returns arrays. Removing these checks breaks functionality.
Learnt from: VariableVince
PR: openfrontio/OpenFrontIO#1192
File: src/client/graphics/layers/RadialMenuElements.ts:312-314
Timestamp: 2025-06-16T03:03:59.778Z
Learning: In RadialMenuElements.ts, when fixing undefined params errors in subMenu functions, use explicit checks like `if (params === undefined || params.selected === null)` rather than optional chaining, as it makes the intent clearer and matches the specific error scenarios where params can be undefined during spawn phase operations.
src/client/TerritoryPatternsModal.ts (2)
Learnt from: scottanderson
PR: openfrontio/OpenFrontIO#786
File: src/client/TerritoryPatternsModal.ts:337-338
Timestamp: 2025-06-22T05:48:19.241Z
Learning: In src/client/TerritoryPatternsModal.ts, the bit shifting operators (<<) used in coordinate calculations with decoder.getScale() are intentional and should not be changed to multiplication. The user scottanderson confirmed this is functioning as intended.
Learnt from: devalnor
PR: openfrontio/OpenFrontIO#1248
File: src/client/graphics/layers/TerritoryInfoLayer.ts:20-20
Timestamp: 2025-06-22T21:51:14.990Z
Learning: In TerritoryInfoLayer.ts, the highlightedTerritory field uses both null and undefined intentionally: undefined represents initial state or inactive layer (Ctrl released), while null represents active layer with no territory being highlighted at cursor position. This distinction is important for proper state change detection.
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: 🏗️ Build
  • GitHub Check: Deploy to openfront.dev
🔇 Additional comments (3)
src/server/Privilege.ts (1)

43-43: Good defensive programming with optional chaining.

This prevents runtime errors when role_groups[groupName] is undefined. The optional chaining ensures safe access and maintains the expected behavior of the conditional check.

src/client/Main.ts (1)

185-200: Clear variable naming improvement.

Renaming from tpButton to patternButton makes the code more readable and self-documenting. The full name is easier to understand, especially for team members who may not be familiar with the abbreviation.

src/client/TerritoryPatternsModal.ts (1)

67-71: Excellent pattern validation logic.

This defensive check prevents users from having invalid patterns selected. The validation covers both missing patterns and locked/hidden patterns, with appropriate fallback to the default pattern. The console warning helps with debugging when patterns become unavailable.


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

@evanpelle evanpelle marked this pull request as ready for review July 4, 2025 20:11
@evanpelle evanpelle requested a review from a team as a code owner July 4, 2025 20:11
@evanpelle evanpelle added this to the v24 milestone Jul 4, 2025
@evanpelle evanpelle merged commit 0fed0e9 into main Jul 4, 2025
13 of 25 checks passed
@evanpelle evanpelle deleted the evan-fix-pattern-role-bugs branch July 4, 2025 20:13
@github-project-automation github-project-automation bot moved this from Triage to Complete in OpenFront Release Management Jul 4, 2025
@coderabbitai coderabbitai bot mentioned this pull request Jul 9, 2025
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

1 participant