Function askForEventsConfig

src/extensions/askUserForEventsConfig.ts:47–74

(
  events: EventDescriptor[],
  projectId: string,
  instanceId: string,
)

 * @return The instance events config or undefined if the user doesn't want events
 */
export async function askForEventsConfig(
  events: EventDescriptor[],
  projectId: string,
  instanceId: string,
): Promise<InstanceEventsConfig | undefined> {
  logger.info(
    `\n${clc.bold("Enable Events")}: ${await marked(
      "If you enable events, you can write custom event handlers ([https://firebase.google.com/docs/extensions/install-extensions#eventarc](https://firebase.google.com/docs/extensions/install-extensions#eventarc)) that respond to these events.\n\nYou can always enable or disable events later. Events will be emitted via Eventarc. Fees apply ([https://cloud.google.com/eventarc/pricing](https://cloud.google.com/eventarc/pricing)).",
    )}`,
  );
  if (!(await askShouldCollectEventsConfig())) {
    return undefined;
  }
  let existingInstance: ExtensionInstance | undefined;
  try {
    existingInstance = instanceId
      ? await extensionsApi.getInstance(projectId, instanceId)
      : undefined;
  } catch {
    /* If instance was not found, then this is an instance ID for a new instance. Don't preselect any values when displaying prompts to the user. */
  }
  const preselectedTypes = existingInstance?.config.allowedEventTypes ?? [];
  const oldLocation = existingInstance?.config.eventarcChannel?.split("/")[3];
  const location = await askForEventArcLocation(oldLocation);
  const channel = getEventArcChannel(projectId, location);
  const allowedEventTypes = await askForAllowedEventTypes(events, preselectedTypes);
  return { channel, allowedEventTypes };
}

/**
 * Creates an EventArc channel resource name