@finos/legend-studio
Version:
191 lines • 10.2 kB
JavaScript
/**
* 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 { EditorState } from '../editor-state/EditorState.js';
import { action, computed, flow, observable, makeObservable, flowResult, } from 'mobx';
import { LogEvent, assertErrorThrown, guaranteeNonNullable, } from '@finos/legend-shared';
import { ProjectStructureVersion, UpdateProjectConfigurationCommand, } from '@finos/legend-server-sdlc';
import { LEGEND_STUDIO_APP_EVENT } from '../LegendStudioAppEvent.js';
import { MASTER_SNAPSHOT_ALIAS, ProjectData } from '@finos/legend-server-depot';
export var CONFIGURATION_EDITOR_TAB;
(function (CONFIGURATION_EDITOR_TAB) {
CONFIGURATION_EDITOR_TAB["PROJECT_STRUCTURE"] = "PROJECT_STRUCTURE";
CONFIGURATION_EDITOR_TAB["PROJECT_DEPENDENCIES"] = "PROJECT_DEPENDENCIES";
})(CONFIGURATION_EDITOR_TAB = CONFIGURATION_EDITOR_TAB || (CONFIGURATION_EDITOR_TAB = {}));
export class ProjectConfigurationEditorState extends EditorState {
sdlcState;
originalProjectConfiguration; // TODO: we might want to remove this when we do change detection for project configuration
projectConfiguration;
selectedTab;
isReadOnly = false;
projects = new Map();
queryHistory = new Set();
latestProjectStructureVersion;
isUpdatingConfiguration = false;
isQueryingProjects = false;
associatedProjectsAndVersionsFetched = false;
isFetchingAssociatedProjectsAndVersions = false;
constructor(editorStore, sdlcState) {
super(editorStore);
makeObservable(this, {
originalProjectConfiguration: observable,
isUpdatingConfiguration: observable,
projectConfiguration: observable,
selectedTab: observable,
isReadOnly: observable,
projects: observable,
queryHistory: observable,
isQueryingProjects: observable,
associatedProjectsAndVersionsFetched: observable,
isFetchingAssociatedProjectsAndVersions: observable,
latestProjectStructureVersion: observable,
originalConfig: computed,
setOriginalProjectConfiguration: action,
setProjectConfiguration: action,
setSelectedTab: action,
fectchAssociatedProjectsAndVersions: flow,
updateProjectConfiguration: flow,
updateToLatestStructure: flow,
updateConfigs: flow,
fetchLatestProjectStructureVersion: flow,
});
this.selectedTab = CONFIGURATION_EDITOR_TAB.PROJECT_STRUCTURE;
this.isReadOnly = editorStore.isInViewerMode;
this.sdlcState = sdlcState;
}
setOriginalProjectConfiguration(projectConfiguration) {
this.originalProjectConfiguration = projectConfiguration;
}
setProjectConfiguration(projectConfiguration) {
this.projectConfiguration = projectConfiguration;
}
setSelectedTab(tab) {
this.selectedTab = tab;
}
get headerName() {
return 'config';
}
get currentProjectConfiguration() {
return guaranteeNonNullable(this.projectConfiguration, 'Project configuration must exist');
}
get originalConfig() {
return guaranteeNonNullable(this.originalProjectConfiguration, 'Original project configuration is not set');
}
get containsSnapshotDependencies() {
return Boolean(this.originalProjectConfiguration?.projectDependencies.some((dependency) => dependency.versionId === MASTER_SNAPSHOT_ALIAS));
}
*fectchAssociatedProjectsAndVersions() {
this.isFetchingAssociatedProjectsAndVersions = true;
try {
(yield this.editorStore.depotServerClient.getProjects())
.map((v) => ProjectData.serialization.fromJson(v))
// filter out non versioned projects
.filter((p) => Boolean(p.versions.length))
.forEach((project) => this.projects.set(project.coordinates, project));
// Update the legacy dependency to newer format (using group ID and artifact ID instead of just project ID)
this.projectConfiguration?.projectDependencies.forEach((dependency) => {
if (!dependency.isLegacyDependency) {
return;
}
const project = Array.from(this.projects.values()).find((e) => e.projectId === dependency.projectId);
// re-write to new format
if (project) {
dependency.setProjectId(project.coordinates);
}
});
this.associatedProjectsAndVersionsFetched = true;
}
catch (error) {
assertErrorThrown(error);
this.editorStore.applicationStore.log.error(LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE), error);
this.editorStore.applicationStore.notifyError(`Can't get project dependencies data. Error:\n${error.message}`);
}
finally {
this.isFetchingAssociatedProjectsAndVersions = false;
}
}
*updateProjectConfiguration(updateConfigurationCommand) {
try {
this.isUpdatingConfiguration = true;
yield this.editorStore.sdlcServerClient.updateConfiguration(this.editorStore.sdlcState.activeProject.projectId, this.editorStore.sdlcState.activeWorkspace, UpdateProjectConfigurationCommand.serialization.toJson(updateConfigurationCommand));
this.editorStore.reset();
// reset editor
yield flowResult(this.editorStore.sdlcState.fetchCurrentWorkspace(this.editorStore.sdlcState.activeProject.projectId, this.editorStore.sdlcState.activeWorkspace.workspaceId, this.editorStore.sdlcState.activeWorkspace.workspaceType));
yield flowResult(this.sdlcState.fetchCurrentRevision(this.editorStore.sdlcState.activeProject.projectId, this.editorStore.sdlcState.activeWorkspace));
yield flowResult(this.editorStore.initMode());
this.editorStore.openSingletonEditorState(this.editorStore.projectConfigurationEditorState);
}
catch (error) {
assertErrorThrown(error);
this.editorStore.applicationStore.log.error(LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE), error);
this.editorStore.applicationStore.notifyError(error);
}
finally {
this.isUpdatingConfiguration = false;
}
}
*updateToLatestStructure() {
if (this.latestProjectStructureVersion) {
try {
const updateCommand = new UpdateProjectConfigurationCommand(this.currentProjectConfiguration.groupId, this.currentProjectConfiguration.artifactId, this.latestProjectStructureVersion, `update project configuration from ${this.editorStore.applicationStore.config.appName}`);
yield flowResult(this.updateProjectConfiguration(updateCommand));
}
catch (error) {
assertErrorThrown(error);
this.editorStore.applicationStore.log.error(LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE), error);
this.editorStore.applicationStore.notifyError(error);
}
}
}
// TODO: we will probably need to remove this in the future when we have a better strategy for change detection and persistence of project config
// See https://github.com/finos/legend-studio/issues/952
*updateConfigs() {
this.isUpdatingConfiguration = true;
this.editorStore.setBlockingAlert({
message: `Updating project configuration...`,
prompt: `Please do not reload the application`,
showLoading: true,
});
try {
const updateProjectConfigurationCommand = new UpdateProjectConfigurationCommand(this.currentProjectConfiguration.groupId, this.currentProjectConfiguration.artifactId, this.currentProjectConfiguration.projectStructureVersion, `update project configuration from ${this.editorStore.applicationStore.config.appName}`);
updateProjectConfigurationCommand.projectDependenciesToAdd =
this.currentProjectConfiguration.projectDependencies.filter((dep) => !this.originalConfig.projectDependencies.find((originalProjDep) => originalProjDep.hashCode === dep.hashCode));
updateProjectConfigurationCommand.projectDependenciesToRemove =
this.originalConfig.projectDependencies.filter((originalProjDep) => !this.currentProjectConfiguration.projectDependencies.find((dep) => dep.hashCode === originalProjDep.hashCode));
yield flowResult(this.updateProjectConfiguration(updateProjectConfigurationCommand));
}
catch (error) {
assertErrorThrown(error);
this.editorStore.applicationStore.log.error(LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE), error);
this.editorStore.applicationStore.notifyError(error);
}
finally {
this.isUpdatingConfiguration = false;
this.editorStore.setBlockingAlert(undefined);
}
}
*fetchLatestProjectStructureVersion() {
try {
this.latestProjectStructureVersion =
ProjectStructureVersion.serialization.fromJson((yield this.editorStore.sdlcServerClient.getLatestProjectStructureVersion()));
}
catch (error) {
assertErrorThrown(error);
this.editorStore.applicationStore.log.error(LogEvent.create(LEGEND_STUDIO_APP_EVENT.SDLC_MANAGER_FAILURE), error);
this.editorStore.applicationStore.notifyError(error);
}
}
}
//# sourceMappingURL=ProjectConfigurationEditorState.js.map