fix: constructor validation on build

cli/cli.js

@@ -10,7 +10,7 @@ import { nodeResolve } from "@rollup/plugin-node-resolve";
 import sourcemaps from "rollup-plugin-sourcemaps";
 import { babel } from "@rollup/plugin-babel";
 import { rollup } from "rollup";
-
+import validateContract from "./contract_validation.js";
 import { executeCommand } from "./utils.js";
 
 const PROJECT_DIR = process.cwd();
@@ -86,6 +86,7 @@ async function checkTsBuildWithTsc(sourceFileWithPath) {
 
 // Common build function
 async function createJsFileWithRullup(sourceFileWithPath, rollupTarget) {
+  await validateContract(sourceFileWithPath);
   console.log(`Creating ${rollupTarget} file with Rollup...`);
   const bundle = await rollup({
     input: sourceFileWithPath,

cli/contract_validation.js

@@ -0,0 +1,57 @@
+import { Project } from "ts-morph";
+import path from "path";
+import chalk from "chalk";
+
+const validateContract = async (contractPath) => {
+  const project = new Project();
+  project.addSourceFilesAtPaths(contractPath);
+  const baseFileName = path.parse(contractPath).base;
+  const contractClassFile = project.getSourceFile(contractPath);
+  const contractClasses = contractClassFile.getClasses(baseFileName);
+  for (const contractClass of contractClasses) {
+    const classStructure = contractClass.getStructure();
+    const { decorators, properties } = classStructure;
+    const hasBindgen = decorators.find(
+      (decorator) => decorator.name === "NearBindgen"
+    );
+    if (hasBindgen) {
+      const constructors = contractClass.getConstructors();
+      const hasConstructor = constructors.length > 0;
+      const propertiesToBeInited = properties.filter((p) => !p.initializer);
+      // reson: examples/clean-state.js
+      if (!hasConstructor && propertiesToBeInited.length === 0) {
+        return true;
+      }
+      if (!hasConstructor && propertiesToBeInited.length > 0) {
+        console.log(
+          chalk.redBright(
+            `Ops, constructor isnt initialized, after initialization include ${propertiesToBeInited
+              .map((p) => p.name)
+              .join(", ")} in constructor`
+          )
+        );
+        process.exit(2);
+      }
+      const constructor = constructors[0];
+      const constructorContent = constructor.getText();
+      const nonInitedProperties = [];
+      for (const property of propertiesToBeInited) {
+        if (!constructorContent.includes(`this.${property.name} =`)) {
+          nonInitedProperties.push(property.name);
+        }
+      }
+      if (nonInitedProperties.length > 0) {
+        console.log(
+          chalk.redBright(
+            `Ops, please initialise ${nonInitedProperties.join(
+              ", "
+            )} in constructor`
+          )
+        );
+        process.exit(2);
+      }
+    }
+  }
+};
+
+export default validateContract;

package.json

@@ -55,6 +55,8 @@
     "@types/babel__traverse": "^7.18.1",
     "@types/node": "^17.0.38",
     "@types/rollup": "^0.54.0",
+    "chalk": "^5.1.0",
+    "ts-morph": "^16.0.0",
     "@typescript-eslint/eslint-plugin": "^5.37.0",
     "@typescript-eslint/parser": "^5.37.0",
     "eslint": "^8.23.1",

tests/__tests__/constructor_validation.ava.js

@@ -0,0 +1,53 @@
+import test from "ava";
+import { execSync } from "child_process";
+
+test("should build, constructor is correctly initialized", async (t) => {
+  let result = null;
+  try {
+    result = execSync(
+      "near-sdk-js build src/constructor-validation/version-1.ts build/constructor-validation/version-1.wasm"
+    ).toString();
+  } catch (e) {
+    result = e;
+  }
+  t.not(result.status, 2);
+});
+
+test("should throw error, name isnt inited", async (t) => {
+  let result = null;
+  try {
+    result = execSync(
+      "near-sdk-js build src/constructor-validation/version-2.ts build/constructor-validation/version-2.wasm"
+    ).toString();
+  } catch (e) {
+    result = e;
+  }
+
+  t.is(result.status, 2);
+});
+
+test("should throw error, construcor is empty", async (t) => {
+  let result = null;
+  try {
+    result = execSync(
+      "near-sdk-js build src/constructor-validation/version-3.ts build/constructor-validation/version-3.wasm"
+    ).toString();
+  } catch (e) {
+    result = e;
+  }
+
+  t.is(result.status, 2);
+});
+
+test("should throw error, construcor isnt declared", async (t) => {
+  let result = null;
+  try {
+    result = execSync(
+      "near-sdk-js build src/constructor-validation/version-4.ts build/constructor-validation/version-4.wasm"
+    ).toString();
+  } catch (e) {
+    result = e;
+  }
+
+  t.is(result.status, 2);
+});

tests/package.json

@@ -49,7 +49,8 @@
     "test:private": "ava __tests__/decorators/private.ava.js",
     "test:bigint-serialization": "ava __tests__/test-bigint-serialization.ava.js",
     "test:date-serialization": "ava __tests__/test-date-serialization.ava.js",
-    "test:serialization": "ava __tests__/test-serialization.ava.js"
+    "test:serialization": "ava __tests__/test-serialization.ava.js",
+    "test:constructor-validation": "ava __tests__/constructor_validation.ava.js"
   },
   "author": "Near Inc <hello@nearprotocol.com>",
   "license": "Apache-2.0",

tests/src/constructor-validation/version-1.ts

@@ -0,0 +1,16 @@
+import { NearBindgen, LookupMap, call } from "near-sdk-js";
+
+@NearBindgen({})
+export class ConstructorValidation {
+  map: LookupMap<string>;
+  name: string;
+  constructor() {
+    this.map = new LookupMap<string>("a");
+    this.name = "";
+  }
+
+  @call({})
+  get() {
+    return { status: "ok" };
+  }
+}

tests/src/constructor-validation/version-2.ts

@@ -0,0 +1,10 @@
+import { NearBindgen, LookupMap } from "near-sdk-js";
+
+@NearBindgen({})
+export class ConstructorValidation {
+  map: LookupMap<string>;
+  name: string;
+  constructor() {
+    this.map = new LookupMap<string>("a");
+  }
+}

tests/src/constructor-validation/version-3.ts

@@ -0,0 +1,10 @@
+import { NearBindgen, LookupMap } from "near-sdk-js";
+
+@NearBindgen({})
+export class ConstructorValidation {
+  map: LookupMap<string>;
+  name: string;
+  constructor() {
+    //
+  }
+}

tests/src/constructor-validation/version-4.ts

@@ -0,0 +1,7 @@
+import { NearBindgen, LookupMap } from "near-sdk-js";
+
+@NearBindgen({})
+export class ConstructorValidation {
+  map: LookupMap<string>;
+  name: string;
+}