[new-parser] Support LHS pattern annotations #5797

yurloc · 2024-03-20T23:39:29Z

This change replicates the old parser's behavior.

Multiple annotations can appear after an LHS pattern:

incubator-kie-drools/drools-drl/drools-drl-parser/src/main/java/org/drools/drl/parser/lang/DRL6Parser.java

Lines 3559 to 3564 in 4004fe9

    
           while (input.LA(1) == DRL6Lexer.AT) { 
        
               // annotation* 
        
               annotation(pattern); 
        
               if (state.failed) 
        
                   return; 
        
           }

A DRL annotation can either contain Java-style key-value pairs, or a chunk:

incubator-kie-drools/drools-drl/drools-drl-parser/src/main/java/org/drools/drl/parser/lang/DRL6Parser.java

Lines 4673 to 4732 in 4004fe9

    
               /** 
        
                * annotation := fullAnnotation | AT ID chunk_(_)? 
        
                */ 
        
               void annotation( AnnotatedDescrBuilder<?> adb ) { 
        
                   AnnotationDescrBuilder<?> annotation = null; 
        
                   try { 
        
                       if (speculateFullAnnotation()) { 
        
                           boolean buildState = exprParser.isBuildDescr(); 
        
                           exprParser.setBuildDescr(true); 
        
                           exprParser.fullAnnotation(adb); 
        
                           exprParser.setBuildDescr(buildState); 
        
                       } else { 
        
                           // '@' 
        
                           Token at = match(input, 
        
                                   DRL6Lexer.AT, 
        
                                   null, 
        
                                   null, 
        
                                   DroolsEditorType.SYMBOL); 
        
                           if (state.failed) 
        
                               return; 
        
                           // identifier 
        
                           String fqn = qualifiedIdentifier(); 
        
                           if (state.failed) 
        
                               return; 
        
                           if (state.backtracking == 0) { 
        
                               annotation = adb.newAnnotation(fqn); 
        
                               helper.setStart(annotation, 
        
                                       at); 
        
                           } 
        
                           try { 
        
                               if (input.LA(1) == DRL6Lexer.LEFT_PAREN) { 
        
                                   String value = chunk(DRL6Lexer.LEFT_PAREN, 
        
                                           DRL6Lexer.RIGHT_PAREN, 
        
                                           -1).trim(); 
        
                                   if (state.failed) 
        
                                       return; 
        
                                   if (state.backtracking == 0) { 
        
                                       if (annotation != null) { 
        
                                           annotation.value(value); 
        
                                       } else { 
        
                                           throw new RecognitionException(); 
        
                                       } 
        
                                   } 
        
                               } 
        
                           } finally { 
        
                               if (state.backtracking == 0) { 
        
                                   helper.setEnd(annotation); 
        
                               } 
        
                           } 
        
                       } 
        
                   } catch (RecognitionException re) { 
        
                       reportError(re); 
        
                   } 
        
               }

How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:

for pull request and downstream checks
- Push a new commit to the PR. An empty commit would be enough.
for a full downstream build
- for github actions job: add the label run_fdb
for Jenkins PR check only
- If you are an ASF committer for KIE podling, login to Jenkins (https://ci-builds.apache.org/job/KIE/job/drools/), go to the specific PR job, and click on Build Now button.

yurloc · 2024-03-20T23:41:46Z

drools-drl/drools-drl-parser/src/main/antlr4/org/drools/drl/parser/antlr4/DRLParser.g4

@@ -124,7 +124,7 @@ lhsPattern : xpathPrimary (OVER patternFilter)? |
             ( QUESTION? qualifiedIdentifier LPAREN positionalConstraints? constraints? RPAREN (OVER patternFilter)? (FROM patternSource)? ) ;
 */

-lhsPattern : QUESTION? objectType=drlQualifiedName LPAREN positionalConstraints? constraints? RPAREN (DRL_OVER patternFilter)? (DRL_FROM patternSource)? ;
+lhsPattern : QUESTION? objectType=drlQualifiedName LPAREN positionalConstraints? constraints? RPAREN drlAnnotation* (DRL_OVER patternFilter)? (DRL_FROM patternSource)? ;


This allows an annotation to appear after a LHS pattern, for example, Person() @watch(!age).

yurloc · 2024-03-20T23:45:29Z

drools-drl/drools-drl-parser/src/main/antlr4/org/drools/drl/parser/antlr4/DRLParser.g4

@@ -459,7 +459,7 @@ type : (classOrInterfaceType | primitiveType) typeArguments? ( DOT IDENTIFIER ty
 drlArguments : LPAREN drlArgument (COMMA drlArgument)* RPAREN ;
 drlArgument : ( stringId | floatLiteral | BOOL_LITERAL | NULL_LITERAL ) ;

-drlAnnotation : AT name=drlQualifiedName (LPAREN ( drlElementValuePairs | drlElementValue )? RPAREN)? ;
+drlAnnotation : AT name=drlQualifiedName ((LPAREN ( drlElementValuePairs | drlElementValue )? RPAREN) | chunk)? ;


This allows an annotation value to be something that doesn't fit into the standard Java annotation key-value format, for example, @watch(!*, age).

yurloc · 2024-03-20T23:46:37Z

drools-drl/drools-drl-parser/src/main/java/org/drools/drl/parser/util/ParserStringUtils.java

+            }
+        }
+        return value;
+    }


This one is used by both the old parser and the new parser's visitor.

yurloc · 2024-03-20T23:54:54Z

@tkobayas, @mariofusco, @gitgabrio please review.

yurloc · 2024-03-21T00:01:38Z

org.drools.model.codegen.execmodel.PropertyReactivityTest is fixed.

Before PR
drools-model-codegen

[ERROR] Tests run: 2433, Failures: 334, Errors: 0, Skipped: 9

