Update @salesforce/apex/* imports to return jest.fn()

[nwcm]

After looking for ways to simplify mocking apex methods in a SFDX project, I found this transformer is applied. However the apex method transforms don't make the imports available within jests.

This change allows for jests import and use apex methods cleanly without having to mock in each test file.

This doesn't apply to wired apex methods which would need createApexTestWireAdapter() from @salesforce/sf

// foo.test.js
import apexMethod from "@salesforce/apex/ApexClass.apexMethod";

describe("c-foo", () => {
  afterEach(() => {
    // resetEnvironment();
  });
  
  
  it("Test mock", async () => {
     apexMethod.mockResolvedValue('value');
  }
}

Otherwise any apex method requires

jest.mock(
  "@salesforce/apex/ApexClass.apexMethod",
  () => {
    return {
      default: jest.fn()
    };
  },
  { virtual: true }
);

[salesforce-cla]

Thanks for the contribution! Before we can merge this, we need @nwcm to sign the Salesforce Inc. Contributor License Agreement.

[nolanlawson]

Thanks for the contribution! Could you clarify: is this a breaking change?

[nolanlawson]

FYI @pozil @Templarian do you have strong opinions about this? Should we just return a jest.fn() so that people can mock directly?

[nwcm]

Thanks for the contribution! Could you clarify: is this a breaking change?

Hey @nolanlawson, I don't believe so but can't be 100%. This change did not break any tests across our source which usually directly mock apex in each test file

[pozil]

I like the idea of having a mock directly but I have not clue about the potential impact of such a change.

[nolanlawson]

I don't think this should be a breaking change. It looks reasonable enough to me.

OTOH could we please add documentation for this so that it's more discoverable? A good place would be this README. Thank you! 🙇

[nwcm]

@nolanlawson I have made additions to the documentation as you suggest. Feel free to provide feedback, there wasn't anything too similar in the readme to align with

[nolanlawson]

One small change to account for injectGlobals=false and I think this is good to go! nwcm#1

[nwcm]

One small change to account for injectGlobals=false and I think this is good to go! nwcm#1

Good catch! Merged

[nolanlawson]

Thanks a bunch! Really appreciate the time you took to add docs and such. 🙇 Will release this in a bit.