From 1fea643e32ddab923e8e4f150308ae98befbc2ae Mon Sep 17 00:00:00 2001
From: Adrien Zaganelli <adrienzaganelli@gmail.com>
Date: Thu, 3 Oct 2024 14:39:27 +0200
Subject: [PATCH] refactor(plugin): moved ipInfo plugin in a separate file

---
 playground/app.vue                            |  3 +-
 src/runtime/core/README.md                    | 30 ------------
 src/runtime/core/core.ts                      |  7 +--
 src/runtime/core/plugins/ipInfoPlugin.ts      | 47 ++++++++++++++++++
 src/runtime/core/types.ts                     | 13 +++--
 src/runtime/database/lib/tables.ts            |  7 ---
 .../{lib => }/sqlite/schema.sqlite.ts         |  2 +-
 src/runtime/nuxt/defaults.ts                  |  2 +-
 src/runtime/server/utils/useSlipAuth.ts       | 48 +------------------
 9 files changed, 65 insertions(+), 94 deletions(-)
 delete mode 100644 src/runtime/core/README.md
 create mode 100644 src/runtime/core/plugins/ipInfoPlugin.ts
 delete mode 100644 src/runtime/database/lib/tables.ts
 rename src/runtime/database/{lib => }/sqlite/schema.sqlite.ts (97%)

diff --git a/playground/app.vue b/playground/app.vue
index 29b4578..160d906 100644
--- a/playground/app.vue
+++ b/playground/app.vue
@@ -1,4 +1,5 @@
-<script setup></script>
+<script setup lang="ts">
+</script>
 
 <template>
   <UContainer class="main-container min-h-screen flex flex-col">
diff --git a/src/runtime/core/README.md b/src/runtime/core/README.md
deleted file mode 100644
index 5caf15e..0000000
--- a/src/runtime/core/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# @slip/core
-
-> Slip auth core logic
-
-```shell
-pnpm install
-```
-### Tests
-
-```shell
-pnpm test
-```
-
-```typescript
-import sqlite from "db0/connectors/better-sqlite3";
-import { createDatabase } from "db0";
-
-const db = createDatabase(sqlite({}));
-const auth = new SlipAuthCore(
-  db,
-  {
-    users: "slip_users",
-    sessions: "slip_sessions",
-    oauthAccounts: "slip_oauth_accounts",
-  },
-  {
-    sessionMaxAge: 60 * 60 * 24 * 7, // 7 days
-  }
-);
-```
\ No newline at end of file
diff --git a/src/runtime/core/core.ts b/src/runtime/core/core.ts
index a683830..e539bba 100644
--- a/src/runtime/core/core.ts
+++ b/src/runtime/core/core.ts
@@ -1,5 +1,5 @@
 import { createChecker, type supportedConnectors } from "drizzle-schema-checker";
-import { getOAuthAccountsTableSchema, getSessionsTableSchema, getUsersTableSchema, getEmailVerificationCodesTableSchema, getPasswordResetTokensTableSchema } from "../database/lib/sqlite/schema.sqlite";
+import { getOAuthAccountsTableSchema, getSessionsTableSchema, getUsersTableSchema, getEmailVerificationCodesTableSchema, getPasswordResetTokensTableSchema } from "../database/sqlite/schema.sqlite";
 import { drizzle as drizzleIntegration } from "db0/integrations/drizzle/index";
 import type { ICreateOrLoginParams, ICreateUserParams, ILoginUserParams, IPasswordHashingMethods, ISlipAuthCoreOptions, SchemasMockValue, SlipAuthUser, tableNames } from "./types";
 import { createSlipHooks } from "./hooks";
@@ -226,10 +226,11 @@ export class SlipAuthCore {
   public async askEmailVerificationCode(user: SlipAuthUser): Promise<void> {
     await this.#repos.emailVerificationCodes.deleteAllByUserId(user.id);
     await this.#repos.emailVerificationCodes.insert(user.id, user.email, this.#createRandomEmailVerificationCode());
+    // send mail to user
   }
 
   // TODO: use transactions
-  // should recreate session if true
+  // TODO: rate limit
   public async verifyEmailVerificationCode(user: SlipAuthUser, code: string): Promise<boolean> {
     const databaseCode = await this.#repos.emailVerificationCodes.findByUserId(user.id);
     if (!databaseCode || databaseCode.code !== code) {
@@ -250,7 +251,7 @@ export class SlipAuthCore {
     }
 
     await this.#repos.users.updateEmailVerifiedByUserId(databaseCode.user_id, true);
-
+    // should recreate session if true
     return true;
   }
 
diff --git a/src/runtime/core/plugins/ipInfoPlugin.ts b/src/runtime/core/plugins/ipInfoPlugin.ts
new file mode 100644
index 0000000..cd33180
--- /dev/null
+++ b/src/runtime/core/plugins/ipInfoPlugin.ts
@@ -0,0 +1,47 @@
+import type { IPinfo } from "node-ipinfo";
+import { IPinfoWrapper, ApiLimitError } from "node-ipinfo";
+import net from "node:net";
+import fsDriver from "unstorage/drivers/fs";
+import { createStorage } from "unstorage";
+import type { SlipAuthCore } from "../core";
+
+export const setupIpInfoAddOn = (auth: SlipAuthCore, ipInfoToken: string) => {
+  const ipinfoWrapper = new IPinfoWrapper(ipInfoToken);
+  const cache = createStorage<IPinfo>({
+    driver: fsDriver({
+      base: "./.data/cache/ipinfo",
+    }),
+  });
+
+  auth.hooks.hook("sessions:create", async (session) => {
+    session.ip = "92.168.1.58";
+    if (!session.ip) {
+      return;
+    }
+    const ipType = net.isIP(session.ip);
+
+    if (ipType === 0) {
+      // valid cases are 4 and 6 (ipv)
+      return;
+    }
+
+    const cachedValue = await cache.getItem(session.ip);
+    if (cachedValue !== null) {
+      return;
+    }
+
+    try {
+      const response = await ipinfoWrapper.lookupIp(session.ip);
+      cache.setItem(session.ip, response);
+    }
+    catch (error) {
+      console.log(error);
+      if (error instanceof ApiLimitError) {
+        // handle api limit exceed error
+      }
+      else {
+        // handle other errors
+      }
+    }
+  });
+};
diff --git a/src/runtime/core/types.ts b/src/runtime/core/types.ts
index c9ff949..fcce2f5 100644
--- a/src/runtime/core/types.ts
+++ b/src/runtime/core/types.ts
@@ -1,8 +1,5 @@
 import type { SQLiteTable } from "drizzle-orm/sqlite-core";
-import { getOAuthAccountsTableSchema, getSessionsTableSchema, getUsersTableSchema, getEmailVerificationCodesTableSchema, getPasswordResetTokensTableSchema } from "../database/lib/sqlite/schema.sqlite";
-import type { tableNames } from "../database/lib/tables";
-
-export type { tableNames };
+import { getOAuthAccountsTableSchema, getSessionsTableSchema, getUsersTableSchema, getEmailVerificationCodesTableSchema, getPasswordResetTokensTableSchema } from "../database/sqlite/schema.sqlite";
 
 interface ISessionCreateMetada {
   ip?: string
@@ -78,3 +75,11 @@ const schemasMockValue = {
 } satisfies Record<keyof tableNames, SQLiteTable>;
 export type SchemasMockValue = typeof schemasMockValue;
 // #endregion
+
+export interface tableNames {
+  users: string
+  sessions: string
+  oauthAccounts: string
+  emailVerificationCodes: string
+  resetPasswordTokens: string
+}
diff --git a/src/runtime/database/lib/tables.ts b/src/runtime/database/lib/tables.ts
deleted file mode 100644
index e7411ff..0000000
--- a/src/runtime/database/lib/tables.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-export interface tableNames {
-  users: string
-  sessions: string
-  oauthAccounts: string
-  emailVerificationCodes: string
-  resetPasswordTokens: string
-}
diff --git a/src/runtime/database/lib/sqlite/schema.sqlite.ts b/src/runtime/database/sqlite/schema.sqlite.ts
similarity index 97%
rename from src/runtime/database/lib/sqlite/schema.sqlite.ts
rename to src/runtime/database/sqlite/schema.sqlite.ts
index c8662b4..afe2738 100644
--- a/src/runtime/database/lib/sqlite/schema.sqlite.ts
+++ b/src/runtime/database/sqlite/schema.sqlite.ts
@@ -1,5 +1,5 @@
 import { sqliteTable, text, integer, primaryKey } from "drizzle-orm/sqlite-core";
-import type { tableNames } from "../tables";
+import type { tableNames } from "../../core/types";
 import { sql } from "drizzle-orm";
 
 const datesColumns = {
diff --git a/src/runtime/nuxt/defaults.ts b/src/runtime/nuxt/defaults.ts
index 44383ae..476070f 100644
--- a/src/runtime/nuxt/defaults.ts
+++ b/src/runtime/nuxt/defaults.ts
@@ -1,4 +1,4 @@
-import type { tableNames } from "../database/lib/tables";
+import type { tableNames } from "../core/types";
 
 export const defaultTableNames: tableNames = {
   sessions: "slip_auth_sessions",
diff --git a/src/runtime/server/utils/useSlipAuth.ts b/src/runtime/server/utils/useSlipAuth.ts
index 05ef0cb..80b2471 100644
--- a/src/runtime/server/utils/useSlipAuth.ts
+++ b/src/runtime/server/utils/useSlipAuth.ts
@@ -4,11 +4,7 @@ import {
   // @ts-expect-error useDatabase is not enabled by default
   useDatabase,
 } from "#imports";
-import type { IPinfo } from "node-ipinfo";
-import { IPinfoWrapper, ApiLimitError } from "node-ipinfo";
-import net from "node:net";
-import fsDriver from "unstorage/drivers/fs";
-import { createStorage } from "unstorage";
+import { setupIpInfoAddOn } from "../../core/plugins/ipInfoPlugin";
 
 let instance: SlipAuthCore;
 
@@ -28,45 +24,3 @@ export function useSlipAuth() {
 
   return instance;
 }
-
-// TODO: build a plugin system
-const setupIpInfoAddOn = (auth: SlipAuthCore, ipInfoToken: string) => {
-  const ipinfoWrapper = new IPinfoWrapper(ipInfoToken);
-  const cache = createStorage<IPinfo>({
-    driver: fsDriver({
-      base: "./.data/cache/ipinfo",
-    }),
-  });
-
-  auth.hooks.hook("sessions:create", async (session) => {
-    session.ip = "92.168.1.58";
-    if (!session.ip) {
-      return;
-    }
-    const ipType = net.isIP(session.ip);
-
-    if (ipType === 0) {
-      // valid cases are 4 and 6 (ipv)
-      return;
-    }
-
-    const cachedValue = await cache.getItem(session.ip);
-    if (cachedValue !== null) {
-      return;
-    }
-
-    try {
-      const response = await ipinfoWrapper.lookupIp(session.ip);
-      cache.setItem(session.ip, response);
-    }
-    catch (error) {
-      console.log(error);
-      if (error instanceof ApiLimitError) {
-        // handle api limit exceed error
-      }
-      else {
-        // handle other errors
-      }
-    }
-  });
-};