Merge branch 'release/1.2.0'

intelligide · intelligide · commit b8d20576c815 · 2022-06-24T16:23:07.000-04:00
diff --git a/src/OpenMatch.Tests/BackendServiceClientTest.cs b/src/OpenMatch.Tests/BackendServiceClientTest.cs
@@ -9,7 +9,7 @@ public class BackendServiceClientTest
         [Fact]
         public void CanCreateBackendServiceClient()
         {
-            var channel = GrpcChannel.ForAddress("localhost:6000");
+            var channel = GrpcChannel.ForAddress("https://localhost:6000");
             var omClient = new OpenMatch.BackendService.BackendServiceClient(channel);
         }
     }
diff --git a/src/OpenMatch/OpenMatch.csproj b/src/OpenMatch/OpenMatch.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.1</TargetFramework>
     <PackageId>OpenMatch.Api</PackageId>
     <Title>OpenMatch Api</Title>
-    <Version>1.1.1</Version>
+    <Version>1.2.0</Version>
     <PackageDescription>C# API for OpenMatch</PackageDescription>
     <Authors>Yoann Potinet</Authors>
     <Company>FrozenStorm Interactive</Company>
@@ -23,16 +23,18 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Protobuf Access="public" Include="proto/api/**/*.proto" GrpcServices="Both" ProtoRoot="proto;proto/third_party" />
-
+    <Protobuf Access="public" Include="proto/api/**/*.proto" GrpcServices="Both" ProtoRoot="proto" AdditionalImportDirs="proto/third_party" />
     <Protobuf Access="internal" Include="proto/third_party/google/**/*.proto" GrpcServices="Both" ProtoRoot="proto/third_party" OutputDir="$(IntermediateOutputPath)/ThirdParty/google" />
-    <Protobuf Access="internal" Include="proto/third_party/protoc-gen-swagger/**/*.proto" GrpcServices="Both" ProtoRoot="proto/third_party" OutputDir="$(IntermediateOutputPath)/ThirdParty/protoc-gen-swagger" />
+    <Protobuf Access="internal" Include="proto/third_party/protoc-gen-openapiv2/**/*.proto" GrpcServices="Both" ProtoRoot="proto/third_party" OutputDir="$(IntermediateOutputPath)/ThirdParty/protoc-gen-openapiv2" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Grpc.Net.Client" Version="2.29.0" />
-    <PackageReference Include="Google.Protobuf" Version="3.15.0" />
-    <PackageReference Include="Grpc.Tools" Version="2.29.0" />
+    <PackageReference Include="Grpc.Net.Client" Version="2.38.0" />
+    <PackageReference Include="Google.Protobuf" Version="3.17.0" />
+    <PackageReference Include="Grpc.Tools" Version="2.38.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
 </Project>
diff --git a/src/OpenMatch/proto/api/backend.proto b/src/OpenMatch/proto/api/backend.proto
@@ -19,9 +19,9 @@ option csharp_namespace = "OpenMatch";
 
 import "api/messages.proto";
 import "google/api/annotations.proto";
-import "protoc-gen-swagger/options/annotations.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
 
-option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Backend"
     version: "1.0"
@@ -93,7 +93,7 @@ message ReleaseAllTicketsRequest{}
 message ReleaseAllTicketsResponse {}
 
 // AssignmentGroup contains an Assignment and the Tickets to which it should be applied. 
