feat: convert mime_type field to its own model. #129
Merged
Conversation
This file contains hidden or 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
This commit normalizes the Media/MIME type in RawContent to be a foriegn key to a new table rather than a text string. This was done for a couple of reasons: 1. Recent problems with edx-platform's courseware_studentmodule table have driven home the point that we should try to reduce index sizes where possible, and RawContent is likely to grow into a very large table in time. 2. Media type designations can sometimes change, and that's much easier to do as a data migration if it's in its own lookup table, rather than affecting millions of rows in RawContent. In order to support these changes, I've also added LRU caching for MediaType lookup... which in turn required a test helper that will clear out the values between test calls. That's the rationale behind our new openedx_learning.lib.test_utils.TestCase.
ormsbee
force-pushed
the
normalize-mimetype
branch
from
082f313 to
1a2a27f
Compare
Contributor
Author
|
@kdmccormick, @bradenmacdonald: The MIME type refactoring I mentioned earlier. |
bradenmacdonald
approved these changes
Dec 4, 2023
Contributor
bradenmacdonald
left a comment
bradenmacdonald
left a comment
There was a problem hiding this comment.
Looks nice! I didn't test the code, but I read it and this makes sense to me.
No problem changing existing migrations if they're not in use yet.
|
|
||
| # Second call pulls from cache instead of the database | ||
| with self.assertNumQueries(0): | ||
| contents_api.get_media_type_id(mime_type_str) |
Contributor
There was a problem hiding this comment.
Nit: It would be good to check the actual return value too, to make sure it's the same as the prior call. I guess other things are covered by how media_type is used throughout the test suite / app ?
| if self.suffix: | ||
| return f"{base}+{self.suffix}" | ||
| return base | ||
|
|
Contributor
There was a problem hiding this comment.
Nit: It's not necessary but it could be nice to have a clean function that forces the field values to lowercase, and checks for invalid characters or at least disallows /
kdmccormick
approved these changes
Dec 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This commit normalizes the Media/MIME type in RawContent to be a foriegn key to a new table rather than a text string. This was done for a couple of reasons:
In order to support these changes, I've also added LRU caching for MediaType lookup... which in turn required a test helper that will clear out the values between test calls. That's the rationale behind our new openedx_learning.lib.test_utils.TestCase.
One major thing that this PR does that is a big unusual at this stage is that it rewrites the database migrations for
oel_contentsandoel_components. I thought this was safe because we haven't actually included these apps into edx-platform yet, and it was cleaner than writing migration code on a non-nullable field.