RHOAIENG-16568: [Bug] Unable to download notebook as a PDF from JupyterLab Workbenches #1030

jesuino · 2025-05-02T17:58:45Z

This is a fix for issue #210

Description

It install TexLive following instructions from TexLive Quick Installation guide. It uses the minimal scheme and other important dependencies are added.

The full installation increased the image size by a few GB. Additionally, the full installation adds more vulnerabilities to the published image. So starting from a minimal installation is a must. To compare images with different installation methods, check the ones I have published in my quay.io, the oldest one is the full TexLive installation

Notice also that the packages required for adding the required dependencies are not available in UBI9 base image, hence why we had to manually install this.

Finally we also disable other option that does not work.

How Has This Been Tested?

Manually tested by creating and importing some notebooks and then exporting it to PDF.

To test:

Build locally or pull my image with this PR changes:

podman pull quay.io/wsiqueir/workbench-images:jupyter-minimal-ubi9-python-3.11-pdf_and_disabled_formats_20250502

Run the image:

podman run -it -p 8888:8888  quay.io/wsiqueir/workbench-images:jupyter-minimal-ubi9-python-3.11-pdf_and_disabled_formats_20250502

Go to the JupyterLab URL, create a notebook and try to export it using the option Save and Export Notebook As.
You should be able to export the notebook as PDF with no issue.

Merge criteria:

The commits are squashed in a cohesive manner and have meaningful messages.
Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
The developer has manually tested the changes and verified that the changes work

…erLab Workbenches

jupyter/utils/jupyter_server_config.py

jupyter/minimal/ubi9-python-3.11/Dockerfile.cpu

atheo89 · 2025-05-05T08:37:30Z

Thanks, William, for the fix! The implementation looks good to me. I ran the minimal image generated from this PR locally, and I was able to successfully generate the PDF 🥳.Aside from Jiri’s comments, I noticed a few extra blank white lines that I’d like to remove. Also, it seems the TexLive library increases the size of the minimal by approximately 700 MB.

/lgtm

jiridanek · 2025-05-06T09:27:22Z

jupyter/minimal/ubi9-python-3.11/start-notebook.sh

@@ -8,6 +8,9 @@ if [ -f "${SCRIPT_DIR}/utils/setup-elyra.sh" ]; then
  source ${SCRIPT_DIR}/utils/setup-elyra.sh
 fi

+export PATH=/usr/local/texlive/2025/bin/x86_64-linux:$PATH


Any suggestion on where to set the path? I am currently doing it in start-notebook.sh

Could be set in Dockerfile itself, but it appears we don't do it anywhere else this way.

Alternatively, leave this and let the test set its PATH anew, like in

notebooks/tests/containers/workbenches/rstudio/rstudio_test.py

Line 96 in 6cd9ddb

f"bash -c 'RSTUDIO_PANDOC=/usr/lib/rstudio-server/bin/quarto/bin/tools/x86_64 Rscript {self.APP_ROOT_HOME}/script.R'",

jesuino · 2025-05-06T18:11:57Z

Hello @jiridanek I added a test and changed the path configuration to the Dockerfile - please let me know if I am missing something. Thanks!

logs/pytest-logs.txt

jupyter/minimal/ubi9-python-3.11/Dockerfile.rocm

tests/containers/workbenches/jupyterlab/jupyterlab_test.py

harshad16

/lgtm

Excellent work
tested with following:

Repo clone and exported as pdf: https://github.com/harshad16/data-science-pipeline-example/tree/master/run-pipelines-on-data-science-pipelines
works as expected 🎉

separate question:
@jesuino , can you share for knowledge share, if version of pandoc 3.6.4 was consider for some special reason instead of the 3.7 ? so that , these reason can be consider for next upgrades.

jesuino · 2025-06-02T19:17:55Z

@harshad16 thanks for testing it!

can you share for knowledge share, if version of pandoc 3.6.4 was consider for some special reason instead of the 3.7 ? so that , these reason can be consider for next upgrades.

No special reason. I tested with latest pandoc and it works, so I updated the version

jesuino · 2025-06-02T19:19:00Z

@jiridanek thanks for letting me know about this config. I did add an entry for pandoc, but I don't know if I had to add some specific name, so I used rpm.pandoc.ignore

jiridanek · 2025-06-02T19:22:20Z

I don't know if I had to add some specific name, so I used rpm.pandoc.ignore

🤞🏽

