Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit fcb673b

Browse files
author
vikasrohit
authored
Merge pull request #6 from maxceem/update/1
Updates from another repo 1
2 parents 2aeef19 + 9c33df5 commit fcb673b

File tree

14 files changed

+331
-89
lines changed

14 files changed

+331
-89
lines changed

‎README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Microservice to manage CRUD operations for all things Projects.
1313
* Install [libpg](https://www.npmjs.com/package/pg-native)
1414

1515
### Steps to run locally
16-
1716
1. Install node dependencies
1817
```bash
1918
npm install
@@ -142,5 +141,4 @@ You may replace 172.17.0.1 with your docker0 IP.
142141
You can paste **swagger.yaml** to [swagger editor](http://editor.swagger.io/) or import **postman.json** and **postman_environment.json** to verify endpoints.
143142

144143
#### Deploying without docker
145-
146144
If you don't want to use docker to deploy to localhost. You can simply run `npm run start:dev` from root of project. This should start the server on default port `8001`.

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
"babel-plugin-add-module-exports": "^0.2.1",
7676
"babel-plugin-transform-runtime": "^6.23.0",
7777
"babel-preset-es2015": "^6.9.0",
78-
"bunyan": "^1.8.1",
78+
"bunyan": "^1.8.12",
7979
"chai": "^3.5.0",
8080
"chai-as-promised": "^7.1.1",
8181
"eslint": "^3.16.1",

‎src/events/index.js

Lines changed: 52 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,73 @@
11

22
import { EVENT, CONNECT_NOTIFICATION_EVENT } from '../constants';
3-
import { projectCreatedHandler, projectUpdatedHandler, projectDeletedHandler,
3+
import { projectCreatedHandler,
44
projectUpdatedKafkaHandler } from './projects';
5-
import { projectMemberAddedHandler, projectMemberRemovedHandler,
6-
projectMemberUpdatedHandler } from './projectMembers';
7-
import { projectMemberInviteCreatedHandler,
8-
projectMemberInviteUpdatedHandler } from './projectMemberInvites';
9-
import { projectAttachmentRemovedHandler,
10-
projectAttachmentUpdatedHandler, projectAttachmentAddedHandler } from './projectAttachments';
115
import { projectPhaseAddedHandler, projectPhaseRemovedHandler,
126
projectPhaseUpdatedHandler } from './projectPhases';
13-
import { phaseProductAddedHandler, phaseProductRemovedHandler,
14-
phaseProductUpdatedHandler } from './phaseProducts';
157
import {
168
timelineAddedHandler,
17-
timelineUpdatedHandler,
18-
timelineRemovedHandler,
199
timelineAdjustedKafkaHandler,
2010
} from './timelines';
2111
import {
2212
milestoneAddedHandler,
2313
milestoneUpdatedHandler,
24-
milestoneRemovedHandler,
2514
milestoneUpdatedKafkaHandler,
2615
} from './milestones';
2716

17+
/**
18+
* Void RabbitMQ event handler.
19+
* It "ack"s messages which are still published but we don't want to consume.
20+
*
21+
* It's used to "disable" events which we don't want to handle anymore. But for a time being
22+
* we don't want to remove the code of them until we validate that we are good without them.
23+
*
24+
* @param {Object} logger logger
25+
* @param {Object} msg RabbitMQ message
26+
* @param {Object} channel RabbitMQ channel
27+
* @returns {Promise} nothing
28+
*/
29+
const voidRabbitHandler = (logger, msg, channel) => {
30+
logger.debug('Calling void RabbitMQ handler.');
31+
channel.ack(msg);
32+
return Promise.resolve();
33+
};
34+
35+
// NOTE: We use "project-processor-es" for ES indexing now.
36+
// So I disable indexing using RabbitMQ for a transition period for most of the objects
37+
// which don't have any special logic.
38+
// As soon as we are sure, that "project-processor-es" works well for ES indexing,
39+
// we should completely remove the handlers for this events.
2840
export const rabbitHandlers = {
29-
'project.initial': projectCreatedHandler,
30-
[EVENT.ROUTING_KEY.PROJECT_DRAFT_CREATED]: projectCreatedHandler,
31-
[EVENT.ROUTING_KEY.PROJECT_UPDATED]: projectUpdatedHandler,
32-
[EVENT.ROUTING_KEY.PROJECT_DELETED]: projectDeletedHandler,
33-
[EVENT.ROUTING_KEY.PROJECT_MEMBER_ADDED]: projectMemberAddedHandler,
34-
[EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED]: projectMemberRemovedHandler,
35-
[EVENT.ROUTING_KEY.PROJECT_MEMBER_UPDATED]: projectMemberUpdatedHandler,
36-
[EVENT.ROUTING_KEY.PROJECT_MEMBER_INVITE_CREATED]: projectMemberInviteCreatedHandler,
37-
[EVENT.ROUTING_KEY.PROJECT_MEMBER_INVITE_UPDATED]: projectMemberInviteUpdatedHandler,
38-
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_ADDED]: projectAttachmentAddedHandler,
39-
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_REMOVED]: projectAttachmentRemovedHandler,
40-
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_UPDATED]: projectAttachmentUpdatedHandler,
41-
[EVENT.ROUTING_KEY.PROJECT_PHASE_ADDED]: projectPhaseAddedHandler,
42-
[EVENT.ROUTING_KEY.PROJECT_PHASE_REMOVED]: projectPhaseRemovedHandler,
43-
[EVENT.ROUTING_KEY.PROJECT_PHASE_UPDATED]: projectPhaseUpdatedHandler,
44-
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_ADDED]: phaseProductAddedHandler,
45-
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_REMOVED]: phaseProductRemovedHandler,
46-
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_UPDATED]: phaseProductUpdatedHandler,
41+
'project.initial': projectCreatedHandler, // is only used `seedElasticsearchIndex.js` and can be removed
42+
[EVENT.ROUTING_KEY.PROJECT_DRAFT_CREATED]: voidRabbitHandler, // DISABLED
43+
[EVENT.ROUTING_KEY.PROJECT_UPDATED]: voidRabbitHandler, // DISABLED
44+
[EVENT.ROUTING_KEY.PROJECT_DELETED]: voidRabbitHandler, // DISABLED
45+
[EVENT.ROUTING_KEY.PROJECT_MEMBER_ADDED]: voidRabbitHandler, // DISABLED
46+
[EVENT.ROUTING_KEY.PROJECT_MEMBER_REMOVED]: voidRabbitHandler, // DISABLED
47+
[EVENT.ROUTING_KEY.PROJECT_MEMBER_UPDATED]: voidRabbitHandler, // DISABLED
48+
[EVENT.ROUTING_KEY.PROJECT_MEMBER_INVITE_CREATED]: voidRabbitHandler, // DISABLED
49+
[EVENT.ROUTING_KEY.PROJECT_MEMBER_INVITE_UPDATED]: voidRabbitHandler, // DISABLED
50+
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_ADDED]: voidRabbitHandler, // DISABLED
51+
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_REMOVED]: voidRabbitHandler, // DISABLED
52+
[EVENT.ROUTING_KEY.PROJECT_ATTACHMENT_UPDATED]: voidRabbitHandler, // DISABLED
53+
54+
// project phase handles additionally implement logic for creating associated topics in Message Service
55+
[EVENT.ROUTING_KEY.PROJECT_PHASE_ADDED]: projectPhaseAddedHandler, // index in ES because of cascade updates
56+
[EVENT.ROUTING_KEY.PROJECT_PHASE_REMOVED]: projectPhaseRemovedHandler, // doesn't index in ES
57+
[EVENT.ROUTING_KEY.PROJECT_PHASE_UPDATED]: projectPhaseUpdatedHandler, // index in ES because of cascade updates
58+
59+
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_ADDED]: voidRabbitHandler, // DISABLED
60+
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_REMOVED]: voidRabbitHandler, // DISABLED
61+
[EVENT.ROUTING_KEY.PROJECT_PHASE_PRODUCT_UPDATED]: voidRabbitHandler, // DISABLED
4762

4863
// Timeline and milestone
49-
'timeline.initial': timelineAddedHandler,
50-
[EVENT.ROUTING_KEY.TIMELINE_ADDED]: timelineAddedHandler,
51-
[EVENT.ROUTING_KEY.TIMELINE_REMOVED]: timelineRemovedHandler,
52-
[EVENT.ROUTING_KEY.TIMELINE_UPDATED]: timelineUpdatedHandler,
53-
[EVENT.ROUTING_KEY.MILESTONE_ADDED]: milestoneAddedHandler,
54-
[EVENT.ROUTING_KEY.MILESTONE_REMOVED]: milestoneRemovedHandler,
55-
[EVENT.ROUTING_KEY.MILESTONE_UPDATED]: milestoneUpdatedHandler,
64+
'timeline.initial': timelineAddedHandler, // is only used `seedElasticsearchIndex.js` and can be removed
65+
[EVENT.ROUTING_KEY.TIMELINE_ADDED]: voidRabbitHandler, // DISABLED
66+
[EVENT.ROUTING_KEY.TIMELINE_REMOVED]: voidRabbitHandler, // DISABLED
67+
[EVENT.ROUTING_KEY.TIMELINE_UPDATED]: voidRabbitHandler, // DISABLED
68+
[EVENT.ROUTING_KEY.MILESTONE_ADDED]: milestoneAddedHandler, // index in ES because of cascade updates
69+
[EVENT.ROUTING_KEY.MILESTONE_REMOVED]: voidRabbitHandler, // DISABLED
70+
[EVENT.ROUTING_KEY.MILESTONE_UPDATED]: milestoneUpdatedHandler, // index in ES because of cascade updates
5671
};
5772

5873
export const kafkaHandlers = {

‎src/events/projectPhases/index.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ const projectPhaseUpdatedHandler = Promise.coroutine(function* (logger, msg, cha
243243
* @param {Object} msg event payload
244244
* @returns {undefined}
245245
*/
246-
const removePhaseFromIndex = Promise.coroutine(function* (logger, msg) { // eslint-disable-line func-names
246+
const removePhaseFromIndex = Promise.coroutine(function* (logger, msg) { // eslint-disable-line func-names, no-unused-vars
247247
try {
248248
const data = JSON.parse(msg.content.toString());
249249
const phase = _.get(data, 'deleted', {});
@@ -316,7 +316,8 @@ const removeTopics = Promise.coroutine(function* (logger, phase, route) { // esl
316316
*/
317317
const projectPhaseRemovedHandler = Promise.coroutine(function* (logger, msg, channel) { // eslint-disable-line func-names
318318
try {
319-
yield removePhaseFromIndex(logger, msg, channel);
319+
// NOTE We use "project-processor-es" for ES indexing now.
320+
// yield removePhaseFromIndex(logger, msg, channel);
320321
const data = JSON.parse(msg.content.toString());
321322
const phase = _.get(data, 'deleted', {});
322323
const route = _.get(data, 'route');

‎src/routes/milestones/create.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,26 +102,27 @@ module.exports = [
102102
}),
103103
)
104104
.then((otherUpdated) => {
105-
// Do not send events for the updated milestones here,
106-
// because it will make 'version conflict' error in ES.
107-
// The order of the other milestones need to be updated in the MILESTONE_ADDED event handler
108-
109105
// Send event to bus
110106
req.log.debug('Sending event to RabbitMQ bus for milestone %d', result.id);
111107
req.app.services.pubsub.publish(EVENT.ROUTING_KEY.MILESTONE_ADDED,
112108
result,
113109
{ correlationId: req.id },
114110
);
115111

116-
// emit the event
112+
// NOTE So far this logic is implemented in RabbitMQ handler of MILESTONE_ADDED
113+
// Even though we send this event to the Kafka, the "project-processor-es" shouldn't process it.
117114
util.sendResourceToKafkaBus(
118115
req,
119116
EVENT.ROUTING_KEY.MILESTONE_ADDED,
120117
RESOURCES.MILESTONE,
121118
result);
122119

123-
124-
// emit the event for other milestone order updated
120+
// NOTE So far this logic is implemented in RabbitMQ handler of MILESTONE_ADDED
121+
// Even though we send these events to the Kafka, the "project-processor-es" shouldn't process them.
122+
//
123+
// We don't process these event in "project-processor-es"
124+
// because it will make 'version conflict' error in ES.
125+
// The order of the other milestones need to be updated in the PROJECT_PHASE_UPDATED event handler
125126
_.map(otherUpdated, milestone =>
126127
util.sendResourceToKafkaBus(
127128
req,

‎src/routes/phases/create.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,14 +145,20 @@ module.exports = [
145145
{ correlationId: req.id },
146146
);
147147

148-
// emit the event
148+
// NOTE So far this logic is implemented in RabbitMQ handler of PROJECT_PHASE_UPDATED
149+
// Even though we send this event to the Kafka, the "project-processor-es" shouldn't process it.
149150
util.sendResourceToKafkaBus(
150151
req,
151152
EVENT.ROUTING_KEY.PROJECT_PHASE_ADDED,
152153
RESOURCES.PHASE,
153154
newProjectPhase);
154155

155-
// emit the event for other phase order updated
156+
// NOTE So far this logic is implemented in RabbitMQ handler of PROJECT_PHASE_UPDATED
157+
// Even though we send these events to the Kafka, the "project-processor-es" shouldn't process them.
158+
//
159+
// We don't process these event in "project-processor-es"
160+
// because it will make 'version conflict' error in ES.
161+
// The order of the other milestones need to be updated in the PROJECT_PHASE_UPDATED event handler
156162
_.map(otherUpdated, phase =>
157163
util.sendResourceToKafkaBus(
158164
req,

‎src/routes/phases/create.spec.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -482,8 +482,10 @@ describe('Project Phases', () => {
482482
let publishSpy;
483483
let sandbox;
484484

485-
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
486-
before(async () => new Promise(resolve => setTimeout(() => resolve(), 500)));
485+
before((done) => {
486+
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
487+
testUtil.wait(done);
488+
});
487489

488490
beforeEach(async () => {
489491
sandbox = sinon.sandbox.create();

‎src/routes/phases/delete.spec.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,8 +297,10 @@ describe('Project Phases', () => {
297297
let publishSpy;
298298
let sandbox;
299299

300-
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
301-
before(async () => new Promise(resolve => setTimeout(() => resolve(), 500)));
300+
before((done) => {
301+
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
302+
testUtil.wait(done);
303+
});
302304

303305
beforeEach(async () => {
304306
sandbox = sinon.sandbox.create();

‎src/routes/phases/update.spec.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -719,8 +719,10 @@ describe('Project Phases', () => {
719719
let publishSpy;
720720
let sandbox;
721721

722-
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
723-
before(async () => new Promise(resolve => setTimeout(() => resolve(), 500)));
722+
before((done) => {
723+
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
724+
testUtil.wait(done);
725+
});
724726

725727
beforeEach(async () => {
726728
sandbox = sinon.sandbox.create();

‎src/routes/projects/list.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -569,9 +569,11 @@ module.exports = [
569569
return retrieveProjects(req, criteria, sort, req.query.fields)
570570
.then((result) => {
571571
if (result.rows.length === 0) {
572+
req.log.debug('No projects found in ES');
572573
return retrieveProjectsFromDB(req, criteria, sort, req.query.fields)
573574
.then(r => util.setPaginationHeaders(req, res, r));
574575
}
576+
req.log.debug('Projects found in ES');
575577
// set header
576578
return util.setPaginationHeaders(req, res, result);
577579
})
@@ -584,9 +586,11 @@ module.exports = [
584586
return retrieveProjects(req, criteria, sort, req.query.fields)
585587
.then((result) => {
586588
if (result.rows.length === 0) {
589+
req.log.debug('No projects found in ES');
587590
return retrieveProjectsFromDB(req, criteria, sort, req.query.fields)
588591
.then(r => util.setPaginationHeaders(req, res, r));
589592
}
593+
req.log.debug('Projects found in ES');
590594
return util.setPaginationHeaders(req, res, result);
591595
})
592596
.catch(err => next(err));

‎src/routes/works/create.spec.js

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,19 @@ import _ from 'lodash';
77
import chai from 'chai';
88
import sinon from 'sinon';
99
import request from 'supertest';
10+
import config from 'config';
1011
import models from '../../models';
1112
import server from '../../app';
1213
import testUtil from '../../tests/util';
1314
import busApi from '../../services/busApi';
15+
import messageService from '../../services/messageService';
16+
import RabbitMQService from '../../services/rabbitmq';
17+
import mockRabbitMQ from '../../tests/mockRabbitMQ';
1418
import { BUS_API_EVENT, CONNECT_NOTIFICATION_EVENT, RESOURCES } from '../../constants';
1519

20+
const ES_PROJECT_INDEX = config.get('elasticsearchConfig.indexName');
21+
const ES_PROJECT_TYPE = config.get('elasticsearchConfig.docType');
22+
1623
const should = chai.should();
1724

1825
const validatePhase = (resJson, expectedPhase) => {
@@ -370,5 +377,89 @@ describe('CREATE work', () => {
370377
});
371378
});
372379
});
380+
381+
describe('RabbitMQ Message topic', () => {
382+
let createMessageSpy;
383+
let publishSpy;
384+
let sandbox;
385+
386+
before((done) => {
387+
// Wait for 500ms in order to wait for createEvent calls from previous tests to complete
388+
testUtil.wait(done);
389+
});
390+
391+
beforeEach(async () => {
392+
sandbox = sinon.sandbox.create();
393+
server.services.pubsub = new RabbitMQService(server.logger);
394+
395+
// initialize RabbitMQ
396+
server.services.pubsub.init(
397+
config.get('rabbitmqURL'),
398+
config.get('pubsubExchangeName'),
399+
config.get('pubsubQueueName'),
400+
);
401+
402+
// add project to ES index
403+
await server.services.es.index({
404+
index: ES_PROJECT_INDEX,
405+
type: ES_PROJECT_TYPE,
406+
id: projectId,
407+
body: {
408+
doc: project,
409+
},
410+
});
411+
412+
return new Promise(resolve => setTimeout(() => {
413+
publishSpy = sandbox.spy(server.services.pubsub, 'publish');
414+
createMessageSpy = sandbox.spy(messageService, 'createTopic');
415+
resolve();
416+
}, 500));
417+
});
418+
419+
afterEach(() => {
420+
sandbox.restore();
421+
});
422+
423+
after(() => {
424+
mockRabbitMQ(server);
425+
});
426+
427+
it('should send message topic when work added', (done) => {
428+
const mockHttpClient = _.merge(testUtil.mockHttpClient, {
429+
post: () => Promise.resolve({
430+
status: 200,
431+
data: {
432+
id: 'requesterId',
433+
version: 'v3',
434+
result: {
435+
success: true,
436+
status: 200,
437+
content: {},
438+
},
439+
},
440+
}),
441+
});
442+
sandbox.stub(messageService, 'getClient', () => mockHttpClient);
443+
request(server)
444+
.post(`/v5/projects/${projectId}/workstreams/${workStreamId}/works`)
445+
.set({
446+
Authorization: `Bearer ${testUtil.jwts.connectAdmin}`,
447+
})
448+
.send(body)
449+
.expect(201)
450+
.end((err) => {
451+
if (err) {
452+
done(err);
453+
} else {
454+
testUtil.wait(() => {
455+
publishSpy.calledOnce.should.be.true;
456+
publishSpy.calledWith('project.phase.added').should.be.true;
457+
createMessageSpy.calledTwice.should.be.true;
458+
done();
459+
});
460+
}
461+
});
462+
});
463+
});
373464
});
374465
});

0 commit comments

Comments
 (0)