After PR
drools-model-codegen

[ERROR] Tests run: 2433, Failures: 309, Errors: 2, Skipped: 9

tkobayas

Thanks!

tkobayas · 2024-03-21T09:16:45Z

@yurloc Please solve the conflict (likely because of recent other PR merge), thanks!

yurloc · 2024-03-21T12:16:59Z

@yurloc Please solve the conflict (likely because of recent other PR merge), thanks!

Done. @mariofusco please merge.

yurloc · 2024-03-21T18:50:25Z

Overall fixing progress: Error: There were 370 failed tests.

tkobayas · 2024-03-27T09:25:07Z

Overall fixing progress: Error: There were 370 failed tests.

FYI) @yurloc , you seem to take the 370 from the GHA result, but note that several modules were SKIPPED because of other module's failure. Especially, drools-test-coverage was skipped, which has a significant number of tests. So at some point, we will find more test failures :)

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

yurloc commented Mar 20, 2024

View reviewed changes

tkobayas approved these changes Mar 21, 2024

View reviewed changes

mariofusco requested review from gitgabrio and mariofusco March 21, 2024 09:03

mariofusco approved these changes Mar 21, 2024

View reviewed changes

yurloc added 2 commits March 21, 2024 11:57

LHS patterns can have annotations

4cb6713

LHS pattern annotations can contain chunks

03a56a0

yurloc force-pushed the new-parser-watch branch from 2e9d9a2 to 03a56a0 Compare March 21, 2024 10:58

mariofusco merged commit 12545b9 into apache:dev-new-parser Mar 21, 2024
0 of 3 checks passed

yurloc deleted the new-parser-watch branch March 21, 2024 18:50

tkobayas pushed a commit to tkobayas/drools that referenced this pull request Jun 11, 2024

[new-parser] Support LHS pattern annotations (apache#5797)

906e260

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

tkobayas pushed a commit to tkobayas/drools that referenced this pull request Oct 2, 2024

[new-parser] Support LHS pattern annotations (apache#5797)

88302e0

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

tkobayas pushed a commit to tkobayas/drools that referenced this pull request Oct 11, 2024

[new-parser] Support LHS pattern annotations (apache#5797)

4a00686

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

tkobayas pushed a commit that referenced this pull request Oct 11, 2024

[new-parser] Support LHS pattern annotations (#5797)

abd79ff

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

rgdoliveira pushed a commit to rgdoliveira/drools that referenced this pull request Oct 24, 2024

[new-parser] Support LHS pattern annotations (apache#5797)

3370def

* LHS patterns can have annotations * LHS pattern annotations can contain chunks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[new-parser] Support LHS pattern annotations #5797

[new-parser] Support LHS pattern annotations #5797

yurloc commented Mar 20, 2024 •

edited

Loading

yurloc Mar 20, 2024 •

edited

Loading

yurloc Mar 20, 2024

yurloc Mar 20, 2024

yurloc commented Mar 20, 2024

yurloc commented Mar 21, 2024

tkobayas left a comment

tkobayas commented Mar 21, 2024 •

edited

Loading

yurloc commented Mar 21, 2024

yurloc commented Mar 21, 2024

tkobayas commented Mar 27, 2024

	while (input.LA(1) == DRL6Lexer.AT) {
	// annotation*
	annotation(pattern);
	if (state.failed)
	return;
	}

	/**
	* annotation := fullAnnotation \| AT ID chunk_(_)?
	*/
	void annotation( AnnotatedDescrBuilder<?> adb ) {
	AnnotationDescrBuilder<?> annotation = null;

	try {
	if (speculateFullAnnotation()) {
	boolean buildState = exprParser.isBuildDescr();
	exprParser.setBuildDescr(true);
	exprParser.fullAnnotation(adb);
	exprParser.setBuildDescr(buildState);
	} else {

	// '@'
	Token at = match(input,
	DRL6Lexer.AT,
	null,
	null,
	DroolsEditorType.SYMBOL);
	if (state.failed)
	return;

	// identifier
	String fqn = qualifiedIdentifier();
	if (state.failed)
	return;

	if (state.backtracking == 0) {
	annotation = adb.newAnnotation(fqn);
	helper.setStart(annotation,
	at);
	}

	try {
	if (input.LA(1) == DRL6Lexer.LEFT_PAREN) {
	String value = chunk(DRL6Lexer.LEFT_PAREN,
	DRL6Lexer.RIGHT_PAREN,
	-1).trim();
	if (state.failed)
	return;
	if (state.backtracking == 0) {
	if (annotation != null) {
	annotation.value(value);
	} else {
	throw new RecognitionException();
	}
	}
	}
	} finally {
	if (state.backtracking == 0) {
	helper.setEnd(annotation);
	}
	}
	}

	} catch (RecognitionException re) {
	reportError(re);
	}
	}

[new-parser] Support LHS pattern annotations #5797

[new-parser] Support LHS pattern annotations #5797

Conversation

yurloc commented Mar 20, 2024 • edited Loading

yurloc Mar 20, 2024 • edited Loading

Choose a reason for hiding this comment

yurloc Mar 20, 2024

Choose a reason for hiding this comment

yurloc Mar 20, 2024

Choose a reason for hiding this comment

yurloc commented Mar 20, 2024

yurloc commented Mar 21, 2024

tkobayas left a comment

Choose a reason for hiding this comment

tkobayas commented Mar 21, 2024 • edited Loading

yurloc commented Mar 21, 2024

yurloc commented Mar 21, 2024

tkobayas commented Mar 27, 2024

yurloc commented Mar 20, 2024 •

edited

Loading

yurloc Mar 20, 2024 •

edited

Loading

tkobayas commented Mar 21, 2024 •

edited

Loading