Add @cpp.AllowLegacyDeprecatedTerseWritesRef to allow using cpp.Ref with deprecated_terse_writes cpp2 option

Summary: We will ban such usages without this annotation.

Reviewed By: thedavekwon

Differential Revision: D68802575

fbshipit-source-id: 16a60085e3951f0f3ce64e46040d210b9ef93cc9

Author: TJ Yin

thrift/annotation/cpp.thrift

@@ -403,3 +403,13 @@ struct AllowLegacyNonOptionalRef {}
  */
 @scope.Field
 struct DeprecatedTerseWrite {}
+
+/**
+ * Allows the field to be annotated @cpp.Ref (or cpp[2].ref[_type]) even if it
+ * is deprecated_terse_writes field.
+ *
+ * This annotation is provided for a limited time, to exempt pre-existing fields
+ * while rolling out a stricter enforcement of the condition above.
+ */
+@scope.Field
+struct AllowLegacyDeprecatedTerseWritesRef {}

thrift/compiler/test/fixtures/adapter/out/android/gen-android/com/facebook/thrift/annotation/cpp_deprecated/AllowLegacyDeprecatedTerseWritesRef.java

@@ -0,0 +1,123 @@
+/**
+ * Autogenerated by Thrift
+ *
+ * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+ *  @generated
+ */
+package com.facebook.thrift.annotation.cpp_deprecated;
+
+import java.util.List;
+import java.util.ArrayList;
+import java.util.Map;
+import java.util.HashMap;
+import java.util.Set;
+import java.util.HashSet;
+import java.util.Collections;
+import java.util.BitSet;
+import java.util.Arrays;
+import com.facebook.thrift.*;
+import com.facebook.thrift.annotations.*;
+import com.facebook.thrift.async.*;
+import com.facebook.thrift.meta_data.*;
+import com.facebook.thrift.server.*;
+import com.facebook.thrift.transport.*;
+import com.facebook.thrift.protocol.*;
+
+/**
+ * Allows the field to be annotated @cpp.Ref (or cpp[2].ref[_type]) even if it
+ * is deprecated_terse_writes field.
+ * 
+ * This annotation is provided for a limited time, to exempt pre-existing fields
+ * while rolling out a stricter enforcement of the condition above.
+ */
+@SuppressWarnings({ "unused", "serial" })
+public class AllowLegacyDeprecatedTerseWritesRef implements TBase, java.io.Serializable, Cloneable {
+  private static final TStruct STRUCT_DESC = new TStruct("AllowLegacyDeprecatedTerseWritesRef");
+
+
+  public AllowLegacyDeprecatedTerseWritesRef() {
+  }
+
+  /**
+   * Performs a deep copy on <i>other</i>.
+   */
+  public AllowLegacyDeprecatedTerseWritesRef(AllowLegacyDeprecatedTerseWritesRef other) {
+  }
+
+  public AllowLegacyDeprecatedTerseWritesRef deepCopy() {
+    return new AllowLegacyDeprecatedTerseWritesRef(this);
+  }
+
+  @Override
+  public boolean equals(Object _that) {
+    if (_that == null)
+      return false;
+    if (this == _that)
+      return true;
+    if (!(_that instanceof AllowLegacyDeprecatedTerseWritesRef))
+      return false;
+    AllowLegacyDeprecatedTerseWritesRef that = (AllowLegacyDeprecatedTerseWritesRef)_that;
+
+    return true;
+  }
+
+  @Override
+  public int hashCode() {
+    return Arrays.deepHashCode(new Object[] {});
+  }
+
+  // This is required to satisfy the TBase interface, but can't be implemented on immutable struture.
+  public void read(TProtocol iprot) throws TException {
+    throw new TException("unimplemented in android immutable structure");
+  }
+
+  public static AllowLegacyDeprecatedTerseWritesRef deserialize(TProtocol iprot) throws TException {
+    TField __field;
+    iprot.readStructBegin();
+    while (true)
+    {
+      __field = iprot.readFieldBegin();
+      if (__field.type == TType.STOP) {
+        break;
+      }
+      switch (__field.id)
+      {
+        default:
+          TProtocolUtil.skip(iprot, __field.type);
+          break;
+      }
+      iprot.readFieldEnd();
+    }
+    iprot.readStructEnd();
+
+    AllowLegacyDeprecatedTerseWritesRef _that;
+    _that = new AllowLegacyDeprecatedTerseWritesRef(
+    );
+    _that.validate();
+    return _that;
+  }
+
+  public void write(TProtocol oprot) throws TException {
+    validate();
+
+    oprot.writeStructBegin(STRUCT_DESC);
+    oprot.writeFieldStop();
+    oprot.writeStructEnd();
+  }
+
+  @Override
+  public String toString() {
+    return toString(1, true);
+  }
+
+  @Override
+  public String toString(int indent, boolean prettyPrint) {
+    return TBaseHelper.toStringHelper(this, indent, prettyPrint);
+  }
+
+  public void validate() throws TException {
+    // check for required fields
+  }
+
+}
+

