SOA/RPC>> ipfs-postmsg-proxy>> 返回
项目作者： ipfs-inactive

项目描述 ：
[DEPRECATED] Use ipfs-message-port-server/client instead:
高级语言： JavaScript
项目地址: git://github.com/ipfs-inactive/ipfs-postmsg-proxy.git
创建时间： 2017-12-14T15:39:50Z
项目社区：https://github.com/ipfs-inactive/ipfs-postmsg-proxy
开源协议：MIT License
下载


⚠️ Deprecated ⚠️

This library has been deprecated and replaced with more flexible universal libraries for sharing API instance across message port:

This library will not be maintained.

ipfs-postmsg-proxy

Build Status dependencies Status deprecated

Proxy to an IPFS over window.postMessage

The proxy uses postmsg-rpc under the hood to create an object which looks like an IPFS instance on the web page. This is just an object with “stubs” (functions) that use window.postMessage to communicate with a real IPFS node running in the browser extension. postmsg-rpc allows us to create these stubs and expose methods on the IPFS node without having to deal with the complexities of window.postMessage.

  1. Web page                                               Browser extension
  2. +---------------+-----------------+                    +-------------------+----------------+
  3. |               |                 |                    |                   |                |
  4. |               |                 |                    |                   |                |
  5. |               |                 | window.postMessage |                   |                |
  6. | window.ipfs   +->  call stubs   +--------------------->   exposed api    +->  js-ipfs /   |
  7. |             <-+  (postmsg-rpc) <---------------------+   (postmsg-rpc) <-+    js-ipfs-api |
  8. |               |                 |                    |                   |                |
  9. |               |                 |                    |                   |                |
  10. |               |                 |                    |                   |                |
  11. +-------^-------+-----------------+                    +-------------------+----------------+
  12.         |
  13.         +
  14. interface-ipfs-core

We’re using interface-ipfs-core to test our call stubs which are hooked up to a js-ipfs/js-ipfs-api on the other end. If the tests pass we know that the proxy is doing a good job of passing messages over the boundary.

When messages are passed using window.postMessage the data that is sent is cloned using the structured clone algorithm. It allows more things to be cloned than just JSON types but there are some things that cannot be cloned without some prior serialization to a format that can be cloned by the algorithm. For this reason, on both the web page and browser extension side we sometimes manually perform this serialization on arguments and return types.

In the web page, we serialize arguments we know cannot be handled by the structured clone algorithm before stubs are called and we deserialize them in the browser extension before exposed functions are called.

In the browser extension we serialize return values after exposed functions are called and deserialize them in the web page after stubs are called.

The prepost module provides these utility functions.

Install

  1. npm install ipfs-postmsg-proxy

Usage

In this example, IPFS is running in an iframe.

In iframe window where the js-ipfs node is running, create iframe.js:

  1. const IPFS = require('ipfs')
  2. const { createProxyServer, closeProxyServer } = require('ipfs-postmsg-proxy')
  4. const ipfs = new IPFS()
  6. // Create proxy server that talks to the parent window
  7. const server = createProxyServer(() => ipfs, {
  8.   postMessage: window.parent.postMessage.bind(window.parent)
  9. })
  11. // Later, you might want to close the server:
  12. closeProxyServer(server)

Browserify/Webpack iframe.js to bundle.js.

Create iframe.html:

  1. <!doctype html>
  2. <script src="bundle.js"></script>

In the client window, add the iframe and create a client to talk to it:

  1. const { createProxyClient } = require('ipfs-postmsg-proxy')
  3. const iframe = document.createElement('iframe')
  4. iframe.src = 'iframe.html'
  5. document.body.appendChild(iframe)
  7. // Create proxy client that talks to the iframe
  8. window.ipfs = createProxyClient({
  9.   postMessage: iframe.contentWindow.postMessage.bind(iframe.contentWindow)
  10. })
  12. // You can now interact with IPFS as usual, e.g.
  13. // ipfs.add(new Buffer('HELLO WORLD'), (err, res) => console.log(err, res))

API

createProxyServer(getIpfs, [options])

