skuba 0.0.0-master-20230319220011 → 0.0.0-master-20230718070720

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.
Files changed (169) hide show
  1. package/README.md +1 -1
  2. package/config/tsconfig.json +3 -1
  3. package/lib/api/buildkite/md.js.map +1 -1
  4. package/lib/api/git/currentBranch.js +2 -1
  5. package/lib/api/git/currentBranch.js.map +2 -2
  6. package/lib/api/git/findRoot.d.ts +9 -0
  7. package/lib/api/git/findRoot.js +52 -0
  8. package/lib/api/git/findRoot.js.map +7 -0
  9. package/lib/api/git/index.d.ts +1 -0
  10. package/lib/api/git/index.js +3 -0
  11. package/lib/api/git/index.js.map +2 -2
  12. package/lib/api/git/pull.js.map +1 -1
  13. package/lib/api/git/push.js.map +1 -1
  14. package/lib/api/git/remote.js +2 -1
  15. package/lib/api/git/remote.js.map +2 -2
  16. package/lib/api/git/reset.js.map +1 -1
  17. package/lib/api/github/checkRun.d.ts +1 -1
  18. package/lib/api/github/checkRun.js.map +2 -2
  19. package/lib/api/github/environment.js.map +1 -1
  20. package/lib/api/github/issueComment.js.map +1 -1
  21. package/lib/api/github/pullRequest.js +3 -2
  22. package/lib/api/github/pullRequest.js.map +2 -2
  23. package/lib/api/github/push.js.map +1 -1
  24. package/lib/api/jest/index.d.ts +24 -21
  25. package/lib/api/net/compose.js.map +1 -1
  26. package/lib/api/net/socket.js.map +1 -1
  27. package/lib/cli/adapter/eslint.js +0 -24
  28. package/lib/cli/adapter/eslint.js.map +2 -2
  29. package/lib/cli/adapter/prettier.d.ts +1 -1
  30. package/lib/cli/adapter/prettier.js +14 -11
  31. package/lib/cli/adapter/prettier.js.map +2 -2
  32. package/lib/cli/build/assets.d.ts +10 -0
  33. package/lib/cli/build/assets.js +107 -0
  34. package/lib/cli/build/assets.js.map +7 -0
  35. package/lib/cli/build/esbuild.js +7 -42
  36. package/lib/cli/build/esbuild.js.map +3 -3
  37. package/lib/cli/build/index.js +12 -2
  38. package/lib/cli/build/index.js.map +2 -2
  39. package/lib/cli/build/tsc.d.ts +3 -0
  40. package/lib/cli/build/tsc.js +66 -0
  41. package/lib/cli/build/tsc.js.map +3 -3
  42. package/lib/cli/buildPackage.js +13 -0
  43. package/lib/cli/buildPackage.js.map +2 -2
  44. package/lib/cli/configure/addEmptyExports.js +1 -1
  45. package/lib/cli/configure/addEmptyExports.js.map +2 -2
  46. package/lib/cli/configure/analyseDependencies.js +1 -1
  47. package/lib/cli/configure/analyseDependencies.js.map +2 -2
  48. package/lib/cli/configure/analysis/files.js.map +1 -1
  49. package/lib/cli/configure/analysis/package.js.map +1 -1
  50. package/lib/cli/configure/analysis/project.js +7 -3
  51. package/lib/cli/configure/analysis/project.js.map +2 -2
  52. package/lib/cli/configure/ensureTemplateCompletion.js +1 -1
  53. package/lib/cli/configure/ensureTemplateCompletion.js.map +2 -2
  54. package/lib/cli/configure/getEntryPoint.js +3 -0
  55. package/lib/cli/configure/getEntryPoint.js.map +3 -3
  56. package/lib/cli/configure/index.js.map +1 -1
  57. package/lib/cli/configure/modules/jest.js +2 -2
  58. package/lib/cli/configure/modules/jest.js.map +2 -2
  59. package/lib/cli/configure/modules/skubaDive.js.map +1 -1
  60. package/lib/cli/configure/modules/tsconfig.js.map +1 -1
  61. package/lib/cli/configure/patchRenovateConfig.js +9 -4
  62. package/lib/cli/configure/patchRenovateConfig.js.map +2 -2
  63. package/lib/cli/configure/patchServerListener.js +1 -1
  64. package/lib/cli/configure/patchServerListener.js.map +2 -2
  65. package/lib/cli/configure/processing/ignoreFile.js.map +1 -1
  66. package/lib/cli/configure/processing/javascript.js.map +1 -1
  67. package/lib/cli/configure/processing/json.d.ts +1 -1
  68. package/lib/cli/configure/processing/json.js.map +1 -1
  69. package/lib/cli/configure/processing/module.js.map +1 -1
  70. package/lib/cli/configure/processing/package.d.ts +2 -2
  71. package/lib/cli/configure/processing/prettier.d.ts +1 -1
  72. package/lib/cli/configure/processing/typescript.d.ts +2 -2
  73. package/lib/cli/configure/processing/typescript.js +14 -6
  74. package/lib/cli/configure/processing/typescript.js.map +2 -2
  75. package/lib/cli/configure/refreshIgnoreFiles.js.map +1 -1
  76. package/lib/cli/configure/types.d.ts +1 -1
  77. package/lib/cli/configure/types.js.map +1 -1
  78. package/lib/cli/init/getConfig.js +4 -1
  79. package/lib/cli/init/getConfig.js.map +2 -2
  80. package/lib/cli/init/git.js.map +1 -1
  81. package/lib/cli/init/index.js.map +1 -1
  82. package/lib/cli/init/prompts.js +1 -1
  83. package/lib/cli/init/prompts.js.map +2 -2
  84. package/lib/cli/init/writePackageJson.js +1 -1
  85. package/lib/cli/init/writePackageJson.js.map +2 -2
  86. package/lib/cli/lint/annotate/buildkite/prettier.js.map +2 -2
  87. package/lib/cli/lint/annotate/github/eslint.js.map +1 -1
  88. package/lib/cli/lint/annotate/github/index.js.map +1 -1
  89. package/lib/cli/lint/annotate/github/tsc.js +1 -1
  90. package/lib/cli/lint/annotate/github/tsc.js.map +2 -2
  91. package/lib/cli/lint/autofix.js +6 -0
  92. package/lib/cli/lint/autofix.js.map +2 -2
  93. package/lib/cli/lint/external.js.map +1 -1
  94. package/lib/cli/lint/internal.js.map +1 -1
  95. package/lib/cli/lint/tsc.js.map +1 -1
  96. package/lib/cli/test/reporters/github/annotations.js +1 -1
  97. package/lib/cli/test/reporters/github/annotations.js.map +2 -2
  98. package/lib/cli/test/reporters/github/index.js +0 -2
  99. package/lib/cli/test/reporters/github/index.js.map +1 -1
  100. package/lib/skuba.js +1 -0
  101. package/lib/skuba.js.map +2 -2
  102. package/lib/utils/args.d.ts +1 -1
  103. package/lib/utils/args.js.map +2 -2
  104. package/lib/utils/command.js +1 -1
  105. package/lib/utils/command.js.map +2 -2
  106. package/lib/utils/copy.d.ts +1 -0
  107. package/lib/utils/copy.js +6 -1
  108. package/lib/utils/copy.js.map +2 -2
  109. package/lib/utils/dir.d.ts +3 -2
  110. package/lib/utils/dir.js +6 -6
  111. package/lib/utils/dir.js.map +2 -2
  112. package/lib/utils/exec.js.map +1 -1
  113. package/lib/utils/logging.js.map +1 -1
  114. package/lib/utils/logo.js.map +1 -1
  115. package/lib/utils/manifest.d.ts +1 -0
  116. package/lib/utils/manifest.js +8 -2
  117. package/lib/utils/manifest.js.map +2 -2
  118. package/lib/utils/validation.d.ts +2 -2
  119. package/lib/utils/validation.js.map +2 -2
  120. package/lib/utils/version.js.map +1 -1
  121. package/lib/utils/wait.js.map +1 -1
  122. package/lib/utils/worker.js.map +1 -1
  123. package/lib/wrapper/functionHandler.js.map +1 -1
  124. package/lib/wrapper/http.js.map +1 -1
  125. package/lib/wrapper/index.js.map +1 -1
  126. package/lib/wrapper/main.js.map +2 -2
  127. package/lib/wrapper/requestListener.js +3 -0
  128. package/lib/wrapper/requestListener.js.map +2 -2
  129. package/package.json +28 -25
  130. package/template/base/.github/CODEOWNERS +0 -4
  131. package/template/base/_.prettierignore +0 -13
  132. package/template/express-rest-api/.buildkite/pipeline.yml +1 -1
  133. package/template/express-rest-api/gantry.apply.yml +0 -2
  134. package/template/express-rest-api/package.json +2 -2
  135. package/template/express-rest-api/src/api/healthCheck.ts +1 -1
  136. package/template/express-rest-api/src/api/smokeTest.ts +1 -1
  137. package/template/greeter/.buildkite/pipeline.yml +1 -1
  138. package/template/greeter/package.json +1 -1
  139. package/template/koa-rest-api/.buildkite/pipeline.yml +1 -1
  140. package/template/koa-rest-api/gantry.apply.yml +0 -2
  141. package/template/koa-rest-api/package.json +7 -7
  142. package/template/koa-rest-api/src/api/healthCheck.ts +1 -1
  143. package/template/koa-rest-api/src/api/jobs/getJobs.ts +1 -1
  144. package/template/koa-rest-api/src/api/jobs/postJob.ts +1 -1
  145. package/template/koa-rest-api/src/api/smokeTest.ts +1 -1
  146. package/template/koa-rest-api/src/framework/server.test.ts +1 -1
  147. package/template/koa-rest-api/src/framework/validation.ts +2 -2
  148. package/template/koa-rest-api/src/storage/jobs.ts +1 -1
  149. package/template/koa-rest-api/src/testing/server.ts +2 -2
  150. package/template/koa-rest-api/src/testing/types.ts +1 -1
  151. package/template/lambda-sqs-worker/.buildkite/pipeline.yml +2 -2
  152. package/template/lambda-sqs-worker/package.json +9 -9
  153. package/template/lambda-sqs-worker/src/app.test.ts +1 -1
  154. package/template/lambda-sqs-worker/src/app.ts +10 -5
  155. package/template/lambda-sqs-worker/src/framework/handler.test.ts +4 -4
  156. package/template/lambda-sqs-worker/src/framework/handler.ts +1 -1
  157. package/template/lambda-sqs-worker/src/framework/validation.ts +1 -1
  158. package/template/lambda-sqs-worker/src/mapping/jobScorer.ts +5 -2
  159. package/template/lambda-sqs-worker/src/services/jobScorer.ts +6 -6
  160. package/template/lambda-sqs-worker/src/testing/handler.ts +3 -3
  161. package/template/lambda-sqs-worker/src/testing/logging.ts +3 -0
  162. package/template/lambda-sqs-worker/src/testing/types.ts +1 -1
  163. package/template/lambda-sqs-worker-cdk/.buildkite/pipeline.yml +2 -2
  164. package/template/lambda-sqs-worker-cdk/infra/appStack.ts +1 -1
  165. package/template/lambda-sqs-worker-cdk/package.json +2 -2
  166. package/template/lambda-sqs-worker-cdk/src/app.ts +1 -1
  167. package/template/oss-npm-package/.github/workflows/release.yml +1 -0
  168. package/template/oss-npm-package/_package.json +4 -1
  169. package/template/private-npm-package/_package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../src/wrapper/requestListener.ts"],
