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

Prep backend for session search swap #8351

Merged
merged 3 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
DROP VIEW IF EXISTS sessions_joined_vw;
CREATE VIEW IF NOT EXISTS sessions_joined_vw AS
select ProjectID as ProjectId,
CreatedAt as Timestamp,
mapFromArrays(
arrayMap(x->splitByChar('_', x, 2) [2], FieldKeys),
arrayMap(
(k, kv)->substring(kv, length(k) + 2),
arrayZip(FieldKeys, FieldKeyValues)
)
) as SessionAttributes,
*
Vadman97 marked this conversation as resolved.
Show resolved Hide resolved
from sessions SETTINGS splitby_max_substrings_includes_remaining_string = 1;
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
DROP VIEW IF EXISTS sessions_joined_vw;
CREATE VIEW IF NOT EXISTS sessions_joined_vw AS
select ProjectID as ProjectId,
CreatedAt as Timestamp,
mapFromArrays(
arrayMap(x->splitByChar('_', x, 2) [2], FieldKeys),
arrayMap(
(k, kv)->substring(kv, length(k) + 2),
arrayZip(FieldKeys, FieldKeyValues)
)
) as SessionAttributes,
*
from sessions SETTINGS splitby_max_substrings_includes_remaining_string = 1;
122 changes: 92 additions & 30 deletions backend/clickhouse/sessions.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,34 @@ type ClickhouseField struct {
Value string
}

// These keys show up as recommendations, but with no recommended values due to high cardinality
// These keys show up as recommendations, not in fields table due to high cardinality or post processing booleans
var defaultSessionsKeys = []*modelInputs.QueryKey{
{Name: string(modelInputs.ReservedSessionKeyLength), Type: modelInputs.KeyTypeNumeric},
{Name: string(modelInputs.ReservedSessionKeyActiveLength), Type: modelInputs.KeyTypeNumeric},
{Name: string(modelInputs.ReservedSessionKeyFirstTime), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyHasComments), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyHasErrors), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyHasRageClicks), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyIdentified), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyLength), Type: modelInputs.KeyTypeNumeric},
{Name: string(modelInputs.ReservedSessionKeyPagesVisited), Type: modelInputs.KeyTypeNumeric},
{Name: string(modelInputs.ReservedSessionKeyProcessed), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeySample), Type: modelInputs.KeyTypeCreatable},
{Name: string(modelInputs.ReservedSessionKeyViewed), Type: modelInputs.KeyTypeBoolean},
{Name: string(modelInputs.ReservedSessionKeyViewedByMe), Type: modelInputs.KeyTypeBoolean},
}

var booleanKeys = map[string]bool{
string(modelInputs.ReservedSessionKeyFirstTime): true,
string(modelInputs.ReservedSessionKeyIdentified): true,
string(modelInputs.ReservedSessionKeyHasComments): true,
string(modelInputs.ReservedSessionKeyHasErrors): true,
string(modelInputs.ReservedSessionKeyHasRageClicks): true,
string(modelInputs.ReservedSessionKeyProcessed): true,
string(modelInputs.ReservedSessionKeyViewed): true,
string(modelInputs.ReservedSessionKeyViewedByMe): true,
}

const SessionsJoinedTable = "sessions_joined_vw"
const SessionsTable = "sessions"
const FieldsTable = "fields"
const SessionKeysTable = "session_keys"
Expand Down Expand Up @@ -468,34 +490,40 @@ func SessionMatchesQuery(session *model.Session, filters listener.Filters) bool
}

