@enokdev/springdocs-mcp 1.2.4 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,14 +1,28 @@
1
+ import fetch from 'node-fetch';
2
+ import * as cheerio from 'cheerio';
3
+ import TurndownService from 'turndown';
1
4
  import { CacheService } from './cache.js';
2
5
  /**
3
- * Advanced features service for Spring documentation
6
+ * Advanced features service for Spring documentation - uses ONLY real Spring documentation APIs
7
+ * No mock data - everything is fetched from actual Spring documentation sources
4
8
  */
5
9
  export class AdvancedFeaturesService {
6
10
  cache;
11
+ turndownService;
12
+ baseUrl = 'https://docs.spring.io';
13
+ springProjectsUrl = 'https://spring.io/projects';
14
+ springGuideUrl = 'https://spring.io/guides';
15
+ REQUEST_TIMEOUT = 10000;
16
+ MAX_RETRIES = 3;
7
17
  constructor() {
8
18
  this.cache = new CacheService();
19
+ this.turndownService = new TurndownService({
20
+ headingStyle: 'atx',
21
+ codeBlockStyle: 'fenced',
22
+ });
9
23
  }
10
24
  /**
11
- * Search across the entire Spring ecosystem
25
+ * Search across the entire Spring ecosystem using real APIs
12
26
  */
13
27
  async searchEcosystem(query, scope = 'all', limit = 5) {
14
28
  const cacheKey = `ecosystem:${query}:${scope}:${limit}`;
@@ -36,539 +50,367 @@ export class AdvancedFeaturesService {
36
50
  }
37
51
  results.totalResults = Object.values(results.categories)
38
52
  .reduce((total, category) => total + (category?.length || 0), 0);
39
- this.cache.set(cacheKey, results);
40
- return results;
53
+ const formattedResult = this.formatEcosystemResults(results);
54
+ this.cache.set(cacheKey, formattedResult);
55
+ return formattedResult;
41
56
  }
42
57
  catch (error) {
43
- console.error('Error in ecosystem search:', error);
44
- throw new Error('Failed to search Spring ecosystem');
58
+ console.error('Error searching ecosystem:', error);
59
+ return `# Spring Ecosystem Search Results\n\nError searching for "${query}": ${error instanceof Error ? error.message : 'Unknown error'}`;
45
60
  }
46
61
  }
47
62
  /**
48
- * Get step-by-step tutorials
63
+ * Get tutorials by fetching from actual Spring Boot guides
49
64
  */
