Merge pull request #1024 from forcedotcom/rm/updateUIMsg_OutOfMemory

rmohan20 · web-flow · commit efc87eaa0072 · 2023-03-17T10:55:08.000-07:00
CHANGE (GraphEngine): @W-12672520@: Applies UI text feedback
diff --git a/messages/run-dfa.js b/messages/run-dfa.js
diff --git a/sfge/src/main/java/com/salesforce/Main.java b/sfge/src/main/java/com/salesforce/Main.java
@@ -85,7 +85,8 @@ int process(String... args) {
         }
         if (args.length == 0) {
             // No args means we can't do anything productive.
-            dependencies.printError(UserFacingMessages.REQUIRES_AT_LEAST_ONE_ARGUMENT);
+            dependencies.printError(
+                    UserFacingMessages.InvocationErrors.REQUIRES_AT_LEAST_ONE_ARGUMENT);
             return EXIT_WITH_INTERNAL_ERROR_NO_VIOLATIONS;
         }
 
@@ -222,7 +223,7 @@ private String formatError(Throwable error) {
         return ERROR_PREFIX
                 + (error.getCause() != null
                         ? String.format(
-                                UserFacingMessages.EXCEPTION_FORMAT_TEMPLATE,
+                                UserFacingMessages.CompilationErrors.EXCEPTION_FORMAT_TEMPLATE,
                                 error.getMessage(),
                                 error.getCause().getMessage())
                         : error.getMessage());
diff --git a/sfge/src/main/java/com/salesforce/apex/jorje/JorjeUtil.java b/sfge/src/main/java/com/salesforce/apex/jorje/JorjeUtil.java
@@ -87,7 +87,8 @@ public static AstNodeWrapper<?> compileApexFromString(String sourceCode) {
                             .map(
                                     e ->
                                             String.format(
-                                                    UserFacingMessages.INVALID_SYNTAX_TEMPLATE,
+                                                    UserFacingMessages.CompilationErrors
+                                                            .INVALID_SYNTAX_TEMPLATE,
                                                     e.getLoc().getLine(),
                                                     e.getLoc().getColumn(),
                                                     e.getError()))
diff --git a/sfge/src/main/java/com/salesforce/cli/CliArgParser.java b/sfge/src/main/java/com/salesforce/cli/CliArgParser.java
@@ -37,7 +37,8 @@ public CLI_ACTION getCliAction(String... args) {
             return CLI_ACTION.CATALOG;
         } else {
             throw new InvocationException(
-                    String.format(UserFacingMessages.UNRECOGNIZED_ACTION, actionArg));
+                    String.format(
+                            UserFacingMessages.InvocationErrors.UNRECOGNIZED_ACTION, actionArg));
         }
     }
 
