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.

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

Rework flow/preview_start endpoint to take a number of days since last seen on #624

Merged
merged 1 commit into from
Apr 27, 2022
+73 −60
Merged

Rework flow/preview_start endpoint to take a number of days since last seen on #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions core/search/queries.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ import (

// Exclusions are preset exclusion conditions
type Exclusions struct {
NonActive bool `json:"non_active"` // contacts who are blocked, stopped or archived
InAFlow bool `json:"in_a_flow"` // contacts who are currently in a flow (including this one)
StartedPreviously bool `json:"started_previously"` // contacts who have been in this flow in the last 90 days
NotSeenRecently bool `json:"not_seen_recently"` // contacts who have not been seen for more than 90 days
NonActive bool `json:"non_active"` // contacts who are blocked, stopped or archived
InAFlow bool `json:"in_a_flow"` // contacts who are currently in a flow (including this one)
StartedPreviously bool `json:"started_previously"` // contacts who have been in this flow in the last 90 days
NotSeenSinceDays int `json:"not_seen_since_days"` // contacts who have not been seen for more than this number of days
}

// BuildStartQuery builds a start query for the given flow and start options
Expand Down Expand Up @@ -51,8 +51,8 @@ func BuildStartQuery(env envs.Environment, flow *models.Flow, groups []*models.G
if excs.StartedPreviously {
exclusions = append(exclusions, fmt.Sprintf("history != \"%s\"", flow.Name()))
}
if excs.NotSeenRecently {
seenSince := dates.Now().Add(-time.Hour * 24 * 90)
if excs.NotSeenSinceDays > 0 {
seenSince := dates.Now().Add(-time.Hour * time.Duration(24*excs.NotSeenSinceDays))
exclusions = append(exclusions, fmt.Sprintf("last_seen_on > %s", formatQueryDate(env, seenSince)))
}

Expand Down
6 changes: 3 additions & 3 deletions core/search/queries_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func TestBuildStartQuery(t *testing.T) {
NonActive: true,
InAFlow: true,
StartedPreviously: true,
NotSeenRecently: true,
NotSeenSinceDays: 90,
},
expected: `(group = "Doctors" OR uuid = "6393abc0-283d-4c9b-a1b3-641a035c34bf" OR tel = "+1234567890") AND status = "active" AND flow = "" AND history != "Favorites" AND last_seen_on > 20-01-2022`,
},
Expand All @@ -73,9 +73,9 @@ func TestBuildStartQuery(t *testing.T) {
NonActive: true,
InAFlow: true,
StartedPreviously: true,
NotSeenRecently: true,
NotSeenSinceDays: 30,
},
expected: `gender = M AND status = "active" AND flow = "" AND history != "Favorites" AND last_seen_on > 20-01-2022`,
expected: `gender = M AND status = "active" AND flow = "" AND history != "Favorites" AND last_seen_on > 21-03-2022`,
},
}

Expand Down
36 changes: 20 additions & 16 deletions web/flow/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,13 @@ func init() {
// {
// "org_id": 1,
// "flow_id": 2,
// "group_uuids": ["5fa925e4-edd8-4e2a-ab24-b3dbb5932ddd", "2912b95f-5b89-4d39-a2a8-5292602f357f"],
// "contact_uuids": ["e5bb9e6f-7703-4ba1-afba-0b12791de38b"],
// "urns": ["tel:+1234567890"],
// "user_query": "",
// "exclusions": {
// "include": {
// "group_uuids": ["5fa925e4-edd8-4e2a-ab24-b3dbb5932ddd", "2912b95f-5b89-4d39-a2a8-5292602f357f"],
// "contact_uuids": ["e5bb9e6f-7703-4ba1-afba-0b12791de38b"],
// "urns": ["tel:+1234567890"],
// "user_query": ""
// },
// "exclude": {
// "non_active": false,
// "in_a_flow": false,
// "started_previously": true,
Expand All @@ -51,14 +53,16 @@ func init() {
// }
//
type previewStartRequest struct {
OrgID models.OrgID `json:"org_id" validate:"required"`
FlowID models.FlowID `json:"flow_id" validate:"required"`
GroupUUIDs []assets.GroupUUID `json:"group_uuids"`
ContactUUIDs []flows.ContactUUID `json:"contact_uuids"`
URNs []urns.URN `json:"urns"`
Query string `json:"query"`
Exclusions search.Exclusions `json:"exclusions"`
SampleSize int `json:"sample_size" validate:"required"`
OrgID models.OrgID `json:"org_id" validate:"required"`
FlowID models.FlowID `json:"flow_id" validate:"required"`
Include struct {
GroupUUIDs []assets.GroupUUID `json:"group_uuids"`
ContactUUIDs []flows.ContactUUID `json:"contact_uuids"`
URNs []urns.URN `json:"urns"`
Query string `json:"query"`
} `json:"include" validate:"required"`
Exclude search.Exclusions `json:"exclude"`
SampleSize int `json:"sample_size" validate:"required"`
}

type previewStartResponse struct {
Expand All @@ -84,15 +88,15 @@ func handlePreviewStart(ctx context.Context, rt *runtime.Runtime, r *http.Reques
return nil, http.StatusInternalServerError, errors.Wrapf(err, "unable to load flow")
}

groups := make([]*models.Group, 0, len(request.GroupUUIDs))
for _, groupUUID := range request.GroupUUIDs {
groups := make([]*models.Group, 0, len(request.Include.GroupUUIDs))
for _, groupUUID := range request.Include.GroupUUIDs {
g := oa.GroupByUUID(groupUUID)
if g != nil {
groups = append(groups, g)
}
}

query := search.BuildStartQuery(oa.Env(), flow, groups, request.ContactUUIDs, request.URNs, request.Query, request.Exclusions)
query := search.BuildStartQuery(oa.Env(), flow, groups, request.Include.ContactUUIDs, request.Include.URNs, request.Include.Query, request.Exclude)
if query == "" {
return &previewStartResponse{SampleIDs: []models.ContactID{}}, http.StatusOK, nil
}
Expand Down
79 changes: 44 additions & 35 deletions web/flow/testdata/preview_start.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"body": {
"org_id": 1,
"flow_id": 10001,
"include": {},
"sample_size": 3
},
"status": 200,
Expand All @@ -41,19 +42,21 @@
"body": {
"org_id": 1,
"flow_id": 10001,
"group_uuids": [
"c153e265-f7c9-4539-9dbc-9b358714b638",
"5e9d8fab-5e7e-4f51-b533-261af5dea70d"
],
"contact_uuids": [
"5a8345c1-514a-4d1b-aee5-6f39b2f53cfa",
"bd2aab59-5e28-4db4-b6e8-bbdb75fd7a0a"
],
"urns": [
"tel:+1234567890",
"facebook:9876543210"
],
"query": "",
"include": {
"group_uuids": [
"c153e265-f7c9-4539-9dbc-9b358714b638",
"5e9d8fab-5e7e-4f51-b533-261af5dea70d"
],
"contact_uuids": [
"5a8345c1-514a-4d1b-aee5-6f39b2f53cfa",
"bd2aab59-5e28-4db4-b6e8-bbdb75fd7a0a"
],
"urns": [
"tel:+1234567890",
"facebook:9876543210"
],
"query": ""
},
"sample_size": 3
},
"status": 200,
Expand Down Expand Up @@ -94,10 +97,12 @@
"body": {
"org_id": 1,
"flow_id": 10001,
"group_ids": [],
"contact_ids": [],
"urns": [],
"query": "gender = M",
"include": {
"group_ids": [],
"contact_ids": [],
"urns": [],
"query": "gender = M"
},
"sample_size": 3
},
"status": 200,
Expand Down Expand Up @@ -128,24 +133,26 @@
"body": {
"org_id": 1,
"flow_id": 10001,
"group_uuids": [
"c153e265-f7c9-4539-9dbc-9b358714b638",
"5e9d8fab-5e7e-4f51-b533-261af5dea70d"
],
"contact_uuids": [
"5a8345c1-514a-4d1b-aee5-6f39b2f53cfa",
"bd2aab59-5e28-4db4-b6e8-bbdb75fd7a0a"
],
"urns": [
"tel:+1234567890",
"facebook:9876543210"
],
"query": "",
"exclusions": {
"include": {
"group_uuids": [
"c153e265-f7c9-4539-9dbc-9b358714b638",
"5e9d8fab-5e7e-4f51-b533-261af5dea70d"
],
"contact_uuids": [
"5a8345c1-514a-4d1b-aee5-6f39b2f53cfa",
"bd2aab59-5e28-4db4-b6e8-bbdb75fd7a0a"
],
"urns": [
"tel:+1234567890",
"facebook:9876543210"
],
"query": ""
},
"exclude": {
"non_active": true,
"in_a_flow": true,
"started_previously": true,
"not_seen_recently": true
"not_seen_since_days": 90
},
"sample_size": 3
},
Expand Down Expand Up @@ -191,12 +198,14 @@
"body": {
"org_id": 1,
"flow_id": 10001,
"query": "gender = M",
"exclusions": {
"include": {
"query": "gender = M"
},
"exclude": {
"non_active": true,
"in_a_flow": true,
"started_previously": true,
"not_seen_recently": true
"not_seen_since_days": 90
},
"sample_size": 3
},
Expand Down