4
- "sourcesContent": ["import http from 'http';\n\nimport { isFunction, isIpPort, isObject } from '../utils/validation';\n\nimport { serveRequestListener, startServer } from './http';\n\n// Express compatibility\ninterface FunctionConfig extends http.RequestListener {\n port?: number;\n}\n\ninterface ObjectConfig {\n // Koa compatibility\n callback?: () => http.RequestListener;\n\n requestListener?: http.RequestListener;\n\n // Fastify compatibility\n server?: http.Server;\n\n default?: Promise<unknown>;\n port?: unknown;\n}\n\nconst isConfig = (\n data: unknown,\n): data is Promise<FunctionConfig> | Promise<ObjectConfig> =>\n isFunction(data) || isObject(data);\n\ninterface Args {\n availablePort?: number;\n entryPoint: unknown;\n}\n\n/**\n * Create an HTTP server that calls into an exported `http.RequestListener`.\n *\n * This supports Express and Koa applications out of the box.\n */\nexport const runRequestListener = async ({\n availablePort,\n entryPoint,\n}: Args): Promise<void> => {\n if (!isConfig(entryPoint)) {\n // Assume an executable script with weird exports\n return;\n }\n\n let config: FunctionConfig | ObjectConfig = await entryPoint;\n\n if (typeof config === 'object' && isConfig(config.default)) {\n // Prefer `export default` over `export =`\n config = await config.default;\n }\n\n if (Object.keys(config).length === 0) {\n // Assume an executable script with no exports\n return;\n }\n\n const port = isIpPort(config.port) ? config.port : availablePort;\n\n // Fastify workaround\n if (\n typeof config !== 'function' &&\n config.server &&\n config.server instanceof http.Server\n ) {\n return startServer(config.server, port);\n }\n\n const requestListener =\n typeof config === 'function'\n ? config\n : config.requestListener ?? config.callback?.();\n\n if (typeof requestListener !== 'function') {\n // Assume an executable script with non-request listener exports\n return;\n }\n\n return serveRequestListener(requestListener, port);\n};\n"],
5
- "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,wBAA+C;AAE/C,IAAAA,eAAkD;AAoBlD,MAAM,WAAW,CACf,aAEA,8BAAW,IAAI,SAAK,4BAAS,IAAI;AAY5B,MAAM,qBAAqB,OAAO;AAAA,EACvC;AAAA,EACA;AACF,MAA2B;AACzB,MAAI,CAAC,SAAS,UAAU,GAAG;AAEzB;AAAA,EACF;AAEA,MAAI,SAAwC,MAAM;AAElD,MAAI,OAAO,WAAW,YAAY,SAAS,OAAO,OAAO,GAAG;AAE1D,aAAS,MAAM,OAAO;AAAA,EACxB;AAEA,MAAI,OAAO,KAAK,MAAM,EAAE,WAAW,GAAG;AAEpC;AAAA,EACF;AAEA,QAAM,WAAO,4BAAS,OAAO,IAAI,IAAI,OAAO,OAAO;AAGnD,MACE,OAAO,WAAW,cAClB,OAAO,UACP,OAAO,kBAAkB,YAAAC,QAAK,QAC9B;AACA,eAAO,0BAAY,OAAO,QAAQ,IAAI;AAAA,EACxC;AAEA,QAAM,kBACJ,OAAO,WAAW,aACd,SACA,OAAO,mBAAmB,OAAO,WAAW;AAElD,MAAI,OAAO,oBAAoB,YAAY;AAEzC;AAAA,EACF;AAEA,aAAO,mCAAqB,iBAAiB,IAAI;AACnD;",
4
+ "sourcesContent": ["import http from 'http';\n\nimport { isFunction, isIpPort, isObject } from '../utils/validation';\n\nimport { serveRequestListener, startServer } from './http';\n\n// Express compatibility\ninterface FunctionConfig extends http.RequestListener {\n port?: number;\n}\n\ninterface ObjectConfig {\n // Koa compatibility\n callback?: () => http.RequestListener;\n\n requestListener?: http.RequestListener;\n\n // Fastify compatibility\n server?: http.Server;\n\n default?: Promise<unknown>;\n port?: unknown;\n}\n\nconst isConfig = (\n data: unknown,\n): data is Promise<FunctionConfig> | Promise<ObjectConfig> =>\n isFunction(data) || isObject(data);\n\ninterface Args {\n availablePort?: number;\n entryPoint: unknown;\n}\n\n/**\n * Create an HTTP server that calls into an exported `http.RequestListener`.\n *\n * This supports Express and Koa applications out of the box.\n */\nexport const runRequestListener = async ({\n availablePort,\n entryPoint,\n}: Args): Promise<void> => {\n if (!isConfig(entryPoint)) {\n // Assume an executable script with weird exports\n return;\n }\n\n let config: FunctionConfig | ObjectConfig = await entryPoint;\n\n if (typeof config === 'object' && isConfig(config.default)) {\n // Prefer `export default` over `export =`\n config = await config.default;\n }\n\n if (Object.keys(config).length === 0) {\n // Assume an executable script with no exports\n return;\n }\n\n const port = isIpPort(config.port) ? config.port : availablePort;\n\n // http.Server support\n if (typeof config !== 'function' && config instanceof http.Server) {\n return startServer(config, port);\n }\n\n // Fastify workaround\n if (\n typeof config !== 'function' &&\n config.server &&\n config.server instanceof http.Server\n ) {\n return startServer(config.server, port);\n }\n\n const requestListener =\n typeof config === 'function'\n ? config\n : config.requestListener ?? config.callback?.();\n\n if (typeof requestListener !== 'function') {\n // Assume an executable script with non-request listener exports\n return;\n }\n\n return serveRequestListener(requestListener, port);\n};\n"],
5
+ "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,wBAA+C;AAE/C,IAAAA,eAAkD;AAoBlD,MAAM,WAAW,CACf,aAEA,8BAAW,IAAI,SAAK,4BAAS,IAAI;AAY5B,MAAM,qBAAqB,OAAO;AAAA,EACvC;AAAA,EACA;AACF,MAA2B;AACzB,MAAI,CAAC,SAAS,UAAU,GAAG;AAEzB;AAAA,EACF;AAEA,MAAI,SAAwC,MAAM;AAElD,MAAI,OAAO,WAAW,YAAY,SAAS,OAAO,OAAO,GAAG;AAE1D,aAAS,MAAM,OAAO;AAAA,EACxB;AAEA,MAAI,OAAO,KAAK,MAAM,EAAE,WAAW,GAAG;AAEpC;AAAA,EACF;AAEA,QAAM,WAAO,4BAAS,OAAO,IAAI,IAAI,OAAO,OAAO;AAGnD,MAAI,OAAO,WAAW,cAAc,kBAAkB,YAAAC,QAAK,QAAQ;AACjE,eAAO,0BAAY,QAAQ,IAAI;AAAA,EACjC;AAGA,MACE,OAAO,WAAW,cAClB,OAAO,UACP,OAAO,kBAAkB,YAAAA,QAAK,QAC9B;AACA,eAAO,0BAAY,OAAO,QAAQ,IAAI;AAAA,EACxC;AAEA,QAAM,kBACJ,OAAO,WAAW,aACd,SACA,OAAO,mBAAmB,OAAO,WAAW;AAElD,MAAI,OAAO,oBAAoB,YAAY;AAEzC;AAAA,EACF;AAEA,aAAO,mCAAqB,iBAAiB,IAAI;AACnD;",
6
6
  "names": ["import_http", "http"]
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "skuba",
3
- "version": "0.0.0-master-20230319220011",
3
+ "version": "0.0.0-master-20230718070720",
4
4
  "private": false,
