@yz-social/webrtc 0.0.5 → 0.1.0

package/lib/peerevents.js

@@ -1,56 +0,0 @@
-import { WebRTCUtilities } from './utilities.js';
-
-// Extendible methods for events on the RTCPeerConnection.
-export class WebRTCPeerEvents extends WebRTCUtilities {
-  resetPeer() {
-    const peer = super.resetPeer();
-
-    peer.onnegotiationneeded = event => this.negotiationneeded(event);
-    peer.onicecandidate = event => this.onLocalIceCandidate(event);
-    // I don't think anyone actually signals this. Instead, they reject from addIceCandidate, which we handle the same.
-    peer.onicecandidateerror = error => this.icecandidateError(error);
-    // I think this is redundant because no implementation fires this event any significant time ahead of emitting icecandidate with an empty event.candidate.
-    peer.onicegatheringstatechange = event => (peer.iceGatheringState === 'complete') && this.onLocalEndIce;
-    peer.onconnectionstatechange = event => this.connectionStateChange(this.peer.connectionState);
-
-    return peer;
-  }
-  negotiationneeded() { // Something has changed locally (new stream, or network change), such that we have to start negotiation.
-    this.log('negotiationnneeded');
-    this.peer.createOffer()
-      .then(offer => {
-        this.peer.setLocalDescription(offer); // promise does not resolve to offer
-	return offer;
-      })
-      .then(offer => this.signal('offer', offer))
-      .catch(error => this.negotiationneededError(error));
-  }
-  negotiationneededError(eventOrException) {
-    this.logError('negotiationneeded', eventOrException);
-  }
-  icecandidateError(eventOrException) { // For errors on this peer during gathering.
-    // Can be overridden or extended by applications.
-
-    // STUN errors are in the range 300-699. See RFC 5389, section 15.6
-    // for a list of codes. TURN adds a few more error codes; see
-    // RFC 5766, section 15 for details.
-    // Server could not be reached are in the range 700-799.
-    const code = eventOrException.code || eventOrException.errorCode || eventOrException.status;
-    // Chrome gives 701 errors for some turn servers that it does not give for other turn servers.
-    // This isn't good, but it's way too noisy to slog through such errors, and I don't know how to fix our turn configuration.
-    if (code === 701) return;
-    this.logError('ice', eventOrException);
-  }
-  onLocalIceCandidate(event) {
-    // The spec says that a null candidate should not be sent, but that an empty string candidate should. Safari (used to?) get errors either way.
-    if (!event.candidate || !event.candidate.candidate) this.onLocalEndIce();
-    else this.signal('icecandidate', event.candidate);
-  }
-  onLocalEndIce() { // Triggered on our side by any/all of onicecandidate with no event.candidate, iceGatheringState === 'complete'.
-    // I.e., can happen multiple times. Subclasses might do something.
-  }
-  connectionStateChange(state) {
-    this.log('state change:', state);
-    if (['disconnected', 'failed', 'closed'].includes(state)) this.close(); // Other behavior are reasonable, tolo.
-  }
-}

package/lib/utilities.js

