[EngSys] decouple filters in changed-files.js

.github/shared/src/changed-files.js

@@ -1,7 +1,9 @@
 // @ts-check
 
 import debug from "debug";
+import { normalize, sep } from "path";
 import { simpleGit } from "simple-git";
+import { includesFolder } from "./path.js";
 
 // Enable simple-git debug logging to improve console output
 debug.enable("simple-git");
@@ -158,7 +160,7 @@
  */
 export function specification(file) {
   // Folder name "specification" should match case, since it already exists in repo
-  return typeof file === "string" && file.startsWith("specification/");
+  return typeof file === "string" && normalize(file).split(sep)[0] === "specification";
 }
 
 /**
@@ -167,7 +169,7 @@
  */
 export function dataPlane(file) {
   // Folder name "data-plane" should match case for consistency across specs
-  return typeof file === "string" && specification(file) && file.includes("/data-plane/");
+  return typeof file === "string" && includesFolder(file, "data-plane");
 }
 
 /**
@@ -176,7 +178,7 @@
  */
 export function resourceManager(file) {
   // Folder name "resource-manager" should match case for consistency across specs
-  return typeof file === "string" && specification(file) && file.includes("/resource-manager/");
+  return typeof file === "string" && includesFolder(file, "resource-manager");
 }
 
 /**
@@ -185,9 +187,7 @@
  */
 export function example(file) {
   // Folder name "examples" should match case for consistency across specs
-  return (
-    typeof file === "string" && json(file) && specification(file) && file.includes("/examples/")
-  );
+  return typeof file === "string" && json(file) && includesFolder(file, "examples");
 }
 
 /**
@@ -209,7 +209,5 @@
  * @returns {boolean}
  */
 export function scenario(file) {
-  return (
-    typeof file === "string" && json(file) && specification(file) && file.includes("/scenarios/")
-  );
+  return typeof file === "string" && json(file) && includesFolder(file, "scenarios");
 }

.github/shared/src/swagger.js

@@ -1,10 +1,10 @@
 // @ts-check
 
 import $RefParser, { ResolverError } from "@apidevtools/json-schema-ref-parser";
 import { readFile } from "fs/promises";
 import { dirname, relative, resolve } from "path";
 import { mapAsync } from "./array.js";
