Add an unresolver similar to our resolver #6944
Conversation
ericholscher
changed the title
Turn a URL into the component parts that our views would use to process them. This is useful for lots of places, like where we want to figure out exactly what file a URL maps to
There was a problem hiding this comment.
This seems fine and reasonably well tested. I know this is primarily for the Embed API initially and that seems fine but if we need to ever unresolve multiple URLs, there's probably optimizations we could do because each call to this is going to involve multiple queries.
|
|
||
| from readthedocs.core.utils.extend import SettingsOverrideObject | ||
| from readthedocs.proxito.middleware import map_host_to_project_slug | ||
| from readthedocs.proxito.views.utils import _get_project_data_from_request |
There was a problem hiding this comment.
If we're using it outside of proxito, it probably shouldn't be private (underscore prefixed).
There was a problem hiding this comment.
Having an object like this is great! It seems we are not using it yet in this code, but I think we can iterate over and refactor other places to start using it. Looks like a good win!
This unresolver, will help us to test deeply the URLConf defined by the user, as well 😄
readthedocs/core/unresolver.py
Outdated
|
|
||
| # Handle returning a response | ||
| if hasattr(project_slug, 'status_code'): | ||
| return UnresolvedObject(None, None, None, None, None) |
There was a problem hiding this comment.
Why not just return None instead?
There was a problem hiding this comment.
It will be easier to perform checks by checking if parts than if parts.<somefield> --looks more intuitive to me, since <somefield> could be None and be a valid object as well (fragment, for example)
|
|
||
| @override_settings( | ||
| PUBLIC_DOMAIN='readthedocs.io', | ||
| RTD_EXTERNAL_VERSION_DOMAIN='dev.readthedocs.build', |
There was a problem hiding this comment.
nit: I think it's better if we use the real production value. It's easier to visualize and compare.
There was a problem hiding this comment.
This is the dev value, which I think makes sense for testing.
| PUBLIC_DOMAIN='readthedocs.io', | ||
| RTD_EXTERNAL_VERSION_DOMAIN='dev.readthedocs.build', | ||
| ) | ||
| @pytest.mark.proxito |
There was a problem hiding this comment.
I don't think proxito settings are required for this. We are just testing an object.
There was a problem hiding this comment.
They import the proxito code tho, at least currently
| parts = unresolve('http://pip.readthedocs.io/en/latest/foo.html#fragment') | ||
| self.assertEqual(parts.project.slug, 'pip') | ||
| self.assertEqual(parts.language_slug, 'en') | ||
| self.assertEqual(parts.version_slug, 'latest') | ||
| self.assertEqual(parts.filename, 'foo.html') | ||
| self.assertEqual(parts.fragment, 'fragment') |
There was a problem hiding this comment.
I love these tests! Super easy to follow! 💯 More "unit test" that our current tests that needs to call Django internals
| self.assertEqual(parts.filename, '') | ||
|
|
||
| def test_unresolver_single_version(self): | ||
| self.pip.single_version = True |
There was a problem hiding this comment.
Isn't it required to .save the project here? 🤔
Turn a URL into the component parts that our views would use to process them.
Look at the tests for an example.