Function requireAuth

src/requireAuth.ts:105–162

(
  options: any,
  skipAutoAuth: boolean = false,
)

 * @param options CLI options.
 */
export async function requireAuth(
  options: any,
  skipAutoAuth: boolean = false,
): Promise<string | null> {
  lastOptions = options;
  const requiredScopes = [scopes.CLOUD_PLATFORM];
  if (isFirebaseStudio()) {
    requiredScopes.push(scopes.USERINFO_EMAIL);
  }
  api.setScopes(requiredScopes);
  options.authScopes = api.getScopes();

  const tokens = options.tokens as Tokens | undefined;
  const user = options.user as User | undefined;
  let tokenOpt = utils.getInheritedOption(options, "token");
  if (tokenOpt) {
    logger.debug("> authorizing via --token option");
    utils.logWarning(
      "Authenticating with `--token` is deprecated and will be removed in a future major version of `firebase-tools`. " +
        "Instead, use a service account key with `GOOGLE_APPLICATION_CREDENTIALS`: https://cloud.google.com/docs/authentication/getting-started",
    );
  } else if (process.env.FIREBASE_TOKEN) {
    logger.debug("> authorizing via FIREBASE_TOKEN environment variable");
    utils.logWarning(
      "Authenticating with `FIREBASE_TOKEN` is deprecated and will be removed in a future major version of `firebase-tools`. " +
        "Instead, use a service account key with `GOOGLE_APPLICATION_CREDENTIALS`: https://cloud.google.com/docs/authentication/getting-started",
    );
  } else if (user && (!isExpired(tokens) || tokens?.refresh_token)) {
    logger.debug(`> authorizing via signed-in user (${user.email})`);
  } else if (skipAutoAuth) {
    return null;
  } else {
    try {
      return await autoAuth(options, options.authScopes);
    } catch (e: any) {
      throw new FirebaseError(
        `Failed to authenticate, have you run ${clc.bold("firebase login")}?`,
        { original: e },
      );
    }
  }

  tokenOpt = tokenOpt || process.env.FIREBASE_TOKEN;

  if (tokenOpt) {
    setRefreshToken(tokenOpt);
    return null;
  }

  if (!user || !tokens) {
    throw new FirebaseError(AUTH_ERROR_MESSAGE);
  }

  // TODO: 90 percent sure this is redundant, as the only time we hit this is if options.user/options.token is set, and
  // setActiveAccount is the only code that sets those.
  setActiveAccount(options, { user, tokens });
  return user.email;
}