@finos/legend-server-sdlc/src/models/configuration/ProjectConfiguration.ts

Legend SDLC server client

/**
 * 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 {
  list,
  createModelSchema,
  primitive,
  optional,
  custom,
  SKIP,
} from 'serializr';
import { observable, action, computed, makeObservable } from 'mobx';
import { ProjectStructureVersion } from '../configuration/ProjectStructureVersion.js';
import { ProjectDependency } from '../configuration/ProjectDependency.js';
import {
  type Hashable,
  hashArray,
  addUniqueEntry,
  deleteEntry,
  SerializationFactory,
  usingModelSchema,
  optionalCustomListWithSchema,
} from '@finos/legend-shared';
import { ENTITY_PATH_DELIMITER } from '@finos/legend-storage';
import { PlatformConfiguration } from './PlatformConfiguration.js';
import { SDLC_HASH_STRUCTURE } from '../../SDLC_HashUtils.js';

/**
 * Embedded Mode enables user to manage their pipeline/build and deployment flow.
 * This will disable releasing and platform version configuration.
 * Additionally, the concept of extension version will not be applicable when dealing with project structure version.
 */
export enum ProjectType {
  MANAGED = 'MANAGED',
  EMBEDDED = 'EMBEDDED',
}

export class ProjectConfiguration implements Hashable {
  projectId!: string;
  groupId!: string;
  artifactId!: string;
  projectType: ProjectType | undefined;
  projectStructureVersion!: ProjectStructureVersion;
  platformConfigurations?: PlatformConfiguration[] | undefined;
  projectDependencies: ProjectDependency[] = [];
  runDependencyTests?: boolean | undefined;

  constructor() {
    makeObservable(this, {
      groupId: observable,
      artifactId: observable,
      projectStructureVersion: observable,
      platformConfigurations: observable,
      projectDependencies: observable,
      runDependencyTests: observable,
      setGroupId: action,
      setPlatformConfigurations: action,
      setArtifactId: action,
      deleteProjectDependency: action,
      addProjectDependency: action,
      setRunDependencyTests: action,
      dependencyKey: computed,
      hashCode: computed,
    });
  }

  static readonly serialization = new SerializationFactory(
    createModelSchema(ProjectConfiguration, {
      artifactId: primitive(),
      groupId: primitive(),
      platformConfigurations: optionalCustomListWithSchema(
        PlatformConfiguration.serialization.schema,
      ),
      projectDependencies: list(
        usingModelSchema(ProjectDependency.serialization.schema),
      ),
      projectId: primitive(),
      projectType: optional(primitive()),
      projectStructureVersion: usingModelSchema(
        ProjectStructureVersion.serialization.schema,
      ),
      runDependencyTests: custom(
        () => SKIP,
        (value: boolean | null | undefined) => (value ? value : SKIP),
      ),
    }),
  );

  setRunDependencyTests(val: boolean | undefined): void {
    this.runDependencyTests = val;
  }

  setGroupId(val: string): void {
    this.groupId = val;
  }

  setPlatformConfigurations(val: PlatformConfiguration[] | undefined): void {
    this.platformConfigurations = val;
  }

  setArtifactId(val: string): void {
    this.artifactId = val;
  }

  deleteProjectDependency(val: ProjectDependency): void {
    deleteEntry(this.projectDependencies, val);
  }

  addProjectDependency(val: ProjectDependency): void {
    addUniqueEntry(this.projectDependencies, val);
  }

  get dependencyKey(): string {
    return `${this.groupId.replace(
      /\./g,
      ENTITY_PATH_DELIMITER,
    )}${ENTITY_PATH_DELIMITER}${this.artifactId}`;
  }

  get hashCode(): string {
    return hashArray([
      SDLC_HASH_STRUCTURE.PROJECT_CONFIGURATION,
      this.groupId,
      this.artifactId,
      hashArray(this.platformConfigurations ?? []),
      this.projectStructureVersion.version.toString(),
      this.projectStructureVersion.extensionVersion?.toString() ?? '',
      hashArray(this.projectDependencies),
      this.runDependencyTests?.toString() ?? '',
    ]);
  }
}