Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: #1114 static files in blog/assets is not working #1143

Merged
merged 3 commits into from
Dec 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions v1/lib/server/__tests__/__snapshots__/blog.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,51 @@ We are very happy to introduce [Docusaurus](https://github.com/facebook/Docusaur
"title": "Docusaurus",
}
`;

exports[`replaceAssetsLink does not transform document without valid assets link 1`] = `
"
### Existing Docs

- [doc1](doc1.md)
- [doc2](./doc2.md)

### Non-existing Docs

- [hahaha](hahaha.md)

## Repeating Docs

- [doc1](doc1.md)
- [doc2](./doc2.md)

## Do not replace this
\`\`\`md
![image1](assets/image1.png)
\`\`\`

\`\`\`js
const doc1 = foo();
console.log(\\"[image2](assets/image2.jpg)\\");
const testStr = \`![image3](assets/image3.gif)\`;
\`\`\`"
`;

exports[`replaceAssetsLink transform document with valid assets link 1`] = `
"
Docusaurus is the best :)

![image1](/blog/assets/image1.png)

\`\`\`js
console.log(\\"Docusaurus\\");
\`\`\`

![image2](/blog/assets/image2.jpg)
![image3](/blog/assets/image3.gif)

Don't replace the one below
\`\`\`md

![image4](assets/image4.bmp)
\`\`\`"
`;
37 changes: 37 additions & 0 deletions v1/lib/server/__tests__/blog.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
const path = require('path');
const fs = require('fs-extra');
const blog = require('../blog');
const metadataUtils = require('../metadataUtils');
const {replaceAssetsLink} = require('../utils.js');

const testFile = path.join(
__dirname,
Expand Down Expand Up @@ -66,3 +68,38 @@ describe('urlToSource', () => {
);
});
});

describe('replaceAssetsLink', () => {
test('transform document with valid assets link', () => {
const doc1 = fs.readFileSync(
path.join(__dirname, '__fixtures__', 'doc1.md'),
'utf8',
);
const rawContent1 = metadataUtils.extractMetadata(doc1).rawContent;
const content1 = replaceAssetsLink(rawContent1, 'blog');
expect(content1).toMatchSnapshot();
expect(content1).toContain('![image1](/blog/assets/image1.png)');
expect(content1).toContain('![image2](/blog/assets/image2.jpg)');
expect(content1).toContain('![image3](/blog/assets/image3.gif)');
expect(content1).toContain('![image4](assets/image4.bmp)');
expect(content1).not.toContain('![image1](assets/image1.png)');
expect(content1).not.toContain('![image2](assets/image2.jpg)');
expect(content1).not.toContain('![image3](assets/image3.gif)');
expect(content1).not.toContain('![image4](/blog/assets/image4.bmp)');
expect(content1).not.toEqual(rawContent1);
});

test('does not transform document without valid assets link', () => {
const doc2 = fs.readFileSync(
path.join(__dirname, '__fixtures__', 'doc2.md'),
'utf8',
);
const rawContent2 = metadataUtils.extractMetadata(doc2).rawContent;
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)');
expect(content2).not.toContain('![image3](/blog/assets/image3.gif)');
expect(content2).toEqual(rawContent2);
});
});
5 changes: 3 additions & 2 deletions v1/lib/server/__tests__/docs.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const path = require('path');
const fs = require('fs-extra');
const docs = require('../docs');
const metadataUtils = require('../metadataUtils');
const {replaceAssetsLink} = require('../utils.js');

