Skip to content

[server] Move some admin rpcs to non EE #17341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 24, 2023
Merged

[server] Move some admin rpcs to non EE #17341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d9c3561
[server] Move snapshot service out of EE
easyCZ Apr 24, 2023
7e55def
Fix
easyCZ Apr 24, 2023
84fdedd
retest
easyCZ Apr 24, 2023
3eb4df7
[server] Move some admin rpcs to non EE
easyCZ Apr 24, 2023
95317e9
fix
easyCZ Apr 24, 2023
e2c4e0d
Fix
easyCZ Apr 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
340 changes: 1 addition & 339 deletions components/server/ee/src/workspace/gitpod-server-impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,13 @@
*/

import { injectable, inject } from "inversify";
import { GitpodServerImpl, traceAPIParams, traceWI, censor } from "../../../src/workspace/gitpod-server-impl";
import { GitpodServerImpl, traceAPIParams, traceWI } from "../../../src/workspace/gitpod-server-impl";
import { TraceContext, TraceContextWithSpan } from "@gitpod/gitpod-protocol/lib/util/tracing";
import {
GitpodClient,
AdminGetListRequest,
User,
Team,
TeamMemberInfo,
AdminGetListResult,
Permission,
AdminBlockUserRequest,
AdminModifyRoleOrPermissionRequest,
RoleOrPermission,
AdminModifyPermanentWorkspaceFeatureFlagRequest,
UserFeatureSettings,
AdminGetWorkspacesRequest,
WorkspaceAndInstance,
GetWorkspaceTimeoutResult,
WorkspaceTimeoutDuration,
SetWorkspaceTimeoutResult,
Expand All @@ -38,7 +28,6 @@ import {
StartPrebuildResult,
ClientHeaderFields,
FindPrebuildsParams,
TeamMemberRole,
WORKSPACE_TIMEOUT_DEFAULT_SHORT,
PrebuildEvent,
OpenPrebuildContext,
Expand All @@ -47,7 +36,6 @@ import { ResponseError } from "vscode-jsonrpc";
import {
AdmissionLevel,
ControlAdmissionRequest,
StopWorkspacePolicy,
DescribeWorkspaceRequest,
SetTimeoutRequest,
} from "@gitpod/ws-manager/lib";
Expand All @@ -56,7 +44,6 @@ import { log, LogContext } from "@gitpod/gitpod-protocol/lib/util/logging";
import { LicenseValidationResult } from "@gitpod/gitpod-protocol/lib/license-protocol";
import { PrebuildManager } from "../prebuilds/prebuild-manager";
import { GuardedCostCenter, ResourceAccessGuard, ResourceAccessOp } from "../../../src/auth/resource-access";
import { BlockedRepository } from "@gitpod/gitpod-protocol/lib/blocked-repositories-protocol";
import { CostCenterJSON, ListUsageRequest, ListUsageResponse } from "@gitpod/gitpod-protocol/lib/usage";
import {
CostCenter,
Expand Down Expand Up @@ -367,331 +354,6 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
});
}

async adminGetUsers(ctx: TraceContext, req: AdminGetListRequest<User>): Promise<AdminGetListResult<User>> {
traceAPIParams(ctx, { req: censor(req, "searchTerm") }); // searchTerm may contain PII

await this.guardAdminAccess("adminGetUsers", { req }, Permission.ADMIN_USERS);

try {
const res = await this.userDB.findAllUsers(
req.offset,
req.limit,
req.orderBy,
req.orderDir === "asc" ? "ASC" : "DESC",
req.searchTerm,
);
res.rows = res.rows.map(this.censorUser);
return res;
} catch (e) {
throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, e.toString());
}
}

async adminGetUser(ctx: TraceContext, userId: string): Promise<User> {
traceAPIParams(ctx, { userId });

await this.guardAdminAccess("adminGetUser", { id: userId }, Permission.ADMIN_USERS);

let result: User | undefined;
try {
result = await this.userDB.findUserById(userId);
} catch (e) {
throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, e.toString());
}

if (!result) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "not found");
}
return this.censorUser(result);
}

async adminBlockUser(ctx: TraceContext, req: AdminBlockUserRequest): Promise<User> {
traceAPIParams(ctx, { req });

await this.guardAdminAccess("adminBlockUser", { req }, Permission.ADMIN_USERS);

const targetUser = await this.userService.blockUser(req.id, req.blocked);

const stoppedWorkspaces = await this.workspaceStarter.stopRunningWorkspacesForUser(
ctx,
req.id,
"user blocked by admin",
StopWorkspacePolicy.IMMEDIATELY,
);

log.info(`Stopped ${stoppedWorkspaces.length} workspaces in response to admin initiated block.`, {
userId: targetUser.id,
workspaceIds: stoppedWorkspaces.map((w) => w.id),
});

// For some reason, returning the result of `this.userDB.storeUser(target)` does not work. The response never arrives the caller.
// Returning `target` instead (which should be equivalent).
return this.censorUser(targetUser);
}

