@shivaedev/test-story 0.21.1 → 0.22.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.
Files changed (62) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +61 -2
  3. package/dist/server/forwardingProxy.d.ts.map +1 -1
  4. package/dist/server/forwardingProxy.js +3 -2
  5. package/dist/server/forwardingProxy.js.map +1 -1
  6. package/dist/server/internal/compose.d.ts +4 -0
  7. package/dist/server/internal/compose.d.ts.map +1 -0
  8. package/dist/server/internal/compose.js +38 -0
  9. package/dist/server/internal/compose.js.map +1 -0
  10. package/dist/server/internal/compositionTypes.d.ts +37 -0
  11. package/dist/server/internal/compositionTypes.d.ts.map +1 -0
  12. package/dist/server/internal/compositionTypes.js +2 -0
  13. package/dist/server/internal/compositionTypes.js.map +1 -0
  14. package/dist/server/internal/documentRedirect.d.ts.map +1 -1
  15. package/dist/server/internal/documentRedirect.js +3 -1
  16. package/dist/server/internal/documentRedirect.js.map +1 -1
  17. package/dist/server/internal/documentTransport.d.ts.map +1 -1
  18. package/dist/server/internal/documentTransport.js +4 -1
  19. package/dist/server/internal/documentTransport.js.map +1 -1
  20. package/dist/server/internal/fakeHttpAnswer.d.ts.map +1 -1
  21. package/dist/server/internal/fakeHttpAnswer.js +3 -2
  22. package/dist/server/internal/fakeHttpAnswer.js.map +1 -1
  23. package/dist/server/internal/fakeHttpControls.d.ts.map +1 -1
  24. package/dist/server/internal/fakeHttpControls.js +2 -1
  25. package/dist/server/internal/fakeHttpControls.js.map +1 -1
  26. package/dist/server/internal/fakeHttpReceive.d.ts.map +1 -1
  27. package/dist/server/internal/fakeHttpReceive.js +5 -4
  28. package/dist/server/internal/fakeHttpReceive.js.map +1 -1
  29. package/dist/server/internal/fakeHttpSend.d.ts.map +1 -1
  30. package/dist/server/internal/fakeHttpSend.js +3 -2
  31. package/dist/server/internal/fakeHttpSend.js.map +1 -1
  32. package/dist/server/internal/hookInference.d.ts +3 -3
  33. package/dist/server/internal/hookInference.d.ts.map +1 -1
  34. package/dist/server/internal/storyIt.d.ts.map +1 -1
  35. package/dist/server/internal/storyIt.js +7 -5
  36. package/dist/server/internal/storyIt.js.map +1 -1
  37. package/dist/server/otlpReceiver.d.ts.map +1 -1
  38. package/dist/server/otlpReceiver.js +5 -4
  39. package/dist/server/otlpReceiver.js.map +1 -1
  40. package/dist/server/outcomes.d.ts +6 -0
  41. package/dist/server/outcomes.d.ts.map +1 -0
  42. package/dist/server/outcomes.js +13 -0
  43. package/dist/server/outcomes.js.map +1 -0
  44. package/dist/server/storyKit.d.ts +6 -3
  45. package/dist/server/storyKit.d.ts.map +1 -1
  46. package/dist/server/storyKit.js +5 -1
  47. package/dist/server/storyKit.js.map +1 -1
  48. package/package.json +8 -6
  49. package/src/server/forwardingProxy.ts +3 -2
  50. package/src/server/internal/compose.ts +45 -0
  51. package/src/server/internal/compositionTypes.ts +56 -0
  52. package/src/server/internal/documentRedirect.ts +4 -1
  53. package/src/server/internal/documentTransport.ts +12 -1
  54. package/src/server/internal/fakeHttpAnswer.ts +3 -2
  55. package/src/server/internal/fakeHttpControls.ts +2 -1
  56. package/src/server/internal/fakeHttpReceive.ts +5 -4
  57. package/src/server/internal/fakeHttpSend.ts +3 -2
  58. package/src/server/internal/hookInference.ts +3 -3
  59. package/src/server/internal/storyIt.ts +9 -8
  60. package/src/server/otlpReceiver.ts +5 -4
  61. package/src/server/outcomes.ts +21 -0
  62. package/src/server/storyKit.ts +11 -5
