IssueTracker

Component used: Navigation

Version used: 2.4.0-alpha09

Devices/Android versions reproduced on: Not device dependent, code generation issue

Safeargs plugin on 2.4.0-alpha09 since it implemented this behaviour change below

When generating arguments, Safe Args now puts parameters without default values before those with default values. (I89709, b/198493585)

This bahvious change seesms to cause the side effect of compilation time errors in the genrated argument files. As far as I know this affects both kotlin and java generated files.

e.g.

XML navgraph destination (NavCompFingerPrintAuthDialogFragment)

<dialog
        android:id="@+id/NavCompFingerPrintAuthDialogFragment"
        android:name="sg.ndi.fragment.NavCompFingerPrintAuthDialogFragment"
        tools:layout="@layout/layout_fingerprint_authentication"
        >

        <argument
            android:name="positiveText"
            app:argType="string"
            app:nullable="true"
            android:defaultValue="@null"
            />

        <argument
            android:name="negativeText"
            app:argType="string"
            app:nullable="true"
            android:defaultValue="@null"
            />

        <argument
            android:name="generalErrorMsg"
            app:argType="string"
            app:nullable="true"
            android:defaultValue="@null"
            />

        <argument
            android:name="ownFragmentTag"
            app:argType="string"
            />

        <argument
            android:name="requestId"
            app:argType="integer"
            app:nullable="false"
            />

    </dialog>

As you can see the arguments with no default values are not defined first.

this will generate the argument data object shown below with the behavios change which puts the arguments with no default values first in the constructor.

public data class NavCompFingerPrintAuthDialogFragmentArgs(
  public val ownFragmentTag: String,
  public val requestId: Int,
  public val positiveText: String? = null,
  public val negativeText: String? = null,
  public val generalErrorMsg: String? = null
) : NavArgs {
  public fun toBundle(): Bundle {
    val result = Bundle()
    result.putString("positiveText", this.positiveText)
    result.putString("negativeText", this.negativeText)
    result.putString("generalErrorMsg", this.generalErrorMsg)
    result.putString("ownFragmentTag", this.ownFragmentTag)
    result.putInt("requestId", this.requestId)
    return result
  }

Now the problem is that in the NavCompFingerPrintAuthDialogFragmentArgs.fromBundle(bundle: Bundle): NavCompFingerPrintAuthDialogFragmentArgs companion function does not use named arguments when creating a NavCompFingerPrintAuthDialogFragmentArgs from a bundle. And it uses the arguments in the order that it was defined in the navgraph and not in the order that the NavCompFingerPrintAuthDialogFragmentArgs data object expects in its constructor. The same issue also apples for the companion function fromSavedStateHandle(savedStateHandle: SavedStateHandle):NavCompFingerPrintAuthDialogFragmentArgs but compilation will fail at the earliest point so it was not reported in the error. But from what i can see in the genrated code, its will have the same problem too.

public companion object {
    @JvmStatic
    public fun fromBundle(bundle: Bundle): NavCompFingerPrintAuthDialogFragmentArgs {
      bundle.setClassLoader(NavCompFingerPrintAuthDialogFragmentArgs::class.java.classLoader)
      val __positiveText : String?
      if (bundle.containsKey("positiveText")) {
        __positiveText = bundle.getString("positiveText")
      } else {
        __positiveText = null
      }
      val __negativeText : String?
      if (bundle.containsKey("negativeText")) {
        __negativeText = bundle.getString("negativeText")
      } else {
        __negativeText = null
      }
      val __generalErrorMsg : String?
      if (bundle.containsKey("generalErrorMsg")) {
        __generalErrorMsg = bundle.getString("generalErrorMsg")
      } else {
        __generalErrorMsg = null
      }
      val __ownFragmentTag : String?
      if (bundle.containsKey("ownFragmentTag")) {
        __ownFragmentTag = bundle.getString("ownFragmentTag")
        if (__ownFragmentTag == null) {
          throw IllegalArgumentException("Argument \"ownFragmentTag\" is marked as non-null but was passed a null value.")
        }
      } else {
        throw IllegalArgumentException("Required argument \"ownFragmentTag\" is missing and does not have an android:defaultValue")
      }
      val __requestId : Int
      if (bundle.containsKey("requestId")) {
        __requestId = bundle.getInt("requestId")
      } else {
        throw IllegalArgumentException("Required argument \"requestId\" is missing and does nauthot have an android:defaultValue")
      }
      return NavCompFingerPrintAuthDialogFragmentArgs(__positiveText, __negativeText,
          __generalErrorMsg, __ownFragmentTag, __requestId)
    }

    @JvmStatic
    public fun fromSavedStateHandle(savedStateHandle: SavedStateHandle):
        NavCompFingerPrintAuthDialogFragmentArgs {
      val __positiveText : String?
      if (savedStateHandle.contains("positiveText")) {
        __positiveText = savedStateHandle["positiveText"]
      } else
        __positiveText = null
      }
      val __negativeText : String?
      if (savedStateHandle.contains("negativeText")) {
        __negativeText = savedStateHandle["negativeText"]
      } else {
        __negativeText = null
      }
      val __generalErrorMsg : String?
      if (savedStateHandle.contains("generalErrorMsg")) {
        __generalErrorMsg = savedStateHandle["generalErrorMsg"]
      } else {
        __generalErrorMsg = null
      }
      val __ownFragmentTag : String?
      if (savedStateHandle.contains("ownFragmentTag")) {
        __ownFragmentTag = savedStateHandle["ownFragmentTag"]
        if (__ownFragmentTag == null) {
          throw IllegalArgumentException("Argument \"ownFragmentTag\" is marked as non-null but was passed a null value")
        }
      } else {
        throw IllegalArgumentException("Required argument \"ownFragmentTag\" is missing and does not have an android:defaultValue")
      }
      val __requestId : Int?
      if (savedStateHandle.contains("requestId")) {
        __requestId = savedStateHandle["requestId"]
        if (__requestId == null) {
          throw IllegalArgumentException("Argument \"requestId\" of type integer does not support null values")
        }
      } else {
        throw IllegalArgumentException("Required argument \"requestId\" is missing and does not have an android:defaultValue")
      }
      return NavCompFingerPrintAuthDialogFragmentArgs(__positiveText, __negativeText,
          __generalErrorMsg, __ownFragmentTag, __requestId)
    }
  }
}

One solution is to just use named arguments for kotlin generated files, but it does not solve the issue for java generated files. So perhaps putting the arguments in the order of the behavior change mention above shld solve the issue.