update HE 使用 rewriter plugin 重构语法处理部分 #348
Conversation
WalkthroughThe recent updates focus on enhancing the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HEProxy
participant HETreeMethodRewriter
participant HETreeTriviaRewriter
User->>HEProxy: Start Hot Compilation
activate HEProxy
HEProxy->>HETreeMethodRewriter: Register Method Plugins
activate HETreeMethodRewriter
HETreeMethodRewriter->>HEProxy: Plugins Registered
deactivate HETreeMethodRewriter
HEProxy->>HETreeTriviaRewriter: Register Trivia Plugins
activate HETreeTriviaRewriter
HETreeTriviaRewriter->>HEProxy: Plugins Registered
deactivate HETreeTriviaRewriter
HEProxy->>HEProxy: Rewrite Methods and Comments with Plugins
User->>HEProxy: Complete Hot Compilation
deactivate HEProxy
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
@coderabbitai review |
Actions performedReview triggered.
|
|
未检测到合适的 ISSUE 推荐给您。感谢您的反馈！
|
UT Test - Ubuntu1 tests 1 ✅ 0s ⏱️ Results for commit 9a3a4c4. |
UT Test - Windows1 tests 1 ✅ 0s ⏱️ Results for commit 9a3a4c4. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Outside diff range and nitpick comments (3)
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/ToplevelHandler.cs (1)
Line range hint
11-21:
Suggestion: Use StringBuilder for concatenation.Using
StringBuilderfor concatenation can improve performance.- var content = "public class Program{ async static Task Main(string[] args){" + root!.ToFullString() + "}}"; + var content = new StringBuilder("public class Program{ async static Task Main(string[] args){") + .Append(root!.ToFullString()) + .Append("}}") + .ToString();src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/ProxyMethodPlugin.cs (1)
38-41: Add a comment to indicate no initialization needed.The method is empty and does not perform any initialization. Consider adding a comment to indicate that no initialization is needed.
- public override void Initialize() - { - - } + public override void Initialize() + { + // No initialization needed + }src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/OptimizationTriviaPlugin.cs (1)
25-28: Add a comment to indicate no handling needed.The method currently does not perform any handling and returns null. Consider adding a comment to indicate that no handling is needed.
- public override string? Handle(string comment, string lowerComment) - { - return null; - } + public override string? Handle(string comment, string lowerComment) + { + // No handling needed + return null; + }
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (15)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HEMethodTriviaRewriter.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HETreeMethodRewriter.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HETreeTriviaRewriter.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/OnceHandler.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/CS0104Plugin/CS0104TriviaPlugin.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/OutputPlugin/OutputTriviaPlugin.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/AsyncTriviaPlugin.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/OptimizationTriviaPlugin.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/ProxyMethodPlugin.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/Standard/MethodSyntaxPluginBase.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/Standard/TriviaSyntaxPluginBase.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/ToplevelHandler.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/UsingsHandler.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/Utils/CommentHelper.cs (1 hunks)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/HEProxy.cs (13 hunks)
Files skipped from review due to trivial changes (3)
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/Standard/TriviaSyntaxPluginBase.cs
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/UsingsHandler.cs
- src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/Utils/CommentHelper.cs
Additional comments not posted (45)
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/Standard/MethodSyntaxPluginBase.cs (5)
7-8: LGTM! Fields are correctly defined and initialized.The fields
MethodNameandTriviaSyntaxPluginBasesare appropriately defined and initialized.
9-13: LGTM! Constructor is correctly implemented.The constructor initializes
MethodNameandTriviaSyntaxPluginBasescorrectly.
14-14: LGTM! Abstract method declaration is correct.The
Initializemethod is correctly declared as abstract.
16-20: LGTM! Method correctly adds trivia plugin to the list.The
RegisteTriviaPluginmethod correctly adds a trivia plugin to theTriviaSyntaxPluginBaseslist.
21-25: LGTM! Methods are correctly implemented.The
ClearTriviaPluginmethod clears theTriviaSyntaxPluginBaseslist and theHandlemethod is correctly declared as abstract.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/AsyncTriviaPlugin.cs (5)
5-6: LGTM! Fields are correctly defined and initialized.The fields
_asyncCommentTagandIsAsyncare appropriately defined and initialized.
7-10: LGTM! Constructor is correctly implemented.The constructor initializes
_asyncCommentTagcorrectly.
11-14: LGTM! Method correctly sets_asyncCommentTag.The
SetAsyncCommentTagmethod correctly sets_asyncCommentTag.
15-24: LGTM! Methods are correctly implemented.The
Handlemethod setsIsAsyncto true andInitializeresetsIsAsync.
26-29: LGTM! Method correctly matches the comment with_asyncCommentTag.The
IsMatchmethod correctly matches the comment with_asyncCommentTag.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/ToplevelHandler.cs (1)
Line range hint
11-21:
LGTM! Method correctly handles top-level statements.The
Handlemethod correctly handles top-level statements and adds using directives.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/CS0104Plugin/CS0104TriviaPlugin.cs (5)
5-6: LGTM! Fields are correctly defined and initialized.The fields
_excludeUsingCommentandExcludeUsingsare appropriately defined and initialized.
7-10: LGTM! Constructor is correctly implemented.The constructor initializes
_excludeUsingCommentandExcludeUsingscorrectly.
13-16: LGTM! Method correctly sets_excludeUsingComment.The
SetMatchCommentmethod correctly sets_excludeUsingComment.
18-21: LGTM! Method correctly clearsExcludeUsings.The
Initializemethod correctly clearsExcludeUsings.
23-33: LGTM! Methods are correctly implemented.The
IsMatchmethod matches the comment with_excludeUsingCommentand theHandlemethod processes the comment.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/ProxyMethodPlugin.cs (2)
10-13: Constructor looks good!The constructor correctly initializes the
_kindfield.
14-17: Method looks good!The method correctly sets the
_kindfield.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HEMethodTriviaRewriter.cs (2)
9-12: Constructor looks good!The constructor correctly initializes the
_methodTriviaSyntaxPluginsfield.
13-35: Method looks good!The method correctly processes single-line comments using the registered plugins and returns the modified comment if a plugin handles it.
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/ProxyMainPlugin/OptimizationTriviaPlugin.cs (4)
8-12: Constructor looks good!The constructor correctly initializes the
_proxyCommentOPLDebugand_proxyCommentOPLReleasefields.
14-17: Method looks good!The method correctly sets the
_proxyCommentOPLDebugfield.
19-22: Method looks good!The method correctly sets the
_proxyCommentOPLReleasefield.
30-33: Method looks good!The method correctly initializes the
IsReleasefield.src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HETreeTriviaRewriter.cs (2)
16-19: Constructor looks good!The constructor correctly initializes the
_triviaPluginsfield.
27-54: Method looks good!The method correctly processes single-line comments using the registered plugins and returns the modified comment if a plugin handles it.
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/SyntaxPlugin/OutputPlugin/OutputTriviaPlugin.cs (6)
9-15: Constructor looks good!The constructor correctly initializes the properties and sets a unique comment prefix.
17-20: Method looks good!The method correctly sets the
_debugOutputCommentproperty.
22-25: Method looks good!The method correctly sets the
_releaseOutputCommentproperty.
27-34: Method looks good!The method correctly processes comments based on the release mode.
41-52: Method looks good!The method correctly checks if a comment matches the debug or release output comment.
54-61: Method looks good!The method correctly generates a preprocessor replace script.
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/OnceHandler.cs (3)
10-13: Method looks good!The method correctly sets the
_onceCommentproperty.
14-52: Method looks good!The method correctly processes compilation unit syntax to remove statements with specific comments.
54-73: Method looks good!The method correctly checks if a statement should be removed based on its comments.
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/Component/SyntaxHandler/HETreeMethodRewriter.cs (1)
49-79: Method looks good!The method correctly processes method declarations using registered plugins.
src/Natasha.CSharp/Extension/HotExecutor/Natasha.CSharp.HotExecutor/HEProxy.cs (9)
42-49: Properties look good!The properties correctly initialize several plugins and rewriters.
Line range hint
49-71: Static constructor looks good!The static constructor correctly initializes several fields and registers plugins.
Line range hint
72-109: Method looks good!The method correctly sets up a project watcher with several callbacks.
Line range hint
110-149: Method looks good!The method correctly sets up a main watcher with several callbacks.
Line range hint
150-180: Method looks good!The method correctly initializes and starts the watchers.
Line range hint
181-241: Method looks good!The method correctly processes a file's syntax tree.
Line range hint
242-343: Method looks good!The method correctly performs hot execution of the compiled code.
516-516: Method looks good!The method correctly sets the once comment tag.
540-543: Method looks good!The method correctly sets the debug output comment tag.
| public override BlockSyntax? Handle(BlockSyntax blockSyntax) | ||
| { | ||
| ClassDeclarationSyntax? parentClass = blockSyntax.Parent!.Parent as ClassDeclarationSyntax ?? throw new Exception($"获取 {MethodName} 方法类名出现错误！"); | ||
| ClassName = parentClass.Identifier.Text; | ||
|
|
||
| if (_kind == HEProjectKind.Winform) | ||
| { | ||
| return WinformRewriter.Handle(blockSyntax); | ||
| } | ||
| else if (_kind == HEProjectKind.WPF) | ||
| { | ||
| return WpfWriter.Handle(blockSyntax); | ||
| } | ||
| else if (_kind == HEProjectKind.Console) | ||
| { | ||
| return ConsoleWriter.Handle(blockSyntax); | ||
| } | ||
| return null; |
There was a problem hiding this comment.
Consider using a specific exception type.
The method correctly handles different project kinds and rewrites the syntax accordingly. However, consider using a specific exception type for better error handling.
- ClassDeclarationSyntax? parentClass = blockSyntax.Parent!.Parent as ClassDeclarationSyntax ?? throw new Exception($"获取 {MethodName} 方法类名出现错误！");
+ ClassDeclarationSyntax? parentClass = blockSyntax.Parent!.Parent as ClassDeclarationSyntax ?? throw new InvalidOperationException($"获取 {MethodName} 方法类名出现错误！");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.
| public override BlockSyntax? Handle(BlockSyntax blockSyntax) | |
| { | |
| ClassDeclarationSyntax? parentClass = blockSyntax.Parent!.Parent as ClassDeclarationSyntax ?? throw new Exception($"获取 {MethodName} 方法类名出现错误！"); | |
| ClassName = parentClass.Identifier.Text; | |
| if (_kind == HEProjectKind.Winform) | |
| { | |
| return WinformRewriter.Handle(blockSyntax); | |
| } | |
| else if (_kind == HEProjectKind.WPF) | |
| { | |
| return WpfWriter.Handle(blockSyntax); | |
| } | |
| else if (_kind == HEProjectKind.Console) | |
| { | |
| return ConsoleWriter.Handle(blockSyntax); | |
| } | |
| return null; | |
| public override BlockSyntax? Handle(BlockSyntax blockSyntax) | |
| { | |
| ClassDeclarationSyntax? parentClass = blockSyntax.Parent!.Parent as ClassDeclarationSyntax ?? throw new InvalidOperationException($"获取 {MethodName} 方法类名出现错误！"); | |
| ClassName = parentClass.Identifier.Text; | |
| if (_kind == HEProjectKind.Winform) | |
| { | |
| return WinformRewriter.Handle(blockSyntax); | |
| } | |
| else if (_kind == HEProjectKind.WPF) | |
| { | |
| return WpfWriter.Handle(blockSyntax); | |
| } | |
| else if (_kind == HEProjectKind.Console) | |
| { | |
| return ConsoleWriter.Handle(blockSyntax); | |
| } | |
| return null; |
| public HETreeTriviaRewriter RegistePlugin(TriviaSyntaxPluginBase triviaSyntaxPluginBase) | ||
| { | ||
| _triviaPlugins.Add(triviaSyntaxPluginBase); | ||
| return this; | ||
| } |
There was a problem hiding this comment.
Rename method to RegisterPlugin.
The method correctly adds the plugin to _triviaPlugins but the method name has a spelling error.
- public HETreeTriviaRewriter RegistePlugin(TriviaSyntaxPluginBase triviaSyntaxPluginBase)
+ public HETreeTriviaRewriter RegisterPlugin(TriviaSyntaxPluginBase triviaSyntaxPluginBase)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.
| public HETreeTriviaRewriter RegistePlugin(TriviaSyntaxPluginBase triviaSyntaxPluginBase) | |
| { | |
| _triviaPlugins.Add(triviaSyntaxPluginBase); | |
| return this; | |
| } | |
| public HETreeTriviaRewriter RegisterPlugin(TriviaSyntaxPluginBase triviaSyntaxPluginBase) | |
| { | |
| _triviaPlugins.Add(triviaSyntaxPluginBase); | |
| return this; | |
| } |
| public HETreeMethodRewriter() | ||
| { | ||
| _methodPlugins = []; | ||
| _methodTriviaPlugins = []; | ||
| } |
There was a problem hiding this comment.
Fix the initialization of _methodPlugins and _methodTriviaPlugins.
The constructor incorrectly initializes _methodPlugins and _methodTriviaPlugins with empty array brackets instead of new ConcurrentDictionary<>().
- _methodPlugins = [];
- _methodTriviaPlugins = [];
+ _methodPlugins = new ConcurrentDictionary<string, HashSet<MethodSyntaxPluginBase>>();
+ _methodTriviaPlugins = new ConcurrentDictionary<string, HashSet<TriviaSyntaxPluginBase>>();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.
| public HETreeMethodRewriter() | |
| { | |
| _methodPlugins = []; | |
| _methodTriviaPlugins = []; | |
| } | |
| public HETreeMethodRewriter() | |
| { | |
| _methodPlugins = new ConcurrentDictionary<string, HashSet<MethodSyntaxPluginBase>>(); | |
| _methodTriviaPlugins = new ConcurrentDictionary<string, HashSet<TriviaSyntaxPluginBase>>(); | |
| } |
| public HETreeMethodRewriter RegistePlugin(MethodSyntaxPluginBase methodSyntaxPlugin) | ||
| { | ||
| if (_methodPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var methodPlugins)) | ||
| { | ||
| methodPlugins.Add(methodSyntaxPlugin); | ||
| } | ||
| else | ||
| { | ||
| _methodPlugins[methodSyntaxPlugin.MethodName] = [methodSyntaxPlugin]; | ||
| } | ||
| if (_methodTriviaPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var triviaPlugins)) | ||
| { | ||
|
|
||
| if (methodSyntaxPlugin.TriviaSyntaxPluginBases.Count>0) | ||
| { | ||
| triviaPlugins.UnionWith(methodSyntaxPlugin.TriviaSyntaxPluginBases); | ||
| } | ||
|
|
||
| } | ||
| else | ||
| { | ||
| _methodTriviaPlugins[methodSyntaxPlugin.MethodName] = new(methodSyntaxPlugin.TriviaSyntaxPluginBases); | ||
|
|
||
| } | ||
| return this; |
There was a problem hiding this comment.
Fix the use of array brackets for initializing collections.
The method incorrectly uses array brackets for initializing collections instead of new HashSet<>().
- _methodPlugins[methodSyntaxPlugin.MethodName] = [methodSyntaxPlugin];
- _methodTriviaPlugins[methodSyntaxPlugin.MethodName] = new(methodSyntaxPlugin.TriviaSyntaxPluginBases);
+ _methodPlugins[methodSyntaxPlugin.MethodName] = new HashSet<MethodSyntaxPluginBase> { methodSyntaxPlugin };
+ _methodTriviaPlugins[methodSyntaxPlugin.MethodName] = new HashSet<TriviaSyntaxPluginBase>(methodSyntaxPlugin.TriviaSyntaxPluginBases);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.
| public HETreeMethodRewriter RegistePlugin(MethodSyntaxPluginBase methodSyntaxPlugin) | |
| { | |
| if (_methodPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var methodPlugins)) | |
| { | |
| methodPlugins.Add(methodSyntaxPlugin); | |
| } | |
| else | |
| { | |
| _methodPlugins[methodSyntaxPlugin.MethodName] = [methodSyntaxPlugin]; | |
| } | |
| if (_methodTriviaPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var triviaPlugins)) | |
| { | |
| if (methodSyntaxPlugin.TriviaSyntaxPluginBases.Count>0) | |
| { | |
| triviaPlugins.UnionWith(methodSyntaxPlugin.TriviaSyntaxPluginBases); | |
| } | |
| } | |
| else | |
| { | |
| _methodTriviaPlugins[methodSyntaxPlugin.MethodName] = new(methodSyntaxPlugin.TriviaSyntaxPluginBases); | |
| } | |
| return this; | |
| public HETreeMethodRewriter RegistePlugin(MethodSyntaxPluginBase methodSyntaxPlugin) | |
| { | |
| if (_methodPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var methodPlugins)) | |
| { | |
| methodPlugins.Add(methodSyntaxPlugin); | |
| } | |
| else | |
| { | |
| _methodPlugins[methodSyntaxPlugin.MethodName] = new HashSet<MethodSyntaxPluginBase> { methodSyntaxPlugin }; | |
| } | |
| if (_methodTriviaPlugins.TryGetValue(methodSyntaxPlugin.MethodName, out var triviaPlugins)) | |
| { | |
| if (methodSyntaxPlugin.TriviaSyntaxPluginBases.Count>0) | |
| { | |
| triviaPlugins.UnionWith(methodSyntaxPlugin.TriviaSyntaxPluginBases); | |
| } | |
| } | |
| else | |
| { | |
| _methodTriviaPlugins[methodSyntaxPlugin.MethodName] = new HashSet<TriviaSyntaxPluginBase>(methodSyntaxPlugin.TriviaSyntaxPluginBases); | |
| } | |
| return this; |
Summary by CodeRabbit
New Features
Refactor
HEProxyclass to utilize newly introduced plugins.