If runner feature disabled, don't show 'runner' navlink or pages

Author: david-mears-2

api/README.md

@@ -10,7 +10,7 @@ This API is built with [Spring boot framework](https://spring.io)
 ## Run dependencies
 
 Before you can start packit you need to run `./scripts/run-dependencies` from the project root
-to start database and `outpack_server` instances.
+to start database, `orderly.runner` server and worker, and `outpack_server` instances.
 
 ## Starting App
 

api/app/src/main/kotlin/packit/controllers/RunnerController.kt

@@ -18,6 +18,11 @@ import packit.service.RunnerService
 @RequestMapping("/runner")
 @PreAuthorize("hasAuthority('packet.run')")
 class RunnerController(private val runnerService: RunnerService) {
+    @GetMapping("/enabled")
+    fun getEnabled(): ResponseEntity<Boolean> {
+        return ResponseEntity.ok(runnerService.getEnabled())
+    }
+
     @GetMapping("/version")
     fun getVersion(): ResponseEntity<OrderlyRunnerVersion> {
         return ResponseEntity.ok(runnerService.getVersion())

api/app/src/main/kotlin/packit/service/RunnerService.kt

@@ -14,6 +14,7 @@ import packit.model.dto.*
 import packit.repository.RunInfoRepository
 
 interface RunnerService {
+    fun getEnabled(): Boolean = true
     fun getVersion(): OrderlyRunnerVersion
     fun gitFetch()
     fun getBranches(): GitBranches
@@ -167,6 +168,7 @@ class DisabledRunnerService : RunnerService {
         throw PackitException("runnerDisabled", HttpStatus.FORBIDDEN)
     }
 
+    override fun getEnabled(): Boolean = false
     override fun getVersion(): OrderlyRunnerVersion = error()
     override fun gitFetch() = error()
     override fun getBranches(): GitBranches = error()

api/app/src/test/kotlin/packit/integration/controllers/RunnerControllerTest.kt

@@ -96,6 +96,20 @@ class RunnerControllerTest : IntegrationTest() {
         userRepository.delete(testUser)
     }
 
+    @Test
+    @WithAuthenticatedUser(authorities = ["packet.run"])
+    fun `reports enabled status`() {
+        val res: ResponseEntity<JsonNode> = restTemplate.exchange(
+            "/runner/enabled",
+            HttpMethod.GET,
+            getTokenizedHttpEntity()
+        )
+
+        assertSuccess(res)
+
+        assertEquals(true, res.body!!.asBoolean())
+    }
+
     @Test
     @WithAuthenticatedUser(authorities = ["packet.run"])
     fun `can get orderly runner version`() {
@@ -334,6 +348,20 @@ class UnknownRepoRunnerControllerTest : IntegrationTest() {
 
 @TestPropertySource(properties = ["orderly.runner.enabled=false"])
 class DisabledRunnerControllerTest : IntegrationTest() {
+    @Test
+    @WithAuthenticatedUser(authorities = ["packet.run"])
+    fun `reports disabled status`() {
+        val res: ResponseEntity<JsonNode> = restTemplate.exchange(
+            "/runner/enabled",
+            HttpMethod.GET,
+            getTokenizedHttpEntity()
+        )
+
+        assertSuccess(res)
+
+        assertEquals(false, res.body!!.asBoolean())
+    }
+
     @Test
     @WithAuthenticatedUser(authorities = ["packet.run"])
     fun `cannot get orderly runner version`() {

api/app/src/test/kotlin/packit/unit/service/RunnerServiceTest.kt

@@ -76,6 +76,12 @@ class RunnerServiceTest {
         userService
     )
 
+    @Test
+    fun `can report enabled status`() {
+        val result = sut.getEnabled()
+        assertEquals(result, true)
+    }
+
     @Test
     fun `can get version`() {
         val result = sut.getVersion()

app/src/app/components/contents/runner/PacketRunnerLayout.tsx

@@ -4,6 +4,7 @@ import { SidebarItem } from "@lib/types/SidebarItem";
 import { useUser } from "../../providers/UserProvider";
 import { Sidebar } from "../common/Sidebar";
 import { Unauthorized } from "../common/Unauthorized";
+import { useGetRunnerEnabled } from "@components/header/hooks/useGetRunnerEnabled";
 
 const sidebarItems: SidebarItem[] = [
   {
@@ -18,7 +19,9 @@ const sidebarItems: SidebarItem[] = [
 
 export const PacketRunnerLayout = () => {
   const { authorities } = useUser();
-  if (!hasPacketRunPermission(authorities)) {
+  const { isRunnerEnabled } = useGetRunnerEnabled(hasPacketRunPermission(authorities));
+
+  if (!hasPacketRunPermission(authorities) || isRunnerEnabled === false) {
     return <Unauthorized />;
   }
   return (

app/src/app/components/header/NavMenu.tsx

@@ -8,35 +8,30 @@ import { DropdownMenu, DropdownMenuTrigger, DropdownMenuContent, DropdownMenuIte
 import { Menu } from "lucide-react";
 import { NavLink } from "react-router-dom";
 import { Button, buttonVariants } from "../Base/Button";
-
+import { useGetRunnerEnabled } from "./hooks/useGetRunnerEnabled";
 interface NavMenuProps extends React.HTMLAttributes<HTMLElement> {
   authorities: string[];
 }
 export const NavMenu = ({ className, authorities, ...props }: NavMenuProps) => {
-  const NavItems: { [key: string]: string } = {
-    runner: "Runner"
-    // accessibility: "Accessibility",
-  };
+  const canRunPackets = hasPacketRunPermission(authorities);
+  const { isRunnerEnabled, isLoading: isRunnerEnabledLoading } = useGetRunnerEnabled(canRunPackets);
+
+  const NavItems: { [key: string]: string } = {};
 
-  const displayableItems = Object.keys(NavItems).filter((to) => {
-    if (to === "runner" && !hasPacketRunPermission(authorities)) {
-      return false;
-    } else {
-      return true;
-    }
-  });
+  if (canRunPackets && !isRunnerEnabledLoading && isRunnerEnabled) {
+    NavItems.runner = "Runner";
+  }
 
   // Special case: route "Admin" to appropriate tab depending on user perms
   if (hasUserManagePermission(authorities) || hasGlobalPacketManagePermission(authorities)) {
     const key = hasUserManagePermission(authorities) ? "manage-roles" : "resync-packets";
     NavItems[key] = "Admin";
-    displayableItems.push(key);
   }
 
   return (
     <div className="flex-1">
       <nav className={cn("flex items-center space-x-2 pr-4 lg:pr-6 justify-end", className)} {...props}>
-        {displayableItems.map((to) => (
+        {Object.entries(NavItems).map(([to, label]) => (
           <NavLink
             to={to}
             key={to}
@@ -51,7 +46,7 @@ export const NavMenu = ({ className, authorities, ...props }: NavMenuProps) => {
               )
             }
           >
-            {NavItems[to]}
+            {label}
           </NavLink>
         ))}
       </nav>
@@ -63,9 +58,9 @@ export const NavMenu = ({ className, authorities, ...props }: NavMenuProps) => {
             </Button>
           </DropdownMenuTrigger>
           <DropdownMenuContent className="w-48">
-            {displayableItems.map((to) => (
+            {Object.entries(NavItems).map(([to, label]) => (
               <DropdownMenuItem key={to} asChild>
-                <NavLink to={to}>{NavItems[to]}</NavLink>
+                <NavLink to={to}>{label}</NavLink>
               </DropdownMenuItem>
             ))}
           </DropdownMenuContent>

app/src/app/components/header/hooks/useGetRunnerEnabled.ts

@@ -0,0 +1,19 @@
+import useSWR from "swr";
+import appConfig from "@config/appConfig";
+import { fetcher } from "@lib/fetch";
+
+export const useGetRunnerEnabled = (shouldFetch = true) => {
+  const { data, error, isLoading } = useSWR<boolean>(
+    shouldFetch ? `${appConfig.apiUrl()}/runner/enabled` : null,
+    (url: string) => fetcher({ url }),
+    {
+      revalidateOnFocus: false
+    }
+  );
+
+  return {
+    isRunnerEnabled: data === true,
+    isLoading,
+    error
+  };
+};

app/src/tests/components/contents/runner/PacketRunnerLayout.test.tsx

@@ -3,8 +3,16 @@ import userEvent from "@testing-library/user-event";
 import { MemoryRouter, Route, Routes } from "react-router-dom";
 import { PacketRunnerLayout } from "@components/contents/runner";
 import * as UserProvider from "@components/providers/UserProvider";
+import { useGetRunnerEnabled } from "@components/header/hooks/useGetRunnerEnabled";
 
 const mockUseUser = vitest.spyOn(UserProvider, "useUser");
+
+vitest.mock("@components/header/hooks/useGetRunnerEnabled", () => ({
+  useGetRunnerEnabled: vitest.fn()
+}));
+
+const mockedUseGetRunnerEnabled = vitest.mocked(useGetRunnerEnabled);
+
 describe("packet runner component", () => {
   const renderElement = () => {
     return render(
@@ -21,6 +29,11 @@ describe("packet runner component", () => {
 
   it("should allow navigation between run and logs in from sidebar given packet.run permission", async () => {
     mockUseUser.mockReturnValue({ authorities: ["packet.run"] } as any);
+    mockedUseGetRunnerEnabled.mockReturnValue({
+      isRunnerEnabled: true,
+      isLoading: false,
+      error: undefined
+    });
     renderElement();
 
     // ensure correct url route is loaded
@@ -36,9 +49,27 @@ describe("packet runner component", () => {
   });
 
   it("should show unauthorized when user does not have packet.run authority", () => {
+    mockedUseGetRunnerEnabled.mockReturnValue({
+      isRunnerEnabled: true,
+      isLoading: false,
+      error: undefined
+    });
     mockUseUser.mockReturnValue({ authorities: [""] } as any);
     renderElement();
 
     expect(screen.getByText(/Unauthorized/)).toBeVisible();
   });
+
+  it("should show unauthorized when orderly runner is not enabled", () => {
+    mockUseUser.mockReturnValue({ authorities: ["packet.run"] } as any);
+    mockedUseGetRunnerEnabled.mockReturnValue({
+      isRunnerEnabled: false,
+      isLoading: false,
+      error: undefined
+    });
+
+    renderElement();
+
+    expect(screen.getByText(/Unauthorized/)).toBeVisible();
+  });
 });

app/src/tests/components/header/Header.test.tsx

@@ -10,11 +10,24 @@ import { BrandingProvider } from "@components/providers/BrandingProvider";
 import { expectThemeClass, handleRequestWithEnabledThemes } from "../../testUtils";
 import { LocalStorageKeys } from "@lib/types/LocalStorageKeys";
 import { SWRConfig } from "swr";
+import { useGetRunnerEnabled } from "@components/header/hooks/useGetRunnerEnabled";
 
 const mockUseUser = vitest.spyOn(UserProvider, "useUser");
 
+vitest.mock("@components/header/hooks/useGetRunnerEnabled", () => ({
+  useGetRunnerEnabled: vitest.fn()
+}));
+
+const mockedUseGetRunnerEnabled = vitest.mocked(useGetRunnerEnabled);
+
 describe("header component", () => {
   const renderElement = () => {
+    mockedUseGetRunnerEnabled.mockReturnValue({
+      isRunnerEnabled: true,
+      isLoading: false,
+      error: undefined
+    });
+
     return render(
       <SWRConfig value={{ provider: () => new Map() }}>
         <MemoryRouter>