Cb 4661 remove includes concept from resources api

webapp/packages/core-authentication/src/TeamInfoMetaParametersResource.ts

@@ -0,0 +1,66 @@
+/*
+ * CloudBeaver - Cloud Database Manager
+ * Copyright (C) 2020-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0.
+ * you may not use this file except in compliance with the License.
+ */
+import { injectable } from '@cloudbeaver/core-di';
+import { CachedMapAllKey, CachedMapResource, isResourceAlias, ResourceKey, resourceKeyList, ResourceKeyUtils } from '@cloudbeaver/core-resource';
+import { GraphQLService } from '@cloudbeaver/core-sdk';
+
+import type { TeamMetaParameter } from './TeamMetaParametersResource';
+import { TeamsResource } from './TeamsResource';
+
+@injectable()
+export class TeamInfoMetaParametersResource extends CachedMapResource<string, TeamMetaParameter> {
+  constructor(
+    private readonly graphQLService: GraphQLService,
+    private readonly teamsResource: TeamsResource,
+  ) {
+    super();
+
+    this.sync(this.teamsResource);
+  }
+
+  protected async loader(param: ResourceKey<string>): Promise<Map<string, TeamMetaParameter>> {
+    const all = this.aliases.isAlias(param, CachedMapAllKey);
+    const teamsList: [string, TeamMetaParameter][] = [];
+
+    await ResourceKeyUtils.forEachAsync(param, async key => {
+      let teamId: string | undefined;
+
+      if (!isResourceAlias(key)) {
+        teamId = key;
+      }
+
+      const { teams } = await this.graphQLService.sdk.getTeamsListMetaParameters({
+        teamId,
+      });
+      const metaParameters = teams[0].metaParameters;
+
+      if (teamId) {
+        teamsList.push([teamId, metaParameters]);
+      }
+    });
+
+    const key = resourceKeyList(teamsList.map(([teamId]) => teamId));
+    const value = teamsList.map(([_, metaParameters]) => metaParameters);
+
+    if (all) {
+      this.replace(key, value);
+    } else {
+      this.set(key, value);
+    }
+
+    return this.data;
+  }
+
+  async setMetaParameters(teamId: string, parameters: Record<string, any>): Promise<void> {
+    await this.graphQLService.sdk.saveTeamMetaParameters({ teamId, parameters });
+  }
+
+  protected validateKey(key: string): boolean {
+    return typeof key === 'string';
+  }
+}

webapp/packages/core-authentication/src/TeamsResource.ts

@@ -24,6 +24,8 @@
 } from '@cloudbeaver/core-sdk';
 import { isArraysEqual, UndefinedToNull } from '@cloudbeaver/core-utils';
 
+import type { TeamMetaParameter } from './TeamMetaParametersResource';
+
 const NEW_TEAM_SYMBOL = Symbol('new-team');
 
 export type TeamInfo = AdminTeamInfoFragment;
@@ -38,12 +40,11 @@
     super();
   }
 
