Skip to content

Commit f1dea35

Browse files
GPortasGPortas
committed
Removed: language path param from guides URL in returned InApp notifications payload
1 parent db953d0 commit f1dea35

5 files changed

Lines changed: 15 additions & 11 deletions

File tree

‎doc/sphinx-guides/source/api/native-api.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6022,7 +6022,7 @@ The expected OK (200) response looks something like this:
60226022
"sentTimestamp": "2025-08-08T08:00:16Z",
60236023
"rootDataverseName": "Root",
60246024
"installationName": "Your Installation Name",
6025-
"userGuidesBaseUrl": "https://guides.dataverse.org/en",
6025+
"userGuidesBaseUrl": "https://guides.dataverse.org",
60266026
"userGuidesVersion": "6.7.1",
60276027
"userGuidesSectionPath": "user/index.html"
60286028
}

‎src/main/java/edu/harvard/iq/dataverse/util/SystemConfig.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,13 @@ public String getPageURLWithQueryString() {
288288
}
289289

290290
public String getGuidesBaseUrl() {
291+
return getGuidesBaseUrl(true);
292+
}
293+
294+
public String getGuidesBaseUrl(boolean includeLang) {
291295
String saneDefault = "https://guides.dataverse.org";
292296
String guidesBaseUrl = settingsService.getValueForKey(SettingsServiceBean.Key.GuidesBaseUrl, saneDefault);
293-
return guidesBaseUrl + "/" + getGuidesLanguage();
297+
return includeLang ? guidesBaseUrl + "/" + getGuidesLanguage() : guidesBaseUrl;
294298
}
295299

296300
private String getGuidesLanguage() {

‎src/main/java/edu/harvard/iq/dataverse/util/json/InAppNotificationsJsonPrinter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ private void addCreateDatasetFields(final NullSafeJsonBuilder notificationJson,
222222
}
223223

224224
private void addGuidesFields(final NullSafeJsonBuilder notificationJson, String guidesSectionPath) {
225-
notificationJson.add(KEY_GUIDES_BASE_URL, systemConfig.getGuidesBaseUrl());
225+
notificationJson.add(KEY_GUIDES_BASE_URL, systemConfig.getGuidesBaseUrl(false));
226226
notificationJson.add(KEY_GUIDES_VERSION, getGuidesVersionFormattedString());
227227

228228
if (guidesSectionPath != null) {

‎src/test/java/edu/harvard/iq/dataverse/api/NotificationsIT.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ public void testNotifications() {
190190
.body("data.notifications.size()", equalTo(1))
191191
// In-App fields should be present
192192
.body("data.notifications[0].rootDataverseName", equalTo("Root"))
193-
.body("data.notifications[0].userGuidesBaseUrl", equalTo("https://guides.dataverse.org/en"))
193+
.body("data.notifications[0].userGuidesBaseUrl", equalTo("https://guides.dataverse.org"))
194194
.body("data.notifications[0].userGuidesSectionPath", equalTo("user/index.html"))
195195
.body("data.notifications[0].userGuidesVersion", not(equalTo(null)))
196196
// Email-related fields should be null

‎src/test/java/edu/harvard/iq/dataverse/util/json/InAppNotificationsJsonPrinterTest.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ public void testAddFieldsByType_createDv_dvHasOwner() {
151151
when(owner.getDisplayName()).thenReturn("Parent Dataverse");
152152

153153
when(dataverseService.find(1L)).thenReturn(dataverse);
154-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
154+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
155155
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
156156

157157
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -177,7 +177,7 @@ public void testAddFieldsByType_createDv_dvHasNoOwner() {
177177
when(dataverse.getOwner()).thenReturn(null);
178178

179179
when(dataverseService.find(1L)).thenReturn(dataverse);
180-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
180+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
181181
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
182182

183183
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -195,7 +195,7 @@ public void testAddFieldsByType_createDv_objectDeleted() {
195195
userNotification.setObjectId(1L);
196196

197197
when(dataverseService.find(1L)).thenReturn(null);
198-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
198+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
199199
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
200200

201201
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -279,7 +279,7 @@ public void testAddFieldsByType_createDs() {
279279

280280
when(datasetVersionService.find(1L)).thenReturn(datasetVersion);
281281

282-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
282+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
283283
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
284284

285285
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -407,7 +407,7 @@ public void testAddFieldsByType_createAcc() {
407407
when(dataverseService.findRootDataverse()).thenReturn(rootDataverse);
408408
when(settingsService.getValueForKey(SettingsServiceBean.Key.InstallationName)).thenReturn("InstallationName");
409409

410-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
410+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
411411
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
412412

413413
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -436,7 +436,7 @@ public void testAddFieldsByType_ingestCompleted() {
436436

437437
when(datasetService.find(1L)).thenReturn(dataset);
438438

439-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
439+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
440440
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
441441

442442
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
@@ -457,7 +457,7 @@ public void testAddFieldsByType_ingestCompleted_objectDeleted() {
457457

458458
when(datasetService.find(1L)).thenReturn(null);
459459

460-
when(systemConfig.getGuidesBaseUrl()).thenReturn("http://guides.dataverse.org");
460+
when(systemConfig.getGuidesBaseUrl(false)).thenReturn("http://guides.dataverse.org");
461461
when(systemConfig.getGuidesVersion()).thenReturn("v1.0");
462462

463463
sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);

0 commit comments

Comments
 (0)