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 in StaticFIleServer init if passed a non-directory path #1389
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kilnerm
force-pushed
the
sfs_failableinit
branch
2 times, most recently
from
January 21, 2019 08:56
edb4d9a
to
793eda9
Compare
djones6
requested changes
Jan 21, 2019
I have updated the change to be non-breaking. |
djones6
requested changes
Jan 21, 2019
kilnerm
changed the title
Fail StaticFIleServer init if passed a non-directory path
Log error in StaticFIleServer init if passed a non-directory path
Jan 21, 2019
djones6
approved these changes
Jan 22, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Looks good now, thanks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the StaticFileServer to have a failable initializer, updates the initializer to fail if the
path
parameter is not to a directory and adds a test to ensure the initializer fails whenpath
is a file.Motivation and Context
Currently the StaticFileServer documentation states the
path
parameter should be a folder but the initializer will accept a file which can lead to files being incorrectly served. This change prevents this scenario.How Has This Been Tested?
I have added a test which will try to create a StaticFileServer using a path to a file, should the StaticFileServer be successfully created then the test will fail. I have also stepped through the debugger to ensure the code functions as expected.
Checklist: