fix: add nakama-debug on docker-compose to fix debug mode #51

zulkhair · 2024-06-12T09:01:43Z

Adding nakama-debug on docker-compose.yml to fix running cardinal on debug mode --debug flag.

Previously cardinal-debug container need nakama but nakama depends-on cardinal not cardinal-debug so this results an error when running cardinal with debug mode.

**
Updated using two docker-compose file.
CLI will run with args -f docker-compose.yml -f docker-compose.debug.yml up in --debug mode and it will override the first docker-compose file with the second one.

Updated using short syntax with envar passed from world-cli

coderabbitai · 2024-06-12T09:01:49Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

zulkhair · 2024-06-12T09:01:57Z

fix: add nakama-debug on docker-compose to fix debug mode #51 👈
main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @zulkhair and the rest of your teammates on Graphite

rmrt1n

what if we use two docker compose files, e.g. docker-compose.dev.yaml and docker-compose.prod.yaml, instead of putting all containers here? The dev compose file contains the debug containers, and it'll be run only in dev or with the --debug world CLI flag.

smsunarto

Instead of adding nakama-debug, a trick here is to just pass in the depends_on container name using environment variable https://stackoverflow.com/questions/29377853/how-can-i-use-environment-variables-in-docker-compose

If the --debug flag in the CLI is used, inject an environment variable that would change the depended container name to cardinal-debug, otherwise it would use the default value cardinal

zulkhair · 2024-06-19T15:29:32Z

Instead of adding nakama-debug, a trick here is to just pass in the depends_on container name using environment variable https://stackoverflow.com/questions/29377853/how-can-i-use-environment-variables-in-docker-compose

If the --debug flag in the CLI is used, inject an environment variable that would change the depended container name to cardinal-debug, otherwise it would use the default value cardinal

Tried this but error.

validating /home/daim/Documents/Argus/repo/starter-game-template/docker-compose.yml: services.nakama.depends_on Additional property ${DOCKER_CARDINAL_SERVICE_NAME:-cardinal} is not allowed
Error: Encountered an error with Docker: exit status 15

I will try to find another solutions.

zulkhair · 2024-06-20T10:11:10Z

what if we use two docker compose files, e.g. docker-compose.dev.yaml and docker-compose.prod.yaml, instead of putting all containers here? The dev compose file contains the debug containers, and it'll be run only in dev or with the --debug world CLI flag.

Updated using two docker-compose file.
CLI will run with args -f docker-compose.yml -f docker-compose.debug.yml up in --debug mode and it will override the first docker-compose file with the second one.

smsunarto · 2024-06-20T17:38:41Z

The whole goal is to reduce the number of duplication. If you are creating a separate docker compose then you end up with even more duplication

rmrt1n · 2024-06-20T19:00:38Z

Updated using two docker-compose file. CLI will run with args -f docker-compose.yml -f docker-compose.debug.yml up in --debug mode and it will override the first docker-compose file with the second one.

this follows docker compose's extend rules. (summary of rules here).

it's a bit error-prone if you don't know how the override works on different options, but imo it's an ok approach to this, similar to a plugin system. you just include it for debug mode.

setting depends_on using env vars probably doesn't work with the long form, but it could in the short form. I couldn't get this to work tho 🤷.

probably we can try using compose profiles? run the debug containers when in the dev/debug profile, and the regular ones in prod profile. then we just have to change the commands in world-cli depending on the debug flag: docker compose --profile debug up.

smsunarto · 2024-06-20T19:14:24Z

You can do

    depends_on:
      - "${NAME_OF_ENV_VAR_GOES_HERE:-default-value-goes-here}"

Note the "" quotation marks around it

zulkhair · 2024-06-20T19:46:30Z

You can do
    depends_on:
      - "${NAME_OF_ENV_VAR_GOES_HERE:-default-value-goes-here}"
Note the "" quotation marks around it

Updated to short syntax, it works but need to remove the condition specifies that a dependency is expected to be "healthy" condition: service_healthy for nakama-db

smsunarto · 2024-06-20T23:22:10Z

You can overwrite the entrypoint/cmd in docker compose for the Nakama service to run the healthcheck from within the container.

