This discovery details the code changes necessary for the search by phone to work in admin tool, and is based on the solution n. 1 proposed in Search customer by phone in Admin App.

POC

Validate SA market solution

In

Result:

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

...

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

1. Searching by phone

   Image Added

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 .

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 Service API: Add a isPhoneNumberVerified field to lookupByPhoneNumber interface. This is important to avoid impacting https://rbictg.atlassian.net/wiki/spaces/EGMT/pages/4329078785/Solution+Phone+Number+Authentication+for+BK+SA#Customer-support-tool

• 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).

This changes are already implemented in this git branch: https://github.com/rbilabs/intl-packages/pull/961

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

These main changes are implemented in this git branch: https://github.com/rbilabs/intl-admin-app/pull/242