Add dev container configuration for GitHub Codespaces (#4193)

Author: unpervertedkid

.devcontainer/devcontainer.json

@@ -0,0 +1,42 @@
+{
+    "name": "Quickwit",
+    "image": "mcr.microsoft.com/devcontainers/rust:latest",
+    "customizations": {
+        "codespaces": {
+            "openFiles": [
+                "CONTRIBUTING.md"
+            ]
+        },
+        "vscode": {
+            "extensions": [
+                "rust-lang.rust-analyzer"
+            ]
+        }
+    },
+    "hostRequirements": {
+        "cpus": 4,
+        "memory": "16gb"
+    },
+    "runArgs": [
+        "--init"
+    ],
+    "mounts": [
+        {
+            "source": "/var/run/docker.sock",
+            "target": "/var/run/docker.sock",
+            "type": "bind"
+        }
+    ],
+    "features": {
+        "docker-from-docker": {
+            "version": "latest",
+            "moby": true
+        },
+        "ghcr.io/devcontainers/features/node:1": {
+            "version": "18"
+        },
+        "ghcr.io/devcontainers/features/aws-cli:1": {},
+        "ghcr.io/devcontainers-contrib/features/protoc:1": {}
+    },
+    "postCreateCommand": ".devcontainer/post-create.sh"
+}

.devcontainer/post-create.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+# Define success and error color codes
+SUCCESS_COLOR="\e[32m"
+ERROR_COLOR="\e[31m"
+RESET_COLOR="\e[0m"
+
+# Define success tracking variables
+rustupToolchainNightlyInstalled=false
+cmakeInstalled=false
+
+
+# Define installation functions
+
+#Installing manually for now until we figure out why "ghcr.io/devcontainers-community/features/cmake": {} is not working
+install_cmake() {
+    echo -e "Installing CMake..."
+    sudo apt-get update
+    sudo apt-get install -y cmake > /dev/null 2>&1
+    if [[ "$(cmake --version)" =~ "cmake version" ]]; then
+        echo -e "${SUCCESS_COLOR}CMake installed successfully.${RESET_COLOR}"
+        cmakeInstalled=true
+    else
+        echo -e "${ERROR_COLOR}CMake installation failed. Please install it manually.${RESET_COLOR}"
+    fi
+}
+
+install_rustup_toolchain_nightly() {
+    echo -e "Installing Rustup nightly toolchain..."
+    rustup toolchain install nightly > /dev/null 2>&1
+    rustup component add rustfmt --toolchain nightly > /dev/null 2>&1
+    if [[ "$(rustup toolchain list)" =~ "nightly" && "$(rustup component list --toolchain nightly | grep rustfmt)" =~ "installed" ]]; then
+        echo -e "${SUCCESS_COLOR}Rustup nightly toolchain and rustfmt installed successfully.${RESET_COLOR}"
+        rustupToolchainNightlyInstalled=true
+    else
+        echo -e "${ERROR_COLOR}Rustup nightly toolchain and/or rustfmt installation failed. Please install them manually.${RESET_COLOR}"
+    fi
+}
+
+# Install tools
+install_cmake
+install_rustup_toolchain_nightly
+
+# Copy our custom welcome message to replace the default github welcome message
+sudo cp .devcontainer/welcome.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt
+
+
+# Check the success tracking variables
+if $rustupToolchainNightlyInstalled && $cmakeInstalled; then
+    echo -e "${SUCCESS_COLOR}All tools installed successfully.${RESET_COLOR}"
+else
+    echo -e "${ERROR_COLOR}One or more tools failed to install. Please check the output for errors and install the failed tools manually.${RESET_COLOR}"
+fi

.devcontainer/welcome.txt

@@ -0,0 +1,16 @@
+👋 Welcome to the project!
+All the necessary tools have already been installed for you 🎉. 
+You can go ahead and start hacking! Happy coding💻.
+
+ Here are some useful commands you can run:
+
+🔧 `make test-all` - starts necessary Docker services and runs all tests.
+🔧 `make -k test-all docker-compose-down` - the same as above, but tears down the Docker services after running all the tests.
+🔧 `make fmt` - runs formatter, this command requires the nightly toolchain to be installed by running `rustup toolchain install nightly`.
+🔧 `make fix` - runs formatter and clippy checks.
+🔧 `make typos` - runs the spellcheck tool over the codebase. (Install by running `cargo install typos`)
+🔧 `make build-docs` - builds docs.
+🔧 `make docker-compose-up` - starts Docker services.
+🔧 `make docker-compose-down` - stops Docker services.
+🔧 `make docker-compose-logs` - shows Docker logs.
+