IN-4121 - async hooks / api client #7155

Olbix · 2024-05-16T07:24:11Z

🔗 Linked issue

❓ Type of change

📖 Documentation (updates to the documentation, readme or JSDoc annotations)
🐞 Bug fix (a non-breaking change that fixes an issue)
👌 Enhancement (improving an existing functionality like performance)
✨ New feature (a non-breaking change that adds functionality)
🧹 Chore (updates to the build process or auxiliary tools and libraries)
⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

📝 Checklist

I have linked an issue or discussion.
I have updated the documentation accordingly.

changeset-bot · 2024-05-16T07:24:15Z

⚠️ No Changeset found

Latest commit: 7b78579

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

WojtekTheWebDev · 2024-05-16T09:10:41Z

packages/middleware/src/handlers/prepareApiFunction/index.ts

-    }
-
-    next();
+    getApiFunction(apiClientInstance, functionName, extensionName)


nit pick but I'd like to have async/await syntax in here as well (easier debugging imho), but you'd need to use this lib: https://www.npmjs.com/package/express-async-handler

WojtekTheWebDev · 2024-05-16T09:19:09Z

packages/middleware/__tests__/integration/orchestration/orchestration.spec.ts

Can you make onCreate async in packages/middleware/__tests__/integration/bootstrap/server.ts to validate async behaviour?

# Conflicts: # packages/middleware/src/apiClientFactory/index.ts # packages/middleware/src/handlers/prepareApiFunction/getApiFunction.ts # packages/middleware/src/handlers/prepareApiFunction/index.ts

WojtekTheWebDev

Still, missing the integration tests to validate full scenario with extensions.

WojtekTheWebDev · 2024-05-17T08:23:48Z

packages/middleware/src/handlers/prepareApiFunction/index.ts

