Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cli): watch paths for auto uploading daemon #14923

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

eligao
Copy link
Contributor

@eligao eligao commented Dec 25, 2024

Adds a --watch flag to continue watching for changes after initial upload.

  • Example: immich upload ./assets/ --watch
  • Initial upload behaves just like without --watch, as it batch uploads all current items in one go.
  • The script then starts watching for file change/addition, with a simple batching logic for performance:
    • A batch will be fired on 100 file changes
    • Or 10 seconds after the last change
    • The numbers above are hardcoded for now, they are fine and probably not necessary to make it configurable?
  • Another --no-progress flag to hide progress bars to make logs cleaner when running as a daemon
    • This is implied by the --watch flag
  • Docker image: https://github.com/eligao/immich/pkgs/container/immich-cli

@github-actions github-actions bot added the cli Tasks related to the Immich CLI label Dec 25, 2024
@eligao eligao marked this pull request as draft December 25, 2024 10:35
@eligao eligao marked this pull request as ready for review December 26, 2024 19:18
@eligao eligao force-pushed the feat/cli-watch-changes branch from 78824da to 32ba427 Compare December 26, 2024 19:24
cli/src/commands/asset.spec.ts Outdated Show resolved Hide resolved
cli/src/commands/asset.ts Outdated Show resolved Hide resolved
Comment on lines +74 to +78
options: UploadOptionsDto,
{
batchSize = UPLOAD_WATCH_BATCH_SIZE,
debounceTimeMs = UPLOAD_WATCH_DEBOUNCE_TIME_MS,
}: { batchSize?: number; debounceTimeMs?: number } = {},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should only pass a single options object here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I considered doing this, but it would be error prone to mix/unmix watch-specific params with the UploadOptionsDto which would be later passed into uploadBatch()

const extensions = new Set([...image, ...video]);

if (options.ignore) {
watcherIgnored.push((path) => micromatch.contains(path, `**/${options.ignore}`));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if the ignored path contains special characters?, like curly brace, comma, $, etc?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it will be handled in the same way as crawl(), which internally calls fast-glob and then also micromatch:
https://github.com/eligao/immich/blob/fe71f7303ddc0950f7f8464853dac27fdf99fe38/cli/src/utils.ts#L160

cli/src/commands/asset.ts Outdated Show resolved Hide resolved
@eligao eligao force-pushed the feat/cli-watch-changes branch from c267202 to 3e74c98 Compare December 30, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:enhancement cli Tasks related to the Immich CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants