Api urls in json by will-moore · Pull Request #5035 · ome/openmicroscopy

will-moore · 2017-01-16T13:11:29Z

What this PR does

Adds urls to the api json in the same style as github api, E.g. https://api.github.com/users/will-moore
E,g, when listing /projects/ each will have links that are absolute urls (clickable in browser)

"url:datasets": "http://localhost:4080/api/v0.1/m/projects/11601/datasets/",
"url:project": "http://localhost:4080/api/v0.1/m/projects/11601/",

Testing this PR

Urls to expect:
- /projects/ - each project has link to 'datasets' and 'project' as above.
- /project/:id/ - has a link to 'datasets' only.
- /datasets/ - each dataset has link to 'images and 'dataset'.
- /dataset/ - has link to 'images' only.
- /images/ - each image has link to 'image' only.
- Same for Screens -> Plates (no links to Wells - not yet supported)
Tests cover all urls in P->D->I in test_pdi_urls() and S>P in test_spw_urls()
- I have ignored urls in test_api_projects.py (and now test_api_images)
- And will have to do the same for future tests.

NB: urls can be configured to be "absolute" vv prefixed using the "omero.web.api.absolute_url" setting.

cc @chris-allan @aleksandra-tarkowska @jburel

atarkowska · 2017-01-16T14:23:37Z

regarding your question about absolute uri, my feeling was that by default we will skip domain from api, but I don't remember exactly what we said over the meeting about build_absolute_uri #4708 (comment).

EDITED: So to test urls in unittests did you try using @override_settings() see example https://github.com/openmicroscopy/openmicroscopy/pull/4706/files#diff-23c6659b076340831a8d1839cea54cfaR94. For integration tests you would need to decide global config set by bin/omero and build_absolute_uri in a test?

atarkowska · 2017-01-16T15:59:33Z

THAT IS AN EXAMPLE OF BUILDING ABSOLUTE URI in UNITTEST to assert values
Don't use it in django APP

To call build_absolute_uri did you try in your tests:

from django.http import HttpRequest

def request_helper(url):
  r = HttpRequest()   
  r.META = {
    "SERVER_NAME": "testserver",
    "SERVER_PORT": "80",
  }
  return r.build_absolute_uri(url)

request_helper(reverse('weblogin'))

manics · 2017-01-16T16:35:58Z

Is the absolute URI based on the Host header sent by the client?

This reverts commit 09a2e71.

will-moore · 2017-01-17T00:02:49Z

@manics Are you talking about the Django test framework or 'real world'? I think it's Yes either way.

atarkowska · 2017-01-17T00:07:56Z

@manics yes it is. My understanding was that we will omit using build_absolute_uri anywhere unless someone configure it https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroWeb/omeroweb/settings.py#L475, but that is no longer true https://github.com/openmicroscopy/openmicroscopy/blob/develop/components/tools/OmeroWeb/omeroweb/api/views.py#L56.

manics · 2017-01-17T09:36:19Z

@will-moore The real world. We had a load of problems with the IDR due to multi-layered proxies, so just wanted to be sure this would work.

will-moore · 2017-01-18T06:43:29Z

Failing test test_dataset_images due to image_url not being ignored.

        assert_objects(conn, rsp['data'], [orphaned], dtype='Image',
>                      opts={'load_pixels': True})

test/integration/test_api_images.py:150:

Need to handle this as in test_api_projects.py

jburel · 2017-01-18T09:38:24Z

components/tools/OmeroWeb/omeroweb/api/views.py

