Generate closures for default values in type inclusions #42428

chiranSachintha · 2024-03-28T12:15:29Z

Purpose

$title.

Fixes #42356

Approach

Describe how you are implementing the solutions along with the design details.

Samples

Provide high-level details about the samples related to this feature.

Remarks

List any other known issues, related PRs, TODO items, or any other notes related to the PR.

Check List

CLAassistant · 2024-03-28T12:15:35Z

All committers have signed the CLA.

codecov · 2024-03-28T13:47:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.82%. Comparing base (06d9bb6) to head (dfde2e3).
Report is 415 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #42428      +/-   ##
============================================
+ Coverage     76.64%   76.82%   +0.17%     
- Complexity    53437    53971     +534     
============================================
  Files          2902     2924      +22     
  Lines        201848   203904    +2056     
  Branches      26271    26592     +321     
============================================
+ Hits         154706   156646    +1940     
- Misses        38651    38718      +67     
- Partials       8491     8540      +49

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…ina-lang into issue-42356

.../resources/test-src/bala/test_projects/test_project_records/closed_record_type_reference.bal

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

MaryamZi · 2024-03-29T05:37:17Z

.../resources/test-src/bala/test_projects/test_project_records/closed_record_type_reference.bal

@@ -39,3 +39,8 @@ public type ClosedVehicleWithNever record {|
    int j;
    never p?;
 |};
+


Please add more tests

with multiple levels of inclusion: e.g.,
i. baz:C includes bar:B which includes foo:A, where the default value is specified in foo
ii. baz:C includes bar:B which includes foo:A, where the default value is specified in bar

to make sure the default value is used only when a value is not specified

a record includes two records with the same field (where one or both have a default), but the including record has to specify the field explicitly then. In such cases, add tests for both when the including record's field has a default value and doesn't have a default value. In either case default values from the included records shouldn't be used.

added with 4d48e7a

We aren't testing 2 (in conjunction with 3 also) are we? I guess that's OK since we have tests for the normal case.

Please add a test like 1, where foo:A has a default for a field which is overridden by bar:B, also with a default.

Added with 6094bb8

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

poorna2152

LGTM

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

MaryamZi · 2024-04-02T04:37:05Z

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

