Skip to content
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

eng: add a basic 'must use result' and ensure assertSnapshot result is used #194744

Merged
merged 2 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions .eslintplugin/code-must-use-result.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import * as eslint from 'eslint';
import { TSESTree } from '@typescript-eslint/experimental-utils';

const VALID_USES = new Set<TSESTree.AST_NODE_TYPES | undefined>([
TSESTree.AST_NODE_TYPES.AwaitExpression,
TSESTree.AST_NODE_TYPES.VariableDeclarator,
]);

export = new class MustUseResults implements eslint.Rule.RuleModule {

create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener {

const config = <{ message: string, functions: string[] }[]>context.options[0];
const listener: eslint.Rule.RuleListener = {};

for (const { message, functions } of config) {
for (const fn of functions) {
const query = `CallExpression[callee.property.name='${fn}'], CallExpression[callee.name='${fn}']`
listener[query] = (node: any) => {
const cast: TSESTree.CallExpression = node;
if (!VALID_USES.has(cast.parent?.type)) {
context.report({ node, message });
}
}
}
}

return listener;
}
};
13 changes: 12 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,18 @@
"rules": {
"local/code-no-test-only": "error",
"local/code-no-test-async-suite": "warn",
"local/code-no-unexternalized-strings": "off"
"local/code-no-unexternalized-strings": "off",
"local/code-must-use-result": [
"warn",
[
{
"message": "Expression must be awaited",
"functions": [
"assertSnapshot"
]
}
]
]
}
},
{
Expand Down
6 changes: 3 additions & 3 deletions src/vs/workbench/contrib/chat/test/common/chatService.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ suite('Chat', () => {
const model = testDisposables.add(testService.startSession(providerId, CancellationToken.None));
assert.strictEqual(model.getRequests().length, 0);

assertSnapshot(model.toExport());
await assertSnapshot(model.toExport());

const response = await testService.sendRequest(model.sessionId, 'test request');
assert(response);
Expand All @@ -266,7 +266,7 @@ suite('Chat', () => {

assert.strictEqual(model.getRequests().length, 1);

assertSnapshot(model.toExport());
await assertSnapshot(model.toExport());
});

test('can deserialize', async () => {
Expand Down Expand Up @@ -306,6 +306,6 @@ suite('Chat', () => {
dispose: () => testService2.clearSession(serializedChatData.sessionId)
});

assertSnapshot(chatModel2.toExport());
await assertSnapshot(chatModel2.toExport());
});
});