Merge branch 'master' into reduce-test-time

.github/workflows/lint.yml

@@ -11,9 +11,24 @@ jobs:
       - name: 🚀 Use Node.js
         uses: actions/[email protected]
         with:
-          node-version: '12.x'
+          node-version: '14.x'
       - run: npm install -g [email protected]
       - run: markdownlint '**/*.md' --ignore node_modules
+  misspell:
+    name: runner/misspell
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code.
+        uses: actions/checkout@v1
+      - name: Install
+        run: |
+          wget -O - -q https://git.io/misspell | sh -s -- -b .
+      - name: Misspell
+        run: |
+          find . -type f -maxdepth 1 | xargs ./misspell -error
+          find . -name "*.go" -type f | xargs ./misspell -error
+          find docs -type f | xargs ./misspell -error
+          find web/src web/cypress -type f | xargs ./misspell -error
   yamllint:
     name: 🍏 YAML
     runs-on: ubuntu-latest
@@ -29,4 +44,12 @@ jobs:
           pip install yamllint
       - name: 🧹 YAML Lint
         run: |
-          yamllint .
+          # return non-zero exit code on warnings
+          yamllint --strict .
+  trailing-whitespace:
+    name: Trailing whitespace
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Check for trailing whitespace
+        run: "! git grep -EIn $'[ \t]+$'"

CHANGELOG.md

@@ -19,6 +19,7 @@
 
 # Table of Contents
 