@@ -1,5 +1,6 @@
1
1
  import { createServer, type IncomingHttpHeaders, type IncomingMessage, type ServerResponse } from "node:http";
2
2
  import { Effect } from "effect";
3
+ import * as HttpStatus from "effect/http/HttpStatus";
3
4
  import { loopbackServer } from "#internal/loopback.ts";
4
5
  import { otlpReadout } from "#internal/otlpReadout.ts";
5
6
 
@@ -25,16 +26,16 @@ async function receive(request: IncomingMessage, response: ServerResponse, reque
25
26
  const body = Buffer.concat(chunks);
26
27
  requests.push({ body, headers: request.headers, path: request.url, rawHeaders: request.rawHeaders });
27
28
  if (request.method !== "POST" || request.url !== (options.path ?? "/v1/traces")) {
28
- response.writeHead(404).end();
29
+ response.writeHead(HttpStatus.fromLiteral("NotFound")).end();
29
30
  return;
30
31
  }
31
32
  const contentType = request.headers["content-type"]?.split(";")[0]?.trim();
32
33
  if (contentType !== "application/json" && contentType !== "application/x-protobuf") {
33
- response.writeHead(415).end();
34
+ response.writeHead(HttpStatus.fromLiteral("UnsupportedMediaType")).end();
34
35
  return;
35
36
  }
36
37
  spans.push(...otlpReadout(body, contentType));
37
- const status = typeof options.status === "function" ? options.status(requests.length) : (options.status ?? 200);
38
+ const status = typeof options.status === "function" ? options.status(requests.length) : (options.status ?? HttpStatus.fromLiteral("OK"));
38
39
  if (status === undefined) {
39
40
  return;
40
41
  }
@@ -45,7 +46,7 @@ async function receive(request: IncomingMessage, response: ServerResponse, reque
45
46
  response.end(options.answer ?? "{}");
46
47
  }
47
48
  } catch {
48
- response.writeHead(400).end();
49
+ response.writeHead(HttpStatus.fromLiteral("BadRequest")).end();
49
50
  }
50
51
  }
51
52
 
@@ -0,0 +1,21 @@
1
+ import { Effect } from "effect";
2
+ import { type DeeplyAllowMatchers, expect } from "vitest";
3
+
4
+ type AnyReadout = Effect.Effect<unknown, unknown, unknown>;
5
+
6
+ export const outcomes = Effect.fn("Story.outcomes")(check);
7
+
8
+ function check<TReadouts extends Record<string, AnyReadout>>(
9
+ rows: {
10
+ readonly [TKey in keyof TReadouts]: readonly [TReadouts[TKey], DeeplyAllowMatchers<Effect.Success<NoInfer<TReadouts[TKey]>>>];
11
+ },
12
+ ): Effect.fn.Return<void, Effect.Error<TReadouts[keyof TReadouts]>, Effect.Services<TReadouts[keyof TReadouts]>>;
13
+ function* check(rows: Readonly<Record<string, readonly [AnyReadout, unknown]>>) {
14
+ const actual: Record<string, unknown> = {};
15
+ const expected: Record<string, unknown> = {};
16
+ for (const [label, [readout, value]] of Object.entries(rows)) {
17
+ actual[label] = yield* readout;
18
+ expected[label] = value;
19
+ }
20
+ expect(actual).toEqual(expected);
21
+ }
@@ -1,6 +1,8 @@
1
1
  import type { TestContext } from "@effect/vitest";
2
- import type { Effect, Layer, Scope } from "effect";
2
+ import type { Crypto, Effect, Layer, Scope } from "effect";
3
3
  import type { EffectClock, EffectTestOptions } from "@shivaedev/test/types.ts";
