developtools_ace-ets2bundle/compiler/main.js

/*
 * Copyright (c) 2020 Huawei Device Co., Ltd.
 * 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.
 */

const fs = require('fs');
const path = require('path');
const md5 = require('md5');

const { readFile } = require('./lib/utils');
const { WORKERS_DIR } = require('./lib/pre_define');

const {
  configure,
  getLogger
} = require('log4js');

configure({
  appenders: { 'ETS': {type: 'stderr', layout: {type: 'messagePassThrough'}}},
  categories: {'default': {appenders: ['ETS'], level: 'info'}}
});
const logger = getLogger('ETS');

const staticPreviewPage = process.env.aceStaticPreview;
const aceCompileMode = process.env.aceCompileMode || 'page';
const abilityConfig = {
  abilityType: process.env.abilityType || 'page',
  abilityEntryFile: null,
  projectAbilityPath: [],
  testRunnerFile: []
};
const projectConfig = {};
const resources = {
  app: {},
  sys: {}
};

function initProjectConfig(projectConfig) {
  projectConfig.entryObj = {};
  projectConfig.projectPath = projectConfig.projectPath || process.env.aceModuleRoot ||
    path.join(process.cwd(), 'sample');
  projectConfig.buildPath = projectConfig.buildPath || process.env.aceModuleBuild ||
    path.resolve(projectConfig.projectPath, 'build');
  projectConfig.manifestFilePath = projectConfig.manifestFilePath || process.env.aceManifestPath ||
    path.join(projectConfig.projectPath, 'manifest.json');
  projectConfig.aceProfilePath = projectConfig.aceProfilePath || process.env.aceProfilePath;
  projectConfig.aceModuleJsonPath = projectConfig.aceModuleJsonPath || process.env.aceModuleJsonPath;
  projectConfig.aceSuperVisualPath = projectConfig.aceSuperVisualPath ||
    process.env.aceSuperVisualPath
  projectConfig.hashProjectPath = projectConfig.hashProjectPath ||
    hashProjectPath(projectConfig.projectPath)
  projectConfig.aceBuildJson = projectConfig.aceBuildJson || process.env.aceBuildJson;
  projectConfig.cachePath = projectConfig.cachePath || process.env.cachePath ||
    path.resolve(__dirname, 'node_modules/.cache');
  projectConfig.aceSoPath = projectConfig.aceSoPath || process.env.aceSoPath;
}

