commit | 6596a8096abd519c60901ae0ca09abd67078bd1d | [log] [tgz] |
---|---|---|
author | Mitchell Kember <mkember@google.com> | Wed Nov 16 23:29:12 2022 +0000 |
committer | Mitchell Kember <mkember@google.com> | Wed Nov 16 23:29:12 2022 +0000 |
tree | 5772821e8a0628acbde69d98a47914afa580009d | |
parent | 676bfc40652c9630f9ba6d5f949ed5c80ff05cf7 [diff] |
Fix caching This CL makes fidlbolt use cache-busting for bundle.js and style.cc, and no-cache (i.e. require revalidation of caches) for index.html. This should make deployments take effect immediately without requiring anyone to force refresh. Tested manually and confirmed the server issues 304 based on If-Modified-Since, and then 200 after modifying index.html. Also confirmed that changing js/css changes the hashes and they don't get served from cache in that case. Change-Id: Ib4f678e518f337b7d50a64ebc3e2dd234261c8df Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/761602 Reviewed-by: Yifei Teng <yifeit@google.com>
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_{cpp,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. 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.