Skip to content

Typo fixes in query history methods/properties #1594

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
shati-patel merged 3 commits into from
Oct 13, 2022
Merged

Typo fixes in query history methods/properties #1594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a9c4d9
Typo fix: Rename `successful` property
shati-patel Oct 13, 2022
435d81e
Typo fix: `Witb` -> `With`
shati-patel Oct 13, 2022
97f4086
Typo fix: `Scubber` -> `Scrubber`
shati-patel Oct 13, 2022
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
2 changes: 1 addition & 1 deletion extensions/ql-vscode/src/contextual/locationFinder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export async function getLocationsForUriString(
false
);
const results = await qs.compileAndRunQueryAgainstDatabase(db, initialInfo, queryStorageDir, progress, token, templates);
if (results.sucessful) {
if (results.successful) {
links.push(...await getLinksFromResults(results, cli, db, filter));
}
}
Expand Down
2 changes: 1 addition & 1 deletion extensions/ql-vscode/src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ export class ResultsView extends AbstractWebview<IntoResultsViewMsg, FromResults
forceReveal: WebviewReveal,
shouldKeepOldResultsWhileRendering = false
): Promise<void> {
if (!fullQuery.completedQuery.sucessful) {
if (!fullQuery.completedQuery.successful) {
return;
}

Expand Down
8 changes: 4 additions & 4 deletions extensions/ql-vscode/src/legacy-query-server/run-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ export async function compileAndRunQueryAgainstDatabase(
query: query.queryEvalInfo,
message,
result,
sucessful: result.resultType == messages.QueryResultType.SUCCESS,
successful: result.resultType == messages.QueryResultType.SUCCESS,
logFileLocation: result.logFileLocation,
dispose: () => {
qs.logger.removeAdditionalLogLocation(result.logFileLocation);
Expand Down Expand Up @@ -497,14 +497,14 @@ function createSyntheticResult(
return {
query: query.queryEvalInfo,
message,
result:{
evaluationTime:0,
result: {
evaluationTime: 0,
queryId: 0,
resultType: messages.QueryResultType.OTHER_ERROR,
message,
runId: 0,
},
sucessful: false,
successful: false,
dispose: () => { /**/ },
};
}
Expand Down
2 changes: 1 addition & 1 deletion extensions/ql-vscode/src/query-history-scrubber.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ type Counter = {
* @param queryDirectory The directory containing all queries.
* @param ctx The extension context.
*/
export function registerQueryHistoryScubber(
export function registerQueryHistoryScrubber(
wakeInterval: number,
throttleTime: number,
maxQueryTime: number,
Expand Down
10 changes: 5 additions & 5 deletions extensions/ql-vscode/src/query-history.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { ONE_HOUR_IN_MS, TWO_HOURS_IN_MS } from './pure/time';
import { assertNever, getErrorMessage, getErrorStack } from './pure/helpers-pure';
import { CompletedLocalQueryInfo, LocalQueryInfo as LocalQueryInfo, QueryHistoryInfo } from './query-results';
import { DatabaseManager } from './databases';
import { registerQueryHistoryScubber } from './query-history-scrubber';
import { registerQueryHistoryScrubber } from './query-history-scrubber';
import { QueryStatus } from './query-status';
import { slurpQueryHistory, splatQueryHistory } from './query-serialization';
import * as fs from 'fs-extra';
Expand Down Expand Up @@ -573,7 +573,7 @@ export class QueryHistoryManager extends DisposableObject {
this.queryHistoryScrubber?.dispose();
// Every hour check if we need to re-run the query history scrubber.
this.queryHistoryScrubber = this.push(
registerQueryHistoryScubber(
registerQueryHistoryScrubber(
ONE_HOUR_IN_MS,
TWO_HOURS_IN_MS,
queryHistoryConfigListener.ttlInMillis,
Expand Down Expand Up @@ -795,7 +795,7 @@ export class QueryHistoryManager extends DisposableObject {
throw new Error('Please select a local query.');
}

if (!finalSingleItem.completedQuery?.sucessful) {
if (!finalSingleItem.completedQuery?.successful) {
throw new Error('Please select a query that has completed successfully.');
}

Expand Down Expand Up @@ -1236,7 +1236,7 @@ the file in the file explorer and dragging it into the workspace.`
if (!otherQuery.completedQuery) {
throw new Error('Please select a completed query.');
}
if (!otherQuery.completedQuery.sucessful) {
if (!otherQuery.completedQuery.successful) {
throw new Error('Please select a successful query.');
}
if (otherQuery.initialInfo.databaseInfo.name !== dbName) {
Expand All @@ -1256,7 +1256,7 @@ the file in the file explorer and dragging it into the workspace.`
otherQuery !== singleItem &&
otherQuery.t === 'local' &&
otherQuery.completedQuery &&
otherQuery.completedQuery.sucessful &&
otherQuery.completedQuery.successful &&
otherQuery.initialInfo.databaseInfo.name === dbName
)
.map((item) => ({
Expand Down
6 changes: 3 additions & 3 deletions extensions/ql-vscode/src/query-results.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export interface InitialQueryInfo {
export class CompletedQueryInfo implements QueryWithResults {
readonly query: QueryEvaluationInfo;
readonly message?: string;
readonly sucessful?: boolean;
readonly successful?: boolean;
/**
* The legacy result. This is only set when loading from the query history.
*/
Expand Down Expand Up @@ -86,7 +86,7 @@ export class CompletedQueryInfo implements QueryWithResults {
this.result = evaluation.result;

this.message = evaluation.message;
this.sucessful = evaluation.sucessful;
this.successful = evaluation.successful;
// Use the dispose method from the evaluation.
// The dispose will clean up any additional log locations that this
// query may have created.
Expand Down Expand Up @@ -301,7 +301,7 @@ export class LocalQueryInfo {
return QueryStatus.Failed;
} else if (!this.completedQuery) {
return QueryStatus.InProgress;
} else if (this.completedQuery.sucessful) {
} else if (this.completedQuery.successful) {
return QueryStatus.Completed;
} else {
return QueryStatus.Failed;
Expand Down
6 changes: 3 additions & 3 deletions extensions/ql-vscode/src/query-server/run-queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,18 +124,18 @@ export async function compileAndRunQueryAgainstDatabase(
message = result.message ? `failed: ${result.message}` : 'failed';
break;
}
const sucessful = result.resultType === messages.QueryResultType.SUCCESS;
const successful = result.resultType === messages.QueryResultType.SUCCESS;
return {
query,
result: {
evaluationTime: result.evaluationTime,
queryId: 0,
resultType: sucessful ? legacyMessages.QueryResultType.SUCCESS : legacyMessages.QueryResultType.OTHER_ERROR,
resultType: successful ? legacyMessages.QueryResultType.SUCCESS : legacyMessages.QueryResultType.OTHER_ERROR,
runId: 0,
message
},
message,
sucessful,
successful,
dispose: () => {
qs.logger.removeAdditionalLogLocation(undefined);
}
Expand Down
2 changes: 1 addition & 1 deletion extensions/ql-vscode/src/run-queries-shared.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ export interface QueryWithResults {
readonly query: QueryEvaluationInfo;
readonly logFileLocation?: string;
readonly dispose: () => void;
readonly sucessful?: boolean;
readonly successful?: boolean;
readonly message?: string;
readonly result: legacyMessages.EvaluationResult;
}
Expand Down
4 changes: 2 additions & 2 deletions extensions/ql-vscode/src/vscode-tests/cli-integration/queries.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ describe('Queries', function() {
);

// just check that the query was successful
expect((await result).sucessful).to.eq(true);
expect((await result).successful).to.eq(true);
} catch (e) {
console.error('Test Failed');
fail(e as Error);
Expand All @@ -132,7 +132,7 @@ describe('Queries', function() {
token
);

expect(result.sucessful).to.eq(true);
expect(result.successful).to.eq(true);
} catch (e) {
console.error('Test Failed');
fail(e as Error);
Expand Down
12 changes: 6 additions & 6 deletions extensions/ql-vscode/src/vscode-tests/no-workspace/query-history.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import * as vscode from 'vscode';
import * as sinon from 'sinon';

import { logger } from '../../logging';
import { registerQueryHistoryScubber } from '../../query-history-scrubber';
import { registerQueryHistoryScrubber } from '../../query-history-scrubber';
import { QueryHistoryManager, HistoryTreeDataProvider, SortOrder } from '../../query-history';
import { QueryEvaluationInfo, QueryWithResults } from '../../run-queries-shared';
import { QueryHistoryConfig, QueryHistoryConfigListener } from '../../config';
Expand Down Expand Up @@ -581,7 +581,7 @@ describe('query-history', () => {
}
});

function createMockFullQueryInfo(dbName = 'a', queryWitbResults?: QueryWithResults, isFail = false): LocalQueryInfo {
function createMockFullQueryInfo(dbName = 'a', queryWithResults?: QueryWithResults, isFail = false): LocalQueryInfo {
const fqi = new LocalQueryInfo(
{
databaseInfo: { name: dbName },
Expand All @@ -593,8 +593,8 @@ describe('query-history', () => {
} as vscode.CancellationTokenSource
);

if (queryWitbResults) {
fqi.completeThisQuery(queryWitbResults);
if (queryWithResults) {
fqi.completeThisQuery(queryWithResults);
}
if (isFail) {
fqi.failureReason = 'failure reason';
Expand Down Expand Up @@ -759,7 +759,7 @@ describe('query-history', () => {
}

function registerScrubber(dir: string) {
deregister = registerQueryHistoryScubber(
deregister = registerQueryHistoryScrubber(
ONE_HOUR_IN_MS,
TWO_HOURS_IN_MS,
LESS_THAN_ONE_DAY,
Expand All @@ -785,7 +785,7 @@ describe('query-history', () => {
hasInterpretedResults: () => Promise.resolve(hasInterpretedResults),
deleteQuery: sandbox.stub(),
} as unknown as QueryEvaluationInfo,
sucessful: didRunSuccessfully,
successful: didRunSuccessfully,
message: 'foo',
dispose: sandbox.spy(),
result: {
Expand Down
8 changes: 4 additions & 4 deletions extensions/ql-vscode/src/vscode-tests/no-workspace/query-results.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ describe('query-results', () => {

const result: QueryWithResults = {
query: query.queryEvalInfo,
sucessful: didRunSuccessfully,
successful: didRunSuccessfully,
message: 'foo',
dispose: disposeSpy,
result: {
Expand All @@ -343,7 +343,7 @@ describe('query-results', () => {
return result;
}

function createMockFullQueryInfo(dbName = 'a', queryWitbResults?: QueryWithResults, isFail = false): LocalQueryInfo {
function createMockFullQueryInfo(dbName = 'a', queryWithResults?: QueryWithResults, isFail = false): LocalQueryInfo {
const fqi = new LocalQueryInfo(
{
databaseInfo: {
Expand All @@ -362,8 +362,8 @@ describe('query-results', () => {
} as CancellationTokenSource
);

if (queryWitbResults) {
fqi.completeThisQuery(queryWitbResults);
if (queryWithResults) {
fqi.completeThisQuery(queryWithResults);
}
if (isFail) {
fqi.failureReason = 'failure reason';
Expand Down