Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/cli/src/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ export const GENERIC_OAUTH2_CREDENTIALS_WITH_EDITABLE_SCOPE = [
'microsoftOAuth2Api',
'highLevelOAuth2Api',
'mcpOAuth2Api',
'wordpressOAuth2Api',
];

export const ARTIFICIAL_TASK_DATA = {
Expand Down
25 changes: 25 additions & 0 deletions packages/cli/src/oauth/__tests__/oauth.service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1130,6 +1130,31 @@ describe('OauthService', () => {
);
});

it('should not delete scope for wordpressOAuth2Api credentials', async () => {
const credential = mock<CredentialsEntity>({
id: '1',
type: 'wordpressOAuth2Api',
});
const mockDecryptedData = { clientId: 'client-id', scope: 'custom-scope' };
const mockOAuthCredentials = { clientId: 'client-id', scope: 'custom-scope' };
const mockAdditionalData = mock<IWorkflowExecuteAdditionalData>();

jest.mocked(WorkflowExecuteAdditionalData.getBase).mockResolvedValue(mockAdditionalData);
credentialsHelper.getDecrypted.mockResolvedValue(mockDecryptedData);
credentialsHelper.applyDefaultsAndOverwrites.mockResolvedValue(mockOAuthCredentials);

await service.getOAuthCredentials(credential);

expect(credentialsHelper.applyDefaultsAndOverwrites).toHaveBeenCalledWith(
mockAdditionalData,
{ clientId: 'client-id', scope: 'custom-scope' },
credential.type,
'internal',
undefined,
undefined,
);
});

