Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[BUG][code-analyzer] Flow rules producing false positives and flagging platform limitations (MissingFaultHandler, MissingDescription, UnusedResource, SameRecordUpdate)

Đang mở
#2,026 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
42/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
tooling

Hướng nghiên cứu

Tái hiện bốn báo cáo với MyParentFlow.flow-meta.xml và MySubFlow.flow-meta.xml bằng cách sử dụng sf code-analyzer run --target "./force-app/main/default/flows" --rule-selector flow. Truy vết các điểm vào của các rule flow:MissingFaultHandler, flow:MissingDescription, flow:UnusedResource và flow:SameRecordUpdate, cùng với cách chúng xử lý các giới hạn của nền tảng và các tham chiếu tài nguyên. Hoàn thành khi các trường hợp hợp lệ không còn bị báo cáo, trong khi các vi phạm thực sự vẫn có thể được phát hiện.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Have you tried to resolve this issue yourself first?
  • I confirm I have gone through the above steps and still have an issue to report.
Bug Description

When running sf code-analyzer run --rule-selector flow on Salesforce Flow metadata, several rules are either producing false positives or flagging platform limitations that cannot be remediated:

  1. flow:MissingFaultHandler — Flags subflow elements for missing fault handlers, but Flow Builder does not support adding fault paths to subflow elements (platform limitation).

  2. flow:MissingDescription — Flags system-managed elements like $Record.Id (trigger record references) for missing descriptions, but these elements cannot have custom descriptions added (platform limitation).

  3. flow:UnusedResource — Flags resources (e.g., formula variables) as unused when they are actively being used in the flow (false positive). The analyzer appears to not detect usage in certain contexts such as decision conditions or formula expressions.

  4. flow:SameRecordUpdate — Flags AfterSave record triggers for modifying the same record. This is a valid business requirement when email alerts (only supported in AfterSave flows) must be sent before updating the record. The logic cannot be moved to BeforeSave without losing functionality.

Output / Logs
#    Severity       Rule                       Location                           Message                                                                                                                                                                                                                                                                               

  1    2 (High)       flow:MissingFaultHandler   MyParentFlow.flow-meta.xml:140:1   An element that can fire fault events is missing fault handlers. Add fault handlers to all Create Records, Update Records, Delete Records, Action Calls, and Subflows.

  2    2 (High)       flow:MissingFaultHandler   MySubFlow.flow-meta.xml:140:1      An element that can fire fault events is missing fault handlers. Add fault handlers to all Create Records, Update Records, Delete Records, Action Calls, and Subflows.

  3    3 (Moderate)   flow:UnusedResource        MyParentFlow.flow-meta.xml:76:1    A resource is not used elsewhere in the flow. Check that you did not intend to use the resource and then delete it.

  4    3 (Moderate)   flow:SameRecordUpdate      MyParentFlow.flow-meta.xml:103:1   An AfterSave record trigger is modifying the same record. Record modifications should be done in BeforeSave triggers, not AfterSave triggers. The trigger definition may be in a parent flow that calls the current flow as a subflow, passing in the recordId of the trigger record.

  5    4 (Low)        flow:MissingDescription    MyParentFlow.flow-meta.xml:18:1    An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.

  6    4 (Low)        flow:MissingDescription    MyParentFlow.flow-meta.xml:150:1   An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.

  7    4 (Low)        flow:MissingDescription    MySubFlow.flow-meta.xml:2:1        An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.

  8    4 (Low)        flow:MissingDescription    MySubFlow.flow-meta.xml:2:1        An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.

  9    4 (Low)        flow:MissingDescription    MySubFlow.flow-meta.xml:49:1       An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.

  10   4 (Low)        flow:MissingDescription    MySubFlow.flow-meta.xml:49:1       An element contains a label that is missing a description. Document all elements with labels to make the flow comprehensible to future maintainers.
Steps To Reproduce

Create a Salesforce Flow metadata file with the following characteristics:

  1. MyParentFlow.flow-meta.xml (AfterSave record-triggered flow on Account object)
  • Contains a subflow element (InvokeMySubflow)
  • Contains a formula variable (formulavar) used in a decision condition
  • Contains an email alert action followed by a record update on the same triggering record
  1. MySubFlow.flow-meta.xml (Auto-launched flow)
  • Contains an assignment element and variables
  1. Run the command:sf code-analyzer run --target "./force-app/main/default/flows" --rule-selector flow

  2. Observe the violations listed above.

Attached Files:
MyParentFlow.flow-meta.xml
MySubFlow.flow-meta.xml

Expected Behavior
  1. flow:MissingFaultHandler — Should not flag subflow elements, as fault paths cannot be added to subflows in Flow Builder (platform limitation).
  2. flow:MissingDescription — Should not flag system-managed elements like $Record.Id, as these cannot have custom descriptions (platform limitation).
  3. flow:UnusedResource — Should correctly detect when a resource (like formulavar) is used in decision conditions and not flag it as unused.
  4. flow:SameRecordUpdate — Should support exceptions or provide guidance for valid business cases where AfterSave record updates are required (e.g., when email alerts must be sent before updating the record).
Operating System

macOS

Salesforce CLI Version

@salesforce/cli/2.130.9 darwin-arm64 node-v22.22.2

Code Analyzer Plugin (code-analyzer) Version

code-analyzer 5.11.1

Node Version

v24.14.0

Java Version

openjdk version "21.0.2" 2024-01-16 LTS OpenJDK Runtime Environment Zulu21.32+17-CA (build 21.0.2+13-LTS) OpenJDK 64-Bit Server VM Zulu21.32+17-CA (build 21.0.2+13-LTS, mixed mode, sharing)

Python Version

command not found: python

Additional Context (Screenshots, Files, etc)
Image Image Image Image
Workaround
  1. Currently using the Suppress Violations feature to suppress false positives (flow:UnusedResource, flow:MissingDescription) by adding @suppress in the tags of flow elements.
  2. However, this is a temporary workaround and does not address the underlying false positive detection or platform limitation issues.
Urgency

Moderate

Ngôn ngữ chính
TypeScript
Star
241
Fork
51
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của forcedotcom/code-analyzer

Tất cả issue của forcedotcom/code-analyzer

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.