Added setting to hide/show left sidebar github buttons (#396)

plugin.json

@@ -63,6 +63,13 @@
                 "type": "text",
                 "help_text": "(Optional) The upload URL for using the plugin with a GitHub Enterprise installation. This is often the same as your Base URL."
             },
+            {
+                "key": "EnableLeftSidebar",
+                "display_name": "Display Notification Counters in Left Sidebar",
+                "type": "bool",
+                "help_text": "When false, the counters showing the user how many open/assigned issues they have in Github will not be shown in the Left Hand Sidebar on desktop browsers.",
+                "default": true
+            },
             {
                 "key": "EnablePrivateRepo",
                 "display_name": "Enable Private Repositories:",

server/plugin/api.go

@@ -56,6 +56,10 @@ type HTTPHandlerFuncWithUser func(w http.ResponseWriter, r *http.Request, userID
 // ResponseType indicates type of response returned by api
 type ResponseType string
 
+type Settings struct {
+	LeftSidebarEnabled bool `json:"left_sidebar_enabled"`
+}
+
 const (
 	// ResponseTypeJSON indicates that response type is json
 	ResponseTypeJSON ResponseType = "JSON_RESPONSE"
@@ -109,6 +113,7 @@ func (p *Plugin) initializeAPI() {
 	oauthRouter.HandleFunc("/complete", p.extractUserMiddleWare(p.completeConnectUserToGitHub, ResponseTypePlain)).Methods(http.MethodGet)
 
 	apiRouter.HandleFunc("/connected", p.getConnected).Methods(http.MethodGet)
+	apiRouter.HandleFunc("/settings", p.getSettings).Methods(http.MethodGet)
 	apiRouter.HandleFunc("/todo", p.extractUserMiddleWare(p.postToDo, ResponseTypeJSON)).Methods(http.MethodPost)
 	apiRouter.HandleFunc("/reviews", p.extractUserMiddleWare(p.getReviews, ResponseTypePlain)).Methods(http.MethodGet)
 	apiRouter.HandleFunc("/yourprs", p.extractUserMiddleWare(p.getYourPrs, ResponseTypePlain)).Methods(http.MethodGet)
@@ -1367,3 +1372,11 @@ func parseRepo(repoParam string) (owner, repo string, err error) {
 
 	return splitted[0], splitted[1], nil
 }
+
+func (p *Plugin) getSettings(w http.ResponseWriter, _ *http.Request) {
+	resp := Settings{
+		LeftSidebarEnabled: p.getConfiguration().EnableLeftSidebar,
+	}
+
+	p.writeJSON(w, resp)
+}

server/plugin/configuration.go

@@ -22,6 +22,7 @@ type Configuration struct {
 	GitHubOAuthClientID     string
 	GitHubOAuthClientSecret string
 	WebhookSecret           string
+	EnableLeftSidebar       bool
 	EnablePrivateRepo       bool
 	EncryptionKey           string
 	EnterpriseBaseURL       string

server/plugin/manifest.go

@@ -36,6 +36,14 @@ const manifestStr = `
     "header": "The GitHub plugin for Mattermost allows users to subscribe to notifications, stay up-to-date with reviews, see the status of pull requests at a glance, and other common GitHub actions - directly from Mattermost. \n \n Instructions for setup are [available here](https://www.mattermost.com/pl/default-github-plugin#configuration).",
     "footer": "* To report an issue, make a suggestion or a contribution, [check the repository](https://github.com/mattermost/mattermost-plugin-github).",
     "settings": [
+      {
+        "key": "EnableLeftSidebar",
+        "display_name": "Display Notification Counters in Left Sidebar",
+        "type": "bool",
+        "help_text": "When false, the counters showing the user how many open/assigned issues they have in Github will not be shown in the Left Hand Sidebar on desktop browsers.",
+        "placeholder": "",
+        "default": true
+      },
       {
         "key": "GitHubOAuthClientID",
         "display_name": "GitHub OAuth Client ID:",

webapp/src/actions/index.js

@@ -418,3 +418,13 @@ export function attachCommentToIssue(payload) {
         return {data};
     };
 }
+
+export async function getSettings() {
+    let data;
+    try {
+        data = await Client.getSettings();
+    } catch (error) {
+        return {error};
+    }
+    return {data};
+}

webapp/src/client/client.js

@@ -79,6 +79,10 @@ export default class Client {
         return this.doGet(`${this.url}/pr?owner=${owner}&repo=${repo}&number=${prNumber}`);
     }
 
+    getSettings = async () => {
+        return this.doGet(`${this.url}/settings`);
+    }
+
     doGet = async (url, body, headers = {}) => {
         headers['X-Timezone-Offset'] = new Date().getTimezoneOffset();
 

webapp/src/index.js

@@ -11,7 +11,7 @@ import UserAttribute from './components/user_attribute';
 import SidebarRight from './components/sidebar_right';
 import LinkTooltip from './components/link_tooltip';
 import Reducer from './reducers';
-import {getConnected, setShowRHSAction} from './actions';
+import {getConnected, setShowRHSAction, getSettings} from './actions';
 import {handleConnect, handleDisconnect, handleOpenCreateIssueModal, handleReconnect, handleRefresh} from './websocket';
 
 import {id as pluginId} from './manifest';
@@ -24,10 +24,13 @@ class PluginClass {
     async initialize(registry, store) {
         registry.registerReducer(Reducer);
 
+        const {data: settings} = await getSettings(store.getState);
         await getConnected(true)(store.dispatch, store.getState);
 
-        registry.registerLeftSidebarHeaderComponent(SidebarHeader);
-        registry.registerBottomTeamSidebarComponent(TeamSidebar);
+        if (settings && settings.left_sidebar_enabled) {
+            registry.registerLeftSidebarHeaderComponent(SidebarHeader);
+            registry.registerBottomTeamSidebarComponent(TeamSidebar);
+        }
         registry.registerPopoverUserAttributesComponent(UserAttribute);
         registry.registerRootComponent(CreateIssueModal);
         registry.registerPostDropdownMenuComponent(CreateIssuePostMenuAction);

webapp/src/manifest.ts

@@ -26,6 +26,14 @@ const manifest = JSON.parse(`
         "header": "The GitHub plugin for Mattermost allows users to subscribe to notifications, stay up-to-date with reviews, see the status of pull requests at a glance, and other common GitHub actions - directly from Mattermost. \\n \\n Instructions for setup are [available here](https://www.mattermost.com/pl/default-github-plugin#configuration).",
         "footer": "* To report an issue, make a suggestion or a contribution, [check the repository](https://github.com/mattermost/mattermost-plugin-github).",
         "settings": [
+            {
+                "key": "EnableLeftSidebar",
+                "display_name": "Display Notification Counters in Left Sidebar",
+                "type": "bool",
+                "help_text": "When false, the counters showing the user how many open/assigned issues they have in Github will not be shown in the Left Hand Sidebar on desktop browsers.",
+                "placeholder": "",
+                "default": true
+            },
             {
                 "key": "GitHubOAuthClientID",
                 "display_name": "GitHub OAuth Client ID:",