create-qpq-app 0.1.26 → 0.1.27

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/emailReceive → suites/emailReceive/logic}/askRunEmailReceiveTest.ts

@@ -1,8 +1,8 @@
 import { askDnsResolveHosts, askEmailSendEmail, AskResponse } from 'quidproquo';
 
-import { smokeEmailMarkerId } from '../../email/smokeEmailMarkerId';
-import { askSmokeAssert } from '../askSmokeAssert';
-import { askSmokePollForMarker } from '../askSmokePollForMarker';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
+import { askSmokePollForMarker } from '../../../harness/assert/askSmokePollForMarker';
+import { smokeEmailMarkerId } from './smokeEmailMarkerId';
 
 // The inbound email path end to end: send to this app's own receiving domain
 // with its own sender, SES receives it through the account rule set and the

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/emailReceive → suites/emailReceive/logic}/index.ts

@@ -1 +1,2 @@
 export * from './askRunEmailReceiveTest';
+export * from './smokeEmailMarkerId';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/config/defineEncryptedResourcesSmoke.ts

@@ -0,0 +1,29 @@
+import {
+  defineCryptoKey,
+  defineKeyValueStore,
+  defineStorageDrive,
+  QPQConfig,
+} from 'quidproquo';
+
+import { SmokeProbeRecord } from '@qpqjs/test-models';
+
+import { SMOKE_CRYPTO_KEY } from '../constants/SMOKE_CRYPTO_KEY';
+import { SMOKE_ENCRYPTED_PROBE_DRIVE } from '../constants/SMOKE_ENCRYPTED_PROBE_DRIVE';
+import { SMOKE_ENCRYPTED_PROBE_STORE } from '../constants/SMOKE_ENCRYPTED_PROBE_STORE';
+
+/**
+ * A drive and a store encrypted with an owned crypto key, so the test proves
+ * the role's KMS grant covers data at rest.
+ */
+export const defineEncryptedResourcesSmoke = (): QPQConfig => [
+  defineCryptoKey(SMOKE_CRYPTO_KEY),
+  defineKeyValueStore<SmokeProbeRecord>(
+    SMOKE_ENCRYPTED_PROBE_STORE,
+    'probeId',
+    [],
+    { cryptoKeyName: SMOKE_CRYPTO_KEY }
+  ),
+  defineStorageDrive(SMOKE_ENCRYPTED_PROBE_DRIVE, {
+    cryptoKeyName: SMOKE_CRYPTO_KEY,
+  }),
+];

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/config/index.ts

@@ -0,0 +1 @@
+export * from './defineEncryptedResourcesSmoke';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/constants/SMOKE_CRYPTO_KEY.ts

@@ -0,0 +1,5 @@
+/**
+ * The crypto key the encrypted probe drive and store name. Not 'smokeProbe':
+ * the signing key of that name is a KMS alias too, and the two would collide.
+ */
+export const SMOKE_CRYPTO_KEY = 'smokeCrypto';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/constants/SMOKE_ENCRYPTED_PROBE_DRIVE.ts

@@ -0,0 +1,2 @@
+/** A probe drive encrypted at rest with SMOKE_CRYPTO_KEY. */
+export const SMOKE_ENCRYPTED_PROBE_DRIVE = 'smoke-encrypted-probe';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/constants/SMOKE_ENCRYPTED_PROBE_STORE.ts

@@ -0,0 +1,2 @@
+/** A probe store encrypted at rest with SMOKE_CRYPTO_KEY. */
+export const SMOKE_ENCRYPTED_PROBE_STORE = 'smokeEncryptedProbe';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/constants/index.ts

@@ -0,0 +1,3 @@
+export * from './SMOKE_CRYPTO_KEY';
+export * from './SMOKE_ENCRYPTED_PROBE_DRIVE';
+export * from './SMOKE_ENCRYPTED_PROBE_STORE';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/encryptedResourcesSmokeSuite.ts

@@ -0,0 +1,9 @@
+import { SmokeSuite } from '../../harness/types/SmokeSuite';
+import { defineEncryptedResourcesSmoke } from './config/defineEncryptedResourcesSmoke';
+import { askRunEncryptedResourcesTest } from './logic/askRunEncryptedResourcesTest';
+
+/** Round trips through a drive and a store encrypted with an owned crypto key. */
+export const encryptedResourcesSmokeSuite: SmokeSuite = {
+  defineConfig: defineEncryptedResourcesSmoke,
+  tests: [{ name: 'encryptedResources', askRun: askRunEncryptedResourcesTest }],
+};

package/template/apps/qpqjs/services/test/service/src/smoke/suites/encryptedResources/index.ts

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './constants';
+export * from './encryptedResourcesSmokeSuite';
+export * from './logic';

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/encryptedResources → suites/encryptedResources/logic}/askRunEncryptedResourcesTest.ts

@@ -11,11 +11,9 @@ import {
 
 import { SmokeProbeRecord } from '@qpqjs/test-models';
 
-import {
-  SMOKE_ENCRYPTED_PROBE_DRIVE,
-  SMOKE_ENCRYPTED_PROBE_STORE,
-} from '../../constants/smokeProbe';
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
+import { SMOKE_ENCRYPTED_PROBE_DRIVE } from '../constants/SMOKE_ENCRYPTED_PROBE_DRIVE';
+import { SMOKE_ENCRYPTED_PROBE_STORE } from '../constants/SMOKE_ENCRYPTED_PROBE_STORE';
 
 // A drive and a store encrypted with a defineCryptoKey. Deployed, every write
 // needs kms:GenerateDataKey and every read kms:Decrypt on that key through

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/config/defineEventBusSmoke.ts

@@ -0,0 +1,21 @@
+import { defineEventBus, defineQueue, QPQConfig } from 'quidproquo';
+
+import { SMOKE_PROBE_EVENT_BUS } from '../constants/SMOKE_PROBE_EVENT_BUS';
+import { SMOKE_PROBE_EVENT_QUEUE } from '../constants/SMOKE_PROBE_EVENT_QUEUE';
+import { SMOKE_PROBE_EVENT_TYPE } from '../constants/SMOKE_PROBE_EVENT_TYPE';
+
+/** Publish to the bus, the subscribed queue's entry writes a marker into the probe store, the test polls for it. */
+export const defineEventBusSmoke = (): QPQConfig => [
+  defineEventBus(SMOKE_PROBE_EVENT_BUS),
+  defineQueue(
+    SMOKE_PROBE_EVENT_QUEUE,
+    {
+      [SMOKE_PROBE_EVENT_TYPE]: {
+        basePath: __dirname,
+        relativePath: '../entry/queue/onSmokeProbeEvent',
+        functionName: 'onSmokeProbeEvent',
+      },
+    },
+    { eventBusSubscriptions: [SMOKE_PROBE_EVENT_BUS] }
+  ),
+];

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/config/index.ts

@@ -0,0 +1 @@
+export * from './defineEventBusSmoke';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/constants/SMOKE_PROBE_EVENT_BUS.ts

@@ -0,0 +1,2 @@
+/** The owned event bus the eventBus test publishes to. */
+export const SMOKE_PROBE_EVENT_BUS = 'smokeProbe';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/constants/SMOKE_PROBE_EVENT_QUEUE.ts

@@ -0,0 +1,2 @@
+/** The queue subscribed to the probe event bus; its entry writes the marker the test polls for. */
+export const SMOKE_PROBE_EVENT_QUEUE = 'smokeProbeEvents';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/constants/SMOKE_PROBE_EVENT_TYPE.ts

@@ -0,0 +1,2 @@
+/** The one message type that flows bus -> queue -> store marker. */
+export const SMOKE_PROBE_EVENT_TYPE = 'smokeProbeEvent';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/constants/index.ts

@@ -0,0 +1,3 @@
+export * from './SMOKE_PROBE_EVENT_BUS';
+export * from './SMOKE_PROBE_EVENT_QUEUE';
+export * from './SMOKE_PROBE_EVENT_TYPE';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/entry/index.ts

@@ -0,0 +1 @@
+export * from './queue';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/entry/queue/index.ts

@@ -0,0 +1 @@
+export * from './onSmokeProbeEvent';

package/template/apps/qpqjs/services/test/service/src/smoke/{queue → suites/eventBus/entry/queue}/onSmokeProbeEvent.ts

@@ -7,7 +7,7 @@ import {
 import { SMOKE_PROBE_STORE } from '@qpqjs/constants';
 import { SmokeProbeRecord } from '@qpqjs/test-models';
 
-import { SmokeProbeEventQueueEvent } from '../models/SmokeProbeEventQueueEvent';
+import { SmokeProbeEventQueueEvent } from '../../models/SmokeProbeEventQueueEvent';
 
 // Fan-in for the event bus test: the message published to the probe bus
 // lands here via the subscribed queue, and the marker row it writes is what

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/eventBusSmokeSuite.ts

@@ -0,0 +1,9 @@
+import { SmokeSuite } from '../../harness/types/SmokeSuite';
+import { defineEventBusSmoke } from './config/defineEventBusSmoke';
+import { askRunEventBusTest } from './logic/askRunEventBusTest';
+
+/** Publish to an owned event bus and wait for the subscribed queue's marker. */
+export const eventBusSmokeSuite: SmokeSuite = {
+  defineConfig: defineEventBusSmoke,
+  tests: [{ name: 'eventBus', askRun: askRunEventBusTest }],
+};

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/index.ts

@@ -0,0 +1,6 @@
+export * from './config';
+export * from './constants';
+export * from './entry';
+export * from './eventBusSmokeSuite';
+export * from './logic';
+export * from './models';

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventBus → suites/eventBus/logic}/askRunEventBusTest.ts

@@ -5,12 +5,10 @@ import {
   EventBusMessage,
 } from 'quidproquo';
 
-import {
-  SMOKE_PROBE_EVENT_BUS,
-  SMOKE_PROBE_EVENT_TYPE,
-} from '../../constants/smokeProbe';
-import { SmokeProbeEventPayload } from '../../models/SmokeProbeEventQueueEvent';
-import { askSmokePollForMarker } from '../askSmokePollForMarker';
+import { askSmokePollForMarker } from '../../../harness/assert/askSmokePollForMarker';
+import { SMOKE_PROBE_EVENT_BUS } from '../constants/SMOKE_PROBE_EVENT_BUS';
+import { SMOKE_PROBE_EVENT_TYPE } from '../constants/SMOKE_PROBE_EVENT_TYPE';
+import { SmokeProbeEventPayload } from '../models/SmokeProbeEventQueueEvent';
 
 // The full async fan-out / fan-in path: publish to the owned event bus, the
 // subscribed queue's entry (onSmokeProbeEvent) writes a marker row, and this

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventBus/models/index.ts

@@ -0,0 +1 @@
+export * from './SmokeProbeEventQueueEvent';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/config/defineEventDocSmoke.ts

@@ -0,0 +1,44 @@
+import { defineQueue, QPQConfig } from 'quidproquo';
+import { defineEventDoc } from 'quidproquo-features';
+
+import {
+  SMOKE_EVENT_DOC_APPEND_MESSAGE_TYPE,
+  SMOKE_EVENT_DOC_APPEND_QUEUE,
+  SMOKE_EVENT_DOC_BASE_PATH,
+} from '../constants/smokeEventDoc';
+import { smokeProbeDocDefinition } from '../definition/smokeProbeDocDefinition';
+
+/**
+ * A full registered event-doc collection (stores, stream projector, dynamic
+ * functions, routes) so the tests exercise event docs the way a real service
+ * does, plus the queue that fans a test's writers out one invocation each so
+ * their appends race across lambdas.
+ */
+export const defineEventDocSmoke = (): QPQConfig => [
+  // NOTE the routes mount with no auth (the test service has no user
+  // directory), so the collection is world-writable; it holds nothing but
+  // throwaway probe docs.
+  defineEventDoc(
+    smokeProbeDocDefinition,
+    {
+      basePath: __dirname,
+      relativePath: '../definition/smokeProbeDocDefinition',
+      functionName: 'smokeProbeDocDefinition',
+    },
+    { basePath: SMOKE_EVENT_DOC_BASE_PATH }
+  ),
+  // A writer that loses the slot race past the append retry cap fails its
+  // message; a quick redelivery lets it land instead of vanishing, as a
+  // production queue should.
+  defineQueue(
+    SMOKE_EVENT_DOC_APPEND_QUEUE,
+    {
+      [SMOKE_EVENT_DOC_APPEND_MESSAGE_TYPE]: {
+        basePath: __dirname,
+        relativePath: '../entry/queue/onSmokeEventDocAppend',
+        functionName: 'onSmokeEventDocAppend',
+      },
+    },
+    { maxTries: 3, ttRetryInSeconds: 10 }
+  ),
+];

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/config/index.ts

@@ -0,0 +1 @@
+export * from './defineEventDocSmoke';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/constants/index.ts

@@ -0,0 +1 @@
+export * from './smokeEventDoc';

package/template/apps/qpqjs/services/test/service/src/smoke/{constants → suites/eventDoc/constants}/smokeEventDoc.ts

@@ -1,7 +1,7 @@
 import { EventDocEventActor, EventDocStoreOptions } from 'quidproquo-features';
 
 // The throwaway event-doc collection the smoke tests write to, registered in full via
-// defineEventDoc (see ../eventDoc/smokeProbeDocDefinition): stores, stream projector,
+// defineEventDoc (see ../definition/smokeProbeDocDefinition): stores, stream projector,
 // dynamic functions and routes, exactly as a real service's collection.
 export const SMOKE_EVENT_DOC_STORE = 'smokeEventDocs';
 export const SMOKE_EVENT_DOC_TYPE = 'smokeProbeDoc';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/entry/index.ts

@@ -0,0 +1 @@
+export * from './queue';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/entry/queue/index.ts

@@ -0,0 +1 @@
+export * from './onSmokeEventDocAppend';

package/template/apps/qpqjs/services/test/service/src/smoke/{queue → suites/eventDoc/entry/queue}/onSmokeEventDocAppend.ts

@@ -11,9 +11,9 @@ import {
   SMOKE_EVENT_DOC_MARK_EVENT,
   SMOKE_EVENT_DOC_SCHEMA_VERSION,
   SMOKE_EVENT_DOC_STORE_OPTIONS,
-} from '../constants/smokeEventDoc';
-import { SmokeEventDocAppendQueueEvent } from '../models/SmokeEventDocAppendQueueEvent';
-import { SmokeEventDocMark } from '../models/SmokeEventDocMark';
+} from '../../constants/smokeEventDoc';
+import { SmokeEventDocAppendQueueEvent } from '../../models/SmokeEventDocAppendQueueEvent';
+import { SmokeEventDocMark } from '../../models/SmokeEventDocMark';
 
 // One writer in the event-doc concurrency tests. Every message is its own invocation,
 // so the writers of a test race each other for the log's next slots for real - the

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/eventDocSmokeSuite.ts

