[dashboard]: create a settings tab inside admin

Author: Simon Emms

components/dashboard/src/App.tsx

@@ -12,6 +12,7 @@ import { Login } from './Login';
 import { UserContext } from './user-context';
 import { TeamsContext } from './teams/teams-context';
 import { ThemeContext } from './theme-context';
+import { AdminContext } from './admin-context';
 import { getGitpodService } from './service/service';
 import { shouldSeeWhatsNew, WhatsNew } from './whatsnew/WhatsNew';
 import gitpodIcon from './icons/gitpod.svg';
@@ -52,6 +53,7 @@ const InstallGitHubApp = React.lazy(() => import(/* webpackPrefetch: true */ './
 const FromReferrer = React.lazy(() => import(/* webpackPrefetch: true */ './FromReferrer'));
 const UserSearch = React.lazy(() => import(/* webpackPrefetch: true */ './admin/UserSearch'));
 const WorkspacesSearch = React.lazy(() => import(/* webpackPrefetch: true */ './admin/WorkspacesSearch'));
+const AdminSettings = React.lazy(() => import(/* webpackPrefetch: true */ './admin/Settings'));
 const OAuthClientApproval = React.lazy(() => import(/* webpackPrefetch: true */ './OauthClientApproval'));
 
 function Loading() {
@@ -98,6 +100,7 @@ export function getURLHash() {
 function App() {
     const { user, setUser } = useContext(UserContext);
     const { teams, setTeams } = useContext(TeamsContext);
+    const { setSendTelemetry } = useContext(AdminContext);
     const { setIsDark } = useContext(ThemeContext);
 
     const [ loading, setLoading ] = useState<boolean>(true);
@@ -132,6 +135,11 @@ function App() {
                     }
                 }
                 setTeams(teams);
+
+                if (user?.rolesOrPermissions?.includes('admin')) {
+                    const sendTelemetry = await getGitpodService().server.adminSettingsGetTelemetry();
+                    setSendTelemetry(sendTelemetry);
+                }
             } catch (error) {
                 console.error(error);
                 if (error && "code" in error) {
@@ -279,6 +287,7 @@ function App() {
 
                 <Route path="/admin/users" component={UserSearch} />
                 <Route path="/admin/workspaces" component={WorkspacesSearch} />
+                <Route path="/admin/settings" component={AdminSettings} />
 
                 <Route path={["/", "/login"]} exact>
                     <Redirect to={workspacesPathMain} />

components/dashboard/src/admin-context.tsx

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import React, { createContext, useState } from 'react';
+
+const AdminContext = createContext<{
+    sendTelemetry?: boolean,
+    setSendTelemetry: React.Dispatch<boolean>,
+}>({
+    setSendTelemetry: () => null,
+});
+
+const AdminContextProvider: React.FC = ({ children }) => {
+    const [sendTelemetry, setSendTelemetry] = useState<boolean>();
+    return (
+        <AdminContext.Provider value={{ sendTelemetry, setSendTelemetry }}>
+            {children}
+        </AdminContext.Provider>
+    );
+};
+
+export { AdminContext, AdminContextProvider }

components/dashboard/src/admin/Settings.tsx

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { useContext } from "react";
+import { AdminContext } from "../admin-context";
+import CheckBox from "../components/CheckBox";
+import { PageWithSubMenu } from "../components/PageWithSubMenu";
+import { getGitpodService } from "../service/service";
+import { adminMenu } from "./admin-menu";
+
+export default function Settings() {
+    const { sendTelemetry, setSendTelemetry } = useContext(AdminContext);
+
+    const actuallySetTelemetryPrefs = async (value: boolean) => {
+        await getGitpodService().server.adminSettingsSetTelemetry(value);
+        setSendTelemetry(value);
+    }
+
+    return (
+        <div>
+            <PageWithSubMenu subMenu={adminMenu} title="Settings" subtitle="Configure settings for your Gitpod cluster.">
+                <CheckBox
+                    title="Send anonymous service ping to Gitpod"
+                    desc="This is used to provide insights on how you use your cluster so we can provide a better overall experience."
+                    checked={sendTelemetry ?? false}
+                    onChange={(evt) => actuallySetTelemetryPrefs(evt.target.checked)} />
+            </PageWithSubMenu>
+        </div >
+    )
+}

components/dashboard/src/admin/admin-menu.ts

@@ -10,4 +10,7 @@ export const adminMenu = [{
 }, {
     title: 'Workspaces',
     link: ['/admin/workspaces']
+}, {
+    title: 'Settings',
+    link: ['/admin/settings']
 },];

components/dashboard/src/index.tsx

@@ -8,6 +8,7 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import App from './App';
 import { UserContextProvider } from './user-context';
+import { AdminContextProvider } from './admin-context';
 import { TeamsContextProvider } from './teams/teams-context';
 import { ProjectContextProvider } from './projects/project-context';
 import { ThemeContextProvider } from './theme-context';
@@ -18,15 +19,17 @@ import "./index.css"
 ReactDOM.render(
     <React.StrictMode>
         <UserContextProvider>
-            <TeamsContextProvider>
-                <ProjectContextProvider>
-                    <ThemeContextProvider>
-                        <BrowserRouter>
-                            <App />
-                        </BrowserRouter>
-                    </ThemeContextProvider>
-                </ProjectContextProvider>
-            </TeamsContextProvider>
+            <AdminContextProvider>
+                <TeamsContextProvider>
+                    <ProjectContextProvider>
+                        <ThemeContextProvider>
+                            <BrowserRouter>
+                                <App />
+                            </BrowserRouter>
+                        </ThemeContextProvider>
+                    </ProjectContextProvider>
+                </TeamsContextProvider>
+            </AdminContextProvider>
         </UserContextProvider>
     </React.StrictMode>,
     document.getElementById('root')

components/gitpod-db/src/installation-admin-db.ts

@@ -9,4 +9,5 @@ import { InstallationAdmin } from "@gitpod/gitpod-protocol";
 export const InstallationAdminDB = Symbol('InstallationAdminDB');
 export interface InstallationAdminDB {
     getTelemetryData(): Promise<InstallationAdmin>;
+    setSendTelemetry(value: boolean): Promise<void>;
 }

components/gitpod-db/src/typeorm/installation-admin-db-impl.ts

@@ -24,7 +24,7 @@ export class TypeORMInstallationAdminImpl implements InstallationAdminDB {
         const record: InstallationAdmin = {
             id: uuidv4(),
             settings: {
-                sendTelemetry: false,
+                sendTelemetry: true,
             },
         };
 
@@ -55,4 +55,12 @@ export class TypeORMInstallationAdminImpl implements InstallationAdminDB {
         /* Record not found - create one */
         return this.createDefaultRecord();
     }
+
+    async setSendTelemetry(value: boolean): Promise<void> {
+        const record = await this.getTelemetryData();
+        record.settings.sendTelemetry = value;
+
+        const repo = await this.getInstallationAdminRepo();
+        repo.save(record);
+    }
 }

components/gitpod-protocol/src/admin-protocol.ts

@@ -29,6 +29,9 @@ export interface AdminServer {
     adminIsStudent(userId: string): Promise<boolean>;
     adminAddStudentEmailDomain(userId: string, domain: string): Promise<void>;
     adminGrantExtraHours(userId: string, extraHours: number): Promise<void>;
+
+    adminSettingsGetTelemetry(): Promise<boolean>
+    adminSettingsSetTelemetry(send: boolean): Promise<void>
 }
 
 export interface AdminGetListRequest<T> {
@@ -65,7 +68,7 @@ export interface AdminModifyPermanentWorkspaceFeatureFlagRequest {
     }[]
 }
 
-export interface WorkspaceAndInstance extends Omit<Workspace, "id"|"creationTime">, Omit<WorkspaceInstance, "id"|"creationTime"> {
+export interface WorkspaceAndInstance extends Omit<Workspace, "id" | "creationTime">, Omit<WorkspaceInstance, "id" | "creationTime"> {
     workspaceId: string;
     workspaceCreationTime: string;
     instanceId: string;
@@ -78,7 +81,7 @@ export namespace WorkspaceAndInstance {
         return {
             id: wai.workspaceId,
             creationTime: wai.workspaceCreationTime,
-            ... wai
+            ...wai
         };
     }
 
@@ -89,7 +92,7 @@ export namespace WorkspaceAndInstance {
         return {
             id: wai.instanceId,
             creationTime: wai.instanceCreationTime,
-            ... wai
+            ...wai
         };
     }
 }

components/gitpod-protocol/src/gitpod-service.ts

@@ -125,6 +125,10 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     resetGenericInvite(inviteId: string): Promise<TeamMembershipInvite>;
     deleteTeam(teamId: string, userId: string): Promise<void>;
 
+    // Admin Settings
+    adminSettingsGetTelemetry(): Promise<boolean>;
+    adminSettingsSetTelemetry(send: boolean): Promise<void>;
+
     // Projects
     getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;
     createProject(params: CreateProjectParams): Promise<Project>;

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

@@ -318,7 +318,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         if (!instance) {
             throw new ResponseError(ErrorCodes.NOT_FOUND, `Workspace ${workspaceId} has no running instance`);
         }
-        await this.guardAccess({ kind: "workspaceInstance", subject: instance, workspace}, "get");
+        await this.guardAccess({ kind: "workspaceInstance", subject: instance, workspace }, "get");
 
         const client = await this.workspaceManagerClientProvider.get(instance.region);
         const request = new TakeSnapshotRequest();
@@ -337,13 +337,13 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
             await this.internalDoWaitForWorkspace(waitOpts);
         } else {
             // start driving the snapshot immediately
-            SafePromise.catchAndLog(this.internalDoWaitForWorkspace(waitOpts), { userId: user.id, workspaceId: workspaceId})
+            SafePromise.catchAndLog(this.internalDoWaitForWorkspace(waitOpts), { userId: user.id, workspaceId: workspaceId })
         }
 
         return snapshot.id;
     }
 
-    protected async guardSnaphotAccess(ctx: TraceContext, userId: string, workspaceId: string) : Promise<Workspace> {
+    protected async guardSnaphotAccess(ctx: TraceContext, userId: string, workspaceId: string): Promise<Workspace> {
         traceAPIParams(ctx, { userId, workspaceId });
 
         const workspace = await this.workspaceDb.trace(ctx).findById(workspaceId);
@@ -563,6 +563,24 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
         return result;
     }
 
+    async adminSettingsGetTelemetry(ctx: TraceContext): Promise<boolean> {
+        traceAPIParams(ctx, {});
+
+        await this.guardAdminAccess("adminSettingsGetTelemetry", {}, Permission.ADMIN_API);
+
+        const settings = await this.installationAdminDb.getTelemetryData();
+
+        return settings.settings.sendTelemetry;
+    }
+
+    async adminSettingsSetTelemetry(ctx: TraceContext, send: boolean): Promise<void> {
+        traceAPIParams(ctx, {});
+
+        await this.guardAdminAccess("adminSettingsGetTelemetry", {}, Permission.ADMIN_API);
+
+        await this.installationAdminDb.setSendTelemetry(send);
+    }
+
     async adminForceStopWorkspace(ctx: TraceContext, workspaceId: string): Promise<void> {
         traceAPIParams(ctx, { workspaceId });
 
@@ -715,7 +733,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
     }
 
     async adminSetLicense(ctx: TraceContext, key: string): Promise<void> {
-        traceAPIParams(ctx, { });   // don't trace the actual key
+        traceAPIParams(ctx, {});   // don't trace the actual key
 
         await this.guardAdminAccess("adminGetWorkspaces", { key }, Permission.ADMIN_API);
 
@@ -1406,7 +1424,7 @@ export class GitpodServerEEImpl extends GitpodServerImpl {
 
     // various
     async sendFeedback(ctx: TraceContext, feedback: string): Promise<string | undefined> {
-        traceAPIParams(ctx, { });   // feedback is not interesting here, any may contain names
+        traceAPIParams(ctx, {});   // feedback is not interesting here, any may contain names
 
         const user = this.checkUser("sendFeedback");
         const now = new Date().toISOString();

components/server/src/auth/rate-limiter.ts

@@ -135,6 +135,8 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "adminForceStopWorkspace": { group: "default", points: 1 },
         "adminRestoreSoftDeletedWorkspace": { group: "default", points: 1 },
         "adminSetLicense": { group: "default", points: 1 },
+        "adminSettingsGetTelemetry": { group: "default", points: 1 },
+        "adminSettingsSetTelemetry": { group: "default", points: 1 },
 
         "validateLicense": { group: "default", points: 1 },
         "getLicenseInfo": { group: "default", points: 1 },

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

@@ -5,7 +5,7 @@
  */
 
 import { DownloadUrlRequest, DownloadUrlResponse, UploadUrlRequest, UploadUrlResponse } from '@gitpod/content-service/lib/blobs_pb';
-import { AppInstallationDB, UserDB, UserMessageViewsDB, WorkspaceDB, DBWithTracing, TracedWorkspaceDB, DBGitpodToken, DBUser, UserStorageResourcesDB, TeamDB } from '@gitpod/gitpod-db/lib';
+import { AppInstallationDB, UserDB, UserMessageViewsDB, WorkspaceDB, DBWithTracing, TracedWorkspaceDB, DBGitpodToken, DBUser, UserStorageResourcesDB, TeamDB, InstallationAdminDB } from '@gitpod/gitpod-db/lib';
 import { AuthProviderEntry, AuthProviderInfo, CommitContext, Configuration, CreateWorkspaceMode, DisposableCollection, GetWorkspaceTimeoutResult, GitpodClient as GitpodApiClient, GitpodServer, GitpodToken, GitpodTokenType, InstallPluginsParams, PermissionName, PortVisibility, PrebuiltWorkspace, PrebuiltWorkspaceContext, PreparePluginUploadParams, ResolvedPlugins, ResolvePluginsParams, SetWorkspaceTimeoutResult, StartPrebuildContext, StartWorkspaceResult, Terms, Token, UninstallPluginParams, User, UserEnvVar, UserEnvVarValue, UserInfo, WhitelistedRepository, Workspace, WorkspaceContext, WorkspaceCreationResult, WorkspaceImageBuild, WorkspaceInfo, WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstanceUser, WorkspaceTimeoutDuration, GuessGitTokenScopesParams, GuessedGitTokenScopes, Team, TeamMemberInfo, TeamMembershipInvite, CreateProjectParams, Project, ProviderRepository, TeamMemberRole, WithDefaultConfig, FindPrebuildsParams, PrebuildWithStatus, StartPrebuildResult, ClientHeaderFields } from '@gitpod/gitpod-protocol';
 import { AccountStatement } from "@gitpod/gitpod-protocol/lib/accounting-protocol";
 import { AdminBlockUserRequest, AdminGetListRequest, AdminGetListResult, AdminGetWorkspacesRequest, AdminModifyPermanentWorkspaceFeatureFlagRequest, AdminModifyRoleOrPermissionRequest, WorkspaceAndInstance } from '@gitpod/gitpod-protocol/lib/admin-protocol';
@@ -77,6 +77,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     @inject(ContextParser) protected contextParser: ContextParser;
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
     @inject(GitpodFileParser) protected readonly gitpodParser: GitpodFileParser;
+    @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
 
     @inject(WorkspaceStarter) protected readonly workspaceStarter: WorkspaceStarter;
     @inject(WorkspaceManagerClientProvider) protected readonly workspaceManagerClientProvider: WorkspaceManagerClientProvider;
@@ -621,7 +622,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
             includeHeadless: false,
         });
         await Promise.all(res.map(ws => this.guardAccess({ kind: "workspace", subject: ws.workspace }, "get")));
-        await Promise.all(res.map(ws => this.guardAccess({ kind: "workspaceInstance", subject: ws.latestInstance, workspace: ws.workspace}, "get")));
+        await Promise.all(res.map(ws => this.guardAccess({ kind: "workspaceInstance", subject: ws.latestInstance, workspace: ws.workspace }, "get")));
         return res;
     }
 
@@ -1853,7 +1854,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     }
 
     public async getGitpodTokenScopes(ctx: TraceContext, tokenHash: string): Promise<string[]> {
-        traceAPIParams(ctx, { });   // do not trace tokenHash
+        traceAPIParams(ctx, {});   // do not trace tokenHash
 
         const user = this.checkAndBlockUser("getGitpodTokenScopes");
         let token: GitpodToken | undefined;
@@ -1871,7 +1872,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     }
 
     public async deleteGitpodToken(ctx: TraceContext, tokenHash: string): Promise<void> {
-        traceAPIParams(ctx, { });   // do not trace tokenHash
+        traceAPIParams(ctx, {});   // do not trace tokenHash
 
         const user = this.checkAndBlockUser("deleteGitpodToken");
         const existingTokens = await this.getGitpodTokens(ctx); // all tokens for logged in user
@@ -1984,6 +1985,15 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         throw new ResponseError(ErrorCodes.EE_FEATURE, `Admin support is implemented in Gitpod's Enterprise Edition`);
     }
 
+    async adminSettingsGetTelemetry(ctx: TraceContext): Promise<boolean> {
+        console.log(2222)
+        return false;
+    }
+
+    async adminSettingsSetTelemetry(ctx: TraceContext, send: boolean): Promise<void> {
+        console.log(3333);
+    }
+
     async getLicenseInfo(): Promise<GetLicenseInfoResult> {
         throw new ResponseError(ErrorCodes.EE_FEATURE, `Licensing is implemented in Gitpod's Enterprise Edition`);
     }
@@ -2040,7 +2050,7 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     protected validHostNameRegexp = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)+([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])(\/([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$/;
 
     async updateOwnAuthProvider(ctx: TraceContext, { entry }: GitpodServer.UpdateOwnAuthProviderParams): Promise<AuthProviderEntry> {
-        traceAPIParams(ctx, {  });  // entry contains PII
+        traceAPIParams(ctx, {});  // entry contains PII
 
         let userId: string;
         try {