-
Notifications
You must be signed in to change notification settings - Fork 29
/
storage.ts
317 lines (298 loc) · 8.58 KB
/
storage.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
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
/* eslint-disable @typescript-eslint/no-explicit-any */
import axios from 'axios';
import crypto from 'crypto';
import * as Minio from 'minio';
import {
ErrorInvalidUrl,
ErrorStorageBucketNotFound,
ErrorStorageClientNotInitialized,
ErrorStorageFileNotFound,
ErrorStorageFileNotUploaded,
} from './error';
import { UploadFile, StorageCredentials, StorageParams } from './types';
import { isValidUrl } from './utils';
import { HttpStatus } from './constants';
/**
*
* @deprecated StorageClient is deprecated. Use Minio.Client directly.
*
* ## Introduction
*
* This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
*
* The instance creation of `StorageClient` should be made using its constructor:
*
* ```ts
* constructor(params: StorageParams, credentials?: StorageCredentials)
* ```
*
* > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
*
* ## Installation
*
* ### npm
* ```bash
* npm install @human-protocol/sdk
* ```
*
* ### yarn
* ```bash
* yarn install @human-protocol/sdk
* ```
*
* ## Code example
*
* ```ts
* import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
*
* const credentials: StorageCredentials = {
* accessKey: 'ACCESS_KEY',
* secretKey: 'SECRET_KEY',
* };
* const params: StorageParams = {
* endPoint: 'http://localhost',
* port: 9000,
* useSSL: false,
* region: 'us-east-1'
* };
*
* const storageClient = new StorageClient(params, credentials);
* ```
*/
export class StorageClient {
private client: Minio.Client;
private clientParams: StorageParams;
/**
* **Storage client constructor**
*
* @param {StorageParams} params - Cloud storage params
* @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
*/
constructor(params: StorageParams, credentials?: StorageCredentials) {
try {
this.clientParams = params;
this.client = new Minio.Client({
...params,
accessKey: credentials?.accessKey ?? '',
secretKey: credentials?.secretKey ?? '',
});
} catch (e) {
throw ErrorStorageClientNotInitialized;
}
}
/**
* This function downloads files from a bucket.
*
* @param {string[]} keys Array of filenames to download.
* @param {string} bucket Bucket name.
* @returns {any[]} Returns an array of json files downloaded and parsed into objects.
*
*
* **Code example**
*
* ```ts
* import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
*
* const params: StorageParams = {
* endPoint: 'http://localhost',
* port: 9000,
* useSSL: false,
* region: 'us-east-1'
* };
*
* const storageClient = new StorageClient(params);
*
* const keys = ['file1.json', 'file2.json'];
* const files = await storageClient.downloadFiles(keys, 'bucket-name');
* ```
*/
public async downloadFiles(keys: string[], bucket: string): Promise<any[]> {
const isBucketExists = await this.client.bucketExists(bucket);
if (!isBucketExists) {
throw ErrorStorageBucketNotFound;
}
return Promise.all(
keys.map(async (key) => {
try {
const response = await this.client.getObject(bucket, key);
const content = response?.read();
return { key, content: JSON.parse(content?.toString('utf-8') || '') };
} catch (e) {
throw ErrorStorageFileNotFound;
}
})
);
}
/**
* This function downloads files from a Url.
*
* @param {string} url Url of the file to download.
* @returns {any} Returns the JSON file downloaded and parsed into object.
*
*
* **Code example**
*
* ```ts
* import { StorageClient } from '@human-protocol/sdk';
*
* const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
* ```
*/
public static async downloadFileFromUrl(url: string): Promise<any> {
if (!isValidUrl(url)) {
throw ErrorInvalidUrl;
}
try {
const { data, status } = await axios.get(url, {
headers: {
'Content-Type': 'application/json',
},
});
if (status !== HttpStatus.OK) {
throw ErrorStorageFileNotFound;
}
return data;
} catch (e) {
throw ErrorStorageFileNotFound;
}
}
/**
* This function uploads files to a bucket.
*
* @param {any[]} files Array of objects to upload serialized into json.
* @param {string} bucket Bucket name.
* @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
*
*
* **Code example**
*
* ```ts
* import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
*
* const credentials: StorageCredentials = {
* accessKey: 'ACCESS_KEY',
* secretKey: 'SECRET_KEY',
* };
* const params: StorageParams = {
* endPoint: 'http://localhost',
* port: 9000,
* useSSL: false,
* region: 'us-east-1'
* };
*
* const storageClient = new StorageClient(params, credentials);
* const file1 = { name: 'file1', description: 'description of file1' };
* const file2 = { name: 'file2', description: 'description of file2' };
* const files = [file1, file2];
* const uploadedFiles = await storageClient.uploadFiles(files, 'bucket-name');
* ```
*/
public async uploadFiles(
files: any[],
bucket: string
): Promise<UploadFile[]> {
const isBucketExists = await this.client.bucketExists(bucket);
if (!isBucketExists) {
throw ErrorStorageBucketNotFound;
}
return Promise.all(
files.map(async (file) => {
const content = JSON.stringify(file);
const hash = crypto.createHash('sha1').update(content).digest('hex');
const key = `s3${hash}.json`;
try {
await this.client.putObject(bucket, key, content, {
'Content-Type': 'application/json',
});
return {
key,
url: `${this.clientParams.useSSL ? 'https' : 'http'}://${
this.clientParams.endPoint
}${
this.clientParams.port ? `:${this.clientParams.port}` : ''
}/${bucket}/${key}`,
hash,
};
} catch (e) {
throw ErrorStorageFileNotUploaded;
}
})
);
}
/**
* This function checks if a bucket exists.
*
* @param {string} bucket Bucket name.
* @returns {boolean} Returns `true` if exists, `false` if it doesn't.
*
*
* **Code example**
*
* ```ts
* import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
*
* const credentials: StorageCredentials = {
* accessKey: 'ACCESS_KEY',
* secretKey: 'SECRET_KEY',
* };
* const params: StorageParams = {
* endPoint: 'http://localhost',
* port: 9000,
* useSSL: false,
* region: 'us-east-1'
* };
*
* const storageClient = new StorageClient(params, credentials);
* const exists = await storageClient.bucketExists('bucket-name');
* ```
*/
public async bucketExists(bucket: string): Promise<boolean> {
return this.client.bucketExists(bucket);
}
/**
* This function list all file names contained in the bucket.
*
* @param {string} bucket Bucket name.
* @returns {boolean} Returns the list of file names contained in the bucket.
*
*
* **Code example**
*
* ```ts
* import { StorageClient, StorageCredentials, StorageParams } from '@human-protocol/sdk';
*
* const credentials: StorageCredentials = {
* accessKey: 'ACCESS_KEY',
* secretKey: 'SECRET_KEY',
* };
* const params: StorageParams = {
* endPoint: 'http://localhost',
* port: 9000,
* useSSL: false,
* region: 'us-east-1'
* };
*
* const storageClient = new StorageClient(params, credentials);
* const fileNames = await storageClient.listObjects('bucket-name');
* ```
*/
public async listObjects(bucket: string): Promise<string[]> {
const isBucketExists = await this.client.bucketExists(bucket);
if (!isBucketExists) {
throw ErrorStorageBucketNotFound;
}
try {
return new Promise((resolve, reject) => {
const keys: string[] = [];
const stream = this.client.listObjectsV2(bucket, '', true, '');
stream.on('data', (obj: { name: string }) => keys.push(obj.name));
stream.on('error', reject);
stream.on('end', () => {
resolve(keys);
});
});
} catch (e) {
throw new Error(String(e));
}
}
}