@mshima/generator-jhipster-nodejs 0.0.0-stage → 0.0.1

package/generators/node-server/templates/server/src/config/application-prod.yml.ejs

@@ -0,0 +1,97 @@
+# ===================================================================
+# Configuration for the "prod" profile.
+#
+# This configuration overrides the application.yml file.
+#
+# More information on profiles: https://www.jhipster.tech/profiles/
+# More information on configuration properties: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# ===================================================================
+# Standard app properties.
+# ===================================================================
+
+<%_ if (serviceDiscoveryEureka) { _%>
+eureka:
+  instance:
+    prefer-ip-address: true
+  client:
+    service-url:
+      defaultZone: http://admin:${jhipster.registry.password}@localhost:8761/eureka/
+
+<%_ } _%>
+<%_ if (serviceDiscoveryConsul) { _%>
+cloud:
+  consul:
+    discovery:
+      prefer-ip-address: true
+
+<%_ } _%>
+# ===================================================================
+# To enable TLS in production, activate the "tls" profile (BACKEND_ENV=prod,tls) with your own PKCS#12 keystore, see
+# application-tls.yml. You can also use Let's Encrypt:
+# https://maximilian-boehm.com/hp2121/Create-a-Java-Keystore-JKS-from-Let-s-Encrypt-Certificates.htm
+# ===================================================================
+# The level of the loggers, like Spring Boot: ROOT for the loggers without a level of their own, a logger by the
+# context of its Nest logger (like AuthService: DEBUG). The logs page of the client changes them while it runs.
+logging:
+  level:
+    ROOT: INFO
+
+server:
+  port: <%= serverPort %>
+
+# ===================================================================
+# JHipster specific properties
+#
+# Full reference is available at: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# The database, read by orm.config.ts (TypeORM options): environment variables override each property, like
+# DATABASE_HOST or DATABASE_PASSWORD.
+database:
+  type: <%= nodeProdDatabaseType %>
+  # The database of the host, like the datasource of JHipster Spring Boot: <%- dockerServicesDir %>app.yml sets the host of its service.
+  host: localhost
+  port: <%= nodeDatabasePort %>
+<%_ if (databaseTypeSql) { _%>
+  # Samples of the username and the password are in the secret-samples profile: set them in production, with the
+  # DATABASE_USERNAME and DATABASE_PASSWORD environment variables for example.
+  username: ''
+  password: ''
+  name: <%- prodDatabaseName %>
+<%_ } else { _%>
+  # Set the username and the password of a MongoDB with authentication, with the DATABASE_USERNAME and
+  # DATABASE_PASSWORD environment variables for example.
+  username: ''
+  password: ''
+  name: <%= baseName %>
+<%_ } _%>
+  logging: false
+
+<%_ if (generateUserManagement) { _%>
+# The SMTP server of the account mails (activation, creation, password reset), read by the mail module
+# (@nestjs-modules/mailer), like spring.mail of JHipster Spring Boot: environment variables override each property, like MAIL_HOST
+# or MAIL_PASSWORD.
+mail:
+  host: localhost
+  port: 25
+  username:
+  password:
+
+<%_ } _%>
+jhipster:
+  mail: # specific JHipster mail property, for standard properties see MailProperties
+    from: <%= baseName %>@localhost
+    base-url: http://my-server-url-to-change # Modify according to your server's URL
+
+# ===================================================================
+# Application specific properties
+# Add your own application properties here, see the ApplicationProperties class
+# to have type-safe configuration, like in the JHipsterProperties above
+#
+# More documentation is available at:
+# https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# application:

package/generators/node-server/templates/server/src/config/application-secret-samples.yml.ejs

@@ -0,0 +1,42 @@
+# ===================================================================
+# Configuration for the "secret-samples" profile.
+#
+# This configuration overrides the application.yml file.
+#
+# More information on profiles: https://www.jhipster.tech/profiles/
+# More information on configuration properties: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# ===================================================================
+# Samples for required secrets to be used in development and ci using prod profile.
+# ===================================================================
+
+<%_ if (databaseTypeSql) { _%>
+database:
+  username: <%- prodDatabaseUsername %>
+  password: '<%- prodDatabasePassword %>'
+
+<%_ } _%>
+jhipster:
+  security:
+<%_ if (authenticationType === 'jwt') { _%>
+    authentication:
+      jwt:
+        # This token must be encoded using Base64 and be at least 512 bits long, like the HS512 key of JHipster Spring Boot (you can type `openssl rand -base64 64` on your command line to generate one)
+        base64-secret: <%= jwtSecretKey %>
+<%_ } else if (authenticationTypeSession) { _%>
+    session:
+      secret: '<%= baseName %> session secret'
+<%_ } else if (authenticationType === 'oauth2') { _%>
+    session:
+      secret: '<%= baseName %> session secret'
+    oauth2:
+      client:
+        provider:
+          oidc:
+            issuer-uri: http://localhost:9080/realms/jhipster
+        registration:
+          oidc:
+            client-id: web_app
+            client-secret: web_app
+<%_ } _%>

package/generators/node-server/templates/server/src/config/application-test.yml.ejs

@@ -0,0 +1,68 @@
+# ===================================================================
+# Configuration for the "test" profile.
+#
+# This configuration overrides the application.yml file.
+#
+# More information on profiles: https://www.jhipster.tech/profiles/
+# More information on configuration properties: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# ===================================================================
+# Standard app properties.
+# ===================================================================
+
+<%_ if (serviceDiscoveryEureka) { _%>
+eureka:
+  instance:
+    prefer-ip-address: true
+  client:
+    service-url:
+      defaultZone: http://admin:${jhipster.registry.password}@localhost:8761/eureka/
+
+<%_ } _%>
+# The level of the loggers, like Spring Boot: ROOT for the loggers without a level of their own, a logger by the
+# context of its Nest logger (like AuthService: DEBUG). The logs page of the client changes them while it runs.
+logging:
+  level:
+    ROOT: WARN
+
+server:
+  port: <%= serverPort %>
+
+# ===================================================================
+# JHipster specific properties
+#
+# Full reference is available at: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# The database, read by orm.config.ts (TypeORM options): environment variables override each property, like
+# DATABASE_HOST or DATABASE_PASSWORD.
+database:
+<%_ if (databaseTypeSql) { _%>
+  type: better-sqlite3
+  name: ':memory:'
+  # The schema of the migrations, like the Liquibase changelogs of the tests of JHipster Spring Boot.
+  synchronize: false
+<%_ } else { _%>
+  type: mongodb
+  # An in-memory MongoDB server (mongodb-memory-server), started for each run.
+  embedded: true
+  synchronize: true
+<%_ } _%>
+  logging: true
+
+jhipster:
+  mail: # specific JHipster mail property, for standard properties see MailProperties
+    from: <%= baseName %>@localhost
+    base-url: http://127.0.0.1:<%= serverPort %>
+
+# ===================================================================
+# Application specific properties
+# Add your own application properties here, see the ApplicationProperties class
+# to have type-safe configuration, like in the JHipsterProperties above
+#
+# More documentation is available at:
+# https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# application:

package/generators/node-server/templates/server/src/config/application-tls-samples.yml.ejs

@@ -0,0 +1,15 @@
+# ===================================================================
+# Configuration for the "tls-samples" profile, used with the "tls" profile.
+#
+# The keystore is a self-signed sample generated by JHipster for development and tests: its password is public, so it
+# gives a working https endpoint, not secrecy. Do not use it in production.
+#
+# As your browser will not trust its certificate, you will need to import it, or, with Chrome, enable the
+# "allow-insecure-localhost" flag at chrome://flags/#allow-insecure-localhost
+# ===================================================================
+server:
+  ssl:
+    key-store: classpath:config/tls/keystore-samples.p12
+    key-store-password: password
+    key-store-type: PKCS12
+    key-alias: selfsigned

package/generators/node-server/templates/server/src/config/application-tls.yml.ejs

@@ -0,0 +1,15 @@
+# ===================================================================
+# Activate this profile to enable TLS (HTTPS).
+#
+# Provide your own PKCS#12 keystore, for example through the environment:
+#   SERVER_SSL_KEY_STORE, SERVER_SSL_KEY_STORE_PASSWORD
+# In development, add the "tls-samples" profile instead: it uses the self-signed sample keystore generated by JHipster,
+# whose password is public.
+# ===================================================================
+server:
+  ssl:
+    enabled: true
+    # A path relative to the working directory, or classpath:config/... for a file of the config folder.
+    # key-store: /path/to/keystore.p12
+    # key-store-password:
+    key-store-type: PKCS12

package/generators/node-server/templates/server/src/config/application.yml.ejs

