AuditChange.java

package com.rbctcsworld.ecommerce.audit;

import java.math.BigDecimal;

import java.util.ArrayList;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Map;

import java.util.Objects;

/** One changed field of one record: what the audit trail stores per row. */

public record AuditChange(String entityType, long entityId, String action, String field, String oldValue,

                          String newValue) {

    public static final String PRODUCT = "PRODUCT";

    public static final String ORDER = "ORDER";

    public static final String CUSTOMER = "CUSTOMER";

    public static final String COUPON = "COUPON";

    public static final String WAREHOUSE = "WAREHOUSE";

    public static final int MAX_VALUE = 500;

    /**

     * The fields whose value differs between before and after, in the order of {@code after}.

     * {@code before} = null means the record was created (every field with a value is listed).

     * Numbers are compared by value: 12.5 and 12.50 are the same price.

     */

    public static List<AuditChange> diff(String entityType, long entityId, String action,

                                         Map<String, Object> before, Map<String, Object> after) {

        List<AuditChange> changes = new ArrayList<>();

        for (Map.Entry<String, Object> e : after.entrySet()) {

            Object old = before == null ? null : before.get(e.getKey());

            if (!same(old, e.getValue())) {

                changes.add(new AuditChange(entityType, entityId, action, e.getKey(), text(old), text(e.getValue())));

            }

        }

        return changes;

    }

    /** Convenience for building the before/after maps in field order. */

    public static Map<String, Object> fields(Object... namesAndValues) {

        Map<String, Object> m = new LinkedHashMap<>();

        for (int i = 0; i < namesAndValues.length; i += 2) {

            m.put((String) namesAndValues[i], namesAndValues[i + 1]);

        }

        return m;

    }

    static boolean same(Object a, Object b) {

        if (a instanceof BigDecimal x && b instanceof BigDecimal y) {

            return x.compareTo(y) == 0;

        }

        return Objects.equals(a, b);

    }

    /** As stored: plain text, BigDecimal without exponent, at most MAX_VALUE characters, null stays null. */

    static String text(Object value) {

        if (value == null) return null;

        String s = value instanceof BigDecimal d ? d.toPlainString() : String.valueOf(value);

        return s.length() > MAX_VALUE ? s.substring(0, MAX_VALUE) : s;

    }

}

Active mutators

• CONDITIONALS_BOUNDARY
• EMPTY_RETURNS
• FALSE_RETURNS
• INCREMENTS
• INVERT_NEGS
• MATH
• NULL_RETURNS
• PRIMITIVE_RETURNS
• REMOVE_CONDITIONALS_EQUAL_ELSE
• REMOVE_CONDITIONALS_ORDER_ELSE
• TRUE_RETURNS
• VOID_METHOD_CALLS

Tests examined

• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:fieldsKeepsTheGivenOrder()] (2 ms)
• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:theSamePriceWrittenDifferentlyIsNoChange()] (0 ms)
• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:aCreatedRecordListsEveryFieldThatHasAValue()] (0 ms)
• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:aClearedValueIsStoredAsNull()] (0 ms)
• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:onlyTheFieldsThatChangedAreListedInOrder()] (8 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:aDeletedProductIsAuditedAsNoLongerActive()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:deleteIsSoftDelete()] (0 ms)
• com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest]/[method:switchingOnAgainNeedsNoChecks()] (1 ms)
• com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest]/[method:anEditIsAuditedWithOnlyWhatChanged()] (0 ms)
• com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest]/[method:aWarehouseIsSwitchedOffOnlyWhenEmptyAndNotTheLastOne()] (1 ms)
• com.rbctcsworld.ecommerce.coupon.CouponServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.coupon.CouponServiceTest]/[method:aNewCouponIsAuditedWithItsTerms()] (1 ms)
• com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.inventory.WarehouseServiceTest]/[method:aNewWarehouseGetsANormalisedCodeAndStateAndIsAudited()] (3 ms)
• com.rbctcsworld.ecommerce.coupon.CouponServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.coupon.CouponServiceTest]/[method:anEditChangesTheTermsKeepsTheCodeAndAuditsOnlyWhatChanged()] (0 ms)
• com.rbctcsworld.ecommerce.coupon.CouponServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.coupon.CouponServiceTest]/[method:createStoresANormalisedCouponAndAllowsExactly100Percent()] (1 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:aNewProductsStockIsPlacedInTheDefaultWarehouse()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:anUpdateThatChangesNothingHasNothingToAudit()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:aProductWithoutVariantFieldsStaysASingleProduct()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:theProductFormsStockGoesThroughTheInventoryBeforeTheOtherFields()] (0 ms)
• com.rbctcsworld.ecommerce.coupon.CouponServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.coupon.CouponServiceTest]/[method:createRejectsDuplicateCodeAndEndBeforeStart()] (3 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:createKeepsThePicture()] (1 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:onlyASizeOrOnlyAColourIsEnough()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:aNewProductIsAuditedWithEveryValue()] (2 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:updateReplacesOrRemovesThePicture()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:productMayKeepItsOwnSkuOnUpdate()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:anUpdateIsAuditedFieldByFieldWithOnlyWhatChanged()] (0 ms)
• com.rbctcsworld.ecommerce.product.ProductServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductServiceTest]/[method:updateChangesEveryField_regressionForStockOnlyBug()] (1 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:aNewVariantIsSavedWithItsGroupInUpperCaseAndTidySizeAndColour()] (1 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:theVariantFieldsAreAudited()] (3 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:aDifferentSizeOrColourInTheSameGroupIsFine()] (2 ms)
• com.rbctcsworld.ecommerce.product.ProductVariantTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.product.ProductVariantTest]/[method:anUpdateMayKeepItsOwnSizeAndColourAndAPutWithoutThemEndsTheVariant()] (1 ms)
• com.rbctcsworld.ecommerce.coupon.CouponServiceTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.coupon.CouponServiceTest]/[method:anEditFollowsTheSameRulesAsCreate()] (66 ms)
• com.rbctcsworld.ecommerce.audit.AuditChangeTest.[engine:junit-jupiter]/[class:com.rbctcsworld.ecommerce.audit.AuditChangeTest]/[method:valuesAreStoredAsPlainTextOfAtMostFiveHundredCharacters()] (0 ms)