all repos — sz-chrome-remote-cdp @ master

pi-browser-harness, patched to drive a Chrome on another host over CDP, with castle_cdp_search web search

src/cdp/events.ts (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
import { Type, type Static, type TSchema } from "typebox";
import { Compile } from "typebox/compile";
import { type Result, err, ok } from "../util/result";
import { type CdpError, cdpError } from "./errors";

const ev = <P extends TSchema>(params: P) => ({ params, validate: Compile(params) });

const open = { additionalProperties: true } as const;

const Anything = Type.Object({}, open);

const StackTrace = Type.Object(
  {
    callFrames: Type.Optional(
      Type.Array(
        Type.Object(
          {
            url: Type.Optional(Type.String()),
            lineNumber: Type.Optional(Type.Number()),
            functionName: Type.Optional(Type.String()),
          },
          open,
        ),
      ),
    ),
  },
  open,
);

const ConsoleArg = Type.Object(
  {
    type: Type.Optional(Type.String()),
    value: Type.Optional(Type.Unknown()),
    description: Type.Optional(Type.String()),
    unserializableValue: Type.Optional(Type.String()),
  },
  open,
);

export const EVENTS = {
  "Inspector.detached": ev(Anything),

  "Page.javascriptDialogOpening": ev(
    Type.Object(
      {
        type: Type.String(),
        message: Type.String(),
        defaultPrompt: Type.Optional(Type.String()),
      },
      open,
    ),
  ),
  "Page.loadEventFired": ev(Anything),
  "Page.frameNavigated": ev(Anything),

  "Runtime.consoleAPICalled": ev(
    Type.Object(
      {
        type: Type.Optional(Type.String()),
        args: Type.Optional(Type.Array(ConsoleArg)),
        stackTrace: Type.Optional(StackTrace),
      },
      open,
    ),
  ),

  "Log.entryAdded": ev(
    Type.Object(
      {
        entry: Type.Object(
          {
            level: Type.Optional(Type.String()),
            text: Type.Optional(Type.String()),
            url: Type.Optional(Type.String()),
            lineNumber: Type.Optional(Type.Number()),
            stackTrace: Type.Optional(StackTrace),
          },
          open,
        ),
      },
      open,
    ),
  ),

  "Network.requestWillBeSent": ev(
    Type.Object(
      {
        requestId: Type.String(),
        request: Type.Object(
          {
            url: Type.String(),
            method: Type.String(),
            postData: Type.Optional(Type.String()),
          },
          open,
        ),
        type: Type.Optional(Type.String()),
      },
      open,
    ),
  ),
  "Network.responseReceived": ev(
    Type.Object(
      {
        requestId: Type.String(),
        response: Type.Optional(
          Type.Object(
            {
              status: Type.Optional(Type.Number()),
              statusText: Type.Optional(Type.String()),
              mimeType: Type.Optional(Type.String()),
            },
            open,
          ),
        ),
        type: Type.Optional(Type.String()),
      },
      open,
    ),
  ),
  "Network.loadingFinished": ev(
    Type.Object(
      { requestId: Type.String(), encodedDataLength: Type.Optional(Type.Number()) },
      open,
    ),
  ),
  "Network.loadingFailed": ev(
    Type.Object(
      { requestId: Type.String(), errorText: Type.Optional(Type.String()) },
      open,
    ),
  ),

  "Target.targetCreated": ev(
    Type.Object(
      {
        targetInfo: Type.Object(
          {
            targetId: Type.String(),
            type: Type.String(),
            openerId: Type.Optional(Type.String()),
          },
          open,
        ),
      },
      open,
    ),
  ),
  "Target.targetDestroyed": ev(Type.Object({ targetId: Type.String() }, open)),
};

export type CdpEventName = keyof typeof EVENTS;
export type EventParamsOf<E extends CdpEventName> = Static<(typeof EVENTS)[E]["params"]>;

export const isKnownEvent = (name: string): name is CdpEventName => Object.hasOwn(EVENTS, name);

export const decodeEvent = <E extends CdpEventName>(
  name: E,
  raw: unknown,
): Result<EventParamsOf<E>, CdpError> => {
  const spec = EVENTS[name];
  if (spec === undefined) {
    return err(cdpError("invalid_response", "unknown CDP event", name));
  }
  if (!spec.validate.Check(raw)) {
    const why = spec.validate.Errors(raw).map((e) => e.message).join("; ");
    return err(cdpError("invalid_response", why, name));
  }
  return ok(raw as EventParamsOf<E>);
};