Skip to content

Commit

Permalink
Add ready API endpoint and temporarily "backport" to ping
Browse files Browse the repository at this point in the history
  • Loading branch information
dhaavi committed Apr 23, 2024
1 parent 20a72df commit b15a4aa
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
25 changes: 25 additions & 0 deletions api/endpoints_debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package api
import (
"bytes"
"context"
"errors"
"fmt"
"net/http"
"os"
Expand All @@ -11,6 +12,7 @@ import (
"time"

"github.com/safing/portbase/info"
"github.com/safing/portbase/modules"
"github.com/safing/portbase/utils/debug"
)

Expand All @@ -25,6 +27,16 @@ func registerDebugEndpoints() error {
return err
}

if err := RegisterEndpoint(Endpoint{
Path: "ready",
Read: PermitAnyone,
ActionFunc: ready,
Name: "Ready",
Description: "Check if Portmaster has completed starting and is ready.",
}); err != nil {
return err
}

if err := RegisterEndpoint(Endpoint{
Path: "debug/stack",
Read: PermitAnyone,
Expand Down Expand Up @@ -118,9 +130,22 @@ You can easily view this data in your browser with this command (with Go install

// ping responds with pong.
func ping(ar *Request) (msg string, err error) {
// TODO: Remove upgrade to "ready" when all UI components have transitioned.
if modules.IsStarting() || modules.IsShuttingDown() {
return "", ErrorWithStatus(errors.New("portmaster is not ready"), http.StatusTooEarly)
}

return "Pong.", nil
}

// ready checks if Portmaster has completed starting.
func ready(ar *Request) (msg string, err error) {
if modules.IsStarting() || modules.IsShuttingDown() {
return "", ErrorWithStatus(errors.New("portmaster is not ready"), http.StatusTooEarly)
}
return "Portmaster is ready.", nil
}

// getStack returns the current goroutine stack.
func getStack(_ *Request) (data []byte, err error) {
buf := &bytes.Buffer{}
Expand Down
5 changes: 5 additions & 0 deletions modules/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ func SetGlobalPrepFn(fn func() error) {
}
}

// IsStarting returns whether the initial global start is still in progress.
func IsStarting() bool {
return !initialStartCompleted.IsSet()
}

// Start starts all modules in the correct order. In case of an error, it will automatically shutdown again.
func Start() error {
if !modulesLocked.SetToIf(false, true) {
Expand Down

0 comments on commit b15a4aa

Please sign in to comment.