Improve requireNotNull error messages

Crustack · Crustack · commit f813481209ce · 2025-10-22T19:01:53.000+02:00
diff --git a/app/src/main/java/com/philkes/notallyx/data/dao/BaseNoteDao.kt b/app/src/main/java/com/philkes/notallyx/data/dao/BaseNoteDao.kt
@@ -142,14 +142,16 @@ interface BaseNoteDao {
      * In this case, an exception will be thrown. It is the caller's responsibility to handle it.
      */
     suspend fun updateChecked(id: Long, position: Int, checked: Boolean) {
-        val items = requireNotNull(get(id)).items
+        val items =
+            requireNotNull(get(id), { "updateChecked: Note with id '$id' does not exist" }).items
         items[position].checked = checked
         updateItems(id, items)
     }
 
     /** see [updateChecked] */
     suspend fun updateChecked(id: Long, positions: List<Int>, checked: Boolean) {
-        val items = requireNotNull(get(id)).items
+        val items =
+            requireNotNull(get(id), { "updateChecked: Note with id '$id' does not exist" }).items
         positions.forEach { position -> items[position].checked = checked }
         updateItems(id, items)
     }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/UiExtensions.kt b/app/src/main/java/com/philkes/notallyx/presentation/UiExtensions.kt
@@ -347,7 +347,7 @@ fun StylableEditTextWithHistory.createTextWatcherWithHistory(
         }
 
         override fun afterTextChanged(s: Editable?) {
-            val textAfter = requireNotNull(s).clone()
+            val textAfter = requireNotNull(s, { "afterTextChanged: Editable is null" }).clone()
             if (textAfter.hasNotChanged(stateBefore.text)) {
                 return
             }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/main/MainActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/main/MainActivity.kt
@@ -494,7 +494,9 @@ class MainActivity : LockedActivity<ActivityMainBinding>() {
                         fragmentIdToLoad != null &&
                             navController.currentDestination?.id != fragmentIdToLoad
                     ) {
-                        navigateWithAnimation(requireNotNull(fragmentIdToLoad))
+                        navigateWithAnimation(
+                            requireNotNull(fragmentIdToLoad, { "fragmentIdToLoad is null" })
+                        )
                     }
                 }
             }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/DisplayLabelFragment.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/DisplayLabelFragment.kt
