feat!: move @google-cloud/translate to ESM and Node 14 #4189
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| const config = { | ||
| "enable-source-maps": true, | ||
| "throw-deprecation": true, | ||
| "timeout": 10000, | ||
| "recursive": true | ||
| } | ||
| if (process.env.MOCHA_THROW_DEPRECATION === 'false') { | ||
| delete config['throw-deprecation']; | ||
| } | ||
| if (process.env.MOCHA_REPORTER) { | ||
| config.reporter = process.env.MOCHA_REPORTER; | ||
| } | ||
| if (process.env.MOCHA_REPORTER_OUTPUT) { | ||
| config['reporter-option'] = `output=${process.env.MOCHA_REPORTER_OUTPUT}`; | ||
| } | ||
| module.exports = config |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,4 +14,4 @@ | |
|
|
||
| module.exports = { | ||
| ...require('gts/.prettierrc.json') | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment. If we decide that using a post compile step is the best path forward it would probably make sense to extract this to some kind of utility repo so that it is reusable. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // ** This file is automatically generated by gapic-generator-typescript. ** | ||
| // ** https://github.com/googleapis/gapic-generator-typescript ** | ||
| // ** All changes to this file may be overwritten. ** | ||
|
|
||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; | ||
| const fsp = fs.promises; | ||
|
|
||
| const regexMetaInput = | ||
| /let dirToUse = '';\ntry {\n {4}dirToUse = __dirname;\n\}\ncatch \(e\) \{\n {4}\/\/ eslint-disable-next-line @typescript-eslint\/ban-ts-comment\n {4}\/\/ @ts-ignore\n {4}dirToUse = import\.meta\.url;\n\}\nconst filename = \(0, url_1\.fileURLToPath\)\(dirToUse\);\nconst dirname = path_1\.default\.dirname\(filename\);/i; | ||
|
There was a problem hiding this comment. This regex seems pretty fragile, I'm betting when we update to a new typescript version at some point it will stop working silently. I'll leave a comment further down in code review. |
||
| // eslint-disable-next-line no-useless-escape | ||
| const regexJsExtension = /\.js\"/g; | ||
| // eslint-disable-next-line no-useless-escape | ||
| const regexJsExtensionSingleQuote = /\.js\'/g; | ||
| const awaitEsmock = /await esmock/g; | ||
| const protosHackregex = /protos-hack/g; | ||
| const esmock = /esmock/g; | ||
| async function modifyCJSDir(dirNameReadAbsolute) { | ||
| const files = fs.readdirSync(dirNameReadAbsolute); | ||
| for (const file of files) { | ||
| const fileName = file.toString(); | ||
|
|
||
| const readName = path.join(dirNameReadAbsolute, fileName); | ||
|
|
||
| if (fs.statSync(readName).isFile()) { | ||
| if (!readName.includes('protos')) { | ||
| let fileContents = await fsp.readFile(readName, 'utf-8'); | ||
| if (readName.endsWith('.js')) { | ||
| fileContents = fileContents.replace( | ||
| regexMetaInput, | ||
| 'const dirname = __dirname' | ||
| ); | ||
| fileContents = fileContents.replace(esmock, 'proxyquire'); | ||
| fileContents = fileContents.replace(awaitEsmock, 'proxyquire'); | ||
| if (fileName !== 'install.js') { | ||
| fileContents = fileContents.replace(regexJsExtension, '.cjs"'); | ||
| fileContents = fileContents.replace( | ||
| regexJsExtensionSingleQuote, | ||
| ".cjs'" | ||
| ); | ||
| } | ||
| fileContents = fileContents.replace(protosHackregex, 'protos'); | ||
| await fsp.writeFile(readName.replace(/.js$/, '.cjs'), fileContents); | ||
| await fsp.unlink(readName); | ||
| } | ||
| } else { | ||
| await fsp.rename(readName, readName.replace(/\.js$/, '.cjs')); | ||
| } | ||
| } else if (fs.statSync(readName).isDirectory()) { | ||
| modifyCJSDir(readName); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| modifyCJSDir('./build/cjs'); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
More of a review of the idea implemented here and less on this specific implementation but conceptually I believe unit tests will benefit less from running on the multiple module system targets. In comparison end-to-end test tend to benefit more since they're testing that all parts together are working as expected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree! Unfortunately our system tests won't test ESM, since they use a testing harness called pack-n-play that essentially creates a CJS package and installs our libraries as dependencies. However, in the PR body I describe what we can do to modify that harness to test in ESM as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I think would be best would be to extend pack-n-play to test the ESM build of the package, at this point we could run unit tests against just ESM or CJS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep! That's what I suggest in #3 in the PR body!