Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-15 03:01:37 -05:00
Code Issues Activity

Extracted MembersCSVImporter to a builder method

Browse source 
refs https://github.com/TryGhost/Toolbox/issues/430
refs https://github.com/TryGhost/Ghost/issues/14882

- The MembersCSVImporter constructor is way to complex and needs refactoring. This complexity makes initialization in tests too bulky and makes tests hard to read.
- Having a builder method is a stopgap solution to avoid going into MembersCSVImporter refactoring too deep.
This commit is contained in:
Naz 2022-10-13 14:21:08 +08:00
parent 4300f14d79
commit d165a0017c
No known key found for this signature in database
1 changed files with 52 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

154
ghost/members-importer/test/importer.test.js
View file

@ -11,6 +11,9 @@ const csvPath = path.join(__dirname, '/fixtures/');
describe('Importer', function () {
let fsWriteSpy;
let memberCreateStub;
let knexStub;
let sendEmailStub;
beforeEach(function () {
fsWriteSpy = sinon.spy(fs, 'writeFile');
@ -26,51 +29,58 @@ describe('Importer', function () {
sinon.restore();
});
// @NOTE: this is way too much mocking! the MembersCSVImporter constructor API should be simplified
const buildMockImporterInstance = () => {
const defaultProduct = {
id: 'default_product_id'
};
memberCreateStub = sinon.stub().resolves(null);
const membersApi = {
productRepository: {
list: async () => {
return {
data: [defaultProduct]
};
}
},
members: {
get: async () => {
return null;
},
create: memberCreateStub
}
};
knexStub = {
transaction: sinon.stub().resolves({
rollback: () => {},
commit: () => {}
})
};
sendEmailStub = sinon.stub();
return new MembersCSVImporter({
storagePath: csvPath,
getTimezone: sinon.stub().returns('UTC'),
getMembersApi: () => membersApi,
sendEmail: sendEmailStub,
isSet: sinon.stub(),
addJob: sinon.stub(),
knex: knexStub,
urlFor: sinon.stub(),
context: {importer: true}
});
};
describe('process', function () {
it('should import a CSV file', async function () {
const defaultProduct = {
id: 'default_product_id'
};
const memberCreateStub = sinon.stub().resolves(null);
const membersApi = {
productRepository: {
list: async () => {
return {
data: [defaultProduct]
};
}
},
members: {
get: async () => {
return null;
},
create: memberCreateStub
}
};
const knexStub = {
transaction: sinon.stub().resolves({
rollback: () => {},
commit: () => {}
})
};
const LabelModelStub = {
findOne: sinon.stub().resolves(null)
};
const importer = new MembersCSVImporter({
storagePath: csvPath,
getTimezone: sinon.stub().returns('UTC'),
getMembersApi: () => membersApi,
sendEmail: sinon.stub(),
isSet: sinon.stub(),
addJob: sinon.stub(),
knex: knexStub,
urlFor: sinon.stub(),
context: {importer: true}
});
const importer = buildMockImporterInstance();
const result = await importer.process({
pathToCSV: `${csvPath}/single-column-with-header.csv`,
@ -105,47 +115,7 @@ describe('Importer', function () {
describe('sendErrorEmail', function () {
it('should send email with errors for invalid CSV file', async function () {
const defaultProduct = {
id: 'default_product_id'
};
const memberCreateStub = sinon.stub().resolves(null);
const membersApi = {
productRepository: {
list: async () => {
return {
data: [defaultProduct]
};
}
},
members: {
get: async () => {
return null;
},
create: memberCreateStub
}
};
const knexStub = {
transaction: sinon.stub().resolves({
rollback: () => {},
commit: () => {}
})
};
const sendEmailStub = sinon.stub();
const importer = new MembersCSVImporter({
storagePath: csvPath,
getTimezone: sinon.stub().returns('UTC'),
getMembersApi: () => membersApi,
sendEmail: sendEmailStub,
isSet: sinon.stub(),
addJob: sinon.stub(),
knex: knexStub,
urlFor: sinon.stub(),
context: {importer: true}
});
const importer = buildMockImporterInstance();
await importer.sendErrorEmail({
emailRecipient: 'test@example.com',
@ -174,17 +144,7 @@ describe('Importer', function () {
describe('prepare', function () {
it('processes a basic valid import file for members', async function () {
const membersImporter = new MembersCSVImporter({
storagePath: csvPath,
getTimezone: sinon.stub().returns('UTC'),
getMembersApi: sinon.stub(),
sendEmail: sinon.stub(),
isSet: sinon.stub(),
addJob: sinon.stub(),
knex: sinon.stub(),
urlFor: sinon.stub(),
context: {importer: true}
});
const membersImporter = buildMockImporterInstance();
const result = await membersImporter.prepare(`${csvPath}/single-column-with-header.csv`);
@ -198,17 +158,7 @@ describe('Importer', function () {
});
it('Does not include columns not in the original CSV or mapped', async function () {
const membersImporter = new MembersCSVImporter({
storagePath: csvPath,
getTimezone: sinon.stub().returns('UTC'),
getMembersApi: sinon.stub(),
sendEmail: sinon.stub(),
isSet: sinon.stub(),
addJob: sinon.stub(),
knex: sinon.stub(),
urlFor: sinon.stub(),
context: {importer: true}
});
const membersImporter = buildMockImporterInstance();
await membersImporter.prepare(`${csvPath}/single-column-with-header.csv`);