Just make it run curl -s --fail --connect-timeout 1 --retry 10 <cockroachdb healthcheck API> && <original entrypoint commands>

CockroachdB healthcheck API: https://www.cockroachlabs.com/docs/api/cluster/v2.html#operation/health

with retries: https://stackoverflow.com/questions/42873285/curl-retry-mechanism

zulkhair · 2024-06-21T12:48:55Z

You can overwrite the entrypoint/cmd in docker compose for the Nakama service to run the healthcheck from within the container.

Just make it run curl -s --fail --connect-timeout 1 --retry 10 <cockroachdb healthcheck API> && <original entrypoint commands>

CockroachdB healthcheck API: https://www.cockroachlabs.com/docs/api/cluster/v2.html#operation/health

with retries: https://stackoverflow.com/questions/42873285/curl-retry-mechanism

After i'm testing it, i think we don't need to do health check for nakama-db, using sort syntax should be enough.

I tried to run docker compose without nakama-db, nakama will automatically retry to run migrate up from entrypoint for the db until success, so it can be used as healtcheck.

Closes: WORLD-1154 ## Overview Re enable debug mode with delve on `world cardinal start` with `--debug` flag ## Brief Changelog - Re activate `--debug` flag - Add `nakama-debug` container to fix nakama cannot run because `cardinal` is not running ## Testing and Verifying - Tested manually using `world cardinal start --debug` command and delve with vs code Notes : Unit test failed because Argus-Labs/starter-game-template#51 need to be merged first and create new tag

zulkhair requested review from heronimus, rmrt1n and smsunarto June 13, 2024 02:35

zulkhair marked this pull request as ready for review June 13, 2024 02:35

zulkhair mentioned this pull request Jun 13, 2024

fix: re enable debug mode Argus-Labs/world-cli#69

Merged

rmrt1n reviewed Jun 13, 2024

View reviewed changes

smsunarto requested changes Jun 14, 2024

View reviewed changes

zulkhair force-pushed the daim/add_nakama_debug branch from ba043c9 to 7682f27 Compare June 20, 2024 10:02

zulkhair requested review from rmrt1n and smsunarto June 20, 2024 10:13

add nakama-debug on docker-compose.yml to fix debug mode

82d82ed

zulkhair force-pushed the daim/add_nakama_debug branch from 7682f27 to 82d82ed Compare June 20, 2024 19:39

smsunarto approved these changes Jun 21, 2024

View reviewed changes

smsunarto merged commit 8440c5b into main Jun 21, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: add nakama-debug on docker-compose to fix debug mode #51

fix: add nakama-debug on docker-compose to fix debug mode #51

zulkhair commented Jun 12, 2024 •

edited

Loading

coderabbitai bot commented Jun 12, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

zulkhair commented Jun 12, 2024

rmrt1n left a comment

smsunarto left a comment

zulkhair commented Jun 19, 2024

zulkhair commented Jun 20, 2024

smsunarto commented Jun 20, 2024

rmrt1n commented Jun 20, 2024

smsunarto commented Jun 20, 2024 •

edited

Loading

zulkhair commented Jun 20, 2024

smsunarto commented Jun 20, 2024 •

edited

Loading

zulkhair commented Jun 21, 2024

fix: add nakama-debug on docker-compose to fix debug mode #51

fix: add nakama-debug on docker-compose to fix debug mode #51

Conversation

zulkhair commented Jun 12, 2024 • edited Loading

coderabbitai bot commented Jun 12, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

zulkhair commented Jun 12, 2024

rmrt1n left a comment

Choose a reason for hiding this comment

smsunarto left a comment

Choose a reason for hiding this comment

zulkhair commented Jun 19, 2024

zulkhair commented Jun 20, 2024

smsunarto commented Jun 20, 2024

rmrt1n commented Jun 20, 2024

smsunarto commented Jun 20, 2024 • edited Loading

zulkhair commented Jun 20, 2024

smsunarto commented Jun 20, 2024 • edited Loading

zulkhair commented Jun 21, 2024

zulkhair commented Jun 12, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

smsunarto commented Jun 20, 2024 •

edited

Loading

smsunarto commented Jun 20, 2024 •

edited

Loading