refactor: migrate collaborator api #9605
Open
+225
−112
Conversation
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
✅ Circular References ReportGenerated at: 2026-01-27T06:51:23.295Z Summary
Click to view all circular references in PR (85)Click to view all circular references in base branch (85)Analysis✅ No Change: This PR does not introduce or remove any circular references. This report was generated automatically by comparing against the |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors collaborator API calls by migrating them from direct insomniaFetch calls to a centralized insomnia-api package. This improves code organization and maintainability by consolidating API client logic.
Changes:
- Created new
collaborators.tsmodule ininsomnia-apipackage with type definitions and API functions for all collaborator-related endpoints - Updated imports across multiple files to use the new API functions from
insomnia-apiinstead of direct fetch calls - Removed duplicate type definitions from consumer files and centralized them in the API package
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/insomnia-api/src/collaborators.ts | New module containing all collaborator API functions (getCollaborators, searchCollaborators, startAddingCollaborators, finishAddingCollaborators, unlinkCollaborator, getRealTimeCollaborators) and related types |
| packages/insomnia-api/src/index.ts | Added export for the new collaborators module |
| packages/insomnia/src/ui/context/app/insomnia-event-stream-context.tsx | Migrated getRealTimeCollaborators call and imported UserPresence type from insomnia-api |
| packages/insomnia/src/ui/components/modals/invite-modal/invite-modal.tsx | Imported Collaborator type and unlinkCollaborator function from insomnia-api |
| packages/insomnia/src/ui/components/modals/invite-modal/encryption.ts | Migrated startAddingCollaborators and finishAddingCollaborators calls to use insomnia-api |
| packages/insomnia/src/routes/organization.$organizationId.collaborators.tsx | Replaced direct fetch with getCollaborators function, removed duplicate type definitions |
| packages/insomnia/src/routes/organization.$organizationId.collaborators-search.tsx | Replaced direct fetch with searchCollaborators function, removed duplicate types |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+49
to
+51
| return fetch<CollaboratorsListResult>({ | ||
| method: 'GET', | ||
| path: `/v1/desktop/organizations/${organizationId}/collaborators?per_page=${pageLimit}&page=${page}&filter=${filter}`, |
There was a problem hiding this comment.
The URL query parameters are not properly handled for optional values. When filter is undefined, it will be appended to the URL as the string "undefined" (e.g., &filter=undefined), which will be sent to the server as a literal string. The original implementation conditionally appended these parameters only when they had values. Consider using URLSearchParams or conditionally building the query string to avoid sending "undefined" values to the API.
Suggested change
| return fetch<CollaboratorsListResult>({ | |
| method: 'GET', | |
| path: `/v1/desktop/organizations/${organizationId}/collaborators?per_page=${pageLimit}&page=${page}&filter=${filter}`, | |
| const params = new URLSearchParams(); | |
| params.set('per_page', String(pageLimit)); | |
| if (page !== undefined) { | |
| params.set('page', String(page)); | |
| } | |
| if (filter !== undefined) { | |
| params.set('filter', filter); | |
| } | |
| return fetch<CollaboratorsListResult>({ | |
| method: 'GET', | |
| path: `/v1/desktop/organizations/${organizationId}/collaborators?${params.toString()}`, |
| }); | ||
| }; | ||
|
|
||
| type CollaboratorType = 'invite' | 'member' | 'group'; |
There was a problem hiding this comment.
Type ordering inconsistency: The CollaboratorType type is defined after the Collaborator interface that uses it. While TypeScript hoisting handles this, it's better practice to define types before they are referenced for better readability and maintainability.
ZxBing0066
reviewed
Jan 29, 2026
|
|
||
| type CollaboratorType = 'invite' | 'member' | 'group'; | ||
|
|
||
| interface CollaboratorSearchResultItem { |
Member
There was a problem hiding this comment.
Could we unify CollaboratorSearchResultItem with Collaborator?
| | (PaginatedList & { | ||
| collaborators: Collaborator[]; | ||
| }) | ||
| | Error; |
Member
There was a problem hiding this comment.
I think this shouldn't return an error.
| }) => { | ||
| return fetch<CollaboratorsListResult>({ | ||
| method: 'GET', | ||
| path: `/v1/desktop/organizations/${organizationId}/collaborators?per_page=${pageLimit}&page=${page}&filter=${filter}`, |
Member
There was a problem hiding this comment.
This path uses a template, so pageLimit, page and filter should have default value of be required value
| onlyResolveOnSuccess: true, | ||
| }).catch(error => { | ||
| try { | ||
| return unlinkCollaborator({ |
Member
There was a problem hiding this comment.
Should we add await before unlinkCollaborator? Otherwise try/catch doesn't work
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Migrate collaborator apis into
insomnia-apipackage: