Source: client/tenant.js

  1. /*
  2.  * Copyright 2023, TeamDev. All rights reserved.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Redistribution and use in source and/or binary forms, with or without
  11.  * modification, must retain the above copyright notice and the following
  12.  * disclaimer.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  27. import {TenantId} from "../proto/spine/core/tenant_id_pb";
  28. import {EmailAddress} from "../proto/spine/net/email_address_pb";
  29. import {InternetDomain} from "../proto/spine/net/internet_domain_pb";
  30. import {isProtobufMessage, Type} from "./typed-message";
  32. /**
  33.  * A factory of `TenantId` instances.
  34.  *
  35.  * Exposes methods that are "shortcuts" for the convenient creation of `TenantId` message
  36.  * instances.
  37.  */
  38. export class TenantIds {
  40.   /**
  41.    * Constructs a `TenantId` which represents an internet domain.
  42.    *
  43.    * @param {!string} domainName the domain name as a plain string
  44.    * @return {TenantId} a new `TenantId` instance
  45.    */
  46.   static internetDomain(domainName) {
  47.     if (!domainName) {
  48.       throw new Error('Expected a non-empty internet domain name.');
  49.     }
  50.     const domain = new InternetDomain();
  51.     domain.setValue(domainName);
  52.     const result = new TenantId();
  53.     result.setDomain(domain);
  54.     return result;
  55.   }
  57.   /**
  58.    * Constructs a `TenantId` which represents an email address.
  59.    *
  60.    * @param {!string} address the email address as a plain string
  61.    * @return {TenantId} a new `TenantId` instance
  62.    */
  63.   static emailAddress(address) {
  64.     if (!address) {
  65.       throw new Error('Expected a non-empty email address value.');
  66.     }
  67.     const emailAddress = new EmailAddress();
  68.     emailAddress.setValue(address);
  69.     const result = new TenantId();
  70.     result.setEmail(emailAddress);
  71.     return result;
  72.   }
  74.   /**
  75.    * Constructs a `TenantId` which is a plain string value.
  76.    *
  77.    * @param {!string} tenantIdValue the tenant ID
  78.    * @return {TenantId} a new `TenantId` instance
  79.    */
  80.   static plainString(tenantIdValue) {
  81.     if (!tenantIdValue) {
  82.       throw new Error('Expected a valid tenant ID value.');
  83.     }
  84.     const result = new TenantId();
  85.     result.setValue(tenantIdValue);
  86.     return result;
  87.   }
  88. }
  90. /**
  91.  * The current tenant provider.
  92.  *
  93.  * This object is passed to the `ActorRequestFactory` and is used during creation of all
  94.  * client-side requests.
  95.  *
  96.  * The current tenant ID can be switched dynamically with the help of the `update` method.
  97.  *
  98.  * If it is necessary to update the current ID to a "no tenant" value (to work in a single-tenant
  99.  * environment), pass the default tenant ID to the `update` method as follows:
  100.  * `tenantProvider.update(new TenantId())`.
  101.  */
  102. export class TenantProvider {
  104.   /**
  105.    * Creates a new `TenantProvider` configured with the passed tenant ID.
  106.    *
  107.    * The argument may be omitted but until the `_tenantId` is assigned some non-default value, the
  108.    * application is considered single-tenant.
  109.    *
  110.    * @param {?TenantId} tenantId the ID of the currently active tenant
  111.    */
  112.   constructor(tenantId) {
  113.     if (tenantId) {
  114.       TenantProvider._checkIsValidTenantId(tenantId);
  115.       this._tenantId = tenantId;
  116.     }
  117.   }
  119.   /**
  120.    * @param {!TenantId} tenantId the ID of the currently active tenant
  121.    */
  122.   update(tenantId) {
  123.     TenantProvider._checkIsValidTenantId(tenantId);
  124.     this._tenantId = tenantId;
  125.   }
  127.   /**
  128.    * Returns the currently active tenant ID.
  129.    *
  130.    * @return {TenantId}
  131.    */
  132.   tenantId() {
  133.     return this._tenantId;
  134.   }
  136.   /**
  137.    * Checks that the passed object represents a `TenantId` message.
  138.    *
  139.    * @param {!object} tenantId the object to check
  140.    * @private
  141.    */
  142.   static _checkIsValidTenantId(tenantId) {
  143.     if (!tenantId
  144.         || !isProtobufMessage(tenantId)
  145.         || Type.forMessage(tenantId).url().value() !== 'type.spine.io/spine.core.TenantId') {
  146.       throw new Error(`Expected a valid instance of the 'TenantId' message.`
  147.           + `The '${tenantId}' was passed instead.`);
  148.     }
  149.   }
  150. }