Path to uv.html can now be set with options.embedTemplate #1254

crhallberg · 2024-12-12T22:47:16Z

By moving /uv.html to the template, I was able to split the appUri and the hash parameters. You can now pass in a custom iframe template to set the path to uv.html.

I also utilized URLSearchParams to make the hash parameters easier to understand and update.

Config uvAppPath (default to uv.html).
Switch to just uv.html.
Allow switching of hostname.

For example, in VuFind:

{
  "modules": {
    "shareDialogue": {
      "options": {
        "embedTemplate": "<iframe src=\"{0}/themes/vudiglib/assets/uv-4.1.0-rc1/uv.html#?{1}\" width=\"{2}\" height=\"{3}\" allowfullscreen frameborder=\"0\" title=\"{4}\"></iframe>"
      }
    }
  }
}

Admittedly, this is also possible with a RewriteRule.

RewriteRule ^/uv.html /themes/vudiglib/assets/uv-4.1.0-rc1/uv.html [R=301,L]

…ing when uv.html isn't in webroot.

vercel · 2024-12-12T22:47:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
universalviewer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 27, 2025 4:48pm

demiankatz

Thanks, @crhallberg, this is full of good ideas, but I have some suggested refinements... :-)

src/uv-iiif-config.json

demiankatz · 2024-12-13T14:16:21Z

src/content-handlers/iiif/modules/uv-shared-module/BaseExtension.ts

-
-    return appUri + "/uv.html";
+    const port = window.location.port ? `:${window.location.port}` : "";
+    return `${window.location.protocol}//${window.location.hostname}${port}`;


Rather than moving /uv.html from here into the embed template, would it be better to create a new config setting like uvAppPath that defaults to /uv.html? Then we wouldn't have to change the embed templates as much, and other code looking for the full path to uv.html would also work correctly.

I wonder if it would make sense to split this PR in two: one to do the hash parameter simplification, since I think that is a useful improvement to readability, and one to add the new config setting. Another advantage to this approach: we wouldn't have to change the number of placeholders in the embed template, which would better maintain backward compatibility.

That's a good idea. I think that getAppUri should not include /uv.html but if I'm misunderstanding the usage...