function loadEntryObj(projectConfig) {
  let manifest = {};
  initProjectConfig(projectConfig);
  if (process.env.aceManifestPath && aceCompileMode === 'page') {
    setEntryFile(projectConfig);
    setFaTestRunnerFile(projectConfig);
  }
  if (process.env.aceModuleJsonPath) {
    setAbilityPages(projectConfig);
    setStageTestRunnerFile(projectConfig);
  }

  if(staticPreviewPage) {
    projectConfig.entryObj['./' + staticPreviewPage] = projectConfig.projectPath + path.sep +
      staticPreviewPage + '.ets?entry';
  } else if (abilityConfig.abilityType === 'page') {
    if (fs.existsSync(projectConfig.manifestFilePath)) {
      const jsonString = fs.readFileSync(projectConfig.manifestFilePath).toString();
      manifest = JSON.parse(jsonString);
      projectConfig.pagesJsonFileName = 'config.json';
    } else if (projectConfig.aceModuleJsonPath && fs.existsSync(projectConfig.aceModuleJsonPath)) {
      process.env.compileMode = 'moduleJson';
      buildManifest(manifest, projectConfig.aceModuleJsonPath);
    } else {
      throw Error('\u001b[31m ERROR: the manifest file ' + projectConfig.manifestFilePath +
        ' or module.json is lost or format is invalid. \u001b[39m').message;
    }
    if (manifest.pages) {
      const pages = manifest.pages;
      pages.forEach((element) => {
        const sourcePath = element.replace(/^\.\/ets\//, '');
        const fileName = projectConfig.projectPath + path.sep + sourcePath + '.ets';
        if (fs.existsSync(fileName)) {
          projectConfig.entryObj['./' + sourcePath] = fileName + '?entry';
        } else {
          throw Error(`\u001b[31m ERROR: page '${fileName}' does not exist. \u001b[39m`).message;
        }
      });
    } else {
      throw Error('\u001b[31m ERROR: missing pages attribute in ' + projectConfig.manifestFilePath +
        '. \u001b[39m').message;
    }
  }
}

function buildManifest(manifest, aceConfigPath) {
  try {
    const moduleConfigJson =  JSON.parse(fs.readFileSync(aceConfigPath).toString());
    manifest.type = process.env.abilityType;
    if (moduleConfigJson.module && moduleConfigJson.module.uiSyntax === 'ets') {
      manifest.pages = getPages(moduleConfigJson);
    } else {
      throw Error('\u001b[31m'+
        'EERROR: the config.json file miss key word module || module[abilities].' +
        '\u001b[39m').message;
    }
  } catch (e) {
    throw Error("\x1B[31m" + 'ERROR: the module.json file is lost or format is invalid.' +
      "\x1B[39m").message;
  }
}

function getPages(configJson) {
  const pages = []
  const pagesJsonFileName = `${configJson.module.pages.replace(/\$profile\:/, '')}.json`;
  const modulePagePath = path.resolve(projectConfig.aceProfilePath, pagesJsonFileName);
  if (fs.existsSync(modulePagePath)) {
    const pagesConfig = JSON.parse(fs.readFileSync(modulePagePath, 'utf-8'));
    if (pagesConfig && pagesConfig.src) {
      projectConfig.pagesJsonFileName = pagesJsonFileName;
      return pagesConfig.src;
    }
  }
  return pages;
}

function setEntryFile(projectConfig) {
  const entryFileName = abilityConfig.abilityType === 'page' ? 'app' : abilityConfig.abilityType;
  const extendFile = entryFileName === 'app' ? '.ets' : '.ts';
  const entryFileRealPath = entryFileName + extendFile;
  const entryFilePath = path.resolve(projectConfig.projectPath, entryFileRealPath);
  abilityConfig.abilityEntryFile = entryFilePath;
  if (!fs.existsSync(entryFilePath) && aceCompileMode === 'page') {
    throw Error(`\u001b[31m ERROR: missing ${entryFilePath}. \u001b[39m`).message;
  }
  projectConfig.entryObj[`./${entryFileName}`] = entryFilePath + '?entry';
}

function setAbilityPages(projectConfig) {
  let abilityPages = [];
  if (projectConfig.aceModuleJsonPath && fs.existsSync(projectConfig.aceModuleJsonPath)) {
    const moduleJson = JSON.parse(fs.readFileSync(projectConfig.aceModuleJsonPath).toString());
    abilityPages = readAbilityEntrance(moduleJson);
    setAbilityFile(projectConfig, abilityPages);
  }
}

function setFaTestRunnerFile(projectConfig) {
  const index =projectConfig.projectPath.split(path.sep).join('/').lastIndexOf('\/');
  const testRunnerPath = path.resolve(projectConfig.projectPath.substring(0,index + 1), "TestRunner");
  if (fs.existsSync(testRunnerPath)) {
    const testRunnerFiles = [];
    readFile(testRunnerPath, testRunnerFiles);
    testRunnerFiles.forEach((item) => {
      if (/\.(ts|js)$/.test(item)) {
        const relativePath = path.relative(testRunnerPath, item).replace(/\.(ts|js)$/, '');
		projectConfig.entryObj["../TestRunner/" + relativePath] = item;
        abilityConfig.testRunnerFile.push(item);
      }
    })
  }
}

function setStageTestRunnerFile(projectConfig) {
  const index =projectConfig.projectPath.split(path.sep).join('/').lastIndexOf('\/');
  const testRunnerPath = path.resolve(projectConfig.projectPath, "TestRunner");
  if (fs.existsSync(testRunnerPath)) {
    const testRunnerFiles = [];
    readFile(testRunnerPath, testRunnerFiles);
    testRunnerFiles.forEach((item) => {
      if (/\.(ts|js)$/.test(item)) {
        const relativePath = path.relative(testRunnerPath, item).replace(/\.(ts|js)$/, '');
		projectConfig.entryObj["./TestRunner/" + relativePath] = item;
        abilityConfig.testRunnerFile.push(item);
      }
    })
  }
}

function setAbilityFile(projectConfig, abilityPages) {
  abilityPages.forEach(abilityPath => {
    const projectAbilityPath = path.resolve(projectConfig.projectPath, '../', abilityPath);
    const entryPageKey = abilityPath.replace(/^\.\/ets\//, './').replace(/\.ts$/, '');
    if (fs.existsSync(projectAbilityPath)) {
      abilityConfig.projectAbilityPath.push(projectAbilityPath);
      projectConfig.entryObj[entryPageKey] = projectAbilityPath + '?entry';
    } else {
      throw Error(`\u001b[31m ERROR: srcEntrance file '${projectAbilityPath}' does not exist. \u001b[39m`).message;
    }
  });
}

function readAbilityEntrance(moduleJson) {
  let abilityPages = [];
  if (moduleJson.module) {
    if (moduleJson.module.srcEntrance) {
      abilityPages.push(moduleJson.module.srcEntrance);
    }
    if (moduleJson.module.abilities && moduleJson.module.abilities.length > 0) {
      setEntrance(moduleJson.module.abilities, abilityPages);
    }
    if (moduleJson.module.extensionAbilities && moduleJson.module.extensionAbilities.length > 0) {
      setEntrance(moduleJson.module.extensionAbilities, abilityPages);
    }
  }
  return abilityPages;
}

function setEntrance(abilityConfig, abilityPages) {
  if (abilityConfig && abilityConfig.length > 0) {
    abilityConfig.forEach(ability => {
      if (ability.srcEntrance) {
        abilityPages.push(ability.srcEntrance);
      }
    });
  }
}

function loadWorker(projectConfig) {
  if (validateWorkOption()) {
    const workerConfig = JSON.parse(fs.readFileSync(projectConfig.aceBuildJson).toString());
    workerConfig.workers.forEach(worker => {
      if (!/\.(ts|js)$/.test(worker)) {
        worker += '.ts';
      }
      const relativePath = path.relative(projectConfig.projectPath, worker);
      if (filterWorker(relativePath)) {
        projectConfig.entryObj[relativePath.replace(/\.(ts|js)$/,'')] = worker;
      }
    })
  } else {
    const workerPath = path.resolve(projectConfig.projectPath, WORKERS_DIR);
    if (fs.existsSync(workerPath)) {
      const workerFiles = [];
      readFile(workerPath, workerFiles);
      workerFiles.forEach((item) => {
        if (/\.(ts|js)$/.test(item)) {
          const relativePath = path.relative(workerPath, item).replace(/\.(ts|js)$/, '');
          projectConfig.entryObj[`./${WORKERS_DIR}/` + relativePath] = item;
        }
      })
    }
  }
}

function validateWorkOption() {
  if (projectConfig.aceBuildJson && fs.existsSync(projectConfig.aceBuildJson)) {
    const workerConfig = JSON.parse(fs.readFileSync(projectConfig.aceBuildJson).toString());
    if(workerConfig.workers) {
      return true;
    }
  }
  return false;
}

function filterWorker(workerPath) {
  return /\.(ts|js)$/.test(workerPath);
}

;(function initSystemResource() {
  const sysResourcePath = path.resolve('./sysResource.js');
  if (fs.existsSync(sysResourcePath)) {
    resources.sys = require(sysResourcePath).sys;
  }
})()

function readAppResource(resources, filePath) {
  if (fs.existsSync(filePath)) {
    const appResource = fs.readFileSync(filePath, "utf-8");
    const resourceArr = appResource.split(/\n/);
    let resourceMap = new Map();
    processResourceArr(resourceArr, resourceMap, filePath);
    for (let [key, value] of resourceMap) {
      resources.app[key] = value;
    }
  }
}

function processResourceArr(resourceArr, resourceMap, filePath) {
  for (let i = 0; i < resourceArr.length; i++) {
    if (!resourceArr[i].length) {
      continue;
    }
    const resourceData = resourceArr[i].split(/\s/);
    if (resourceData.length === 3 && !isNaN(Number(resourceData[2])) ) {
      if (resourceMap.get(resourceData[0])) {
        const resourceKeys = resourceMap.get(resourceData[0]);
        if (!resourceKeys[resourceData[1]] || resourceKeys[resourceData[1]] !== Number(resourceData[2])) {
          resourceKeys[resourceData[1]] = Number(resourceData[2]);
        }
      } else {
        let obj = {};
        obj[resourceData[1]] = Number(resourceData[2]);
        resourceMap.set(resourceData[0], obj);
      }
    } else {
      logger.warn(`\u001b[31m ETS:WARN The format of file '${filePath}' is incorrect. \u001b[39m`);
      break;
    }
  }
}

function hashProjectPath(projectPath) {
  process.env.hashProjectPath = "_" + md5(projectPath);
  return process.env.hashProjectPath;
}

const globalProgram = {
  program: null,
  watchProgram: null
};

exports.globalProgram = globalProgram;
exports.projectConfig = projectConfig;
exports.loadEntryObj = loadEntryObj;
exports.readAppResource = readAppResource;
exports.resources = resources;
exports.loadWorker = loadWorker;
exports.abilityConfig = abilityConfig;