const path = require('path');
const should = require('should');
const sinon = require('sinon');
const nock = require('nock');
const configUtils = require('../../utils/configUtils');
const mobiledocLib = require('../../../core/server/lib/mobiledoc');
const storage = require('../../../core/server/adapters/storage');
const urlUtils = require('../../../core/shared/url-utils');
const mockUtils = require('../../utils/mocks');
describe('lib/mobiledoc', function () {
afterEach(function () {
sinon.restore();
nock.cleanAll();
configUtils.restore();
// ensure config changes are reset and picked up by next test
mobiledocLib.reload();
mockUtils.modules.unmockNonExistentModule(/sharp/);
});
describe('mobiledocHtmlRenderer', function () {
it('renders all default cards and atoms', function () {
let mobiledoc = {
version: '0.3.1',
ghostVersion: '0.3',
atoms: [
['soft-return', '', {}]
],
cards: [
['markdown', {
markdown: '# Markdown card\nSome markdown'
}],
['paywall', {}],
['hr', {}],
['image', {
cardWidth: 'wide',
src: '/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000,
caption: 'Birdies'
}],
['html', {
html: 'HTML card
\n'
}],
['embed', {
html: 'Embed card
'
}],
['gallery', {
images: [{
row: 0,
fileName: 'test.png',
src: '/content/images/test.png',
width: 1000,
height: 500
}]
}]
],
markups: [],
sections: [
[1, 'p', [
[0, [], 0, 'One'],
[1, [], 0, 0],
[0, [], 0, 'Two']
]],
[10, 0],
[1, 'p', [
[0, [], 0, 'Three']
]],
[10, 1],
[10, 2],
[10, 3],
[1, 'p', [
[0, [], 0, 'Four']
]],
[10, 4],
[10, 5],
[10, 6],
[1, 'p', []]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('One
Two
Markdown card
\nSome markdown
\nThree
BirdiesFour
HTML card
\nEmbed card
');
});
it('renders according to ghostVersion', function () {
let mobiledoc = {
version: '0.3.1',
ghostVersion: '4.0',
atoms: [],
cards: [
['markdown', {
markdown: '# Header One'
}]
],
markups: [],
sections: [
[10, 0],
[1, 'h2', [
[0, [], 0, 'Héader Two']]
]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('\nHéader Two
');
});
it('renders srcsets for __GHOST_URL__ relative images', function () {
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
cardWidth: 'wide',
src: '__GHOST_URL__/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000,
caption: 'Birdies'
}],
['gallery', {
images: [{
row: 0,
fileName: 'test.png',
src: '__GHOST_URL__/content/images/test.png',
width: 1000,
height: 500
}]
}]
],
markups: [],
sections: [
[10, 0],
[10, 1]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('
Birdies');
});
it('renders srcsets for absolute images', function () {
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
cardWidth: 'wide',
src: 'http://127.0.0.1:2369/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000,
caption: 'Birdies'
}],
['gallery', {
images: [{
row: 0,
fileName: 'test.png',
src: 'http://127.0.0.1:2369/content/images/test.png',
width: 1000,
height: 500
}]
}]
],
markups: [],
sections: [
[10, 0],
[10, 1]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('
Birdies');
});
it('respects srcsets config', function () {
configUtils.set('imageOptimization:srcsets', false);
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
cardWidth: 'wide',
src: '/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000,
caption: 'Birdies'
}],
['gallery', {
images: [{
row: 0,
fileName: 'test.png',
src: '/content/images/test.png',
width: 1000,
height: 500
}]
}]
],
markups: [],
sections: [
[10, 0],
[10, 1]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('Birdies');
});
it('does not render srcsets for non-resizable images', function () {
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
cardWidth: '',
src: '/content/images/2020/07/animated.gif',
width: 4000,
height: 2000
}]
],
markups: [],
sections: [[10, 0]]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('
');
});
it('does not render srcsets when sharp is not available', function () {
mockUtils.modules.mockNonExistentModule('sharp', new Error(), true);
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
src: '/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000
}]
],
markups: [],
sections: [
[10, 0]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('');
});
it('does not render srcsets with incompatible storage engine', function () {
sinon.stub(storage.getStorage(), 'saveRaw').value(null);
let mobiledoc = {
version: '0.3.1',
atoms: [],
cards: [
['image', {
src: '/content/images/2018/04/NatGeo06.jpg',
width: 4000,
height: 2000
}]
],
markups: [],
sections: [
[10, 0]
]
};
mobiledocLib.mobiledocHtmlRenderer.render(mobiledoc)
.should.eql('');
});
});
describe('populateImageSizes', function () {
let originalStoragePath;
beforeEach(function () {
originalStoragePath = storage.getStorage().storagePath;
storage.getStorage().storagePath = path.join(__dirname, '../../utils/fixtures/images/');
});
afterEach(function () {
storage.getStorage().storagePath = originalStoragePath;
});
it('works', async function () {
let mobiledoc = {
cards: [
['image', {src: '/content/images/ghost-logo.png'}],
['image', {src: 'http://example.com/external.jpg'}],
['image', {src: 'https://images.unsplash.com/favicon_too_large?ixlib=rb-1.2.1&q=80&fm=jpg&crop=entropy&cs=tinysrgb&w=2000&fit=max&ixid=eyJhcHBfaWQiOjExNzczfQ'}],
['image', {}]
]
};
const unsplashMock = nock('https://images.unsplash.com/')
.get('/favicon_too_large')
.query(true)
.replyWithFile(200, path.join(__dirname, '../../utils/fixtures/images/favicon_not_square.png'), {
'Content-Type': 'image/png'
});
const transformedMobiledoc = await mobiledocLib.populateImageSizes(JSON.stringify(mobiledoc));
const transformed = JSON.parse(transformedMobiledoc);
unsplashMock.isDone().should.be.true();
transformed.cards.length.should.equal(4);
});
// images can be stored with and without subdir when a subdir is configured
// but storage adapter always needs paths relative to content dir
it('works with subdir', async function () {
// urlUtils is a class instance and won't pick up changes to config so
// it's necessary to stub out the internals used by
sinon.stub(urlUtils, 'getSubdir').returns('/subdir');
let mobiledoc = {
cards: [
['image', {src: '/content/images/ghost-logo.png'}],
['image', {src: '/subdir/content/images/ghost-logo.png'}]
]
};
const transformedMobiledoc = await mobiledocLib.populateImageSizes(JSON.stringify(mobiledoc));
const transformed = JSON.parse(transformedMobiledoc);
transformed.cards.length.should.equal(2);
should.exist(transformed.cards[0][1].width);
transformed.cards[0][1].width.should.equal(800);
should.exist(transformed.cards[0][1].height);
transformed.cards[0][1].height.should.equal(257);
should.exist(transformed.cards[1][1].width);
transformed.cards[1][1].width.should.equal(800);
should.exist(transformed.cards[1][1].height);
transformed.cards[1][1].height.should.equal(257);
});
});
});