+): (req, res, next) => Promise<any> {
+  return async (req, res, next) => {


I don't like this hack in here ;p I'd go with https://www.npmjs.com/package/express-async-handler and avoid defining the return type, then express will validate if it returns what's expected.

Suggested change

): (req, res, next) => Promise<any> {

return async (req, res, next) => {

) {

return asyncHandler(async (req, res, next) => { ... });

You could also try without the lib and without the Promise in return type

WojtekTheWebDev · 2024-05-17T08:25:24Z

packages/middleware/src/apiClientFactory/index.ts

-        );
+        .reduce(async (configSoFar, extension) => {
+          const resolvedConfig = await configSoFar;
+          return extension.beforeCreate({ configuration: resolvedConfig });


await on lifecycles seems fine but I think you missed async behaviour on hooks like beforeCreate, afterCreate, beforeCall and afterCall

# Conflicts: # packages/middleware/src/apiClientFactory/index.ts # packages/middleware/src/handlers/prepareApiFunction/getApiFunction.ts # packages/middleware/src/handlers/prepareApiFunction/index.ts

lsliwaradioluz · 2024-06-06T08:56:40Z

packages/middleware/__tests__/unit/apiClientFactory/apiClientFactory.spec.ts

-    const { settings } = createApiClient(clientConfig);
+    const { settings } = await createApiClient(clientConfig);
+
+    await settings.client;


lsliwaradioluz · 2024-06-06T08:57:55Z

packages/middleware/__tests__/unit/apiClientFactory/apiClientFactory.spec.ts

@@ -76,11 +78,11 @@ describe("apiClientFactory", () => {
    };

    const { createApiClient } = apiClientFactory<any, any>(params as any);
-    const extensions = (createApiClient as any)._predefinedExtensions;
+    const extensions = ((await createApiClient) as any)._predefinedExtensions;


I'd split that

Suggested change

const extensions = ((await createApiClient) as any)._predefinedExtensions;

const apiClient = (await createApiClient) as any;

const extensions = apiClient._predefinedExtensions;

lsliwaradioluz · 2024-06-06T08:59:04Z

packages/middleware/__tests__/unit/apiClientFactory/apiClientFactory.spec.ts

-    createApiClient.bind({ middleware: { req: null, res: null, extensions } })(
-      {}
-    );
+    await createApiClient.bind({


Since you're calling this function immediately anyway, perhaps you could replace .bind() with .call()?

lsliwaradioluz · 2024-06-06T08:59:37Z

packages/middleware/__tests__/unit/apiClientFactory/apiClientFactory.spec.ts

@@ -106,7 +108,7 @@ describe("apiClientFactory", () => {
    const { createApiClient } = apiClientFactory<any, any>(params as any);
    const extensions = (createApiClient as any)._predefinedExtensions;

-    const apiWithContext: any = createApiClient.bind({
+    const apiWithContext: any = await createApiClient.bind({


Since you're calling this function immediately anyway, perhaps you could replace .bind() with .call()?

same here

lsliwaradioluz · 2024-06-06T09:12:57Z

packages/middleware/__tests__/unit/apiClientFactory/factoryParams.spec.ts

what is this suite testing, actually? :P

# Conflicts: # packages/middleware/__tests__/integration/apiClientFactory.spec.ts

WojtekTheWebDev

Approved in advance but type casting to any might be redundant

WojtekTheWebDev · 2024-06-06T12:21:47Z

packages/middleware/__tests__/integration/apiClientFactory.spec.ts

+          configuration: {},
+          location: "./__tests__/integration/bootstrap/server",
+          extensions() {
+            return [myExtension as any];


why as any?

IN-4121 - async hooks / api client

d7c92d1

WojtekTheWebDev requested changes May 16, 2024

View reviewed changes

krystian wlodarski added 2 commits May 17, 2024 01:46

IN-4121 - async hooks / api client

ca5e346

Merge remote-tracking branch 'origin/feat/IN-4121' into feat/IN-4121

1bc9c3b

# Conflicts: # packages/middleware/src/apiClientFactory/index.ts # packages/middleware/src/handlers/prepareApiFunction/getApiFunction.ts # packages/middleware/src/handlers/prepareApiFunction/index.ts

WojtekTheWebDev requested changes May 17, 2024

View reviewed changes

Merge remote-tracking branch 'origin/feat/IN-4121' into feat/IN-4121

4b05c67

# Conflicts: # packages/middleware/src/apiClientFactory/index.ts # packages/middleware/src/handlers/prepareApiFunction/getApiFunction.ts # packages/middleware/src/handlers/prepareApiFunction/index.ts

lsliwaradioluz reviewed Jun 6, 2024

View reviewed changes

packages/middleware/__tests__/unit/apiClientFactory/factoryParams.spec.ts Outdated

Copy link

Collaborator

lsliwaradioluz Jun 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this suite testing, actually? :P

lsliwaradioluz and others added 8 commits June 6, 2024 12:45

fix: apiclientfactory integration test suggestion

128fa91

chore: remove console logs

743ae9e

chore: remove reundant req and res

b6f67dd

chore: remove Promise.resolve

f05c84b

add tests / async hooks

1ad6cb0

Merge remote-tracking branch 'origin/feat/IN-4121' into feat/IN-4121

10fe5bf

# Conflicts: # packages/middleware/__tests__/integration/apiClientFactory.spec.ts

Merge remote-tracking branch 'origin/feat/IN-4121' into feat/IN-4121

57da4a0

# Conflicts: # packages/middleware/__tests__/integration/apiClientFactory.spec.ts

Merge remote-tracking branch 'origin/feat/IN-4121' into feat/IN-4121

7b78579

lsliwaradioluz approved these changes Jun 6, 2024

View reviewed changes

WojtekTheWebDev marked this pull request as ready for review June 6, 2024 11:43

WojtekTheWebDev requested a review from a team as a code owner June 6, 2024 11:43

WojtekTheWebDev approved these changes Jun 6, 2024

View reviewed changes

Olbix merged commit e6fd664 into main Jun 6, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IN-4121 - async hooks / api client #7155

IN-4121 - async hooks / api client #7155

Olbix commented May 16, 2024

changeset-bot bot commented May 16, 2024 •

edited

WojtekTheWebDev May 16, 2024

WojtekTheWebDev May 16, 2024

WojtekTheWebDev left a comment

WojtekTheWebDev May 17, 2024

WojtekTheWebDev May 17, 2024

WojtekTheWebDev May 17, 2024

lsliwaradioluz Jun 6, 2024

lsliwaradioluz Jun 6, 2024

lsliwaradioluz Jun 6, 2024

lsliwaradioluz Jun 6, 2024

lsliwaradioluz Jun 6, 2024

WojtekTheWebDev left a comment

WojtekTheWebDev Jun 6, 2024

		): (req, res, next) => Promise<any> {
		return async (req, res, next) => {

	const extensions = ((await createApiClient) as any)._predefinedExtensions;
	const apiClient = (await createApiClient) as any;
	const extensions = apiClient._predefinedExtensions;

IN-4121 - async hooks / api client #7155

IN-4121 - async hooks / api client #7155

Conversation

Olbix commented May 16, 2024

🔗 Linked issue

❓ Type of change

📚 Description

📝 Checklist

changeset-bot bot commented May 16, 2024 • edited

⚠️ No Changeset found

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WojtekTheWebDev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WojtekTheWebDev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

changeset-bot bot commented May 16, 2024 •

edited