thrift/compiler/test/fixtures/adapter/out/go/gen-go/thrift/annotation/cpp/codec.go

@@ -269,6 +269,17 @@ var (
     NewFunc:    func() thrift.Struct { return NewDeprecatedTerseWrite() },
 },
 
+        }
+    }()
+    premadeCodecTypeSpec_cpp_AllowLegacyDeprecatedTerseWritesRef = func() *thrift.TypeSpec {
+        return &thrift.TypeSpec{
+            FullName: "cpp.AllowLegacyDeprecatedTerseWritesRef",
+            CodecStructSpec: &thrift.CodecStructSpec{
+    ScopedName: "cpp.AllowLegacyDeprecatedTerseWritesRef",
+    IsUnion:    false,
+    NewFunc:    func() thrift.Struct { return NewAllowLegacyDeprecatedTerseWritesRef() },
+},
+
         }
     }()
 )
@@ -693,6 +704,20 @@ var (
     },
     FieldSpecNameToIndex: map[string]int{
     },
+}
+    }()
+    premadeStructSpec_AllowLegacyDeprecatedTerseWritesRef = func() *thrift.StructSpec {
+        return &thrift.StructSpec{
+    Name:                 "AllowLegacyDeprecatedTerseWritesRef",
+    ScopedName:           "cpp.AllowLegacyDeprecatedTerseWritesRef",
+    IsUnion:              false,
+    IsException:          false,
+    FieldSpecs:           []thrift.FieldSpec{
+    },
+    FieldSpecIDToIndex:   map[int16]int{
+    },
+    FieldSpecNameToIndex: map[string]int{
+    },
 }
     }()
 )
@@ -720,6 +745,7 @@ var premadeStructSpecs = func() []*thrift.StructSpec {
     fbthriftResults = append(fbthriftResults, premadeStructSpec_GenerateDeprecatedHeaderClientMethods)
     fbthriftResults = append(fbthriftResults, premadeStructSpec_AllowLegacyNonOptionalRef)
     fbthriftResults = append(fbthriftResults, premadeStructSpec_DeprecatedTerseWrite)
+    fbthriftResults = append(fbthriftResults, premadeStructSpec_AllowLegacyDeprecatedTerseWritesRef)
     return fbthriftResults
 }()
 
@@ -749,6 +775,7 @@ var premadeCodecSpecsMap = func() map[string]*thrift.TypeSpec {
     fbthriftTypeSpecsMap[premadeCodecTypeSpec_cpp_GenerateDeprecatedHeaderClientMethods.FullName] = premadeCodecTypeSpec_cpp_GenerateDeprecatedHeaderClientMethods
     fbthriftTypeSpecsMap[premadeCodecTypeSpec_cpp_AllowLegacyNonOptionalRef.FullName] = premadeCodecTypeSpec_cpp_AllowLegacyNonOptionalRef
     fbthriftTypeSpecsMap[premadeCodecTypeSpec_cpp_DeprecatedTerseWrite.FullName] = premadeCodecTypeSpec_cpp_DeprecatedTerseWrite
+    fbthriftTypeSpecsMap[premadeCodecTypeSpec_cpp_AllowLegacyDeprecatedTerseWritesRef.FullName] = premadeCodecTypeSpec_cpp_AllowLegacyDeprecatedTerseWritesRef
     return fbthriftTypeSpecsMap
 }()
 

thrift/compiler/test/fixtures/adapter/out/go/gen-go/thrift/annotation/cpp/metadata.go

@@ -161,6 +161,12 @@ var (
                 SetName("cpp.DeprecatedTerseWrite"),
         )
     }()
