feat: invoke save on panic (#51)

[plastikfan]

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced new error types for enhanced error handling, including TraversalSavedError and TraversalNotSavedError.
  • Added AdminOptions to consolidate admin-related configurations within logging options.

• Improvements

  • Enhanced the navigatorAgent and mediator structs to improve state management and error handling.
  • Updated the DefaultPanicHandler to provide more detailed error recovery options.

• Bug Fixes

  • Clarified terminology in comments for the Director interface.

• Tests

  • Added comprehensive unit tests for the "Save" functionality to ensure robust error handling.

• Documentation

  • Updated comments and method signatures for clarity and consistency throughout the codebase.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces various changes across multiple files, including enhancements to spell-checking in .vscode/settings.json, structural modifications to core definitions and error handling, and the introduction of new testing utilities. Key updates include new structs and methods for file system handling, error types, and testing frameworks, as well as improved logging options and interface definitions. The changes collectively enhance functionality, error management, and testing capabilities within the codebase.

Changes

File Path	Change Summary
.vscode/settings.json	Added "jdir" to cSpell.words array.
core/core-defs.go	Introduced FsDescription and Permissions structs, new constants, and a TimeFunc type.
go.mod	Updated github.com/snivilised/nefilim version from v0.1.9 to v0.1.10.
internal/enclave/enclave-defs.go	Removed SaveState struct, relocated Loader type, and added OnLoad method.
internal/feat/resume/save_test.go	Added unit tests for save functionality using Ginkgo and Gomega.
internal/feat/resume/strategy-fastward.go	Updated IsMatch method and improved comments in init method.
internal/kernel/author.go	Introduced author struct and methods for handling vexation data writing.
internal/kernel/kernel-defs.go	Updated navigationStatic struct and added active method to inspection interface.
internal/kernel/mediator.go	Enhanced mediator struct with new fields and updated method signatures for clarity.
internal/kernel/navigation-vapour.go	Added active method to navigationVapour struct.
internal/kernel/navigator-agent.go	Added persister field, updated method signatures, and introduced new Save method.
internal/kernel/navigator-factory.go	Added persister field and updated ofExtent field in navigatorAgent struct.
internal/laboratory/callbacks.go	Introduced PanicAt function to handle specific panic scenarios.
internal/laboratory/static.go	Updated Perms and Static variables with new structures.
internal/laboratory/test-utilities.go	Added GetJSONDir() function for accessing test JSON directory.
locale/messages-errors.go	Introduced new error types and modified existing ones for enhanced error handling.
pref/defaults.go	Updated DefaultPanicHandler function signature to accept parameters and return values.
pref/defects.go	Updated PanicHandler and Rescuer method signatures for enhanced error handling.
pref/facade.go	Added OfExtent() method to Using and Relic structs.
pref/options-log.go	Introduced AdminOptions type and modified MonitorOptions structure.
pref/options.go	Added Admin field to Monitor struct in Options.
pref/pref-defs.go	Introduced new interfaces RescueData and Recovery for structured data handling.
pref/pref-suite_test.go	Updated method signatures in testPanicHandler for enhanced error handling.
traverse-api.go	Updated comments in Director interface and added WithAdminPath constant.

Possibly related PRs

• test(hydra): export virtual tree (#224) #247: This PR is related as it also modifies the .vscode/settings.json file by adding a new entry to the cSpell.words array, similar to the main PR which adds "jdir" to the same array.
• feat(resume): bootstrap resume (#266) #269: This PR introduces changes to the core/core-defs.go file, which may not directly relate to the main PR but involves structural modifications that could impact how terms like "jdir" are handled in the context of active states and navigation.
• feat: define internal addons to allow tests to change internal state … #307: While this PR focuses on defining internal addons for tests, it does not directly relate to the changes in the main PR regarding the .vscode/settings.json file. However, it may indirectly affect testing scenarios that involve spell-checking or related functionalities.

Suggested labels

test

🐰 In the land of code where bunnies play,
A new word's added, hip-hip-hooray!
With tests for saving, and structs so neat,
Our code's now better, oh what a treat!
Hopping through changes, with joy we cheer,
For every new feature, we hold so dear! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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