Sandcastle Reborn #12574

jjspace · 2025-04-18T15:37:11Z

Description

Starting work on rebuilding Sandcastle. Currently this branch has the scrapped together hackathon code. This branch and PR will act as a staging branch for the work involved in the whole process. See #12566 for more details

Added a new package packages/sandcastle to encapsulate the new Vite + React + Typescript project
Set up the Vite build to output into Apps/Sandcastle2 (temporary path)
- Running both the vite dev server and the static files from the normal CesiumJS dev server should behave the same. This requires a bit of extra config to make sure routes for assets and sample data line up. Should be working now but may require some finagling later if we change routes.

TODO:

Set up CI deployment

Issue number and link

Fixes #12566

Testing plan

From the top level

Run npm run build-sandcastle
Run npm start
Navigate to http://localhost:8080/Apps/Sandcastle2/index.html

From inside packages/sandcastle for direct development of sandcastle

Run npm run dev for the dev server build
Navigate to http://localhost:5173/

Author checklist

I have submitted a Contributor License Agreement
I have added my name to CONTRIBUTORS.md
I have updated CHANGES.md with a short summary of my change
I have added or updated unit tests to ensure consistent code coverage
I have updated the inline documentation, and included code examples where relevant
I have performed a self-review of my code

github-actions · 2025-04-18T15:37:37Z

Thank you for the pull request, @jjspace!

✅ We can confirm we have a CLA on file for you.

ggetz · 2025-04-24T20:54:28Z

Wahoo! @jjspace could you get this PR targeting to a feature branch for sandcastle v2? That way we can have smaller, iterative PRs as needed.

ggetz

Works great so far! I haven't reviewed any of the app code itself, since as I understand it is very much in flux. But I do have some thoughts on the overall configuration.

package.json

packages/sandcastle/public/Cesium.d.ts

packages/sandcastle/public/Sandcastle-client.js

gulpfile.js

packages/sandcastle/public/Sandcastle-header.js

packages/sandcastle/public/gallery/3D Models.html

packages/sandcastle/src/assets/react.svg

packages/sandcastle/src/gallery-index.ts

jjspace · 2025-04-24T21:22:38Z

could you get this PR targeting to a feature branch for sandcastle v2? That way we can have smaller, iterative PRs as needed.

@ggetz I was expecting this branch/PR to be that feature branch. I was thinking of developing directly here until the build system is mostly sorted then do smaller PRs into this branch for review as needed. Where you thinking differently?

ggetz · 2025-04-24T22:14:48Z

To keep things clean, let's target a new staging branch. That way we can merge this and keep the PR list tidy. Well... tidier.

jjspace · 2025-05-05T22:08:12Z

@ggetz CI is now working properly on this branch https://ci-builds.cesium.com/cesium/sandcastle-reborn/Apps/Sandcastle2/index.html

There may be some more things to clean up but I believe that everything with the builds is set up to work in whatever environment we put it in, CI being the hardest. Might be able to make it "nicer" but what's there should work so I think it's good enough for now. Please take a peek at the new vite configs specifically and make sure CI, local (through build-app then npm start) and dev (through run dev) all work.

jjspace · 2025-05-06T19:52:13Z

For testing I found it really helpful to mimic the way it's set up on the CI server to avoid having to push it up and wait for the actual CI deploy every change.

In whatever starting directory you want:

mkdir local-ci-test && cd local-ci-test
mkdir cesium && cd cesium
mkdir branch && cd branch
ln -s [path to cesium]/Apps
ln -s [path to cesium]/Build
ln -s [path to cesium]/Source
cd ../../
npx http-server --port 8081

Then navigate to http://localhost:8081/cesium/branch/Apps/Sandcastle2/

(a --base-dir setting has been added to http-server which would be super helpful here but it's not been released yet)

ggetz · 2025-05-07T15:48:22Z

Thanks or the updates @jjspace! I'll take a review pass on this shortly. I assume this PR is good to be marked "Ready for review"?

jjspace · 2025-05-08T15:34:16Z

@ggetz yes I think for now this is good to review, I can make further changes in subsequent PRs

ggetz

@jjspace Nice, this all looks like a solid base to build on top of. I have a few comments, but have indicated where I wouldn't expect some them to hold up this PR getting merged.

ggetz · 2025-05-09T14:53:42Z

.prettierignore

@@ -34,6 +35,9 @@ packages/widgets/Build/**
 packages/widgets/index.js
 packages/widgets/Source/ThirdParty/**

+packages/sandcastle/node_modules/**


Would a blanket **/node_modules/** rule work?

technically yes but I think we specifically want it to be obvious when dependencies are messed up and it creates a node_modules inside the other two packages since that's undesired.

ggetz · 2025-05-09T14:54:42Z

.prettierignore

@@ -34,6 +35,9 @@ packages/widgets/Build/**
 packages/widgets/index.js
 packages/widgets/Source/ThirdParty/**

+packages/sandcastle/node_modules/**
+Apps/Sandcastle2/**


Can we signal that this is built output by putting it in a Build folder?

Possibly but potentially not very easily given how files are accessed, specifically the sample data. I'd like to leave it here for now to mimic the existing sandcastle as much as possible.

ggetz · 2025-05-09T15:17:50Z

eslint.config.js

+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-refresh/only-export-components": [
+        "warn",


Should this be "warn" or "error"? Right now, warnings will not be indicating when running our eslint command.

Possibly. This was a direct copy out of the generated file from the vite setup just to make it work with the flat eslint config. I honestly didn't really look at what was set or not set yet, completely open to review if you want to take a stab at changing this and extracting like you mention in the other comment.

ggetz · 2025-05-09T17:05:11Z

eslint.config.js

+  ...[...tseslint.configs.recommended].map((config) => ({
+    // This is needed to restrict to a specific path unless using the tseslint.config function
+    // https://typescript-eslint.io/packages/typescript-eslint#config
+    ...config,
+    files: ["packages/sandcastle/**/*.{ts,tsx}"],
+  })),
+  {
+    // This config came from the vite project generation
+    files: ["packages/sandcastle/**/*.{ts,tsx}"],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+    },
+    plugins: {
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
+    },


