Skip to content

refactor: [BREAKING] update Task and Project schemas to match API objects #286

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Apr 24, 2025
Merged

refactor: [BREAKING] update Task and Project schemas to match API objects #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6015093
refactor: [BREAKING] update Task and Project schemas to match API obj…
pedroalves0 Apr 15, 2025
c0280f0
chore: add 'url' field back to Task and Project schemas
pedroalves0 Apr 15, 2025
05ad9ed
chore: update docs
pedroalves0 Apr 15, 2025
bced5ee
chore: do not export slugify function
pedroalves0 Apr 17, 2025
a922ba6
chore: switch to explicit personal/workspace project types instead of…
pedroalves0 Apr 17, 2025
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
40 changes: 22 additions & 18 deletions src/TodoistApi.projects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@ import { TodoistApi } from '.'
import {
DEFAULT_AUTH_TOKEN,
DEFAULT_PROJECT,
RAW_DEFAULT_PROJECT,
DEFAULT_REQUEST_ID,
DEFAULT_USER,
PROJECT_WITH_OPTIONALS_AS_NULL,
DEFAULT_PROJECT_ID,
} from './testUtils/testDefaults'
import {
getSyncBaseUri,
ENDPOINT_REST_PROJECTS,
ENDPOINT_REST_PROJECT_COLLABORATORS,
} from './consts/endpoints'
import { setupRestClientMock } from './testUtils/mocks'
import { getProjectUrl } from './utils/urlHelpers'

