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

services/horizon: Add deprecation warning for using command-line flags #5051

Merged
merged 24 commits into from
Oct 6, 2023

Conversation

aditya1702
Copy link
Contributor

@aditya1702 aditya1702 commented Sep 13, 2023

Closes #5045

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

We recommend environment variable usage in our docs. We want to deprecate command-line flag usage and remove it completely in the future. This deprecation warning will make users move towards using env vars.

Why

Currently horizon has a ton of flags and this makes using them all very cumbersome. We want to move towards using environment variables.

Known limitations

[TODO or N/A]

@aditya1702 aditya1702 marked this pull request as ready for review September 15, 2023 17:03
Copy link
Contributor

@urvisavla urvisavla left a comment

Choose a reason for hiding this comment

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

While we're currently only adding a deprecation warning, I'm wondering if we should transition our code that uses command line parameters, both in test cases and potentially other code, to instead use environment variables before publishing the warning?

Copy link
Contributor

@urvisavla urvisavla left a comment

Choose a reason for hiding this comment

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

Can we avoid duplicating environment.go?

Copy link
Contributor

@urvisavla urvisavla left a comment

Choose a reason for hiding this comment

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

LGTM!

@aditya1702 aditya1702 merged commit e50ba18 into stellar:master Oct 6, 2023
36 checks passed
@aditya1702 aditya1702 deleted the deprecate-cli-flags branch October 6, 2023 20:57
2opremio pushed a commit that referenced this pull request Oct 16, 2023
#5051)

* Add deprecated warning

* Add deprecated warning tests

* add test for env vars

* Dynamically print deprecated message

* Update flags.go

* Update parameters_test.go

* Update parameters_test.go

* Update parameters_test.go

* Update parameters_test.go

* Shift environment.go to horizon package

* Move environment.go to test dir

* Update flags_test.go

* Update flags_test.go

* Update integration.go

* Nit changes - 1

* Update CHANGELOG.md

* Nit changes - 2

* Update flags_test.go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

services/horizon: deprecate command-line parameter usage in favor of env vars
3 participants