-message AssignmentGroup{
+message AssignmentGroup {
   // TicketIds is a list of strings representing Open Match generated Ids which apply to an Assignment.
   repeated string ticket_ids = 1;
 
@@ -146,7 +146,6 @@ service BackendService {
 
   // ReleaseTickets moves tickets from the pending state, to the active state.
   // This enables them to be returned by query, and find different matches.
-  // 
   // BETA FEATURE WARNING:  This call and the associated Request and Response
   // messages are not finalized and still subject to possible change or removal.
   rpc ReleaseTickets(ReleaseTicketsRequest) returns (ReleaseTicketsResponse) {
@@ -159,7 +158,6 @@ service BackendService {
   // ReleaseAllTickets moves all tickets from the pending state, to the active
   // state. This enables them to be returned by query, and find different
   // matches.
-  // 
   // BETA FEATURE WARNING:  This call and the associated Request and Response
   // messages are not finalized and still subject to possible change or removal.
   rpc ReleaseAllTickets(ReleaseAllTicketsRequest) returns (ReleaseAllTicketsResponse) {
diff --git a/src/OpenMatch/proto/api/evaluator.proto b/src/OpenMatch/proto/api/evaluator.proto
@@ -19,9 +19,9 @@ option csharp_namespace = "OpenMatch";
 
 import "api/messages.proto";
 import "google/api/annotations.proto";
-import "protoc-gen-swagger/options/annotations.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
 
-option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Evaluator"
     version: "1.0"
@@ -52,7 +52,7 @@ option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
   }
   // TODO Add annotations for security_defintiions.
   // See
-  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/proto/examplepb/a_bit_of_everything.proto
+  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/internal/proto/examplepb/a_bit_of_everything.proto
 };
 
 message EvaluateRequest {
diff --git a/src/OpenMatch/proto/api/frontend.proto b/src/OpenMatch/proto/api/frontend.proto
@@ -19,10 +19,10 @@ option csharp_namespace = "OpenMatch";
 
 import "api/messages.proto";
 import "google/api/annotations.proto";
-import "protoc-gen-swagger/options/annotations.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
 import "google/protobuf/empty.proto";
 
-option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Frontend"
     version: "1.0"
@@ -53,7 +53,7 @@ option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
   }
   // TODO Add annotations for security_defintiions.
   // See
-  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/proto/examplepb/a_bit_of_everything.proto
+  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/internal/proto/examplepb/a_bit_of_everything.proto
 };
 
 message CreateTicketRequest {
@@ -81,6 +81,47 @@ message WatchAssignmentsResponse {
   Assignment assignment = 1;
 }
 
+// BETA FEATURE WARNING: This Request message is not finalized and still subject
+// to possible change or removal.
+message AcknowledgeBackfillRequest {
+  // An existing ID of Backfill to acknowledge.
+  string backfill_id = 1;
+
+  // An updated Assignment of the requested Backfill.
+  Assignment assignment = 2;
+}
+
+// BETA FEATURE WARNING: This Request message is not finalized and still subject
+// to possible change or removal.
+message CreateBackfillRequest {
+  // An empty Backfill object.
+  Backfill backfill = 1;
+}
+
+// BETA FEATURE WARNING: This Request message is not finalized and still subject
+// to possible change or removal.
+message DeleteBackfillRequest {
+  // An existing ID of Backfill to delete.
+  string backfill_id = 1;
+}
+
+// BETA FEATURE WARNING: This Request message is not finalized and still subject
+// to possible change or removal.
+message GetBackfillRequest {
+  // An existing ID of Backfill to retrieve.
+  string backfill_id = 1;
+}
+
+// UpdateBackfillRequest - update searchFields, extensions and set assignment.
+// 
+// BETA FEATURE WARNING: This Request message is not finalized and still subject
+// to possible change or removal.
+message UpdateBackfillRequest {
+  // A Backfill object with ID set and fields to update.
+  Backfill backfill = 1;
+}
+
+
 // The FrontendService implements APIs to manage and query status of a Tickets.
 service FrontendService {
   // CreateTicket assigns an unique TicketId to the input Ticket and record it in state storage.
@@ -117,4 +158,55 @@ service FrontendService {
       get: "/v1/frontendservice/tickets/{ticket_id}/assignments"
     };
   }
+
+  // AcknowledgeBackfill is used to notify OpenMatch about GameServer connection info
+  // This triggers an assignment process.
+  // BETA FEATURE WARNING: This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc AcknowledgeBackfill(AcknowledgeBackfillRequest) returns (Backfill) {
+    option (google.api.http) = {
+      post: "/v1/frontendservice/backfills/{backfill_id}/acknowledge"
+      body: "*"
+    };
+  }
+
+  // CreateBackfill creates a new Backfill object.
+  // BETA FEATURE WARNING:  This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc CreateBackfill(CreateBackfillRequest) returns (Backfill) {
+    option (google.api.http) = {
+      post: "/v1/frontendservice/backfills"
+      body: "*"
+    };
+  }
+
+  // DeleteBackfill receives a backfill ID and deletes its resource.
+  // Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
+  // BETA FEATURE WARNING:  This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc DeleteBackfill(DeleteBackfillRequest) returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1/frontendservice/backfills/{backfill_id}"
+    };
+  }
+
+  // GetBackfill returns a backfill object by its ID.
+  // BETA FEATURE WARNING:  This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc GetBackfill(GetBackfillRequest) returns (Backfill) {
+    option (google.api.http) = {
+      get: "/v1/frontendservice/backfills/{backfill_id}"
+    };
+  }
+  
+  // UpdateBackfill updates search_fields and extensions for the backfill with the provided id.
+  // Any tickets waiting for this backfill will be returned to the active pool, no longer pending.
+  // BETA FEATURE WARNING:  This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc UpdateBackfill(UpdateBackfillRequest) returns (Backfill) {
+    option (google.api.http) = {
+      patch: "/v1/frontendservice/backfills"
+      body: "*"
+    };
+  }
 }
