feat: PPT-54 Add full text search capabilities to guest model (#278)

Author: naqvis

migration/db/migrations/202412311046000_alter_guests_add_tsvector_field.sql

@@ -0,0 +1,50 @@
+-- +micrate Up
+-- SQL in section 'Up' is executed when this migration is applied
+
+-- +micrate StatementBegin
+CREATE OR REPLACE FUNCTION tsv_search_tsvector_update() RETURNS TRIGGER LANGUAGE plpgsql AS $$
+BEGIN
+    NEW.tsv_search := to_tsvector('simple',
+        regexp_replace(
+            COALESCE(NEW.email, '') || ' ' ||
+            COALESCE(NEW.name, '') || ' ' ||
+            COALESCE(NEW.preferred_name, '') || ' ' ||
+            COALESCE(NEW.organisation, '') || ' ' ||
+            COALESCE(NEW.phone, '') || ' ' ||
+            COALESCE(NEW.id::TEXT, ''),
+            '[@._]', ' ', 'g'
+        ) || ' ' ||
+        COALESCE(NEW.email, '')
+    );
+    RETURN NEW;
+END $$;
+-- +micrate StatementEnd
+
+ALTER TABLE guests ADD COLUMN tsv_search tsvector DEFAULT ''::tsvector;
+
+CREATE INDEX idx_tsv_search ON guests USING gin(tsv_search);
+
+UPDATE guests
+SET tsv_search = to_tsvector('simple',
+    regexp_replace(
+        COALESCE(email, '') || ' ' ||
+        COALESCE(name, '') || ' ' ||
+        COALESCE(preferred_name, '') || ' ' ||
+        COALESCE(organisation, '') || ' ' ||
+        COALESCE(phone, '') || ' ' ||
+        COALESCE(id::TEXT, ''),
+        '[@._]', ' ', 'g'
+    ) || ' ' ||
+    COALESCE(email, '')
+);
+
+CREATE TRIGGER tsv_search_trigger BEFORE INSERT OR UPDATE ON guests
+FOR EACH ROW EXECUTE FUNCTION tsv_search_tsvector_update();
+
+-- +micrate Down
+-- SQL section 'Down' is executed when this migration is rolled back
+
+DROP TRIGGER IF EXISTS tsv_search_trigger ON guests;
+DROP FUNCTION IF EXISTS tsv_search_tsvector_update();
+DROP INDEX IF EXISTS idx_tsv_search;
+ALTER TABLE guests DROP COLUMN IF EXISTS tsv_search;

spec/guest_spec.cr

@@ -0,0 +1,42 @@
+require "./helper"
+
+module PlaceOS::Model
+  describe Guest do
+    Spec.after_each do
+      Guest.clear
+    end
+
+    it "can search via tsquery" do
+      tenant = get_tenant
+      Guest.create!(
+        id: 1_i64,
+        tenant_id: tenant.id,
+        email: "john.doe@example.com",
+        name: "John Doe",
+        preferred_name: "Johnny",
+        organisation: "Example Org",
+        phone: "1234567890"
+      )
+
+      Guest.create!(
+        id: 2_i64,
+        tenant_id: tenant.id,
+        email: "jane.doe@example.com",
+        name: "Jane Doe",
+        organisation: "Another Org",
+        phone: "0987654321"
+      )
+
+      results = Guest.where("tsv_search @@ to_tsquery('simple', 'john & example')").all
+      results.size.should eq 1
+      results.first.id.should eq 1
+
+      results = Guest.where("tsv_search @@ to_tsquery('simple', 'jane')").all
+      results.size.should eq 1
+      results.first.id.should eq 2
+
+      results = Guest.where("tsv_search @@ to_tsquery('simple', 'example')").all
+      results.size.should eq 2
+    end
+  end
+end

src/placeos-models/guest.cr

@@ -37,19 +37,6 @@ module PlaceOS::Model
       dependent: :destroy
     )
 
-    # Save searchable information
-    before_save do
-      @email = email.strip.downcase
-      @searchable = String.build do |sb|
-        sb << email
-        sb << " #{name}" if name_assigned?
-        sb << " #{preferred_name}" if preferred_name_assigned?
-        sb << " #{organisation}" if organisation_assigned?
-        sb << " #{phone}" if phone_assigned?
-        sb << " #{id}" if id_assigned?
-      end.downcase
-    end
-
     def change_extension_data(data : JSON::Any)
       @extension_data = data
       @extension_data_changed = true