[GR-30205] Extend the agent to collect the locale and classname of resource bundles. #3557

graalvmbot · 2021-07-07T15:09:19Z

This PR extends the resource-config.json configuration file structure and adds two new fields locales and classNames for each bundle. By using these entries one can narrow down which bundles should be included, the default being all selected locales.

Specifying bundles using classNames has the advantage that they don't have to be looked up and instantiated at build time, which can be dangerous.

NativeImageAgent was updated to provide more detailed configuration using classNames.

substratevm/src/com.oracle.svm.agent/src/com/oracle/svm/agent/NativeImageAgentJNIHandleSet.java

substratevm/src/com.oracle.svm.agent/src/com/oracle/svm/agent/BreakpointInterceptor.java

...m/src/com.oracle.svm.core/src/com/oracle/svm/core/configure/ResourceConfigurationParser.java

...m.oracle.svm.core/src/com/oracle/svm/core/jdk/localization/OptimizedLocalizationSupport.java

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/ResourcesFeature.java

…nfig entry if they are non-empty

…mes are provided

…oked up by it

bundle basename is only needed for the OptimizedLocalizationSupport support

…port

…upport only if they have the right type

… lazy

…Parser

substratevm/src/com.oracle.svm.agent/src/com/oracle/svm/agent/BreakpointInterceptor.java

peter-hofer · 2021-10-28T09:49:07Z

.../src/com.oracle.svm.configure/src/com/oracle/svm/configure/config/ResourceConfiguration.java