@@ -1,92 +0,0 @@
-import wrtc from '#wrtc';
-
-const iceServers = [ // Some default stun and even turn servers.
-  
-  { urls: 'stun:stun.l.google.com:19302'},
-  // https://freestun.net/  Currently 50 KBit/s. (2.5 MBit/s fors $9/month)
-  { urls: 'stun:freestun.net:3478' },
-
-  //{ urls: 'turn:freestun.net:3478', username: 'free', credential: 'free' },
-  // Presumably traffic limited. Can generate new credentials at https://speed.cloudflare.com/turn-creds
-  // Also https://developers.cloudflare.com/calls/ 1 TB/month, and $0.05 /GB after that.
-  { urls: 'turn:turn.speed.cloudflare.com:50000', username: '826226244cd6e5edb3f55749b796235f420fe5ee78895e0dd7d2baa45e1f7a8f49e9239e78691ab38b72ce016471f7746f5277dcef84ad79fc60f8020b132c73', credential: 'aba9b169546eb6dcc7bfb1cdf34544cf95b5161d602e3b5fa7c8342b2e9802fb' }
-
-  // See also:
-  // https://fastturn.net/ Currently 500MB/month? (25 GB/month for $9/month)
-  // https://xirsys.com/pricing/ 500 MB/month (50 GB/month for $33/month)
-  // Also https://www.npmjs.com/package/node-turn or https://meetrix.io/blog/webrtc/coturn/installation.html
-];
-
-// Basic logging and configuration wrapper around an instance of RTCPeerConnection.
-export class WebRTCUtilities {
-  constructor({label = '', configuration = null, debug = false, error = console.error, ...rest} = {}) {
-    configuration ??= {iceServers}; // If configuration can be ommitted or explicitly as null, to use our default. But if {}, leave it be.
-    Object.assign(this, {label, configuration, debug, error, ...rest});
-    this.resetPeer();
-    this.connectionStartTime = Date.now();
-  }
-  signal(type, message) { // Subclasses must override or extend. Default just logs.
-    this.log('sending', type, type.length, JSON.stringify(message).length);
-  }
-  close() {
-    if ((this.peer.connectionState === 'new') && (this.peer.signalingState === 'stable')) return;
-    this.resetPeer();
-  }
-  instanceVersion = 0;
-  resetPeer() { // Set up a new RTCPeerConnection.
-    const old = this.peer;
-    if (old) {
-      old.onnegotiationneeded = old.onicecandidate = old.onicecandidateerror = old.onconnectionstatechange = null;
-      // Don't close unless it's been opened, because there are likely handlers that we don't want to fire.
-      if (old.connectionState !== 'new') old.close();
-    }
-    const peer = this.peer = new wrtc.RTCPeerConnection(this.configuration);
-    peer.instanceVersion = this.instanceVersion++;
-
-    return peer;
-  }
-  async reportConnection(doLogging = false) { // Update self with latest wrtc stats (and log them if doLogging true). See Object.assign for properties.
-    const stats = await this.peer.getStats();
-    let transport;
-    for (const report of stats.values()) {
-      if (report.type === 'transport') {
-	transport = report;
-	break;
-      }
-    }
-    let candidatePair = transport && stats.get(transport.selectedCandidatePairId);
-    if (!candidatePair) { // Safari doesn't follow the standard.
-      for (const report of stats.values()) {
-	if ((report.type === 'candidate-pair') && report.selected) {
-	  candidatePair = report;
-	  break;
-	}
-      }
-    }
-    if (!candidatePair) {
-      console.warn(this.label, 'got stats without candidatePair', Array.from(stats.values()));
-      return;
-    }
-    const remote = stats.get(candidatePair.remoteCandidateId);
-    const {protocol, candidateType} = remote;
-    const now = Date.now();
-    Object.assign(this, {stats, transport, candidatePair, remote, protocol, candidateType, statsTime: now});
-    if (doLogging) console.info(this.label, 'connected', protocol, candidateType, ((now - this.connectionStartTime)/1e3).toFixed(1));
-  }
-  log(...rest) { // console.log(...rest) ONLY if debug is set.
-    if (this.debug) console.log(this.label, this.peer.instanceVersion, ...rest);
-  }
-  logError(label, eventOrException) { // Call error with the gathered platform-specific data. Returns the gatheredata.
-    const data = [this.label, this.peer.instanceVersion, ...this.constructor.gatherErrorData(label, eventOrException)];
-    this.error(...data);
-    return data;
-  }
-  static gatherErrorData(label, eventOrException) { // Normalize several context- or platform-specific properties.
-    return [
-      label + " error:",
-      eventOrException.code || eventOrException.errorCode || eventOrException.status || "", // First is deprecated, but still useful.
-      eventOrException.url || eventOrException.name || '',
-      eventOrException.message || eventOrException.errorText || eventOrException.statusText || eventOrException
-    ];
-  }
-}

package/lib/webrtc.js

