fix: do not specify handle as an output parameter when calling `sp_…

…execute`/`sp_unprepare` This was causing unexpected `returnValue` events.
tediousjs · Sep 20, 2021 · fe4bc69 · fe4bc69
1 parent 7aea4fa
commit fe4bc69
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 2 deletions.
diff --git a/src/connection.ts b/src/connection.ts
@@ -3011,7 +3011,7 @@ class Connection extends EventEmitter {
       name: 'handle',
       // TODO: Abort if `request.handle` is not set
       value: request.handle,
-      output: true,
+      output: false,
       length: undefined,
       precision: undefined,
       scale: undefined
@@ -3037,7 +3037,7 @@ class Connection extends EventEmitter {
       name: 'handle',
       // TODO: Abort if `request.handle` is not set
       value: request.handle,
-      output: true,
+      output: false,
       length: undefined,
       precision: undefined,
       scale: undefined

diff --git a/test/integration/prepare-execute-statements-test.js b/test/integration/prepare-execute-statements-test.js
@@ -63,6 +63,52 @@ describe('Prepare Execute Statement', function() {
     });
   });
 
+  it('does not cause unexpected `returnValue` events to be emitted', function(done) {
+    const config = getConfig();
+
+    const connection = new Connection(config);
+    connection.connect(function(err) {
+      if (err) {
+        return done(err);
+      }
+
+      /**
+       * @type {{ parameterName: string, value: unknown, metadata: import('../../src/metadata-parser').Metadata }[]}
+       */
+      const returnValues = [];
+
+      const request = new Request('select @param', function(err) {
+        if (err) {
+          return done(err);
+        }
+
+        assert.lengthOf(returnValues, 1);
+
+        connection.close();
+      });
+      request.addParameter('param', TYPES.Int);
+
+      request.on('prepared', function() {
+        assert.ok(request.handle);
+
+        assert.lengthOf(returnValues, 1);
+        assert.strictEqual(returnValues[0].parameterName, 'handle');
+
+        connection.execute(request, { param: 8 });
+      });
+
+      request.on('returnValue', (parameterName, value, metadata) => {
+        returnValues.push({ parameterName, value, metadata });
+      });
+
+      connection.prepare(request);
+    });
+
+    connection.on('end', function() {
+      done();
+    });
+  });
+
   it('does not leak memory via EventEmitter listeners when reusing a request many times', function(done) {
     const config = getConfig();