Skip to content

improve milestone hooks and change referenceId in milestone to BIGINT #321

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 27, 2019
Merged

improve milestone hooks and change referenceId in milestone to BIGINT #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 47 additions & 16 deletions src/models/milestone.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,42 @@ import models from '../models';

/**
* Populate and map milestone model with statusHistory
* NOTE that this function mutates milestone
* @param {Object} milestone the milestone
* @returns {Promise} promise
*/
const mapWithStatusHistory = async (milestone) => {
try {
const statusHistory = await models.StatusHistory.findAll({
where: {
referenceId: milestone.id.toString(),
reference: 'milestone',
},
order: [['createdAt', 'desc']],
raw: true,
});
return _.merge(milestone, { dataValues: { statusHistory } });
} catch (err) {
return _.merge(milestone, { dataValues: { statusHistory: [] } });
if (Array.isArray(milestone)) {
try {
const allStatusHistory = await models.StatusHistory.findAll({
where: {
referenceId: { $in: milestone.map(m => m.dataValues.id) },
reference: 'milestone',
},
order: [['createdAt', 'desc']],
raw: true,
});
return milestone.map((m, index) => {
const statusHistory = allStatusHistory.filter(s => s.referenceId === m.dataValues.id);
return _.merge(milestone[index], { dataValues: { statusHistory } });
});
} catch (err) {
return milestone.map((m, index) => _.merge(milestone[index], { dataValues: { statusHistory: [] } }));
}
} else {
try {
const statusHistory = await models.StatusHistory.findAll({
where: {
referenceId: milestone.dataValues.id,
reference: 'milestone',
},
order: [['createdAt', 'desc']],
raw: true,
});
return _.merge(milestone, { dataValues: { statusHistory } });
} catch (err) {
return _.merge(milestone, { dataValues: { statusHistory: [] } });
}
}
};

Expand Down Expand Up @@ -117,6 +137,21 @@ module.exports = (sequelize, DataTypes) => {
transaction: options.transaction,
}).then(() => mapWithStatusHistory(milestone)),

afterBulkCreate: (milestones, options) => {
const listStatusHistory = milestones.map(({ dataValues }) => ({
reference: 'milestone',
referenceId: dataValues.id,
status: dataValues.status,
comment: null,
createdBy: dataValues.createdBy,
updatedBy: dataValues.updatedBy,
}));

return models.StatusHistory.bulkCreate(listStatusHistory, {
transaction: options.transaction,
}).then(() => mapWithStatusHistory(milestones));
},

