moving best-match-from-list function down to ConnectionMatcher (#20491)

Author: Benjin

src/controllers/connectionManager.ts

@@ -386,9 +386,14 @@ export default class ConnectionManager {
         return fileUri in this._connections && this._connections[fileUri].connecting;
     }
 
+    /**
+     * Finds the closest-matching profile from the saved connections for the given partial connection profile
+     * @param connProfile partial connection profile to match against
+     * @returns closest-matching connection profile from the saved connections. If none is found, returns {score: MatchScore.NotMatch}
+     */
     public async findMatchingProfile(
         connProfile: IConnectionProfile,
-    ): Promise<{ profile: IConnectionProfile; score: Utils.MatchScore } | undefined> {
+    ): Promise<{ profile: IConnectionProfile; score: Utils.MatchScore }> {
         return this.connectionStore.findMatchingProfile(connProfile);
     }
 

src/models/connectionStore.ts

@@ -727,24 +727,17 @@ export class ConnectionStore {
         return connResults;
     }
 
+    /**
+     * Finds the closest-matching profile from the saved connections for the given partial connection profile
+     * @param connProfile partial connection profile to match against
+     * @returns closest-matching connection profile from the saved connections. If none is found, returns {score: MatchScore.NotMatch}
+     */
     public async findMatchingProfile(
         connProfile: IConnectionProfile,
-    ): Promise<{ profile: IConnectionProfile; score: MatchScore } | undefined> {
+    ): Promise<{ profile: IConnectionProfile; score: MatchScore }> {
         const savedConnections = await this.readAllConnections();
 
-        let bestMatch: IConnectionProfile | undefined;
-        let bestMatchScore = MatchScore.NotMatch;
-
-        for (const savedConn of savedConnections) {
-            const matchLevel = ConnectionMatcher.isMatchingConnection(savedConn, connProfile);
-
-            if (matchLevel > bestMatchScore) {
-                bestMatchScore = matchLevel;
-                bestMatch = savedConn;
-            }
-        }
-
-        return { profile: bestMatch, score: bestMatchScore };
+        return ConnectionMatcher.findMatchingProfile(connProfile, savedConnections);
     }
 
     /** Gets the groupId for connections  */

src/models/utils.ts

@@ -355,6 +355,30 @@ export class ConnectionMatcher {
         return MatchScore.NotMatch;
     }
 
+    /**
+     * Finds the closest-matching profile from the provided list for the given partial connection profile
+     * @param connProfile partial connection profile to match against
+     * @returns closest-matching connection profile from the provided list. If none is found, returns {score: MatchScore.NotMatch}
+     */
+    public static findMatchingProfile(
+        connProfile: IConnectionProfile,
+        connectionList: IConnectionProfile[],
+    ): { profile: IConnectionProfile; score: MatchScore } {
+        let bestMatch: IConnectionProfile | undefined;
+        let bestMatchScore = MatchScore.NotMatch;
+
+        for (const savedConn of connectionList) {
+            const matchLevel = ConnectionMatcher.isMatchingConnection(savedConn, connProfile);
+
+            if (matchLevel > bestMatchScore) {
+                bestMatchScore = matchLevel;
+                bestMatch = savedConn;
+            }
+        }
+
+        return { profile: bestMatch, score: bestMatchScore };
+    }
+
     /**
      * Checks if the server names match.  Normalizes "." to "localhost" for comparison purposes.  Case-sensitive.
      */

test/unit/utils.test.ts

@@ -7,7 +7,7 @@ import { expect, assert } from "chai";
 import * as Utils from "../../src/models/utils";
 import * as Constants from "../../src/constants/constants";
 import { ConnectionCredentials } from "../../src/models/connectionCredentials";
-import { IConnectionProfile } from "../../src/models/interfaces";
+import { IConnectionProfile, IConnectionProfileWithSource } from "../../src/models/interfaces";
 import * as utilUtils from "../../src/utils/utils";
 
 suite("Utility Tests - parseTimeString", () => {
@@ -367,6 +367,31 @@ suite("ConnectionMatcher", () => {
             ).to.equal(testCase.expected);
         }
     });
+
+    test("findMatchingProfile", async () => {
+        const connections = [
+            sqlAuthConn as IConnectionProfileWithSource,
+            azureAuthConn as IConnectionProfileWithSource,
+            connStringConn as IConnectionProfileWithSource,
+        ];
+
+        let match = Utils.ConnectionMatcher.findMatchingProfile(azureAuthConn, connections);
+        expect(match).to.deep.equal({
+            profile: azureAuthConn,
+            score: Utils.MatchScore.AllAvailableProps,
+        });
+
+        match = Utils.ConnectionMatcher.findMatchingProfile(
+            {
+                server: "noMatch",
+            } as IConnectionProfile,
+            connections,
+        );
+        expect(match).to.deep.equal({
+            profile: undefined,
+            score: Utils.MatchScore.NotMatch,
+        });
+    });
 });
 
 export const sqlAuthConn = {