Merge pull request #10 from JavaWebStack/use-is-dirty-before-update

Use is dirty before update

Author: JanHolger

src/main/java/org/javawebstack/orm/Model.java

@@ -73,6 +73,8 @@ public <T> T getOriginalValue(String field) {
 
     public boolean isDirty(String... fields) {
         List<String> dirty = getDirtyFields();
+        if(fields.length == 0 && dirty.size() > 0)
+            return true;
         for (String f : fields) {
             if (dirty.contains(f))
                 return true;

src/main/java/org/javawebstack/orm/ORMConfig.java

@@ -16,6 +16,7 @@ public class ORMConfig {
     private boolean idAutoIncrement = true;
     private final List<TypeMapper> typeMappers = new ArrayList<>();
     private Injector injector;
+    private boolean preventUnnecessaryUpdates = true;
 
     public ORMConfig() {
         typeMappers.add(new DefaultMapper());
@@ -113,4 +114,13 @@ public String getTypeParameters(Class<?> type, int size) {
         }
         return null;
     }
+
+    public boolean shouldPreventUnnecessaryUpdates() {
+        return preventUnnecessaryUpdates;
+    }
+
+    public ORMConfig setPreventUnnecessaryUpdates(boolean preventUnnecessaryUpdates) {
+        this.preventUnnecessaryUpdates = preventUnnecessaryUpdates;
+        return this;
+    }
 }

src/main/java/org/javawebstack/orm/Repo.java

@@ -155,6 +155,8 @@ private void executeCreate(T entry) {
     }
 
     public void update(T entry) {
+        if(info.getConfig().shouldPreventUnnecessaryUpdates() && !entry.isDirty())
+            return;
         observers.forEach(o -> o.saving(entry));
         observers.forEach(o -> o.updating(entry));
         where(info.getIdField(), getId(entry)).update(entry);

src/main/java/org/javawebstack/orm/wrapper/BaseSQL.java

@@ -1,26 +1,21 @@
 package org.javawebstack.orm.wrapper;
 
-import org.javawebstack.orm.ORM;
 import org.javawebstack.orm.exception.ORMQueryException;
 
 import java.sql.*;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Locale;
-import java.util.Map;
-import java.util.logging.Level;
-import java.util.stream.Collectors;
+import java.sql.Date;
+import java.util.*;
 
 public abstract class BaseSQL implements SQL {
 
     private final Map<ResultSet, Statement> statementMap = new HashMap<>();
+    private final List<QueryLogger> loggers = new LinkedList<>();
 
     public abstract Connection getConnection();
 
     public int write(String queryString, Object... parameters) throws SQLException {
+        loggers.forEach(l -> l.log(queryString, parameters));
         Connection connection = getConnection();
-        ORM.LOGGER.log(Level.ALL, queryString);
-        ORM.LOGGER.log(Level.ALL, Arrays.stream(parameters).map(o -> o == null ? "null" : o.toString()).collect(Collectors.joining(",")));
         if (queryString.toLowerCase(Locale.ROOT).startsWith("insert")) {
             PreparedStatement ps = setParams(connection.prepareStatement(queryString, Statement.RETURN_GENERATED_KEYS), parameters);
             ps.executeUpdate();
@@ -41,9 +36,8 @@ public int write(String queryString, Object... parameters) throws SQLException {
     }
 
     public ResultSet read(String queryString, Object... parameters) throws SQLException {
+        loggers.forEach(l -> l.log(queryString, parameters));
         Connection connection = getConnection();
-        ORM.LOGGER.log(Level.ALL, queryString);
-        ORM.LOGGER.log(Level.ALL, Arrays.stream(parameters).map(o -> o == null ? "null" : o.toString()).collect(Collectors.joining(",")));
         PreparedStatement ps = setParams(connection.prepareStatement(queryString), parameters);
         ResultSet rs = ps.executeQuery();
         statementMap.put(rs, ps);
@@ -109,4 +103,12 @@ public void cleanUp() {
             close(rs);
     }
 
+    public void addQueryLogger(QueryLogger logger) {
+        loggers.add(logger);
+    }
+
+    public void removeQueryLogger(QueryLogger logger) {
+        loggers.remove(logger);
+    }
+
 }

src/main/java/org/javawebstack/orm/wrapper/QueryLogger.java

@@ -0,0 +1,7 @@
+package org.javawebstack.orm.wrapper;
+
+public interface QueryLogger {
+
+    void log(String query, Object[] parameters);
+
+}

src/main/java/org/javawebstack/orm/wrapper/SQL.java

@@ -14,4 +14,8 @@ public interface SQL {
 
     void close(ResultSet resultSet);
 
+    void addQueryLogger(QueryLogger logger);
+
+    void removeQueryLogger(QueryLogger logger);
+
 }

src/test/java/org/javawebstack/orm/test/UpdateOnlyIfIsDirtyTest.java

@@ -0,0 +1,54 @@
+package org.javawebstack.orm.test;
+
+import org.javawebstack.orm.ORM;
+import org.javawebstack.orm.ORMConfig;
+import org.javawebstack.orm.exception.ORMConfigurationException;
+import org.javawebstack.orm.test.shared.models.JustString;
+import org.javawebstack.orm.wrapper.QueryLogger;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class UpdateOnlyIfIsDirtyTest extends ORMTestCase {
+
+    @Test
+    public void testOnlyUpdateIfIsDirty() throws ORMConfigurationException {
+        // Using an array to make force mutability inside lamda expression
+        boolean[] updated = new boolean[1];
+        QueryLogger logger = (query, parameters) -> {
+            if(query.startsWith("UPDATE"))
+                updated[0] = true;
+        };
+        sql().addQueryLogger(logger);
+        ORM.register(JustString.class, sql(), new ORMConfig());
+        ORM.autoMigrate();
+        JustString model = new JustString();
+        model.setString("Test");
+        model.save();
+        model.save();
+        assertFalse(updated[0]);
+        model.setString("TestB");
+        model.save();
+        assertTrue(updated[0]);
+        sql().removeQueryLogger(logger);
+    }
+
+    @Test
+    public void testPreventUnnecessaryUpdatesOption() throws ORMConfigurationException {
+        boolean[] updated = new boolean[1];
+        QueryLogger logger = (query, parameters) -> {
+            if(query.startsWith("UPDATE"))
+                updated[0] = true;
+        };
+        sql().addQueryLogger(logger);
+        ORM.register(JustString.class, sql(), new ORMConfig().setPreventUnnecessaryUpdates(false));
+        ORM.autoMigrate();
+        JustString model = new JustString();
+        model.setString("Test");
+        model.save();
+        model.save();
+        assertTrue(updated[0]);
+        sql().removeQueryLogger(logger);
+    }
+
+}

src/test/java/org/javawebstack/orm/test/shared/models/JustString.java

@@ -4,10 +4,26 @@
 import org.javawebstack.orm.annotation.Column;
 
 public class JustString extends Model {
+
     @Column
     int id;
 
     @Column
     String string;
 
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public String getString() {
+        return string;
+    }
+
+    public void setString(String string) {
+        this.string = string;
+    }
 }