-
Notifications
You must be signed in to change notification settings - Fork 23
/
backup.js
382 lines (346 loc) · 13.4 KB
/
backup.js
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
// Downloads the server code from Microsoft
const fs = require('fs-extra');
const assert = require('assert');
const archiver = require('archiver');
const unzipper = require('unzipper');
const AWS = require('aws-sdk');
const util = require('util');
const stream = require('stream');
const pipeline = util.promisify(stream.pipeline);
const {
CONFIG_FILE_PATH,
SERVER_WORLDS_FOLDER_NAME,
SERVER_WORLDS_FOLDER_PATH,
BACKUP_FOLDER_PATH,
BACKUP_TYPES,
BUCKET_LOCK_FILE_NAME,
BUCKET_LOCK_FILE_CONTENTS_PATH,
MS_IN_SEC,
formatBytes,
platform
} = require('./utils.js');
const configFile = fs.readFileSync(CONFIG_FILE_PATH, 'utf8');
const config = JSON.parse(configFile);
const backupConfig = config.backup;
assert(backupConfig, `Could not find field 'backup' at root of config`);
// too lazy for more error handling :/
const localBackupKeepCount = backupConfig["num-backups-to-keep-for-type"].local;
const remoteBackupKeepCount = backupConfig["num-backups-to-keep-for-type"].remote;
// AWS STUFF
let s3 = null;
const serverProps = config['server-properties'];
const bucketName = `Minecraft-bedrock-backup.${serverProps['level-name']}`.toLowerCase().replace(/( |_)/g, "-").replace(/(-+)/g, "-");
if (backupConfig["use-aws-s3-backup"]) {
s3 = new AWS.S3({
apiVersion: '2006-03-01'
});
} else {
console.log(`!!!!!!!!!!\nconfig["backup"]["use-aws-s3-backup"] set to false - if you want to use AWS S3 backups, set this to true and see https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html for instruction on how to define your AWS credentials\n!!!!!!!!!!\n`);
}
async function createBackupBucketIfNotExists() {
if (s3) {
await s3.createBucket({
Bucket: bucketName
}).promise();
}
}
async function _createBackupFromFileToCopyLength(fileToCopyLength, backupStartTime, backupType) {
assert(backupType, `Undefined backup type`);
fs.ensureDirSync(BACKUP_FOLDER_PATH);
const archive = archiver('zip');
const outputArchiveFileName = `${backupStartTime}_${backupType}.zip`;
const outputArchiveStream = fs.createWriteStream(`${BACKUP_FOLDER_PATH}/${outputArchiveFileName}`);
archive.pipe(outputArchiveStream);
await Promise.all(Object.keys(fileToCopyLength).map(async (fileName) => {
const contentLength = fileToCopyLength[fileName];
// Sadly, the 'save query command' doesn't give us the correct path for all
// files - attempting to fix that now
if (!(await fs.pathExists(`${SERVER_WORLDS_FOLDER_PATH}/${fileName}`))) {
fileName = fileName.replace('/', '/db/');
}
if (!(await fs.pathExists(`${SERVER_WORLDS_FOLDER_PATH}/${fileName}`))) {
fileName = fileName.replace('/db/', '/db/lost/');
}
const source = `${SERVER_WORLDS_FOLDER_PATH}/${fileName}`;
const readStream = fs.createReadStream(source, {
end: contentLength > 0 ? contentLength - 1 : 0
});
archive.append(readStream, {
name: fileName
});
}));
archive.finalize();
await new Promise(fulfill => outputArchiveStream.on("close", fulfill));
if (s3) {
await pushBackupToRemote(outputArchiveFileName);
await purgeOldRemoteBackups();
}
// purge old backups now since we may have too many
try {
await purgeOldLocalBackups();
} catch (e) {
console.error(e);
}
console.log(`Finished creating local backup of server state at ${new Date(backupStartTime*MS_IN_SEC).toLocaleString()} with type ${backupType}\n`);
};
async function createBackup(backupFileListString, backupStartTime, backupType) {
const instructionStrings = backupFileListString.split(', ');
const fileToCopyLength = {};
instructionStrings.forEach((instruction) => {
const splitInstruction = instruction.split(':');
fileToCopyLength[splitInstruction[0]] = parseInt(splitInstruction[1]);
});
await _createBackupFromFileToCopyLength(fileToCopyLength, backupStartTime, backupType);
};
function getFilePathsSync(dir, files_) {
files_ = files_ || [];
const files = fs.readdirSync(dir);
for (var i in files) {
const name = dir + '/' + files[i];
if (fs.statSync(name).isDirectory()) {
getFilePathsSync(name, files_);
} else {
files_.push(name);
}
}
return files_;
}
async function createUnscheduledBackup(backupStartTime) {
// blindly tries to create a backup of everything in the current worlds folder
// without the file and position list provided by 'save query'
console.log('!!!!!!!!!!!\n\nRUNNING BACKUP DUE TO A FORCED STOP - creating a sketchy ad hoc backup of server state...');
const filePaths = getFilePathsSync(SERVER_WORLDS_FOLDER_PATH).map(filePath => filePath.replace(`${SERVER_WORLDS_FOLDER_PATH}/`, ''));
const fileToCopyLength = {};
filePaths.forEach(path => {
fileToCopyLength[path] = Infinity;
});
await _createBackupFromFileToCopyLength(fileToCopyLength, backupStartTime, BACKUP_TYPES.ON_FORCED_STOP);
console.log(`\nPlease check the state of the server and make sure the latest backup is a valid one before continued use (use force-restore <BACKUP_FILE_NAME> if necessary)`);
console.log(`\nIn the future, please use the 'stop' command to kill the server`);
}
async function restoreLatestLocalBackup() {
console.log('\nRestoring latest local backup...');
fs.ensureDirSync(BACKUP_FOLDER_PATH);
const backupFiles = await fs.readdir(BACKUP_FOLDER_PATH);
const allArchives = await fs.readdir(BACKUP_FOLDER_PATH);
allArchives.sort((name1, name2) => {
const ts1Match = name1.match(/\d*/);
const ts2Match = name2.match(/\d*/);
const ts1 = parseInt(ts1Match[0]);
const ts2 = parseInt(ts2Match[0]);
return ts2 - ts1;
});
const restorableArchives = allArchives.filter(
fileName => !fileName.includes(BACKUP_TYPES.ON_FORCED_STOP)
);
const numForceStopArchives = allArchives.length - restorableArchives.length;
if (numForceStopArchives > 0) {
console.log(`WARNING: Skipped ${numForceStopArchives} archive(s) of type 'ON_FORCED_STOP' that were generated when the server exited ungracefully`);
}
if (restorableArchives.length > 0) {
await restoreLocalBackup(restorableArchives[0]);
} else {
console.log(`No backups found - leaving 'worlds' folder as is`);
}
}
async function restoreLocalBackup(backupArchiveName) {
if (!/\.zip$/gi.test(backupArchiveName)) {
backupArchiveName = backupArchiveName + '.zip';
}
const backupArchivePath = `${BACKUP_FOLDER_PATH}/${backupArchiveName}`;
if (!(await fs.pathExists(backupArchivePath))) {
console.error(`Could not find backup archive: ${backupArchivePath}`);
return false;
} else {
fs.removeSync(SERVER_WORLDS_FOLDER_PATH);
fs.ensureDirSync(SERVER_WORLDS_FOLDER_PATH);
await pipeline(
fs.createReadStream(backupArchivePath),
unzipper.Extract({
path: SERVER_WORLDS_FOLDER_PATH
})
);
console.log(`Successfully restored backup ${backupArchivePath}`)
return true;
}
}
function getBackupsToPurge(backupFileNameList, maxToKeep) {
backupFileNameList.sort((name1, name2) => {
const ts1Match = name1.match(/\d*/);
const ts2Match = name2.match(/\d*/);
const ts1 = parseInt(ts1Match[0]);
const ts2 = parseInt(ts2Match[0]);
return ts2 - ts1;
});
if (maxToKeep != null && maxToKeep > -1) {
return backupFileNameList.slice(maxToKeep);
} else {
return [];
}
};
async function purgeOldLocalBackups() {
fs.ensureDirSync(BACKUP_FOLDER_PATH);
const allArchives = await fs.readdir(BACKUP_FOLDER_PATH);
await Promise.all(Object.keys(BACKUP_TYPES).map(async (backupType) => {
const maxBackupTypes = localBackupKeepCount[backupType];
const backupsToPurge = getBackupsToPurge(allArchives.filter(
fileName => fileName.includes(backupType)
), maxBackupTypes);
backupsToPurge.forEach(async (backupToPurge) => {
await fs.remove(`${BACKUP_FOLDER_PATH}/${backupToPurge}`);
console.log(`Removed ${backupToPurge} from local backups folder due to parameters defined in config["backup"]["num-backups-to-keep-for-type"]["local"]`);
});
}));
}
async function purgeOldRemoteBackups() {
const bucketContents = await s3.listObjects({
Bucket: bucketName
}).promise();
const allArchives = bucketContents.Contents.map(entry => entry.Key);
await Promise.all(Object.keys(BACKUP_TYPES).map(async (backupType) => {
const maxBackupTypes = remoteBackupKeepCount[backupType];
const backupsToPurge = getBackupsToPurge(allArchives.filter(
fileName => fileName.includes(backupType)
), maxBackupTypes);
backupsToPurge.forEach(async (backupToPurge) => {
await s3.deleteObject({
Bucket: bucketName,
Key: backupToPurge
}).promise();
console.log(`Removed ${backupToPurge} from AWS S3 due to parameters defined in config["backup"]["num-backups-to-keep-for-type"]["remote"]`);
});
}));
}
const pushBackupToRemote = util.promisify((archiveName, callback) => {
const readStream = fs.createReadStream(`${BACKUP_FOLDER_PATH}/${archiveName}`);
var params = {
Bucket: bucketName,
Key: archiveName,
Body: readStream
};
s3.upload(params, function(err, data) {
if (!err) {
console.log(`Successfully backed up ${archiveName} to AWS S3`);
callback();
} else {
console.log(`Error uploading ${archiveName} to AWS S3:`);
console.error(err);
}
});
});
function getRemoteBackupsToDownload(allRemoteBackups, allLocalBackups) {
const lists = Object.keys(BACKUP_TYPES).map((backupType) => {
const maxBackupTypes = remoteBackupKeepCount[backupType];
const localBackups = allLocalBackups.filter(
fileName => fileName.includes(backupType)
);
const remoteBackups = allRemoteBackups.filter(
fileName => fileName.includes(backupType)
);
let allBackupsOfType = localBackups.concat(remoteBackups);
allBackupsOfType = [...new Set(allBackupsOfType)]; // remove duplicates
allBackupsOfType.sort((name1, name2) => {
const ts1Match = name1.match(/\d*/);
const ts2Match = name2.match(/\d*/);
const ts1 = parseInt(ts1Match[0]);
const ts2 = parseInt(ts2Match[0]);
return ts2 - ts1;
});
const slicedBackupsOfType = allBackupsOfType.slice(0, maxBackupTypes);
const backupsToDownload = slicedBackupsOfType.filter((backup) => !localBackups.includes(backup));
return backupsToDownload;
});
const merged = [].concat.apply([], lists);
return merged;
}
async function downloadRemoteBackups() {
if (s3) {
console.log('Downloading remote backups from AWS S3...');
fs.ensureDirSync(BACKUP_FOLDER_PATH);
const bucketContents = await s3.listObjects({
Bucket: bucketName
}).promise();
const allRemoteArchives = bucketContents.Contents.map(entry => entry.Key);
const allLocalArchives = await fs.readdir(BACKUP_FOLDER_PATH);
const remoteBackupsToDownload = getRemoteBackupsToDownload(allRemoteArchives, allLocalArchives);
await Promise.all(remoteBackupsToDownload.map(async (backup) => {
const response = await s3.getObject({
Bucket: bucketName,
Key: backup
}).promise();
await fs.outputFile(`${BACKUP_FOLDER_PATH}/${backup}`, response.Body);
console.log(`Downloaded ${backup}`);
}));
console.log(`Downloaded ${remoteBackupsToDownload.length} backup(s) from from AWS S3 bucket ${bucketName}`)
await purgeOldLocalBackups();
}
}
async function getBackupList() {
await fs.ensureDir(BACKUP_FOLDER_PATH);
const allArchives = await fs.readdir(BACKUP_FOLDER_PATH);
return allArchives.filter(archive => !/\.gitkeep/.test(archive));
}
// TODO: asyncify
async function getBackupSizeList() {
await fs.ensureDir(BACKUP_FOLDER_PATH);
const allArchiveNames = await fs.readdir(BACKUP_FOLDER_PATH);
return allArchiveNames.filter(archive => !/\.gitkeep/.test(archive)).map(archiveName => {
const stats = fs.statSync(`${BACKUP_FOLDER_PATH}/${archiveName}`);
const {size} = stats;
const numberPrefixRegex = /^\d*/;
const timestamp = (archiveName || "").match(numberPrefixRegex)[0];
return timestamp != null ? {name: archiveName, size, sizeString: formatBytes(size), timestamp: Number(timestamp)}: null;
}).filter(entry => entry != null);
}
async function doesLockFileExistOrS3Disabled() {
if (!s3) {
return false;
}
const bucketContents = await s3.listObjects({
Bucket: bucketName
}).promise();
return await bucketContents.Contents.map(entry => entry.Key).includes(BUCKET_LOCK_FILE_NAME);
}
const createLockFileIfS3Enabled = util.promisify((callback) => {
if (s3) {
const readStream = fs.createReadStream(BUCKET_LOCK_FILE_CONTENTS_PATH);
var params = {
Bucket: bucketName,
Key: BUCKET_LOCK_FILE_NAME,
Body: readStream
};
s3.upload(params, function(err, data) {
if (!err) {
console.log(`Successfully created lock file ${BUCKET_LOCK_FILE_NAME} in AWS S3`);
callback();
} else {
console.log(`Error created lock file ${BUCKET_LOCK_FILE_NAME} in AWS S3:`);
console.error(err);
}
});
} else {
callback();
}
});
async function deleteLockFileIfExists() {
if (s3) {
await s3.deleteObject({
Bucket: bucketName,
Key: BUCKET_LOCK_FILE_NAME
}).promise();
console.log(`Successfully removed lock file from S3 bucket: ${BUCKET_LOCK_FILE_NAME}`);
}
}
module.exports = {
createBackupBucketIfNotExists,
downloadRemoteBackups,
createBackup,
restoreLocalBackup,
restoreLatestLocalBackup,
createUnscheduledBackup,
getBackupList,
getBackupSizeList,
doesLockFileExistOrS3Disabled,
createLockFileIfS3Enabled,
deleteLockFileIfExists,
};