@finos/legend-extension-dsl-data-product 0.0.2

package/src/utils/DataContractUtils.ts

@@ -0,0 +1,121 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  type V1_AccessPointGroup,
+  type V1_DataContract,
+  type V1_DataProduct,
+  type V1_LiteDataContract,
+  V1_AccessPointGroupReference,
+  V1_AdhocTeam,
+  V1_ContractState,
+  V1_deserializeTaskResponse,
+  V1_UserType,
+} from '@finos/legend-graph';
+import type { LakehouseContractServerClient } from '@finos/legend-server-lakehouse';
+
+const invalidContractState = [
+  V1_ContractState.DRAFT,
+  V1_ContractState.REJECTED,
+  V1_ContractState.CLOSED,
+];
+
+export const dataContractContainsDataProduct = (
+  dataProduct: V1_DataProduct,
+  dataProductDeploymentID: number,
+  dataContract: V1_DataContract,
+): boolean => {
+  if (invalidContractState.includes(dataContract.state)) {
+    return false;
+  }
+  const contractResource = dataContract.resource;
+  if (
+    contractResource instanceof V1_AccessPointGroupReference &&
+    dataProductDeploymentID
+  ) {
+    const didMatch =
+      dataProductDeploymentID === contractResource.dataProduct.owner.appDirId;
+    const nameMatch =
+      contractResource.dataProduct.name.toLowerCase() ===
+      dataProduct.name.toLowerCase();
+    const dataProductContainsContractAPG = dataProduct.accessPointGroups
+      .map((e) => e.id)
+      .includes(contractResource.accessPointGroup);
+    return didMatch && nameMatch && dataProductContainsContractAPG;
+  }
+
+  return false;
+};
+
+// Assume contract already part of data product
+export const dataContractContainsAccessGroup = (
+  group: V1_AccessPointGroup,
+  dataContract: V1_DataContract,
+): boolean => {
+  const contractResource = dataContract.resource;
+  if (contractResource instanceof V1_AccessPointGroupReference) {
+    return contractResource.accessPointGroup === group.id;
+  }
+  return false;
+};
+
+export const isContractInTerminalState = (
+  contract: V1_DataContract | V1_LiteDataContract,
+): boolean => {
+  return [
+    V1_ContractState.CLOSED,
+    V1_ContractState.COMPLETED,
+    V1_ContractState.REJECTED,
+  ].includes(contract.state);
+};
+
+export const isMemberOfContract = async (
+  user: string,
+  contract: V1_DataContract,
+  lakehouseContractServerClient: LakehouseContractServerClient,
+  token: string | undefined,
+): Promise<boolean> => {
+  const consumer = contract.consumer;
+  if (consumer instanceof V1_AdhocTeam) {
+    return consumer.users.some((e) => e.name === user);
+  } else if (contract.members.length > 0) {
+    return contract.members.some((e) => e.user.name === user);
+  } else {
+    // If consumer is not an ad-hoc team and the contract's members are not defined,
+    // we will fetch the tasks and use the tasks to determine if user is a member
+    // of the contract.
+    const rawTasks = await lakehouseContractServerClient.getContractTasks(
+      contract.guid,
+      token,
+    );
+    const tasks = V1_deserializeTaskResponse(rawTasks);
+    return tasks.some((task) => task.rec.consumer === user);
+  }
+};
+
+export const contractContainsSystemAccount = (
+  contract: V1_DataContract,
+): boolean => {
+  return (
+    (contract.consumer instanceof V1_AdhocTeam &&
+      contract.consumer.users.some(
+        (_user) => _user.userType === V1_UserType.SYSTEM_ACCOUNT,
+      )) ||
+    contract.members.some(
+      (_user) => _user.user.userType === V1_UserType.SYSTEM_ACCOUNT,
+    )
+  );
+};

package/src/utils/LakehouseUtils.ts

@@ -0,0 +1,91 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  V1_AdhocTeam,
+  V1_AppDirOrganizationalScope,
+  V1_UnknownOrganizationalScopeType,
+  type V1_OrganizationalScope,
+} from '@finos/legend-graph';
+import type { DataProductDataAccess_LegendApplicationPlugin_Extension } from '../stores/DataProductDataAccess_LegendApplicationPlugin_Extension.js';
+import { isNonNullable } from '@finos/legend-shared';
+
+export const getOrganizationalScopeTypeName = (
+  scope: V1_OrganizationalScope,
+  plugins: DataProductDataAccess_LegendApplicationPlugin_Extension[],
+): string => {
+  if (scope instanceof V1_AppDirOrganizationalScope) {
+    return 'AppDir Node';
+  } else if (scope instanceof V1_AdhocTeam) {
+    return 'Ad-hoc Team';
+  } else if (scope instanceof V1_UnknownOrganizationalScopeType) {
+    return 'Unknown';
+  } else {
+    const typeNames = plugins
+      .flatMap((plugin) =>
+        plugin
+          .getContractConsumerTypeRendererConfigs?.()
+          .flatMap((config) => config.organizationalScopeTypeName?.(scope)),
+      )
+      .filter(isNonNullable);
+
+    return typeNames[0] ?? 'Unknown';
+  }
+};
+
+export const getOrganizationalScopeTypeDetails = (
+  scope: V1_OrganizationalScope,
+  plugins: DataProductDataAccess_LegendApplicationPlugin_Extension[],
+): React.ReactNode => {
+  if (
+    scope instanceof V1_AppDirOrganizationalScope ||
+    scope instanceof V1_AdhocTeam ||
+    scope instanceof V1_UnknownOrganizationalScopeType
+  ) {
+    return undefined;
+  } else {
+    const detailsRenderers = plugins
+      .flatMap((plugin) =>
+        plugin
+          .getContractConsumerTypeRendererConfigs?.()
+          .flatMap((config) => config.organizationalScopeTypeDetailsRenderer),
+      )
+      .filter(isNonNullable);
+    for (const detailsRenderer of detailsRenderers) {
+      const detailsComponent = detailsRenderer(scope);
+      if (detailsComponent) {
+        return detailsComponent;
+      }
+    }
+
+    return undefined;
+  }
+};
+
+export const stringifyOrganizationalScope = (
+  scope: V1_OrganizationalScope,
+): string => {
+  if (scope instanceof V1_AppDirOrganizationalScope) {
+    return scope.appDirNode
+      .map((node) => `${node.level}: ${node.appDirId}`)
+      .join(', ');
+  } else if (scope instanceof V1_AdhocTeam) {
+    return scope.users.map((user) => user.name).join(', ');
+  } else if (scope instanceof V1_UnknownOrganizationalScopeType) {
+    return JSON.stringify(scope.content);
+  }
+  return '';
+};

package/tsconfig.json

@@ -0,0 +1,91 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "nodenext",
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "verbatimModuleSyntax": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/prod.tsbuildinfo",
+    "rootDir": "./src",
+    "jsx": "react-jsx",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolvePackageJsonExports": true,
+    "resolvePackageJsonImports": true,
+    "preserveConstEnums": true,
+    "incremental": true,
+    "useDefineForClassFields": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "strictBuiltinIteratorReturn": true,
+    "alwaysStrict": true,
+    "useUnknownInCatchVariables": true
+  },
+  "references": [
+    {
+      "path": "./tsconfig.package.json"
+    }
+  ],
+  "files": [
+    "./src/index.ts",
+    "./src/__lib__/DSL_DataProduct_Event.ts",
+    "./src/components/__test-utils__/StateTestUtils.ts",
+    "./src/components/__test-utils__/TEST_DATA__LakehouseContractData.ts",
+    "./src/components/__test-utils__/TEST_DATA__LakehouseDataProducts.ts",
+    "./src/stores/BaseLayoutState.ts",
+    "./src/stores/BaseViewerState.ts",
+    "./src/stores/DataProductDataAccess_LegendApplicationPlugin_Extension.ts",
+    "./src/stores/ProductViewerNavigation.ts",
+    "./src/stores/DataProduct/DataProductAPGState.ts",
+    "./src/stores/DataProduct/DataProductDataAccessState.ts",
+    "./src/stores/DataProduct/DataProductViewerState.ts",
+    "./src/stores/DataProduct/EntitlementsDataContractViewerState.ts",
+    "./src/stores/TerminalProduct/TerminalProductViewerState.ts",
+    "./src/utils/DataContractUtils.ts",
+    "./src/utils/LakehouseUtils.ts",
+    "./src/components/Core_DataProductDataAccess_LegendApplicationPlugin.tsx",
+    "./src/components/ProductViewer.tsx",
+    "./src/components/ProductWiki.tsx",
+    "./src/components/DataProduct/DataProductDataAccess.tsx",
+    "./src/components/DataProduct/DataProductSupportInfo.tsx",
+    "./src/components/DataProduct/DataContract/EntitlementsDataContractCreator.tsx",
+    "./src/components/DataProduct/DataContract/EntitlementsDataContractViewer.tsx",
+    "./src/components/DataProduct/Subscriptions/DataProductSubscriptionsViewer.tsx",
+    "./src/components/TerminalProduct/TerminalProductPrice.tsx",
+    "./src/components/UserRenderer/MultiUserRenderer.tsx",
+    "./src/components/UserRenderer/UserRenderer.tsx"
+  ],
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx",
+    "src/**/*.json"
+  ],
+  "exclude": [
+    "src/**/__tests__/**/*.*",
+    "src/**/__mocks__/**/*.*"
+  ]
+}

package/tsconfig.package.json

@@ -0,0 +1,56 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext",
+      "webworker",
+      "scripthost"
+    ],
+    "composite": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "module": "nodenext",
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "verbatimModuleSyntax": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./lib",
+    "tsBuildInfoFile": "./build/package.tsbuildinfo",
+    "rootDir": "./",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolvePackageJsonExports": true,
+    "resolvePackageJsonImports": true,
+    "preserveConstEnums": true,
+    "incremental": true,
+    "useDefineForClassFields": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "strictBuiltinIteratorReturn": true,
+    "alwaysStrict": true,
+    "useUnknownInCatchVariables": true
+  },
+  "files": [
+    "./package.json"
+  ],
+  "include": [
+    "package.json"
+  ],
+  "exclude": [
+    "/home/runner/work/legend-studio/legend-studio/packages/legend-extension-dsl-data-product/lib"
+  ]
+}