@checkdigit/eslint-plugin 7.15.0-PR.134-3323 → 7.15.0-PR.136-a1e2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-mjs/aws/require-consistent-read.mjs +129 -0
- package/dist-mjs/index.mjs +7 -9
- package/dist-types/aws/require-consistent-read.d.ts +12 -0
- package/dist-types/index.d.ts +0 -1
- package/package.json +1 -1
- package/src/aws/require-consistent-read.ts +172 -0
- package/src/index.ts +4 -6
- package/dist-mjs/is-aws-sdk-v3-used.mjs +0 -16
- package/dist-mjs/require-aws-config.mjs +0 -85
- package/dist-types/is-aws-sdk-v3-used.d.ts +0 -1
- package/dist-types/require-aws-config.d.ts +0 -6
- package/src/is-aws-sdk-v3-used.ts +0 -24
- package/src/require-aws-config.ts +0 -105
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
// src/aws/require-consistent-read.ts
|
|
2
|
+
import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
|
|
3
|
+
import getDocumentationUrl from "../get-documentation-url.mjs";
|
|
4
|
+
var ruleId = "require-consistent-read";
|
|
5
|
+
var MESSAGE_ID_CONSISTENT_READ_TRUE = "MESSAGE_ID_CONSISTENT_READ_TRUE";
|
|
6
|
+
var MESSAGE_ID_CONSISTENT_READ_FALSE = "MESSAGE_ID_CONSISTENT_READ_FALSE";
|
|
7
|
+
function getPropertyName(property) {
|
|
8
|
+
if (property.computed) {
|
|
9
|
+
return void 0;
|
|
10
|
+
}
|
|
11
|
+
const propertyKey = property.key;
|
|
12
|
+
return propertyKey.type === AST_NODE_TYPES.Identifier ? propertyKey.name : (
|
|
13
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
14
|
+
propertyKey.type === AST_NODE_TYPES.Literal && typeof propertyKey.value === "string" ? propertyKey.value : void 0
|
|
15
|
+
);
|
|
16
|
+
}
|
|
17
|
+
function extractObjectProperties(objectExpression) {
|
|
18
|
+
const objectProperties = {};
|
|
19
|
+
for (const property of objectExpression.properties) {
|
|
20
|
+
if (property.type !== AST_NODE_TYPES.Property || property.computed) {
|
|
21
|
+
continue;
|
|
22
|
+
}
|
|
23
|
+
const propertyName = getPropertyName(property);
|
|
24
|
+
if (propertyName !== void 0) {
|
|
25
|
+
objectProperties[propertyName] = property;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
return objectProperties;
|
|
29
|
+
}
|
|
30
|
+
function existsRequestItemsProperty(extractedObjectProperties) {
|
|
31
|
+
const requestItemProperty = extractedObjectProperties["RequestItems"];
|
|
32
|
+
if (requestItemProperty?.type !== AST_NODE_TYPES.Property) {
|
|
33
|
+
return false;
|
|
34
|
+
}
|
|
35
|
+
const requestItemValue = requestItemProperty.value;
|
|
36
|
+
if (requestItemValue.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
37
|
+
return false;
|
|
38
|
+
}
|
|
39
|
+
return requestItemValue.properties.some(
|
|
40
|
+
(property) => property.type === AST_NODE_TYPES.Property && property.value.type === AST_NODE_TYPES.ObjectExpression && extractObjectProperties(property.value)["Keys"]?.value.type === AST_NODE_TYPES.ArrayExpression
|
|
41
|
+
);
|
|
42
|
+
}
|
|
43
|
+
function existsKeyProperty(extractedObjectProperties) {
|
|
44
|
+
const keyProperty = extractedObjectProperties["Key"];
|
|
45
|
+
return keyProperty?.type === AST_NODE_TYPES.Property && keyProperty.value.type === AST_NODE_TYPES.ObjectExpression;
|
|
46
|
+
}
|
|
47
|
+
function getReadCommandInfo(objectExpression) {
|
|
48
|
+
const extractedProperties = extractObjectProperties(objectExpression);
|
|
49
|
+
let readCommandInfo;
|
|
50
|
+
if (existsRequestItemsProperty(extractedProperties)) {
|
|
51
|
+
readCommandInfo = { type: "BatchGetItem" };
|
|
52
|
+
} else {
|
|
53
|
+
const hasTableName = "TableName" in extractedProperties;
|
|
54
|
+
const hasKey = existsKeyProperty(extractedProperties);
|
|
55
|
+
if (hasTableName && hasKey) {
|
|
56
|
+
readCommandInfo = { type: "GetItem" };
|
|
57
|
+
} else {
|
|
58
|
+
const hasKeyCondExpr = extractedProperties["KeyConditionExpression"]?.value.type === AST_NODE_TYPES.Literal;
|
|
59
|
+
const hasLegacyKeyConditions = extractedProperties["KeyConditions"]?.value.type === AST_NODE_TYPES.ObjectExpression;
|
|
60
|
+
if (hasTableName && (hasKeyCondExpr || hasLegacyKeyConditions)) {
|
|
61
|
+
readCommandInfo = { type: "Query" };
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
if (readCommandInfo === void 0) {
|
|
66
|
+
return void 0;
|
|
67
|
+
}
|
|
68
|
+
const consistentReadProperty = extractedProperties["ConsistentRead"];
|
|
69
|
+
if (consistentReadProperty?.type === AST_NODE_TYPES.Property && consistentReadProperty.value.type === AST_NODE_TYPES.Literal && typeof consistentReadProperty.value.value === "boolean") {
|
|
70
|
+
readCommandInfo.consistentRead = consistentReadProperty.value.value;
|
|
71
|
+
}
|
|
72
|
+
const indexNameProperty = extractedProperties["IndexName"];
|
|
73
|
+
if (indexNameProperty?.type === AST_NODE_TYPES.Property && indexNameProperty.value.type === AST_NODE_TYPES.Literal && typeof indexNameProperty.value.value === "string") {
|
|
74
|
+
readCommandInfo.usedIndex = true;
|
|
75
|
+
}
|
|
76
|
+
return readCommandInfo;
|
|
77
|
+
}
|
|
78
|
+
var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
79
|
+
var rule = createRule({
|
|
80
|
+
name: ruleId,
|
|
81
|
+
meta: {
|
|
82
|
+
type: "problem",
|
|
83
|
+
docs: {
|
|
84
|
+
description: "For AWS dynamodb commands Query/GetItem/BatchGetItem, ConsistentRead option should be set as true unless global index is used. This will make the service more robust at the ignorable cost of RCU."
|
|
85
|
+
},
|
|
86
|
+
messages: {
|
|
87
|
+
[MESSAGE_ID_CONSISTENT_READ_TRUE]: "ConsistentRead option should be set as true for {{readCommandType}} command.",
|
|
88
|
+
[MESSAGE_ID_CONSISTENT_READ_FALSE]: "ConsistentRead option should be set as false for {{readCommandType}} command when using a global secondary index."
|
|
89
|
+
},
|
|
90
|
+
schema: []
|
|
91
|
+
},
|
|
92
|
+
defaultOptions: [],
|
|
93
|
+
create(context) {
|
|
94
|
+
const sourceCode = context.sourceCode;
|
|
95
|
+
return {
|
|
96
|
+
ObjectExpression(node) {
|
|
97
|
+
const text = sourceCode.getText(node);
|
|
98
|
+
if (!/TableName|RequestItems|KeyConditionExpression|KeyConditions/u.test(text)) {
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
const readCommandInfo = getReadCommandInfo(node);
|
|
102
|
+
if (readCommandInfo !== void 0) {
|
|
103
|
+
if (readCommandInfo.usedIndex !== true && readCommandInfo.consistentRead !== true) {
|
|
104
|
+
context.report({
|
|
105
|
+
node,
|
|
106
|
+
messageId: MESSAGE_ID_CONSISTENT_READ_TRUE,
|
|
107
|
+
data: { readCommandType: readCommandInfo.type }
|
|
108
|
+
});
|
|
109
|
+
} else if (readCommandInfo.usedIndex === true && readCommandInfo.consistentRead !== false) {
|
|
110
|
+
context.report({
|
|
111
|
+
node,
|
|
112
|
+
messageId: MESSAGE_ID_CONSISTENT_READ_FALSE,
|
|
113
|
+
data: { readCommandType: readCommandInfo.type }
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
});
|
|
121
|
+
var require_consistent_read_default = rule;
|
|
122
|
+
export {
|
|
123
|
+
MESSAGE_ID_CONSISTENT_READ_FALSE,
|
|
124
|
+
MESSAGE_ID_CONSISTENT_READ_TRUE,
|
|
125
|
+
require_consistent_read_default as default,
|
|
126
|
+
getReadCommandInfo,
|
|
127
|
+
ruleId
|
|
128
|
+
};
|
|
129
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL2F3cy9yZXF1aXJlLWNvbnNpc3RlbnQtcmVhZC50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFRQSxTQUFTLGdCQUFnQixtQkFBNkI7QUFDdEQsT0FBTyx5QkFBeUI7QUFFekIsSUFBTSxTQUFTO0FBQ2YsSUFBTSxrQ0FBa0M7QUFDeEMsSUFBTSxtQ0FBbUM7QUFRaEQsU0FBUyxnQkFBZ0IsVUFBaUQ7QUFDeEUsTUFBSSxTQUFTLFVBQVU7QUFDckIsV0FBTztBQUFBLEVBQ1Q7QUFDQSxRQUFNLGNBQWMsU0FBUztBQUU3QixTQUFPLFlBQVksU0FBUyxlQUFlLGFBQ3ZDLFlBQVk7QUFBQTtBQUFBLElBRVosWUFBWSxTQUFTLGVBQWUsV0FBVyxPQUFPLFlBQVksVUFBVSxXQUMxRSxZQUFZLFFBQ1o7QUFBQTtBQUNSO0FBRUEsU0FBUyx3QkFBd0Isa0JBQWdGO0FBQy9HLFFBQU0sbUJBQXNELENBQUM7QUFDN0QsYUFBVyxZQUFZLGlCQUFpQixZQUFZO0FBQ2xELFFBQUksU0FBUyxTQUFTLGVBQWUsWUFBWSxTQUFTLFVBQVU7QUFDbEU7QUFBQSxJQUNGO0FBQ0EsVUFBTSxlQUFlLGdCQUFnQixRQUFRO0FBQzdDLFFBQUksaUJBQWlCLFFBQVc7QUFDOUIsdUJBQWlCLFlBQVksSUFBSTtBQUFBLElBQ25DO0FBQUEsRUFDRjtBQUNBLFNBQU87QUFDVDtBQUVBLFNBQVMsMkJBQTJCLDJCQUF1RTtBQUN6RyxRQUFNLHNCQUFzQiwwQkFBMEIsY0FBYztBQUNwRSxNQUFJLHFCQUFxQixTQUFTLGVBQWUsVUFBVTtBQUN6RCxXQUFPO0FBQUEsRUFDVDtBQUNBLFFBQU0sbUJBQW1CLG9CQUFvQjtBQUM3QyxNQUFJLGlCQUFpQixTQUFTLGVBQWUsa0JBQWtCO0FBQzdELFdBQU87QUFBQSxFQUNUO0FBRUEsU0FBTyxpQkFBaUIsV0FBVztBQUFBLElBQ2pDLENBQUMsYUFDQyxTQUFTLFNBQVMsZUFBZSxZQUNqQyxTQUFTLE1BQU0sU0FBUyxlQUFlLG9CQUN2Qyx3QkFBd0IsU0FBUyxLQUFLLEVBQUUsTUFBTSxHQUFHLE1BQU0sU0FBUyxlQUFlO0FBQUEsRUFDbkY7QUFDRjtBQUVBLFNBQVMsa0JBQWtCLDJCQUF1RTtBQUNoRyxRQUFNLGNBQWMsMEJBQTBCLEtBQUs7QUFFbkQsU0FBTyxhQUFhLFNBQVMsZUFBZSxZQUFZLFlBQVksTUFBTSxTQUFTLGVBQWU7QUFDcEc7QUFFTyxTQUFTLG1CQUFtQixrQkFBMEU7QUFDM0csUUFBTSxzQkFBc0Isd0JBQXdCLGdCQUFnQjtBQUNwRSxNQUFJO0FBRUosTUFBSSwyQkFBMkIsbUJBQW1CLEdBQUc7QUFDbkQsc0JBQWtCLEVBQUUsTUFBTSxlQUFlO0FBQUEsRUFDM0MsT0FBTztBQUNMLFVBQU0sZUFBZSxlQUFlO0FBQ3BDLFVBQU0sU0FBUyxrQkFBa0IsbUJBQW1CO0FBQ3BELFFBQUksZ0JBQWdCLFFBQVE7QUFDMUIsd0JBQWtCLEVBQUUsTUFBTSxVQUFVO0FBQUEsSUFDdEMsT0FBTztBQUNMLFlBQU0saUJBQWlCLG9CQUFvQix3QkFBd0IsR0FBRyxNQUFNLFNBQVMsZUFBZTtBQUNwRyxZQUFNLHlCQUNKLG9CQUFvQixlQUFlLEdBQUcsTUFBTSxTQUFTLGVBQWU7QUFDdEUsVUFBSSxpQkFBaUIsa0JBQWtCLHlCQUF5QjtBQUM5RCwwQkFBa0IsRUFBRSxNQUFNLFFBQVE7QUFBQSxNQUNwQztBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBRUEsTUFBSSxvQkFBb0IsUUFBVztBQUNqQyxXQUFPO0FBQUEsRUFDVDtBQUVBLFFBQU0seUJBQXlCLG9CQUFvQixnQkFBZ0I7QUFDbkUsTUFDRSx3QkFBd0IsU0FBUyxlQUFlLFlBQ2hELHVCQUF1QixNQUFNLFNBQVMsZUFBZSxXQUNyRCxPQUFPLHVCQUF1QixNQUFNLFVBQVUsV0FDOUM7QUFDQSxvQkFBZ0IsaUJBQWlCLHVCQUF1QixNQUFNO0FBQUEsRUFDaEU7QUFFQSxRQUFNLG9CQUFvQixvQkFBb0IsV0FBVztBQUN6RCxNQUNFLG1CQUFtQixTQUFTLGVBQWUsWUFDM0Msa0JBQWtCLE1BQU0sU0FBUyxlQUFlLFdBQ2hELE9BQU8sa0JBQWtCLE1BQU0sVUFBVSxVQUN6QztBQUNBLG9CQUFnQixZQUFZO0FBQUEsRUFDOUI7QUFFQSxTQUFPO0FBQ1Q7QUFFQSxJQUFNLGFBQWEsWUFBWSxZQUFZLENBQUMsU0FBUyxvQkFBb0IsSUFBSSxDQUFDO0FBRTlFLElBQU0sT0FDSixXQUFXO0FBQUEsRUFDVCxNQUFNO0FBQUEsRUFDTixNQUFNO0FBQUEsSUFDSixNQUFNO0FBQUEsSUFDTixNQUFNO0FBQUEsTUFDSixhQUNFO0FBQUEsSUFDSjtBQUFBLElBQ0EsVUFBVTtBQUFBLE1BQ1IsQ0FBQywrQkFBK0IsR0FDOUI7QUFBQSxNQUNGLENBQUMsZ0NBQWdDLEdBQy9CO0FBQUEsSUFDSjtBQUFBLElBQ0EsUUFBUSxDQUFDO0FBQUEsRUFDWDtBQUFBLEVBQ0EsZ0JBQWdCLENBQUM7QUFBQSxFQUNqQixPQUFPLFNBQVM7QUFDZCxVQUFNLGFBQWEsUUFBUTtBQUUzQixXQUFPO0FBQUEsTUFDTCxpQkFBaUIsTUFBTTtBQUVyQixjQUFNLE9BQU8sV0FBVyxRQUFRLElBQUk7QUFDcEMsWUFBSSxDQUFDLCtEQUErRCxLQUFLLElBQUksR0FBRztBQUM5RTtBQUFBLFFBQ0Y7QUFFQSxjQUFNLGtCQUFrQixtQkFBbUIsSUFBSTtBQUMvQyxZQUFJLG9CQUFvQixRQUFXO0FBQ2pDLGNBQUksZ0JBQWdCLGNBQWMsUUFBUSxnQkFBZ0IsbUJBQW1CLE1BQU07QUFDakYsb0JBQVEsT0FBTztBQUFBLGNBQ2I7QUFBQSxjQUNBLFdBQVc7QUFBQSxjQUNYLE1BQU0sRUFBRSxpQkFBaUIsZ0JBQWdCLEtBQUs7QUFBQSxZQUNoRCxDQUFDO0FBQUEsVUFDSCxXQUFXLGdCQUFnQixjQUFjLFFBQVEsZ0JBQWdCLG1CQUFtQixPQUFPO0FBQ3pGLG9CQUFRLE9BQU87QUFBQSxjQUNiO0FBQUEsY0FDQSxXQUFXO0FBQUEsY0FDWCxNQUFNLEVBQUUsaUJBQWlCLGdCQUFnQixLQUFLO0FBQUEsWUFDaEQsQ0FBQztBQUFBLFVBQ0g7QUFBQSxRQUNGO0FBQUEsTUFDRjtBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBQ0YsQ0FBQztBQUVILElBQU8sa0NBQVE7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
package/dist-mjs/index.mjs
CHANGED
|
@@ -17,7 +17,7 @@ import noServeRuntime, { ruleId as noServeRuntimeRuleId } from "./no-serve-runti
|
|
|
17
17
|
import requireServiceCallResponseDeclaration, {
|
|
18
18
|
ruleId as requireServiceCallResponseDeclarationRuleId
|
|
19
19
|
} from "./require-service-call-response-declaration.mjs";
|
|
20
|
-
import
|
|
20
|
+
import requireConsistentRead, { ruleId as requireConsistentReadRuleId } from "./aws/require-consistent-read.mjs";
|
|
21
21
|
import filePathComment from "./file-path-comment.mjs";
|
|
22
22
|
import noCardNumbers from "./no-card-numbers.mjs";
|
|
23
23
|
import noEnum from "./no-enum.mjs";
|
|
@@ -33,7 +33,6 @@ import requireAssertPredicateRejectsThrows from "./require-assert-predicate-reje
|
|
|
33
33
|
import requireStrictAssert from "./require-strict-assert.mjs";
|
|
34
34
|
import requireAssertMessage from "./require-assert-message.mjs";
|
|
35
35
|
import requireTsExtensionImportsExports from "./require-ts-extension-imports-exports.mjs";
|
|
36
|
-
import { default as default2 } from "./is-aws-sdk-v3-used.mjs";
|
|
37
36
|
var rules = {
|
|
38
37
|
"file-path-comment": filePathComment,
|
|
39
38
|
"no-card-numbers": noCardNumbers,
|
|
@@ -58,9 +57,9 @@ var rules = {
|
|
|
58
57
|
[noDuplicatedImportsRuleId]: noDuplicatedImports,
|
|
59
58
|
[noServeRuntimeRuleId]: noServeRuntime,
|
|
60
59
|
[requireServiceCallResponseDeclarationRuleId]: requireServiceCallResponseDeclaration,
|
|
61
|
-
[requireAwsConfigRuleId]: requireAwsConfig,
|
|
62
60
|
[requireFixedServicesImportRuleId]: requireFixedServicesImport,
|
|
63
|
-
[requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports
|
|
61
|
+
[requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
|
|
62
|
+
[requireConsistentReadRuleId]: requireConsistentRead
|
|
64
63
|
};
|
|
65
64
|
var plugin = {
|
|
66
65
|
rules
|
|
@@ -98,7 +97,7 @@ var configs = {
|
|
|
98
97
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: "error",
|
|
99
98
|
[`@checkdigit/${noServeRuntimeRuleId}`]: "error",
|
|
100
99
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: "error",
|
|
101
|
-
[`@checkdigit/${
|
|
100
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: "error"
|
|
102
101
|
}
|
|
103
102
|
}
|
|
104
103
|
],
|
|
@@ -134,7 +133,7 @@ var configs = {
|
|
|
134
133
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: "error",
|
|
135
134
|
[`@checkdigit/${noServeRuntimeRuleId}`]: "off",
|
|
136
135
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: "off",
|
|
137
|
-
[`@checkdigit/${
|
|
136
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: "off"
|
|
138
137
|
}
|
|
139
138
|
}
|
|
140
139
|
]
|
|
@@ -145,7 +144,6 @@ var defaultToExport = {
|
|
|
145
144
|
};
|
|
146
145
|
var index_default = defaultToExport;
|
|
147
146
|
export {
|
|
148
|
-
index_default as default
|
|
149
|
-
default2 as isAwsSdkV3Used
|
|
147
|
+
index_default as default
|
|
150
148
|
};
|
|
151
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
149
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8seUJBQXlCLFVBQVUsbUNBQW1DO0FBQzdFLE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU8sd0JBQXdCO0FBQy9CLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTyx5QkFBeUIsVUFBVSxtQ0FBbUM7QUFDN0UsT0FBTyxxQkFBcUI7QUFDNUIsT0FBTyxtQkFBbUI7QUFDMUIsT0FBTyxZQUFZO0FBQ25CLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sb0JBQW9CO0FBQzNCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFDaEMsT0FBTywwQkFBMEI7QUFDakMsT0FBTyxzQ0FBc0M7QUFFN0MsSUFBTSxRQUFzRDtBQUFBLEVBQzFELHFCQUFxQjtBQUFBLEVBQ3JCLG1CQUFtQjtBQUFBLEVBQ25CLFdBQVc7QUFBQSxFQUNYLHFCQUFxQjtBQUFBLEVBQ3JCLHlCQUF5QjtBQUFBLEVBQ3pCLFdBQVc7QUFBQSxFQUNYLFdBQVc7QUFBQSxFQUNYLDBCQUEwQjtBQUFBLEVBQzFCLHlCQUF5QjtBQUFBLEVBQ3pCLHdDQUF3QztBQUFBLEVBQ3hDLGtCQUFrQjtBQUFBLEVBQ2xCLHNCQUFzQjtBQUFBLEVBQ3RCLG1CQUFtQjtBQUFBLEVBQ25CLDhCQUE4QjtBQUFBLEVBQzlCLDJDQUEyQztBQUFBLEVBQzNDLDJCQUEyQjtBQUFBLEVBQzNCLENBQUMsMEJBQTBCLEdBQUc7QUFBQSxFQUM5QixDQUFDLDZCQUE2QixHQUFHO0FBQUEsRUFDakMsQ0FBQywyQkFBMkIsR0FBRztBQUFBLEVBQy9CLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHlCQUF5QixHQUFHO0FBQUEsRUFDN0IsQ0FBQyxvQkFBb0IsR0FBRztBQUFBLEVBQ3hCLENBQUMsMkNBQTJDLEdBQUc7QUFBQSxFQUMvQyxDQUFDLGdDQUFnQyxHQUFHO0FBQUEsRUFDcEMsQ0FBQyxxQ0FBcUMsR0FBRztBQUFBLEVBQ3pDLENBQUMsMkJBQTJCLEdBQUc7QUFDakM7QUFFQSxJQUFNLFNBQXFDO0FBQUEsRUFDekM7QUFDRjtBQUVBLElBQU0sVUFBd0Q7QUFBQSxFQUM1RCxLQUFLO0FBQUEsSUFDSDtBQUFBLE1BQ0UsT0FBTyxDQUFDLFNBQVM7QUFBQSxNQUNqQixTQUFTO0FBQUEsUUFDUCxlQUFlO0FBQUEsTUFDakI7QUFBQSxNQUNBLE9BQU87QUFBQSxRQUNMLCtCQUErQjtBQUFBLFFBQy9CLHVCQUF1QjtBQUFBLFFBQ3ZCLGlDQUFpQztBQUFBLFFBQ2pDLGlDQUFpQztBQUFBLFFBQ2pDLHFDQUFxQztBQUFBLFFBQ3JDLHVCQUF1QjtBQUFBLFFBQ3ZCLHVCQUF1QjtBQUFBLFFBQ3ZCLHNDQUFzQztBQUFBLFFBQ3RDLHFDQUFxQztBQUFBLFFBQ3JDLG9EQUFvRDtBQUFBLFFBQ3BELGtDQUFrQztBQUFBLFFBQ2xDLCtCQUErQjtBQUFBLFFBQy9CLDBDQUEwQztBQUFBLFFBQzFDLHVEQUF1RDtBQUFBLFFBQ3ZELHVDQUF1QztBQUFBLFFBQ3ZDLDhCQUE4QjtBQUFBLFFBQzlCLENBQUMsZUFBZSwwQkFBMEIsRUFBRSxHQUFHO0FBQUEsUUFDL0MsQ0FBQyxlQUFlLDZCQUE2QixFQUFFLEdBQUc7QUFBQSxRQUNsRCxDQUFDLGVBQWUsMkJBQTJCLEVBQUUsR0FBRztBQUFBLFFBQ2hELENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsUUFDckQsQ0FBQyxlQUFlLHlCQUF5QixFQUFFLEdBQUc7QUFBQSxRQUM5QyxDQUFDLGVBQWUsZ0NBQWdDLEVBQUUsR0FBRztBQUFBLFFBQ3JELENBQUMsZUFBZSxxQ0FBcUMsRUFBRSxHQUFHO0FBQUEsUUFDMUQsQ0FBQyxlQUFlLG9CQUFvQixFQUFFLEdBQUc7QUFBQSxRQUN6QyxDQUFDLGVBQWUsMkNBQTJDLEVBQUUsR0FBRztBQUFBLFFBQ2hFLENBQUMsZUFBZSwyQkFBMkIsRUFBRSxHQUFHO0FBQUEsTUFDbEQ7QUFBQSxJQUNGO0FBQUEsRUFDRjtBQUFBLEVBQ0EsYUFBYTtBQUFBLElBQ1g7QUFBQSxNQUNFLE9BQU8sQ0FBQyxTQUFTO0FBQUEsTUFDakIsU0FBUztBQUFBLFFBQ1AsZUFBZTtBQUFBLE1BQ2pCO0FBQUEsTUFDQSxPQUFPO0FBQUEsUUFDTCwrQkFBK0I7QUFBQSxRQUMvQix1QkFBdUI7QUFBQSxRQUN2QixpQ0FBaUM7QUFBQSxRQUNqQyxpQ0FBaUM7QUFBQSxRQUNqQyxxQ0FBcUM7QUFBQSxRQUNyQyx1QkFBdUI7QUFBQSxRQUN2Qix1QkFBdUI7QUFBQSxRQUN2QixzQ0FBc0M7QUFBQSxRQUN0QyxxQ0FBcUM7QUFBQSxRQUNyQyxvREFBb0Q7QUFBQSxRQUNwRCxrQ0FBa0M7QUFBQSxRQUNsQywrQkFBK0I7QUFBQSxRQUMvQiwwQ0FBMEM7QUFBQSxRQUMxQyx1REFBdUQ7QUFBQSxRQUN2RCx1Q0FBdUM7QUFBQSxRQUN2Qyw4QkFBOEI7QUFBQSxRQUM5QixDQUFDLGVBQWUsMEJBQTBCLEVBQUUsR0FBRztBQUFBLFFBQy9DLENBQUMsZUFBZSw2QkFBNkIsRUFBRSxHQUFHO0FBQUEsUUFDbEQsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsZ0NBQWdDLEVBQUUsR0FBRztBQUFBLFFBQ3JELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsUUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLFFBQzFELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsUUFDekMsQ0FBQyxlQUFlLDJDQUEyQyxFQUFFLEdBQUc7QUFBQSxRQUNoRSxDQUFDLGVBQWUsMkJBQTJCLEVBQUUsR0FBRztBQUFBLE1BQ2xEO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFDRjtBQUVBLElBQU0sa0JBRUY7QUFBQSxFQUNGLEdBQUc7QUFBQSxFQUNIO0FBQ0Y7QUFDQSxJQUFPLGdCQUFROyIsCiAgIm5hbWVzIjogW10KfQo=
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
|
2
|
+
export declare const ruleId = "require-consistent-read";
|
|
3
|
+
export declare const MESSAGE_ID_CONSISTENT_READ_TRUE = "MESSAGE_ID_CONSISTENT_READ_TRUE";
|
|
4
|
+
export declare const MESSAGE_ID_CONSISTENT_READ_FALSE = "MESSAGE_ID_CONSISTENT_READ_FALSE";
|
|
5
|
+
interface ReadCommandInfo {
|
|
6
|
+
type: 'GetItem' | 'Query' | 'BatchGetItem';
|
|
7
|
+
consistentRead?: boolean;
|
|
8
|
+
usedIndex?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare function getReadCommandInfo(objectExpression: TSESTree.ObjectExpression): ReadCommandInfo | undefined;
|
|
11
|
+
declare const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_CONSISTENT_READ_TRUE | typeof MESSAGE_ID_CONSISTENT_READ_FALSE>;
|
|
12
|
+
export default rule;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { TSESLint } from '@typescript-eslint/utils';
|
|
2
|
-
export { default as isAwsSdkV3Used } from './is-aws-sdk-v3-used.ts';
|
|
3
2
|
declare const defaultToExport: Exclude<TSESLint.FlatConfig.Plugin, 'config'> & {
|
|
4
3
|
configs: Record<string, TSESLint.FlatConfig.Config[]>;
|
|
5
4
|
};
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/eslint-plugin","version":"7.15.0-PR.
|
|
1
|
+
{"name":"@checkdigit/eslint-plugin","version":"7.15.0-PR.136-a1e2","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 .","lint:fix":"eslint --max-warnings 0 --fix .","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"dependencies":{"@typescript-eslint/type-utils":"^8.23.0","@typescript-eslint/utils":"^8.23.0","http-status-codes":"^2.3.0","ts-api-utils":"^2.0.1"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^6.1.0","@checkdigit/typescript-config":"^9.0.0","@eslint/js":"^9.19.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.23.0","@typescript-eslint/rule-tester":"^8.23.0","eslint":"^9.19.0","eslint-config-prettier":"^10.0.1","eslint-import-resolver-typescript":"^3.7.0","eslint-plugin-eslint-plugin":"^6.4.0","eslint-plugin-import":"^2.31.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^2.2.1","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","rimraf":"^6.0.1","typescript-eslint":"^8.23.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=22.14"}}
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
// aws/require-consistent-read.ts
|
|
2
|
+
|
|
3
|
+
/*
|
|
4
|
+
* Copyright (c) 2021-2025 Check Digit, LLC
|
|
5
|
+
*
|
|
6
|
+
* This code is licensed under the MIT license (see LICENSE.txt for details).
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
|
10
|
+
import getDocumentationUrl from '../get-documentation-url.ts';
|
|
11
|
+
|
|
12
|
+
export const ruleId = 'require-consistent-read';
|
|
13
|
+
export const MESSAGE_ID_CONSISTENT_READ_TRUE = 'MESSAGE_ID_CONSISTENT_READ_TRUE';
|
|
14
|
+
export const MESSAGE_ID_CONSISTENT_READ_FALSE = 'MESSAGE_ID_CONSISTENT_READ_FALSE';
|
|
15
|
+
|
|
16
|
+
interface ReadCommandInfo {
|
|
17
|
+
type: 'GetItem' | 'Query' | 'BatchGetItem';
|
|
18
|
+
consistentRead?: boolean;
|
|
19
|
+
usedIndex?: boolean;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
function getPropertyName(property: TSESTree.Property): string | undefined {
|
|
23
|
+
if (property.computed) {
|
|
24
|
+
return undefined;
|
|
25
|
+
}
|
|
26
|
+
const propertyKey = property.key;
|
|
27
|
+
// eslint-disable-next-line no-nested-ternary
|
|
28
|
+
return propertyKey.type === AST_NODE_TYPES.Identifier
|
|
29
|
+
? propertyKey.name
|
|
30
|
+
: // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
31
|
+
propertyKey.type === AST_NODE_TYPES.Literal && typeof propertyKey.value === 'string'
|
|
32
|
+
? propertyKey.value
|
|
33
|
+
: undefined;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function extractObjectProperties(objectExpression: TSESTree.ObjectExpression): Record<string, TSESTree.Property> {
|
|
37
|
+
const objectProperties: Record<string, TSESTree.Property> = {};
|
|
38
|
+
for (const property of objectExpression.properties) {
|
|
39
|
+
if (property.type !== AST_NODE_TYPES.Property || property.computed) {
|
|
40
|
+
continue;
|
|
41
|
+
}
|
|
42
|
+
const propertyName = getPropertyName(property);
|
|
43
|
+
if (propertyName !== undefined) {
|
|
44
|
+
objectProperties[propertyName] = property;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
return objectProperties;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
function existsRequestItemsProperty(extractedObjectProperties: Record<string, TSESTree.Property>): boolean {
|
|
51
|
+
const requestItemProperty = extractedObjectProperties['RequestItems'];
|
|
52
|
+
if (requestItemProperty?.type !== AST_NODE_TYPES.Property) {
|
|
53
|
+
return false;
|
|
54
|
+
}
|
|
55
|
+
const requestItemValue = requestItemProperty.value;
|
|
56
|
+
if (requestItemValue.type !== AST_NODE_TYPES.ObjectExpression) {
|
|
57
|
+
return false;
|
|
58
|
+
}
|
|
59
|
+
// any table entry with an object having a Keys array
|
|
60
|
+
return requestItemValue.properties.some(
|
|
61
|
+
(property) =>
|
|
62
|
+
property.type === AST_NODE_TYPES.Property &&
|
|
63
|
+
property.value.type === AST_NODE_TYPES.ObjectExpression &&
|
|
64
|
+
extractObjectProperties(property.value)['Keys']?.value.type === AST_NODE_TYPES.ArrayExpression,
|
|
65
|
+
);
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
function existsKeyProperty(extractedObjectProperties: Record<string, TSESTree.Property>): boolean {
|
|
69
|
+
const keyProperty = extractedObjectProperties['Key'];
|
|
70
|
+
// Relaxed: just ensure it's an object (works for both low-level and DocumentClient)
|
|
71
|
+
return keyProperty?.type === AST_NODE_TYPES.Property && keyProperty.value.type === AST_NODE_TYPES.ObjectExpression;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export function getReadCommandInfo(objectExpression: TSESTree.ObjectExpression): ReadCommandInfo | undefined {
|
|
75
|
+
const extractedProperties = extractObjectProperties(objectExpression);
|
|
76
|
+
let readCommandInfo: ReadCommandInfo | undefined;
|
|
77
|
+
|
|
78
|
+
if (existsRequestItemsProperty(extractedProperties)) {
|
|
79
|
+
readCommandInfo = { type: 'BatchGetItem' };
|
|
80
|
+
} else {
|
|
81
|
+
const hasTableName = 'TableName' in extractedProperties;
|
|
82
|
+
const hasKey = existsKeyProperty(extractedProperties);
|
|
83
|
+
if (hasTableName && hasKey) {
|
|
84
|
+
readCommandInfo = { type: 'GetItem' };
|
|
85
|
+
} else {
|
|
86
|
+
const hasKeyCondExpr = extractedProperties['KeyConditionExpression']?.value.type === AST_NODE_TYPES.Literal;
|
|
87
|
+
const hasLegacyKeyConditions =
|
|
88
|
+
extractedProperties['KeyConditions']?.value.type === AST_NODE_TYPES.ObjectExpression;
|
|
89
|
+
if (hasTableName && (hasKeyCondExpr || hasLegacyKeyConditions)) {
|
|
90
|
+
readCommandInfo = { type: 'Query' };
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
if (readCommandInfo === undefined) {
|
|
96
|
+
return undefined;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
const consistentReadProperty = extractedProperties['ConsistentRead'];
|
|
100
|
+
if (
|
|
101
|
+
consistentReadProperty?.type === AST_NODE_TYPES.Property &&
|
|
102
|
+
consistentReadProperty.value.type === AST_NODE_TYPES.Literal &&
|
|
103
|
+
typeof consistentReadProperty.value.value === 'boolean'
|
|
104
|
+
) {
|
|
105
|
+
readCommandInfo.consistentRead = consistentReadProperty.value.value;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const indexNameProperty = extractedProperties['IndexName'];
|
|
109
|
+
if (
|
|
110
|
+
indexNameProperty?.type === AST_NODE_TYPES.Property &&
|
|
111
|
+
indexNameProperty.value.type === AST_NODE_TYPES.Literal &&
|
|
112
|
+
typeof indexNameProperty.value.value === 'string'
|
|
113
|
+
) {
|
|
114
|
+
readCommandInfo.usedIndex = true;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return readCommandInfo;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
121
|
+
|
|
122
|
+
const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_CONSISTENT_READ_TRUE | typeof MESSAGE_ID_CONSISTENT_READ_FALSE> =
|
|
123
|
+
createRule({
|
|
124
|
+
name: ruleId,
|
|
125
|
+
meta: {
|
|
126
|
+
type: 'problem',
|
|
127
|
+
docs: {
|
|
128
|
+
description:
|
|
129
|
+
'For AWS dynamodb commands Query/GetItem/BatchGetItem, ConsistentRead option should be set as true unless global index is used. This will make the service more robust at the ignorable cost of RCU.',
|
|
130
|
+
},
|
|
131
|
+
messages: {
|
|
132
|
+
[MESSAGE_ID_CONSISTENT_READ_TRUE]:
|
|
133
|
+
'ConsistentRead option should be set as true for {{readCommandType}} command.',
|
|
134
|
+
[MESSAGE_ID_CONSISTENT_READ_FALSE]:
|
|
135
|
+
'ConsistentRead option should be set as false for {{readCommandType}} command when using a global secondary index.',
|
|
136
|
+
},
|
|
137
|
+
schema: [],
|
|
138
|
+
},
|
|
139
|
+
defaultOptions: [],
|
|
140
|
+
create(context) {
|
|
141
|
+
const sourceCode = context.sourceCode;
|
|
142
|
+
|
|
143
|
+
return {
|
|
144
|
+
ObjectExpression(node) {
|
|
145
|
+
// Quick prefilter: only look at objects that mention table/read-ish keys
|
|
146
|
+
const text = sourceCode.getText(node);
|
|
147
|
+
if (!/TableName|RequestItems|KeyConditionExpression|KeyConditions/u.test(text)) {
|
|
148
|
+
return;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
const readCommandInfo = getReadCommandInfo(node);
|
|
152
|
+
if (readCommandInfo !== undefined) {
|
|
153
|
+
if (readCommandInfo.usedIndex !== true && readCommandInfo.consistentRead !== true) {
|
|
154
|
+
context.report({
|
|
155
|
+
node,
|
|
156
|
+
messageId: MESSAGE_ID_CONSISTENT_READ_TRUE,
|
|
157
|
+
data: { readCommandType: readCommandInfo.type },
|
|
158
|
+
});
|
|
159
|
+
} else if (readCommandInfo.usedIndex === true && readCommandInfo.consistentRead !== false) {
|
|
160
|
+
context.report({
|
|
161
|
+
node,
|
|
162
|
+
messageId: MESSAGE_ID_CONSISTENT_READ_FALSE,
|
|
163
|
+
data: { readCommandType: readCommandInfo.type },
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
};
|
|
169
|
+
},
|
|
170
|
+
});
|
|
171
|
+
|
|
172
|
+
export default rule;
|
package/src/index.ts
CHANGED
|
@@ -26,7 +26,7 @@ import noServeRuntime, { ruleId as noServeRuntimeRuleId } from './no-serve-runti
|
|
|
26
26
|
import requireServiceCallResponseDeclaration, {
|
|
27
27
|
ruleId as requireServiceCallResponseDeclarationRuleId,
|
|
28
28
|
} from './require-service-call-response-declaration.ts';
|
|
29
|
-
import
|
|
29
|
+
import requireConsistentRead, { ruleId as requireConsistentReadRuleId } from './aws/require-consistent-read.ts';
|
|
30
30
|
import filePathComment from './file-path-comment.ts';
|
|
31
31
|
import noCardNumbers from './no-card-numbers.ts';
|
|
32
32
|
import noEnum from './no-enum.ts';
|
|
@@ -43,8 +43,6 @@ import requireStrictAssert from './require-strict-assert.ts';
|
|
|
43
43
|
import requireAssertMessage from './require-assert-message';
|
|
44
44
|
import requireTsExtensionImportsExports from './require-ts-extension-imports-exports.ts';
|
|
45
45
|
|
|
46
|
-
export { default as isAwsSdkV3Used } from './is-aws-sdk-v3-used.ts';
|
|
47
|
-
|
|
48
46
|
const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
49
47
|
'file-path-comment': filePathComment,
|
|
50
48
|
'no-card-numbers': noCardNumbers,
|
|
@@ -69,9 +67,9 @@ const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
|
69
67
|
[noDuplicatedImportsRuleId]: noDuplicatedImports,
|
|
70
68
|
[noServeRuntimeRuleId]: noServeRuntime,
|
|
71
69
|
[requireServiceCallResponseDeclarationRuleId]: requireServiceCallResponseDeclaration,
|
|
72
|
-
[requireAwsConfigRuleId]: requireAwsConfig,
|
|
73
70
|
[requireFixedServicesImportRuleId]: requireFixedServicesImport,
|
|
74
71
|
[requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
|
|
72
|
+
[requireConsistentReadRuleId]: requireConsistentRead,
|
|
75
73
|
};
|
|
76
74
|
|
|
77
75
|
const plugin: TSESLint.FlatConfig.Plugin = {
|
|
@@ -111,7 +109,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
111
109
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: 'error',
|
|
112
110
|
[`@checkdigit/${noServeRuntimeRuleId}`]: 'error',
|
|
113
111
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: 'error',
|
|
114
|
-
[`@checkdigit/${
|
|
112
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: 'error',
|
|
115
113
|
},
|
|
116
114
|
},
|
|
117
115
|
],
|
|
@@ -147,7 +145,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
147
145
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: 'error',
|
|
148
146
|
[`@checkdigit/${noServeRuntimeRuleId}`]: 'off',
|
|
149
147
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: 'off',
|
|
150
|
-
[`@checkdigit/${
|
|
148
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: 'off',
|
|
151
149
|
},
|
|
152
150
|
},
|
|
153
151
|
],
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
// src/is-aws-sdk-v3-used.ts
|
|
2
|
-
import { promises as fs } from "node:fs";
|
|
3
|
-
var cachedIsAwsSdkV3Used;
|
|
4
|
-
async function isAwsSdkV3Used() {
|
|
5
|
-
if (cachedIsAwsSdkV3Used !== void 0) {
|
|
6
|
-
return cachedIsAwsSdkV3Used;
|
|
7
|
-
}
|
|
8
|
-
const packageJson = JSON.parse(await fs.readFile("package.json", "utf8"));
|
|
9
|
-
const dependencies = packageJson.dependencies ?? {};
|
|
10
|
-
cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) => dependency.startsWith("@aws-sdk/"));
|
|
11
|
-
return cachedIsAwsSdkV3Used;
|
|
12
|
-
}
|
|
13
|
-
export {
|
|
14
|
-
isAwsSdkV3Used as default
|
|
15
|
-
};
|
|
16
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2lzLWF3cy1zZGstdjMtdXNlZC50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFFQSxTQUFTLFlBQVksVUFBVTtBQVMvQixJQUFJO0FBRUosZUFBTyxpQkFBMEQ7QUFDL0QsTUFBSSx5QkFBeUIsUUFBVztBQUN0QyxXQUFPO0FBQUEsRUFDVDtBQUVBLFFBQU0sY0FBYyxLQUFLLE1BQU0sTUFBTSxHQUFHLFNBQVMsZ0JBQWdCLE1BQU0sQ0FBQztBQUN4RSxRQUFNLGVBQWUsWUFBWSxnQkFBZ0IsQ0FBQztBQUVsRCx5QkFBdUIsT0FBTyxLQUFLLFlBQVksRUFBRSxLQUFLLENBQUMsZUFBZSxXQUFXLFdBQVcsV0FBVyxDQUFDO0FBQ3hHLFNBQU87QUFDVDsiLAogICJuYW1lcyI6IFtdCn0K
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
// src/require-aws-config.ts
|
|
2
|
-
import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
|
|
3
|
-
import getDocumentationUrl from "./get-documentation-url.mjs";
|
|
4
|
-
var ruleId = "require-aws-config";
|
|
5
|
-
var MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
6
|
-
var MESSAGE_ID_NO_CHECKDIGIT_AWS = "noCheckdigitAws";
|
|
7
|
-
var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
8
|
-
function isAwsSdkClientModule(importDeclaration) {
|
|
9
|
-
return importDeclaration.source.value.startsWith("@aws-sdk/client-");
|
|
10
|
-
}
|
|
11
|
-
function isCheckdigitAwsModule(importDeclaration) {
|
|
12
|
-
return importDeclaration.source.value === "@checkdigit/aws";
|
|
13
|
-
}
|
|
14
|
-
function isAwsClient(awsClientName, importedAwsClients) {
|
|
15
|
-
return awsClientName.endsWith("Client") && (importedAwsClients === void 0 || importedAwsClients.has(awsClientName));
|
|
16
|
-
}
|
|
17
|
-
var rule = createRule({
|
|
18
|
-
name: ruleId,
|
|
19
|
-
meta: {
|
|
20
|
-
type: "problem",
|
|
21
|
-
docs: {
|
|
22
|
-
description: "Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module."
|
|
23
|
-
},
|
|
24
|
-
messages: {
|
|
25
|
-
[MESSAGE_ID_REQUIRE_AWS_CONFIG]: "Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.",
|
|
26
|
-
[MESSAGE_ID_NO_CHECKDIGIT_AWS]: 'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.'
|
|
27
|
-
},
|
|
28
|
-
schema: []
|
|
29
|
-
},
|
|
30
|
-
defaultOptions: [],
|
|
31
|
-
create(context) {
|
|
32
|
-
const { isAwsSdkV3Used } = context.settings;
|
|
33
|
-
const importedAwsClients = /* @__PURE__ */ new Set();
|
|
34
|
-
return {
|
|
35
|
-
ImportDeclaration(node) {
|
|
36
|
-
if (isAwsSdkV3Used !== true) {
|
|
37
|
-
return;
|
|
38
|
-
}
|
|
39
|
-
if (isCheckdigitAwsModule(node)) {
|
|
40
|
-
context.report({
|
|
41
|
-
node,
|
|
42
|
-
messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS
|
|
43
|
-
});
|
|
44
|
-
return;
|
|
45
|
-
}
|
|
46
|
-
if (isAwsSdkClientModule(node)) {
|
|
47
|
-
for (const specifier of node.specifiers) {
|
|
48
|
-
if (specifier.type === AST_NODE_TYPES.ImportSpecifier && isAwsClient(specifier.local.name)) {
|
|
49
|
-
importedAwsClients.add(specifier.local.name);
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
},
|
|
54
|
-
NewExpression(node) {
|
|
55
|
-
if (isAwsSdkV3Used !== true) {
|
|
56
|
-
return;
|
|
57
|
-
}
|
|
58
|
-
if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
|
|
59
|
-
context.report({
|
|
60
|
-
node,
|
|
61
|
-
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
62
|
-
data: { awsClientName: node.callee.name }
|
|
63
|
-
});
|
|
64
|
-
} else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
|
|
65
|
-
const property = node.callee.property;
|
|
66
|
-
if (property.type === AST_NODE_TYPES.Identifier && isAwsClient(property.name, importedAwsClients)) {
|
|
67
|
-
context.report({
|
|
68
|
-
node,
|
|
69
|
-
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
70
|
-
data: { awsClientName: property.name }
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
};
|
|
76
|
-
}
|
|
77
|
-
});
|
|
78
|
-
var require_aws_config_default = rule;
|
|
79
|
-
export {
|
|
80
|
-
MESSAGE_ID_NO_CHECKDIGIT_AWS,
|
|
81
|
-
MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
82
|
-
require_aws_config_default as default,
|
|
83
|
-
ruleId
|
|
84
|
-
};
|
|
85
|
-
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL3JlcXVpcmUtYXdzLWNvbmZpZy50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFRQSxTQUFTLGdCQUFnQixtQkFBNkI7QUFDdEQsT0FBTyx5QkFBeUI7QUFFekIsSUFBTSxTQUFTO0FBQ2YsSUFBTSxnQ0FBZ0M7QUFDdEMsSUFBTSwrQkFBK0I7QUFDNUMsSUFBTSxhQUFhLFlBQVksWUFBWSxDQUFDLFNBQVMsb0JBQW9CLElBQUksQ0FBQztBQUU5RSxTQUFTLHFCQUFxQixtQkFBd0Q7QUFDcEYsU0FBTyxrQkFBa0IsT0FBTyxNQUFNLFdBQVcsa0JBQWtCO0FBQ3JFO0FBRUEsU0FBUyxzQkFBc0IsbUJBQXdEO0FBQ3JGLFNBQU8sa0JBQWtCLE9BQU8sVUFBVTtBQUM1QztBQUVBLFNBQVMsWUFBWSxlQUF1QixvQkFBMkM7QUFHckYsU0FDRSxjQUFjLFNBQVMsUUFBUSxNQUFNLHVCQUF1QixVQUFhLG1CQUFtQixJQUFJLGFBQWE7QUFFakg7QUFFQSxJQUFNLE9BQ0osV0FBVztBQUFBLEVBQ1QsTUFBTTtBQUFBLEVBQ04sTUFBTTtBQUFBLElBQ0osTUFBTTtBQUFBLElBQ04sTUFBTTtBQUFBLE1BQ0osYUFDRTtBQUFBLElBQ0o7QUFBQSxJQUNBLFVBQVU7QUFBQSxNQUNSLENBQUMsNkJBQTZCLEdBQzVCO0FBQUEsTUFDRixDQUFDLDRCQUE0QixHQUMzQjtBQUFBLElBQ0o7QUFBQSxJQUNBLFFBQVEsQ0FBQztBQUFBLEVBQ1g7QUFBQSxFQUNBLGdCQUFnQixDQUFDO0FBQUEsRUFDakIsT0FBTyxTQUFTO0FBQ2QsVUFBTSxFQUFFLGVBQWUsSUFBSSxRQUFRO0FBQ25DLFVBQU0scUJBQXFCLG9CQUFJLElBQVk7QUFFM0MsV0FBTztBQUFBLE1BQ0wsa0JBQWtCLE1BQU07QUFDdEIsWUFBSSxtQkFBbUIsTUFBTTtBQUMzQjtBQUFBLFFBQ0Y7QUFFQSxZQUFJLHNCQUFzQixJQUFJLEdBQUc7QUFDL0Isa0JBQVEsT0FBTztBQUFBLFlBQ2I7QUFBQSxZQUNBLFdBQVc7QUFBQSxVQUNiLENBQUM7QUFDRDtBQUFBLFFBQ0Y7QUFFQSxZQUFJLHFCQUFxQixJQUFJLEdBQUc7QUFDOUIscUJBQVcsYUFBYSxLQUFLLFlBQVk7QUFDdkMsZ0JBQUksVUFBVSxTQUFTLGVBQWUsbUJBQW1CLFlBQVksVUFBVSxNQUFNLElBQUksR0FBRztBQUMxRixpQ0FBbUIsSUFBSSxVQUFVLE1BQU0sSUFBSTtBQUFBLFlBQzdDO0FBQUEsVUFDRjtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsTUFFQSxjQUFjLE1BQU07QUFDbEIsWUFBSSxtQkFBbUIsTUFBTTtBQUMzQjtBQUFBLFFBQ0Y7QUFFQSxZQUFJLEtBQUssT0FBTyxTQUFTLGVBQWUsY0FBYyxZQUFZLEtBQUssT0FBTyxNQUFNLGtCQUFrQixHQUFHO0FBQ3ZHLGtCQUFRLE9BQU87QUFBQSxZQUNiO0FBQUEsWUFDQSxXQUFXO0FBQUEsWUFDWCxNQUFNLEVBQUUsZUFBZSxLQUFLLE9BQU8sS0FBSztBQUFBLFVBQzFDLENBQUM7QUFBQSxRQUNILFdBQVcsS0FBSyxPQUFPLFNBQVMsZUFBZSxrQkFBa0I7QUFFL0QsZ0JBQU0sV0FBVyxLQUFLLE9BQU87QUFDN0IsY0FBSSxTQUFTLFNBQVMsZUFBZSxjQUFjLFlBQVksU0FBUyxNQUFNLGtCQUFrQixHQUFHO0FBQ2pHLG9CQUFRLE9BQU87QUFBQSxjQUNiO0FBQUEsY0FDQSxXQUFXO0FBQUEsY0FDWCxNQUFNLEVBQUUsZUFBZSxTQUFTLEtBQUs7QUFBQSxZQUN2QyxDQUFDO0FBQUEsVUFDSDtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFDRixDQUFDO0FBRUgsSUFBTyw2QkFBUTsiLAogICJuYW1lcyI6IFtdCn0K
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export default function isAwsSdkV3Used(): Promise<boolean>;
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { ESLintUtils } from '@typescript-eslint/utils';
|
|
2
|
-
export declare const ruleId = "require-aws-config";
|
|
3
|
-
export declare const MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
4
|
-
export declare const MESSAGE_ID_NO_CHECKDIGIT_AWS = "noCheckdigitAws";
|
|
5
|
-
declare const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS>;
|
|
6
|
-
export default rule;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
// is-aws-sdk-v3-used.ts
|
|
2
|
-
|
|
3
|
-
import { promises as fs } from 'node:fs';
|
|
4
|
-
|
|
5
|
-
interface PackageJson {
|
|
6
|
-
dependencies?: Record<string, string>;
|
|
7
|
-
service?: {
|
|
8
|
-
awsSdkV2?: boolean;
|
|
9
|
-
};
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
let cachedIsAwsSdkV3Used: boolean | undefined;
|
|
13
|
-
|
|
14
|
-
export default async function isAwsSdkV3Used(): Promise<boolean> {
|
|
15
|
-
if (cachedIsAwsSdkV3Used !== undefined) {
|
|
16
|
-
return cachedIsAwsSdkV3Used;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
const packageJson = JSON.parse(await fs.readFile('package.json', 'utf8')) as PackageJson;
|
|
20
|
-
const dependencies = packageJson.dependencies ?? {};
|
|
21
|
-
// eslint-disable-next-line require-atomic-updates
|
|
22
|
-
cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) => dependency.startsWith('@aws-sdk/'));
|
|
23
|
-
return cachedIsAwsSdkV3Used;
|
|
24
|
-
}
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
// require-aws-config.ts
|
|
2
|
-
|
|
3
|
-
/*
|
|
4
|
-
* Copyright (c) 2021-2025 Check Digit, LLC
|
|
5
|
-
*
|
|
6
|
-
* This code is licensed under the MIT license (see LICENSE.txt for details).
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
|
10
|
-
import getDocumentationUrl from './get-documentation-url.ts';
|
|
11
|
-
|
|
12
|
-
export const ruleId = 'require-aws-config';
|
|
13
|
-
export const MESSAGE_ID_REQUIRE_AWS_CONFIG = 'requireAwsConfig';
|
|
14
|
-
export const MESSAGE_ID_NO_CHECKDIGIT_AWS = 'noCheckdigitAws';
|
|
15
|
-
const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
16
|
-
|
|
17
|
-
function isAwsSdkClientModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
18
|
-
return importDeclaration.source.value.startsWith('@aws-sdk/client-');
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
function isCheckdigitAwsModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
22
|
-
return importDeclaration.source.value === '@checkdigit/aws';
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
function isAwsClient(awsClientName: string, importedAwsClients?: Set<string>): boolean {
|
|
26
|
-
// for simplicity, just check if it ends with 'Client'
|
|
27
|
-
// we can consider type checking in the future if needed to verify if it actually extends from AWS SDK's Smithy Client class
|
|
28
|
-
return (
|
|
29
|
-
awsClientName.endsWith('Client') && (importedAwsClients === undefined || importedAwsClients.has(awsClientName))
|
|
30
|
-
);
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS> =
|
|
34
|
-
createRule({
|
|
35
|
-
name: ruleId,
|
|
36
|
-
meta: {
|
|
37
|
-
type: 'problem',
|
|
38
|
-
docs: {
|
|
39
|
-
description:
|
|
40
|
-
'Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module.',
|
|
41
|
-
},
|
|
42
|
-
messages: {
|
|
43
|
-
[MESSAGE_ID_REQUIRE_AWS_CONFIG]:
|
|
44
|
-
'Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.',
|
|
45
|
-
[MESSAGE_ID_NO_CHECKDIGIT_AWS]:
|
|
46
|
-
'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.',
|
|
47
|
-
},
|
|
48
|
-
schema: [],
|
|
49
|
-
},
|
|
50
|
-
defaultOptions: [],
|
|
51
|
-
create(context) {
|
|
52
|
-
const { isAwsSdkV3Used } = context.settings;
|
|
53
|
-
const importedAwsClients = new Set<string>();
|
|
54
|
-
|
|
55
|
-
return {
|
|
56
|
-
ImportDeclaration(node) {
|
|
57
|
-
if (isAwsSdkV3Used !== true) {
|
|
58
|
-
return;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
if (isCheckdigitAwsModule(node)) {
|
|
62
|
-
context.report({
|
|
63
|
-
node,
|
|
64
|
-
messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS,
|
|
65
|
-
});
|
|
66
|
-
return;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
if (isAwsSdkClientModule(node)) {
|
|
70
|
-
for (const specifier of node.specifiers) {
|
|
71
|
-
if (specifier.type === AST_NODE_TYPES.ImportSpecifier && isAwsClient(specifier.local.name)) {
|
|
72
|
-
importedAwsClients.add(specifier.local.name);
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
}
|
|
76
|
-
},
|
|
77
|
-
|
|
78
|
-
NewExpression(node) {
|
|
79
|
-
if (isAwsSdkV3Used !== true) {
|
|
80
|
-
return;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
|
|
84
|
-
context.report({
|
|
85
|
-
node,
|
|
86
|
-
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
87
|
-
data: { awsClientName: node.callee.name },
|
|
88
|
-
});
|
|
89
|
-
} else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
|
|
90
|
-
// Handle `new AWS.DynamoDBClient()` style (MemberExpression)
|
|
91
|
-
const property = node.callee.property;
|
|
92
|
-
if (property.type === AST_NODE_TYPES.Identifier && isAwsClient(property.name, importedAwsClients)) {
|
|
93
|
-
context.report({
|
|
94
|
-
node,
|
|
95
|
-
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
96
|
-
data: { awsClientName: property.name },
|
|
97
|
-
});
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
},
|
|
101
|
-
};
|
|
102
|
-
},
|
|
103
|
-
});
|
|
104
|
-
|
|
105
|
-
export default rule;
|