| commit | 23c3704553a111673b2b34e8fa8790ff27b61230 | [log] [tgz] |
|---|---|---|
| author | Mitchell Kember <mkember@google.com> | Wed Apr 15 18:18:46 2020 -0700 |
| committer | Mitchell Kember <mkember@google.com> | Wed Apr 15 22:34:21 2020 -0700 |
| tree | 37f0bdb81f48b6e59123fbbf4b944b6d2ef85087 | |
| parent | f9f5c3a5564d89c9dbab2ddd1e1c5b2726775d64 [diff] |
Display deployment information dynamically This CL introduces the concept of a "fidlbolt deployment" as a set of git hashes and version strings that identify all source code responsible for processing a fidlbolt request. Currently, this information includes hashes for fidlbolt, fuchsia, and topaz, and a version for rustfmt. The script copy_support_files.sh now writes fidlbolt_deployment.json. The server passes this information with every response, and the frontend uses it to show links and timestamps at the bottom of the Help window. It is sent with every response rather than just queried once because there is no reason to assume users will refresh soon after a deployment. This CL also renames the fuchsia/ directory to support/ (and similarly copy_fuchsia_files.sh to copy_support_files.sh) since this directory is more general with the inclusion of fidlbolt_deployment.json and rustfmt. Other small changes: * Add CSS styling for links. * Use FORCE_COLOR in watch.sh to get npm color output. * Link to Monorail for bug reports instead of my email. Change-Id: I5af577522c6b5ef04119913b2781bd7963edfc17
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 ./copy_support_files.sh and use make run SUPPORT=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 nodejs.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../copy_support_files.sh to get the latest FIDL files and binaries from your Fuchsia repository.docker image build -t fidlbolt .docker container run --publish 8080:8080 --detach --name fb fidlboltYou might need to use sudo with the Docker commands.