+        }
+
+        @Override
+        public void addResourceBundles(ConfigurationCondition condition, String basename, Collection<Locale> locales) {


This class is used not only in the image build, but also in the agent and the native-image-configure images at runtime. Could using Locale objects here be an issue since these images might not include the locales in question? If so, it would be preferable to use plain strings instead and do any checks during the image build.

Good question. Fortunately, it should not be a problem - it is possible to create Locale objects even for non-existent locales such as aa-bb-ccccc. The method parseLocaleFromTag uses the locale tag parsing from JDK, which only cares about the syntatic structure of the tag, again aa-bb-ccccc works here. And there is also a fallback for handling locales with invalid tags (driven from a test case in the JCK). So creating the Locale objects on their own should not be an issue, even in an image that does not have corresponding locale data included.

peter-hofer · 2021-10-28T10:32:35Z

...m.oracle.svm.core/src/com/oracle/svm/core/jdk/localization/OptimizedLocalizationSupport.java

+            bundleNameField.set(bundle, basename);
+            bundleLocaleField.set(bundle, locale);


Could setting these fields reflectively break ResourceBundle implementations?

As far as I know, it should not. There is no special logic in their getters and setters and in the ResourceBundle class, they are used only during the lookup process which is completely substituted in the optimized mode. There is no suspicious use outside the class either. I am setting them reflectively because they are also set during the lookup, see ResourceBundle.loadLookup. Without setting them, the class bundles in the optimized mode would have no locale and basename associated, which would be inconsistent with the JDK. The whole idea of not instantiating bundles and only preparing their classes for reflection, unfortunately, does not work with the older optimized mode, in which everything is stored in the map at build time, so I have to instantiate them in that scenario anyway.

refs oracle/graal#3557

* ci: upgrade GraalVM versions * ci: fix workflows * fix: add necessary metadata to new versions * fix: support Java 17 * fix: add options to the gu command * fix: support the latest format of ResourceBundleUsage refs oracle/graal#3557 * chore: reformat * fix: stop using Java9 feature for Java8 compatibility Arrays.compare() is not ready to use for Java8 * fix: handle nullness of lists properly * fix: handle nullness of lists properly

graalvmbot added the oracle-emp label Jul 7, 2021

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from 5811da0 to 38c2154 Compare July 16, 2021 13:37

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from 8b50a6d to 8eb8a5a Compare July 26, 2021 16:57

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch 4 times, most recently from 8778ff7 to 967cf2d Compare August 18, 2021 11:52

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch 3 times, most recently from 811a9fb to b0cdc3e Compare August 26, 2021 08:22

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from 23adb58 to 3155f86 Compare September 14, 2021 11:05

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from a398adf to 6fe6f2f Compare September 25, 2021 09:45

d-kozak requested a review from vjovanov September 29, 2021 14:46

peter-hofer assigned peter-hofer and unassigned peter-hofer Oct 11, 2021

peter-hofer self-requested a review October 11, 2021 14:08

peter-hofer requested changes Oct 11, 2021

View reviewed changes

d-kozak added 13 commits October 21, 2021 15:04

extend the agent to collect the locale and classname of resource bundles

6b41ba2

read & use the whole resource bundle parent chain in native image agent

3c28aa5

use new locale configuration in the image

0d2d414

only include 'locales' and 'classnames' field of a resource bundle co…

7203f73

…nfig entry if they are non-empty

enable tracing to get more debug hints from the gates

b6b7daf

fix style issue - make ResourceConfiguration.printResourceBundle static

e752976

fix registering class based bundles in Java 8

62302f9

only register bundle in all locales if no specific locales or classna…

b24db31

…mes are provided

remember the basename of the class based bundle, so that it can be lo…

ef98bc8

…oked up by it

fix another style issue

faf9026

bundle basename is only needed for the OptimizedLocalizationSupport support

refactoring: changing the naming patterns for localization

30715d3

preprocess class based bundles correctly for OptimizedLocalizationSup…

165cce3

…port

store the bundles as delayed in BundleContentSubstitutedLocalizationS…

7ce690b

…upport only if they have the right type

d-kozak added 9 commits October 21, 2021 15:05

fix style issues

c6b4c08

fixes after rebase

2fd2a55

make the localization related handles in NativeImageAgentJNIHandleSet…

35dfaff

… lazy

fix incorrect bundle analysis in BreakpointInterceptor.extractBundleInfo

72041ec

fix imports in ResourcesFeature

913a06f

use JSONParserException instead of UserError in ResourceConfiguration…

aab0db2

…Parser

fixes after rebase

5cda4fd

style issue: add missing override

5d13c71

localization: code cleanup

f87ef4a

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch 2 times, most recently from 39a892f to d516367 Compare October 22, 2021 11:11

address issues from the review

860f582

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from d516367 to 860f582 Compare October 22, 2021 11:31

fix formatting issues when printing resource bundle config

f1d7dc0

d-kozak requested a review from peter-hofer October 25, 2021 11:27

peter-hofer approved these changes Oct 28, 2021

View reviewed changes

d-kozak added 2 commits November 1, 2021 11:54

remove static imports for Support.callObjectMethod & Support.newObjectL

8fefd4f

refactoring BreakpointInterceptor

f516400

graalvmbot force-pushed the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch from a17caba to f516400 Compare November 1, 2021 11:08

graalvmbot merged commit a53da53 into master Nov 2, 2021

KengoTODA added a commit to KengoTODA/graalvm-native-image-plugin that referenced this pull request Jan 28, 2022

fix: support the latest format of ResourceBundleUsage

857e6dc

refs oracle/graal#3557

graalvmbot deleted the github/d-kozak/GR-30205/update-agent-to-support-localization-better branch February 8, 2022 01:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GR-30205] Extend the agent to collect the locale and classname of resource bundles. #3557

[GR-30205] Extend the agent to collect the locale and classname of resource bundles. #3557

graalvmbot commented Jul 7, 2021 •

edited by d-kozak

Loading

peter-hofer Oct 28, 2021

d-kozak Nov 1, 2021

peter-hofer Oct 28, 2021

d-kozak Nov 1, 2021 •

edited

Loading

		bundleNameField.set(bundle, basename);
		bundleLocaleField.set(bundle, locale);

[GR-30205] Extend the agent to collect the locale and classname of resource bundles. #3557

[GR-30205] Extend the agent to collect the locale and classname of resource bundles. #3557

Conversation

graalvmbot commented Jul 7, 2021 • edited by d-kozak Loading

peter-hofer Oct 28, 2021

Choose a reason for hiding this comment

d-kozak Nov 1, 2021

Choose a reason for hiding this comment

peter-hofer Oct 28, 2021

Choose a reason for hiding this comment

d-kozak Nov 1, 2021 • edited Loading

Choose a reason for hiding this comment

graalvmbot commented Jul 7, 2021 •

edited by d-kozak

Loading

d-kozak Nov 1, 2021 •

edited

Loading