...
...
...
Table of Contents
| Table of Contents |
|---|
Open questions
Business Questions
Is there a business rule that demands that only verified phone numbers can be used in customer search?
Business Answers
Tech Questions
Why do two different Interfaces for lookupByPhone records exist? (one in
user-serviceand another inintl-packages)Does accessing user-service phone lookup records from intl-packages violate the current architecture?
Since Admin App is not using Launch Darkly, does it have a strategy defined for Feature Toggles?
Tech Answers
...
This is legacy from US, and neither of them are used today, since sign up via phone is disabled in international.
...
Table of Contents
| Table of Contents |
|---|
...
Business problem
This feature aims to implement the option to search for customers by phone in RBI Admin tool. This was a business request from Iberia (
| Jira Legacy | ||
|---|---|---|
|
...
|
Tech Discovery
Architecture AS-IS
Today, Admin Tool only has the option to search customers by email or Cognito ID. The search by email is exemplified by the following sequence diagram.
...
The most direct solution is using intl-packages, which already exposes a method to search users by phone number and DynamoDB queries for userLookupByPhone records associating phone numbers to Cognito IDs. However, there is a divergence between the records created using intl-packages and the ones created by user-service, as can be seen below:
intl-packages:
| Code Block | ||
|---|---|---|
| ||
{
pk: phoneNumber,
pk2: cognitoId,
sk: current/user-lookup-by-phone
sk2: current/user-lookup-by-phone/{date}
} |
user-service:
| Code Block | ||
|---|---|---|
| ||
{
pk: phone#${phoneNumber},
pk2: phone_user#${cognitoId},
sk: v0_UserPhone,
sk2: v0_UserPhoneUserPhoneLookUp,
} |
The user-service record is created when a user verifies their phone number via SMS. As far as we can tell, no one is using intl-packages lookup records since its only reference is its own test.
...
| Note |
|---|
Orders made using Call Center won’t appear in the customer history, since they are registered under the Call Center operator account. |
Proposed solution n. 1 - DEPRECATED
Add the option in intl-packagesto search users by phone number, and change user-service API to create/update lookupByPhoneNumber records whenever there are changes in the customer's phone number.
...
It’s important to notice that since lookupByPhoneNumber records haven’t been created for existing users, a script will have to be developed to scan all users in DynamoDB and create their associated lookup records.
Necessary changes - summary
User Service API: Adapt GET user endpoint to also search by phone number
User Service API: Adapt the
createmethod in user service to create alookupByPhoneNumberrecord if a phone number is informedUser Service API: Adapt
update-userlambda to update or create alookupByPhoneNumberrecord if the phone number changedUser Service API: Add a
isPhoneNumberVerifiedfield tolookupByPhoneNumberinterface. This is important to avoid impacting https://rbictg.atlassian.net/wiki/spaces/EGMT/pages/4329078785/Solution+Phone+Number+Authentication+for+BK+SA#Customer-support-toolUser packages: Change
getByPhoneNumberto use User Service API instead of directly accessing the databaseAdmin 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
lookupByPhoneNumberfor existing customers
Diagrams
Search customer by phone sequence diagram:
...
Necessary changes - details
intl-user-service
Include the
isVerifiedfield inIUserLookupByPhoneInterface: https://github.com/rbilabs/intl-user-service/blob/master/src/users/user-lookup-by-phone.repository.ts#L25-L30
| Code Block |
|---|
export interface IUserLookupByPhone {
pk: string;
pk2: string;
sk: string;
sk2: string;
isVerified: boolean;
} |
Create
lookupByPhoneNumberrecord after creating the user in dynamo inside thepre-signuplambda, but only if a phone number is informed: https://github.com/rbilabs/intl-user-service/blob/master/src/cognito-lambdas/pre-signup.service.ts#L135Update the
lookupByPhoneNumberrecord 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#L150Adapt the get user endpoint to have an
phoneNumberquery field, that searches by phone: https://github.com/rbilabs/intl-user-service/blob/master/src/users/users.controller.ts#L124
intl-packages
Create the option to search
lookupByPhonerecords created byuser-serviceusing the endpoint. Currently,getByEmailalready 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
searchByPhonemethod exposed by intl-packagesUpdate 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
However, Admin App currently doesn’t use Launch Darkly, which makes it harder to control the feature activation for different markets and makes it riskier. Possible alternatives are:
...
Pros
...
Cons
...
Add and configure Launch Darkly in Admin App
...
Easy and quick FT management
Adhere to the pattern used in many other RBI repositories
...
High effort
...
Implement FT using environment variables
...
Medium effort
...
FT management requires that a Developer updates the CircleCI configuration and redeploys the app
An excessive number of env vars might be necessary
...
Only display the search by phone option in Iberia market
...
Low effort
...
Activation in other markets will require code changes
Once activated in an environment, can only be deactivated via hotfix or waiting for the normal Lifecycle
...
We could take advantage from the development done for SA market in
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
However, this would still require existing customer to update their phone number for the search to work. This problem could be solved if we automatically update the user’s phone number with purchases. This can be done every time or only if they haven’t registered a phone.
| Info |
|---|
PROS:
|
| Note |
|---|
CONS:
|
Rule on when and how to save the phone number need to be defined
Proposed solution n. 2 - APPROVED
Using the Call Center solution to search orders by delivery phone. The search will return a list of orders using the given phone number, and they might come from multiple customer. One solution is to present this list of customers for the support team to decide which one they want to use.
...
This solution has the added bonus that if a phone number is associated to several phone number, that is probably a possible sign of a problem or even fraud.
| Info |
|---|
PROS: The operator of the Admin tool can see all customers associated with a phone number. |
| Note |
|---|
CONS:
|