Tolerate errors loading repository properties

init/action.yml

@@ -159,6 +159,9 @@ inputs:
     description: >-
       Explicitly enable or disable caching of project build dependencies.
     required: false
+  repository-owner-type:
+    default: ${{ github.event.repository.owner.type }}
+    required: false
 outputs:
   codeql-path:
     description: The path of the CodeQL binary used for analysis

src/feature-flags/properties.ts

@@ -78,11 +78,17 @@ export async function loadPropertiesFromApi(
       }
     }
 
-    logger.debug("Loaded the following values for the repository properties:");
-    for (const [property, value] of Object.entries(properties).sort(
-      ([nameA], [nameB]) => nameA.localeCompare(nameB),
-    )) {
-      logger.debug(`  ${property}: ${value}`);
+    if (Object.keys(properties).length === 0) {
+      logger.debug("No known repository properties were found.");
+    } else {
+      logger.debug(
+        "Loaded the following values for the repository properties:",
+      );
+      for (const [property, value] of Object.entries(properties).sort(
+        ([nameA], [nameB]) => nameA.localeCompare(nameB),
+      )) {
+        logger.debug(`  ${property}: ${value}`);
+      }
     }
 
     return properties;

src/init-action.ts

@@ -36,8 +36,11 @@ import {
   makeTelemetryDiagnostic,
 } from "./diagnostics";
 import { EnvVar } from "./environment";
-import { Feature, Features } from "./feature-flags";
-import { loadPropertiesFromApi } from "./feature-flags/properties";
+import { Feature, FeatureEnablement, Features } from "./feature-flags";
+import {
+  loadPropertiesFromApi,
+  RepositoryProperties,
+} from "./feature-flags/properties";
 import {
   checkInstallPython311,
   checkPacksForOverlayCompatibility,
@@ -53,7 +56,7 @@ import {
   OverlayBaseDatabaseDownloadStats,
   OverlayDatabaseMode,
 } from "./overlay-database-utils";
-import { getRepositoryNwo } from "./repository";
+import { getRepositoryNwo, RepositoryNwo } from "./repository";
 import { ToolsSource } from "./setup-codeql";
 import {
   ActionName,
@@ -87,6 +90,8 @@ import {
   checkActionVersion,
   getErrorMessage,
   BuildMode,
+  GitHubVersion,
+  Result,
 } from "./util";
 import { checkWorkflow } from "./workflow";
 
@@ -237,12 +242,12 @@ async function run(startedAt: Date) {
     );
 
     // Fetch the values of known repository properties that affect us.
-    const enableRepoProps = await features.getValue(
-      Feature.UseRepositoryProperties,
+    const repositoryProperties = await loadRepositoryProperties(
+      repositoryNwo,
+      gitHubVersion,
+      features,
+      logger,
     );
-    const repositoryProperties = enableRepoProps
-      ? await loadPropertiesFromApi(gitHubVersion, logger, repositoryNwo)
-      : {};
 
     // Create a unique identifier for this run.
     const jobRunUuid = uuidV4();
@@ -363,10 +368,26 @@ async function run(startedAt: Date) {
       githubVersion: gitHubVersion,
       apiDetails,
       features,
-      repositoryProperties,
+      repositoryProperties: repositoryProperties.orElse({}),
       logger,
     });
 
+    if (repositoryProperties.isError()) {
+      addDiagnostic(
+        config,
+        // Arbitrarily choose the first language. We could also choose all languages, but that
+        // increases the risk of misinterpreting the data.
+        config.languages[0],
+        makeTelemetryDiagnostic(
+          "codeql-action/repository-properties-load-failure",
+          "Failed to load repository properties",
+          {
+            error: getErrorMessage(repositoryProperties.value),
+          },
+        ),
+      );
+    }
+
     await checkInstallPython311(config.languages, codeql);
   } catch (unwrappedError) {
     const error = wrapError(unwrappedError);
@@ -775,6 +796,41 @@ async function run(startedAt: Date) {
   );
 }
 
+async function loadRepositoryProperties(
+  repositoryNwo: RepositoryNwo,
+  gitHubVersion: GitHubVersion,
+  features: FeatureEnablement,
+  logger: Logger,
+): Promise<Result<RepositoryProperties, unknown>> {
+  const repositoryOwnerType = getOptionalInput("repository-owner-type");
+  if (repositoryOwnerType === "User") {
+    // Users cannot have repository properties, so skip the API call.
+    logger.debug(
+      "Skipping loading repository properties because the repository is owned by a user and " +
+        "therefore cannot have repository properties.",
+    );
+    return Result.ok({});
+  }
+
+  if (!(await features.getValue(Feature.UseRepositoryProperties))) {
+    logger.debug(
+      "Skipping loading repository properties because the UseRepositoryProperties feature flag is disabled.",
+    );
+    return Result.ok({});
+  }
+
+  try {
+    return Result.ok(
+      await loadPropertiesFromApi(gitHubVersion, logger, repositoryNwo),
+    );
+  } catch (error) {
+    logger.warning(
+      `Failed to load repository properties: ${getErrorMessage(error)}`,
+    );
+    return Result.error(error);
+  }
+}
+
 function getTrapCachingEnabled(): boolean {
   // If the workflow specified something always respect that
   const trapCaching = getOptionalInput("trap-caching");

src/util.ts

@@ -1292,3 +1292,33 @@ export function joinAtMost(
 
   return array.join(separator);
 }
+
+type Success<T> = Result<T, never>;
+type Failure<E> = Result<never, E>;
+
+export class Result<T, E> {
+  private constructor(
+    private readonly _ok: boolean,
+    public readonly value: T | E,
+  ) {}
+
+  static ok<T>(value: T): Success<T> {
+    return new Result(true, value) as Success<T>;
+  }
+
+  static error<E>(error: E): Failure<E> {
+    return new Result(false, error) as Failure<E>;
+  }
+
+  isOk(): this is Success<T> {
+    return this._ok;
+  }
+
+  isError(): this is Failure<E> {
+    return !this._ok;
+  }
+
+  orElse(defaultValue: T): T {
+    return this._ok ? (this.value as T) : defaultValue;
+  }
+}