@@ -44,6 +44,12 @@ export enum TunnelType {
4444 Add = 'Add'
4545}
4646
47+ export enum TunnelCloseReason {
48+ Other = 'Other' ,
49+ User = 'User' ,
50+ AutoForwardEnd = 'AutoForwardEnd' ,
51+ }
52+
4753export interface ITunnelItem {
4854 tunnelType : TunnelType ;
4955 remoteHost : string ;
@@ -426,6 +432,7 @@ export class TunnelModel extends Disposable {
426432 private restoreListener : IDisposable | undefined ;
427433 private knownPortsRestoreValue : string | undefined ;
428434 private unrestoredExtensionTunnels : Map < string , Tunnel > = new Map ( ) ;
435+ private sessionCachedProperties : Map < string , Partial < TunnelProperties > > = new Map ( ) ;
429436
430437 private portAttributesProviders : PortAttributesProvider [ ] = [ ] ;
431438
@@ -500,11 +507,11 @@ export class TunnelModel extends Disposable {
500507 this . _onForwardPort . fire ( this . forwarded . get ( key ) ! ) ;
501508 } ) ) ;
502509 this . _register ( this . tunnelService . onTunnelClosed ( address => {
503- return this . onTunnelClosed ( address ) ;
510+ return this . onTunnelClosed ( address , TunnelCloseReason . Other ) ;
504511 } ) ) ;
505512 }
506513
507- private async onTunnelClosed ( address : { host : string ; port : number } ) {
514+ private async onTunnelClosed ( address : { host : string ; port : number } , reason : TunnelCloseReason ) {
508515 const key = makeAddress ( address . host , address . port ) ;
509516 if ( this . forwarded . has ( key ) ) {
510517 this . forwarded . delete ( key ) ;
@@ -631,7 +638,9 @@ export class TunnelModel extends Disposable {
631638
632639 const key = makeAddress ( tunnelProperties . remote . host , tunnelProperties . remote . port ) ;
633640 this . inProgress . set ( key , true ) ;
634- let tunnel = await this . tunnelService . openTunnel ( addressProvider , tunnelProperties . remote . host , tunnelProperties . remote . port , undefined , localPort , ( ! tunnelProperties . elevateIfNeeded ) ? attributes ?. elevateIfNeeded : tunnelProperties . elevateIfNeeded , tunnelProperties . privacy , attributes ?. protocol ) ;
641+ tunnelProperties = this . mergeCachedAndUnrestoredProperties ( key , tunnelProperties ) ;
642+
643+ const tunnel = await this . tunnelService . openTunnel ( addressProvider , tunnelProperties . remote . host , tunnelProperties . remote . port , undefined , localPort , ( ! tunnelProperties . elevateIfNeeded ) ? attributes ?. elevateIfNeeded : tunnelProperties . elevateIfNeeded , tunnelProperties . privacy , attributes ?. protocol ) ;
635644 if ( tunnel && tunnel . localAddress ) {
636645 const matchingCandidate = mapHasAddressLocalhostOrAllInterfaces < CandidatePort > ( this . _candidates ?? new Map ( ) , tunnelProperties . remote . host , tunnelProperties . remote . port ) ;
637646 const protocol = ( tunnel . protocol ?
@@ -658,37 +667,63 @@ export class TunnelModel extends Disposable {
658667 await this . storeForwarded ( ) ;
659668 await this . showPortMismatchModalIfNeeded ( tunnel , localPort , attributes ) ;
660669 this . _onForwardPort . fire ( newForward ) ;
661- if ( this . unrestoredExtensionTunnels . has ( key ) ) {
662- const updateProps = this . unrestoredExtensionTunnels . get ( key ) ;
663- this . unrestoredExtensionTunnels . delete ( key ) ;
664- if ( updateProps ) {
665- tunnel = await this . forward ( {
666- remote : { host : newForward . remoteHost , port : newForward . remotePort } ,
667- local : newForward . localPort ,
668- name : newForward . name ,
669- privacy : updateProps . privacy ,
670- elevateIfNeeded : true ,
671- } ) ;
672- }
673- }
674670 return tunnel ;
675671 }
676672 this . inProgress . delete ( key ) ;
677673 } else {
678- const newName = attributes ?. label ?? tunnelProperties . name ;
679- if ( newName !== existingTunnel . name ) {
680- existingTunnel . name = newName ;
674+ return this . mergeAttributesIntoExistingTunnel ( existingTunnel , tunnelProperties , attributes ) ;
675+ }
676+
677+ return undefined ;
678+ }
679+
680+ private mergeCachedAndUnrestoredProperties ( key : string , tunnelProperties : TunnelProperties ) : TunnelProperties {
681+ const map = this . unrestoredExtensionTunnels . has ( key ) ? this . unrestoredExtensionTunnels : ( this . sessionCachedProperties . has ( key ) ? this . sessionCachedProperties : undefined ) ;
682+ if ( map ) {
683+ const updateProps = map . get ( key ) ! ;
684+ map . delete ( key ) ;
685+ if ( updateProps ) {
686+ tunnelProperties . name = updateProps . name ?? tunnelProperties . name ;
687+ tunnelProperties . local = ( ( 'local' in updateProps ) ? updateProps . local : ( ( 'localPort' in updateProps ) ? updateProps . localPort : undefined ) ) ?? tunnelProperties . local ;
688+ tunnelProperties . privacy = updateProps . privacy ?? tunnelProperties . privacy ;
689+ }
690+ }
691+ return tunnelProperties ;
692+ }
693+
694+ private async mergeAttributesIntoExistingTunnel ( existingTunnel : Tunnel , tunnelProperties : TunnelProperties , attributes : Attributes | undefined ) {
695+ const newName = attributes ?. label ?? tunnelProperties . name ;
696+ enum MergedAttributeAction {
697+ None = 0 ,
698+ Fire = 1 ,
699+ Reopen = 2
700+ }
701+ let mergedAction = MergedAttributeAction . None ;
702+ if ( newName !== existingTunnel . name ) {
703+ existingTunnel . name = newName ;
704+ mergedAction = MergedAttributeAction . Fire ;
705+ }
706+ // Source of existing tunnel wins so that original source is maintained
707+ if ( ( attributes ?. protocol || ( existingTunnel . protocol !== TunnelProtocol . Http ) ) && ( attributes ?. protocol !== existingTunnel . protocol ) ) {
708+ tunnelProperties . source = existingTunnel . source ;
709+ mergedAction = MergedAttributeAction . Reopen ;
710+ }
711+ // New privacy value wins
712+ if ( tunnelProperties . privacy && ( existingTunnel . privacy !== tunnelProperties . privacy ) ) {
713+ mergedAction = MergedAttributeAction . Reopen ;
714+ }
715+ switch ( mergedAction ) {
716+ case MergedAttributeAction . Fire : {
681717 this . _onForwardPort . fire ( ) ;
718+ break ;
682719 }
683- if ( ( attributes ?. protocol || ( existingTunnel . protocol !== TunnelProtocol . Http ) ) && ( attributes ?. protocol !== existingTunnel . protocol ) ) {
684- await this . close ( existingTunnel . remoteHost , existingTunnel . remotePort ) ;
685- tunnelProperties . source = existingTunnel . source ;
720+ case MergedAttributeAction . Reopen : {
721+ await this . close ( existingTunnel . remoteHost , existingTunnel . remotePort , TunnelCloseReason . User ) ;
686722 await this . forward ( tunnelProperties , attributes ) ;
687723 }
688- return mapHasAddressLocalhostOrAllInterfaces ( this . remoteTunnels , tunnelProperties . remote . host , tunnelProperties . remote . port ) ;
689724 }
690725
691- return undefined ;
726+ return mapHasAddressLocalhostOrAllInterfaces ( this . remoteTunnels , tunnelProperties . remote . host , tunnelProperties . remote . port ) ;
692727 }
693728
694729 async name ( host : string , port : number , name : string ) {
@@ -705,9 +740,18 @@ export class TunnelModel extends Disposable {
705740 }
706741 }
707742
708- async close ( host : string , port : number ) : Promise < void > {
743+ async close ( host : string , port : number , reason : TunnelCloseReason ) : Promise < void > {
744+ const key = makeAddress ( host , port ) ;
745+ const oldTunnel = this . forwarded . get ( key ) ! ;
746+ if ( reason === TunnelCloseReason . AutoForwardEnd ) {
747+ this . sessionCachedProperties . set ( key , {
748+ local : oldTunnel . localPort ,
749+ name : oldTunnel . name ,
750+ privacy : oldTunnel . privacy ,
751+ } ) ;
752+ }
709753 await this . tunnelService . closeTunnel ( host , port ) ;
710- return this . onTunnelClosed ( { host, port } ) ;
754+ return this . onTunnelClosed ( { host, port } , reason ) ;
711755 }
712756
713757 address ( host : string , port : number ) : string | undefined {
@@ -929,7 +973,7 @@ export interface IRemoteExplorerService {
929973 setEditable ( tunnelItem : ITunnelItem | undefined , editId : TunnelEditId , data : IEditableData | null ) : void ;
930974 getEditableData ( tunnelItem : ITunnelItem | undefined , editId ?: TunnelEditId ) : IEditableData | undefined ;
931975 forward ( tunnelProperties : TunnelProperties , attributes ?: Attributes | null ) : Promise < RemoteTunnel | undefined > ;
932- close ( remote : { host : string ; port : number } ) : Promise < void > ;
976+ close ( remote : { host : string ; port : number } , reason : TunnelCloseReason ) : Promise < void > ;
933977 setTunnelInformation ( tunnelInformation : TunnelInformation | undefined ) : void ;
934978 setCandidateFilter ( filter : ( ( candidates : CandidatePort [ ] ) => Promise < CandidatePort [ ] > ) | undefined ) : IDisposable ;
935979 onFoundNewCandidates ( candidates : CandidatePort [ ] ) : void ;
@@ -991,8 +1035,8 @@ class RemoteExplorerService implements IRemoteExplorerService {
9911035 return this . tunnelModel . forward ( tunnelProperties , attributes ) ;
9921036 }
9931037
994- close ( remote : { host : string ; port : number } ) : Promise < void > {
995- return this . tunnelModel . close ( remote . host , remote . port ) ;
1038+ close ( remote : { host : string ; port : number } , reason : TunnelCloseReason ) : Promise < void > {
1039+ return this . tunnelModel . close ( remote . host , remote . port , reason ) ;
9961040 }
9971041
9981042 setTunnelInformation ( tunnelInformation : TunnelInformation | undefined ) : void {
0 commit comments