Merge pull request #19979 from mozilla/FXA-12993

PART 1: feat(auth): Add backend APIs needed to move off GraphQL

Author: vbudhram

packages/fxa-auth-client/lib/client.ts

@@ -1176,6 +1176,18 @@ export default class AuthClient {
     );
   }
 
+  async emailBounceStatus(
+    email: string,
+    headers?: Headers
+  ): Promise<{ hasHardBounce: boolean }> {
+    return this.request(
+      'POST',
+      '/account/email_bounce_status',
+      { email },
+      headers
+    );
+  }
+
   async accountProfile(sessionToken: hexstring, headers?: Headers) {
     return this.sessionGet('/account/profile', sessionToken, headers);
   }
@@ -1184,6 +1196,19 @@ export default class AuthClient {
     return this.sessionGet('/account', sessionToken, headers);
   }
 
+  async metricsOpt(
+    sessionToken: hexstring,
+    state: 'in' | 'out',
+    headers?: Headers
+  ): Promise<{}> {
+    return this.sessionPost(
+      '/account/metrics_opt',
+      sessionToken,
+      { state },
+      headers
+    );
+  }
+
   async sessionDestroy(
     sessionToken: hexstring,
     options: {

packages/fxa-auth-server/config/dev.json

@@ -23,7 +23,11 @@
     "subscriptionTermsUrl": "https://www.mozilla.org/about/legal/terms/subscription-services",
     "subscriptionSettingsUrl": "http://localhost:3035/",
     "user": "local",
-    "password": "local"
+    "password": "local",
+    "bounces": {
+      "enabled": true,
+      "aliasCheckEnabled": true
+    }
   },
   "snsTopicArn": "arn:aws:sns:us-east-1:100010001000:fxa-account-change-dev",
   "snsTopicEndpoint": "http://localhost:4100/",

packages/fxa-auth-server/config/rate-limit-rules.txt

@@ -26,6 +26,7 @@ loadAccountFailed                     : ip                : 50          : 24 hou
 #
 accountCreate                         : ip                : 100         : 24 hours        : 24 hours    : block
 accountStatusCheck                    : ip                : 100         : 15 minute       : 15 minute   : block
+emailBounceStatusCheck                : ip                : 100         : 15 minute       : 15 minute   : block
 recoveryKeyExists                     : ip                : 100         : 15 minute       : 15 minute   : block
 getCredentialsStatus                  : ip                : 100         : 15 minute       : 15 minute   : block
 

packages/fxa-auth-server/docs/swagger/account-api.ts

@@ -109,6 +109,14 @@ const ACCOUNT_STATUS_POST = {
   ],
 };
 
+const ACCOUNT_EMAIL_BOUNCE_STATUS_POST = {
+  ...TAGS_ACCOUNT,
+  description: '/account/email_bounce_status',
+  notes: [
+    'Checks if there are any hard (permanent) email bounces recorded for the provided email address. Used during signup confirmation to detect if verification emails are bouncing.',
+  ],
+};
+
 const ACCOUNT_PROFILE_GET = {
   ...TAGS_ACCOUNT,
   description: '/account/profile',
@@ -310,12 +318,24 @@ const ACCOUNT_STUB_POST = {
   description: '/account/stub',
 };
 
+const ACCOUNT_METRICS_OPT_POST = {
+  ...TAGS_ACCOUNT,
+  description: '/account/metrics_opt',
+  notes: [
+    dedent`
+      Set the metrics opt-in or opt-out state for the account. Notifies relying parties of the profile data change.
+    `,
+  ],
+};
+
 const API_DOCS = {
   ACCOUNT_CREATE_POST,
   ACCOUNT_DESTROY_POST,
+  ACCOUNT_EMAIL_BOUNCE_STATUS_POST,
   ACCOUNT_FINISH_SETUP_POST,
   ACCOUNT_KEYS_GET,
   ACCOUNT_LOGIN_POST,
+  ACCOUNT_METRICS_OPT_POST,
   ACCOUNT_PROFILE_GET,
   ACCOUNT_RESET_POST,
   ACCOUNT_CREDENTIALS_STATUS,