-  async createTeam({ teamId, teamPermissions, teamName, description, metaParameters }: TeamInfo): Promise<TeamInfo> {
+  async createTeam({ teamId, teamPermissions, teamName, description }: TeamInfo): Promise<TeamInfo> {
     const response = await this.graphQLService.sdk.createTeam({
       teamId,
       teamName,
       description,
-      ...this.getDefaultIncludes(),
       ...this.getIncludesMap(teamId),
     });
 
@@ -55,24 +56,21 @@
 
     this.set(newTeam.teamId, newTeam);
 
-    await this.setMetaParameters(newTeam.teamId, metaParameters);
     await this.setSubjectPermissions(newTeam.teamId, teamPermissions);
 
     return this.get(teamId)!;
   }
 
-  async updateTeam({ teamId, teamPermissions, teamName, description, metaParameters }: TeamInfo): Promise<TeamInfo> {
+  async updateTeam({ teamId, teamPermissions, teamName, description }: TeamInfo): Promise<TeamInfo> {
     const { team } = await this.graphQLService.sdk.updateTeam({
       teamId,
       teamName,
       description,
-      ...this.getDefaultIncludes(),
       ...this.getIncludesMap(teamId),
     });
 
     this.set(team.teamId, team);
 
-    await this.setMetaParameters(team.teamId, metaParameters);
     await this.setSubjectPermissions(team.teamId, teamPermissions);
 
     this.markOutdated(team.teamId);
@@ -119,10 +117,6 @@
     }
   }
 
-  async setMetaParameters(teamId: string, parameters: Record<string, any>): Promise<void> {
-    await this.graphQLService.sdk.saveTeamMetaParameters({ teamId, parameters });
-  }
-
   protected async loader(originalKey: ResourceKey<string>, includes?: string[]): Promise<Map<string, TeamInfo>> {
     const all = this.aliases.isAlias(originalKey, CachedMapAllKey);
     const teamsList: TeamInfo[] = [];
@@ -136,7 +130,6 @@
 
       const { teams } = await this.graphQLService.sdk.getTeamsList({
         teamId,
-        ...this.getDefaultIncludes(),
         ...this.getIncludesMap(teamId, includes),
       });
 
@@ -164,12 +157,6 @@
     super.dataSet(key, { ...oldTeam, ...value });
   }
 
-  private getDefaultIncludes(): TeamResourceIncludes {
-    return {
-      includeMetaParameters: false,
-    };
-  }
-
   protected validateKey(key: string): boolean {
     return typeof key === 'string';
   }

webapp/packages/core-authentication/src/UserInfoMetaParametersResource.ts

@@ -0,0 +1,35 @@
+/*
+ * CloudBeaver - Cloud Database Manager
+ * Copyright (C) 2020-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0.
+ * you may not use this file except in compliance with the License.
+ */
+import { injectable } from '@cloudbeaver/core-di';
+import { CachedDataResource, ResourceKey } from '@cloudbeaver/core-resource';
+import { GraphQLService } from '@cloudbeaver/core-sdk';
+
+import { UserInfoResource } from './UserInfoResource';
+import type { UserMetaParameter } from './UserMetaParametersResource';
+
+@injectable()
+export class UserInfoMetaParametersResource extends CachedDataResource<UserMetaParameter | null> {
+  constructor(
+    private readonly graphQLService: GraphQLService,
+    private readonly userInfoResource: UserInfoResource,
+  ) {
+    super(() => null, undefined);
+
+    this.sync(this.userInfoResource);
+  }
+
+  protected async loader(param: ResourceKey<void>): Promise<UserMetaParameter | null> {
+    try {
+      const { user } = await this.graphQLService.sdk.getActiveUserMetaParameters();
+
+      return user?.metaParameters;
+    } catch (exception: any) {
+      return null;
+    }
+  }
+}

webapp/packages/core-authentication/src/UserInfoResource.ts

@@ -53,7 +53,7 @@ export class UserInfoResource extends CachedDataResource<UserInfo | null, void,
     private readonly authProviderService: AuthProviderService,
     private readonly sessionResource: SessionResource,
   ) {
-    super(() => null, undefined, ['customIncludeOriginDetails', 'includeConfigurationParameters']);
+    super(() => null, undefined, ['includeConfigurationParameters']);
 
     this.onUserChange = new SyncExecutor();
     this.onException = new SyncExecutor();
@@ -103,7 +103,6 @@ export class UserInfoResource extends CachedDataResource<UserInfo | null, void,
       configuration: configurationId,
       credentials: processedCredentials,
       linkUser,
-      customIncludeOriginDetails: true,
       forceSessionsLogout,
     });
 
@@ -135,7 +134,6 @@ export class UserInfoResource extends CachedDataResource<UserInfo | null, void,
             const { authInfo } = await this.graphQLService.sdk.getAuthStatus({
               authId,
               linkUser,
-              customIncludeOriginDetails: true,
             });
             return authInfo as AuthInfo;
           },
@@ -281,9 +279,7 @@ export class UserInfoResource extends CachedDataResource<UserInfo | null, void,
 
   private getDefaultIncludes(): UserInfoIncludes {
     return {
-      customIncludeOriginDetails: true,
       includeConfigurationParameters: false,
-      includeMetaParameters: false,
     };
   }
 }

webapp/packages/core-authentication/src/UsersMetaParametersResource.ts

