Javabuilder build-and-run package

This portion of Javabuilder contains the code that compiles and runs student code as well as the code for the org.code Java packages that are used in the Java Lab mini apps.

Directory

• lib contains the "backend" code that compiles, builds, and runs student code. This is not user-facing. It also handles the WebSocket layer that communicates between the client and the running program. Also contained here are implementations of the communication protocol and program initialization that are specific to local development and AWS development. Local implementations are in the dev.javabuilder package while AWS implementations are in the main org.code.javabuilder package and are prefixed with AWS or Lambda
• media contains a package that can be imported by the user to edit sounds, colors, fonts, and images.
• neighborhood contains a package that can be imported by the user to interact with the neighborhood mini-app, a maze-like app created for AP CSA.
• protocol contains the communication protocol that handles messages between Java Lab (client) and Javabuilder (server)
• theater contains a package that can be imported by the user to interact with the theater mini-app, an image and sound editing app created for AP CSA and used in standalone Java Lab projects.
• studentlib houses all external dependencies required to run and compile student code that are not already included by other mini-app packages.
• lang is used for code.org-specific implementations of java.lang classes, to be used in user project code.

Local Development

Setup your project

1. Install a Java IDE - We recommend IntelliJ Community edition.
   1. If given the option when installing, select Java 11 as the default
2. If Java 11 was not installed as part of the IDE, install OpenJDK 11
3. Download the repo and build. Building is a one-time step that seeds the git commit hooks.

git clone git@github.com:code-dot-org/javabuilder.git
cd javabuilder/org-code-javabuilder
./gradlew build

That's it! Now you can open the project in your IDE and start developing. If you are using IntelliJ, import the project as a gradle project: File -> New -> Project from Existing Sources...

It is not required, but you can also install gradle. If you do, you can use gradle directly rather than from the gradlew file. Instead of running ./gradlew build, for example, you would run gradle build.

Here are some other useful commands:

Launch the local Javabuilder WebSocket server

./gradlew appRun

Note: the Javabuilder server will be ready to use after a few seconds when you see Press any key to stop the server. It will never reach 100% EXECUTING.

Run all tests

./gradlew test

Run the linter and fix lint errors

./gradlew goJF

Developing with Dashboard (most common scenario)

In order to run Java Lab (Code Studio client) with Javabuilder, use the WebSocketServer. This is a local replacement of AWS API Gateway.

Instructions

1. Launch the WebSocketServer using the instructions above. (run ./gradlew appRun)
2. Launch dashboard using the instructions here: https://github.com/code-dot-org/code-dot-org/blob/staging/SETUP.md#overview
3. Navigate to any Java Lab level, for example: http://localhost-studio.code.org:3000/projects/javalab/new
4. Click the "Run" button

Alternatively, you can test in "headless" mode

1. Install wscat: npm install -g wscat
2. Launch the WebSocketServer: ./gradlew appRun
3. In a terminal, connect to the server with wscat: wscat -c ws://localhost:8080/javabuilder

Postman is a good wscat alternative. It is in beta, but has a gui and is more feature-rich.

Note: non-Java files used or created by the program (for example grid.txt in the Neighborhood) will be added to the root of the repo. In production, the runtime directory is changed to the tmp directory, so cleanup of these files is not necessary there.