androidx DialogFragment getLayoutInflater StackOverflow [117894767]

Fixed

Bug

Status Update

No update yet.

Description

af...@gmail.com

created issue #1

Oct 18, 2018 10:58AM

PLEASE READ:

Please describe the problem in detail. Be sure to include:
- Steps to reproduce the problem (including sample code if appropriate).
Subclass androidx.fragment.app.DialogFragment and in onCreateDialog get an instance of the layout inflater using getLayoutInflater.

compileSdkVersion 28
minSdkVersion 23
targetSdkVersion 28

import android.app.AlertDialog
import android.app.Dialog
import android.os.Bundle
import androidx.fragment.app.DialogFragment

class AddUserDialogFragment : DialogFragment() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
}

override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
val inflater = layoutInflater // this throws a stack overflow error
val view = inflater.inflate(R.layout.fragment_add_user, null)

return AlertDialog.Builder(activity!!)
.setTitle(R.string.some_title)
.setView(view)
.setPositiveButton(R.string.add, null)
.setNegativeButton(R.string.cancel) { dialog, which ->
}
.create()
}
}

- What happened.
The call to getLayoutInflater stack overflows

2018-10-18 06:55:31.279 20850-20850/? E/AndroidRuntime: at androidx.fragment.app.Fragment.performGetLayoutInflater(Fragment.java:1308)
at androidx.fragment.app.Fragment.getLayoutInflater(Fragment.java:1293)
at com.ase.solutions.mat.organization.adduser.AddUserDialogFragment.onCreateDialog(AddUserDialogFragment.kt:26)
at androidx.fragment.app.DialogFragment.onGetLayoutInflater(DialogFragment.java:330)
at androidx.fragment.app.Fragment.performGetLayoutInflater(Fragment.java:1308)
at androidx.fragment.app.Fragment.getLayoutInflater(Fragment.java:1293)
at com.ase.solutions.mat.organization.adduser.AddUserDialogFragment.onCreateDialog(AddUserDialogFragment.kt:26)
at androidx.fragment.app.DialogFragment.onGetLayoutInflater(DialogFragment.java:330)
at androidx.fragment.app.Fragment.performGetLayoutInflater(Fragment.java:1308)
at androidx.fragment.app.Fragment.getLayoutInflater(Fragment.java:1293)

.. further down ...
2018-10-18 06:55:31.279 20850-20850/? E/AndroidRuntime: at androidx.fragment.app.Fragment.performGetLayoutInflater(Fragment.java:1308)
at com.ase.solutions.mat.organization.adduser.AddUserDialogFragment.onCreateDialog(AddUserDialogFragment.kt:26)
at androidx.fragment.app.DialogFragment.onGetLayoutInflater(DialogFragment.java:330)
at androidx.fragment.app.Fragment.performGetLayoutInflater(Fragment.java:1308)
at androidx.fragment.app.FragmentManagerImpl.moveToState(FragmentManager.java:1460)
at androidx.fragment.app.FragmentManagerImpl.moveFragmentToExpectedState(FragmentManager.java:1784)
at androidx.fragment.app.FragmentManagerImpl.moveToState(FragmentManager.java:1852)
at androidx.fragment.app.BackStackRecord.executeOps(BackStackRecord.java:802)
at androidx.fragment.app.FragmentManagerImpl.executeOps(FragmentManager.java:2625)
at androidx.fragment.app.FragmentManagerImpl.executeOpsTogether(FragmentManager.java:2411)
at androidx.fragment.app.FragmentManagerImpl.removeRedundantOperationsAndExecute(FragmentManager.java:2366)
at androidx.fragment.app.FragmentManagerImpl.execPendingActions(FragmentManager.java:2273)
at androidx.fragment.app.FragmentManagerImpl$1.run(FragmentManager.java:733)
at android.os.Handler.handleCallback(Handler.java:873)
at android.os.Handler.dispatchMessage(Handler.java:99)
at android.os.Looper.loop(Looper.java:193)
at android.app.ActivityThread.main(ActivityThread.java:6669)
at java.lang.reflect.Method.invoke(Native Method)
at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:493)
at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:858)

- What you think the correct behavior should be.
It should return a layout inflater

Don't forget to mention which version of Android you're using, and/or which
device the problem appears on (model and Android version).
API 28

Please also run "adb bugreport" and archive the output.

Comments

ku...@google.com <ku...@google.com> Oct 22, 2018 05:18AM

Assigned to ku...@google.com.

ku...@google.com <ku...@google.com> #2Oct 22, 2018 09:39AM

To provide some context , R8 removes code that is not referenced directly at runtime.

It is a known issue in kotlinx serialization where serializable classes & types are shrunk/obfuscated when not referenced directly. Mitigation includes custom proguard rules to keep all classes marked with @Serializable.

In the context of navigation + kotlinx serialization, we will have to look into whether navigation can viably prevent this shrinkage/obfuscation.

In the mean time, we will be adding a lint rule to remind users to use @Keep.

ku...@google.com <ku...@google.com> #3Oct 29, 2018 07:13AM

Project: platform/frameworks/support
Branch: androidx-main

commit 4940c45ab1632128129bfb64b4fd42320b081c92
Author: Clara Fok <clarafok@google.com>
Date: Mon Sep 16 13:04:40 2024

Add navigation-common lint for Keep annotation

We need to make sure that Enums that are used as nav arguments in type-safe routes are annotated with @Keep. The e
ntry point to locating said Enums are rotue declarations that contains Enum arguments.

Since the entry point is essentially the same lint location for linting @Serializable annotation, this lint uses the same detector but expands upon it.

Test: ./gradlew navigation:navigation-common-lint:test
Bug:358687142
Change-Id: I2b46fbc3b5be6251d89e902e315f50f20c46ce19

M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/NavigationCommonIssueRegistry.kt
M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingKeepAnnotationDetectorTest.kt

https://android-review.googlesource.com/3270115

ku...@google.com <ku...@google.com> #4Nov 5, 2018 06:49AM

Status: Won't Fix (Infeasible)

Project: platform/frameworks/support
Branch: androidx-main

commit 33f3eee080a07079f9ce7b34d58ee210869fe180
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 18 23:32:56 2024

Add navigation-compose lint for type safe annotations

The lint checks if routes that are used to create NavDestinations are annotated with kotlinx @Serializable, and checks that enum arg types are annotated with @Keep.

Test: ./gradlew navigation:navigation-compose-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: I954023cd0cb4a5ee7d08647cf9a8139b0c8ae9d9

M navigation/navigation-compose-lint/src/main/java/androidx/navigation/compose/lint/NavigationComposeIssueRegistry.kt
A navigation/navigation-compose-lint/src/main/java/androidx/navigation/compose/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/MissingKeepAnnotationDetectorTest.kt
A navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-compose-lint/src/test/java/androidx/navigation/compose/lint/Stubs.kt

https://android-review.googlesource.com/3271440

sm...@gmail.com <sm...@gmail.com> #5Nov 14, 2018 10:22PM

Project: platform/frameworks/support
Branch: androidx-main

commit 50b1c751929ecb0bfafa59afc1a6101b39668e9b
Author: Clara Fok <clarafok@google.com>
Date: Wed Sep 18 20:55:45 2024

Add navigation-runtime lint for type safe annotations

The lint checks if routes that are used to create NavDestinations are annotated with kotlinx @Serializable, and checks that enum arg types are annotated with @Keep.

Test: ./gradlew navigation:navigation-runtime-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: Ie601a15449b1561154bd3ae5d990e006a371c7c6

M navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/NavigationRuntimeIssueRegistry.kt
A navigation/navigation-runtime-lint/src/main/java/androidx/navigation/runtime/lint/TypeSafeDestinationMissingAnnotationDetector.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/MissingKeepAnnotationDetectorTest.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/MissingSerializableAnnotationDetectorTest.kt
A navigation/navigation-runtime-lint/src/test/java/androidx/navigation/runtime/lint/Stubs.kt

https://android-review.googlesource.com/3271439

sm...@gmail.com <sm...@gmail.com> #6Nov 14, 2018 10:34PM

Project: platform/frameworks/support
Branch: androidx-main

