[server] removed unused branding from config

Author: JanKoehnlein

chart/templates/server-configmap.yaml

@@ -40,7 +40,6 @@ data:
         "enableLocalApp": {{ $comp.enableLocalApp }},
         "authProviderConfigs": {{ .Values.authProviders | toJson }},
         "disableDynamicAuthProviderLogin": {{ $comp.disableDynamicAuthProviderLogin }},
-        "brandingConfig": {{ .Values.branding | toJson }},
         "maxEnvvarPerUserCount": {{ $comp.maxEnvvarPerUserCount }},
         "maxConcurrentPrebuildsPerRef": {{ $comp.maxConcurrentPrebuildsPerRef }},
         "incrementalPrebuilds": {{ $comp.incrementalPrebuilds | toJson }},

chart/values.yaml

@@ -97,40 +97,6 @@ authProviders: []
 #     settingsUrl: "https://gitlab.com/-/profile/applications"
 #   description: ""
 #   icon: ""
-branding:
-  logo: /images/gitpod-ddd.svg
-  homepage: https://www.gitpod.io/
-  links:
-    header:
-      - name: Workspaces
-        url: /workspaces/
-      - name: Docs
-        url: https://www.gitpod.io/docs/
-      - name: Blog
-        url: https://www.gitpod.io/blog/
-      - name: Community
-        url: https://community.gitpod.io/
-    footer:
-      - name: Docs
-        url: https://www.gitpod.io/docs/
-      - name: Blog
-        url: https://www.gitpod.io/blog/
-      - name: Status
-        url: https://status.gitpod.io/
-    social:
-      - type: GitHub
-        url: https://github.com/gitpod-io/gitpod
-      - type: Discourse
-        url: https://community.gitpod.io/
-      - type: Twitter
-        url: https://twitter.com/gitpod
-    legal:
-      - name: Imprint
-        url: https://www.gitpod.io/imprint/
-      - name: Privacy Policy
-        url: https://www.gitpod.io/privacy/
-      - name: Terms of Service
-        url: https://www.gitpod.io/terms/
 workspaceScheduler: workspace-scheduler
 
 components:

components/gitpod-protocol/go/gitpod-service.go

