feat: add ESM tools in gax #1459

ddelgrosso1 · 2023-06-20T15:55:05Z

This PR does the following:

Adds 3 babel plugins to help transform ESM code to CJS: one to transform path.dirname(fileURLToPath(import.meta) to __dirname, another to turn isEsm to false, and lastly a final one to turn proxyquire into esmock.
Adds an ESM-path in compileProtos (searches for source code one level deeper, and generates protos.js and protos.cjs in es6 and amd, respectively)

ddelgrosso1 · 2023-06-20T15:55:35Z

Want to get some eyes on this before I dive deeper into other transformations. Will this be acceptable for our needs?

sofisl · 2023-06-20T16:56:22Z

Thanks @ddelgrosso1, this is looking awesome! A few questions/things that I think this still needs to do:

Hopefully this transform will rename .js file extensions in the build/cjs directory to .cjs
It would change this variable to false, if compiling from tsconfig.json: https://github.com/googleapis/google-cloud-node/blob/6dc9253cda1931d9c9538364d8ddb0c592b9dc69/packages/google-cloud-billing/esm/src/v1/cloud_catalog_client.ts#L170
It would rename the esm aspect in all of these paths: https://github.com/googleapis/google-cloud-node/pull/4354/files to cjs when compiling to commonJS

ddelgrosso1 · 2023-06-22T15:09:12Z

@sofisl regarding your points above 1. I think this can be handled by specifying the appropriate babel cli arguments and won't require custom plugin code. 2. Changing the variable should be easy but are you saying we need to be aware when a tsconfig is in use? If so, that might prove more challenging. 3. Let me look into this one further.

sofisl · 2023-06-28T17:00:47Z

@ddelgrosso1 awesome! For #2, ideally we'd know whether we compiled using tsconfig.esm, and that would determine whether that variable was true or not.

…tools

…ools

danielbankhead · 2023-09-07T17:29:20Z

tools/test/compileProtos.ts

+    assert(ts.toString().includes('import Long = require'));
+    assert(!ts.toString().includes('import * as Long'));


Just curious - would import Long from work here?

Good call out! I think it would, but I'm just looking to preserve functionality here, since I'm not making any changes to the .ts file.

…o esm-cjs-tools

alexander-fenster · 2023-09-18T17:28:25Z

tools/src/compileProtos.ts

@@ -163,6 +163,13 @@ function updateDtsTypes(dts: string, enums: Set<string>): string {
 }

 function fixJsFile(js: string): string {
+  // 1. fix protobufjs import: we don't want the libraries to


super nit but let's either make this "0." or increment the numbers below :)

alexander-fenster · 2023-09-18T17:28:45Z

tools/src/compileProtos.ts

+  // depend on protobufjs, so we re-export it from google-gax
+  js = js.replace(
+    'import * as $protobuf from "protobufjs/minimal"',
+    'import { protobufMinimal  as $protobuf} from "google-gax/build/src/protobuf.js"'


nit: formatting, remove space after {

feat!: publish protos.js using es6 and amd, if needed

1b53525

product-auto-label bot added the size: s Pull request size is small. label Jun 20, 2023

ddelgrosso1 requested review from sofisl and bcoe June 20, 2023 15:55

ddelgrosso1 force-pushed the esm-cjs-tools branch from 222cbb6 to acb7493 Compare June 20, 2023 15:56

product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Jun 20, 2023

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Jun 22, 2023

ddelgrosso1 added 2 commits July 19, 2023 13:47

feat: add babel transform for import.meta.url

7266376

add transformer for esm mocking lib

5a2916e

ddelgrosso1 force-pushed the esm-cjs-tools branch from 74998cd to 5a2916e Compare July 19, 2023 13:48

ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 19, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 19, 2023

ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 19, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 19, 2023

add transform for toggling isEsm flag

112b3d9

ddelgrosso1 force-pushed the esm-cjs-tools branch from 43ee800 to 112b3d9 Compare July 19, 2023 15:35

sofisl and others added 8 commits August 22, 2023 16:51

Merge branch 'main' of github.com:googleapis/gax-nodejs into esm-cjs-…

3a3dd27

…tools

Merge remote-tracking branch 'upstream/main' into esm-cjs-tools

4c8f319

Merge remote-tracking branch 'upstream/updateProtosJs' into esm-cjs-t…

6721dd0

…ools

build: update branch and update buildListOfProtos func

9abbdc9

save for now

1416fb6

feat: add babel transform for import.meta.url

d63460b

add transformer for esm mocking lib

6f683af

add transform for toggling isEsm flag

c7514b4

danielbankhead reviewed Sep 7, 2023

View reviewed changes

danielduhh approved these changes Sep 8, 2023

View reviewed changes

danielbankhead approved these changes Sep 11, 2023

View reviewed changes

sofisl added 2 commits September 11, 2023 20:12

Merge branch 'esm-cjs-tools' of github.com:ddelgrosso1/gax-nodejs int…

83f0cc1

…o esm-cjs-tools

remove path matching

54ce22e

ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Sep 12, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Sep 12, 2023

alexander-fenster reviewed Sep 18, 2023

View reviewed changes

alexander-fenster approved these changes Sep 18, 2023

View reviewed changes

sofisl and others added 5 commits September 18, 2023 11:45

Update compileProtos.ts

c8eea35

Update compileProtos.ts

dc31cd2

Merge branch 'main' into esm-cjs-tools

9bd5c37

chore: update compilePrtotos

645f063

Merge branch 'main' into esm-cjs-tools

3b2769d

sofisl approved these changes Sep 19, 2023

View reviewed changes

sofisl added automerge Merge the pull request once unit tests and other checks pass. owlbot:run Add this label to trigger the Owlbot post processor. labels Sep 19, 2023

gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Sep 19, 2023

gcf-merge-on-green bot merged commit 0fb1cf9 into googleapis:main Sep 19, 2023
18 checks passed

gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Sep 19, 2023

release-please bot mentioned this pull request Sep 19, 2023

chore(main): release 4.1.0 #1499

Closed

ddelgrosso1 deleted the esm-cjs-tools branch September 19, 2023 14:17

sofisl mentioned this pull request Sep 19, 2023

chore: release main #1502

Closed

sofisl added the release-please:force-run To run release-please label Sep 19, 2023

release-please bot removed the release-please:force-run To run release-please label Sep 19, 2023

release-please bot mentioned this pull request Sep 19, 2023

chore: release main #1504

Merged

sofisl added the release-please:force-run To run release-please label Sep 19, 2023

release-please bot removed the release-please:force-run To run release-please label Sep 19, 2023

release-please bot mentioned this pull request Jan 12, 2024

chore: release main #1537

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add ESM tools in gax #1459

feat: add ESM tools in gax #1459

ddelgrosso1 commented Jun 20, 2023 •

edited by sofisl

ddelgrosso1 commented Jun 20, 2023

sofisl commented Jun 20, 2023

ddelgrosso1 commented Jun 22, 2023

sofisl commented Jun 28, 2023

danielbankhead Sep 7, 2023

sofisl Sep 12, 2023

alexander-fenster Sep 18, 2023

alexander-fenster Sep 18, 2023

		assert(ts.toString().includes('import Long = require'));
		assert(!ts.toString().includes('import * as Long'));

feat: add ESM tools in gax #1459

feat: add ESM tools in gax #1459

Conversation

ddelgrosso1 commented Jun 20, 2023 • edited by sofisl

ddelgrosso1 commented Jun 20, 2023

sofisl commented Jun 20, 2023

ddelgrosso1 commented Jun 22, 2023

sofisl commented Jun 28, 2023

danielbankhead Sep 7, 2023

Choose a reason for hiding this comment

sofisl Sep 12, 2023

Choose a reason for hiding this comment

alexander-fenster Sep 18, 2023

Choose a reason for hiding this comment

alexander-fenster Sep 18, 2023

Choose a reason for hiding this comment

ddelgrosso1 commented Jun 20, 2023 •

edited by sofisl