fix(orderscollectionquery): Corrects syntax for querying for searchTerm (#11575)

Author: kfc35

migrations/20260324155640-add-orders-textual-search-indexes.ts

@@ -0,0 +1,63 @@
+'use strict';
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface) {
+    await queryInterface.sequelize.query(`
+      drop index concurrently if exists "Orders_data_fromAccountInfo_name_search_idx";
+    `);
+    await queryInterface.sequelize.query(`
+      drop index concurrently if exists "Orders_data_fromAccountInfo_email_search_idx";
+    `);
+
+    await queryInterface.sequelize.query(`
+      create index concurrently if not exists "Orders_data_fromAccountInfo_name_search_idx"
+      on "Orders" using gist(("data"#>>'{fromAccountInfo,name}') gist_trgm_ops)
+      include (
+          description,
+          tags,
+          id,
+          "SubscriptionId",
+          "createdAt",
+          "CollectiveId",
+          "FromCollectiveId",
+          "CreatedByUserId",
+          "status",
+          "TierId",
+          "interval",
+          "totalAmount",
+          "currency",
+          "PaymentMethodId",
+          "deletedAt"
+      );
+    `);
+
+    await queryInterface.sequelize.query(`
+      create index concurrently if not exists "Orders_data_fromAccountInfo_email_search_idx"
+      on "Orders" using gist(("data"#>>'{fromAccountInfo,email}') gist_trgm_ops)
+      include (
+        description,
+          tags,
+          id,
+          "SubscriptionId",
+          "createdAt",
+          "CollectiveId",
+          "FromCollectiveId",
+          "CreatedByUserId",
+          "status",
+          "TierId",
+          "interval",
+          "totalAmount",
+          "currency",
+          "PaymentMethodId",
+          "deletedAt"
+          );
+    `);
+  },
+
+  async down() {
+    console.log(
+      'Not rolling back, re-create the "Orders_data_fromAccountInfo_name_search_idx" and "Orders_data_fromAccountInfo_email_search_idx" indexes manually if needed',
+    );
+  },
+};

server/graphql/v2/query/collection/OrdersCollectionQuery.ts

@@ -517,8 +517,8 @@ export const OrdersCollectionResolver = async (args: OrdersCollectionArgsType, r
 
               ors.push(eb('Orders.description', 'ilike', `%${args.searchTerm}%`));
               ors.push(eb(sql`"Orders".data->>'ponumber'`, 'ilike', `%${args.searchTerm}%`));
-              ors.push(eb(sql`"Orders".data->>'{fromAccountInfo,name}'`, 'ilike', `%${args.searchTerm}%`));
-              ors.push(eb(sql`"Orders".data->>'{fromAccountInfo,email}'`, 'ilike', `%${args.searchTerm}%`));
+              ors.push(eb(sql`"Orders".data#>>'{fromAccountInfo,name}'`, 'ilike', `%${args.searchTerm}%`));
+              ors.push(eb(sql`"Orders".data#>>'{fromAccountInfo,email}'`, 'ilike', `%${args.searchTerm}%`));
               ors.push(
                 eb('Orders.tags', '&&', sql<string[]>`ARRAY[${args.searchTerm.toLocaleLowerCase()}]::varchar[]`),
               );

test/server/graphql/v2/collection/OrdersCollectionQuery.test.ts

@@ -24,6 +24,7 @@ const ordersQuery = gql`
     $includeHostedAccounts: Boolean
     $accountingCategory: [String]
     $createdBy: [AccountReferenceInput]
+    $searchTerm: String
   ) {
     orders(
       account: $account
@@ -34,6 +35,7 @@ const ordersQuery = gql`
       includeHostedAccounts: $includeHostedAccounts
       accountingCategory: $accountingCategory
       createdBy: $createdBy
+      searchTerm: $searchTerm
     ) {
       totalCount
       nodes {
@@ -928,6 +930,59 @@ describe('server/graphql/v2/collection/OrdersCollectionQuery', () => {
     });
   });
 
+  describe('searchTerm argument', () => {
+    let collective, user1, user2, order1, order2;
+
+    before(async () => {
+      collective = await fakeCollective();
+
+      // Create users with specific names for search testing
+      user1 = await fakeUser(null, { name: 'Alice Anderson' });
+      user2 = await fakeUser(null, { name: 'Bob Builder' });
+
+      // Create orders by different users
+      order1 = await fakeOrder({
+        CollectiveId: collective.id,
+        FromCollectiveId: user1.CollectiveId,
+        CreatedByUserId: user1.id,
+        status: OrderStatuses.PAID,
+      });
+
+      order2 = await fakeOrder({
+        CollectiveId: collective.id,
+        FromCollectiveId: user2.CollectiveId,
+        CreatedByUserId: user2.id,
+        status: OrderStatuses.PAID,
+      });
+    });
+
+    it("should return the order when the search term matches a user's name", async () => {
+      const result = await graphqlQueryV2(ordersQuery, {
+        account: { legacyId: collective.id },
+        filter: 'INCOMING',
+        searchTerm: 'Alice',
+      });
+
+      expect(result.errors).to.not.exist;
+      expect(result.data.orders.totalCount).to.eq(1);
+      const orderIds = result.data.orders.nodes.map(node => node.legacyId);
+      expect(orderIds).to.include(order1.id);
+    });
+
+    it("should return the order when the search term matches a user's email", async () => {
+      const result = await graphqlQueryV2(ordersQuery, {
+        account: { legacyId: collective.id },
+        filter: 'INCOMING',
+        searchTerm: user2.email,
+      });
+
+      expect(result.errors).to.not.exist;
+      expect(result.data.orders.totalCount).to.eq(1);
+      const orderIds = result.data.orders.nodes.map(node => node.legacyId);
+      expect(orderIds).to.include(order2.id);
+    });
+  });
+
   describe('createdByUsers resolver', () => {
     let collective, childAccount, user1, user2, user3;
 

test/test-helpers/fake-data.ts

@@ -736,7 +736,8 @@ export const fakeOrder = async (
 ) => {
   const CreatedByUserId = orderData.CreatedByUserId || (await fakeUser()).id;
   const user = await models.User.findByPk(<number>CreatedByUserId);
-  const FromCollectiveId = orderData.FromCollectiveId || (await models.Collective.findByPk(user.CollectiveId)).id;
+  const fromCollective = await models.Collective.findByPk(user.CollectiveId);
+  const FromCollectiveId = orderData.FromCollectiveId || fromCollective.id;
   const collective = orderData.CollectiveId
     ? await models.Collective.findByPk(orderData.CollectiveId)
     : await fakeCollective();
@@ -745,6 +746,13 @@ export const fakeOrder = async (
     : withTier
       ? await fakeTier()
       : null;
+  const data = {
+    ...orderData.data,
+    fromAccountInfo: {
+      name: fromCollective.name,
+      email: user.email,
+    },
+  };
 
   const order: Order & {
     subscription?: typeof Subscription;
@@ -759,6 +767,7 @@ export const fakeOrder = async (
     CreatedByUserId,
     FromCollectiveId,
     CollectiveId: collective.id,
+    data,
   });
 
   if (order.PaymentMethodId) {