Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-16756

InterfaceAudience annotate our protobuf; distinguish internal; publish public

    XMLWordPrintableJSON

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Protobufs
    • Labels:
      None

      Description

      This is a follow-on from the work done over in HBASE-15638 Shade protobuf.

      Currently protobufs are not annotated as our java classes are even though they are being used by downstream Coprocessor Endpoints; i.e. if a CPEP wants to update a Cell in HBase or refer to a server in the cluster, 9 times out of 10 they will depend on the HBase Cell.proto and its generated classes or the ServerName definition in HBase.proto file.

      This makes it so we cannot make breaking changes to the Cell type or relocate the ServerName definition to another file if we want CPEPs to keep working.

      The issue gets compounded by HBASE-15638 "Shade protobuf" where protos used internally are relocated, and given another package name altogether. Currently we leave behind the old protos (sort-of duplicated) so CPEPs keep working but going forward, IF WE CONTINUE DOWN THIS PATH OF SHADING PROTOS (we may revisit if hadoop ends up isolating its classpath), then we need to 'publish' protos that we will honor as we would classes annotate with @InterfaceAudience.Public as part of our public API going forward.

      What is involved is a review of the current protos under hbase-protocol. Sort out what is to be made public. We will likely have to break up current proto files into smaller collections since they currently contain mixes of public and private types. Deprecate the fat Admin and Client protos. This will allow us to better narrow the set of what we make public. These new files could live in the hbase-protocol module suitably annotated or they could be done up in a new module altogether. TODO.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                stack Michael Stack
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated: