초기 Design Doc 작성

[jungeunyooon]

Summary by CodeRabbit

• Documentation
  • Replaced the README with a comprehensive design document for a fast redirect URL shortener, covering architecture, APIs, storage, caching strategies, rollout, metrics/SLOs, risks, and references.
  • Added local development setup instructions using Docker Compose, including prerequisites, services (PostgreSQL, Redis), run commands, connection details, and a sample application configuration.
• Chores
  • Removed outdated demo/test code and insecure examples to streamline the repository and reduce noise.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Replaces README with a detailed design document and local dev setup for a redirect URL shortener. Removes two example files: a Java class (TestJavaClass.java) and a JavaScript script (test_script.js), eliminating their public entities and executable code.

Changes

Cohort / File(s)	Summary
Design doc and local dev setup README.md	Rewrote README into a multi-section design doc; added Docker Compose local setup instructions (PostgreSQL 16, Redis 7), configuration examples, operational notes, rollout plan, SLOs, risks, and references; elaborated caching layers, TTLs, upsert, invalidation, and pre-warming.
Removal of insecure Java examples TestJavaClass.java	Deleted file removing public class TestJavaClass and nested public static class BadInnerClass; eliminated insecure patterns (hard-coded secrets, injections, poor resource handling) and main entry.
Removal of insecure JS examples test_script.js	Deleted file removing globals, hard-coded secrets, vulnerable functions (XSS, eval, SQL-like), inefficient code, a poorly designed class, and DOMContentLoaded wiring.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Edge as Edge Cache/CDN
  participant Origin as Origin Cache (Redis/Memcached)
  participant DB as RDBMS

  rect rgba(220,240,255,0.3)
  Note over User,DB: Read path (redirect resolution)
  User->>Edge: GET /{code}
  alt Hit
    Edge-->>User: 301/302 with target URL
  else Miss
    Edge->>Origin: GET code
    alt Hit
      Origin-->>Edge: target URL
      Edge-->>User: 301/302 with target URL
    else Miss
      Origin->>DB: SELECT target FROM urls WHERE code=?
      DB-->>Origin: target or not found
      Origin->>Origin: Set cache with TTL
      Origin-->>Edge: target or 404
      Edge-->>User: 301/302 or 404
    end
  end
  end

  rect rgba(220,255,220,0.3)
  Note over User,DB: Write/Upsert (simplified)
  User->>DB: INSERT ... ON CONFLICT UPDATE
  DB-->>User: ack
  DB-->>Origin: (via app) Invalidate/Purge code
  Origin-->>Edge: (optional) Purge/Refresh key
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

• 초기 설계 문서 작성 #4 — Introduces the comprehensive design doc in README aligned with the issue’s objective.

Possibly related PRs

• CI test #3 — Previously added TestJavaClass.java; this PR removes that same file and its public types.

Poem

In burrows of bytes I twitch with delight,
Caches at dawn, redirects in flight.
Postgres thumps, Redis goes beep,
Short codes scamper, secrets asleep.
With docs refreshed and cruft set free—
Hippity-hop, ship it with glee! 🥕🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a35a5e2 and 7dccf52.

📒 Files selected for processing (3)

• README.md (1 hunks)
• TestJavaClass.java (0 hunks)
• test_script.js (0 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/#4

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

현재 제출된 파일 내용에서는 코드 품질, 보안, 성능 관점에서 특별히 언급하거나 수정/개선이 필요하다고 판단되는 변경 사항을 찾지 못했습니다. 전반적으로 현재 상태는 양호하여 추가적인 코멘트가 필요하지 않습니다.

</details>