Repository navigation
Expand file tree
/
Copy pathnotebook.ts
More file actions
233 lines (225 loc) · 10.1 KB
/
Copy pathnotebook.ts
File metadata and controls
233 lines (225 loc) · 10.1 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
import * as vscode from 'vscode';
interface SavedCell {
kind: vscode.NotebookCellKind;
value: string;
language: string;
metadata: Record<string, unknown>;
summary?: vscode.NotebookCellExecutionSummary;
outputs: { metadata?: Record<string, unknown>; items: { mime: string; data: string }[] }[];
}
export const DISPLAY_MIME = 'application/vnd.vscode-r.display+json';
/** Native Interactive uses the IPython serializer, which retains only metadata.metadata. */
export function persistentCellMetadata(
metadata: Record<string, unknown>,
languageId: string,
): Record<string, unknown> {
const saved = metadata.metadata as Record<string, unknown> | undefined;
return {
...metadata,
metadata: {
...saved,
...Object.fromEntries(Object.entries(metadata).filter(([key]) => key.startsWith('r'))),
vscode: { ...(saved?.vscode as Record<string, unknown> | undefined), languageId },
},
};
}
export function restoredCellMetadata(metadata: Record<string, unknown>): Record<string, unknown> {
return { ...(metadata.metadata as Record<string, unknown> | undefined), ...metadata };
}
export function persistentNotebookMetadata(
metadata: Record<string, unknown>,
sessionId: string,
generation: string,
): Record<string, unknown> {
const saved = metadata.metadata as Record<string, unknown> | undefined;
return {
...metadata,
rSessionId: sessionId,
rGeneration: generation,
metadata: {
...saved,
language_info: {
...(saved?.language_info as Record<string, unknown> | undefined),
name: 'r',
},
},
};
}
export class InteractiveSerializer implements vscode.NotebookSerializer {
exportIpynb(data: vscode.NotebookData): Uint8Array {
const cells = data.cells.map((cell) => ({
cell_type: cell.kind === vscode.NotebookCellKind.Markup ? 'markdown' : 'code',
source: cell.value,
metadata: {},
...(cell.kind === vscode.NotebookCellKind.Code
? {
execution_count: cell.executionSummary?.executionOrder ?? null,
outputs: (cell.outputs ?? []).flatMap((output): Record<string, unknown>[] => {
const stream = output.items.find((item) =>
/vnd\.code\.notebook\.(stdout|stderr)$/.test(item.mime),
);
if (stream) {
return [
{
output_type: 'stream',
name: stream.mime.endsWith('stderr') ? 'stderr' : 'stdout',
text: Buffer.from(stream.data).toString(),
},
];
}
const error = output.items.find(
(item) => item.mime === 'application/vnd.code.notebook.error',
);
if (error) {
const value = JSON.parse(Buffer.from(error.data).toString()) as {
name: string;
message: string;
stack?: string;
};
return [
{
output_type: 'error',
ename: value.name,
evalue: value.message,
traceback: (value.stack ?? '').split('\n'),
},
];
}
const custom = output.items.find((item) => item.mime === DISPLAY_MIME);
const display =
custom &&
(JSON.parse(Buffer.from(custom.data).toString()) as
| Record<string, unknown>
| undefined);
if (display?.kind === 'plot' && Array.isArray(display.pages)) {
return (display.pages as Record<string, unknown>[]).map(
(page, index) => {
const mime: Record<string, string> = {
'text/plain': `R plot ${index + 1} of ${(display.pages as unknown[]).length}`,
};
if (typeof page.svgData === 'string') {
mime['image/svg+xml'] = Buffer.from(
page.svgData,
'base64',
).toString('utf8');
} else if (
typeof page.imageData === 'string' &&
typeof page.mime === 'string'
) {
mime[page.mime] =
page.mime === 'image/svg+xml'
? Buffer.from(page.imageData, 'base64').toString(
'utf8',
)
: page.imageData;
}
return {
output_type: 'display_data',
data: mime,
metadata: {},
};
},
);
}
const mime: Record<string, string> = {};
for (const item of output.items) {
if (item.mime === DISPLAY_MIME) {
continue;
}
mime[item.mime] = Buffer.from(item.data).toString(
/^image\/(png|jpeg|gif)$/.test(item.mime) ? 'base64' : 'utf8',
);
}
return [{ output_type: 'display_data', data: mime, metadata: {} }];
}),
}
: {}),
}));
return Buffer.from(
JSON.stringify(
{
nbformat: 4,
nbformat_minor: 4,
metadata: {
kernelspec: { name: 'ir', display_name: 'R', language: 'R' },
language_info: { name: 'R' },
},
cells,
},
null,
2,
),
);
}
deserializeNotebook(content: Uint8Array): vscode.NotebookData {
if (!content.length) {
return new vscode.NotebookData([]);
}
const saved = JSON.parse(Buffer.from(content).toString('utf8')) as {
version: number;
metadata: Record<string, unknown>;
cells: SavedCell[];
};
if (saved.version !== 1 || !Array.isArray(saved.cells)) {
throw new Error('Unsupported R Interactive notebook');
}
const cells = saved.cells.map((cell) => {
const data = new vscode.NotebookCellData(cell.kind, cell.value, cell.language);
data.metadata = cell.metadata;
data.executionSummary = cell.summary;
data.outputs = cell.outputs.map(
(output) =>
new vscode.NotebookCellOutput(
output.items.map(
(item) =>
new vscode.NotebookCellOutputItem(
Buffer.from(item.data, 'base64'),
item.mime,
),
),
output.metadata,
),
);
return data;
});
const notebook = new vscode.NotebookData(cells);
notebook.metadata = saved.metadata;
return notebook;
}
serializeNotebook(data: vscode.NotebookData): Uint8Array {
const cells: SavedCell[] = data.cells.map((cell) => ({
kind: cell.kind,
value: cell.value,
language: cell.languageId,
metadata: cell.metadata ?? {},
summary: cell.executionSummary,
outputs: (cell.outputs ?? []).map((output) => ({
metadata: output.metadata,
items: output.items.map((item) => {
let bytes = item.data;
if (item.mime === DISPLAY_MIME) {
const display = JSON.parse(Buffer.from(bytes).toString('utf8')) as Record<
string,
unknown
>;
// Forwarding URLs contain transient credentials. Retain asset identities only.
for (const page of [
display,
...(Array.isArray(display.pages)
? (display.pages as Record<string, unknown>[])
: []),
]) {
delete page.url;
page.connected = false;
}
bytes = Buffer.from(JSON.stringify(display));
}
return { mime: item.mime, data: Buffer.from(bytes).toString('base64') };
}),
})),
}));
return Buffer.from(
JSON.stringify({ version: 1, metadata: data.metadata ?? {}, cells }, null, 2),
);
}
}