-import { includesFolder } from "./path.js";
+import { example } from "./changed-files.js";
 import { SpecModelError } from "./spec-model-error.js";
 
 /**
@@ -222,26 +222,6 @@
   }
 }
 
-// TODO: Remove duplication with changed-files.js (which currently requires paths relative to repo root)
-
-/**
- * @param {string} [file]
- * @returns {boolean}
- */
-function example(file) {
-  // Folder name "examples" should match case for consistency across specs
-  return typeof file === "string" && json(file) && includesFolder(file, "examples");
-}
-
-/**
- * @param {string} [file]
- * @returns {boolean}
- */
-function json(file) {
-  // Extension "json" with any case is a valid JSON file
-  return typeof file === "string" && file.toLowerCase().endsWith(".json");
-}
-
 // API version lifecycle stages
 export const API_VERSION_LIFECYCLE_STAGES = Object.freeze({
   PREVIEW: "preview",

.github/shared/test/changed-files.test.js

@@ -1,3 +1,3 @@
 // @ts-check
 
 import { afterEach, describe, expect, it, vi } from "vitest";
@@ -46,6 +46,11 @@
     "cspell.yaml",
     "MixedCase.jSoN",
     "README.MD",
+    "not-spec/contosowidgetmanager/data-plane/readme.md",
+    "not-spec/contosowidgetmanager/resource-manager/readme.md",
+    "not-spec/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
+    "not-spec/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json",
+    "not-spec/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
     "specification/contosowidgetmanager/data-plane/readme.md",
     "specification/contosowidgetmanager/Contoso.Management/main.tsp",
     "specification/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
@@ -59,6 +64,9 @@
     const expected = [
       "cspell.json",
       "MixedCase.jSoN",
+      "not-spec/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
+      "not-spec/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json",
+      "not-spec/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
       "specification/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/examples/Employees_Get.json",
@@ -71,6 +79,8 @@
   it("filter:readme", () => {
     const expected = [
       "README.MD",
+      "not-spec/contosowidgetmanager/data-plane/readme.md",
+      "not-spec/contosowidgetmanager/resource-manager/readme.md",
       "specification/contosowidgetmanager/data-plane/readme.md",
       "specification/contosowidgetmanager/resource-manager/readme.md",
     ];
@@ -93,13 +103,18 @@
   });
 
   it("filter:data-plane", () => {
-    const expected = ["specification/contosowidgetmanager/data-plane/readme.md"];
+    const expected = [
+      "not-spec/contosowidgetmanager/data-plane/readme.md",
+      "specification/contosowidgetmanager/data-plane/readme.md",
+    ];
 
     expect(files.filter(dataPlane)).toEqual(expected);
   });
 
   it("filter:resource-manager", () => {
     const expected = [
+      "not-spec/contosowidgetmanager/resource-manager/readme.md",
+      "not-spec/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
       "specification/contosowidgetmanager/resource-manager/readme.md",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/examples/Employees_Get.json",
@@ -110,6 +125,7 @@
 
   it("filter:example", () => {
     const expected = [
+      "not-spec/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
       "specification/contosowidgetmanager/Contoso.Management/examples/2021-11-01/Employees_Get.json",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/examples/Employees_Get.json",
     ];
@@ -119,6 +135,7 @@
 
   it("filter:scenarios", () => {
     const expected = [
+      "not-spec/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json",
       "specification/contosowidgetmanager/Contoso.Management/scenarios/2021-11-01/Employees_Get.json",
     ];
 
@@ -127,6 +144,7 @@
 
   it("filter:swagger", () => {
     const expected = [
+      "not-spec/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
       "specification/contosowidgetmanager/resource-manager/Microsoft.Contoso/stable/2021-11-01/contoso.json",
     ];
 

.github/workflows/src/arm-incremental-typespec.js

@@ -1,3 +1,3 @@
 // @ts-check
 
 // For now, treat all paths as posix, since this is the format returned from git commands
@@ -9,6 +9,7 @@
   getChangedFiles,
   readme,
   resourceManager,
+  specification,
   swagger,
 } from "../../shared/src/changed-files.js";
 import { Readme } from "../../shared/src/readme.js";
@@ -30,7 +31,7 @@
   const changedFiles = await getChangedFiles(options);
 
   // Includes swaggers, readmes, and examples
-  const changedRmFiles = changedFiles.filter(resourceManager);
+  const changedRmFiles = changedFiles.filter((f) => specification(f) && resourceManager(f));
 
   if (changedRmFiles.length == 0) {
     core.info("No changes to files containing path '/resource-manager/'");
@@ -128,7 +129,7 @@
       changedSpecDir,
     ]);
 
-    // Filter files to only include RM swagger files
+    // Filter files to only include RM swagger files.  Should already be filtered to files under "/specification".
     const specRmSwaggerFilesBaseBranch = specFilesBaseBranch
       .split("\n")
       .filter((file) => resourceManager(file) && swagger(file));

eng/tools/oav-runner/src/runner.ts

@@ -1,12 +1,11 @@
 #!/usr/bin/env node
 
+import * as fs from "fs";
 import * as oav from "oav";
 import * as path from "path";
-import * as fs from "fs";
 
+import { example, getChangedFiles, swagger } from "@azure-tools/specs-shared/changed-files"; //getChangedFiles,
 import { Swagger } from "@azure-tools/specs-shared/swagger";
-import { includesFolder } from "@azure-tools/specs-shared/path";
-import { getChangedFiles } from "@azure-tools/specs-shared/changed-files"; //getChangedFiles,
 import { ReportableOavError } from "./formatting.js";
 
 export async function preCheckFiltering(
@@ -125,24 +124,6 @@
     .filter((d) => d.includes("specification" + path.sep));
 }
 
-function example(file: string): boolean {
-  return (
-    typeof file === "string" &&
-    file.toLowerCase().endsWith(".json") &&
-    includesFolder(file, "examples")
-  );
-}
-
-function swagger(file: string): boolean {
-  return (
-    typeof file === "string" &&
-    file.toLowerCase().endsWith(".json") &&
-    (includesFolder(file, "data-plane") || includesFolder(file, "resource-manager")) &&
-    includesFolder(file, "specification") &&
-    !includesFolder(file, "examples")
-  );
-}
-
 export async function processFilesToSpecificationList(
   rootDirectory: string,
   files: string[],