frontend: Show feature flags in topbar and separate page #1144

almusil · 2020-10-30T07:00:30Z

As discussed in #1129. Opening the frontend part for discussion.

Current implementation look:

pietroalbini · 2020-10-30T10:43:01Z

I'm not sure showing the additional dependencies is much useful, we could simplify the layout like this (showing the features on two columns on desktop):

almusil · 2020-10-30T13:05:20Z

I'm not sure showing the additional dependencies is much useful, we could simplify the layout like this (showing the features on > two columns on desktop):

From my point of view it's useful to know which feature gets enabled by which flag. Especially for default.

On the other hand it would be useful to have at least something to show and the detail can be added later on.

jyn514 · 2020-10-30T14:29:03Z

I also prefer having the features that are enabled shown.

Kixiron · 2020-10-30T15:20:15Z

I think we should show full detail, but on a separate page (placed alongside /builds) with the top bar linking to it

Kixiron · 2020-10-30T15:30:57Z

Made a very rough and out of proportion sketch of what I'm thinking, display the available features on the left, clicking on each "maximizes" it to show all the features and dependencies it activates. This allows us to give as much info as possible (ex. saying if the feature is actually a feature or just an optional dependency) without immediately overwhelming the user.

almusil · 2020-11-05T09:52:23Z

Ok, I have been able to come up with this (I'm really bad at frontend, so please excuse some rough edges):

jyn514 · 2020-11-05T19:10:30Z

I like it! It could be nice to split it into columns like @pietroalbini suggested, but I don't think we need to block on that.

templates/crate/features.html

jyn514

Thanks for sticking with this :)

src/db/types.rs

src/web/crate_details.rs

templates/crate/features.html

templates/rustdoc/topbar.html

templates/crate/features.html

src/web/crate_details.rs

src/web/features.rs

So far features were stored only in database. Add link to the topbar which will lead to the new features page. Features page will show all relevant features with their subfeatures.

jyn514 · 2020-11-10T12:23:24Z

@almusil it's not a big deal, but in the future it would be nice to add changes as additional commits instead of force-pushing. The diff github shows also includes the changes from master. Fortunately here there weren't many changes, but in a big repo like rust-lang/rust it would be unreadable.

