a
    ø£BeŸ.  ã                   @   sb  d Z ddlZddlZddlZddlZddlZddlZddlmZm	Z	 ddl
mZ ddlmZ ddlmZ ddlmZmZmZ ddlmZ dd	lmZmZ dd
lmZmZ ddlmZ ddlmZm Z  ddl!m"Z" ddl#m$Z$ ej%de&dd� e'e (dd¡ƒZ)G dd„ dee ƒZ*G dd„ deƒZ+G dd„ deƒZ,ddl-m.Z. ddl/m0Z0 de. e*fde0 e,fgZ1dS )zGateway API handlers.é    N)ÚOptionalÚcast)ÚSession)Úweb)ÚFuture)Újson_decodeÚ
url_escapeÚutf8)ÚHTTPRequest)ÚIOLoopÚPeriodicCallback)ÚWebSocketHandlerÚwebsocket_connect)ÚLoggingConfigurableé   )Ú
APIHandlerÚJupyterHandler)Úurl_path_joiné   )ÚGatewayClientzhThe jupyter_server.gateway.handlers module is deprecated and will not be supported in Jupyter Server 3.0)Ú
stacklevelÚGATEWAY_WS_PING_INTERVAL_SECSZ30c                       s˜   e Zd ZdZdZdZdZdZddd„Zdd„ Z	dd„ Z
d	d
„ Zdd„ Z‡ fdd„Zdd„ Zdd„ Zdd„ Zd‡ fdd„	Z‡ fdd„Zedd„ ƒZ‡  ZS )ÚWebSocketChannelsHandlerz$Gateway web socket channels handler.Nc                 C   s   t  | |¡S )zCheck origin for the socket.)r   Úcheck_origin)ÚselfÚorigin© r   úb/home/yuhw/wc/wire-cell-python/wcpy/lib/python3.9/site-packages/jupyter_server/gateway/handlers.pyr   ,   s    z%WebSocketChannelsHandler.check_originc                 C   s   dS )zVUndo the set_default_headers in JupyterHandler which doesn't make sense for websocketsNr   ©r   r   r   r   Úset_default_headers0   s    z,WebSocketChannelsHandler.set_default_headersc                 C   s   i S )z+Get the compression options for the socket.r   r   r   r   r   Úget_compression_options4   s    z0WebSocketChannelsHandler.get_compression_optionsc                 C   sZ   | j du r | j d¡ t d¡‚|  dd¡rJ| jdus:J ‚|  d¡| j_n| j d¡ dS )z™Run before finishing the GET request

        Extend this method to add logic that should fire before
        the websocket finishes completing.
        Nz*Couldn't authenticate WebSocket connectioni“  Z
session_idzNo session ID specified)Zcurrent_userÚlogÚwarningr   Ú	HTTPErrorZget_argumentÚsessionr   r   r   r   Úauthenticate9   s    

z%WebSocketChannelsHandler.authenticatec                 C   s6   | j  d| jj¡ t| jd�| _tt 	¡ j
d�| _dS )zInitialize the socket.z$Initializing websocket connection %s)Úconfig)Zgateway_urlN)r!   ÚdebugÚrequestÚpathr   r&   r$   ÚGatewayWebSocketClientr   ÚinstanceÚurlÚgatewayr   r   r   r   Ú
initializeJ   s    z#WebSocketChannelsHandler.initializec                 �   s2   |   ¡  || _||d< tƒ j|i |¤ŽI dH  dS )zGet the socket.Ú	kernel_idN)r%   r/   ÚsuperÚget©r   r/   ÚargsÚkwargs©Ú	__class__r   r   r1   P   s    zWebSocketChannelsHandler.getc                 C   s0   | j du r"| jdur"| j ¡  dS |  d¡ dS )zSend a ping to the socket.Nó    )Úws_connectionÚping_callbackÚstopZpingr   r   r   r   Ú	send_pingW   s    
z"WebSocketChannelsHandler.send_pingc                 O   sF   t | jtd ƒ| _| j ¡  | jdus*J ‚| jj|| j|  ¡ d� dS )z_Handle web socket connection open to notebook server and delegate to gateway web socket handleriè  N)r/   Úmessage_callbackZcompression_options)	r   r;   r   r9   Ústartr-   Úon_openÚwrite_messager    r2   r   r   r   Úopen_   s    
ýzWebSocketChannelsHandler.openc                 C   s   | j dusJ ‚| j  |¡ dS )z.Forward message to gateway web socket handler.N)r-   Ú
on_message)r   Úmessager   r   r   rA   k   s    z#WebSocketChannelsHandler.on_messageFc                    s\   | j r&t|tƒrd}tƒ j||d� n2| j tj¡rXt	 
tt|ƒƒ¡}| j d|› �¡ dS )zdSend message back to notebook client.  This is called via callback from self.gateway._read_messages.T)Úbinaryz?Notebook client closed websocket connection - message dropped: N)r8   Ú
isinstanceÚbytesr0   r?   r!   ÚisEnabledForÚloggingÚDEBUGr   Ú_get_message_summaryr   r	   r'   )r   rB   rC   Zmsg_summaryr5   r   r   r?   p   s    
ÿz&WebSocketChannelsHandler.write_messagec                    s8   | j  d| jj¡ | jdus J ‚| j ¡  tƒ  ¡  dS )zHandle a closing socket.zClosing websocket connection %sN)r!   r'   r(   r)   r-   Úon_closer0   r   r5   r   r   rJ   |   s    
z!WebSocketChannelsHandler.on_closec                 C   sˆ   g }| d }|  d|› �¡ |dkr>|  d | d d ¡¡ n@|dkrt|  d | d d	 | d d
 | d d ¡¡ n