diff --git a/src/OpenMatch/proto/api/matchfunction.proto b/src/OpenMatch/proto/api/matchfunction.proto
@@ -19,9 +19,9 @@ option csharp_namespace = "OpenMatch";
 
 import "api/messages.proto";
 import "google/api/annotations.proto";
-import "protoc-gen-swagger/options/annotations.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
 
-option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "Match Function"
     version: "1.0"
@@ -69,8 +69,9 @@ message RunResponse {
 // The MatchFunction service implements APIs to run user-defined matchmaking logics.
 service MatchFunction {
   // DO NOT CALL THIS FUNCTION MANUALLY. USE backend.FetchMatches INSTEAD.
-  // Run pulls Tickets that satisfy Profile constraints from QueryService, runs matchmaking logics against them, then
-  // constructs and streams back match candidates to the Backend service.
+  // Run pulls Tickets that satisfy Profile constraints from QueryService,
+  // runs matchmaking logic against them, then constructs and streams back
+  // match candidates to the Backend service.
   rpc Run(RunRequest) returns (stream RunResponse) {
     option (google.api.http) = {
       post: "/v1/matchfunction:run"
diff --git a/src/OpenMatch/proto/api/messages.proto b/src/OpenMatch/proto/api/messages.proto
@@ -103,6 +103,25 @@ message DoubleRangeFilter {
 
   // Minimum value.
   double min = 3;
+
+  enum Exclude {
+    // No bounds should be excluded when evaluating the filter, i.e.: MIN <= x <= MAX
+    NONE = 0;
+
+    // Only the minimum bound should be excluded when evaluating the filter, i.e.: MIN < x <= MAX
+    MIN = 1;
+
+    // Only the maximum bound should be excluded when evaluating the filter, i.e.: MIN <= x < MAX
+    MAX = 2;
+
+    // Both bounds should be excluded when evaluating the filter, i.e.: MIN < x < MAX
+    BOTH = 3;
+  }
+
+  // Defines the bounds to apply when filtering tickets by their search_fields.double_args value.
+  // BETA FEATURE WARNING: This field and the associated values are
+  // not finalized and still subject to possible change or removal.
+  Exclude exclude = 4;
 }
 
 // Filters strings exactly equaling a value.
@@ -201,6 +220,45 @@ message Match {
   // Optional, depending on the requirements of the connected systems.
   map<string, google.protobuf.Any> extensions = 7;
 
+  // Backfill request which contains additional information to the match
+  // and contains an association to a GameServer.
+  // BETA FEATURE WARNING: This field is not finalized and still subject
+  // to possible change or removal.
+  Backfill backfill = 8;
+
+  // AllocateGameServer signalise Director that Backfill is new and it should 
+  // allocate a GameServer, this Backfill would be assigned.
+  // BETA FEATURE WARNING: This field is not finalized and still subject
+  // to possible change or removal.
+  bool allocate_gameserver = 9;
+
   // Deprecated fields.
   reserved 5, 6;
 }
+
+// Represents a backfill entity which is used to fill partially full matches.
+// 
+// BETA FEATURE WARNING:  This call and the associated Request and Response
+// messages are not finalized and still subject to possible change or removal.
+message Backfill {
+  // Id represents an auto-generated Id issued by Open Match.
+  string id = 1;
+
+  // Search fields are the fields which Open Match is aware of, and can be used
+  // when specifying filters.
+  SearchFields search_fields = 2;
+
+  // Customized information not inspected by Open Match, to be used by
+  // the Match Function, evaluator, and components making calls to Open Match.
+  // Optional, depending on the requirements of the connected systems.
+  map<string, google.protobuf.Any> extensions = 3;
+
+  // Create time is the time the Ticket was created. It is populated by Open
+  // Match at the time of Ticket creation.
+  google.protobuf.Timestamp create_time = 4;
+
+  // Generation gets incremented on GameServers update operations.
+  // Prevents the MMF from overriding a newer version from the game server.
+  // Do NOT read or write to this field, it is for internal tracking, and changing the value will cause bugs.
+  int64 generation = 5;
+}
diff --git a/src/OpenMatch/proto/api/query.proto b/src/OpenMatch/proto/api/query.proto
@@ -19,9 +19,9 @@ option csharp_namespace = "OpenMatch";
 
 import "api/messages.proto";
 import "google/api/annotations.proto";
-import "protoc-gen-swagger/options/annotations.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
 
-option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
   info: {
     title: "MM Logic (Data Layer)"
     version: "1.0"
@@ -52,7 +52,7 @@ option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
   }
   // TODO Add annotations for security_defintiions.
   // See
-  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/proto/examplepb/a_bit_of_everything.proto
+  // https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/internal/proto/examplepb/a_bit_of_everything.proto
 };
 
 message QueryTicketsRequest {
@@ -75,6 +75,20 @@ message QueryTicketIdsResponse {
   repeated string ids = 1;
 }
 
+// BETA FEATURE WARNING:  This Request messages are not finalized and 
+// still subject to possible change or removal.
+message QueryBackfillsRequest {
+  // The Pool representing the set of Filters to be queried.
+  Pool pool = 1;
+}
+
+// BETA FEATURE WARNING:  This Request messages are not finalized and 
+// still subject to possible change or removal.
+message QueryBackfillsResponse {
+  // Backfills that meet all the filtering criteria requested by the pool.
+  repeated Backfill backfills = 1;
+}
+
 // The QueryService service implements helper APIs for Match Function to query Tickets from state storage.
 service QueryService {
   // QueryTickets gets a list of Tickets that match all Filters of the input Pool.
@@ -98,4 +112,14 @@ service QueryService {
       body: "*"
     };
   }
+
+  // QueryBackfills gets a list of Backfills.
+  // BETA FEATURE WARNING:  This call and the associated Request and Response
+  // messages are not finalized and still subject to possible change or removal.
+  rpc QueryBackfills(QueryBackfillsRequest) returns (stream QueryBackfillsResponse) {
+    option (google.api.http) = {
+      post: "/v1/queryservice/backfills:query"
+      body: "*"
+    };
+  }
 }
diff --git a/src/OpenMatch/proto/third_party/protoc-gen-openapiv2/options/annotations.proto b/src/OpenMatch/proto/third_party/protoc-gen-openapiv2/options/annotations.proto
diff --git a/src/OpenMatch/proto/third_party/protoc-gen-openapiv2/options/openapiv2.proto b/src/OpenMatch/proto/third_party/protoc-gen-openapiv2/options/openapiv2.proto
diff --git a/src/OpenMatch/proto/third_party/protoc-gen-swagger/options/openapiv2.proto b/src/OpenMatch/proto/third_party/protoc-gen-swagger/options/openapiv2.proto

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public class BackendServiceClientTest`
`9`	`9`	`[Fact]`
`10`	`10`	`public void CanCreateBackendServiceClient()`
`11`	`11`	`{`
`12`		`- var channel = GrpcChannel.ForAddress("localhost:6000");`
	`12`	`+ var channel = GrpcChannel.ForAddress("https://localhost:6000");`
`13`	`13`	`var omClient = new OpenMatch.BackendService.BackendServiceClient(channel);`
`14`	`14`	`}`
`15`	`15`	`}`