@@ -0,0 +1,149 @@
+# ===================================================================
+# Configuration.
+#
+# This configuration will be overridden by the profiles you activate with BACKEND_ENV (a comma separated list),
+# for example application-dev.yml if you use the "dev" profile.
+#
+# More information on profiles: https://www.jhipster.tech/profiles/
+# More information on configuration properties: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# ===================================================================
+# Standard app properties.
+# ===================================================================
+
+profiles:
+  # The profiles each profile activates, like spring.profiles.group of Spring Boot.
+  group:
+    dev:
+      - secret-samples
+      - api-docs
+      # Uncomment to activate TLS for the dev profile
+      #- tls
+      #- tls-samples
+    test:
+      - secret-samples
+
+<%_ if (serviceDiscoveryEureka) { _%>
+eureka:
+  client:
+    enabled: false
+    fetch-registry: true
+    register-with-eureka: true
+    instance-info-replication-interval-seconds: 10
+    registry-fetch-interval-seconds: 10
+  instance:
+    appname: <%= baseName %>
+    instanceId: <%= baseName %>:${random.value}
+    lease-renewal-interval-in-seconds: 5
+    lease-expiration-duration-in-seconds: 10
+<%_ } _%>
+<%_ if (serviceDiscoveryConsul) { _%>
+# The registration in Consul, like the spring.cloud.consul properties of JHipster Spring Boot: enabled with
+# CLOUD_CONSUL_ENABLED=true, at CLOUD_CONSUL_HOST and CLOUD_CONSUL_PORT.
+cloud:
+  consul:
+    enabled: false
+    host: localhost
+    port: 8500
+    discovery:
+      service-name: <%= baseName.toLowerCase() %>
+      instance-id: <%= baseName.toLowerCase() %>:${random.value}
+      health-check-path: /management/health
+      health-check-interval: 10s
+      health-check-timeout: 5s
+      prefer-ip-address: false
+<%_ } _%>
+
+# The management endpoints, like Spring Boot Actuator: the values of the env and configprops endpoints (the
+# configuration page of the client) are shown as ****** unless show-values is always.
+management:
+  endpoint:
+    env:
+      show-values: never
+    configprops:
+      show-values: never
+
+# ===================================================================
+# JHipster specific properties
+#
+# Full reference is available at: https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+jhipster:
+  clientApp:
+    name: '<%= frontendAppName %>'
+  # By default, CORS is disabled. Uncomment to enable.
+  # cors:
+  #   allowed-origins: "http://localhost:8100,http://localhost:9000"
+  #   allowed-methods: "*"
+  #   allowed-headers: "*"
+  #   exposed-headers: "Authorization,Link,X-Total-Count,X-${jhipster.clientApp.name}-alert,X-${jhipster.clientApp.name}-error,X-${jhipster.clientApp.name}-params"
+  #   allow-credentials: true
+  #   max-age: 1800
+<%_ if (serviceDiscoveryEureka) { _%>
+  registry:
+    password: admin
+<%_ } _%>
+  security:
+<%_ if (!skipClient) { _%>
+    # The Content-Security-Policy header of the responses, like JHipster Spring Boot.
+    content-security-policy: "default-src 'self'; frame-src 'self' data:; script-src 'self' 'unsafe-inline' 'unsafe-eval'<%- locals.microfrontend && locals.clientFrameworkAngular ? ' blob:' : '' %> https://storage.googleapis.com; style-src 'self'<%- locals.clientThemeAny ? ' https://fonts.googleapis.com' : '' %> 'unsafe-inline'; img-src 'self' data:; font-src 'self'<%- locals.clientThemeAny ? ' https://fonts.gstatic.com' : '' %> data:"
+<%_ } _%>
+<%_ if (authenticationType === 'jwt') { _%>
+    authentication:
+      jwt:
+        # The secret of the tokens (base64-secret), a sample of the secret-samples profile: set it in production, with
+        # the JHIPSTER_SECURITY_AUTHENTICATION_JWT_BASE64SECRET environment variable for example.
+        # Token is valid 24 hours
+        token-validity-in-seconds: 86400
+        token-validity-in-seconds-for-remember-me: 2592000
+<%_ } else if (authenticationType === 'oauth2') { _%>
+    # The session secret and the OAuth2 client, samples of the secret-samples profile: set them in production, with
+    # environment variables like JHIPSTER_SECURITY_OAUTH2_CLIENT_REGISTRATION_OIDC_CLIENTSECRET.
+    oauth2:
+      # The audiences of the access tokens the API accepts as bearer tokens, comma separated, like JHipster Spring Boot:
+      # account for Keycloak, api://default for Okta.
+      audience: account,api://default
+<%_ } _%>
+  mail:
+    from: <%= baseName %>@localhost
+  swagger:
+    default-include-pattern: /api/.*
+    title: <%= baseName %> API
+    description: <%= baseName %> API documentation
+    version: 0.0.1
+    terms-of-service-url:
+    contact-name:
+    contact-url:
+    contact-email:
+    license:
+    license-url:
+
+
+# Properties to be exposed on the /management/info endpoint
+info:
+  # Comma separated list of profiles that will trigger the ribbon to show
+  display-ribbon-on-profiles: 'dev'
+
+<%_ if (serviceDiscoveryEureka) { _%>
+cloud:
+  config:
+    uri: http://admin:${jhipster.registry.password}@localhost:8761/config
+  # name of the config server's property source (file.yml) that we want to use
+    name: <%= baseName %>
+    profile: prod # profile(s) of the property source
+    label: master # toggle to switch to a different version of the configuration as stored in git
+    # it can be set to any label, branch or commit of the configuration source Git repository
+<%_ } _%>
+
+# ===================================================================
+# Application specific properties
+# Add your own application properties here, see the ApplicationProperties class
+# to have type-safe configuration, like in the JHipsterProperties above
+#
+# More documentation is available at:
+# https://www.jhipster.tech/common-application-properties/
+# ===================================================================
+
+# application:

