(#3194) Add command to purge cached queries #3209

AdmiringWorm · 2023-06-09T11:00:19Z

Description Of Changes

The changes in this PR adds a new command to Chocolatey CLI
that allows the user to clear any cached queries that have been saved
on their system.
This will clear both system and user level caches when running as an
administrator, and user level caches when running in a non-elevated
context.

Additionally, the ability to only remove expired caches is added as well
as just listing how many items has been cached.

Motivation and Context

To make it easier for users to clear out any cached items on their system, without having to go to the locations manually.

Testing

What is listed will be highly dependent on your system.

Run choco cache in a non-elevated context.
Ensure the number of cached sources and items are listed for the user level cache only.
Ensure there is a warning about running as an administrator.
Run choco cache in an elevated context.
Ensure the number of cached sources and items are listed for both system and user level caches.
Ensure there is no longer a warning about running as an administrator.
Run choco cache remove in a non-elevated context.
Ensure only the the user level cached items are removed.
Run choco cache remove in a elevated context.
Ensure both system and user level cached items are removed.
Run choco search chocolatey with the chocolatey source enabled in both elevated and non-elevated context.
Run choco cache remove --expired in an elevated context
Ensure no items was removed.
Run choco cache get
Ensure a warning is outputted that get is an unknown command, and list will be used.

Help description check

Run choco -h
Ensure v2.1.0 is listed together with the cache command.
Run choco cache -h
Ensure all values looks appropriate and nothing seems off.

Operating Systems Testing

Windows 10

Change Types Made

Bug fix (non-breaking change).
Feature / Enhancement (non-breaking change).
Breaking change (fix or feature that could cause existing functionality to change).
Documentation changes.
PowerShell code changes.

Change Checklist

Requires a change to the documentation.
Documentation has been updated.
Tests to cover my changes, have been added.
All new and existing tests passed?
PowerShell code changes: PowerShell v2 compatibility checked?

Related Issue

Fixes #3194

gep13 · 2023-06-16T06:34:57Z

I am not sure what this is referring to:

Ensure there is a warning about running as an administrator.

I didn't see any warning. Can you confirm what is expected here?

src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs

src/chocolatey/infrastructure.app/commands/ChocolateyCommandBase.cs

src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs

src/chocolatey/infrastructure.app/configuration/ChocolateyConfiguration.cs

gep13 · 2023-06-16T07:18:59Z

@pauby can I get you to put your eyes on this section of the PR: https://github.com/chocolatey/choco/pull/3209/files#diff-798be7ca9a8afe2aa34a870384e9b9bfefa7155703b839c1262e3bc798ca02b2R168-R173 Looking for some feedback on the wording of the command help description. Thanks

gep13 · 2023-06-16T07:35:50Z

@AdmiringWorm just thinking about this as well... can we get some tests added to the CacheCommand class, even just verification that the options are available, etc. Similar to what was done with the export command. If there are any easy wins in terms of Pester tests as well, it would be good to get those added in as well.

This changes how the help output is implemented in Chocolatey CLI. It adds the handling of outputting the majority of the help output in the class called ChocolateyCommandBase that can be used to writing help documentation easier, and instead of thinking about the structure of the output instead needs to override specific methods to give the information that is needed. Some defaults are additionally handled as well to make common output be easier and more maintainable.

The changes here allows the displaying of what version a command was implemented in more easily. THis gives more information to a user whether a command is available to them ore not when viewing the documentation on the website.

src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs

AdmiringWorm · 2023-06-16T10:46:58Z

I am not sure what this is referring to:

Ensure there is a warning about running as an administrator.

I didn't see any warning. Can you confirm what is expected here?

When running as in a non-elevated context, a warning will be outputted running as an administrator is required to clean out the system http cache.

src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs

src/chocolatey.tests/infrastructure.app/commands/ChocolateyCacheCommandSpecs.cs

gep13 · 2023-06-20T06:46:02Z

Running through the tests again, I can't replicate this step:

Ensure there is a warning about running as an administrator.

I see a warning about running as an Administrator when choco cache remove is run, but not when running choco cache list. Can you confirm that this is intended?

The requested changes have been made.

gep13

LGTM!

gep13 · 2023-06-20T07:01:25Z

@AdmiringWorm aside from confirmation about Step 3 above, this looks good to me, and I would say is ready to be merged.

AdmiringWorm · 2023-06-20T11:57:54Z

Running through the tests again, I can't replicate this step:

Ensure there is a warning about running as an administrator.

I see a warning about running as an Administrator when choco cache remove is run, but not when running choco cache list. Can you confirm that this is intended?

I don't have any specific reason for not adding it. It just seemed to be useful in a remove scenario. I can also add it for listing the cache stats if it makes sense to have it there.

EDIT: Actually, looking at the steps again. This may have been an oversight on my part. Let me check

The changes in this commit adds a new command to Chocolatey CLI that allows the user to clear any cached queries that have been saved on their system. This will clear both system and user level caches when running as an administrator, and user level caches when running in a non-elevated context. Additionally, the ability to only remove expired caches is added as well as just listing how many items has been cached.

The change here updates the editorconfig file to default to using a block body instead of an expression. This helps when using any of the Visual Studio features when generating new methods as it will now create a full method without using expressions for single line methods.

gep13

LGTM!

gep13 · 2023-06-20T13:28:16Z

@AdmiringWorm thank you very much for getting this added!

AdmiringWorm self-assigned this Jun 9, 2023

AdmiringWorm requested a review from gep13 June 9, 2023 11:00

AdmiringWorm force-pushed the cache-clearing-command branch 3 times, most recently from f6baa19 to 673aae8 Compare June 15, 2023 16:27

gep13 requested changes Jun 16, 2023

View reviewed changes

gep13 requested a review from pauby June 16, 2023 07:18

AdmiringWorm added 2 commits June 16, 2023 11:27

(maint) Add ability to display version on command

d64de0e

The changes here allows the displaying of what version a command was implemented in more easily. THis gives more information to a user whether a command is available to them ore not when viewing the documentation on the website.

AdmiringWorm force-pushed the cache-clearing-command branch from 673aae8 to a4f9f16 Compare June 16, 2023 09:28

pauby requested changes Jun 16, 2023

View reviewed changes

AdmiringWorm force-pushed the cache-clearing-command branch from a4f9f16 to 2fd8aa6 Compare June 16, 2023 10:21

AdmiringWorm requested review from gep13 and pauby June 16, 2023 10:21

pauby previously requested changes Jun 16, 2023

View reviewed changes

src/chocolatey/infrastructure.app/commands/ChocolateyCacheCommand.cs Outdated Show resolved Hide resolved

gep13 reviewed Jun 16, 2023

View reviewed changes

src/chocolatey.tests/infrastructure.app/commands/ChocolateyCacheCommandSpecs.cs Show resolved Hide resolved

AdmiringWorm force-pushed the cache-clearing-command branch 3 times, most recently from 794bc0e to e567d49 Compare June 19, 2023 19:26

gep13 force-pushed the cache-clearing-command branch from e567d49 to 24fd61a Compare June 20, 2023 06:59

gep13 previously approved these changes Jun 20, 2023

View reviewed changes

AdmiringWorm added 3 commits June 20, 2023 14:31

(maint) Normalize line endings in Command Base class

1d67bcf

(maint) Include warning messages in docs output

47d9f75

AdmiringWorm dismissed gep13’s stale review via 47d9f75 June 20, 2023 12:32

AdmiringWorm force-pushed the cache-clearing-command branch from 24fd61a to 47d9f75 Compare June 20, 2023 12:32

gep13 approved these changes Jun 20, 2023

View reviewed changes

gep13 merged commit 45ef807 into chocolatey:develop Jun 20, 2023
5 checks passed

AdmiringWorm deleted the cache-clearing-command branch September 25, 2023 12:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(#3194) Add command to purge cached queries #3209

(#3194) Add command to purge cached queries #3209

AdmiringWorm commented Jun 9, 2023 •

edited

Loading

gep13 commented Jun 16, 2023

gep13 commented Jun 16, 2023

gep13 commented Jun 16, 2023

AdmiringWorm commented Jun 16, 2023

gep13 commented Jun 20, 2023

gep13 left a comment

gep13 commented Jun 20, 2023

AdmiringWorm commented Jun 20, 2023 •

edited

Loading

gep13 left a comment

gep13 commented Jun 20, 2023

(#3194) Add command to purge cached queries #3209

(#3194) Add command to purge cached queries #3209

Conversation

AdmiringWorm commented Jun 9, 2023 • edited Loading

Description Of Changes

Motivation and Context

Testing

Operating Systems Testing

Change Types Made

Change Checklist

Related Issue

gep13 commented Jun 16, 2023

gep13 commented Jun 16, 2023

gep13 commented Jun 16, 2023

AdmiringWorm commented Jun 16, 2023

gep13 commented Jun 20, 2023

gep13 left a comment

Choose a reason for hiding this comment

gep13 commented Jun 20, 2023

AdmiringWorm commented Jun 20, 2023 • edited Loading

gep13 left a comment

Choose a reason for hiding this comment

gep13 commented Jun 20, 2023

AdmiringWorm commented Jun 9, 2023 •

edited

Loading

AdmiringWorm commented Jun 20, 2023 •

edited

Loading