chore: enable esModuleInterop #1751
Conversation
Summary of ChangesHello @taeold, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a significant configuration change by enabling Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enables esModuleInterop in the TypeScript configuration, which is a great step for improving interoperability between CommonJS and ES modules. The changes to update import statements across the codebase are well-executed and make the code cleaner. The refactoring is consistent and correctly applies the benefits of the new compiler option. Great work!
- Enable esModuleInterop in tsconfig.release.json for better CJS/ESM interop. - Update unit tests and source code to use default imports for CJS modules (fs, nock, jsonwebtoken, etc.) to align with new compiler settings.
taeold
force-pushed
the
chore/esModuleInterop
branch
from
5b19da6 to
f054321
Compare
- Enable esModuleInterop in tsconfig.release.json for better CJS/ESM interop. - Update unit tests and source code to use default imports for CJS modules (fs, nock, jsonwebtoken, express, etc.) to align with new compiler settings.
jhuleatt
left a comment
jhuleatt
left a comment
There was a problem hiding this comment.
There are still some namespace imports left. Do those need to be changed too, or are they left alone because they're compliant with the es module namespace import spec?
github-project-automation
bot
moved this to Approved [PR]
in [Cloud] Extensions + Functions
github-project-automation
bot
moved this from Approved [PR]
to Done
in [Cloud] Extensions + Functions
- Configure tsdown to build both CJS and ESM outputs. - Update package.json exports to support both 'require' and 'import'. - Fix type hygiene issues by using explicit 'export type'. - Update protos/update.sh to generate ESM version of compiledFirestore and fix its imports for Node.js compatibility. - Configure build aliases to handle relative paths to protos correctly in both CJS and ESM builds. - Add packaging integration test to CI. ~Note: I enabled `esModuleInterop` in tsconfig.release.json to support default imports from CommonJS modules (like cors), which is required for proper ESM interop. This caused some chain-effect that required updating several unit tests and source files to use default imports for other CJS dependencies (e.g., fs, nock, jsonwebtoken) to align with the new compiler configuration.~ Fixed in #1751.
* BREAKING: Upgrade TypeScript to v5.9.3 (#1746) Upgrades from TypeScript v4.3.5 to v5.9.3. All tests pass successfully. * BREAKING: Drop Node.js 14/16 support, require Node.js >=18 (#1747) * BREAKING: Drop Node.js 14/16 support, require Node.js >=18 - Update package.json engines to require Node.js >=18.0.0 - Upgrade @types/node from v14 to v18 - Update TypeScript target from ES2019 to ES2022 - Add useDefineForClassFields: false for backward compatibility - Update CI/CD workflows to test Node.js 18, 20, 22, and 24 - Set default CI/CD Node.js version to 24 - Update integration test documentation * BREAKING: remove functions.config() implementation (#1748) Replace functions.config() implementation with an error that provides clear migration guidance to the params module. This removes the deprecated API as planned for the next major release while helping developers migrate. The error message directs users to: https://firebase.google.com/docs/functions/config-env#migrate-config * chore: migrate to ESLint v9 and Flat Config (#1753) Upgraded eslint to v9 and replaced the legacy .eslintrc.js with the new eslint.config.js format. Applied minor fixes to 4 files (renaming unused catch variables to _e and one small refactor) to satisfy slightly stricter baseline rules from updated plugins. Mostly doing this due to our upgrade in TS to latest v5 version which the old versions of eslint ts plugins no longer support. * chore: enable esModuleInterop (#1751) * feat: add async error handling to onRequest (#1755) BREAKING CHANGE: Unhandled errors in async onRequest handlers now immediately return a 500 Internal Server Error instead of hanging until timeout. This may affect clients relying on 504 Gateway Timeout for retry logic. * BREAKING: Break TS build that uses functions.config() (#1757) Type out `functions.config()` API. Use of `functions.config()` API should now cause a BUILD error at compile time. ```ts import * as functions from "firebase-functions"; import {onRequest} from "firebase-functions/https"; import * as logger from "firebase-functions/logger"; const cfg = functions.config() export const helloWorld = onRequest((request, response) => { logger.info("Hello logs!", cfg); response.send("Hello from Firebase!"); }); ``` ```bash $ npm run build > build > tsc src/index.ts:5:23 - error TS2349: This expression is not callable. Type 'never' has no call signatures. 5 const cfg = functions.config() ~~~~~~ Found 1 error in src/index.ts:5 ``` * Add Firebase Data Connect v2 support (#1727) * Add Firebase Data Connect v2 support * Export dataconnect * Fix export * Rename Extract to VarName, since Extract is a built in type * Include auth context in event payload * Stronger typing for data connect params * Fix formatting and address comments * Apply another suggestion * Add region and fix bug in which event.service, event.connector, event.operation gets populated * Remove locations/... segment * Address comments * Fix linter * feat: enable ESM support via dual-publishing (#1750) - Configure tsdown to build both CJS and ESM outputs. - Update package.json exports to support both 'require' and 'import'. - Fix type hygiene issues by using explicit 'export type'. - Update protos/update.sh to generate ESM version of compiledFirestore and fix its imports for Node.js compatibility. - Configure build aliases to handle relative paths to protos correctly in both CJS and ESM builds. - Add packaging integration test to CI. ~Note: I enabled `esModuleInterop` in tsconfig.release.json to support default imports from CommonJS modules (like cors), which is required for proper ESM interop. This caused some chain-effect that required updating several unit tests and source files to use default imports for other CJS dependencies (e.g., fs, nock, jsonwebtoken) to align with the new compiler configuration.~ Fixed in #1751. * lock down permission per GitHub alert. * update lint rule to enforce prettier rules. * chore: update CHANGELOG for v7.0.0 * format. --------- Co-authored-by: Lisa Jian <[email protected]>
2 participants
Changes are in preparation for ESM publishing for Functions SDK. Enablign
esModuleInteropshould align the codebase's import style to better match how nodejs supports default imports from "legacy" commonjs only modules like express.Note: I also updated all
fsimport to use default import style. Default import enables fs module to be mocked.