Skip to content

Commit

Permalink
Lint remaining static enums in src (#36821)
Browse files Browse the repository at this point in the history
* tmp

* Fix types

* Fix types

* Types

* Undo changes to VideoAnalyticsEvents_Enum

It requires its own PR.

* Inline fetch-polyfill enum

* stop linting tests

* Fix make-extension template

* Fix typescript shames

* Fix suspicious LHS error

* Fix type

* fix test
  • Loading branch information
jridgewell committed Nov 15, 2021
1 parent 9dc8f18 commit 556e94a
Show file tree
Hide file tree
Showing 387 changed files with 3,620 additions and 3,231 deletions.
78 changes: 45 additions & 33 deletions 3p/ampcontext.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {MessageType} from '#core/3p-frame-messaging';
import {AmpEvents} from '#core/constants/amp-events';
import {MessageType_Enum} from '#core/3p-frame-messaging';
import {AmpEvents_Enum} from '#core/constants/amp-events';
import {Deferred} from '#core/data-structures/promise';
import {isObject} from '#core/types';
import {dict, map} from '#core/types/object';
Expand Down Expand Up @@ -129,8 +129,8 @@ export class AbstractAmpContext {
/** Registers an general handler for page visibility. */
listenForPageVisibility_() {
this.client_.makeRequest(
MessageType.SEND_EMBED_STATE,
MessageType.EMBED_STATE,
MessageType_Enum.SEND_EMBED_STATE,
MessageType_Enum.EMBED_STATE,
(data) => {
this.hidden = data['pageHidden'];
this.dispatchVisibilityChangeEvent_();
Expand All @@ -145,7 +145,7 @@ export class AbstractAmpContext {
dispatchVisibilityChangeEvent_() {
const event = this.win_.document.createEvent('Event');
event.data = {hidden: this.hidden};
event.initEvent(AmpEvents.VISIBILITY_CHANGE, true, true);
event.initEvent(AmpEvents_Enum.VISIBILITY_CHANGE, true, true);
this.win_.dispatchEvent(event);
}

Expand All @@ -157,9 +157,12 @@ export class AbstractAmpContext {
* every time we receive a page visibility message.
*/
onPageVisibilityChange(callback) {
return this.client_.registerCallback(MessageType.EMBED_STATE, (data) => {
callback({hidden: data['pageHidden']});
});
return this.client_.registerCallback(
MessageType_Enum.EMBED_STATE,
(data) => {
callback({hidden: data['pageHidden']});
}
);
}

/**
Expand All @@ -171,8 +174,8 @@ export class AbstractAmpContext {
*/
observeIntersection(callback) {
return this.client_.makeRequest(
MessageType.SEND_INTERSECTIONS,
MessageType.INTERSECTION,
MessageType_Enum.SEND_INTERSECTIONS,
MessageType_Enum.INTERSECTION,
(intersection) => {
callback(intersection['changes']);
}
Expand All @@ -188,7 +191,7 @@ export class AbstractAmpContext {
*/
getHtml(selector, attributes, callback) {
this.client_.getData(
MessageType.GET_HTML,
MessageType_Enum.GET_HTML,
dict({
'selector': selector,
'attributes': attributes,
Expand All @@ -203,7 +206,7 @@ export class AbstractAmpContext {
* @param {function(*)} callback
*/
getConsentState(callback) {
this.client_.getData(MessageType.GET_CONSENT_STATE, null, callback);
this.client_.getData(MessageType_Enum.GET_CONSENT_STATE, null, callback);
}

/**
Expand All @@ -217,7 +220,7 @@ export class AbstractAmpContext {
requestResize(width, height, hasOverflow) {
const requestId = this.nextResizeRequestId_++;
this.client_.sendMessage(
MessageType.EMBED_SIZE,
MessageType_Enum.EMBED_SIZE,
dict({
'id': requestId,
'width': width,
Expand All @@ -234,21 +237,27 @@ export class AbstractAmpContext {
* Set up listeners to handle responses from request size.
*/
listenToResizeResponse_() {
this.client_.registerCallback(MessageType.EMBED_SIZE_CHANGED, (data) => {
const id = data['id'];
if (id !== undefined) {
this.resizeIdToDeferred_[id].resolve();
delete this.resizeIdToDeferred_[id];
this.client_.registerCallback(
MessageType_Enum.EMBED_SIZE_CHANGED,
(data) => {
const id = data['id'];
if (id !== undefined) {
this.resizeIdToDeferred_[id].resolve();
delete this.resizeIdToDeferred_[id];
}
}
});
);

this.client_.registerCallback(MessageType.EMBED_SIZE_DENIED, (data) => {
const id = data['id'];
if (id !== undefined) {
this.resizeIdToDeferred_[id].reject('Resizing is denied');
delete this.resizeIdToDeferred_[id];
this.client_.registerCallback(
MessageType_Enum.EMBED_SIZE_DENIED,
(data) => {
const id = data['id'];
if (id !== undefined) {
this.resizeIdToDeferred_[id].reject('Resizing is denied');
delete this.resizeIdToDeferred_[id];
}
}
});
);
}

/**
Expand All @@ -257,7 +266,7 @@ export class AbstractAmpContext {
*/
sendDeprecationNotice_(endpoint) {
this.client_.sendMessage(
MessageType.USER_ERROR_IN_IFRAME,
MessageType_Enum.USER_ERROR_IN_IFRAME,
dict({
'message': `${endpoint} is deprecated`,
'expected': true,
Expand All @@ -273,9 +282,12 @@ export class AbstractAmpContext {
* request succeeds.
*/
onResizeSuccess(callback) {
this.client_.registerCallback(MessageType.EMBED_SIZE_CHANGED, (obj) => {
callback(obj['requestedHeight'], obj['requestedWidth']);
});
this.client_.registerCallback(
MessageType_Enum.EMBED_SIZE_CHANGED,
(obj) => {
callback(obj['requestedHeight'], obj['requestedWidth']);
}
);
this.sendDeprecationNotice_('onResizeSuccess');
}

Expand All @@ -287,7 +299,7 @@ export class AbstractAmpContext {
* request is denied.
*/
onResizeDenied(callback) {
this.client_.registerCallback(MessageType.EMBED_SIZE_DENIED, (obj) => {
this.client_.registerCallback(MessageType_Enum.EMBED_SIZE_DENIED, (obj) => {
callback(obj['requestedHeight'], obj['requestedWidth']);
});
this.sendDeprecationNotice_('onResizeDenied');
Expand All @@ -297,7 +309,7 @@ export class AbstractAmpContext {
* Make the ad interactive.
*/
signalInteractive() {
this.client_.sendMessage(MessageType.SIGNAL_INTERACTIVE);
this.client_.sendMessage(MessageType_Enum.SIGNAL_INTERACTIVE);
}

/**
Expand All @@ -314,7 +326,7 @@ export class AbstractAmpContext {
* Notifies the parent document of no content available inside embed.
*/
noContentAvailable() {
this.client_.sendMessage(MessageType.NO_CONTENT);
this.client_.sendMessage(MessageType_Enum.NO_CONTENT);
}

/**
Expand Down Expand Up @@ -414,7 +426,7 @@ export class AbstractAmpContext {
return;
}
this.client_.sendMessage(
MessageType.USER_ERROR_IN_IFRAME,
MessageType_Enum.USER_ERROR_IN_IFRAME,
dict({
'message': e.message,
})
Expand Down
11 changes: 7 additions & 4 deletions 3p/iframe-transport-client.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import {IframeTransportEventDef, MessageType} from '#core/3p-frame-messaging';
import {
IframeTransportEventDef,
MessageType_Enum,
} from '#core/3p-frame-messaging';
import {tryParseJson} from '#core/types/object/json';

import {dev, devAssert, user, userAssert} from '#utils/log';
Expand Down Expand Up @@ -46,8 +49,8 @@ export class IframeTransportClient {
)
);
this.iframeMessagingClient_.makeRequest(
MessageType.SEND_IFRAME_TRANSPORT_EVENTS,
MessageType.IFRAME_TRANSPORT_EVENTS,
MessageType_Enum.SEND_IFRAME_TRANSPORT_EVENTS,
MessageType_Enum.IFRAME_TRANSPORT_EVENTS,
(eventData) => {
const events = /** @type {!Array<IframeTransportEventDef>} */ (
eventData['events']
Expand Down Expand Up @@ -163,7 +166,7 @@ export class IframeTransportContext {
*/
sendResponseToCreative(data) {
this.iframeMessagingClient_./*OK*/ sendMessage(
MessageType.IFRAME_TRANSPORT_RESPONSE,
MessageType_Enum.IFRAME_TRANSPORT_RESPONSE,
/** @type {!JsonObject} */
({message: data, ...this.baseMessage_})
);
Expand Down
10 changes: 5 additions & 5 deletions ads/google/a4a/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const ValidAdContainerTypes = {
};

/**
* See `VisibilityState` enum.
* See `VisibilityState_Enum` enum.
* @const {!Object<string, string>}
*/
const visibilityStateCodes = {
Expand Down Expand Up @@ -1090,7 +1090,7 @@ export function setNameframeExperimentConfigs(headers, nameframeConfig) {
* than 32 capabilities to this enum.
* @enum {number}
*/
const Capability = {
const Capability_Enum = {
SVG_SUPPORTED: 1 << 0,
SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED: 1 << 1,
SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED: 1 << 2,
Expand All @@ -1105,17 +1105,17 @@ function getBrowserCapabilitiesBitmap(win) {
let browserCapabilities = 0;
const doc = win.document;
if (win.SVGElement && doc.createElementNS) {
browserCapabilities |= Capability.SVG_SUPPORTED;
browserCapabilities |= Capability_Enum.SVG_SUPPORTED;
}
const iframeEl = doc.createElement('iframe');
if (iframeEl.sandbox && iframeEl.sandbox.supports) {
if (iframeEl.sandbox.supports('allow-top-navigation-by-user-activation')) {
browserCapabilities |=
Capability.SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED;
Capability_Enum.SANDBOXING_ALLOW_TOP_NAVIGATION_BY_USER_ACTIVATION_SUPPORTED;
}
if (iframeEl.sandbox.supports('allow-popups-to-escape-sandbox')) {
browserCapabilities |=
Capability.SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED;
Capability_Enum.SANDBOXING_ALLOW_POPUPS_TO_ESCAPE_SANDBOX_SUPPORTED;
}
}
return browserCapabilities;
Expand Down
30 changes: 16 additions & 14 deletions ads/google/ima/ima-video.js
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ function onImaLoadSuccess(global, data) {
requestAds();
} else {
// Let amp-ima-video know that we are done set-up.
postMessage({event: VideoEvents.LOAD});
postMessage({event: VideoEvents_Enum.LOAD});
}
}

Expand All @@ -564,7 +564,7 @@ function onImaLoadFail() {
showControlsThrottled
);
imaLoadAllowed = false;
postMessage({event: VideoEvents.LOAD});
postMessage({event: VideoEvents_Enum.LOAD});
}

/**
Expand Down Expand Up @@ -688,8 +688,8 @@ export function onContentEnded() {
toggle(elements['overlayButton'], true);
}

postMessage({event: VideoEvents.PAUSE});
postMessage({event: VideoEvents.ENDED});
postMessage({event: VideoEvents_Enum.PAUSE});
postMessage({event: VideoEvents_Enum.ENDED});
}

/**
Expand Down Expand Up @@ -737,7 +737,7 @@ export function onAdsManagerLoaded(global, adsManagerLoadedEvent) {
if (muteAdsManagerOnLoaded) {
adsManager.setVolume(0);
}
postMessage({event: VideoEvents.LOAD});
postMessage({event: VideoEvents_Enum.LOAD});
}

/**
Expand All @@ -750,7 +750,7 @@ export function onAdsLoaderError() {
// Send this message to trigger auto-play for failed pre-roll requests -
// failing to load an ad is just as good as loading one as far as starting
// playback is concerned because our content will be ready to play.
postMessage({event: VideoEvents.LOAD});
postMessage({event: VideoEvents_Enum.LOAD});
addHoverEventToElement(
/** @type {!Element} */ (elements['video']),
showControlsThrottled
Expand All @@ -766,7 +766,7 @@ export function onAdsLoaderError() {
* @visibleForTesting
*/
export function onAdError() {
postMessage({event: VideoEvents.AD_END});
postMessage({event: VideoEvents_Enum.AD_END});
currentAd = null;
if (adsManager) {
adsManager.destroy();
Expand Down Expand Up @@ -824,7 +824,7 @@ export function onContentPauseRequested(global) {
}
adsActive = true;
playerState = PlayerStates.PLAYING;
postMessage({event: VideoEvents.AD_START});
postMessage({event: VideoEvents_Enum.AD_START});
toggle(elements['adContainer'], true);
showAdControls();

Expand All @@ -849,7 +849,7 @@ export function onContentResumeRequested() {
/** @type {!Element} */ (video),
showControlsThrottled
);
postMessage({event: VideoEvents.AD_END});
postMessage({event: VideoEvents_Enum.AD_END});
resetControlsAfterAd();
if (!contentComplete) {
// CONTENT_RESUME will fire after post-rolls as well, and we don't want to
Expand Down Expand Up @@ -1096,7 +1096,7 @@ export function playVideo() {
video.play();
}
playerState = PlayerStates.PLAYING;
postMessage({event: VideoEvents.PLAYING});
postMessage({event: VideoEvents_Enum.PLAYING});
toggleRootDataAttribute('playing', true);
}

Expand All @@ -1121,7 +1121,7 @@ export function pauseVideo(event = null) {
}
}
playerState = PlayerStates.PAUSED;
postMessage({event: VideoEvents.PAUSE});
postMessage({event: VideoEvents_Enum.PAUSE});
toggleRootDataAttribute('playing', false);
}

Expand Down Expand Up @@ -1168,7 +1168,9 @@ export function toggleMuted(video, muted) {
muteAdsManagerOnLoaded = muted;
}
toggleRootDataAttribute('muted', muted);
postMessage({event: muted ? VideoEvents.MUTED : VideoEvents.UNMUTED});
postMessage({
event: muted ? VideoEvents_Enum.MUTED : VideoEvents_Enum.UNMUTED,
});
}

/**
Expand Down Expand Up @@ -1622,10 +1624,10 @@ export function setConsentStateForTesting(newConsentState) {
*
* Copied from src/video-interface.js.
*
* @const {!Object<string, string>}
* @enum {string}
*/
// TODO(aghassemi, #9216): Use video-interface.js
const VideoEvents = {
const VideoEvents_Enum = {
/**
* load
*
Expand Down

0 comments on commit 556e94a

Please sign in to comment.