Major refactoring of property (name) ignorals (#5954)

Author: cowtowncoder

src/main/java/tools/jackson/databind/BeanDescription.java

@@ -99,33 +99,47 @@ public boolean isNonStaticInnerClass() {
     public abstract List<BeanPropertyDefinition> findProperties();
 
     /**
-     * Returns the set of property names that are marked to be ignored, from both
-     * per-property {@code @JsonIgnore} markers and class-level
-     * {@code @JsonIgnoreProperties} (annotation and config overrides).
-     * The set is direction-specific: a name may appear for serialization but not
+     * Returns the full set of property names marked ignored — combining per-property
+     * {@code @JsonIgnore} markers, class-level {@code @JsonIgnoreProperties}
+     * (annotation and config overrides), and read/write-only access rules. The set
+     * is direction-specific: a name may appear for serialization but not
      * deserialization, depending on the annotation attributes.
      *<p>
-     * <b>Caveat for factory layers:</b> this set is <em>not</em> a complete runtime
-     * ignore-list. Names that collide with a creator parameter may have been
-     * removed during property renaming (see {@code [databind#2001]} /
-     * {@code [databind#2118]} handling in {@code POJOPropertiesCollector}). When
-     * building a deserializer's ignorable-property set, factories must therefore
-     * combine this with {@link #getPropertyIgnorals()}'s direction-specific names
-     * to get the full effective set. See
-     * {@code BeanDeserializerFactory#addBeanProps} for the canonical pattern.
+     * Per-property names that have been "rescued" by a creator parameter renamed
+     * to the same name (see {@code [databind#2001]}) are excluded; class-level
+     * names are absolute and always appear. This is the canonical accessor for
+     * building a deserializer's runtime ignore-list — factory code does not need
+     * to combine it with {@link #getPropertyIgnorals()}.
      */
     public abstract Set<String> getIgnoredPropertyNames();
 
+    /**
+     * Returns the un-rescued view of {@link #getIgnoredPropertyNames()}: includes
+     * per-property names that {@code [databind#2001]} would later rescue when a
+     * creator parameter is renamed to the same name. Class-level names are
+     * included exactly as in the rescued view (they are absolute either way).
+     *<p>
+     * Default implementation returns {@link #getIgnoredPropertyNames()}; subclasses
+     * backed by a property collector override to return the un-rescued set. Most
+     * callers should use {@link #getIgnoredPropertyNames()}; this exists for
+     * tooling that needs to inspect the original ignoral declarations.
+     *
+     * @since 3.2
+     */
+    public Set<String> getNonRescuedIgnoredPropertyNames() {
+        return getIgnoredPropertyNames();
+    }
+
     /**
      * Returns the class-level property ignorals value (annotation plus config overrides),
      * pre-computed during property collection.  Preferred over re-calling
      * {@code findPropertyIgnoralByName()} in factory code since the result is cached.
      * Returns {@code null} when neither annotation nor config override defines any ignorals.
      *<p>
-     * Note: this only carries class-level ignorals. Per-property {@code @JsonIgnore}
-     * names live in {@link #getIgnoredPropertyNames()} instead. Neither accessor on
-     * its own is a complete runtime ignore-list — see the caveat on
-     * {@link #getIgnoredPropertyNames()}.
+     * Equivalent to the class-level subset of {@link #getIgnoredPropertyNames()}
+     * but in {@link JsonIgnoreProperties.Value} form, which additionally carries
+     * the {@code ignoreUnknown}, {@code allowGetters}, {@code allowSetters}, and
+     * {@code merge} attributes.
      */
     public JsonIgnoreProperties.Value getPropertyIgnorals() {
         return null;

src/main/java/tools/jackson/databind/deser/BeanDeserializerFactory.java

@@ -545,20 +545,13 @@ protected void addBeanProps(DeserializationContext ctxt,
         final boolean hasCreatorProps = (creatorProps != null);
 
         // Class-level ignorals (annotation + config overrides): pre-computed during
-        // property collection, so no second findPropertyIgnoralByName() call needed.
+        // property collection. Surface the direction-specific name set so we can
+        // pass it to filterBeanProps() and the ignoreUnknown flag to the builder.
         JsonIgnoreProperties.Value ignorals = beanDesc.getPropertyIgnorals();
         Set<String> ignored;
         if (ignorals != null) {
             builder.setIgnoreUnknownProperties(ignorals.getIgnoreUnknown());
             ignored = ignorals.findIgnoredForDeserialization();
-            // NOTE: must register class-level ignorals here separately from the
-            // per-property loop below: per [databind#2001]/[databind#2118], names
-            // that collide with creator parameters get stripped out of
-            // POJOPropertiesCollector#_ignoredPropertyNames during rename, so
-            // beanDesc.getIgnoredPropertyNames() does NOT cover them.
-            for (String propName : ignored) {
-                builder.addIgnorable(propName);
-            }
         } else {
             ignored = Collections.emptySet();
         }
@@ -580,17 +573,14 @@ protected void addBeanProps(DeserializationContext ctxt,
         if (anySetter != null) {
             builder.setAnySetter(anySetter);
         }
-        // [databind#5952]: per-property @JsonIgnore (and read-only access rules) must
-        // be registered as ignorable regardless of whether an any-setter exists, so
-        // the any-setter does not receive properties the user explicitly marked as
-        // ignored. (Class-level @JsonIgnoreProperties names are registered separately
-        // above; this is needed because creator-prop renaming may remove class-level
-        // names from POJOPropertiesCollector#_ignoredPropertyNames.)
-        Collection<String> ignored2 = beanDesc.getIgnoredPropertyNames();
-        if (ignored2 != null) {
-            for (String propName : ignored2) {
-                builder.addIgnorable(propName);
-            }
+        // [databind#5952]: register the full deser-side ignore-list (per-property
+        // @JsonIgnore, class-level @JsonIgnoreProperties, read-only access rules)
+        // unconditionally, so the any-setter does not receive properties the user
+        // explicitly marked as ignored. getIgnoredPropertyNames() returns the
+        // already-merged set with the [databind#2001] creator-rename rescue
+        // applied to per-property names only — class-level names remain absolute.
+        for (String propName : beanDesc.getIgnoredPropertyNames()) {
+            builder.addIgnorable(propName);
         }
         final boolean useGettersAsSetters = ctxt.isEnabled(MapperFeature.USE_GETTERS_AS_SETTERS);
         // 24-Sep-2017, tatu: Legacy setting removed from 3.x, not sure if other visibility checks

src/main/java/tools/jackson/databind/introspect/BasicBeanDescription.java

@@ -247,6 +247,12 @@ public Set<String> getIgnoredPropertyNames() {
         return ign;
     }
 
+    @Override
+    public Set<String> getNonRescuedIgnoredPropertyNames() {
+        return (_propCollector == null) ? Collections.emptySet()
+                : _propCollector.getNonRescuedIgnoredPropertyNames();
+    }
+
     @Override
     public JsonIgnoreProperties.Value getPropertyIgnorals() {
         return (_propCollector == null) ? null