@salesforce/core 2.36.3 → 2.36.4

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.36.4](https://github.com/forcedotcom/sfdx-core/compare/v2.36.3...v2.36.4) (2022-04-28)
+
+### Bug Fixes
+
+- disable strictSchema ([2f44345](https://github.com/forcedotcom/sfdx-core/commit/2f44345d6dc11673b921b6c65cd548b7f31a0dad))
+- replace JSEN with AJV (wip) ([87ca60c](https://github.com/forcedotcom/sfdx-core/commit/87ca60c48a82618008d761bdd6086727f712aeff))
+- schema comment ([a0868d1](https://github.com/forcedotcom/sfdx-core/commit/a0868d157fbc8757cdbd28472aecfbf597c0f9d2))
+- test failures and cleanup ([95c0710](https://github.com/forcedotcom/sfdx-core/commit/95c0710938b399c858cddfdf5100892ee2e7cf90))
+
 ### [2.36.3](https://github.com/forcedotcom/sfdx-core/compare/v2.36.2...v2.36.3) (2022-04-21)
 
 ### Bug Fixes

package/lib/schema/validator.d.ts

@@ -46,10 +46,12 @@ export declare class SchemaValidator {
      */
     validateSync(json: AnyJson): AnyJson;
     /**
-     * Loads local, external schemas from URIs relative to the local schema file.  Does not support loading from
-     * remote URIs. Returns a map of external schema local URIs to loaded schema JSON objects.
+     * Loads local, external schemas from URIs in the same directory as the local schema file.
+     * Does not support loading from remote URIs.
+     * Returns a map of external schema local URIs to loaded schema JSON objects.
      *
-     * @param schema The main schema to validate against.
+     * @param schema The main schema to look up references ($ref) in.
+     * @returns An array of found referenced schemas.
      */
     private loadExternalSchemas;
     /**
@@ -60,9 +62,9 @@ export declare class SchemaValidator {
     private loadExternalSchema;
     /**
      * Get a string representation of the schema validation errors.
+     * Adds additional (human friendly) information to certain errors.
      *
-     * @param errors An array of JsenValidateError objects.
-     * @param schema The validation schema.
+     * @param errors An array of AJV (DefinedError) objects.
      */
     private getErrorsText;
 }

package/lib/schema/validator.js

@@ -7,12 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaValidator = void 0;
+const fs = require("fs");
 const path = require("path");
+const ajv_1 = require("ajv");
 const kit_1 = require("@salesforce/kit");
-const ts_types_1 = require("@salesforce/ts-types");
-const validator = require("jsen");
 const sfdxError_1 = require("../sfdxError");
-const fs_1 = require("../util/fs");
 /**
  * Loads a JSON schema and performs validations against JSON objects.
  */
@@ -33,7 +32,7 @@ class SchemaValidator {
      */
     async load() {
         if (!this.schema) {
-            this.schema = await fs_1.fs.readJsonMap(this.schemaPath);
+            this.schema = kit_1.parseJsonMap(await fs.promises.readFile(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -43,7 +42,7 @@ class SchemaValidator {
      */
     loadSync() {
         if (!this.schema) {
-            this.schema = fs_1.fs.readJsonMapSync(this.schemaPath);
+            this.schema = kit_1.parseJsonMap(fs.readFileSync(this.schemaPath, 'utf8'));
             this.logger.debug(`Schema loaded for ${this.schemaPath}`);
         }
         return this.schema;
@@ -75,47 +74,54 @@ class SchemaValidator {
     validateSync(json) {
         const schema = this.loadSync();
         const externalSchemas = this.loadExternalSchemas(schema);
+        const ajv = new ajv_1.default({
+            allErrors: true,
+            schemas: externalSchemas,
+            useDefaults: true,
+            // TODO: We may someday want to enable strictSchema. This is disabled for now
+            // because the CLI team does not "own" the @salesforce/schemas repository.
+            // Invalid schema would cause errors wherever SchemaValidator is used.
+            strictSchema: false,
+        });
+        // JSEN to AJV migration note - regarding the following "TODO":
+        // I don't think that AJV has a way to throw an error if an additional property exists in the data
+        // It does however have a top level option for `removeAdditional` https://ajv.js.org/options.html#removeadditional
+        // Regardless, this would be a breaking changes and I do not think it should be implemented.
         // TODO: We should default to throw an error when a property is specified
         // that is not in the schema, but the only option to do this right now is
         // to specify "removeAdditional: false" in every object.
-        const validate = validator(schema, {
-            greedy: true,
-            schemas: externalSchemas,
-        });
-        if (!validate(json)) {
+        const validate = ajv.compile(schema);
+        // AJV will modify the original json object. We need to make a clone of the
+        // json to keep this backwards compatible with JSEN functionality
+        const jsonClone = JSON.parse(JSON.stringify(json));
+        const valid = validate(jsonClone);
+        if (!valid) {
             if (validate.errors) {
-                const errors = this.getErrorsText(validate.errors, schema);
+                const errors = this.getErrorsText(validate.errors);
                 throw new sfdxError_1.SfdxError(`Validation errors:\n${errors}`, 'ValidationSchemaFieldErrors');
             }
             else {
                 throw new sfdxError_1.SfdxError('Unknown schema validation error', 'ValidationSchemaUnknown');
             }
         }
-        return validate.build(json);
+        // We return the cloned JSON because it will have defaults included
+        // This is configured with the 'useDefaults' option above.
+        return jsonClone;
     }
     /**
-     * Loads local, external schemas from URIs relative to the local schema file.  Does not support loading from
-     * remote URIs. Returns a map of external schema local URIs to loaded schema JSON objects.
+     * Loads local, external schemas from URIs in the same directory as the local schema file.
+     * Does not support loading from remote URIs.
+     * Returns a map of external schema local URIs to loaded schema JSON objects.
      *
-     * @param schema The main schema to validate against.
+     * @param schema The main schema to look up references ($ref) in.
+     * @returns An array of found referenced schemas.
      */
     loadExternalSchemas(schema) {
-        const externalSchemas = {};
-        const schemas = kit_1.getJsonValuesByName(schema, '$ref')
-            // eslint-disable-next-line no-useless-escape
-            .map((ref) => ref && RegExp(/([\w\.]+)#/).exec(ref))
+        return kit_1.getJsonValuesByName(schema, '$ref')
+            .map((ref) => ref && RegExp(/([\w\.]+)#/).exec(ref)) // eslint-disable-line no-useless-escape
             .map((match) => match && match[1])
             .filter((uri) => !!uri)
             .map((uri) => this.loadExternalSchema(uri));
-        schemas.forEach((externalSchema) => {
-            if (ts_types_1.isString(externalSchema.id)) {
-                externalSchemas[externalSchema.id] = externalSchema;
-            }
-            else {
-                throw new sfdxError_1.SfdxError(`Unexpected external schema id type: ${typeof externalSchema.id}`, 'ValidationSchemaTypeError');
-            }
-        });
-        return externalSchemas;
     }
     /**
      * Load another schema relative to the primary schema when referenced.  Only supports local schema URIs.
@@ -125,7 +131,7 @@ class SchemaValidator {
     loadExternalSchema(uri) {
         const schemaPath = path.join(this.schemasDir, `${uri}.json`);
         try {
-            return fs_1.fs.readJsonMapSync(schemaPath);
+            return kit_1.parseJsonMap(fs.readFileSync(schemaPath, 'utf8'));
         }
         catch (err) {
             if (err.code === 'ENOENT') {
@@ -136,52 +142,21 @@ class SchemaValidator {
     }
     /**
      * Get a string representation of the schema validation errors.
+     * Adds additional (human friendly) information to certain errors.
      *
-     * @param errors An array of JsenValidateError objects.
-     * @param schema The validation schema.
+     * @param errors An array of AJV (DefinedError) objects.
      */
-    getErrorsText(errors, schema) {
+    getErrorsText(errors) {
         return errors
             .map((error) => {
-            // eslint-disable-next-line no-useless-escape
-            const property = RegExp(/^([a-zA-Z0-9\.]+)\.([a-zA-Z0-9]+)$/).exec(error.path);
-            const getPropValue = (prop) => {
-                const reducer = (obj, name) => {
-                    if (!ts_types_1.isJsonMap(obj))
-                        return;
-                    if (ts_types_1.isJsonMap(obj.properties))
-                        return obj.properties[name];
-                    if (name === '0')
-                        return ts_types_1.asJsonArray(obj.items);
-                    return obj[name] || obj[prop];
-                };
-                return error.path.split('.').reduce(reducer, schema);
-            };
-            const getEnumValues = () => {
-                const enumSchema = ts_types_1.asJsonMap(getPropValue('enum'));
-                return (enumSchema && ts_types_1.getJsonArray(enumSchema, 'enum', []).join(', ')) || '';
-            };
+            const msg = `${error.schemaPath}: ${error.message}`;
             switch (error.keyword) {
                 case 'additionalProperties':
-                    // Missing Typing
-                    // eslint-disable-next-line no-case-declarations
-                    const additionalProperties = ts_types_1.get(error, 'additionalProperties');
-                    return `${error.path} should NOT have additional properties '${additionalProperties}'`;
-                case 'required':
-                    if (property) {
-                        return `${property[1]} should have required property ${property[2]}`;
-                    }
-                    return `should have required property '${error.path}'`;
-                case 'oneOf':
-                    return `${error.path} should match exactly one schema in oneOf`;
+                    return `${msg} '${error.params.additionalProperty}'`;
                 case 'enum':
-                    return `${error.path} should be equal to one of the allowed values ${getEnumValues()}`;
-                case 'type': {
-                    const _path = error.path === '' ? 'Root of JSON object' : error.path;
-                    return `${_path} is an invalid type.  Expected type [${getPropValue('type')}]`;
-                }
+                    return `${msg} '${error.params.allowedValues.join(', ')}'`;
                 default:
-                    return `${error.path} invalid ${error.keyword}`;
+                    return msg;
             }
         })
             .join('\n');

package/lib/sfdxProject.d.ts

@@ -81,7 +81,7 @@ export declare class SfdxProjectJson extends ConfigFile<ConfigFile.Options> {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] (https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     schemaValidate(): Promise<void>;
     /**
@@ -95,7 +95,7 @@ export declare class SfdxProjectJson extends ConfigFile<ConfigFile.Options> {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] (https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     schemaValidateSync(): void;
     /**

package/lib/sfdxProject.js

@@ -87,7 +87,7 @@ class SfdxProjectJson extends configFile_1.ConfigFile {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] (https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     async schemaValidate() {
         if (!this.hasRead) {
@@ -98,7 +98,6 @@ class SfdxProjectJson extends configFile_1.ConfigFile {
             try {
                 const projectJsonSchemaPath = require.resolve('@salesforce/schemas/sfdx-project.schema.json');
                 const validator = new validator_1.SchemaValidator(this.logger, projectJsonSchemaPath);
-                await validator.load();
                 await validator.validate(this.getContents());
             }
             catch (err) {
@@ -129,7 +128,7 @@ class SfdxProjectJson extends configFile_1.ConfigFile {
      * Set the `SFDX_PROJECT_JSON_VALIDATION` environment variable to `true` to throw an error when schema validation fails.
      * A warning is logged by default when the file is invalid.
      *
-     * ***See*** [sfdx-project.schema.json] (https://raw.githubusercontent.com/forcedotcom/schemas/master/schemas/sfdx-project.schema.json)
+     * ***See*** [sfdx-project.schema.json] (https://github.com/forcedotcom/schemas/blob/main/sfdx-project.schema.json)
      */
     schemaValidateSync() {
         if (!this.hasRead) {
@@ -140,7 +139,6 @@ class SfdxProjectJson extends configFile_1.ConfigFile {
             try {
                 const projectJsonSchemaPath = require.resolve('@salesforce/schemas/sfdx-project.schema.json');
                 const validator = new validator_1.SchemaValidator(this.logger, projectJsonSchemaPath);
-                validator.loadSync();
                 validator.validateSync(this.getContents());
             }
             catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "2.36.3",
+  "version": "2.36.4",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -41,12 +41,12 @@
     "@types/graceful-fs": "^4.1.5",
     "@types/jsforce": "^1.9.41",
     "@types/mkdirp": "^1.0.1",
+    "ajv": "^8.11.0",
     "archiver": "^5.3.0",
     "debug": "^3.1.0",
     "faye": "^1.4.0",
     "graceful-fs": "^4.2.4",
     "js2xmlparser": "^4.0.1",
-    "jsen": "0.6.6",
     "jsforce": "^1.11.0",
     "jsonwebtoken": "8.5.0",
     "mkdirp": "1.0.4",
@@ -60,7 +60,6 @@
     "@salesforce/ts-sinon": "1.3.21",
     "@types/archiver": "^5.1.1",
     "@types/debug": "0.0.30",
-    "@types/jsen": "0.0.19",
     "@types/jsonwebtoken": "8.3.2",
     "@types/semver": "^7.3.9",
     "@types/shelljs": "0.7.8",