Closed Bug 1644191 Opened 4 years ago Closed 4 years ago

Implement Network Event listening via the ResourceWatcher API on the actor side

Tracking

(Fission Milestone:M6c, firefox80 fixed, firefox81 fixed, firefox82 fixed)

Status:

RESOLVED FIXED

Milestone:

Firefox 80

Project Flags:

Fission Milestone

M6c

Tracking Flags:

Tracking

Status

firefox80

---

fixed

firefox81

---

fixed

firefox82

---

fixed

People

(Reporter: ochameau, Assigned: bomsy)

References

(Depends on 2 open bugs, Blocks 1 open bug)

Details

(Whiteboard: dt-fission-m2-mvp)

Attachments

(2 files, 8 obsolete files)

Bug 1644191 - Server side network events listening 4 years ago Alexandre Poirot [:ochameau] 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Add tests for network event resources (WIP) r=nchevobbe 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Server side network event listening WIP r=nchevobbe 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Add tests for network event resources r=nchevobbe 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Access the browsingContextID directly from the watcherActor r=ochameau 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - server side network event listening r=nchevobbe 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Add Network events stacktrace watcher r=ochameau 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Add the network event stacktrace watcher r=ochameau 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Legacy listener for the Network stacktrace 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review
Bug 1644191 - Tests for the Network Event Stacktrace 4 years ago Hubert Boma Manilla (:bomsy) 47 bytes, text/x-phabricator-request		Details \| Review

Alexandre Poirot [:ochameau]

Reporter

Description

•

4 years ago

•

Edited

The goal here is to implement the NETWORK_EVENT resource from the actor side.
This is about replicating the current behavior, implemented in bug 1625909.
But instead of having a wrapper on the client side to morph the legacy WebConsoleFront methods (i.e. the legacy listener code),
we would implement an actor API matching ResourceWatcher API (i.e. watch and unwatch).

This would be about implementing a server side equivalent of this legacy listener code:
https://searchfox.org/mozilla-central/source/devtools/shared/resources/legacy-listeners/network-events.js
In a new server side module:
https://searchfox.org/mozilla-central/source/devtools/server/actors/resources/network-events.js

This module would typicaly look like this:

const { TYPES } = require("devtools/server/actors/resources/index");

class MyResourceWatcher {
  /**
   * Start watching for all ${MY_RESOURCE_TYPE} related to a given Target Actor.
   * This will notify about existing ${MY_RESOURCE_TYPE}, but also the one created in future.
   *
   * @param TargetActor targetActor
   *        The target actor from which we should observe console messages
   * @param Object options
   *        Dictionary object with following attributes:
   *        - onAvailable: mandatory function
   *          This will be called for each resource.
   */
  constructor(targetActor, { onAvailable }) {
    // In most cases, we already have some helper class which helps observing one resource
    // that we can spawn like this:
    // Note that it may often be easier to merge such `MyResourceListener` into this `MyResourceWatcher` class!
    const listener = new MyResourceListener(
      targetActor.browsingContextID,
      targetActor.window,
      ...  /* whatever is useful for your observation */
    );
    
    // Forward all future resources being observed to the upper layer calling this module,
    // via `onAvailable` callback argument.
    // I'm using EventEmitter API here, but the API may different,
    // based on the platform API we have to use to observe the resource.
    listener.on("one-of-my-resource-is-created", resource => {
      // We have to ensure that each resource object has a valid `resourceType` attribute
      resource.resourceType = TYPES.MY_RESOURCE_TYPE;
      onAvailable([resource]);
    });
    
    // Also forward all resources which already exist when we are calling this method
    // (if any exists)
    const cachedResources = listener.getAllAlreadyExistingOrCachedResources();
    for(const resource of cachedResources) {
      resource.resourceType = TYPES.MY_RESOURCE_TYPE;
    }
    onAvailable(cachedResources);
    
    // Save the listener in order to destroy/stop watching later on.
    this.listener = listener;
  }

  /**
   * Stop watching for ${MY_RESOURCE_TYPE}.
   */
  destroy() {
    if (this.listener) {
      this.listener.destroy();
    }
  }
}
module.exports = MyResourceWatcher;

An important goal here is to emit the exact same resource object that the legacy listener is passing to its onAvailable callback.
Same attributes, same values, ...

Bug 1644185 could be used as a template. As it did this work for PLATFORM_MESSAGE resource type.

The main reason to do this is to be able to start listening to the resource before the page starts loading.
Thanks to the framework work done in bug 1620243, this MyResourceWatcher class will be instantiated before the page starts
loading and possibly as early as the content process just started.
This wasn't the case with legacy actor APIs like WebConsoleActor.startListeners, ThreadActor.attachThread, ...
We were calling these methods too late, only after the frontend is notify about the existance of the target, so, late after the page started loading.

You will also have to register this new module in this registry:
https://searchfox.org/mozilla-central/source/devtools/server/actors/resources/index.js

Add a new entry in TYPES object.
Register your new resource watcher module into Resources object.

Last but not least, it is probably a good time to review the existing tests for this Resource:
https://searchfox.org/mozilla-central/source/devtools/shared/resources/tests
And ensure that it has a good coverage.
You would especially have to migrate all Client/Front tests, which were testing the backend behavior via targetFront.getFront("myfront").
All these tests will be removed, once we drop the legacy listeners. Because we are going to drop the server API that we no longer use.
Like WebConsoleActor/Front.getCachedMessage(), WebConsoleActor/Front.startListeners(), ThreadActor/Front.sources(), ThreadActor/Front.new-source, ...

Alexandre Poirot [:ochameau]

Reporter

Comment 1

•

4 years ago

Attached file Bug 1644191 - Server side network events listening — Details

Chris Peterson [:cpeterson]

Comment 2

•

4 years ago

Tracking dt-fission-m2 bugs for Fission Nightly (M6c)

Fission Milestone: --- → M6c