NEW (GraphEngine): @W-11989381@: New MultipleMassSchemaLookupRule to detect performance degrading schema lookups. #1054
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package com.salesforce.rules; | ||
|
|
||
| import com.salesforce.config.UserFacingMessages; | ||
| import com.salesforce.graph.ApexPath; | ||
| import com.salesforce.graph.vertex.BaseSFVertex; | ||
| import com.salesforce.rules.multiplemassschemalookup.MultipleMassSchemaLookupRuleHandler; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource; | ||
|
|
||
| /** Rule to detect possible performance degradations while invoking Schema.getGlobalDescribe(). */ | ||
| public class MultipleMassSchemaLookupRule extends AbstractPathTraversalRule { | ||
|
|
||
| private final MultipleMassSchemaLookupRuleHandler ruleHandler; | ||
|
|
||
| private MultipleMassSchemaLookupRule() { | ||
| ruleHandler = MultipleMassSchemaLookupRuleHandler.getInstance(); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean test(BaseSFVertex vertex) { | ||
| return ruleHandler.test(vertex); | ||
| } | ||
|
|
||
| @Override | ||
| protected List<RuleThrowable> _run(GraphTraversalSource g, ApexPath path, BaseSFVertex vertex) { | ||
| List<RuleThrowable> violations = new ArrayList<>(); | ||
|
|
||
| violations.addAll(ruleHandler.detectViolations(g, path, vertex)); | ||
|
|
||
| return violations; | ||
| } | ||
|
|
||
| @Override | ||
| protected int getSeverity() { | ||
| return SEVERITY.HIGH.code; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getDescription() { | ||
| return UserFacingMessages.RuleDescriptions.MULTIPLE_MASS_SCHEMA_LOOKUP_RULE; | ||
| } | ||
|
|
||
| @Override | ||
| protected String getCategory() { | ||
| return CATEGORY.PERFORMANCE.name; | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isEnabled() { | ||
| return false; | ||
| } | ||
|
|
||
| public static MultipleMassSchemaLookupRule getInstance() { | ||
| return MultipleMassSchemaLookupRule.LazyHolder.INSTANCE; | ||
| } | ||
|
|
||
| private static final class LazyHolder { | ||
| // Postpone initialization until first use | ||
| private static final MultipleMassSchemaLookupRule INSTANCE = | ||
| new MultipleMassSchemaLookupRule(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package com.salesforce.rules.multiplemassschemalookup; | ||
|
|
||
| import com.salesforce.config.UserFacingMessages; | ||
| import com.salesforce.graph.vertex.MethodCallExpressionVertex; | ||
| import com.salesforce.graph.vertex.SFVertex; | ||
|
|
||
| /** Utility to help with violation message creation on AvoidMassSchemaLookupRule */ | ||
| public final class MassSchemaLookupInfoUtil { | ||
| private MassSchemaLookupInfoUtil() {} | ||
|
|
||
| public static String getMessage(MultipleMassSchemaLookupInfo info) { | ||
| return getMessage( | ||
| info.getSinkVertex().getFullMethodName(), | ||
| info.getRepetitionType(), | ||
| getOccurrenceInfoValue(info.getRepetitionType(), info.getRepetitionVertex()), | ||
| info.getRepetitionVertex().getDefiningType(), | ||
| info.getRepetitionVertex().getBeginLine()); | ||
| } | ||
|
|
||
| public static String getMessage( | ||
| String sinkMethodName, | ||
| RuleConstants.RepetitionType repetitionType, | ||
| String occurrenceInfoValue, | ||
| String occurrenceClassName, | ||
| int occurrenceLine) { | ||
| final String occurrenceMessage = getOccurrenceMessage(repetitionType, occurrenceInfoValue); | ||
|
|
||
| return String.format( | ||
| UserFacingMessages.MultipleMassSchemaLookupRuleTemplates.MESSAGE_TEMPLATE, | ||
| sinkMethodName, | ||
| occurrenceMessage, | ||
| occurrenceClassName, | ||
| occurrenceLine); | ||
| } | ||
|
|
||
| private static String getOccurrenceInfoValue( | ||
| RuleConstants.RepetitionType repetitionType, SFVertex repetitionVertex) { | ||
| if (RuleConstants.RepetitionType.MULTIPLE.equals(repetitionType)) { | ||
| // Use method name on template message | ||
| return ((MethodCallExpressionVertex) repetitionVertex).getFullMethodName(); | ||
| } else { | ||
| // Use Loop type on template message | ||
| return repetitionVertex.getLabel(); | ||
| } | ||
| } | ||
|
|
||
| private static String getOccurrenceMessage( | ||
| RuleConstants.RepetitionType repetitionType, String value) { | ||
| return repetitionType.getMessage(value); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved UI text.