base/modules/crm/crm_test.go

package crm_test

import (
	"strings"
	"testing"

	"github.com/hanzoai/base/core"
	"github.com/hanzoai/base/modules"
	"github.com/hanzoai/base/modules/crm"
	"github.com/hanzoai/base/tests"
	"github.com/hanzoai/base/tools/types"
)

var collections = []string{
	"companies", "people", "opportunities", "candidates", "applications", "segments",
	"lists", "list_members", "activities", "notes", "tasks", "attachments", "views",
}

func install(t *testing.T) *tests.TestApp {
	t.Helper()
	app, err := tests.NewTestApp()
	if err != nil {
		t.Fatal(err)
	}
	t.Cleanup(app.Cleanup)

	g, err := modules.Install(app, crm.Name)
	if err != nil {
		t.Fatalf("install: %v", err)
	}
	if strings.Join(g.Created, ",") != strings.Join(collections, ",") {
		t.Fatalf("created %v", g.Created)
	}
	return app
}

func TestTheModuleInstallsAndReinstallsAsNothing(t *testing.T) {
	app := install(t)

	g, err := modules.Install(app, crm.Name)
	if err != nil {
		t.Fatal(err)
	}
	if len(g.Created) != 0 || len(g.Grown) != 0 || len(g.Kept) != 0 {
		t.Fatalf("a second install must change nothing: %+v", g)
	}
}

func TestEveryFieldIsLabelled(t *testing.T) {
	app := install(t)

	history := map[string]bool{
		"people": true, "companies": true, "opportunities": true, "candidates": true,
		"applications": true, "notes": true, "tasks": true,
	}

	for _, name := range collections {
		c, err := app.FindCollectionByNameOrId(name)
		if err != nil {
			t.Fatal(err)
		}
		if c.Label == "" || c.Plural == "" || c.Icon == "" {
			t.Errorf("%s is not labelled: %q %q %q", name, c.Label, c.Plural, c.Icon)
		}
		if c.History != history[name] {
			t.Errorf("%s history = %v", name, c.History)
		}
		for _, f := range c.Fields {
			if f.GetName() == core.FieldNameId {
				continue
			}
			m := f.(core.FieldMetaHolder).Meta()
			if m.Label == "" || m.Icon == "" || m.Position == 0 {
				t.Errorf("%s.%s is not labelled: %+v", name, f.GetName(), *m)
			}
		}
		if c.Fields.GetByName("created_by") == nil || c.Fields.GetByName("updated_by") == nil {
			t.Errorf("%s does not record its writers", name)
		}
	}

	stage := mustCollection(t, app, "opportunities").Fields.GetByName("stage").(*core.SelectField)
	if len(stage.Options) != 5 || stage.Options[0].Color != "red" || stage.Options[4].Color != "yellow" {
		t.Errorf("the pipeline stages are not coloured: %+v", stage.Options)
	}
}

func mustCollection(t *testing.T, app core.App, name string) *core.Collection {
	t.Helper()
	c, err := app.FindCollectionByNameOrId(name)
	if err != nil {
		t.Fatal(err)
	}
	return c
}

func save(t *testing.T, app core.App, collection string, data map[string]any) *core.Record {
	t.Helper()
	r := core.NewRecord(mustCollection(t, app, collection))
	r.Load(data)
	if err := app.Save(r); err != nil {
		t.Fatalf("save %s: %v", collection, err)
	}
	return r
}

