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.

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

uploading a non-ODD results in blank screen of death #164

Closed
sydb opened this issue Mar 8, 2024 · 5 comments
Closed

uploading a non-ODD results in blank screen of death #164

sydb opened this issue Mar 8, 2024 · 5 comments
Assignees

Comments

@sydb
Copy link
Member

sydb commented Mar 8, 2024

If you

The resulting screen is entirely blank. Looking at source of the blank web page the <html:body> has an empty <html:div id=romajs> and an empty <html:script src=…>.

To be fair, I do not expect that Roma do much with something that does not meet its criteria for a proper ODD file. But it should at least give a “I’m sorry, I cannot deal with this file” error message. I consider this a BUG, thus the “bug” label for this ticket.

below
I do not know what criteria Roma uses to define a proper ODD file. I tried a DocBook document, and not surprisingly it did not work. I tried an ODD which had nothing but a <schemaSpec>, and that did not work, either. It would be nice if Roma further differentiated why an uploaded file is not usable. Something like:

  • Not an XML file — when ill-formed
  • Not a TEI document — when outermost element is not in TEI namespace
  • Missing required XXXX — when <title> (or anything else required) is missing from <teiHeader> (or, indeed, whole <teiHeader> is missing, of course)
  • Not a TEI ODD customization — when <schemaSpec> is missing
  • Invalid TEI ODD customization — when invalid against, say, tei_odds.

I consider this a good idea, but much less important, thus an enhancement; hence the “enhancement” label, too.

@raffazizzi
Copy link
Contributor

@sydb can you tell me more about the browser and environment you're using? When trying to reproduce this, I get the expected behavior of a modal letting you know you're doing something unexpected:

image

@raffazizzi raffazizzi self-assigned this Mar 19, 2024
@raffazizzi raffazizzi added awaiting response I answered or addressed the issue and requested feedback and removed bug labels Mar 19, 2024
@raffazizzi
Copy link
Contributor

Nevermind: I could reproduce this on roma.tei-c.org, but it's puzzling. The error pop up works correctly both locally on a Netlify dev instance. Could it be something with how Roma is bootstrapped on tei-c.org? Or maybe this would simply be fixed by making a new release?

@raffazizzi raffazizzi added bug and removed awaiting response I answered or addressed the issue and requested feedback labels Mar 19, 2024
@peterstadler
Copy link
Member

There were no automated pipelines in place to build the Docker images at https://hub.docker.com/r/teic/romajs.
Both dev and latest were more than a year old.

I just added a GitHub action ("Docker") to build and push the Docker images for every git push. It already built successfully and the dev image is updated now. This updated dev image is deployed at https://roma.tei-c.de/ (at Paderborn University) and shows the expected behavior in catching the error and displaying the modal.

The deployment at https://roma.tei-c.org/ (at Huma-Num) is running from the old latest image. How should we proceed there? Options I see

  1. do a manual update of teic/romajs:latest from current master branch
  2. do an empty commit to the master branch. This will trigger the GitHub pipeline and automatically update the Docker image teic/romajs:latest
  3. do a point(?) release by merging current dev into master branch. This will also trigger the GitHub pipeline and automatically update the Docker image teic/romajs:latest

The deployment at Huma-Num needs to be updated manually afterwards in any case.

@peterstadler
Copy link
Member

My preference would be option 3 but I think this for @raffazizzi to decide

@raffazizzi
Copy link
Contributor

I'll proceed with 3. since there are a few other useful minor changes that can be released.

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

No branches or pull requests

3 participants