Skip to content

build(deps): Migrate yscope-log-viewer dependency from submodule to task-based source download. #835

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.

Sign up for GitHub

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

Merged
kirkrodrigues merged 5 commits into from
Apr 18, 2025
Merged

build(deps): Migrate yscope-log-viewer dependency from submodule to task-based source download. #835

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7435d7b
build(deps): Use tasks to install yscope-log-viewer instead of using …
kirkrodrigues Apr 17, 2025
cf4e8ba
Add docs.
kirkrodrigues Apr 17, 2025
8bb3890
Remove ref to deleted task.
kirkrodrigues Apr 17, 2025
fb5b3c6
Parallelize core and log-viewer dependency downloads.
kirkrodrigues Apr 17, 2025
a7d4c7e
Update taskfiles/deps.yaml
kirkrodrigues Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@
[submodule "components/core/submodules/outcome"]
path = components/core/submodules/outcome
url = https://github.com/ned14/outcome.git
[submodule "components/log-viewer-webui/yscope-log-viewer"]
path = components/log-viewer-webui/yscope-log-viewer
url = https://github.com/y-scope/yscope-log-viewer.git
[submodule "components/core/submodules/utfcpp"]
path = components/core/submodules/utfcpp
url = https://github.com/nemtrif/utfcpp.git
Expand Down
1 change: 0 additions & 1 deletion components/log-viewer-webui/yscope-log-viewer
Open in desktop
Submodule yscope-log-viewer deleted from 969ff3
6 changes: 6 additions & 0 deletions docs/src/dev-guide/components-log-viewer-webui.md
View file
Open in desktop
Copy link
Member

@junhaoliao junhaoliao Apr 18, 2025

Choose a reason for hiding this comment

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

@coderabbitai Not related to this PR but for the "## Running" commands, we should specify in which directory the commands should be run. Create an issue to track this.

Copy link
Contributor

@coderabbitai coderabbitai bot Apr 18, 2025

Choose a reason for hiding this comment

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

🧩 Analysis chain

@junhaoliao I've created an issue to track this documentation improvement. The issue describes the need to specify which directories the commands in the "Running" section should be executed from. I've assigned the issue to you as requested.

🏁 Script executed:

#!/bin/bash
# Create a GitHub issue to track the documentation improvement
gh issue create \
  --title "Documentation: Specify directories for commands in Log Viewer WebUI Running section" \
  --body "## Description

In the Log Viewer WebUI documentation, the \"Running\" section does not specify which directory the commands should be run from. This makes it unclear for users whether they should run the commands from the repository root, components/log-viewer-webui, or the client/server subdirectories.

## Proposed Change

Update the \"Running\" section in \`docs/src/dev-guide/components-log-viewer-webui.md\` to specify the directory for each command, similar to how it's done in the \"Setup\" section.

## Background

This issue was identified during PR review: https://github.com/y-scope/clp/pull/835#discussion_r2049777505

" \
  --assignee "junhaoliao"

Length of output: 813

@junhaoliao I've created the issue to track this documentation improvement. You can find it at: #836

The issue focuses on updating the "Running" section in the Log Viewer WebUI documentation to clearly specify which directories the commands should be executed from.

Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ currently consists of a [React] client and a [Fastify] server.

## Setup

Download the log-viewer's source code:

```bash
task deps:log-viewer
```

Install the app's dependencies:

```shell
Expand Down
56 changes: 14 additions & 42 deletions taskfiles/deps.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
version: "3"

includes:
yscope-dev-utils: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"

vars:
# Utility script path
G_DEP_DOWNLOAD_SCRIPT: "{{.ROOT_DIR}}/tools/scripts/deps-download/download-dep.py"
Expand All @@ -24,9 +28,9 @@ vars:

tasks:
default:
cmds:
- task: "core"
- task: "log-viewer"
deps:
- "core"
- "log-viewer"

core:
vars:
Expand Down Expand Up @@ -63,15 +67,14 @@ tasks:
>> "{{.G_DEPS_CORE_CHECKSUM_FILE}}"

log-viewer:
sources:
- "{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
generates: ["{{.G_DEPS_LOG_VIEWER_CHECKSUM_FILE}}"]
deps: ["all-internal-deps"]
cmds:
- >-
cat
"{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
>> "{{.G_DEPS_LOG_VIEWER_CHECKSUM_FILE}}"
- task: "yscope-dev-utils:remote:download-and-extract-tar"
vars:
CHECKSUM_FILE: "{{.G_DEPS_LOG_VIEWER_CHECKSUM_FILE}}"
FILE_SHA256: "de0600b505545f1bceb7ff5725941035f7c1dc875d08249d9b6d679e3ba77f26"
OUTPUT_DIR: "{{.G_LOG_VIEWER_WEBUI_SRC_DIR}}/yscope-log-viewer"
URL: "https://github.com/y-scope/yscope-log-viewer/archive/969ff35.tar.gz"
TAR_FILE: "{{.G_BUILD_DIR}}/yscope-log-viewer.tar.gz"

# NOTE: `git submodule update` doesn't support parallel invocations, so we can't use it to
# download submodules in parallel. This means:
Expand Down Expand Up @@ -101,7 +104,6 @@ tasks:
- task: "sqlite3"
- task: "utfcpp"
- task: "yaml-cpp"
- task: "yscope-log-viewer"
- task: "ystdlib-cpp"

abseil-cpp:
Expand Down Expand Up @@ -437,36 +439,6 @@ tasks:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.DEST}}"]

yscope-log-viewer:
internal: true
vars:
CHECKSUM_FILE: "{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
DEST: "{{.G_LOG_VIEWER_WEBUI_SRC_DIR}}/yscope-log-viewer"
sources:
- "{{.G_DEP_DOWNLOAD_SCRIPT}}"
- "{{.G_UTILS_TASKFILE}}"
- "{{.ROOT_DIR}}/taskfile.yaml"
- "{{.TASKFILE}}"
generates: ["{{.CHECKSUM_FILE}}"]
deps:
- ":init"
- task: ":utils:checksum:validate"
vars:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.DEST}}"]
cmds:
- task: "download-dependency"
vars:
DEST: "{{.DEST}}"
FLAGS: "--extract"
SRC_NAME: "yscope-log-viewer-969ff35b2387bcdc3580b441907e3656640ce16d"
SRC_URL: "https://github.com/y-scope/yscope-log-viewer/archive/969ff35.zip"
# This command must be last
- task: ":utils:checksum:compute"
vars:
CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
INCLUDE_PATTERNS: ["{{.DEST}}"]

ystdlib-cpp:
internal: true
vars:
Expand Down
Loading