Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Make caching more verbose - #650

Merged
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main
Jan 19, 2021
Merged

Make caching more verbose#650
yacaovsnc merged 1 commit into
actions:mainfrom
rosik:main

Conversation

@rosik

@rosikrosik commented Nov 25, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Print cache size when saving cache (similar to restoring)
  • Print restore success (similar to saving)
  • Print cached file list (if debug logging is enabled)

This makes logs of saving and restoring cache more similar to each other.

image

image

Part of actions/cache#471

@rosik

rosik commented Dec 1, 2020

Copy link
Copy Markdown
ContributorAuthor

Hi, guys. Could someone review my patch, please?

@rosik

rosik commented Dec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan ?

joshmgross
joshmgross reviewed Dec 3, 2020
View reviewed changes
Comment threadpackages/cache/src/cache.ts Outdated
options
)

await listTar(archivePath, compressionMethod)

@joshmgrossjoshmgrossDec 3, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Listing out the contents of the tar file might not be ideal in all scenarios. If users are concerned more about cache speed than log verbosity, we should consider making this optional.

@rosikrosikDec 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Thanks for your review. I've added it under if (core.isDebug()) conditinal.

@rosikrosikDec 7, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I'd like to note that @actions/glob also has its own debug output, but it's not the same as listTar:

image

@rosik
rosik requested a review from joshmgrossDecember 3, 2020 22:08
@joshmgross
joshmgross requested a review from a teamDecember 4, 2020 22:54
@rosik

rosik commented Dec 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Dec 17, 2020

Copy link
Copy Markdown
ContributorAuthor

@joshmgross I've updated the PR a week ago. Do you expect from me any other actions or do I miss something?

@joshmgross

joshmgross commented Dec 17, 2020

Copy link
Copy Markdown
Contributor

@aiqiaoy or @yacaovsnc could you take a look at this PR?

@yacaovsnc

yacaovsnc commented Dec 18, 2020

Copy link
Copy Markdown
Contributor

Thanks @rosik for the PR. Could you please add a test for the listTar method you created? The tests are here: https://github.com/actions/toolkit/blob/main/packages/cache/__tests__/tar.test.ts

@rosik
rosikforce-pushed the main branch 3 times, most recently from 856f207 to 967b069CompareDecember 20, 2020 20:31
@rosik

rosik commented Dec 20, 2020

Copy link
Copy Markdown
ContributorAuthor

I've added a unit test, but I'm worried it's not covered by an end-to-end test. The listTar function is only called when ACTIONS_STEP_DEBUG is set, so it's not run in PR checks: https://github.com/actions/toolkit/pull/650/checks?check_run_id=1585714569. What do you think? If it's desirable, could you give me a hint on how to implement it?

@yacaovsnc

yacaovsnc commented Jan 4, 2021

Copy link
Copy Markdown
Contributor

Sorry for the silence, I was out for the last couple weeks. Personally I think it's fine that this isn't covered in the end-to-end test - to test that we need to set ACTIONS_STEP_DEBUG as a secret value.

FWIW, I forked the repo and set ACTIONS_STEP_DEBUG in my repo setting, and saw the additional debug messages. If really desired, an admin of this repo can enable debug? I don't think it blocks this PR anyway.

yacaovsnc
yacaovsnc approved these changes Jan 4, 2021
View reviewed changes

@yacaovsncyacaovsnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR. Looks good to me.

@rosik
Make caching more verbose
bfdba95
- Print cache size when saving cache similarly to restoring
- Print restore success similarly to saving
- Print cached file list if debug logging is enabled
See also: actions/cache#471
@rosik

rosik commented Jan 7, 2021

Copy link
Copy Markdown
ContributorAuthor

If you ask for my opinion, I vote for enabling ACTIONS_STEP_DEBUG in the main repo. It sounds helpful for the coverage.

So, what's next? I've rebased my patch on top of the fresh main branch. Do you expect any other actions from me now?

@rosik

rosik commented Jan 13, 2021

Copy link
Copy Markdown
ContributorAuthor

Ping

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

@dhadka@joshmgross@konradpabjan@aiqiaoy@yacaovsnc ping

@yacaovsnc
yacaovsnc merged commit 8252049 into actions:mainJan 19, 2021
@yacaovsnc

yacaovsnc commented Jan 19, 2021

Copy link
Copy Markdown
Contributor

@rosik the cache action can include this change after we release a new npm package. Are you waiting for this change?

@konradpabjan let's include this change next time we release. Do you handle npm releases for cache toolkit too?

@rosik

rosik commented Jan 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Are you waiting for this change?

So so. We can always invent a workaround for debugging, but it's usually a little bit nasty.

This was referenced Jan 19, 2021
Merged
Closed
@konradpabjankonradpabjan mentioned this pull request Feb 3, 2021
Merged
This was referenced Mar 6, 2021
Merged
Closed
This was referenced Mar 17, 2021
Closed
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Merged
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Closed
Closed
Merged
Closed
Merged
Closed
Closed
Merged
Closed
Closed
Closed
@dhadkadhadka mentioned this pull request Apr 12, 2021
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dhadkadhadkaAwaiting requested review from dhadka
@joshmgrossjoshmgrossAwaiting requested review from joshmgross
1 more reviewer
@yacaovsncyacaovsncyacaovsnc approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rosik@joshmgross@yacaovsnc