extensions/browser/events/event_ack_data.h

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_BROWSER_EVENTS_EVENT_ACK_DATA_H_
#define EXTENSIONS_BROWSER_EVENTS_EVENT_ACK_DATA_H_

#include <map>

#include "base/functional/callback_forward.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "base/uuid.h"
#include "content/public/browser/service_worker_external_request_result.h"
#include "extensions/browser/extension_event_histogram_value.h"

namespace content {
class ServiceWorkerContext;
}

namespace extensions {

enum class EventDispatchSource : int;

// Manages in-flight events for extension Service Worker.
class EventAckData {
 public:
  EventAckData();

  EventAckData(const EventAckData&) = delete;
  EventAckData& operator=(const EventAckData&) = delete;

  ~EventAckData();

  // Records the fact that an event with `event_id` was dispatched to an
  // extension Service Worker and we expect an ack for the event from the worker
  // later on.
  void IncrementInflightEvent(content::ServiceWorkerContext* context,
                              int render_process_id,
                              int64_t version_id,
                              int worker_thread_id,
                              int event_id,
                              base::TimeTicks dispatch_start_time,
                              EventDispatchSource dispatch_source,
                              bool lazy_background_active_on_dispatch,
                              events::HistogramValue histogram_value);
  // Clears the record of our knowledge of an in-flight event with `event_id`.
  //
  // On failure, `failure_callback` is called synchronously.
  void DecrementInflightEvent(content::ServiceWorkerContext* context,
                              int render_process_id,
                              int64_t version_id,
                              int worker_thread_id,
                              int event_id,
                              bool worker_stopped,
                              base::OnceClosure failure_callback);

  // Removes any `unacked_events_` for `render_process_id`.
  void ClearUnackedEventsForRenderProcess(int render_process_id);

  // Removes any `unacked_events_` for a specific service worker instance. This
  // should be called when it's known that the worker will not send an ack
  // (e.g., because it has been shut down). If `context` is provided, also calls
  // `FinishedExternalRequest` for each event to ensure the external request ref
  // count is properly managed.
  void ClearUnackedEventsForWorker(content::ServiceWorkerContext* context,
                                   int render_process_id,
                                   int64_t version_id,
                                   int worker_thread_id);

  bool HasUnackedEventForTesting(int event_id);

 private:
  // Information about an unacked event.
  struct EventInfo {
    EventInfo(
        const base::Uuid& request_uuid,
        int render_process_id,
        int64_t version_id,
        int worker_thread_id,
        bool start_ok,
        content::ServiceWorkerExternalRequestResult external_request_result,
        base::TimeTicks dispatch_start_time,
        EventDispatchSource dispatch_source,
        bool lazy_background_active_on_dispatch,
        const events::HistogramValue histogram_value);

    EventInfo(EventInfo&&);

    EventInfo(const EventInfo&) = delete;
    EventInfo& operator=(const EventInfo&) = delete;

    // Uuid of the Service Worker's external request for the event.
    base::Uuid request_uuid;
    // RenderProcessHost id.
    int render_process_id;
    // Service worker version id.
    int64_t version_id;
    // Service worker thread id.
    int worker_thread_id;
    // Whether or not StartExternalRequest succeeded.
    bool start_ok;
    // The status returned for StartExternalRequest.
    content::ServiceWorkerExternalRequestResult external_request_result;
    // The time the event was dispatched to the event router for the extension.
    base::TimeTicks dispatch_start_time;
    // The event dispatching processing flow that was followed for this event.
    EventDispatchSource dispatch_source;
    // `true` if the event was dispatched to a active/running lazy background.
    bool lazy_background_active_on_dispatch;
    // See `EventRouter::Event.histogram_value`.
    events::HistogramValue histogram_value;
  };

  // Emits a stale event ack metric if an event with `event_id` is not present
  // in `unacked_events_`. Meaning that the event was not yet acked by the
  // renderer to the browser.
  void EmitLateAckedEventTask(int event_id);
  void EmitLateAckedEventTaskMetrics(const EventInfo& event_info);

  // Emit all the time related event dispatch metrics when an event is acked
  // from the renderer.
  static void EmitDispatchTimeMetrics(EventInfo& event_info);

  // TODO(crbug.com/40909770): Mark events that are not acked within 5 minutes
  // (if the worker is still around) as stale, and emit
  // Extensions.Events.DispatchToAckTime.ExtensionServiceWorker2 at that point.
  // Acks after that point should check staleness and not emit a second time.
  std::map<int, EventInfo> unacked_events_;

  base::WeakPtrFactory<EventAckData> weak_factory_{this};
};

}  // namespace extensions

#endif  // EXTENSIONS_BROWSER_EVENTS_EVENT_ACK_DATA_H_