Build fails for devices with `PRODUCT_ENFORCE_ARTIFACT_PATH_REQUIREMENTS := strict` in their makefiles

[petefoth]

• buildserv3: Failed build for akita (Google Pixel 8a) branch: lineage-22.1

[ 99% 213/214] finishing legacy Make module parsing ...
FAILED:
build/make/core/artifact_path_requirements.mk:31: warning:  device/google/akita/lineage_akita.mk produces files inside build/make/target/product/generic_system.mks artifact path requirement.
Offending entries:
system/etc/microg.xml
In file included from build/make/core/main.mk:1157:

• caused by this PR In the android_vendor_partner_gms/ repo. I have seen this build error before when making builds for sunfish (Google Pixel 4a) - see here. I'm guessing it will break the build for all Google Pixel devices that have PRODUCT_ENFORCE_ARTIFACT_PATH_REQUIREMENTS := strict in their makefiles (14 instances - 5 devices and 9 motorola commonrepos - in LOS GitHub repos).

Possible fixes:

1. Revert that change In the android_vendor_partner_gms/ repo
2. Create and maintain a patch for all Google Pixel devices, and apply it when building
3. Set PRODUCT_ENFORCE_ARTIFACT_PATH_REQUIREMENTS := relaxed as an environment variable

Originally posted by @petefoth in #754

[petefoth]

So where should our makefile put microg.xml?

1. we [previously put it in TARGET_OUT_PRODUCT_ETC](https://github.com/lineageos4microg/android_vendor_partner_gms/blame/0594cee1c814b70e8557b4bca9347044a8f606c6/GmsCore/Android.mk]
2. changed to TARGET_OUT_SYSTEM which is what broke things
3. IodéOS put it in TARGET_OUT_ETC

I think we should try 3 - it seems to work for IodéOS.

[petefoth]

@karlbaumg Would you have try to try a build with TARGET_OUT_ETC in place of TARGET_OUT_SYSTEM? I would rather not make a change in our live repo while our main monthly build run is in progress? Thanks

[karlbaumg]

The build succeeds but microG itself doesn't recognize the path in TARGET_OUT_ETC, the path is hard-coded in the microG code so it has been broken already that it wasn't recognizing the XML file at all. But I can revert the PR if you'd like to, to get the builds unblocked until they're fixed.

IodéOS put it in TARGET_OUT_ETC

I think it's not working for them too. The commit introduced the hard-coded path is 4 years old.

[karlbaumg]

Here is the revert PR if you'd like to revert the change #45

[petefoth]

Thanks. I'm not going to revert the PR. It seems that the correct place for microg.xml is /system/etc so that's where we should put it.
To do that we need to override or change the PRODUCT_ENFORCE_ARTIFACT_PATH_REQUIREMENTS := strict for affected devices.

• Long term we could try persuading LOS to make he change in their repos (but I don't have any faith they would actually do that, and I'm not sure I want to spend time in their 'support` channels trying to persuade them).
• Until upstream changes, we can overrride it using an environment variable: adding the following line in our docker run command should do the trick:
  -e "PRODUCT_ENFORCE_ARTIFACT_PATH_REQUIREMENTS=relaxed" \

We should also try and get IodéOS to do the right thing with microg.xml. I will raise it in their Iodé Dev Matrix channel (since I still can't get a login to their github instance to create issues.

[petefoth]

We should also try and get IodéOS to do the right thing with microg.xml.

Actually, it looks like they are already doing the right thing - see this commit (which I think has not yet made it into official builds)

I think adding the following in one of our makefiles would do the trick for us

PRODUCT_ARTIFACT_PATH_REQUIREMENT_ALLOWED_LIST += \
	system/etc/microg.xml

[karlbaumg]

That makes sense to me. Another option is to have microG to add /vendor/etc to the config precedence list before /system/etc but that's probably a stretch.

[petefoth]

I think adding the following in one of our makefiles would do the trick for us

PRODUCT_ARTIFACT_PATH_REQUIREMENT_ALLOWED_LIST += \
	system/etc/microg.xml

No, that fails with

FAILED:
In file included from build/make/core/prebuilt.mk:53:
vendor/partner_gms/GmsCore/Android.mk:32: error: cannot assign to readonly variable: PRODUCT_ARTIFACT_PATH_REQUIREMENT_ALLOWED_LIST

A lot of LineageOS repos get away with adding stuff to the list (see this search

@rik @karlbaumg Any ideas how we can get around that problem, or do we have to take a different approach to fixing the original error?

[steadfasterX]

the reason: https://source.android.com/docs/core/architecture/partitions/product-interfaces#about-the-artifact-path-requirements

a solution: https://github.com/sfX-android/android_vendor_extendrom/blob/5a6bdab545bbe07839ab6d498a6e3c7676b696dd/er.mk#L49C1-L52C79

in other words and in your specific case I would move to system_ext or (likely even better?) product partition

in extendrom I do it likes this depending on the Android version: https://github.com/sfX-android/android_vendor_extendrom/blob/5a6bdab545bbe07839ab6d498a6e3c7676b696dd/extra/Android.mk#L634-L638
(same will be done for MicroG itself but that is handled differently within extendrom - while the result is the same: if sdk30 or higher use system_ext otherwise system)

[rik]

@rik @karlbaumg Any ideas how we can get around that problem, or do we have to take a different approach to fixing the original error?

@petefoth I believe I'm not the Rik you're looking for.

[karlbaumg]

@petefoth I don't know unfortunately but opened microg/GmsCore#2852 to see if we can fix it in upstream.