Skip to content

Commit 973b32e

Browse files
labkey-adamlabkey-adam
authored
Deprecate the legacy name map along with the audit union table (#6903)
1 parent b0637a6 commit 973b32e

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

‎api/src/org/labkey/api/audit/query/DefaultAuditTypeTable.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import org.labkey.api.security.roles.CanSeeAuditLogRole;
4343
import org.labkey.api.security.roles.Role;
4444
import org.labkey.api.security.roles.RoleManager;
45+
import org.labkey.api.settings.OptionalFeatureService;
4546

4647
import java.util.ArrayList;
4748
import java.util.List;
@@ -50,6 +51,8 @@
5051

5152
public class DefaultAuditTypeTable extends FilteredTable<UserSchema>
5253
{
54+
public static final String LEGACY_UNION_AUDIT_TABLE = "legacyUnionAuditTable";
55+
5356
protected AuditTypeProvider _provider;
5457
protected Map<FieldKey, String> _legacyNameMap;
5558
protected Map<String, String> _dbSchemaToColumnMap;
@@ -64,7 +67,7 @@ public DefaultAuditTypeTable(AuditTypeProvider provider, TableInfo storage, User
6467
if (_provider.getDescription() != null)
6568
setDescription(_provider.getDescription());
6669

67-
_legacyNameMap = provider.legacyNameMap();
70+
_legacyNameMap = OptionalFeatureService.get().isFeatureEnabled(LEGACY_UNION_AUDIT_TABLE) ? provider.legacyNameMap() : Map.of();
6871

6972
// Create a mapping from the real dbTable names to the legacy query table names for QueryUpdateService.
7073
_dbSchemaToColumnMap = new CaseInsensitiveHashMap<>();

‎api/src/org/labkey/api/data/ContainerDisplayColumn.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ public void testDisplayColumn() throws Exception
186186
fieldKeys.add(FieldKey.fromString("ProjectId"));
187187
fieldKeys.add(FieldKey.fromString("ProjectId/Name"));
188188
fieldKeys.add(FieldKey.fromString("ProjectId/Parent/Name"));
189-
fieldKeys.add(FieldKey.fromString("ContainerId"));
190-
fieldKeys.add(FieldKey.fromString("ContainerId/Name"));
189+
fieldKeys.add(FieldKey.fromString("Container"));
190+
fieldKeys.add(FieldKey.fromString("Container/Name"));
191191
fieldKeys.add(FieldKey.fromString("Comment"));
192192
mpv.addPropertyValue("query.columns", StringUtils.join(fieldKeys, ","));
193193

@@ -243,14 +243,14 @@ else if (comment.contains(workbook1.getName() + " was created") ||
243243
comment.contains(subFolder2.getName() + " was created"))
244244
{
245245
// These are all containers that have since been deleted, so we can't join to the container row for details
246-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ContainerId").optString("value", null));
247-
assertEquals("Incorrect json value for ContainerId column", "<deleted>", row.getJSONObject("ContainerId").getString("displayValue"));
246+
assertNull("Incorrect json value for Container column", row.getJSONObject("Container").optString("value", null));
247+
assertEquals("Incorrect json value for Container column", "<deleted>", row.getJSONObject("Container").getString("displayValue"));
248248

249-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ContainerId/Name").optString("value", null));
250-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ContainerId/Name").optString("displayValue", null));
249+
assertNull("Incorrect json value for Container column", row.getJSONObject("Container/Name").optString("value", null));
250+
assertNull("Incorrect json value for Container column", row.getJSONObject("Container/Name").optString("displayValue", null));
251251

252-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ProjectId/Parent/Name").optString("value", null));
253-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ProjectId/Parent/Name").optString("displayValue", null));
252+
assertNull("Incorrect json value for ProjectId column", row.getJSONObject("ProjectId/Parent/Name").optString("value", null));
253+
assertNull("Incorrect json value for ProjectId column", row.getJSONObject("ProjectId/Parent/Name").optString("displayValue", null));
254254
}
255255
else
256256
{
@@ -262,13 +262,13 @@ else if (comment.contains(workbook1.getName() + " was created") ||
262262

263263
private void validateContainerRow(Container project, JSONObject row)
264264
{
265-
assertEquals("Incorrect json value for ContainerId column", project.getEntityId().toString(), row.getJSONObject("ContainerId").getString("value"));
266-
assertEquals("Incorrect json value for ContainerId column", project.getName(), row.getJSONObject("ContainerId").getString("displayValue"));
265+
assertEquals("Incorrect json value for Container column", project.getEntityId().toString(), row.getJSONObject("Container").getString("value"));
266+
assertEquals("Incorrect json value for Container column", project.getName(), row.getJSONObject("Container").getString("displayValue"));
267267

268-
assertEquals("Incorrect json value for ContainerId column", project.getName(), row.getJSONObject("ContainerId/Name").getString("value"));
268+
assertEquals("Incorrect json value for Container column", project.getName(), row.getJSONObject("Container/Name").getString("value"));
269269

270-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ProjectId/Parent/Name").optString("value", null));
271-
assertNull("Incorrect json value for ContainerId column", row.getJSONObject("ProjectId/Parent/Name").optString("displayValue", null));
270+
assertNull("Incorrect json value for ProjectId column", row.getJSONObject("ProjectId/Parent/Name").optString("value", null));
271+
assertNull("Incorrect json value for ProjectId column", row.getJSONObject("ProjectId/Parent/Name").optString("displayValue", null));
272272
}
273273
}
274274
}

‎audit/src/org/labkey/audit/AuditModule.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import org.jetbrains.annotations.NotNull;
2020
import org.labkey.api.audit.AuditLogService;
2121
import org.labkey.api.audit.provider.SiteSettingsAuditProvider;
22+
import org.labkey.api.audit.query.DefaultAuditTypeTable;
2223
import org.labkey.api.module.DefaultModule;
2324
import org.labkey.api.module.ModuleContext;
2425
import org.labkey.api.settings.OptionalFeatureFlag;
@@ -32,8 +33,6 @@
3233

3334
public class AuditModule extends DefaultModule
3435
{
35-
public static final String LEGACY_UNION_AUDIT_TABLE = "legacyUnionAuditTable";
36-
3736
@Override
3837
@NotNull
3938
protected Collection<WebPartFactory> createWebPartFactories()
@@ -80,7 +79,7 @@ public void doStartup(ModuleContext moduleContext)
8079

8180
AuditController.registerAdminConsoleLinks();
8281
OptionalFeatureService.get().addFeatureFlag(new OptionalFeatureFlag(
83-
LEGACY_UNION_AUDIT_TABLE,
82+
DefaultAuditTypeTable.LEGACY_UNION_AUDIT_TABLE,
8483
"Restore legacy union audit table",
8584
"Restores a legacy query that unions all the event tables together into a single query. This option will be removed in LabKey Server v26.3.",
8685
false,

‎audit/src/org/labkey/audit/query/AuditQuerySchema.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import java.util.LinkedHashSet;
3939
import java.util.Set;
4040

41-
import static org.labkey.audit.AuditModule.LEGACY_UNION_AUDIT_TABLE;
41+
import static org.labkey.api.audit.query.DefaultAuditTypeTable.LEGACY_UNION_AUDIT_TABLE;
4242

4343
public class AuditQuerySchema extends UserSchema
4444
{

0 commit comments

Comments
 (0)