How swiftfiddle/swiftfiddle-web works
Project Type & Purpose
• Full-stack web application (an online Swift playground).
• Frontend: static assets built with Webpack, served under Public/.
• Backend: Swift (Vapor-style) HTTP server under Sources/App.
• Persistence: Firestore (via Google Cloud) + GitHub Gist integration.
• CI/CD: GitHub Actions + Docker.
File Structure
Top-level:
• Public/ — HTML/CSS/JS assets, embedded playground code (client).
• Sources/App/ — Swift server: configure.swift, routes.swift, entrypoint.swift.
– Controllers (API handlers for compilation, sharing, fetching, etc.)
– Middlewares (error handling, headers)
– Models (request/response DTOs)
• webpack.*.js — build pipelines for dev/prod.
• Dockerfile, .github/workflows — containerization & CI/CD.
• Dependencies: Package.swift (SwiftPM), package.json (npm).
README for Insights
• Purpose: share/embed/run Swift code in browser.
• Tech stack: Swift 5.9, macOS/Linux, MIT licensed.
• Related: external SwiftLSP service for code-completion.
Main Components & Interactions
a. Frontend (Browser)
– UI: editor, buttons, version picker (Public/js/*.js).
– Runner: Web Worker (Public/js/worker.js) compiles & executes in-browser or requests server.
– LSP client: Public/js/language_server.js connects to language-server endpoint.
– Embedded view: Public/embedded.html/embedded.js for iframes.
b. Backend Server (Vapor-style)
– HTTP API endpoints (Sources/App/Controllers/*).
– Routes configured in routes.swift.
– Middlewares for error & custom headers.
– Services:
• Firestore (Controllers/Firestore.swift) for persistence.
• GitHub Gist API (Controllers/Gist.swift).
• SharedImage generation (Controllers/ShareImage.swift).
• SharedLink handling (Controllers/SharedLink.swift).
• SwiftPackage info (Controllers/SwiftPackage.swift).
c. Data Stores & External Services
– Firestore (Google Cloud)
– GitHub API
– Optional: Language server (external SwiftFiddle-LSP or SourceKit-LSP).
d. CI/CD & Deployment
– Dockerized server + Nginx (implied)
– GitHub Actions build/test/deploy pipelines.
Architectural Patterns & Principles
• MVC-style controllers + models on server.
• Middleware pipeline for cross-cutting concerns.
• SPA front-end served as static assets.
• Build separation: Webpack for JS/CSS, SwiftPM for server code.
• Externalized configuration (swiftpm, package.json, webpack configs).
• Browser (Client)
• Web Server (SwiftFiddle Backend)
• Database & External Services
• CI/CD Pipeline
– Static Assets (HTML/CSS/JS)
– Web Worker (code execution)
– LSP Client
– HTTP API Layer (routes + controllers)
– Middlewares
– Models
– Business Logic (share, gist, compile package)
– Firestore
– GitHub Gist API
– (Optionally) Language Server
– GitHub Actions workflows
– Docker build & deploy
Final Checklist
– All components from Public/, Sources/App/, external services represented.
– Build & deployment pipeline nodes.
– Clear annotations of frameworks: Webpack, SwiftPM (Vapor), Firestore SDK, GitHub API.