Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 1538b16b authored by Marybeth Fair's avatar Marybeth Fair
Browse files

aconfig: Move SDK check within Java codegen 

Having it within the Flags class makes it easier to remove the "else"
branch for binaries with high enough minSdk. Most if not all uses are
here rather than within FeatureFlags, but left the check in
FeatureFlagsImpl just to be safe.

Also moved within ExportedFlags which is the codegen for apps to use.

Bug: 378936061
Test: manually built the files, atest aconfig.test

Change-Id: Ib487503970a046e913977093fe09c1f7adb96e41
parent 0da55dfa

tools/aconfig/aconfig/src/codegen/java.rs

+109 −0
Original line number Diff line number Diff line
@@ -796,6 +796,7 @@ mod tests { 


        let expect_flags_content = r#"

        package com.android.aconfig.test;

        import android.os.Build;

        /** @hide */

        public final class Flags {

            /** @hide */
@@ -1001,6 +1002,7 @@ mod tests { 


        let expect_flags_content = r#"

        package com.android.aconfig.test;

        import android.os.Build;

        /** @hide */

        public final class Flags {

            /** @hide */
@@ -1204,6 +1206,7 @@ mod tests { 


        let expect_flags_content = r#"

        package com.android.aconfig.test;

        import android.os.Build;

        /** @hide */

        public final class Flags {

            /** @hide */
@@ -1213,6 +1216,9 @@ mod tests { 
            /** @hide */

            public static final String FLAG_ENABLED_RO_EXPORTED = "com.android.aconfig.test.enabled_ro_exported";

            public static boolean disabledRwExported() {

                if (Build.VERSION.SDK_INT >= 36) {

                  return true;

                }

                return FEATURE_FLAGS.disabledRwExported();

            }

            public static boolean enabledFixedRoExported() {
@@ -1787,6 +1793,109 @@ mod tests { 
        assert!(file_set.is_empty());

    }



    #[test]

    fn test_generate_java_code_exported_flags() {

        let parsed_flags = crate::test::parse_test_flags();

        let mode = CodegenMode::Exported;

        let modified_parsed_flags =

            crate::commands::modify_parsed_flags_based_on_mode(parsed_flags, mode).unwrap();

        let flag_ids =

            assign_flag_ids(crate::test::TEST_PACKAGE, modified_parsed_flags.iter()).unwrap();

        let mut finalized_flags = FinalizedFlagMap::new();

        finalized_flags.insert_if_new(

            ApiLevel(36),

            FinalizedFlag {

                flag_name: "disabled_rw_exported".to_string(),

                package_name: "com.android.aconfig.test".to_string(),

            },

        );

        let config = JavaCodegenConfig {

            codegen_mode: mode,

            flag_ids,

            allow_instrumentation: true,

            package_fingerprint: 5801144784618221668,

            new_exported: true,

            single_exported_file: true,

            finalized_flags,

        };

        let generated_files = generate_java_code(

            crate::test::TEST_PACKAGE,

            modified_parsed_flags.into_iter(),

            config,

        )

        .unwrap();



        let expect_exported_flags_content = r#"

        package com.android.aconfig.test;



        import android.os.Build;

        import android.os.flagging.AconfigPackage;

        import android.util.Log;

        public final class ExportedFlags {



            public static final String FLAG_DISABLED_RW_EXPORTED = "com.android.aconfig.test.disabled_rw_exported";

            public static final String FLAG_ENABLED_FIXED_RO_EXPORTED = "com.android.aconfig.test.enabled_fixed_ro_exported";

            public static final String FLAG_ENABLED_RO_EXPORTED = "com.android.aconfig.test.enabled_ro_exported";

            private static final String TAG = "ExportedFlags";

            private static volatile boolean isCached = false;



            private static boolean disabledRwExported = false;

            private static boolean enabledFixedRoExported = false;

            private static boolean enabledRoExported = false;

            private ExportedFlags() {}



            private void init() {

                try {

                    AconfigPackage reader = AconfigPackage.load("com.android.aconfig.test");

                    disabledRwExported = reader.getBooleanFlagValue("disabled_rw_exported", false);

                    enabledFixedRoExported = reader.getBooleanFlagValue("enabled_fixed_ro_exported", false);

                    enabledRoExported = reader.getBooleanFlagValue("enabled_ro_exported", false);

                } catch (Exception e) {

                    // pass

                    Log.e(TAG, e.toString());

                } catch (LinkageError e) {

                    // for mainline module running on older devices.

                    // This should be replaces to version check, after the version bump.

                    Log.w(TAG, e.toString());

                }

                isCached = true;

            }

            public static boolean disabledRwExported() {

                if (Build.VERSION.SDK_INT >= 36) {

                  return true;

                }



                if (!featureFlags.isCached) {

                    featureFlags.init();

                }

                return featureFlags.disabledRwExported;

            }

            public static boolean enabledFixedRoExported() {

                if (!featureFlags.isCached) {

                    featureFlags.init();

                }

                return featureFlags.enabledFixedRoExported;

            }

            public static boolean enabledRoExported() {

                if (!featureFlags.isCached) {

                    featureFlags.init();

                }

                return featureFlags.enabledRoExported;

            }

            private static ExportedFlags featureFlags = new ExportedFlags();

        }"#;



        let file = generated_files.iter().find(|f| f.path.ends_with("ExportedFlags.java")).unwrap();

        assert_eq!(

            None,

            crate::test::first_significant_code_diff(

                expect_exported_flags_content,

                &String::from_utf8(file.contents.clone()).unwrap()

            ),

            "ExportedFlags content is not correct"

        );

    }



    #[test]

    fn test_format_java_method_name() {

        let expected = "someSnakeName";

tools/aconfig/aconfig/templates/ExportedFlags.java.template

+6 −4
Original line number Diff line number Diff line
@@ -19,11 +19,8 @@ public final class ExportedFlags \{ 
            AconfigPackage reader = AconfigPackage.load("{package_name}");

            {{ -for namespace_with_flags in namespace_flags }}

            {{ -for flag in namespace_with_flags.flags }}

            {{ -if flag.finalized_sdk_present }}

            {flag.method_name} = Build.VERSION.SDK_INT >= {flag.finalized_sdk_value} ? true : reader.getBooleanFlagValue("{flag.flag_name}", {flag.default_value});

            {{ - else }} {#- else finalized_sdk_present #}

            {flag.method_name} = reader.getBooleanFlagValue("{flag.flag_name}", {flag.default_value});

            {{ -endif}}  {#- end finalized_sdk_present#}



            {{ -endfor }} {#- end namespace_with_flags.flags #}

            {{ -endfor }} {#- end namespace_flags #}

        } catch (Exception e) \{
@@ -39,6 +36,11 @@ public final class ExportedFlags \{ 


{{ -for flag in flag_elements }}

    public static boolean {flag.method_name}() \{

        {{ -if flag.finalized_sdk_present }}

        if (Build.VERSION.SDK_INT >= {flag.finalized_sdk_value}) \{

          return true;

        }

        {{ -endif}}  {#- end finalized_sdk_present#}

        if (!featureFlags.isCached) \{

            featureFlags.init();

        }

tools/aconfig/aconfig/templates/Flags.java.template

+7 −0
Original line number Diff line number Diff line
@@ -2,6 +2,8 @@ package {package_name}; 
{{ if not library_exported- }}

// TODO(b/303773055): Remove the annotation after access issue is resolved.

import android.compat.annotation.UnsupportedAppUsage;

{{ else }}

import android.os.Build;

{{ -endif }}

{{ -if single_exported_file }}

{{ -if library_exported }}
@@ -31,6 +33,11 @@ public final class Flags \{ 
    @UnsupportedAppUsage

{{ -endif }}

    public static boolean {item.method_name}() \{

        {{ -if item.finalized_sdk_present }}

        if (Build.VERSION.SDK_INT >= {item.finalized_sdk_value}) \{

          return true;

        }

        {{ -endif}}  {#- end finalized_sdk_present#}

        return FEATURE_FLAGS.{item.method_name}();

    }

{{ -endfor }}