@@ -0,0 +1,19 @@
+import { SmokeSuite } from '../../harness/types/SmokeSuite';
+import { defineEventDocSmoke } from './config/defineEventDocSmoke';
+import { askRunEventDocConcurrentAppendTest } from './logic/askRunEventDocConcurrentAppendTest';
+import { askRunEventDocInterleavedBatchAppendTest } from './logic/askRunEventDocInterleavedBatchAppendTest';
+
+/** Racing appends onto one event doc across lambdas must stay contiguous. */
+export const eventDocSmokeSuite: SmokeSuite = {
+  defineConfig: defineEventDocSmoke,
+  tests: [
+    {
+      name: 'eventDocConcurrentAppend',
+      askRun: askRunEventDocConcurrentAppendTest,
+    },
+    {
+      name: 'eventDocInterleavedBatchAppend',
+      askRun: askRunEventDocInterleavedBatchAppendTest,
+    },
+  ],
+};

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/index.ts

@@ -0,0 +1,7 @@
+export * from './config';
+export * from './constants';
+export * from './definition';
+export * from './entry';
+export * from './eventDocSmokeSuite';
+export * from './logic';
+export * from './models';

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventDoc → suites/eventDoc/logic}/askAssertContiguousEventIds.ts

@@ -1,7 +1,7 @@
 import { AskResponse } from 'quidproquo';
 import { EventDocEvent } from 'quidproquo-features';
 
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 
 // The whole point of numeric event ids: an ascending list read of the log is exactly
 // 0, 1, 2, ... with no hole and no repeat, whatever order the writers raced in.

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventDoc → suites/eventDoc/logic}/askAssertSmokeProbeDocState.ts

