openDocumentFile() returns null

[mx1up]

Describe the bug documentFile.openDocumentFile returns null, even on success

To Reproduce final result = await documentFile.openDocumentFile()

Expected behavior result to be true on success

Smartphone (please complete the following information):

• Device: android emulator
• OS: android api 33
• Version 0.7.1

Additional context this problem is reproducable using the sample app: example/lib/utils/document_file_utils.dart:25 launched is null on successful launch

[alexrintt]

Fix was released under v0.7.2, please re-open the issue if this behavior persists.

[mx1up]

hi @alexrintt , thanks for the quick fix. Unfortunately, now when no app is present that supports the file format, I no longer get an exception so I can only show a generic error to the user now. I guess I should have realized that before I created the ticket 🙄 it seems there is a clash in feedback for this method: it both returns a bool and throws exceptions in not so unusual situations.

Since starting the activity does not really provide feedback, I think it would be better to have it return void and throw exceptions like it used to..

[alexrintt]

Seems good, I'll provide this as part of v8 since it's a breaking change. Would be helpful if you could provide any exceptions you would like to handle, for now I can think only on Activity not found, Security Exception (when no read permission) and Unknown.

[mx1up]

cool, the exceptions you listed are indeed the important ones, of which Activity not found would be the most common in my use case.

btw, in theory, I think 0.7.2 introduced a breaking change, not on api signature level, but on behavioral level, by not throwing exceptions anymore in cases where an exception was expected.

[alexrintt]

Think you are right. I was using signature level as metric for breaking vs minor changes.

Not sure how an app would get a exception from these changes though, who was handling exceptions + the boolean return value doesn't need to change anything, in last case the client will just ignore the exception (since it doesn't throw anything now), but anyway thanks for the warning, I'll take better care from now on.

[alexrintt]

Retracted version 0.7.2, since it was released only 8h ago, I think there are only few affected clients besides you, I'll release the fix of this issue at v8.

[mx1up]

great, sorry for all the hassle ;)

[alexrintt]

I'll add an API method openDocumentFileWithResult, it will return a Future<OpenDocumentFileResult> where OpenDocumentFileResult is a enum with all possible results (success, error A, B, C, etc.).

The current openDocumentFile will be a simple openDocumentFileWithResult() == success around this new method.

This let the old users migrate to the fixed openDocumentFile and let people implement custom catches if they want to, using the new openDocumentFileWithResult.

Gonna add details soon.

[alexrintt]

Launched openDocumentFileWithResult at v.0.8, see ref.

I'll mark as done but feel free to re-open if needed.