[New Feature]: The type constraints in the manifest file are not strict. #161793

SreakMan · 2024-07-07T05:58:09Z

Description of the new feature/enhancement

Some fields in the repository's manifest files do not actually comply with the constraints.
example

# yaml-language-server: $schema=https://aka.ms/winget-manifest.installer.1.0.0.schema.json
MinimumOSVersion: 6.1

{
    "MinimumOSVersion": {
      "type": [ "string", "null" ],
      "pattern": "^(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])(\\.(0|[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])){0,3}$",
      "description": "The installer minimum operating system version"
    },
}

Proposed technical implementation details (optional)

No response

SreakMan · 2024-07-07T12:08:02Z

const fs = require("fs");
const path = require("path");
const YAML = require("yaml");
const Ajv = require("ajv");
const AjvFormats = require("ajv-formats");

const ajv = new Ajv();
AjvFormats(ajv);
ajv.addFormat("long", {
  type: "number",
  validate: function (value) {
    return (
      Number.isInteger(value) &&
      value <= Number.MAX_SAFE_INTEGER &&
      value >= Number.MIN_SAFE_INTEGER
    );
  },
});

const lib = {};

const schemaDir = `./schema`;
for (let filename of fs.readdirSync(schemaDir)) {
  const [_, type, __, version] = filename.split(".");
  lib[`1.${version}.0-${type}`] = JSON.parse(
    fs.readFileSync(path.resolve(schemaDir, filename), "utf8")
  );
}

const outFile = `./log`;
const pre = "https://github.com/microsoft/winget-pkgs/tree/master/manifests/";
const loadManifest = (dir) => {
  for (const filename of fs.readdirSync(dir)) {
    const subDir = path.resolve(dir, filename);
    const subStat = fs.statSync(subDir);
    if (subStat.isDirectory()) {
      loadManifest(subDir);
    } else if (subStat.isFile()) {
      if (filename.endsWith(".yaml") || filename.endsWith(".yml")) {
        const data = YAML.parse(fs.readFileSync(subDir, "utf8"));
        const schema = lib[`${data.ManifestVersion}-${data.ManifestType}`];
        if (!ajv.validate(schema, data)) {
          const relativePath = path
            .relative(manifestDir, subDir)
            .split(path.sep)
            .join("/");
          const log = `<a href="${pre}${relativePath}">${relativePath}</a>\n`;
          fs.appendFileSync(outFile, log);
        }
      }
    }
  }
};

const manifestDir = `./winget-pkgs/manifests`;
loadManifest(manifestDir);

result

SreakMan added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label Jul 7, 2024

microsoft-github-policy-service bot added the Needs-Triage This work item needs to be triaged by a member of the core team. label Jul 7, 2024

stephengillie removed the Needs-Triage This work item needs to be triaged by a member of the core team. label Jul 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[New Feature]: The type constraints in the manifest file are not strict. #161793

[New Feature]: The type constraints in the manifest file are not strict. #161793

SreakMan commented Jul 7, 2024

SreakMan commented Jul 7, 2024

[New Feature]: The type constraints in the manifest file are not strict. #161793

[New Feature]: The type constraints in the manifest file are not strict. #161793

Comments

SreakMan commented Jul 7, 2024

Description of the new feature/enhancement

Proposed technical implementation details (optional)

SreakMan commented Jul 7, 2024