Add onUpdate event listener for installing starter blueprints on Playground urls #4249
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,74 +23,147 @@ import { forEachTab } from "@/background/util"; | |
| import { queueReactivateTab } from "@/contentScript/messenger/api"; | ||
| import { ExtensionOptionsState } from "@/store/extensionsTypes"; | ||
| import reportError from "@/telemetry/reportError"; | ||
| import { debounce } from "lodash"; | ||
|
|
||
| const { reducer, actions } = extensionsSlice; | ||
|
|
||
| const PLAYGROUND_URL = "https://www.pixiebrix.com/playground"; | ||
| let isInstallingBlueprints = false; | ||
| const BLUEPRINT_INSTALLATION_DEBOUNCE_MS = 10_000; | ||
| const BLUEPRINT_INSTALLATION_MAX_MS = 60_000; | ||
|
|
||
| function installBlueprint( | ||
| state: ExtensionOptionsState, | ||
| blueprint: RecipeDefinition | ||
| ): ExtensionOptionsState { | ||
| return reducer( | ||
| state, | ||
| actions.installRecipe({ | ||
| recipe: blueprint, | ||
| extensionPoints: blueprint.extensionPoints, | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| async function installBlueprints( | ||
| blueprints: RecipeDefinition[] | ||
| ): Promise<boolean> { | ||
| let installed = false; | ||
| if (blueprints.length === 0) { | ||
| return installed; | ||
| } | ||
|
|
||
| let extensionsState = await loadOptions(); | ||
| for (const blueprint of blueprints) { | ||
| const blueprintAlreadyInstalled = extensionsState.extensions.some( | ||
| (extension) => extension._recipe.id === blueprint.metadata.id | ||
| ); | ||
|
|
||
| if (!blueprintAlreadyInstalled) { | ||
| extensionsState = installBlueprint(extensionsState, blueprint); | ||
| installed = true; | ||
| } | ||
| } | ||
|
|
||
| await saveOptions(extensionsState); | ||
| await forEachTab(queueReactivateTab); | ||
| return installed; | ||
| } | ||
|
|
||
| async function getShouldFirstTimeInstall(): Promise<boolean> { | ||
| const client = await maybeGetLinkedApiClient(); | ||
| if (client == null) { | ||
| console.debug( | ||
| "Skipping starter blueprint installation because the extension is not linked to the PixieBrix service" | ||
| ); | ||
| return false; | ||
| } | ||
|
|
||
| try { | ||
| const { | ||
| data: { install_starter_blueprints: shouldInstall }, | ||
| } = await client.get("/api/onboarding/starter-blueprints/install/"); | ||
|
|
||
| if (shouldInstall) { | ||
| // If the starter blueprint request fails for some reason, or the user's primary organization | ||
| // gets removed, we'd still like to mark starter blueprints as installed for this user | ||
| // so that they don't see onboarding views/randomly have starter blueprints installed | ||
| // the next time they open the extension | ||
| await client.post("/api/onboarding/starter-blueprints/install/"); | ||
| } | ||
|
|
||
| return shouldInstall; | ||
| } catch (error) { | ||
| reportError(error); | ||
|
There was a problem hiding this comment. What is going to be returned from this function when it catches an error? I think There was a problem hiding this comment. 👍 TypeScript in loose mode misses a lot of such warnings. It should have complained that the signature is There was a problem hiding this comment. Thanks for catching this Ben! This was indeed a mistake. |
||
| return false; | ||
| } | ||
| } | ||
|
|
||
| async function getStarterBlueprints(): Promise<RecipeDefinition[]> { | ||
| const client = await maybeGetLinkedApiClient(); | ||
| if (client == null) { | ||
| console.debug( | ||
| "Skipping starter blueprint installation because the extension is not linked to the PixieBrix service" | ||
| ); | ||
| return []; | ||
|
|
||
| } | ||
|
|
||
| try { | ||
| const { data: starterBlueprints } = await client.get<RecipeDefinition[]>( | ||
| "/api/onboarding/starter-blueprints/" | ||
| ); | ||
| return starterBlueprints; | ||
| } catch (error) { | ||
| reportError(error); | ||
| return []; | ||
| } | ||
| } | ||
|
|
||
| const installStarterBlueprints = async (): Promise<boolean> => { | ||
| if (isInstallingBlueprints) { | ||
| return false; | ||
| } | ||
|
|
||
| isInstallingBlueprints = true; | ||
| const starterBlueprints = await getStarterBlueprints(); | ||
| const installed = await installBlueprints(starterBlueprints); | ||
| isInstallingBlueprints = false; | ||
| return installed; | ||
| }; | ||
|
|
||
| const debouncedInstallStarterBlueprints = debounce( | ||
| installStarterBlueprints, | ||
| BLUEPRINT_INSTALLATION_DEBOUNCE_MS, | ||
| { | ||
| leading: true, | ||
| trailing: false, | ||
| maxWait: BLUEPRINT_INSTALLATION_MAX_MS, | ||
| } | ||
| ); | ||
|
|
||
| export async function firstTimeInstallStarterBlueprints(): Promise<void> { | ||
| const shouldInstall = await getShouldFirstTimeInstall(); | ||
| if (!shouldInstall) { | ||
| return; | ||
| } | ||
|
|
||
| const installed = await installStarterBlueprints(); | ||
|
There was a problem hiding this comment. While unlikely, it could be called concurrently with |
||
|
|
||
| if (installed) { | ||
| void browser.tabs.create({ | ||
| url: PLAYGROUND_URL, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| function initStarterBlueprints(): void { | ||
| browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => { | ||
| if (tab?.url?.startsWith(PLAYGROUND_URL)) { | ||
| void debouncedInstallStarterBlueprints(); | ||
| } | ||
| }); | ||
|
|
||
| void firstTimeInstallStarterBlueprints(); | ||
| } | ||
|
|
||
| export default initStarterBlueprints; | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To ensure that it's not called undebounced (as it currently is on line 150), we can prepend
_to the name.I generally inline the function in the
debouncedefinition (debounce(() => {}, opts)) but for long functions it's less readable.