async adminVerifyUser(ctx: TraceContext, userId: string): Promise<User> {
await this.guardAdminAccess("adminVerifyUser", { id: userId }, Permission.ADMIN_USERS);
try {
const user = await this.userDB.findUserById(userId);
if (!user) {
throw new ResponseError(ErrorCodes.NOT_FOUND, `No user with id ${userId} found.`);
}
this.verificationService.markVerified(user);
await this.userDB.updateUserPartial(user);
return user;
} catch (e) {
throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, e.toString());
}
}

async adminDeleteUser(ctx: TraceContext, userId: string): Promise<void> {
traceAPIParams(ctx, { userId });

await this.guardAdminAccess("adminDeleteUser", { id: userId }, Permission.ADMIN_USERS);

try {
await this.userDeletionService.deleteUser(userId);
} catch (e) {
throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, e.toString());
}
}

async adminGetBlockedRepositories(
ctx: TraceContext,
req: AdminGetListRequest<BlockedRepository>,
): Promise<AdminGetListResult<BlockedRepository>> {
traceAPIParams(ctx, { req: censor(req, "searchTerm") }); // searchTerm may contain PII

await this.guardAdminAccess("adminGetBlockedRepositories", { req }, Permission.ADMIN_USERS);

try {
const res = await this.blockedRepostoryDB.findAllBlockedRepositories(
req.offset,
req.limit,
req.orderBy,
req.orderDir === "asc" ? "ASC" : "DESC",
req.searchTerm,
);
return res;
} catch (e) {
throw new ResponseError(ErrorCodes.INTERNAL_SERVER_ERROR, e.toString());
}
}

async adminCreateBlockedRepository(
ctx: TraceContext,
urlRegexp: string,
blockUser: boolean,
): Promise<BlockedRepository> {
traceAPIParams(ctx, { urlRegexp, blockUser });

await this.guardAdminAccess("adminCreateBlockedRepository", { urlRegexp, blockUser }, Permission.ADMIN_USERS);

return await this.blockedRepostoryDB.createBlockedRepository(urlRegexp, blockUser);
}

async adminDeleteBlockedRepository(ctx: TraceContext, id: number): Promise<void> {
traceAPIParams(ctx, { id });

await this.guardAdminAccess("adminDeleteBlockedRepository", { id }, Permission.ADMIN_USERS);

await this.blockedRepostoryDB.deleteBlockedRepository(id);
}

async adminModifyRoleOrPermission(ctx: TraceContext, req: AdminModifyRoleOrPermissionRequest): Promise<User> {
traceAPIParams(ctx, { req });

await this.guardAdminAccess("adminModifyRoleOrPermission", { req }, Permission.ADMIN_USERS);

const target = await this.userDB.findUserById(req.id);
if (!target) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "not found");
}

const rolesOrPermissions = new Set((target.rolesOrPermissions || []) as string[]);
req.rpp.forEach((e) => {
if (e.add) {
rolesOrPermissions.add(e.r as string);
} else {
rolesOrPermissions.delete(e.r as string);
}
});
target.rolesOrPermissions = Array.from(rolesOrPermissions.values()) as RoleOrPermission[];

await this.userDB.storeUser(target);
// For some reason, neither returning the result of `this.userDB.storeUser(target)` nor returning `target` work.
// The response never arrives the caller.
// Returning the following works at the cost of an additional DB query:
return this.censorUser((await this.userDB.findUserById(req.id))!);
}

async adminModifyPermanentWorkspaceFeatureFlag(
ctx: TraceContext,
req: AdminModifyPermanentWorkspaceFeatureFlagRequest,
): Promise<User> {
traceAPIParams(ctx, { req });

await this.guardAdminAccess("adminModifyPermanentWorkspaceFeatureFlag", { req }, Permission.ADMIN_USERS);
const target = await this.userDB.findUserById(req.id);
if (!target) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "not found");
}

const featureSettings: UserFeatureSettings = target.featureFlags || {};
const featureFlags = new Set(featureSettings.permanentWSFeatureFlags || []);

req.changes.forEach((e) => {
if (e.add) {
featureFlags.add(e.featureFlag);
} else {
featureFlags.delete(e.featureFlag);
}
});
featureSettings.permanentWSFeatureFlags = Array.from(featureFlags);
target.featureFlags = featureSettings;

await this.userDB.storeUser(target);
// For some reason, returning the result of `this.userDB.storeUser(target)` does not work. The response never arrives the caller.
// Returning `target` instead (which should be equivalent).
return this.censorUser(target);
}

async adminGetTeamMembers(ctx: TraceContext, teamId: string): Promise<TeamMemberInfo[]> {
await this.guardAdminAccess("adminGetTeamMembers", { teamId }, Permission.ADMIN_WORKSPACES);

const team = await this.teamDB.findTeamById(teamId);
if (!team) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "Team not found");
}
const members = await this.teamDB.findMembersByTeam(team.id);
return members;
}