package/generators/node-server/templates/server/src/config.spec.ts.ejs

@@ -0,0 +1,81 @@
+import { afterEach, describe, expect, it } from 'vitest';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { Test } from '@nestjs/testing';
+import { validateConfiguration } from './application-config.ts';
+import { Config, config, configuration } from './config.ts';
+
+describe('Config', () => {
+  const variables = [
+    'JHIPSTER_MAIL_BASEURL',
+    'JHIPSTER_MAIL_BASE_URL',
+    'SAMPLE_INTERVALSECONDS',
+    'SAMPLE_ENABLED',
+  ];
+
+  afterEach(() => {
+    for (const variable of variables) {
+      delete process.env[variable];
+    }
+  });
+
+  it('should keep the properties without environment variable', () => {
+    const config = new Config({ jhipster: { mail: { 'base-url': 'from-yaml' } } });
+    expect(config.get('jhipster.mail.base-url')).toBe('from-yaml');
+  });
+
+  it('should override a property with its canonical environment variable', () => {
+    process.env.JHIPSTER_MAIL_BASEURL = 'from-env';
+    const config = new Config({ jhipster: { mail: { 'base-url': 'from-yaml' } } });
+    expect(config.get('jhipster.mail.base-url')).toBe('from-env');
+  });
+
+  it('should override a property with the dashes as underscores', () => {
+    process.env.JHIPSTER_MAIL_BASE_URL = 'from-env';
+    const config = new Config({ jhipster: { mail: { 'base-url': 'from-yaml' } } });
+    expect(config.get('jhipster.mail.base-url')).toBe('from-env');
+  });
+
+  it('should keep the type of numbers and booleans', () => {
+    process.env.SAMPLE_INTERVALSECONDS = '60';
+    process.env.SAMPLE_ENABLED = 'false';
+    const config = new Config({ sample: { 'interval-seconds': 10, enabled: true } });
+    expect(config.get('sample.interval-seconds')).toBe(60);
+    expect(config.get('sample.enabled')).toBe(false);
+  });
+});
+
+describe('ConfigService', () => {
+  const createConfigService = async (): Promise<ConfigService> => {
+    const module = await Test.createTestingModule({
+      imports: [ConfigModule.forRoot({ ignoreEnvFile: true, load: [configuration] })],
+    }).compile();
+    return module.get(ConfigService);
+  };
+
+  it('should read the properties of config by their dotted names', async () => {
+    const configService = await createConfigService();
+    expect(configService.get('jhipster.clientApp.name')).toBe(config.get('jhipster.clientApp.name'));
+    expect(configService.get('server.port')).toBe(config.get('server.port'));
+  });
+
+  it('should read the properties added before the application is created, like the cloud config', async () => {
+    config.addAll({ sample: { 'added-later': 'from the cloud config' } });
+    const configService = await createConfigService();
+    expect(configService.get('sample.added-later')).toBe('from the cloud config');
+  });
+});
+
+describe('validateConfiguration', () => {
+  it('should accept the configuration of the application', () => {
+    expect(() => configuration()).not.toThrow();
+  });
+
+  it('should refuse an invalid property, telling the property and what it expects', () => {
+    const invalid = configuration() as any;
+    invalid.server.port = 'not a port';
+    invalid.jhipster.cors['max-age'] = -1;
+    expect(() => validateConfiguration(invalid)).toThrow(
+      /server\.port is "not a port", expected a port\n.*jhipster\.cors\.max-age is -1, expected a number of seconds/,
+    );
+  });
+});