Extensions Registry Alpha (#2881)

Author: huangjeff5

src/commands/ext-dev-list.ts

@@ -0,0 +1,59 @@
+import * as clc from "cli-color";
+import Table = require("cli-table");
+import * as _ from "lodash";
+
+import { Command } from "../command";
+import { logPrefix } from "../extensions/extensionsHelper";
+import { FirebaseError } from "../error";
+import * as utils from "../utils";
+import * as extensionsUtils from "../extensions/utils";
+import { listExtensions } from "../extensions/extensionsApi";
+import * as logger from "../logger";
+import { requireAuth } from "../requireAuth";
+
+/**
+ * List all published extensions associated with this publisher ID.
+ */
+export default new Command("ext:dev:list <publisherId>")
+ .description("list all published extensions associated with this publisher ID")
+ .before(requireAuth)
+ .action(async (publisherId: string) => {
+ let extensions;
+ try {
+ extensions = await listExtensions(publisherId);
+ } catch (err) {
+ throw new FirebaseError(err);
+ }
+
+ if (extensions.length < 1) {
+ throw new FirebaseError(
+ `There are no published extensions associated with publisher ID ${clc.bold(
+ publisherId
+ )}. This could happen for two reasons:\n` +
+ " - The publisher ID doesn't exist or could be misspelled\n" +
+ " - This publisher has not published any extensions\n\n" +
+ "If you are expecting some extensions to appear, please make sure you have the correct publisher ID and try again."
+ );
+ }
+
+ const table = new Table({
+ head: ["Extension ID", "Version", "Published"],
+ style: { head: ["yellow"] },
+ });
+ // Order extensions newest to oldest.
+ const sorted = _.sortBy(extensions, "createTime", "asc").reverse();
+ sorted.forEach((extension) => {
+ table.push([
+ _.last(extension.ref.split("/")),
+ extension.latestVersion,
+ extension.createTime ? extensionsUtils.formatTimestamp(extension.createTime) : "",
+ ]);
+ });
+
+ utils.logLabeledBullet(
+ logPrefix,
+ `list of published extensions for publisher ${clc.bold(publisherId)}:`
+ );
+ logger.info(table.toString());
+ return { extensions: sorted };
+ });

src/commands/ext-dev-publish.ts

@@ -0,0 +1,44 @@
+import { Command } from "../command";
+import { publishExtensionVersionFromLocalSource } from "../extensions/extensionsHelper";
+import { parseRef } from "../extensions/extensionsApi";
+
+import { findExtensionYaml } from "../extensions/localHelper";
+import { requireAuth } from "../requireAuth";
+import * as clc from "cli-color";
+import { FirebaseError } from "../error";
+
+/**
+ * Command for publishing an extension version.
+ */
+export default new Command("ext:dev:publish <extensionRef>")
+ .description(`publish a new version of an extension`)
+ .help(
+ "if you have not previously published a version of this extension, this will " +
+ "create the extension. If you have previously published a version of this extension, this version must " +
+ "be greater than previous versions."
+ )
+ .before(requireAuth)
+ .action(async (extensionRef: string) => {
+ const { publisherId, extensionId, version } = parseRef(extensionRef);
+ if (version) {
+ throw new FirebaseError(
+ `The input extension reference must be of the format ${clc.bold(
+ "<publisherId>/<extensionId>"
+ )}. Version should not be supplied and will be inferred directly from extension.yaml. Please increment the version in extension.yaml if you would like to bump/specify a version.`
+ );
+ }
+ if (!publisherId || !extensionId) {
+ throw new FirebaseError(
+ `Error parsing publisher ID and extension ID from extension reference '${clc.bold(
+ extensionRef
+ )}'. Please use the format '${clc.bold("<publisherId>/<extensionId>")}'.`
+ );
+ }
+ const extensionYamlDirectory = findExtensionYaml(process.cwd());
+ const res = await publishExtensionVersionFromLocalSource(
+ publisherId,
+ extensionId,
+ extensionYamlDirectory
+ );
+ return res;
+ });

src/commands/ext-dev-register.ts

@@ -0,0 +1,65 @@
+import * as clc from "cli-color";
+import * as marked from "marked";
+
+import { Command } from "../command";
+import { registerPublisherProfile } from "../extensions/extensionsApi";
+import * as getProjectId from "../getProjectId";
+import { promptOnce } from "../prompt";
+import { ensureExtensionsApiEnabled, logPrefix } from "../extensions/extensionsHelper";
+import { promptForPublisherTOS } from "../extensions/askUserForConsent";
+import { requirePermissions } from "../requirePermissions";
+import { FirebaseError } from "../error";
+import * as utils from "../utils";
+
+/**
+ * Register a publisher ID; run this before publishing any extensions.
+ */
+export default new Command("ext:dev:register")
+ .description("register a publisher ID; run this before publishing your first extension.")
+ // temporary until registry-specific permissions are available
+ .before(requirePermissions, ["firebaseextensions.sources.create"])
+ .before(ensureExtensionsApiEnabled)
+ .action(async (options: any) => {
+ await promptForPublisherTOS();
+ const projectId = getProjectId(options, false);
+ const msg =
+ "What would you like to register as your publisher ID? " +
+ "This value identifies you in Firebase's registry of extensions as the author of your extensions. " +
+ "Examples: my-company-name, MyGitHubUsername. If you are a member of the Extensions EAP group, your published extensions will only be accessible to other members of the EAP group. \n\n" +
+ "You can only do this once for each project.";
+ const publisherId = await promptOnce({
+ name: "publisherId",
+ type: "input",
+ message: msg,
+ default: projectId,
+ });
+ try {
+ await registerPublisherProfile(projectId, publisherId);
+ } catch (err) {
+ if (err.status === 409) {
+ const error =
+ `Couldn't register the publisher ID '${clc.bold(publisherId)}' to the project '${clc.bold(
+ projectId
+ )}'.` +
+ " This can happen for either of two reasons:\n\n" +
+ ` - Publisher ID '${clc.bold(publisherId)}' is registered to another project\n` +
+ ` - Project '${clc.bold(projectId)}' already has a publisher ID\n\n` +
+ ` Try again with a unique publisher ID or a new project. If your business’s name has been registered to another project, contact Firebase support ${marked(
+ "(https://firebase.google.com/support/troubleshooter/contact)."
+ )}`;
+ throw new FirebaseError(error, { exit: 1 });
+ }
+ throw new FirebaseError(
+ `Failed to register publisher ID ${clc.bold(publisherId)} for project ${clc.bold(
+ projectId
+ )}: ${err.message}`,
+ { exit: 1 }
+ );
+ }
+ return utils.logLabeledSuccess(
+ logPrefix,
+ `Publisher ID '${clc.bold(publisherId)}' has been registered to project ${clc.bold(
+ projectId
+ )}`
+ );
+ });

src/commands/ext-dev-unpublish.ts

@@ -0,0 +1,47 @@
+import { Command } from "../command";
+import { logPrefix } from "../extensions/extensionsHelper";
+import { unpublishExtension, parseRef, getExtension } from "../extensions/extensionsApi";
+import * as utils from "../utils";
+import { promptOnce } from "../prompt";
+import * as clc from "cli-color";
+import { requireAuth } from "../requireAuth";
+import { FirebaseError } from "../error";
+
+module.exports = new Command("ext:dev:unpublish <extensionRef>")
+ .description("unpublish an extension")
+ .help(
+ "use this command to unpublish an extension, and make it unavailable for developers to install or reconfigure. " +
+ "Specify the extension you want to unpublish using the format '<publisherId>/<extensionId>."
+ )
+ .before(requireAuth)
+ .action(async (extensionRef: string) => {
+ const { publisherId, extensionId, version } = parseRef(extensionRef);
+ const message =
+ "If you unpublish this extension, developers won't be able to install it. For developers who currently have this extension installed, it will continue to run and will appear as unpublished when listed in the Firebase console or Firebase CLI.";
+ utils.logLabeledWarning(logPrefix, message);
+ if (version) {
+ throw new FirebaseError(
+ `Unpublishing a single version is not currently supported. You can only unpublish ${clc.bold(
+ "ALL versions"
+ )} of an extension. To unpublish all versions, please remove the version from the reference.`
+ );
+ }
+ await getExtension(extensionRef);
+ const consent = await comfirmUnpublish(publisherId, extensionId);
+ if (!consent) {
+ throw new FirebaseError("unpublishing cancelled.");
+ }
+ await unpublishExtension(extensionRef);
+ utils.logLabeledSuccess(logPrefix, "successfully unpublished all versions of this extension.");
+ });
+
+async function comfirmUnpublish(publisherId: string, extensionId: string): Promise<string> {
+ const message = `You are about to unpublish ALL versions of ${clc.green(
+ `${publisherId}/${extensionId}`
+ )}.\nDo you wish to continue? `;
+ return await promptOnce({
+ type: "confirm",
+ message,
+ default: false, // Force users to explicitly type 'yes'
+ });
+}