|
| 1 | +import * as clc from "colorette"; |
| 2 | + |
| 3 | +import { Command } from "../command"; |
| 4 | +import * as fsi from "../firestore/api"; |
| 5 | +import * as types from "../firestore/api-types"; |
| 6 | +import { getCurrentMinuteAsIsoString, parseDatabaseName } from "../firestore/util"; |
| 7 | +import { logger } from "../logger"; |
| 8 | +import { requirePermissions } from "../requirePermissions"; |
| 9 | +import { Emulators } from "../emulator/types"; |
| 10 | +import { warnEmulatorNotSupported } from "../emulator/commandUtils"; |
| 11 | +import { EncryptionType, FirestoreOptions } from "../firestore/options"; |
| 12 | +import { PrettyPrint } from "../firestore/pretty-print"; |
| 13 | +import { FirebaseError } from "../error"; |
| 14 | + |
| 15 | +export const command = new Command("firestore:databases:clone <sourceDatabase> <targetDatabase>") |
| 16 | + .description("clone one Firestore database to another") |
| 17 | + .option( |
| 18 | + "-e, --encryption-type <encryptionType>", |
| 19 | + `encryption method of the cloned database; one of ${EncryptionType.USE_SOURCE_ENCRYPTION} (default), ` + |
| 20 | + `${EncryptionType.CUSTOMER_MANAGED_ENCRYPTION}, ${EncryptionType.GOOGLE_DEFAULT_ENCRYPTION}`, |
| 21 | + ) |
| 22 | + // TODO(b/356137854): Remove allowlist only message once feature is public GA. |
| 23 | + .option( |
| 24 | + "-k, --kms-key-name <kmsKeyName>", |
| 25 | + "resource ID of the Cloud KMS key to encrypt the cloned database. This " + |
| 26 | + "feature is allowlist only in initial launch", |
| 27 | + ) |
| 28 | + .option( |
| 29 | + "-s, --snapshot-time <snapshotTime>", |
| 30 | + "snapshot time of the source database to use, in ISO 8601 format. Can be any minutely snapshot after the database's earliest version time. If unspecified, takes the most recent available snapshot", |
| 31 | + ) |
| 32 | + .before(requirePermissions, ["datastore.databases.clone"]) |
| 33 | + .before(warnEmulatorNotSupported, Emulators.FIRESTORE) |
| 34 | + .action(async (sourceDatabase: string, targetDatabase: string, options: FirestoreOptions) => { |
| 35 | + const api = new fsi.FirestoreApi(); |
| 36 | + const printer = new PrettyPrint(); |
| 37 | + const helpCommandText = "See firebase firestore:databases:clone --help for more info."; |
| 38 | + |
| 39 | + if (options.database) { |
| 40 | + throw new FirebaseError( |
| 41 | + `--database is not a supported flag for 'firestoree:databases:clone'. ${helpCommandText}`, |
| 42 | + ); |
| 43 | + } |
| 44 | + |
| 45 | + let snapshotTime: string; |
| 46 | + if (options.snapshotTime) { |
| 47 | + snapshotTime = options.snapshotTime; |
| 48 | + } else { |
| 49 | + snapshotTime = getCurrentMinuteAsIsoString(); |
| 50 | + } |
| 51 | + |
| 52 | + let encryptionConfig: types.EncryptionConfig | undefined = undefined; |
| 53 | + switch (options.encryptionType) { |
| 54 | + case EncryptionType.GOOGLE_DEFAULT_ENCRYPTION: |
| 55 | + throwIfKmsKeyNameIsSet(options.kmsKeyName); |
| 56 | + encryptionConfig = { googleDefaultEncryption: {} }; |
| 57 | + break; |
| 58 | + case EncryptionType.USE_SOURCE_ENCRYPTION: |
| 59 | + throwIfKmsKeyNameIsSet(options.kmsKeyName); |
| 60 | + encryptionConfig = { useSourceEncryption: {} }; |
| 61 | + break; |
| 62 | + case EncryptionType.CUSTOMER_MANAGED_ENCRYPTION: |
| 63 | + encryptionConfig = { |
| 64 | + customerManagedEncryption: { kmsKeyName: getKmsKeyOrThrow(options.kmsKeyName) }, |
| 65 | + }; |
| 66 | + break; |
| 67 | + case undefined: |
| 68 | + throwIfKmsKeyNameIsSet(options.kmsKeyName); |
| 69 | + break; |
| 70 | + default: |
| 71 | + throw new FirebaseError(`Invalid value for flag --encryption-type. ${helpCommandText}`); |
| 72 | + } |
| 73 | + |
| 74 | + // projects must be the same |
| 75 | + const targetDatabaseName = parseDatabaseName(targetDatabase); |
| 76 | + const parentProject = targetDatabaseName.projectId; |
| 77 | + const targetDatabaseId = targetDatabaseName.databaseId; |
| 78 | + const sourceProject = parseDatabaseName(sourceDatabase).projectId; |
| 79 | + if (parentProject !== sourceProject) { |
| 80 | + throw new FirebaseError(`Cloning across projects is not supported.`); |
| 81 | + } |
| 82 | + const lro: types.Operation = await api.cloneDatabase( |
| 83 | + sourceProject, |
| 84 | + { |
| 85 | + database: sourceDatabase, |
| 86 | + snapshotTime, |
| 87 | + }, |
| 88 | + targetDatabaseId, |
| 89 | + encryptionConfig, |
| 90 | + ); |
| 91 | + |
| 92 | + if (lro.error) { |
| 93 | + logger.error( |
| 94 | + clc.bold( |
| 95 | + `Clone to ${printer.prettyDatabaseString(targetDatabase)} failed. See below for details.`, |
| 96 | + ), |
| 97 | + ); |
| 98 | + printer.prettyPrintOperation(lro); |
| 99 | + } else { |
| 100 | + logger.info( |
| 101 | + clc.bold(`Successfully initiated clone to ${printer.prettyDatabaseString(targetDatabase)}`), |
| 102 | + ); |
| 103 | + logger.info( |
| 104 | + "Please be sure to configure Firebase rules in your Firebase config file for\n" + |
| 105 | + "the new database. By default, created databases will have closed rules that\n" + |
| 106 | + "block any incoming third-party traffic.", |
| 107 | + ); |
| 108 | + logger.info(); |
| 109 | + logger.info(`You can monitor the progress of this clone by executing this command:`); |
| 110 | + logger.info(); |
| 111 | + logger.info( |
| 112 | + `firebase firestore:operations:describe --database="${targetDatabaseId}" ${lro.name}`, |
| 113 | + ); |
| 114 | + logger.info(); |
| 115 | + logger.info( |
| 116 | + `Once the clone is complete, your database may be viewed at ${printer.firebaseConsoleDatabaseUrl(options.project, targetDatabaseId)}`, |
| 117 | + ); |
| 118 | + } |
| 119 | + |
| 120 | + return lro; |
| 121 | + |
| 122 | + function throwIfKmsKeyNameIsSet(kmsKeyName: string | undefined): void { |
| 123 | + if (kmsKeyName) { |
| 124 | + throw new FirebaseError( |
| 125 | + "--kms-key-name can only be set when specifying an --encryption-type " + |
| 126 | + `of ${EncryptionType.CUSTOMER_MANAGED_ENCRYPTION}.`, |
| 127 | + ); |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + function getKmsKeyOrThrow(kmsKeyName: string | undefined): string { |
| 132 | + if (kmsKeyName) return kmsKeyName; |
| 133 | + |
| 134 | + throw new FirebaseError( |
| 135 | + "--kms-key-name must be provided when specifying an --encryption-type " + |
| 136 | + `of ${EncryptionType.CUSTOMER_MANAGED_ENCRYPTION}.`, |
| 137 | + ); |
| 138 | + } |
| 139 | + }); |
0 commit comments