Resolves #1637: Stop publishing proto2 version of our artifacts (#2444)

* update minor version to 3.4 from 3.3

* Resolves #1637: Stop publishing proto2 version of our artifacts

Consolidates our protobuf version to proto3. This removes the proto2 specific directories and places them into the main source directories. This also removes the `-pb3` suffix from our artifact names, so users should switch over to the un-suffixed package names

This resolves #1637.

Author: alecgrieser

.idea/compiler.xml

@@ -198,25 +198,8 @@ subprojects {
     }
 
     ext {
-        if (System.getenv('PROTO_VERSION') != null) {
-            protoMajorVersion = System.getenv('PROTO_VERSION')
-        } else {
-            protoMajorVersion = '3'
-        }
-        if (protoMajorVersion == "2") {
-            protobufVersion = protobuf2Version
-        } else if (protoMajorVersion == "3") {
-            protobufVersion = protobuf3Version
-        } else {
-            throw new GradleException("Unknown protobuf major version: ${protoMajorVersion}")
-        }
-        if (protoMajorVersion != "2") {
-            coreProjectName = "fdb-record-layer-core-pb${protoMajorVersion}"
-            shadedProjectName = "fdb-record-layer-core-pb${protoMajorVersion}-shaded"
-        } else {
-            coreProjectName = "fdb-record-layer-core"
-            shadedProjectName = "fdb-record-layer-core-shaded"
-        }
+        coreProjectName = "fdb-record-layer-core"
+        shadedProjectName = "fdb-record-layer-core-shaded"
     }
 
     artifacts {

build.gradle

@@ -43,12 +43,10 @@ def print_with_date(text):
     print ('{0}   {1}'.format(date_string(), text))
 
 # Constructs the gradle run path given the gradle args.
-def run_gradle(proto_version, *args):
-    env = dict(os.environ)
+def run_gradle(*args):
     full_args = [os.path.join(dir_path, 'gradlew'), '--console=plain', '-b', os.path.join(dir_path, 'build.gradle'), ] + list(args)
-    print_with_date('Running gradle build: {0}; Proto version: {1}'.format(' '.join(full_args), proto_version))
-    env['PROTO_VERSION'] = str(proto_version)
-    proc = subprocess.Popen(full_args, env=env)
+    print_with_date('Running gradle build: {0}'.format(' '.join(full_args)))
+    proc = subprocess.Popen(full_args)
     proc.communicate()
 
     if proc.returncode != 0:
@@ -114,7 +112,7 @@ def get_version(release=False):
     return version
 
 # Move all of the publishable files to a temporary directory.
-def build(release=False, proto2=False, proto3=False, publish=False):
+def build(release=False, publish=False):
     print_with_date('Running build script within directory: {0}'.format(dir_path))
 
     print_with_date('Clearing temporary directory.')
@@ -128,54 +126,24 @@ def build(release=False, proto2=False, proto3=False, publish=False):
     # Clear before.
     clear(os.path.join(dir_path, TEMP_ROOT))
 
-    if proto2:
-        # Make with protobuf 2.
-        success = run_gradle(2, 'clean', 'build', 'destructiveTest',
-                                '-PreleaseBuild={0}'.format('true' if release else 'false'))
-        if not success:
-            return False
-
-        if publish:
-            success = run_gradle(2, 'artifactoryPublish', '-PpublishBuild=true',
-                                    '-PreleaseBuild={0}'.format('true' if release else 'false'))
-            if not success:
-                return False
-
-        success = run_gradle(2, 'fdb-record-layer-core:clean')
-        if not success:
-            return False
+    success = run_gradle('clean', 'build', 'destructiveTest',
+                         '-PreleaseBuild={0}'.format('true' if release else 'false'))
+    if not success:
+        return False
 
-    if proto3:
-        # Make with protobuf 3.
-        success = run_gradle(3, 'build', 'destructiveTest', '-PcoreNotStrict',
-                                '-PreleaseBuild={0}'.format('true' if release else 'false'),
-                                '-PpublishBuild={0}'.format('true' if publish else 'false'))
-        if not success:
+    if publish:
+        success = run_gradle('artifactoryPublish', '-PpublishBuild=true',
+                             '-PreleaseBuild={0}'.format('true' if release else 'false'))
+        if not success
             return False
 
-        if publish:
-            # These are enumerated rather than just using the full project artifactoryPublish command to avoid uploading
-            # the fdb-extensions subproject twice. (Note that as overwrite is not supported, doing so would result
-            # in the build failing.)
-            success = run_gradle(3, ':fdb-record-layer-core-pb3:artifactoryPublish',
-                                    ':fdb-record-layer-core-pb3-shaded:artifactoryPublish',
-                                    ':fdb-record-layer-icu-pb3:artifactoryPublish',
-                                    ':fdb-record-layer-spatial-pb3:artifactoryPublish',
-                                    ':fdb-record-layer-lucene-pb3:artifactoryPublish',
-                                    '-PcoreNotStrict',
-                                    '-PreleaseBuild={0}'.format('true' if release else 'false'),
-                                    '-PpublishBuild=true')
-            if not success:
-                return False
-
-
     return True
 
 usage = """
-Usage: python build.py <release|snapshot> [--proto2] [--proto3] [--publish]
+Usage: python build.py <release|snapshot> [--publish]
 Builds the packages for this project. You must specify release or snapshot
-The --proto2 flag indicates that the build should use protobuf 2.
-The --proto3 flag indicates that the build should use protobuf 3.
+The --proto2 flag is ignored (previously would use protobuf 2)
+The --proto3 flag is ignored (previously would use protobuf 3)
 The --publish flag indicates that the build should be published upon completion.
 """
 def parse_args():
@@ -203,18 +171,13 @@ def parse_args():
             print ('Unrecognized argument: {0}'.format(arg))
             quit(3)
 
-    # run both proto2 and proto3 by default
-    if not ret.proto2 and not ret.proto3:
-        ret.proto2 = True
-        ret.proto3 = True
-
     return ret
 
 if __name__ == "__main__":
     print_with_date('Starting build')
     success = True
     args = parse_args()
-    success = success and build(release=args.release, proto2=args.proto2, proto3=args.proto3, publish=args.publish)
+    success = success and build(release=args.release, publish=args.publish)
 
     if not success:
         print_with_date('Build failed!')

build.py

@@ -5,11 +5,11 @@ This document contains a log of changes to the FoundationDB Record Layer. It aim
 
 As the [versioning guide](Versioning.md) details, it cannot always be determined solely by looking at the version numbers whether one Record Layer version contains all changes included in another. In particular, bug fixes and backwards-compatible changes might be back-ported to or introduced as patches against older versions. To track when a patch version has been included in the main release train, some releases will say as a note that they contain all changes from a specific patch.
 
-## 3.3
+## 3.4
 
 ### Breaking Changes
 
-The Guava dependency version has been updated to 31.1. Projects may need to check for compatibility with their own versions of the dependency, or they may need to consider using the shaded artifact if the new version is incompatible.
+Support for the Protobuf 2 runtime has been removed as of this version. All artifacts now use Protobuf version 3. Note that the choice of Protobuf runtime version is distinct from the choice of Protobuf message syntax, and that users wishing to retain Protobuf 2 behavior can still achieve the same semantics (including [optional field behavior]()) as long as they specify the syntax on their Protobuf file as `proto2`. Note that the Maven artifacts using Protobuf version 3 used to be suffixed with `-pb3`. Existing Protobuf 3 users must remove that suffix from their dependency declarations (e.g., `fdb-record-layer-core-pb3` should now be `fdb-record-layer-core`).
 
 <!--
 // begin next release
@@ -31,14 +31,21 @@ The Guava dependency version has been updated to 31.1. Projects may need to chec
 * **Feature** Feature 4 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Feature** Feature 5 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Breaking change** Change 1 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
-* **Breaking change** Change 2 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
+* **Breaking change** Support for the Protobuf 2 runtime has been removed from all artifacts [(Issue #1637)](https://github.com/FoundationDB/fdb-record-layer/issues/1637)
 * **Breaking change** Change 3 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Breaking change** Change 4 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Breaking change** Change 5 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 
 // end next release
 -->
 
+## 3.3
+
+### Breaking Changes
+
+The Guava dependency version has been updated to 31.1. Projects may need to check for compatibility with their own versions of the dependency, or they may need to consider using the shaded artifact if the new version is incompatible.
+
+
 ### 3.3.446.0
 
 

docs/ReleaseNotes.md

@@ -2,16 +2,14 @@
 
 ## Variants
 
-The Record Layer is released in several variants, depending on which version of the Protobuf API is used and whether or not Protobuf is renamed ("shaded").
+The Record Layer is released in two variants, depending on not Protobuf is renamed ("shaded").
 
-|              |         Protobuf 2             |         Protobuf 3                 |
-|:------------:|:------------------------------:|:----------------------------------:|
-| **Unshaded** | `fdb-record-layer-core`        | `fdb-record-layer-core-pb3`        |
-| **Shaded**   | `fdb-record-layer-core-shaded` | `fdb-record-layer-core-pb3-shaded` |
+* **Unshaded**: `fdb-record-layer-core`
+* **Shaded**: `fdb-record-layer-core-shaded`
 
 In the shaded versions, `com.google` classes will be renamed to `com.apple.foundationdb.record.shaded.com.google`.
 
-Code generated by one version of `protoc` is generally *not* compatible with the Protobuf runtime classes from another version.
+Note that code generated by one version of `protoc` is generally *not* compatible with the Protobuf runtime classes from another version. For that reason, it is suggested that the adopter keep their `protoc` version aligned with the Protobuf runtime used by the Record Layer library.
 
 ### Maven Dependency
 
@@ -32,7 +30,7 @@ Then the following dependency can be added:
 ```
   <groupId>org.foundationdb</groupId>
   <artifactId>fdb-record-layer-core</artifactId>
-  <version>3.3.+</version>
+  <version>3.4.+</version>
 ```
 
 Older builds are also available in the maven central repository, and newer builds will be published there upon the resolution of [Issue #1288](https://github.com/FoundationDB/fdb-record-layer/issues/1288).
@@ -53,7 +51,7 @@ repositories {
 Then the following dependency can be added:
 
 ```
-"org.foundationdb:fdb-record-layer-core:3.3.+"
+"org.foundationdb:fdb-record-layer-core:3.4.+"
 ```
 
 Older builds are also available in the `mavenCentral()` repository, and newer builds will be published there upon the resolution of [Issue #1288](https://github.com/FoundationDB/fdb-record-layer/issues/1288).

docs/Versioning.md

@@ -84,7 +84,7 @@ publishing {
             from project.shadow.component(publication)
             addPublishingInfo(publication) // function imported from publishing.gradle
             publication.pom { pom ->
-                description = 'A record-oriented layer built for FoundationDB (shaded artifacts; proto' + project.protoMajorVersion + ').'
+                description = 'A record-oriented layer built for FoundationDB (shaded artifacts).'
                 pom.withXml { xml ->
                     // Remove any existing dependencies sections
                     def childNodes = xml.asNode().children()

fdb-record-layer-core-shaded/fdb-record-layer-core-shaded.gradle

@@ -59,12 +59,8 @@ dependencies {
 
 sourceSets {
     main {
-        java.srcDir "src/main/java-proto${protoMajorVersion}"
         java.srcDir ".out/generated/sources/annotationProcessor/java/main/"
     }
-    test {
-        java.srcDir "src/test/java-proto${protoMajorVersion}"
-    }
 }
 
 test {
@@ -142,7 +138,7 @@ publishing {
                 // Normally, the variable would be included within the string using variable expansion in a Groovy
                 // string. However, the "description" field must be a java.lang.String, hence the use of string
                 // concatenation here.
-                description = 'A record-oriented layer built for FoundationDB (proto' + project.protoMajorVersion + ').'
+                description = 'A record-oriented layer built for FoundationDB.'
             }
         }
     }