Skip to content

test(ts): Add types to js-stubs #29855

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.

Sign up for GitHub

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

Merged
evanpurkhiser merged 1 commit into from
Nov 9, 2021
Merged

test(ts): Add types to js-stubs #29855

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions tests/fixtures/js-stubs/types.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
type SimpleStub<T = any> = () => T;

type OverridableStub<T = any> = (params?: Partial<T>) => T;

type OverridableStubList<T = any> = (params?: T[]) => T[];

type TestStubFixtures = {
AccessRequest: OverridableStub;
AccountAppearance: OverridableStub;
AccountEmails: OverridableStubList;
ActivityFeed: OverridableStub;
ApiApplication: OverridableStub;
ApiKey: OverridableStub;
Copy link
Member

@markstory markstory Nov 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these generics be filled out as the implementations are all JS only files.

Copy link
Member Author

@evanpurkhiser evanpurkhiser Nov 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love for them to be. But it's going to be a lot more effort to make types align in our tests :( we probably should do them one at a time

ApiToken: OverridableStub;
AsanaCreate: SimpleStub;
AsanaPlugin: SimpleStub;
AuditLogs: OverridableStubList;
AuthProvider: OverridableStub;
AuthProviders: OverridableStubList;
Authenticators: SimpleStub;
AllAuthenticators: SimpleStub;
BitbucketIntegrationConfig: SimpleStub;
Broadcast: OverridableStub;
Commit: OverridableStub;
CommitAuthor: OverridableStub;
DataScrubbingRelayPiiConfig: SimpleStub;
DebugFile: OverridableStub;
DebugSymbols: OverridableStub;
DetailedEvents: SimpleStub;
DiscoverSavedQuery: OverridableStub;
Entries: SimpleStub;
Event: OverridableStub;
EventEntry: OverridableStub;
EventEntryDebugMeta: OverridableStub;
EventEntryStacktrace: OverridableStub;
EventIdQueryResult: OverridableStub;
EventStacktraceException: OverridableStub;
EventStacktraceMessage: OverridableStub;
Events: OverridableStubList;
EventsStats: OverridableStub;
ExceptionWithMeta: OverridableStubList;
GitHubIntegration: OverridableStub;
GitHubIntegrationProvider: OverridableStub;
GitHubRepositoryProvider: OverridableStub;
GithubIntegrationConfig: SimpleStub;
GlobalSelection: OverridableStub;
Group: OverridableStub;
GroupStats: OverridableStub;
GroupingConfigs: SimpleStub;
GroupingEnhancements: SimpleStub;
Groups: SimpleStub;
Incident: OverridableStub;
IncidentActivity: OverridableStub;
IncidentRule: OverridableStub;
IncidentStats: OverridableStub;
IncidentTrigger: OverridableStub;
InstallWizard: OverridableStub;
JiraIntegration: OverridableStub;
JiraIntegrationProvider: OverridableStub;
Member: OverridableStub;
Members: OverridableStubList;
OrgOwnedApps: SimpleStub;
Organization: OverridableStub;
OrganizationEvent: OverridableStub;
OrganizationIntegrations: OverridableStub;
Organizations: OverridableStub;
PhabricatorCreate: SimpleStub;
PhabricatorPlugin: SimpleStub;
PlatformExternalIssue: OverridableStub;
Plugin: OverridableStub;
PluginListConfig: SimpleStub;
Plugins: OverridableStubList;
Project: OverridableStub;
ProjectAlertRule: OverridableStub;
ProjectAlertRuleConfiguration: OverridableStub;
ProjectDetails: OverridableStub;
ProjectFilters: OverridableStubList;
ProjectKeys: OverridableStubList;
ProviderList: SimpleStub;
PublishedApps: SimpleStub;
PullRequest: OverridableStub;
Repository: OverridableStub;
Search: OverridableStub;
Searches: OverridableStubList;
SentryApp: OverridableStub;
SentryAppComponent: OverridableStub;
SentryAppComponentAsync: OverridableStub;
SentryAppComponentDependent: OverridableStub;
SentryAppInstallation: OverridableStub;
SentryAppInstalls: SimpleStub;
SentryAppToken: OverridableStub;
SentryAppWebhookRequest: OverridableStub;
ServiceIncident: OverridableStub;
SessionStatusCountByProjectInPeriod: SimpleStub;
SessionStatusCountByReleaseInPeriod: SimpleStub;
SessionTotalCountByProjectIn24h: SimpleStub;
SessionUserCountByStatus: SimpleStub;
SessionUserCountByStatus2: SimpleStub;
SessionUserStatusCountByProjectInPeriod: SimpleStub;
SessionUserStatusCountByReleaseInPeriod: SimpleStub;
SesssionTotalCountByReleaseIn24h: SimpleStub;
ShortIdQueryResult: OverridableStub;
SourceMapArchive: OverridableStub;
SourceMapArtifact: OverridableStub;
Subscriptions: OverridableStubList;
TagValues: OverridableStubList;
Tags: OverridableStubList;
Team: OverridableStub;
TeamAlertsTriggered: SimpleStub;
TeamIssuesReviewed: SimpleStub;
TeamResolutionTime: SimpleStub;
Tombstones: OverridableStubList;
UpdateSdkAndEnableIntegrationSuggestion: SimpleStub;
User: OverridableStub;
UserDetails: OverridableStub;
UserFeedback: OverridableStub;
UserIdentity: SimpleStub;
UserTotalCountByProjectIn24h: SimpleStub;
UserTotalCountByReleaseIn24h: SimpleStub;
VercelProvider: SimpleStub;
VstsCreate: SimpleStub;
VstsIntegrationProvider: OverridableStub;
VstsPlugin: SimpleStub;

Release: (params?: any, healthParams?: any) => any;

// TODO: These need propertly typed still

// Widget(queries = {...DEFAULT_QUERIES}, options)
// Environments(hidden)
// Dashboard(widgets = DEFAULT_WIDGETS, props = {})
// AsanaAutocomplete(type = 'project', values = [DEFAULT_AUTOCOMPLETE])
// PhabricatorAutocomplete(type = 'project', values = null)
// RepositoryProjectPathConfig(project, repo, integration, params)
// RoleList(params = [], fullAccess = false)

// const MOCK_RESP_VERBOSE
// const MOCK_RESP_ONLY_IGNORED_CONDITIONS_INVALID
// const MOCK_RESP_INCONSISTENT_PLACEHOLDERS
// const MOCK_RESP_INCONSISTENT_INTERVALS
};

export default TestStubFixtures;