feat(#3227): Move file management to settings (#3228)

apache · Sep 14, 2024 · 1b7774b · 1b7774b
1 parent 19cdd22
commit 1b7774b
Show file tree

Hide file tree

Showing 38 changed files with 237 additions and 316 deletions.
diff --git a/streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/GenericStorageResource.java b/streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/GenericStorageResource.java
@@ -83,7 +83,7 @@ public ResponseEntity<Map<String, Object>> create(@PathVariable(APP_DOC_NAME) St
       path = "/{appDocName}/find",
       produces = MediaType.APPLICATION_JSON_VALUE,
       consumes = MediaType.APPLICATION_JSON_VALUE)
-  @PreAuthorize(AuthConstants.HAS_WRITE_GENERIC_STORAGE_PRIVILEGE)
+  @PreAuthorize(AuthConstants.HAS_READ_GENERIC_STORAGE_PRIVILEGE)
   public ResponseEntity<List<Map<String, Object>>> find(@PathVariable(APP_DOC_NAME) String appDocName,
                                                         @RequestBody Map<String, Object> query) {
     try {

diff --git a/...ement/src/main/java/org/apache/streampipes/user/management/authorization/RoleManager.java b/...ement/src/main/java/org/apache/streampipes/user/management/authorization/RoleManager.java
@@ -42,7 +42,8 @@ public List<Role> makeDefaultRoles() {
         Role.createDefaultRole(DefaultRole.Constants.ROLE_SERVICE_ADMIN_VALUE, "Service Admin", List.of()),
         Role.createDefaultRole(DefaultRole.Constants.ROLE_DASHBOARD_ADMIN_VALUE, "Dashboard Admin", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_READ_DASHBOARD_VALUE,
-            DefaultPrivilege.Constants.PRIVILEGE_WRITE_DASHBOARD_VALUE
+            DefaultPrivilege.Constants.PRIVILEGE_WRITE_DASHBOARD_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_VALUE
         )),
         Role.createDefaultRole(DefaultRole.Constants.ROLE_DASHBOARD_USER_VALUE, "Dashboard User", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_READ_DASHBOARD_VALUE,
@@ -52,11 +53,14 @@ public List<Role> makeDefaultRoles() {
         Role.createDefaultRole(DefaultRole.Constants.ROLE_PIPELINE_ADMIN_VALUE, "Pipeline Admin", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_VALUE,
             DefaultPrivilege.Constants.PRIVILEGE_WRITE_PIPELINE_VALUE,
-            DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_ELEMENT_VALUE
+            DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_ELEMENT_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_READ_FILES_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_WRITE_FILES_VALUE
         )),
         Role.createDefaultRole(DefaultRole.Constants.ROLE_PIPELINE_USER_VALUE, "Pipeline User", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_VALUE,
-            DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_ELEMENT_VALUE
+            DefaultPrivilege.Constants.PRIVILEGE_READ_PIPELINE_ELEMENT_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_READ_FILES_VALUE
         )),
         Role.createDefaultRole(DefaultRole.Constants.ROLE_ASSET_ADMIN_VALUE, "Asset Admin", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_READ_ASSETS_VALUE,
@@ -83,7 +87,9 @@ public List<Role> makeDefaultRoles() {
         )),
         Role.createDefaultRole(DefaultRole.Constants.ROLE_CONNECT_ADMIN_VALUE, "Connect Admin", List.of(
             DefaultPrivilege.Constants.PRIVILEGE_WRITE_ADAPTER_VALUE,
-            DefaultPrivilege.Constants.PRIVILEGE_READ_ADAPTER_VALUE
+            DefaultPrivilege.Constants.PRIVILEGE_READ_ADAPTER_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_READ_FILES_VALUE,
+            DefaultPrivilege.Constants.PRIVILEGE_WRITE_FILES_VALUE
         ))
     );
   }

diff --git a/ui/cypress/support/utils/FileManagementUtils.ts b/ui/cypress/support/utils/FileManagementUtils.ts
@@ -19,7 +19,7 @@
 export class FileManagementUtils {
     public static addFile(filePath: string) {
         // Go to StreamPipes file management
-        cy.visit('#/files');
+        cy.visit('#/configuration/files');
 
         // Open file upload dialog
         cy.dataCy('sp-open-file-upload-dialog').click();
@@ -32,7 +32,7 @@ export class FileManagementUtils {
 
     public static deleteFile() {
         // Go to StreamPipes file management
-        cy.visit('#/files');
+        cy.visit('#/configuration/files');
         // Check if file was uploaded and delete it
         cy.dataCy('delete').should('have.length', 1);
         cy.dataCy('delete').click();
@@ -44,7 +44,7 @@ export class FileManagementUtils {
         const downloadsFolder = Cypress.config('downloadsFolder');
 
         // Go to StreamPipes file management
-        cy.visit('#/files');
+        cy.visit('#/configuration/files');
         // Check if file was uploaded
         cy.dataCy('download').should('have.length', 1);
 

diff --git a/ui/cypress/tests/userManagement/testVariousUserRoles.smoke.spec.ts b/ui/cypress/tests/userManagement/testVariousUserRoles.smoke.spec.ts
@@ -40,7 +40,7 @@ for (var i = 0; i < testedRoles.length; i++) {
             UserUtils.goToUserConfiguration();
             cy.dataCy('navigation-icon', { timeout: 10000 }).should(
                 'have.length',
-                9,
+                8,
             );
 
             cy.dataCy('user-accounts-table-row', { timeout: 10000 }).should(
@@ -75,12 +75,12 @@ for (var i = 0; i < testedRoles.length; i++) {
             } else if (testRole == UserRole.ROLE_DASHBOARD_ADMIN) {
                 cy.dataCy('navigation-icon', { timeout: 10000 }).should(
                     'have.length',
-                    2,
+                    4,
                 );
             } else if (testRole == UserRole.ROLE_DATA_EXPLORER_ADMIN) {
                 cy.dataCy('navigation-icon', { timeout: 10000 }).should(
                     'have.length',
-                    2,
+                    4,
                 );
             } else if (testRole == UserRole.ROLE_CONNECT_ADMIN) {
                 cy.dataCy('navigation-icon', { timeout: 10000 }).should(

diff --git a/ui/deployment/app-routing.module.mst b/ui/deployment/app-routing.module.mst
@@ -39,6 +39,7 @@ import { RegistrationAllowedCanActivateGuard } from './_guards/registration-allo
 import { RestorePasswordAllowedCanActivateGuard } from './_guards/restore-password-allowed.can-activate.guard';
 import { SetNewPasswordComponent } from './login/components/set-new-password/set-new-password.component';
 import { ActivateAccountComponent } from './login/components/activate-account/activate-account.component';
+import { UserPrivilege } from './_enums/user-privilege.enum';
 
 {{#modulesActive}}
 {{#componentImport}}
@@ -60,10 +61,10 @@ const routes: Routes = [
       { path: '', component: HomeComponent, canActivate: [ConfiguredCanActivateGuard] },
       {{#modulesActive}}
       {{#componentImport}}
-      { path: '{{{link}}}', component: {{{component}}}, data: { authPageNames: [{{{pageNames}}}]}},
+      { path: '{{{link}}}', component: {{{component}}}, data: { privileges: {{{privileges}}}, authPageNames: [{{{pageNames}}}]}},
       {{/componentImport}}
       {{^componentImport}}
-      { path: '{{{link}}}', data: { authPageNames: [{{{pageNames}}}]}, loadChildren: () => import('{{{path}}}').then(m => m.{{{moduleName}}})},
+      { path: '{{{link}}}', data: { privileges: {{{privileges}}}, authPageNames: [{{{pageNames}}}]}, loadChildren: () => import('{{{path}}}').then(m => m.{{{moduleName}}})},
       {{/componentImport}}
       {{/modulesActive}}
 

diff --git a/ui/deployment/base-navigation.component.mst b/ui/deployment/base-navigation.component.mst
@@ -22,6 +22,7 @@ import { PageName } from '../../_enums/page-name.enum';
 import { AuthService } from '../../services/auth.service';
 import { CurrentUserService } from '@streampipes/shared-ui';
 import { AppConstants } from '../../services/app.constants';
+import { UserPrivilege } from '../../_enums/user-privilege.enum';
 
 export abstract class BaseNavigationComponent {
 
@@ -36,32 +37,18 @@ export abstract class BaseNavigationComponent {
       title: 'Home',
       icon: 'home',
       pagesNames: [PageName.HOME],
+      privileges: [],
       visible: false
     },
     {{#modulesActive}}
-    {{^admin}}
     {
         link: '{{{link}}}',
         title: '{{{title}}}',
         icon: '{{{icon}}}',
         pageNames: [{{{pageNames}}}],
+        privileges: {{{privileges}}},
         visible: false
     },
-    {{/admin}}
-    {{/modulesActive}}
-  ];
-
-  admin = [
-    {{#modulesActive}}
-    {{#admin}}
-    {
-        link: '{{{link}}}',
-        title: '{{{title}}}',
-        icon: '{{{icon}}}',
-        pageNames: [{{{pageNames}}}],
-        visible: false
-    },
-    {{/admin}}
     {{/modulesActive}}
   ];
 
@@ -77,9 +64,11 @@ export abstract class BaseNavigationComponent {
 
     onInit() {
       this.currentUserService.user$.subscribe(user => {
-        this.menu.forEach(m => m.visible = this.isNavItemVisible(m.pageNames));
-        this.admin.forEach(m => m.visible = this.isNavItemVisible(m.pageNames));
-        this.notificationsVisible = this.isNavItemVisible([PageName.NOTIFICATIONS]);
+        this.menu.forEach(m => m.visible = this.isNavItemVisible(m.privileges));
+        this.notificationsVisible = this.isNavItemVisible([
+        UserPrivilege.PRIVILEGE_READ_PIPELINE,
+        UserPrivilege.PRIVILEGE_WRITE_PIPELINE
+        ]);
       });
       this.activePage = this.router.url.replace('/', '');
       this.activePageName = this.getPageTitle(this.activePage);
@@ -96,9 +85,8 @@ export abstract class BaseNavigationComponent {
     }
 
     getPageTitle(path) {
-      const allMenuItems = this.menu.concat(this.admin);
       let currentTitle = this.appConstants.APP_NAME;
-      allMenuItems.forEach(m => {
+      this.menu.forEach(m => {
         if (m.link === path) {
           currentTitle = m.title;
         }
@@ -120,8 +108,8 @@ export abstract class BaseNavigationComponent {
       this.activePageName = this.getPageTitle(this.activePage);
     }
 
-    public isNavItemVisible(pageNames?: PageName[]): boolean {
-      return this.authService.isAnyAccessGranted(pageNames);
+    public isNavItemVisible(privileges: string[]): boolean {
+      return this.authService.isAnyAccessGranted(privileges);
     }
 
 }
diff --git a/ui/deployment/dev/config.yml b/ui/deployment/dev/config.yml
@@ -24,5 +24,4 @@ modules:
     - spDashboard
     - spDataExplorer
     - spAssets
-    - spFiles
     - spConfiguration
diff --git a/ui/deployment/home.service.mst b/ui/deployment/home.service.mst
@@ -26,7 +26,7 @@ import {
     DataViewDataExplorerService, PipelineElementService,
     PipelineService
 } from '@streampipes/platform-services';
-import { UserRole } from '../_enums/user-role.enum';
+import { UserPrivilege } from '../_enums/user-privilege.enum';
 
 @Injectable({providedIn: 'root'})
 export class HomeService {
@@ -40,7 +40,7 @@ export class HomeService {
     }
 
     getFilteredServiceLinks() {
-        return this.getServiceLinks().filter(s => this.authService.isAnyAccessGranted(s.pageNames));
+        return this.getServiceLinks().filter(s => this.authService.isAnyAccessGranted(s.privileges));
     }
 
     getServiceLinks(): ServiceLink[] {
@@ -51,6 +51,7 @@ export class HomeService {
                description: "{{description}}",
                icon: "{{{icon}}}",
                pageNames: [{{{pageNames}}}],
+               privileges: {{{privileges}}},
                link: {
                    newWindow: false,
                    value: "{{{link}}}"
@@ -74,6 +75,10 @@ export class HomeService {
                description: "The notification module lets you view all notifications generated by pipelines.",
                icon: "chat",
                pageNames: [PageName.NOTIFICATIONS],
+               privileges: [
+                UserPrivilege.PRIVILEGE_READ_PIPELINE,
+                UserPrivilege.PRIVILEGE_WRITE_PIPELINE
+               ],
                link: {
                    newWindow: false,
                    value: "notifications"

diff --git a/ui/deployment/modules.yml b/ui/deployment/modules.yml
@@ -24,7 +24,7 @@ spAssets:
     title: 'Asset Management'
     description: 'Manage assets which help assigning pipelines, dashboards and adapters to real-world objects such as machines and plants.'
     icon: 'precision_manufacturing'
-    admin: true
+    privileges: '[UserPrivilege.PRIVILEGE_READ_ASSETS, UserPrivilege.PRIVILEGE_WRITE_ASSETS]'
     pageNames: 'PageName.ASSETS'
     showStatusBox: false
 spConnect:
@@ -38,7 +38,7 @@ spConnect:
     title: 'Connect'
     description: 'StreamPipes Connect lets you easily connect new data sources for a variety of data formats and protocols.'
     icon: 'power'
-    admin: False
+    privileges: '[UserPrivilege.PRIVILEGE_READ_ADAPTER, UserPrivilege.PRIVILEGE_WRITE_ADAPTER]'
     pageNames: 'PageName.CONNECT'
     showStatusBox: true
     statusBox:
@@ -47,8 +47,8 @@ spConnect:
         title: 'Adapters'
         createTitle: 'New adapter'
         dataFns: '[this.adapterService.getAdapters()]'
-        viewRoles: '[UserRole.ROLE_CONNECT_ADMIN]'
-        createRoles: '[UserRole.ROLE_CONNECT_ADMIN]'
+        viewRoles: '[UserPrivilege.PRIVILEGE_READ_ADAPTER, UserPrivilege.PRIVILEGE_WRITE_ADAPTER]'
+        createRoles: '[UserPrivilege.PRIVILEGE_WRITE_ADAPTER]'
 spPipelines:
     componentImport: False
     moduleName: 'PipelinesModule'
@@ -60,17 +60,17 @@ spPipelines:
     title: 'Pipelines'
     description: 'All created pipelines are available in the pipeline view, where you can also start and stop pipelines.'
     icon: 'play_arrow'
-    admin: False
     pageNames: 'PageName.PIPELINE_OVERVIEW'
+    privileges: '[UserPrivilege.PRIVILEGE_READ_PIPELINE, UserPrivilege.PRIVILEGE_WRITE_PIPELINE]'
     showStatusBox: true
     statusBox:
         link: "['pipelines']"
         createLinks: "['pipelines', 'create']"
         title: 'Pipelines'
         createTitle: 'New pipeline'
         dataFns: '[this.pipelineService.getPipelines()]'
-        viewRoles: '[UserRole.ROLE_PIPELINE_ADMIN, UserRole.ROLE_PIPELINE_USER]'
-        createRoles: '[UserRole.ROLE_PIPELINE_ADMIN]'
+        viewRoles: '[UserPrivilege.PRIVILEGE_READ_PIPELINE, UserPrivilege.PRIVILEGE_WRITE_PIPELINE]'
+        createRoles: '[UserPrivilege.PRIVILEGE_WRITE_PIPELINE]'
 spConfiguration:
     componentImport: False
     moduleName: 'ConfigurationModule'
@@ -83,7 +83,7 @@ spConfiguration:
     description: 'In the configuration module, basic StreamPipes settings and services can be configured.'
     icon: 'settings'
     pageNames: 'PageName.SETTINGS'
-    admin: True
+    privileges: '[UserPrivilege.PRIVILEGE_WRITE_ASSETS, UserPrivilege.PRIVILEGE_WRITE_LABELS, UserPrivilege.PRIVILEGE_READ_FILES, UserPrivilege.PRIVILEGE_WRITE_FILES]'
     showStatusBox: false
 spAppOverview:
     componentImport: False
@@ -96,8 +96,8 @@ spAppOverview:
     title: 'Apps'
     description: 'The app overview lets you access additional plugins.'
     icon: 'apps'
-    admin: false
     pageNames: 'PageName.APPS'
+    privileges: '[UserPrivilege.PRIVILEGE_READ_APPS, UserPrivilege.PRIVILEGE_WRITE_APPS]'
     showStatusBox: false
 spDashboard:
     componentImport: False
@@ -110,17 +110,17 @@ spDashboard:
     title: 'Dashboard'
     description: 'The live dashboard visualizes data in real-time.'
     icon: 'insert_chart'
-    admin: false
     pageNames: 'PageName.DASHBOARD'
+    privileges: '[UserPrivilege.PRIVILEGE_READ_DASHBOARD, UserPrivilege.PRIVILEGE_WRITE_DASHBOARD]'
     showStatusBox: true
     statusBox:
         link: "['dashboard']"
         createLinks: "['dashboard']"
         title: 'Dashboards'
         createTitle: 'New dashboard'
         dataFns: '[this.dashboardService.getDashboards()]'
-        viewRoles: '[UserRole.ROLE_DASHBOARD_ADMIN, UserRole.ROLE_DASHBOARD_USER]'
-        createRoles: '[UserRole.ROLE_DASHBOARD_ADMIN]'
+        viewRoles: '[UserPrivilege.PRIVILEGE_READ_DASHBOARD, UserPrivilege.PRIVILEGE_WRITE_DASHBOARD]'
+        createRoles: '[UserPrivilege.PRIVILEGE_WRITE_DASHBOARD]'
 spDataExplorer:
     componentImport: False
     moduleName: 'DataExplorerModule'
@@ -132,28 +132,14 @@ spDataExplorer:
     title: 'Data Explorer'
     description: 'The data explorer lets you visually inspect historical data from your connected sources.'
     icon: 'search'
-    admin: false
     pageNames: 'PageName.DATA_EXPLORER'
+    privileges: '[UserPrivilege.PRIVILEGE_READ_DATA_EXPLORER_VIEW, UserPrivilege.PRIVILEGE_WRITE_DATA_EXPLORER_VIEW]'
     showStatusBox: true
     statusBox:
         link: "['dataexplorer']"
         createLinks: "['dataexplorer']"
         title: 'Data Views'
         createTitle: 'New data view'
         dataFns: '[this.dataViewService.getDataViews()]'
-        viewRoles: '[UserRole.ROLE_DATA_EXPLORER_ADMIN, UserRole.ROLE_DATA_EXPLORER_USER]'
-        createRoles: '[UserRole.ROLE_DATA_EXPLORER_ADMIN]'
-spFiles:
-    componentImport: False
-    moduleName: 'FilesModule'
-    component: 'FilesComponent'
-    componentPath: './files/files.component'
-    path: './files/files.module'
-    link: 'files'
-    url: '/files'
-    title: 'File Management'
-    description: 'The file management module lets you upload and manage files that are used by adapters or pipeline elements.'
-    icon: 'folder'
-    admin: true
-    pageNames: 'PageName.FILE_UPLOAD'
-    showStatusBox: false
+        viewRoles: '[UserPrivilege.PRIVILEGE_READ_DATA_EXPLORER_VIEW, UserPrivilege.PRIVILEGE_WRITE_DATA_EXPLORER_VIEW]'
+        createRoles: '[UserPrivilege.PRIVILEGE_WRITE_DATA_EXPLORER_VIEW]'
diff --git a/ui/deployment/prebuild.js b/ui/deployment/prebuild.js
@@ -73,6 +73,7 @@ for (let module of config.modules) {
         path: modules[module]['path'],
         link: modules[module]['link'],
         pageNames: modules[module]['pageNames'],
+        privileges: modules[module]['privileges'],
         url: modules[module]['url'],
         title: modules[module]['title'],
         icon: modules[module]['icon'],