[server] Refactor checkUser and checkAndBlockUser: Use arguments.callee.name instead of (mis)typing function names

Author: jankeromnes

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

@@ -171,7 +171,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         traceWI(ctx, { workspaceId });
 
         this.requireEELicense(Feature.FeatureSetTimeout);
-        const user = this.checkUser("setWorkspaceTimeout");
+        const user = this.checkUser(arguments.callee.name);
 
         if (!WorkspaceTimeoutValues.includes(duration)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "Invalid duration")
@@ -222,7 +222,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         // Allowed in the free version, because it is read only.
         // this.requireEELicense(Feature.FeatureSetTimeout);
 
-        const user = this.checkUser("getWorkspaceTimeout");
+        const user = this.checkUser(arguments.callee.name);
 
         const canChange = await this.maySetTimeout(user);
 
@@ -307,7 +307,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         traceWI(ctx, { workspaceId });
 
         this.requireEELicense(Feature.FeatureSnapshot);
-        const user = this.checkAndBlockUser("takeSnapshot");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const workspace = await this.guardSnaphotAccess(ctx, user.id, workspaceId);
 
@@ -360,7 +360,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         traceAPIParams(ctx, { snapshotId });
 
         this.requireEELicense(Feature.FeatureSnapshot);
-        const user = this.checkAndBlockUser("waitForSnapshot");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const snapshot = await this.workspaceDb.trace(ctx).findSnapshotById(snapshotId);
         if (!snapshot) {
@@ -386,7 +386,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         // Allowed in the free version, because it is read only.
         // this.requireEELicense(Feature.FeatureSnapshot);
 
-        const user = this.checkAndBlockUser("getSnapshots");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const workspace = await this.workspaceDb.trace(ctx).findById(workspaceId);
         if (!workspace || workspace.ownerId !== user.id) {
@@ -722,7 +722,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
     // TODO(gpl) This is not part of our API interface, nor can I find any clients. Remove or re-surrect?
     // async getLicenseInfo(ctx: TraceContext): Promise<GetLicenseInfoResult> {
-    //     const user = this.checkAndBlockUser("getLicenseInfo");
+    //     const user = this.checkAndBlockUser(arguments.callee.name);
 
     //     const { key } = await this.licenseKeySource.getKey();
     //     const { validUntil, seats } = this.licenseEvaluator.inspect();
@@ -744,7 +744,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async licenseIncludesFeature(ctx: TraceContext, licenseFeature: LicenseFeature): Promise<boolean> {
         traceAPIParams(ctx, { licenseFeature });
 
-        this.checkAndBlockUser("licenseIncludesFeature");
+        this.checkAndBlockUser(arguments.callee.name);
 
         let feature: Feature | undefined;
         switch (licenseFeature) {
@@ -763,13 +763,13 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     public async getAccountStatement(ctx: TraceContext, options: GitpodServer.GetAccountStatementOptions): Promise<AccountStatement> {
         traceAPIParams(ctx, { options });
 
-        const user = this.checkUser("getAccountStatement");
+        const user = this.checkUser(arguments.callee.name);
         const now = options.date || new Date().toISOString();
         return this.accountStatementProvider.getAccountStatement(user.id, now);
     }
 
     public async getRemainingUsageHours(ctx: TraceContext): Promise<number> {
-        const user = this.checkUser("getRemainingUsageHours");
+        const user = this.checkUser(arguments.callee.name);
         const runningInstancesPromise = this.workspaceDb.trace(ctx).findRegularRunningInstances(user.id);
         return this.accountStatementProvider.getRemainingUsageHours(user.id, new Date().toISOString(), runningInstancesPromise);
     }
@@ -798,7 +798,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     }
 
     public async isStudent(ctx: TraceContext): Promise<boolean> {
-        const user = this.checkUser("isStudent");
+        const user = this.checkUser(arguments.callee.name);
         return this.eligibilityService.isStudent(user);
     }
 
@@ -1342,7 +1342,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async adminGetAccountStatement(ctx: TraceContext, userId: string): Promise<AccountStatement> {
         traceAPIParams(ctx, { userId });
 
-        const user = this.checkAndBlockUser("adminGetAccountStatement");
+        const user = this.checkAndBlockUser(arguments.callee.name);
         if (!this.authorizationService.hasPermission(user, Permission.ADMIN_USERS)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "not allowed");
         }
@@ -1353,7 +1353,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async adminSetProfessionalOpenSource(ctx: TraceContext, userId: string, shouldGetProfOSS: boolean): Promise<void> {
         traceAPIParams(ctx, { userId, shouldGetProfOSS });
 
-        const user = this.checkAndBlockUser("adminSetProfessionalOpenSource");
+        const user = this.checkAndBlockUser(arguments.callee.name);
         if (!this.authorizationService.hasPermission(user, Permission.ADMIN_USERS)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "not allowed");
         }
@@ -1368,7 +1368,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async adminIsStudent(ctx: TraceContext, userId: string): Promise<boolean> {
         traceAPIParams(ctx, { userId });
 
-        const user = this.checkAndBlockUser("adminIsStudent");
+        const user = this.checkAndBlockUser(arguments.callee.name);
         if (!this.authorizationService.hasPermission(user, Permission.ADMIN_USERS)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "not allowed");
         }
@@ -1379,7 +1379,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async adminAddStudentEmailDomain(ctx: TraceContext, userId: string, domain: string): Promise<void> {
         traceAPIParams(ctx, { userId, domain });
 
-        const user = this.checkAndBlockUser("adminAddStudentEmailDomain");
+        const user = this.checkAndBlockUser(arguments.callee.name);
         if (!this.authorizationService.hasPermission(user, Permission.ADMIN_USERS)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "not allowed");
         }
@@ -1393,7 +1393,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async adminGrantExtraHours(ctx: TraceContext, userId: string, extraHours: number): Promise<void> {
         traceAPIParams(ctx, { userId, extraHours });
 
-        const user = this.checkAndBlockUser("adminGrantExtraHours");
+        const user = this.checkAndBlockUser(arguments.callee.name);
         if (!this.authorizationService.hasPermission(user, Permission.ADMIN_USERS)) {
             throw new ResponseError(ErrorCodes.PERMISSION_DENIED, "not allowed");
         }
@@ -1405,7 +1405,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async sendFeedback(ctx: TraceContext, feedback: string): Promise<string | undefined> {
         traceAPIParams(ctx, { });   // feedback is not interesting here, any may contain names
 
-        const user = this.checkUser("sendFeedback");
+        const user = this.checkUser(arguments.callee.name);
         const now = new Date().toISOString();
         const remainingUsageHours = await this.getRemainingUsageHours(ctx);
         const stillEnoughCredits = remainingUsageHours > Math.max(...Accounting.LOW_CREDIT_WARNINGS_IN_HOURS);
@@ -1421,7 +1421,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async getProviderRepositoriesForUser(ctx: TraceContext, params: { provider: string, hints?: object }): Promise<ProviderRepository[]> {
         traceAPIParams(ctx, { params });
 
-        const user = this.checkAndBlockUser("getProviderRepositoriesForUser");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const repositories: ProviderRepository[] = [];
         const providerHost = params.provider;
@@ -1445,7 +1445,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async triggerPrebuild(ctx: TraceContext, projectId: string, branchName: string | null): Promise<StartPrebuildResult> {
         traceAPIParams(ctx, { projectId, branchName });
 
-        const user = this.checkAndBlockUser("triggerPrebuild");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const project = await this.projectsService.getProject(projectId);
         if (!project) {
@@ -1491,7 +1491,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     async cancelPrebuild(ctx: TraceContext, projectId: string, prebuildId: string): Promise<void> {
         traceAPIParams(ctx, { projectId, prebuildId });
 
-        const user = this.checkAndBlockUser("cancelPrebuild");
+        const user = this.checkAndBlockUser(arguments.callee.name);
 
         const project = await this.projectsService.getProject(projectId);
         if (!project) {