Add eventTypes parameter to Google Calendar inputAlphaGit/worklogger#1674

Sign in

# Repo & Issue Metadata
Repo: worklogger: Generating work logs (timesheets) from multiple formats to multiple formats, and a tagging system to classify them
Issue Title: add eventTypes parameter to Google Calendar input

Issue Description: The GoogleCalendar Events.list API will start receiving an `eventTypes` parameter, which will be an array of strings. We need to give it the value `["default"]` so that when they change their default behaviour we will not be impacted.
The changes should happen in the `app/inputs/GoogleCalendar/Input.ts` file and its related tests.

<section id="A">
import { getLogger, LoggerCategory } from '../../services/Logger';
import { google, Auth } from 'googleapis';

import { IAppConfiguration, IServiceRegistrations, Worklog } from '../../models';
import { getUserAuthenticatedOAuthClient } from '../../services/authHandler';

import { IApiResponse, ModelMapper, GoogleCalendarConfiguration, GoogleCalendarCalendarConfiguration } from '.';
import { IInput } from '../IInput';

</section id="A">
<section id="B">
export class Input implements IInput {
    private logger = getLogger(LoggerCategory.Inputs);
    private modelMapper: ModelMapper = new ModelMapper();
    private inputConfiguration: GoogleCalendarConfiguration;

    constructor(
        serviceRegistrations: IServiceRegistrations,
        appConfiguration: IAppConfiguration,
        inputConfiguration: GoogleCalendarConfiguration
    ) {
        if (!serviceRegistrations)
            throw new Error('ServiceRegistrations for GoogleCalendarInput is required');

        if (!inputConfiguration)
            throw new Error('Configuration for GoogleCalendarInput is required');

        this.inputConfiguration = inputConfiguration;
        this.name = inputConfiguration.name;
    }

</section id="B">
<section id="C">
    name: string;

    async getWorkLogs(startDateTime: Date, endDateTime: Date): Promise<Worklog[]> {
        this.logger.info(`Retrieving worklogs from Google Calendar between ${startDateTime} and ${endDateTime}`);
        const oauth2Client = await getUserAuthenticatedOAuthClient();
        const apiResponses = await this._getEventsFromApi(oauth2Client, startDateTime, endDateTime);
        return this.modelMapper.map(apiResponses);
    }

</section id="C">
<section id="D">
    async _getEventsFromApi(auth: Auth.OAuth2Client, startDateTime: Date, endDateTime: Date): Promise<IApiResponse[]> {
        const calendarReturnPromises = this.inputConfiguration.calendars
            .map(calendarInfo => this._getEventsFromApiSingleCalendar(auth, calendarInfo, startDateTime, endDateTime));
        return await Promise.all(calendarReturnPromises);
    }

</section id="D">
<section id="E">
    async _getEventsFromApiSingleCalendar(auth: Auth.OAuth2Client, calendar: GoogleCalendarCalendarConfiguration, startDateTime: Date, endDateTime: Date): Promise<IApiResponse> {
        this.logger.debug('Filtering calendar events from', startDateTime, 'to', endDateTime);

        this.logger.debug('Retrieving entries from calendar', calendar.id);

</section id="E">
<section id="F">
        try {
            const calendarResponse = await google.calendar("v3").events.list({
                auth,
                calendarId: calendar.id,
                timeMin: startDateTime.toISOString(),
                timeMax: endDateTime.toISOString(),
                maxResults: 2500,
                singleEvents: true,
                orderBy: 'startTime'
            });
            this.logger.trace('Calendar response', { calendarResponse });

            const calendarEvents = (calendarResponse.data.items || [])
                .filter(e => new Date(e.start?.dateTime ?? 0) >= startDateTime);

            const apiResponse: IApiResponse = {
                calendarConfig: calendar,
                events: calendarEvents
            };

            return apiResponse;
        } catch (err) {
            this.logger.error('Error retrieving calendar events', err);
            throw err;
        }
    }
}

export default Input;
</section id="F">

# Request
• In the `events.list` method call, add the `eventTypes` parameter with the value `["default"]` to the existing parameters. This ensures that the API call explicitly requests the default event types, safeguarding against future changes to the API's default behavior.
• The modified code block should look like this:
```typescript
const calendarResponse = await google.calendar("v3").events.list({
    auth,
    calendarId: calendar.id,
    timeMin: startDateTime.toISOString(),
    timeMax: endDateTime.toISOString(),
    maxResults: 2500,
    singleEvents: true,
    eventTypes: ["default"], // Add this line
});
```

