@openstax/ts-utils 1.33.1 → 1.34.0
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/.cfnlintrc +2 -0
- package/.github/CODEOWNERS +1 -0
- package/.github/workflows/ci.yml +36 -0
- package/.github/workflows/lint.yml +55 -0
- package/.nvmrc +1 -0
- package/.syncignore +4 -0
- package/.syncpackrc +18 -0
- package/CONTRIBUTING.md +96 -0
- package/LICENSE +661 -0
- package/Procfile +1 -0
- package/README.md +62 -90
- package/app.json +23 -0
- package/cspell.json +32 -0
- package/deploy/constants.env +21 -0
- package/deploy/deploy.bash +157 -0
- package/deploy/deployment-alt-region.cfn.yml +70 -0
- package/deploy/deployment.cfn.yml +650 -0
- package/deploy/destroy-deployment.bash +23 -0
- package/deploy/shared.cfn.yml +94 -0
- package/docs/lambda-build.md +35 -0
- package/package.json +12 -228
- package/packages/frontend/README.md +46 -0
- package/packages/frontend/package.json +101 -0
- package/packages/frontend/public/favicon.ico +0 -0
- package/packages/frontend/public/index.html +107 -0
- package/packages/frontend/public/maintenance.html +59 -0
- package/packages/frontend/public/manifest.json +15 -0
- package/packages/frontend/public/robots.txt +3 -0
- package/packages/frontend/script/make-certificate.bash +49 -0
- package/packages/frontend/script/server/cli.js +11 -0
- package/packages/frontend/script/server/index.js +47 -0
- package/packages/frontend/script/start.bash +22 -0
- package/packages/frontend/script/trust-localhost.bash +7 -0
- package/packages/frontend/src/auth/authProvider.ts +10 -0
- package/packages/frontend/src/auth/useAuth.ts +33 -0
- package/packages/frontend/src/components/Pagination.tsx +26 -0
- package/packages/frontend/src/configProvider/index.ts +53 -0
- package/packages/frontend/src/configProvider/use.ts +41 -0
- package/packages/frontend/src/core/context/services.spec.tsx +39 -0
- package/packages/frontend/src/core/context/services.tsx +16 -0
- package/packages/frontend/src/core/index.spec.ts +7 -0
- package/packages/frontend/src/core/index.ts +20 -0
- package/packages/frontend/src/core/services.tsx +14 -0
- package/packages/frontend/src/core/types.ts +3 -0
- package/packages/frontend/src/example/api.ts +28 -0
- package/packages/frontend/src/example/components/Layout.tsx +23 -0
- package/packages/frontend/src/example/screens/Home.spec.tsx +68 -0
- package/packages/frontend/src/example/screens/Home.tsx +78 -0
- package/packages/frontend/src/example/screens/ThingList.spec.tsx +60 -0
- package/packages/frontend/src/example/screens/ThingList.tsx +75 -0
- package/packages/frontend/src/example/screens/ThingView.spec.tsx +71 -0
- package/packages/frontend/src/example/screens/ThingView.tsx +47 -0
- package/packages/frontend/src/example/screens/index.ts +9 -0
- package/packages/frontend/src/index.css +159 -0
- package/packages/frontend/src/index.tsx +67 -0
- package/packages/frontend/src/react-app-env.d.ts +1 -0
- package/packages/frontend/src/routing/components/RouteLink.spec.tsx +55 -0
- package/packages/frontend/src/routing/components/RouteLink.tsx +35 -0
- package/packages/frontend/src/routing/middleware.ts +6 -0
- package/packages/frontend/src/routing/useQuery.ts +14 -0
- package/packages/frontend/src/setupProxy.js +19 -0
- package/packages/frontend/src/setupTests.ts +9 -0
- package/packages/frontend/src/tests/testServices.tsx +23 -0
- package/packages/frontend/tsconfig.json +27 -0
- package/packages/lambda/.eslintrc.js +64 -0
- package/packages/lambda/jest-global-setup.js +3 -0
- package/packages/lambda/jest-setup-after-env.js +1 -0
- package/packages/lambda/jest.config.js +31 -0
- package/packages/lambda/jest.resolver.js +17 -0
- package/packages/lambda/package.json +68 -0
- package/packages/lambda/script/build.bash +19 -0
- package/packages/lambda/script/bundle-functions.bash +10 -0
- package/packages/lambda/script/lambdaLocalProxy.js +16 -0
- package/packages/lambda/script/lambdaLocalProxy.spec.ts +147 -0
- package/packages/lambda/script/utils/getRouteData.ts +7 -0
- package/packages/lambda/script/utils/routeDataLoader.js +8 -0
- package/packages/lambda/script/utils/routeDataLoader.spec.ts +8 -0
- package/packages/lambda/src/functions/serviceApi/core/index.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/core/request.spec.ts +38 -0
- package/packages/lambda/src/functions/serviceApi/core/request.ts +42 -0
- package/packages/lambda/src/functions/serviceApi/core/routes.spec.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/core/routes.ts +10 -0
- package/packages/lambda/src/functions/serviceApi/core/services.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/core/types.ts +13 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/https-xray.ts +4 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/index.spec.ts +48 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/index.ts +58 -0
- package/packages/lambda/src/functions/serviceApi/entry/lambda/services.ts +36 -0
- package/packages/lambda/src/functions/serviceApi/entry/local.ts +71 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.spec.ts +16 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentSearchMiddleware.ts +41 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.spec.ts +78 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/documentStoreMiddleware.ts +70 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.spec.ts +306 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/example/routes.ts +176 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/index.spec.ts +263 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/index.ts +134 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.spec.ts +23 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/authMiddleware.ts +32 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.spec.ts +10 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/configMiddleware.ts +7 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.spec.ts +13 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/frontendFileServerMiddleware.ts +23 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.spec.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/paginationMiddleware.ts +9 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.spec.ts +12 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/searchMiddleware.ts +21 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.spec.ts +21 -0
- package/packages/lambda/src/functions/serviceApi/versions/v0/middleware/userRoleValidatorMiddleware.ts +18 -0
- package/packages/lambda/tsconfig.json +30 -0
- package/packages/lambda/webpack.config.js +97 -0
- package/packages/utils/.eslintrc.js +64 -0
- package/packages/utils/README.md +118 -0
- package/packages/utils/jest-global-setup.js +3 -0
- package/packages/utils/jest.config.js +25 -0
- package/packages/utils/jest.resolver.js +17 -0
- package/packages/utils/package.json +238 -0
- package/packages/utils/src/assertions/index.spec.ts +126 -0
- package/{dist/esm/assertions/index.js → packages/utils/src/assertions/index.ts} +64 -49
- package/packages/utils/src/aws/ssmService.ts +7 -0
- package/packages/utils/src/config/awsParameterConfig.ts +24 -0
- package/packages/utils/src/config/envConfig.ts +58 -0
- package/packages/utils/src/config/index.spec.ts +165 -0
- package/{dist/esm/config/index.d.ts → packages/utils/src/config/index.ts} +29 -13
- package/packages/utils/src/config/lambdaParameterConfig.ts +49 -0
- package/{dist/esm/config/replaceConfig.js → packages/utils/src/config/replaceConfig.ts} +16 -6
- package/packages/utils/src/config/resolveConfigValue.ts +10 -0
- package/packages/utils/src/errors/index.spec.ts +35 -0
- package/{dist/esm/errors/index.js → packages/utils/src/errors/index.ts} +57 -41
- package/packages/utils/src/fetch/fetchStatusRetry.spec.ts +197 -0
- package/packages/utils/src/fetch/fetchStatusRetry.ts +33 -0
- package/packages/utils/src/fetch/index.spec.ts +34 -0
- package/packages/utils/src/fetch/index.ts +87 -0
- package/packages/utils/src/guards/index.spec.ts +58 -0
- package/{dist/esm/guards/index.d.ts → packages/utils/src/guards/index.ts} +10 -7
- package/packages/utils/src/index.spec.ts +471 -0
- package/packages/utils/src/middleware/apiErrorHandler.spec.ts +65 -0
- package/packages/utils/src/middleware/apiErrorHandler.ts +67 -0
- package/packages/utils/src/middleware/apiSlowResponseMiddleware.spec.ts +184 -0
- package/packages/utils/src/middleware/apiSlowResponseMiddleware.ts +71 -0
- package/packages/utils/src/middleware/index.spec.ts +99 -0
- package/{dist/cjs/middleware/index.d.ts → packages/utils/src/middleware/index.ts} +53 -5
- package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.spec.ts +103 -0
- package/packages/utils/src/middleware/lambdaCorsResponseMiddleware.ts +52 -0
- package/packages/utils/src/middleware/throwNotFoundMiddleware.spec.ts +20 -0
- package/packages/utils/src/middleware/throwNotFoundMiddleware.ts +11 -0
- package/packages/utils/src/misc/hashValue.ts +18 -0
- package/packages/utils/src/misc/helpers.ts +259 -0
- package/packages/utils/src/misc/merge.ts +48 -0
- package/{dist/esm/misc/partitionSequence.js → packages/utils/src/misc/partitionSequence.ts} +23 -15
- package/packages/utils/src/pagination/index.spec.ts +150 -0
- package/packages/utils/src/pagination/index.ts +117 -0
- package/{dist/esm/routing/helpers.js → packages/utils/src/routing/helpers.ts} +42 -30
- package/packages/utils/src/routing/index.spec.ts +553 -0
- package/packages/utils/src/routing/index.ts +424 -0
- package/packages/utils/src/routing/validators/zod.spec.ts +16 -0
- package/packages/utils/src/routing/validators/zod.ts +14 -0
- package/packages/utils/src/services/accountsGateway/README.md +3 -0
- package/packages/utils/src/services/accountsGateway/index.spec.ts +518 -0
- package/packages/utils/src/services/accountsGateway/index.ts +251 -0
- package/packages/utils/src/services/apiGateway/README.md +93 -0
- package/packages/utils/src/services/apiGateway/index.spec.ts +254 -0
- package/packages/utils/src/services/apiGateway/index.ts +189 -0
- package/packages/utils/src/services/authProvider/README.md +21 -0
- package/packages/utils/src/services/authProvider/browser.spec.ts +391 -0
- package/packages/utils/src/services/authProvider/browser.ts +209 -0
- package/packages/utils/src/services/authProvider/decryption.spec.ts +337 -0
- package/packages/utils/src/services/authProvider/decryption.ts +98 -0
- package/packages/utils/src/services/authProvider/index.ts +93 -0
- package/packages/utils/src/services/authProvider/stub.spec.ts +29 -0
- package/packages/utils/src/services/authProvider/subrequest.spec.ts +105 -0
- package/packages/utils/src/services/authProvider/subrequest.ts +68 -0
- package/packages/utils/src/services/authProvider/utils/decryptAndVerify.spec.ts +128 -0
- package/packages/utils/src/services/authProvider/utils/decryptAndVerify.ts +106 -0
- package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.spec.ts +26 -0
- package/packages/utils/src/services/authProvider/utils/embeddedAuthProvider.ts +57 -0
- package/packages/utils/src/services/authProvider/utils/userRoleValidator.spec.ts +135 -0
- package/packages/utils/src/services/authProvider/utils/userRoleValidator.ts +49 -0
- package/packages/utils/src/services/authProvider/utils/userSubrequest.spec.ts +26 -0
- package/packages/utils/src/services/authProvider/utils/userSubrequest.ts +10 -0
- package/packages/utils/src/services/documentStore/dynamoEncoding.ts +57 -0
- package/packages/utils/src/services/documentStore/fileSystemAssert.spec.ts +43 -0
- package/packages/utils/src/services/documentStore/fileSystemAssert.ts +10 -0
- package/{dist/cjs/services/documentStore/index.d.ts → packages/utils/src/services/documentStore/index.ts} +8 -8
- package/packages/utils/src/services/documentStore/unversioned/README.md +13 -0
- package/packages/utils/src/services/documentStore/unversioned/dynamodb.spec.ts +859 -0
- package/packages/utils/src/services/documentStore/unversioned/dynamodb.ts +243 -0
- package/packages/utils/src/services/documentStore/unversioned/file-system.spec.ts +629 -0
- package/packages/utils/src/services/documentStore/unversioned/file-system.ts +194 -0
- package/{dist/cjs/services/documentStore/unversioned/index.d.ts → packages/utils/src/services/documentStore/unversioned/index.ts} +2 -0
- package/packages/utils/src/services/documentStore/versioned/README.md +13 -0
- package/packages/utils/src/services/documentStore/versioned/dynamodb.spec.ts +376 -0
- package/packages/utils/src/services/documentStore/versioned/dynamodb.ts +167 -0
- package/packages/utils/src/services/documentStore/versioned/file-system.spec.ts +262 -0
- package/packages/utils/src/services/documentStore/versioned/file-system.ts +90 -0
- package/packages/utils/src/services/documentStore/versioned/index.ts +25 -0
- package/packages/utils/src/services/exercisesGateway/README.md +5 -0
- package/packages/utils/src/services/exercisesGateway/index.spec.ts +326 -0
- package/packages/utils/src/services/exercisesGateway/index.ts +163 -0
- package/packages/utils/src/services/fileServer/index.spec.ts +88 -0
- package/packages/utils/src/services/fileServer/index.ts +43 -0
- package/packages/utils/src/services/fileServer/localFileServer.spec.ts +182 -0
- package/packages/utils/src/services/fileServer/localFileServer.ts +159 -0
- package/packages/utils/src/services/fileServer/s3FileServer.spec.ts +266 -0
- package/packages/utils/src/services/fileServer/s3FileServer.ts +155 -0
- package/packages/utils/src/services/launchParams/index.spec.ts +366 -0
- package/packages/utils/src/services/launchParams/signer.ts +73 -0
- package/packages/utils/src/services/launchParams/verifier.ts +120 -0
- package/packages/utils/src/services/logger/console.spec.ts +29 -0
- package/{dist/esm/services/logger/console.js → packages/utils/src/services/logger/console.ts} +5 -2
- package/packages/utils/src/services/logger/index.spec.ts +65 -0
- package/{dist/esm/services/logger/index.d.ts → packages/utils/src/services/logger/index.ts} +23 -9
- package/packages/utils/src/services/lrsGateway/README.md +5 -0
- package/packages/utils/src/services/lrsGateway/addStatementDefaultFields.ts +22 -0
- package/packages/utils/src/services/lrsGateway/attempt-utils.spec.ts +847 -0
- package/packages/utils/src/services/lrsGateway/attempt-utils.ts +358 -0
- package/packages/utils/src/services/lrsGateway/file-system.spec.ts +363 -0
- package/packages/utils/src/services/lrsGateway/file-system.ts +165 -0
- package/packages/utils/src/services/lrsGateway/index.spec.ts +194 -0
- package/packages/utils/src/services/lrsGateway/index.ts +257 -0
- package/packages/utils/src/services/lrsGateway/xapiUtils.spec.ts +887 -0
- package/packages/utils/src/services/lrsGateway/xapiUtils.ts +262 -0
- package/packages/utils/src/services/postgresConnection/index.spec.ts +170 -0
- package/packages/utils/src/services/postgresConnection/index.ts +84 -0
- package/packages/utils/src/services/searchProvider/README.md +3 -0
- package/packages/utils/src/services/searchProvider/index.ts +59 -0
- package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.spec.ts +526 -0
- package/packages/utils/src/services/searchProvider/memorySearchTheBadWay.ts +223 -0
- package/packages/utils/src/services/searchProvider/openSearch.spec.ts +926 -0
- package/packages/utils/src/services/searchProvider/openSearch.ts +195 -0
- package/{dist/esm/types.d.ts → packages/utils/src/types.ts} +34 -6
- package/packages/utils/tsconfig.json +31 -0
- package/packages/utils/tsconfig.without-specs.cjs.json +7 -0
- package/packages/utils/tsconfig.without-specs.esm.json +7 -0
- package/packages/utils/tsconfig.without-specs.json +6 -0
- package/scripts/build.bash +24 -0
- package/scripts/ci.bash +10 -0
- package/scripts/start.bash +29 -0
- package/dist/cjs/assertions/index.d.ts +0 -89
- package/dist/cjs/assertions/index.js +0 -157
- package/dist/cjs/aws/ssmService.d.ts +0 -5
- package/dist/cjs/aws/ssmService.js +0 -9
- package/dist/cjs/config/awsParameterConfig.d.ts +0 -10
- package/dist/cjs/config/awsParameterConfig.js +0 -26
- package/dist/cjs/config/envConfig.d.ts +0 -24
- package/dist/cjs/config/envConfig.js +0 -57
- package/dist/cjs/config/index.d.ts +0 -48
- package/dist/cjs/config/index.js +0 -35
- package/dist/cjs/config/lambdaParameterConfig.d.ts +0 -12
- package/dist/cjs/config/lambdaParameterConfig.js +0 -45
- package/dist/cjs/config/replaceConfig.d.ts +0 -14
- package/dist/cjs/config/replaceConfig.js +0 -22
- package/dist/cjs/config/resolveConfigValue.d.ts +0 -5
- package/dist/cjs/config/resolveConfigValue.js +0 -12
- package/dist/cjs/errors/index.d.ts +0 -88
- package/dist/cjs/errors/index.js +0 -123
- package/dist/cjs/fetch/fetchStatusRetry.d.ts +0 -8
- package/dist/cjs/fetch/fetchStatusRetry.js +0 -27
- package/dist/cjs/fetch/index.d.ts +0 -64
- package/dist/cjs/fetch/index.js +0 -55
- package/dist/cjs/guards/index.d.ts +0 -38
- package/dist/cjs/guards/index.js +0 -44
- package/dist/cjs/index.js +0 -20
- package/dist/cjs/middleware/apiErrorHandler.d.ts +0 -24
- package/dist/cjs/middleware/apiErrorHandler.js +0 -42
- package/dist/cjs/middleware/apiSlowResponseMiddleware.d.ts +0 -23
- package/dist/cjs/middleware/apiSlowResponseMiddleware.js +0 -54
- package/dist/cjs/middleware/index.js +0 -48
- package/dist/cjs/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
- package/dist/cjs/middleware/lambdaCorsResponseMiddleware.js +0 -44
- package/dist/cjs/middleware/throwNotFoundMiddleware.d.ts +0 -4
- package/dist/cjs/middleware/throwNotFoundMiddleware.js +0 -14
- package/dist/cjs/misc/hashValue.d.ts +0 -10
- package/dist/cjs/misc/hashValue.js +0 -17
- package/dist/cjs/misc/helpers.d.ts +0 -124
- package/dist/cjs/misc/helpers.js +0 -214
- package/dist/cjs/misc/merge.d.ts +0 -21
- package/dist/cjs/misc/merge.js +0 -45
- package/dist/cjs/misc/partitionSequence.d.ts +0 -35
- package/dist/cjs/misc/partitionSequence.js +0 -55
- package/dist/cjs/pagination/index.d.ts +0 -91
- package/dist/cjs/pagination/index.js +0 -83
- package/dist/cjs/routing/helpers.d.ts +0 -57
- package/dist/cjs/routing/helpers.js +0 -90
- package/dist/cjs/routing/index.d.ts +0 -290
- package/dist/cjs/routing/index.js +0 -295
- package/dist/cjs/routing/validators/zod.d.ts +0 -4
- package/dist/cjs/routing/validators/zod.js +0 -14
- package/dist/cjs/services/accountsGateway/index.d.ts +0 -92
- package/dist/cjs/services/accountsGateway/index.js +0 -138
- package/dist/cjs/services/apiGateway/index.d.ts +0 -68
- package/dist/cjs/services/apiGateway/index.js +0 -118
- package/dist/cjs/services/authProvider/browser.d.ts +0 -40
- package/dist/cjs/services/authProvider/browser.js +0 -155
- package/dist/cjs/services/authProvider/decryption.d.ts +0 -19
- package/dist/cjs/services/authProvider/decryption.js +0 -73
- package/dist/cjs/services/authProvider/index.d.ts +0 -63
- package/dist/cjs/services/authProvider/index.js +0 -34
- package/dist/cjs/services/authProvider/subrequest.d.ts +0 -13
- package/dist/cjs/services/authProvider/subrequest.js +0 -49
- package/dist/cjs/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
- package/dist/cjs/services/authProvider/utils/decryptAndVerify.js +0 -91
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
- package/dist/cjs/services/authProvider/utils/embeddedAuthProvider.js +0 -47
- package/dist/cjs/services/authProvider/utils/userRoleValidator.d.ts +0 -13
- package/dist/cjs/services/authProvider/utils/userRoleValidator.js +0 -37
- package/dist/cjs/services/authProvider/utils/userSubrequest.d.ts +0 -3
- package/dist/cjs/services/authProvider/utils/userSubrequest.js +0 -13
- package/dist/cjs/services/documentStore/dynamoEncoding.d.ts +0 -10
- package/dist/cjs/services/documentStore/dynamoEncoding.js +0 -52
- package/dist/cjs/services/documentStore/fileSystemAssert.d.ts +0 -1
- package/dist/cjs/services/documentStore/fileSystemAssert.js +0 -14
- package/dist/cjs/services/documentStore/index.js +0 -2
- package/dist/cjs/services/documentStore/unversioned/dynamodb.d.ts +0 -31
- package/dist/cjs/services/documentStore/unversioned/dynamodb.js +0 -233
- package/dist/cjs/services/documentStore/unversioned/file-system.d.ts +0 -32
- package/dist/cjs/services/documentStore/unversioned/file-system.js +0 -214
- package/dist/cjs/services/documentStore/unversioned/index.js +0 -2
- package/dist/cjs/services/documentStore/versioned/dynamodb.d.ts +0 -25
- package/dist/cjs/services/documentStore/versioned/dynamodb.js +0 -143
- package/dist/cjs/services/documentStore/versioned/file-system.d.ts +0 -25
- package/dist/cjs/services/documentStore/versioned/file-system.js +0 -73
- package/dist/cjs/services/documentStore/versioned/index.d.ts +0 -17
- package/dist/cjs/services/documentStore/versioned/index.js +0 -2
- package/dist/cjs/services/exercisesGateway/index.d.ts +0 -67
- package/dist/cjs/services/exercisesGateway/index.js +0 -107
- package/dist/cjs/services/fileServer/index.d.ts +0 -30
- package/dist/cjs/services/fileServer/index.js +0 -19
- package/dist/cjs/services/fileServer/localFileServer.d.ts +0 -13
- package/dist/cjs/services/fileServer/localFileServer.js +0 -132
- package/dist/cjs/services/fileServer/s3FileServer.d.ts +0 -14
- package/dist/cjs/services/fileServer/s3FileServer.js +0 -132
- package/dist/cjs/services/launchParams/index.js +0 -7
- package/dist/cjs/services/launchParams/signer.d.ts +0 -23
- package/dist/cjs/services/launchParams/signer.js +0 -58
- package/dist/cjs/services/launchParams/verifier.d.ts +0 -21
- package/dist/cjs/services/launchParams/verifier.js +0 -129
- package/dist/cjs/services/logger/console.d.ts +0 -4
- package/dist/cjs/services/logger/console.js +0 -12
- package/dist/cjs/services/logger/index.d.ts +0 -39
- package/dist/cjs/services/logger/index.js +0 -31
- package/dist/cjs/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
- package/dist/cjs/services/lrsGateway/addStatementDefaultFields.js +0 -21
- package/dist/cjs/services/lrsGateway/attempt-utils.d.ts +0 -70
- package/dist/cjs/services/lrsGateway/attempt-utils.js +0 -258
- package/dist/cjs/services/lrsGateway/file-system.d.ts +0 -15
- package/dist/cjs/services/lrsGateway/file-system.js +0 -150
- package/dist/cjs/services/lrsGateway/index.d.ts +0 -122
- package/dist/cjs/services/lrsGateway/index.js +0 -148
- package/dist/cjs/services/lrsGateway/xapiUtils.d.ts +0 -68
- package/dist/cjs/services/lrsGateway/xapiUtils.js +0 -109
- package/dist/cjs/services/postgresConnection/index.d.ts +0 -28
- package/dist/cjs/services/postgresConnection/index.js +0 -65
- package/dist/cjs/services/searchProvider/index.d.ts +0 -67
- package/dist/cjs/services/searchProvider/index.js +0 -2
- package/dist/cjs/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
- package/dist/cjs/services/searchProvider/memorySearchTheBadWay.js +0 -191
- package/dist/cjs/services/searchProvider/openSearch.d.ts +0 -28
- package/dist/cjs/services/searchProvider/openSearch.js +0 -154
- package/dist/cjs/tsconfig.without-specs.cjs.tsbuildinfo +0 -1
- package/dist/cjs/types.d.ts +0 -31
- package/dist/cjs/types.js +0 -2
- package/dist/esm/assertions/index.d.ts +0 -89
- package/dist/esm/aws/ssmService.d.ts +0 -5
- package/dist/esm/aws/ssmService.js +0 -6
- package/dist/esm/config/awsParameterConfig.d.ts +0 -10
- package/dist/esm/config/awsParameterConfig.js +0 -22
- package/dist/esm/config/envConfig.d.ts +0 -24
- package/dist/esm/config/envConfig.js +0 -53
- package/dist/esm/config/index.js +0 -17
- package/dist/esm/config/lambdaParameterConfig.d.ts +0 -12
- package/dist/esm/config/lambdaParameterConfig.js +0 -38
- package/dist/esm/config/replaceConfig.d.ts +0 -14
- package/dist/esm/config/resolveConfigValue.d.ts +0 -5
- package/dist/esm/config/resolveConfigValue.js +0 -8
- package/dist/esm/errors/index.d.ts +0 -88
- package/dist/esm/fetch/fetchStatusRetry.d.ts +0 -8
- package/dist/esm/fetch/fetchStatusRetry.js +0 -23
- package/dist/esm/fetch/index.d.ts +0 -64
- package/dist/esm/fetch/index.js +0 -46
- package/dist/esm/guards/index.js +0 -36
- package/dist/esm/index.d.ts +0 -4
- package/dist/esm/index.js +0 -4
- package/dist/esm/middleware/apiErrorHandler.d.ts +0 -24
- package/dist/esm/middleware/apiErrorHandler.js +0 -38
- package/dist/esm/middleware/apiSlowResponseMiddleware.d.ts +0 -23
- package/dist/esm/middleware/apiSlowResponseMiddleware.js +0 -50
- package/dist/esm/middleware/index.d.ts +0 -47
- package/dist/esm/middleware/index.js +0 -44
- package/dist/esm/middleware/lambdaCorsResponseMiddleware.d.ts +0 -20
- package/dist/esm/middleware/lambdaCorsResponseMiddleware.js +0 -40
- package/dist/esm/middleware/throwNotFoundMiddleware.d.ts +0 -4
- package/dist/esm/middleware/throwNotFoundMiddleware.js +0 -10
- package/dist/esm/misc/hashValue.d.ts +0 -10
- package/dist/esm/misc/hashValue.js +0 -13
- package/dist/esm/misc/helpers.d.ts +0 -124
- package/dist/esm/misc/helpers.js +0 -199
- package/dist/esm/misc/merge.d.ts +0 -21
- package/dist/esm/misc/merge.js +0 -40
- package/dist/esm/misc/partitionSequence.d.ts +0 -35
- package/dist/esm/pagination/index.d.ts +0 -91
- package/dist/esm/pagination/index.js +0 -77
- package/dist/esm/routing/helpers.d.ts +0 -57
- package/dist/esm/routing/index.d.ts +0 -290
- package/dist/esm/routing/index.js +0 -246
- package/dist/esm/routing/validators/zod.d.ts +0 -4
- package/dist/esm/routing/validators/zod.js +0 -10
- package/dist/esm/services/accountsGateway/index.d.ts +0 -92
- package/dist/esm/services/accountsGateway/index.js +0 -131
- package/dist/esm/services/apiGateway/index.d.ts +0 -68
- package/dist/esm/services/apiGateway/index.js +0 -77
- package/dist/esm/services/authProvider/browser.d.ts +0 -40
- package/dist/esm/services/authProvider/browser.js +0 -151
- package/dist/esm/services/authProvider/decryption.d.ts +0 -19
- package/dist/esm/services/authProvider/decryption.js +0 -69
- package/dist/esm/services/authProvider/index.d.ts +0 -63
- package/dist/esm/services/authProvider/index.js +0 -26
- package/dist/esm/services/authProvider/subrequest.d.ts +0 -13
- package/dist/esm/services/authProvider/subrequest.js +0 -45
- package/dist/esm/services/authProvider/utils/decryptAndVerify.d.ts +0 -28
- package/dist/esm/services/authProvider/utils/decryptAndVerify.js +0 -85
- package/dist/esm/services/authProvider/utils/embeddedAuthProvider.d.ts +0 -26
- package/dist/esm/services/authProvider/utils/embeddedAuthProvider.js +0 -40
- package/dist/esm/services/authProvider/utils/userRoleValidator.d.ts +0 -13
- package/dist/esm/services/authProvider/utils/userRoleValidator.js +0 -33
- package/dist/esm/services/authProvider/utils/userSubrequest.d.ts +0 -3
- package/dist/esm/services/authProvider/utils/userSubrequest.js +0 -6
- package/dist/esm/services/documentStore/dynamoEncoding.d.ts +0 -10
- package/dist/esm/services/documentStore/dynamoEncoding.js +0 -45
- package/dist/esm/services/documentStore/fileSystemAssert.d.ts +0 -1
- package/dist/esm/services/documentStore/fileSystemAssert.js +0 -10
- package/dist/esm/services/documentStore/index.d.ts +0 -14
- package/dist/esm/services/documentStore/index.js +0 -1
- package/dist/esm/services/documentStore/unversioned/dynamodb.d.ts +0 -31
- package/dist/esm/services/documentStore/unversioned/dynamodb.js +0 -226
- package/dist/esm/services/documentStore/unversioned/file-system.d.ts +0 -32
- package/dist/esm/services/documentStore/unversioned/file-system.js +0 -174
- package/dist/esm/services/documentStore/unversioned/index.d.ts +0 -2
- package/dist/esm/services/documentStore/unversioned/index.js +0 -1
- package/dist/esm/services/documentStore/versioned/dynamodb.d.ts +0 -25
- package/dist/esm/services/documentStore/versioned/dynamodb.js +0 -139
- package/dist/esm/services/documentStore/versioned/file-system.d.ts +0 -25
- package/dist/esm/services/documentStore/versioned/file-system.js +0 -69
- package/dist/esm/services/documentStore/versioned/index.d.ts +0 -17
- package/dist/esm/services/documentStore/versioned/index.js +0 -1
- package/dist/esm/services/exercisesGateway/index.d.ts +0 -67
- package/dist/esm/services/exercisesGateway/index.js +0 -70
- package/dist/esm/services/fileServer/index.d.ts +0 -30
- package/dist/esm/services/fileServer/index.js +0 -13
- package/dist/esm/services/fileServer/localFileServer.d.ts +0 -13
- package/dist/esm/services/fileServer/localFileServer.js +0 -125
- package/dist/esm/services/fileServer/s3FileServer.d.ts +0 -14
- package/dist/esm/services/fileServer/s3FileServer.js +0 -125
- package/dist/esm/services/launchParams/index.d.ts +0 -2
- package/dist/esm/services/launchParams/index.js +0 -2
- package/dist/esm/services/launchParams/signer.d.ts +0 -23
- package/dist/esm/services/launchParams/signer.js +0 -51
- package/dist/esm/services/launchParams/verifier.d.ts +0 -21
- package/dist/esm/services/launchParams/verifier.js +0 -92
- package/dist/esm/services/logger/console.d.ts +0 -4
- package/dist/esm/services/logger/index.js +0 -27
- package/dist/esm/services/lrsGateway/addStatementDefaultFields.d.ts +0 -5
- package/dist/esm/services/lrsGateway/addStatementDefaultFields.js +0 -14
- package/dist/esm/services/lrsGateway/attempt-utils.d.ts +0 -70
- package/dist/esm/services/lrsGateway/attempt-utils.js +0 -236
- package/dist/esm/services/lrsGateway/file-system.d.ts +0 -15
- package/dist/esm/services/lrsGateway/file-system.js +0 -110
- package/dist/esm/services/lrsGateway/index.d.ts +0 -122
- package/dist/esm/services/lrsGateway/index.js +0 -111
- package/dist/esm/services/lrsGateway/xapiUtils.d.ts +0 -68
- package/dist/esm/services/lrsGateway/xapiUtils.js +0 -99
- package/dist/esm/services/postgresConnection/index.d.ts +0 -28
- package/dist/esm/services/postgresConnection/index.js +0 -58
- package/dist/esm/services/searchProvider/index.d.ts +0 -67
- package/dist/esm/services/searchProvider/index.js +0 -1
- package/dist/esm/services/searchProvider/memorySearchTheBadWay.d.ts +0 -20
- package/dist/esm/services/searchProvider/memorySearchTheBadWay.js +0 -187
- package/dist/esm/services/searchProvider/openSearch.d.ts +0 -28
- package/dist/esm/services/searchProvider/openSearch.js +0 -150
- package/dist/esm/tsconfig.without-specs.esm.tsbuildinfo +0 -1
- package/dist/esm/types.js +0 -1
- package/script/bin/.init-params-script.bash.swp +0 -0
- /package/{script → packages/utils/script}/bin/copy-from-template.bash +0 -0
- /package/{script → packages/utils/script}/bin/delete-stack.bash +0 -0
- /package/{script → packages/utils/script}/bin/deploy.bash +0 -0
- /package/{script → packages/utils/script}/bin/destroy-deployment.bash +0 -0
- /package/{script → packages/utils/script}/bin/empty-bucket.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-arg.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-deployed-environments.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-env-param.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-kwarg.bash +0 -0
- /package/{script → packages/utils/script}/bin/get-stack-param.bash +0 -0
- /package/{script → packages/utils/script}/bin/has-flag.bash +0 -0
- /package/{script → packages/utils/script}/bin/init-constants-script.bash +0 -0
- /package/{script → packages/utils/script}/bin/init-params-script.bash +0 -0
- /package/{script → packages/utils/script}/bin/stack-exists.bash +0 -0
- /package/{script → packages/utils/script}/bin/update-utils.bash +0 -0
- /package/{script → packages/utils/script}/bin/upload-pager-duty-endpoints.bash +0 -0
- /package/{script → packages/utils/script}/bin/upload-params.bash +0 -0
- /package/{script → packages/utils/script}/bin/which.bash +0 -0
- /package/{script → packages/utils/script}/bin-entry.bash +0 -0
- /package/{script → packages/utils/script}/build.bash +0 -0
- /package/{dist/cjs/index.d.ts → packages/utils/src/index.ts} +0 -0
- /package/{dist/cjs/services/launchParams/index.d.ts → packages/utils/src/services/launchParams/index.ts} +0 -0
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
import * as fsModule from 'fs';
|
|
2
|
+
import path from 'path';
|
|
3
|
+
import { Config, TDocument } from '..';
|
|
4
|
+
import { HashValue, hashValue } from '../../..';
|
|
5
|
+
import { ConfigProviderForConfig, resolveConfigValue } from '../../../config';
|
|
6
|
+
import { ConflictError, NotFoundError } from '../../../errors';
|
|
7
|
+
import { ifDefined, isDefined } from '../../../guards';
|
|
8
|
+
import { assertNoUndefined } from '../fileSystemAssert';
|
|
9
|
+
|
|
10
|
+
interface Initializer<C> {
|
|
11
|
+
dataDir: string;
|
|
12
|
+
fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
|
|
13
|
+
configSpace?: C;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export const fileSystemUnversionedDocumentStore = <C extends string = 'fileSystem'>(initializer: Initializer<C>) => <T extends TDocument<T>>() => (configProvider: {[_key in C]: ConfigProviderForConfig<Config>}) => <K extends keyof T>(_: {}, hashKey: K, options?: {afterWrite?: (item: T) => void | Promise<void>; batchAfterWrite?: (items: T[]) => void | Promise<void>; skipAssert?: boolean}) => {
|
|
17
|
+
const tableName = resolveConfigValue(configProvider[initializer.configSpace || 'fileSystem' as C].tableName);
|
|
18
|
+
const tablePath = tableName.then((table) => path.join(initializer.dataDir, table));
|
|
19
|
+
const { mkdir, readdir, readFile, writeFile } = ifDefined(initializer.fs, fsModule);
|
|
20
|
+
const skipAssert = options?.skipAssert ?? false;
|
|
21
|
+
|
|
22
|
+
const mkTableDir = new Promise<void>((resolve, reject) => tablePath.then(
|
|
23
|
+
(path) => mkdir(path, { recursive: true }, (err) =>
|
|
24
|
+
err && err.code !== 'EEXIST' ? reject(err) : resolve()
|
|
25
|
+
)
|
|
26
|
+
));
|
|
27
|
+
|
|
28
|
+
const hashFilename = (value: HashValue) => `${hashValue(value)}.json`;
|
|
29
|
+
|
|
30
|
+
const filePath = async(filename: string) => path.join(await tablePath, filename);
|
|
31
|
+
|
|
32
|
+
const load = async(filename: string) => {
|
|
33
|
+
const path = await filePath(filename);
|
|
34
|
+
await mkTableDir;
|
|
35
|
+
|
|
36
|
+
return new Promise<T | undefined>((resolve, reject) => {
|
|
37
|
+
readFile(path, (err, readData) => {
|
|
38
|
+
if (err) {
|
|
39
|
+
err.code === 'ENOENT' ? resolve(undefined) : reject(err);
|
|
40
|
+
} else {
|
|
41
|
+
try {
|
|
42
|
+
const data = JSON.parse(readData.toString());
|
|
43
|
+
typeof data === 'object' ? resolve(data) : reject(new Error('unexpected non-object JSON'));
|
|
44
|
+
} catch (err) {
|
|
45
|
+
reject(err);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
const loadAllDocumentsTheBadWay = async() => {
|
|
53
|
+
const path = await tablePath;
|
|
54
|
+
await mkTableDir;
|
|
55
|
+
|
|
56
|
+
return new Promise<T[]>((resolve, reject) => readdir(path, (err, files) => err ?
|
|
57
|
+
reject(err) :
|
|
58
|
+
Promise.all(files.map((file) => load(file)))
|
|
59
|
+
.then((allData) => resolve(allData.filter(isDefined)), (err) => reject(err))
|
|
60
|
+
));
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
return {
|
|
64
|
+
loadAllDocumentsTheBadWay,
|
|
65
|
+
getItemsByField: async(key: keyof T, value: T[K], pageKey?: string) => {
|
|
66
|
+
if (!skipAssert) assertNoUndefined(value, [key as string]);
|
|
67
|
+
const pageSize = 10;
|
|
68
|
+
const items = await loadAllDocumentsTheBadWay();
|
|
69
|
+
const filteredItems = items.filter((item) => item[key] === value);
|
|
70
|
+
const startIndex = pageKey ? parseInt(pageKey, 10) : 0;
|
|
71
|
+
const paginatedItems = filteredItems.slice(startIndex, startIndex + pageSize);
|
|
72
|
+
const nextPageToken = startIndex + pageSize < filteredItems.length
|
|
73
|
+
? (startIndex + pageSize).toString()
|
|
74
|
+
: undefined;
|
|
75
|
+
return { items: paginatedItems, nextPageToken };
|
|
76
|
+
},
|
|
77
|
+
batchGetItem: async(ids: T[K][]) => {
|
|
78
|
+
const items = await Promise.all(ids.map((id) => {
|
|
79
|
+
if (!skipAssert) assertNoUndefined(id, ['id']);
|
|
80
|
+
return load(hashFilename(id));
|
|
81
|
+
}));
|
|
82
|
+
return items.filter(isDefined);
|
|
83
|
+
},
|
|
84
|
+
getItem: (id: T[K]) => {
|
|
85
|
+
if (!skipAssert) assertNoUndefined(id, ['id']);
|
|
86
|
+
return load(hashFilename(id));
|
|
87
|
+
},
|
|
88
|
+
incrementItemAttribute: async(id: T[K], attribute: keyof T) => {
|
|
89
|
+
if (!skipAssert) assertNoUndefined(id, ['id']);
|
|
90
|
+
const filename = hashFilename(id);
|
|
91
|
+
const path = await filePath(filename);
|
|
92
|
+
await mkTableDir;
|
|
93
|
+
|
|
94
|
+
const data = await load(filename);
|
|
95
|
+
if (!data) { throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`); }
|
|
96
|
+
|
|
97
|
+
const newValue = typeof data[attribute] === 'number' ? data[attribute] as number + 1 : 1;
|
|
98
|
+
const newItem = {...data, [hashKey]: id, [attribute]: newValue};
|
|
99
|
+
|
|
100
|
+
return new Promise<number>((resolve, reject) => {
|
|
101
|
+
writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newValue));
|
|
102
|
+
});
|
|
103
|
+
},
|
|
104
|
+
patchItem: async(item: Partial<T>) => {
|
|
105
|
+
const id = item[hashKey];
|
|
106
|
+
if (!id) { throw new Error(`Key attribute "${hashKey.toString()}" is required for patchItem`); }
|
|
107
|
+
|
|
108
|
+
// This check is just to make this adapter consistent with the dynamo adapter
|
|
109
|
+
if (Object.keys(item).filter((key) => key !== hashKey.toString()).length === 0) {
|
|
110
|
+
throw new Error('No attributes to update');
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
const filename = hashFilename(id);
|
|
114
|
+
const path = await filePath(filename);
|
|
115
|
+
await mkTableDir;
|
|
116
|
+
|
|
117
|
+
const data = await load(filename);
|
|
118
|
+
if (!data) { throw new NotFoundError(`Item with ${hashKey.toString()} "${id}" does not exist`); }
|
|
119
|
+
|
|
120
|
+
const newItem = {...data, ...item};
|
|
121
|
+
if (!skipAssert) assertNoUndefined(newItem);
|
|
122
|
+
|
|
123
|
+
return new Promise<T>((resolve, reject) => {
|
|
124
|
+
writeFile(path, JSON.stringify(newItem, null, 2), (err) => err ? reject(err) : resolve(newItem));
|
|
125
|
+
});
|
|
126
|
+
},
|
|
127
|
+
putItem: async(item: T) => {
|
|
128
|
+
if (!skipAssert) assertNoUndefined(item);
|
|
129
|
+
const path = await filePath(hashFilename(item[hashKey]));
|
|
130
|
+
await mkTableDir;
|
|
131
|
+
|
|
132
|
+
return new Promise<T>((resolve, reject) => {
|
|
133
|
+
writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
|
|
134
|
+
});
|
|
135
|
+
},
|
|
136
|
+
createItem: async(item: T) => {
|
|
137
|
+
if (!skipAssert) assertNoUndefined(item);
|
|
138
|
+
const hashed = hashFilename(item[hashKey]);
|
|
139
|
+
const existingItem = await load(hashed);
|
|
140
|
+
if (existingItem) {
|
|
141
|
+
throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
const path = await filePath(hashed);
|
|
145
|
+
await mkTableDir;
|
|
146
|
+
|
|
147
|
+
return new Promise<T>((resolve, reject) => {
|
|
148
|
+
writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
|
|
149
|
+
});
|
|
150
|
+
},
|
|
151
|
+
batchCreateItem: async(items: T[], _concurrency = 1): Promise<{successful: T[]; failed: Array<{item: T; error: Error}>}> => {
|
|
152
|
+
if (items.length === 0) return { successful: [], failed: [] };
|
|
153
|
+
|
|
154
|
+
const successful: T[] = [];
|
|
155
|
+
const failed: Array<{item: T; error: Error}> = [];
|
|
156
|
+
|
|
157
|
+
// Process items sequentially to ensure consistent conflict detection
|
|
158
|
+
// Note: concurrency parameter is ignored for filesystem to avoid race conditions
|
|
159
|
+
for (const item of items) {
|
|
160
|
+
if (!skipAssert) assertNoUndefined(item);
|
|
161
|
+
try {
|
|
162
|
+
const hashed = hashFilename(item[hashKey]);
|
|
163
|
+
const existingItem = await load(hashed);
|
|
164
|
+
if (existingItem) {
|
|
165
|
+
throw new ConflictError(`Item with ${String(hashKey)} "${item[hashKey]}" already exists`);
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
const path = await filePath(hashed);
|
|
169
|
+
await mkTableDir;
|
|
170
|
+
|
|
171
|
+
const createdItem = await new Promise<T>((resolve, reject) => {
|
|
172
|
+
writeFile(path, JSON.stringify(item, null, 2), (err) => err ? reject(err) : resolve(item));
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
successful.push(createdItem);
|
|
176
|
+
|
|
177
|
+
// Only call individual afterWrite if batchAfterWrite is not defined
|
|
178
|
+
if (!options?.batchAfterWrite) {
|
|
179
|
+
await options?.afterWrite?.(createdItem);
|
|
180
|
+
}
|
|
181
|
+
} catch (error) {
|
|
182
|
+
failed.push({ item, error: error as Error });
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
// Call batchAfterWrite with all successful items if defined
|
|
187
|
+
if (options?.batchAfterWrite && successful.length > 0) {
|
|
188
|
+
await options.batchAfterWrite(successful);
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
return { successful, failed };
|
|
192
|
+
},
|
|
193
|
+
};
|
|
194
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# VersionedDocumentStore
|
|
2
|
+
|
|
3
|
+
a key value document store where all writes are new versions of documents and a version history can be fetched. the interface accepts a `getAuthor` argument at the driver level so you can provide some automatic audit logging for writes, if you don't provide that you have to provide the author information on every call to putItem.
|
|
4
|
+
|
|
5
|
+
## drivers
|
|
6
|
+
|
|
7
|
+
### dynamo
|
|
8
|
+
|
|
9
|
+
production driver, the entity key is the hash key and the version timestamp is the range key, getItem just fetches the last element of the range in one read, while getVersions paginates through the whole range.
|
|
10
|
+
|
|
11
|
+
### fileSystem
|
|
12
|
+
|
|
13
|
+
just matches the interface over dumping everything in a json file on disk
|
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
import * as awsSdk from '@aws-sdk/client-dynamodb';
|
|
2
|
+
import { dynamoVersionedDocumentStore } from './dynamodb';
|
|
3
|
+
import { VersionedDocumentRequiredFields } from '.';
|
|
4
|
+
|
|
5
|
+
jest.mock('@aws-sdk/client-dynamodb', () => {
|
|
6
|
+
const sendSpy = jest.fn(() => Promise.resolve()) as any;
|
|
7
|
+
return {
|
|
8
|
+
...jest.requireActual('@aws-sdk/client-dynamodb'),
|
|
9
|
+
DynamoDB: class {
|
|
10
|
+
static sendSpy = sendSpy;
|
|
11
|
+
send(...a: any[]) { return sendSpy(...a); }
|
|
12
|
+
}
|
|
13
|
+
};
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
type TTestDocument = {
|
|
17
|
+
coolId: string;
|
|
18
|
+
maybe?: null;
|
|
19
|
+
name: string;
|
|
20
|
+
strings?: string[];
|
|
21
|
+
isCool?: boolean;
|
|
22
|
+
} & VersionedDocumentRequiredFields;
|
|
23
|
+
|
|
24
|
+
describe('dynamoVersionedDocumentStore', () => {
|
|
25
|
+
const sendSpy: jest.SpyInstance = (awsSdk.DynamoDB as any).sendSpy;
|
|
26
|
+
const config = {dynamodb: {tableName: 'cool-table-name'}};
|
|
27
|
+
const middleware = {};
|
|
28
|
+
let mockDynamoClient: awsSdk.DynamoDB;
|
|
29
|
+
let mockClientSend: jest.SpyInstance;
|
|
30
|
+
|
|
31
|
+
beforeEach(() => {
|
|
32
|
+
mockClientSend = jest.fn();
|
|
33
|
+
mockDynamoClient = {send: mockClientSend} as unknown as awsSdk.DynamoDB;
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
afterEach(() => {
|
|
37
|
+
jest.clearAllMocks();
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
describe('loadAllDocumentsTheBadWay', () => {
|
|
41
|
+
it('loads pages of documents', async() => {
|
|
42
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
43
|
+
|
|
44
|
+
sendSpy.mockReturnValueOnce(Promise.resolve({
|
|
45
|
+
LastEvaluatedKey: {
|
|
46
|
+
coolId: {S: 'my-document-id'},
|
|
47
|
+
timestamp: {N: '123'},
|
|
48
|
+
},
|
|
49
|
+
Items: [
|
|
50
|
+
{
|
|
51
|
+
coolId: {S: 'my-document-id'},
|
|
52
|
+
timestamp: {N: '123'},
|
|
53
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
54
|
+
name: {S: 'my-doc-old'},
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
coolId: {S: 'my-document-id'},
|
|
58
|
+
timestamp: {N: '124'},
|
|
59
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
60
|
+
name: {S: 'my-doc-new'},
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
coolId: {S: 'my-document-id'},
|
|
64
|
+
timestamp: {N: '122'},
|
|
65
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
66
|
+
name: {S: 'my-doc-old'},
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}));
|
|
70
|
+
sendSpy.mockReturnValueOnce(Promise.resolve({
|
|
71
|
+
Items: [
|
|
72
|
+
{
|
|
73
|
+
coolId: {S: 'my-document-id-two'},
|
|
74
|
+
timestamp: {N: '123'},
|
|
75
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
76
|
+
name: {S: 'my-doc-two'},
|
|
77
|
+
}
|
|
78
|
+
]
|
|
79
|
+
}));
|
|
80
|
+
|
|
81
|
+
expect(await store.loadAllDocumentsTheBadWay()).toEqual([
|
|
82
|
+
{
|
|
83
|
+
coolId: 'my-document-id',
|
|
84
|
+
timestamp: 124,
|
|
85
|
+
author: {type: 'system', reason: 'testing'},
|
|
86
|
+
name: 'my-doc-new',
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
coolId: 'my-document-id-two',
|
|
90
|
+
timestamp: 123,
|
|
91
|
+
author: {type: 'system', reason: 'testing'},
|
|
92
|
+
name: 'my-doc-two',
|
|
93
|
+
}
|
|
94
|
+
]);
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
it('handles null items', async() => {
|
|
98
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
99
|
+
sendSpy.mockReturnValueOnce(Promise.resolve({
|
|
100
|
+
}));
|
|
101
|
+
expect(await store.loadAllDocumentsTheBadWay()).toEqual([
|
|
102
|
+
]);
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
describe('getItem', () => {
|
|
107
|
+
it('gets document', async() => {
|
|
108
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
109
|
+
|
|
110
|
+
sendSpy.mockReturnValue(Promise.resolve({Items: [{
|
|
111
|
+
coolId: {S: 'my-document-id'},
|
|
112
|
+
timestamp: {N: '123'},
|
|
113
|
+
maybe: {NULL: true},
|
|
114
|
+
strings: {L: [{S: 'string1'}, {S: 'string2'}]},
|
|
115
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
116
|
+
name: {S: 'my-doc'},
|
|
117
|
+
isCool: {BOOL: true}
|
|
118
|
+
}]}));
|
|
119
|
+
|
|
120
|
+
expect(await store.getItem('my-document-id')).toEqual({
|
|
121
|
+
coolId: 'my-document-id',
|
|
122
|
+
timestamp: 123,
|
|
123
|
+
maybe: null,
|
|
124
|
+
strings: ['string1', 'string2'],
|
|
125
|
+
author: {type: 'system', reason: 'testing'},
|
|
126
|
+
name: 'my-doc',
|
|
127
|
+
isCool: true
|
|
128
|
+
});
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
it('can get a specific version', async() => {
|
|
132
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
133
|
+
|
|
134
|
+
sendSpy.mockReturnValue(Promise.resolve({Items: [{
|
|
135
|
+
coolId: {S: 'my-document-id'},
|
|
136
|
+
timestamp: {N: '123'},
|
|
137
|
+
maybe: {NULL: true},
|
|
138
|
+
strings: {L: [{S: 'string1'}, {S: 'string2'}]},
|
|
139
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
140
|
+
name: {S: 'my-doc'},
|
|
141
|
+
isCool: {BOOL: true}
|
|
142
|
+
}]}));
|
|
143
|
+
|
|
144
|
+
expect(await store.getItem('my-document-id', 123)).toEqual({
|
|
145
|
+
coolId: 'my-document-id',
|
|
146
|
+
timestamp: 123,
|
|
147
|
+
maybe: null,
|
|
148
|
+
strings: ['string1', 'string2'],
|
|
149
|
+
author: {type: 'system', reason: 'testing'},
|
|
150
|
+
name: 'my-doc',
|
|
151
|
+
isCool: true
|
|
152
|
+
});
|
|
153
|
+
});
|
|
154
|
+
|
|
155
|
+
it('gets undefined for missing document', async() => {
|
|
156
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
157
|
+
sendSpy.mockReturnValue(Promise.resolve({}));
|
|
158
|
+
expect(await store.getItem('my-document-id')).toBeUndefined();
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
it('throws on weirdo data types', async() => {
|
|
162
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
163
|
+
sendSpy.mockReturnValue(Promise.resolve({Items: [{
|
|
164
|
+
isCool: {NOT_A_REAL_TYPE: true}
|
|
165
|
+
}]}));
|
|
166
|
+
|
|
167
|
+
await expect(async() => store.getItem('my-document-id')).rejects.toThrow();
|
|
168
|
+
});
|
|
169
|
+
});
|
|
170
|
+
|
|
171
|
+
describe('putItem', () => {
|
|
172
|
+
beforeAll(() => {
|
|
173
|
+
jest.useFakeTimers();
|
|
174
|
+
jest.setSystemTime(new Date(2020, 6, 28));
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
afterAll(() => {
|
|
178
|
+
jest.useRealTimers();
|
|
179
|
+
});
|
|
180
|
+
|
|
181
|
+
it('saves document', async() => {
|
|
182
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
|
|
183
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
|
|
184
|
+
await store.putItem(testDoc, {type: 'system', reason: 'testing'});
|
|
185
|
+
expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
|
|
186
|
+
input: {
|
|
187
|
+
TableName: 'cool-table-name',
|
|
188
|
+
Item: {
|
|
189
|
+
coolId: {S: 'my-document-id'},
|
|
190
|
+
timestamp: {N: '1595894400000'},
|
|
191
|
+
strings: {L: [{S: 'string1'}, {S: 'string2'}]},
|
|
192
|
+
maybe: {NULL: true},
|
|
193
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
194
|
+
name: {S: 'my-doc'},
|
|
195
|
+
isCool: {BOOL: false}
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
}));
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
it('calls afterWrite', async() => {
|
|
202
|
+
const afterWrite = jest.fn();
|
|
203
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
|
|
204
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {afterWrite});
|
|
205
|
+
await store.putItem(testDoc, {type: 'system', reason: 'testing'});
|
|
206
|
+
expect(afterWrite).toHaveBeenCalledWith(expect.objectContaining({
|
|
207
|
+
...testDoc,
|
|
208
|
+
author: {type: 'system', reason: 'testing'},
|
|
209
|
+
timestamp: 1595894400000,
|
|
210
|
+
}));
|
|
211
|
+
});
|
|
212
|
+
|
|
213
|
+
it('returns new document', async() => {
|
|
214
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
|
|
215
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
|
|
216
|
+
const result = await store.putItem(testDoc, {type: 'system', reason: 'testing'});
|
|
217
|
+
expect(result).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'system', reason: 'testing'}});
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
it('throws on weirdo data types', async() => {
|
|
221
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc', foobar: Buffer.from('asdf')};
|
|
222
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
223
|
+
await expect(async() => store.putItem(testDoc, {type: 'system', reason: 'testing'})).rejects.toThrow();
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
it('uses author provider', async() => {
|
|
227
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
|
|
228
|
+
const getAuthor = (name: string) => Promise.resolve({type: 'user' as const, name, uuid: 'a uuid'});
|
|
229
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {getAuthor});
|
|
230
|
+
const result = await store.putItem(testDoc, 'a name');
|
|
231
|
+
expect(result).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'user', name: 'a name', uuid: 'a uuid'}});
|
|
232
|
+
});
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
describe('prepareItem', () => {
|
|
236
|
+
beforeAll(() => {
|
|
237
|
+
jest.useFakeTimers();
|
|
238
|
+
jest.setSystemTime(new Date(2020, 6, 28));
|
|
239
|
+
});
|
|
240
|
+
|
|
241
|
+
afterAll(() => {
|
|
242
|
+
jest.useRealTimers();
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
it('saves document', async() => {
|
|
246
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
|
|
247
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
248
|
+
const {save} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
|
|
249
|
+
await save();
|
|
250
|
+
expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
|
|
251
|
+
input: {
|
|
252
|
+
TableName: 'cool-table-name',
|
|
253
|
+
Item: {
|
|
254
|
+
coolId: {S: 'my-document-id'},
|
|
255
|
+
timestamp: {N: '1595894400000'},
|
|
256
|
+
strings: {L: [{S: 'string1'}, {S: 'string2'}]},
|
|
257
|
+
maybe: {NULL: true},
|
|
258
|
+
author: {M: {type: {S: 'system'}, reason: {S: 'testing'}}},
|
|
259
|
+
name: {S: 'my-doc'},
|
|
260
|
+
isCool: {BOOL: false}
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
}));
|
|
264
|
+
});
|
|
265
|
+
|
|
266
|
+
it('calls afterWrite', async() => {
|
|
267
|
+
const afterWrite = jest.fn();
|
|
268
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc', isCool: false, maybe: null, strings: ['string1', 'string2']};
|
|
269
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {afterWrite});
|
|
270
|
+
const {save} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
|
|
271
|
+
expect(await save()).toEqual(expect.objectContaining({
|
|
272
|
+
...testDoc,
|
|
273
|
+
author: {type: 'system', reason: 'testing'},
|
|
274
|
+
timestamp: 1595894400000,
|
|
275
|
+
}));
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
it('returns new document', async() => {
|
|
279
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
|
|
280
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId');
|
|
281
|
+
const {document} = await store.prepareItem(testDoc, {type: 'system', reason: 'testing'});
|
|
282
|
+
expect(document).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'system', reason: 'testing'}});
|
|
283
|
+
});
|
|
284
|
+
|
|
285
|
+
it('uses author provider', async() => {
|
|
286
|
+
const testDoc = {coolId: 'my-document-id', name: 'my-doc'};
|
|
287
|
+
const getAuthor = (name: string) => Promise.resolve({type: 'user' as const, name, uuid: 'a uuid'});
|
|
288
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', {getAuthor});
|
|
289
|
+
const {document} = await store.prepareItem(testDoc, 'a name');
|
|
290
|
+
expect(document).toEqual({...testDoc, timestamp: expect.any(Number), author: {type: 'user', name: 'a name', uuid: 'a uuid'}});
|
|
291
|
+
});
|
|
292
|
+
});
|
|
293
|
+
|
|
294
|
+
describe('custom client', () => {
|
|
295
|
+
it('uses provided dynamodb client', async() => {
|
|
296
|
+
const customSendSpy = jest.fn().mockResolvedValue({Items: [{coolId: {S: 'test-id'}}]});
|
|
297
|
+
mockDynamoClient.send = customSendSpy;
|
|
298
|
+
|
|
299
|
+
const store = dynamoVersionedDocumentStore({dynamoClient: mockDynamoClient})<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
300
|
+
await store.getItem('test-id');
|
|
301
|
+
|
|
302
|
+
expect(customSendSpy).toHaveBeenCalled();
|
|
303
|
+
expect(sendSpy).not.toHaveBeenCalled();
|
|
304
|
+
});
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
describe('getVersions', () => {
|
|
308
|
+
it('gets versions for document', async() => {
|
|
309
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
310
|
+
|
|
311
|
+
sendSpy.mockReturnValue(Promise.resolve({Items: [
|
|
312
|
+
{
|
|
313
|
+
coolId: {S: 'my-document-id'},
|
|
314
|
+
timestamp: {N: '123'},
|
|
315
|
+
name: {S: 'my-doc'}
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
coolId: {S: 'my-document-id'},
|
|
319
|
+
timestamp: {N: '234'},
|
|
320
|
+
name: {S: 'my-doc'}
|
|
321
|
+
}
|
|
322
|
+
]}));
|
|
323
|
+
|
|
324
|
+
expect(await store.getVersions('my-document-id')).toEqual({
|
|
325
|
+
items: [
|
|
326
|
+
{coolId: 'my-document-id', name: 'my-doc', timestamp: 123},
|
|
327
|
+
{coolId: 'my-document-id', name: 'my-doc', timestamp: 234}
|
|
328
|
+
]
|
|
329
|
+
});
|
|
330
|
+
});
|
|
331
|
+
|
|
332
|
+
it('gets next page token', async() => {
|
|
333
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
334
|
+
|
|
335
|
+
sendSpy.mockReturnValue(Promise.resolve({
|
|
336
|
+
LastEvaluatedKey: {
|
|
337
|
+
coolId: {S: 'my-document-id'},
|
|
338
|
+
timestamp: {N: '123'},
|
|
339
|
+
},
|
|
340
|
+
Items: [
|
|
341
|
+
{
|
|
342
|
+
coolId: {S: 'my-document-id'},
|
|
343
|
+
timestamp: {N: '234'},
|
|
344
|
+
name: {S: 'my-doc'}
|
|
345
|
+
}
|
|
346
|
+
]}));
|
|
347
|
+
|
|
348
|
+
expect(await store.getVersions('my-document-id')).toEqual(expect.objectContaining({
|
|
349
|
+
nextPageToken: 123,
|
|
350
|
+
}));
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
it('gets undefined for unknown document id', async() => {
|
|
354
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
355
|
+
sendSpy.mockReturnValue(Promise.resolve({}));
|
|
356
|
+
expect(await store.getVersions('my-document-id')).toBeUndefined();
|
|
357
|
+
sendSpy.mockReturnValue(Promise.resolve({Items: []}));
|
|
358
|
+
expect(await store.getVersions('my-document-id')).toBeUndefined();
|
|
359
|
+
});
|
|
360
|
+
|
|
361
|
+
it('gets version with indicated start point', async() => {
|
|
362
|
+
const store = dynamoVersionedDocumentStore()<TTestDocument>()(config)(middleware, 'coolId', undefined);
|
|
363
|
+
sendSpy.mockReturnValue(Promise.resolve({}));
|
|
364
|
+
await store.getVersions('my-document-id', 123);
|
|
365
|
+
|
|
366
|
+
expect(sendSpy).toHaveBeenCalledWith(expect.objectContaining({
|
|
367
|
+
input: expect.objectContaining({
|
|
368
|
+
ExclusiveStartKey: {
|
|
369
|
+
coolId: {S: 'my-document-id'},
|
|
370
|
+
timestamp: {N: '123'}
|
|
371
|
+
}
|
|
372
|
+
})
|
|
373
|
+
}));
|
|
374
|
+
});
|
|
375
|
+
});
|
|
376
|
+
});
|