Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow sharing traces via MAGIC_TRACE_SHARE_COMMAND #132

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow sharing traces via MAGIC_TRACE_SHARE_COMMAND #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/env_vars.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ open Async
a local copy of Perfetto if you don't want to copy trace files around. *)
let perfetto_ui_base_directory = Unix.getenv "MAGIC_TRACE_PERFETTO_DIR"

(* Points to a filesystem path that will be invoked with a trace filename to implement
[-share]. *)
let share_command_filename = Unix.getenv "MAGIC_TRACE_SHARE_COMMAND"

(* Turns on hidden command line options. These options are to help magic-trace developers debug
magic-trace, they're not generally useful. *)
let enable_debug_options = Option.is_some (Unix.getenv "MAGIC_TRACE_DEBUG")
1 change: 1 addition & 0 deletions src/env_vars.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ open! Core

val enable_debug_options : bool
val perfetto_ui_base_directory : string option
val share_command_filename : string option
78 changes: 53 additions & 25 deletions src/tracing_tool_output.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,21 @@ open! Core
open! Async

module Serve = struct
type enabled =
type t =
{ port : int
; perfetto_ui_base_directory : string
}

type t =
| Disabled
| Enabled of enabled

let param =
match Env_vars.perfetto_ui_base_directory with
| None -> Command.Param.return Disabled
| Some perfetto_ui_base_directory ->
let%map_open.Command port =
let default = 8080 in
flag
"serve"
(optional_with_default default int)
~doc:
[%string
"PORT Chooses the port that the local copy of Perfetto will be served on. \
(default: %{default#Int})"]
in
Enabled { port; perfetto_ui_base_directory }
let maybe_param =
Option.map Env_vars.perfetto_ui_base_directory ~f:(fun perfetto_ui_base_directory ->
let port = 8080 in
let%map_open.Command serve =
flag
"serve"
no_arg
~doc:[%string " Serves the magic-trace UI on port %{port#Int})"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra paren at the end

in
if serve then Some { port; perfetto_ui_base_directory } else None)
;;

let url t =
Expand Down Expand Up @@ -110,8 +101,35 @@ module Serve = struct
;;
end

module Share = struct
type t = { share_command_filename : string }

let maybe_param =
Option.map Env_vars.share_command_filename ~f:(fun share_command_filename ->
let%map_open.Command share = flag "share" no_arg ~doc:"Share trace." in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That help text could say more. If you don't want it to be too long, I'm happy with the docs just being magic-trace.org/w/share and then we explain how sharing works on the wiki somewhere.

Serve could arguably work the same way.

if share then Some { share_command_filename } else None)
;;

let share_trace_file { share_command_filename } ~store_path =
let%map.Deferred.Or_error output =
Process.run
~prog:share_command_filename
~args:[ Filename_unix.realpath store_path ]
()
in
Core.printf "%s%!" output
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't show output until the command ends, and it might also swallow stderr? I'd use the cruddy process APIs to transfer stdout/stderr of the subprocess to magic-trace's.

;;
end

module Display_mode = struct
type t =
| Serve of Serve.t
| Share of Share.t
| Disabled
end

type t =
{ serve : Serve.t
{ display_mode : Display_mode.t
; store_path : string
}

Expand All @@ -121,9 +139,18 @@ let param =
flag
"output"
(optional_with_default default string)
~aliases:[ "o" ]
~doc:[%string "FILE Where to output the trace. (default: '%{default}')"]
and serve = Serve.param in
{ serve; store_path }
and display_mode =
[ Serve.maybe_param
|> Option.map ~f:(map ~f:(Option.map ~f:(fun serve -> Display_mode.Serve serve)))
; Share.maybe_param
|> Option.map ~f:(map ~f:(Option.map ~f:(fun share -> Display_mode.Share share)))
]
|> List.filter_opt
|> choose_one ~if_nothing_chosen:(Default_to Display_mode.Disabled)
in
{ display_mode; store_path }
;;

let notify_trace ~store_path =
Expand All @@ -132,9 +159,10 @@ let notify_trace ~store_path =
;;

let maybe_serve t ~filename =
match t.serve with
match t.display_mode with
| Disabled -> notify_trace ~store_path:t.store_path
| Enabled serve -> Serve.serve_trace_file serve ~filename ~store_path:t.store_path
| Serve serve -> Serve.serve_trace_file serve ~filename ~store_path:t.store_path
| Share share -> Share.share_trace_file share ~store_path:t.store_path
;;

let maybe_stash_old_trace ~filename =
Expand Down