SUCCESS
Here are the new code sections:

The following changes have been applied:
```diff
--- 
+++ 
@@ -55,7 +55,8 @@
                 timeMax: endDateTime.toISOString(),
                 maxResults: 2500,
                 singleEvents: true,
-                orderBy: 'startTime'
+                orderBy: 'startTime',
+                eventTypes: ["default"], // Add this line
             });
             this.logger.trace('Calendar response', { calendarResponse });
 

```
Here are the new code sections:




<section id="A">
import { getLogger, LoggerCategory } from '../../services/Logger';
import { google, Auth } from 'googleapis';

import { IAppConfiguration, IServiceRegistrations, Worklog } from '../../models';
import { getUserAuthenticatedOAuthClient } from '../../services/authHandler';

import { IApiResponse, ModelMapper, GoogleCalendarConfiguration, GoogleCalendarCalendarConfiguration } from '.';
import { IInput } from '../IInput';

</section id="A">
<section id="B">
export class Input implements IInput {
    private logger = getLogger(LoggerCategory.Inputs);
    private modelMapper: ModelMapper = new ModelMapper();
    private inputConfiguration: GoogleCalendarConfiguration;

    constructor(
        serviceRegistrations: IServiceRegistrations,
        appConfiguration: IAppConfiguration,
        inputConfiguration: GoogleCalendarConfiguration
    ) {
        if (!serviceRegistrations)
            throw new Error('ServiceRegistrations for GoogleCalendarInput is required');

        if (!inputConfiguration)
            throw new Error('Configuration for GoogleCalendarInput is required');

        this.inputConfiguration = inputConfiguration;
        this.name = inputConfiguration.name;
    }

</section id="B">
<section id="C">
    name: string;

    async getWorkLogs(startDateTime: Date, endDateTime: Date): Promise<Worklog[]> {
        this.logger.info(`Retrieving worklogs from Google Calendar between ${startDateTime} and ${endDateTime}`);
        const oauth2Client = await getUserAuthenticatedOAuthClient();
        const apiResponses = await this._getEventsFromApi(oauth2Client, startDateTime, endDateTime);
        return this.modelMapper.map(apiResponses);
    }

</section id="C">
<section id="D">
    async _getEventsFromApi(auth: Auth.OAuth2Client, startDateTime: Date, endDateTime: Date): Promise<IApiResponse[]> {
        const calendarReturnPromises = this.inputConfiguration.calendars
            .map(calendarInfo => this._getEventsFromApiSingleCalendar(auth, calendarInfo, startDateTime, endDateTime));
        return await Promise.all(calendarReturnPromises);
    }

</section id="D">
<section id="E">
    async _getEventsFromApiSingleCalendar(auth: Auth.OAuth2Client, calendar: GoogleCalendarCalendarConfiguration, startDateTime: Date, endDateTime: Date): Promise<IApiResponse> {
        this.logger.debug('Filtering calendar events from', startDateTime, 'to', endDateTime);

        this.logger.debug('Retrieving entries from calendar', calendar.id);

</section id="E">
<section id="F">
        try {
            const calendarResponse = await google.calendar("v3").events.list({
                auth,
                calendarId: calendar.id,
                timeMin: startDateTime.toISOString(),
                timeMax: endDateTime.toISOString(),
                maxResults: 2500,
                singleEvents: true,
                orderBy: 'startTime',
                eventTypes: ["default"], // Add this line
            });
            this.logger.trace('Calendar response', { calendarResponse });

            const calendarEvents = (calendarResponse.data.items || [])
                .filter(e => new Date(e.start?.dateTime ?? 0) >= startDateTime);

            const apiResponse: IApiResponse = {
                calendarConfig: calendar,
                events: calendarEvents
            };

            return apiResponse;
        } catch (err) {
            this.logger.error('Error retrieving calendar events', err);
            throw err;
        }
    }
}

export default Input;
</section id="F">

You can continue to make changes to the code sections and call the `search_and_replace` function again.

# Repo & Issue Metadata
Repo: worklogger: Generating work logs (timesheets) from multiple formats to multiple formats, and a tagging system to classify them
Issue Title: add eventTypes parameter to Google Calendar input

