https://github.com/stockbal/cds-types-test

https://github.com/stockbal/cds-types-test

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/stockbal/cds-types-test
• Owner: stockbal
• Created: 2024-07-21T13:47:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-21T19:36:03.000Z (4 months ago)
• Last Synced: 2024-10-11T02:43:59.147Z (27 days ago)
• Language: TypeScript
• Size: 428 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Testing @cap-js/cds-types

Simple CAP project to verify/test the generated types from [@cap-js/cds-typer](https://github.com/cap-js/cds-typer) in a CAP project

together with the cds typings from [@cap-js/cds-types](https://github.com/cap-js/cds-types).

Currently the `.before`, `.on` and `.after` handlers are being tested to see if the handler parameter `req.data` or `data` is of the correct class according to the type inference from cds-types.

## Used CDS versions

| Module                 | Version  |

| ---------------------- | -------- |

| @cap-js/asyncapi       | 1.0.2    |

| @cap-js/cds-typer      | 0.24.0   |

| @cap-js/cds-types      | 0.6.3    |

| @cap-js/openapi        | 1.0.4    |

| @cap-js/sqlite         | 1.7.3    |

| @sap/cds               | 8.0.4    |

| @sap/cds-compiler      | 5.0.6    |

| @sap/cds-dk (global)   | 8.0.3    |

| @sap/cds-fiori         | 1.2.7    |

| @sap/cds-foss          | 5.0.1    |

| @sap/cds-mtxs          | 2.0.3    |

| @sap/eslint-plugin-cds | 3.0.4    |

| Node.js                | v18.20.2 |

## Handler tests

### Test results for expected types through type inference

These tests assume the inferred type for each handler registration is correct

e.g. Intellisense for `.before("CREATE", Books)` shows that `req.data` is of type `Book[]`  

![alt text](docs/handler-reg-sample.png)

but, the test of the actual type of `req.data` show that a single object was received, not an array.

![](docs/jest-test-results.png)

### Test results for expected types through runtime

The following tests show that most of the time the received type in `req.data` is a single object, not an array, which makes sense because CRUD operations normally operate on a single entry.

![](docs/runtime-types-expectation-test-results.png)