[SERVER-85274] write_ops_exec.cpp violates style guide on parameter ordering Created: 16/Jan/24  Updated: 25/Jan/24

Status: Backlog
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Matt Kneiser Assignee: Backlog - Storage Execution Team
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Storage Execution
Participants:

 Description   

The functions in this file are very hard to follow (aside from being undocumented) often because the one input parameter `request` is last, not first! In many cases there are several input parameters and they all appear before the sole input parameter.

According to the Google Style Guide, input-only parameters should be ordered first, before in/out or output parameters.

Functions (~15, incorrectly ordered params in parentheses):

  • insertBatchAndHandleErrors (OperationSource)
  • performUpdate(curOp, updateRequest)
  • performSingleUpdateOp(containsDotsAndDollarsField)
  • performTimeseriesInsert(batch)
  • performTimeseriesUpdate(batch)
  • tryPerformTimeseriesBucketCompression(request)
  • commitTimeseriesBucketsAtomically(request)
  • rebuildOptionsWithGranularityFromConfigServer(timeseriesOptions)
  • insertIntoBucketCatalog(request)
  • performOrderedTimeseriesWritesAtomically(request)
  • performUnorderedTimeseriesWrites(request)
  • performUnorderedTimeseriesWritesWithRetries(request)
  • performOrderedTimeseriesWrites (request)
  • explainUpdate(updateRequest)
  • explainDelete(deleteRequest)

Generated at Thu Feb 08 06:57:19 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.