commit | 71932baccf3ba62aaba9608741adbe50fe2729df | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Thu Sep 10 16:10:42 2020 -0700 |
committer | Mitchell Kember <mkember@google.com> | Fri Sep 11 10:40:56 2020 -0700 |
tree | 115709507792cc0158af66d560e8f7067585765b | |
parent | 56ff29434ff7a67767efe86e47b6499206b18098 [diff] |
Only expose program failures for exit status 1 This CL changes the program.run function to return `(response, error)` instead of just `response`. Previously, all failures would be rolled into an `Ok: false` response and shown to the user. Now, it only does so for exit status 1, and otherwise returns an error which bubbles up to a 500 Internal Server Error, with the `error` object logged on the server. Rationale: we want to show legitimate failures to the user (e.g. fidlc will fail if its input has a syntax error), but we do *not* want to expose information the OS prints when programs crash. We use the exit status as a proxy for this. For example, a segfault should cause the program to exit with status 139, not 1. This also makes program.run return stdout in the success case and stderr in the failure (exit status 1) case, rather than always combining them as before. This is a further measure to avoid leaking details that should not be shown to the user. It also allows the logged message for exit statuses besides 0 and 1 to show stdout/stderr separately. Change-Id: I19173e66d37ead6989a7b45ab699976547f97267
fidlbolt is web app for exploring FIDL code and bytes, inspired by Matt Godbolt's Compiler Explorer.
To run a local fidlbolt server:
fx build host_x64/{fidlc,fidlgen_{llcpp,hlcpp,rust,go,dart}} zircon/tools
.make run
.http://localhost:8080
.If you don't want changes in the Fuchsia tree (e.g. rebuilding fidlc or changing FIDL libraries) to affect the running fidlbolt, run ./prepare_deployment.sh
and use make run DEPLOYMENT=1
instead.
The backend is written in Go 1.13. It uses net/http to serve static files and handle POST requests.
The frontend is written in Elm and TypeScript. It uses webpack for bundling.
To set up the frontend:
sudo apt-get install npm
.cd frontend && npm ci
(using ci
instead of install
ensures a repeatable build).Then, use one of the commands listed in npm run
:
npm run dev
: build in development modenpm run watch
: rebuild in development mode on every file changenpm run tc
: typecheck TypeScript filesnpm run lint
: run eslint on TypeScript filesnpm run fix
: format and fix lint issues in TypeScript and Elm filesnpm run build
: build in production modeThe build commands read files in frontend/src/
and generate output in frontend/dist/
.
If you are developing on Linux, ./watch.sh
provides an easy workflow. It automatically watches code in the frontend (using npm run watch
) and backend (using inotifywait), rebuilding and restarting the server as necessary. It does not perform hot/live reloading: you still need to refresh the browser manually to see changes.
Before making a CL, always run make format
.
The project uses Docker for containerized deployment.
To build and run a new image locally:
sudo apt-get install docker-ce
../prepare_deployment.sh
docker image build -t fidlbolt .
docker container run --publish 8080:8080 --detach --name fb fidlbolt
You might need to use sudo
with the Docker commands.