chore!: migrate gax to Node 18 #1699

sofisl · 2025-02-05T08:48:17Z

For gax and tools directory:

runs https://paste.googleplex.com/5722106875871232
updates all dependencies to their latest version if compatible
updates CI/CD and Kokoro to use Node 18
runs lint
updates post-processor version to latest
removes outdated Kokoro folders
additionally, migrates webpack to v5 in order to support modern JS conventions
adds exports subpaths (Fixes use subpath exports #1337)
does not upgrade auth to 10 (will do so in separate PR)
migrates us to node-fetch v3

generated-files-bot · 2025-02-05T08:56:27Z

Warning: This pull request is touching the following templated files:

.kokoro/common.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/continuous/node14/common.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/continuous/node14/lint.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/continuous/node14/samples-test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/continuous/node14/system-test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/continuous/node14/test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/presubmit/node14/common.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/presubmit/node14/samples-test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/presubmit/node14/system-test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/presubmit/node14/test.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/release/docs.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/release/publish.cfg - .kokoro files are templated and should be updated in synthtool
.kokoro/samples-test.sh - .kokoro files are templated and should be updated in synthtool
.kokoro/system-test.sh - .kokoro files are templated and should be updated in synthtool
.kokoro/test.bat - .kokoro files are templated and should be updated in synthtool
.kokoro/test.sh - .kokoro files are templated and should be updated in synthtool
.github/workflows/ci.yaml - .github/workflows/ci.yaml (GitHub Actions) should be updated in synthtool

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…to migrateToNode18

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

…odejs into migrateToNode18

d-goog · 2025-02-13T17:31:06Z

gax/package.json

@@ -10,61 +10,62 @@
    "!build/src/**/*.map"
  ],
  "dependencies": {
-    "@grpc/grpc-js": "^1.10.9",
+    "@grpc/grpc-js": "^1.12.6",
    "@grpc/proto-loader": "^0.7.13",
    "@types/long": "^5.0.0",
    "abort-controller": "^3.0.0",


This is global in Node 18+; we can drop this dependency in this or separate PR.

Looking through the code, I believe this is only used in browser-contexts.

d-goog · 2025-02-13T17:32:40Z

gax/package.json

-    "duplexify": "^4.0.0",
-    "google-auth-library": "^9.3.0",
+    "duplexify": "^4.1.3",
+    "google-auth-library": "^9.15.1",
    "node-fetch": "^2.7.0",


We will need this bumped to v3 in order to avoid punycode warnings in Node v22. Here are a few examples:

DeprecationWarning: The punycode module is deprecated. Please use a userland alternative instead google-auth-library-nodejs#1829

punycode deprecation warning gaxios#640

Here’s an example migration:

feat!: Upgrade to node-fetch v3 gaxios#617

d-goog · 2025-02-13T17:33:54Z

gax/package.json

-    "protobufjs": "^7.3.2"
+    "protobufjs": "^7.4.0",
+    "retry-request": "^7.0.2",
+    "uuid": "^11.0.5"


UUID is globally available as of Node 18+. Here’s how we can drop this dependency:

https://github.com/googleapis/gaxios/blob/d3cb530430a1896f8292c218246763b53aa78097/src/gaxios.ts#L33

d-goog · 2025-02-13T17:35:01Z

gax/package.json

  },
  "devDependencies": {
-    "@types/uuid": "^9.0.7",
    "@babel/plugin-proposal-private-methods": "^7.18.6",


We should be good to remove this now in Node 18+

d-goog · 2025-02-13T17:40:18Z

gax/src/iamService.ts

@@ -15,6 +15,7 @@
 // ** This file is automatically generated by gapic-generator-typescript. **
 // ** https://github.com/googleapis/gapic-generator-typescript **
 // ** All changes to this file may be overwritten. **
+/* eslint-disable @typescript-eslint/no-floating-promises */


I think these should be handled rather than ignored - even if its adding .catch(console.error).

d-goog · 2025-02-13T17:46:17Z

gax/test/browser-test/tsconfig.json

@@ -4,10 +4,11 @@
    "rootDir": ".",
    "outDir": "build",
    "resolveJsonModule": true,
-    "lib": ["ES2018", "DOM"]
+    "lib": ["DOM"]


We may want ES2023 for language support, in case upstream dependencies use newer syntax or features.

We get this for free since it inherits from the top-level config!

d-goog · 2025-02-13T17:54:54Z

package.json

@@ -15,7 +15,7 @@
    "url": "https://github.com/googleapis/gax-nodejs/issues"
  },


[Optional] We can use npm workspaces now:

https://docs.npmjs.com/cli/v7/using-npm/workspaces

