feat: add database url parser to Parser class

Author: jlenon7

README.md

@@ -586,6 +586,37 @@ Parser.reasonToStatusCode('NOT_found') // 404
 Parser.reasonToStatusCode('internal server error') // 500
 ```
 
+```ts
+const url =
+  'postgresql://postgres:root@127.0.0.1:5432/postgres?paramOne=1&paramTwo=2&paramThree=3'
+
+// Convert database connection url to connection object
+const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+/** connectionObject result
+ * {
+ *   protocol: 'postgresql',
+ *   user: 'postgres',
+ *   password: 'root',
+ *   host: '127.0.0.1',
+ *   port: 5432,
+ *   database: 'postgres',
+ *   options: {
+ *     paramOne: '1',
+ *     paramTwo: '2',
+ *     paramThree: '3',
+ *   }
+ * }
+ */
+
+// Convert connection object to database connection url
+const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+/** connectionUrl result
+ * postgresql://postgres:root@127.0.0.1:5432/postgres?paramOne=1&paramTwo=2&paramThree=3
+ */
+```
+
 ---
 
 ### Clean
@@ -765,18 +796,18 @@ await sleep(2000) // Your code will stop in this line for two seconds
 
 > Find out what's the distance between a coordinate to other
 
-```js
+```ts
 import { kmRadius, ICoordinate } from '@secjs/utils'
 
 // Use type number for more precision,
 // but you can use string to,
 // kmRadius will handle it with Parser.
-const coordinate1 {
+const coordinate1 = {
  latitude: -25.4858841,
  longitude: -54.564615,
 } as ICoordinate // ICoordinate will force numbers
 
-const coordinate2 {
+const coordinate2 = {
  latitude: '-54.564615',
  longitude: '-25.4858841',
 }

index.ts

@@ -1,3 +1,5 @@
+export * from './src/Contracts/DBUrlParserContract'
+
 export * from './src/Classes/Is'
 export * from './src/Classes/Json'
 export * from './src/Classes/Path'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/utils",
-  "version": "1.6.9",
+  "version": "1.7.0",
   "description": "",
   "license": "MIT",
   "author": "João Lenon",

package.json

@@ -10,9 +10,12 @@
 import ms from 'ms'
 import bytes from 'bytes'
 
-import { getReasonPhrase, getStatusCode } from 'http-status-codes'
-import { InternalServerException } from '@secjs/exceptions'
+import { Is } from './Is'
 import { String } from './String'
+import { InternalServerException } from '@secjs/exceptions'
+import { getReasonPhrase, getStatusCode } from 'http-status-codes'
+import { DBUrlParserContract } from '../Contracts/DBUrlParserContract'
+import { homedir } from 'os'
 
 export class Parser {
   /**
@@ -199,4 +202,83 @@ export class Parser {
 
     return getStatusCode(reason)
   }
+
+  /**
+   * dbUrlToConnectionObj parses the database connection url to connection object
+   *
+   * @param url - The database url
+   * @return Return the connection object
+   */
+  static dbUrlToConnectionObj(url: string): DBUrlParserContract {
+    const urlRegexp = /^([^:\\/\s]+):\/\/((.*):(.*)@|)(.*)(:(.*)|)\/(.*)(\?(.+))?/
+    const matcher = url.match(urlRegexp)
+
+    const connectionObject: DBUrlParserContract = {
+      protocol: matcher[1],
+      user: null,
+      password: null,
+      host: null,
+      port: null,
+      database: matcher[8],
+      options: {},
+    }
+
+    if (matcher[5].includes(',')) {
+      connectionObject.host = matcher[5].split(',')
+    } else {
+      connectionObject.host = matcher[5]
+
+      if (matcher[5].includes(':')) {
+        const [h, p] = matcher[5].split(':')
+
+        connectionObject.host = h
+        connectionObject.port = parseInt(p)
+      }
+    }
+
+    if (connectionObject.database.includes('?')) {
+      const [database, options] = connectionObject.database.split('?')
+
+      connectionObject.database = database
+      connectionObject.options = this.formDataToJson(options)
+    }
+
+    if (matcher[3]) connectionObject.user = matcher[3]
+    if (matcher[4]) connectionObject.password = matcher[4]
+
+    return connectionObject
+  }
+
+  /**
+   * connectionObjToDbUrl parses the database connection object to connection url
+   *
+   * @param object - The database connection object
+   * @return Return the connection url
+   */
+  static connectionObjToDbUrl(object: DBUrlParserContract): string {
+    const { protocol, user, password, host, port, database, options } = object
+
+    let url = `${protocol}://`
+
+    if (user || password) {
+      if (user) url = url.concat(user)
+      if (password) url = url.concat(`:${password}`)
+
+      url = url.concat('@')
+    }
+
+    if (Is.Array(host)) {
+      url = url.concat(host.join(','))
+    } else {
+      url = url.concat(host)
+
+      if (port) url = url.concat(`:${port}`)
+    }
+
+    url = url.concat(`/${database}`)
+
+    if (!Is.Empty(options)) url = url.concat(`?${this.jsonToFormData(options)}`)
+
+    return url
+  }
 }