function getTarget() {
return new TodoistApi(DEFAULT_AUTH_TOKEN)
Expand All @@ -21,7 +23,7 @@ describe('TodoistApi project endpoints', () => {
describe('getProject', () => {
test('calls get request with expected url', async () => {
const projectId = '12'
const requestMock = setupRestClientMock(RAW_DEFAULT_PROJECT)
const requestMock = setupRestClientMock(DEFAULT_PROJECT)
const api = getTarget()

await api.getProject(projectId)
Expand All @@ -36,7 +38,7 @@ describe('TodoistApi project endpoints', () => {
})

test('returns result from rest client', async () => {
setupRestClientMock(RAW_DEFAULT_PROJECT)
setupRestClientMock(DEFAULT_PROJECT)
const api = getTarget()

const project = await api.getProject('123')
Expand All @@ -48,7 +50,7 @@ describe('TodoistApi project endpoints', () => {
describe('getProjects', () => {
test('calls get on projects endpoint', async () => {
const requestMock = setupRestClientMock({
results: [RAW_DEFAULT_PROJECT],
results: [DEFAULT_PROJECT],
nextCursor: '123',
})
const api = getTarget()
Expand All @@ -67,13 +69,13 @@ describe('TodoistApi project endpoints', () => {
})

test('returns result from rest client', async () => {
const projects = [RAW_DEFAULT_PROJECT]
const projects = [DEFAULT_PROJECT, PROJECT_WITH_OPTIONALS_AS_NULL]
setupRestClientMock({ results: projects, nextCursor: '123' })
const api = getTarget()

const { results, nextCursor } = await api.getProjects()

expect(results).toEqual([DEFAULT_PROJECT])
expect(results).toEqual(projects)
expect(nextCursor).toBe('123')
})
})
Expand All @@ -84,7 +86,7 @@ describe('TodoistApi project endpoints', () => {
}

test('calls post on restClient with expected parameters', async () => {
const requestMock = setupRestClientMock(RAW_DEFAULT_PROJECT)
const requestMock = setupRestClientMock(DEFAULT_PROJECT)
const api = getTarget()

await api.addProject(DEFAULT_ADD_PROJECT_ARGS, DEFAULT_REQUEST_ID)
Expand All @@ -101,7 +103,7 @@ describe('TodoistApi project endpoints', () => {
})

test('returns result from rest client', async () => {
setupRestClientMock(RAW_DEFAULT_PROJECT)
setupRestClientMock(DEFAULT_PROJECT)
const api = getTarget()

const project = await api.addProject(DEFAULT_ADD_PROJECT_ARGS)
Expand All @@ -112,10 +114,15 @@ describe('TodoistApi project endpoints', () => {

describe('updateProject', () => {
const DEFAULT_UPDATE_PROJECT_ARGS = { name: 'a name' }
const DEFAULT_UPDATED_PROJECT_URL = getProjectUrl(
DEFAULT_PROJECT_ID,
DEFAULT_UPDATE_PROJECT_ARGS.name,
)

test('calls post on restClient with expected parameters', async () => {
const projectId = '123'
const updateArgs = { name: 'a new name' }
const requestMock = setupRestClientMock(RAW_DEFAULT_PROJECT, 204)
const requestMock = setupRestClientMock(DEFAULT_PROJECT, 204)
const api = getTarget()

await api.updateProject(projectId, updateArgs, DEFAULT_REQUEST_ID)
Expand All @@ -132,20 +139,17 @@ describe('TodoistApi project endpoints', () => {
})

test('returns success result from rest client', async () => {
const RAW_DEFAULT_PROJECT_WITH_UPDATES = {
...RAW_DEFAULT_PROJECT,
name: DEFAULT_UPDATE_PROJECT_ARGS.name,
const returnedProject = {
...DEFAULT_PROJECT,
...DEFAULT_UPDATE_PROJECT_ARGS,
url: DEFAULT_UPDATED_PROJECT_URL,
}
setupRestClientMock(RAW_DEFAULT_PROJECT_WITH_UPDATES, 204)
setupRestClientMock(returnedProject, 204)
const api = getTarget()

const result = await api.updateProject('123', DEFAULT_UPDATE_PROJECT_ARGS)

const DEFAULT_PROJECT_WITH_UPDATES = {
...DEFAULT_PROJECT,
name: DEFAULT_UPDATE_PROJECT_ARGS.name,
}
expect(result).toEqual(DEFAULT_PROJECT_WITH_UPDATES)
expect(result).toEqual(returnedProject)
})
})

Expand Down
63 changes: 25 additions & 38 deletions src/TodoistApi.tasks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import * as taskConverters from './utils/taskConverters'
import { TodoistApi } from '.'
import { Task } from './types'
import {
DEFAULT_AUTH_TOKEN,
DEFAULT_QUICK_ADD_RESPONSE,
DEFAULT_REQUEST_ID,
DEFAULT_TASK,
RAW_DEFAULT_TASK,
TASK_WITH_OPTIONALS_AS_NULL,
DEFAULT_TASK_ID,
} from './testUtils/testDefaults'
import {
getSyncBaseUri,
Expand All @@ -18,10 +15,7 @@ import {
ENDPOINT_SYNC_QUICK_ADD,
} from './consts/endpoints'
import { setupRestClientMock } from './testUtils/mocks'

function setupSyncTaskConverter(returnedTask: Task) {
return jest.spyOn(taskConverters, 'getTaskFromQuickAddResponse').mockReturnValue(returnedTask)
}
import { getTaskUrl } from './utils/urlHelpers'

function getTarget(baseUrl = 'https://api.todoist.com') {
return new TodoistApi(DEFAULT_AUTH_TOKEN, baseUrl)
Expand All @@ -34,7 +28,7 @@ describe('TodoistApi task endpoints', () => {
}

test('calls post on restClient with expected parameters', async () => {
const requestMock = setupRestClientMock(RAW_DEFAULT_TASK)
const requestMock = setupRestClientMock(DEFAULT_TASK)
const api = getTarget()

await api.addTask(DEFAULT_ADD_TASK_ARGS, DEFAULT_REQUEST_ID)
Expand All @@ -51,7 +45,7 @@ describe('TodoistApi task endpoints', () => {
})

test('calls post on restClient with expected parameters against staging', async () => {
const requestMock = setupRestClientMock(RAW_DEFAULT_TASK)
const requestMock = setupRestClientMock(DEFAULT_TASK)
const api = getTarget('https://staging.todoist.com')

await api.addTask(DEFAULT_ADD_TASK_ARGS, DEFAULT_REQUEST_ID)
Expand All @@ -68,7 +62,7 @@ describe('TodoistApi task endpoints', () => {
})

test('returns result from rest client', async () => {
setupRestClientMock(RAW_DEFAULT_TASK)
setupRestClientMock(DEFAULT_TASK)
const api = getTarget()

const task = await api.addTask(DEFAULT_ADD_TASK_ARGS)
Expand All @@ -79,10 +73,14 @@ describe('TodoistApi task endpoints', () => {

describe('updateTask', () => {
const DEFAULT_UPDATE_TASK_ARGS = { content: 'some new content' }
const DEFAULT_UPDATED_TASK_URL = getTaskUrl(
DEFAULT_TASK_ID,
DEFAULT_UPDATE_TASK_ARGS.content,
)

test('calls post on restClient with expected parameters', async () => {
const taskId = '123'
const requestMock = setupRestClientMock(RAW_DEFAULT_TASK, 204)
const requestMock = setupRestClientMock(DEFAULT_TASK, 204)
const api = getTarget()

await api.updateTask(taskId, DEFAULT_UPDATE_TASK_ARGS, DEFAULT_REQUEST_ID)
Expand All @@ -99,20 +97,17 @@ describe('TodoistApi task endpoints', () => {
})

test('returns success result from rest client', async () => {
const RAW_DEFAULT_TASK_WITH_UPDATES = {
...RAW_DEFAULT_TASK,
content: DEFAULT_UPDATE_TASK_ARGS.content,
const returnedTask = {
...DEFAULT_TASK,
...DEFAULT_UPDATE_TASK_ARGS,
url: DEFAULT_UPDATED_TASK_URL,
}
setupRestClientMock(RAW_DEFAULT_TASK_WITH_UPDATES, 204)
setupRestClientMock(returnedTask, 204)
const api = getTarget()

const response = await api.updateTask('123', DEFAULT_UPDATE_TASK_ARGS)

const DEFAULT_TASK_WITH_UPDATES = {
...DEFAULT_TASK,
content: DEFAULT_UPDATE_TASK_ARGS.content,
}
expect(response).toEqual(DEFAULT_TASK_WITH_UPDATES)
expect(response).toEqual(returnedTask)
})
})

Expand Down Expand Up @@ -212,7 +207,7 @@ describe('TodoistApi task endpoints', () => {
}

test('calls sync endpoint with expected parameters', async () => {
const requestMock = setupRestClientMock(DEFAULT_QUICK_ADD_RESPONSE)
const requestMock = setupRestClientMock(DEFAULT_TASK)
const api = getTarget()

await api.quickAddTask(DEFAULT_QUICK_ADD_ARGS)
Expand All @@ -228,22 +223,17 @@ describe('TodoistApi task endpoints', () => {
})

test('calls task converter with response data and returns result', async () => {
setupRestClientMock(DEFAULT_QUICK_ADD_RESPONSE)
const taskConverter = setupSyncTaskConverter(DEFAULT_TASK)
setupRestClientMock(DEFAULT_TASK)
const api = getTarget()

const task = await api.quickAddTask(DEFAULT_QUICK_ADD_ARGS)

expect(taskConverter).toBeCalledTimes(1)
expect(taskConverter).toBeCalledWith(DEFAULT_QUICK_ADD_RESPONSE)
expect(task).toEqual(DEFAULT_TASK)
})
})

describe('getTask', () => {
test('calls get request with expected url', async () => {
const taskId = '12'
const requestMock = setupRestClientMock(RAW_DEFAULT_TASK)
const requestMock = setupRestClientMock(DEFAULT_TASK)
const api = getTarget()

await api.getTask(taskId)
Expand All @@ -267,7 +257,7 @@ describe('TodoistApi task endpoints', () => {

test('calls get on expected endpoint with args', async () => {
const requestMock = setupRestClientMock({
results: [RAW_DEFAULT_TASK, TASK_WITH_OPTIONALS_AS_NULL],
results: [DEFAULT_TASK, TASK_WITH_OPTIONALS_AS_NULL],
nextCursor: '123',
})
const api = getTarget()
Expand All @@ -285,13 +275,13 @@ describe('TodoistApi task endpoints', () => {
})

test('returns result from rest client', async () => {
const tasks = [RAW_DEFAULT_TASK]
const tasks = [DEFAULT_TASK]
setupRestClientMock({ results: tasks, nextCursor: '123' })
const api = getTarget()

const { results, nextCursor } = await api.getTasks(DEFAULT_GET_TASKS_ARGS)

expect(results).toEqual([DEFAULT_TASK])
expect(results).toEqual(tasks)
expect(nextCursor).toBe('123')
})
})
Expand All @@ -305,10 +295,7 @@ describe('TodoistApi task endpoints', () => {
}

test('calls get request with expected url', async () => {
const requestMock = setupRestClientMock({
results: [RAW_DEFAULT_TASK],
nextCursor: null,
})
const requestMock = setupRestClientMock({ results: [DEFAULT_TASK], nextCursor: null })
const api = getTarget()

await api.getTasksByFilter(DEFAULT_GET_TASKS_BY_FILTER_ARGS)
Expand All @@ -324,7 +311,7 @@ describe('TodoistApi task endpoints', () => {
})

test('returns result from rest client', async () => {
setupRestClientMock({ results: [RAW_DEFAULT_TASK], nextCursor: null })
setupRestClientMock({ results: [DEFAULT_TASK], nextCursor: null })
const api = getTarget()

const response = await api.getTasksByFilter(DEFAULT_GET_TASKS_BY_FILTER_ARGS)
Expand All @@ -336,7 +323,7 @@ describe('TodoistApi task endpoints', () => {
})

test('validates task array in response', async () => {
const invalidTask = { ...RAW_DEFAULT_TASK, due: '2020-01-31' }
const invalidTask = { ...DEFAULT_TASK, due: '2020-01-31' }
setupRestClientMock({ results: [invalidTask], nextCursor: null })
const api = getTarget()

Expand Down
Loading