Skip to content
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

[connector,exporter,processor,receiver] Error out on mismatched type #12381

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

[connector,exporter,processor,receiver] Error out on mismatched type #12381

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f75a406
[connector,exporter,processor,receiver] Error out on mismatched type
mx-psi Feb 13, 2025
480e080
Fix tests
mx-psi Feb 14, 2025
c476abf
Update changelog note
mx-psi Feb 14, 2025
611c51b
Merge remote-tracking branch 'origin/main' into mx-psi/error-out
mx-psi Feb 18, 2025
57e9e79
Merge branch 'main' into mx-psi/error-out
mx-psi Feb 19, 2025
a205ce4
Fix bad merge
mx-psi Feb 19, 2025
5bb5de2
Merge branch 'main' into mx-psi/error-out
mx-psi Feb 20, 2025
3676dd8
Merge branch 'main' into mx-psi/error-out
mx-psi Feb 21, 2025
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
4 changes: 2 additions & 2 deletions .chloggen/mx-psi_type-mismatch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: extension
component: extension, processor, connector, exporter, receiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Explicitly error out at extension creation time if there is a type mismatch.
note: Explicitly error out at component creation time if there is a type mismatch.

# One or more tracking issues or pull requests related to the change
issues: [12305]
Expand Down
45 changes: 45 additions & 0 deletions connector/connector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,62 +387,107 @@
if f.createTracesToTracesFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalTraces)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 393 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L392-L393 

Added lines #L392 - L393 were not covered by tests

return f.createTracesToTracesFunc(ctx, set, cfg, next)
}

func (f *factory) CreateTracesToMetrics(ctx context.Context, set Settings, cfg component.Config, next consumer.Metrics) (Traces, error) {
if f.createTracesToMetricsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalMetrics)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 405 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L404-L405 

Added lines #L404 - L405 were not covered by tests

return f.createTracesToMetricsFunc(ctx, set, cfg, next)
}

func (f *factory) CreateTracesToLogs(ctx context.Context, set Settings, cfg component.Config, next consumer.Logs) (Traces, error) {
if f.createTracesToLogsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalLogs)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 417 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L416-L417 

Added lines #L416 - L417 were not covered by tests

return f.createTracesToLogsFunc(ctx, set, cfg, next)
}

func (f *factory) CreateMetricsToTraces(ctx context.Context, set Settings, cfg component.Config, next consumer.Traces) (Metrics, error) {
if f.createMetricsToTracesFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalTraces)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 429 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L428-L429 

Added lines #L428 - L429 were not covered by tests

return f.createMetricsToTracesFunc(ctx, set, cfg, next)
}

func (f *factory) CreateMetricsToMetrics(ctx context.Context, set Settings, cfg component.Config, next consumer.Metrics) (Metrics, error) {
if f.createMetricsToMetricsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalMetrics)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 441 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L440-L441 

Added lines #L440 - L441 were not covered by tests

return f.createMetricsToMetricsFunc(ctx, set, cfg, next)
}

func (f *factory) CreateMetricsToLogs(ctx context.Context, set Settings, cfg component.Config, next consumer.Logs) (Metrics, error) {
if f.createMetricsToLogsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalLogs)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 453 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L452-L453 

Added lines #L452 - L453 were not covered by tests

return f.createMetricsToLogsFunc(ctx, set, cfg, next)
}

func (f *factory) CreateLogsToTraces(ctx context.Context, set Settings, cfg component.Config, next consumer.Traces) (Logs, error) {
if f.createLogsToTracesFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalTraces)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 465 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L464-L465 

Added lines #L464 - L465 were not covered by tests

return f.createLogsToTracesFunc(ctx, set, cfg, next)
}

func (f *factory) CreateLogsToMetrics(ctx context.Context, set Settings, cfg component.Config, next consumer.Metrics) (Logs, error) {
if f.createLogsToMetricsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalMetrics)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 477 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L476-L477 

Added lines #L476 - L477 were not covered by tests

return f.createLogsToMetricsFunc(ctx, set, cfg, next)
}

func (f *factory) CreateLogsToLogs(ctx context.Context, set Settings, cfg component.Config, next consumer.Logs) (Logs, error) {
if f.createLogsToLogsFunc == nil {
return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalLogs)
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 489 in connector/connector.go

View check run for this annotation

Codecov / codecov/patch

connector/connector.go#L488-L489 

Added lines #L488 - L489 were not covered by tests

return f.createLogsToLogsFunc(ctx, set, cfg, next)
}

