From 3b60c2d1fe2911da2134511d61fc467e718cd5b6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Timoth=C3=A9e=20Alby?= <timothee.alby@gmail.com>
Date: Thu, 10 Feb 2022 10:52:17 +0100
Subject: [PATCH] Merge pull request #6679 from
 overleaf/ta-undefined-references-hint

Update Human Readable Hint Regex for Undefined References

GitOrigin-RevId: 326ed206f3321d43580031ec2b46bc3117c6c4e9
---
 .../HumanReadableLogsRules.js                 | 17 +++-
 .../components/pdf-preview.test.js            | 81 +++++++++++++++++++
 2 files changed, 97 insertions(+), 1 deletion(-)

diff --git a/services/web/frontend/js/ide/human-readable-logs/HumanReadableLogsRules.js b/services/web/frontend/js/ide/human-readable-logs/HumanReadableLogsRules.js
index 3f7202e2fc..aaad597b2d 100644
--- a/services/web/frontend/js/ide/human-readable-logs/HumanReadableLogsRules.js
+++ b/services/web/frontend/js/ide/human-readable-logs/HumanReadableLogsRules.js
@@ -93,7 +93,22 @@ const rules = [
       'You need to enclose all mathematical expressions and symbols with special markers. These special markers create a ‘math mode’. Use $...$ for inline math mode, and \\[...\\] or one of the mathematical environments (e.g. equation) for display math mode.  This applies to symbols such as subscripts ( _ ), integrals ( \\int ), Greek letters ( \\alpha, \\beta, \\delta ) and modifiers (\\vec{x}, \\tilde{x} ).',
   },
   {
-    regexToMatch: /(undefined )?[rR]eference(s)?.+(undefined)?/,
+    regexToMatch: /Reference.+undefined/,
+    extraInfoURL:
+      'https://www.overleaf.com/learn/Errors/There_were_undefined_references',
+    humanReadableHintComponent: (
+      <>
+        You have referenced something which has not yet been labelled. If you
+        have labelled it already, make sure that what is written inside \ref
+        {'{...}'} is the same as what is written inside \label
+        {'{...}'}.
+      </>
+    ),
+    humanReadableHint:
+      'You have referenced something which has not yet been labelled. If you have labelled it already, make sure that what is written inside \\ref{...} is the same as what is written inside \\label{...}.',
+  },
+  {
+    regexToMatch: /There were undefined references/,
     extraInfoURL:
       'https://www.overleaf.com/learn/Errors/There_were_undefined_references',
     humanReadableHintComponent: (
diff --git a/services/web/test/frontend/features/pdf-preview/components/pdf-preview.test.js b/services/web/test/frontend/features/pdf-preview/components/pdf-preview.test.js
index 0bd44ce02f..02bf5c31fb 100644
--- a/services/web/test/frontend/features/pdf-preview/components/pdf-preview.test.js
+++ b/services/web/test/frontend/features/pdf-preview/components/pdf-preview.test.js
@@ -504,4 +504,85 @@ describe('<PdfPreview/>', function () {
 
     expect(nock.isDone()).to.be.true
   })
+
+  describe('human readable logs', function () {
+    it('shows human readable hint for undefined reference errors', async function () {
+      mockCompile()
+      mockBuildFile({
+        ...defaultFileResponses,
+        '/build/output.log': `
+log This is pdfTeX, Version 3.14159265-2.6-1.40.21 (TeX Live 2020) (preloaded format=pdflatex 2020.9.10)  8 FEB 2022 16:27
+entering extended mode
+ \\write18 enabled.
+ %&-line parsing enabled.
+**main.tex
+(./main.tex
+LaTeX2e <2020-02-02> patch level 5
+
+LaTeX Warning: Reference \`intorduction' on page 1 undefined on input line 11.
+
+
+LaTeX Warning: Reference \`section1' on page 1 undefined on input line 13.
+
+[1
+
+{/usr/local/texlive/2020/texmf-var/fonts/map/pdftex/updmap/pdftex.map}] (/compi
+le/output.aux)
+
+LaTeX Warning: There were undefined references.
+
+ )
+`,
+      })
+      mockValidPdf()
+
+      screen.debug()
+      renderWithEditorContext(<PdfPreview />, { scope })
+
+      await screen.findByText(
+        "Reference `intorduction' on page 1 undefined on input line 11."
+      )
+      await screen.findByText(
+        "Reference `section1' on page 1 undefined on input line 13."
+      )
+      await screen.findByText('There were undefined references.')
+      const hints = await screen.findAllByText(
+        /You have referenced something which has not yet been labelled/
+      )
+      console.log('hints', hints)
+      expect(hints.length).to.equal(3)
+    })
+
+    it('idoes not show human readable hint for undefined reference errors', async function () {
+      mockCompile()
+      mockBuildFile({
+        ...defaultFileResponses,
+        '/build/output.log': `
+Package rerunfilecheck Info: File \`output.out' has not changed.
+(rerunfilecheck)             Checksum: 339DB29951BB30436898BC39909EA4FA;11265.
+
+Package rerunfilecheck Warning: File \`output.brf' has changed.
+(rerunfilecheck)                Rerun to get bibliographical references right.
+
+Package rerunfilecheck Info: Checksums for \`output.brf':
+(rerunfilecheck)             Before: D41D8CD98F00B204E9800998ECF8427E;0
+(rerunfilecheck)             After:  DF3260FAD3828D54C5E4E9337E97F7AF;4841.
+ )
+`,
+      })
+      mockValidPdf()
+
+      screen.debug()
+      renderWithEditorContext(<PdfPreview />, { scope })
+
+      await screen.findByText(
+        /Package rerunfilecheck Warning: File `output.brf' has changed. Rerun to get bibliographical references right./
+      )
+      expect(
+        screen.queryByText(
+          /You have referenced something which has not yet been labelled/
+        )
+      ).to.not.exist
+    })
+  })
 })