Merge pull request github#22103 from github/repo-sync

repo sync

Author: Octomerger

lib/get-data.js

@@ -101,6 +101,23 @@ export const getDataByLanguage = memoize((dottedPath, langCode) => {
     }
     return value
   } catch (error) {
+    if (error instanceof Error && error.mark && error.message) {
+      // It's a yaml.load() generated error!
+      // Remember, the file that we read might have been a .yml or a .md
+      // file. If it was a .md file, with corrupt front-matter that too
+      // would have caused a YAMLException
+      if (langCode !== 'en') {
+        if (DEBUG_JIT_DATA_READS) {
+          console.warn(`Unable to parse Yaml in (${langCode}) '${dottedPath}': ${error.message}`)
+        }
+        // Give it one more chance, but use English this time
+        return getDataByDir(dottedPath, languages.en.dir)
+      }
+      // Always throw English Yaml reading errors. Staff writers
+      // need to know early and explicitly that they are corrupt.
+      throw error
+    }
+
     if (error.code === 'ENOENT') return undefined
     throw error
   }

tests/unit/get-data.js

@@ -13,7 +13,7 @@ describe('get-data', () => {
   const jaDirBefore = languages.ja.dir
 
   beforeAll(() => {
-    const dd = new DataDirectory({
+    dd = new DataDirectory({
       data: {
         ui: {
           key: 'Value',
@@ -63,7 +63,7 @@ describe('get-data', () => {
   })
 
   afterAll(() => {
-    if (dd) dd.destroy()
+    dd.destroy()
     languages.en.dir = enDirBefore
     languages.ja.dir = jaDirBefore
   })
@@ -192,3 +192,103 @@ describe('get-data', () => {
     }
   })
 })
+
+const VALID_ENGLISH_MARKDOWN = `
+---
+front: matter
+---
+*English* /Markdown/
+`.trim()
+
+const VALID_JAPANESE_MARKDOWN = `
+---
+front:matter
+---
+*Japanese* /Markdown/
+`.trim()
+
+const INVALID_JAPANESE_MARKDOWN = `
+---
+front: >'matter
+---
+*Japanese* /Markdown/
+`.trim()
+
+describe('get-data on corrupt translations', () => {
+  let dd
+  const enDirBefore = languages.en.dir
+  const jaDirBefore = languages.ja.dir
+
+  beforeAll(() => {
+    dd = new DataDirectory({
+      data: {
+        variables: {
+          everything: {
+            is: 'Awesome',
+          },
+        },
+        reusables: {
+          cool: VALID_ENGLISH_MARKDOWN,
+        },
+      },
+    })
+    languages.en.dir = dd.root
+
+    const jaTranslationsRoot = path.join(dd.root, 'translations', 'ja-JP')
+    fs.mkdirSync(jaTranslationsRoot, { recursive: true })
+    languages.ja.dir = jaTranslationsRoot
+    new DataDirectory( // eslint-disable-line no-new
+      {
+        data: {
+          variables: {
+            everything: {
+              is: 'just you wait',
+            },
+          },
+          reusables: {
+            cool: VALID_JAPANESE_MARKDOWN,
+          },
+        },
+      },
+      jaTranslationsRoot
+    )
+    const ymlFile = path.join(jaTranslationsRoot, 'data', 'variables', 'everything.yml')
+    console.assert(fs.existsSync(ymlFile), `${ymlFile} wasn't created`)
+    fs.writeFileSync(ymlFile, `>:This is not valid Yaml:>`, 'utf-8')
+    const mdFile = path.join(jaTranslationsRoot, 'data', 'reusables', 'cool.md')
+    console.assert(fs.existsSync(mdFile), `${mdFile} wasn't created`)
+    fs.writeFileSync(mdFile, INVALID_JAPANESE_MARKDOWN, 'utf-8')
+  })
+
+  afterAll(() => {
+    dd.destroy()
+    languages.en.dir = enDirBefore
+    languages.ja.dir = jaDirBefore
+  })
+
+  test('getDataByLanguage on a corrupt .yml file', () => {
+    // First make sure it works in English
+    {
+      const result = getDataByLanguage('variables.everything.is', 'en')
+      expect(result).toBe('Awesome')
+    }
+    // Japanese translations would fall back due to a corrupt Yaml file
+    {
+      const result = getDataByLanguage('variables.everything.is', 'ja')
+      expect(result).toBe('Awesome')
+    }
+  })
+
+  test('getDataByLanguage on a corrupt .md file', () => {
+    // First make sure it works in English
+    {
+      const result = getDataByLanguage('reusables.cool', 'en')
+      expect(result).toBe('*English* /Markdown/')
+    }
+    // Japanese translations would fall back due to a corrupt Yaml file
+    {
+      const result = getDataByLanguage('reusables.cool', 'ja')
+      expect(result).toBe('*English* /Markdown/')
+    }
+  })
+})