apollo-router 2.13.1

A configurable, high-performance routing runtime for Apollo Federation 🚀
Documentation
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
/**
 * Data Access Layer for Apollo Router Diagnostics
 *
 * Provides a unified interface for loading diagnostic data in both dashboard
 * and embedded modes. Handles switching between live API endpoints and embedded
 * base64-encoded data.
 *
 * ## Architecture
 *
 * Two modes of operation:
 * - **Dashboard Mode** (IS_DASHBOARD_MODE=true): Fetches data from REST API endpoints
 * - **Embedded Mode** (IS_DASHBOARD_MODE=false): Decodes data from EMBEDDED_DATA object
 *
 * ## Data Sources
 *
 * Loads the following diagnostic data:
 * - System information (OS, CPU, memory)
 * - Router configuration (YAML)
 * - Supergraph schema (GraphQL)
 * - Memory heap dumps (.prof files)
 *
 * ## Security
 *
 * All data is fetched from same-origin endpoints or embedded at build time.
 * No external data sources are accessed to prevent CORS and XSS issues.
 *
 * @module data-access
 */

// ===== Utility Functions =====

function base64Decode(str) {
    try {
        return atob(str);
    } catch (e) {
        console.error('Failed to decode base64:', e);
        return str;
    }
}

// ===== Configuration =====

// Data loading configuration
const DATA_CONFIG = {
    useLocalFiles: false, // Set to false to use embedded data
    basePath: './', // Base path for data files
    files: {
        systemInfo: 'system_info.txt',
        routerConfig: 'router.yaml',
        schema: 'supergraph.graphql',
        memoryDumps: [
            'memory/router_heap_dump_1757588839.prof',
            'memory/router_heap_dump_1757588881.prof'
        ]
    }
};

// API base URL (absolute path)
const API_BASE = '/diagnostics/';

// ===== File Loading Functions =====

async function loadTextFile(filepath) {
    try {
        const response = await fetch(DATA_CONFIG.basePath + filepath);
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return await response.text();
    } catch (error) {
        console.error(`Failed to load ${filepath}:`, error);
        return `Error: Could not load ${filepath}`;
    }
}

async function loadBinaryFile(filepath) {
    try {
        const response = await fetch(DATA_CONFIG.basePath + filepath);
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        const arrayBuffer = await response.arrayBuffer();
        return new Uint8Array(arrayBuffer);
    } catch (error) {
        console.error(`Failed to load ${filepath}:`, error);
        return `Error: Could not load ${filepath}`;
    }
}

// ===== Main Data Loading Functions =====

async function loadAllData() {
    if (DATA_CONFIG.useLocalFiles) {
        try {
            // Load text files
            const [systemInfo, routerConfig, schema] = await Promise.all([
                loadTextFile(DATA_CONFIG.files.systemInfo),
                loadTextFile(DATA_CONFIG.files.routerConfig),
                loadTextFile(DATA_CONFIG.files.schema)
            ]);

            // Load memory dumps
            const memoryDumps = [];
            for (let i = 0; i < DATA_CONFIG.files.memoryDumps.length; i++) {
                const filepath = DATA_CONFIG.files.memoryDumps[i];
                const data = await loadBinaryFile(filepath);
                if (data) {
                    const filename = filepath.split('/').pop();
                    memoryDumps.push({
                        name: filename,
                        data: data,
                        size: data.length,
                        path: filepath
                    });
                }
            }

            // Update global data
            window.LOADED_DATA = {
                systemInfo: systemInfo,
                routerConfig: routerConfig,
                schema: schema,
                memoryDumps: memoryDumps
            };

            return window.LOADED_DATA;

        } catch (error) {
            console.error('Failed to load data:', error);
            // Fallback to embedded data
            return await loadEmbeddedData();
        }
    } else {
        // Check if we have usable embedded data (static report mode) or should use API (dashboard mode)
        if (typeof EMBEDDED_DATA !== 'undefined' && EMBEDDED_DATA &&
            (EMBEDDED_DATA.systemInfo || EMBEDDED_DATA.routerConfig || EMBEDDED_DATA.schema)) {
            return await loadEmbeddedData();
        } else {
            // Dashboard mode - fetch from API endpoints
            return await loadApiData();
        }
    }
}

