fix: Workspace path match (#33)

* fix: Project path compare

* chore: Create @garment/utils package, add isSubPath win32 test

* chore: Change path import

Author: Aleksei Dmitriev

core/garment/package.json

@@ -9,17 +9,18 @@
     "@garment/runner": "^0.14.0",
     "@garment/scheduler": "^0.14.0",
     "@garment/schema-validator": "^0.14.0",
+    "@garment/utils": "^0.0.14",
     "@garment/workspace": "^0.14.0",
     "@parcel/watcher": "^2.0.0-alpha.9",
     "fs-extra": "8.1.0",
+    "globby": "10.0.1",
     "is-valid-path": "^0.1.1",
     "matcher": "^2.1.0",
     "memfs": "^3.1.2",
     "multimatch": "^4.0.0",
     "normalize-path": "^3.0.0",
     "tempy": "0.3.0",
-    "unionfs": "^4.4.0",
-    "globby": "10.0.1"
+    "unionfs": "^4.4.0"
   },
   "files": [
     "lib",
@@ -30,4 +31,4 @@
     "@types/is-valid-path": "^0.1.0",
     "@types/tempy": "^0.2.0"
   }
-}
+}

core/garment/src/garment.ts

@@ -39,6 +39,7 @@ import { FileCache } from './FileCache';
 import { getProjectsByName } from './getProjectsByName';
 import globby = require('globby');
 import normalizePath = require('normalize-path');
+import { isSubPath } from '@garment/utils';
 
 export type Cache =
   | {
@@ -954,7 +955,7 @@ async function garmentFromWorkspace(
 
         if (
           subscription.type === 'glob' &&
-          normalizePath(event.path).startsWith(subscription.input.rootDir)
+          isSubPath(subscription.input.rootDir, normalizePath(event.path))
         ) {
           const matched = multimatch(
             event.path,

core/utils/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@garment/utils",
+  "version": "0.0.14",
+  "main": "lib/index.js",
+  "license": "MIT",
+  "dependencies": {},
+  "files": [
+    "lib"
+  ]
+}

core/utils/src/index.ts

@@ -0,0 +1 @@
+export * from './isSubPath';

core/utils/src/isSubPath/__tests__/isSubPath.test.ts

@@ -0,0 +1,50 @@
+import { isSubPath } from '..';
+import * as Path from 'path';
+
+describe('utils | isSubPath', () => {
+  it('should return true if path is a subpath', () => {
+    expect(isSubPath('/root', '/root/child')).toBeTruthy();
+  });
+
+  it('should return false if path is not a subpath', () => {
+    expect(isSubPath('/root/foo', '/root/bar/baz')).toBeFalsy();
+  });
+
+  it('should return false if path has a similar substring', () => {
+    expect(isSubPath('/root/foo', '/root/foo bar/baz')).toBeFalsy();
+  });
+
+  it("should return true if path has special path .. symbols and it's a subpath", () => {
+    expect(isSubPath('/root/foo', '/root/../root/foo/bar')).toBeTruthy();
+  });
+
+  it("should return true if path has special path . symbol and it's a subpath", () => {
+    expect(isSubPath('/root/foo', '/root/./foo/bar')).toBeTruthy();
+  });
+});
+
+describe('utils | isSubPath [win32]', () => {
+  let relativeSpy: jest.SpyInstance;
+  let isAbsoluteSpy: jest.SpyInstance;
+
+  beforeEach(() => {
+    relativeSpy = jest
+      .spyOn(Path, 'relative')
+      .mockImplementationOnce(Path.win32.relative);
+    isAbsoluteSpy = jest
+      .spyOn(Path, 'isAbsolute')
+      .mockImplementationOnce(Path.win32.isAbsolute);
+  });
+
+  afterEach(() => {
+    relativeSpy.mockRestore();
+    isAbsoluteSpy.mockRestore();
+  });
+
+  it('should return true if path is a subpath', () => {
+    expect(isSubPath('C:\\Foo', 'C:\\Foo\\Bar')).toBeTruthy();
+  });
+  it('should return false if path is not a subpath', () => {
+    expect(isSubPath('C:\\Foo\\Bar', 'D:\\Foo\\Bar')).toBeFalsy();
+  });
+});

core/utils/src/isSubPath/index.ts

@@ -0,0 +1,7 @@
+import * as Path from 'path';
+
+export const isSubPath = (parent: string, child: string) => {
+  const relative = Path.relative(parent, child);
+
+  return relative && !relative.startsWith('..') && !Path.isAbsolute(relative);
+};

core/workspace/package.json

@@ -9,6 +9,7 @@
   ],
   "dependencies": {
     "@garment/schema-validator": "^0.14.0",
+    "@garment/utils": "^0.0.14",
     "dependency-graph": "^0.8.0",
     "fs-extra": "8.1.0",
     "mustache": "^3.0.1",
@@ -21,4 +22,4 @@
     "@types/normalize-path": "^3.0.0",
     "@types/object-hash": "^1.3.0"
   }
-}
+}

core/workspace/src/ProjectRegistry.ts

@@ -1,6 +1,7 @@
 import { Project } from './Project';
 
 import normalizePath = require('normalize-path');
+import { isSubPath } from '@garment/utils';
 
 export class ProjectRegistry {
   [Symbol.iterator]() {
@@ -32,13 +33,13 @@ export class ProjectRegistry {
   getByPaths(...paths: string[]) {
     paths = paths.map(path => normalizePath(path));
     return this.list().filter(project =>
-      paths.some(path => path.indexOf(project.fullPath) === 0)
+      paths.some(path => isSubPath(project.fullPath, path))
     );
   }
 
   getByPath(path: string) {
     path = normalizePath(path);
-    return this.list().find(project => path.indexOf(project.fullPath) === 0);
+    return this.list().find(project => isSubPath(project.fullPath, path));
   }
 
   getByPathExact(path: string) {

garment.json

@@ -268,6 +268,10 @@
     "visualize-graph": {
       "path": "utils/visualize-graph",
       "extends": ["tspackage"]
+    },
+    "utils": {
+      "path": "core/utils",
+      "extends": ["tspackage"]
     }
   },
   "schematics": ["@garment/schematics", "@garment/schematics-typescript"],