afterUpdate: (milestone, options) => {
if (milestone.changed().includes('status')) {
return models.StatusHistory.create({
Expand All @@ -135,10 +170,6 @@ module.exports = (sequelize, DataTypes) => {

afterFind: (milestone) => {
if (!milestone) return Promise.resolve();

if (Array.isArray(milestone)) {
return Promise.all(milestone.map(mapWithStatusHistory));
}
return mapWithStatusHistory(milestone);
},
},
Expand Down
2 changes: 1 addition & 1 deletion src/models/statusHistory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module.exports = function defineStatusHistory(sequelize, DataTypes) {
const StatusHistory = sequelize.define('StatusHistory', {
id: { type: DataTypes.BIGINT, primaryKey: true, autoIncrement: true },
reference: { type: DataTypes.STRING, allowNull: false },
referenceId: { type: DataTypes.STRING, allowNull: false },
referenceId: { type: DataTypes.BIGINT, allowNull: false },
status: {
type: DataTypes.STRING,
allowNull: false,
Expand Down
12 changes: 8 additions & 4 deletions src/routes/milestones/create.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ describe('CREATE milestone', () => {
// Create milestones
models.Milestone.bulkCreate([
{
id: 11,
timelineId: 1,
name: 'milestone 1',
duration: 2,
Expand All @@ -164,6 +165,7 @@ describe('CREATE milestone', () => {
updatedBy: 2,
},
{
id: 12,
timelineId: 1,
name: 'milestone 2',
duration: 3,
Expand All @@ -179,6 +181,7 @@ describe('CREATE milestone', () => {
updatedBy: 3,
},
{
id: 13,
timelineId: 1,
name: 'milestone 3',
duration: 4,
Expand Down Expand Up @@ -526,9 +529,10 @@ describe('CREATE milestone', () => {
// validate statusHistory
should.exist(resJson.statusHistory);
resJson.statusHistory.should.be.an('array');
resJson.statusHistory.length.should.be.eql(1);
resJson.statusHistory.forEach((statusHistory) => {
statusHistory.reference.should.be.eql('milestone');
statusHistory.referenceId.should.be.eql(`${resJson.id}`);
statusHistory.referenceId.should.be.eql(resJson.id);
});

// eslint-disable-next-line no-unused-expressions
Expand All @@ -538,11 +542,11 @@ describe('CREATE milestone', () => {
models.Milestone.findAll({ where: { timelineId: 1 } })
.then((milestones) => {
_.each(milestones, (milestone) => {
if (milestone.id === 1) {
if (milestone.id === 11) {
milestone.order.should.be.eql(1);
} else if (milestone.id === 2) {
} else if (milestone.id === 12) {
milestone.order.should.be.eql(2 + 1);
} else if (milestone.id === 3) {
} else if (milestone.id === 13) {
milestone.order.should.be.eql(3 + 1);
}
});
Expand Down
3 changes: 3 additions & 0 deletions src/routes/milestones/delete.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ describe('DELETE milestone', () => {
// Create milestones
models.Milestone.bulkCreate([
{
id: 1,
timelineId: 1,
name: 'milestone 1',
duration: 2,
Expand All @@ -182,6 +183,7 @@ describe('DELETE milestone', () => {
updatedBy: 2,
},
{
id: 2,
timelineId: 1,
name: 'milestone 2',
duration: 3,
Expand All @@ -197,6 +199,7 @@ describe('DELETE milestone', () => {
updatedBy: 3,
},
{
id: 3,
timelineId: 1,
name: 'milestone 3',
duration: 4,
Expand Down
28 changes: 3 additions & 25 deletions src/routes/milestones/get.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,30 +190,7 @@ describe('GET milestone', () => {
deletedAt: '2018-05-04T00:00:00.000Z',
},
])
.then(() =>
models.StatusHistory.bulkCreate([
{
reference: 'milestone',
referenceId: '1',
status: 'active',
comment: 'comment',
createdBy: 1,
createdAt: '2018-05-15T00:00:00Z',
updatedBy: 1,
updatedAt: '2018-05-15T00:00:00Z',
},
{
reference: 'milestone',
referenceId: '1',
status: 'active',
comment: 'comment',
createdBy: 1,
createdAt: '2018-05-15T00:00:00Z',
updatedBy: 1,
updatedAt: '2018-05-15T00:00:00Z',
},
])
.then(() => done()));
.then(() => done());
});
});
});
Expand Down Expand Up @@ -330,9 +307,10 @@ describe('GET milestone', () => {
// validate statusHistory
should.exist(resJson.statusHistory);
resJson.statusHistory.should.be.an('array');
resJson.statusHistory.length.should.be.eql(1);
resJson.statusHistory.forEach((statusHistory) => {
statusHistory.reference.should.be.eql('milestone');
statusHistory.referenceId.should.be.eql(`${resJson.id}`);
statusHistory.referenceId.should.be.eql(resJson.id);
});

done();
Expand Down
44 changes: 14 additions & 30 deletions src/routes/milestones/list.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ const milestones = [
detail2: [1, 2, 3],
},
order: 1,
hidden: false,
plannedText: 'plannedText 1',
activeText: 'activeText 1',
completedText: 'completedText 1',
Expand All @@ -59,16 +60,6 @@ const milestones = [
updatedBy: 2,
createdAt: '2018-05-11T00:00:00.000Z',
updatedAt: '2018-05-11T00:00:00.000Z',
statusHistory: [{
reference: 'milestone',
referenceId: '1',
status: 'active',
comment: 'comment',
createdBy: 1,
createdAt: '2018-05-15T00:00:00Z',
updatedBy: 1,
updatedAt: '2018-05-15T00:00:00Z',
}],
},
{
id: 2,
Expand All @@ -79,6 +70,7 @@ const milestones = [
status: 'open',
type: 'type2',
order: 2,
hidden: false,
plannedText: 'plannedText 2',
activeText: 'activeText 2',
completedText: 'completedText 2',
Expand All @@ -87,16 +79,6 @@ const milestones = [
updatedBy: 3,
createdAt: '2018-05-11T00:00:00.000Z',
updatedAt: '2018-05-11T00:00:00.000Z',
statusHistory: [{
reference: 'milestone',
referenceId: '2',
status: 'active',
comment: 'comment',
createdBy: 1,
createdAt: '2018-05-15T00:00:00Z',
updatedBy: 1,
updatedAt: '2018-05-15T00:00:00Z',
}],
},
];

Expand Down Expand Up @@ -186,13 +168,10 @@ describe('LIST timelines', () => {
.then(() =>
// Create timelines and milestones
models.Timeline.bulkCreate(timelines)
.then(() => {
const mappedMilstones = milestones.map(milestone => _.omit(milestone, ['statusHistory']));
return models.Milestone.bulkCreate(mappedMilstones);
}))
.then(() => {
.then(() => models.Milestone.bulkCreate(milestones)))
.then((mappedMilestones) => {
// Index to ES
timelines[0].milestones = milestones;
timelines[0].milestones = mappedMilestones.map(({ dataValues }) => dataValues);
timelines[0].projectId = 1;
return server.services.es.index({
index: ES_TIMELINE_INDEX,
Expand Down Expand Up @@ -268,12 +247,15 @@ describe('LIST timelines', () => {

resJson.forEach((milestone, index) => {
milestone.statusHistory.should.be.an('array');
milestone.statusHistory.length.should.be.eql(1);
milestone.statusHistory.forEach((statusHistory) => {
statusHistory.reference.should.be.eql('milestone');
statusHistory.referenceId.should.be.eql(`${milestone.id}`);
statusHistory.referenceId.should.be.eql(milestone.id);
});

milestone.should.be.eql(milestones[index]);
const m = _.omit(milestone, ['statusHistory']);

m.should.be.eql(milestones[index]);
});

done();
Expand Down Expand Up @@ -349,8 +331,10 @@ describe('LIST timelines', () => {
const resJson = res.body.result.content;
resJson.should.have.length(2);

resJson[0].should.be.eql(milestones[1]);
resJson[1].should.be.eql(milestones[0]);
const m1 = _.omit(resJson[0], ['statusHistory']);
const m2 = _.omit(resJson[1], ['statusHistory']);
m1.should.be.eql(milestones[1]);
m2.should.be.eql(milestones[0]);

done();
});
Expand Down
2 changes: 1 addition & 1 deletion src/routes/milestones/update.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ module.exports = [
return Promise.reject(apiErr);
}
const statusHistory = await models.StatusHistory.findAll({
where: { referenceId: milestone.id.toString() },
where: { referenceId: milestone.id },
order: [['createdAt', 'desc']],
attributes: ['status'],
limit: 2,
Expand Down
Loading