-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapp.py
More file actions
6110 lines (5543 loc) · 258 KB
/
app.py
File metadata and controls
6110 lines (5543 loc) · 258 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Databricks API Explorer -- main Dash application.
This single module defines the complete UI layout (sidebar, topbar,
response viewer, connection panel) and all server- / client-side
callbacks that drive the explorer.
Run modes:
Local:
Auth via Databricks CLI profile (SSO / OAuth / PAT) or a
manually entered workspace URL + token.
Databricks App:
Auth via On-Behalf-Of (OBO) using the
``x-forwarded-access-token`` header injected by the Databricks
Apps proxy.
Key internal data flows are documented in the *Architecture* and
*Key Patterns* sections of ``CLAUDE.md``.
"""
import json
import os
import subprocess
import threading
import time
import requests
from typing import Any, Dict, List, Optional
import dash
import dash_bootstrap_components as dbc
from dash import ALL, Input, Output, State, ctx, dcc, html, no_update, set_props
from flask import request as flask_request
from api_catalog import (
ACCOUNT_API_CATALOG,
API_CATALOG,
COMMAND_API_CATALOG,
ENDPOINT_MAP,
TOTAL_ACCOUNT_CATEGORIES,
TOTAL_ACCOUNT_ENDPOINTS,
TOTAL_CATEGORIES,
TOTAL_COMMAND_CATEGORIES,
TOTAL_COMMAND_ENDPOINTS,
TOTAL_ENDPOINTS,
detect_cloud,
extract_chips,
get_category_doc_url,
get_doc_url,
get_endpoint_by_id,
)
from auth import (
DATABRICKS_PROFILE,
IS_DATABRICKS_APP,
_get_local_config,
get_account_id,
get_cli_profiles,
get_current_user_info,
get_host,
get_metastore_name,
get_sp_token,
get_workspace_name,
make_api_call,
resolve_account_connection,
resolve_local_connection,
)
from version import VERSION
# Category name → accordion item-id, used by search to expand matching sections
_WS_CAT_INDEX = {name: f"item-{i}" for i, name in enumerate(API_CATALOG)}
_ACC_CAT_INDEX = {name: f"item-{i}" for i, name in enumerate(ACCOUNT_API_CATALOG)}
_CMD_CAT_INDEX = {name: f"item-{i}" for i, name in enumerate(COMMAND_API_CATALOG)}
# ── Dash init ─────────────────────────────────────────────────────────────────
app = dash.Dash(
__name__,
external_stylesheets=[dbc.themes.CYBORG, dbc.icons.BOOTSTRAP],
title="Databricks API Explorer",
suppress_callback_exceptions=True,
meta_tags=[{"name": "viewport", "content": "width=device-width, initial-scale=1"}],
)
server = app.server
app.index_string = '''<!DOCTYPE html>
<html>
<head>
{%metas%}
<title>{%title%}</title>
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' width='64' height='64' viewBox='0 0 64 64'><rect width='64' height='64' rx='12' fill='%231B1B1B'/><g transform='translate(12,4) scale(0.133)'><path d='M283.923 136.449L150.144 213.624L6.88995 131.168L0 134.982V194.844L150.144 281.115L283.923 204.234V235.926L150.144 313.1L6.88995 230.644L0 234.458V244.729L150.144 331L300 244.729V184.867L293.11 181.052L150.144 263.215L16.0766 186.334V154.643L150.144 231.524L300 145.253V86.2713L292.536 81.8697L150.144 163.739L22.9665 90.9663L150.144 17.8998L254.641 78.055L263.828 72.773V65.4371L150.144 0L0 86.2713V95.6613L150.144 181.933L283.923 104.758V136.449Z' fill='%23FF3621'/></g><text x='32' y='56' text-anchor='middle' font-family='system-ui,sans-serif' font-size='18' font-weight='800' fill='%23FFFFFF' letter-spacing='1'>API</text></svg>">
{%css%}
</head>
<body>
{%app_entry%}
<footer>
{%config%}
{%scripts%}
{%renderer%}
</footer>
</body>
</html>'''
# Default connection config
_DEFAULT_CONN = {"mode": "sp"} if IS_DATABRICKS_APP else {"mode": "profile", "profile": DATABRICKS_PROFILE}
# ── Flask route: serve ~/.databrickscfg in the browser ────────────────────────
@server.route("/open-databrickscfg")
def _serve_databrickscfg():
"""Serve ``~/.databrickscfg`` as a syntax-highlighted HTML page."""
import html as _html
cfg_path = os.path.expanduser("~/.databrickscfg")
try:
with open(cfg_path, encoding="utf-8") as f:
content = f.read()
except FileNotFoundError:
content = "# File not found: ~/.databrickscfg"
escaped = _html.escape(content)
highlighted = _highlight_ini(escaped)
page = (
"<!DOCTYPE html><html><head><title>~/.databrickscfg</title>"
"<style>"
"body{background:#0d1117;color:#c9d1d9;font-family:'JetBrains Mono',monospace;"
"padding:24px;margin:0;font-size:13px;line-height:1.6}"
"pre{white-space:pre-wrap;word-break:break-all;margin:0}"
".comment{color:#6a737d}.section{color:#79c0ff;font-weight:600}"
".key{color:#d2a8ff}.val{color:#a5d6ff}"
".toolbar{display:flex;align-items:center;justify-content:space-between;"
"margin-bottom:16px}"
"h1{font-size:16px;color:#58a6ff;margin:0;font-weight:500}"
".edit-btn{background:rgba(88,166,255,0.12);color:#58a6ff;border:1px solid "
"rgba(88,166,255,0.3);border-radius:6px;padding:6px 14px;font-size:12px;"
"font-family:inherit;cursor:pointer;text-decoration:none;display:inline-flex;"
"align-items:center;gap:6px;transition:all 0.15s}"
".edit-btn:hover{background:rgba(88,166,255,0.22);border-color:#58a6ff;"
"color:#79c0ff}"
".edit-btn svg{width:14px;height:14px;fill:currentColor}"
"</style></head><body>"
'<div class="toolbar">'
"<h1>~/.databrickscfg</h1>"
'<a class="edit-btn" href="/open-databrickscfg-editor" target="_self">'
'<svg viewBox="0 0 16 16"><path d="M12.854.146a.5.5 0 00-.707 0L10.5 1.793 '
"14.207 5.5l1.647-1.646a.5.5 0 000-.708l-3-3zM13.5 6.207L9.793 2.5 "
"3.622 8.671a.5.5 0 00-.121.196l-1.47 4.413a.5.5 0 00.633.633l4.413-1.47"
'a.5.5 0 00.196-.121L13.5 6.207z"/></svg>'
"Open in editor</a>"
"</div>"
"<pre>" + highlighted + "</pre>"
"</body></html>"
)
from flask import Response
return Response(page, status=200, content_type="text/html")
@server.route("/open-databrickscfg-editor")
def _open_in_editor():
"""Open ``~/.databrickscfg`` in the user's default text editor."""
import platform
import subprocess as _sp
cfg_path = os.path.expanduser("~/.databrickscfg")
system = platform.system()
try:
if system == "Darwin":
_sp.Popen(["open", cfg_path])
elif system == "Windows":
os.startfile(cfg_path)
else:
_sp.Popen(["xdg-open", cfg_path])
except Exception:
pass
from flask import redirect
return redirect("/open-databrickscfg")
def _highlight_ini(text: str) -> str:
"""Add syntax highlighting spans to escaped INI content."""
lines = []
for line in text.split("\n"):
stripped = line.lstrip()
if stripped.startswith("#") or stripped.startswith(";"):
lines.append(f'<span class="comment">{line}</span>')
elif stripped.startswith("["):
lines.append(f'<span class="section">{line}</span>')
elif "=" in line:
key, _, val = line.partition("=")
lines.append(f'<span class="key">{key}</span>=<span class="val">{val}</span>')
else:
lines.append(line)
return "\n".join(lines)
# ── JSON Syntax Highlighter ───────────────────────────────────────────────────
# ── Pagination helpers ────────────────────────────────────────────────────────
_SKIP_LIST_KEYS = frozenset({"schemas"})
# Server-side state for background "Load All" pagination
_load_all_state: Dict[str, Any] = {
"running": False,
"pages": 0,
"total_items": 0,
"items": [],
"done": False,
"error": None,
"list_key": None,
"initial_data": {},
"last_req": {},
"elapsed_ms": 0,
}
def _detect_has_more(data: Any) -> bool:
"""Check whether a paginated response has more pages to fetch.
Handles two pagination styles:
* ``has_more`` flag (standard Databricks APIs).
* SCIM-style ``totalResults`` / ``startIndex`` / ``itemsPerPage``.
"""
if not isinstance(data, dict):
return False
if data.get("has_more"):
return True
# SCIM pagination: totalResults, startIndex, itemsPerPage
total = data.get("totalResults")
start = data.get("startIndex")
per_page = data.get("itemsPerPage")
if isinstance(total, int) and isinstance(start, int) and isinstance(per_page, int):
return (start + per_page - 1) < total
return False
def _detect_next_page_token(data: Any) -> Optional[str]:
"""Extract a ``next_page_token`` from a paginated API response.
Args:
data: Parsed JSON response body.
Returns:
The token string when more pages exist, otherwise ``None``.
"""
if not isinstance(data, dict):
return None
token = data.get("next_page_token")
return token if token and isinstance(token, str) else None
def _find_list_key(data: dict) -> Optional[str]:
"""Identify the top-level key that holds the item array in a response.
Skips keys in :data:`_SKIP_LIST_KEYS` (e.g. ``"schemas"``) to
avoid false positives.
Args:
data: A parsed JSON response dict.
Returns:
The first key whose value is a ``list``, or ``None``.
"""
for k, v in data.items():
if isinstance(v, list) and k not in _SKIP_LIST_KEYS:
return k
return None
# ── JSON Tree Viewer ──────────────────────────────────────────────────────────
_TREE_CSS = (
"@import url('https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500&display=swap');"
":root{"
"--t-bg:#050810;--t-text:#94a3b8;--t-text-hi:#e2e8f0;--t-muted:#475569;"
"--t-border:rgba(255,255,255,.07);--t-accent:#00d4ff;"
"--t-key:#60a5fa;--t-str:#86efac;--t-num:#fbbf24;--t-bool:#c084fc;--t-null:#94a3b8;"
"--t-punc:#64748b;--t-btn-bg:rgba(0,212,255,.07);--t-btn-border:rgba(0,212,255,.2);"
"--t-input-bg:rgba(255,255,255,.06);--t-input-border:rgba(255,255,255,.12);"
"--t-scroll:rgba(255,255,255,.12);--t-tip-bg:#1e293b;--t-mark:#7c3aed;--t-mark-cur:#f59e0b;"
"}"
"html{margin:0;padding:0;background:var(--t-bg);height:100%;overflow:hidden;}"
"body{margin:0;padding:0;background:var(--t-bg);height:100%;overflow:auto;}"
"body{font-family:'JetBrains Mono','Fira Code',ui-monospace,monospace;"
"font-size:12px;line-height:1.7;color:var(--t-text);}"
"#toolbar{position:sticky;top:0;background:var(--t-bg);border-bottom:1px solid var(--t-border);"
"padding:5px 14px;display:flex;align-items:center;gap:6px;z-index:10;}"
"#depth-label{color:var(--t-muted);font-size:11px;font-style:italic;flex:1;}"
".depth-btn{background:var(--t-btn-bg);border:1px solid var(--t-btn-border);color:var(--t-accent);"
"border-radius:4px;width:22px;height:22px;font-size:15px;line-height:1;cursor:pointer;"
"display:inline-flex;align-items:center;justify-content:center;padding:0;flex-shrink:0;}"
".depth-btn:hover{opacity:.85;}"
".depth-btn:disabled{opacity:.3;cursor:default;}"
"#root{padding:10px 14px;}"
".tree-node{display:block;}"
".node-header{display:block;}"
".toggle{display:inline-block;width:14px;text-align:center;cursor:pointer;"
"user-select:none;color:var(--t-muted);transition:color .1s;}"
".toggle:hover{color:var(--t-accent);}"
".preview{color:var(--t-muted);font-style:italic;}"
".tree-node:not(.collapsed)>.node-header>.preview{display:none;}"
".children{margin-left:20px;display:block;}"
".close-line{display:block;}"
".tree-node.collapsed>.children,.tree-node.collapsed>.close-line{display:none;}"
".kv,.item{display:block;}"
".jk{color:var(--t-key)}.jv{color:var(--t-str)}.jn{color:var(--t-num)}"
".jb{color:var(--t-bool)}.jbn{color:var(--t-null)}.jp{color:var(--t-punc)}"
".id-link{cursor:pointer;border-bottom:1px dashed currentColor;}"
".id-link:hover{color:var(--t-accent)!important;border-bottom-color:var(--t-accent);}"
".jts{position:relative;cursor:default;border-bottom:1px dotted var(--t-num);}"
".jts:hover .ts-tip{visibility:visible;opacity:1;}"
".ts-tip{visibility:hidden;opacity:0;position:absolute;bottom:calc(100% + 4px);left:50%;"
"transform:translateX(-50%);background:var(--t-tip-bg);color:var(--t-text-hi);font-size:11px;"
"padding:4px 8px;border-radius:4px;white-space:pre;pointer-events:none;line-height:1.5;"
"border:1px solid var(--t-btn-border);z-index:100;"
"transition:opacity .15s;}"
"::-webkit-scrollbar{width:6px;height:6px}"
"::-webkit-scrollbar-thumb{background:var(--t-scroll);border-radius:3px}"
"::-webkit-scrollbar-track{background:transparent}"
"*{scrollbar-width:thin;scrollbar-color:var(--t-scroll) transparent}"
"#search-box{flex:1;background:var(--t-input-bg);border:1px solid var(--t-input-border);"
"color:var(--t-text-hi);border-radius:4px;padding:2px 8px;font-family:inherit;font-size:11px;"
"outline:none;min-width:80px;}"
"#search-box:focus{border-color:var(--t-btn-border);}"
"#search-box::placeholder{color:var(--t-muted);}"
"#sc{color:var(--t-text);font-size:11px;white-space:nowrap;flex-shrink:0;min-width:44px;text-align:center;}"
"mark.sh{background:var(--t-mark);color:#fff;border-radius:2px;padding:0 1px;}"
"mark.sh.cur{background:var(--t-mark-cur);color:#050810;}"
".sep{width:1px;height:16px;background:var(--t-scroll);flex-shrink:0;}"
".sql-link-wrap{display:inline;}"
".sql-link-btn{display:inline-block;margin-left:8px;cursor:pointer;font-size:10px;"
"background:rgba(0,212,255,.1);border:1px solid rgba(0,212,255,.25);border-radius:10px;"
"padding:0 7px;color:var(--t-accent);vertical-align:middle;line-height:1.6;"
"transition:all .15s;}"
".sql-link-btn:hover{background:rgba(0,212,255,.22);border-color:rgba(0,212,255,.5);}"
)
# Raw string — no Python escape processing; JS unicode escapes work as-is in browser.
_TREE_JS = r"""
var currentDepth=INITIAL_DEPTH;
function mkEl(tag,cls,txt){var e=document.createElement(tag);if(cls)e.className=cls;if(txt!==undefined)e.textContent=txt;return e;}
function idLink(cls,display,gid,par,val,ext){var e=mkEl('span','id-link '+cls,display);e.dataset.gid=gid;e.dataset.par=par;e.dataset.val=val;if(ext)e.dataset.ext=JSON.stringify(ext);e.onclick=function(){var msg={type:'id-link',gid:e.dataset.gid,par:e.dataset.par,val:e.dataset.val};if(e.dataset.ext)msg.ext=JSON.parse(e.dataset.ext);window.parent.postMessage(msg,'*');};return e;}
function sqlLink(cls,display,fullName){var w=mkEl('span','sql-link-wrap');var v=mkEl('span',cls,display);w.appendChild(v);var btn=mkEl('span','sql-link-btn',String.fromCharCode(0x25b6)+' SELECT *');btn.title='SELECT * FROM '+fullName;btn.onclick=function(){window.parent.postMessage({type:'sql-link',full_name:fullName},'*');};w.appendChild(btn);return w;}
function sqlColLink(cls,display,colName,fullName){var w=mkEl('span','sql-link-wrap');var v=mkEl('span',cls,display);w.appendChild(v);var btn=mkEl('span','sql-link-btn',String.fromCharCode(0x25b6)+' SELECT');btn.title='SELECT '+colName+' FROM '+fullName;btn.onclick=function(){window.parent.postMessage({type:'sql-link',full_name:fullName,column:colName},'*');};w.appendChild(btn);return w;}
var TS_KEYS=/time$|_at$|timestamp$|_date$|expiration$|expired$|created$|updated$|deleted$|started$|finished$|modified$|deadline$|_ts$|start_time|end_time|creation_time|last_active_time|expiry_time/i;
function isEpoch(val,pKey){if(typeof val!=='number'||!pKey||!TS_KEYS.test(pKey))return false;if(val>1e12&&val<2e13)return val;if(val>1e9&&val<2e10)return val*1000;return false;}
function getSettingsTz(){try{return window.parent.document.documentElement.dataset.tz||'Europe/Berlin';}catch(e){return 'Europe/Berlin';}}
function tsSpan(cls,display,ms){var w=mkEl('span','jts '+cls);w.textContent=display;var tip=mkEl('span','ts-tip');var d=new Date(ms);var tz=getSettingsTz();var local=d.toLocaleString(undefined,{timeZone:tz,year:'numeric',month:'short',day:'numeric',hour:'2-digit',minute:'2-digit',second:'2-digit',hour12:false});var utc=d.toLocaleString(undefined,{timeZone:'UTC',year:'numeric',month:'short',day:'numeric',hour:'2-digit',minute:'2-digit',second:'2-digit',hour12:false});tip.textContent=local+' ('+tz.replace(/_/g,' ')+')\n'+utc+' (UTC)';w.appendChild(tip);return w;}
function renderValue(val,pKey,depth){
if(val===null)return mkEl('span','jbn','null');
var t=typeof val;
if(t==='boolean')return mkEl('span','jb',String(val));
if(t==='number'){var ms=isEpoch(val,pKey);if(ms)return tsSpan('jn',String(val),ms);var sv=String(val);var lu0=pKey&&LOOKUP[pKey];var c=lu0&&lu0[sv];return c?idLink('jn',sv,c.gid,c.par,sv,c.ext):mkEl('span','jn',sv);}
if(t==='string'){var lu=pKey&&LOOKUP[pKey];var c2=lu&&lu[val];var lv=val;if(!c2&&lu&&val.indexOf('/')>=0){var seg=val.split('/').pop();c2=lu[seg];if(c2)lv=seg;}if(c2)return idLink('jv','"'+val+'"',c2.gid,c2.par,lv,c2.ext);var sf=pKey&&SQL_FIELDS[pKey];if(sf){if(sf.table_name&&val!==sf.table_name)return sqlColLink('jv','"'+val+'"',val,sf.full_name);return sqlLink('jv','"'+val+'"',sf.full_name);}return mkEl('span','jv','"'+val+'"');}
if(Array.isArray(val))return renderArray(val,depth);
if(t==='object')return renderObject(val,depth);
return mkEl('span','jbn',String(val));
}
function fillObj(container,obj,depth){Object.keys(obj).forEach(function(k,i,arr){var kv=mkEl('div','kv');kv.appendChild(mkEl('span','jk','"'+k+'"'));kv.appendChild(mkEl('span','jp',': '));kv.appendChild(renderValue(obj[k],k,depth+1));if(i<arr.length-1)kv.appendChild(mkEl('span','jp',','));container.appendChild(kv);});}
function fillArr(container,arr,depth){arr.forEach(function(v,i,a){var item=mkEl('div','item');item.appendChild(renderValue(v,null,depth+1));if(i<a.length-1)item.appendChild(mkEl('span','jp',','));container.appendChild(item);});}
function buildNode(openCh,closeCh,label,data,depth,isObj){
var collapsed=depth>=currentDepth;
var node=mkEl('div',collapsed?'tree-node collapsed':'tree-node');
node.dataset.depth=depth;
var hdr=mkEl('div','node-header');
var btn=mkEl('span','toggle',collapsed?'\u25b8':'\u25be');
hdr.appendChild(btn);hdr.appendChild(mkEl('span','jp',openCh));hdr.appendChild(mkEl('span','preview jp',' '+label+' '+closeCh));
node.appendChild(hdr);
var rendered=false;
function ensure(){if(rendered)return;rendered=true;var ch=mkEl('div','children');isObj?fillObj(ch,data,depth):fillArr(ch,data,depth);var cl=mkEl('div','close-line');cl.appendChild(mkEl('span','jp',closeCh));node.appendChild(ch);node.appendChild(cl);}
if(!collapsed)ensure();
node._ensure=ensure;
btn.onclick=function(){if(node.classList.contains('collapsed'))ensure();node.classList.toggle('collapsed');btn.textContent=node.classList.contains('collapsed')?'\u25b8':'\u25be';};
return node;
}
function renderObject(obj,depth){var k=Object.keys(obj);if(!k.length)return mkEl('span','jp','{}');return buildNode('{','}',k.length+(k.length===1?' key':' keys'),obj,depth,true);}
function renderArray(arr,depth){if(!arr.length)return mkEl('span','jp','[]');return buildNode('[',']',arr.length+' items',arr,depth,false);}
function applyCollapseLevel(newDepth){
currentDepth=newDepth;
document.querySelectorAll('.tree-node').forEach(function(node){
var d=parseInt(node.dataset.depth);
var btn=node.querySelector(':scope > .node-header > .toggle');
if(d>=currentDepth){
node.classList.add('collapsed');
if(btn)btn.textContent='\u25b8';
} else if(node.classList.contains('collapsed')){
if(node._ensure)node._ensure();
node.classList.remove('collapsed');
if(btn)btn.textContent='\u25be';
}
});
var lbl=document.getElementById('depth-label');
if(lbl)lbl.textContent='Collapse at depth \u2265 '+currentDepth;
var btnMinus=document.getElementById('btn-minus');
if(btnMinus)btnMinus.disabled=(currentDepth<=1);
}
function changeDepth(delta){applyCollapseLevel(Math.max(1,currentDepth+delta));}
var searchMatches=[];var searchIdx=-1;
function clearHighlights(){
document.querySelectorAll('mark.sh').forEach(function(m){
var p=m.parentNode;if(!p)return;
p.replaceChild(document.createTextNode(m.textContent),m);
p.normalize();
});
searchMatches=[];searchIdx=-1;
}
function doSearch(q){
clearHighlights();
var sc=document.getElementById('sc');
if(!q){if(sc)sc.textContent='';return;}
q=q.toLowerCase();
document.querySelectorAll('.tree-node.collapsed').forEach(function(nd){
if(nd._ensure)nd._ensure();
nd.classList.remove('collapsed');
var btn=nd.querySelector(':scope > .node-header > .toggle');
if(btn)btn.textContent='\u25be';
});
var root=document.getElementById('root');
var tw=document.createTreeWalker(root,NodeFilter.SHOW_TEXT,null,false);
var toProc=[];var nd;
while((nd=tw.nextNode())){if(nd.textContent.toLowerCase().indexOf(q)!==-1)toProc.push(nd);}
toProc.forEach(function(tn){
var txt=tn.textContent;var low=txt.toLowerCase();
var frag=document.createDocumentFragment();var last=0;var i;
while((i=low.indexOf(q,last))!==-1){
if(i>last)frag.appendChild(document.createTextNode(txt.slice(last,i)));
var mk=document.createElement('mark');mk.className='sh';mk.textContent=txt.slice(i,i+q.length);
frag.appendChild(mk);searchMatches.push(mk);last=i+q.length;
}
if(last<txt.length)frag.appendChild(document.createTextNode(txt.slice(last)));
tn.parentNode.replaceChild(frag,tn);
});
if(searchMatches.length>0){searchIdx=0;activateMatch(0);}
updateCounter();
}
function activateMatch(i){
searchMatches.forEach(function(m,j){m.classList.toggle('cur',j===i);});
if(searchMatches[i])searchMatches[i].scrollIntoView({behavior:'smooth',block:'center'});
}
function updateCounter(){
var c=document.getElementById('sc');if(!c)return;
c.textContent=searchMatches.length>0?(searchIdx+1)+'\u2009/\u2009'+searchMatches.length:'';
}
function searchNav(d){
if(!searchMatches.length)return;
searchIdx=(searchIdx+d+searchMatches.length)%searchMatches.length;
activateMatch(searchIdx);updateCounter();
}
document.addEventListener('DOMContentLoaded',function(){
document.getElementById('root').appendChild(renderValue(DATA,null,0));
applyCollapseLevel(currentDepth);
});
"""
_ENDPOINT_COLLAPSE_DEPTH: Dict[str, int] = {
"mlflow-runs-search": 6,
"pg-projects-list": 5,
"pg-projects-get": 5,
"pg-endpoints-list": 5,
}
def _build_json_tree_html(
data: Any,
chips: Optional[List[Dict]] = None,
sql_fields: Optional[List[str]] = None,
initial_depth: int = 3,
) -> str:
"""Build a self-contained HTML document with a collapsible JSON tree.
The tree is rendered entirely in vanilla JavaScript (no React /
Dash). Nodes at depth >= 3 are auto-collapsed and children are
lazy-rendered on first expand for performance with large payloads.
If *chips* are provided, matching field values become clickable
inline links that post a ``window.parent.postMessage`` event
consumed by callback 16 (``handle_iframe_link_click``).
If *sql_fields* are provided, values of those JSON keys get a
clickable play icon that posts a ``sql-link`` message to navigate
to the SQL editor with ``SELECT * FROM <value>``.
Args:
data: Any JSON-serialisable value to render.
chips: Optional list of chip dicts (from
:func:`api_catalog.extract_chips`) used to build the
``LOOKUP`` table that drives inline ID links.
sql_fields: Optional list of JSON key names whose values
should get an inline SQL query button.
Returns:
A complete ``<!DOCTYPE html>`` string suitable for use as the
``srcDoc`` of an ``<iframe>``.
"""
link_lookup: Dict[str, Dict[str, Dict]] = {}
if chips:
for chip in chips:
field = chip["id_field"]
if field not in link_lookup:
link_lookup[field] = {}
entry: Dict[str, Any] = {
"gid": chip["get_id"],
"par": chip["param"],
}
if chip.get("extras"):
entry["ext"] = chip["extras"]
link_lookup[field][str(chip["value"])] = entry
sql_fields_js = json.dumps(sql_fields or {}, ensure_ascii=False)
data_js = json.dumps(data, ensure_ascii=False, separators=(",", ":")).replace("</script>", r"<\/script>")
lookup_js = json.dumps(link_lookup, ensure_ascii=False).replace("</script>", r"<\/script>")
return "".join([
"<!DOCTYPE html><html><head><meta charset='utf-8'>",
"<style>", _TREE_CSS, "</style>",
"</head><body>",
"<div id='toolbar'>",
"<button class='depth-btn' id='btn-minus' onclick='changeDepth(-1)' title='Collapse one level more'>\u2212</button>",
"<button class='depth-btn' onclick='changeDepth(+1)' title='Expand one level more'>+</button>",
"<span id='depth-label'></span>",
"<div class='sep'></div>",
"<input id='search-box' type='text' placeholder='\U0001f50d\u2009Search\u2026' "
"oninput='doSearch(this.value)' "
"onkeydown='if(event.key===\"Enter\"){searchNav(event.shiftKey?-1:1);event.preventDefault();}' />",
"<span id='sc'></span>",
"<button class='depth-btn' onclick='searchNav(-1)' title='Previous match (Shift+Enter)'>\u2191</button>",
"<button class='depth-btn' onclick='searchNav(1)' title='Next match (Enter)'>\u2193</button>",
"</div>",
"<div id='root'></div><script>",
"const DATA=", data_js, ";",
"const LOOKUP=", lookup_js, ";",
"const SQL_FIELDS=", sql_fields_js, ";",
f"const INITIAL_DEPTH={initial_depth};",
_TREE_JS,
"</script></body></html>",
])
# ── UI Helpers ────────────────────────────────────────────────────────────────
METHOD_COLORS = {"GET": "info", "POST": "warning", "PUT": "primary", "DELETE": "danger", "PATCH": "success"}
def method_badge(method: str) -> dbc.Badge:
"""Return a colour-coded Bootstrap badge for an HTTP method.
Args:
method: HTTP verb (e.g. ``"GET"``, ``"POST"``).
Returns:
A :class:`dbc.Badge` component.
"""
return dbc.Badge(method, color=METHOD_COLORS.get(method, "secondary"), className="method-badge")
_TOKEN_CACHE_PATH = os.path.expanduser("~/.databricks/token-cache.json")
def _load_token_cache() -> dict:
"""Load the Databricks CLI token cache from disk.
Returns:
A dict with ``version`` and ``tokens`` keys. Returns a fresh
empty cache if the file does not exist.
"""
if not os.path.exists(_TOKEN_CACHE_PATH):
return {"version": 1, "tokens": {}}
with open(_TOKEN_CACHE_PATH, "r", encoding="utf-8") as fh:
return json.load(fh)
def _save_token_cache(cache: dict) -> None:
"""Persist the token cache dict back to disk.
Args:
cache: The full cache dict (must contain ``version`` and
``tokens``).
"""
with open(_TOKEN_CACHE_PATH, "w", encoding="utf-8") as fh:
json.dump(cache, fh, indent=2)
def _find_cache_entry(tokens: dict, host: str) -> Optional[dict]:
"""Find a token-cache entry matching *host*.
Looks up by exact key first, then falls back to decoding the JWT
``iss`` claim of each cached token.
Args:
tokens: The ``tokens`` sub-dict from the token cache.
host: Workspace URL to match (with or without trailing ``/``).
Returns:
The matching cache entry dict, or ``None``.
"""
import base64 as _b64
h = host.rstrip("/")
entry = tokens.get(h) or tokens.get(h + "/")
if entry:
return entry
for _v in tokens.values():
try:
payload = _v["access_token"].split(".")[1]
payload += "=" * (-len(payload) % 4)
iss = json.loads(_b64.urlsafe_b64decode(payload)).get("iss", "")
if h in iss:
return _v
except Exception:
pass
return None
def _is_token_expired(entry: dict) -> bool:
"""Check whether a cached token has expired.
Args:
entry: A single token-cache entry containing an ``expiry``
ISO-8601 timestamp string.
Returns:
``True`` if the token is expired or the expiry cannot be
parsed.
"""
from datetime import datetime, timezone
s = entry.get("expiry", "")
if not s:
return True
try:
exp = datetime.fromisoformat(s)
if exp.tzinfo is None:
exp = exp.replace(tzinfo=timezone.utc)
return exp <= datetime.now(timezone.utc)
except Exception:
return True
def _try_token_refresh(entry: dict, host: str) -> Optional[str]:
"""Attempt a silent OAuth token refresh using the stored refresh token.
On success the *entry* dict is mutated in place and the updated
token cache is persisted to disk.
Args:
entry: A token-cache entry that must contain
``refresh_token``.
host: Workspace URL used to discover the OIDC token endpoint.
Returns:
The new access token string, or ``None`` on failure.
"""
from datetime import datetime, timezone, timedelta
rt = entry.get("refresh_token", "")
if not rt:
return None
try:
oidc = requests.get(
f"{host}/oidc/.well-known/oauth-authorization-server", timeout=10
).json()
tr = requests.post(oidc["token_endpoint"], data={
"grant_type": "refresh_token",
"client_id": "databricks-cli",
"refresh_token": rt,
}, timeout=30)
if not tr.ok:
return None
d = tr.json()
token = d.get("access_token", "")
if token:
entry["access_token"] = token
entry["refresh_token"] = d.get("refresh_token", rt)
entry["expiry"] = (
datetime.now(timezone.utc) + timedelta(seconds=d.get("expires_in", 3600))
).isoformat()
cache = _load_token_cache()
cache["tokens"][host.rstrip("/")] = entry
_save_token_cache(cache)
return token or None
except Exception:
return None
def _sso_try_cached(host: str) -> Optional[str]:
"""Return a valid token from the local cache, refreshing if needed.
Args:
host: Workspace URL to look up.
Returns:
A valid access token string, or ``None`` when no usable token
is available.
"""
cache = _load_token_cache()
entry = _find_cache_entry(cache.get("tokens", {}), host)
if not entry:
return None
if not _is_token_expired(entry):
return entry["access_token"]
return _try_token_refresh(entry, host)
# ── Background SSO browser flow ──────────────────────────────────────
_sso_result: Dict[str, Any] = {} # host → {"token": ..., "error": ..., "done": bool}
_sso_lock = threading.Lock()
def _sso_browser_flow(host: str) -> None:
"""Run the blocking browser-based OAuth flow in a background thread.
Opens the system browser for SSO login, waits for the redirect
callback on ``localhost:8020``, and stores the resulting token (or
error) in :data:`_sso_result` under ``host``.
Args:
host: Workspace URL to authenticate against.
"""
from databricks.sdk.oauth import OAuthClient
from datetime import datetime, timezone, timedelta
import signal
try:
# databricks-cli client only allows http://localhost:8020 as redirect
port = 8020
# Kill any leftover listener on this port
try:
for pid in subprocess.check_output(
["lsof", "-ti", f":{port}"], stderr=subprocess.DEVNULL
).decode().split():
os.kill(int(pid.strip()), signal.SIGTERM)
time.sleep(0.3)
except Exception:
pass
redirect_url = f"http://localhost:{port}"
client = OAuthClient.from_host(
host=host, client_id="databricks-cli",
redirect_url=redirect_url,
scopes=["all-apis", "offline_access"],
)
consent = client.initiate_consent()
if not consent:
with _sso_lock:
_sso_result[host] = {"token": None, "error": "Could not initiate OAuth.", "done": True}
return
creds = consent.launch_external_browser()
tok_obj = creds.token()
token = tok_obj.access_token
if token:
cache = _load_token_cache()
expiry = tok_obj.expiry or (datetime.now(timezone.utc) + timedelta(seconds=3600))
cache["tokens"][host.rstrip("/")] = {
"access_token": token,
"token_type": "Bearer",
"refresh_token": tok_obj.refresh_token or "",
"expiry": expiry.isoformat(),
"expires_in": 3600,
}
_save_token_cache(cache)
with _sso_lock:
_sso_result[host] = {"token": token, "error": None, "done": True}
except Exception as e:
with _sso_lock:
_sso_result[host] = {"token": None, "error": str(e), "done": True}
def _resolve_conn(
conn_config: Optional[Dict],
) -> tuple:
"""Return ``(host, token)`` for the current runtime mode.
In Databricks App mode the host and token come from environment
variables and request headers; in local mode they are resolved via
:func:`auth.resolve_local_connection`.
Args:
conn_config: The ``conn-config`` Dash store value.
Returns:
A ``(host, token)`` tuple.
"""
if IS_DATABRICKS_APP:
mode = (conn_config or {}).get("mode", "sp")
if mode == "obo":
# OBO: read the user's token from the proxy header (requires
# User Authorization enabled + scopes configured in the app)
return get_host(), flask_request.headers.get("X-Forwarded-Access-Token")
# Default: Service Principal
return get_host(), get_sp_token()
return resolve_local_connection(conn_config or _DEFAULT_CONN)
def _resolve_conn_obo(conn_config: Optional[Dict]) -> tuple:
"""Like ``_resolve_conn`` but always prefer the OBO user token in App mode.
Lakebase PG connections and the Data API require the end-user's
identity, not the service principal. In local mode this behaves
identically to ``_resolve_conn``.
"""
if IS_DATABRICKS_APP:
return get_host(), flask_request.headers.get("X-Forwarded-Access-Token")
return resolve_local_connection(conn_config or _DEFAULT_CONN)
def _accounts_host(workspace_host: str) -> str:
"""Derive the Databricks accounts console URL from a workspace host.
Args:
workspace_host: The workspace URL (e.g.
``https://adb-123.azuredatabricks.net``).
Returns:
The accounts console URL (e.g.
``https://accounts.azuredatabricks.net`` for Azure or
``https://accounts.cloud.databricks.com`` for AWS/GCP).
"""
h = (workspace_host or "").lower()
if "azuredatabricks" in h:
return "https://accounts.azuredatabricks.net"
if ".gcp.databricks.com" in h:
return "https://accounts.gcp.databricks.com"
return "https://accounts.cloud.databricks.com"
def build_response_panel(
result: Dict[str, Any],
chips: Optional[List[Dict]] = None,
endpoint_id: Optional[str] = None,
) -> html.Div:
"""Assemble the full response viewer panel for an API call result.
Includes a status badge, timing label, item count, the JSON tree
iframe, and an optional side panel of clickable chip items.
Args:
result: Normalised result dict from :func:`auth.make_api_call`.
chips: Optional chip list from :func:`api_catalog.extract_chips`
for rendering the side panel and inline ID links.
Returns:
A Dash ``html.Div`` component tree.
"""
code, ms, data = result["status_code"], result["elapsed_ms"], result["data"]
if 200 <= code < 300:
status_color, icon = "success", "bi-check-circle-fill"
elif code == 0:
status_color, icon = "danger", "bi-x-octagon-fill"
elif 400 <= code < 500:
status_color, icon = "danger", "bi-x-circle-fill"
else:
status_color, icon = "warning", "bi-exclamation-circle-fill"
item_count = ""
if isinstance(data, list):
item_count = f" · {len(data)} items"
elif isinstance(data, dict):
list_key = _find_list_key(data)
if list_key:
item_count = f" · {len(data[list_key])} items"
# Determine SQL-queryable fields based on endpoint
# Maps JSON key → {full_name, table_name?} for inline SQL links.
# When value == table_name → SELECT *, otherwise → SELECT <value> (column)
sql_fields = None
if endpoint_id == "uc-tables-get" and isinstance(data, dict) and data.get("full_name"):
fn = data["full_name"]
tbl = data.get("name", "")
sql_fields = {
"full_name": {"full_name": fn},
"name": {"full_name": fn, "table_name": tbl},
}
collapse_depth = _ENDPOINT_COLLAPSE_DEPTH.get(endpoint_id, 3)
# CSV response: render as a scrollable HTML table
csv_text = result.get("_csv")
if csv_text:
import csv as _csv_mod
import io
reader = _csv_mod.reader(io.StringIO(csv_text))
rows = list(reader)
if rows:
headers = rows[0]
table_header = html.Thead(html.Tr([html.Th(h) for h in headers]))
table_body = html.Tbody([
html.Tr([html.Td(cell) for cell in row])
for row in rows[1:]
])
item_count = f" · {len(rows) - 1} rows"
viewer = html.Div([
html.Table([table_header, table_body], className="csv-table"),
], className="csv-viewer")
else:
viewer = html.Iframe(
srcDoc=_build_json_tree_html(data, chips, sql_fields=sql_fields, initial_depth=collapse_depth),
style={"width": "100%", "height": "100%", "border": "none", "display": "block"},
)
else:
viewer = html.Iframe(
srcDoc=_build_json_tree_html(data, chips, sql_fields=sql_fields, initial_depth=collapse_depth),
style={"width": "100%", "height": "100%", "border": "none", "display": "block"},
)
wrapper_cls = "json-viewer-wrapper json-viewer-iframe"
# Build side panel with chip items
if chips:
sp_items = []
for i, chip in enumerate(chips):
has_label = chip["label"] != chip["title"]
name_text = chip["label"]
id_text = chip["title"] if has_label else ""
name_row = [html.Span(name_text, className="sp-name")]
if "state" in chip:
state = chip.get("state") or ""
dot_cls = "sp-state-dot sp-state-running" if state == "RUNNING" else "sp-state-dot sp-state-other"
name_row.insert(0, html.Span(className=dot_cls, title=f"State: {state or 'unknown'}"))
text_children = [html.Span(name_row, className="sp-name-row")]
if id_text:
text_children.append(html.Span(id_text, className="sp-id"))
tooltip = f"{chip['label']} · {chip['title']}"
if "state" in chip:
tooltip = f"{tooltip} · {chip.get('state') or 'unknown'}"
item_children = [
html.Button(
text_children,
id={"type": "sp-item", "index": i},
n_clicks=0,
className="sp-item-main",
title=tooltip,
),
]
for j, action in enumerate(chip.get("actions") or []):
item_children.append(html.Button(
html.I(className=f"bi {action['icon']}"),
id={"type": "sp-action", "index": i, "action": j},
n_clicks=0,
className="sp-action-btn",
title=action["title"],
))
sp_items.append(html.Div(item_children, className="sp-item"))
header_children = [
html.Button(
html.I(className="bi bi-layout-sidebar-reverse"),
id="sp-toggle-btn",
className="sp-toggle",
n_clicks=0,
title="Collapse/expand panel",
),
html.Span(f"{len(chips)} items", className="sp-header-text"),
]
side_panel = html.Div([
html.Div(className="sp-resize-handle"),
html.Div(header_children, className="sp-header"),
html.Div(sp_items, className="sp-list"),
], id="side-panel", className="side-panel")
else:
side_panel = None
body_children = [html.Div(viewer, className=wrapper_cls)]
if side_panel:
body_children.append(side_panel)
# "Query table" button for Get Table responses
query_btn = None
if endpoint_id == "uc-tables-get" and isinstance(data, dict) and data.get("full_name"):
full_name = data["full_name"]
query_btn = html.Button(
[html.I(className="bi bi-play-circle me-1"), "SELECT *"],
id={"type": "sql-query-table-btn", "name": full_name},
n_clicks=0,
className="sql-query-link-btn ms-2",
title=f"SELECT * FROM {full_name}",
)
# "Pretty-print" + "Download" buttons for Files API Download File responses
file_pretty_btn = None
file_download_btn = None
if endpoint_id == "files-download" and 200 <= code < 300:
file_pretty_btn = html.Button(
[html.I(className="bi bi-file-earmark-text me-1"), "Pretty-print"],
id="file-pretty-btn",
n_clicks=0,
className="sql-query-link-btn ms-2",
title="Parse content as JSON / CSV / Parquet and render",
)
file_download_btn = html.Button(
[html.I(className="bi bi-download me-1"), "Download"],
id="file-download-btn",
n_clicks=0,
className="sql-query-link-btn ms-2",
title="Download the file to your computer",
)
body_children.append(html.Div(
[
html.Div([
html.Span("Pretty-printed content", className="decoded-script-title"),
html.Span("Click \"Pretty-print\" again to close", className="decoded-script-hint"),
], className="decoded-script-header"),
html.Div(id="file-pretty-content", className="file-pretty-content"),
],
id="file-pretty-panel",
className="decoded-script-panel hidden",
))
# "Decode script" button + overlay for Get Global Init Script responses
decode_btn = None
if endpoint_id == "global-init-scripts-get" and isinstance(data, dict) and data.get("script"):
import base64 as _b64
try:
decoded_text = _b64.b64decode(data["script"]).decode("utf-8", errors="replace")
except Exception as e:
decoded_text = f"[decode error: {e}]"
decode_btn = html.Button(
[html.I(className="bi bi-file-earmark-code me-1"), "Decode script"],