Merge pull request #1818 from matthieuRioual/AddLoggerToVueJS

Add Logger to Vue common application

src/main/java/tech/jhipster/lite/generator/client/vue/core/domain/VueDomainService.java

@@ -18,9 +18,13 @@ public class VueDomainService implements VueService {
   public static final String NEEDLE_IMPORT = "// jhipster-needle-main-ts-import";
   public static final String NEEDLE_PROVIDER = "// jhipster-needle-main-ts-provider";
   public static final String SOURCE_PRIMARY = getPath(SOURCE, "webapp/app/common/primary");
+  public static final String SOURCE_DOMAIN = getPath(SOURCE, "webapp/app/common/domain");
+  public static final String SOURCE_SECONDARY = getPath(SOURCE, "webapp/app/common/secondary");
   public static final String SOURCE_TEST_PRIMARY = getPath(SOURCE, "test/spec/common/primary");
   public static final String SOURCE_PRIMARY_APP = getPath(SOURCE_PRIMARY, "app");
   public static final String DESTINATION_PRIMARY = "src/main/webapp/app/common/primary";
+  public static final String DESTINATION_DOMAIN = "src/main/webapp/app/common/domain";
+  public static final String DESTINATION_SECONDARY = "src/main/webapp/app/common/secondary";
   public static final String DESTINATION_PRIMARY_APP = DESTINATION_PRIMARY + "/app";
   public static final String DESTINATION_PRIMARY_TEST = "src/test/javascript/spec/common/primary";
   public static final String DESTINATION_PRIMARY_ROUTER = DESTINATION_PRIMARY + "/app";
@@ -60,6 +64,7 @@ private void addCommonVue(Project project) {
     addRootFiles(project);
     addAppFiles(project);
     addRouter(project);
+    addLogger(project);
   }
 
   public void addDependencies(Project project) {
@@ -120,6 +125,38 @@ private void addAxiosFile(Project project) {
     );
   }
 
+  public void addLogger(Project project) {
+    addLoggerFiles(project);
+    addLoggerTestFiles(project);
+  }
+
+  private void addLoggerFiles(Project project) {
+    projectRepository.template(
+      ProjectFile.forProject(project).withSource(SOURCE_DOMAIN, "Logger.ts").withDestinationFolder(DESTINATION_DOMAIN)
+    );
+    projectRepository.template(
+      ProjectFile.forProject(project).withSource(SOURCE_DOMAIN, "Message.ts").withDestinationFolder(DESTINATION_DOMAIN)
+    );
+    projectRepository.template(
+      ProjectFile.forProject(project).withSource(SOURCE_SECONDARY, "ConsoleLogger.ts").withDestinationFolder(DESTINATION_SECONDARY)
+    );
+  }
+
+  private void addLoggerTestFiles(Project project) {
+    projectRepository.template(
+      ProjectFile
+        .forProject(project)
+        .withSource(getPath(SOURCE, "test/spec/common/domain"), "Logger.fixture.ts")
+        .withDestinationFolder("src/test/javascript/spec/common/domain")
+    );
+    projectRepository.template(
+      ProjectFile
+        .forProject(project)
+        .withSource(getPath(SOURCE, "test/spec/common/secondary"), "ConsoleLogger.spec.ts")
+        .withDestinationFolder("src/test/javascript/spec/common/secondary")
+    );
+  }
+
   public void addDevDependencies(Project project) {
     Vue.devDependencies().forEach(devDependency -> addDevDependency(project, devDependency));
   }

src/main/resources/generator/client/vue/test/spec/common/domain/Logger.fixture.ts.mustache

@@ -0,0 +1,10 @@
+import sinon, { SinonStub } from 'sinon';
+import { Logger } from '@/common/domain/Logger';
+
+export interface LoggerFixture extends Logger {
+  error: SinonStub;
+}
+
+export const stubLogger = (): LoggerFixture => ({
+  error: sinon.stub(),
+});

src/main/resources/generator/client/vue/test/spec/common/secondary/ConsoleLogger.spec.ts.mustache

@@ -0,0 +1,20 @@
+import sinon from 'sinon';
+
+import ConsoleLogger from '@/common/secondary/ConsoleLogger';
+
+describe('ConsoleLogger', () => {
+  it('should log an error', () => {
+    const logger = {
+      error: sinon.stub(),
+    };
+    const consoleLogger = new ConsoleLogger(logger as any);
+    const error = new Error('Error message');
+
+    consoleLogger.error('An error occurs', error);
+
+    const [message, errorPassed] = logger.error.getCall(0).args;
+    expect(message).toBe('An error occurs\n');
+    expect(errorPassed).toBeInstanceOf(Error);
+    expect(errorPassed.message).toBe('Error message');
+  });
+});

src/main/resources/generator/client/vue/webapp/app/common/domain/Logger.ts.mustache

@@ -0,0 +1,5 @@
+import { Message } from '@/common/domain/Message';
+
+export interface Logger {
+  error(message: Message, error: Error): void;
+}

src/main/resources/generator/client/vue/webapp/app/common/domain/Message.ts.mustache

@@ -0,0 +1 @@
+export type Message = string;

src/main/resources/generator/client/vue/webapp/app/common/secondary/ConsoleLogger.ts.mustache

@@ -0,0 +1,10 @@
+import { Logger } from '@/common/domain/Logger';
+import { Message } from '@/common/domain/Message';
+
+export default class ConsoleLogger implements Logger {
+  constructor(private logger: Console) {}
+
+  error(message: Message, error: Error) {
+    this.logger.error(`${message}\n`, error);
+  }
+}

src/test/java/tech/jhipster/lite/generator/client/vue/core/application/VueApplicationServiceIT.java

@@ -28,6 +28,8 @@ void shouldAddVue() {
     VueAssert.assertAppFiles(project);
     VueAssert.assertAppWithCss(project);
     VueAssert.assertLogos(project);
+    VueAssert.assertLogger(project);
+    VueAssert.assertAxiosFile(project);
 
     VueAssert.assertJestSonar(project);
   }

src/test/java/tech/jhipster/lite/generator/client/vue/core/application/VueAssert.java

@@ -86,4 +86,12 @@ public static void assertAxiosFile(Project project) {
     assertFileExist(project, "src/test/javascript/spec/http/AxiosHttpStub.ts");
     assertFileExist(project, "src/test/javascript/spec/http/AxiosStub.ts");
   }
+
+  public static void assertLogger(Project project) {
+    assertFileExist(project, "src/main/webapp/app/common/domain/Logger.ts");
+    assertFileExist(project, "src/main/webapp/app/common/domain/Message.ts");
+    assertFileExist(project, "src/main/webapp/app/common/secondary/ConsoleLogger.ts");
+    assertFileExist(project, "src/test/javascript/spec/common/domain/Logger.fixture.ts");
+    assertFileExist(project, "src/test/javascript/spec/common/secondary/ConsoleLogger.spec.ts");
+  }
 }

src/test/java/tech/jhipster/lite/generator/client/vue/core/domain/VueDomainServiceTest.java

@@ -210,4 +210,13 @@ void shouldAddAxiosFile() {
 
     verify(projectRepository, times(4)).template(any(ProjectFile.class));
   }
+
+  @Test
+  void shouldAddLoggerFiles() {
+    Project project = tmpProjectWithPackageJson();
+
+    vueDomainService.addLogger(project);
+
+    verify(projectRepository, times(5)).template(any(ProjectFile.class));
+  }
 }