File: one_google_bar.ts

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (349 lines) | stat: -rw-r--r-- 11,205 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

type MessageType = 'overlaysUpdated'|'click'|'loaded';

// TODO(crbug.com/373569279): Post launch completion of OGB ABP integration,
// remove all references and logic associated to the legacy integration
// implementation.
declare let abp: boolean;

/**
 * The following |messageType|'s are sent to the parent frame:
 *  - loaded: sent on initial load.
 *  - overlaysUpdated: sent when an overlay is updated. The overlay bounding
 *        rects are included in the |data|.
 *  - click: sent when the OGB was clicked.
 */
function postMessage(messageType: MessageType, data?: object) {
  if (window === window.parent) {
    return;
  }
  window.parent.postMessage(
      {frameType: 'one-google-bar', messageType, data},
      'chrome://new-tab-page');
}

interface Bar {
  setDarkMode(matches: boolean): void;
  setBackgroundColor(bgColor: string): void;
  setForegroundStyle(style: number): void;
}

interface AsyncBar {
  setDarkMode(matches: boolean): void;
}

type IndexableApi = Record<string, Function>;
interface Gbar {
  gbar?: {a: Record<string, () => IndexableApi>, P: () => void};
}

if (abp) {
  window.addEventListener('gbar_a', () => {
    postOneGoogleBarLoaded();
  });
}

const oneGoogleBarApi = (() => {
  async function callApi(
      apiName: string, fnName: string, ...args: any[]): Promise<unknown> {
    const {gbar} = window as Window & Gbar;
    if (!gbar) {
      return;
    }
    const api = await gbar.a[apiName]!();
    return api[fnName]!.apply(api, args);
  }

  async function callAsyncBarApi(
      fnName: string, ...args: any[]): Promise<unknown> {
    const {gbar} = window as Window & Gbar;
    if (!gbar || !gbar.a) {
      return Promise.resolve();
    }

    const barApi = await gbar.a['bf']!();
    return barApi[fnName]!.apply(barApi, args);
  }

  interface Definition {
    name: string;
    apiName: string;
    fns: Array<[string, string]>;
  }

  const api: {bar: Bar} = [
    {
      name: 'bar',
      apiName: 'bf',
      fns: [
        ['setForegroundStyle', 'pc'],
        ['setBackgroundColor', 'pd'],
        ['setDarkMode', 'pp'],
      ],
    } as Definition,
  ].reduce((topLevelApi, def) => {
    (topLevelApi as Record<string, any>)[def.name] =
        def.fns.reduce((apiPart, [name, fnName]) => {
          apiPart[name] = callApi.bind(null, def.apiName, fnName);
          return apiPart;
        }, {} as IndexableApi);
    return topLevelApi;
  }, {} as {bar: Bar});

  const asyncBar: AsyncBar =
      [['setDarkMode', 'pp']].reduce((bar: any, [name, fnName]) => {
        bar[name!] = callAsyncBarApi.bind(null, fnName!);
        return bar;
      }, {} as Bar);

  async function updateDarkMode(): Promise<void> {
    if (abp) {
      await asyncBar.setDarkMode(
          window.matchMedia('(prefers-color-scheme: dark)').matches);
    } else {
      await api.bar.setDarkMode(
          window.matchMedia('(prefers-color-scheme: dark)').matches);
      // |setDarkMode(toggle)| updates the background color and foreground
      // style. The background color should always be 'transparent'.
      api.bar.setBackgroundColor('transparent');
      // The foreground style is set based on NTP theme and not dark mode.
      api.bar.setForegroundStyle(foregroundLight ? 1 : 0);
    }
  }

  let foregroundLight: boolean = false;

  return {
    /**
     * Updates the foreground on the OneGoogleBar to provide contrast against
     * the background.
     */
    setForegroundLight: (enabled: boolean) => {
      if (abp) {
        asyncBar.setDarkMode(enabled);
      } else if (foregroundLight !== enabled) {
        foregroundLight = enabled;
        api.bar.setForegroundStyle(foregroundLight ? 1 : 0);
      }
    },

    /**
     * Updates the OneGoogleBar dark mode when called as well as any time dark
     * mode is updated.
     */
    trackDarkModeChanges: async () => {
      window.matchMedia('(prefers-color-scheme: dark)').addListener(() => {
        updateDarkMode();
      });
      await updateDarkMode();
    },
  };
})();

/**
 * Object that exposes:
 *  - |track()|: sets up MutationObserver to track element visibility changes.
 *  - |update(potentialNewOverlays)|: determines visibility of tracked elements
 *        and sends an update to the top frame about element visibility.
 */
