[LUCENENET-642] Eliminate Runtime Reflection Code from TokenStream

• Type: Task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: Lucene.Net 4.8.0
• Fix Version/s: Lucene.Net 4.8.0
• Component/s: Lucene.Net Core
• Assignee: Shad Storhaug
• Reporter: Shad Storhaug
• Created: 03/Feb/20 05:42
• Updated: 09/Feb/20 06:51
• Resolved: 09/Feb/20 06:51

Description

As per LUCENENET-640, the TokenStream.AssertFinal method is causing performance issues. This method was used to assert that the usage of TokenStream is correct - that is, subclasses or their IncrementToken() method must be sealed.

In Java, there is not a performance issue because asserts are presumably turned off in production applications and the Reflection overhead only happens when debugging. However, in .NET asserts are compiled out of the final release so doing it in a similar way would disable the feature for end users.

Instead, we should create Rosnlyn code analyzers to ensure the project doesn't compile unless the end user seals either the class or its IncrementToken() method. This effectively means we leave the heavy code analysis up to the IDE/build and it doesn't run at all in production.

Per this article, it is feasible to package a code analyzer into the Lucene.Net NuGet package so when it is installed the code analysis will take effect in the IDE.

Issue Links

• Is contained by: LUCENENET-630 Identify/Fix Bottlenecks
• is related to: LUCENENET-640 Sequential IndexWriter performance in concurrent environments.