50
65
  async getTutorial(topic, level = 'beginner') {
51
66
  const cacheKey = `tutorial:${topic}:${level}`;
52
67
  const cached = this.cache.get(cacheKey);
53
68
  if (cached)
54
69
  return cached;
55
- const tutorials = this.getTutorialDatabase();
56
- const tutorial = tutorials[topic]?.[level];
57
- if (!tutorial) {
58
- const availableTopics = Object.keys(tutorials).join(', ');
59
- return `# Tutorial Not Found
60
-
61
- The tutorial for "${topic}" at "${level}" level is not available.
62
-
63
- ## Available Topics:
64
- ${availableTopics}
65
-
66
- ## Available Levels:
67
- - beginner
68
- - intermediate
69
- - advanced
70
-
71
- Please use one of the available topics and levels.`;
70
+ try {
71
+ // Search for relevant guides based on topic
72
+ const guides = await this.searchGuides(topic, 3);
73
+ if (guides.length === 0) {
74
+ return `# Tutorial Not Found\n\nNo tutorials found for topic: "${topic}"\n\nTry searching for: rest-api, jpa, security, testing, or web`;
75
+ }
76
+ // Fetch content from the first relevant guide
77
+ const guide = guides[0];
78
+ const response = await this.fetchWithRetry(guide.url);
79
+ if (!response.ok) {
80
+ throw new Error(`Failed to fetch tutorial: ${response.status}`);
81
+ }
82
+ const html = await response.text();
83
+ const $ = cheerio.load(html);
84
+ // Extract main content
85
+ const content = $('.content, .guide-content, main, .markdown-body').first();
86
+ if (content.length === 0) {
87
+ throw new Error('No content found in guide');
88
+ }
89
+ // Convert to markdown
90
+ const markdown = this.turndownService.turndown(content.html() || '');
91
+ const result = `# ${guide.title}\n\n**Level:** ${level}\n**Source:** ${guide.url}\n\n${markdown}`;
92
+ this.cache.set(cacheKey, result);
93
+ return result;
94
+ }
95
+ catch (error) {
96
+ console.error('Error fetching tutorial:', error);
97
+ return `# Tutorial Error\n\nUnable to fetch tutorial for "${topic}": ${error instanceof Error ? error.message : 'Unknown error'}`;
72
98
  }
73
- this.cache.setLongTerm(cacheKey, tutorial);
74
- return tutorial;
75
99
  }
76
100
  /**
77
- * Compare Spring Boot versions
101
+ * Compare Spring Boot versions using real release notes
78
102
  */
79
103
  async compareVersions(version1, version2, focus = 'all') {
80
- const cacheKey = `compare:${version1}:${version2}:${focus}`;
104
+ const cacheKey = `versions:${version1}:${version2}:${focus}`;
81
105
  const cached = this.cache.get(cacheKey);
82
106
  if (cached)
83
107
  return cached;
84
108
  try {
85
- const comparison = await this.generateVersionComparison(version1, version2, focus);
86
- this.cache.setLongTerm(cacheKey, comparison);
87
- return comparison;
109
+ // Fetch release notes from GitHub
110
+ const releaseNotesUrl = `https://api.github.com/repos/spring-projects/spring-boot/releases`;
111
+ const response = await this.fetchWithRetry(releaseNotesUrl);
112
+ if (!response.ok) {
113
+ throw new Error(`Failed to fetch release data: ${response.status}`);
114
+ }
115
+ const releases = await response.json();
116
+ const release1 = releases.find((r) => r.tag_name.includes(version1));
117
+ const release2 = releases.find((r) => r.tag_name.includes(version2));
118
+ if (!release1 || !release2) {
119
+ return `# Version Comparison: ${version1} vs ${version2}\n\nUnable to find release information for one or both versions.\n\nAvailable versions can be found at: https://github.com/spring-projects/spring-boot/releases`;
120
+ }
121
+ const result = `# Spring Boot Version Comparison: ${version1} vs ${version2}
122
+
123
+ ## Version ${version1}
124
+ **Released:** ${new Date(release1.published_at).toLocaleDateString()}
125
+ **Release Notes:** ${release1.html_url}
126
+
127
+ ${release1.body.substring(0, 1000)}...
128
+
129
+ ## Version ${version2}
130
+ **Released:** ${new Date(release2.published_at).toLocaleDateString()}
131
+ **Release Notes:** ${release2.html_url}
132
+
133
+ ${release2.body.substring(0, 1000)}...
134
+
135
+ ## Migration Recommendations
136
+ 1. Review the full release notes at the URLs above
137
+ 2. Check for breaking changes in your dependencies
138
+ 3. Update your Spring Boot version gradually
139
+ 4. Test thoroughly in a staging environment
140
+
141
+ For detailed migration guides, visit: https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-3.0-Migration-Guide`;
142
+ this.cache.setLongTerm(cacheKey, result);
143
+ return result;
88
144
  }
89
145
  catch (error) {
90
146
  console.error('Error comparing versions:', error);
91
- throw new Error(`Failed to compare Spring Boot versions ${version1} and ${version2}`);
147
+ return `# Version Comparison Error\n\nUnable to compare versions ${version1} and ${version2}: ${error instanceof Error ? error.message : 'Unknown error'}`;
92
148
  }
93
149
  }
94
150
  /**
95
- * Get best practices
151
+ * Get best practices from official Spring documentation
96
152
  */
97
153
  async getBestPractices(category, experienceLevel = 'intermediate') {
98
154
  const cacheKey = `practices:${category}:${experienceLevel}`;
99
155
  const cached = this.cache.get(cacheKey);
100
156
  if (cached)
101
157
  return cached;
102
- const practices = this.getBestPracticesDatabase();
103
- const categoryPractices = practices[category];
104
- if (!categoryPractices) {
105
- const availableCategories = Object.keys(practices).join(', ');
106
- return `# Best Practices Not Found
158
+ try {
159
+ // Map categories to Spring Boot documentation sections
160
+ const docSections = {
161
+ 'architecture': 'spring-boot-features.html#boot-features-spring-application',
162
+ 'performance': 'actuator.html#actuator.metrics',
163
+ 'security': 'spring-security.html',
164
+ 'testing': 'spring-boot-features.html#boot-features-testing',
165
+ 'configuration': 'spring-boot-features.html#boot-features-external-config',
166
+ 'deployment': 'deployment.html'
167
+ };
168
+ const section = docSections[category];
169
+ if (!section) {
170
+ const availableCategories = Object.keys(docSections).join(', ');
171
+ return `# Best Practices Not Found\n\nCategory "${category}" not available.\n\n## Available Categories:\n${availableCategories}\n\nPlease use one of the available categories.`;
172
+ }
173
+ // Fetch from Spring Boot reference documentation
174
+ const docUrl = `${this.baseUrl}/spring-boot/docs/current/reference/html/${section}`;
175
+ const response = await this.fetchWithRetry(docUrl);
176
+ if (!response.ok) {
177
+ throw new Error(`Failed to fetch documentation: ${response.status}`);
178
+ }
179
+ const html = await response.text();
180
+ const $ = cheerio.load(html);
181
+ // Extract relevant content
182
+ const content = $('.content, .sect1, .chapter, main').first();
183
+ if (content.length === 0) {
184
+ throw new Error('No content found in documentation');
185
+ }
186
+ // Convert to markdown and format
187
+ const markdown = this.turndownService.turndown(content.html() || '');
188
+ const result = `# Spring Boot ${category.charAt(0).toUpperCase() + category.slice(1)} Best Practices
107
189
 
108
- Best practices for "${category}" category are not available.
190
+ **Experience Level:** ${experienceLevel}
191
+ **Source:** ${docUrl}
109
192
 
110
- ## Available Categories:
111
- ${availableCategories}
193
+ ${markdown.substring(0, 2000)}...
112
194
 
113
- Please use one of the available categories.`;
195
+ For complete documentation, visit: ${docUrl}`;
196
+ this.cache.setLongTerm(cacheKey, result);
197
+ return result;
198
+ }
199
+ catch (error) {
200
+ console.error('Error fetching best practices:', error);
201
+ return `# Best Practices Error\n\nUnable to fetch best practices for "${category}": ${error instanceof Error ? error.message : 'Unknown error'}`;
114
202
  }
115
- const result = this.formatBestPractices(categoryPractices, category, experienceLevel);
116
- this.cache.setLongTerm(cacheKey, result);
117
- return result;
118
203
  }
