Closed Bug 1650753 Opened 4 years ago Closed 4 years ago

Document/prevent footguns related to `Glean.Initalize` and `SetUploadEnabled`

Categories

(Data Platform and Tools :: Glean: SDK, defect, P1)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: Dexter, Assigned: janerik)

References

Details

Attachments

(1 file)

Our docs do not currently mention that Glean.Initialize should be called with the "proper" value for uploadEnabled, not with a temporary value that will be corrected with the real one by calling SetUploadEnabled.

Doing this, for example, can cause bug 1650752

Depends on: 1650752
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:backlog]

This may not always hold because of async execution:

GleanInstance.SetUploadEnabled(false); 
Assert.False(GleanInstance.GetUploadEnabled());
Assignee: nobody → jrediger
Priority: P3 → P1
Whiteboard: [telemetry:glean-rs:backlog]
Status: NEW → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: