Rename getMockStore() to createMockStore()

[zbarbuto]

Which @ngrx/* package(s) are relevant/related to the feature request?

store

Information

I have fallen into the trap a couple of times of thinking that getMockStore() was an alias for TestBed.inject(MockStore). For the most part, it will serve a similar purpose, and it the name hints that it will get the mock store I need.

However, it falls apart when you start to use things like overrideSelector as getMockStore().overrideSelector() will not function the same as TestBed.inject(MockStore).overrideSelector() (as you may not get the same mock store used by your component).

I would like to suggest that the function be renamed to createMockStore() to avoid confusion by making it clear that this will be creating a new mock store rather than getting an existing one (probably with a deprecation period for createMockStore().

Describe any alternatives/workarounds you're currently using

No response

I would be willing to submit a PR to fix this issue

• Yes
• No

[timdeschryver]

I like this suggestion 👍
What do you think @markostanimirovic and @brandonroberts ?

[brandonroberts]

Seems reasonable to me. As mentioned, we can deprecate the old name. If there is an automatic migration added we can remove it in v16.

[markostanimirovic]

Sounds good to me too 👍

@zbarbuto do you want to create a PR for this?

You can take a look at these PRs to see how it can be done: #3745 #3753

[zbarbuto]

@markostanimirovic yes, PR is now up (co #3789 - hopefully I did everything right)

Happy to do the schematic one as well (looks like that comes after the first part is merged?)

Thanks all for the prompt responses.

[ValentinBossi]

i think i see side-effects in my tests with createMockStore.
i have 349 tests and i adapted an effect test file (without Testbed), cause the effect now uses data from a selector (selectTT)(https://v15.ngrx.io/guide/effects#incorporating-state), but now other code in other files throws errors (TypeError: Cannot read properties of undefined (reading 'forEach')...)

before:
effects = new XEffects(actions$, XMockService);
after:
effects = new XEffects(actions$, XMockService, createMockStore({selectors: [{ selector: selectTT, value: { id: 'UUID' } as TT }]}));

is it possible that the selectTT and/or the value is still used later in other tests resp even test files?

EDIT:
wow adding
afterAll(() => { mockSelectors = []; });
(cause im doing actually effects = new XEffects(actions$, XMockService, createMockStore({selectors: mockSelectors}))); )

made the test output even worse. obviously im using this the wrong way. (btw im doing mockSelectors.push(...) in 2 tests and beforeEach mockSelectors = [])