firebase-tools
Version:
Command-Line Interface for Firebase
165 lines (164 loc) • 6.93 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Delegate = exports.getPythonBinary = exports.tryCreateDelegate = void 0;
const fs = require("fs");
const path = require("path");
const node_fetch_1 = require("node-fetch");
const util_1 = require("util");
const portfinder = require("portfinder");
const discovery = require("../discovery");
const supported = require("../supported");
const logger_1 = require("../../../../logger");
const python_1 = require("../../../../functions/python");
const error_1 = require("../../../../error");
const functional_1 = require("../../../../functional");
async function tryCreateDelegate(context) {
var _a;
const requirementsTextPath = path.join(context.sourceDir, "requirements.txt");
if (!(await (0, util_1.promisify)(fs.exists)(requirementsTextPath))) {
logger_1.logger.debug("Customer code is not Python code.");
return;
}
const runtime = (_a = context.runtime) !== null && _a !== void 0 ? _a : supported.latest("python");
if (!supported.isRuntime(runtime)) {
throw new error_1.FirebaseError(`Runtime ${runtime} is not a valid Python runtime`);
}
if (!supported.runtimeIsLanguage(runtime, "python")) {
throw new error_1.FirebaseError(`Internal error. Trying to construct a python runtime delegate for runtime ${runtime}`, { exit: 1 });
}
return Promise.resolve(new Delegate(context.projectId, context.sourceDir, runtime));
}
exports.tryCreateDelegate = tryCreateDelegate;
function getPythonBinary(runtime) {
if (process.platform === "win32") {
return "python.exe";
}
if (runtime === "python310") {
return "python3.10";
}
else if (runtime === "python311") {
return "python3.11";
}
else if (runtime === "python312") {
return "python3.12";
}
else if (runtime === "python313") {
return "python3.13";
}
(0, functional_1.assertExhaustive)(runtime, `Unhandled python runtime ${runtime}`);
}
exports.getPythonBinary = getPythonBinary;
class Delegate {
constructor(projectId, sourceDir, runtime) {
this.projectId = projectId;
this.sourceDir = sourceDir;
this.runtime = runtime;
this.language = "python";
this._bin = "";
this._modulesDir = "";
}
get bin() {
if (this._bin === "") {
this._bin = this.getPythonBinary();
}
return this._bin;
}
async modulesDir() {
var _a, _b;
if (!this._modulesDir) {
let out = "";
let stderr = "";
const child = (0, python_1.runWithVirtualEnv)([
this.bin,
"-c",
'"import firebase_functions; import os; print(os.path.dirname(firebase_functions.__file__))"',
], this.sourceDir, {});
(_a = child.stderr) === null || _a === void 0 ? void 0 : _a.on("data", (chunk) => {
const chunkString = chunk.toString();
stderr = stderr + chunkString;
logger_1.logger.debug(`stderr: ${chunkString}`);
});
(_b = child.stdout) === null || _b === void 0 ? void 0 : _b.on("data", (chunk) => {
const chunkString = chunk.toString();
out = out + chunkString;
logger_1.logger.debug(`stdout: ${chunkString}`);
});
await new Promise((resolve, reject) => {
child.on("exit", resolve);
child.on("error", reject);
});
this._modulesDir = out.trim();
if (this._modulesDir === "") {
if (stderr.includes("venv") && stderr.includes("activate")) {
throw new error_1.FirebaseError("Failed to find location of Firebase Functions SDK: Missing virtual environment at venv directory. " +
`Did you forget to run '${this.bin} -m venv venv'?`);
}
const { command, args } = (0, python_1.virtualEnvCmd)(this.sourceDir, python_1.DEFAULT_VENV_DIR);
throw new error_1.FirebaseError("Failed to find location of Firebase Functions SDK. " +
`Did you forget to run '${command} ${args.join(" ")} && ${this.bin} -m pip install -r requirements.txt'?`);
}
}
return this._modulesDir;
}
getPythonBinary() {
return getPythonBinary(this.runtime);
}
validate() {
return Promise.resolve();
}
watch() {
return Promise.resolve(() => Promise.resolve());
}
async build() {
return Promise.resolve();
}
async serveAdmin(port, envs) {
var _a, _b;
const modulesDir = await this.modulesDir();
const envWithAdminPort = Object.assign(Object.assign({}, envs), { ADMIN_PORT: port.toString() });
const args = [this.bin, `"${path.join(modulesDir, "private", "serving.py")}"`];
logger_1.logger.debug(`Running admin server with args: ${JSON.stringify(args)} and env: ${JSON.stringify(envWithAdminPort)} in ${this.sourceDir}`);
const childProcess = (0, python_1.runWithVirtualEnv)(args, this.sourceDir, envWithAdminPort);
(_a = childProcess.stdout) === null || _a === void 0 ? void 0 : _a.on("data", (chunk) => {
logger_1.logger.info(chunk.toString("utf8"));
});
(_b = childProcess.stderr) === null || _b === void 0 ? void 0 : _b.on("data", (chunk) => {
logger_1.logger.error(chunk.toString("utf8"));
});
return Promise.resolve(async () => {
try {
await (0, node_fetch_1.default)(`http://127.0.0.1:${port}/__/quitquitquit`);
}
catch (e) {
logger_1.logger.debug("Failed to call quitquitquit. This often means the server failed to start", e);
}
const quitTimeout = setTimeout(() => {
if (!childProcess.killed) {
childProcess.kill("SIGKILL");
}
}, 10000);
clearTimeout(quitTimeout);
return new Promise((resolve, reject) => {
childProcess.once("exit", resolve);
childProcess.once("error", reject);
});
});
}
async discoverBuild(_configValues, envs) {
let discovered = await discovery.detectFromYaml(this.sourceDir, this.projectId, this.runtime);
if (!discovered) {
const adminPort = await portfinder.getPortPromise({
port: 8081,
});
const killProcess = await this.serveAdmin(adminPort, envs);
try {
discovered = await discovery.detectFromPort(adminPort, this.projectId, this.runtime, 500);
}
finally {
await killProcess();
}
}
return discovered;
}
}
exports.Delegate = Delegate;