Atualizar o código da minha aplicação para utilizar o SDK JavaScript do Microsoft Graph
O SDK JavaScript do Microsoft Graph inclui funcionalidades que simplificam o seu código e permitem-lhe concentrar-se na criação da sua aplicação.
Utilizar o SDK torna mais fácil para si:
- Lidar com erros de API para quando as coisas não funcionam como esperado, como quando os serviços são limitados sob carga pesada
- Executar operações de API complexas, como pedidos em lote
- Processar respostas binárias, como obter a fotografia de um utilizador
Migrar da obtenção para o SDK JavaScript do Graph
Se utilizar a API de obtenção para chamar APIs na sua aplicação JavaScript, poderá ter código semelhante ao seguinte:
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
});
Para utilizar o SDK JavaScript do Graph, altere o código para:
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
});
Lidar com erros da API
Um dos erros de API mais comuns que as aplicações que utilizam a experiência do Microsoft Graph quando utilizadas em escala são a limitação. Ocorre quando o servidor está sob muita carga. A limitação diminui a carga no servidor para manter o serviço em funcionamento.
Uma vez que a limitação raramente ocorre em inquilinos de programadores, muitas vezes os programadores chamam a API sem processar corretamente erros:
fetch('https://graph.microsoft.com/v1.0/me', {
method: 'GET',
headers: {
authorization: `Bearer ${accessToken}`
}
})
.then(response => response.json())
.then(json => {
// do something here
});
A forma adequada de lidar com erros de limitação com a API de obtenção seria expandir a chamada para watch erros de limitação 429 e aguardar antes de chamar a API novamente para o número de segundos designado no cabeçalho de retry-after
resposta. O código atualizado teria o seguinte aspeto:
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
Uma forma mais fácil de lidar com a limitação, e outros erros, é utilizar o SDK JavaScript do Graph, que processa erros por si.
const json = await graphClient.api('/me').get();
// do something here