-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.ts
187 lines (170 loc) · 5.3 KB
/
index.ts
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
import { Storage as DStorage } from '../../Plugin/Storage';
import { Storage, Bucket, GetSignedUrlConfig } from '@google-cloud/storage';
import { DeepPartial } from '../../utils/DeepPartial';
import { Dimension, StorageType } from '../../Dimension';
import { Plugin } from '../../Plugin';
import path from 'path';
import fs, { copyFileSync } from 'fs';
import { Database } from '../../Plugin/Database';
import { Tournament } from '../../Tournament';
import LRUFileCache from '../../utils/LRUFileCache';
import { LOCAL_DIR } from '../../utils/System';
import { Logger } from '../../Logger';
import { deepCopy } from '../../utils/DeepCopy';
import { deepMerge } from '../../utils/DeepMerge';
export class GCloudStorage extends DStorage {
public name = 'GCloudStorage';
public type: Plugin.Type = Plugin.Type.STORAGE;
public storage: Storage;
public configs: GCloudStorage.Configs = {
keyFilename: '',
projectId: '',
fileCacheMaxSize: 1024 * 1024 * 1024,
loggingLevel: Logger.LEVEL.INFO,
cacheDir: 'cache',
};
public log: Logger;
public dimensionBucket: Bucket;
private lruFileCache: LRUFileCache;
constructor(configs: DeepPartial<GCloudStorage.Configs>) {
super();
this.configs = deepMerge(this.configs, deepCopy(configs));
// default cache size of 1 GB
this.lruFileCache = new LRUFileCache(
this.configs.fileCacheMaxSize,
path.join(LOCAL_DIR, this.configs.cacheDir)
);
this.log = new Logger(this.configs.loggingLevel, 'GCloud-Storage');
}
/**
* Initializer. Initializes the storage object and creates necessary buckets
*/
async initialize(dimension: Dimension): Promise<void> {
const bucketName =
dimension.name.toLowerCase().replace(/ /g, '_') +
'_' +
dimension.id.toLowerCase();
this.storage = new Storage({
keyFilename: this.configs.keyFilename,
projectId: this.configs.projectId,
});
const exists = await this.storage.bucket(bucketName).exists();
if (!exists[0]) {
this.log.system(`creating bucket ${bucketName}`);
await this.storage.createBucket(bucketName);
}
this.dimensionBucket = this.storage.bucket(bucketName);
}
async uploadTournamentFile(
file: string,
user: Database.User,
tournament: Tournament
): Promise<string> {
const dest = `users/${user.username}_${
user.playerID
}/tournaments/${tournament.getKeyName()}/bot.zip`;
return this.dimensionBucket
.upload(file, {
destination: dest,
})
.then(() => {
this.log.system(
`uploaded tournament file for player ${user.playerID} to ${dest}`
);
return dest;
});
}
async upload(file: string, destination?: string): Promise<string> {
const dest = `${destination ? destination : path.basename(file)}`;
return this.dimensionBucket
.upload(file, {
destination: dest,
})
.then(() => {
this.log.system(`uploaded file from ${file} to ${dest}`);
return dest;
});
}
async download(
key: string,
destination: string,
useCached: boolean
): Promise<string> {
return new Promise((resolve) => {
if (useCached) {
const cachedPath = this.lruFileCache.get(key);
// if there is a cached path, use it
if (cachedPath) {
copyFileSync(cachedPath, destination);
resolve(destination);
return;
}
}
const file = this.dimensionBucket.file(key);
const ws = file
.createReadStream()
.pipe(fs.createWriteStream(destination));
ws.on('close', async () => {
// store in cache
const cachedPath = await this.lruFileCache.add(key, destination);
this.log.system(
`writing from bucket ${key} -> ${destination}; cached to ${cachedPath}`
);
resolve(destination);
});
});
}
/**
* Returns a download URL to use to download an object
* @param key - key referencing the object to download
*/
async getDownloadURL(key: string): Promise<string> {
const options: GetSignedUrlConfig = {
version: 'v4',
action: 'read',
expires: new Date().getTime() + 15 * 60 * 1000,
};
return this.dimensionBucket
.file(key)
.getSignedUrl(options)
.then((url) => {
return url[0];
});
}
public async manipulate(dimension: Dimension): Promise<void> {
dimension.configs.backingDatabase = StorageType.GCLOUD;
return;
}
}
export namespace GCloudStorage {
/**
* Specific configurations for GCloud storage
*/
export interface Configs extends DeepPartial<DStorage.Configs> {
/**
* Path to key file from a google account service key
*/
keyFilename: string;
/**
* Project ID
*/
projectId: string;
/**
* When caching files to prevent downloading the same data files over and over, this is the max size of files to
* try and cache before throwing out the largest least used files.
*
* @default `1 GB = 1024 * 1024 * 1024`
*/
fileCacheMaxSize: number;
/**
* Location for all cached files. Actual location is a subdirectry of the local directory used for storing files
* related to dimensions
* @default `cache`
*/
cacheDir: string;
/**
* Logging level for storage service
*/
loggingLevel: Logger.LEVEL;
}
}