Fix: Fixes for fetchDomainBalance lambda edge cases

[mmioana]

Description

• This PR aims to solve the following issues identified on QA
• Cover case for action without token in getTotalFiatAmountFor - for this I have actually added a filter for the actions before reaching this step as it doesn't make sense to include the actions that don't have a token and an amount/networkFee
• Use directly the network value for getting the default network token and network info in NetworkConfig - actually for this one I added a fallback to the network env var if the colony js mapping does not exist
• Cover case for grouping actions by period, but the computed action period was not included in the initial setup - this was happening due to wrongly computing the start date of a period, including one extra day/month/week/year

Testing

TODO: Please test the fetchDomainBalance lambda and check these edge cases are covered.
Don't know how to easily do this on DEV without actually changing directly into code the used values as in for eg. adding a null token or using arbitrumOne as a value for the network env var etc. So let's do this 🦾

Important

To check the values returned or logged in a lambda, you need to always run the getDomainBalance query and then check the amplify logs

Step 1. Let's make sure the query runs as expected first

query MyQuery {
  getDomainBalance(
    input: {
      colonyAddress: "<COLONY_ADDRESS_HERE>", 
      timeframePeriod: 1, 
      timeframeType: MONTHLY
    }
  ) {
    total
    totalIn
    totalOut
  }
}

Step 2. Now let's try to break it by using a negative or 0 timeframePeriod

query MyQuery {
  getDomainBalance(
    input: {
      colonyAddress: "<COLONY_ADDRESS_HERE>", 
      timeframePeriod: -10, 
      timeframeType: MONTHLY
    }
  ) {
    total
    totalIn
    totalOut
  }
}

Step 3. For the next queries please change back the timeframePeriod to a value > 0

Step 4. Go to amplify/backend/function/fetchDomainBalance/src/config/envVars.js and replace
let network = Network.Custom; with
let network = 'arbitrumOne'

Step 5. Now in amplify/backend/function/fetchDomainBalance/src/config/networkConfig.js check the DEFAULT_NETWORK_TOKEN and DEFAULT_NETWORK_INFO

Step 6. Go to amplify/backend/function/fetchDomainBalance/src/utils.js go to getFormattedActions and replace the code with

const getFormattedActions = (actions, domainId) => {
  // Separating the actions created as extension support
  let extensionSupportActions = actions.filter(
    (action) => !!action.initiatorExtension?.id,
  );

  return actions
    .filter((action) => !action.initiatorExtension?.id)
    .map((action) => getActionWithFinalizedDate(action))
    .filter((action) => !!action.finalizedDate)
    .map((action) => {
      let amount = action.amount;
      let networkFee = action.networkFee;

      /**
       * If there is no domain selected (aka we are at colony level) and the action type is not among payments, we'll consider the amount to be '0'
       * Though we might need to reconsider this when transferring funds between colonies
       */
      if (!domainId && !paymentActionTypes.includes(action.type)) {
        amount = '0';
      }

      const attachedAction = extensionSupportActions.find(
        (extensionSupportAction) =>
          extensionSupportAction.rootHash === action.rootHash,
      );

      if (attachedAction) {
        networkFee = attachedAction.networkFee;
      }

      return {
        ...action,
        token: null,
        amount,
        networkFee,
      };
    });
};

Step 7. Go to amplify/backend/function/fetchDomainBalance/src/index.js and check inOutActions don't contain the regular actions (Simple payments or Transfer funds)

Resolves #3658

[bassgeta]

Yup, the code changes look sane, I will absolutely trust your judgement here as the master of fetchDomainBalance lambda :D

1. Still runs as it should ✔️
   
2. Negative and 0 don't bork ✔️
   
   
   Arbitrum balance ✔️
   
   No simple payments or move funds:
   
   

[bassgeta]

Intentional or a leftover 👀 ?

[mmioana]

Intentional, so we can get some more information if there is an error in a specific call

[rdig]

Seems to be working as expected. Nice fix here! 👍

[rumzledz]

Can confirm testing steps are telling me the truth and nothing but the truth! 🙌

GraphQL Queries

timeFramePeriod = 1

timeFramePeriod = -10

timeFramePeriod = 21

Code changes

network = arbitrumOne

returning token: null from getFormattedOptions()

Results

Before	After (no more simple payment types)