X Tutup
Skip to content

Commit de6696e

Browse files
authored
chore: remove unused and broken ipcRendererInternal.sendTo() (electron#29743)
1 parent 6b4c59b commit de6696e

File tree

10 files changed

+12
-25
lines changed

10 files changed

+12
-25
lines changed

lib/renderer/api/ipc-renderer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ipcRenderer.sendToHost = function (channel, ...args) {
1818
};
1919

2020
ipcRenderer.sendTo = function (webContentsId, channel, ...args) {
21-
return ipc.sendTo(internal, webContentsId, channel, args);
21+
return ipc.sendTo(webContentsId, channel, args);
2222
};
2323

2424
ipcRenderer.invoke = async function (channel, ...args) {

lib/renderer/ipc-renderer-internal.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ const { ipc } = process._linkedBinding('electron_renderer_ipc');
44

55
const internal = true;
66

7-
const ipcRendererInternal = new EventEmitter() as any as ElectronInternal.IpcRendererInternal;
7+
export const ipcRendererInternal = new EventEmitter() as any as ElectronInternal.IpcRendererInternal;
8+
89
ipcRendererInternal.send = function (channel, ...args) {
910
return ipc.send(internal, channel, args);
1011
};
@@ -13,16 +14,10 @@ ipcRendererInternal.sendSync = function (channel, ...args) {
1314
return ipc.sendSync(internal, channel, args);
1415
};
1516

16-
ipcRendererInternal.sendTo = function (webContentsId, channel, ...args) {
17-
return ipc.sendTo(internal, webContentsId, channel, args);
18-
};
19-
2017
ipcRendererInternal.invoke = async function<T> (channel: string, ...args: any[]) {
2118
const { error, result } = await ipc.invoke<T>(internal, channel, args);
2219
if (error) {
2320
throw new Error(`Error invoking remote method '${channel}': ${error}`);
2421
}
2522
return result;
2623
};
27-
28-
export { ipcRendererInternal };

shell/browser/api/electron_api_web_contents.cc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1601,8 +1601,7 @@ void WebContents::MessageSync(
16011601
internal, channel, std::move(arguments));
16021602
}
16031603

1604-
void WebContents::MessageTo(bool internal,
1605-
int32_t web_contents_id,
1604+
void WebContents::MessageTo(int32_t web_contents_id,
16061605
const std::string& channel,
16071606
blink::CloneableMessage arguments) {
16081607
TRACE_EVENT1("electron", "WebContents::MessageTo", "channel", channel);
@@ -1617,7 +1616,7 @@ void WebContents::MessageTo(bool internal,
16171616
WebFrameMain::From(JavascriptEnvironment::GetIsolate(), frame);
16181617

16191618
int32_t sender_id = ID();
1620-
web_frame_main->GetRendererApi()->Message(internal, channel,
1619+
web_frame_main->GetRendererApi()->Message(false /* internal */, channel,
16211620
std::move(arguments), sender_id);
16221621
}
16231622
}

shell/browser/api/electron_api_web_contents.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,8 +410,7 @@ class WebContents : public gin::Wrappable<WebContents>,
410410
blink::CloneableMessage arguments,
411411
electron::mojom::ElectronBrowser::MessageSyncCallback callback,
412412
content::RenderFrameHost* render_frame_host);
413-
void MessageTo(bool internal,
414-
int32_t web_contents_id,
413+
void MessageTo(int32_t web_contents_id,
415414
const std::string& channel,
416415
blink::CloneableMessage arguments);
417416
void MessageHost(const std::string& channel,

shell/browser/electron_browser_handler_impl.cc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,12 @@ void ElectronBrowserHandlerImpl::MessageSync(bool internal,
8686
}
8787
}
8888

89-
void ElectronBrowserHandlerImpl::MessageTo(bool internal,
90-
int32_t web_contents_id,
89+
void ElectronBrowserHandlerImpl::MessageTo(int32_t web_contents_id,
9190
const std::string& channel,
9291
blink::CloneableMessage arguments) {
9392
api::WebContents* api_web_contents = api::WebContents::From(web_contents());
9493
if (api_web_contents) {
95-
api_web_contents->MessageTo(internal, web_contents_id, channel,
96-
std::move(arguments));
94+
api_web_contents->MessageTo(web_contents_id, channel, std::move(arguments));
9795
}
9896
}
9997

shell/browser/electron_browser_handler_impl.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ class ElectronBrowserHandlerImpl : public mojom::ElectronBrowser,
4444
const std::string& channel,
4545
blink::CloneableMessage arguments,
4646
MessageSyncCallback callback) override;
47-
void MessageTo(bool internal,
48-
int32_t web_contents_id,
47+
void MessageTo(int32_t web_contents_id,
4948
const std::string& channel,
5049
blink::CloneableMessage arguments) override;
5150
void MessageHost(const std::string& channel,

shell/common/api/api.mojom

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ interface ElectronBrowser {
6363
// Emits an event from the |ipcRenderer| JavaScript object in the target
6464
// WebContents's main frame, specified by |web_contents_id|.
6565
MessageTo(
66-
bool internal,
6766
int32 web_contents_id,
6867
string channel,
6968
blink.mojom.CloneableMessage arguments);

shell/renderer/api/electron_api_ipc_renderer.cc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,6 @@ class IPCRenderer : public gin::Wrappable<IPCRenderer>,
172172

173173
void SendTo(v8::Isolate* isolate,
174174
gin_helper::ErrorThrower thrower,
175-
bool internal,
176175
int32_t web_contents_id,
177176
const std::string& channel,
178177
v8::Local<v8::Value> arguments) {
@@ -184,7 +183,7 @@ class IPCRenderer : public gin::Wrappable<IPCRenderer>,
184183
if (!electron::SerializeV8Value(isolate, arguments, &message)) {
185184
return;
186185
}
187-
electron_browser_remote_->MessageTo(internal, web_contents_id, channel,
186+
electron_browser_remote_->MessageTo(web_contents_id, channel,
188187
std::move(message));
189188
}
190189

typings/internal-ambient.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ declare namespace NodeJS {
3535
send(internal: boolean, channel: string, args: any[]): void;
3636
sendSync(internal: boolean, channel: string, args: any[]): any;
3737
sendToHost(channel: string, args: any[]): void;
38-
sendTo(internal: boolean, webContentsId: number, channel: string, args: any[]): void;
38+
sendTo(webContentsId: number, channel: string, args: any[]): void;
3939
invoke<T>(internal: boolean, channel: string, args: any[]): Promise<{ error: string, result: T }>;
4040
postMessage(channel: string, message: any, transferables: MessagePort[]): void;
4141
}

typings/internal-electron.d.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,11 +229,10 @@ declare namespace ElectronInternal {
229229
appIcon: Electron.NativeImage | null;
230230
}
231231

232-
interface IpcRendererInternal extends Electron.IpcRenderer {
232+
interface IpcRendererInternal extends NodeJS.EventEmitter, Pick<Electron.IpcRenderer, 'send' | 'sendSync' | 'invoke'> {
233233
invoke<T>(channel: string, ...args: any[]): Promise<T>;
234234
}
235235

236-
// Internal IPC has _replyInternal and NO reply method
237236
interface IpcMainInternalEvent extends Omit<Electron.IpcMainEvent, 'reply'> {
238237
}
239238

0 commit comments

Comments
 (0)
X Tutup