🔧 [fix] Fix Port Mapping Issue #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds significant logging for debugging as well as port initialization if a specified port is not found in the existing config file.
This commit validates and assigns ports before deploying manuscripts, ensuring that ports for graphQL , the database, and the manuscript itself are all properly assigned.
This commit moves the port verification out of deploy manuscript and into the common_command.go file in the pkg package. The idea would be to gradually migrate common methods to a single source so that the script is easier to follow and debug.
This commit modifies GetListeningPorts() in common_command.go so as to make it more robust. Instead of just looking at system ports. It evaluates docker container ports and system ports comprehensively to ensure that port conflicts don't occur. It also continues the migration of system functionality to the common_command.go inside pkg package for better encapsulation.
Applied principle of D.R.Y. - don't repeat yourself - to init_manuscripts.go. Now, instead of reusing similar logic to assign ports, it uses the common pkg.InitialzePorts function on the manuscript to assign new ports. This is a significantly cleaner implementation as it means that we'll only need to change the logic in one location going forward.
Due to previous commmits, the FindAvailablePort() is now defined in pkg/common_command.go and no longer needs to be put here in init_manuscript.go. It is now being removed for clarity.
Liquidwe
approved these changes
Nov 27, 2024
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist:
Important
Please review the checklist below before submitting your pull request.
Description
This PR restores functionality to port assignment for manuscript initializations and deployments. I removed redundant code in createDockerComposeFile function, fixed overlapping ports issue during manuscript initialization, moved port verification to a common package for better organization, added port validation before manuscript deployment, and enhanced port initialization for Docker Compose.
The MAJOR THEME was to do the following:
1- check that ports aren't already in use by docker/system before assigning
2- assure ports have been assigned with additional validation measures
More granularly, I did the following:
pkg.InitializePortsfunction for assigning ports, improving code maintainability.pkg.GetListeningPorts()to prevent port conflicts by considering both system and docker containerports.
common_command.goin the pkg package for better codeorganization & consistency.
Fixes #60
As always, please check behind my work 😅
Type of Change