Merge pull request #41 from platform-mesh/organization-local-setup-check

feat: add local-setup message for new ogranization

Author: Sobyt483

projects/lib/utils/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './columns-to-gql-fields';
 export * from './get-value-by-path';
 export * from './group-name-sanitizer';
+export * from './is-local-setup';
 export * from './resource-field-by-path';

projects/lib/utils/utils/is-local-setup.spec.ts

@@ -0,0 +1,87 @@
+import { isLocalSetup } from './is-local-setup';
+
+describe('isLocalSetup', () => {
+  let originalLocation: Location;
+
+  beforeEach(() => {
+    originalLocation = window.location;
+
+    delete (window as any).location;
+    (window as any).location = {
+      ...originalLocation,
+      hostname: '',
+    };
+  });
+
+  afterEach(() => {
+    (window as any).location = originalLocation;
+  });
+
+  it('should return true for localhost', () => {
+    window.location.hostname = 'localhost';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return true for localhost with port', () => {
+    window.location.hostname = 'localhost:4200';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return false for 127.0.0.1 (localhost IP)', () => {
+    window.location.hostname = '127.0.0.1';
+    expect(isLocalSetup()).toBe(false);
+  });
+
+  it('should return true for portal.dev.local', () => {
+    window.location.hostname = 'portal.dev.local';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return true for subdomain with portal.dev.local', () => {
+    window.location.hostname = 'app.portal.dev.local';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return true for portal.dev.local with port', () => {
+    window.location.hostname = 'portal.dev.local:3000';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return false for production domain', () => {
+    window.location.hostname = 'portal.example.com';
+    expect(isLocalSetup()).toBe(false);
+  });
+
+  it('should return false for staging domain', () => {
+    window.location.hostname = 'staging.portal.example.com';
+    expect(isLocalSetup()).toBe(false);
+  });
+
+  it('should return false for IP address that is not localhost', () => {
+    window.location.hostname = '192.168.1.100';
+    expect(isLocalSetup()).toBe(false);
+  });
+
+  it('should return false for empty hostname', () => {
+    window.location.hostname = '';
+    expect(isLocalSetup()).toBe(false);
+  });
+
+  it('should return true for domain containing localhost', () => {
+    window.location.hostname = 'mylocalhost.com';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should return true for domain containing portal.dev.local', () => {
+    window.location.hostname = 'myportal.dev.local.com';
+    expect(isLocalSetup()).toBe(true);
+  });
+
+  it('should handle case sensitivity correctly', () => {
+    window.location.hostname = 'LOCALHOST';
+    expect(isLocalSetup()).toBe(false);
+
+    window.location.hostname = 'PORTAL.DEV.LOCAL';
+    expect(isLocalSetup()).toBe(false);
+  });
+});

projects/lib/utils/utils/is-local-setup.ts

@@ -0,0 +1,3 @@
+export const isLocalSetup = () => {
+  return window.location.hostname.includes('localhost') || window.location.hostname.includes('portal.dev.local');
+};

projects/wc/src/app/components/organization-management/organization-management.component.spec.ts

@@ -115,7 +115,7 @@ describe('OrganizationManagementComponent', () => {
     component.ngOnInit();
 
     expect(resourceServiceMock.readOrganizations).toHaveBeenCalled();
-    expect(component.organizations()).toEqual(['org2']);
+    expect(component.organizations()).toEqual(['org1', 'org2']);
   });
 
   it('should set organization to switch', () => {

projects/wc/src/app/components/organization-management/organization-management.component.ts

@@ -21,7 +21,10 @@ import {
   ResourceNodeContext,
   ResourceService,
 } from '@platform-mesh/portal-ui-lib/services';
-import { generateGraphQLFields } from '@platform-mesh/portal-ui-lib/utils';
+import {
+  generateGraphQLFields,
+  isLocalSetup,
+} from '@platform-mesh/portal-ui-lib/utils';
 import {
   ButtonComponent,
   InputComponent,
@@ -89,9 +92,7 @@ export class OrganizationManagementComponent implements OnInit {
       .subscribe({
         next: (result) => {
           this.organizations.set(
-            result['Accounts']
-              .map((o) => o.metadata.name)
-              .filter((o) => o !== this.context().organization),
+            result['Accounts'].map((o) => o.metadata.name),
           );
         },
       });
@@ -121,10 +122,14 @@ export class OrganizationManagementComponent implements OnInit {
           ]);
           this.organizationToSwitch.set(this.newOrganization);
           this.newOrganization = '';
-          this.LuigiClient().uxManager().showAlert({
-            text: 'New organization has been created, select it from the list to switch to it.',
-            type: 'info',
-          });
+          this.LuigiClient()
+            .uxManager()
+            .showAlert({
+              text: this.getMessageForOrganizationCreation(
+                this.organizationToSwitch(),
+              ),
+              type: 'info',
+            });
         },
         error: (_error) => {
           this.LuigiClient()
@@ -137,6 +142,14 @@ export class OrganizationManagementComponent implements OnInit {
       });
   }
 
+  private getMessageForOrganizationCreation(orgName: string) {
+    if (isLocalSetup()) {
+      return `A new organization has been onboarded. Since the portal runs on localhost, you need to add the organization to your machine's hosts file in order to switch to it. Add the following entry to your hosts configuration: 127.0.0.1 ${orgName}.portal.dev.local`;
+    }
+
+    return 'A new organization has been created. Select it from the list to switch.';
+  }
+
   private readTranslations() {
     return {
       explanation: this.i18nService.getTranslation(