style(gateway): polish gateway code style (#49)

Co-authored-by: will-2012-nr <will.nodereal@gmail.com>

model/const.go

@@ -25,3 +25,36 @@ const (
 	// server and client max send or recv msg size
 	MaxCallMsgSize = 40 * 1024 * 1024
 )
+
+// Gateway
+const (
+	// path
+	AdminPath          = "/greenfield/admin/v1/"
+	GetApprovalSubPath = "get-approval"
+
+	// query key
+	TransactionQuery = "transaction"
+	PutObjectV2Query = "putobjectv2"
+	ActionQuery      = "action"
+
+	// bfs header key
+	BFSRequestIDHeader       = "X-Bfs-Request-ID"
+	BFSContentLengthHeader   = "X-Bfs-Content-Length"
+	BFSContentTypeHeader     = "X-Bfs-Content-Type"
+	BFSChecksumHeader        = "X-Bfs-Checksum"
+	BFSIsPrivateHeader       = "X-Bfs-Is-Private"
+	BFSTransactionHashHeader = "X-Bfs-Txn-Hash"
+	BFSResourceHeader        = "X-Bfs-Resource"
+	BFSPreSignatureHeader    = "X-Bfs-Pre-Signature"
+	// BFSRedundancyTypeHeader can be EC or Replica, EC is default
+	BFSRedundancyTypeHeader = "X-Bfs-Redundancy-Type"
+
+	// http header key
+	ContentTypeHeader   = "Content-Type"
+	ETagHeader          = "ETag"
+	ContentLengthHeader = "Content-Length"
+
+	// header value
+	ContentTypeXMLHeaderValue        = "application/xml"
+	ReplicaRedundancyTypeHeaderValue = "Replica"
+)

service/gateway/admin_handler.go

@@ -4,6 +4,7 @@ import (
 	"encoding/hex"
 	"net/http"
 
+	"github.com/bnb-chain/inscription-storage-provider/model"
 	"github.com/bnb-chain/inscription-storage-provider/util/log"
 )
 
@@ -12,42 +13,42 @@ func (g *Gateway) getAuthenticationHandler(w http.ResponseWriter, r *http.Reques
 	var (
 		err              error
 		errorDescription *errorDescription
-		reqCtx           *requestContext
-		opt              *getAuthenticationOption
+		requestContext   *requestContext
+		option           *getAuthenticationOption
 	)
 
 	defer func() {
 		statusCode := 200
 		if errorDescription != nil {
 			statusCode = errorDescription.statusCode
-			_ = errorDescription.errorResponse(w, reqCtx)
+			_ = errorDescription.errorResponse(w, requestContext)
 		}
 		if statusCode == 200 {
-			log.Infof("action(%v) statusCode(%v) %v", "getAuthentication", statusCode, generateRequestDetail(reqCtx))
+			log.Infof("action(%v) statusCode(%v) %v", "getAuthentication", statusCode, generateRequestDetail(requestContext))
 		} else {
-			log.Warnf("action(%v) statusCode(%v) %v", "getAuthentication", statusCode, generateRequestDetail(reqCtx))
+			log.Warnf("action(%v) statusCode(%v) %v", "getAuthentication", statusCode, generateRequestDetail(requestContext))
 		}
 	}()
 
-	reqCtx = newRequestContext(r)
-	if reqCtx.bucket == "" {
+	requestContext = newRequestContext(r)
+	if requestContext.bucketName == "" {
 		errorDescription = InvalidBucketName
 		return
 	}
 
-	if err := reqCtx.verifySign(); err != nil {
+	if err := requestContext.verifySign(); err != nil {
 		errorDescription = SignatureDoesNotMatch
 		return
 	}
 
-	opt = &getAuthenticationOption{
-		reqCtx: reqCtx,
+	option = &getAuthenticationOption{
+		requestContext: requestContext,
 	}
-	info, err := g.uploadProcessor.getAuthentication(opt)
+	info, err := g.uploadProcessor.getAuthentication(option)
 	if err != nil {
 		errorDescription = InternalError
 		return
 	}
-	w.Header().Set(BFSRequestIDHeader, reqCtx.requestID)
-	w.Header().Set(BFSPreSignatureHeader, hex.EncodeToString(info.preSignature))
+	w.Header().Set(model.BFSRequestIDHeader, requestContext.requestID)
+	w.Header().Set(model.BFSPreSignatureHeader, hex.EncodeToString(info.preSignature))
 }

service/gateway/bucket_handler.go

@@ -15,36 +15,36 @@ func (g *Gateway) createBucketHandler(w http.ResponseWriter, r *http.Request) {
 	var (
 		err              error
 		errorDescription *errorDescription
-		reqCtx           *requestContext
+		requestContext   *requestContext
 	)
 
 	defer func() {
 		statusCode := 200
 		if errorDescription != nil {
 			statusCode = errorDescription.statusCode
-			_ = errorDescription.errorResponse(w, reqCtx)
+			_ = errorDescription.errorResponse(w, requestContext)
 		}
 		if statusCode == 200 {
-			log.Infof("action(%v) statusCode(%v) %v", "createBucket", statusCode, generateRequestDetail(reqCtx))
+			log.Infof("action(%v) statusCode(%v) %v", "createBucket", statusCode, generateRequestDetail(requestContext))
 		} else {
-			log.Warnf("action(%v) statusCode(%v) %v", "createBucket", statusCode, generateRequestDetail(reqCtx))
+			log.Warnf("action(%v) statusCode(%v) %v", "createBucket", statusCode, generateRequestDetail(requestContext))
 		}
 	}()
 
-	reqCtx = newRequestContext(r)
-	if reqCtx.bucket == "" {
+	requestContext = newRequestContext(r)
+	if requestContext.bucketName == "" {
 		errorDescription = InvalidBucketName
 		return
 	}
-	if err := reqCtx.verifySign(); err != nil {
+	if err := requestContext.verifySign(); err != nil {
 		errorDescription = SignatureDoesNotMatch
 		return
 	}
 
-	var opt = &createBucketOption{
-		reqCtx: reqCtx,
+	option := &createBucketOption{
+		requestContext: requestContext,
 	}
-	err = g.chain.createBucket(reqCtx.bucket, opt)
+	err = g.chain.createBucket(requestContext.bucketName, option)
 	if err != nil {
 		if err == errors.ErrDuplicateBucket {
 			errorDescription = BucketAlreadyExists

service/gateway/chain_client.go

@@ -10,7 +10,7 @@ import (
 
 // createBucketOption is the createBucket option.
 type createBucketOption struct {
-	reqCtx *requestContext
+	requestContext *requestContext
 }
 
 // chainClientInterface define some interfaces to maintain metadata in the blockchain.
@@ -57,13 +57,18 @@ type chainClientConfig struct {
 	DebugDir string
 }
 
+var defaultChainClientConfig = &chainClientConfig{
+	Mode:     "DebugMode",
+	DebugDir: "./debug",
+}
+
 // chainClient is a wrapper of maintaining metadata in the blockchain.
 // todo: impl of call UpdateChainService, forward msg to blockchain.
 type chainClient struct {
 	impl chainClientInterface
 }
 
-func newChainClient(c chainClientConfig) (*chainClient, error) {
+func newChainClient(c *chainClientConfig) (*chainClient, error) {
 	switch {
 	case c.Mode == "DebugMode":
 		if c.DebugDir == "" {

service/gateway/download_processor.go

@@ -15,9 +15,9 @@ import (
 
 // getObjectOption is the getObject Option.
 type getObjectOption struct {
-	reqCtx *requestContext
-	offset uint64
-	length uint64
+	requestContext *requestContext
+	offset         uint64
+	length         uint64
 }
 
 // downloaderClientInterface define interface to download object.
@@ -31,10 +31,10 @@ type debugDownloaderImpl struct {
 }
 
 // getObject is used to get object data from local directory file for debugging.
-func (ddl *debugDownloaderImpl) getObject(name string, writer io.Writer, option *getObjectOption) error {
+func (ddl *debugDownloaderImpl) getObject(objectName string, writer io.Writer, option *getObjectOption) error {
 	var (
-		bucketDir      = ddl.localDir + "/" + option.reqCtx.bucket
-		objectDataFile = bucketDir + "/" + name + ".data"
+		bucketDir      = ddl.localDir + "/" + option.requestContext.bucketName
+		objectDataFile = bucketDir + "/" + objectName + ".data"
 		buf            = make([]byte, 65536)
 		readN, writeN  int
 		size           uint64
@@ -93,13 +93,19 @@ type downloadProcessorConfig struct {
 	Address  string
 }
 
+var defaultDownloadProcessorConfig = &downloadProcessorConfig{
+	Mode:     "DebugMode",
+	DebugDir: "./debug",
+	Address:  "127.0.0.1:5523",
+}
+
 // downloaderClient is a wrapper of download object.
 type downloadProcessor struct {
 	impl downloaderClientInterface
 }
 
 // newDownloaderClient return a downloader wrapper.
-func newDownloadProcessor(c downloadProcessorConfig) (*downloadProcessor, error) {
+func newDownloadProcessor(c *downloadProcessorConfig) (*downloadProcessor, error) {
 	switch {
 	case c.Mode == "DebugMode":
 		return &downloadProcessor{impl: &debugDownloaderImpl{localDir: c.DebugDir}}, nil
@@ -115,8 +121,8 @@ func newDownloadProcessor(c downloadProcessorConfig) (*downloadProcessor, error)
 }
 
 // getObject get object from downloader.
-func (dc *downloadProcessor) getObject(name string, writer io.Writer, option *getObjectOption) error {
-	return dc.impl.getObject(name, writer, option)
+func (dc *downloadProcessor) getObject(objectName string, writer io.Writer, option *getObjectOption) error {
+	return dc.impl.getObject(objectName, writer, option)
 }
 
 // grpcDownloaderImpl is an implement of call grpc downloader service.
@@ -125,17 +131,17 @@ type grpcDownloaderImpl struct {
 }
 
 // getObject get object from downloader.
-func (d *grpcDownloaderImpl) getObject(name string, writer io.Writer, option *getObjectOption) error {
+func (d *grpcDownloaderImpl) getObject(objectName string, writer io.Writer, option *getObjectOption) error {
 	var (
 		err           error
 		readN, writeN int
 		size          int
 	)
 
 	req := &service.DownloaderServiceDownloaderObjectRequest{
-		TraceId:    option.reqCtx.requestID,
-		BucketName: option.reqCtx.bucket,
-		ObjectName: option.reqCtx.object,
+		TraceId:    option.requestContext.requestID,
+		BucketName: option.requestContext.bucketName,
+		ObjectName: objectName,
 	}
 	ctx := log.Context(context.Background(), req)
 	defer func() {

service/gateway/gateway.go

@@ -39,7 +39,7 @@ func NewGatewayService(cfg *GatewayConfig) (*Gateway, error) {
 		config: cfg,
 		name:   ServiceNameGateway,
 	}
-	if g.uploadProcessor, err = newUploadProcessor(&g.config.UploaderConfig); err != nil {
+	if g.uploadProcessor, err = newUploadProcessor(g.config.UploaderConfig); err != nil {
 		log.Warnw("failed to create uploader", "err", err)
 		return nil, err
 	}

service/gateway/gateway_config.go

@@ -3,26 +3,15 @@ package gateway
 type GatewayConfig struct {
 	Address          string
 	Domain           string
-	UploaderConfig   uploadProcessorConfig
-	ChainConfig      chainClientConfig
-	DownloaderConfig downloadProcessorConfig
+	UploaderConfig   *uploadProcessorConfig
+	ChainConfig      *chainClientConfig
+	DownloaderConfig *downloadProcessorConfig
 }
 
 var DefaultGatewayConfig = &GatewayConfig{
-	Address: "127.0.0.1:5310",
-	Domain:  "bfs.nodereal.com",
-	UploaderConfig: struct {
-		Mode     string
-		DebugDir string
-		Address  string
-	}{Mode: "DebugMode", DebugDir: "./debug", Address: ""},
-	ChainConfig: struct {
-		Mode     string
-		DebugDir string
-	}{Mode: "DebugMode", DebugDir: "./debug"},
-	DownloaderConfig: struct {
-		Mode     string
-		DebugDir string
-		Address  string
-	}{Mode: "DebugMode", DebugDir: "./debug", Address: "127.0.0.1:5523"},
+	Address:          "127.0.0.1:5310",
+	Domain:           "bfs.nodereal.com",
+	UploaderConfig:   defaultUploadProcessorConfig,
+	ChainConfig:      defaultChainClientConfig,
+	DownloaderConfig: defaultDownloadProcessorConfig,
 }