+        Subclasses can configure self.urls to specify urls to add.
+        See ProjectsView urls as example
+        """
+        # if self.urls is None:


remove if no longer needed

jburel · 2017-01-18T09:46:27Z

components/tools/OmeroWeb/omeroweb/api/views.py


+    # Urls to add to marshalled object. See ProjectsView for more details
+    urls = {
+        'dataset_url': {'name': 'api_dataset',


maybe keep the same order for the url list in each view
i.e. retrieval of children then object e.g. datasets/project

in Python order in dict is not guaranteed (unless you use https://docs.python.org/2.7/library/collections.html#collections.OrderedDict), why order matters?

I found it easier to read when reviewing the code
This is mainly for review later on when we get back to it

will-moore · 2017-01-19T11:45:57Z

As discussed in today's web meeting, we'll use the url: prefix for urls e.g. url:datasets since this seems compatible with omero: prefix. Updated in commits above.

jburel · 2017-01-19T21:33:13Z

components/tools/OmeroWeb/test/integration/test_api_containers.py

+    """Build an absolute url using client response url."""
+    response = client.request()
+    # http://testserver/webclient/
+    webclint_url = response.url


typo: I think you mean webclient_url

will-moore · 2017-01-19T22:10:13Z

@jburel fixed typo, thanks

will-moore · 2017-01-20T09:45:23Z

Last commit should fix test https://ci.openmicroscopy.org/view/Failing/job/OMERO-DEV-merge-integration-Python27/435/testReport/OmeroWeb.test.integration.test_api_projects/TestProjects/test_project_create_read/

jburel · 2017-01-20T12:14:38Z

@will-moore I guess your comment is for #5023

jburel · 2017-01-23T20:34:29Z

Thanks @will-moore. Merging

will-moore added 5 commits January 13, 2017 09:53

add_data() in ObjectsView used to add urls in ProjectsView

b8eb153

Rename pid -> object_id for ObjectView

c179062

ObjectsView.add_data() uses subcleass.url = {} to add urls

10b3315

Adding urls to 'extra' in test_screens()

3832b75

Work-around to add http://testserver/ to test urls

9cff702

will-moore closed this Jan 16, 2017

will-moore added 4 commits January 16, 2017 22:10

Use request.build_absolute_uri() in test_screens

09a2e71

Revert "Use request.build_absolute_uri() in test_screens"

cdb5a5e

This reverts commit 09a2e71.

Added build_url() helper to test_api_containers

7785e68

Remove '_url' values from json in test_api_projects * containers

801ad6f

will-moore reopened this Jan 16, 2017

Merge remote-tracking branch 'origin/develop' into api_urls_in_json

37bb038

will-moore added 5 commits January 17, 2017 11:19

Add 'images_url' to /datasets/ json

e0ff25e

New ApiView base class for ObjectsView and ObjectView

d986da1

Add children_urls to Project, Dataset & Screen json

3ce2708

Fix pid -> object_id rename in test_api_projects.py

fd287d3

Add new test_pdi_urls

e0f9313

jburel reviewed Jan 18, 2017

View reviewed changes

will-moore mentioned this pull request Jan 18, 2017

Api wells #5047

Merged

will-moore added 4 commits January 18, 2017 13:57

Ignore urls in test_api_images assert_objects()

871b803

Fixes from ome#5035 for api/views.py

af2614e

Add test_spw_urls()

64c05a7

Use url: prefix for urls in json

074876d

will-moore added 2 commits January 19, 2017 11:40

Update tests to use 'url:' prefix for urls

ddc2f23

flake8 fix

981db6e

Update test_api_login.py to use 'url:' prefix

a9b6ca0

jburel reviewed Jan 19, 2017

View reviewed changes

Fix typo webclint

ff95b03

Fix missing '_url' -> 'url:' keys in test_api_projects.py

a364e39

will-moore closed this Jan 20, 2017

will-moore reopened this Jan 20, 2017

will-moore closed this Jan 20, 2017

will-moore reopened this Jan 20, 2017

jburel merged commit 2b4e9f8 into ome:develop Jan 23, 2017

jburel added this to the 5.3.0 milestone Mar 29, 2017

will-moore deleted the api_urls_in_json branch February 18, 2019 04:09

Conversation

will-moore commented Jan 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does

Testing this PR

Uh oh!

atarkowska commented Jan 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

atarkowska commented Jan 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manics commented Jan 16, 2017

Uh oh!

will-moore commented Jan 17, 2017

Uh oh!

atarkowska commented Jan 17, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

manics commented Jan 17, 2017

Uh oh!

will-moore commented Jan 18, 2017

Uh oh!

jburel Jan 18, 2017

Choose a reason for hiding this comment

Uh oh!

jburel Jan 18, 2017

Choose a reason for hiding this comment

Uh oh!

atarkowska Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jburel Jan 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

will-moore commented Jan 19, 2017

Uh oh!

jburel Jan 19, 2017

Choose a reason for hiding this comment

Uh oh!

will-moore commented Jan 19, 2017

Uh oh!

will-moore commented Jan 20, 2017

Uh oh!

jburel commented Jan 20, 2017

Uh oh!

jburel commented Jan 23, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

will-moore commented Jan 16, 2017 •

edited

Loading

atarkowska commented Jan 16, 2017 •

edited

Loading

atarkowska commented Jan 16, 2017 •

edited

Loading

atarkowska commented Jan 17, 2017 •

edited

Loading

atarkowska Jan 18, 2017 •

edited

Loading

jburel Jan 18, 2017 •

edited

Loading