Merge pull request #9 from hackmdio/feature/ee-support

Support enterprise instance

Author: Yukaii

src/api.ts

@@ -1,3 +1,4 @@
+import cheerio from 'cheerio'
 import * as fs from 'fs-extra'
 import nodeFetch from 'node-fetch'
 import tough = require('tough-cookie')
@@ -8,7 +9,8 @@ import config from './config'
 
 interface APIOptions {
   serverUrl: string
-  cookiePath: string
+  cookiePath: string,
+  enterprise: boolean
 }
 
 type nodeFetchType = (url: RequestInfo, init?: RequestInit | undefined) => Promise<Response>
@@ -36,10 +38,11 @@ export type HistoryItem = {
  */
 class API {
   public readonly serverUrl: string
+  private readonly enterprise: boolean
   private readonly _fetch: nodeFetchType
 
-  constructor() {
-    const {serverUrl, cookiePath}: APIOptions = config
+  constructor(config: APIOptions) {
+    const {serverUrl, cookiePath, enterprise} = config
 
     fs.ensureFileSync(cookiePath)
 
@@ -48,32 +51,39 @@ class API {
 
     this._fetch = fetch
     this.serverUrl = serverUrl
+    this.enterprise = enterprise
   }
 
   async login(email: string, password: string) {
     const response = await this.fetch(`${this.serverUrl}/login`, {
       method: 'post',
       body: encodeFormComponent({email, password}),
-      headers: {
+      headers: await this.wrapHeaders({
         'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8'
-      }
+      })
     })
+
     return response.status === 200
   }
 
   async loginLdap(username: string, password: string) {
     const response = await this.fetch(`${this.serverUrl}/auth/ldap`, {
       method: 'post',
       body: encodeFormComponent({username, password}),
-      headers: {
+      headers: await this.wrapHeaders({
         'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8'
-      }
+      })
     })
     return response.status === 200
   }
 
   async logout() {
-    const response = await this.fetch(`${this.serverUrl}/logout`)
+    const response = await this.fetch(`${this.serverUrl}/logout`, {
+      method: this.enterprise ? 'POST' : 'GET',
+      headers: await this.wrapHeaders({
+        'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
+      })
+    })
     return response.status === 200
   }
 
@@ -93,14 +103,26 @@ class API {
   }
 
   async newNote(body: string) {
-    const contentType = 'text/markdown;charset=UTF-8'
-    const response = await this.fetch(`${this.serverUrl}/new`, {
-      method: 'POST',
-      body,
-      headers: {
-        'Content-Type': contentType
-      }
-    })
+    let response
+    if (this.enterprise) {
+      response = await this.fetch(`${this.serverUrl}/new`, {
+        method: 'POST',
+        body: encodeFormComponent({content: body}),
+        headers: await this.wrapHeaders({
+          'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
+        })
+      })
+    } else {
+      const contentType = 'text/markdown;charset=UTF-8'
+      response = await this.fetch(`${this.serverUrl}/new`, {
+        method: 'POST',
+        body,
+        headers: {
+          'Content-Type': contentType
+        }
+      })
+    }
+
     if (response.status === 200) {
       return response.url
     } else {
@@ -149,8 +171,27 @@ class API {
   get domain() {
     return url.parse(this.serverUrl).host
   }
+
+  private async wrapHeaders(headers: any) {
+    if (this.enterprise) {
+      const csrf = await this.loadCSRFToken()
+      return {
+        ...headers,
+        'X-XSRF-Token': csrf
+      }
+    } else {
+      return headers
+    }
+  }
+
+  private async loadCSRFToken() {
+    const html = await this.fetch(`${this.serverUrl}`).then(r => r.text())
+    const $ = cheerio.load(html)
+
+    return $('meta[name="csrf-token"]').attr('content') || ''
+  }
 }
 
 export default API
 
-export const APIClient = new API()
+export const APIClient = new API(config)

src/commands/login.ts

@@ -28,7 +28,7 @@ Login as HMD successfully!
     let id = flags.id
 
     if (!id) {
-      if(flags.ldap) {
+      if (flags.ldap) {
         const out = await inquirer.prompt({
           type: 'input',
           name: 'username',
@@ -60,7 +60,7 @@ Login as HMD successfully!
 
     try {
       let success = false
-      if(flags.ldap) {
+      if (flags.ldap) {
         success = await APIClient.loginLdap(id, password)
       } else {
         success = await APIClient.login(id, password)

src/config.ts

@@ -1,8 +1,7 @@
 import * as fs from 'fs-extra'
-import * as path from 'path'
-
 import defaults from 'lodash/defaults'
 import {homedir} from 'os'
+import * as path from 'path'
 
 let configDir
 if (process.env.HMD_CLI_CONFIG_DIR) {
@@ -16,12 +15,25 @@ const defaultCookiePath = path.join(homedir(), '.codimd', 'cookies.json')
 
 const defaultConfig = {
   cookiePath: defaultCookiePath,
-  serverUrl: ''
+  serverUrl: 'https://hackmd.io',
+  enterprise: true
+}
+
+function toBooleanConfig(configValue?: string | boolean) {
+  if (configValue && typeof configValue === 'string') {
+    return (configValue === 'true')
+  }
+  return configValue
 }
 
 const envConfig = {
-  cookiePath: process.env.CMD_CLI_COOKIE_PATH,
-  serverUrl: process.env.CMD_CLI_SERVER_URL
+  cookiePath: process.env.HMD_CLI_COOKIE_PATH || process.env.CMD_CLI_COOKIE_PATH,
+  serverUrl: process.env.HMD_CLI_SERVER_URL || process.env.CMD_CLI_SERVER_URL,
+  enterprise: (process.env.HMD_CLI_COOKIE_PATH || process.env.HMD_CLI_SERVER_URL)
+    ? true
+    : (process.env.CMD_CLI_COOKIE_PATH || process.env.CMD_CLI_SERVER_URL)
+      ? false
+      : toBooleanConfig(process.env.HMD_CLI_ENTERPRISE)
 }
 
 // look for a readable config file; we can merge it with the env.
@@ -61,6 +73,7 @@ ${err}
 // prefer environment config over file config
 const config = defaults(envConfig, readConfig, defaultConfig)
 
+// !FIXME This branching never meets because we have defaultConfig
 if (!config.serverUrl) {
   throw new Error(`
 
@@ -91,6 +104,7 @@ ${err}
   try {
     fs.existsSync(config.cookiePath)
     hasExistingConfigFile = true
+  // tslint:disable-next-line: no-unused
   } catch (ignored) {}
 
   if (hasExistingCookieFile) {
@@ -120,6 +134,4 @@ ${err}
   }
 }
 
-
-
 export default config

test/commands/hello.test.ts

@@ -0,0 +1,95 @@
+import {expect} from '@oclif/test'
+import * as fs from 'fs-extra'
+import * as path from 'path'
+
+import {tempDir} from './utils'
+
+const requireConfig = () => require('../src/config').default
+
+const cleanup = () => {
+  // delete config module cache
+  delete require.cache[require.resolve('../src/config')]
+
+  // reset env
+  process.env = {}
+}
+
+const setupConfigFile = () => {
+  const configDir = tempDir()
+  process.env.HMD_CLI_CONFIG_DIR = configDir
+  return path.join(configDir, 'config.json')
+}
+
+describe('Config test', function () {
+  beforeEach(function () {
+    cleanup()
+    this.configFilePath = setupConfigFile()
+  })
+
+  it('should throw no config error if config.json not found and no serverUrl set in env', function () {
+    expect(requireConfig)
+      .to.throw(new RegExp(`Configuration file at ${this.configFilePath} not readable`))
+  })
+
+  it('should throw read error if config.json is not valid JSON', function () {
+    fs.writeFileSync(this.configFilePath, '.', 'utf8')
+
+    expect(requireConfig)
+      .to.throw(/Could not read JSON config file at/)
+  })
+
+  it.skip('should throw error if no serverUrl is set', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    expect(requireConfig)
+      .to.throw(/Please specify CodiMD server URL either/)
+  })
+
+  it('should set enterprise to true if HMD_CLI_COOKIE_PATH or HMD_CLI_SERVER_URL are supplied', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    process.env.HMD_CLI_COOKIE_PATH = tempDir()
+    let config = requireConfig()
+
+    expect(config.cookiePath).to.eq(process.env.HMD_CLI_COOKIE_PATH)
+    expect(config.enterprise).to.eq(true)
+
+    cleanup()
+
+    process.env.HMD_CLI_SERVER_URL = tempDir()
+    config = requireConfig()
+
+    expect(config.serverUrl).to.eq(process.env.HMD_CLI_SERVER_URL)
+    expect(config.enterprise).to.eq(true)
+  })
+
+  it('should set enterprise to false if either CMD_CLI_COOKIE_PATH or CMD_CLI_SERVER_URL are supplied', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    process.env.CMD_CLI_SERVER_URL = tempDir()
+    let config = requireConfig()
+
+    expect(config.serverUrl).to.eq(process.env.CMD_CLI_SERVER_URL)
+    expect(config.enterprise).to.eq(false)
+
+    cleanup()
+
+    process.env.CMD_CLI_COOKIE_PATH = tempDir()
+    config = requireConfig()
+
+    expect(config.cookiePath).to.eq(process.env.CMD_CLI_COOKIE_PATH)
+    expect(config.enterprise).to.eq(false)
+  })
+
+  it('should set enterprise with HMD_CLI_ENTERPRISE', function () {
+    fs.writeFileSync(this.configFilePath, '{}', 'utf8')
+
+    process.env.HMD_CLI_ENTERPRISE = 'false'
+    expect(requireConfig().enterprise).to.eq(false)
+
+    cleanup()
+
+    process.env.HMD_CLI_ENTERPRISE = 'true'
+    expect(requireConfig().enterprise).to.eq(true)
+  })
+})

test/config.test.ts

@@ -0,0 +1,7 @@
+import * as fs from 'fs-extra'
+import * as os from 'os'
+import * as path from 'path'
+
+export function tempDir() {
+  return fs.mkdtempSync(path.join(os.tmpdir(), 'foo-'))
+}