Single-tenant runtime config with predefined "kamu user".

Runtime config path determine by env. "loginMethods" => "enabledUILoginMethods". GitHub login may fail, handling
kamu-data · Aug 29, 2023 · 4e5fcab · 4e5fcab
1 parent f3cea99
commit 4e5fcab
Show file tree

Hide file tree

Showing 20 changed files with 89 additions and 34 deletions.
diff --git a/images/kamu-web-ui/Dockerfile b/images/kamu-web-ui/Dockerfile
@@ -6,11 +6,12 @@ COPY rootfs/ /
 RUN cd /usr/share/nginx/html && \
     rm * && \
     curl \
-        --location --silent \
-        --output kamu-web-ui-any.tar.gz \
-        "https://github.com/kamu-data/kamu-web-ui/releases/download/v${KAMU_WEB_UI_VERSION}/kamu-web-ui-any.tar.gz" && \
+    --location --silent \
+    --output kamu-web-ui-any.tar.gz \
+    "https://github.com/kamu-data/kamu-web-ui/releases/download/v${KAMU_WEB_UI_VERSION}/kamu-web-ui-any.tar.gz" && \
     tar -xf kamu-web-ui-any.tar.gz && \
     mv kamu-web-ui-any/* . && \
     rm -r kamu-web-ui-any.tar.gz kamu-web-ui-any
 
 COPY runtime-config.json /usr/share/nginx/html/assets/runtime-config.json
+COPY runtime-config-single-tenant.json /usr/share/nginx/html/assets/runtime-config-single-tenant.json
diff --git a/images/kamu-web-ui/runtime-config-single-tenant.json b/images/kamu-web-ui/runtime-config-single-tenant.json
@@ -0,0 +1,11 @@
+{
+    "apiServerGqlUrl": "http://localhost:8080/graphql",
+    "featureFlags": {
+        "enableLogout": false,
+        "enabledUILoginMethods": []
+    },
+    "loginInstructions": {
+        "loginMethod": "password",
+        "loginCredentialsJson": "{\"login\": \"kamu\", \"password\": \"kamu\"}"
+    }
+}
diff --git a/images/kamu-web-ui/runtime-config.json b/images/kamu-web-ui/runtime-config.json
@@ -2,7 +2,7 @@
     "apiServerGqlUrl": "http://localhost:8080/graphql",
     "featureFlags": {
         "enableLogout": true,
-        "loginMethods": [
+        "enabledUILoginMethods": [
             "password",
             "oauth_github"
         ]

diff --git a/src/app/app-config.model.ts b/src/app/app-config.model.ts
@@ -16,5 +16,5 @@ export enum LoginMethod {
 
 export interface AppConfigFeatureFlags {
     enableLogout: boolean;
-    loginMethods: LoginMethod[];
+    enabledUILoginMethods: LoginMethod[];
 }
diff --git a/src/app/app-config.service.ts b/src/app/app-config.service.ts
@@ -1,5 +1,6 @@
 import { Injectable } from "@angular/core";
 import { AppConfig, AppConfigFeatureFlags, AppConfigLoginInstructions } from "./app-config.model";
+import { environment } from "src/environments/environment";
 
 @Injectable({
     providedIn: "root",
@@ -37,7 +38,7 @@ export class AppConfigService {
 
     private static loadAppConfig(): AppConfig {
         const request = new XMLHttpRequest();
-        request.open("GET", "/assets/runtime-config.json", false);
+        request.open("GET", environment.runtime_config_file, false);
         request.send(null);
         const data: AppConfig = JSON.parse(request.responseText) as AppConfig;
         return {

diff --git a/src/app/app-routing.spec.ts b/src/app/app-routing.spec.ts
@@ -91,7 +91,7 @@ describe("Router", () => {
         it("login redirects to default page when not allowed in configuration", fakeAsync(() => {
             spyOnProperty(appConfigService, "featureFlags", "get").and.returnValue({
                 enableLogout: true,
-                loginMethods: [],
+                enabledUILoginMethods: [],
             });
 
             promiseWithCatch(router.navigate([ProjectLinks.URL_LOGIN]));

diff --git a/src/app/app.component.ts b/src/app/app.component.ts
@@ -33,7 +33,7 @@ export class AppComponent extends BaseComponent implements OnInit {
     };
     public static readonly DEFAULT_FEATURE_FLAGS: AppConfigFeatureFlags = {
         enableLogout: true,
-        loginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
+        enabledUILoginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
     };
 
     public readonly APP_LOGO = `/${AppValues.APP_LOGO}`;

diff --git a/src/app/auth/github-callback/github.callback.ts b/src/app/auth/github-callback/github.callback.ts
@@ -11,15 +11,15 @@ import { GithubLoginCredentials } from "src/app/api/auth.api.model";
     changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class GithubCallbackComponent extends BaseComponent implements OnInit {
-    constructor(
+    public constructor(
         private route: ActivatedRoute,
         private navigationService: NavigationService,
         private loginService: LoginService,
     ) {
         super();
     }
 
-    ngOnInit() {
+    public ngOnInit() {
         if (!this.searchString.includes("?code=")) {
             this.navigationService.navigateToHome();
         }

diff --git a/src/app/auth/guards/login.guard.spec.ts b/src/app/auth/guards/login.guard.spec.ts
@@ -31,27 +31,27 @@ describe("LoginGuard", () => {
     [
         {
             route: ProjectLinks.URL_LOGIN,
-            featureFlags: { enableLogout: true, loginMethods: [LoginMethod.PASSWORD] },
+            featureFlags: { enableLogout: true, enabledUILoginMethods: [LoginMethod.PASSWORD] },
             expectedResult: true,
         },
         {
             route: ProjectLinks.URL_LOGIN,
-            featureFlags: { enableLogout: true, loginMethods: [] },
+            featureFlags: { enableLogout: true, enabledUILoginMethods: [] },
             expectedResult: false,
         },
         {
             route: ProjectLinks.URL_SEARCH,
-            featureFlags: { enableLogout: true, loginMethods: [LoginMethod.PASSWORD] },
+            featureFlags: { enableLogout: true, enabledUILoginMethods: [LoginMethod.PASSWORD] },
             expectedResult: true,
         },
         {
             route: ProjectLinks.URL_SEARCH,
-            featureFlags: { enableLogout: true, loginMethods: [] },
+            featureFlags: { enableLogout: true, enabledUILoginMethods: [] },
             expectedResult: true,
         },
     ].forEach((testCase: TestCase) => {
         it(`should check route ${testCase.route} with login ${
-            testCase.featureFlags.loginMethods.length > 0 ? "enabled" : "disabled"
+            testCase.featureFlags.enabledUILoginMethods.length > 0 ? "enabled" : "disabled"
         }`, () => {
             spyOnProperty(appConfigService, "featureFlags", "get").and.returnValue(testCase.featureFlags);
             const result = guard.canActivate(new ActivatedRouteSnapshot(), {

diff --git a/src/app/auth/guards/login.guard.ts b/src/app/auth/guards/login.guard.ts
@@ -25,6 +25,9 @@ export class LoginGuard implements CanActivate {
     }
 
     private canLogin(): boolean {
-        return this.appConfigService.featureFlags.loginMethods.length > 0 && !this.loggedUserService.isAuthenticated;
+        return (
+            this.appConfigService.featureFlags.enabledUILoginMethods.length > 0 &&
+            !this.loggedUserService.isAuthenticated
+        );
     }
 }
diff --git a/src/app/auth/login/login.component.spec.ts b/src/app/auth/login/login.component.spec.ts
@@ -69,7 +69,7 @@ describe("LoginComponent", () => {
             appConfigService = TestBed.inject(AppConfigService);
             spyOnProperty(appConfigService, "featureFlags", "get").and.returnValue({
                 enableLogout: true,
-                loginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
+                enabledUILoginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
             });
 
             createFixture();
@@ -204,7 +204,7 @@ describe("LoginComponent", () => {
                 appConfigService = TestBed.inject(AppConfigService);
                 spyOnProperty(appConfigService, "featureFlags", "get").and.returnValue({
                     enableLogout: true,
-                    loginMethods: [loginMethod],
+                    enabledUILoginMethods: [loginMethod],
                 });
 
                 spyGotoGithub = spyOn(LoginService, "gotoGithub").and.stub();
@@ -233,7 +233,7 @@ describe("LoginComponent", () => {
             appConfigService = TestBed.inject(AppConfigService);
             spyOnProperty(appConfigService, "featureFlags", "get").and.returnValue({
                 enableLogout: true,
-                loginMethods: [],
+                enabledUILoginMethods: [],
             });
         });
 

diff --git a/src/app/auth/login/login.component.ts b/src/app/auth/login/login.component.ts
@@ -48,9 +48,9 @@ export class LoginComponent implements OnInit {
 
     public ngOnInit(): void {
         const featureFlags: AppConfigFeatureFlags = this.appConfigService.featureFlags;
-        if (featureFlags.loginMethods.length === 1) {
-            this.onSelectedLoginMethod(featureFlags.loginMethods[0]);
-        } else if (featureFlags.loginMethods.length === 0) {
+        if (featureFlags.enabledUILoginMethods.length === 1) {
+            this.onSelectedLoginMethod(featureFlags.enabledUILoginMethods[0]);
+        } else if (featureFlags.enabledUILoginMethods.length === 0) {
             throw new Error(LoginComponent.ERROR_ZERO_METHODS_IN_CONFIG);
         }
     }

diff --git a/src/app/auth/login/login.service.spec.ts b/src/app/auth/login/login.service.spec.ts
@@ -1,4 +1,4 @@
-import { TestBed } from "@angular/core/testing";
+import { TestBed, fakeAsync, tick } from "@angular/core/testing";
 import { AuthApi } from "src/app/api/auth.api";
 import { NavigationService } from "src/app/services/navigation.service";
 import { LoginService } from "./login.service";
@@ -39,6 +39,28 @@ describe("LoginService", () => {
         expect(navigateSpy).toHaveBeenCalledTimes(1);
     });
 
+    it("failed Github login navigates to home, but throws an error", fakeAsync(() => {
+        const errorText = "Unsupported login method";
+        const exception = new AuthenticationError([new Error(errorText)]);
+
+        const authApiSpy = spyOn(authApi, "fetchUserInfoAndTokenFromGithubCallackCode").and.returnValue(
+            throwError(() => exception),
+        );
+        const navigateSpy = spyOn(navigationService, "navigateToHome");
+
+        const credentials: GithubLoginCredentials = { code: TEST_GITHUB_CODE };
+        try {
+            service.githubLogin(credentials);
+            tick();
+            fail("unexpected success");
+        } catch (e) {
+            expect(e).toEqual(exception);
+        }
+
+        expect(authApiSpy).toHaveBeenCalledOnceWith(credentials);
+        expect(navigateSpy).toHaveBeenCalledTimes(1);
+    }));
+
     it("succesful password login navigates to home", () => {
         const authApiSpy = spyOn(authApi, "fetchUserInfoAndTokenFromPasswordLogin").and.returnValue(of(void {}));
         const navigateSpy = spyOn(navigationService, "navigateToHome");

diff --git a/src/app/auth/login/login.service.ts b/src/app/auth/login/login.service.ts
@@ -26,13 +26,17 @@ export class LoginService {
         window.location.href = ProjectLinks.GITHUB_URL;
     }
 
-    public githubLogin(credentials: GithubLoginCredentials) {
-        this.authApi
-            .fetchUserInfoAndTokenFromGithubCallackCode(credentials)
-            .subscribe(() => this.navigationService.navigateToHome());
+    public githubLogin(credentials: GithubLoginCredentials): void {
+        this.authApi.fetchUserInfoAndTokenFromGithubCallackCode(credentials).subscribe({
+            next: () => this.navigationService.navigateToHome(),
+            error: (e) => {
+                this.navigationService.navigateToHome();
+                throw e;
+            },
+        });
     }
 
-    public passwordLogin(credentials: PasswordLoginCredentials) {
+    public passwordLogin(credentials: PasswordLoginCredentials): void {
         this.authApi.fetchUserInfoAndTokenFromPasswordLogin(credentials).subscribe({
             next: () => this.navigationService.navigateToHome(),
             error: (e) => {

diff --git a/src/app/components/app-header/app-header.component.html b/src/app/components/app-header/app-header.component.html
@@ -99,7 +99,7 @@
                     Explore
                 </a>
 
-                <ng-template [ngIf]="!isUserLoggedIn() && featureFlags.loginMethods.length > 0">
+                <ng-template [ngIf]="!isUserLoggedIn() && featureFlags.enabledUILoginMethods.length > 0">
                     <a
                         class="Header-link d-block d-md-none mr-0 mr-md-3 py-2 py-md-3 border-sm-top border-top border-md-top-0 border-white-fade"
                         data-test-id="loginHeader"
@@ -234,7 +234,7 @@
 
                     <div role="none" class="dropdown-divider"></div>
 
-                    <ng-template [ngIf]="!isUserLoggedIn() && featureFlags.loginMethods.length > 0">
+                    <ng-template [ngIf]="!isUserLoggedIn() && featureFlags.enabledUILoginMethods.length > 0">
                         <button mat-menu-item data-test-id="openLogin" (click)="onLogin()">Login</button>
                     </ng-template>
 

diff --git a/src/app/components/app-header/app-header.component.spec.ts b/src/app/components/app-header/app-header.component.spec.ts
@@ -82,7 +82,7 @@ describe("AppHeaderComponent", () => {
         };
         component.featureFlags = {
             enableLogout: true,
-            loginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
+            enabledUILoginMethods: [LoginMethod.GITHUB, LoginMethod.PASSWORD],
         };
         component.isVisible = true;
         component.isMobileView = false;
@@ -156,7 +156,7 @@ describe("AppHeaderComponent", () => {
     it("should not have Login link when login feature is disabled", () => {
         component.featureFlags = {
             ...component.featureFlags,
-            loginMethods: [],
+            enabledUILoginMethods: [],
         };
         fixture.detectChanges();
 
@@ -310,7 +310,7 @@ describe("AppHeaderComponent", () => {
         it("should not have Login link menu when login feature is disabled", () => {
             component.featureFlags = {
                 ...component.featureFlags,
-                loginMethods: [],
+                enabledUILoginMethods: [],
             };
             fixture.detectChanges();
 

diff --git a/src/assets/runtime-config-single-tenant.json b/src/assets/runtime-config-single-tenant.json
@@ -0,0 +1,11 @@
+{
+    "apiServerGqlUrl": "http://localhost:8080/graphql",
+    "featureFlags": {
+        "enableLogout": false,
+        "enabledUILoginMethods": []
+    },
+    "loginInstructions": {
+        "loginMethod": "password",
+        "loginCredentialsJson": "{\"login\": \"kamu\", \"password\": \"kamu\"}"
+    }
+}
diff --git a/src/assets/runtime-config.json b/src/assets/runtime-config.json
@@ -2,7 +2,7 @@
     "apiServerGqlUrl": "http://localhost:8080/graphql",
     "featureFlags": {
         "enableLogout": true,
-        "loginMethods": [
+        "enabledUILoginMethods": [
             "password",
             "oauth_github"
         ]

diff --git a/src/environments/environment.prod.ts b/src/environments/environment.prod.ts
@@ -2,4 +2,5 @@ export const environment = {
     production: true,
     github_client_id: "361a3b4fda86d0234d2f", // your Client ID from GitHub
     delay_http_request_ms: 0,
+    runtime_config_file: "/assets/runtime-config.json",
 };
diff --git a/src/environments/environment.ts b/src/environments/environment.ts
@@ -6,6 +6,7 @@ export const environment = {
     production: false,
     github_client_id: "361a3b4fda86d0234d2f", // your Client ID from GitHub,
     delay_http_request_ms: 500,
+    runtime_config_file: "/assets/runtime-config.json",
 };
 
 /*