Add Lab to quickstart #678

fnando · 2025-04-01T00:42:46Z

No description provided.

leighmcculloch · 2025-04-01T01:11:11Z

What's the impact on image size and container memory and cpu usage?

leighmcculloch

🎉🥳🎉🥳🎉🥳🎉🥳🎉🥳

leighmcculloch · 2025-04-01T01:12:39Z

start

@@ -26,6 +27,7 @@ export PGPORT=5432
 : "${ENABLE_LOGS:=false}"
 : "${ENABLE_CORE:=false}"
 : "${ENABLE_HORIZON:=false}"
+: "${ENABLE_LAB:=false}"


Can we remove the enable lab env and instead rely on the enable env var? The other ones for core and horizon are legacy.

Sorry, the env can stay, but can we hook it into the ENABLE car as well?

This comment was marked as resolved, but enabling lab was not hooked into the ENABLE variable.

To do that you need to add a block that looks something like this to where the blocks like that exist already in this file:

if [[ ",$ENABLE," = *",lab,"* ]]; then ENABLE_LAB=true fi

Hook lab into ENABLE env var and --enable option #699

Dockerfile

fnando · 2025-04-01T02:09:08Z

What's the impact on image size and container memory and cpu usage?

@leighmcculloch Unfortunately, is node.js tire fire all around.

$ du -hs /stellar/lab/node_modules/
786M	/stellar/lab/node_modules/

$ du -hs /stellar/lab/build/
314M	/stellar/lab/build/

As for memory and cpu, it should be fine.

$ ps auxwww | grep next
stellar      619  0.1  0.3 22331024 125484 pts/0 Sl   01:52   0:01 next-server (v14.2.26)

leighmcculloch · 2025-04-01T02:41:53Z

Oof. I think we should make changes to Lab if needed to make it generatable as a static website. An additional 1GB of image size is multiple times the current size of the image.

sagpatil · 2025-06-30T17:51:38Z

we do have AHA waiting on this for scaffold-stellar. I think we should get this merged in and unblock them. while we get an optimization to reduce the image size

Copilot

Pull Request Overview

This PR adds a new Lab component to the quickstart, enabling the Stellar Laboratory service to be built, deployed, and run alongside the existing services.

