Skip to content

Expose OpenSeadragon tile timeout option#1514

Merged
demiankatz merged 2 commits into
UniversalViewer:devfrom
tind:sky/timeout-upstream
Jul 29, 2025
Merged

Expose OpenSeadragon tile timeout option#1514
demiankatz merged 2 commits into
UniversalViewer:devfrom
tind:sky/timeout-upstream

Conversation

@skairunner

Copy link
Copy Markdown
Contributor

Description of what you did:

Resolve UniversalViewer/user-stories#70 by exposing the OpenSeadragon configuration to set the maximum time a tile operation can take.

@vercel

vercel Bot commented Jul 28, 2025

Copy link
Copy Markdown

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 Jul 29, 2025 3:02pm

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @skairunner, this makes sense to me.

One small request: we've added a configuration manual to the project. Can you also add documentation for this new setting to that file in the appropriate place? (I'm also happy to help if you need me to, but hopefully this isn't too difficult :-) ).

@skairunner

skairunner commented Jul 28, 2025

Copy link
Copy Markdown
Contributor Author

No problem @demiankatz , I've pushed a new commit that updates the config.md. Hope it checks out!

Edit: My IDE inserted a space after every header as part of linting, it seems. I hope that's not a problem.

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @skairunner, this seems to work as expected for me -- if I set a very short tileTimeout, I get timeout errors; otherwise things work as normal.

Regarding the linting of the Markdown, it might be better to paste the new config setting:

##### tileTimeout
**Type**: `number`
**Default**: `30_000`
Controls the maximum amount of time in milliseconds OpenSeadragon allows for any tile operation.

into the existing documentation without all the other lint changes; otherwise, the history is harder to read here.

I'm definitely open to having better linting on Markdown files, but I think it would be better to handle that in a separate PR (and preferably with some automated tool to help with ongoing enforcement/consistency) rather than making lots of unrelated changes here.

(I tried to save you time by directly editing the file myself, but unfortunately I don't seem to have write access to update this PR).

@skairunner

skairunner commented Jul 28, 2025 via email

Copy link
Copy Markdown
Contributor Author

Also update default config

docs
@skairunner skairunner force-pushed the sky/timeout-upstream branch from 7e0088e to 67c2088 Compare July 29, 2025 07:03
@skairunner

Copy link
Copy Markdown
Contributor Author

@demiankatz Should be good to go!

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@skairunner, just one more request: can you move the documentation for the new setting up a few lines so it falls between subtitleEnabled and titleEnabled? We're trying to keep these in alphabetical order. Apologies for the nuisance!

(Note: it looks like one existing setting -- requiredStatementEnabled -- is also out of order; if you want to move that down a couple of spots while you're fixing the new issue, please feel free).

@demiankatz demiankatz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, @skairunner, and apologies for the extra hoops at the end. I appreciate you taking the time to contribute this back to us!

@demiankatz demiankatz merged commit 923fe2a into UniversalViewer:dev Jul 29, 2025
4 of 5 checks passed
@github-project-automation github-project-automation Bot moved this from In testing to Completed in Universal Viewer Community Board Jul 29, 2025
@demiankatz

Copy link
Copy Markdown
Contributor

Note that there was a test failure in the automatic build, but this seems to be related to GitHub Actions running slowly rather than the changes in this PR; it passed on a retry.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Completed

Development

Successfully merging this pull request may close these issues.

Add a way to configure tile fetching timeout

2 participants