Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log error instead of throwing security exception #6363

Merged
merged 3 commits into from
Aug 21, 2024

Conversation

grzesiek2010
Copy link
Member

@grzesiek2010 grzesiek2010 commented Aug 21, 2024

Why is this the best possible solution? Were any other approaches considered?

As we discussed on slack with @seadowg there is something wrong with the way analyze paths and throw the SeciurityException so we should stop doing that (throwing the exception) until we know what is going on there and can properly fix the code.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

It doesn't require testing.

Do we need any specific form for testing your changes? If so, please attach one.

No.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

No.

Before submitting this PR, please make sure you have:

  • added or modified tests for any new or changed behavior
  • run ./gradlew connectedAndroidTest (or ./gradlew testLab) and confirmed all checks still pass
  • added a comment above any new strings describing it for translators
  • added any new strings with date formatting to DateFormatsTest
  • verified that any code or assets from external sources are properly credited in comments and/or in the about file.
  • verified that any new UI elements use theme colors. UI Components Style guidelines

object PathUtils {

@JvmStatic
fun getRelativeFilePath(dirPath: String, filePath: String): String {
return if (filePath.startsWith(dirPath)) filePath.substring(dirPath.length + 1) else filePath
}

@JvmStatic
fun getAbsoluteFilePath(dirPath: String, filePath: String): String {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to move this whole method to the androidshared module because the shared one is a pure java/kotlin module and I can't use Timber or Analytics there. I've tried SLF4J to no avail. I think we should file an issue to figure out how to log things in such modules.

@grzesiek2010 grzesiek2010 marked this pull request as ready for review August 21, 2024 13:49
assertThat(path, equalTo(nonCanonicalPath + File.separator + "file"))
}
// @Test
// fun `getAbsoluteFilePath() returns filePath prepended with dirPath`() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this as well and just ignore the tests for the SecurityException?

@seadowg seadowg merged commit 8a59270 into getodk:v2024.2.x Aug 21, 2024
6 checks passed
seadowg added a commit to seadowg/collect that referenced this pull request Aug 22, 2024
…eption

Log error instead of throwing security exception
seadowg added a commit to seadowg/collect that referenced this pull request Aug 23, 2024
…eption

Log error instead of throwing security exception
grzesiek2010 pushed a commit to grzesiek2010/collect that referenced this pull request Oct 29, 2024
…eption

Log error instead of throwing security exception
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants