chore: combine signer allow api with oauthInitiated track

Author: lwin-kyaw

src/helpers/citadelUtils.ts

@@ -4,6 +4,11 @@ import { get, put } from "@toruslabs/http-helpers";
 import { RetrieveSharesParams } from "../interfaces";
 import { isNullOrUndefined } from "./common";
 
+export enum CitadelAllowParamsSetOrUnsetFlag {
+  SET = 1,
+  UNSET = 0,
+}
+
 export interface CitadelAuthFlowAuditParams {
   oauthInitiated?: boolean;
   oauthVerified?: boolean;
@@ -12,14 +17,20 @@ export interface CitadelAuthFlowAuditParams {
   oauthFailed?: boolean;
 }
 
-export interface CitadelAllowParams extends CitadelAuthFlowAuditParams {
+export interface CitadelAllowParams {
   buildEnv: BUILD_ENV_TYPE;
   verifier: string;
   verifierId: string;
   network: string;
   clientId: string;
   recordId: string;
   source?: string;
+  // flags for auditing the auth flow
+  oauthInitiated?: CitadelAllowParamsSetOrUnsetFlag;
+  oauthVerified?: CitadelAllowParamsSetOrUnsetFlag;
+  oauthCompleted?: CitadelAllowParamsSetOrUnsetFlag;
+  oauthVerificationFailed?: CitadelAllowParamsSetOrUnsetFlag;
+  oauthFailed?: CitadelAllowParamsSetOrUnsetFlag;
 }
 
 export interface CitadelAuditParams extends CitadelAuthFlowAuditParams {

src/helpers/nodeUtils.ts

@@ -27,7 +27,7 @@ import {
 import log from "../loglevel";
 import { Some } from "../some";
 import { TorusUtilsExtraParams } from "../TorusUtilsExtraParams";
-import { callAllowApi } from "./citadelUtils";
+import { callAllowApi, CitadelAllowParamsSetOrUnsetFlag } from "./citadelUtils";
 import {
   base64ToBytes,
   bigintToHex,
@@ -399,6 +399,8 @@ export async function retrieveOrImportShare(params: {
     clientId,
     source,
     recordId,
+    oauthInitiated: CitadelAllowParamsSetOrUnsetFlag.SET,
+    oauthCompleted: CitadelAllowParamsSetOrUnsetFlag.SET,
   });
 
   // generate temporary private and public key that is used to secure receive shares

src/torus.ts

@@ -9,6 +9,7 @@ import {
   callAllowApi,
   callAuditApi,
   CitadelAllowParams,
+  CitadelAllowParamsSetOrUnsetFlag,
   CitadelAuthFlowAuditParams,
   Curve,
   encodeEd25519Point,
@@ -165,15 +166,13 @@ class Torus {
       recordId,
     };
 
-    let result: TorusKey;
+    // for auditing the auth flow
+    const auditParams: CitadelAuthFlowAuditParams = {
+      // at this point, user has completed the oauth login
+      oauthCompleted: true,
+    };
 
-    if (!params.recordId) {
-      // report oauth completed, we won't await this call as it's only for analytics tracking
-      // if recordId isn't provided in the params, we will also report oauth initiated
-      this.reportSignerAllow({ ...allowParams, oauthCompleted: true, oauthInitiated: true });
-    } else {
-      this.reportUserAuthFlowAudit({ ...params, recordId }, { oauthCompleted: true });
-    }
+    let result: TorusKey;
 
     try {
       result = await retrieveOrImportShare({
@@ -202,18 +201,20 @@ class Torus {
     } catch (error) {
       if (params.recordId) {
         // report oauth verification failed, we won't await this call as it's only for analytics tracking
-        this.reportUserAuthFlowAudit({ ...params, recordId }, { oauthVerificationFailed: true });
+        auditParams.oauthVerificationFailed = true;
+        this.reportUserAuthFlowAudit({ ...params, recordId }, auditParams);
       } else {
-        this.reportSignerAllow({ ...allowParams, oauthVerificationFailed: true });
+        this.reportSignerAllow({ ...allowParams, oauthVerificationFailed: CitadelAllowParamsSetOrUnsetFlag.SET });
       }
       throw error;
     }
 
     if (!params.recordId) {
-      this.reportSignerAllow({ ...allowParams, oauthVerified: true });
+      this.reportSignerAllow({ ...allowParams, oauthVerified: CitadelAllowParamsSetOrUnsetFlag.SET });
     } else {
       // report oauth verified, we won't await this call as it's only for analytics tracking
-      this.reportUserAuthFlowAudit({ ...params, recordId }, { oauthVerified: true });
+      auditParams.oauthVerified = true;
+      this.reportUserAuthFlowAudit({ ...params, recordId }, auditParams);
     }
     return result;
   }