fix(fslib): accept null as second argument for readdir (#3239)

yarnpkg · Aug 9, 2021 · 857e21f · 857e21f
1 parent 01586a8
commit 857e21f
Show file tree

Hide file tree

Showing 11 changed files with 119 additions and 89 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/versions/c82aa0f0.yml b/.yarn/versions/c82aa0f0.yml
@@ -0,0 +1,38 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/fslib": patch
+  "@yarnpkg/plugin-pnp": patch
+  "@yarnpkg/pnp": patch
+  "@yarnpkg/pnpify": patch
+
+declined:
+  - "@yarnpkg/esbuild-plugin-pnp"
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-exec"
+  - "@yarnpkg/plugin-file"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-http"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-link"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - vscode-zipfs
+  - "@yarnpkg/builder"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/json-proxy"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/sdks"
+  - "@yarnpkg/shell"
diff --git a/packages/yarnpkg-fslib/sources/FakeFS.ts b/packages/yarnpkg-fslib/sources/FakeFS.ts
@@ -152,12 +152,12 @@ export abstract class FakeFS<P extends Path> {
   abstract realpathSync(p: P): P;
 
   abstract readdirPromise(p: P): Promise<Array<Filename>>;
-  abstract readdirPromise(p: P, opts: {withFileTypes: false}): Promise<Array<Filename>>;
+  abstract readdirPromise(p: P, opts: {withFileTypes: false} | null): Promise<Array<Filename>>;
   abstract readdirPromise(p: P, opts: {withFileTypes: true}): Promise<Array<Dirent>>;
   abstract readdirPromise(p: P, opts: {withFileTypes: boolean}): Promise<Array<Filename> | Array<Dirent>>;
 
   abstract readdirSync(p: P): Array<Filename>;
-  abstract readdirSync(p: P, opts: {withFileTypes: false}): Array<Filename>;
+  abstract readdirSync(p: P, opts: {withFileTypes: false} | null): Array<Filename>;
   abstract readdirSync(p: P, opts: {withFileTypes: true}): Array<Dirent>;
   abstract readdirSync(p: P, opts: {withFileTypes: boolean}): Array<Filename> | Array<Dirent>;
 

diff --git a/packages/yarnpkg-fslib/sources/NodeFS.ts b/packages/yarnpkg-fslib/sources/NodeFS.ts
@@ -412,12 +412,12 @@ export class NodeFS extends BasePortableFakeFS {
   }
 
   async readdirPromise(p: PortablePath): Promise<Array<Filename>>;
-  async readdirPromise(p: PortablePath, opts: {withFileTypes: false}): Promise<Array<Filename>>;
+  async readdirPromise(p: PortablePath, opts: {withFileTypes: false} | null): Promise<Array<Filename>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: true}): Promise<Array<Dirent>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: boolean}): Promise<Array<Filename> | Array<Dirent>>;
-  async readdirPromise(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Promise<Array<string> | Array<Dirent>> {
+  async readdirPromise(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Promise<Array<string> | Array<Dirent>> {
     return await new Promise<Array<Filename> | Array<Dirent>>((resolve, reject) => {
-      if (withFileTypes) {
+      if (opts?.withFileTypes) {
         this.realFs.readdir(npath.fromPortablePath(p), {withFileTypes: true}, this.makeCallback(resolve, reject) as any);
       } else {
         this.realFs.readdir(npath.fromPortablePath(p), this.makeCallback(value => resolve(value as Array<Filename>), reject));
@@ -426,11 +426,11 @@ export class NodeFS extends BasePortableFakeFS {
   }
 
   readdirSync(p: PortablePath): Array<Filename>;
-  readdirSync(p: PortablePath, opts: {withFileTypes: false}): Array<Filename>;
+  readdirSync(p: PortablePath, opts: {withFileTypes: false} | null): Array<Filename>;
   readdirSync(p: PortablePath, opts: {withFileTypes: true}): Array<Dirent>;
   readdirSync(p: PortablePath, opts: {withFileTypes: boolean}): Array<Filename> | Array<Dirent>;
-  readdirSync(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Array<string> | Array<Dirent> {
-    if (withFileTypes) {
+  readdirSync(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Array<string> | Array<Dirent> {
+    if (opts?.withFileTypes) {
       return this.realFs.readdirSync(npath.fromPortablePath(p), {withFileTypes: true} as any);
     } else {
       return this.realFs.readdirSync(npath.fromPortablePath(p)) as Array<Filename>;

diff --git a/packages/yarnpkg-fslib/sources/ProxiedFS.ts b/packages/yarnpkg-fslib/sources/ProxiedFS.ts
@@ -291,19 +291,19 @@ export abstract class ProxiedFS<P extends Path, IP extends Path> extends FakeFS<
   }
 
   async readdirPromise(p: P): Promise<Array<Filename>>;
-  async readdirPromise(p: P, opts: {withFileTypes: false}): Promise<Array<Filename>>;
+  async readdirPromise(p: P, opts: {withFileTypes: false} | null): Promise<Array<Filename>>;
   async readdirPromise(p: P, opts: {withFileTypes: true}): Promise<Array<Dirent>>;
   async readdirPromise(p: P, opts: {withFileTypes: boolean}): Promise<Array<Filename> | Array<Dirent>>;
-  async readdirPromise(p: P, {withFileTypes}: {withFileTypes?: boolean} = {}): Promise<Array<string> | Array<Dirent>> {
-    return this.baseFs.readdirPromise(this.mapToBase(p), {withFileTypes: withFileTypes as any});
+  async readdirPromise(p: P, opts?: {withFileTypes?: boolean} | null): Promise<Array<string> | Array<Dirent>> {
+    return this.baseFs.readdirPromise(this.mapToBase(p), opts as any);
   }
 
   readdirSync(p: P): Array<Filename>;
-  readdirSync(p: P, opts: {withFileTypes: false}): Array<Filename>;
+  readdirSync(p: P, opts: {withFileTypes: false} | null): Array<Filename>;
   readdirSync(p: P, opts: {withFileTypes: true}): Array<Dirent>;
   readdirSync(p: P, opts: {withFileTypes: boolean}): Array<Filename> | Array<Dirent>;
-  readdirSync(p: P, {withFileTypes}: {withFileTypes?: boolean} = {}): Array<string> | Array<Dirent> {
-    return this.baseFs.readdirSync(this.mapToBase(p), {withFileTypes: withFileTypes as any});
+  readdirSync(p: P, opts?: {withFileTypes?: boolean} | null): Array<string> | Array<Dirent> {
+    return this.baseFs.readdirSync(this.mapToBase(p), opts as any);
   }
 
   async readlinkPromise(p: P) {

diff --git a/packages/yarnpkg-fslib/sources/ZipFS.ts b/packages/yarnpkg-fslib/sources/ZipFS.ts
@@ -1363,18 +1363,18 @@ export class ZipFS extends BasePortableFakeFS {
   }
 
   async readdirPromise(p: PortablePath): Promise<Array<Filename>>;
-  async readdirPromise(p: PortablePath, opts: {withFileTypes: false}): Promise<Array<Filename>>;
+  async readdirPromise(p: PortablePath, opts: {withFileTypes: false} | null): Promise<Array<Filename>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: true}): Promise<Array<statUtils.DirEntry>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: boolean}): Promise<Array<Filename> | Array<statUtils.DirEntry>>;
-  async readdirPromise(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Promise<Array<string> | Array<statUtils.DirEntry>> {
-    return this.readdirSync(p, {withFileTypes: withFileTypes as any});
+  async readdirPromise(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Promise<Array<string> | Array<statUtils.DirEntry>> {
+    return this.readdirSync(p, opts as any);
   }
 
   readdirSync(p: PortablePath): Array<Filename>;
-  readdirSync(p: PortablePath, opts: {withFileTypes: false}): Array<Filename>;
+  readdirSync(p: PortablePath, opts: {withFileTypes: false} | null): Array<Filename>;
   readdirSync(p: PortablePath, opts: {withFileTypes: true}): Array<statUtils.DirEntry>;
   readdirSync(p: PortablePath, opts: {withFileTypes: boolean}): Array<Filename> | Array<statUtils.DirEntry>;
-  readdirSync(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Array<string> | Array<statUtils.DirEntry> {
+  readdirSync(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Array<string> | Array<statUtils.DirEntry> {
     const resolvedP = this.resolveFilename(`scandir '${p}'`, p);
     if (!this.entries.has(resolvedP) && !this.listings.has(resolvedP))
       throw errors.ENOENT(`scandir '${p}'`);
@@ -1384,7 +1384,7 @@ export class ZipFS extends BasePortableFakeFS {
       throw errors.ENOTDIR(`scandir '${p}'`);
 
     const entries = [...directoryListing];
-    if (!withFileTypes)
+    if (!opts?.withFileTypes)
       return entries;
 
     return entries.map(name => {

diff --git a/packages/yarnpkg-fslib/sources/ZipOpenFS.ts b/packages/yarnpkg-fslib/sources/ZipOpenFS.ts
@@ -750,28 +750,28 @@ export class ZipOpenFS extends BasePortableFakeFS {
   }
 
   async readdirPromise(p: PortablePath): Promise<Array<Filename>>;
-  async readdirPromise(p: PortablePath, opts: {withFileTypes: false}): Promise<Array<Filename>>;
+  async readdirPromise(p: PortablePath, opts: {withFileTypes: false} | null): Promise<Array<Filename>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: true}): Promise<Array<Dirent>>;
   async readdirPromise(p: PortablePath, opts: {withFileTypes: boolean}): Promise<Array<Filename> | Array<Dirent>>;
-  async readdirPromise(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Promise<Array<string> | Array<Dirent>> {
+  async readdirPromise(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Promise<Array<string> | Array<Dirent>> {
     return await this.makeCallPromise(p, async () => {
-      return await this.baseFs.readdirPromise(p, {withFileTypes: withFileTypes as any});
+      return await this.baseFs.readdirPromise(p, opts as any);
     }, async (zipFs, {subPath}) => {
-      return await zipFs.readdirPromise(subPath, {withFileTypes: withFileTypes as any});
+      return await zipFs.readdirPromise(subPath, opts as any);
     }, {
       requireSubpath: false,
     });
   }
 
   readdirSync(p: PortablePath): Array<Filename>;
-  readdirSync(p: PortablePath, opts: {withFileTypes: false}): Array<Filename>;
+  readdirSync(p: PortablePath, opts: {withFileTypes: false} | null): Array<Filename>;
   readdirSync(p: PortablePath, opts: {withFileTypes: true}): Array<Dirent>;
   readdirSync(p: PortablePath, opts: {withFileTypes: boolean}): Array<Filename> | Array<Dirent>;
-  readdirSync(p: PortablePath, {withFileTypes}: {withFileTypes?: boolean} = {}): Array<string> | Array<Dirent> {
+  readdirSync(p: PortablePath, opts?: {withFileTypes?: boolean} | null): Array<string> | Array<Dirent> {
     return this.makeCallSync(p, () => {
-      return this.baseFs.readdirSync(p, {withFileTypes: withFileTypes as any});
+      return this.baseFs.readdirSync(p, opts as any);
     }, (zipFs, {subPath}) => {
-      return zipFs.readdirSync(subPath, {withFileTypes: withFileTypes as any});
+      return zipFs.readdirSync(subPath, opts as any);
     }, {
       requireSubpath: false,
     });

diff --git a/packages/yarnpkg-fslib/tests/ZipOpenFS.test.ts b/packages/yarnpkg-fslib/tests/ZipOpenFS.test.ts
@@ -6,17 +6,17 @@ import {ZipOpenFS}              from '../sources';
 
 import {useFakeTime}            from './utils';
 
-const ZIP_DIR1 = ppath.join(
+export const ZIP_DIR1 = ppath.join(
   npath.toPortablePath(__dirname),
   `fixtures/foo.zip` as Filename
 );
-const ZIP_DIR2 = ppath.join(
+export const ZIP_DIR2 = ppath.join(
   npath.toPortablePath(__dirname),
   `fixtures/folder.zip/foo.zip` as Filename
 );
 
 export const ZIP_FILE1 = ppath.join(ZIP_DIR1, `foo.txt` as Filename);
-const ZIP_FILE2 = ppath.join(ZIP_DIR2, `foo.txt` as Filename);
+export const ZIP_FILE2 = ppath.join(ZIP_DIR2, `foo.txt` as Filename);
 
 describe(`getArchivePart`, () => {
   const tests = [

diff --git a/packages/yarnpkg-fslib/tests/patchedFs.test.ts b/packages/yarnpkg-fslib/tests/patchedFs.test.ts
@@ -10,7 +10,7 @@ import {Filename, npath}      from '../sources/path';
 import {xfs}                  from '../sources/xfs';
 import {statUtils, ZipOpenFS} from '../sources';
 
-import {ZIP_FILE1}            from "./ZipOpenFS.test";
+import {ZIP_FILE1, ZIP_DIR1}  from "./ZipOpenFS.test";
 
 describe(`patchedFs`, () => {
   it(`in case of no error, give null: fs.stat`, done => {
@@ -121,4 +121,26 @@ describe(`patchedFs`, () => {
       patchedFs.closeSync(fd);
     }
   });
+
+  it(`should support passing null as the second argument to readdir`, async () => {
+    const patchedFs = extendFs(fs, new PosixFS(new ZipOpenFS({libzip: await getLibzipPromise(), baseFs: new NodeFS()})));
+
+    const tmpdir = npath.fromPortablePath(xfs.mktempSync());
+
+    expect(patchedFs.readdirSync(tmpdir, null)).toHaveLength(0);
+    await expect(new Promise((resolve, reject) =>
+      patchedFs.readdir(tmpdir, null, (err, files) =>
+        err ? reject(err) : resolve(files)
+      )
+    )).resolves.toHaveLength(0);
+    await expect(patchedFs.promises.readdir(tmpdir, null)).resolves.toHaveLength(0);
+
+    expect(patchedFs.readdirSync(ZIP_DIR1, null)).toStrictEqual([`foo.txt`]);
+    await expect(new Promise((resolve, reject) =>
+      patchedFs.readdir(ZIP_DIR1, null, (err, files) =>
+        err ? reject(err) : resolve(files)
+      )
+    )).resolves.toStrictEqual([`foo.txt`]);
+    await expect(patchedFs.promises.readdir(ZIP_DIR1, null)).resolves.toStrictEqual([`foo.txt`]);
+  });
 });
diff --git a/packages/yarnpkg-pnp/sources/hook.js b/packages/yarnpkg-pnp/sources/hook.js