Skip to content

Commit

Permalink
fix(Gmail Trigger Node): Prevent error for empty emails, improve type…
Browse files Browse the repository at this point in the history 
… safety (#13171)
  • Loading branch information
@elsmr
elsmr authored Feb 11, 2025
1 parent 4c19bae commit 115a367
Show file tree
Hide file tree
Showing 4 changed files with 267 additions and 73 deletions.
150 changes: 79 additions & 71 deletions packages/nodes-base/nodes/Google/Gmail/GmailTrigger.node.ts
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { DateTime } from 'luxon';
import type {
IPollFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
IPollFunctions,
} from 'n8n-workflow';
import { NodeConnectionType } from 'n8n-workflow';

Expand All @@ -17,6 +17,15 @@ import {
prepareQuery,
simplifyOutput,
} from './GenericFunctions';
import type {
GmailTriggerFilters,
GmailTriggerOptions,
GmailWorkflowStaticData,
GmailWorkflowStaticDataDictionary,
Label,
Message,
MessageListResponse,
} from './types';

export class GmailTrigger implements INodeType {
description: INodeTypeDescription = {
Expand Down Expand Up @@ -206,12 +215,12 @@ export class GmailTrigger implements INodeType {
async getLabels(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];

const labels = await googleApiRequestAllItems.call(
const labels = (await googleApiRequestAllItems.call(
this,
'labels',
'GET',
'/gmail/v1/users/me/labels',
);
)) as Label[];

for (const label of labels) {
returnData.push({
Expand All @@ -234,50 +243,53 @@ export class GmailTrigger implements INodeType {
};

async poll(this: IPollFunctions): Promise<INodeExecutionData[][] | null> {
const workflowStaticData = this.getWorkflowStaticData('node');
const workflowStaticData = this.getWorkflowStaticData('node') as
| GmailWorkflowStaticData
| GmailWorkflowStaticDataDictionary;
const node = this.getNode();

let nodeStaticData = workflowStaticData;
let nodeStaticData = (workflowStaticData ?? {}) as GmailWorkflowStaticData;
if (node.typeVersion > 1) {
const nodeName = node.name;
if (workflowStaticData[nodeName] === undefined) {
workflowStaticData[nodeName] = {} as IDataObject;
nodeStaticData = workflowStaticData[nodeName] as IDataObject;
} else {
nodeStaticData = workflowStaticData[nodeName] as IDataObject;
const dictionary = workflowStaticData as GmailWorkflowStaticDataDictionary;
if (!(nodeName in workflowStaticData)) {
dictionary[nodeName] = {};
}
}

let responseData;
nodeStaticData = dictionary[nodeName];
}

const now = Math.floor(DateTime.now().toSeconds()).toString();
const startDate = (nodeStaticData.lastTimeChecked as string) || +now;
const startDate = nodeStaticData.lastTimeChecked ?? +now;
const endDate = +now;

const options = this.getNodeParameter('options', {}) as IDataObject;
const filters = this.getNodeParameter('filters', {}) as IDataObject;
const options = this.getNodeParameter('options', {}) as GmailTriggerOptions;
const filters = this.getNodeParameter('filters', {}) as GmailTriggerFilters;

let responseData: INodeExecutionData[] = [];

try {
const qs: IDataObject = {};
filters.receivedAfter = startDate;
const allFilters: GmailTriggerFilters = { ...filters, receivedAfter: startDate };

if (this.getMode() === 'manual') {
qs.maxResults = 1;
delete filters.receivedAfter;
delete allFilters.receivedAfter;
}

Object.assign(qs, prepareQuery.call(this, filters, 0), options);
Object.assign(qs, prepareQuery.call(this, allFilters, 0), options);

responseData = await googleApiRequest.call(
const messagesResponse: MessageListResponse = await googleApiRequest.call(
this,
'GET',
'/gmail/v1/users/me/messages',
{},
qs,
);
responseData = responseData.messages;

if (!responseData?.length) {
const messages = messagesResponse.messages ?? [];

if (!messages.length) {
nodeStaticData.lastTimeChecked = endDate;
return null;
}
Expand All @@ -291,48 +303,47 @@ export class GmailTrigger implements INodeType {
qs.format = 'raw';
}

let includeDrafts;
let includeDrafts = false;
if (node.typeVersion > 1.1) {
includeDrafts = (qs.includeDrafts as boolean) ?? false;
includeDrafts = filters.includeDrafts ?? false;
} else {
includeDrafts = (qs.includeDrafts as boolean) ?? true;
includeDrafts = filters.includeDrafts ?? true;
}

delete qs.includeDrafts;
const withoutDrafts = [];

for (let i = 0; i < responseData.length; i++) {
responseData[i] = await googleApiRequest.call(
for (const message of messages) {
const fullMessage = (await googleApiRequest.call(
this,
'GET',
`/gmail/v1/users/me/messages/${responseData[i].id}`,
`/gmail/v1/users/me/messages/${message.id}`,
{},
qs,
);
)) as Message;

if (!includeDrafts) {
if (responseData[i].labelIds.includes('DRAFT')) {
if (fullMessage.labelIds?.includes('DRAFT')) {
continue;
}
}
if (!simple && responseData?.length) {

if (!simple) {
const dataPropertyNameDownload =
(options.dataPropertyAttachmentsPrefixName as string) || 'attachment_';
options.dataPropertyAttachmentsPrefixName || 'attachment_';

responseData[i] = await parseRawEmail.call(
this,
responseData[i],
dataPropertyNameDownload,
);
const parsed = await parseRawEmail.call(this, fullMessage, dataPropertyNameDownload);
responseData.push(parsed);
} else {
responseData.push({ json: fullMessage });
}
withoutDrafts.push(responseData[i]);
}

if (!includeDrafts) {
responseData = withoutDrafts;
}

if (simple && responseData?.length) {
if (simple) {
responseData = this.helpers.returnJsonArray(
await simplifyOutput.call(this, responseData as IDataObject[]),
await simplifyOutput.call(
this,
responseData.map((item) => item.json),
),
);
}
} catch (error) {
Expand All @@ -349,60 +360,57 @@ export class GmailTrigger implements INodeType {
},
);
}
if (!responseData?.length) {
if (!responseData.length) {
nodeStaticData.lastTimeChecked = endDate;
return null;
}

const emailsWithInvalidDate = new Set<string>();
const getEmailDateAsSeconds = (email: IDataObject): number => {

const getEmailDateAsSeconds = (email: Message): number => {
let date;

if (email.internalDate) {
date = +(email.internalDate as string) / 1000;
date = +email.internalDate / 1000;
} else if (email.date) {
date = +DateTime.fromJSDate(new Date(email.date as string)).toSeconds();
} else {
date = +DateTime.fromJSDate(
new Date((email?.headers as IDataObject)?.date as string),
).toSeconds();
date = +DateTime.fromJSDate(new Date(email.date)).toSeconds();
} else if (email.headers?.date) {
date = +DateTime.fromJSDate(new Date(email.headers.date)).toSeconds();
}

if (!date || isNaN(date)) {
emailsWithInvalidDate.add(email.id as string);
emailsWithInvalidDate.add(email.id);
return +startDate;
}

return date;
};

const lastEmailDate = (responseData as IDataObject[]).reduce((lastDate, { json }) => {
const emailDate = getEmailDateAsSeconds(json as IDataObject);
const lastEmailDate = responseData.reduce((lastDate, { json }) => {
const emailDate = getEmailDateAsSeconds(json as Message);
return emailDate > lastDate ? emailDate : lastDate;
}, 0);

const nextPollPossibleDuplicates = (responseData as IDataObject[]).reduce(
(duplicates, { json }) => {
const emailDate = getEmailDateAsSeconds(json as IDataObject);
return emailDate <= lastEmailDate
? duplicates.concat((json as IDataObject).id as string)
: duplicates;
},
Array.from(emailsWithInvalidDate),
);

const possibleDuplicates = (nodeStaticData.possibleDuplicates as string[]) || [];
if (possibleDuplicates.length) {
responseData = (responseData as IDataObject[]).filter(({ json }) => {
const { id } = json as IDataObject;
return !possibleDuplicates.includes(id as string);
const nextPollPossibleDuplicates = responseData
.filter((item) => item.json)
.reduce((duplicates, { json }) => {
const emailDate = getEmailDateAsSeconds(json as Message);
return emailDate <= lastEmailDate ? duplicates.concat((json as Message).id) : duplicates;
}, Array.from(emailsWithInvalidDate));

const possibleDuplicates = new Set(nodeStaticData.possibleDuplicates ?? []);
if (possibleDuplicates.size > 0) {
responseData = responseData.filter(({ json }) => {
if (!json || typeof json.id !== 'string') return false;
return !possibleDuplicates.has(json.id);
});
}

nodeStaticData.possibleDuplicates = nextPollPossibleDuplicates;
nodeStaticData.lastTimeChecked = lastEmailDate || endDate;

if (Array.isArray(responseData) && responseData.length) {
return [responseData as INodeExecutionData[]];
return [responseData];
}

return null;
Expand Down
59 changes: 59 additions & 0 deletions packages/nodes-base/nodes/Google/Gmail/test/GmailTrigger.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,63 @@ describe('GmailTrigger', () => {

expect(response).toEqual(null);
});

it('should handle duplicates and different date fields', async () => {
const messageListResponse: MessageListResponse = {
messages: [
createListMessage({ id: '1' }),
createListMessage({ id: '2' }),
createListMessage({ id: '3' }),
createListMessage({ id: '4' }),
createListMessage({ id: '5' }),
],
resultSizeEstimate: 123,
};

nock(baseUrl)
.get('/gmail/v1/users/me/labels')
.reply(200, { labels: [{ id: 'testLabelId', name: 'Test Label Name' }] });
nock(baseUrl).get(new RegExp('/gmail/v1/users/me/messages?.*')).reply(200, messageListResponse);
nock(baseUrl)
.get(new RegExp('/gmail/v1/users/me/messages/1?.*'))
.reply(200, createMessage({ id: '1', internalDate: '1727777957863', date: undefined }));
nock(baseUrl)
.get(new RegExp('/gmail/v1/users/me/messages/2?.*'))
.reply(200, createMessage({ id: '2', internalDate: undefined, date: '1727777957863' }));
nock(baseUrl)
.get(new RegExp('/gmail/v1/users/me/messages/3?.*'))
.reply(
200,
createMessage({
id: '3',
internalDate: undefined,
date: undefined,
headers: { date: 'Thu, 5 Dec 2024 08:30:00 -0800' },
}),
);
nock(baseUrl)
.get(new RegExp('/gmail/v1/users/me/messages/4?.*'))
.reply(
200,
createMessage({
id: '4',
internalDate: undefined,
date: undefined,
headers: undefined,
}),
);
nock(baseUrl).get(new RegExp('/gmail/v1/users/me/messages/5?.*')).reply(200, {});

const { response } = await testPollingTriggerNode(GmailTrigger, {
node: { parameters: { simple: true } },
workflowStaticData: {
'Gmail Trigger': {
lastTimeChecked: new Date('2024-10-31').getTime() / 1000,
possibleDuplicates: ['1'],
},
},
});

expect(response).toMatchSnapshot();
});
});
Loading

0 comments on commit 115a367

Please sign in to comment.