From 315414de1b4f88aaf27471e433e46be8c2d8f09e Mon Sep 17 00:00:00 2001
From: Jakob Ackermann <jakob.ackermann@overleaf.com>
Date: Thu, 28 Jul 2022 15:39:17 +0100
Subject: [PATCH] Merge pull request #9011 from
 overleaf/jpa-better-render-error-message

[web] provide helpful error message when pdf rendering fails

GitOrigin-RevId: abbe6f362fa362fadee197527463ee675760e581
---
 .../pdf-preview/components/pdf-preview-error.js        |  8 ++++++++
 .../components/pdf-preview/pdf-preview.spec.tsx        | 10 ++++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/services/web/frontend/js/features/pdf-preview/components/pdf-preview-error.js b/services/web/frontend/js/features/pdf-preview/components/pdf-preview-error.js
index 3ddd04b789..2b4868acb1 100644
--- a/services/web/frontend/js/features/pdf-preview/components/pdf-preview-error.js
+++ b/services/web/frontend/js/features/pdf-preview/components/pdf-preview-error.js
@@ -16,6 +16,14 @@ function PdfPreviewError({ error }) {
       return (
         <ErrorLogEntry title={t('pdf_rendering_error')}>
           {t('something_went_wrong_rendering_pdf')}
+          &nbsp;
+          <Trans
+            i18nKey="try_recompile_project_or_troubleshoot"
+            components={[
+              // eslint-disable-next-line react/jsx-key, jsx-a11y/anchor-has-content
+              <a href="/learn/how-to/Resolving_access%2C_loading%2C_and_display_problems" />,
+            ]}
+          />
         </ErrorLogEntry>
       )
 
diff --git a/services/web/test/frontend/components/pdf-preview/pdf-preview.spec.tsx b/services/web/test/frontend/components/pdf-preview/pdf-preview.spec.tsx
index 8c670ef331..2dc517c3ae 100644
--- a/services/web/test/frontend/components/pdf-preview/pdf-preview.spec.tsx
+++ b/services/web/test/frontend/components/pdf-preview/pdf-preview.spec.tsx
@@ -557,7 +557,10 @@ describe('<PdfPreview/>', function () {
 
       cy.wait('@compile-pdf-error')
 
-      cy.findByText('Something went wrong while rendering this PDF.')
+      cy.contains('Something went wrong while rendering this PDF.')
+      cy.contains(
+        'Please try recompiling the project from scratch, and if that doesn’t help, follow our troubleshooting guide.'
+      )
       cy.findByLabelText('Page 1').should('not.exist')
     })
 
@@ -578,7 +581,10 @@ describe('<PdfPreview/>', function () {
 
       cy.wait('@compile-pdf-corrupt')
 
-      cy.findByText('Something went wrong while rendering this PDF.')
+      cy.contains('Something went wrong while rendering this PDF.')
+      cy.contains(
+        'Please try recompiling the project from scratch, and if that doesn’t help, follow our troubleshooting guide.'
+      )
       cy.findByLabelText('Page 1').should('not.exist')
     })
   })