feat: Improved support for debugging Cardinal test app under GoLand

[ezavada]

• Added 3 new GoLand runtime configurations in .run directory
• Added README-devs.md with info on using those configs to run tests and to debug cardinal apps.

Summary by CodeRabbit

• New Features

  • Introduced a new game-debug service for enhanced debugging and telemetry support.
  • Added a comprehensive overview for developers in README-devs.md.

• Documentation

  • Updated README.md to include a new section on World Engine Development, linking to README-devs.md.
  • Enhanced DEVELOPMENT.md with a detailed overview and guidance for developers.

• Configuration Changes

  • Simplified dependency management in docker-compose.yml.
  • Updated environment variables for the nakama service for improved configuration.
  • Added a new build stage for debugging in the game Dockerfile.

[graphite-app[bot]]

Your org has enabled the Graphite merge queue for merging into main

Add the label “graphite/merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[coderabbitai[bot]]

Walkthrough

The changes encompass updates to documentation and configuration files for the World Engine SDK. The README-devs.md is enhanced with detailed development instructions, while README.md now references this new document. The docker-compose.yml file has been modified to improve service dependencies and introduce a new debugging service. Additionally, Dockerfiles for end-to-end tests now support a debug runtime environment and ensure necessary files are included for testing.

Changes

File(s)	Change Summary
README-devs.md	Added comprehensive overview of the World Engine SDK, including structure, tools, and testing instructions.
README.md	New section "World Engine Development" added, linking to README-devs.md and DEVELOPMENT.md.
DEVELOPMENT.md	Comprehensive overview added, including development tools and instructions for running tests.
docker-compose.yml	Updated nakama service depends_on to list format; modified CARDINAL_ADDR to use CARDINAL_SERVICE; added game-debug service for debugging; adjusted game service build target to runtime.
e2e/testgames/game/Dockerfile	Added a new build stage for a debug runtime environment with Delve debugger and debugging symbols.
e2e/tests/nakama/Dockerfile	Added COPY command to include the cardinal directory in the Docker image.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant README
    participant DockerCompose
    participant GameService
    participant NakamaService
    participant DebugService

    Developer->>README: Access development instructions
    README->>Developer: Provides link to README-devs.md
    Developer->>DockerCompose: Modify service configurations
    DockerCompose->>NakamaService: Update dependencies
    DockerCompose->>GameService: Set build target to runtime
    DockerCompose->>DebugService: Introduce game-debug service for telemetry

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between f12579848a8bac71a60265fea7fd14adacbee587 and c7b233b62bd0af6697f7d4574a1e24c8ccef75da.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

README.md (2)

54-55: LGTM: New section for development information

The addition of the "World Engine Development" section is a good improvement to the README. It provides a clear separation for development-related information, which aligns well with the PR objectives.

---

56-56: LGTM: Informative link to development documentation

The addition of the link to DEVELOPMENT.md with a brief description is excellent. It provides easy access to more detailed development information and clearly states what developers can expect to find in the document.

However, there's a discrepancy between the file name mentioned in the PR objectives (README-devs.md) and the one used in the link (DEVELOPMENT.md).

Please verify that DEVELOPMENT.md is the correct file name. If not, update the link accordingly. You can use the following command to check for the existence of both files:

✅ Verification successful

LGTM: Correct link to DEVELOPMENT.md

The link to DEVELOPMENT.md is valid and points to an existing file, ensuring developers have access to detailed development instructions.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for the existence of DEVELOPMENT.md and README-devs.md
ls DEVELOPMENT.md README-devs.md 2>/dev/null || echo "One or both files not found"

Length of output: 114

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai 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

Documentation and Community

• 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.

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 59.51%. Comparing base (fba71f2) to head (1567efd). Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #800      +/-   ##
==========================================
- Coverage   59.61%   59.51%   -0.10%     
==========================================
  Files         144      144              
  Lines        7440     7440              
==========================================
- Hits         4435     4428       -7     
- Misses       2554     2557       +3     
- Partials      451      455       +4     

see 1 file with indirect coverage changes