feat: introduce experimental feature switch by qweeah · Pull Request #613 · notaryproject/notation

qweeah · 2023-04-04T11:41:33Z

This PR introduces an environmental variable, NOTATION_EXPERIMENTAL, as the switch for experimental features

If NOTATION_EXPERIMENTAL set to 1, then experimental features are enabled. All experimental features can be used with a prompt in the stderr output:

Caution: This feature is experimental and may not be fully tested or completed and may be deprecated. Report any issues to "https://github/notaryproject/notation"

Otherwise experimental features are disabled, using an experimental command will show

Error: "<COMMAND>" been marked as experimental and not enabled by default. To use it, please set NOTATION_EXPERIMENTAL=1 in your environment

or

Error: flags(s) --<FLAG1>,--<FLAG2> in "<COMMAND>" been marked as experimental and not enabled by default. To use it, please set NOTATION_EXPERIMENTAL=1 in your environment

Resolves #614.

codecov-commenter · 2023-04-04T11:46:43Z

Codecov Report

Merging #613 (82e78a2) into main (0ec3b3d) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #613   +/-   ##
=======================================
  Coverage   34.43%   34.43%           
=======================================
  Files          32       32           
  Lines        1844     1844           
=======================================
  Hits          635      635           
  Misses       1188     1188           
  Partials       21       21

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

specs/notation-cli.md

cmd/notation/policy/cmd.go

internal/experimental/experimental.go

yizha1

One comment on sub-commands.

specs/notation-cli.md

qweeah · 2023-04-11T01:09:29Z

@priteshbandi I have removed policy changes, can you help review the implementation

@yizha1 @FeynmanZhou @iamsamirzon @toddysm can you help review the user experience as well as the wording for the output in the PR description, thanks!

internal/experimental/experimental.go

patrickzheng200

LGTM

priteshbandi · 2023-04-13T01:17:33Z

internal/experimental/experimental.go

