fix: do not hardcode siteConfig path (#1150)

* Fix broken build Do not hardcode path in require to siteConfig * Just require instead of loadConfig * Actually use loadConfig I think the test may be wrong too. * refactor & nits * jest mock to fix test * fix test
facebook · Dec 7, 2018 · c78a8b4 · c78a8b4
1 parent 71824a3
commit c78a8b4
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 11 deletions.
diff --git a/v1/lib/server/__tests__/blog.test.js b/v1/lib/server/__tests__/blog.test.js
@@ -10,6 +10,10 @@ const blog = require('../blog');
 const metadataUtils = require('../metadataUtils');
 const {replaceAssetsLink} = require('../utils.js');
 
+jest.mock(`${process.cwd()}/siteConfig.js`, () => ({baseUrl: '/'}), {
+  virtual: true,
+});
+
 const testFile = path.join(
   __dirname,
   '__fixtures__',
@@ -76,7 +80,7 @@ describe('replaceAssetsLink', () => {
       'utf8',
     );
     const rawContent1 = metadataUtils.extractMetadata(doc1).rawContent;
-    const content1 = replaceAssetsLink(rawContent1, 'blog');
+    const content1 = replaceAssetsLink(rawContent1, '/blog');
     expect(content1).toMatchSnapshot();
     expect(content1).toContain('![image1](/blog/assets/image1.png)');
     expect(content1).toContain('![image2](/blog/assets/image2.jpg)');
@@ -95,7 +99,7 @@ describe('replaceAssetsLink', () => {
       'utf8',
     );
     const rawContent2 = metadataUtils.extractMetadata(doc2).rawContent;
-    const content2 = replaceAssetsLink(rawContent2, 'blog');
+    const content2 = replaceAssetsLink(rawContent2, '/blog');
     expect(content2).toMatchSnapshot();
     expect(content2).not.toContain('![image1](/blog/assets/image1.png)');
     expect(content2).not.toContain('![image2](/blog/assets/image2.jpg)');

diff --git a/v1/lib/server/__tests__/docs.test.js b/v1/lib/server/__tests__/docs.test.js
@@ -10,6 +10,7 @@ const originalCwd = process.cwd();
 if (!/website$/.test(originalCwd)) {
   process.chdir(process.cwd() + '/website');
 }
+
 const path = require('path');
 const fs = require('fs-extra');
 const docs = require('../docs');
@@ -187,7 +188,7 @@ describe('getFile', () => {
 
 describe('replaceAssetsLink', () => {
   test('transform document with valid assets link', () => {
-    const content1 = replaceAssetsLink(rawContent1, 'docs');
+    const content1 = replaceAssetsLink(rawContent1, '/docs');
     expect(content1).toMatchSnapshot();
     expect(content1).toContain('![image1](/docs/assets/image1.png)');
     expect(content1).toContain('![image2](/docs/assets/image2.jpg)');
@@ -201,7 +202,7 @@ describe('replaceAssetsLink', () => {
   });
 
   test('does not transform document without valid assets link', () => {
-    const content2 = replaceAssetsLink(rawContent2, 'docs');
+    const content2 = replaceAssetsLink(rawContent2, '/docs');
     expect(content2).toMatchSnapshot();
     expect(content2).not.toContain('![image1](/docs/assets/image1.png)');
     expect(content2).not.toContain('![image2](/docs/assets/image2.jpg)');

diff --git a/v1/lib/server/blog.js b/v1/lib/server/blog.js
@@ -4,12 +4,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+const CWD = process.cwd();
 const React = require('react');
 const path = require('path');
 const fs = require('fs-extra');
 const metadataUtils = require('./metadataUtils');
 const {replaceAssetsLink} = require('./utils.js');
 const {renderToStaticMarkupWithDoctype} = require('./renderUtils');
+const loadConfig = require('./config');
+
+const siteConfig = loadConfig(`${CWD}/siteConfig.js`);
 
 function urlToSource(url) {
   if (!url || typeof url !== 'string') {
@@ -59,7 +63,10 @@ function getMetadata(file) {
   const metadata = Object.assign(
     {
       path: fileToUrl(file),
-      content: replaceAssetsLink(result.rawContent, 'blog'),
+      content: replaceAssetsLink(
+        result.rawContent,
+        `${siteConfig.baseUrl}blog`,
+      ),
     },
     result.metadata,
   );

diff --git a/v1/lib/server/docs.js b/v1/lib/server/docs.js
@@ -111,7 +111,7 @@ function getMarkup(rawContent, mdToHtml, metadata) {
   content = mdToHtmlify(content, mdToHtml, metadata);
 
   // replace any relative links to static assets (not in fenced code blocks) to absolute links
-  content = replaceAssetsLink(content, 'docs');
+  content = replaceAssetsLink(content, `${siteConfig.baseUrl}docs`);
 
   const DocsLayout = require('../core/DocsLayout.js');
   return renderToStaticMarkupWithDoctype(

diff --git a/v1/lib/server/utils.js b/v1/lib/server/utils.js
@@ -9,7 +9,6 @@ const autoprefixer = require('autoprefixer');
 const postcss = require('postcss');
 const path = require('path');
 const escapeStringRegexp = require('escape-string-regexp');
-const siteConfig = require('../../website/siteConfig.js');
 
 function getSubDir(file, refDir) {
   const subDir = path.dirname(path.relative(refDir, file)).replace(/\\/g, '/');
@@ -74,10 +73,7 @@ function replaceAssetsLink(oldContent, location) {
     }
     return fencedBlock
       ? line
-      : line.replace(
-          /\]\(assets\//g,
-          `](${siteConfig.baseUrl}${location}/assets/`,
-        );
+      : line.replace(/\]\(assets\//g, `](${location}/assets/`);
   });
   return lines.join('\n');
 }