|  d¡ d |¡S )zGet a summary of a message.Úmsg_typeztype: Ústatusz, state: {}ÚcontentZexecution_stateÚerrorz
, {}:{}:{}ZenameZevalueÚ	tracebackz, ...Ú )ÚappendÚformatÚjoin)rB   ÚsummaryZmessage_typer   r   r   rI   ƒ   s    


ýÿ
z-WebSocketChannelsHandler._get_message_summary)N)F)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r$   r-   r/   r9   r   r   r    r%   r.   r1   r;   r@   rA   r?   rJ   ÚstaticmethodrI   Ú__classcell__r   r   r5   r   r   $   s$   
r   c                       s`   e Zd ZdZ‡ fdd„Zdd„ Zdd„ Zdd	„ Zd
d„ Zdd„ Z	dd„ Z
dd„ Zdd„ Z‡  ZS )r*   z;Proxy web socket connection to a kernel/enterprise gateway.c                    s.   t ƒ  ¡  d| _d| _tƒ | _d| _d| _dS )z)Initialize the gateway web socket client.NFr   )r0   Ú__init__r/   Úwsr   Ú	ws_futureÚdisconnectedÚretry)r   r4   r5   r   r   r[   �   s    
zGatewayWebSocketClient.__init__c                 ƒ   s°   dˆ_ |ˆ_t ¡ }|jdus"J ‚t|j|jt|ƒdƒ}ˆj 	d|› �¡ i }|j
f i |¤Ž}t|fi |¤Ž}ttt|ƒƒˆ_ˆj ˆj¡ t ¡ }| ˆj‡ ‡fdd„¡ dS )zConnect to the socket.NZchannelszConnecting to c                    s
   ˆ  ˆ ¡S ©N)Ú_read_messages©Úfuture©r<   r   r   r   Ú<lambda>½   r7   z1GatewayWebSocketClient._connect.<locals>.<lambda>)r\   r/   r   r+   Úws_urlr   Zkernels_endpointr   r!   ÚinfoZload_connection_argsr
   r   r   r   r]   Úadd_done_callbackÚ_connection_doner   ÚcurrentÚ
add_future)r   r/   r<   Úclientrf   r4   r(   Úloopr   rd   r   Ú_connect¦   s$    üzGatewayWebSocketClient._connectc                 C   sX   | j s8| ¡ du r8| ¡ | _d| _| j d| j› �¡ n| j d | j	t
 ¡ j¡¡ dS )zHandle a finished connection.Nr   zConnection is ready: ws: z‹Websocket connection has been closed via client disconnect or due to error.  Kernel with ID '{}' may not be terminated on GatewayClient: {})r^   Ú	exceptionÚresultr\   r_   r!   r'   r"   rR   r/   r   r+   r,   )r   Úfutr   r   r   ri   ¿   s    ÿ
ÿ
þÿz'GatewayWebSocketClient._connection_donec                 C   sH   d| _ | jdur| j ¡  n(| j ¡ sD| j ¡  | j d| j › �¡ dS )zHandle a disconnect.TNz-_disconnect: future cancelled, disconnected: )r^   r\   Úcloser]   ÚdoneÚcancelr!   r'   r   r   r   r   Ú_disconnectÏ   s    


z"GatewayWebSocketClient._disconnectc              
   Ã   s:  | j dur’d}| js’z| j  ¡ I dH }W n6 ty^ } z| j d|› �¡ W Y d}~n
d}~0 0 |du r„| js’| j d| j› �¡ q’||ƒ q q’q | j�s6| jt	 
¡ jk �r6t dd¡d }tt	 
¡ jd| j  t	 
¡ jƒ| }|  jd7  _| j d	|| jt	 
¡ j| j¡ t |¡I dH  t ¡ }| | j| j|¡ dS )
z"Read messages from gateway server.Nz*Exception reading message from websocket: zLost connection to Gateway: é
   éd   g{®Gáz„?r   r   zKAttempting to re-establish the connection to Gateway in %s secs (%s/%s): %s)r\   r^   Zread_messageÚ	Exceptionr!   rN   r"   r/   r_   r   r+   Zgateway_retry_maxÚrandomÚrandintÚminZgateway_retry_intervalZgateway_retry_interval_maxrg   ÚasyncioÚsleepr   rj   Úspawn_callbackrn   )r   ÚcallbackrB   ÚeÚjitterZretry_intervalrm   r   r   r   ra   Ú   sJ    
ÿÿþüÿûz%GatewayWebSocketClient._read_messagesc                 K   s   t  ¡ }| | j||¡ dS )z2Web socket connection open against gateway server.N)r   rj   r~   rn   )r   r/   r<   r4   rm   r   r   r   r>     s    zGatewayWebSocketClient.on_openc                    s:   ˆj du r,t ¡ }| ˆj‡ ‡fdd„¡ n
ˆ ˆ ¡ dS )úSend message to gateway server.Nc                    s
   ˆ  ˆ ¡S r`   )Ú_write_messagerb   ©rB   r   r   r   re     r7   z3GatewayWebSocketClient.on_message.<locals>.<lambda>)r\   r   rj   rk   r]   rƒ   )r   rB   rm   r   r„   r   rA   
  s    
z!GatewayWebSocketClient.on_messagec              
   C   s\   z | j s| jdur| j |¡ W n6 tyV } z| j d|› �¡ W Y d}~n
d}~0 0 dS )r‚   Nz(Exception writing message to websocket: )r^   r\   r?   rx   r!   rN   )r   rB   r€   r   r   r   rƒ     s
    z%GatewayWebSocketClient._write_messagec                 C   s   |   ¡  dS )zWeb socket closed event.N)ru   r   r   r   r   rJ     s    zGatewayWebSocketClient.on_close)rU   rV   rW   rX   r[   rn   ri   ru   ra   r>   rA   rƒ   rJ   rZ   r   r   r5   r   r*   š   s   	+r*   c                   @   s    e Zd ZdZejddd„ƒZdS )ÚGatewayResourceHandlerzWRetrieves resources for specific kernelspec definitions from kernel/enterprise gateway.Tc                 Ã   s^   d}| j }| ||¡I dH }|du r:| j d ||¡¡ nt |¡d pJd}| j||d� dS )z(Get a gateway resource by name and path.NzWKernelspec resource '{}' for '{}' not found.  Gateway may not support resource serving.r   z
text/plain)Zset_content_type)Zkernel_spec_managerZget_kernel_spec_resourcer!   r"   rR   Ú	mimetypesÚ
guess_typeÚfinish)r   Zkernel_namer)   Zinclude_bodyÚmimetypeZksmZkernel_spec_resr   r   r   r1   "  s    ÿ
ÿÿzGatewayResourceHandler.getN)T)rU   rV   rW   rX   r   Úauthenticatedr1   r   r   r   r   r…     s   r…   )Ú_kernel_id_regex)Úkernel_name_regexz/api/kernels/%s/channelsz/kernelspecs/%s/(?P<path>.*))2rX   r|   rG   r†   Úosry   ÚwarningsÚtypingr   r   Zjupyter_client.sessionr   Útornador   Ztornado.concurrentr   Ztornado.escaper   r   r	   Ztornado.httpclientr
   Ztornado.ioloopr   r   Ztornado.websocketr   r   Ztraitlets.config.configurabler   Zbase.handlersr   r   Úutilsr   Zmanagersr   ÚwarnÚDeprecationWarningÚintÚgetenvr   r   r*   r…   Zservices.kernels.handlersr‹   Zservices.kernelspecs.handlersrŒ   Zdefault_handlersr   r   r   r   Ú<module>   sB   ýv 

þ