Which has the benefit of enabling top-level tests for all workspaces/packages among other features.

hm good call! Maybe a good process request?

d-goog

LGTM!

d-goog · 2025-02-19T22:39:58Z

A quick note, this PR may also close:

sofisl added 2 commits February 5, 2025 00:46

chore!: migrate gax to Node 18

5817b0c

cleanup

0645b00

sofisl requested review from a team as code owners February 5, 2025 08:48

product-auto-label bot added the size: m Pull request size is medium. label Feb 5, 2025

chore: upgrade to node 18

25cec21

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Feb 5, 2025

🦉 Updates from OwlBot post-processor

e4bb773

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

product-auto-label bot added size: m Pull request size is medium. and removed size: l Pull request size is large. labels Feb 5, 2025

sofisl and others added 18 commits February 5, 2025 01:05

migrate to node 18

bb2ffee

Merge branch 'migrateToNode18' of github.com:googleapis/gax-nodejs in…

5c0f1e2

…to migrateToNode18

downgrade dep

d6cf4a2

update package.json

5c3bb9e

downgrade dep

41e6f43

chore: update to node-feth v3 and fix typings issues

77a09d9

downgrade execa

f0f5b2f

try to make node-fetch v3 work

8557dda

update node version

eb21931

update regapic

4417e51

chore: update regapic imports

fafdf8d

reconfigure mocking

2998c86

chore: use node-fetch v3

f513fc5

Update CODEOWNERS

0146332

Update release-trigger.yml

aee4167

🦉 Updates from OwlBot post-processor

1f59b35

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

🦉 Updates from OwlBot post-processor

f9f4fba

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Merge branch 'migrateToNode18' of https://github.com/googleapis/gax-n…

f97d5b1

…odejs into migrateToNode18

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Feb 12, 2025

sofisl added 9 commits February 12, 2025 22:45

fix: upgrade webpack to v5 to match the new typescript version

2286d63

run lint

11d5c64

attempt to fix linting problem

ebb485f

remove floating promises TS error for tests

c2eacde

add @ sign to disable linting

93cdeaf

chore: migrate tools to node 18 as well

fd809ce

downgrade walkup

3bd82aa

run lint

75deabf

fix lint

99825f5

d-goog reviewed Feb 13, 2025

View reviewed changes

sofisl added 4 commits February 14, 2025 17:14

attempt to upgrade node-fetch to v3

2d48dbb

run lint

b76905c

readd abort controller

0696ae5

readd abort controller in test

45fc98f

sofisl requested a review from d-goog February 15, 2025 01:39

sofisl mentioned this pull request Feb 15, 2025

[Optional] We can use npm workspaces now: #1701

Open

sofisl and others added 6 commits February 14, 2025 18:02

run lint

d3aa828

run lint

b6f2d83

fix tests

6bdcbd0

fix tests

f047cf8

run lint

4ea8b2b

Merge branch 'main' into migrateToNode18

c40b9b9

d-goog approved these changes Feb 15, 2025

View reviewed changes

upgradependencies

c90e574

sofisl merged commit fc3eeaa into main Feb 19, 2025
27 checks passed

sofisl deleted the migrateToNode18 branch February 19, 2025 23:30

release-please bot mentioned this pull request Feb 14, 2025

chore: release main #1697

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore!: migrate gax to Node 18 #1699

chore!: migrate gax to Node 18 #1699

sofisl commented Feb 5, 2025 •

edited

Loading

generated-files-bot bot commented Feb 5, 2025 •

edited

Loading

d-goog Feb 13, 2025

sofisl Feb 15, 2025

d-goog Feb 13, 2025

d-goog Feb 13, 2025

d-goog Feb 13, 2025

d-goog Feb 13, 2025

d-goog Feb 13, 2025

sofisl Feb 15, 2025

d-goog Feb 13, 2025

sofisl Feb 15, 2025

d-goog left a comment

d-goog commented Feb 19, 2025 •

edited

Loading

		@@ -15,7 +15,7 @@
		"url": "https://github.com/googleapis/gax-nodejs/issues"
		},

chore!: migrate gax to Node 18 #1699

chore!: migrate gax to Node 18 #1699

Conversation

sofisl commented Feb 5, 2025 • edited Loading

generated-files-bot bot commented Feb 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d-goog left a comment

Choose a reason for hiding this comment

d-goog commented Feb 19, 2025 • edited Loading

sofisl commented Feb 5, 2025 •

edited

Loading

generated-files-bot bot commented Feb 5, 2025 •

edited

Loading

d-goog commented Feb 19, 2025 •

edited

Loading