Expand Down
20 changes: 10 additions & 10 deletions connector/connector_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (

var (
testType = component.MustNewType("test")
testID = component.MustNewIDWithName("type", "name")
testID = component.MustNewIDWithName("test", "name")
)

func TestNewFactoryNoOptions(t *testing.T) {
Expand Down Expand Up @@ -147,33 +147,33 @@ func TestNewFactoryWithAllTypes(t *testing.T) {
assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())

assert.Equal(t, component.StabilityLevelAlpha, factory.TracesToTracesStability())
_, err := factory.CreateTracesToTraces(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err := factory.CreateTracesToTraces(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelDevelopment, factory.TracesToMetricsStability())
_, err = factory.CreateTracesToMetrics(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateTracesToMetrics(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelAlpha, factory.TracesToLogsStability())
_, err = factory.CreateTracesToLogs(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateTracesToLogs(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)

assert.Equal(t, component.StabilityLevelBeta, factory.MetricsToTracesStability())
_, err = factory.CreateMetricsToTraces(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateMetricsToTraces(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelBeta, factory.MetricsToMetricsStability())
_, err = factory.CreateMetricsToMetrics(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateMetricsToMetrics(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelStable, factory.MetricsToLogsStability())
_, err = factory.CreateMetricsToLogs(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateMetricsToLogs(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)

assert.Equal(t, component.StabilityLevelDeprecated, factory.LogsToTracesStability())
_, err = factory.CreateLogsToTraces(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateLogsToTraces(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelUnmaintained, factory.LogsToMetricsStability())
_, err = factory.CreateLogsToMetrics(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateLogsToMetrics(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
require.NoError(t, err)
assert.Equal(t, component.StabilityLevelUnmaintained, factory.LogsToLogsStability())
_, err = factory.CreateLogsToLogs(context.Background(), Settings{}, &defaultCfg, consumertest.NewNop())
_, err = factory.CreateLogsToLogs(context.Background(), Settings{ID: testID}, &defaultCfg, consumertest.NewNop())
assert.NoError(t, err)
}

Expand Down
12 changes: 12 additions & 0 deletions exporter/exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,10 @@
return nil, pipeline.ErrSignalNotSupported
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 165 in exporter/exporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporter.go#L164-L165 

Added lines #L164 - L165 were not covered by tests

return f.createTracesFunc(ctx, set, cfg)
}

Expand All @@ -168,6 +172,10 @@
return nil, pipeline.ErrSignalNotSupported
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 177 in exporter/exporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporter.go#L176-L177 

Added lines #L176 - L177 were not covered by tests

return f.createMetricsFunc(ctx, set, cfg)
}

Expand All @@ -176,6 +184,10 @@
return nil, pipeline.ErrSignalNotSupported
}

if set.ID.Type() != f.Type() {
return nil, fmt.Errorf("component type mismatch: component ID %q does not have type %q", set.ID, f.Type())
}

Check warning on line 189 in exporter/exporter.go

View check run for this annotation

Codecov / codecov/patch

exporter/exporter.go#L188-L189 

Added lines #L188 - L189 were not covered by tests

return f.createLogsFunc(ctx, set, cfg)
}

Expand Down
19 changes: 11 additions & 8 deletions exporter/exporter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,27 @@ import (
"go.opentelemetry.io/collector/pipeline"
)

var (
testType = component.MustNewType("test")
testID = component.NewID(testType)
)

func TestNewFactory(t *testing.T) {
testType := component.MustNewType("test")
defaultCfg := struct{}{}
f := NewFactory(
testType,
func() component.Config { return &defaultCfg })
assert.EqualValues(t, testType, f.Type())
assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())
_, err := f.CreateTraces(context.Background(), Settings{}, &defaultCfg)
_, err := f.CreateTraces(context.Background(), Settings{ID: testID}, &defaultCfg)
require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
_, err = f.CreateMetrics(context.Background(), Settings{}, &defaultCfg)
_, err = f.CreateMetrics(context.Background(), Settings{ID: testID}, &defaultCfg)
require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg)
_, err = f.CreateLogs(context.Background(), Settings{ID: testID}, &defaultCfg)
require.ErrorIs(t, err, pipeline.ErrSignalNotSupported)
}

func TestNewFactoryWithOptions(t *testing.T) {
testType := component.MustNewType("test")
defaultCfg := struct{}{}
f := NewFactory(
testType,
Expand All @@ -44,15 +47,15 @@ func TestNewFactoryWithOptions(t *testing.T) {
assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig())

assert.Equal(t, component.StabilityLevelDevelopment, f.TracesStability())
_, err := f.CreateTraces(context.Background(), Settings{}, &defaultCfg)
_, err := f.CreateTraces(context.Background(), Settings{ID: testID}, &defaultCfg)
require.NoError(t, err)

assert.Equal(t, component.StabilityLevelAlpha, f.MetricsStability())
_, err = f.CreateMetrics(context.Background(), Settings{}, &defaultCfg)
_, err = f.CreateMetrics(context.Background(), Settings{ID: testID}, &defaultCfg)
require.NoError(t, err)

assert.Equal(t, component.StabilityLevelDeprecated, f.LogsStability())
_, err = f.CreateLogs(context.Background(), Settings{}, &defaultCfg)
_, err = f.CreateLogs(context.Background(), Settings{ID: testID}, &defaultCfg)
assert.NoError(t, err)
}

Expand Down
4 changes: 2 additions & 2 deletions exporter/exportertest/contract_checker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ func checkTraces(t *testing.T, params CheckConsumeContractParams, mockReceiver c
ctx := context.Background()
var exp exporter.Traces
var err error
exp, err = params.ExporterFactory.CreateTraces(ctx, NewNopSettingsWithType(NopType), params.ExporterConfig)
exp, err = params.ExporterFactory.CreateTraces(ctx, NewNopSettingsWithType(params.ExporterFactory.Type()), params.ExporterConfig)
require.NoError(t, err)
require.NotNil(t, exp)

Expand Down Expand Up @@ -191,7 +191,7 @@ func checkLogs(t *testing.T, params CheckConsumeContractParams, mockReceiver com
ctx := context.Background()
var exp exporter.Logs
var err error
exp, err = params.ExporterFactory.CreateLogs(ctx, NewNopSettingsWithType(NopType), params.ExporterConfig)
exp, err = params.ExporterFactory.CreateLogs(ctx, NewNopSettingsWithType(params.ExporterFactory.Type()), params.ExporterConfig)
require.NoError(t, err)
require.NotNil(t, exp)

Expand Down
Loading
Loading