@@ -0,0 +1,125 @@
+/*
+ * CloudBeaver - Cloud Database Manager
+ * Copyright (C) 2020-2024 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0.
+ * you may not use this file except in compliance with the License.
+ */
+import { runInAction } from 'mobx';
+
+import { injectable } from '@cloudbeaver/core-di';
+import {
+  CACHED_RESOURCE_DEFAULT_PAGE_LIMIT,
+  CACHED_RESOURCE_DEFAULT_PAGE_OFFSET,
+  CachedMapAllKey,
+  CachedMapResource,
+  CachedResourceOffsetPageKey,
+  CachedResourceOffsetPageListKey,
+  isResourceAlias,
+  ResourceKey,
+  resourceKeyList,
+  ResourceKeyUtils,
+} from '@cloudbeaver/core-resource';
+import { GraphQLService } from '@cloudbeaver/core-sdk';
+
+import type { UserMetaParameter } from './UserMetaParametersResource';
+import { UsersResource, UsersResourceFilterKey } from './UsersResource';
+
+@injectable()
+export class UsersMetaParametersResource extends CachedMapResource<string, UserMetaParameter> {
+  constructor(
+    private readonly graphQLService: GraphQLService,
+    private readonly usersResource: UsersResource,
+  ) {
+    super();
+
+    this.sync(this.usersResource);
+  }
+
+  async setMetaParameters(userId: string, parameters: Record<string, any>): Promise<void> {
+    await this.graphQLService.sdk.saveUserMetaParameters({ userId, parameters });
+    this.markOutdated(userId);
+  }
+
+  protected async loader(originalKey: ResourceKey<string>): Promise<Map<string, UserMetaParameter>> {
+    const all = this.aliases.isAlias(originalKey, CachedMapAllKey);
+    const keys: string[] = [];
+    const pages: Parameters<typeof this.offsetPagination.setPage>[] = [];
+
+    if (all) {
+      throw new Error('Loading all users is prohibited');
+    }
+
+    const userMetaParametersList: UserMetaParameter[] = [];
+
+    await ResourceKeyUtils.forEachAsync(originalKey, async key => {
+      let userId: string | undefined;
+
+      if (!isResourceAlias(key)) {
+        userId = key;
+      }
+
+      if (userId !== undefined) {
+        const { user } = await this.graphQLService.sdk.getAdminUserMetaParameters({
+          userId,
+        });
+
+        keys.push(userId);
+        userMetaParametersList.push(user.metaParameters);
+      } else {
+        const pageKey =
+          this.aliases.isAlias(originalKey, CachedResourceOffsetPageKey) || this.aliases.isAlias(originalKey, CachedResourceOffsetPageListKey);
+        const filterKey = this.aliases.isAlias(originalKey, UsersResourceFilterKey);
+        let offset = CACHED_RESOURCE_DEFAULT_PAGE_OFFSET;
+        let limit = CACHED_RESOURCE_DEFAULT_PAGE_LIMIT;
+        let userIdMask: string | undefined;
+        let enabledState: boolean | undefined;
+
+        if (pageKey) {
+          offset = pageKey.options.offset;
+          limit = pageKey.options.limit;
+        }
+
+        if (filterKey) {
+          userIdMask = filterKey.options.userId;
+          enabledState = filterKey.options.enabledState;
+        }
+
+        const { users } = await this.graphQLService.sdk.getUsersMetaParametersList({
+          page: {
+            offset,
+            limit,
+          },
+          filter: {
+            userIdMask,
+            enabledState,
+          },
+        });
+
+        userMetaParametersList.push(...users.map(user => user.metaParameters));
+        keys.push(...users.map(user => user.userId));
+
+        pages.push([
+          CachedResourceOffsetPageListKey(offset, users.length).setParent(filterKey!),
+          users.map(user => user.userId),
+          users.length === limit,
+        ]);
+      }
+    });
+
+    const key = resourceKeyList(keys);
+
+    runInAction(() => {
+      this.set(key, userMetaParametersList);
+      for (const pageArgs of pages) {
+        this.offsetPagination.setPage(...pageArgs);
+      }
+    });
+
+    return this.data;
+  }
+
+  protected validateKey(key: string): boolean {
+    return typeof key === 'string';
+  }
+}