vardius / peer-cdn

Lightweight library providing peer to peer CDN functionality

peer-cdn

Lightweight library providing peer to peer CDN functionality

📖 ABOUT

Contributors:

• Rafał Lorenz

Want to contribute ? Feel free to send pull requests!

Have problems, bugs, feature ideas? We are using the github issue tracker to manage them.

📚 Documentation

For documentation (including examples), visit rafallorenz.com/peer-cdn

🚏 HOW TO USE

Installation

$ npm install peer-cdn

Basic example

main.js

"use strict";

import { PeerPlugin } from "peer-cdn";

if ("serviceWorker" in navigator) {
  // since sw does not support WebRTC yet
  // this is workaround to use it
  // we use PeerPlugin on client side
  const peerPlugin = new PeerPlugin({
    cacheName: CachePlugin.peerFetch + 1,
    timeoutAfter: 3000,
    servers: {
      iceServers: [
        {
          url: "stun:74.125.142.127:19302",
        },
      ],
    },
    constraints: {
      ordered: true,
    },
  });

  // Set up a listener for messages posted from the service worker.
  // The service worker is set to post a message to specific client only
  // so you should see this message event fire once.
  // You can force it to fire again by visiting this page in an Incognito window.
  navigator.serviceWorker.addEventListener("message", function (event) {
    const request = new Request(event.data.url);
    // mock sw event wrapping request with object
    const middleware = peerPlugin.getMiddleware({ request });

    // run get method of a created middleware
    middleware
      .get()
      .then(function (response) {
        // return response to a service worker
        event.ports[0].postMessage(response);
      })
      .catch(function (error) {
        // return response to a service worker
        event.ports[0].postMessage(null);
      });
  });

  navigator.serviceWorker
    .register("sw.js")
    .then(function (registration) {
      // Registration was successful
      console.log(
        "ServiceWorker registration successful with scope: ",
        registration.scope
      );
    })
    .catch(function (error) {
      console.error("Service Worker Error", error);
    });
}

sw.js

// import peer-cdn into service worker
self.importScripts("https://github.com/vardius/peer-cdn/blob/v1.0.5-beta/dist/index.js");

const { CachePlugin, DelegatePlugin, NetworkPlugin, strategies: { ordered }} = PeerCDN;

const cachePlugin = new CachePlugin({ version: 1 });
// since sw does not support WebRTC yet we use PeerPlugin on client side 
// and we delegate request to it with DelegatePlugin
const delegatePlugin = new DelegatePlugin({ timeoutAfter: 5000 });
const networkPlugin = new NetworkPlugin();

const cdn = new PeerCDN();

cdn.GET("/css/main.css", ordered,
    cachePlugin.getMiddleware,
    delegatePlugin.getMiddleware,
    networkPlugin.getMiddleware
);

// We need to register service worker events
// cdn.register() will add listeners for install, activate and fetch
// gaining required control
cdn.register();

📜 License

This package is released under the MIT license. See the complete license in the package

peer-cdn's Issues

Implement signaling server

Implement signaling server

• peers matching
• chunk data

Add router

Refactor PeerCDN API

Refactor API

• allow to register custom middlewares
• manage middlewares for each event
• manage event handlers for each event

1.0.0-beta

release beta after milestone steps are done
For more info chcek milestone decs

todo

• allow to provide custom cache names
• fix message channel closure
• create better socket server with ability to extend
• update docs and readme

Compatible with multiple service workers

Do you want to request a feature or report a bug?
feature

What is the current behavior?
cannot used when there is another service worker

What is the expected behavior?
when there is another service worker. this one can add before it

Handle range requests

http://httpwg.org/specs/rfc7233.html#combining.byte.ranges

Implement peer middleware

Implement peer middleware

• call signaling server for peers
• download response from chunks
• seed chunks

Write documentation

Service worker - webrtc support

Following this issue
proposal
other

wordpress Plugin for easy Integration is neededp

Peercdn Wordpres Plugin is needed to trigger more interests.

Thanks and

Best regards

Add tests

Implement tests

Need more tests

client.postMessage browser support

according to the client.postMessage() documentation and presented example,
given solution should work, however client never gets worker message on:

• Google Chrome Version 64.0.3282.167 (Official Build) (64-bit),
  works on:
• Mozilla Firefox Quantum 58.0.2 (64-bit)

Create example