Skip to content

[server, dashboard] Do basic rate limiting on startWorkspace #8073

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 1 commit into from
Feb 7, 2022
Merged

[server, dashboard] Do basic rate limiting on startWorkspace #8073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 31 additions & 2 deletions components/dashboard/src/start/StartWorkspace.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* See License-AGPL.txt in the project root for license information.
*/

import { ContextURL, DisposableCollection, WithPrebuild, Workspace, WorkspaceImageBuild, WorkspaceInstance } from "@gitpod/gitpod-protocol";
import { ContextURL, DisposableCollection, GitpodServer, RateLimiterError, StartWorkspaceResult, WithPrebuild, Workspace, WorkspaceImageBuild, WorkspaceInstance } from "@gitpod/gitpod-protocol";
import { IDEOptions } from "@gitpod/gitpod-protocol/lib/ide-protocol";
import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
import EventEmitter from "events";
Expand Down Expand Up @@ -124,7 +124,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,

const { workspaceId } = this.props;
try {
const result = await getGitpodService().server.startWorkspace(workspaceId, { forceDefaultImage });
const result = await this.startWorkspaceRateLimited(workspaceId, { forceDefaultImage });
if (!result) {
throw new Error("No result!");
}
Expand All @@ -151,6 +151,35 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
}
}

/**
* TODO(gpl) Ideally this can be pushed into the GitpodService implementation. But to get started we hand-roll it here.
* @param workspaceId
* @param options
* @returns
*/
protected async startWorkspaceRateLimited(workspaceId: string, options: GitpodServer.StartWorkspaceOptions): Promise<StartWorkspaceResult> {
let retries = 0;
while (true) {
try {
return await getGitpodService().server.startWorkspace(workspaceId, options);
} catch (err) {
if (err?.code !== ErrorCodes.TOO_MANY_REQUESTS) {
throw err;
}

if (retries >= 10) {
throw err;
}
retries++;

const data = err?.data as RateLimiterError | undefined;
const timeoutSeconds = data?.retryAfter || 5;
console.log(`startWorkspace was rate-limited: waiting for ${timeoutSeconds}s before doing ${retries}nd retry...`)
await new Promise(resolve => setTimeout(resolve, timeoutSeconds * 1000));
}
}
}

async fetchWorkspaceInfo() {
const { workspaceId } = this.props;
try {
Expand Down
10 changes: 10 additions & 0 deletions components/gitpod-protocol/src/gitpod-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,16 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
identifyUser(event: RemoteIdentifyMessage): Promise<void>;
}

export interface RateLimiterError {
method?: string,

/**
* Retry after this many seconds, earliest.
* cmp.: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
*/
retryAfter: number,
}

export interface CreateProjectParams {
name: string;
slug?: string;
Expand Down
62 changes: 0 additions & 62 deletions components/gitpod-protocol/src/messaging/connection-error-handler.ts
View file
Open in desktop

This file was deleted.

11 changes: 8 additions & 3 deletions components/server/src/auth/rate-limiter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { RateLimiterMemory, RateLimiterRes } from "rate-limiter-flexible";
export const accessCodeSyncStorage = 'accessCodeSyncStorage';
export const accessHeadlessLogs = 'accessHeadlessLogs';
type GitpodServerMethodType = keyof Omit<GitpodServer, "dispose" | "setClient"> | typeof accessCodeSyncStorage | typeof accessHeadlessLogs;
type GroupKey = "default" | "startWorkspace";
type GroupsConfig = {
[key: string]: {
points: number,
Expand All @@ -20,7 +21,7 @@ type GroupsConfig = {
}
type FunctionsConfig = {
[K in GitpodServerMethodType]: {
group: string,
group: GroupKey,
points: number,
}
}
Expand All @@ -34,7 +35,11 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
default: {
points: 60000, // 1,000 calls per user per second
durationsSec: 60,
}
},
startWorkspace: {
points: 1, // 1 workspace start per user per 10s
durationsSec: 10
},
Comment on lines +39 to +42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

}
const defaultFunctions: FunctionsConfig = {
"getLoggedInUser": { group: "default", points: 1 },
Expand All @@ -59,7 +64,7 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
"isWorkspaceOwner": { group: "default", points: 1 },
"getOwnerToken": { group: "default", points: 1 },
"createWorkspace": { group: "default", points: 1 },
"startWorkspace": { group: "default", points: 1 },
"startWorkspace": { group: "startWorkspace", points: 1 },
"stopWorkspace": { group: "default", points: 1 },
"deleteWorkspace": { group: "default", points: 1 },
"setWorkspaceDescription": { group: "default", points: 1 },
Expand Down
4 changes: 2 additions & 2 deletions components/server/src/websocket/websocket-connection-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* See License-AGPL.txt in the project root for license information.
*/

import { ClientHeaderFields, Disposable, GitpodClient as GitpodApiClient, GitpodServerPath, User } from "@gitpod/gitpod-protocol";
import { ClientHeaderFields, Disposable, GitpodClient as GitpodApiClient, GitpodServerPath, RateLimiterError, User } from "@gitpod/gitpod-protocol";
import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
import { ConnectionHandler } from "@gitpod/gitpod-protocol/lib/messaging/handler";
import { JsonRpcConnectionHandler, JsonRpcProxy, JsonRpcProxyFactory } from "@gitpod/gitpod-protocol/lib/messaging/proxy-factory";
Expand Down Expand Up @@ -356,7 +356,7 @@ class GitpodJsonRpcProxyFactory<T extends object> extends JsonRpcProxyFactory<T>
throw rlRejected;
}
log.warn({ userId }, "Rate limiter prevents accessing method due to too many requests.", rlRejected, { method });
throw new ResponseError(ErrorCodes.TOO_MANY_REQUESTS, "too many requests", { "Retry-After": String(Math.round(rlRejected.msBeforeNext / 1000)) || 1 });
throw new ResponseError<RateLimiterError>(ErrorCodes.TOO_MANY_REQUESTS, "too many requests", { method, retryAfter: Math.round(rlRejected.msBeforeNext / 1000) || 1 });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably safer with a Math.ceil, but not a major issue (since the front-end retry code works well):

Suggested change
throw new ResponseError<RateLimiterError>(ErrorCodes.TOO_MANY_REQUESTS, "too many requests", { method, retryAfter: Math.round(rlRejected.msBeforeNext / 1000) || 1 });
throw new ResponseError<RateLimiterError>(ErrorCodes.TOO_MANY_REQUESTS, "too many requests", { method, retryAfter: Math.ceil(rlRejected.msBeforeNext / 1000) || 1 });

}

// access guard
Expand Down