chore: switch to pnpm

Author: rchl

.github/workflows/ci.yaml

@@ -16,16 +16,19 @@ jobs:
       CI: true
     name: Test and lint
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
+      - uses: pnpm/action-setup@v6
       - name: Setup node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
-          node-version: 20.x
-      - name: npm install
-        run: npm i
+          node-version: 24
+          registry-url: https://registry.npmjs.org
+          cache: pnpm
+      - name: pnpm install
+        run: pnpm i
       - name: build
-        run: npm run build
+        run: pnpm build
       - name: Unittesting
-        run: npm run test
+        run: pnpm test
       - name: Linting
-        run: npm run lint
+        run: pnpm lint

.github/workflows/publish.yaml

@@ -32,7 +32,7 @@ jobs:
     needs: docker
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Update repo description
         uses: peter-evans/dockerhub-description@v4
         with:

.husky/pre-commit

@@ -0,0 +1 @@
+pnpm lint

Dockerfile

@@ -1,33 +1,38 @@
-FROM node:20-alpine AS build
+FROM node:24-alpine AS build
 
-RUN npm -g install npm@10
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
 
 COPY bin bin/
 COPY lib lib/
-COPY package-lock.json .
+COPY pnpm-lock.yaml .
 COPY package.json .
 COPY rollup.config.ts .
 COPY tsconfig.json .
 
-RUN npm ci
-RUN npm run build
+RUN pnpm install --frozen-lockfile
+RUN pnpm build
 
 FROM node:20-alpine
 EXPOSE 8001
 
 WORKDIR /home/node/app
 
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+RUN corepack enable
+
 RUN apk add --no-cache tini
-RUN npm -g install npm@10
 
 COPY --from=build dist dist/
 COPY public public/
 COPY views views/
 COPY README.md README.md
-COPY package-lock.json .
+COPY pnpm-lock.yaml .
 COPY package.json .
 
-RUN npm ci --omit=dev --ignore-scripts
+RUN pnpm install --frozen-lockfile --prod --ignore-scripts
 
 ENTRYPOINT ["tini"]
 CMD ["node", "dist/dynamodb-admin.js"]

README.md

@@ -79,9 +79,9 @@ server.on('listening', () => {
 
 ## Development
 
-Run `npm run build` and then `DYNAMO_ENDPOINT=http://localhost:8000 npm run start` to start dynamodb-admin.
+Run `pnpm build` and then `DYNAMO_ENDPOINT=http://localhost:8000 pnpm start` to start dynamodb-admin.
 
-You can set up a build watcher in a separate terminal using `npm run build:watch` which will re-compile the code on change and cause the dynamodb-admin instance to restart.
+You can set up a build watcher in a separate terminal using `pnpm build:watch` which will re-compile the code on change and cause the dynamodb-admin instance to restart.
 
 ## See also
 

lib/routes.ts

@@ -12,6 +12,38 @@ import { listAllTables } from './actions/listAllTables';
 import asyncMiddleware from './utils/asyncMiddleware';
 import type { DynamoApiController } from './dynamoDbApi';
 
+type TableNameParams = { TableName: string };
+type TableItemParams = { TableName: string; key: string };
+
+type TableDefinitionInput = {
+    TableName: string;
+    HashAttributeName: string;
+    HashAttributeType: ScalarAttributeType;
+    RangeAttributeName?: string;
+    RangeAttributeType?: ScalarAttributeType;
+    ReadCapacityUnits: number;
+    WriteCapacityUnits: number;
+};
+
+type SecondaryIndexesInput = Omit<TableDefinitionInput, 'TableName'> & {
+    IndexName: string;
+    IndexType: 'global' | 'local';
+};
+
+type GetItemQuery = { hash?: string; range?: string };
+
+type TableScanQuery = { pageNum?: string };
+
+type ItemsQuery = {
+    filters?: string;
+    startKey?: string;
+    prevKey?: string;
+    pageNum?: string;
+    pageSize?: string;
+    queryableSelection?: string;
+    operationType?: string;
+};
+
 const DEFAULT_THEME = process.env.DEFAULT_THEME || 'light';
 
 export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath = ''): void {
@@ -46,21 +78,6 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.render('create-table', {});
     });
 
