-
Notifications
You must be signed in to change notification settings - Fork 3.8k
fix(jsm): accept the numeric pagination the JSM tools actually send #6386
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.
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
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,170 @@ | ||
| /** | ||
| * @vitest-environment node | ||
| */ | ||
| import { describe, expect, it } from 'vitest' | ||
| import type { z } from 'zod' | ||
| import { | ||
| jsmApprovalsBodySchema, | ||
| jsmCommentsBodySchema, | ||
| jsmCustomersBodySchema, | ||
| jsmIssuePaginationBodySchema, | ||
| jsmParticipantsBodySchema, | ||
| jsmQueuesBodySchema, | ||
| jsmRequestsBodySchema, | ||
| jsmRequestTypesToolBodySchema, | ||
| jsmServiceDeskScopedBodySchema, | ||
| jsmServiceDesksBodySchema, | ||
| } from '@/lib/api/contracts/selectors/jsm' | ||
| import { JiraServiceManagementBlock } from '@/blocks/blocks/jira_service_management' | ||
| import { | ||
| jsmGetApprovalsTool, | ||
| jsmGetCommentsTool, | ||
| jsmGetCustomersTool, | ||
| jsmGetOrganizationsTool, | ||
| jsmGetParticipantsTool, | ||
| jsmGetQueuesTool, | ||
| jsmGetRequestsTool, | ||
| jsmGetRequestTypesTool, | ||
| jsmGetServiceDesksTool, | ||
| jsmGetSlaTool, | ||
| jsmGetTransitionsTool, | ||
| } from '@/tools/jsm' | ||
| import type { ToolConfig, ToolResponse } from '@/tools/types' | ||
|
|
||
| const DOMAIN = 'example.atlassian.net' | ||
| /** Injected by the executor from the OAuth credential before the tool's `body` runs. */ | ||
| const ACCESS_TOKEN = 'token-123' | ||
|
|
||
| interface PaginatedCase { | ||
| operation: string | ||
| toolId: string | ||
| /** The tool's own `request.body`, captured at its concrete param type by `paginatedCase`. */ | ||
| buildBody: (params: Record<string, unknown>) => Record<string, unknown> | ||
| schema: z.ZodType | ||
| extraInputs: Record<string, string> | ||
| } | ||
|
|
||
| /** | ||
| * Captures each tool at its own generic so an incompatible tool/contract pairing is still a type | ||
| * error at the call site, rather than being erased by a widened `ToolConfig` in the table type. | ||
| */ | ||
| function paginatedCase<P, R extends ToolResponse>( | ||
| operation: string, | ||
| tool: ToolConfig<P, R>, | ||
| schema: z.ZodType, | ||
| extraInputs: Record<string, string> = {} | ||
| ): PaginatedCase { | ||
| return { | ||
| operation, | ||
| toolId: tool.id, | ||
| buildBody: (params) => { | ||
| const bodyFn = tool.request.body | ||
| if (!bodyFn) throw new Error(`${tool.id} is missing request.body`) | ||
| return bodyFn(params as P) as Record<string, unknown> | ||
| }, | ||
| schema, | ||
| extraInputs, | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Every paginated JSM operation, wired to the tool it resolves to and the contract its route | ||
| * parses the body with. This walks the real chain — block `tools.config.params` → the tool's | ||
| * `request.body` → the route contract — which is exactly where `jsm_get_comments` broke: the | ||
| * tools declare `start`/`limit` as `type: 'number'` while the contract demanded strings. | ||
| */ | ||
| const PAGINATED_CASES: PaginatedCase[] = [ | ||
| paginatedCase('get_service_desks', jsmGetServiceDesksTool, jsmServiceDesksBodySchema), | ||
| paginatedCase('get_request_types', jsmGetRequestTypesTool, jsmRequestTypesToolBodySchema, { | ||
| serviceDeskId: '1', | ||
| }), | ||
| paginatedCase('get_requests', jsmGetRequestsTool, jsmRequestsBodySchema), | ||
| paginatedCase('get_comments', jsmGetCommentsTool, jsmCommentsBodySchema, { | ||
| issueIdOrKey: 'SD-123', | ||
| }), | ||
| paginatedCase('get_customers', jsmGetCustomersTool, jsmCustomersBodySchema, { | ||
| serviceDeskId: '1', | ||
| }), | ||
| paginatedCase('get_organizations', jsmGetOrganizationsTool, jsmServiceDeskScopedBodySchema, { | ||
| serviceDeskId: '1', | ||
| }), | ||
| paginatedCase('get_queues', jsmGetQueuesTool, jsmQueuesBodySchema, { serviceDeskId: '1' }), | ||
| paginatedCase('get_sla', jsmGetSlaTool, jsmIssuePaginationBodySchema, { issueIdOrKey: 'SD-123' }), | ||
| paginatedCase('get_transitions', jsmGetTransitionsTool, jsmIssuePaginationBodySchema, { | ||
| issueIdOrKey: 'SD-123', | ||
| }), | ||
| paginatedCase('get_participants', jsmGetParticipantsTool, jsmParticipantsBodySchema, { | ||
| issueIdOrKey: 'SD-123', | ||
| }), | ||
| paginatedCase('get_approvals', jsmGetApprovalsTool, jsmApprovalsBodySchema, { | ||
| issueIdOrKey: 'SD-123', | ||
| }), | ||
| ] | ||
|
|
||
| /** Run a set of block inputs through `tools.config.params`, then through the tool's request body. */ | ||
| function buildRequestBody( | ||
| { operation, buildBody, extraInputs }: PaginatedCase, | ||
| pagination: Record<string, string> | ||
| ) { | ||
| const paramsFn = JiraServiceManagementBlock.tools.config?.params | ||
| if (!paramsFn) throw new Error('Block is missing tools.config.params') | ||
|
|
||
| const toolParams = paramsFn({ | ||
| oauthCredential: 'cred-1', | ||
| domain: DOMAIN, | ||
| operation, | ||
| ...extraInputs, | ||
| ...pagination, | ||
| }) | ||
|
|
||
| return buildBody({ ...toolParams, accessToken: ACCESS_TOKEN, domain: DOMAIN }) | ||
| } | ||
|
|
||
| describe.each(PAGINATED_CASES.map((testCase) => [testCase.operation, testCase] as const))( | ||
| 'JiraServiceManagementBlock %s', | ||
| (_operation, testCase) => { | ||
| it('resolves to the expected tool', () => { | ||
| const toolFn = JiraServiceManagementBlock.tools.config?.tool | ||
| expect(toolFn?.({ operation: testCase.operation })).toBe(testCase.toolId) | ||
| expect(JiraServiceManagementBlock.tools.access).toContain(testCase.toolId) | ||
| }) | ||
|
|
||
| it('sends a body its route contract accepts when pagination is filled in', () => { | ||
| const body = buildRequestBody(testCase, { startIndex: '50', maxResults: '25' }) | ||
|
|
||
| expect(body.start).toBe(50) | ||
| expect(body.limit).toBe(25) | ||
| expect(testCase.schema.parse(body)).toMatchObject({ start: '50', limit: '25' }) | ||
| }) | ||
|
|
||
| it('sends a body its route contract accepts when pagination is left blank', () => { | ||
| const body = buildRequestBody(testCase, {}) | ||
|
|
||
| expect(body.start).toBeUndefined() | ||
| expect(body.limit).toBeUndefined() | ||
| expect(() => testCase.schema.parse(body)).not.toThrow() | ||
| }) | ||
|
|
||
| it('drops non-numeric pagination input instead of sending NaN', () => { | ||
| const body = buildRequestBody(testCase, { startIndex: 'not-a-number', maxResults: '' }) | ||
|
|
||
| expect(body.start).toBeUndefined() | ||
| expect(body.limit).toBeUndefined() | ||
| expect(() => testCase.schema.parse(body)).not.toThrow() | ||
| }) | ||
| } | ||
| ) | ||
|
|
||
| describe('JiraServiceManagementBlock pagination inputs', () => { | ||
| it('exposes Start Index and Max Results on exactly the paginated operations', () => { | ||
| const operations = PAGINATED_CASES.map(({ operation }) => operation) | ||
|
|
||
| for (const id of ['startIndex', 'maxResults']) { | ||
| const subBlock = JiraServiceManagementBlock.subBlocks.find((sb) => sb.id === id) | ||
| expect(subBlock, `${id} subBlock is missing`).toBeDefined() | ||
| expect(subBlock?.mode).toBe('advanced') | ||
| expect(subBlock?.condition).toEqual({ field: 'operation', value: operations }) | ||
| expect(JiraServiceManagementBlock.inputs[id]).toBeDefined() | ||
| } | ||
| }) | ||
| }) | ||
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.
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.
Uh oh!
There was an error while loading. Please reload this page.