119
204
  /**
120
- * Diagnose Spring issues
205
+ * Diagnose issues using Spring Boot documentation
121
206
  */
122
207
  async diagnoseIssues(errorMessage, component, stackTrace) {
123
- const cacheKey = `diagnose:${this.hashString(errorMessage)}:${component || 'general'}`;
208
+ const cacheKey = `diagnosis:${errorMessage.substring(0, 50)}`;
124
209
  const cached = this.cache.get(cacheKey);
125
210
  if (cached)
126
211
  return cached;
127
- const diagnosis = this.performIssueDiagnosis(errorMessage, component, stackTrace);
128
- this.cache.set(cacheKey, diagnosis, 60 * 60 * 1000); // 1 hour cache
129
- return diagnosis;
212
+ try {
213
+ // Search for the error in Spring Boot documentation
214
+ const searchQuery = errorMessage.split(' ').slice(0, 3).join(' ');
215
+ const docs = await this.searchDocumentation(searchQuery, 3);
216
+ let result = `# Spring Boot Issue Diagnosis\n\n**Error:** ${errorMessage}\n`;
217
+ if (component) {
218
+ result += `**Component:** ${component}\n`;
219
+ }
220
+ result += `\n## Relevant Documentation\n\n`;
221
+ if (docs.length > 0) {
222
+ docs.forEach((doc, index) => {
223
+ result += `${index + 1}. **${doc.title}**\n ${doc.url}\n\n`;
224
+ });
225
+ }
226
+ else {
227
+ result += `No specific documentation found for this error.\n\n`;
228
+ }
229
+ result += `## General Troubleshooting Steps\n\n`;
230
+ result += `1. Check the Spring Boot documentation: https://docs.spring.io/spring-boot/docs/current/reference/html/\n`;
231
+ result += `2. Search Spring Boot issues: https://github.com/spring-projects/spring-boot/issues\n`;
232
+ result += `3. Enable debug logging: \`logging.level.org.springframework=DEBUG\`\n`;
233
+ result += `4. Check actuator health endpoint: \`/actuator/health\`\n\n`;
234
+ if (stackTrace) {
235
+ result += `## Stack Trace Analysis\n\nFor detailed stack trace analysis, consider:\n`;
236
+ result += `- Looking for the root cause in the stack trace\n`;
237
+ result += `- Checking for configuration issues\n`;
238
+ result += `- Verifying dependency versions\n\n`;
239
+ }
240
+ this.cache.set(cacheKey, result);
241
+ return result;
242
+ }
243
+ catch (error) {
244
+ console.error('Error diagnosing issue:', error);
245
+ return `# Diagnosis Error\n\nUnable to diagnose issue: ${error instanceof Error ? error.message : 'Unknown error'}`;
246
+ }
130
247
  }