@@ -1,8 +1,8 @@
 import { AskResponse } from 'quidproquo';
 import { askEventDocDocumentStateLatest } from 'quidproquo-features';
 
-import { SmokeProbeDocState } from '../../eventDoc/smokeProbeDocDefinition';
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
+import { SmokeProbeDocState } from '../definition/smokeProbeDocDefinition';
 
 // The folded document, read the way the render/references routes read it: snapshot
 // seeded (whatever the stream projector has stored so far) plus the gap, through the

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventDoc → suites/eventDoc/logic}/askAwaitSmokeEventDocLog.ts

@@ -1,7 +1,7 @@
 import { askDelay, AskResponse } from 'quidproquo';
 import { askEventDocEventListAll, EventDocEvent } from 'quidproquo-features';
 
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 
 // Long enough to cover a writer's retry laps plus one queue redelivery.
 const POLL_ATTEMPTS = 45;

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventDoc → suites/eventDoc/logic}/askRunEventDocConcurrentAppendTest.ts

@@ -5,6 +5,7 @@ import {
   askEventDocSoftDelete,
 } from 'quidproquo-features';
 
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 import {
   SMOKE_EVENT_DOC_ACTOR,
   SMOKE_EVENT_DOC_APPEND_MESSAGE_TYPE,
@@ -12,11 +13,10 @@ import {
   SMOKE_EVENT_DOC_MARK_EVENT,
   SMOKE_EVENT_DOC_SCHEMA_VERSION,
   SMOKE_EVENT_DOC_STORE_OPTIONS,
-} from '../../constants/smokeEventDoc';
-import { SMOKE_PROBE_DOC_WINDOW } from '../../eventDoc/smokeProbeDocDefinition';
-import { SmokeEventDocAppendPayload } from '../../models/SmokeEventDocAppendQueueEvent';
-import { SmokeEventDocMark } from '../../models/SmokeEventDocMark';
-import { askSmokeAssert } from '../askSmokeAssert';
+} from '../constants/smokeEventDoc';
+import { SMOKE_PROBE_DOC_WINDOW } from '../definition/smokeProbeDocDefinition';
+import { SmokeEventDocAppendPayload } from '../models/SmokeEventDocAppendQueueEvent';
+import { SmokeEventDocMark } from '../models/SmokeEventDocMark';
 import { askAssertContiguousEventIds } from './askAssertContiguousEventIds';
 import { askAssertSmokeProbeDocState } from './askAssertSmokeProbeDocState';
 import { askAwaitSmokeEventDocLog } from './askAwaitSmokeEventDocLog';

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/eventDoc → suites/eventDoc/logic}/askRunEventDocInterleavedBatchAppendTest.ts

