Introduce Architectural Decision Records (ADR)

[annikaholmqvist94]

Changes

Closes #16

What's Added

ADR directory structure in /docs/adr/
README explaining ADR process for the team
TEMPLATE for writing future ADRs
ADR-001 documenting static file serving architecture

Why This Matters

ADRs help document architectural decisions so:

• Future team members understand the "why" behind choices
• Design discussions are preserved
• We avoid repeating past debates

Review Focus

1. ADR format - Does it work for our team?
2. ADR-001 content - Is the static file architecture clear?
3. Process - Any improvements to the ADR workflow?

Size

Small PR: 3 markdown files

Next Steps

After this merges, PR #2 will add the actual implementation
of the static file handler.

Summary by CodeRabbit

Release Notes

• New Features

  • Functional HTTP server with request parsing and response handling capabilities.
  • Docker containerization support for deployment.
  • GitHub Actions CI/CD pipeline for automated testing and image publishing.

• Documentation

  • Added architectural decision records documenting design decisions and guidance.

• Chores

  • Upgraded Java version and enhanced code quality tooling.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This PR establishes a complete Java HTTP server project by introducing build infrastructure (Maven wrapper, Dockerfile, CI/CD pipelines), architectural documentation framework (ADR README, template, and initial static file serving design), and core server components (socket handling, HTTP request parsing, response modeling, and logging utilities).

Changes

Cohort / File(s)	Summary
Project Configuration .editorconfig, .mvn/wrapper/maven-wrapper.properties	EditorConfig formatting standards and Maven wrapper configuration with version 3.3.4 and distribution settings.
Build & Packaging pom.xml, Dockerfile	Project coordinates updated (org.juv25d/JavaHttpServer), Java 25 toolchain, added spotless and pitest plugins, multi-stage Docker build for Java 21.
Maven Wrapper Scripts mvnw, mvnw.cmd	Unix/Linux and Windows shell scripts implementing Maven wrapper logic with download, SHA validation, and distribution extraction.
CI/CD Workflows .github/workflows/ci.yml, .github/workflows/docker-release.yml	GitHub Actions pipeline for testing and code style checks on push/PR; automated multi-architecture Docker image publishing on release events.
Architectural Documentation docs/adr/README.md, docs/adr/TEMPLATE.md, docs/adr/ADR-001-static-file-serving-architecture.md	ADR framework documentation, standard template, and initial decision record for static file serving architecture with security and MIME type handling.
HTTP Server Core Components src/main/java/org/juv25d/HttpRequest.java, src/main/java/org/juv25d/http/HttpResponse.java, src/main/java/org/juv25d/http/HttpResponseWriter.java	Immutable HTTP request/response data models with serialization utility for writing HTTP/1.1 formatted responses.
Request Parsing & Server src/main/java/org/juv25d/parser/HttpParser.java, src/main/java/org/juv25d/SocketServer.java	HTTP request parser extracting method, path, query, headers, and body; socket server accepting connections on port 3000 with virtual thread per client.
Utilities & Entry Point src/main/java/org/juv25d/App.java, src/main/java/org/juv25d/logging/ServerLogging.java	Application entry point invoking socket server; logging utility with configurable level from system properties/environment variables.
Test Files src/test/java/org/juv25d/AppIT.java, src/test/java/org/juv25d/AppTest.java, src/test/java/org/juv25d/http/HttpResponseWriterTest.java	Package namespace updates and new tests validating HTTP response serialization (200 OK and 404 Not Found scenarios).

Sequence Diagram

sequenceDiagram
    participant Client
    participant SocketServer
    participant HttpParser
    participant HttpResponseWriter
    participant App

    App->>SocketServer: createSocket()
    SocketServer->>SocketServer: listen on port 3000
    Client->>SocketServer: connect
    SocketServer->>HttpParser: parse(InputStream)
    HttpParser->>HttpParser: readLine() × n
    HttpParser->>HttpParser: extract method, path, version
    HttpParser->>HttpParser: parse headers & body
    HttpParser-->>SocketServer: HttpRequest
    SocketServer->>HttpResponseWriter: write(OutputStream, HttpResponse)
    HttpResponseWriter->>HttpResponseWriter: format status line
    HttpResponseWriter->>HttpResponseWriter: write headers
    HttpResponseWriter->>HttpResponseWriter: write body
    HttpResponseWriter-->>Client: HTTP/1.1 response

Loading

Estimated Code Review Effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly Related Issues

• Introduce Architectural Decision Records (ADR) project-webserver-juv25d#16: This PR directly fulfills the ADR system implementation by introducing docs/adr/README.md, TEMPLATE.md, and ADR-001-static-file-serving-architecture.md, establishing the architectural decision record framework and initial design documentation for the project.

Poem

🐰 A server springs to life, so grand!
With sockets, parsers, ready-made,
HTTP requests understand,
Through Docker's multi-stage cascade.
ADRs chart the path ahead—
Our Java server's birth is fed! 🚀

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}