Merge branch 'develop-2.0.0' into fix/v2.x/disconnect-event-notifications-2390

Author: NoelStephensUnity

.github/pull_request_template.md

@@ -1,36 +1,61 @@
-<!-- Replace this block with what this PR does and why. Describe what you'd like reviewers to know, how you applied the engineering principles, and any interesting tradeoffs made. Delete bullet points below that don't apply, and update the changelog section as appropriate. -->
+## Purpose of this PR
+[//]: # (
+Replace this block with what this PR does and why. Describe what you'd like reviewers to know, how you applied the engineering principles, and any interesting tradeoffs made. 
+)
 
-<!-- Add short version of the JIRA ticket to the PR title (e.g. "feat: new shiny feature [MTT-123]") -->
+### Jira ticket
+_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
 
-## Changelog
+### Changelog
+[//]: # (updated with all public facing changes  - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
 
 - Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
-- Fixed: If you update multiple packages, create a new section with a new header for the other package. 
-- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
-
-## Testing and Documentation
-
-- No tests have been added.
-- Includes unit tests.
-- Includes integration tests.
-- No documentation changes or additions were necessary.
-- Includes documentation for previously-undocumented public API entry points.
-- Includes edits to existing public API documentation.
+- Fixed: If you update multiple packages, create a new section with a new header for the other package.
+- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go
 
 <!--  Uncomment and mark items off with a * if this PR deprecates any API:
 ### Deprecated API
 - [ ] An `[Obsolete]` attribute was added along with a `(RemovedAfter yyyy-mm-dd)` entry.
-- [ ] An [api updater] was added.
+- [ ] An [api updater](https://confluence.unity3d.com/display/DEV/Obsolete+API+updaters) was added.
 - [ ] Deprecation of the API is explained in the CHANGELOG.
 - [ ] The users can understand why this API was removed and what they should use instead.
 -->
 
-## Backport
+## Documentation
+[//]: # (
+This section is REQUIRED and should mention what documentation changes were following the changes in this PR. 
+We should always evaluate if the changes in this PR require any documentation changes.
+)
 
-<!-- If this is a backport:
- - Add the following to the PR title: "\[Backport\] ..." .
- - Link to the original PR.
-If this needs a backport - state this here
-If a backport is not needed please provide the reason why.
-If the "Backports" section is not present it will lead to a CI test failure. 
--->
+- No documentation changes or additions were necessary.
+- Includes documentation for previously-undocumented public API entry points.
+- Includes edits to existing public API documentation.
+
+## Testing & QA
+[//]: #  (
+This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
+It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
+Expectation is that PR creator does some manual testing and provides a summary of it here.)
+
+### Functional Testing
+[//]: # (If checked, List manual tests that have been performed.)
+_Manual testing :_
+- [ ] `Manual testing done`
+
+_Automated tests:_
+- [ ] `Covered by existing automated tests`
+- [ ] `Covered by new automated tests`
+
+_Does the change require QA team to:_
+
+- [ ] `Review automated tests`?
+- [ ] `Execute manual tests`?
+
+If any boxes above are checked, please add QA as a PR reviewer.
+
+## Backport
+[//]: # (
+This section is REQUIRED and should link to the PR that targets other NGO version which is either develop or develop-2.0.0 branch
+Add the following to the PR title: "\[Backport\] ..."
+If this is not needed, for example feature specific to NGOv2.X, then just mention this fact.
+)

.github/workflows/backport-verification.yml

@@ -0,0 +1,62 @@
+# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
+# ## Backport section is important as a reminder to account for backports for anyone that works with NGO repository (to 1.X or 2.X branches respectively).
+# ## Testing & QA section is important to ensure that the PR has appropriate testing coverage and is important when QA will evaluate PRs before Playtesting for the release.
+# ## Documentation section is important to ensure that the documentation is updated with the changes made in the PR.
+
+# If any of the sections is missing, the workflow will fail and block the PR from merging, prompting the developer to add those sections to the PR description.
+# The workflow is configured to run when PR is created as well as when it is edited which also counts simple description edits.
+
+name: "NGO - PR Verification"
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+    branches:
+      - develop
+      - develop-2.0.0
+      - release/*
+
+jobs:
+  pr-verification:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check PR description
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const pr = context.payload.pull_request;
+            const body = pr.body || '';
+
+            // List of mandatory PR sections
+            const requiredSections = [
+              {
+                header: '## Backport',
+                description: 'PR description must include a "## Backport" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
+              },
+              {
+                header: '## Testing & QA',
+                description: 'PR description must include a "## Testing & QA" section. Please add this section and provide information about the testing performed for this PR. It can range from adding unit tests to full samples and is needed from QA side to analyze PRs while Playtesting for the release.'
+              },
+              {
+                header: '## Documentation',
+                description: 'PR description must include a "## Documentation" section. Please add this section and provide information about the documentation changes made in this PR. It is important to keep the documentation up to date with the code changes.'
+              }
+            ];
+
+            const missing = requiredSections.filter(section => !body.includes(section.header));
+
+            if (missing.length > 0) {
+              let message = 'PR description is missing the following required section(s):\n';
+
+              const missingDescriptions = missing.map(
+                s => `- ${s.header}: ${s.description}`
+              );
+
+              message += missingDescriptions.join('\n');
+              message += '\n\nPlease add them to your PR description.';
+
+              core.setFailed(message);
+            }

.github/workflows/pr-verification.yml

@@ -60,33 +60,98 @@ echo "Starting with echo server on port: $echo_port and the cmb service on port:
 
 # Setup -------------------------------------------------------------------------
 
+
+ThrewError=false
+
+# Mimics "Try-Catch" where you have to check if an error occurred after invoking
+try() {
+   ThrewError=false
+  "$@" || throw "$@"
+}
+
+# Invoked by try
+throw() {
+    logError "An error occurred executing this command:$@"
+    ThrewError=true
+}
+
+# A way to log messages that are easy to distinguish from the rest of the logs
+logMessage(){
+    printf "\n############################################\n"
+    printf "$@\n"
+    printf "############################################\n"
+}
+
+# A way to log error messages that are easy to distinguish from the rest of the logs
+logError(){
+    printf "\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
+    printf "$@\n"
+    printf "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
+}
+
+# Protocol Buffer Compiler ------------------------------------------------------
+
+# Apply any updates 
+logMessage "Updating modules..."
+sudo apt-get update
+
+# Install Protocol Buffer Compiler (using apt-get)
+logMessage "Installing protocol bufffer compiler as SUDO..."
+try sudo apt-get install -y protobuf-compiler
+
+# If the previous command failed, try without sudo
+if $ThrewError; then
+logMessage "Installing protocol bufffer compiler as shell assigned account..."
+apt-get install -y protobuf-compiler
+else
+logMessage "Protocol bufffer compiler was installed as sudo!"
+fi
+
+# Add the PROTOC environment variable that points to the Protocol Buffer Compiler binary
+export PROTOC="/usr/bin/protoc"
+
+# Validate the PROTOC env var by getting the protoc version
+try $PROTOC --version
+
+if $ThrewError; then
+logError "Failed to properly run protoc!"
+exit -1
+else
+logMessage "Protocol Buffer Compiler Installed & ENV variables verified!\n PROTOC path is: $PROTOC"
+fi
+
 # clone the cmb service repo
 git clone https://github.com/Unity-Technologies/mps-common-multiplayer-backend.git
+
 # navigate to the cmb service directory
 cd ./mps-common-multiplayer-backend/runtime
 
 # Install rust
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+
 # Add the cargo bin directory to the PATH
 export PATH="$HOME/.cargo/bin:$PATH"
 
-
 # Echo server -------------------------------------------------------------------
 
 # Build the echo server
+logMessage "Beginning echo server build..."
 cargo build --example ngo_echo_server
+
 # Run the echo server in the background
+logMessage "Running echo server tests..."
 cargo run --example ngo_echo_server -- --port $echo_port &
 
-
 # CMB Service -------------------------------------------------------------------
 
 # Build a release version of the standalone cmb service
+logMessage "Beginning service release build..."
 cargo build --release --locked
 
 # Run the standalone service on an infinite loop in the background.
 # The infinite loop is required as the service will exit each time all connected clients disconnect.
 # This means the service will exit after each test. The infinite loop will immediately restart the service each time it exits.
+logMessage "Running service integration tests..."
 while :; do
   ./target/release/comb-server -l error --metrics-port 5000 standalone --port $service_port -t 60m;
 done & # <- use & to run the entire loop in the background

Tools/CI/run_cmb_service.sh

@@ -10,17 +10,21 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Added
 
+- Added `AsNativeArray()` read‑only accessor to `NetworkList<T>` (#3567)
 - Added disconnection event notification handling capabilities where `NetworkTransport` derived custom transports can set the current disconnect event type (`NetworkTransport.DisconnectEvents`) that, if implemented, will provide more details on why the transport disconnected. (#3551)
 - Added protected method `NetworkTransport.SetDisconnectEvent` that a `NetworkTransport` derived custom transport can use to provide the disconnect event type that occurred. (#3551)
 - Added protected virtual method `NetworkTransport.OnGetDisconnectEventMessage` that, when overridden, a `NetworkTransport` derived custom transport can use to provide a customized extended message for each `NetworkTransport.DisconnectEvents` value. (#3551)
 
 ### Fixed
 
+- Fixed issue where viewing a `NetworkBehaviour` with one or more `NetworkVariable` fields could throw an exception if running a distributed authority network topology with a local (DAHost) host and viewed on the host when the host is not the authority of the associated `NetworkObject`. (#3578)
+- Fixed issue when using a distributed authority network topology and  viewing a `NetworkBehaviour` with one or more `NetworkVariable` fields in the inspector view would not show editable fields. (#3578)
 - Fixed issue where the disconnect event and provided message was too generic to know why the disconnect occurred. (#3551)
 - Fixed issue where `SendTo.NotMe` could cause an RPC to be delivered to the sender when connected to a live distributed authority session. (#3551)
 
 ### Changed
 
+- Optimized `NetworkList<T>` indexer setter to skip operations when the new value equals the existing value, improving performance by avoiding unnecessary list events and network synchronization. (#3587)
 - Changed `UnityTransport` now handles setting the current disconnect notification type, via internal `UnityTransportNotificationHandler` class, while also providing extended informational messages for each disconnect event type. (#3551)
 
 ## [2.5.0] - 2025-08-01
@@ -30,10 +34,11 @@ Additional documentation and release notes are available at [Multiplayer Documen
 - Added serializer for `Pose` (#3546)
 - Added methods `GetDefaultNetworkSettings` and `GetDefaultPipelineConfigurations` to `UnityTransport`. These can be used to retrieve the default settings and pipeline stages that are used by `UnityTransport`. This is useful when providing a custom driver constructor through `UnityTransport.s_DriverConstructor`, since it allows reusing or tuning the existing configuration instead of trying to recreate it. This means a transport with a custom driver can now easily benefit from most of the features of `UnityTransport`, like integration with the Network Simulator and Network Profiler from the multiplayer tools package. (#3501)
 - Added mappings between `ClientId` and `TransportId`. (#3516)
-- Added `NetworkPrefabInstanceHandlerWithData<T>`, a variant of `INetworkPrefabInstanceHandler` that provides access to custom instantiation data directly within the `Instantiate()` method. (#3430)
+- Added `NetworkPrefabInstanceHandlerWithData<T>`, a variant of `INetworkPrefabInstanceHandler` that provides access to custom instantiation data directly within the `Instantiate()` method. (#3497)
 
 ### Fixed
 
+- Removed allocation to the heap in NetworkBehaviourUpdate. (#3573)
 - Fixed issue where NetworkConfig.ConnectionData could cause the ConnectionRequestMessage to exceed the transport's MTU size and would result in a buffer overflow error. (#3564)
 - Fixed regression issue in v2.x where `NetworkObject.GetNetworkBehaviourAtOrderIndex` was converted from public to internal. (#3541)
 - Fixed ensuring OnValueChanged callback is still triggered on the authority when a collection changes and then reverts to the previous value in the same frame. (#3539)

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -34,6 +34,7 @@
   * [Ownership race conditions](basics/race-conditions.md)
 * [Spawning and despawning](spawn-despawn.md)
   * [Object spawning](basics/object-spawning.md)
+  * [Network prefab handler](advanced-topics/network-prefab-handler.md)
   * [Object pooling](advanced-topics/object-pooling.md)
   * [Object visibility](basics/object-visibility.md)
   * [Spawning synchronization](basics/spawning-synchronization.md)
@@ -100,4 +101,4 @@
     * [NetworkObject parenting](samples/bossroom/networkobject-parenting.md)
     * [Optimizing Boss Room](samples/bossroom/optimizing-bossroom.md)
     * [NetworkRigidbody](samples/bossroom/networkrigidbody.md)
-    * [Spawn NetworkObjects](samples/bossroom/spawn-networkobjects.md)
+    * [Spawn NetworkObjects](samples/bossroom/spawn-networkobjects.md)