async adminGetTeams(ctx: TraceContext, req: AdminGetListRequest<Team>): Promise<AdminGetListResult<Team>> {
await this.guardAdminAccess("adminGetTeams", { req }, Permission.ADMIN_WORKSPACES);

return await this.teamDB.findTeams(
req.offset,
req.limit,
req.orderBy,
req.orderDir === "asc" ? "ASC" : "DESC",
req.searchTerm as string,
);
}

async adminGetTeamById(ctx: TraceContext, id: string): Promise<Team | undefined> {
await this.guardAdminAccess("adminGetTeamById", { id }, Permission.ADMIN_WORKSPACES);
return await this.teamDB.findTeamById(id);
}

async adminSetTeamMemberRole(
ctx: TraceContext,
teamId: string,
userId: string,
role: TeamMemberRole,
): Promise<void> {
await this.guardAdminAccess("adminSetTeamMemberRole", { teamId, userId, role }, Permission.ADMIN_WORKSPACES);
return this.teamDB.setTeamMemberRole(userId, teamId, role);
}

async adminGetWorkspaces(
ctx: TraceContext,
req: AdminGetWorkspacesRequest,
): Promise<AdminGetListResult<WorkspaceAndInstance>> {
traceAPIParams(ctx, { req });

await this.guardAdminAccess("adminGetWorkspaces", { req }, Permission.ADMIN_WORKSPACES);

return await this.workspaceDb
.trace(ctx)
.findAllWorkspaceAndInstances(
req.offset,
req.limit,
req.orderBy,
req.orderDir === "asc" ? "ASC" : "DESC",
req,
);
}

async adminGetWorkspace(ctx: TraceContext, workspaceId: string): Promise<WorkspaceAndInstance> {
traceAPIParams(ctx, { workspaceId });

await this.guardAdminAccess("adminGetWorkspace", { id: workspaceId }, Permission.ADMIN_WORKSPACES);

const result = await this.workspaceDb.trace(ctx).findWorkspaceAndInstance(workspaceId);
if (!result) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "not found");
}
return result;
}

async adminGetWorkspaceInstances(ctx: TraceContext, workspaceId: string): Promise<WorkspaceInstance[]> {
traceAPIParams(ctx, { workspaceId });

await this.guardAdminAccess("adminGetWorkspaceInstances", { id: workspaceId }, Permission.ADMIN_WORKSPACES);

const result = await this.workspaceDb.trace(ctx).findInstances(workspaceId);
return result || [];
}

async adminForceStopWorkspace(ctx: TraceContext, workspaceId: string): Promise<void> {
traceAPIParams(ctx, { workspaceId });

await this.guardAdminAccess("adminForceStopWorkspace", { id: workspaceId }, Permission.ADMIN_WORKSPACES);

const workspace = await this.workspaceDb.trace(ctx).findById(workspaceId);
if (workspace) {
await this.internalStopWorkspace(ctx, workspace, "stopped by admin", StopWorkspacePolicy.IMMEDIATELY, true);
}
}

async adminRestoreSoftDeletedWorkspace(ctx: TraceContext, workspaceId: string): Promise<void> {
traceAPIParams(ctx, { workspaceId });

await this.guardAdminAccess(
"adminRestoreSoftDeletedWorkspace",
{ id: workspaceId },
Permission.ADMIN_WORKSPACES,
);

await this.workspaceDb.trace(ctx).transaction(async (db) => {
const ws = await db.findById(workspaceId);
if (!ws) {
throw new ResponseError(ErrorCodes.NOT_FOUND, `No workspace with id '${workspaceId}' found.`);
}
if (!ws.softDeleted) {
return;
}
if (!!ws.contentDeletedTime) {
throw new ResponseError(ErrorCodes.NOT_FOUND, "The workspace content was already garbage-collected.");
}
// @ts-ignore
ws.softDeleted = null;
ws.softDeletedTime = "";
ws.pinned = true;
await db.store(ws);
});
}

async adminGetProjectsBySearchTerm(
ctx: TraceContext,
req: AdminGetListRequest<Project>,
): Promise<AdminGetListResult<Project>> {
await this.guardAdminAccess("adminGetProjectsBySearchTerm", { req }, Permission.ADMIN_PROJECTS);
return await this.projectDB.findProjectsBySearchTerm(
req.offset,
req.limit,
req.orderBy,
req.orderDir === "asc" ? "ASC" : "DESC",
req.searchTerm as string,
);
}

async adminGetProjectById(ctx: TraceContext, id: string): Promise<Project | undefined> {
await this.guardAdminAccess("adminGetProjectById", { id }, Permission.ADMIN_PROJECTS);
return await this.projectDB.findProjectById(id);
}

protected async findPrebuiltWorkspace(
parentCtx: TraceContext,
user: User,
Expand Down
Loading