feat: add file service stat middleware

Author: Loïc Mangeonjean

src/service-override/files.ts

@@ -31,7 +31,9 @@ import {
   type IFileSystemProviderWithFileAtomicReadCapability,
   type IFileSystemProviderWithFileAtomicWriteCapability,
   type IFileSystemProviderWithFileAtomicDeleteCapability,
-  hasFileReadStreamCapability
+  hasFileReadStreamCapability,
+  type IFileStat,
+  type IFileStatWithMetadata
 } from 'vs/platform/files/common/files'
 import {
   DisposableStore,
@@ -1079,8 +1081,15 @@ const providers: Record<string, IFileSystemProvider> = {
   [Schemas.file]: overlayFileSystemProvider
 }
 
+export interface FileServiceOptions {
+  statMiddleware?: (resource: URI, next: () => Promise<IFileStat>) => Promise<IFileStat>
+}
+
 class FileServiceOverride extends FileService {
-  constructor(logService: ILogService) {
+  constructor(
+    logService: ILogService,
+    private options: FileServiceOptions
+  ) {
     super(logService)
 
     for (const [scheme, provider] of Object.entries(providers)) {
@@ -1104,6 +1113,36 @@ class FileServiceOverride extends FileService {
     return super.withProvider(resource)
   }
 
+  protected override async toFileStat(
+    provider: IFileSystemProvider,
+    resource: URI,
+    stat: IStat | ({ type: FileType } & Partial<IStat>),
+    siblings: number | undefined,
+    resolveMetadata: boolean,
+    recurse: (stat: IFileStat, siblings?: number) => boolean
+  ): Promise<IFileStat>
+  protected override async toFileStat(
+    provider: IFileSystemProvider,
+    resource: URI,
+    stat: IStat,
+    siblings: number | undefined,
+    resolveMetadata: true,
+    recurse: (stat: IFileStat, siblings?: number) => boolean
+  ): Promise<IFileStatWithMetadata>
+  protected override async toFileStat(
+    provider: IFileSystemProvider,
+    resource: URI,
+    stat: IStat | ({ type: FileType } & Partial<IStat>),
+    siblings: number | undefined,
+    resolveMetadata: boolean,
+    recurse: (stat: IFileStat, siblings?: number) => boolean
+  ): Promise<IFileStat> {
+    const next = async () => {
+      return await super.toFileStat(provider, resource, stat, siblings, resolveMetadata, recurse)
+    }
+    return this.options.statMiddleware?.(resource, next) ?? next()
+  }
+
   /**
    * Hack: the parent class has dependencies, we don't, dependencies are stored in a static field
    * Having no dependencies mean the field won't be overriden, so we'll inherit dependencies from the parent
@@ -1118,9 +1157,11 @@ registerServiceInitializePreParticipant(async (accessor) => {
   fileLogger.logger = accessor.get(ILogService)
 })
 
-export default function getServiceOverride(): IEditorOverrideServices {
+export default function getServiceOverride(
+  options: FileServiceOptions = {}
+): IEditorOverrideServices {
   return {
-    [IFileService.toString()]: new SyncDescriptor(FileServiceOverride, [fileLogger], true),
+    [IFileService.toString()]: new SyncDescriptor(FileServiceOverride, [fileLogger, options], true),
     [ITextFileService.toString()]: new SyncDescriptor(BrowserTextFileService, [], true),
     [IFilesConfigurationService.toString()]: new SyncDescriptor(
       FilesConfigurationService,
@@ -1311,5 +1352,6 @@ export type {
   IFileWriteOptions,
   IFileDeleteOptions,
   IFileOverwriteOptions,
-  IFileChange
+  IFileChange,
+  IFileStat
 }

vscode-patches/0013-feat-export-some-classes-and-make-some-methods-acces.patch

@@ -12,6 +12,7 @@ Subject: [PATCH] feat: export some classes and make some methods accessible
  .../platform/actionWidget/browser/actionWidget.ts  |  2 +-
  .../actions/browser/actionViewItemService.ts       |  2 +-
  .../browser/extensionResourceLoaderService.ts      |  2 +-
+ src/vs/platform/files/common/fileService.ts        |  6 +++---
  .../api/browser/statusBarExtensionPoint.ts         |  2 +-
  src/vs/workbench/browser/layout.ts                 | 10 +++++-----
  src/vs/workbench/browser/workbench.ts              | 14 +++++++-------
@@ -39,7 +40,7 @@ Subject: [PATCH] feat: export some classes and make some methods accessible
  .../terminal/common/embedderTerminalService.ts     |  2 +-
  .../common/remoteUserDataProfiles.ts               |  2 +-
  .../userDataSync/common/userDataSyncUtil.ts        |  2 +-
- 35 files changed, 60 insertions(+), 56 deletions(-)
+ 36 files changed, 63 insertions(+), 59 deletions(-)
 
 diff --git a/src/vs/editor/contrib/editorState/browser/keybindingCancellation.ts b/src/vs/editor/contrib/editorState/browser/keybindingCancellation.ts
 index 94020ce96b9..de1e9af237e 100644
@@ -167,6 +168,23 @@ index 921674ef18e..00b83a75fcb 100644
 
  	declare readonly _serviceBrand: undefined;
 
+diff --git a/src/vs/platform/files/common/fileService.ts b/src/vs/platform/files/common/fileService.ts
+index a5f6dc5023a..1220e0d5b6a 100644
+--- a/src/vs/platform/files/common/fileService.ts
++++ b/src/vs/platform/files/common/fileService.ts
+@@ -243,9 +243,9 @@ export class FileService extends Disposable implements IFileService {
+ 		});
+ 	}
+ 
+-	private async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat | { type: FileType } & Partial<IStat>, siblings: number | undefined, resolveMetadata: boolean, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStat>;
+-	private async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat, siblings: number | undefined, resolveMetadata: true, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStatWithMetadata>;
+-	private async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat | { type: FileType } & Partial<IStat>, siblings: number | undefined, resolveMetadata: boolean, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStat> {
++	protected async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat | { type: FileType } & Partial<IStat>, siblings: number | undefined, resolveMetadata: boolean, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStat>;
++	protected async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat, siblings: number | undefined, resolveMetadata: true, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStatWithMetadata>;
++	protected async toFileStat(provider: IFileSystemProvider, resource: URI, stat: IStat | { type: FileType } & Partial<IStat>, siblings: number | undefined, resolveMetadata: boolean, recurse: (stat: IFileStat, siblings?: number) => boolean): Promise<IFileStat> {
+ 		const { providerExtUri } = this.getExtUri(provider);
+ 
+ 		// convert to file stat
 diff --git a/src/vs/workbench/api/browser/statusBarExtensionPoint.ts b/src/vs/workbench/api/browser/statusBarExtensionPoint.ts
 index fa0d7fd2307..46a8443e46a 100644
 --- a/src/vs/workbench/api/browser/statusBarExtensionPoint.ts

vscode-patches/0045-refactor-split-code-to-be-able-to-import-only-requir.patch

@@ -337,7 +337,7 @@ index 8697dcb34d4..5d7426ab0db 100644
 
  interface IExtensionCacheData {
 diff --git a/src/vs/platform/files/common/fileService.ts b/src/vs/platform/files/common/fileService.ts
-index a5f6dc5023a..313c0ef2b26 100644
+index 1220e0d5b6a..c1e984953dd 100644
 --- a/src/vs/platform/files/common/fileService.ts
 +++ b/src/vs/platform/files/common/fileService.ts
 @@ -23,6 +23,64 @@ import { readFileIntoStream } from './io.js';