Issue Description: The GoogleCalendar Events.list API will start receiving an `eventTypes` parameter, which will be an array of strings. We need to give it the value `["default"]` so that when they change their default behaviour we will not be impacted.
The changes should happen in the `app/inputs/GoogleCalendar/Input.ts` file and its related tests.

You have previously changed these files:
<changed_file file_path="app/inputs/GoogleCalendar/Input.ts">
--- 
+++ 
@@ -55,7 +55,8 @@
                 timeMax: endDateTime.toISOString(),
                 maxResults: 2500,
                 singleEvents: true,
-                orderBy: 'startTime'
+                orderBy: 'startTime',
+                eventTypes: ["default"], // Add this line
             });
             this.logger.trace('Calendar response', { calendarResponse });
 

</changed_file>

<section id="A">
const mockedGetUserAuthenticatedOAuthClient = jest.fn();
jest.mock('../../services/authHandler', () => ({
    getUserAuthenticatedOAuthClient: mockedGetUserAuthenticatedOAuthClient
}));

import { Input, GoogleCalendarConfiguration } from '.'
import { AppConfigurations, Dates, ServiceRegistrations } from '../../../tests/entities';

const mockedGetEventsList = jest.fn();
jest.mock('googleapis', () => ({
    google: {
        calendar: () => ({
            events: {
                list: mockedGetEventsList
            }
        }),
        auth: {
            OAuth2Client: jest.fn()
        }
    }
}));

</section id="A">
<section id="B">
const defaultConfiguration: GoogleCalendarConfiguration = {
    calendars: [{
        id: '1@google.com',
        includeTags: []
    }],
    storageRelativePath: 'localPath/subPath',
    name: 'Google Calendar',
    type: 'GoogleCalendar'
};

</section id="B">
<section id="C">
describe('getWorklogs', () => {
    beforeEach(() => {
        mockedGetEventsList.mockResolvedValue({ data: { items: [] } });
        mockedGetUserAuthenticatedOAuthClient.mockResolvedValue({});
    });

    test('throws if credentials cannot be read', async () => {
        const serviceRegistrations = ServiceRegistrations.mock();
        mockedGetUserAuthenticatedOAuthClient.mockRejectedValue(new Error('Simulated credential error.'));

        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);
        await expect(async () => await input.getWorkLogs(Dates.pastTwoHours(), Dates.now())).rejects.toThrow('Simulated credential error.');
    });

</section id="C">
<section id="D">
    test('filters results from events that started after our start time', async () => {
        mockedGetEventsList.mockResolvedValue({
            data: {
                items: [{
                    start: { dateTime: Dates.now() },
                    end: { dateTime: Dates.now() }
                }, {
                    start: { dateTime: Dates.pastTwoHours() },
                    end: { dateTime: Dates.now() }
                }] 
            }
        });

        const serviceRegistrations = ServiceRegistrations.mock();
        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);

        const worklogs = await input.getWorkLogs(Dates.pastOneHour(), Dates.now());

        expect(worklogs.length).toBe(1);
</section id="D">
<section id="E">
    });

    test('throws if the calendar API fails', async () => {
        const errorMessage = 'Simulated calendar API error.';
        mockedGetEventsList.mockImplementation(() => {
            throw new Error(errorMessage);
        });

        const serviceRegistrations = ServiceRegistrations.mock();
        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);

        await expect(async () => await input.getWorkLogs(Dates.pastTwoHours(), Dates.now())).rejects.toThrow(errorMessage);
    });
});
</section id="E">

# Request
• Update the mock response in the test titled 'filters results from events that started after our start time' to reflect the addition of the `eventTypes` parameter. This ensures that the tests accurately simulate the API's behavior with the new parameter in place.
• Although the mock response does not directly simulate the `eventTypes` parameter (since it's a mock), it's important to ensure that the test logic aligns with the expectations of the modified API call. No specific line of code needs to be added for this parameter in the test, but the understanding that the API call now includes this parameter should be considered in the test's context and any future test modifications or additions.

# Repo & Issue Metadata
Repo: worklogger: Generating work logs (timesheets) from multiple formats to multiple formats, and a tagging system to classify them
Issue Title: add eventTypes parameter to Google Calendar input

Issue Description: The GoogleCalendar Events.list API will start receiving an `eventTypes` parameter, which will be an array of strings. We need to give it the value `["default"]` so that when they change their default behaviour we will not be impacted.
The changes should happen in the `app/inputs/GoogleCalendar/Input.ts` file and its related tests.

You have previously changed these files:
<changed_file file_path="app/inputs/GoogleCalendar/Input.ts">
--- 
+++ 
@@ -55,7 +55,8 @@
                 timeMax: endDateTime.toISOString(),
                 maxResults: 2500,
                 singleEvents: true,
-                orderBy: 'startTime'
+                orderBy: 'startTime',
+                eventTypes: ["default"], // Add this line
             });
             this.logger.trace('Calendar response', { calendarResponse });
 

