admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Miscrosoft Client errors when refreshing accessToken (#12884)

Browse Source 
# Context

We had an error saying "Unknown error importing calendar events for
[...]: Access token is undefined or empty. Please provide a valid token.
For more help -
https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CustomAuthenticationProvider.md
"

Reason is that the access token method for microsoft is a bit different
than the one from google. And in microsoft case, we want to check the
access token in the authProvider in case it fails. Currently it was not
catched, so it broke services above that counted on the accesstoken to
be valid.

That ended in UNKNOWN failure for our calendar event fetch service.

# Solution

This PR should solve the issue since :
1. forcing the method to break if accesstoken renewal fails
2. logs will help to know what kind of errors will be sent in case we
need to tackle this issue again
3. we now throw TEMPORARY error instead of unknown, allowing 3
getClientConfig failure before it is definitive

Why so many changes while it should have been simple :
The root cause is the `authProvider` from
`'@microsoft/microsoft-graph-client'` npm package. It does not throw a
custom error, and we cannot catch it on calling `Client.init`. Errors
only occurs when the client from
```
const client = this.microsoftOAuth2ClientManagerService.getOAuth2Client(refreshtoken) 
```
is used, as in `client.api('/messages').get().catch(err => [...])`

So we need to go in every call using the client and catch errors, and
rethrow whenver we need as a newly created message type
`MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE`


We discussed 1. and 2. with @bosiraphael already
I added 3. to make our system more robust without waiting for more
failures

# Related

Fixes : https://github.com/twentyhq/twenty/issues/12880

---------

Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
Guillim
2025-07-02 19:03:13 +02:00
committed by GitHub
parent 0a8670a223
commit 8cbb1aa71a
12 changed files with 140 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/services/microsoft-calendar-get-events.service.ts
View File

@ -6,10 +6,15 @@ import {
PageIteratorCallback,
} from '@microsoft/microsoft-graph-client';
import {
CalendarEventImportDriverException,
CalendarEventImportDriverExceptionCode,
} from 'src/modules/calendar/calendar-event-import-manager/drivers/exceptions/calendar-event-import-driver.exception';
import { parseMicrosoftCalendarError } from 'src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/parse-microsoft-calendar-error.util';
import { GetCalendarEventsResponse } from 'src/modules/calendar/calendar-event-import-manager/services/calendar-get-events.service';
import { MicrosoftOAuth2ClientManagerService } from 'src/modules/connected-account/oauth2-client-manager/drivers/microsoft/microsoft-oauth2-client-manager.service';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
@Injectable()
export class MicrosoftCalendarGetEventsService {
@ -56,6 +61,12 @@ export class MicrosoftCalendarGetEventsService {
nextSyncCursor: pageIterator.getDeltaLink() || '',
};
} catch (error) {
if (isAccessTokenRefreshingError(error?.body)) {
throw new CalendarEventImportDriverException(
error.message,
CalendarEventImportDriverExceptionCode.TEMPORARY_ERROR,
);
}
throw parseMicrosoftCalendarError(error);
}
}

12
packages/twenty-server/src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/services/microsoft-calendar-import-events.service.ts
View File

@ -2,11 +2,16 @@ import { Injectable } from '@nestjs/common';
import { Event } from '@microsoft/microsoft-graph-types';
import {
CalendarEventImportDriverException,
CalendarEventImportDriverExceptionCode,
} from 'src/modules/calendar/calendar-event-import-manager/drivers/exceptions/calendar-event-import-driver.exception';
import { formatMicrosoftCalendarEvents } from 'src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/format-microsoft-calendar-event.util';
import { parseMicrosoftCalendarError } from 'src/modules/calendar/calendar-event-import-manager/drivers/microsoft-calendar/utils/parse-microsoft-calendar-error.util';
import { FetchedCalendarEvent } from 'src/modules/calendar/common/types/fetched-calendar-event';
import { MicrosoftOAuth2ClientManagerService } from 'src/modules/connected-account/oauth2-client-manager/drivers/microsoft/microsoft-oauth2-client-manager.service';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
@Injectable()
export class MicrosoftCalendarImportEventsService {
@ -39,6 +44,13 @@ export class MicrosoftCalendarImportEventsService {
return formatMicrosoftCalendarEvents(events);
} catch (error) {
if (isAccessTokenRefreshingError(error?.body)) {
throw new CalendarEventImportDriverException(
error.message,
CalendarEventImportDriverExceptionCode.TEMPORARY_ERROR,
);
}
throw parseMicrosoftCalendarError(error);
}
}

11
packages/twenty-server/src/modules/connected-account/email-alias-manager/drivers/microsoft/microsoft-email-alias-manager.service.ts
View File

