Fix Web extension context integration test cases (#805)

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
     "cSpell.words": [
+      "lcid",
       "nupkg",
       "powerapps",
       "powerpages",

l10n/bundle.l10n.json

@@ -73,6 +73,9 @@
       "{0} represents the name of the file"
     ]
   },
+  "Enter the name of the web template": "Enter the name of the web template",
+  "Please enter a name for the web template.": "Please enter a name for the web template.",
+  "A webtemplate with the same name already exists. Please enter a different name.": "A webtemplate with the same name already exists. Please enter a different name.",
   "No page templates found": "No page templates found",
   "No webpages found": "No webpages found",
   "New Webpage": "New Webpage",
@@ -85,9 +88,6 @@
   "File(s) already exist. No new files to add": "File(s) already exist. No new files to add",
   "Web files": "Web files",
   "Webfile(s) added successfully": "Webfile(s) added successfully",
-  "Enter the name of the web template": "Enter the name of the web template",
-  "Please enter a name for the web template.": "Please enter a name for the web template.",
-  "A webtemplate with the same name already exists. Please enter a different name.": "A webtemplate with the same name already exists. Please enter a different name.",
   "Page Template name cannot be empty.": "Page Template name cannot be empty.",
   "New Page Template": "New Page Template",
   "Choose web template": "Choose web template",

src/web/client/WebExtensionContext.ts