(FWIW I consider this a bug in github isaacs/github#1834)

almusil · 2020-11-10T12:25:37Z

@almusil it's not a big deal, but in the future it would be nice to add changes as additional commits instead of force-pushing. The diff github shows also includes the changes from master. Fortunately here there weren't many changes, but in a big repo like rust-lang/rust it would be unreadable.

(FWIW I consider this a bug in github isaacs/github#1834)

Ah right, the ugly thing about this is that every repo has different policy. I'll keep it in mind for future changes in this repo, thanks :)

src/web/crate_details.rs

src/test/fakes.rs

templates/crate/features.html

templates/header/package_navigation.html

templates/rustdoc/topbar.html

Show different page for empty feature flags and null feature flags.

jyn514

This already looks really good and I'm happy to merge it as is :) Some improvements I'd like to see at some point:

Right now the features look like they're unordered:

Could we change it to put features that enable other features first? Or we could get really fancy and do a tree structure, where we put default -- [std, perf, unicode], then std, then perf, then unicode, then, recursively, features that are enabled by std/perf/unicode.
We don't distinguish between optional dependencies and features. Could we add that?
@Nemo157 I think you mentioned a while back you wouldn't want this for your crates - do you still want to add an opt-out to package.metadata.docs.rs?
Could we add some color? Maybe green for default, red for features that enable other features, black otherwise, something like that?

src/web/crate_details.rs

Nemo157 · 2020-11-10T22:56:38Z

@Nemo157 I think you mentioned a while back you wouldn't want this for your crates - do you still want to add an opt-out to package.metadata.docs.rs?

I would, but I wouldn't want to block this on that being added.

I did run across a bug in the feature recording while looking at it though, async-compression 0.3.6 has a tokio-02 and a tokio-03 optional dependency, but these both get recorded and displayed as tokio.

Nemo157 · 2020-11-10T23:00:34Z

templates/crate/features.html

+                {%- if metadata.features -%}
+                    <p>This version has <b>{{ metadata.features | length }}</b> feature flags, <b data-id="default-feature-len">
+                        {%- if metadata.features[0].name == 'default' -%}
+                            {{ metadata.features[0].subfeatures | length }}


This count is wrong when one of the default features activates more features. In bs58 0.4.0 I have default = ["std"] and std = ["alloc"].

Also I think the previous count should be decreased by 1 (if the crate has a default feature), otherwise a crate which activates all its features by default will still say something like "This version has 5 feature flags, 4 of them enabled by default" because default is not counted.

async-compression 0.3.6

I was trying it locally and I can see both tokio-02 and tokio-03.

Since the renamed dependency issue is unrelated to this UI I opened #1175 for it.

almusil · 2020-11-11T06:32:25Z

@jyn514 @Nemo157 What should be addressed by this PR? The default counting to follow the dependencies?

jyn514 · 2020-11-11T06:35:33Z

@almusil if you can fix the bugs Nemo noticed and address my nit I think this is good to merge. The rest can be fixed in follow-ups.

almusil · 2020-11-11T12:51:08Z

@jyn514 Hopefully got it right this time, thanks for all the patience

EDIT: We should also reference #590 as this is addressing that. (I don't know if it can be closed after this merge).

Order features that are enabled by default in flat tree structure. At the same time report correct number of features being enabled by default.

src/web/features.rs

jyn514 · 2020-11-12T17:33:11Z

src/web/features.rs

+        let result = order_features_and_count_default_len(raw);
+        features = Some(result.0);
+        default_len = result.1;


rust-lang/rust#71156 would help with this :) 'coming soon to rust versions near you'

That will be nice :)

src/web/features.rs

By making it more modular it is easier to add unit tests fro current behavior.

jyn514 · 2020-11-13T22:58:48Z

I think further improvements can be done in follow-ups. Thanks so much for working on this, I've wanted this in docs.rs for a while ❤️

almusil · 2020-11-15T07:22:31Z

Happy to help :) Thank you for your patience. If you don't mind I would like to continue with improvements to this feature.

jyn514 · 2020-11-15T11:17:09Z

Sounds great! If you want to talk about ideas we have a discord channel for docs.rs

This patch changes one detail implemented in rust-lang#1144. The features flag sorting was by "number of subfeatures". Now it by feature alphabetically. It also ensure that the "default" feature stays on top of the list.

jyn514 added the A-frontend Area: Web frontend label Oct 30, 2020

jyn514 added the S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed label Oct 30, 2020

jyn514 added S-waiting-on-author Status: This PR is incomplete or needs to address review comments and removed S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed labels Nov 4, 2020

almusil force-pushed the feature_frontend branch from 7d69c80 to dbbd70b Compare November 5, 2020 09:51

jyn514 added S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed and removed S-waiting-on-author Status: This PR is incomplete or needs to address review comments labels Nov 5, 2020

jyn514 reviewed Nov 5, 2020

View reviewed changes

templates/crate/features.html Outdated Show resolved Hide resolved

almusil force-pushed the feature_frontend branch from dbbd70b to 008a04a Compare November 9, 2020 06:49

almusil changed the title ~~WIP: frontend: Show feature flags in topbar~~ frontend: Show feature flags in topbar and separate page Nov 9, 2020

jyn514 reviewed Nov 10, 2020

View reviewed changes

frontend: Show feature flags

2df55ef

So far features were stored only in database. Add link to the topbar which will lead to the new features page. Features page will show all relevant features with their subfeatures.

almusil force-pushed the feature_frontend branch from 008a04a to 2df55ef Compare November 10, 2020 10:23

jyn514 reviewed Nov 10, 2020

View reviewed changes

frontend: Distinguish between empty and null features

902515f

Show different page for empty feature flags and null feature flags.

almusil force-pushed the feature_frontend branch from acb70af to 902515f Compare November 10, 2020 16:33

jyn514 approved these changes Nov 10, 2020

View reviewed changes

src/web/crate_details.rs Outdated Show resolved Hide resolved

Nemo157 reviewed Nov 10, 2020

View reviewed changes

