What are the validations present within Volo.Saas.Tenants.TenantManager.CreateAsync(String name, Nullable`1 editionId) ? #9581

2 Answer(s)

• 

  0

  AI-Bot created 2 months ago

  Support Team ABP Agent

  The Volo.Saas.Tenants.TenantManager.CreateAsync(string name, Nullable<Guid> editionId) method in ABP Commercial uses internal validation logic to ensure tenant names are valid and unique. The core of this validation is performed in the ValidateNameAsync method.

  Here are the key validations performed by ValidateNameAsync:

  1. Name Not Null or Empty: The tenant name must not be null, empty, or whitespace.
  2. Name Length: The tenant name must not exceed the maximum allowed length (typically 64 characters, but this can be checked in your entity definition).
  3. Name Uniqueness: The normalized tenant name must be unique. If another tenant already exists with the same normalized name (case-insensitive, trimmed, etc.), a BusinessException is thrown.
  4. Name Format: The name may be checked for allowed characters (e.g., no whitespace or special characters), depending on your implementation or any customizations.
  5. Custom Rules: If you have overridden the TenantManager or repository, you may have additional custom rules (e.g., removing whitespace, regex checks).

  If any of these validations fail, a Volo.Abp.BusinessException is thrown, which is what you are seeing in your stack trace.

  Example of a custom name validation (from community guidance):

  public override async Task<Tenant> FindByNameAsync(string name, bool includeDetails = true, CancellationToken cancellationToken = default)
  {
      var tenants = await (await GetDbSetAsync())
          .IncludeDetails(includeDetails)
          .OrderBy(t => t.Id).ToListAsync();
  
      return tenants
          .FirstOrDefault(t => (t.Name == name || TestUrlNamingConvention(t.Name, name)));
  }
  
  private bool TestUrlNamingConvention(string tenantName, string inputName)
  {
      var i = string.Concat(inputName.Where(c => !char.IsWhiteSpace(c))).ToLowerInvariant();
      var t = string.Concat(tenantName.Where(c => !char.IsWhiteSpace(c))).ToLowerInvariant();
      return i == t;              
  }
  

  This shows how you can extend or customize the validation logic.

  Summary:

  • The default validations are: not null/empty, length, uniqueness, and possibly allowed characters.
  • You can override or extend these by customizing the TenantManager or repository.

  Sources:

  • ABP SaaS Module Documentation
  • ABP Support: Tenant Name Matching Rules

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Save Cancel
• 

  0

  maliming created 2 months ago

  Support Team Fullstack Developer

  hi

  The latest code of ValidateAsync method

  public virtual async Task ValidateAsync(Tenant tenant)
  {
      Check.NotNullOrWhiteSpace(tenant.Name, nameof(tenant.Name));
      Check.NotNullOrWhiteSpace(tenant.NormalizedName, nameof(tenant.NormalizedName));
  
      var owner = await TenantRepository.FindByNameAsync(tenant.NormalizedName);
      if (owner != null && owner.Id != tenant.Id)
      {
          throw new BusinessException("Volo.Saas:DuplicateTenantName").WithData("Name",  tenant.NormalizedName);
      }
  }
  

  Save Cancel