Add Missing Else to enhanceEndpoints Function

[kinson]

Overview

Addresses #2334 .

This pr adds a missing else to the enhanceEndpoints function to improve the clarity of the function. It also adds an example of using it to the documentation.

Regarding the original issue:

This needs to be a else or the Object.assign will assign the function to the endpoint.

Based on my understanding of Object.assign, passing a function as an assign will return a copy of the original object with no modifications. I created a codesandbox to demonstrate it (forgive me if there is a better template to use for such a simple example). As a result, the function won't affect the endpoint as the code currently is written. Let me know if I am misunderstanding the issue though, or if my premise is incorrect.

Here is the code snippet again for reference:

redux-toolkit/packages/toolkit/src/query/createApi.ts

Lines 275 to 285 in 64a30d8

	for (const [endpointName, partialDefinition] of Object.entries(
	endpoints
	)) {
	if (typeof partialDefinition === 'function') {
	partialDefinition(context.endpointDefinitions[endpointName])
	}
	Object.assign(
	context.endpointDefinitions[endpointName] || {},
	partialDefinition
	)
	}

Even if the lack of an else will not cause a bug, it still does not make much sense to call Object.assign when a function is passed, because it does not do anything. So, I still added the else in this pr for clarity and readability.

The issue asked for tests as well, however when I went to adds tests I realized I was mostly duplicating a test that was already in the test suite:

redux-toolkit/packages/toolkit/src/query/tests/createApi.test.ts

Lines 457 to 501 in 64a30d8

	test('modify', () => {
	api.enhanceEndpoints({
	endpoints: {
	query1: {
	query: (x) => {
	expectExactType('in1' as const)(x)
	return 'modified1'
	},
	},
	query2(definition) {
	definition.query = (x) => {
	expectExactType('in2' as const)(x)
	return 'modified2'
	}
	},
	mutation1: {
	query: (x) => {
	expectExactType('in1' as const)(x)
	return 'modified1'
	},
	},
	mutation2(definition) {
	definition.query = (x) => {
	expectExactType('in2' as const)(x)
	return 'modified2'
	}
	},
	// @ts-expect-error
	nonExisting: {},
	},
	})
	storeRef.store.dispatch(api.endpoints.query1.initiate('in1'))
	storeRef.store.dispatch(api.endpoints.query2.initiate('in2'))
	storeRef.store.dispatch(api.endpoints.mutation1.initiate('in1'))
	storeRef.store.dispatch(api.endpoints.mutation2.initiate('in2'))
	expect(baseQuery.mock.calls).toEqual([
	['modified1', commonBaseQueryApi, undefined],
	['modified2', commonBaseQueryApi, undefined],
	['modified1', { ...commonBaseQueryApi, forced: undefined }, undefined],
	['modified2', { ...commonBaseQueryApi, forced: undefined }, undefined],
	])
	})
	})

I am happy to add more tests 🤓 , but I wondering what test cases may remain for this. I removed my test change from this pr because I didn't want to add more weight to the codebase without adding any testing value.

Lastly, is there a way for me to preview the docs changes in the format they are rendered? I wanted to provide a before/after screenshot but I am probably missing a very obvious set of steps to get it up and running! CI did it for me 😍 (and I figured out how to do it locally as well)

Thanks for creating this package, and taking the time to read this wall of text ✌🏻 😄

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 2e71d34:

Sandbox	Source
Vanilla	Configuration
Vanilla Typescript	Configuration
rsk-github-issues-example	Configuration
reduxjs/redux-toolkit	Configuration
@examples-query-react/advanced	Configuration
reduxjs/redux-toolkit	Configuration
crazy-clarke-hluqv3	PR

[kinson]

It looks like CI may have failed due to this line:
https://app.netlify.com/sites/redux-starter-kit-docs/deploys/629d1fee7ab8150008c71b33#L301

I will take a closer look and fix this!

[netlify]

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	2e71d34
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/62a31ef64ddd76000972edca
😎 Deploy Preview	https://deploy-preview-2386--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[phryneas]

Thank you for looking deeper into this!

I think the test is enough - to be honest, I just forgot about the existence of that test :)

I've tweaked the example a bit so it works without the : any and am going to get this in - it makes the code base a bit more sane and improves the docs 🎉

[kinson]

Thanks for the updates and finding a way to remove the pesky any!