Decouple HTTP Servers from cli/commands/daemon #1950

lidel · 2019-03-19T23:33:24Z

Part of an effort to run embedded js-ipfs in Brave 🦁 ipfs/ipfs-companion#664, part of #1820 too

Summary

This PR decouples HTTP servers from code jsipfs daemon.
Apart from cleanup, we need this to enable HTTP server in browser context with chrome.sockets.

There are no functional changes. I just moved non-HTTP code to src/cli/standalone-daemon.js

Background

In the past API was exposed via HTTP Server only when jsipfs daemon was run from the commandline, so src/http/index.js was also responsible for orchestration that is not related to HTTP itself. The coupling was quite bad: HttpApi basically decided on libp2p configuration: it enabled WebRTC if available, TCP transport, MulticastDNS etc.

Changes

This refactor moves code that is not related to HTTP Servers into standalone-daemon.js, which is easier to reason about, and unlocks use of HttpApi in contexts other than CLI jsipfs daemon, such as Firefox with libdweb or Chromium-based web browser with chrome.sockets APIs

With this PR, HttpApi is not only decoupled from Standalone Daemon, but can also be manually started/stopped in browser context.

I believe only ipfs-companion will be using this for now, but it is a fairly generic code.
Someone else should be able to use this in Chrome App environment:

Start

const Ipfs = require('ipfs')
const HttpApi = require('ipfs/src/http')

let node = new Ipfs(ipfsOpts)
let nodeHttpApi

node.on('start', async () => {
  // HttpApi is off in browser context and needs to be started separately
  const httpServers = new HttpApi(node, ipfsOpts)
  nodeHttpApi = await httpServers.start()
})

Stop

if (nodeHttpApi) {
  await nodeHttpApi.stop()
  nodeHttpApi = null
}
if (node) {
  await node.stop()
  node = null
}

Checklist

do the thing ;-)
fix printing of API and Gateway port in browser console
ensure issue with returning payload in browser context is not due to js-ipfs
- DONE: does not block this PR (it was due to Node-specific check in Hapi, will be addressed upstream)

Refs.
ipfs/ipfs-companion#664, #1855, #1820

In the past API was exposed via HTTP Server only when jsipfs daemon was run from the commandline, so src/http/index.js was also responsible for orchestration that is not related to HTTP itself. This refactor moves code that is not related to HTTP Servers into standalone-daemon.js, which is easier to reason about, and unlocks use of HttpApi in contexts other than commandline jsipfs daemon, such as Firefox with libdweb or Chromium-based web browser with chrome.sockets APIs. Refs. ipfs/ipfs-companion#664 License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

This changes behavior in web browser. Instead of printing to console.log, it uses proper debug-based logger. Old behavior in terminal (when run via `jsipfs daemon`) does not change. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel · 2019-04-11T13:31:40Z

Ok, should be ready, let's review it.

This replaces durect use of HttpApi with StandaloneDaemon, restoring all existing tests to operational state. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

src/http/index.js

src/cli/commands/daemon.js

alanshaw · 2019-04-12T08:09:46Z

src/cli/standalone-daemon.js

+        reject(err)
+      })
+      ipfs.once('start', resolve)
+    })


Argh, any chance you can help @pkafei writing a test for #1878 so we don't need to do this?

(completely optional and I won't block merging this!)

Can we pair program and work on the test together?

@alanshaw I'd prefer to merge this PR as-is and improve it later.

@pkafei Sure! I am booked today, but feel free to grab time slot next week: https://calendly.com/pl-lidel/ :)

alanshaw · 2019-04-12T10:20:53Z

src/cli/daemon.js

+    })
+    this._httpApi._apiServers.forEach(apiServer => {
+      ipfs._print('Web UI available at %s', toUri(apiServer.info.ma) + '/webui')
+    })


I meant move to src/cli/commands/daemon.js - where the rest of the logging already is.

Ack, done in 1e82102

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

alanshaw · 2019-04-12T10:34:30Z

