Using license extension URL from the ServiceControl API (#2108)

* using license extension url from the backend api

* fix formatting

* moar linter fixes

* lint fixes

* workaround the shared state between the tests

* Update src/Frontend/test/preconditions/hasLicense.ts

Co-authored-by: WilliamBZA <[email protected]>

* Change license_extension_url to be nullable

Co-authored-by: John Simons <[email protected]>

---------

Co-authored-by: WilliamBZA <[email protected]>
Co-authored-by: John Simons <[email protected]>

Author: 3 people

src/Frontend/src/components/LicenseExpired.vue

@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { licenseStatus } from "../composables/serviceLicense";
+import { licenseStatus, license } from "../composables/serviceLicense";
 import routeLinks from "@/router/routeLinks";
 </script>
 
@@ -18,7 +18,7 @@ import routeLinks from "@/router/routeLinks";
       <h1>License expired</h1>
       <p>To continue using the Particular Service Platform, please extend your license</p>
       <div class="action-toolbar">
-        <a class="btn btn-default btn-primary" href="https://particular.net/extend-your-trial?p=servicepulse" target="_blank">Extend your license <i class="fa fa-external-link"></i></a>
+        <a class="btn btn-default btn-primary" :href="license.license_extension_url" target="_blank">Extend your license <i class="fa fa-external-link"></i></a>
         <RouterLink class="btn btn-default btn-secondary" :to="routeLinks.configuration.license.link">View license details</RouterLink>
       </div>
     </div>

src/Frontend/src/components/LicenseNotifications.vue

@@ -8,6 +8,7 @@ import routeLinks from "@/router/routeLinks";
 import { useRouter } from "vue-router";
 
 const router = useRouter();
+const { license, getOrUpdateLicenseStatus } = useLicense();
 
 function displayWarningMessage(licenseStatus: LicenseStatus) {
   const configurationRootLink = router.resolve(routeLinks.configuration.root).href;
@@ -18,7 +19,7 @@ function displayWarningMessage(licenseStatus: LicenseStatus) {
       break;
     }
     case "ValidWithExpiringTrial": {
-      const trialExpiring = `<div><strong>Non-production development license expiring</strong><div>Your non-production development license will expire soon. To continue using the Particular Service Platform you'll need to extend your license.</div><a href="http://particular.net/extend-your-trial?p=servicepulse" class="btn btn-warning"><i class="fa fa-external-link-alt"></i> Extend your license</a><a href="${configurationRootLink}" class="btn btn-light">View license details</a></div>`;
+      const trialExpiring = `<div><strong>Non-production development license expiring</strong><div>Your non-production development license will expire soon. To continue using the Particular Service Platform you'll need to extend your license.</div><a href="${license.license_extension_url}" class="btn btn-warning"><i class="fa fa-external-link-alt"></i> Extend your license</a><a href="${configurationRootLink}" class="btn btn-light">View license details</a></div>`;
       useShowToast(TYPE.WARNING, "", trialExpiring, true);
       break;
     }
@@ -40,8 +41,6 @@ function displayWarningMessage(licenseStatus: LicenseStatus) {
   }
 }
 
-const { license, getOrUpdateLicenseStatus } = useLicense();
-
 watch(
   () => license.license_status,
   (newValue, oldValue) => {

src/Frontend/src/components/configuration/PlatformLicense.vue

@@ -62,7 +62,7 @@ const loading = computed(() => {
                     </span>
                     <div class="license-expired-text" v-if="licenseStatus.isPlatformTrialExpired">Your license expired. To continue using the Particular Service Platform you'll need to extend your license.</div>
                     <div class="license-page-extend-trial" v-if="licenseStatus.isPlatformTrialExpiring && licenseStatus.isPlatformTrialExpired">
-                      <a class="btn btn-default btn-primary" href="https://particular.net/extend-your-trial?p=servicepulse" target="_blank">Extend your license&nbsp;&nbsp;<i class="fa fa-external-link"></i></a>
+                      <a class="btn btn-default btn-primary" :href="license.license_extension_url" target="_blank">Extend your license&nbsp;&nbsp;<i class="fa fa-external-link"></i></a>
                     </div>
                   </div>
                 </template>

src/Frontend/src/composables/serviceLicense.ts

@@ -23,6 +23,7 @@ const emptyLicense: License = {
   registered_to: "",
   status: "",
   license_status: LicenseStatus.Unavailable,
+  license_extension_url: "",
   licenseEdition: computed(() => {
     return license.license_type && license.edition ? ", " + license.edition : "";
   }),
@@ -54,6 +55,7 @@ const licenseStatus = reactive({
   subscriptionDaysLeft: "",
   trialDaysLeft: "",
   warningLevel: LicenseWarningLevel.None,
+  licenseExtensionUrl: "",
 });
 
 function useLicense() {
@@ -70,6 +72,7 @@ async function getOrUpdateLicenseStatus() {
   license.instance_name = lic.instance_name;
   license.registered_to = lic.registered_to;
   license.status = lic.status;
+  license.license_extension_url = lic.license_extension_url ?? "https://particular.net/extend-your-trial?p=servicepulse";
   license.upgrade_protection_expiration = lic.upgrade_protection_expiration;
 
   licenseStatus.isSubscriptionLicense = isSubscriptionLicense(license);
@@ -86,6 +89,7 @@ async function getOrUpdateLicenseStatus() {
   licenseStatus.trialDaysLeft = getTrialDaysLeft(license);
   licenseStatus.warningLevel = getLicenseWarningLevel(license.license_status);
   licenseStatus.isExpired = licenseStatus.isPlatformExpired || licenseStatus.isPlatformTrialExpired || licenseStatus.isInvalidDueToUpgradeProtectionExpired;
+  licenseStatus.licenseExtensionUrl = license.license_extension_url;
 }
 
 export { useLicense, license, licenseStatus };
@@ -141,7 +145,7 @@ function getUpgradeDaysLeft(license: UnwrapNestedRefs<License>) {
 
 async function getLicense() {
   try {
-    const [, data] = await useTypedFetchFromServiceControl<LicenseInfo>("license?refresh=true");
+    const [, data] = await useTypedFetchFromServiceControl<LicenseInfo>("license?refresh=true&clientName=servicepulse");
     return data;
   } catch (err) {
     console.log(err);

src/Frontend/src/resources/LicenseInfo.ts

@@ -7,6 +7,7 @@ export default interface LicenseInfo {
   instance_name: string;
   trial_license: boolean;
   license_status: LicenseStatus;
+  license_extension_url?: string;
   status: string;
 }
 

src/Frontend/test/preconditions/hasLicense.ts

@@ -1,6 +1,9 @@
 import { activeLicenseResponse } from "../mocks/license-response-template";
 import { SetupFactoryOptions } from "../driver";
 import LicenseInfo, { LicenseStatus } from "@/resources/LicenseInfo";
+import { useLicense } from "@/composables/serviceLicense";
+
+const { license } = useLicense();
 
 export const hasActiveLicense = ({ driver }: SetupFactoryOptions) => {
   const serviceControlInstanceUrl = window.defaultConfig.service_control_url;
@@ -16,11 +19,11 @@ export enum LicenseType {
   UpgradeProtection,
 }
 
-export const hasExpiredLicense = (licenseType: LicenseType) => createLicenseMockedResponse(licenseType, false);
-export const hasExpiringLicense = (licenseType: LicenseType) => createLicenseMockedResponse(licenseType, true);
+export const hasExpiredLicense = (licenseType: LicenseType, licenseExtensionUrl: string = "https://particular.net/extend-your-trial?p=servicepulse") => createLicenseMockedResponse(licenseType, false, licenseExtensionUrl);
+export const hasExpiringLicense = (licenseType: LicenseType, licenseExtensionUrl: string = "https://particular.net/extend-your-trial?p=servicepulse") => createLicenseMockedResponse(licenseType, true, licenseExtensionUrl);
 
 const createLicenseMockedResponse =
-  (liceseType: LicenseType, expiring = false) =>
+  (liceseType: LicenseType, expiring = false, licenseExtensionUrl: string) =>
   ({ driver }: SetupFactoryOptions) => {
     const serviceControlInstanceUrl = window.defaultConfig.service_control_url;
     let status: LicenseStatus;
@@ -37,6 +40,9 @@ const createLicenseMockedResponse =
         break;
     }
 
+    //We need to reset the global state to ensure the warning toast is always triggered by the value changing between multiple test runs. See documented issue and proposed solution https://github.com/Particular/ServicePulse/issues/1905
+    license.license_status = LicenseStatus.Unavailable;
+
     driver.mockEndpoint(`${serviceControlInstanceUrl}license`, {
       body: <LicenseInfo>{
         registered_to: "ACME Software",
@@ -47,6 +53,7 @@ const createLicenseMockedResponse =
         instance_name: "Particular.ServiceControl",
         trial_license: status === LicenseStatus.ValidWithExpiringTrial || status === LicenseStatus.InvalidDueToExpiredTrial,
         license_status: status,
+        license_extension_url: licenseExtensionUrl,
       },
     });
   };

src/Frontend/test/specs/licensing/license-enforcement.spec.ts

@@ -8,18 +8,20 @@ import { getAlertNotifications } from "./questions/alertNotifications";
 
 describe("FEATURE: EXPIRING license detection", () => {
   describe("RULE: The user should be alerted while using the monitoring endpoint list functionality about an EXPIRING license", () => {
-    test("EXAMPLE: Expiring trial", async ({ driver }) => {
-      //Arrange
-      await driver.setUp(precondition.serviceControlWithMonitoring);
-      await driver.setUp(precondition.hasExpiringLicense(precondition.LicenseType.Trial));
+    [{ licenseExtensionUrl: "https://particular.net/extend-your-trial?p=servicepulse" }, { licenseExtensionUrl: "http://custom-url?with-parts=value1" }].forEach(({ licenseExtensionUrl }) => {
+      test(`EXAMPLE: Expiring trial with ${licenseExtensionUrl} as license extension url `, async ({ driver }) => {
+        //Arrange
+        await driver.setUp(precondition.serviceControlWithMonitoring);
+        await driver.setUp(precondition.hasExpiringLicense(precondition.LicenseType.Trial, licenseExtensionUrl));
 
-      await driver.goTo("monitoring");
+        await driver.goTo("monitoring");
 
-      const notification = (await getAlertNotifications()).find((n) => n.textMatches(/your non-production development license will expire soon\. to continue using the particular service platform you'll need to extend your license\./i));
+        const notification = (await getAlertNotifications()).find((n) => n.textMatches(/your non-production development license will expire soon\. to continue using the particular service platform you'll need to extend your license\./i));
 
-      expect(notification).not.toBeUndefined();
-      expect(notification?.hasLink({ caption: "Extend your license", address: "http://particular.net/extend-your-trial?p=servicepulse" })).toBeTruthy();
-      expect(notification?.hasLink({ caption: "View license details", address: "#/configuration" })).toBeTruthy();
+        expect(notification).not.toBeUndefined();
+        expect(notification?.hasLink({ caption: "Extend your license", address: licenseExtensionUrl })).toBeTruthy();
+        expect(notification?.hasLink({ caption: "View license details", address: "#/configuration" })).toBeTruthy();
+      });
     });
 
     [