klesh commented on code in PR #7189:
URL:
https://github.com/apache/incubator-devlake/pull/7189#discussion_r1529968981
##########
backend/server/api/router.go:
##########
@@ -73,6 +73,9 @@ func RegisterRouter(r *gin.Engine, basicRes context.BasicRes)
{
r.DELETE("/projects/*projectName", project.DeleteProject)
r.POST("/projects", project.PostProject)
r.GET("/projects", project.GetProjects)
+ // on board api
+ r.GET("/store/:storeKey", project.GetStore)
+ r.PUT("/store/:storeKey", project.PutStore)
Review Comment:
It doesn't seem right to put a store API inside `project` package.
I think it would be better to create a new package like `store` alongside
the `project` package and put it there.
##########
backend/server/api/project/store.go:
##########
@@ -0,0 +1,79 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package project
+
+import (
+ "fmt"
+ "net/http"
+
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/models"
+ "github.com/apache/incubator-devlake/server/api/shared"
+ "github.com/apache/incubator-devlake/server/services"
+
+ "github.com/gin-gonic/gin"
+)
+
+// @Summary Get list of info by onboard
+// @Description GET onboard info
+// @Tags framework/projects
+// @Param storeKey path string true "storeKey"
+// @Success 200 {object} json.RawMessage
+// @Failure 400 {string} errcode.Error "Bad Request"
+// @Failure 500 {string} errcode.Error "Internal Error"
+// @Router /store/{storeKey} [get]
+func GetStore(c *gin.Context) {
+ storeKey := c.Param("storeKey")
+ result, err := services.GetStore(storeKey)
+ fmt.Println(err)
Review Comment:
please remove this
##########
backend/server/services/store.go:
##########
@@ -0,0 +1,75 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package services
+
+import (
+ "fmt"
+
+ "github.com/apache/incubator-devlake/core/dal"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/models"
+)
+
+// GetProjects returns a paginated list of Projects based on `query`
+func GetStore(storeKey string) (*models.Store, errors.Error) {
+ clauses := []dal.Clause{
+ dal.From(&models.Store{}),
+ dal.Where("store_key = ?", storeKey),
+ }
+
+ kvstore := &models.Store{}
+ err := db.All(&kvstore, clauses...)
+ if err != nil {
+ return nil, errors.Default.Wrap(err, fmt.Sprintf("error finding
%s on _devlake_store table", storeKey))
+ }
+
+ return kvstore, nil
+}
+
+// PutOnboard accepts a project instance and insert it to database
+func PutStore(storeKey string, storeValue *models.Store) (*models.Store,
errors.Error) {
+ // verify input
+ if err := VerifyStruct(storeValue); err != nil {
+ return nil, err
+ }
+
+ // create transaction to updte multiple tables
+ var err errors.Error
+ tx := db.Begin()
+ defer func() {
+ if r := recover(); r != nil || err != nil {
+ err = tx.Rollback()
+ if err != nil {
+ logger.Error(err, "PutStore: failed to
rollback")
+ }
+ }
+ }()
+
+ err = tx.CreateOrUpdate(storeValue, dal.Where("store_key = ?",
storeKey))
Review Comment:
Seems like there is only one db operation, the transaction doesn't make any
sense.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]