[Linter] Add a linter rule to prevent usage of window (Azure#13873)

## What

- Adds a rule to prevent usage of `window` and prefer `self` instead

## Why

- This came up recently in a few cases: Azure#11067 and in this discussion: Azure#13232 (comment)
- window is not always the global object, but self's reference changes depending on the context and will point to the right global object
- Adding a linter rule makes this easy to remember instead of relying on diligence

Resolves Azure#13472

Author: maorleger

common/tools/eslint-plugin-azure-sdk/README.md

@@ -101,6 +101,7 @@ Some rules (see table below) are fixable using the `--fix` ESLint option (added
 | [**ts-naming-options**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-options.md)                                                   | :triangular_flag_on_post: | :x:                | `1.2.0` |
 | [**ts-naming-subclients**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-subclients.md)                                             | :triangular_flag_on_post: | :x:                | `1.2.0` |
 | [**ts-no-const-enums**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-const-enums.md)                                                   | :warning:                 | :heavy_check_mark: | `1.1.0` |
+| [**ts-no-window**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-window.md)                                                             | :triangular_flag_on_post: | :heavy_check_mark: | `3.1.0` |
 | [**ts-no-namespaces**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-namespaces.md)                                                     | :triangular_flag_on_post: | :x:                | `1.2.0` |
 | [**ts-package-json-author**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-author.md)                                         | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
 | [**ts-package-json-bugs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-bugs.md)                                             | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |

common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-window.md

@@ -0,0 +1,23 @@
+# ts-no-window
+
+Recommends against the usage of `window` in favor of `self`.
+
+This rule is fixable using the `--fix` option.
+
+## Examples
+
+### Good
+
+```ts
+const navigator = self.navigator as NavigatorEx;
+```
+
+### Bad
+
+```ts
+const navigator = window.navigator as NavigatorEx;
+```
+
+## When to turn off
+
+Only if the rule breaks.

common/tools/eslint-plugin-azure-sdk/src/configs/index.ts

@@ -47,6 +47,7 @@ export = {
       "@azure/azure-sdk/ts-naming-subclients": "error",
       "@azure/azure-sdk/ts-no-const-enums": "warn",
       "@azure/azure-sdk/ts-no-namespaces": "error",
+      "@azure/azure-sdk/ts-no-window": "error",
       "@azure/azure-sdk/ts-package-json-author": "error",
       "@azure/azure-sdk/ts-package-json-bugs": "error",
       "@azure/azure-sdk/ts-package-json-engine-is-present": "error",

common/tools/eslint-plugin-azure-sdk/src/rules/index.ts

@@ -31,6 +31,7 @@ import tsNamingOptions from "./ts-naming-options";
 import tsNamingSubclients from "./ts-naming-subclients";
 import tsNoConstEnums from "./ts-no-const-enums";
 import tsNoNamespaces from "./ts-no-namespaces";
+import tsNoWindow from "./ts-no-window";
 import tsPackageJsonAuthor from "./ts-package-json-author";
 import tsPackageJsonBugs from "./ts-package-json-bugs";
 import tsPackageJsonEngineIsPresent from "./ts-package-json-engine-is-present";
@@ -79,6 +80,7 @@ export = {
   "ts-naming-subclients": tsNamingSubclients,
   "ts-no-const-enums": tsNoConstEnums,
   "ts-no-namespaces": tsNoNamespaces,
+  "ts-no-window": tsNoWindow,
   "ts-package-json-author": tsPackageJsonAuthor,
   "ts-package-json-bugs": tsPackageJsonBugs,
   "ts-package-json-engine-is-present": tsPackageJsonEngineIsPresent,

common/tools/eslint-plugin-azure-sdk/src/rules/ts-no-window.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * @file Rule to forbid usage of window.
+ * @author Maor Leger
+ */
+
+import { Rule } from "eslint";
+import { getRuleMetaData } from "../utils";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+export = {
+  meta: getRuleMetaData("ts-no-window", "forbid usage of window", "code"),
+  create: (context: Rule.RuleContext): Rule.RuleListener =>
+    ({
+      // report on any window identifiers
+      "Identifier[name=window]": (node: any): void => {
+        context.report({
+          node: node,
+          message: "`window` should not be used, please use `self` instead.",
+          fix: (fixer: Rule.RuleFixer): Rule.Fix =>
+            fixer.replaceTextRange([node.range[0], node.range[0] + "window".length], "self")
+        });
+      }
+    } as Rule.RuleListener)
+};

common/tools/eslint-plugin-azure-sdk/tests/plugin.ts

@@ -39,6 +39,7 @@ const ruleList = [
   "ts-naming-subclients",
   "ts-no-const-enums",
   "ts-no-namespaces",
+  "ts-no-window",
   "ts-package-json-author",
   "ts-package-json-bugs",
   "ts-package-json-engine-is-present",

common/tools/eslint-plugin-azure-sdk/tests/rules/ts-no-window.ts

@@ -0,0 +1,51 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * @file Testing the ts-no-window rule.
+ * @author Maor Leger
+ */
+
+import rule from "../../src/rules/ts-no-window";
+import { RuleTester } from "eslint";
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parser: require.resolve("@typescript-eslint/parser"),
+  parserOptions: {
+    createDefaultProgram: true,
+    project: "./tsconfig.json",
+    sourceType: "module"
+  },
+  settings: {
+    main: "test.ts"
+  }
+});
+
+ruleTester.run("ts-no-window", rule, {
+  valid: [
+    {
+      code: "self.navigator",
+      filename: "src/test.ts"
+    },
+    {
+      code: '"quoted window should be fine"',
+      filename: "src/test.ts"
+    }
+  ],
+  invalid: [
+    {
+      code: "window.navigator",
+      filename: "src/test.ts",
+      errors: [
+        {
+          message: "`window` should not be used, please use `self` instead."
+        }
+      ],
+      output: "self.navigator"
+    }
+  ]
+});

sdk/core/core-amqp/src/ConnectionContextBase.ts

@@ -142,9 +142,9 @@ export const ConnectionContextBase = {
 
     if (
       parameters.config.webSocket ||
-      (!isNode && typeof window !== "undefined" && (window as any).WebSocket)
+      (!isNode && typeof self !== "undefined" && (self as any).WebSocket)
     ) {
-      const socket = parameters.config.webSocket || (window as any).WebSocket;
+      const socket = parameters.config.webSocket || (self as any).WebSocket;
       const host = parameters.config.host;
       const endpoint = parameters.config.webSocketEndpointPath || "";
       const socketOptions = parameters.config.webSocketConstructorOptions || {};

sdk/core/core-amqp/src/errors.ts

@@ -610,9 +610,9 @@ function isBrowserWebsocketError(err: any): boolean {
   let result: boolean = false;
   if (
     !isNode &&
-    window &&
+    self &&
     err.type === "error" &&
-    err.target instanceof (window as any).WebSocket
+    err.target instanceof (self as any).WebSocket
   ) {
     result = true;
   }

sdk/core/core-amqp/src/shims.d.ts

@@ -13,4 +13,4 @@ interface Window {
 }
 declare let navigator: Navigator;
 
-declare let window: Window;
+declare let self: Window & typeof globalThis