5
5
  "description": "SEEK development toolkit for backend applications and packages",
6
6
  "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -65,25 +65,25 @@
65
65
  ]
66
66
  },
67
67
  "resolutions": {
68
- "**/@types/node": ">=16.11"
68
+ "**/@types/node": ">=18.12"
69
69
  },
70
70
  "dependencies": {
71
71
  "@esbuild-plugins/tsconfig-paths": "^0.1.0",
72
72
  "@jest/types": "^29.0.0",
73
- "@octokit/graphql": "^5.0.0",
74
- "@octokit/graphql-schema": "^13.0.0",
75
- "@octokit/rest": "^19.0.0",
76
- "@octokit/types": "^9.0.0",
73
+ "@octokit/graphql": "^7.0.0",
74
+ "@octokit/graphql-schema": "^14.5.0",
75
+ "@octokit/rest": "^20.0.0",
76
+ "@octokit/types": "^11.0.0",
77
77
  "@types/jest": "^29.0.0",
78
- "@types/node": ">=16.11",
78
+ "@types/node": ">=18.12",
79
79
  "chalk": "^4.1.0",
80
- "concurrently": "^7.0.0",
80
+ "concurrently": "^8.0.0",
81
81
  "dotenv": "^16.0.0",
82
82
  "ejs": "^3.1.6",
83
83
  "enquirer": "^2.3.6",
84
- "esbuild": "~0.17.0",
84
+ "esbuild": "~0.18.0",
85
85
  "eslint": "^8.11.0",
86
- "eslint-config-skuba": "1.4.1",
86
+ "eslint-config-skuba": "2.0.4",
87
87
  "execa": "^5.0.0",
88
88
  "fdir": "^6.0.0",
89
89
  "fs-extra": "^11.0.0",
@@ -102,31 +102,31 @@
102
102
  "npm-run-path": "^4.0.1",
103
103
  "npm-which": "^3.0.1",
104
104
  "picomatch": "^2.2.2",
105
- "prettier": "~2.8.0",
105
+ "prettier": "~3.0.0",
106
106
  "read-pkg-up": "^7.0.1",
107
107
  "runtypes": "^6.0.0",
108
- "semantic-release": "^19.0.0",
108
+ "semantic-release": "^21.0.0",
109
109
  "serialize-error": "^8.0.1",
110
110
  "simple-git": "^3.5.0",
111
111
  "sort-package-json": "^1.57.0",
112
112
  "strip-ansi": "^6.0.1",
113
113
  "ts-dedent": "^2.2.0",
114
- "ts-jest": "^29.0.3",
114
+ "ts-jest": "^29.1.0",
115
115
  "ts-node": "^10.7.0",
116
116
  "ts-node-dev": "^2.0.0",
117
117
  "tsconfig-paths": "^4.0.0",
118
- "tsconfig-seek": "1.0.2",
119
- "typescript": "~5.0.0",
118
+ "tsconfig-seek": "2.0.0",
119
+ "typescript": "~5.1.5",
120
120
  "validate-npm-package-name": "^5.0.0"
121
121
  },
