Init commit

Author: MateuszDoboszSTX

.docker/Dockerfile

@@ -0,0 +1,23 @@
+FROM denoland/deno:1.15.3
+
+# The port that your application listens to.
+EXPOSE 1337
+
+WORKDIR /app
+
+# Prefer not to run as root.
+USER deno
+
+# Cache the dependencies as a layer (the following two steps are re-run only when deps.ts is modified).
+# Ideally cache deps.ts will download and compile _all_ external files used in main.ts.
+COPY import_map.json .
+COPY deps_lock.json .
+
+# These steps will be re-run upon each file change in your working directory:
+COPY ./src ./src
+COPY ./migrations ./migrations
+
+# Compile the main app so that it doesn't need to be compiled each startup/entry.
+RUN deno cache --lock=deps_lock.json --import-map=import_map.json ./src/index.ts
+
+CMD ["run", "--allow-net", "--allow-env", "./src/index.ts"]

.env.example

@@ -0,0 +1,18 @@
+# -- Server --
+PORT=1337
+
+# -- Database --
+POSTGRES_HOSTNAME=postgres
+POSTGRES_DB=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_USER=postgres
+POSTGRES_POOL_SIZE=10
+POSTGRES_MIGRATIONS_TABLE_NAME=migrations
+
+# -- LOG LEVEL --
+# DEBUG = 0
+# INFO = 1
+# WARNING = 2
+# ERROR = 3
+# CRITICAL = 4
+LOG_LEVEL=0

.gitignore

@@ -0,0 +1 @@
+.env

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "deno.enable": true,
+  "deno.lint": true,
+  "deno.unstable": true,
+  "deno.importMap": "import_map.json",
+  "deno.suggest.imports.hosts": {
+    "https://deno.land": false
+  }
+}

README.md

@@ -0,0 +1,71 @@
+# Deno starter API
+
+- Added PostgreSQL db driver with ORM => https://deno.land/x/[email protected]
+- validation to endpoints
+- import_maps
+- dockerized
+
+
+## Install
+
+Copy .env.example as .env in root directory.
+
+Run ``./scripts/build-docker-image-local.sh `` to build docker image.
+
+
+Run ``docker-compose up api`` to run Deno.
+
+
+Run ``docker-compose up watch`` to run Deno in watch mode.
+
+
+Tip: For Apple M1 users for Deno watch mode we need to change in Dockerfile:
+
+``FROM denoland/deno:1.15.3``
+
+to this:
+
+``FROM lukechannings/deno:latest``
+
+ and to docker-compose ``platform: linux/amd64``: 
+
+``    
+services:
+  watch:
+    image: api:local
+    hostname: api
+    platform: linux/amd64
+    volumes:
+    ...
+``
+
+
+## Migrations
+
+Migrations are in `` migrations `` folder. 
+
+Syntax for class names is like in TypeORM:
+
+File `` 20220124110458-init.ts `` then class should be named `` Init20220124110458 `` :
+File `` 20220130024421-fixes_on_post_users.ts `` then class should be named `` Fixes_on_post_users20220130024421 `` :
+
+Files to migration folder we add manually.
+
+"down" method is not supported yet.
+
+Example migration file: 
+
+``
+import { Model } from "denodb";
+
+export class Init20220124110458 {
+
+    async up(client: any): Promise<void> {
+        await client.queryObject(`SELECT * FROM "migrations"`);
+    }
+
+    async down(client: any): Promise<void> {
+        await client.queryObject(`SELECT * FROM "migrations"`);
+    }
+}
+``

deps_lock.json

@@ -0,0 +1,54 @@
+version: "3.1"
+
+services:
+  watch:
+    image: api:local
+    hostname: api
+    volumes:
+      - ./src:/app/src:ro
+      - ./migrations:/app/migrations:ro
+      - ./import_map.json:/app/import_map.json:ro
+      - ./deps_lock.json:/app/deps_lock.json:ro
+    ports:
+      - 1337:1337
+    command: "run --watch -A --importmap import_map.json ./src/index.ts"
+    env_file:
+      - .env
+    depends_on:
+      - postgres
+      - adminer # its optional, but good for development
+
+  api:
+    image: api:local
+    hostname: api
+    volumes:
+      - ./src:/app/src:ro
+      - ./migrations:/app/migrations:ro
+      - ./import_map.json:/app/import_map.json:ro
+      - ./deps_lock.json:/app/deps_lock.json:ro
+    ports:
+      - 1337:1337
+    command: "run -A --importmap import_map.json ./src/index.ts"
+    env_file:
+      - .env
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:14-alpine
+    hostname: postgres
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_USER=postgres
+    volumes:
+      - db:/var/lib/postgresql/data
+
+  adminer:
+    hostname: adminer
+    image: adminer
+    ports:
+      - 8080:8080
+
+volumes:
+  db:

docker-compose.yml

@@ -0,0 +1,9 @@
+{
+  "imports": {
+    "oak": "https://deno.land/x/[email protected]/mod.ts",
+    "ansi_styles": "https://deno.land/x/[email protected]/mod.ts",
+    "http_status": "https://deno.land/x/[email protected]/mod.ts",
+    "dex": "https://deno.land/x/[email protected]/mod.ts",
+    "denodb": "https://deno.land/x/[email protected]/mod.ts"
+  }
+}

import_map.json

@@ -0,0 +1,23 @@
+import { Model } from "denodb";
+
+export class Init20220124110458 {
+
+    async up(client: any): Promise<void> {
+        await client.queryObject(`DROP TABLE IF EXISTS "users";`);
+
+        await client.queryObject(`DROP SEQUENCE IF EXISTS users_id_seq;`);
+
+        await client.queryObject(`CREATE SEQUENCE users_id_seq INCREMENT 1 MINVALUE 1 MAXVALUE 2147483647 CACHE 1;`);
+        await client.queryObject(`CREATE TABLE "public"."users" (
+            "id" integer DEFAULT nextval('users_id_seq') NOT NULL,
+            "username" character varying(128) NOT NULL,
+            "email" character varying(128) NOT NULL,
+            CONSTRAINT "users_email" UNIQUE ("email"),
+            CONSTRAINT "users_pkey" PRIMARY KEY ("id"),
+            CONSTRAINT "users_username" UNIQUE ("username")
+        ) WITH (oids = false);`);
+    }
+
+    async down(client: any): Promise<void> {
+    }
+}

migrations/20220124110458-init.ts

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://deno.land/x/[email protected]/schema.json",
+  "importmap": "import_map.json",
+  "watch": false,
+  "scripts": {
+    "docker:build-image": {
+      "cmd": "bash ./scripts/build-docker-image-local.sh",
+      "desc": "Build docker images"
+    },
+    "docker:watch": {
+      "cmd": "docker-compose up watch",
+      "desc": "Start api in watch mode"
+    },
+    "docker:start": {
+      "cmd": "docker-compose up api",
+      "desc": "Start api"
+    }
+  }
+}

scripts.json

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+IMAGE="api"
+TAG="local"
+
+# Remove image to reduce dangling images
+docker image rm $IMAGE:$TAG
+
+docker build -f $PWD/.docker/Dockerfile -t $IMAGE:$TAG --force-rm .

scripts/build-docker-image-local.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+: '
+Copyright © 2021 Kamide.re Laboratory
+
+License: MIT https://mit-license.org
+
+Permission is hereby granted, free of charge, to any 
+person obtaining a copy of this software and associated 
+documentation files (the “Software”), to deal in 
+the Software without restriction, including without limitation 
+the rights to use, copy, modify, merge, publish, distribute, 
+sublicense, and/or sell copies of the Software, 
+and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice 
+shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
+OTHER DEALINGS IN THE SOFTWARE.
+'
+
+TZ="Europe/Warsaw"
+
+timestamp=`date +"%s"`
+fileName=$@
+
+date=`date +"%F"`
+
+echo "## Date: ${date}
+***
+## Context:
+example 
+***
+## Options:
+  -
+***
+## Decision:" >> "${PWD}/adr/${timestamp}-${fileName// /-}.md"
+

scripts/generate-adr.sh

@@ -0,0 +1,19 @@
+import { Context } from "oak";
+import { AppState } from "../../../types/state.ts";
+import { CreateToDoRequest } from "../types/create-todo.request.ts";
+import { CreateToDoCase } from "../use-cases/create-todo.case.ts";
+import { ToDoService } from "../services/todo.service.ts";
+
+export class CreateToDoController {
+  async handle(context: Context<AppState>) {
+    context.state.logger.debug("CreateUserController");
+    const body = (await context.request.body({ type: "json" })
+      .value) as CreateToDoRequest;
+    const user = await new CreateToDoCase(
+      context,
+      new ToDoService(context.state.databaseClient)
+    ).execute(body);
+    context.response.status = 201;
+    context.response.body = JSON.stringify(user);
+  }
+}

src/domain/todo/controllers/create-todo.controller.ts

@@ -0,0 +1,19 @@
+import { Context } from "oak";
+import { AppState } from "../../../types/state.ts";
+import { DeleteToDoCase } from "../use-cases/delete-todo.case.ts";
+import { ToDoService } from "../services/todo.service.ts";
+import { DeleteToDoRequest } from "../types/delete-todo.request.ts";
+
+export class DeleteToDoController {
+  async handle(context: Context<AppState>) {
+    context.state.logger.debug("DeleteToDoController");
+    const body = (await context.request.body({ type: "json" })
+      .value) as DeleteToDoRequest;
+    const response = await new DeleteToDoCase(
+      context,
+      new ToDoService(context.state.databaseClient)
+    ).execute(body);
+    context.response.status = 201;
+    context.response.body = JSON.stringify(response);
+  }
+}

src/domain/todo/controllers/delete-todo.controller.ts

@@ -0,0 +1,15 @@
+import { Context } from "oak";
+import { AppState } from "../../../types/state.ts";
+import { GetToDoCase } from "../use-cases/get-todos.case.ts";
+import { ToDoService } from "../services/todo.service.ts";
+
+export class GetToDosController {
+  async handle(context: Context<AppState>) {
+    context.state.logger.debug("GetToDoController");
+    const users = await new GetToDoCase(
+      context,
+      new ToDoService(context.state.databaseClient)
+    ).execute();
+    context.response.body = JSON.stringify(users);
+  }
+}

src/domain/todo/controllers/get-todos.controller.ts

@@ -0,0 +1,21 @@
+import { RouterContext, RouteParams } from "oak";
+import { AppState } from "../../../types/state.ts";
+import { UpdateToDoStatusCase } from "../use-cases/update-todo-status.case.ts";
+import { ToDoService } from "../services/todo.service.ts";
+import { UpdateToDoStatusRequest } from "../types/update-todo-status.request.ts";
+
+export class UpdateToDoStatusController {
+  async handle(context: RouterContext<RouteParams, AppState>) {
+    context.state.logger.debug("UpdateToDoStatusController");
+
+    const id = {
+      id: context?.params?.id,
+    } as UpdateToDoStatusRequest;
+    const todo = await new UpdateToDoStatusCase(
+      context,
+      new ToDoService(context.state.databaseClient)
+    ).execute(id);
+    context.response.status = 201;
+    context.response.body = JSON.stringify(todo);
+  }
+}

src/domain/todo/controllers/update-todo-status.controller.ts

@@ -0,0 +1,9 @@
+import { HttpError, Status } from "oak";
+
+export class ToDoNotFoundError extends HttpError {
+  public status: Status = Status.NotFound;
+
+  constructor() {
+    super("Todo not found");
+  }
+}

src/domain/todo/errors/todo-not-found.error.ts

@@ -0,0 +1,3 @@
+import { ToDoModel } from "./todo.model.ts";
+
+export default [ToDoModel];