android-emulator-webrtc 1.0.18 → 2.0.1

package/src/proto/emulator_web_client.js

@@ -1,140 +0,0 @@
-/*
- * Copyright 2019 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License")
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { EmulatorControllerClient } from "../proto/emulator_controller_grpc_web_pb";
-import { RtcClient } from "../proto/rtc_service_grpc_web_pb";
-import { GrpcWebClientBase } from "grpc-web";
-import { EventEmitter } from "events";
-
-export class NopAuthenticator {
-  authHeader = () => {
-    return {};
-  };
-
-  unauthorized = () => { };
-}
-
-/**
- * A GrcpWebClientBase that inject authentication headers and intercepts
- * errors. If the errors are 401, the unauthorized method of the authenticator will be invoked.
- *
- * @export
- * @class EmulatorWebClient
- * @extends {GrpcWebClientBase}
- */
-class EmulatorWebClient extends GrpcWebClientBase {
-  constructor(options, auth) {
-    super(options);
-    this.auth = auth;
-    this.events = new EventEmitter();
-    this.events.on("error", e => {console.log("low level gRPC error: " + JSON.stringify(e));})
-  }
-
-  on = (name, fn) => {
-    this.events.on(name, fn);
-  };
-
-  rpcCall = (method, request, metadata, methodinfo, callback) => {
-    const authHeader = this.auth.authHeader();
-    const meta = { ...metadata, ...authHeader };
-    const self = this;
-    return super.rpcCall(method, request, meta, methodinfo, (err, res) => {
-      if (err) {
-        if (err.code === 401) self.auth.unauthorized();
-        if (self.events)
-          self.events.emit("error", err);
-      }
-      if (callback) callback(err, res);
-    });
-  };
-
-  serverStreaming = (method, request, metadata, methodInfo) => {
-    const authHeader = this.auth.authHeader();
-    const meta = { ...metadata, ...authHeader };
-    const stream = super.serverStreaming(method, request, meta, methodInfo);
-    const self = this;
-
-    // Intercept errors.
-    stream.on("error", e => {
-      if (e.code === 401) {
-        self.auth.unauthorized();
-      }
-      self.events.emit("error", e);
-    });
-    return stream;
-  };
-}
-
-/**
- * An EmulatorControllerService is an EmulatorControllerClient that inject authentication headers.
- * You can provide your own authenticator service that must implement the following mehtods:
- *
- * - `authHeader()` which must return a set of headers that should be send along with a request.
- * - `unauthorized()` a function that gets called when a 401 was received.
- *
- * You can use this to simplify handling authentication failures.
- *
- * TODO(jansene): Maybe expose error handling? That way it does
- * not have to be repeated at every function call.
- *
- * @export
- * @class EmulatorControllerService
- * @extends {EmulatorControllerClient}
- */
-export class EmulatorControllerService extends EmulatorControllerClient {
-  /**
-   *Creates an instance of EmulatorControllerService.
-   * @param {string} uri of the emulator controller endpoint.
-   * @param {Authenticator} authenticator used to authenticate with the emulator endpoint.
-   * @param onError callback that will be invoked when a low level gRPC error arises.
-   * @memberof EmulatorControllerService
-   */
-  constructor(uri, authenticator, onError) {
-    super(uri);
-    if (!authenticator) authenticator = new NopAuthenticator();
-    this.client_ = new EmulatorWebClient({}, authenticator);
-    if (onError) this.client_.on('error', e => { onError(e); });
-  }
-}
-
-
-/**
- * An RtcService is an RtcClient that inject authentication headers.
- * You can provide your own authenticator service that must implement the following mehtods:
- *
- * - `authHeader()` which must return a set of headers that should be send along with a request.
- * - `unauthorized()` a function that gets called when a 401 was received.
- *
- * You can use this to simplify handling authentication failures.
- *
- * @export
- * @class EmulatorControllerService
- * @extends {RtcClient}
- */
-export class RtcService extends RtcClient {
-  /**
-   *Creates an instance of RtcService.
-   * @param {string} uri of the emulator controller endpoint.
-   * @param {Authenticator} authenticator used to authenticate with the emulator endpoint.
-   * @param onError callback that will be invoked when a low level gRPC error arises.
-   * @memberof RtcService
-   */
-  constructor(uri, authenticator, onError) {
-    super(uri);
-    if (!authenticator) authenticator = new NopAuthenticator();
-    this.client_ = new EmulatorWebClient({}, authenticator);
-    if (onError) this.client_.on('error', e => { onError(e); });
-  }
-}