@@ -5,6 +5,7 @@ import {
   askEventDocSoftDelete,
 } from 'quidproquo-features';
 
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 import {
   SMOKE_EVENT_DOC_ACTOR,
   SMOKE_EVENT_DOC_APPEND_MESSAGE_TYPE,
@@ -12,10 +13,9 @@ import {
   SMOKE_EVENT_DOC_MARK_EVENT,
   SMOKE_EVENT_DOC_SCHEMA_VERSION,
   SMOKE_EVENT_DOC_STORE_OPTIONS,
-} from '../../constants/smokeEventDoc';
-import { SmokeEventDocAppendPayload } from '../../models/SmokeEventDocAppendQueueEvent';
-import { SmokeEventDocMark } from '../../models/SmokeEventDocMark';
-import { askSmokeAssert } from '../askSmokeAssert';
+} from '../constants/smokeEventDoc';
+import { SmokeEventDocAppendPayload } from '../models/SmokeEventDocAppendQueueEvent';
+import { SmokeEventDocMark } from '../models/SmokeEventDocMark';
 import { askAssertContiguousEventIds } from './askAssertContiguousEventIds';
 import { askAssertSmokeProbeDocState } from './askAssertSmokeProbeDocState';
 import { askAwaitSmokeEventDocLog } from './askAwaitSmokeEventDocLog';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/eventDoc/models/index.ts

