fix: Use correct API parameter names for thread and inbox timestamp filtering #117
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| import { HttpResponse, http } from 'msw' | ||
| import { apiUrl } from '../testUtils/msw-handlers' | ||
| import { server } from '../testUtils/msw-setup' | ||
| import { TEST_API_TOKEN } from '../testUtils/test-defaults' | ||
| import { InboxClient } from './inbox-client' | ||
|
|
||
| describe('InboxClient', () => { | ||
| let client: InboxClient | ||
|
|
||
| beforeEach(() => { | ||
| client = new InboxClient({ apiToken: TEST_API_TOKEN }) | ||
| }) | ||
|
|
||
| describe('getInbox', () => { | ||
| it('should send newerThan as newer_than_ts query parameter', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.get(apiUrl('api/v3/inbox/get'), ({ request }) => { | ||
| const url = new URL(request.url) | ||
| expect(url.searchParams.get('newer_than_ts')).toBe(String(expectedTs)) | ||
| expect(url.searchParams.get('workspace_id')).toBe('123') | ||
| return HttpResponse.json([]) | ||
| }), | ||
| ) | ||
|
|
||
| await client.getInbox({ workspaceId: 123, newerThan: date }) | ||
| }) | ||
|
|
||
| it('should send olderThan as older_than_ts query parameter', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.get(apiUrl('api/v3/inbox/get'), ({ request }) => { | ||
| const url = new URL(request.url) | ||
| expect(url.searchParams.get('older_than_ts')).toBe(String(expectedTs)) | ||
| expect(url.searchParams.get('workspace_id')).toBe('123') | ||
| return HttpResponse.json([]) | ||
| }), | ||
| ) | ||
|
|
||
| await client.getInbox({ workspaceId: 123, olderThan: date }) | ||
| }) | ||
|
|
||
| it('should support deprecated since param as newer_than_ts', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.get(apiUrl('api/v3/inbox/get'), ({ request }) => { | ||
| const url = new URL(request.url) | ||
| expect(url.searchParams.get('newer_than_ts')).toBe(String(expectedTs)) | ||
| expect(url.searchParams.get('workspace_id')).toBe('123') | ||
| return HttpResponse.json([]) | ||
| }), | ||
| ) | ||
|
|
||
| await client.getInbox({ workspaceId: 123, since: date }) | ||
| }) | ||
|
|
||
| it('should support deprecated until param as older_than_ts', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.get(apiUrl('api/v3/inbox/get'), ({ request }) => { | ||
| const url = new URL(request.url) | ||
| expect(url.searchParams.get('older_than_ts')).toBe(String(expectedTs)) | ||
| expect(url.searchParams.get('workspace_id')).toBe('123') | ||
| return HttpResponse.json([]) | ||
| }), | ||
| ) | ||
|
|
||
| await client.getInbox({ workspaceId: 123, until: date }) | ||
| }) | ||
| }) | ||
|
|
||
| describe('archiveAll', () => { | ||
| it('should send newerThan as since_ts_or_obj_idx parameter', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.post(apiUrl('api/v3/inbox/archive_all'), async ({ request }) => { | ||
| const body = await request.json() | ||
| expect(body).toEqual({ | ||
| workspace_id: 123, | ||
| since_ts_or_obj_idx: expectedTs, | ||
| }) | ||
| return HttpResponse.json(null) | ||
| }), | ||
| ) | ||
|
|
||
| await client.archiveAll({ workspaceId: 123, newerThan: date }) | ||
| }) | ||
|
|
||
| it('should send olderThan as until_ts_or_obj_idx parameter', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.post(apiUrl('api/v3/inbox/archive_all'), async ({ request }) => { | ||
| const body = await request.json() | ||
| expect(body).toEqual({ | ||
| workspace_id: 123, | ||
| until_ts_or_obj_idx: expectedTs, | ||
| }) | ||
| return HttpResponse.json(null) | ||
| }), | ||
| ) | ||
|
|
||
| await client.archiveAll({ workspaceId: 123, olderThan: date }) | ||
| }) | ||
|
|
||
| it('should support deprecated since param', async () => { | ||
| const date = new Date('2024-06-15T12:00:00Z') | ||
| const expectedTs = Math.floor(date.getTime() / 1000) | ||
|
|
||
| server.use( | ||
| http.post(apiUrl('api/v3/inbox/archive_all'), async ({ request }) => { | ||
| const body = await request.json() | ||
| expect(body).toEqual({ | ||
| workspace_id: 123, | ||
| since_ts_or_obj_idx: expectedTs, | ||
| }) | ||
| return HttpResponse.json(null) | ||
| }), | ||
| ) | ||
|
|
||
| await client.archiveAll({ workspaceId: 123, since: date }) | ||
| }) | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[P1] Rebuilding
paramsfrom scratch here drops the previously documentednewer_than_ts/older_than_tsinputs forgetThreads(). Before this change, those snake_case keys were forwarded throughrequest()and worked for JS consumers; after this refactor they are silently ignored, so existing calls can start returning unfiltered threads. Please add a deprecated fallback for the old keys, similar to the inbox/comments migrations, before removing that runtime path.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 639ff5a. Switched back to the passthrough pattern — we now destructure only the timestamp fields and spread
...restthrough. Added deprecatednewerThanTs/olderThanTsnumber fields onGetThreadsArgs(which auto-convert tonewer_than_ts/older_than_tsviasnakeCaseKeys), withnewerThanDate taking precedence when both are provided.