Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

This refinement details the necessary changes for the search by phone to work in admin tool documented in Search customer by phone in Admin App .

...

  • Uses existing lookup record structure

  • Search will work with both phone numbers included in the order or in the user account

  • This solution will be compatible with the Phone OTP

  • Doesn’t require phone verification

  • Doesn’t require migration scripts, the search will work as long as the user has made one order after the feature release

...

  • A phone number can only be associated with a single customer, which will be the first one to inform the number on the platform

  • There isn’t a simple way to delete the link between an a user and a phone number recorded in a delivery order. One possibility is allowing customer support to remove the link via the support tool if it is outdated.

Implementation Proposal

The sequence diagram below represents one possible implementation of the solution where the responsibility of managing lookup records stay in the intl-users packages.

...

Search by phone

The search will be implemented in the users service API, the NPM user package (represented as intl-packages below) exposes the client that admin app will use to make this request.

...

Create phone lookup records

The creation of the lookup records can be either synchronous or asynchronous, the two diagrams below details the different approaches:

asynchronous: since the commit order operation is already slow, this option minimizes possibly making it slower. [PREFERRED]

...

synchronous: simpler implementation

...

POC

The code below creates lookup records if they don’t exist when the order is committed.

...

  1. Commit an order with delivery.dropoff.phoneNumber +222222

    image-20240118-155822.png

  2. Validate record in database

    image-20240118-160259.png

  3. Searching phone in support tool

    image-20240118-160837.png

  4. Customer details

    image-20240118-160929.png

Solution 2 [Preferred]

The solution Solution 2 uses the exact same strategy of as solution 1, the only difference is that it proposes to update the lookup record structure so that it can link multiple phone numbers to multiples multiple customers. Below is an a suggestion of the new record:

Note

We’ll need to implement checks to prevent the creation of multiple lookup records linking the same phone number and customer

Code Block
{
  pk: `phone_user#${cognitoId}`,
  pk2: `phone#${phoneNumber}`,
  sk: `createdAt#$`phone#${createdAtphoneNumber}`,
  sk2: 'createdAt#$phone_user#${createdAtcognitoId}',
}

With these changes, the search by phone will return a list of customers instead of a single one and avoid the problem of manual record deletion that solution 1 requires. However, the support tool front end will also have to be adapted so that customer support can choose which one they want to check, given the list of customers associated with that phone number. The front end design will have to be aligned with UI/UX team.

An important point is that customer support can differentiate which customer is the actual owner of the phone number. Phone verification is not enabled in Iberia right now, but the feature is expected to be activated in the following months.

Pros and cons

Pros

  • Search will work with both phone numbers included in the order or in the user account

  • Doesn’t require phone verification

  • This solution will be compatible with the Phone OTP

  • Doesn’t require migration scripts, the search will work as long as the user has made one order after the feature release

  • Allows the association of multiple phone numbers with multiple customers

...

  • Require the development of a new page in the support tool front end to select which customer they want to check

  • Although very unlikely, there is a scenario where a single phone number is linked to many customers and this might make the process to of finding the right one cumbersome

POC

SearchByPhone POC:

For this POC I changed the getByUserServiceLookup to use the proposed structure:

...

Code Block
public async getByUserServiceLookup(
  phoneNumber: string,
): Promise<IUserLookupByPhone[] | undefined> {
  const dynamoSearch = {
    ExpressionAttributeValues: {
      ':pk2': `phone_lookup#${phoneNumber}`,
      ':sk2': 'createdAt#',
    },
    IndexName: 'brand-index-2',
    KeyConditionExpression: 'pk2 = :pk2 AND begins_with(sk2, :sk2)',
    TableName: this.tableName,
  };

  const { Items } = await this.executeWithRetry(DynamoMethods.query, dynamoSearch);
  return Items ? Items.map((item) => cast(item, TUserLookupByPhone)) : undefined;
}

And created 4 lookup records for 2 customers:

...

and was able to find the two customers when searching for the phone number +123123123:

...

Distinguish verified number POC:

To explicitly display which user is verified, we need to:

  • return phoneVerified in the Customer query from backend

  • check verified numbers and compare them with the searched text in the result.

intl-admin-app/src/components/layout/universal-search/index.tsx

Code Block
languagetypescript
export const UniversalSearch = () => {
  ...
  return (
    <List>
      ...
      {searchResults.map((result) => {
        const customer = result as CustomerDetails;
        const { phoneVerified, phoneNumber } = customer;
        const isVerifiedUser = !!phoneVerified && searchTerm === phoneNumber;

        return (
          <SearchItem
            item={result}
            key={result.id}
            onClick={handleSearchResultSelection}
            isVerified={isVerifiedUser}
          />
        );
      }
    </List>
  )
}

The code alterations above, plus altering SearchItem to change the text if the phone is verified we get:

...

Task breakdown

[intl-user-service]

  1. Refactor user-lookup-by-phone.repository to use both “UserPhone” and “UserPhoneLookUp” records

    1. Since this impacts SA team, we need to ask their review as well

  2. Update the lookup record structure to enable associating multiple phones and users

  3. Develop create lookup records endpoint

  4. Develop find by phone endpoint

[intl-packages]

  1. Develop a method in intl-users that creates lookup records in via the new user endpoint

  2. Update the searchByPhone method to use the new User endpoint

[intl-whitelabel-graphql]

  1. Create lookup records in commitOrder

[intl-fulfillment-service]

  1. Create lookup records in commitOrder

[intl-admin-app]

  1. Update customer query to also search by phone

  2. Include search by phone in search bar

    1. include search by phone in use-universal-search hook

    2. add logic to explicitly show verified numbers