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

Adds mime_type field to resource serializer #1363

Merged
merged 2 commits into from
Apr 10, 2017
Merged

Conversation

oliverroick
Copy link
Member

Proposed changes in this pull request

When should this PR be merged

Soon; this is important to move forward with data imports.

Risks

None

Follow-up actions

None

Checklist (for reviewing)

General

  • Is this PR explained thoroughly? All code changes must be accounted for in the PR description.
  • Is the PR labeled correctly? It should have the migration label if a new migration is added.
  • Is the risk level assessment sufficient? The risks section should contain all risks that might be introduced with the PR and which actions we need to take to mitigate these risks. Possible risks are database migrations, new libraries that need to be installed or changes to deployment scripts.

Functionality

  • Are all requirements met? Compare implemented functionality with the requirements specification.
  • Does the UI work as expected? There should be no Javascript errors in the console; all resources should load. There should be no unexpected errors. Deliberately try to break the feature to find out if there are corner cases that are not handled.

Code

  • Do you fully understand the introduced changes to the code? If not ask for clarification, it might uncover ways to solve a problem in a more elegant and efficient way.
  • Does the PR introduce any inefficient database requests? Use the debug server to check for duplicate requests.
  • Are all necessary strings marked for translation? All strings that are exposed to users via the UI must be marked for translation.

Tests

  • Are there sufficient test cases? Ensure that all components are tested individually; models, forms, and serializers should be tested in isolation even if a test for a view covers these components.
  • If this is a bug fix, are tests for the issue in place? There must be a test case for the bug to ensure the issue won’t regress. Make sure that the tests break without the new code to fix the issue.
  • If this is a new feature or a significant change to an existing feature? has the manual testing spreadsheet been updated with instructions for manual testing?

Security

  • Confirm this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets.
  • Are all UI and API inputs run through forms or serializers?
  • Are all external inputs validated and sanitized appropriately?
  • Does all branching logic have a default case?
  • Does this solution handle outliers and edge cases gracefully?
  • Are all external communications secured and restricted to SSL?

Documentation

  • Are changes to the UI documented in the platform docs? If this PR introduces new platform site functionality or changes existing ones, the changes must be documented in the Cadasta Platform Documentation.
  • Are changes to the API documented in the API docs? If this PR introduces new API functionality or changes existing ones, the changes must be documented in the API docs.
  • Are reusable components documented? If this PR introduces components that are relevant to other developers (for instance a mixin for a view or a generic form) they should be documented in the Wiki.

Copy link
Contributor

@seav seav left a comment

Choose a reason for hiding this comment

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

The changes look good. But I think we may need tests for the following 2 cases:

  1. Since you indicated in the serializer that the MIME type is not required, then there should be a test to check that you can create/update a resource that has no MIME type.
  2. Since only images are expected to have thumbnails, should we have a test that if the specified MIME type is not an image (or is missing), then no thumbnail is created? (What about for the unlikely case that a file's MIME type was updated from a non-image type to an image type?)

Copy link
Contributor

@linzjax linzjax left a comment

Choose a reason for hiding this comment

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

Does this address the issues that @amplifi raised here? #1322 (comment)

Resolving this issue will require adding a secure process by which we derive and/or verify the mimetype of the uploaded file, saving mimetype to the resources table in the db (and writing to S3 metadata if not already populated), quarantining files for which a user-specified mimetype doesn't match the derived mimetype and applying additional processing, then generating and displaying the appropriate preview image. Much of this is adjacent to #490.

@amplifi
Copy link
Contributor

amplifi commented Apr 3, 2017

@linzjax It doesn't address the mime type security issues, but it's an early component for handling proper processing end-to-end. Good looking out!

@oliverroick
Copy link
Member Author

@seav: I added two tests, one to verify that you can create a resource without specifying a mime type, and one to verify that no thumbnail is created for files other than images.

Since creating a thumbnail is handled in create_thumbnails, which is the same for creating and updating resources I don't think specific tests for updating the resource are necessary.

@seav
Copy link
Contributor

seav commented Apr 4, 2017

@linzjax, 2nd review is all yours!

@linzjax
Copy link
Contributor

linzjax commented Apr 4, 2017

Look good 👍

@amplifi amplifi force-pushed the bugfix/mime_types branch from d4c6158 to b9f441b Compare April 10, 2017 11:07
@amplifi amplifi merged commit 21e15a1 into master Apr 10, 2017
@amplifi amplifi deleted the bugfix/mime_types branch April 10, 2017 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants