Merge pull request #262 from mrc-ide/check-orderly-runner-enabled

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

Author: david-mears-2

AGENTS.md

@@ -0,0 +1 @@
+Before submitting a PR or set of changes to a PR, if any changes have been made to the front end, ensure linting and formatting are clean, e.g. with `npm run lint:fix --prefix=app` or `npm run format:write --prefix=app`. Don't make these pass by using comments to ignore linter warnings: actually fix the highlighted issues. No exceptions.

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,12 @@ import packit.service.RunnerService
 @RequestMapping("/runner")
 @PreAuthorize("hasAuthority('packet.run')")
 class RunnerController(private val runnerService: RunnerService) {
+    @PreAuthorize("permitAll()")
+    @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/security/WebSecurityConfig.kt

@@ -123,6 +123,7 @@ class WebSecurityConfig(
                         .requestMatchers("/auth/**", "/oauth2/**").permitAll()
                         .requestMatchers("/deviceAuth", "/deviceAuth/token").permitAll()
                         .requestMatchers("/branding/config").permitAll()
+                        .requestMatchers("/runner/enabled").permitAll()
                         .dispatcherTypeMatchers(DispatcherType.FORWARD, DispatcherType.ERROR).permitAll()
                         .anyRequest().authenticated()
                 }

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,32 @@ class RunnerControllerTest : IntegrationTest() {
         userRepository.delete(testUser)
     }
 
+    @Test
+    fun `reports enabled status when not logged in`() {
+        val res: ResponseEntity<JsonNode> = restTemplate.exchange(
+            "/runner/enabled",
+            HttpMethod.GET,
+        )
+
+        assertSuccess(res)
+
+        assertEquals(true, res.body!!.asBoolean())
+    }
+
+    @Test
+    @WithAuthenticatedUser(authorities = [])
+    fun `reports enabled status when no packet run permision`() {
+        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 +360,32 @@ class UnknownRepoRunnerControllerTest : IntegrationTest() {
 
 @TestPropertySource(properties = ["orderly.runner.enabled=false"])
 class DisabledRunnerControllerTest : IntegrationTest() {
+    @Test
+    fun `reports disabled status when not logged in`() {
+        val res: ResponseEntity<JsonNode> = restTemplate.exchange(
+            "/runner/enabled",
+            HttpMethod.GET,
+        )
+
+        assertSuccess(res)
+
+        assertEquals(false, res.body!!.asBoolean())
+    }
+
+    @Test
+    @WithAuthenticatedUser(authorities = [])
+    fun `reports disabled status when no packet run permission`() {
+        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 { useRunnerConfig } from "../../providers/RunnerConfigProvider";
 
 const sidebarItems: SidebarItem[] = [
   {
@@ -18,7 +19,9 @@ const sidebarItems: SidebarItem[] = [
 
 export const PacketRunnerLayout = () => {
   const { authorities } = useUser();
-  if (!hasPacketRunPermission(authorities)) {
+  const isRunnerEnabled = useRunnerConfig();
+
+  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 { useRunnerConfig } from "../providers/RunnerConfigProvider";
 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 isRunnerEnabled = useRunnerConfig();
+  const isLoading = isRunnerEnabled === null;
+
+  const NavItems: { [key: string]: string } = {};
 
-  const displayableItems = Object.keys(NavItems).filter((to) => {
-    if (to === "runner" && !hasPacketRunPermission(authorities)) {
-      return false;
-    } else {
-      return true;
-    }
-  });
+  if (hasPacketRunPermission(authorities) && !isLoading && 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,17 @@
+import useSWR from "swr";
+import appConfig from "@config/appConfig";
+import { fetcher } from "@lib/fetch";
+
+export const useGetRunnerEnabled = (runnerEnabled: boolean | null) => {
+  const { data, error, isLoading } = useSWR<boolean>(
+    runnerEnabled === null ? `${appConfig.apiUrl()}/runner/enabled` : null,
+    (url: string) => fetcher({ url, noAuth: true }),
+    { revalidateOnFocus: false }
+  );
+
+  return {
+    isRunnerEnabled: data,
+    isLoading,
+    error
+  };
+};