halo/ui/console-src/modules/system/roles/RoleList.vue

326 lines
9.2 KiB
Vue
Raw Normal View History

<script lang="ts" setup>
// core libs
import { computed, ref } from "vue";
import type { Role, RoleList } from "@halo-dev/api-client";
// components
import {
Dialog,
IconAddCircle,
IconShieldUser,
Toast,
VButton,
VCard,
VDropdownItem,
VEntity,
VEntityField,
VLoading,
VPageHeader,
VStatusDot,
VTag,
} from "@halo-dev/components";
import RoleEditingModal from "./components/RoleEditingModal.vue";
// constants
import { rbacAnnotations } from "@/constants/annotations";
import { formatDatetime } from "@/utils/date";
// libs
import { coreApiClient } from "@halo-dev/api-client";
import Fuse from "fuse.js";
import { usePermission } from "@/utils/permission";
import { roleLabels } from "@/constants/labels";
import { SUPER_ROLE_NAME } from "@/constants/constants";
import { useI18n } from "vue-i18n";
import { useQuery } from "@tanstack/vue-query";
import { resolveDeepDependencies } from "@/utils/role";
const { currentUserHasPermission } = usePermission();
const { t } = useI18n();
const editingModal = ref<boolean>(false);
const selectedRole = ref<Role>();
let fuse: Fuse<Role> | undefined = undefined;
const { data: roleTemplates } = useQuery({
queryKey: ["role-templates"],
queryFn: async () => {
const { data } = await coreApiClient.role.listRole({
page: 0,
size: 0,
labelSelector: [`${roleLabels.TEMPLATE}=true`, "!halo.run/hidden"],
});
return data.items;
},
});
const {
data: roles,
isLoading,
refetch,
} = useQuery<RoleList>({
queryKey: ["roles"],
queryFn: async () => {
const { data } = await coreApiClient.role.listRole({
page: 0,
size: 0,
labelSelector: [`!${roleLabels.TEMPLATE}`],
});
return data;
},
refetchInterval(data) {
const hasDeletingRole = data?.items.some(
(item) => !!item.metadata.deletionTimestamp
);
return hasDeletingRole ? 1000 : false;
},
onSuccess(data) {
fuse = new Fuse(data.items, {
keys: [
{
name: "displayName",
getFn: (role) => {
return (
role.metadata.annotations?.[rbacAnnotations.DISPLAY_NAME] || ""
);
},
},
"metadata.name",
],
useExtendedSearch: true,
threshold: 0.2,
});
},
enabled: computed(() => !!roleTemplates.value),
});
const keyword = ref("");
const searchResults = computed(() => {
if (!fuse || !keyword.value) {
return roles.value?.items || [];
}
return fuse?.search(keyword.value).map((item) => item.item);
});
const isSystemReserved = (role: Role) => {
return role.metadata.labels?.[roleLabels.SYSTEM_RESERVED] === "true";
};
const getRoleCountText = (role: Role) => {
if (role.metadata.name === SUPER_ROLE_NAME) {
return t("core.role.common.text.contains_all_permissions");
}
const dependencies = new Set<string>(
resolveDeepDependencies(role, roleTemplates.value || [])
);
return t("core.role.common.text.contains_n_permissions", {
count: dependencies.size || 0,
});
};
const handleOpenEditingModal = (role: Role) => {
selectedRole.value = role;
editingModal.value = true;
};
const onEditingModalClose = () => {
selectedRole.value = undefined;
editingModal.value = false;
refetch();
};
const handleCloneRole = async (role: Role) => {
const roleToCreate: Role = {
apiVersion: "v1alpha1",
kind: "Role",
metadata: {
name: "",
generateName: "role-",
labels: {},
annotations: {
[rbacAnnotations.DEPENDENCIES]:
role.metadata.annotations?.[rbacAnnotations.DEPENDENCIES] || "",
[rbacAnnotations.DISPLAY_NAME]:
role.metadata.annotations?.[rbacAnnotations.DISPLAY_NAME] || "",
},
},
rules: [],
};
// 如果是超级管理员角色,那么需要获取到所有角色模板并填充到表单
if (role.metadata.name === SUPER_ROLE_NAME) {
const { data } = await coreApiClient.role.listRole({
page: 0,
size: 0,
labelSelector: [`${roleLabels.TEMPLATE}=true`, "!halo.run/hidden"],
});
const roleTemplateNames = data.items.map((item) => item.metadata.name);
if (roleToCreate.metadata.annotations) {
roleToCreate.metadata.annotations[rbacAnnotations.DEPENDENCIES] =
JSON.stringify(roleTemplateNames);
} else {
roleToCreate.metadata.annotations = {
[rbacAnnotations.DEPENDENCIES]: JSON.stringify(roleTemplateNames),
};
}
}
selectedRole.value = roleToCreate;
editingModal.value = true;
};
const handleDelete = async (role: Role) => {
Dialog.warning({
title: t("core.role.operations.delete.title"),
description: t("core.role.operations.delete.description"),
confirmType: "danger",
confirmText: t("core.common.buttons.confirm"),
cancelText: t("core.common.buttons.cancel"),
onConfirm: async () => {
try {
await coreApiClient.role.deleteRole({
refactor: method parameters of api client (halo-dev/console#605) <!-- Thanks for sending a pull request! Here are some tips for you: 1. 如果这是你的第一次,请阅读我们的贡献指南:<https://github.com/halo-dev/halo/blob/master/CONTRIBUTING.md>。 1. If this is your first time, please read our contributor guidelines: <https://github.com/halo-dev/halo/blob/master/CONTRIBUTING.md>. 2. 请根据你解决问题的类型为 Pull Request 添加合适的标签。 2. Please label this pull request according to what type of issue you are addressing, especially if this is a release targeted pull request. 3. 请确保你已经添加并运行了适当的测试。 3. Ensure you have added or ran the appropriate tests for your PR. --> #### What type of PR is this? /kind improvement /milestone 2.0 <!-- 添加其中一个类别: Add one of the following kinds: /kind bug /kind cleanup /kind documentation /kind feature /kind optimization 适当添加其中一个或多个类别(可选): Optionally add one or more of the following kinds if applicable: /kind api-change /kind deprecation /kind failing-test /kind flake /kind regression --> #### What this PR does / why we need it: 修改 api-client 的请求参数结构,改为所有参数由一个对象包裹,而不是将各个参数作为方法的参数,防止因为后端参数结构发生改变,或者生成 api-client 时参数顺序发生改变导致请求异常。如: ```diff await apiClient.extension.storage.group.updatestorageHaloRunV1alpha1Group( - formState.value.metadata.name, - formState.value + { + name: formState.value.metadata.name, + group: formState.value, + } ); ``` #### Which issue(s) this PR fixes: <!-- PR 合并时自动关闭 issue。 Automatically closes linked issue when PR is merged. 用法:`Fixes #<issue 号>`,或者 `Fixes (粘贴 issue 完整链接)` Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. --> None #### Screenshots: <!-- 如果此 PR 有 UI 的改动,最好截图说明这个 PR 的改动。 If there are UI changes to this PR, it is best to take a screenshot to illustrate the changes to this PR. eg. Before: ![screenshot-before](https://user-images.githubusercontent.com/screenshot.png) After: ![screenshot-after](https://user-images.githubusercontent.com/screenshot.png) --> None #### Special notes for your reviewer: /cc @halo-dev/sig-halo-admin #### Does this PR introduce a user-facing change? <!-- 如果当前 Pull Request 的修改不会造成用户侧的任何变更,在 `release-note` 代码块儿中填写 `NONE`。 否则请填写用户侧能够理解的 Release Note。如果当前 Pull Request 包含破坏性更新(Break Change), Release Note 需要以 `action required` 开头。 If no, just write "NONE" in the release-note block below. If yes, a release note is required: Enter your extended release note in the block below. If the PR requires additional action from users switching to the new release, include the string "action required". --> ```release-note None ```
2022-09-06 02:26:11 +00:00
name: role.metadata.name,
});
Toast.success(t("core.common.toast.delete_success"));
} catch (e) {
console.error("Failed to delete role", e);
} finally {
refetch();
}
},
});
};
</script>
<template>
<RoleEditingModal
v-if="editingModal"
:role="selectedRole"
@close="onEditingModalClose"
/>
<VPageHeader :title="$t('core.role.title')">
<template #icon>
<IconShieldUser class="mr-2 self-center" />
</template>
<template #actions>
<VButton
v-permission="['system:roles:manage']"
type="secondary"
@click="editingModal = true"
>
<template #icon>
<IconAddCircle class="h-full w-full" />
</template>
{{ $t("core.common.buttons.new") }}
</VButton>
</template>
</VPageHeader>
<div class="m-0 md:m-4">
<VCard :body-class="['!p-0']">
<template #header>
<div class="block w-full bg-gray-50 px-4 py-3">
<div
class="relative flex flex-col items-start sm:flex-row sm:items-center"
>
<div class="flex w-full flex-1 sm:w-auto">
<FormKit
v-model="keyword"
:placeholder="$t('core.common.placeholder.search')"
type="text"
></FormKit>
</div>
</div>
</div>
</template>
<VLoading v-if="isLoading" />
<Transition v-else appear name="fade">
<ul
class="box-border h-full w-full divide-y divide-gray-100"
role="list"
>
<li v-for="(role, index) in searchResults" :key="index">
<VEntity>
<template #start>
<VEntityField
:title="
role.metadata.annotations?.[rbacAnnotations.DISPLAY_NAME] ||
role.metadata.name
"
:description="getRoleCountText(role)"
:route="{
name: 'RoleDetail',
params: {
name: role.metadata.name,
},
}"
></VEntityField>
</template>
<template #end>
<!-- TODO: 支持显示用户数量 -->
<VEntityField v-if="false" description="0 个用户" />
<VEntityField>
<template #description>
<VTag>
{{
isSystemReserved(role)
? t("core.role.common.text.system_reserved")
: t("core.role.common.text.custom")
}}
</VTag>
</template>
</VEntityField>
<VEntityField v-if="role.metadata.deletionTimestamp">
<template #description>
<VStatusDot
v-tooltip="$t('core.common.status.deleting')"
state="warning"
animate
/>
</template>
</VEntityField>
<VEntityField>
<template #description>
<span class="truncate text-xs tabular-nums text-gray-500">
{{ formatDatetime(role.metadata.creationTimestamp) }}
</span>
</template>
</VEntityField>
</template>
<template
v-if="currentUserHasPermission(['system:roles:manage'])"
#dropdownItems
>
<VDropdownItem
v-if="!isSystemReserved(role)"
@click="handleOpenEditingModal(role)"
>
{{ $t("core.common.buttons.edit") }}
</VDropdownItem>
<VDropdownItem
v-if="!isSystemReserved(role)"
type="danger"
@click="handleDelete(role)"
>
{{ $t("core.common.buttons.delete") }}
</VDropdownItem>
<VDropdownItem @click="handleCloneRole(role)">
{{
$t("core.role.operations.create_based_on_this_role.button")
}}
</VDropdownItem>
</template>
</VEntity>
</li>
</ul>
</Transition>
</VCard>
</div>
</template>