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

Remove Explorer #10581

Merged
merged 16 commits into from
Sep 14, 2023
Merged

Remove Explorer #10581

merged 16 commits into from
Sep 14, 2023

Conversation

skubakdj
Copy link
Contributor

@skubakdj skubakdj commented Sep 11, 2023

As Explorer has been deprecated, this PR:

  • Removes the Explorer client for sending telemetry
  • Removes Explorer config
  • Updates docs

@github-actions
Copy link
Contributor

I see that you haven't updated any CHANGELOG files. Would it make sense to do so?

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@skubakdj skubakdj marked this pull request as ready for review September 11, 2023 19:42
@@ -27,6 +27,10 @@ AllowSimplePasswords=true

- To migrate on production builds, update the database password set in Database.URL to be 16 - 50 characters without leading or trailing whitespace. URI parsing rules apply to the chosen password - refer to [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) for special character escape rules.

### Removed

- Removed support for sending telemetry to the deprecated Explorer service
Copy link
Contributor

Choose a reason for hiding this comment

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

We should probably be explicit here about the config fields that are being removed and that node ops must remove them, since the node will reject a config that still has them and refuse to start.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jmank88 I just updated the changelog, could you please take a look?

ticfg := cfg.TelemetryIngress()
// Use Explorer over TelemetryIngress if both URLs are set
if cfg.Explorer().URL() == nil && ticfg.URL() != nil {
if ticfg.URL() != nil {
if ticfg.UseBatchSend() {
telemetryIngressBatchClient = synchronization.NewTelemetryIngressBatchClient(ticfg.URL(),
Copy link
Contributor

Choose a reason for hiding this comment

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

unrelated to the scope of this PR, but this is a pretty heavy API w/ a large number of the parameters coming from cfg.TelemetryIngress() - what do you think of plumbing ticfg as one parameter through instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds good to me, that would definitely clean things up a bit 🙂

@@ -129,10 +129,6 @@ func (s *Secrets) SetFrom(f *Secrets) (err error) {
err = multierr.Append(err, config.NamedMultiErrorList(err1, "Database"))
}

if err2 := s.Explorer.SetFrom(&f.Explorer); err2 != nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

/nit and a matter of preference - in the future when I revisit this file I'd spend some unnecessary time answering the question "why is err2 skipped?". If you'd like, perhaps update the ordering here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@patrickhuie19 just pushed a commit for this

patrickhuie19
patrickhuie19 previously approved these changes Sep 12, 2023
docs/CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Patrick <[email protected]>
docs/CHANGELOG.md Outdated Show resolved Hide resolved
patrickhuie19
patrickhuie19 previously approved these changes Sep 13, 2023
docs/CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Jordan Krage <[email protected]>
@patrickhuie19 patrickhuie19 added this pull request to the merge queue Sep 13, 2023
@cl-sonarqube-production
Copy link

SonarQube Quality Gate

Quality Gate failed

Failed condition 58.3% 58.3% Coverage on New Code (is less than 80%)

See analysis details on SonarQube

@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 13, 2023
@jmank88 jmank88 added this pull request to the merge queue Sep 14, 2023
Merged via the queue into develop with commit c4557c1 Sep 14, 2023
97 of 98 checks passed
@jmank88 jmank88 deleted the chore/remove-explorer branch September 14, 2023 02:31
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.

4 participants