mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-02-21 02:56:40 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

✨ Add PostHog Node (#1440)

Browse source 
* ✨ PostHog Node

* ⚡ Minor improvements to PostHog Node

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Ricardo Espinoza 2021-02-14 11:56:34 -05:00 committed by GitHub
parent b183f3ec02
commit bb794b6da3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 894 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
packages/nodes-base/credentials/PostHogApi.credentials.ts Normal file
View file

@ -0,0 +1,23 @@
import {
ICredentialType,
NodePropertyTypes,
} from 'n8n-workflow';
export class PostHogApi implements ICredentialType {
name = 'postHogApi';
displayName = 'PostHog API';
properties = [
{
displayName: 'URL',
name: 'url',
type: 'string' as NodePropertyTypes,
default: 'https://app.posthog.com',
},
{
displayName: 'API Key',
name: 'apiKey',
type: 'string' as NodePropertyTypes,
default: '',
},
];
}

126
packages/nodes-base/nodes/PostHog/AliasDescription.ts Normal file
View file

@ -0,0 +1,126 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const aliasOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'alias',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an alias',
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const aliasFields = [
/* -------------------------------------------------------------------------- */
/* alias:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Alias',
name: 'alias',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'alias',
],
operation: [
'create',
],
},
},
default: '',
description: 'The name of the alias.',
},
{
displayName: 'Distinct ID',
name: 'distinctId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'alias',
],
operation: [
'create',
],
},
},
default: '',
description: `The user's distinct ID.`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'alias',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Context',
name: 'contextUi',
type: 'fixedCollection',
placeholder: 'Add Property',
default: {},
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Context',
name: 'contextValues',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
description: `If not set, it'll automatically be set to the current time.`,
},
],
},
] as INodeProperties[];

126
packages/nodes-base/nodes/PostHog/EventDescription.ts Normal file
View file

@ -0,0 +1,126 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const eventOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'event',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create an event',
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const eventFields = [
/* -------------------------------------------------------------------------- */
/* event:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Event',
name: 'eventName',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'event',
],
operation: [
'create',
],
},
},
default: '',
description: 'The name of the event.',
},
{
displayName: 'Distinct ID',
name: 'distinctId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'event',
],
operation: [
'create',
],
},
},
default: '',
description: `The user's distinct ID.`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'event',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Properties',
name: 'propertiesUi',
type: 'fixedCollection',
placeholder: 'Add Property',
default: {},
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'propertyValues',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
description: `If not set, it'll automatically be set to the current time.`,
},
],
},
] as INodeProperties[];

80
packages/nodes-base/nodes/PostHog/GenericFunctions.ts Normal file
View file

@ -0,0 +1,80 @@
import {
OptionsWithUrl,
} from 'request';
import {
IExecuteFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
export async function posthogApiRequest(this: IExecuteFunctions | ILoadOptionsFunctions, method: string, path: string, body: any = {}, qs: IDataObject = {}, option = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('postHogApi') as IDataObject;
const base = credentials.url as string;
body.api_key = credentials.apiKey as string;
const options: OptionsWithUrl = {
headers: {
'Content-Type': 'application/json',
},
method,
body,
qs,
url: `${base}${path}`,
json: true,
};
try {
if (Object.keys(body).length === 0) {
delete options.body;
}
return await this.helpers.request!(options);
} catch (error) {
if (error.response && error.response.body && error.response.body.message) {
const message = error.response.body.message;
// Try to return the error prettier
throw new Error(
`PosHog error response [${error.statusCode}]: ${message}`,
);
}
throw error;
}
}
export interface IEvent {
event: string;
properties: { [key: string]: any }; // tslint:disable-line:no-any
}
export interface IAlias {
type: string;
event: string;
properties: { [key: string]: any }; // tslint:disable-line:no-any
context: { [key: string]: any }; // tslint:disable-line:no-any
}
export interface ITrack {
type: string;
event: string;
name: string;
messageId?: string;
distinct_id: string;
category?: string;
properties: { [key: string]: any }; // tslint:disable-line:no-any
context: { [key: string]: any }; // tslint:disable-line:no-any
}
export interface IIdentity {
event: string;
messageId?: string;
distinct_id: string;
properties: { [key: string]: any }; // tslint:disable-line:no-any
}

113
packages/nodes-base/nodes/PostHog/IdentityDescription.ts Normal file
View file

@ -0,0 +1,113 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const identityOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'identity',
],
},
},
options: [
{
name: 'Create',
value: 'create',
},
],
default: 'create',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const identityFields = [
/* -------------------------------------------------------------------------- */
/* identity:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Distinct ID',
name: 'distinctId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'identity',
],
operation: [
'create',
],
},
},
default: '',
description: `The identity's distinct ID.`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'identity',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Properties',
name: 'propertiesUi',
type: 'fixedCollection',
placeholder: 'Add Property',
default: {},
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'propertyValues',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Message ID',
name: 'messageId',
type: 'string',
default: '',
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
description: `If not set, it'll automatically be set to the current time.`,
},
],
},
] as INodeProperties[];

248
packages/nodes-base/nodes/PostHog/PostHog.node.ts Normal file
View file

@ -0,0 +1,248 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
IAlias,
IEvent,
IIdentity,
ITrack,
posthogApiRequest,
} from './GenericFunctions';
import {
aliasFields,
aliasOperations,
} from './AliasDescription';
import {
eventFields,
eventOperations,
} from './EventDescription';
import {
trackFields,
trackOperations,
} from './TrackDescription';
import {
identityFields,
identityOperations,
} from './IdentityDescription';
import * as moment from 'moment-timezone';
export class PostHog implements INodeType {
description: INodeTypeDescription = {
displayName: 'PostHog',
name: 'postHog',
icon: 'file:postHog.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume PostHog API.',
defaults: {
name: 'PostHog',
color: '#000000',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'postHogApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Alias',
value: 'alias',
},
{
name: 'Event',
value: 'event',
},
{
name: 'Identity',
value: 'identity',
},
{
name: 'Track',
value: 'track',
},
],
default: 'event',
description: 'The resource to operate on.',
},
...aliasOperations,
...aliasFields,
...eventOperations,
...eventFields,
...identityOperations,
...identityFields,
...trackOperations,
...trackFields,
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = (items.length as unknown) as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
if (resource === 'alias') {
if (operation === 'create') {
for (let i = 0; i < length; i++) {
const distinctId = this.getNodeParameter('distinctId', i) as string;
const alias = this.getNodeParameter('alias', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const context = (additionalFields.contextUi as IDataObject || {}).contextValues as IDataObject[] || [];
const event: IAlias = {
type: 'alias',
event: '$create_alias',
context: context.reduce((obj, value) => Object.assign(obj, { [`${value.key}`]: value.value }), {}),
properties: {
distinct_id: distinctId,
alias,
},
};
Object.assign(event, additionalFields);
if (additionalFields.timestamp) {
additionalFields.timestamp = moment(additionalFields.timestamp as string).toISOString();
}
responseData = await posthogApiRequest.call(this, 'POST', '/batch', event);
returnData.push(responseData);
}
}
}
if (resource === 'event') {
if (operation === 'create') {
const events: IEvent[] = [];
for (let i = 0; i < length; i++) {
const eventName = this.getNodeParameter('eventName', i) as string;
const distinctId = this.getNodeParameter('distinctId', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const properties = (additionalFields.propertiesUi as IDataObject || {}).propertyValues as IDataObject[] || [];
const event: IEvent = {
event: eventName,
properties: properties.reduce((obj, value) => Object.assign(obj, { [`${value.key}`]: value.value }), {}),
};
event.properties['distinct_id'] = distinctId;
Object.assign(event, additionalFields);
if (additionalFields.timestamp) {
additionalFields.timestamp = moment(additionalFields.timestamp as string).toISOString();
}
//@ts-ignore
delete event.propertiesUi;
events.push(event);
}
responseData = await posthogApiRequest.call(this, 'POST', '/capture', { batch: events });
returnData.push(responseData);
}
}
if (resource === 'identity') {
if (operation === 'create') {
for (let i = 0; i < length; i++) {
const distinctId = this.getNodeParameter('distinctId', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const properties = (additionalFields.propertiesUi as IDataObject || {}).propertyValues as IDataObject[] || [];
const event: IIdentity = {
event: '$identify',
properties: properties.reduce((obj, value) => Object.assign(obj, { [`${value.key}`]: value.value }), {}),
distinct_id: distinctId,
};
Object.assign(event, additionalFields);
if (additionalFields.timestamp) {
additionalFields.timestamp = moment(additionalFields.timestamp as string).toISOString();
}
//@ts-ignore
delete event.propertiesUi;
responseData = await posthogApiRequest.call(this, 'POST', '/batch', event);
returnData.push(responseData);
}
}
}
if (resource === 'track') {
if (operation === 'page' || operation === 'screen') {
for (let i = 0; i < length; i++) {
const distinctId = this.getNodeParameter('distinctId', i) as string;
const name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const context = (additionalFields.contextUi as IDataObject || {}).contextValues as IDataObject[] || [];
const properties = (additionalFields.propertiesUi as IDataObject || {}).propertyValues as IDataObject[] || [];
const event: ITrack = {
name,
type: operation,
event: `$${operation}`,
context: context.reduce((obj, value) => Object.assign(obj, { [`${value.key}`]: value.value }), {}),
distinct_id: distinctId,
properties: properties.reduce((obj, value) => Object.assign(obj, { [`${value.key}`]: value.value }), {}),
};
Object.assign(event, additionalFields);
if (additionalFields.timestamp) {
additionalFields.timestamp = moment(additionalFields.timestamp as string).toISOString();
}
//@ts-ignore
delete event.propertiesUi;
responseData = await posthogApiRequest.call(this, 'POST', '/batch', event);
returnData.push(responseData);
}
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}

175
packages/nodes-base/nodes/PostHog/TrackDescription.ts Normal file
View file

@ -0,0 +1,175 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const trackOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'track',
],
},
},
options: [
{
name: 'Page',
value: 'page',
description: 'Track a page',
},
{
name: 'Screen',
value: 'screen',
description: 'Track a screen',
},
],
default: 'page',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const trackFields = [
/* -------------------------------------------------------------------------- */
/* track:page */
/* -------------------------------------------------------------------------- */
{
displayName: 'Name',
name: 'name',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
'screen',
],
},
},
default: '',
},
{
displayName: 'Distinct ID',
name: 'distinctId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
'screen',
],
},
},
default: '',
description: `The user's distinct ID.`,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'track',
],
operation: [
'page',
'screen',
],
},
},
default: {},
options: [
{
displayName: 'Category',
name: 'category',
type: 'string',
default: '',
},
{
displayName: 'Context',
name: 'contextUi',
type: 'fixedCollection',
placeholder: 'Add Property',
default: {},
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Context',
name: 'contextValues',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Message ID',
name: 'messageId',
type: 'string',
default: '',
},
{
displayName: 'Properties',
name: 'propertiesUi',
type: 'fixedCollection',
placeholder: 'Add Property',
default: {},
typeOptions: {
multipleValues: true,
},
options: [
{
displayName: 'Property',
name: 'propertyValues',
values: [
{
displayName: 'Key',
name: 'key',
type: 'string',
default: '',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Timestamp',
name: 'timestamp',
type: 'dateTime',
default: '',
description: `If not set, it'll automatically be set to the current time.`,
},
],
},
] as INodeProperties[];

1
packages/nodes-base/nodes/PostHog/postHog.svg Normal file
View file

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="300" height="300" fill="none" viewBox="0 0 300 300"><rect width="300" height="300" fill="#fff"/><path fill="#F9BD2B" d="M33 179.379L72.0038 218.33H33V179.379ZM33 169.641L81.7548 218.33H120.759L33 130.689V169.641ZM33 120.951L130.51 218.33H169.513L33 82V120.951ZM81.7548 120.951L179.264 218.33V179.379L81.7548 82V120.951ZM130.51 82V120.951L179.264 169.641V130.689L130.51 82Z"/><path fill="#000" d="M267.023 202.75C257.03 202.75 247.451 198.784 240.391 191.734L186.16 137.576V218.33H267.023V202.75Z"/><path fill="#fff" d="M209.563 202.75C213.871 202.75 217.363 199.262 217.363 194.959C217.363 190.657 213.871 187.169 209.563 187.169C205.254 187.169 201.762 190.657 201.762 194.959C201.762 199.262 205.254 202.75 209.563 202.75Z"/><path fill="#1D4AFF" d="M33 218.33H72.0038L33 179.379V218.33Z"/><path fill="#1D4AFF" d="M81.7548 130.689L33 82V120.951L81.7548 169.641V130.689Z"/><path fill="#1D4AFF" d="M33 130.689V169.641L81.7548 218.33V179.379L33 130.689Z"/><path fill="#F54E00" d="M130.51 130.689L81.7548 82V120.951L130.51 169.641V130.689Z"/><path fill="#F54E00" d="M81.7548 218.33H120.759L81.7548 179.379V218.33Z"/><path fill="#F54E00" d="M81.7548 130.689V169.641L130.51 218.33V179.379L81.7548 130.689Z"/></svg>
Side by side

After

Width:  |  Height:  |  Size: 1.2 KiB

2
packages/nodes-base/package.json
View file

@ -171,6 +171,7 @@
"dist/credentials/PipedriveOAuth2Api.credentials.js", "dist/credentials/PipedriveOAuth2Api.credentials.js",
"dist/credentials/PhilipsHueOAuth2Api.credentials.js", "dist/credentials/PhilipsHueOAuth2Api.credentials.js",
"dist/credentials/Postgres.credentials.js", "dist/credentials/Postgres.credentials.js",
"dist/credentials/PostHogApi.credentials.js",
"dist/credentials/PostmarkApi.credentials.js", "dist/credentials/PostmarkApi.credentials.js",
"dist/credentials/ProfitWellApi.credentials.js", "dist/credentials/ProfitWellApi.credentials.js",
"dist/credentials/PushbulletOAuth2Api.credentials.js", "dist/credentials/PushbulletOAuth2Api.credentials.js",
@ -422,6 +423,7 @@
"dist/nodes/Pipedrive/PipedriveTrigger.node.js", "dist/nodes/Pipedrive/PipedriveTrigger.node.js",
"dist/nodes/PhilipsHue/PhilipsHue.node.js", "dist/nodes/PhilipsHue/PhilipsHue.node.js",
"dist/nodes/Postgres/Postgres.node.js", "dist/nodes/Postgres/Postgres.node.js",
"dist/nodes/PostHog/PostHog.node.js",
"dist/nodes/Postmark/PostmarkTrigger.node.js", "dist/nodes/Postmark/PostmarkTrigger.node.js",
"dist/nodes/ProfitWell/ProfitWell.node.js", "dist/nodes/ProfitWell/ProfitWell.node.js",
"dist/nodes/Pushbullet/Pushbullet.node.js", "dist/nodes/Pushbullet/Pushbullet.node.js",