async function loadEmbeddedData() {
    // Decode any base64 encoded data in embedded mode
    const decodedData = {
        systemInfo: EMBEDDED_DATA.systemInfo ?
            (typeof EMBEDDED_DATA.systemInfo === 'string' && EMBEDDED_DATA.systemInfo.match(/^[A-Za-z0-9+/]+=*$/) ?
                base64Decode(EMBEDDED_DATA.systemInfo) : EMBEDDED_DATA.systemInfo) : null,
        routerConfig: EMBEDDED_DATA.routerConfig ?
            (typeof EMBEDDED_DATA.routerConfig === 'string' && EMBEDDED_DATA.routerConfig.match(/^[A-Za-z0-9+/]+=*$/) ?
                base64Decode(EMBEDDED_DATA.routerConfig) : EMBEDDED_DATA.routerConfig) : null,
        schema: EMBEDDED_DATA.schema ?
            (typeof EMBEDDED_DATA.schema === 'string' && EMBEDDED_DATA.schema.match(/^[A-Za-z0-9+/]+=*$/) ?
                base64Decode(EMBEDDED_DATA.schema) : EMBEDDED_DATA.schema) : null,
        memoryDumps: EMBEDDED_DATA.memoryDumps || []
    };

    // Set global data
    window.LOADED_DATA = decodedData;
    return decodedData;
}

async function loadApiData() {
    try {
        // Fetch data from API endpoints
        const [systemInfoResponse, routerConfigResponse, schemaResponse, dumpsResponse] = await Promise.all([
            fetch(API_BASE + 'system_info.txt'),
            fetch(API_BASE + 'router_config.yaml'),
            fetch(API_BASE + 'supergraph.graphql'),
            fetch(API_BASE + 'memory/dumps')
        ]);

        // Get text content
        const [systemInfo, routerConfig, schema] = await Promise.all([
            systemInfoResponse.text(),
            routerConfigResponse.text(),
            schemaResponse.text()
        ]);

        // Get memory dumps
        const dumps = dumpsResponse.ok ? await dumpsResponse.json() : [];

        // Set global data for other functions to use
        const loadedData = {
            systemInfo: systemInfo,
            routerConfig: routerConfig,
            schema: schema,
            memoryDumps: dumps
        };

        window.LOADED_DATA = loadedData;
        return loadedData;

    } catch (error) {
        console.error('Failed to load data from API:', error);
        throw error;
    }
}

// ===== Dashboard API Functions =====

async function fetchProfilingStatus() {
    try {
        const response = await fetch(API_BASE + 'memory/status');
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('Failed to fetch profiling status:', error);
        throw error;
    }
}

async function startProfiling() {
    try {
        const response = await fetch(API_BASE + 'memory/start', {method: 'POST'});
        const data = await response.json();

        if (!response.ok) {
            throw new Error(data.message || 'Failed to start profiling');
        }

        return data;
    } catch (error) {
        console.error('Failed to start profiling:', error);
        throw error;
    }
}

async function stopProfiling() {
    try {
        const response = await fetch(API_BASE + 'memory/stop', {method: 'POST'});
        const data = await response.json();

        if (!response.ok) {
            throw new Error(data.message || 'Failed to stop profiling');
        }

        return data;
    } catch (error) {
        console.error('Failed to stop profiling:', error);
        throw error;
    }
}

async function triggerDump() {
    try {
        const response = await fetch(API_BASE + 'memory/dump', {method: 'POST'});
        const data = await response.json();

        if (!response.ok) {
            throw new Error(data.message || 'Failed to trigger dump');
        }

        return data;
    } catch (error) {
        console.error('Failed to trigger dump:', error);
        throw error;
    }
}

async function listDumps() {
    try {
        const response = await fetch(API_BASE + 'memory/dumps');
        const dumps = await response.json();
        return dumps;
    } catch (error) {
        console.error('Failed to list dumps:', error);
        throw error;
    }
}

