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 .

...

Pros and cons

Pros

• Uses existing lookup record structure

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

• 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

...

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

   

2. Validate record in database
   

   

3. Searching phone in support tool
   

   

4. Customer details
   

   

Validate SA market solution

In

Result:

After confirming that SA market is deployed in eu-central-1 AWS Region, I could find user records created in Dynamo indexed by phone:

...

With this information, I was able to validate that the search could work in admin app:

1. Searching by phone
   

   Image Removed

2. Result

...

Code changes

In this section are listed the changes made for this validation in intl-packages and intl-admin-app repositories.

intl-packages:

users.ts:

  public getByPhoneNumber(
    phoneNumber: string,
    searchByUserServiceLookup = false,
  ): Promise<IUserItem | undefined> {
    return searchByUserServiceLookup
      ? this.usersDynamo.getByUserServicePhoneLookup(phoneNumber)
      : this.usersDynamo.getByPhoneNumber(phoneNumber);
  }

users-dynamo.ts:

  public async getByUserServicePhoneLookup(phoneNumber: string): Promise<IUserItem | undefined> {
    const lookupItem = await this.userLookupByPhone.getByUserServiceLookup(phoneNumber);
    if (lookupItem) {
      if (lookupItem) {
        const cognitoId = lookupItem.pk;
        const user = await this.getById(cognitoId);
        return user;
      }
    }
    return undefined;
  }

user-lookup-by-phone:

  public async getByUserServiceLookup(
    phoneNumber: string,
  ): Promise<IUserLookupByPhone | undefined> {
    const dynamoSearch = {
      ExpressionAttributeValues: {
        ':pk2': this.createUserServicePk(phoneNumber),
        ':sk2': this.createUserServiceSk(),
      },
      IndexName: 'brand-index-2',
      KeyConditionExpression: 'pk2 = :pk2 AND begins_with(sk2, :sk2)',
      TableName: this.tableName,
    };

    const { Items } = await this.executeWithRetry(DynamoMethods.query, dynamoSearch);
    const Item = Items?.[0];
    return Item ? cast(Item, TUserLookupByPhone) : undefined;
  }

intl-admin-app

The changes can be found in https://github.com/rbilabs/intl-admin-app/pull/242 .

Validate phone number updates

The user search, either by phone or emails, depends on the pk2 value of the user record in dynamo that necessarily has to have a phone number or an email, for example:

phone number:

...

email:

...

Therefore, we can only search a customer by phone number or email, but not both. Besides this issue, another problem is the update of the phone number. Today the change would only be reflected in user.details.phoneNumber and not in pk2 (check code below), which leads to the search by phone only working with the first number registered.

user-lookup-by-phone.repository.ts (https://github.com/rbilabs/intl-user-service/blob/master/src/users/user-lookup-by-phone.repository.ts#L103-L125)

  public async update(updatedUser: IUser): Promise<void> {
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    const { cognitoId, ...userItem } = updatedUser;

    let updateExpressions = DynamoDB.getUpdateExpressions(userItem);

    updateExpressions = {
      ...updateExpressions,
      ExpressionAttributeValues: {
        ...updateExpressions.ExpressionAttributeValues,
        [':phoneNumber']: updatedUser.details.phoneNumber,
      },
    };

    await this.dynamoClient
      .update({
        ...updateExpressions,
        ConditionExpression: '#details.phoneNumber = :phoneNumber',
        Key: { pk: updatedUser.cognitoId, sk: this.createSk() },
        TableName: this.tableName,
      })
      .promise();
  }

Deprecated

Necessary changes - summary

...

User Service API: Adapt GET user endpoint to also search by phone number

...

User Service API: Adapt the create method in user service to create a lookupByPhoneNumber record if a phone number is informed

...

User Service API: Adapt update-user lambda to update or create a lookupByPhoneNumber record if the phone number changed

...

User packages: Change getByPhoneNumber to use User Service API instead of directly accessing the database

...

Admin App Backend: Create a GraphQL query to request customers by phone number

...

Admin App Frontend: Add the option to search customers by phone using the new query

...

DynamoDB: Develop a migration script to create lookupByPhoneNumber for existing customers

Diagrams

Search customer by phone sequence diagram:

...

Necessary changes - details

intl-user-service

1. Include the isVerified field in IUserLookupByPhone Interface: https://github.com/rbilabs/intl-user-service/blob/master/src/users/user-lookup-by-phone.repository.ts#L25-L30

export interface IUserLookupByPhone {
  pk: string;
  pk2: string;
  sk: string;
  sk2: string;
  isVerified: boolean;
}

2. Create lookupByPhoneNumber record after creating the user in dynamo inside the pre-signup lambda, but only if a phone number is informed: https://github.com/rbilabs/intl-user-service/blob/master/src/cognito-lambdas/pre-signup.service.ts#L135

3. Update the lookupByPhoneNumber record if an user update is triggered and includes the phone number: https://github.com/rbilabs/intl-user-service/blob/master/src/users/update-comm-pref.service.ts#L150

4. Adapt the get user endpoint to have an phoneNumber query field, that searches by phone: https://github.com/rbilabs/intl-user-service/blob/master/src/users/users.controller.ts#L124

5. Create a LaunchDarkly Flag and request it via a backend query (https://github.com/rbilabs/intl-admin-app/blob/master/src/remote/queries/launch-darkly.ts )

intl-packages

• Create the option to search lookupByPhone records created by user-service using the endpoint. Currently, getByEmail already works this way (https://github.com/rbilabs/intl-packages/blob/master/packages/users/src/users.ts#L359).

...

intl-admin-app

• Create a GraphQL query that uses the searchByPhone method exposed by intl-packages

• Update the UI to display the search by phone number option

...

Solution 2

The solution 2 uses the exact same strategy of 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 customers. Below is an suggestion of the new record:

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

With these changes the search by phone will return a list of customers instead of 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.

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

• 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

Cons

• Require the development of a new page in 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 finding the right one cumbersome