func TestThePipeline(t *testing.T) {
	app := install(t)

	acme := save(t, app, "companies", map[string]any{
		"name":           "Acme",
		"domain":         map[string]any{"primaryLinkUrl": "acme.test"},
		"annual_revenue": map[string]any{"amountMicros": 12_000_000_000_000, "currencyCode": "USD"},
	})
	ada := save(t, app, "people", map[string]any{
		"name":      map[string]any{"firstName": "Ada", "lastName": "Lovelace"},
		"emails":    map[string]any{"primaryEmail": "[email protected]"},
		"company":   acme.Id,
		"lifecycle": "lead",
	})
	deal := save(t, app, "opportunities", map[string]any{
		"name":    "Acme pilot",
		"amount":  map[string]any{"amountMicros": 50_000_000_000, "currencyCode": "USD"},
		"stage":   "meeting",
		"company": acme.Id,
		"contact": ada.Id,
	})

	got, err := app.FindRecordsByFilter("opportunities", `company.name = "Acme" && contact.emails.primaryEmail = "[email protected]"`, "", 0, 0)
	if err != nil || len(got) != 1 || got[0].Id != deal.Id {
		t.Fatalf("the deal is not reached through its company and contact: %v %v", got, err)
	}

	// a person's primary address is theirs alone
	dup := core.NewRecord(mustCollection(t, app, "people"))
	dup.Set("emails", types.Emails{PrimaryEmail: "[email protected]"})
	if err := app.Save(dup); err == nil {
		t.Fatal("a second person with the same primary email must be refused")
	}
}

func TestListsAndTheInListFilter(t *testing.T) {
	app := install(t)

	ada := save(t, app, "people", map[string]any{"name": map[string]any{"firstName": "Ada"}})
	bob := save(t, app, "people", map[string]any{"name": map[string]any{"firstName": "Bob"}})
	invitees := save(t, app, "lists", map[string]any{"name": "Invitees", "object": "people"})
	save(t, app, "list_members", map[string]any{"list": invitees.Id, "person": ada.Id, "source": "manual"})

	dup := core.NewRecord(mustCollection(t, app, "list_members"))
	dup.Load(map[string]any{"list": invitees.Id, "person": ada.Id})
	if err := app.Save(dup); err == nil {
		t.Fatal("a person may be on a list once")
	}

	in, err := app.FindRecordsByFilter("people", `list_members_via_person.list ?= {:list}`, "", 0, 0, map[string]any{"list": invitees.Id})
	if err != nil || len(in) != 1 || in[0].Id != ada.Id {
		t.Fatalf("in list: %v %v", in, err)
	}

	out, err := app.FindRecordsByFilter("people", `list_members_via_person.list != {:list}`, "", 0, 0, map[string]any{"list": invitees.Id})
	if err != nil || len(out) != 1 || out[0].Id != bob.Id {
		t.Fatalf("not in list: %v %v", out, err)
	}

	// deleting the list takes its members with it
	if err := app.Delete(invitees); err != nil {
		t.Fatal(err)
	}
	if left, _ := app.FindRecordsByFilter("list_members", "", "", 0, 0); len(left) != 0 {
		t.Fatalf("members outlived their list: %d", len(left))
	}
}

func TestAnActivityIsWrittenOncePerSource(t *testing.T) {
	app := install(t)

	ada := save(t, app, "people", map[string]any{"name": map[string]any{"firstName": "Ada"}})
	save(t, app, "activities", map[string]any{"kind": "email", "direction": "in", "source_id": "msg-1", "person": ada.Id})

	again := core.NewRecord(mustCollection(t, app, "activities"))
	again.Load(map[string]any{"kind": "email", "source_id": "msg-1", "person": ada.Id})
	if err := app.Save(again); err == nil {
		t.Fatal("a second activity from one source must be refused")
	}

	// activities with no source are not one another's duplicates
	save(t, app, "activities", map[string]any{"kind": "note", "person": ada.Id})
	save(t, app, "activities", map[string]any{"kind": "note", "person": ada.Id})
}

func TestSegmentsAndViewsHoldTheirFilters(t *testing.T) {
	app := install(t)

	where := map[string]any{"field": "lifecycle", "op": "is", "value": []any{"lead"}}
	seg := save(t, app, "segments", map[string]any{"name": "Leads", "object": "people", "where": where})
	view := save(t, app, "views", map[string]any{
		"name": "By stage", "object": "opportunities", "type": "kanban", "group_by": "stage",
		"where": where, "sorts": []any{map[string]any{"field": "close_date", "direction": "asc"}},
	})

	for _, r := range []*core.Record{seg, view} {
		got, err := app.FindRecordById(r.Collection(), r.Id)
		if err != nil {
			t.Fatal(err)
		}
		if !strings.Contains(got.GetString("where"), `"lifecycle"`) {
			t.Fatalf("%s lost its filter: %s", r.Collection().Name, got.GetString("where"))
		}
	}
}