make pear dump consistent for file and pear

- mirror local files from the root of the pear project

Author: Didericis

subsystems/sidecar/ops/dump.js

@@ -4,6 +4,7 @@ const path = require('bare-path')
 const LocalDrive = require('localdrive')
 const Hyperdrive = require('hyperdrive')
 const plink = require('pear-link')
+const State = require('pear-state')
 const {
   ERR_PERMISSION_REQUIRED,
   ERR_DIR_NONEMPTY,
@@ -12,6 +13,7 @@ const {
 } = require('pear-errors')
 const Pod = require('../lib/pod')
 const Opstream = require('../lib/opstream')
+const { isWindows } = require('which-runtime')
 
 module.exports = class Dump extends Opstream {
   constructor(...args) {
@@ -36,9 +38,18 @@ module.exports = class Dump extends Opstream {
     }
 
     const parsed = plink.parse(link)
+
     const isFileLink = parsed.protocol === 'file:'
+    const fsPathname = isWindows
+      ? (parsed.pathname.startsWith('/')
+          ? parsed.pathname.slice(1)
+          : parsed.pathname
+        )
+          .split(path.posix.sep)
+          .join(path.win32.sep)
+      : parsed.pathname
     const isFile =
-      isFileLink && (await fsp.stat(parsed.pathname)).isDirectory() === false
+      isFileLink && (await fsp.stat(fsPathname)).isDirectory() === false
 
     const key = parsed.drive.key
     checkout =
@@ -48,25 +59,40 @@ module.exports = class Dump extends Opstream {
     const encryptionKey = traits?.encryptionKey
 
     const corestore = isFileLink ? null : sidecar.getCorestore(null, null)
-    let drive = null
 
-    if (corestore) {
+    let prefix
+    let drive
+
+    if (!isFileLink) {
       await corestore.ready()
       try {
         drive = new Hyperdrive(corestore, key, { encryptionKey })
         await drive.ready()
+        prefix = parsed.pathname
       } catch (err) {
         if (err.code !== 'DECODING_ERROR') throw err
         throw ERR_PERMISSION_REQUIRED('Encryption key required', {
           key,
           encrypted: true
         })
       }
+    } else {
+      const state = new State({
+        dir: isFile ? path.dirname(fsPathname) : fsPathname
+      })
+      await State.localPkg(state)
+      prefix = path.join('/', path.relative(state.dir, fsPathname))
+      drive = new LocalDrive(state.dir, { followLinks: true })
+      const isRoot = isWindows
+        ? /[a-zA-Z]:\\$/.test(state.dir)
+        : state.dir === '/'
+      if (isRoot) throw ERR_NOT_FOUND('No pear project found')
     }
-    const root = isFile ? path.dirname(parsed.pathname) : parsed.pathname
+    const pathname = prefix === '/' ? '' : prefix
+
     const pod = new Pod({
       corestore,
-      drive: isFileLink ? new LocalDrive(root, { followLinks: true }) : drive,
+      drive,
       key,
       checkout,
       swarm: sidecar.swarm
@@ -92,13 +118,6 @@ module.exports = class Dump extends Opstream {
     const src = pod.drive
     await src.ready()
 
-    const prefix = isFileLink ? '/' : parsed.pathname
-    const pathname =
-      !isFileLink && parsed.pathname === '/'
-        ? ''
-        : isFile
-          ? path.basename(parsed.pathname)
-          : prefix
     const entry = pathname === '' ? null : await src.entry(pathname)
 
     if (entry === null) {

test/06-dump.test.js

@@ -2,6 +2,9 @@
 const test = require('brittle')
 const tmp = require('test-tmp')
 const Localdrive = require('localdrive')
+const fs = require('bare-fs')
+const path = require('bare-path')
+const { isWindows } = require('which-runtime')
 
 const Helper = require('./helper')
 
@@ -43,20 +46,13 @@ test('pear dump', async function ({ ok, plan, teardown }) {
   ok(await dumped.exists('/package.json'), 'package.json should exist')
 })
 
-test('pear dump dumping subdirectory', async function ({
+test('pear dump dumping subdirectory from pear drive', async function ({
   ok,
   absent,
   plan,
   teardown
 }) {
   plan(4)
-  const path = require('bare-path')
-  const fs = require('bare-fs')
-  const exists = (path) =>
-    fs.promises.stat(path).then(
-      () => true,
-      () => false
-    )
   const helper = new Helper()
   teardown(() => helper.close(), { order: Infinity })
   await helper.ready()
@@ -93,6 +89,35 @@ test('pear dump dumping subdirectory', async function ({
   ok(await dumped.exists('/lib/pear.js'), 'lib/pear.js should exist')
 })
 
+test('pear dump dumping subdirectory from local drive', async function ({
+  ok,
+  absent,
+  plan,
+  teardown
+}) {
+  plan(4)
+  const helper = new Helper()
+  teardown(() => helper.close(), { order: Infinity })
+  await helper.ready()
+
+  const src = Helper.fixture('dump')
+  const link = isWindows
+    ? `file://${src.split(path.win32.sep).join(path.posix.sep)}/lib`
+    : `file://${src}/lib`
+  const out = await tmp()
+
+  teardown(() => Helper.gc(out))
+  const dump = await helper.dump({ link, dir: out })
+  teardown(() => Helper.teardownStream(dump))
+  const untilDump = await Helper.pick(dump, [{ tag: 'complete' }])
+  await untilDump.complete
+  const dumped = new Localdrive(out)
+  absent(await dumped.exists('/index.js'), 'index.js should not exist')
+  absent(await dumped.exists('/package.json'), 'package.json should not exist')
+  ok(await dumped.exists('/lib/dump.js'), 'lib/dump.js should exist')
+  ok(await dumped.exists('/lib/pear.js'), 'lib/pear.js should exist')
+})
+
 test('pear dump dumping to existing dir', async function ({
   absent,
   is,
@@ -230,7 +255,7 @@ test('pear dump dumping a single file', async function ({
   absent(await dumped.exists('/package.json'), 'package.json should not exist')
 })
 
-test('pear dump dumping a single file in a subdirectory', async function ({
+test('pear dump dumping a single file in a subdirectory from pear drive', async function ({
   ok,
   is,
   plan,
@@ -275,6 +300,73 @@ test('pear dump dumping a single file in a subdirectory', async function ({
   is(dirCount, 1, 'should have only one file in the lib directory')
 })
 
+test('pear dump should throw when dumping file outside a pear project', async function ({
+  plan,
+  teardown,
+  exception
+}) {
+  plan(1)
+
+  const helper = new Helper()
+  teardown(() => helper.close(), { order: Infinity })
+  await helper.ready()
+
+  const src = await tmp()
+  const out = await tmp()
+  teardown(async () => {
+    await Helper.gc(out)
+    await Helper.gc(src)
+  })
+  await fs.promises.writeFile(
+    path.join(src, 'test.js'),
+    'console.log("test")',
+    {
+      encoding: 'utf-8'
+    }
+  )
+  const link = isWindows
+    ? `file://${src.split(path.win32.sep).join(path.posix.sep)}/test.js`
+    : `file://${src}/test.js`
+
+  await exception(async () => {
+    const dump = helper.dump({ link, dir: out })
+    teardown(() => Helper.teardownStream(dump))
+    const untilDump = await Helper.pick(dump, [{ tag: 'complete' }])
+    await untilDump.complete
+  })
+})
+
+test('pear dump dumping a single file in a subdirectory from local drive', async function ({
+  ok,
+  is,
+  plan,
+  teardown
+}) {
+  plan(2)
+
+  const helper = new Helper()
+  teardown(() => helper.close(), { order: Infinity })
+  await helper.ready()
+
+  const src = Helper.fixture('dump')
+  const link = isWindows
+    ? `file://${src.split(path.win32.sep).join(path.posix.sep)}/lib/dump.js`
+    : `file://${src}/lib/dump.js`
+
+  const out = await tmp()
+
+  teardown(() => Helper.gc(out))
+  const dump = await helper.dump({ link, dir: out })
+  teardown(() => Helper.teardownStream(dump))
+  const untilDump = await Helper.pick(dump, [{ tag: 'complete' }])
+  await untilDump.complete
+  const dumped = new Localdrive(out)
+  let dirCount = 0
+  for await (const _ of dumped.readdir()) dirCount++
+  ok(await dumped.exists('/lib/dump.js'), 'lib/dump.js should exist')
+  is(dirCount, 1, 'should have only one file in the lib directory')
+})
+
 test('pear dump dumping to stdout', async function ({ ok, plan, teardown }) {
   plan(4)