122
122
  "devDependencies": {
123
- "@changesets/cli": "2.26.0",
123
+ "@changesets/cli": "2.26.2",
124
124
  "@changesets/get-github-info": "0.5.2",
125
- "@jest/reporters": "29.4.3",
125
+ "@jest/reporters": "29.6.1",
126
126
  "@types/ejs": "3.1.2",
127
127
  "@types/express": "4.17.17",
128
128
  "@types/fs-extra": "11.0.1",
129
- "@types/koa": "2.13.5",
129
+ "@types/koa": "2.13.6",
130
130
  "@types/libnpmsearch": "2.0.3",
131
131
  "@types/lodash.mergewith": "4.6.7",
132
132
  "@types/module-alias": "2.0.1",
@@ -134,15 +134,15 @@
134
134
  "@types/picomatch": "2.3.0",
135
135
  "@types/supertest": "2.0.12",
136
136
  "@types/validate-npm-package-name": "4.0.0",
137
- "enhanced-resolve": "5.12.0",
137
+ "enhanced-resolve": "5.15.0",
138
138
  "express": "4.18.2",
139
- "fastify": "4.13.0",
139
+ "fastify": "4.19.2",
140
140
  "jsonfile": "6.1.0",
141
- "koa": "2.14.1",
142
- "memfs": "3.4.13",
141
+ "koa": "2.14.2",
142
+ "memfs": "4.2.0",
143
143
  "remark-cli": "11.0.0",
144
- "remark-preset-lint-recommended": "6.1.2",
145
- "semver": "7.3.8",
144
+ "remark-preset-lint-recommended": "6.1.3",
145
+ "semver": "7.5.4",
146
146
  "supertest": "6.3.3",
147
147
  "type-fest": "2.19.0"
148
148
  },
