@cap-js-community/odata-v2-adapter/src/build.js

OData V2 adapter for CDS

"use strict";

const cds = require("@sap/cds");
const { path } = cds.utils;

const DEFAULT_MAIN_FOLDER = "_main";

module.exports = class COV2APBuildPlugin extends cds.build.Plugin {
  static taskDefaults = { src: "srv" }; // used by build plugin

  static hasTask() {
    cds.env.cov2ap = cds.env.cov2ap || {};
    cds.env.cov2ap.plugin = cds.env.cov2ap.plugin === undefined ? true : cds.env.cov2ap.plugin;
    cds.env.cov2ap.build = cds.env.cov2ap.build === undefined ? true : cds.env.cov2ap.build;
    return cds.env.cov2ap.plugin && cds.env.cov2ap.build;
  }

  async build() {
    const model = await (this.baseModel ? this.baseModel() : this.model());
    if (!model) {
      return;
    }

    // srv
    const srvBuildTask = this.context.tasks.find((task) => ["nodejs", "java"].includes(task.for));
    if (srvBuildTask) {
      this.task.src = srvBuildTask.src;
      const compileDest =
        (srvBuildTask.options && srvBuildTask.options.compileDest) ?? path.join(srvBuildTask.dest, cds.env.folders.srv);
      this.task.dest = path.join(compileDest, "odata/v2");
      await this.generateEdmx(model);

      // mtx/sidecar
      if (cds.env.profiles?.includes("with-mtx-sidecar") || !!cds.env.requires["cds.xt.ModelProviderService"]) {
        const mtxBuildTask = this.context.tasks.find((task) => task.for === "mtx-sidecar");
        if (mtxBuildTask) {
          this.task.src = mtxBuildTask.src;
          const sidecarEnv = cds.env.for("cds", mtxBuildTask.src);
          const modelProviderService = sidecarEnv.requires["cds.xt.ModelProviderService"];
          let main = modelProviderService.root;
          const profiles = cds.env.profiles ?? [];
          if (!profiles.includes("production") && !profiles.includes("prod")) {
            main = DEFAULT_MAIN_FOLDER;
          }
          const mtxSidecarDest = path.join(mtxBuildTask.dest, main, cds.env.folders.srv, "odata/v2");
          await this.copy(this.task.dest).to(mtxSidecarDest);
        }
      }
    }
  }

  async generateEdmx(model) {
    const services = cds.reflect(model).services.filter((service) => this.isServedViaOData(service));
    for (const service of services) {
      if (model.definitions && model.definitions[service.name] && model.definitions[service.name]["@cov2ap.ignore"]) {
        continue;
      }
      try {
        const result = await cds.compile.to.edmx(model, {
          service: service.name,
          version: "v2",
        });
        await this.write(result).to(`${service.name}.xml`);
      } catch (err) {
        this.pushMessage(
          `EDMX V2 compilation failed. Service '${service.name}' is (probably) not compatible with OData V2: ` + err,
          COV2APBuildPlugin.INFO,
        );
      }
    }
  }

  isServedViaOData(service) {
    let protocols = service["@protocol"];
    if (protocols) {
      protocols = !Array.isArray(protocols) ? [protocols] : protocols;
      return protocols.some((protocol) => {
        return (typeof protocol === "string" ? protocol : protocol.kind).startsWith("odata");
      });
    }
    const protocolDirect = Object.keys(cds.env.protocols || {}).find((protocol) => service["@" + protocol]);
    if (protocolDirect) {
      return protocolDirect.startsWith("odata");
    }
    return true;
  }
};