Create a proxy server to a running IPFS instance.

  • getIpfs - a function that returns the IPFS instance. Note this function will be called every time a function needs to be invoked and so shouldn’t create a new instance each time!
  • options.postMessage - function that posts a message (default window.postMessage)
  • options.targetOrigin - passed to postMessage. See postMessage docs for more info (default '*')
  • options.addListener - function that adds a listener (default window.addEventListener)
  • options.removeListener - function that removes a listener (default window.removeEventListener)
  • options.getMessageData - a function that extracts data from the event object passed to a message event handler (default (e) => e.data)

  • options.pre - an object or a function. If an object, it’s values are functions to call prior to invoking functions on the exposed IPFS node. The pre-functions are passed arguments as they would be passed to the exposed IPFS node and are expected to return an array of possibly altered arguments or a promise that resolves to the arguments array. The keys for this object identify the function name on the IPFS node that this function should be run before. e.g.

    1.   createProxyServer(getIpfs, {
    2.     pre: {
    3.       'files.add' (...args) {
    4.         // Alter the args in some way...
    5.         return args
    6.       }
    7.     }
    8.   })

    If options.pre is a function it should create and return a pre-function (or null) for the passed function name. e.g.

    1.   createProxyServer(getIpfs, {
    2.     pre: (fnName) => (...args) => {
    3.       // Alter the args in some way...
    4.       return args
    5.     }
    6.   })

Returns an IPFS proxy server instance.

closeProxyServer(server)

Close the passed proxy server (removes all listeners for postMessage message events).

  • server - a proxy server created by createProxyServer

Returns a Promise that resolves once the server is fully closed.

createProxyClient([options])

Create a proxy client to the proxy server.

  • options.postMessage - function that posts a message (default window.postMessage)
  • options.targetOrigin - passed to postMessage. See postMessage docs for more info (default '*')
  • options.addListener - function that adds a listener (default window.addEventListener)
  • options.removeListener - function that removes a listener (default window.removeEventListener)
  • options.getMessageData - a function that extracts data from the event object passed to a message event handler (default (e) => e.data)

Returns an IPFS proxy client instance.

Current status

  1. $ npm run test:integration:node:js
  3. .bitswap.stat
  4.   ✓ should get bitswap stats
  5.   ✓ should get bitswap stats (promised)
  6.   ✓ should not get bitswap stats when offline
  8. .bitswap.wantlist
  9.   ✓ should get the wantlist
  10.   ✓ should get the wantlist by peer ID for a diffreent node
  11.   ✓ should not get the wantlist when offline
  13. .block.put
  14.   ✓ should put a buffer, using defaults
  15.   ✓ should put a buffer, using CID
  16.   ✓ should put a buffer, using options
  17.   ✓ should put a Block instance
  18.   ✓ should error with array of blocks
  20. .block.get
  21.   ✓ should get by CID object
  22.   ✓ should get by CID in string
  23.   ✓ should get an empty block
  25. .block.stat
  26.   ✓ should stat by CID
  28. .bootstrap.add
  29.   ✓ should return an error when called with an invalid arg
  30.   ✓ should return a list containing the bootstrap peer when called with a valid arg (ip4)
  31.   ✓ should return a list of bootstrap peers when called with the default option
  33. .bootstrap.list
  34.   ✓ should return a list of peers
  36. .bootstrap.rm
  37.   ✓ should return an error when called with an invalid arg
  38.   ✓ should return an empty list because no peers removed when called without an arg or options
  39.   ✓ should return a list containing the peer removed when called with a valid arg (ip4)
  40.   ✓ should return a list of all peers removed when all option is passed
  42. .config.get
  43.   ✓ should retrieve the whole config
  44.   ✓ should retrieve the whole config (promised)
  45.   ✓ should retrieve a value through a key
  46.   ✓ should retrieve a value through a nested key
  47.   ✓ should fail on non valid key
  48.   ✓ should fail on non existent key
  50. .config.set
  51.   ✓ should set a new key
  52.   ✓ should set a new key (promised)
  53.   ✓ should set an already existing key
  54.   ✓ should set a JSON object
  55.   ✓ should fail on non valid key
  56.   ✓ should fail on non valid value
  58. .config.replace
  59.   ✓ should replace the whole config
  60.   ✓ should replace to empty config
  62. .dag.get
  63.   ✓ should get a dag-pb node
  64.   ✓ should get a dag-cbor node
  65.   ✓ should get a dag-pb node with path
  66.   ✓ should get a dag-pb node local value
  67.   - should get a dag-pb node value one level deep
  68.   - should get a dag-pb node value two levels deep
  69.   ✓ should get a dag-cbor node with path
  70.   ✓ should get a dag-cbor node local value
  71.   - should get dag-cbor node value one level deep
  72.   - should get dag-cbor node value two levels deep
  73.   - should get dag-cbor value via dag-pb node
  74.   ✓ should get dag-pb value via dag-cbor node
  75.   ✓ should get by CID string
  76.   ✓ should get by CID string + path
  78. .dag.put
  79.   ✓ should put dag-pb with default hash func (sha2-256)
  80.   ✓ should put dag-pb with custom hash func (sha3-512)
  81.   ✓ should put dag-cbor with default hash func (sha2-256)
  82.   ✓ should put dag-cbor with custom hash func (sha3-512)
  83.   ✓ should return the cid
  84.   ✓ should not fail when calling put without options
  85.   ✓ should not fail when calling put without options (promised)
  86.   ✓ should set defaults when calling put without options
  87.   ✓ should set defaults when calling put without options (promised)
  88.   ✓ should override hash algoritm default and resolve with it
  89.   - should put by passing the cid instead of format and hashAlg
  91. .dag.tree
  92.   ✓ should get tree with CID
  93.   ✓ should get tree with CID and path
  94.   ✓ should get tree with CID and path as String
  95.   ✓ should get tree with CID recursive (accross different formats)
  96.   ✓ should get tree with CID and path recursive
  98. .dht.get (TODO: DHT is not implemented in js-ipfs yet!)
  99.   - should error when getting a non-existent key from the DHT
  100.   - should get a value after it was put on another node
  102. .dht.put (TODO: DHT is not implemented in js-ipfs yet!)
  103.   - should put a value on the DHT
  105. .dht.findpeer (TODO: DHT is not implemented in js-ipfs yet!)
  106.   - should find other peers
  107.   - should fail to find other peer if peer does not exist
  109. .dht.provide (TODO: DHT is not implemented in js-ipfs yet!)
  110.   - should provide local CID
  111.   - should not provide if block not found locally
  112.   - should allow multiple CIDs to be passed
  113.   - should provide a CIDv1
  114.   - should error on non CID arg
  115.   - should error on array containing non CID arg
  117. .dht.findprovs (TODO: DHT is not implemented in js-ipfs yet!)
  118.   - should provide from one node and find it through another node
  119.   - should take options to override timeout config
  121. .dht.query (TODO: DHT is not implemented in js-ipfs yet!)
  122.   - should return the other node in the query
  124. .files.add
  125.   ✓ should add a Buffer
  126.   ✓ should add a Buffer (promised)
  127.   ✓ should add a BIG Buffer
  128.   ✓ should add a BIG Buffer with progress enabled
  129.   ✓ should add a Buffer as tuple
  130.   ✓ should not be able to add by path
  131.   ✓ should add readable stream
  132.   ✓ should add array of objects with readable stream content
  133.   ✓ should add pull stream
  134.   - should add pull stream (promised) (https://github.com/ipfs/js-ipfs/issues/1574)
  135.   ✓ should add array of objects with pull stream content (promised)
  136.   ✓ should add a nested directory as array of tupples
  137.   ✓ should add a nested directory as array of tupples with progress
  138.   ✓ should fail when passed invalid input
  139.   ✓ should wrap content in a directory
  140.   ✓ should add with only-hash=true (promised)
  142. .files.addReadableStream
  143.   ✓ should add readable stream of valid files and dirs
  145. .files.addPullStream
  146.   ✓ should add pull stream of valid files and dirs
  147.   ✓ should add with object chunks and pull stream content
  149. .files.cat
  150.   ✓ should cat with a base58 string encoded multihash
  151.   ✓ should cat with a base58 string encoded multihash (promised)
  152.   ✓ should cat with a Buffer multihash
  153.   ✓ should cat with a CID object
  154.   ✓ should cat a BIG file
  155.   ✓ should cat with IPFS path
  156.   ✓ should cat with IPFS path, nested value
  157.   ✓ should error on invalid key (promised)
  158.   ✓ should error on unknown path (promised)
  159.   ✓ should error on dir path (promised)
  160.   ✓ should export a chunk of a file
  162. .files.catReadableStream
  163.   ✓ should return a Readable Stream for a CID
  164.   ✓ should export a chunk of a file in a Readable Stream
  166. .files.catPullStream
  167.   ✓ should return a Pull Stream for a CID
  168.   ✓ should export a chunk of a file in a Pull Stream
  170. .files.get
  171.   ✓ should get with a base58 encoded multihash
  172.   ✓ should get with a base58 encoded multihash (promised)
  173.   ✓ should get with a Buffer multihash
  174.   ✓ should get a BIG file
  175.   ✓ should get a directory
  176.   ✓ should get with ipfs path, as object and nested value
  177.   ✓ should get with ipfs path, as array and nested value
  178.   ✓ should error on invalid key
  180. .files.getReadableStream
  181.   ✓ should return a Readable Stream of Readable Streams
  183. .files.getPullStream
  184.   ✓ should return a Pull Stream of Pull Streams
  186. .files.mkdir
  187.   ✓ should make directory on root
  188.   ✓ should make directory and its parents
  189.   ✓ should not make already existent directory
  191. .files.write
  192.   ✓ should not write to non existent file, expect error
  193.   ✓ should write to non existent file with create flag
  194.   ✓ should write to deeply nested non existent file with create and parents flags
  196. .files.cp
  197.   ✓ should copy file, expect error
  198.   ✓ should copy file, expect no error
  199.   ✓ should copy dir, expect error
  200.   ✓ should copy dir, expect no error
  202. .files.mv
  203.   ✓ should not move not found file/dir, expect error
  204.   ✓ should move file, expect no error
  205.   ✓ should move dir, expect no error
  207. .files.rm
  208.   ✓ should not remove not found file/dir, expect error
  209.   ✓ should remove file, expect no error
  210.   ✓ should remove dir, expect no error
  212. .files.stat
  213.   ✓ should not stat not found file/dir, expect error
  214.   - should stat file (https://github.com/ipfs/interface-ipfs-core/pull/365)
  215.   - should stat dir (https://github.com/ipfs/interface-ipfs-core/pull/365)
  216.   - should stat withLocal file
  217.   - should stat withLocal dir
  218.   - should stat outside of mfs (https://github.com/ipfs/interface-ipfs-core/pull/365)
  220. .files.read
  221.   ✓ should not read not found, expect error
  222.   ✓ should read file
  224. .files.readReadableStream
  225.   ✓ should not read not found, expect error
  226.   ✓ should read file
  228. .files.readPullStream
  229.   ✓ should not read not found, expect error
  230.   ✓ should read file
  232. .files.ls
  233.   ✓ should not ls not found file/dir, expect error
  234.   ✓ should ls directory
  235.   ✓ should ls -l directory
  237. .files.flush
  238.   ✓ should not flush not found file/dir, expect error
  239.   ✓ should flush root
  240.   ✓ should flush specific dir
  242. .key.gen
  243.   ✓ should generate a new rsa key
  245. .key.list
  246.   ✓ should list all the keys
  248. .key.rename
  249.   ✓ should rename a key
  251. .key.rm
  252.   ✓ should rm a key
  254. .key.export
  255.   ✓ should export "self" key
  257. .key.import
  258.   ✓ should import an exported key
  260. .ls
  261.   ✓ should ls with a base58 encoded CID
  262.   ✓ should correctly handle a non existing hash
  263.   ✓ should correctly handle a non exiting path
  265. .lsReadableStream
  266.   ✓ should readable stream ls with a base58 encoded CID
  268. .lsPullStream
  269.   ✓ should pull stream ls with a base58 encoded CID
  271. .id
  272.   ✓ should get the node ID
  273.   ✓ should get the node ID (promised)
  275. .version
  276.   ✓ should get the node version
  277.   ✓ should get the node version (promised)
  279. .dns
  280.   ✓ should resolve a DNS link
  282. .stop
  283.   ✓ should stop the node
  285. .resolve
  286.   ✓ should resolve an IPFS hash
  287.   ✓ should resolve an IPFS path link
  288.   ✓ should not resolve an IPFS path non-link
  289.   - should resolve an IPNS DNS link (TODO IPNS not implemented yet)
  290.   - should resolve IPNS link recursively (TODO IPNS not implemented yet)
  292. .name.publish
  293.   ✓ should publish an IPNS record with the default params
  294.   ✓ should publish correctly when the file was not added but resolve is disabled
  295.   ✓ should publish with a key received as param, instead of using the key of the node
  297. .name.resolve
  298.   ✓ should resolve a record with the default params after a publish
  299.   ✓ should not get the entry if its validity time expired
  300.   ✓ should recursively resolve to an IPFS hash
  302. .object.new
  303.   ✓ should create a new object with no template
  304.   ✓ should create a new object with no template (promised)
  305.   ✓ should create a new object with unixfs-dir template
  307. .object.put
  308.   ✓ should put an object
  309.   ✓ should put an object (promised)
  310.   ✓ should put a JSON encoded Buffer
  311.   ✓ should put a Protobuf encoded Buffer
  312.   ✓ should put a Buffer as data
  313.   ✓ should put a Protobuf DAGNode
  314.   ✓ should fail if a string is passed
  315.   ✓ should put a Protobuf DAGNode with a link
  317. .object.get
  318.   ✓ should get object by multihash
  319.   ✓ should get object by multihash (promised)
  320.   ✓ should get object by multihash string
  321.   ✓ should get object by multihash string (promised)
  322.   ✓ should get object with links by multihash string
  323.   ✓ should get object by base58 encoded multihash
  324.   ✓ should get object by base58 encoded multihash string
  325.   ✓ supplies unadulterated data
  327. .object.data
  328.   ✓ should get data by multihash
  329.   ✓ should get data by multihash (promised)
  330.   ✓ should get data by base58 encoded multihash
  331.   ✓ should get data by base58 encoded multihash string
  333. .object.links
  334.   ✓ should get empty links by multihash
  335.   ✓ should get empty links by multihash (promised)
  336.   ✓ should get links by multihash
  337.   ✓ should get links by base58 encoded multihash
  338.   ✓ should get links by base58 encoded multihash string
  340. .object.stat
  341.   ✓ should get stats by multihash
  342.   ✓ should get stats for object by multihash (promised)
  343.   ✓ should get stats for object with links by multihash
  344.   ✓ should get stats by base58 encoded multihash
  345.   ✓ should get stats by base58 encoded multihash string
  347. .object.patch.addLink
  348.   ✓ should add a link to an existing node
  349.   ✓ should add a link to an existing node (promised)
  351. .object.patch.rmLink
  352.   ✓ should remove a link from an existing node
  353.   ✓ should remove a link from an existing node (promised)
  355. .object.patch.appendData
  356.   ✓ should append data to an existing node
  357.   ✓ should append data to an existing node (promised)
  359. .object.patch.setData
  360.   ✓ should set data for an existing node
  361.   ✓ should set data for an existing node (promised)
  363. .pin.ls
  364.   ✓ should list recursive pins
  365.   ✓ should list indirect pins
  366.   ✓ should list pins
  367.   ✓ should list pins (promised)
  368.   ✓ should list direct pins
  369.   ✓ should list pins for a specific hash
  370.   ✓ should list pins for a specific hash (promised)
  372. .pin.rm
  373.   ✓ should remove a recursive pin
  374.   ✓ should remove a direct pin (promised)
  376. .pin.add
  377.   ✓ should add a pin
  378.   ✓ should add a pin (promised)
  380. .ping
  381.   ✓ should send the specified number of packets
  382.   - should fail when pinging an unknown peer (Timing out)
  383.   ✓ should fail when pinging an invalid peer
  385. .pingPullStream
  386.   ✓ should send the specified number of packets over pull stream
  387.   - should fail when pinging an unknown peer over pull stream (Timing out)
  388.   ✓ should fail when pinging an invalid peer over pull stream
  390. .pingReadableStream
  391.   ✓ should send the specified number of packets over readable stream
  392.   - should fail when pinging an unknown peer over readable stream (Timing out)
  393.   ✓ should fail when pinging an invalid peer over readable stream
  395. .pubsub.publish
  396.   ✓ should error on string messags
  397.   ✓ should publish message from buffer
  398.   ✓ should publish 10 times within time limit
  400. .pubsub.subscribe
  401.   single node
  402.     ✓ should subscribe to one topic
  403.     ✓ should subscribe to one topic (promised)
  404.     ✓ should subscribe to one topic with options
  405.     ✓ should subscribe to one topic with options (promised)
  406.     ✓ should subscribe to topic multiple times with different handlers
  407.     ✓ should allow discover option to be passed
  408.   multiple connected nodes
  409.     ✓ should receive messages from a different node
  410.     ✓ should round trip a non-utf8 binary buffer
  411.     ✓ should receive multiple messages
  412. Send/Receive 100 messages took: 86 ms, 1162 ops / s
  413.     ✓ send/receive 100 messages
  415. .pubsub.unsubscribe
  416.   ✓ should subscribe and unsubscribe 10 times
  418. .pubsub.peers
  419.   ✓ should not error when not subscribed to a topic
  420.   ✓ should not return extra peers
  421.   ✓ should return peers for a topic - one peer
  422.   ✓ should return peers for a topic - multiple peers
  424. .pubsub.ls
  425.   ✓ should return an empty list when no topics are subscribed
  426.   ✓ should return a list with 1 subscribed topic
  427.   ✓ should return a list with 3 subscribed topics
  429. .repo.version
  430.   ✓ should get the repo version
  431.   ✓ should get the repo version (promised)
  433. .repo.stat
  434.   ✓ should get repo stats
  435.   ✓ should get repo stats (promised)
  437. .repo.gc (TODO: repo.gc is not implemented in js-ipfs yet!)
  438.   - should run garbage collection
  439.   - should run garbage collection (promised)
  441. .stats.bitswap
  442.   ✓ should get bitswap stats
  443.   ✓ should get bitswap stats (promised)
  445. .stats.bw
  446.   ✓ should get bandwidth stats
  447.   ✓ should get bandwidth stats (promised)
  449. .stats.bwPullStream
  450.   ✓ should get bandwidth stats over pull stream
  452. .stats.bwReadableStream
  453.   ✓ should get bandwidth stats over readable stream
  455. .stats.repo
  456.   ✓ should get repo stats
  457.   ✓ should get repo stats (promised)
  459. .swarm.connect
  460.   ✓ should connect to a peer
  461.   ✓ should connect to a peer (promised)
  463. .swarm.peers
  464.   ✓ should list peers this node is connected to
  465.   ✓ should list peers this node is connected to (promised)
  466.   ✓ should list peers this node is connected to with verbose option
  467.   ✓ should list peers only once
  468.   ✓ should list peers only once even if they have multiple addresses
  470. .swarm.addrs
  471.   - should get a list of node addresses (Returning empty array)
  472.   - should get a list of node addresses (promised) (Returning empty array)
  474. .swarm.localAddrs
  475.   ✓ should list local addresses the node is listening on
  476.   ✓ should list local addresses the node is listening on (promised)
  478. .swarm.disconnect
  479.   ✓ should disconnect from a peer
  480.   ✓ should disconnect from a peer (promised)
  482. .types (FIXME: currently failing)
  483.   - should have a types object with the required values
  485. .util (FIXME: currently failing)
  486.   - should have a util object with the required values
  489. 261 passing (2m)
  490. 37 pending

Caveats

Progress option

The progress option for files.add currently tracks progress of data streamed to the IPFS node.

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Protocol Labs