-
Notifications
You must be signed in to change notification settings - Fork 0
/
metadata.js
397 lines (344 loc) · 10.2 KB
/
metadata.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
const debug = require('debug')('ara-filesystem:debug')
const { validate } = require('ara-util')
const { create } = require('./create')
const extend = require('extend')
const pify = require('pify')
const fs = require('fs')
const METADATA_FILE = 'metadata.json'
/**
* Writes a metadata JSON file to the metadata partition of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.password
* @param {String} opts.afsPassword
* @param {String} opts.filepath
* @return {Object}
*/
async function writeFile(opts = {}) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.password || 'string' !== typeof opts.password) {
throw new TypeError('Password must be non-empty string.')
} else if (opts.afsPassword && 'string' !== typeof opts.afsPassword) {
throw TypeError('Expecting non-empty password.')
} else if (!opts.filepath || 'string' !== typeof opts.filepath) {
throw new TypeError('File path must be a non-empty string.')
}
const {
keyringOpts = {},
password,
filepath,
did
} = opts
let { afsPassword } = opts
afsPassword = afsPassword || password
const { afs, partition } = await _getEtcPartition(opts)
try {
await validate({
did,
password: afsPassword,
keyringOpts,
label: 'writeFile'
})
} catch (err) {
throw err
}
try {
await pify(fs.access)(filepath)
} catch (err) {
throw new Error(`Filepath ${filepath} doesn't exist.`)
}
let fileContents = await pify(fs.readFile)(filepath, 'utf8')
try {
fileContents = JSON.parse(fileContents)
} catch (err) {
throw new Error('Contents of file is not valid JSON.')
}
const contents = Object.assign({}, await _readMetadataFile(partition), fileContents)
await _writeMetadataFile(partition, contents)
await afs.close()
return contents
}
/**
* Writes a metadata key/value pair to the metadata partition of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.password
* @param {String} opts.afsPassword
* @param {String} opts.key
* @param {Mixed} opts.value
* @return {Object}
*/
async function writeKey(opts = {}) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.password || 'string' !== typeof opts.password) {
throw new TypeError('Password must be non-empty string.')
} else if (opts.afsPassword && 'string' !== typeof opts.afsPassword) {
throw TypeError('Expecting non-empty password.')
} else if (!opts.key || 'string' !== typeof opts.key) {
throw new TypeError('Key must be be a non-empty string.')
} else if (!opts.value) {
throw new TypeError('Must provide a value to store.')
}
const {
did,
key,
value,
password,
keyringOpts = {}
} = opts
let { afsPassword } = opts
afsPassword = afsPassword || password
const { afs, partition } = await _getEtcPartition(opts)
try {
await validate({
did,
password: afsPassword,
keyringOpts,
label: 'writeKey'
})
} catch (err) {
throw err
}
if (!(await _metadataFileExists(partition))) {
await _createMetadataFile(partition)
}
const contents = await _readMetadataFile(partition)
contents[key] = value
await _writeMetadataFile(partition, contents)
debug('%s written to metadata', key)
await afs.close()
return contents
}
/**
* Writes metadata key/value pairs to the metadata partition of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.password
* @param {String} opts.afsPassword
* @param {Object} opts.keys
* @return {Object}
*/
async function writeKeys(opts = {}) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.password || 'string' !== typeof opts.password) {
throw new TypeError('Password must be non-empty string.')
} else if (opts.afsPassword && 'string' !== typeof opts.afsPassword) {
throw TypeError('Expecting non-empty password.')
} else if (!opts.keys || 'object' !== typeof opts.keys) {
throw new TypeError('Expected opts.keys to be an object.')
}
const {
did,
keys,
password,
keyringOpts = {}
} = opts
let { afsPassword } = opts
afsPassword = afsPassword || password
const { afs, partition } = await _getEtcPartition(opts)
try {
await validate({
did,
password: afsPassword,
keyringOpts,
label: 'writeKey'
})
} catch (err) {
throw err
}
if (!(await _metadataFileExists(partition))) {
await _createMetadataFile(partition)
}
const contents = await _readMetadataFile(partition)
extend(true, contents, keys)
await _writeMetadataFile(partition, contents)
debug('%s written to metadata', keys)
await afs.close()
return contents
}
/**
* Reads a metadata key from the metadata partition of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.key
* @return {Mixed}
*/
async function readKey(opts = {}) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.key || 'string' !== typeof opts.key) {
throw new TypeError('Key must be a non-empty string.')
}
const { key } = opts
const contents = await readFile(opts)
if (!Object.prototype.hasOwnProperty.call(contents, key)) {
throw new Error(`Metadata file does not contain key ${key}.`)
}
debug('metadata key %s: %s', key, contents[key].toString())
return contents[key]
}
/**
* Deletes a metadata key/value pair from the metadata partition of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.password
* @param {String} opts.afsPassword
* @param {String} opts.key
*/
async function delKey(opts) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.password || 'string' !== typeof opts.password) {
throw new TypeError('Password must be non-empty string.')
} else if (opts.afsPassword && 'string' !== typeof opts.afsPassword) {
throw TypeError('Expecting non-empty password.')
} else if (!opts.key || 'string' !== typeof opts.key) {
throw new TypeError('Key must be a non-empty string.')
}
const {
did,
key,
password,
keyringOpts = {}
} = opts
let { afsPassword } = opts
afsPassword = afsPassword || password
const { afs, partition } = await _getEtcPartition(opts)
try {
await validate({
did,
password: afsPassword,
keyringOpts,
label: 'delKey'
})
} catch (err) {
throw err
}
const contents = await _readMetadataFile(partition)
if (!Object.prototype.hasOwnProperty.call(contents, key)) {
throw new Error(`Metadata file does not contain key ${key}.`)
}
delete contents[key]
await _writeMetadataFile(partition, contents)
debug('%s removed from metadata', key)
await afs.close()
return contents
}
/**
* Empties all metadata contents of an AFS
* @param {Object} opts
* @param {String} opts.did
* @param {String} opts.password
* @param {String} opts.afsPassword
*/
async function clear(opts) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
} else if (!opts.password || 'string' !== typeof opts.password) {
throw new TypeError('Password must be non-empty string.')
} else if (opts.afsPassword && 'string' !== typeof opts.afsPassword) {
throw TypeError('Expecting non-empty password.')
}
const {
did,
password,
keyringOpts = {}
} = opts
let { afsPassword } = opts
afsPassword = afsPassword || password
try {
await validate({
did,
password: afsPassword,
keyringOpts,
label: 'clear'
})
} catch (err) {
throw err
}
const { afs, partition } = await _getEtcPartition(opts)
if (!(await _metadataFileExists(partition))) {
throw new Error('No metadata to clear.')
}
// sets metadata contents to {}
await _createMetadataFile(partition)
await afs.close()
debug('metadata contents cleared')
}
/**
* Reads all metadata from an AFS
* @param {Object} opts
* @param {String} opts.did
* @return {Object}
*/
async function readFile(opts) {
if (!opts || 'object' !== typeof opts) {
throw new TypeError('Expecting opts to be an object.')
} else if (!opts.did || 'string' !== typeof opts.did) {
throw new TypeError('DID URI must be a non-empty string.')
}
const { afs, partition } = await _getEtcPartition(opts)
const results = await _readMetadataFile(partition)
await afs.close()
return results
}
async function _readMetadataFile(partition) {
if (!(await _metadataFileExists(partition))) {
return {}
}
try {
const file = await pify(partition.readFile)(METADATA_FILE)
return JSON.parse(file.toString())
} catch (err) {
return {}
}
}
async function _writeMetadataFile(partition, contents) {
await pify(partition.writeFile)(METADATA_FILE, Buffer.from(JSON.stringify(contents)))
}
async function _createMetadataFile(partition) {
await _writeMetadataFile(partition, {})
}
async function _metadataFileExists(partition) {
try {
await pify(partition.access)(METADATA_FILE)
return true
} catch (_) {
return false
}
}
async function _getEtcPartition(opts) {
let partition
let afs
try {
({ afs } = await create(opts))
partition = afs.partitions.etc
} catch (err) {
throw err
}
return { afs, partition }
}
module.exports = {
writeFile,
writeKeys,
writeKey,
readFile,
readKey,
delKey,
clear
}