Testing Error in Orgs with State & Country Code Picklists

[jobcentersoftware]

Package Edition of Nebula Logger

Unlocked Package

Package Version of Nebula Logger

4.17.4

New Bug Summary

We are getting consistent errors in the LoggerEmailSender class, after the recent Email-related patch. In orgs that have County picklists enabled, this is happening during our builds. In orgs that do NOT have state and country picklists enabled, the patch is working just fine.

  <testcase name="it_should_indicate_email_deliverability_is_based_on_email_deliverability_when_org_limits_not_exceeded" classname="LoggerEmailSender_Tests" time="0.07">
            <failure message="System.DmlException: Update failed. First exception on row 0 with id 005SK00000EG2llYAD; first error: FIELD_INTEGRITY_EXCEPTION, There&apos;s a problem with this country, even though it may appear correct. Please select a country/territory from the list of valid countries.: [Country]"><![CDATA[Class.LoggerEmailSender_Tests: line 32, column 1]]></failure>
        </testcase>

[jobcentersoftware]

Sorry, that's the LoggerEmailSender_Tests class

[jongpie]

Hi @jobcentersoftware - I just tried this in a scratch org with state + country picklists enabled, and everything is still passing for me. Are your build orgs sandboxes or scratch orgs?

[jobcentersoftware]

They are scratch orgs (part of our CI/CD process)

[jobcentersoftware]

This is what I did to fix it (temporarily). I threw it into a new scratch org and it worked before and after state and country enablement

  static {
    // Don't use the org's actual custom metadata records when running tests
    LoggerConfigurationSelector.useMocks();

    // Salesforce now sends email only from verified domains, with a few exceptions for domains like gmail.com & hotmail.com
    // To avoid the error "INSUFFICIENT_ACCESS_OR_READONLY, We can't send your email because your email address domain isn't verified.",
    // a fake gmail.com address is used on the current user.
    // Docs: https://help.salesforce.com/s/articleView?id=xcloud.security_user_email_verification_substitute_domain.htm&type=5
    Schema.User newUser = new Schema.User(Id = System.UserInfo.getUserId(), Email = 'nebula.logger.testing.fake@gmail.com');
    if(Schema.SObjectType.User.fields.getMap().containsKey('CountryCode')) {
      newUser.put('stateCode', 'MI');
      newUser.put('countryCode', 'US');
    }
    update newUser;
  }

[jongpie]

@jobcentersoftware can you share your scratch org definition file/any other details about your setup? I'd like to be able to reproduce the issue, but I'm not sure what's different about your setup vs mine.

[ClayChipps]

@jongpie Thank you for the prompt response, I am providing below the scratch definition file we are using.

Additionally, these were the commands I executed.

sf org create scratch --duration-days 3 --definition-file config/scratch-orgs/country-picklist-scratch-def.json --alias chippsNebulaLogger --wait 30

sf project deploy start -d nebula-logger/core -o chippsNebulaLogger --wait 30

sf apex run test --test-level RunLocalTests --code-coverage --result-format junit --wait 60 --output-dir ./test-results/apex -o chippsNebulaLogger

{
  "orgName": "nebula-logger-core",
  "edition": "Enterprise",
  "features": [
    "Communities",
    "ContactsToMultipleAccounts",
    "PersonAccounts",
    "StateAndCountryPicklist"
  ],
  "settings": {
    "communitiesSettings": {
      "enableNetworksEnabled": true
    },
    "enhancedNotesSettings": {
      "enableEnhancedNotes": true
    },
    "emailAdministrationSettings": {      
      "enableEnhancedEmailEnabled": true    
    },
    "experienceBundleSettings": {
      "enableExperienceBundleMetadata": true
    },
    "lightningExperienceSettings": {
      "enableS1DesktopEnabled": true
    },
    "nameSettings": {
      "enableMiddleName": true,
      "enableNameSuffix": true
    },
    "securitySettings": {
      "enableAuditFieldsInactiveOwner": "true",
      "sessionSettings": {
        "lockSessionsToDomain": "false",
        "lockSessionsToIp": "false",
        "sessionTimeout": "TwelveHours"
      }
    }
  }
}

[ClayChipps]

Hi @jongpie, have you had a chance to try to recreate this issue? We are hoping to not fork our copy of the project to apply the fix that @jobcentersoftware has suggested. Thank you so much for your support of this project!

[jongpie]

Hi @ClayChipps - yeah, I was finally able to try out the scratch-def.json file, and I'm now able to reproduce the issue. It seems like it's caused by a combination of how scratch org users are created/populated, and the extra fields used by the state & country picklists feature. The end result is that the scratch org user, User User, is created in a broken state - any DML on the user record that doesn't include correcting the bad data will result in the DML exception.

I think the quickest fix for your project would be to add & run a script in your pipeline to update the auto-generated scratch org user, using a slightly modified version of the code that @jobcentersoftware shared above. I would run this right after creating the scratch org.

if(Schema.SObjectType.User.fields.getMap().containsKey('CountryCode')) {
    User currentUser = new User(Id = UserInfo.getUserId());
    currentUser.put('StateCode', 'MI');
    currentUser.put('CountryCode', 'US');
    update currentUser;
}

That will fix the current user's data, before Nebula Logger (or any other code/metadata) attempts to modify the scratch org user.

I'm also very hesitant to have Nebula Logger try to update the fields CountryCode and StateCode in tests - the fields themselves have nothing to do with Nebula Logger's functionality, and the more fields I attempt to change on the user, the more likely it is that Nebula Logger's tests will have issues in some other org/project/team, caused by custom validation rules, some other Salesforce features, etc. I think the long-term fix for this is for it to be handled on Salesforce's side (either on the scratch org side, or the state & country picklist metadata side).