@@ -345,14 +345,14 @@ class WebExtensionContext implements IWebExtensionContext {
         await this.setWebsiteLanguageCode();
 
         // Getting website Id to populate shared workspace for Co-Presence
-        const websiteid = this.urlParametersMap.get(
+        const websiteId = this.urlParametersMap.get(
             Constants.queryParameters.WEBSITE_ID
         ) as string;
 
         const headers = getCommonHeaders(this._dataverseAccessToken);
 
         // Populate shared workspace for Co-Presence
-        await this.populateSharedworkspace(headers, dataverseOrgUrl, websiteid);
+        await this.populateSharedWorkspace(headers, dataverseOrgUrl, websiteId);
     }
 
     public async dataverseAuthentication(firstTimeAuth = false) {
@@ -729,24 +729,24 @@ class WebExtensionContext implements IWebExtensionContext {
         this._worker = worker;
     }
 
-    private async populateSharedworkspace(
+    private async populateSharedWorkspace(
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         headers: any,
         dataverseOrgUrl: string,
-        websiteid: string
+        websiteId: string
     ) {
         try {
-            const sharedworkspace = await getOrCreateSharedWorkspace({
+            const sharedWorkspace = await getOrCreateSharedWorkspace({
                 headers,
                 dataverseOrgUrl,
-                websiteid,
+                websiteId: websiteId,
             });
 
             const sharedWorkSpaceParamsMap = new Map<string, string>();
-            for (const key in sharedworkspace) {
+            for (const key in sharedWorkspace) {
                 sharedWorkSpaceParamsMap.set(
                     String(key).trim().toLocaleLowerCase(),
-                    String(sharedworkspace[key]).trim()
+                    String(sharedWorkspace[key]).trim()
                 );
             }
 
@@ -759,7 +759,7 @@ class WebExtensionContext implements IWebExtensionContext {
         } catch (error) {
             this.telemetry.sendErrorTelemetry(
                 telemetryEventNames.WEB_EXTENSION_POPULATE_SHARED_WORKSPACE_SYSTEM_ERROR,
-                this.populateSharedworkspace.name,
+                this.populateSharedWorkspace.name,
                 Constants.WEB_EXTENSION_POPULATE_SHARED_WORKSPACE_SYSTEM_ERROR,
                 error as Error
             );

src/web/client/test/integration/WebExtensionContext.test.ts

@@ -119,7 +119,7 @@ describe("WebExtensionContext", () => {
             assert.calledOnceWithExactly(
                 sendErrorTelemetry,
                 telemetryEventNames.WEB_EXTENSION_DATAVERSE_AUTHENTICATION_MISSING,
-                'triggeredMethod'
+                WebExtensionContext.dataverseAuthentication.name
             );
             expect(WebExtensionContext.websiteIdToLanguage).empty;
             expect(WebExtensionContext.languageIdCodeMap).empty;
@@ -186,7 +186,8 @@ describe("WebExtensionContext", () => {
             fileName,
             attributePath,
             encodeAsBase64,
-            mimeType
+            mimeType,
+            true
         );
 
         //Assert
@@ -204,6 +205,9 @@ describe("WebExtensionContext", () => {
             _encodeAsBase64: true,
             _mimeType: "pdf",
             _hasDirtyChanges: false,
+            _hasDiffViewTriggered: false,
+            _isContentLoaded: true,
+            _logicalEntityName: undefined
         };
         expect(fileMap).deep.eq(expectedResult);
     });
@@ -253,12 +257,15 @@ describe("WebExtensionContext", () => {
             _encodeAsBase64: encodeAsBase64,
             _hasDirtyChanges: false,
             _mimeType: undefined,
+            _hasDiffViewTriggered: false,
+            _isContentLoaded: undefined,
+            _logicalEntityName: undefined
         };
 
         expect(fileMap).deep.eq(expectedResult);
     });
 
-    it("updateEntityDetailsInContext_whenPassAllParamsExcpet_shouldSetColumnContent", async () => {
+    it("updateEntityDetailsInContext_whenPassAllParamsExcept_shouldSetColumnContent", async () => {
         //Act
         const attributePaths = {
             relativePath: "relativePath",
@@ -334,7 +341,7 @@ describe("WebExtensionContext", () => {
             assert.calledOnceWithExactly(
                 sendErrorTelemetry,
                 telemetryEventNames.WEB_EXTENSION_DATAVERSE_AUTHENTICATION_MISSING,
-                'triggeredMethod'
+                WebExtensionContext.dataverseAuthentication.name
             );
             expect(WebExtensionContext.websiteIdToLanguage).length(0);
             expect(WebExtensionContext.languageIdCodeMap).length(0);
@@ -404,6 +411,15 @@ describe("WebExtensionContext", () => {
             "getWebsiteLanguageIdToPortalLanguageIdMap"
         ).returns(websiteLanguageIdToPortalLanguageMap);
 
+        const sharedWorkSpaceParamsMap = new Map<string, string>([
+            [
+                "workspaceKey",
+                "d8b40829-17c8-4082-9e3f-89d60dc0ab7e", // some guid value
+            ],
+        ]);
+        const getOrCreateSharedWorkspace = stub(urlBuilderUtil, "getOrCreateSharedWorkspace")
+            .resolves(sharedWorkSpaceParamsMap);
+
         const portalLanguageIdCodeMap = new Map<string, string>([
             ["d8b40829-17c8-4082-9e3f-89d60dc0ab7e", "1033"],
         ]);
@@ -447,7 +463,7 @@ describe("WebExtensionContext", () => {
         );
 
         expect(WebExtensionContext.dataverseAccessToken).eq(accessToken);
-        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL);
+        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL, true);
         assert.callCount(sendAPISuccessTelemetry, 3);
         assert.calledOnceWithExactly(
             getLcidCodeMap,
@@ -508,9 +524,9 @@ describe("WebExtensionContext", () => {
             Constants.initializationEntityName.WEBSITELANGUAGE
         );
 
-        const thrirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
-        expect(thrirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
-        expect(thrirdGetCustomRequestURLCall.args[1]).eq(
+        const thirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
+        expect(thirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
+        expect(thirdGetCustomRequestURLCall.args[1]).eq(
             Constants.initializationEntityName.PORTALLANGUAGE
         );
         //#endregion
@@ -531,6 +547,15 @@ describe("WebExtensionContext", () => {
         expect(thirdFetchCall.args[1]?.headers).deep.eq(header);
 
         //#endregion
+
+        assert.calledOnceWithExactly(
+            getOrCreateSharedWorkspace,
+            {
+                headers: header,
+                dataverseOrgUrl: ORG_URL,
+                websiteId: undefined
+            }
+        );
     });
 
     it("authenticateAndUpdateDataverseProperties_whenFetchCallFails_languageMapsShouldStillBeUpdated", async () => {
@@ -558,21 +583,6 @@ describe("WebExtensionContext", () => {
             "getCustomRequestURL"
         ).returns(requestUrl);
 
-        const sendAPIFailureTelemetry = stub(
-            WebExtensionContext.telemetry,
-            "sendAPIFailureTelemetry"
-        );
-
-        const sendAPITelemetry = stub(
-            WebExtensionContext.telemetry,
-            "sendAPITelemetry"
-        );
-
-        const sendAPISuccessTelemetry = stub(
-            WebExtensionContext.telemetry,
-            "sendAPISuccessTelemetry"
-        );
-
         const languageIdCodeMap = new Map<string, string>([["1033", "en-US"]]);
         const getLcidCodeMap = stub(schemaHelperUtil, "getLcidCodeMap").returns(
             languageIdCodeMap
@@ -631,54 +641,11 @@ describe("WebExtensionContext", () => {
         );
 
         expect(WebExtensionContext.dataverseAccessToken).eq(accessToken);
-        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL);
-        assert.calledThrice(sendAPISuccessTelemetry);
-        assert.calledOnceWithExactly(
-            getLcidCodeMap,
-            { value: "value" },
-            SCHEMA_VERSION.toLowerCase()
-        );
-        assert.calledOnceWithExactly(
-            getWebsiteIdToLcidMap,
-            { value: "value" },
-            SCHEMA_VERSION.toLowerCase()
-        );
-        assert.calledOnceWithExactly(
-            getPortalLanguageIdToLcidMap,
-            { value: "value" },
-            SCHEMA_VERSION.toLowerCase()
-        );
-        assert.calledOnceWithExactly(
-            getWebsiteLanguageIdToPortalLanguageIdMap,
-            { value: "value" },
-            SCHEMA_VERSION.toLowerCase()
-        );
-
-        assert.calledThrice(sendAPIFailureTelemetry);
-
-        //#region sendAPITelemetry calls
-        assert.calledThrice(sendAPITelemetry);
-        const firstSendAPITelemetryCall = sendAPITelemetry.getCalls()[0];
-        expect(firstSendAPITelemetryCall.args[0]).eq(requestUrl);
-        expect(firstSendAPITelemetryCall.args[1]).eq(
-            Constants.initializationEntityName.WEBSITE
-        );
-        expect(firstSendAPITelemetryCall.args[2]).eq(Constants.httpMethod.GET);
-
-        const secondSendAPITelemetryCall = sendAPITelemetry.getCalls()[1];
-        expect(secondSendAPITelemetryCall.args[0]).eq(requestUrl);
-        expect(secondSendAPITelemetryCall.args[1]).eq(
-            Constants.initializationEntityName.WEBSITELANGUAGE
-        );
-        expect(secondSendAPITelemetryCall.args[2]).eq(Constants.httpMethod.GET);
-
-        const thirdSendAPITelemetryCall = sendAPITelemetry.getCalls()[2];
-        expect(thirdSendAPITelemetryCall.args[0]).eq(requestUrl);
-        expect(thirdSendAPITelemetryCall.args[1]).eq(
-            Constants.initializationEntityName.PORTALLANGUAGE
-        );
-        expect(thirdSendAPITelemetryCall.args[2]).eq(Constants.httpMethod.GET);
-        //#endregion
+        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL, true);
+        assert.notCalled(getLcidCodeMap);
+        assert.notCalled(getWebsiteIdToLcidMap);
+        assert.notCalled(getPortalLanguageIdToLcidMap);
+        assert.notCalled(getWebsiteLanguageIdToPortalLanguageIdMap);
 
         //#region getCustomRequestURL calls
         assert.calledThrice(getCustomRequestURL);
@@ -694,9 +661,9 @@ describe("WebExtensionContext", () => {
             Constants.initializationEntityName.WEBSITELANGUAGE
         );
 
-        const thrirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
-        expect(thrirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
-        expect(thrirdGetCustomRequestURLCall.args[1]).eq(
+        const thirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
+        expect(thirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
+        expect(thirdGetCustomRequestURLCall.args[1]).eq(
             Constants.initializationEntityName.PORTALLANGUAGE
         );
         //#endregion
@@ -744,11 +711,6 @@ describe("WebExtensionContext", () => {
             "getCustomRequestURL"
         ).returns(requestUrl);
 
-        const sendAPIFailureTelemetry = stub(
-            WebExtensionContext.telemetry,
-            "sendAPIFailureTelemetry"
-        );
-
         const _mockFetch = stub(fetch, "default").throws();
         const languageIdCodeMap = new Map<string, string>([["1033", "en-US"]]);
         stub(schemaHelperUtil, "getLcidCodeMap").returns(languageIdCodeMap);
@@ -795,7 +757,7 @@ describe("WebExtensionContext", () => {
         );
         expect(WebExtensionContext.dataverseAccessToken).eq(accessToken);
 
-        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL);
+        assert.calledOnceWithExactly(dataverseAuthentication, ORG_URL, true);
         //#region  Fetch
         const header = getCommonHeaders(accessToken);
         assert.calledThrice(_mockFetch);
@@ -810,7 +772,6 @@ describe("WebExtensionContext", () => {
         const thirdFetchCall = _mockFetch.getCalls()[2];
         expect(thirdFetchCall.args[0], requestUrl);
         expect(thirdFetchCall.args[1]?.headers).deep.eq(header);
-        assert.calledThrice(sendAPIFailureTelemetry);
 
         //#endregion
 
@@ -828,9 +789,9 @@ describe("WebExtensionContext", () => {
             Constants.initializationEntityName.WEBSITELANGUAGE
         );
 
-        const thrirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
-        expect(thrirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
-        expect(thrirdGetCustomRequestURLCall.args[1]).eq(
+        const thirdGetCustomRequestURLCall = getCustomRequestURL.getCalls()[2];
+        expect(thirdGetCustomRequestURLCall.args[0]).eq(ORG_URL);
+        expect(thirdGetCustomRequestURLCall.args[1]).eq(
             Constants.initializationEntityName.PORTALLANGUAGE
         );
         //#endregion

src/web/client/utilities/urlBuilderUtil.ts

@@ -274,7 +274,7 @@ export async function getOrCreateSharedWorkspace(config: any) {
                 method: "POST",
                 body: JSON.stringify({
                     target: {
-                        name: getWorkSpaceName(config.websiteid),
+                        name: getWorkSpaceName(config.websiteId),
                     }
                 }),
             }