microsoft / microsoft/MSBuildCache

Question / Guidance: MinIO Implementation

Open
#108 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
64
Forks
24
Avg merge
1d 14h
Merged PRs (30d)
2

Description

After reading more about MSBuildCache and BuildXL I wanted to ask a few questions to see if implementing MinIO as a cache is feasible and at what level it should be implemented.

  • Is the expectation of this repository to hide the internals of BuildXL? The reason I ask is BuildXL seems to be on GitHub but has a decent amount of internal vs public stuff going on. Not clear to me if extending functionality from that repository is recommended.
  • If it is recommended to extend functionality from that repository any guidance on a Minio approach? This is what I've currently got in my notes so far:
    • Use AzureBlobStorage as an example.
    • Careful of classes that seem generic but have Azure specific functionality. May not be able to re-use as much as initially hoped.
    • Create MSBuildCacheMinioStoragePlugin.cs
    • MSBuildCacheMinioStoragePlugin.cs will implement CreateCacheClientAsync that returns a CasCacheClient to satisfy ICacheClient requirement.
    • The CasCacheClient expects a local cache and remote cache. The local cache is already handled. The remote cache must be a Minio compatible remote cache implementation.
    • To create a Minio compatible remote cache client we must implement:
      • MinioContentStore to satisfy IContentStore requirement.
      • MinioContentSession to satisfy IContentSession requirement.
      • MinioContentStore and MinioContentSession will be injected into OneLevelCache and "just work" given those new Minio classes are implemented correctly.
      • MinioMetadataStore to satisfy IMetadataStore requirement.
      • MinioMetadataStore will be injected into MetadataStoreMemoizationDatabase. DatabaseMemoizationStore will "just work" given new Minio classes are implemented correctly.
      • IPublishingStore and IPublishingSession looks like they need to be implemented but ran out of time during investigation. Look later to determine requirements.
      • IBlobCacheTopology does not seem required but might want to mimic flow anyways to keep things the same.
    • Overall very involved. Overhead of learning BuildXL is very high. Testing / debuggability also seems difficult.

Does everything around BuildXL and having to extend that sound correct if we want a Minio / S3 implementation? Am I overstating or understating how involved this is?

Any guidance would be appreciated!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the proposed MSBuildCacheMinioStoragePlugin.cs with the AzureBlobStorage implementation and inspect the BuildXL ICacheClient, IContentStore, IContentSession, IMetadataStore, IPublishingStore, and related interfaces. Determine which MinIO cache components are actually required, then document a decided implementation scope and testing approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.