feat: expose peer discovery to plugins (#1808)

__tests__/unit/services/plugin-manager/sandbox/peer-all-sandbox.spec.js

@@ -0,0 +1,35 @@
+import { create as createPeerAllSandbox } from '@/services/plugin-manager/sandbox/peer-all-sandbox'
+
+class PeerDiscoveryStub {
+  withLatency () {
+    return this
+  }
+
+  sortBy () {
+    return this
+  }
+}
+
+const mockDispatch = jest.fn(() => new PeerDiscoveryStub())
+
+let walletApi
+let app
+let peerAllSandbox
+
+describe('Peer All Sandbox', () => {
+  beforeEach(() => {
+    walletApi = {}
+    app = {
+      $store: {
+        dispatch: mockDispatch
+      }
+    }
+    peerAllSandbox = createPeerAllSandbox(walletApi, app)
+    peerAllSandbox()
+  })
+
+  it('should expose functions', () => {
+    expect(mockDispatch).toHaveBeenCalled()
+    expect(walletApi.peers.all).toBeTruthy()
+  })
+})

src/renderer/i18n/locales/en-US.js

@@ -556,6 +556,7 @@ export default {
       HTTP: 'Allows performing external web requests',
       MENU_ITEMS: 'Allows adding custom menu items to the Desktop Wallet sidebar',
       MESSAGING: 'Allows WebFrames access to a one-way messaging system',
+      PEER_ALL: 'Allows access to the peer discovery',
       PEER_CURRENT: 'Allows access to the currently connected peer',
       PUBLIC: 'Allows navigation to wallet routes and provides access to the Font Awesome icon set',
       PROFILE_ALL: 'Allows access to all available profiles',

src/renderer/services/plugin-manager/plugin-permission.js

@@ -17,6 +17,7 @@ export const EVENTS = new Permission({ name: 'EVENTS' })
 export const HTTP = new Permission({ name: 'HTTP' })
 export const MENU_ITEMS = new Permission({ name: 'MENU_ITEMS' })
 export const MESSAGING = new Permission({ name: 'MESSAGING' })
+export const PEER_ALL = new Permission({ name: 'PEER_ALL' })
 export const PEER_CURRENT = new Permission({ name: 'PEER_CURRENT' })
 export const PROFILE_ALL = new Permission({ name: 'PROFILE_ALL' })
 export const PROFILE_CURRENT = new Permission({ name: 'PROFILE_CURRENT' })

src/renderer/services/plugin-manager/plugin-sandbox.js

@@ -10,6 +10,7 @@ import {
   TIMERS,
   PROFILE_ALL,
   PROFILE_CURRENT,
+  PEER_ALL,
   PEER_CURRENT,
   STORAGE,
   AUDIO,
@@ -26,6 +27,7 @@ import * as RouteSandbox from './sandbox/route-sandbox'
 import * as TimersSandbox from './sandbox/timers-sandbox'
 import * as ProfileAllSandbox from './sandbox/profile-all-sandbox'
 import * as ProfileCurrentSandbox from './sandbox/profile-current-sandbox'
+import * as PeerAllSandbox from './sandbox/peer-all-sandbox'
 import * as PeerCurrentSandbox from './sandbox/peer-current-sandbox'
 import * as StorageSandbox from './sandbox/storage-sandbox'
 import * as AudioSandbox from './sandbox/audio-sandbox'
@@ -124,6 +126,7 @@ export class PluginSandbox {
       [EVENTS.name]: EventsSandbox.create(this.walletApi, this.app),
       [HTTP.name]: HttpSandbox.create(this.walletApi, this.plugin),
       [MESSAGING.name]: MessagingSandbox.create(this.walletApi, this.app),
+      [PEER_ALL.name]: PeerAllSandbox.create(this.walletApi, this.app),
       [PEER_CURRENT.name]: PeerCurrentSandbox.create(this.walletApi, this.app),
       [PROFILE_ALL.name]: ProfileAllSandbox.create(this.walletApi, this.app),
       [PROFILE_CURRENT.name]: ProfileCurrentSandbox.create(this.walletApi, this.app),

src/renderer/services/plugin-manager/sandbox/peer-all-sandbox.js

@@ -0,0 +1,13 @@
+export function create (walletApi, app) {
+  return async () => {
+    if (!walletApi.peers) {
+      walletApi.peers = {}
+    }
+
+    const peerDiscovery = (await app.$store.dispatch('peer/getPeerDiscovery'))
+      .withLatency(300)
+      .sortBy('latency')
+
+    walletApi.peers.all = peerDiscovery
+  }
+}

src/renderer/services/plugin-manager/sandbox/peer-current-sandbox.js

@@ -1,6 +1,12 @@
 export function create (walletApi, app) {
   return () => {
+    if (!walletApi.peers) {
+      walletApi.peers = {}
+    }
+
     walletApi.peers = {
+      ...walletApi.peers,
+
       current: {
         get: async (url, options = {}) => {
           options.timeout || (options.timeout = 3000)