telmetry: show collected data under the disable option

Currently, The service ping can be disabled by going into the
admin settings. Users are more likely to do that if they have
no clue what is being sent.

This PR tries to improve this experience, by showcasing the
exact data that is being sent below the option. This is possible
by creating a new TelemetryDataProvider and injecting that
both in the `installation-admin-collector` controller
and the `gitpod-service` (`getTelemetryData` func is added here
that can be used).

This PR also adds a gaurd to the `/admin/settings` page which
was missing previously

Signed-off-by: Tarun Pothulapati <[email protected]>

replace cluster with gitpod instance in desc

Signed-off-by: Tarun Pothulapati <[email protected]>

easy nits around design and TelemetryData naming

Signed-off-by: Tarun Pothulapati <[email protected]>

gaurd telemetry method with admin access

Signed-off-by: Tarun Pothulapati <[email protected]>

replace TelemetryData at more places

Signed-off-by: Tarun Pothulapati <[email protected]>

gaurd access to `admin/settings` like other admin settings

Signed-off-by: Tarun Pothulapati <[email protected]>

call useEffect hook early

Signed-off-by: Tarun Pothulapati <[email protected]>

Author: Pothulapati

components/dashboard/src/admin/Settings.tsx

@@ -5,15 +5,32 @@
  */
 
 import { useContext } from "react";
-import { InstallationAdminSettings } from "@gitpod/gitpod-protocol";
+import { TelemetryData, InstallationAdminSettings } from "@gitpod/gitpod-protocol";
 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";
