Skip to content

Allow specifying alternate bin and cache directories when downloading #306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow specifying alternate bin and cache directories when downloading #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions download.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ declare module "ngrok/download" {
export default function downloadNgrok(
callback: (err?: Error) => void,
options?: {
cafilePath: string;
arch: string;
cdnUrl: string;
cdnPath: string;
ignoreCache: boolean;
cafilePath?: string;
Copy link
Author

@mdlavin mdlavin May 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only new addition are the last two lines. The other lines are made optional to reflect reality.

arch?: string;
cdnUrl?: string;
cdnPath?: string;
ignoreCache?: boolean;
cacheDir?: string;
binDir?: string;
}
): void;
}
24 changes: 14 additions & 10 deletions download.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,20 @@ function downloadNgrok(callback, options) {

function getCacheUrl() {
let dir;
try {
dir =
os.platform() === "win32" && process.env.APPDATA
? path.join(process.env.APPDATA, "ngrok")
: path.join(os.homedir(), ".ngrok");
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
fs.mkdirSync(dir);

if (options.cacheDir) dir = options.cacheDir;
else {
try {
dir =
os.platform() === "win32" && process.env.APPDATA
? path.join(process.env.APPDATA, "ngrok")
: path.join(os.homedir(), ".ngrok");
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
fs.mkdirSync(dir);
}
} catch (err) {
dir = path.join(__dirname, "bin");
}
} catch (err) {
dir = path.join(__dirname, "bin");
}
const name = Buffer.from(cdnUrl).toString("base64");
return path.join(dir, name + ".zip");
Expand Down Expand Up @@ -147,7 +151,7 @@ function downloadNgrok(callback, options) {

function extract(cb) {
console.error("ngrok - unpacking binary");
const moduleBinPath = path.join(__dirname, "bin");
const moduleBinPath = options.binDir || path.join(__dirname, "bin");
extract_zip(cacheUrl, { dir: moduleBinPath })
.then(() => {
const suffix = os.platform() === "win32" ? ".exe" : "";
Expand Down
4 changes: 2 additions & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ declare module "ngrok" {
gauge: number;
}

interface HTTPRequests extends Metrics {}
interface HTTPRequests extends Metrics { }

interface Tunnel {
name: string;
Expand All @@ -203,7 +203,7 @@ declare module "ngrok" {

interface CapturedRequestOptions {
limit: number;
tunnel_name: string;
tunnel_name?: string;
Copy link
Author

@mdlavin mdlavin May 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed during development, the tunnnel_name isn't really required

}

interface Request {
Expand Down