@ -1,7 +1,12 @@
import { Injectable } from '@nestjs/common';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import {
MessageImportDriverException,
MessageImportDriverExceptionCode,
} from 'src/modules/messaging/message-import-manager/drivers/exceptions/message-import-driver.exception';
import { MicrosoftClientProvider } from 'src/modules/messaging/message-import-manager/drivers/microsoft/providers/microsoft-client.provider';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
@Injectable()
export class MicrosoftEmailAliasManagerService {
@ -19,6 +24,12 @@ export class MicrosoftEmailAliasManagerService {
.api('/me?$select=proxyAddresses')
.get()
.catch((error) => {
if (isAccessTokenRefreshingError(error?.message)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
throw new Error(`Failed to fetch email aliases: ${error.message}`);
});

24
packages/twenty-server/src/modules/connected-account/oauth2-client-manager/drivers/microsoft/microsoft-oauth2-client-manager.service.ts
View File

@ -1,4 +1,4 @@
import { Injectable } from '@nestjs/common';
import { Injectable, Logger } from '@nestjs/common';
import {
AuthProvider,
@ -7,9 +7,13 @@ import {
} from '@microsoft/microsoft-graph-client';
import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
import { ConnectedAccountRefreshAccessTokenExceptionCode } from 'src/modules/connected-account/refresh-tokens-manager/exceptions/connected-account-refresh-tokens.exception';
@Injectable()
export class MicrosoftOAuth2ClientManagerService {
private readonly logger = new Logger(
MicrosoftOAuth2ClientManagerService.name,
);
constructor(private readonly twentyConfigService: TwentyConfigService) {}
public async getOAuth2Client(refreshToken: string): Promise<Client> {
@ -41,6 +45,24 @@ export class MicrosoftOAuth2ClientManagerService {
const data = await res.json();
if (!res.ok) {
if (data) {
const accessTokenSliced = data?.access_token?.slice(0, 10);
const refreshTokenSliced = data?.refresh_token?.slice(0, 10);
delete data.access_token;
delete data.refresh_token;
this.logger.error(data);
this.logger.error(`accessTokenSliced: ${accessTokenSliced}`);
this.logger.error(`refreshTokenSliced: ${refreshTokenSliced}`);
}
this.logger.error(res);
throw new Error(
`${MicrosoftOAuth2ClientManagerService.name} error: ${ConnectedAccountRefreshAccessTokenExceptionCode.REFRESH_ACCESS_TOKEN_FAILED}`,
);
}
callback(null, data.access_token);
} catch (error) {
callback(error, null);

1
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/exceptions/message-import-driver.exception.ts
View File

@ -15,4 +15,5 @@ export enum MessageImportDriverExceptionCode {
NO_NEXT_SYNC_CURSOR = 'NO_NEXT_SYNC_CURSOR',
SYNC_CURSOR_ERROR = 'SYNC_CURSOR_ERROR',
PROVIDER_NOT_SUPPORTED = 'PROVIDER_NOT_SUPPORTED',
CLIENT_NOT_AVAILABLE = 'CLIENT_NOT_AVAILABLE',
}

14
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/microsoft/providers/microsoft-client.provider.ts
View File

@ -17,16 +17,8 @@ export class MicrosoftClientProvider {
'refreshToken' | 'id'
>,
): Promise<Client> {
try {
return await this.microsoftOAuth2ClientManagerService.getOAuth2Client(
connectedAccount.refreshToken,
);
} catch (error) {
throw new Error(
`Failed to get Microsoft client: ${
error instanceof Error ? error.message : 'Unknown error'
}`,
);
}
return await this.microsoftOAuth2ClientManagerService.getOAuth2Client(
connectedAccount.refreshToken,
);
}
}

11
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-fetch-by-batch.service.ts
View File

@ -1,9 +1,14 @@
import { Injectable, Logger } from '@nestjs/common';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import {
MessageImportDriverException,
MessageImportDriverExceptionCode,
} from 'src/modules/messaging/message-import-manager/drivers/exceptions/message-import-driver.exception';
import { MicrosoftClientProvider } from 'src/modules/messaging/message-import-manager/drivers/microsoft/providers/microsoft-client.provider';
import { MicrosoftGraphBatchResponse } from 'src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-get-messages.interface';
import { MicrosoftHandleErrorService } from 'src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-handle-error.service';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
@Injectable()
export class MicrosoftFetchByBatchService {
@ -52,6 +57,12 @@ export class MicrosoftFetchByBatchService {
batchResponses.push(batchResponse);
} catch (error) {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
this.microsoftHandleErrorService.handleMicrosoftMessageFetchByBatchError(
error,
);

25
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-get-message-list.service.ts
View File

@ -18,6 +18,7 @@ import {
import { MicrosoftClientProvider } from 'src/modules/messaging/message-import-manager/drivers/microsoft/providers/microsoft-client.provider';
import { MicrosoftHandleErrorService } from 'src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-handle-error.service';
import { MessageFolderName } from 'src/modules/messaging/message-import-manager/drivers/microsoft/types/folders';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
import {
GetFullMessageListForFoldersResponse,
GetFullMessageListResponse,
@ -79,6 +80,12 @@ export class MicrosoftGetMessageListService {
})
.get()
.catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
this.microsoftHandleErrorService.handleMicrosoftGetMessageListError(
error,
);
@ -97,6 +104,12 @@ export class MicrosoftGetMessageListService {
});
await pageIterator.iterate().catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
this.microsoftHandleErrorService.handleMicrosoftGetMessageListError(
error,
);
@ -204,6 +217,12 @@ export class MicrosoftGetMessageListService {
})
.get()
.catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
this.microsoftHandleErrorService.handleMicrosoftGetMessageListError(
error,
);
@ -226,6 +245,12 @@ export class MicrosoftGetMessageListService {
});
await pageIterator.iterate().catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
this.microsoftHandleErrorService.handleMicrosoftGetMessageListError(
error,
);

7
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/microsoft/services/microsoft-handle-error.service.ts
View File

@ -70,6 +70,13 @@ export class MicrosoftHandleErrorService {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
public handleMicrosoftGetMessagesError(error: any): void {
if (
error instanceof MessageImportDriverException &&
error.code === MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE
) {
throw error;
}
if (!error.statusCode) {
throw new MessageImportDriverException(
`Microsoft Graph API unknown error: ${error}`,

7
packages/twenty-server/src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils.ts Normal file
View File

@ -0,0 +1,7 @@
import { ConnectedAccountRefreshAccessTokenExceptionCode } from 'src/modules/connected-account/refresh-tokens-manager/exceptions/connected-account-refresh-tokens.exception';
export const isAccessTokenRefreshingError = (body: string): boolean => {
return body.includes(
ConnectedAccountRefreshAccessTokenExceptionCode.REFRESH_ACCESS_TOKEN_FAILED,
);
};

1
packages/twenty-server/src/modules/messaging/message-import-manager/services/messaging-import-exception-handler.service.ts
View File

@ -60,6 +60,7 @@ export class MessageImportExceptionHandlerService {
case MessageNetworkExceptionCode.ECONNRESET:
case MessageNetworkExceptionCode.ETIMEDOUT:
case MessageNetworkExceptionCode.ERR_NETWORK:
case MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE:
await this.handleTemporaryException(
syncStep,
messageChannel,

30
packages/twenty-server/src/modules/messaging/message-import-manager/services/messaging-send-message.service.ts
View File

@ -5,9 +5,14 @@ import { assertUnreachable, isDefined } from 'twenty-shared/utils';
import { z } from 'zod';
import { ConnectedAccountWorkspaceEntity } from 'src/modules/connected-account/standard-objects/connected-account.workspace-entity';
import {
MessageImportDriverException,
MessageImportDriverExceptionCode,
} from 'src/modules/messaging/message-import-manager/drivers/exceptions/message-import-driver.exception';
import { GmailClientProvider } from 'src/modules/messaging/message-import-manager/drivers/gmail/providers/gmail-client.provider';
import { OAuth2ClientProvider } from 'src/modules/messaging/message-import-manager/drivers/gmail/providers/oauth2-client.provider';
import { MicrosoftClientProvider } from 'src/modules/messaging/message-import-manager/drivers/microsoft/providers/microsoft-client.provider';
import { isAccessTokenRefreshingError } from 'src/modules/messaging/message-import-manager/drivers/microsoft/utils/is-access-token-refreshing-error.utils';
import { mimeEncode } from 'src/modules/messaging/message-import-manager/utils/mime-encode.util';
interface SendMessageInput {
@ -86,11 +91,32 @@ export class MessagingSendMessageService {
const response = await microsoftClient
.api(`/me/messages`)
.post(message);
.post(message)
.catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
throw error;
});
z.string().parse(response.id);
await microsoftClient.api(`/me/messages/${response.id}/send`).post({});
await microsoftClient
.api(`/me/messages/${response.id}/send`)
.post({})
.catch((error) => {
if (isAccessTokenRefreshingError(error?.body)) {
throw new MessageImportDriverException(
error.message,
MessageImportDriverExceptionCode.CLIENT_NOT_AVAILABLE,
);
}
throw error;
});
break;
}
case ConnectedAccountProvider.IMAP_SMTP_CALDAV: {