All files / src/objects data_definition.ts

98.41% Statements 248/252
80.58% Branches 83/103
100% Functions 19/19
98.41% Lines 248/252

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 2531x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 92x 92x 92x 92x 92x 176x 176x 92x 92x 2x 2x 2x 2x 2x 92x 92x 53x 53x 53x 92x 92x 73x 73x 73x 92x 92x 2x 2x 2x 92x 92x 21x 21x 21x 92x 92x 27x 27x 92x 92x 2x 2x 2x 92x 92x 93x 93x 93x 93x 92x 92x 345x 345x 92x 92x 5x 5x 92x 92x 2x 2x 2x 2x 15x 7x 7x 15x 2x 2x 92x 92x 245x 154x 154x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 91x 245x 87x 383x 44x 44x 383x 87x 87x 87x 383x 87x 87x 245x 4x 4x 91x 91x 91x 91x 92x 92x 71x 71x 92x 92x 92x 92x 91x 91x 9x 9x 91x 92x 91x 91x 10x 10x 81x 81x 92x 92x 87x 87x 24x 24x 87x 24x 24x 87x 87x 166x 166x 166x 128x 128x 127x 2x 127x 125x 125x 20x 20x 125x 127x 128x 166x 1x 1x 1x 1x 1x 166x     166x 166x 166x 166x 8x 8x 158x 158x 166x 18x 18x 158x 158x 158x 158x 158x 158x 158x 158x 87x 92x 92x 87x 65x 65x 65x 65x 87x 87x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 87x 87x 17x 17x     17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 87x 92x  
import {ExpressionNode} from "../abap/nodes";
import {AbstractType} from "../abap/types/basic/_abstract_type";
import {CDSDetermineTypes} from "../cds/cds_determine_types";
import {CDSParser} from "../cds/cds_parser";
import {CDSAnnotate, CDSAnnotation, CDSAs, CDSAssociation, CDSDefineProjection, CDSElement, CDSName, CDSPrefixedName, CDSRelation, CDSSelect, CDSSource} from "../cds/expressions";
import {IRegistry} from "../_iregistry";
import {AbstractObject} from "./_abstract_object";
import {IParseResult} from "./_iobject";
 
export type ParsedDataDefinition = {
  sqlViewName: string | undefined;
  definitionName: string | undefined;
  description: string | undefined;
  fields: {key: boolean, name: string, prefix: string, annotations: string[]}[];
  sources: {name: string, as: string | undefined}[];
  associations: {name: string, as: string | undefined}[],
  relations: {name: string, as: string | undefined}[];
  tree: ExpressionNode | undefined;
};
 
export class DataDefinition extends AbstractObject {
  private parserError: boolean | undefined = undefined;
  private parsedData: ParsedDataDefinition | undefined = undefined;
 
  public getType(): string {
    return "DDLS";
  }
 
  public getAllowedNaming() {
    return {
      maxLength: 40,
      allowNamespace: true,
    };
  }
 
  public getSQLViewName(): string | undefined {
    this.parse();
    return this.parsedData?.sqlViewName;
  }
 
  public getDefinitionName(): string | undefined {
    this.parse();
    return this.parsedData?.definitionName;
  }
 
  public getDescription(): string | undefined {
    this.parse();
    return this.parsedData?.description;
  }
 
  public parseType(reg: IRegistry): AbstractType {
    this.parse();
    return new CDSDetermineTypes().parseType(reg, this.parsedData!, this.getName());
  }
 
  public getParsedData() {
    return this.parsedData;
  }
 
  public listSources() {
    this.parse();
    return this.parsedData?.sources;
  }
 
  public setDirty(): void {
    this.parsedData = undefined;
    this.parserError = undefined;
    super.setDirty();
  }
 
  public findSourceFile() {
    return this.getFiles().find(f => f.getFilename().endsWith(".asddls") || f.getFilename().endsWith(".acds"));
  }
 
  public hasParserError() {
    return this.parserError;
  }
 
  public listKeys(): string[] {
    this.parse();
 
    const ret: string[] = [];
    for (const field of this.parsedData?.fields || []) {
      if (field.key === true) {
        ret.push(field.name);
      }
    }
    return ret;
  }
 
  public parse(): IParseResult {
    if (this.isDirty() === false) {
      return {updated: false, runtime: 0};
    }
 
    const start = Date.now();
 
    this.parsedData = {
      sqlViewName: undefined,
      definitionName: undefined,
      description: this.findDescription(),
      fields: [],
      sources: [],
      relations: [],
      associations: [],
      tree: undefined,
    };
 
    this.findSQLViewName();
 
    this.parsedData.tree = new CDSParser().parse(this.findSourceFile());
    if (this.parsedData.tree) {
      for (const c of this.parsedData.tree?.getChildren() || []) {
        if (c.get() instanceof CDSAnnotation) {
          continue;
        }
        if (c instanceof ExpressionNode) {
          this.parsedData.definitionName = c.findFirstExpression(CDSName)?.concatTokens().replace(/ /g, "");
          break;
        }
      }
      this.findSourcesAndRelations(this.parsedData.tree);
      this.findFieldNames(this.parsedData.tree);
    } else {
      this.parserError = true;
    }
 
    this.dirty = false;
    return {updated: true, runtime: Date.now() - start};
  }
 
  public getTree() {
    return this.parsedData?.tree;
  }
 
//////////
 
  private findSQLViewName(): void {
    const match = this.findSourceFile()?.getRaw().match(/@AbapCatalog\.sqlViewName: '([\w/]+)'/);
    if (match) {
      this.parsedData!.sqlViewName = match[1].toUpperCase();
    }
  }
  private findDescription(): string | undefined {
    const match = this.findSourceFile()?.getRaw().match(/@EndUserText\.label: '([\w,.:-=#%&() ]+)'/);
    if (match) {
      return match[1];
    }
    return undefined;
  }
 
  private findFieldNames(tree: ExpressionNode) {
    let expr = tree.findFirstExpression(CDSSelect);
    if (expr === undefined) {
      expr = tree.findFirstExpression(CDSAnnotate);
    }
    if (expr === undefined) {
      expr = tree.findFirstExpression(CDSDefineProjection);
    }
 
    for (const e of expr?.findDirectExpressions(CDSElement) || []) {
      let prefix = "";
      let found = e.findDirectExpression(CDSAs)?.findDirectExpression(CDSName);
      if (found === undefined) {
        const list = e.findDirectExpression(CDSPrefixedName)?.findAllExpressions(CDSName);
        if (list) {
          if (e.concatTokens().toUpperCase().includes(" REDIRECTED TO ")) {
            found = list[0];
          } else {
            found = list[list.length - 1];
            if (list.length > 1) {
              prefix = list[0].concatTokens();
            }
          }
        }
      }
      if (found === undefined) {
        // typed virtual element: VIRTUAL <name> : <type>
        if (e.findDirectTokenByText("VIRTUAL") !== undefined) {
          found = e.findFirstExpression(CDSName);
        }
      }
      if (found === undefined) {
        continue;
      }
 
      const name = found?.concatTokens();
      if (this.parsedData?.associations.some(a =>
        a.name.toUpperCase() === name.toUpperCase() || a.as?.toUpperCase() === name.toUpperCase())) {
        continue;
      }
 
      const annotations: string[] = [];
      for (const a of e.findDirectExpressions(CDSAnnotation)) {
        annotations.push(a.concatTokens());
      }
 
      this.parsedData!.fields.push({
        name: name,
        annotations: annotations,
        prefix: prefix,
        key: e.findDirectTokenByText("KEY") !== undefined,
      });
    }
  }
 
  private findSourcesAndRelations(tree: ExpressionNode) {
    for (const e of tree.findAllExpressions(CDSSource)) {
      const name = e.getFirstChild()?.concatTokens().toUpperCase().replace(/ /g, "") || "ERROR";
      const as = e.findDirectExpression(CDSAs)?.findDirectExpression(CDSName)?.concatTokens().toUpperCase();
      this.parsedData!.sources.push({name, as});
    }
 
    for (const e of tree.findAllExpressions(CDSRelation)) {
      // For namespace-prefixed names like /PF1/C_VH_TRANSTYPE, getFirstToken() only yields "/".
      // Collect all tokens NOT part of the CDSAs child to reconstruct the full name.
      const asNode = e.findDirectExpression(CDSAs);
      const asTokenSet = new Set(
        asNode ? asNode.getTokens().map(t => `${t.getStart().getRow()}:${t.getStart().getCol()}`) : [],
      );
      const name = e.getTokens()
        .filter(t => !asTokenSet.has(`${t.getStart().getRow()}:${t.getStart().getCol()}`))
        .map(t => t.getStr())
        .join("") || "ERROR";
      const as = asNode?.findDirectExpression(CDSName)?.getFirstToken().getStr();
      this.parsedData!.relations.push({name, as});
    }
 
    for (const e of tree.findAllExpressions(CDSAssociation)) {
      const j = e.findDirectExpression(CDSRelation);
      if (j === undefined) {
        continue;
      }
      // CDSRelation: seq(opt(/NS/), entityName, opt(CDSAs))
      // For namespace-prefixed names like /PF1/C_VH_TRANSTYPE, getFirstToken() only yields "/"
      // Collect all tokens that are NOT part of the CDSAs child to reconstruct the full name
      const asNode = j.findDirectExpression(CDSAs);
      const asTokenSet = new Set(
        asNode ? asNode.getTokens().map(t => `${t.getStart().getRow()}:${t.getStart().getCol()}`) : [],
      );
      const name = j.getTokens()
        .filter(t => !asTokenSet.has(`${t.getStart().getRow()}:${t.getStart().getCol()}`))
        .map(t => t.getStr())
        .join("") || "ERROR";
      const as = asNode?.findDirectExpression(CDSName)?.getFirstToken().getStr();
      this.parsedData!.associations.push({
        name: name,
        as: as,
      });
    }
  }
}