From 19f188a8529cc5af5e054fa9818e8785dbb931af Mon Sep 17 00:00:00 2001
From: Jack Franklin <jacktfranklin@chromium.org>
Date: Wed, 8 Jul 2020 16:03:16 +0100
Subject: [PATCH] chore: forbid importing src/common/Events.ts (#6183)

This file is now deprecated and only used by the coverage tool and
DocLint - these tools will be updated to not rely on it in the future.

We now have events defined per class - e.g. all the events that `Page`
can emit are defined in the `PageEmittedEvents` enum, and similar. We
have to keep `Events.ts` around for the aforementioned tools, but don't
want its usage creeping back into our source code.
---
 .eslintrc.js                   | 6 +++++-
 src/common/LifecycleWatcher.ts | 1 -
 src/common/Page.ts             | 1 -
 3 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/.eslintrc.js b/.eslintrc.js
index 32b5d16114941..670e790428867 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -84,7 +84,11 @@ module.exports = {
         "mocha/no-exclusive-tests": "error",
 
         // enforce the variable in a catch block is named error
-        "unicorn/catch-error-name": "error"
+        "unicorn/catch-error-name": "error",
+
+        "no-restricted-imports": ["error", {
+            patterns: ["*Events"],
+        }]
     },
     "overrides": [
         {
diff --git a/src/common/LifecycleWatcher.ts b/src/common/LifecycleWatcher.ts
index bd64a5671a6ed..45ff97117a785 100644
--- a/src/common/LifecycleWatcher.ts
+++ b/src/common/LifecycleWatcher.ts
@@ -16,7 +16,6 @@
 
 import { assert } from './assert';
 import { helper, PuppeteerEventListener } from './helper';
-import { Events } from './Events';
 import { TimeoutError } from './Errors';
 import { FrameManager, Frame, FrameManagerEmittedEvents } from './FrameManager';
 import { HTTPRequest } from './HTTPRequest';
diff --git a/src/common/Page.ts b/src/common/Page.ts
index 63e1a40a4e663..41503a0a07b13 100644
--- a/src/common/Page.ts
+++ b/src/common/Page.ts
@@ -18,7 +18,6 @@ import * as fs from 'fs';
 import { promisify } from 'util';
 import { EventEmitter } from './EventEmitter';
 import * as mime from 'mime';
-import { Events } from './Events';
 import { Connection, CDPSession, CDPSessionEmittedEvents } from './Connection';
 import { Dialog } from './Dialog';
 import { EmulationManager } from './EmulationManager';