EVG-20692: Indicate if a version has been ignored (#2095)

cypress/integration/version/banners.ts

@@ -2,11 +2,11 @@ describe("banners", () => {
   const versionWithBanners =
     "/version/logkeeper_e864cf934194c161aa044e4599c8c81cee7b6237/tasks?sorts=STATUS%3AASC%3BBASE_STATUS%3ADESC";
 
-  beforeEach(() => {
-    cy.visit(versionWithBanners);
-  });
-
   describe("errors", () => {
+    beforeEach(() => {
+      cy.visit(versionWithBanners);
+    });
+
     it("should display the number of configuration errors", () => {
       cy.dataCy("configuration-errors-banner").should("be.visible");
       cy.contains("4 errors in configuration file").should("be.visible");
@@ -19,6 +19,10 @@ describe("banners", () => {
   });
 
   describe("warnings", () => {
+    beforeEach(() => {
+      cy.visit(versionWithBanners);
+    });
+
     it("should display the number of configuration warnings", () => {
       cy.dataCy("configuration-warnings-banner").should("be.visible");
       cy.contains("3 warnings in configuration file").should("be.visible");
@@ -29,4 +33,19 @@ describe("banners", () => {
       cy.get("ol").find("li").should("have.length", 3);
     });
   });
+
+  describe("ignored", () => {
+    it("should display a banner", () => {
+      cy.visit("/version/spruce_e695f654c8b4b959d3e12e71696c3e318bcd4c33");
+      cy.dataCy("ignored-banner").should("be.visible");
+    });
+
+    it("should indicate if a version is ignored in the inactive commits tooltip", () => {
+      cy.visit("/commits/spruce");
+      cy.dataCy("ignored-icon").should("not.exist");
+      cy.dataCy("inactive-commits-button").click();
+      cy.dataCy("inactive-commits-tooltip").should("be.visible");
+      cy.dataCy("ignored-icon").should("be.visible");
+    });
+  });
 });

src/components/Icon/icons/index.tsx

@@ -6,6 +6,7 @@ const { green } = palette;
 interface LeafygreenIconProps extends React.SVGProps<SVGSVGElement> {
   size?: number;
   role?: "presentation" | "img";
+  ["data-cy"]?: string;
 }
 
 export const EvergreenLogo: React.ComponentType<LeafygreenIconProps> = ({
@@ -241,3 +242,27 @@ export const Loading: React.ComponentType<LeafygreenIconProps> = ({
     </g>
   </svg>
 );
+
+export const Ignored: React.ComponentType<LeafygreenIconProps> = ({
+  className,
+  "data-cy": dataCy,
+  fill,
+  size = 16,
+}) => (
+  <svg
+    aria-label="Ignored Icon"
+    data-cy={dataCy}
+    className={className}
+    fill="currentColor"
+    height={size}
+    width={size}
+    xmlns="http://www.w3.org/2000/svg"
+  >
+    <path
+      fill={fill}
+      fillRule="evenodd"
+      d="M8 14A6 6 0 1 0 8 2a6 6 0 0 0 0 12ZM5 7a1 1 0 0 0 0 2h6a1 1 0 1 0 0-2H5Z"
+      clipRule="evenodd"
+    />
+  </svg>
+);

src/constants/externalResources.ts

@@ -26,6 +26,8 @@ export const githubChecksAliasesDocumentationUrl = `${projectDistroSettingsDocum
 
 export const githubMergeQueueDocumentationUrl = `${wikiBaseUrl}/Project-Configuration/Merge-Queue`;
 
+export const ignoredFilesDocumentationUrl = `${wikiBaseUrl}/Project-Configuration/Project-Configuration-Files#ignoring-changes-to-certain-files`;
+
 export const cliDocumentationUrl = `${wikiBaseUrl}/CLI`;
 
 export const windowsPasswordRulesURL =

src/gql/generated/types.ts

@@ -6182,6 +6182,7 @@ export type MainlineCommitsQuery = {
         author: string;
         createTime: Date;
         id: string;
+        ignored: boolean;
         message: string;
         order: number;
         revision: string;
@@ -8739,6 +8740,7 @@ export type VersionQuery = {
     errors: Array<string>;
     finishTime?: Date | null;
     id: string;
+    ignored: boolean;
     isPatch: boolean;
     message: string;
     order: number;

src/gql/queries/mainline-commits.graphql

@@ -18,6 +18,7 @@ query MainlineCommits(
         author
         createTime
         id
+        ignored
         message
         order
         revision

src/gql/queries/version.graphql

@@ -19,6 +19,7 @@ query Version($id: String!) {
       tag
     }
     id
+    ignored
     isPatch
     manifest {
       branch

src/pages/Version.tsx

@@ -28,7 +28,7 @@ import { PageDoesNotExist } from "pages/404";
 import { isPatchUnconfigured } from "utils/patch";
 import { shortenGithash, githubPRLinkify } from "utils/string";
 import { jiraLinkify } from "utils/string/jiraLinkify";
-import { WarningBanner, ErrorBanner } from "./version/Banners";
+import { WarningBanner, ErrorBanner, IgnoredBanner } from "./version/Banners";
 import VersionPageBreadcrumbs from "./version/Breadcrumbs";
 import BuildVariantCard from "./version/BuildVariantCard";
 import { ActionButtons, Metadata, VersionTabs } from "./version/index";
@@ -133,6 +133,7 @@ export const VersionPage: React.FC = () => {
   const { version } = versionData || {};
   const {
     errors,
+    ignored,
     isPatch,
     message,
     order,
@@ -165,6 +166,7 @@ export const VersionPage: React.FC = () => {
       <ProjectBanner projectIdentifier={projectIdentifier} />
       {errors && errors.length > 0 && <ErrorBanner errors={errors} />}
       {warnings && warnings.length > 0 && <WarningBanner warnings={warnings} />}
+      {ignored && <IgnoredBanner />}
       {version && (
         <VersionPageBreadcrumbs
           patchNumber={patchNumber}

src/pages/commits/InactiveCommits/InactiveCommits.stories.tsx

@@ -1,4 +1,5 @@
 import { CustomStoryObj, CustomMeta } from "test_utils/types";
+import { CommitRolledUpVersions } from "types/commits";
 import { InactiveCommitButton as InactiveCommits } from ".";
 
 export default {
@@ -12,14 +13,15 @@ export const Default: CustomStoryObj<typeof InactiveCommits> = {
   },
 };
 
-const versions = [
+const versions: CommitRolledUpVersions = [
   {
     id: "123",
     createTime: new Date("2021-06-16T23:38:13Z"),
     message: "SERVER-57332 Create skeleton InternalDocumentSourceDensify",
     order: 39365,
     author: "Mohamed Khelif",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: false,
     upstreamProject: {
       triggerID: "123",
       triggerType: "task",
@@ -38,6 +40,7 @@ const versions = [
     order: 39366,
     author: "Arjun Patel",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: false,
   },
   {
     id: "123",
@@ -46,6 +49,7 @@ const versions = [
     order: 39365,
     author: "Mohamed Khelif",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: false,
   },
   {
     id: "123",
@@ -54,6 +58,7 @@ const versions = [
     order: 39366,
     author: "Arjun Patel",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: false,
   },
   {
     id: "123",
@@ -62,6 +67,7 @@ const versions = [
     order: 39365,
     author: "Elena Chen",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: true,
   },
   {
     id: "123",
@@ -70,5 +76,6 @@ const versions = [
     order: 39366,
     author: "Sophie Stadler",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: false,
   },
 ];

src/pages/commits/InactiveCommits/InactiveCommits.test.tsx

@@ -104,17 +104,29 @@ describe("inactiveCommitButton", () => {
       "6Unmatching"
     );
   });
+
+  it("should show ignored icon for ignored versions", async () => {
+    const user = userEvent.setup();
+    render(<RenderInactiveCommitButton versions={versions.slice(0, 1)} />);
+    expect(screen.queryByDataCy("inactive-commits-tooltip")).toBeNull();
+    await user.click(screen.queryByDataCy("inactive-commits-button"));
+    await waitFor(() => {
+      expect(screen.queryByDataCy("inactive-commits-tooltip")).toBeVisible();
+    });
+    expect(screen.getByDataCy("ignored-icon")).toBeVisible();
+  });
 });
 
 const time = new Date("2021-06-16T23:38:13Z");
-const versions = [
+const versions: CommitRolledUpVersions = [
   {
     id: "1",
     createTime: time,
     message: "SERVER-57332 Create skeleton InternalDocumentSourceDensify",
     order: 39365,
     author: "Mohamed Khelif",
     revision: "4137c33fa4a0d5c747a1115f0853b5f70e46f112",
+    ignored: true,
   },
   {
     id: "2",
@@ -123,6 +135,7 @@ const versions = [
     order: 39366,
     author: "Arjun Patel",
     revision: "4237c33fa4a0d5c747a1115f0853b5f70e46f113",
+    ignored: false,
   },
   {
     id: "3",
@@ -131,6 +144,7 @@ const versions = [
     order: 39365,
     author: "Mohamed Khelif",
     revision: "4337c33fa4a0d5c747a1115f0853b5f70e46f114",
+    ignored: false,
   },
   {
     id: "4",
@@ -139,6 +153,7 @@ const versions = [
     order: 39366,
     author: "Arjun Patel",
     revision: "4437c33fa4a0d5c747a1115f0853b5f70e46f115",
+    ignored: false,
   },
   {
     id: "5",
@@ -147,6 +162,7 @@ const versions = [
     order: 39365,
     author: "Elena Chen",
     revision: "4537c33fa4a0d5c747a1115f0853b5f70e46f116",
+    ignored: false,
   },
   {
     id: "6",
@@ -155,5 +171,6 @@ const versions = [
     order: 39366,
     author: "Sophie Stadler",
     revision: "4637c33fa4a0d5c747a1115f0853b5f70e46f117",
+    ignored: false,
   },
 ];

src/pages/commits/InactiveCommits/index.tsx

@@ -5,6 +5,7 @@ import Tooltip from "@leafygreen-ui/tooltip";
 import { Disclaimer } from "@leafygreen-ui/typography";
 import { useProjectHealthAnalytics } from "analytics/projectHealth/useProjectHealthAnalytics";
 import { DisplayModal } from "components/DisplayModal";
+import Icon from "components/Icon";
 import { StyledRouterLink } from "components/styles";
 import { getVersionRoute, getTaskRoute } from "constants/routes";
 import { size, zIndex, fontSize } from "constants/tokens";
@@ -167,6 +168,7 @@ const CommitCopy: React.FC<CommitCopyProps> = ({ isTooltip, v }) => {
         </>
       )}
       <CommitBodyText>
+        {v.ignored && <StyledIcon data-cy="ignored-icon" glyph="Ignored" />}
         {v.author} -{" "}
         {jiraLinkify(message, jiraHost, () => {
           sendEvent({
@@ -181,6 +183,11 @@ const CommitCopy: React.FC<CommitCopyProps> = ({ isTooltip, v }) => {
   );
 };
 
+const StyledIcon = styled(Icon)`
+  margin-right: ${size.xxs};
+  vertical-align: text-bottom;
+`;
+
 const InactiveCommitContainer = styled.div`
   display: flex;
   justify-content: center;

src/pages/commits/ProjectHealth.stories.tsx

@@ -235,6 +235,7 @@ const versions: Commits = [
         order: 927,
         message: "v2.11.1",
         revision: "a77bd39ccf515b63327dc2355a8444955043c66a",
+        ignored: false,
       },
     ],
   },

src/pages/version/Banners/IgnoredBanner/index.tsx

@@ -0,0 +1,18 @@
+import Banner, { Variant } from "@leafygreen-ui/banner";
+import { StyledLink } from "components/styles";
+import { ignoredFilesDocumentationUrl } from "constants/externalResources";
+import { BannerContainer } from "../styles";
+
+const IgnoredBanner: React.FC = () => (
+  <BannerContainer data-cy="ignored-banner">
+    <Banner variant={Variant.Info}>
+      This revision will not be automatically scheduled, because only{" "}
+      <StyledLink href={ignoredFilesDocumentationUrl} target="_blank">
+        ignored files
+      </StyledLink>{" "}
+      are changed. It may still be scheduled manually, or on failure stepback.
+    </Banner>
+  </BannerContainer>
+);
+
+export default IgnoredBanner;

src/pages/version/Banners/index.tsx

@@ -1,4 +1,5 @@
 import ErrorBanner from "./ErrorBanner";
+import IgnoredBanner from "./IgnoredBanner";
 import WarningBanner from "./WarningBanner";
 
-export { WarningBanner, ErrorBanner };
+export { WarningBanner, ErrorBanner, IgnoredBanner };