@jsenv/snapshot 2.3.3 → 2.4.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 (2) hide show
  1. package/package.json +1 -1
  2. package/src/function_side_effects/function_side_effects_snapshot.js +123 -93
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsenv/snapshot",
3
- "version": "2.3.3",
3
+ "version": "2.4.0",
4
4
  "description": "Snapshot testing",
5
5
  "license": "MIT",
6
6
  "author": {
package/src/function_side_effects/function_side_effects_snapshot.js CHANGED
@@ -15,19 +15,29 @@ import {
15
15
  import { spyConsoleCalls } from "./spy_console_calls.js";
16
16
  import { spyFilesystemCalls } from "./spy_filesystem_calls.js";
17
17
 
18
+ const filesystemEffectsDefault = {
19
+ outDirectory: null,
20
+ preserve: false,
21
+ };
22
+ const consoleEffectsDefault = {
23
+ prevent: true,
24
+ };
25
+
18
26
  export const snapshotFunctionSideEffects = (
19
27
  fn,
20
28
  fnFileUrl,
21
29
  sideEffectDirectoryRelativeUrl = "./",
22
30
  {
23
31
  rootDirectoryUrl = new URL("./", fnFileUrl),
24
- filesystemEffectsDirectory,
25
- preventConsoleSideEffects = true,
26
- undoFilesystemSideEffects = true,
32
+ consoleEffects = true,
33
+ filesystemEffects = true,
27
34
  } = {},
28
35
  ) => {
29
- if (filesystemEffectsDirectory === true) {
30
- filesystemEffectsDirectory = "./fs/";
36
+ if (consoleEffects === true) {
37
+ consoleEffects = {};
38
+ }
39
+ if (filesystemEffects === true) {
40
+ filesystemEffects = {};
31
41
  }
32
42
  const sideEffectDirectoryUrl = new URL(
33
43
  sideEffectDirectoryRelativeUrl,
@@ -40,103 +50,123 @@ export const snapshotFunctionSideEffects = (
40
50
  const sideEffectFileUrl = new URL(sideEffectFilename, sideEffectDirectoryUrl);
41
51
  const callbackSet = new Set();
42
52
  const sideEffectDetectors = [
43
- {
44
- name: "console",
45
- install: (addSideEffect) => {
46
- const onConsole = (methodName, message) => {
47
- addSideEffect({
48
- type: `console:${methodName}`,
49
- value: message,
50
- label: `console.${methodName}`,
51
- text: wrapIntoMarkdownBlock(
52
- replaceFluctuatingValues(message, {
53
- stringType: "console",
54
- rootDirectoryUrl,
55
- }),
56
- "console",
57
- ),
58
- });
59
- };
60
- const consoleSpy = spyConsoleCalls(
53
+ ...(consoleEffects
54
+ ? [
61
55
  {
62
- error: (message) => {
63
- onConsole("error", message);
64
- },
65
- warn: (message) => {
66
- onConsole("warn", message);
67
- },
68
- info: (message) => {
69
- onConsole("info", message);
70
- },
71
- log: (message) => {
72
- onConsole("log", message);
73
- },
74
- },
75
- {
76
- preventConsoleSideEffects,
77
- },
78
- );
79
- return () => {
80
- consoleSpy.restore();
81
- };
82
- },
83
- },
84
- {
85
- name: "filesystem",
86
- install: (addSideEffect) => {
87
- const fsSideEffectDirectoryUrl = ensurePathnameTrailingSlash(
88
- new URL(filesystemEffectsDirectory, sideEffectDirectoryUrl),
89
- );
90
- const fsSideEffectsDirectoryRelativeUrl = urlToRelativeUrl(
91
- fsSideEffectDirectoryUrl,
92
- sideEffectFileUrl,
93
- );
94
- const filesystemSpy = spyFilesystemCalls(
95
- {
96
- writeFile: (url, content) => {
97
- const relativeUrl = urlToRelativeUrl(url, fnFileUrl);
98
- const toUrl = new URL(relativeUrl, fsSideEffectDirectoryUrl);
99
- if (filesystemEffectsDirectory) {
100
- callbackSet.add(() => {
101
- writeFileSync(toUrl, content);
102
- });
103
- addSideEffect({
104
- type: "fs:write_file",
105
- value: { relativeUrl, content },
106
- label: `write file "${relativeUrl}" (see ./${fsSideEffectsDirectoryRelativeUrl}${relativeUrl})`,
107
- text: null,
108
- });
109
- } else {
56
+ name: "console",
57
+ install: (addSideEffect) => {
58
+ consoleEffects = { ...consoleEffectsDefault, ...consoleEffects };
59
+ const { prevent } = consoleEffects;
60
+ const onConsole = (methodName, message) => {
110
61
  addSideEffect({
111
- type: "fs:write_file",
112
- value: { relativeUrl, content },
113
- label: `write file "${relativeUrl}"`,
62
+ type: `console:${methodName}`,
63
+ value: message,
64
+ label: `console.${methodName}`,
114
65
  text: wrapIntoMarkdownBlock(
115
- content,
116
- urlToExtension(url).slice(1),
66
+ replaceFluctuatingValues(message, {
67
+ stringType: "console",
68
+ rootDirectoryUrl,
69
+ }),
70
+ "console",
117
71
  ),
118
72
  });
119
- }
120
- },
121
- writeDirectory: (url) => {
122
- const relativeUrl = urlToRelativeUrl(url, fnFileUrl);
123
- addSideEffect({
124
- type: "fs:write_directory",
125
- value: { relativeUrl },
126
- label: `write directory "${relativeUrl}"`,
127
- text: null,
128
- });
73
+ };
74
+ const consoleSpy = spyConsoleCalls(
75
+ {
76
+ error: (message) => {
77
+ onConsole("error", message);
78
+ },
79
+ warn: (message) => {
80
+ onConsole("warn", message);
81
+ },
82
+ info: (message) => {
83
+ onConsole("info", message);
84
+ },
85
+ log: (message) => {
86
+ onConsole("log", message);
87
+ },
88
+ },
89
+ {
90
+ preventConsoleSideEffects: prevent,
91
+ },
92
+ );
93
+ return () => {
94
+ consoleSpy.restore();
95
+ };
129
96
  },
130
97
  },
98
+ ]
99
+ : []),
100
+ ...(filesystemEffects
101
+ ? [
131
102
  {
132
- undoFilesystemSideEffects,
103
+ name: "filesystem",
104
+ install: (addSideEffect) => {
105
+ filesystemEffects = {
106
+ ...filesystemEffectsDefault,
107
+ ...filesystemEffects,
108
+ };
109
+ let writeFile;
110
+ const { preserve, outDirectory } = filesystemEffects;
111
+ if (outDirectory) {
112
+ const fsEffectsOutDirectoryUrl = ensurePathnameTrailingSlash(
113
+ new URL(outDirectory, sideEffectDirectoryUrl),
114
+ );
115
+ const fsEffectsOutDirectoryRelativeUrl = urlToRelativeUrl(
116
+ fsEffectsOutDirectoryUrl,
117
+ sideEffectFileUrl,
118
+ );
119
+ writeFile = (url, content) => {
120
+ const relativeUrl = urlToRelativeUrl(url, fnFileUrl);
121
+ const toUrl = new URL(relativeUrl, fsEffectsOutDirectoryUrl);
122
+ callbackSet.add(() => {
123
+ writeFileSync(toUrl, content);
124
+ });
125
+ addSideEffect({
126
+ type: "fs:write_file",
127
+ value: { relativeUrl, content },
128
+ label: `write file "${relativeUrl}" (see ./${fsEffectsOutDirectoryRelativeUrl}${relativeUrl})`,
129
+ text: null,
130
+ });
131
+ };
132
+ } else {
133
+ writeFile = (url, content) => {
134
+ const relativeUrl = urlToRelativeUrl(url, fnFileUrl);
135
+ addSideEffect({
136
+ type: "fs:write_file",
137
+ value: { relativeUrl, content },
138
+ label: `write file "${relativeUrl}"`,
139
+ text: wrapIntoMarkdownBlock(
140
+ content,
141
+ urlToExtension(url).slice(1),
142
+ ),
143
+ });
144
+ };
145
+ }
146
+ const filesystemSpy = spyFilesystemCalls(
147
+ {
148
+ writeFile,
149
+ writeDirectory: (url) => {
150
+ const relativeUrl = urlToRelativeUrl(url, fnFileUrl);
151
+ addSideEffect({
152
+ type: "fs:write_directory",
153
+ value: { relativeUrl },
154
+ label: `write directory "${relativeUrl}"`,
155
+ text: null,
156
+ });
157
+ },
158
+ },
159
+ {
160
+ undoFilesystemSideEffects: !preserve,
161
+ },
162
+ );
163
+ return () => {
164
+ filesystemSpy.restore();
165
+ };
166
+ },
133
167
  },
134
- );
135
- return () => {
136
- filesystemSpy.restore();
137
- };
138
- },
139
- },
168
+ ]
169
+ : []),
140
170
  ];
141
171
 
142
172
  const onSideEffectsCollected = (sideEffects) => {