René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Support Promises for API calls","articleBody":"I've been using both this SDK and the NodeJS SDK extensively for a few months now, and I've found that the SDKs are much easier to use when API calls are promise-based. I've been using a wrapper function that provides this functionality, which works fine but is not ideal. That looks something like this (shortened for brevity)  \r\n\r\n```javascript\r\nfunction playfabAPI(endpoint, requestObject) {\r\n    return new Promise(function(resolve, reject) {\r\n        PlayFabClientSDK[endpoint](requestObject, function(error, result) {\r\n            if (error !== null) {\r\n                // Request error\r\n                return reject(new Error(error));\r\n            }\r\n            else if (result \u0026\u0026 result[\"code\"] == 200) {\r\n                // Request successful\r\n                return resolve(result);\r\n            }\r\n            else {\r\n                // Non-200 HTTP status\r\n                return reject(new Error(result.status));\r\n            }\r\n        });\r\n    });\r\n}\r\n```  \r\n\r\nThis makes for cleaner code, adds useful functionality, and eliminates a lot of redundant error checking code. The current request functions are consistent enough for this to work in most cases so far but I'm a bit wary of using it in production. What I would propose is to implement this either alongside the current format, or as an additional SDK/script, for compatibility reasons.  \r\n\r\n\u003chr\u003e \r\n\r\n### Example of how this change could be implemented in a given function:  \r\n\r\n#### Current\r\n```javascript\r\nexports.UpdateUserData = function (request, callback) {\r\n    if (PlayFab._internalSettings.sessionTicket == null) {\r\n        throw \"Must be logged in to call this method\";\r\n    }\r\n    PlayFab.MakeRequest(\r\n        PlayFab.GetServerUrl() + \"/Client/UpdateUserData\",\r\n        request,\r\n        \"X-Authorization\",\r\n        PlayFab._internalSettings.sessionTicket,\r\n        function (error, result) {\r\n            if (callback != null) {\r\n                callback(error, result);\r\n            }\r\n        },\r\n    );\r\n};\r\n```\r\n\r\n#### Proposed\r\n```javascript\r\nexports.UpdateUserData = function (request)\r\n{\r\n    return new Promise((resolve, reject) =\u003e {\r\n        if (PlayFab._internalSettings.sessionTicket == null) {\r\n            throw \"Must be logged in to call this method\";\r\n        }\r\n        PlayFab.MakeRequest(\r\n            PlayFab.GetServerUrl() + \"/Client/UpdateUserData\",\r\n            request,\r\n            \"X-Authorization\",\r\n            PlayFab._internalSettings.sessionTicket,\r\n            (error, result) =\u003e {\r\n                if (error !== null) {\r\n                    return reject(new Error(error));\r\n                }\r\n                else if (result \u0026\u0026 result[\"code\"] == 200) {\r\n                    return resolve(result);\r\n                }\r\n                else {\r\n                    return reject(new Error(result.status));\r\n                }\r\n            },\r\n        );\r\n    });\r\n};\r\n```  \r\n\r\n\u003chr\u003e \r\n\r\n### Example usage of current vs proposed usage:  \r\n#### Current\r\n```javascript\r\nPlayFabClientSDK.UpdateUserData(requestParameters, function(error, result) {\r\n    // Check for + handle errors... \r\n    // Handle result...\r\n});\r\n```\r\n#### Proposed\r\n```javascript\r\nPlayFabClientSDK.UpdateUserData(requestParameters).then((userDataResult) =\u003e {\r\n    // Handle userDataResult...\r\n}).catch((error) =\u003e {\r\n    // Handle errors... \r\n});\r\n```\r\n\r\nThis would also have the added benefit of allowing the use of async/await which can greatly simplify code structure, e.g. when chaining requests\r\n```javascript\r\n(async function() {\r\n    const userDataResult = await PlayFabClientSDK.UpdateUserData(requestParameters);\r\n    // Handle userDataResult/make additional API requests\r\n})();\r\n```\r\n\r\n\u003chr\u003e\r\n\r\nLet me know what you guys think. Is this something that would be better served using the SDK generator with a custom config, or would it be feasible to get an official implementation? ","author":{"url":"https://github.com/403-Fruit","@type":"Person","name":"403-Fruit"},"datePublished":"2020-12-02T23:18:10.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/90/JavaScriptSDK/issues/90"}