@@ -120,7 +121,7 @@ public void parseArgs(String... args) {
             if (args.length != ARG_COUNT) {
                 throw new InvocationException(
                         String.format(
-                                UserFacingMessages.INCORRECT_ARGUMENT_COUNT,
+                                UserFacingMessages.InvocationErrors.INCORRECT_ARGUMENT_COUNT,
                                 ARG_COUNT,
                                 args.length));
             }
diff --git a/sfge/src/main/java/com/salesforce/config/UserFacingMessages.java b/sfge/src/main/java/com/salesforce/config/UserFacingMessages.java
@@ -25,46 +25,50 @@ public static final class RuleViolationTemplates {
         //         Second %s is the name of a class or interface.
         public static final String UNIMPLEMENTED_TYPE_RULE = "Extend, implement, or delete %s %s";
         public static final String LIMIT_REACHED_VIOLATION_MESSAGE =
-                "%s. The analysis preemptively stopped running on this path to prevent an OutOfMemory error. Rerun Graph Engine targeting this entry method with a larger heap space.";
+                "%s. The analysis preemptively stopped running on this path to prevent an OutOfMemory error. Rerun Graph Engine and target this entry method with a larger heap space.";
     }
 
     /** Main args and process checks * */
-    public static final String REQUIRES_AT_LEAST_ONE_ARGUMENT =
-            "SFGE invocation requires at least one argument.";
-
-    public static final String UNRECOGNIZED_ACTION = "Unrecognized action to invoke SFGE: %s.";
-    public static final String INCORRECT_ARGUMENT_COUNT =
-            "Wrong number of arguments. Expected %d; received %d";
+    public static final class InvocationErrors {
+        public static final String REQUIRES_AT_LEAST_ONE_ARGUMENT =
+                "SFGE invocation requires at least one argument.";
+        public static final String UNRECOGNIZED_ACTION = "Unrecognized action to invoke SFGE: %s.";
+        public static final String INCORRECT_ARGUMENT_COUNT =
+                "Wrong number of arguments. Expected %d; received %d";
+    }
 
     /** UserActionException * */
+    public static final class UserActionMessage {
+        // format: filename,defined type, line number
+        public static final String UNREACHABLE_CODE =
+                "Remove unreachable code to proceed with the analysis: %s,%s:%d";
+        public static final String VARIABLE_DECLARED_MULTIPLE_TIMES =
+                "Rename or delete this reused variable to proceed with the analysis: %s,%s:%d";
+    }
 
-    // format: filename,defined type, line number
-    public static final String UNREACHABLE_CODE =
-            "Remove unreachable code to proceed with the analysis: %s,%s:%d";
-
-    public static final String VARIABLE_DECLARED_MULTIPLE_TIMES =
-            "This variable is reused. Rename or delete it to proceed with the analysis: %s,%s:%d";
-
-    public static final String INSUFFICIENT_HEAP_SPACE =
-            "There's insufficient heap space (%d bytes) to execute Graph Engine. Increase heap space using --sfgejvmargs option and retry.";
-
-    public static final String STRIP_INACCESSIBLE_READ_WARNING_TEMPLATE =
-            "For stripInaccessible checks on READ operation, Salesforce Graph Engine can't verify that only sanitized data is used after the check. Discard unsanitized data for [%2$s].";
-
-    public static final String UNRESOLVED_CRUD_FLS_TEMPLATE =
-            "Salesforce Graph Engine couldn't resolve the parameter passed to [%2$s] operation%4$s. Confirm that this operation has the necessary %1$s checks.";
-
-    public static final String FIELDS_MESSAGE_TEMPLATE = " with field(s) [%s]";
-    public static final String FIELD_HANDLING_NOTICE =
-            ". Confirm that the objects and fields involved in these segments have FLS checks: [%s]";
+    public static final class PathExpansionTemplates {
+        public static final String INSUFFICIENT_HEAP_SPACE =
+                "There's insufficient heap space (%d bytes) to execute Graph Engine. Increase heap space using the --sfgejvmargs option and retry.";
+        public static final String PATH_EXPANSION_LIMIT_REACHED =
+                "Graph Engine reached the path expansion upper limit (%d).";
+    }
 
-    public static final String INVALID_SYNTAX_TEMPLATE = "Invalid syntax at %d:%d. (%s)";
+    public static final class CrudFlsTemplates {
 
-    public static final String FIX_COMPILATION_ERRORS =
-            "Graph engine encountered compilation errors. Fix the errors in %s and retry.";
+        public static final String STRIP_INACCESSIBLE_READ_WARNING_TEMPLATE =
+                "For stripInaccessible checks on READ operation, Salesforce Graph Engine can't verify that only sanitized data is used after the check. Discard unsanitized data for [%2$s].";
+        public static final String UNRESOLVED_CRUD_FLS_TEMPLATE =
+                "Salesforce Graph Engine couldn't resolve the parameter passed to [%2$s] operation%4$s. Confirm that this operation has the necessary %1$s checks.";
+        public static final String FIELDS_MESSAGE_TEMPLATE = " with field(s) [%s]";
+        public static final String FIELD_HANDLING_NOTICE =
+                ". Confirm that the objects and fields involved in these segments have FLS checks: [%s]";
+    }
 
-    public static final String EXCEPTION_FORMAT_TEMPLATE = "%s, Caused by:\n%s";
+    public static final class CompilationErrors {
 
-    public static final String PATH_EXPANSION_LIMIT_REACHED =
-            "Graph Engine reached the path expansion upper limit (%d).";
+        public static final String INVALID_SYNTAX_TEMPLATE = "Invalid syntax at %d:%d. (%s)";
+        public static final String FIX_COMPILATION_ERRORS =
+                "Graph engine encountered compilation errors. Fix the errors in %s and retry.";
+        public static final String EXCEPTION_FORMAT_TEMPLATE = "%s, Caused by:\n%s";
+    }
 }
