Merge pull request #6 from scalio/fix/buckets-config

fix(couchbase): added defaultBucket, buckets and connection with password

Author: michaelyali

README.md

@@ -7,6 +7,7 @@
 </p>
 
 &nbsp;
+
 ## Installation
 
 ```bash
@@ -28,7 +29,7 @@ export class Cat {
 }
 ```
 
-Where `cats` is the Couchbase bucket name.
+Where `cats` is the Couchbase bucket name (optional).
 
 Then, we need to import `CouchbaseModule` in our root `AppModule`:
 
@@ -42,7 +43,16 @@ import { CouchbaseModule } from '@scalio-oss/nest-couchbase';
       url: 'couchbase://127.0.0.1',
       username: 'couchbase',
       password: 'couchbase',
-      bucket: 'test',
+      defaultBucket: {
+        name: 'test',
+        password: 'password',
+      },
+      buckets: [
+        {
+          name: 'another_bucket',
+          password: 'another_password',
+        },
+      ],
     }),
   ],
 })
@@ -94,8 +104,8 @@ export class CatsService {
 
 Created by [@zMotivat0r](https://github.com/zMotivat0r) @ [Scalio](https://scal.io/)
 
-
 ## About us
+
 <p align="center">
     <br/>
     <a href="https://scal.io/">

dist/README.md

@@ -1,6 +1,12 @@
-## Description
+![Couchbase for Nest](https://raw.githubusercontent.com/scalio/nest-couchbase/master/scalio-nc.svg?sanitize=true)
 
-The [Couchbase](https://www.couchbase.com/) module for Nest framework
+<h1 align="center">NestJS Couchbase</h1>
+
+<p align="center">
+  A <a href="https://www.couchbase.com/">Couchbase</a> module for <a href="https://nestjs.com/">NestJS</a>
+</p>
+
+&nbsp;
 
 ## Installation
 
@@ -23,7 +29,7 @@ export class Cat {
 }
 ```
 
-Where `cats` is the Couchbase bucket name.
+Where `cats` is the Couchbase bucket name (optional).
 
 Then, we need to import `CouchbaseModule` in our root `AppModule`:
 
@@ -37,7 +43,16 @@ import { CouchbaseModule } from '@scalio-oss/nest-couchbase';
       url: 'couchbase://127.0.0.1',
       username: 'couchbase',
       password: 'couchbase',
-      bucket: 'test',
+      defaultBucket: {
+        name: 'test',
+        password: 'password',
+      },
+      buckets: [
+        {
+          name: 'another_bucket',
+          password: 'another_password',
+        },
+      ],
     }),
   ],
 })
@@ -89,9 +104,12 @@ export class CatsService {
 
 Created by [@zMotivat0r](https://github.com/zMotivat0r) @ [Scalio](https://scal.io/)
 
+## About us
+
 <p align="center">
     <br/>
     <a href="https://scal.io/">
-        <img src="https://raw.githubusercontent.com/scalio/bazel-status/master/assets/scalio-logo.svg?sanitize=true"/>
+        <img src="https://raw.githubusercontent.com/scalio/bazel-status/master/assets/scalio-logo.svg?sanitize=true" />
     </a>
+    <br/>
 </p>

docker-compose.yml

@@ -13,7 +13,7 @@ volumes:
 
 services:
   couchbase:
-    container_name: couchbase
+    container_name: nest_couchbase
     image: couchbase:community
     volumes:
       - type: volume

e2e/__stubs__/config.ts

@@ -4,7 +4,15 @@ export const config: CouchbaseConnectionConfig = {
   url: 'couchbase://127.0.0.1',
   username: 'couchbase',
   password: 'couchbase',
-  bucket: 'e2e_test',
+  defaultBucket: {
+    name: 'e2e_test',
+  },
+  buckets: [
+    {
+      name: 'e2e_test_secure',
+      password: 'password',
+    },
+  ],
 };
 
 export const bucketOptions = { bucketType: 'ephemeral', replicaNumber: 0 };

e2e/couchbase/couchbase.connection.factory.spec.ts

@@ -47,13 +47,19 @@ describe('#couchbase', () => {
 
       describe('#createBucket', () => {
         it('should create a bucket', async () => {
-          const [err, ok] = await conn.createBucket(config.bucket, bucketOptions);
+          const [err, ok] = await conn.createBucket(
+            config.defaultBucket.name,
+            bucketOptions,
+          );
           expect(err).toBeUndefined();
           expect(ok).toBe(true);
           await sleep(3500);
         });
         it('should return an error', async () => {
-          const [err, _] = await conn.createBucket(config.bucket, bucketOptions);
+          const [err, _] = await conn.createBucket(
+            config.defaultBucket.name,
+            bucketOptions,
+          );
           expect(err).toBeInstanceOf(Error);
         });
       });
@@ -71,12 +77,12 @@ describe('#couchbase', () => {
           expect(err).toBeInstanceOf(Error);
         });
         it('should return a bucket', async () => {
-          const [_, bucket] = await conn.getBucket(config.bucket);
+          const [_, bucket] = await conn.getBucket(config.defaultBucket.name);
           expect(bucket).toBeDefined();
           bucket.disconnect();
         });
         it('should return a bucket with mock', async () => {
-          const [_, bucket] = await mocked.getBucket(config.bucket);
+          const [_, bucket] = await mocked.getBucket(config.defaultBucket.name);
           expect(bucket).toBeDefined();
         });
       });
@@ -87,7 +93,7 @@ describe('#couchbase', () => {
           expect(err).toBeInstanceOf(Error);
         });
         it('should remove a bucket', async () => {
-          const [_, ok] = await conn.removeBucket(config.bucket);
+          const [_, ok] = await conn.removeBucket(config.defaultBucket.name);
           expect(ok).toBe(true);
         });
       });

e2e/couchbase/couchbase.repository.factory.spec.ts

@@ -27,12 +27,12 @@ describe('#couchbase', () => {
       conn = await CouchbaseConnectionFactory.create(config);
       mocked = await CouchbaseConnectionFactory.create({ ...config, mock: true });
       await removeBuckets();
-      await conn.createBucket(config.bucket, bucketOptions);
+      await conn.createBucket(config.defaultBucket.name, bucketOptions);
       await sleep(3500);
     });
 
     afterAll(async () => {
-      const [_, bucket] = await conn.getBucket(config.bucket);
+      const [_, bucket] = await conn.getBucket(config.defaultBucket.name);
       bucket.disconnect();
       await removeBuckets();
     });
@@ -49,14 +49,6 @@ describe('#couchbase', () => {
         const [err] = await flattenPromise(CouchbaseRepositoryFactory.create)(conn);
         expect(err).toBeInstanceOf(Error);
       });
-      it('should throw an error, 3', async () => {
-        class InvalidTestEntity {}
-        const [err] = await flattenPromise(CouchbaseRepositoryFactory.create)(
-          conn,
-          InvalidTestEntity,
-        );
-        expect(err).toBeInstanceOf(CouchbaseException);
-      });
       it('should throw an error, 4', async () => {
         @Entity('invalid')
         class InvalidTestEntity {}
@@ -66,12 +58,19 @@ describe('#couchbase', () => {
         );
         expect(err).toBeInstanceOf(Error);
       });
-      it('should create new Repository', async () => {
+      it('should create new Repository, 1', async () => {
         const repo = await CouchbaseRepositoryFactory.create(conn, Cat);
         expect(repo).toBeDefined();
         expect(typeof repo).toBe('object');
         expect(repo.entity).toBeDefined();
       });
+      it('should create new Repository, 2', async () => {
+        class TestEntity {}
+        const repo = await CouchbaseRepositoryFactory.create(conn, TestEntity);
+        expect(repo).toBeDefined();
+        expect(typeof repo).toBe('object');
+        expect(repo.entity).toBeDefined();
+      });
       it('should create new Repository with mock', async () => {
         const repo = await CouchbaseRepositoryFactory.create(mocked, Cat);
         expect(repo).toBeDefined();

e2e/module/couchbase.module.spec.ts

@@ -26,12 +26,12 @@ describe('#module', () => {
     beforeAll(async () => {
       conn = await CouchbaseConnectionFactory.create(config);
       await removeBuckets();
-      await conn.createBucket(config.bucket, bucketOptions);
+      await conn.createBucket(config.defaultBucket.name, bucketOptions);
       await sleep(3500);
     });
 
     afterAll(async () => {
-      const [_, bucket] = await conn.getBucket(config.bucket);
+      const [_, bucket] = await conn.getBucket(config.defaultBucket.name);
       bucket.disconnect();
       await removeBuckets();
     });

integration/couchbase.config.ts

@@ -2,7 +2,10 @@ import { CouchbaseConnectionConfig } from '../src/couchbase';
 
 export const config: CouchbaseConnectionConfig = {
   url: 'couchbase://127.0.0.1',
-  username: 'couchbase',
-  password: 'couchbase',
-  bucket: 'test',
+  username: undefined,
+  password: undefined,
+  defaultBucket: {
+    name: 'test',
+    password: '123456',
+  },
 };

integration/users/users.service.ts

@@ -8,6 +8,6 @@ export class UsersService {
   constructor(@InjectRepository(User) private repo: Repository<User>) {}
 
   async get(id: string) {
-    return this.repo.getFlat(id);
+    return (this.repo as any).getFlat(id);
   }
 }

src/couchbase/couchbase.connection.factory.ts

@@ -23,10 +23,10 @@ export class CouchbaseConnectionFactory {
     return conn;
   }
 
-  async getBucket(name: string): Promise<[Error, Bucket]> {
+  async getBucket(name: string, password?: string): Promise<[Error, Bucket]> {
     return this.config.mock
       ? [undefined, this.cluster.openBucket()]
-      : await this.openBucket(name);
+      : await this.openBucket(name, password);
   }
 
   async createBucket(
@@ -64,7 +64,7 @@ export class CouchbaseConnectionFactory {
     }
   }
 
-  private async openBucket(name: string): Promise<[Error, Bucket]> {
+  private async openBucket(name: string, password?: string): Promise<[Error, Bucket]> {
     /* istanbul ignore if */
     if (this.buckets[name]) {
       return [undefined, this.buckets[name]];
@@ -75,6 +75,7 @@ export class CouchbaseConnectionFactory {
         new Promise((resolve, reject) => {
           const bucket = this.cluster.openBucket.bind(this.cluster)(
             name,
+            password,
             (err: Error) => {
               if (err) {
                 reject(err);