da0fd286b4
* chore: initial scaffolding * chore: implement interface and docs * chore: address code style review * fix: cleanup of utility process on shutdown * chore: simplify NodeBindings::CreateEnvironment * chore: rename disableLibraryValidation => allowLoadingUnsignedLibraries * chore: implement process.parentPort * chore(posix): implement stdio pipe interface * chore(win): implement stdio interface * chore: reenable SetNodeOptions for utility process * chore: add specs * chore: fix lint * fix: update kill API * fix: update process.parentPort API * fix: exit event * docs: update exit event * fix: tests on linux * chore: expand on some comments * fix: shutdown of pipe reader Avoid logging since it is always the case that reader end of pipe will terminate after the child process. * fix: remove exit code check for crash spec * fix: rm PR_SET_NO_NEW_PRIVS for unsandbox utility process * chore: fix incorrect rebase * fix: address review feedback * chore: rename utility_process -> utility * chore: update docs * chore: cleanup c++ implemantation * fix: leak in NodeServiceHost impl * chore: minor cleanup * chore: cleanup JS implementation * chore: flip default stdio to inherit * fix: some api improvements * Support cwd option * Remove path restriction for modulePath * Rewire impl for env support * fix: add tests for cwd and env option * chore: alt impl for reading stdio handles * chore: support message queuing * chore: fix lint * chore: new UtilityProcess => utilityProcess.fork * fix: support for uncaught exception exits * chore: remove process.execArgv as default * fix: windows build * fix: style changes * fix: docs and style changes * chore: update patches * spec: disable flaky test on win32 arm CI Co-authored-by: PatchUp <73610968+patchup[bot]@users.noreply.github.com>
100 lines
3.2 KiB
C++
100 lines
3.2 KiB
C++
// Copyright (c) 2022 Microsoft, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef ELECTRON_SHELL_BROWSER_API_ELECTRON_API_UTILITY_PROCESS_H_
|
|
#define ELECTRON_SHELL_BROWSER_API_ELECTRON_API_UTILITY_PROCESS_H_
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "base/containers/id_map.h"
|
|
#include "base/environment.h"
|
|
#include "base/memory/weak_ptr.h"
|
|
#include "base/process/process_handle.h"
|
|
#include "gin/wrappable.h"
|
|
#include "mojo/public/cpp/bindings/connector.h"
|
|
#include "mojo/public/cpp/bindings/message.h"
|
|
#include "mojo/public/cpp/bindings/remote.h"
|
|
#include "shell/browser/event_emitter_mixin.h"
|
|
#include "shell/common/gin_helper/pinnable.h"
|
|
#include "shell/services/node/public/mojom/node_service.mojom.h"
|
|
#include "v8/include/v8.h"
|
|
|
|
namespace gin {
|
|
class Arguments;
|
|
template <typename T>
|
|
class Handle;
|
|
} // namespace gin
|
|
|
|
namespace base {
|
|
class Process;
|
|
} // namespace base
|
|
|
|
namespace electron {
|
|
|
|
namespace api {
|
|
|
|
class UtilityProcessWrapper
|
|
: public gin::Wrappable<UtilityProcessWrapper>,
|
|
public gin_helper::Pinnable<UtilityProcessWrapper>,
|
|
public gin_helper::EventEmitterMixin<UtilityProcessWrapper>,
|
|
public mojo::MessageReceiver {
|
|
public:
|
|
enum class IOHandle : size_t { STDIN = 0, STDOUT = 1, STDERR = 2 };
|
|
enum class IOType { IO_PIPE, IO_INHERIT, IO_IGNORE };
|
|
|
|
~UtilityProcessWrapper() override;
|
|
static gin::Handle<UtilityProcessWrapper> Create(gin::Arguments* args);
|
|
static raw_ptr<UtilityProcessWrapper> FromProcessId(base::ProcessId pid);
|
|
|
|
void Shutdown(int exit_code);
|
|
|
|
// gin::Wrappable
|
|
static gin::WrapperInfo kWrapperInfo;
|
|
gin::ObjectTemplateBuilder GetObjectTemplateBuilder(
|
|
v8::Isolate* isolate) override;
|
|
const char* GetTypeName() override;
|
|
|
|
private:
|
|
UtilityProcessWrapper(node::mojom::NodeServiceParamsPtr params,
|
|
std::u16string display_name,
|
|
std::map<IOHandle, IOType> stdio,
|
|
base::EnvironmentMap env_map,
|
|
base::FilePath current_working_directory,
|
|
bool use_plugin_helper);
|
|
void OnServiceProcessDisconnected(uint32_t error_code,
|
|
const std::string& description);
|
|
void OnServiceProcessLaunched(const base::Process& process);
|
|
void CloseConnectorPort();
|
|
|
|
void PostMessage(gin::Arguments* args);
|
|
bool Kill() const;
|
|
v8::Local<v8::Value> GetOSProcessId(v8::Isolate* isolate) const;
|
|
|
|
// mojo::MessageReceiver
|
|
bool Accept(mojo::Message* mojo_message) override;
|
|
|
|
base::ProcessId pid_ = base::kNullProcessId;
|
|
#if BUILDFLAG(IS_WIN)
|
|
// Non-owning handles, these will be closed when the
|
|
// corresponding FD are closed via _close.
|
|
HANDLE stdout_read_handle_;
|
|
HANDLE stderr_read_handle_;
|
|
#endif
|
|
int stdout_read_fd_ = -1;
|
|
int stderr_read_fd_ = -1;
|
|
bool connector_closed_ = false;
|
|
std::unique_ptr<mojo::Connector> connector_;
|
|
blink::MessagePortDescriptor host_port_;
|
|
mojo::Remote<node::mojom::NodeService> node_service_remote_;
|
|
base::WeakPtrFactory<UtilityProcessWrapper> weak_factory_{this};
|
|
};
|
|
|
|
} // namespace api
|
|
|
|
} // namespace electron
|
|
|
|
#endif // ELECTRON_SHELL_BROWSER_API_ELECTRON_API_UTILITY_PROCESS_H_
|