Merge pull request #323 from atom/fuzzy-finder-support

Allow guests to use fuzzy-finder to open any remote editor shared by the host

Author: Antonio Scandurra

lib/editor-binding.js

@@ -2,7 +2,8 @@
 
 const path = require('path')
 const {Range, Emitter, Disposable, CompositeDisposable} = require('atom')
-const normalizeURI = require('./normalize-uri')
+const getPathWithNativeSeparators = require('./get-path-with-native-separators')
+const getEditorURI = require('./get-editor-uri')
 const {FollowState} = require('@atom/teletype-client')
 
 module.exports =
@@ -32,17 +33,12 @@ class EditorBinding {
 
     this.emitter.emit('did-dispose')
     this.emitter.dispose()
-
-    if (!this.isHost) this.editor.destroy()
   }
 
   setEditorProxy (editorProxy) {
     this.editorProxy = editorProxy
-    if (this.isHost) {
-      this.editor.onDidDestroy(() => this.editorProxy.dispose())
-    } else {
+    if (!this.isHost) {
       this.monkeyPatchEditorMethods(this.editor, this.editorProxy)
-      this.editor.onDidDestroy(() => this.dispose())
     }
 
     this.localCursorLayerDecoration = this.editor.decorateMarkerLayer(
@@ -63,20 +59,20 @@ class EditorBinding {
 
   monkeyPatchEditorMethods (editor, editorProxy) {
     const buffer = editor.getBuffer()
-    const bufferProxy = editorProxy.bufferProxy
+    const {bufferProxy} = editorProxy
     const hostIdentity = this.portal.getSiteIdentity(1)
-    const uriPrefix = hostIdentity ? `@${hostIdentity.login}` : 'remote'
+    const prefix = hostIdentity ? `@${hostIdentity.login}` : 'remote'
+    const bufferURI = getPathWithNativeSeparators(bufferProxy.uri)
 
-    const bufferURI = normalizeURI(bufferProxy.uri)
-    editor.getTitle = () => `${uriPrefix}: ${path.basename(bufferURI)}`
-    editor.getURI = () => ''
+    editor.getTitle = () => `${prefix}: ${path.basename(bufferURI)}`
+    editor.getURI = () => getEditorURI(this.portal.id, editorProxy.id)
     editor.copy = () => null
     editor.serialize = () => null
     editor.isRemote = true
 
     let remoteEditorCountForBuffer = buffer.remoteEditorCount || 0
     buffer.remoteEditorCount = ++remoteEditorCountForBuffer
-    buffer.getPath = () => `${uriPrefix}:${bufferURI}`
+    buffer.getPath = () => `${prefix}:${bufferURI}`
     buffer.save = () => { bufferProxy.requestSave() }
     buffer.isModified = () => false
 

lib/empty-portal-pane-item.js

@@ -0,0 +1,3 @@
+module.exports = function getEditorURI (portalId, editorProxyId) {
+  return 'atom://teletype/portal/' + portalId + '/editor/' + editorProxyId
+}

lib/get-editor-uri.js

@@ -4,7 +4,7 @@ const WINDOWS_PATH_SEP_SEARCH_PATTERN = /\\/g
 const POSIX_PATH_SEP_SEARCH_PATTERN = /\//g
 
 module.exports =
-function normalizeURI (uri, targetPathSeparator = path.sep) {
+function getPathWithNativeSeparators (uri, targetPathSeparator = path.sep) {
   const PATH_SEP_SEARCH_PATTERN = (targetPathSeparator === '/') ? WINDOWS_PATH_SEP_SEARCH_PATTERN : POSIX_PATH_SEP_SEARCH_PATTERN
   return uri.replace(PATH_SEP_SEARCH_PATTERN, targetPathSeparator)
 }

lib/normalize-uri.js renamed to lib/get-path-with-native-separators.js

@@ -2,8 +2,9 @@ const {CompositeDisposable, Emitter, TextEditor, TextBuffer} = require('atom')
 const {Errors, FollowState} = require('@atom/teletype-client')
 const BufferBinding = require('./buffer-binding')
 const EditorBinding = require('./editor-binding')
-const EmptyPortalPaneItem = require('./empty-portal-pane-item')
 const SitePositionsController = require('./site-positions-controller')
+const getPathWithNativeSeparators = require('./get-path-with-native-separators')
+const getEditorURI = require('./get-editor-uri')
 const NOOP = () => {}
 
 module.exports =
@@ -15,14 +16,14 @@ class GuestPortalBinding {
     this.notificationManager = notificationManager
     this.emitDidDispose = didDispose || NOOP
     this.lastActivePaneItem = null
-    this.editorBindingsByEditorProxy = new Map()
-    this.bufferBindingsByBufferProxy = new Map()
+    this.editorBindingsByEditorProxyId = new Map()
+    this.bufferBindingsByBufferProxyId = new Map()
     this.editorProxiesByEditor = new WeakMap()
+    this.editorProxiesMetadataById = new Map()
     this.emitter = new Emitter()
     this.subscriptions = new CompositeDisposable()
     this.lastEditorProxyChangePromise = Promise.resolve()
     this.shouldRelayActiveEditorChanges = true
-    this.lastDestroyedEditor = null
   }
 
   async initialize () {
@@ -32,10 +33,8 @@ class GuestPortalBinding {
 
       this.sitePositionsController = new SitePositionsController({portal: this.portal, workspace: this.workspace})
       this.subscriptions.add(this.workspace.onDidChangeActivePaneItem(this.didChangeActivePaneItem.bind(this)))
-      this.subscriptions.add(this.workspace.onDidDestroyPaneItem(this.didDestroyPaneItem.bind(this)))
 
       await this.portal.setDelegate(this)
-      await this.toggleEmptyPortalPaneItem()
 
       return true
     } catch (error) {
@@ -47,7 +46,6 @@ class GuestPortalBinding {
   dispose () {
     this.subscriptions.dispose()
     this.sitePositionsController.destroy()
-    if (this.emptyPortalItem) this.emptyPortalItem.destroy()
 
     this.emitDidDispose()
   }
@@ -66,28 +64,36 @@ class GuestPortalBinding {
     this.emitter.emit('did-change')
   }
 
-  addEditorProxy (editorProxy) {
-    // TODO Implement in order to allow guests to open any editor that's in the host's workspace
-  }
+  didChangeEditorProxies () {}
 
-  removeEditorProxy (editorProxy) {
-    this.lastEditorProxyChangePromise = this.lastEditorProxyChangePromise.then(async () => {
-      const editorBinding = this.editorBindingsByEditorProxy.get(editorProxy)
-      if (editorBinding) {
-        const isRetracted = this.portal.resolveFollowState() === FollowState.RETRACTED
-        this.shouldRelayActiveEditorChanges = !isRetracted
-        editorBinding.dispose()
-        this.shouldRelayActiveEditorChanges = true
+  getRemoteEditors () {
+    const hostIdentity = this.portal.getSiteIdentity(1)
+    const bufferProxyIds = new Set()
+    const remoteEditors = []
+    const editorProxiesMetadata = this.portal.getEditorProxiesMetadata()
 
-        if (this.editorBindingsByEditorProxy.size === 0) {
-          this.portal.follow(1)
-        }
+    for (let i = 0; i < editorProxiesMetadata.length; i++) {
+      const {id, bufferProxyId, bufferProxyURI} = editorProxiesMetadata[i]
+      if (bufferProxyIds.has(bufferProxyId)) continue
 
-        await this.toggleEmptyPortalPaneItem()
-      }
-    })
+      remoteEditors.push({
+        hostGitHubUsername: hostIdentity.login,
+        uri: getEditorURI(this.portal.id, id),
+        path: getPathWithNativeSeparators(bufferProxyURI)
+      })
+      bufferProxyIds.add(bufferProxyId)
+    }
 
-    return this.lastEditorProxyChangePromise
+    return remoteEditors
+  }
+
+  async getRemoteEditor (editorProxyId) {
+    const editorProxy = await this.portal.findOrFetchEditorProxy(editorProxyId)
+    if (editorProxy) {
+      return this.findOrCreateEditorForEditorProxy(editorProxy)
+    } else {
+      return null
+    }
   }
 
   updateActivePositions (positionsBySiteId) {
@@ -111,12 +117,11 @@ class GuestPortalBinding {
       this.shouldRelayActiveEditorChanges = false
       await this.openPaneItem(editor)
       this.shouldRelayActiveEditorChanges = true
-      await this.toggleEmptyPortalPaneItem()
     } else {
-      this.editorBindingsByEditorProxy.forEach((b) => b.updateTether(followState))
+      this.editorBindingsByEditorProxyId.forEach((b) => b.updateTether(followState))
     }
 
-    const editorBinding = this.editorBindingsByEditorProxy.get(editorProxy)
+    const editorBinding = this.editorBindingsByEditorProxyId.get(editorProxy.id)
     if (editorBinding && position) {
       editorBinding.updateTether(followState, position)
     }
@@ -125,7 +130,7 @@ class GuestPortalBinding {
   // Private
   findOrCreateEditorForEditorProxy (editorProxy) {
     let editor
-    let editorBinding = this.editorBindingsByEditorProxy.get(editorProxy)
+    let editorBinding = this.editorBindingsByEditorProxyId.get(editorProxy.id)
     if (editorBinding) {
       editor = editorBinding.editor
     } else {
@@ -140,12 +145,20 @@ class GuestPortalBinding {
       editorBinding.setEditorProxy(editorProxy)
       editorProxy.setDelegate(editorBinding)
 
-      this.editorBindingsByEditorProxy.set(editorProxy, editorBinding)
+      this.editorBindingsByEditorProxyId.set(editorProxy.id, editorBinding)
       this.editorProxiesByEditor.set(editor, editorProxy)
+
+      const didDestroyEditorSubscription = editor.onDidDestroy(() => editorBinding.dispose())
       editorBinding.onDidDispose(() => {
-        this.lastDestroyedEditor = editor
+        didDestroyEditorSubscription.dispose()
+
+        const isRetracted = this.portal.resolveFollowState() === FollowState.RETRACTED
+        this.shouldRelayActiveEditorChanges = !isRetracted
+        editor.destroy()
+        this.shouldRelayActiveEditorChanges = true
+
         this.editorProxiesByEditor.delete(editor)
-        this.editorBindingsByEditorProxy.delete(editorProxy)
+        this.editorBindingsByEditorProxyId.delete(editorProxy.id)
       })
 
       this.sitePositionsController.addEditorBinding(editorBinding)
@@ -156,34 +169,23 @@ class GuestPortalBinding {
   // Private
   findOrCreateBufferForBufferProxy (bufferProxy) {
     let buffer
-    let bufferBinding = this.bufferBindingsByBufferProxy.get(bufferProxy)
+    let bufferBinding = this.bufferBindingsByBufferProxyId.get(bufferProxy.id)
     if (bufferBinding) {
       buffer = bufferBinding.buffer
     } else {
       buffer = new TextBuffer()
       bufferBinding = new BufferBinding({
         buffer,
         isHost: false,
-        didDispose: () => this.bufferBindingsByBufferProxy.delete(bufferProxy)
+        didDispose: () => this.bufferBindingsByBufferProxyId.delete(bufferProxy.id)
       })
       bufferBinding.setBufferProxy(bufferProxy)
       bufferProxy.setDelegate(bufferBinding)
-      this.bufferBindingsByBufferProxy.set(bufferProxy, bufferBinding)
+      this.bufferBindingsByBufferProxyId.set(bufferProxy.id, bufferBinding)
     }
     return buffer
   }
 
-  // Private
-  async toggleEmptyPortalPaneItem () {
-    const emptyPortalItem = this.getEmptyPortalPaneItem()
-    const pane = this.workspace.paneForItem(emptyPortalItem)
-    if (this.editorBindingsByEditorProxy.size === 0) {
-      if (!pane) await this.openPaneItem(emptyPortalItem)
-    } else {
-      if (pane) emptyPortalItem.destroy()
-    }
-  }
-
   activate () {
     const paneItem = this.lastActivePaneItem
     const pane = this.workspace.paneForItem(paneItem)
@@ -241,48 +243,25 @@ class GuestPortalBinding {
   didChangeActivePaneItem (paneItem) {
     const editorProxy = this.editorProxiesByEditor.get(paneItem)
 
-    if (editorProxy || paneItem === this.getEmptyPortalPaneItem()) {
+    if (editorProxy) {
       this.sitePositionsController.show(paneItem.element)
     } else {
       this.sitePositionsController.hide()
     }
 
-    if (this.shouldRelayActiveEditorChanges && paneItem !== this.getEmptyPortalPaneItem()) {
+    if (this.shouldRelayActiveEditorChanges) {
       this.portal.activateEditorProxy(editorProxy)
     }
   }
 
-  didDestroyPaneItem ({item}) {
-    const emptyPortalItem = this.getEmptyPortalPaneItem()
-    const hasNoPortalPaneItem = this.workspace.getPaneItems().every((item) => (
-      item !== emptyPortalItem && !this.editorProxiesByEditor.has(item)
-    ))
-    const lastDestroyedEditorWasClosedManually = this.lastDestroyedEditor !== item
-    if (hasNoPortalPaneItem && lastDestroyedEditorWasClosedManually) {
-      this.leave()
-    }
-  }
-
   hasPaneItem (paneItem) {
-    return (
-      paneItem === this.getEmptyPortalPaneItem() ||
-      this.editorProxiesByEditor.has(paneItem)
-    )
+    return this.editorProxiesByEditor.has(paneItem)
   }
 
   getActivePaneItem () {
     return this.newActivePaneItem || this.workspace.getActivePaneItem()
   }
 
-  getEmptyPortalPaneItem () {
-    if (this.emptyPortalItem == null) {
-      this.emptyPortalItem = new EmptyPortalPaneItem({
-        hostIdentity: this.portal.getSiteIdentity(1)
-      })
-    }
-    return this.emptyPortalItem
-  }
-
   onDidChange (callback) {
     return this.emitter.on('did-change', callback)
   }

lib/guest-portal-binding.js

@@ -29,8 +29,8 @@ class HostPortalBinding {
 
       this.portal.setDelegate(this)
       this.disposables.add(
-        this.workspace.observeActiveTextEditor(this.didChangeActiveTextEditor.bind(this)),
-        this.workspace.onDidDestroyPaneItem(this.didDestroyPaneItem.bind(this))
+        this.workspace.observeTextEditors(this.didAddTextEditor.bind(this)),
+        this.workspace.observeActiveTextEditor(this.didChangeActiveTextEditor.bind(this))
       )
 
       this.workspace.getElement().classList.add('teletype-Host')
@@ -108,11 +108,8 @@ class HostPortalBinding {
     }
   }
 
-  didDestroyPaneItem ({item}) {
-    const editorBinding = this.editorBindingsByEditor.get(item)
-    if (editorBinding) {
-      this.portal.removeEditorProxy(editorBinding.editorProxy)
-    }
+  didAddTextEditor (editor) {
+    if (!editor.isRemote) this.findOrCreateEditorProxyForEditor(editor)
   }
 
   findOrCreateEditorProxyForEditor (editor) {
@@ -128,7 +125,10 @@ class HostPortalBinding {
 
       this.editorBindingsByEditor.set(editor, editorBinding)
       this.editorBindingsByEditorProxy.set(editorProxy, editorBinding)
+
+      const didDestroyEditorSubscription = editor.onDidDestroy(() => editorProxy.dispose())
       editorBinding.onDidDispose(() => {
+        didDestroyEditorSubscription.dispose()
         this.editorBindingsByEditorProxy.delete(editorProxy)
       })
 

lib/host-portal-binding.js

@@ -0,0 +1,4 @@
+const UUID_REGEXP = /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/
+module.exports = function isUUID (string) {
+  return UUID_REGEXP.test(string)
+}