config.ts 5.7 KB
Newer Older
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
1
/**
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
2
 *   Wechaty - https://github.com/chatie/wechaty
3
 *
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
4
 *   @copyright 2016-2018 Huan LI <zixia@zixia.net>
5 6 7 8 9 10 11 12 13 14 15 16
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
17
 *
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
18
 */
19 20 21 22
import * as fs    from 'fs'
import * as os    from 'os'
import * as path  from 'path'

23
import * as readPkgUp from 'read-pkg-up'
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
24
import * as Raven     from 'raven'
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
25
import { log }        from 'brolog'
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
26

27 28 29
import {
  PuppetName,
}             from './puppet-config'
30

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
31
const pkg = readPkgUp.sync({ cwd: __dirname }).pkg
32 33
export const VERSION = pkg.version

34 35 36 37 38 39 40 41 42 43
/**
 * Raven.io
 */
Raven.disableConsoleAlerts()

Raven
.config(
  process.env.NODE_ENV === 'production'
    && 'https://f6770399ee65459a82af82650231b22c:d8d11b283deb441e807079b8bb2c45cd@sentry.io/179672',
  {
44
    release: VERSION,
45
    tags: {
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
46
      git_commit: '',
47
      platform:   !!process.env['WECHATY_DOCKER']
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
                  ? 'docker'
                  : os.platform(),
    },
  },
)
.install()

/*
try {
    doSomething(a[0])
} catch (e) {
    Raven.captureException(e)
}

Raven.context(function () {
  doSomething(a[0])
})
 */
66

Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
67
const logLevel = process.env['WECHATY_LOG']
68
if (logLevel) {
69
  log.level(logLevel.toLowerCase() as any)
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
70
  log.silly('Config', 'WECHATY_LOG set level to %s', logLevel)
71 72 73 74 75
}

/**
 * to handle unhandled exceptions
 */
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
76
if (log.level() === 'verbose' || log.level() === 'silly') {
77 78 79 80 81 82
  log.info('Config', 'registering process.on("unhandledRejection") for development/debug')
  process.on('unhandledRejection', (reason, promise) => {
    log.error('Config', '###########################')
    log.error('Config', 'unhandledRejection: %s %s', reason, promise)
    log.error('Config', '###########################')
    promise.catch(err => {
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
83
      log.error('Config', 'process.on(unhandledRejection) promise.catch(%s)', err.message)
84 85 86
      console.error('Config', err) // I don't know if log.error has similar full trace print support like console.error
    })
  })
87
}
88

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
89
export interface DefaultSetting {
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
90 91
  DEFAULT_HEAD     : number,
  DEFAULT_PORT     : number,
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
92 93 94 95 96
  DEFAULT_PUPPET   : PuppetName,
  DEFAULT_APIHOST  : string,
  DEFAULT_PROFILE  : string,
  DEFAULT_TOKEN    : string,
  DEFAULT_PROTOCOL : string,
97
}
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
98

99 100
/* tslint:disable:variable-name */
/* tslint:disable:no-var-requires */
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
101
const DEFAULT_SETTING = pkg.wechaty as DefaultSetting
102

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
103 104
export class Config {
  public default = DEFAULT_SETTING
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
105

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
106 107 108
  public apihost = process.env['WECHATY_APIHOST']    || DEFAULT_SETTING.DEFAULT_APIHOST
  public head    = ('WECHATY_HEAD' in process.env) ? (!!process.env['WECHATY_HEAD']) : (!!(DEFAULT_SETTING.DEFAULT_HEAD))
  public puppet  = (process.env['WECHATY_PUPPET']    || DEFAULT_SETTING.DEFAULT_PUPPET) as PuppetName
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
109

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
110 111 112
  public profile = process.env['WECHATY_PROFILE']    || null    // DO NOT set DEFAULT_PROFILE, because sometimes user do not want to save session
  public token   = process.env['WECHATY_TOKEN']      || null    // DO NOT set DEFAULT, because sometimes user do not want to connect to io cloud service
  public debug   = !!(process.env['WECHATY_DEBUG'])
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
113

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
114 115
  public httpPort = process.env['PORT'] || process.env['WECHATY_PORT'] || DEFAULT_SETTING.DEFAULT_PORT
  public docker = !!(process.env['WECHATY_DOCKER'])
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
116

117
  // private _puppetInstance: Puppet | null = null
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
118 119 120 121 122

  constructor() {
    log.verbose('Config', 'constructor()')
    this.validApiHost(this.apihost)
  }
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
123

124
  /**
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
125
   * 5. live setting
126
   */
127 128 129
  // public puppetInstance(): Puppet
  // public puppetInstance(empty: null): void
  // public puppetInstance(instance: Puppet): void
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
130

131
  // public puppetInstance(instance?: Puppet | null): Puppet | void {
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
132

133 134 135 136 137
  //   if (typeof instance === 'undefined') {
  //     if (!this._puppetInstance) {
  //       throw new Error('no puppet instance')
  //     }
  //     return this._puppetInstance
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
138

139 140 141 142 143
  //   } else if (instance === null) {
  //     log.verbose('Config', 'puppetInstance(null)')
  //     this._puppetInstance = null
  //     return
  //   }
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
144

145 146 147
  //   log.verbose('Config', 'puppetInstance(%s)', instance.constructor.name)
  //   this._puppetInstance = instance
  //   return
148

149
  // }
150

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  public gitRevision(): string | null {
    const dotGitPath  = path.join(__dirname, '..', '.git') // only for ts-node, not for dist
    // const gitLogArgs  = ['log', '--oneline', '-1']
    // TODO: use git rev-parse HEAD ?
    const gitArgs  = ['rev-parse', 'HEAD']

    try {
      // Make sure this is a Wechaty repository
      fs.statSync(dotGitPath).isDirectory()

      const ss = require('child_process')
                  .spawnSync('git', gitArgs, { cwd:  __dirname })

      if (ss.status !== 0) {
        throw new Error(ss.error)
      }

      const revision = ss.stdout
                        .toString()
                        .trim()
                        .slice(0, 7)
      return revision

    } catch (e) { /* fall safe */
      /**
       *  1. .git not exist
       *  2. git log fail
       */
      log.silly('Wechaty', 'version() form development environment is not availble: %s', e.message)
      return null
181
    }
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
182
  }
183

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
184 185 186 187 188
  public validApiHost(apihost: string): boolean {
    if (/^[a-zA-Z0-9\.\-\_]+:?[0-9]*$/.test(apihost)) {
      return true
    }
    throw new Error('validApiHost() fail for ' + apihost)
189 190 191
  }
}

192
export interface Sayable {
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
193
  say(text: string, replyTo?: any|any[]): Promise<void>
194
}
Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
195

196
export {
Huan (李卓桓)'s avatar
wip...  
Huan (李卓桓) 已提交
197
  log,
198
  Raven,
199 200
}

Huan (李卓桓)'s avatar
Huan (李卓桓) 已提交
201
export const config = new Config()
202
export default config