Skip to content
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.

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

Node process object compatibility #3368

Merged
merged 12 commits into from
Nov 18, 2019
42 changes: 42 additions & 0 deletions std/node/process.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { notImplemented } from "./_utils.ts";

const version = `v${Deno.version.deno}`;

const versions = {
node: Deno.version.deno,
...Deno.version
};

const osToPlatform = (os: Deno.OperatingSystem): string =>
os === "win" ? "win32" : os === "mac" ? "darwin" : os;

const platform = osToPlatform(Deno.build.os);

const { arch } = Deno.build;

const { pid, cwd, chdir, exit } = Deno;

function on(_event: string, _callback: Function): void {
// TODO(rsp): to be implemented
Copy link
Member

Choose a reason for hiding this comment

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

please add

throw Error("unimplemented");

Copy link
Contributor Author

@rsp rsp Nov 18, 2019

Choose a reason for hiding this comment

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

Is it ok if I throw Error("unimplemented") for everything except "uncaughtException"? The idea is that Deno crashes on all uncaught exceptions anyway, and I want to prevent code that makes Node crash on uncaught exceptions to crash during adding a listener for uncaughtException.

Copy link
Contributor Author

@rsp rsp Nov 18, 2019

Choose a reason for hiding this comment

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

But it you think it's not a good idea then I can throw on everything and take care of it in a third party module, just let me know.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I'm just throwing Error("unimplemented") for everything that is not actually implemented. I don't want to add any exceptions. Sorry for the confusion.

notImplemented();
}

export const process = {
version,
versions,
platform,
arch,
pid,
cwd,
chdir,
exit,
on,
get env(): { [index: string]: string } {
// using getter to avoid --allow-env unless it's used
return Deno.env();
},
get argv(): string[] {
// Deno.execPath() also requires --allow-env
return [Deno.execPath(), ...Deno.args];
}
};
103 changes: 103 additions & 0 deletions std/node/process_test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import { test } from "../testing/mod.ts";
import { assert, assertThrows, assertEquals } from "../testing/asserts.ts";
import { process } from "./process.ts";

// NOTE: Deno.execPath() (and thus process.argv) currently requires --allow-env
// (Also Deno.env() (and process.env) requires --allow-env but it's more obvious)

test({
name: "process.cwd and process.chdir success",
fn() {
// this should be run like other tests from directory up
assert(process.cwd().match(/\Wstd$/));
process.chdir("node");
assert(process.cwd().match(/\Wnode$/));
process.chdir("..");
assert(process.cwd().match(/\Wstd$/));
}
});

test({
name: "process.chdir failure",
fn() {
assertThrows(
() => {
process.chdir("non-existent-directory-name");
},
Deno.DenoError,
"file"
// On every OS Deno returns: "No such file" except for Windows, where it's:
// "The system cannot find the file specified. (os error 2)" so "file" is
// the only common string here.
// TODO(rsp): Crazy idea: 404 for things like this?
// It would be nice to have error codes like 404 or 403 in addition to strings.
);
}
});

test({
name: "process.version",
fn() {
assertEquals(typeof process, "object");
assertEquals(typeof process.version, "string");
assertEquals(typeof process.versions, "object");
assertEquals(typeof process.versions.node, "string");
}
});

test({
name: "process.platform",
fn() {
assertEquals(typeof process.platform, "string");
}
});

test({
name: "process.arch",
fn() {
assertEquals(typeof process.arch, "string");
// TODO(rsp): make sure that the arch strings should be the same in Node and Deno:
assertEquals(process.arch, Deno.build.arch);
}
});

test({
name: "process.pid",
fn() {
assertEquals(typeof process.pid, "number");
assertEquals(process.pid, Deno.pid);
}
});

test({
name: "process.on",
fn() {
assertEquals(typeof process.on, "function");
assertThrows(
() => {
process.on("uncaughtException", (_err: Error) => {});
},
Error,
"implemented"
);
}
});

test({
name: "process.argv",
fn() {
assert(Array.isArray(process.argv));
assert(
process.argv[0].match(/[^/\\]*deno[^/\\]*$/),
"deno included in the file name of argv[0]"
);
// we cannot test for anything else (we see test runner arguments here)
}
});

test({
name: "process.env",
fn() {
assertEquals(typeof process.env.PATH, "string");
}
});