Add allowLazyInSync container option

[paul-marechal]

This is useful when binding promise objects while still using the
synchronous APIs.

Description

Add a new allowLazyInSync option to interfaces.ContainerOptions.

It is false by default.

When true, it will prevent throwing when getting promise objects from the bindings.

Related Issue

n/a

Motivation and Context

We used an old version of Inversify (5.1.1) and wanted to upgrade to 6.0.1.

We used to bind some promise objects as .toConstantValue(promise...) and have the components deal with it after construction. This now seem to completely break with the new Inversify logic.

We don't have time to completely refactor our code to avoid the error from being thrown, so turning the check off is our best bet for now.

How Has This Been Tested?

Added a new unit test for this option.

Types of changes

• Updated docs / Refactor code / Added a tests case (non-breaking change)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.
• I have updated the changelog.

[PodaruDragos]

I think this is fine.
@dcavanagh @jakehamtexas what do you guys think ?

@paul-marechal can you please make sure the CI get's to green ?

[paul-marechal]

getArgs.serviceIdentifier can be a symbol here, and it fails to get converted to string in LAZY_IN_SYNC.

I added a quick fix in error_msgs.ts to not fail in such a case. Not sure if the impl is good:

const TO_STRING = (value: any) => typeof value?.toString === 'function' ? value.toString() : `${value}`;

Surprisingly, doing the following fails:

const symbol = Symbol('test');
console.log(`${symbol}`);

But calling .toString() manually on the symbol works... Gotta love working with JavaScript :)

[paul-marechal]

@PodaruDragos CI should be fixed.

[leonardssh]

LGTM!

[paul-marechal]

Closing because I realized it might be weird to try and bend Inversify in way it isn't meant to be.

I don't know what you guys think about the constraint with never binding promises/thenables but it sounds like it makes sense to encourage binding actual implementations and prevent raw promises from being passed around?