-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
executor(engine): support openapi registration for job master (#5696)
ref #5689
- Loading branch information
1 parent
9a0bfd8
commit d0c1970
Showing
15 changed files
with
411 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| // Copyright 2022 PingCAP, Inc. | ||
| // | ||
| // Licensed 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, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package executor | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "strings" | ||
| "sync" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
|
|
||
| libModel "github.com/pingcap/tiflow/engine/lib/model" | ||
| ) | ||
|
|
||
| const jobAPIPrefix = "/api/v1/jobs/" | ||
|
|
||
| func jobAPIBasePath(jobID libModel.JobID) string { | ||
| return jobAPIPrefix + jobID + "/" | ||
| } | ||
|
|
||
| type jobAPIServer struct { | ||
| rwm sync.RWMutex | ||
| handlers map[libModel.JobID]http.Handler | ||
| } | ||
|
|
||
| func newJobAPIServer() *jobAPIServer { | ||
| return &jobAPIServer{ | ||
| handlers: make(map[libModel.JobID]http.Handler), | ||
| } | ||
| } | ||
|
|
||
| func (s *jobAPIServer) ServeHTTP(w http.ResponseWriter, r *http.Request) { | ||
| if h, ok := s.match(r.URL.Path); ok { | ||
| h.ServeHTTP(w, r) | ||
| } else { | ||
| http.NotFound(w, r) | ||
| } | ||
| } | ||
|
|
||
| func (s *jobAPIServer) match(path string) (http.Handler, bool) { | ||
| if !strings.HasPrefix(path, jobAPIPrefix) { | ||
| return nil, false | ||
| } | ||
| path = strings.TrimPrefix(path, jobAPIPrefix) | ||
| fields := strings.SplitN(path, "/", 2) | ||
| if len(fields) != 2 { | ||
| return nil, false | ||
| } | ||
| JobID := fields[0] | ||
| s.rwm.RLock() | ||
| h, ok := s.handlers[JobID] | ||
| s.rwm.RUnlock() | ||
| return h, ok | ||
| } | ||
|
|
||
| func (s *jobAPIServer) initialize(jobID libModel.JobID, f func(apiGroup *gin.RouterGroup)) { | ||
| engine := gin.New() | ||
| apiGroup := engine.Group(jobAPIBasePath(jobID)) | ||
| f(apiGroup) | ||
|
|
||
| s.rwm.Lock() | ||
| s.handlers[jobID] = engine | ||
| s.rwm.Unlock() | ||
| } | ||
|
|
||
| func (s *jobAPIServer) listenStoppedJobs(ctx context.Context, stoppedJobs <-chan libModel.JobID) error { | ||
| for { | ||
| select { | ||
| case jobID, ok := <-stoppedJobs: | ||
| if !ok { | ||
| return nil | ||
| } | ||
| s.rwm.Lock() | ||
| delete(s.handlers, jobID) | ||
| s.rwm.Unlock() | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| // Copyright 2022 PingCAP, Inc. | ||
| // | ||
| // Licensed 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, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package executor | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "sync" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/gin-gonic/gin" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| libModel "github.com/pingcap/tiflow/engine/lib/model" | ||
| ) | ||
|
|
||
| func TestJobAPIServer(t *testing.T) { | ||
| jobAPISrv := newJobAPIServer() | ||
|
|
||
| jobAPISrv.initialize("job1", func(apiGroup *gin.RouterGroup) { | ||
| apiGroup.GET("/status", func(c *gin.Context) { | ||
| c.String(http.StatusOK, "job1 status") | ||
| }) | ||
| }) | ||
| jobAPISrv.initialize("job2", func(apiGroup *gin.RouterGroup) { | ||
| apiGroup.GET("/status", func(c *gin.Context) { | ||
| c.String(http.StatusOK, "job2 status") | ||
| }) | ||
| }) | ||
|
|
||
| // test job1 | ||
| { | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest("GET", "/api/v1/jobs/job1/status", nil) | ||
| jobAPISrv.ServeHTTP(w, r) | ||
| require.Equal(t, http.StatusOK, w.Code) | ||
| require.Equal(t, "job1 status", w.Body.String()) | ||
| } | ||
| // test job2 | ||
| { | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest("GET", "/api/v1/jobs/job2/status", nil) | ||
| jobAPISrv.ServeHTTP(w, r) | ||
| require.Equal(t, http.StatusOK, w.Code) | ||
| require.Equal(t, "job2 status", w.Body.String()) | ||
| } | ||
| // test not found | ||
| { | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest("GET", "/api/v1/jobs/job3/status", nil) | ||
| jobAPISrv.ServeHTTP(w, r) | ||
| require.Equal(t, http.StatusNotFound, w.Code) | ||
| } | ||
|
|
||
| wg := sync.WaitGroup{} | ||
| stoppedJobs := make(chan libModel.JobID, 16) | ||
| wg.Add(1) | ||
| go func() { | ||
| defer wg.Done() | ||
| err := jobAPISrv.listenStoppedJobs(context.Background(), stoppedJobs) | ||
| require.NoError(t, err) | ||
| }() | ||
|
|
||
| stoppedJobs <- "job1" | ||
| require.Eventually(t, func() bool { | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest("GET", "/api/v1/jobs/job1/status", nil) | ||
| jobAPISrv.ServeHTTP(w, r) | ||
| return w.Code == http.StatusNotFound | ||
| }, time.Second, time.Millisecond*100) | ||
|
|
||
| stoppedJobs <- "job2" | ||
| require.Eventually(t, func() bool { | ||
| w := httptest.NewRecorder() | ||
| r := httptest.NewRequest("GET", "/api/v1/jobs/job2/status", nil) | ||
| jobAPISrv.ServeHTTP(w, r) | ||
| return w.Code == http.StatusNotFound | ||
| }, time.Second, time.Millisecond*100) | ||
|
|
||
| close(stoppedJobs) | ||
| wg.Wait() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.