All files / src/objects data_definition.ts

98.47% Statements 258/262
80.18% Branches 85/106
100% Functions 19/19
98.47% Lines 258/262

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 253 254 255 256 257 258 259 260 261 262 2631x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 115x 115x 115x 115x 115x 115x 115x 239x 239x 115x 115x 4x 4x 4x 4x 4x 115x 115x 68x 68x 68x 115x 115x 90x 90x 90x 115x 115x 2x 2x 2x 115x 115x 29x 29x 27x 27x 27x 29x 29x 115x 115x 45x 45x 115x 115x 2x 2x 2x 115x 115x 118x 118x 118x 118x 118x 118x 115x 115x 442x 442x 115x 115x 8x 8x 115x 115x 4x 4x 4x 4x 24x 10x 10x 24x 4x 4x 115x 115x 312x 198x 198x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 312x 110x 487x 53x 53x 487x 110x 110x 110x 487x 110x 110x 312x 4x 4x 114x 114x 114x 114x 115x 115x 97x 97x 115x 115x 115x 115x 114x 114x 9x 9x 114x 115x 114x 114x 12x 12x 102x 102x 115x 115x 110x 110x 24x 24x 110x 24x 24x 110x 110x 215x 215x 215x 215x 215x 213x 213x 31x 31x 31x 31x 213x 135x 135x 213x 215x 1x 1x 1x 1x 1x 215x     215x 215x 215x 215x 8x 8x 207x 207x 215x 27x 27x 207x 207x 207x 207x 207x 207x 207x 207x 207x 110x 115x 115x 110x 91x 91x 91x 91x 110x 110x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 18x 110x 110x 17x 17x     17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 110x 115x  
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;
  /** name is the name of the element, nameInSource the name in the prefixed source, if aliased via "as" */
  fields: {key: boolean, name: string, nameInSource?: 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;
  private typeCache: AbstractType | undefined = undefined;
  private typeCacheData: 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();
    if (this.typeCache === undefined || this.typeCacheData !== this.parsedData) {
      this.typeCacheData = this.parsedData;
      this.typeCache = new CDSDetermineTypes().parseType(reg, this.parsedData!, this.getName());
    }
    return this.typeCache;
  }
 
  public getParsedData() {
    return this.parsedData;
  }
 
  public listSources() {
    this.parse();
    return this.parsedData?.sources;
  }
 
  public setDirty(): void {
    this.parsedData = undefined;
    this.typeCache = undefined;
    this.typeCacheData = 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 nameInSource: string | undefined = undefined;
      let found = e.findDirectExpression(CDSAs)?.findDirectExpression(CDSName);
      const list = e.findDirectExpression(CDSPrefixedName)?.findAllExpressions(CDSName);
      if (list !== undefined) {
        const redirected = list.length > 1 && e.concatTokens().toUpperCase().includes(" REDIRECTED TO ");
        if (list.length > 1 && redirected === false) {
          // "prefix.field" is looked up as "field" in "prefix", also when aliased via "as"
          prefix = list[0].concatTokens();
          nameInSource = list[list.length - 1].concatTokens();
        }
        if (found === undefined) {
          found = redirected === true ? list[0] : list[list.length - 1];
        }
      }
      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,
        nameInSource: nameInSource,
        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,
      });
    }
  }
}