Skip to content

Commit 9b649bc

Browse files
committed
fix: address review of the CLI prefab and config commands (MTT-15298)
- register_prefab treats a prefab as registered when a list entry overrides it, matching entries by source prefab or prefab id hash as NGO does at runtime. - audit reports override entries with no target, a target without a root NetworkObject, or a hash override with a zero source hash. - audit, list_prefabs and register_prefab handle empty list entries; audit reports them as a LIST_ENTRY_INVALID warning. - make_prefab refuses prefabs with child NetworkObjects instead of saving an unsupported network prefab. - config set refuses spawn_timeout outside 10-3600 seconds, and NaN or infinite float values.
1 parent d5c1f54 commit 9b649bc

3 files changed

Lines changed: 159 additions & 14 deletions

File tree

‎com.unity.netcode.gameobjects/Editor/CliQueries/NgoCliQueries.Authoring.cs‎

Lines changed: 77 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,18 @@ internal static PrefabListResult ListPrefabs(string listFilter)
132132
return result;
133133
}
134134

135+
/// <summary>
136+
/// Describes a list entry, with an error when NGO would reject it at runtime (see
137+
/// <see cref="NetworkPrefab.Validate"/>). An empty entry, which netcode ignores, is described as such.
138+
/// </summary>
135139
private static PrefabEntry DescribePrefabEntry(NetworkPrefab prefab)
136140
{
137-
var entry = new PrefabEntry { Override = prefab.Override.ToString() };
138-
var source = prefab.Override switch
141+
if (prefab == null)
139142
{
140-
NetworkPrefabOverride.Prefab => prefab.SourcePrefabToOverride,
141-
_ => prefab.Prefab,
142-
};
143+
return new PrefabEntry { Error = k_EmptyEntry };
144+
}
145+
var entry = new PrefabEntry { Override = prefab.Override.ToString() };
146+
var source = SourcePrefab(prefab);
143147
if (source == null && prefab.Override != NetworkPrefabOverride.Hash)
144148
{
145149
entry.Error = "Missing prefab reference.";
@@ -163,15 +167,70 @@ private static PrefabEntry DescribePrefabEntry(NetworkPrefab prefab)
163167
if (prefab.Override == NetworkPrefabOverride.Hash)
164168
{
165169
entry.OverrideSource = prefab.SourceHashToOverride.ToString();
170+
if (prefab.SourceHashToOverride == 0)
171+
{
172+
entry.Error ??= "The hash override's source hash is 0.";
173+
}
166174
}
167175
if (prefab.Override != NetworkPrefabOverride.None)
168176
{
169177
entry.OverrideSource ??= entry.Path;
170-
entry.OverrideTarget = prefab.OverridingTargetPrefab != null ? AssetDatabase.GetAssetPath(prefab.OverridingTargetPrefab) : null;
178+
var target = prefab.OverridingTargetPrefab;
179+
entry.OverrideTarget = target != null ? AssetDatabase.GetAssetPath(target) : null;
180+
if (target == null)
181+
{
182+
entry.Error ??= "The override has no target prefab.";
183+
}
184+
else if (!target.TryGetComponent<NetworkObject>(out _))
185+
{
186+
entry.Error ??= $"The override target {entry.OverrideTarget} has no NetworkObject on its root.";
187+
}
171188
}
172189
return entry;
173190
}
174191

192+
private const string k_EmptyEntry = "Empty entry, with no prefab set. Netcode ignores it.";
193+
194+
// The prefab an entry registers, as NGO resolves it: a prefab override falls back to Prefab when its source is unset.
195+
private static GameObject SourcePrefab(NetworkPrefab prefab) => prefab.Override switch
196+
{
197+
NetworkPrefabOverride.Prefab => prefab.SourcePrefabToOverride != null ? prefab.SourcePrefabToOverride : prefab.Prefab,
198+
_ => prefab.Prefab,
199+
};
200+
201+
/// <summary>
202+
/// Whether a list already registers this prefab, as NGO matches entries at runtime: by the source prefab id
203+
/// hash, so a prefab override or hash override of it counts. Empty entries are skipped.
204+
/// </summary>
205+
private static bool IsRegisteredIn(NetworkPrefabsList list, GameObject prefab)
206+
{
207+
var hash = prefab.TryGetComponent<NetworkObject>(out var networkObject) ? networkObject.GlobalObjectIdHash : 0;
208+
foreach (var entry in list.PrefabList)
209+
{
210+
if (entry == null)
211+
{
212+
continue;
213+
}
214+
var source = SourcePrefab(entry);
215+
if (source == prefab && entry.Override != NetworkPrefabOverride.Hash)
216+
{
217+
return true;
218+
}
219+
if (hash == 0)
220+
{
221+
continue;
222+
}
223+
var sourceHash = entry.Override == NetworkPrefabOverride.Hash
224+
? entry.SourceHashToOverride
225+
: source != null && source.TryGetComponent<NetworkObject>(out var sourceObject) ? sourceObject.GlobalObjectIdHash : 0;
226+
if (sourceHash == hash)
227+
{
228+
return true;
229+
}
230+
}
231+
return false;
232+
}
233+
175234
/// <summary>
176235
/// Adds a prefab to a NetworkPrefabsList: the named one, else the list of the scene's NetworkManager, else
177236
/// the project's default list. With default prefab generation on, NetworkObject prefabs are usually in the
@@ -188,11 +247,11 @@ internal static RegisterPrefabResult RegisterPrefab(string prefab, string listPa
188247
}
189248

