Add helpers and improve error logging. (#201)

* Dependency treadmill.

* Add media type helper.

* Add context to rendering error.

* Downgrade @oclif/command due to node engine version mismatch.

* Revert oclif upgrades; change @types/node to v10.

* Don't bundle test files.

* Ignore package bundles.

* Add request payload helper.

* Add resolutions and `npm audit fix`.

* Allow missing request in payload checker.

* sort-package-json

* Parallelize rendering and improve error logging.

* Update copyrights.

Author: wjhsf

.gitignore

@@ -8,3 +8,4 @@ coverage
 .env
 reports
 .idea
+*.tgz

package-lock.json

@@ -49,6 +49,10 @@
       "git add"
     ]
   },
+  "resolutions": {
+    "**/@oclif/command": "<=1.8.3",
+    "**/yargs": "<17"
+  },
   "dependencies": {
     "@oclif/command": "1.8.0",
     "@oclif/config": "1.17.1",
@@ -62,7 +66,7 @@
     "lodash": "4.17.21",
     "loglevel": "1.8.0",
     "make-fetch-happen": "8.0.14",
-    "snyk": "1.685.0",
+    "snyk": "1.787.0",
     "tmp": "0.2.1",
     "ts-node": "8.10.2",
     "unzipper": "0.10.11"
@@ -78,9 +82,9 @@
     "@types/js-yaml": "^3.12.7",
     "@types/jszip": "^3.4.1",
     "@types/mocha": "^8.2.3",
-    "@types/node": "^14.14.6",
+    "@types/node": "^10.17.60",
     "@types/sinon": "^9.0.11",
-    "@types/tmp": "^0.2.1",
+    "@types/tmp": "^0.2.2",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
     "chai": "^4.3.4",
@@ -89,16 +93,16 @@
     "depcheck": "^0.9.2",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-header": "^3.0.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jszip": "^3.6.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-prettier": "^3.4.1",
+    "jszip": "^3.7.1",
     "lint-staged": "^8.2.1",
     "mocha": "^8.4.0",
     "nock": "^12.0.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.3.2",
+    "prettier": "^2.5.1",
     "sinon": "^9.2.4",
-    "sort-package-json": "^1.50.0",
+    "sort-package-json": "^1.53.1",
     "tslib": "^1.14.1",
     "typescript": "^3.9.7"
   },

package.json

