changes in findCollectionName functionality; replace LogicalCollectionName with EntitySetName for a collection name

Author: AleksandrRogov

lib/requests/sendRequest.js

@@ -13,7 +13,8 @@ var _entityNames;
  */
 function findCollectionName(entityName) {
     var xrmInternal = Utility.getXrmInternal();
-    if (!Utility.isNull(xrmInternal)) {
+
+    if (!Utility.isNull(xrmInternal) && typeof xrmInternal.getEntitySetName === "function") {
         return xrmInternal.getEntitySetName(entityName) || entityName;
     }
 
@@ -23,7 +24,7 @@ function findCollectionName(entityName) {
         collectionName = _entityNames[entityName];
         if (Utility.isNull(collectionName)) {
             for (var key in _entityNames) {
-                if (_entityNames[key] == entityName) {
+                if (_entityNames[key] === entityName) {
                     return entityName;
                 }
             }
@@ -234,26 +235,37 @@ function sendRequest(method, path, config, data, additionalHeaders, responsePara
 
 function _getEntityNames(entityName, config, successCallback, errorCallback) {
 
-    var resolve = function (result) {
-        _entityNames = {};
-        for (var i = 0; i < result.data.value.length; i++) {
-            _entityNames[result.data.value[i].LogicalName] = result.data.value[i].LogicalCollectionName;
-        }
+    var xrmUtility = Utility.getXrmUtility();
 
-        successCallback(findCollectionName(entityName));
-    };
+    //try using Xrm.Utility.getEntityMetadata first (because D365 caches metadata)
+    if (!Utility.isNull(xrmUtility) && typeof xrmUtility.getEntityMetadata === "function") {
+        xrmUtility.getEntityMetadata(entityName).then(function (response) {
+            successCallback(response.EntitySetName);
+        }, errorCallback);
+    }
+    else {
+        //make a web api call for Node.js apps
+        var resolve = function (result) {
+            _entityNames = {};
+            for (var i = 0; i < result.data.value.length; i++) {
+                _entityNames[result.data.value[i].LogicalName] = result.data.value[i].EntitySetName;
+            }
 
-    var reject = function (error) {
-        errorCallback({ message: 'Unable to fetch EntityDefinitions. Error: ' + error.message });
-    };
+            successCallback(findCollectionName(entityName));
+        };
 
-    var request = RequestConverter.convertRequest({
-        collection: 'EntityDefinitions',
-        select: ['LogicalCollectionName', 'LogicalName'],
-        noCache: true
-    }, 'retrieveMultiple', config);
+        var reject = function (error) {
+            errorCallback({ message: 'Unable to fetch EntityDefinitions. Error: ' + error.message });
+        };
 
-    sendRequest('GET', request.url, config, null, request.headers, null, resolve, reject, false, request.async);
+        var request = RequestConverter.convertRequest({
+            collection: 'EntityDefinitions',
+            select: ['EntitySetName', 'LogicalName'],
+            noCache: true
+        }, 'retrieveMultiple', config);
+
+        sendRequest('GET', request.url, config, null, request.headers, null, resolve, reject, false, request.async);
+    }
 }
 
 function _isEntityNameException(entityName) {

lib/utilities/Utility.js

@@ -16,13 +16,13 @@ function generateUUID() { // Public Domain/MIT
 }
 
 function getXrmContext() {
-    if (typeof GetGlobalContext != 'undefined') {
+    if (typeof GetGlobalContext !== 'undefined') {
         return GetGlobalContext();
     }
     else {
-        if (typeof Xrm != 'undefined') {
+        if (typeof Xrm !== 'undefined') {
             //d365 v.9.0
-            if ((!isNull(Xrm.Utility) && !isNull(Xrm.Utility.getGlobalContext))) {
+            if (!isNull(Xrm.Utility) && !isNull(Xrm.Utility.getGlobalContext)) {
                 return Xrm.Utility.getGlobalContext();
             }
             else if (!isNull(Xrm.Page) && !isNull(Xrm.Page.context)) {
@@ -51,11 +51,11 @@ function initWebApiUrl(version) {
 
 function getXrmInternal() {
     //todo: Xrm.Internal namespace is not supported
-    if (typeof Xrm !== 'undefined') {
-        return Xrm.Internal;
-    }
+    return typeof Xrm !== "undefined" ? Xrm.Internal : null;
+}
 
-    return null;
+function getXrmUtility() {
+    return typeof Xrm !== "undefined" ? Xrm.Utility : null;
 }
 
 var Utility = {
@@ -97,6 +97,8 @@ var Utility = {
 
     getXrmInternal: getXrmInternal,
 
+    getXrmUtility: getXrmUtility,
+
     getClientUrl: getClientUrl,
 
     initWebApiUrl: initWebApiUrl

tests/common-tests.js

@@ -1674,7 +1674,7 @@ describe('Request.makeRequest', function () {
             var response = mocks.responses.response200;
             var response2 = mocks.responses.responseEntityDefinitions;
             scope = nock(mocks.webApiUrl)
-                .get('/EntityDefinitions?$select=LogicalCollectionName,LogicalName')
+                .get('/EntityDefinitions?$select=EntitySetName,LogicalName')
                 .once()
                 .reply(response2.status, response2.responseText, response2.responseHeaders)
                 .get('/tests(' + mocks.data.testEntityId + ')')
@@ -1721,7 +1721,7 @@ describe('Request.makeRequest', function () {
             var response = mocks.responses.response200;
             var response2 = mocks.responses.responseEntityDefinitions;
             scope = nock(mocks.webApiUrl)
-                .get('/EntityDefinitions?$select=LogicalCollectionName,LogicalName')
+                .get('/EntityDefinitions?$select=EntitySetName,LogicalName')
                 .once()
                 .reply(response2.status, response2.responseText, response2.responseHeaders)
                 .get('/tests(' + mocks.data.testEntityId + ')')
@@ -1785,7 +1785,7 @@ describe('Request.makeRequest', function () {
             var response = mocks.responses.response200;
             var response2 = mocks.responses.responseEntityDefinitions;
             scope = nock(mocks.webApiUrl)
-                .get('/EntityDefinitions?$select=LogicalCollectionName,LogicalName')
+                .get('/EntityDefinitions?$select=EntitySetName,LogicalName')
                 .once()
                 .reply(response2.status, response2.responseText, response2.responseHeaders)
                 .get('/tests(' + mocks.data.testEntityId + ')')

tests/main-tests.js

@@ -1177,7 +1177,7 @@ describe("promises -", function () {
                 var response = mocks.responses.basicEmptyResponseSuccess;
                 var response2 = mocks.responses.responseEntityDefinitions;
                 scope = nock(mocks.webApiUrl)
-                    .get('/EntityDefinitions?$select=LogicalCollectionName,LogicalName')
+                    .get('/EntityDefinitions?$select=EntitySetName,LogicalName')
                     .once()
                     .reply(response2.status, response2.responseText, response2.responseHeaders)
                     .post("/tests(" + mocks.data.testEntityId + ")/tests_records/$ref", {

tests/stubs.js

@@ -72,11 +72,11 @@ var dataStubs = {
         '@odata.context': 'context',
         oDataContext: 'context',
         value: [{
-            "LogicalCollectionName": "tests",
+            "EntitySetName": "tests",
             "LogicalName": "test",
             "MetadataId": "9dceed2b-9513-4a14-b09e-c176a6f1d9c3"
         }, {
-            "LogicalCollectionName": "records",
+            "EntitySetName": "records",
             "LogicalName": "record",
             "MetadataId": "18eb9672-3070-478c-be5b-e0324acb1188"
         }]