190249
var result = new RegisterPrefabResult { DryRun = dryRun, Prefab = prefabPath };
191-
var registeredIn = FindPrefabsLists().Where(l => l.Contains(prefabAsset)).Select(AssetDatabase.GetAssetPath).ToList();
250+
var registeredIn = FindPrefabsLists().Where(l => IsRegisteredIn(l, prefabAsset)).Select(AssetDatabase.GetAssetPath).ToList();
192251
var list = ResolveTargetList(listPath, dryRun, result.Notes);
193252
result.List = list != null ? AssetDatabase.GetAssetPath(list) : NetworkPrefabProcessor.DefaultNetworkPrefabsPath;
194253

195-
if (list != null && list.Contains(prefabAsset))
254+
if (list != null && IsRegisteredIn(list, prefabAsset))
196255
{
197256
result.AlreadyRegistered = true;
198257
if (list.IsDefault && NetcodeForGameObjectsProjectSettings.instance.GenerateDefaultNetworkPrefabs)
@@ -269,7 +328,7 @@ internal static MakePrefabResult MakePrefab(string prefab, bool dryRun)
269328
{
270329
result.AlreadyNetworkObject = true;
271330
result.PrefabIdHash = existing.GlobalObjectIdHash;
272-
result.RegisteredIn = FindPrefabsLists().Where(l => l.Contains(prefabAsset)).Select(AssetDatabase.GetAssetPath).FirstOrDefault();
331+
result.RegisteredIn = FindPrefabsLists().Where(l => IsRegisteredIn(l, prefabAsset)).Select(AssetDatabase.GetAssetPath).FirstOrDefault();
273332
return result;
274333
}
275334
if (prefabAsset.GetComponentInChildren<NetworkManager>(true) != null)
@@ -279,7 +338,8 @@ internal static MakePrefabResult MakePrefab(string prefab, bool dryRun)
279338
var nested = prefabAsset.GetComponentsInChildren<NetworkObject>(true);
280339
if (nested.Length > 0)
281340
{
282-
result.Notes.Add($"It already has {nested.Length} child NetworkObject(s). Each spawns separately; the new root NetworkObject won't spawn them.");
341+
// Nested NetworkObjects are only supported in scene objects: a network prefab doesn't spawn them.
342+
throw new ArgumentException($"{path} has {nested.Length} child NetworkObject(s), and network prefabs don't support nested NetworkObjects. Make each of those children its own network prefab, or remove their NetworkObjects, then run make_prefab again.");
283343
}
284344
if (dryRun)
285345
{
@@ -302,7 +362,7 @@ internal static MakePrefabResult MakePrefab(string prefab, bool dryRun)
302362
{
303363
result.Notes.Add("The prefab id hash is generated on the next import; check it with netcode.gameobjects list_prefabs.");
304364
}
305-
result.RegisteredIn = FindPrefabsLists().Where(l => l.Contains(reloaded)).Select(AssetDatabase.GetAssetPath).FirstOrDefault();
365+
result.RegisteredIn = FindPrefabsLists().Where(l => IsRegisteredIn(l, reloaded)).Select(AssetDatabase.GetAssetPath).FirstOrDefault();
306366
if (result.RegisteredIn == null)
307367
{
308368
result.Notes.Add("Not in a network prefabs list yet. Register it with netcode.gameobjects register_prefab.");
@@ -396,7 +456,7 @@ internal static AuditResult AuditPrefabs(string folder, int limit)
396456

397457
var result = new AuditResult();
398458
var lists = FindPrefabsLists();
399-
var registered = new HashSet<GameObject>(lists.SelectMany(l => l.PrefabList).Select(p => p.Prefab).Where(p => p != null));
459+
var registered = new HashSet<GameObject>(lists.SelectMany(l => l.PrefabList).Where(p => p != null).Select(SourcePrefab).Where(p => p != null));
400460
var autoGenerate = NetcodeForGameObjectsProjectSettings.instance.GenerateDefaultNetworkPrefabs;
401461
var hashes = new Dictionary<uint, string>();
402462
var scriptCache = new Dictionary<string, bool>();
@@ -442,6 +502,11 @@ void Add(string severity, string code, string asset, string message)
442502
var listPath = AssetDatabase.GetAssetPath(list);
443503
foreach (var entry in list.PrefabList)
444504
{
505+
if (entry == null)
506+
{
507+
Add("warning", "LIST_ENTRY_INVALID", listPath, k_EmptyEntry);
508+
continue;
509+
}
445510
var described = DescribePrefabEntry(entry);
446511
if (described.Error != null)
447512
{

‎com.unity.netcode.gameobjects/Editor/CliQueries/NgoCliQueries.Config.cs‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ private static void ValidateConfigValue(string fieldName, string name, object va
193193
case nameof(NetworkConfig.NetworkTopology) when (NetworkTopologyTypes)value == NetworkTopologyTypes.DistributedAuthority:
194194
notes.Add("Distributed authority needs a session service (use_cmb_service, e.g. through the Multiplayer Services SDK) or a distributed authority host.");
195195
break;
196+
case nameof(NetworkConfig.SpawnTimeout) when (float)value < NetworkConfig.MinSpawnTimeout || (float)value > NetworkConfig.MaxSpawnTimeout:
197+
throw new ArgumentException($"{name} must be between {NetworkConfig.MinSpawnTimeout} and {NetworkConfig.MaxSpawnTimeout} seconds.");
196198
case nameof(NetworkConfig.ClientConnectionBufferTimeout) or nameof(NetworkConfig.LoadSceneTimeOut) or nameof(NetworkConfig.TimeResyncInterval) when (int)value < 1:
197199
throw new ArgumentException($"{name} must be at least 1.");
198200
}
@@ -304,7 +306,7 @@ private static void ValidateManager(NetworkManager manager, Action<string, strin
304306
add("error", "PLAYER_PREFAB_WITHOUT_NETWORKOBJECT", where, $"The player prefab {AssetPathOrName(config.PlayerPrefab)} has no NetworkObject on its root.");
305307
}
306308

307-
var prefabs = lists.SelectMany(l => l.PrefabList).Select(p => p.Prefab).Where(p => p != null).ToList();
309+
var prefabs = lists.SelectMany(l => l.PrefabList).Where(p => p != null).Select(p => p.Prefab).Where(p => p != null).ToList();
308310
if (config.PlayerPrefab != null)
309311
{
310312
prefabs.Add(config.PlayerPrefab);
@@ -382,7 +384,12 @@ private static object ParseValue(Type type, string value, string name)
382384
_ => throw new FormatException(),
383385
};
384386
}
385-
return Convert.ChangeType(text, type, CultureInfo.InvariantCulture);
387+
var parsed = Convert.ChangeType(text, type, CultureInfo.InvariantCulture);
388+
if (parsed is float f && !float.IsFinite(f) || parsed is double d && !double.IsFinite(d))
389+
{
390+
throw new FormatException();
391+
}
392+
return parsed;
386393
}
387394
catch (Exception e) when (e is FormatException or OverflowException or InvalidCastException)
388395
{

‎com.unity.netcode.gameobjects/Tests/Editor/Cli/NgoCliQueriesTests.cs‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,63 @@ public void RegisterPrefab_AddsOnceAndListsIt()
206206
Assert.AreEqual($"{k_Folder}/Networked.prefab", listed.Prefabs.Single().Path);
207207
}
208208

209+
[Test]
210+
public void RegisterPrefab_OverrideSourceCountsAsRegistered()
211+
{
212+
var source = CreatePrefab("Source", typeof(NetworkObject));
213+
var target = CreatePrefab("Target", typeof(NetworkObject));
214+
var list = ScriptableObject.CreateInstance<NetworkPrefabsList>();
215+
AssetDatabase.CreateAsset(list, k_ListPath);
216+
// As in the inspector's override entries: Prefab differs from the source being overridden.
217+
list.Add(new NetworkPrefab { Override = NetworkPrefabOverride.Prefab, Prefab = target, SourcePrefabToOverride = source, OverridingTargetPrefab = target });
218+
219+
var result = NgoCliQueries.RegisterPrefab("Source", k_ListPath, false);
220+
221+
Assert.IsTrue(result.AlreadyRegistered);
222+
Assert.IsFalse(result.Registered);
223+
Assert.AreEqual(1, list.PrefabList.Count);
224+
}
225+
226+
[Test]
227+
public void MakePrefab_WithChildNetworkObjects_ChangesNothing()
228+
{
229+
var parent = new GameObject("Parent");
230+
new GameObject("Child", typeof(NetworkObject)).transform.SetParent(parent.transform);
231+
PrefabUtility.SaveAsPrefabAsset(parent, $"{k_Folder}/Parent.prefab");
232+
UnityEngine.Object.DestroyImmediate(parent);
233+
234+
var error = Assert.Throws<ArgumentException>(() => NgoCliQueries.MakePrefab("Parent", false));
235+
236+
StringAssert.Contains("nested NetworkObjects", error.Message);
237+
Assert.IsNull(AssetDatabase.LoadAssetAtPath<GameObject>($"{k_Folder}/Parent.prefab").GetComponent<NetworkObject>());
238+
}
239+
240+
[Test]
241+
public void AuditPrefabs_ReportsBrokenOverridesAndEmptyEntries()
242+
{
243+
var source = CreatePrefab("Source", typeof(NetworkObject));
244+
var plain = CreatePrefab("Plain");
245+
var list = ScriptableObject.CreateInstance<NetworkPrefabsList>();
246+
AssetDatabase.CreateAsset(list, k_ListPath);
247+
list.Add(null);
248+
list.Add(new NetworkPrefab { Override = NetworkPrefabOverride.Prefab, SourcePrefabToOverride = source });
249+
list.Add(new NetworkPrefab { Override = NetworkPrefabOverride.Prefab, SourcePrefabToOverride = source, OverridingTargetPrefab = plain });
250+
list.Add(new NetworkPrefab { Override = NetworkPrefabOverride.Hash, SourceHashToOverride = 0, OverridingTargetPrefab = source });
251+
252+
var result = NgoCliQueries.AuditPrefabs(k_Folder, 50);
253+
254+
var entries = result.Issues.Where(i => i.Code == "LIST_ENTRY_INVALID" && i.Asset == k_ListPath).ToList();
255+
var found = string.Join(" | ", entries.Select(i => $"{i.Severity}: {i.Message}"));
256+
Assert.AreEqual(4, entries.Count, found);
257+
Assert.AreEqual(1, entries.Count(i => i.Severity == "warning"), "Netcode ignores an empty entry: " + found);
258+
Assert.IsTrue(entries.Any(i => i.Message.Contains("no target prefab")), found);
259+
Assert.IsTrue(entries.Any(i => i.Message.Contains("Plain.prefab has no NetworkObject")), found);
260+
Assert.IsTrue(entries.Any(i => i.Message.Contains("source hash is 0")), found);
261+
262+
var listed = NgoCliQueries.ListPrefabs("CliTestPrefabs").Lists.Single();
263+
Assert.AreEqual(4, listed.Prefabs.Count, "Listing doesn't stop at an empty entry.");
264+
}
265+
209266
[Test]
210267
public void RegisterPrefab_WithoutNetworkObject_PointsToMakePrefab()
211268
{
@@ -309,6 +366,22 @@ public void SetConfig_ValidatesAndApplies()
309366
StringAssert.Contains("Relay", relay.Message);
310367
}
311368

369+
[Test]
370+
public void SetConfig_RejectsOutOfRangeAndNonFiniteFloats()
371+
{
372+
var manager = CreateManager();
373+
var spawnTimeout = manager.NetworkConfig.SpawnTimeout;
374+
375+
StringAssert.Contains("between", Assert.Throws<ArgumentException>(() => NgoCliQueries.SetConfig("spawn_timeout", "0", null, false)).Message);
376+
Assert.Throws<ArgumentException>(() => NgoCliQueries.SetConfig("spawn_timeout", "4000", null, false));
377+
Assert.Throws<ArgumentException>(() => NgoCliQueries.SetConfig("spawn_timeout", "NaN", null, false));
378+
Assert.Throws<ArgumentException>(() => NgoCliQueries.SetConfig("network_id_recycle_delay", "Infinity", null, false));
379+
Assert.AreEqual(spawnTimeout, manager.NetworkConfig.SpawnTimeout, "A rejected value changes nothing.");
380+
381+
NgoCliQueries.SetConfig("spawn_timeout", "30", null, false);
382+
Assert.AreEqual(30f, manager.NetworkConfig.SpawnTimeout);
383+
}
384+
312385
[Test]
313386
public void SetConfig_LogLevel_ChangesTheManager()
314387
{

0 commit comments

Comments
 (0)