firebase-tools 15.28.3-feat-firebase-debug-path.0 → 15.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/bin/cli.js +1 -4
- package/lib/commands/functions-kits-install.js +4 -0
- package/lib/commands/functions-kits-uninstall.js +2 -0
- package/lib/functions/kits/install.js +83 -3
- package/lib/tsconfig.compile.tsbuildinfo +1 -1
- package/lib/tsconfig.publish.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/templates/init/functions/typescript/package-kit.json +21 -0
package/lib/bin/cli.js
CHANGED
|
@@ -82,10 +82,7 @@ function cli(pkg) {
|
|
|
82
82
|
help = "Having trouble? Try " + clc.bold("firebase [command] --help");
|
|
83
83
|
}
|
|
84
84
|
else {
|
|
85
|
-
|
|
86
|
-
? logFilename
|
|
87
|
-
: "firebase-debug.log";
|
|
88
|
-
help = `Having trouble? Try again or contact support with contents of ${logFileDisplay}`;
|
|
85
|
+
help = `Having trouble? Try again or contact support with contents of ${logFilename}`;
|
|
89
86
|
}
|
|
90
87
|
if (cmd) {
|
|
91
88
|
console.log();
|
|
@@ -5,8 +5,12 @@ const command_1 = require("../command");
|
|
|
5
5
|
const error_1 = require("../error");
|
|
6
6
|
const experiments = require("../experiments");
|
|
7
7
|
const install_1 = require("../functions/kits/install");
|
|
8
|
+
const requireAuth_1 = require("../requireAuth");
|
|
9
|
+
const requireConfig_1 = require("../requireConfig");
|
|
8
10
|
exports.command = new command_1.Command("functions:kits:install")
|
|
9
11
|
.description("install a function kit into your project")
|
|
12
|
+
.before(requireConfig_1.requireConfig)
|
|
13
|
+
.before(requireAuth_1.requireAuth)
|
|
10
14
|
.option("--package <package>", "NPM package name or specifier to install as a function kit")
|
|
11
15
|
.option("--directory <directory>", "path to a local functions codebase directory to install as a function kit")
|
|
12
16
|
.option(`--template <template>`, `template to use for the kit index file (${Object.keys(install_1.TEMPLATES).join("|")})`)
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.command = void 0;
|
|
4
4
|
const requireConfig_1 = require("../requireConfig");
|
|
5
|
+
const requireAuth_1 = require("../requireAuth");
|
|
5
6
|
const command_1 = require("../command");
|
|
6
7
|
const config_1 = require("../functions/kits/config");
|
|
7
8
|
const path_1 = require("path");
|
|
@@ -15,6 +16,7 @@ const delete_1 = require("../deploy/functions/delete");
|
|
|
15
16
|
exports.command = new command_1.Command("functions:kits:uninstall")
|
|
16
17
|
.description("uninstall a function kit or kit instance from your project")
|
|
17
18
|
.before(requireConfig_1.requireConfig)
|
|
19
|
+
.before(requireAuth_1.requireAuth)
|
|
18
20
|
.option("--kit <kitId>", "")
|
|
19
21
|
.option("--instance <instanceId>", "")
|
|
20
22
|
.action(async (options) => {
|
|
@@ -16,6 +16,8 @@ exports.promptExistingInstanceForProject = promptExistingInstanceForProject;
|
|
|
16
16
|
exports.writeKitPackageJson = writeKitPackageJson;
|
|
17
17
|
exports.writeKitIndexTs = writeKitIndexTs;
|
|
18
18
|
exports.scaffoldKitFiles = scaffoldKitFiles;
|
|
19
|
+
exports.resolveSdkSpecifierToSave = resolveSdkSpecifierToSave;
|
|
20
|
+
exports.getKitPackagesToSave = getKitPackagesToSave;
|
|
19
21
|
exports.buildAndInstallKit = buildAndInstallKit;
|
|
20
22
|
exports.addKitToConfig = addKitToConfig;
|
|
21
23
|
exports.validateAndResolveDirectoryKit = validateAndResolveDirectoryKit;
|
|
@@ -36,6 +38,7 @@ const crypto = require("crypto");
|
|
|
36
38
|
const path = require("path");
|
|
37
39
|
const clc = require("colorette");
|
|
38
40
|
const fs = require("fs-extra");
|
|
41
|
+
const semver = require("semver");
|
|
39
42
|
const error_1 = require("../../error");
|
|
40
43
|
const projectUtils_1 = require("../../projectUtils");
|
|
41
44
|
const utils_1 = require("../../utils");
|
|
@@ -305,13 +308,15 @@ async function writeKitPackageJson(config, sourcePath, kitId) {
|
|
|
305
308
|
}
|
|
306
309
|
else {
|
|
307
310
|
const latestNodeVersion = supported.latest("nodejs").replace("nodejs", "");
|
|
308
|
-
const
|
|
309
|
-
const subbedTemplate =
|
|
311
|
+
const packageKitTemplate = (0, templates_1.readTemplateSync)("init/functions/typescript/package-kit.json");
|
|
312
|
+
const subbedTemplate = packageKitTemplate.replace(/{{RUNTIME}}/g, latestNodeVersion);
|
|
310
313
|
try {
|
|
311
314
|
pkgJson = JSON.parse(subbedTemplate);
|
|
312
315
|
}
|
|
313
316
|
catch (err) {
|
|
314
|
-
throw new error_1.FirebaseError("Failed to parse package.
|
|
317
|
+
throw new error_1.FirebaseError("Failed to parse package-kit.json template: " + (0, error_1.getErrMsg)(err), {
|
|
318
|
+
original: err instanceof Error ? err : undefined,
|
|
319
|
+
});
|
|
315
320
|
}
|
|
316
321
|
}
|
|
317
322
|
pkgJson.name = `${kitId}-wrapper`;
|
|
@@ -339,7 +344,67 @@ async function scaffoldKitFiles(config, kitId, instanceId, packageName, template
|
|
|
339
344
|
await writeKitIndexTs(config, sourcePath, packageName, templateType);
|
|
340
345
|
return { sourcePath, configDirPath, absSourcePath, absConfigDirPath };
|
|
341
346
|
}
|
|
347
|
+
function resolveSdkSpecifierToSave(packageName, declaredVer, installedVer) {
|
|
348
|
+
const cleanVer = semver.clean(declaredVer);
|
|
349
|
+
if (cleanVer) {
|
|
350
|
+
return `${packageName}@=${installedVer || cleanVer}`;
|
|
351
|
+
}
|
|
352
|
+
if (declaredVer.trim().startsWith("~")) {
|
|
353
|
+
return installedVer ? `${packageName}@~${installedVer}` : `${packageName}@${declaredVer}`;
|
|
354
|
+
}
|
|
355
|
+
if (installedVer) {
|
|
356
|
+
return `${packageName}@^${installedVer}`;
|
|
357
|
+
}
|
|
358
|
+
return `${packageName}@${declaredVer}`;
|
|
359
|
+
}
|
|
360
|
+
async function getKitPackagesToSave(absSourcePath, packageName) {
|
|
361
|
+
const lockfilePath = path.join(absSourcePath, "package-lock.json");
|
|
362
|
+
let peerDeps = {};
|
|
363
|
+
let directDeps = {};
|
|
364
|
+
let installedFunctionsVer;
|
|
365
|
+
let installedAdminVer;
|
|
366
|
+
if (await fs.pathExists(lockfilePath)) {
|
|
367
|
+
try {
|
|
368
|
+
const lockfile = (await fs.readJson(lockfilePath));
|
|
369
|
+
const packages = lockfile.packages || {};
|
|
370
|
+
const kitEntry = packages[`node_modules/${packageName}`] || {};
|
|
371
|
+
peerDeps = kitEntry.peerDependencies || {};
|
|
372
|
+
directDeps = kitEntry.dependencies || {};
|
|
373
|
+
installedFunctionsVer = packages["node_modules/firebase-functions"]?.version;
|
|
374
|
+
installedAdminVer = packages["node_modules/firebase-admin"]?.version;
|
|
375
|
+
}
|
|
376
|
+
catch (err) {
|
|
377
|
+
logger_1.logger.debug(`Failed to read package-lock.json: ${(0, error_1.getErrMsg)(err)}`);
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
if (Object.keys(peerDeps).length === 0 && Object.keys(directDeps).length === 0) {
|
|
381
|
+
const kitPkgJsonPath = path.join(absSourcePath, "node_modules", packageName, "package.json");
|
|
382
|
+
if (await fs.pathExists(kitPkgJsonPath)) {
|
|
383
|
+
try {
|
|
384
|
+
const kitPkgJson = (await fs.readJson(kitPkgJsonPath));
|
|
385
|
+
peerDeps = kitPkgJson.peerDependencies || {};
|
|
386
|
+
directDeps = kitPkgJson.dependencies || {};
|
|
387
|
+
}
|
|
388
|
+
catch (err) {
|
|
389
|
+
logger_1.logger.debug(`Failed to read kit package.json: ${(0, error_1.getErrMsg)(err)}`);
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
const declaredFunctionsVer = peerDeps["firebase-functions"] || directDeps["firebase-functions"];
|
|
394
|
+
if (!declaredFunctionsVer) {
|
|
395
|
+
throw new error_1.FirebaseError(`Package '${packageName}' is not a valid Function Kit: it must declare 'firebase-functions' as a dependency or peer dependency.`);
|
|
396
|
+
}
|
|
397
|
+
const packagesToSave = [
|
|
398
|
+
resolveSdkSpecifierToSave("firebase-functions", declaredFunctionsVer, installedFunctionsVer),
|
|
399
|
+
];
|
|
400
|
+
const declaredAdminVer = peerDeps["firebase-admin"] || directDeps["firebase-admin"];
|
|
401
|
+
if (declaredAdminVer) {
|
|
402
|
+
packagesToSave.push(resolveSdkSpecifierToSave("firebase-admin", declaredAdminVer, installedAdminVer));
|
|
403
|
+
}
|
|
404
|
+
return packagesToSave;
|
|
405
|
+
}
|
|
342
406
|
async function buildAndInstallKit(absSourcePath, rawPkgName, isThirdParty) {
|
|
407
|
+
const { packageName } = parseNpmPackageSpecifier(rawPkgName);
|
|
343
408
|
const installArgs = ["install", rawPkgName, "--save-prefix=^"];
|
|
344
409
|
if (isThirdParty) {
|
|
345
410
|
installArgs.push("--ignore-scripts");
|
|
@@ -351,6 +416,21 @@ async function buildAndInstallKit(absSourcePath, rawPkgName, isThirdParty) {
|
|
|
351
416
|
catch (err) {
|
|
352
417
|
throw new error_1.FirebaseError(`NPM install failed: ${(0, error_1.getErrMsg)(err)}`);
|
|
353
418
|
}
|
|
419
|
+
const packagesToSave = await getKitPackagesToSave(absSourcePath, packageName);
|
|
420
|
+
if (packagesToSave.length > 0) {
|
|
421
|
+
(0, utils_1.logLabeledBullet)("functions", `Saving resolved SDK dependencies: ${clc.bold(packagesToSave.join(", "))}...`);
|
|
422
|
+
const saveArgs = ["install", ...packagesToSave, "--save-prefix=^"];
|
|
423
|
+
if (isThirdParty) {
|
|
424
|
+
saveArgs.push("--ignore-scripts");
|
|
425
|
+
}
|
|
426
|
+
try {
|
|
427
|
+
await (0, spawn_1.wrapSpawn)("npm", saveArgs, absSourcePath);
|
|
428
|
+
}
|
|
429
|
+
catch (err) {
|
|
430
|
+
throw new error_1.FirebaseError(`Failed to install required SDK dependencies (${packagesToSave.join(", ")}): ${(0, error_1.getErrMsg)(err)}. ` +
|
|
431
|
+
"Verify that the kit's dependencies are compatible with the resolved Firebase SDK versions.", { original: err instanceof Error ? err : undefined });
|
|
432
|
+
}
|
|
433
|
+
}
|
|
354
434
|
(0, utils_1.logLabeledBullet)("functions", "Building TypeScript source...");
|
|
355
435
|
try {
|
|
356
436
|
await (0, spawn_1.wrapSpawn)("npm", ["run", "build"], absSourcePath);
|