+
+// IsDisabled determines whether an experimental feature is disabled.
+func IsDisabled() bool {
+	return os.Getenv(envName) != enabled


should we trim the white spaces here, for both key and value?

For what purpose do we need to trim key and value?

In scenario where user calls following command to set env variable.
export NOTATION_EXPERIMENTAL=" 1"

Its an edge case, I am fine to ignore this.

priteshbandi · 2023-04-13T01:19:15Z

internal/experimental/experimental.go

+
+// Error returns an error for a disabled experimental feature.
+func Error(description string) error {
+	return fmt.Errorf("%s been marked as experimental and not enabled by default. To use it, please set %s=%s in your environment", description, envName, enabled)


Suggested change

return fmt.Errorf("%s been marked as experimental and not enabled by default. To use it, please set %s=%s in your environment", description, envName, enabled)

return fmt.Errorf("%s is experimental and not enabled by default. To use, please set %s=%s environment variable", description, envName, enabled)

Changed accordingly. There is a case when multiple experimental flags the warning can be

flag(s) --foo,--bar,--baz in "notation test" is experimental and not enabled by default. To use, please set %s=%s environment variable

I am okay with the is here, @patrickzheng200 what do you think.

Changed accordingly. There is a case when multiple experimental flags the warning can be

flag(s) --foo,--bar,--baz in "notation test" is experimental and not enabled by default. To use, please set %s=%s environment variable

I am okay with the is here, @patrickzheng200 what do you think.

Yeah, we could have multiple flags marked as experimental, in this case, using is here is not very accurate.

internal/experimental/experimental.go

Signed-off-by: Billy Zha <jinzha1@microsoft.com> clean Signed-off-by: Billy Zha <jinzha1@microsoft.com> hide experimental Signed-off-by: Billy Zha <jinzha1@microsoft.com> fix e2e Signed-off-by: Billy Zha <jinzha1@microsoft.com> code clean Signed-off-by: Billy Zha <jinzha1@microsoft.com> remove policy changes Signed-off-by: Billy Zha <jinzha1@microsoft.com> update flag checker Signed-off-by: Billy Zha <jinzha1@microsoft.com> update type Signed-off-by: Billy Zha <jinzha1@microsoft.com> make output more readable Signed-off-by: Billy Zha <jinzha1@microsoft.com> resolve comments Signed-off-by: Billy Zha <jinzha1@microsoft.com> resolve comments Signed-off-by: Billy Zha <jinzha1@microsoft.com> remove unnecessary change Signed-off-by: Billy Zha <jinzha1@microsoft.com> resolve comments Signed-off-by: Billy Zha <jinzha1@microsoft.com>

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

priteshbandi

LGTM

shizhMSFT

LGTM

This PR introduces an environmental variable, `NOTATION_EXPERIMENTAL`, as the switch for experimental features - If `NOTATION_EXPERIMENTAL` set to `1`, then experimental features are enabled. All experimental features can be used with a prompt in the stderr output: ```console Caution: This feature is experimental and may not be fully tested or completed and may be deprecated. Report any issues to "https://github/notaryproject/notation" ``` - Otherwise experimental features are disabled, using an experimental command will show ```console Error: "<COMMAND>" been marked as experimental and not enabled by default. To use it, please set NOTATION_EXPERIMENTAL=1 in your environment ``` or ```console Error: flags(s) --<FLAG1>,--<FLAG2> in "<COMMAND>" been marked as experimental and not enabled by default. To use it, please set NOTATION_EXPERIMENTAL=1 in your environment ``` Resolves notaryproject#614. --------- Signed-off-by: Billy Zha <jinzha1@microsoft.com>

qweeah requested review from JeyJeyGao, NiazFK, SteveLasker, gokarnm, justincormack, patrickzheng200, priteshbandi, rgnote and shizhMSFT as code owners April 4, 2023 11:41

qweeah force-pushed the experimental branch 3 times, most recently from ab76830 to a90cf97 Compare April 6, 2023 01:39

shizhMSFT reviewed Apr 6, 2023

View reviewed changes

specs/notation-cli.md Outdated Show resolved Hide resolved

specs/notation-cli.md Outdated Show resolved Hide resolved

qweeah force-pushed the experimental branch from 848c8a7 to 82691ed Compare April 7, 2023 01:39

patrickzheng200 mentioned this pull request Apr 8, 2023

feat: add local sign/list/verification for OCI layout directory #595

Merged

patrickzheng200 reviewed Apr 10, 2023

View reviewed changes

cmd/notation/policy/cmd.go Outdated Show resolved Hide resolved

patrickzheng200 reviewed Apr 10, 2023

View reviewed changes

internal/experimental/experimental.go Outdated Show resolved Hide resolved

patrickzheng200 reviewed Apr 10, 2023

View reviewed changes

internal/experimental/experimental.go Outdated Show resolved Hide resolved

internal/experimental/experimental.go Outdated Show resolved Hide resolved

qweeah force-pushed the experimental branch 4 times, most recently from 321757c to 1c31401 Compare April 10, 2023 06:33

yizha1 reviewed Apr 10, 2023

View reviewed changes

specs/notation-cli.md Outdated Show resolved Hide resolved

qweeah force-pushed the experimental branch 3 times, most recently from 728aaf1 to 5c2738d Compare April 11, 2023 00:56

qweeah changed the title ~~feat!: add experimental mark for policy commands~~ feat: introduce experimental feature switch Apr 11, 2023

qweeah force-pushed the experimental branch from 5c2738d to ddf46fc Compare April 11, 2023 01:06

patrickzheng200 reviewed Apr 11, 2023

View reviewed changes

qweeah force-pushed the experimental branch from ddf46fc to 8929b44 Compare April 11, 2023 07:08

patrickzheng200 reviewed Apr 11, 2023

View reviewed changes

internal/experimental/experimental.go Outdated Show resolved Hide resolved

internal/experimental/experimental.go Outdated Show resolved Hide resolved

internal/experimental/experimental.go Outdated Show resolved Hide resolved

qweeah force-pushed the experimental branch 2 times, most recently from 2866e1f to 5dd2527 Compare April 11, 2023 07:57

patrickzheng200 reviewed Apr 11, 2023

View reviewed changes

internal/experimental/experimental.go Outdated Show resolved Hide resolved

internal/experimental/experimental.go Outdated Show resolved Hide resolved

qweeah force-pushed the experimental branch 3 times, most recently from 825c394 to e1bb96f Compare April 12, 2023 03:08

patrickzheng200 previously approved these changes Apr 12, 2023

View reviewed changes

priteshbandi reviewed Apr 13, 2023

View reviewed changes

qweeah added 4 commits April 13, 2023 01:49

resolve comments

b1e8a64

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

resolve comments

94e4104

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

resolve comments

82e78a2

Signed-off-by: Billy Zha <jinzha1@microsoft.com>

qweeah dismissed patrickzheng200’s stale review via 82e78a2 April 13, 2023 01:49

qweeah force-pushed the experimental branch from e1bb96f to 82e78a2 Compare April 13, 2023 01:49

priteshbandi approved these changes Apr 13, 2023

View reviewed changes

shizhMSFT approved these changes Apr 13, 2023

View reviewed changes

shizhMSFT merged commit 24a9719 into notaryproject:main Apr 13, 2023

	return fmt.Errorf("%s been marked as experimental and not enabled by default. To use it, please set %s=%s in your environment", description, envName, enabled)
	return fmt.Errorf("%s is experimental and not enabled by default. To use, please set %s=%s environment variable", description, envName, enabled)

Conversation

qweeah commented Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Apr 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yizha1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qweeah commented Apr 11, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patrickzheng200 left a comment

Choose a reason for hiding this comment

Uh oh!

priteshbandi Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

qweeah Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

priteshbandi Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

priteshbandi Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

qweeah Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

patrickzheng200 Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

priteshbandi left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

qweeah commented Apr 4, 2023 •

edited

Loading

codecov-commenter commented Apr 4, 2023 •

edited

Loading