feat: Unity Transport + Relay #887

cdmazom · 2021-06-05T01:43:11Z

This PR adds support for using the Unity Transport package as a transport for MLAPI.

wip still waiting on some packages to be published.

Relay SDK stuff

Pushing latest

updating UTP to preview 5 with Relay ping support fixing issue with endpoint

Some cleanup

cleanup

In order to use Relay for this transport you need to install the package into your project its no longer a dependcy

…lay-utp

* update to relay sdk v0.0.1-preview.5 * remove workarounds - use byte array representation of allocation id - connection data truncation is not longer needed - set default relay endpoint as production * updated auth to v0.5.0 - updated core and authentication versions - updated relay version (compatible with latest core) - updated authentication calls

unity-cla-assistant · 2021-06-17T18:34:35Z

All committers have signed the CLA.

C# Guid convertion to byte array is not compatbile with relay, intead we can use the byte array provided by the relay sdk

MLAPI appears to expect Connect events on servers when new clients connect (at least this is what's implemented in SIPTransport). UTP doesn't generate Connect events server-side, so we must generate them ourselves when accepting connections.

* Add some basic UTPTranport tests * Implement OnDestroy in UTPTransport The implementation is the same as Shutdown, meaning it only disposes of the driver (if not already disposed of). The driver (!) for this change is to avoid leaking resources when tests fail. * Add connection tests for UTPTransport * Add basic data transmission tests for UTPTransport

* Correctly handle empty messages in Send The UTPTransport.Send method would throw a NullReferenceException exception when passed default(ArraySegment<byte>) as the message data. Now it simply sends an empty message to its remote host (not a terribly useful feature, but better than an exception). * Make it possible to receive messages >1024 bytes The fragmentation pipeline was set up to handle messages up to 6KB in length, but the receive buffer was only 1KB long. Messages longer than that were just ignored (although an error message was logged). * Add proper support for channels in UTPTransport The transport now selects an appropriate pipeline according to the delivery level of the channel, rather than send everything on the default unreliable pipeline.

* DST-528: Extracted Relay SDK calls out of UTP adapter for MLAPI; it now accepts a variable passed in via a setter method. Also updated the sample test project included to illustrate these changes. * DST-528: Made some changes that address feedback comments; mainly restructured the manner that code external to UTPTransport passes in the requisite relay server data so that external code doesn't need to know about the internal data structures that UTPTransport uses. * DST-528: Removing minor changes that were erroneously left in when taking other approaches.

) This reverts commit ccbf652.

com.unity.netcode.adapter.utp/Runtime/com.unity.netcode.adapter.utp.asmdef

0xFA11 · 2021-09-09T22:49:46Z

testproject/ProjectSettings/ProjectVersion.txt

-m_EditorVersion: 2020.3.12f1
-m_EditorVersionWithRevision: 2020.3.12f1 (b3b2c6512326)
+m_EditorVersion: 2020.3.15f2
+m_EditorVersionWithRevision: 2020.3.15f2 (6cf78cb77498)


unnecessary?

I mean personally I think the project should always be on the latest version of the LTS :P but that is just me. which would be .18 :P I me right now with PR triggers we aren't even testing on 2020.3 which I find also wrong.

nightly runs on various platforms and versions at least, but yeah 2020.3 baseline for PRs might be more useful, I'm not sure

Well seeing as how its the min version for the package it should run on it :P I mean for UTP we run on 2020.3/2021.2/trunk across all desktop platforms for PRs because more often then I would like to admit stuff breaks across unity versions. I think we should at least make sure PRs work with the min version.

0xFA11 · 2021-09-09T22:50:07Z

testproject/ProjectSettings/ProjectSettings.asset

-  projectName: 
-  organizationId: 
+  projectName: relay-stg
+  organizationId: relay-stg


not needed?

