chore(backend): add more comments

Author: abhaysood

backend/api/measure/app.go

@@ -6613,7 +6613,7 @@ func GetSessionTargetingRule(c *gin.Context) {
 		return
 	}
 
-	trace, err := GetSTRule(ctx, ruleId)
+	trace, err := GetSTRuleById(ctx, ruleId)
 	if err != nil {
 		msg := "failed to get trace"
 		fmt.Println(msg, err)

backend/api/measure/session_targeting.go

@@ -68,6 +68,9 @@ type STDashboardConfig struct {
 	OperatorTypes OperatorTypes `json:"operator_types"`
 }
 
+// GetSTRules provides session targeting rules
+// that matches various filter criteria
+// in a paginated fashion.
 func GetSTRules(ctx context.Context, af *filter.AppFilter) (rules []SessionTargetingRule, next, previous bool, err error) {
 	stmt := sqlf.PostgreSQL.From("session_targeting_rules").
 		Select("id").
@@ -164,10 +167,9 @@ func GetSTRules(ctx context.Context, af *filter.AppFilter) (rules []SessionTarge
 	return rules, next, previous, nil
 }
 
-// GetSTRule constructs and returns a
-// session targeting rule for a
-// given ruleId
-func GetSTRule(ctx context.Context, ruleId string) (rule SessionTargetingRule, err error) {
+// GetSTRuleById fetches a session targeting
+// rule by its ruleId.
+func GetSTRuleById(ctx context.Context, ruleId string) (rule SessionTargetingRule, err error) {
 	stmt := sqlf.PostgreSQL.From("session_targeting_rules").
 		Select("id").
 		Select("team_id").
@@ -205,6 +207,9 @@ func GetSTRule(ctx context.Context, ruleId string) (rule SessionTargetingRule, e
 	return rule, nil
 }
 
+// CreateSTRule validates and creates
+// a new session targeting rule for
+// an app.
 func CreateSTRule(ctx context.Context, teamId string, appId string, userId string, payload CreateSTRulePayload) (rule SessionTargetingRule, err error) {
 	now := time.Now()
 	ruleId := uuid.New()
@@ -257,6 +262,8 @@ func CreateSTRule(ctx context.Context, teamId string, appId string, userId strin
 	return rule, nil
 }
 
+// UpdateSTRule updates an existing
+// session targeting rule.
 func UpdateSTRule(ctx context.Context, teamId string, appId string, userId string, ruleId string, payload UpdateSTRulePayload) error {
 	now := time.Now()
 
@@ -299,6 +306,9 @@ func UpdateSTRule(ctx context.Context, teamId string, appId string, userId strin
 	return nil
 }
 
+// GetSTDashboardConfig creates and returns
+// the config required to render session
+// targeting rule creation page.
 func GetSTDashboardConfig(ctx context.Context, appId uuid.UUID, osName string) (STDashboardConfig, error) {
 	eventUdAttrs, err := getUDAttrKeys(ctx, appId)
 	if err != nil {
@@ -349,7 +359,8 @@ func getUDAttrKeys(ctx context.Context, appId uuid.UUID) (attributes []Attribute
 	return
 }
 
-// newEventsConfig creates OS-specific events configuration
+// newEventsConfig creates OS-specific
+// events configuration
 func newEventsConfig(os string) []Event {
 	// Common events for both iOS and Android
 	events := []Event{
@@ -443,6 +454,8 @@ func newEventsConfig(os string) []Event {
 	return events
 }
 
+// newEventsConfig creates OS-specific
+// session attributes configuration.
 func newSessionConfig(osName string) []Attribute {
 	switch opsys.ToFamily(osName) {
 	case opsys.Android: