feat: add feature flag for private repo builds (#4234)

* feat: add support for private repo build feature flag

The feature flag allows admins to enable independently
the builds feature and the support for building images
from private repositories.

The code repository selector has been updated to disable
private repository selection with a proper message.

This makes the workflow consistent for the user.

* chore: fix equality tests

Co-authored-by: Flora Thiebaut <flora@leafty.dev>

* chore: update error message

"Cannot clone repository" is more accurate than "No public access"
as it applies whether private repo build support is enabled or not.

Co-authored-by: Flora Thiebaut <flora@leafty.dev>

---------

Co-authored-by: Flora Thiebaut <flora@leafty.dev>

Author: sgaist

client/run-telepresence.sh

@@ -201,6 +201,7 @@ tee > ./public/config.json << EOF
   "USER_PREFERENCES_MAX_PINNED_PROJECTS": ${USER_PREFERENCES_MAX_PINNED_PROJECTS:-5},
   "SESSION_CLASS_EMAIL_US": { "enabled": false },
   "IMAGE_BUILDERS_ENABLED": true,
+  "BUILD_PRIVATE_REPO_BUILDS_ENABLED": true,
   "CONTACT_EMAIL":  "hello@renku.io"
 }
 EOF

client/server/constants.ts

@@ -83,6 +83,8 @@ export const CONFIG_JSON = {
     process.env.USER_PREFERENCES_MAX_PINNED_PROJECTS,
   SESSION_CLASS_EMAIL_US: safeJsonToObject(process.env.SESSION_CLASS_EMAIL_US),
   IMAGE_BUILDERS_ENABLED: process.env.IMAGE_BUILDERS_ENABLED,
+  BUILD_PRIVATE_REPO_BUILDS_ENABLED:
+    process.env.BUILD_PRIVATE_REPO_BUILDS_ENABLED,
   CONTACT_EMAIL: process.env.CONTACT_EMAIL || "hello@renku.io",
 };
 

client/src/features/sessionsV2/components/SessionForm/CodeRepositorySelector.tsx

@@ -17,7 +17,7 @@
  */
 
 import cx from "classnames";
-import { useCallback, useEffect, useMemo } from "react";
+import { useCallback, useContext, useEffect, useMemo } from "react";
 import { ChevronDown, XLg } from "react-bootstrap-icons";
 import {
   Controller,
@@ -38,6 +38,8 @@ import Select, {
 import { Label } from "reactstrap";
 
 import { GetRepositoriesApiResponse } from "~/features/repositories/api/repositories.api";
+import AppContext from "../../../../utils/context/appContext";
+import { DEFAULT_APP_PARAMS } from "../../../../utils/context/appParams.constants";
 import { getRepositoryName } from "../../../ProjectPageV2/ProjectPageContent/CodeRepositories/repositories.utils";
 
 import styles from "./Select.module.scss";
@@ -129,6 +131,11 @@ function CodeRepositorySelect({
   value: value_,
   disabled,
 }: CodeRepositorySelectProps) {
+  const { params } = useContext(AppContext);
+  const privateRepoBuildEnabled =
+    params?.BUILD_PRIVATE_REPO_BUILDS_ENABLED ??
+    DEFAULT_APP_PARAMS.BUILD_PRIVATE_REPO_BUILDS_ENABLED;
+
   const defaultValue = useMemo(
     () => options.find((repository) => repository.url === defaultValue_),
     [defaultValue_, options],
@@ -165,7 +172,9 @@ function CodeRepositorySelect({
       unstyled
       isOptionDisabled={(option) =>
         option.data?.status !== "valid" ||
-        !option.data.metadata?.pull_permission
+        !option.data.metadata?.pull_permission ||
+        (option.data.metadata.visibility === "private" &&
+          !privateRepoBuildEnabled)
       }
       onChange={onChange}
       onBlur={onBlur}
@@ -207,6 +216,11 @@ interface OptionValueContentProps {
 
 function OptionValueContent({ option, isDisabled }: OptionValueContentProps) {
   const title = getRepositoryName(option.url);
+  const { params } = useContext(AppContext);
+  const privateRepoBuildEnabled =
+    params?.BUILD_PRIVATE_REPO_BUILDS_ENABLED ??
+    DEFAULT_APP_PARAMS.BUILD_PRIVATE_REPO_BUILDS_ENABLED;
+
   return (
     <>
       <div>
@@ -218,12 +232,19 @@ function OptionValueContent({ option, isDisabled }: OptionValueContentProps) {
         >
           {title}
         </span>
-        {isDisabled && (
-          <span className="ms-1">
-            <XLg className={cx("bi", "me-1")} />
-            No public access
-          </span>
-        )}
+        {isDisabled &&
+          (option.data?.metadata?.visibility === "private" &&
+          !privateRepoBuildEnabled ? (
+            <span className="ms-1">
+              <XLg className={cx("bi", "me-1")} />
+              Private repository builds are not available
+            </span>
+          ) : (
+            <span className="ms-1">
+              <XLg className={cx("bi", "me-1")} />
+              Cannot clone repository
+            </span>
+          ))}
       </div>
       <div>{option.url}</div>
     </>
@@ -236,17 +257,29 @@ interface SingleValueContentProps {
 }
 
 function SingleValueContent({ option, isDisabled }: SingleValueContentProps) {
+  const { params } = useContext(AppContext);
+  const privateRepoBuildEnabled =
+    params?.BUILD_PRIVATE_REPO_BUILDS_ENABLED ??
+    DEFAULT_APP_PARAMS.BUILD_PRIVATE_REPO_BUILDS_ENABLED;
+
   return (
     <>
       <span className={cx(isDisabled && "text-decoration-line-through")}>
         {option.url}
       </span>
-      {isDisabled && (
-        <span className="ms-1">
-          <XLg className={cx("bi", "me-1")} />
-          No public access
-        </span>
-      )}
+      {isDisabled &&
+        (option.data?.metadata?.visibility == "private" &&
+        !privateRepoBuildEnabled ? (
+          <span className="ms-1">
+            <XLg className={cx("bi", "me-1")} />
+            Private repository builds are not available
+          </span>
+        ) : (
+          <span className="ms-1">
+            <XLg className={cx("bi", "me-1")} />
+            Cannot clone repository
+          </span>
+        ))}
     </>
   );
 }

client/src/utils/context/appParams.constants.ts

@@ -81,5 +81,6 @@ export const DEFAULT_APP_PARAMS: AppParams = {
   USER_PREFERENCES_MAX_PINNED_PROJECTS:
     DEFAULT_USER_PREFERENCES_MAX_PINNED_PROJECTS,
   IMAGE_BUILDERS_ENABLED: false,
+  BUILD_PRIVATE_REPO_BUILDS_ENABLED: false,
   CONTACT_EMAIL: "hello@renku.io",
 };

client/src/utils/context/appParams.types.ts

@@ -24,6 +24,7 @@ export interface AppParams {
   GATEWAY_URL: string;
   HOMEPAGE: HomepageParams;
   IMAGE_BUILDERS_ENABLED: boolean;
+  BUILD_PRIVATE_REPO_BUILDS_ENABLED: boolean;
   KEYCLOAK_REALM: string;
   MAINTENANCE: string;
   PREVIEW_THRESHOLD: PreviewThresholdParams;

client/src/utils/context/appParams.utils.ts

@@ -69,6 +69,10 @@ export function validatedAppParams(params: unknown): AppParams {
     params_,
     "IMAGE_BUILDERS_ENABLED",
   );
+  const BUILD_PRIVATE_REPO_BUILDS_ENABLED = validateBoolean(
+    params_,
+    "BUILD_PRIVATE_REPO_BUILDS_ENABLED",
+  );
 
   // Integer params
   const USER_PREFERENCES_MAX_PINNED_PROJECTS = validateInteger(
@@ -91,6 +95,7 @@ export function validatedAppParams(params: unknown): AppParams {
     GATEWAY_URL,
     HOMEPAGE,
     IMAGE_BUILDERS_ENABLED,
+    BUILD_PRIVATE_REPO_BUILDS_ENABLED,
     KEYCLOAK_REALM,
     MAINTENANCE,
     PREVIEW_THRESHOLD,

tests/cypress/fixtures/config-no-legacy.json

@@ -69,6 +69,7 @@
   },
   "USER_PREFERENCES_MAX_PINNED_PROJECTS": 5,
   "IMAGE_BUILDERS_ENABLED": true,
+  "BUILD_PRIVATE_REPO_BUILDS_ENABLED": true,
   "LEGACY_SUPPORT": {
     "enabled": false
   },

tests/cypress/fixtures/config.json

@@ -69,5 +69,6 @@
   },
   "USER_PREFERENCES_MAX_PINNED_PROJECTS": 5,
   "IMAGE_BUILDERS_ENABLED": true,
+  "BUILD_PRIVATE_REPO_BUILDS_ENABLED": true,
   "CONTACT_EMAIL": "hello@renku.io"
 }

tests/cypress/fixtures/config_privacy_banner.json

@@ -69,5 +69,6 @@
   },
   "USER_PREFERENCES_MAX_PINNED_PROJECTS": 5,
   "IMAGE_BUILDERS_ENABLED": true,
+  "BUILD_PRIVATE_REPO_BUILDS_ENABLED": true,
   "CONTACT_EMAIL": "hello@renku.io"
 }