Skip to content
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

Bug 1970011: Fix edge case for "managed by" links #9331

Merged
merged 1 commit into from Jul 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 32 additions & 36 deletions frontend/public/components/utils/managed-by.tsx
Expand Up @@ -4,11 +4,9 @@ import { Link } from 'react-router-dom';
import { useTranslation } from 'react-i18next';

import { ResourceIcon } from './resource-icon';
import { resourcePathFromModel } from './resource-link';
import {
groupVersionFor,
K8sResourceCommon,
referenceForGroupVersionKind,
referenceForModel,
referenceForOwnerRef,
OwnerReference,
modelFor,
Expand All @@ -19,38 +17,39 @@ import { ClusterServiceVersionModel } from '@console/operator-lifecycle-manager/
import { ClusterServiceVersionKind } from '@console/operator-lifecycle-manager';
import { ResourceLink } from '.';

export const ManagedByOperatorResourceLink: React.SFC<ManagerLinkProps> = (props) => {
const { csvName, namespace, owner, className } = props;
const name = owner.name;
const { group, version } = groupVersionFor(owner.apiVersion);
const kind = owner.kind;

const reference = referenceForGroupVersionKind(group)(version)(kind);
const { namespaced } = modelFor(reference);

const link = `/k8s/ns/${namespace}/${referenceForModel(
ClusterServiceVersionModel,
)}/${csvName}/${reference}/${name}`;

export const ManagedByOperatorResourceLink: React.SFC<ManagerLinkProps> = ({
csvName,
namespace,
owner,
className,
}) => {
const ownerGroupVersionKind = referenceForOwnerRef(owner);
const { apiGroup, kind, namespaced } = modelFor(ownerGroupVersionKind) ?? {};
const ownerIsCSV =
apiGroup === ClusterServiceVersionModel.apiGroup && kind === ClusterServiceVersionModel.kind;
const link = resourcePathFromModel(ClusterServiceVersionModel, csvName, namespace);
return (
<span className={className}>
{namespaced ? (
<>
<ResourceIcon kind={referenceForOwnerRef(owner)} />
<Link to={link} className="co-resource-item__resource-name" data-test-operand-link={name}>
{name}
<ResourceIcon kind={ownerGroupVersionKind} />
<Link
to={ownerIsCSV ? link : `${link}/${ownerGroupVersionKind}/${owner.name}`}
className="co-resource-item__resource-name"
data-test-operand-link={owner.name}
>
{owner.name}
</Link>
</>
) : (
<ResourceLink kind={reference} name={name} />
<ResourceLink kind={ownerGroupVersionKind} name={owner.name} />
)}
</span>
);
};

export const ManagedByOperatorLink: React.SFC<ManagedByLinkProps> = (props) => {
export const ManagedByOperatorLink: React.SFC<ManagedByLinkProps> = ({ obj, className }) => {
const { t } = useTranslation();
const { obj, className } = props;
const [data, setData] = React.useState<ClusterServiceVersionKind[] | undefined>();
const namespace = obj.metadata.namespace;
React.useEffect(() => {
Expand All @@ -67,20 +66,17 @@ export const ManagedByOperatorLink: React.SFC<ManagedByLinkProps> = (props) => {
const owner = findOwner(obj, data);
const csv = data && owner ? matchOwnerAndCSV(owner, data) : undefined;

if (owner && csv) {
return (
<div className={classNames('co-m-pane__heading-owner', className)}>
{t('public~Managed by')}{' '}
<ManagedByOperatorResourceLink
className="co-resource-item"
namespace={namespace}
csvName={csv.metadata.name}
owner={owner}
/>
</div>
);
}
return null;
return owner && csv ? (
<div className={classNames('co-m-pane__heading-owner', className)}>
{t('public~Managed by')}{' '}
<ManagedByOperatorResourceLink
className="co-resource-item"
namespace={namespace}
csvName={csv.metadata.name}
owner={owner}
/>
</div>
) : null;
};

type ManagedByLinkProps = {
Expand Down
26 changes: 20 additions & 6 deletions frontend/public/module/k8s/managed-by.ts
@@ -1,6 +1,10 @@
import { groupVersionFor, K8sResourceCommon, OwnerReference } from './';
import { ClusterServiceVersionKind } from '@console/operator-lifecycle-manager';
import { K8sResourceCommon, OwnerReference, groupVersionFor } from './';
import {
ClusterServiceVersionKind,
ClusterServiceVersionModel,
} from '@console/operator-lifecycle-manager';

// Check if owner is an Operand under csv
const isOwnedByOperator = (csv: ClusterServiceVersionKind, owner: OwnerReference) => {
const { group } = groupVersionFor(owner.apiVersion);
return csv.spec?.customresourcedefinitions?.owned?.some((owned) => {
Expand All @@ -9,15 +13,25 @@ const isOwnedByOperator = (csv: ClusterServiceVersionKind, owner: OwnerReference
});
};

const isOwnedByCSV = (csv: ClusterServiceVersionKind, owner: OwnerReference) =>
csv.kind === owner.kind && csv.apiVersion === owner.apiVersion;
// Check if csv === owner (there is no need to check namespace because ownerReferences must
// be in the same namespace as the owned resource, or be cluster-scoped).
const isOwnedByCSV = (csv: ClusterServiceVersionKind, owner: OwnerReference) => {
const { group } = groupVersionFor(owner.apiVersion);
return (
group === ClusterServiceVersionModel.apiGroup &&
owner.kind === ClusterServiceVersionModel.kind &&
csv.metadata.name === owner.name
);
};

// Find an Operator CSV that either is the owner or owns the owner
export const matchOwnerAndCSV = (owner: OwnerReference, csvs: ClusterServiceVersionKind[] = []) => {
return csvs.find((csv) => isOwnedByOperator(csv, owner) || isOwnedByCSV(csv, owner));
};

export const findOwner = (obj: K8sResourceCommon, data: ClusterServiceVersionKind[]) => {
// Find onwerReference that is either a CSV or is an Operand managed by a CSV.
export const findOwner = (obj: K8sResourceCommon, csvs: ClusterServiceVersionKind[]) => {
return obj?.metadata?.ownerReferences?.find((o) =>
data?.some((csv) => isOwnedByOperator(csv, o) || isOwnedByCSV(csv, o)),
csvs?.some((csv) => isOwnedByOperator(csv, o) || isOwnedByCSV(csv, o)),
);
};