+import { useEffect, useState } from "react";
+import InfoBox from "../components/InfoBox";
+import { Redirect } from "react-router-dom";
+import { UserContext } from "../user-context";
 
 export default function Settings() {
     const { adminSettings, setAdminSettings } = useContext(AdminContext);
+    const [telemetryData, setTelemetryData] = useState<TelemetryData>();
+    const { user } = useContext(UserContext);
+
+    useEffect(() => {
+        (async () => {
+            const data = await getGitpodService().server.adminGetTelemetryData();
+            setTelemetryData(data)
+        })();
+    });
+
+    if (!user || !user?.rolesOrPermissions?.includes('admin')) {
+        return <Redirect to="/"/>
+    }
 
     const actuallySetTelemetryPrefs = async (value: InstallationAdminSettings) => {
         await getGitpodService().server.adminUpdateSettings(value);
@@ -26,12 +43,13 @@ export default function Settings() {
                 <h3>Usage Statistics</h3>
                 <CheckBox
                     title="Enable Service Ping"
-                    desc={<span>This is used to provide insights on how you use your cluster so we can provide a better overall experience. <a className="gp-link" href="https://www.gitpod.io/privacy">Read our Privacy Policy</a></span>}
+                    desc={<span>The following usage data is sent to provide insights on how you use your Gitpod instance, so we can provide a better overall experience. <a className="gp-link" href="https://www.gitpod.io/privacy">Read our Privacy Policy</a></span>}
                     checked={adminSettings?.sendTelemetry ?? false}
                     onChange={(evt) => actuallySetTelemetryPrefs({
                         sendTelemetry: evt.target.checked,
                     })} />
-            </PageWithSubMenu>
+                <InfoBox><pre>{JSON.stringify(telemetryData, null, 2)}</pre></InfoBox>
+            </PageWithSubMenu >
         </div >
     )
 }

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

@@ -30,7 +30,7 @@ import { GithubUpgradeURL, PlanCoupon } from './payment-protocol';
 import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from './team-subscription-protocol';
 import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from './analytics';
 import { IDEServer } from './ide-protocol';
-import { InstallationAdminSettings } from './installation-admin-protocol';
+import { InstallationAdminSettings, TelemetryData } from './installation-admin-protocol';
 
 export interface GitpodClient {
     onInstanceUpdate(instance: WorkspaceInstance): void;
@@ -136,6 +136,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     // Admin Settings
     adminGetSettings(): Promise<InstallationAdminSettings>;
     adminUpdateSettings(settings: InstallationAdminSettings): Promise<void>;
+    adminGetTelemetryData(): Promise<TelemetryData>;
 
     // Projects
     getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;

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

@@ -23,7 +23,7 @@ export interface InstallationAdmin {
     settings: InstallationAdminSettings;
 }
 
-export interface Data {
+export interface TelemetryData {
     installationAdmin: InstallationAdmin
     totalUsers: number
     totalWorkspaces: number

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

@@ -148,6 +148,7 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "adminSetLicense": { group: "default", points: 1 },
         "adminGetSettings": { group: "default", points: 1 },
         "adminUpdateSettings": { group: "default", points: 1 },
+        "adminGetTelemetryData": {group: "default", points: 1},
 
         "validateLicense": { group: "default", points: 1 },
         "getLicenseInfo": { group: "default", points: 1 },

components/server/src/container-module.ts

@@ -81,6 +81,7 @@ import { DebugApp } from './debug-app';
 import { LocalMessageBroker, LocalRabbitMQBackedMessageBroker } from './messaging/local-message-broker';
 import { contentServiceBinder } from '@gitpod/content-service/lib/sugar';
 import { ReferrerPrefixParser } from './workspace/referrer-prefix-context-parser';
+import { InstallationAdminTelemetryDataProvider } from './installation-admin/telemetry-data-provider';
 
 export const productionContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
     bind(Config).toConstantValue(ConfigFile.fromFile());
@@ -193,6 +194,8 @@ export const productionContainerModule = new ContainerModule((bind, unbind, isBo
 
     bind(TermsProvider).toSelf().inSingletonScope();
 
+    bind(InstallationAdminTelemetryDataProvider).toSelf().inSingletonScope();
+
     // binds all content services
     (contentServiceBinder((ctx) => {
         const config = ctx.container.get<Config>(Config);

components/server/src/installation-admin/installation-admin-controller.ts

@@ -6,27 +6,17 @@
 
 import { injectable, inject } from 'inversify';
 import * as express from 'express';
-import { InstallationAdminDB, UserDB, WorkspaceDB } from '@gitpod/gitpod-db/lib';
-import { Data } from '@gitpod/gitpod-protocol'
+import { InstallationAdminTelemetryDataProvider } from './telemetry-data-provider';
 
 @injectable()
 export class InstallationAdminController {
-    @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
-    @inject(UserDB) protected readonly userDb: UserDB
-    @inject(WorkspaceDB) protected readonly workspaceDb: WorkspaceDB
+    @inject(InstallationAdminTelemetryDataProvider) protected readonly telemetryDataProvider: InstallationAdminTelemetryDataProvider;
 
     public create(): express.Application {
         const app = express();
 
         app.get('/data', async (req: express.Request, res: express.Response) => {
-            const data: Data = {
-                installationAdmin: await this.installationAdminDb.getData(),
-                totalUsers: await this.userDb.getUserCount(true),
-                totalWorkspaces: await this.workspaceDb.getWorkspaceCount(),
-                totalInstances: await this.workspaceDb.getInstanceCount(),
-            } as Data;
-
-            res.status(200).json(data);
+            res.status(200).json(await this.telemetryDataProvider.getTelemetryData());
         });
 
         return app;

components/server/src/installation-admin/telemetry-data-provider.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) 2020 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 { injectable, inject } from 'inversify';
+
+ import { TelemetryData } from "@gitpod/gitpod-protocol"
+ import { InstallationAdminDB, UserDB, WorkspaceDB } from '@gitpod/gitpod-db/lib';
+
+ @injectable()
+ export class InstallationAdminTelemetryDataProvider {
+    @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
+    @inject(UserDB) protected readonly userDb: UserDB
+    @inject(WorkspaceDB) protected readonly workspaceDb: WorkspaceDB
+
+     async getTelemetryData(): Promise<TelemetryData> {
+            const data: TelemetryData = {
+                installationAdmin: await this.installationAdminDb.getData(),
+                totalUsers: await this.userDb.getUserCount(true),
+                totalWorkspaces: await this.workspaceDb.getWorkspaceCount(),
+                totalInstances: await this.workspaceDb.getInstanceCount(),
+            } as TelemetryData;
+
+            return data;
+        }
+ }

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

@@ -57,8 +57,9 @@ import { PartialProject } from '@gitpod/gitpod-protocol/src/teams-projects-proto
 import { ClientMetadata, traceClientMetadata } from '../websocket/websocket-connection-manager';
 import { ConfigurationService } from '../config/configuration-service';
 import { ProjectEnvVar } from '@gitpod/gitpod-protocol/src/protocol';
-import { InstallationAdminSettings } from '@gitpod/gitpod-protocol';
+import { InstallationAdminSettings, TelemetryData } from '@gitpod/gitpod-protocol';
 import { Deferred } from '@gitpod/gitpod-protocol/lib/util/deferred';
+import { InstallationAdminTelemetryDataProvider } from '../installation-admin/telemetry-data-provider';
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi);    // userId is already taken care of in WebsocketConnectionManager
@@ -80,6 +81,8 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
     @inject(HostContextProvider) protected readonly hostContextProvider: HostContextProvider;
     @inject(GitpodFileParser) protected readonly gitpodParser: GitpodFileParser;
     @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
+    @inject(InstallationAdminTelemetryDataProvider) protected readonly telemetryDataProvider: InstallationAdminTelemetryDataProvider;
+
 
     @inject(WorkspaceStarter) protected readonly workspaceStarter: WorkspaceStarter;
     @inject(WorkspaceManagerClientProvider) protected readonly workspaceManagerClientProvider: WorkspaceManagerClientProvider;
@@ -2222,6 +2225,16 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         await this.installationAdminDb.setSettings(newSettings);
     }
 
+    async adminGetTelemetryData(ctx: TraceContext): Promise<TelemetryData> {
+        traceAPIParams(ctx, {});
+
+        await this.guardAdminAccess("adminGetTelemetryData", {}, Permission.ADMIN_API);
+
+       return await this.telemetryDataProvider.getTelemetryData();
+    }
+
+
+
     async getLicenseInfo(): Promise<GetLicenseInfoResult> {
         throw new ResponseError(ErrorCodes.EE_FEATURE, `Licensing is implemented in Gitpod's Enterprise Edition`);
     }