Skip to content

Commit

Permalink
feat: init inversify plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
mildronize committed Apr 18, 2024
1 parent e3b0949 commit d0413bf
Show file tree
Hide file tree
Showing 8 changed files with 218 additions and 16 deletions.
3 changes: 2 additions & 1 deletion examples/azure-functions-with-inversify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
"dependencies": {
"@azure/functions": "^4.1.0",
"@di-extra/inversify": "^0.2.0",
"nammatham": "2.0.0-alpha.13",
"@nammatham/inversify": "2.0.0-alpha.13",
"inversify": "^6.0.2",
"nammatham": "2.0.0-alpha.13",
"reflect-metadata": "^0.2.1"
},
"devDependencies": {
Expand Down
15 changes: 4 additions & 11 deletions examples/azure-functions-with-inversify/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
import 'reflect-metadata';
import { BaseHandlerResolver, expressPlugin, NammathamApp } from 'nammatham';
import { expressPlugin } from 'nammatham';
import { HomeController } from './controllers/home.controller';
import { app } from './nammatham';
import { container } from './container';
import { Container, interfaces } from 'inversify';

// Uncomment this line to use inversify plugin
// import { inverisfyPlugin } from '@nammatham/inversify';

// Mock inversify plugin
declare function inverisfyPlugin(options: {
container: Container;
controllers: interfaces.ServiceIdentifier[];
}): (app: NammathamApp, handlerResolver: BaseHandlerResolver) => void;
// Import the inversify plugin
import { inverisfyPlugin } from '@nammatham/inversify';

// Manually register controllers
// const homeController = new HomeController(container.get(DataService));
// app.addFunctions(homeController.hello);

// Automatically register controllers
app.register(inverisfyPlugin({ container, controllers: [HomeController] }));
app.register(inverisfyPlugin({ container, services: [HomeController] }));

const dev = process.env.NODE_ENV === 'development';
app.register(expressPlugin({ dev }));
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
"scripts": {
"test": "vitest",
"test:coverage": "vitest run --coverage",
"dev": "nx run @nammatham/core:build && nx run-many -t dev --projects nammatham @nammatham/* --parallel=5",
"dev": "nx run @nammatham/core:build && nx run-many -t dev --projects nammatham @nammatham/* --parallel=10",
"pre-local": "tsx ./scripts/pre-local.ts",
"post-local": "tsx ./scripts/post-local.ts",
"release": "run-s build releaseOnly",
"releaseOnly": "tsx ./scripts/release.ts",
"format": "nx run-many -t format --projects=@nammatham/* --parallel=5",
"lint": "nx run-many -t lint --projects=@nammatham/* --parallel=5",
"lint:fix": "nx run-many -t lint:fix --projects=@nammatham/* --parallel=5",
"format": "nx run-many -t format --projects=@nammatham/* --parallel=10",
"lint": "nx run-many -t lint --projects=@nammatham/* --parallel=10",
"lint:fix": "nx run-many -t lint:fix --projects=@nammatham/* --parallel=10",
"build": "nx run-many -t build --parallel=10",
"azurite": "pnpx azurite --silent --location ./.azurite --debug ./.azurite/debug.log"
},
Expand Down
148 changes: 148 additions & 0 deletions packages/inversify/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
<p align="center">
<a href="http://thadaw.com/" target="blank"><img src="https://i.ibb.co/QmTh7x4/Nammatham-Logo-v2.png" width="120" alt="Nammatham Logo" /></a>
</p>

<p align="center">
Type-safe Serverless Library for Azure Functions and friends
</p>

<p align="center"><a href="https://www.npmjs.com/package/nammatham"><img alt="NPM Version (with dist tag)" src="https://img.shields.io/npm/v/nammatham/alpha">
<a href="https://www.npmjs.com/package/nammatham"><img src="https://img.shields.io/npm/dt/nammatham" alt="npm download"></a></p>


> 🚧 Alpha Stage: Internal Use Only 🚧
>
> Please note that Nammatham v2 is currently in its Alpha stage and is intended for internal use only. As we actively develop and refine the platform, be aware that the API may undergo frequent changes. [Tracking v2 Roadmap](https://github.com/thaitype/nammatham/issues?q=is%3Aissue+is%3Aopen+label%3Av2-blocker)
>
> Note: [Nammatham v1](https://www.npmjs.com/package/nammatham) is currently in maintenance mode. no new features are actively being developed
You're reading v2 docs


| Version | Status | Azure Functions <br>Node.js Lib | Branch | Build Status |
| ------- | ----------- | ----------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| v1.x | Maintenance | v3.x | [v1.x][v1.x] | [![Build & Test](https://github.com/thaitype/nammatham/actions/workflows/test.yml/badge.svg?branch=v1.x)](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/thaitype/nammatham/branch/v1.x/graph/badge.svg?token=Y7ZMDKFPAN)](https://codecov.io/gh/thaitype/nammatham) |
| v2.x | Alpha | v4.x | [main][main] | [![Build & Test](https://github.com/thaitype/nammatham/actions/workflows/test.yml/badge.svg?branch=main.unittest)](https://github.com/thaitype/nammatham/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/thaitype/nammatham/branch/main/graph/badge.svg?token=Y7ZMDKFPAN)](https://codecov.io/gh/thaitype/nammatham) |

[v1.x]: https://github.com/thaitype/nammatham/tree/v1.x
[main]: https://github.com/thaitype/nammatham/tree/main

## Description
Nammatham (นามธรรม in Thai, pronounced `/naam ma tham/`, means **abstract** in Thai) is Azure Function Nodejs.

## Getting Started for Azure Functions

### Install

```bash
# Including all packages
npm install nammatham@alpha
```

### Example

You can see [examples](examples) or follow the minimal app getting started below:

> `initNammatham.create()` is a factory function for creating Nammatham App, it's a wrapper for Azure Functions App.
```typescript
import { initNammatham, expressPlugin } from 'nammatham';

const n = initNammatham.create();
const func = n.func;
const app = n.app;

const helloFunction = func
.httpGet('hello', {
route: 'hello-world',
})
.handler(async c => {
c.context.log('HTTP trigger function processed a request.');
c.context.debug(`Http function processed request for url "${c.trigger.url}"`);
const name = c.trigger.query.get('name') || (await c.trigger.text()) || 'world';
return c.text(`Hello, ${name}!`);
});

app.addFunctions(helloFunction);

const dev = process.env.NODE_ENV === 'development';
app.register(expressPlugin({ dev }));
app.start();
```

Then edit `package.json` like this;

```json
{
"main": "dist/src/main.js",
"scripts": {
"dev": "cross-env NODE_ENV=development tsx watch src/main.ts",
"start": "tsc && func start"
}
}
```

Run Dev Server on locally, (For dev server use `tsx watch` for reloading run dev server using `express` )

```
npm run dev
```

Run Azure Functions on locally (Using Official Azure Functions Node.js)

```
npm start
```


## Nammatham Packages

- [core][@nammatham/core], Nammatham Core package for initializing Nammatham App

### Available Adatpers

- [azure-functions][@nammatham/azure-functions], Azure Functions Adapter for Nammatham, internally, Azure Functions in local dev mode is dependend on Express.js.

### Available Plugins

- [express][@nammatham/express], Express Plugin for run server. Nammatham itself doesn't contain any server, enabling this plugin to provide better DX than the original server e.g. Azure Functions Runtime
- [trpc-azure-functions][@nammatham/trpc-azure-functions], provide [tRPC](https://trpc.io/) Plugin for Azure Functions, inclduing [express][@nammatham/express] server for local testing.

[@nammatham/core]: packages/core
[@nammatham/azure-functions]: packages/azure-functions
[@nammatham/express]: packages/express
[@nammatham/trpc-azure-functions]: packages/trpc-azure-functions


## Talks
Empowering TypeScript on Azure Functions with Nammatham, Azure Open Source Day @ Microsoft Thailand, 25 Mar 2023
[![](docs/imgs/azure-open-source-day-2023.png)](https://www.youtube.com/watch?v=n6B4-5Lt2h0) (Thai speech, subtitle will added later)
- Slides: https://docs.google.com/presentation/d/1WUIXaUxXaiixZ2bgGCfx-f4Gdrmjl4RfbwKaEfAC6t4/edit?usp=sharing


<!-- ## What's different with Azure Functions v4 (Official Library) -->

## Local Dev Setup

```bash
# Install dependencies
pnpm install
# Before dev (Update workspace to local dependencies)
pnpm pre-local && pnpm install
# While dev
pnpm dev
# After dev before submitting PRs (Update workspace to actual dependencies), `pnpm install` for making sure lockfile is correct.
pnpm post-local && pnpm install
# Release package
pnpm release
```

## Inspiration
- [Azure Functions .NET](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-cli-csharp?tabs=azure-cli%2Cin-process)
- [inversify-express-utils](https://github.com/inversify/inversify-express-utils) - We use inversify as a Dependency Injection Tool.
- [Nestjs](https://nestjs.com/)
- [typestack/routing-controllers](https://github.com/typestack/routing-controllers)
- [azure-middleware](https://github.com/emanuelcasco/azure-middleware) - Azure Functions Middleware Libray

## Author
- Thada Wangthammang, Software Engineer, Thailand
33 changes: 33 additions & 0 deletions packages/inversify/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"name": "@nammatham/inversify",
"version": "2.0.0-alpha.13",
"description": "Type-safe Serverless Library for Azure Functions and friends",
"main": "dist/main.js",
"types": "dist/main.d.ts",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"prepublishOnly": "npm run build",
"build": "tsup src/main.ts --dts",
"format": "prettier -w src",
"lint": "tsc --noEmit && eslint ./src && prettier -c src",
"lint:fix": "eslint --fix ./src && prettier -w src",
"dev": "nodemon --watch src --ext ts --exec 'npm run build'"
},
"keywords": [
"azure-functions",
"azure"
],
"author": "Thada Wangthammang",
"license": "MIT",
"dependencies": {
"@nammatham/core": "2.0.0-alpha.13",
"inversify": "^6.0.2"
},
"repository": {
"type": "git",
"url": "https://github.com/thaitype/nammatham.git"
},
"publishConfig": {
"registry": "https://registry.npmjs.org/"
}
}
1 change: 1 addition & 0 deletions packages/inversify/src/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './plugin';
14 changes: 14 additions & 0 deletions packages/inversify/src/plugin.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import type { Container, interfaces } from 'inversify';
import type { NammathamApp, BaseHandlerResolver } from '@nammatham/core';

export function inverisfyPlugin(options: {
container: Container;
services: interfaces.ServiceIdentifier[];
}): (app: NammathamApp, handlerResolver: BaseHandlerResolver) => void {
return (app: NammathamApp, handlerResolver: BaseHandlerResolver) => {
for (const service of options.services) {
const controller = options.container.get(service);
// app.addFunctions(controller, handlerResolver);
}
};
}
12 changes: 12 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d0413bf

Please sign in to comment.