diff --git a/sfge/src/main/java/com/salesforce/graph/build/MethodPathBuilderVisitor.java b/sfge/src/main/java/com/salesforce/graph/build/MethodPathBuilderVisitor.java
@@ -597,7 +597,7 @@ private void addEdge(String name, Vertex from, Vertex to) {
             // Ask user to fix unreachable code
             throw new UserActionException(
                     String.format(
-                            UserFacingMessages.UNREACHABLE_CODE,
+                            UserFacingMessages.UserActionMessage.UNREACHABLE_CODE,
                             GremlinUtil.getFileName(g, to),
                             to.value(Schema.DEFINING_TYPE),
                             to.value(Schema.BEGIN_LINE)));
diff --git a/sfge/src/main/java/com/salesforce/graph/ops/GraphUtil.java b/sfge/src/main/java/com/salesforce/graph/ops/GraphUtil.java
@@ -182,7 +182,7 @@ private static List<Util.CompilationDescriptor> buildFolderComps(String sourceFo
         } catch (JorjeUtil.JorjeCompilationException ex) {
             throw new GraphLoadException(
                     String.format(
-                            UserFacingMessages.FIX_COMPILATION_ERRORS,
+                            UserFacingMessages.CompilationErrors.FIX_COMPILATION_ERRORS,
                             sourceFileVisitor.lastVisitedFile),
                     ex);
         }
diff --git a/sfge/src/main/java/com/salesforce/graph/ops/registry/PathExpansionLimitReachedException.java b/sfge/src/main/java/com/salesforce/graph/ops/registry/PathExpansionLimitReachedException.java
@@ -9,6 +9,9 @@
  */
 public class PathExpansionLimitReachedException extends SfgeRuntimeException {
     public PathExpansionLimitReachedException(int limit) {
-        super(String.format(UserFacingMessages.PATH_EXPANSION_LIMIT_REACHED, limit));
+        super(
+                String.format(
+                        UserFacingMessages.PathExpansionTemplates.PATH_EXPANSION_LIMIT_REACHED,
+                        limit));
     }
 }
diff --git a/sfge/src/main/java/com/salesforce/graph/ops/registry/RegistryDataLimitCalculator.java b/sfge/src/main/java/com/salesforce/graph/ops/registry/RegistryDataLimitCalculator.java
@@ -43,7 +43,9 @@ int calculateAllowedLimit(long averageItemSize, int minimumItemCountExpected) {
 
         if (heapMaxSize < minimumItemCountExpected * averageItemSize) {
             throw new UserActionException(
-                    String.format(UserFacingMessages.INSUFFICIENT_HEAP_SPACE, heapMaxSize));
+                    String.format(
+                            UserFacingMessages.PathExpansionTemplates.INSUFFICIENT_HEAP_SPACE,
+                            heapMaxSize));
         }
 
         final int allowedLimit = (int) ((heapMaxSize * CAPACITY_LIMIT) / averageItemSize);
diff --git a/sfge/src/main/java/com/salesforce/graph/symbols/PathScopeVisitor.java b/sfge/src/main/java/com/salesforce/graph/symbols/PathScopeVisitor.java
@@ -1593,7 +1593,7 @@ public boolean visit(VariableDeclarationVertex vertex) {
         if (apexValueStack.peek().containsKey(key)) {
             // The variable was defined multiple times
             throw new UserActionException(
-                    UserFacingMessages.VARIABLE_DECLARED_MULTIPLE_TIMES,
+                    UserFacingMessages.UserActionMessage.VARIABLE_DECLARED_MULTIPLE_TIMES,
                     vertex.getFileName(),
                     vertex.getDefiningType(),
                     vertex.getBeginLine());
diff --git a/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/FlsStripInaccessibleWarningInfo.java b/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/FlsStripInaccessibleWarningInfo.java
@@ -25,6 +25,6 @@ public FlsStripInaccessibleWarningInfo(
     }
 
     public String getMessageTemplate() {
-        return UserFacingMessages.STRIP_INACCESSIBLE_READ_WARNING_TEMPLATE;
+        return UserFacingMessages.CrudFlsTemplates.STRIP_INACCESSIBLE_READ_WARNING_TEMPLATE;
     }
 }
diff --git a/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/FlsViolationMessageUtil.java b/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/FlsViolationMessageUtil.java
@@ -133,14 +133,16 @@ private static String getFieldInformation(
         // Populate field information only if we have anything
         if (!"".equals(fieldString)) {
             fieldInformation =
-                    String.format(UserFacingMessages.FIELDS_MESSAGE_TEMPLATE, fieldString);
+                    String.format(
+                            UserFacingMessages.CrudFlsTemplates.FIELDS_MESSAGE_TEMPLATE,
+                            fieldString);
         }
 
         // Add field notice if we have segments that may not have been parsed correctly
         if (!complexSegments.isEmpty()) {
             fieldInformation +=
                     String.format(
-                            UserFacingMessages.FIELD_HANDLING_NOTICE,
+                            UserFacingMessages.CrudFlsTemplates.FIELD_HANDLING_NOTICE,
                             Joiner.on(FIELD_NAME_SEPARATOR).join(complexSegments));
         }
         return fieldInformation;
diff --git a/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/UnresolvedCrudFlsViolationInfo.java b/sfge/src/main/java/com/salesforce/rules/fls/apex/operations/UnresolvedCrudFlsViolationInfo.java
@@ -14,6 +14,6 @@ public UnresolvedCrudFlsViolationInfo(FlsConstants.FlsValidationType validationT
     }
 
     public String getMessageTemplate() {
-        return UserFacingMessages.UNRESOLVED_CRUD_FLS_TEMPLATE;
+        return UserFacingMessages.CrudFlsTemplates.UNRESOLVED_CRUD_FLS_TEMPLATE;
     }
 }
diff --git a/sfge/src/test/java/com/salesforce/MainTest.java b/sfge/src/test/java/com/salesforce/MainTest.java
@@ -80,7 +80,8 @@ void teardown() {
     void testNoActionProvided() {
         final Main main = new Main(dependencies);
         main.process();
-        verify(dependencies).printError(UserFacingMessages.REQUIRES_AT_LEAST_ONE_ARGUMENT);
+        verify(dependencies)
+                .printError(UserFacingMessages.InvocationErrors.REQUIRES_AT_LEAST_ONE_ARGUMENT);
     }
 
     @Test
@@ -91,7 +92,8 @@ void testInvalidActionProvided() {
         assertThrows(
                 CliArgParser.InvocationException.class,
                 () -> main.process(invalid_action),
-                String.format(UserFacingMessages.UNRECOGNIZED_ACTION, invalid_action));
+                String.format(
+                        UserFacingMessages.InvocationErrors.UNRECOGNIZED_ACTION, invalid_action));
     }
 
     @Test
diff --git a/sfge/src/test/java/com/salesforce/cli/CliArgParserTest.java b/sfge/src/test/java/com/salesforce/cli/CliArgParserTest.java
@@ -48,7 +48,8 @@ public void getCliAction_throwsExpectedError() {
         assertThrows(
                 CliArgParser.InvocationException.class,
                 () -> parser.getCliAction("notARealAction"),
-                String.format(UserFacingMessages.UNRECOGNIZED_ACTION, "notARealAction"));
+                String.format(
+                        UserFacingMessages.InvocationErrors.UNRECOGNIZED_ACTION, "notARealAction"));
     }
 
     @CsvSource({
diff --git a/sfge/src/test/java/com/salesforce/graph/ops/expander/PathExpansionRegistryTest.java b/sfge/src/test/java/com/salesforce/graph/ops/expander/PathExpansionRegistryTest.java
@@ -43,7 +43,9 @@ public void testApexPathExpanderExceedsLimit() {
         assertThrows(
                 PathExpansionLimitReachedException.class,
                 () -> createApexPathExpanders(itemCountToAdd, new PathExpansionRegistry()),
-                String.format(UserFacingMessages.PATH_EXPANSION_LIMIT_REACHED, limit));
+                String.format(
+                        UserFacingMessages.PathExpansionTemplates.PATH_EXPANSION_LIMIT_REACHED,
+                        limit));
     }
 
     @Test
diff --git a/sfge/src/test/java/com/salesforce/graph/ops/registry/RegistryDataLimitCalculatorTest.java b/sfge/src/test/java/com/salesforce/graph/ops/registry/RegistryDataLimitCalculatorTest.java
@@ -54,6 +54,8 @@ public void testInsufficientMaxHeapSize() {
         assertThrows(
                 UserActionException.class,
                 () -> calculator.calculateAllowedLimit(objectSize, minimumItemCountExpected),
-                String.format(UserFacingMessages.INSUFFICIENT_HEAP_SPACE, maxHeapSpaceSize));
+                String.format(
+                        UserFacingMessages.PathExpansionTemplates.INSUFFICIENT_HEAP_SPACE,
+                        maxHeapSpaceSize));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,8 @@ public CLI_ACTION getCliAction(String... args) {`
`37`	`37`	`return CLI_ACTION.CATALOG;`
`38`	`38`	`} else {`
`39`	`39`	`throw new InvocationException(`
`40`		`- String.format(UserFacingMessages.UNRECOGNIZED_ACTION, actionArg));`
	`40`	`+ String.format(`
	`41`	`+ UserFacingMessages.InvocationErrors.UNRECOGNIZED_ACTION, actionArg));`
`41`	`42`	`}`
`42`	`43`	`}`
`43`	`44`
`@@ -120,7 +121,7 @@ public void parseArgs(String... args) {`
`120`	`121`	`if (args.length != ARG_COUNT) {`
`121`	`122`	`throw new InvocationException(`
`122`	`123`	`String.format(`
`123`		`- UserFacingMessages.INCORRECT_ARGUMENT_COUNT,`
	`124`	`+ UserFacingMessages.InvocationErrors.INCORRECT_ARGUMENT_COUNT,`
`124`	`125`	`ARG_COUNT,`
`125`	`126`	`args.length));`
`126`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ private static List<Util.CompilationDescriptor> buildFolderComps(String sourceFo`
`182`	`182`	`} catch (JorjeUtil.JorjeCompilationException ex) {`
`183`	`183`	`throw new GraphLoadException(`
`184`	`184`	`String.format(`
`185`		`- UserFacingMessages.FIX_COMPILATION_ERRORS,`
	`185`	`+ UserFacingMessages.CompilationErrors.FIX_COMPILATION_ERRORS,`
`186`	`186`	`sourceFileVisitor.lastVisitedFile),`
`187`	`187`	`ex);`
`188`	`188`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`	`*/`
`10`	`10`	`public class PathExpansionLimitReachedException extends SfgeRuntimeException {`
`11`	`11`	`public PathExpansionLimitReachedException(int limit) {`
`12`		`- super(String.format(UserFacingMessages.PATH_EXPANSION_LIMIT_REACHED, limit));`
	`12`	`+ super(`
	`13`	`+ String.format(`
	`14`	`+ UserFacingMessages.PathExpansionTemplates.PATH_EXPANSION_LIMIT_REACHED,`
	`15`	`+ limit));`
`13`	`16`	`}`
`14`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,9 @@ int calculateAllowedLimit(long averageItemSize, int minimumItemCountExpected) {`
`43`	`43`
`44`	`44`	`if (heapMaxSize < minimumItemCountExpected * averageItemSize) {`
`45`	`45`	`throw new UserActionException(`
`46`		`- String.format(UserFacingMessages.INSUFFICIENT_HEAP_SPACE, heapMaxSize));`
	`46`	`+ String.format(`
	`47`	`+ UserFacingMessages.PathExpansionTemplates.INSUFFICIENT_HEAP_SPACE,`
	`48`	`+ heapMaxSize));`
`47`	`49`	`}`
`48`	`50`
`49`	`51`	`final int allowedLimit = (int) ((heapMaxSize * CAPACITY_LIMIT) / averageItemSize);`