From ad8faa66faae64e896972114720cb6f1dce80485 Mon Sep 17 00:00:00 2001 From: Stephen Wright Date: Thu, 18 Jun 2026 09:55:07 +0100 Subject: [PATCH] feat(Microsoft To Do Node): Allow custom OAuth2 scopes (#32538) --- .../MicrosoftToDoOAuth2Api.credentials.ts | 38 ++++- ...MicrosoftToDoOAuth2Api.credentials.test.ts | 153 ++++++++++++++++++ 2 files changed, 189 insertions(+), 2 deletions(-) create mode 100644 packages/nodes-base/credentials/test/MicrosoftToDoOAuth2Api.credentials.test.ts diff --git a/packages/nodes-base/credentials/MicrosoftToDoOAuth2Api.credentials.ts b/packages/nodes-base/credentials/MicrosoftToDoOAuth2Api.credentials.ts index ea46da6f178..2b47393c17a 100644 --- a/packages/nodes-base/credentials/MicrosoftToDoOAuth2Api.credentials.ts +++ b/packages/nodes-base/credentials/MicrosoftToDoOAuth2Api.credentials.ts @@ -1,5 +1,8 @@ import type { ICredentialType, INodeProperties } from 'n8n-workflow'; +//https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent +const defaultScopes = ['openid', 'offline_access', 'Tasks.ReadWrite']; + export class MicrosoftToDoOAuth2Api implements ICredentialType { name = 'microsoftToDoOAuth2Api'; @@ -10,12 +13,43 @@ export class MicrosoftToDoOAuth2Api implements ICredentialType { documentationUrl = 'microsoft'; properties: INodeProperties[] = [ - //https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent + { + displayName: 'Custom Scopes', + name: 'customScopes', + type: 'boolean', + default: false, + description: 'Define custom scopes', + }, + { + displayName: + 'The default scopes needed for the node to work are already set, If you change these the node may not function correctly.', + name: 'customScopesNotice', + type: 'notice', + default: '', + displayOptions: { + show: { + customScopes: [true], + }, + }, + }, + { + displayName: 'Enabled Scopes', + name: 'enabledScopes', + type: 'string', + displayOptions: { + show: { + customScopes: [true], + }, + }, + default: defaultScopes.join(' '), + description: 'Scopes that should be enabled', + }, { displayName: 'Scope', name: 'scope', type: 'hidden', - default: 'openid offline_access Tasks.ReadWrite', + default: + '={{$self["customScopes"] ? $self["enabledScopes"] : "' + defaultScopes.join(' ') + '"}}', }, ]; } diff --git a/packages/nodes-base/credentials/test/MicrosoftToDoOAuth2Api.credentials.test.ts b/packages/nodes-base/credentials/test/MicrosoftToDoOAuth2Api.credentials.test.ts new file mode 100644 index 00000000000..35bff76dc02 --- /dev/null +++ b/packages/nodes-base/credentials/test/MicrosoftToDoOAuth2Api.credentials.test.ts @@ -0,0 +1,153 @@ +import { ClientOAuth2 } from '@n8n/client-oauth2'; +import nock from 'nock'; + +import { MicrosoftToDoOAuth2Api } from '../MicrosoftToDoOAuth2Api.credentials'; + +describe('MicrosoftToDoOAuth2Api Credential', () => { + const microsoftToDoOAuth2Api = new MicrosoftToDoOAuth2Api(); + const defaultScopes = ['openid', 'offline_access', 'Tasks.ReadWrite']; + + // Shared OAuth2 configuration + const baseUrl = 'https://login.microsoftonline.com'; + const authorizationUri = `${baseUrl}/common/oauth2/v2.0/authorize`; + const accessTokenUri = `${baseUrl}/common/oauth2/v2.0/token`; + const redirectUri = 'http://localhost:5678/rest/oauth2-credential/callback'; + const clientId = 'test-client-id'; + const clientSecret = 'test-client-secret'; + + const createOAuthClient = (scopes: string[]) => + new ClientOAuth2({ + clientId, + clientSecret, + accessTokenUri, + authorizationUri, + redirectUri, + scopes, + }); + + const mockTokenEndpoint = (code: string, responseScopes: string[]) => { + nock(baseUrl) + .post('/common/oauth2/v2.0/token', (body: Record) => { + return ( + body.code === code && + body.grant_type === 'authorization_code' && + body.redirect_uri === redirectUri + ); + }) + .reply(200, { + access_token: 'test-access-token', + token_type: 'Bearer', + expires_in: 3600, + scope: responseScopes.join(' '), + }); + }; + + beforeAll(() => { + nock.disableNetConnect(); + }); + + afterAll(() => { + nock.restore(); + }); + + afterEach(() => { + nock.cleanAll(); + }); + + it('should have correct credential metadata', () => { + expect(microsoftToDoOAuth2Api.name).toBe('microsoftToDoOAuth2Api'); + expect(microsoftToDoOAuth2Api.extends).toEqual(['microsoftOAuth2Api']); + + // Verify default scopes are correctly defined + const enabledScopesProperty = microsoftToDoOAuth2Api.properties.find( + (p) => p.name === 'enabledScopes', + ); + expect(enabledScopesProperty?.default).toBe('openid offline_access Tasks.ReadWrite'); + }); + + it('should keep the scope hidden and default to the standard scopes when custom scopes are off', () => { + const scopeProperty = microsoftToDoOAuth2Api.properties.find((p) => p.name === 'scope'); + expect(scopeProperty?.type).toBe('hidden'); + expect(scopeProperty?.default).toBe( + '={{$self["customScopes"] ? $self["enabledScopes"] : "openid offline_access Tasks.ReadWrite"}}', + ); + }); + + describe('OAuth2 flow with default scopes', () => { + it('should include default scopes in authorization URI', () => { + const oauthClient = createOAuthClient(defaultScopes); + const authUri = oauthClient.code.getUri(); + + // Verify the authorization URI contains the correct scopes + // Scopes can be encoded with either %20 or + for spaces + expect(authUri).toMatch(/scope=(openid[+%20]offline_access[+%20]Tasks\.ReadWrite)/); + expect(authUri).toContain(`client_id=${clientId}`); + expect(authUri).toContain('response_type=code'); + }); + + it('should retrieve token successfully with default scopes', async () => { + const code = 'test-auth-code'; + mockTokenEndpoint(code, defaultScopes); + + const oauthClient = createOAuthClient(defaultScopes); + const token = await oauthClient.code.getToken(redirectUri + `?code=${code}`); + + expect(token.data.scope).toBe('openid offline_access Tasks.ReadWrite'); + }); + }); + + describe('OAuth2 flow with custom scopes', () => { + const customScopes = [ + 'openid', + 'offline_access', + 'Tasks.ReadWrite', + 'Tasks.ReadWrite.Shared', + 'User.Read', + ]; + + it('should include custom scopes in authorization URI', () => { + const oauthClient = createOAuthClient(customScopes); + const authUri = oauthClient.code.getUri(); + + expect(authUri).toContain('scope='); + expect(authUri).toContain('openid'); + expect(authUri).toContain('Tasks.ReadWrite.Shared'); + expect(authUri).toContain('User.Read'); + }); + + it('should retrieve token successfully with custom scopes', async () => { + const code = 'test-auth-code'; + mockTokenEndpoint(code, customScopes); + + const oauthClient = createOAuthClient(customScopes); + const token = await oauthClient.code.getToken(redirectUri + `?code=${code}`); + + expect(token.data.scope).toContain('openid'); + expect(token.data.scope).toContain('offline_access'); + expect(token.data.scope).toContain('Tasks.ReadWrite'); + expect(token.data.scope).toContain('Tasks.ReadWrite.Shared'); + expect(token.data.scope).toContain('User.Read'); + }); + + it('should handle completely different custom scopes', async () => { + const differentScopes = ['openid', 'offline_access', 'Calendars.Read', 'Mail.Send']; + const code = 'test-auth-code'; + mockTokenEndpoint(code, differentScopes); + + const oauthClient = createOAuthClient(differentScopes); + const authUri = oauthClient.code.getUri(); + + // Verify authorization URI has the different scopes + expect(authUri).toContain('Calendars.Read'); + expect(authUri).toContain('Mail.Send'); + expect(authUri).not.toContain('Tasks.ReadWrite'); + + const token = await oauthClient.code.getToken(redirectUri + `?code=${code}`); + + // Verify token response has the different scopes + expect(token.data.scope).toContain('Calendars.Read'); + expect(token.data.scope).toContain('Mail.Send'); + expect(token.data.scope).not.toContain('Tasks.ReadWrite'); + }); + }); +});