const overlayUpdater = (() => {
  const overlays = new Set<HTMLElement>();
  let lastOverlayRects: DOMRect[] = [];
  let elementsTransitioningCount: number = 0;
  let updateIntervalId: number|null = null;
  let initialElementsAdded: boolean = false;

  function transitionStart() {
    elementsTransitioningCount++;
    if (!updateIntervalId) {
      updateIntervalId = setInterval(() => {
        update([]);
      });
    }
  }

  function transitionStop() {
    if (elementsTransitioningCount > 0) {
      elementsTransitioningCount--;
    }
    if (updateIntervalId && elementsTransitioningCount === 0) {
      clearInterval(updateIntervalId);
      updateIntervalId = null;
    }
  }

  function addOverlay(overlay: HTMLElement) {
    if (overlays.has(overlay)) {
      return;
    }
    // If an overlay starts a transition, the updated bounding rects need to
    // be sent to the top frame during the transition. The MutationObserver
    // will only handle new elements and changes to the element attributes.
    overlay.addEventListener('animationstart', transitionStart);
    overlay.addEventListener('animationend', transitionStop);
    overlay.addEventListener('animationcancel', transitionStop);
    overlay.addEventListener('transitionstart', transitionStart);
    overlay.addEventListener('transitionend', transitionStop);
    overlay.addEventListener('transitioncancel', transitionStop);
    // Update links that are loaded dynamically to ensure target is "_blank"
    // or "_top".
    // TODO(crbug.com/40667075): remove after OneGoogleBar links are updated.
    overlay.parentElement!.querySelectorAll('a').forEach(el => {
      if (el.target !== '_blank' && el.target !== '_top') {
        el.target = '_top';
      }
    });
    const {transition} = getComputedStyle(overlay);
    const opacityTransition = 'opacity 0.1s ease 0.02s';
    // Check if the transition is the default computed transition style. If it
    // is not, append to the existing transitions.
    if (transition === 'all 0s ease 0s') {
      overlay.style.transition = opacityTransition;
    } else if (!transition.includes('opacity')) {
      overlay.style.transition = transition + ', ' + opacityTransition;
    }
    // The element has an initial opacity of 1. If the element is being added to
    // |overlays| and shown in the same |update()| call, the opacity transition
    // will not work since the opacity is already 1. For this reason the
    // 'fade-in' class is added to the element which runs an initial fade-in
    // animation.
    overlay.classList.add('fade-in');
    overlays.add(overlay);
  }

  function update(potentialNewOverlays: HTMLElement[]) {
    const gbElement = document.body.querySelector('#gb');
    if (!gbElement) {
      return;
    }
    const barRect = gbElement.getBoundingClientRect();
    if (barRect.bottom === 0) {
      return;
    }
    // After loaded, there could exist overlays that are shown, but not
    // mutated. Add all elements that could be an overlay. The children of the
    // actual overlay element are removed before sending any overlay update
    // message.
    if (!initialElementsAdded) {
      initialElementsAdded = true;
      Array.from(document.body.querySelectorAll<HTMLElement>('*'))
          .forEach(el => {
            potentialNewOverlays.push(el);
          });
    }
    Array.from(potentialNewOverlays).forEach(overlay => {
      const rect = overlay.getBoundingClientRect();
      if (overlay.parentElement && rect.width > 0 &&
          rect.bottom > barRect.bottom) {
        addOverlay(overlay);
      }
    });
    // Remove overlays detached from DOM.
    Array.from(overlays).forEach(overlay => {
      if (!overlay.parentElement) {
        overlays.delete(overlay);
      }
    });
    // Check if an overlay and its parents are visible.
    const overlayRects: DOMRect[] = [];
    overlays.forEach(overlay => {
      const {display, visibility} = window.getComputedStyle(overlay);
      const rect = overlay.getBoundingClientRect();
      const shown = display !== 'none' && visibility !== 'hidden' &&
          rect.bottom > barRect.bottom;
      if (shown) {
        overlayRects.push(rect);
      }
      // Setting the style here avoids triggering the mutation observer.
      overlay.style.opacity = shown ? '1' : '0';
    });
    overlayRects.push(barRect);
    const noChange = overlayRects.length === lastOverlayRects.length &&
        lastOverlayRects.every((rect, i) => {
          const newRect = overlayRects[i]!;
          return newRect.left === rect.left && newRect.top === rect.top &&
              newRect.right === rect.right && newRect.bottom === rect.bottom;
        });
    lastOverlayRects = overlayRects;
    if (noChange) {
      return;
    }
    postMessage('overlaysUpdated', overlayRects);
  }

  function track() {
    const observer = new MutationObserver(mutations => {
      const potentialNewOverlays: HTMLElement[] = [];
      // Add any mutated element that is an overlay to |overlays|.
      mutations.forEach(({target}) => {
        if (overlays.has(target as HTMLElement) || !target.parentElement) {
          return;
        }
        potentialNewOverlays.push(target as HTMLElement);
      });
      update(potentialNewOverlays);
    });
    observer.observe(document.body, {
      attributes: true,
      childList: true,
      subtree: true,
    });
  }

  return {track, update};
})();

window.addEventListener('message', ({data}) => {
  if (data.type === 'updateAppearance') {
    oneGoogleBarApi.setForegroundLight(data.applyLightTheme);
  }
});

// Need to send overlay updates on resize because overlay bounding rects are
// absolutely positioned.
window.addEventListener('resize', () => {
  overlayUpdater.update([]);
});

// When the account overlay is shown, it does not close on blur. It does close
// when focusing the body.
window.addEventListener('blur', e => {
  if (e.target === window && document.activeElement === document.body) {
    document.body.focus();
  }
});

window.addEventListener('click', () => {
  postMessage('click');
}, /*useCapture=*/ true);

function postOneGoogleBarLoaded() {
  postMessage('loaded');
  overlayUpdater.track();
  oneGoogleBarApi.trackDarkModeChanges();
}

if (!abp) {
  document.addEventListener('DOMContentLoaded', () => {
    document.body.style.margin = '0';
    // TODO(crbug.com/40667075): remove after OneGoogleBar links are updated.
    // Updates <a>'s so they load on the top frame instead of the iframe.
    document.body.querySelectorAll('a').forEach(el => {
      if (el.target !== '_blank') {
        el.target = '_top';
      }
    });

    postOneGoogleBarLoaded();
  });
} else {
  const {gbar} = window as Window & Gbar;
  if (gbar && gbar.a) {
    postOneGoogleBarLoaded();
  }
}

export {};