src/cli/commands/daemon.js

+        })
+        daemon._httpApi._apiServers.forEach(apiServer => {
+          print(`Web UI available at ${toUri(apiServer.info.ma)}/webui`)
+        })


This applies cherry-picked patches from: ipfs/js-ipfs#1989 ipfs/js-ipfs#1950 and solves stream issues on page refresh. Content-type sniffing is now done over a meaningful amount of bytes instead of arbitrary number.

alanshaw · 2019-04-12T13:32:24Z

Thanks @lidel ❤️

lidel requested review from alanshaw and hugomrdias March 19, 2019 23:33

ghost assigned lidel Mar 19, 2019

ghost added the status/in-progress In progress label Mar 19, 2019

lidel mentioned this pull request Mar 19, 2019

Support chrome.sockets.* APIs ipfs/ipfs-companion#664

Closed

4 tasks

lidel changed the title ~~[WIP] Refactor: decouple HTTP Server from cli/commands/daemon~~ Decouple HTTP Servers from cli/commands/daemon Apr 11, 2019

lidel marked this pull request as ready for review April 11, 2019 13:19

lidel added 2 commits April 11, 2019 15:23

lidel force-pushed the feat/http-gateway-without-cli branch from 29a91ce to 0b9076d Compare April 11, 2019 13:23

hugomrdias approved these changes Apr 11, 2019

View reviewed changes

test: use StandaloneDaemon in test/http-api,gateway

7c32da8

This replaces durect use of HttpApi with StandaloneDaemon, restoring all existing tests to operational state. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel force-pushed the feat/http-gateway-without-cli branch from e326540 to 7c32da8 Compare April 11, 2019 19:01

alanshaw suggested changes Apr 12, 2019

View reviewed changes

refactor: rename StandaloneDaemon to Daemon

1e82102

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel force-pushed the feat/http-gateway-without-cli branch from a2a307d to 1e82102 Compare April 12, 2019 10:32

alanshaw approved these changes Apr 12, 2019

View reviewed changes

alanshaw merged commit 5f62e99 into ipfs:master Apr 12, 2019

ghost removed the status/in-progress In progress label Apr 12, 2019

lidel deleted the feat/http-gateway-without-cli branch April 12, 2019 12:03

This was referenced Apr 16, 2019

Feature-detection of chrome.sockets ipfs/ipfs-companion#711

Merged

Embedded JS-IPFS in Brave (experiment) ipfs/ipfs-companion#716

Closed

rtpro mentioned this pull request May 14, 2022

[Snyk] Security upgrade ipfs from 0.25.4 to 0.35.0 rtpro/js-ipfs#55

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Decouple HTTP Servers from cli/commands/daemon #1950

Decouple HTTP Servers from cli/commands/daemon #1950

lidel commented Mar 19, 2019 •

edited

Loading

lidel commented Apr 11, 2019

alanshaw Apr 12, 2019

pkafei Apr 12, 2019

lidel Apr 12, 2019

alanshaw Apr 12, 2019

lidel Apr 12, 2019

alanshaw Apr 12, 2019

alanshaw commented Apr 12, 2019

Decouple HTTP Servers from cli/commands/daemon #1950

Decouple HTTP Servers from cli/commands/daemon #1950

Conversation

lidel commented Mar 19, 2019 • edited Loading

Summary

Background

Changes

Start

Stop

Checklist

lidel commented Apr 11, 2019

alanshaw Apr 12, 2019

Choose a reason for hiding this comment

pkafei Apr 12, 2019

Choose a reason for hiding this comment

lidel Apr 12, 2019

Choose a reason for hiding this comment

alanshaw Apr 12, 2019

Choose a reason for hiding this comment

lidel Apr 12, 2019

Choose a reason for hiding this comment

alanshaw Apr 12, 2019

Choose a reason for hiding this comment

alanshaw commented Apr 12, 2019

lidel commented Mar 19, 2019 •

edited

Loading