Added UI support for managing Group level rules

EricWittmann · EricWittmann · commit 876e65a08293 · 2024-07-30T15:38:15.000-04:00
diff --git a/app/src/main/java/io/apicurio/registry/rest/v3/GroupsResourceImpl.java b/app/src/main/java/io/apicurio/registry/rest/v3/GroupsResourceImpl.java
@@ -325,6 +325,10 @@ public void createGroupRule(String groupId, CreateRule data) {
             throw new MissingRequiredParameterException("config");
         }
 
+        if (new GroupId(groupId).isDefaultGroup()) {
+            throw new NotAllowedException("Default group is not allowed");
+        }
+
         RuleConfigurationDto config = new RuleConfigurationDto();
         config.setConfiguration(data.getConfig());
 
diff --git a/ui/ui-app/src/app/components/ruleList/RuleList.tsx b/ui/ui-app/src/app/components/ruleList/RuleList.tsx
@@ -6,7 +6,7 @@ import {
     CompatibilityLabel,
     CompatibilitySelect,
     IntegrityLabel,
-    IntegritySelect,
+    IntegritySelect, RuleListType,
     RuleValue,
     ValidityLabel,
     ValiditySelect
@@ -19,7 +19,7 @@ export type RuleListProps = {
     onDisableRule: (ruleType: string) => void;
     onConfigureRule: (ruleType: string, config: string) => void;
     rules: Rule[];
-    isGlobalRules: boolean;
+    type: RuleListType;
 };
 
 const NAME_COLUMN_WIDTH: string = "250px";
@@ -151,13 +151,13 @@ export const RuleList: FunctionComponent<RuleListProps> = (props: RuleListProps)
     }
 
     const validityDescription = (
-        <span>Ensure that content is <em>valid</em> when updating this artifact.</span>
+        <span>Ensure that content is <em>valid</em> when creating an artifact or artifact version.</span>
     );
     const compatibilityDescription = (
-        <span>Enforce a compatibility level when updating this artifact (for example, select Backward for backwards compatibility).</span>
+        <span>Enforce a compatibility level when creating a new artifact version (for example, select Backward for backwards compatibility).</span>
     );
     const integrityDescription = (
-        <span>Enforce artifact reference integrity when creating or updating artifacts.  Enable and configure this rule to ensure that artifact references provided are correct.</span>
+        <span>Enforce artifact reference integrity when creating an artifact or artifact version.  Enable and configure this rule to ensure that provided artifact references are correct.</span>
     );
 
     return (
@@ -176,7 +176,7 @@ export const RuleList: FunctionComponent<RuleListProps> = (props: RuleListProps)
                         </Tooltip>
                     </FlexItem>
                     <FlexItem className="rule-actions">
-                        <RuleValue isGlobalRule={props.isGlobalRules} actions={validityRuleActions} label={validityRuleLabel} />
+                        <RuleValue type={props.type} actions={validityRuleActions} label={validityRuleLabel} />
                     </FlexItem>
                 </Flex>
             </GridItem>
@@ -194,7 +194,7 @@ export const RuleList: FunctionComponent<RuleListProps> = (props: RuleListProps)
                         </Tooltip>
                     </FlexItem>
                     <FlexItem className="rule-actions">
-                        <RuleValue isGlobalRule={props.isGlobalRules} actions={compatibilityRuleActions} label={compatibilityRuleLabel} />
+                        <RuleValue type={props.type} actions={compatibilityRuleActions} label={compatibilityRuleLabel} />
                     </FlexItem>
                 </Flex>
             </GridItem>
@@ -212,7 +212,7 @@ export const RuleList: FunctionComponent<RuleListProps> = (props: RuleListProps)
                         </Tooltip>
                     </FlexItem>
                     <FlexItem className="rule-actions">
-                        <RuleValue isGlobalRule={props.isGlobalRules} actions={integrityRuleActions} label={integrityRuleLabel} />
+                        <RuleValue type={props.type} actions={integrityRuleActions} label={integrityRuleLabel} />
                     </FlexItem>
                 </Flex>
             </GridItem>
diff --git a/ui/ui-app/src/app/components/ruleList/RuleListType.ts b/ui/ui-app/src/app/components/ruleList/RuleListType.ts
@@ -0,0 +1,3 @@
+export enum RuleListType {
+    Global, Group, Artifact
+}
diff --git a/ui/ui-app/src/app/components/ruleList/RuleValue.tsx b/ui/ui-app/src/app/components/ruleList/RuleValue.tsx
@@ -2,10 +2,11 @@ import React, { FunctionComponent } from "react";
 import { If } from "@apicurio/common-ui-components";
 import { useUserService } from "@services/useUserService.ts";
 import { useConfigService } from "@services/useConfigService.ts";
+import { RuleListType } from "@app/components";
 
 
 export type RuleValueProps = {
-    isGlobalRule: boolean;
+    type: RuleListType;
     actions: React.ReactElement;
     label: React.ReactElement;
 };
@@ -17,7 +18,7 @@ export const RuleValue: FunctionComponent<RuleValueProps> = (props: RuleValuePro
     const userIsAdmin: boolean = user.isUserAdmin();
     const userIsDev: boolean = user.isUserDeveloper();
 
-    const isEditable: boolean = !readOnly && (props.isGlobalRule ? userIsAdmin : userIsDev);
+    const isEditable: boolean = !readOnly && (props.type === RuleListType.Global ? userIsAdmin : userIsDev);
 
     return (
         <>
diff --git a/ui/ui-app/src/app/components/ruleList/index.ts b/ui/ui-app/src/app/components/ruleList/index.ts
@@ -1,8 +1,9 @@
-export * from "./CompatibilitySelect.tsx";
-export * from "./CompatibilityLabel.tsx";
-export * from "./IntegritySelect.tsx";
-export * from "./IntegrityLabel.tsx";
-export * from "./ValiditySelect.tsx";
-export * from "./ValidityLabel.tsx";
-export * from "./RuleList.tsx";
-export * from "./RuleValue.tsx";
+export * from "./CompatibilitySelect";
+export * from "./CompatibilityLabel";
+export * from "./IntegritySelect";
+export * from "./IntegrityLabel";
+export * from "./ValiditySelect";
+export * from "./ValidityLabel";
+export * from "./RuleList";
+export * from "./RuleValue";
+export * from "./RuleListType";
diff --git a/ui/ui-app/src/app/pages/artifact/components/tabs/ArtifactInfoTabContent.tsx b/ui/ui-app/src/app/pages/artifact/components/tabs/ArtifactInfoTabContent.tsx
@@ -1,7 +1,7 @@
 import { FunctionComponent } from "react";
 import "./ArtifactInfoTabContent.css";
 import "@app/styles/empty.css";
-import { ArtifactTypeIcon, IfAuth, IfFeature, RuleList } from "@app/components";
+import { ArtifactTypeIcon, IfAuth, IfFeature, RuleList, RuleListType } from "@app/components";
 import {
     Button,
     Card,
@@ -152,7 +152,7 @@ export const ArtifactInfoTabContent: FunctionComponent<ArtifactInfoTabContentPro
                             the equivalent global rules.
                         </p>
                         <RuleList
-                            isGlobalRules={false}
+                            type={RuleListType.Artifact}
                             rules={props.rules}
                             onEnableRule={props.onEnableRule}
                             onDisableRule={props.onDisableRule}
diff --git a/ui/ui-app/src/app/pages/group/GroupPage.tsx b/ui/ui-app/src/app/pages/group/GroupPage.tsx
@@ -24,7 +24,7 @@ import { LoggerService, useLoggerService } from "@services/useLoggerService.ts";
 import { GroupsService, useGroupsService } from "@services/useGroupsService.ts";
 import { ArtifactsTabContent } from "@app/pages/group/components/tabs/ArtifactsTabContent.tsx";
 import { ApiError } from "@models/apiError.model.ts";
-import { CreateArtifact, GroupMetaData, SearchedArtifact } from "@sdk/lib/generated-client/models";
+import { CreateArtifact, GroupMetaData, Rule, RuleType, SearchedArtifact } from "@sdk/lib/generated-client/models";
 
 
 export type GroupPageProps = {
@@ -49,6 +49,7 @@ export const GroupPage: FunctionComponent<GroupPageProps> = () => {
     const [isInvalidContentModalOpen, setInvalidContentModalOpen] = useState<boolean>(false);
     const [artifactToDelete, setArtifactToDelete] = useState<SearchedArtifact>();
     const [artifactDeleteSuccessCallback, setArtifactDeleteSuccessCallback] = useState<() => void>();
+    const [rules, setRules] = useState<Rule[]>([]);
 
     const appNavigation: AppNavigation = useAppNavigation();
     const logger: LoggerService = useLoggerService();
@@ -69,6 +70,11 @@ export const GroupPage: FunctionComponent<GroupPageProps> = () => {
                 .catch(error => {
                     setPageError(toPageError(error, "Error loading page data."));
                 }),
+            groups.getGroupRules(groupId as string)
+                .then(setRules)
+                .catch(error => {
+                    setPageError(toPageError(error, "Error loading page data."));
+                }),
         ];
     };
 
@@ -136,6 +142,40 @@ export const GroupPage: FunctionComponent<GroupPageProps> = () => {
         });
     };
 
+    const doEnableRule = (ruleType: string): void => {
+        logger.debug("[GroupPage] Enabling rule:", ruleType);
+        let config: string = "FULL";
+        if (ruleType === "COMPATIBILITY") {
+            config = "BACKWARD";
+        }
+        groups.createGroupRule(groupId as string, ruleType, config).catch(error => {
+            setPageError(toPageError(error, `Error enabling "${ ruleType }" group rule.`));
+        });
+        setRules([...rules, { config, ruleType: ruleType as RuleType }]);
+    };
+
+    const doDisableRule = (ruleType: string): void => {
+        logger.debug("[GroupPage] Disabling rule:", ruleType);
+        groups.deleteGroupRule(groupId as string, ruleType).catch(error => {
+            setPageError(toPageError(error, `Error disabling "${ ruleType }" group rule.`));
+        });
+        setRules(rules.filter(r => r.ruleType !== ruleType));
+    };
+
+    const doConfigureRule = (ruleType: string, config: string): void => {
+        logger.debug("[GroupPage] Configuring rule:", ruleType, config);
+        groups.updateGroupRule(groupId as string, ruleType, config).catch(error => {
+            setPageError(toPageError(error, `Error configuring "${ ruleType }" group rule.`));
+        });
+        setRules(rules.map(r => {
+            if (r.ruleType === ruleType) {
+                return { config, ruleType: r.ruleType };
+            } else {
+                return r;
+            }
+        }));
+    };
+
     const closeInvalidContentModal = (): void => {
         setInvalidContentModalOpen(false);
     };
@@ -201,7 +241,15 @@ export const GroupPage: FunctionComponent<GroupPageProps> = () => {
 
     const tabs: any[] = [
         <Tab data-testid="info-tab" eventKey="overview" title="Overview" key="overview" tabContentId="tab-info">
-            <GroupInfoTabContent group={group as GroupMetaData} onEditMetaData={() => setIsEditModalOpen(true)} onChangeOwner={() => {}} />
+            <GroupInfoTabContent
+                group={group as GroupMetaData}
+                rules={rules}
+                onEnableRule={doEnableRule}
+                onDisableRule={doDisableRule}
+                onConfigureRule={doConfigureRule}
+                onEditMetaData={() => setIsEditModalOpen(true)}
+                onChangeOwner={() => {}}
+            />
         </Tab>,
         <Tab data-testid="artifacts-tab" eventKey="artifacts" title="Artifacts" key="artifacts" tabContentId="tab-artifacts">
             <ArtifactsTabContent
diff --git a/ui/ui-app/src/app/pages/group/components/tabs/GroupInfoTabContent.tsx b/ui/ui-app/src/app/pages/group/components/tabs/GroupInfoTabContent.tsx
@@ -1,7 +1,7 @@
 import { FunctionComponent } from "react";
 import "./GroupInfoTabContent.css";
 import "@app/styles/empty.css";
-import { IfAuth, IfFeature } from "@app/components";
+import { IfAuth, IfFeature, RuleList, RuleListType } from "@app/components";
 import {
     Button,
     Card,
@@ -18,17 +18,21 @@ import {
     Label,
     Truncate
 } from "@patternfly/react-core";
-import { IndustryIcon, OutlinedFolderIcon, PencilAltIcon } from "@patternfly/react-icons";
+import { OutlinedFolderIcon, PencilAltIcon } from "@patternfly/react-icons";
 import { FromNow, If } from "@apicurio/common-ui-components";
 import { isStringEmptyOrUndefined } from "@utils/string.utils.ts";
-import { GroupMetaData } from "@sdk/lib/generated-client/models";
+import { GroupMetaData, Rule } from "@sdk/lib/generated-client/models";
 import { labelsToAny } from "@utils/rest.utils.ts";
 
 /**
  * Properties
  */
 export type GroupInfoTabContentProps = {
     group: GroupMetaData;
+    rules: Rule[];
+    onEnableRule: (ruleType: string) => void;
+    onDisableRule: (ruleType: string) => void;
+    onConfigureRule: (ruleType: string, config: string) => void;
     onEditMetaData: () => void;
     onChangeOwner: () => void;
 };
@@ -135,16 +139,13 @@ export const GroupInfoTabContent: FunctionComponent<GroupInfoTabContentProps> =
                             individually enabled, configured, and disabled. Group-specific rules override
                             the equivalent global rules.
                         </p>
-                        <p>
-                            <b><IndustryIcon /> Under construction </b>
-                        </p>
-                        {/*<RuleList*/}
-                        {/*    isGlobalRules={false}*/}
-                        {/*    rules={props.rules}*/}
-                        {/*    onEnableRule={props.onEnableRule}*/}
-                        {/*    onDisableRule={props.onDisableRule}*/}
-                        {/*    onConfigureRule={props.onConfigureRule}*/}
-                        {/*/>*/}
+                        <RuleList
+                            type={RuleListType.Group}
+                            rules={props.rules}
+                            onEnableRule={props.onEnableRule}
+                            onDisableRule={props.onDisableRule}
+                            onConfigureRule={props.onConfigureRule}
+                        />
                     </CardBody>
                 </Card>
             </div>
diff --git a/ui/ui-app/src/app/pages/rules/RulesPage.tsx b/ui/ui-app/src/app/pages/rules/RulesPage.tsx
@@ -1,7 +1,7 @@
 import React, { FunctionComponent, useEffect, useState } from "react";
 import "./RulesPage.css";
 import { PageSection, PageSectionVariants, TextContent } from "@patternfly/react-core";
-import { RootPageHeader, RuleList } from "@app/components";
+import { RootPageHeader, RuleList, RuleListType } from "@app/components";
 import { PageDataLoader, PageError, PageErrorHandler, toPageError } from "@app/pages";
 import { AdminService, useAdminService } from "@services/useAdminService.ts";
 import { LoggerService, useLoggerService } from "@services/useLoggerService.ts";
@@ -81,7 +81,7 @@ export const RulesPage: FunctionComponent<RulesPageProps> = () => {
                 <PageSection variant={PageSectionVariants.default} isFilled={true}>
                     <React.Fragment>
                         <RuleList
-                            isGlobalRules={true}
+                            type={RuleListType.Global}
                             rules={rules}
                             onEnableRule={doEnableRule}
                             onDisableRule={doDisableRule}
diff --git a/ui/ui-app/src/services/useGroupsService.ts b/ui/ui-app/src/services/useGroupsService.ts
@@ -82,6 +82,47 @@ const deleteGroup = async (config: ConfigService, auth: AuthService, groupId: st
 };
 
 
+const getGroupRules = async (config: ConfigService, auth: AuthService, groupId: string|null): Promise<Rule[]> => {
+    groupId = normalizeGroupId(groupId);
+
+    console.info("[GroupsService] Getting the list of rules for group: ", groupId);
+    return getRegistryClient(config, auth).groups.byGroupId(groupId).rules.get().then(ruleTypes => {
+        return Promise.all(ruleTypes!.map(rt => getGroupRule(config, auth, groupId, rt)));
+    });
+};
+
+const getGroupRule = async (config: ConfigService, auth: AuthService, groupId: string|null, ruleType: string): Promise<Rule> => {
+    groupId = normalizeGroupId(groupId);
+    return getRegistryClient(config, auth).groups.byGroupId(groupId).rules.byRuleType(ruleType).get().then(v => v!);
+};
+
+const createGroupRule = async (config: ConfigService, auth: AuthService, groupId: string|null, ruleType: string, configValue: string): Promise<Rule> => {
+    groupId = normalizeGroupId(groupId);
+    console.info("[GroupsService] Creating group rule:", ruleType);
+    const body: CreateRule = {
+        config: configValue,
+        ruleType: ruleType as RuleType
+    };
+    return getRegistryClient(config, auth).groups.byGroupId(groupId).rules.post(body).then(v => v!);
+};
+
+const updateGroupRule = async (config: ConfigService, auth: AuthService, groupId: string|null, ruleType: string, configValue: string): Promise<Rule> => {
+    groupId = normalizeGroupId(groupId);
+    console.info("[GroupsService] Updating group rule:", ruleType);
+    const body: Rule = {
+        config: configValue,
+        ruleType: ruleType as RuleType
+    };
+    return getRegistryClient(config, auth).groups.byGroupId(groupId).rules.byRuleType(ruleType).put(body).then(v => v!);
+};
+
+const deleteGroupRule = async (config: ConfigService, auth: AuthService, groupId: string|null, ruleType: string): Promise<void> => {
+    groupId = normalizeGroupId(groupId);
+    console.info("[GroupsService] Deleting group rule:", ruleType);
+    return getRegistryClient(config, auth).groups.byGroupId(groupId).rules.byRuleType(ruleType).delete();
+};
+
+
 const createArtifact = async (config: ConfigService, auth: AuthService, groupId: string|null, data: CreateArtifact): Promise<CreateArtifactResponse> => {
     groupId = normalizeGroupId(groupId);
     return getRegistryClient(config, auth).groups.byGroupId(groupId).artifacts.post(data).then(v => v!);
@@ -333,6 +374,12 @@ export interface GroupsService {
     updateGroupOwner(groupId: string, newOwner: string): Promise<void>;
     deleteGroup(groupId: string): Promise<void>;
 
+    getGroupRules(groupId: string|null): Promise<Rule[]>;
+    createGroupRule(groupId: string|null, ruleType: string, configValue: string): Promise<Rule>;
+    getGroupRule(groupId: string|null, ruleType: string): Promise<Rule>;
+    updateGroupRule(groupId: string|null, ruleType: string, configValue: string): Promise<Rule>;
+    deleteGroupRule(groupId: string|null, ruleType: string): Promise<void>;
+
     createArtifact(groupId: string|null, data: CreateArtifact): Promise<CreateArtifactResponse>;
     getArtifactMetaData(groupId: string|null, artifactId: string): Promise<ArtifactMetaData>;
     getArtifactReferences(globalId: number, refType: ReferenceType): Promise<ArtifactReference[]>;
@@ -394,6 +441,22 @@ export const useGroupsService: () => GroupsService = (): GroupsService => {
             return deleteGroup(config, auth, groupId);
         },
 
+        getGroupRules(groupId: string|null): Promise<Rule[]> {
+            return getGroupRules(config, auth, groupId);
+        },
+        createGroupRule(groupId: string|null, ruleType: string, configValue: string): Promise<Rule> {
+            return createGroupRule(config, auth, groupId, ruleType, configValue);
+        },
+        getGroupRule(groupId: string|null, ruleType: string): Promise<Rule> {
+            return getGroupRule(config, auth, groupId, ruleType);
+        },
+        updateGroupRule(groupId: string|null, ruleType: string, configValue: string): Promise<Rule> {
+            return updateGroupRule(config, auth, groupId, ruleType, configValue);
+        },
+        deleteGroupRule(groupId: string|null, ruleType: string): Promise<void> {
+            return deleteGroupRule(config, auth, groupId, ruleType);
+        },
+
         createArtifact(groupId: string|null, data: CreateArtifact): Promise<CreateArtifactResponse> {
             return createArtifact(config, auth, groupId, data);
         },

Original file line number	Diff line number	Diff line change
`@@ -325,6 +325,10 @@ public void createGroupRule(String groupId, CreateRule data) {`
`325`	`325`	`throw new MissingRequiredParameterException("config");`
`326`	`326`	`}`
`327`	`327`
	`328`	`+ if (new GroupId(groupId).isDefaultGroup()) {`
	`329`	`+ throw new NotAllowedException("Default group is not allowed");`
	`330`	`+ }`
	`331`	`+`
`328`	`332`	`RuleConfigurationDto config = new RuleConfigurationDto();`
`329`	`333`	`config.setConfiguration(data.getConfig());`
`330`	`334`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export enum RuleListType {`
	`2`	`+ Global, Group, Artifact`
	`3`	`+}`