Revamp with latest driver, bot account support & more

- Use the latest release of mattermost-server
  and switch to newer Go APIs
- Use bot accounts / token instead of user account
- Cleaner and more structured code
- Don't panic when connection closes unexpectedly
  (when mattermost server dies or bot get disconnected )
- No global variables
- Use env vars or .env file for configuration
- Level based logging
- Do not wait for one message to be handled before moving to next
- Example to reply in an existing thread

Author: IceWreck

.gitignore

@@ -32,3 +32,5 @@ Session.vim
 .agignore
 .ctags
 tags
+
+.env

README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-This sample Bot shows how to use the Mattermost [Go driver](https://github.com/mattermost/mattermost-server/blob/master/model/client4.go) to interact with a Mattermost server, listen to events and respond to messages. Documentation for the Go driver can be found [here](https://godoc.org/github.com/mattermost/mattermost-server/model#Client).
+This sample Bot shows how to use the Mattermost [Go driver](https://github.com/mattermost/mattermost-server/blob/master/model/client4.go) to interact with a Mattermost server, listen to events and respond to messages. Documentation for the Go driver can be found [here](https://pkg.go.dev/github.com/mattermost/mattermost-server/v6/model).
 
 Highlights of APIs used in this sample:
  - Log in to the Mattermost server
@@ -11,7 +11,7 @@ Highlights of APIs used in this sample:
  - Connect and listen to WebSocket events for real-time responses to messages
  - Post a message to a channel
 
-This Bot Sample was tested with Mattermost server version 3.10.0.
+This Bot Sample was tested with Mattermost server version 7.5.2.
 
 ## Setup Server Environment
 
@@ -22,7 +22,10 @@ This Bot Sample was tested with Mattermost server version 3.10.0.
 
 3 - Run `docker-compose up -d --build` and the mattermost client will be built and will expose the port `8065` to your system's localhost
 
-4 - Start the Bot.
+4 - Get a bot token by logging into your mattermost instance, copy `example.env` to `.env` and fill in the credentials. Alternatively, just provide your credentials as environment variables.
+
+5 - Start the Bot.
+
 ```
 make run
 ```
@@ -73,21 +76,23 @@ Learn more about the `mmctl` CLI tool in the [Mattermost documentation](https://
 git clone https://github.com/mattermost/mattermost-bot-sample-golang.git
 cd mattermost-bot-sample-golang
 ```
-3 - Start the Bot.
+3 - Get a bot token by logging into your mattermost instance, copy `example.env` to `.env` and fill in the credentials.
+
+4 - Start the Bot.
 ```
 make run
 ```
 You can verify the Bot is running when 
-  - `Server detected and is running version X.Y.Z` appears on the command line.
-  - `Mattermost Bot Sample has started running` is posted in the `Debugging For Sample Bot` channel.
+  - `Logged in to mattermost` appears on the command line.
+  - `Hi! I am a bot.` is posted in the your specified channel.
 
 ## Test the Bot
 
 1 - Log in to the Mattermost server as `[email protected]` and `Password1!`.
 
-2 - Join the `Debugging For Sample Bot` channel.
+2 - Join the your specified channel.
 
-3 - Post a message in the channel such as `are you running?` to see if the Bot responds. You should see a response similar to `Yes I'm running` if the Bot is running.
+3 - Post a message in the channel such as `hello?` to see if the Bot responds. You should see a response if the Bot is running.
 
 ## Stop the Bot
 

app.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v6/model"
+	"github.com/rs/zerolog"
+)
+
+// application struct to hold the dependencies for our bot
+type application struct {
+	config                    config
+	logger                    zerolog.Logger
+	mattermostClient          *model.Client4
+	mattermostWebSocketClient *model.WebSocketClient
+	mattermostUser            *model.User
+	mattermostChannel         *model.Channel
+	mattermostTeam            *model.Team
+}

bot_sample.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"net/url"
+	"os"
+
+	_ "github.com/joho/godotenv/autoload"
+)
+
+type config struct {
+	mattermostUserName string
+	mattermostTeamName string
+	mattermostToken    string
+	mattermostChannel  string
+	mattermostServer   *url.URL
+}
+
+func loadConfig() config {
+	var settings config
+
+	settings.mattermostTeamName = os.Getenv("MM_TEAM")
+	settings.mattermostUserName = os.Getenv("MM_USERNAME")
+	settings.mattermostToken = os.Getenv("MM_TOKEN")
+	settings.mattermostChannel = os.Getenv("MM_CHANNEL")
+	settings.mattermostServer, _ = url.Parse(os.Getenv("MM_SERVER"))
+
+	return settings
+}

config.go

@@ -0,0 +1,5 @@
+MM_TEAM="test-team"
+MM_TOKEN="XXXXXXXXXXXXXXX"
+MM_CHANNEL="town-square"
+MM_SERVER="http://localhost:8065"
+MM_USERNAME="yourbotuser"

example.env

@@ -3,30 +3,14 @@ module github.com/mattermost/mattermost-bot-sample-golang
 go 1.15
 
 require (
-	github.com/NYTimes/gziphandler v1.1.1 // indirect
-	github.com/go-gorp/gorp v2.0.0+incompatible // indirect
-	github.com/google/uuid v1.3.0 // indirect
-	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/joho/godotenv v1.4.0
 	github.com/klauspost/compress v1.15.2 // indirect
-	github.com/klauspost/cpuid/v2 v2.0.12 // indirect
-	github.com/mattermost/gorp v2.0.1-0.20190301154413-3b31e9a39d05+incompatible // indirect
 	github.com/mattermost/ldap v3.0.4+incompatible // indirect
-	github.com/mattermost/mattermost-server/v5 v5.39.3
-	github.com/mattermost/viper v1.0.4 // indirect
-	github.com/minio/minio-go/v6 v6.0.40 // indirect
-	github.com/minio/minio-go/v7 v7.0.24 // indirect
+	github.com/mattermost/mattermost-server/v6 v6.7.2
 	github.com/pelletier/go-toml v1.9.5 // indirect
-	github.com/rs/xid v1.4.0 // indirect
-	github.com/segmentio/analytics-go v3.1.0+incompatible // indirect
-	github.com/spf13/afero v1.2.2 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
-	go.uber.org/atomic v1.9.0 // indirect
-	go.uber.org/multierr v1.8.0 // indirect
-	go.uber.org/zap v1.21.0 // indirect
+	github.com/rs/zerolog v1.15.0
 	golang.org/x/crypto v0.0.0-20220427172511-eb4f295cb31f // indirect
 	golang.org/x/net v0.0.0-20220425223048-2871e0cb64e4 // indirect
 	golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6 // indirect
 	gopkg.in/asn1-ber.v1 v1.0.0-20181015200546-f715ec2f112d // indirect
-	gopkg.in/ini.v1 v1.66.4 // indirect
-	gopkg.in/olivere/elastic.v5 v5.0.82 // indirect
 )