Google Git
Sign in
fuchsia / fidlbolt / 2441d37331d6c76d3e9ed8f6dab4ba4d8d84f65b
commit2441d37331d6c76d3e9ed8f6dab4ba4d8d84f65b[log] [tgz]
authorMitchell Kember <mkember@google.com>Thu Mar 17 18:30:21 2022 +0000
committerMitchell Kember <mkember@google.com>Thu Mar 17 18:30:21 2022 +0000
treee0ce133e61d6c097529063cf6ee0604033c152a7
parenta5898e810b31872d6610d18057b5282937fc67d3 [diff]
Match zircon/vdso/zx/BUILD.gn logic

This CL restricts compilation of library zx to only include
zx_common.fidl and rights.fidl, matching zircon/vdso/zx/BUILD.gn.
Previously it globbed all *.fidl files, which is only used for the
fidlc -> kazoo flow, not the fidlc -> fidlgen flow. The latter started
breaking on the latest fidlgen deployment because fidlgen_cpp code was
not expecting to see JSON IR entries arising from including all the vdso
*.fidl files, e.g. the PacketUser union.

Test: manually tested the fxbug.dev/95560 repro
Fixed: 95560
Bug: 90838
Change-Id: Iaa668742ff381dde5c38787fc82b8ebfdd134f51
Reviewed-on: https://fuchsia-review.googlesource.com/c/fidlbolt/+/658466
Reviewed-by: Yifei Teng <yifeit@google.com>
1 file changed
tree: e0ce133e61d6c097529063cf6ee0604033c152a7
  1. backend/
  2. frontend/
  3. .gcloudignore ⇨ .dockerignore
  4. .dockerignore
  5. .gitignore
  6. AUTHORS
  7. CHANGELOG.md
  8. CONTRIBUTING.md
  9. Dockerfile
  10. LICENSE
  11. Makefile
  12. PATENTS
  13. prepare_deployment.sh
  14. README.md
  15. watch.sh
README.md

fidlbolt

fidlbolt is web app for exploring FIDL code and bytes, inspired by Matt Godbolt's Compiler Explorer.

Get started

To run a local fidlbolt server:

  1. Follow the Fuchsia: Get Started guide.
  2. Build FIDL tools: fx build host_x64/{fidlc,fidlgen_{llcpp,hlcpp,rust,go,dart}} zircon/tools.
  3. Ensure that you have Go and Node.js installed.
  4. Build and run with make run.
  5. View the app at 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.

Contributing

Backend

The backend is written in Go. It uses net/http to serve static files and handle POST requests.

Frontend

The frontend is written in Elm and TypeScript. It uses webpack for bundling.

To set up the frontend:

  1. Install Node.js and npm. On Debian-based systems, use sudo apt-get install npm.
  2. 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 mode
  • npm run watch: rebuild in development mode on every file change
  • npm run tc: typecheck TypeScript files
  • npm run lint: run eslint on TypeScript files
  • npm run fix: format and fix lint issues in TypeScript and Elm files
  • npm run build: build in production mode

The build commands read files in frontend/src/ and generate output in frontend/dist/.

Workflow

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.

Style

Before making a CL, always run make format.

Deployment

The project uses Docker for containerized deployment.

To build and run a new image locally:

  1. Install Docker. On Debian-based systems, use sudo apt-get install docker-ce.
  2. ./prepare_deployment.sh
  3. docker image build -t fidlbolt .
  4. docker container run --publish 8080:8080 --detach --name fb fidlbolt

You might need to use sudo with the Docker commands.