+- [2.4.0](#240)
 - [2.3.0](#230)
 - [2.2.0](#220)
 - [2.1.1](#211)
@@ -27,6 +28,51 @@
 - [1.5.0](#150)
 - [1.0.0](#100)
 
+# 2.4.0
+
+This release mainly improves basic features, bugfix and adds test cases.
+
+`Manager API` 2.4 should be used with [Apache APISIX 2.3](https://github.com/apache/apisix/releases/tag/2.3). It is not recommended to use with other Apache APISIX versions.
+
+### Core
+
+- Support to show warning notification when dashboard version not matching apisix. [#1435](https://github.com/apache/apisix-dashboard/pull/1435)
+- Support mTLS connection to ETCD. [#1437](https://github.com/apache/apisix-dashboard/pull/1437)
+- Support IP allow list. [#1424](https://github.com/apache/apisix-dashboard/pull/1424)
+- Support to get manager-api version through API. [#1429](https://github.com/apache/apisix-dashboard/pull/1429)
+- Support import route from OpenAPI specification3.0. [#1102](https://github.com/apache/apisix-dashboard/pull/1102)
+- Support export route from OpenAPI specification3.0. [#1245](https://github.com/apache/apisix-dashboard/pull/1245)
+- Support string type for the script field in Route. [#1289](https://github.com/apache/apisix-dashboard/pull/1289)
+- Feat: add script_id field in Route.entity. [#1386](https://github.com/apache/apisix-dashboard/pull/1386)
+- Feat: add stop subcommand. [#741](https://github.com/apache/apisix-dashboard/pull/741)
+- Feat: add e2e test coverage. [#1270](https://github.com/apache/apisix-dashboard/pull/1270)
+- Feat: add returning value for HTTP PUT and PATCH methods. [#1322](https://github.com/apache/apisix-dashboard/pull/1322)
+- Feat: user can skip upstream when select service_id [#1302](https://github.com/apache/apisix-dashboard/pull/1302)
+
+### Bugfix
+
+- Fix: add defer recover for goroutines to prevent abnormal crash. [#1419](https://github.com/apache/apisix-dashboard/pull/1419)
+- Fix: add version ldflags when building manager-api in Dockerfile. [#1393](https://github.com/apache/apisix-dashboard/pull/1393)
+- Fix: Upgrade gjson and protobuf to avoid security problem. [#1366](https://github.com/apache/apisix-dashboard/pull/1366)
+- Fix: Incomplete label display. [#1252](https://github.com/apache/apisix-dashboard/pull/1252)
+- Fix: Redirect plugin should not show in route step3 [#1276](https://github.com/apache/apisix-dashboard/pull/1276)
+- Fix: Editing a Service, the upstream info will be lost. [#1347](https://github.com/apache/apisix-dashboard/pull/1347)
+
+### Test Case
+
+- Use ginkgo framwork to do backend E2E testing. [#1319](https://github.com/apache/apisix-dashboard/pull/1319)
+- Add action to check the version for release. [#1418](https://github.com/apache/apisix-dashboard/pull/1418)
+- Add test for make build. [#1421](https://github.com/apache/apisix-dashboard/pull/1421)
+- Remove the etcd dependency in part of unit test. [#1169](https://github.com/apache/apisix-dashboard/pull/1469)
+- Skip Cypress binary install when build. [#1248](https://github.com/apache/apisix-dashboard/pull/1248)
+- Enhance plugin schema smoke test [#1261](https://github.com/apache/apisix-dashboard/pull/1261)
+- Delete unnecessary wait in front-end test. [#1370](https://github.com/apache/apisix-dashboard/pull/1370)
+- Add edit the plugin testcase [#1372](https://github.com/apache/apisix-dashboard/pull/1372)
+
+### Doc
+
+- Doc: add document for introducing bakend e2e test. [#1381](https://github.com/apache/apisix-dashboard/pull/1381)
+
 # 2.3.0
 
 ### Core

Makefile

@@ -33,7 +33,7 @@ help:
 	@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/   /'
 
 
-### build:		Build Apache APISIX Dashboard, it contains web and manager-api
+### build:		Build the Apache APISIX Dashboard, including web and manager-api
 .PHONY: build
 build: web-default api-default
 	api/build.sh && cd ./web && export CYPRESS_INSTALL_BINARY=0  && yarn install && yarn build  && mkdir -p ../output/logs
@@ -55,7 +55,7 @@ ifeq ("$(wildcard $(GO_EXEC))", "")
 endif
 
 
-### dag-lib:            get dag-lib
+### dag-lib:            Download the dag-lib
 .PHONY: dag-lib
 dag-lib:
 ifeq ("$(wildcard api/dag-to-lua/dag-to-lua.lua)", "")
@@ -72,7 +72,7 @@ api-test: api-default dag-lib
 	cd api/ && APISIX_API_WORKDIR=$$PWD ENV=test go test -v -count=1 -race -cover -coverprofile=coverage.txt -covermode=atomic ./...
 
 
-### api-run:		Run the manager-api
+### api-run:		Run the manager-api in develop mode
 .PHONY: api-run
 api-run: api-default
 	api/build.sh --dry-run
@@ -82,7 +82,7 @@ api-run: api-default
 api-stop:
 	cd api && go run -ldflags "${GOLDFLAGS}" ./cmd/manager stop
 
-### go-lint:		Lint Go source code
+### go-lint:		Lint Go source codes
 .PHONY: go-lint
 go-lint: ## Run the golangci-lint application (install if not found)
 	@#Brew - MacOS
@@ -93,7 +93,7 @@ go-lint: ## Run the golangci-lint application (install if not found)
 	@cd api && golangci-lint run --tests=false ./...
 
 
-### license-check:	Check Apache APISIX Dashboard Source Codes for Apache License
+### license-check:	Check source codes for Apache License
 .PHONY: license-check
 license-check:
 ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
@@ -103,7 +103,7 @@ endif
 	.actions/openwhisk-utilities/scancode/scanCode.py --config .actions/ASF-Release.cfg ./
 
 
-### release-src: Package Apache APISIX Dashboard source codes for release
+### release-src:        Package source codes for release
 .PHONY: release-src
 release-src:
 	./utils/version-check.sh ${VERSION}

README.md

@@ -31,7 +31,7 @@
 
 - The master version should be used with Apache APISIX master version.
 
-- The latest released version is [2.3](https://apisix.apache.org/downloads/) and should be used with [Apache APISIX 2.2](https://apisix.apache.org/downloads/). It is not recommended to use with other Apache APISIX versions.
+- The latest released version is [2.4](https://apisix.apache.org/downloads/) and should be used with [Apache APISIX 2.3](https://apisix.apache.org/downloads/). It is not recommended to use with other Apache APISIX versions.
 
 ## What's Apache APISIX Dashboard
 

api/VERSION

@@ -1 +1 @@
-2.3
+2.4

api/internal/handler/data_loader/route_export_test.go

@@ -304,13 +304,13 @@ func TestExportRoutesCreateByServiceId(t *testing.T) {
 			"version":"v2"
 		},
 		"enable_websocket":true,
-		"plugins": { 
-			"limit-count": { 
-				"count": 100, 
-				"time_window": 60, 
-				"rejected_code": 503, 
-				"key": "remote_addr" 
-			} 
+		"plugins": {
+			"limit-count": {
+				"count": 100,
+				"time_window": 60,
+				"rejected_code": 503,
+				"key": "remote_addr"
+			}
 		},
 		"upstream": {
 			"type": "roundrobin",
@@ -399,7 +399,7 @@ func TestExportRoutesCreateByServiceId2(t *testing.T) {
 		"uri": "/hello",
 		"service_id": "s1",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}
@@ -424,13 +424,13 @@ func TestExportRoutesCreateByServiceId2(t *testing.T) {
 			"version":"v2"
 		},
 		"enable_websocket":true,
-		"plugins": { 
-			"limit-count": { 
-				"count": 100, 
-				"time_window": 60, 
-				"rejected_code": 503, 
-				"key": "remote_addr" 
-			} 
+		"plugins": {
+			"limit-count": {
+				"count": 100,
+				"time_window": 60,
+				"rejected_code": 503,
+				"key": "remote_addr"
+			}
 		},
 		"upstream": {
 			"type": "roundrobin",
@@ -539,13 +539,13 @@ func TestExportRoutesCreateByServiceId3(t *testing.T) {
 			"version":"v2"
 		},
 		"enable_websocket":true,
-		"plugins": { 
-			"limit-count": { 
-				"count": 100, 
-				"time_window": 60, 
-				"rejected_code": 503, 
-				"key": "remote_addr" 
-			} 
+		"plugins": {
+			"limit-count": {
+				"count": 100,
+				"time_window": 60,
+				"rejected_code": 503,
+				"key": "remote_addr"
+			}
 		},
 		"upstream_id": "u1"
 	}`
@@ -555,7 +555,7 @@ func TestExportRoutesCreateByServiceId3(t *testing.T) {
 		"uri": "/hello",
 		"service_id": "s1",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}
@@ -669,7 +669,7 @@ func TestExportRoutesCreateByUpstreamId(t *testing.T) {
 		"methods": ["GET"],
 		"uri": "/hello",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}
@@ -766,13 +766,13 @@ func TestExportRoutesCreateByUpstreamIdandServiceId(t *testing.T) {
 			"version":"v2"
 		},
 		"enable_websocket":true,
-		"plugins": { 
-			"limit-count": { 
-				"count": 100, 
-				"time_window": 60, 
-				"rejected_code": 503, 
-				"key": "remote_addr" 
-			} 
+		"plugins": {
+			"limit-count": {
+				"count": 100,
+				"time_window": 60,
+				"rejected_code": 503,
+				"key": "remote_addr"
+			}
 		},
 		"upstream_id": "u1"
 	}`
@@ -793,7 +793,7 @@ func TestExportRoutesCreateByUpstreamIdandServiceId(t *testing.T) {
 		],
 		"uri": "/hello",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}
@@ -923,7 +923,7 @@ func TestExportRoutesCreateByServiceIdNoUpstream(t *testing.T) {
 		],
 		"uri": "/hello",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}
@@ -1110,8 +1110,8 @@ func TestExportRoutesCreateByLabel2(t *testing.T) {
 		"desc": "testservice_desc",
 		"enable_websocket":true,
 		"labels": {
-			"build": "16", 
-			"env": "production", 
+			"build": "16",
+			"env": "production",
 			"version": "v2"
 		}
 	}`
@@ -1628,7 +1628,7 @@ func TestExportRoutesCreateByUpstreamIDAndServiceID2(t *testing.T) {
 		],
 		"uri": "/hello",
 		"enable_websocket":false,
-		"plugins": { 
+		"plugins": {
 			"prometheus": {
 				"disable": false
 			}