4
+ import { compose } from "#internal/compose.ts";
5
+ import { type ComposedKit, type Composition, type KitDefinition, type KitList, kitDefinition } from "#internal/compositionTypes.ts";
4
6
  import { type AnyEffect, type EffectHook, type ErrorOf, type Hook, type HookValue, hooked, type ServicesOf } from "#internal/hooked.ts";
5
7
  import type { AfterResults, InferredDefinition, LegacyDefinition } from "#internal/hookInference.ts";
6
8
  import type { LooseDefinition } from "#internal/seed.ts";
@@ -46,7 +48,7 @@ export interface StoryKitDefinition<
46
48
  TDiagnose extends AnyEffect,
47
49
  > {
48
50
  readonly after?: { readonly [TKey in keyof TAfter]: EffectHook<[engine: TEngine], TAfter[TKey] & AnyEffect, void> };
49
- readonly around?: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, unknown, R | NoInfer<TProvided> | Scope.Scope>;
51
+ readonly around?: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, unknown, R | NoInfer<TProvided> | Crypto.Crypto | Scope.Scope>;
50
52
  readonly clock?: EffectClock;
51
53
  readonly create: EffectHook<[], TCreate, TEngine>;
52
54
  readonly inspect?: (engine: TEngine) => unknown;
@@ -67,10 +69,10 @@ export type StoryBody<TEngine, TVerbs, TRun extends AnyEffect, TEffect extends A
67
69
  ) => Generator<TEffect, unknown, never> | undefined;
68
70
 
69
71
  export type StoryTest<TEngine, TStage extends string, TVerbs, TRun extends AnyEffect, TProvided> = <
70
- TEffect extends Needs<TProvided | Scope.Scope> = never,
72
+ TEffect extends Needs<TProvided | Crypto.Crypto | Scope.Scope> = never,
71
73
  >(
72
74
  name: string,
73
- given: readonly Trait<TEngine, TStage, TProvided | Scope.Scope>[],
75
+ given: readonly Trait<TEngine, TStage, TProvided | Crypto.Crypto | Scope.Scope>[],
74
76
  body?: StoryBody<TEngine, TVerbs, TRun, TEffect>,
75
77
  options?: number | EffectTestOptions,
76
78
  ) => void;
@@ -97,6 +99,7 @@ export interface StoryKit<TEngine, TStage extends string, TVerbs, TRun extends A
97
99
  readonly traits: <const TGiven extends readonly Trait<TEngine, TStage, unknown>[]>(
98
100
  ...given: TGiven
99
101
  ) => Trait<TEngine, TStage, TraitServices<TGiven[number]>>;
102
+ readonly [kitDefinition]: KitDefinition<TEngine, TStage, TVerbs, TRun, TProvided>;
100
103
  }
101
104
 
102
105
  export function storyKit<
@@ -125,8 +128,11 @@ export function storyKit<
125
128
  >(
126
129
  definition: LegacyDefinition<TEngine, TStage, TVerbs, TProvided, TCreate, TAfter, TStep, TFailed, TDiagnose>,
127
130
  ): StoryKit<TEngine, TStage, TVerbs, TStep | TFailed | TDiagnose, TProvided>;
128
- export function storyKit(definition: LooseDefinition): unknown {
131
+ export function storyKit<const TKits extends KitList>(definition: Composition<TKits>): ComposedKit<TKits>;
132
+ export function storyKit(input: LooseDefinition | Composition<KitList>): unknown {
133
+ const definition = "extends" in input ? compose(input.name, input.extends) : input;
129
134
  return {
135
+ [kitDefinition]: definition,
130
136
  it: storyIt(definition),
131
137
  trait: (stage: string, line: string, apply: EffectHook<[engine: unknown], AnyEffect, void>) =>
132
138
  trait(stage, line, (engine: unknown) => hooked(() => apply(engine))),