Updated datamodel grammar so edition is a single number (major version)

Updated version util to only update on major version update
Added stability checks and refactored logging in datamodel manager
Moved datamodel version check to validations.
Fixed issue in serializer to properly handle 0 numeric values

Author: harmen-xb

examples/mapping-example/ExampleDWH/datamodel.cm

@@ -4,6 +4,9 @@ datamodel:
     description: "Example Data Warehouse Logical Data Model"
     type: logical
     version: 1.0.0
+    crossmodel:
+        edition: core
+        version: 0
     dependencies:
       - datamodel: ExampleCRM
         version: 1.0.0

examples/mapping-example/ExampleOtherModel/datamodel.cm

@@ -1,4 +1,7 @@
 datamodel:
     id: ExampleOtherModel
     name: "Example Other Model"
-    type: logical
+    type: logical
+    crossmodel:
+        edition: core
+        version: 0

examples/mapping-example/Sources/ExampleCRM/datamodel.cm

@@ -2,4 +2,7 @@ datamodel:
     id: ExampleCRM
     name: "Example CRM"
     type: logical
-    version: 1.0.0
+    version: 1.0.0
+    crossmodel:
+        edition: core
+        version: 0

examples/mapping-example/Sources/ExampleMasterdata/datamodel.cm

@@ -2,4 +2,7 @@ datamodel:
     id: ExampleMasterdata
     name: "Example Masterdata"
     type: logical
-    version: 1.0.0
+    version: 1.0.0
+    crossmodel:
+        edition: core
+        version: 0

packages/core/src/browser/new-element-contribution.ts

@@ -16,7 +16,7 @@ import {
    TargetObjectType,
    findNextUnique,
    getCrossModelEdition,
-   getCrossModelVersion,
+   getCrossModelMajorVersion,
    isMemberPermittedInModel,
    quote,
    toId,
@@ -64,14 +64,20 @@ interface NewElementTemplate<T extends readonly InputOptions[] = readonly InputO
  * The version is read from CROSSMODEL_VERSION constant which is sourced from package.json.
  */
 function getInitialDataModelContent(): string {
+   const edition = getCrossModelEdition();
+   const majorVersion = getCrossModelMajorVersion();
+   const crossmodelBlock =
+      edition !== undefined && majorVersion !== undefined
+         ? `
+    crossmodel:
+        edition: ${edition}
+        version: ${majorVersion}`
+         : '';
    return `datamodel:
     id: _
     name: ""
     type: ${DataModelTypeInfos.logical.value}
-    version: 1.0.0
-    crossmodel:
-        edition: ${getCrossModelEdition()}
-        version: ${getCrossModelVersion()}
+    version: 1.0.0${crossmodelBlock}
 `;
 }
 

packages/protocol/src/model-service/protocol.ts

@@ -272,12 +272,20 @@ export interface RelationshipEdge extends CrossModelElement, IdentifiedObject, W
    targetNode: Reference<EntityNode>;
 }
 
+export const CrossModelEditionInfoType = 'CrossModelEditionInfo';
+export interface CrossModelEditionInfo extends CrossModelElement {
+   readonly $type: typeof CrossModelEditionInfoType;
+   edition: string;
+   version: number;
+}
+
 export const DataModelType = 'DataModel';
 export type DataModelType = 'conceptual' | 'logical' | 'relational';
 export interface DataModel extends CrossModelElement, NamedObject, WithCustomProperties {
    readonly $type: typeof DataModelType;
    type: DataModelType;
    version?: string;
+   crossmodel?: CrossModelEditionInfo;
    dependencies: Array<DataModelDependency>;
 }
 

packages/protocol/src/version.ts

@@ -63,3 +63,15 @@ export function getCrossModelVersion(): string {
 export function getCrossModelEdition(): string {
    return getEditionFromPackage();
 }
+
+/**
+ * Returns the major version component of the CrossModel version as a number.
+ * Minor and patch versions don't cause breaking grammar changes, so only the major version
+ * is stored in datamodel.cm files for migration detection.
+ *
+ * @returns the major version number, or undefined if it cannot be parsed
+ */
+export function getCrossModelMajorVersion(): number | undefined {
+   const version = getVersionFromPackage();
+   return parseInt(version.split('.')[0], 10);
+}

packages/server/src/language-server/cross-model-datamodel-manager.ts

@@ -7,7 +7,6 @@ import { Disposable, DocumentState, LangiumDocument, MultiMap, UriUtils } from '
 import * as protocol from '@crossmodel/protocol';
 import { CancellationToken, WorkspaceFolder } from 'vscode-languageserver';
 import { URI } from 'vscode-uri';
-import { needsCrossModelVersionUpdate, updateCrossModelVersion } from './util/crossmodel-version-util.js';
 import { CrossModelLangiumDocuments } from './cross-model-langium-documents.js';
 import { CrossModelSharedServices } from './cross-model-module.js';
 import { QUALIFIED_ID_SEPARATOR } from './cross-model-naming.js';
@@ -126,10 +125,15 @@ export class CrossModelDataModelManager {
       const content = await this.fileSystemProvider.readDirectory(folderPath);
       await Promise.all(
          content.map(async entry => {
-            if (entry.isDirectory) {
-               await this.initializeDataModels(entry.uri);
-            } else if (entry.isFile && isDataModelUri(entry.uri)) {
-               await this.updateDataModel(entry.uri);
+            try {
+               if (entry.isDirectory) {
+                  await this.initializeDataModels(entry.uri);
+               } else if (entry.isFile && isDataModelUri(entry.uri)) {
+                  await this.updateDataModel(entry.uri);
+               }
+            } catch (error) {
+               const path = this.shared.workspace.WorkspaceManager.wsRelativePath(entry.uri);
+               this.logger.error(`[DataModel] Failed to initialize data model at ${path}: ${error}`);
             }
          })
       );
@@ -290,23 +294,13 @@ export class CrossModelDataModelManager {
 
    // Updates (or adds) the data model for the given URI. Returns the IDs of data models that were added/updated.
    protected async updateDataModel(uri: URI): Promise<string[]> {
-      let newDataModel = await parseDataModelFile(uri, this.langiumDocuments);
+      const wsRelPath = this.shared.workspace.WorkspaceManager.wsRelativePath(uri);
+      const newDataModel = await parseDataModelFile(uri, this.langiumDocuments, this.logger);
       if (!newDataModel) {
+         this.logger.error(`[DataModel] Failed to parse data model at ${wsRelPath}`);
          return [];
       }
 
-      // Ensure CrossModel version/edition is current on load
-      if (needsCrossModelVersionUpdate(newDataModel)) {
-         updateCrossModelVersion(newDataModel);
-         // Serialize the updated AST and persist to disk
-         const document = await this.langiumDocuments.getOrCreateDocument(uri);
-         const serializer = this.shared.ServiceRegistry.getServices(uri).serializer.Serializer;
-         const text = serializer.serialize(document.parseResult.value);
-         await this.shared.workspace.TextDocumentManager.save(uri.toString(), text, 'datamodel-manager');
-         // Re-parse so in-memory document matches updated disk content
-         newDataModel = (await parseDataModelFile(uri, this.langiumDocuments)) ?? newDataModel;
-      }
-
       const toUpdate = [];
       const existingDataModelInfo = this.uriToDataModel.get(uri.toString());
       const newDataModelId = createDataModelId(newDataModel.id, newDataModel.version);
@@ -368,19 +362,25 @@ function getAndRemoveDataModelUris(uris: URI[]): URI[] {
    return dataModels;
 }
 
-async function parseDataModelFile(uri?: URI, langiumDocuments?: CrossModelLangiumDocuments): Promise<DataModel | undefined> {
+async function parseDataModelFile(
+   uri?: URI,
+   langiumDocuments?: CrossModelLangiumDocuments,
+   logger?: { error(message: string): void }
+): Promise<DataModel | undefined> {
    if (!uri || !langiumDocuments) {
       return undefined;
    }
    try {
       const document = await langiumDocuments.updateOrCreateDocument(uri);
       if (document.parseResult.lexerErrors.length > 0 || document.parseResult.parserErrors.length > 0) {
-         console.error('Parse errors in datamodel file:', document.parseResult.lexerErrors, document.parseResult.parserErrors);
+         const msg = `[DataModel] Parse errors in ${uri.fsPath}`;
+         logger ? logger.error(msg) : console.error(msg);
          return undefined;
       }
       return findDataModel(document);
    } catch (error) {
-      console.error('Failed to parse datamodel file:', error);
+      const msg = `[DataModel] Failed to parse ${uri.fsPath}: ${error}`;
+      logger ? logger.error(msg) : console.error(msg);
       return undefined;
    }
 }

packages/server/src/language-server/cross-model-serializer.ts

@@ -109,7 +109,7 @@ export class CrossModelSerializer implements Serializer<CrossModelRoot> {
                // arrays and objects start on a new line -- skip some objects that we do not actually serialize in object structure
                const onNewLine = Array.isArray(propValue) || (isAstNode(propValue) && !isInlineSerializedType(propValue.$type));
                const serializedPropValue = this.toYaml(value, prop, propValue, onNewLine ? indentationLevel + 1 : 0);
-               if (!serializedPropValue) {
+               if (serializedPropValue === undefined || serializedPropValue === '') {
                   return undefined;
                }
                const separator = onNewLine ? CrossModelSerializer.CHAR_NEWLINE : ' ';

packages/server/src/language-server/cross-model-validator.ts

@@ -19,6 +19,7 @@ import {
    AttributeMappingExpression,
    BinaryExpression,
    CrossModelAstType,
+   DataModel,
    IdentifiedObject,
    InheritanceEdge,
    isCrossModelRoot,
@@ -40,6 +41,7 @@ import {
    TargetObjectAttribute
 } from './generated/ast.js';
 import { findDocument, getOwner, isSemanticRoot } from './util/ast-util.js';
+import { isMissingCrossModelVersion, needsCrossModelMigration } from './util/crossmodel-version-util.js';
 import { getAttributeMappingExpressionRefRange } from './util/expression-range.js';
 
 export interface FilenameNotMatchingDiagnostic extends Diagnostic {
@@ -63,6 +65,7 @@ export function registerValidationChecks(services: CrossModelServices): void {
 
    const checks: ValidationChecks<CrossModelAstType> = {
       AstNode: validator.checkNode,
+      DataModel: validator.checkDataModel,
       IdentifiedObject: validator.checkIdentifiedObject,
       AttributeMapping: validator.checkAttributeMapping,
       LogicalAttribute: validator.checkLogicalAttribute,
@@ -87,6 +90,14 @@ export function registerValidationChecks(services: CrossModelServices): void {
 export class CrossModelValidator {
    constructor(protected services: CrossModelServices) {}
 
+   checkDataModel(dataModel: DataModel, accept: ValidationAcceptor): void {
+      if (isMissingCrossModelVersion(dataModel)) {
+         accept('warning', 'This data model is missing a CrossModel version and needs migration.', { node: dataModel });
+      } else if (needsCrossModelMigration(dataModel)) {
+         accept('error', 'This data model was created with a different CrossModel version and needs migration.', { node: dataModel });
+      }
+   }
+
    checkNamedObject(namedObject: NamedObject, accept: ValidationAcceptor): void {
       if (namedObject.name === undefined || namedObject.name.length === 0) {
          accept('error', 'The name cannot be empty', {