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.

Sign up for GitHub

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

Jump to bottom

Load JS view assets from CDN when applicable #1958

Merged
merged 3 commits into from
Jun 7, 2023
Merged

Load JS view assets from CDN when applicable #1958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cff4e77
Load JS view assets from CDN when applicable
jonatanklosko Jun 5, 2023
09cb62a
Format
jonatanklosko Jun 5, 2023
4d16bb2
Simplify loading strategy check
jonatanklosko Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 47 additions & 11 deletions assets/js/hooks/js_view.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,12 @@ import { initializeIframeSource } from "./js_view/iframe";
*
* * `data-ref` - a unique identifier used as messages scope
*
* * `data-assets-base-path` - the path to resolve all relative paths
* against in the iframe
* * `data-assets-base-path` - the base path to fetch assets from
* within the iframe (and resolve all relative paths against)
*
* * `data-assets-cdn-url` - a URL to CDN location to fetch assets
* from. Only used if specified and the entrypoint script can be
* successfully accessed, also only when Livebook runs on https
*
* * `data-js-path` - a relative path for the initial view-specific
* JS module
Expand Down Expand Up @@ -179,6 +183,7 @@ const JSView = {
return {
ref: getAttributeOrThrow(this.el, "data-ref"),
assetsBasePath: getAttributeOrThrow(this.el, "data-assets-base-path"),
assetsCdnUrl: getAttributeOrDefault(this.el, "data-assets-cdn-url", null),
jsPath: getAttributeOrThrow(this.el, "data-js-path"),
sessionToken: getAttributeOrThrow(this.el, "data-session-token"),
connectToken: getAttributeOrThrow(this.el, "data-connect-token"),
Expand Down Expand Up @@ -334,17 +339,17 @@ const JSView = {

handleChildMessage(message, onReady) {
if (message.type === "ready" && !this.childReady) {
const assetsBaseUrl = window.location.origin + this.props.assetsBasePath;
this.getAssetsBaseUrl().then((assetsBaseUrl) => {
this.postMessage({
type: "readyReply",
token: this.childToken,
baseUrl: assetsBaseUrl,
jsPath: this.props.jsPath,
});

this.postMessage({
type: "readyReply",
token: this.childToken,
baseUrl: assetsBaseUrl,
jsPath: this.props.jsPath,
this.childReady = true;
onReady();
});

this.childReady = true;
onReady();
} else {
// Note: we use a random token to authorize child messages
// and do our best to make this token unavailable for the
Expand Down Expand Up @@ -386,6 +391,21 @@ const JSView = {
}
},

getAssetsBaseUrl() {
// Livebook may be running behind an authentication proxy, in
// which case the internal assets URL is not accessible from
// within the iframe (served from a different origin). To
// workaround this, we fallback to a CDN for the assets if
// available for the given package.
return cachedPublicEndpointCheck().then((isPublicAccessible) => {
if (!isPublicAccessible && this.props.assetsCdnUrl) {
return this.props.assetsCdnUrl;
} else {
return window.location.origin + this.props.assetsBasePath;
}
});
Comment on lines +401 to +406
Copy link
Member Author

Choose a reason for hiding this comment

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

I reverted the logic, instead of checking if the CDN is accessible, we check if Livebook /public is accessible and only fallback to CDN if not (if the CDN points to a private package it would fail either way). This way the check is simpler and we do it only once.

},

postMessage(message) {
this.iframe.contentWindow.postMessage(message, "*");
},
Expand Down Expand Up @@ -486,4 +506,20 @@ const JSView = {
},
};

/**
* Checks if Livebook public endpoint is accessible without auth cookies.
*
* Returns a promise that resolves to a boolean. The request is sent only
* once and the response is cached.
*/
function cachedPublicEndpointCheck() {
cachedPublicEndpointCheck.promise =
cachedPublicEndpointCheck.promise ||
fetch("/public/health")
.then((response) => response.status === 200)
.catch((error) => false);

return cachedPublicEndpointCheck.promise;
}

export default JSView;
3 changes: 2 additions & 1 deletion lib/livebook/runtime.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,8 @@ defprotocol Livebook.Runtime do
assets: %{
archive_path: String.t(),
hash: String.t(),
js_path: String.t()
js_path: String.t(),
cdn_url: String.t() | nil
}
}

Expand Down
4 changes: 4 additions & 0 deletions lib/livebook_web/live/js_view_component.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ defmodule LivebookWeb.JSViewComponent do
phx-update="ignore"
data-ref={@js_view.ref}
data-assets-base-path={~p"/public/sessions/#{@session_id}/assets/#{@js_view.assets.hash}/"}
data-assets-cdn-url={cdn_url(@js_view.assets[:cdn_url])}
data-js-path={@js_view.assets.js_path}
data-session-token={session_token(@session_id, @client_id)}
data-connect-token={connect_token(@js_view.pid)}
Expand All @@ -29,6 +30,9 @@ defmodule LivebookWeb.JSViewComponent do
"""
end

defp cdn_url(nil), do: nil
defp cdn_url(url), do: url <> "/"

defp session_token(session_id, client_id) do
Phoenix.Token.sign(LivebookWeb.Endpoint, "session", %{
session_id: session_id,
Expand Down