I never know this either. I normally just try this again and again until I figure out something that works. If you look what the gha runs, it should not be hard to reproduce on your own laptop, to iterate faster. (We do have open ticket to document, #1086)

jiridanek · 2025-06-02T19:50:09Z

Did not work. I can check tomorrow morning and try figuring something out, so that you don't waste time on this. Imo what you'd have to do add it to the plain [[ignore]] block, because the reported error does not mention any rpm or nothing

[[ignore]]
error = "ErrNotDynLinked"
files = [
    # executable is not dynamically linked
    "/opt/app-root/bin/py-spy",
    "/usr/local/pandoc/bin/pandoc",
]

edit: that ^^^ worked for me in https://github.com/jiridanek/notebooks/actions/runs/15404297288, trying to push the commit here

jesuino · 2025-06-03T13:23:03Z

Hello @jiridanek thanks again for ignoring that warning. I see that only image cuda-jupyter-tensorflow-ubi9-python-3.11 is failing the test. I am checking what could be wrong and I will update this PR soon.

jesuino · 2025-06-03T14:27:56Z

I could not reproduce this failing test locally. Could this be a flaky test?

To run locally first I build the image:

make cuda-jupyter-tensorflow-ubi9-python-3.11 -e  IMAGE_REGISTRY=quay.io/wsiqueir/workbench-images  -e  RELEASE=test_installer_path_with_pandoc

Then I run the test:

uv run pytest tests/containers/workbenches/jupyterlab/jupyterlab_test.py -k test_pdf_export -m 'not openshift' --image quay.io/wsiqueir/workbench-images:jupyter-datascience-ubi9-python-3.11-test_installer_path_with_pandoc_20250528

jiridanek · 2025-06-03T14:34:12Z

@jesuino no, it's a flaky image build! If you check build logs, you see

[4/6] STEP 8/12: RUN ./utils/install_pdf_deps.sh
Installing TexLive to allow PDf export from Notebooks
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100   284  100   284    0     0    393      0 --:--:-- --:--:-- --:--:--   393

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
  0     0    0     0    0     0      0      0 --:--:--  0:00:01 --:--:--     0

[ ... snip ... ]

  0     0    0     0    0     0      0      0 --:--:--  0:02:16 --:--:--     0
  0     0    0     0    0     0      0      0 --:--:--  0:02:16 --:--:--     0
curl: (28) Failed to connect to ctan.math.illinois.edu port [443](https://github.com/opendatahub-io/notebooks/actions/runs/15411712114/job/43365000822?pr=1030#step:24:444): Connection timed out
./utils/install_pdf_deps.sh: line 8: install-tl-unx.tar.gz: No such file or directory
tar: This does not look like a tar archive
tar: Exiting with failure status due to previous errors
./utils/install_pdf_deps.sh: line 9: cd: install-tl-2*: No such file or directory
Can't open perl script "./install-tl": No such file or directory
./utils/install_pdf_deps.sh: line 11: cd: /usr/local/texlive/bin/x86_64-linux: No such file or directory
./utils/install_pdf_deps.sh: line 12: ./tlmgr: No such file or directory
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0

100 32.1M  100 32.1M    0     0   130M      0 --:--:-- --:--:-- --:--:--  130M
pandoc-3.7.0.2/share/
pandoc-3.7.0.2/share/man/
pandoc-3.7.0.2/share/man/man1/
pandoc-3.7.0.2/share/man/man1/pandoc.1.gz
pandoc-3.7.0.2/share/man/man1/pandoc-server.1.gz
pandoc-3.7.0.2/share/man/man1/pandoc-lua.1.gz
pandoc-3.7.0.2/bin/
pandoc-3.7.0.2/bin/pandoc
pandoc-3.7.0.2/bin/pandoc-server
pandoc-3.7.0.2/bin/pandoc-lua
--> dadc6631aca6

And this RUN ./utils/install_pdf_deps.sh step exited with ecode 0 without actually installing xelatex.

jesuino · 2025-06-03T14:38:11Z

thank you @jiridanek I expected the build to fail in such cases (fail fast), hence why I didn't check the logs, saw the failed test and thought it was the culprit!

harshad16

Thanks for the upgrade to latest version
work as expected

Tested on:
podman run -p 8888:8888 quay.io/opendatahub/workbench-images:jupyter-datascience-ubi9-python-3.11-pr-1030

The export of PDF works as expected.

(app-root) pandoc --version
pandoc 3.7.0.2
Features: +server +lua
Scripting engine: Lua 5.4
User data directory: /opt/app-root/src/.local/share/pandoc
Copyright (C) 2006-2024 John MacFarlane. Web: https://pandoc.org
This is free software; see the source for copying conditions. There is no

/lgtm
/approve

openshift-ci · 2025-06-04T05:09:51Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: harshad16

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [harshad16]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

RHOAIENG-16568: [Bug] Unable to download notebook as a PDF from Jupyt…

7f7edbb

…erLab Workbenches

openshift-ci bot added the size/s label May 2, 2025

openshift-ci bot requested review from caponetto and dibryant May 2, 2025 17:59

jiridanek reviewed May 3, 2025

View reviewed changes

jupyter/utils/jupyter_server_config.py Show resolved Hide resolved

jiridanek reviewed May 3, 2025

View reviewed changes

jupyter/minimal/ubi9-python-3.11/Dockerfile.cpu Outdated Show resolved Hide resolved

jiridanek reviewed May 3, 2025

View reviewed changes

jupyter/minimal/ubi9-python-3.11/Dockerfile.cpu Show resolved Hide resolved

jiridanek reviewed May 3, 2025

View reviewed changes

jupyter/minimal/ubi9-python-3.11/Dockerfile.cpu Outdated Show resolved Hide resolved

openshift-ci bot assigned atheo89 May 5, 2025

openshift-ci bot added the lgtm label May 5, 2025

Running installation from a script

dea7051

openshift-ci bot added size/m and removed lgtm size/s labels May 5, 2025

jiridanek reviewed May 6, 2025

View reviewed changes

Adding test and fixing path

a94c7af

openshift-ci bot added size/m and removed size/m labels May 6, 2025

Fixing Script file name

8c8a58d

openshift-ci bot added size/m and removed size/m labels May 6, 2025

Using minimal tmp file instead a fixed file

7937ac9

openshift-ci bot added size/l and removed size/m labels May 6, 2025

jiridanek reviewed May 6, 2025

View reviewed changes

logs/pytest-logs.txt Outdated Show resolved Hide resolved

jiridanek reviewed May 6, 2025

View reviewed changes

jupyter/minimal/ubi9-python-3.11/Dockerfile.rocm Outdated Show resolved Hide resolved

jiridanek reviewed May 6, 2025

View reviewed changes

tests/containers/workbenches/jupyterlab/jupyterlab_test.py Outdated Show resolved Hide resolved

Removing and ignoring logs

2849a5e

jiridanek requested review from jiridanek and harshad16 May 30, 2025 15:51

harshad16 reviewed Jun 2, 2025

View reviewed changes

openshift-ci bot added the lgtm label Jun 2, 2025

pandoc latest version and ignoring message

2c9a199

openshift-ci bot added size/l and removed lgtm size/l labels Jun 2, 2025

formatting fix

8521ff3

openshift-ci bot added size/l and removed size/l labels Jun 2, 2025

jiridanek requested a review from harshad16 June 2, 2025 19:23

add "/usr/local/pandoc/bin/pandoc" to config.toml

6ab959b

openshift-ci bot added size/l and removed size/l labels Jun 3, 2025

jiridanek mentioned this pull request Jun 3, 2025

Developers have low trust in our tests opendatahub-io/kubeflow#618

Open

jiridanek mentioned this pull request Jun 3, 2025

RUN ./utils/install_pdf_deps.sh step exited with ecode 0 without actually installing xelatex #1147

Open

harshad16 approved these changes Jun 4, 2025

View reviewed changes

openshift-ci bot added the lgtm label Jun 4, 2025

openshift-ci bot added the approved label Jun 4, 2025

openshift-merge-bot bot merged commit 858b1b8 into opendatahub-io:main Jun 4, 2025
52 of 53 checks passed

RHOAIENG-16568: [Bug] Unable to download notebook as a PDF from JupyterLab Workbenches #1030

RHOAIENG-16568: [Bug] Unable to download notebook as a PDF from JupyterLab Workbenches #1030

Uh oh!

Conversation

jesuino commented May 2, 2025

Description

How Has This Been Tested?

Merge criteria:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

atheo89 commented May 5, 2025

Uh oh!

jiridanek May 6, 2025

Choose a reason for hiding this comment

Uh oh!

jesuino commented May 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

harshad16 left a comment

Choose a reason for hiding this comment

Uh oh!

jesuino commented Jun 2, 2025

Uh oh!

jesuino commented Jun 2, 2025

Uh oh!

jiridanek commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jiridanek commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jesuino commented Jun 3, 2025

Uh oh!

jesuino commented Jun 3, 2025

Uh oh!

jiridanek commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jesuino commented Jun 3, 2025

Uh oh!

harshad16 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jun 4, 2025

Uh oh!

Uh oh!

Uh oh!

jiridanek commented Jun 2, 2025 •

edited

Loading

jiridanek commented Jun 2, 2025 •

edited

Loading

jiridanek commented Jun 3, 2025 •

edited

Loading

harshad16 left a comment •

edited

Loading