batches: display rollout windows configuration in user settings #50479

BolajiOlajide · 2023-04-07T17:04:36Z

When rollout windows are configured on a Sourcegraph instance, there's no way for non-site admins to know the window that has been configured. We are displaying this window (if configured), in the Batch Changes section of the UserSettings area.

Test plan

Test 1

Navigate to the Batch Changes User Settings page /users/<username>/settings/batch-changes on a Sourcegraph instance without rollout windows configured.
A section for rollout windows will be shown, with a link to configure rollout windows for Batch Changes.

Test 2

Navigate to the Batch Changes User Settings page /users/<username>/settings/batch-changes on a Sourcegraph instance with rollout windows configured.
You should see a section containing the configuration of the rollout windows.

App preview:

Web

Check out the client app preview documentation to learn more.

sourcegraph-bot · 2023-04-07T17:06:31Z

Codenotify: Notifying subscribers in CODENOTIFY files for diff 5072054...60071fa.

Notify	File(s)
@courier-new	client/web/src/enterprise/batches/backend.ts client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.module.scss client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.story.tsx client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.tsx client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.module.scss client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.story.tsx client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.tsx client/web/src/enterprise/batches/settings/format.test.ts client/web/src/enterprise/batches/settings/format.ts client/web/src/enterprise/batches/settings/mocks.ts
@eseliger	client/web/src/enterprise/batches/backend.ts client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.module.scss client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.story.tsx client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.tsx client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.module.scss client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.story.tsx client/web/src/enterprise/batches/settings/RolloutWindowsConfiguration.tsx client/web/src/enterprise/batches/settings/format.test.ts client/web/src/enterprise/batches/settings/format.ts client/web/src/enterprise/batches/settings/mocks.ts

sg-e2e-regression-test-bob · 2023-04-07T17:12:13Z

Bundle size report 📦

Initial size	Total size	Async size	Modules
0.00% (+0.13 kb)	0.05% (+7.10 kb)	0.06% (+6.96 kb)	0.00% (0)

Look at the Statoscope report for a full comparison between the commits 60071fa and 5072054 or learn more.

Open explanation

Initial size is the size of the initial bundle (the one that is loaded when you open the page)
Total size is the size of the initial bundle + all the async loaded chunks
Async size is the size of all the async loaded chunks
Modules is the number of modules in the initial bundle

courier-new

I love the design you came up with for this! 😄 Left several comments but they're all pretty minor so here's a ✅ to go along with them.

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.story.tsx

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.tsx

sourcegraph-bot · 2023-05-05T02:17:32Z

📖 Storybook live preview

courier-new

This looks great; the refactor to use the site query makes a lot of sense to me, too. Left a couple nits, but really great work here! 🙌

Once this is merged, can we safely revert https://github.com/sourcegraph/sourcegraph/pull/50471, too?

courier-new · 2023-05-09T00:45:23Z

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.tsx

        <UserCodeHostConnections
            headerLine={<Text>Add access tokens to enable Batch Changes changeset creation on your code hosts.</Text>}
            userID={props.user.id}
        />
    </div>
 )
+
+// Displays the rollout window configuration.
+export const RolloutWindowsConfiguration: React.FunctionComponent = () => {


Nit: Could we give this its own file, like we do with UserCodeHostConnections?

Sure thing.

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.tsx

client/web/src/enterprise/batches/settings/BatchChangesSettingsArea.story.tsx

courier-new · 2023-05-09T00:48:52Z

client/web/src/enterprise/batches/settings/format.ts

+ * Formats the days of the week for a rollout window for display.
+ *
+ * If days are provided, joins them with commas and capitalizes each day name.
+ * Otherwise returns 'every other day' as the default.


Sorry if this is glaringly obvious, but why is "every other day" the default?

Oh no, it's okay; the statement is technically wrong. I'll reword it.

* If days are provided, join them with commas and capitalize each day's name. * Otherwise, returns 'every other day'.

courier-new · 2023-05-09T00:53:28Z

client/web/src/enterprise/batches/settings/format.ts

+/**
+ * Formats the rollout window rate for display.
+ *
+ * According to the schema, if the rate is a number then it can only be zero.


Can you tell, do we actually validate if you provide a number other than 0? I don't remember if I've tried. I wonder if it's worth actually assuming that we haven't validated that here (so only returning "None" if it's actually rate: 0), and showing "invalid configuration" with the little warning indicator if we get a bad rate like rate: 7 or rate: 200/24 hours.

This doesn't need to happen in this PR; we could log that as an enhancement. Just something that came to mind that could also be useful here.

We do have a validation of the rate field when it's added. I've added screenshots above.

client/web/src/enterprise/batches/settings/format.test.ts

CHANGELOG.md

BolajiOlajide · 2023-05-10T12:11:20Z

This looks great; the refactor to use the site query makes a lot of sense to me, too. Left a couple nits, but really great work here! 🙌

Once this is merged, can we safely revert #50471, too?

Not yet. I have one more PR to remove the JSContext field for rollout configuration in the Bulk Actions dropdown view.

Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

…sArea.tsx Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

…#51560) Make the web application bundle independent from the `//client/web/src/integration` and `//client/shared/src/testing`. It significantly slows down the Percy changes I iterate on locally. Previously they were connected via multiple mock files and the shared `isHotReloadEnabled` variable. The variable is redundant now, and the mock files are correctly moved to the `web_tests` target out of `web_lib`.

Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

BolajiOlajide added the batch-changes Issues related to Batch Changes label Apr 7, 2023

BolajiOlajide requested a review from a team April 7, 2023 17:04

BolajiOlajide self-assigned this Apr 7, 2023

cla-bot bot added the cla-signed label Apr 7, 2023

BolajiOlajide force-pushed the bo/display-rollout-windows-batch-changes-user-settings branch from ec3ee2c to 7173dd9 Compare April 12, 2023 10:11

courier-new approved these changes Apr 24, 2023

View reviewed changes

BolajiOlajide force-pushed the bo/display-rollout-windows-batch-changes-user-settings branch 2 times, most recently from c8222f8 to 0585d61 Compare May 5, 2023 02:09

courier-new approved these changes May 9, 2023

View reviewed changes

BolajiOlajide force-pushed the bo/display-rollout-windows-batch-changes-user-settings branch from 5200636 to 52d727b Compare May 10, 2023 12:46

BolajiOlajide and others added 16 commits May 10, 2023 19:45

display rollout window configuration

7d807f6

remove comment

848f2c7

add storybook

fa18ef8

prettier

abee274

refactor CSS to BEM

624d34f

changelog entry

2078c6e

refactor logic for displaying rollout windows

3f782e0

move format functions into own module

3193d0b

update storybook

d4d2a02

update bazel

da6d1c1

update changelog

b3fd51b

remove debug statements`

17638ab

Update CHANGELOG.md

caab857

Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

Update client/web/src/enterprise/batches/settings/BatchChangesSetting…

9e1e223

…sArea.tsx Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

codeintel: Add blocklist for autoindexing (#51578)

7379afb

BolajiOlajide and others added 11 commits May 10, 2023 19:45

changelog entry

ee54720

update bazel

6ac13e1

update changelog

6dfb043

Update CHANGELOG.md

c63dd5d

Co-authored-by: Kelli Rockwell <kelli@sourcegraph.com>

update comment

7942d81

add time to storybook

7689827

move rollout windows configuration to separate file

637b47c

bazel configure

f8dd4ec

cleanup changelog

6d42523

remove duplicate changelog entry

1cbf622

remove unrelated bazel config

60071fa

BolajiOlajide force-pushed the bo/display-rollout-windows-batch-changes-user-settings branch from 713faa7 to 60071fa Compare May 10, 2023 17:46

BolajiOlajide merged commit 5bd03cd into main May 10, 2023

BolajiOlajide deleted the bo/display-rollout-windows-batch-changes-user-settings branch May 10, 2023 18:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

batches: display rollout windows configuration in user settings #50479

batches: display rollout windows configuration in user settings #50479

BolajiOlajide commented Apr 7, 2023 •

edited

Loading

sourcegraph-bot commented Apr 7, 2023 •

edited

Loading

sg-e2e-regression-test-bob commented Apr 7, 2023 •

edited by sourcegraph-buildkite

Loading

courier-new left a comment

sourcegraph-bot commented May 5, 2023 •

edited

Loading

courier-new left a comment

courier-new May 9, 2023

BolajiOlajide May 10, 2023

courier-new May 9, 2023

BolajiOlajide May 9, 2023 •

edited

Loading

courier-new May 9, 2023

BolajiOlajide May 9, 2023

BolajiOlajide commented May 10, 2023

batches: display rollout windows configuration in user settings #50479

batches: display rollout windows configuration in user settings #50479

Conversation

BolajiOlajide commented Apr 7, 2023 • edited Loading

Test plan

Test 1

Test 2

App preview:

sourcegraph-bot commented Apr 7, 2023 • edited Loading

sg-e2e-regression-test-bob commented Apr 7, 2023 • edited by sourcegraph-buildkite Loading

Bundle size report 📦

courier-new left a comment

Choose a reason for hiding this comment

sourcegraph-bot commented May 5, 2023 • edited Loading

courier-new left a comment

Choose a reason for hiding this comment

courier-new May 9, 2023

Choose a reason for hiding this comment

BolajiOlajide May 10, 2023

Choose a reason for hiding this comment

courier-new May 9, 2023

Choose a reason for hiding this comment

BolajiOlajide May 9, 2023 • edited Loading

Choose a reason for hiding this comment

courier-new May 9, 2023

Choose a reason for hiding this comment

BolajiOlajide May 9, 2023

Choose a reason for hiding this comment

BolajiOlajide commented May 10, 2023

BolajiOlajide commented Apr 7, 2023 •

edited

Loading

sourcegraph-bot commented Apr 7, 2023 •

edited

Loading

sg-e2e-regression-test-bob commented Apr 7, 2023 •

edited by sourcegraph-buildkite

Loading

sourcegraph-bot commented May 5, 2023 •

edited

Loading

BolajiOlajide May 9, 2023 •

edited

Loading