jyn514 added S-waiting-on-author Status: This PR is incomplete or needs to address review comments and removed S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed labels Nov 11, 2020

frontend: Order default features in tree structure

1937862

Order features that are enabled by default in flat tree structure. At the same time report correct number of features being enabled by default.

almusil force-pushed the feature_frontend branch from 33bdd95 to 1937862 Compare November 11, 2020 13:02

jyn514 reviewed Nov 12, 2020

View reviewed changes

src/web/features.rs Outdated Show resolved Hide resolved

src/web/features.rs Outdated Show resolved Hide resolved

almusil force-pushed the feature_frontend branch from 88890a7 to 04e3ce3 Compare November 12, 2020 09:26

jyn514 reviewed Nov 12, 2020

View reviewed changes

frontend: Make features code more modular

6730aa2

By making it more modular it is easier to add unit tests fro current behavior.

almusil force-pushed the feature_frontend branch from 04e3ce3 to 6730aa2 Compare November 12, 2020 19:01

jyn514 merged commit 6a81b64 into rust-lang:master Nov 13, 2020

almusil deleted the feature_frontend branch November 16, 2020 08:26

jyn514 mentioned this pull request Nov 16, 2020

Feature request: list crate features at the top of package index.html #590

Closed

apiraino mentioned this pull request Mar 17, 2021

Sort crate features by name #1320

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

frontend: Show feature flags in topbar and separate page #1144

frontend: Show feature flags in topbar and separate page #1144

almusil commented Oct 30, 2020

pietroalbini commented Oct 30, 2020

almusil commented Oct 30, 2020 •

edited

Loading

jyn514 commented Oct 30, 2020

Kixiron commented Oct 30, 2020

Kixiron commented Oct 30, 2020

almusil commented Nov 5, 2020

jyn514 commented Nov 5, 2020

jyn514 left a comment

jyn514 commented Nov 10, 2020 •

edited

Loading

almusil commented Nov 10, 2020 •

edited

Loading

jyn514 left a comment

Nemo157 commented Nov 10, 2020 •

edited

Loading

Nemo157 Nov 10, 2020

almusil Nov 11, 2020

Nemo157 Nov 11, 2020

almusil commented Nov 11, 2020

jyn514 commented Nov 11, 2020

almusil commented Nov 11, 2020 •

edited

Loading

jyn514 Nov 12, 2020

almusil Nov 12, 2020

jyn514 commented Nov 13, 2020

almusil commented Nov 15, 2020

jyn514 commented Nov 15, 2020

frontend: Show feature flags in topbar and separate page #1144

frontend: Show feature flags in topbar and separate page #1144

Conversation

almusil commented Oct 30, 2020

pietroalbini commented Oct 30, 2020

almusil commented Oct 30, 2020 • edited Loading

jyn514 commented Oct 30, 2020

Kixiron commented Oct 30, 2020

Kixiron commented Oct 30, 2020

almusil commented Nov 5, 2020

jyn514 commented Nov 5, 2020

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 commented Nov 10, 2020 • edited Loading

almusil commented Nov 10, 2020 • edited Loading

jyn514 left a comment

Choose a reason for hiding this comment

Nemo157 commented Nov 10, 2020 • edited Loading

Nemo157 Nov 10, 2020

Choose a reason for hiding this comment

almusil Nov 11, 2020

Choose a reason for hiding this comment

Nemo157 Nov 11, 2020

Choose a reason for hiding this comment

almusil commented Nov 11, 2020

jyn514 commented Nov 11, 2020

almusil commented Nov 11, 2020 • edited Loading

jyn514 Nov 12, 2020

Choose a reason for hiding this comment

almusil Nov 12, 2020

Choose a reason for hiding this comment

jyn514 commented Nov 13, 2020

almusil commented Nov 15, 2020

jyn514 commented Nov 15, 2020

almusil commented Oct 30, 2020 •

edited

Loading

jyn514 commented Nov 10, 2020 •

edited

Loading

almusil commented Nov 10, 2020 •

edited

Loading

Nemo157 commented Nov 10, 2020 •

edited

Loading

almusil commented Nov 11, 2020 •

edited

Loading