The Beam Playground is a web application to run Beam code snippets in a modern browser. This directory holds code to build, test, and deploy the frontend and backend services.
The following requirements are needed for development, testing, and deploying.
Google Cloud Shell already has most of the prerequisites installed. Only few tools need to be installed separately
git config --global --add safe.directory /google/flutter flutter doctor
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28 go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2 dart pub global activate protoc_plugin npm install -g @bufbuild/buf
echo "deb https://repo.scala-sbt.org/scalasbt/debian all main" | sudo tee /etc/apt/sources.list.d/sbt.list echo "deb https://repo.scala-sbt.org/scalasbt/debian /" | sudo tee /etc/apt/sources.list.d/sbt_old.list curl -sL "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x2EE0EA64E40A89B84B2DF73499E82A75642AC823" | sudo -H gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/scalasbt-release.gpg --import sudo chmod 644 /etc/apt/trusted.gpg.d/scalasbt-release.gpg sudo apt-get update sudo apt-get install sbt
cd beam ./gradlew playgroundPrecommit
cd beam ./gradlew playground:tasks
cd beam ./gradlew playground:generateProto
Start:
cd beam ./gradlew playground:backend:containers:router:dockerComposeLocalUp
Stop:
cd beam ./gradlew playground:backend:containers:router:dockerComposeLocalDown
/playground/frontend/playground_components/lib/src/constants/backend_urls.dart
to override backend URLs with yours found in /playground/docker-compose.local.yaml
.cd beam ./gradlew playground:dockerComposeLocalUp
cd beam ./gradlew playground:dockerComposeLocalDown
This way of running may not work in all environments because it is not maintained. It is used occasionally by the Frontend team to test complex tasks against a not-yet-deployed backend. The full start may take ~30 minutes and is demanding, so you should likely enable only one backend runner for the SDK you need.
If you do not need particular runners, comment out:
/playground/build.gradle.kts
in dockerComposeLocalUp
task./playground/docker-compose.local.yaml
.See also Backend Lookup in the Frontend.
Run the method to remove unused code snippets from the Cloud Datastore. Unused snippets are snippets that are out of date. If the last visited date property less or equals than the current date minus dayDiff parameter then a snippet is out of date
cd beam ./gradlew playground:backend:removeUnusedSnippet -DdayDiff={int} -DprojectId={string} -Dnamespace={datastore namespace}
Run the method to remove a specific code snippet from the Cloud Datastore.
cd beam ./gradlew playground:backend:removeSnippet -DsnippetId={string} -DprojectId={string} -Dnamespace={datastore namespace}
cd beam ./gradlew playground:backend:testWithoutCache
See terraform for details on how to build and deploy the application and its dependent infrastructure.
The following requirements are needed for deploying examples manually:
Example deployment scripts uses following environment variables:
usage: ci_cd.py [-h] --step {CI,CD} [--namespace NAMESPACE] --datastore-project DATASTORE_PROJECT --sdk {SDK_JAVA,SDK_GO,SDK_PYTHON,SDK_SCIO} --origin {PG_EXAMPLES,TB_EXAMPLES} --subdirs SUBDIRS [SUBDIRS ...] CI/CD Steps for Playground objects optional arguments: -h, --help show this help message and exit --step {CI,CD} CI step to verify all beam examples/tests/katas. CD step to save all beam examples/tests/katas and their outputs on the GCD --namespace NAMESPACE Datastore namespace to use when saving data (default: Playground) --datastore-project DATASTORE_PROJECT Datastore project to use when saving data --sdk {SDK_JAVA,SDK_GO,SDK_PYTHON,SDK_SCIO} Supported SDKs --origin {PG_EXAMPLES,TB_EXAMPLES} ORIGIN field of pg_examples/pg_snippets --subdirs SUBDIRS [SUBDIRS ...] limit sub directories to walk through, relative to BEAM_ROOT_DIR
Helper script to deploy examples for all supported sdk's:
cd playground/infrastructure export BEAM_ROOT_DIR="../../" export SDK_CONFIG="../../playground/sdks.yaml" export BEAM_EXAMPLE_CATEGORIES="../categories.yaml" export BEAM_USE_WEBGRPC=yes export BEAM_CONCURRENCY=4 export PLAYGROUND_DNS_NAME="your registered dns name for Playground" for sdk in go java python scio; do export SDK=$sdk && export SERVER_ADDRESS=https://${SDK}.$PLAYGROUND_DNS_NAME && python3 ci_cd.py --datastore-project $GOOGLE_CLOUD_PROJECT \ --step CD --sdk SDK_${SDK^^} \ --origin PG_EXAMPLES \ --subdirs ./learning/katas ./examples ./sdks done