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

Jump to bottom

[pdata] Deprecate pcommon.Map.Sort() #6989

Merged
merged 1 commit into from
Jan 21, 2023
Merged

[pdata] Deprecate pcommon.Map.Sort() #6989

Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions .chloggen/deprecate-map-sort.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: deprecation

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: pdata

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecate pcommon.Map.Sort().

# One or more tracking issues or pull requests related to the change
issues: [6688]
12 changes: 10 additions & 2 deletions pdata/pcommon/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -654,8 +654,16 @@ func (m Map) PutEmptySlice(k string) Slice {

// Sort sorts the entries in the Map so two instances can be compared.
//
// IMPORTANT: Sort mutates the data, if you call this function in a consumer,
// the consumer must be configured that it mutates data.
// Deprecated: [1.0.0-rc4] This method will be removed as it leaks the underlying implementation.
// Please use one of the following alternatives depending on your use case:
// - Map.AsRaw() if you need to compare two maps in tests.
// - github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatatest module if you use Sort()
// to prepare other pdata objects for comparison.
// - github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil module if you use Sort()
// to create Map identifiers.
//
// If your use case is not covered by the above alternatives, please comment on the issue
// https://github.com/open-telemetry/opentelemetry-collector/issues/6688.
func (m Map) Sort() {
// Intention is to move the nil values at the end.
sort.SliceStable(*m.getOrig(), func(i, j int) bool {
Expand Down