generator-jhipster-sentry-module 1.0.11 → 1.0.13

package/README.md

@@ -151,20 +151,20 @@ After running the generator, verify that Sentry has been added successfully by c
   ```xml
   <dependency>
       <groupId>io.sentry</groupId>
-      <artifactId>sentry-spring-boot-starter</artifactId>
-      <version>7.3.0</version>
+      <artifactId>sentry-spring-boot-starter-jakarta</artifactId>
+      <version>8.29.0</version>
   </dependency>
   ```
 
 **Gradle Projects:**
 - ✅ Check `build.gradle` for Sentry dependency:
   ```gradle
-  implementation 'io.sentry:sentry-spring-boot-starter:7.3.0'
+  implementation 'io.sentry:sentry-spring-boot-starter-jakarta:8.29.0'
   ```
 
 **Frontend (package.json):**
-- ✅ For React: Check for `@sentry/react: ^7.3.0`
-- ✅ For Angular: Check for `@sentry/angular: ^7.3.0`
+- ✅ For React: Check for `@sentry/react: ^8.29.0`
+- ✅ For Angular: Check for `@sentry/angular: ^8.29.0`
 
 ### 3. Check Module Registration
 
@@ -185,7 +185,7 @@ After running the generator, verify that Sentry has been added successfully by c
 **Backend (Spring Boot):**
 - ✅ Sentry should auto-configure when Spring Boot starts
 - ✅ Check application logs for Sentry initialization
-- ✅ Test by throwing an exception - it should appear in Sentry dashboard
+- ✅ A `SentryTestResource` is added at `.../web/rest/SentryTestResource.java` with `GET /api/sentry-test/illegal-argument` and `GET /api/sentry-test/null-pointer` to test Sentry
 
 **Frontend:**
 - ✅ Import and initialize Sentry in your main app file:
@@ -200,14 +200,29 @@ After running the generator, verify that Sentry has been added successfully by c
 
 ### 5. Test Sentry Integration
 
-**Backend Test:**
-```java
-// Create a test endpoint or add to existing controller
-@GetMapping("/api/test-sentry")
-public void testSentry() {
-    throw new RuntimeException("Test Sentry integration");
-}
-```
+The module adds a **Sentry test REST controller** with two endpoints you can call to verify Sentry captures backend exceptions.
+
+**Backend test endpoints** (in `SentryTestResource`):
+
+| Endpoint | Description |
+|----------|-------------|
+| `GET /api/sentry-test/illegal-argument` | Throws `IllegalArgumentException` and sends it to Sentry |
+| `GET /api/sentry-test/null-pointer` | Throws `NullPointerException`, logs a formatted message, and sends the exception to Sentry |
+
+**How to test (backend):**
+
+1. Start your application (e.g. `./mvnw spring-boot:run` or `./gradlew bootRun`).
+2. Call one of the endpoints (they will return 500 and the error will appear in Sentry):
+
+   ```bash
+   # Test IllegalArgumentException
+   curl -s -o /dev/null -w "%{http_code}" http://localhost:8080/api/sentry-test/illegal-argument
+
+   # Test NullPointerException (also sends a formatted log as breadcrumb)
+   curl -s -o /dev/null -w "%{http_code}" http://localhost:8080/api/sentry-test/null-pointer
+   ```
+
+3. Check your Sentry project dashboard; you should see the two exceptions with stack traces.
 
 **Frontend Test:**
 ```typescript

package/generators/app/index.js

@@ -1,4 +1,3 @@
-const path = require('path');
 const fs = require('fs');
 const chalk = require('chalk');
 const semver = require('semver');
@@ -8,7 +7,6 @@ const packageJson = require('../../package.json');
 const JHIPSTER_CONFIG_KEY = 'generator-jhipster';
 
 const jhipsterConstants = {
-  SERVER_MAIN_SRC_DIR: 'src/main/java/',
   SERVER_MAIN_RES_DIR: 'src/main/resources/',
   CLIENT_MAIN_SRC_DIR: 'src/main/webapp/'
 };
@@ -27,7 +25,7 @@ module.exports = class extends Generator {
     this.jhipsterAppConfig = yoRc[JHIPSTER_CONFIG_KEY];
 
     if (!this.jhipsterAppConfig) {
-      this.log(chalk.red('❌ JHipster configuration missing inside .yo-rc.json'));
+      this.log(chalk.red('❌ JHipster config missing in .yo-rc.json'));
       process.exit(1);
     }
 
@@ -38,7 +36,6 @@ module.exports = class extends Generator {
     );
 
     const currentVersion = this.jhipsterAppConfig.jhipsterVersion;
-
     if (currentVersion && !semver.satisfies(currentVersion, '>=8.0.0')) {
       this.log(
         chalk.yellow(
@@ -79,7 +76,10 @@ module.exports = class extends Generator {
       buildTool
     } = this.jhipsterAppConfig;
 
+    const resourceDir = jhipsterConstants.SERVER_MAIN_RES_DIR;
+    const javaDir = 'src/main/java/';
     const webappDir = jhipsterConstants.CLIENT_MAIN_SRC_DIR;
+    const packageFolderResolved = packageFolder || packageName.replace(/\./g, '/');
 
     this.log('\n--- JHipster Config ---');
     this.log(`baseName=${baseName}`);
@@ -99,9 +99,34 @@ module.exports = class extends Generator {
       enabled: true,
       dsn: this.promptAnswers.sentryDsn
     };
-
     this.fs.writeJSON(yoRcPath, yoRc, null, 2);
 
+    /* ============================
+       Create sentry.yml
+    ============================= */
+
+    this.fs.copyTpl(
+      this.templatePath('server/sentry-application.yml.ejs'),
+      this.destinationPath(`${resourceDir}config/sentry.yml`),
+      {
+        jhipsterAppConfig: {
+          sentry: {
+            dsn: this.promptAnswers.sentryDsn
+          }
+        }
+      }
+    );
+
+    /* ============================
+       Sentry test REST controller
+    ============================= */
+
+    this.fs.copyTpl(
+      this.templatePath('server/java/SentryTestResource.java.ejs'),
+      this.destinationPath(`${javaDir}${packageFolderResolved}/web/rest/SentryTestResource.java`),
+      { packageName }
+    );
+
     /* ============================
        Backend Dependency Injection
     ============================= */
@@ -110,14 +135,14 @@ module.exports = class extends Generator {
       const pomPath = this.destinationPath('pom.xml');
       if (fs.existsSync(pomPath)) {
         let pom = fs.readFileSync(pomPath, 'utf8');
-        if (!pom.includes('sentry-spring-boot-starter')) {
+        if (!pom.includes('sentry-spring-boot-starter-jakarta')) {
           pom = pom.replace(
             '</dependencies>',
             `
         <dependency>
             <groupId>io.sentry</groupId>