I think it's okay for getAppUri to include /uv.html -- that is part of the URL of the UV application itself. I could imagine it being useful to get the URL of the path to the application without the filename, but I think that would be a separate method that doesn't exist yet (presumably because it hasn't been needed yet). I'd be inclined to keep method names and behaviors as they are, and refactor in future if a need arises.

Alright. I switched it back. I would like to hear other opinions about this if anyone feels strongly bc I think it makes the template string harder to read and understand.

Thanks! I've marked this for steering group review so we can discuss it on a future meeting.

My view here is that getAppUri should return a full working URL to the running UV app -- and that includes the uv.html part. If we only want the path part without the actual filename on the end, I would think that would require a different method like getAppPath.

I see the distinction for sure. Having both could be the solution. Although I’d be inclined to use getAppPath for the readability in the template - which would leave getAppUri unused.

But if somebody customizes their UV to use a filename other than uv.html, we would need a way to override that.

That's what the customization of the template solves.

Didn't seem appropriate to bring it up during steering committee. Summoning @edsilv for his thoughts!

I see what you're saying. We have a to-do checkbox up above to make the actual application path a configurable option. I think it would be nice to have more granular configuration so we could configure just the piece that needs to be tweaked instead of having to copy, paste and modify the whole template (which could get out of sync over time if other things change)... but I see how either approach could be potentially workable, and the two might complement each other.

Co-authored-by: Demian Katz <[email protected]>

mialondon · 2025-02-26T13:18:59Z

Documenting my comments in the stand-up, I'd lean towards the simpler solution of configuring the path (and host) and leaving the potential complexity of modifying other options for a later task, perhaps with more input from orgs where embed has been used a lot.

LlGC-jop · 2025-02-26T14:56:11Z

I see what you're saying. We have a to-do checkbox up above to make the actual application path a configurable option. I think it would be nice to have more granular configuration so we could configure just the piece that needs to be tweaked instead of having to copy, paste and modify the whole template (which could get out of sync over time if other things change)... but I see how either approach could be potentially workable, and the two might complement each other.

Increased granularity sounds good to me, @demiankatz

Having getAppUri() call functions to get the hostname, filename, port etc - either from provided config or defaults - would make implementation much more flexible.

…ralize string-building.

crhallberg · 2025-02-26T18:23:56Z

This has been updated so that you can set embedHost, embedPort, and embedPath (alongside embedTemplate). See the config here.

demiankatz

Thanks, @crhallberg, this is coming along very nicely! See below for a few comments/suggestions.

demiankatz · 2025-02-26T20:38:40Z

src/content-handlers/iiif/BaseConfig.ts

+  /** Hosting settings for embedding */
+  embedHost?: string;
+  embedPort?: number;
+  embedPath: string; // starts with "/"


I think we may need a separate comment on each property to ensure that auto-generated documentation comes out correctly.

demiankatz · 2025-02-26T20:46:23Z

src/content-handlers/iiif/modules/uv-shared-module/BaseExtension.ts

+    const host =
+      options?.embedHost ??
+      `${window.location.protocol}//${window.location.hostname}`;
+    const port = options?.embedPort ?? window.location.port;


Do we need to add logic to leave off default ports like 80 and 443 when they match the protocol, or does this already happen automatically somehow? (I'm guessing more work may be needed, since the demo has a custom-configured port, so you wouldn't see how this behaves in standard HTTP/S by default).

It looks like JS takes care of that for us: https://developer.mozilla.org/en-US/docs/Web/API/Location/protocol.

If the port is the default for the protocol (80 for ws: and http:, 443 for wss: and https:, and 21 for ftp:), this property contains an empty string, "".

Hooray for well-designed magic!

src/content-handlers/iiif/modules/uv-shared-module/BaseExtension.ts

src/uv-iiif-config.json

…g/universalviewer into embed-webroot-template

demiankatz

I think this meets all the requirements now and looks good to me. I'll leave it unmerged for a little longer, though, in case others have feedback.

LanieOkorodudu · 2025-03-03T11:13:17Z

I think this meets all the requirements now and looks good to me. I'll leave it unmerged for a little longer, though, in case others have feedback.

This looks good on my side too. Thanks @crhallberg

crhallberg and others added 2 commits December 12, 2024 17:42

feat(embed): move /uv.html to options.embedTemplate for easier embedd…

8c2e399

…ing when uv.html isn't in webroot.

Commit from GitHub Actions (Lint code)

ea32f49

crhallberg self-assigned this Dec 12, 2024

vercel bot deployed to Preview – universalviewer December 12, 2024 22:48 View deployment

demiankatz requested changes Dec 13, 2024

View reviewed changes

revert: test code

40ac1f1

Co-authored-by: Demian Katz <[email protected]>

vercel bot deployed to Preview – universalviewer December 16, 2024 15:16 View deployment

refactor: add uv.html back to getAppUri.

0e40060

vercel bot deployed to Preview – universalviewer January 14, 2025 19:55 View deployment

demiankatz added the steering group review label Jan 14, 2025

demiankatz self-assigned this Feb 25, 2025

LlGC-jop self-assigned this Feb 25, 2025

demiankatz mentioned this pull request Feb 25, 2025

RELEASE STRATEGY: Feb 2025 Sprint #1302

Closed

Merge remote-tracking branch 'origin/dev' into embed-webroot-template

42b27eb

crhallberg and others added 2 commits February 26, 2025 12:58

feat(embed): add embedHost, embedPath, and embedPort to options. Cent…

69b3335

…ralize string-building.

Commit from GitHub Actions (Lint code)

0605ee0

vercel bot deployed to Preview – universalviewer February 26, 2025 18:00 View deployment

crhallberg and others added 2 commits February 26, 2025 13:25

revert: return embedTemplate to top-level config.

4901712

Commit from GitHub Actions (Update Documentation)

eddefc0

vercel bot deployed to Preview – universalviewer February 26, 2025 18:27 View deployment

demiankatz requested changes Feb 26, 2025

View reviewed changes

crhallberg and others added 2 commits February 27, 2025 11:43

feedback(dk): concat appUri and hashParams, reverting embedTemplates.

039d010

Commit from GitHub Actions (Update Documentation)

044f055

vercel bot deployed to Preview – universalviewer February 27, 2025 16:45 View deployment

crhallberg added 2 commits February 27, 2025 11:47

fix(json): set embedPort to null and fix extra comma.

a75b816

Merge branch 'embed-webroot-template' of https://github.com/crhallber…

59f99df

…g/universalviewer into embed-webroot-template

vercel bot deployed to Preview – universalviewer February 27, 2025 16:48 View deployment

demiankatz approved these changes Feb 27, 2025

View reviewed changes

LlGC-szw merged commit fde8d7d into UniversalViewer:dev Mar 3, 2025
5 checks passed

crhallberg deleted the embed-webroot-template branch March 3, 2025 13:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Path to uv.html can now be set with options.embedTemplate #1254

Path to uv.html can now be set with options.embedTemplate #1254

crhallberg commented Dec 12, 2024 •

edited by demiankatz

Loading

vercel bot commented Dec 12, 2024 •

edited

Loading

demiankatz left a comment

demiankatz Dec 13, 2024

crhallberg Dec 16, 2024

demiankatz Dec 16, 2024 •

edited

Loading

crhallberg Jan 14, 2025

demiankatz Jan 14, 2025

crhallberg Jan 14, 2025

demiankatz Jan 14, 2025

crhallberg Jan 15, 2025

crhallberg Jan 15, 2025

demiankatz Jan 15, 2025

mialondon commented Feb 26, 2025

LlGC-jop commented Feb 26, 2025

crhallberg commented Feb 26, 2025 •

edited

Loading

demiankatz left a comment

demiankatz Feb 26, 2025

demiankatz Feb 26, 2025

crhallberg Feb 27, 2025

demiankatz Feb 27, 2025

demiankatz left a comment

LanieOkorodudu commented Mar 3, 2025

Path to uv.html can now be set with options.embedTemplate #1254

Path to uv.html can now be set with options.embedTemplate #1254

Conversation

crhallberg commented Dec 12, 2024 • edited by demiankatz Loading

vercel bot commented Dec 12, 2024 • edited Loading

demiankatz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

demiankatz Dec 16, 2024 • edited Loading

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

Choose a reason for hiding this comment

mialondon commented Feb 26, 2025

LlGC-jop commented Feb 26, 2025

crhallberg commented Feb 26, 2025 • edited Loading

demiankatz 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

demiankatz left a comment

Choose a reason for hiding this comment

LanieOkorodudu commented Mar 3, 2025

crhallberg commented Dec 12, 2024 •

edited by demiankatz

Loading

vercel bot commented Dec 12, 2024 •

edited

Loading

demiankatz Dec 16, 2024 •

edited

Loading

crhallberg commented Feb 26, 2025 •

edited

Loading