Skip to content

Conversation

@codegen-sh
Copy link
Contributor

@codegen-sh codegen-sh bot commented Aug 9, 2025

Requested by: Jake Ruesink

Summary

  • Add optional runtime validation to packages/utils/src/storage.ts loadFromStorage<T> so parsed values can be gated by a provided type guard.
  • Behavior: if validate is provided and returns false, return fallback instead of trusting JSON.parse blindly.
  • No breaking changes to existing callers (third param optional).

Changes

  • Update signature and implementation of loadFromStorage to accept validate?: (value: unknown) => value is T and apply it to the parsed value.
  • Add unit tests in packages/utils/src/__tests__/storage.test.ts covering:
    • valid parse path
    • malformed JSON fallback path
    • validate-guard reject path

Integration notes

  • Optional callsite updates can pass a guard function when desired, e.g., for the TodoState shape in apps/todo-app/app/lib/todo-context.tsx. Current behavior remains unchanged if omitted.

Relevant files

  • packages/utils/src/storage.ts
  • packages/utils/src/tests/storage.test.ts

Compliance

  • Repo rules: created changes on a feature branch, validated with lint and typecheck at workspace level, and added tests (utils package tests pass).

💻 View my work • 👤 Initiated by Jake RuesinkAbout Codegen
⛔ Remove Codegen from PR🚫 Ban action checks

@linear
Copy link

linear bot commented Aug 9, 2025

STA-7 [Major] Add runtime validation to storage loader (utils.loadFromStorage)

Requested by: Jake Ruesink

Summary
Add an optional runtime validation step to the storage loader so we never trust JSON.parse blindly. This prevents invalid shapes from poisoning app state and improves robustness.

Base branch for PR: codegen-bot/persist-todos-localstorage-STA-2-1754688724
Target repo: lambda-curry/react-router-starter

Code context

  • File: packages/utils/src/storage.ts
  • Current:
export function loadFromStorage<T>(key: string, fallback: T): T {
  const storage = getStorage();
  if (!storage) return fallback;
  try {
    const raw = storage.getItem(key);
    if (!raw) return fallback;
    return JSON.parse(raw) as T; // broad cast
  } catch {
    return fallback;
  }
}
  • Change signature and gate parsed value with a type guard:
export function loadFromStorage<T>(
  key: string,
  fallback: T,
  validate?: (value: unknown) => value is T
): T {
  const storage = getStorage();
  if (!storage) return fallback;
  try {
    const raw = storage.getItem(key);
    if (!raw) return fallback;
    const parsed = JSON.parse(raw);
    if (validate && !validate(parsed)) return fallback;
    return parsed as T;
  } catch {
    return fallback;
  }
}
  • Optional call site update (no behavior change if omitted):
    • File: apps/todo-app/app/lib/todo-context.tsx
    • Provide a simple guard for TodoState (object with todos array and filter string), or keep current behavior by not passing validate.

Acceptance criteria

  • loadFromStorage accepts an optional validate guard and returns fallback when validation fails.
  • No breaking changes to existing callers; all current usage continues to work.
  • Unit tests cover: valid parse, malformed JSON fallback, validate-guard reject path.

References

@coderabbitai
Copy link

coderabbitai bot commented Aug 9, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codegen/sta-7-major-add-runtime-validation-to-storage-loader

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate unit tests to generate unit tests for 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.

@codegen-sh
Copy link
Contributor Author

codegen-sh bot commented Aug 9, 2025

🔍 Check Suite Status for PR #11

Check Status Commit Time Check Suite Agent trace
quality-checks 🔄 Working 4b16a9a Just now Run Agent Work

💻 View my work🛑 Stop🚫 Ban all checks

@jaruesink jaruesink marked this pull request as ready for review August 9, 2025 03:53
…' of github.com:lambda-curry/react-router-starter into codegen/sta-7-major-add-runtime-validation-to-storage-loader
@jaruesink jaruesink merged commit 2cfaab9 into codegen-bot/persist-todos-localstorage-STA-2-1754688724 Aug 9, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants