feat: allow customizing CasbinRuleTable by providing optional argument (#30)

nagaozen · web-flow · commit 514ab2a17f6e · 2025-02-14T22:18:51.000+08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,18 +32,17 @@ jobs:
       - run: npm test -t pg-adapter
   mysql_and_mysql2:
     runs-on: ubuntu-latest
-
     services:
       mysql:
-        image: bitnami/mysql
+        image: bitnami/mysql:5.7
         ports:
           - 3306:3306
         env:
+          ALLOW_EMPTY_PASSWORD: yes
           MYSQL_DATABASE: casbin
-          MYSQL_ROOT_PASSWORD: password
-          MYSQL_AUTHENTICATION_PLUGIN: mysql_native_password
+          MYSQL_USER: casbin
+          MYSQL_PASSWORD: password
         options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
-
     steps:
       - uses: actions/checkout@v2
       - run: npm i
@@ -59,15 +58,22 @@ jobs:
       - run: npm test -t sqlite3-adapter
 
   mssql:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
+      - name: Install SQLCMD Tools
+        run: |
+          curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
+          curl https://packages.microsoft.com/config/ubuntu/20.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list
+          sudo apt-get update
+          sudo ACCEPT_EULA=Y apt-get install -y mssql-tools unixodbc-dev
+          echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> $GITHUB_ENV
       - name: run sqlserver
         env:
           SA_PASSWORD: Passw0rd
         run: |
-          docker run --name sqlserver -it -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD='$SA_PASSWORD'' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2017-latest
+          docker run --name sqlserver -it -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD='$SA_PASSWORD'' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2022-latest
           echo 'awaiting sqlserver bootup' && sleep 15
-          sqlcmd -S 127.0.0.1 -U sa -P $SA_PASSWORD -Q 'CREATE DATABASE casbin'
+          sqlcmd -C -S 127.0.0.1 -U sa -P $SA_PASSWORD -No -Q 'CREATE DATABASE casbin'
       - uses: actions/checkout@v2
       - run: npm i
       - run: npm test -t mssql-adapter
diff --git a/README.md b/README.md
@@ -59,6 +59,66 @@ async function myFunction() {
   await e.savePolicy();
 ```
 
+## Custom Table Name Example
+
+By default, each adapter creates its own table in the database. While this might seem convenient, it poses a significant drawback when multiple adapters need to share the same database: policies cannot be shared across adapters if they are stored in separate tables.
+
+### Why Customization is Important
+
+**Compliance with Naming Conventions:**
+Many production databases follow strict naming conventions. By customizing the table name, you can ensure that your adapter’s tables comply with these conventions, which is essential for production environments.
+
+**Shared Policies:**
+When the same set of policies should be accessible by different adapters or services, having them in separate tables prevents a unified view. Customizing the table name allows you to consolidate policies into a single table that can be shared across adapters.
+
+**Avoiding Duplication:**
+If each adapter creates its own table by default, it can lead to unnecessary duplication of data. This not only wastes storage space but can also lead to inconsistent policy enforcement across different parts of your application.
+
+**Simplified Management:**
+With a single, customized table for all policies, managing, updating, and querying policy data becomes much easier. This is especially beneficial in environments where policies need to be audited or maintained centrally.
+
+### How to Customize the Table Name
+
+Most adapters offer a configuration option to set the table name explicitly. For example:
+
+```ts
+import { newEnforcer } from 'casbin';
+import { ConnectionPool } from 'mssql';
+import { BasicAdapter } from 'casbin-basic-adapter';
+
+const tableName = 'dbo.policies'// instead of the default 'casbin_rule'
+
+async function myFunction() {
+  const a = await BasicAdapter.newAdapter('mssql',
+    new ConnectionPool({
+      server: 'localhost',
+      port: 1433,
+      user: 'usr',
+      password: 'pwd',
+      database: 'casbin',
+      options: {
+        encrypt: true,
+        trustServerCertificate: true,
+      },
+    }),
+    tableName
+  );
+
+  const e = await newEnforcer('examples/rbac_model.conf', a);
+
+  // Check the permission.
+  e.enforce('alice', 'data1', 'read');
+
+  // Modify the policy.
+  // await e.addPolicy(...);
+  // await e.removePolicy(...);
+
+  // Save the policy back to DB.
+  await e.savePolicy();
+```
+
+By setting the `tableName` option, you ensure that all adapters point to the same table, enabling seamless policy sharing and compliance with any required naming conventions.
+
 ## Getting Help
 
 - [Node-Casbin](https://github.com/casbin/node-casbin)
diff --git a/src/adapter.ts b/src/adapter.ts
@@ -35,15 +35,18 @@ export type Instance = {
   mssql: mssql.ConnectionPool;
 };
 
-const CasbinRuleTable = 'casbin_rule';
-
 export class BasicAdapter<T extends keyof Instance> implements Adapter {
   private knex: Knex.Knex;
   private config: Config;
   private drive: T;
   private client: Instance[T];
+  private tableName: string;
 
-  private constructor(drive: T, client: Instance[T]) {
+  private constructor(
+    drive: T,
+    client: Instance[T],
+    tableName: string = 'casbin_rule',
+  ) {
     this.config = {
       client: drive,
       useNullAsDefault: drive === 'sqlite3',
@@ -52,13 +55,15 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
     this.knex = Knex.knex(this.config);
     this.drive = drive;
     this.client = client;
+    this.tableName = tableName;
   }
 
   static async newAdapter<T extends keyof Instance>(
     drive: T,
     client: Instance[T],
+    tableName: string = 'casbin_rule',
   ): Promise<BasicAdapter<T>> {
-    const a = new BasicAdapter(drive, client);
+    const a = new BasicAdapter(drive, client, tableName);
     await a.connect();
     await a.createTable();
 
@@ -67,7 +72,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
 
   async loadPolicy(model: Model): Promise<void> {
     const result = await this.query(
-      this.knex.select().from(CasbinRuleTable).toQuery(),
+      this.knex.select().from(this.tableName).toQuery(),
     );
 
     for (const line of result) {
@@ -76,7 +81,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
   }
 
   async savePolicy(model: Model): Promise<boolean> {
-    await this.query(this.knex.del().from(CasbinRuleTable).toQuery());
+    await this.query(this.knex.del().from(this.tableName).toQuery());
 
     let astMap = model.model.get('p')!;
     const processes: Array<Promise<CasbinRule[]>> = [];
@@ -85,7 +90,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
       for (const rule of ast.policy) {
         const line = this.savePolicyLine(ptype, rule);
         const p = this.query(
-          this.knex.insert(line).into(CasbinRuleTable).toQuery(),
+          this.knex.insert(line).into(this.tableName).toQuery(),
         );
         processes.push(p);
       }
@@ -96,7 +101,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
       for (const rule of ast.policy) {
         const line = this.savePolicyLine(ptype, rule);
         const p = this.query(
-          this.knex.insert(line).into(CasbinRuleTable).toQuery(),
+          this.knex.insert(line).into(this.tableName).toQuery(),
         );
         processes.push(p);
       }
@@ -109,7 +114,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
 
   async addPolicy(sec: string, ptype: string, rule: string[]): Promise<void> {
     const line = this.savePolicyLine(ptype, rule);
-    await this.query(this.knex.insert(line).into(CasbinRuleTable).toQuery());
+    await this.query(this.knex.insert(line).into(this.tableName).toQuery());
   }
 
   async addPolicies(
@@ -121,7 +126,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
     for (const rule of rules) {
       const line = this.savePolicyLine(ptype, rule);
       const p = this.query(
-        this.knex.insert(line).into(CasbinRuleTable).toQuery(),
+        this.knex.insert(line).into(this.tableName).toQuery(),
       );
       processes.push(p);
     }
@@ -136,7 +141,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
   ): Promise<void> {
     const line = this.savePolicyLine(ptype, rule);
     await this.query(
-      this.knex.del().where(line).from(CasbinRuleTable).toQuery(),
+      this.knex.del().where(line).from(this.tableName).toQuery(),
     );
   }
 
@@ -149,7 +154,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
     for (const rule of rules) {
       const line = this.savePolicyLine(ptype, rule);
       const p = this.query(
-        this.knex.del().where(line).from(CasbinRuleTable).toQuery(),
+        this.knex.del().where(line).from(this.tableName).toQuery(),
       );
       processes.push(p);
     }
@@ -186,7 +191,7 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
     }
 
     await this.query(
-      this.knex.del().where(line).from(CasbinRuleTable).toQuery(),
+      this.knex.del().where(line).from(this.tableName).toQuery(),
     );
   }
 
@@ -264,13 +269,13 @@ export class BasicAdapter<T extends keyof Instance> implements Adapter {
 
   private async createTable(): Promise<void> {
     const tableExists = await this.query(
-      this.knex.schema.hasTable(CasbinRuleTable).toString(),
+      this.knex.schema.hasTable(this.tableName).toString(),
     );
 
     if (tableExists.length > 0) return;
 
     const createTableSQL = this.knex.schema
-      .createTable(CasbinRuleTable, (table) => {
+      .createTable(this.tableName, (table) => {
         table.increments();
         table.string('ptype').notNullable();
         for (const i of ['v0', 'v1', 'v2', 'v3', 'v4', 'v5']) {
diff --git a/test/docker-compose.yml b/test/docker-compose.yml
@@ -1,7 +1,7 @@
 version: '3.8'
 services:
   mysql:
-    image: mysql:5
+    image: bitnami/mysql:5.7
     environment:
       MYSQL_ROOT_PASSWORD: password
       MYSQL_DATABASE: casbin
@@ -20,7 +20,7 @@ services:
     expose:
       - '5432'
   mssql:
-    image: mcr.microsoft.com/azure-sql-edge
+    image: mcr.microsoft.com/mssql/server:2022-latest
     environment:
       SA_PASSWORD: Passw0rd
       ACCEPT_EULA: Y
diff --git a/test/mysql-adapter.test.ts b/test/mysql-adapter.test.ts
@@ -20,7 +20,7 @@ test(
   Runner(
     'mysql',
     createConnection({
-      user: 'root',
+      user: 'casbin',
       password: 'password',
       database: 'casbin',
     }),
diff --git a/test/mysql2-adapter.test.ts b/test/mysql2-adapter.test.ts
@@ -20,7 +20,7 @@ test(
   Runner(
     'mysql2',
     createConnection({
-      user: 'root',
+      user: 'casbin',
       password: 'password',
       database: 'casbin',
     }),