package/test/cloudbuild.yaml

@@ -1,41 +0,0 @@
-steps:
-  - name: "gcr.io/cloud-builders/gcloud"
-    args:
-      - kms
-      - decrypt
-      - --ciphertext-file=npmrc.enc
-      - --plaintext-file=/root/.npmrc
-      - --location=global
-      - --keyring=my-keyring
-      - --key=npm-key
-    volumes:
-      - name: "home"
-        path: /root/
-  - name: gcr.io/emu-dev-cts/protoc
-    args:
-      [
-        "--include_imports",
-        "--include_source_info",
-        "--proto_path",
-        "./proto",
-        "--descriptor_set_out",
-        "api_descriptor.pb",
-        "--plugin=protoc-gen-grpc-web=/protoc/bin/protoc-gen-grpc-web",
-        "--js_out=import_style=commonjs:src/proto",
-        "--grpc-web_out=import_style=commonjs,mode=grpcwebtext:src/proto",
-        "./proto/emulator_controller.proto",
-        "./proto/rtc_service.proto",
-      ]
-  - name: "gcr.io/cloud-builders/npm"
-    args: ["install"]
-  - name: "gcr.io/cloud-builders/npm"
-    args: ["run", "build"]
-  - name: "gcr.io/cloud-builders/npm"
-    args: ["test"]
-  - name: "gcr.io/cloud-builders/npm"
-    args: ["publish", "/workspace", "--dry-run"]
-    env:
-      - HOME=/root/
-    volumes:
-      - name: "home"
-        path: /root/

package/test/emulator.test.js

