tree: Ensure directory exists and lock works across nurkel/urkel.

Author: nodech

lib/tree.js

@@ -7,10 +7,11 @@
 
 const assert = require('bsert');
 const fs = require('bfile');
+const {BufferMap} = require('buffer-map');
+const LockFile = require('urkel/lib/lockfile');
 const nurkel = require('./nurkel');
 const Proof = require('./proof');
 const {randomPath} = require('./util');
-const {BufferMap} = require('buffer-map');
 const {
   asyncIterator,
   syncIterator,
@@ -52,6 +53,8 @@ class Tree {
 
     this.isOpen = false;
     this.tree = null;
+    // This is used to lock the tree for urkel as well.
+    this.lockFile = new LockFile(fs, this.prefix);
 
     this.init();
   }
@@ -123,6 +126,16 @@ class Tree {
     return this;
   }
 
+  /**
+   * Ensure we have the directory.
+   * @returns {Promise}
+   */
+
+  async ensure() {
+    assert(!this.isOpen, ERR_OPEN);
+    await fs.mkdirp(this.prefix, 0o750);
+  }
+
   /**
    * Open tree.
    * @param {Hash} [rootHash=null]
@@ -132,6 +145,9 @@ class Tree {
   async open(rootHash) {
     assert(!this.isOpen, ERR_OPEN);
 
+    await this.ensure();
+    await this.lockFile.open();
+
     await nurkel.tree_open(this.tree, this.prefix);
     this.isOpen = true;
 
@@ -149,6 +165,7 @@ class Tree {
     assert(this.isOpen, ERR_CLOSED);
 
     await nurkel.tree_close(this.tree);
+    await this.lockFile.close();
     this.isOpen = false;
   }
 

lib/urkel.js

@@ -119,6 +119,7 @@ class WrappedTree {
 
   async open(rootHash) {
     assert(!this.isOpen, ERR_OPEN);
+
     try {
       await this._tree.open(rootHash);
     } catch (e) {

test/iterator-test.js

@@ -1,8 +1,7 @@
 'use strict';
 
 const assert = require('bsert');
-const fs = require('fs');
-const {testdir, rmTreeDir} = require('./util/common');
+const {testdir, rmTreeDir, isTreeDir} = require('./util/common');
 const nurkel = require('..');
 
 const keys = {
@@ -15,8 +14,20 @@ const keys = {
   0: Buffer.alloc(32, 0x00)
 };
 
-for (const memory of [false, true]) {
-describe(`Urkel Iterator (${memory ? 'MemTree' : 'Tree'})`, function () {
+const treeCreateOptions = {
+  'nurkel': {},
+  // use legacy tree
+  'urkel': {
+    urkel: true
+  },
+  // legacy tree as in memory tree
+  'memory': {
+    memory: true
+  }
+};
+
+for (const [name, treeTestOptions] of Object.entries(treeCreateOptions)) {
+describe(`Urkel Iterator (${name})`, function () {
   let prefix, tree;
 
   const addEntries = async () => {
@@ -35,10 +46,7 @@ describe(`Urkel Iterator (${memory ? 'MemTree' : 'Tree'})`, function () {
   beforeEach(async () => {
     prefix = testdir('tx');
 
-    if (!memory)
-      fs.mkdirSync(prefix);
-
-    tree = nurkel.create({ memory, prefix });
+    tree = nurkel.create({ prefix, ...treeTestOptions });
     await tree.open();
 
     await addEntries();
@@ -47,7 +55,7 @@ describe(`Urkel Iterator (${memory ? 'MemTree' : 'Tree'})`, function () {
   afterEach(async () => {
     await tree.close();
 
-    if (fs.existsSync(prefix))
+    if (isTreeDir(prefix))
       rmTreeDir(prefix);
   });
 

test/proof-test.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const assert = require('bsert');
-const fs = require('fs');
 const {testdir, rmTreeDir, isTreeDir} = require('./util/common');
 const nurkel = require('..');
 const {BLAKE2b, proofTypes, statusCodes} = nurkel;
@@ -38,9 +37,21 @@ async function populateTree(tree, roots) {
   await txn.close();
 }
 
-for (const memory of [false, true]) {
-describe(`Urkel Proof (${memory ? 'MemTree' : 'Tree'})`, function () {
-  const Tree = memory ? nurkel.MemTree : nurkel.Tree;
+const treeCreateOptions = {
+  'nurkel': {},
+  // use legacy tree
+  'urkel': {
+    urkel: true
+  },
+  // legacy tree as in memory tree
+  'memory': {
+    memory: true
+  }
+};
+
+for (const [name, treeTestOptions] of Object.entries(treeCreateOptions)) {
+describe(`Urkel Proof (${name})`, function () {
+  const Tree = name !== 'nurkel' ? nurkel.UrkelTree : nurkel.Tree;
   let prefix, tree, rootEntries, checkMatrix;
 
   const withSnap = (snap) => {
@@ -54,10 +65,7 @@ describe(`Urkel Proof (${memory ? 'MemTree' : 'Tree'})`, function () {
   beforeEach(async () => {
     prefix = testdir('tree');
 
-    if (!memory)
-      fs.mkdirSync(prefix);
-
-    tree = nurkel.create({ memory, prefix });
+    tree = nurkel.create({ prefix, ...treeTestOptions });
     await tree.open();
     rootEntries = {};
     await populateTree(tree, rootEntries);
@@ -73,7 +81,7 @@ describe(`Urkel Proof (${memory ? 'MemTree' : 'Tree'})`, function () {
   afterEach(async () => {
     await tree.close();
 
-    if (!memory && isTreeDir(prefix))
+    if (isTreeDir(prefix))
       rmTreeDir(prefix);
   });
 

test/transaction-segfault-test.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const fs = require('fs');
-const {testdir, rmTreeDir} = require('./util/common');
+const {testdir, rmTreeDir, isTreeDir} = require('./util/common');
 const {Tree} = require('../lib/tree');
 
 // Tests for the segfaults that were encountered.
@@ -20,7 +20,7 @@ describe('Urkel Transaction (segfault)', function () {
     if (tree.isOpen)
       await tree.close();
 
-    if (fs.existsSync(prefix))
+    if (isTreeDir(prefix))
       rmTreeDir(prefix);
   });
 

test/transaction-test.js

@@ -8,17 +8,26 @@ const {Proof} = nurkel;
 
 const NULL_HASH = Buffer.alloc(32, 0);
 
-for (const memory of [false, true]) {
-describe(`Urkel Transaction (${memory ? 'MemTree' : 'Tree'})`, function () {
+const treeCreateOptions = {
+  'nurkel': {},
+  // use legacy tree
+  'urkel': {
+    urkel: true
+  },
+  // legacy tree as in memory tree
+  'memory': {
+    memory: true
+  }
+};
+
+for (const [name, treeTestOptions] of Object.entries(treeCreateOptions)) {
+describe(`Urkel Transaction (${name})`, function () {
   let prefix, tree;
 
   beforeEach(async () => {
     prefix = testdir('tx');
 
-    if (!memory)
-      fs.mkdirSync(prefix);
-
-    tree = nurkel.create({ memory, prefix });
+    tree = nurkel.create({ prefix, ...treeTestOptions });
     await tree.open();
   });
 

test/tree-debug-test.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const assert = require('assert');
-const fs = require('fs');
 const {testdir, rmTreeDir, isTreeDir, sleep} = require('./util/common');
 const {Tree} = require('..');
 
@@ -35,8 +34,6 @@ describe('Nurkel debug state', function() {
 
   const before = () => {
     prefix = testdir('tree-gc');
-    fs.mkdirSync(prefix);
-
     tree = new Tree({ prefix });
   };
 
@@ -54,7 +51,18 @@ describe('Nurkel debug state', function() {
     });
 
     it('should open tree', async () => {
+      const afterLock = new Promise((r) => {
+        // mock ensure and open.
+        tree.ensure = () => {};
+        tree.lockFile.open = () => {
+          setImmediate(r);
+          return;
+        };
+      });
+
       const open = tree.open();
+      await afterLock;
+
       assert.deepStrictEqual(tree.debugInfoSync(), {
         ...CLOSED_TREE,
         workers: 1,

test/tree-gc-test.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const assert = require('bsert');
-const fs = require('fs');
 const {testdir, rmTreeDir, isTreeDir} = require('./util/common');
 const {Tree} = require('..');
 
@@ -13,7 +12,6 @@ describe('Urkel Tree (GC)', function () {
 
   beforeEach(() => {
     prefix = testdir('tree-gc');
-    fs.mkdirSync(prefix);
   });
 
   afterEach(() => {