1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
import { addGlobalSuccessMessage } from 'design-system';
import { isEqual, keyBy, partition, pick, unionBy } from 'lodash';
import { useContext } from 'react';
import {
addGithubRolesMapping,
checkConfigurationValidity,
deleteGithubRolesMapping,
fetchGithubProvisioningStatus,
fetchGithubRolesMapping,
syncNowGithubProvisioning,
updateGithubRolesMapping,
} from '../../api/github-provisioning';
import { AvailableFeaturesContext } from '../../app/components/available-features/AvailableFeaturesContext';
import { translate } from '../../helpers/l10n';
import { mapReactQueryResult } from '../../helpers/react-query';
import { Feature } from '../../types/features';
import { GitHubMapping } from '../../types/provisioning';
const MAPPING_STALE_TIME = 60_000;
export const useCheckGitHubConfigQuery = (githubEnabled: boolean) => {
return useQuery({
queryKey: ['identity_provider', 'github_check'],
queryFn: checkConfigurationValidity,
enabled: githubEnabled,
});
};
interface GithubSyncStatusOptions {
noRefetch?: boolean;
}
export function useGitHubSyncStatusQuery(options: GithubSyncStatusOptions = {}) {
const hasGithubProvisioning = useContext(AvailableFeaturesContext).includes(
Feature.GithubProvisioning,
);
return useQuery({
queryKey: ['identity_provider', 'github_sync', 'status'],
queryFn: fetchGithubProvisioningStatus,
enabled: hasGithubProvisioning,
refetchInterval: options.noRefetch ? undefined : 10_000,
});
}
export function useGithubProvisioningEnabledQuery() {
const res = useGitHubSyncStatusQuery({ noRefetch: true });
return mapReactQueryResult(res, (data) => {
return data.enabled;
});
}
export function useSyncWithGitHubNow() {
const queryClient = useQueryClient();
const { data } = useGitHubSyncStatusQuery();
const mutation = useMutation({
mutationFn: syncNowGithubProvisioning,
onSuccess: () => {
queryClient.invalidateQueries({ queryKey: ['identity_provider', 'github_sync'] });
},
});
return {
synchronizeNow: mutation.mutate,
canSyncNow: data?.enabled && !data.nextSync && !mutation.isPending,
};
}
// Order is reversed to put custom roles at the end (their index is -1)
const defaultRoleOrder = ['admin', 'maintain', 'write', 'triage', 'read'];
export function useGithubRolesMappingQuery() {
return useQuery({
queryKey: ['identity_provider', 'github_mapping'],
queryFn: fetchGithubRolesMapping,
staleTime: MAPPING_STALE_TIME,
select: (data) =>
[...data].sort((a, b) => {
if (defaultRoleOrder.includes(a.id) || defaultRoleOrder.includes(b.id)) {
return defaultRoleOrder.indexOf(b.id) - defaultRoleOrder.indexOf(a.id);
}
return a.githubRole.localeCompare(b.githubRole);
}),
});
}
export function useGithubRolesMappingMutation() {
const client = useQueryClient();
const queryKey = ['identity_provider', 'github_mapping'];
return useMutation({
mutationFn: async (mapping: GitHubMapping[]) => {
const state = keyBy(client.getQueryData<GitHubMapping[]>(queryKey), (m) => m.id);
const [maybeChangedRoles, newRoles] = partition(mapping, (m) => state[m.id]);
const changedRoles = maybeChangedRoles.filter((item) => !isEqual(item, state[item.id]));
const deletedRoles = Object.values(state).filter(
(m) => !m.baseRole && !mapping.some((cm) => m.id === cm.id),
);
return {
addedOrChanged: await Promise.all([
...changedRoles.map((data) =>
updateGithubRolesMapping(data.id, pick(data, 'permissions')),
),
...newRoles.map((m) => addGithubRolesMapping(m)),
]),
deleted: await Promise.all([
deletedRoles.map((dm) => deleteGithubRolesMapping(dm.id)),
]).then(() => deletedRoles.map((dm) => dm.id)),
};
},
onSuccess: ({ addedOrChanged, deleted }) => {
const state = client.getQueryData<GitHubMapping[]>(queryKey);
if (state) {
const newData = unionBy(
addedOrChanged,
state.filter((s) => !deleted.find((id) => id === s.id)),
(el) => el.id,
);
client.setQueryData(queryKey, newData);
}
addGlobalSuccessMessage(
translate('settings.authentication.github.configuration.roles_mapping.save_success'),
);
},
});
}
|
