Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-85274

write_ops_exec.cpp violates style guide on parameter ordering

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major - P3 Major - P3
    • None
    • None
    • None
    • None
    • Storage Execution

    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)

      Attachments

        Activity

          People

            backlog-server-execution Backlog - Storage Execution Team
            matt.kneiser@mongodb.com Matt Kneiser
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: