Rename old EnvVarService to EnvVarResolver

Author: jeanp413

components/server/src/container-module.ts

@@ -104,7 +104,7 @@ import { WebsocketConnectionManager } from "./websocket/websocket-connection-man
 import { ConfigProvider } from "./workspace/config-provider";
 import { IContextParser, IPrefixContextParser } from "./workspace/context-parser";
 import { ContextParser } from "./workspace/context-parser-service";
-import { EnvVarService } from "./workspace/env-var-service";
+import { EnvVarResolver } from "./workspace/env-var-resolver";
 import { EnvvarPrefixParser } from "./workspace/envvar-prefix-context-parser";
 import { GitTokenScopeGuesser } from "./workspace/git-token-scope-guesser";
 import { GitTokenValidator } from "./workspace/git-token-validator";
@@ -255,7 +255,7 @@ export const productionContainerModule = new ContainerModule(
 
         bind(OrganizationService).toSelf().inSingletonScope();
         bind(ProjectsService).toSelf().inSingletonScope();
-        bind(EnvVarService).toSelf().inSingletonScope();
+        bind(EnvVarResolver).toSelf().inSingletonScope();
 
         bind(NewsletterSubscriptionController).toSelf().inSingletonScope();
 

components/server/src/prebuilds/prebuild-manager.ts

@@ -36,7 +36,7 @@ import { PrebuildRateLimiterConfig } from "../workspace/prebuild-rate-limiter";
 import { ErrorCodes, ApplicationError } from "@gitpod/gitpod-protocol/lib/messaging/error";
 import { UserAuthentication } from "../user/user-authentication";
 import { EntitlementService, MayStartWorkspaceResult } from "../billing/entitlement-service";
-import { EnvVarService } from "../workspace/env-var-service";
+import { EnvVarResolver } from "../workspace/env-var-resolver";
 import { WorkspaceService } from "../workspace/workspace-service";
 
 export class WorkspaceRunningError extends Error {
@@ -66,7 +66,7 @@ export class PrebuildManager {
     @inject(UserAuthentication) protected readonly userService: UserAuthentication;
     @inject(TeamDB) protected readonly teamDB: TeamDB;
     @inject(EntitlementService) protected readonly entitlementService: EntitlementService;
-    @inject(EnvVarService) private readonly envVarService: EnvVarService;
+    @inject(EnvVarResolver) private readonly envVarResolver: EnvVarResolver;
 
     async abortPrebuildsForBranch(ctx: TraceContext, project: Project, user: User, branch: string): Promise<void> {
         const span = TraceContext.startSpan("abortPrebuildsForBranch", ctx);
@@ -230,7 +230,7 @@ export class PrebuildManager {
                 context.normalizedContextURL!,
             );
 
-            const envVarsPromise = this.envVarService.resolve(workspace);
+            const envVarsPromise = this.envVarResolver.resolve(workspace);
 
             const prebuild = await this.workspaceDB.trace({ span }).findPrebuildByWorkspaceID(workspace.id)!;
             if (!prebuild) {
@@ -334,7 +334,7 @@ export class PrebuildManager {
             if (!prebuild) {
                 throw new Error("No prebuild found for workspace " + workspaceId);
             }
-            const envVars = await this.envVarService.resolve(workspace);
+            const envVars = await this.envVarResolver.resolve(workspace);
             await this.workspaceStarter.startWorkspace({ span }, workspace, user, project, envVars);
             return { prebuildId: prebuild.id, wsid: workspace.id, done: false };
         } catch (err) {

components/server/src/workspace/env-var-service.spec.ts renamed to components/server/src/workspace/env-var-resolver.spec.ts

@@ -8,7 +8,7 @@ import "reflect-metadata";
 
 import { suite, test } from "@testdeck/mocha";
 import * as chai from "chai";
-import { EnvVarService } from "./env-var-service";
+import { EnvVarResolver } from "./env-var-resolver";
 import {
     CommitContext,
     EnvVarWithValue,
@@ -79,22 +79,22 @@ const contextEnvVars = {
 } as WithEnvvarsContext;
 
 @suite
-class TestEnvVarService {
-    protected envVarService: EnvVarService;
+class TestEnvVarResolver {
+    protected envVarResolver: EnvVarResolver;
 
     protected init(userEnvVars: UserEnvVar[], projectEnvVar: ProjectEnvVarWithValue[]) {
-        this.envVarService = new EnvVarService();
-        this.envVarService["userDB"] = {
+        this.envVarResolver = new EnvVarResolver();
+        this.envVarResolver["userDB"] = {
             getEnvVars: (_) => {
                 return Promise.resolve(userEnvVars);
             },
         } as UserDB;
-        this.envVarService["projectsService"] = {
+        this.envVarResolver["projectsService"] = {
             getProjectEnvironmentVariables: (userId: string, projectId: string) => {
                 return Promise.resolve(projectEnvVar as ProjectEnvVar[]);
             },
         } as ProjectsService;
-        this.envVarService["projectDB"] = {
+        this.envVarResolver["projectDB"] = {
             getProjectEnvironmentVariableValues: (envs) => {
                 return Promise.resolve(envs as ProjectEnvVarWithValue[]);
             },
@@ -111,7 +111,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             ownerId: "1",
             type: "regular",
             context: commitContext,
@@ -128,7 +128,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             ownerId: "1",
             type: "prebuild",
             context: commitContext,
@@ -145,7 +145,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             ownerId: "1",
             type: "regular",
             context: commitContext,
@@ -163,7 +163,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             type: "prebuild",
             context: commitContext,
             projectId: "1",
@@ -188,7 +188,7 @@ class TestEnvVarService {
 
         this.init(userEnvVars, []);
 
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             ownerId: "1",
             type: "regular",
             context: commitContext,
@@ -206,7 +206,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             owerId: "1",
             type: "regular",
             context: { ...commitContext, ...contextEnvVars },
@@ -223,7 +223,7 @@ class TestEnvVarService {
             [fooAnyUserEnvVar, barUserCommitEnvVar, barUserAnotherCommitEnvVar],
             [barProjectCensoredEnvVar, bazProjectEnvVar],
         );
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             owerId: "1",
             type: "regular",
             context: { ...commitContext, ...contextEnvVars },
@@ -274,7 +274,7 @@ class TestEnvVarService {
             const expectedVars = [inputVars[0]];
 
             this.init(inputVars, []);
-            const envVars = await this.envVarService.resolve({
+            const envVars = await this.envVarResolver.resolve({
                 owerId: "1",
                 type: "regular",
                 context: { ...commitContext },
@@ -352,7 +352,7 @@ class TestEnvVarService {
 
         this.init(userEnvVars, []);
 
-        const envVars = await this.envVarService.resolve({
+        const envVars = await this.envVarResolver.resolve({
             owerId: "1",
             type: "regular",
             context: { ...gitlabSubgroupCommitContext },
@@ -365,4 +365,4 @@ class TestEnvVarService {
     }
 }
 
-module.exports = new TestEnvVarService();
+module.exports = new TestEnvVarResolver();

components/server/src/workspace/env-var-service.ts renamed to components/server/src/workspace/env-var-resolver.ts

@@ -25,7 +25,7 @@ export interface ResolvedEnvVars {
 }
 
 @injectable()
-export class EnvVarService {
+export class EnvVarResolver {
     @inject(UserDB)
     private userDB: UserDB;
 

components/server/src/workspace/gitpod-server-impl.ts

@@ -169,7 +169,7 @@ import {
 import { increaseDashboardErrorBoundaryCounter, reportCentralizedPermsValidation } from "../prometheus-metrics";
 import { RegionService } from "./region-service";
 import { isWorkspaceRegion, WorkspaceRegion } from "@gitpod/gitpod-protocol/lib/workspace-cluster";
-import { EnvVarService } from "./env-var-service";
+import { EnvVarResolver } from "./env-var-resolver";
 import { LinkedInService } from "../linkedin-service";
 import { SnapshotService, WaitForSnapshotOptions } from "./snapshot-service";
 import { IncrementalPrebuildsService } from "../prebuilds/incremental-prebuilds-service";
@@ -268,7 +268,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         @inject(BillingServiceDefinition.name) private readonly billingService: BillingServiceClient,
         @inject(EmailDomainFilterDB) private emailDomainFilterdb: EmailDomainFilterDB,
 
-        @inject(EnvVarService) private readonly envVarService: EnvVarService,
+        @inject(EnvVarResolver) private readonly envVarResolver: EnvVarResolver,
         @inject(RedisSubscriber) private readonly subscriber: RedisSubscriber,
         @inject(RedisPublisher) private readonly publisher: RedisPublisher,
         @inject(TracedWorkspaceDB) private readonly workspaceDB: DBWithTracing<WorkspaceDB>,
@@ -949,7 +949,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         if (workspace.deleted) {
             throw new ApplicationError(ErrorCodes.PERMISSION_DENIED, "Cannot (re-)start a deleted workspace.");
         }
-        const envVarsPromise = this.envVarService.resolve(workspace);
+        const envVarsPromise = this.envVarResolver.resolve(workspace);
         const projectPromise = workspace.projectId
             ? ApplicationError.notFoundToUndefined(this.projectsService.getProject(user.id, workspace.projectId))
             : Promise.resolve(undefined);
@@ -1439,7 +1439,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
                 throw err;
             }
 
-            const envVarsPromise = this.envVarService.resolve(workspace);
+            const envVarsPromise = this.envVarResolver.resolve(workspace);
             options.region = await this.determineWorkspaceRegion(workspace, options.region || "");
 
             logContext.workspaceId = workspace.id;
@@ -2326,7 +2326,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         const user = await this.checkUser("getWorkspaceEnvVars");
         const workspace = await this.workspaceService.getWorkspace(user.id, workspaceId);
         await this.guardAccess({ kind: "workspace", subject: workspace }, "get");
-        const envVars = await this.envVarService.resolve(workspace);
+        const envVars = await this.envVarResolver.resolve(workspace);
 
         const result: EnvVarWithValue[] = [];
         for (const value of envVars.workspace) {

components/server/src/workspace/workspace-starter.ts

@@ -123,7 +123,7 @@ import { RedisMutex } from "../redis/mutex";
 import { AuthorizationService } from "../user/authorization-service";
 import { TokenProvider } from "../user/token-provider";
 import { UserAuthentication } from "../user/user-authentication";
-import { ResolvedEnvVars } from "./env-var-service";
+import { ResolvedEnvVars } from "./env-var-resolver";
 import { ImageSourceProvider } from "./image-source-provider";
 import { WorkspaceClassesConfig } from "./workspace-classes";