Refactor NotificationsClient (#270)

2025-12-19 17:01:13 +00:00 · 2020-10-12 22:10:28 -05:00
parent 3b64d75322
commit cfb9a0b321
28 changed files with 75 additions and 157 deletions
--- a/src/Explorer/Controls/Settings/SettingsComponent.test.tsx
+++ b/src/Explorer/Controls/Settings/SettingsComponent.test.tsx
@@ -103,9 +103,7 @@ describe("SettingsComponent", () => {
    let settingsComponentInstance = new SettingsComponent(baseProps);
    expect(settingsComponentInstance.shouldShowKeyspaceSharedThroughputMessage()).toEqual(false);

-    const newContainer = new Explorer({
-      notificationsClient: undefined
-    });
+    const newContainer = new Explorer();
    newContainer.isPreferredApiCassandra = ko.computed(() => true);

    const newCollection = { ...collection };
@@ -146,9 +144,7 @@ describe("SettingsComponent", () => {
    let settingsComponentInstance = new SettingsComponent(baseProps);
    expect(settingsComponentInstance.hasConflictResolution()).toEqual(undefined);

-    const newContainer = new Explorer({
-      notificationsClient: undefined
-    });
+    const newContainer = new Explorer();
    newContainer.databaseAccount = ko.observable({
      id: undefined,
      name: undefined,
--- a/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.test.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/ScaleComponent.test.tsx
@@ -12,9 +12,7 @@ import * as SharedConstants from "../../../../Shared/Constants";
 import ko from "knockout";

 describe("ScaleComponent", () => {
-  const nonNationalCloudContainer = new Explorer({
-    notificationsClient: undefined
-  });
+  const nonNationalCloudContainer = new Explorer();
  nonNationalCloudContainer.getPlatformType = () => PlatformType.Portal;
  nonNationalCloudContainer.isRunningOnNationalCloud = () => false;

@@ -87,9 +85,7 @@ describe("ScaleComponent", () => {
  });

  it("autoScale enabled", () => {
-    const newContainer = new Explorer({
-      notificationsClient: undefined
-    });
+    const newContainer = new Explorer();

    newContainer.databaseAccount({
      id: undefined,
--- a/src/Explorer/Controls/Settings/SettingsSubComponents/SubSettingsComponent.test.tsx
+++ b/src/Explorer/Controls/Settings/SettingsSubComponents/SubSettingsComponent.test.tsx
@@ -105,9 +105,7 @@ describe("SubSettingsComponent", () => {
  });

  it("partitionKey not visible", () => {
-    const newContainer = new Explorer({
-      notificationsClient: undefined
-    });
+    const newContainer = new Explorer();

    newContainer.isPreferredApiCassandra = ko.computed(() => true);
    const props = { ...baseProps, container: newContainer };
--- a/src/Explorer/Controls/Settings/TestUtils.tsx
+++ b/src/Explorer/Controls/Settings/TestUtils.tsx
@@ -3,9 +3,7 @@ import * as ViewModels from "../../../Contracts/ViewModels";
 import Explorer from "../../Explorer";
 import ko from "knockout";

-export const container = new Explorer({
-  notificationsClient: undefined
-});
+export const container = new Explorer();

 export const collection = ({
  container: container,
--- a/src/Explorer/Controls/Settings/snapshots/SettingsComponent.test.tsx.snap
+++ b/src/Explorer/Controls/Settings/snapshots/SettingsComponent.test.tsx.snap
@@ -1051,7 +1051,6 @@ exports[`SettingsComponent renders 1`] = `
                  "parameters": [Function],
                },
                "notificationConsoleData": [Function],
-                "notificationsClient": undefined,
                "onRefreshDatabasesKeyPress": [Function],
                "onRefreshResourcesClick": [Function],
                "onSwitchToConnectionString": [Function],
@@ -2358,7 +2357,6 @@ exports[`SettingsComponent renders 1`] = `
                "parameters": [Function],
              },
              "notificationConsoleData": [Function],
-              "notificationsClient": undefined,
              "onRefreshDatabasesKeyPress": [Function],
              "onRefreshResourcesClick": [Function],
              "onSwitchToConnectionString": [Function],
@@ -3678,7 +3676,6 @@ exports[`SettingsComponent renders 1`] = `
                  "parameters": [Function],
                },
                "notificationConsoleData": [Function],
-                "notificationsClient": undefined,
                "onRefreshDatabasesKeyPress": [Function],
                "onRefreshResourcesClick": [Function],
                "onSwitchToConnectionString": [Function],
@@ -4985,7 +4982,6 @@ exports[`SettingsComponent renders 1`] = `
                "parameters": [Function],
              },
              "notificationConsoleData": [Function],
-              "notificationsClient": undefined,
              "onRefreshDatabasesKeyPress": [Function],
              "onRefreshResourcesClick": [Function],
              "onSwitchToConnectionString": [Function],
--- a/src/Explorer/Explorer.ts
+++ b/src/Explorer/Explorer.ts
@@ -82,7 +82,6 @@ import { toRawContentUri, fromContentUri } from "../Utils/GitHubUtils";
 import UserDefinedFunction from "./Tree/UserDefinedFunction";
 import StoredProcedure from "./Tree/StoredProcedure";
 import Trigger from "./Tree/Trigger";
-import { NotificationsClientBase } from "../Common/NotificationsClientBase";
 import { ContextualPaneBase } from "./Panes/ContextualPaneBase";
 import TabsBase from "./Tabs/TabsBase";
 import { CommandButtonComponentProps } from "./Controls/CommandButton/CommandButtonComponent";
@@ -99,9 +98,6 @@ enum ShareAccessToggleState {
  Read
 }

-interface ExplorerOptions {
-  notificationsClient: NotificationsClientBase;
-}
 interface AdHocAccessData {
  readWriteUrl: string;
  readUrl: string;
@@ -141,7 +137,6 @@ export default class Explorer {
  public serverId: ko.Observable<string>;
  public armEndpoint: ko.Observable<string>;
  public isTryCosmosDBSubscription: ko.Observable<boolean>;
-  public notificationsClient: NotificationsClientBase;
  public queriesClient: QueriesClient;
  public tableDataClient: TableDataClient;
  public splitter: Splitter;
@@ -270,7 +265,7 @@ export default class Explorer {

  private static readonly MaxNbDatabasesToAutoExpand = 5;

-  constructor(options: ExplorerOptions) {
+  constructor() {
    const startKey: number = TelemetryProcessor.traceStart(Action.InitializeDataExplorer, {
      dataExplorerArea: Constants.Areas.ResourceTree
    });
@@ -376,7 +371,6 @@ export default class Explorer {
      }
    });
    this.memoryUsageInfo = ko.observable<DataModels.MemoryUsageInfo>();
-    this.notificationsClient = options.notificationsClient;

    this.features = ko.observable();
    this.serverId = ko.observable<string>();
@@ -1910,7 +1904,6 @@ export default class Explorer {
      this.features(inputs.features);
      this.serverId(inputs.serverId);
      this.armEndpoint(EnvironmentUtility.normalizeArmEndpointUri(inputs.csmEndpoint || configContext.ARM_ENDPOINT));
-      this.notificationsClient.setExtensionEndpoint(configContext.BACKEND_ENDPOINT);
      this.databaseAccount(databaseAccount);
      this.subscriptionType(inputs.subscriptionType);
      this.quotaId(inputs.quotaId);
--- a/src/Explorer/Panes/AddCollectionPane.test.ts
+++ b/src/Explorer/Panes/AddCollectionPane.test.ts
@@ -40,7 +40,7 @@ describe("Add Collection Pane", () => {
    };

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
      explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);
    });

--- a/src/Explorer/Panes/AddDatabasePane.test.ts
+++ b/src/Explorer/Panes/AddDatabasePane.test.ts
@@ -40,9 +40,7 @@ describe("Add Database Pane", () => {
    };

    beforeEach(() => {
-      explorer = new Explorer({
-        notificationsClient: null
-      });
+      explorer = new Explorer();
    });

    it("should be true if subscription type is Benefits", () => {
--- a/src/Explorer/Panes/DeleteCollectionConfirmationPane.test.ts
+++ b/src/Explorer/Panes/DeleteCollectionConfirmationPane.test.ts
@@ -17,7 +17,7 @@ describe("Delete Collection Confirmation Pane", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
    });

    it("should be true if 1 database and 1 collection", () => {
@@ -56,7 +56,7 @@ describe("Delete Collection Confirmation Pane", () => {

  describe("shouldRecordFeedback()", () => {
    it("should return true if last collection and database does not have shared throughput else false", () => {
-      let fakeExplorer = new Explorer({ notificationsClient: null });
+      let fakeExplorer = new Explorer();
      fakeExplorer.isNotificationConsoleExpanded = ko.observable<boolean>(false);
      fakeExplorer.refreshAllDatabases = () => Q.resolve();

--- a/src/Explorer/Panes/DeleteDatabaseConfirmationPane.test.ts
+++ b/src/Explorer/Panes/DeleteDatabaseConfirmationPane.test.ts
@@ -22,7 +22,7 @@ describe("Delete Database Confirmation Pane", () => {
    });

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
    });

    it("should be true if only 1 database", () => {
--- a/src/Explorer/Panes/SettingsPane.test.ts
+++ b/src/Explorer/Panes/SettingsPane.test.ts
@@ -7,7 +7,7 @@ describe("Settings Pane", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
    });

    it("should be true for SQL API", () => {
--- a/src/Explorer/SplashScreen/SplashScreenComponentAdapter.test.ts
+++ b/src/Explorer/SplashScreen/SplashScreenComponentAdapter.test.ts
@@ -6,7 +6,7 @@ import Explorer from "../Explorer";
 jest.mock("../Explorer");

 const createExplorer = () => {
-  const mock = new Explorer({} as any);
+  const mock = new Explorer();
  mock.selectedNode = ko.observable();
  mock.isNotebookEnabled = ko.observable(false);
  mock.addCollectionText = ko.observable("add collection");
--- a/src/Explorer/Tabs/DocumentsTab.test.ts
+++ b/src/Explorer/Tabs/DocumentsTab.test.ts
@@ -27,13 +27,9 @@ describe("Documents tab", () => {
  });

  describe("showPartitionKey", () => {
-    const explorer = new Explorer({
-      notificationsClient: null
-    });
+    const explorer = new Explorer();

-    const mongoExplorer = new Explorer({
-      notificationsClient: null
-    });
+    const mongoExplorer = new Explorer();
    mongoExplorer.defaultExperience(Constants.DefaultAccountExperience.MongoDB);

    const collectionWithoutPartitionKey = <ViewModels.Collection>(<unknown>{
--- a/src/Explorer/Tabs/QueryTab.test.ts
+++ b/src/Explorer/Tabs/QueryTab.test.ts
@@ -49,7 +49,7 @@ describe("Query Tab", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
    });

    it("should be true for accounts using SQL API", () => {
@@ -69,7 +69,7 @@ describe("Query Tab", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
    });

    it("should be visible when using a supported API", () => {
--- a/src/Explorer/Tabs/SettingsTab.test.ts
+++ b/src/Explorer/Tabs/SettingsTab.test.ts
@@ -79,7 +79,7 @@ describe("Settings tab", () => {
      };

      beforeEach(() => {
-        explorer = new Explorer({ notificationsClient: null });
+        explorer = new Explorer();
        explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);
      });

@@ -178,7 +178,7 @@ describe("Settings tab", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
      explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);
    });

@@ -256,7 +256,7 @@ describe("Settings tab", () => {
    let explorer: Explorer;

    beforeEach(() => {
-      explorer = new Explorer({ notificationsClient: null });
+      explorer = new Explorer();
      explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);
    });

@@ -337,9 +337,7 @@ describe("Settings tab", () => {
    }

    function getCollection(defaultApi: string, partitionKeyOption: PartitionKeyOption) {
-      const explorer = new Explorer({
-        notificationsClient: null
-      });
+      const explorer = new Explorer();
      explorer.defaultExperience(defaultApi);
      explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);

@@ -469,9 +467,7 @@ describe("Settings tab", () => {

  describe("AutoPilot", () => {
    function getCollection(autoPilotTier: DataModels.AutopilotTier) {
-      const explorer = new Explorer({
-        notificationsClient: null
-      });
+      const explorer = new Explorer();
      explorer.hasAutoPilotV2FeatureFlag = ko.computed<boolean>(() => true);

      explorer.databaseAccount({
--- a/src/Explorer/Tabs/TabsManager.test.ts
+++ b/src/Explorer/Tabs/TabsManager.test.ts
@@ -16,7 +16,7 @@ describe("Tabs manager tests", () => {
  let documentsTab: DocumentsTab;

  beforeAll(() => {
-    explorer = new Explorer({ notificationsClient: undefined });
+    explorer = new Explorer();
    explorer.databaseAccount = ko.observable<DataModels.DatabaseAccount>({
      id: "test",
      name: "test",
--- a/src/Explorer/Tree/Collection.ts
+++ b/src/Explorer/Tree/Collection.ts
@@ -40,6 +40,7 @@ import { configContext } from "../../ConfigContext";
 import Explorer from "../Explorer";
 import { userContext } from "../../UserContext";
 import TabsBase from "../Tabs/TabsBase";
+import { fetchPortalNotifications } from "../../Common/PortalNotifications";

 export default class Collection implements ViewModels.Collection {
  public nodeKind: string;
@@ -1213,7 +1214,7 @@ export default class Collection implements ViewModels.Collection {
    }

    const deferred: Q.Deferred<DataModels.Notification> = Q.defer<DataModels.Notification>();
-    this.container.notificationsClient.fetchNotifications().then(
+    fetchPortalNotifications().then(
      (notifications: DataModels.Notification[]) => {
        if (!notifications || notifications.length === 0) {
          deferred.resolve(undefined);
--- a/src/Explorer/Tree/Database.ts
+++ b/src/Explorer/Tree/Database.ts
@@ -15,6 +15,7 @@ import Explorer from "../Explorer";
 import { readCollections } from "../../Common/dataAccess/readCollections";
 import { readDatabaseOffer } from "../../Common/dataAccess/readDatabaseOffer";
 import { DefaultAccountExperienceType } from "../../DefaultAccountExperienceType";
+import { fetchPortalNotifications } from "../../Common/PortalNotifications";

 export default class Database implements ViewModels.Database {
  public nodeKind: string;
@@ -220,8 +221,8 @@ export default class Database implements ViewModels.Database {
    }

    const deferred: Q.Deferred<DataModels.Notification> = Q.defer<DataModels.Notification>();
-    this.container.notificationsClient.fetchNotifications().then(
-      (notifications: DataModels.Notification[]) => {
+    fetchPortalNotifications().then(
+      notifications => {
        if (!notifications || notifications.length === 0) {
          deferred.resolve(undefined);
          return;