Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Swap emulator Node runtime discovery to favor local cache #2740

Merged
merged 12 commits into from
Oct 28, 2020
Merged

Swap emulator Node runtime discovery to favor local cache #2740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b7fb744
Fixes passing flags to firepit node shim
abeisgoat Jun 2, 2020
331233c
Remove indent
abeisgoat Jun 2, 2020
a0543fb
Adds comments
abeisgoat Jun 2, 2020
d5746f4
Merge branch 'master' of https://github.com/firebase/firebase-tools
abeisgoat Oct 23, 2020
7f7f8c2
Patch emulator node runtime discovery to favor local cache
abeisgoat Oct 23, 2020
34d34aa
Adds warning when attempting to inspect functions under firepit
abeisgoat Oct 23, 2020
76588b4
Changelog
abeisgoat Oct 28, 2020
e7a7679
Simplify code
abeisgoat Oct 28, 2020
d825c18
Merge branch 'master' into ah/functions-emulator-discover-npm-node
abeisgoat Oct 28, 2020
5266a85
Add number to changelog
abeisgoat Oct 28, 2020
3743e13
Merge branch 'ah/functions-emulator-discover-npm-node' of https://git…
abeisgoat Oct 28, 2020
29e4152
Merge branch 'master' into ah/functions-emulator-discover-npm-node
abeisgoat Oct 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Fixes Cloud Function inspection when using standalone binary release (#2740)
36 changes: 26 additions & 10 deletions src/emulator/functionsEmulator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,14 @@ export class FunctionsEmulator implements EmulatorInstance {
disabled_features: this.args.disabledRuntimeFeatures,
};
}
/**
* Returns a node major version ("10", "8") or null
* @param frb the current Functions Runtime Bundle
*/
getRequestedNodeRuntimeVersion(frb: FunctionsRuntimeBundle): string | undefined {
const pkg = require(path.join(frb.cwd, "package.json"));
return frb.nodeMajorVersion || (pkg.engines && pkg.engines.node);
}
/**
* Returns the path to a "node" executable to use.
* @param cwd the directory to checkout for a package.json file.
Expand Down Expand Up @@ -707,24 +715,24 @@ export class FunctionsEmulator implements EmulatorInstance {
// Will happen if we haven't asked about local version yet
}

// If the requested version is the same as the host, let's use that
if (requestedMajorVersion === hostMajorVersion) {
// If the requested version is already locally available, let's use that
if (requestedMajorVersion === localMajorVersion) {
this.logger.logLabeled(
"SUCCESS",
"functions",
`Using node@${requestedMajorVersion} from host.`
`Using node@${requestedMajorVersion} from local cache.`
);
return process.execPath;
return localNodePath;
}

// If the requested version is already locally available, let's use that
if (localMajorVersion === requestedMajorVersion) {
// If the requested version is the same as the host, let's use that
if (requestedMajorVersion === hostMajorVersion) {
this.logger.logLabeled(
"SUCCESS",
"functions",
`Using node@${requestedMajorVersion} from local cache.`
`Using node@${requestedMajorVersion} from host.`
);
return localNodePath;
return process.execPath;
}

// Otherwise we'll begin the conversational flow to install the correct version locally
Expand All @@ -750,8 +758,16 @@ export class FunctionsEmulator implements EmulatorInstance {
}

if (this.args.debugPort) {
const { host } = this.getInfo();
args.unshift(`--inspect=${host}:${this.args.debugPort}`);
if (process.env.FIREPIT_VERSION && process.execPath == opts.nodeBinary) {
const requestedMajorNodeVersion = this.getRequestedNodeRuntimeVersion(frb);
this.logger.log(
"WARN",
`To enable function inspection, please run "${process.execPath} is:npm i node@${requestedMajorNodeVersion} --save-dev" in your functions directory`
);
} else {
const { host } = this.getInfo();
args.unshift(`--inspect=${host}:${this.args.debugPort}`);
}
}

const childProcess = spawn(opts.nodeBinary, args, {
Expand Down