Skip to content

Set reasonable default that will help with filling in repo form for core t… #1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
May 5, 2025
Merged

Set reasonable default that will help with filling in repo form for core t… #1400

merged 4 commits into from
May 5, 2025

Conversation

JoshuaSBrown
Copy link
Collaborator

@JoshuaSBrown JoshuaSBrown commented Apr 30, 2025 •
edited
Loading

PR Description

This PR helps mitigate problems with core and repo communication. The REPO_DOMAIN is used to create the repo form to register a repo with the core service. The default localhost that was being used causes problems in a compose environment because the core server is unable to properly resolve it. This PR sets a reasonable default and leaves it blank if localhost is specified.

Tasks

  • - A description of the PR has been provided, and a diagram included if it is a new feature.
  • - Formatter has been run
  • - CHANGELOG comment has been added
  • - Labels have been assigned to the pr
  • - A reviwer has been added
  • - A user has been assigned to work on the pr
  • - If new feature a unit test has been added

Summary by Sourcery

Improve handling of repository domain configuration in compose environment to resolve communication issues between core and repo services

Bug Fixes:

  • Prevent communication problems when using localhost as the default domain

Enhancements:

  • Modify repo domain configuration to handle localhost more gracefully
  • Add network configuration for core service in compose setup

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Apr 30, 2025 •
edited
Loading

Reviewer's Guide

This pull request updates the compose environment setup to improve communication between the core and repo services. It modifies a shell script to conditionally set the DATAFED_COMPOSE_REPO_DOMAIN variable, leaving it empty if the base domain is localhost to avoid resolution issues. Additionally, it adds the repo service to the datafed-internal network in the main compose file.

File-Level Changes

Change Details Files
Modify default REPO_DOMAIN logic for compose environment
  • Check if DATAFED_COMPOSE_DOMAIN is localhost.
  • Set DATAFED_COMPOSE_REPO_DOMAIN to an empty string if the domain is localhost, otherwise set it to the DATAFED_COMPOSE_DOMAIN value.
  • Update comments explaining the logic.
 scripts/compose_generate_env.sh
Add repo service to internal network
  • Add the repo service to the datafed-internal network configuration.
 compose/all/compose.yml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JoshuaSBrown JoshuaSBrown linked an issue Apr 30, 2025 that may be closed by this pull request
[Bug, CI, Scripts, Compose] - Default compose settings for repo domain #1399
Open
@JoshuaSBrown JoshuaSBrown self-assigned this Apr 30, 2025
@JoshuaSBrown JoshuaSBrown added Component: CI Component: Build Related to the build system Type: Bug Something isn't working labels Apr 30, 2025
sourcery-ai[bot]
sourcery-ai bot reviewed Apr 30, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @JoshuaSBrown - I've reviewed your changes - here's some feedback:

  • Consider setting REPO_DOMAIN explicitly to the container service name (e.g., 'repo') for inter-container communication instead of leaving it blank when COMPOSE_DOMAIN is 'localhost'.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

JoshuaSBrown and others added 2 commits April 30, 2025 07:30
@JoshuaSBrown @sourcery-ai
Update scripts/compose_generate_env.sh
17b4d91 
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@JoshuaSBrown
Set appropriate default when building compose image
1065376
@JoshuaSBrown JoshuaSBrown changed the title Set reasonable default that will help filling in repo form for core t… Set reasonable default that will help with filling in repo form for core t… May 1, 2025
@JoshuaSBrown JoshuaSBrown merged commit 7dcd3a6 into devel May 5, 2025
11 of 12 checks passed
@JoshuaSBrown JoshuaSBrown deleted the 1399-fix-compose-repo-domain branch May 5, 2025 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@AronPerez AronPerez AronPerez approved these changes

@nedvedba nedvedba Awaiting requested review from nedvedba

Assignees

@JoshuaSBrown JoshuaSBrown

Labels
Component: Build Related to the build system Component: CI Type: Bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug, CI, Scripts, Compose] - Default compose settings for repo domain
2 participants
@JoshuaSBrown @AronPerez