Skip to content

node, ws: address() method on Server and related classes can return a string #25597

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

Merged
sheetalkamat merged 4 commits into from
May 8, 2018
Merged

node, ws: address() method on Server and related classes can return a string #25597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
85b82d1
node: ClearTextStream hasn't existed for 3 years
thw0rted May 8, 2018
7480fdf
node: move AddressInfo to net module; address() can return string
thw0rted May 8, 2018
8f31e5e
ws: Server.address() can return string (same as net.Server.address etc)
thw0rted May 8, 2018
902921d
Fix some tests that assumed Server.address returns AddressInfo
thw0rted May 8, 2018
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
4 changes: 2 additions & 2 deletions types/net-keepalive/net-keepalive-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const server = Net.createServer((socket) => {
})

server.listen(1337, '127.0.0.1', () => {
const {port, address} = server.address()
const {port, address} = server.address() as Net.AddressInfo
const clientSocket = Net.createConnection({
port, host: address
}, () => {
Expand All @@ -18,4 +18,4 @@ server.listen(1337, '127.0.0.1', () => {
NetKeepAlive.setKeepAliveProbes(clientSocket, 1)
clientSocket.end()
})
})
})
44 changes: 14 additions & 30 deletions types/node/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2666,6 +2666,12 @@ declare module "net" {

type LookupFunction = (hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void;

export interface AddressInfo {
address: string;
family: string;
port: number;
}

export interface SocketConstructorOpts {
fd?: number;
allowHalfOpen?: boolean;
Expand Down Expand Up @@ -2713,7 +2719,7 @@ declare module "net" {
setTimeout(timeout: number, callback?: Function): this;
setNoDelay(noDelay?: boolean): this;
setKeepAlive(enable?: boolean, initialDelay?: number): this;
address(): { port: number; family: string; address: string; };
address(): AddressInfo | string;
unref(): void;
ref(): void;

Expand Down Expand Up @@ -2829,7 +2835,7 @@ declare module "net" {
listen(handle: any, backlog?: number, listeningListener?: Function): this;
listen(handle: any, listeningListener?: Function): this;
close(callback?: Function): this;
address(): { port: number; family: string; address: string; };
address(): AddressInfo | string;
getConnections(cb: (error: Error | null, count: number) => void): void;
ref(): this;
unref(): this;
Expand Down Expand Up @@ -2905,30 +2911,25 @@ declare module "net" {
}

declare module "dgram" {
import * as events from "events";
import { AddressInfo } from "net";
import * as dns from "dns";
import * as events from "events";

interface RemoteInfo {
address: string;
family: string;
port: number;
}

interface AddressInfo {
export interface RemoteInfo {
address: string;
family: string;
port: number;
}

interface BindOptions {
export interface BindOptions {
port: number;
address?: string;
exclusive?: boolean;
}

type SocketType = "udp4" | "udp6";

interface SocketOptions {
export interface SocketOptions {
type: SocketType;
reuseAddr?: boolean;
recvBufferSize?: number;
Expand All @@ -2947,7 +2948,7 @@ declare module "dgram" {
bind(callback?: () => void): void;
bind(options: BindOptions, callback?: Function): void;
close(callback?: () => void): void;
address(): AddressInfo;
address(): AddressInfo | string;
setBroadcast(flag: boolean): void;
setTTL(ttl: number): void;
setMulticastTTL(ttl: number): void;
Expand Down Expand Up @@ -5624,23 +5625,6 @@ declare module "tls" {
prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
}

export interface ClearTextStream extends stream.Duplex {
authorized: boolean;
authorizationError: Error;
getPeerCertificate(): any;
getCipher: {
name: string;
version: string;
};
address: {
port: number;
family: string;
address: string;
};
remoteAddress: string;
remotePort: number;
}

export interface SecurePair {
encrypted: any;
cleartext: any;
Expand Down
19 changes: 8 additions & 11 deletions types/node/node-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1551,7 +1551,7 @@ namespace dgram_tests {
ds.bind(4123, 'localhost', () => { });
ds.bind(4123, () => { });
ds.bind(() => { });
var ai: dgram.AddressInfo = ds.address();
const addr: net.AddressInfo | string = ds.address();
ds.send(new Buffer("hello"), 0, 5, 5000, "127.0.0.1", (error: Error, bytes: number): void => {
});
ds.send(new Buffer("hello"), 5000, "127.0.0.1");
Expand All @@ -1564,7 +1564,7 @@ namespace dgram_tests {
let _boolean: boolean;
let _err: Error;
let _str: string;
let _rinfo: dgram.AddressInfo;
let _rinfo: net.AddressInfo;
/**
* events.EventEmitter
* 1. close
Expand All @@ -1580,7 +1580,7 @@ namespace dgram_tests {
_socket = _socket.addListener("listening", () => { });
_socket = _socket.addListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_boolean = _socket.emit("close");
Expand All @@ -1595,7 +1595,7 @@ namespace dgram_tests {
_socket = _socket.on("listening", () => { });
_socket = _socket.on("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.once("close", () => { });
Expand All @@ -1605,7 +1605,7 @@ namespace dgram_tests {
_socket = _socket.once("listening", () => { });
_socket = _socket.once("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.prependListener("close", () => { });
Expand All @@ -1615,7 +1615,7 @@ namespace dgram_tests {
_socket = _socket.prependListener("listening", () => { });
_socket = _socket.prependListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.prependOnceListener("close", () => { });
Expand All @@ -1625,7 +1625,7 @@ namespace dgram_tests {
_socket = _socket.prependOnceListener("listening", () => { });
_socket = _socket.prependOnceListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});
}

Expand Down Expand Up @@ -2730,10 +2730,7 @@ namespace net_tests {
server = server.close((...args: any[]) => { });

// test the types of the address object fields
let address = server.address();
address.port = 1234;
address.family = "ipv4";
address.address = "127.0.0.1";
let address: net.AddressInfo | string = server.address();
}

{
Expand Down
44 changes: 14 additions & 30 deletions types/node/v9/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2657,6 +2657,12 @@ declare module "net" {

type LookupFunction = (hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void;

export interface AddressInfo {
address: string;
family: string;
port: number;
}

export interface SocketConstructorOpts {
fd?: number;
allowHalfOpen?: boolean;
Expand Down Expand Up @@ -2704,7 +2710,7 @@ declare module "net" {
setTimeout(timeout: number, callback?: Function): this;
setNoDelay(noDelay?: boolean): this;
setKeepAlive(enable?: boolean, initialDelay?: number): this;
address(): { port: number; family: string; address: string; };
address(): AddressInfo | string;
unref(): void;
ref(): void;

Expand Down Expand Up @@ -2820,7 +2826,7 @@ declare module "net" {
listen(handle: any, backlog?: number, listeningListener?: Function): this;
listen(handle: any, listeningListener?: Function): this;
close(callback?: Function): this;
address(): { port: number; family: string; address: string; };
address(): AddressInfo | string;
getConnections(cb: (error: Error | null, count: number) => void): void;
ref(): this;
unref(): this;
Expand Down Expand Up @@ -2896,30 +2902,25 @@ declare module "net" {
}

declare module "dgram" {
import * as events from "events";
import { AddressInfo } from "net";
import * as dns from "dns";
import * as events from "events";

interface RemoteInfo {
address: string;
family: string;
port: number;
}

interface AddressInfo {
export interface RemoteInfo {
address: string;
family: string;
port: number;
}

interface BindOptions {
export interface BindOptions {
port: number;
address?: string;
exclusive?: boolean;
}

type SocketType = "udp4" | "udp6";

interface SocketOptions {
export interface SocketOptions {
type: SocketType;
reuseAddr?: boolean;
recvBufferSize?: number;
Expand All @@ -2938,7 +2939,7 @@ declare module "dgram" {
bind(callback?: () => void): void;
bind(options: BindOptions, callback?: Function): void;
close(callback?: () => void): void;
address(): AddressInfo;
address(): AddressInfo | string;
setBroadcast(flag: boolean): void;
setTTL(ttl: number): void;
setMulticastTTL(ttl: number): void;
Expand Down Expand Up @@ -5139,23 +5140,6 @@ declare module "tls" {
prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
}

export interface ClearTextStream extends stream.Duplex {
authorized: boolean;
authorizationError: Error;
getPeerCertificate(): any;
getCipher: {
name: string;
version: string;
};
address: {
port: number;
family: string;
address: string;
};
remoteAddress: string;
remotePort: number;
}

export interface SecurePair {
encrypted: any;
cleartext: any;
Expand Down
19 changes: 8 additions & 11 deletions types/node/v9/node-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1551,7 +1551,7 @@ namespace dgram_tests {
ds.bind(4123, 'localhost', () => { });
ds.bind(4123, () => { });
ds.bind(() => { });
var ai: dgram.AddressInfo = ds.address();
const addr: net.AddressInfo | string = ds.address();
ds.send(new Buffer("hello"), 0, 5, 5000, "127.0.0.1", (error: Error, bytes: number): void => {
});
ds.send(new Buffer("hello"), 5000, "127.0.0.1");
Expand All @@ -1564,7 +1564,7 @@ namespace dgram_tests {
let _boolean: boolean;
let _err: Error;
let _str: string;
let _rinfo: dgram.AddressInfo;
let _rinfo: net.AddressInfo;
/**
* events.EventEmitter
* 1. close
Expand All @@ -1580,7 +1580,7 @@ namespace dgram_tests {
_socket = _socket.addListener("listening", () => { });
_socket = _socket.addListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_boolean = _socket.emit("close");
Expand All @@ -1595,7 +1595,7 @@ namespace dgram_tests {
_socket = _socket.on("listening", () => { });
_socket = _socket.on("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.once("close", () => { });
Expand All @@ -1605,7 +1605,7 @@ namespace dgram_tests {
_socket = _socket.once("listening", () => { });
_socket = _socket.once("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.prependListener("close", () => { });
Expand All @@ -1615,7 +1615,7 @@ namespace dgram_tests {
_socket = _socket.prependListener("listening", () => { });
_socket = _socket.prependListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});

_socket = _socket.prependOnceListener("close", () => { });
Expand All @@ -1625,7 +1625,7 @@ namespace dgram_tests {
_socket = _socket.prependOnceListener("listening", () => { });
_socket = _socket.prependOnceListener("message", (msg, rinfo) => {
let _msg: Buffer = msg;
let _rinfo: dgram.AddressInfo = rinfo;
let _rinfo: net.AddressInfo = rinfo;
});
}

Expand Down Expand Up @@ -2730,10 +2730,7 @@ namespace net_tests {
server = server.close((...args: any[]) => { });

// test the types of the address object fields
let address = server.address();
address.port = 1234;
address.family = "ipv4";
address.address = "127.0.0.1";
let address: net.AddressInfo | string = server.address();
}

{
Expand Down
3 changes: 2 additions & 1 deletion types/smtp-server/smtp-server-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { AddressInfo } from 'net';
import { SMTPServer, SMTPServerAddress, SMTPServerAuthentication, SMTPServerAuthenticationResponse, SMTPServerOptions, SMTPServerSession } from 'smtp-server';
import { Readable } from 'stream';

Expand Down Expand Up @@ -71,6 +72,6 @@ server.on('close', () => {
});

server.listen(port, () => {
const address = server.server.address();
const address = server.server.address() as AddressInfo;
console.log(`Listening on [${address.address}]:${address.port}`);
});
4 changes: 3 additions & 1 deletion types/swaggerize-express/swaggerize-express-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import http = require('http');
import express = require('express');
import swaggerize = require('swaggerize-express');
import { AddressInfo } from 'net';

const api = {
swagger: "2.0",
Expand Down Expand Up @@ -50,5 +51,6 @@ app.use(swaggerize(<swaggerize.Options>{
}));

var server = app.listen(18888, 'localhost', function () {
(<swaggerize.SwaggerizedExpress>app).swagger.api.host = server.address().address + ':' + server.address().port;
const addr = server.address() as AddressInfo;
(<swaggerize.SwaggerizedExpress>app).swagger.api.host = addr.address + ':' + addr.port;
});
Loading