Merge pull request #1 from 6RiverSystems/add_headers

Add headers to change stream

Author: joshughes

.eslintrc

@@ -0,0 +1,3 @@
+{
+	"extends": "6river/typescript"
+}

.eslintrc.json

@@ -7,7 +7,7 @@ npm-debug.log*
 pids
 *.pid
 *.seed
-
+dist
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 

.gitignore

@@ -34,6 +34,9 @@ Add the following configuration to component-config.json:
         "Foo",
         "Bar",
         "Baz"
+      ],
+      "headers": [
+        "x-auth-request-user"
       ]
     },
     ...
@@ -47,6 +50,7 @@ The configuration parameters:
   * reconnectTimeout - instruct Browser to reconnect after this timeout if connection is lost;
   * responseTimeout - the response socket will be closed after this timeout;
   * models - array of model names to observe.
+	* headers - headers and values to embed in the stream metadata.
 
 The component configuration above adds 3 middleware rules:
   * GET "/api/updates" to connect some SourceEvent listener;
@@ -61,4 +65,3 @@ The following snippet can be used on client side to connect:
     ...
   });
   ```
-

README.md

@@ -7,3 +7,16 @@ dependencies:
     - node_modules
   override:
     - npm prune && npm install
+  pre:
+    - git clone --depth 1 git@github.com:6RiverSystems/infrastructure.git ~/infrastructure
+
+test:
+  post:
+    - ~/infrastructure/ci_scripts/release.sh
+
+deployment:
+  npm-publish:
+    branch: [master]
+    commands:
+    - echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+    - npm publish

circle.yml

@@ -5,6 +5,9 @@
 		"models": [
 			"Foo",
 			"Bar"
+		],
+		"headers": [
+			"x-auth-request-user"
 		]
 	}
 }

dist/component.js

@@ -42,6 +42,22 @@ describe('loopback-component-changestreamer', () => {
 				.expect(200, done);
 		});
 
+		it('set user headers', (done) => {
+			const fooID = uuid.v4();
+			let foo = {id: fooID, foo: 'habba'};
+			http.get(changesUrl, (res) => {
+				res.pipe(outStream);
+			});
+			request(app).post('/api/Foos')
+			  .set('X-Auth-Request-User','test@gmail.com')
+				.send(foo)
+				.expect(200)
+				.then(response => {
+					messages[1].should.equal(`data: {"seqNo":0,"modelName":"Foo","kind":"create","target":"${fooID}","meta":{"headers":{"x-auth-request-user":"test@gmail.com"}},"data":{"id":"${fooID}","foo":"habba"}}\n\n`);
+					done();
+				});
+		});
+
 		it('should write retry timout as first parameter', (done) => {
 			http.get(changesUrl, (res) => {
 				res.pipe(outStream);
@@ -55,7 +71,7 @@ describe('loopback-component-changestreamer', () => {
 	});
 
 	context('on model create', () => {
-		it('should write change event with kind kreate', (done) => {
+		it('should write change event with kind create', (done) => {
 			const fooID = uuid.v4();
 			const barID = uuid.v4();
 			http.get(changesUrl, (res) => {
@@ -68,8 +84,8 @@ describe('loopback-component-changestreamer', () => {
 			});
 			setTimeout(() => {
 				messages.length.should.be.equal(3);
-				messages[1].should.equal(`data: {"seqNo":0,"modelName":"Foo","kind":"create","target":"${fooID}","data":{"id":"${fooID}","foo":"habba"}}\n\n`);
-				messages[2].should.equal(`data: {"seqNo":1,"modelName":"Bar","kind":"create","target":"${barID}","data":{"id":"${barID}","bar":"bahha"}}\n\n`);
+				messages[1].should.equal(`data: {"seqNo":0,"modelName":"Foo","kind":"create","target":"${fooID}","meta":{"headers":[]},"data":{"id":"${fooID}","foo":"habba"}}\n\n`);
+				messages[2].should.equal(`data: {"seqNo":1,"modelName":"Bar","kind":"create","target":"${barID}","meta":{"headers":[]},"data":{"id":"${barID}","bar":"bahha"}}\n\n`);
 				done();
 			}, 2000);
 		});
@@ -114,7 +130,7 @@ describe('loopback-component-changestreamer', () => {
 				});
 				setTimeout(() => {
 					messages.length.should.be.equal(2);
-					messages[1].should.equal(`data: {"seqNo":2,"modelName":"Foo","kind":"update","target":"${fooID}","data":{"id":"${fooID}","foo":"baz"}}\n\n`);
+					messages[1].should.equal(`data: {"seqNo":2,"modelName":"Foo","kind":"update","target":"${fooID}","meta":{"headers":[]},"data":{"id":"${fooID}","foo":"baz"}}\n\n`);
 					done();
 				}, 2000);
 			});
@@ -128,7 +144,7 @@ describe('loopback-component-changestreamer', () => {
 				});
 				setTimeout(() => {
 					messages.length.should.be.equal(2);
-					messages[1].should.equal(`data: {"seqNo":2,"modelName":"Bar","kind":"remove","target":"${barID}","where":{"id":"${barID}"},"data":{"id":"${barID}","bar":"bar"}}\n\n`);
+					messages[1].should.equal(`data: {"seqNo":2,"modelName":"Bar","kind":"remove","target":"${barID}","where":{"id":"${barID}"},"meta":{"headers":[]},"data":{"id":"${barID}","bar":"bar"}}\n\n`);
 					done();
 				}, 2000);
 			});

dist/middleware.js

@@ -1,28 +1,25 @@
 {
-  "restApiRoot": "/api",
-  "host": "0.0.0.0",
-  "port": 3333,
-  "remoting": {
-    "context": {
-      "enableHttpContext": false
-    },
-    "rest": {
-      "normalizeHttpPath": false,
-      "xml": false
-    },
-    "json": {
-      "strict": false,
-      "limit": "100kb"
-    },
-    "urlencoded": {
-      "extended": true,
-      "limit": "100kb"
-    },
-    "cors": false,
-    "errorHandler": {
-      "disableStackTrace": false
-    }
-  },
-  "legacyExplorer": false
+	"restApiRoot": "/api",
+	"host": "0.0.0.0",
+	"port": 3333,
+	"remoting": {
+		"context": false,
+		"rest": {
+			"normalizeHttpPath": false,
+			"xml": false
+		},
+		"json": {
+			"strict": false,
+			"limit": "100kb"
+		},
+		"urlencoded": {
+			"extended": true,
+			"limit": "100kb"
+		},
+		"cors": false,
+		"errorHandler": {
+			"disableStackTrace": false
+		}
+	},
+	"legacyExplorer": false
 }
-