-
Notifications
You must be signed in to change notification settings - Fork 325
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #711 from ipfs-shipyard/feat/brave-build-with-chro…
…me-sockets This PR adds runtime dectection of `chrome.sockets` APIs and a build target for testing it with Brave Nightly: `yarn dev-build bundle:brave` External node type remains the default, but Brave users can opt-in to "Embedded + chrome.sockets" node type on the Preferences screen, which will enable Embedded HTTP Gateway. Cherry-picked js-ipfs improvements: - streaming compressed payload - Content-type sniffing is now done over a meaningful amount of bytes instead of arbitrary number. - decoupling HTTP Servers from cli/commands/daemon Other - Brave users will see a new node type: `embedded:chromesockets` - cleanup boot on clean install - new runtime-checks: `isBrave`, `hasChromeSocketsForTcp` - peer discovery over a ws-star to improve things until we have TCP transport, MulticastDNS and DHT
- Loading branch information
Showing
32 changed files
with
1,304 additions
and
712 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAshQhe/y/j0adZqOFes0nqgRgjDNx4eX6oNrESKeKbpUjH9eSN+lCYqBM3PT+BhPxo+sj/aVgCYsddiIbO43Bq/LsQLBFd+kD1I4qZSN4pJAX9AdsbMmXR9XV0W/O9zlyqkXAfxV13Hwmy+e6IH3p59ytQbpcuLnyipspQ4VXZprLkiWdvPMdifT9wgf5gmD30S1n7uaNrKCu8yZk/Lz5Z+KjoxRdk7X7FJYW+hoUGKb6Ld3Q99iLeKPIvcTjK6/xNHXTbaZfRYbfI8i/mSaxetGxSo7/XkMB8VvAiUkZ4gVSp786oMciQVwK2UyVFXw9pJhGD+O4ozcNk0PSq8aE7QIDAQAB" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| 'use strict' | ||
| /* eslint-env browser, webextensions */ | ||
| const browser = require('webextension-polyfill') | ||
| const debug = require('debug') | ||
|
|
||
| // Polyfills required by embedded HTTP server | ||
| const uptimeStart = Date.now() | ||
| process.uptime = () => Math.floor((Date.now() - uptimeStart) / 1000) | ||
| process.hrtime = require('browser-process-hrtime') | ||
|
|
||
| const mergeOptions = require('merge-options') | ||
| const Ipfs = require('ipfs') | ||
| const HttpApi = require('ipfs/src/http') | ||
| const multiaddr = require('multiaddr') | ||
| const maToUri = require('multiaddr-to-uri') | ||
|
|
||
| const { optionDefaults } = require('../options') | ||
|
|
||
| // js-ipfs with embedded hapi HTTP server | ||
| let node = null | ||
| let nodeHttpApi = null | ||
|
|
||
| // additional servers for smoke-tests | ||
| // let httpServer = null | ||
| // let hapiServer = null | ||
|
|
||
| const log = debug('ipfs-companion:client:embedded') | ||
| log.error = debug('ipfs-companion:client:embedded:error') | ||
|
|
||
| exports.init = function init (opts) { | ||
| /* | ||
| // TEST RAW require('http') SERVER | ||
| if (!httpServer) { | ||
| httpServer = startRawHttpServer(9091) | ||
| } | ||
| // TEST require('hapi') HTTP SERVER (same as in js-ipfs) | ||
| if (!hapiServer) { | ||
| hapiServer = startRawHapiServer(9092) | ||
| } | ||
| */ | ||
| log('init embedded:chromesockets') | ||
|
|
||
| const defaultOpts = JSON.parse(optionDefaults.ipfsNodeConfig) | ||
|
|
||
| defaultOpts.libp2p = { | ||
| config: { | ||
| dht: { | ||
| // TODO: check if below is needed after js-ipfs is released with DHT disabled | ||
| enabled: false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const userOpts = JSON.parse(opts.ipfsNodeConfig) | ||
| const ipfsOpts = mergeOptions.call({ concatArrays: true }, defaultOpts, userOpts, { start: false }) | ||
| log('creating js-ipfs with opts: ', ipfsOpts) | ||
| node = new Ipfs(ipfsOpts) | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| node.once('error', (error) => { | ||
| log.error('something went terribly wrong during startup of js-ipfs!', error) | ||
| reject(error) | ||
| }) | ||
| node.once('ready', async () => { | ||
| node.once('start', async () => { | ||
| // HttpApi is off in browser context and needs to be started separately | ||
| try { | ||
| const httpServers = new HttpApi(node, ipfsOpts) | ||
| nodeHttpApi = await httpServers.start() | ||
| await updateConfigWithHttpEndpoints(node, opts) | ||
| resolve(node) | ||
| } catch (err) { | ||
| reject(err) | ||
| } | ||
| }) | ||
| try { | ||
| node.on('error', error => { | ||
| log.error('something went terribly wrong in embedded js-ipfs!', error) | ||
| }) | ||
| await node.start() | ||
| } catch (err) { | ||
| reject(err) | ||
| } | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| const multiaddr2httpUrl = (ma) => maToUri(ma.includes('/http') ? ma : multiaddr(ma).encapsulate('/http')) | ||
|
|
||
| // Update internal configuration to HTTP Endpoints from js-ipfs instance | ||
| async function updateConfigWithHttpEndpoints (ipfs, opts) { | ||
| const localConfig = await browser.storage.local.get('ipfsNodeConfig') | ||
| if (localConfig && localConfig.ipfsNodeConfig) { | ||
| const gwMa = await ipfs.config.get('Addresses.Gateway') | ||
| const apiMa = await ipfs.config.get('Addresses.API') | ||
| const httpGateway = multiaddr2httpUrl(gwMa) | ||
| const httpApi = multiaddr2httpUrl(apiMa) | ||
| log(`updating extension configuration to Gateway=${httpGateway} and API=${httpApi}`) | ||
| // update ports in JSON configuration for embedded js-ipfs | ||
| const ipfsNodeConfig = JSON.parse(localConfig.ipfsNodeConfig) | ||
| ipfsNodeConfig.config.Addresses.Gateway = gwMa | ||
| ipfsNodeConfig.config.Addresses.API = apiMa | ||
| const configChanges = { | ||
| customGatewayUrl: httpGateway, | ||
| ipfsApiUrl: httpApi, | ||
| ipfsNodeConfig: JSON.stringify(ipfsNodeConfig, null, 2) | ||
| } | ||
| // update current runtime config (in place, effective without restart) | ||
| Object.assign(opts, configChanges) | ||
| // update user config in storage (effective on next run) | ||
| await browser.storage.local.set(configChanges) | ||
| } | ||
| } | ||
|
|
||
| exports.destroy = async function () { | ||
| log('destroy: embedded:chromesockets') | ||
|
|
||
| /* | ||
| if (httpServer) { | ||
| httpServer.close() | ||
| httpServer = null | ||
| } | ||
| if (hapiServer) { | ||
| try { | ||
| await hapiServer.stop({ timeout: 1000 }) | ||
| } catch (err) { | ||
| if (err) { | ||
| console.error(`[ipfs-companion] failed to stop hapi`, err) | ||
| } else { | ||
| console.log('[ipfs-companion] hapi server stopped') | ||
| } | ||
| } | ||
| hapiServer = null | ||
| } | ||
| */ | ||
|
|
||
| if (nodeHttpApi) { | ||
| try { | ||
| await nodeHttpApi.stop() | ||
| } catch (err) { | ||
| log.error('failed to stop HttpApi', err) | ||
| } | ||
| nodeHttpApi = null | ||
| } | ||
| if (node) { | ||
| await node.stop() | ||
| node = null | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| // Quick smoke-test to confirm require('http') works for MVP | ||
| function startRawHttpServer (port) { | ||
| const http = require('http') // courtesy of chrome-net | ||
| const httpServer = http.createServer(function (req, res) { | ||
| res.writeHead(200, { 'Content-Type': 'text/plain' }) | ||
| res.end('Hello from ipfs-companion exposing HTTP via chrome.sockets in Brave :-)\n') | ||
| }) | ||
| httpServer.listen(port, '127.0.0.1') | ||
| console.log(`[ipfs-companion] require('http') HTTP server on http://127.0.0.1:${port}`) | ||
| return httpServer | ||
| } | ||
| function startRawHapiServer (port) { | ||
| let options = { | ||
| host: '127.0.0.1', | ||
| port, | ||
| debug: { | ||
| log: ['*'], | ||
| request: ['*'] | ||
| } | ||
| } | ||
| const initHapi = async () => { | ||
| // hapi v18 (js-ipfs >=v0.35.0-pre.0) | ||
| const Hapi = require('hapi') // courtesy of js-ipfs | ||
| const hapiServer = new Hapi.Server(options) | ||
| await hapiServer.route({ | ||
| method: 'GET', | ||
| path: '/', | ||
| handler: (request, h) => { | ||
| console.log('[ipfs-companion] hapiServer processing request', request) | ||
| return 'Hello from ipfs-companion+Hapi.js exposing HTTP via chrome.sockets in Brave :-)' | ||
| } | ||
| }) | ||
| await hapiServer.start() | ||
| console.log(`[ipfs-companion] require('hapi') HTTP server running at: ${hapiServer.info.uri}`) | ||
| } | ||
| initHapi() | ||
| return hapiServer | ||
| } | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.