-    type TableDefinitionInput = {
-        TableName: string;
-        HashAttributeName: string;
-        HashAttributeType: ScalarAttributeType;
-        RangeAttributeName?: string;
-        RangeAttributeType?: ScalarAttributeType;
-        ReadCapacityUnits: number;
-        WriteCapacityUnits: number;
-    };
-
-    type SecondaryIndexesInput = Omit<TableDefinitionInput, 'TableName'> & {
-        IndexName: string;
-        IndexType: 'global' | 'local';
-    };
-
     router.post(
         '/create-table',
         bodyParser.json({ limit: '500kb' }),
@@ -193,22 +210,21 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.send('Tables purged');
     }));
 
-    router.delete('/tables/:TableName', asyncMiddleware(async(req, res) => {
+    router.delete('/tables/:TableName', asyncMiddleware<TableNameParams>(async(req, res) => {
         const { TableName } = req.params;
         await ddbApi.deleteTable({ TableName });
         res.status(204).end();
     }));
 
-    router.delete('/tables/:TableName/all', asyncMiddleware(async(req, res) => {
+    router.delete('/tables/:TableName/all', asyncMiddleware<TableNameParams>(async(req, res) => {
         const { TableName } = req.params;
         await purgeTable(TableName, ddbApi);
         res.status(200).end();
     }));
 
-    router.get('/tables/:TableName/get', asyncMiddleware(async(req, res) => {
+    router.get('/tables/:TableName/get', asyncMiddleware<TableNameParams, any, any, GetItemQuery>(async(req, res) => {
         const { TableName } = req.params;
-        const hash = req.query.hash as string;
-        const range = req.query.range as string;
+        const { hash, range } = req.query;
         if (hash) {
             if (range) {
                 res.redirect(`${basePath}/tables/${encodeURIComponent(TableName)}/items/${encodeURIComponent(hash)},${encodeURIComponent(range)}`);
@@ -228,10 +244,10 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         });
     }));
 
-    router.get('/tables/:TableName', asyncMiddleware(async(req, res) => {
-        const TableName = req.params.TableName;
+    router.get('/tables/:TableName', asyncMiddleware<TableNameParams, any, any, TableScanQuery>(async(req, res) => {
+        const { TableName } = req.params;
         req.query = pickBy(req.query);
-        const pageNum = typeof req.query.pageNum === 'string' ? Number.parseInt(req.query.pageNum) : 1;
+        const pageNum = req.query.pageNum ? Number.parseInt(req.query.pageNum) : 1;
 
         const description = await ddbApi.describeTable({ TableName });
         const data = {
@@ -255,13 +271,13 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.render('scan', data);
     }));
 
-    router.get('/tables/:TableName/items', asyncMiddleware(async(req, res) => {
+    router.get('/tables/:TableName/items', asyncMiddleware<TableNameParams, any, any, ItemsQuery>(async(req, res) => {
         const { TableName } = req.params;
         req.query = pickBy(req.query);
-        const filters = typeof req.query.filters === 'string' ? JSON.parse(req.query.filters) : {};
-        const ExclusiveStartKey = typeof req.query.startKey === 'string' ? JSON.parse(req.query.startKey) : {};
-        const pageNum = typeof req.query.pageNum === 'string' ? parseInt(req.query.pageNum) : 1;
-        const queryableSelection = typeof req.query.queryableSelection === 'string' ? req.query.queryableSelection : 'table';
+        const filters = req.query.filters ? JSON.parse(req.query.filters) : {};
+        const ExclusiveStartKey = req.query.startKey ? JSON.parse(req.query.startKey) : {};
+        const pageNum = req.query.pageNum ? parseInt(req.query.pageNum) : 1;
+        const queryableSelection = req.query.queryableSelection ?? 'table';
         const operationType: 'scan' | 'query' = req.query.operationType === 'query' ? 'query' : 'scan';
         let indexBeingUsed = null;
 
@@ -323,7 +339,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
             KeyConditionExpression: KeyConditionExpression.length ? KeyConditionExpression.join(' AND ') : undefined,
             IndexName: queryableSelection !== 'table' ? queryableSelection : undefined,
         };
-        const pageSize = typeof req.query.pageSize === 'string' ? Number.parseInt(req.query.pageSize) : 25;
+        const pageSize = req.query.pageSize ? Number.parseInt(req.query.pageSize) : 25;
 
         const results = await getPage(ddbApi, tableDescription.KeySchema!, TableName, params, pageSize, operationType);
         const { pageItems, nextKey } = results;
@@ -343,10 +359,10 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         const data = {
             query: req.query,
             pageNum,
-            prevKey: encodeURIComponent(typeof req.query.prevKey === 'string' ? req.query.prevKey : ''),
-            startKey: encodeURIComponent(typeof req.query.startKey === 'string' ? req.query.startKey : ''),
+            prevKey: encodeURIComponent(req.query.prevKey ?? ''),
+            startKey: encodeURIComponent(req.query.startKey ?? ''),
             nextKey: nextKey ? encodeURIComponent(JSON.stringify(nextKey)) : null,
-            filterQueryString: encodeURIComponent(typeof req.query.filters === 'string' ? req.query.filters : ''),
+            filterQueryString: encodeURIComponent(req.query.filters ?? ''),
             Table: tableDescription,
             Items: pageItems,
             uniqueKeys,
@@ -355,7 +371,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.json(data);
     }));
 
-    router.get('/tables/:TableName/meta', asyncMiddleware(async(req, res) => {
+    router.get('/tables/:TableName/meta', asyncMiddleware<TableNameParams>(async(req, res) => {
         const { TableName } = req.params;
         const [tableDescription, items] = await Promise.all([
             ddbApi.describeTable({ TableName }),
@@ -368,7 +384,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.render('meta', data);
     }));
 
-    router.delete('/tables/:TableName/items/:key', asyncMiddleware(async(req, res) => {
+    router.delete('/tables/:TableName/items/:key', asyncMiddleware<TableItemParams>(async(req, res) => {
         const { TableName } = req.params;
         const tableDescription = await ddbApi.describeTable({ TableName });
         await ddbApi.deleteItem({
@@ -378,7 +394,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         res.status(204).end();
     }));
 
-    router.get('/tables/:TableName/add-item', asyncMiddleware(async(req, res) => {
+    router.get('/tables/:TableName/add-item', asyncMiddleware<TableNameParams>(async(req, res) => {
         const { TableName } = req.params;
         const tableDescription = await ddbApi.describeTable({ TableName });
         const Item: Record<string, string | number> = {};
@@ -400,7 +416,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         });
     }));
 
-    router.get('/tables/:TableName/items/:key', asyncMiddleware(async(req, res) => {
+    router.get('/tables/:TableName/items/:key', asyncMiddleware<TableItemParams>(async(req, res) => {
         const { TableName } = req.params;
         const tableDescription = await ddbApi.describeTable({ TableName });
         const params = {
@@ -421,7 +437,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         });
     }));
 
-    router.put('/tables/:TableName/add-item', bodyParser.json({ limit: '500kb' }), asyncMiddleware(async(req, res) => {
+    router.put('/tables/:TableName/add-item', bodyParser.json({ limit: '500kb' }), asyncMiddleware<TableNameParams>(async(req, res) => {
         const { TableName } = req.params;
         const tableDescription = await ddbApi.describeTable({ TableName });
         await ddbApi.putItem({ TableName, Item: req.body });
@@ -435,7 +451,7 @@ export function setupRoutes(app: Express, ddbApi: DynamoApiController, basePath
         return;
     }));
 
-    router.put('/tables/:TableName/items/:key', bodyParser.json({ limit: '500kb' }), asyncMiddleware(async(req, res) => {
+    router.put('/tables/:TableName/items/:key', bodyParser.json({ limit: '500kb' }), asyncMiddleware<TableItemParams>(async(req, res) => {
         const { TableName } = req.params;
         const tableDescription = await ddbApi.describeTable({ TableName });
         await ddbApi.putItem({ TableName, Item: req.body });

lib/utils/asyncMiddleware.ts

@@ -1,7 +1,12 @@
 import type { RequestHandler } from 'express';
 
-export default function(endpointHandlerFunction: RequestHandler): RequestHandler {
+export default function asyncMiddleware<
+    P extends Record<string, string> = Record<string, string>,
+    ResBody = any,
+    ReqBody = any,
+    ReqQuery extends Record<string, string | string[] | undefined> = Record<string, string | string[] | undefined>,
+>(handler: RequestHandler<P, ResBody, ReqBody, ReqQuery>): RequestHandler {
     return function(req, res, next) {
-        Promise.resolve(endpointHandlerFunction(req, res, next)).catch(next);
+        Promise.resolve(handler(req as Parameters<typeof handler>[0], res, next)).catch(next);
     };
 }