Introduces environment variables and startup configuration for the Lab service.
Adds a dedicated Dockerfile for the Lab image and updates the build, Makefile, and supervisor configurations accordingly.
Updates GitHub workflows to cache, build, and load the Lab image.

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
start	Added environment variable and service start block for Lab.
common/supervisor/etc/supervisord.conf.d/stellar-lab.conf	Created supervisor configuration for the Lab process.
common/nginx/etc/conf.d/lab.conf	Added NGINX proxy configuration for Lab.
Makefile	Added LAB_REF variable and build-deps target for Lab.
Dockerfile.lab	New Dockerfile for building the Lab image.
Dockerfile	Updated to include the Lab stage and copy Lab assets and binaries.
.github/workflows/*	Updated workflows to include build, cache, and loading steps for Lab.

Comments suppressed due to low confidence (3)

Makefile:81

[nitpick] Consider adding a comment to document the use of NEXT_PUBLIC_COMMIT_HASH in the Lab build target to assist future maintainers in understanding its purpose.

build-deps-lab:

.github/workflows/build.yml:324

The disk cleanup commands remove several system directories with sudo; please confirm these removals are safe within the CI environment and won’t affect subsequent steps.

        sudo rm -rf /usr/share/dotnet

Dockerfile:37

[nitpick] Ensure that the permissions and paths of the Node.js binaries being copied from the Lab stage match the expected environment requirements to avoid runtime issues.

COPY --from=lab /usr/local/bin/node \

Dockerfile.lab

leighmcculloch

@fnando Couple asks inline, can you follow up w ith?

leighmcculloch · 2025-07-09T04:09:34Z

Dockerfile.lab

+RUN git fetch origin ${NEXT_PUBLIC_COMMIT_HASH}
+RUN git checkout ${NEXT_PUBLIC_COMMIT_HASH}
+RUN rm -rf .git
+RUN yarn install


yarn install is not guaranteed to be reproducible. We need to add the --frozen-lockfile option to ensure it is. Can we do that here to make sure that we never build dependencies into the quickstart image that haven't been tested and run through the normal test processes of lab?

Ensure yarn install is reproducible #698

leighmcculloch · 2025-07-09T04:12:04Z

start

@@ -26,6 +27,7 @@ export PGPORT=5432
 : "${ENABLE_LOGS:=false}"
 : "${ENABLE_CORE:=false}"
 : "${ENABLE_HORIZON:=false}"
+: "${ENABLE_LAB:=false}"


This comment was marked as resolved, but enabling lab was not hooked into the ENABLE variable.

To do that you need to add a block that looks something like this to where the blocks like that exist already in this file:

if [[ ",$ENABLE," = *",lab,"* ]]; then ENABLE_LAB=true fi

github-project-automation bot added this to DevX Apr 1, 2025

github-project-automation bot moved this to Backlog (Not Ready) in DevX Apr 1, 2025

leighmcculloch reviewed Apr 1, 2025

View reviewed changes

fnando added 5 commits June 30, 2025 12:09

WIP

4ffb550

WIP

3190014

WIP

a4421b3

fc8c6bf

Change default lab ref.

428241f

fnando force-pushed the add-lab-to-quickstart branch from 616aae2 to 428241f Compare June 30, 2025 19:24

fnando added 4 commits June 30, 2025 12:59

Add build arg for lab.

421bff1

Add stellar-lab requirement.

9992a54

fix typo

6805693

add missing type

e9d2126

fnando force-pushed the add-lab-to-quickstart branch from c0fab9a to 8cede7f Compare June 30, 2025 20:27

use local dockerfile

a28757e

fnando force-pushed the add-lab-to-quickstart branch from 8cede7f to a28757e Compare June 30, 2025 20:29

fnando added 5 commits June 30, 2025 13:33

checkout repo

c50eff7

free up some disk space

99a1f27

cache stellar-lab

334d953

fix cache key

ae4f974

remove unnecessary docker pruning

8ac6ffe

sagpatil requested a review from Copilot June 30, 2025 22:29

fnando marked this pull request as ready for review June 30, 2025 22:29

Copilot AI reviewed Jun 30, 2025

View reviewed changes

Dockerfile.lab Show resolved Hide resolved

sagpatil self-requested a review June 30, 2025 22:30

fnando mentioned this pull request Jun 30, 2025

Optimize stellar lab so it doesn't increase the docker image size too much #695

Closed

fnando added 6 commits June 30, 2025 15:41

remove git dir

d5d6e24

Add switch to enable lab.

4760eb8

Fix switch and remove deprecated config.

44b2457

Use a different port, as 8002 is being used by friendbot.

4fd525e

Sort ports.

38be94c

e24b36b

fnando force-pushed the add-lab-to-quickstart branch from 2f9a208 to e24b36b Compare July 2, 2025 21:42

sagpatil approved these changes Jul 2, 2025

View reviewed changes

fnando added 2 commits July 2, 2025 15:52

Set env var.

6070c79

ae626b0

fnando merged commit 61c3965 into main Jul 3, 2025
367 of 371 checks passed

fnando deleted the add-lab-to-quickstart branch July 3, 2025 22:02

github-project-automation bot moved this from Backlog (Not Ready) to Done in DevX Jul 3, 2025

pselle mentioned this pull request Jul 7, 2025

Link to Lab from contracts explorer AhaLabs/scaffold-stellar-frontend#79

Open

leighmcculloch reviewed Jul 9, 2025

View reviewed changes

This was referenced Jul 9, 2025

Ensure yarn install is reproducible #698

Closed

Hook lab into ENABLE env var and --enable option #699

Closed

Add Lab to quickstart #678

Add Lab to quickstart #678

Uh oh!

Conversation

fnando commented Apr 1, 2025

Uh oh!

leighmcculloch commented Apr 1, 2025

Uh oh!

leighmcculloch left a comment

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fnando commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

leighmcculloch commented Apr 1, 2025

Uh oh!

sagpatil commented Jun 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

leighmcculloch left a comment

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

leighmcculloch Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fnando commented Apr 1, 2025 •

edited

Loading