API Project V2

Project Requirements

• The API should be self documenting
  • Document new tables and fields on apiary
• The API should be to be generated dynamically
• The API should be able to run on an serverless archieture
• The API should support webhooks
• Bespoke logic should be injectable at any stage
• The API should provide metadata with all the tables and fields and their types

Learning Requirements

• To be implemented with TDD in mind
• Adhere to S.O.L.I.D Principals
• Improve understanding of the .vscode directory (Purpose? Benefits?)
• How to setup SonarQube for MacOS/Windows

Learning Notes

• .vscode directory
  • extensions.json
    • Allows you to create a list of recommended extentions for a particular project, for example in this project. I've added:
      • Azure Functions extention
      • ESLint extention
      • Prettier ESLint compatiable extention
    • This should make developing easier and simpler as there is an OTB (out the box) list of extentions that should help with debugging, linting an formatting
    • More information on this particular file can be found here
  • launch.json
    • A configuration file for running or debugging your application.
    • Launch attachs a debugger to the node process allowing for breakpointing!!!
  • settings.json
    • Responsible for workspace based settings; things like format on save etc
  • tasks.json
    • A set of tasks to execute when you press F5 or equivalent run your application.
    • Relative to this project, I've tied it to the npm run build:dev command and then told the func: host to start
  • TypeScript module resolution is stupid and requies another process to replace alias in post-build step.
    • Implmeneted module resolution via external package and supported via hot-reloading aswell

Local Development Setup

• Need to have a local.settings.json file in the following format

  {
    "IsEncrypted": false,
    "Values": {
      "AzureWebJobsStorage": "UseDevelopmentStorage=true",
      "FUNCTIONS_WORKER_RUNTIME": "node",
      "FUNCTIONS_EXTENSION_VERSION": "~2",
      "WEBSITE_NODE_DEFAULT_VERSION": "10.14.1",
      "AzureMSSQLEndpoint": "[ENDPOINT]",
      "AzureMSSQLUser": "[USER]",
      "AzureMSSQLPassword": "[PASSWORD]",
      "AzureMSSQLDB": "[DB]",
      "SchemaDirectory": "[PATH_TO_PROJECT]/@api/src/assets/schema/"
    },
    "host": {
      "LocalHttpPort": 7071,
      "Cors": "*"
    }
  }

TODOs

• - Sanitize values
• - Improve error handling
• - Use Entity & Entity Field tables to generate schema and interfaces
• - Use Entity Relationship tables to generate schema with foreign key relationships
• - Integrate with REDIS
• - Be able to query data using $select, $filter
• - Artiect a way to inject logic based on REQUEST
• - Unit tests with 99%+ coverage
• - Support composite primary keys
• - Integrate Sonarqube into project
• - Dynamic Class loading
  • - Use a dictionary of object to class and then do new dictionary

Dev - TODOs

• - Get entity information before create/update/delete and pass it in
• - Split Generic into SQL|Cosmos entities; both should extend a base entity
• - Fix path issue such that at build it replaces with absolute path
• - Upgrade to latest TypeScript
• - Split generators into own folders; if tests; folder -> index + test or move tests into seperate folder
• - Make SQL Generator simpler; have select in a different generator
• - Create cosmos connection class
• - Refactor SQL connection class
• - Create static classes for things like application insights to just be used wherever
• - Update mixins with latest code from Lordly
• - Metadata should only generate interfaces when working locally or post content to an endpoint which will create it into a package and publish a new version
• - Support core vs non-core tables
• - Create method to get structure hash of database in SQL
• - Figure out which methods could be made static for reuse and reduce memory footprint
• - Cosmos based schema - Maybe?

Notes

API

• Composite primary keys are handled via hyphens
  • Updating the an composite entity; you would send a PATCH request to https://api/v2/CompositeEntity/3-1 to update the entity with the first Id of 3 and second Id of 1

SonarQube

Pre-Requisites

Debugging

• Debugging is available by pressing F5 or "Run" project button. The .vscode folder has been configured to attach on the specified port

Hot Reloading

• This project supports hot-reloading via the following method:
  1. Run npm run local
  2. On another terminal window run npm run watch
  3. Once you save a .ts file, it should hot-reload and the function host should then also reload so that the new changes take effect
  • Note: Hot reloading does not work in debugging mode (F5) yet