[HDDS-9540] Inconsistent BlockManager.putBlock() API definition

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.4.0
• Labels: pull-request-available
• Assignee: Tejaskriya Madhan
• Reporter: Wei-Chiu Chuang
• Created: 25/Oct/23 20:53
• Updated: 03/Nov/23 15:56
• Resolved: 03/Nov/23 15:56

Description

The BlockManager interface defines API :

  /**
   * Puts or overwrites a block.
   *
   * @param container - Container for which block need to be added.
   * @param data     - Block Data.
   * @param incrKeyCount - Whether to increase container key count.
   * @return length of the Block.
   * @throws IOException
   */
  long putBlock(Container container, BlockData data, boolean incrKeyCount)
      throws IOException;

whereas BlockManagerImpl has:

  /**
   * Puts or overwrites a block.
   *
   * @param container - Container for which block need to be added.
   * @param data - BlockData.
   * @param endOfBlock - The last putBlock call for this block (when
   *                   all the chunks are written and stream is closed)
   * @return length of the block.
   * @throws IOException
   */
  @Override
  public long putBlock(Container container, BlockData data,
      boolean endOfBlock) throws IOException {

That is, the last parameter is inconsistent (incrKeyCount vs. endOfBlock)

IMO the javadoc in BlockManagerImpl more accurately reflects what it's supposed to do.

Issue Links

• is related to: HDDS-5359 Incorrect BLOCKCOUNT and BYTESUSED in container DB
• links to: GitHub Pull Request #5520