Add navigate telemetry

Author: karlseguin

.github/workflows/e2e-test.yml

@@ -64,6 +64,7 @@ jobs:
     env:
       MAX_MEMORY: 28000
       MAX_AVG_DURATION: 24
+      LIGHTPANDA_DISABLE_TELEMETRY: true
 
     runs-on: ubuntu-latest
 

README.md

@@ -111,6 +111,9 @@ await context.close();
 await browser.disconnect();
 ```
 
+### Telemetry
+By default, Lightpanda collects and sends usage telemetry. This can be disabled by setting an environment variable `LIGHTPANDA_DISABLE_TELEMETRY=true`. You can read Lightpanda's privacy policy at: [https://lightpanda.io/privacy-policy](https://lightpanda.io/privacy-policy).
+
 ## Status
 
 Lightpanda is still a work in progress and is currently at a Beta stage.

src/app.zig

@@ -7,18 +7,30 @@ const Telemetry = @import("telemetry/telemetry.zig").Telemetry;
 // Container for global state / objects that various parts of the system
 // might need.
 pub const App = struct {
+    loop: *Loop,
+    allocator: Allocator,
     telemetry: Telemetry,
 
-    pub fn init(allocator: Allocator, loop: *Loop) !App {
+    pub fn init(allocator: Allocator) !App {
+        const loop = try allocator.create(Loop);
+        errdefer allocator.destroy(loop);
+
+        loop.* = try Loop.init(allocator);
+        errdefer loop.deinit();
+
         const telemetry = Telemetry.init(allocator, loop);
         errdefer telemetry.deinit();
 
         return .{
+            .loop = loop,
+            .allocator = allocator,
             .telemetry = telemetry,
         };
     }
 
     pub fn deinit(self: *App) void {
         self.telemetry.deinit();
+        self.loop.deinit();
+        self.allocator.destroy(self.loop);
     }
 };

src/browser/browser.zig

@@ -33,6 +33,7 @@ const Loop = jsruntime.Loop;
 const Env = jsruntime.Env;
 const Module = jsruntime.Module;
 
+const App = @import("../app.zig").App;
 const apiweb = @import("../apiweb.zig");
 
 const Window = @import("../html/window.zig").Window;
@@ -59,21 +60,19 @@ pub const user_agent = "Lightpanda/1.0";
 // A browser contains only one session.
 // TODO allow multiple sessions per browser.
 pub const Browser = struct {
-    loop: *Loop,
+    app: *App,
     session: ?*Session,
-    allocator: Allocator,
     session_pool: SessionPool,
 
     const SessionPool = std.heap.MemoryPool(Session);
 
     const uri = "about:blank";
 
-    pub fn init(allocator: Allocator, loop: *Loop) Browser {
+    pub fn init(app: *App) Browser {
         return .{
-            .loop = loop,
+            .app = app,
             .session = null,
-            .allocator = allocator,
-            .session_pool = SessionPool.init(allocator),
+            .session_pool = SessionPool.init(app.allocator),
         };
     }
 
@@ -86,7 +85,7 @@ pub const Browser = struct {
         self.closeSession();
 
         const session = try self.session_pool.create();
-        try Session.init(session, self.allocator, ctx, self.loop, uri);
+        try Session.init(session, self.app, ctx, uri);
         self.session = session;
         return session;
     }
@@ -111,6 +110,8 @@ pub const Browser = struct {
 // You can create successively multiple pages for a session, but you must
 // deinit a page before running another one.
 pub const Session = struct {
+    app: *App,
+
     // allocator used to init the arena.
     allocator: Allocator,
 
@@ -138,8 +139,10 @@ pub const Session = struct {
 
     jstypes: [Types.len]usize = undefined,
 
-    fn init(self: *Session, allocator: Allocator, ctx: anytype, loop: *Loop, uri: []const u8) !void {
+    fn init(self: *Session, app: *App, ctx: anytype, uri: []const u8) !void {
+        const allocator = app.allocator;
         self.* = .{
+            .app = app,
             .uri = uri,
             .env = undefined,
             .inspector = undefined,
@@ -153,7 +156,7 @@ pub const Session = struct {
 
         const arena = self.arena.allocator();
 
-        Env.init(&self.env, arena, loop, null);
+        Env.init(&self.env, arena, app.loop, null);
         errdefer self.env.deinit();
         try self.env.load(&self.jstypes);
 
@@ -339,6 +342,7 @@ pub const Page = struct {
     // - auxData: extra data forwarded to the Inspector
     // see Inspector.contextCreated
     pub fn navigate(self: *Page, uri: []const u8, auxData: ?[]const u8) !void {
+        self.session.app.telemetry.record(.{ .navigate = {} });
         const alloc = self.arena.allocator();
 
         log.debug("starting GET {s}", .{uri});

src/cdp/cdp.zig

@@ -21,8 +21,7 @@ const Allocator = std.mem.Allocator;
 const json = std.json;
 
 const dom = @import("dom.zig");
-const Loop = @import("jsruntime").Loop;
-// const Client = @import("../server.zig").Client;
+const App = @import("../app.zig").App;
 const asUint = @import("../str/parser.zig").asUint;
 
 const log = std.log.scoped(.cdp);
@@ -78,10 +77,11 @@ pub fn CDPT(comptime TypeProvider: type) type {
         pub const Browser = TypeProvider.Browser;
         pub const Session = TypeProvider.Session;
 
-        pub fn init(allocator: Allocator, client: *TypeProvider.Client, loop: anytype) Self {
+        pub fn init(app: *App, client: *TypeProvider.Client) Self {
+            const allocator = app.allocator;
             return .{
                 .client = client,
-                .browser = Browser.init(allocator, loop),
+                .browser = Browser.init(app),
                 .session = null,
                 .allocator = allocator,
                 .url = URL_BASE,

src/cdp/testing.zig

@@ -7,6 +7,7 @@ const Testing = @This();
 
 const cdp = @import("cdp.zig");
 const parser = @import("netsurf");
+const App = @import("../app.zig").App;
 
 pub const expectEqual = std.testing.expectEqual;
 pub const expectError = std.testing.expectError;
@@ -15,8 +16,8 @@ pub const expectString = std.testing.expectEqualStrings;
 const Browser = struct {
     session: ?Session = null,
 
-    pub fn init(_: Allocator, loop: anytype) Browser {
-        _ = loop;
+    pub fn init(app: *App) Browser {
+        _ = app;
         return .{};
     }
 
@@ -90,6 +91,7 @@ const TestCDP = cdp.CDPT(struct {
 });
 
 const TestContext = struct {
+    app: App,
     client: ?Client = null,
     cdp_: ?TestCDP = null,
     arena: std.heap.ArenaAllocator,
@@ -98,6 +100,7 @@ const TestContext = struct {
         if (self.cdp_) |*c| {
             c.deinit();
         }
+        self.app.deinit();
         self.arena.deinit();
     }
 
@@ -106,7 +109,7 @@ const TestContext = struct {
             self.client = Client.init(self.arena.allocator());
             // Don't use the arena here. We want to detect leaks in CDP.
             // The arena is only for test-specific stuff
-            self.cdp_ = TestCDP.init(std.testing.allocator, &self.client.?, "dummy-loop");
+            self.cdp_ = TestCDP.init(&self.app, &self.client.?);
         }
         return &self.cdp_.?;
     }
@@ -165,6 +168,7 @@ const TestContext = struct {
 
 pub fn context() TestContext {
     return .{
+        .app = App.init(std.testing.allocator) catch unreachable,
         .arena = std.heap.ArenaAllocator.init(std.testing.allocator),
     };
 }

src/main.zig

@@ -70,27 +70,20 @@ pub fn main() !void {
                 return args.printUsageAndExit(false);
             };
 
-            var loop = try jsruntime.Loop.init(alloc);
-            defer loop.deinit();
-
-            var app = try @import("app.zig").App.init(alloc, &loop);
+            var app = try @import("app.zig").App.init(alloc);
             defer app.deinit();
             app.telemetry.record(.{ .run = .{ .mode = .serve, .version = version } });
 
             const timeout = std.time.ns_per_s * @as(u64, opts.timeout);
-            server.run(alloc, address, timeout, &loop, &app) catch |err| {
+            server.run(&app, address, timeout) catch |err| {
                 log.err("Server error", .{});
                 return err;
             };
         },
         .fetch => |opts| {
             log.debug("Fetch mode: url {s}, dump {any}", .{ opts.url, opts.dump });
 
-            // loop
-            var loop = try jsruntime.Loop.init(alloc);
-            defer loop.deinit();
-
-            var app = try @import("app.zig").App.init(alloc, &loop);
+            var app = try @import("app.zig").App.init(alloc);
             defer app.deinit();
             app.telemetry.record(.{ .run = .{ .mode = .fetch, .version = version } });
 
@@ -99,7 +92,7 @@ pub fn main() !void {
             defer vm.deinit();
 
             // browser
-            var browser = Browser.init(alloc, &loop);
+            var browser = Browser.init(&app);
             defer browser.deinit();
 
             var session = try browser.newSession({});

src/server.zig

@@ -80,7 +80,6 @@ const Server = struct {
         self.send_pool.deinit();
         self.client_pool.deinit();
         self.completion_state_pool.deinit();
-        self.allocator.free(self.json_version_response);
     }
 
     fn queueAccept(self: *Server) void {
@@ -597,7 +596,7 @@ fn ClientT(comptime S: type, comptime C: type) type {
             };
 
             self.mode = .websocket;
-            self.cdp = C.init(self.server.allocator, self, self.server.loop);
+            self.cdp = C.init(self.server.app, self);
             return self.sendAlloc(arena, response);
         }
 
@@ -1026,11 +1025,9 @@ fn websocketHeader(buf: []u8, op_code: OpCode, payload_len: usize) []const u8 {
 }
 
 pub fn run(
-    allocator: Allocator,
+    app: *App,
     address: net.Address,
     timeout: u64,
-    loop: *jsruntime.Loop,
-    app: *App,
 ) !void {
     // create socket
     const flags = posix.SOCK.STREAM | posix.SOCK.CLOEXEC | posix.SOCK.NONBLOCK;
@@ -1053,14 +1050,17 @@ pub fn run(
     const vm = jsruntime.VM.init();
     defer vm.deinit();
 
+    var loop = app.loop;
+    const allocator = app.allocator;
     const json_version_response = try buildJSONVersionResponse(allocator, address);
+    defer allocator.free(json_version_response);
 
     var server = Server{
         .app = app,
         .loop = loop,
         .timeout = timeout,
         .listener = listener,
-        .allocator = allocator,
+        .allocator = app.allocator,
         .close_completion = undefined,
         .accept_completion = undefined,
         .json_version_response = json_version_response,
@@ -1739,7 +1739,7 @@ fn assertWebSocketMessage(
 }
 
 const MockServer = struct {
-    loop: *jsruntime.Loop = undefined,
+    app: *App = undefined,
     closed: bool = false,
 
     // record the messages we sent to the client
@@ -1782,8 +1782,8 @@ const MockCDP = struct {
 
     allocator: Allocator = testing.allocator,
 
-    fn init(_: Allocator, client: anytype, loop: *jsruntime.Loop) MockCDP {
-        _ = loop;
+    fn init(app: *App, client: anytype) MockCDP {
+        _ = app;
         _ = client;
         return .{};
     }

src/telemetry/lightpanda.zig

@@ -7,7 +7,7 @@ const Client = @import("asyncio").Client;
 
 const log = std.log.scoped(.telemetry);
 
-const URL = "https://stats.lightpanda.io";
+const URL = "https://httpbin.io/post";
 
 pub const LightPanda = struct {
     uri: std.Uri,

src/telemetry/telemetry.zig

@@ -10,7 +10,7 @@ const log = std.log.scoped(.telemetry);
 const ID_FILE = "lightpanda.id";
 
 pub const Telemetry = TelemetryT(blk: {
-    // if (builtin.mode == .Debug or builtin.is_test) break :blk NoopProvider;
+    if (builtin.mode == .Debug or builtin.is_test) break :blk NoopProvider;
     break :blk @import("lightpanda.zig").LightPanda;
 });