+                                                            BTypeSymbol typeSymbol) {
+        Map<String, BInvokableSymbol> defaultValues = ((BRecordTypeSymbol) typeSymbol).defaultValues;
+        String typeName = recordTypeNode.symbol.name.value;
+        for (BLangType type : recordTypeNode.typeRefs) {


We seem to be creating quite a few closures unnecessarily.

Isn't the problem only with inclusions from a different module? Why are we creating closures for defaults from all inclusions?

For the following points, inclusions can be from different modules once 1. is addressed.

For

type Foo record {| int a = 1; int b = 2; int c = 3; |}; type Bar record {| *Foo; int b = 22; int c; |};

We are creating a closure wrapping c's default value closure unnecessarily. That default value closure (Foo's c field's) is not required here.

For

type Foo record {| int a = 1; |}; type Bar record {| *Foo; |}; type Baz record {| *Foo; |};

closures wrapping a's closure are created twice. Can't we avoid (or at least minimize) this using some combination of the included record's fully-qualified identifier and field name?

Yeah, Issue when type inclusion in a different module. Earlier, I created closures for when it's in the same module to keep the logic simple. I've updated that.

Do we need to skip the second and third scenarios? We need to do extra checks for those. But these scenarios are very rare, so do we need to skip them?

I would fix at least 2. Easy fix, right? Just need to check by explicitly-specified fields rather than those with defaults.

Yes. Will update that.

Udapted 52836fd

MaryamZi · 2024-04-02T04:37:55Z

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

        result = recordTypeNode;
    }

+    private void generateClosuresForDefaultValuesInTypeRefs(BLangRecordTypeNode recordTypeNode,


Add a comment explaining why we are doing this, mention that it's temporary, and point to relevant issues.

added
Fixed with #41949

MaryamZi · 2024-04-02T08:51:27Z

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

+        //In the BIR, we generate instruction for closures when visiting the lambda function.
+        //Due to that, if the inclusions are in different modules, closures are not created for default values.
+        //Fixed with #41949 issue.


Isn't the issue more about not being able to find that closure? Can we rephrase. Mention the workaround we are adopting here too.

Add a space after //.

I would also say "Will be fixed with ..." or "Tracked with ..." instead of "Fixed with ...". since if it is fixed, we don't need the workaround.

Updated. please check

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

MaryamZi · 2024-04-02T09:04:51Z

.../resources/test-src/bala/test_projects/test_project_records/closed_record_type_reference.bal

@@ -39,3 +39,8 @@ public type ClosedVehicleWithNever record {|
    int j;
    never p?;
 |};
+


We aren't testing 2 (in conjunction with 3 also) are we? I guess that's OK since we have tests for the normal case.

Please add a test like 1, where foo:A has a default for a field which is overridden by bar:B, also with a default.

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

MaryamZi · 2024-04-03T05:18:17Z

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

@@ -1050,7 +1097,8 @@ public void visit(BLangCompoundAssignment compoundAssignment) {
    public void visit(BLangInvocation invocation) {
        rewriteInvocationExpr(invocation);
        BLangInvokableNode encInvokable = env.enclInvokable;
-        if (encInvokable == null || !invocation.functionPointerInvocation) {
+        if (encInvokable == null || !invocation.functionPointerInvocation ||
+                !env.enclPkg.packageID.equals(invocation.symbol.pkgID)) {


We could have had cases like this previously too, right? When the default value is a function call of a function from a different module? Can we add such a test also?

added test with c681a7f

.../src/test/resources/test-src/bala/test_bala/functions/test_different_function_signatures.bal

MaryamZi · 2024-04-04T13:53:46Z

...c/test/java/org/ballerinalang/test/bala/constant/MapConstantEqualityInDifferentBalaTest.java

@@ -35,6 +35,7 @@ public class MapConstantEqualityInDifferentBalaTest {

    @BeforeClass
    public void setup() {
+        BCompileUtil.compileAndCacheBala("test-src/bala/test_projects/test_project_utils");


Given that what we are introducing is a simple test, I would extract that test and packages out separately, and avoid these unnecessary compilations for other tests.

@chiranSachintha, please send a separate PR fixing this, will merge this for now since it is required for U9.

Updated the test case

chiranSachintha added 2 commits March 28, 2024 17:41

Generate closures for default values in type inclusions

2b0fbbf

Add bala tests

9ef5e55

chiranSachintha requested review from sameerajayasoma and hasithaa as code owners March 28, 2024 12:15

chiranSachintha added the Team/CompilerFE All issues related to Language implementation and Compiler, this exclude run times. label Mar 29, 2024

Merge branch 'master' of https://github.com/ballerina-platform/baller…

34e70c8

…ina-lang into issue-42356

chiranSachintha requested review from MaryamZi and poorna2152 March 29, 2024 03:42

MaryamZi reviewed Mar 29, 2024

View reviewed changes

MaryamZi added this to the 2201.9.0 milestone Mar 29, 2024

chiranSachintha added 2 commits March 29, 2024 15:14

Fix review suggestions

5d351e6

Add bala tests

4d48e7a

chiranSachintha force-pushed the issue-42356 branch from 375981d to 4d48e7a Compare April 1, 2024 07:42

chiranSachintha requested a review from MaryamZi April 1, 2024 07:43

poorna2152 reviewed Apr 1, 2024

View reviewed changes

Fix review suggestions

d5d887f

poorna2152 previously approved these changes Apr 2, 2024

View reviewed changes

Update failing test

d86f4b1

chiranSachintha dismissed poorna2152’s stale review via d86f4b1 April 2, 2024 04:19

MaryamZi reviewed Apr 2, 2024

View reviewed changes

Fix review suggestions

09915f1

chiranSachintha force-pushed the issue-42356 branch from 499274c to 09915f1 Compare April 2, 2024 06:30

Fix review suggestions

52836fd

chiranSachintha requested review from poorna2152 and MaryamZi April 2, 2024 08:27

MaryamZi reviewed Apr 2, 2024

View reviewed changes

Fix review suggestions

6094bb8

chiranSachintha requested a review from MaryamZi April 3, 2024 05:01

MaryamZi reviewed Apr 3, 2024

View reviewed changes

Fix review suggestions

3954a12

chiranSachintha requested a review from MaryamZi April 3, 2024 09:02

Add bala tests

c681a7f

chiranSachintha force-pushed the issue-42356 branch from 186a393 to c681a7f Compare April 4, 2024 04:23

MaryamZi reviewed Apr 4, 2024

View reviewed changes

.../src/test/resources/test-src/bala/test_bala/functions/test_different_function_signatures.bal Show resolved Hide resolved

chiranSachintha added 2 commits April 4, 2024 10:13

Update comment

dc00ee1

Update function name

6f8aa90

MaryamZi reviewed Apr 4, 2024

View reviewed changes

.../src/test/resources/test-src/bala/test_bala/functions/test_different_function_signatures.bal Outdated Show resolved Hide resolved

Fix review suggestion

340101c

MaryamZi previously approved these changes Apr 4, 2024

View reviewed changes

chiranSachintha dismissed MaryamZi’s stale review via 38b08a8 April 4, 2024 07:00

chiranSachintha force-pushed the issue-42356 branch from 38b08a8 to cbddffd Compare April 4, 2024 08:59

MaryamZi reviewed Apr 4, 2024

View reviewed changes

Generate new package for functions

dfde2e3

chiranSachintha force-pushed the issue-42356 branch from cbddffd to dfde2e3 Compare April 5, 2024 02:10

MaryamZi approved these changes Apr 5, 2024

View reviewed changes

LakshanWeerasinghe merged commit 7782a44 into ballerina-platform:master Apr 5, 2024
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate closures for default values in type inclusions #42428

Generate closures for default values in type inclusions #42428

chiranSachintha commented Mar 28, 2024

CLAassistant commented Mar 28, 2024 •

edited

Loading

codecov bot commented Mar 28, 2024 •

edited

Loading

MaryamZi Mar 29, 2024

chiranSachintha Apr 1, 2024

MaryamZi Apr 2, 2024

chiranSachintha Apr 2, 2024

poorna2152 left a comment

MaryamZi Apr 2, 2024

chiranSachintha Apr 2, 2024

MaryamZi Apr 2, 2024

chiranSachintha Apr 2, 2024

chiranSachintha Apr 2, 2024

MaryamZi Apr 2, 2024 •

edited

Loading

chiranSachintha Apr 2, 2024

MaryamZi Apr 2, 2024

chiranSachintha Apr 2, 2024

MaryamZi Apr 2, 2024

MaryamZi Apr 3, 2024

chiranSachintha Apr 3, 2024 •

edited

Loading

MaryamZi Apr 4, 2024

MaryamZi Apr 5, 2024

chiranSachintha Apr 5, 2024

Generate closures for default values in type inclusions #42428

Generate closures for default values in type inclusions #42428

Conversation

chiranSachintha commented Mar 28, 2024

Purpose

Approach

Samples

Remarks

Check List

CLAassistant commented Mar 28, 2024 • edited Loading

codecov bot commented Mar 28, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

poorna2152 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaryamZi Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chiranSachintha Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Mar 28, 2024 •

edited

Loading

codecov bot commented Mar 28, 2024 •

edited

Loading

MaryamZi Apr 2, 2024 •

edited

Loading

chiranSachintha Apr 3, 2024 •

edited

Loading