var SessionsJoinedTableConfig = model.TableConfig[modelInputs.ReservedSessionKey]{
TableName: "sessions_joined_vw",
TableName: SessionsJoinedTable,
AttributesColumn: "SessionAttributes",
BodyColumn: `concat(coalesce(nullif(SessionAttributes['email'],''), nullif(Identifier, ''), nullif(toString(Fingerprint), ''), 'unidentified'), ': ', City, if(City != '', ', ', ''), Country)`,
KeysToColumns: map[modelInputs.ReservedSessionKey]string{
modelInputs.ReservedSessionKeyEnvironment: "Environment",
modelInputs.ReservedSessionKeyAppVersion: "AppVersion",
modelInputs.ReservedSessionKeySecureSessionID: "SecureID",
modelInputs.ReservedSessionKeyFingerprint: "Fingerprint",
modelInputs.ReservedSessionKeyIdentifier: "Identifier",
modelInputs.ReservedSessionKeyCity: "City",
modelInputs.ReservedSessionKeyState: "State",
modelInputs.ReservedSessionKeyCountry: "Country",
modelInputs.ReservedSessionKeyOsName: "OSName",
modelInputs.ReservedSessionKeyOsVersion: "OSVersion",
modelInputs.ReservedSessionKeyBrowserName: "BrowserName",
modelInputs.ReservedSessionKeyBrowserVersion: "BrowserVersion",
modelInputs.ReservedSessionKeyProcessed: "Processed",
modelInputs.ReservedSessionKeyHasComments: "HasComments",
modelInputs.ReservedSessionKeyHasRageClicks: "HasRageClicks",
modelInputs.ReservedSessionKeyHasErrors: "HasErrors",
modelInputs.ReservedSessionKeyLength: "Length",
modelInputs.ReservedSessionKeyActiveLength: "ActiveLength",
modelInputs.ReservedSessionKeyFirstTime: "FirstTime",
modelInputs.ReservedSessionKeyViewed: "Viewed",
modelInputs.ReservedSessionKeyPagesVisited: "PagesVisited",
modelInputs.ReservedSessionKeyNormalness: "Normalness",
modelInputs.ReservedSessionKeyActiveLength: "ActiveLength",
modelInputs.ReservedSessionKeyServiceVersion: "AppVersion",
modelInputs.ReservedSessionKeyBrowserName: "BrowserName",
modelInputs.ReservedSessionKeyBrowserVersion: "BrowserVersion",
modelInputs.ReservedSessionKeyCity: "City",
modelInputs.ReservedSessionKeyCountry: "Country",
modelInputs.ReservedSessionKeyEnvironment: "Environment",
modelInputs.ReservedSessionKeyDeviceID: "Fingerprint",
modelInputs.ReservedSessionKeyFirstTime: "FirstTime",
modelInputs.ReservedSessionKeyHasComments: "HasComments",
modelInputs.ReservedSessionKeyHasErrors: "HasErrors",
modelInputs.ReservedSessionKeyHasRageClicks: "HasRageClicks",
modelInputs.ReservedSessionKeyIdentified: "Identified",
modelInputs.ReservedSessionKeyIdentifier: "Identifier",
modelInputs.ReservedSessionKeyIP: "IP",
modelInputs.ReservedSessionKeyLength: "Length",
modelInputs.ReservedSessionKeyNormalness: "Normalness",
modelInputs.ReservedSessionKeyOsName: "OSName",
modelInputs.ReservedSessionKeyOsVersion: "OSVersion",
modelInputs.ReservedSessionKeyPagesVisited: "PagesVisited",
modelInputs.ReservedSessionKeyProcessed: "Processed",
modelInputs.ReservedSessionKeySecureID: "SecureID",
modelInputs.ReservedSessionKeyLocState: "State",
modelInputs.ReservedSessionKeyViewed: "Viewed",
},
ReservedKeys: modelInputs.AllReservedSessionKey,
IgnoredFilters: map[string]bool{
modelInputs.ReservedSessionKeySample.String(): true,
modelInputs.ReservedSessionKeyViewedByMe.String(): true,
},
}