@@ -20,7 +20,11 @@ class DisplayLabelFragment : NotallyFragment() {
     override fun getBackground() = R.drawable.label
 
     override fun getObservable(): LiveData<List<Item>> {
-        label = requireNotNull(requireArguments().getString(EXTRA_DISPLAYED_LABEL))
+        label =
+            requireNotNull(
+                requireArguments().getString(EXTRA_DISPLAYED_LABEL),
+                { "DisplayLabelFragment does not have '$EXTRA_DISPLAYED_LABEL' arg" },
+            )
         return model.getNotesByLabel(label)
     }
 
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/NotallyFragment.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/NotallyFragment.kt
@@ -200,7 +200,7 @@ abstract class NotallyFragment : Fragment(), ItemListener {
             doAfterTextChanged { text ->
                 val isSearchFragment = navController.currentDestination?.id == R.id.Search
                 if (isSearchFragment) {
-                    model.keyword = requireNotNull(text).trim().toString()
+                    model.keyword = requireNotNull(text, { "text is null" }).trim().toString()
                 }
                 if (text?.isNotEmpty() == true && !isSearchFragment) {
                     setText("")
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/settings/PreferenceBindingExtensions.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/main/fragment/settings/PreferenceBindingExtensions.kt
@@ -434,7 +434,11 @@ fun PreferenceBinding.setupBackupsFolder(
         root.setOnClickListener { chooseBackupFolder() }
     } else {
         val uri = Uri.parse(value)
-        val folder = requireNotNull(DocumentFile.fromTreeUri(context, uri))
+        val folder =
+            requireNotNull(
+                DocumentFile.fromTreeUri(context, uri),
+                { "Folder with uri: '$uri' does not exist" },
+            )
         if (folder.exists()) {
             val path = uri.toReadablePath()
             Value.text = path
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/note/PlayAudioActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/note/PlayAudioActivity.kt
@@ -52,7 +52,8 @@ class PlayAudioActivity : LockedActivity<ActivityPlayAudioBinding>() {
         configureEdgeToEdgeInsets()
         audio =
             requireNotNull(
-                intent?.let { IntentCompat.getParcelableExtra(it, EXTRA_AUDIO, Audio::class.java) }
+                intent?.let { IntentCompat.getParcelableExtra(it, EXTRA_AUDIO, Audio::class.java) },
+                { "PlayAudioActivity intent has no '$EXTRA_AUDIO' extra" },
             )
         binding.AudioControlView.setDuration(audio.duration)
 
@@ -159,7 +160,7 @@ class PlayAudioActivity : LockedActivity<ActivityPlayAudioBinding>() {
         super.onDestroy()
         if (service != null) {
             unbindService(connection)
-            requireNotNull(service).onStateChange = null
+            requireNotNull(service, { "service is null" }).onStateChange = null
             service = null
         }
         if (isFinishing) {
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/note/SelectLabelsActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/note/SelectLabelsActivity.kt
@@ -32,7 +32,11 @@ class SelectLabelsActivity : LockedActivity<ActivityLabelBinding>() {
         configureEdgeToEdgeInsets()
 
         val savedList = savedInstanceState?.getStringArrayList(EXTRA_SELECTED_LABELS)
-        val passedList = requireNotNull(intent.getStringArrayListExtra(EXTRA_SELECTED_LABELS))
+        val passedList =
+            requireNotNull(
+                intent.getStringArrayListExtra(EXTRA_SELECTED_LABELS),
+                { "SelectLabelsActivity intent has no '$EXTRA_SELECTED_LABELS' extra" },
+            )
         selectedLabels = savedList ?: passedList
 
         val result = Intent()
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/activity/note/ViewImageActivity.kt b/app/src/main/java/com/philkes/notallyx/presentation/activity/note/ViewImageActivity.kt
@@ -235,7 +235,11 @@ class ViewImageActivity : LockedActivity<ActivityViewImageBinding>() {
             withContext(Dispatchers.IO) {
                 val mediaRoot = application.getExternalImagesDirectory()
                 val file =
-                    if (mediaRoot != null) File(mediaRoot, requireNotNull(currentImage).localName)
+                    if (mediaRoot != null)
+                        File(
+                            mediaRoot,
+                            requireNotNull(currentImage, { "currentImage is null" }).localName,
+                        )
                     else null
                 if (file != null && file.exists()) {
                     val output = contentResolver.openOutputStream(uri) as FileOutputStream
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/main/label/SelectableLabelAdapter.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/main/label/SelectableLabelAdapter.kt
@@ -19,6 +19,6 @@ class SelectableLabelAdapter(private val selectedLabels: List<String>) :
     override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): SelectableLabelVH {
         val inflater = LayoutInflater.from(parent.context)
         val binding = RecyclerSelectableLabelBinding.inflate(inflater, parent, false)
-        return SelectableLabelVH(binding, requireNotNull(onChecked))
+        return SelectableLabelVH(binding, requireNotNull(onChecked, { "onChecked is null" }))
     }
 }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/view/misc/NotNullLiveData.kt b/app/src/main/java/com/philkes/notallyx/presentation/view/misc/NotNullLiveData.kt
@@ -6,6 +6,6 @@ import androidx.lifecycle.MutableLiveData
 open class NotNullLiveData<T>(value: T) : MutableLiveData<T>(value) {
 
     override fun getValue(): T {
-        return requireNotNull(super.getValue())
+        return requireNotNull(super.getValue(), { "NotNullLiveData value is null" })
     }
 }
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/BaseNoteModel.kt b/app/src/main/java/com/philkes/notallyx/presentation/viewmodel/BaseNoteModel.kt
@@ -210,7 +210,7 @@ class BaseNoteModel(private val app: Application) : AndroidViewModel(app) {
         if (labelCache[label] == null) {
             labelCache[label] = Content(baseNoteDao.getBaseNotesByLabel(label), ::transform)
         }
-        return requireNotNull(labelCache[label])
+        return requireNotNull(labelCache[label], { "labelCache has no '$label' value" })
     }
 
     fun getNotesWithoutLabel(): Content {
@@ -357,7 +357,11 @@ class BaseNoteModel(private val app: Application) : AndroidViewModel(app) {
         viewModelScope.launch(exceptionHandler) {
             val importedNotes =
                 withContext(Dispatchers.IO) {
-                    val stream = requireNotNull(app.contentResolver.openInputStream(uri))
+                    val stream =
+                        requireNotNull(
+                            app.contentResolver.openInputStream(uri),
+                            { "InputStream for '$uri' is null" },
+                        )
                     val (baseNotes, labels) = stream.readAsBackup()
                     commonDao.importBackup(baseNotes, labels)
                     baseNotes.size
diff --git a/app/src/main/java/com/philkes/notallyx/presentation/widget/WidgetFactory.kt b/app/src/main/java/com/philkes/notallyx/presentation/widget/WidgetFactory.kt
@@ -53,7 +53,7 @@ class WidgetFactory(
 
     override fun getViewAt(position: Int): RemoteViews {
         val copy = baseNote
-        requireNotNull(copy)
+        requireNotNull(copy, { "baseNote is null" })
 
         return when (copy.type) {
             Type.NOTE -> getNoteView(copy)
diff --git a/app/src/main/java/com/philkes/notallyx/utils/backup/ExportExtensions.kt b/app/src/main/java/com/philkes/notallyx/utils/backup/ExportExtensions.kt
@@ -106,7 +106,7 @@ fun ContextWrapper.createBackup(): Result {
     val path = preferences.backupsFolder.value
 
     if (path != EMPTY_PATH) {
-        val uri = Uri.parse(path)
+        val uri = path.toUri()
         val folder =
             requireBackupFolder(
                 path,
@@ -127,7 +127,12 @@ fun ContextWrapper.createBackup(): Result {
             val backupFilePrefix = PERIODIC_BACKUP_FILE_PREFIX
             val name = "$backupFilePrefix${formatter.format(System.currentTimeMillis())}.zip"
             log(msg = "Creating '$uri/$name'...")
-            val zipUri = requireNotNull(folder.createFile(MIME_TYPE_ZIP, name)).uri
+            val zipUri =
+                requireNotNull(
+                        folder.createFile(MIME_TYPE_ZIP, name),
+                        { "Failed to create '$name' for Backup in Folder: '${folder.uri}'" },
+                    )
+                    .uri
             val exportedNotes = app.exportAsZip(zipUri, password = preferences.backupPassword.value)
             log(msg = "Exported $exportedNotes notes")
             val backupFiles = folder.listZipFiles(backupFilePrefix)
diff --git a/app/src/main/java/com/philkes/notallyx/utils/backup/ImportExtensions.kt b/app/src/main/java/com/philkes/notallyx/utils/backup/ImportExtensions.kt
@@ -76,7 +76,11 @@ suspend fun ContextWrapper.importZip(
     try {
         val importedNotes =
             withContext(Dispatchers.IO) {
-                val stream = requireNotNull(contentResolver.openInputStream(zipFileUri))
+                val stream =
+                    requireNotNull(
+                        contentResolver.openInputStream(zipFileUri),
+                        { "InputStream for zipFileUri '$zipFileUri' is null" },
+                    )
                 val tempZipFile = File(databaseFolder, "TEMP.zip")
                 stream.copyToFile(tempZipFile)
                 val zipFile = ZipFile(tempZipFile)
@@ -375,7 +379,11 @@ suspend fun Context.importFile(
     proposedMimeType: String? = null,
 ): Pair<FileAttachment?, FileError?> {
     return withContext(Dispatchers.IO) {
-        val document = requireNotNull(DocumentFile.fromSingleUri(this@importFile, uri))
+        val document =
+            requireNotNull(
+                DocumentFile.fromSingleUri(this@importFile, uri),
+                { "importFile: could not read file from: '$uri'" },
+            )
         val displayName = document.name ?: getString(R.string.unknown_name)
         try {
 
@@ -386,7 +394,11 @@ suspend fun Context.importFile(
             */
             val temp = File(directory, "Temp")
 
-            val inputStream = requireNotNull(contentResolver.openInputStream(uri))
+            val inputStream =
+                requireNotNull(
+                    contentResolver.openInputStream(uri),
+                    { "importFile: InputStream for '$uri' is null" },
+                )
             inputStream.copyToFile(temp)
 
             val originalName = getFileName(uri)
diff --git a/app/src/main/java/com/philkes/notallyx/utils/backup/MigrationsExtensions.kt b/app/src/main/java/com/philkes/notallyx/utils/backup/MigrationsExtensions.kt
@@ -19,7 +19,11 @@ fun Context.clearAllFolders() {
 
 fun Context.getPreviousLabels(): List<Label> {
     val preferences = getLabelsPreferences()
-    val labels = requireNotNull(preferences.getStringSet("labelItems", emptySet()))
+    val labels =
+        requireNotNull(
+            preferences.getStringSet("labelItems", emptySet()),
+            { "preference do not have 'labelItems' String set" },
+        )
     return labels.map { value -> Label(value) }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -347,7 +347,7 @@ fun StylableEditTextWithHistory.createTextWatcherWithHistory(`
`347`	`347`	`}`
`348`	`348`
`349`	`349`	`override fun afterTextChanged(s: Editable?) {`
`350`		`- val textAfter = requireNotNull(s).clone()`
	`350`	`+ val textAfter = requireNotNull(s, { "afterTextChanged: Editable is null" }).clone()`
`351`	`351`	`if (textAfter.hasNotChanged(stateBefore.text)) {`
`352`	`352`	`return`
`353`	`353`	`}`
Original file line number	Diff line number	Diff line change
`@@ -494,7 +494,9 @@ class MainActivity : LockedActivity<ActivityMainBinding>() {`
`494`	`494`	`fragmentIdToLoad != null &&`
`495`	`495`	`navController.currentDestination?.id != fragmentIdToLoad`
`496`	`496`	`) {`
`497`		`- navigateWithAnimation(requireNotNull(fragmentIdToLoad))`
	`497`	`+ navigateWithAnimation(`
	`498`	`+ requireNotNull(fragmentIdToLoad, { "fragmentIdToLoad is null" })`
	`499`	`+ )`
`498`	`500`	`}`
`499`	`501`	`}`
`500`	`502`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@ abstract class NotallyFragment : Fragment(), ItemListener {`
`200`	`200`	`doAfterTextChanged { text ->`
`201`	`201`	`val isSearchFragment = navController.currentDestination?.id == R.id.Search`
`202`	`202`	`if (isSearchFragment) {`
`203`		`- model.keyword = requireNotNull(text).trim().toString()`
	`203`	`+ model.keyword = requireNotNull(text, { "text is null" }).trim().toString()`
`204`	`204`	`}`
`205`	`205`	`if (text?.isNotEmpty() == true && !isSearchFragment) {`
`206`	`206`	`setText("")`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,6 @@ class SelectableLabelAdapter(private val selectedLabels: List<String>) :`
`19`	`19`	`override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): SelectableLabelVH {`
`20`	`20`	`val inflater = LayoutInflater.from(parent.context)`
`21`	`21`	`val binding = RecyclerSelectableLabelBinding.inflate(inflater, parent, false)`
`22`		`- return SelectableLabelVH(binding, requireNotNull(onChecked))`
	`22`	`+ return SelectableLabelVH(binding, requireNotNull(onChecked, { "onChecked is null" }))`
`23`	`23`	`}`
`24`	`24`	`}`