src/Classes/Parser.ts

@@ -0,0 +1,18 @@
+/**
+ * @secjs/utils
+ *
+ * (c) João Lenon <lenon@secjs.com.br>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export interface DBUrlParserContract {
+  protocol: string
+  user?: string
+  password?: string
+  host: string | string[]
+  port?: number
+  database: string
+  options?: Record<string, string>
+}

src/Contracts/DBUrlParserContract.ts

@@ -105,4 +105,117 @@ describe('\n Parser Class', () => {
     expect(Parser.reasonToStatusCode('unauthorized')).toBe(401)
     expect(Parser.reasonToStatusCode('INTERNAL_SERVER_ERROR')).toBe(500)
   })
+
+  it('should parse the complete database url to object and object to complete database url', async () => {
+    const url =
+      'postgresql://postgres:root@127.0.0.1:5432/postgres?paramOne=1&paramTwo=2&paramThree=3'
+
+    // database url to connection object
+    const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+    expect(connectionObject.protocol).toBe('postgresql')
+    expect(connectionObject.user).toBe('postgres')
+    expect(connectionObject.password).toBe('root')
+    expect(connectionObject.host).toBe('127.0.0.1')
+    expect(connectionObject.port).toBe(5432)
+    expect(connectionObject.database).toBe('postgres')
+    expect(connectionObject.options).toEqual({
+      paramOne: '1',
+      paramTwo: '2',
+      paramThree: '3',
+    })
+
+    // connection object to database url
+    const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+    expect(connectionUrl).toBe(url)
+  })
+
+  it('should parse the without auth database url to object and object to without auth database url', async () => {
+    const url = 'postgresql://127.0.0.1:5432/postgres'
+
+    // database url to connection object
+    const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+    expect(connectionObject.protocol).toBe('postgresql')
+    expect(connectionObject.user).toBe(null)
+    expect(connectionObject.password).toBe(null)
+    expect(connectionObject.host).toBe('127.0.0.1')
+    expect(connectionObject.port).toBe(5432)
+    expect(connectionObject.database).toBe('postgres')
+    expect(connectionObject.options).toEqual({})
+
+    // connection object to database url
+    const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+    expect(connectionUrl).toBe(url)
+  })
+
+  it('should parse the without auth and port database url to object and object to without auth and port database url', async () => {
+    const url = 'postgresql://127.0.0.1/postgres?options=10&test=10'
+
+    // database url to connection object
+    const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+    expect(connectionObject.protocol).toBe('postgresql')
+    expect(connectionObject.user).toBe(null)
+    expect(connectionObject.password).toBe(null)
+    expect(connectionObject.host).toBe('127.0.0.1')
+    expect(connectionObject.port).toBe(null)
+    expect(connectionObject.database).toBe('postgres')
+    expect(connectionObject.options).toEqual({
+      options: '10',
+      test: '10',
+    })
+
+    // connection object to database url
+    const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+    expect(connectionUrl).toBe(url)
+  })
+
+  it('should parse the without auth, port and options database url to object and object to without auth, port and options database url', async () => {
+    const url = 'postgresql://127.0.0.1/postgres'
+
+    // database url to connection object
+    const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+    expect(connectionObject.protocol).toBe('postgresql')
+    expect(connectionObject.user).toBe(null)
+    expect(connectionObject.password).toBe(null)
+    expect(connectionObject.host).toBe('127.0.0.1')
+    expect(connectionObject.port).toBe(null)
+    expect(connectionObject.database).toBe('postgres')
+    expect(connectionObject.options).toEqual({})
+
+    // connection object to database url
+    const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+    expect(connectionUrl).toBe(url)
+  })
+
+  it('should parse the cluster database url to object and object to cluster database url', async () => {
+    const url =
+      'postgresql://postgres:root@127.0.0.1:5432,127.0.0.1:5433,127.0.0.1:5434/postgres'
+
+    // database url to connection object
+    const connectionObject = Parser.dbUrlToConnectionObj(url)
+
+    expect(connectionObject.protocol).toBe('postgresql')
+    expect(connectionObject.user).toBe('postgres')
+    expect(connectionObject.password).toBe('root')
+    expect(connectionObject.host).toEqual([
+      '127.0.0.1:5432',
+      '127.0.0.1:5433',
+      '127.0.0.1:5434',
+    ])
+    expect(connectionObject.port).toBe(null)
+    expect(connectionObject.database).toBe('postgres')
+    expect(connectionObject.options).toEqual({})
+
+    // connection object to database url
+    const connectionUrl = Parser.connectionObjToDbUrl(connectionObject)
+
+    expect(connectionUrl).toBe(url)
+  })
 })