var sessionsSampleableTableConfig = sampleableTableConfig[modelInputs.ReservedSessionKey]{
Expand Down Expand Up @@ -559,6 +587,10 @@ func (client *Client) QuerySessionCustomMetrics(ctx context.Context, projectId i
}

func (client *Client) SessionsKeyValues(ctx context.Context, projectID int, keyName string, startDate time.Time, endDate time.Time) ([]string, error) {
if booleanKeys[keyName] {
return []string{"true", "false"}, nil
}

sb := sqlbuilder.NewSelectBuilder()
sql, args := sb.
Select("Value").
Expand Down Expand Up @@ -595,13 +627,37 @@ func (client *Client) GetConn() driver.Conn {

func GetSessionsQueryImpl(admin *model.Admin, params modelInputs.QueryInput, projectId int, retentionDate time.Time, selectColumns string, groupBy *string, orderBy *string, limit *int, offset *int) (string, []interface{}, bool, error) {
sb := sqlbuilder.NewSelectBuilder()
sb.From(SessionsJoinedTableConfig.TableName)
sb.Select(selectColumns)
sb.From(fmt.Sprintf("%s FINAL", SessionsJoinedTableConfig.TableName))

sb.Where(sb.LessEqualThan("CreatedAt", params.DateRange.EndDate)).
Where(sb.GreaterEqualThan("CreatedAt", params.DateRange.StartDate))

parser.AssignSearchFilters(sb, params.Query, SessionsJoinedTableConfig)
listener := parser.GetSearchListener(sb, params.Query, SessionsJoinedTableConfig)
parser.GetSearchFilters(params.Query, SessionsJoinedTableConfig, listener)

useViewedByMe := listener.IgnoredFilters != nil && listener.IgnoredFilters[modelInputs.ReservedSessionKeyViewedByMe.String()] != ""
if useViewedByMe {
viewedByMe := listener.IgnoredFilters[modelInputs.ReservedSessionKeyViewedByMe.String()]
if viewedByMe == "true" {
sb.Where(fmt.Sprintf("has(ViewedByAdmins, %d)", admin.ID))
} else {
sb.Where(fmt.Sprintf("NOT has(ViewedByAdmins, %d)", admin.ID))
}
}

useRandomSample := listener.IgnoredFilters != nil && listener.IgnoredFilters[modelInputs.ReservedSessionKeySample.String()] != ""
if useRandomSample {
sampleRule := listener.IgnoredFilters[modelInputs.ReservedSessionKeySample.String()]
salt, err := strconv.ParseUint(sampleRule, 16, 64)
if err != nil {
return "", nil, false, err
}
selectColumns = fmt.Sprintf("%s, toUInt64(farmHash64(SecureID) %% %d) as hash", selectColumns, salt)
orderBy = pointy.String("hash")
}

sb.Select(selectColumns)

if groupBy != nil {
sb = sb.GroupBy(*groupBy)
}
Expand All @@ -615,10 +671,16 @@ func GetSessionsQueryImpl(admin *model.Admin, params modelInputs.QueryInput, pro
sb = sb.Offset(*offset)
}

if useRandomSample {
sbOuter := sqlbuilder.NewSelectBuilder()
sb = sbOuter.
Select("*").
From(sbOuter.BuilderAs(sb, "inner"))
}

sql, args := sb.BuildWithFlavor(sqlbuilder.ClickHouse)

// TODO(spenny): custom rules to check - sampleField
return sql, args, false, nil
return sql, args, useRandomSample, nil
}

func (client *Client) QuerySessionIds(ctx context.Context, admin *model.Admin, projectId int, count int, params modelInputs.QueryInput, sortField string, page *int, retentionDate time.Time) ([]int64, int64, bool, error) {
Expand Down
1 change: 1 addition & 0 deletions backend/model/model.go
Original file line number Diff line number Diff line change
Expand Up @@ -2473,4 +2473,5 @@ type TableConfig[TReservedKey ~string] struct {
ReservedKeys []TReservedKey
SelectColumns []string
DefaultFilter string
IgnoredFilters map[string]bool
}
Loading
Loading