-
Notifications
You must be signed in to change notification settings - Fork 511
feat: integrate nightly survey system into app #8480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
christian-byrne
wants to merge
2
commits into
main
Choose a base branch
from
feat/survey-integration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+132
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <script setup lang="ts"> | ||
| import { computed } from 'vue' | ||
|
|
||
| import NightlySurveyPopover from './NightlySurveyPopover.vue' | ||
| import { getEnabledSurveys } from './surveyRegistry' | ||
|
|
||
| const enabledSurveys = computed(() => getEnabledSurveys()) | ||
| </script> | ||
|
|
||
| <template> | ||
| <template v-for="config in enabledSurveys" :key="config.featureId"> | ||
| <NightlySurveyPopover :config="config" /> | ||
| </template> | ||
| </template> |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest' | ||
|
|
||
| const getSurveyConfig = vi.hoisted(() => | ||
| vi.fn<(featureId: string) => { enabled: boolean } | undefined>() | ||
| ) | ||
|
|
||
| vi.mock('./surveyRegistry', () => ({ | ||
| getSurveyConfig | ||
| })) | ||
|
|
||
| describe('useSurveyFeatureTracking', () => { | ||
| beforeEach(() => { | ||
| localStorage.clear() | ||
| vi.resetModules() | ||
| getSurveyConfig.mockReset() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| localStorage.clear() | ||
| }) | ||
|
|
||
| it('tracks usage when config is enabled', async () => { | ||
| getSurveyConfig.mockReturnValue({ enabled: true }) | ||
|
|
||
| const { useSurveyFeatureTracking } = | ||
| await import('./useSurveyFeatureTracking') | ||
| const { trackFeatureUsed, useCount } = | ||
| useSurveyFeatureTracking('test-feature') | ||
|
|
||
| expect(useCount.value).toBe(0) | ||
|
|
||
| trackFeatureUsed() | ||
|
|
||
| expect(useCount.value).toBe(1) | ||
| }) | ||
|
|
||
| it('does not track when config is disabled', async () => { | ||
| getSurveyConfig.mockReturnValue({ enabled: false }) | ||
|
|
||
| const { useSurveyFeatureTracking } = | ||
| await import('./useSurveyFeatureTracking') | ||
| const { trackFeatureUsed, useCount } = | ||
| useSurveyFeatureTracking('disabled-feature') | ||
|
|
||
| trackFeatureUsed() | ||
|
|
||
| expect(useCount.value).toBe(0) | ||
| }) | ||
|
|
||
| it('does not track when config does not exist', async () => { | ||
| getSurveyConfig.mockReturnValue(undefined) | ||
|
|
||
| const { useSurveyFeatureTracking } = | ||
| await import('./useSurveyFeatureTracking') | ||
| const { trackFeatureUsed, useCount } = useSurveyFeatureTracking( | ||
| 'nonexistent-feature' | ||
| ) | ||
|
|
||
| trackFeatureUsed() | ||
|
|
||
| expect(useCount.value).toBe(0) | ||
| }) | ||
| }) |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import { computed } from 'vue' | ||
|
|
||
| import { getSurveyConfig } from './surveyRegistry' | ||
| import { useFeatureUsageTracker } from './useFeatureUsageTracker' | ||
|
|
||
| /** | ||
| * Convenience composable for tracking feature usage for surveys. | ||
| * Use this at the feature site to track when a feature is used. | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * const { trackFeatureUsed } = useSurveyFeatureTracking('simple-mode') | ||
| * | ||
| * function onFeatureAction() { | ||
| * trackFeatureUsed() | ||
| * } | ||
| * ``` | ||
| */ | ||
| export function useSurveyFeatureTracking(featureId: string) { | ||
| const config = getSurveyConfig(featureId) | ||
|
|
||
| if (!config?.enabled) { | ||
| return { | ||
| trackFeatureUsed: () => {}, | ||
| useCount: computed(() => 0) | ||
| } | ||
| } | ||
|
|
||
| const { trackUsage, useCount } = useFeatureUsageTracker(featureId) | ||
|
|
||
| return { | ||
| trackFeatureUsed: trackUsage, | ||
| useCount | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
useSurveyFeatureTrackingtreats enabled as required-true, while the rest of the survey system defaults missing enabled to true, so a survey without enabled set can render and pass eligibility but won’t record usage, potentially never reaching its threshold.see
ComfyUI_frontend/src/platform/surveys/surveyRegistry.ts
Line 17 in bb40ffa