@@ -0,0 +1,2 @@
+export * from './SmokeEventDocAppendQueueEvent';
+export * from './SmokeEventDocMark';

package/template/apps/qpqjs/services/test/service/src/smoke/{tests → suites}/index.ts

@@ -1,6 +1,3 @@
-export * from './askSmokeAssert';
-export * from './askSmokePollForMarker';
-export * from './crossService';
 export * from './emailReceive';
 export * from './encryptedResources';
 export * from './eventBus';
@@ -10,9 +7,11 @@ export * from './keyValueStoreStream';
 export * from './noop';
 export * from './openApi';
 export * from './parameter';
+export * from './schedule';
+export * from './scopedKeyValueStore';
+export * from './scopedStorageDrive';
 export * from './secret';
 export * from './signingKey';
-export * from './SmokeTestDefinition';
-export * from './smokeTestRegistry';
+export * from './smokeSuites';
 export * from './storageDrive';
 export * from './storageDriveEvent';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStore/index.ts

@@ -0,0 +1,2 @@
+export * from './keyValueStoreSmokeSuite';
+export * from './logic';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStore/keyValueStoreSmokeSuite.ts

@@ -0,0 +1,14 @@
+import { SmokeSuite } from '../../harness/types/SmokeSuite';
+import { askRunCrossServiceKeyValueStoreTest } from './logic/askRunCrossServiceKeyValueStoreTest';
+import { askRunKeyValueStoreTest } from './logic/askRunKeyValueStoreTest';
+
+/** Every DynamoDB action on the probe store, from this service and from testa. No config: the store belongs to the harness. */
+export const keyValueStoreSmokeSuite: SmokeSuite = {
+  tests: [
+    { name: 'keyValueStore', askRun: askRunKeyValueStoreTest },
+    {
+      name: 'crossServiceKeyValueStore',
+      askRun: askRunCrossServiceKeyValueStoreTest,
+    },
+  ],
+};

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/crossService → suites/keyValueStore/logic}/askRunCrossServiceKeyValueStoreTest.ts

@@ -17,7 +17,7 @@ import {
   CrossServiceProbePayload,
 } from '@qpqjs/testa-models';
 
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 
 // testa writes a row into the store THIS service owns, through its foreign
 // (exact-ARN) DynamoDB grant. An error from inside testa is that grant; the

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/keyValueStore → suites/keyValueStore/logic}/askRunKeyValueStoreTest.ts