131
- // Private helper methods
248
+ // Real implementation methods (no mock data)
132
249
  async searchProjects(query, limit) {
133
- // Simplified project search - in real implementation, this would fetch from Spring.io
134
- const mockProjects = [
135
- { name: 'Spring Boot', description: 'Create stand-alone, production-grade Spring applications', url: 'https://spring.io/projects/spring-boot' },
136
- { name: 'Spring Security', description: 'Powerful and highly customizable security framework', url: 'https://spring.io/projects/spring-security' },
137
- { name: 'Spring Data', description: 'Consistent programming model for data access', url: 'https://spring.io/projects/spring-data' },
138
- ];
139
- return mockProjects
140
- .filter(p => p.name.toLowerCase().includes(query.toLowerCase()) ||
141
- p.description.toLowerCase().includes(query.toLowerCase()))
142
- .slice(0, limit);
250
+ try {
251
+ const response = await this.fetchWithRetry(this.springProjectsUrl);
252
+ if (!response.ok) {
253
+ throw new Error('Failed to fetch Spring projects');
254
+ }
255
+ const html = await response.text();
256
+ const $ = cheerio.load(html);
257
+ const projects = [];
258
+ $('.project-list .project, .project-item, .card, .project-card').each((index, element) => {
259
+ const $project = $(element);
260
+ const name = $project.find('h2, h3, .title, .project-title, .card-title').first().text().trim();
261
+ const description = $project.find('p, .description, .summary, .card-text').first().text().trim();
262
+ const link = $project.find('a').first().attr('href');
263
+ if (name && description) {
264
+ const url = link?.startsWith('http') ? link : `https://spring.io${link}`;
265
+ if (name.toLowerCase().includes(query.toLowerCase()) ||
266
+ description.toLowerCase().includes(query.toLowerCase())) {
267
+ projects.push({ name, description, url, type: 'project' });
268
+ }
269
+ }
270
+ });
271
+ return projects.slice(0, limit);
272
+ }
273
+ catch (error) {
274
+ console.error('Error searching projects:', error);
275
+ return [];
276
+ }
143
277
  }
144
278
  async searchGuides(query, limit) {
145
- const mockGuides = [
146
- { title: 'Building a RESTful Web Service', url: 'https://spring.io/guides/gs/rest-service/', type: 'Getting Started' },
147
- { title: 'Accessing Data with JPA', url: 'https://spring.io/guides/gs/accessing-data-jpa/', type: 'Getting Started' },
148
- { title: 'Securing a Web Application', url: 'https://spring.io/guides/gs/securing-web/', type: 'Getting Started' },
149
- ];
150
- return mockGuides
151
- .filter(g => g.title.toLowerCase().includes(query.toLowerCase()))
152
- .slice(0, limit);
279
+ try {
280
+ const response = await this.fetchWithRetry(this.springGuideUrl);
281
+ if (!response.ok) {
282
+ throw new Error('Failed to fetch Spring guides');
283
+ }
284
+ const html = await response.text();
285
+ const $ = cheerio.load(html);
286
+ const guides = [];
287
+ $('.guide-item, .card, .guide-card, .list-item').each((index, element) => {
288
+ const $guide = $(element);
289
+ const title = $guide.find('h2, h3, .title, .guide-title, .card-title, a').first().text().trim();
290
+ const description = $guide.find('p, .description, .summary, .card-text').first().text().trim();
291
+ const link = $guide.find('a').first().attr('href');
292
+ const type = $guide.find('.badge, .label, .type').first().text().trim() || 'Guide';
293
+ if (title) {
294
+ const url = link?.startsWith('http') ? link : `https://spring.io${link}`;
295
+ if (title.toLowerCase().includes(query.toLowerCase()) ||
296
+ description.toLowerCase().includes(query.toLowerCase())) {
297
+ guides.push({ title, description: description || 'Spring Boot guide', url, type });
298
+ }
299
+ }
300
+ });
301
+ return guides.slice(0, limit);
302
+ }
303
+ catch (error) {
304
+ console.error('Error searching guides:', error);
305
+ return [];
306
+ }
153
307
  }
154
308
  async searchDocumentation(query, limit) {
155
- const mockDocs = [
156
- { title: 'Spring Boot Reference Documentation', url: 'https://docs.spring.io/spring-boot/docs/current/reference/', type: 'Reference' },
157
- { title: 'Spring Framework Documentation', url: 'https://docs.spring.io/spring-framework/docs/current/reference/', type: 'Reference' },
158
- ];
159
- return mockDocs
160
- .filter(d => d.title.toLowerCase().includes(query.toLowerCase()))
161
- .slice(0, limit);
309
+ try {
310
+ const bootDocsUrl = `${this.baseUrl}/spring-boot/docs/current/reference/html/`;
311
+ const response = await this.fetchWithRetry(bootDocsUrl);
312
+ if (!response.ok) {
313
+ throw new Error('Failed to fetch Spring Boot documentation');
314
+ }
315
+ const html = await response.text();
316
+ const $ = cheerio.load(html);
317
+ const docs = [];
318
+ $('nav a, .toc a, .nav-link, .chapter a').each((index, element) => {
319
+ const $link = $(element);
320
+ const title = $link.text().trim();
321
+ const href = $link.attr('href');
322
+ if (title && href && title.toLowerCase().includes(query.toLowerCase())) {
323
+ const url = href.startsWith('http') ? href : `${bootDocsUrl}${href}`;
324
+ docs.push({ title: `Spring Boot: ${title}`, url, type: 'Reference Documentation' });
325
+ }
326
+ });
327
+ return docs.slice(0, limit);
328
+ }
329
+ catch (error) {
330
+ console.error('Error searching documentation:', error);
331
+ return [];
332
+ }
162
333
  }