@@ -1,125 +0,0 @@
-
-/**
- * @jest-environment jsdom
- */
-/*
- * Copyright 2020 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License")
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import "@testing-library/jest-dom";
-import "babel-polyfill";
-import { EventEmitter } from "events";
-import React from "react";
-import { render, fireEvent, screen, waitFor } from "@testing-library/react";
-import Emulator from "../src/components/emulator/emulator";
-import * as Proto from "../src/proto/emulator_controller_pb";
-import * as Rtc from "../src/proto/rtc_service_pb";
-import {
-  RtcService,
-  EmulatorControllerService,
-} from "../src/proto/emulator_web_client";
-
-jest.mock("../src/proto/emulator_web_client");
-
-// See https://github.com/testing-library/react-testing-library/issues/470
-// As well as https://github.com/facebook/react/issues/10389
-// All because of the "muted" tag on our video element inside webrtc_view
-const renderIgnoringUnstableFlushDiscreteUpdates = (component) => {
-  // tslint:disable: no-console
-  const originalError = console.error;
-  const error = jest.fn();
-  console.error = error;
-  const result = render(component);
-  expect(error).toHaveBeenCalledTimes(1);
-  expect(error).toHaveBeenCalledWith(
-    "Warning: unstable_flushDiscreteUpdates: Cannot flush updates when React is already rendering.%s",
-    expect.any(String)
-  );
-  console.error = originalError;
-  // tslint:enable: no-console
-  return result;
-};
-
-describe("The emulator", () => {
-  beforeEach(() => {
-    // Clear all instances and calls to constructor and all methods:
-    RtcService.mockClear();
-    EmulatorControllerService.mockClear();
-  });
-
-  test("Creates gRPC services", async () => {
-    render(
-      <Emulator uri="/test" width={300} height={300} />
-    );
-
-    expect(EmulatorControllerService).toHaveBeenCalled();
-    expect(RtcService).toHaveBeenCalled();
-    // Shipped out a gps call
-  });
-  test("Tries to establish a webrtc connection", async () => {
-    let state;
-    render(
-      <Emulator
-        uri="/test"
-        width={300}
-        height={300}
-        onStateChange={(e) => {
-          state = e;
-        }}
-      />
-    );
-
-    await waitFor(() => state === "connecting");
-    expect(RtcService).toHaveBeenCalled();
-  });
-
-  test("Sends a gps location to the emulator", async () => {
-    // Let's go to Seattle!
-    render(
-      <Emulator
-        uri="/test"
-        width={300}
-        height={300}
-        gps={{ latitude: 47.6062, longitude: 122.3321 }}
-      />
-    );
-
-    const setGps = EmulatorControllerService.mock.instances[0].setGps;
-    expect(setGps).toHaveBeenCalled();
-
-    const location = new Proto.GpsState();
-    location.setLatitude(47.6062);
-    location.setLongitude(122.3321);
-    location.setAltitude(undefined);
-    location.setBearing(undefined);
-    location.setSpeed(undefined);
-    expect(setGps).toHaveBeenCalledWith(location);
-  });
-
-  test("The png view requests images", async () => {
-    let pngCall = false
-    EmulatorControllerService.mockImplementation(() => {
-      return {
-        streamScreenshot: jest.fn((request) => {
-            pngCall = true
-          return { on: jest.fn(), cancel: jest.fn() };
-        }),
-        getStatus: jest.fn(() => {}),
-      };
-    });
-
-    render(<Emulator uri="/test" width={300} height={300} view="png" />);
-    expect(pngCall).toBeTruthy()
-  });
-});

package/test/event_handler.test.js

@@ -1,91 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-/*
- * Copyright 2020 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License")
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import "@testing-library/jest-dom";
-
-import React from "react";
-import { render, fireEvent, screen } from "@testing-library/react";
-import { fakeMouseEvent, fakeTouchEvent} from "./fake_events";
-import withMouseKeyHandler from "../src/components/emulator/views/event_handler";
-
-import JsepProtocol from "../src/components/emulator/net/jsep_protocol_driver";
-import {
-  RtcService,
-  EmulatorControllerService,
-} from "../src/proto/emulator_web_client";
-
-jest.mock("../src/proto/emulator_web_client");
-jest.mock("../src/proto/rtc_service_pb");
-jest.mock("../src/proto/emulator_controller_pb");
-
-
-class FakeEmulator extends React.Component {
-  render() {
-    return (
-      <div
-        data-testid="fake"
-        style={{ height: "200px", width: "200px", backgroundColor: "#555" }}
-      ></div>
-    );
-  }
-}
-
-const TestView = withMouseKeyHandler(FakeEmulator);
-describe("The event handler using a real jsep serializer", () => {
-
-  const rtcServiceInstance = new RtcService("http://foo");
-  const emulatorServiceInstance = new EmulatorControllerService("http://foo");
-  let jsep, fakeScreen;
-
-  beforeEach(() => {
-    jest.clearAllMocks();
-    jsep = new JsepProtocol(emulatorServiceInstance, rtcServiceInstance, true);
-
-    render(<TestView emulator={emulatorServiceInstance} jsep={jsep} />);
-    fakeScreen = screen.getByTestId("fake").parentElement;
-    Object.defineProperty(fakeScreen, "clientWidth", { get: () => 200 });
-    Object.defineProperty(fakeScreen, "clientHeight", { get: () => 200 });
-
-    expect(fakeScreen).toBeInTheDocument();
-  });
-
-  test("Forwards mouse events", () => {
-    fireEvent(fakeScreen, fakeMouseEvent("mousedown", 10, 10));
-    fireEvent(fakeScreen, fakeMouseEvent("mouseup", 20, 20));
-
-    // Shipped out a mouse event
-    expect(emulatorServiceInstance.sendMouse).toHaveBeenCalledTimes(2);
-  });
-
-  test("Forwards keyboard events", () => {
-    fireEvent.keyDown(fakeScreen, { key: "Enter", code: "Enter" });
-    fireEvent.keyUp(fakeScreen, { key: "Enter", code: "Enter" });
-
-    // Shipped out a keyboard event
-    expect(emulatorServiceInstance.sendKey).toHaveBeenCalledTimes(2);
-  });
-
-  test("Forwards touch events", () => {
-    fireEvent(fakeScreen, fakeTouchEvent("touchstart", 10, 10, 1));
-    fireEvent(fakeScreen, fakeTouchEvent("touchmove", 20, 20, 2));
-    fireEvent(fakeScreen, fakeTouchEvent("touchend", 30, 30, 0));
-
-    // Shipped out a touch event
-    expect(emulatorServiceInstance.sendTouch).toHaveBeenCalledTimes(3);
-  });
-});

package/test/fake_events.js

@@ -1,50 +0,0 @@
-/*
- * Copyright 2021 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License")
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export function fakeMouseEvent(tp, x, y, props = {}) {
-  const event = new MouseEvent(tp, {
-    bubbles: true,
-    cancelable: true,
-    ...props,
-  });
-
-  Object.defineProperty(event, "offsetX", { get: () => x });
-  Object.defineProperty(event, "offsetY", { get: () => y });
-  return event;
-}
-
-export function fakeTouchEvent(tp, x, y, force, props = {}) {
-  const event = new TouchEvent(tp, {
-    bubbles: true,
-    cancelable: true,
-    ...props,
-  });
-
-  Object.defineProperty(event, "changedTouches", {
-    get: () => [
-      { clientX: x, clientY: y, radiusX: 4, radiusY: 4, force: force },
-    ],
-  });
-  return event;
-}
-
-export function resize(width, height) {
-  const resizeEvent = document.createEvent("Event");
-  resizeEvent.initEvent("resize", true, true);
-
-  global.window.innerWidth = width || global.window.innerWidth;
-  global.window.innerHeight = height || global.window.innerHeight;
-  global.window.dispatchEvent(resizeEvent);
-}

package/test/jsep_protocol_driver.test.js

@@ -1,228 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-/*
- * Copyright 2020 The Android Open Source Project
- *
- * Licensed under the Apache License, Version 2.0 (the "License")
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { jest } from "@jest/globals";
-import "regenerator-runtime/runtime"; // Somehow needed for jest to be happy with ES6
-
-import * as Proto from "../src/proto/emulator_controller_pb";
-import * as Rtc from "../src/proto/rtc_service_pb";
-import JsepProtocol from "../src/components/emulator/net/jsep_protocol_driver.js";
-import {
-  RtcService,
-  EmulatorControllerService,
-} from "../src/proto/emulator_web_client";
-
-jest.mock("../src/proto/emulator_web_client");
-
-const jsepMessage = (object, uid) => {
-  const guid = new Rtc.RtcId();
-  guid.setGuid(uid);
-
-  const jsepMsg = new Rtc.JsepMsg();
-  jsepMsg.setId(guid);
-  jsepMsg.setMessage(JSON.stringify(object));
-  return jsepMsg;
-};
-
-const requestRtcStream = jest.fn((request, metadata, callback) => {
-  const guid = new Rtc.RtcId();
-  guid.setGuid("abcde");
-
-  callback(null, guid);
-});
-
-const receiveJsepMessage = (message) => {
-  const jsepMsg = jsepMessage(message);
-  return jest.fn((request, metadata, callback) => {
-    callback(null, jsepMsg);
-  });
-};
-
-const RTCPeerConnectionMock = jest.fn().mockImplementation((cfg) => ({
-  ondatachannel: jest.fn(),
-  createAnswer: jest.fn(),
-  addEventListener: jest.fn(),
-  addIceCandidate: jest.fn(),
-  dispatchEvent: jest.fn(),
-  setRemoteDescription: jest.fn(),
-  setLocalDescription: jest.fn(),
-  close: jest.fn(),
-}));
-
-Object.defineProperty(window, "RTCPeerConnection", {
-  writable: true,
-  value: jest.fn().mockImplementation((cfg) => {
-    let sdp = null;
-    let signal = null;
-    let state = null;
-    return {
-      ondatachannel: jest.fn(),
-      createAnswer: jest.fn(() => {
-        return new Promise((resolve) => {
-          return { answer: "fake-answer" };
-        });
-      }),
-      addEventListener: jest.fn(),
-      addIceCandidate: jest.fn(),
-      dispatchEvent: jest.fn(),
-      setRemoteDescription: (desc) => {
-        sdp = desc;
-        state = "have-remote-offer";
-        if (signal) signal();
-      },
-      setLocalDescription: jest.fn(),
-      get currentRemoteDescription() {
-        return sdp;
-      },
-      set onsignalingstatechange(fn) {
-        signal = fn;
-      },
-      get signalingState() {
-        return state;
-      },
-      close: jest.fn(),
-    };
-  }),
-});
-
-Object.defineProperty(window, "RTCIceCandidate", {
-  writable: true,
-  value: jest.fn().mockImplementation((cfg) => ({})),
-});
-
-Object.defineProperty(window, "RTCSessionDescription", {
-  writable: true,
-  value: jest.fn().mockImplementation((desc) => {
-    return { sdp: desc };
-  }),
-});
-
-const sdp = {
-  sdp: "fakesdp1",
-  type: "offer",
-};
-
-const sdp2 = {
-  sdp: "fakesdp2",
-  type: "offer",
-};
-const candidates_and_sdp = [
-  {
-    candidate:
-      "candidate:4205781435 1 udp 2122260223 10.146.0.6 37608 typ host generation 0 ufrag Er9W network-id 1 network-cost 50",
-    sdpMLineIndex: 1,
-    sdpMid: "1",
-  },
-  {
-    candidate:
-      "candidate:3022839115 1 tcp 1518280447 10.146.0.6 36959 typ host tcptype passive generation 0 ufrag Er9W network-id 1 network-cost 50",
-    sdpMLineIndex: 0,
-    sdpMid: "0",
-  },
-  sdp,
-];
-
-const jsepProtocol = (messages) => {
-  RtcService.mockClear();
-  EmulatorControllerService.mockClear();
-
-  let receive = jest.fn();
-  for (var i = 0; i < messages.length; i++) {
-    receive.mockImplementationOnce(receiveJsepMessage(messages[i]));
-  }
-  RtcService.mockImplementation(() => {
-    return {
-      requestRtcStream: requestRtcStream,
-      receiveJsepMessage: receive,
-      sendJsepMessage: jest.fn((msg) => {
-        console.log("Sending " + msg);
-      }),
-    };
-  });
-  const rtcServiceInstance = new RtcService("http://foo");
-  const emulatorServiceInstance = new EmulatorControllerService("http://foo");
-  return {
-    rtc: rtcServiceInstance,
-    jsep: new JsepProtocol(emulatorServiceInstance, rtcServiceInstance, true),
-  };
-};
-
-describe("Basic jsep protocol with polling.", () => {
-  it("calls request rtc stream", () => {
-    const { rtc, jsep } = jsepProtocol([{ bye: "we're done" }]);
-    jsep.startStream();
-    expect(rtc.requestRtcStream.mock.calls.length).toBe(1);
-    expect(rtc.receiveJsepMessage.mock.calls.length).toBe(1);
-  });
-
-  it("Notifies listeners of a disconnect", () => {
-    const { jsep } = jsepProtocol([{ bye: "we're done" }]);
-
-    const disconnect = jest.fn();
-    jsep.on("disconnected", disconnect);
-    jsep.startStream();
-    expect(disconnect).toHaveBeenCalledTimes(1);
-  });
-
-  it("Does not process messages before start", () => {
-    const { jsep } = jsepProtocol(candidates_and_sdp);
-
-    jsep.startStream();
-    // All candidates are queued.
-    expect(jsep.old_emu_patch.candidates.length).toBe(2);
-    expect(jsep.old_emu_patch.sdp).not.toBeNull();
-  });
-
-  it("Flush message queue after bye", () => {
-    let msg = Array.from(candidates_and_sdp);
-    msg.push({ bye: "we're done" });
-    const { jsep } = jsepProtocol(msg);
-
-    jsep.startStream();
-    expect(jsep.old_emu_patch.candidates.length).toBe(0);
-    expect(jsep.old_emu_patch.sdp).toBe(null);
-    expect(jsep.peerConnection).toBe(null);
-  });
-
-  it("Out of order messages handled after start", () => {
-    let msg = Array.from(candidates_and_sdp);
-    msg.push({ start: { foo: "bar" } });
-    const { jsep } = jsepProtocol(msg);
-
-    jsep.startStream();
-    expect(jsep.old_emu_patch.candidates.length).toBe(0);
-    expect(jsep.peerConnection).not.toBeNull();
-    expect(jsep.peerConnection.currentRemoteDescription).not.toBeNull();
-    // Peer connection was initialized with rtc config
-    expect(RTCPeerConnection.mock.calls[0][0]).toStrictEqual({ foo: "bar" });
-  });
-
-  it.skip("Never handles sdp twice / (async problem)", async () => {
-    // 2nd jsep gets dropped.
-    let { rtc, jsep } = jsepProtocol([sdp, sdp2, { start: { foo: "bar" } }]);
-    jsep.startStream();
-    expect(jsep.old_emu_patch.candidates.length).toBe(0);
-    expect(jsep.old_emu_patch.sdp).toBeNull();
-    expect(jsep.old_emu_patch.answer).toBe(true);
-    expect(jsep.peerConnection).not.toBeNull();
-    expect(jsep.peerConnection.currentRemoteDescription.sdp.sdp).toBe(sdp.sdp);
-    // Peer connection was initialized with rtc config
-    expect(RTCPeerConnection.mock.calls[0][0]).toStrictEqual({ foo: "bar" });
-    expect(rtc.sendJsepMessage.mock.calls[0]).toBe(1);
-  });
-});