Skip to content

Add graalvm reachability metadata to sso service #5840

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
Open
1 of 2 tasks
gbaso opened this issue Jan 29, 2025 · 5 comments · May be fixed by #5852
Open
1 of 2 tasks

Add graalvm reachability metadata to sso service #5840

gbaso opened this issue Jan 29, 2025 · 5 comments · May be fixed by #5852
Assignees
@debora-ito
Labels
feature-request A feature should be added or improved. graalvm p2 This is a standard priority issue

Comments

@gbaso
Copy link

gbaso commented Jan 29, 2025

Describe the feature

Add reachability metadata for service sso, namely for the constructor of SsoProfileCredentialsProviderFactory.

Use Case

GraalVM native image requires reflection hints for code that is only used by reflection.

Proposed Solution

Add a file reflect-config.json under src/main/resources/META-INF/native-image/software.amazon.awssdk/sso with:

[
  {
    "name": "software.amazon.awssdk.services.sso.auth.SsoProfileCredentialsProviderFactory",
    "methods": [
      {
        "name": "<init>",
        "parameterTypes": []
      }
    ]
  }
]

Other Information

Native hints can be provided by the application (e.g., for spring applications, via @ImportRuntimeHints), but it's mostly a try-and-error process. Libraries providing metadata simplify the operation of building a native image considerably.

Other aws services already provide metadata, see ssooidc.

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

AWS Java SDK version used

2.29.52

JDK version used

21.0.5

Operating System and version

MacOS 15.2
@gbaso gbaso added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Jan 29, 2025
gbaso added a commit to gbaso/aws-sdk-java-v2 that referenced this issue Feb 3, 2025
@gbaso
Add GraalVM reachability metadata for sso service
c683d41 
Closes aws#5840
@gbaso gbaso linked a pull request Feb 3, 2025 that will close this issue
Open
12 tasks
@jdussouillez jdussouillez mentioned this issue Apr 25, 2025
Closed
@debora-ito debora-ito added graalvm p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 2, 2025
@debora-ito debora-ito self-assigned this May 2, 2025
@debora-ito
Copy link
Member

@gbaso Sorry for the long delay in replying. Taking a look at the PR.

@scrocquesel
Copy link
Contributor

@debora-ito not related to the OP PR, but he mentions that sso oidc reachability was done long ago. The issue is that the referenced class software.amazon.awssdk.services.ssooidc.SsoOidcTokenProviderFactory has never existed. I think there is a typo with SsoOidcProfileTokenProviderFactory.

@debora-ito
Copy link
Member

debora-ito commented May 3, 2025 •
edited
Loading

@scrocquesel good catch 🤦🏻‍♀️ thank you!

@gbaso would you mind fixing ssooidc/reflect-config.json in your PR?

@gbaso
Copy link
Author

gbaso commented May 6, 2025

@debora-ito sure, I'll fix it now.

@scrocquesel
Copy link
Contributor

I have fixed this issue with GraalVM substitution in the Quarkus extension and we faced another issue. Both providers make use of a static field which is statically initialized with a call to userHomeDirectory().
This call is evaluated during native image build to empty string, providers will never find the cached token.
To resolve this, either add a GraalVM feature to specify those two classes need to be runtime initialized, let the field be an instance field or lazy initialize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@debora-ito debora-ito

Labels
feature-request A feature should be added or improved. graalvm p2 This is a standard priority issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add GraalVM reachability metadata for sso service gbaso/aws-sdk-java-v2
3 participants
@debora-ito @gbaso @scrocquesel