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: Remove all references to Redis #2409

Merged
merged 2 commits into from
Mar 24, 2020

Conversation

2opremio
Copy link
Contributor

@2opremio 2opremio commented Mar 24, 2020

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.

Fixes #2395

What

Remove all Redis references.

Why

It wasn't used, it was only adding complexity and causing test failures.

Known limitations

N/A

@cla-bot cla-bot bot added the cla: yes label Mar 24, 2020
services/horizon/cmd/root.go Outdated Show resolved Hide resolved
It wasn't used, it was only adding complexity and causing test failures.
We should deprecate them first, to give room to remove them
(in case someone is using them)
@2opremio 2opremio merged commit ddf7117 into release-horizon-v1.1.0 Mar 24, 2020
@2opremio 2opremio deleted the 2395-remove-redis branch March 24, 2020 18:43
ConfigKey: &config.RedisURL,
OptType: types.String,
Usage: "redis to connect with, for rate limiting",
&support.ConfigOption{ // To be removed in horizon 2.0.0
Copy link
Member

Choose a reason for hiding this comment

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

We used to add a specially formatted comment following the pattern outlined in issue #833 so that CI picks up on them and helps us remove them when the time comes. @stellar/horizon-committers I can't find any details in our CONTRIBUTING.md or DEVELOPING.md documents that outline how to do this. Have we abandoned that practice?

We still have the CI check for this (below), so I think we're still wanting to do it and probably need some better docs to encourage us to use it. I know I've probably not done this properly recently too 😬.

go/.circleci/config.yml

Lines 41 to 52 in bab6abc

# check_deprecations ensures a release is actually removing deprecated fields
# that were supposed to be discontinued in said release.
check_deprecations:
steps:
- run:
name: Run deprecation tests when on a tagged commit
command: |
if [ "$CIRCLE_TAG" != "" ]; then
# Negate the result so process exits with 1 if anything found
echo "Searching for \"action needed\" tags..."
! egrep -irn -A 1 --include=*.go "Action.+needed.+in.+release:.+$CIRCLE_TAG" ./
fi

Copy link
Member

Choose a reason for hiding this comment

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

Good catch. The approach isn't abandoned. It's documented in our internal devel guide.

Mark deprecated public API fields using deprecation tag:
// Deprecated - remove in: horizon-v[version]

We should do a pass over this and update DEVELOPING.md with things relevant to all contributors.

@2opremio can you update the deprecation comments to match the syntax quoted above?

Copy link
Member

Choose a reason for hiding this comment

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

#2412 for the doc updates

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure thing

@leighmcculloch
Copy link
Member

I notice that this change was made only for the next Horizon release branch. Is there a reason this isn't on master? I may be making changes to the CircleCI config soon and we can avoid merge conflicts later when Horizon releases if this change is also on master.

@2opremio
Copy link
Contributor Author

2opremio commented Mar 25, 2020

I notice that this change was made only for the next Horizon release branch. Is there a reason this isn't on master? I may be making changes to the CircleCI config soon and we can avoid merge conflicts later when Horizon releases if this change is also on master.

Sure, I will create a PR to merge it back to master.

@2opremio 2opremio changed the title Remove all references to Redis services/horizon: Remove all references to Redis Mar 25, 2020
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.

3 participants