added svcapi ui and camunda code

[it/otf.git] / otf-frontend / server / src / agenda / result-emitter.js

diff --git a/otf-frontend/server/src/agenda/result-emitter.js b/otf-frontend/server/src/agenda/result-emitter.js
new file mode 100644 (file)
index 0000000..cdcf4af
--- /dev/null
+++ b/otf-frontend/server/src/agenda/result-emitter.js
@@ -0,0 +1,32 @@
+/*  Copyright (c) 2019 AT&T Intellectual Property.                             #\r
+#                                                                              #\r
+#   Licensed under the Apache License, Version 2.0 (the "License");            #\r
+#   you may not use this file except in compliance with the License.           #\r
+#   You may obtain a copy of the License at                                    #\r
+#                                                                              #\r
+#       http://www.apache.org/licenses/LICENSE-2.0                             #\r
+#                                                                              #\r
+#   Unless required by applicable law or agreed to in writing, software        #\r
+#   distributed under the License is distributed on an "AS IS" BASIS,          #\r
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #\r
+#   See the License for the specific language governing permissions and        #\r
+#   limitations under the License.                                             #\r
+##############################################################################*/\r
+\r
+\r
+const events = require('events');\r
+const eventEmitter = new events.EventEmitter();\r
+\r
+module.exports.emitter = eventEmitter;\r
+\r
+// @author: rp978t\r
+/* @description: This module serves as a common emitter to be used by\r
+ * the test execution controller and job definitions. The Agenda library\r
+ * only returns a job object when that object persists in the database.\r
+ * Therefore, there is no conventional way to return the response from\r
+ * the service api (inside the job definition) to the controller to be\r
+ * sent back to the user of the scheduling endpoint (In this case it would\r
+ * be the UI). Setting up a listener in the controller will allow emitting\r
+ * an event from the job definition to relay the response. Events are\r
+ * distinguished by using the job identifier as part of the event name.\r
+ */\r