+    premadeThriftType_cpp_AllowLegacyDeprecatedTerseWritesRef = func() *metadata.ThriftType {
+        return metadata.NewThriftType().SetTStruct(
+            metadata.NewThriftStructType().
+                SetName("cpp.AllowLegacyDeprecatedTerseWritesRef"),
+        )
+    }()
 )
 
 // Helper type to allow us to store Thrift types in a slice at compile time,
@@ -197,6 +203,7 @@ var premadeThriftTypesMap = func() map[string]*metadata.ThriftType {
     thriftTypesWithFullName = append(thriftTypesWithFullName, thriftTypeWithFullName{ "cpp.GenerateDeprecatedHeaderClientMethods", premadeThriftType_cpp_GenerateDeprecatedHeaderClientMethods })
     thriftTypesWithFullName = append(thriftTypesWithFullName, thriftTypeWithFullName{ "cpp.AllowLegacyNonOptionalRef", premadeThriftType_cpp_AllowLegacyNonOptionalRef })
     thriftTypesWithFullName = append(thriftTypesWithFullName, thriftTypeWithFullName{ "cpp.DeprecatedTerseWrite", premadeThriftType_cpp_DeprecatedTerseWrite })
+    thriftTypesWithFullName = append(thriftTypesWithFullName, thriftTypeWithFullName{ "cpp.AllowLegacyDeprecatedTerseWritesRef", premadeThriftType_cpp_AllowLegacyDeprecatedTerseWritesRef })
 
     fbthriftThriftTypesMap := make(map[string]*metadata.ThriftType, len(thriftTypesWithFullName))
     for _, value := range thriftTypesWithFullName {

thrift/compiler/test/fixtures/adapter/out/go/gen-go/thrift/annotation/cpp/types.go

@@ -2209,6 +2209,78 @@ func (x *DeprecatedTerseWrite) setDefaults() *DeprecatedTerseWrite {
     return x
 }
 
+type AllowLegacyDeprecatedTerseWritesRef struct {
+}
+// Compile time interface enforcer
+var _ thrift.Struct = (*AllowLegacyDeprecatedTerseWritesRef)(nil)
+
+func NewAllowLegacyDeprecatedTerseWritesRef() *AllowLegacyDeprecatedTerseWritesRef {
+    return (&AllowLegacyDeprecatedTerseWritesRef{}).setDefaults()
+}
+
+
+
+func (x *AllowLegacyDeprecatedTerseWritesRef) Write(p thrift.Encoder) error {
+    if err := p.WriteStructBegin("AllowLegacyDeprecatedTerseWritesRef"); err != nil {
+        return thrift.PrependError(fmt.Sprintf("%T write struct begin error: ", x), err)
+    }
+
+
+    if err := p.WriteFieldStop(); err != nil {
+        return thrift.PrependError(fmt.Sprintf("%T write field stop error: ", x), err)
+    }
+
+    if err := p.WriteStructEnd(); err != nil {
+        return thrift.PrependError(fmt.Sprintf("%T write struct end error: ", x), err)
+    }
+    return nil
+}
+
+func (x *AllowLegacyDeprecatedTerseWritesRef) Read(p thrift.Decoder) error {
+    if _, err := p.ReadStructBegin(); err != nil {
+        return thrift.PrependError(fmt.Sprintf("%T read error: ", x), err)
+    }
+
+    for {
+        fieldName, wireType, id, err := p.ReadFieldBegin()
+        if err != nil {
+            return thrift.PrependError(fmt.Sprintf("%T field %d ('%s') read error: ", x, id, fieldName), err)
+        }
+
+        if wireType == thrift.STOP {
+            break;
+        }
+
+        var fieldReadErr error
+        switch {
+        default:
+            fieldReadErr = p.Skip(wireType)
+        }
+
+        if fieldReadErr != nil {
+            return fieldReadErr
+        }
+
+        if err := p.ReadFieldEnd(); err != nil {
+            return err
+        }
+    }
+
+    if err := p.ReadStructEnd(); err != nil {
+        return thrift.PrependError(fmt.Sprintf("%T read struct end error: ", x), err)
+    }
+
+    return nil
+}
+
+func (x *AllowLegacyDeprecatedTerseWritesRef) String() string {
+    return thrift.StructToString(reflect.ValueOf(x))
+}
+
+func (x *AllowLegacyDeprecatedTerseWritesRef) setDefaults() *AllowLegacyDeprecatedTerseWritesRef {
+    return x
+}
+
 
 
 // RegisterTypes registers types found in this file that have a thrift_uri with the passed in registry.
@@ -2235,6 +2307,7 @@ func RegisterTypes(registry interface {
     registry.RegisterType("facebook.com/thrift/annotation/cpp/GenerateDeprecatedHeaderClientMethods", func() any { return NewGenerateDeprecatedHeaderClientMethods() })
     registry.RegisterType("facebook.com/thrift/annotation/cpp/AllowLegacyNonOptionalRef", func() any { return NewAllowLegacyNonOptionalRef() })
     registry.RegisterType("facebook.com/thrift/annotation/cpp/DeprecatedTerseWrite", func() any { return NewDeprecatedTerseWrite() })
+    registry.RegisterType("facebook.com/thrift/annotation/cpp/AllowLegacyDeprecatedTerseWritesRef", func() any { return NewAllowLegacyDeprecatedTerseWritesRef() })
 
     registry.RegisterType("facebook.com/thrift/annotation/cpp/RefType", func() any { return RefType(0) })
     registry.RegisterType("facebook.com/thrift/annotation/cpp/EnumUnderlyingType", func() any { return EnumUnderlyingType(0) })

thrift/compiler/test/fixtures/adapter/out/hack/gen-hack/cpp_types.php

@@ -2485,3 +2485,91 @@ public function readFromJson(string $jsonText): void {
 
 }
 
+/**
+ * Allows the field to be annotated @cpp.Ref (or cpp[2].ref[_type]) even if it
+ * is deprecated_terse_writes field.
+ * 
+ * This annotation is provided for a limited time, to exempt pre-existing fields
+ * while rolling out a stricter enforcement of the condition above.
+ *
+ * Original thrift struct:-
+ * AllowLegacyDeprecatedTerseWritesRef
+ */
+<<\ThriftTypeInfo(shape('uri' => 'facebook.com/thrift/annotation/cpp/AllowLegacyDeprecatedTerseWritesRef'))>>
+class AllowLegacyDeprecatedTerseWritesRef implements \IThriftSyncStruct, \IThriftStructMetadata, \IThriftShapishSyncStruct {
+  use \ThriftSerializationTrait;
+
+  const \ThriftStructTypes::TSpec SPEC = dict[
+  ];
+  const dict<string, int> FIELDMAP = dict[
+  ];
+
+  const type TConstructorShape = shape(
+  );
+
+  const type TShape = shape(
+  );
+  const int STRUCTURAL_ID = 957977401221134810;
+
+  public function __construct()[] {
+  }
+
+  public static function withDefaultValues()[]: this {
+    return new static();
+  }
+
+  public static function fromShape(self::TConstructorShape $shape)[]: this {
+    return new static(
+    );
+  }
+
+  public function getName()[]: string {
+    return 'AllowLegacyDeprecatedTerseWritesRef';
+  }
+
+  public static function getStructMetadata()[]: \tmeta_ThriftStruct {
+    return \tmeta_ThriftStruct::fromShape(
+      shape(
+        "name" => "cpp.AllowLegacyDeprecatedTerseWritesRef",
+        "is_union" => false,
+      )
+    );
+  }
+
+  public static function getAllStructuredAnnotations()[write_props]: \TStructAnnotations {
+    return shape(
+      'struct' => dict[
+        '\facebook\thrift\annotation\Field' => \facebook\thrift\annotation\Field::fromShape(
+          shape(
+          )
+        ),
+      ],
+      'fields' => dict[
+      ],
+    );
+  }
+
+  public static function __fromShape(self::TShape $shape)[]: this {
+    return new static(
+    );
+  }
+
+  public function __toShape()[]: self::TShape {
+    return shape(
+    );
+  }
+  public function getInstanceKey()[write_props]: string {
+    return \TCompactSerializer::serialize($this);
+  }
+
+  public function readFromJson(string $jsonText): void {
+    $parsed = json_decode($jsonText, true);
+
+    if ($parsed === null || !($parsed is KeyedContainer<_, _>)) {
+      throw new \TProtocolException("Cannot parse the given json string.");
+    }
+
+  }
+
+}
+