@@ -1,57 +0,0 @@
-import { WebRTCBase } from './webrtcbase.js';
-
-export class WebRTC extends WebRTCBase {
-
-  async respond(signals) { // When a peer sends an offer or ice, this can be used to respond.
-    this.signals = signals;
-    await this.signalsReady;
-    return this.signals;
-  }
-  async connectVia(responder) { // Resolves when connected to the peer signaled via responder.
-    // Use like this (see test suite):
-    // let promise = this.signalsReady;
-    // let dataChannelPromise = this.ensureDataChannel(channelName); // Or something else that triggers negotiation.
-    // const aSignals = await promise;
-    // await this.connectVia(somethingThatCreatesPeerAndExchangesSigansl)); // Typically through peer.respond(signals).
-    
-    const returning = await responder(this.signals); // this.signals might be an empty list.
-    if (!returning?.length) return;
-    if (this.peer.iceGatheringState !== 'gathering') return; // All done.
-    this.signals = returning;
-    await this.connectVia(responder); // Keep "long-polling" the other side until it has nothing left to say.
-  }
-  
-  sending = [];
-  get signals() { // Answer the signals that have fired on this end since the last time this.signals was asked for.
-    let pending = this.sending;
-    this.sending = [];
-    return pending;
-  }
-  set signals(data) { // Set with the signals received from the other end.
-    data.forEach(([type, message]) => this[type](message));
-  }
-
-  signalResolvers = [];
-  resetAndResolveSignals() { // Any pending.
-    let resolvers = this.signalResolvers; // Reset and resolve all pending resolvers.
-    this.signalResolvers = [];
-    for (const resolve of resolvers) resolve(null);
-  }    
-  get signalsReady() { // Return a promise that resolves as soon as there any ready.
-    // Each time that a client calls get signalsReady, a new promise is generated.
-    if (this.sending.length) return Promise.resolve(null);
-    const { promise, resolve } = Promise.withResolvers();
-    this.signalResolvers.push(resolve);
-    return promise;
-  }
-
-  signal(type, message) { // Handle signals being generated on this side, by accumulating them for get signals
-    super.signal(type, message);
-    this.sending.push([type, message]);
-    this.resetAndResolveSignals();
-  }
-  connectionStateChange(state) { // When we connect, resetAndResolveSignals.
-    super.connectionStateChange(state);
-    if ('connected' === state) this.resetAndResolveSignals();
-  }
-}

package/lib/webrtcbase.js

@@ -1,42 +0,0 @@
-import { WebRTCDataChannels } from './datachannels.js';
-
-// Basics.
-export class WebRTCBase extends WebRTCDataChannels {
-  static connections = new Map();
-  static ensure({serviceLabel, multiplex = true, ...rest}) { // Answer the named connection, creating it if there isn't already a CONNECTED one by this name.
-    // The serviceLabel is used as the log label throughout.
-    // E.g., if a node has connections to many other nodes, but with multiple channels on each connection, then it is
-    // convenient to name the shared connection with the id of the other side.
-    //
-    // If running both ends in the same Javascript, be sure to give them different names!
-
-    let connection = this.connections.get(serviceLabel);
-    // It is possible that we were backgrounded before we had a chance to act on a closing connection and remove it.
-    if (connection) {
-      const {connectionState, signalingState} = connection.peer;
-      if ((connectionState === 'new') || (connectionState === 'closed') || (signalingState === 'closed')) connection = null;
-    }
-    if (!connection) {
-      connection = new this({label: serviceLabel, multiplex, ...rest});
-      if (multiplex) this.connections.set(serviceLabel, connection);
-    }
-    return connection;
-  }
-
-  // Handlers for signal messages from the peer.
-  // Note that one peer will receive offer(), and the other will receive answer(). Both receive icecandidate.
-  offer(offer) { // Handler for receiving an offer from the other user (who started the signaling process).
-    // Note that during signaling, we will receive negotiationneeded/answer, or offer, but not both, depending
-    // on whether we were the one that started the signaling process.
-    this.peer.setRemoteDescription(offer)
-      .then(_ => this.peer.createAnswer())
-      .then(answer => this.peer.setLocalDescription(answer)) // promise does not resolve to answer
-      .then(_ => this.signal('answer', this.peer.localDescription));
-  }
-  answer(answer) { // Handler for finishing the signaling process that we started.
-    this.peer.setRemoteDescription(answer);
-  }
-  icecandidate(iceCandidate) { // Handler for a new candidate received from the other end through signaling.
-    this.peer.addIceCandidate(iceCandidate).catch(error => this.icecandidateError(error));
-  }
-}