Merge pull request #4143 from nscuro/migrate-author

Add `AUTHOR` -> `AUTHORS` migration

dev/docker-compose.mssql.yml

@@ -33,7 +33,7 @@ services:
  ACCEPT_EULA: "Y"
  MSSQL_SA_PASSWORD: "DTrack1234#"
  healthcheck:
- test: /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$$MSSQL_SA_PASSWORD" -Q "SELECT 1" -b -o /dev/null
+ test: /opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P "$$MSSQL_SA_PASSWORD" -Q "SELECT 1" -b -o /dev/null
  interval: 15s
  timeout: 3s
  retries: 10
@@ -51,7 +51,8 @@ services:
  mssql:
  condition: service_healthy
  command:
- - /opt/mssql-tools/bin/sqlcmd
+ - /opt/mssql-tools18/bin/sqlcmd
+ - -C
  - -S
  - mssql
  - -U

src/main/java/org/dependencytrack/upgrade/v4120/v4120Updater.java

@@ -24,6 +24,7 @@
 import alpine.server.util.DbUtil;
 import org.dependencytrack.model.BomValidationMode;
 
+import jakarta.json.Json;
 import java.sql.Connection;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
@@ -46,6 +47,8 @@ public void executeUpgrade(final AlpineQueryManager qm, final Connection connect
  removeExperimentalBomUploadProcessingV2ConfigProperty(connection);
  migrateBomValidationConfigProperty(connection);
  extendTeamNameColumnMaxLength(connection);
+ migrateAuthorToAuthors(connection);
+ dropAuthorColumns(connection);
  }
 
  private static void removeExperimentalBomUploadProcessingV2ConfigProperty(final Connection connection) throws SQLException {
@@ -156,13 +159,130 @@ private void extendTeamNameColumnMaxLength(final Connection connection) throws S
  """);
  } else if (DbUtil.isMysql()) {
  stmt.executeUpdate("""
- ALTER TABLE "TEAM" MODIFY "NAME" VARCHAR(255) NOT NULL
- """);
+  ALTER TABLE "TEAM" MODIFY "NAME" VARCHAR(255) NOT NULL
+  """);
  } else {
  stmt.executeUpdate("""
- ALTER TABLE "TEAM" ALTER COLUMN "NAME" TYPE VARCHAR(255)
- """);
+ ALTER TABLE "TEAM" ALTER COLUMN "NAME" TYPE VARCHAR(255)
+ """);
+ }
+ }
+ }
+
+ private void migrateAuthorToAuthors(final Connection connection) throws SQLException {
+ LOGGER.info("Migrating PROJECT.AUTHOR and COMPONENT.AUTHOR to PROJECT.AUTHORS and COMPONENT.AUTHORS");
+
+ // MSSQL did not have native JSON functions until version 2022.
+ // Since we have to support versions earlier than that, the migration
+ // requires a more procedural approach.
+ if (DbUtil.isMssql()) {
+ migrateAuthorToAuthorsMssql(connection);
+ return;
+ }
+
+ try (final Statement stmt = connection.createStatement()) {
+ if (DbUtil.isH2()) {
+ stmt.executeUpdate("""
+ UPDATE "PROJECT"
+ SET "AUTHORS" = JSON_ARRAY(JSON_OBJECT('name': "AUTHOR"))
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ stmt.executeUpdate("""
+ UPDATE "COMPONENT"
+ SET "AUTHORS" = JSON_ARRAY(JSON_OBJECT('name': "AUTHOR"))
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ } else if (DbUtil.isMysql()) {
+ stmt.executeUpdate("""
+ UPDATE "PROJECT"
+ SET "AUTHORS" = JSON_ARRAY(JSON_OBJECT('name', "AUTHOR"))
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ stmt.executeUpdate("""
+ UPDATE "COMPONENT"
+ SET "AUTHORS" = JSON_ARRAY(JSON_OBJECT('name', "AUTHOR"))
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ } else if (DbUtil.isPostgreSQL()) {
+ stmt.executeUpdate("""
+ UPDATE "PROJECT"
+ SET "AUTHORS" = JSON_BUILD_ARRAY(JSON_BUILD_OBJECT('name', "AUTHOR"))::TEXT
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ stmt.executeUpdate("""
+ UPDATE "COMPONENT"
+ SET "AUTHORS" = JSON_BUILD_ARRAY(JSON_BUILD_OBJECT('name', "AUTHOR"))::TEXT
+ WHERE "AUTHOR" IS NOT NULL
+ """);
+ } else {
+ throw new IllegalStateException("Unrecognized database type");
+ }
+ }
+ }
+
+ private void migrateAuthorToAuthorsMssql(final Connection connection) throws SQLException {
+ migrateAuthorToAuthorsMssqlForTable(connection, "PROJECT");
+ migrateAuthorToAuthorsMssqlForTable(connection, "COMPONENT");
+ }
+
+ private void migrateAuthorToAuthorsMssqlForTable(
+ final Connection connection,
+ final String tableName) throws SQLException {
+ try (final PreparedStatement selectStatement = connection.prepareStatement("""
+ SELECT "ID"
+ , "AUTHOR"
+ FROM "%s"
+ WHERE "AUTHOR" IS NOT NULL
+ AND "AUTHORS" IS NULL
+ """.formatted(tableName));
+ final PreparedStatement updateStatement = connection.prepareStatement("""
+ UPDATE "%s"
+ SET "AUTHORS" = ?
+ WHERE "ID" = ?
+ """.formatted(tableName))) {
+ int batchSize = 0, numBatches = 0, numUpdates = 0;
+ final ResultSet rs = selectStatement.executeQuery();
+ while (rs.next()) {
+ final long id = rs.getLong(1);
+ final String author = rs.getString(2);
+ final String authors = Json.createArrayBuilder()
+ .add(Json.createObjectBuilder()
+ .add("name", author))
+ .build()
+ .toString();
+
+ updateStatement.setString(1, authors);
+ updateStatement.setLong(2, id);
+ updateStatement.addBatch();
+ if (++batchSize == 500) {
+ updateStatement.executeBatch();
+ numUpdates += batchSize;
+ numBatches++;
+ batchSize = 0;
+ }
+ }
+
+ if (batchSize > 0) {
+ updateStatement.executeBatch();
+ numUpdates += batchSize;
+ numBatches++;
  }
+
+ LOGGER.info("Updated %d %s records in %d batches"
+ .formatted(numUpdates, tableName, numBatches));
+ }
+ }
+
+ private void dropAuthorColumns(final Connection connection) throws SQLException {
+ LOGGER.info("Dropping PROJECT.AUTHOR and COMPONENT.AUTHOR columns");
+
+ try (final Statement stmt = connection.createStatement()) {
+ stmt.executeUpdate("""
+ ALTER TABLE "PROJECT" DROP COLUMN "AUTHOR"
+ """);
+ stmt.executeUpdate("""
+ ALTER TABLE "COMPONENT" DROP COLUMN "AUTHOR"
+ """);
  }
  }