Migrate to Devcontainers POC

[anataliocs]

What

Migrated to Devcontainers!

I documented the changes in devcontainer.md and gave an intro to devcontainers in general.

So there are 2 main ways to engage with devcontainers:

1. Through a browser via the web VSCode interface of Codespaces
2. On your local VS Code using the Devcontainer as a backend dev env

In addition:

• You can stream logs remotely or tunnel into the devcontainer with SSH(Not turned on by default currently)
• Deep Github integration of course with copilot and access to workflows
• Devcontainers also is compatible with a multitude of other providers. I added links for 2.
• I also added instructions to launch codespaces with the Github CLI
• Guided walkthrough for lauching Codespaces from VS Code
• Walk through the Devcontainer, features, config and design choices

ADDED: Github Actions CI Pipeline Workflows

• Verify JSON Schema of Devcontainers config
• Unit test and lint bash config scripts
• Use Devcontainer CLI to build
• Make changes less brittle and detect breaking changes to config as early as possible

DX:

• Included a script to build locally and jumpstart the pre-builds and caching loop
• Stellar CLI with autocomplete, sccache, Rust and all the goodness and the make all script should be working
• Added some customization to the terminal and IDE to make it feel more like home. Injected a bit of shell history and some VSCode settings

Why

Gitpod EOL and devcontainers are way better

Known limitations

• Build is currently a little slow
• TODO(Future PR) caching, prebuilds and optimization
• make all fills up the 32GB disk so I may have to do some optimization there.
• NOTE(prebuilds): Manual prebuild cache images are compatible with Github Prebuilds. GH Prebuilds are superior but the manual prebuilds are usable locally and also help speed up the GH Prebuild process for codespaces.

HOW

Testing steps
https://codespaces.new/stellar/soroban-examples/tree/migrate-to-devcontainers-poc

Make sure branch migrate-to-devcontainers-poc is chosen

cd to desired contract -> make all(build -> test)

cd account
make all

Or:

stellar contract build --manifest-path $CODESPACE_VSCODE_FOLDER/alloc/Cargo.toml

Test cache:

sccache --show-stat

[leighmcculloch]

👏🏻 Few comments inline.

[leighmcculloch]

If you prefer to do it this way, I think it's reasonable to add the prebuilds in a follow up so that this can get merged and in use. Even if it's a bit slower to boot.

[anataliocs]

ADDED Devcontainer GH Actions

• validate-devcontainer-json.yml: Validates Devcontainer JSON Schema
• build-and-test-devcontainer.yml Validates bash scripts and tests build with devcontainer with CLI

Only runs on changes to /.devcontainer

[anataliocs]

  = note: /usr/bin/ld: final link failed: No space left on device
          collect2: error: ld returned 1 exit status

One issue I noticed is that make all fills up a 32GB disk so I may have to do some optimization there.

[anataliocs]

Based on the provided diff for the devcontainer.json file, here are a few observations and potential issues to consider:

Port Forwarding:

Ensure that port 8000 is necessary and correctly configured for the intended use within your devcontainer. Avoid conflicts with other services using the same port.
Environment Variables:

The environment variables STELLAR_RPC_URL and STELLAR_NETWORK_PASSPHRASE are defined correctly. Make sure these values are correct and secure.
Features Configuration:

The features common-utils:2.5.3 and rust:1.3.1 are defined and configured properly. Ensure that these versions are suitable for your project requirements.
Commands:

The postCreateCommand, postStartCommand, postAttachCommand, initializeCommand, onCreateCommand, and updateContentCommand fields are defined correctly. Ensure that the referenced scripts (.devcontainer/post_start_cli_autocomplete.sh and .devcontainer/post_attach_welcome_text.sh) exist and are executable.
Syntax:

The JSON syntax is correct, and trailing commas have been removed where necessary.
If you need further analysis or specific checks, please let me know!

Reviewed devcontainers setup with Copilot ✅

[anataliocs]

Tested:

cd account
make all
stellar contract build
ℹ️  CARGO_BUILD_RUSTFLAGS=--remap-path-prefix=/usr/local/cargo/registry/src= cargo rustc --manifest-path=Cargo.toml --crate-type=cdylib --target=wasm32-unknown-unknown --release

Output ✅

    Finished `test` profile [unoptimized + debuginfo] target(s) in 1m 28s
     Running unittests src/lib.rs (target/debug/deps/soroban_account_contract-af22d991a97b8bca)

running 1 test
test test::test_token_auth ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.09s