I wonder... To help isolate things a bit more, can we defined the following config in a standalone file and just import it here? I may look into this a bit. No need to hold up the PR.

gulpfile.js

packages/sandcastle/README.md

ggetz · 2025-05-09T17:14:47Z

packages/sandcastle/vite.config.ci.ts

+export default defineConfig(() => {
+  const cesiumBaseUrl = `${process.env.BASE_URL}Build/CesiumUnminified`;
+
+  console.log("Building Sandcastle with base url:", cesiumBaseUrl);


Is this console.log left here intentionally?

I thought it was helpful to be able to see in the CI output if/when there are issues. Maybe not needed but also don't think it hurts?

jjspace · 2025-05-09T19:04:30Z

@ggetz ready again

ggetz · 2025-05-09T20:39:25Z

Awesome, thanks @jjspace!

jjspace added 5 commits April 15, 2025 16:59

create sandcastle package

eb55c7e

elevate eslint config, run prettier

793ba88

import hackathon code

8a73405

adjusting paths for built and local dev

c05ed50

readme and build commands

4a2082a

jjspace requested a review from ggetz April 18, 2025 15:37

fix ci

1d8cd04

jjspace marked this pull request as draft April 18, 2025 15:43

jjspace added 2 commits April 18, 2025 16:56

set up itwin-ui, fix types route

1522aa7

build for ci

f775608

ggetz reviewed Apr 24, 2025

View reviewed changes

Config setups, including CI

c3e3f11

remove extra files

db51183

This was referenced Apr 30, 2025

Rebuilding Sandcastle: Technical Implementation #12566

Open

Create @cesium/utils package #12581

Open

jjspace added 4 commits May 2, 2025 12:08

Merge remote-tracking branch 'origin/main' into sandcastle-reborn

414fc15

test html build

463c6b3

adjust paths

5c02885

adjust paths again

93955b7

jjspace changed the base branch from main to sandcastle-v2 May 2, 2025 16:18

jjspace added 6 commits May 2, 2025 16:41

switch to custom plugin and vite define

f714fa2

ci test

ebafd4d

remove static bucket.html

ab625d8

adjust configs slightly

f574e97

streamline vite config with custom plugin

fc38e02

fix types url

8fa32a4

nest bucket.html like in current sandcastle

2ac1ed3

jjspace mentioned this pull request May 7, 2025

Do not install playwright in CI #12607

Merged

6 tasks

jjspace marked this pull request as ready for review May 8, 2025 15:34

ggetz requested changes May 9, 2025

View reviewed changes

better workspace check

7ecb6f5

ggetz merged commit 0e3c658 into sandcastle-v2 May 9, 2025
9 checks passed

ggetz deleted the sandcastle-reborn branch May 9, 2025 20:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sandcastle Reborn #12574

Sandcastle Reborn #12574

jjspace commented Apr 18, 2025

github-actions bot commented Apr 18, 2025

ggetz commented Apr 24, 2025

ggetz left a comment

jjspace commented Apr 24, 2025

ggetz commented Apr 24, 2025

jjspace commented May 5, 2025

jjspace commented May 6, 2025

ggetz commented May 7, 2025

jjspace commented May 8, 2025

ggetz left a comment

ggetz May 9, 2025

jjspace May 9, 2025

ggetz May 9, 2025

jjspace May 9, 2025

ggetz May 9, 2025

jjspace May 9, 2025

ggetz May 9, 2025

ggetz May 9, 2025

jjspace May 9, 2025

jjspace commented May 9, 2025

ggetz commented May 9, 2025

Sandcastle Reborn #12574

Sandcastle Reborn #12574

Conversation

jjspace commented Apr 18, 2025

Description

Issue number and link

Testing plan

Author checklist

github-actions bot commented Apr 18, 2025

ggetz commented Apr 24, 2025

ggetz left a comment

Choose a reason for hiding this comment

jjspace commented Apr 24, 2025

ggetz commented Apr 24, 2025

jjspace commented May 5, 2025

jjspace commented May 6, 2025

ggetz commented May 7, 2025

jjspace commented May 8, 2025

ggetz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjspace commented May 9, 2025

ggetz commented May 9, 2025