Merge pull request #41739 from Nadeeshan96/mas-large-init

Split `init` functions in to multiple classes

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/desugar/LargeMethodSplitter.java

@@ -18,30 +18,32 @@
 
 package org.wso2.ballerinalang.compiler.desugar;
 
+import io.ballerina.tools.diagnostics.Location;
+import io.ballerina.tools.text.LinePosition;
+import io.ballerina.tools.text.LineRange;
+import io.ballerina.tools.text.TextRange;
 import org.ballerinalang.model.tree.NodeKind;
 import org.wso2.ballerinalang.compiler.diagnostic.BLangDiagnosticLocation;
 import org.wso2.ballerinalang.compiler.semantics.analyzer.SymbolResolver;
 import org.wso2.ballerinalang.compiler.semantics.model.SymbolEnv;
 import org.wso2.ballerinalang.compiler.semantics.model.SymbolTable;
 import org.wso2.ballerinalang.compiler.semantics.model.symbols.BInvokableSymbol;
-import org.wso2.ballerinalang.compiler.semantics.model.symbols.Symbols;
 import org.wso2.ballerinalang.compiler.tree.BLangBlockFunctionBody;
 import org.wso2.ballerinalang.compiler.tree.BLangFunction;
 import org.wso2.ballerinalang.compiler.tree.BLangPackage;
 import org.wso2.ballerinalang.compiler.tree.expressions.BLangCheckedExpr;
 import org.wso2.ballerinalang.compiler.tree.expressions.BLangInvocation;
-import org.wso2.ballerinalang.compiler.tree.expressions.BLangSimpleVarRef;
 import org.wso2.ballerinalang.compiler.tree.statements.BLangAssignment;
 import org.wso2.ballerinalang.compiler.tree.statements.BLangExpressionStmt;
 import org.wso2.ballerinalang.compiler.tree.statements.BLangStatement;
 import org.wso2.ballerinalang.compiler.util.CompilerContext;
 import org.wso2.ballerinalang.compiler.util.Name;
 import org.wso2.ballerinalang.compiler.util.Names;
-import org.wso2.ballerinalang.util.Flags;
 
 import java.util.ArrayList;
 import java.util.List;
 
+import static org.wso2.ballerinalang.compiler.util.Constants.INIT_FUNC_COUNT_PER_CLASS;
 import static org.wso2.ballerinalang.compiler.util.Constants.INIT_METHOD_SPLIT_SIZE;
 import static org.wso2.ballerinalang.compiler.util.Constants.MAX_LISTENER_COUNT_PER_METHOD;
 
@@ -88,15 +90,31 @@ void splitLargeFunctions(BLangPackage pkgNode, SymbolEnv env) {
         pkgNode.stopFunction = splitStopFunction(pkgNode, env);
     }
 
+    private static BLangDiagnosticLocation getNewFuncPos(Location packageNodePos, String packageFileName,
+                                                         int splitInitFuncClassCount) {
+        LineRange lineRange = packageNodePos.lineRange();
+        TextRange textRange = packageNodePos.textRange();
+        LinePosition startLine = lineRange.startLine();
+        LinePosition endLine = lineRange.endLine();
+        return new BLangDiagnosticLocation(packageFileName + "$" + splitInitFuncClassCount, startLine.line(),
+                endLine.line(), startLine.offset(), endLine.offset(), textRange.startOffset(), textRange.length());
+    }
+
     /**
-     * Split package init function into several smaller functions.
+     * Split package init function into several smaller functions and put them into multiple classes
+     * if the function count is very high.
      *
      * @param packageNode package node
      * @param env symbol environment
      * @return initial init function but trimmed in size
      */
     private BLangFunction splitInitFunction(BLangPackage packageNode, SymbolEnv env) {
-        int methodSize = INIT_METHOD_SPLIT_SIZE;
+        int splitInitFuncClassCount = 1;
+        int splitFuncCount = 0;
+        Location packageNodePos = packageNode.pos;
+        String packageFileName = packageNodePos.lineRange().fileName();
+        BLangDiagnosticLocation newFuncPos = getNewFuncPos(packageNodePos, packageFileName, splitInitFuncClassCount);
+        splitInitFuncClassCount++;
         BLangBlockFunctionBody funcBody = (BLangBlockFunctionBody) packageNode.initFunction.body;
         BLangFunction initFunction = packageNode.initFunction;
 
@@ -114,56 +132,22 @@ private BLangFunction splitInitFunction(BLangPackage packageNode, SymbolEnv env)
                 break;
             }
             varDefIndex++;
