Merge pull request #777 from cozy-labs/create-missing-remote-folders

Create missing remote folders

cli/src/remote/cozy.js

@@ -12,6 +12,8 @@ import { composeAsync } from '../utils/func'
 
 import type { RemoteDoc, RemoteDeletion } from './document'
 
+const { posix } = path
+
 const log = logger({
   component: 'RemoteCozy'
 })
@@ -136,6 +138,22 @@ export default class RemoteCozy {
     return {...results[0], _type: FILES_DOCTYPE}
   }
 
+  // FIXME: created_at is returned by some methods, but not all of them
+
+  async findOrCreateDirectoryByPath (path: string): Promise<RemoteDoc> {
+    try {
+      return await this.findDirectoryByPath(path)
+    } catch (err) {
+      if (!(err instanceof DirectoryNotFound)) throw err
+
+      const name = posix.basename(path)
+      const parentPath = posix.dirname(path)
+      const parentDir: RemoteDoc = await this.findOrCreateDirectoryByPath(parentPath)
+      const dirID = parentDir._id
+      return this.createDirectory({name, dirID})
+    }
+  }
+
   async downloadBinary (id: string): Promise<Readable> {
     const resp = await this.client.files.downloadById(id)
     return resp.body

cli/src/remote/index.js

@@ -62,7 +62,7 @@ export default class Remote implements Side {
     log.info({path}, 'Creating folder...')
 
     const [parentPath, name] = conversion.extractDirAndName(doc.path)
-    const parent: RemoteDoc = await this.remoteCozy.findDirectoryByPath(parentPath)
+    const parent: RemoteDoc = await this.remoteCozy.findOrCreateDirectoryByPath(parentPath)
     let dir: RemoteDoc
 
     try {
@@ -91,7 +91,7 @@ export default class Remote implements Side {
     log.info({path}, 'Uploading new file...')
     const stream = await this.other.createReadStreamAsync(doc)
     const [dirPath, name] = conversion.extractDirAndName(path)
-    const dir = await this.remoteCozy.findDirectoryByPath(dirPath)
+    const dir = await this.remoteCozy.findOrCreateDirectoryByPath(dirPath)
 
     // Emit events to track the upload progress
     let info = clone(doc)

cli/test/builders/metadata/base.js

@@ -12,7 +12,7 @@ export default class BaseMetadataBuilder {
     sides: MetadataSidesInfo
   }
 
-  constructor (pouch?: Pouch) {
+  constructor (pouch: ?Pouch) {
     this.pouch = pouch
     this.opts = {
       path: 'foo',

cli/test/builders/metadata/index.js

@@ -6,9 +6,9 @@ import DirMetadataBuilder from './dir'
 import FileMetadataBuilder from './file'
 
 export default class MetadataBuilders {
-  pouch: Pouch
+  pouch: ?Pouch
 
-  constructor (pouch: Pouch) {
+  constructor (pouch: ?Pouch) {
     this.pouch = pouch
   }
 

cli/test/unit/remote/cozy.js

@@ -167,6 +167,55 @@ describe('RemoteCozy', function () {
     })
   })
 
+  describe('findOrCreateDirectoryByPath', () => {
+    it('resolves with the exisisting directory if any', async function () {
+      const root = await remoteCozy.findDirectoryByPath('/')
+      const dir = await builders.remoteDir().create()
+      const subdir = await builders.remoteDir().inDir(dir).create()
+
+      let result = await remoteCozy.findOrCreateDirectoryByPath(root.path)
+      should(result).have.properties(root)
+      result = await remoteCozy.findOrCreateDirectoryByPath(dir.path)
+      should(result).have.properties(dir)
+      result = await remoteCozy.findOrCreateDirectoryByPath(subdir.path)
+      should(result).have.properties(subdir)
+    })
+
+    it('creates any missing parent directory', async function () {
+      const dir = await builders.remoteDir().named('dir').create()
+      await builders.remoteDir().named('subdir').inDir(dir).create()
+
+      let result = await remoteCozy.findOrCreateDirectoryByPath('/dir/subdir/foo')
+      should(result).have.properties({
+        type: 'directory',
+        path: '/dir/subdir/foo'
+      })
+      result = await remoteCozy.findOrCreateDirectoryByPath('/dir/bar/baz')
+      should(result).have.properties({
+        type: 'directory',
+        path: '/dir/bar/baz'
+      })
+      result = await remoteCozy.findOrCreateDirectoryByPath('/foo/bar/qux')
+      should(result).have.properties({
+        type: 'directory',
+        path: '/foo/bar/qux'
+      })
+    })
+
+    it('does not swallow errors', async function () {
+      this.config.cozyUrl = cozyStackDouble.url()
+      const remoteCozy = new RemoteCozy(this.config)
+
+      cozyStackDouble.stub((req, res) => {
+        res.writeHead(500, {'Content-Type': 'text/plain'})
+        res.end('Whatever')
+      })
+
+      await should(remoteCozy.findOrCreateDirectoryByPath('/whatever'))
+        .be.rejected()
+    })
+  })
+
   describe('downloadBinary', function () {
     it('resolves with a Readable stream of the file content', async function () {
       const remoteFile = await builders.remoteFile().data('foo').create()

cli/test/unit/remote/index.js

@@ -17,12 +17,15 @@ import timestamp from '../../../src/timestamp'
 import type { Metadata } from '../../../src/metadata'
 import type { RemoteDoc, JsonApiDoc } from '../../../src/remote/document'
 
+import MetadataBuilders from '../../builders/metadata'
 import configHelpers from '../../helpers/config'
 import pouchHelpers from '../../helpers/pouch'
 import {
   cozy, builders, deleteAll, createTheCouchdbFolder
 } from '../../helpers/cozy'
 
+const metadataBuilders = new MetadataBuilders()
+
 describe('Remote', function () {
   if (process.env.APPVEYOR) {
     it('is unstable on AppVeyor')
@@ -423,6 +426,12 @@ describe('Remote', function () {
         size: '36901'
       })
     })
+
+    it('creates the parent folder when missing', async function () {
+      const metadata: Metadata = metadataBuilders.fileMetadata().path('foo/bar/qux').build()
+      await this.remote.addFileAsync(metadata)
+      await should(cozy.files.statByPath('/foo/bar')).be.fulfilled()
+    })
   })
 
   describe('addFolderAsync', () => {
@@ -460,6 +469,12 @@ describe('Remote', function () {
         _rev: remoteDir._rev
       })
     })
+
+    it('creates the parent folder when missing', async function () {
+      const metadata: Metadata = metadataBuilders.dirMetadata().path('foo/bar/qux').build()
+      await this.remote.addFolderAsync(metadata)
+      await should(cozy.files.statByPath('/foo/bar')).be.fulfilled()
+    })
   })
 
   describe('overwriteFileAsync', function () {