Suppport for D2L files proxing using Via #4792

marcospri · 2022-12-21T10:22:03Z

Needs

Testing

Checkout Allow to send headers to proxied documents h-vialib#42 h_vialib
Checkout Proxy D2L files using python via#845 in Via
Install the local version of h-vialib in both Via and LMS

I've been using

.tox/dev/bin/pip install -e /home/marcos/hypo/h-vialib for this.

Enable D2L files in http://localhost:8001/admin/instance/id/106/
Launch a D2L assignment as a teacher and configure it as D2L assignment:

https://aunltd.brightspacedemo.com/d2l/le/content/6782/viewContent/2184/View

You should be able to see the contents of the file a follow the trip of URL
- via_url request to LMS to get the file which contains the via.secret.headers
- Via request to get the pdf, again with the header

marcospri · 2022-12-22T14:41:33Z

lms/services/d2l_api/client.py

+        # We don't need the data from this call.
+        # We are only interested on the potential side effect of needing
+        # a new access token and/or refreshing an existing one.
+        _ = self._api.request(


This is a bit of a hack but the whole setup is (sending the header etc).

Is this because we're going to be sending our access token to Via (in the new secret headers), and we therefore need to make sure that the access token is still valid first?

marcospri · 2022-12-22T14:42:33Z

lms/views/api/d2l/files.py

+
+    public_url = request.find_service(D2LAPIClient).public_url(course_id, file_id)
+
+    access_token = request.find_service(name="oauth2_token").get().access_token


I thought I might need to get this from a private method in the client but we can just use the oauth2 service 👍

seanh

I haven't tested it myself, but this all looks totally sound to me.

seanh · 2022-12-22T15:49:45Z

lms/resources/_js_config/__init__.py

+        elif document_url.startswith("d2l://"):
+            self._config["api"]["viaUrl"] = {
+                "authUrl": self._request.route_url(D2L.route.oauth2_authorize),
+                "path": self._request.route_path(
+                    "d2l_api.courses.files.via_url",
+                    course_id=self._request.lti_params["context_id"],
+                    _query={"document_url": document_url},
+                ),
+            }


Ah ok, this is the config telling the frontend to make the API call to get the Via URL? 👍

seanh · 2022-12-22T15:50:28Z

lms/routes.py

+    config.add_route(
+        "d2l_api.courses.files.via_url", "/api/d2l/courses/{course_id}/via_url"
+    )


And the new Via URL API for the frontend to call go get D2L files Via URLs 👍

seanh · 2022-12-22T15:51:09Z

lms/services/d2l_api/client.py

@@ -117,6 +117,32 @@ def course_table_of_contents(self, org_unit) -> List[dict]:
        )
        return D2LTableOfContentsSchema(response).parse().get("modules", [])

+    def public_url(self, org_unit, file_id) -> str:


Service method for getting a public URL for a D2L file. So far this is all very familiar 😄

lms/services/d2l_api/client.py

seanh · 2022-12-22T15:53:19Z

lms/services/d2l_api/client.py

+        To make sure the API authentication header is not expired we'll make a API
+        request here so if it needs to be refreshed we follow the standard token refresh procedure.
+
+        https://docs.valence.desire2learn.com/res/content.html#get--d2l-api-le-(version)-(orgUnitId)-content-topics-(topicId)
+        https://docs.valence.desire2learn.com/res/content.html#get--d2l-api-le-(version)-(orgUnitId)-content-topics-(topicId)-file


I think this is probably better in code comments next to the code that makes these requests. Otherwise it seems likely that if the code changes this docstring will get out of date.

seanh · 2022-12-22T15:54:15Z

lms/services/d2l_api/client.py

+        # We don't need the data from this call.
+        # We are only interested on the potential side effect of needing
+        # a new access token and/or refreshing an existing one.
+        _ = self._api.request(


Is this because we're going to be sending our access token to Via (in the new secret headers), and we therefore need to make sure that the access token is still valid first?

seanh · 2022-12-22T15:55:18Z

lms/views/api/d2l/authorize.py

@@ -8,7 +8,7 @@
 from lms.validation.authentication import OAuthCallbackSchema

 GROUPS_SCOPES = ("groups:*:*",)
-FILES_SCOPES = ("content:toc:read",)
+FILES_SCOPES = ("content:toc:read", "content:topics:read")


I wonder what will happen to people who've already granted us access tokens without the topics scope? Will they get prompted to re-authorize us? Maybe no real users are using this feature yet anyway?

marcospri changed the base branch from main to d2l-file-api December 21, 2022 10:22

marcospri force-pushed the d2l-file-proxing branch from d77f90f to a403f9d Compare December 21, 2022 11:04

marcospri changed the title ~~[WIP]D2l file proxing~~ Suppport for D2L files proxing using Via Dec 21, 2022

This was referenced Dec 21, 2022

Allow to send headers to proxied documents hypothesis/h-vialib#42

Merged

Proxy D2L files using python hypothesis/via#845

Merged

marcospri force-pushed the d2l-file-api branch 2 times, most recently from e006c0a to 533b08f Compare December 22, 2022 09:19

Base automatically changed from d2l-file-api to main December 22, 2022 09:28

marcospri added the ⚠️ do not merge ⚠️ label Dec 22, 2022

marcospri force-pushed the d2l-file-proxing branch from a403f9d to 40f6193 Compare December 22, 2022 14:39

marcospri commented Dec 22, 2022

View reviewed changes

seanh approved these changes Dec 22, 2022

View reviewed changes

marcospri mentioned this pull request Dec 23, 2022

Support nested folders/files in the files response #4795

Closed

marcospri removed the ⚠️ do not merge ⚠️ label Jan 11, 2023

marcospri added 2 commits January 11, 2023 11:57

Add required scopes for file proxing

22aba8e

Via url endpoint for D2L files

f52278b

marcospri force-pushed the d2l-file-proxing branch from 40f6193 to 4a7872d Compare January 12, 2023 12:01

marcospri added 2 commits January 12, 2023 15:08

Public URL endpoint for D2L files

0df63bf

Pass headers along to via

8294040

marcospri force-pushed the d2l-file-proxing branch from 644350e to 8294040 Compare January 12, 2023 14:45

marcospri marked this pull request as ready for review January 16, 2023 08:29

marcospri merged commit 80e13b2 into main Jan 16, 2023

marcospri deleted the d2l-file-proxing branch January 16, 2023 08:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suppport for D2L files proxing using Via #4792

Suppport for D2L files proxing using Via #4792

marcospri commented Dec 21, 2022 •

edited

Loading

marcospri Dec 22, 2022

seanh Dec 22, 2022

marcospri Dec 22, 2022

seanh left a comment

seanh Dec 22, 2022

seanh Dec 22, 2022

seanh Dec 22, 2022

seanh Dec 22, 2022

seanh Dec 22, 2022

seanh Dec 22, 2022


		public_url = request.find_service(D2LAPIClient).public_url(course_id, file_id)

		access_token = request.find_service(name="oauth2_token").get().access_token

Suppport for D2L files proxing using Via #4792

Suppport for D2L files proxing using Via #4792

Conversation

marcospri commented Dec 21, 2022 • edited Loading

Needs

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seanh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcospri commented Dec 21, 2022 •

edited

Loading