Update to work with Deno 1.3.1

Also add a migration for an Admin user Also added the env file
giggio-samples · Aug 23, 2020 · a66ba95 · a66ba95
1 parent 043ed21
commit a66ba95
Show file tree

Hide file tree

Showing 20 changed files with 67 additions and 45 deletions.
diff --git a/.env.example → .env b/.env.example → .env
@@ -1,5 +1,5 @@
 DB_NAME=deno_api_db
-DB_HOST=db
+DB_HOST=localhost
 DB_PASS=example
 DB_USER=root
 ENV=dev
@@ -8,5 +8,5 @@ ENV=dev
 JWT_ACCESS_TOKEN_EXP=600000
 # Refresh token validity in ms
 JWT_REFRESH_TOKEN_EXP=3600000
-# Secret secuirity string
+# Secret security string
 JWT_TOKEN_SECRET=HEGbulKGDblAFYskBLml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,13 @@
+{
+  "debug.javascript.usePreview": false,
+  "deno.enable": true,
+  "deno.unstable": true,
+  "[typescript]": {
+    "editor.defaultFormatter": "denoland.vscode-deno"
+  },
+  "vsicons.presets.angular": false,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+  }
+}
diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ We can run the project **with/ without Docker**.
         - docker-compose installed.
     - To run API server without Docker we need
         - MySQL server running &
+          - You can run it with Docker by running: `docker run --name deno-sample-mysql -e MYSQL_ROOT_PASSWORD=example -e MYSQL_DATABASE=deno_api_db -d -p 3306:3306 mysql --default-authentication-plugin=mysql_native_password`
         - Deno run time installed
 - **Configuration**
     - In application root, rename example env file `env.example` to `.env`.
@@ -62,26 +63,26 @@ We use [nessie](https://deno.land/x/nessie) to manage database migration.
 - In the application root, we have `nessie.config.ts`. Make sure to update this with the DB credentials. 
 - Run the following command to run the migration. Migration should create necessary tables and dump the data.
 ```
-$ deno run --allow-net --allow-read --allow-write https://deno.land/x/nessie@v1.0.0-rc3/cli.ts migrate
+$ deno run --allow-net --allow-read --allow-write https://deno.land/x/nessie@v1.0.4/cli.ts migrate
 ```
 
 With this, the user table would be created and the table would be seeded with fake data
 
 - Further, to add new migration, for example, to create new product table run
 ```
-deno run --allow-net --allow-read --allow-write https://deno.land/x/nessie@v1.0.0-rc3/cli.ts make create_product
+deno run --allow-net --allow-read --allow-write https://deno.land/x/nessie@v1.0.4/cli.ts make create_product
 ```
 
 ## Modules
 
 
 | Package  | Purpose |
 | ---------|---------|
-|[oak@v5.0.0](https://deno.land/x/oak@v5.0.0)| Deno middleware framework|
+|[oak@v6.0.2](https://deno.land/x/oak@v6.0.2)| Deno middleware framework|
 |[dotenv@v0.4.2](https://deno.land/x/dotenv@v0.4.2)| Read env variables|
 |[mysql@2.2.0](https://deno.land/x/mysql@2.2.0)|MySQL driver for Deno|
-|[nessie@v1.0.0-rc3](https://deno.land/x/nessie@v1.0.0-rc3)| DB migration tool for Deno|
-|[validasaur@v0.7.0](https://deno.land/x/validasaur@v0.7.0)| validation library|
+|[nessie@v1.0.4](https://deno.land/x/nessie@v1.0.4)| DB migration tool for Deno|
+|[validasaur@v0.14.0](https://deno.land/x/validasaur@v0.14.0)| validation library|
 |[djwt@v0.9.0](https://deno.land/x/djwt@v0.9.0)| JWT token encoding|
 |[bcrypt@v0.2.1](https://deno.land/x/bcrypt@v0.2.1)| bcrypt encription lib|
 
@@ -143,14 +144,14 @@ deno run --allow-net --allow-read --allow-write https://deno.land/x/nessie@v1.0.
     ```
 
 ## How to validate request body
-- Here we used [validasaur@v0.7.0](https://deno.land/x/validasaur@v0.7.0) module for validating forms or request body. List of available rules can be found [here](https://deno.land/x/validasaur@v0.7.0/#available-rules) 
+- Here we used [validasaur@v0.14.0](https://deno.land/x/validasaur@v0.14.0) module for validating forms or request body. List of available rules can be found [here](https://deno.land/x/validasaur@v0.14.0/#available-rules) 
 - [requestValidator](./middlewares/request-validator.middleware.ts) middleware added to validate the request body.
 ```
 //auth.routes.ts
 import {
   required,
   isEmail,
-} from "https://deno.land/x/validasaur@v0.7.0/src/rules.ts";
+} from "https://deno.land/x/validasaur@v0.14.0/src/rules.ts";
 
 import { requestValidator } from "./../middlewares/request-validator.middleware.ts";
 

diff --git a/app.ts b/app.ts
@@ -1,4 +1,4 @@
-import { Application } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { Application } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import * as middlewares from "./middlewares/middlewares.ts";
 import { oakCors } from "https://deno.land/x/cors/mod.ts";
 import { router } from "./routes/routes.ts";

diff --git a/db/db.ts b/db/db.ts
@@ -1,4 +1,4 @@
-import { Client } from "https://deno.land/x/mysql@2.2.0/mod.ts";
+import { Client } from "https://deno.land/x/mysql@v2.4.0/mod.ts";
 import { config } from "./../config/config.ts";
 
 const port = config.DB_PORT ? parseInt(config.DB_PORT || "") : undefined;

diff --git a/db/migrations/1591637345959-create-user.ts b/db/migrations/1591637345959-create-user.ts
@@ -1,7 +1,7 @@
 import {
   Migration,
-} from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
-import { Schema } from "https://deno.land/x/nessie@v1.0.0-rc3/qb.ts";
+} from "https://deno.land/x/nessie@v1.0.4/mod.ts";
+import { Schema } from "https://deno.land/x/nessie@v1.0.4/qb.ts";
 
 /** Runs on migrate */
 export const up: Migration<Schema> = ({ queryBuilder }) => {

diff --git a/db/migrations/1591638037132-update-user-email.ts b/db/migrations/1591638037132-update-user-email.ts
@@ -1,5 +1,4 @@
-import { Migration } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
-import { Schema } from "https://deno.land/x/nessie@v1.0.0-rc3/qb.ts";
+import { Migration } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
 
 /** Runs on migrate */
 export const up: Migration = () => {

diff --git a/db/migrations/1591773649203-update-user-password.ts b/db/migrations/1591773649203-update-user-password.ts
@@ -1,4 +1,4 @@
-import { Migration } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
+import { Migration } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
 
 /** Runs on migrate */
 export const up: Migration = () => {

diff --git a/db/migrations/1592058407065-update-user-roles.ts b/db/migrations/1592058407065-update-user-roles.ts
@@ -1,4 +1,4 @@
-import { Migration } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
+import { Migration } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
 
 /** Runs on migrate */
 export const up: Migration = () => {

diff --git a/db/seeds/create-admin.ts b/db/seeds/create-admin.ts
@@ -0,0 +1,8 @@
+import { Seed } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
+import * as encription from "../../helpers/encription.ts";
+
+export const run: Seed = async () => {
+  const password = await encription.encript("123456");
+  return `INSERT into users VALUES
+    (DEFAULT, 'João da Silva', 'joaodasilva@example.com', 'Admin', '${password}', 1, DEFAULT, DEFAULT)`;
+};
diff --git a/middlewares/error.middleware.ts b/middlewares/error.middleware.ts
@@ -1,7 +1,7 @@
 import {
   isHttpError,
   Status,
-} from "https://deno.land/x/oak@v5.0.0/mod.ts";
+} from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { config } from "./../config/config.ts";
 import { Context } from "./../types.ts";
 

diff --git a/middlewares/request-validator.middleware.ts b/middlewares/request-validator.middleware.ts
@@ -1,9 +1,9 @@
 import {
-  validate,
   ValidationErrors,
   ValidationRules,
-} from "https://deno.land/x/validasaur@v0.7.0/src/mod.ts";
-import { httpErrors } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+} from "https://deno.land/x/validasaur@v0.14.0/src/interfaces.ts";
+import { validate } from "https://deno.land/x/validasaur@v0.14.0/src/validate.ts";
+import { httpErrors } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { Context } from "./../types.ts";
 
 /**
@@ -28,14 +28,15 @@ const requestValidator = ({ bodyRules }: { bodyRules: ValidationRules }) => {
   return async (ctx: Context, next: () => Promise<void>) => {
     /** get request body */
     const request = ctx.request;
-    const body = (await request.body()).value;
-
-    /** check rules */
-    const [isValid, errors] = await validate(body, bodyRules);
-    if (!isValid) {
-      /** if error found, throw bad request error */
-      const message = getErrorMessage(errors);
-      throw new httpErrors.BadRequest(message);
+    const body = await request.body().value;
+    if (body != null) {
+      /** check rules */
+      const [isValid, errors] = await validate(body, bodyRules);
+      if (!isValid) {
+        /** if error found, throw bad request error */
+        const message = getErrorMessage(errors);
+        throw new httpErrors.BadRequest(message);
+      }
     }
 
     await next();

diff --git a/middlewares/user-guard.middleware.ts b/middlewares/user-guard.middleware.ts
@@ -1,4 +1,4 @@
-import { httpErrors } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { httpErrors } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { Context, UserRole } from "./../types.ts";
 import { hasUserRole } from "../helpers/roles.ts";
 

diff --git a/nessie.config.ts b/nessie.config.ts
@@ -1,6 +1,6 @@
-import { ClientPostgreSQL } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
-import { ClientMySQL } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
-import { ClientSQLite } from "https://deno.land/x/nessie@v1.0.0-rc3/mod.ts";
+import { ClientPostgreSQL } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
+import { ClientMySQL } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
+import { ClientSQLite } from "https://deno.land/x/nessie@v1.0.4/mod.ts";
 
 /** These are the default config options. */
 const clientOptions = {
@@ -12,7 +12,7 @@ const clientMySql = new ClientMySQL(clientOptions, {
   hostname: "localhost",
   port: 3306,
   username: "root",
-  password: "example", // uncomment this line for <8
+  password: "example",
   db: "deno_api_db",
 });
 

diff --git a/routes/auth.routes.ts b/routes/auth.routes.ts
@@ -8,7 +8,7 @@ import {
   required,
   isEmail,
   lengthBetween,
-} from "https://deno.land/x/validasaur@v0.7.0/src/rules.ts";
+} from "https://deno.land/x/validasaur@v0.14.0/src/rules.ts";
 
 import * as authService from "./../services/auth.service.ts";
 import { requestValidator } from "./../middlewares/request-validator.middleware.ts";
@@ -34,7 +34,7 @@ const register = [
   /** router handler */
   async (ctx: Context) => {
     const request = ctx.request;
-    const userData = (await request.body()).value as CreateUser;
+    const userData = await request.body().value as CreateUser;
     const user = await authService.registerUser(userData);
     ctx.response.body = user;
   },
@@ -55,7 +55,7 @@ const login = [
   /** router handler */
   async (ctx: Context) => {
     const request = ctx.request;
-    const credential = (await request.body()).value as LoginCredential;
+    const credential = await request.body().value as LoginCredential;
     const token = await authService.loginUser(credential);
     ctx.response.body = token;
   },
@@ -70,7 +70,7 @@ const refreshToken = [
   /** router handler */
   async (ctx: Context) => {
     const request = ctx.request;
-    const data = (await request.body()).value as RefreshToken;
+    const data = await request.body().value as RefreshToken;
 
     const token = await authService.refreshToken(
       data["refresh_token"],

diff --git a/routes/routes.ts b/routes/routes.ts
@@ -1,4 +1,4 @@
-import { Router } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { Router } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { Context } from "./../types.ts";
 
 import * as authRoutes from "./auth.routes.ts";

diff --git a/routes/user.routes.ts b/routes/user.routes.ts
@@ -2,11 +2,11 @@ import {
   helpers,
   Status,
   httpErrors,
-} from "https://deno.land/x/oak@v5.0.0/mod.ts";
+} from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import {
   required,
   isEmail,
-} from "https://deno.land/x/validasaur@v0.7.0/src/rules.ts";
+} from "https://deno.land/x/validasaur@v0.14.0/src/rules.ts";
 import * as userService from "./../services/user.service.ts";
 import { requestValidator, userGuard } from "./../middlewares/middlewares.ts";
 import { Context, UserRole } from "./../types.ts";
@@ -63,7 +63,7 @@ const updateUser = [
     if (authUser) {
       if (id === authUser.id || hasUserRole(authUser, UserRole.ADMIN)) {
         const request = ctx.request;
-        const userData = (await request.body()).value;
+        const userData = await request.body().value;
         const user = await userService.updateUser(+id, userData);
         ctx.response.body = user;
         return;

diff --git a/services/auth.service.ts b/services/auth.service.ts
@@ -1,5 +1,5 @@
 import * as userRepo from "./../repositories/user.repository.ts";
-import { httpErrors } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { httpErrors } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import * as encription from "../helpers/encription.ts";
 import * as jwt from "../helpers/jwt.ts";
 import {

diff --git a/services/user.service.ts b/services/user.service.ts
@@ -1,5 +1,5 @@
 import * as userRepo from "./../repositories/user.repository.ts";
-import { httpErrors } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { httpErrors } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { encript } from "../helpers/encription.ts";
 
 /**

diff --git a/types/core/context.ts b/types/core/context.ts
@@ -1,4 +1,4 @@
-import { Context as OakContext } from "https://deno.land/x/oak@v5.0.0/mod.ts";
+import { Context as OakContext } from "https://deno.land/x/oak@v6.0.2/mod.ts";
 import { AuthUser } from "./../auth/auth-user.ts";
 
 /**