@@ -31,7 +31,6 @@ type APIInterface interface {
 	GetOwnAuthProviders(ctx context.Context) (res []*AuthProviderEntry, err error)
 	UpdateOwnAuthProvider(ctx context.Context, params *UpdateOwnAuthProviderParams) (err error)
 	DeleteOwnAuthProvider(ctx context.Context, params *DeleteOwnAuthProviderParams) (err error)
-	GetBranding(ctx context.Context) (res *Branding, err error)
 	GetConfiguration(ctx context.Context) (res *Configuration, err error)
 	GetGitpodTokenScopes(ctx context.Context, tokenHash string) (res []string, err error)
 	GetToken(ctx context.Context, query *GetTokenSearchOptions) (res *Token, err error)
@@ -105,8 +104,6 @@ const (
 	FunctionUpdateOwnAuthProvider FunctionName = "updateOwnAuthProvider"
 	// FunctionDeleteOwnAuthProvider is the name of the deleteOwnAuthProvider function
 	FunctionDeleteOwnAuthProvider FunctionName = "deleteOwnAuthProvider"
-	// FunctionGetBranding is the name of the getBranding function
-	FunctionGetBranding FunctionName = "getBranding"
 	// FunctionGetConfiguration is the name of the getConfiguration function
 	FunctionGetConfiguration FunctionName = "getConfiguration"
 	// FunctionGetGitpodTokenScopes is the name of the GetGitpodTokenScopes function
@@ -480,24 +477,6 @@ func (gp *APIoverJSONRPC) DeleteOwnAuthProvider(ctx context.Context, params *Del
 	return
 }
 
-// GetBranding calls getBranding on the server
-func (gp *APIoverJSONRPC) GetBranding(ctx context.Context) (res *Branding, err error) {
-	if gp == nil {
-		err = errNotConnected
-		return
-	}
-	var _params []interface{}
-
-	var result Branding
-	err = gp.C.Call(ctx, "getBranding", _params, &result)
-	if err != nil {
-		return
-	}
-	res = &result
-
-	return
-}
-
 // GetConfiguration calls getConfiguration on the server
 func (gp *APIoverJSONRPC) GetConfiguration(ctx context.Context) (res *Configuration, err error) {
 	if gp == nil {
@@ -1961,7 +1940,7 @@ type GenerateNewGitpodTokenOptions struct {
 type TakeSnapshotOptions struct {
 	LayoutData  string `json:"layoutData,omitempty"`
 	WorkspaceID string `json:"workspaceId,omitempty"`
-	DontWait    bool   `json:"dontWait",omitempty`
+	DontWait    bool   `json:"dontWait,omitempty"`
 }
 
 // PreparePluginUploadParams is the PreparePluginUploadParams message type
@@ -2051,49 +2030,6 @@ type RemoteTrackMessage struct {
 	Properties interface{} `json:"properties,omitempty"`
 }
 
-// BrandingLink is the BrandingLink message type
-type BrandingLink struct {
-	Name string `json:"name,omitempty"`
-	URL  string `json:"url,omitempty"`
-}
-
-// BrandingSocialLink is the BrandingSocialLink message type
-type BrandingSocialLink struct {
-	Type string `json:"type,omitempty"`
-	URL  string `json:"url,omitempty"`
-}
-
-// Ide is the Ide message type
-type Ide struct {
-	HelpMenu         []*BrandingLink `json:"helpMenu,omitempty"`
-	Logo             string          `json:"logo,omitempty"`
-	ShowReleaseNotes bool            `json:"showReleaseNotes,omitempty"`
-}
-
-// Links is the Links message type
-type Links struct {
-	Footer []*BrandingLink       `json:"footer,omitempty"`
-	Header []*BrandingLink       `json:"header,omitempty"`
-	Legal  []*BrandingLink       `json:"legal,omitempty"`
-	Social []*BrandingSocialLink `json:"social,omitempty"`
-}
-
-// Branding is the Branding message type
-type Branding struct {
-	Favicon  string `json:"favicon,omitempty"`
-	Homepage string `json:"homepage,omitempty"`
-	Ide      *Ide   `json:"ide,omitempty"`
-	Links    *Links `json:"links,omitempty"`
-
-	// Either including domain OR absolute path (interpreted relative to host URL)
-	Logo                          string `json:"logo,omitempty"`
-	Name                          string `json:"name,omitempty"`
-	RedirectURLAfterLogout        string `json:"redirectUrlAfterLogout,omitempty"`
-	RedirectURLIfNotAuthenticated string `json:"redirectUrlIfNotAuthenticated,omitempty"`
-	ShowProductivityTips          bool   `json:"showProductivityTips,omitempty"`
-	StartupLogo                   string `json:"startupLogo,omitempty"`
-}
-
 // WorkspaceInstanceUser is the WorkspaceInstanceUser message type
 type WorkspaceInstanceUser struct {
 	AvatarURL  string `json:"avatarUrl,omitempty"`

components/gitpod-protocol/go/mock.go

@@ -6,7 +6,7 @@
 
 import {
     User, WorkspaceInfo, WorkspaceCreationResult, WorkspaceInstanceUser,
-    WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode,
+    WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, CreateWorkspaceMode,
     Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, Terms,
     ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType,
     GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes
@@ -55,7 +55,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getOwnAuthProviders(): Promise<AuthProviderEntry[]>;
     updateOwnAuthProvider(params: GitpodServer.UpdateOwnAuthProviderParams): Promise<AuthProviderEntry>;
     deleteOwnAuthProvider(params: GitpodServer.DeleteOwnAuthProviderParams): Promise<void>;
-    getBranding(): Promise<Branding>;
     getConfiguration(): Promise<Configuration>;
     getToken(query: GitpodServer.GetTokenSearchOptions): Promise<Token | undefined>;
     getGitpodTokenScopes(tokenHash: string): Promise<string[]>;

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

@@ -1175,39 +1175,6 @@ export namespace AuthProviderEntry {
     }
 }
 
-export interface Branding {
-    readonly name: string;
-    readonly favicon?: string;
-    /** Either including domain OR absolute path (interpreted relative to host URL) */
-    readonly logo: string;
-    readonly startupLogo: string;
-    readonly showProductivityTips: boolean;
-    readonly redirectUrlIfNotAuthenticated?: string;
-    readonly redirectUrlAfterLogout?: string;
-    readonly homepage: string;
-    readonly ide?: {
-        readonly logo: string;
-        readonly showReleaseNotes: boolean;
-        readonly helpMenu: Branding.Link[];
-    }
-    readonly links: {
-        readonly header: Branding.Link[];
-        readonly footer: Branding.Link[];
-        readonly social: Branding.SocialLink[];
-        readonly legal: Branding.Link[];
-    }
-}
-export namespace Branding {
-    export interface Link {
-        readonly name: string;
-        readonly url: string;
-    }
-    export interface SocialLink {
-        readonly type: string;
-        readonly url: string;
-    }
-}
-
 export interface Configuration {
     readonly daysBeforeGarbageCollection: number;
     readonly garbageCollectionStartDate: number;

components/gitpod-protocol/src/protocol.ts

@@ -44,7 +44,6 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "getOwnAuthProviders": { group: "default", points: 1 },
         "updateOwnAuthProvider": { group: "default", points: 1 },
         "deleteOwnAuthProvider": { group: "default", points: 1 },
-        "getBranding": { group: "default", points: 1 },
         "getConfiguration": { group: "default", points: 1 },
         "getGitpodTokenScopes": { group: "default", points: 1 },
         "getToken": { group: "default", points: 1 },

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

@@ -7,7 +7,7 @@
 import { GitpodHostUrl } from '@gitpod/gitpod-protocol/lib/util/gitpod-host-url';
 import { AuthProviderParams, normalizeAuthProviderParams } from './auth/auth-provider';
 
-import { Branding, NamedWorkspaceFeatureFlag } from '@gitpod/gitpod-protocol';
+import { NamedWorkspaceFeatureFlag } from '@gitpod/gitpod-protocol';
 
 import { RateLimiterConfig } from './auth/rate-limiter';
 import { CodeSyncConfig } from './code-sync/code-sync-service';
@@ -16,7 +16,6 @@ import * as fs from 'fs';
 import * as yaml from 'js-yaml';
 import { log, LogrusLogLevel } from '@gitpod/gitpod-protocol/lib/util/logging';
 import { filePathTelepresenceAware, KubeStage, translateLegacyStagename } from '@gitpod/gitpod-protocol/lib/env';
-import { BrandingParser } from './branding-parser';
 
 export const Config = Symbol("Config");
 export type Config = Omit<ConfigSerialized, "hostUrl" | "chargebeeProviderOptionsFile"> & {
@@ -91,8 +90,6 @@ export interface ConfigSerialized {
     builtinAuthProvidersConfigured: boolean;
     disableDynamicAuthProviderLogin: boolean;
 
-    brandingConfig: Branding;
-
     /**
      * The maximum number of environment variables a user can have configured in their list at any given point in time.
      * Note: This limit should be so high that no regular user ever reaches it.
@@ -193,10 +190,6 @@ export namespace ConfigFile {
 
         const builtinAuthProvidersConfigured = authProviderConfigs.length > 0;
         const chargebeeProviderOptions = readOptionsFromFile(filePathTelepresenceAware(config.chargebeeProviderOptionsFile || ""));
-        let brandingConfig = config.brandingConfig;
-        if (brandingConfig) {
-            brandingConfig = BrandingParser.normalize(brandingConfig);
-        }
         let license = config.license
         const licenseFile = config.licenseFile
         if (licenseFile) {
@@ -208,7 +201,6 @@ export namespace ConfigFile {
             hostUrl,
             authProviderConfigs,
             builtinAuthProvidersConfigured,
-            brandingConfig,
             chargebeeProviderOptions,
             license,
             workspaceGarbageCollection: {

components/server/src/branding-parser.ts

@@ -141,13 +141,12 @@ export class UserController {
             this.ensureSafeReturnToParam(req);
             this.authenticator.deauthorize(req, res, next);
         });
-        const branding = this.config.brandingConfig;
         router.get("/logout", async (req: express.Request, res: express.Response, next: express.NextFunction) => {
             const logContext = LogContext.from({ user: req.user, request: req });
             const clientInfo = getRequestingClientInfo(req);
             const logPayload = { session: req.session, clientInfo };
 
-            let redirectToUrl = this.getSafeReturnToParam(req) || branding.redirectUrlAfterLogout || this.config.hostUrl.toString();
+            let redirectToUrl = this.getSafeReturnToParam(req) || this.config.hostUrl.toString();
 
             if (req.isAuthenticated()) {
                 req.logout();
@@ -621,7 +620,7 @@ export class UserController {
             return;
         }
 
-        if (this.urlStartsWith(returnToURL, this.config.hostUrl.toString()) || this.urlStartsWith(returnToURL, this.config.brandingConfig.homepage)) {
+        if (this.urlStartsWith(returnToURL, this.config.hostUrl.toString()) || this.urlStartsWith(returnToURL, "https://www.gitpod.io")) {
             return returnToURL
         }
 

components/server/src/config.ts

@@ -6,7 +6,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 { AuthProviderEntry, AuthProviderInfo, Branding, 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 { 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';
 import { GetLicenseInfoResult, LicenseFeature, LicenseValidationResult } from '@gitpod/gitpod-protocol/lib/license-protocol';
@@ -374,10 +374,6 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         return result;
     }
 
-    public async getBranding(ctx: TraceContext): Promise<Branding> {
-        return this.config.brandingConfig;
-    }
-
     public async getConfiguration(ctx: TraceContext): Promise<Configuration> {
         return {
             garbageCollectionStartDate: this.config.workspaceGarbageCollection.startDate,