jest.mock('../env', () => ({
translation: {
Expand Down Expand Up @@ -186,7 +187,7 @@ describe('getFile', () => {

describe('replaceAssetsLink', () => {
test('transform document with valid assets link', () => {
const content1 = docs.replaceAssetsLink(rawContent1);
const content1 = replaceAssetsLink(rawContent1, 'docs');
expect(content1).toMatchSnapshot();
expect(content1).toContain('![image1](/docs/assets/image1.png)');
expect(content1).toContain('![image2](/docs/assets/image2.jpg)');
Expand All @@ -200,7 +201,7 @@ describe('replaceAssetsLink', () => {
});

test('does not transform document without valid assets link', () => {
const content2 = docs.replaceAssetsLink(rawContent2);
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)');
Expand Down
8 changes: 6 additions & 2 deletions v1/lib/server/blog.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
const React = require('react');
const path = require('path');
const fs = require('fs-extra');
const {renderToStaticMarkupWithDoctype} = require('./renderUtils');
const metadataUtils = require('./metadataUtils');
const {replaceAssetsLink} = require('./utils.js');
const {renderToStaticMarkupWithDoctype} = require('./renderUtils');

function urlToSource(url) {
if (!url || typeof url !== 'string') {
Expand Down Expand Up @@ -56,7 +57,10 @@ function getMetadata(file) {
fs.readFileSync(file, {encoding: 'utf8'}),
);
const metadata = Object.assign(
{path: fileToUrl(file), content: result.rawContent},
{
path: fileToUrl(file),
content: replaceAssetsLink(result.rawContent, 'blog'),
},
result.metadata,
);
metadata.id = metadata.title;
Expand Down
20 changes: 2 additions & 18 deletions v1/lib/server/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const env = require('./env.js');
const {renderToStaticMarkupWithDoctype} = require('./renderUtils');
const readMetadata = require('./readMetadata.js');
const {insertTOC} = require('../core/toc.js');
const {replaceAssetsLink} = require('./utils.js');
const {getPath} = require('../core/utils.js');

const docsPart = `${siteConfig.docsUrl ? `${siteConfig.docsUrl}/` : ''}`;
Expand Down Expand Up @@ -102,22 +103,6 @@ function mdToHtmlify(oldContent, mdToHtml, metadata) {
return content;
}

function replaceAssetsLink(oldContent) {
let fencedBlock = false;
const lines = oldContent.split('\n').map(line => {
if (line.trim().startsWith('```')) {
fencedBlock = !fencedBlock;
}
return fencedBlock
? line
: line.replace(
/\]\(assets\//g,
`](${siteConfig.baseUrl}${docsPart}assets/`,
);
});
return lines.join('\n');
}

function getMarkup(rawContent, mdToHtml, metadata) {
// generate table of contents
let content = insertTOC(rawContent);
Expand All @@ -126,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);
content = replaceAssetsLink(content, 'docs');

const DocsLayout = require('../core/DocsLayout.js');
return renderToStaticMarkupWithDoctype(
Expand Down Expand Up @@ -164,5 +149,4 @@ module.exports = {
getFilePath,
getRedirectMarkup,
mdToHtmlify,
replaceAssetsLink,
};
19 changes: 18 additions & 1 deletion v1/lib/server/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

const cssnano = require('cssnano');
const autoprefixer = require('autoprefixer');
const postcss = require('postcss');
const path = require('path');
const escapeStringRegexp = require('escape-string-regexp');
const siteConfig = require('../../website/siteConfig.js');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This broke docusaurus completely, see #1149

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that doesn't look right.

@yangshun @endiliey -- I think we need to fix this or revert this specific diff and push out a hotfix.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this PR broke the release. My bad to overlook this. Will release a hotfix in ~1 hour.


function getSubDir(file, refDir) {
const subDir = path.dirname(path.relative(refDir, file)).replace(/\\/g, '/');
Expand Down Expand Up @@ -66,10 +66,27 @@ function autoPrefixCss(cssContent) {
.then(result => result.css);
}

function replaceAssetsLink(oldContent, location) {
let fencedBlock = false;
const lines = oldContent.split('\n').map(line => {
if (line.trim().startsWith('```')) {
fencedBlock = !fencedBlock;
}
return fencedBlock
? line
: line.replace(
/\]\(assets\//g,
`](${siteConfig.baseUrl}${location}/assets/`,
);
});
return lines.join('\n');
}

module.exports = {
getSubDir,
getLanguage,
isSeparateCss,
minifyCss,
autoPrefixCss,
replaceAssetsLink,
};