git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 0/2] Ensure unique worktree ids across repositories

From
Caleb White <cdwhite3@pm.me>
Date
Nov 29, 2024, 03:31 UTC
Message-ID
<D5YCFP1AV64F.36B116IUDDEE2@pm.me>
In-Reply-To
<xmqqr06un33g.fsf@gitster.g>
On Thu Nov 28, 2024 at 9:14 PM CST, Junio C Hamano wrote:
Show 12 quoted lines
> Caleb White <cdwhite3@pm.me> writes:
>
>> The `es/worktree-repair-copied` topic added support for repairing a
>> worktree from a copy scenario. I noted[1,2] that the topic added the
>> ability for a repository to "take over" a worktree from another
>> repository if the worktree_id matched a worktree inside the current
>> repository which can happen if two repositories use the same worktree name.
>
> Problem worth solving.  Another would be to fail if the worktree ID
> proposed to be used is already in use, but the ID is supposed to be
> almost invisible (unless the user is doing some adiministrative work
> on the repository), generating a unique ID is a good approach.

There's already a `while` loop that tries incrementing the proposed id (e.g., `develop1` if `develop` is taken). However, this is on a per-repository basis, so there's no way to know what's already in use in another repository. The problem arises when trying to run `worktree repair` on a worktree that has a matching id (like `develop`) from another repository. The goal here is that the same worktree name can be created in different repositories and the id will be (effectively) unique.

Show 26 quoted lines
>> This series teaches Git to create worktrees with a unique suffix so
>> that the worktree_id is unique across all repositories even if they have
>> the same name. For example creating a worktree `develop` would look like:
>>
>>     foo/
>>     ├── .git/worktrees/develop-5445874156/
>>     └── develop/
>>     bar/
>>     ├── .git/worktrees/develop-1549518426/
>>     └── develop/
>>
>> The actual worktree directory name is still `develop`, but the
>> worktree_id is unique and prevents the "take over" scenario. The suffix
>> is given by the `git_rand()` function, but I'm open to suggestions if
>> there's a better random or hashing function to use.
>
> I do not think it matters much what hash/rand algorithm is chosen.
> What is important is what you do when the suffix suggested by that
> chosen algorithm collides with an existing worktree ID.  IOW, there
> is no way a "random" can guarantee uniqueness.  Attempt to create and
> if you find a collision, retry from the generation of another suffix,
> or something like that, is necessary.
>
> And as long as that "make sure it is unique" part is done right, it
> does not even have to be random.  Just generating a sequence number
> and using the first one that is available would work as well.

The `while` loop mentioned earlier still exists, so in the (unlikely) event that the suffix collides with an existing worktree_id, it will increment the suffix and try again.

Best,
Caleb
Previous: Junio C HamanoNext: Junio C Hamano
Message 6 of 11 in “Ensure unique worktree ids across repositories”
  1. 0/2 Ensure unique worktree ids across repositoriesCaleb White, Nov 29, 2024
  2. 1/2 worktree: add worktree with unique suffixCaleb White, Nov 29, 2024
  3. 2/2 worktree: rename worktree id during worktree moveCaleb White, Nov 29, 2024
  4. Caleb WhiteNov 29, 2024
  5. Junio C HamanoNov 29, 2024
  6. Caleb WhiteNov 29, 2024
  7. Junio C HamanoDec 1, 2024
  8. shejialuoNov 29, 2024
  9. Caleb WhiteNov 29, 2024
  10. shejialuoNov 29, 2024
  11. Caleb WhiteNov 29, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.