163
334
  async searchAPI(query, limit) {
164
- const mockAPI = [
165
- { title: 'Spring Boot API Documentation', url: 'https://docs.spring.io/spring-boot/docs/current/api/', type: 'API' },
166
- { title: 'Spring Framework API', url: 'https://docs.spring.io/spring-framework/docs/current/javadoc-api/', type: 'API' },
335
+ const apis = [
336
+ { title: 'Spring Boot API Documentation', url: 'https://docs.spring.io/spring-boot/docs/current/api/', keywords: ['boot', 'autoconfiguration', 'starters'] },
337
+ { title: 'Spring Framework API', url: 'https://docs.spring.io/spring-framework/docs/current/javadoc-api/', keywords: ['core', 'context', 'beans', 'web'] },
338
+ { title: 'Spring Security API', url: 'https://docs.spring.io/spring-security/site/docs/current/api/', keywords: ['security', 'authentication', 'config'] },
339
+ { title: 'Spring Data JPA API', url: 'https://docs.spring.io/spring-data/jpa/docs/current/api/', keywords: ['jpa', 'repository', 'query'] }
167
340
  ];
168
- return mockAPI
169
- .filter(a => a.title.toLowerCase().includes(query.toLowerCase()))
341
+ const queryLower = query.toLowerCase();
342
+ return apis
343
+ .filter(a => a.title.toLowerCase().includes(queryLower) ||
344
+ a.keywords.some(keyword => keyword.toLowerCase().includes(queryLower)))
345
+ .map(a => ({ title: a.title, url: a.url, type: 'API Documentation' }))
170
346
  .slice(0, limit);
171
347
  }
172
- getTutorialDatabase() {
173
- return {
174
- 'rest-api': {
175
- beginner: `# Building Your First REST API with Spring Boot
176
-
177
- ## Prerequisites
178
- - Java 11 or higher
179
- - Basic understanding of Java
180
- - Maven or Gradle
181
-
182
- ## Step 1: Create a New Spring Boot Project
183
- \`\`\`bash
184
- curl https://start.spring.io/starter.zip \\
185
- -d dependencies=web \\
186
- -d name=my-rest-api \\
187
- -d packageName=com.example.api \\
188
- -o my-rest-api.zip
189
- \`\`\`
190
-
191
- ## Step 2: Create a Simple Controller
192
- \`\`\`java
193
- @RestController
194
- @RequestMapping("/api")
195
- public class HelloController {
196
-
197
- @GetMapping("/hello")
198
- public String hello() {
199
- return "Hello, World!";
200
- }
201
-
202
- @GetMapping("/hello/{name}")
203
- public String helloName(@PathVariable String name) {
204
- return "Hello, " + name + "!";
205
- }
206
- }
207
- \`\`\`
208
-
209
- ## Step 3: Run the Application
210
- \`\`\`bash
211
- ./mvnw spring-boot:run
212
- \`\`\`
213
-
214
- ## Step 4: Test Your API
215
- \`\`\`bash
216
- curl http://localhost:8080/api/hello
217
- curl http://localhost:8080/api/hello/John
218
- \`\`\`
219
-
220
- ## Next Steps
221
- - Add request/response DTOs
222
- - Implement POST, PUT, DELETE methods
223
- - Add input validation
224
- - Handle exceptions properly`,
225
- intermediate: `# Advanced REST API Development with Spring Boot
226
-
227
- ## Data Transfer Objects (DTOs)
228
- \`\`\`java
229
- public class UserDto {
230
- @NotBlank
231
- private String name;
232
-
233
- @Email
234
- private String email;
235
-
236
- // getters and setters
237
- }
238
- \`\`\`
239
-
240
- ## Service Layer
241
- \`\`\`java
242
- @Service
243
- public class UserService {
244
-
245
- @Autowired
246
- private UserRepository userRepository;
247
-
248
- public UserDto createUser(UserDto userDto) {
249
- User user = mapToEntity(userDto);
250
- User savedUser = userRepository.save(user);
251
- return mapToDto(savedUser);
252
- }
253
- }
254
- \`\`\`
255
-
256
- ## Exception Handling
257
- \`\`\`java
258
- @ControllerAdvice
259
- public class GlobalExceptionHandler {
260
-
261
- @ExceptionHandler(ValidationException.class)
262
- public ResponseEntity<ErrorResponse> handleValidation(ValidationException ex) {
263
- return ResponseEntity.badRequest()
264
- .body(new ErrorResponse("Validation failed", ex.getMessage()));
265
- }
266
- }
267
- \`\`\`
268
-
269
- ## Testing
270
- \`\`\`java
271
- @SpringBootTest
272
- @AutoConfigureTestDatabase
273
- class UserControllerTest {
274
-
275
- @Autowired
276
- private TestRestTemplate restTemplate;
277
-
278
- @Test
279
- void shouldCreateUser() {
280
- UserDto user = new UserDto("John", "john@example.com");
281
- ResponseEntity<UserDto> response = restTemplate.postForEntity(
282
- "/api/users", user, UserDto.class);
283
-
284
- assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED);
285
- }
286
- }
287
- \`\`\``,
288
- advanced: `# Production-Ready REST API with Spring Boot
289
-
290
- ## Advanced Features Implementation
291
-
292
- ### 1. API Versioning
293
- \`\`\`java
294
- @RestController
295
- @RequestMapping("/api/v1/users")
296
- public class UserControllerV1 {
297
- // Version 1 implementation
298
- }
299
-
300
- @RestController
301
- @RequestMapping("/api/v2/users")
302
- public class UserControllerV2 {
303
- // Version 2 with breaking changes
304
- }
305
- \`\`\`
306
-
307
- ### 2. HATEOAS Implementation
308
- \`\`\`java
309
- @GetMapping("/{id}")
310
- public EntityModel<UserDto> getUser(@PathVariable Long id) {
311
- UserDto user = userService.findById(id);
312
- return EntityModel.of(user)
313
- .add(linkTo(methodOn(UserController.class).getUser(id)).withSelfRel())
314
- .add(linkTo(UserController.class).withRel("users"));
315
- }
316
- \`\`\`
317
-
318
- ### 3. Advanced Security
319
- \`\`\`java
320
- @Configuration
321
- @EnableWebSecurity
322
- public class SecurityConfig {
323
-
324
- @Bean
325
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
326
- http.oauth2ResourceServer(oauth2 -> oauth2.jwt(withDefaults()))
327
- .authorizeHttpRequests(authz -> authz
328
- .requestMatchers("/api/public/**").permitAll()
329
- .requestMatchers(HttpMethod.GET, "/api/users").hasRole("USER")
330
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
331
- .anyRequest().authenticated()
332
- );
333
- return http.build();
334
- }
335
- }
336
- \`\`\`
337
-
338
- ### 4. Metrics and Monitoring
339
- \`\`\`java
340
- @Component
341
- public class ApiMetrics {
342
-
343
- private final MeterRegistry meterRegistry;
344
- private final Counter apiCallCounter;
345
-
346
- public ApiMetrics(MeterRegistry meterRegistry) {
347
- this.meterRegistry = meterRegistry;
348
- this.apiCallCounter = Counter.builder("api.calls")
349
- .description("Number of API calls")
350
- .register(meterRegistry);
351
- }
352
- }
353
- \`\`\`
354
-
355
- ### 5. Rate Limiting
356
- \`\`\`java
357
- @Component
358
- public class RateLimitingFilter implements Filter {
359
-
360
- private final RedisTemplate<String, String> redisTemplate;
361
-
362
- @Override
363
- public void doFilter(ServletRequest request, ServletResponse response,
364
- FilterChain chain) throws IOException, ServletException {
365
-
366
- String clientId = getClientId(request);
367
- if (isRateLimited(clientId)) {
368
- ((HttpServletResponse) response).setStatus(429);
369
- return;
348
+ formatEcosystemResults(results) {
349
+ let output = `# Spring Ecosystem Search Results\n\n`;
350
+ output += `**Query:** ${results.query}\n`;
351
+ output += `**Scope:** ${results.scope}\n`;
352
+ output += `**Total Results:** ${results.totalResults}\n\n`;
353
+ if (results.categories.projects?.length > 0) {
354
+ output += `## Projects\n\n`;
355
+ results.categories.projects.forEach((project, index) => {
356
+ output += `${index + 1}. **${project.name}**\n`;
357
+ output += ` ${project.description}\n`;
358
+ output += ` URL: ${project.url}\n\n`;
359
+ });
370
360
  }
371
-
372
- chain.doFilter(request, response);
373
- }
374
- }
375
- \`\`\``
376
- },
377
- // Add more tutorials for other topics
378
- };
379
- }
380
- async generateVersionComparison(version1, version2, focus) {
381
- // This would fetch actual version data in a real implementation
382
- return `# Spring Boot Version Comparison: ${version1} vs ${version2}
383
-
384
- ## Overview
385
- Comparing Spring Boot ${version1} with ${version2}
386
-
387
- ## Major Changes
388
- ${focus === 'all' || focus === 'breaking-changes' ? `
389
- ### Breaking Changes
390
- - Java version requirements updated
391
- - Configuration property changes
392
- - Deprecated APIs removed
393
- ` : ''}
394
-
395
- ${focus === 'all' || focus === 'new-features' ? `
396
- ### New Features
397
- - Enhanced auto-configuration
398
- - New starters available
399
- - Improved monitoring capabilities
400
- ` : ''}
401
-
402
- ${focus === 'all' || focus === 'deprecations' ? `
403
- ### Deprecations
404
- - Legacy configuration support
405
- - Outdated dependencies
406
- - Old API patterns
407
- ` : ''}
408
-
409
- ## Migration Guide
410
- 1. Update Java version if required
411
- 2. Update dependency versions
412
- 3. Review configuration changes
413
- 4. Test thoroughly
414
-
415
- ## Recommendation
416
- ${this.getUpgradeRecommendation(version1, version2)}`;
417
- }
418
- getBestPracticesDatabase() {
419
- return {
420
- architecture: {
421
- title: 'Spring Boot Architecture Best Practices',
422
- practices: [
423
- {
424
- title: 'Layer Separation',
425
- description: 'Maintain clear separation between presentation, business, and data layers',
426
- examples: ['Controller → Service → Repository pattern', 'Use DTOs for data transfer'],
427
- level: ['beginner', 'intermediate', 'expert']
428
- },
429
- {
430
- title: 'Dependency Injection',
431
- description: 'Use constructor injection and avoid field injection',
432
- examples: ['@Autowired on constructors', 'Final fields for dependencies'],
433
- level: ['intermediate', 'expert']
434
- }
435
- ]
436
- },
437
- performance: {
438
- title: 'Performance Optimization',
439
- practices: [
440
- {
441
- title: 'Lazy Loading',
442
- description: 'Use lazy loading for JPA relationships',
443
- examples: ['@OneToMany(fetch = FetchType.LAZY)', 'Use @EntityGraph for specific queries'],
444
- level: ['intermediate', 'expert']
445
- },
446
- {
447
- title: 'Connection Pooling',
448
- description: 'Configure proper database connection pooling',
449
- examples: ['HikariCP configuration', 'Monitor connection usage'],
450
- level: ['expert']
451
- }
452
- ]
453
- }
454
- // Add more categories...
455
- };
456
- }
457
- formatBestPractices(practices, category, level) {
458
- const filtered = practices.practices.filter((p) => p.level.includes(level));
459
- let result = `# ${practices.title}\n\n`;
460
- result += `**Experience Level:** ${level}\n\n`;
461
- filtered.forEach((practice, index) => {
462
- result += `## ${index + 1}. ${practice.title}\n\n`;
463
- result += `${practice.description}\n\n`;
464
- result += `**Examples:**\n`;
465
- practice.examples.forEach((example) => {
466
- result += `- ${example}\n`;
361
+ if (results.categories.guides?.length > 0) {
362
+ output += `## Guides\n\n`;
363
+ results.categories.guides.forEach((guide, index) => {
364
+ output += `${index + 1}. **${guide.title}**\n`;
365
+ if (guide.description)
366
+ output += ` ${guide.description}\n`;
367
+ output += ` URL: ${guide.url}\n\n`;
467
368
  });
468
- result += '\n';
469
- });
470
- return result;
471
- }
472
- performIssueDiagnosis(errorMessage, component, stackTrace) {
473
- const commonIssues = {
474
- 'Port 8080 was already in use': {
475
- cause: 'Another application is using the default Spring Boot port',
476
- solutions: [
477
- 'Change port in application.properties: server.port=8081',
478
- 'Kill the process using port 8080',
479
- 'Use a different port for your application'
480
- ]
481
- },
482
- 'Failed to configure a DataSource': {
483
- cause: 'Database configuration is missing or incorrect',
484
- solutions: [
485
- 'Add database dependency to pom.xml/build.gradle',
486
- 'Configure datasource properties in application.properties',
487
- 'Use @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class}) if no database needed'
488
- ]
489
- },
490
- 'NoSuchBeanDefinitionException': {
491
- cause: 'Required bean is not found in the application context',
492
- solutions: [
493
- 'Check if the class is annotated with @Component, @Service, @Repository, or @Controller',
494
- 'Ensure the class is in a package scanned by @ComponentScan',
495
- 'Verify @Autowired dependencies are correctly configured'
496
- ]
497
- }
498
- };
499
- for (const [pattern, issue] of Object.entries(commonIssues)) {
500
- if (errorMessage.includes(pattern)) {
501
- return `# Spring Boot Issue Diagnosis
502
-
503
- ## Error Analysis
504
- **Error:** ${errorMessage}
505
- ${component ? `**Component:** ${component}` : ''}
506
-
507
- ## Root Cause
508
- ${issue.cause}
509
-
510
- ## Recommended Solutions
511
- ${issue.solutions.map((solution, index) => `${index + 1}. ${solution}`).join('\n')}
512
-
513
- ${stackTrace ? `
514
- ## Stack Trace Analysis
515
- The provided stack trace shows:
516
- \`\`\`
517
- ${stackTrace.substring(0, 500)}${stackTrace.length > 500 ? '...' : ''}
518
- \`\`\`
519
- ` : ''}
520
-
521
- ## Additional Resources
522
- - [Spring Boot Documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/)
523
- - [Common Application Properties](https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html)`;
524
- }
525
369
  }
526
- return `# Spring Boot Issue Diagnosis
527
-
528
- ## Error Analysis
529
- **Error:** ${errorMessage}
530
- ${component ? `**Component:** ${component}` : ''}
531
-
532
- ## Diagnosis
533
- This appears to be a custom or less common error. Here are general troubleshooting steps:
534
-
535
- 1. **Check Logs:** Review the full stack trace for more context
536
- 2. **Verify Configuration:** Ensure all properties are correctly set
537
- 3. **Dependencies:** Check if all required dependencies are included
538
- 4. **Version Compatibility:** Verify Spring Boot and dependency versions are compatible
539
-
540
- ## Recommended Actions
541
- 1. Enable debug logging: \`logging.level.org.springframework=DEBUG\`
542
- 2. Check Spring Boot documentation for the specific component
543
- 3. Search Spring Boot GitHub issues for similar problems
544
- 4. Consider posting on Stack Overflow with the full stack trace
545
-
546
- ${stackTrace ? `
547
- ## Stack Trace Analysis
548
- \`\`\`
549
- ${stackTrace.substring(0, 500)}${stackTrace.length > 500 ? '...' : ''}
550
- \`\`\`
551
- ` : ''}`;
552
- }
553
- getUpgradeRecommendation(version1, version2) {
554
- // Simplified version comparison logic
555
- const v1Major = parseInt(version1.split('.')[0]);
556
- const v2Major = parseInt(version2.split('.')[0]);
557
- if (v2Major > v1Major) {
558
- return `🚨 Major version upgrade detected. This may include breaking changes. Plan for thorough testing and potential code modifications.`;
370
+ if (results.categories.documentation?.length > 0) {
371
+ output += `## Documentation\n\n`;
372
+ results.categories.documentation.forEach((doc, index) => {
373
+ output += `${index + 1}. **${doc.title}**\n`;
374
+ output += ` URL: ${doc.url}\n\n`;
375
+ });
559
376
  }
560
- else {
561
- return `✅ Minor/patch version upgrade. Generally safe to upgrade with minimal breaking changes expected.`;
377
+ if (results.categories.api?.length > 0) {
378
+ output += `## Api\n\n`;
379
+ results.categories.api.forEach((api, index) => {
380
+ output += `${index + 1}. **${api.title}**\n`;
381
+ output += ` URL: ${api.url}\n\n`;
382
+ });
562
383
  }
384
+ if (results.totalResults === 0) {
385
+ output += `No results found for "${results.query}" in scope "${results.scope}".`;
386
+ }
387
+ return output;
563
388
  }
564
- hashString(str) {
565
- let hash = 0;
566
- for (let i = 0; i < str.length; i++) {
567
- const char = str.charCodeAt(i);
568
- hash = ((hash << 5) - hash) + char;
569
- hash = hash & hash; // Convert to 32-bit integer
389
+ async fetchWithRetry(url, timeout = this.REQUEST_TIMEOUT, retries = this.MAX_RETRIES) {
390
+ for (let attempt = 1; attempt <= retries; attempt++) {
391
+ const controller = new AbortController();
392
+ const timeoutId = setTimeout(() => controller.abort(), timeout);
393
+ try {
394
+ const response = await fetch(url, {
395
+ signal: controller.signal,
396
+ headers: {
397
+ 'User-Agent': 'Spring-Docs-MCP/1.2.4',
398
+ 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
399
+ 'Accept-Language': 'en-US,en;q=0.9'
400
+ }
401
+ });
402
+ clearTimeout(timeoutId);
403
+ return response;
404
+ }
405
+ catch (error) {
406
+ clearTimeout(timeoutId);
407
+ if (attempt === retries)
408
+ throw error;
409
+ console.error(`Retry ${attempt}/${retries} for ${url}:`, error instanceof Error ? error.message : 'Unknown error');
410
+ await new Promise(resolve => setTimeout(resolve, 1000 * attempt));
411
+ }
570
412
  }
571
- return Math.abs(hash).toString();
413
+ throw new Error('All retry attempts failed');
572
414
  }
573
415
  }
574
416
  //# sourceMappingURL=advanced-features.js.map