Yes, those values are for the cloud services related stuff since we did add relay testing to the project. So for internal testing that is what they need to be, if public devs want to mess around with things this value will automatically get updated with their services info when they login to their services uDash. So for us yes its required.

com.unity.netcode.adapter.utp/Editor/MultiplayerWindow.cs

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs

simon-lemay-unity · 2021-09-10T14:24:34Z

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs

+
+            InitDriver();
+
+            if (m_Driver.Bind(NetworkEndPoint.AnyIpv4) != 0)


Is IPv6 supported by the adapter? If so, might want to choose between this and AnyIpv6 depending on the address family of serverEndpoint.

Alternatively, I don't think there's any need to bind on the client side. Could remove this entirely.

We do support IPv6 in the transport but I don't think we support it currently in the adapter.

As for binding the protocol can bind which in this case we use for Relay

I will add a ticket to support IPV6 to the transport API in general.

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs

…on't delay the queued messages by another tick

0xFA11 · 2021-09-13T14:58:24Z

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs

+            Connected,
+        }
+
+        public const int MaximumMessageLength = 6 * 1024;


where this number is coming from?

Boss Room :( It is still configurable in the serialized field.

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs

com.unity.netcode.adapter.utp/Tests/Editor/UTPTransportTests.cs

0xFA11

some naming nits but apart from that, looks good to me!
(UTP -> UnityTransport & NGO -> Netcode)

…nsform * develop: feat: NetworkBehaviour.IsSpawned (#1190) feat: added tip to the network manager inspector that directs to install tools (MTT-1211) (#1182) refactor!: remove network dictionary & set, use native container in List, add tests (#1149) fix: Fixed remote disconnects not properly cleaning up (#1184) test: base changes to PR-1114 (#1165) test: verify do not destroy networkobjects on networkmanager shutdown (#1183) chore: removal of EnableNetworkVariable in NetworkConfig. It's always True now (#1179) fix: Fix DontDestroyWithOwner not returning ownership (#1181) test: Giving Android some more room as the connection tests are timing sensitive (#1178) fix: unitytransport connectionmode buttons (#1176) test: added min frames to multi-instance helper (#1170) chore: Add mobile tests to nightly trigger (#1161) feat: snapshot spawn pre-requisite (#1166) feat: Unity Transport + Relay (#887) feat: client scene synchronization mode (#1171) # Conflicts: # testproject/Assets/Scenes/SampleScene.unity

* Adding support for UTP/Unity Relay in Netcode for GameObjects Co-authored-by: Andrew Spiering <aspiering@gmail.com> Co-authored-by: Andrew Spiering <andrews@unity3d.com> Co-authored-by: Fernando Galandrini <fernando.galandrini@gmail.com> Co-authored-by: Iurii Zakipnyi <jura.zakipniy@gmail.com> Co-authored-by: Fernando Galandrini <fernando.galandrini@unity3d.com> Co-authored-by: Simon Lemay <simon.lemay@unity3d.com> Co-authored-by: thoward-unity <87874023+thoward-unity@users.noreply.github.com> Co-authored-by: Cosmin <cosmin.bararu@unity3d.com>

wackoisgod and others added 12 commits May 27, 2021 17:39

feat: Initial new UTP Transport

7aa6e13

wip still waiting on some packages to be published.

chore: forgot these files

cd808d2

Removing registry

93790cc

feat: Some UI for authenticating and setup for relay

b6dfb8a

Relay SDK stuff

feat: pushing latest stuff

2d6a393

Pushing latest

chore: fixing define and changing buffer to 1024

8dbad67

chore: updating package

43cd593

updating UTP to preview 5 with Relay ping support fixing issue with endpoint

Chore: Cleanup

b3be347

Some cleanup

chore: file cleanup

6c44ec1

cleanup

fix: Make it so Relay is not a direct depenecy of MLAPI UTP Transport

a58faef

In order to use Relay for this transport you need to install the package into your project its no longer a dependcy

Re-enable Relay Transport on Sample project

b92259c

Merge remote-tracking branch 'origin/develop' into feature/initial-re…

75133d4

…lay-utp

cdmazom assigned fraserhutch2020 Jun 5, 2021

cdmazom changed the title ~~Feature: UTP Transport + Relay~~ feat: UTP Transport + Relay Jun 5, 2021

Jura-Z and others added 11 commits June 22, 2021 06:50

Faster pointer and ref based UTP API usage (#912)

f07a164

use allocation id bytes instead of guid

7f07d71

C# Guid convertion to byte array is not compatbile with relay, intead we can use the byte array provided by the relay sdk

Merge branch 'develop' into feature/initial-relay-utp

e38d4cb

bug: Fixing Packages Version

8d934cf

bug: Adding support for frag pipeline

4d26070

Merge branch 'develop' into feature/initial-relay-utp

995b6f4

Updating package files

8914ab6

Exposing the Fragmentation Capacity which was too small for boss room

4cd203c

cdmazom unassigned fraserhutch2020 Aug 4, 2021

thoward-unity added 2 commits August 9, 2021 14:25

Revert "Feature/initial relay utp remove relay sdk calls (#1032)" (#1033

cd54529

) This reverts commit ccbf652.

0xFA11 reviewed Sep 9, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/com.unity.netcode.adapter.utp.asmdef Outdated Show resolved Hide resolved

0xFA11 reviewed Sep 9, 2021

View reviewed changes

Cosmin-B approved these changes Sep 10, 2021

View reviewed changes

andrews-unity added 2 commits September 10, 2021 14:20

Update ProjectVersion.txt

51d1f69

Merge branch 'develop' into feature/initial-relay-utp

5266eea

simon-lemay-unity reviewed Sep 10, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Editor/MultiplayerWindow.cs Outdated Show resolved Hide resolved

simon-lemay-unity reviewed Sep 10, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

simon-lemay-unity reviewed Sep 10, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

andrews-unity and others added 3 commits September 10, 2021 17:18

Addressing some PR feedback

7ba5ed6

fix: move FlushSendQueues call before we do drive update so that we d…

bb2f110

…on't delay the queued messages by another tick

Merge branch 'develop' into feature/initial-relay-utp

20f3f17

simon-lemay-unity approved these changes Sep 13, 2021

View reviewed changes

0xFA11 reviewed Sep 13, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

0xFA11 reviewed Sep 13, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

0xFA11 reviewed Sep 13, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

0xFA11 reviewed Sep 13, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Runtime/UTPTransport.cs Outdated Show resolved Hide resolved

0xFA11 reviewed Sep 13, 2021

View reviewed changes

com.unity.netcode.adapter.utp/Tests/Editor/UTPTransportTests.cs Outdated Show resolved Hide resolved

PR Feedback

9715ced

0xFA11 approved these changes Sep 13, 2021

View reviewed changes

Fixing rename issues

95ca9e0

0xFA11 changed the title ~~feat: UTP Transport + Relay~~ feat: Unity Transport + Relay Sep 13, 2021

Merge branch 'develop' into feature/initial-relay-utp

13a7ed3

andrews-unity enabled auto-merge (squash) September 13, 2021 17:50

andrews-unity merged commit a02dfee into develop Sep 13, 2021

andrews-unity deleted the feature/initial-relay-utp branch September 13, 2021 18:20


		InitDriver();

		if (m_Driver.Bind(NetworkEndPoint.AnyIpv4) != 0)

feat: Unity Transport + Relay #887

feat: Unity Transport + Relay #887

Uh oh!

Conversation

cdmazom commented Jun 5, 2021

Uh oh!

unity-cla-assistant commented Jun 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrews-unity Sep 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

0xFA11 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

unity-cla-assistant commented Jun 17, 2021 •

edited

Loading

andrews-unity Sep 10, 2021 •

edited

Loading