Skip to content

Commit f838693

Browse files
MikeDobrzanMikeDobrzan
authored
refactor: CLEN-555 (#68)
refactor: Implemented UserId configuration option, and switched UUID into obsolete alias properties. refactor: Rename UUID to UserId in configuration object The UUID field is now marked as deprecated, it is advised to switch to UserId. fix: Change AuthorizedUUID to AuthorizedUserId fix: UserId error messages fix: remove the double event invocation
1 parent 3bcbe25 commit f838693

35 files changed

+213
-186
lines changed

‎.pubnub.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
2-
version: v6.0.3
2+
version: v6.0.4
33
changelog:
4+
- date: 2022-07-27
5+
version: v6.0.4
6+
changes:
7+
- type: improvement
8+
text: "UUID has been marked as deprecated, and it's being renamed to UserId. For now, both variants will work, but UUID will be gradually phased out in favor of UserId."
49
- date: 2022-07-12
510
version: v6.0.3
611
changes:
@@ -643,7 +648,7 @@ sdks:
643648
distribution-type: package
644649
distribution-repository: git release
645650
package-name: PubNub.unitypackage
646-
location: https://github.com/pubnub/unity/releases/download/v6.0.3/PubNub.unitypackage
651+
location: https://github.com/pubnub/unity/releases/download/v6.0.4/PubNub.unitypackage
647652
requires:
648653
-
649654
name: "UnityEditor"
@@ -810,7 +815,7 @@ sdks:
810815
distribution-type: package
811816
distribution-repository: git release
812817
package-name: PubNub.unitypackage
813-
location: https://github.com/pubnub/unity/releases/download/v5.0.0/PubNub.unitypackage
818+
location: https://github.com/pubnub/unity/releases/download/v6.0.4/PubNub.unitypackage
814819
requires:
815820
-
816821
name: "UnityEditor"

‎PubNubUnity/Assets/PubNub/Builders/Presence/GetStateRequestBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ protected override void RunWebRequest(QueueManager qm){
3737
requestState.OperationType = OperationType;
3838

3939
if (string.IsNullOrEmpty (uuid)) {
40-
uuid = this.PubNubInstance.PNConfig.UUID;
40+
uuid = this.PubNubInstance.PNConfig.UserId;
4141
}
4242

4343
string channels = "";

‎PubNubUnity/Assets/PubNub/Builders/Presence/SetStateRequestBuilder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public void Async(Action<PNSetStateResult, PNStatus> callback)
4343
UserState,
4444
false,
4545
uuid,
46-
this.PubNubInstance.PNConfig.UUID,
46+
this.PubNubInstance.PNConfig.UserId,
4747
out ChannelEntities
4848
)) {
4949
base.Async(this);
@@ -74,7 +74,7 @@ protected override void RunWebRequest(QueueManager qm){
7474
}
7575

7676
if (string.IsNullOrEmpty (uuid)) {
77-
uuid = this.PubNubInstance.PNConfig.UUID;
77+
uuid = this.PubNubInstance.PNConfig.UserId;
7878
}
7979
Uri request = BuildRequests.BuildSetStateRequest(
8080
channels,

‎PubNubUnity/Assets/PubNub/Builders/Presence/WhereNowRequestBuilder.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ protected override void RunWebRequest(QueueManager qm){
3232
this.PubNubInstance.PNLog.WriteToLog(string.Format ("WhereNowBuilder UuidForWhereNow: {0}", this.UuidForWhereNow), PNLoggingMethod.LevelInfo);
3333
#endif
3434

35-
string uuidForWhereNow = this.PubNubInstance.PNConfig.UUID;
35+
string uuidForWhereNow = this.PubNubInstance.PNConfig.UserId;
3636
if(!string.IsNullOrEmpty(this.UuidForWhereNow)){
3737
uuidForWhereNow = this.UuidForWhereNow;
3838
}

‎PubNubUnity/Assets/PubNub/Builders/PubNubNonSubBuilder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ public void Async(PubNubNonSubBuilder<U, V> pnBuilder){
129129
return;
130130
}
131131

132-
if(!string.IsNullOrEmpty(this.PubNubInstance.AuthorizedUUID) && !this.PubNubInstance.AuthorizedUUID.Equals(this.PubNubInstance.PNConfig.UUID)){
133-
string responseMsg = "Authorized UUID doesn't match.";
132+
if(!string.IsNullOrEmpty(this.PubNubInstance.AuthorizedUserId) && !this.PubNubInstance.AuthorizedUserId.Equals(this.PubNubInstance.PNConfig.UserId)){
133+
string responseMsg = "Authorized User ID doesn't match.";
134134
#if (ENABLE_PUBNUB_LOGGING)
135135
this.PubNubInstance.PNLog.WriteToLog(string.Format("{0} {1}", responseMsg, OperationType.ToString()), PNLoggingMethod.LevelWarning);
136136
#endif

‎PubNubUnity/Assets/PubNub/Editor/ChannelGroupBuildRequestsTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public void TestBuildAddChannelsToChannelGroupRequestCommon(string[] channels, b
102102
pnConfiguration.PresenceTimeout = 60;
103103
pnConfiguration.PresenceInterval= 30;
104104
pnConfiguration.AuthKey = authKey;
105-
pnConfiguration.UUID = uuid;
105+
pnConfiguration.UserId = uuid;
106106

107107
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
108108

@@ -232,7 +232,7 @@ public void TestBuildRemoveChannelsFromChannelGroupRequestCommon(string[] channe
232232
pnConfiguration.PresenceTimeout = 60;
233233
pnConfiguration.PresenceInterval= 30;
234234
pnConfiguration.AuthKey = authKey;
235-
pnConfiguration.UUID = uuid;
235+
pnConfiguration.UserId = uuid;
236236

237237
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
238238

@@ -357,7 +357,7 @@ public void TestBuildGetChannelsForChannelGroupRequestCommon(bool allCg, bool ss
357357
pnConfiguration.PresenceTimeout = 60;
358358
pnConfiguration.PresenceInterval= 30;
359359
pnConfiguration.AuthKey = authKey;
360-
pnConfiguration.UUID = uuid;
360+
pnConfiguration.UserId = uuid;
361361

362362
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
363363

‎PubNubUnity/Assets/PubNub/Editor/DeleteMessagesBuildRequestsTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ public void DeleteMessagesBuildRequestsCommon(bool ssl, string channel, string a
127127
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
128128
pnConfiguration.PresenceTimeout = 60;
129129
pnConfiguration.PresenceInterval= 30;
130-
pnConfiguration.UUID = "DeleteMessagesTestUUID";
130+
pnConfiguration.UserId = "DeleteMessagesTestUUID";
131131
pnConfiguration.AuthKey = authKey;
132132

133133
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
@@ -172,7 +172,7 @@ public void DeleteMessagesBuildRequestsCommon(bool ssl, string channel, string a
172172
UnityEngine.Debug.Log(string.Format("key:{0}, value:{1}",kv[0], kv[1]));
173173
switch (kv[0]){
174174
case "uuid":
175-
Assert.AreEqual(pnConfiguration.UUID,kv[1]);
175+
Assert.AreEqual(pnConfiguration.UserId,kv[1]);
176176
break;
177177
case "timestamp":
178178
timestamp = kv[1];
@@ -190,7 +190,7 @@ public void DeleteMessagesBuildRequestsCommon(bool ssl, string channel, string a
190190
}
191191
string uriParamStringFormatted = string.Format(
192192
uriParamString,
193-
pnConfiguration.UUID,
193+
pnConfiguration.UserId,
194194
startTimeString,
195195
endTimeString,
196196
timestamp,

‎PubNubUnity/Assets/PubNub/Editor/FetchMessagesBuildRequestsTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public void TestFetchMessagesBuildRequestCommon(bool ssl, bool reverse, bool inc
7878
pnConfiguration.PresenceTimeout = 60;
7979
pnConfiguration.PresenceInterval= 30;
8080
pnConfiguration.AuthKey = authKey;
81-
pnConfiguration.UUID = uuid;
81+
pnConfiguration.UserId = uuid;
8282

8383
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
8484

‎PubNubUnity/Assets/PubNub/Editor/FetchMessagesResponseTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public void FetchMessageResponseTestCommon(bool ssl, bool withMoreField)
4848
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
4949
pnConfiguration.PresenceTimeout = 60;
5050
pnConfiguration.PresenceInterval = 30;
51-
pnConfiguration.UUID = uuid;
51+
pnConfiguration.UserId = uuid;
5252

5353
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
5454

‎PubNubUnity/Assets/PubNub/Editor/HelpersTests.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public void TestCreatePNStatusWithCGAndCh(){
4141
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
4242
Assert.True(pnStatus.StatusCode.Equals(0));
4343
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
44-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
44+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
4545
Assert.True(EditorCommon.MatchChannelsEntities(channelEntities1, pnStatus.AffectedChannelGroups));
4646
Assert.True(EditorCommon.MatchChannelsEntities(channelEntities2, pnStatus.AffectedChannels));
4747
}
@@ -72,7 +72,7 @@ public void TestCreatePNStatusWithoutCGAndCh(){
7272
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
7373
Assert.True(pnStatus.StatusCode.Equals(0));
7474
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
75-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
75+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
7676
Assert.True(pnStatus.AffectedChannelGroups.Count.Equals(0));
7777
Assert.True(pnStatus.AffectedChannels.Count.Equals(0));
7878
}
@@ -105,7 +105,7 @@ public void TestCreatePNStatusExceptionWithoutCHAndCG(){
105105
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
106106
Assert.True(pnStatus.StatusCode.Equals(0));
107107
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
108-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
108+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
109109
Assert.True(pnStatus.AffectedChannelGroups.Count.Equals(0));
110110
Assert.True(pnStatus.AffectedChannels.Count.Equals(0));
111111

@@ -144,7 +144,7 @@ public void TestCreatePNStatusExceptionWithCHAndCG(){
144144
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
145145
Assert.True(pnStatus.StatusCode.Equals(0));
146146
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
147-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
147+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
148148
Assert.True(EditorCommon.MatchChannelsEntities(channelEntities1, pnStatus.AffectedChannelGroups));
149149
Assert.True(EditorCommon.MatchChannelsEntities(channelEntities2, pnStatus.AffectedChannels));
150150

@@ -181,7 +181,7 @@ public void TestCreatePNStatusExceptionWithCH(){
181181
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
182182
Assert.True(pnStatus.StatusCode.Equals(0));
183183
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
184-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
184+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
185185
Assert.True(channelEntities1[0].ChannelID.ChannelOrChannelGroupName.Equals(pnStatus.AffectedChannelGroups[0]));
186186
//Assert.True(pnStatus.AffectedChannels.Count.Equals(0));
187187
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
@@ -216,7 +216,7 @@ public void TestCreatePNStatusWithCH(){
216216
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
217217
Assert.True(pnStatus.StatusCode.Equals(0));
218218
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
219-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
219+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
220220
Assert.True(channelEntities1[0].ChannelID.ChannelOrChannelGroupName.Equals(pnStatus.AffectedChannelGroups[0]));
221221
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
222222
}
@@ -252,7 +252,7 @@ public void TestCreatePNStatusExceptionWithCG(){
252252
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
253253
Assert.True(pnStatus.StatusCode.Equals(0));
254254
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
255-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
255+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
256256
Assert.True(channelEntities1[0].ChannelID.ChannelOrChannelGroupName.Equals(pnStatus.AffectedChannels[0]));
257257
//Assert.True(pnStatus.AffectedChannels.Count.Equals(0));
258258
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
@@ -287,7 +287,7 @@ public void TestCreatePNStatusWithCG(){
287287
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
288288
Assert.True(pnStatus.StatusCode.Equals(0));
289289
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
290-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
290+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
291291
Assert.True(channelEntities1[0].ChannelID.ChannelOrChannelGroupName.Equals(pnStatus.AffectedChannels[0]));
292292
//Assert.True(pnStatus.AffectedChannels.Count.Equals(0));
293293
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
@@ -324,7 +324,7 @@ public void TestCreatePNStatus3(){
324324
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
325325
Assert.True(pnStatus.StatusCode.Equals(0));
326326
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
327-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
327+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
328328
Assert.True(ch[0].Equals(pnStatus.AffectedChannels[0]));
329329
Assert.True(cg[0].Equals(pnStatus.AffectedChannelGroups[0]));
330330
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
@@ -365,7 +365,7 @@ public void TestCreatePNStatus3ErrorNoException(){
365365
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
366366
Assert.True(pnStatus.StatusCode.Equals(0));
367367
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
368-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
368+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
369369
Assert.True(ch[0].Equals(pnStatus.AffectedChannels[0]));
370370
Assert.True(cg[0].Equals(pnStatus.AffectedChannelGroups[0]));
371371
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));
@@ -407,7 +407,7 @@ public void TestCreatePNStatus3Exception(){
407407
Assert.True(pnStatus.Origin.Equals(pnConfiguration.Origin));
408408
Assert.True(pnStatus.StatusCode.Equals(0));
409409
Assert.True(pnStatus.TlsEnabled.Equals(pnConfiguration.Secure));
410-
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UUID));
410+
Assert.True(pnStatus.UUID.Equals(pnConfiguration.UserId));
411411
Assert.True(ch[0].Equals(pnStatus.AffectedChannels[0]));
412412
Assert.True(cg[0].Equals(pnStatus.AffectedChannelGroups[0]));
413413
Assert.True(pnStatus.ClientRequest.Equals(pnRequestState.URL));

‎PubNubUnity/Assets/PubNub/Editor/HereNowBuildRequestsTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ public void TestBuildHereNowRequestCommon(bool testCh, bool testCg, bool ssl, bo
349349
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
350350
pnConfiguration.PresenceTimeout = 60;
351351
pnConfiguration.PresenceInterval= 30;
352-
pnConfiguration.UUID = uuid;
352+
pnConfiguration.UserId = uuid;
353353
pnConfiguration.AuthKey = authKey;
354354

355355
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
@@ -503,7 +503,7 @@ public void TestBuildGlobalHereNowRequestCommon(bool ssl, bool showUUIDList, boo
503503
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
504504
pnConfiguration.PresenceTimeout = 60;
505505
pnConfiguration.PresenceInterval= 30;
506-
pnConfiguration.UUID = uuid;
506+
pnConfiguration.UserId = uuid;
507507
pnConfiguration.AuthKey = authKey;
508508

509509
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);

‎PubNubUnity/Assets/PubNub/Editor/HistoryBuildRequestsTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1134,7 +1134,7 @@ public void TestBuildDetailedHistoryRequestCommon(bool ssl, bool reverse, bool i
11341134
pnConfiguration.PresenceTimeout = 60;
11351135
pnConfiguration.PresenceInterval= 30;
11361136
pnConfiguration.AuthKey = authKey;
1137-
pnConfiguration.UUID = uuid;
1137+
pnConfiguration.UserId = uuid;
11381138

11391139
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
11401140

‎PubNubUnity/Assets/PubNub/Editor/LeaveBuildRequestsTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ public void TestBuildLeaveRequestCommon(string[] channels, string[] channelGroup
222222
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
223223

224224
pnConfiguration.AuthKey = authKey;
225-
pnConfiguration.UUID = uuid;
225+
pnConfiguration.UserId = uuid;
226226

227227

228228
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);

‎PubNubUnity/Assets/PubNub/Editor/MessageActionsTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void TestAddMessageActionsCommon(bool ssl, bool sendQueryParams){
4646
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
4747
pnConfiguration.PresenceTimeout = 60;
4848
pnConfiguration.PresenceInterval= 30;
49-
pnConfiguration.UUID = uuid;
49+
pnConfiguration.UserId = uuid;
5050

5151
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
5252
string channelName = "message_actions_channel";
@@ -103,7 +103,7 @@ public void TestRemoveMessageActionsCommon(bool ssl, bool sendQueryParams){
103103
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
104104
pnConfiguration.PresenceTimeout = 60;
105105
pnConfiguration.PresenceInterval= 30;
106-
pnConfiguration.UUID = uuid;
106+
pnConfiguration.UserId = uuid;
107107

108108
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
109109
string channelName = "message_actions_channel";
@@ -246,7 +246,7 @@ public void TestGetMessageActionsCommon(bool ssl, bool sendQueryParams, long sta
246246
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
247247
pnConfiguration.PresenceTimeout = 60;
248248
pnConfiguration.PresenceInterval= 30;
249-
pnConfiguration.UUID = uuid;
249+
pnConfiguration.UserId = uuid;
250250

251251
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);
252252
string channelName = "message_actions_channel";

‎PubNubUnity/Assets/PubNub/Editor/MessageCountsBuildRequestsTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public void TestMessageCountsBuildRequestCommon(string[] channels, long[] channe
8585
pnConfiguration.LogVerbosity = PNLogVerbosity.BODY;
8686

8787
pnConfiguration.AuthKey = authKey;
88-
pnConfiguration.UUID = uuid;
88+
pnConfiguration.UserId = uuid;
8989

9090

9191
PubNubUnity pnUnity = new PubNubUnity(pnConfiguration, null, null);

0 commit comments

Comments
 (0)