DF-20252 s3-csv-reader removing verbose error messages (#3340)

* DF-20252 s3-csv-reader removing verbose error messages * bucket & keyPrefix input sanitisation + tests * update dependencies * add changeset
smartcontractkit · Jul 11, 2024 · 33bd0a4 · 33bd0a4
1 parent 9f98cbf
commit 33bd0a4
Show file tree

Hide file tree

Showing 29 changed files with 533 additions and 69 deletions.
diff --git a/.changeset/nine-dogs-flow.md b/.changeset/nine-dogs-flow.md
@@ -0,0 +1,5 @@
+---
+'@chainlink/s3-csv-reader-adapter': minor
+---
+
+security mitigations
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.yarn/cache/@jest-expect-utils-npm-29.7.0-14740cc487-ef8d379778.zip b/.yarn/cache/@jest-expect-utils-npm-29.7.0-14740cc487-ef8d379778.zip
diff --git a/.yarn/cache/@jest-schemas-npm-29.6.3-292730e442-910040425f.zip b/.yarn/cache/@jest-schemas-npm-29.6.3-292730e442-910040425f.zip
diff --git a/.yarn/cache/@jest-types-npm-29.6.3-a584ca999d-f74bf512fd.zip b/.yarn/cache/@jest-types-npm-29.6.3-a584ca999d-f74bf512fd.zip
diff --git a/.yarn/cache/@sinclair-typebox-npm-0.27.8-23e206d653-297f95ff77.zip b/.yarn/cache/@sinclair-typebox-npm-0.27.8-23e206d653-297f95ff77.zip
diff --git a/.yarn/cache/@types-jest-npm-29.5.12-6459b9d012-312e8dcf92.zip b/.yarn/cache/@types-jest-npm-29.5.12-6459b9d012-312e8dcf92.zip
diff --git a/.yarn/cache/@types-node-npm-16.11.68-c2f2ea9840-7906b0fe63.zip b/.yarn/cache/@types-node-npm-16.11.68-c2f2ea9840-7906b0fe63.zip
diff --git a/.yarn/cache/@types-node-npm-20.14.10-5efcbc9009-672892cf94.zip b/.yarn/cache/@types-node-npm-20.14.10-5efcbc9009-672892cf94.zip
diff --git a/.yarn/cache/diff-sequences-npm-29.6.3-18ab2c9949-179daf9d2f.zip b/.yarn/cache/diff-sequences-npm-29.6.3-18ab2c9949-179daf9d2f.zip
diff --git a/.yarn/cache/expect-npm-29.7.0-62e9f7979e-63f97bc51f.zip b/.yarn/cache/expect-npm-29.7.0-62e9f7979e-63f97bc51f.zip
diff --git a/.yarn/cache/jest-diff-npm-29.7.0-0149e01930-6f3a7eb9cd.zip b/.yarn/cache/jest-diff-npm-29.7.0-0149e01930-6f3a7eb9cd.zip
diff --git a/.yarn/cache/jest-get-type-npm-29.6.3-500477292e-88ac9102d4.zip b/.yarn/cache/jest-get-type-npm-29.6.3-500477292e-88ac9102d4.zip
diff --git a/.yarn/cache/jest-matcher-utils-npm-29.7.0-dfc74b630e-981904a494.zip b/.yarn/cache/jest-matcher-utils-npm-29.7.0-dfc74b630e-981904a494.zip
diff --git a/.yarn/cache/jest-message-util-npm-29.7.0-7f88b6e8d1-31d53c6ed2.zip b/.yarn/cache/jest-message-util-npm-29.7.0-7f88b6e8d1-31d53c6ed2.zip
diff --git a/.yarn/cache/jest-util-npm-29.7.0-ff1d59714b-30d58af696.zip b/.yarn/cache/jest-util-npm-29.7.0-ff1d59714b-30d58af696.zip
diff --git a/.yarn/cache/pretty-format-npm-29.7.0-7d330b2ea2-dea96bc83c.zip b/.yarn/cache/pretty-format-npm-29.7.0-7d330b2ea2-dea96bc83c.zip
diff --git a/.yarn/cache/typescript-npm-5.5.3-9d4a463231-11a8673124.zip b/.yarn/cache/typescript-npm-5.5.3-9d4a463231-11a8673124.zip
diff --git a/.yarn/cache/typescript-patch-9fde7bec60-7cf7acb78a.zip b/.yarn/cache/typescript-patch-9fde7bec60-7cf7acb78a.zip
diff --git a/.yarn/cache/undici-types-npm-5.26.5-de4f7c7bb9-0097779d94.zip b/.yarn/cache/undici-types-npm-5.26.5-de4f7c7bb9-0097779d94.zip
diff --git a/packages/sources/s3-csv-reader/README.md b/packages/sources/s3-csv-reader/README.md
@@ -31,14 +31,14 @@ There are no rate limits for this adapter.
 
 ### Input Params
 
-| Required? |     Name      |   Aliases    |                                                    Description                                                    |  Type  | Options | Default | Depends On | Not Valid With |
-| :-------: | :-----------: | :----------: | :---------------------------------------------------------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
-|    ✅     |    bucket     |              |                                              The S3 bucket to query                                               | string |         |         |            |                |
-|    ✅     |   keyPrefix   | `pathPrefix` |            The path prefix of the file stored in S3. <Date.csv> is appended to search for older files.            | string |         |         |            |                |
-|    ✅     |   headerRow   |              |                        The 1-indexed row of the CSV file that contains the column headers                         | number |         |         |            |                |
-|    ✅     | matcherColumn |              |                                 The column field to compare with the matcherValue                                 | string |         |         |            |                |
-|    ✅     | matcherValue  |              |                                       The value to match with matcherField                                        | string |         |         |            |                |
-|    ✅     | resultColumn  |              | The column of the CSV file to return a result for, where the row value for matcherColumn is equal to matcherValue | string |         |         |            |                |
+| Required? |     Name      |   Aliases    |                                                               Description                                                                |  Type  | Options | Default | Depends On | Not Valid With |
+| :-------: | :-----------: | :----------: | :--------------------------------------------------------------------------------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
+|    ✅     |    bucket     |              |                                                          The S3 bucket to query                                                          | string |         |         |            |                |
+|    ✅     |   keyPrefix   | `pathPrefix` | The path prefix of the file stored in S3. Will be prefixed onto <DATE>.csv to search for older files, e.g. 'path/prefix-01-02-2024.csv'. | string |         |         |            |                |
+|    ✅     |   headerRow   |              |                                    The 1-indexed row of the CSV file that contains the column headers                                    | number |         |         |            |                |
+|    ✅     | matcherColumn |              |                                            The column field to compare with the matcherValue                                             | string |         |         |            |                |
+|    ✅     | matcherValue  |              |                                                   The value to match with matcherField                                                   | string |         |         |            |                |
+|    ✅     | resultColumn  |              |            The column of the CSV file to return a result for, where the row value for matcherColumn is equal to matcherValue             | string |         |         |            |                |
 
 ### Example
 
@@ -48,7 +48,7 @@ Request:
 {
   "data": {
     "endpoint": "csv",
-    "bucket": "s3_bucket",
+    "bucket": "s3-bucket",
     "keyPrefix": "path/to/file",
     "headerRow": 2,
     "matcherColumn": "matcherColumn",

diff --git a/packages/sources/s3-csv-reader/package.json b/packages/sources/s3-csv-reader/package.json
@@ -28,16 +28,16 @@
     "start": "yarn server:dist"
   },
   "devDependencies": {
-    "@types/jest": "27.5.2",
-    "@types/node": "16.11.68",
+    "@types/jest": "29.5.12",
+    "@types/node": "20.14.10",
     "nock": "13.5.4",
-    "typescript": "5.0.4"
+    "typescript": "5.5.3"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.600.0",
     "@chainlink/external-adapter-framework": "1.1.0",
     "csv-parse": "5.5.6",
     "date-fns": "3.6.0",
-    "tslib": "2.4.1"
+    "tslib": "2.6.3"
   }
 }