mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-19 08:31:43 +03:00
6d4dcdf45d
refs https://github.com/TryGhost/Toolbox/issues/524 - We need to be able to inline external media in all internal resources: tags, users, post's meta fields. - This change adds media inlining logic to all these resources
460 lines
18 KiB
JavaScript
460 lines
18 KiB
JavaScript
const assert = require('assert');
|
|
const sinon = require('sinon');
|
|
const nock = require('nock');
|
|
const loggingLib = require('@tryghost/logging');
|
|
const ExternalMediaInliner = require('../index');
|
|
|
|
describe('ExternalMediaInliner', function () {
|
|
let logging;
|
|
let GIF1x1;
|
|
let postModelStub;
|
|
let postMetaModelStub;
|
|
let tagModelStub;
|
|
let userModelStub;
|
|
|
|
beforeEach(function () {
|
|
// use a 1x1 gif in nock responses because it's really small and easy to work with
|
|
GIF1x1 = Buffer.from('R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==', 'base64');
|
|
logging = {
|
|
info: sinon.stub(loggingLib, 'info'),
|
|
error: sinon.stub(loggingLib, 'error'),
|
|
warn: sinon.stub(loggingLib, 'warn')
|
|
};
|
|
|
|
postModelStub = {
|
|
tableName: 'posts',
|
|
findPage: sinon.stub().resolves({
|
|
data: []
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
postMetaModelStub = {
|
|
tableName: 'posts_meta',
|
|
findPage: sinon.stub().resolves({
|
|
data: []
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
tagModelStub = {
|
|
tableName: 'tags',
|
|
findPage: sinon.stub().resolves({
|
|
data: []
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
userModelStub = {
|
|
tableName: 'users',
|
|
findPage: sinon.stub().resolves({
|
|
data: []
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
});
|
|
|
|
afterEach(function () {
|
|
sinon.restore();
|
|
nock.cleanAll();
|
|
});
|
|
|
|
it('Creates an External Media Inliner instance', function () {
|
|
assert.ok(new ExternalMediaInliner({}));
|
|
});
|
|
|
|
describe('inline', function () {
|
|
it('inlines image in the post\'s mobiledoc content', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
const postModelInstanceStub = {
|
|
id: 'inlined-post-id',
|
|
get: sinon.stub()
|
|
.withArgs('mobiledoc')
|
|
.returns(`{"version":"0.3.1","atoms":[],"cards":[["image",{"src":"${imageURL}"}]]}`)
|
|
};
|
|
postModelStub = {
|
|
findPage: sinon.stub().returns({
|
|
data: [postModelInstanceStub]
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-image.jpg',
|
|
saveRaw: () => '/content/images/unique-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(postModelStub.edit.calledOnce);
|
|
assert.ok(postModelStub.edit.calledWith({
|
|
mobiledoc: '{"version":"0.3.1","atoms":[],"cards":[["image",{"src":"__GHOST_URL__/content/images/unique-image.jpg"}]]}'
|
|
}, {
|
|
id: 'inlined-post-id',
|
|
context: {
|
|
internal: true
|
|
}
|
|
}));
|
|
});
|
|
|
|
it('logs an error when fetching an external media fails', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/image.jpg')
|
|
.reply(404);
|
|
const postModelInstanceStub = {
|
|
id: 'inlined-post-id',
|
|
get: sinon.stub()
|
|
.withArgs('mobiledoc')
|
|
.returns(`{"version":"0.3.1","atoms":[],"cards":[["image",{"src":"${imageURL}"}]]}`)
|
|
};
|
|
|
|
postModelStub = {
|
|
findPage: sinon.stub().returns({
|
|
data: [postModelInstanceStub]
|
|
})
|
|
};
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.equal(logging.error.args[0][0], 'Error downloading remote media: https://img.stockfresh.com/files/f/image.jpg');
|
|
});
|
|
|
|
it('logs an error when fetching an external media for simple fields fails', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/simple-image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/simple-image.jpg')
|
|
.reply(500);
|
|
const userModelInstanceStub = {
|
|
id: 'inlined-user-id',
|
|
get: sinon.stub()
|
|
.withArgs('profile_image')
|
|
.returns(imageURL)
|
|
};
|
|
|
|
userModelStub = {
|
|
findPage: sinon.stub().returns({
|
|
data: [userModelInstanceStub]
|
|
})
|
|
};
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.equal(logging.error.args[0][0], 'Error downloading remote media: https://img.stockfresh.com/files/f/simple-image.jpg');
|
|
});
|
|
|
|
it('logs a warning when no suitable storage adapter found for inlined media extension', async function () {
|
|
const fileURL = 'https://img.stockfresh.com/files/f/inlined.exe';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/inlined.exe')
|
|
.reply(200, GIF1x1);
|
|
|
|
const postModelInstanceStub = {
|
|
id: 'inlined-post-id',
|
|
get: sinon.stub()
|
|
.withArgs('mobiledoc')
|
|
.returns(`{"version":"0.3.1","atoms":[],"cards":[["image",{"src":"${fileURL}"}]]}`)
|
|
};
|
|
postModelStub = {
|
|
findPage: sinon.stub().returns({
|
|
data: [postModelInstanceStub]
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.exe').returns(null)
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(logging.warn.calledOnce);
|
|
assert.equal(logging.warn.args[0][0], 'No storage adapter found for file extension: .exe');
|
|
});
|
|
|
|
it('logs an error when handling post inlining throws an error', async function (){
|
|
const imageURL = 'https://img.stockfresh.com/files/f/image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
postModelStub = {
|
|
id: 'errored-post-id',
|
|
get: sinon.stub()
|
|
.withArgs('mobiledoc')
|
|
.returns(`{"version":"0.3.1","atoms":[],"cards":[["image",{"src":"${imageURL}"}]]}`)
|
|
};
|
|
postModelStub = {
|
|
findPage: sinon.stub().returns({
|
|
data: [postModelStub]
|
|
}),
|
|
edit: sinon.stub().throws(new Error('Error saving the post'))
|
|
};
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-image.jpg',
|
|
saveRaw: () => '/content/images/unique-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(postModelStub.edit.calledOnce);
|
|
assert.equal(logging.error.args[0][0], 'Error inlining media for post: errored-post-id');
|
|
});
|
|
|
|
it('logs an error when handling tag simple fields inlining throws an error', async function (){
|
|
const imageURL = 'https://img.stockfresh.com/files/f/simple-image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/simple-image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
const getMethodStub = sinon.stub();
|
|
getMethodStub.withArgs('feature_image').returns(imageURL);
|
|
getMethodStub.withArgs('og_image').returns(null);
|
|
getMethodStub.withArgs('twitter_image').returns(null);
|
|
|
|
const tagModelInstanceStub = {
|
|
id: 'errored-tag-id',
|
|
get: getMethodStub
|
|
};
|
|
tagModelStub.findPage = sinon.stub().returns({
|
|
data: [tagModelInstanceStub]
|
|
});
|
|
tagModelStub.edit = sinon.stub().throws(new Error('Error saving the tag'));
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-image.jpg',
|
|
saveRaw: () => '/content/images/unique-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(tagModelStub.edit.calledOnce);
|
|
assert.equal(logging.error.args[0][0], 'Error inlining media for tags: errored-tag-id');
|
|
});
|
|
|
|
it('inlines image in the post\'s feature_image field', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/posts_feature_image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/posts_feature_image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
postModelStub = {
|
|
id: 'inlined-post-id',
|
|
get: sinon.stub()
|
|
.withArgs('feature_image')
|
|
.returns(imageURL)
|
|
};
|
|
const postModelMock = {
|
|
findPage: sinon.stub().returns({
|
|
data: [postModelStub]
|
|
}),
|
|
edit: sinon.stub().resolves()
|
|
};
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelMock,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-feature-image.jpg',
|
|
saveRaw: () => '/content/images/unique-feature-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(postModelMock.edit.calledOnce);
|
|
assert.ok(postModelMock.edit.calledWith({
|
|
feature_image: '__GHOST_URL__/content/images/unique-feature-image.jpg'
|
|
}, {
|
|
id: 'inlined-post-id',
|
|
context: {
|
|
internal: true
|
|
}
|
|
}));
|
|
});
|
|
|
|
it('inlines og_image image in posts_meta table', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/posts_meta_image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/posts_meta_image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
const getMethodStub = sinon.stub();
|
|
getMethodStub.withArgs('og_image').returns(imageURL);
|
|
getMethodStub.withArgs('twitter_image').returns(null);
|
|
const postsMetaModelInstanceStub = {
|
|
id: 'inlined-post-meta-id',
|
|
get: getMethodStub
|
|
};
|
|
|
|
postMetaModelStub.findPage = sinon.stub().resolves({
|
|
data: [postsMetaModelInstanceStub]
|
|
});
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-posts-meta-image.jpg',
|
|
saveRaw: () => '/content/images/unique-posts-meta-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(postMetaModelStub.edit.calledOnce);
|
|
assert.deepEqual(postMetaModelStub.edit.args[0][0], {
|
|
og_image: '__GHOST_URL__/content/images/unique-posts-meta-image.jpg'
|
|
});
|
|
assert.deepEqual(postMetaModelStub.edit.args[0][1], {
|
|
id: 'inlined-post-meta-id',
|
|
context: {
|
|
internal: true
|
|
}
|
|
});
|
|
});
|
|
|
|
it('inlines twitter_image image in tags table', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/tag_twitter_image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/tag_twitter_image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
const getMethodStub = sinon.stub();
|
|
getMethodStub.withArgs('twitter_image').returns(imageURL);
|
|
getMethodStub.returns(null);
|
|
const tagModelInstanceStub = {
|
|
id: 'inlined-tag-id',
|
|
get: getMethodStub
|
|
};
|
|
|
|
tagModelStub.findPage = sinon.stub().resolves({
|
|
data: [tagModelInstanceStub]
|
|
});
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/unique-tag-twitter-image.jpg',
|
|
saveRaw: () => '/content/images/unique-tag-twitter-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(tagModelStub.edit.calledOnce);
|
|
assert.deepEqual(tagModelStub.edit.args[0][0], {
|
|
twitter_image: '__GHOST_URL__/content/images/unique-tag-twitter-image.jpg'
|
|
});
|
|
assert.deepEqual(tagModelStub.edit.args[0][1], {
|
|
id: 'inlined-tag-id',
|
|
context: {
|
|
internal: true
|
|
}
|
|
});
|
|
});
|
|
|
|
it('inlines cover_image image in users table', async function () {
|
|
const imageURL = 'https://img.stockfresh.com/files/f/user_cover_image.jpg';
|
|
const requestMock = nock('https://img.stockfresh.com')
|
|
.get('/files/f/user_cover_image.jpg')
|
|
.reply(200, GIF1x1);
|
|
|
|
const getMethodStub = sinon.stub();
|
|
getMethodStub.withArgs('cover_image').returns(imageURL);
|
|
getMethodStub.returns(null);
|
|
const userModelInstanceStub = {
|
|
id: 'inlined-user-id',
|
|
get: getMethodStub
|
|
};
|
|
|
|
userModelStub.findPage = sinon.stub().resolves({
|
|
data: [userModelInstanceStub]
|
|
});
|
|
|
|
const inliner = new ExternalMediaInliner({
|
|
PostModel: postModelStub,
|
|
PostMetaModel: postMetaModelStub,
|
|
TagModel: tagModelStub,
|
|
UserModel: userModelStub,
|
|
getMediaStorage: sinon.stub().withArgs('.jpg').returns({
|
|
getTargetDir: () => '/content/images',
|
|
getUniqueFileName: () => '/content/images/user-cover-image.jpg',
|
|
saveRaw: () => '/content/images/user-cover-image.jpg'
|
|
})
|
|
});
|
|
|
|
await inliner.inline(['https://img.stockfresh.com']);
|
|
|
|
assert.ok(requestMock.isDone());
|
|
assert.ok(userModelStub.edit.calledOnce);
|
|
assert.deepEqual(userModelStub.edit.args[0][0], {
|
|
cover_image: '__GHOST_URL__/content/images/user-cover-image.jpg'
|
|
});
|
|
assert.deepEqual(userModelStub.edit.args[0][1], {
|
|
id: 'inlined-user-id',
|
|
context: {
|
|
internal: true
|
|
}
|
|
});
|
|
});
|
|
});
|
|
});
|