#9131: Slice 3 - deactivate all team mods not in a deployment #9148

grahamlangford · 2024-09-12T20:15:15Z

What does this PR do?

Closes Slice 3: Deactivate all team mods NOT in a deployment #9131

Demo

https://pixiebrix.slack.com/archives/C02RAMRDF0R/p1726260232672069

Future Work

Refactor syncDeployments to reduce complexity
Rename organizations -> teams
use the me transformer in backgroundApi

For more information on our expectations for the PR process, see the
code review principles doc

github-actions · 2024-09-12T20:33:09Z

Playwright test results

126 passed
2 flaky
4 skipped

Details

Open report ↗︎
132 tests across 44 suites
41 minutes, 29 seconds
290c823
For more information on how to debug and view this report, see our readme

Flaky tests

chrome › tests/pageEditor/addStarterBrick.spec.ts › Add starter brick to mod
msedge › tests/pageEditor/addStarterBrick.spec.ts › Add starter brick to mod

Skipped tests

chrome › tests/regressions/doNotCloseSidebarOnPageEditorSave.spec.ts › #8104: Do not automatically close the sidebar when saving in the Page Editor
msedge › tests/regressions/doNotCloseSidebarOnPageEditorSave.spec.ts › #8104: Do not automatically close the sidebar when saving in the Page Editor
chrome › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options
msedge › tests/runtime/googleSheetsIntegration.spec.ts › can activate a google spreadsheet mod with config options

codecov · 2024-09-12T21:30:05Z

Codecov Report

Attention: Patch coverage is 67.67677% with 32 lines in your changes missing coverage. Please review.

Project coverage is 74.77%. Comparing base (8318d74) to head (290c823).
Report is 291 commits behind head on main.

Files with missing lines	Patch %	Lines
src/background/teamTrialUpdater.ts	0.00%	26 Missing ⚠️
src/data/service/backgroundApi.ts	28.57%	5 Missing ⚠️
src/background/background.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9148      +/-   ##
==========================================
+ Coverage   74.24%   74.77%   +0.53%     
==========================================
  Files        1332     1360      +28     
  Lines       40817    41842    +1025     
  Branches     7634     7807     +173     
==========================================
+ Hits        30306    31289     +983     
- Misses      10511    10553      +42

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/background/background.ts

grahamlangford · 2024-09-13T13:55:17Z

src/background/deploymentUpdater.ts

-  reloadMode: "queue" | "immediate";
-};
-
-async function saveModComponentStateAndReloadTabs(


extracted to src/background/utils/saveModComponentStateAndReloadTabs

grahamlangford · 2024-09-13T13:55:34Z

src/background/deploymentUpdater.ts

-  }
-}
-
-function deactivateModComponentFromStates(


Duplicate versions in deploymentUpdater and modUpdater and also needed for teamTrialUpdater

extracted to src/background/utils/deactivateModComponent

grahamlangford · 2024-09-13T13:57:41Z

src/background/deploymentUpdater.ts

-  return { options, editor };
-}
-
-async function deactivateModComponentsAndSaveState(


extracted to src/background/utils/deactivateModComponentAndSaveState

grahamlangford · 2024-09-13T13:58:25Z

src/background/deploymentUpdater.ts

@@ -256,35 +173,6 @@ async function deactivateUnassignedDeployments(
  });
 }

-async function deactivateMod(


Duplicate versions in deploymentUpdater and modUpdater and also needed for teamTrialUpdater

extracted to src/background/utils/deactivateMod

grahamlangford · 2024-09-13T13:59:49Z

src/background/modUpdater.test.ts

@@ -230,85 +230,49 @@ describe("fetchModUpdates function", () => {
  });
 });

-describe("deactivateMod function", () => {


Original tests moved to src/background/utils/deactivateMod.test.ts

grahamlangford · 2024-09-13T14:00:57Z

src/background/modUpdater.test.ts

        activatedModComponentFactory({
          _recipe: anotherMod,
        }),
      ],
    });
  });

