feat: demo project for self hosted (#2410)

[issue 2394](#2394)

backend/app/src/main/kotlin/io/tolgee/commandLineRunners/InitialUserCreatorCommandLineRunner.kt

@@ -5,6 +5,7 @@ import io.tolgee.configuration.tolgee.TolgeeProperties
 import io.tolgee.dtos.request.organization.OrganizationDto
 import io.tolgee.model.UserAccount
 import io.tolgee.security.InitialPasswordManager
+import io.tolgee.service.QuickStartService
 import io.tolgee.service.organization.OrganizationService
 import io.tolgee.service.security.UserAccountService
 import org.slf4j.LoggerFactory
@@ -25,6 +26,7 @@ class InitialUserCreatorCommandLineRunner(
  private val organizationService: OrganizationService,
  private val passwordEncoder: PasswordEncoder,
  private val internalProperties: InternalProperties,
+ private val quickStartService: QuickStartService,
 ) : CommandLineRunner, ApplicationListener<ContextClosedEvent> {
  private val logger = LoggerFactory.getLogger(this::class.java)
 
@@ -71,12 +73,17 @@ class InitialUserCreatorCommandLineRunner(
 
  // If the user was already existing, it may already have assigned orgs.
  // To avoid conflicts, we only create the org if the user doesn't have any.
- organizationService.create(
- OrganizationDto(
- properties.authentication.initialUsername,
- ),
- userAccount = user,
- )
+ val organization =
+ organizationService.create(
+ OrganizationDto(
+ properties.authentication.initialUsername,
+ ),
+ userAccount = user,
+ )
+
+ if (properties.authentication.createDemoForInitialUser) {
+ quickStartService.create(user, organization)
+ }
  }
 
  fun updatePasswordIfNecessary(initialUser: UserAccount) {

backend/app/src/main/resources/application-e2e.yaml

@@ -23,6 +23,7 @@ tolgee:
  authorization-url: "https://dummy-url.com/authorize"
  token-url: "https://dummy-url.com/oauth/token"
  user-url: "https://dummy-url.com/userinfo"
+ create-demo-for-initial-user: false
  rate-limits: # tests go brrrr but then get 429'd and no longer go brrrr
  global-limits: false
  endpoint-limits: false

backend/app/src/test/kotlin/io/tolgee/initialUserCreation/CreateEnabledTest.kt

@@ -9,8 +9,11 @@ import io.tolgee.CleanDbBeforeClass
 import io.tolgee.commandLineRunners.InitialUserCreatorCommandLineRunner
 import io.tolgee.component.fileStorage.FileStorage
 import io.tolgee.configuration.tolgee.TolgeeProperties
+import io.tolgee.model.enums.OrganizationRoleType
+import io.tolgee.repository.QuickStartRepository
 import io.tolgee.repository.UserAccountRepository
 import io.tolgee.security.InitialPasswordManager
+import io.tolgee.service.project.ProjectService
 import io.tolgee.service.security.UserAccountService
 import io.tolgee.testing.AbstractTransactionalTest
 import io.tolgee.testing.ContextRecreatingTest
@@ -58,11 +61,27 @@ class CreateEnabledTest : AbstractTransactionalTest() {
  @Autowired
  lateinit var initialUserCreatorCommandLineRunner: InitialUserCreatorCommandLineRunner
 
+ @Autowired
+ lateinit var projectService: ProjectService
+
+ @Autowired
+ lateinit var quickStartRepository: QuickStartRepository
+
  @BeforeAll
  fun callTheRunner() {
  initialUserCreatorCommandLineRunner.run()
  }
 
+ @Test
+ fun `creates demo project for initial user`() {
+ val johny = userAccountService.findActive("johny")
+ assertThat(johny!!.organizationRoles).hasSize(1)
+ assertThat(johny.organizationRoles[0].type).isEqualTo(OrganizationRoleType.OWNER)
+ val organization = johny.organizationRoles[0].organization!!
+ val projects = projectService.findAllInOrganization(organizationId = organization.id)
+ assertThat(projects[0].name).isEqualTo("Demo project")
+ }
+
  @Test
  fun storesPassword() {
  assertThat(getPasswordFileContents().toString(Charsets.UTF_8)).isNotBlank
@@ -109,7 +128,7 @@ class CreateEnabledTest : AbstractTransactionalTest() {
  fun cleanUp() {
  (fileStorage as InMemoryFileStorage).clear()
  resetInitialPassword()
-
+ quickStartRepository.deleteAll()
  val initial = userAccountService.findActive("johny")!!
  userAccountRepository.delete(initial)
  }

backend/data/src/main/kotlin/io/tolgee/configuration/tolgee/AuthenticationProperties.kt

@@ -120,6 +120,11 @@ class AuthenticationProperties(
  "a set period of time to prevent unauthorized access to images.",
  )
  var securedImageRetrieval: Boolean = false,
+ @DocProperty(
+ description =
+ "When enabled, creates Demo project and quick start guide for inital user\n",
+ )
+ var createDemoForInitialUser: Boolean = true,
  @DocProperty(
  description = "Expiration time of a generated image access token in milliseconds.",
  defaultExplanation = "= 10 minutes",

e2e/cypress/e2e/translations/base.cy.ts

@@ -66,6 +66,8 @@ describe('Translations Base', () => {
  key: 'Test key 2',
  translation: 'Translated test key 2',
  });
+ cy.contains('Key created').should('be.visible');
+ cy.wait(100);
  cy.xpath(getAnyContainingText('Key', 'a'))
  .xpath(getClosestContainingText('Test key 2'))
  .scrollIntoView()