commit 8b4f5f4e8219232187ac103252715c7213215625
Author: Clara Fok <clarafok@google.com>
Date: Tue Sep 24 04:42:33 2024

Add annotation lint for NavDeepLink builders

Lint for @Serializable and @Keep with for navDeepLink builders

Test: ./gradlew navigation:navigation-common-lint:test
Bug: 362725816
Bug: 358687142
Change-Id: I4a259b5544e4e4655c4bdee812d64f3b2a1947bd

M navigation/navigation-common-lint/src/main/java/androidx/navigation/common/lint/TypeSafeDestinationMissingAnnotationDetector.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingKeepAnnotationDetectorTest.kt
M navigation/navigation-common-lint/src/test/java/androidx/navigation/common/lint/MissingSerializableAnnotationDetectorTest.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/BaseTypeSafeDestinationMissingAnnotationDetector.kt
M navigation/navigation-lint-common/src/main/java/androidx/navigation/lint/common/TestStub.kt

https://android-review.googlesource.com/3278871

sm...@gmail.com <sm...@gmail.com> #7Nov 14, 2018 11:01PM

This has been fixed internally and will be available in the Navigation 2.8.3 release.

il...@google.com <il...@google.com> #8Nov 15, 2018 12:49AM

Status: Assigned (reopened)

Using requireActivity().layoutInflater as is done in the Java code sample in the docs is one workaround until this can be fixed.

af...@gmail.com <af...@gmail.com> #9Nov 15, 2018 12:58AM

I just wound up using the following as a work around:

override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
dialogView = LayoutInflater.from(context).inflate(R.layout.fragment_add_user, null)

jp...@gmail.com <jp...@gmail.com> #10Jun 21, 2019 09:00PM

I uncovered this issue as well. I am working on migrating my app to use androidx fragments instead of framework. This includes migrating custom DialogFragments. Previously I was using LayoutInflater.from(context) also; I guess that's the only way to do it via framework fragments, maybe there's no "getLayoutInflater" on the fragment there.
Do you need any further samples to investigate?

il...@google.com <il...@google.com> Feb 24, 2020 11:37PM

Reassigned to jb...@google.com.

an...@google.com <an...@google.com> #11Mar 10, 2020 11:51PM

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6552735953321984/#/history/all)
Created: 2020-03-10 23:49:02.041052+00:00
Changes: aosp/1253912

ap...@google.com <ap...@google.com> #12Mar 11, 2020 12:01AM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit cd5549fdd847601c65d3a0e6f72a7de83c61154c
Author: Jeremy Woods <jbwoods@google.com>
Date: Mon Mar 09 13:00:19 2020

Allow calling getLayoutInflater in onCreateDialog

Calling getLayoutInflater in a custom DialogFragment's overridden
onCreateDialog method causes a StackOverflowError because
DialogFragment's onGetLayoutInflater relied on calling onCreateDialog.

In onCreateDialog, we should return the layout inflater from the
Fragment onGetLayoutInflater instead, which has no idea about the
context or theme of the Dialog. The layout inflater returned in
onCreateView will remain the same, but the two will be different.

This also fixes an issue where FragmentContainerView and the fragment
tag cannot inflate fragments within a DialogFragment. The inflated
fragments are properly added to the DialogFragment's
childFragmentManager.

Test: Added DialogFragmentInflatedChildTest test
Bug: 117894767
RelNote: "Fixed a bug in DialogFragment that caused a StackOverflowError
when calling getLayoutInflater from within onCreateDialog."

Change-Id: Ib55b53de9ccd5ccb69111d519fd7ec02fbf9726e

M fragment/fragment/build.gradle
M fragment/fragment/src/androidTest/AndroidManifest.xml
A fragment/fragment/src/androidTest/java/androidx/fragment/app/DialogFragmentInflatedChildTest.kt
M fragment/fragment/src/main/java/androidx/fragment/app/DialogFragment.java

https://android-review.googlesource.com/1253912

jb...@google.com <jb...@google.com> #13Mar 11, 2020 12:02AM

Marked as fixed.

This has been fixed internally and will be available in both the Fragment 1.2.3 release and 1.3.0-alpha02 release.