-            <artifactId>sentry-spring-boot-starter</artifactId>
-            <version>7.3.0</version>
+            <artifactId>sentry-spring-boot-starter-jakarta</artifactId>
+            <version>8.29.0</version>
         </dependency>
     </dependencies>`
           );
@@ -130,10 +155,10 @@ module.exports = class extends Generator {
       const gradlePath = this.destinationPath('build.gradle');
       if (fs.existsSync(gradlePath)) {
         let gradle = fs.readFileSync(gradlePath, 'utf8');
-        if (!gradle.includes('sentry-spring-boot-starter')) {
+        if (!gradle.includes('sentry-spring-boot-starter-jakarta')) {
           gradle += `
 dependencies {
-    implementation "io.sentry:sentry-spring-boot-starter:7.3.0"
+    implementation "io.sentry:sentry-spring-boot-starter-jakarta:8.29.0"
 }
 `;
           fs.writeFileSync(gradlePath, gradle);
@@ -142,7 +167,7 @@ dependencies {
     }
 
     /* ============================
-       Frontend Dependency Injection
+       Frontend Dependency + File
     ============================= */
 
     const packagePath = this.destinationPath('package.json');
@@ -151,7 +176,7 @@ dependencies {
       pkg.dependencies = pkg.dependencies || {};
 
       if (clientFramework === 'react') {
-        pkg.dependencies['@sentry/react'] = '^7.3.0';
+        pkg.dependencies['@sentry/react'] = '^8.29.0';
 
         this.fs.copyTpl(
           this.templatePath('client/react/sentry.ts.ejs'),
@@ -161,7 +186,7 @@ dependencies {
       }
 
       if (clientFramework === 'angularX') {
-        pkg.dependencies['@sentry/angular'] = '^7.3.0';
+        pkg.dependencies['@sentry/angular'] = '^8.29.0';
 
         this.fs.copyTpl(
           this.templatePath('client/angular/sentry.ts.ejs'),
@@ -177,17 +202,15 @@ dependencies {
   install() {
     if (!this.promptAnswers.enableSentry) return;
 
-    const clientPackageManager =
+    const pkgManager =
       this.jhipsterAppConfig.clientPackageManager || 'npm';
 
     if (this.options['skip-install']) {
-      this.log(
-        `Run ${clientPackageManager} install manually to install dependencies`
-      );
+      this.log(`Run ${pkgManager} install manually.`);
       return;
     }
 
-    this.spawnCommandSync(clientPackageManager, ['install']);
+    this.spawnCommandSync(pkgManager, ['install']);
   }
 
   end() {

package/generators/app/templates/server/java/SentryTestResource.java.ejs

@@ -0,0 +1,51 @@
+package <%= packageName %>.web.rest;
+
+import io.sentry.Sentry;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * REST controller for testing Sentry error reporting.
+ * Exposes endpoints that trigger exceptions and send them to Sentry.
+ */
+@RestController
+@RequestMapping("/api/sentry-test")
+public class SentryTestResource {
+
+    private static final Logger LOG = LoggerFactory.getLogger(SentryTestResource.class);
+
+    /**
+     * Triggers an IllegalArgumentException and sends it to Sentry.
+     * Use this endpoint to verify Sentry captures backend exceptions.
+     */
+    @GetMapping("/illegal-argument")
+    public ResponseEntity<Void> testIllegalArgument() {
+        LOG.error("Testing Sentry IllegalArgumentException");
+        try {
+            throw new IllegalArgumentException("This is a test IllegalArgumentException for Sentry");
+        } catch (Exception e) {
+            Sentry.captureException(e);
+            throw e;
+        }
+    }
+
+    /**
+     * Triggers a NullPointerException and sends it to Sentry, plus a formatted log message.
+     * Use this endpoint to verify Sentry captures backend exceptions and breadcrumbs.
+     */
+    @GetMapping("/null-pointer")
+    public ResponseEntity<Void> testNullPointer() {
+        LOG.error("Testing Sentry NullPointerException");
+        try {
+            throw new NullPointerException("This is a test NullPointerException for Sentry");
+        } catch (Exception e) {
+            Sentry.logger().error("A %s log message", "formatted");
+            Sentry.captureException(e);
+            throw e;
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-jhipster-sentry-module",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "Adding Sentry integration to JHipster projects",
   "keywords": [
     "yeoman-generator",