@@ -14,7 +14,7 @@ import {
 import { SMOKE_PROBE_STORE } from '@qpqjs/constants';
 import { SmokeProbeRecord } from '@qpqjs/test-models';
 
-import { askSmokeAssert } from '../askSmokeAssert';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
 
 // Every DynamoDB action the owned-table grant covers (PutItem, GetItem,
 // UpdateItem, Query, DeleteItem), including a query that must be served by

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStore/logic/index.ts

@@ -0,0 +1,2 @@
+export * from './askRunCrossServiceKeyValueStoreTest';
+export * from './askRunKeyValueStoreTest';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/config/defineKeyValueStoreStreamSmoke.ts

@@ -0,0 +1,30 @@
+import { defineKeyValueStore, QPQConfig } from 'quidproquo';
+
+import { SmokeProbeRecord } from '@qpqjs/test-models';
+
+import { SMOKE_STREAM_PROBE_STORE } from '../constants/SMOKE_STREAM_PROBE_STORE';
+
+/**
+ * A change on this scoped store streams to the handler, which writes a marker
+ * into the probe store for the test to poll. The record must carry the scope
+ * as its own field with a raw key, and the category index's hidden copy must
+ * not reach the handler.
+ */
+export const defineKeyValueStoreStreamSmoke = (): QPQConfig => [
+  defineKeyValueStore<SmokeProbeRecord>(
+    SMOKE_STREAM_PROBE_STORE,
+    'probeId',
+    [],
+    {
+      indexes: ['category'],
+      scoped: true,
+      onStream: {
+        runtime: {
+          basePath: __dirname,
+          relativePath: '../entry/kvsStream/onSmokeStreamRecord',
+          functionName: 'onSmokeStreamRecord',
+        },
+      },
+    }
+  ),
+];

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/config/index.ts

@@ -0,0 +1 @@
+export * from './defineKeyValueStoreStreamSmoke';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/constants/SMOKE_STREAM_PROBE_STORE.ts

@@ -0,0 +1,2 @@
+/** A scoped store with a change stream; its handler writes the markers the kvs stream test polls for. */
+export const SMOKE_STREAM_PROBE_STORE = 'smokeStreamProbe';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/constants/index.ts

@@ -0,0 +1 @@
+export * from './SMOKE_STREAM_PROBE_STORE';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/entry/index.ts

@@ -0,0 +1 @@
+export * from './kvsStream';

package/template/apps/qpqjs/services/test/service/src/smoke/{kvsStream → suites/keyValueStoreStream/entry/kvsStream}/index.ts

@@ -1,2 +1 @@
 export * from './onSmokeStreamRecord';
-export * from './smokeStreamMarkerId';

package/template/apps/qpqjs/services/test/service/src/smoke/{kvsStream → suites/keyValueStoreStream/entry/kvsStream}/onSmokeStreamRecord.ts

@@ -8,12 +8,13 @@ import {
 import { SMOKE_PROBE_STORE } from '@qpqjs/constants';
 import { SmokeProbeRecord } from '@qpqjs/test-models';
 
-import { smokeStreamMarkerId } from './smokeStreamMarkerId';
+import { smokeStreamMarkerId } from '../../logic/smokeStreamMarkerId';
 
 // Fan-in for the kvs stream test: the scoped stream store's changes land
-// here. The marker records the scope the record carried and the raw key, so
-// the test can check the stream hands back the scope as its own field with
-// the key stripped of it.
+// here. The marker records the scope the record carried, the raw key and the
+// image's attribute names, so the test can check the stream hands back the
+// scope as its own field, the key stripped of it, and none of the store's
+// hidden index attributes.
 export function* onSmokeStreamRecord(
   record: KvsStreamRecord<SmokeProbeRecord>
 ): AskResponse<KvsStreamEventResponse> {
@@ -25,6 +26,7 @@ export function* onSmokeStreamRecord(
     value: 1,
     scope: record.scope,
     path: key,
+    imageAttributes: Object.keys(record.newImage ?? record.oldImage ?? {}),
   };
 
   yield* askKeyValueStoreUpsert<SmokeProbeRecord>(SMOKE_PROBE_STORE, marker);

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/index.ts

@@ -0,0 +1,5 @@
+export * from './config';
+export * from './constants';
+export * from './entry';
+export * from './keyValueStoreStreamSmokeSuite';
+export * from './logic';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/keyValueStoreStream/keyValueStoreStreamSmokeSuite.ts

@@ -0,0 +1,11 @@
+import { SmokeSuite } from '../../harness/types/SmokeSuite';
+import { defineKeyValueStoreStreamSmoke } from './config/defineKeyValueStoreStreamSmoke';
+import { askRunKeyValueStoreStreamTest } from './logic/askRunKeyValueStoreStreamTest';
+
+/** A scoped store's change stream, as its handler sees it. */
+export const keyValueStoreStreamSmokeSuite: SmokeSuite = {
+  defineConfig: defineKeyValueStoreStreamSmoke,
+  tests: [
+    { name: 'keyValueStoreStream', askRun: askRunKeyValueStoreStreamTest },
+  ],
+};

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/keyValueStoreStream → suites/keyValueStoreStream/logic}/askRunKeyValueStoreStreamTest.ts

@@ -8,15 +8,17 @@ import {
 
 import { SmokeProbeRecord } from '@qpqjs/test-models';
 
-import { SMOKE_STREAM_PROBE_STORE } from '../../constants/smokeProbe';
-import { smokeStreamMarkerId } from '../../kvsStream/smokeStreamMarkerId';
-import { askSmokeAssert } from '../askSmokeAssert';
-import { askSmokePollForMarker } from '../askSmokePollForMarker';
+import { askSmokeAssert } from '../../../harness/assert/askSmokeAssert';
+import { askSmokePollForMarker } from '../../../harness/assert/askSmokePollForMarker';
+import { SMOKE_STREAM_PROBE_STORE } from '../constants/SMOKE_STREAM_PROBE_STORE';
+import { smokeStreamMarkerId } from './smokeStreamMarkerId';
 
 // The kvs stream path end to end on a scoped store: an upsert streams an
 // Insert and a delete streams a Remove to the handler. On dynamo the scope is
-// composed into the stored partition key, so the record must hand it back as
-// its own field with the key stripped, the same as the dev server does.
+// composed into the stored partition key and into a hidden copy of the
+// category GSI key, so the record must hand the scope back as its own field
+// with the key stripped and the hidden copy dropped, the same as the dev
+// server does.
 export function* askRunKeyValueStoreStreamTest(): AskResponse<void> {
   const probeId = yield* askNewGuid();
   const scope = `smoke-st-${probeId}`;
@@ -44,6 +46,13 @@ export function* askRunKeyValueStoreStreamTest(): AskResponse<void> {
     inserted.path === probeId,
     `stream insert key [${inserted.path}] was not the raw key`
   );
+  yield* askSmokeAssert(
+    !!inserted.imageAttributes?.includes('category') &&
+      inserted.imageAttributes.every(
+        (attribute) => !attribute.includes('@@QPQ')
+      ),
+    `stream insert image attributes [${inserted.imageAttributes}] missed category or leaked a reserved @@QPQ attribute`
+  );
 
   yield* askKeyValueStoreDelete(SMOKE_STREAM_PROBE_STORE, probeId, undefined, {
     scope,

package/template/apps/qpqjs/services/test/service/src/smoke/{tests/keyValueStoreStream → suites/keyValueStoreStream/logic}/index.ts

@@ -1 +1,2 @@
 export * from './askRunKeyValueStoreStreamTest';
+export * from './smokeStreamMarkerId';

package/template/apps/qpqjs/services/test/service/src/smoke/suites/noop/index.ts

@@ -0,0 +1,2 @@
+export * from './logic';
+export * from './noopSmokeSuite';