Merge pull request #288 from dtm-labs/alpha

dashboard rename to admin

.github/workflows/release.yml

@@ -10,7 +10,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14
+        env:
+          host: 'ubuntu@en.dtm.pub'
+          dest: '/data/dtm-admin/'
+        run: |
+          cd admin
+          npm install -g yarn
+          yarn
+          VITE_ADMIN_VERSION=${GITHUB_REF#refs/*/} yarn build
+          echo "${{secrets.DEPLOY_KEY}}" > deploy_key
+          chmod 600 ./deploy_key
+          tar -cvzf dist.tar.gz dist
+          scp -i ../../deploy_key -o StrictHostKeyChecking=no dist.tar.gz ${{env.host}}:${{env.dest}}
+          ssh -i ../../deploy_key -o StrictHostKeyChecking=no ${{env.host}} 'cd ${{env.dest}} && tar -zvxf dist.tar.gz'
+          cd ..
 
       - name: Validates GO releaser config
         uses: docker://goreleaser/goreleaser:v1.7.0

.gitignore

@@ -1,7 +1,7 @@
 conf.yml
 *.out
 *.log
-dist
+# dist
 .idea/**
 .vscode
 default.etcd

admin/.env

@@ -0,0 +1 @@
+VITE_ADMIN_VERSION="v0.0.0-dev"

admin/dist/placeholder

@@ -0,0 +1 @@
+placeholder

admin/src/api/api_dtm.ts

@@ -0,0 +1,22 @@
+import { AxiosResponse } from 'axios'
+import request from '/@/utils/request'
+
+export interface IListAllTransactionsReq {
+    limit: number
+    position?: number
+}
+
+export function listAllTransactions<T>(payload: IListAllTransactionsReq): Promise<AxiosResponse<T>> {
+    return request({
+        url: '/api/dtmsvr/all',
+        method: 'get',
+        params: payload
+    })
+}
+
+export function getDtmVersion(): Promise<AxiosResponse<any>> {
+    return request({
+        url: '/api/dtmsvr/version',
+        method: 'get',
+    })
+}

dashboard/src/layout/aside.vue → admin/src/layout/aside.vue

@@ -4,6 +4,7 @@
             <Sidebar />
         </a-layout-sider>
         <a-layout style="padding: 0 24px 24px">
+            <div v-if="layout.dtmVersion && layout.dtmVersion != dashVer" style="color:#f00"> !!! admin version: {{dashVer}} != dtm version: {{layout.dtmVersion}}. </div>
             <a-breadcrumb style="margin: 16px 0">
                 <a-breadcrumb-item>{{ mainNav }}</a-breadcrumb-item>
                 <a-breadcrumb-item>{{ subNav }}</a-breadcrumb-item>
@@ -26,18 +27,21 @@ import { useLayoutStore } from '../store/modules/layout'
 import { IMenubarList } from '../type/store/layout'
 import { findCurrentMenubar } from '../utils/util'
 import { computed, onMounted, ref } from 'vue'
+import { getDtmVersion } from '../api/api_dtm'
 
+
+const dashVer = import.meta.env.VITE_ADMIN_VERSION
 const route = useRoute()
-const { getMenubar } = useLayoutStore()
+const layout = useLayoutStore()
 
 const mainNav = computed(() => {
-    const currentMenubar = findCurrentMenubar(getMenubar.menuList, true)
+    const currentMenubar = findCurrentMenubar(layout.getMenubar.menuList, true)
     return currentMenubar?.meta.title
 })
 
 const subNav = computed(() => {
     let subNav = ''
-    const currentMenubar = findCurrentMenubar(getMenubar.menuList, true)
+    const currentMenubar = findCurrentMenubar(layout.getMenubar.menuList, true)
     currentMenubar.children?.forEach(v => {
         if (route.path.indexOf(v.path) !== -1) {
             subNav = v.meta.title
@@ -49,17 +53,22 @@ const subNav = computed(() => {
 
 const page = computed(() => {
     let page = ''
-    const currentMenubar = findCurrentMenubar(getMenubar.menuList, true)
+    const currentMenubar = findCurrentMenubar(layout.getMenubar.menuList, true)
     currentMenubar.children?.forEach(v => {
         v.children?.forEach(vv => {
             if (route.path == vv.path) {
                 page = vv.meta.title
             }
         })
-    })   
+    })
 
     return page
 })
+
+onMounted(() => {
+    layout.loadDtmVersion()
+})
+
 </script>
 
 <style lang="postcss" scoped>

dashboard/src/layout/components/header.vue → admin/src/layout/components/header.vue

@@ -3,7 +3,7 @@
         <a-layout-header class="header flex">
             <div class="flex items-center logo h-16">
                 <svg-icon style="width: 36px; height: 36px; margin-right: 84px;" icon-class="svg-logo" />
-                <span class="text-gray-400 text-lg">DTM dashbaord {{ version }}</span>
+                <span class="text-gray-400 text-lg">DTM admin {{ version }}</span>
             </div>
             <a-menu
             v-model:selectedKeys="activeMenu"
@@ -25,8 +25,8 @@ import { useLayoutStore } from '/@/store/modules/layout'
 const route = useRoute()
 const router = useRouter()
 const { getMenubar, getCurrentVersion } = useLayoutStore()
-const firstRedirectPath = '/dashboard'
-const version = import.meta.env.VITE_DASHBOARD_VERSION
+const firstRedirectPath = '/admin'
+const version = import.meta.env.VITE_ADMIN_VERSION
 
 const activeMenu = ref([route.meta.activeMenu !== firstRedirectPath ? route.meta.activeMenu : '/'])
 

dashboard/src/router/index.ts → admin/src/router/index.ts

@@ -8,43 +8,43 @@ const Components: IObject<() => Promise<typeof import('*.vue')>> = Object.assign
 })
 
 export const allowRouter: Array<IMenubarList> = [
-    {
-    name: 'Dashboard',
+  {
+    name: 'Admin',
     path: '/',
-    redirect: '/dashboard/nodes/living',
+    redirect: '/admin/global-transactions/all',
     component: Components['LayoutHeader'],
-    meta: { title: 'Dashboard', activeMenu: '/dashboard' },
+    meta: { title: 'Admin', activeMenu: '/admin' },
     children: [
       {
         name: 'Nodes',
-        path: '/dashboard/nodes',
+        path: '/admin/nodes',
         component: Components['LayoutMain'],
         meta: { title: 'Nodes' },
         children: [
-            {
-                name: 'LivingNodes',
-                path: '/dashboard/nodes/living',
-                component: Components['LivingNodes'],
-                meta: { title: 'Living Nodes' },
-            }
+          {
+            name: 'LivingNodes',
+            path: '/admin/nodes/living',
+            component: Components['LivingNodes'],
+            meta: { title: 'Living Nodes' },
+          }
         ]
       }, {
         name: 'GlobalTransactions',
-        path: '/dashboard/global-transactions',
+        path: '/admin/global-transactions',
         component: Components['LayoutMain'],
         meta: { title: 'Global Transactions' },
         children: [
-            {
-                name: 'AllTransactions',
-                path: '/dashboard/global-transactions/all',
-                component: Components['AllTransactions'],
-                meta: { title: 'All Transactions' },
-            },  {
-                name: 'UnfinishedTransactions',
-                path: '/dashboard/global-transactions/unfinished',
-                component: Components['UnfinishedTransactions'],
-                meta: { title: 'Unfinished Transactions' },
-            }
+          {
+            name: 'AllTransactions',
+            path: '/admin/global-transactions/all',
+            component: Components['AllTransactions'],
+            meta: { title: 'All Transactions' },
+          }, {
+            name: 'UnfinishedTransactions',
+            path: '/admin/global-transactions/unfinished',
+            component: Components['UnfinishedTransactions'],
+            meta: { title: 'Unfinished Transactions' },
+          }
         ]
       }
     ]

dashboard/src/store/modules/layout.ts → admin/src/store/modules/layout.ts

@@ -1,16 +1,18 @@
 import { defineStore } from 'pinia';
 import { allowRouter } from '/@/router';
 import { ILayout, IMenubar, IMenubarList, IStatus } from '/@/type/store/layout';
+import { getDtmVersion } from '/@/api/api_dtm';
 
 export const useLayoutStore = defineStore({
     id: 'layout',
-    state: ():ILayout => ({
+    state: (): ILayout => ({
         menubar: {
             menuList: []
         },
         status: {
             isLoading: false
         },
+        dtmVersion: "",
     }),
     getters: {
         getMenubar(): IMenubar {
@@ -27,5 +29,10 @@ export const useLayoutStore = defineStore({
         concatAllowRoutes(): void {
             allowRouter.reverse().forEach(v => this.menubar.menuList.unshift(v))
         },
+        async loadDtmVersion(): Promise<void> {
+            const { data: { version } } = await getDtmVersion()
+            this.dtmVersion = version
+            console.log("dtm version: ", this.dtmVersion)
+        }
     }
 })

dashboard/src/type/index.d.ts → admin/src/type/index.d.ts

@@ -1,4 +1,4 @@
-export {}
+export { }
 declare global {
   interface IObject<T> {
     [index: string]: T
@@ -7,11 +7,11 @@ declare global {
     VITE_APP_TITLE: string
     VITE_PORT: number
     VITE_PROXY: string
-    VITE_DASHBOARD_VERSION: string
+    VITE_ADMIN_VERSION: string
   }
   interface ITable<T = any> {
-      data: Array<T>
-      next_position: number,
-      size: number
+    data: Array<T>
+    next_position: number,
+    size: number
   }
 }

dashboard/src/type/store/layout.ts → admin/src/type/store/layout.ts

@@ -1,14 +1,15 @@
 export interface IMenubar {
-    menuList: Array<IMenubarList>
+  menuList: Array<IMenubarList>
 }
 
 export interface ILayout {
-    menubar: IMenubar
-    status: IStatus
+  menubar: IMenubar
+  status: IStatus
+  dtmVersion: string
 }
 
 export interface IStatus {
-    isLoading: boolean
+  isLoading: boolean
 }
 
 export interface IMenubarList {
@@ -16,7 +17,7 @@ export interface IMenubarList {
   id?: number | string
   name: string
   path: string
-  redirect?: string 
+  redirect?: string
   meta: {
     icon?: string
     title: string

dashboard/src/utils/request.ts → admin/src/utils/request.ts

@@ -1,7 +1,6 @@
 import axios from 'axios'
 
 const request = axios.create({
-    baseURL: import.meta.env.VITE_APP_API_BASE_URL as string | undefined,
     timeout: 60000
 })
 

dashboard/vite.config.ts → admin/vite.config.ts

@@ -29,7 +29,7 @@ export default ({ }: ConfigEnv): UserConfigExport => {
         ],
         server: {
             port: 5000,
-            base: 'dashboard',
+            base: 'admin',
             proxy: {
                 '/api': {
                     target: 'http://localhost:36789',

dashboard/.env.development

@@ -1,3 +0,0 @@
-VITE_APP_API_BASE_URL="/api"
-VITE_PROXY=[["/api", "http://localhost:36789"]]
-VITE_DASHBOARD_VERSION="v0.0.0-dev"

dashboard/src/api/api_dtm.ts

@@ -1,15 +0,0 @@
-import { AxiosResponse } from 'axios'
-import request from '/@/utils/request'
-
-export interface IListAllTransactionsReq {
-    limit: number
-    position?: number
-}
-
-export function listAllTransactions<T>(payload:IListAllTransactionsReq):Promise<AxiosResponse<T>> {
-    return request({
-        url: '/dtmsvr/all',
-        method: 'get',
-        params: payload
-    })
-}

dtmsvr/api.go

@@ -15,6 +15,9 @@ import (
 	"github.com/dtm-labs/dtm/dtmsvr/storage"
 )
 
+// Version store the passin version for dtm server
+var Version = ""
+
 func svcSubmit(t *TransGlobal) interface{} {
 	t.Status = dtmcli.StatusSubmitted
 	branches, err := t.saveNew()

dtmsvr/api_http.go

@@ -19,6 +19,9 @@ import (
 )
 
 func addRoute(engine *gin.Engine) {
+	engine.GET("/api/dtmsvr/version", dtmutil.WrapHandler2(func(c *gin.Context) interface{} {
+		return gin.H{"version": Version}
+	}))
 	engine.GET("/api/dtmsvr/newGid", dtmutil.WrapHandler2(newGid))
 	engine.POST("/api/dtmsvr/prepare", dtmutil.WrapHandler2(prepare))
 	engine.POST("/api/dtmsvr/submit", dtmutil.WrapHandler2(submit))

dtmsvr/config/config.go

@@ -79,7 +79,8 @@ func (s *Store) GetDBConf() dtmcli.DBConf {
 	}
 }
 
-type configType struct {
+// Type is the type for the config of dtm server
+type Type struct {
 	Store                         Store            `yaml:"Store"`
 	TransCronInterval             int64            `yaml:"TransCronInterval" default:"3"`
 	TimeoutToFail                 int64            `yaml:"TimeoutToFail" default:"35"`
@@ -97,7 +98,7 @@ type configType struct {
 }
 
 // Config config
-var Config = configType{}
+var Config = Type{}
 
 // MustLoadConfig load config from env and file
 func MustLoadConfig(confFile string) {

dtmsvr/config/config_utils.go

@@ -58,7 +58,7 @@ func toUnderscoreUpper(key string) string {
 	return strings.ToUpper(s2)
 }
 
-func checkConfig(conf *configType) error {
+func checkConfig(conf *Type) error {
 	if conf.RetryInterval < 10 {
 		return errors.New("RetryInterval should not be less than 10")
 	}

dtmsvr/entry/main.go

@@ -14,13 +14,6 @@ import (
 	"go.uber.org/automaxprocs/maxprocs"
 )
 
-func ver(version *string) {
-	if *version == "" {
-		*version = "0.0.0-dev"
-	}
-	fmt.Printf("dtm version: %s\n", *version)
-}
-
 func usage() {
 	cmd := filepath.Base(os.Args[0])
 	s := "Usage: %s [options]\n\n"
@@ -35,14 +28,18 @@ var isReset = flag.Bool("r", false, "Reset dtm server data.")
 var confFile = flag.String("c", "", "Path to the server configuration file.")
 
 // Main is the entry point of dtm server.
-func Main(version *string) *gin.Engine {
+func Main(version *string) (*gin.Engine, *config.Type) {
 	flag.Parse()
+	if *version == "" {
+		*version = "v0.0.0-dev"
+	}
+	dtmsvr.Version = *version
 	if flag.NArg() > 0 || *isHelp {
 		usage()
-		return nil
+		return nil, nil
 	} else if *isVersion {
-		ver(version)
-		return nil
+		fmt.Printf("dtm version: %s\n", *version)
+		return nil, nil
 	}
 	logger.Infof("dtm version is: %s", *version)
 	config.MustLoadConfig(*confFile)
@@ -58,5 +55,5 @@ func Main(version *string) *gin.Engine {
 	registry.WaitStoreUp()
 	app := dtmsvr.StartSvr()       // start dtmsvr api
 	go dtmsvr.CronExpiredTrans(-1) // start dtmsvr cron job
-	return app
+	return app, &config.Config
 }

helper/Dockerfile-release

@@ -1,4 +1,11 @@
 # syntax=docker/dockerfile:1
+FROM node:14.5.0-alpine as bulder1
+ARG RELEASE_VERSION
+WORKDIR /app/dtm
+COPY . .
+RUN cd admin && yarn
+RUN VITE_ADMIN_VERSION=$RELEASE_VERSION yarn build
+
 FROM --platform=$TARGETPLATFORM golang:1.16-alpine as builder
 ARG TARGETARCH
 ARG TARGETOS
@@ -7,6 +14,7 @@ WORKDIR /app/dtm
 # RUN go env -w GOPROXY=https://mirrors.aliyun.com/goproxy/,direct
 EXPOSE 8080
 COPY . .
+COPY --from=bulder1 /app/dtm/admin/dist /app/dtm/admin
 RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -ldflags="-s -w -X main.Version=$RELEASE_VERSION"
 
 FROM --platform=$TARGETPLATFORM alpine

main.go

@@ -7,12 +7,16 @@
 package main
 
 import (
+	"embed"
 	"fmt"
+	"io/fs"
+	"io/ioutil"
 	"net/http"
 	"net/http/httputil"
 	"net/url"
 
 	"github.com/dtm-labs/dtm/dtmcli/logger"
+	"github.com/dtm-labs/dtm/dtmsvr/config"
 	"github.com/dtm-labs/dtm/dtmsvr/entry"
 	_ "github.com/dtm-labs/dtm/dtmsvr/microservices"
 	"github.com/gin-gonic/gin"
@@ -22,23 +26,51 @@ import (
 var Version string
 
 func main() {
-	app := entry.Main(&Version)
+	app, conf := entry.Main(&Version)
 	if app != nil {
-		addDashboard(app)
+		addAdmin(app, conf)
 		select {}
 	}
 }
-func addDashboard(app *gin.Engine) {
-	app.GET("/dashboard/*name", proxyDashboard)
-	app.GET("/@vite/*name", proxyDashboard)
-	app.GET("/node_modules/*name", proxyDashboard)
-	app.GET("/src/*name", proxyDashboard)
-	app.GET("/@id/*name", proxyDashboard)
+
+//go:embed admin/dist
+var admin embed.FS
+
+var target = "admin.dtm.pub"
+
+func getSub(f1 fs.FS, sub string) fs.FS {
+	f2, err := fs.Sub(f1, sub)
+	logger.FatalIfError(err)
+	return f2
+}
+func addAdmin(app *gin.Engine, conf *config.Type) {
+	// for released dtm, serve admin from local files because the build output has been embed
+	// for testing users, proxy admin to target because the build output has not been embed
+	dist := getSub(admin, "admin/dist")
+	index, err := dist.Open("index.html")
+	if err == nil {
+		cont, err := ioutil.ReadAll(index)
+		logger.FatalIfError(err)
+		_ = index.Close()
+		sfile := string(cont)
+		renderIndex := func(c *gin.Context) {
+			c.Header("content-type", "text/html;charset=utf-8")
+			c.String(200, sfile)
+		}
+		app.StaticFS("/assets", http.FS(getSub(dist, "assets")))
+		app.GET("/admin/*name", renderIndex)
+		app.GET("/", renderIndex)
+		logger.Infof("admin is served from dir 'admin/dist/'")
+	} else {
+		app.GET("/", proxyAdmin)
+		app.GET("/admin/*name", proxyAdmin)
+		logger.Infof("admin is proxied to %s", target)
+	}
+	logger.Infof("admin is running at: http://localhost:%d", conf.HTTPPort)
 }
 
-func proxyDashboard(c *gin.Context) {
+func proxyAdmin(c *gin.Context) {
 
-	target := "127.0.0.1:5000"
 	u := &url.URL{}
 	u.Scheme = "http"
 	u.Host = target
@@ -49,7 +81,7 @@ func proxyDashboard(c *gin.Context) {
 		ret := fmt.Sprintf("http proxy error %v", err)
 		_, _ = rw.Write([]byte(ret))
 	}
-	logger.Debugf("proxy dashboard to %s", target)
+	logger.Debugf("proxy admin to %s", target)
 	proxy.ServeHTTP(c.Writer, c.Request)
 
 }

test/api_test.go

@@ -18,6 +18,12 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func TestAPIVersion(t *testing.T) {
+	resp, err := dtmimp.RestyClient.R().Get(dtmutil.DefaultHTTPServer + "/version")
+	assert.Nil(t, err)
+	assert.Equal(t, 200, resp.StatusCode())
+}
+
 func TestAPIQuery(t *testing.T) {
 	gid := dtmimp.GetFuncName()
 	err := genMsg(gid).Submit()