Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ignore all annotations in all scopes if source is missing #10021

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.eclipse.jdt.internal.compiler.impl.Constant;
import org.eclipse.jdt.internal.compiler.lookup.BinaryTypeBinding;
import org.eclipse.jdt.internal.compiler.lookup.BlockScope;
import org.eclipse.jdt.internal.compiler.lookup.ClassScope;
import org.eclipse.jdt.internal.compiler.lookup.SourceTypeBinding;

import java.util.ArrayList;
Expand Down Expand Up @@ -79,27 +80,44 @@ public boolean visit(MarkerAnnotation annotation, BlockScope scope) {
return false;
}

@Override
public boolean visit(MarkerAnnotation annotation, ClassScope scope) {
// Ignore annotations
return false;
}

@Override
public boolean visit(NormalAnnotation annotation, BlockScope scope) {
// Ignore annotations
return false;
}

@Override
public boolean visit(NormalAnnotation annotation, ClassScope scope) {
// Ignore annotations
return false;
}

@Override
public boolean visit(SingleMemberAnnotation annotation, BlockScope scope) {
// Ignore annotations
return false;
}

@Override
public boolean visit(SingleMemberAnnotation annotation, ClassScope scope) {
// Ignore annotations
return false;
}

@Override
protected void onBinaryTypeRef(BinaryTypeBinding binding,
CompilationUnitDeclaration unitOfReferrer, Expression expression) {
if (expression.constant != null && expression.constant != Constant.NotAConstant) {
// Allow compile time constants from classes provided only in binary form.
return;
}
binaryTypeReferenceSites.add(new BinaryTypeReferenceSite(expression,
binding));
binaryTypeReferenceSites.add(new BinaryTypeReferenceSite(expression, binding));
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* Copyright 2024 GWT Project Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.dev.jjs.impl;

import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.thirdparty.guava.common.base.Joiner;

public class AnnotationCompilerTest extends FullCompileTestBase {
@Override
protected void optimizeJava() {
}

public void testUseAnnotationWithoutSource() throws UnableToCompleteException {
// The JDT represents annotations as three kinds: markers, which have no members,
// single-member, which have only one member, and normal, which have more than one.
// This test validates that all three work in two cases each: block scope, and class
// scope.

String annotations = Joiner.on(" ").join(
"@SampleBytecodeOnlyMarkerAnnotation",
"@SampleBytecodeOnlySingleMemberAnnotation(\"abc\")",
"@SampleBytecodeOnlyNormalAnnotation(a=1, b=2)"
);

String code = Joiner.on('\n').join(
"package test;",
"import com.google.gwt.dev.jjs.impl.*;",
"public class EntryPoint<T extends " + annotations + " Object> {",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we go all-in here and add annotations everywhere allowed in source code so the test is basically a catch all test and not tailored to the available methods of JDT ASTVisitor (BinaryTypeReferenceVisitor)?

JDT knows additional scopes (Module, CompilationUnit, Method) and if we update JDT some visitor might change and we might not detect it here given visitors have default implementations. For example block scope could become method scope.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth considering, but the ASTVisitor doesn't check those, so the particular code in question that is actively looking for binary type refs so that it can complain about them in the logs (and throw an exception) isn't going to fail, at least as I read it.

Would you contribute a test that does that? I'm guessing there is an example out there of all the different ways you can stack annotations that can be used to extend this. We'd need (at least) three instances of every location, to hit marker/normal/single.

" public static void onModuleLoad() {",
" }",
" " + annotations + " public String foo() {",
" return \"\";",
" }",
"}");

compileSnippetToJS(code);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*
* Copyright 2024 GWT Project Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.dev.jjs.impl;

/**
* Annotation with no bytecode for GWT, and no members.
*/
public @interface SampleBytecodeOnlyMarkerAnnotation {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Copyright 2024 GWT Project Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.dev.jjs.impl;

/**
* Annotation with no bytecode for GWT, and multiple members.
*/
public @interface SampleBytecodeOnlyNormalAnnotation {
int a();
int b();
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Copyright 2024 GWT Project Authors
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.gwt.dev.jjs.impl;

/**
* Annotation with no bytecode for GWT, and a single member.
*/
public @interface SampleBytecodeOnlySingleMemberAnnotation {
String value();
}