feat(onvif-events): Add eventsError event

Author: agsh

Diff for: .github/workflows/npm.yml

@@ -0,0 +1,30 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

Diff for: .github/workflows/publish.yml

@@ -146,11 +146,13 @@ module.exports = function(Cam) {
 
 	/**
 	 * Renew pull-point subscription
-	 * @param {options} callback
-	 * @param {function} callback
+	 * @param {Object|Function} [options]
+	 * @param {Function} callback
 	 */
-
 	Cam.prototype.renew = function(options, callback) {
+		if (!callback) {
+			callback = options;
+		}
 		let urlAddress = null;
 		let subscriptionId = null;
 		try {
@@ -335,9 +337,7 @@ module.exports = function(Cam) {
 	 * @private
 	 */
 	function _terminationTime(response) {
-		let result = new Date(Date.now() - response.currentTime.getTime() + response.terminationTime.getTime());
-		// console.log("Events: Termination Time is " + result);
-		return result;
+		return new Date(Date.now() - response.currentTime.getTime() + response.terminationTime.getTime());
 	}
 
 	/**
@@ -351,12 +351,15 @@ module.exports = function(Cam) {
 				// if there is no pull-point subscription or it has expired, create new subscription
 				this.createPullPointSubscription(function(error) {
 					if (!error) {
+						delete this._eventReconnectms;
 						this._eventPull();
-					} else if (typeof error === 'object' && retryErrorCodes.includes( error.code)) {
-						// connection reset on creation - restart Event loop for pullMessages request
-						this._restartEventRequest();
+					} else {
+						this.emit('eventsError', error);
+						if (typeof error === 'object' && retryErrorCodes.includes(error.code)) {
+							// connection reset on creation - restart Event loop for pullMessages request
+							this._restartEventRequest();
+						}
 					}
-					console.log("Error: " + error.code);
 				}.bind(this));
 			} else {
 				this._eventPull();
@@ -376,10 +379,10 @@ module.exports = function(Cam) {
 		if (this.listeners('event').length && this.events.subscription) { // check for event listeners, if zero, or no subscription then stop pulling
 			this.pullMessages({
 				messageLimit: this.events.messageLimit
-			}, function(err, data, xml) {
-				if (!err) {
+			}, function(error, data, xml) {
+				if (!error) {
+					delete this._eventReconnectms;
 					if (data.notificationMessage) {
-						this._eventReconnectms = 0;
 						if (!Array.isArray(data.notificationMessage)) {
 							data.notificationMessage = [data.notificationMessage];
 						}
@@ -395,14 +398,15 @@ module.exports = function(Cam) {
 					this.events.terminationTime = _terminationTime(data); // Axis does not increment the termination time. Use RENEW. Vista returns a termination time with the time now (ie we have expired) even if there was still time left over. Use RENEW
 
 					// Axis cameras require us to Rewew the Pull Point Subscription
-					this.renew({},function(err,data) {
-						if (!err) {
+					this.renew({},function(error, data) {
+						if (!error) {
 							this.events.terminationTime = _terminationTime(data);
 						}
 						this._eventRequest();  // go around the loop again, once the RENEW has completed (and terminationTime updated)
 					});
 				} else {
-					if (typeof err === 'object' && err.code === 'ECONNRESET') {
+					this.emit('eventsError', error);
+					if (typeof error === 'object' && retryErrorCodes.includes(error.code)) {
 						// connection reset - restart Event loop for pullMessages request
 						this._restartEventRequest();
 					} else {

Diff for: lib/events.js

@@ -99,7 +99,13 @@ describe('Events', () => {
 			assert.ok(gotMessage === 11 || gotMessage === 12);
 			assert.ok(pullMessagesCallCount > gotMessage && pullMessagesCallCount > 20);
 			cam.removeListener('event', onEvent);
-			done();
+			cam.unsubscribe(done);
 		}, 1.5 * 1000);
 	});
+	it('should return an error when calling renew without subscription', (done) => {
+		cam.renew({}, (err) => {
+			assert.ok(err instanceof Error);
+			done();
+		});
+	});
 });