Jonathan Christison
5 years ago
78 changed files with 12304 additions and 0 deletions
@ -0,0 +1,310 @@
|
||||
#!/bin/sh |
||||
# ---------------------------------------------------------------------------- |
||||
# Licensed to the Apache Software Foundation (ASF) under one |
||||
# or more contributor license agreements. See the NOTICE file |
||||
# distributed with this work for additional information |
||||
# regarding copyright ownership. The ASF licenses this file |
||||
# to you 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. |
||||
# ---------------------------------------------------------------------------- |
||||
|
||||
# ---------------------------------------------------------------------------- |
||||
# Maven Start Up Batch script |
||||
# |
||||
# Required ENV vars: |
||||
# ------------------ |
||||
# JAVA_HOME - location of a JDK home dir |
||||
# |
||||
# Optional ENV vars |
||||
# ----------------- |
||||
# M2_HOME - location of maven2's installed home dir |
||||
# MAVEN_OPTS - parameters passed to the Java VM when running Maven |
||||
# e.g. to debug Maven itself, use |
||||
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 |
||||
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files |
||||
# ---------------------------------------------------------------------------- |
||||
|
||||
if [ -z "$MAVEN_SKIP_RC" ] ; then |
||||
|
||||
if [ -f /etc/mavenrc ] ; then |
||||
. /etc/mavenrc |
||||
fi |
||||
|
||||
if [ -f "$HOME/.mavenrc" ] ; then |
||||
. "$HOME/.mavenrc" |
||||
fi |
||||
|
||||
fi |
||||
|
||||
# OS specific support. $var _must_ be set to either true or false. |
||||
cygwin=false; |
||||
darwin=false; |
||||
mingw=false |
||||
case "`uname`" in |
||||
CYGWIN*) cygwin=true ;; |
||||
MINGW*) mingw=true;; |
||||
Darwin*) darwin=true |
||||
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home |
||||
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html |
||||
if [ -z "$JAVA_HOME" ]; then |
||||
if [ -x "/usr/libexec/java_home" ]; then |
||||
export JAVA_HOME="`/usr/libexec/java_home`" |
||||
else |
||||
export JAVA_HOME="/Library/Java/Home" |
||||
fi |
||||
fi |
||||
;; |
||||
esac |
||||
|
||||
if [ -z "$JAVA_HOME" ] ; then |
||||
if [ -r /etc/gentoo-release ] ; then |
||||
JAVA_HOME=`java-config --jre-home` |
||||
fi |
||||
fi |
||||
|
||||
if [ -z "$M2_HOME" ] ; then |
||||
## resolve links - $0 may be a link to maven's home |
||||
PRG="$0" |
||||
|
||||
# need this for relative symlinks |
||||
while [ -h "$PRG" ] ; do |
||||
ls=`ls -ld "$PRG"` |
||||
link=`expr "$ls" : '.*-> \(.*\)$'` |
||||
if expr "$link" : '/.*' > /dev/null; then |
||||
PRG="$link" |
||||
else |
||||
PRG="`dirname "$PRG"`/$link" |
||||
fi |
||||
done |
||||
|
||||
saveddir=`pwd` |
||||
|
||||
M2_HOME=`dirname "$PRG"`/.. |
||||
|
||||
# make it fully qualified |
||||
M2_HOME=`cd "$M2_HOME" && pwd` |
||||
|
||||
cd "$saveddir" |
||||
# echo Using m2 at $M2_HOME |
||||
fi |
||||
|
||||
# For Cygwin, ensure paths are in UNIX format before anything is touched |
||||
if $cygwin ; then |
||||
[ -n "$M2_HOME" ] && |
||||
M2_HOME=`cygpath --unix "$M2_HOME"` |
||||
[ -n "$JAVA_HOME" ] && |
||||
JAVA_HOME=`cygpath --unix "$JAVA_HOME"` |
||||
[ -n "$CLASSPATH" ] && |
||||
CLASSPATH=`cygpath --path --unix "$CLASSPATH"` |
||||
fi |
||||
|
||||
# For Mingw, ensure paths are in UNIX format before anything is touched |
||||
if $mingw ; then |
||||
[ -n "$M2_HOME" ] && |
||||
M2_HOME="`(cd "$M2_HOME"; pwd)`" |
||||
[ -n "$JAVA_HOME" ] && |
||||
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" |
||||
fi |
||||
|
||||
if [ -z "$JAVA_HOME" ]; then |
||||
javaExecutable="`which javac`" |
||||
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then |
||||
# readlink(1) is not available as standard on Solaris 10. |
||||
readLink=`which readlink` |
||||
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then |
||||
if $darwin ; then |
||||
javaHome="`dirname \"$javaExecutable\"`" |
||||
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" |
||||
else |
||||
javaExecutable="`readlink -f \"$javaExecutable\"`" |
||||
fi |
||||
javaHome="`dirname \"$javaExecutable\"`" |
||||
javaHome=`expr "$javaHome" : '\(.*\)/bin'` |
||||
JAVA_HOME="$javaHome" |
||||
export JAVA_HOME |
||||
fi |
||||
fi |
||||
fi |
||||
|
||||
if [ -z "$JAVACMD" ] ; then |
||||
if [ -n "$JAVA_HOME" ] ; then |
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then |
||||
# IBM's JDK on AIX uses strange locations for the executables |
||||
JAVACMD="$JAVA_HOME/jre/sh/java" |
||||
else |
||||
JAVACMD="$JAVA_HOME/bin/java" |
||||
fi |
||||
else |
||||
JAVACMD="`which java`" |
||||
fi |
||||
fi |
||||
|
||||
if [ ! -x "$JAVACMD" ] ; then |
||||
echo "Error: JAVA_HOME is not defined correctly." >&2 |
||||
echo " We cannot execute $JAVACMD" >&2 |
||||
exit 1 |
||||
fi |
||||
|
||||
if [ -z "$JAVA_HOME" ] ; then |
||||
echo "Warning: JAVA_HOME environment variable is not set." |
||||
fi |
||||
|
||||
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher |
||||
|
||||
# traverses directory structure from process work directory to filesystem root |
||||
# first directory with .mvn subdirectory is considered project base directory |
||||
find_maven_basedir() { |
||||
|
||||
if [ -z "$1" ] |
||||
then |
||||
echo "Path not specified to find_maven_basedir" |
||||
return 1 |
||||
fi |
||||
|
||||
basedir="$1" |
||||
wdir="$1" |
||||
while [ "$wdir" != '/' ] ; do |
||||
if [ -d "$wdir"/.mvn ] ; then |
||||
basedir=$wdir |
||||
break |
||||
fi |
||||
# workaround for JBEAP-8937 (on Solaris 10/Sparc) |
||||
if [ -d "${wdir}" ]; then |
||||
wdir=`cd "$wdir/.."; pwd` |
||||
fi |
||||
# end of workaround |
||||
done |
||||
echo "${basedir}" |
||||
} |
||||
|
||||
# concatenates all lines of a file |
||||
concat_lines() { |
||||
if [ -f "$1" ]; then |
||||
echo "$(tr -s '\n' ' ' < "$1")" |
||||
fi |
||||
} |
||||
|
||||
BASE_DIR=`find_maven_basedir "$(pwd)"` |
||||
if [ -z "$BASE_DIR" ]; then |
||||
exit 1; |
||||
fi |
||||
|
||||
########################################################################################## |
||||
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central |
||||
# This allows using the maven wrapper in projects that prohibit checking in binary data. |
||||
########################################################################################## |
||||
if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Found .mvn/wrapper/maven-wrapper.jar" |
||||
fi |
||||
else |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." |
||||
fi |
||||
if [ -n "$MVNW_REPOURL" ]; then |
||||
jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" |
||||
else |
||||
jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" |
||||
fi |
||||
while IFS="=" read key value; do |
||||
case "$key" in (wrapperUrl) jarUrl="$value"; break ;; |
||||
esac |
||||
done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Downloading from: $jarUrl" |
||||
fi |
||||
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" |
||||
if $cygwin; then |
||||
wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` |
||||
fi |
||||
|
||||
if command -v wget > /dev/null; then |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Found wget ... using wget" |
||||
fi |
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then |
||||
wget "$jarUrl" -O "$wrapperJarPath" |
||||
else |
||||
wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" |
||||
fi |
||||
elif command -v curl > /dev/null; then |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Found curl ... using curl" |
||||
fi |
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then |
||||
curl -o "$wrapperJarPath" "$jarUrl" -f |
||||
else |
||||
curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f |
||||
fi |
||||
|
||||
else |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo "Falling back to using Java to download" |
||||
fi |
||||
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" |
||||
# For Cygwin, switch paths to Windows format before running javac |
||||
if $cygwin; then |
||||
javaClass=`cygpath --path --windows "$javaClass"` |
||||
fi |
||||
if [ -e "$javaClass" ]; then |
||||
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo " - Compiling MavenWrapperDownloader.java ..." |
||||
fi |
||||
# Compiling the Java class |
||||
("$JAVA_HOME/bin/javac" "$javaClass") |
||||
fi |
||||
if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then |
||||
# Running the downloader |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo " - Running MavenWrapperDownloader.java ..." |
||||
fi |
||||
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") |
||||
fi |
||||
fi |
||||
fi |
||||
fi |
||||
########################################################################################## |
||||
# End of extension |
||||
########################################################################################## |
||||
|
||||
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} |
||||
if [ "$MVNW_VERBOSE" = true ]; then |
||||
echo $MAVEN_PROJECTBASEDIR |
||||
fi |
||||
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" |
||||
|
||||
# For Cygwin, switch paths to Windows format before running java |
||||
if $cygwin; then |
||||
[ -n "$M2_HOME" ] && |
||||
M2_HOME=`cygpath --path --windows "$M2_HOME"` |
||||
[ -n "$JAVA_HOME" ] && |
||||
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` |
||||
[ -n "$CLASSPATH" ] && |
||||
CLASSPATH=`cygpath --path --windows "$CLASSPATH"` |
||||
[ -n "$MAVEN_PROJECTBASEDIR" ] && |
||||
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` |
||||
fi |
||||
|
||||
# Provide a "standardized" way to retrieve the CLI args that will |
||||
# work with both Windows and non-Windows executions. |
||||
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" |
||||
export MAVEN_CMD_LINE_ARGS |
||||
|
||||
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain |
||||
|
||||
exec "$JAVACMD" \ |
||||
$MAVEN_OPTS \ |
||||
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ |
||||
"-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ |
||||
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" |
||||
@ -0,0 +1,182 @@
|
||||
@REM ---------------------------------------------------------------------------- |
||||
@REM Licensed to the Apache Software Foundation (ASF) under one |
||||
@REM or more contributor license agreements. See the NOTICE file |
||||
@REM distributed with this work for additional information |
||||
@REM regarding copyright ownership. The ASF licenses this file |
||||
@REM to you under the Apache License, Version 2.0 (the |
||||
@REM "License"); you may not use this file except in compliance |
||||
@REM with the License. You may obtain a copy of the License at |
||||
@REM |
||||
@REM http://www.apache.org/licenses/LICENSE-2.0 |
||||
@REM |
||||
@REM Unless required by applicable law or agreed to in writing, |
||||
@REM software distributed under the License is distributed on an |
||||
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
||||
@REM KIND, either express or implied. See the License for the |
||||
@REM specific language governing permissions and limitations |
||||
@REM under the License. |
||||
@REM ---------------------------------------------------------------------------- |
||||
|
||||
@REM ---------------------------------------------------------------------------- |
||||
@REM Maven Start Up Batch script |
||||
@REM |
||||
@REM Required ENV vars: |
||||
@REM JAVA_HOME - location of a JDK home dir |
||||
@REM |
||||
@REM Optional ENV vars |
||||
@REM M2_HOME - location of maven2's installed home dir |
||||
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands |
||||
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending |
||||
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven |
||||
@REM e.g. to debug Maven itself, use |
||||
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 |
||||
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files |
||||
@REM ---------------------------------------------------------------------------- |
||||
|
||||
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' |
||||
@echo off |
||||
@REM set title of command window |
||||
title %0 |
||||
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' |
||||
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% |
||||
|
||||
@REM set %HOME% to equivalent of $HOME |
||||
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") |
||||
|
||||
@REM Execute a user defined script before this one |
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre |
||||
@REM check for pre script, once with legacy .bat ending and once with .cmd ending |
||||
if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" |
||||
if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" |
||||
:skipRcPre |
||||
|
||||
@setlocal |
||||
|
||||
set ERROR_CODE=0 |
||||
|
||||
@REM To isolate internal variables from possible post scripts, we use another setlocal |
||||
@setlocal |
||||
|
||||
@REM ==== START VALIDATION ==== |
||||
if not "%JAVA_HOME%" == "" goto OkJHome |
||||
|
||||
echo. |
||||
echo Error: JAVA_HOME not found in your environment. >&2 |
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2 |
||||
echo location of your Java installation. >&2 |
||||
echo. |
||||
goto error |
||||
|
||||
:OkJHome |
||||
if exist "%JAVA_HOME%\bin\java.exe" goto init |
||||
|
||||
echo. |
||||
echo Error: JAVA_HOME is set to an invalid directory. >&2 |
||||
echo JAVA_HOME = "%JAVA_HOME%" >&2 |
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2 |
||||
echo location of your Java installation. >&2 |
||||
echo. |
||||
goto error |
||||
|
||||
@REM ==== END VALIDATION ==== |
||||
|
||||
:init |
||||
|
||||
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". |
||||
@REM Fallback to current working directory if not found. |
||||
|
||||
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% |
||||
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir |
||||
|
||||
set EXEC_DIR=%CD% |
||||
set WDIR=%EXEC_DIR% |
||||
:findBaseDir |
||||
IF EXIST "%WDIR%"\.mvn goto baseDirFound |
||||
cd .. |
||||
IF "%WDIR%"=="%CD%" goto baseDirNotFound |
||||
set WDIR=%CD% |
||||
goto findBaseDir |
||||
|
||||
:baseDirFound |
||||
set MAVEN_PROJECTBASEDIR=%WDIR% |
||||
cd "%EXEC_DIR%" |
||||
goto endDetectBaseDir |
||||
|
||||
:baseDirNotFound |
||||
set MAVEN_PROJECTBASEDIR=%EXEC_DIR% |
||||
cd "%EXEC_DIR%" |
||||
|
||||
:endDetectBaseDir |
||||
|
||||
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig |
||||
|
||||
@setlocal EnableExtensions EnableDelayedExpansion |
||||
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a |
||||
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% |
||||
|
||||
:endReadAdditionalConfig |
||||
|
||||
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" |
||||
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" |
||||
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain |
||||
|
||||
set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" |
||||
|
||||
FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( |
||||
IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B |
||||
) |
||||
|
||||
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central |
||||
@REM This allows using the maven wrapper in projects that prohibit checking in binary data. |
||||
if exist %WRAPPER_JAR% ( |
||||
if "%MVNW_VERBOSE%" == "true" ( |
||||
echo Found %WRAPPER_JAR% |
||||
) |
||||
) else ( |
||||
if not "%MVNW_REPOURL%" == "" ( |
||||
SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" |
||||
) |
||||
if "%MVNW_VERBOSE%" == "true" ( |
||||
echo Couldn't find %WRAPPER_JAR%, downloading it ... |
||||
echo Downloading from: %DOWNLOAD_URL% |
||||
) |
||||
|
||||
powershell -Command "&{"^ |
||||
"$webclient = new-object System.Net.WebClient;"^ |
||||
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ |
||||
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ |
||||
"}"^ |
||||
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ |
||||
"}" |
||||
if "%MVNW_VERBOSE%" == "true" ( |
||||
echo Finished downloading %WRAPPER_JAR% |
||||
) |
||||
) |
||||
@REM End of extension |
||||
|
||||
@REM Provide a "standardized" way to retrieve the CLI args that will |
||||
@REM work with both Windows and non-Windows executions. |
||||
set MAVEN_CMD_LINE_ARGS=%* |
||||
|
||||
%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* |
||||
if ERRORLEVEL 1 goto error |
||||
goto end |
||||
|
||||
:error |
||||
set ERROR_CODE=1 |
||||
|
||||
:end |
||||
@endlocal & set ERROR_CODE=%ERROR_CODE% |
||||
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost |
||||
@REM check for post script, once with legacy .bat ending and once with .cmd ending |
||||
if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" |
||||
if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" |
||||
:skipRcPost |
||||
|
||||
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' |
||||
if "%MAVEN_BATCH_PAUSE%" == "on" pause |
||||
|
||||
if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% |
||||
|
||||
exit /B %ERROR_CODE% |
||||
@ -0,0 +1 @@
|
||||
../wscat/bin/wscat |
||||
@ -0,0 +1,145 @@
|
||||
agent-base |
||||
========== |
||||
### Turn a function into an [`http.Agent`][http.Agent] instance |
||||
[](https://github.com/TooTallNate/node-agent-base/actions?workflow=Node+CI) |
||||
|
||||
This module provides an `http.Agent` generator. That is, you pass it an async |
||||
callback function, and it returns a new `http.Agent` instance that will invoke the |
||||
given callback function when sending outbound HTTP requests. |
||||
|
||||
#### Some subclasses: |
||||
|
||||
Here's some more interesting uses of `agent-base`. |
||||
Send a pull request to list yours! |
||||
|
||||
* [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints |
||||
* [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints |
||||
* [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS |
||||
* [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS (v4a) proxy `http.Agent` implementation for HTTP and HTTPS |
||||
|
||||
|
||||
Installation |
||||
------------ |
||||
|
||||
Install with `npm`: |
||||
|
||||
``` bash |
||||
$ npm install agent-base |
||||
``` |
||||
|
||||
|
||||
Example |
||||
------- |
||||
|
||||
Here's a minimal example that creates a new `net.Socket` connection to the server |
||||
for every HTTP request (i.e. the equivalent of `agent: false` option): |
||||
|
||||
```js |
||||
var net = require('net'); |
||||
var tls = require('tls'); |
||||
var url = require('url'); |
||||
var http = require('http'); |
||||
var agent = require('agent-base'); |
||||
|
||||
var endpoint = 'http://nodejs.org/api/'; |
||||
var parsed = url.parse(endpoint); |
||||
|
||||
// This is the important part! |
||||
parsed.agent = agent(function (req, opts) { |
||||
var socket; |
||||
// `secureEndpoint` is true when using the https module |
||||
if (opts.secureEndpoint) { |
||||
socket = tls.connect(opts); |
||||
} else { |
||||
socket = net.connect(opts); |
||||
} |
||||
return socket; |
||||
}); |
||||
|
||||
// Everything else works just like normal... |
||||
http.get(parsed, function (res) { |
||||
console.log('"response" event!', res.headers); |
||||
res.pipe(process.stdout); |
||||
}); |
||||
``` |
||||
|
||||
Returning a Promise or using an `async` function is also supported: |
||||
|
||||
```js |
||||
agent(async function (req, opts) { |
||||
await sleep(1000); |
||||
// etc… |
||||
}); |
||||
``` |
||||
|
||||
Return another `http.Agent` instance to "pass through" the responsibility |
||||
for that HTTP request to that agent: |
||||
|
||||
```js |
||||
agent(function (req, opts) { |
||||
return opts.secureEndpoint ? https.globalAgent : http.globalAgent; |
||||
}); |
||||
``` |
||||
|
||||
|
||||
API |
||||
--- |
||||
|
||||
## Agent(Function callback[, Object options]) → [http.Agent][] |
||||
|
||||
Creates a base `http.Agent` that will execute the callback function `callback` |
||||
for every HTTP request that it is used as the `agent` for. The callback function |
||||
is responsible for creating a `stream.Duplex` instance of some kind that will be |
||||
used as the underlying socket in the HTTP request. |
||||
|
||||
The `options` object accepts the following properties: |
||||
|
||||
* `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional). |
||||
|
||||
The callback function should have the following signature: |
||||
|
||||
### callback(http.ClientRequest req, Object options, Function cb) → undefined |
||||
|
||||
The ClientRequest `req` can be accessed to read request headers and |
||||
and the path, etc. The `options` object contains the options passed |
||||
to the `http.request()`/`https.request()` function call, and is formatted |
||||
to be directly passed to `net.connect()`/`tls.connect()`, or however |
||||
else you want a Socket to be created. Pass the created socket to |
||||
the callback function `cb` once created, and the HTTP request will |
||||
continue to proceed. |
||||
|
||||
If the `https` module is used to invoke the HTTP request, then the |
||||
`secureEndpoint` property on `options` _will be set to `true`_. |
||||
|
||||
|
||||
License |
||||
------- |
||||
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
'Software'), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
|
||||
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent |
||||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent |
||||
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent |
||||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent |
||||
[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent |
||||
@ -0,0 +1,74 @@
|
||||
/// <reference types="node" />
|
||||
import net from 'net'; |
||||
import http from 'http'; |
||||
import https from 'https'; |
||||
import { Duplex } from 'stream'; |
||||
import { EventEmitter } from 'events'; |
||||
declare function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent; |
||||
declare function createAgent(callback: createAgent.AgentCallback, opts?: createAgent.AgentOptions): createAgent.Agent; |
||||
declare namespace createAgent { |
||||
interface ClientRequest extends http.ClientRequest { |
||||
_last?: boolean; |
||||
_hadError?: boolean; |
||||
method: string; |
||||
} |
||||
interface AgentRequestOptions { |
||||
host?: string; |
||||
path?: string; |
||||
port: number; |
||||
} |
||||
interface HttpRequestOptions extends AgentRequestOptions, Omit<http.RequestOptions, keyof AgentRequestOptions> { |
||||
secureEndpoint: false; |
||||
} |
||||
interface HttpsRequestOptions extends AgentRequestOptions, Omit<https.RequestOptions, keyof AgentRequestOptions> { |
||||
secureEndpoint: true; |
||||
} |
||||
type RequestOptions = HttpRequestOptions | HttpsRequestOptions; |
||||
type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent; |
||||
type AgentCallbackReturn = Duplex | AgentLike; |
||||
type AgentCallbackCallback = (err?: Error | null, socket?: createAgent.AgentCallbackReturn) => void; |
||||
type AgentCallbackPromise = (req: createAgent.ClientRequest, opts: createAgent.RequestOptions) => createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>; |
||||
type AgentCallback = typeof Agent.prototype.callback; |
||||
type AgentOptions = { |
||||
timeout?: number; |
||||
}; |
||||
/** |
||||
* Base `http.Agent` implementation. |
||||
* No pooling/keep-alive is implemented by default. |
||||
* |
||||
* @param {Function} callback |
||||
* @api public |
||||
*/ |
||||
class Agent extends EventEmitter { |
||||
timeout: number | null; |
||||
maxFreeSockets: number; |
||||
maxSockets: number; |
||||
sockets: { |
||||
[key: string]: net.Socket[]; |
||||
}; |
||||
requests: { |
||||
[key: string]: http.IncomingMessage[]; |
||||
}; |
||||
options: https.AgentOptions; |
||||
private promisifiedCallback?; |
||||
private explicitDefaultPort?; |
||||
private explicitProtocol?; |
||||
constructor(callback?: createAgent.AgentCallback | createAgent.AgentOptions, _opts?: createAgent.AgentOptions); |
||||
get defaultPort(): number; |
||||
set defaultPort(v: number); |
||||
get protocol(): string; |
||||
set protocol(v: string); |
||||
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions, fn: createAgent.AgentCallbackCallback): void; |
||||
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions): createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>; |
||||
/** |
||||
* Called by node-core's "_http_client.js" module when creating |
||||
* a new HTTP request with this Agent instance. |
||||
* |
||||
* @api public |
||||
*/ |
||||
addRequest(req: ClientRequest, _opts: RequestOptions): void; |
||||
freeSocket(socket: net.Socket, opts: AgentOptions): void; |
||||
destroy(): void; |
||||
} |
||||
} |
||||
export = createAgent; |
||||
@ -0,0 +1,201 @@
|
||||
"use strict"; |
||||
var __importDefault = (this && this.__importDefault) || function (mod) { |
||||
return (mod && mod.__esModule) ? mod : { "default": mod }; |
||||
}; |
||||
const events_1 = require("events"); |
||||
const debug_1 = __importDefault(require("debug")); |
||||
const promisify_1 = __importDefault(require("./promisify")); |
||||
const debug = debug_1.default('agent-base'); |
||||
function isAgent(v) { |
||||
return Boolean(v) && typeof v.addRequest === 'function'; |
||||
} |
||||
function isSecureEndpoint() { |
||||
const { stack } = new Error(); |
||||
if (typeof stack !== 'string') |
||||
return false; |
||||
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1); |
||||
} |
||||
function createAgent(callback, opts) { |
||||
return new createAgent.Agent(callback, opts); |
||||
} |
||||
(function (createAgent) { |
||||
/** |
||||
* Base `http.Agent` implementation. |
||||
* No pooling/keep-alive is implemented by default. |
||||
* |
||||
* @param {Function} callback |
||||
* @api public |
||||
*/ |
||||
class Agent extends events_1.EventEmitter { |
||||
constructor(callback, _opts) { |
||||
super(); |
||||
let opts = _opts; |
||||
if (typeof callback === 'function') { |
||||
this.callback = callback; |
||||
} |
||||
else if (callback) { |
||||
opts = callback; |
||||
} |
||||
// Timeout for the socket to be returned from the callback
|
||||
this.timeout = null; |
||||
if (opts && typeof opts.timeout === 'number') { |
||||
this.timeout = opts.timeout; |
||||
} |
||||
// These aren't actually used by `agent-base`, but are required
|
||||
// for the TypeScript definition files in `@types/node` :/
|
||||
this.maxFreeSockets = 1; |
||||
this.maxSockets = 1; |
||||
this.sockets = {}; |
||||
this.requests = {}; |
||||
this.options = {}; |
||||
} |
||||
get defaultPort() { |
||||
if (typeof this.explicitDefaultPort === 'number') { |
||||
return this.explicitDefaultPort; |
||||
} |
||||
return isSecureEndpoint() ? 443 : 80; |
||||
} |
||||
set defaultPort(v) { |
||||
this.explicitDefaultPort = v; |
||||
} |
||||
get protocol() { |
||||
if (typeof this.explicitProtocol === 'string') { |
||||
return this.explicitProtocol; |
||||
} |
||||
return isSecureEndpoint() ? 'https:' : 'http:'; |
||||
} |
||||
set protocol(v) { |
||||
this.explicitProtocol = v; |
||||
} |
||||
callback(req, opts, fn) { |
||||
throw new Error('"agent-base" has no default implementation, you must subclass and override `callback()`'); |
||||
} |
||||
/** |
||||
* Called by node-core's "_http_client.js" module when creating |
||||
* a new HTTP request with this Agent instance. |
||||
* |
||||
* @api public |
||||
*/ |
||||
addRequest(req, _opts) { |
||||
const opts = Object.assign({}, _opts); |
||||
if (typeof opts.secureEndpoint !== 'boolean') { |
||||
opts.secureEndpoint = isSecureEndpoint(); |
||||
} |
||||
if (opts.host == null) { |
||||
opts.host = 'localhost'; |
||||
} |
||||
if (opts.port == null) { |
||||
opts.port = opts.secureEndpoint ? 443 : 80; |
||||
} |
||||
if (opts.protocol == null) { |
||||
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:'; |
||||
} |
||||
if (opts.host && opts.path) { |
||||
// If both a `host` and `path` are specified then it's most
|
||||
// likely the result of a `url.parse()` call... we need to
|
||||
// remove the `path` portion so that `net.connect()` doesn't
|
||||
// attempt to open that as a unix socket file.
|
||||
delete opts.path; |
||||
} |
||||
delete opts.agent; |
||||
delete opts.hostname; |
||||
delete opts._defaultAgent; |
||||
delete opts.defaultPort; |
||||
delete opts.createConnection; |
||||
// Hint to use "Connection: close"
|
||||
// XXX: non-documented `http` module API :(
|
||||
req._last = true; |
||||
req.shouldKeepAlive = false; |
||||
let timedOut = false; |
||||
let timeoutId = null; |
||||
const timeoutMs = opts.timeout || this.timeout; |
||||
const onerror = (err) => { |
||||
if (req._hadError) |
||||
return; |
||||
req.emit('error', err); |
||||
// For Safety. Some additional errors might fire later on
|
||||
// and we need to make sure we don't double-fire the error event.
|
||||
req._hadError = true; |
||||
}; |
||||
const ontimeout = () => { |
||||
timeoutId = null; |
||||
timedOut = true; |
||||
const err = new Error(`A "socket" was not created for HTTP request before ${timeoutMs}ms`); |
||||
err.code = 'ETIMEOUT'; |
||||
onerror(err); |
||||
}; |
||||
const callbackError = (err) => { |
||||
if (timedOut) |
||||
return; |
||||
if (timeoutId !== null) { |
||||
clearTimeout(timeoutId); |
||||
timeoutId = null; |
||||
} |
||||
onerror(err); |
||||
}; |
||||
const onsocket = (socket) => { |
||||
if (timedOut) |
||||
return; |
||||
if (timeoutId != null) { |
||||
clearTimeout(timeoutId); |
||||
timeoutId = null; |
||||
} |
||||
if (isAgent(socket)) { |
||||
// `socket` is actually an `http.Agent` instance, so
|
||||
// relinquish responsibility for this `req` to the Agent
|
||||
// from here on
|
||||
debug('Callback returned another Agent instance %o', socket.constructor.name); |
||||
socket.addRequest(req, opts); |
||||
return; |
||||
} |
||||
if (socket) { |
||||
socket.once('free', () => { |
||||
this.freeSocket(socket, opts); |
||||
}); |
||||
req.onSocket(socket); |
||||
return; |
||||
} |
||||
const err = new Error(`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\``); |
||||
onerror(err); |
||||
}; |
||||
if (typeof this.callback !== 'function') { |
||||
onerror(new Error('`callback` is not defined')); |
||||
return; |
||||
} |
||||
if (!this.promisifiedCallback) { |
||||
if (this.callback.length >= 3) { |
||||
debug('Converting legacy callback function to promise'); |
||||
this.promisifiedCallback = promisify_1.default(this.callback); |
||||
} |
||||
else { |
||||
this.promisifiedCallback = this.callback; |
||||
} |
||||
} |
||||
if (typeof timeoutMs === 'number' && timeoutMs > 0) { |
||||
timeoutId = setTimeout(ontimeout, timeoutMs); |
||||
} |
||||
if ('port' in opts && typeof opts.port !== 'number') { |
||||
opts.port = Number(opts.port); |
||||
} |
||||
try { |
||||
debug('Resolving socket for %o request: %o', opts.protocol, `${req.method} ${req.path}`); |
||||
Promise.resolve(this.promisifiedCallback(req, opts)).then(onsocket, callbackError); |
||||
} |
||||
catch (err) { |
||||
Promise.reject(err).catch(callbackError); |
||||
} |
||||
} |
||||
freeSocket(socket, opts) { |
||||
debug('Freeing socket %o %o', socket.constructor.name, opts); |
||||
socket.destroy(); |
||||
} |
||||
destroy() { |
||||
debug('Destroying agent %o', this.constructor.name); |
||||
} |
||||
} |
||||
createAgent.Agent = Agent; |
||||
// So that `instanceof` works correctly
|
||||
createAgent.prototype = createAgent.Agent.prototype; |
||||
})(createAgent || (createAgent = {})); |
||||
module.exports = createAgent; |
||||
//# sourceMappingURL=index.js.map
|
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,4 @@
|
||||
import { ClientRequest, RequestOptions, AgentCallbackCallback, AgentCallbackPromise } from './index'; |
||||
declare type LegacyCallback = (req: ClientRequest, opts: RequestOptions, fn: AgentCallbackCallback) => void; |
||||
export default function promisify(fn: LegacyCallback): AgentCallbackPromise; |
||||
export {}; |
||||
@ -0,0 +1,18 @@
|
||||
"use strict"; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
function promisify(fn) { |
||||
return function (req, opts) { |
||||
return new Promise((resolve, reject) => { |
||||
fn.call(this, req, opts, (err, rtn) => { |
||||
if (err) { |
||||
reject(err); |
||||
} |
||||
else { |
||||
resolve(rtn); |
||||
} |
||||
}); |
||||
}); |
||||
}; |
||||
} |
||||
exports.default = promisify; |
||||
//# sourceMappingURL=promisify.js.map
|
||||
@ -0,0 +1 @@
|
||||
{"version":3,"file":"promisify.js","sourceRoot":"","sources":["../../src/promisify.ts"],"names":[],"mappings":";;AAeA,SAAwB,SAAS,CAAC,EAAkB;IACnD,OAAO,UAAsB,GAAkB,EAAE,IAAoB;QACpE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,EAAE,CAAC,IAAI,CACN,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,CAAC,GAA6B,EAAE,GAAyB,EAAE,EAAE;gBAC5D,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM;oBACN,OAAO,CAAC,GAAG,CAAC,CAAC;iBACb;YACF,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAjBD,4BAiBC"} |
||||
@ -0,0 +1,94 @@
|
||||
{ |
||||
"_from": "agent-base@6", |
||||
"_id": "agent-base@6.0.1", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-01q25QQDwLSsyfhrKbn8yuur+JNw0H+0Y4JiGIKd3z9aYk/w/2kxD/Upc+t2ZBBSUNff50VjPsSW2YxM8QYKVg==", |
||||
"_location": "/agent-base", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "agent-base@6", |
||||
"name": "agent-base", |
||||
"escapedName": "agent-base", |
||||
"rawSpec": "6", |
||||
"saveSpec": null, |
||||
"fetchSpec": "6" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/https-proxy-agent" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.1.tgz", |
||||
"_shasum": "808007e4e5867decb0ab6ab2f928fbdb5a596db4", |
||||
"_spec": "agent-base@6", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/https-proxy-agent", |
||||
"author": { |
||||
"name": "Nathan Rajlich", |
||||
"email": "nathan@tootallnate.net", |
||||
"url": "http://n8.io/" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/TooTallNate/node-agent-base/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"dependencies": { |
||||
"debug": "4" |
||||
}, |
||||
"deprecated": false, |
||||
"description": "Turn a function into an `http.Agent` instance", |
||||
"devDependencies": { |
||||
"@types/debug": "4", |
||||
"@types/mocha": "^5.2.7", |
||||
"@types/node": "^12.12.17", |
||||
"@types/semver": "^7.1.0", |
||||
"@types/ws": "^6.0.3", |
||||
"@typescript-eslint/eslint-plugin": "1.6.0", |
||||
"@typescript-eslint/parser": "1.1.0", |
||||
"async-listen": "^1.2.0", |
||||
"cpy-cli": "^2.0.0", |
||||
"eslint": "5.16.0", |
||||
"eslint-config-airbnb": "17.1.0", |
||||
"eslint-config-prettier": "4.1.0", |
||||
"eslint-import-resolver-typescript": "1.1.1", |
||||
"eslint-plugin-import": "2.16.0", |
||||
"eslint-plugin-jsx-a11y": "6.2.1", |
||||
"eslint-plugin-react": "7.12.4", |
||||
"mocha": "^6.2.0", |
||||
"rimraf": "^3.0.0", |
||||
"semver": "^7.1.2", |
||||
"typescript": "^3.5.3", |
||||
"ws": "^3.0.0" |
||||
}, |
||||
"engines": { |
||||
"node": ">= 6.0.0" |
||||
}, |
||||
"files": [ |
||||
"dist/src", |
||||
"src" |
||||
], |
||||
"homepage": "https://github.com/TooTallNate/node-agent-base#readme", |
||||
"keywords": [ |
||||
"http", |
||||
"agent", |
||||
"base", |
||||
"barebones", |
||||
"https" |
||||
], |
||||
"license": "MIT", |
||||
"main": "dist/src/index", |
||||
"name": "agent-base", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git://github.com/TooTallNate/node-agent-base.git" |
||||
}, |
||||
"scripts": { |
||||
"build": "tsc", |
||||
"postbuild": "cpy --parents src test '!**/*.ts' dist", |
||||
"prebuild": "rimraf dist", |
||||
"prepublishOnly": "npm run build", |
||||
"test": "mocha --reporter spec dist/test/*.js", |
||||
"test-lint": "eslint src --ext .js,.ts" |
||||
}, |
||||
"typings": "dist/src/index", |
||||
"version": "6.0.1" |
||||
} |
||||
@ -0,0 +1,339 @@
|
||||
import net from 'net'; |
||||
import http from 'http'; |
||||
import https from 'https'; |
||||
import { Duplex } from 'stream'; |
||||
import { EventEmitter } from 'events'; |
||||
import createDebug from 'debug'; |
||||
import promisify from './promisify'; |
||||
|
||||
const debug = createDebug('agent-base'); |
||||
|
||||
function isAgent(v: any): v is createAgent.AgentLike { |
||||
return Boolean(v) && typeof v.addRequest === 'function'; |
||||
} |
||||
|
||||
function isSecureEndpoint(): boolean { |
||||
const { stack } = new Error(); |
||||
if (typeof stack !== 'string') return false; |
||||
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1); |
||||
} |
||||
|
||||
function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent; |
||||
function createAgent( |
||||
callback: createAgent.AgentCallback, |
||||
opts?: createAgent.AgentOptions |
||||
): createAgent.Agent; |
||||
function createAgent( |
||||
callback?: createAgent.AgentCallback | createAgent.AgentOptions, |
||||
opts?: createAgent.AgentOptions |
||||
) { |
||||
return new createAgent.Agent(callback, opts); |
||||
} |
||||
|
||||
namespace createAgent { |
||||
export interface ClientRequest extends http.ClientRequest { |
||||
_last?: boolean; |
||||
_hadError?: boolean; |
||||
method: string; |
||||
} |
||||
|
||||
export interface AgentRequestOptions { |
||||
host?: string; |
||||
path?: string; |
||||
// `port` on `http.RequestOptions` can be a string or undefined,
|
||||
// but `net.TcpNetConnectOpts` expects only a number
|
||||
port: number; |
||||
} |
||||
|
||||
export interface HttpRequestOptions |
||||
extends AgentRequestOptions, |
||||
Omit<http.RequestOptions, keyof AgentRequestOptions> { |
||||
secureEndpoint: false; |
||||
} |
||||
|
||||
export interface HttpsRequestOptions |
||||
extends AgentRequestOptions, |
||||
Omit<https.RequestOptions, keyof AgentRequestOptions> { |
||||
secureEndpoint: true; |
||||
} |
||||
|
||||
export type RequestOptions = HttpRequestOptions | HttpsRequestOptions; |
||||
|
||||
export type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent; |
||||
|
||||
export type AgentCallbackReturn = Duplex | AgentLike; |
||||
|
||||
export type AgentCallbackCallback = ( |
||||
err?: Error | null, |
||||
socket?: createAgent.AgentCallbackReturn |
||||
) => void; |
||||
|
||||
export type AgentCallbackPromise = ( |
||||
req: createAgent.ClientRequest, |
||||
opts: createAgent.RequestOptions |
||||
) => |
||||
| createAgent.AgentCallbackReturn |
||||
| Promise<createAgent.AgentCallbackReturn>; |
||||
|
||||
export type AgentCallback = typeof Agent.prototype.callback; |
||||
|
||||
export type AgentOptions = { |
||||
timeout?: number; |
||||
}; |
||||
|
||||
/** |
||||
* Base `http.Agent` implementation. |
||||
* No pooling/keep-alive is implemented by default. |
||||
* |
||||
* @param {Function} callback |
||||
* @api public |
||||
*/ |
||||
export class Agent extends EventEmitter { |
||||
public timeout: number | null; |
||||
public maxFreeSockets: number; |
||||
public maxSockets: number; |
||||
public sockets: { |
||||
[key: string]: net.Socket[]; |
||||
}; |
||||
public requests: { |
||||
[key: string]: http.IncomingMessage[]; |
||||
}; |
||||
public options: https.AgentOptions; |
||||
private promisifiedCallback?: createAgent.AgentCallbackPromise; |
||||
private explicitDefaultPort?: number; |
||||
private explicitProtocol?: string; |
||||
|
||||
constructor( |
||||
callback?: createAgent.AgentCallback | createAgent.AgentOptions, |
||||
_opts?: createAgent.AgentOptions |
||||
) { |
||||
super(); |
||||
|
||||
let opts = _opts; |
||||
if (typeof callback === 'function') { |
||||
this.callback = callback; |
||||
} else if (callback) { |
||||
opts = callback; |
||||
} |
||||
|
||||
// Timeout for the socket to be returned from the callback
|
||||
this.timeout = null; |
||||
if (opts && typeof opts.timeout === 'number') { |
||||
this.timeout = opts.timeout; |
||||
} |
||||
|
||||
// These aren't actually used by `agent-base`, but are required
|
||||
// for the TypeScript definition files in `@types/node` :/
|
||||
this.maxFreeSockets = 1; |
||||
this.maxSockets = 1; |
||||
this.sockets = {}; |
||||
this.requests = {}; |
||||
this.options = {}; |
||||
} |
||||
|
||||
get defaultPort(): number { |
||||
if (typeof this.explicitDefaultPort === 'number') { |
||||
return this.explicitDefaultPort; |
||||
} |
||||
return isSecureEndpoint() ? 443 : 80; |
||||
} |
||||
|
||||
set defaultPort(v: number) { |
||||
this.explicitDefaultPort = v; |
||||
} |
||||
|
||||
get protocol(): string { |
||||
if (typeof this.explicitProtocol === 'string') { |
||||
return this.explicitProtocol; |
||||
} |
||||
return isSecureEndpoint() ? 'https:' : 'http:'; |
||||
} |
||||
|
||||
set protocol(v: string) { |
||||
this.explicitProtocol = v; |
||||
} |
||||
|
||||
callback( |
||||
req: createAgent.ClientRequest, |
||||
opts: createAgent.RequestOptions, |
||||
fn: createAgent.AgentCallbackCallback |
||||
): void; |
||||
callback( |
||||
req: createAgent.ClientRequest, |
||||
opts: createAgent.RequestOptions |
||||
): |
||||
| createAgent.AgentCallbackReturn |
||||
| Promise<createAgent.AgentCallbackReturn>; |
||||
callback( |
||||
req: createAgent.ClientRequest, |
||||
opts: createAgent.AgentOptions, |
||||
fn?: createAgent.AgentCallbackCallback |
||||
): |
||||
| createAgent.AgentCallbackReturn |
||||
| Promise<createAgent.AgentCallbackReturn> |
||||
| void { |
||||
throw new Error( |
||||
'"agent-base" has no default implementation, you must subclass and override `callback()`' |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* Called by node-core's "_http_client.js" module when creating |
||||
* a new HTTP request with this Agent instance. |
||||
* |
||||
* @api public |
||||
*/ |
||||
addRequest(req: ClientRequest, _opts: RequestOptions): void { |
||||
const opts: RequestOptions = { ..._opts }; |
||||
|
||||
if (typeof opts.secureEndpoint !== 'boolean') { |
||||
opts.secureEndpoint = isSecureEndpoint(); |
||||
} |
||||
|
||||
if (opts.host == null) { |
||||
opts.host = 'localhost'; |
||||
} |
||||
|
||||
if (opts.port == null) { |
||||
opts.port = opts.secureEndpoint ? 443 : 80; |
||||
} |
||||
|
||||
if (opts.protocol == null) { |
||||
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:'; |
||||
} |
||||
|
||||
if (opts.host && opts.path) { |
||||
// If both a `host` and `path` are specified then it's most
|
||||
// likely the result of a `url.parse()` call... we need to
|
||||
// remove the `path` portion so that `net.connect()` doesn't
|
||||
// attempt to open that as a unix socket file.
|
||||
delete opts.path; |
||||
} |
||||
|
||||
delete opts.agent; |
||||
delete opts.hostname; |
||||
delete opts._defaultAgent; |
||||
delete opts.defaultPort; |
||||
delete opts.createConnection; |
||||
|
||||
// Hint to use "Connection: close"
|
||||
// XXX: non-documented `http` module API :(
|
||||
req._last = true; |
||||
req.shouldKeepAlive = false; |
||||
|
||||
let timedOut = false; |
||||
let timeoutId: ReturnType<typeof setTimeout> | null = null; |
||||
const timeoutMs = opts.timeout || this.timeout; |
||||
|
||||
const onerror = (err: NodeJS.ErrnoException) => { |
||||
if (req._hadError) return; |
||||
req.emit('error', err); |
||||
// For Safety. Some additional errors might fire later on
|
||||
// and we need to make sure we don't double-fire the error event.
|
||||
req._hadError = true; |
||||
}; |
||||
|
||||
const ontimeout = () => { |
||||
timeoutId = null; |
||||
timedOut = true; |
||||
const err: NodeJS.ErrnoException = new Error( |
||||
`A "socket" was not created for HTTP request before ${timeoutMs}ms` |
||||
); |
||||
err.code = 'ETIMEOUT'; |
||||
onerror(err); |
||||
}; |
||||
|
||||
const callbackError = (err: NodeJS.ErrnoException) => { |
||||
if (timedOut) return; |
||||
if (timeoutId !== null) { |
||||
clearTimeout(timeoutId); |
||||
timeoutId = null; |
||||
} |
||||
onerror(err); |
||||
}; |
||||
|
||||
const onsocket = (socket: AgentCallbackReturn) => { |
||||
if (timedOut) return; |
||||
if (timeoutId != null) { |
||||
clearTimeout(timeoutId); |
||||
timeoutId = null; |
||||
} |
||||
|
||||
if (isAgent(socket)) { |
||||
// `socket` is actually an `http.Agent` instance, so
|
||||
// relinquish responsibility for this `req` to the Agent
|
||||
// from here on
|
||||
debug( |
||||
'Callback returned another Agent instance %o', |
||||
socket.constructor.name |
||||
); |
||||
(socket as createAgent.Agent).addRequest(req, opts); |
||||
return; |
||||
} |
||||
|
||||
if (socket) { |
||||
socket.once('free', () => { |
||||
this.freeSocket(socket as net.Socket, opts); |
||||
}); |
||||
req.onSocket(socket as net.Socket); |
||||
return; |
||||
} |
||||
|
||||
const err = new Error( |
||||
`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\`` |
||||
); |
||||
onerror(err); |
||||
}; |
||||
|
||||
if (typeof this.callback !== 'function') { |
||||
onerror(new Error('`callback` is not defined')); |
||||
return; |
||||
} |
||||
|
||||
if (!this.promisifiedCallback) { |
||||
if (this.callback.length >= 3) { |
||||
debug('Converting legacy callback function to promise'); |
||||
this.promisifiedCallback = promisify(this.callback); |
||||
} else { |
||||
this.promisifiedCallback = this.callback; |
||||
} |
||||
} |
||||
|
||||
if (typeof timeoutMs === 'number' && timeoutMs > 0) { |
||||
timeoutId = setTimeout(ontimeout, timeoutMs); |
||||
} |
||||
|
||||
if ('port' in opts && typeof opts.port !== 'number') { |
||||
opts.port = Number(opts.port); |
||||
} |
||||
|
||||
try { |
||||
debug( |
||||
'Resolving socket for %o request: %o', |
||||
opts.protocol, |
||||
`${req.method} ${req.path}` |
||||
); |
||||
Promise.resolve(this.promisifiedCallback(req, opts)).then( |
||||
onsocket, |
||||
callbackError |
||||
); |
||||
} catch (err) { |
||||
Promise.reject(err).catch(callbackError); |
||||
} |
||||
} |
||||
|
||||
freeSocket(socket: net.Socket, opts: AgentOptions) { |
||||
debug('Freeing socket %o %o', socket.constructor.name, opts); |
||||
socket.destroy(); |
||||
} |
||||
|
||||
destroy() { |
||||
debug('Destroying agent %o', this.constructor.name); |
||||
} |
||||
} |
||||
|
||||
// So that `instanceof` works correctly
|
||||
createAgent.prototype = createAgent.Agent.prototype; |
||||
} |
||||
|
||||
export = createAgent; |
||||
@ -0,0 +1,33 @@
|
||||
import { |
||||
Agent, |
||||
ClientRequest, |
||||
RequestOptions, |
||||
AgentCallbackCallback, |
||||
AgentCallbackPromise, |
||||
AgentCallbackReturn |
||||
} from './index'; |
||||
|
||||
type LegacyCallback = ( |
||||
req: ClientRequest, |
||||
opts: RequestOptions, |
||||
fn: AgentCallbackCallback |
||||
) => void; |
||||
|
||||
export default function promisify(fn: LegacyCallback): AgentCallbackPromise { |
||||
return function(this: Agent, req: ClientRequest, opts: RequestOptions) { |
||||
return new Promise((resolve, reject) => { |
||||
fn.call( |
||||
this, |
||||
req, |
||||
opts, |
||||
(err: Error | null | undefined, rtn?: AgentCallbackReturn) => { |
||||
if (err) { |
||||
reject(err); |
||||
} else { |
||||
resolve(rtn); |
||||
} |
||||
} |
||||
); |
||||
}); |
||||
}; |
||||
} |
||||
@ -0,0 +1,22 @@
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
'Software'), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -0,0 +1,737 @@
|
||||
# Commander.js |
||||
|
||||
[](http://travis-ci.org/tj/commander.js) |
||||
[](https://www.npmjs.org/package/commander) |
||||
[](https://npmcharts.com/compare/commander?minimal=true) |
||||
[](https://packagephobia.now.sh/result?p=commander) |
||||
|
||||
The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/commander-rb/commander). |
||||
|
||||
Read this in other languages: English | [简体中文](./Readme_zh-CN.md) |
||||
|
||||
- [Commander.js](#commanderjs) |
||||
- [Installation](#installation) |
||||
- [Declaring _program_ variable](#declaring-program-variable) |
||||
- [Options](#options) |
||||
- [Common option types, boolean and value](#common-option-types-boolean-and-value) |
||||
- [Default option value](#default-option-value) |
||||
- [Other option types, negatable boolean and flag|value](#other-option-types-negatable-boolean-and-flagvalue) |
||||
- [Custom option processing](#custom-option-processing) |
||||
- [Required option](#required-option) |
||||
- [Version option](#version-option) |
||||
- [Commands](#commands) |
||||
- [Specify the argument syntax](#specify-the-argument-syntax) |
||||
- [Action handler (sub)commands](#action-handler-subcommands) |
||||
- [Stand-alone executable (sub)commands](#stand-alone-executable-subcommands) |
||||
- [Automated help](#automated-help) |
||||
- [Custom help](#custom-help) |
||||
- [.usage and .name](#usage-and-name) |
||||
- [.help(cb)](#helpcb) |
||||
- [.outputHelp(cb)](#outputhelpcb) |
||||
- [.helpInformation()](#helpinformation) |
||||
- [.helpOption(flags, description)](#helpoptionflags-description) |
||||
- [.addHelpCommand()](#addhelpcommand) |
||||
- [Custom event listeners](#custom-event-listeners) |
||||
- [Bits and pieces](#bits-and-pieces) |
||||
- [.parse() and .parseAsync()](#parse-and-parseasync) |
||||
- [Avoiding option name clashes](#avoiding-option-name-clashes) |
||||
- [TypeScript](#typescript) |
||||
- [createCommand()](#createcommand) |
||||
- [Node options such as `--harmony`](#node-options-such-as---harmony) |
||||
- [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands) |
||||
- [Override exit handling](#override-exit-handling) |
||||
- [Examples](#examples) |
||||
- [License](#license) |
||||
- [Support](#support) |
||||
- [Commander for enterprise](#commander-for-enterprise) |
||||
|
||||
## Installation |
||||
|
||||
```bash |
||||
npm install commander |
||||
``` |
||||
|
||||
## Declaring _program_ variable |
||||
|
||||
Commander exports a global object which is convenient for quick programs. |
||||
This is used in the examples in this README for brevity. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
program.version('0.0.1'); |
||||
``` |
||||
|
||||
For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local Command object to use. |
||||
|
||||
```js |
||||
const { Command } = require('commander'); |
||||
const program = new Command(); |
||||
program.version('0.0.1'); |
||||
``` |
||||
|
||||
## Options |
||||
|
||||
Options are defined with the `.option()` method, also serving as documentation for the options. Each option can have a short flag (single character) and a long name, separated by a comma or space or vertical bar ('|'). |
||||
|
||||
The options can be accessed as properties on the Command object. Multi-word options such as "--template-engine" are camel-cased, becoming `program.templateEngine` etc. See also optional new behaviour to [avoid name clashes](#avoiding-option-name-clashes). |
||||
|
||||
Multiple short flags may optionally be combined in a single argument following the dash: boolean flags, the last flag may take a value, and the value. |
||||
For example `-a -b -p 80` may be written as `-ab -p80` or even `-abp80`. |
||||
|
||||
You can use `--` to indicate the end of the options, and any remaining arguments will be used without being interpreted. |
||||
This is particularly useful for passing options through to another |
||||
command, like: `do -- git --version`. |
||||
|
||||
Options on the command line are not positional, and can be specified before or after other command arguments. |
||||
|
||||
### Common option types, boolean and value |
||||
|
||||
The two most used option types are a boolean flag, and an option which takes a value (declared using angle brackets). Both are `undefined` unless specified on command line. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.option('-d, --debug', 'output extra debugging') |
||||
.option('-s, --small', 'small pizza size') |
||||
.option('-p, --pizza-type <type>', 'flavour of pizza'); |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
if (program.debug) console.log(program.opts()); |
||||
console.log('pizza details:'); |
||||
if (program.small) console.log('- small pizza size'); |
||||
if (program.pizzaType) console.log(`- ${program.pizzaType}`); |
||||
``` |
||||
|
||||
```bash |
||||
$ pizza-options -d |
||||
{ debug: true, small: undefined, pizzaType: undefined } |
||||
pizza details: |
||||
$ pizza-options -p |
||||
error: option '-p, --pizza-type <type>' argument missing |
||||
$ pizza-options -ds -p vegetarian |
||||
{ debug: true, small: true, pizzaType: 'vegetarian' } |
||||
pizza details: |
||||
- small pizza size |
||||
- vegetarian |
||||
$ pizza-options --pizza-type=cheese |
||||
pizza details: |
||||
- cheese |
||||
``` |
||||
|
||||
`program.parse(arguments)` processes the arguments, leaving any args not consumed by the program options in the `program.args` array. |
||||
|
||||
### Default option value |
||||
|
||||
You can specify a default value for an option which takes a value. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.option('-c, --cheese <type>', 'add the specified type of cheese', 'blue'); |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
console.log(`cheese: ${program.cheese}`); |
||||
``` |
||||
|
||||
```bash |
||||
$ pizza-options |
||||
cheese: blue |
||||
$ pizza-options --cheese stilton |
||||
cheese: stilton |
||||
``` |
||||
|
||||
### Other option types, negatable boolean and flag|value |
||||
|
||||
You can specify a boolean option long name with a leading `no-` to set the option value to false when used. |
||||
Defined alone this also makes the option true by default. |
||||
|
||||
If you define `--foo` first, adding `--no-foo` does not change the default value from what it would |
||||
otherwise be. You can specify a default boolean value for a boolean flag and it can be overridden on command line. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.option('--no-sauce', 'Remove sauce') |
||||
.option('--cheese <flavour>', 'cheese flavour', 'mozzarella') |
||||
.option('--no-cheese', 'plain with no cheese') |
||||
.parse(process.argv); |
||||
|
||||
const sauceStr = program.sauce ? 'sauce' : 'no sauce'; |
||||
const cheeseStr = (program.cheese === false) ? 'no cheese' : `${program.cheese} cheese`; |
||||
console.log(`You ordered a pizza with ${sauceStr} and ${cheeseStr}`); |
||||
``` |
||||
|
||||
```bash |
||||
$ pizza-options |
||||
You ordered a pizza with sauce and mozzarella cheese |
||||
$ pizza-options --sauce |
||||
error: unknown option '--sauce' |
||||
$ pizza-options --cheese=blue |
||||
You ordered a pizza with sauce and blue cheese |
||||
$ pizza-options --no-sauce --no-cheese |
||||
You ordered a pizza with no sauce and no cheese |
||||
``` |
||||
|
||||
You can specify an option which functions as a flag but may also take a value (declared using square brackets). |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.option('-c, --cheese [type]', 'Add cheese with optional type'); |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
if (program.cheese === undefined) console.log('no cheese'); |
||||
else if (program.cheese === true) console.log('add cheese'); |
||||
else console.log(`add cheese type ${program.cheese}`); |
||||
``` |
||||
|
||||
```bash |
||||
$ pizza-options |
||||
no cheese |
||||
$ pizza-options --cheese |
||||
add cheese |
||||
$ pizza-options --cheese mozzarella |
||||
add cheese type mozzarella |
||||
``` |
||||
|
||||
### Custom option processing |
||||
|
||||
You may specify a function to do custom processing of option values. The callback function receives two parameters, the user specified value and the |
||||
previous value for the option. It returns the new value for the option. |
||||
|
||||
This allows you to coerce the option value to the desired type, or accumulate values, or do entirely custom processing. |
||||
|
||||
You can optionally specify the default/starting value for the option after the function. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
function myParseInt(value, dummyPrevious) { |
||||
// parseInt takes a string and an optional radix |
||||
return parseInt(value); |
||||
} |
||||
|
||||
function increaseVerbosity(dummyValue, previous) { |
||||
return previous + 1; |
||||
} |
||||
|
||||
function collect(value, previous) { |
||||
return previous.concat([value]); |
||||
} |
||||
|
||||
function commaSeparatedList(value, dummyPrevious) { |
||||
return value.split(','); |
||||
} |
||||
|
||||
program |
||||
.option('-f, --float <number>', 'float argument', parseFloat) |
||||
.option('-i, --integer <number>', 'integer argument', myParseInt) |
||||
.option('-v, --verbose', 'verbosity that can be increased', increaseVerbosity, 0) |
||||
.option('-c, --collect <value>', 'repeatable value', collect, []) |
||||
.option('-l, --list <items>', 'comma separated list', commaSeparatedList) |
||||
; |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
if (program.float !== undefined) console.log(`float: ${program.float}`); |
||||
if (program.integer !== undefined) console.log(`integer: ${program.integer}`); |
||||
if (program.verbose > 0) console.log(`verbosity: ${program.verbose}`); |
||||
if (program.collect.length > 0) console.log(program.collect); |
||||
if (program.list !== undefined) console.log(program.list); |
||||
``` |
||||
|
||||
```bash |
||||
$ custom -f 1e2 |
||||
float: 100 |
||||
$ custom --integer 2 |
||||
integer: 2 |
||||
$ custom -v -v -v |
||||
verbose: 3 |
||||
$ custom -c a -c b -c c |
||||
[ 'a', 'b', 'c' ] |
||||
$ custom --list x,y,z |
||||
[ 'x', 'y', 'z' ] |
||||
``` |
||||
|
||||
### Required option |
||||
|
||||
You may specify a required (mandatory) option using `.requiredOption`. The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (say from environment). The method is otherwise the same as `.option` in format, taking flags and description, and optional default value or custom processing. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.requiredOption('-c, --cheese <type>', 'pizza must have cheese'); |
||||
|
||||
program.parse(process.argv); |
||||
``` |
||||
|
||||
```bash |
||||
$ pizza |
||||
error: required option '-c, --cheese <type>' not specified |
||||
``` |
||||
|
||||
### Version option |
||||
|
||||
The optional `version` method adds handling for displaying the command version. The default option flags are `-V` and `--version`, and when present the command prints the version number and exits. |
||||
|
||||
```js |
||||
program.version('0.0.1'); |
||||
``` |
||||
|
||||
```bash |
||||
$ ./examples/pizza -V |
||||
0.0.1 |
||||
``` |
||||
|
||||
You may change the flags and description by passing additional parameters to the `version` method, using |
||||
the same syntax for flags as the `option` method. The version flags can be named anything, but a long name is required. |
||||
|
||||
```js |
||||
program.version('0.0.1', '-v, --vers', 'output the current version'); |
||||
``` |
||||
|
||||
## Commands |
||||
|
||||
You can specify (sub)commands using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested ([example](./examples/nestedCommands.js)). |
||||
|
||||
In the first parameter to `.command()` you specify the command name and any command arguments. The arguments may be `<required>` or `[optional]`, and the last argument may also be `variadic...`. |
||||
|
||||
You can use `.addCommand()` to add an already configured subcommand to the program. |
||||
|
||||
For example: |
||||
|
||||
```js |
||||
// Command implemented using action handler (description is supplied separately to `.command`) |
||||
// Returns new command for configuring. |
||||
program |
||||
.command('clone <source> [destination]') |
||||
.description('clone a repository into a newly created directory') |
||||
.action((source, destination) => { |
||||
console.log('clone command called'); |
||||
}); |
||||
|
||||
// Command implemented using stand-alone executable file (description is second parameter to `.command`) |
||||
// Returns `this` for adding more commands. |
||||
program |
||||
.command('start <service>', 'start named service') |
||||
.command('stop [service]', 'stop named service, or all if no name supplied'); |
||||
|
||||
// Command prepared separately. |
||||
// Returns `this` for adding more commands. |
||||
program |
||||
.addCommand(build.makeBuildCommand()); |
||||
``` |
||||
|
||||
Configuration options can be passed with the call to `.command()` and `.addCommand()`. Specifying `true` for `opts.hidden` will remove the command from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified ([example](./examples/defaultCommand.js)). |
||||
|
||||
### Specify the argument syntax |
||||
|
||||
You use `.arguments` to specify the arguments for the top-level command, and for subcommands they are usually included in the `.command` call. Angled brackets (e.g. `<required>`) indicate required input. Square brackets (e.g. `[optional]`) indicate optional input. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.version('0.1.0') |
||||
.arguments('<cmd> [env]') |
||||
.action(function (cmd, env) { |
||||
cmdValue = cmd; |
||||
envValue = env; |
||||
}); |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
if (typeof cmdValue === 'undefined') { |
||||
console.error('no command given!'); |
||||
process.exit(1); |
||||
} |
||||
console.log('command:', cmdValue); |
||||
console.log('environment:', envValue || "no environment given"); |
||||
``` |
||||
|
||||
The last argument of a command can be variadic, and only the last argument. To make an argument variadic you |
||||
append `...` to the argument name. For example: |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.version('0.1.0') |
||||
.command('rmdir <dir> [otherDirs...]') |
||||
.action(function (dir, otherDirs) { |
||||
console.log('rmdir %s', dir); |
||||
if (otherDirs) { |
||||
otherDirs.forEach(function (oDir) { |
||||
console.log('rmdir %s', oDir); |
||||
}); |
||||
} |
||||
}); |
||||
|
||||
program.parse(process.argv); |
||||
``` |
||||
|
||||
The variadic argument is passed to the action handler as an array. |
||||
|
||||
### Action handler (sub)commands |
||||
|
||||
You can add options to a command that uses an action handler. |
||||
The action handler gets passed a parameter for each argument you declared, and one additional argument which is the |
||||
command object itself. This command argument has the values for the command-specific options added as properties. |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.command('rm <dir>') |
||||
.option('-r, --recursive', 'Remove recursively') |
||||
.action(function (dir, cmdObj) { |
||||
console.log('remove ' + dir + (cmdObj.recursive ? ' recursively' : '')) |
||||
}) |
||||
|
||||
program.parse(process.argv) |
||||
``` |
||||
|
||||
You may supply an `async` action handler, in which case you call `.parseAsync` rather than `.parse`. |
||||
|
||||
```js |
||||
async function run() { /* code goes here */ } |
||||
|
||||
async function main() { |
||||
program |
||||
.command('run') |
||||
.action(run); |
||||
await program.parseAsync(process.argv); |
||||
} |
||||
``` |
||||
|
||||
A command's options on the command line are validated when the command is used. Any unknown options will be reported as an error. |
||||
|
||||
### Stand-alone executable (sub)commands |
||||
|
||||
When `.command()` is invoked with a description argument, this tells Commander that you're going to use stand-alone executables for subcommands. |
||||
Commander will search the executables in the directory of the entry script (like `./examples/pm`) with the name `program-subcommand`, like `pm-install`, `pm-search`. |
||||
You can specify a custom name with the `executableFile` configuration option. |
||||
|
||||
You handle the options for an executable (sub)command in the executable, and don't declare them at the top-level. |
||||
|
||||
```js |
||||
// file: ./examples/pm |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.version('0.1.0') |
||||
.command('install [name]', 'install one or more packages') |
||||
.command('search [query]', 'search with optional query') |
||||
.command('update', 'update installed packages', {executableFile: 'myUpdateSubCommand'}) |
||||
.command('list', 'list packages installed', {isDefault: true}) |
||||
.parse(process.argv); |
||||
``` |
||||
|
||||
If the program is designed to be installed globally, make sure the executables have proper modes, like `755`. |
||||
|
||||
## Automated help |
||||
|
||||
The help information is auto-generated based on the information commander already knows about your program. The default |
||||
help option is `-h,--help`. ([example](./examples/pizza)) |
||||
|
||||
```bash |
||||
$ node ./examples/pizza --help |
||||
Usage: pizza [options] |
||||
|
||||
An application for pizzas ordering |
||||
|
||||
Options: |
||||
-V, --version output the version number |
||||
-p, --peppers Add peppers |
||||
-c, --cheese <type> Add the specified type of cheese (default: "marble") |
||||
-C, --no-cheese You do not want any cheese |
||||
-h, --help display help for command |
||||
``` |
||||
|
||||
A `help` command is added by default if your command has subcommands. It can be used alone, or with a subcommand name to show |
||||
further help for the subcommand. These are effectively the same if the `shell` program has implicit help: |
||||
|
||||
```bash |
||||
shell help |
||||
shell --help |
||||
|
||||
shell help spawn |
||||
shell spawn --help |
||||
``` |
||||
|
||||
### Custom help |
||||
|
||||
You can display extra information by listening for "--help". ([example](./examples/custom-help)) |
||||
|
||||
```js |
||||
program |
||||
.option('-f, --foo', 'enable some foo'); |
||||
|
||||
// must be before .parse() |
||||
program.on('--help', () => { |
||||
console.log(''); |
||||
console.log('Example call:'); |
||||
console.log(' $ custom-help --help'); |
||||
}); |
||||
``` |
||||
|
||||
Yields the following help output: |
||||
|
||||
```Text |
||||
Usage: custom-help [options] |
||||
|
||||
Options: |
||||
-f, --foo enable some foo |
||||
-h, --help display help for command |
||||
|
||||
Example call: |
||||
$ custom-help --help |
||||
``` |
||||
|
||||
### .usage and .name |
||||
|
||||
These allow you to customise the usage description in the first line of the help. The name is otherwise |
||||
deduced from the (full) program arguments. Given: |
||||
|
||||
```js |
||||
program |
||||
.name("my-command") |
||||
.usage("[global options] command") |
||||
``` |
||||
|
||||
The help will start with: |
||||
|
||||
```Text |
||||
Usage: my-command [global options] command |
||||
``` |
||||
|
||||
### .help(cb) |
||||
|
||||
Output help information and exit immediately. Optional callback cb allows post-processing of help text before it is displayed. |
||||
|
||||
### .outputHelp(cb) |
||||
|
||||
Output help information without exiting. |
||||
Optional callback cb allows post-processing of help text before it is displayed. |
||||
|
||||
### .helpInformation() |
||||
|
||||
Get the command help information as a string for processing or displaying yourself. (The text does not include the custom help |
||||
from `--help` listeners.) |
||||
|
||||
### .helpOption(flags, description) |
||||
|
||||
Override the default help flags and description. |
||||
|
||||
```js |
||||
program |
||||
.helpOption('-e, --HELP', 'read more information'); |
||||
``` |
||||
|
||||
### .addHelpCommand() |
||||
|
||||
You can explicitly turn on or off the implicit help command with `.addHelpCommand()` and `.addHelpCommand(false)`. |
||||
|
||||
You can both turn on and customise the help command by supplying the name and description: |
||||
|
||||
```js |
||||
program.addHelpCommand('assist [command]', 'show assistance'); |
||||
``` |
||||
|
||||
## Custom event listeners |
||||
|
||||
You can execute custom actions by listening to command and option events. |
||||
|
||||
```js |
||||
program.on('option:verbose', function () { |
||||
process.env.VERBOSE = this.verbose; |
||||
}); |
||||
|
||||
program.on('command:*', function (operands) { |
||||
console.error(`error: unknown command '${operands[0]}'`); |
||||
const availableCommands = program.commands.map(cmd => cmd.name()); |
||||
mySuggestBestMatch(operands[0], availableCommands); |
||||
process.exitCode = 1; |
||||
}); |
||||
``` |
||||
|
||||
## Bits and pieces |
||||
|
||||
### .parse() and .parseAsync() |
||||
|
||||
The first argument to `.parse` is the array of strings to parse. You may omit the parameter to implicitly use `process.argv`. |
||||
|
||||
If the arguments follow different conventions than node you can pass a `from` option in the second parameter: |
||||
|
||||
- 'node': default, `argv[0]` is the application and `argv[1]` is the script being run, with user parameters after that |
||||
- 'electron': `argv[1]` varies depending on whether the electron application is packaged |
||||
- 'user': all of the arguments from the user |
||||
|
||||
For example: |
||||
|
||||
```js |
||||
program.parse(process.argv); // Explicit, node conventions |
||||
program.parse(); // Implicit, and auto-detect electron |
||||
program.parse(['-f', 'filename'], { from: 'user' }); |
||||
``` |
||||
|
||||
### Avoiding option name clashes |
||||
|
||||
The original and default behaviour is that the option values are stored |
||||
as properties on the program, and the action handler is passed a |
||||
command object with the options values stored as properties. |
||||
This is very convenient to code, but the downside is possible clashes with |
||||
existing properties of Command. |
||||
|
||||
There are two new routines to change the behaviour, and the default behaviour may change in the future: |
||||
|
||||
- `storeOptionsAsProperties`: whether to store option values as properties on command object, or store separately (specify false) and access using `.opts()` |
||||
- `passCommandToAction`: whether to pass command to action handler, |
||||
or just the options (specify false) |
||||
|
||||
([example](./examples/storeOptionsAsProperties-action.js)) |
||||
|
||||
```js |
||||
program |
||||
.storeOptionsAsProperties(false) |
||||
.passCommandToAction(false); |
||||
|
||||
program |
||||
.name('my-program-name') |
||||
.option('-n,--name <name>'); |
||||
|
||||
program |
||||
.command('show') |
||||
.option('-a,--action <action>') |
||||
.action((options) => { |
||||
console.log(options.action); |
||||
}); |
||||
|
||||
program.parse(process.argv); |
||||
|
||||
const programOptions = program.opts(); |
||||
console.log(programOptions.name); |
||||
``` |
||||
|
||||
### TypeScript |
||||
|
||||
The Commander package includes its TypeScript Definition file. |
||||
|
||||
If you use `ts-node` and stand-alone executable subcommands written as `.ts` files, you need to call your program through node to get the subcommands called correctly. e.g. |
||||
|
||||
```bash |
||||
node -r ts-node/register pm.ts |
||||
``` |
||||
|
||||
### createCommand() |
||||
|
||||
This factory function creates a new command. It is exported and may be used instead of using `new`, like: |
||||
|
||||
```js |
||||
const { createCommand } = require('commander'); |
||||
const program = createCommand(); |
||||
``` |
||||
|
||||
`createCommand` is also a method of the Command object, and creates a new command rather than a subcommand. This gets used internally |
||||
when creating subcommands using `.command()`, and you may override it to |
||||
customise the new subcommand (examples using [subclass](./examples/custom-command-class.js) and [function](./examples/custom-command-function.js)). |
||||
|
||||
### Node options such as `--harmony` |
||||
|
||||
You can enable `--harmony` option in two ways: |
||||
|
||||
- Use `#! /usr/bin/env node --harmony` in the subcommands scripts. (Note Windows does not support this pattern.) |
||||
- Use the `--harmony` option when call the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning subcommand process. |
||||
|
||||
### Debugging stand-alone executable subcommands |
||||
|
||||
An executable subcommand is launched as a separate child process. |
||||
|
||||
If you are using the node inspector for [debugging](https://nodejs.org/en/docs/guides/debugging-getting-started/) executable subcommands using `node --inspect` et al, |
||||
the inspector port is incremented by 1 for the spawned subcommand. |
||||
|
||||
If you are using VSCode to debug executable subcommands you need to set the `"autoAttachChildProcesses": true` flag in your launch.json configuration. |
||||
|
||||
### Override exit handling |
||||
|
||||
By default Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override |
||||
this behaviour and optionally supply a callback. The default override throws a `CommanderError`. |
||||
|
||||
The override callback is passed a `CommanderError` with properties `exitCode` number, `code` string, and `message`. The default override behaviour is to throw the error, except for async handling of executable subcommand completion which carries on. The normal display of error messages or version or help |
||||
is not affected by the override which is called after the display. |
||||
|
||||
``` js |
||||
program.exitOverride(); |
||||
|
||||
try { |
||||
program.parse(process.argv); |
||||
} catch (err) { |
||||
// custom processing... |
||||
} |
||||
``` |
||||
|
||||
## Examples |
||||
|
||||
```js |
||||
const { program } = require('commander'); |
||||
|
||||
program |
||||
.version('0.1.0') |
||||
.option('-C, --chdir <path>', 'change the working directory') |
||||
.option('-c, --config <path>', 'set config path. defaults to ./deploy.conf') |
||||
.option('-T, --no-tests', 'ignore test hook'); |
||||
|
||||
program |
||||
.command('setup [env]') |
||||
.description('run setup commands for all envs') |
||||
.option("-s, --setup_mode [mode]", "Which setup mode to use") |
||||
.action(function(env, options){ |
||||
const mode = options.setup_mode || "normal"; |
||||
env = env || 'all'; |
||||
console.log('setup for %s env(s) with %s mode', env, mode); |
||||
}); |
||||
|
||||
program |
||||
.command('exec <cmd>') |
||||
.alias('ex') |
||||
.description('execute the given remote cmd') |
||||
.option("-e, --exec_mode <mode>", "Which exec mode to use") |
||||
.action(function(cmd, options){ |
||||
console.log('exec "%s" using %s mode', cmd, options.exec_mode); |
||||
}).on('--help', function() { |
||||
console.log(''); |
||||
console.log('Examples:'); |
||||
console.log(''); |
||||
console.log(' $ deploy exec sequential'); |
||||
console.log(' $ deploy exec async'); |
||||
}); |
||||
|
||||
program.parse(process.argv); |
||||
``` |
||||
|
||||
More Demos can be found in the [examples](https://github.com/tj/commander.js/tree/master/examples) directory. |
||||
|
||||
## License |
||||
|
||||
[MIT](https://github.com/tj/commander.js/blob/master/LICENSE) |
||||
|
||||
## Support |
||||
|
||||
Commander 5.x is fully supported on Long Term Support versions of Node, and is likely to work with Node 6 but not tested. |
||||
(For versions of Node below Node 6, use Commander 3.x or 2.x.) |
||||
|
||||
The main forum for free and community support is the project [Issues](https://github.com/tj/commander.js/issues) on GitHub. |
||||
|
||||
### Commander for enterprise |
||||
|
||||
Available as part of the Tidelift Subscription |
||||
|
||||
The maintainers of Commander and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-commander?utm_source=npm-commander&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,80 @@
|
||||
{ |
||||
"_from": "commander@^5.0.0", |
||||
"_id": "commander@5.1.0", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==", |
||||
"_location": "/commander", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "commander@^5.0.0", |
||||
"name": "commander", |
||||
"escapedName": "commander", |
||||
"rawSpec": "^5.0.0", |
||||
"saveSpec": null, |
||||
"fetchSpec": "^5.0.0" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/wscat" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz", |
||||
"_shasum": "46abbd1652f8e059bddaef99bbdcb2ad9cf179ae", |
||||
"_spec": "commander@^5.0.0", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/wscat", |
||||
"author": { |
||||
"name": "TJ Holowaychuk", |
||||
"email": "tj@vision-media.ca" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/tj/commander.js/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"dependencies": {}, |
||||
"deprecated": false, |
||||
"description": "the complete solution for node.js command-line programs", |
||||
"devDependencies": { |
||||
"@types/jest": "^25.2.1", |
||||
"@types/node": "^12.12.36", |
||||
"@typescript-eslint/eslint-plugin": "^2.29.0", |
||||
"eslint": "^6.8.0", |
||||
"eslint-config-standard-with-typescript": "^15.0.1", |
||||
"eslint-plugin-jest": "^23.8.2", |
||||
"jest": "^25.4.0", |
||||
"standard": "^14.3.3", |
||||
"typescript": "^3.7.5" |
||||
}, |
||||
"engines": { |
||||
"node": ">= 6" |
||||
}, |
||||
"files": [ |
||||
"index.js", |
||||
"typings/index.d.ts" |
||||
], |
||||
"homepage": "https://github.com/tj/commander.js#readme", |
||||
"keywords": [ |
||||
"commander", |
||||
"command", |
||||
"option", |
||||
"parser", |
||||
"cli", |
||||
"argument", |
||||
"args", |
||||
"argv" |
||||
], |
||||
"license": "MIT", |
||||
"main": "index", |
||||
"name": "commander", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/tj/commander.js.git" |
||||
}, |
||||
"scripts": { |
||||
"lint": "eslint index.js \"tests/**/*.js\"", |
||||
"test": "jest && npm run test-typings", |
||||
"test-typings": "tsc -p tsconfig.json", |
||||
"typescript-lint": "eslint typings/*.ts" |
||||
}, |
||||
"typings": "typings/index.d.ts", |
||||
"version": "5.1.0" |
||||
} |
||||
@ -0,0 +1,386 @@
|
||||
// Type definitions for commander
|
||||
// Original definitions by: Alan Agius <https://github.com/alan-agius4>, Marcelo Dezem <https://github.com/mdezem>, vvakame <https://github.com/vvakame>, Jules Randolph <https://github.com/sveinburne>
|
||||
|
||||
declare namespace commander { |
||||
|
||||
interface CommanderError extends Error { |
||||
code: string; |
||||
exitCode: number; |
||||
message: string; |
||||
nestedError?: string; |
||||
} |
||||
type CommanderErrorConstructor = new (exitCode: number, code: string, message: string) => CommanderError; |
||||
|
||||
interface Option { |
||||
flags: string; |
||||
required: boolean; // A value must be supplied when the option is specified.
|
||||
optional: boolean; // A value is optional when the option is specified.
|
||||
mandatory: boolean; // The option must have a value after parsing, which usually means it must be specified on command line.
|
||||
bool: boolean; |
||||
short?: string; |
||||
long: string; |
||||
description: string; |
||||
} |
||||
type OptionConstructor = new (flags: string, description?: string) => Option; |
||||
|
||||
interface ParseOptions { |
||||
from: 'node' | 'electron' | 'user'; |
||||
} |
||||
|
||||
interface Command { |
||||
[key: string]: any; // options as properties
|
||||
|
||||
args: string[]; |
||||
|
||||
commands: Command[]; |
||||
|
||||
/** |
||||
* Set the program version to `str`. |
||||
* |
||||
* This method auto-registers the "-V, --version" flag |
||||
* which will print the version number when passed. |
||||
* |
||||
* You can optionally supply the flags and description to override the defaults. |
||||
*/ |
||||
version(str: string, flags?: string, description?: string): this; |
||||
|
||||
/** |
||||
* Define a command, implemented using an action handler. |
||||
* |
||||
* @remarks |
||||
* The command description is supplied using `.description`, not as a parameter to `.command`. |
||||
* |
||||
* @example |
||||
* ```ts
|
||||
* program |
||||
* .command('clone <source> [destination]') |
||||
* .description('clone a repository into a newly created directory') |
||||
* .action((source, destination) => { |
||||
* console.log('clone command called'); |
||||
* }); |
||||
* ``` |
||||
* |
||||
* @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...` |
||||
* @param opts - configuration options |
||||
* @returns new command |
||||
*/ |
||||
command(nameAndArgs: string, opts?: CommandOptions): ReturnType<this['createCommand']>; |
||||
/** |
||||
* Define a command, implemented in a separate executable file. |
||||
* |
||||
* @remarks |
||||
* The command description is supplied as the second parameter to `.command`. |
||||
* |
||||
* @example |
||||
* ```ts
|
||||
* program |
||||
* .command('start <service>', 'start named service') |
||||
* .command('stop [service]', 'stop named serice, or all if no name supplied'); |
||||
* ``` |
||||
* |
||||
* @param nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...` |
||||
* @param description - description of executable command |
||||
* @param opts - configuration options |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
command(nameAndArgs: string, description: string, opts?: commander.ExecutableCommandOptions): this; |
||||
|
||||
/** |
||||
* Factory routine to create a new unattached command. |
||||
* |
||||
* See .command() for creating an attached subcommand, which uses this routine to |
||||
* create the command. You can override createCommand to customise subcommands. |
||||
*/ |
||||
createCommand(name?: string): Command; |
||||
|
||||
/** |
||||
* Add a prepared subcommand. |
||||
* |
||||
* See .command() for creating an attached subcommand which inherits settings from its parent. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
addCommand(cmd: Command, opts?: CommandOptions): this; |
||||
|
||||
/** |
||||
* Define argument syntax for command. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
arguments(desc: string): this; |
||||
|
||||
/** |
||||
* Register callback to use as replacement for calling process.exit. |
||||
*/ |
||||
exitOverride(callback?: (err: CommanderError) => never|void): this; |
||||
|
||||
/** |
||||
* Register callback `fn` for the command. |
||||
* |
||||
* @example |
||||
* program |
||||
* .command('help') |
||||
* .description('display verbose help') |
||||
* .action(function() { |
||||
* // output help here
|
||||
* }); |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
action(fn: (...args: any[]) => void | Promise<void>): this; |
||||
|
||||
/** |
||||
* Define option with `flags`, `description` and optional |
||||
* coercion `fn`. |
||||
* |
||||
* The `flags` string should contain both the short and long flags, |
||||
* separated by comma, a pipe or space. The following are all valid |
||||
* all will output this way when `--help` is used. |
||||
* |
||||
* "-p, --pepper" |
||||
* "-p|--pepper" |
||||
* "-p --pepper" |
||||
* |
||||
* @example |
||||
* // simple boolean defaulting to false
|
||||
* program.option('-p, --pepper', 'add pepper'); |
||||
* |
||||
* --pepper |
||||
* program.pepper |
||||
* // => Boolean
|
||||
* |
||||
* // simple boolean defaulting to true
|
||||
* program.option('-C, --no-cheese', 'remove cheese'); |
||||
* |
||||
* program.cheese |
||||
* // => true
|
||||
* |
||||
* --no-cheese |
||||
* program.cheese |
||||
* // => false
|
||||
* |
||||
* // required argument
|
||||
* program.option('-C, --chdir <path>', 'change the working directory'); |
||||
* |
||||
* --chdir /tmp |
||||
* program.chdir |
||||
* // => "/tmp"
|
||||
* |
||||
* // optional argument
|
||||
* program.option('-c, --cheese [type]', 'add cheese [marble]'); |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
option(flags: string, description?: string, defaultValue?: string | boolean): this; |
||||
option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): this; |
||||
option<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this; |
||||
|
||||
/** |
||||
* Define a required option, which must have a value after parsing. This usually means |
||||
* the option must be specified on the command line. (Otherwise the same as .option().) |
||||
* |
||||
* The `flags` string should contain both the short and long flags, separated by comma, a pipe or space. |
||||
*/ |
||||
requiredOption(flags: string, description?: string, defaultValue?: string | boolean): this; |
||||
requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): this; |
||||
requiredOption<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this; |
||||
|
||||
/** |
||||
* Whether to store option values as properties on command object, |
||||
* or store separately (specify false). In both cases the option values can be accessed using .opts(). |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
storeOptionsAsProperties(value?: boolean): this; |
||||
|
||||
/** |
||||
* Whether to pass command to action handler, |
||||
* or just the options (specify false). |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
passCommandToAction(value?: boolean): this; |
||||
|
||||
/** |
||||
* Allow unknown options on the command line. |
||||
* |
||||
* @param [arg] if `true` or omitted, no error will be thrown for unknown options. |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
allowUnknownOption(arg?: boolean): this; |
||||
|
||||
/** |
||||
* Parse `argv`, setting options and invoking commands when defined. |
||||
* |
||||
* The default expectation is that the arguments are from node and have the application as argv[0] |
||||
* and the script being run in argv[1], with user parameters after that. |
||||
* |
||||
* Examples: |
||||
* |
||||
* program.parse(process.argv); |
||||
* program.parse(); // implicitly use process.argv and auto-detect node vs electron conventions
|
||||
* program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
|
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
parse(argv?: string[], options?: ParseOptions): this; |
||||
|
||||
/** |
||||
* Parse `argv`, setting options and invoking commands when defined. |
||||
* |
||||
* Use parseAsync instead of parse if any of your action handlers are async. Returns a Promise. |
||||
* |
||||
* The default expectation is that the arguments are from node and have the application as argv[0] |
||||
* and the script being run in argv[1], with user parameters after that. |
||||
* |
||||
* Examples: |
||||
* |
||||
* program.parseAsync(process.argv); |
||||
* program.parseAsync(); // implicitly use process.argv and auto-detect node vs electron conventions
|
||||
* program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
|
||||
* |
||||
* @returns Promise |
||||
*/ |
||||
parseAsync(argv?: string[], options?: ParseOptions): Promise<this>; |
||||
|
||||
/** |
||||
* Parse options from `argv` removing known options, |
||||
* and return argv split into operands and unknown arguments. |
||||
* |
||||
* @example |
||||
* argv => operands, unknown |
||||
* --known kkk op => [op], [] |
||||
* op --known kkk => [op], [] |
||||
* sub --unknown uuu op => [sub], [--unknown uuu op] |
||||
* sub -- --unknown uuu op => [sub --unknown uuu op], [] |
||||
*/ |
||||
parseOptions(argv: string[]): commander.ParseOptionsResult; |
||||
|
||||
/** |
||||
* Return an object containing options as key-value pairs |
||||
*/ |
||||
opts(): { [key: string]: any }; |
||||
|
||||
/** |
||||
* Set the description. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
description(str: string, argsDescription?: {[argName: string]: string}): this; |
||||
/** |
||||
* Get the description. |
||||
*/ |
||||
description(): string; |
||||
|
||||
/** |
||||
* Set an alias for the command. |
||||
* |
||||
* You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
alias(alias: string): this; |
||||
/** |
||||
* Get alias for the command. |
||||
*/ |
||||
alias(): string; |
||||
|
||||
/** |
||||
* Set aliases for the command. |
||||
* |
||||
* Only the first alias is shown in the auto-generated help. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
aliases(aliases: string[]): this; |
||||
/** |
||||
* Get aliases for the command. |
||||
*/ |
||||
aliases(): string[]; |
||||
|
||||
/** |
||||
* Set the command usage. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
usage(str: string): this; |
||||
/** |
||||
* Get the command usage. |
||||
*/ |
||||
usage(): string; |
||||
|
||||
/** |
||||
* Set the name of the command. |
||||
* |
||||
* @returns `this` command for chaining |
||||
*/ |
||||
name(str: string): this; |
||||
/** |
||||
* Get the name of the command. |
||||
*/ |
||||
name(): string; |
||||
|
||||
/** |
||||
* Output help information for this command. |
||||
* |
||||
* When listener(s) are available for the helpLongFlag |
||||
* those callbacks are invoked. |
||||
*/ |
||||
outputHelp(cb?: (str: string) => string): void; |
||||
|
||||
/** |
||||
* Return command help documentation. |
||||
*/ |
||||
helpInformation(): string; |
||||
|
||||
/** |
||||
* You can pass in flags and a description to override the help |
||||
* flags and help description for your command. |
||||
*/ |
||||
helpOption(flags?: string, description?: string): this; |
||||
|
||||
/** |
||||
* Output help information and exit. |
||||
*/ |
||||
help(cb?: (str: string) => string): never; |
||||
|
||||
/** |
||||
* Add a listener (callback) for when events occur. (Implemented using EventEmitter.) |
||||
* |
||||
* @example |
||||
* program |
||||
* .on('--help', () -> { |
||||
* console.log('See web site for more information.'); |
||||
* }); |
||||
*/ |
||||
on(event: string | symbol, listener: (...args: any[]) => void): this; |
||||
} |
||||
type CommandConstructor = new (name?: string) => Command; |
||||
|
||||
interface CommandOptions { |
||||
noHelp?: boolean; // old name for hidden
|
||||
hidden?: boolean; |
||||
isDefault?: boolean; |
||||
} |
||||
interface ExecutableCommandOptions extends CommandOptions { |
||||
executableFile?: string; |
||||
} |
||||
|
||||
interface ParseOptionsResult { |
||||
operands: string[]; |
||||
unknown: string[]; |
||||
} |
||||
|
||||
interface CommanderStatic extends Command { |
||||
program: Command; |
||||
Command: CommandConstructor; |
||||
Option: OptionConstructor; |
||||
CommanderError: CommanderErrorConstructor; |
||||
} |
||||
|
||||
} |
||||
|
||||
// Declaring namespace AND global
|
||||
// eslint-disable-next-line no-redeclare
|
||||
declare const commander: commander.CommanderStatic; |
||||
export = commander; |
||||
@ -0,0 +1,19 @@
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2014 TJ Holowaychuk <tj@vision-media.ca> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
||||
and associated documentation files (the 'Software'), to deal in the Software without restriction, |
||||
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, |
||||
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, |
||||
subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial |
||||
portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
||||
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
|
||||
@ -0,0 +1,455 @@
|
||||
# debug |
||||
[](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers) |
||||
[](#sponsors) |
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> |
||||
|
||||
A tiny JavaScript debugging utility modelled after Node.js core's debugging |
||||
technique. Works in Node.js and web browsers. |
||||
|
||||
## Installation |
||||
|
||||
```bash |
||||
$ npm install debug |
||||
``` |
||||
|
||||
## Usage |
||||
|
||||
`debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole. |
||||
|
||||
Example [_app.js_](./examples/node/app.js): |
||||
|
||||
```js |
||||
var debug = require('debug')('http') |
||||
, http = require('http') |
||||
, name = 'My App'; |
||||
|
||||
// fake app |
||||
|
||||
debug('booting %o', name); |
||||
|
||||
http.createServer(function(req, res){ |
||||
debug(req.method + ' ' + req.url); |
||||
res.end('hello\n'); |
||||
}).listen(3000, function(){ |
||||
debug('listening'); |
||||
}); |
||||
|
||||
// fake worker of some kind |
||||
|
||||
require('./worker'); |
||||
``` |
||||
|
||||
Example [_worker.js_](./examples/node/worker.js): |
||||
|
||||
```js |
||||
var a = require('debug')('worker:a') |
||||
, b = require('debug')('worker:b'); |
||||
|
||||
function work() { |
||||
a('doing lots of uninteresting work'); |
||||
setTimeout(work, Math.random() * 1000); |
||||
} |
||||
|
||||
work(); |
||||
|
||||
function workb() { |
||||
b('doing some work'); |
||||
setTimeout(workb, Math.random() * 2000); |
||||
} |
||||
|
||||
workb(); |
||||
``` |
||||
|
||||
The `DEBUG` environment variable is then used to enable these based on space or |
||||
comma-delimited names. |
||||
|
||||
Here are some examples: |
||||
|
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png"> |
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png"> |
||||
<img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png"> |
||||
|
||||
#### Windows command prompt notes |
||||
|
||||
##### CMD |
||||
|
||||
On Windows the environment variable is set using the `set` command. |
||||
|
||||
```cmd |
||||
set DEBUG=*,-not_this |
||||
``` |
||||
|
||||
Example: |
||||
|
||||
```cmd |
||||
set DEBUG=* & node app.js |
||||
``` |
||||
|
||||
##### PowerShell (VS Code default) |
||||
|
||||
PowerShell uses different syntax to set environment variables. |
||||
|
||||
```cmd |
||||
$env:DEBUG = "*,-not_this" |
||||
``` |
||||
|
||||
Example: |
||||
|
||||
```cmd |
||||
$env:DEBUG='app';node app.js |
||||
``` |
||||
|
||||
Then, run the program to be debugged as usual. |
||||
|
||||
npm script example: |
||||
```js |
||||
"windowsDebug": "@powershell -Command $env:DEBUG='*';node app.js", |
||||
``` |
||||
|
||||
## Namespace Colors |
||||
|
||||
Every debug instance has a color generated for it based on its namespace name. |
||||
This helps when visually parsing the debug output to identify which debug instance |
||||
a debug line belongs to. |
||||
|
||||
#### Node.js |
||||
|
||||
In Node.js, colors are enabled when stderr is a TTY. You also _should_ install |
||||
the [`supports-color`](https://npmjs.org/supports-color) module alongside debug, |
||||
otherwise debug will only use a small handful of basic colors. |
||||
|
||||
<img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png"> |
||||
|
||||
#### Web Browser |
||||
|
||||
Colors are also enabled on "Web Inspectors" that understand the `%c` formatting |
||||
option. These are WebKit web inspectors, Firefox ([since version |
||||
31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/)) |
||||
and the Firebug plugin for Firefox (any version). |
||||
|
||||
<img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png"> |
||||
|
||||
|
||||
## Millisecond diff |
||||
|
||||
When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls. |
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> |
||||
|
||||
When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below: |
||||
|
||||
<img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png"> |
||||
|
||||
|
||||
## Conventions |
||||
|
||||
If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output. |
||||
|
||||
## Wildcards |
||||
|
||||
The `*` character may be used as a wildcard. Suppose for example your library has |
||||
debuggers named "connect:bodyParser", "connect:compress", "connect:session", |
||||
instead of listing all three with |
||||
`DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do |
||||
`DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`. |
||||
|
||||
You can also exclude specific debuggers by prefixing them with a "-" character. |
||||
For example, `DEBUG=*,-connect:*` would include all debuggers except those |
||||
starting with "connect:". |
||||
|
||||
## Environment Variables |
||||
|
||||
When running through Node.js, you can set a few environment variables that will |
||||
change the behavior of the debug logging: |
||||
|
||||
| Name | Purpose | |
||||
|-----------|-------------------------------------------------| |
||||
| `DEBUG` | Enables/disables specific debugging namespaces. | |
||||
| `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). | |
||||
| `DEBUG_COLORS`| Whether or not to use colors in the debug output. | |
||||
| `DEBUG_DEPTH` | Object inspection depth. | |
||||
| `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. | |
||||
|
||||
|
||||
__Note:__ The environment variables beginning with `DEBUG_` end up being |
||||
converted into an Options object that gets used with `%o`/`%O` formatters. |
||||
See the Node.js documentation for |
||||
[`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options) |
||||
for the complete list. |
||||
|
||||
## Formatters |
||||
|
||||
Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. |
||||
Below are the officially supported formatters: |
||||
|
||||
| Formatter | Representation | |
||||
|-----------|----------------| |
||||
| `%O` | Pretty-print an Object on multiple lines. | |
||||
| `%o` | Pretty-print an Object all on a single line. | |
||||
| `%s` | String. | |
||||
| `%d` | Number (both integer and float). | |
||||
| `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. | |
||||
| `%%` | Single percent sign ('%'). This does not consume an argument. | |
||||
|
||||
|
||||
### Custom formatters |
||||
|
||||
You can add custom formatters by extending the `debug.formatters` object. |
||||
For example, if you wanted to add support for rendering a Buffer as hex with |
||||
`%h`, you could do something like: |
||||
|
||||
```js |
||||
const createDebug = require('debug') |
||||
createDebug.formatters.h = (v) => { |
||||
return v.toString('hex') |
||||
} |
||||
|
||||
// …elsewhere |
||||
const debug = createDebug('foo') |
||||
debug('this is hex: %h', new Buffer('hello world')) |
||||
// foo this is hex: 68656c6c6f20776f726c6421 +0ms |
||||
``` |
||||
|
||||
|
||||
## Browser Support |
||||
|
||||
You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify), |
||||
or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest), |
||||
if you don't want to build it yourself. |
||||
|
||||
Debug's enable state is currently persisted by `localStorage`. |
||||
Consider the situation shown below where you have `worker:a` and `worker:b`, |
||||
and wish to debug both. You can enable this using `localStorage.debug`: |
||||
|
||||
```js |
||||
localStorage.debug = 'worker:*' |
||||
``` |
||||
|
||||
And then refresh the page. |
||||
|
||||
```js |
||||
a = debug('worker:a'); |
||||
b = debug('worker:b'); |
||||
|
||||
setInterval(function(){ |
||||
a('doing some work'); |
||||
}, 1000); |
||||
|
||||
setInterval(function(){ |
||||
b('doing some work'); |
||||
}, 1200); |
||||
``` |
||||
|
||||
|
||||
## Output streams |
||||
|
||||
By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method: |
||||
|
||||
Example [_stdout.js_](./examples/node/stdout.js): |
||||
|
||||
```js |
||||
var debug = require('debug'); |
||||
var error = debug('app:error'); |
||||
|
||||
// by default stderr is used |
||||
error('goes to stderr!'); |
||||
|
||||
var log = debug('app:log'); |
||||
// set this namespace to log via console.log |
||||
log.log = console.log.bind(console); // don't forget to bind to console! |
||||
log('goes to stdout'); |
||||
error('still goes to stderr!'); |
||||
|
||||
// set all output to go via console.info |
||||
// overrides all per-namespace log settings |
||||
debug.log = console.info.bind(console); |
||||
error('now goes to stdout via console.info'); |
||||
log('still goes to stdout, but via console.info now'); |
||||
``` |
||||
|
||||
## Extend |
||||
You can simply extend debugger |
||||
```js |
||||
const log = require('debug')('auth'); |
||||
|
||||
//creates new debug instance with extended namespace |
||||
const logSign = log.extend('sign'); |
||||
const logLogin = log.extend('login'); |
||||
|
||||
log('hello'); // auth hello |
||||
logSign('hello'); //auth:sign hello |
||||
logLogin('hello'); //auth:login hello |
||||
``` |
||||
|
||||
## Set dynamically |
||||
|
||||
You can also enable debug dynamically by calling the `enable()` method : |
||||
|
||||
```js |
||||
let debug = require('debug'); |
||||
|
||||
console.log(1, debug.enabled('test')); |
||||
|
||||
debug.enable('test'); |
||||
console.log(2, debug.enabled('test')); |
||||
|
||||
debug.disable(); |
||||
console.log(3, debug.enabled('test')); |
||||
|
||||
``` |
||||
|
||||
print : |
||||
``` |
||||
1 false |
||||
2 true |
||||
3 false |
||||
``` |
||||
|
||||
Usage : |
||||
`enable(namespaces)` |
||||
`namespaces` can include modes separated by a colon and wildcards. |
||||
|
||||
Note that calling `enable()` completely overrides previously set DEBUG variable : |
||||
|
||||
``` |
||||
$ DEBUG=foo node -e 'var dbg = require("debug"); dbg.enable("bar"); console.log(dbg.enabled("foo"))' |
||||
=> false |
||||
``` |
||||
|
||||
`disable()` |
||||
|
||||
Will disable all namespaces. The functions returns the namespaces currently |
||||
enabled (and skipped). This can be useful if you want to disable debugging |
||||
temporarily without knowing what was enabled to begin with. |
||||
|
||||
For example: |
||||
|
||||
```js |
||||
let debug = require('debug'); |
||||
debug.enable('foo:*,-foo:bar'); |
||||
let namespaces = debug.disable(); |
||||
debug.enable(namespaces); |
||||
``` |
||||
|
||||
Note: There is no guarantee that the string will be identical to the initial |
||||
enable string, but semantically they will be identical. |
||||
|
||||
## Checking whether a debug target is enabled |
||||
|
||||
After you've created a debug instance, you can determine whether or not it is |
||||
enabled by checking the `enabled` property: |
||||
|
||||
```javascript |
||||
const debug = require('debug')('http'); |
||||
|
||||
if (debug.enabled) { |
||||
// do stuff... |
||||
} |
||||
``` |
||||
|
||||
You can also manually toggle this property to force the debug instance to be |
||||
enabled or disabled. |
||||
|
||||
|
||||
## Authors |
||||
|
||||
- TJ Holowaychuk |
||||
- Nathan Rajlich |
||||
- Andrew Rhyne |
||||
|
||||
## Backers |
||||
|
||||
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)] |
||||
|
||||
<a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a> |
||||
|
||||
|
||||
## Sponsors |
||||
|
||||
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)] |
||||
|
||||
<a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a> |
||||
<a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a> |
||||
|
||||
## License |
||||
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2014-2017 TJ Holowaychuk <tj@vision-media.ca> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
'Software'), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
@ -0,0 +1,102 @@
|
||||
{ |
||||
"_from": "debug@4", |
||||
"_id": "debug@4.2.0", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-IX2ncY78vDTjZMFUdmsvIRFY2Cf4FnD0wRs+nQwJU8Lu99/tPFdb0VybiiMTPe3I6rQmwsqQqRBvxU+bZ/I8sg==", |
||||
"_location": "/debug", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "debug@4", |
||||
"name": "debug", |
||||
"escapedName": "debug", |
||||
"rawSpec": "4", |
||||
"saveSpec": null, |
||||
"fetchSpec": "4" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/agent-base", |
||||
"/https-proxy-agent" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/debug/-/debug-4.2.0.tgz", |
||||
"_shasum": "7f150f93920e94c58f5574c2fd01a3110effe7f1", |
||||
"_spec": "debug@4", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/https-proxy-agent", |
||||
"author": { |
||||
"name": "TJ Holowaychuk", |
||||
"email": "tj@vision-media.ca" |
||||
}, |
||||
"browser": "./src/browser.js", |
||||
"bugs": { |
||||
"url": "https://github.com/visionmedia/debug/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"contributors": [ |
||||
{ |
||||
"name": "Nathan Rajlich", |
||||
"email": "nathan@tootallnate.net", |
||||
"url": "http://n8.io" |
||||
}, |
||||
{ |
||||
"name": "Andrew Rhyne", |
||||
"email": "rhyneandrew@gmail.com" |
||||
}, |
||||
{ |
||||
"name": "Josh Junon", |
||||
"email": "josh@junon.me" |
||||
} |
||||
], |
||||
"dependencies": { |
||||
"ms": "2.1.2" |
||||
}, |
||||
"deprecated": false, |
||||
"description": "small debugging utility", |
||||
"devDependencies": { |
||||
"brfs": "^2.0.1", |
||||
"browserify": "^16.2.3", |
||||
"coveralls": "^3.0.2", |
||||
"istanbul": "^0.4.5", |
||||
"karma": "^3.1.4", |
||||
"karma-browserify": "^6.0.0", |
||||
"karma-chrome-launcher": "^2.2.0", |
||||
"karma-mocha": "^1.3.0", |
||||
"mocha": "^5.2.0", |
||||
"mocha-lcov-reporter": "^1.2.0", |
||||
"xo": "^0.23.0" |
||||
}, |
||||
"engines": { |
||||
"node": ">=6.0" |
||||
}, |
||||
"files": [ |
||||
"src", |
||||
"LICENSE", |
||||
"README.md" |
||||
], |
||||
"homepage": "https://github.com/visionmedia/debug#readme", |
||||
"keywords": [ |
||||
"debug", |
||||
"log", |
||||
"debugger" |
||||
], |
||||
"license": "MIT", |
||||
"main": "./src/index.js", |
||||
"name": "debug", |
||||
"peerDependenciesMeta": { |
||||
"supports-color": { |
||||
"optional": true |
||||
} |
||||
}, |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git://github.com/visionmedia/debug.git" |
||||
}, |
||||
"scripts": { |
||||
"lint": "xo", |
||||
"test": "npm run test:node && npm run test:browser && npm run lint", |
||||
"test:browser": "karma start --single-run", |
||||
"test:coverage": "cat ./coverage/lcov.info | coveralls", |
||||
"test:node": "istanbul cover _mocha -- test.js" |
||||
}, |
||||
"version": "4.2.0" |
||||
} |
||||
@ -0,0 +1,259 @@
|
||||
/* eslint-env browser */ |
||||
|
||||
/** |
||||
* This is the web browser implementation of `debug()`. |
||||
*/ |
||||
|
||||
exports.formatArgs = formatArgs; |
||||
exports.save = save; |
||||
exports.load = load; |
||||
exports.useColors = useColors; |
||||
exports.storage = localstorage(); |
||||
|
||||
/** |
||||
* Colors. |
||||
*/ |
||||
|
||||
exports.colors = [ |
||||
'#0000CC', |
||||
'#0000FF', |
||||
'#0033CC', |
||||
'#0033FF', |
||||
'#0066CC', |
||||
'#0066FF', |
||||
'#0099CC', |
||||
'#0099FF', |
||||
'#00CC00', |
||||
'#00CC33', |
||||
'#00CC66', |
||||
'#00CC99', |
||||
'#00CCCC', |
||||
'#00CCFF', |
||||
'#3300CC', |
||||
'#3300FF', |
||||
'#3333CC', |
||||
'#3333FF', |
||||
'#3366CC', |
||||
'#3366FF', |
||||
'#3399CC', |
||||
'#3399FF', |
||||
'#33CC00', |
||||
'#33CC33', |
||||
'#33CC66', |
||||
'#33CC99', |
||||
'#33CCCC', |
||||
'#33CCFF', |
||||
'#6600CC', |
||||
'#6600FF', |
||||
'#6633CC', |
||||
'#6633FF', |
||||
'#66CC00', |
||||
'#66CC33', |
||||
'#9900CC', |
||||
'#9900FF', |
||||
'#9933CC', |
||||
'#9933FF', |
||||
'#99CC00', |
||||
'#99CC33', |
||||
'#CC0000', |
||||
'#CC0033', |
||||
'#CC0066', |
||||
'#CC0099', |
||||
'#CC00CC', |
||||
'#CC00FF', |
||||
'#CC3300', |
||||
'#CC3333', |
||||
'#CC3366', |
||||
'#CC3399', |
||||
'#CC33CC', |
||||
'#CC33FF', |
||||
'#CC6600', |
||||
'#CC6633', |
||||
'#CC9900', |
||||
'#CC9933', |
||||
'#CCCC00', |
||||
'#CCCC33', |
||||
'#FF0000', |
||||
'#FF0033', |
||||
'#FF0066', |
||||
'#FF0099', |
||||
'#FF00CC', |
||||
'#FF00FF', |
||||
'#FF3300', |
||||
'#FF3333', |
||||
'#FF3366', |
||||
'#FF3399', |
||||
'#FF33CC', |
||||
'#FF33FF', |
||||
'#FF6600', |
||||
'#FF6633', |
||||
'#FF9900', |
||||
'#FF9933', |
||||
'#FFCC00', |
||||
'#FFCC33' |
||||
]; |
||||
|
||||
/** |
||||
* Currently only WebKit-based Web Inspectors, Firefox >= v31, |
||||
* and the Firebug extension (any Firefox version) are known |
||||
* to support "%c" CSS customizations. |
||||
* |
||||
* TODO: add a `localStorage` variable to explicitly enable/disable colors |
||||
*/ |
||||
|
||||
// eslint-disable-next-line complexity
|
||||
function useColors() { |
||||
// NB: In an Electron preload script, document will be defined but not fully
|
||||
// initialized. Since we know we're in Chrome, we'll just detect this case
|
||||
// explicitly
|
||||
if (typeof window !== 'undefined' && window.process && (window.process.type === 'renderer' || window.process.__nwjs)) { |
||||
return true; |
||||
} |
||||
|
||||
// Internet Explorer and Edge do not support colors.
|
||||
if (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) { |
||||
return false; |
||||
} |
||||
|
||||
// Is webkit? http://stackoverflow.com/a/16459606/376773
|
||||
// document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
|
||||
return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) || |
||||
// Is firebug? http://stackoverflow.com/a/398120/376773
|
||||
(typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) || |
||||
// Is firefox >= v31?
|
||||
// https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
|
||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/) && parseInt(RegExp.$1, 10) >= 31) || |
||||
// Double check webkit in userAgent just in case we are in a worker
|
||||
(typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/)); |
||||
} |
||||
|
||||
/** |
||||
* Colorize log arguments if enabled. |
||||
* |
||||
* @api public |
||||
*/ |
||||
|
||||
function formatArgs(args) { |
||||
args[0] = (this.useColors ? '%c' : '') + |
||||
this.namespace + |
||||
(this.useColors ? ' %c' : ' ') + |
||||
args[0] + |
||||
(this.useColors ? '%c ' : ' ') + |
||||
'+' + module.exports.humanize(this.diff); |
||||
|
||||
if (!this.useColors) { |
||||
return; |
||||
} |
||||
|
||||
const c = 'color: ' + this.color; |
||||
args.splice(1, 0, c, 'color: inherit'); |
||||
|
||||
// The final "%c" is somewhat tricky, because there could be other
|
||||
// arguments passed either before or after the %c, so we need to
|
||||
// figure out the correct index to insert the CSS into
|
||||
let index = 0; |
||||
let lastC = 0; |
||||
args[0].replace(/%[a-zA-Z%]/g, match => { |
||||
if (match === '%%') { |
||||
return; |
||||
} |
||||
index++; |
||||
if (match === '%c') { |
||||
// We only are interested in the *last* %c
|
||||
// (the user may have provided their own)
|
||||
lastC = index; |
||||
} |
||||
}); |
||||
|
||||
args.splice(lastC, 0, c); |
||||
} |
||||
|
||||
/** |
||||
* Invokes `console.debug()` when available. |
||||
* No-op when `console.debug` is not a "function". |
||||
* If `console.debug` is not available, falls back |
||||
* to `console.log`. |
||||
* |
||||
* @api public |
||||
*/ |
||||
exports.log = console.debug || console.log || (() => {}); |
||||
|
||||
/** |
||||
* Save `namespaces`. |
||||
* |
||||
* @param {String} namespaces |
||||
* @api private |
||||
*/ |
||||
function save(namespaces) { |
||||
try { |
||||
if (namespaces) { |
||||
exports.storage.setItem('debug', namespaces); |
||||
} else { |
||||
exports.storage.removeItem('debug'); |
||||
} |
||||
} catch (error) { |
||||
// Swallow
|
||||
// XXX (@Qix-) should we be logging these?
|
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Load `namespaces`. |
||||
* |
||||
* @return {String} returns the previously persisted debug modes |
||||
* @api private |
||||
*/ |
||||
function load() { |
||||
let r; |
||||
try { |
||||
r = exports.storage.getItem('debug'); |
||||
} catch (error) { |
||||
// Swallow
|
||||
// XXX (@Qix-) should we be logging these?
|
||||
} |
||||
|
||||
// If debug isn't set in LS, and we're in Electron, try to load $DEBUG
|
||||
if (!r && typeof process !== 'undefined' && 'env' in process) { |
||||
r = process.env.DEBUG; |
||||
} |
||||
|
||||
return r; |
||||
} |
||||
|
||||
/** |
||||
* Localstorage attempts to return the localstorage. |
||||
* |
||||
* This is necessary because safari throws |
||||
* when a user disables cookies/localstorage |
||||
* and you attempt to access it. |
||||
* |
||||
* @return {LocalStorage} |
||||
* @api private |
||||
*/ |
||||
|
||||
function localstorage() { |
||||
try { |
||||
// TVMLKit (Apple TV JS Runtime) does not have a window object, just localStorage in the global context
|
||||
// The Browser also has localStorage in the global context.
|
||||
return localStorage; |
||||
} catch (error) { |
||||
// Swallow
|
||||
// XXX (@Qix-) should we be logging these?
|
||||
} |
||||
} |
||||
|
||||
module.exports = require('./common')(exports); |
||||
|
||||
const {formatters} = module.exports; |
||||
|
||||
/** |
||||
* Map %j to `JSON.stringify()`, since no Web Inspectors do that by default. |
||||
*/ |
||||
|
||||
formatters.j = function (v) { |
||||
try { |
||||
return JSON.stringify(v); |
||||
} catch (error) { |
||||
return '[UnexpectedJSONParseError]: ' + error.message; |
||||
} |
||||
}; |
||||
@ -0,0 +1,264 @@
|
||||
|
||||
/** |
||||
* This is the common logic for both the Node.js and web browser |
||||
* implementations of `debug()`. |
||||
*/ |
||||
|
||||
function setup(env) { |
||||
createDebug.debug = createDebug; |
||||
createDebug.default = createDebug; |
||||
createDebug.coerce = coerce; |
||||
createDebug.disable = disable; |
||||
createDebug.enable = enable; |
||||
createDebug.enabled = enabled; |
||||
createDebug.humanize = require('ms'); |
||||
|
||||
Object.keys(env).forEach(key => { |
||||
createDebug[key] = env[key]; |
||||
}); |
||||
|
||||
/** |
||||
* Active `debug` instances. |
||||
*/ |
||||
createDebug.instances = []; |
||||
|
||||
/** |
||||
* The currently active debug mode names, and names to skip. |
||||
*/ |
||||
|
||||
createDebug.names = []; |
||||
createDebug.skips = []; |
||||
|
||||
/** |
||||
* Map of special "%n" handling functions, for the debug "format" argument. |
||||
* |
||||
* Valid key names are a single, lower or upper-case letter, i.e. "n" and "N". |
||||
*/ |
||||
createDebug.formatters = {}; |
||||
|
||||
/** |
||||
* Selects a color for a debug namespace |
||||
* @param {String} namespace The namespace string for the for the debug instance to be colored |
||||
* @return {Number|String} An ANSI color code for the given namespace |
||||
* @api private |
||||
*/ |
||||
function selectColor(namespace) { |
||||
let hash = 0; |
||||
|
||||
for (let i = 0; i < namespace.length; i++) { |
||||
hash = ((hash << 5) - hash) + namespace.charCodeAt(i); |
||||
hash |= 0; // Convert to 32bit integer
|
||||
} |
||||
|
||||
return createDebug.colors[Math.abs(hash) % createDebug.colors.length]; |
||||
} |
||||
createDebug.selectColor = selectColor; |
||||
|
||||
/** |
||||
* Create a debugger with the given `namespace`. |
||||
* |
||||
* @param {String} namespace |
||||
* @return {Function} |
||||
* @api public |
||||
*/ |
||||
function createDebug(namespace) { |
||||
let prevTime; |
||||
|
||||
function debug(...args) { |
||||
// Disabled?
|
||||
if (!debug.enabled) { |
||||
return; |
||||
} |
||||
|
||||
const self = debug; |
||||
|
||||
// Set `diff` timestamp
|
||||
const curr = Number(new Date()); |
||||
const ms = curr - (prevTime || curr); |
||||
self.diff = ms; |
||||
self.prev = prevTime; |
||||
self.curr = curr; |
||||
prevTime = curr; |
||||
|
||||
args[0] = createDebug.coerce(args[0]); |
||||
|
||||
if (typeof args[0] !== 'string') { |
||||
// Anything else let's inspect with %O
|
||||
args.unshift('%O'); |
||||
} |
||||
|
||||
// Apply any `formatters` transformations
|
||||
let index = 0; |
||||
args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => { |
||||
// If we encounter an escaped % then don't increase the array index
|
||||
if (match === '%%') { |
||||
return match; |
||||
} |
||||
index++; |
||||
const formatter = createDebug.formatters[format]; |
||||
if (typeof formatter === 'function') { |
||||
const val = args[index]; |
||||
match = formatter.call(self, val); |
||||
|
||||
// Now we need to remove `args[index]` since it's inlined in the `format`
|
||||
args.splice(index, 1); |
||||
index--; |
||||
} |
||||
return match; |
||||
}); |
||||
|
||||
// Apply env-specific formatting (colors, etc.)
|
||||
createDebug.formatArgs.call(self, args); |
||||
|
||||
const logFn = self.log || createDebug.log; |
||||
logFn.apply(self, args); |
||||
} |
||||
|
||||
debug.namespace = namespace; |
||||
debug.enabled = createDebug.enabled(namespace); |
||||
debug.useColors = createDebug.useColors(); |
||||
debug.color = createDebug.selectColor(namespace); |
||||
debug.destroy = destroy; |
||||
debug.extend = extend; |
||||
|
||||
// Env-specific initialization logic for debug instances
|
||||
if (typeof createDebug.init === 'function') { |
||||
createDebug.init(debug); |
||||
} |
||||
|
||||
createDebug.instances.push(debug); |
||||
|
||||
return debug; |
||||
} |
||||
|
||||
function destroy() { |
||||
const index = createDebug.instances.indexOf(this); |
||||
if (index !== -1) { |
||||
createDebug.instances.splice(index, 1); |
||||
return true; |
||||
} |
||||
return false; |
||||
} |
||||
|
||||
function extend(namespace, delimiter) { |
||||
const newDebug = createDebug(this.namespace + (typeof delimiter === 'undefined' ? ':' : delimiter) + namespace); |
||||
newDebug.log = this.log; |
||||
return newDebug; |
||||
} |
||||
|
||||
/** |
||||
* Enables a debug mode by namespaces. This can include modes |
||||
* separated by a colon and wildcards. |
||||
* |
||||
* @param {String} namespaces |
||||
* @api public |
||||
*/ |
||||
function enable(namespaces) { |
||||
createDebug.save(namespaces); |
||||
|
||||
createDebug.names = []; |
||||
createDebug.skips = []; |
||||
|
||||
let i; |
||||
const split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/); |
||||
const len = split.length; |
||||
|
||||
for (i = 0; i < len; i++) { |
||||
if (!split[i]) { |
||||
// ignore empty strings
|
||||
continue; |
||||
} |
||||
|
||||
namespaces = split[i].replace(/\*/g, '.*?'); |
||||
|
||||
if (namespaces[0] === '-') { |
||||
createDebug.skips.push(new RegExp('^' + namespaces.substr(1) + '$')); |
||||
} else { |
||||
createDebug.names.push(new RegExp('^' + namespaces + '$')); |
||||
} |
||||
} |
||||
|
||||
for (i = 0; i < createDebug.instances.length; i++) { |
||||
const instance = createDebug.instances[i]; |
||||
instance.enabled = createDebug.enabled(instance.namespace); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Disable debug output. |
||||
* |
||||
* @return {String} namespaces |
||||
* @api public |
||||
*/ |
||||
function disable() { |
||||
const namespaces = [ |
||||
...createDebug.names.map(toNamespace), |
||||
...createDebug.skips.map(toNamespace).map(namespace => '-' + namespace) |
||||
].join(','); |
||||
createDebug.enable(''); |
||||
return namespaces; |
||||
} |
||||
|
||||
/** |
||||
* Returns true if the given mode name is enabled, false otherwise. |
||||
* |
||||
* @param {String} name |
||||
* @return {Boolean} |
||||
* @api public |
||||
*/ |
||||
function enabled(name) { |
||||
if (name[name.length - 1] === '*') { |
||||
return true; |
||||
} |
||||
|
||||
let i; |
||||
let len; |
||||
|
||||
for (i = 0, len = createDebug.skips.length; i < len; i++) { |
||||
if (createDebug.skips[i].test(name)) { |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
for (i = 0, len = createDebug.names.length; i < len; i++) { |
||||
if (createDebug.names[i].test(name)) { |
||||
return true; |
||||
} |
||||
} |
||||
|
||||
return false; |
||||
} |
||||
|
||||
/** |
||||
* Convert regexp to namespace |
||||
* |
||||
* @param {RegExp} regxep |
||||
* @return {String} namespace |
||||
* @api private |
||||
*/ |
||||
function toNamespace(regexp) { |
||||
return regexp.toString() |
||||
.substring(2, regexp.toString().length - 2) |
||||
.replace(/\.\*\?$/, '*'); |
||||
} |
||||
|
||||
/** |
||||
* Coerce `val`. |
||||
* |
||||
* @param {Mixed} val |
||||
* @return {Mixed} |
||||
* @api private |
||||
*/ |
||||
function coerce(val) { |
||||
if (val instanceof Error) { |
||||
return val.stack || val.message; |
||||
} |
||||
return val; |
||||
} |
||||
|
||||
createDebug.enable(createDebug.load()); |
||||
|
||||
return createDebug; |
||||
} |
||||
|
||||
module.exports = setup; |
||||
@ -0,0 +1,10 @@
|
||||
/** |
||||
* Detect Electron renderer / nwjs process, which is node, but we should |
||||
* treat as a browser. |
||||
*/ |
||||
|
||||
if (typeof process === 'undefined' || process.type === 'renderer' || process.browser === true || process.__nwjs) { |
||||
module.exports = require('./browser.js'); |
||||
} else { |
||||
module.exports = require('./node.js'); |
||||
} |
||||
@ -0,0 +1,257 @@
|
||||
/** |
||||
* Module dependencies. |
||||
*/ |
||||
|
||||
const tty = require('tty'); |
||||
const util = require('util'); |
||||
|
||||
/** |
||||
* This is the Node.js implementation of `debug()`. |
||||
*/ |
||||
|
||||
exports.init = init; |
||||
exports.log = log; |
||||
exports.formatArgs = formatArgs; |
||||
exports.save = save; |
||||
exports.load = load; |
||||
exports.useColors = useColors; |
||||
|
||||
/** |
||||
* Colors. |
||||
*/ |
||||
|
||||
exports.colors = [6, 2, 3, 4, 5, 1]; |
||||
|
||||
try { |
||||
// Optional dependency (as in, doesn't need to be installed, NOT like optionalDependencies in package.json)
|
||||
// eslint-disable-next-line import/no-extraneous-dependencies
|
||||
const supportsColor = require('supports-color'); |
||||
|
||||
if (supportsColor && (supportsColor.stderr || supportsColor).level >= 2) { |
||||
exports.colors = [ |
||||
20, |
||||
21, |
||||
26, |
||||
27, |
||||
32, |
||||
33, |
||||
38, |
||||
39, |
||||
40, |
||||
41, |
||||
42, |
||||
43, |
||||
44, |
||||
45, |
||||
56, |
||||
57, |
||||
62, |
||||
63, |
||||
68, |
||||
69, |
||||
74, |
||||
75, |
||||
76, |
||||
77, |
||||
78, |
||||
79, |
||||
80, |
||||
81, |
||||
92, |
||||
93, |
||||
98, |
||||
99, |
||||
112, |
||||
113, |
||||
128, |
||||
129, |
||||
134, |
||||
135, |
||||
148, |
||||
149, |
||||
160, |
||||
161, |
||||
162, |
||||
163, |
||||
164, |
||||
165, |
||||
166, |
||||
167, |
||||
168, |
||||
169, |
||||
170, |
||||
171, |
||||
172, |
||||
173, |
||||
178, |
||||
179, |
||||
184, |
||||
185, |
||||
196, |
||||
197, |
||||
198, |
||||
199, |
||||
200, |
||||
201, |
||||
202, |
||||
203, |
||||
204, |
||||
205, |
||||
206, |
||||
207, |
||||
208, |
||||
209, |
||||
214, |
||||
215, |
||||
220, |
||||
221 |
||||
]; |
||||
} |
||||
} catch (error) { |
||||
// Swallow - we only care if `supports-color` is available; it doesn't have to be.
|
||||
} |
||||
|
||||
/** |
||||
* Build up the default `inspectOpts` object from the environment variables. |
||||
* |
||||
* $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js |
||||
*/ |
||||
|
||||
exports.inspectOpts = Object.keys(process.env).filter(key => { |
||||
return /^debug_/i.test(key); |
||||
}).reduce((obj, key) => { |
||||
// Camel-case
|
||||
const prop = key |
||||
.substring(6) |
||||
.toLowerCase() |
||||
.replace(/_([a-z])/g, (_, k) => { |
||||
return k.toUpperCase(); |
||||
}); |
||||
|
||||
// Coerce string value into JS value
|
||||
let val = process.env[key]; |
||||
if (/^(yes|on|true|enabled)$/i.test(val)) { |
||||
val = true; |
||||
} else if (/^(no|off|false|disabled)$/i.test(val)) { |
||||
val = false; |
||||
} else if (val === 'null') { |
||||
val = null; |
||||
} else { |
||||
val = Number(val); |
||||
} |
||||
|
||||
obj[prop] = val; |
||||
return obj; |
||||
}, {}); |
||||
|
||||
/** |
||||
* Is stdout a TTY? Colored output is enabled when `true`. |
||||
*/ |
||||
|
||||
function useColors() { |
||||
return 'colors' in exports.inspectOpts ? |
||||
Boolean(exports.inspectOpts.colors) : |
||||
tty.isatty(process.stderr.fd); |
||||
} |
||||
|
||||
/** |
||||
* Adds ANSI color escape codes if enabled. |
||||
* |
||||
* @api public |
||||
*/ |
||||
|
||||
function formatArgs(args) { |
||||
const {namespace: name, useColors} = this; |
||||
|
||||
if (useColors) { |
||||
const c = this.color; |
||||
const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c); |
||||
const prefix = ` ${colorCode};1m${name} \u001B[0m`; |
||||
|
||||
args[0] = prefix + args[0].split('\n').join('\n' + prefix); |
||||
args.push(colorCode + 'm+' + module.exports.humanize(this.diff) + '\u001B[0m'); |
||||
} else { |
||||
args[0] = getDate() + name + ' ' + args[0]; |
||||
} |
||||
} |
||||
|
||||
function getDate() { |
||||
if (exports.inspectOpts.hideDate) { |
||||
return ''; |
||||
} |
||||
return new Date().toISOString() + ' '; |
||||
} |
||||
|
||||
/** |
||||
* Invokes `util.format()` with the specified arguments and writes to stderr. |
||||
*/ |
||||
|
||||
function log(...args) { |
||||
return process.stderr.write(util.format(...args) + '\n'); |
||||
} |
||||
|
||||
/** |
||||
* Save `namespaces`. |
||||
* |
||||
* @param {String} namespaces |
||||
* @api private |
||||
*/ |
||||
function save(namespaces) { |
||||
if (namespaces) { |
||||
process.env.DEBUG = namespaces; |
||||
} else { |
||||
// If you set a process.env field to null or undefined, it gets cast to the
|
||||
// string 'null' or 'undefined'. Just delete instead.
|
||||
delete process.env.DEBUG; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Load `namespaces`. |
||||
* |
||||
* @return {String} returns the previously persisted debug modes |
||||
* @api private |
||||
*/ |
||||
|
||||
function load() { |
||||
return process.env.DEBUG; |
||||
} |
||||
|
||||
/** |
||||
* Init logic for `debug` instances. |
||||
* |
||||
* Create a new `inspectOpts` object in case `useColors` is set |
||||
* differently for a particular `debug` instance. |
||||
*/ |
||||
|
||||
function init(debug) { |
||||
debug.inspectOpts = {}; |
||||
|
||||
const keys = Object.keys(exports.inspectOpts); |
||||
for (let i = 0; i < keys.length; i++) { |
||||
debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]]; |
||||
} |
||||
} |
||||
|
||||
module.exports = require('./common')(exports); |
||||
|
||||
const {formatters} = module.exports; |
||||
|
||||
/** |
||||
* Map %o to `util.inspect()`, all on a single line. |
||||
*/ |
||||
|
||||
formatters.o = function (v) { |
||||
this.inspectOpts.colors = this.useColors; |
||||
return util.inspect(v, this.inspectOpts) |
||||
.replace(/\s*\n\s*/g, ' '); |
||||
}; |
||||
|
||||
/** |
||||
* Map %O to `util.inspect()`, allowing multiple lines if needed. |
||||
*/ |
||||
|
||||
formatters.O = function (v) { |
||||
this.inspectOpts.colors = this.useColors; |
||||
return util.inspect(v, this.inspectOpts); |
||||
}; |
||||
@ -0,0 +1,137 @@
|
||||
https-proxy-agent |
||||
================ |
||||
### An HTTP(s) proxy `http.Agent` implementation for HTTPS |
||||
[](https://github.com/TooTallNate/node-https-proxy-agent/actions?workflow=Node+CI) |
||||
|
||||
This module provides an `http.Agent` implementation that connects to a specified |
||||
HTTP or HTTPS proxy server, and can be used with the built-in `https` module. |
||||
|
||||
Specifically, this `Agent` implementation connects to an intermediary "proxy" |
||||
server and issues the [CONNECT HTTP method][CONNECT], which tells the proxy to |
||||
open a direct TCP connection to the destination server. |
||||
|
||||
Since this agent implements the CONNECT HTTP method, it also works with other |
||||
protocols that use this method when connecting over proxies (i.e. WebSockets). |
||||
See the "Examples" section below for more. |
||||
|
||||
|
||||
Installation |
||||
------------ |
||||
|
||||
Install with `npm`: |
||||
|
||||
``` bash |
||||
$ npm install https-proxy-agent |
||||
``` |
||||
|
||||
|
||||
Examples |
||||
-------- |
||||
|
||||
#### `https` module example |
||||
|
||||
``` js |
||||
var url = require('url'); |
||||
var https = require('https'); |
||||
var HttpsProxyAgent = require('https-proxy-agent'); |
||||
|
||||
// HTTP/HTTPS proxy to connect to |
||||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128'; |
||||
console.log('using proxy server %j', proxy); |
||||
|
||||
// HTTPS endpoint for the proxy to connect to |
||||
var endpoint = process.argv[2] || 'https://graph.facebook.com/tootallnate'; |
||||
console.log('attempting to GET %j', endpoint); |
||||
var options = url.parse(endpoint); |
||||
|
||||
// create an instance of the `HttpsProxyAgent` class with the proxy server information |
||||
var agent = new HttpsProxyAgent(proxy); |
||||
options.agent = agent; |
||||
|
||||
https.get(options, function (res) { |
||||
console.log('"response" event!', res.headers); |
||||
res.pipe(process.stdout); |
||||
}); |
||||
``` |
||||
|
||||
#### `ws` WebSocket connection example |
||||
|
||||
``` js |
||||
var url = require('url'); |
||||
var WebSocket = require('ws'); |
||||
var HttpsProxyAgent = require('https-proxy-agent'); |
||||
|
||||
// HTTP/HTTPS proxy to connect to |
||||
var proxy = process.env.http_proxy || 'http://168.63.76.32:3128'; |
||||
console.log('using proxy server %j', proxy); |
||||
|
||||
// WebSocket endpoint for the proxy to connect to |
||||
var endpoint = process.argv[2] || 'ws://echo.websocket.org'; |
||||
var parsed = url.parse(endpoint); |
||||
console.log('attempting to connect to WebSocket %j', endpoint); |
||||
|
||||
// create an instance of the `HttpsProxyAgent` class with the proxy server information |
||||
var options = url.parse(proxy); |
||||
|
||||
var agent = new HttpsProxyAgent(options); |
||||
|
||||
// finally, initiate the WebSocket connection |
||||
var socket = new WebSocket(endpoint, { agent: agent }); |
||||
|
||||
socket.on('open', function () { |
||||
console.log('"open" event!'); |
||||
socket.send('hello world'); |
||||
}); |
||||
|
||||
socket.on('message', function (data, flags) { |
||||
console.log('"message" event! %j %j', data, flags); |
||||
socket.close(); |
||||
}); |
||||
``` |
||||
|
||||
API |
||||
--- |
||||
|
||||
### new HttpsProxyAgent(Object options) |
||||
|
||||
The `HttpsProxyAgent` class implements an `http.Agent` subclass that connects |
||||
to the specified "HTTP(s) proxy server" in order to proxy HTTPS and/or WebSocket |
||||
requests. This is achieved by using the [HTTP `CONNECT` method][CONNECT]. |
||||
|
||||
The `options` argument may either be a string URI of the proxy server to use, or an |
||||
"options" object with more specific properties: |
||||
|
||||
* `host` - String - Proxy host to connect to (may use `hostname` as well). Required. |
||||
* `port` - Number - Proxy port to connect to. Required. |
||||
* `protocol` - String - If `https:`, then use TLS to connect to the proxy. |
||||
* `headers` - Object - Additional HTTP headers to be sent on the HTTP CONNECT method. |
||||
* Any other options given are passed to the `net.connect()`/`tls.connect()` functions. |
||||
|
||||
|
||||
License |
||||
------- |
||||
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining |
||||
a copy of this software and associated documentation files (the |
||||
'Software'), to deal in the Software without restriction, including |
||||
without limitation the rights to use, copy, modify, merge, publish, |
||||
distribute, sublicense, and/or sell copies of the Software, and to |
||||
permit persons to whom the Software is furnished to do so, subject to |
||||
the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be |
||||
included in all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
||||
|
||||
[CONNECT]: http://en.wikipedia.org/wiki/HTTP_tunnel#HTTP_CONNECT_Tunneling |
||||
@ -0,0 +1,30 @@
|
||||
/// <reference types="node" />
|
||||
import net from 'net'; |
||||
import { Agent, ClientRequest, RequestOptions } from 'agent-base'; |
||||
import { HttpsProxyAgentOptions } from '.'; |
||||
/** |
||||
* The `HttpsProxyAgent` implements an HTTP Agent subclass that connects to |
||||
* the specified "HTTP(s) proxy server" in order to proxy HTTPS requests. |
||||
* |
||||
* Outgoing HTTP requests are first tunneled through the proxy server using the |
||||
* `CONNECT` HTTP request method to establish a connection to the proxy server, |
||||
* and then the proxy server connects to the destination target and issues the |
||||
* HTTP request from the proxy server. |
||||
* |
||||
* `https:` requests have their socket connection upgraded to TLS once |
||||
* the connection to the proxy server has been established. |
||||
* |
||||
* @api public |
||||
*/ |
||||
export default class HttpsProxyAgent extends Agent { |
||||
private secureProxy; |
||||
private proxy; |
||||
constructor(_opts: string | HttpsProxyAgentOptions); |
||||
/** |
||||
* Called when the node-core HTTP client library is creating a |
||||
* new HTTP request. |
||||
* |
||||
* @api protected |
||||
*/ |
||||
callback(req: ClientRequest, opts: RequestOptions): Promise<net.Socket>; |
||||
} |
||||
@ -0,0 +1,180 @@
|
||||
"use strict"; |
||||
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { |
||||
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } |
||||
return new (P || (P = Promise))(function (resolve, reject) { |
||||
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } |
||||
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } |
||||
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } |
||||
step((generator = generator.apply(thisArg, _arguments || [])).next()); |
||||
}); |
||||
}; |
||||
var __importDefault = (this && this.__importDefault) || function (mod) { |
||||
return (mod && mod.__esModule) ? mod : { "default": mod }; |
||||
}; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const net_1 = __importDefault(require("net")); |
||||
const tls_1 = __importDefault(require("tls")); |
||||
const url_1 = __importDefault(require("url")); |
||||
const assert_1 = __importDefault(require("assert")); |
||||
const debug_1 = __importDefault(require("debug")); |
||||
const agent_base_1 = require("agent-base"); |
||||
const parse_proxy_response_1 = __importDefault(require("./parse-proxy-response")); |
||||
const debug = debug_1.default('https-proxy-agent:agent'); |
||||
/** |
||||
* The `HttpsProxyAgent` implements an HTTP Agent subclass that connects to |
||||
* the specified "HTTP(s) proxy server" in order to proxy HTTPS requests. |
||||
* |
||||
* Outgoing HTTP requests are first tunneled through the proxy server using the |
||||
* `CONNECT` HTTP request method to establish a connection to the proxy server, |
||||
* and then the proxy server connects to the destination target and issues the |
||||
* HTTP request from the proxy server. |
||||
* |
||||
* `https:` requests have their socket connection upgraded to TLS once |
||||
* the connection to the proxy server has been established. |
||||
* |
||||
* @api public |
||||
*/ |
||||
class HttpsProxyAgent extends agent_base_1.Agent { |
||||
constructor(_opts) { |
||||
let opts; |
||||
if (typeof _opts === 'string') { |
||||
opts = url_1.default.parse(_opts); |
||||
} |
||||
else { |
||||
opts = _opts; |
||||
} |
||||
if (!opts) { |
||||
throw new Error('an HTTP(S) proxy server `host` and `port` must be specified!'); |
||||
} |
||||
debug('creating new HttpsProxyAgent instance: %o', opts); |
||||
super(opts); |
||||
const proxy = Object.assign({}, opts); |
||||
// If `true`, then connect to the proxy server over TLS.
|
||||
// Defaults to `false`.
|
||||
this.secureProxy = opts.secureProxy || isHTTPS(proxy.protocol); |
||||
// Prefer `hostname` over `host`, and set the `port` if needed.
|
||||
proxy.host = proxy.hostname || proxy.host; |
||||
if (typeof proxy.port === 'string') { |
||||
proxy.port = parseInt(proxy.port, 10); |
||||
} |
||||
if (!proxy.port && proxy.host) { |
||||
proxy.port = this.secureProxy ? 443 : 80; |
||||
} |
||||
// ALPN is supported by Node.js >= v5.
|
||||
// attempt to negotiate http/1.1 for proxy servers that support http/2
|
||||
if (this.secureProxy && !('ALPNProtocols' in proxy)) { |
||||
proxy.ALPNProtocols = ['http 1.1']; |
||||
} |
||||
if (proxy.host && proxy.path) { |
||||
// If both a `host` and `path` are specified then it's most likely
|
||||
// the result of a `url.parse()` call... we need to remove the
|
||||
// `path` portion so that `net.connect()` doesn't attempt to open
|
||||
// that as a Unix socket file.
|
||||
delete proxy.path; |
||||
delete proxy.pathname; |
||||
} |
||||
this.proxy = proxy; |
||||
} |
||||
/** |
||||
* Called when the node-core HTTP client library is creating a |
||||
* new HTTP request. |
||||
* |
||||
* @api protected |
||||
*/ |
||||
callback(req, opts) { |
||||
return __awaiter(this, void 0, void 0, function* () { |
||||
const { proxy, secureProxy } = this; |
||||
// Create a socket connection to the proxy server.
|
||||
let socket; |
||||
if (secureProxy) { |
||||
debug('Creating `tls.Socket`: %o', proxy); |
||||
socket = tls_1.default.connect(proxy); |
||||
} |
||||
else { |
||||
debug('Creating `net.Socket`: %o', proxy); |
||||
socket = net_1.default.connect(proxy); |
||||
} |
||||
const headers = Object.assign({}, proxy.headers); |
||||
const hostname = `${opts.host}:${opts.port}`; |
||||
let payload = `CONNECT ${hostname} HTTP/1.1\r\n`; |
||||
// Inject the `Proxy-Authorization` header if necessary.
|
||||
if (proxy.auth) { |
||||
headers['Proxy-Authorization'] = `Basic ${Buffer.from(proxy.auth).toString('base64')}`; |
||||
} |
||||
// The `Host` header should only include the port
|
||||
// number when it is not the default port.
|
||||
let { host, port, secureEndpoint } = opts; |
||||
if (!isDefaultPort(port, secureEndpoint)) { |
||||
host += `:${port}`; |
||||
} |
||||
headers.Host = host; |
||||
headers.Connection = 'close'; |
||||
for (const name of Object.keys(headers)) { |
||||
payload += `${name}: ${headers[name]}\r\n`; |
||||
} |
||||
const proxyResponsePromise = parse_proxy_response_1.default(socket); |
||||
socket.write(`${payload}\r\n`); |
||||
const { statusCode, buffered } = yield proxyResponsePromise; |
||||
if (statusCode === 200) { |
||||
req.once('socket', resume); |
||||
if (opts.secureEndpoint) { |
||||
const servername = opts.servername || opts.host; |
||||
if (!servername) { |
||||
throw new Error('Could not determine "servername"'); |
||||
} |
||||
// The proxy is connecting to a TLS server, so upgrade
|
||||
// this socket connection to a TLS connection.
|
||||
debug('Upgrading socket connection to TLS'); |
||||
return tls_1.default.connect(Object.assign(Object.assign({}, omit(opts, 'host', 'hostname', 'path', 'port')), { socket, |
||||
servername })); |
||||
} |
||||
return socket; |
||||
} |
||||
// Some other status code that's not 200... need to re-play the HTTP
|
||||
// header "data" events onto the socket once the HTTP machinery is
|
||||
// attached so that the node core `http` can parse and handle the
|
||||
// error status code.
|
||||
// Close the original socket, and a new "fake" socket is returned
|
||||
// instead, so that the proxy doesn't get the HTTP request
|
||||
// written to it (which may contain `Authorization` headers or other
|
||||
// sensitive data).
|
||||
//
|
||||
// See: https://hackerone.com/reports/541502
|
||||
socket.destroy(); |
||||
const fakeSocket = new net_1.default.Socket(); |
||||
fakeSocket.readable = true; |
||||
// Need to wait for the "socket" event to re-play the "data" events.
|
||||
req.once('socket', (s) => { |
||||
debug('replaying proxy buffer for failed request'); |
||||
assert_1.default(s.listenerCount('data') > 0); |
||||
// Replay the "buffered" Buffer onto the fake `socket`, since at
|
||||
// this point the HTTP module machinery has been hooked up for
|
||||
// the user.
|
||||
s.push(buffered); |
||||
s.push(null); |
||||
}); |
||||
return fakeSocket; |
||||
}); |
||||
} |
||||
} |
||||
exports.default = HttpsProxyAgent; |
||||
function resume(socket) { |
||||
socket.resume(); |
||||
} |
||||
function isDefaultPort(port, secure) { |
||||
return Boolean((!secure && port === 80) || (secure && port === 443)); |
||||
} |
||||
function isHTTPS(protocol) { |
||||
return typeof protocol === 'string' ? /^https:?$/i.test(protocol) : false; |
||||
} |
||||
function omit(obj, ...keys) { |
||||
const ret = {}; |
||||
let key; |
||||
for (key in obj) { |
||||
if (!keys.includes(key)) { |
||||
ret[key] = obj[key]; |
||||
} |
||||
} |
||||
return ret; |
||||
} |
||||
//# sourceMappingURL=agent.js.map
|
||||
@ -0,0 +1 @@
|
||||
{"version":3,"file":"agent.js","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,8CAAsB;AACtB,8CAAsB;AACtB,8CAAsB;AACtB,oDAA4B;AAC5B,kDAAgC;AAEhC,2CAAkE;AAElE,kFAAwD;AAExD,MAAM,KAAK,GAAG,eAAW,CAAC,yBAAyB,CAAC,CAAC;AAErD;;;;;;;;;;;;;GAaG;AACH,MAAqB,eAAgB,SAAQ,kBAAK;IAIjD,YAAY,KAAsC;QACjD,IAAI,IAA4B,CAAC;QACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC9B,IAAI,GAAG,aAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACxB;aAAM;YACN,IAAI,GAAG,KAAK,CAAC;SACb;QACD,IAAI,CAAC,IAAI,EAAE;YACV,MAAM,IAAI,KAAK,CACd,8DAA8D,CAC9D,CAAC;SACF;QACD,KAAK,CAAC,2CAA2C,EAAE,IAAI,CAAC,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,CAAC;QAEZ,MAAM,KAAK,qBAAgC,IAAI,CAAE,CAAC;QAElD,wDAAwD;QACxD,uBAAuB;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE/D,+DAA+D;QAC/D,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,CAAC;QAC1C,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACnC,KAAK,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SACtC;QACD,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;YAC9B,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;SACzC;QAED,sCAAsC;QACtC,sEAAsE;QACtE,IAAI,IAAI,CAAC,WAAW,IAAI,CAAC,CAAC,eAAe,IAAI,KAAK,CAAC,EAAE;YACpD,KAAK,CAAC,aAAa,GAAG,CAAC,UAAU,CAAC,CAAC;SACnC;QAED,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;YAC7B,kEAAkE;YAClE,8DAA8D;YAC9D,iEAAiE;YACjE,8BAA8B;YAC9B,OAAO,KAAK,CAAC,IAAI,CAAC;YAClB,OAAO,KAAK,CAAC,QAAQ,CAAC;SACtB;QAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACG,QAAQ,CACb,GAAkB,EAClB,IAAoB;;YAEpB,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;YAEpC,kDAAkD;YAClD,IAAI,MAAkB,CAAC;YACvB,IAAI,WAAW,EAAE;gBAChB,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;gBAC1C,MAAM,GAAG,aAAG,CAAC,OAAO,CAAC,KAA8B,CAAC,CAAC;aACrD;iBAAM;gBACN,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;gBAC1C,MAAM,GAAG,aAAG,CAAC,OAAO,CAAC,KAA2B,CAAC,CAAC;aAClD;YAED,MAAM,OAAO,qBAA6B,KAAK,CAAC,OAAO,CAAE,CAAC;YAC1D,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC7C,IAAI,OAAO,GAAG,WAAW,QAAQ,eAAe,CAAC;YAEjD,wDAAwD;YACxD,IAAI,KAAK,CAAC,IAAI,EAAE;gBACf,OAAO,CAAC,qBAAqB,CAAC,GAAG,SAAS,MAAM,CAAC,IAAI,CACpD,KAAK,CAAC,IAAI,CACV,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;aACvB;YAED,iDAAiD;YACjD,0CAA0C;YAC1C,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;YAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE;gBACzC,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;aACnB;YACD,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;YAEpB,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBACxC,OAAO,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;aAC3C;YAED,MAAM,oBAAoB,GAAG,8BAAkB,CAAC,MAAM,CAAC,CAAC;YAExD,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;YAE/B,MAAM,EACL,UAAU,EACV,QAAQ,EACR,GAAG,MAAM,oBAAoB,CAAC;YAE/B,IAAI,UAAU,KAAK,GAAG,EAAE;gBACvB,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAE3B,IAAI,IAAI,CAAC,cAAc,EAAE;oBACxB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC;oBAChD,IAAI,CAAC,UAAU,EAAE;wBAChB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;qBACpD;oBACD,sDAAsD;oBACtD,8CAA8C;oBAC9C,KAAK,CAAC,oCAAoC,CAAC,CAAC;oBAC5C,OAAO,aAAG,CAAC,OAAO,iCACd,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,KACjD,MAAM;wBACN,UAAU,IACT,CAAC;iBACH;gBAED,OAAO,MAAM,CAAC;aACd;YAED,oEAAoE;YACpE,kEAAkE;YAClE,iEAAiE;YACjE,qBAAqB;YAErB,iEAAiE;YACjE,0DAA0D;YAC1D,oEAAoE;YACpE,mBAAmB;YACnB,EAAE;YACF,4CAA4C;YAC5C,MAAM,CAAC,OAAO,EAAE,CAAC;YAEjB,MAAM,UAAU,GAAG,IAAI,aAAG,CAAC,MAAM,EAAE,CAAC;YACpC,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC;YAE3B,oEAAoE;YACpE,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAa,EAAE,EAAE;gBACpC,KAAK,CAAC,2CAA2C,CAAC,CAAC;gBACnD,gBAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBAEpC,gEAAgE;gBAChE,8DAA8D;gBAC9D,YAAY;gBACZ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACjB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,OAAO,UAAU,CAAC;QACnB,CAAC;KAAA;CACD;AA9JD,kCA8JC;AAED,SAAS,MAAM,CAAC,MAAkC;IACjD,MAAM,CAAC,MAAM,EAAE,CAAC;AACjB,CAAC;AAED,SAAS,aAAa,CAAC,IAAY,EAAE,MAAe;IACnD,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,OAAO,CAAC,QAAwB;IACxC,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC3E,CAAC;AAED,SAAS,IAAI,CACZ,GAAM,EACN,GAAG,IAAO;IAIV,MAAM,GAAG,GAAG,EAEX,CAAC;IACF,IAAI,GAAqB,CAAC;IAC1B,KAAK,GAAG,IAAI,GAAG,EAAE;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;SACpB;KACD;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"} |
||||
@ -0,0 +1,23 @@
|
||||
/// <reference types="node" />
|
||||
import net from 'net'; |
||||
import tls from 'tls'; |
||||
import { Url } from 'url'; |
||||
import { AgentOptions } from 'agent-base'; |
||||
import { OutgoingHttpHeaders } from 'http'; |
||||
import _HttpsProxyAgent from './agent'; |
||||
declare function createHttpsProxyAgent(opts: string | createHttpsProxyAgent.HttpsProxyAgentOptions): _HttpsProxyAgent; |
||||
declare namespace createHttpsProxyAgent { |
||||
interface BaseHttpsProxyAgentOptions { |
||||
headers?: OutgoingHttpHeaders; |
||||
secureProxy?: boolean; |
||||
host?: string | null; |
||||
path?: string | null; |
||||
port?: string | number | null; |
||||
} |
||||
export interface HttpsProxyAgentOptions extends AgentOptions, BaseHttpsProxyAgentOptions, Partial<Omit<Url & net.NetConnectOpts & tls.ConnectionOptions, keyof BaseHttpsProxyAgentOptions>> { |
||||
} |
||||
export type HttpsProxyAgent = _HttpsProxyAgent; |
||||
export const HttpsProxyAgent: typeof _HttpsProxyAgent; |
||||
export {}; |
||||
} |
||||
export = createHttpsProxyAgent; |
||||
@ -0,0 +1,14 @@
|
||||
"use strict"; |
||||
var __importDefault = (this && this.__importDefault) || function (mod) { |
||||
return (mod && mod.__esModule) ? mod : { "default": mod }; |
||||
}; |
||||
const agent_1 = __importDefault(require("./agent")); |
||||
function createHttpsProxyAgent(opts) { |
||||
return new agent_1.default(opts); |
||||
} |
||||
(function (createHttpsProxyAgent) { |
||||
createHttpsProxyAgent.HttpsProxyAgent = agent_1.default; |
||||
createHttpsProxyAgent.prototype = agent_1.default.prototype; |
||||
})(createHttpsProxyAgent || (createHttpsProxyAgent = {})); |
||||
module.exports = createHttpsProxyAgent; |
||||
//# sourceMappingURL=index.js.map
|
||||
@ -0,0 +1 @@
|
||||
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAKA,oDAAuC;AAEvC,SAAS,qBAAqB,CAC7B,IAA2D;IAE3D,OAAO,IAAI,eAAgB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,WAAU,qBAAqB;IAoBjB,qCAAe,GAAG,eAAgB,CAAC;IAEhD,qBAAqB,CAAC,SAAS,GAAG,eAAgB,CAAC,SAAS,CAAC;AAC9D,CAAC,EAvBS,qBAAqB,KAArB,qBAAqB,QAuB9B;AAED,iBAAS,qBAAqB,CAAC"} |
||||
@ -0,0 +1,7 @@
|
||||
/// <reference types="node" />
|
||||
import { Readable } from 'stream'; |
||||
export interface ProxyResponse { |
||||
statusCode: number; |
||||
buffered: Buffer; |
||||
} |
||||
export default function parseProxyResponse(socket: Readable): Promise<ProxyResponse>; |
||||
@ -0,0 +1,66 @@
|
||||
"use strict"; |
||||
var __importDefault = (this && this.__importDefault) || function (mod) { |
||||
return (mod && mod.__esModule) ? mod : { "default": mod }; |
||||
}; |
||||
Object.defineProperty(exports, "__esModule", { value: true }); |
||||
const debug_1 = __importDefault(require("debug")); |
||||
const debug = debug_1.default('https-proxy-agent:parse-proxy-response'); |
||||
function parseProxyResponse(socket) { |
||||
return new Promise((resolve, reject) => { |
||||
// we need to buffer any HTTP traffic that happens with the proxy before we get
|
||||
// the CONNECT response, so that if the response is anything other than an "200"
|
||||
// response code, then we can re-play the "data" events on the socket once the
|
||||
// HTTP parser is hooked up...
|
||||
let buffersLength = 0; |
||||
const buffers = []; |
||||
function read() { |
||||
const b = socket.read(); |
||||
if (b) |
||||
ondata(b); |
||||
else |
||||
socket.once('readable', read); |
||||
} |
||||
function cleanup() { |
||||
socket.removeListener('end', onend); |
||||
socket.removeListener('error', onerror); |
||||
socket.removeListener('close', onclose); |
||||
socket.removeListener('readable', read); |
||||
} |
||||
function onclose(err) { |
||||
debug('onclose had error %o', err); |
||||
} |
||||
function onend() { |
||||
debug('onend'); |
||||
} |
||||
function onerror(err) { |
||||
cleanup(); |
||||
debug('onerror %o', err); |
||||
reject(err); |
||||
} |
||||
function ondata(b) { |
||||
buffers.push(b); |
||||
buffersLength += b.length; |
||||
const buffered = Buffer.concat(buffers, buffersLength); |
||||
const endOfHeaders = buffered.indexOf('\r\n\r\n'); |
||||
if (endOfHeaders === -1) { |
||||
// keep buffering
|
||||
debug('have not received end of HTTP headers yet...'); |
||||
read(); |
||||
return; |
||||
} |
||||
const firstLine = buffered.toString('ascii', 0, buffered.indexOf('\r\n')); |
||||
const statusCode = +firstLine.split(' ')[1]; |
||||
debug('got proxy server response: %o', firstLine); |
||||
resolve({ |
||||
statusCode, |
||||
buffered |
||||
}); |
||||
} |
||||
socket.on('error', onerror); |
||||
socket.on('close', onclose); |
||||
socket.on('end', onend); |
||||
read(); |
||||
}); |
||||
} |
||||
exports.default = parseProxyResponse; |
||||
//# sourceMappingURL=parse-proxy-response.js.map
|
||||
@ -0,0 +1 @@
|
||||
{"version":3,"file":"parse-proxy-response.js","sourceRoot":"","sources":["../src/parse-proxy-response.ts"],"names":[],"mappings":";;;;;AAAA,kDAAgC;AAGhC,MAAM,KAAK,GAAG,eAAW,CAAC,wCAAwC,CAAC,CAAC;AAOpE,SAAwB,kBAAkB,CACzC,MAAgB;IAEhB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACtC,+EAA+E;QAC/E,gFAAgF;QAChF,8EAA8E;QAC9E,8BAA8B;QAC9B,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,SAAS,IAAI;YACZ,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;YACxB,IAAI,CAAC;gBAAE,MAAM,CAAC,CAAC,CAAC,CAAC;;gBACZ,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QAED,SAAS,OAAO;YACf,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACxC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACxC,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;QACzC,CAAC;QAED,SAAS,OAAO,CAAC,GAAW;YAC3B,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC;QAED,SAAS,KAAK;YACb,KAAK,CAAC,OAAO,CAAC,CAAC;QAChB,CAAC;QAED,SAAS,OAAO,CAAC,GAAU;YAC1B,OAAO,EAAE,CAAC;YACV,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,CAAC;QACb,CAAC;QAED,SAAS,MAAM,CAAC,CAAS;YACxB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAChB,aAAa,IAAI,CAAC,CAAC,MAAM,CAAC;YAE1B,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACvD,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAElD,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE;gBACxB,iBAAiB;gBACjB,KAAK,CAAC,8CAA8C,CAAC,CAAC;gBACtD,IAAI,EAAE,CAAC;gBACP,OAAO;aACP;YAED,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAClC,OAAO,EACP,CAAC,EACD,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CACxB,CAAC;YACF,MAAM,UAAU,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,KAAK,CAAC,+BAA+B,EAAE,SAAS,CAAC,CAAC;YAClD,OAAO,CAAC;gBACP,UAAU;gBACV,QAAQ;aACR,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAExB,IAAI,EAAE,CAAC;IACR,CAAC,CAAC,CAAC;AACJ,CAAC;AAvED,qCAuEC"} |
||||
@ -0,0 +1,86 @@
|
||||
{ |
||||
"_from": "https-proxy-agent@^5.0.0", |
||||
"_id": "https-proxy-agent@5.0.0", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-EkYm5BcKUGiduxzSt3Eppko+PiNWNEpa4ySk9vTC6wDsQJW9rHSa+UhGNJoRYp7bz6Ht1eaRIa6QaJqO5rCFbA==", |
||||
"_location": "/https-proxy-agent", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "https-proxy-agent@^5.0.0", |
||||
"name": "https-proxy-agent", |
||||
"escapedName": "https-proxy-agent", |
||||
"rawSpec": "^5.0.0", |
||||
"saveSpec": null, |
||||
"fetchSpec": "^5.0.0" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/wscat" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.0.tgz", |
||||
"_shasum": "e2a90542abb68a762e0a0850f6c9edadfd8506b2", |
||||
"_spec": "https-proxy-agent@^5.0.0", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/wscat", |
||||
"author": { |
||||
"name": "Nathan Rajlich", |
||||
"email": "nathan@tootallnate.net", |
||||
"url": "http://n8.io/" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/TooTallNate/node-https-proxy-agent/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"dependencies": { |
||||
"agent-base": "6", |
||||
"debug": "4" |
||||
}, |
||||
"deprecated": false, |
||||
"description": "An HTTP(s) proxy `http.Agent` implementation for HTTPS", |
||||
"devDependencies": { |
||||
"@types/debug": "4", |
||||
"@types/node": "^12.12.11", |
||||
"@typescript-eslint/eslint-plugin": "1.6.0", |
||||
"@typescript-eslint/parser": "1.1.0", |
||||
"eslint": "5.16.0", |
||||
"eslint-config-airbnb": "17.1.0", |
||||
"eslint-config-prettier": "4.1.0", |
||||
"eslint-import-resolver-typescript": "1.1.1", |
||||
"eslint-plugin-import": "2.16.0", |
||||
"eslint-plugin-jsx-a11y": "6.2.1", |
||||
"eslint-plugin-react": "7.12.4", |
||||
"mocha": "^6.2.2", |
||||
"proxy": "1", |
||||
"rimraf": "^3.0.0", |
||||
"typescript": "^3.5.3" |
||||
}, |
||||
"engines": { |
||||
"node": ">= 6" |
||||
}, |
||||
"files": [ |
||||
"dist" |
||||
], |
||||
"homepage": "https://github.com/TooTallNate/node-https-proxy-agent#readme", |
||||
"keywords": [ |
||||
"https", |
||||
"proxy", |
||||
"endpoint", |
||||
"agent" |
||||
], |
||||
"license": "MIT", |
||||
"main": "dist/index", |
||||
"name": "https-proxy-agent", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git://github.com/TooTallNate/node-https-proxy-agent.git" |
||||
}, |
||||
"scripts": { |
||||
"build": "tsc", |
||||
"prebuild": "rimraf dist", |
||||
"prepublishOnly": "npm run build", |
||||
"test": "mocha --reporter spec", |
||||
"test-lint": "eslint src --ext .js,.ts" |
||||
}, |
||||
"types": "dist/index", |
||||
"version": "5.0.0" |
||||
} |
||||
@ -0,0 +1,162 @@
|
||||
/** |
||||
* Helpers. |
||||
*/ |
||||
|
||||
var s = 1000; |
||||
var m = s * 60; |
||||
var h = m * 60; |
||||
var d = h * 24; |
||||
var w = d * 7; |
||||
var y = d * 365.25; |
||||
|
||||
/** |
||||
* Parse or format the given `val`. |
||||
* |
||||
* Options: |
||||
* |
||||
* - `long` verbose formatting [false] |
||||
* |
||||
* @param {String|Number} val |
||||
* @param {Object} [options] |
||||
* @throws {Error} throw an error if val is not a non-empty string or a number |
||||
* @return {String|Number} |
||||
* @api public |
||||
*/ |
||||
|
||||
module.exports = function(val, options) { |
||||
options = options || {}; |
||||
var type = typeof val; |
||||
if (type === 'string' && val.length > 0) { |
||||
return parse(val); |
||||
} else if (type === 'number' && isFinite(val)) { |
||||
return options.long ? fmtLong(val) : fmtShort(val); |
||||
} |
||||
throw new Error( |
||||
'val is not a non-empty string or a valid number. val=' + |
||||
JSON.stringify(val) |
||||
); |
||||
}; |
||||
|
||||
/** |
||||
* Parse the given `str` and return milliseconds. |
||||
* |
||||
* @param {String} str |
||||
* @return {Number} |
||||
* @api private |
||||
*/ |
||||
|
||||
function parse(str) { |
||||
str = String(str); |
||||
if (str.length > 100) { |
||||
return; |
||||
} |
||||
var match = /^(-?(?:\d+)?\.?\d+) *(milliseconds?|msecs?|ms|seconds?|secs?|s|minutes?|mins?|m|hours?|hrs?|h|days?|d|weeks?|w|years?|yrs?|y)?$/i.exec( |
||||
str |
||||
); |
||||
if (!match) { |
||||
return; |
||||
} |
||||
var n = parseFloat(match[1]); |
||||
var type = (match[2] || 'ms').toLowerCase(); |
||||
switch (type) { |
||||
case 'years': |
||||
case 'year': |
||||
case 'yrs': |
||||
case 'yr': |
||||
case 'y': |
||||
return n * y; |
||||
case 'weeks': |
||||
case 'week': |
||||
case 'w': |
||||
return n * w; |
||||
case 'days': |
||||
case 'day': |
||||
case 'd': |
||||
return n * d; |
||||
case 'hours': |
||||
case 'hour': |
||||
case 'hrs': |
||||
case 'hr': |
||||
case 'h': |
||||
return n * h; |
||||
case 'minutes': |
||||
case 'minute': |
||||
case 'mins': |
||||
case 'min': |
||||
case 'm': |
||||
return n * m; |
||||
case 'seconds': |
||||
case 'second': |
||||
case 'secs': |
||||
case 'sec': |
||||
case 's': |
||||
return n * s; |
||||
case 'milliseconds': |
||||
case 'millisecond': |
||||
case 'msecs': |
||||
case 'msec': |
||||
case 'ms': |
||||
return n; |
||||
default: |
||||
return undefined; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Short format for `ms`. |
||||
* |
||||
* @param {Number} ms |
||||
* @return {String} |
||||
* @api private |
||||
*/ |
||||
|
||||
function fmtShort(ms) { |
||||
var msAbs = Math.abs(ms); |
||||
if (msAbs >= d) { |
||||
return Math.round(ms / d) + 'd'; |
||||
} |
||||
if (msAbs >= h) { |
||||
return Math.round(ms / h) + 'h'; |
||||
} |
||||
if (msAbs >= m) { |
||||
return Math.round(ms / m) + 'm'; |
||||
} |
||||
if (msAbs >= s) { |
||||
return Math.round(ms / s) + 's'; |
||||
} |
||||
return ms + 'ms'; |
||||
} |
||||
|
||||
/** |
||||
* Long format for `ms`. |
||||
* |
||||
* @param {Number} ms |
||||
* @return {String} |
||||
* @api private |
||||
*/ |
||||
|
||||
function fmtLong(ms) { |
||||
var msAbs = Math.abs(ms); |
||||
if (msAbs >= d) { |
||||
return plural(ms, msAbs, d, 'day'); |
||||
} |
||||
if (msAbs >= h) { |
||||
return plural(ms, msAbs, h, 'hour'); |
||||
} |
||||
if (msAbs >= m) { |
||||
return plural(ms, msAbs, m, 'minute'); |
||||
} |
||||
if (msAbs >= s) { |
||||
return plural(ms, msAbs, s, 'second'); |
||||
} |
||||
return ms + ' ms'; |
||||
} |
||||
|
||||
/** |
||||
* Pluralization helper. |
||||
*/ |
||||
|
||||
function plural(ms, msAbs, n, name) { |
||||
var isPlural = msAbs >= n * 1.5; |
||||
return Math.round(ms / n) + ' ' + name + (isPlural ? 's' : ''); |
||||
} |
||||
@ -0,0 +1,21 @@
|
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2016 Zeit, Inc. |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
@ -0,0 +1,69 @@
|
||||
{ |
||||
"_from": "ms@2.1.2", |
||||
"_id": "ms@2.1.2", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", |
||||
"_location": "/ms", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "version", |
||||
"registry": true, |
||||
"raw": "ms@2.1.2", |
||||
"name": "ms", |
||||
"escapedName": "ms", |
||||
"rawSpec": "2.1.2", |
||||
"saveSpec": null, |
||||
"fetchSpec": "2.1.2" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/debug" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", |
||||
"_shasum": "d09d1f357b443f493382a8eb3ccd183872ae6009", |
||||
"_spec": "ms@2.1.2", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/debug", |
||||
"bugs": { |
||||
"url": "https://github.com/zeit/ms/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"deprecated": false, |
||||
"description": "Tiny millisecond conversion utility", |
||||
"devDependencies": { |
||||
"eslint": "4.12.1", |
||||
"expect.js": "0.3.1", |
||||
"husky": "0.14.3", |
||||
"lint-staged": "5.0.0", |
||||
"mocha": "4.0.1" |
||||
}, |
||||
"eslintConfig": { |
||||
"extends": "eslint:recommended", |
||||
"env": { |
||||
"node": true, |
||||
"es6": true |
||||
} |
||||
}, |
||||
"files": [ |
||||
"index.js" |
||||
], |
||||
"homepage": "https://github.com/zeit/ms#readme", |
||||
"license": "MIT", |
||||
"lint-staged": { |
||||
"*.js": [ |
||||
"npm run lint", |
||||
"prettier --single-quote --write", |
||||
"git add" |
||||
] |
||||
}, |
||||
"main": "./index", |
||||
"name": "ms", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/zeit/ms.git" |
||||
}, |
||||
"scripts": { |
||||
"lint": "eslint lib/* bin/*", |
||||
"precommit": "lint-staged", |
||||
"test": "mocha tests.js" |
||||
}, |
||||
"version": "2.1.2" |
||||
} |
||||
@ -0,0 +1,60 @@
|
||||
# ms |
||||
|
||||
[](https://travis-ci.org/zeit/ms) |
||||
[](https://spectrum.chat/zeit) |
||||
|
||||
Use this package to easily convert various time formats to milliseconds. |
||||
|
||||
## Examples |
||||
|
||||
```js |
||||
ms('2 days') // 172800000 |
||||
ms('1d') // 86400000 |
||||
ms('10h') // 36000000 |
||||
ms('2.5 hrs') // 9000000 |
||||
ms('2h') // 7200000 |
||||
ms('1m') // 60000 |
||||
ms('5s') // 5000 |
||||
ms('1y') // 31557600000 |
||||
ms('100') // 100 |
||||
ms('-3 days') // -259200000 |
||||
ms('-1h') // -3600000 |
||||
ms('-200') // -200 |
||||
``` |
||||
|
||||
### Convert from Milliseconds |
||||
|
||||
```js |
||||
ms(60000) // "1m" |
||||
ms(2 * 60000) // "2m" |
||||
ms(-3 * 60000) // "-3m" |
||||
ms(ms('10 hours')) // "10h" |
||||
``` |
||||
|
||||
### Time Format Written-Out |
||||
|
||||
```js |
||||
ms(60000, { long: true }) // "1 minute" |
||||
ms(2 * 60000, { long: true }) // "2 minutes" |
||||
ms(-3 * 60000, { long: true }) // "-3 minutes" |
||||
ms(ms('10 hours'), { long: true }) // "10 hours" |
||||
``` |
||||
|
||||
## Features |
||||
|
||||
- Works both in [Node.js](https://nodejs.org) and in the browser |
||||
- If a number is supplied to `ms`, a string with a unit is returned |
||||
- If a string that contains the number is supplied, it returns it as a number (e.g.: it returns `100` for `'100'`) |
||||
- If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned |
||||
|
||||
## Related Packages |
||||
|
||||
- [ms.macro](https://github.com/knpwrs/ms.macro) - Run `ms` as a macro at build-time. |
||||
|
||||
## Caught a Bug? |
||||
|
||||
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device |
||||
2. Link the package to the global module directory: `npm link` |
||||
3. Within the module you want to test your local development instance of ms, just link it to the dependencies: `npm link ms`. Instead of the default one from npm, Node.js will now use your clone of ms! |
||||
|
||||
As always, you can run the tests using: `npm test` |
||||
@ -0,0 +1,15 @@
|
||||
The ISC License |
||||
|
||||
Copyright (c) Isaac Z. Schlueter and Contributors |
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any |
||||
purpose with or without fee is hereby granted, provided that the above |
||||
copyright notice and this permission notice appear in all copies. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR |
||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
||||
@ -0,0 +1,68 @@
|
||||
# mute-stream |
||||
|
||||
Bytes go in, but they don't come out (when muted). |
||||
|
||||
This is a basic pass-through stream, but when muted, the bytes are |
||||
silently dropped, rather than being passed through. |
||||
|
||||
## Usage |
||||
|
||||
```javascript |
||||
var MuteStream = require('mute-stream') |
||||
|
||||
var ms = new MuteStream(options) |
||||
|
||||
ms.pipe(process.stdout) |
||||
ms.write('foo') // writes 'foo' to stdout |
||||
ms.mute() |
||||
ms.write('bar') // does not write 'bar' |
||||
ms.unmute() |
||||
ms.write('baz') // writes 'baz' to stdout |
||||
|
||||
// can also be used to mute incoming data |
||||
var ms = new MuteStream |
||||
input.pipe(ms) |
||||
|
||||
ms.on('data', function (c) { |
||||
console.log('data: ' + c) |
||||
}) |
||||
|
||||
input.emit('data', 'foo') // logs 'foo' |
||||
ms.mute() |
||||
input.emit('data', 'bar') // does not log 'bar' |
||||
ms.unmute() |
||||
input.emit('data', 'baz') // logs 'baz' |
||||
``` |
||||
|
||||
## Options |
||||
|
||||
All options are optional. |
||||
|
||||
* `replace` Set to a string to replace each character with the |
||||
specified string when muted. (So you can show `****` instead of the |
||||
password, for example.) |
||||
|
||||
* `prompt` If you are using a replacement char, and also using a |
||||
prompt with a readline stream (as for a `Password: *****` input), |
||||
then specify what the prompt is so that backspace will work |
||||
properly. Otherwise, pressing backspace will overwrite the prompt |
||||
with the replacement character, which is weird. |
||||
|
||||
## ms.mute() |
||||
|
||||
Set `muted` to `true`. Turns `.write()` into a no-op. |
||||
|
||||
## ms.unmute() |
||||
|
||||
Set `muted` to `false` |
||||
|
||||
## ms.isTTY |
||||
|
||||
True if the pipe destination is a TTY, or if the incoming pipe source is |
||||
a TTY. |
||||
|
||||
## Other stream methods... |
||||
|
||||
The other standard readable and writable stream methods are all |
||||
available. The MuteStream object acts as a facade to its pipe source |
||||
and destination. |
||||
@ -0,0 +1,145 @@
|
||||
var Stream = require('stream') |
||||
|
||||
module.exports = MuteStream |
||||
|
||||
// var out = new MuteStream(process.stdout)
|
||||
// argument auto-pipes
|
||||
function MuteStream (opts) { |
||||
Stream.apply(this) |
||||
opts = opts || {} |
||||
this.writable = this.readable = true |
||||
this.muted = false |
||||
this.on('pipe', this._onpipe) |
||||
this.replace = opts.replace |
||||
|
||||
// For readline-type situations
|
||||
// This much at the start of a line being redrawn after a ctrl char
|
||||
// is seen (such as backspace) won't be redrawn as the replacement
|
||||
this._prompt = opts.prompt || null |
||||
this._hadControl = false |
||||
} |
||||
|
||||
MuteStream.prototype = Object.create(Stream.prototype) |
||||
|
||||
Object.defineProperty(MuteStream.prototype, 'constructor', { |
||||
value: MuteStream, |
||||
enumerable: false |
||||
}) |
||||
|
||||
MuteStream.prototype.mute = function () { |
||||
this.muted = true |
||||
} |
||||
|
||||
MuteStream.prototype.unmute = function () { |
||||
this.muted = false |
||||
} |
||||
|
||||
Object.defineProperty(MuteStream.prototype, '_onpipe', { |
||||
value: onPipe, |
||||
enumerable: false, |
||||
writable: true, |
||||
configurable: true |
||||
}) |
||||
|
||||
function onPipe (src) { |
||||
this._src = src |
||||
} |
||||
|
||||
Object.defineProperty(MuteStream.prototype, 'isTTY', { |
||||
get: getIsTTY, |
||||
set: setIsTTY, |
||||
enumerable: true, |
||||
configurable: true |
||||
}) |
||||
|
||||
function getIsTTY () { |
||||
return( (this._dest) ? this._dest.isTTY |
||||
: (this._src) ? this._src.isTTY |
||||
: false |
||||
) |
||||
} |
||||
|
||||
// basically just get replace the getter/setter with a regular value
|
||||
function setIsTTY (isTTY) { |
||||
Object.defineProperty(this, 'isTTY', { |
||||
value: isTTY, |
||||
enumerable: true, |
||||
writable: true, |
||||
configurable: true |
||||
}) |
||||
} |
||||
|
||||
Object.defineProperty(MuteStream.prototype, 'rows', { |
||||
get: function () { |
||||
return( this._dest ? this._dest.rows |
||||
: this._src ? this._src.rows |
||||
: undefined ) |
||||
}, enumerable: true, configurable: true }) |
||||
|
||||
Object.defineProperty(MuteStream.prototype, 'columns', { |
||||
get: function () { |
||||
return( this._dest ? this._dest.columns |
||||
: this._src ? this._src.columns |
||||
: undefined ) |
||||
}, enumerable: true, configurable: true }) |
||||
|
||||
|
||||
MuteStream.prototype.pipe = function (dest, options) { |
||||
this._dest = dest |
||||
return Stream.prototype.pipe.call(this, dest, options) |
||||
} |
||||
|
||||
MuteStream.prototype.pause = function () { |
||||
if (this._src) return this._src.pause() |
||||
} |
||||
|
||||
MuteStream.prototype.resume = function () { |
||||
if (this._src) return this._src.resume() |
||||
} |
||||
|
||||
MuteStream.prototype.write = function (c) { |
||||
if (this.muted) { |
||||
if (!this.replace) return true |
||||
if (c.match(/^\u001b/)) { |
||||
if(c.indexOf(this._prompt) === 0) { |
||||
c = c.substr(this._prompt.length); |
||||
c = c.replace(/./g, this.replace); |
||||
c = this._prompt + c; |
||||
} |
||||
this._hadControl = true |
||||
return this.emit('data', c) |
||||
} else { |
||||
if (this._prompt && this._hadControl && |
||||
c.indexOf(this._prompt) === 0) { |
||||
this._hadControl = false |
||||
this.emit('data', this._prompt) |
||||
c = c.substr(this._prompt.length) |
||||
} |
||||
c = c.toString().replace(/./g, this.replace) |
||||
} |
||||
} |
||||
this.emit('data', c) |
||||
} |
||||
|
||||
MuteStream.prototype.end = function (c) { |
||||
if (this.muted) { |
||||
if (c && this.replace) { |
||||
c = c.toString().replace(/./g, this.replace) |
||||
} else { |
||||
c = null |
||||
} |
||||
} |
||||
if (c) this.emit('data', c) |
||||
this.emit('end') |
||||
} |
||||
|
||||
function proxy (fn) { return function () { |
||||
var d = this._dest |
||||
var s = this._src |
||||
if (d && d[fn]) d[fn].apply(d, arguments) |
||||
if (s && s[fn]) s[fn].apply(s, arguments) |
||||
}} |
||||
|
||||
MuteStream.prototype.destroy = proxy('destroy') |
||||
MuteStream.prototype.destroySoon = proxy('destroySoon') |
||||
MuteStream.prototype.close = proxy('close') |
||||
@ -0,0 +1,62 @@
|
||||
{ |
||||
"_from": "mute-stream@~0.0.4", |
||||
"_id": "mute-stream@0.0.8", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", |
||||
"_location": "/mute-stream", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "mute-stream@~0.0.4", |
||||
"name": "mute-stream", |
||||
"escapedName": "mute-stream", |
||||
"rawSpec": "~0.0.4", |
||||
"saveSpec": null, |
||||
"fetchSpec": "~0.0.4" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/read" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", |
||||
"_shasum": "1630c42b2251ff81e2a283de96a5497ea92e5e0d", |
||||
"_spec": "mute-stream@~0.0.4", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/read", |
||||
"author": { |
||||
"name": "Isaac Z. Schlueter", |
||||
"email": "i@izs.me", |
||||
"url": "http://blog.izs.me/" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/isaacs/mute-stream/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"deprecated": false, |
||||
"description": "Bytes go in, but they don't come out (when muted).", |
||||
"devDependencies": { |
||||
"tap": "^12.1.1" |
||||
}, |
||||
"directories": { |
||||
"test": "test" |
||||
}, |
||||
"files": [ |
||||
"mute.js" |
||||
], |
||||
"homepage": "https://github.com/isaacs/mute-stream#readme", |
||||
"keywords": [ |
||||
"mute", |
||||
"stream", |
||||
"pipe" |
||||
], |
||||
"license": "ISC", |
||||
"main": "mute.js", |
||||
"name": "mute-stream", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git://github.com/isaacs/mute-stream.git" |
||||
}, |
||||
"scripts": { |
||||
"test": "tap test/*.js --cov" |
||||
}, |
||||
"version": "0.0.8" |
||||
} |
||||
@ -0,0 +1,15 @@
|
||||
The ISC License |
||||
|
||||
Copyright (c) Isaac Z. Schlueter and Contributors |
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for any |
||||
purpose with or without fee is hereby granted, provided that the above |
||||
copyright notice and this permission notice appear in all copies. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR |
||||
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
||||
@ -0,0 +1,53 @@
|
||||
## read |
||||
|
||||
For reading user input from stdin. |
||||
|
||||
Similar to the `readline` builtin's `question()` method, but with a |
||||
few more features. |
||||
|
||||
## USAGE |
||||
|
||||
```javascript |
||||
var read = require("read") |
||||
read(options, callback) |
||||
``` |
||||
|
||||
The callback gets called with either the user input, or the default |
||||
specified, or an error, as `callback(error, result, isDefault)` |
||||
node style. |
||||
|
||||
## OPTIONS |
||||
|
||||
Every option is optional. |
||||
|
||||
* `prompt` What to write to stdout before reading input. |
||||
* `silent` Don't echo the output as the user types it. |
||||
* `replace` Replace silenced characters with the supplied character value. |
||||
* `timeout` Number of ms to wait for user input before giving up. |
||||
* `default` The default value if the user enters nothing. |
||||
* `edit` Allow the user to edit the default value. |
||||
* `terminal` Treat the output as a TTY, whether it is or not. |
||||
* `input` Readable stream to get input data from. (default `process.stdin`) |
||||
* `output` Writeable stream to write prompts to. (default: `process.stdout`) |
||||
|
||||
If silent is true, and the input is a TTY, then read will set raw |
||||
mode, and read character by character. |
||||
|
||||
## COMPATIBILITY |
||||
|
||||
This module works sort of with node 0.6. It does not work with node |
||||
versions less than 0.6. It is best on node 0.8. |
||||
|
||||
On node version 0.6, it will remove all listeners on the input |
||||
stream's `data` and `keypress` events, because the readline module did |
||||
not fully clean up after itself in that version of node, and did not |
||||
make it possible to clean up after it in a way that has no potential |
||||
for side effects. |
||||
|
||||
Additionally, some of the readline options (like `terminal`) will not |
||||
function in versions of node before 0.8, because they were not |
||||
implemented in the builtin readline module. |
||||
|
||||
## CONTRIBUTING |
||||
|
||||
Patches welcome. |
||||
@ -0,0 +1,113 @@
|
||||
|
||||
module.exports = read |
||||
|
||||
var readline = require('readline') |
||||
var Mute = require('mute-stream') |
||||
|
||||
function read (opts, cb) { |
||||
if (opts.num) { |
||||
throw new Error('read() no longer accepts a char number limit') |
||||
} |
||||
|
||||
if (typeof opts.default !== 'undefined' && |
||||
typeof opts.default !== 'string' && |
||||
typeof opts.default !== 'number') { |
||||
throw new Error('default value must be string or number') |
||||
} |
||||
|
||||
var input = opts.input || process.stdin |
||||
var output = opts.output || process.stdout |
||||
var prompt = (opts.prompt || '').trim() + ' ' |
||||
var silent = opts.silent |
||||
var editDef = false |
||||
var timeout = opts.timeout |
||||
|
||||
var def = opts.default || '' |
||||
if (def) { |
||||
if (silent) { |
||||
prompt += '(<default hidden>) ' |
||||
} else if (opts.edit) { |
||||
editDef = true |
||||
} else { |
||||
prompt += '(' + def + ') ' |
||||
} |
||||
} |
||||
var terminal = !!(opts.terminal || output.isTTY) |
||||
|
||||
var m = new Mute({ replace: opts.replace, prompt: prompt }) |
||||
m.pipe(output, {end: false}) |
||||
output = m |
||||
var rlOpts = { input: input, output: output, terminal: terminal } |
||||
|
||||
if (process.version.match(/^v0\.6/)) { |
||||
var rl = readline.createInterface(rlOpts.input, rlOpts.output) |
||||
} else { |
||||
var rl = readline.createInterface(rlOpts) |
||||
} |
||||
|
||||
|
||||
output.unmute() |
||||
rl.setPrompt(prompt) |
||||
rl.prompt() |
||||
if (silent) { |
||||
output.mute() |
||||
} else if (editDef) { |
||||
rl.line = def |
||||
rl.cursor = def.length |
||||
rl._refreshLine() |
||||
} |
||||
|
||||
var called = false |
||||
rl.on('line', onLine) |
||||
rl.on('error', onError) |
||||
|
||||
rl.on('SIGINT', function () { |
||||
rl.close() |
||||
onError(new Error('canceled')) |
||||
}) |
||||
|
||||
var timer |
||||
if (timeout) { |
||||
timer = setTimeout(function () { |
||||
onError(new Error('timed out')) |
||||
}, timeout) |
||||
} |
||||
|
||||
function done () { |
||||
called = true |
||||
rl.close() |
||||
|
||||
if (process.version.match(/^v0\.6/)) { |
||||
rl.input.removeAllListeners('data') |
||||
rl.input.removeAllListeners('keypress') |
||||
rl.input.pause() |
||||
} |
||||
|
||||
clearTimeout(timer) |
||||
output.mute() |
||||
output.end() |
||||
} |
||||
|
||||
function onError (er) { |
||||
if (called) return |
||||
done() |
||||
return cb(er) |
||||
} |
||||
|
||||
function onLine (line) { |
||||
if (called) return |
||||
if (silent && terminal) { |
||||
output.unmute() |
||||
output.write('\r\n') |
||||
} |
||||
done() |
||||
// truncate the \n at the end.
|
||||
line = line.replace(/\r?\n$/, '') |
||||
var isDefault = !!(editDef && line === def) |
||||
if (def && !line) { |
||||
isDefault = true |
||||
line = def |
||||
} |
||||
cb(null, line, isDefault) |
||||
} |
||||
} |
||||
@ -0,0 +1,60 @@
|
||||
{ |
||||
"_from": "read@^1.0.7", |
||||
"_id": "read@1.0.7", |
||||
"_inBundle": false, |
||||
"_integrity": "sha1-s9oZvQUkMal2cdRKQmNK33ELQMQ=", |
||||
"_location": "/read", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "read@^1.0.7", |
||||
"name": "read", |
||||
"escapedName": "read", |
||||
"rawSpec": "^1.0.7", |
||||
"saveSpec": null, |
||||
"fetchSpec": "^1.0.7" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/wscat" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/read/-/read-1.0.7.tgz", |
||||
"_shasum": "b3da19bd052431a97671d44a42634adf710b40c4", |
||||
"_spec": "read@^1.0.7", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/wscat", |
||||
"author": { |
||||
"name": "Isaac Z. Schlueter", |
||||
"email": "i@izs.me", |
||||
"url": "http://blog.izs.me/" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/isaacs/read/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"dependencies": { |
||||
"mute-stream": "~0.0.4" |
||||
}, |
||||
"deprecated": false, |
||||
"description": "read(1) for node programs", |
||||
"devDependencies": { |
||||
"tap": "^1.2.0" |
||||
}, |
||||
"engines": { |
||||
"node": ">=0.8" |
||||
}, |
||||
"files": [ |
||||
"lib/read.js" |
||||
], |
||||
"homepage": "https://github.com/isaacs/read#readme", |
||||
"license": "ISC", |
||||
"main": "lib/read.js", |
||||
"name": "read", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git://github.com/isaacs/read.git" |
||||
}, |
||||
"scripts": { |
||||
"test": "tap test/*.js" |
||||
}, |
||||
"version": "1.0.7" |
||||
} |
||||
@ -0,0 +1,21 @@
|
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
@ -0,0 +1,496 @@
|
||||
# ws: a Node.js WebSocket library |
||||
|
||||
[](https://www.npmjs.com/package/ws) |
||||
[](https://travis-ci.com/websockets/ws) |
||||
[](https://ci.appveyor.com/project/lpinca/ws) |
||||
[](https://coveralls.io/github/websockets/ws) |
||||
|
||||
ws is a simple to use, blazing fast, and thoroughly tested WebSocket client and |
||||
server implementation. |
||||
|
||||
Passes the quite extensive Autobahn test suite: [server][server-report], |
||||
[client][client-report]. |
||||
|
||||
**Note**: This module does not work in the browser. The client in the docs is a |
||||
reference to a back end with the role of a client in the WebSocket |
||||
communication. Browser clients must use the native |
||||
[`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) |
||||
object. To make the same code work seamlessly on Node.js and the browser, you |
||||
can use one of the many wrappers available on npm, like |
||||
[isomorphic-ws](https://github.com/heineiuo/isomorphic-ws). |
||||
|
||||
## Table of Contents |
||||
|
||||
- [Protocol support](#protocol-support) |
||||
- [Installing](#installing) |
||||
- [Opt-in for performance and spec compliance](#opt-in-for-performance-and-spec-compliance) |
||||
- [API docs](#api-docs) |
||||
- [WebSocket compression](#websocket-compression) |
||||
- [Usage examples](#usage-examples) |
||||
- [Sending and receiving text data](#sending-and-receiving-text-data) |
||||
- [Sending binary data](#sending-binary-data) |
||||
- [Simple server](#simple-server) |
||||
- [External HTTP/S server](#external-https-server) |
||||
- [Multiple servers sharing a single HTTP/S server](#multiple-servers-sharing-a-single-https-server) |
||||
- [Client authentication](#client-authentication) |
||||
- [Server broadcast](#server-broadcast) |
||||
- [echo.websocket.org demo](#echowebsocketorg-demo) |
||||
- [Use the Node.js streams API](#use-the-nodejs-streams-api) |
||||
- [Other examples](#other-examples) |
||||
- [FAQ](#faq) |
||||
- [How to get the IP address of the client?](#how-to-get-the-ip-address-of-the-client) |
||||
- [How to detect and close broken connections?](#how-to-detect-and-close-broken-connections) |
||||
- [How to connect via a proxy?](#how-to-connect-via-a-proxy) |
||||
- [Changelog](#changelog) |
||||
- [License](#license) |
||||
|
||||
## Protocol support |
||||
|
||||
- **HyBi drafts 07-12** (Use the option `protocolVersion: 8`) |
||||
- **HyBi drafts 13-17** (Current default, alternatively option |
||||
`protocolVersion: 13`) |
||||
|
||||
## Installing |
||||
|
||||
``` |
||||
npm install ws |
||||
``` |
||||
|
||||
### Opt-in for performance and spec compliance |
||||
|
||||
There are 2 optional modules that can be installed along side with the ws |
||||
module. These modules are binary addons which improve certain operations. |
||||
Prebuilt binaries are available for the most popular platforms so you don't |
||||
necessarily need to have a C++ compiler installed on your machine. |
||||
|
||||
- `npm install --save-optional bufferutil`: Allows to efficiently perform |
||||
operations such as masking and unmasking the data payload of the WebSocket |
||||
frames. |
||||
- `npm install --save-optional utf-8-validate`: Allows to efficiently check if a |
||||
message contains valid UTF-8 as required by the spec. |
||||
|
||||
## API docs |
||||
|
||||
See [`/doc/ws.md`](./doc/ws.md) for Node.js-like documentation of ws classes and |
||||
utility functions. |
||||
|
||||
## WebSocket compression |
||||
|
||||
ws supports the [permessage-deflate extension][permessage-deflate] which enables |
||||
the client and server to negotiate a compression algorithm and its parameters, |
||||
and then selectively apply it to the data payloads of each WebSocket message. |
||||
|
||||
The extension is disabled by default on the server and enabled by default on the |
||||
client. It adds a significant overhead in terms of performance and memory |
||||
consumption so we suggest to enable it only if it is really needed. |
||||
|
||||
Note that Node.js has a variety of issues with high-performance compression, |
||||
where increased concurrency, especially on Linux, can lead to [catastrophic |
||||
memory fragmentation][node-zlib-bug] and slow performance. If you intend to use |
||||
permessage-deflate in production, it is worthwhile to set up a test |
||||
representative of your workload and ensure Node.js/zlib will handle it with |
||||
acceptable performance and memory usage. |
||||
|
||||
Tuning of permessage-deflate can be done via the options defined below. You can |
||||
also use `zlibDeflateOptions` and `zlibInflateOptions`, which is passed directly |
||||
into the creation of [raw deflate/inflate streams][node-zlib-deflaterawdocs]. |
||||
|
||||
See [the docs][ws-server-options] for more options. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const wss = new WebSocket.Server({ |
||||
port: 8080, |
||||
perMessageDeflate: { |
||||
zlibDeflateOptions: { |
||||
// See zlib defaults. |
||||
chunkSize: 1024, |
||||
memLevel: 7, |
||||
level: 3 |
||||
}, |
||||
zlibInflateOptions: { |
||||
chunkSize: 10 * 1024 |
||||
}, |
||||
// Other options settable: |
||||
clientNoContextTakeover: true, // Defaults to negotiated value. |
||||
serverNoContextTakeover: true, // Defaults to negotiated value. |
||||
serverMaxWindowBits: 10, // Defaults to negotiated value. |
||||
// Below options specified as default values. |
||||
concurrencyLimit: 10, // Limits zlib concurrency for perf. |
||||
threshold: 1024 // Size (in bytes) below which messages |
||||
// should not be compressed. |
||||
} |
||||
}); |
||||
``` |
||||
|
||||
The client will only use the extension if it is supported and enabled on the |
||||
server. To always disable the extension on the client set the |
||||
`perMessageDeflate` option to `false`. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const ws = new WebSocket('ws://www.host.com/path', { |
||||
perMessageDeflate: false |
||||
}); |
||||
``` |
||||
|
||||
## Usage examples |
||||
|
||||
### Sending and receiving text data |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const ws = new WebSocket('ws://www.host.com/path'); |
||||
|
||||
ws.on('open', function open() { |
||||
ws.send('something'); |
||||
}); |
||||
|
||||
ws.on('message', function incoming(data) { |
||||
console.log(data); |
||||
}); |
||||
``` |
||||
|
||||
### Sending binary data |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const ws = new WebSocket('ws://www.host.com/path'); |
||||
|
||||
ws.on('open', function open() { |
||||
const array = new Float32Array(5); |
||||
|
||||
for (var i = 0; i < array.length; ++i) { |
||||
array[i] = i / 2; |
||||
} |
||||
|
||||
ws.send(array); |
||||
}); |
||||
``` |
||||
|
||||
### Simple server |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const wss = new WebSocket.Server({ port: 8080 }); |
||||
|
||||
wss.on('connection', function connection(ws) { |
||||
ws.on('message', function incoming(message) { |
||||
console.log('received: %s', message); |
||||
}); |
||||
|
||||
ws.send('something'); |
||||
}); |
||||
``` |
||||
|
||||
### External HTTP/S server |
||||
|
||||
```js |
||||
const fs = require('fs'); |
||||
const https = require('https'); |
||||
const WebSocket = require('ws'); |
||||
|
||||
const server = https.createServer({ |
||||
cert: fs.readFileSync('/path/to/cert.pem'), |
||||
key: fs.readFileSync('/path/to/key.pem') |
||||
}); |
||||
const wss = new WebSocket.Server({ server }); |
||||
|
||||
wss.on('connection', function connection(ws) { |
||||
ws.on('message', function incoming(message) { |
||||
console.log('received: %s', message); |
||||
}); |
||||
|
||||
ws.send('something'); |
||||
}); |
||||
|
||||
server.listen(8080); |
||||
``` |
||||
|
||||
### Multiple servers sharing a single HTTP/S server |
||||
|
||||
```js |
||||
const http = require('http'); |
||||
const WebSocket = require('ws'); |
||||
const url = require('url'); |
||||
|
||||
const server = http.createServer(); |
||||
const wss1 = new WebSocket.Server({ noServer: true }); |
||||
const wss2 = new WebSocket.Server({ noServer: true }); |
||||
|
||||
wss1.on('connection', function connection(ws) { |
||||
// ... |
||||
}); |
||||
|
||||
wss2.on('connection', function connection(ws) { |
||||
// ... |
||||
}); |
||||
|
||||
server.on('upgrade', function upgrade(request, socket, head) { |
||||
const pathname = url.parse(request.url).pathname; |
||||
|
||||
if (pathname === '/foo') { |
||||
wss1.handleUpgrade(request, socket, head, function done(ws) { |
||||
wss1.emit('connection', ws, request); |
||||
}); |
||||
} else if (pathname === '/bar') { |
||||
wss2.handleUpgrade(request, socket, head, function done(ws) { |
||||
wss2.emit('connection', ws, request); |
||||
}); |
||||
} else { |
||||
socket.destroy(); |
||||
} |
||||
}); |
||||
|
||||
server.listen(8080); |
||||
``` |
||||
|
||||
### Client authentication |
||||
|
||||
```js |
||||
const http = require('http'); |
||||
const WebSocket = require('ws'); |
||||
|
||||
const server = http.createServer(); |
||||
const wss = new WebSocket.Server({ noServer: true }); |
||||
|
||||
wss.on('connection', function connection(ws, request, client) { |
||||
ws.on('message', function message(msg) { |
||||
console.log(`Received message ${msg} from user ${client}`); |
||||
}); |
||||
}); |
||||
|
||||
server.on('upgrade', function upgrade(request, socket, head) { |
||||
// This function is not defined on purpose. Implement it with your own logic. |
||||
authenticate(request, (err, client) => { |
||||
if (err || !client) { |
||||
socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n'); |
||||
socket.destroy(); |
||||
return; |
||||
} |
||||
|
||||
wss.handleUpgrade(request, socket, head, function done(ws) { |
||||
wss.emit('connection', ws, request, client); |
||||
}); |
||||
}); |
||||
}); |
||||
|
||||
server.listen(8080); |
||||
``` |
||||
|
||||
Also see the provided [example][session-parse-example] using `express-session`. |
||||
|
||||
### Server broadcast |
||||
|
||||
A client WebSocket broadcasting to all connected WebSocket clients, including |
||||
itself. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const wss = new WebSocket.Server({ port: 8080 }); |
||||
|
||||
wss.on('connection', function connection(ws) { |
||||
ws.on('message', function incoming(data) { |
||||
wss.clients.forEach(function each(client) { |
||||
if (client.readyState === WebSocket.OPEN) { |
||||
client.send(data); |
||||
} |
||||
}); |
||||
}); |
||||
}); |
||||
``` |
||||
|
||||
A client WebSocket broadcasting to every other connected WebSocket clients, |
||||
excluding itself. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const wss = new WebSocket.Server({ port: 8080 }); |
||||
|
||||
wss.on('connection', function connection(ws) { |
||||
ws.on('message', function incoming(data) { |
||||
wss.clients.forEach(function each(client) { |
||||
if (client !== ws && client.readyState === WebSocket.OPEN) { |
||||
client.send(data); |
||||
} |
||||
}); |
||||
}); |
||||
}); |
||||
``` |
||||
|
||||
### echo.websocket.org demo |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const ws = new WebSocket('wss://echo.websocket.org/', { |
||||
origin: 'https://websocket.org' |
||||
}); |
||||
|
||||
ws.on('open', function open() { |
||||
console.log('connected'); |
||||
ws.send(Date.now()); |
||||
}); |
||||
|
||||
ws.on('close', function close() { |
||||
console.log('disconnected'); |
||||
}); |
||||
|
||||
ws.on('message', function incoming(data) { |
||||
console.log(`Roundtrip time: ${Date.now() - data} ms`); |
||||
|
||||
setTimeout(function timeout() { |
||||
ws.send(Date.now()); |
||||
}, 500); |
||||
}); |
||||
``` |
||||
|
||||
### Use the Node.js streams API |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const ws = new WebSocket('wss://echo.websocket.org/', { |
||||
origin: 'https://websocket.org' |
||||
}); |
||||
|
||||
const duplex = WebSocket.createWebSocketStream(ws, { encoding: 'utf8' }); |
||||
|
||||
duplex.pipe(process.stdout); |
||||
process.stdin.pipe(duplex); |
||||
``` |
||||
|
||||
### Other examples |
||||
|
||||
For a full example with a browser client communicating with a ws server, see the |
||||
examples folder. |
||||
|
||||
Otherwise, see the test cases. |
||||
|
||||
## FAQ |
||||
|
||||
### How to get the IP address of the client? |
||||
|
||||
The remote IP address can be obtained from the raw socket. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
const wss = new WebSocket.Server({ port: 8080 }); |
||||
|
||||
wss.on('connection', function connection(ws, req) { |
||||
const ip = req.socket.remoteAddress; |
||||
}); |
||||
``` |
||||
|
||||
When the server runs behind a proxy like NGINX, the de-facto standard is to use |
||||
the `X-Forwarded-For` header. |
||||
|
||||
```js |
||||
wss.on('connection', function connection(ws, req) { |
||||
const ip = req.headers['x-forwarded-for'].split(/\s*,\s*/)[0]; |
||||
}); |
||||
``` |
||||
|
||||
### How to detect and close broken connections? |
||||
|
||||
Sometimes the link between the server and the client can be interrupted in a way |
||||
that keeps both the server and the client unaware of the broken state of the |
||||
connection (e.g. when pulling the cord). |
||||
|
||||
In these cases ping messages can be used as a means to verify that the remote |
||||
endpoint is still responsive. |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
function noop() {} |
||||
|
||||
function heartbeat() { |
||||
this.isAlive = true; |
||||
} |
||||
|
||||
const wss = new WebSocket.Server({ port: 8080 }); |
||||
|
||||
wss.on('connection', function connection(ws) { |
||||
ws.isAlive = true; |
||||
ws.on('pong', heartbeat); |
||||
}); |
||||
|
||||
const interval = setInterval(function ping() { |
||||
wss.clients.forEach(function each(ws) { |
||||
if (ws.isAlive === false) return ws.terminate(); |
||||
|
||||
ws.isAlive = false; |
||||
ws.ping(noop); |
||||
}); |
||||
}, 30000); |
||||
|
||||
wss.on('close', function close() { |
||||
clearInterval(interval); |
||||
}); |
||||
``` |
||||
|
||||
Pong messages are automatically sent in response to ping messages as required by |
||||
the spec. |
||||
|
||||
Just like the server example above your clients might as well lose connection |
||||
without knowing it. You might want to add a ping listener on your clients to |
||||
prevent that. A simple implementation would be: |
||||
|
||||
```js |
||||
const WebSocket = require('ws'); |
||||
|
||||
function heartbeat() { |
||||
clearTimeout(this.pingTimeout); |
||||
|
||||
// Use `WebSocket#terminate()`, which immediately destroys the connection, |
||||
// instead of `WebSocket#close()`, which waits for the close timer. |
||||
// Delay should be equal to the interval at which your server |
||||
// sends out pings plus a conservative assumption of the latency. |
||||
this.pingTimeout = setTimeout(() => { |
||||
this.terminate(); |
||||
}, 30000 + 1000); |
||||
} |
||||
|
||||
const client = new WebSocket('wss://echo.websocket.org/'); |
||||
|
||||
client.on('open', heartbeat); |
||||
client.on('ping', heartbeat); |
||||
client.on('close', function clear() { |
||||
clearTimeout(this.pingTimeout); |
||||
}); |
||||
``` |
||||
|
||||
### How to connect via a proxy? |
||||
|
||||
Use a custom `http.Agent` implementation like [https-proxy-agent][] or |
||||
[socks-proxy-agent][]. |
||||
|
||||
## Changelog |
||||
|
||||
We're using the GitHub [releases][changelog] for changelog entries. |
||||
|
||||
## License |
||||
|
||||
[MIT](LICENSE) |
||||
|
||||
[changelog]: https://github.com/websockets/ws/releases |
||||
[client-report]: http://websockets.github.io/ws/autobahn/clients/ |
||||
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent |
||||
[node-zlib-bug]: https://github.com/nodejs/node/issues/8871 |
||||
[node-zlib-deflaterawdocs]: |
||||
https://nodejs.org/api/zlib.html#zlib_zlib_createdeflateraw_options |
||||
[permessage-deflate]: https://tools.ietf.org/html/rfc7692 |
||||
[server-report]: http://websockets.github.io/ws/autobahn/servers/ |
||||
[session-parse-example]: ./examples/express-session-parse |
||||
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent |
||||
[ws-server-options]: |
||||
https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback |
||||
@ -0,0 +1,8 @@
|
||||
'use strict'; |
||||
|
||||
module.exports = function () { |
||||
throw new Error( |
||||
'ws does not work in the browser. Browser clients must use the native ' + |
||||
'WebSocket object' |
||||
); |
||||
}; |
||||
@ -0,0 +1,10 @@
|
||||
'use strict'; |
||||
|
||||
const WebSocket = require('./lib/websocket'); |
||||
|
||||
WebSocket.createWebSocketStream = require('./lib/stream'); |
||||
WebSocket.Server = require('./lib/websocket-server'); |
||||
WebSocket.Receiver = require('./lib/receiver'); |
||||
WebSocket.Sender = require('./lib/sender'); |
||||
|
||||
module.exports = WebSocket; |
||||
@ -0,0 +1,129 @@
|
||||
'use strict'; |
||||
|
||||
const { EMPTY_BUFFER } = require('./constants'); |
||||
|
||||
/** |
||||
* Merges an array of buffers into a new buffer. |
||||
* |
||||
* @param {Buffer[]} list The array of buffers to concat |
||||
* @param {Number} totalLength The total length of buffers in the list |
||||
* @return {Buffer} The resulting buffer |
||||
* @public |
||||
*/ |
||||
function concat(list, totalLength) { |
||||
if (list.length === 0) return EMPTY_BUFFER; |
||||
if (list.length === 1) return list[0]; |
||||
|
||||
const target = Buffer.allocUnsafe(totalLength); |
||||
let offset = 0; |
||||
|
||||
for (let i = 0; i < list.length; i++) { |
||||
const buf = list[i]; |
||||
target.set(buf, offset); |
||||
offset += buf.length; |
||||
} |
||||
|
||||
if (offset < totalLength) return target.slice(0, offset); |
||||
|
||||
return target; |
||||
} |
||||
|
||||
/** |
||||
* Masks a buffer using the given mask. |
||||
* |
||||
* @param {Buffer} source The buffer to mask |
||||
* @param {Buffer} mask The mask to use |
||||
* @param {Buffer} output The buffer where to store the result |
||||
* @param {Number} offset The offset at which to start writing |
||||
* @param {Number} length The number of bytes to mask. |
||||
* @public |
||||
*/ |
||||
function _mask(source, mask, output, offset, length) { |
||||
for (let i = 0; i < length; i++) { |
||||
output[offset + i] = source[i] ^ mask[i & 3]; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Unmasks a buffer using the given mask. |
||||
* |
||||
* @param {Buffer} buffer The buffer to unmask |
||||
* @param {Buffer} mask The mask to use |
||||
* @public |
||||
*/ |
||||
function _unmask(buffer, mask) { |
||||
// Required until https://github.com/nodejs/node/issues/9006 is resolved.
|
||||
const length = buffer.length; |
||||
for (let i = 0; i < length; i++) { |
||||
buffer[i] ^= mask[i & 3]; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Converts a buffer to an `ArrayBuffer`. |
||||
* |
||||
* @param {Buffer} buf The buffer to convert |
||||
* @return {ArrayBuffer} Converted buffer |
||||
* @public |
||||
*/ |
||||
function toArrayBuffer(buf) { |
||||
if (buf.byteLength === buf.buffer.byteLength) { |
||||
return buf.buffer; |
||||
} |
||||
|
||||
return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength); |
||||
} |
||||
|
||||
/** |
||||
* Converts `data` to a `Buffer`. |
||||
* |
||||
* @param {*} data The data to convert |
||||
* @return {Buffer} The buffer |
||||
* @throws {TypeError} |
||||
* @public |
||||
*/ |
||||
function toBuffer(data) { |
||||
toBuffer.readOnly = true; |
||||
|
||||
if (Buffer.isBuffer(data)) return data; |
||||
|
||||
let buf; |
||||
|
||||
if (data instanceof ArrayBuffer) { |
||||
buf = Buffer.from(data); |
||||
} else if (ArrayBuffer.isView(data)) { |
||||
buf = Buffer.from(data.buffer, data.byteOffset, data.byteLength); |
||||
} else { |
||||
buf = Buffer.from(data); |
||||
toBuffer.readOnly = false; |
||||
} |
||||
|
||||
return buf; |
||||
} |
||||
|
||||
try { |
||||
const bufferUtil = require('bufferutil'); |
||||
const bu = bufferUtil.BufferUtil || bufferUtil; |
||||
|
||||
module.exports = { |
||||
concat, |
||||
mask(source, mask, output, offset, length) { |
||||
if (length < 48) _mask(source, mask, output, offset, length); |
||||
else bu.mask(source, mask, output, offset, length); |
||||
}, |
||||
toArrayBuffer, |
||||
toBuffer, |
||||
unmask(buffer, mask) { |
||||
if (buffer.length < 32) _unmask(buffer, mask); |
||||
else bu.unmask(buffer, mask); |
||||
} |
||||
}; |
||||
} catch (e) /* istanbul ignore next */ { |
||||
module.exports = { |
||||
concat, |
||||
mask: _mask, |
||||
toArrayBuffer, |
||||
toBuffer, |
||||
unmask: _unmask |
||||
}; |
||||
} |
||||
@ -0,0 +1,10 @@
|
||||
'use strict'; |
||||
|
||||
module.exports = { |
||||
BINARY_TYPES: ['nodebuffer', 'arraybuffer', 'fragments'], |
||||
GUID: '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', |
||||
kStatusCode: Symbol('status-code'), |
||||
kWebSocket: Symbol('websocket'), |
||||
EMPTY_BUFFER: Buffer.alloc(0), |
||||
NOOP: () => {} |
||||
}; |
||||
@ -0,0 +1,177 @@
|
||||
'use strict'; |
||||
|
||||
/** |
||||
* Class representing an event. |
||||
* |
||||
* @private |
||||
*/ |
||||
class Event { |
||||
/** |
||||
* Create a new `Event`. |
||||
* |
||||
* @param {String} type The name of the event |
||||
* @param {Object} target A reference to the target to which the event was dispatched |
||||
*/ |
||||
constructor(type, target) { |
||||
this.target = target; |
||||
this.type = type; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Class representing a message event. |
||||
* |
||||
* @extends Event |
||||
* @private |
||||
*/ |
||||
class MessageEvent extends Event { |
||||
/** |
||||
* Create a new `MessageEvent`. |
||||
* |
||||
* @param {(String|Buffer|ArrayBuffer|Buffer[])} data The received data |
||||
* @param {WebSocket} target A reference to the target to which the event was dispatched |
||||
*/ |
||||
constructor(data, target) { |
||||
super('message', target); |
||||
|
||||
this.data = data; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Class representing a close event. |
||||
* |
||||
* @extends Event |
||||
* @private |
||||
*/ |
||||
class CloseEvent extends Event { |
||||
/** |
||||
* Create a new `CloseEvent`. |
||||
* |
||||
* @param {Number} code The status code explaining why the connection is being closed |
||||
* @param {String} reason A human-readable string explaining why the connection is closing |
||||
* @param {WebSocket} target A reference to the target to which the event was dispatched |
||||
*/ |
||||
constructor(code, reason, target) { |
||||
super('close', target); |
||||
|
||||
this.wasClean = target._closeFrameReceived && target._closeFrameSent; |
||||
this.reason = reason; |
||||
this.code = code; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Class representing an open event. |
||||
* |
||||
* @extends Event |
||||
* @private |
||||
*/ |
||||
class OpenEvent extends Event { |
||||
/** |
||||
* Create a new `OpenEvent`. |
||||
* |
||||
* @param {WebSocket} target A reference to the target to which the event was dispatched |
||||
*/ |
||||
constructor(target) { |
||||
super('open', target); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Class representing an error event. |
||||
* |
||||
* @extends Event |
||||
* @private |
||||
*/ |
||||
class ErrorEvent extends Event { |
||||
/** |
||||
* Create a new `ErrorEvent`. |
||||
* |
||||
* @param {Object} error The error that generated this event |
||||
* @param {WebSocket} target A reference to the target to which the event was dispatched |
||||
*/ |
||||
constructor(error, target) { |
||||
super('error', target); |
||||
|
||||
this.message = error.message; |
||||
this.error = error; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* This provides methods for emulating the `EventTarget` interface. It's not |
||||
* meant to be used directly. |
||||
* |
||||
* @mixin |
||||
*/ |
||||
const EventTarget = { |
||||
/** |
||||
* Register an event listener. |
||||
* |
||||
* @param {String} type A string representing the event type to listen for |
||||
* @param {Function} listener The listener to add |
||||
* @param {Object} options An options object specifies characteristics about |
||||
* the event listener |
||||
* @param {Boolean} options.once A `Boolean`` indicating that the listener
|
||||
* should be invoked at most once after being added. If `true`, the |
||||
* listener would be automatically removed when invoked. |
||||
* @public |
||||
*/ |
||||
addEventListener(type, listener, options) { |
||||
if (typeof listener !== 'function') return; |
||||
|
||||
function onMessage(data) { |
||||
listener.call(this, new MessageEvent(data, this)); |
||||
} |
||||
|
||||
function onClose(code, message) { |
||||
listener.call(this, new CloseEvent(code, message, this)); |
||||
} |
||||
|
||||
function onError(error) { |
||||
listener.call(this, new ErrorEvent(error, this)); |
||||
} |
||||
|
||||
function onOpen() { |
||||
listener.call(this, new OpenEvent(this)); |
||||
} |
||||
|
||||
const method = options && options.once ? 'once' : 'on'; |
||||
|
||||
if (type === 'message') { |
||||
onMessage._listener = listener; |
||||
this[method](type, onMessage); |
||||
} else if (type === 'close') { |
||||
onClose._listener = listener; |
||||
this[method](type, onClose); |
||||
} else if (type === 'error') { |
||||
onError._listener = listener; |
||||
this[method](type, onError); |
||||
} else if (type === 'open') { |
||||
onOpen._listener = listener; |
||||
this[method](type, onOpen); |
||||
} else { |
||||
this[method](type, listener); |
||||
} |
||||
}, |
||||
|
||||
/** |
||||
* Remove an event listener. |
||||
* |
||||
* @param {String} type A string representing the event type to remove |
||||
* @param {Function} listener The listener to remove |
||||
* @public |
||||
*/ |
||||
removeEventListener(type, listener) { |
||||
const listeners = this.listeners(type); |
||||
|
||||
for (let i = 0; i < listeners.length; i++) { |
||||
if (listeners[i] === listener || listeners[i]._listener === listener) { |
||||
this.removeListener(type, listeners[i]); |
||||
} |
||||
} |
||||
} |
||||
}; |
||||
|
||||
module.exports = EventTarget; |
||||
@ -0,0 +1,223 @@
|
||||
'use strict'; |
||||
|
||||
//
|
||||
// Allowed token characters:
|
||||
//
|
||||
// '!', '#', '$', '%', '&', ''', '*', '+', '-',
|
||||
// '.', 0-9, A-Z, '^', '_', '`', a-z, '|', '~'
|
||||
//
|
||||
// tokenChars[32] === 0 // ' '
|
||||
// tokenChars[33] === 1 // '!'
|
||||
// tokenChars[34] === 0 // '"'
|
||||
// ...
|
||||
//
|
||||
// prettier-ignore
|
||||
const tokenChars = [ |
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 0 - 15
|
||||
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, // 16 - 31
|
||||
0, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 0, // 32 - 47
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, // 48 - 63
|
||||
0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 64 - 79
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, // 80 - 95
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 96 - 111
|
||||
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 1, 0 // 112 - 127
|
||||
]; |
||||
|
||||
/** |
||||
* Adds an offer to the map of extension offers or a parameter to the map of |
||||
* parameters. |
||||
* |
||||
* @param {Object} dest The map of extension offers or parameters |
||||
* @param {String} name The extension or parameter name |
||||
* @param {(Object|Boolean|String)} elem The extension parameters or the |
||||
* parameter value |
||||
* @private |
||||
*/ |
||||
function push(dest, name, elem) { |
||||
if (dest[name] === undefined) dest[name] = [elem]; |
||||
else dest[name].push(elem); |
||||
} |
||||
|
||||
/** |
||||
* Parses the `Sec-WebSocket-Extensions` header into an object. |
||||
* |
||||
* @param {String} header The field value of the header |
||||
* @return {Object} The parsed object |
||||
* @public |
||||
*/ |
||||
function parse(header) { |
||||
const offers = Object.create(null); |
||||
|
||||
if (header === undefined || header === '') return offers; |
||||
|
||||
let params = Object.create(null); |
||||
let mustUnescape = false; |
||||
let isEscaping = false; |
||||
let inQuotes = false; |
||||
let extensionName; |
||||
let paramName; |
||||
let start = -1; |
||||
let end = -1; |
||||
let i = 0; |
||||
|
||||
for (; i < header.length; i++) { |
||||
const code = header.charCodeAt(i); |
||||
|
||||
if (extensionName === undefined) { |
||||
if (end === -1 && tokenChars[code] === 1) { |
||||
if (start === -1) start = i; |
||||
} else if (code === 0x20 /* ' ' */ || code === 0x09 /* '\t' */) { |
||||
if (end === -1 && start !== -1) end = i; |
||||
} else if (code === 0x3b /* ';' */ || code === 0x2c /* ',' */) { |
||||
if (start === -1) { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
|
||||
if (end === -1) end = i; |
||||
const name = header.slice(start, end); |
||||
if (code === 0x2c) { |
||||
push(offers, name, params); |
||||
params = Object.create(null); |
||||
} else { |
||||
extensionName = name; |
||||
} |
||||
|
||||
start = end = -1; |
||||
} else { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
} else if (paramName === undefined) { |
||||
if (end === -1 && tokenChars[code] === 1) { |
||||
if (start === -1) start = i; |
||||
} else if (code === 0x20 || code === 0x09) { |
||||
if (end === -1 && start !== -1) end = i; |
||||
} else if (code === 0x3b || code === 0x2c) { |
||||
if (start === -1) { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
|
||||
if (end === -1) end = i; |
||||
push(params, header.slice(start, end), true); |
||||
if (code === 0x2c) { |
||||
push(offers, extensionName, params); |
||||
params = Object.create(null); |
||||
extensionName = undefined; |
||||
} |
||||
|
||||
start = end = -1; |
||||
} else if (code === 0x3d /* '=' */ && start !== -1 && end === -1) { |
||||
paramName = header.slice(start, i); |
||||
start = end = -1; |
||||
} else { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
} else { |
||||
//
|
||||
// The value of a quoted-string after unescaping must conform to the
|
||||
// token ABNF, so only token characters are valid.
|
||||
// Ref: https://tools.ietf.org/html/rfc6455#section-9.1
|
||||
//
|
||||
if (isEscaping) { |
||||
if (tokenChars[code] !== 1) { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
if (start === -1) start = i; |
||||
else if (!mustUnescape) mustUnescape = true; |
||||
isEscaping = false; |
||||
} else if (inQuotes) { |
||||
if (tokenChars[code] === 1) { |
||||
if (start === -1) start = i; |
||||
} else if (code === 0x22 /* '"' */ && start !== -1) { |
||||
inQuotes = false; |
||||
end = i; |
||||
} else if (code === 0x5c /* '\' */) { |
||||
isEscaping = true; |
||||
} else { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
} else if (code === 0x22 && header.charCodeAt(i - 1) === 0x3d) { |
||||
inQuotes = true; |
||||
} else if (end === -1 && tokenChars[code] === 1) { |
||||
if (start === -1) start = i; |
||||
} else if (start !== -1 && (code === 0x20 || code === 0x09)) { |
||||
if (end === -1) end = i; |
||||
} else if (code === 0x3b || code === 0x2c) { |
||||
if (start === -1) { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
|
||||
if (end === -1) end = i; |
||||
let value = header.slice(start, end); |
||||
if (mustUnescape) { |
||||
value = value.replace(/\\/g, ''); |
||||
mustUnescape = false; |
||||
} |
||||
push(params, paramName, value); |
||||
if (code === 0x2c) { |
||||
push(offers, extensionName, params); |
||||
params = Object.create(null); |
||||
extensionName = undefined; |
||||
} |
||||
|
||||
paramName = undefined; |
||||
start = end = -1; |
||||
} else { |
||||
throw new SyntaxError(`Unexpected character at index ${i}`); |
||||
} |
||||
} |
||||
} |
||||
|
||||
if (start === -1 || inQuotes) { |
||||
throw new SyntaxError('Unexpected end of input'); |
||||
} |
||||
|
||||
if (end === -1) end = i; |
||||
const token = header.slice(start, end); |
||||
if (extensionName === undefined) { |
||||
push(offers, token, params); |
||||
} else { |
||||
if (paramName === undefined) { |
||||
push(params, token, true); |
||||
} else if (mustUnescape) { |
||||
push(params, paramName, token.replace(/\\/g, '')); |
||||
} else { |
||||
push(params, paramName, token); |
||||
} |
||||
push(offers, extensionName, params); |
||||
} |
||||
|
||||
return offers; |
||||
} |
||||
|
||||
/** |
||||
* Builds the `Sec-WebSocket-Extensions` header field value. |
||||
* |
||||
* @param {Object} extensions The map of extensions and parameters to format |
||||
* @return {String} A string representing the given object |
||||
* @public |
||||
*/ |
||||
function format(extensions) { |
||||
return Object.keys(extensions) |
||||
.map((extension) => { |
||||
let configurations = extensions[extension]; |
||||
if (!Array.isArray(configurations)) configurations = [configurations]; |
||||
return configurations |
||||
.map((params) => { |
||||
return [extension] |
||||
.concat( |
||||
Object.keys(params).map((k) => { |
||||
let values = params[k]; |
||||
if (!Array.isArray(values)) values = [values]; |
||||
return values |
||||
.map((v) => (v === true ? k : `${k}=${v}`)) |
||||
.join('; '); |
||||
}) |
||||
) |
||||
.join('; '); |
||||
}) |
||||
.join(', '); |
||||
}) |
||||
.join(', '); |
||||
} |
||||
|
||||
module.exports = { format, parse }; |
||||
@ -0,0 +1,54 @@
|
||||
'use strict'; |
||||
|
||||
const kDone = Symbol('kDone'); |
||||
const kRun = Symbol('kRun'); |
||||
|
||||
/** |
||||
* A very simple job queue with adjustable concurrency. Adapted from |
||||
* https://github.com/STRML/async-limiter
|
||||
*/ |
||||
class Limiter { |
||||
/** |
||||
* Creates a new `Limiter`. |
||||
* |
||||
* @param {Number} concurrency The maximum number of jobs allowed to run |
||||
* concurrently |
||||
*/ |
||||
constructor(concurrency) { |
||||
this[kDone] = () => { |
||||
this.pending--; |
||||
this[kRun](); |
||||
}; |
||||
this.concurrency = concurrency || Infinity; |
||||
this.jobs = []; |
||||
this.pending = 0; |
||||
} |
||||
|
||||
/** |
||||
* Adds a job to the queue. |
||||
* |
||||
* @public |
||||
*/ |
||||
add(job) { |
||||
this.jobs.push(job); |
||||
this[kRun](); |
||||
} |
||||
|
||||
/** |
||||
* Removes a job from the queue and runs it if possible. |
||||
* |
||||
* @private |
||||
*/ |
||||
[kRun]() { |
||||
if (this.pending === this.concurrency) return; |
||||
|
||||
if (this.jobs.length) { |
||||
const job = this.jobs.shift(); |
||||
|
||||
this.pending++; |
||||
job(this[kDone]); |
||||
} |
||||
} |
||||
} |
||||
|
||||
module.exports = Limiter; |
||||
@ -0,0 +1,512 @@
|
||||
'use strict'; |
||||
|
||||
const zlib = require('zlib'); |
||||
|
||||
const bufferUtil = require('./buffer-util'); |
||||
const Limiter = require('./limiter'); |
||||
const { kStatusCode, NOOP } = require('./constants'); |
||||
|
||||
const TRAILER = Buffer.from([0x00, 0x00, 0xff, 0xff]); |
||||
const kPerMessageDeflate = Symbol('permessage-deflate'); |
||||
const kTotalLength = Symbol('total-length'); |
||||
const kCallback = Symbol('callback'); |
||||
const kBuffers = Symbol('buffers'); |
||||
const kError = Symbol('error'); |
||||
|
||||
//
|
||||
// We limit zlib concurrency, which prevents severe memory fragmentation
|
||||
// as documented in https://github.com/nodejs/node/issues/8871#issuecomment-250915913
|
||||
// and https://github.com/websockets/ws/issues/1202
|
||||
//
|
||||
// Intentionally global; it's the global thread pool that's an issue.
|
||||
//
|
||||
let zlibLimiter; |
||||
|
||||
/** |
||||
* permessage-deflate implementation. |
||||
*/ |
||||
class PerMessageDeflate { |
||||
/** |
||||
* Creates a PerMessageDeflate instance. |
||||
* |
||||
* @param {Object} options Configuration options |
||||
* @param {Boolean} options.serverNoContextTakeover Request/accept disabling |
||||
* of server context takeover |
||||
* @param {Boolean} options.clientNoContextTakeover Advertise/acknowledge |
||||
* disabling of client context takeover |
||||
* @param {(Boolean|Number)} options.serverMaxWindowBits Request/confirm the |
||||
* use of a custom server window size |
||||
* @param {(Boolean|Number)} options.clientMaxWindowBits Advertise support |
||||
* for, or request, a custom client window size |
||||
* @param {Object} options.zlibDeflateOptions Options to pass to zlib on deflate |
||||
* @param {Object} options.zlibInflateOptions Options to pass to zlib on inflate |
||||
* @param {Number} options.threshold Size (in bytes) below which messages |
||||
* should not be compressed |
||||
* @param {Number} options.concurrencyLimit The number of concurrent calls to |
||||
* zlib |
||||
* @param {Boolean} isServer Create the instance in either server or client |
||||
* mode |
||||
* @param {Number} maxPayload The maximum allowed message length |
||||
*/ |
||||
constructor(options, isServer, maxPayload) { |
||||
this._maxPayload = maxPayload | 0; |
||||
this._options = options || {}; |
||||
this._threshold = |
||||
this._options.threshold !== undefined ? this._options.threshold : 1024; |
||||
this._isServer = !!isServer; |
||||
this._deflate = null; |
||||
this._inflate = null; |
||||
|
||||
this.params = null; |
||||
|
||||
if (!zlibLimiter) { |
||||
const concurrency = |
||||
this._options.concurrencyLimit !== undefined |
||||
? this._options.concurrencyLimit |
||||
: 10; |
||||
zlibLimiter = new Limiter(concurrency); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* @type {String} |
||||
*/ |
||||
static get extensionName() { |
||||
return 'permessage-deflate'; |
||||
} |
||||
|
||||
/** |
||||
* Create an extension negotiation offer. |
||||
* |
||||
* @return {Object} Extension parameters |
||||
* @public |
||||
*/ |
||||
offer() { |
||||
const params = {}; |
||||
|
||||
if (this._options.serverNoContextTakeover) { |
||||
params.server_no_context_takeover = true; |
||||
} |
||||
if (this._options.clientNoContextTakeover) { |
||||
params.client_no_context_takeover = true; |
||||
} |
||||
if (this._options.serverMaxWindowBits) { |
||||
params.server_max_window_bits = this._options.serverMaxWindowBits; |
||||
} |
||||
if (this._options.clientMaxWindowBits) { |
||||
params.client_max_window_bits = this._options.clientMaxWindowBits; |
||||
} else if (this._options.clientMaxWindowBits == null) { |
||||
params.client_max_window_bits = true; |
||||
} |
||||
|
||||
return params; |
||||
} |
||||
|
||||
/** |
||||
* Accept an extension negotiation offer/response. |
||||
* |
||||
* @param {Array} configurations The extension negotiation offers/reponse |
||||
* @return {Object} Accepted configuration |
||||
* @public |
||||
*/ |
||||
accept(configurations) { |
||||
configurations = this.normalizeParams(configurations); |
||||
|
||||
this.params = this._isServer |
||||
? this.acceptAsServer(configurations) |
||||
: this.acceptAsClient(configurations); |
||||
|
||||
return this.params; |
||||
} |
||||
|
||||
/** |
||||
* Releases all resources used by the extension. |
||||
* |
||||
* @public |
||||
*/ |
||||
cleanup() { |
||||
if (this._inflate) { |
||||
this._inflate.close(); |
||||
this._inflate = null; |
||||
} |
||||
|
||||
if (this._deflate) { |
||||
const callback = this._deflate[kCallback]; |
||||
|
||||
this._deflate.close(); |
||||
this._deflate = null; |
||||
|
||||
if (callback) { |
||||
callback( |
||||
new Error( |
||||
'The deflate stream was closed while data was being processed' |
||||
) |
||||
); |
||||
} |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Accept an extension negotiation offer. |
||||
* |
||||
* @param {Array} offers The extension negotiation offers |
||||
* @return {Object} Accepted configuration |
||||
* @private |
||||
*/ |
||||
acceptAsServer(offers) { |
||||
const opts = this._options; |
||||
const accepted = offers.find((params) => { |
||||
if ( |
||||
(opts.serverNoContextTakeover === false && |
||||
params.server_no_context_takeover) || |
||||
(params.server_max_window_bits && |
||||
(opts.serverMaxWindowBits === false || |
||||
(typeof opts.serverMaxWindowBits === 'number' && |
||||
opts.serverMaxWindowBits > params.server_max_window_bits))) || |
||||
(typeof opts.clientMaxWindowBits === 'number' && |
||||
!params.client_max_window_bits) |
||||
) { |
||||
return false; |
||||
} |
||||
|
||||
return true; |
||||
}); |
||||
|
||||
if (!accepted) { |
||||
throw new Error('None of the extension offers can be accepted'); |
||||
} |
||||
|
||||
if (opts.serverNoContextTakeover) { |
||||
accepted.server_no_context_takeover = true; |
||||
} |
||||
if (opts.clientNoContextTakeover) { |
||||
accepted.client_no_context_takeover = true; |
||||
} |
||||
if (typeof opts.serverMaxWindowBits === 'number') { |
||||
accepted.server_max_window_bits = opts.serverMaxWindowBits; |
||||
} |
||||
if (typeof opts.clientMaxWindowBits === 'number') { |
||||
accepted.client_max_window_bits = opts.clientMaxWindowBits; |
||||
} else if ( |
||||
accepted.client_max_window_bits === true || |
||||
opts.clientMaxWindowBits === false |
||||
) { |
||||
delete accepted.client_max_window_bits; |
||||
} |
||||
|
||||
return accepted; |
||||
} |
||||
|
||||
/** |
||||
* Accept the extension negotiation response. |
||||
* |
||||
* @param {Array} response The extension negotiation response |
||||
* @return {Object} Accepted configuration |
||||
* @private |
||||
*/ |
||||
acceptAsClient(response) { |
||||
const params = response[0]; |
||||
|
||||
if ( |
||||
this._options.clientNoContextTakeover === false && |
||||
params.client_no_context_takeover |
||||
) { |
||||
throw new Error('Unexpected parameter "client_no_context_takeover"'); |
||||
} |
||||
|
||||
if (!params.client_max_window_bits) { |
||||
if (typeof this._options.clientMaxWindowBits === 'number') { |
||||
params.client_max_window_bits = this._options.clientMaxWindowBits; |
||||
} |
||||
} else if ( |
||||
this._options.clientMaxWindowBits === false || |
||||
(typeof this._options.clientMaxWindowBits === 'number' && |
||||
params.client_max_window_bits > this._options.clientMaxWindowBits) |
||||
) { |
||||
throw new Error( |
||||
'Unexpected or invalid parameter "client_max_window_bits"' |
||||
); |
||||
} |
||||
|
||||
return params; |
||||
} |
||||
|
||||
/** |
||||
* Normalize parameters. |
||||
* |
||||
* @param {Array} configurations The extension negotiation offers/reponse |
||||
* @return {Array} The offers/response with normalized parameters |
||||
* @private |
||||
*/ |
||||
normalizeParams(configurations) { |
||||
configurations.forEach((params) => { |
||||
Object.keys(params).forEach((key) => { |
||||
let value = params[key]; |
||||
|
||||
if (value.length > 1) { |
||||
throw new Error(`Parameter "${key}" must have only a single value`); |
||||
} |
||||
|
||||
value = value[0]; |
||||
|
||||
if (key === 'client_max_window_bits') { |
||||
if (value !== true) { |
||||
const num = +value; |
||||
if (!Number.isInteger(num) || num < 8 || num > 15) { |
||||
throw new TypeError( |
||||
`Invalid value for parameter "${key}": ${value}` |
||||
); |
||||
} |
||||
value = num; |
||||
} else if (!this._isServer) { |
||||
throw new TypeError( |
||||
`Invalid value for parameter "${key}": ${value}` |
||||
); |
||||
} |
||||
} else if (key === 'server_max_window_bits') { |
||||
const num = +value; |
||||
if (!Number.isInteger(num) || num < 8 || num > 15) { |
||||
throw new TypeError( |
||||
`Invalid value for parameter "${key}": ${value}` |
||||
); |
||||
} |
||||
value = num; |
||||
} else if ( |
||||
key === 'client_no_context_takeover' || |
||||
key === 'server_no_context_takeover' |
||||
) { |
||||
if (value !== true) { |
||||
throw new TypeError( |
||||
`Invalid value for parameter "${key}": ${value}` |
||||
); |
||||
} |
||||
} else { |
||||
throw new Error(`Unknown parameter "${key}"`); |
||||
} |
||||
|
||||
params[key] = value; |
||||
}); |
||||
}); |
||||
|
||||
return configurations; |
||||
} |
||||
|
||||
/** |
||||
* Decompress data. Concurrency limited. |
||||
* |
||||
* @param {Buffer} data Compressed data |
||||
* @param {Boolean} fin Specifies whether or not this is the last fragment |
||||
* @param {Function} callback Callback |
||||
* @public |
||||
*/ |
||||
decompress(data, fin, callback) { |
||||
zlibLimiter.add((done) => { |
||||
this._decompress(data, fin, (err, result) => { |
||||
done(); |
||||
callback(err, result); |
||||
}); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Compress data. Concurrency limited. |
||||
* |
||||
* @param {Buffer} data Data to compress |
||||
* @param {Boolean} fin Specifies whether or not this is the last fragment |
||||
* @param {Function} callback Callback |
||||
* @public |
||||
*/ |
||||
compress(data, fin, callback) { |
||||
zlibLimiter.add((done) => { |
||||
this._compress(data, fin, (err, result) => { |
||||
done(); |
||||
callback(err, result); |
||||
}); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Decompress data. |
||||
* |
||||
* @param {Buffer} data Compressed data |
||||
* @param {Boolean} fin Specifies whether or not this is the last fragment |
||||
* @param {Function} callback Callback |
||||
* @private |
||||
*/ |
||||
_decompress(data, fin, callback) { |
||||
const endpoint = this._isServer ? 'client' : 'server'; |
||||
|
||||
if (!this._inflate) { |
||||
const key = `${endpoint}_max_window_bits`; |
||||
const windowBits = |
||||
typeof this.params[key] !== 'number' |
||||
? zlib.Z_DEFAULT_WINDOWBITS |
||||
: this.params[key]; |
||||
|
||||
this._inflate = zlib.createInflateRaw({ |
||||
...this._options.zlibInflateOptions, |
||||
windowBits |
||||
}); |
||||
this._inflate[kPerMessageDeflate] = this; |
||||
this._inflate[kTotalLength] = 0; |
||||
this._inflate[kBuffers] = []; |
||||
this._inflate.on('error', inflateOnError); |
||||
this._inflate.on('data', inflateOnData); |
||||
} |
||||
|
||||
this._inflate[kCallback] = callback; |
||||
|
||||
this._inflate.write(data); |
||||
if (fin) this._inflate.write(TRAILER); |
||||
|
||||
this._inflate.flush(() => { |
||||
const err = this._inflate[kError]; |
||||
|
||||
if (err) { |
||||
this._inflate.close(); |
||||
this._inflate = null; |
||||
callback(err); |
||||
return; |
||||
} |
||||
|
||||
const data = bufferUtil.concat( |
||||
this._inflate[kBuffers], |
||||
this._inflate[kTotalLength] |
||||
); |
||||
|
||||
if (fin && this.params[`${endpoint}_no_context_takeover`]) { |
||||
this._inflate.close(); |
||||
this._inflate = null; |
||||
} else { |
||||
this._inflate[kTotalLength] = 0; |
||||
this._inflate[kBuffers] = []; |
||||
} |
||||
|
||||
callback(null, data); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Compress data. |
||||
* |
||||
* @param {Buffer} data Data to compress |
||||
* @param {Boolean} fin Specifies whether or not this is the last fragment |
||||
* @param {Function} callback Callback |
||||
* @private |
||||
*/ |
||||
_compress(data, fin, callback) { |
||||
const endpoint = this._isServer ? 'server' : 'client'; |
||||
|
||||
if (!this._deflate) { |
||||
const key = `${endpoint}_max_window_bits`; |
||||
const windowBits = |
||||
typeof this.params[key] !== 'number' |
||||
? zlib.Z_DEFAULT_WINDOWBITS |
||||
: this.params[key]; |
||||
|
||||
this._deflate = zlib.createDeflateRaw({ |
||||
...this._options.zlibDeflateOptions, |
||||
windowBits |
||||
}); |
||||
|
||||
this._deflate[kTotalLength] = 0; |
||||
this._deflate[kBuffers] = []; |
||||
|
||||
//
|
||||
// An `'error'` event is emitted, only on Node.js < 10.0.0, if the
|
||||
// `zlib.DeflateRaw` instance is closed while data is being processed.
|
||||
// This can happen if `PerMessageDeflate#cleanup()` is called at the wrong
|
||||
// time due to an abnormal WebSocket closure.
|
||||
//
|
||||
this._deflate.on('error', NOOP); |
||||
this._deflate.on('data', deflateOnData); |
||||
} |
||||
|
||||
this._deflate[kCallback] = callback; |
||||
|
||||
this._deflate.write(data); |
||||
this._deflate.flush(zlib.Z_SYNC_FLUSH, () => { |
||||
if (!this._deflate) { |
||||
//
|
||||
// The deflate stream was closed while data was being processed.
|
||||
//
|
||||
return; |
||||
} |
||||
|
||||
let data = bufferUtil.concat( |
||||
this._deflate[kBuffers], |
||||
this._deflate[kTotalLength] |
||||
); |
||||
|
||||
if (fin) data = data.slice(0, data.length - 4); |
||||
|
||||
//
|
||||
// Ensure that the callback will not be called again in
|
||||
// `PerMessageDeflate#cleanup()`.
|
||||
//
|
||||
this._deflate[kCallback] = null; |
||||
|
||||
if (fin && this.params[`${endpoint}_no_context_takeover`]) { |
||||
this._deflate.close(); |
||||
this._deflate = null; |
||||
} else { |
||||
this._deflate[kTotalLength] = 0; |
||||
this._deflate[kBuffers] = []; |
||||
} |
||||
|
||||
callback(null, data); |
||||
}); |
||||
} |
||||
} |
||||
|
||||
module.exports = PerMessageDeflate; |
||||
|
||||
/** |
||||
* The listener of the `zlib.DeflateRaw` stream `'data'` event. |
||||
* |
||||
* @param {Buffer} chunk A chunk of data |
||||
* @private |
||||
*/ |
||||
function deflateOnData(chunk) { |
||||
this[kBuffers].push(chunk); |
||||
this[kTotalLength] += chunk.length; |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `zlib.InflateRaw` stream `'data'` event. |
||||
* |
||||
* @param {Buffer} chunk A chunk of data |
||||
* @private |
||||
*/ |
||||
function inflateOnData(chunk) { |
||||
this[kTotalLength] += chunk.length; |
||||
|
||||
if ( |
||||
this[kPerMessageDeflate]._maxPayload < 1 || |
||||
this[kTotalLength] <= this[kPerMessageDeflate]._maxPayload |
||||
) { |
||||
this[kBuffers].push(chunk); |
||||
return; |
||||
} |
||||
|
||||
this[kError] = new RangeError('Max payload size exceeded'); |
||||
this[kError][kStatusCode] = 1009; |
||||
this.removeListener('data', inflateOnData); |
||||
this.reset(); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `zlib.InflateRaw` stream `'error'` event. |
||||
* |
||||
* @param {Error} err The emitted error |
||||
* @private |
||||
*/ |
||||
function inflateOnError(err) { |
||||
//
|
||||
// There is no need to call `Zlib#close()` as the handle is automatically
|
||||
// closed when an error is emitted.
|
||||
//
|
||||
this[kPerMessageDeflate]._inflate = null; |
||||
err[kStatusCode] = 1007; |
||||
this[kCallback](err); |
||||
} |
||||
@ -0,0 +1,507 @@
|
||||
'use strict'; |
||||
|
||||
const { Writable } = require('stream'); |
||||
|
||||
const PerMessageDeflate = require('./permessage-deflate'); |
||||
const { |
||||
BINARY_TYPES, |
||||
EMPTY_BUFFER, |
||||
kStatusCode, |
||||
kWebSocket |
||||
} = require('./constants'); |
||||
const { concat, toArrayBuffer, unmask } = require('./buffer-util'); |
||||
const { isValidStatusCode, isValidUTF8 } = require('./validation'); |
||||
|
||||
const GET_INFO = 0; |
||||
const GET_PAYLOAD_LENGTH_16 = 1; |
||||
const GET_PAYLOAD_LENGTH_64 = 2; |
||||
const GET_MASK = 3; |
||||
const GET_DATA = 4; |
||||
const INFLATING = 5; |
||||
|
||||
/** |
||||
* HyBi Receiver implementation. |
||||
* |
||||
* @extends stream.Writable |
||||
*/ |
||||
class Receiver extends Writable { |
||||
/** |
||||
* Creates a Receiver instance. |
||||
* |
||||
* @param {String} binaryType The type for binary data |
||||
* @param {Object} extensions An object containing the negotiated extensions |
||||
* @param {Boolean} isServer Specifies whether to operate in client or server |
||||
* mode |
||||
* @param {Number} maxPayload The maximum allowed message length |
||||
*/ |
||||
constructor(binaryType, extensions, isServer, maxPayload) { |
||||
super(); |
||||
|
||||
this._binaryType = binaryType || BINARY_TYPES[0]; |
||||
this[kWebSocket] = undefined; |
||||
this._extensions = extensions || {}; |
||||
this._isServer = !!isServer; |
||||
this._maxPayload = maxPayload | 0; |
||||
|
||||
this._bufferedBytes = 0; |
||||
this._buffers = []; |
||||
|
||||
this._compressed = false; |
||||
this._payloadLength = 0; |
||||
this._mask = undefined; |
||||
this._fragmented = 0; |
||||
this._masked = false; |
||||
this._fin = false; |
||||
this._opcode = 0; |
||||
|
||||
this._totalPayloadLength = 0; |
||||
this._messageLength = 0; |
||||
this._fragments = []; |
||||
|
||||
this._state = GET_INFO; |
||||
this._loop = false; |
||||
} |
||||
|
||||
/** |
||||
* Implements `Writable.prototype._write()`. |
||||
* |
||||
* @param {Buffer} chunk The chunk of data to write |
||||
* @param {String} encoding The character encoding of `chunk` |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
_write(chunk, encoding, cb) { |
||||
if (this._opcode === 0x08 && this._state == GET_INFO) return cb(); |
||||
|
||||
this._bufferedBytes += chunk.length; |
||||
this._buffers.push(chunk); |
||||
this.startLoop(cb); |
||||
} |
||||
|
||||
/** |
||||
* Consumes `n` bytes from the buffered data. |
||||
* |
||||
* @param {Number} n The number of bytes to consume |
||||
* @return {Buffer} The consumed bytes |
||||
* @private |
||||
*/ |
||||
consume(n) { |
||||
this._bufferedBytes -= n; |
||||
|
||||
if (n === this._buffers[0].length) return this._buffers.shift(); |
||||
|
||||
if (n < this._buffers[0].length) { |
||||
const buf = this._buffers[0]; |
||||
this._buffers[0] = buf.slice(n); |
||||
return buf.slice(0, n); |
||||
} |
||||
|
||||
const dst = Buffer.allocUnsafe(n); |
||||
|
||||
do { |
||||
const buf = this._buffers[0]; |
||||
const offset = dst.length - n; |
||||
|
||||
if (n >= buf.length) { |
||||
dst.set(this._buffers.shift(), offset); |
||||
} else { |
||||
dst.set(new Uint8Array(buf.buffer, buf.byteOffset, n), offset); |
||||
this._buffers[0] = buf.slice(n); |
||||
} |
||||
|
||||
n -= buf.length; |
||||
} while (n > 0); |
||||
|
||||
return dst; |
||||
} |
||||
|
||||
/** |
||||
* Starts the parsing loop. |
||||
* |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
startLoop(cb) { |
||||
let err; |
||||
this._loop = true; |
||||
|
||||
do { |
||||
switch (this._state) { |
||||
case GET_INFO: |
||||
err = this.getInfo(); |
||||
break; |
||||
case GET_PAYLOAD_LENGTH_16: |
||||
err = this.getPayloadLength16(); |
||||
break; |
||||
case GET_PAYLOAD_LENGTH_64: |
||||
err = this.getPayloadLength64(); |
||||
break; |
||||
case GET_MASK: |
||||
this.getMask(); |
||||
break; |
||||
case GET_DATA: |
||||
err = this.getData(cb); |
||||
break; |
||||
default: |
||||
// `INFLATING`
|
||||
this._loop = false; |
||||
return; |
||||
} |
||||
} while (this._loop); |
||||
|
||||
cb(err); |
||||
} |
||||
|
||||
/** |
||||
* Reads the first two bytes of a frame. |
||||
* |
||||
* @return {(RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
getInfo() { |
||||
if (this._bufferedBytes < 2) { |
||||
this._loop = false; |
||||
return; |
||||
} |
||||
|
||||
const buf = this.consume(2); |
||||
|
||||
if ((buf[0] & 0x30) !== 0x00) { |
||||
this._loop = false; |
||||
return error(RangeError, 'RSV2 and RSV3 must be clear', true, 1002); |
||||
} |
||||
|
||||
const compressed = (buf[0] & 0x40) === 0x40; |
||||
|
||||
if (compressed && !this._extensions[PerMessageDeflate.extensionName]) { |
||||
this._loop = false; |
||||
return error(RangeError, 'RSV1 must be clear', true, 1002); |
||||
} |
||||
|
||||
this._fin = (buf[0] & 0x80) === 0x80; |
||||
this._opcode = buf[0] & 0x0f; |
||||
this._payloadLength = buf[1] & 0x7f; |
||||
|
||||
if (this._opcode === 0x00) { |
||||
if (compressed) { |
||||
this._loop = false; |
||||
return error(RangeError, 'RSV1 must be clear', true, 1002); |
||||
} |
||||
|
||||
if (!this._fragmented) { |
||||
this._loop = false; |
||||
return error(RangeError, 'invalid opcode 0', true, 1002); |
||||
} |
||||
|
||||
this._opcode = this._fragmented; |
||||
} else if (this._opcode === 0x01 || this._opcode === 0x02) { |
||||
if (this._fragmented) { |
||||
this._loop = false; |
||||
return error(RangeError, `invalid opcode ${this._opcode}`, true, 1002); |
||||
} |
||||
|
||||
this._compressed = compressed; |
||||
} else if (this._opcode > 0x07 && this._opcode < 0x0b) { |
||||
if (!this._fin) { |
||||
this._loop = false; |
||||
return error(RangeError, 'FIN must be set', true, 1002); |
||||
} |
||||
|
||||
if (compressed) { |
||||
this._loop = false; |
||||
return error(RangeError, 'RSV1 must be clear', true, 1002); |
||||
} |
||||
|
||||
if (this._payloadLength > 0x7d) { |
||||
this._loop = false; |
||||
return error( |
||||
RangeError, |
||||
`invalid payload length ${this._payloadLength}`, |
||||
true, |
||||
1002 |
||||
); |
||||
} |
||||
} else { |
||||
this._loop = false; |
||||
return error(RangeError, `invalid opcode ${this._opcode}`, true, 1002); |
||||
} |
||||
|
||||
if (!this._fin && !this._fragmented) this._fragmented = this._opcode; |
||||
this._masked = (buf[1] & 0x80) === 0x80; |
||||
|
||||
if (this._isServer) { |
||||
if (!this._masked) { |
||||
this._loop = false; |
||||
return error(RangeError, 'MASK must be set', true, 1002); |
||||
} |
||||
} else if (this._masked) { |
||||
this._loop = false; |
||||
return error(RangeError, 'MASK must be clear', true, 1002); |
||||
} |
||||
|
||||
if (this._payloadLength === 126) this._state = GET_PAYLOAD_LENGTH_16; |
||||
else if (this._payloadLength === 127) this._state = GET_PAYLOAD_LENGTH_64; |
||||
else return this.haveLength(); |
||||
} |
||||
|
||||
/** |
||||
* Gets extended payload length (7+16). |
||||
* |
||||
* @return {(RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
getPayloadLength16() { |
||||
if (this._bufferedBytes < 2) { |
||||
this._loop = false; |
||||
return; |
||||
} |
||||
|
||||
this._payloadLength = this.consume(2).readUInt16BE(0); |
||||
return this.haveLength(); |
||||
} |
||||
|
||||
/** |
||||
* Gets extended payload length (7+64). |
||||
* |
||||
* @return {(RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
getPayloadLength64() { |
||||
if (this._bufferedBytes < 8) { |
||||
this._loop = false; |
||||
return; |
||||
} |
||||
|
||||
const buf = this.consume(8); |
||||
const num = buf.readUInt32BE(0); |
||||
|
||||
//
|
||||
// The maximum safe integer in JavaScript is 2^53 - 1. An error is returned
|
||||
// if payload length is greater than this number.
|
||||
//
|
||||
if (num > Math.pow(2, 53 - 32) - 1) { |
||||
this._loop = false; |
||||
return error( |
||||
RangeError, |
||||
'Unsupported WebSocket frame: payload length > 2^53 - 1', |
||||
false, |
||||
1009 |
||||
); |
||||
} |
||||
|
||||
this._payloadLength = num * Math.pow(2, 32) + buf.readUInt32BE(4); |
||||
return this.haveLength(); |
||||
} |
||||
|
||||
/** |
||||
* Payload length has been read. |
||||
* |
||||
* @return {(RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
haveLength() { |
||||
if (this._payloadLength && this._opcode < 0x08) { |
||||
this._totalPayloadLength += this._payloadLength; |
||||
if (this._totalPayloadLength > this._maxPayload && this._maxPayload > 0) { |
||||
this._loop = false; |
||||
return error(RangeError, 'Max payload size exceeded', false, 1009); |
||||
} |
||||
} |
||||
|
||||
if (this._masked) this._state = GET_MASK; |
||||
else this._state = GET_DATA; |
||||
} |
||||
|
||||
/** |
||||
* Reads mask bytes. |
||||
* |
||||
* @private |
||||
*/ |
||||
getMask() { |
||||
if (this._bufferedBytes < 4) { |
||||
this._loop = false; |
||||
return; |
||||
} |
||||
|
||||
this._mask = this.consume(4); |
||||
this._state = GET_DATA; |
||||
} |
||||
|
||||
/** |
||||
* Reads data bytes. |
||||
* |
||||
* @param {Function} cb Callback |
||||
* @return {(Error|RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
getData(cb) { |
||||
let data = EMPTY_BUFFER; |
||||
|
||||
if (this._payloadLength) { |
||||
if (this._bufferedBytes < this._payloadLength) { |
||||
this._loop = false; |
||||
return; |
||||
} |
||||
|
||||
data = this.consume(this._payloadLength); |
||||
if (this._masked) unmask(data, this._mask); |
||||
} |
||||
|
||||
if (this._opcode > 0x07) return this.controlMessage(data); |
||||
|
||||
if (this._compressed) { |
||||
this._state = INFLATING; |
||||
this.decompress(data, cb); |
||||
return; |
||||
} |
||||
|
||||
if (data.length) { |
||||
//
|
||||
// This message is not compressed so its lenght is the sum of the payload
|
||||
// length of all fragments.
|
||||
//
|
||||
this._messageLength = this._totalPayloadLength; |
||||
this._fragments.push(data); |
||||
} |
||||
|
||||
return this.dataMessage(); |
||||
} |
||||
|
||||
/** |
||||
* Decompresses data. |
||||
* |
||||
* @param {Buffer} data Compressed data |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
decompress(data, cb) { |
||||
const perMessageDeflate = this._extensions[PerMessageDeflate.extensionName]; |
||||
|
||||
perMessageDeflate.decompress(data, this._fin, (err, buf) => { |
||||
if (err) return cb(err); |
||||
|
||||
if (buf.length) { |
||||
this._messageLength += buf.length; |
||||
if (this._messageLength > this._maxPayload && this._maxPayload > 0) { |
||||
return cb( |
||||
error(RangeError, 'Max payload size exceeded', false, 1009) |
||||
); |
||||
} |
||||
|
||||
this._fragments.push(buf); |
||||
} |
||||
|
||||
const er = this.dataMessage(); |
||||
if (er) return cb(er); |
||||
|
||||
this.startLoop(cb); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Handles a data message. |
||||
* |
||||
* @return {(Error|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
dataMessage() { |
||||
if (this._fin) { |
||||
const messageLength = this._messageLength; |
||||
const fragments = this._fragments; |
||||
|
||||
this._totalPayloadLength = 0; |
||||
this._messageLength = 0; |
||||
this._fragmented = 0; |
||||
this._fragments = []; |
||||
|
||||
if (this._opcode === 2) { |
||||
let data; |
||||
|
||||
if (this._binaryType === 'nodebuffer') { |
||||
data = concat(fragments, messageLength); |
||||
} else if (this._binaryType === 'arraybuffer') { |
||||
data = toArrayBuffer(concat(fragments, messageLength)); |
||||
} else { |
||||
data = fragments; |
||||
} |
||||
|
||||
this.emit('message', data); |
||||
} else { |
||||
const buf = concat(fragments, messageLength); |
||||
|
||||
if (!isValidUTF8(buf)) { |
||||
this._loop = false; |
||||
return error(Error, 'invalid UTF-8 sequence', true, 1007); |
||||
} |
||||
|
||||
this.emit('message', buf.toString()); |
||||
} |
||||
} |
||||
|
||||
this._state = GET_INFO; |
||||
} |
||||
|
||||
/** |
||||
* Handles a control message. |
||||
* |
||||
* @param {Buffer} data Data to handle |
||||
* @return {(Error|RangeError|undefined)} A possible error |
||||
* @private |
||||
*/ |
||||
controlMessage(data) { |
||||
if (this._opcode === 0x08) { |
||||
this._loop = false; |
||||
|
||||
if (data.length === 0) { |
||||
this.emit('conclude', 1005, ''); |
||||
this.end(); |
||||
} else if (data.length === 1) { |
||||
return error(RangeError, 'invalid payload length 1', true, 1002); |
||||
} else { |
||||
const code = data.readUInt16BE(0); |
||||
|
||||
if (!isValidStatusCode(code)) { |
||||
return error(RangeError, `invalid status code ${code}`, true, 1002); |
||||
} |
||||
|
||||
const buf = data.slice(2); |
||||
|
||||
if (!isValidUTF8(buf)) { |
||||
return error(Error, 'invalid UTF-8 sequence', true, 1007); |
||||
} |
||||
|
||||
this.emit('conclude', code, buf.toString()); |
||||
this.end(); |
||||
} |
||||
} else if (this._opcode === 0x09) { |
||||
this.emit('ping', data); |
||||
} else { |
||||
this.emit('pong', data); |
||||
} |
||||
|
||||
this._state = GET_INFO; |
||||
} |
||||
} |
||||
|
||||
module.exports = Receiver; |
||||
|
||||
/** |
||||
* Builds an error object. |
||||
* |
||||
* @param {(Error|RangeError)} ErrorCtor The error constructor |
||||
* @param {String} message The error message |
||||
* @param {Boolean} prefix Specifies whether or not to add a default prefix to |
||||
* `message` |
||||
* @param {Number} statusCode The status code |
||||
* @return {(Error|RangeError)} The error |
||||
* @private |
||||
*/ |
||||
function error(ErrorCtor, message, prefix, statusCode) { |
||||
const err = new ErrorCtor( |
||||
prefix ? `Invalid WebSocket frame: ${message}` : message |
||||
); |
||||
|
||||
Error.captureStackTrace(err, error); |
||||
err[kStatusCode] = statusCode; |
||||
return err; |
||||
} |
||||
@ -0,0 +1,392 @@
|
||||
'use strict'; |
||||
|
||||
const { randomFillSync } = require('crypto'); |
||||
|
||||
const PerMessageDeflate = require('./permessage-deflate'); |
||||
const { EMPTY_BUFFER } = require('./constants'); |
||||
const { isValidStatusCode } = require('./validation'); |
||||
const { mask: applyMask, toBuffer } = require('./buffer-util'); |
||||
|
||||
const mask = Buffer.alloc(4); |
||||
|
||||
/** |
||||
* HyBi Sender implementation. |
||||
*/ |
||||
class Sender { |
||||
/** |
||||
* Creates a Sender instance. |
||||
* |
||||
* @param {net.Socket} socket The connection socket |
||||
* @param {Object} extensions An object containing the negotiated extensions |
||||
*/ |
||||
constructor(socket, extensions) { |
||||
this._extensions = extensions || {}; |
||||
this._socket = socket; |
||||
|
||||
this._firstFragment = true; |
||||
this._compress = false; |
||||
|
||||
this._bufferedBytes = 0; |
||||
this._deflating = false; |
||||
this._queue = []; |
||||
} |
||||
|
||||
/** |
||||
* Frames a piece of data according to the HyBi WebSocket protocol. |
||||
* |
||||
* @param {Buffer} data The data to frame |
||||
* @param {Object} options Options object |
||||
* @param {Number} options.opcode The opcode |
||||
* @param {Boolean} options.readOnly Specifies whether `data` can be modified |
||||
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit |
||||
* @param {Boolean} options.mask Specifies whether or not to mask `data` |
||||
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit |
||||
* @return {Buffer[]} The framed data as a list of `Buffer` instances |
||||
* @public |
||||
*/ |
||||
static frame(data, options) { |
||||
const merge = options.mask && options.readOnly; |
||||
let offset = options.mask ? 6 : 2; |
||||
let payloadLength = data.length; |
||||
|
||||
if (data.length >= 65536) { |
||||
offset += 8; |
||||
payloadLength = 127; |
||||
} else if (data.length > 125) { |
||||
offset += 2; |
||||
payloadLength = 126; |
||||
} |
||||
|
||||
const target = Buffer.allocUnsafe(merge ? data.length + offset : offset); |
||||
|
||||
target[0] = options.fin ? options.opcode | 0x80 : options.opcode; |
||||
if (options.rsv1) target[0] |= 0x40; |
||||
|
||||
target[1] = payloadLength; |
||||
|
||||
if (payloadLength === 126) { |
||||
target.writeUInt16BE(data.length, 2); |
||||
} else if (payloadLength === 127) { |
||||
target.writeUInt32BE(0, 2); |
||||
target.writeUInt32BE(data.length, 6); |
||||
} |
||||
|
||||
if (!options.mask) return [target, data]; |
||||
|
||||
randomFillSync(mask, 0, 4); |
||||
|
||||
target[1] |= 0x80; |
||||
target[offset - 4] = mask[0]; |
||||
target[offset - 3] = mask[1]; |
||||
target[offset - 2] = mask[2]; |
||||
target[offset - 1] = mask[3]; |
||||
|
||||
if (merge) { |
||||
applyMask(data, mask, target, offset, data.length); |
||||
return [target]; |
||||
} |
||||
|
||||
applyMask(data, mask, data, 0, data.length); |
||||
return [target, data]; |
||||
} |
||||
|
||||
/** |
||||
* Sends a close message to the other peer. |
||||
* |
||||
* @param {(Number|undefined)} code The status code component of the body |
||||
* @param {String} data The message component of the body |
||||
* @param {Boolean} mask Specifies whether or not to mask the message |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
close(code, data, mask, cb) { |
||||
let buf; |
||||
|
||||
if (code === undefined) { |
||||
buf = EMPTY_BUFFER; |
||||
} else if (typeof code !== 'number' || !isValidStatusCode(code)) { |
||||
throw new TypeError('First argument must be a valid error code number'); |
||||
} else if (data === undefined || data === '') { |
||||
buf = Buffer.allocUnsafe(2); |
||||
buf.writeUInt16BE(code, 0); |
||||
} else { |
||||
const length = Buffer.byteLength(data); |
||||
|
||||
if (length > 123) { |
||||
throw new RangeError('The message must not be greater than 123 bytes'); |
||||
} |
||||
|
||||
buf = Buffer.allocUnsafe(2 + length); |
||||
buf.writeUInt16BE(code, 0); |
||||
buf.write(data, 2); |
||||
} |
||||
|
||||
if (this._deflating) { |
||||
this.enqueue([this.doClose, buf, mask, cb]); |
||||
} else { |
||||
this.doClose(buf, mask, cb); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Frames and sends a close message. |
||||
* |
||||
* @param {Buffer} data The message to send |
||||
* @param {Boolean} mask Specifies whether or not to mask `data` |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
doClose(data, mask, cb) { |
||||
this.sendFrame( |
||||
Sender.frame(data, { |
||||
fin: true, |
||||
rsv1: false, |
||||
opcode: 0x08, |
||||
mask, |
||||
readOnly: false |
||||
}), |
||||
cb |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* Sends a ping message to the other peer. |
||||
* |
||||
* @param {*} data The message to send |
||||
* @param {Boolean} mask Specifies whether or not to mask `data` |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
ping(data, mask, cb) { |
||||
const buf = toBuffer(data); |
||||
|
||||
if (buf.length > 125) { |
||||
throw new RangeError('The data size must not be greater than 125 bytes'); |
||||
} |
||||
|
||||
if (this._deflating) { |
||||
this.enqueue([this.doPing, buf, mask, toBuffer.readOnly, cb]); |
||||
} else { |
||||
this.doPing(buf, mask, toBuffer.readOnly, cb); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Frames and sends a ping message. |
||||
* |
||||
* @param {Buffer} data The message to send |
||||
* @param {Boolean} mask Specifies whether or not to mask `data` |
||||
* @param {Boolean} readOnly Specifies whether `data` can be modified |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
doPing(data, mask, readOnly, cb) { |
||||
this.sendFrame( |
||||
Sender.frame(data, { |
||||
fin: true, |
||||
rsv1: false, |
||||
opcode: 0x09, |
||||
mask, |
||||
readOnly |
||||
}), |
||||
cb |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* Sends a pong message to the other peer. |
||||
* |
||||
* @param {*} data The message to send |
||||
* @param {Boolean} mask Specifies whether or not to mask `data` |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
pong(data, mask, cb) { |
||||
const buf = toBuffer(data); |
||||
|
||||
if (buf.length > 125) { |
||||
throw new RangeError('The data size must not be greater than 125 bytes'); |
||||
} |
||||
|
||||
if (this._deflating) { |
||||
this.enqueue([this.doPong, buf, mask, toBuffer.readOnly, cb]); |
||||
} else { |
||||
this.doPong(buf, mask, toBuffer.readOnly, cb); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Frames and sends a pong message. |
||||
* |
||||
* @param {Buffer} data The message to send |
||||
* @param {Boolean} mask Specifies whether or not to mask `data` |
||||
* @param {Boolean} readOnly Specifies whether `data` can be modified |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
doPong(data, mask, readOnly, cb) { |
||||
this.sendFrame( |
||||
Sender.frame(data, { |
||||
fin: true, |
||||
rsv1: false, |
||||
opcode: 0x0a, |
||||
mask, |
||||
readOnly |
||||
}), |
||||
cb |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* Sends a data message to the other peer. |
||||
* |
||||
* @param {*} data The message to send |
||||
* @param {Object} options Options object |
||||
* @param {Boolean} options.compress Specifies whether or not to compress `data` |
||||
* @param {Boolean} options.binary Specifies whether `data` is binary or text |
||||
* @param {Boolean} options.fin Specifies whether the fragment is the last one |
||||
* @param {Boolean} options.mask Specifies whether or not to mask `data` |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
send(data, options, cb) { |
||||
const buf = toBuffer(data); |
||||
const perMessageDeflate = this._extensions[PerMessageDeflate.extensionName]; |
||||
let opcode = options.binary ? 2 : 1; |
||||
let rsv1 = options.compress; |
||||
|
||||
if (this._firstFragment) { |
||||
this._firstFragment = false; |
||||
if (rsv1 && perMessageDeflate) { |
||||
rsv1 = buf.length >= perMessageDeflate._threshold; |
||||
} |
||||
this._compress = rsv1; |
||||
} else { |
||||
rsv1 = false; |
||||
opcode = 0; |
||||
} |
||||
|
||||
if (options.fin) this._firstFragment = true; |
||||
|
||||
if (perMessageDeflate) { |
||||
const opts = { |
||||
fin: options.fin, |
||||
rsv1, |
||||
opcode, |
||||
mask: options.mask, |
||||
readOnly: toBuffer.readOnly |
||||
}; |
||||
|
||||
if (this._deflating) { |
||||
this.enqueue([this.dispatch, buf, this._compress, opts, cb]); |
||||
} else { |
||||
this.dispatch(buf, this._compress, opts, cb); |
||||
} |
||||
} else { |
||||
this.sendFrame( |
||||
Sender.frame(buf, { |
||||
fin: options.fin, |
||||
rsv1: false, |
||||
opcode, |
||||
mask: options.mask, |
||||
readOnly: toBuffer.readOnly |
||||
}), |
||||
cb |
||||
); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Dispatches a data message. |
||||
* |
||||
* @param {Buffer} data The message to send |
||||
* @param {Boolean} compress Specifies whether or not to compress `data` |
||||
* @param {Object} options Options object |
||||
* @param {Number} options.opcode The opcode |
||||
* @param {Boolean} options.readOnly Specifies whether `data` can be modified |
||||
* @param {Boolean} options.fin Specifies whether or not to set the FIN bit |
||||
* @param {Boolean} options.mask Specifies whether or not to mask `data` |
||||
* @param {Boolean} options.rsv1 Specifies whether or not to set the RSV1 bit |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
dispatch(data, compress, options, cb) { |
||||
if (!compress) { |
||||
this.sendFrame(Sender.frame(data, options), cb); |
||||
return; |
||||
} |
||||
|
||||
const perMessageDeflate = this._extensions[PerMessageDeflate.extensionName]; |
||||
|
||||
this._bufferedBytes += data.length; |
||||
this._deflating = true; |
||||
perMessageDeflate.compress(data, options.fin, (_, buf) => { |
||||
if (this._socket.destroyed) { |
||||
const err = new Error( |
||||
'The socket was closed while data was being compressed' |
||||
); |
||||
|
||||
if (typeof cb === 'function') cb(err); |
||||
|
||||
for (let i = 0; i < this._queue.length; i++) { |
||||
const callback = this._queue[i][4]; |
||||
|
||||
if (typeof callback === 'function') callback(err); |
||||
} |
||||
|
||||
return; |
||||
} |
||||
|
||||
this._bufferedBytes -= data.length; |
||||
this._deflating = false; |
||||
options.readOnly = false; |
||||
this.sendFrame(Sender.frame(buf, options), cb); |
||||
this.dequeue(); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Executes queued send operations. |
||||
* |
||||
* @private |
||||
*/ |
||||
dequeue() { |
||||
while (!this._deflating && this._queue.length) { |
||||
const params = this._queue.shift(); |
||||
|
||||
this._bufferedBytes -= params[1].length; |
||||
Reflect.apply(params[0], this, params.slice(1)); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Enqueues a send operation. |
||||
* |
||||
* @param {Array} params Send operation parameters. |
||||
* @private |
||||
*/ |
||||
enqueue(params) { |
||||
this._bufferedBytes += params[1].length; |
||||
this._queue.push(params); |
||||
} |
||||
|
||||
/** |
||||
* Sends a frame. |
||||
* |
||||
* @param {Buffer[]} list The frame to send |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
sendFrame(list, cb) { |
||||
if (list.length === 2) { |
||||
this._socket.cork(); |
||||
this._socket.write(list[0]); |
||||
this._socket.write(list[1], cb); |
||||
this._socket.uncork(); |
||||
} else { |
||||
this._socket.write(list[0], cb); |
||||
} |
||||
} |
||||
} |
||||
|
||||
module.exports = Sender; |
||||
@ -0,0 +1,164 @@
|
||||
'use strict'; |
||||
|
||||
const { Duplex } = require('stream'); |
||||
|
||||
/** |
||||
* Emits the `'close'` event on a stream. |
||||
* |
||||
* @param {stream.Duplex} The stream. |
||||
* @private |
||||
*/ |
||||
function emitClose(stream) { |
||||
stream.emit('close'); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `'end'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function duplexOnEnd() { |
||||
if (!this.destroyed && this._writableState.finished) { |
||||
this.destroy(); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `'error'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function duplexOnError(err) { |
||||
this.removeListener('error', duplexOnError); |
||||
this.destroy(); |
||||
if (this.listenerCount('error') === 0) { |
||||
// Do not suppress the throwing behavior.
|
||||
this.emit('error', err); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Wraps a `WebSocket` in a duplex stream. |
||||
* |
||||
* @param {WebSocket} ws The `WebSocket` to wrap |
||||
* @param {Object} options The options for the `Duplex` constructor |
||||
* @return {stream.Duplex} The duplex stream |
||||
* @public |
||||
*/ |
||||
function createWebSocketStream(ws, options) { |
||||
let resumeOnReceiverDrain = true; |
||||
|
||||
function receiverOnDrain() { |
||||
if (resumeOnReceiverDrain) ws._socket.resume(); |
||||
} |
||||
|
||||
if (ws.readyState === ws.CONNECTING) { |
||||
ws.once('open', function open() { |
||||
ws._receiver.removeAllListeners('drain'); |
||||
ws._receiver.on('drain', receiverOnDrain); |
||||
}); |
||||
} else { |
||||
ws._receiver.removeAllListeners('drain'); |
||||
ws._receiver.on('drain', receiverOnDrain); |
||||
} |
||||
|
||||
const duplex = new Duplex({ |
||||
...options, |
||||
autoDestroy: false, |
||||
emitClose: false, |
||||
objectMode: false, |
||||
writableObjectMode: false |
||||
}); |
||||
|
||||
ws.on('message', function message(msg) { |
||||
if (!duplex.push(msg)) { |
||||
resumeOnReceiverDrain = false; |
||||
ws._socket.pause(); |
||||
} |
||||
}); |
||||
|
||||
ws.once('error', function error(err) { |
||||
if (duplex.destroyed) return; |
||||
|
||||
duplex.destroy(err); |
||||
}); |
||||
|
||||
ws.once('close', function close() { |
||||
if (duplex.destroyed) return; |
||||
|
||||
duplex.push(null); |
||||
}); |
||||
|
||||
duplex._destroy = function (err, callback) { |
||||
if (ws.readyState === ws.CLOSED) { |
||||
callback(err); |
||||
process.nextTick(emitClose, duplex); |
||||
return; |
||||
} |
||||
|
||||
let called = false; |
||||
|
||||
ws.once('error', function error(err) { |
||||
called = true; |
||||
callback(err); |
||||
}); |
||||
|
||||
ws.once('close', function close() { |
||||
if (!called) callback(err); |
||||
process.nextTick(emitClose, duplex); |
||||
}); |
||||
ws.terminate(); |
||||
}; |
||||
|
||||
duplex._final = function (callback) { |
||||
if (ws.readyState === ws.CONNECTING) { |
||||
ws.once('open', function open() { |
||||
duplex._final(callback); |
||||
}); |
||||
return; |
||||
} |
||||
|
||||
// If the value of the `_socket` property is `null` it means that `ws` is a
|
||||
// client websocket and the handshake failed. In fact, when this happens, a
|
||||
// socket is never assigned to the websocket. Wait for the `'error'` event
|
||||
// that will be emitted by the websocket.
|
||||
if (ws._socket === null) return; |
||||
|
||||
if (ws._socket._writableState.finished) { |
||||
callback(); |
||||
if (duplex._readableState.endEmitted) duplex.destroy(); |
||||
} else { |
||||
ws._socket.once('finish', function finish() { |
||||
// `duplex` is not destroyed here because the `'end'` event will be
|
||||
// emitted on `duplex` after this `'finish'` event. The EOF signaling
|
||||
// `null` chunk is, in fact, pushed when the websocket emits `'close'`.
|
||||
callback(); |
||||
}); |
||||
ws.close(); |
||||
} |
||||
}; |
||||
|
||||
duplex._read = function () { |
||||
if (ws.readyState === ws.OPEN && !resumeOnReceiverDrain) { |
||||
resumeOnReceiverDrain = true; |
||||
if (!ws._receiver._writableState.needDrain) ws._socket.resume(); |
||||
} |
||||
}; |
||||
|
||||
duplex._write = function (chunk, encoding, callback) { |
||||
if (ws.readyState === ws.CONNECTING) { |
||||
ws.once('open', function open() { |
||||
duplex._write(chunk, encoding, callback); |
||||
}); |
||||
return; |
||||
} |
||||
|
||||
ws.send(chunk, callback); |
||||
}; |
||||
|
||||
duplex.on('end', duplexOnEnd); |
||||
duplex.on('error', duplexOnError); |
||||
return duplex; |
||||
} |
||||
|
||||
module.exports = createWebSocketStream; |
||||
@ -0,0 +1,30 @@
|
||||
'use strict'; |
||||
|
||||
try { |
||||
const isValidUTF8 = require('utf-8-validate'); |
||||
|
||||
exports.isValidUTF8 = |
||||
typeof isValidUTF8 === 'object' |
||||
? isValidUTF8.Validation.isValidUTF8 // utf-8-validate@<3.0.0
|
||||
: isValidUTF8; |
||||
} catch (e) /* istanbul ignore next */ { |
||||
exports.isValidUTF8 = () => true; |
||||
} |
||||
|
||||
/** |
||||
* Checks if a status code is allowed in a close frame. |
||||
* |
||||
* @param {Number} code The status code |
||||
* @return {Boolean} `true` if the status code is valid, else `false` |
||||
* @public |
||||
*/ |
||||
exports.isValidStatusCode = (code) => { |
||||
return ( |
||||
(code >= 1000 && |
||||
code <= 1014 && |
||||
code !== 1004 && |
||||
code !== 1005 && |
||||
code !== 1006) || |
||||
(code >= 3000 && code <= 4999) |
||||
); |
||||
}; |
||||
@ -0,0 +1,404 @@
|
||||
'use strict'; |
||||
|
||||
const EventEmitter = require('events'); |
||||
const { createHash } = require('crypto'); |
||||
const { createServer, STATUS_CODES } = require('http'); |
||||
|
||||
const PerMessageDeflate = require('./permessage-deflate'); |
||||
const WebSocket = require('./websocket'); |
||||
const { format, parse } = require('./extension'); |
||||
const { GUID, kWebSocket } = require('./constants'); |
||||
|
||||
const keyRegex = /^[+/0-9A-Za-z]{22}==$/; |
||||
|
||||
/** |
||||
* Class representing a WebSocket server. |
||||
* |
||||
* @extends EventEmitter |
||||
*/ |
||||
class WebSocketServer extends EventEmitter { |
||||
/** |
||||
* Create a `WebSocketServer` instance. |
||||
* |
||||
* @param {Object} options Configuration options |
||||
* @param {Number} options.backlog The maximum length of the queue of pending |
||||
* connections |
||||
* @param {Boolean} options.clientTracking Specifies whether or not to track |
||||
* clients |
||||
* @param {Function} options.handleProtocols A hook to handle protocols |
||||
* @param {String} options.host The hostname where to bind the server |
||||
* @param {Number} options.maxPayload The maximum allowed message size |
||||
* @param {Boolean} options.noServer Enable no server mode |
||||
* @param {String} options.path Accept only connections matching this path |
||||
* @param {(Boolean|Object)} options.perMessageDeflate Enable/disable |
||||
* permessage-deflate |
||||
* @param {Number} options.port The port where to bind the server |
||||
* @param {http.Server} options.server A pre-created HTTP/S server to use |
||||
* @param {Function} options.verifyClient A hook to reject connections |
||||
* @param {Function} callback A listener for the `listening` event |
||||
*/ |
||||
constructor(options, callback) { |
||||
super(); |
||||
|
||||
options = { |
||||
maxPayload: 100 * 1024 * 1024, |
||||
perMessageDeflate: false, |
||||
handleProtocols: null, |
||||
clientTracking: true, |
||||
verifyClient: null, |
||||
noServer: false, |
||||
backlog: null, // use default (511 as implemented in net.js)
|
||||
server: null, |
||||
host: null, |
||||
path: null, |
||||
port: null, |
||||
...options |
||||
}; |
||||
|
||||
if (options.port == null && !options.server && !options.noServer) { |
||||
throw new TypeError( |
||||
'One of the "port", "server", or "noServer" options must be specified' |
||||
); |
||||
} |
||||
|
||||
if (options.port != null) { |
||||
this._server = createServer((req, res) => { |
||||
const body = STATUS_CODES[426]; |
||||
|
||||
res.writeHead(426, { |
||||
'Content-Length': body.length, |
||||
'Content-Type': 'text/plain' |
||||
}); |
||||
res.end(body); |
||||
}); |
||||
this._server.listen( |
||||
options.port, |
||||
options.host, |
||||
options.backlog, |
||||
callback |
||||
); |
||||
} else if (options.server) { |
||||
this._server = options.server; |
||||
} |
||||
|
||||
if (this._server) { |
||||
this._removeListeners = addListeners(this._server, { |
||||
listening: this.emit.bind(this, 'listening'), |
||||
error: this.emit.bind(this, 'error'), |
||||
upgrade: (req, socket, head) => { |
||||
this.handleUpgrade(req, socket, head, (ws) => { |
||||
this.emit('connection', ws, req); |
||||
}); |
||||
} |
||||
}); |
||||
} |
||||
|
||||
if (options.perMessageDeflate === true) options.perMessageDeflate = {}; |
||||
if (options.clientTracking) this.clients = new Set(); |
||||
this.options = options; |
||||
} |
||||
|
||||
/** |
||||
* Returns the bound address, the address family name, and port of the server |
||||
* as reported by the operating system if listening on an IP socket. |
||||
* If the server is listening on a pipe or UNIX domain socket, the name is |
||||
* returned as a string. |
||||
* |
||||
* @return {(Object|String|null)} The address of the server |
||||
* @public |
||||
*/ |
||||
address() { |
||||
if (this.options.noServer) { |
||||
throw new Error('The server is operating in "noServer" mode'); |
||||
} |
||||
|
||||
if (!this._server) return null; |
||||
return this._server.address(); |
||||
} |
||||
|
||||
/** |
||||
* Close the server. |
||||
* |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
close(cb) { |
||||
if (cb) this.once('close', cb); |
||||
|
||||
//
|
||||
// Terminate all associated clients.
|
||||
//
|
||||
if (this.clients) { |
||||
for (const client of this.clients) client.terminate(); |
||||
} |
||||
|
||||
const server = this._server; |
||||
|
||||
if (server) { |
||||
this._removeListeners(); |
||||
this._removeListeners = this._server = null; |
||||
|
||||
//
|
||||
// Close the http server if it was internally created.
|
||||
//
|
||||
if (this.options.port != null) { |
||||
server.close(() => this.emit('close')); |
||||
return; |
||||
} |
||||
} |
||||
|
||||
process.nextTick(emitClose, this); |
||||
} |
||||
|
||||
/** |
||||
* See if a given request should be handled by this server instance. |
||||
* |
||||
* @param {http.IncomingMessage} req Request object to inspect |
||||
* @return {Boolean} `true` if the request is valid, else `false` |
||||
* @public |
||||
*/ |
||||
shouldHandle(req) { |
||||
if (this.options.path) { |
||||
const index = req.url.indexOf('?'); |
||||
const pathname = index !== -1 ? req.url.slice(0, index) : req.url; |
||||
|
||||
if (pathname !== this.options.path) return false; |
||||
} |
||||
|
||||
return true; |
||||
} |
||||
|
||||
/** |
||||
* Handle a HTTP Upgrade request. |
||||
* |
||||
* @param {http.IncomingMessage} req The request object |
||||
* @param {net.Socket} socket The network socket between the server and client |
||||
* @param {Buffer} head The first packet of the upgraded stream |
||||
* @param {Function} cb Callback |
||||
* @public |
||||
*/ |
||||
handleUpgrade(req, socket, head, cb) { |
||||
socket.on('error', socketOnError); |
||||
|
||||
const key = |
||||
req.headers['sec-websocket-key'] !== undefined |
||||
? req.headers['sec-websocket-key'].trim() |
||||
: false; |
||||
const version = +req.headers['sec-websocket-version']; |
||||
const extensions = {}; |
||||
|
||||
if ( |
||||
req.method !== 'GET' || |
||||
req.headers.upgrade.toLowerCase() !== 'websocket' || |
||||
!key || |
||||
!keyRegex.test(key) || |
||||
(version !== 8 && version !== 13) || |
||||
!this.shouldHandle(req) |
||||
) { |
||||
return abortHandshake(socket, 400); |
||||
} |
||||
|
||||
if (this.options.perMessageDeflate) { |
||||
const perMessageDeflate = new PerMessageDeflate( |
||||
this.options.perMessageDeflate, |
||||
true, |
||||
this.options.maxPayload |
||||
); |
||||
|
||||
try { |
||||
const offers = parse(req.headers['sec-websocket-extensions']); |
||||
|
||||
if (offers[PerMessageDeflate.extensionName]) { |
||||
perMessageDeflate.accept(offers[PerMessageDeflate.extensionName]); |
||||
extensions[PerMessageDeflate.extensionName] = perMessageDeflate; |
||||
} |
||||
} catch (err) { |
||||
return abortHandshake(socket, 400); |
||||
} |
||||
} |
||||
|
||||
//
|
||||
// Optionally call external client verification handler.
|
||||
//
|
||||
if (this.options.verifyClient) { |
||||
const info = { |
||||
origin: |
||||
req.headers[`${version === 8 ? 'sec-websocket-origin' : 'origin'}`], |
||||
secure: !!(req.connection.authorized || req.connection.encrypted), |
||||
req |
||||
}; |
||||
|
||||
if (this.options.verifyClient.length === 2) { |
||||
this.options.verifyClient(info, (verified, code, message, headers) => { |
||||
if (!verified) { |
||||
return abortHandshake(socket, code || 401, message, headers); |
||||
} |
||||
|
||||
this.completeUpgrade(key, extensions, req, socket, head, cb); |
||||
}); |
||||
return; |
||||
} |
||||
|
||||
if (!this.options.verifyClient(info)) return abortHandshake(socket, 401); |
||||
} |
||||
|
||||
this.completeUpgrade(key, extensions, req, socket, head, cb); |
||||
} |
||||
|
||||
/** |
||||
* Upgrade the connection to WebSocket. |
||||
* |
||||
* @param {String} key The value of the `Sec-WebSocket-Key` header |
||||
* @param {Object} extensions The accepted extensions |
||||
* @param {http.IncomingMessage} req The request object |
||||
* @param {net.Socket} socket The network socket between the server and client |
||||
* @param {Buffer} head The first packet of the upgraded stream |
||||
* @param {Function} cb Callback |
||||
* @throws {Error} If called more than once with the same socket |
||||
* @private |
||||
*/ |
||||
completeUpgrade(key, extensions, req, socket, head, cb) { |
||||
//
|
||||
// Destroy the socket if the client has already sent a FIN packet.
|
||||
//
|
||||
if (!socket.readable || !socket.writable) return socket.destroy(); |
||||
|
||||
if (socket[kWebSocket]) { |
||||
throw new Error( |
||||
'server.handleUpgrade() was called more than once with the same ' + |
||||
'socket, possibly due to a misconfiguration' |
||||
); |
||||
} |
||||
|
||||
const digest = createHash('sha1') |
||||
.update(key + GUID) |
||||
.digest('base64'); |
||||
|
||||
const headers = [ |
||||
'HTTP/1.1 101 Switching Protocols', |
||||
'Upgrade: websocket', |
||||
'Connection: Upgrade', |
||||
`Sec-WebSocket-Accept: ${digest}` |
||||
]; |
||||
|
||||
const ws = new WebSocket(null); |
||||
let protocol = req.headers['sec-websocket-protocol']; |
||||
|
||||
if (protocol) { |
||||
protocol = protocol.trim().split(/ *, */); |
||||
|
||||
//
|
||||
// Optionally call external protocol selection handler.
|
||||
//
|
||||
if (this.options.handleProtocols) { |
||||
protocol = this.options.handleProtocols(protocol, req); |
||||
} else { |
||||
protocol = protocol[0]; |
||||
} |
||||
|
||||
if (protocol) { |
||||
headers.push(`Sec-WebSocket-Protocol: ${protocol}`); |
||||
ws.protocol = protocol; |
||||
} |
||||
} |
||||
|
||||
if (extensions[PerMessageDeflate.extensionName]) { |
||||
const params = extensions[PerMessageDeflate.extensionName].params; |
||||
const value = format({ |
||||
[PerMessageDeflate.extensionName]: [params] |
||||
}); |
||||
headers.push(`Sec-WebSocket-Extensions: ${value}`); |
||||
ws._extensions = extensions; |
||||
} |
||||
|
||||
//
|
||||
// Allow external modification/inspection of handshake headers.
|
||||
//
|
||||
this.emit('headers', headers, req); |
||||
|
||||
socket.write(headers.concat('\r\n').join('\r\n')); |
||||
socket.removeListener('error', socketOnError); |
||||
|
||||
ws.setSocket(socket, head, this.options.maxPayload); |
||||
|
||||
if (this.clients) { |
||||
this.clients.add(ws); |
||||
ws.on('close', () => this.clients.delete(ws)); |
||||
} |
||||
|
||||
cb(ws); |
||||
} |
||||
} |
||||
|
||||
module.exports = WebSocketServer; |
||||
|
||||
/** |
||||
* Add event listeners on an `EventEmitter` using a map of <event, listener> |
||||
* pairs. |
||||
* |
||||
* @param {EventEmitter} server The event emitter |
||||
* @param {Object.<String, Function>} map The listeners to add |
||||
* @return {Function} A function that will remove the added listeners when called |
||||
* @private |
||||
*/ |
||||
function addListeners(server, map) { |
||||
for (const event of Object.keys(map)) server.on(event, map[event]); |
||||
|
||||
return function removeListeners() { |
||||
for (const event of Object.keys(map)) { |
||||
server.removeListener(event, map[event]); |
||||
} |
||||
}; |
||||
} |
||||
|
||||
/** |
||||
* Emit a `'close'` event on an `EventEmitter`. |
||||
* |
||||
* @param {EventEmitter} server The event emitter |
||||
* @private |
||||
*/ |
||||
function emitClose(server) { |
||||
server.emit('close'); |
||||
} |
||||
|
||||
/** |
||||
* Handle premature socket errors. |
||||
* |
||||
* @private |
||||
*/ |
||||
function socketOnError() { |
||||
this.destroy(); |
||||
} |
||||
|
||||
/** |
||||
* Close the connection when preconditions are not fulfilled. |
||||
* |
||||
* @param {net.Socket} socket The socket of the upgrade request |
||||
* @param {Number} code The HTTP response status code |
||||
* @param {String} [message] The HTTP response body |
||||
* @param {Object} [headers] Additional HTTP response headers |
||||
* @private |
||||
*/ |
||||
function abortHandshake(socket, code, message, headers) { |
||||
if (socket.writable) { |
||||
message = message || STATUS_CODES[code]; |
||||
headers = { |
||||
Connection: 'close', |
||||
'Content-Type': 'text/html', |
||||
'Content-Length': Buffer.byteLength(message), |
||||
...headers |
||||
}; |
||||
|
||||
socket.write( |
||||
`HTTP/1.1 ${code} ${STATUS_CODES[code]}\r\n` + |
||||
Object.keys(headers) |
||||
.map((h) => `${h}: ${headers[h]}`) |
||||
.join('\r\n') + |
||||
'\r\n\r\n' + |
||||
message |
||||
); |
||||
} |
||||
|
||||
socket.removeListener('error', socketOnError); |
||||
socket.destroy(); |
||||
} |
||||
@ -0,0 +1,905 @@
|
||||
'use strict'; |
||||
|
||||
const EventEmitter = require('events'); |
||||
const https = require('https'); |
||||
const http = require('http'); |
||||
const net = require('net'); |
||||
const tls = require('tls'); |
||||
const { randomBytes, createHash } = require('crypto'); |
||||
const { URL } = require('url'); |
||||
|
||||
const PerMessageDeflate = require('./permessage-deflate'); |
||||
const Receiver = require('./receiver'); |
||||
const Sender = require('./sender'); |
||||
const { |
||||
BINARY_TYPES, |
||||
EMPTY_BUFFER, |
||||
GUID, |
||||
kStatusCode, |
||||
kWebSocket, |
||||
NOOP |
||||
} = require('./constants'); |
||||
const { addEventListener, removeEventListener } = require('./event-target'); |
||||
const { format, parse } = require('./extension'); |
||||
const { toBuffer } = require('./buffer-util'); |
||||
|
||||
const readyStates = ['CONNECTING', 'OPEN', 'CLOSING', 'CLOSED']; |
||||
const protocolVersions = [8, 13]; |
||||
const closeTimeout = 30 * 1000; |
||||
|
||||
/** |
||||
* Class representing a WebSocket. |
||||
* |
||||
* @extends EventEmitter |
||||
*/ |
||||
class WebSocket extends EventEmitter { |
||||
/** |
||||
* Create a new `WebSocket`. |
||||
* |
||||
* @param {(String|url.URL)} address The URL to which to connect |
||||
* @param {(String|String[])} protocols The subprotocols |
||||
* @param {Object} options Connection options |
||||
*/ |
||||
constructor(address, protocols, options) { |
||||
super(); |
||||
|
||||
this.readyState = WebSocket.CONNECTING; |
||||
this.protocol = ''; |
||||
|
||||
this._binaryType = BINARY_TYPES[0]; |
||||
this._closeFrameReceived = false; |
||||
this._closeFrameSent = false; |
||||
this._closeMessage = ''; |
||||
this._closeTimer = null; |
||||
this._closeCode = 1006; |
||||
this._extensions = {}; |
||||
this._receiver = null; |
||||
this._sender = null; |
||||
this._socket = null; |
||||
|
||||
if (address !== null) { |
||||
this._bufferedAmount = 0; |
||||
this._isServer = false; |
||||
this._redirects = 0; |
||||
|
||||
if (Array.isArray(protocols)) { |
||||
protocols = protocols.join(', '); |
||||
} else if (typeof protocols === 'object' && protocols !== null) { |
||||
options = protocols; |
||||
protocols = undefined; |
||||
} |
||||
|
||||
initAsClient(this, address, protocols, options); |
||||
} else { |
||||
this._isServer = true; |
||||
} |
||||
} |
||||
|
||||
get CONNECTING() { |
||||
return WebSocket.CONNECTING; |
||||
} |
||||
get CLOSING() { |
||||
return WebSocket.CLOSING; |
||||
} |
||||
get CLOSED() { |
||||
return WebSocket.CLOSED; |
||||
} |
||||
get OPEN() { |
||||
return WebSocket.OPEN; |
||||
} |
||||
|
||||
/** |
||||
* This deviates from the WHATWG interface since ws doesn't support the |
||||
* required default "blob" type (instead we define a custom "nodebuffer" |
||||
* type). |
||||
* |
||||
* @type {String} |
||||
*/ |
||||
get binaryType() { |
||||
return this._binaryType; |
||||
} |
||||
|
||||
set binaryType(type) { |
||||
if (!BINARY_TYPES.includes(type)) return; |
||||
|
||||
this._binaryType = type; |
||||
|
||||
//
|
||||
// Allow to change `binaryType` on the fly.
|
||||
//
|
||||
if (this._receiver) this._receiver._binaryType = type; |
||||
} |
||||
|
||||
/** |
||||
* @type {Number} |
||||
*/ |
||||
get bufferedAmount() { |
||||
if (!this._socket) return this._bufferedAmount; |
||||
|
||||
return this._socket._writableState.length + this._sender._bufferedBytes; |
||||
} |
||||
|
||||
/** |
||||
* @type {String} |
||||
*/ |
||||
get extensions() { |
||||
return Object.keys(this._extensions).join(); |
||||
} |
||||
|
||||
/** |
||||
* Set up the socket and the internal resources. |
||||
* |
||||
* @param {net.Socket} socket The network socket between the server and client |
||||
* @param {Buffer} head The first packet of the upgraded stream |
||||
* @param {Number} maxPayload The maximum allowed message size |
||||
* @private |
||||
*/ |
||||
setSocket(socket, head, maxPayload) { |
||||
const receiver = new Receiver( |
||||
this._binaryType, |
||||
this._extensions, |
||||
this._isServer, |
||||
maxPayload |
||||
); |
||||
|
||||
this._sender = new Sender(socket, this._extensions); |
||||
this._receiver = receiver; |
||||
this._socket = socket; |
||||
|
||||
receiver[kWebSocket] = this; |
||||
socket[kWebSocket] = this; |
||||
|
||||
receiver.on('conclude', receiverOnConclude); |
||||
receiver.on('drain', receiverOnDrain); |
||||
receiver.on('error', receiverOnError); |
||||
receiver.on('message', receiverOnMessage); |
||||
receiver.on('ping', receiverOnPing); |
||||
receiver.on('pong', receiverOnPong); |
||||
|
||||
socket.setTimeout(0); |
||||
socket.setNoDelay(); |
||||
|
||||
if (head.length > 0) socket.unshift(head); |
||||
|
||||
socket.on('close', socketOnClose); |
||||
socket.on('data', socketOnData); |
||||
socket.on('end', socketOnEnd); |
||||
socket.on('error', socketOnError); |
||||
|
||||
this.readyState = WebSocket.OPEN; |
||||
this.emit('open'); |
||||
} |
||||
|
||||
/** |
||||
* Emit the `'close'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
emitClose() { |
||||
if (!this._socket) { |
||||
this.readyState = WebSocket.CLOSED; |
||||
this.emit('close', this._closeCode, this._closeMessage); |
||||
return; |
||||
} |
||||
|
||||
if (this._extensions[PerMessageDeflate.extensionName]) { |
||||
this._extensions[PerMessageDeflate.extensionName].cleanup(); |
||||
} |
||||
|
||||
this._receiver.removeAllListeners(); |
||||
this.readyState = WebSocket.CLOSED; |
||||
this.emit('close', this._closeCode, this._closeMessage); |
||||
} |
||||
|
||||
/** |
||||
* Start a closing handshake. |
||||
* |
||||
* +----------+ +-----------+ +----------+ |
||||
* - - -|ws.close()|-->|close frame|-->|ws.close()|- - - |
||||
* | +----------+ +-----------+ +----------+ | |
||||
* +----------+ +-----------+ | |
||||
* CLOSING |ws.close()|<--|close frame|<--+-----+ CLOSING |
||||
* +----------+ +-----------+ | |
||||
* | | | +---+ | |
||||
* +------------------------+-->|fin| - - - - |
||||
* | +---+ | +---+ |
||||
* - - - - -|fin|<---------------------+ |
||||
* +---+ |
||||
* |
||||
* @param {Number} code Status code explaining why the connection is closing |
||||
* @param {String} data A string explaining why the connection is closing |
||||
* @public |
||||
*/ |
||||
close(code, data) { |
||||
if (this.readyState === WebSocket.CLOSED) return; |
||||
if (this.readyState === WebSocket.CONNECTING) { |
||||
const msg = 'WebSocket was closed before the connection was established'; |
||||
return abortHandshake(this, this._req, msg); |
||||
} |
||||
|
||||
if (this.readyState === WebSocket.CLOSING) { |
||||
if (this._closeFrameSent && this._closeFrameReceived) this._socket.end(); |
||||
return; |
||||
} |
||||
|
||||
this.readyState = WebSocket.CLOSING; |
||||
this._sender.close(code, data, !this._isServer, (err) => { |
||||
//
|
||||
// This error is handled by the `'error'` listener on the socket. We only
|
||||
// want to know if the close frame has been sent here.
|
||||
//
|
||||
if (err) return; |
||||
|
||||
this._closeFrameSent = true; |
||||
if (this._closeFrameReceived) this._socket.end(); |
||||
}); |
||||
|
||||
//
|
||||
// Specify a timeout for the closing handshake to complete.
|
||||
//
|
||||
this._closeTimer = setTimeout( |
||||
this._socket.destroy.bind(this._socket), |
||||
closeTimeout |
||||
); |
||||
} |
||||
|
||||
/** |
||||
* Send a ping. |
||||
* |
||||
* @param {*} data The data to send |
||||
* @param {Boolean} mask Indicates whether or not to mask `data` |
||||
* @param {Function} cb Callback which is executed when the ping is sent |
||||
* @public |
||||
*/ |
||||
ping(data, mask, cb) { |
||||
if (this.readyState === WebSocket.CONNECTING) { |
||||
throw new Error('WebSocket is not open: readyState 0 (CONNECTING)'); |
||||
} |
||||
|
||||
if (typeof data === 'function') { |
||||
cb = data; |
||||
data = mask = undefined; |
||||
} else if (typeof mask === 'function') { |
||||
cb = mask; |
||||
mask = undefined; |
||||
} |
||||
|
||||
if (typeof data === 'number') data = data.toString(); |
||||
|
||||
if (this.readyState !== WebSocket.OPEN) { |
||||
sendAfterClose(this, data, cb); |
||||
return; |
||||
} |
||||
|
||||
if (mask === undefined) mask = !this._isServer; |
||||
this._sender.ping(data || EMPTY_BUFFER, mask, cb); |
||||
} |
||||
|
||||
/** |
||||
* Send a pong. |
||||
* |
||||
* @param {*} data The data to send |
||||
* @param {Boolean} mask Indicates whether or not to mask `data` |
||||
* @param {Function} cb Callback which is executed when the pong is sent |
||||
* @public |
||||
*/ |
||||
pong(data, mask, cb) { |
||||
if (this.readyState === WebSocket.CONNECTING) { |
||||
throw new Error('WebSocket is not open: readyState 0 (CONNECTING)'); |
||||
} |
||||
|
||||
if (typeof data === 'function') { |
||||
cb = data; |
||||
data = mask = undefined; |
||||
} else if (typeof mask === 'function') { |
||||
cb = mask; |
||||
mask = undefined; |
||||
} |
||||
|
||||
if (typeof data === 'number') data = data.toString(); |
||||
|
||||
if (this.readyState !== WebSocket.OPEN) { |
||||
sendAfterClose(this, data, cb); |
||||
return; |
||||
} |
||||
|
||||
if (mask === undefined) mask = !this._isServer; |
||||
this._sender.pong(data || EMPTY_BUFFER, mask, cb); |
||||
} |
||||
|
||||
/** |
||||
* Send a data message. |
||||
* |
||||
* @param {*} data The message to send |
||||
* @param {Object} options Options object |
||||
* @param {Boolean} options.compress Specifies whether or not to compress |
||||
* `data` |
||||
* @param {Boolean} options.binary Specifies whether `data` is binary or text |
||||
* @param {Boolean} options.fin Specifies whether the fragment is the last one |
||||
* @param {Boolean} options.mask Specifies whether or not to mask `data` |
||||
* @param {Function} cb Callback which is executed when data is written out |
||||
* @public |
||||
*/ |
||||
send(data, options, cb) { |
||||
if (this.readyState === WebSocket.CONNECTING) { |
||||
throw new Error('WebSocket is not open: readyState 0 (CONNECTING)'); |
||||
} |
||||
|
||||
if (typeof options === 'function') { |
||||
cb = options; |
||||
options = {}; |
||||
} |
||||
|
||||
if (typeof data === 'number') data = data.toString(); |
||||
|
||||
if (this.readyState !== WebSocket.OPEN) { |
||||
sendAfterClose(this, data, cb); |
||||
return; |
||||
} |
||||
|
||||
const opts = { |
||||
binary: typeof data !== 'string', |
||||
mask: !this._isServer, |
||||
compress: true, |
||||
fin: true, |
||||
...options |
||||
}; |
||||
|
||||
if (!this._extensions[PerMessageDeflate.extensionName]) { |
||||
opts.compress = false; |
||||
} |
||||
|
||||
this._sender.send(data || EMPTY_BUFFER, opts, cb); |
||||
} |
||||
|
||||
/** |
||||
* Forcibly close the connection. |
||||
* |
||||
* @public |
||||
*/ |
||||
terminate() { |
||||
if (this.readyState === WebSocket.CLOSED) return; |
||||
if (this.readyState === WebSocket.CONNECTING) { |
||||
const msg = 'WebSocket was closed before the connection was established'; |
||||
return abortHandshake(this, this._req, msg); |
||||
} |
||||
|
||||
if (this._socket) { |
||||
this.readyState = WebSocket.CLOSING; |
||||
this._socket.destroy(); |
||||
} |
||||
} |
||||
} |
||||
|
||||
readyStates.forEach((readyState, i) => { |
||||
WebSocket[readyState] = i; |
||||
}); |
||||
|
||||
//
|
||||
// Add the `onopen`, `onerror`, `onclose`, and `onmessage` attributes.
|
||||
// See https://html.spec.whatwg.org/multipage/comms.html#the-websocket-interface
|
||||
//
|
||||
['open', 'error', 'close', 'message'].forEach((method) => { |
||||
Object.defineProperty(WebSocket.prototype, `on${method}`, { |
||||
/** |
||||
* Return the listener of the event. |
||||
* |
||||
* @return {(Function|undefined)} The event listener or `undefined` |
||||
* @public |
||||
*/ |
||||
get() { |
||||
const listeners = this.listeners(method); |
||||
for (let i = 0; i < listeners.length; i++) { |
||||
if (listeners[i]._listener) return listeners[i]._listener; |
||||
} |
||||
|
||||
return undefined; |
||||
}, |
||||
/** |
||||
* Add a listener for the event. |
||||
* |
||||
* @param {Function} listener The listener to add |
||||
* @public |
||||
*/ |
||||
set(listener) { |
||||
const listeners = this.listeners(method); |
||||
for (let i = 0; i < listeners.length; i++) { |
||||
//
|
||||
// Remove only the listeners added via `addEventListener`.
|
||||
//
|
||||
if (listeners[i]._listener) this.removeListener(method, listeners[i]); |
||||
} |
||||
this.addEventListener(method, listener); |
||||
} |
||||
}); |
||||
}); |
||||
|
||||
WebSocket.prototype.addEventListener = addEventListener; |
||||
WebSocket.prototype.removeEventListener = removeEventListener; |
||||
|
||||
module.exports = WebSocket; |
||||
|
||||
/** |
||||
* Initialize a WebSocket client. |
||||
* |
||||
* @param {WebSocket} websocket The client to initialize |
||||
* @param {(String|url.URL)} address The URL to which to connect |
||||
* @param {String} protocols The subprotocols |
||||
* @param {Object} options Connection options |
||||
* @param {(Boolean|Object)} options.perMessageDeflate Enable/disable |
||||
* permessage-deflate |
||||
* @param {Number} options.handshakeTimeout Timeout in milliseconds for the |
||||
* handshake request |
||||
* @param {Number} options.protocolVersion Value of the `Sec-WebSocket-Version` |
||||
* header |
||||
* @param {String} options.origin Value of the `Origin` or |
||||
* `Sec-WebSocket-Origin` header |
||||
* @param {Number} options.maxPayload The maximum allowed message size |
||||
* @param {Boolean} options.followRedirects Whether or not to follow redirects |
||||
* @param {Number} options.maxRedirects The maximum number of redirects allowed |
||||
* @private |
||||
*/ |
||||
function initAsClient(websocket, address, protocols, options) { |
||||
const opts = { |
||||
protocolVersion: protocolVersions[1], |
||||
maxPayload: 100 * 1024 * 1024, |
||||
perMessageDeflate: true, |
||||
followRedirects: false, |
||||
maxRedirects: 10, |
||||
...options, |
||||
createConnection: undefined, |
||||
socketPath: undefined, |
||||
hostname: undefined, |
||||
protocol: undefined, |
||||
timeout: undefined, |
||||
method: undefined, |
||||
host: undefined, |
||||
path: undefined, |
||||
port: undefined |
||||
}; |
||||
|
||||
if (!protocolVersions.includes(opts.protocolVersion)) { |
||||
throw new RangeError( |
||||
`Unsupported protocol version: ${opts.protocolVersion} ` + |
||||
`(supported versions: ${protocolVersions.join(', ')})` |
||||
); |
||||
} |
||||
|
||||
let parsedUrl; |
||||
|
||||
if (address instanceof URL) { |
||||
parsedUrl = address; |
||||
websocket.url = address.href; |
||||
} else { |
||||
parsedUrl = new URL(address); |
||||
websocket.url = address; |
||||
} |
||||
|
||||
const isUnixSocket = parsedUrl.protocol === 'ws+unix:'; |
||||
|
||||
if (!parsedUrl.host && (!isUnixSocket || !parsedUrl.pathname)) { |
||||
throw new Error(`Invalid URL: ${websocket.url}`); |
||||
} |
||||
|
||||
const isSecure = |
||||
parsedUrl.protocol === 'wss:' || parsedUrl.protocol === 'https:'; |
||||
const defaultPort = isSecure ? 443 : 80; |
||||
const key = randomBytes(16).toString('base64'); |
||||
const get = isSecure ? https.get : http.get; |
||||
let perMessageDeflate; |
||||
|
||||
opts.createConnection = isSecure ? tlsConnect : netConnect; |
||||
opts.defaultPort = opts.defaultPort || defaultPort; |
||||
opts.port = parsedUrl.port || defaultPort; |
||||
opts.host = parsedUrl.hostname.startsWith('[') |
||||
? parsedUrl.hostname.slice(1, -1) |
||||
: parsedUrl.hostname; |
||||
opts.headers = { |
||||
'Sec-WebSocket-Version': opts.protocolVersion, |
||||
'Sec-WebSocket-Key': key, |
||||
Connection: 'Upgrade', |
||||
Upgrade: 'websocket', |
||||
...opts.headers |
||||
}; |
||||
opts.path = parsedUrl.pathname + parsedUrl.search; |
||||
opts.timeout = opts.handshakeTimeout; |
||||
|
||||
if (opts.perMessageDeflate) { |
||||
perMessageDeflate = new PerMessageDeflate( |
||||
opts.perMessageDeflate !== true ? opts.perMessageDeflate : {}, |
||||
false, |
||||
opts.maxPayload |
||||
); |
||||
opts.headers['Sec-WebSocket-Extensions'] = format({ |
||||
[PerMessageDeflate.extensionName]: perMessageDeflate.offer() |
||||
}); |
||||
} |
||||
if (protocols) { |
||||
opts.headers['Sec-WebSocket-Protocol'] = protocols; |
||||
} |
||||
if (opts.origin) { |
||||
if (opts.protocolVersion < 13) { |
||||
opts.headers['Sec-WebSocket-Origin'] = opts.origin; |
||||
} else { |
||||
opts.headers.Origin = opts.origin; |
||||
} |
||||
} |
||||
if (parsedUrl.username || parsedUrl.password) { |
||||
opts.auth = `${parsedUrl.username}:${parsedUrl.password}`; |
||||
} |
||||
|
||||
if (isUnixSocket) { |
||||
const parts = opts.path.split(':'); |
||||
|
||||
opts.socketPath = parts[0]; |
||||
opts.path = parts[1]; |
||||
} |
||||
|
||||
let req = (websocket._req = get(opts)); |
||||
|
||||
if (opts.timeout) { |
||||
req.on('timeout', () => { |
||||
abortHandshake(websocket, req, 'Opening handshake has timed out'); |
||||
}); |
||||
} |
||||
|
||||
req.on('error', (err) => { |
||||
if (websocket._req.aborted) return; |
||||
|
||||
req = websocket._req = null; |
||||
websocket.readyState = WebSocket.CLOSING; |
||||
websocket.emit('error', err); |
||||
websocket.emitClose(); |
||||
}); |
||||
|
||||
req.on('response', (res) => { |
||||
const location = res.headers.location; |
||||
const statusCode = res.statusCode; |
||||
|
||||
if ( |
||||
location && |
||||
opts.followRedirects && |
||||
statusCode >= 300 && |
||||
statusCode < 400 |
||||
) { |
||||
if (++websocket._redirects > opts.maxRedirects) { |
||||
abortHandshake(websocket, req, 'Maximum redirects exceeded'); |
||||
return; |
||||
} |
||||
|
||||
req.abort(); |
||||
|
||||
const addr = new URL(location, address); |
||||
|
||||
initAsClient(websocket, addr, protocols, options); |
||||
} else if (!websocket.emit('unexpected-response', req, res)) { |
||||
abortHandshake( |
||||
websocket, |
||||
req, |
||||
`Unexpected server response: ${res.statusCode}` |
||||
); |
||||
} |
||||
}); |
||||
|
||||
req.on('upgrade', (res, socket, head) => { |
||||
websocket.emit('upgrade', res); |
||||
|
||||
//
|
||||
// The user may have closed the connection from a listener of the `upgrade`
|
||||
// event.
|
||||
//
|
||||
if (websocket.readyState !== WebSocket.CONNECTING) return; |
||||
|
||||
req = websocket._req = null; |
||||
|
||||
const digest = createHash('sha1') |
||||
.update(key + GUID) |
||||
.digest('base64'); |
||||
|
||||
if (res.headers['sec-websocket-accept'] !== digest) { |
||||
abortHandshake(websocket, socket, 'Invalid Sec-WebSocket-Accept header'); |
||||
return; |
||||
} |
||||
|
||||
const serverProt = res.headers['sec-websocket-protocol']; |
||||
const protList = (protocols || '').split(/, */); |
||||
let protError; |
||||
|
||||
if (!protocols && serverProt) { |
||||
protError = 'Server sent a subprotocol but none was requested'; |
||||
} else if (protocols && !serverProt) { |
||||
protError = 'Server sent no subprotocol'; |
||||
} else if (serverProt && !protList.includes(serverProt)) { |
||||
protError = 'Server sent an invalid subprotocol'; |
||||
} |
||||
|
||||
if (protError) { |
||||
abortHandshake(websocket, socket, protError); |
||||
return; |
||||
} |
||||
|
||||
if (serverProt) websocket.protocol = serverProt; |
||||
|
||||
if (perMessageDeflate) { |
||||
try { |
||||
const extensions = parse(res.headers['sec-websocket-extensions']); |
||||
|
||||
if (extensions[PerMessageDeflate.extensionName]) { |
||||
perMessageDeflate.accept(extensions[PerMessageDeflate.extensionName]); |
||||
websocket._extensions[ |
||||
PerMessageDeflate.extensionName |
||||
] = perMessageDeflate; |
||||
} |
||||
} catch (err) { |
||||
abortHandshake( |
||||
websocket, |
||||
socket, |
||||
'Invalid Sec-WebSocket-Extensions header' |
||||
); |
||||
return; |
||||
} |
||||
} |
||||
|
||||
websocket.setSocket(socket, head, opts.maxPayload); |
||||
}); |
||||
} |
||||
|
||||
/** |
||||
* Create a `net.Socket` and initiate a connection. |
||||
* |
||||
* @param {Object} options Connection options |
||||
* @return {net.Socket} The newly created socket used to start the connection |
||||
* @private |
||||
*/ |
||||
function netConnect(options) { |
||||
options.path = options.socketPath; |
||||
return net.connect(options); |
||||
} |
||||
|
||||
/** |
||||
* Create a `tls.TLSSocket` and initiate a connection. |
||||
* |
||||
* @param {Object} options Connection options |
||||
* @return {tls.TLSSocket} The newly created socket used to start the connection |
||||
* @private |
||||
*/ |
||||
function tlsConnect(options) { |
||||
options.path = undefined; |
||||
|
||||
if (!options.servername && options.servername !== '') { |
||||
options.servername = options.host; |
||||
} |
||||
|
||||
return tls.connect(options); |
||||
} |
||||
|
||||
/** |
||||
* Abort the handshake and emit an error. |
||||
* |
||||
* @param {WebSocket} websocket The WebSocket instance |
||||
* @param {(http.ClientRequest|net.Socket)} stream The request to abort or the |
||||
* socket to destroy |
||||
* @param {String} message The error message |
||||
* @private |
||||
*/ |
||||
function abortHandshake(websocket, stream, message) { |
||||
websocket.readyState = WebSocket.CLOSING; |
||||
|
||||
const err = new Error(message); |
||||
Error.captureStackTrace(err, abortHandshake); |
||||
|
||||
if (stream.setHeader) { |
||||
stream.abort(); |
||||
stream.once('abort', websocket.emitClose.bind(websocket)); |
||||
websocket.emit('error', err); |
||||
} else { |
||||
stream.destroy(err); |
||||
stream.once('error', websocket.emit.bind(websocket, 'error')); |
||||
stream.once('close', websocket.emitClose.bind(websocket)); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Handle cases where the `ping()`, `pong()`, or `send()` methods are called |
||||
* when the `readyState` attribute is `CLOSING` or `CLOSED`. |
||||
* |
||||
* @param {WebSocket} websocket The WebSocket instance |
||||
* @param {*} data The data to send |
||||
* @param {Function} cb Callback |
||||
* @private |
||||
*/ |
||||
function sendAfterClose(websocket, data, cb) { |
||||
if (data) { |
||||
const length = toBuffer(data).length; |
||||
|
||||
//
|
||||
// The `_bufferedAmount` property is used only when the peer is a client and
|
||||
// the opening handshake fails. Under these circumstances, in fact, the
|
||||
// `setSocket()` method is not called, so the `_socket` and `_sender`
|
||||
// properties are set to `null`.
|
||||
//
|
||||
if (websocket._socket) websocket._sender._bufferedBytes += length; |
||||
else websocket._bufferedAmount += length; |
||||
} |
||||
|
||||
if (cb) { |
||||
const err = new Error( |
||||
`WebSocket is not open: readyState ${websocket.readyState} ` + |
||||
`(${readyStates[websocket.readyState]})` |
||||
); |
||||
cb(err); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'conclude'` event. |
||||
* |
||||
* @param {Number} code The status code |
||||
* @param {String} reason The reason for closing |
||||
* @private |
||||
*/ |
||||
function receiverOnConclude(code, reason) { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
websocket._socket.removeListener('data', socketOnData); |
||||
websocket._socket.resume(); |
||||
|
||||
websocket._closeFrameReceived = true; |
||||
websocket._closeMessage = reason; |
||||
websocket._closeCode = code; |
||||
|
||||
if (code === 1005) websocket.close(); |
||||
else websocket.close(code, reason); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'drain'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function receiverOnDrain() { |
||||
this[kWebSocket]._socket.resume(); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'error'` event. |
||||
* |
||||
* @param {(RangeError|Error)} err The emitted error |
||||
* @private |
||||
*/ |
||||
function receiverOnError(err) { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
websocket._socket.removeListener('data', socketOnData); |
||||
|
||||
websocket.readyState = WebSocket.CLOSING; |
||||
websocket._closeCode = err[kStatusCode]; |
||||
websocket.emit('error', err); |
||||
websocket._socket.destroy(); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'finish'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function receiverOnFinish() { |
||||
this[kWebSocket].emitClose(); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'message'` event. |
||||
* |
||||
* @param {(String|Buffer|ArrayBuffer|Buffer[])} data The message |
||||
* @private |
||||
*/ |
||||
function receiverOnMessage(data) { |
||||
this[kWebSocket].emit('message', data); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'ping'` event. |
||||
* |
||||
* @param {Buffer} data The data included in the ping frame |
||||
* @private |
||||
*/ |
||||
function receiverOnPing(data) { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
websocket.pong(data, !websocket._isServer, NOOP); |
||||
websocket.emit('ping', data); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `Receiver` `'pong'` event. |
||||
* |
||||
* @param {Buffer} data The data included in the pong frame |
||||
* @private |
||||
*/ |
||||
function receiverOnPong(data) { |
||||
this[kWebSocket].emit('pong', data); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `net.Socket` `'close'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function socketOnClose() { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
this.removeListener('close', socketOnClose); |
||||
this.removeListener('end', socketOnEnd); |
||||
|
||||
websocket.readyState = WebSocket.CLOSING; |
||||
|
||||
//
|
||||
// The close frame might not have been received or the `'end'` event emitted,
|
||||
// for example, if the socket was destroyed due to an error. Ensure that the
|
||||
// `receiver` stream is closed after writing any remaining buffered data to
|
||||
// it. If the readable side of the socket is in flowing mode then there is no
|
||||
// buffered data as everything has been already written and `readable.read()`
|
||||
// will return `null`. If instead, the socket is paused, any possible buffered
|
||||
// data will be read as a single chunk and emitted synchronously in a single
|
||||
// `'data'` event.
|
||||
//
|
||||
websocket._socket.read(); |
||||
websocket._receiver.end(); |
||||
|
||||
this.removeListener('data', socketOnData); |
||||
this[kWebSocket] = undefined; |
||||
|
||||
clearTimeout(websocket._closeTimer); |
||||
|
||||
if ( |
||||
websocket._receiver._writableState.finished || |
||||
websocket._receiver._writableState.errorEmitted |
||||
) { |
||||
websocket.emitClose(); |
||||
} else { |
||||
websocket._receiver.on('error', receiverOnFinish); |
||||
websocket._receiver.on('finish', receiverOnFinish); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `net.Socket` `'data'` event. |
||||
* |
||||
* @param {Buffer} chunk A chunk of data |
||||
* @private |
||||
*/ |
||||
function socketOnData(chunk) { |
||||
if (!this[kWebSocket]._receiver.write(chunk)) { |
||||
this.pause(); |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `net.Socket` `'end'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function socketOnEnd() { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
websocket.readyState = WebSocket.CLOSING; |
||||
websocket._receiver.end(); |
||||
this.end(); |
||||
} |
||||
|
||||
/** |
||||
* The listener of the `net.Socket` `'error'` event. |
||||
* |
||||
* @private |
||||
*/ |
||||
function socketOnError() { |
||||
const websocket = this[kWebSocket]; |
||||
|
||||
this.removeListener('error', socketOnError); |
||||
this.on('error', NOOP); |
||||
|
||||
if (websocket) { |
||||
websocket.readyState = WebSocket.CLOSING; |
||||
this.destroy(); |
||||
} |
||||
} |
||||
@ -0,0 +1,91 @@
|
||||
{ |
||||
"_from": "ws@^7.1.2", |
||||
"_id": "ws@7.3.1", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-D3RuNkynyHmEJIpD2qrgVkc9DQ23OrN/moAwZX4L8DfvszsJxpjQuUq3LMx6HoYji9fbIOBY18XWBsAux1ZZUA==", |
||||
"_location": "/ws", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "range", |
||||
"registry": true, |
||||
"raw": "ws@^7.1.2", |
||||
"name": "ws", |
||||
"escapedName": "ws", |
||||
"rawSpec": "^7.1.2", |
||||
"saveSpec": null, |
||||
"fetchSpec": "^7.1.2" |
||||
}, |
||||
"_requiredBy": [ |
||||
"/wscat" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/ws/-/ws-7.3.1.tgz", |
||||
"_shasum": "d0547bf67f7ce4f12a72dfe31262c68d7dc551c8", |
||||
"_spec": "ws@^7.1.2", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer/node_modules/wscat", |
||||
"author": { |
||||
"name": "Einar Otto Stangvik", |
||||
"email": "einaros@gmail.com", |
||||
"url": "http://2x.io" |
||||
}, |
||||
"browser": "browser.js", |
||||
"bugs": { |
||||
"url": "https://github.com/websockets/ws/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"deprecated": false, |
||||
"description": "Simple to use, blazing fast and thoroughly tested websocket client and server for Node.js", |
||||
"devDependencies": { |
||||
"benchmark": "^2.1.4", |
||||
"bufferutil": "^4.0.1", |
||||
"coveralls": "^3.0.3", |
||||
"eslint": "^7.2.0", |
||||
"eslint-config-prettier": "^6.0.0", |
||||
"eslint-plugin-prettier": "^3.0.1", |
||||
"mocha": "^7.0.0", |
||||
"nyc": "^15.0.0", |
||||
"prettier": "^2.0.5", |
||||
"utf-8-validate": "^5.0.2" |
||||
}, |
||||
"engines": { |
||||
"node": ">=8.3.0" |
||||
}, |
||||
"files": [ |
||||
"browser.js", |
||||
"index.js", |
||||
"lib/*.js" |
||||
], |
||||
"homepage": "https://github.com/websockets/ws", |
||||
"keywords": [ |
||||
"HyBi", |
||||
"Push", |
||||
"RFC-6455", |
||||
"WebSocket", |
||||
"WebSockets", |
||||
"real-time" |
||||
], |
||||
"license": "MIT", |
||||
"main": "index.js", |
||||
"name": "ws", |
||||
"peerDependencies": { |
||||
"bufferutil": "^4.0.1", |
||||
"utf-8-validate": "^5.0.2" |
||||
}, |
||||
"peerDependenciesMeta": { |
||||
"bufferutil": { |
||||
"optional": true |
||||
}, |
||||
"utf-8-validate": { |
||||
"optional": true |
||||
} |
||||
}, |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/websockets/ws.git" |
||||
}, |
||||
"scripts": { |
||||
"integration": "mocha --throw-deprecation test/*.integration.js", |
||||
"lint": "eslint --ignore-path .gitignore . && prettier --check --ignore-path .gitignore \"**/*.{json,md,yaml,yml}\"", |
||||
"test": "nyc --reporter=html --reporter=text mocha --throw-deprecation test/*.test.js" |
||||
}, |
||||
"version": "7.3.1" |
||||
} |
||||
@ -0,0 +1,21 @@
|
||||
(The MIT License) |
||||
|
||||
Copyright (c) 2011 Einar Otto Stangvik <einaros@gmail.com> |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of |
||||
this software and associated documentation files (the 'Software'), to deal in |
||||
the Software without restriction, including without limitation the rights to |
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies |
||||
of the Software, and to permit persons to whom the Software is furnished to do |
||||
so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
@ -0,0 +1,55 @@
|
||||
# wscat |
||||
|
||||
WebSocket cat. |
||||
|
||||
## Installation |
||||
|
||||
This module needs to be installed globally so use the `-g` flag when installing: |
||||
|
||||
``` |
||||
npm install -g wscat |
||||
``` |
||||
|
||||
## Usage |
||||
|
||||
``` |
||||
Usage: wscat [options] (--listen <port> | --connect <url>) |
||||
|
||||
Options: |
||||
-V, --version output the version number |
||||
-l, --listen <port> listen on port |
||||
-c, --connect <url> connect to a WebSocket server |
||||
-p, --protocol <version> optional protocol version |
||||
-o, --origin <origin> optional origin |
||||
-x, --execute <command> execute command after connecting |
||||
-w, --wait <seconds> wait given seconds after executing command |
||||
-P, --show-ping-pong print a notification when a ping or pong is received |
||||
--host <host> optional host |
||||
-s, --subprotocol <protocol> optional subprotocol (default: []) |
||||
-n, --no-check do not check for unauthorized certificates |
||||
-H, --header <header:value> set an HTTP header. Repeat to set multiple (--connect only) (default: []) |
||||
--auth <username:password> add basic HTTP authentication header (--connect only) |
||||
--ca <ca> specify a Certificate Authority (--connect only) |
||||
--cert <cert> specify a Client SSL Certificate (--connect only) |
||||
--key <key> specify a Client SSL Certificate's key (--connect only) |
||||
--passphrase [passphrase] specify a Client SSL Certificate Key's passphrase (--connect only). If you don't provide a value, it will be prompted for |
||||
--no-color run without color |
||||
--slash enable slash commands for control frames (/ping, /pong, /close [code [, reason]]) |
||||
--proxy <[protocol://]host[:port]> connect via a proxy. Proxy must support CONNECT method |
||||
-h, --help output usage information |
||||
``` |
||||
|
||||
## Example |
||||
|
||||
``` |
||||
$ wscat -c ws://echo.websocket.org |
||||
Connected (press CTRL+C to quit) |
||||
> hi there |
||||
< hi there |
||||
> are you a happy parrot? |
||||
< are you a happy parrot? |
||||
``` |
||||
|
||||
## License |
||||
|
||||
MIT |
||||
@ -0,0 +1,61 @@
|
||||
{ |
||||
"_from": "wscat", |
||||
"_id": "wscat@4.0.1", |
||||
"_inBundle": false, |
||||
"_integrity": "sha512-3lWdgZn8d92WjV1a1zIW8pUlK7iKKk4/DABp2fDM1ZLHrIyAIe1+R1tkSCR4q5QW4QQS4glGqGlQxrmVCN17Zg==", |
||||
"_location": "/wscat", |
||||
"_phantomChildren": {}, |
||||
"_requested": { |
||||
"type": "tag", |
||||
"registry": true, |
||||
"raw": "wscat", |
||||
"name": "wscat", |
||||
"escapedName": "wscat", |
||||
"rawSpec": "", |
||||
"saveSpec": null, |
||||
"fetchSpec": "latest" |
||||
}, |
||||
"_requiredBy": [ |
||||
"#USER", |
||||
"/" |
||||
], |
||||
"_resolved": "https://registry.npmjs.org/wscat/-/wscat-4.0.1.tgz", |
||||
"_shasum": "40aee22548a3010e14496bc27452976656a1b697", |
||||
"_spec": "wscat", |
||||
"_where": "/home/jonny/Development/JBoss/quarkus-qe-role/quarkus-kafaka-homework/kafka-consumer", |
||||
"author": { |
||||
"name": "Arnout Kazemier, Einar Otto Stangvik" |
||||
}, |
||||
"bin": { |
||||
"wscat": "bin/wscat" |
||||
}, |
||||
"bugs": { |
||||
"url": "https://github.com/websockets/wscat/issues" |
||||
}, |
||||
"bundleDependencies": false, |
||||
"dependencies": { |
||||
"commander": "^5.0.0", |
||||
"https-proxy-agent": "^5.0.0", |
||||
"read": "^1.0.7", |
||||
"ws": "^7.1.2" |
||||
}, |
||||
"deprecated": false, |
||||
"description": "WebSocket cat", |
||||
"homepage": "https://github.com/websockets/wscat#readme", |
||||
"keywords": [ |
||||
"wscat", |
||||
"websocket", |
||||
"cat" |
||||
], |
||||
"license": "MIT", |
||||
"main": "index.js", |
||||
"name": "wscat", |
||||
"repository": { |
||||
"type": "git", |
||||
"url": "git+https://github.com/websockets/wscat.git" |
||||
}, |
||||
"scripts": { |
||||
"test": "echo \"No test specified\"" |
||||
}, |
||||
"version": "4.0.1" |
||||
} |
||||
@ -0,0 +1,129 @@
|
||||
<?xml version="1.0"?> |
||||
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" |
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
||||
<modelVersion>4.0.0</modelVersion> |
||||
<groupId>me.jochrist.kafka</groupId> |
||||
<artifactId>kafka-consumer</artifactId> |
||||
<version>1.0-SNAPSHOT</version> |
||||
<properties> |
||||
<compiler-plugin.version>3.8.1</compiler-plugin.version> |
||||
<maven.compiler.parameters>true</maven.compiler.parameters> |
||||
<maven.compiler.source>1.8</maven.compiler.source> |
||||
<maven.compiler.target>1.8</maven.compiler.target> |
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> |
||||
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> |
||||
<quarkus-plugin.version>1.8.1.Final</quarkus-plugin.version> |
||||
<quarkus.platform.artifact-id>quarkus-universe-bom</quarkus.platform.artifact-id> |
||||
<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id> |
||||
<quarkus.platform.version>1.8.1.Final</quarkus.platform.version> |
||||
<surefire-plugin.version>3.0.0-M5</surefire-plugin.version> |
||||
</properties> |
||||
<dependencyManagement> |
||||
<dependencies> |
||||
<dependency> |
||||
<groupId>${quarkus.platform.group-id}</groupId> |
||||
<artifactId>${quarkus.platform.artifact-id}</artifactId> |
||||
<version>${quarkus.platform.version}</version> |
||||
<type>pom</type> |
||||
<scope>import</scope> |
||||
</dependency> |
||||
</dependencies> |
||||
</dependencyManagement> |
||||
<dependencies> |
||||
<dependency> |
||||
<groupId>io.quarkus</groupId> |
||||
<artifactId>quarkus-resteasy</artifactId> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.quarkus</groupId> |
||||
<artifactId>quarkus-junit5</artifactId> |
||||
<scope>test</scope> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.rest-assured</groupId> |
||||
<artifactId>rest-assured</artifactId> |
||||
<scope>test</scope> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.quarkus</groupId> |
||||
<artifactId>quarkus-undertow-websockets</artifactId> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.smallrye.reactive</groupId> |
||||
<artifactId>smallrye-reactive-messaging-api</artifactId> |
||||
<version>2.3.0</version> |
||||
</dependency> |
||||
<dependency> |
||||
<groupId>io.quarkus</groupId> |
||||
<artifactId>quarkus-smallrye-reactive-messaging-kafka</artifactId> |
||||
</dependency> |
||||
</dependencies> |
||||
<build> |
||||
<plugins> |
||||
<plugin> |
||||
<groupId>io.quarkus</groupId> |
||||
<artifactId>quarkus-maven-plugin</artifactId> |
||||
<version>${quarkus-plugin.version}</version> |
||||
<executions> |
||||
<execution> |
||||
<goals> |
||||
<goal>generate-code</goal> |
||||
<goal>generate-code-tests</goal> |
||||
<goal>build</goal> |
||||
</goals> |
||||
</execution> |
||||
</executions> |
||||
</plugin> |
||||
<plugin> |
||||
<artifactId>maven-compiler-plugin</artifactId> |
||||
<version>${compiler-plugin.version}</version> |
||||
</plugin> |
||||
<plugin> |
||||
<artifactId>maven-surefire-plugin</artifactId> |
||||
<version>${surefire-plugin.version}</version> |
||||
<configuration> |
||||
<systemPropertyVariables> |
||||
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager> |
||||
<maven.home>${maven.home}</maven.home> |
||||
</systemPropertyVariables> |
||||
</configuration> |
||||
</plugin> |
||||
</plugins> |
||||
</build> |
||||
<profiles> |
||||
<profile> |
||||
<id>native</id> |
||||
<activation> |
||||
<property> |
||||
<name>native</name> |
||||
</property> |
||||
</activation> |
||||
<build> |
||||
<plugins> |
||||
<plugin> |
||||
<artifactId>maven-failsafe-plugin</artifactId> |
||||
<version>${surefire-plugin.version}</version> |
||||
<executions> |
||||
<execution> |
||||
<goals> |
||||
<goal>integration-test</goal> |
||||
<goal>verify</goal> |
||||
</goals> |
||||
<configuration> |
||||
<systemPropertyVariables> |
||||
<native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path> |
||||
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager> |
||||
<maven.home>${maven.home}</maven.home> |
||||
</systemPropertyVariables> |
||||
</configuration> |
||||
</execution> |
||||
</executions> |
||||
</plugin> |
||||
</plugins> |
||||
</build> |
||||
<properties> |
||||
<quarkus.package.type>native</quarkus.package.type> |
||||
</properties> |
||||
</profile> |
||||
</profiles> |
||||
</project> |
||||
@ -0,0 +1,57 @@
|
||||
#### |
||||
# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode |
||||
# |
||||
# Before building the container image run: |
||||
# |
||||
# mvn package -Dquarkus.package.type=fast-jar |
||||
# |
||||
# Then, build the image with: |
||||
# |
||||
# docker build -f src/main/docker/Dockerfile.fast-jar -t quarkus/kafka-consumer-fast-jar . |
||||
# |
||||
# Then run the container using: |
||||
# |
||||
# docker run -i --rm -p 8080:8080 quarkus/kafka-consumer-fast-jar |
||||
# |
||||
# If you want to include the debug port into your docker image |
||||
# you will have to expose the debug port (default 5005) like this : EXPOSE 8080 5050 |
||||
# |
||||
# Then run the container using : |
||||
# |
||||
# docker run -i --rm -p 8080:8080 -p 5005:5005 -e JAVA_ENABLE_DEBUG="true" quarkus/kafka-consumer-fast-jar |
||||
# |
||||
### |
||||
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.1 |
||||
|
||||
ARG JAVA_PACKAGE=java-11-openjdk-headless |
||||
ARG RUN_JAVA_VERSION=1.3.8 |
||||
|
||||
ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en' |
||||
|
||||
# Install java and the run-java script |
||||
# Also set up permissions for user `1001` |
||||
RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \ |
||||
&& microdnf update \ |
||||
&& microdnf clean all \ |
||||
&& mkdir /deployments \ |
||||
&& chown 1001 /deployments \ |
||||
&& chmod "g+rwX" /deployments \ |
||||
&& chown 1001:root /deployments \ |
||||
&& curl https://repo1.maven.org/maven2/io/fabric8/run-java-sh/${RUN_JAVA_VERSION}/run-java-sh-${RUN_JAVA_VERSION}-sh.sh -o /deployments/run-java.sh \ |
||||
&& chown 1001 /deployments/run-java.sh \ |
||||
&& chmod 540 /deployments/run-java.sh \ |
||||
&& echo "securerandom.source=file:/dev/urandom" >> /etc/alternatives/jre/lib/security/java.security |
||||
|
||||
# Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size. |
||||
ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" |
||||
|
||||
# We make four distinct layers so if there are application changes the library layers can be re-used |
||||
COPY --chown=1001 target/quarkus-app/lib/ /deployments/lib/ |
||||
COPY --chown=1001 target/quarkus-app/*.jar /deployments/ |
||||
COPY --chown=1001 target/quarkus-app/app/ /deployments/app/ |
||||
COPY --chown=1001 target/quarkus-app/quarkus/ /deployments/quarkus/ |
||||
|
||||
EXPOSE 8080 |
||||
USER 1001 |
||||
|
||||
ENTRYPOINT [ "/deployments/run-java.sh" ] |
||||
@ -0,0 +1,54 @@
|
||||
#### |
||||
# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode |
||||
# |
||||
# Before building the container image run: |
||||
# |
||||
# mvn package |
||||
# |
||||
# Then, build the image with: |
||||
# |
||||
# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/kafka-consumer-jvm . |
||||
# |
||||
# Then run the container using: |
||||
# |
||||
# docker run -i --rm -p 8080:8080 quarkus/kafka-consumer-jvm |
||||
# |
||||
# If you want to include the debug port into your docker image |
||||
# you will have to expose the debug port (default 5005) like this : EXPOSE 8080 5050 |
||||
# |
||||
# Then run the container using : |
||||
# |
||||
# docker run -i --rm -p 8080:8080 -p 5005:5005 -e JAVA_ENABLE_DEBUG="true" quarkus/kafka-consumer-jvm |
||||
# |
||||
### |
||||
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.1 |
||||
|
||||
ARG JAVA_PACKAGE=java-11-openjdk-headless |
||||
ARG RUN_JAVA_VERSION=1.3.8 |
||||
|
||||
ENV LANG='en_US.UTF-8' LANGUAGE='en_US:en' |
||||
|
||||
# Install java and the run-java script |
||||
# Also set up permissions for user `1001` |
||||
RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \ |
||||
&& microdnf update \ |
||||
&& microdnf clean all \ |
||||
&& mkdir /deployments \ |
||||
&& chown 1001 /deployments \ |
||||
&& chmod "g+rwX" /deployments \ |
||||
&& chown 1001:root /deployments \ |
||||
&& curl https://repo1.maven.org/maven2/io/fabric8/run-java-sh/${RUN_JAVA_VERSION}/run-java-sh-${RUN_JAVA_VERSION}-sh.sh -o /deployments/run-java.sh \ |
||||
&& chown 1001 /deployments/run-java.sh \ |
||||
&& chmod 540 /deployments/run-java.sh \ |
||||
&& echo "securerandom.source=file:/dev/urandom" >> /etc/alternatives/jre/lib/security/java.security |
||||
|
||||
# Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size. |
||||
ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" |
||||
|
||||
COPY target/lib/* /deployments/lib/ |
||||
COPY target/*-runner.jar /deployments/app.jar |
||||
|
||||
EXPOSE 8080 |
||||
USER 1001 |
||||
|
||||
ENTRYPOINT [ "/deployments/run-java.sh" ] |
||||
@ -0,0 +1,27 @@
|
||||
#### |
||||
# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode |
||||
# |
||||
# Before building the container image run: |
||||
# |
||||
# mvn package -Pnative -Dquarkus.native.container-build=true |
||||
# |
||||
# Then, build the image with: |
||||
# |
||||
# docker build -f src/main/docker/Dockerfile.native -t quarkus/kafka-consumer . |
||||
# |
||||
# Then run the container using: |
||||
# |
||||
# docker run -i --rm -p 8080:8080 quarkus/kafka-consumer |
||||
# |
||||
### |
||||
FROM registry.access.redhat.com/ubi8/ubi-minimal:8.1 |
||||
WORKDIR /work/ |
||||
RUN chown 1001 /work \ |
||||
&& chmod "g+rwX" /work \ |
||||
&& chown 1001:root /work |
||||
COPY --chown=1001:root target/*-runner /work/application |
||||
|
||||
EXPOSE 8080 |
||||
USER 1001 |
||||
|
||||
CMD ["./application", "-Dquarkus.http.host=0.0.0.0"] |
||||
@ -0,0 +1,100 @@
|
||||
package me.jochrist.kafka; |
||||
|
||||
import io.netty.handler.logging.LogLevel; |
||||
|
||||
import javax.inject.Inject; |
||||
import javax.ws.rs.GET; |
||||
import javax.ws.rs.Path; |
||||
import javax.ws.rs.Produces; |
||||
import javax.ws.rs.core.MediaType; |
||||
import java.util.Map; |
||||
import java.util.concurrent.ConcurrentHashMap; |
||||
|
||||
import javax.enterprise.context.ApplicationScoped; |
||||
import javax.websocket.OnClose; |
||||
import javax.websocket.OnError; |
||||
import javax.websocket.OnMessage; |
||||
import javax.websocket.OnOpen; |
||||
import javax.websocket.server.PathParam; |
||||
import javax.websocket.server.ServerEndpoint; |
||||
import javax.websocket.Session; |
||||
import org.jboss.logging.Logger; |
||||
import org.eclipse.microprofile.reactive.messaging.Incoming; |
||||
|
||||
import io.smallrye.reactive.messaging.annotations.Channel; |
||||
import org.eclipse.microprofile.reactive.messaging.Message; |
||||
import java.util.concurrent.CompletionStage; |
||||
import org.reactivestreams.Publisher; |
||||
|
||||
//@Path("/kafka")
|
||||
@ServerEndpoint("/kafka/message/{topic}") |
||||
@ApplicationScoped |
||||
public class Consumer { |
||||
private static final Logger LOG = Logger.getLogger(Consumer.class); |
||||
|
||||
Map<String, Session> sessions = new ConcurrentHashMap<>(); |
||||
|
||||
@OnOpen |
||||
public void onOpen(Session session, @PathParam("topic") String topic) |
||||
{ |
||||
//Join kafka topic matching topid name (timestamp or user-message)
|
||||
sessions.put(topic, session); |
||||
LOG.debug("%h will watch topic \"" + topic + "\""); |
||||
} |
||||
|
||||
//@Inject @Channel("user-message") Publisher<String> usermessage;
|
||||
//@Inject @Channel("timestamp") Publisher<String> timestamp;
|
||||
//public Publisher<String> stream()
|
||||
//{
|
||||
// LOG.info("timestamp: " + timestamp);
|
||||
// return usermessage;
|
||||
//}
|
||||
|
||||
@Incoming("timestamp") |
||||
public CompletionStage<Void> consume(Message<String> timestamp){ |
||||
System.out.println(timestamp.getPayload()); |
||||
sendToSubscriber("timestamp", timestamp.getPayload()); |
||||
return timestamp.ack(); |
||||
} |
||||
|
||||
@Incoming("user-message") |
||||
public CompletionStage<Void> consume2(Message<String> usermessage){ |
||||
System.out.println(usermessage.getPayload()); |
||||
sendToSubscriber("user-message", usermessage.getPayload()); |
||||
return usermessage.ack(); |
||||
} |
||||
|
||||
private void sendToSubscriber(String topic, String message) { |
||||
if(sessions.containsKey(topic)) |
||||
{ |
||||
Session s = sessions.get(topic); |
||||
s.getAsyncRemote().sendObject(message, result -> |
||||
{ |
||||
if (result.getException() != null) { |
||||
System.out.println("Unable to send message: " + result.getException()); |
||||
} |
||||
}); |
||||
} |
||||
} |
||||
/* |
||||
sessions.values().stream() |
||||
.filter(s -> topic.equals(s.getKey())) |
||||
.map(map -> map.getAsyncRemote().sendObject(message), result -> |
||||
{ |
||||
if (result.getException() != null) { |
||||
System.out.println("Unable to send message: " + result.getException()); |
||||
} |
||||
}); |
||||
} |
||||
*/ |
||||
|
||||
private void broadcast(String message) { |
||||
sessions.values().forEach(s -> { |
||||
s.getAsyncRemote().sendObject(message, result -> { |
||||
if (result.getException() != null) { |
||||
System.out.println("Unable to send message: " + result.getException()); |
||||
} |
||||
}); |
||||
}); |
||||
} |
||||
} |
||||
@ -0,0 +1,101 @@
|
||||
<!DOCTYPE html> |
||||
<html> |
||||
|
||||
<head> |
||||
<meta charset="UTF-8"> |
||||
<title>Quarkus Chat!</title> |
||||
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/patternfly/3.24.0/css/patternfly.min.css"> |
||||
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/patternfly/3.24.0/css/patternfly-additions.min.css"> |
||||
|
||||
<style> |
||||
#chat { |
||||
resize: none; |
||||
overflow: hidden; |
||||
min-height: 300px; |
||||
max-height: 300px; |
||||
} |
||||
</style> |
||||
</head> |
||||
|
||||
<body> |
||||
<nav class="navbar navbar-default navbar-pf" role="navigation"> |
||||
<div class="navbar-header"> |
||||
<a class="navbar-brand" href="/"> |
||||
<p><strong>Quarkus Kafka Example</strong></p> |
||||
</a> |
||||
</div> |
||||
</nav> |
||||
<div class="container"> |
||||
<br/> |
||||
<div class="row"> |
||||
<label for="topics">Topic:</label> |
||||
<select name="topic" id="topics"> |
||||
<option value="timestamp">Timestamp</option> |
||||
<option value="user-message">User Message</option> |
||||
</select> |
||||
<button id="connect" class="col-md-1 btn btn-primary" type="button">Watch</button> |
||||
<br/> |
||||
<br/> |
||||
</div> |
||||
<div class="row"> |
||||
<textarea class="col-md-8" id="chat"> |
||||
</textarea> |
||||
</div> |
||||
|
||||
</div> |
||||
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script> |
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script> |
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/patternfly/3.24.0/js/patternfly.min.js"></script> |
||||
|
||||
<script type="text/javascript"> |
||||
var connected = false; |
||||
var socket; |
||||
|
||||
$( document ).ready(function() { |
||||
$("#connect").click(connect); |
||||
|
||||
|
||||
$("#topics").keypress(function(event){ |
||||
if(event.keyCode == 13 || event.which == 13) { |
||||
connect(); |
||||
} |
||||
}); |
||||
|
||||
$("#chat").change(function() { |
||||
scrollToBottom(); |
||||
}); |
||||
|
||||
$("#name").focus(); |
||||
}); |
||||
|
||||
var connect = function() { |
||||
if (! connected) { |
||||
var topic = $("#topics").val(); |
||||
console.log("Val: " + name); |
||||
socket = new WebSocket("ws://" + location.host + "/kafka/message/" + topic); |
||||
socket.onopen = function() { |
||||
connected = true; |
||||
console.log("Connected to the web socket"); |
||||
$("#send").attr("disabled", false); |
||||
$("#connect").attr("disabled", true); |
||||
$("#name").attr("disabled", true); |
||||
$("#msg").focus(); |
||||
}; |
||||
socket.onmessage =function(m) { |
||||
console.log("Got message: " + m.data); |
||||
$("#chat").append(m.data + "\n"); |
||||
scrollToBottom(); |
||||
}; |
||||
} |
||||
}; |
||||
|
||||
|
||||
var scrollToBottom = function () { |
||||
$('#chat').scrollTop($('#chat')[0].scrollHeight); |
||||
}; |
||||
|
||||
</script> |
||||
</body> |
||||
|
||||
</html> |
||||
@ -0,0 +1,12 @@
|
||||
# Configuration file |
||||
# key = value |
||||
# Configure the Kafka source (we read from it) |
||||
kafka.bootstrap.servers=localhost:9092 |
||||
quarkus.http.port=8081 |
||||
mp.messaging.incoming.user-message.connector=smallrye-kafka |
||||
mp.messaging.incoming.user-message.topic=user-message |
||||
mp.messaging.incoming.user-message.value.deserializer=org.apache.kafka.common.serialization.StringDeserializer |
||||
|
||||
mp.messaging.incoming.timestamp.connector=smallrye-kafka |
||||
mp.messaging.incoming.timestamp.topic=timestamp |
||||
mp.messaging.incoming.timestamp.value.deserializer=org.apache.kafka.common.serialization.StringDeserializer |
||||
@ -0,0 +1,21 @@
|
||||
package me.jochrist.kafka; |
||||
|
||||
import io.quarkus.test.junit.QuarkusTest; |
||||
import org.junit.jupiter.api.Test; |
||||
|
||||
import static io.restassured.RestAssured.given; |
||||
import static org.hamcrest.CoreMatchers.is; |
||||
|
||||
@QuarkusTest |
||||
public class ConsumerTest { |
||||
|
||||
@Test |
||||
public void testHelloEndpoint() { |
||||
given() |
||||
.when().get("/hello") |
||||
.then() |
||||
.statusCode(200) |
||||
.body(is("hello")); |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,9 @@
|
||||
package me.jochrist.kafka; |
||||
|
||||
import io.quarkus.test.junit.NativeImageTest; |
||||
|
||||
@NativeImageTest |
||||
public class NativeConsumerIT extends ConsumerTest { |
||||
|
||||
// Execute the same tests but in native mode.
|
||||
} |
||||
Loading…
Reference in new issue