@@ -155,7 +155,10 @@
155
155
  }
156
156
  },
157
157
  "engines": {
158
- "node": ">=16.11"
158
+ "node": ">=18.12"
159
+ },
160
+ "publishConfig": {
161
+ "provenance": true
159
162
  },
160
163
  "skuba": {
161
164
  "build": "esbuild",
@@ -1,5 +1 @@
1
1
  * @<%- ownerName %>
2
-
3
- # Configured by Renovate
4
- package.json
5
- yarn.lock
@@ -1,17 +1,4 @@
1
1
  # managed by skuba
2
- .idea/*
3
- .vscode/*
4
-
5
- .cdk.staging/
6
- .serverless/
7
- cdk.out/
8
- node_modules*/
9
-
10
- /coverage*/
11
- /dist*/
12
- /lib*/
13
- /tmp*/
14
-
15
2
  # Gantry resource files support non-standard template syntax
16
3
  /.gantry/**/*.yaml
17
4
  /.gantry/**/*.yml
@@ -51,7 +51,7 @@ steps:
51
51
  - *aws-sm
52
52
  - *private-npm
53
53
  - *docker-ecr-cache
54
- - docker-compose#v4.11.0:
54
+ - docker-compose#v4.14.0:
55
55
  run: app
56
56
  timeout_in_minutes: 10
57
57
 
@@ -108,8 +108,6 @@ cpu: 256
108
108
  memory: 512
109
109
 
110
110
  deployment:
111
- # SEEK-Jobs/gantry#488
112
- ignoreAlarms: true
113
111
  smokeTest:
114
112
  path: /smoke
115
113
  useExternalDns: true
@@ -12,7 +12,7 @@
12
12
  "test:watch": "skuba test --watch"
13
13
  },
14
14
  "dependencies": {
15
- "@seek/logger": "^5.0.1",
15
+ "@seek/logger": "^6.0.0",
16
16
  "express": "^4.17.1",
17
17
  "skuba-dive": "^2.0.0"
18
18
  },
@@ -25,6 +25,6 @@
25
25
  "supertest": "^6.1.6"
26
26
  },
27
27
  "engines": {
28
- "node": ">=18"
28
+ "node": ">=18.12"
29
29
  }
30
30
  }
@@ -1,4 +1,4 @@
1
- import { Handler } from 'express';
1
+ import type { Handler } from 'express';
2
2
 
