How to use suppressions within the YML file

[aidandunne1892]

Hello all,

I don't want to raise a bug as I believe I'm doing something wrong and was looking for some guidance on how I can implement what I want. Looking through the readme and previous issues raised I can see the following issue - #234 I'm currently hitting the same predicament where I'm not sure what my config file should look like.

Flow:

<?xml version="1.0" encoding="UTF-8"?>
<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionCalls>
        <name>Add_Error_Log_for_Get_Accounts</name>
        <label>Add Error Log for Get Accounts</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <actionName>FlowLogEntry</actionName>
        <actionType>apex</actionType>
        <connector>
            <targetReference>Save_Get_Accounts_Error_Log</targetReference>
        </connector>
        <flowTransactionModel>Automatic</flowTransactionModel>
        <inputParameters>
            <name>flowName</name>
            <value>
                <stringValue>LOG - CORE - ALF - Log Error Event</stringValue>
            </value>
        </inputParameters>
        <inputParameters>
            <name>message</name>
            <value>
                <elementReference>$Flow.FaultMessage</elementReference>
            </value>
        </inputParameters>
        <inputParameters>
            <name>recordId</name>
            <value>
                <elementReference>$Flow.CurrentRecord</elementReference>
            </value>
        </inputParameters>
        <nameSegment>FlowLogEntry</nameSegment>
        <offset>0</offset>
        <storeOutputAutomatically>true</storeOutputAutomatically>
    </actionCalls>
    <actionCalls>
        <name>Save_Get_Accounts_Error_Log</name>
        <label>Save Get Accounts Error Log</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <actionName>Logger</actionName>
        <actionType>apex</actionType>
        <flowTransactionModel>Automatic</flowTransactionModel>
        <nameSegment>Logger</nameSegment>
        <offset>0</offset>
    </actionCalls>
    <apiVersion>66.0</apiVersion>
    <areMetricsLoggedToDataCloud>false</areMetricsLoggedToDataCloud>
    <customProperties>
        <name>ScreenProgressIndicator</name>
        <value>
            <stringValue>{&quot;location&quot;:&quot;top&quot;,&quot;type&quot;:&quot;simple&quot;}</stringValue>
        </value>
    </customProperties>
    <description>Test Screen Flow</description>
    <environments>Default</environments>
    <interviewLabel>Test Screen Flow AD {!$Flow.CurrentDateTime}</interviewLabel>
    <label>Test Screen Flow AD</label>
    <processMetadataValues>
        <name>BuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>CanvasMode</name>
        <value>
            <stringValue>AUTO_LAYOUT_CANVAS</stringValue>
        </value>
    </processMetadataValues>
    <processMetadataValues>
        <name>OriginBuilderType</name>
        <value>
            <stringValue>LightningFlowBuilder</stringValue>
        </value>
    </processMetadataValues>
    <processType>Flow</processType>
    <recordLookups>
        <name>Get_Accounts</name>
        <label>Get Accounts</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <assignNullValuesIfNoRecordsFound>false</assignNullValuesIfNoRecordsFound>
        <connector>
            <targetReference>Test_Screen_Flow</targetReference>
        </connector>
        <faultConnector>
            <targetReference>Add_Error_Log_for_Get_Accounts</targetReference>
        </faultConnector>
        <filterLogic>and</filterLogic>
        <filters>
            <field>Name</field>
            <operator>EqualTo</operator>
            <value>
                <stringValue>Aaron Perry</stringValue>
            </value>
        </filters>
        <getFirstRecordOnly>true</getFirstRecordOnly>
        <object>Account</object>
        <queriedFields>Id</queriedFields>
        <queriedFields>Name</queriedFields>
        <storeOutputAutomatically>true</storeOutputAutomatically>
    </recordLookups>
    <screens>
        <name>Test_Screen_Flow</name>
        <label>Test Screen Flow</label>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <allowBack>true</allowBack>
        <allowFinish>true</allowFinish>
        <allowPause>true</allowPause>
        <fields>
            <name>Test_text</name>
            <fieldText>&lt;p&gt;Test Text&lt;/p&gt;</fieldText>
            <fieldType>DisplayText</fieldType>
            <styleProperties>
                <verticalAlignment>
                    <stringValue>top</stringValue>
                </verticalAlignment>
                <width>
                    <stringValue>12</stringValue>
                </width>
            </styleProperties>
        </fields>
        <showFooter>true</showFooter>
        <showHeader>true</showHeader>
    </screens>
    <start>
        <locationX>0</locationX>
        <locationY>0</locationY>
        <connector>
            <targetReference>Get_Accounts</targetReference>
        </connector>
    </start>
    <status>Active</status>
</Flow>

flow-scanner.yml:

rules:
  missing-fault-path:
    severity: error
    suppressions:
      - Logger
      - "Logger"

Expected Output:

No errors found.

Actual Output:

Any help or direction at all, I would really appreciate!

[RubenHalman]

@aidandunne1892 Thank you for the detailed input and for pointing out the outdated issue and comments. The correct format for defining exceptions(a separate section in the .flow-scanner.yml) is described in the Define Exceptions chapter of the README documentation. Based on your example, this would translate to:

exceptions:
  Add_Error_Log_for_Get_Accounts:
     missing-fault-path:
      - "Save_Get_Accounts_Error_Log"

Our README only demonstrates the JSON notation, while we typically recommend using the yaml notation with the same data model:

exceptions:
  <FlowName>:
    <RuleId>:
      - <ResultName>

Please let us know if there’s anything we can do to improve the documentation or make it clearer.

[aidandunne1892]

@RubenHalman Awhh okay that makes a lot of sense, thank you for the quick response! I think you've pretty much answered my question so it may be an improvement or enhancement for down the line but in a scenario with say over 50 flows which is a use case I'm currently hitting our fault paths will all be identical in terms of how we're handling them, it would be very cool if we could suppress specific action calls at a rule level rather than having to define an exception at a flow level. As one could cover all the fault paths and the other I would need to define 50 exceptions per flow or what are your thoughts on that?

[RubenHalman]

@aidandunne1892 Glad that helped!

Without a flow context, suppressing by element name alone would be ambiguous and could unintentionally hide results in unrelated flows, which is why exceptions are currently scoped per flow. A realistic scenario could be:

• Flow_A has an element called Save_Error_Log
• Flow_B also has an element called Save_Error_Log
• Flow_C has Save_Error_Log but this one should NOT be suppressed

So it would likely require additional scoping/safety mechanisms. That said, if you have thoughts on how you’d envision this working, feel free to open a ticket with your proposal and scenarios. That may help us explore.

[RubenHalman]

Hi @aidandunne1892, could you check again? You mentioned previously having to define 50 exceptions, which led me to realise we were (https://github.com/Flow-Scanner/lightning-flow-scanner/issues/288).. This has now been resolved and may address your request.

[aidandunne1892]

Hi @RubenHalman, apologies I've been away. I've just tested out what you mentioned above and it works exactly how I was hoping it would!! Thank you very much!!