2018-05-22 19:43:36 +00:00
|
|
|
|
// Copyright 2016-2018, Pulumi Corporation.
|
|
|
|
|
//
|
|
|
|
|
// 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,
|
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
|
// limitations under the License.
|
2017-06-21 17:31:06 +00:00
|
|
|
|
|
|
|
|
|
package provider
|
|
|
|
|
|
|
|
|
|
import (
|
2023-01-06 22:39:16 +00:00
|
|
|
|
"io"
|
2021-10-06 16:10:00 +00:00
|
|
|
|
"os"
|
2020-06-17 19:30:59 +00:00
|
|
|
|
"strings"
|
2017-06-21 17:31:06 +00:00
|
|
|
|
|
2021-03-17 13:20:05 +00:00
|
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/diag"
|
|
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
|
|
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
|
|
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/util/rpcutil"
|
2024-01-17 14:56:37 +00:00
|
|
|
|
pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
|
2020-06-17 19:30:59 +00:00
|
|
|
|
"golang.org/x/net/context"
|
|
|
|
|
"google.golang.org/grpc"
|
2023-01-11 19:54:31 +00:00
|
|
|
|
"google.golang.org/grpc/credentials/insecure"
|
2021-10-06 16:10:00 +00:00
|
|
|
|
"google.golang.org/grpc/grpclog"
|
2017-06-21 17:31:06 +00:00
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// HostClient is a client interface into the host's engine RPC interface.
|
|
|
|
|
type HostClient struct {
|
|
|
|
|
conn *grpc.ClientConn
|
2024-01-17 14:56:37 +00:00
|
|
|
|
client pulumirpc.EngineClient
|
2017-06-21 17:31:06 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// NewHostClient dials the target address, connects over gRPC, and returns a client interface.
|
|
|
|
|
func NewHostClient(addr string) (*HostClient, error) {
|
2021-10-06 16:10:00 +00:00
|
|
|
|
// Provider client is sensitive to GRPC info logging to stdout, so ensure they are dropped.
|
|
|
|
|
// See https://github.com/pulumi/pulumi/issues/7156
|
2023-01-06 22:39:16 +00:00
|
|
|
|
grpclog.SetLoggerV2(grpclog.NewLoggerV2(io.Discard, io.Discard, os.Stderr))
|
2020-04-20 22:25:51 +00:00
|
|
|
|
conn, err := grpc.Dial(
|
|
|
|
|
addr,
|
2023-01-11 19:54:31 +00:00
|
|
|
|
grpc.WithTransportCredentials(insecure.NewCredentials()),
|
2020-04-20 22:25:51 +00:00
|
|
|
|
grpc.WithUnaryInterceptor(rpcutil.OpenTracingClientInterceptor()),
|
2022-09-12 21:42:27 +00:00
|
|
|
|
grpc.WithStreamInterceptor(rpcutil.OpenTracingStreamClientInterceptor()),
|
2020-04-20 22:25:51 +00:00
|
|
|
|
rpcutil.GrpcChannelOptions(),
|
|
|
|
|
)
|
2017-06-21 17:31:06 +00:00
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
return &HostClient{
|
|
|
|
|
conn: conn,
|
2024-01-17 14:56:37 +00:00
|
|
|
|
client: pulumirpc.NewEngineClient(conn),
|
2017-06-21 17:31:06 +00:00
|
|
|
|
}, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Close closes and renders the connection and client unusable.
|
|
|
|
|
func (host *HostClient) Close() error {
|
|
|
|
|
return host.conn.Close()
|
|
|
|
|
}
|
|
|
|
|
|
2021-04-16 18:49:21 +00:00
|
|
|
|
// EngineConn provides the engine gRPC client connection.
|
|
|
|
|
func (host *HostClient) EngineConn() *grpc.ClientConn {
|
|
|
|
|
return host.conn
|
|
|
|
|
}
|
|
|
|
|
|
Implement status sinks
This commit reverts most of #1853 and replaces it with functionally
identical logic, using the notion of status message-specific sinks.
In other words, where the original commit implemented ephemeral status
messages by adding an `isStatus` parameter to most of the logging
methdos in pulumi/pulumi, this implements ephemeral status messages as a
parallel logging sink, which emits _only_ ephemeral status messages.
The original commit message in that PR was:
> Allow log events to be marked "status" events
>
> This commit will introduce a field, IsStatus to LogRequest. A "status"
> logging event will be displayed in the Info column of the main
> display, but will not be printed out at the end, when resource
> operations complete.
>
> For example, for complex resource initialization, we'd like to display
> a series of intermediate results: [1/4] Service object created, for
> example. We'd like these to appear in the Info column, but not at the
> end, where they are not helpful to the user.
2018-08-31 20:12:40 +00:00
|
|
|
|
func (host *HostClient) log(
|
|
|
|
|
context context.Context, sev diag.Severity, urn resource.URN, msg string, ephemeral bool,
|
2018-08-01 17:10:16 +00:00
|
|
|
|
) error {
|
2024-01-17 14:56:37 +00:00
|
|
|
|
var rpcsev pulumirpc.LogSeverity
|
2017-06-21 17:31:06 +00:00
|
|
|
|
switch sev {
|
|
|
|
|
case diag.Debug:
|
2024-01-17 14:56:37 +00:00
|
|
|
|
rpcsev = pulumirpc.LogSeverity_DEBUG
|
turn on the golangci-lint exhaustive linter (#15028)
Turn on the golangci-lint exhaustive linter. This is the first step
towards catching more missing cases during development rather than
in tests, or in production.
This might be best reviewed commit-by-commit, as the first commit turns
on the linter with the `default-signifies-exhaustive: true` option set,
which requires a lot less changes in the current codebase.
I think it's probably worth doing the second commit as well, as that
will get us the real benefits, even though we end up with a little bit
more churn. However it means all the `switch` statements are covered,
which isn't the case after the first commit, since we do have a lot of
`default` statements that just call `assert.Fail`.
Fixes #14601
## Checklist
- [x] I have run `make tidy` to update any new dependencies
- [x] I have run `make lint` to verify my code passes the lint check
- [x] I have formatted my code using `gofumpt`
<!--- Please provide details if the checkbox below is to be left
unchecked. -->
- [ ] I have added tests that prove my fix is effective or that my
feature works
<!---
User-facing changes require a CHANGELOG entry.
-->
- [ ] I have run `make changelog` and committed the
`changelog/pending/<file>` documenting my change
<!--
If the change(s) in this PR is a modification of an existing call to the
Pulumi Cloud,
then the service should honor older versions of the CLI where this
change would not exist.
You must then bump the API version in
/pkg/backend/httpstate/client/api.go, as well as add
it to the service.
-->
- [ ] Yes, there are changes in this PR that warrants bumping the Pulumi
Cloud API version
<!-- @Pulumi employees: If yes, you must submit corresponding changes in
the service repo. -->
2024-01-17 16:50:41 +00:00
|
|
|
|
case diag.Info, diag.Infoerr:
|
2024-01-17 14:56:37 +00:00
|
|
|
|
rpcsev = pulumirpc.LogSeverity_INFO
|
2017-06-21 17:31:06 +00:00
|
|
|
|
case diag.Warning:
|
2024-01-17 14:56:37 +00:00
|
|
|
|
rpcsev = pulumirpc.LogSeverity_WARNING
|
2017-06-21 17:31:06 +00:00
|
|
|
|
case diag.Error:
|
2024-01-17 14:56:37 +00:00
|
|
|
|
rpcsev = pulumirpc.LogSeverity_ERROR
|
2017-06-21 17:31:06 +00:00
|
|
|
|
default:
|
|
|
|
|
contract.Failf("Unrecognized log severity type: %v", sev)
|
|
|
|
|
}
|
2024-01-17 14:56:37 +00:00
|
|
|
|
_, err := host.client.Log(context, &pulumirpc.LogRequest{
|
Implement status sinks
This commit reverts most of #1853 and replaces it with functionally
identical logic, using the notion of status message-specific sinks.
In other words, where the original commit implemented ephemeral status
messages by adding an `isStatus` parameter to most of the logging
methdos in pulumi/pulumi, this implements ephemeral status messages as a
parallel logging sink, which emits _only_ ephemeral status messages.
The original commit message in that PR was:
> Allow log events to be marked "status" events
>
> This commit will introduce a field, IsStatus to LogRequest. A "status"
> logging event will be displayed in the Info column of the main
> display, but will not be printed out at the end, when resource
> operations complete.
>
> For example, for complex resource initialization, we'd like to display
> a series of intermediate results: [1/4] Service object created, for
> example. We'd like these to appear in the Info column, but not at the
> end, where they are not helpful to the user.
2018-08-31 20:12:40 +00:00
|
|
|
|
Severity: rpcsev,
|
2020-06-17 19:30:59 +00:00
|
|
|
|
Message: strings.ToValidUTF8(msg, "<22>"),
|
Implement status sinks
This commit reverts most of #1853 and replaces it with functionally
identical logic, using the notion of status message-specific sinks.
In other words, where the original commit implemented ephemeral status
messages by adding an `isStatus` parameter to most of the logging
methdos in pulumi/pulumi, this implements ephemeral status messages as a
parallel logging sink, which emits _only_ ephemeral status messages.
The original commit message in that PR was:
> Allow log events to be marked "status" events
>
> This commit will introduce a field, IsStatus to LogRequest. A "status"
> logging event will be displayed in the Info column of the main
> display, but will not be printed out at the end, when resource
> operations complete.
>
> For example, for complex resource initialization, we'd like to display
> a series of intermediate results: [1/4] Service object created, for
> example. We'd like these to appear in the Info column, but not at the
> end, where they are not helpful to the user.
2018-08-31 20:12:40 +00:00
|
|
|
|
Urn: string(urn),
|
|
|
|
|
Ephemeral: ephemeral,
|
2017-06-21 17:31:06 +00:00
|
|
|
|
})
|
|
|
|
|
return err
|
|
|
|
|
}
|
Implement status sinks
This commit reverts most of #1853 and replaces it with functionally
identical logic, using the notion of status message-specific sinks.
In other words, where the original commit implemented ephemeral status
messages by adding an `isStatus` parameter to most of the logging
methdos in pulumi/pulumi, this implements ephemeral status messages as a
parallel logging sink, which emits _only_ ephemeral status messages.
The original commit message in that PR was:
> Allow log events to be marked "status" events
>
> This commit will introduce a field, IsStatus to LogRequest. A "status"
> logging event will be displayed in the Info column of the main
> display, but will not be printed out at the end, when resource
> operations complete.
>
> For example, for complex resource initialization, we'd like to display
> a series of intermediate results: [1/4] Service object created, for
> example. We'd like these to appear in the Info column, but not at the
> end, where they are not helpful to the user.
2018-08-31 20:12:40 +00:00
|
|
|
|
|
|
|
|
|
// Log logs a global message, including errors and warnings.
|
|
|
|
|
func (host *HostClient) Log(
|
|
|
|
|
context context.Context, sev diag.Severity, urn resource.URN, msg string,
|
|
|
|
|
) error {
|
|
|
|
|
return host.log(context, sev, urn, msg, false)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// LogStatus logs a global status message, including errors and warnings. Status messages will
|
|
|
|
|
// appear in the `Info` column of the progress display, but not in the final output.
|
|
|
|
|
func (host *HostClient) LogStatus(
|
|
|
|
|
context context.Context, sev diag.Severity, urn resource.URN, msg string,
|
|
|
|
|
) error {
|
|
|
|
|
return host.log(context, sev, urn, msg, true)
|
|
|
|
|
}
|