3
3
  /**
4
4
  * Signifies that the API is available to serve requests.
@@ -1,4 +1,4 @@
1
- import { Handler } from 'express';
1
+ import type { Handler } from 'express';
2
2
 
3
3
  /**
4
4
  * Tests connectivity to ensure appropriate access and network configuration.
@@ -32,6 +32,6 @@ steps:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v4.11.0:
35
+ - docker-compose#v4.14.0:
36
36
  run: app
37
37
  timeout_in_minutes: 10
@@ -19,6 +19,6 @@
19
19
  "skuba": "*"
20
20
  },
21
21
  "engines": {
22
- "node": ">=18"
22
+ "node": ">=18.12"
23
23
  }
24
24
  }
@@ -51,7 +51,7 @@ steps:
51
51
  - *aws-sm
52
52
  - *private-npm
53
53
  - *docker-ecr-cache
54
- - docker-compose#v4.11.0:
54
+ - docker-compose#v4.14.0:
55
55
  run: app
56
56
  timeout_in_minutes: 10
57
57
 
@@ -115,8 +115,6 @@ cpu: 256
115
115
  memory: 512
116
116
 
117
117
  deployment:
118
- # SEEK-Jobs/gantry#488
119
- ignoreAlarms: true
120
118
  smokeTest:
121
119
  path: /smoke
122
120
  useExternalDns: true
@@ -14,17 +14,17 @@
14
14
  "dependencies": {
15
15
  "@koa/router": "^12.0.0",
16
16
  "@opentelemetry/api": "^1.1.0",
17
- "@opentelemetry/exporter-trace-otlp-grpc": "^0.36.0",
18
- "@opentelemetry/instrumentation-aws-sdk": "^0.34.0",
19
- "@opentelemetry/instrumentation-http": "^0.36.0",
20
- "@opentelemetry/sdk-node": "^0.36.0",
21
- "@seek/logger": "^5.0.1",
17
+ "@opentelemetry/exporter-trace-otlp-grpc": "^0.41.0",
18
+ "@opentelemetry/instrumentation-aws-sdk": "^0.35.0",
19
+ "@opentelemetry/instrumentation-http": "^0.41.0",
20
+ "@opentelemetry/sdk-node": "^0.41.0",
21
+ "@seek/logger": "^6.0.0",
22
22
  "aws-sdk": "^2.1039.0",
23
23
  "hot-shots": "^10.0.0",
24
24
  "koa": "^2.13.4",
25
25
  "koa-bodyparser": "^4.3.0",
26
26
  "koa-compose": "^4.2.0",
27
- "seek-datadog-custom-metrics": "^4.0.0",
27
+ "seek-datadog-custom-metrics": "^4.2.1",
28
28
  "seek-koala": "^6.0.0",
29
29
  "skuba-dive": "^2.0.0",
30
30
  "zod": "^3.19.1"
@@ -42,6 +42,6 @@
42
42
  "supertest": "^6.1.6"
43
43
  },
44
44
  "engines": {
45
- "node": ">=18"
45
+ "node": ">=18.12"
46
46
  }
47
47
  }
@@ -1,4 +1,4 @@
1
- import { Middleware } from 'src/types/koa';
1
+ import type { Middleware } from 'src/types/koa';
2
2
 
3
3
  /**
4
4
  * Signifies that the API is available to serve requests.
@@ -1,7 +1,7 @@
1
1
  import { logger } from 'src/framework/logging';
2
2
  import { metricsClient } from 'src/framework/metrics';
3
3
  import * as storage from 'src/storage/jobs';
4
- import { Middleware } from 'src/types/koa';
4
+ import type { Middleware } from 'src/types/koa';
5
5
 
6
6
  export const getJobsHandler: Middleware = async (ctx) => {
7
7
  const jobs = await storage.readJobs();
@@ -3,7 +3,7 @@ import { metricsClient } from 'src/framework/metrics';
3
3
  import { validateRequestBody } from 'src/framework/validation';
4
4
  import * as storage from 'src/storage/jobs';
5
5
  import { JobInputSchema } from 'src/types/jobs';
6
- import { Middleware } from 'src/types/koa';
6
+ import type { Middleware } from 'src/types/koa';
7
7
 
8
8
  export const postJobHandler: Middleware = async (ctx) => {
9
9
  const jobInput = validateRequestBody(ctx, JobInputSchema);
@@ -1,5 +1,5 @@
1
1
  import { smokeTestJobStorage } from 'src/storage/jobs';
2
- import { Middleware } from 'src/types/koa';
2
+ import type { Middleware } from 'src/types/koa';
3
3
 
4
4
  /**
5
5
  * Tests connectivity to ensure appropriate access and network configuration.
@@ -4,7 +4,7 @@ import { logger } from 'src/testing/logging';
4
4
  import { metricsClient } from 'src/testing/metrics';
5
5
  import { agentFromRouter } from 'src/testing/server';
6
6
  import { chance } from 'src/testing/types';
7
- import { Middleware } from 'src/types/koa';
7
+ import type { Middleware } from 'src/types/koa';
8
8
 
9
9
  const middleware = jest.fn<void, Parameters<Middleware>>();
10
10
 
@@ -1,7 +1,7 @@
1
1
  import { ErrorMiddleware } from 'seek-koala';
2
- import { z } from 'zod';
2
+ import type { z } from 'zod';
3
3
 
4
- import { Context } from 'src/types/koa';
4
+ import type { Context } from 'src/types/koa';
5
5
 
6
6
  /**
7
7
  * Converts a `ZodError` into an `invalidFields` object
@@ -1,6 +1,6 @@
1
1
  import { randomUUID } from 'crypto';
2
2
 
3
- import { Job, JobInput } from 'src/types/jobs';
3
+ import type { Job, JobInput } from 'src/types/jobs';
4
4
 
5
5
  const jobStore: Record<string, Job> = {};
6
6
 
@@ -1,5 +1,5 @@
1
- import Router from '@koa/router';
2
- import Koa from 'koa';
1
+ import type Router from '@koa/router';
2
+ import type Koa from 'koa';
3
3
  import request from 'supertest';
4
4
 
5
5
  import { createApp } from 'src/framework/server';
@@ -1,7 +1,7 @@
1
1
  import { Chance } from 'chance';
2
2
  import { z } from 'zod';
3
3
 
4
- import { JobInput } from 'src/types/jobs';
4
+ import type { JobInput } from 'src/types/jobs';
5
5
 
6
6
  export type IdDescription = z.infer<typeof IdDescriptionSchema>;
7
7
 
@@ -32,7 +32,7 @@ configs:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v4.11.0:
35
+ - docker-compose#v4.14.0:
36
36
  dependencies: false
37
37
  run: app
38
38
  retry:
@@ -60,7 +60,7 @@ steps:
60
60
  - *aws-sm
61
61
  - *private-npm
62
62
  - *docker-ecr-cache
63
- - docker-compose#v4.11.0:
63
+ - docker-compose#v4.14.0:
64
64
  run: app
65
65
  timeout_in_minutes: 10
66
66
 
@@ -14,13 +14,13 @@
14
14
  "test:watch": "skuba test --watch"
15
15
  },
16
16
  "dependencies": {
17
- "@aws-sdk/client-codedeploy": "^3.259.0",
18
- "@aws-sdk/client-lambda": "^3.259.0",
19
- "@aws-sdk/client-sns": "^3.259.0",
17
+ "@aws-sdk/client-codedeploy": "^3.363.0",
18
+ "@aws-sdk/client-lambda": "^3.363.0",
19
+ "@aws-sdk/client-sns": "^3.363.0",
20
20
  "@aws-sdk/util-utf8-node": "^3.259.0",
21
- "@seek/logger": "^5.0.1",
22
- "datadog-lambda-js": "^6.83.0",
23
- "dd-trace": "^3.8.0",
21
+ "@seek/logger": "^6.0.0",
22
+ "datadog-lambda-js": "^7.0.0",
23
+ "dd-trace": "^4.0.0",
24
24
  "skuba-dive": "^2.0.0",
25
25
  "zod": "^3.19.1"
26
26
  },
@@ -28,8 +28,8 @@
28
28
  "@types/aws-lambda": "^8.10.84",
29
29
  "@types/chance": "^1.1.3",
30
30
  "@types/node": "^18.11.9",
31
- "aws-sdk-client-mock": "^2.0.1",
32
- "aws-sdk-client-mock-jest": "^2.0.1",
31
+ "aws-sdk-client-mock": "^3.0.0",
32
+ "aws-sdk-client-mock-jest": "^3.0.0",
33
33
  "chance": "^1.1.8",
34
34
  "pino-pretty": "^10.0.0",
35
35
  "serverless": "^3.25.0",
@@ -39,6 +39,6 @@
39
39
  "skuba": "*"
40
40
  },
41
41
  "engines": {
42
- "node": ">=18"
42
+ "node": ">=18.12"
43
43
  }
44
44
  }
@@ -47,7 +47,7 @@ describe('handler', () => {
47
47
 
48
48
  expect(logger.error).not.toHaveBeenCalled();
49
49
 
50
- expect(logger.info.mock.calls).toEqual([
50
+ expect(logger.debug.mock.calls).toEqual([
51
51
  [{ count: 1 }, 'Received jobs'],
52
52
  [{ snsMessageId: expect.any(String) }, 'Scored job'],
53
53
  ['Function succeeded'],
@@ -1,6 +1,6 @@
1
1
  import 'skuba-dive/register';
2
2
 
3
- import { SQSEvent } from 'aws-lambda';
3
+ import type { SQSEvent } from 'aws-lambda';
4
4
 
5
5
  import { createHandler } from 'src/framework/handler';
6
6
  import { logger } from 'src/framework/logging';
@@ -20,7 +20,7 @@ const smokeTest = async () => {
20
20
  export const handler = createHandler<SQSEvent>(async (event) => {
21
21
  // Treat an empty object as our smoke test event.
22
22
  if (!Object.keys(event).length) {
23
- logger.info('Received smoke test request');
23
+ logger.debug('Received smoke test request');
24
24
  return smokeTest();
25
25
  }
26
26
 
@@ -30,23 +30,28 @@ export const handler = createHandler<SQSEvent>(async (event) => {
30
30
  throw Error(`Received ${count} records`);
31
31
  }
32
32
 
33
- logger.info({ count }, 'Received jobs');
33
+ logger.debug({ count }, 'Received jobs');
34
34
 
35
35
  metricsClient.distribution('job.received', event.Records.length);
36
36
 
37
37
  const record = event.Records[0];
38
+ if (!record) {
39
+ throw new Error('Malformed SQS event with no records');
40
+ }
41
+
42
+ const { body } = record;
38
43
 
39
44
  // TODO: this throws an error, which will cause the Lambda function to retry
40
45
  // the event and eventually send it to your dead-letter queue. If you don't
41
46
  // trust your source to provide consistently well-formed input, consider
42
47
  // catching and handling this error in code.
43
- const publishedJob = validateJson(record.body, JobPublishedEventSchema);
48
+ const publishedJob = validateJson(body, JobPublishedEventSchema);
44
49
 
45
50
  const scoredJob = await scoreJobPublishedEvent(publishedJob);
46
51
 
47
52
  const snsMessageId = await sendPipelineEvent(scoredJob);
48
53
 
49
- logger.info({ snsMessageId }, 'Scored job');
54
+ logger.debug({ snsMessageId }, 'Scored job');
50
55
 
51
56
  metricsClient.distribution('job.scored', 1);
52
57
  });
@@ -18,7 +18,7 @@ describe('createHandler', () => {
18
18
  const handler = createHandler((event) => {
19
19
  expect(event).toBe(input);
20
20
 
21
- logger.info('Handler invoked');
21
+ logger.debug('Handler invoked');
22
22
 
23
23
  return Promise.resolve(output);
24
24
  });
@@ -27,7 +27,7 @@ describe('createHandler', () => {
27
27
 
28
28
  expect(logger.error).not.toHaveBeenCalled();
29
29
 
30
- expect(logger.info.mock.calls).toEqual([
30
+ expect(logger.debug.mock.calls).toEqual([
31
31
  ['Handler invoked'],
32
32
  ['Function succeeded'],
33
33
  ]);
@@ -42,7 +42,7 @@ describe('createHandler', () => {
42
42
 
43
43
  expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
44
44
 
45
- expect(logger.info).not.toHaveBeenCalled();
45
+ expect(logger.debug).not.toHaveBeenCalled();
46
46
  });
47
47
 
48
48
  it('handles sync error', async () => {
@@ -56,6 +56,6 @@ describe('createHandler', () => {
56
56
 
57
57
  expect(logger.error).toHaveBeenCalledWith({ err }, 'Function failed');
58
58
 
59
- expect(logger.info).not.toHaveBeenCalled();
59
+ expect(logger.debug).not.toHaveBeenCalled();
60
60
  });
61
61
  });
@@ -31,7 +31,7 @@ export const createHandler = <Event, Output = unknown>(
31
31
  try {
32
32
  const output = await fn(event);
33
33
 
34
- logger.info('Function succeeded');
34
+ logger.debug('Function succeeded');
35
35
 
36
36
  return output;
37
37
  } catch (err) {
@@ -1,4 +1,4 @@
1
- import { z } from 'zod';
1
+ import type { z } from 'zod';
2
2
 
3
3
  export const validateJson = <
4
4
  Output,
@@ -1,5 +1,8 @@
1
- import { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
2
- import { JobPublishedEvent, JobScoredEvent } from 'src/types/pipelineEvents';
1
+ import type { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
2
+ import type {
3
+ JobPublishedEvent,
4
+ JobScoredEvent,
5
+ } from 'src/types/pipelineEvents';
3
6
 
4
7
  export const jobPublishedEventToScorerInput = (
5
8
  record: JobPublishedEvent,
@@ -2,12 +2,12 @@ import {
2
2
  jobPublishedEventToScorerInput,
3
3
  jobScorerOutputToScoredEvent,
4
4
  } from 'src/mapping/jobScorer';
5
- import {
6
- JobScorerInput,
7
- JobScorerOutput,
8
- JobScorerOutputSchema,
9
- } from 'src/types/jobScorer';
10
- import { JobPublishedEvent, JobScoredEvent } from 'src/types/pipelineEvents';
5
+ import type { JobScorerInput, JobScorerOutput } from 'src/types/jobScorer';
6
+ import { JobScorerOutputSchema } from 'src/types/jobScorer';
7
+ import type {
8
+ JobPublishedEvent,
9
+ JobScoredEvent,
10
+ } from 'src/types/pipelineEvents';
11
11
 
12
12
  /* istanbul ignore next: simulation of an external service */
