-
-
Notifications
You must be signed in to change notification settings - Fork 182
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
feat(organizations): add functions for managing members TASK-985 #5281
Open
magicznyleszek
wants to merge
55
commits into
main
Choose a base branch
from
leszek/task-985-member-mutation-api
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+34
−1
Conversation
This file contains 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
…e-endpoints-to-handle-org-members
… query for user mfa details
…hook more customizable and then use it in `MembersRoute`
…hook more customizable and then use it in `MembersRoute`
…x/kpi into leszek/task-980-members-table
…eszek/task-980-members-table
…omprehensive tests
…omprehensive tests
…eszek/task-980-members-table
…x/kpi into leszek/task-980-members-table
…eszek/task-980-members-table
…x/kpi into leszek/task-980-members-table
…eszek/task-980-members-table
magicznyleszek
changed the base branch from
main
to
leszek/task-980-members-table
November 20, 2024 13:58
…ber-mutation-api # Conflicts: # jsapp/js/account/organizations/membersQuery.ts
magicznyleszek
commented
Nov 20, 2024
…eszek/task-980-members-table # Conflicts: # jsapp/js/account/organization/MembersRoute.tsx # jsapp/js/account/organization/membersQuery.ts # jsapp/js/account/organization/membersRoute.module.scss # jsapp/js/account/routes.constants.ts # jsapp/js/account/routes.tsx # jsapp/js/api.endpoints.ts
…ber-mutation-api # Conflicts: # jsapp/js/account/organization/membersQuery.ts
magicznyleszek
requested review from
p2edwards
and removed request for
p2edwards
November 21, 2024 14:47
# Conflicts: # jsapp/js/account/organization/MembersRoute.tsx # jsapp/js/account/organization/membersQuery.ts # jsapp/js/api.endpoints.ts # kobo/apps/organizations/serializers.py # kobo/apps/organizations/views.py
9 tasks
.replace(':username', username); | ||
return fetchDelete(apiUrl); | ||
} | ||
|
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.
We will probably need to add to these file the mutation hooks for the functions and do not export the actual functions above.
/**
* Mutation hook to patch and organization member.
* This receives the current members query result to refetch the list after the
* mutation is successful instead of using query keys duo to pagination parameters.
*/
export const usePatchOrganizationMember = (
membersQuery: UseQueryResult<PaginatedResponse<OrganizationMember>>
) => {
const orgQuery = useOrganizationQuery();
const orgId = orgQuery.data?.id;
return useMutation({
mutationFn: ({
username,
data,
}: {
username: string;
data: Partial<OrganizationMember>;
}) => {
if (!orgId) {
throw new Error('Organization not found');
}
return patchOrganizationMember(orgId, username, data);
},
onSuccess: () => {
// This will refetch the members list
membersQuery.refetch();
},
});
};
/**
* Mutation hook to remove an organization member.
* This receives the current members query result to refetch the list after the
* mutation is successful instead of using query keys duo to pagination parameters.
*/
export const useRemoveOrganizationMember = (
membersQuery: UseQueryResult<PaginatedResponse<OrganizationMember>>
) => {
const orgQuery = useOrganizationQuery();
const orgId = orgQuery.data?.id;
return useMutation({
mutationFn: (username: string) => {
if (!orgId) {
throw new Error('Organization not found');
}
return removeOrganizationMember(orgId, username);
},
onSuccess: () => {
// This will refetch the members list
membersQuery.refetch();
},
});
};
Usage would be something like:
const membersQuery = useOrganizationMembersQuery()
const membersPatch = usePatchOrganizationMember(membersQuery)
const onPatch = (username: string, data:Partial<OrganizationMember>) => {
membersPatch.mutateAsync({username, data})
}
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.
🗒️ Checklist
<type>(<scope>)<!>: <title> TASK-1234
frontend
orbackend
unless it's global💭 Notes
Not testable per se until further PR is built atop this one and uses it :)