@@ -0,0 +1 @@
+**/*.test.ts

resources/.npmignore

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -193,35 +193,35 @@ describe("ApiMetaData render tests", () => {
   });
 
   it("does nothing without templates for the entire tree", async () => {
-    const ensureDirSyncSpy = sandbox.spy(fs, "ensureDirSync");
-    const writeFileSyncSpy = sandbox.spy(fs, "writeFileSync");
+    const ensureDirSpy = sandbox.spy(fs, "ensureDir");
+    const writeFileSpy = sandbox.spy(fs, "writeFile");
     await apiMetadata.render();
 
-    expect(ensureDirSyncSpy.notCalled).to.be.true;
-    expect(writeFileSyncSpy.notCalled).to.be.true;
+    expect(ensureDirSpy.notCalled).to.be.true;
+    expect(writeFileSpy.notCalled).to.be.true;
   });
 
   it("renders root template only", async () => {
-    const ensureDirSyncSpy = sandbox.spy(fs, "ensureDirSync");
-    const writeFileSyncSpy = sandbox.spy(fs, "writeFileSync");
+    const ensureDirSpy = sandbox.spy(fs, "ensureDir");
+    const writeFileSpy = sandbox.spy(fs, "writeFile");
     apiMetadata.addTemplate(
       handlebarTemplate,
       path.join(tmpDir.name, "apis.txt")
     );
 
     await apiMetadata.render();
 
-    expect(ensureDirSyncSpy.calledOnce).to.be.true;
-    expect(writeFileSyncSpy.calledOnce).to.be.true;
+    expect(ensureDirSpy.calledOnce).to.be.true;
+    expect(writeFileSpy.calledOnce).to.be.true;
 
     expect(path.join(tmpDir.name, "apis.txt"))
       .to.be.a.file()
       .with.content("apis");
   });
 
   it("renders child templates only", async () => {
-    const ensureDirSyncSpy = sandbox.spy(fs, "ensureDirSync");
-    const writeFileSyncSpy = sandbox.spy(fs, "writeFileSync");
+    const ensureDirSpy = sandbox.spy(fs, "ensureDir");
+    const writeFileSpy = sandbox.spy(fs, "writeFile");
 
     apiMetadata.children[0].addTemplate(
       handlebarTemplate,
@@ -235,8 +235,8 @@ describe("ApiMetaData render tests", () => {
 
     await apiMetadata.render();
 
-    expect(ensureDirSyncSpy.calledTwice).to.be.true;
-    expect(writeFileSyncSpy.calledTwice).to.be.true;
+    expect(ensureDirSpy.calledTwice).to.be.true;
+    expect(writeFileSpy.calledTwice).to.be.true;
 
     expect(path.join(tmpDir.name, "child1.txt"))
       .to.be.a.file()
@@ -248,8 +248,8 @@ describe("ApiMetaData render tests", () => {
   });
 
   it("renders all templates", async () => {
-    const ensureDirSyncSpy = sandbox.spy(fs, "ensureDirSync");
-    const writeFileSyncSpy = sandbox.spy(fs, "writeFileSync");
+    const ensureDirSpy = sandbox.spy(fs, "ensureDir");
+    const writeFileSpy = sandbox.spy(fs, "writeFile");
 
     apiMetadata.addTemplate(
       handlebarTemplate,
@@ -268,8 +268,8 @@ describe("ApiMetaData render tests", () => {
 
     await apiMetadata.render();
 
-    expect(ensureDirSyncSpy.calledThrice).to.be.true;
-    expect(writeFileSyncSpy.calledThrice).to.be.true;
+    expect(ensureDirSpy.calledThrice).to.be.true;
+    expect(writeFileSpy.calledThrice).to.be.true;
 
     expect(path.join(tmpDir.name, "apis.txt"))
       .to.be.a.file()

src/generate/apiMetadata.test.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -75,10 +75,25 @@ export class ApiMetadata {
    */
   public async renderThis(): Promise<void> {
     ramlToolLogger.info(`Rendering templates for ${this.name.original}`);
-    this.templates.forEach((template) => {
-      fs.ensureDirSync(path.dirname(template.outputFile));
-      fs.writeFileSync(template.outputFile, template.handlebarTemplate(this));
+    // Render templates in parallel
+    const promises = this.templates.map(async (template) => {
+      try {
+        await fs.ensureDir(path.dirname(template.outputFile));
+        await fs.writeFile(
+          template.outputFile,
+          template.handlebarTemplate(this, {
+            allowProtoPropertiesByDefault: true,
+            allowProtoMethodsByDefault: true,
+          })
+        );
+      } catch (err) {
+        ramlToolLogger.error(
+          `Error while rendering ${template.outputFile}:`,
+          err
+        );
+      }
     });
+    await Promise.all(promises);
   }
 
   /**
@@ -90,11 +105,12 @@ export class ApiMetadata {
     try {
       await this.renderThis();
     } catch (err) {
-      ramlToolLogger.error(err);
+      ramlToolLogger.error(`Failed to render ${this.name}:`, err);
     }
-    return this.children.forEach(async (child) => {
-      await child.render();
-    });
+
+    // Render children in parallel
+    const promises = this.children.map(async (child) => await child.render());
+    await Promise.all(promises);
   }
 
   /**

src/generate/apiMetadata.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -84,6 +84,7 @@ export class ApiModel extends ApiMetadata {
    * @memberof ApiModel
    */
   public async loadModel(updateName = true): Promise<void> {
+    ramlToolLogger.info(`Loading model for ${this.name.original}`);
     const tmpModel = await parseRamlFile(path.join(this.path, this.main));
 
     // The model needs to be cloned because resolveApiModel messes with the dataTypes.
@@ -120,15 +121,24 @@ export class ApiModel extends ApiMetadata {
     }
 
     ramlToolLogger.info(`Rendering templates for ${this.name.original}`);
-    this.templates.forEach((template) => {
-      fs.ensureDirSync(path.dirname(template.outputFile));
-      fs.writeFileSync(
-        template.outputFile,
-        template.handlebarTemplate(this, {
-          allowProtoPropertiesByDefault: true,
-          allowProtoMethodsByDefault: true,
-        })
-      );
+    // Render templates in parallel
+    const promises = this.templates.map(async (template) => {
+      try {
+        await fs.ensureDir(path.dirname(template.outputFile));
+        await fs.writeFile(
+          template.outputFile,
+          template.handlebarTemplate(this, {
+            allowProtoPropertiesByDefault: true,
+            allowProtoMethodsByDefault: true,
+          })
+        );
+      } catch (err) {
+        ramlToolLogger.error(
+          `Error while rendering ${template.outputFile}:`,
+          err
+        );
+      }
     });
+    await Promise.all(promises);
   }
 }