generator-jhipster-sentry-module 1.0.0

package/README.md

@@ -0,0 +1,190 @@
+# generator-jhipster-sentry-module
+
+[![NPM version][npm-image]][npm-url] [![Build Status][github-actions-image]][github-actions-url] [![Dependency Status][daviddm-image]][daviddm-url]
+
+> JHipster module, adding sentry to jhipster generator
+
+# Introduction
+
+This is a [JHipster](https://www.jhipster.tech/) module, that is meant to be used in a JHipster application.
+
+# Prerequisites
+
+As this is a [JHipster](https://www.jhipster.tech/) module, we expect you have JHipster and its related tools already installed:
+
+- [Installing JHipster](https://www.jhipster.tech/installation/)
+
+# Installation
+
+## With NPM
+
+To install this module:
+
+```bash
+npm install -g generator-jhipster-sentry-module
+```
+
+To update this module:
+
+```bash
+npm update -g generator-jhipster-sentry-module
+```
+
+## With Yarn
+
+To install this module:
+
+```bash
+yarn global add generator-jhipster-sentry-module
+```
+
+To update this module:
+
+```bash
+yarn global upgrade generator-jhipster-sentry-module
+```
+
+# Usage
+
+After installing the module, run it in your JHipster project:
+
+```bash
+yo jhipster-sentry-module
+```
+
+The generator will prompt you to:
+- Enable/disable Sentry integration
+- Enter your Sentry DSN (if enabled)
+
+## Verifying Sentry Integration
+
+After running the generator, verify that Sentry has been added successfully by checking the following:
+
+### 1. Check Configuration Files
+
+**Backend Configuration:**
+- ✅ Verify `src/main/resources/config/sentry.yml` exists
+- ✅ Check that it contains your Sentry DSN:
+  ```yaml
+  sentry:
+    dsn: "https://your-dsn@sentry.io/project-id"
+    environment: dev
+    traces-sample-rate: 0.2
+  ```
+
+**Frontend Configuration:**
+- ✅ Verify `src/main/webapp/app/sentry.ts` exists (for React/Angular)
+- ✅ Check that it contains your Sentry DSN:
+  ```typescript
+  Sentry.init({
+    dsn: 'https://your-dsn@sentry.io/project-id',
+    environment: 'dev',
+  });
+  ```
+
+### 2. Check Dependencies
+
+**Maven Projects:**
+- ✅ Check `pom.xml` for Sentry dependency:
+  ```xml
+  <dependency>
+      <groupId>io.sentry</groupId>
+      <artifactId>sentry-spring-boot-starter</artifactId>
+      <version>7.3.0</version>
+  </dependency>
+  ```
+
+**Gradle Projects:**
+- ✅ Check `build.gradle` for Sentry dependency:
+  ```gradle
+  implementation 'io.sentry:sentry-spring-boot-starter:7.3.0'
+  ```
+
+**Frontend (package.json):**
+- ✅ For React: Check for `@sentry/react: ^7.3.0`
+- ✅ For Angular: Check for `@sentry/angular: ^7.3.0`
+
+### 3. Check Module Registration
+
+- ✅ Verify `.yo-rc.json` contains Sentry configuration:
+  ```json
+  {
+    "generator-jhipster": {
+      "sentry": {
+        "enabled": true,
+        "dsn": "https://your-dsn@sentry.io/project-id"
+      }
+    }
+  }
+  ```
+
+### 4. Verify Integration in Code
+
+**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
+
+**Frontend:**
+- ✅ Import and initialize Sentry in your main app file:
+  ```typescript
+  // For React
+  import './sentry';
+  
+  // For Angular
+  import './sentry';
+  ```
+- ✅ Add the import in `src/main/webapp/app/app.tsx` (React) or `src/main/webapp/app/app.module.ts` (Angular)
+
+### 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");
+}
+```
+
+**Frontend Test:**
+```typescript
+// Add to a component or service
+try {
+  throw new Error('Test Sentry integration');
+} catch (error) {
+  Sentry.captureException(error);
+}
+```
+
+### 6. Verify in Sentry Dashboard
+
+1. ✅ Start your application
+2. ✅ Trigger a test error (backend or frontend)
+3. ✅ Check your Sentry project dashboard
+4. ✅ Verify the error appears with stack trace and context
+
+### Troubleshooting
+
+**If Sentry files are missing:**
+- Run the generator again: `yo jhipster-sentry-module`
+- Check that you answered "yes" to enable Sentry
+
+**If dependencies are missing:**
+- Run `npm install` (for frontend)
+- Run `./mvnw clean install` (Maven) or `./gradlew build` (Gradle)
+
+**If errors don't appear in Sentry:**
+- Verify your DSN is correct in configuration files
+- Check Sentry project settings
+- Verify network connectivity to Sentry servers
+- Check application logs for Sentry initialization errors
+
+# License
+
+[npm-image]: https://img.shields.io/npm/v/generator-jhipster-sentry-module.svg
+[npm-url]: https://npmjs.org/package/generator-jhipster-sentry-module
+[github-actions-image]: https://github.com/Sara/generator-jhipster-sentry-module/workflows/Build/badge.svg
+[github-actions-url]: https://github.com/Sara/generator-jhipster-sentry-module/actions
+[daviddm-image]: https://david-dm.org/Sara/generator-jhipster-sentry-module.svg?theme=shields.io
+[daviddm-url]: https://david-dm.org/Sara/generator-jhipster-sentry-module

package/generators/app/index.js

@@ -0,0 +1,211 @@
+const chalk = require('chalk');
+const semver = require('semver');
+const BaseGenerator = require('generator-jhipster/generators/generator-base');
+const jhipsterConstants = require('generator-jhipster/generators/generator-constants');
+const packagejs = require('../../package.json');
+
+module.exports = class extends BaseGenerator {
+    get initializing() {
+        return {
+            init(args) {
+                if (args === 'default') {
+                    this.message = 'default message';
+                }
+            },
+
+            readConfig() {
+                this.jhipsterAppConfig = this.getAllJhipsterConfig();
+                if (!this.jhipsterAppConfig) {
+                    this.error('Cannot read .yo-rc.json');
+                }
+            },
+
+            displayLogo() {
+                this.printJHipsterLogo();
+                this.log(
+                    `\nWelcome to the ${chalk.bold.yellow(
+                        'JHipster Sentry Module'
+                    )} generator! ${chalk.yellow(`v${packagejs.version}\n`)}`
+                );
+            },
+
+            checkJhipster() {
+                const currentJhipsterVersion = this.jhipsterAppConfig.jhipsterVersion;
+                const minimumJhipsterVersion = packagejs.dependencies['generator-jhipster'];
+
+                if (!semver.satisfies(currentJhipsterVersion, minimumJhipsterVersion)) {
+                    this.warning(
+                        `\nYour generated project uses JHipster ${currentJhipsterVersion}. ` +
+                        `Minimum required is ${minimumJhipsterVersion}\n`
+                    );
+                }
+            }
+        };
+    }
+
+    prompting() {
+        const prompts = [
+            {
+                type: 'confirm',
+                name: 'enableSentry',
+                message: 'Do you want to enable Sentry error tracking?',
+                default: true
+            },
+            {
+                when: answers => answers.enableSentry,
+                type: 'input',
+                name: 'sentryDsn',
+                message: 'Enter your Sentry DSN'
+            }
+        ];
+
+        const done = this.async();
+        this.prompt(prompts).then(answers => {
+            this.promptAnswers = answers;
+            done();
+        });
+    }
+
+    writing() {
+        /* -------------------------------
+         * Read JHipster config
+         * ----------------------------- */
+        this.baseName = this.jhipsterAppConfig.baseName;
+        this.packageName = this.jhipsterAppConfig.packageName;
+        this.packageFolder = this.jhipsterAppConfig.packageFolder;
+        this.clientFramework = this.jhipsterAppConfig.clientFramework;
+        this.clientPackageManager = this.jhipsterAppConfig.clientPackageManager;
+        this.buildTool = this.jhipsterAppConfig.buildTool;
+
+        this.angularAppName = this.getAngularAppName();
+
+        const javaDir = `${jhipsterConstants.SERVER_MAIN_SRC_DIR}${this.packageFolder}/`;
+        const resourceDir = jhipsterConstants.SERVER_MAIN_RES_DIR;
+        const webappDir = jhipsterConstants.CLIENT_MAIN_SRC_DIR;
+
+        /* -------------------------------
+         * Persist config (regen safe)
+         * ----------------------------- */
+        this.jhipsterAppConfig.sentry = {
+            enabled: this.promptAnswers.enableSentry,
+            dsn: this.promptAnswers.sentryDsn
+        };
+
+        // Save config back to .yo-rc.json
+        const configPath = this.destinationPath('.yo-rc.json');
+        const fs = require('fs');
+        if (fs.existsSync(configPath)) {
+            const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+            if (!config['generator-jhipster']) {
+                config['generator-jhipster'] = {};
+            }
+            config['generator-jhipster'].sentry = this.jhipsterAppConfig.sentry;
+            fs.writeFileSync(configPath, JSON.stringify(config, null, 2) + '\n');
+        }
+
+        /* -------------------------------
+         * Logging
+         * ----------------------------- */
+        this.log('\n--- JHipster Config ---');
+        this.log(`baseName=${this.baseName}`);
+        this.log(`packageName=${this.packageName}`);
+        this.log(`clientFramework=${this.clientFramework}`);
+        this.log(`buildTool=${this.buildTool}`);
+
+        this.log('\n--- Directories ---');
+        this.log(`javaDir=${javaDir}`);
+        this.log(`resourceDir=${resourceDir}`);
+        this.log(`webappDir=${webappDir}`);
+
+        this.log('\n--- Sentry ---');
+        this.log(`enabled=${this.promptAnswers.enableSentry}`);
+        this.log('----------------------\n');
+
+        if (!this.promptAnswers.enableSentry) {
+            this.log(chalk.yellow('Sentry is disabled — skipping integration'));
+            return;
+        }
+
+        /* -------------------------------
+         * Backend (Spring Boot)
+         * ----------------------------- */
+        if (this.buildTool === 'maven') {
+            this.addMavenDependency(
+                'io.sentry',
+                'sentry-spring-boot-starter',
+                '7.3.0'
+            );
+        }
+
+        if (this.buildTool === 'gradle') {
+            this.addGradleDependency(
+                'implementation',
+                'io.sentry:sentry-spring-boot-starter:7.3.0'
+            );
+        }
+
+        this.template(
+            'server/sentry-application.yml.ejs',
+            `${resourceDir}config/sentry.yml`
+        );
+
+        /* -------------------------------
+         * Frontend
+         * ----------------------------- */
+        if (this.clientFramework === 'react') {
+            this.addNpmDependency('@sentry/react', '^7.3.0');
+
+            this.template(
+                'client/react/sentry.ts.ejs',
+                `${webappDir}app/sentry.ts`
+            );
+        }
+
+        if (this.clientFramework === 'angularX') {
+            this.addNpmDependency('@sentry/angular', '^7.3.0');
+
+            this.template(
+                'client/angular/sentry.ts.ejs',
+                `${webappDir}app/sentry.ts`
+            );
+        }
+
+        /* -------------------------------
+         * Register module hook
+         * ----------------------------- */
+        try {
+            this.registerModule(
+                'generator-jhipster-sentry-module',
+                'app',
+                'post',
+                'app',
+                'Adds Sentry integration'
+            );
+        } catch (err) {
+            this.log(
+                `${chalk.red.bold('WARN!')} Could not register JHipster hook`
+            );
+        }
+    }
+
+    install() {
+        const logMsg = `To install dependencies manually, run: ${chalk.yellow.bold(
+            `${this.clientPackageManager} install`
+        )}`;
+
+        if (this.options['skip-install']) {
+            this.log(logMsg);
+            return;
+        }
+
+        this.installDependencies({
+            npm: this.clientPackageManager === 'npm',
+            yarn: this.clientPackageManager === 'yarn',
+            bower: false
+        });
+    }
+
+    end() {
+        this.log(chalk.green('✔ Sentry module generation complete'));
+    }
+};

package/generators/app/templates/client/angular/sentry.ts.ejs

@@ -0,0 +1,6 @@
+import * as Sentry from '@sentry/angular';
+
+Sentry.init({
+  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
+  environment: 'dev',
+});

package/generators/app/templates/client/react/sentry.ts.ejs

@@ -0,0 +1,6 @@
+import * as Sentry from '@sentry/react';
+
+Sentry.init({
+  dsn: '<%= jhipsterAppConfig.sentry.dsn %>',
+  environment: 'dev',
+});

package/generators/app/templates/dummy.txt

@@ -0,0 +1,2 @@
+hello sentry-module!
+It's dummy.txt

package/generators/app/templates/server/sentry-application.yml.ejs

@@ -0,0 +1,4 @@
+sentry:
+  dsn: "<%= jhipsterAppConfig.sentry.dsn %>"
+  environment: dev
+  traces-sample-rate: 0.2

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "generator-jhipster-sentry-module",
+  "version": "1.0.0",
+  "description": "adding sentry to jhipster generator",
+  "keywords": [
+    "yeoman-generator",
+    "jhipster-module",
+    "jhipster",
+    "jhipster-6",
+    "jhipster-blueprint",
+    "sentry",
+    "error-tracking"
+  ],
+  "homepage": "https://github.com/Sara/generator-jhipster-sentry-module",
+  "author": {
+    "name": "Firstname Lastname",
+    "email": "",
+    "url": ""
+  },
+  "files": [
+    "generators"
+  ],
+  "main": "generators/app/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Sara/generator-jhipster-sentry-module.git"
+  },
+  "dependencies": {
+    "chalk": "3.0.0",
+    "generator-jhipster": ">=6.0.0",
+    "mkdirp": "0.5.1",
+    "semver": "7.1.1",
+    "shelljs": "0.8.3",
+    "yeoman-generator": "4.4.0"
+  },
+  "devDependencies": {
+    "eslint": "6.8.0",
+    "eslint-config-airbnb-base": "14.0.0",
+    "eslint-config-prettier": "6.9.0",
+    "eslint-plugin-import": "2.19.1",
+    "eslint-plugin-prettier": "3.1.2",
+    "fs-extra": "8.1.0",
+    "husky": "3.1.0",
+    "lint-staged": "9.5.0",
+    "mocha": "6.2.2",
+    "prettier": "1.19.1",
+    "yeoman-assert": "3.1.1",
+    "yeoman-test": "2.0.0"
+  },
+  "scripts": {
+    "prettier:format": "prettier --write \"{,**/}*.{js,json,md,yml}\"",
+    "pretest": "eslint .",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "release": "git push && git push --tags && npm publish",
+    "release:patch": "npm version patch -a -m \"Update to %s\" && npm run release",
+    "release:minor": "npm version minor -a -m \"Update to %s\" && npm run release",
+    "release:major": "npm version major -a -m \"Update to %s\" && npm run release",
+    "test": "mocha test"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,json,yml,md}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "bugs": {
+    "url": "https://github.com/Sara/generator-jhipster-sentry-module/issues"
+  }
+}