[GdpIntegration] Add GdpClient for getting & creating a GDP profile

Bug: 436202677, 441467083
Fixed: 441436892
Change-Id: I0e143e14f2a8c4db1f80b053ba8056499ec019bc
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6894997
Auto-Submit: Ergün Erdoğmuş <[email protected]>
Reviewed-by: Alex Rudenko <[email protected]>
Commit-Queue: Ergün Erdoğmuş <[email protected]>

Author: ergunsh

config/gni/devtools_grd_files.gni

@@ -851,6 +851,7 @@ grd_files_unbundled_sources = [
   "front_end/core/common/Worker.js",
   "front_end/core/dom_extension/DOMExtension.js",
   "front_end/core/host/AidaClient.js",
+  "front_end/core/host/GdpClient.js",
   "front_end/core/host/InspectorFrontendHost.js",
   "front_end/core/host/InspectorFrontendHostAPI.js",
   "front_end/core/host/Platform.js",

front_end/core/host/BUILD.gn

@@ -8,6 +8,7 @@ import("../../../scripts/build/ninja/devtools_module.gni")
 devtools_module("host") {
   sources = [
     "AidaClient.ts",
+    "GdpClient.ts",
     "InspectorFrontendHost.ts",
     "InspectorFrontendHostAPI.ts",
     "Platform.ts",
@@ -34,7 +35,10 @@ devtools_entrypoint("bundle") {
 ts_library("unittests") {
   testonly = true
 
-  sources = [ "AidaClient.test.ts" ]
+  sources = [
+    "AidaClient.test.ts",
+    "GdpClient.test.ts",
+  ]
 
   deps = [
     ":bundle",

front_end/core/host/GdpClient.test.ts

@@ -0,0 +1,35 @@
+// Copyright 2025 The Chromium Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import * as Host from './host.js';
+
+describe('GdpClient', () => {
+  let dispatchHttpRequestStub:
+      sinon.SinonStub<Parameters<typeof Host.InspectorFrontendHost.InspectorFrontendHostInstance.dispatchHttpRequest>>;
+  beforeEach(() => {
+    dispatchHttpRequestStub =
+        sinon.stub(Host.InspectorFrontendHost.InspectorFrontendHostInstance, 'dispatchHttpRequest')
+            .callsFake((request, cb) => {
+              cb({
+                response: JSON.stringify({name: 'profiles/id'}),
+                statusCode: 200,
+              });
+            });
+    Host.GdpClient.GdpClient.instance({forceNew: true});
+  });
+
+  it('should cache requests to getProfile', async () => {
+    await Host.GdpClient.GdpClient.instance().getProfile();
+    await Host.GdpClient.GdpClient.instance().getProfile();
+
+    sinon.assert.calledOnce(dispatchHttpRequestStub);
+  });
+
+  it('should cache requests to checkEligibility', async () => {
+    await Host.GdpClient.GdpClient.instance().checkEligibility();
+    await Host.GdpClient.GdpClient.instance().checkEligibility();
+
+    sinon.assert.calledOnce(dispatchHttpRequestStub);
+  });
+});

front_end/core/host/GdpClient.ts

@@ -0,0 +1,138 @@
+// Copyright 2025 The Chromium Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import {InspectorFrontendHostInstance} from './InspectorFrontendHost.js';
+import type {DispatchHttpRequestRequest, DispatchHttpRequestResult} from './InspectorFrontendHostAPI.js';
+
+enum SubscriptionStatus {
+  ENABLED = 'SUBSCRIPTION_STATE_ENABLED',
+  PENDING = 'SUBSCRIPTION_STATE_PENDING',
+  CANCELED = 'SUBSCRIPTION_STATE_CANCELED',
+  REFUNDED = 'SUBSCRIPTION_STATE_REFUNDED',
+  AWAITING_FIX = 'SUBSCRIPTION_STATE_AWAITING_FIX',
+  ON_HOLD = 'SUBSCRIPTION_STATE_ACCOUNT_ON_HOLD',
+}
+
+enum SubscriptionTier {
+  PREMIUM_ANNUAL = 'SUBSCRIPTION_TIER_PREMIUM_ANNUAL',
+  PREMIUM_MONTHLY = 'SUBSCRIPTION_TIER_PREMIUM_MONTHLY',
+  PRO_ANNUAL = 'SUBSCRIPTION_TIER_PRO_ANNUAL',
+  PRO_MONTHLY = 'SUBSCRIPTION_TIER_PRO_MONTHLY',
+}
+
+enum EligibilityStatus {
+  ELIGIBLE = 'ELIGIBLE',
+  NOT_ELIGIBLE = 'NOT_ELIGIBLE',
+}
+
+enum EmailPreference {
+  ENABLED = 'ENABLED',
+  DISABLED = 'DISABLED',
+}
+
+interface CheckElibigilityResponse {
+  createProfile: EligibilityStatus;
+}
+
+interface Profile {
+  // Resource name of the profile.
+  // Format: profiles/{obfuscated_profile_id}
+  name: string;
+  activeSubscription?: {
+    subscriptionStatus: SubscriptionStatus,
+    subscrionTier: SubscriptionTier,
+  };
+}
+
+async function dispatchHttpRequestPromise<R extends object>(request: DispatchHttpRequestRequest): Promise<R|null> {
+  const response = await new Promise<DispatchHttpRequestResult>(resolve => {
+    InspectorFrontendHostInstance.dispatchHttpRequest(request, resolve);
+  });
+
+  debugLog({request, response});
+  if ('response' in response && response.statusCode === 200) {
+    return JSON.parse(response.response) as R;
+  }
+
+  return null;
+}
+
+const SERVICE_NAME = 'gdpService';
+let gdpClientInstance: GdpClient|null = null;
+export class GdpClient {
+  #cachedProfilePromise?: Promise<Profile|null>;
+  #cachedEligibilityPromise?: Promise<CheckElibigilityResponse|null>;
+
+  private constructor() {
+  }
+
+  static instance({forceNew}: {
+    forceNew: boolean,
+  } = {forceNew: false}): GdpClient {
+    if (!gdpClientInstance || forceNew) {
+      gdpClientInstance = new GdpClient();
+    }
+    return gdpClientInstance;
+  }
+
+  async getProfile(): Promise<Profile|null> {
+    if (this.#cachedProfilePromise) {
+      return await this.#cachedProfilePromise;
+    }
+
+    this.#cachedProfilePromise = dispatchHttpRequestPromise({
+      service: SERVICE_NAME,
+      path: '/v1beta1/profile:get',
+      method: 'GET',
+    });
+    return await this.#cachedProfilePromise;
+  }
+
+  async checkEligibility(): Promise<CheckElibigilityResponse|null> {
+    if (this.#cachedEligibilityPromise) {
+      return await this.#cachedEligibilityPromise;
+    }
+
+    this.#cachedEligibilityPromise =
+        dispatchHttpRequestPromise({service: SERVICE_NAME, path: '/v1beta1/eligibility:check', method: 'GET'});
+
+    return await this.#cachedEligibilityPromise;
+  }
+
+  createProfile({user, emailPreference}: {user: string, emailPreference: EmailPreference}): Promise<Profile|null> {
+    return dispatchHttpRequestPromise({
+      service: SERVICE_NAME,
+      path: '/v1beta1/profiles',
+      method: 'POST',
+      body: JSON.stringify({
+        user,
+        newsletter_email: emailPreference,
+      })
+    });
+  }
+}
+
+function isDebugMode(): boolean {
+  return Boolean(localStorage.getItem('debugGdpIntegrationEnabled'));
+}
+
+function debugLog(...log: unknown[]): void {
+  if (!isDebugMode()) {
+    return;
+  }
+
+  // eslint-disable-next-line no-console
+  console.log('debugLog', ...log);
+}
+
+function setDebugGdpIntegrationEnabled(enabled: boolean): void {
+  if (enabled) {
+    localStorage.setItem('debugGdpIntegrationEnabled', 'true');
+  } else {
+    localStorage.removeItem('debugGdpIntegrationEnabled');
+  }
+}
+
+// @ts-expect-error
+globalThis.setDebugGdpIntegrationEnabled = setDebugGdpIntegrationEnabled;

front_end/core/host/InspectorFrontendHost.ts

@@ -40,6 +40,8 @@ import {
   type ChangeEvent,
   type ClickEvent,
   type ContextMenuDescriptor,
+  type DispatchHttpRequestRequest,
+  type DispatchHttpRequestResult,
   type DoAidaConversationResult,
   type DragEvent,
   type EnumeratedHistogram,
@@ -548,6 +550,11 @@ export class InspectorFrontendHostStub implements InspectorFrontendHostAPI {
     });
   }
 
+  dispatchHttpRequest(_request: DispatchHttpRequestRequest, callback: (result: DispatchHttpRequestResult) => void):
+      void {
+    callback({error: 'Not implemented'});
+  }
+
   recordImpression(_event: ImpressionEvent): void {
   }
   recordResize(_event: ResizeEvent): void {

front_end/core/host/InspectorFrontendHostAPI.ts

@@ -253,6 +253,34 @@ export interface EventTypes {
   [Events.ShowPanel]: string;
 }
 
+export type DispatchHttpRequestRequest = {
+  service: string,
+  path: string,
+  method: 'GET',
+  body?: never,
+}|{
+  service: string,
+  path: string,
+  method: 'POST',
+  // A JSON string containing the request body.
+  body?: string,
+};
+
+interface DispatchHttpRequestSuccessResult {
+  response: string;
+  statusCode: number;
+}
+
+interface DispatchHttpRequestErrorResult {
+  error: string;
+  detail?: string;
+  netError?: number;
+  netErrorName?: string;
+  statusCode?: number;
+}
+
+export type DispatchHttpRequestResult = DispatchHttpRequestSuccessResult|DispatchHttpRequestErrorResult;
+
 export interface InspectorFrontendHostAPI {
   events: Common.EventTarget.EventTarget<EventTypes>;
 
@@ -402,6 +430,7 @@ export interface InspectorFrontendHostAPI {
   doAidaConversation: (request: string, streamId: number, cb: (result: DoAidaConversationResult) => void) => void;
   registerAidaClientEvent: (request: string, cb: (result: AidaClientResult) => void) => void;
   aidaCodeComplete: (request: string, cb: (result: AidaCodeCompleteResult) => void) => void;
+  dispatchHttpRequest: (request: DispatchHttpRequestRequest, cb: (result: DispatchHttpRequestResult) => void) => void;
 
   recordImpression(event: ImpressionEvent): void;
   recordClick(event: ClickEvent): void;

front_end/core/host/host.ts

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 import * as AidaClient from './AidaClient.js';
+import * as GdpClient from './GdpClient.js';
 import * as InspectorFrontendHost from './InspectorFrontendHost.js';
 import * as InspectorFrontendHostAPI from './InspectorFrontendHostAPI.js';
 import * as Platform from './Platform.js';
@@ -11,6 +12,7 @@ import * as UserMetrics from './UserMetrics.js';
 
 export {
   AidaClient,
+  GdpClient,
   InspectorFrontendHost,
   InspectorFrontendHostAPI,
   Platform,