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.

Sign up for GitHub

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

Jump to bottom

fix(java): initialize classes at build-time to fix Native Image compilation #874

Merged
merged 4 commits into from Mar 30, 2022
Merged

fix(java): initialize classes at build-time to fix Native Image compilation #874

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fddce03
fix(java): initialize classes at build-time to Native Image support i…
mpeddada1 Mar 29, 2022
fe9fd7b
update comment in native-image.properties
mpeddada1 Mar 30, 2022
620c0c8
Merge branch 'main' of github.com:googleapis/java-storage-nio into na…
mpeddada1 Mar 30, 2022
3ac88f0
add missing classes
mpeddada1 Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
36 changes: 36 additions & 0 deletions ...resources/META-INF/native-image/com/google/cloud/google-cloud-nio/native-image.properties
View file
Open in desktop
@@ -0,0 +1,36 @@
# Using META-INF/services with Native Image compilation results in
# FileSystemProvider being initialized at build time. This results
# CloudStorageFileSystemProvider and all the sub-classes referenced by
# this class also being initialized at build time.
Copy link
Member

Choose a reason for hiding this comment

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

Only for static fields or static initializers are needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Slightly updated the comment here. Let me know if this sounds okay to you? Explored the code a little further to double check what's happening: The initialization of classes stems from CloudStorageFileSystemProvider which causes StorageOptions and as a result StorageOptionsUtil to be initialized at build time.

java-storage-nio/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemProvider.java

Line 96 in 004ab8c

private static StorageOptions futureStorageOptions = StorageOptionsUtil.getDefaultInstance();

Looks like this seems to be the case in the reproducer as well where when we create a new class MyOptions and instantiate it in MySampleFileSystemProvider, MyOptions ends up getting initialized at build time.

Args = --initialize-at-build-time=com.google.cloud.storage.contrib.nio.CloudStorageFileSystemProvider,\
com.google.cloud.storage.contrib.nio.CloudStorageConfiguration,\
com.google.cloud.storage.contrib.nio.CloudStorageFileSystem,\
com.google.cloud.storage.contrib.nio.StorageOptionsUtil,\
com.google.cloud.storage.StorageException,\
com.google.cloud.storage.StorageOptions,\
com.google.cloud.storage.DefaultStorageRetryStrategy,\
com.google.api.client.http.OpenCensusUtils,\
com.google.api.client.http.GenericUrl,\
Copy link
Member

Choose a reason for hiding this comment

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

(I'm curious about how you get the list)

If we don't have this GenericUrl line here, what kind of error do you get?

Copy link
Contributor Author

@mpeddada1 mpeddada1 Mar 30, 2022 •
edited

Choose a reason for hiding this comment

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

Removing GenericUrl results in:

Error: Classes that should be initialized at run time got initialized during image building:
 com.google.api.client.http.GenericUrl was unintentionally initialized at build time. To see why com.google.api.client.http.GenericUrl got initialized use --trace-class-initialization=com.google.api.client.http.GenericUrl

And removing all the other classes results in a similar error for the following classes:

--trace-class-initialization=com.google.api.client.json.gson.GsonParser$1,io.opencensus.trace.Tracing,io.opencensus.trace.EndSpanOptions,com.google.api.client.http.HttpRequest,org.threeten.bp.Duration,com.google.api.client.http.javanet.NetHttpTransport,com.google.auth.oauth2.OAuth2Utils,com.google.cloud.storage.StorageOptions,io.opencensus.contrib.http.util.CloudTraceFormat,com.google.auth.oauth2.DefaultCredentialsProvider,io.opencensus.trace.Status,io.opencensus.trace.AutoValue_EndSpanOptions,com.google.cloud.storage.DefaultStorageRetryStrategy,com.google.api.client.http.OpenCensusUtils,com.google.cloud.storage.StorageException,com.google.gson.stream.JsonReader,com.google.auth.oauth2.OAuth2Credentials,com.google.api.client.util.DateTime,com.google.api.client.util.escape.PercentEscaper,com.google.cloud.ExceptionHandler,io.opencensus.trace.BlankSpan,io.opencensus.trace.SpanContext,com.google.api.client.json.JsonParser$1,com.google.api.client.http.HttpTransport,com.google.api.client.http.HttpMediaType,com.google.auth.oauth2.GoogleCredentials,com.google.common.collect.RegularImmutableMap,io.opencensus.trace.Span,com.google.api.client.http.GenericUrl,com.google.cloud.ServiceOptions,com.google.api.client.util.Data,com.google.api.client.util.escape.CharEscapers,com.google.cloud.PlatformInformation

Copy link
Member

Choose a reason for hiding this comment

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

I see. Thank you for checking.

com.google.api.client.http.HttpRequest,\
com.google.api.client.http.HttpMediaType,\
com.google.api.client.http.javanet.NetHttpTransport,\
com.google.api.client.util.Data,\
com.google.api.client.util.DateTime,\
com.google.auth.oauth2,\
io.opencensus.trace,\
com.google.api.client.util.escape.CharEscapers,\
com.google.api.client.util.escape.PercentEscaper,\
io.opencensus.contrib.http.util.CloudTraceFormat,\
io.grpc.Context,\
io.grpc.Context$LazyStorage,\
io.grpc.ThreadLocalContextStorage,\
com.google.common.cache.LocalCache,\
com.google.common.cache.CacheBuilder,\
com.google.common.math.IntMath$1,\
com.google.common.collect.RegularImmutableMap,\
com.google.gson.stream.JsonReader,\
com.google.api.client.json.gson.GsonParser$1,\
com.google.api.client.json.JsonParser$1,\
com.google.cloud.PlatformInformation,\
com.google.cloud.ExceptionHandler,\
org.threeten.bp.Duration
BenWhitehead marked this conversation as resolved.
Show resolved Hide resolved