[BUG] `PARSED_STYLE_LIST` causes plugin exception

[wang1212]

In the past, when improving performance, we added PARSED_STYLE_LIST to parse only necessary attributes in order to improve the performance of the element data parsing process, which resulted in some of the new attributes added by the plugin not being taken into account, which led to logical exceptions.

see #1847 #1820

---

Plugins known to be affected:

• @antv/g-plugin-matterjs
• @antv/g-plugin-box2d

[wang1212]

Subsequently, the logic for property parsing needs to be refactored, rather than simply removing PARSED_STYLE_LIST, as many times plugins add properties that don't actually require further parsing.

[github-actions]

@wang1212 Hello! Here is an automated response to your question:

Thank you for reporting this issue regarding plugin attribute parsing and the impact of PARSED_STYLE_LIST. We appreciate your detailed description and references to related issues (#1847, #1820). Below is an analysis and recommended actions to address the problem.

---

📝 Issue Analysis

1. Impact of PARSED_STYLE_LIST on Plugin Attributes

PARSED_STYLE_LIST was introduced to optimize performance by parsing only a predefined set of style attributes for each element. While this increases efficiency, it can inadvertently exclude new attributes registered by plugins (e.g., physics-related properties from @antv/g-plugin-matterjs or @antv/g-plugin-box2d). If these attributes are not listed in PARSED_STYLE_LIST, they won't be parsed or available via APIs such as .parsedStyle or .computedStyleMap(), leading to logical exceptions in plugin behavior.

2. Recommended Plugin Attribute Registration

To ensure plugin-added attributes are recognized and parsed:

• Plugins must explicitly register any new style attributes with the core G system during initialization.
• This is typically done by extending the attribute metadata structure used by the core (see Attribute Metadata Example).
• Registration should occur before element parsing, so the new attributes are included in PARSED_STYLE_LIST.

Example:

{
  name: 'physicsEnabled',
  keywords: ['true', 'false'],
  inherited: false,
  interpolable: false,
  defaultValue: false,
  handler: CustomPhysicsHandler,
}

3. Resolving Plugin Exceptions

If your plugin is experiencing logical exceptions due to missing attributes:

• Update the plugin to register all required custom attributes with the G core before rendering or scene graph operations.
• For already affected projects, ensure you are using the latest versions of both G and your plugins, as recent updates may have addressed registration issues.
• If necessary, unregister and re-register plugins to refresh their attribute registrations:

renderer.unregisterPlugin(plugin);
renderer.registerPlugin(plugin);

• Test attribute access using both .getAttribute() and .parsedStyle to verify correct parsing.

4. Performance vs. Extensibility

When optimizing for performance:

• Balance the size of PARSED_STYLE_LIST—parse only frequently-used attributes, but ensure extensibility by allowing plugins to dynamically extend the list.
• Consider providing a documented API or hook for plugins to register new attributes at runtime, minimizing manual intervention and avoiding hardcoded lists.
• Reuse objects/materials wherever possible (see Performance Optimization Example).
• Profile and monitor performance using tools such as Stats.js to measure the impact of attribute parsing changes.

---

✅ Action Items & Best Practices

1. Plugin Authors: Always register new style attributes during plugin initialization.
2. Core Maintainers: Consider introducing a public API for dynamic extension of PARSED_STYLE_LIST by plugins.
3. Users: Ensure all dependencies are up to date, and follow plugin registration recommendations.
4. All Stakeholders: Balance performance and extensibility by allowing controlled, dynamic registration of attributes.

---

📚 References

• Element Attribute Parsing
• Plugin Registration Guide
• CSS Properties Metadata Structure
• Performance Optimization Techniques

---

If you need guidance on implementing attribute registration in your plugin, or further troubleshooting assistance, please let us know!

---

This is an automated response generated by AI. If you have any questions, our team will follow up as soon as possible.