Caller id match #156

esme · 2023-11-09T00:05:10Z

Description

Jira Ticket: CALL-3993

Merge Checklist

Q	A
Adds Documentation?	yes
Any Dependency Changes?
Patch: Bug Fix?
Minor: New Feature?
Major: Breaking Change?

BRAVE Checklist

I have read the BRAVE checklist and confirmed if the following is necessary.

Q	A
Backwards Compatible?	yes
Rollout/Rollback Plan?
Automated test coverage?
Verified that changes work?
Expect Dependencies to Fail?

github-actions · 2023-11-09T00:06:00Z

PR Preview Action v1.4.4
🚀 Deployed preview to https://HubSpot.github.io/calling-extensions-sdk/pr-preview/pr-156/
on branch `gh-pages` at 2023-11-10 21:59 UTC

esme · 2023-11-09T00:16:34Z

demos/demo-minimal-js/index.js

@@ -3,10 +3,12 @@ import { errorType, callEndStatus } from "../../src/Constants";
 // import CallingExtensions, { Constants } from "@hubspot/calling-extensions-sdk";
 // const { errorType, callEndStatus } = Constants;

-const state = {
+export const state = {


Expose state to the window object so that we can change any of the properties such as fromNumber before sending an event in the Demo Widget. For our acceptance tests, we should create an engagement state and call state to display in the UI like how we are doing so in the Mock UI.

I would export it with a more definitive name. state is too generic. Thoughts?

Sure, do you have any suggestions for the name - maybe engagementState? This is only exported in the demo-minimal-js iframe so we won't be seeing a conflict with any variables in the parent window

We could also implement getters and setters here

If the scope is minimal, i am fine. But, are we making updates to state properties? If yes, then it would be better if we have function to return initial state. So, we dont have accidental leaks.

Yeah it's a minimal scope right now. Since we're not persisting the state across mounts, any changes to state properties would only affect the demo minimal js widget until we unmount the component.

esme · 2023-11-09T00:19:16Z

src/CallingExtensions.js

+  logDebugMessage(message) {
+    this.iFrameManager.logDebugMessage(prefix, "Console Debug", message);
+  }


Used Console Debug to differentiate this message from HS and Third Party events as I couldn't think of another identifier. Feel free to throw suggestions

Console Debug can be confusing. May be 'CallExt Debug'.

Oops. I dint see the prefix defined already. Isnt prefix sufficient enough to differentiate?

The prefix is used in other messages as well

this.logDebugMessage(prefix, "To HubSpot", type, message); this.logDebugMessage(prefix, "From HubSpot", type, { data });

Hmmm. May be, we can add provider name here. Like aircall, justcall. would that be of help?

We're using logDebugMessage in demo minimal js to log an incoming contact and leveraging the prefix to filter out Calling Extensions messages. However, since this isn't a message event to or from HubSpot, I'm thinking that something like Debug would be useful for knowing the purpose of the logging.

This message wouldn't show up in any other apps unless they were to use logDebugMessage() as well and in such cases, I'm not sure if the provider name would be helpful.

README.md

jmp3833

I'll defer to @hemang-thakkar for a code level review. All besides potentially dropping callId from the message body LGTM

esme · 2023-11-09T21:33:14Z

demos/demo-minimal-js/index.js

+        cti.logDebugMessage({
+          message: `Incoming call from ${state.incomingContactName} ${state.fromNumber}`,
+          type: `${callerIdMatches.length} Caller ID Matches`,
+        });
+        return;
+      }
+      cti.logDebugMessage({
+        message: `Incoming call from ${state.fromNumber}`,
+        type: "No Caller ID Matches",
+      });
+    },
+    onCallerIdMatchFailed: (data, rawEvent) => {
+      cti.logDebugMessage({
+        message: `Incoming call from ${state.fromNumber}`,
+        type: "Caller ID Match Failed",
+      });


@hemang-thakkar Added an argument to log messages with a custom type that would be more useful for debugging.

esme · 2023-11-09T21:36:15Z

PR Preview Action v1.4.4
🚀 Deployed preview to https://HubSpot.github.io/calling-extensions-sdk/pr-preview/pr-156/
on branch gh-pages at 2023-11-09 21:32 UTC

@hemang-thakkar FYI you can install the demo widget using the preview link to test within the Calling Popover

* Create incoming call method to test inbound calling (#130) * Create incoming call started method to test inbound calling * Introduce inbound calling availability events (#138) * Refactor constants * Refactor version constant * 0.1.6-alpha.0 * Remove sdkVersion prop from initialized event * 0.1.6-alpha.1 * Introduce inbound calling availability events * Test new events * Configure prettier and format the demo-minimal-js html. Improve accessibility and SEO. * Use semantic html and style buttons * Refactor switch case into onclick methods and remove logic that waits for DOM content loaded since we are using defer to load the JS * Rename id * Specify encoding * Match SDK event name * sort props * Initialize as logged out * Add user availability events * Prevent window overflow * Allow user to change availability during a call. * disable availability buttons during a call. * 0.1.7-alpha.0 * Use new alpha version * Send incoming call event with data to create an engagement (#140) Create event handlers for create_engagement_succeeded and create_engagement_failed * Add to number for inbound calling * Initialize demo widget when ready event is received from HubSpot (#145) * Initialize SDK on ready event * Save userAvailable state in the demo widget * Allow user to start an incoming call asynchronously for testing (#146) * Revert "Initialize demo widget when ready event is received from HubSpot (#145)" (#147) This reverts commit 4aa4ff6. * Extensions inbound lifecycle (#148) * Initialize SDK on ready event * Save userAvailable state in the demo widget * Allow user to start an incoming call asynchronously for testing (#146) * Revert "Allow user to start an incoming call asynchronously for testing (#146)" This reverts commit 9800470. --------- Co-authored-by: Esme Ling <esmelingyr@gmail.com> Co-authored-by: Esme <23175119+esme@users.noreply.github.com> * 0.1.8-alpha.0 * Use next tag of SDK * 0.2.1-alpha.0 * Use latest sdk version * Caller id match (#156) * Add events for caller id matching * Add caller id match payload * Add debugMessageType argument to logging * Add incomingCall event handler to README * Log last sync event * 0.2.1-alpha.1 * Use next tag of SDK * 0.2.1-alpha.2 * Use next tag of SDK * Add support for inbound calling to react demo app (#157) * Add support for inbound calling to react demo app * Add unit tests for Incoming Screen * Unit tests * Fix useCti hook to store incomingNumber * Feedback fixes # 1 * Feedback fixes #2 * Feedback fixes * Add publish script for inbound branch (#162) * Send navigate_to_record event when we receive an existing call id (#158) * Send navigate_to_record event when we receive an existing call id * Fix console debug message const * Navigate to record page in the react demo app (#165) * Update README with instructions for redirect * 0.2.1-alpha.3 * Use next tag of SDK * Configure workflow to run on workflow_dispatch event * React Demo App: Set incoming number and contact name in localstorage (#166) * React Demo App: Set incoming number and contact info in localstorage on redirect * feedback fixes * 0.2.2-alpha.0 * 0.2.2-beta.0 * Support NAVIGATE_TO_RECORD_FAILED event (#171) * switch case lost its case to dictionary * Handle NAVIGATE_TO_RECORD_FAILED * Add event handler to demos * Remove unused message handler * Restore master version * 0.3.0-0 * 0.3.0-rc.0 * 0.3.0-alpha.0 * 0.3.0-beta.0 * Update dependents * Add error to message types (#173) * Restore alpha version before bumping * 0.3.0-alpha.1 * 0.3.0-alpha.2 * Update dependents * 0.3.0-beta.0 * 0.3.0-beta.1 * Bump sdk version to 0.3.0-beta.1 in demos * removing empty tag from preview.yml * Add beta badge to incoming call, availability toggles (#179) * Add beta badge to incoming call, availability toggles * code review feedback * fix unit tests * Simplify formatting * Simplify formatting * fix height for react demo app * Simplify README.md (#177) * Simplify README.md * Update link --------- Co-authored-by: Esme <23175119+esme@users.noreply.github.com> Co-authored-by: Esme Ling <esmelingyr@gmail.com> Co-authored-by: hemang-thakkar <59508898+hemang-thakkar@users.noreply.github.com> Co-authored-by: hthakkar <hthakkar@hubspot.com>

Add events for caller id matching

87cf72d

esme requested a review from a team as a code owner November 9, 2023 00:05

esme changed the base branch from master to proj-inbound-calling November 9, 2023 00:05

Remove console logs

9194701

esme commented Nov 9, 2023

View reviewed changes

esme requested review from hemang-thakkar and jmp3833 November 9, 2023 00:21

Add caller id match payload

3ee317f

jmp3833 reviewed Nov 9, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jmp3833 reviewed Nov 9, 2023

View reviewed changes

esme added 2 commits November 9, 2023 11:05

Drop callId from the payload

bfd0568

Add debugMessageType argument to logging

6bb43d2

esme commented Nov 9, 2023

View reviewed changes

esme added 2 commits November 10, 2023 12:38

Add incomingCall event handler to README

c58fe05

Log last sync event

b328699

esme requested a review from jmp3833 November 14, 2023 18:33

esme merged commit 928f8e2 into proj-inbound-calling Nov 14, 2023
1 check passed

esme deleted the caller-id-match branch November 14, 2023 18:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Caller id match #156

Caller id match #156

esme commented Nov 9, 2023 •

edited

Loading

github-actions bot commented Nov 9, 2023 •

edited

Loading

esme Nov 9, 2023

hemang-thakkar Nov 9, 2023

esme Nov 9, 2023 •

edited

Loading

esme Nov 9, 2023

hemang-thakkar Nov 9, 2023

esme Nov 9, 2023

esme Nov 9, 2023

hemang-thakkar Nov 9, 2023

hemang-thakkar Nov 9, 2023

esme Nov 9, 2023

hemang-thakkar Nov 9, 2023

esme Nov 9, 2023

jmp3833 left a comment

esme Nov 9, 2023

esme commented Nov 9, 2023

Caller id match #156

Caller id match #156

Conversation

esme commented Nov 9, 2023 • edited Loading

Description

Merge Checklist

github-actions bot commented Nov 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

esme Nov 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmp3833 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

esme commented Nov 9, 2023

esme commented Nov 9, 2023 •

edited

Loading

github-actions bot commented Nov 9, 2023 •

edited

Loading

esme Nov 9, 2023 •

edited

Loading