13
13
  export const scoringService = {
@@ -1,13 +1,13 @@
1
- import { Context, SQSEvent } from 'aws-lambda';
1
+ import type { Context, SQSEvent } from 'aws-lambda';
2
2
 
3
3
  import { chance } from './types';
4
4
 
5
5
  export const createCtx = () =>
6
6
  ({
7
7
  awsRequestId: chance.guid({ version: 4 }),
8
- } as Context);
8
+ }) as Context;
9
9
 
10
10
  export const createSqsEvent = (bodies: string[]) =>
11
11
  ({
12
12
  Records: bodies.map((body) => ({ body })),
13
- } as SQSEvent);
13
+ }) as SQSEvent;
@@ -3,14 +3,17 @@ import * as logging from 'src/framework/logging';
3
3
  export const logger = {
4
4
  error: jest.fn(),
5
5
  info: jest.fn(),
6
+ debug: jest.fn(),
6
7
 
7
8
  clear: () => {
8
9
  logger.error.mockClear();
9
10
  logger.info.mockClear();
11
+ logger.debug.mockClear();
10
12
  },
11
13
 
12
14
  spy: () => {
13
15
  jest.spyOn(logging.logger, 'error').mockImplementation(logger.error);
14
16
  jest.spyOn(logging.logger, 'info').mockImplementation(logger.info);
17
+ jest.spyOn(logging.logger, 'debug').mockImplementation(logger.debug);
15
18
  },
16
19
  };
@@ -1,7 +1,7 @@
1
1
  import { Chance } from 'chance';
2
2
  import { z } from 'zod';
3
3
 
4
- import { JobPublishedEvent } from 'src/types/pipelineEvents';
4
+ import type { JobPublishedEvent } from 'src/types/pipelineEvents';
5
5
 
6
6
  export type IdDescription = z.infer<typeof IdDescriptionSchema>;
7
7
 
@@ -32,7 +32,7 @@ configs:
32
32
  - *aws-sm
33
33
  - *private-npm
34
34
  - *docker-ecr-cache
35
- - docker-compose#v4.11.0:
35
+ - docker-compose#v4.14.0:
36
36
  dependencies: false
37
37
  run: app
38
38
  retry:
@@ -57,7 +57,7 @@ steps:
57
57
  - *aws-sm
58
58
  - *private-npm
59
59
  - *docker-ecr-cache
60
- - docker-compose#v4.11.0:
60
+ - docker-compose#v4.14.0:
61
61
  run: app
62
62
  timeout_in_minutes: 10
63
63