forked from rapidpro/mailroom
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move search into its own package and add more tests
- Loading branch information
1 parent
3314713
commit 7d9028e
Showing
12 changed files
with
390 additions
and
274 deletions.
There are no files selected for viewing
This file contains 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 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 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,102 @@ | ||
| package search | ||
|
|
||
| import ( | ||
| "context" | ||
| "time" | ||
|
|
||
| "github.com/jmoiron/sqlx" | ||
| "github.com/nyaruka/mailroom/core/models" | ||
| "github.com/olivere/elastic/v7" | ||
| "github.com/pkg/errors" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| // PopulateSmartGroup calculates which members should be part of a group and populates the contacts | ||
| // for that group by performing the minimum number of inserts / deletes. | ||
| func PopulateSmartGroup(ctx context.Context, db *sqlx.DB, es *elastic.Client, oa *models.OrgAssets, groupID models.GroupID, query string) (int, error) { | ||
| err := models.UpdateGroupStatus(ctx, db, groupID, models.GroupStatusEvaluating) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error marking dynamic group as evaluating") | ||
| } | ||
|
|
||
| start := time.Now() | ||
|
|
||
| // we have a bit of a race with the indexer process.. we want to make sure that any contacts that changed | ||
| // before this group was updated but after the last index are included, so if a contact was modified | ||
| // more recently than 10 seconds ago, we wait that long before starting in populating our group | ||
| newest, err := models.GetNewestContactModifiedOn(ctx, db, oa) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error getting most recent contact modified_on for org: %d", oa.OrgID()) | ||
| } | ||
| if newest != nil { | ||
| n := *newest | ||
|
|
||
| // if it was more recent than 10 seconds ago, sleep until it has been 10 seconds | ||
| if n.Add(time.Second * 10).After(start) { | ||
| sleep := n.Add(time.Second * 10).Sub(start) | ||
| logrus.WithField("sleep", sleep).Info("sleeping before evaluating dynamic group") | ||
| time.Sleep(sleep) | ||
| } | ||
| } | ||
|
|
||
| // get current set of contacts in our group | ||
| ids, err := models.ContactIDsForGroupIDs(ctx, db, []models.GroupID{groupID}) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "unable to look up contact ids for group: %d", groupID) | ||
| } | ||
| present := make(map[models.ContactID]bool, len(ids)) | ||
| for _, i := range ids { | ||
| present[i] = true | ||
| } | ||
|
|
||
| // calculate new set of ids | ||
| new, err := GetContactIDsForQuery(ctx, es, oa, query, -1) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error performing query: %s for group: %d", query, groupID) | ||
| } | ||
|
|
||
| // find which contacts need to be added or removed | ||
| adds := make([]models.ContactID, 0, 100) | ||
| for _, id := range new { | ||
| if !present[id] { | ||
| adds = append(adds, id) | ||
| } | ||
| delete(present, id) | ||
| } | ||
|
|
||
| // build our list of removals | ||
| removals := make([]models.ContactID, 0, len(present)) | ||
| for id := range present { | ||
| removals = append(removals, id) | ||
| } | ||
|
|
||
| // first remove all the contacts | ||
| err = models.RemoveContactsFromGroupAndCampaigns(ctx, db, oa, groupID, removals) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error removing contacts from group: %d", groupID) | ||
| } | ||
|
|
||
| // then add them all | ||
| err = models.AddContactsToGroupAndCampaigns(ctx, db, oa, groupID, adds) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error adding contacts to group: %d", groupID) | ||
| } | ||
|
|
||
| // mark our group as no longer evaluating | ||
| err = models.UpdateGroupStatus(ctx, db, groupID, models.GroupStatusReady) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error marking dynamic group as ready") | ||
| } | ||
|
|
||
| // finally update modified_on for all affected contacts to ensure these changes are seen by rp-indexer | ||
| changed := make([]models.ContactID, 0, len(adds)) | ||
| changed = append(changed, adds...) | ||
| changed = append(changed, removals...) | ||
|
|
||
| err = models.UpdateContactModifiedOn(ctx, db, changed) | ||
| if err != nil { | ||
| return 0, errors.Wrapf(err, "error updating contact modified_on after group population") | ||
| } | ||
|
|
||
| return len(new), nil | ||
| } |
This file contains 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,92 @@ | ||
| package search_test | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/lib/pq" | ||
| "github.com/nyaruka/gocommon/dbutil/assertdb" | ||
| "github.com/nyaruka/mailroom/core/models" | ||
| "github.com/nyaruka/mailroom/core/search" | ||
| "github.com/nyaruka/mailroom/testsuite" | ||
| "github.com/nyaruka/mailroom/testsuite/testdata" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestSmartGroups(t *testing.T) { | ||
| ctx, rt, db, _ := testsuite.Get() | ||
|
|
||
| defer testsuite.Reset(testsuite.ResetAll) | ||
|
|
||
| // insert an event on our campaign | ||
| newEvent := testdata.InsertCampaignFlowEvent(db, testdata.RemindersCampaign, testdata.Favorites, testdata.JoinedField, 1000, "W") | ||
|
|
||
| // clear Cathy's value | ||
| db.MustExec( | ||
| `update contacts_contact set fields = fields - $2 | ||
| WHERE id = $1`, testdata.Cathy.ID, testdata.JoinedField.UUID) | ||
|
|
||
| // and populate Bob's | ||
| db.MustExec( | ||
| fmt.Sprintf(`update contacts_contact set fields = fields || | ||
| '{"%s": { "text": "2029-09-15T12:00:00+00:00", "datetime": "2029-09-15T12:00:00+00:00" }}'::jsonb | ||
| WHERE id = $1`, testdata.JoinedField.UUID), testdata.Bob.ID) | ||
|
|
||
| oa, err := models.GetOrgAssetsWithRefresh(ctx, rt, testdata.Org1.ID, models.RefreshCampaigns|models.RefreshGroups) | ||
| assert.NoError(t, err) | ||
|
|
||
| mockES := testsuite.NewMockElasticServer() | ||
| defer mockES.Close() | ||
|
|
||
| es := mockES.Client() | ||
|
|
||
| mockES.AddResponse(testdata.Cathy.ID) | ||
| mockES.AddResponse(testdata.Bob.ID) | ||
| mockES.AddResponse(testdata.Bob.ID) | ||
|
|
||
| tcs := []struct { | ||
| Query string | ||
| ContactIDs []models.ContactID | ||
| EventContactIDs []models.ContactID | ||
| }{ | ||
| { | ||
| "cathy", | ||
| []models.ContactID{testdata.Cathy.ID}, | ||
| []models.ContactID{}, | ||
| }, | ||
| { | ||
| "bob", | ||
| []models.ContactID{testdata.Bob.ID}, | ||
| []models.ContactID{testdata.Bob.ID}, | ||
| }, | ||
| { | ||
| "unchanged", | ||
| []models.ContactID{testdata.Bob.ID}, | ||
| []models.ContactID{testdata.Bob.ID}, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range tcs { | ||
| err := models.UpdateGroupStatus(ctx, db, testdata.DoctorsGroup.ID, models.GroupStatusInitializing) | ||
| assert.NoError(t, err) | ||
|
|
||
| count, err := search.PopulateSmartGroup(ctx, db, es, oa, testdata.DoctorsGroup.ID, tc.Query) | ||
| assert.NoError(t, err, "error populating smart group for: %s", tc.Query) | ||
|
|
||
| assert.Equal(t, count, len(tc.ContactIDs)) | ||
|
|
||
| // assert the current group membership | ||
| contactIDs, err := models.ContactIDsForGroupIDs(ctx, db, []models.GroupID{testdata.DoctorsGroup.ID}) | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, tc.ContactIDs, contactIDs) | ||
|
|
||
| assertdb.Query(t, db, `SELECT count(*) from contacts_contactgroup WHERE id = $1 AND status = 'R'`, testdata.DoctorsGroup.ID). | ||
| Returns(1, "wrong number of contacts in group for query: %s", tc.Query) | ||
|
|
||
| assertdb.Query(t, db, `SELECT count(*) from campaigns_eventfire WHERE event_id = $1`, newEvent.ID). | ||
| Returns(len(tc.EventContactIDs), "wrong number of contacts with events for query: %s", tc.Query) | ||
|
|
||
| assertdb.Query(t, db, `SELECT count(*) from campaigns_eventfire WHERE event_id = $1 AND contact_id = ANY($2)`, newEvent.ID, pq.Array(tc.EventContactIDs)). | ||
| Returns(len(tc.EventContactIDs), "wrong contacts with events for query: %s", tc.Query) | ||
| } | ||
| } |
Oops, something went wrong.