feat(registerMock): add registerMock functionality to register custom mocks per project #125
Conversation
…nit tests for extension parameters
src/transformer/mock/mock.ts
Outdated
| } | ||
|
|
||
| const factory: ts.FunctionExpression = node.arguments[0] as ts.FunctionExpression; | ||
| MockDefiner.instance.storeRegisterMockFor(TypescriptHelper.GetDeclarationFromNode((typeToMock as ts.TypeReferenceNode).typeName), factory); |
There was a problem hiding this comment.
if you want to avoid the casting to ts.TypeReferenceNode you can invert the if statement
You can also returning only once at the end with if else (I honestly don't mind either way).
Up to you :)
There was a problem hiding this comment.
makes sense, I've inverted the if, removed the casting and removed duplication
| @@ -9,7 +9,7 @@ export function GetIntersectionDescriptor(intersectionTypeNode: ts.IntersectionT | |||
| const nodes: ts.Node[] = GetTypes(intersectionTypeNode.types, scope); | |||
|
|
|||
| const hasInvalidIntersections: boolean = nodes.some((node: ts.Node) => { | |||
| return TypescriptHelper.IsLiteralOrPrimitive(node); | |||
| return TypescriptHelper.IsLiteralOrPrimitive(node) || node.kind === ts.SyntaxKind.TypeQuery; | |||
There was a problem hiding this comment.
I am trying to start using ts.isType instead of kind check... for example, ts.isTypeQuery(node)
There was a problem hiding this comment.
interesting, I've changed it here, I think in busy places we should still use the check with kind to make it quicker
| @@ -9,6 +10,10 @@ import { GetTypescriptType, IsTypescriptType } from '../tsLibs/typecriptLibs'; | |||
| export function GetTypeReferenceDescriptor(node: ts.TypeReferenceNode, scope: Scope): ts.Expression { | |||
| const declaration: ts.Declaration = TypescriptHelper.GetDeclarationFromNode(node.typeName); | |||
|
|
|||
| if (MockDefiner.instance.hasMockForDeclaration(declaration)) { | |||
There was a problem hiding this comment.
Considering that now we check up front if we already have the mock shall we simplify the checks inside GetMockFactoryCall? I think there are unnecessary check in this scenario. If you look at this line
we will check the declaration in the cache twice.
In the same way the last if statement that use GetMockFactory call could be simplified to not to the check because it will add a new declaration in the cache and create a new mock
There was a problem hiding this comment.
I've changed few things:
- now in mockFactoryCall.ts there are 2 different ways to get the call, one where you create a new one, one where you use an existing one, this makes sure a check done earlier is not repeated
- in typeReference.ts we make the check and decide which function to use
- in mockDefiner the ifs are removed
The only downside of this is that now there is no check anymore, a call to "GetMockFactoryCall" of an existing mock factory will create a call to the repository of a non existing factory. I would say that is ok, everything is under test so it shouldn't be possible to miss it.
| return this._registerMockFactoryRegistrationsPerFile[sourceFile.fileName] | ||
| .map((reg: { key: ts.Declaration; factory: ts.Expression }) => { | ||
| const key: string = this._registerMockFactoryCache.get(reg.key); | ||
| // const key: string = this._factoryCache.get(reg.key); |
There was a problem hiding this comment.
I think you just forgot this line. If I understand the intention is good to have the registerFactoryCache separated so we can clean it when need it.
There was a problem hiding this comment.
removed, it was a leftover
| const key: string = this.getDeclarationKeyMap(declaration); | ||
|
|
||
| this._registerMockFactoryCache.set(declaration, key); | ||
| // this._factoryCache.set(declaration, key); |
There was a problem hiding this comment.
I think you just forgot this line. If I understand the intention is good to have the registerFactoryCache separated so we can clean it when need it.
There was a problem hiding this comment.
removed, it was a leftover
Pmyl
changed the title
… mocks per project (#125) * add first working version of register mock, needs code cleaning and unit tests for extension parameters * remove unwanted extra functionalities * make sure register mock works fine when not using caching * add new extension strategy example and write documentation for registerMock * fix after rebase * fix playground * remove commented code * simplify code * use typescript methods to check node type * remove duplicated check for mocked type
This PR adds the possibility to register a custom mock and it contains tests and documentation of every possible usage.
It also adds a new and better method of using extension strategies but I will create a new PR to add documentation for those.
This PR also fixes a usecase where an intersection with a typeof was breaking the build. Now an intersection with a typeof will ignore the typeof when deciding the generated type.
This closes #12