#filePath and #file should not be used in non-test code.

[macwilko]

Description

Apple do not recommend using #file and #filePath in non-test code.

There is a feature that's upcoming, make #file behave like #fileID (which is privacy preserving).

https://www.hackingwithswift.com/swift/5.8/concise-magic-file-names

The use of #filePath in PF code is problematic as it will leak information in produced binaries about the environment that created the binary.

Checklist

• I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
• If possible, I've reproduced the issue using the main branch of this package.
• This issue hasn't been addressed in an existing GitHub issue or discussion.

Expected behavior

Use #fileID only in non-test code

Actual behavior

#filePath is present in non-test code.

Reproducing project

No response

The Composable Architecture version information

No response

Destination operating system

No response

Xcode version information

No response

Swift Compiler version information

[stephencelis]

@macwilko I've converted this to a discussion because we don't consider this a bug (for now).

Are there particular usages that concern you? I believe most of our uses of #filePath are for reportIssue, which requires that information to properly collocate test failures with XCTest, and while we could discuss limiting this using something like #if DEBUG, this would mean folks can't write tests against these failures in release builds, and losing testability in release isn't ideal.