Обновление кода приложения для использования пакета SDK JavaScript для Microsoft Graph
Пакет SDK JavaScript для Microsoft Graph содержит функции, которые упрощают код и позволяют сосредоточиться на создании приложения.
Использование пакета SDK упрощает следующие действия:
- Обработка ошибок API для случаев, когда вещи не работают должным образом, например при регулировании служб при высокой нагрузке
- Выполнение сложных операций API, таких как пакетные запросы
- Обработка двоичных ответов, таких как получение фотографии пользователя
Миграция с выборки на пакет SDK Для JavaScript для Graph
Если вы используете API выборки для вызова API в приложении JavaScript, у вас может быть код, аналогичный следующему:
const msalClient = new msal.PublicClientApplication({
auth: {
clientId: appId
}
});
function getAccessToken(msalClient) {
const accounts = msalClient.getAllAccounts();
if (accounts.length > 0) {
const accessTokenRequest = {
scopes: [
'https://graph.microsoft.com/User.Read'
],
account: accounts[0]
};
return msalClient.acquireTokenSilent(accessTokenRequest)
.then(response => response.accessToken)
.catch(error => {
console.log(error);
console.log("silent token acquisition fails. acquiring token using redirect");
if (error instanceof msal.InteractionRequiredAuthError) {
return msalClient.acquireTokenRedirect(accessTokenRequest);
}
});
}
else {
return Promise.reject('Sign in');
}
}
msalClient
.loginPopup()
.then(response => getAccessToken(msalClient))
.then(accessToken => fetch('https://graph.microsoft.com/v1.0/me', {
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`
}
}))
.then(response => response.json())
.then(json => {
// do something here
});
Чтобы использовать пакет SDK Для JavaScript для Graph, измените код на:
const msalClient = new msal.PublicClientApplication({
auth: {
clientId: appId
}
});
function getGraphClient(account) {
const authProvider = new MSGraphAuthCodeMSALBrowserAuthProvider.AuthCodeMSALBrowserAuthenticationProvider(msalClient, {
account,
scopes: [
'https://graph.microsoft.com/User.Read'
],
interactionType: msal.InteractionType.Popup,
});
return MicrosoftGraph.Client.initWithMiddleware({ authProvider });
}
msalClient
.loginPopup()
.then(response => {
const accounts = msalClient.getAllAccounts();
if (accounts.length > 0) {
const graphClient = getGraphClient(accounts[0]);
return graphClient.api('/me').get();
}
else {
return Promise.reject('Sign in');
}
})
.then(json => {
// do something here
});
Обработка ошибок API
Одной из наиболее распространенных ошибок API, которые используют приложения, использующие Microsoft Graph, при использовании в большом масштабе, является регулирование. Это происходит, когда сервер находится под большой нагрузкой. Регулирование уменьшает нагрузку на сервер для поддержания работоспособности службы.
Так как регулирование редко происходит в клиентах разработчиков, часто разработчики вызывают API без правильной обработки ошибок:
fetch('https://graph.microsoft.com/v1.0/me', {
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`
}
})
.then(response => response.json())
.then(json => {
// do something here
});
Правильный способ обработки ошибок регулирования с помощью API выборки — расширить вызов watch для ошибок регулирования 429 и подождать перед повторным вызовом API на количество секунд, указанное в retry-after
заголовке ответа. Обновленный код будет выглядеть следующим образом:
function sleep(milliseconds) {
return new Promise((resolve) => setTimeout(resolve, milliseconds));
}
async function fetchAndRetryIfNecessary(callAPIFn) {
const response = await callAPIFn();
if (response.status === 429) {
const retryAfter = response.headers.get('retry-after');
await sleep(retryAfter * 1000);
return fetchAndRetryIfNecessary(callAPIFn);
}
return response;
}
const response = await fetchAndRetryIfNecessary(async () => (
await fetch('https://graph.microsoft.com/v1.0/me', {
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`
}
})
));
const json = await response.json();
// do something here
Более простой способ обработки регулирования и других ошибок — использовать пакет SDK JavaScript для Graph, который обрабатывает ошибки за вас.
const json = await graphClient.api('/me').get();
// do something here