</changed_file>
<changed_file file_path="app/inputs/GoogleCalendar/Input.test.ts">
--- 
+++ 
@@ -32,7 +32,7 @@
 
 describe('getWorklogs', () => {
     beforeEach(() => {
-        mockedGetEventsList.mockResolvedValue({ data: { items: [] } });
+        mockedGetEventsList.mockResolvedValue({ data: { items: [], eventTypes: ["default"] } });
         mockedGetUserAuthenticatedOAuthClient.mockResolvedValue({});
     });
 

</changed_file>

<section id="A">
const mockedGetUserAuthenticatedOAuthClient = jest.fn();
jest.mock('../../services/authHandler', () => ({
    getUserAuthenticatedOAuthClient: mockedGetUserAuthenticatedOAuthClient
}));

import { Input, GoogleCalendarConfiguration } from '.'
import { AppConfigurations, Dates, ServiceRegistrations } from '../../../tests/entities';

const mockedGetEventsList = jest.fn();
jest.mock('googleapis', () => ({
    google: {
        calendar: () => ({
            events: {
                list: mockedGetEventsList
            }
        }),
        auth: {
            OAuth2Client: jest.fn()
        }
    }
}));

</section id="A">
<section id="B">
const defaultConfiguration: GoogleCalendarConfiguration = {
    calendars: [{
        id: '1@google.com',
        includeTags: []
    }],
    storageRelativePath: 'localPath/subPath',
    name: 'Google Calendar',
    type: 'GoogleCalendar'
};

</section id="B">
<section id="C">
describe('getWorklogs', () => {
    beforeEach(() => {
        mockedGetEventsList.mockResolvedValue({ data: { items: [], eventTypes: ["default"] } });
        mockedGetUserAuthenticatedOAuthClient.mockResolvedValue({});
    });

    test('throws if credentials cannot be read', async () => {
        const serviceRegistrations = ServiceRegistrations.mock();
        mockedGetUserAuthenticatedOAuthClient.mockRejectedValue(new Error('Simulated credential error.'));

        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);
        await expect(async () => await input.getWorkLogs(Dates.pastTwoHours(), Dates.now())).rejects.toThrow('Simulated credential error.');
    });

</section id="C">
<section id="D">
    test('filters results from events that started after our start time', async () => {
        mockedGetEventsList.mockResolvedValue({
            data: {
                items: [{
                    start: { dateTime: Dates.now() },
                    end: { dateTime: Dates.now() }
                }, {
                    start: { dateTime: Dates.pastTwoHours() },
                    end: { dateTime: Dates.now() }
                }] 
            }
        });

        const serviceRegistrations = ServiceRegistrations.mock();
        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);

        const worklogs = await input.getWorkLogs(Dates.pastOneHour(), Dates.now());

        expect(worklogs.length).toBe(1);
</section id="D">
<section id="E">
    });

    test('throws if the calendar API fails', async () => {
        const errorMessage = 'Simulated calendar API error.';
        mockedGetEventsList.mockImplementation(() => {
            throw new Error(errorMessage);
        });

        const serviceRegistrations = ServiceRegistrations.mock();
        const input = new Input(serviceRegistrations, AppConfigurations.normal(), defaultConfiguration);

        await expect(async () => await input.getWorkLogs(Dates.pastTwoHours(), Dates.now())).rejects.toThrow(errorMessage);
    });
});
</section id="E">

# Request
• Similarly, ensure that the test titled 'throws if the calendar API fails' and any other relevant tests in `Input.test.ts` are reviewed to confirm that they do not require direct modifications due to the addition of the `eventTypes` parameter. This step is more about ensuring the integrity of the test suite in light of the code change rather than making a specific code modification.
• No direct code change is required here, but a thorough review of the test cases should be conducted to ensure they remain valid and comprehensive with the introduction of the `eventTypes` parameter.