Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for FQDNs for self-hosted ERPNext instances #1679

Merged
merged 1 commit into from Apr 30, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 39 additions & 1 deletion packages/nodes-base/credentials/ERPNextApi.credentials.ts
Expand Up @@ -20,13 +20,51 @@ export class ERPNextApi implements ICredentialType {
type: 'string' as NodePropertyTypes,
default: '',
},
{
displayName: 'Environment',
name: 'environment',
type: 'options' as NodePropertyTypes,
default: 'cloudHosted',
options: [
{
name: 'Cloud-hosted',
value: 'cloudHosted',
},
{
name: 'Self-hosted',
value: 'selfHosted',
},
],
},
{
displayName: 'Subdomain',
name: 'subdomain',
type: 'string' as NodePropertyTypes,
default: '',
placeholder: 'n8n',
description: 'ERPNext subdomain. For instance, entering n8n will make the url look like: https://n8n.erpnext.com/.',
description: 'Subdomain of cloud-hosted ERPNext instance. For example, "n8n" is the subdomain in: <code>https://n8n.erpnext.com</code>',
displayOptions: {
show: {
environment: [
'cloudHosted',
],
},
},
},
{
displayName: 'Domain',
name: 'domain',
type: 'string' as NodePropertyTypes,
default: '',
placeholder: 'https://www.mydomain.com',
description: 'Fully qualified domain name of self-hosted ERPNext instance.',
displayOptions: {
show: {
environment: [
'selfHosted',
],
},
},
},
];
}
27 changes: 21 additions & 6 deletions packages/nodes-base/nodes/ERPNext/GenericFunctions.ts
Expand Up @@ -24,8 +24,8 @@ export async function erpNextApiRequest(
uri?: string,
option: IDataObject = {},
) {

const credentials = this.getCredentials('erpNextApi');
const credentials = this.getCredentials('erpNextApi') as ERPNextApiCredentials;
const baseUrl = getBaseUrl(credentials);

if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
Expand All @@ -40,7 +40,7 @@ export async function erpNextApiRequest(
method,
body,
qs: query,
uri: uri || `https://${credentials.subdomain}.erpnext.com${resource}`,
uri: uri || `${baseUrl}${resource}`,
json: true,
};

Expand All @@ -56,13 +56,12 @@ export async function erpNextApiRequest(
try {
return await this.helpers.request!(options);
} catch (error) {

if (error.statusCode === 403) {
throw new NodeApiError(this.getNode(), { message: `DocType unavailable.` });
throw new NodeApiError(this.getNode(), { message: 'DocType unavailable.' });
}

if (error.statusCode === 307) {
throw new NodeApiError(this.getNode(), { message:`Please ensure the subdomain is correct.` });
throw new NodeApiError(this.getNode(), { message: 'Please ensure the subdomain is correct.' });
}

throw new NodeApiError(this.getNode(), error);
Expand Down Expand Up @@ -95,3 +94,19 @@ export async function erpNextApiRequestAllItems(

return returnData;
}

/**
* Return the base API URL based on the user's environment.
*/
const getBaseUrl = ({ environment, domain, subdomain }: ERPNextApiCredentials) =>
environment === 'cloudHosted'
? `https://${subdomain}.erpnext.com`
: domain;

type ERPNextApiCredentials = {
apiKey: string;
apiSecret: string;
environment: 'cloudHosted' | 'selfHosted';
subdomain?: string;
domain?: string;
};