Skip to content

refactor(AppController): Remove obsolete StateContext references; Relocate file to component/ (fixes #280). #281

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

Merged
merged 3 commits into from
May 16, 2025

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented May 16, 2025

Description

Previously, StateContextProvider was renamed to AppController and stopped providing context; this commit finalizes the refactor by removing the unused createContext call and lingering StateContext references, and moving AppController.tsx from context/ to component/ to reflect its new role.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  1. Performed manual testing with the demo file as instructed by https://docs.yscope.com/yscope-log-viewer/main/dev-guide/contributing-validation.html#manual-testing

Summary by CodeRabbit

  • Refactor
    • Simplified internal structure by removing an unused context provider and updating component imports. No visible changes to app behaviour for end-users.

@junhaoliao junhaoliao requested a review from a team as a code owner May 16, 2025 16:24
@junhaoliao junhaoliao requested a review from Henry8192 May 16, 2025 16:24
Copy link

coderabbitai bot commented May 16, 2025

"""

Walkthrough

The changes update the import path of AppController in App.tsx and refactor AppController.tsx by removing the unused StateContext and its provider, renaming the props interface, and reorganizing imports. The top-level JSX wrapper was simplified by returning children directly. The core logic and side effects remain unchanged.

Changes

File(s) Change Summary
src/App.tsx Changed import path of AppController from ./contexts/AppController to ./components/AppController.
src/components/AppController.tsx Removed unused StateContext and its provider, renamed props interface from StateContextProviderProps to AppControllerProps, reorganized imports, and simplified JSX wrapper to return children directly.

Possibly related issues

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 warn config production Use --omit=dev instead.
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-05-16T17_07_45_378Z-debug-0.log

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

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 docstrings to generate docstrings for this 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.

@junhaoliao junhaoliao changed the title refactor(AppController): Remove obsolete StateContext references; Relrelocate file to component/ refactor(AppController): Remove obsolete StateContext references; Relrelocate file to component/. May 16, 2025
@junhaoliao junhaoliao changed the title refactor(AppController): Remove obsolete StateContext references; Relrelocate file to component/. refactor(AppController): Remove obsolete StateContext references; Relocate file to component/. May 16, 2025
@junhaoliao junhaoliao requested a review from hoophalab May 16, 2025 16:26
@junhaoliao junhaoliao changed the title refactor(AppController): Remove obsolete StateContext references; Relocate file to component/. refactor(AppController): Remove obsolete StateContext references; Relocate file to component/ (fixes #280). May 16, 2025
@@ -126,11 +123,10 @@ const AppController = ({children}: StateContextProviderProps) => {
return;
}

const clampedLogEventNum = clamp(logEventNum, 1, numEvents);
Copy link
Collaborator

Choose a reason for hiding this comment

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

are we moving this purely because the calling sequence of updateUrlIfEventOnPage?

Copy link
Member Author

Choose a reason for hiding this comment

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

My mistake. this change should be reverted and be done in #264

Copy link

@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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8c4026d and bafcf16.

📒 Files selected for processing (1)
  • src/components/AppController.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/components/AppController.tsx
🔇 Additional comments (2)
src/components/AppController.tsx (2)

7-13: Import paths updated correctly
The NotificationContext and UrlContextProvider imports have been relocated from the old context/ directory to ../contexts/. These paths align with the new file structure and all imported members (updateWindowUrlHashParams, URL_HASH_PARAMS_DEFAULT, etc.) are used downstream.


71-74: Props interface and component signature renamed
Renaming StateContextProviderProps to AppControllerProps and updating the AppController signature to use this new interface is clear and consistent. The destructuring of children: React.ReactNode remains correct.

Also applies to: 82-82

Copy link

@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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bafcf16 and 01454a7.

📒 Files selected for processing (1)
  • src/components/AppController.tsx (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/components/AppController.tsx
🔇 Additional comments (3)
src/components/AppController.tsx (3)

71-73: Rename props interface to match component
Renaming from the old StateContextProviderProps to AppControllerProps ensures the interface accurately reflects this component’s purpose. The shape remains minimal with only children.


7-13:

✅ Verification successful

Removed obsolete StateContext imports and updated context paths
The import for createContext and all StateContext references have been dropped in favour of the new NotificationContext and UrlContext providers under ../contexts/. This aligns with the refactor objectives. Please confirm no residual StateContext usages remain.


🏁 Script executed:

#!/bin/bash
# Verify no residual StateContext references in the codebase
rg -n "StateContext"

Length of output: 20


Obsolete StateContext imports fully removed
A repository-wide search for StateContext returned no results, confirming the refactor is complete and no residual references remain.

  • Verified in: src/components/AppController.tsx (Lines 7–13 updated to use NotificationContext and UrlContext)

189-189: 🧹 Nitpick (assertive)

Streamline render by returning children directly
Now that there’s no context wrapper, returning children is sufficient. Optionally, you can use an explicit React fragment to make it clear we’re returning JSX:

-    return children;
+    return <>{children}</>;

Likely an incorrect or invalid review comment.

Comment on lines 1 to 5
import React, {
createContext,
useContext,
useEffect,
useRef,
} from "react";
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Optimize React import for type-only usage
Since React is only referenced for the React.ReactNode type in this file, you can switch to a type-only import to avoid pulling in the entire React namespace at runtime (with TS’s importsNotUsedAsValues: "error").

-import React, {
-    useContext,
-    useEffect,
-    useRef,
-} from "react";
+import { useContext, useEffect, useRef } from "react";
+import type { ReactNode } from "react";
📝 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
import React, {
createContext,
useContext,
useEffect,
useRef,
} from "react";
import { useContext, useEffect, useRef } from "react";
import type { ReactNode } from "react";
🤖 Prompt for AI Agents
In src/components/AppController.tsx lines 1 to 5, the React import is currently
importing the entire React namespace, but React is only used for the
React.ReactNode type. Change the import to a type-only import by using `import
type { ReactNode } from "react"` instead of importing the full React object.
This will optimize the import by avoiding pulling in React at runtime
unnecessarily.

@junhaoliao junhaoliao requested a review from Henry8192 May 16, 2025 17:36
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