it('should not delete scope for non-OAuth2 credentials', async () => {
const credential = mock<CredentialsEntity>({
id: '1',
Expand Down
100 changes: 100 additions & 0 deletions packages/nodes-base/credentials/WordpressOAuth2Api.credentials.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
import type { ICredentialType, INodeProperties } from 'n8n-workflow';
Comment thread
Joffcom marked this conversation as resolved.
Resolved

export class WordpressOAuth2Api implements ICredentialType {
Comment thread
Joffcom marked this conversation as resolved.
Resolved
name = 'wordpressOAuth2Api';

displayName = 'WordPress OAuth2 API';

extends = ['oAuth2Api'];

documentationUrl = 'wordpress';

properties: INodeProperties[] = [
{
displayName:
'OAuth2 authentication works with WordPress.com-hosted sites only. For self-hosted WordPress, use the WordPress API (Basic Auth) credential instead.',
name: 'wordpressComNotice',
type: 'notice',
default: '',
Comment thread
cubic-dev-ai[bot] marked this conversation as resolved.
Resolved
},
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
type: 'hidden',
default: 'https://public-api.wordpress.com/oauth2/authorize',
required: true,
},
{
displayName: 'Access Token URL',
name: 'accessTokenUrl',
type: 'hidden',
default: 'https://public-api.wordpress.com/oauth2/token',
required: true,
},
{
displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters',
type: 'hidden',
default: '',
},
{
displayName: 'Authentication',
name: 'authentication',
type: 'hidden',
default: 'header',
},
{
displayName: 'WordPress.com Site',
name: 'wordpressSite',
type: 'string',
default: '',
required: true,
Comment thread
Joffcom marked this conversation as resolved.
Resolved
placeholder: 'myblog.wordpress.com',
description:
'Your WordPress.com site identifier — either a .wordpress.com subdomain (e.g. myblog.wordpress.com) or a custom domain (e.g. myblog.com). Used in API requests that still route through public-api.wordpress.com.',
},
{
displayName: 'Custom Scopes',
name: 'customScopes',
type: 'boolean',
default: false,
description: 'Whether to define custom OAuth2 scopes instead of the defaults',
},
{
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: 'global',
description: 'Space-separated list of OAuth2 scopes to request',
},
{
displayName: 'Scope',
name: 'scope',
type: 'hidden',
default: '={{$self["customScopes"] ? $self["enabledScopes"] : "global"}}',
},
];
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { WordpressOAuth2Api } from '../WordpressOAuth2Api.credentials';

describe('WordpressOAuth2Api Credential', () => {
const credential = new WordpressOAuth2Api();

it('should have correct credential metadata', () => {
expect(credential.name).toBe('wordpressOAuth2Api');
expect(credential.extends).toEqual(['oAuth2Api']);

const authUrlProperty = credential.properties.find((p) => p.name === 'authUrl');
expect(authUrlProperty?.default).toBe('https://public-api.wordpress.com/oauth2/authorize');

const accessTokenUrlProperty = credential.properties.find((p) => p.name === 'accessTokenUrl');
expect(accessTokenUrlProperty?.default).toBe('https://public-api.wordpress.com/oauth2/token');
});

it('should have a notice about WordPress.com-only support', () => {
const noticeProperty = credential.properties.find((p) => p.name === 'wordpressComNotice');
expect(noticeProperty).toBeDefined();
expect(noticeProperty?.type).toBe('notice');
expect(noticeProperty?.default).toBe('');
});

it('should have a required wordpressSite field with no default', () => {
const siteProperty = credential.properties.find((p) => p.name === 'wordpressSite');
expect(siteProperty).toBeDefined();
expect(siteProperty?.type).toBe('string');
expect(siteProperty?.required).toBe(true);
expect(siteProperty?.default).toBe('');
});

it('should have custom scopes toggle defaulting to false', () => {
const customScopesProperty = credential.properties.find((p) => p.name === 'customScopes');
expect(customScopesProperty?.default).toBe(false);
});

it('should have enabledScopes defaulting to "global"', () => {
const enabledScopesProperty = credential.properties.find((p) => p.name === 'enabledScopes');
expect(enabledScopesProperty?.default).toBe('global');
});

it('should use enabledScopes when customScopes is true, otherwise fall back to "global"', () => {
const scopeProperty = credential.properties.find((p) => p.name === 'scope');
expect(scopeProperty?.default).toBe(
'={{$self["customScopes"] ? $self["enabledScopes"] : "global"}}',
);
});
});
29 changes: 25 additions & 4 deletions packages/nodes-base/nodes/Wordpress/GenericFunctions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,29 @@ export async function wordpressApiRequest(
uri?: string,
option: IDataObject = {},
): Promise<any> {
const credentials = await this.getCredentials('wordpressApi');
const authType = this.getNodeParameter('authType', 0, 'basicAuth') as string;
const isOAuth2 = authType === 'oAuth2';

let baseUri: string;
let credentialType: string;
let rejectUnauthorized: boolean | undefined;

if (isOAuth2) {
const credentials = await this.getCredentials('wordpressOAuth2Api');
credentialType = 'wordpressOAuth2Api';
let site = credentials.wordpressSite as string;
try {
site = new URL(site).hostname;
} catch {
site = site.split('/')[0];

@cubic-dev-ai cubic-dev-ai Bot Mar 23, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Fallback site normalization should strip query/hash too; otherwise protocol-less inputs like myblog.com?x=1 generate malformed API URLs.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At packages/nodes-base/nodes/Wordpress/GenericFunctions.ts, line 35:

<comment>Fallback site normalization should strip query/hash too; otherwise protocol-less inputs like `myblog.com?x=1` generate malformed API URLs.</comment>

<file context>
@@ -28,17 +28,13 @@ export async function wordpressApiRequest(
+		try {
+			site = new URL(site).hostname;
+		} catch {
+			site = site.split('/')[0];
 		}
-		baseUri = `https://public-api.wordpress.com/wp/v2${sitePrefix}`;
</file context>
Suggested change
site = site.split('/')[0];
site = site.split(/[/?#]/)[0];
Fix with Cubic

}
baseUri = `https://public-api.wordpress.com/wp/v2/sites/${site}`;
} else {
const credentials = await this.getCredentials('wordpressApi');
credentialType = 'wordpressApi';
baseUri = `${credentials.url as string}/wp-json/wp/v2`;
rejectUnauthorized = !(credentials.allowUnauthorizedCerts as boolean);
}

let options: IRequestOptions = {
headers: {
Expand All @@ -29,16 +51,15 @@ export async function wordpressApiRequest(
method,
qs,
body,
uri: uri || `${credentials.url}/wp-json/wp/v2${resource}`,
rejectUnauthorized: !credentials.allowUnauthorizedCerts,
uri: uri ?? `${baseUri}${resource}`,
...(rejectUnauthorized !== undefined ? { rejectUnauthorized } : {}),
json: true,
};
options = Object.assign({}, options, option);
if (Object.keys(options.body as IDataObject).length === 0) {
delete options.body;
}
try {
const credentialType = 'wordpressApi';
return await this.helpers.requestWithAuthentication.call(this, credentialType, options);
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
Expand Down
31 changes: 31 additions & 0 deletions packages/nodes-base/nodes/Wordpress/Wordpress.node.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,40 @@ export class Wordpress implements INodeType {
{
name: 'wordpressApi',
required: true,
displayOptions: {
show: {
authType: ['basicAuth'],
},
},
},
{
name: 'wordpressOAuth2Api',
required: true,
displayOptions: {
show: {
authType: ['oAuth2'],
},
},
},
],
properties: [
{
displayName: 'Authentication',
name: 'authType',
type: 'options',
options: [
{
name: 'Basic Auth',
value: 'basicAuth',
},
{
name: 'OAuth2 (WordPress.com)',
value: 'oAuth2',
},
],
default: 'basicAuth',
description: 'The authentication method to use',
},
{
displayName: 'Resource',
name: 'resource',
Expand Down
Loading
Loading