Restore 2.3 (#568)

* Add upgrading NPM to all workflows running older Node.js versions (#545) (#553) Also: * Add compatibility checks for Node.js v18 * Bump `actions/setup-node` to v3 Signed-off-by: Miki <[email protected]> * Add serialization and deserialization of numerals larger than `Number.MAX_SAFE_INTEGER` (#544) (#554) Signed-off-by: Miki <[email protected]> * Version Bump: 2.3.0 (#546) (#555) Signed-off-by: Theo Truong <[email protected]> * Make handling of long numerals an option that is disabled by default (#557) (#561) Also: * Strengthen the tests * update USER_GUIDE.md (cherry picked from commit 08069bc) Signed-off-by: Miki <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Version Bump: 2.3.1 Signed-off-by: Theo Truong <[email protected]> --------- Signed-off-by: Miki <[email protected]> Signed-off-by: Theo Truong <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Miki <[email protected]> Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Jul 18, 2023 · f9a2fe1 · f9a2fe1
1 parent 9ed86ee
commit f9a2fe1
Show file tree

Hide file tree

Showing 16 changed files with 523 additions and 15 deletions.
diff --git a/.github/workflows/bundler.yml b/.github/workflows/bundler.yml
@@ -30,10 +30,21 @@ jobs:
           make cluster.clean cluster.opensearch.build cluster.opensearch.start
 
       - name: Use Node.js 14.x
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 14.x
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install

diff --git a/.github/workflows/compatibility.yml b/.github/workflows/compatibility.yml
@@ -50,7 +50,7 @@ jobs:
           make cluster.clean cluster.opensearch.build cluster.opensearch.start
 
       - name: Use Node.js 16.x
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 16.x
 

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -23,10 +23,21 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install

diff --git a/.github/workflows/gh_pages.yml b/.github/workflows/gh_pages.yml
@@ -9,7 +9,7 @@ jobs:
     name: Update gh-pages with docs
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
           ruby-version: 16.x
       - name: Install Tools

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -17,7 +17,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -34,10 +34,21 @@ jobs:
           make cluster.clean cluster.opensearch.build cluster.opensearch.start
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install
@@ -52,7 +63,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -70,10 +81,21 @@ jobs:
           make cluster.clean cluster.opensearch.build cluster.opensearch.start
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install

diff --git a/.github/workflows/license.yml b/.github/workflows/license.yml
@@ -15,10 +15,21 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install

diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -18,17 +18,28 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
         os: [ubuntu-latest, windows-latest, macOS-latest]
 
     steps:
       - uses: actions/checkout@v2
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
+      # NPM started understanding yarn.lock file starting from v7
+      - name: Update NPM
+        shell: bash
+        run: |
+          export NPM_VERSION=$(npm -v)
+          export IS_NPM_SUITABLE=$(node -p "parseInt(process.env.NPM_ROOT, 10) >= 7")
+          if [ "$IS_NPM_SUITABLE" == "false" ]; then
+            echo "NPM needs upgrading!"
+            npm i npm@7 -g
+          fi
+
       - name: Install
         run: |
           npm install

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,35 @@
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
+### Added
+### Dependencies
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+## [2.3.1]
+### Added
+### Dependencies
+### Changed
+- Made the new Long Number logic added in 2.3.0 optional and disabled by default ([561](https://github.com/opensearch-project/opensearch-js/pull/561)
+### Deprecated
+### Removed
+### Fixed
+### Security
+
+## [2.3.0]
 
 ### Added
+
+- Add serialization and deserialization of numerals larger than `Number.MAX_SAFE_INTEGER` ([#544](https://github.com/opensearch-project/opensearch-js/pull/544))
+
 ### Dependencies
 ### Changed
+
+- Add upgrading NPM to all workflows running older Node.js versions ([#545](https://github.com/opensearch-project/opensearch-js/issues/545))
+
 ### Deprecated
 ### Removed
 ### Fixed
@@ -140,4 +165,5 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 [2.1.0]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.1.0
 [2.2.0]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.2.0
-[Unreleased]: https://github.com/opensearch-project/opensearch-js/compare/2.2.0...HEAD
+[2.3.0]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.3.0
+[Unreleased]: https://github.com/opensearch-project/opensearch-js/compare/2.3.0...HEAD
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -5,6 +5,7 @@
     - [Authenticate with Amazon OpenSearch Service](#authenticate-with-amazon-opensearch-service)
       - [Using AWS V2 SDK](#using-aws-v2-sdk)
       - [Using AWS V3 SDK](#using-aws-v3-sdk)
+    - [Enable Handling of Long Numerals](#enable-handling-of-long-numerals) 
   - [Create an Index](#create-an-index)
   - [Add a Document to the Index](#add-a-document-to-the-index)
   - [Search for the Document](#search-for-the-document)
@@ -107,6 +108,21 @@ const client = new Client({
 });
 ```
 
+### Enable Handling of Long Numerals
+
+JavaScript can safely work with integers from -(2<sup>53</sup> - 1) to 2<sup>53</sup> - 1. However, 
+serialized JSON texts from other languages can potentially have numeric values beyond that range and the native
+serialization and deserialization methods of JavaScript's JSON, incapable of parsing them with precision; these
+values get rounded to fit the IEEE-754 representation.
+
+The `Client` can be configured to appropriately deserialize long numerals as `BigInt` values and vice versa:
+
+```javascript
+const client = new Client({
+  enableLongNumeralSupport: true,
+});
+```
+
 ## Create an Index
 
 ```javascript

diff --git a/index.js b/index.js
@@ -128,6 +128,7 @@ class Client extends OpenSearchAPI {
               proxy: null,
               enableMetaHeader: true,
               disablePrototypePoisoningProtection: false,
+              enableLongNumeralSupport: false,
             },
             opts
           );
@@ -151,6 +152,7 @@ class Client extends OpenSearchAPI {
       this[kEventEmitter] = new EventEmitter();
       this.serializer = new options.Serializer({
         disablePrototypePoisoningProtection: options.disablePrototypePoisoningProtection,
+        enableLongNumeralSupport: options.enableLongNumeralSupport,
       });
       this.connectionPool = new options.ConnectionPool({
         pingTimeout: options.pingTimeout,

diff --git a/lib/Serializer.d.ts b/lib/Serializer.d.ts
@@ -29,6 +29,7 @@
 
 export interface SerializerOptions {
   disablePrototypePoisoningProtection: boolean | 'proto' | 'constructor';
+  enableLongNumeralSupport: boolean;
 }
 
 export default class Serializer {