async function downloadDump(filename) {
    try {
        const response = await fetch(API_BASE + `memory/dumps/${filename}`);
        if (!response.ok) {
            throw new Error(`Failed to download dump: ${response.status}`);
        }

        const blob = await response.blob();
        return blob;
    } catch (error) {
        console.error('Failed to download dump:', error);
        throw error;
    }
}

async function deleteDump(filename) {
    try {
        const response = await fetch(API_BASE + `memory/dumps/${filename}`, {method: 'DELETE'});
        const data = await response.json();

        if (!response.ok) {
            throw new Error(data.message || 'Failed to delete dump');
        }

        return data;
    } catch (error) {
        console.error('Failed to delete dump:', error);
        throw error;
    }
}

async function clearAllDumps() {
    try {
        const response = await fetch(API_BASE + 'memory/dumps', {method: 'DELETE'});
        const data = await response.json();

        if (!response.ok) {
            throw new Error(data.message || 'Failed to clear dumps');
        }

        return data;
    } catch (error) {
        console.error('Failed to clear dumps:', error);
        throw error;
    }
}

async function exportDiagnostics() {
    try {
        const response = await fetch(API_BASE + 'export');

        if (!response.ok) {
            const errorData = await response.json();
            throw new Error(errorData.message || 'Export failed');
        }

        const blob = await response.blob();
        return blob;
    } catch (error) {
        console.error('Failed to export diagnostics:', error);
        throw error;
    }
}

// ===== Centralized Data Access Layer =====

// Centralized data access - abstracts away embedded vs API mode
const DataAccess = {
    // Get memory dumps list
    async getMemoryDumps() {
        if (this.isDashboardMode()) {
            // Dashboard mode - fetch from API
            try {
                const response = await fetch(API_BASE + 'memory/dumps');
                return await response.json();
            } catch (error) {
                console.error('Failed to fetch dumps:', error);
                return [];
            }
        } else {
            // Embedded mode - use loaded data
            return window.LOADED_DATA?.memoryDumps || [];
        }
    },

    // Get memory dump content by name (handles base64 decoding internally)
    async getMemoryDump(dumpName) {
        let dump;
        if (this.isDashboardMode()) {
            // Dashboard mode - fetch from API
            try {
                const response = await fetch(API_BASE + `memory/dumps/${dumpName}`);
                if (!response.ok) {
                    throw new Error(`Failed to fetch dump: ${response.status}`);
                }
                const dumpContent = await response.text();
                dump = {name: dumpName, data: dumpContent};
            } catch (error) {
                console.error('Failed to fetch dump:', error);
                throw error;
            }
        } else {
            // Embedded mode - use loaded data
            const dumps = window.LOADED_DATA?.memoryDumps || [];
            dump = dumps.find(d => d.name === dumpName);
            if (!dump) {
                throw new Error(`Dump not found: ${dumpName}`);
            }
        }

        // Handle base64 decoding if needed (centralized here)
        if (typeof dump.data === 'string' && dump.data.match(/^[A-Za-z0-9+/]+=*$/)) {
            return {
                ...dump,
                data: base64Decode(dump.data)
            };
        }

        return dump;
    },

    // Check if we're in dashboard mode (vs embedded mode)
    isDashboardMode() {
        // First check for explicit dashboard mode flag (most reliable)
        if (typeof IS_DASHBOARD_MODE !== 'undefined') {
            return IS_DASHBOARD_MODE;
        }

        // Fallback: If we have embedded data with actual content, we're definitely in static export mode
        if (typeof EMBEDDED_DATA !== 'undefined' && EMBEDDED_DATA &&
            (EMBEDDED_DATA.systemInfo || EMBEDDED_DATA.routerConfig || EMBEDDED_DATA.schema || EMBEDDED_DATA.memoryDumps)) {
            return false;
        }

        // If useLocalFiles is true, we're in file-based development mode (not dashboard mode)
        if (typeof DATA_CONFIG !== 'undefined' && DATA_CONFIG && DATA_CONFIG.useLocalFiles === true) {
            return false;
        }

        // Otherwise, we're in dashboard mode (live API mode)
        return true;
    }
};