Skip to content

Add convenience method to create a tracker in steps #47

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add convenience method to create a tracker in steps #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdd0c7e
Add convenience method to create a tracker in steps
Apr 7, 2022
1d7d51d
Fix `errcheck` errors
Apr 7, 2022
d35a3bb
Merge branch 'master' into create-step-analytics-tracker
russellbstephens Jun 17, 2022
d5da4f2
Update analytics/track.go
lpusok Nov 2, 2022
56474dc
Merge branch 'master' into create-step-analytics-tracker
lpusok Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions analytics/mocks/Repository.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 35 additions & 0 deletions analytics/mocks/TrackerFactory.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions analytics/track.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package analytics

import (
"fmt"

"github.com/bitrise-io/go-utils/v2/analytics"
"github.com/bitrise-io/go-utils/v2/env"
)

// TrackerFactory ...
type TrackerFactory func(...analytics.Properties) analytics.Tracker

const (
stepExecutionIDEnvKey = "BITRISE_STEP_EXECUTION_ID"
stepExecutionID = "step_execution_id"
)

// NewStepTracker creates a tracker that adds the `step_execution_id` property to all events logged with this instance. This is useful for joining the logged data with other tables on the execution ID.
func NewStepTracker(repository env.Repository, trackerFactory TrackerFactory) (analytics.Tracker, error) {
id := repository.Get(stepExecutionIDEnvKey)
if id == "" {
return nil, fmt.Errorf("no step execution ID found")
}
return trackerFactory(analytics.Properties{stepExecutionID: id}), nil
}

// NewDefaultStepTracker ...
func NewDefaultStepTracker(repository env.Repository) (analytics.Tracker, error) {
return NewStepTracker(repository, analytics.NewDefaultTracker)
}
29 changes: 29 additions & 0 deletions analytics/track_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package analytics

import (
"testing"

"github.com/bitrise-io/go-steputils/v2/analytics/mocks"
"github.com/bitrise-io/go-utils/v2/analytics"
)

func TestNewStepTrackerFailsIfStepExecutionIDIsNotFound(t *testing.T) {
repository := new(mocks.Repository)
repository.On("Get", "BITRISE_STEP_EXECUTION_ID").Return("")
_, err := NewDefaultStepTracker(repository)
if err == nil {
t.Error("Expected error, got nil")
}
}

func TestNewStepTrackerAddsStepExecutionIDToNewTracker(t *testing.T) {
repository := new(mocks.Repository)
repository.On("Get", "BITRISE_STEP_EXECUTION_ID").Return("123")
factory := new(mocks.TrackerFactory)
factory.On("Execute", analytics.Properties{"step_execution_id": "123"}).Return(nil, nil)
_, err := NewStepTracker(repository, factory.Execute)
if err != nil {
t.Errorf("Expected no error, got %s", err)
}
factory.AssertExpectations(t)
}
4 changes: 3 additions & 1 deletion go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n
github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
github.com/hashicorp/go-hclog v0.9.2 h1:CG6TE5H9/JXsFWJCfoIVpKFIkFe6ysEuHirp4DxCsHI=
github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ=
github.com/hashicorp/go-retryablehttp v0.7.0 h1:eu1EI/mbirUgP5C8hVsTNaGZreBDlYiwC1FZWkvQPQ4=
github.com/hashicorp/go-retryablehttp v0.7.0/go.mod h1:vAew36LZh98gCBJNLH42IQ1ER/9wtLZZ8meHqQvEYWY=
github.com/hashicorp/go-retryablehttp v0.7.1 h1:sUiuQAnLlbvmExtFQs72iFW/HXeUn8Z1aJLQ4LJJbTQ=
github.com/hashicorp/go-retryablehttp v0.7.1/go.mod h1:vAew36LZh98gCBJNLH42IQ1ER/9wtLZZ8meHqQvEYWY=
Expand All @@ -28,8 +29,9 @@ github.com/stretchr/objx v0.3.0 h1:NGXK3lHquSN08v5vWalVI/L8XU9hdzE/G6xsrze47As=
github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
golang.org/x/crypto v0.0.0-20211202192323-5770296d904e/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
Expand Down