Skip to content

Commit a6b0f80

Browse files
ayanchoudharywryonik
ayanchoudhary
and
wryonik
authored
Fix logo fetch flow from backend (#278)
* feat: fix logo replace workflow * fix: conflicts with previous logo route * remove previous route * Add docs for updateCompetitionInfoHandler * Fix vendor Co-authored-by: shubhamgupta2956 <[email protected]>
1 parent c18e6ac commit a6b0f80

File tree

14 files changed

+322
-37
lines changed

14 files changed

+322
-37
lines changed

‎api/config.go

+47-4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package api
33
import (
44
"fmt"
55
"net/http"
6+
"os"
67
"path/filepath"
78

89
"github.com/gin-gonic/gin"
@@ -36,7 +37,26 @@ func reloadBeastConfig(c *gin.Context) {
3637
})
3738
}
3839

40+
// This updates competition info in the beast global configuration
41+
// @Summary Updates competition info in the beast global configuration, located at ~/.beast/config.toml.
42+
// @Description Populates beast gobal config map by reparsing the config file $HOME/.beast/config.toml.
43+
// @Tags config
44+
// @Accept json
45+
// @Produce json
46+
// @Param name query string true "Competition Name"
47+
// @Param about query string true "Some information about competition"
48+
// @Param prizes query string false "Competitions Prizes for the winners"
49+
// @Param starting_time query string true "Competition's starting time"
50+
// @Param ending_time query string true "Competition's ending time"
51+
// @Param timezone query string true "Competition's timezone"
52+
// @Param logo query string false "Competition's logo"
53+
// @Success 200 {object} api.HTTPPlainResp
54+
// @Failure 400 {object} api.HTTPPlainResp
55+
// @Failure 500 {object} api.HTTPErrorResp
56+
// @Router /api/config/competition-info [post]
3957
func updateCompetitionInfoHandler(c *gin.Context) {
58+
var logoFilePath string
59+
4060
name := c.PostForm("name")
4161
about := c.PostForm("about")
4262
prizes := c.PostForm("prizes")
@@ -45,17 +65,40 @@ func updateCompetitionInfoHandler(c *gin.Context) {
4565
timezone := c.PostForm("timezone")
4666
logo, err := c.FormFile("logo")
4767

48-
logoFilePath := ""
49-
5068
// The file cannot be received.
5169
if err != nil {
5270
log.Info("No file recieved from the user")
5371
} else {
54-
logoFilePath = filepath.Join(core.BEAST_GLOBAL_DIR, core.BEAST_ASSETS_DIR, logo.Filename)
72+
logoFilePath = filepath.Join(
73+
core.BEAST_GLOBAL_DIR,
74+
core.BEAST_ASSETS_DIR,
75+
core.BEAST_LOGO_DIR,
76+
logo.Filename,
77+
)
78+
79+
competitionInfo, err := config.GetCompetitionInfo()
80+
if err != nil {
81+
log.Info("Unable to load previous config")
82+
c.JSON(http.StatusInternalServerError, HTTPErrorResp{
83+
Error: fmt.Sprintf("Unable to load previous config: %s", err),
84+
})
85+
return
86+
}
87+
88+
// Delete previously uploaded logo file
89+
if competitionInfo.LogoURL != "" {
90+
if err := os.Remove(competitionInfo.LogoURL); err != nil {
91+
log.Info("Unable to delete previous logo file")
92+
c.JSON(http.StatusInternalServerError, HTTPErrorResp{
93+
Error: fmt.Sprintf("Unable to delete previous logo file: %s", err),
94+
})
95+
return
96+
}
97+
}
5598

5699
// The file is received, save it
57100
if err := c.SaveUploadedFile(logo, logoFilePath); err != nil {
58-
c.AbortWithStatusJSON(http.StatusInternalServerError, HTTPErrorResp{
101+
c.JSON(http.StatusInternalServerError, HTTPErrorResp{
59102
Error: fmt.Sprintf("Unable to save file: %s", err),
60103
})
61104
return

‎api/info.go

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ package api
33
import (
44
"fmt"
55
"net/http"
6+
"path/filepath"
67
"strconv"
8+
"strings"
79

810
"github.com/gin-gonic/gin"
911
"github.com/sdslabs/beastv4/core"
@@ -515,14 +517,15 @@ func competitionInfoHandler(c *gin.Context) {
515517
return
516518
}
517519

520+
logoPath := strings.ReplaceAll(competitionInfo.LogoURL, filepath.Join(core.BEAST_GLOBAL_DIR, core.BEAST_ASSETS_DIR, core.BEAST_LOGO_DIR), "")
518521
c.JSON(http.StatusOK, CompetitionInfoResp{
519522
Name: competitionInfo.Name,
520523
About: competitionInfo.About,
521524
Prizes: competitionInfo.Prizes,
522525
StartingTime: competitionInfo.StartingTime,
523526
EndingTime: competitionInfo.EndingTime,
524527
TimeZone: competitionInfo.TimeZone,
525-
LogoURL: "/api/info/logo",
528+
LogoURL: strings.Trim(logoPath, "/"),
526529
})
527530
return
528531
}

‎api/router.go

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@ package api
22

33
import (
44
"net/http"
5+
"path/filepath"
56
"time"
67

78
"github.com/gin-contrib/cors"
9+
"github.com/gin-contrib/static"
810
"github.com/gin-gonic/gin"
11+
"github.com/sdslabs/beastv4/core"
912
)
1013

1114
func dummyHandler(c *gin.Context) {
@@ -35,7 +38,10 @@ func initGinRouter() *gin.Engine {
3538
}
3639

3740
// For serving static files
38-
router.StaticFile("/api/info/logo", getLogoPath())
41+
router.Use(static.Serve("/api/info/logo", static.LocalFile(
42+
filepath.Join(core.BEAST_GLOBAL_DIR, core.BEAST_ASSETS_DIR, core.BEAST_LOGO_DIR),
43+
false)),
44+
)
3945
router.GET("/api/info/competition-info", competitionInfoHandler)
4046

4147
// API routes group

‎core/constants.go

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const ( //paths
4242
BEAST_STAGING_AREA_MOUNT_POINT string = "/beast"
4343
BEAST_UPLOADS_DIR string = "uploads"
4444
BEAST_ASSETS_DIR string = "assets"
45+
BEAST_LOGO_DIR string = "logo"
4546
)
4647

4748
const ( //chall types

‎go.mod

+1-6
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ require (
88
github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 // indirect
99
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
1010
github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 // indirect
11-
github.com/containerd/containerd v1.3.4 // indirect
1211
github.com/cpuguy83/go-md2man v1.0.10 // indirect
1312
github.com/cpuguy83/go-md2man/v2 v2.0.0 // indirect
1413
github.com/davecgh/go-spew v1.1.1 // indirect
@@ -22,11 +21,11 @@ require (
2221
github.com/erikstmartin/go-testdb v0.0.0-20160219214506-8d10e4a1bae5 // indirect
2322
github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 // indirect
2423
github.com/gin-contrib/cors v1.3.1
24+
github.com/gin-contrib/static v0.0.0-20200916080430-d45d9a37d28e
2525
github.com/gin-gonic/gin v1.5.0
2626
github.com/gliderlabs/ssh v0.1.1 // indirect
2727
github.com/go-openapi/spec v0.20.3 // indirect
2828
github.com/go-sql-driver/mysql v1.4.0
29-
github.com/gogo/protobuf v1.3.1 // indirect
3029
github.com/golang/protobuf v1.3.2
3130
github.com/google/go-cmp v0.2.0 // indirect
3231
github.com/inconshreveable/mousetrap v1.0.0 // indirect
@@ -39,8 +38,6 @@ require (
3938
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
4039
github.com/modern-go/reflect2 v1.0.1 // indirect
4140
github.com/onsi/gomega v1.4.2 // indirect
42-
github.com/opencontainers/go-digest v1.0.0-rc1 // indirect
43-
github.com/opencontainers/image-spec v1.0.1 // indirect
4441
github.com/pelletier/go-buffruneio v0.2.0 // indirect
4542
github.com/pkg/errors v0.8.0 // indirect
4643
github.com/pmezard/go-difflib v1.0.0 // indirect
@@ -62,8 +59,6 @@ require (
6259
google.golang.org/grpc v1.19.0
6360
gopkg.in/airbrake/gobrake.v2 v2.0.9 // indirect
6461
gopkg.in/gemnasium/logrus-airbrake-hook.v2 v2.1.2 // indirect
65-
gopkg.in/go-playground/assert.v1 v1.2.1 // indirect
66-
gopkg.in/go-playground/validator.v8 v8.18.2 // indirect
6762
gopkg.in/src-d/go-billy.v4 v4.3.0 // indirect
6863
gopkg.in/src-d/go-git-fixtures.v3 v3.3.0 // indirect
6964
gopkg.in/src-d/go-git.v4 v4.7.0

0 commit comments

Comments
 (0)