-
Notifications
You must be signed in to change notification settings - Fork 1.4k
feat(client): add usage report config #2586
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d3544d3
feat(client): add usage report config
fortuna b70ca5b
Handle 404
fortuna 5de0104
Add useragent
fortuna e1bd017
Update client/go/outline/reporting/config.go
fortuna a105d8e
Update client/go/outline/reporting/config.go
fortuna d59c2b0
Require 1h
fortuna 652273e
review
fortuna 925aad4
Fix race condition
fortuna 7a2ae4e
Merge branch 'master' into fortuna-report
fortuna ded1e48
Fix Go Mobile
fortuna File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Copyright 2025 The Outline Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package reporting | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
| "time" | ||
|
|
||
| "github.com/Jigsaw-Code/outline-apps/client/go/configyaml" | ||
| ) | ||
|
|
||
| // HTTPReporterConfig is the format for the HTTPReporter config. | ||
| type HTTPReporterConfig struct { | ||
| URL string | ||
| Interval string | ||
| } | ||
|
|
||
| func NewHTTPReporterSubParser(httpClient *http.Client) func(ctx context.Context, input map[string]any) (Reporter, error) { | ||
| return func(ctx context.Context, input map[string]any) (Reporter, error) { | ||
| var config HTTPReporterConfig | ||
| if err := configyaml.MapToAny(input, &config); err != nil { | ||
| return nil, fmt.Errorf("invalid config format: %w", err) | ||
| } | ||
|
|
||
| collectorURL, err := url.Parse(config.URL) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse the report collector URL: %w", err) | ||
| } | ||
| reporter := &HTTPReporter{URL: *collectorURL, HttpClient: httpClient} | ||
|
|
||
| if config.Interval != "" { | ||
fortuna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| interval, err := time.ParseDuration(config.Interval) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to parse interval: %w", err) | ||
| } | ||
| if interval < 1*time.Hour { | ||
| return nil, fmt.Errorf("interval must be at least 1h") | ||
| } | ||
| reporter.Interval = interval | ||
| } | ||
|
|
||
| return reporter, nil | ||
| } | ||
| } | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // Copyright 2025 The Outline Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package reporting | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "log/slog" | ||
| "net/http" | ||
| "net/url" | ||
| "time" | ||
|
|
||
| "github.com/Jigsaw-Code/outline-apps/client/go/outline/useragent" | ||
| ) | ||
|
|
||
| // Reporter is used to register reports. | ||
| type Reporter interface { | ||
| // Run blocks until the session context is done. | ||
| Run(sessionCtx context.Context) | ||
| } | ||
|
|
||
| type HTTPReporter struct { | ||
| URL url.URL | ||
| Interval time.Duration | ||
| HttpClient *http.Client | ||
| } | ||
|
|
||
| func (r *HTTPReporter) Run(sessionCtx context.Context) { | ||
| r.reportAndLogError() | ||
| if r.Interval == 0 { | ||
| return | ||
| } | ||
| // Only run the loop if we specified an interval. | ||
| ticker := time.NewTicker(r.Interval) | ||
fortuna marked this conversation as resolved.
Show resolved
Hide resolved
fortuna marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| defer ticker.Stop() | ||
| for { | ||
| select { | ||
| case <-sessionCtx.Done(): | ||
| return | ||
| case _, ok := <-ticker.C: | ||
| if !ok { | ||
| return | ||
| } | ||
| r.reportAndLogError() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (r *HTTPReporter) reportAndLogError() { | ||
| slog.Debug("Sending report", "url", r.URL) | ||
| err := r.Report() | ||
| if err != nil { | ||
| slog.Warn("Failed to report", "err", err) | ||
| } | ||
| } | ||
|
|
||
| func (r *HTTPReporter) Report() error { | ||
| req, err := http.NewRequest("POST", r.URL.String(), nil) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create report HTTP request: %w", err) | ||
| } | ||
| req.Close = true | ||
| // TODO: Add Outline Client version. | ||
| req.Header.Add("User-Agent", useragent.GetOutlineUserAgent()) | ||
|
|
||
| resp, err := r.HttpClient.Do(req) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to send report: %w", err) | ||
| } | ||
| resp.Body.Close() | ||
| if resp.StatusCode < 200 || resp.StatusCode >= 300 { | ||
| return fmt.Errorf("report failed with status code %d", resp.StatusCode) | ||
| } | ||
| return nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.