-            if (i > 0 && (i % methodSize == 0 || isAssignmentWithInitOrRecordLiteralExpr(statement))) {
+            if (i > 0 && (i % INIT_METHOD_SPLIT_SIZE == 0 || isAssignmentWithInitOrRecordLiteralExpr(statement))) {
                 generatedFunctions.add(newFunc);
                 newFunc = createIntermediateInitFunction(packageNode, env);
-                newFuncBody = (BLangBlockFunctionBody) newFunc.body;
-                symTable.rootScope.define(names.fromIdNode(newFunc.name), newFunc.symbol);
-            }
-            newFuncBody.stmts.add(stmts.get(i));
-        }
-
-        // from a varDef to a service constructor, those stmts should be within single method
-        List<BLangStatement> chunkStmts = new ArrayList<>();
-        for (int i = varDefIndex; i < stmts.size(); i++) {
-            BLangStatement stmt = stmts.get(i);
-            chunkStmts.add(stmt);
-            varDefIndex++;
-            if ((stmt.getKind() == NodeKind.ASSIGNMENT) &&
-                    (((BLangAssignment) stmt).expr.getKind() == NodeKind.SERVICE_CONSTRUCTOR) &&
-                    (newFuncBody.stmts.size() + chunkStmts.size() > methodSize)) {
-                // enf of current chunk
-                if (newFuncBody.stmts.size() + chunkStmts.size() > methodSize) {
-                    generatedFunctions.add(newFunc);
-                    newFunc = createIntermediateInitFunction(packageNode, env);
-                    newFuncBody = (BLangBlockFunctionBody) newFunc.body;
-                    symTable.rootScope.define(names.fromIdNode(newFunc.name), newFunc.symbol);
+                splitFuncCount++;
+                if (splitFuncCount % INIT_FUNC_COUNT_PER_CLASS == 0) {
+                    newFuncPos = getNewFuncPos(packageNodePos, packageFileName, splitInitFuncClassCount);
+                    splitInitFuncClassCount++;
                 }
-                newFuncBody.stmts.addAll(chunkStmts);
-                chunkStmts.clear();
-            } else if ((stmt.getKind() == NodeKind.ASSIGNMENT) &&
-                    (((BLangAssignment) stmt).varRef instanceof BLangSimpleVarRef.BLangPackageVarRef) &&
-                    Symbols.isFlagOn(
-                            ((BLangSimpleVarRef.BLangPackageVarRef) ((BLangAssignment) stmt).varRef).varSymbol.flags,
-                            Flags.LISTENER)
-            ) {
-                // this is where listener registrations starts, they are independent stmts
-                break;
-            }
-        }
-        newFuncBody.stmts.addAll(chunkStmts);
-
-        // rest of the statements can be split without chunks
-        for (int i = varDefIndex; i < stmts.size(); i++) {
-            if (i > 0 && i % methodSize == 0) {
-                generatedFunctions.add(newFunc);
-                newFunc = createIntermediateInitFunction(packageNode, env);
+                newFunc.pos = newFuncPos;
                 newFuncBody = (BLangBlockFunctionBody) newFunc.body;
                 symTable.rootScope.define(names.fromIdNode(newFunc.name), newFunc.symbol);
             }
             newFuncBody.stmts.add(stmts.get(i));
         }
 
+        newFuncBody.stmts.addAll(stmts.subList(varDefIndex, stmts.size()));
         generatedFunctions.add(newFunc);
 
         for (int j = 0; j < generatedFunctions.size() - 1; j++) {
@@ -295,8 +279,9 @@ private BLangFunction splitStopFunction(BLangPackage packageNode, SymbolEnv env)
         newFuncBody.stmts.add(stmts.get(stmts.size() - 1));
         generatedFunctions.add(newFunc);
 
-        // for the stop function, splitting is done same as the start function except here
-        // here just need only to call the next created stop function because the return value is () and not ()|error
+        // For the stop function, splitting is done the same as the start function except here.
+        // Here, it is only required to call the next created stop function
+        // because the return value is () and not ()|error.
         for (int j = 0; j < generatedFunctions.size() - 1; j++) {
             BLangFunction thisFunction = generatedFunctions.get(j);
 

compiler/ballerina-lang/src/main/java/org/wso2/ballerinalang/compiler/util/Constants.java

@@ -38,6 +38,7 @@ private Constants() {
     public static final String SKIP_TESTS = "false";
 
     public static final int INIT_METHOD_SPLIT_SIZE = 50;
+    public static final int INIT_FUNC_COUNT_PER_CLASS = 100;
     public static final int MAX_LISTENER_COUNT_PER_METHOD = 25;
 
     public static final int MIN_UNICODE = 0xD800;

tests/jballerina-unit-test/src/test/java/org/ballerinalang/test/execution/LargeInitBuildTest.java

@@ -19,6 +19,7 @@
 package org.ballerinalang.test.execution;
 
 import org.ballerinalang.test.BCompileUtil;
+import org.ballerinalang.test.BRunUtil;
 import org.ballerinalang.test.CompileResult;
 import org.testng.Assert;
 import org.testng.annotations.Test;
@@ -32,9 +33,14 @@ public class LargeInitBuildTest {
     @Test
     public void testFileWithLargeInitMethod() {
         CompileResult compileResult = BCompileUtil.compile("test-src/execution/large_init.bal");
-
         Assert.assertEquals(compileResult.getErrorCount(), 0);
         Assert.assertEquals(compileResult.getWarnCount(), 0);
     }
+
+    @Test
+    public void testSplittingLargeInitMethod() {
+        CompileResult compileResult = BCompileUtil.compile("test-src/execution/large-init");
+        BRunUtil.invoke(compileResult, "main");
+    }
 }
 

tests/jballerina-unit-test/src/test/resources/test-src/execution/large-init/.gitignore

@@ -0,0 +1,3 @@
+target
+generated
+Config.toml

tests/jballerina-unit-test/src/test/resources/test-src/execution/large-init/Ballerina.toml

@@ -0,0 +1,7 @@
+[package]
+org = "testorg"
+name = "large_init"
+version = "0.1.0"
+
+[build-options]
+observabilityIncluded = false