Document viewer

[blakerosenthal]

• Add API endpoints for document content
• Add source content viewer to UI

Closes #466

[pmeier]

Our documents have a .read() method that should be used here:

ragna/ragna/core/_document.py

Lines 75 to 77 in 2066dcd

	@abc.abstractmethod
	def read(self) -> bytes: ...

It is not async for now, but there is no need to require documents to be on the local file system. We just need the conversion to the Document object

ragna/ragna/deploy/_api/schemas.py

Lines 29 to 37 in 2066dcd

	def to_core(self) -> ragna.core.Document:
	return ragna.core.LocalDocument(
	id=self.id,
	name=self.name,
	# TEMP: setting an empty metadata dict for now.
	# Will be resolved as part of the "managed ragna" work:
	# https://github.com/Quansight/ragna/issues/256
	metadata={},
	)

Maybe this is also a good time to resolve this TODO first?

[blakerosenthal]

@pmeier I have two outstanding questions before being ready for a full review:

1. Are we only supporting PDFs right now, or do we want to include all supported types? It doesn't seem too difficult to just send any blob to the browser and let the browser decide whether to display it or offer it as a download.
2. I'm currently just calling the Document.read() method and sending the entire blob to the browser wrapped in a fastapi.Response. I'd be interested in your thoughts on how this should be chunked and streamed properly.

Here's a video of how it looks so far.

Screencast.from.2024-08-26.11-33-04.mp4

[pmeier]

1. Are we only supporting PDFs right now, or do we want to include all supported types? It doesn't seem too difficult to just send any blob to the browser and let the browser decide whether to display it or offer it as a download.

Does the browser handle this automatically? Meaning, we just pass it a blob and the browser figures out whether it can show it (.pdf, .md, .txt) or offer it as download (.pptx, .docx)? If yes, that would be awesome and we should really have this feature for everything.

2. I'm currently just calling the Document.read() method and sending the entire blob to the browser wrapped in a fastapi.Response. I'd be interested in your thoughts on how this should be chunked and streamed properly.

FastAPI has a FileResponse that handles this properly. Downside is that this requires a file on disk to work. Short-term I'd be ok to just read the data and write it to a temporary file that we remove in a background task after the response has gone out. Long-term we need to build our own response type that does the same, but starts from bytes or an iterable thereof.

Here's a video of how it looks so far.

Looks good. #466 also states that

Ideally the new pane would scroll to and highlight the exact source content in the file.

Is that possible / planned?

[blakerosenthal]

Does the browser handle this automatically? Meaning, we just pass it a blob and the browser figures out whether it can show it (.pdf, .md, .txt) or offer it as download (.pptx, .docx)? If yes, that would be awesome and we should really have this feature for everything.

I thiiink so as long as the right mimetype is specified in the response header. I will confirm and let you know what I find out.

FastAPI has a FileResponse that handles this properly. Downside is that this requires a file on disk to work. Short-term I'd be ok to just read the data and write it to a temporary file that we remove in a background task after the response has gone out. Long-term we need to build our own response type that does the same, but starts from bytes or an iterable thereof.

Okay, I'd be interested in seeing the level of effort on building our own. It seems like FileResponse is mostly just a wrapper around StreamingResponse that sets the right headers.

Ideally the new pane would scroll to and highlight the exact source content in the file.

Is that possible / planned?

I need to think a bit more about how this could work. Might be best suited for a followup PR.

[blakerosenthal]

@pmeier This is ready for another look! This is was the source viewer looks like now after putting the accordion widget back and adding a new button. And I added some MIME types to our supported documents so the browser knows what to do with them when it receives the blob. On my browser PDFs open in a new tab, text is displayed as HTML, and Word and Powerpoints are downloaded. For sources with page numbers there's also now an anchor that scrolls the view to the right page for in-browser sources.

[pmeier]

This looks great, thanks Blake! One question though: in case the browser downloads the file, I get something like "{uuid.UUID}.docx". Why isn't this the proper file name?

[blakerosenthal]

This looks great, thanks Blake! One question though: in case the browser downloads the file, I get something like "{uuid.UUID}.docx". Why isn't this the proper file name?

That's a typo, thanks for catching!

[pmeier]

As discussed offline, let's use mimetypes from the standard library.

[pmeier]

We need to store this in the DB as well. Otherwise any MIME type set by the user will be overridden as soon as we pull it from the DB, because the default would be used.