refactor: use gitbreaker instead of node-gitlab

Author: superRaytin

.babelrc

@@ -10,8 +10,8 @@
     ]
   ],
   "plugins": [
-    "transform-object-rest-spread",
-    "transform-class-properties",
-    "transform-es2015-classes"
+    "@babel/plugin-proposal-object-rest-spread",
+    "@babel/plugin-transform-classes",
+    "@babel/plugin-proposal-class-properties"
   ]
 }

README.md

@@ -1,5 +1,5 @@
 # gitlab-db
-A lightweight GitLab based JSON database with Mongo-style API. Backed by [node-gitlab](https://github.com/node-gitlab/node-gitlab) and [mingo](https://github.com/kofrasa/mingo).
+A lightweight Gitlab based JSON database with Mongo-style API. Backed by [gitbreaker](https://github.com/jdalrymple/gitbeaker) and [mingo](https://github.com/kofrasa/mingo).
 
 [![NPM version][npm-image]][npm-url]
 [![Downloads][downloads-image]][npm-url]
@@ -17,10 +17,10 @@ npm i gitlab-db
 ## Quick Start
 
 ```js
-import GitLabDB from 'gitlab-db'
+import GitlabDB from 'gitlab-db'
 
 // Instantiate a database
-const db = new GitLabDB('apple', {
+const db = new GitlabDB('apple', {
   url: 'http://gitlab.example.com',
   token: 'your_access_token',
   repo: 'group/repo',
@@ -46,13 +46,13 @@ Repository structure will be:
 
 ## API
 
-Note: As all APIs returns a promise. I highly recommend the `yield` statement like the following:
+Note: As all APIs returns a promise. I highly recommend the `async/await` statement like the following:
 
 ```js
-const result = yield db.collection('product').save({ name: 'iphone', v: '8', price: 699 })
+const result = await db.collection('product').save({ name: 'iphone', v: '8', price: 699 })
 ```
 
-### constructor(dbName, options)
+### constructor(dbName, options[, customGitlabAPI])
 
 Instantiate a database.
 
@@ -61,6 +61,8 @@ Instantiate a database.
   - **url:** `String` Specify gitlab url, eg: `http://gitlab.example.com`.
   - **token:** `String` Specify your personal access token.
   - **repo:** `String` Specify repository name and group belongs to, format: `group/repo`.
+  - **branch:** `String` Optional, specify branch, default: `main`.
+- **customGitlabAPI:** `String` Specify your custom GitlabAPI like `@gitbeaker/browser`.
 
 ### db.createCollection(collectionName [, documents])
 
@@ -157,12 +159,28 @@ Returns like:
 true
 ```
 
-### Next
+## Use in Browser
+
+```js
+import { Gitlab } from '@gitbeaker/browser'; 
+import GitlabDB from 'gitlab-db'
+
+// Instantiate a database
+const db = new GitlabDB('apple', {
+  url: 'http://gitlab.example.com',
+  token: 'your_access_token',
+  repo: 'group/repo',
+}, Gitlab)
+
+// ETC...
+```
+
+## Next
 
 - [ ] model check
 - [ ] collection deletion
 
-### Test
+## Test
 
 Config your environment variables `GITLAB_URL` `ACCESS_TOKEN` `REPO`, and run tests with:
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab-db",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "description": "A lightweight GitLab based JSON database with Mongo-style API",
   "repository": {
     "type": "git",
@@ -10,33 +10,34 @@
   "scripts": {
     "lint": "eslint --ext .js src",
     "build": "babel src --out-dir dist",
-    "test": "npm run build && node ./node_modules/mocha-webpack/bin/mocha-webpack --webpack-config webpack.test.config.js \"test/*.test.js\"",
-    "publishOnly": "npm run build && npm publish"
+    "test": "npm run build && node ./node_modules/mochapack/bin/mochapack --webpack-config webpack.test.config.js \"test/*.test.js\"",
+    "prepublishOnly": "npm run lint && npm run build",
+    "postpublish": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag $PACKAGE_VERSION && git push --tags"
   },
   "dependencies": {
-    "gitlab": "^1.7.1",
-    "mingo": "^2.1.1",
-    "uuid": "^3.1.0"
+    "@gitbeaker/node": "^33.0.0",
+    "mingo": "^4.1.4",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "assert": "^1.4.1",
-    "babel-cli": "^6.26.0",
-    "babel-loader": "^7.0.0",
-    "babel-core": "^6.26.0",
-    "babel-eslint": "^8.0.1",
-    "babel-plugin-transform-class-properties": "^6.24.1",
-    "babel-plugin-transform-es2015-classes": "^6.24.1",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-preset-env": "^1.6.0",
-    "chai": "^4.0.0",
+    "@babel/core": "^7.15.0",
+    "@babel/cli": "^7.14.8",
+    "@babel/plugin-proposal-object-rest-spread": "^7.14.7",
+    "@babel/plugin-transform-classes": "^7.14.9",
+    "@babel/plugin-proposal-class-properties": "^7.14.5",
+    "assert": "^2.0.0",
+    "babel-loader": "^8.2.2",
+    "babel-eslint": "^10.1.0",
+    "babel-preset-env": "^1.7.0",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^4.7.2",
-    "eslint-config-airbnb-base": "^12.0.0",
-    "eslint-plugin-import": "^2.7.0",
-    "eslint-plugin-node": "^5.1.1",
-    "mocha": "^4.1.0",
-    "mocha-webpack": "^1.0.1",
-    "webpack": "^2.6.1",
-    "webpack-node-externals": "^1.6.0"
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "8",
+    "mochapack": "^2.1.2",
+    "webpack": "^5.51.1",
+    "webpack-node-externals": "^3.0.0"
   }
 }

src/collection.js

@@ -10,36 +10,36 @@ export default class Collection {
   _getFileContent() {
     const { name } = this
     const { client, dbName, repo, branch } = this.gitlabConfig
-    return new Promise((resolve, reject) => {
-      client.projects.repository.showFile(repo, {
-        file_path: `${dbName}/${name}.json`,
-        ref: branch,
-      }, (data) => {
-        if (!data) return reject(new Error(`[${name}]: collection does not exist`))
-        const content = Buffer.from(data.content, 'base64').toString()
-        try {
-          const result = JSON.parse(content)
-          resolve(result)
-        } catch (e) {
-          reject(new Error(`[${name}]: collection content must be a valid JSON object`))
-        }
-      })
+    const projectId = repo
+    const file_path = `${dbName}/${name}.json`
+    const branch_name = branch
+
+    return client.RepositoryFiles.show(projectId, file_path, branch_name).then((data) => {
+      if (!data) throw new Error(`[${name}]: collection does not exist`)
+      const content = Buffer.from(data.content, 'base64').toString()
+      try {
+        const result = JSON.parse(content)
+        return result
+      } catch (e) {
+        throw new Error(`[${name}]: collection content must be a valid JSON object`)
+      }
     })
   }
   _writeFileContent(content) {
     const { name } = this
     const { client, dbName, repo, branch } = this.gitlabConfig
-    return new Promise((resolve) => {
-      client.projects.repository.updateFile({
-        projectId: repo,
-        file_path: `${dbName}/${name}.json`,
-        branch_name: branch,
-        content: JSON.stringify(content),
-        commit_message: 'Update collection',
-      }, (data) => {
-        resolve(data)
-      })
-    })
+    const projectId = repo
+    const file_path = `${dbName}/${name}.json`
+    const branch_name = branch
+    const stringifiedContent = JSON.stringify(content)
+    const commit_message = 'Update collection'
+    return client.RepositoryFiles.edit(
+      projectId,
+      file_path,
+      branch_name,
+      stringifiedContent,
+      commit_message,
+    )
   }
   setOptions(options = {}) {
     this.options = { ...this.options, ...options }

src/main.js

@@ -1,37 +1,38 @@
-import GitLab from 'gitlab'
+import { Gitlab } from '@gitbeaker/node'
 import { initializeCollection, promiseAllSerial } from './utils'
 import Collection from './collection'
 
 class GitLabDB {
-  constructor(dbName, options = {}) {
+  constructor(dbName, options = {}, customGitlabAPI) {
     const defaultOptions = {
-      branch: 'master',
+      branch: 'main',
     }
+    const GitlabClient = customGitlabAPI || Gitlab
     this.dbName = dbName
     this.options = { ...defaultOptions, ...options }
-    this.gitlabClient = new GitLab({
-      url: this.options.url,
+    this.collections = {}
+    this.gitlabClient = new GitlabClient({
+      host: this.options.url,
       token: this.options.token,
     })
-    this.collections = {}
   }
   createCollection(collectionName, documents = []) {
     const initialContent = initializeCollection(documents)
     const { dbName } = this
     const { repo, branch } = this.options
-    return new Promise((resolve, reject) => {
-      this.gitlabClient.projects.repository.createFile({
-        projectId: repo,
-        file_path: `${dbName}/${collectionName}.json`,
-        branch_name: branch,
-        content: JSON.stringify(initialContent),
-        commit_message: 'Create collection',
-      }, (data) => {
-        if (data === true) {
-          return reject(new Error(`[${collectionName}]: cannot override existing collections, use update instead`))
-        }
-        resolve(data)
-      })
+    const projectId = repo
+    const file_path = `${dbName}/${collectionName}.json`
+    const branch_name = branch
+    const content = JSON.stringify(initialContent)
+    const commit_message = 'Create collection'
+    return this.gitlabClient.RepositoryFiles.create(
+      projectId,
+      file_path,
+      branch_name,
+      content,
+      commit_message,
+    ).catch(() => {
+      throw new Error(`[${collectionName}]: cannot override existing collections, use update instead`)
     })
   }
   createCollections(collectionNames, documentsArray = []) {
@@ -56,17 +57,13 @@ class GitLabDB {
   isCollectionExists(collectionName) {
     const { dbName } = this
     const { repo, branch } = this.options
-    return new Promise((resolve) => {
-      this.gitlabClient.projects.repository.showFile(repo, {
-        file_path: `${dbName}/${collectionName}.json`,
-        ref: branch,
-      }, (data) => {
-        if (data && data.file_name) {
-          resolve(true)
-        } else {
-          resolve(false)
-        }
-      })
+    const projectId = repo
+    const file_path = `${dbName}/${collectionName}.json`
+    const branch_name = branch
+    return this.gitlabClient.RepositoryFiles.show(projectId, file_path, branch_name).then((res) => {
+      return !!(res && res.file_name)
+    }).catch((e) => {
+      return false
     })
   }
 }

src/utils.js

@@ -1,4 +1,4 @@
-import uuidv1 from 'uuid/v1'
+import { v1 as uuidv1 } from 'uuid'
 
 export function createNewId() {
   return uuidv1().replace(/-/g, '')

test/GitLabDB.test.js

@@ -18,7 +18,7 @@ const options = {
   repo: process.env.REPO,
 }
 const testDbName = 'flame'
-const testCollectionName = 'project1'
+const testCollectionName = 'project'
 const testCollectionDocuments = [{ a: 1, b: 3 }, { a: 2, d: 3, b: 3 }, { a: 11, b: 22, c: 33, d: 44 }]
 const collectionsWillBeCreatedAndRemoved = ['project4', 'project5']
 const newDocument = { a: 41, b: 42 }
@@ -28,24 +28,18 @@ const gitlabDB = new GitLabDB(testDbName, options)
 describe('GitLabDB', function() {
   this.timeout(200000)
 
-  before((done) => {
+  before(async () => {
     console.log(`Creating ${testDbName}/${testCollectionName}.json file in the test repo: ${options.repo}...`)
-    gitlabDB.isCollectionExists(testCollectionName).then((result) => {
-      if (!result) {
-        gitlabDB.createCollection(testCollectionName, testCollectionDocuments).then((data) => {
-          expect(data).to.have.a.property('file_path')
-          done()
-        })
-      } else {
-        done()
-      }
-    })
+    const isExists = await gitlabDB.isCollectionExists(testCollectionName)
+    if (!isExists) {
+      const data = await gitlabDB.createCollection(testCollectionName, testCollectionDocuments)
+      expect(data).to.have.a.property('file_path')
+    }
   })
 
-  it('collection already exists, should createCollection failed', (done) => {
-    gitlabDB.createCollection(testCollectionName, [], { key: 'a' }).catch((e) => {
+  it('collection already exists, should createCollection failed', () => {
+    return gitlabDB.createCollection(testCollectionName, [], { key: 'a' }).catch((e) => {
       expect(e).to.be.an('error')
-      done()
     })
   })
 
@@ -92,10 +86,8 @@ describe('GitLabDB', function() {
 
   after((done) => {
     console.log('Get all tests be done, cleaning generated files...')
-    cleanRepositry(collectionsWillBeCreatedAndRemoved, { ...options, dbName: testDbName }).then((data) => {
-      const removed_files = data.map(item => {
-        return JSON.parse(item).file_path
-      }).join(', ')
+    cleanRepositry(collectionsWillBeCreatedAndRemoved, { ...options, dbName: testDbName }).then(() => {
+      const removed_files = collectionsWillBeCreatedAndRemoved.map(item => `${testDbName}/${item}`).join(', ')
       console.log(`${removed_files} has been removed`)
       done()
     })

test/cleanRepositry.js

@@ -4,11 +4,10 @@ const child_process = require('child_process')
 export default function cleanRepositry(collectionNames, options) {
   const { token, url, repo, dbName } = options
   const promises = collectionNames.map((collectionName, index) => () => {
-    return new Promise((resolve, reject) => {
-      child_process.exec(`curl --request DELETE --header "PRIVATE-TOKEN: ${token}" "${url}/api/v3/projects/${encodeURIComponent(repo)}/repository/files?file_path=${dbName}%2F${collectionName}%2Ejson&branch_name=master&commit_message=Delete%20collection"`, (error, stdout) => {
+    return new Promise((resolve) => {
+      child_process.exec(`curl --request DELETE --header 'PRIVATE-TOKEN: ${token}' --header "Content-Type: application/json" --data '{"branch": "main", "author_email": "[email protected]", "author_name": "shiliang", "commit_message": "Delete collection"}' "${url}/api/v4/projects/shiliang%2Fgitlab-db/repository/files/${dbName}%2F${collectionName}%2Ejson"`, (error, stdout) => {
         if(error) {
-          console.error('error: ' + error);
-          return reject(error)
+          console.log(`[${collectionName}] error: ` + error);
         }
         resolve(stdout)
       });

webpack.test.config.js

@@ -1,13 +1,14 @@
 var nodeExternals = require('webpack-node-externals')
 
 module.exports = {
+  mode: 'production',
   target: 'node',
   externals: [nodeExternals()],
   module: {
-    loaders: [
+    rules: [
       {
         test: /\.js$/,
-        loader: 'babel-loader'
+        use: 'babel-loader'
       }
     ]
   }