Skip to content
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.

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

[online] Revert GENERATOR_HOST explicit setting #3287

Merged

Conversation

jimschubert
Copy link
Member

@jimschubert jimschubert commented Jul 6, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Removing GENERATOR_HOST usage, and moving configuration to server. We may want to consider removing GENERATOR_HOST completely from GenApiServer (if possible), and just using built-in support for retrieving the host/port. I was trying to reduce confusion around this variable in the code that is removed by this PR, but upon discussion it seems the environment variable just adds confusion and is therefore not the appropriate configuration to target.

@auto-labeler
Copy link

auto-labeler bot commented Jul 6, 2019

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@jimschubert
Copy link
Member Author

@cbornet @wing328

ENV GENERATOR_HOST=http://localhost
# GENERATOR_HOST can be used to determine the target location of a download link.
# The default value asumes binding to host via: docker -p 8080:8080 image_name
ENV GENERATOR_HOST=http://localhost:8080
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure I understand. Do we keep GENERATOR_HOST?

Copy link
Member Author

Choose a reason for hiding this comment

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

@cbornet GENERATOR_HOST is still used here:

This isn't "correct" and will need to be changed. The previous value here would be incorrect for all invocations unless bound to port 80, which I believe requires super user privileges. This change at least causes the variable to match the exposed port.

Many people try out docker images by binding to random host ports (-P), and when doing this… GENERATOR_HOST will be useless and the file download link generation won't work.

This PR limits focus to get the proxying host setting working on the server. I can look at the other work later.

Copy link
Member Author

Choose a reason for hiding this comment

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

Created #3288 to address this other concern.

@jimschubert
Copy link
Member Author

This reverts changes I added in #3263 and #3265.

@jimschubert
Copy link
Member Author

CircleCI failure is unrelated. Merging this to let the deployment do its thing, and creating an issue for tracking removal of GENERATOR_HOST from GenApiService.

@jimschubert jimschubert merged commit 45da167 into OpenAPITools:master Jul 6, 2019
@jimschubert jimschubert deleted the revert-online-host-setting branch July 6, 2019 21:18
@wing328 wing328 added this to the 4.1.0 milestone Aug 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants