feat: move opinit keyfile generation to the confirmation step

[traviolus]

Description

Closes: #XXXX

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow-up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

The latest update brings improvements to bot operations with more reliable key management and enhanced error handling. These changes ensure that bot credentials are handled securely for a smoother experience.

• New Features
  • Enhanced bot key management with secure loading and saving of credentials upon key press.
  • Improved error handling during key processing, ensuring reliable bot operations.

[coderabbitai]

Walkthrough

The changes refactor the key management logic for OPInit bots in the models/opinit_bots/init.go file. The code now retrieves the key file path via weavecontext.GetOPInitKeyFileJson(m.Ctx), loads the key file, and writes the mnemonic and address for each bot based on state.SetupOpinitResponses. Error handling has been improved by triggering panic on failures. Additionally, redundant key file handling code has been removed, consolidating the logic to run when the "enter" key is pressed.

Changes

File	Change Summary
models/opinit_bots/init.go	Added logic to retrieve key file path using weavecontext.GetOPInitKeyFileJson(m.Ctx), load and write bot key details (mnemonic and address) from state.SetupOpinitResponses, and enhanced error handling. Removed redundant key file operations.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant S as SetupOPInitBotsMissingKey
    participant W as WeaveContext
    participant K as KeyFile System

    U->>S: Trigger update (Enter key)
    S->>W: GetOPInitKeyFileJson(m.Ctx)
    W-->>S: Return key file path
    S->>K: Load key file & parse SetupOpinitResponses
    alt Successful load
        K-->>S: Keys loaded and written successfully
    else Error encountered
        K-->>S: Error message
        S->>S: Panic handling triggered
    end

Loading

Possibly related PRs

• fix: bug opinit not import minitia key #33: The changes in the main PR are related to the modifications in the Update method of the SetupOPInitBotsMissingKey struct, which is also impacted by the new function handleBotInitSelection introduced in the retrieved PR. Both PRs involve enhancements to the bot initialization logic, specifically focusing on key management and state handling.
• feat: add address to keyfile structs #127: The changes in the main PR are related to the modifications in the SetupOPInitBotsMissingKey struct and its methods, which involve loading and managing key files, while the retrieved PR focuses on updating the handling of key files and adding address information to keyfile structures, indicating a direct connection in their functionality regarding key management.

Suggested Reviewers

• WasinWatt
• Benzbeeb

Poem

Hop along in lines of code,
I’m the rabbit on this cyber-road,
Keys now dance with error checks tight,
In files refined, they shine so bright,
A byte-filled hop, a playful sprite—
Celebrate these changes with delight! 🐇

---

📜 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 824dcac and 3c2790f.

📒 Files selected for processing (1)

• models/opinit_bots/init.go (1 hunks)

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

• GitHub Check: Run Integration Tests on Ubuntu

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9aa435b and 824dcac.

📒 Files selected for processing (1)

• models/opinit_bots/init.go (1 hunks)

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

• GitHub Check: Run Integration Tests on Ubuntu

🔇 Additional comments (2)

models/opinit_bots/init.go (2)

1351-1354: No issues with retrieving the OPInit key file path.

The approach for obtaining the key file path is clean and straightforward.

---

1356-1361: Consider explicitly handling the scenario where the key file might not exist.

If the file is expected to be present in all scenarios, then this is fine. Otherwise, if there's a chance keyFilePath doesn’t exist, you could add logic to create or initialize a new key file for first-time users.