Skip to content

docs(design): convert hard tabs to spaces in SEA-1442 sentinels record #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
seal-agent wants to merge 1 commit into from
+17 −17
Open

docs(design): convert hard tabs to spaces in SEA-1442 sentinels record #289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/designs/platform/compass-runner-gateway-error-sentinels/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ sentinels and defaults everything else to INTERNAL:

> ```go
> func errorResult(id string, err error) *compassv1internal.SessionsRequest {
> code := compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_INTERNAL
> switch {
> case errors.Is(err, errAlreadyRunning):
> code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_ALREADY_RUNNING
> case errors.Is(err, errSessionUnknown):
> code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_NOT_FOUND
> }
> code := compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_INTERNAL
> switch {
> case errors.Is(err, errAlreadyRunning):
> code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_ALREADY_RUNNING
> case errors.Is(err, errSessionUnknown):
> code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_NOT_FOUND
> }
> ```

and the Server's `runnerErrorToConnect`
Expand All @@ -33,11 +33,11 @@ and the Server's `runnerErrorToConnect`
> ```go
> switch e.GetCode() {
> case compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_ALREADY_RUNNING:
> code = connect.CodeAlreadyExists
> code = connect.CodeAlreadyExists
> case compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_NOT_FOUND:
> code = connect.CodeNotFound
> code = connect.CodeNotFound
> default:
> code = connect.CodeInternal
> code = connect.CodeInternal
> }
> ```

Expand All @@ -46,7 +46,7 @@ The canonical operator-fault path is the socket-path-too-long check, a bare

> ```go
> if len(path) > sunPathMax {
> return nil, fmt.Errorf("agent socket path %q is %d bytes, over the %d-byte AF_UNIX limit: shorten the Runner's --runtime-dir or the agent account id", path, len(path), sunPathMax)
> return nil, fmt.Errorf("agent socket path %q is %d bytes, over the %d-byte AF_UNIX limit: shorten the Runner's --runtime-dir or the agent account id", path, len(path), sunPathMax)
> }
> ```

Expand Down Expand Up @@ -190,7 +190,7 @@ returns `serveSocket`'s error directly (`host.go:172-175`), landing at

```go
case errors.Is(err, gateway.ErrOperatorConfig):
code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_FAILED_PRECONDITION
code = compassv1internal.RunnerErrorCode_RUNNER_ERROR_CODE_FAILED_PRECONDITION
```

**Which socket.go paths qualify.** Classification rule: a failure is
Expand Down Expand Up @@ -267,11 +267,11 @@ before returning —

```go
func (d *dispatcher) errorResult(ctx context.Context, id string, err error) *compassv1internal.SessionsRequest {
// classify code as today, then log at a level chosen by class:
// context.Canceled / context.DeadlineExceeded -> skip (or Debug)
// INTERNAL -> Error
// classified operator/client-fault codes -> Warn
// build and return the result frame
// classify code as today, then log at a level chosen by class:
// context.Canceled / context.DeadlineExceeded -> skip (or Debug)
// INTERNAL -> Error
// classified operator/client-fault codes -> Warn
// build and return the result frame
}
```

Expand Down
Loading