Gently soft-fail when the Dockerfile isn't found

filiptronicek · filiptronicek · commit fbcde244faf8 · 2024-11-07T08:51:57.000Z
diff --git a/components/server/src/azure-devops/azure-file-provider.ts b/components/server/src/azure-devops/azure-file-provider.ts
@@ -6,7 +6,7 @@
 
 import { injectable, inject } from "inversify";
 
-import { FileProvider, MaybeContent } from "../repohost/file-provider";
+import { FileProvider, MaybeContent, RevisionNotFoundError } from "../repohost/file-provider";
 import { Commit, User, Repository } from "@gitpod/gitpod-protocol";
 import { AzureDevOpsApi } from "./azure-api";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
@@ -34,7 +34,7 @@ export class AzureDevOpsFileProvider implements FileProvider {
     ): Promise<string> {
         const [azOrgId, azProject] = getOrgAndProject(repository.owner);
         const repoName = repository.name;
-        const notFoundError = new Error(
+        const notFoundError = new RevisionNotFoundError(
             `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
         );
         const fileExists =
diff --git a/components/server/src/bitbucket-server/bitbucket-server-file-provider.ts b/components/server/src/bitbucket-server/bitbucket-server-file-provider.ts
@@ -6,7 +6,7 @@
 
 import { Commit, Repository, User } from "@gitpod/gitpod-protocol";
 import { inject, injectable } from "inversify";
-import { FileProvider, MaybeContent } from "../repohost/file-provider";
+import { FileProvider, MaybeContent, RevisionNotFoundError } from "../repohost/file-provider";
 import { BitbucketServerApi } from "./bitbucket-server-api";
 
 @injectable()
@@ -27,7 +27,7 @@ export class BitbucketServerFileProvider implements FileProvider {
         if (!repoKind) {
             throw new Error("Repo kind is missing.");
         }
-        const notFoundError = new Error(
+        const notFoundError = new RevisionNotFoundError(
             `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
         );
 
diff --git a/components/server/src/bitbucket/bitbucket-file-provider.ts b/components/server/src/bitbucket/bitbucket-file-provider.ts
@@ -7,7 +7,7 @@
 import { Commit, Repository, User } from "@gitpod/gitpod-protocol";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
 import { inject, injectable } from "inversify";
-import { FileProvider, MaybeContent } from "../repohost/file-provider";
+import { FileProvider, MaybeContent, RevisionNotFoundError } from "../repohost/file-provider";
 import { BitbucketApiFactory } from "./bitbucket-api-factory";
 
 @injectable()
@@ -48,7 +48,9 @@ export class BitbucketFileProvider implements FileProvider {
             return lastCommit;
         } catch (err) {
             if (err.status && err.status === 404) {
-                throw new Error(`File ${path} does not exist in repository ${repository.owner}/${repository.name}`);
+                throw new RevisionNotFoundError(
+                    `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
+                );
             }
 
             log.error({ userId: user.id }, err);
diff --git a/components/server/src/github/file-provider.ts b/components/server/src/github/file-provider.ts
@@ -6,7 +6,7 @@
 
 import { injectable, inject } from "inversify";
 
-import { FileProvider, MaybeContent } from "../repohost/file-provider";
+import { FileProvider, MaybeContent, RevisionNotFoundError } from "../repohost/file-provider";
 import { Commit, User, Repository } from "@gitpod/gitpod-protocol";
 import { GitHubRestApi } from "./api";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
@@ -29,14 +29,14 @@ export class GithubFileProvider implements FileProvider {
         user: User,
         path: string,
     ): Promise<string> {
-        const notFoundError = new Error(
+        const notFoundError = new RevisionNotFoundError(
             `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
         );
-        // const fileExists =
-        //     (await this.getFileContent({ repository, revision: revisionOrBranch }, user, path)) !== undefined;
-        // if (!fileExists) {
-        //     throw notFoundError;
-        // }
+        const fileExists =
+            (await this.getFileContent({ repository, revision: revisionOrBranch }, user, path)) !== undefined;
+        if (!fileExists) {
+            throw notFoundError;
+        }
 
         const commits = (
             await this.githubApi.run(user, (gh) =>
diff --git a/components/server/src/gitlab/file-provider.ts b/components/server/src/gitlab/file-provider.ts
@@ -6,7 +6,7 @@
 
 import { injectable, inject } from "inversify";
 
-import { FileProvider, MaybeContent } from "../repohost/file-provider";
+import { FileProvider, MaybeContent, RevisionNotFoundError } from "../repohost/file-provider";
 import { Commit, User, Repository } from "@gitpod/gitpod-protocol";
 import { GitLabApi, GitLab } from "./api";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
@@ -29,7 +29,7 @@ export class GitlabFileProvider implements FileProvider {
         user: User,
         path: string,
     ): Promise<string> {
-        const notFoundError = new Error(
+        const notFoundError = new RevisionNotFoundError(
             `File ${path} does not exist in repository ${repository.owner}/${repository.name}`,
         );
 
diff --git a/components/server/src/repohost/file-provider.ts b/components/server/src/repohost/file-provider.ts
@@ -8,6 +8,13 @@ import { User, Repository, Commit } from "@gitpod/gitpod-protocol";
 
 export type MaybeContent = string | undefined;
 
+export class RevisionNotFoundError extends Error {
+    constructor(message: string) {
+        super(message);
+        this.name = "RevisionNotFoundError";
+    }
+}
+
 export const FileProvider = Symbol("FileProvider");
 export interface FileProvider {
     getGitpodFileContent(commit: Commit, user: User): Promise<MaybeContent>;
diff --git a/components/server/src/workspace/config-provider.ts b/components/server/src/workspace/config-provider.ts
@@ -33,6 +33,7 @@ import { Config } from "../config";
 import { EntitlementService } from "../billing/entitlement-service";
 import { TeamDB } from "@gitpod/gitpod-db/lib";
 import { InvalidGitpodYMLError } from "@gitpod/public-api-common/lib/public-api-errors";
+import { RevisionNotFoundError } from "../repohost";
 
 const POD_PATH_WORKSPACE_BASE = "/workspace";
 
@@ -258,12 +259,14 @@ export class ConfigProvider {
                 throw new Error(`Cannot fetch workspace image source for host: ${host}`);
             }
             const repoHost = hostContext.services;
-            const lastDockerFileSha = await repoHost.fileProvider.getLastChangeRevision(
-                repository,
-                revisionOrTagOrBranch,
-                user,
-                dockerFilePath,
-            );
+            const lastDockerFileSha = await repoHost.fileProvider
+                .getLastChangeRevision(repository, revisionOrTagOrBranch, user, dockerFilePath)
+                .catch((e) => {
+                    if (e instanceof RevisionNotFoundError) {
+                        return "";
+                    }
+                    throw e;
+                });
             return {
                 repository,
                 revision: lastDockerFileSha,
diff --git a/components/server/src/workspace/image-source-provider.ts b/components/server/src/workspace/image-source-provider.ts
@@ -19,6 +19,7 @@ import {
     AdditionalContentContext,
 } from "@gitpod/gitpod-protocol";
 import { createHash } from "crypto";
+import { RevisionNotFoundError } from "../repohost";
 
 @injectable()
 export class ImageSourceProvider {
@@ -43,12 +44,14 @@ export class ImageSourceProvider {
                 if (!hostContext || !hostContext.services) {
                     throw new Error(`Cannot fetch workspace image source for host: ${repository.host}`);
                 }
-                const lastDockerFileSha = await hostContext.services.fileProvider.getLastChangeRevision(
-                    repository,
-                    imgcfg.externalSource.revision,
-                    user,
-                    imgcfg.file,
-                );
+                const lastDockerFileSha = await hostContext.services.fileProvider
+                    .getLastChangeRevision(repository, imgcfg.externalSource.revision, user, imgcfg.file)
+                    .catch((e) => {
+                        if (e instanceof RevisionNotFoundError) {
+                            return "";
+                        }
+                        throw e;
+                    });
                 result = <WorkspaceImageSourceDocker>{
                     dockerFilePath: imgcfg.file,
                     dockerFileSource: imgcfg.externalSource,
@@ -72,12 +75,14 @@ export class ImageSourceProvider {
                 if (!hostContext || !hostContext.services) {
                     throw new Error(`Cannot fetch workspace image source for host: ${context.repository.host}`);
                 }
-                const lastDockerFileSha = await hostContext.services.fileProvider.getLastChangeRevision(
-                    context.repository,
-                    context.revision,
-                    user,
-                    imgcfg.file,
-                );
+                const lastDockerFileSha = await hostContext.services.fileProvider
+                    .getLastChangeRevision(context.repository, context.revision, user, imgcfg.file)
+                    .catch((e) => {
+                        if (e instanceof RevisionNotFoundError) {
+                            return "";
+                        }
+                        throw e;
+                    });
                 result = <WorkspaceImageSourceDocker>{
                     dockerFilePath: imgcfg.file,
                     dockerFileSource: context,
