Skip to content

Commit

Permalink
- fix error message to be more conformant with other RAS implementations
Browse files Browse the repository at this point in the history 
- get rid of purge warning message
- pass hypercore/corestore tests
  • Loading branch information
@zacharygriffee
zacharygriffee committed Oct 4, 2024
1 parent 8bea843 commit e1c6fc8
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 55 deletions.
116 changes: 74 additions & 42 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,20 @@ class RandomAccessIdb extends EventEmitter {

// Check if the database has been purged or closed
if (!this.db) {
// console.warn('Database has been purged. Reinitializing as a new file.');
await this._initializeDB(); // Reinitialize if the database was purged
}

// Ensure metadata is properly set up with defaults
if (!this.meta || isNaN(this.meta.length)) {
this.meta = {
fileName: this.fileName,
chunkSize: this.chunkSize,
length: 0 // Ensure valid length
};
}
}


get fileName() {
if (!this.meta) return null;
return this.meta.fileName;
Expand All @@ -77,7 +86,11 @@ class RandomAccessIdb extends EventEmitter {
}

get length() {
return this.meta.length;
return this?.meta?.length || 0;
}

get size() {
return this?.meta?.length || 0;
}

get paused() {
Expand All @@ -102,40 +115,45 @@ class RandomAccessIdb extends EventEmitter {
this.queue.addTask(async () => {
await this.ensureDBReady();

// If metadata doesn't exist, initialize it with default values
if (!this.meta || isNaN(this.meta.length)) {
this.meta = { fileName: this.fileName, chunkSize: this.chunkSize, length: 0 };
}

const blocks = this._blocks(offset, offset + data.length);
const db = this.db;
const tx = db.transaction('chunks', 'readwrite');
const store = tx.objectStore('chunks');

let cursor = 0;

for (const { block, start, end } of blocks) {
const chunk = await store.get(block) || { data: b4a.alloc(this.chunkSize) };
const chunkDataLength = end - start;
b4a.copy(b4a.from(data), chunk.data, start, cursor, cursor + chunkDataLength);

await store.put({ chunk: block, data: chunk.data });
cursor += chunkDataLength;
}

await tx.done;

const newLength = Math.max(this.meta.length, offset + data.length);
this.meta.length = newLength;
await this.metaManager.set(this.meta);
this.meta.length = isNaN(newLength) ? 0 : newLength; // Sanitize length value
await this.metaManager.set(this.meta); // Persist metadata

cb(null);
cb(null); // Signal success
}).catch(cb);
}


read(offset, size, cb = () => {}) {
this.queue.addTask(async () => {
await this.ensureDBReady();

const length = this.meta.length;

if (length === 0) {
return cb(null, b4a.alloc(size - offset));
// If the file doesn't exist, or it's empty, return a zero-byte buffer
if (length === 0 || !this.meta) {
return cb(null, b4a.alloc(size || 0)); // If 'size' is undefined, default to 0
} else if (offset + size > length) {
return cb(new FileSystemError(`Could not satisfy length. offset + size (${offset + size}) is greater than the file length (${length})`, "EINVAL"));
}
Expand All @@ -161,6 +179,7 @@ class RandomAccessIdb extends EventEmitter {
}).catch(cb);
}


del(offset, size, cb = () => {}) {
this.queue.addTask(async () => {
await this.ensureDBReady();
Expand Down Expand Up @@ -287,32 +306,47 @@ class RandomAccessIdb extends EventEmitter {
}).catch(cb);
}

// Retrieve file metadata
// Retrieve file metadata
stat(cb = () => {}) {
this.queue.addTask(async () => {
await this.ensureDBReady();
let err;
// Check if the file metadata exists
if (!this.meta || !this.meta.fileName || this.meta.length === 0) {
err = new FileSystemError(`File (${this.meta.fileName}) does not exist`, "ENOENT");

// If meta doesn't exist, assume the file doesn't exist and throw ENOENT
const meta = await this.metaManager.get(this.fileName);
if (!meta || isNaN(meta.length)) {
err = new FileSystemError(`File (${this.fileName}) does not exist`, "ENOENT");

// Provide fallback stats with length 0 and no chunkSize
const fallbackStats = {
length: 0,
fileName: this.fileName
};

return cb(err, fallbackStats); // Throw ENOENT but provide fallback stats
}

// Return the file's stats (e.g., length, metadata)
// Sanitize length in case it is NaN (default it to 0)
meta.length = isNaN(meta.length) ? 0 : meta.length;

// Return actual stats if the file exists
const stats = {
length: this.meta.length,
size: this.meta.length,
chunkSize: this.meta.chunkSize,
fileName: this.meta.fileName
length: meta.length, // Ensure length is valid
size: meta.length, // Provide the same value for size
chunkSize: meta.chunkSize || undefined, // Only include chunkSize if available
fileName: meta.fileName
};

cb(err, stats); // Successfully return stats
cb(null, stats); // Return valid stats with no error if the file exists
}).catch(cb);
}


suspend(cb = () => {}) {
this.queue.pauseQueue();
setTimeout(() => {
this.emit('suspend');
this.emit('suspend');
cb();
}, 0);
}
Expand All @@ -329,10 +363,12 @@ class RandomAccessIdb extends EventEmitter {
}

purge(cb = () => {}) {
// If the file is already closed, skip to the purge process directly
if (this.closed) {
console.log('File already closed, purging directly');
this._performPurge(cb);
} else {
// Otherwise, queue the purge operation to ensure all pending tasks complete
this.queue.waitUntilQueueEmpty()
.then(() => this._performPurge(cb))
.catch(cb);
Expand All @@ -341,44 +377,40 @@ class RandomAccessIdb extends EventEmitter {

async _performPurge(cb = () => {}) {
try {
// Check if the database exists
const dbExists = await this._verifyDatabaseExists();
if (!dbExists) {
// console.warn(`Database ${this.fileName} does not exist, skipping purge.`);
return cb(null);
}
if (dbExists) {
console.log(`Purging file ${this.fileName} from database`);

console.log(`Purging file ${this.fileName}`);
// Attempt to delete the database
await IDB.deleteDB(this.fileName);
const isDeleted = !(await this._verifyDatabaseExists());

// Delete the file from IndexedDB using idb library
await IDB.deleteDB(this.fileName);

// Verify the deletion
const isDeleted = !(await this._verifyDatabaseExists());
if (!isDeleted) {
throw new Error(`Failed to delete database: ${this.fileName}`);
if (!isDeleted) {
console.warn(`Database ${this.fileName} may not have been deleted.`);
}
} else {
console.warn(`Database ${this.fileName} does not exist, skipping database deletion.`);
}

// Delete the metadata associated with this file
// Purge the metadata (always attempt this)
await this.metaManager.del(this.fileName);
this.db = null; // Clear the database connection
this.meta = { fileName: this.fileName, chunkSize: this.chunkSize, length: 0 }; // Reset metadata

// Mark the database as purged by setting db to null
this.db = null;

// Reset the metadata specific to this file
this.meta = { fileName: this.fileName, chunkSize: this.chunkSize, length: 0 };

// Remove the file from the allLoadedFiles map
// Remove from loaded files
allLoadedFiles.delete(this.fileName);

console.log(`Purge complete for file ${this.fileName}`);
cb(null);

cb(null); // Success callback
} catch (e) {
console.error(`Error during purge: ${e.message}`);
cb(e);
}
}




unlink(cb = () => {}) {
this.purge(cb);
}
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@zacharygriffee/random-access-idb",
"type": "module",
"version": "4.0.31",
"version": "4.1.0",
"main": "index.js",
"browser": "dist/index.min.js",
"description": "A rework of random-access-idb",
Expand Down
2 changes: 1 addition & 1 deletion test/hyper.test.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {test} from 'brittle';
import {solo, test} from 'brittle';
import b4a from 'b4a';
import 'fake-indexeddb/auto';
import defaultMaker from '../index.js';
Expand Down
23 changes: 12 additions & 11 deletions test/index.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -565,17 +565,18 @@ test('stat retrieves file metadata', async t => {
});
});

test('stat returns ENOENT if file length is 0', async t => {
t.plan(2);
const fileName = 'emptyStatFile.txt';
const ras = createFile(fileName, { chunkSize: 1024 });

// No data is written to the file, so length remains 0
ras.stat((err, stats) => {
t.is(err.code, 'ENOENT', 'Stat should return ENOENT error when file length is 0');
t.is(stats.length, 0, 'File length should be 0 when no data has been written');
});
});
// This behavior is no longer true. If meta exists then the file exists even if it is size=0
// test('stat returns ENOENT if file length is 0', async t => {
// t.plan(2);
// const fileName = 'emptyStatFile.txt';
// const ras = createFile(fileName, { chunkSize: 1024 });
//
// // No data is written to the file, so length remains 0
// ras.stat((err, stats) => {
// t.is(err.code, 'ENOENT', 'Stat should return ENOENT error when file length is 0');
// t.is(stats.length, 0, 'File length should be 0 when no data has been written');
// });
// });

test('suspend pauses the queue and emits suspend event', async t => {
t.plan(2);
Expand Down

0 comments on commit e1c6fc8

Please sign in to comment.