BUG#34970001: move getAffectedItems() to SqlResult

The "RowResult" API is used to encapsulate the result set and
corresponding execution details of a data retrieval statement built
using the "Table.select()" API. This type of statements should not yield
any kind of side effects, including modifying data in the table, thus,
the outcome will not result in any affected items.

However, the "RowResult" API includes an extraneous "getAffectedItems()"
method, which is useless, given that it will always return 0. This
method is only relevant for the case where the statement is created
using raw SQL, in which case, the "Result" instance is not aware about
the type of statement that it yields from. A "SELECT" will not affect
any items, whereas an "UPDATE", "DELETE" or "INSERT" will.

This patch removes the "getAffectedItems()" from the "RowResult" API
whilst ensuring it is still available for results of executing a raw SQL
statement, via the corresponding "SqlResult" API.

Change-Id: I65d48a0cbde4a4452f1cc141e65fd80f985cac38

Author: ruiquelhas

lib/DevAPI/RowResult.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -30,7 +30,6 @@
 
 'use strict';
 
-const uint64 = require('../Protocol/Wrappers/ScalarValues/uint64');
 const column = require('./Column');
 const baseResult = require('./BaseResult');
 
@@ -59,15 +58,6 @@ const baseResult = require('./BaseResult');
 function RowResult ({ index = 0, integerType, metadata = [], results = [], rowsAffected = 0n, warnings } = {}) {
     return {
         ...baseResult({ warnings }),
-        /**
-         * Retrieve the number of documents affected by the operation.
-         * @function
-         * @name module:RowResult#getAffectedItemsCount
-         * @returns {number} The number of rows.
-         */
-        getAffectedItemsCount () {
-            return uint64.create(rowsAffected, { type: integerType }).valueOf();
-        },
 
         /**
          * Consume the current result set from memory (and flush it).

lib/DevAPI/SqlResult.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -59,6 +59,16 @@ const rowResult = require('./RowResult');
 function SqlResult ({ generatedInsertId = 0n, integerType, metadata, results, rowsAffected, warnings } = {}) {
     return {
         ...rowResult({ integerType, metadata, results, rowsAffected, warnings }),
+        /**
+         * Retrieve the number of documents affected by the operation.
+         * @function
+         * @name module:RowResult#getAffectedItemsCount
+         * @returns {number} The number of rows.
+         */
+        getAffectedItemsCount () {
+            return uint64.create(rowsAffected, { type: integerType }).valueOf();
+        },
+
         /**
          * Retrieve the first <code>AUTO INCREMENT</code> value generated by the statement.
          * @function

test/unit/DevAPI/RowResult.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2018, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -32,7 +32,6 @@
 
 /* eslint-env node, mocha */
 
-const IntegerType = require('../../../lib/Protocol/Wrappers/ScalarValues/int64').Type;
 const expect = require('chai').expect;
 const rowResult = require('../../../lib/DevAPI/RowResult');
 const td = require('testdouble');
@@ -134,42 +133,6 @@ describe('RowResult', () => {
         });
     });
 
-    context('getAffectedItemsCount()', () => {
-        context('when the number of affected items by the statement is below Number.MAX_SAFE_INTEGER', () => {
-            it('returns the value as a JavaScript number by default', () => {
-                expect(rowResult({ rowsAffected: 3n }).getAffectedItemsCount()).to.equal(3);
-            });
-
-            it('can return the value as a JavaScript string', () => {
-                expect(rowResult({ rowsAffected: 3n, integerType: IntegerType.STRING }).getAffectedItemsCount()).to.equal('3');
-            });
-
-            it('can return the value as a JavaScript BigInt', () => {
-                expect(rowResult({ rowsAffected: 3n, integerType: IntegerType.BIGINT }).getAffectedItemsCount()).to.equal(3n);
-            });
-
-            it('ignores a specific return type for unsafe integers', () => {
-                expect(rowResult({ rowsAffected: 3n, integerType: IntegerType.UNSAFE_BIGINT }).getAffectedItemsCount()).to.equal(3);
-                expect(rowResult({ rowsAffected: 3n, integerType: IntegerType.UNSAFE_STRING }).getAffectedItemsCount()).to.equal(3);
-            });
-        });
-
-        context('when the number of affected items by the statement is above Number.MAX_SAFE_INTEGER', () => {
-            it('returns the value as a JavaScript string by default', () => {
-                expect(rowResult({ rowsAffected: 18446744073709551615n }).getAffectedItemsCount()).to.equal('18446744073709551615');
-            });
-
-            it('returns the value as a JavaScript string if explicitly specified', () => {
-                expect(rowResult({ rowsAffected: 18446744073709551615n, integerType: IntegerType.UNSAFE_STRING }).getAffectedItemsCount()).to.equal('18446744073709551615');
-            });
-
-            it('can return the value as a JavaScript BigInt', () => {
-                expect(rowResult({ rowsAffected: 18446744073709551615n, integerType: IntegerType.BIGINT }).getAffectedItemsCount()).to.equal(18446744073709551615n);
-                expect(rowResult({ rowsAffected: 18446744073709551615n, integerType: IntegerType.UNSAFE_BIGINT }).getAffectedItemsCount()).to.equal(18446744073709551615n);
-            });
-        });
-    });
-
     context('getColumns()', () => {
         let getAlias;
 

types/lib/DevAPI/RowResult.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -50,11 +50,6 @@ interface RowResult extends BaseResult {
      * column that is part of the projection or aggregation.
      */
     fetchOne: () => Scalar[]
-    /**
-     * Retrieves the number of items affected by the statement.
-     * @returns The total number of items affected by the statement.
-     */
-    getAffectedItemsCount: () => number
     /**
      * Retrieves the first `AUTO INCREMENT` value generated by the statement.
      * @returns The first `AUTO INCREMENT` value.

types/lib/DevAPI/SqlResult.d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -34,6 +34,11 @@ import RowResult from './RowResult';
  * Result set type generated by executing SQL statements with `Session.sql()`.
  */
 interface SqlResult extends RowResult {
+    /**
+     * Retrieves the number of items affected by the statement.
+     * @returns The total number of items affected by the statement.
+     */
+    getAffectedItemsCount: () => number
     /**
      * Retrieves the first `AUTO INCREMENT` value generated by the statement.
      * @returns The first `AUTO INCREMENT` value.

types/test/DevAPI/RowResult.test-d.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2023, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -50,9 +50,6 @@ async function test (): Promise<void> {
     // fetchOne()
     expectType<Scalar[]>(result.fetchOne());
 
-    // getAffectedItemsCount()
-    expectType<number>(result.getAffectedItemsCount());
-
     // getAutoIncrementValue()
     expectType<number>(result.getAutoIncrementValue());