-  it("should remove the mod components from the options state", async () => {
+  it("should uninstall the context menus", async () => {


Previously handled by modUpdater's deactivateMod. Uninstalling the context menus was the only difference from the version in deploymentUpdater, so I pulled that functionality up to updateMod

grahamlangford · 2024-09-13T14:02:11Z

src/background/modUpdater.ts

- * @param reduxState the current state of the modComponent and editor redux stores
- * @returns the new redux state with the mod component deactivated
- */
-function deactivateModComponent(


See https://github.com/pixiebrix/pixiebrix-extension/pull/9148/files#r1758918291

grahamlangford · 2024-09-13T14:02:31Z

src/background/modUpdater.ts

- * @returns new redux state with the mod components deactivated
- * and the mod components that were deactivated
- */
-export function deactivateMod(


See https://github.com/pixiebrix/pixiebrix-extension/pull/9148/files#r1758926456

grahamlangford · 2024-09-13T14:02:54Z

src/background/modUpdater.ts

-    // will see duplicate menu items because the old/new mod components have different UUIDs.
-    // `updateMods` calls `queueReloadModEveryTab`. Therefore, if the user clicks on a tab where the new version of the
-    // mod component is not loaded yet, they'll get a notification to reload the page.
-    void uninstallContextMenu({ modComponentId: activatedModComponent.id });


This functionality moved to updateMod

grahamlangford · 2024-09-13T14:04:19Z

src/background/teamTrialUpdater.ts

+const UPDATE_INTERVAL_MS = 5 * 60 * 1000;
+
+function initTeamTrialUpdater(): void {


Confirmed with @johnnymetz that it's safe to call /api/organizations as often as we want. Set to 5 minute interval to be similar to the heartbeat, but can be anything

mnholtz · 2024-09-13T15:13:01Z

src/data/service/backgroundApi.ts

+export const getOrganizations = memoizeUntilSettled(
+  async (): Promise<Array<components["schemas"]["Organization"]>> => {
+    expectContext("background");
+    const client = await getApiClient();


Doesn't have to be in this PR, but eventually I can see us extracting the getApiClient logic

src/background/teamTrialUpdater.ts

mnholtz · 2024-09-13T15:54:20Z

src/background/teamTrialUpdater.ts

+  activatedModComponents: ActivatedModComponent[],
+  organizationsWithTrials: Array<components["schemas"]["Organization"]>,
+) {
+  const teamScopes = organizationsWithTrials.map((x) => x.scope);


nit: We should probably be consistent with terminology for teams/organizations, i.e. organizationScopes instead

…create-organization-data-model

…ation.isAdmin

…9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

…/pixiebrix-extension into 9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

…9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

mnholtz · 2024-09-13T21:38:39Z

src/background/teamTrialUpdater.ts

+) {
+  const teamScopes = teamsWithTrials.map((x) => x.scope);
+  return activatedModComponents.filter((x) => {
+    if (x._deployment != null) {


nit: I might add a comment or a doc comment explaining the business use-case behind only deactivated non-deployed team mods

github-actions · 2024-09-13T21:40:40Z

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.

grahamlangford added 2 commits September 12, 2024 15:09

refactor/extract duplicated functions; create syncActivatedModCOmponents

2e1e0f0

run team trial updater in the background

c49d600

grahamlangford linked an issue Sep 12, 2024 that may be closed by this pull request

Slice 3: Deactivate all team mods NOT in a deployment #9131

Closed

grahamlangford requested review from BLoe, twschiller and mnholtz September 12, 2024 20:15

fix modUpdater test, create deactivateMod test

ec5776f

vercel bot deployed to Preview September 12, 2024 21:24 View deployment

twschiller added the enhancement New feature or request label Sep 13, 2024

grahamlangford commented Sep 13, 2024

View reviewed changes

src/background/background.ts Show resolved Hide resolved

grahamlangford commented Sep 13, 2024

View reviewed changes

create initial data model

ed4e1d7

mnholtz reviewed Sep 13, 2024

View reviewed changes

src/background/teamTrialUpdater.ts Outdated Show resolved Hide resolved

mnholtz reviewed Sep 13, 2024

View reviewed changes

twschiller added this to the 2.1.2 milestone Sep 13, 2024

grahamlangford added 3 commits September 13, 2024 12:34

finish implementing transformers

98388f8

Merge branch 'main' of github.com:pixiebrix/pixiebrix-extension into …

e788989

…create-organization-data-model

fix typing

fa7d239

grahamlangford added 8 commits September 13, 2024 12:49

remove dead code

6ff1774

switch back to LegacyUserRole and change organization.role to organiz…

b24e4d3

…ation.isAdmin

remove dead code; use UserRole

f787bd3

remove the lifted value from Organzation

df3a73e

rename OrganizationMembers -> OrganizationMemberships

1ea36b4

member -> membership

5c9c4e2

Merge branch 'main' of github.com:pixiebrix/pixiebrix-extension into …

113893d

…9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

Merge branch 'create-organization-data-model' of github.com:pixiebrix…

e8947d2

…/pixiebrix-extension into 9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

vercel bot deployed to Preview September 13, 2024 20:08 View deployment

update typings

244033d

vercel bot deployed to Preview September 13, 2024 20:11 View deployment

grahamlangford added 2 commits September 13, 2024 15:27

Merge branch 'main' of github.com:pixiebrix/pixiebrix-extension into …

249b394

…9131-slice-3-deactivate-all-team-mods-not-in-a-deployment

adds deactivateModComponent tests

59af23b

vercel bot deployed to Preview September 13, 2024 20:29 View deployment

organization -> team

290c823

vercel bot deployed to Preview September 13, 2024 20:33 View deployment

grahamlangford marked this pull request as ready for review September 13, 2024 20:45

mnholtz reviewed Sep 13, 2024

View reviewed changes

mnholtz approved these changes Sep 13, 2024

View reviewed changes

twschiller assigned fungairino and grahamlangford and unassigned fungairino Sep 15, 2024

grahamlangford merged commit 7fe07ed into main Sep 16, 2024
26 checks passed

grahamlangford deleted the 9131-slice-3-deactivate-all-team-mods-not-in-a-deployment branch September 16, 2024 12:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#9131: Slice 3 - deactivate all team mods not in a deployment #9148

#9131: Slice 3 - deactivate all team mods not in a deployment #9148

grahamlangford commented Sep 12, 2024 •

edited

Loading

github-actions bot commented Sep 12, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading

grahamlangford Sep 13, 2024 •

edited

Loading

grahamlangford Sep 13, 2024 •

edited

Loading

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

grahamlangford Sep 13, 2024

mnholtz Sep 13, 2024

mnholtz Sep 13, 2024 •

edited

Loading

mnholtz Sep 13, 2024

github-actions bot commented Sep 13, 2024

		const UPDATE_INTERVAL_MS = 5 * 60 * 1000;

		function initTeamTrialUpdater(): void {

#9131: Slice 3 - deactivate all team mods not in a deployment #9148

#9131: Slice 3 - deactivate all team mods not in a deployment #9148

Conversation

grahamlangford commented Sep 12, 2024 • edited Loading

What does this PR do?

Demo

Future Work

github-actions bot commented Sep 12, 2024 • edited Loading

Playwright test results

Details

codecov bot commented Sep 12, 2024 • edited Loading

Codecov Report

grahamlangford Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

grahamlangford Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mnholtz Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2024

grahamlangford commented Sep 12, 2024 •

edited

Loading

github-actions bot commented Sep 12, 2024 •

edited

Loading

codecov bot commented Sep 12, 2024 •

edited

Loading

grahamlangford Sep 13, 2024 •

edited

Loading

grahamlangford Sep 13, 2024 •

edited

Loading

mnholtz Sep 13, 2024 •

edited

Loading