-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathdatabase.ts
More file actions
194 lines (179 loc) · 6.59 KB
/
database.ts
File metadata and controls
194 lines (179 loc) · 6.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
import * as clc from "colorette";
import { confirm, input, select } from "../../prompt";
import { logger } from "../../logger";
import * as utils from "../../utils";
import { Config } from "../../config";
import {
createInstance,
DatabaseInstance,
DatabaseInstanceType,
DatabaseLocation,
checkInstanceNameAvailable,
getDatabaseInstanceDetails,
} from "../../management/database";
import * as ora from "ora";
import { ensure } from "../../ensureApiEnabled";
import { getDefaultDatabaseInstance } from "../../getDefaultDatabaseInstance";
import { FirebaseError } from "../../error";
import { Client } from "../../apiv2";
import { rtdbManagementOrigin } from "../../api";
import { Setup } from "..";
export interface RequiredInfo {
rulesFilename: string;
rules: string;
writeRules: boolean;
}
const DEFAULT_RULES_FILENAME = "database.rules.json";
export const DEFAULT_RULES = JSON.stringify(
{ rules: { ".read": "auth != null", ".write": "auth != null" } },
null,
2,
);
async function getDBRules(instanceDetails: DatabaseInstance): Promise<string> {
if (!instanceDetails || !instanceDetails.name) {
return DEFAULT_RULES;
}
const client = new Client({ urlPrefix: instanceDetails.databaseUrl });
const response = await client.request<void, NodeJS.ReadableStream>({
method: "GET",
path: "/.settings/rules.json",
responseType: "stream",
resolveOnHTTPError: true,
});
if (response.status !== 200) {
throw new FirebaseError(`Failed to fetch current rules. Code: ${response.status}`);
}
return await response.response.text();
}
function writeDBRules(rules: string, filename: string, config: Config): void {
config.writeProjectFile(filename, rules);
logger.info(
`Future modifications to ${clc.bold(filename)} will update Realtime Database Security Rules when you run`,
);
logger.info(clc.bold("firebase deploy") + ".");
}
async function createDefaultDatabaseInstance(project: string): Promise<DatabaseInstance> {
const selectedLocation = await select<DatabaseLocation>({
message: "Please choose the location for your default Realtime Database instance:",
choices: [
{ name: "us-central1", value: DatabaseLocation.US_CENTRAL1 },
{ name: "europe-west1", value: DatabaseLocation.EUROPE_WEST1 },
{ name: "asia-southeast1", value: DatabaseLocation.ASIA_SOUTHEAST1 },
],
});
let instanceName = `${project}-default-rtdb`;
// check if the conventional default instance name is available.
const checkOutput = await checkInstanceNameAvailable(
project,
instanceName,
DatabaseInstanceType.DEFAULT_DATABASE,
selectedLocation,
);
// if the conventional instance name is not available, pick the first suggestion.
if (!checkOutput.available) {
if (!checkOutput.suggestedIds || checkOutput.suggestedIds.length === 0) {
logger.debug(
`No instance names were suggested instead of conventional instance name: ${instanceName}`,
);
throw new FirebaseError("Failed to create default RTDB instance");
}
instanceName = checkOutput.suggestedIds[0];
logger.info(
`${clc.yellow(
"WARNING:",
)} your project ID has the legacy name format, so your default Realtime Database instance will be named differently: ${instanceName}`,
);
}
const spinner = ora(`Creating your default Realtime Database instance: ${instanceName}`).start();
try {
const createdInstance = await createInstance(
project,
instanceName,
selectedLocation,
DatabaseInstanceType.DEFAULT_DATABASE,
);
spinner.succeed();
return createdInstance;
} catch (err: any) {
spinner.fail();
throw err;
}
}
async function initializeDatabaseInstance(projectId: string): Promise<DatabaseInstance | null> {
await ensure(projectId, rtdbManagementOrigin(), "database", false);
logger.info();
const instance = await getDefaultDatabaseInstance(projectId);
if (instance !== "") {
return await getDatabaseInstanceDetails(projectId, instance);
}
const createDefault = await confirm({
message:
"It seems like you haven’t initialized Realtime Database in your project yet. Do you want to set it up?",
default: true,
});
if (createDefault) {
return await createDefaultDatabaseInstance(projectId);
}
return null;
}
/**
* doSetup is the entry point for setting up the database product.
* @param setup information helpful for database setup
* @param config legacy config parameter. not used for database setup.
*/
export async function askQuestions(setup: Setup, config: Config): Promise<void> {
logger.info();
logger.info(
"Firebase Realtime Database Security Rules allow you to define how your data should be",
);
logger.info("structured and when your data can be read from and written to.");
logger.info();
const rulesFilename = await input({
message: "What file should be used for Realtime Database Security Rules?",
default: DEFAULT_RULES_FILENAME,
});
if (!rulesFilename) {
throw new FirebaseError("Must specify location for Realtime Database rules file.");
}
const info: RequiredInfo = {
rulesFilename,
rules: DEFAULT_RULES,
writeRules: true,
};
if (setup.projectId) {
const instanceDetails = await initializeDatabaseInstance(setup.projectId);
if (instanceDetails) {
info.rules = await getDBRules(instanceDetails);
utils.logBullet(
`Downloaded the existing Realtime Database Security Rules of database ${clc.bold(instanceDetails.name)} from the Firebase console`,
);
}
}
info.writeRules = await config.confirmWriteProjectFile(rulesFilename, info.rules);
// Populate featureInfo for the actuate step later.
setup.featureInfo = setup.featureInfo || {};
setup.featureInfo.database = info;
}
export async function actuate(setup: Setup, config: Config): Promise<void> {
const info = setup.featureInfo?.database;
if (!info) {
throw new FirebaseError("No database RequiredInfo found in setup actuate.");
}
// Populate defaults and update `firebase.json` config.
info.rules = info.rules || DEFAULT_RULES;
info.rulesFilename = info.rulesFilename || "database.rules.json";
setup.config.database = { rules: info.rulesFilename };
if (info.writeRules) {
if (info.rules === DEFAULT_RULES) {
writeDBRules(info.rules, info.rulesFilename, config);
} else {
writeDBRules(info.rules, info.rulesFilename, config);
}
} else {
logger.info("Skipping overwrite of Realtime Database Security Rules.");
logger.info(
`The security rules defined in ${clc.bold(info.rulesFilename)} will be published when you run ${clc.bold("firebase deploy")}.`,
);
}
return Promise.resolve();
}