author
int64
658
755k
date
stringlengths
19
19
timezone
int64
-46,800
43.2k
hash
stringlengths
40
40
message
stringlengths
5
490
mods
list
language
stringclasses
20 values
license
stringclasses
3 values
repo
stringlengths
5
68
original_message
stringlengths
12
491
699
19.12.2022 11:44:16
21,600
d336ce370c44485345b37aa2ec84a928c597e94b
Moves global dependency graph into config
[ { "change_type": "MODIFY", "old_path": "src/Engines/Custom.js", "new_path": "src/Engines/Custom.js", "diff": "const TemplateEngine = require(\"./TemplateEngine\");\nconst getJavaScriptData = require(\"../Util/GetJavaScriptData\");\n-const GlobalDependencyMap = require(\"../GlobalDependencyMap\");\nconst eventBus = require(\"../EventBus.js\");\n-let usesMap = new GlobalDependencyMap();\n-\nlet lastModifiedFile = undefined;\neventBus.on(\"eleventy.resourceModified\", (path) => {\nlastModifiedFile = path;\n@@ -14,8 +11,6 @@ class CustomEngine extends TemplateEngine {\nconstructor(name, dirs, config) {\nsuper(name, dirs, config);\n- usesMap.setConfig(config);\n-\nthis.entry = this.getExtensionMapEntry();\nthis.needsInit =\n\"init\" in this.entry && typeof this.entry.init === \"function\";\n@@ -200,7 +195,7 @@ class CustomEngine extends TemplateEngine {\nlet fn = this.entry.compile.bind({\nconfig: this.config,\naddDependencies: (from, toArray = []) => {\n- usesMap.addDependency(from, toArray);\n+ this.config.uses.addDependency(from, toArray);\n},\ndefaultRenderer, // bind defaultRenderer to compile function\n})(str, inputPath);\n@@ -229,14 +224,18 @@ class CustomEngine extends TemplateEngine {\n}\nhasDependencies(inputPath) {\n- if (usesMap.getDependencies(inputPath) === false) {\n+ if (this.config.uses.getDependencies(inputPath) === false) {\nreturn false;\n}\nreturn true;\n}\nisFileRelevantTo(inputPath, comparisonFile, includeLayouts) {\n- return usesMap.isFileRelevantTo(inputPath, comparisonFile, includeLayouts);\n+ return this.config.uses.isFileRelevantTo(\n+ inputPath,\n+ comparisonFile,\n+ includeLayouts\n+ );\n}\ngetCompileCacheKey(str, inputPath) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateConfig.js", "new_path": "src/TemplateConfig.js", "diff": "const fs = require(\"fs\");\nconst chalk = require(\"kleur\");\nconst { TemplatePath } = require(\"@11ty/eleventy-utils\");\n+\nconst EleventyBaseError = require(\"./EleventyBaseError.js\");\nconst UserConfig = require(\"./UserConfig.js\");\n+const GlobalDependencyMap = require(\"./GlobalDependencyMap.js\");\n+\nconst { EleventyRequire } = require(\"./Util/Require.js\");\nconst merge = require(\"./Util/Merge.js\");\nconst unique = require(\"./Util/Unique\");\n@@ -81,6 +84,8 @@ class TemplateConfig {\nthis.initializeRootConfig();\nthis.hasConfigMerged = false;\n+\n+ this.usesGraph = new GlobalDependencyMap();\n}\n/* Setter for Logger */\n@@ -411,8 +416,25 @@ class TemplateConfig {\nmergedConfig.templateFormats = templateFormats;\ndebug(\"Current configuration: %o\", mergedConfig);\n+\n+ this.afterConfigMergeActions(mergedConfig);\n+\nreturn mergedConfig;\n}\n+\n+ afterConfigMergeActions(eleventyConfig) {\n+ // this is used for the layouts event\n+ this.usesGraph.setConfig(eleventyConfig);\n+ }\n+\n+ get uses() {\n+ if (!this.usesGraph) {\n+ throw new Error(\n+ \"The Eleventy Global Dependency Graph has not yet been initialized.\"\n+ );\n+ }\n+ return this.usesGraph;\n+ }\n}\nmodule.exports = TemplateConfig;\n" } ]
JavaScript
MIT License
11ty/eleventy
Moves global dependency graph into config
699
19.12.2022 13:54:16
21,600
423e1051fde3765398b147f2d87b3006e6bab153
Refactor makes built-in template languages incremental and template aware using global dependency graph
[ { "change_type": "MODIFY", "old_path": "package.json", "new_path": "package.json", "diff": "{\n\"name\": \"@11ty/eleventy\",\n- \"version\": \"2.0.0-canary.20\",\n+ \"version\": \"2.0.0-canary.21\",\n\"description\": \"Transform a directory of templates into HTML.\",\n\"publishConfig\": {\n\"access\": \"public\"\n" }, { "change_type": "MODIFY", "old_path": "src/Engines/TemplateEngine.js", "new_path": "src/Engines/TemplateEngine.js", "diff": "@@ -256,12 +256,15 @@ class TemplateEngine {\nreturn false;\n}\n- isFileRelevantTo() {\n- return undefined;\n+ hasDependencies(inputPath) {\n+ if (this.config.uses.getDependencies(inputPath) === false) {\n+ return false;\n+ }\n+ return true;\n}\n- hasDependencies() {\n- return false;\n+ isFileRelevantTo(inputPath, comparisonFile) {\n+ return this.config.uses.isFileRelevantTo(inputPath, comparisonFile);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "@@ -28,7 +28,6 @@ class GlobalDependencyMap {\n// These have leading dot slashes, but so do the paths from Eleventy\nthis.config.events.once(\"eleventy.layouts\", (layouts) => {\n- // TODO cleanup loose ends here\nthis.addLayoutsToMap(layouts);\n});\n}\n@@ -143,7 +142,8 @@ class GlobalDependencyMap {\n// node arguments are already normalized\n_addDependency(from, toArray = []) {\n- // TODO clear out irrelevant old relationships, note that this is called for both layouts and by Custom compile->addDependencies\n+ // TODO clear out irrelevant old relationships\n+ // note that this is called for both layouts and by Custom compile->addDependencies\nthis.map.addNode(from);\n@@ -172,18 +172,17 @@ class GlobalDependencyMap {\nreturn `${GlobalDependencyMap.COLLECTION_KEY}:${entry}`;\n}\n- addDependencyConsumesCollection(from, collectionNames = []) {\n- this._addDependency(\n- this.normalizeNode(from),\n- collectionNames.map((name) => this.getCollectionKey(name))\n- );\n+ addDependencyConsumesCollection(from, collectionName) {\n+ this._addDependency(this.normalizeNode(from), [\n+ this.getCollectionKey(collectionName),\n+ ]);\n}\n- addDependencyPublishesToCollection(from, collectionNames = []) {\n+ addDependencyPublishesToCollection(from, collectionName) {\nlet normalizedFrom = this.normalizeNode(from);\n- for (let name of collectionNames) {\n- this._addDependency(this.getCollectionKey(name), normalizedFrom);\n- }\n+ this._addDependency(this.getCollectionKey(collectionName), [\n+ normalizedFrom,\n+ ]);\n}\n// Layouts are not relevant to compile cache and can be ignored\n@@ -208,6 +207,7 @@ class GlobalDependencyMap {\nif (!comparisonFile) {\nreturn false;\n}\n+\n// The file that changed is the relevant file\nif (fullTemplateInputPath === comparisonFile) {\nreturn true;\n" }, { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -108,9 +108,18 @@ class Template extends TemplateContent {\nthis.logger.isVerbose = isVerbose;\n}\n+ setDryRunViaIncremental(isDryRun) {\n+ this.setDryRun(isDryRun, true);\n+ }\n+\nsetDryRun(isDryRun, viaIncremental = false) {\nthis.isDryRun = !!isDryRun;\n+\n+ if (this.isDryRun && viaIncremental) {\nthis.isDryRunViaIncremental = viaIncremental;\n+ } else {\n+ this.isDryRunViaIncremental = false;\n+ }\n}\nsetExtraOutputSubdirectory(dir) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateConfig.js", "new_path": "src/TemplateConfig.js", "diff": "@@ -423,6 +423,9 @@ class TemplateConfig {\n}\nafterConfigMergeActions(eleventyConfig) {\n+ // Add to the merged config too\n+ eleventyConfig.uses = this.usesGraph;\n+\n// this is used for the layouts event\nthis.usesGraph.setConfig(eleventyConfig);\n}\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateContent.js", "new_path": "src/TemplateContent.js", "diff": "@@ -520,17 +520,11 @@ class TemplateContent {\nlet hasDependencies = this.engine.hasDependencies(this.inputPath);\n- let isEleventyTemplateMapRelevant = metadata.isTemplateMapRelevant;\n- let isEngineRelevant = this.engine.isFileRelevantTo(\n+ let isRelevant = this.engine.isFileRelevantTo(\nthis.inputPath,\nincrementalFile\n);\n- // isEngineRelevant is undefined for the built-in syntaxes\n- let isRelevant =\n- isEngineRelevant === undefined\n- ? isEleventyTemplateMapRelevant\n- : isEleventyTemplateMapRelevant || isEngineRelevant;\ndebug(\n\"Test dependencies to see if %o is relevant to %o: %o\",\nthis.inputPath,\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -326,22 +326,42 @@ class TemplateMap {\n);\n}\n- isFileRelevantTo(templateMapDependencyGraph, file, comparedTo) {\n- if (file === comparedTo) {\n- return true;\n+ // Similar to getTemplateMapDependencyGraph but adds those relationships to the global dependency graph used for incremental builds\n+ addToGlobalDependencyGraph() {\n+ for (let entry of this.map) {\n+ let paginationTagTarget = this.getPaginationTagTarget(entry);\n+ if (paginationTagTarget) {\n+ this.config.uses.addDependencyConsumesCollection(\n+ entry.inputPath,\n+ paginationTagTarget\n+ );\n}\n- // compare in all four graphs\n- for (let graph of templateMapDependencyGraph) {\n- if (!graph.hasNode(file)) {\n- continue;\n+ if (!entry.data.eleventyExcludeFromCollections) {\n+ this.config.uses.addDependencyPublishesToCollection(\n+ entry.inputPath,\n+ \"all\"\n+ );\n}\n- if (graph.dependenciesOf(file).includes(comparedTo)) {\n- return true;\n+ if (Array.isArray(entry.data.tags)) {\n+ for (let tag of entry.data.tags) {\n+ this.config.uses.addDependencyPublishesToCollection(\n+ entry.inputPath,\n+ tag\n+ );\n+ }\n+ }\n+\n+ if (Array.isArray(entry.data.eleventyImportCollections)) {\n+ for (let tag of entry.data.eleventyImportCollections) {\n+ this.config.uses.addDependencyConsumesCollection(\n+ entry.inputPath,\n+ tag\n+ );\n+ }\n}\n}\n- return false;\n}\nasync setCollectionByTagName(tagName) {\n" } ]
JavaScript
MIT License
11ty/eleventy
Refactor makes built-in template languages incremental and template aware using global dependency graph
699
19.12.2022 14:59:23
21,600
cadc546260201fce55f308278d09a9be733af23b
Rename to eleventyImport.collections to prepare for future imports
[ { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -175,7 +175,7 @@ class TemplateMap {\nthis.addDeclaredDependenciesToGraph(\ngraph,\nentry.inputPath,\n- entry.data.eleventyImportCollections\n+ entry.data.eleventyImport?.collections\n);\n}\n@@ -222,7 +222,7 @@ class TemplateMap {\nthis.addDeclaredDependenciesToGraph(\ngraph,\nentry.inputPath,\n- entry.data.eleventyImportCollections\n+ entry.data.eleventyImport?.collections\n);\n}\n}\n@@ -262,7 +262,7 @@ class TemplateMap {\nthis.addDeclaredDependenciesToGraph(\ngraph,\nentry.inputPath,\n- entry.data.eleventyImportCollections\n+ entry.data.eleventyImport?.collections\n);\n}\n}\n@@ -302,7 +302,7 @@ class TemplateMap {\nthis.addDeclaredDependenciesToGraph(\ngraph,\nentry.inputPath,\n- entry.data.eleventyImportCollections\n+ entry.data.eleventyImport?.collections\n);\n}\n}\n@@ -353,8 +353,8 @@ class TemplateMap {\n}\n}\n- if (Array.isArray(entry.data.eleventyImportCollections)) {\n- for (let tag of entry.data.eleventyImportCollections) {\n+ if (Array.isArray(entry.data.eleventyImport?.collections)) {\n+ for (let tag of entry.data.eleventyImport.collections) {\nthis.config.uses.addDependencyConsumesCollection(\nentry.inputPath,\ntag\n" } ]
JavaScript
MIT License
11ty/eleventy
Rename to eleventyImport.collections to prepare for future imports
699
19.12.2022 17:22:04
21,600
b98e7dbc183bd5197940ee70fe77abcc2739917e
Status commit for more improvements to incremental
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "const { DepGraph } = require(\"dependency-graph\");\nconst { TemplatePath } = require(\"@11ty/eleventy-utils\");\n-const PathNormalizer = require(\"./Util/PathNormalizer\");\n+const PathNormalizer = require(\"./Util/PathNormalizer.js\");\nconst eventBus = require(\"./EventBus.js\");\n-// TODO extend this to built-in template types, this is only used by Custom templates for now\n-\nclass GlobalDependencyMap {\n+ // dependency-graph requires these keys to be alphabetic strings\n+ static LAYOUT_KEY = \"layout\";\n+ static COLLECTION_KEY = \"__collection:\";\n+\n// URL object with a windows, with file:// already removed (from file:///C:/directory/ to /C:/directory/)\nstatic WINDOWS_DRIVE_URL_PATH = /^\\/\\w\\:\\//;\n- static LAYOUT_KEY = \"layout\";\n- static COLLECTION_KEY = \"collection\";\n-\nconstructor() {\neventBus.on(\"eleventy.compileCacheReset\", () => {\nthis._map = undefined;\n@@ -39,6 +38,7 @@ class GlobalDependencyMap {\nif (!data || !data.type || data.type !== GlobalDependencyMap.LAYOUT_KEY) {\ncontinue;\n}\n+\nthis.map.removeNode(node);\n}\n}\n@@ -105,19 +105,69 @@ class GlobalDependencyMap {\n);\n}\n- delete(node) {\n+ getRelationships(node) {\n+ let relationships = {\n+ dependants: new Set(),\n+ dependencies: new Set(),\n+ };\n+\n+ if (!node) {\n+ return relationships;\n+ }\n+\nnode = this.normalizeNode(node);\n- if (this.map.hasNode(node)) {\n- this.map.removeNode(node);\n+ if (!this.map.hasNode(node)) {\n+ return relationships;\n}\n+\n+ // Direct dependants and dependencies, both publish and consume from collections\n+ relationships.dependants = new Set(\n+ this.map\n+ .directDependantsOf(node)\n+ .map((entry) => GlobalDependencyMap.getEntryFromCollectionKey(entry))\n+ );\n+ relationships.dependencies = new Set(\n+ this.map\n+ .directDependenciesOf(node)\n+ .map((entry) => GlobalDependencyMap.getEntryFromCollectionKey(entry))\n+ );\n+\n+ return relationships;\n+ }\n+\n+ resetNode(node) {\n+ node = this.normalizeNode(node);\n+\n+ if (!this.map.hasNode(node)) {\n+ return;\n+ }\n+\n+ for (let dep of this.map.directDependantsOf(node)) {\n+ this.map.removeDependency(dep, node);\n+ }\n+ for (let dep of this.map.directDependenciesOf(node)) {\n+ this.map.removeDependency(node, dep);\n+ }\n+ }\n+\n+ getTemplatesThatConsumeCollections(collectionNames) {\n+ let templates = new Set();\n+ for (let name of collectionNames) {\n+ for (let node of this.map.dependantsOf(\n+ GlobalDependencyMap.getCollectionKeyForEntry(name)\n+ )) {\n+ if (!node.startsWith(GlobalDependencyMap.COLLECTION_KEY)) {\n+ templates.add(node);\n+ }\n+ }\n+ }\n+ return Array.from(templates);\n}\n// Layouts are not relevant to compile cache and can be ignored\ngetDependencies(node, includeLayouts = true) {\nnode = this.normalizeNode(node);\n- // console.log( node, this.map.overallOrder() );\n- // console.log( node, this.map.size(), this.map.dependenciesOf(node), this.map.dependantsOf(node) );\n// `false` means the Node was unknown\nif (!this.map.hasNode(node)) {\n@@ -142,9 +192,6 @@ class GlobalDependencyMap {\n// node arguments are already normalized\n_addDependency(from, toArray = []) {\n- // TODO clear out irrelevant old relationships\n- // note that this is called for both layouts and by Custom compile->addDependencies\n-\nthis.map.addNode(from);\nif (!Array.isArray(toArray)) {\n@@ -168,21 +215,26 @@ class GlobalDependencyMap {\n);\n}\n- getCollectionKey(entry) {\n- return `${GlobalDependencyMap.COLLECTION_KEY}:${entry}`;\n+ static getEntryFromCollectionKey(entry) {\n+ return entry.slice(GlobalDependencyMap.COLLECTION_KEY.length);\n+ }\n+\n+ static getCollectionKeyForEntry(entry) {\n+ return `${GlobalDependencyMap.COLLECTION_KEY}${entry}`;\n}\naddDependencyConsumesCollection(from, collectionName) {\nthis._addDependency(this.normalizeNode(from), [\n- this.getCollectionKey(collectionName),\n+ GlobalDependencyMap.getCollectionKeyForEntry(collectionName),\n]);\n}\naddDependencyPublishesToCollection(from, collectionName) {\nlet normalizedFrom = this.normalizeNode(from);\n- this._addDependency(this.getCollectionKey(collectionName), [\n- normalizedFrom,\n- ]);\n+ this._addDependency(\n+ GlobalDependencyMap.getCollectionKeyForEntry(collectionName),\n+ [normalizedFrom]\n+ );\n}\n// Layouts are not relevant to compile cache and can be ignored\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -3,12 +3,14 @@ const { isPlainObject } = require(\"@11ty/eleventy-utils\");\nconst TemplateCollection = require(\"./TemplateCollection\");\nconst EleventyErrorUtil = require(\"./EleventyErrorUtil\");\n+const GlobalDependencyMap = require(\"./GlobalDependencyMap\");\n+\nconst UsingCircularTemplateContentReferenceError = require(\"./Errors/UsingCircularTemplateContentReferenceError\");\n+const EleventyBaseError = require(\"./EleventyBaseError\");\n+\nconst debug = require(\"debug\")(\"Eleventy:TemplateMap\");\nconst debugDev = require(\"debug\")(\"Dev:Eleventy:TemplateMap\");\n-const EleventyBaseError = require(\"./EleventyBaseError\");\n-\nclass TemplateMapConfigError extends EleventyBaseError {}\nclass DuplicatePermalinkOutputError extends EleventyBaseError {\n@@ -326,6 +328,68 @@ class TemplateMap {\n);\n}\n+ setupDependencyGraphChanges(incrementalFile) {\n+ // Delete incremental from the dependency graph so we get fresh entries!\n+ // This _must_ happen before any additions, the other ones are in Custom.js and GlobalDependencyMap.js (from the eleventy.layouts Event)\n+ let deleted = {\n+ // TODO dependencies might be the only relevant things here\n+ dependencies: new Set(),\n+ dependants: new Set(),\n+ };\n+\n+ if (!incrementalFile) {\n+ return deleted;\n+ }\n+\n+ // New relationships\n+ let dependencies = new Set(); // collections consumed\n+ let dependants = new Set(); // collections published to\n+\n+ for (let entry of this.map) {\n+ let paginationTagTarget = this.getPaginationTagTarget(entry);\n+ if (paginationTagTarget) {\n+ dependencies.add(paginationTagTarget);\n+ }\n+\n+ if (!entry.data.eleventyExcludeFromCollections) {\n+ dependants.add(\"all\");\n+\n+ if (Array.isArray(entry.data.tags)) {\n+ for (let tag of entry.data.tags) {\n+ dependants.add(tag);\n+ }\n+ }\n+ }\n+\n+ if (Array.isArray(entry.data.eleventyImport?.collections)) {\n+ for (let tag of entry.data.eleventyImport.collections) {\n+ dependencies.add(tag);\n+ }\n+ }\n+ }\n+\n+ // Old relationships\n+ let relationships = this.config.uses.getRelationships(incrementalFile);\n+\n+ for (let dep of relationships.dependencies) {\n+ if (!dependencies.has(dep)) {\n+ deleted.dependencies.add(dep);\n+ }\n+ }\n+ for (let dep of relationships.dependants) {\n+ if (!dependants.has(dep)) {\n+ deleted.dependants.add(dep);\n+ }\n+ }\n+\n+ // Actually delete the relationships\n+ this.config.uses.resetNode(incrementalFile);\n+\n+ return this.config.uses.getTemplatesThatConsumeCollections(\n+ deleted.dependants\n+ );\n+ }\n+\n// Similar to getTemplateMapDependencyGraph but adds those relationships to the global dependency graph used for incremental builds\naddToGlobalDependencyGraph() {\nfor (let entry of this.map) {\n@@ -342,7 +406,6 @@ class TemplateMap {\nentry.inputPath,\n\"all\"\n);\n- }\nif (Array.isArray(entry.data.tags)) {\nfor (let tag of entry.data.tags) {\n@@ -352,6 +415,7 @@ class TemplateMap {\n);\n}\n}\n+ }\nif (Array.isArray(entry.data.eleventyImport?.collections)) {\nfor (let tag of entry.data.eleventyImport.collections) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -216,6 +216,24 @@ class TemplateWriter {\nthis.incrementalFile\n);\n+ let relevantToDeletions = [];\n+ // Update the data cascade and the global dependency map for the one incremental template before everything else (only full templates)\n+ if (isFullTemplate && this.incrementalFile) {\n+ let path = this.incrementalFile;\n+ let tmpl = this._createTemplate(path, to);\n+ let p = this.templateMap.add(tmpl);\n+ promises.push(p);\n+ await p;\n+ debug(`${path} adding to template map.`);\n+\n+ // establish new relationships for this one template\n+ relevantToDeletions = this.templateMap.setupDependencyGraphChanges(\n+ tmpl.inputPath\n+ );\n+\n+ this.templateMap.addToGlobalDependencyGraph();\n+ }\n+\nlet isPassthroughCopy = this._isIncrementalFileAPassthroughCopy(paths);\nfor (let path of paths) {\n@@ -228,7 +246,17 @@ class TemplateWriter {\ncontinue;\n}\n+ // We already updated the data cascade for this template above\n+ if (isFullTemplate && this.incrementalFile === tmpl.inputPath) {\n+ continue;\n+ }\n+\n+ let isTemplateRelevantToDeletedCollections =\n+ relevantToDeletions.includes(\n+ TemplatePath.stripLeadingDotSlash(tmpl.inputPath)\n+ );\nif (\n+ isTemplateRelevantToDeletedCollections ||\ntmpl.isFileRelevantToThisTemplate(this.incrementalFile, {\nisFullTemplate,\n})\n@@ -252,7 +280,7 @@ class TemplateWriter {\nawait this._addToTemplateMap(paths, to);\n- // write template relationships to the global dependency graph for next time\n+ // write new template relationships to the global dependency graph for next time\nthis.templateMap.addToGlobalDependencyGraph();\nawait this.templateMap.cache();\n" } ]
JavaScript
MIT License
11ty/eleventy
Status commit for more improvements to incremental
699
19.12.2022 17:25:48
21,600
8781061449118bd1c1b15bfb71e0e0b268320428
A bit of simplification for last incremental commit.
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "@@ -162,7 +162,7 @@ class GlobalDependencyMap {\n}\n}\n}\n- return Array.from(templates);\n+ return templates;\n}\n// Layouts are not relevant to compile cache and can be ignored\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -332,8 +332,6 @@ class TemplateMap {\n// Delete incremental from the dependency graph so we get fresh entries!\n// This _must_ happen before any additions, the other ones are in Custom.js and GlobalDependencyMap.js (from the eleventy.layouts Event)\nlet deleted = {\n- // TODO dependencies might be the only relevant things here\n- dependencies: new Set(),\ndependants: new Set(),\n};\n@@ -342,15 +340,8 @@ class TemplateMap {\n}\n// New relationships\n- let dependencies = new Set(); // collections consumed\nlet dependants = new Set(); // collections published to\n-\nfor (let entry of this.map) {\n- let paginationTagTarget = this.getPaginationTagTarget(entry);\n- if (paginationTagTarget) {\n- dependencies.add(paginationTagTarget);\n- }\n-\nif (!entry.data.eleventyExcludeFromCollections) {\ndependants.add(\"all\");\n@@ -360,22 +351,11 @@ class TemplateMap {\n}\n}\n}\n-\n- if (Array.isArray(entry.data.eleventyImport?.collections)) {\n- for (let tag of entry.data.eleventyImport.collections) {\n- dependencies.add(tag);\n- }\n- }\n}\n// Old relationships\nlet relationships = this.config.uses.getRelationships(incrementalFile);\n- for (let dep of relationships.dependencies) {\n- if (!dependencies.has(dep)) {\n- deleted.dependencies.add(dep);\n- }\n- }\nfor (let dep of relationships.dependants) {\nif (!dependants.has(dep)) {\ndeleted.dependants.add(dep);\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -216,7 +216,7 @@ class TemplateWriter {\nthis.incrementalFile\n);\n- let relevantToDeletions = [];\n+ let relevantToDeletions = new Set();\n// Update the data cascade and the global dependency map for the one incremental template before everything else (only full templates)\nif (isFullTemplate && this.incrementalFile) {\nlet path = this.incrementalFile;\n@@ -251,8 +251,7 @@ class TemplateWriter {\ncontinue;\n}\n- let isTemplateRelevantToDeletedCollections =\n- relevantToDeletions.includes(\n+ let isTemplateRelevantToDeletedCollections = relevantToDeletions.has(\nTemplatePath.stripLeadingDotSlash(tmpl.inputPath)\n);\nif (\n" } ]
JavaScript
MIT License
11ty/eleventy
A bit of simplification for last incremental commit.
699
20.12.2022 09:04:09
21,600
a9f348c785be31db2531de393ab6ffb315358146
Code cleanup for deleted from collections for incremental builds
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "@@ -7,7 +7,7 @@ const eventBus = require(\"./EventBus.js\");\nclass GlobalDependencyMap {\n// dependency-graph requires these keys to be alphabetic strings\nstatic LAYOUT_KEY = \"layout\";\n- static COLLECTION_KEY = \"__collection:\";\n+ static COLLECTION_PREFIX = \"__collection:\";\n// URL object with a windows, with file:// already removed (from file:///C:/directory/ to /C:/directory/)\nstatic WINDOWS_DRIVE_URL_PATH = /^\\/\\w\\:\\//;\n@@ -105,35 +105,38 @@ class GlobalDependencyMap {\n);\n}\n- getRelationships(node) {\n- let relationships = {\n- dependants: new Set(),\n- dependencies: new Set(),\n- };\n-\n+ getDependantsFor(node) {\nif (!node) {\n- return relationships;\n+ return new Set();\n}\nnode = this.normalizeNode(node);\nif (!this.map.hasNode(node)) {\n- return relationships;\n+ return new Set();\n}\n// Direct dependants and dependencies, both publish and consume from collections\n- relationships.dependants = new Set(\n- this.map\n- .directDependantsOf(node)\n- .map((entry) => GlobalDependencyMap.getEntryFromCollectionKey(entry))\n- );\n- relationships.dependencies = new Set(\n- this.map\n- .directDependenciesOf(node)\n- .map((entry) => GlobalDependencyMap.getEntryFromCollectionKey(entry))\n- );\n+ return this.map.directDependantsOf(node);\n+ }\n+\n+ findCollectionsRemovedFrom(node, collectionNames) {\n+ let prevDeps = this.getDependantsFor(node).map((entry) => {\n+ if (entry.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\n+ return GlobalDependencyMap.getEntryFromCollectionKey(entry);\n+ }\n+ return entry;\n+ });\n+\n+ let prevDepsSet = new Set(prevDeps);\n+ let deleted = new Set();\n+ for (let dep of prevDepsSet) {\n+ if (!collectionNames.has(dep)) {\n+ deleted.add(dep);\n+ }\n+ }\n- return relationships;\n+ return deleted;\n}\nresetNode(node) {\n@@ -157,7 +160,7 @@ class GlobalDependencyMap {\nfor (let node of this.map.dependantsOf(\nGlobalDependencyMap.getCollectionKeyForEntry(name)\n)) {\n- if (!node.startsWith(GlobalDependencyMap.COLLECTION_KEY)) {\n+ if (!node.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\ntemplates.add(node);\n}\n}\n@@ -216,11 +219,11 @@ class GlobalDependencyMap {\n}\nstatic getEntryFromCollectionKey(entry) {\n- return entry.slice(GlobalDependencyMap.COLLECTION_KEY.length);\n+ return entry.slice(GlobalDependencyMap.COLLECTION_PREFIX.length);\n}\nstatic getCollectionKeyForEntry(entry) {\n- return `${GlobalDependencyMap.COLLECTION_KEY}${entry}`;\n+ return `${GlobalDependencyMap.COLLECTION_PREFIX}${entry}`;\n}\naddDependencyConsumesCollection(from, collectionName) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -329,44 +329,35 @@ class TemplateMap {\n}\nsetupDependencyGraphChanges(incrementalFile) {\n- // Delete incremental from the dependency graph so we get fresh entries!\n- // This _must_ happen before any additions, the other ones are in Custom.js and GlobalDependencyMap.js (from the eleventy.layouts Event)\n- let deleted = {\n- dependants: new Set(),\n- };\n-\nif (!incrementalFile) {\n- return deleted;\n+ return new Set();\n}\n- // New relationships\n- let dependants = new Set(); // collections published to\n+ // Only dependents: things that consume templates that have deleted dependencies, e.g. if index.md consumes collections.post and a file removes its post tag, regenerate index.md\n+ let newCollectionNames = new Set(); // collections published to\nfor (let entry of this.map) {\nif (!entry.data.eleventyExcludeFromCollections) {\n- dependants.add(\"all\");\n+ newCollectionNames.add(\"all\");\nif (Array.isArray(entry.data.tags)) {\nfor (let tag of entry.data.tags) {\n- dependants.add(tag);\n+ newCollectionNames.add(tag);\n}\n}\n}\n}\n- // Old relationships\n- let relationships = this.config.uses.getRelationships(incrementalFile);\n-\n- for (let dep of relationships.dependants) {\n- if (!dependants.has(dep)) {\n- deleted.dependants.add(dep);\n- }\n- }\n+ let deletedCollectionNames = this.config.uses.findCollectionsRemovedFrom(\n+ incrementalFile,\n+ newCollectionNames\n+ );\n- // Actually delete the relationships\n+ // Delete incremental from the dependency graph so we get fresh entries!\n+ // This _must_ happen before any additions, the other ones are in Custom.js and GlobalDependencyMap.js (from the eleventy.layouts Event)\nthis.config.uses.resetNode(incrementalFile);\nreturn this.config.uses.getTemplatesThatConsumeCollections(\n- deleted.dependants\n+ deletedCollectionNames\n);\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Code cleanup for deleted from collections for incremental builds
699
20.12.2022 09:14:48
21,600
38b1617bf057d816035e23beedfbaefcf069b535
naming clarity
[ { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -328,7 +328,7 @@ class TemplateMap {\n);\n}\n- setupDependencyGraphChanges(incrementalFile) {\n+ setupDependencyGraphChangesForIncrementalFile(incrementalFile) {\nif (!incrementalFile) {\nreturn new Set();\n}\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -217,6 +217,7 @@ class TemplateWriter {\n);\nlet relevantToDeletions = new Set();\n+\n// Update the data cascade and the global dependency map for the one incremental template before everything else (only full templates)\nif (isFullTemplate && this.incrementalFile) {\nlet path = this.incrementalFile;\n@@ -226,8 +227,9 @@ class TemplateWriter {\nawait p;\ndebug(`${path} adding to template map.`);\n- // establish new relationships for this one template\n- relevantToDeletions = this.templateMap.setupDependencyGraphChanges(\n+ // establish new relationships for this template\n+ relevantToDeletions =\n+ this.templateMap.setupDependencyGraphChangesForIncrementalFile(\ntmpl.inputPath\n);\n" } ]
JavaScript
MIT License
11ty/eleventy
naming clarity
699
20.12.2022 17:09:54
21,600
0435c8d79229269a37bd6bee6a500fd5c53948e0
Re-use FileSystemSearch during serve/watch
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -180,6 +180,9 @@ class Eleventy {\nthis.watchTargets = new EleventyWatchTargets();\nthis.watchTargets.addAndMakeGlob(this.config.additionalWatchTargets);\nthis.watchTargets.watchJavaScriptDependencies = this.config.watchJavaScriptDependencies;\n+\n+ /** @member {Object} - tbd. */\n+ this.fileSystemSearch = new FileSystemSearch();\n}\ngetNewTimestamp() {\n@@ -374,8 +377,6 @@ class Eleventy {\n// eleventyServe is always available, even when not in --serve mode\nthis.eleventyServe.setOutputDir(this.outputDir);\n- this.fileSystemSearch = new FileSystemSearch();\n-\nthis.eleventyFiles = new EleventyFiles(\nthis.inputDir,\nthis.outputDir,\n" } ]
JavaScript
MIT License
11ty/eleventy
Re-use FileSystemSearch during serve/watch
699
21.12.2022 10:55:10
21,600
8132a95ef7f4a40905226bb6af48af16d12cf9df
Better compile cache management for incremental
[ { "change_type": "MODIFY", "old_path": "src/TemplateContent.js", "new_path": "src/TemplateContent.js", "diff": "@@ -177,7 +177,7 @@ class TemplateContent {\nreturn this._inputCache.get(TemplatePath.absolutePath(path));\n}\n- static deleteCached(path) {\n+ static deleteFromInputCache(path) {\nthis._inputCache.delete(TemplatePath.absolutePath(path));\n}\n@@ -290,10 +290,7 @@ class TemplateContent {\nthis.bench.get(\"(count) Template Compile Cache Miss\").incrementCount();\n- // Previously the cache grew when the content changes, in 2.0.0-canary.19\n- // we now segment caches based on inputPath so we also clear all other cache\n- // entries for this inputPath\n- cache.clear();\n+ // Compile cache is cleared when the resource is modified (below)\n// Compilation is async, so we eagerly cache a Promise that eventually\n// resolves to the compiled function\n@@ -550,7 +547,15 @@ class TemplateContent {\nTemplateContent._inputCache = new Map();\nTemplateContent._compileCache = new Map();\neventBus.on(\"eleventy.resourceModified\", (path) => {\n- TemplateContent.deleteCached(path);\n+ // delete from input cache\n+ TemplateContent.deleteFromInputCache(path);\n+\n+ // delete form compile cache\n+ let normalized = TemplatePath.addLeadingDotSlash(path);\n+ let compileCache = TemplateContent._compileCache.get(normalized);\n+ if (compileCache) {\n+ compileCache.clear();\n+ }\n});\n// Used when the configuration file reset https://github.com/11ty/eleventy/issues/2147\n" } ]
JavaScript
MIT License
11ty/eleventy
Better compile cache management for incremental
699
21.12.2022 14:20:09
21,600
516f49e8565f7f5afa8f1ff8cac29995395646ef
Stringify and restore dependency map, part of
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "@@ -72,6 +72,10 @@ class GlobalDependencyMap {\nreturn this._map;\n}\n+ set map(graph) {\n+ this._map = graph;\n+ }\n+\nnormalizeNode(node) {\nif (!node) {\nreturn;\n@@ -92,9 +96,7 @@ class GlobalDependencyMap {\n}\nif (typeof node !== \"string\") {\n- throw new Error(\n- \"`addDependencies` files must be strings. Received:\" + node\n- );\n+ throw new Error(\"`addDependencies` files must be strings. Received:\" + node);\n}\n// Paths should not be absolute (we convert absolute paths to relative)\n@@ -120,7 +122,15 @@ class GlobalDependencyMap {\nreturn this.map.directDependantsOf(node);\n}\n+ hasNode(node) {\n+ return this.map.hasNode(this.normalizeNode(node));\n+ }\n+\nfindCollectionsRemovedFrom(node, collectionNames) {\n+ if (!this.hasNode(node)) {\n+ return new Set();\n+ }\n+\nlet prevDeps = this.getDependantsFor(node).map((entry) => {\nif (entry.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\nreturn GlobalDependencyMap.getEntryFromCollectionKey(entry);\n@@ -157,9 +167,7 @@ class GlobalDependencyMap {\ngetTemplatesThatConsumeCollections(collectionNames) {\nlet templates = new Set();\nfor (let name of collectionNames) {\n- for (let node of this.map.dependantsOf(\n- GlobalDependencyMap.getCollectionKeyForEntry(name)\n- )) {\n+ for (let node of this.map.dependantsOf(GlobalDependencyMap.getCollectionKeyForEntry(name))) {\nif (!node.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\ntemplates.add(node);\n}\n@@ -234,10 +242,9 @@ class GlobalDependencyMap {\naddDependencyPublishesToCollection(from, collectionName) {\nlet normalizedFrom = this.normalizeNode(from);\n- this._addDependency(\n- GlobalDependencyMap.getCollectionKeyForEntry(collectionName),\n- [normalizedFrom]\n- );\n+ this._addDependency(GlobalDependencyMap.getCollectionKeyForEntry(collectionName), [\n+ normalizedFrom,\n+ ]);\n}\n// Layouts are not relevant to compile cache and can be ignored\n@@ -269,14 +276,27 @@ class GlobalDependencyMap {\n}\n// The file that changed is a dependency of the template\n- if (\n- this.hasDependency(fullTemplateInputPath, comparisonFile, includeLayouts)\n- ) {\n+ if (this.hasDependency(fullTemplateInputPath, comparisonFile, includeLayouts)) {\nreturn true;\n}\nreturn false;\n}\n+\n+ stringify() {\n+ return JSON.stringify(this.map);\n+ }\n+\n+ restore(persisted) {\n+ let obj = JSON.parse(persisted);\n+ let graph = new DepGraph({ circular: true });\n+\n+ // https://github.com/jriecken/dependency-graph/issues/44\n+ for (let key in obj) {\n+ graph[key] = obj[key];\n+ }\n+ this.map = graph;\n+ }\n}\nmodule.exports = GlobalDependencyMap;\n" } ]
JavaScript
MIT License
11ty/eleventy
Stringify and restore dependency map, part of #984
699
21.12.2022 14:57:43
21,600
c95235cbf292c78d01dbd8241a5f41cbb6a3587d
Restore layout resolution, add config api to disable, fixes
[ { "change_type": "MODIFY", "old_path": "test/TemplateLayoutPathResolverTest.js", "new_path": "test/TemplateLayoutPathResolverTest.js", "diff": "@@ -6,33 +6,16 @@ const EleventyExtensionMap = require(\"../src/EleventyExtensionMap\");\nfunction getResolverInstance(path, inputDir, { eleventyConfig, map } = {}) {\nif (!eleventyConfig) {\neleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\n}\nif (!map) {\nmap = new EleventyExtensionMap(\n- [\n- \"liquid\",\n- \"ejs\",\n- \"md\",\n- \"hbs\",\n- \"mustache\",\n- \"haml\",\n- \"pug\",\n- \"njk\",\n- \"html\",\n- \"11ty.js\",\n- ],\n+ [\"liquid\", \"ejs\", \"md\", \"hbs\", \"mustache\", \"haml\", \"pug\", \"njk\", \"html\", \"11ty.js\"],\neleventyConfig\n);\n}\n- return new TemplateLayoutPathResolver(\n- path,\n- inputDir,\n- map,\n- eleventyConfig.getConfig()\n- );\n+ return new TemplateLayoutPathResolver(path, inputDir, map, eleventyConfig.getConfig());\n}\ntest(\"Layout\", (t) => {\n@@ -53,7 +36,6 @@ test(\"Layout (uses empty string includes folder)\", (t) => {\nincludes: \"\",\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"includesemptystring\", \"./test/stubs\", {\neleventyConfig,\n@@ -70,7 +52,6 @@ test(\"Layout (uses empty string includes folder) already has extension\", (t) =>\nincludes: \"\",\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"includesemptystring.ejs\", \"./test/stubs\", {\neleventyConfig,\n@@ -88,7 +69,6 @@ test(\"Layout (uses layouts folder)\", (t) => {\nincludes: \"_includes\",\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"layoutsdefault\", \"./test/stubs\", {\neleventyConfig,\n@@ -107,7 +87,6 @@ test(\"Layout (uses layouts folder) already has extension\", (t) => {\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"layoutsdefault.ejs\", \"./test/stubs\", {\neleventyConfig,\n});\n@@ -124,7 +103,6 @@ test(\"Layout (uses empty string layouts folder)\", (t) => {\nincludes: \"_includes\",\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"layoutsemptystring\", \"./test/stubs\", {\neleventyConfig,\n@@ -135,6 +113,8 @@ test(\"Layout (uses empty string layouts folder)\", (t) => {\ntest(\"Layout (uses empty string layouts folder) no template resolution\", (t) => {\nlet eleventyConfig = new TemplateConfig();\n+ eleventyConfig.userConfig.setLayoutResolution(false);\n+\neleventyConfig.appendToRootConfig({\ntemplateFormats: [\"ejs\"],\ndir: {\n@@ -161,7 +141,6 @@ test(\"Layout (uses empty string layouts folder) already has extension\", (t) => {\nincludes: \"_includes\",\n},\n});\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet res = getResolverInstance(\"layoutsemptystring.ejs\", \"./test/stubs\", {\neleventyConfig,\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateLayoutTest.js", "new_path": "test/TemplateLayoutTest.js", "diff": "@@ -5,31 +5,14 @@ const EleventyExtensionMap = require(\"../src/EleventyExtensionMap\");\nfunction getTemplateLayoutInstance(key, inputDir, map) {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nif (!map) {\nmap = new EleventyExtensionMap(\n- [\n- \"liquid\",\n- \"ejs\",\n- \"md\",\n- \"hbs\",\n- \"mustache\",\n- \"haml\",\n- \"pug\",\n- \"njk\",\n- \"html\",\n- \"11ty.js\",\n- ],\n+ [\"liquid\", \"ejs\", \"md\", \"hbs\", \"mustache\", \"haml\", \"pug\", \"njk\", \"html\", \"11ty.js\"],\neleventyConfig\n);\n}\n- let layout = new TemplateLayout(\n- key,\n- inputDir,\n- map,\n- eleventyConfig.getConfig()\n- );\n+ let layout = new TemplateLayout(key, inputDir, map, eleventyConfig.getConfig());\nreturn layout;\n}\n@@ -45,10 +28,7 @@ test(\"Creation\", (t) => {\n});\ntest(\"Get Layout Chain\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-inherit-a.njk\",\n- \"./test/stubs\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-inherit-a.njk\", \"./test/stubs\");\nawait tl.getData();\n@@ -60,14 +40,8 @@ test(\"Get Layout Chain\", async (t) => {\n});\ntest(\"Get Front Matter Data\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-inherit-a.njk\",\n- \"./test/stubs\"\n- );\n- t.is(\n- tl.getInputPath(),\n- \"./test/stubs/_includes/layouts/layout-inherit-a.njk\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-inherit-a.njk\", \"./test/stubs\");\n+ t.is(tl.getInputPath(), \"./test/stubs/_includes/layouts/layout-inherit-a.njk\");\nlet data = await tl.getData();\n@@ -109,21 +83,15 @@ test(\"Augment data with layoutContent\", async (t) => {\n_layoutContent: \"Test 2\",\n});\n- t.deepEqual(\n- TemplateLayout.augmentDataWithContent({ content: \"Abc\" }, \"Test 3\"),\n- {\n+ t.deepEqual(TemplateLayout.augmentDataWithContent({ content: \"Abc\" }, \"Test 3\"), {\ncontent: \"Test 3\",\nlayoutContent: \"Test 3\",\n_layoutContent: \"Test 3\",\n- }\n- );\n+ });\n});\ntest(\"Render Layout\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-inherit-a.njk\",\n- \"./test/stubs\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-inherit-a.njk\", \"./test/stubs\");\nt.is(\n(\nawait tl.render({\n@@ -137,10 +105,7 @@ test(\"Render Layout\", async (t) => {\n});\ntest(\"Render Layout (Pass in template content)\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-inherit-a.njk\",\n- \"./test/stubs\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-inherit-a.njk\", \"./test/stubs\");\nt.is(\n(\nawait tl.render(\n@@ -153,59 +118,32 @@ test(\"Render Layout (Pass in template content)\", async (t) => {\n});\ntest(\"Render Layout (Pass in undefined template content)\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-contentdump.njk\",\n- \"./test/stubs\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-contentdump.njk\", \"./test/stubs\");\nt.is(\n- await tl.render(\n- { inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" },\n- undefined\n- ),\n+ await tl.render({ inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" }, undefined),\n\"this is bad a b a c\"\n);\n});\ntest(\"Render Layout (Pass in null template content)\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-contentdump.njk\",\n- \"./test/stubs\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-contentdump.njk\", \"./test/stubs\");\nt.is(\n- await tl.render(\n- { inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" },\n- null\n- ),\n+ await tl.render({ inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" }, null),\n\" a b a c\"\n);\n});\ntest(\"Render Layout (Pass in empty template content)\", async (t) => {\n- let tl = getTemplateLayoutInstance(\n- \"layouts/layout-contentdump.njk\",\n- \"./test/stubs\"\n- );\n- t.is(\n- await tl.render(\n- { inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" },\n- \"\"\n- ),\n- \" a b a c\"\n- );\n+ let tl = getTemplateLayoutInstance(\"layouts/layout-contentdump.njk\", \"./test/stubs\");\n+ t.is(await tl.render({ inherits: \"a\", secondinherits: \"b\", thirdinherits: \"c\" }, \"\"), \" a b a c\");\n});\ntest(\"Cache Duplicates (use full key for cache)\", async (t) => {\n// if two different layouts used the same filename but had different inputdirs, make sure templatelayout cache is unique\n- let tla = getTemplateLayoutInstance(\n- \"layout.njk\",\n- \"./test/stubs/templateLayoutCacheDuplicates\"\n- );\n+ let tla = getTemplateLayoutInstance(\"layout.njk\", \"./test/stubs/templateLayoutCacheDuplicates\");\nt.is((await tla.render({})).trim(), \"Hello A\");\n- let tlb = getTemplateLayoutInstance(\n- \"layout.njk\",\n- \"./test/stubs/templateLayoutCacheDuplicates-b\"\n- );\n+ let tlb = getTemplateLayoutInstance(\"layout.njk\", \"./test/stubs/templateLayoutCacheDuplicates-b\");\nt.is((await tlb.render({})).trim(), \"Hello B\");\nt.is((await tla.render({})).trim(), \"Hello A\");\n@@ -213,10 +151,7 @@ test(\"Cache Duplicates (use full key for cache)\", async (t) => {\ntest(\"Throw an error if a layout references itself as the layout\", async (t) => {\nawait t.throwsAsync(async () => {\n- const tl = getTemplateLayoutInstance(\n- \"layout-cycle-self.njk\",\n- \"./test/stubs-circular-layout\"\n- );\n+ const tl = getTemplateLayoutInstance(\"layout-cycle-self.njk\", \"./test/stubs-circular-layout\");\nconst layoutChain = await tl._testGetLayoutChain();\nreturn layoutChain;\n@@ -225,10 +160,7 @@ test(\"Throw an error if a layout references itself as the layout\", async (t) =>\ntest(\"Throw an error if a circular layout chain is detected\", async (t) => {\nawait t.throwsAsync(async () => {\n- const tl = getTemplateLayoutInstance(\n- \"layout-cycle-a.njk\",\n- \"./test/stubsstubs-circular-layout\"\n- );\n+ const tl = getTemplateLayoutInstance(\"layout-cycle-a.njk\", \"./test/stubsstubs-circular-layout\");\nconst layoutChain = await tl._testGetLayoutChain();\nreturn layoutChain;\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateMapTest.js", "new_path": "test/TemplateMapTest.js", "diff": "@@ -10,14 +10,7 @@ const getNewTemplateForTests = require(\"./_getNewTemplateForTests\");\nconst getRenderedTmpls = require(\"./_getRenderedTemplates\");\nfunction getNewTemplate(filename, input, output, eleventyConfig) {\n- return getNewTemplateForTests(\n- filename,\n- input,\n- output,\n- null,\n- null,\n- eleventyConfig\n- );\n+ return getNewTemplateForTests(filename, input, output, null, null, eleventyConfig);\n}\nfunction getNewTemplateByNumber(num, eleventyConfig) {\n@@ -316,14 +309,8 @@ test(\"TemplateMap adds collections data and has page data values using .cache()\"\nlet map = tm.getMap();\nawait tm.cache();\nt.is(map[0].data.page.url, \"/templateMapCollection/test1/\");\n- t.is(\n- map[0].data.page.outputPath,\n- \"./test/stubs/_site/templateMapCollection/test1/index.html\"\n- );\n- t.is(\n- map[0].data.page.inputPath,\n- \"./test/stubs/templateMapCollection/test1.md\"\n- );\n+ t.is(map[0].data.page.outputPath, \"./test/stubs/_site/templateMapCollection/test1/index.html\");\n+ t.is(map[0].data.page.inputPath, \"./test/stubs/templateMapCollection/test1.md\");\nt.is(map[0].data.page.fileSlug, \"test1\");\nt.truthy(map[0].data.page.date);\n});\n@@ -339,20 +326,14 @@ test(\"TemplateMap adds collections data and has page data values using ._testGet\nlet collections = await tm._testGetCollectionsData();\nt.is(collections.all[0].url, \"/templateMapCollection/test1/\");\n- t.is(\n- collections.all[0].outputPath,\n- \"./test/stubs/_site/templateMapCollection/test1/index.html\"\n- );\n+ t.is(collections.all[0].outputPath, \"./test/stubs/_site/templateMapCollection/test1/index.html\");\nt.is(collections.all[0].data.page.url, \"/templateMapCollection/test1/\");\nt.is(\ncollections.all[0].data.page.outputPath,\n\"./test/stubs/_site/templateMapCollection/test1/index.html\"\n);\n- t.is(\n- collections.all[0].data.page.inputPath,\n- \"./test/stubs/templateMapCollection/test1.md\"\n- );\n+ t.is(collections.all[0].data.page.inputPath, \"./test/stubs/templateMapCollection/test1.md\");\nt.is(collections.all[0].data.page.fileSlug, \"test1\");\n});\n@@ -380,10 +361,7 @@ test(\"Url should be available in user config collections API calls\", async (t) =\n\"./test/stubs/_site/templateMapCollection/test1/index.html\"\n);\n- t.is(\n- collections.userCollection[0].data.page.url,\n- \"/templateMapCollection/test1/\"\n- );\n+ t.is(collections.userCollection[0].data.page.url, \"/templateMapCollection/test1/\");\nt.is(\ncollections.userCollection[0].data.page.outputPath,\n\"./test/stubs/_site/templateMapCollection/test1/index.html\"\n@@ -397,15 +375,9 @@ test(\"Url should be available in user config collections API calls (test in call\nuserCollection: function (collection) {\nlet all = collection.getAll();\nt.is(all[0].url, \"/templateMapCollection/test1/\");\n- t.is(\n- all[0].outputPath,\n- \"./test/stubs/_site/templateMapCollection/test1/index.html\"\n- );\n+ t.is(all[0].outputPath, \"./test/stubs/_site/templateMapCollection/test1/index.html\");\nt.is(all[1].url, \"/templateMapCollection/test2/\");\n- t.is(\n- all[1].outputPath,\n- \"./test/stubs/_site/templateMapCollection/test2/index.html\"\n- );\n+ t.is(all[1].outputPath, \"./test/stubs/_site/templateMapCollection/test2/index.html\");\nreturn all;\n},\n@@ -490,10 +462,7 @@ test(\"Should be able to paginate a user config collection (uses rendered permali\nuserCollection: function (collection) {\nlet all = collection.getFilteredByTag(\"dog\");\nt.is(all[0].url, \"/templateMapCollection/test1/\");\n- t.is(\n- all[0].outputPath,\n- \"./test/stubs/_site/templateMapCollection/test1/index.html\"\n- );\n+ t.is(all[0].outputPath, \"./test/stubs/_site/templateMapCollection/test1/index.html\");\nreturn all;\n},\n});\n@@ -574,14 +543,8 @@ test(\"Should be able to paginate a user config collection (paged template is als\nt.truthy(collections.haha);\nt.is(collections.haha.length, 2);\n- t.is(\n- collections.haha[0].url,\n- \"/templateMapCollection/paged-cfg-tagged-apply-to-all/\"\n- );\n- t.is(\n- collections.haha[1].url,\n- \"/templateMapCollection/paged-cfg-tagged-apply-to-all/1/\"\n- );\n+ t.is(collections.haha[0].url, \"/templateMapCollection/paged-cfg-tagged-apply-to-all/\");\n+ t.is(collections.haha[1].url, \"/templateMapCollection/paged-cfg-tagged-apply-to-all/1/\");\n});\ntest(\"Should be able to paginate a user config collection (paged template is also tagged, uses custom rendered permalink)\", async (t) => {\n@@ -692,10 +655,7 @@ test(\"Should be able to paginate a tag generated collection (and it has template\n\"./test/stubs/templateMapCollection/paged-tag-dogs-templateContent.md\"\n);\n- let templates = await getRenderedTmpls(\n- pagedMapEntry.template,\n- pagedMapEntry.data\n- );\n+ let templates = await getRenderedTmpls(pagedMapEntry.template, pagedMapEntry.data);\nt.is(templates.length, 2);\nt.is(templates[0].data.pagination.pageNumber, 0);\nt.is(templates[1].data.pagination.pageNumber, 1);\n@@ -739,10 +699,7 @@ test(\"Should be able to paginate a tag generated collection when aliased (and it\n\"./test/stubs/templateMapCollection/paged-tag-dogs-templateContent-alias.md\"\n);\n- let templates = await getRenderedTmpls(\n- pagedMapEntry.template,\n- pagedMapEntry.data\n- );\n+ let templates = await getRenderedTmpls(pagedMapEntry.template, pagedMapEntry.data);\nt.is(templates.length, 1);\nt.is(templates[0].data.pagination.pageNumber, 0);\nt.is(\n@@ -803,10 +760,7 @@ test(\"getUserConfigCollectionNames\", async (t) => {\n},\n});\n- t.deepEqual(tm.getUserConfigCollectionNames(), [\n- \"userCollection\",\n- \"otherUserCollection\",\n- ]);\n+ t.deepEqual(tm.getUserConfigCollectionNames(), [\"userCollection\", \"otherUserCollection\"]);\n});\ntest(\"isUserConfigCollectionName\", (t) => {\n@@ -859,9 +813,7 @@ test(\"Dependency Map should have include orphan user config collections (in the\nlet [deps, delayedDeps] = tm.getFullTemplateMapOrder();\nt.true(deps.filter((dep) => dep.indexOf(\"userCollection\") > -1).length === 0);\n- t.true(\n- delayedDeps.filter((dep) => dep.indexOf(\"userCollection\") > -1).length > 0\n- );\n+ t.true(delayedDeps.filter((dep) => dep.indexOf(\"userCollection\") > -1).length > 0);\nlet collections = await tm._testGetCollectionsData();\nt.is(collections.all.length, 2);\n@@ -968,10 +920,7 @@ test(\"Tag pages (all pages added to collections). Allow pagination over all coll\nreturn entry.templateContent.trim();\n})\n);\n- t.deepEqual(\n- collectionTagPagesTemplateContents,\n- new Set([\"post\", \"dog\", \"cat\"])\n- );\n+ t.deepEqual(collectionTagPagesTemplateContents, new Set([\"post\", \"dog\", \"cat\"]));\n});\ntest(\"eleventyExcludeFromCollections\", async (t) => {\n@@ -1066,19 +1015,10 @@ test(\"Paginate over collections.all\", async (t) => {\n);\nlet map = tm.getMap();\n- t.is(\n- map[0].inputPath,\n- \"./test/stubs/page-target-collections/paginateall.njk\"\n- );\n+ t.is(map[0].inputPath, \"./test/stubs/page-target-collections/paginateall.njk\");\nt.is(map[0]._pages.length, 2);\n- t.is(\n- map[0]._pages[0].templateContent,\n- \"INPUT PATH:./test/stubs/templateMapCollection/test1.md\"\n- );\n- t.is(\n- map[0]._pages[1].templateContent,\n- \"INPUT PATH:./test/stubs/templateMapCollection/test2.md\"\n- );\n+ t.is(map[0]._pages[0].templateContent, \"INPUT PATH:./test/stubs/templateMapCollection/test1.md\");\n+ t.is(map[0]._pages[1].templateContent, \"INPUT PATH:./test/stubs/templateMapCollection/test2.md\");\nt.is(map[1].inputPath, \"./test/stubs/templateMapCollection/test1.md\");\nt.is(map[1]._pages[0].templateContent.trim(), \"<h1>Test 1</h1>\");\nt.is(map[2].inputPath, \"./test/stubs/templateMapCollection/test2.md\");\n@@ -1146,10 +1086,7 @@ test(\"Test a transform with a layout (via templateMap)\", async (t) => {\nfor (let entry of tm.getMap()) {\nfor (let page of entry._pages) {\n- t.is(\n- await entry.template.renderPageEntry(entry, page),\n- \"OVERRIDE BY A TRANSFORM\"\n- );\n+ t.is(await entry.template.renderPageEntry(entry, page), \"OVERRIDE BY A TRANSFORM\");\n}\n}\n});\n@@ -1389,8 +1326,7 @@ test(\"serverlessUrlMap Event (with `build` and `serverless`)\", async (t) => {\neleventyConfig.userConfig.on(\"eleventy.serverlessUrlMap\", (templateMap) => {\nt.deepEqual(templateMap, [\n{\n- inputPath:\n- \"./test/stubs/permalink-build-serverless/permalink-build-serverless.md\",\n+ inputPath: \"./test/stubs/permalink-build-serverless/permalink-build-serverless.md\",\nserverless: {\nserverless: \"/some-other-url/\",\n},\n@@ -1470,13 +1406,10 @@ test(\"eleventy.layouts Event\", async (t) => {\nt.plan(1);\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\neleventyConfig.userConfig.on(\"eleventy.layouts\", (layoutMap) => {\nt.deepEqual(layoutMap, {\n- \"./test/stubs-layouts-event/_includes/first.liquid\": [\n- \"./test/stubs-layouts-event/page.md\",\n- ],\n+ \"./test/stubs-layouts-event/_includes/first.liquid\": [\"./test/stubs-layouts-event/page.md\"],\n\"./test/stubs-layouts-event/_includes/second.liquid\": [\n\"./test/stubs-layouts-event/page.md\",\n\"./test/stubs-layouts-event/_includes/first.liquid\",\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateTest.js", "new_path": "test/TemplateTest.js", "diff": "@@ -159,7 +159,6 @@ test(\"Test that getData() works\", async (t) => {\ntest(\"One Layout (using new content var)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\nlet tmpl = getNewTemplate(\n@@ -189,7 +188,6 @@ test(\"One Layout (using new content var)\", async (t) => {\ntest(\"One Layout (using layoutContent)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\nlet tmpl = getNewTemplate(\n@@ -219,7 +217,6 @@ test(\"One Layout (using layoutContent)\", async (t) => {\ntest(\"One Layout (layouts disabled)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\nlet tmpl = getNewTemplate(\n@@ -244,7 +241,6 @@ test(\"One Layout (layouts disabled)\", async (t) => {\ntest(\"One Layout (_layoutContent deprecated but supported)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\nlet tmpl = getNewTemplate(\n@@ -302,7 +298,6 @@ test(\"One Layout (liquid test)\", async (t) => {\ntest(\"Two Layouts\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\n- eleventyConfig.userConfig.enableLayoutResolution();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\nlet tmpl = getNewTemplate(\n" } ]
JavaScript
MIT License
11ty/eleventy
Restore layout resolution, add config api to disable, fixes #2708
699
21.12.2022 17:22:02
21,600
69a56da9413971c89a31b3b3654993d5c9812243
Cache the transform output too for even better incremental builds
[ { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -102,6 +102,7 @@ class Template extends TemplateContent {\nif (types.render) {\ndelete this._cacheRenderedContent;\n+ delete this._cacheFinalContent;\n}\n}\n@@ -766,6 +767,10 @@ class Template extends TemplateContent {\n}\nasync renderPageEntry(mapEntry, page) {\n+ if (this._cacheFinalContent) {\n+ return this._cacheFinalContent;\n+ }\n+\nlet content;\nlet layoutKey = mapEntry.data[this.config.keys.layout];\nif (layoutKey) {\n@@ -778,6 +783,7 @@ class Template extends TemplateContent {\nawait this.runLinters(content, page);\ncontent = await this.runTransforms(content, page);\n+ this._cacheFinalContent = content;\nreturn content;\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Cache the transform output too for even better incremental builds
699
22.12.2022 08:54:45
21,600
e4501e8d7e549c42df8d3de00a8d9ba37ba7c303
Fixes for non-incremental watch/serve, related to
[ { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -91,10 +91,10 @@ class Template extends TemplateContent {\nthis.writeCount = 0;\n}\n- resetForIncremental(types) {\n+ resetCaches(types) {\ntypes = this.getResetTypes(types);\n- super.resetForIncremental(types);\n+ super.resetCaches(types);\nif (types.data) {\ndelete this._dataCache;\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateContent.js", "new_path": "src/TemplateContent.js", "diff": "@@ -58,7 +58,7 @@ class TemplateContent {\n}\n// Called during an incremental build when the template instance is cached but needs to be reset because it has changed\n- resetForIncremental(types) {\n+ resetCaches(types) {\ntypes = this.getResetTypes(types);\nif (types.read) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -154,7 +154,10 @@ class TemplateWriter {\n_createTemplate(path, to = \"fs\") {\nlet tmpl = this._templatePathCache.get(path);\n- if (!tmpl) {\n+ let wasCached = false;\n+ if (tmpl) {\n+ wasCached = true;\n+ } else {\ntmpl = new Template(\npath,\nthis.inputDir,\n@@ -194,21 +197,30 @@ class TemplateWriter {\ntmpl.setIsVerbose(this.isVerbose);\ntmpl.reset();\n- return tmpl;\n+ return {\n+ template: tmpl,\n+ wasCached,\n+ };\n}\nasync _addToTemplateMap(paths, to = \"fs\") {\nlet promises = [];\n- let isFullTemplate = this.eleventyFiles.isFullTemplateFile(paths, this.incrementalFile);\n+ let isIncrementalFileAFullTemplate = this.eleventyFiles.isFullTemplateFile(\n+ paths,\n+ this.incrementalFile\n+ );\n+ let isIncrementalFileAPassthroughCopy = this._isIncrementalFileAPassthroughCopy(paths);\nlet relevantToDeletions = new Set();\n// Update the data cascade and the global dependency map for the one incremental template before everything else (only full templates)\n- if (isFullTemplate && this.incrementalFile) {\n+ if (isIncrementalFileAFullTemplate && this.incrementalFile) {\nlet path = this.incrementalFile;\n- let tmpl = this._createTemplate(path, to);\n- tmpl.resetForIncremental(); // reset internal caches on the cached template instance\n+ let { template: tmpl, wasCached } = this._createTemplate(path, to);\n+ if (wasCached) {\n+ tmpl.resetCaches(); // reset internal caches on the cached template instance\n+ }\nlet p = this.templateMap.add(tmpl);\npromises.push(p);\n@@ -223,8 +235,6 @@ class TemplateWriter {\nthis.templateMap.addToGlobalDependencyGraph();\n}\n- let isIncrementalFileAPassthroughCopy = this._isIncrementalFileAPassthroughCopy(paths);\n-\nfor (let path of paths) {\nif (!this.extensionMap.hasEngine(path)) {\ncontinue;\n@@ -236,13 +246,17 @@ class TemplateWriter {\n}\n// We already updated the data cascade for this template above\n- if (isFullTemplate && this.incrementalFile === path) {\n+ if (isIncrementalFileAFullTemplate && this.incrementalFile === path) {\ncontinue;\n}\n- let tmpl = this._createTemplate(path, to);\n+ let { template: tmpl, wasCached } = this._createTemplate(path, to);\n- if (this.incrementalFile) {\n+ if (!this.incrementalFile) {\n+ if (wasCached) {\n+ tmpl.resetCaches();\n+ }\n+ } else {\nlet isTemplateRelevantToDeletedCollections = relevantToDeletions.has(\nTemplatePath.stripLeadingDotSlash(tmpl.inputPath)\n);\n@@ -250,10 +264,11 @@ class TemplateWriter {\nif (\nisTemplateRelevantToDeletedCollections ||\ntmpl.isFileRelevantToThisTemplate(this.incrementalFile, {\n- isFullTemplate,\n+ isFullTemplate: isIncrementalFileAFullTemplate,\n})\n) {\n- tmpl.resetForIncremental({\n+ // Related to the template but not the template (only reset the render cache)\n+ tmpl.resetCaches({\nrender: true,\n});\n} else {\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateWriterTest.js", "new_path": "test/TemplateWriterTest.js", "diff": "@@ -33,14 +33,11 @@ test(\"Output is a subdir of input\", async (t) => {\nt.is(evf.getRawFiles().length, 2);\nt.true(files.length > 0);\n- let tmpl = tw._createTemplate(files[0]);\n+ let { template: tmpl } = tw._createTemplate(files[0]);\nt.is(tmpl.inputDir, \"./test/stubs/writeTest\");\nlet data = await tmpl.getData();\n- t.is(\n- await tmpl.getOutputPath(data),\n- \"./test/stubs/writeTest/_writeTestSite/test/index.html\"\n- );\n+ t.is(await tmpl.getOutputPath(data), \"./test/stubs/writeTest/_writeTestSite/test/index.html\");\n});\ntest(\"_createTemplateMap\", async (t) => {\n@@ -151,14 +148,8 @@ test(\"__testGetCollectionsData with custom collection (ascending)\", async (t) =>\nlet templateMap = await tw._createTemplateMap(paths);\nlet collectionsData = await templateMap._testGetCollectionsData();\nt.is(collectionsData.customPostsAsc.length, 2);\n- t.is(\n- path.parse(collectionsData.customPostsAsc[0].inputPath).base,\n- \"test1.md\"\n- );\n- t.is(\n- path.parse(collectionsData.customPostsAsc[1].inputPath).base,\n- \"test2.md\"\n- );\n+ t.is(path.parse(collectionsData.customPostsAsc[0].inputPath).base, \"test1.md\");\n+ t.is(path.parse(collectionsData.customPostsAsc[1].inputPath).base, \"test2.md\");\n});\ntest(\"__testGetCollectionsData with custom collection (descending)\", async (t) => {\n@@ -227,19 +218,14 @@ test(\"Pagination with a Collection\", async (t) => {\nt.is(collectionsData.tag1.length, 3);\nt.is(collectionsData.pagingtag.length, 1);\n- let mapEntry = templateMap.getMapEntryForInputPath(\n- \"./test/stubs/paged/collection/main.njk\"\n- );\n+ let mapEntry = templateMap.getMapEntryForInputPath(\"./test/stubs/paged/collection/main.njk\");\nt.truthy(mapEntry);\nt.is(mapEntry.inputPath, \"./test/stubs/paged/collection/main.njk\");\nt.is(mapEntry._pages.length, 2);\nt.is(mapEntry._pages[0].outputPath, \"./test/stubs/_site/main/index.html\");\nt.is(mapEntry._pages[1].outputPath, \"./test/stubs/_site/main/1/index.html\");\n- t.is(\n- mapEntry._pages[0].templateContent.trim(),\n- \"<ol><li>/test1/</li><li>/test2/</li></ol>\"\n- );\n+ t.is(mapEntry._pages[0].templateContent.trim(), \"<ol><li>/test1/</li><li>/test2/</li></ol>\");\nt.is(mapEntry._pages[1].templateContent.trim(), \"<ol><li>/test3/</li></ol>\");\n});\n@@ -263,20 +249,14 @@ test(\"Pagination with a Collection from another Paged Template\", async (t) => {\nlet map1 = templateMap.getMapEntryForInputPath(\n\"./test/stubs/paged/cfg-collection-tag-cfg-collection/paged-main.njk\"\n);\n- t.is(\n- map1._pages[0].templateContent.trim(),\n- \"<ol><li>/test1/</li><li>/test2/</li></ol>\"\n- );\n+ t.is(map1._pages[0].templateContent.trim(), \"<ol><li>/test1/</li><li>/test2/</li></ol>\");\nt.is(map1._pages[1].templateContent.trim(), \"<ol><li>/test3/</li></ol>\");\nlet map2 = templateMap.getMapEntryForInputPath(\n\"./test/stubs/paged/cfg-collection-tag-cfg-collection/paged-downstream.njk\"\n);\nt.is(map2._pages[0].templateContent.trim(), \"<ol><li>/paged-main/</li></ol>\");\n- t.is(\n- map2._pages[1].templateContent.trim(),\n- \"<ol><li>/paged-main/1/</li></ol>\"\n- );\n+ t.is(map2._pages[1].templateContent.trim(), \"<ol><li>/paged-main/1/</li></ol>\");\n});\ntest(\"Pagination with a Collection (apply all pages to collections)\", async (t) => {\n@@ -300,12 +280,9 @@ test(\"Pagination with a Collection (apply all pages to collections)\", async (t)\n\"./test/stubs/paged/collection-apply-to-all/main.njk\"\n);\nt.truthy(mapEntry);\n- t.is(\n- mapEntry.inputPath,\n- \"./test/stubs/paged/collection-apply-to-all/main.njk\"\n- );\n+ t.is(mapEntry.inputPath, \"./test/stubs/paged/collection-apply-to-all/main.njk\");\n- let mainTmpl = tw._createTemplate(\n+ let { template: mainTmpl } = tw._createTemplate(\n\"./test/stubs/paged/collection-apply-to-all/main.njk\"\n);\nlet data = await mainTmpl.getData();\n@@ -327,10 +304,7 @@ test(\"Pagination with a Collection (apply all pages to collections)\", async (t)\nt.is(templates[1].outputPath, \"./test/stubs/_site/main/1/index.html\");\n// test content\n- t.is(\n- templates[0].templateContent.trim(),\n- \"<ol><li>/test1/</li><li>/test2/</li></ol>\"\n- );\n+ t.is(templates[0].templateContent.trim(), \"<ol><li>/test1/</li><li>/test2/</li></ol>\");\nt.is(templates[1].templateContent.trim(), \"<ol><li>/test3/</li></ol>\");\n});\n@@ -356,15 +330,10 @@ test(\"Use a collection inside of a template\", async (t) => {\nt.truthy(mapEntry);\nt.is(mapEntry.inputPath, \"./test/stubs/collection-template/template.ejs\");\n- let mainTmpl = tw._createTemplate(\n- \"./test/stubs/collection-template/template.ejs\"\n- );\n+ let { template: mainTmpl } = tw._createTemplate(\"./test/stubs/collection-template/template.ejs\");\nlet data = await mainTmpl.getData();\nlet outputPath = await mainTmpl.getOutputPath(data);\n- t.is(\n- outputPath,\n- \"./test/stubs/collection-template/_site/template/index.html\"\n- );\n+ t.is(outputPath, \"./test/stubs/collection-template/_site/template/index.html\");\nlet templates = await getRenderedTmpls(mapEntry.template, mapEntry.data);\n@@ -396,15 +365,11 @@ test(\"Use a collection inside of a layout\", async (t) => {\nlet collectionsData = await templateMap._testGetCollectionsData();\nt.is(collectionsData.dog.length, 1);\n- let mapEntry = templateMap.getMapEntryForInputPath(\n- \"./test/stubs/collection-layout/template.ejs\"\n- );\n+ let mapEntry = templateMap.getMapEntryForInputPath(\"./test/stubs/collection-layout/template.ejs\");\nt.truthy(mapEntry);\nt.is(mapEntry.inputPath, \"./test/stubs/collection-layout/template.ejs\");\n- let mainTmpl = tw._createTemplate(\n- \"./test/stubs/collection-layout/template.ejs\"\n- );\n+ let { template: mainTmpl } = tw._createTemplate(\"./test/stubs/collection-layout/template.ejs\");\nlet data = await mainTmpl.getData();\nlet outputPath = await mainTmpl.getOutputPath(data);\nt.is(outputPath, \"./test/stubs/collection-layout/_site/template/index.html\");\n@@ -450,10 +415,7 @@ test(\"Pagination and TemplateContent\", async (t) => {\ntw.setVerboseOutput(false);\nawait tw.write();\n- let content = fs.readFileSync(\n- \"./test/stubs/pagination-templatecontent/_site/index.html\",\n- \"utf8\"\n- );\n+ let content = fs.readFileSync(\"./test/stubs/pagination-templatecontent/_site/index.html\", \"utf8\");\nt.is(\ncontent.trim(),\n`<h1>Post 1</h1>\n@@ -543,9 +505,7 @@ test(\"fileSlug should exist in a collection\", async (t) => {\nlet collectionsData = await templateMap._testGetCollectionsData();\nt.is(collectionsData.dog.length, 1);\n- let mapEntry = templateMap.getMapEntryForInputPath(\n- \"./test/stubs/collection-slug/template.njk\"\n- );\n+ let mapEntry = templateMap.getMapEntryForInputPath(\"./test/stubs/collection-slug/template.njk\");\nt.truthy(mapEntry);\nt.is(mapEntry.inputPath, \"./test/stubs/collection-slug/template.njk\");\n@@ -577,12 +537,9 @@ test(\"Write Test 11ty.js\", async (t) => {\n]);\nt.deepEqual(files, [\"./test/stubs/writeTestJS/test.11ty.js\"]);\n- let tmpl = tw._createTemplate(files[0]);\n+ let { template: tmpl } = tw._createTemplate(files[0]);\nlet data = await tmpl.getData();\n- t.is(\n- await tmpl.getOutputPath(data),\n- \"./test/stubs/_writeTestJSSite/test/index.html\"\n- );\n+ t.is(await tmpl.getOutputPath(data), \"./test/stubs/_writeTestJSSite/test/index.html\");\n});\ntest.skip(\"Markdown with alias\", async (t) => {\n@@ -620,19 +577,13 @@ test.skip(\"Markdown with alias\", async (t) => {\n);\ntw.setEleventyFiles(evf);\n- let tmpl = tw._createTemplate(files[0]);\n+ let { template: tmpl } = tw._createTemplate(files[0]);\ntmpl._setExtensionMap(map);\n- t.is(\n- await tmpl.getOutputPath(),\n- \"./test/stubs/_writeTestMarkdownSite/sample/index.html\"\n- );\n+ t.is(await tmpl.getOutputPath(), \"./test/stubs/_writeTestMarkdownSite/sample/index.html\");\n- let tmpl2 = tw._createTemplate(files[1]);\n+ let { template: tmpl2 } = tw._createTemplate(files[1]);\ntmpl2._setExtensionMap(map);\n- t.is(\n- await tmpl2.getOutputPath(),\n- \"./test/stubs/_writeTestMarkdownSite/sample2/index.html\"\n- );\n+ t.is(await tmpl2.getOutputPath(), \"./test/stubs/_writeTestMarkdownSite/sample2/index.html\");\n});\ntest.skip(\"JavaScript with alias\", async (t) => {\n@@ -656,17 +607,11 @@ test.skip(\"JavaScript with alias\", async (t) => {\nlet files = await fastglob(evf.getFileGlobs());\nt.deepEqual(\nevf.getRawFiles().sort(),\n- [\n- \"./test/stubs/writeTestJS/**/*.11ty.js\",\n- \"./test/stubs/writeTestJS/**/*.js\",\n- ].sort()\n+ [\"./test/stubs/writeTestJS/**/*.11ty.js\", \"./test/stubs/writeTestJS/**/*.js\"].sort()\n);\nt.deepEqual(\nfiles.sort(),\n- [\n- \"./test/stubs/writeTestJS/sample.js\",\n- \"./test/stubs/writeTestJS/test.11ty.js\",\n- ].sort()\n+ [\"./test/stubs/writeTestJS/sample.js\", \"./test/stubs/writeTestJS/test.11ty.js\"].sort()\n);\nlet tw = new TemplateWriter(\n@@ -678,11 +623,8 @@ test.skip(\"JavaScript with alias\", async (t) => {\n);\ntw.setEleventyFiles(evf);\n- let tmpl = tw._createTemplate(files[0]);\n- t.is(\n- await tmpl.getOutputPath(),\n- \"./test/stubs/_writeTestJSSite/test/index.html\"\n- );\n+ let { template: tmpl } = tw._createTemplate(files[0]);\n+ t.is(await tmpl.getOutputPath(), \"./test/stubs/_writeTestJSSite/test/index.html\");\n});\ntest(\"Passthrough file output\", async (t) => {\n" } ]
JavaScript
MIT License
11ty/eleventy
Fixes for non-incremental watch/serve, related to #2710
699
22.12.2022 09:00:00
21,600
01c1cf2160a47e1a2dbf968f3cca5e31b47d4bb1
Reset data cache for non-matching templates during incremental
[ { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -272,6 +272,11 @@ class TemplateWriter {\nrender: true,\n});\n} else {\n+ // during incremental we only reset the data cache for non-matching templates\n+ // https://github.com/11ty/eleventy/issues/2710\n+ tmpl.resetCaches({\n+ data: true,\n+ });\ntmpl.setDryRunViaIncremental();\nthis.skippedCount++;\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Reset data cache for non-matching templates during incremental #2710
699
22.12.2022 09:35:34
21,600
3b3a7c7e9e9bbc00b1047b143e40b87b05ffdb0c
Reset the data cache for matching templates during incremental
[ { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -269,6 +269,7 @@ class TemplateWriter {\n) {\n// Related to the template but not the template (only reset the render cache)\ntmpl.resetCaches({\n+ data: true,\nrender: true,\n});\n} else {\n" } ]
JavaScript
MIT License
11ty/eleventy
Reset the data cache for matching templates during incremental #2710
699
22.12.2022 13:57:00
21,600
c4e18f1d22007a7c47772c717fbe1488a633de32
Fixes regression for passthrough copy via globbing.
[ { "change_type": "MODIFY", "old_path": "src/FileSystemSearch.js", "new_path": "src/FileSystemSearch.js", "diff": "@@ -12,6 +12,13 @@ class FileSystemSearch {\nthis.count = 0;\n}\n+ getCacheKey(key, globs, options) {\n+ if (Array.isArray(globs)) {\n+ globs = globs.sort();\n+ }\n+ return key + JSON.stringify(globs) + JSON.stringify(options);\n+ }\n+\n// returns a promise\nsearch(key, globs, options = {}) {\ndebug(\"Glob search (%o) searching for: %o\", key, globs);\n@@ -27,20 +34,22 @@ class FileSystemSearch {\noptions.ignore = options.ignore.map((entry) => TemplatePath.stripLeadingDotSlash(entry));\n}\n+ let cacheKey = this.getCacheKey(key, globs, options);\n+\n// Only after the promise has resolved\n- if (this.outputs[key]) {\n- return Array.from(this.outputs[key]);\n+ if (this.outputs[cacheKey]) {\n+ return Array.from(this.outputs[cacheKey]);\n}\n- if (!this.promises[key]) {\n- this.inputs[key] = {\n+ if (!this.promises[cacheKey]) {\n+ this.inputs[cacheKey] = {\ninput: globs,\noptions,\n};\nthis.count++;\n- this.promises[key] = fastglob(\n+ this.promises[cacheKey] = fastglob(\nglobs,\nObject.assign(\n{\n@@ -50,13 +59,15 @@ class FileSystemSearch {\noptions\n)\n).then((results) => {\n- this.outputs[key] = new Set(results.map((entry) => TemplatePath.addLeadingDotSlash(entry)));\n- return Array.from(this.outputs[key]);\n+ this.outputs[cacheKey] = new Set(\n+ results.map((entry) => TemplatePath.addLeadingDotSlash(entry))\n+ );\n+ return Array.from(this.outputs[cacheKey]);\n});\n}\n// may be an unresolved promise\n- return this.promises[key];\n+ return this.promises[cacheKey];\n}\n_modify(path, setOperation) {\n" } ]
JavaScript
MIT License
11ty/eleventy
Fixes regression for passthrough copy via globbing.
699
03.01.2023 16:26:37
21,600
83fa7ff80df8137d53c27f5077f721f51f9c45db
Layout resolution keys and pathed layouts now share a cache
[ { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -14,44 +14,49 @@ class TemplateLayout extends TemplateContent {\nthrow new Error(\"Expected `config` in TemplateLayout constructor.\");\n}\n- let resolvedPath = new TemplateLayoutPathResolver(\n- key,\n- inputDir,\n- extensionMap,\n- config\n- ).getFullPath();\n+ let resolver = new TemplateLayoutPathResolver(key, inputDir, extensionMap, config);\n+ let resolvedPath = resolver.getFullPath();\nsuper(resolvedPath, inputDir, config);\nif (!extensionMap) {\nthrow new Error(\"Expected `extensionMap` in TemplateLayout constructor.\");\n}\n+\nthis.extensionMap = extensionMap;\n+ this.key = resolver.getNormalizedLayoutKey();\nthis.dataKeyLayoutPath = key;\nthis.inputPath = resolvedPath;\nthis.inputDir = inputDir;\n}\n+ getKey() {\n+ return this.key;\n+ }\n+\nstatic resolveFullKey(key, inputDir) {\nreturn TemplatePath.join(inputDir, key);\n}\nstatic getTemplate(key, inputDir, config, extensionMap) {\n- if (config.useTemplateCache) {\n+ if (!config.useTemplateCache) {\n+ return new TemplateLayout(key, inputDir, extensionMap, config);\n+ }\n+\nlet fullKey = TemplateLayout.resolveFullKey(key, inputDir);\nif (templateCache.has(fullKey)) {\ndebugDev(\"Found %o in TemplateCache\", key);\nreturn templateCache.get(fullKey);\n}\n- let tmpl = new TemplateLayout(key, inputDir, extensionMap, config);\n+ let layout = new TemplateLayout(key, inputDir, extensionMap, config);\ndebugDev(\"Added %o to TemplateCache\", key);\n- templateCache.add(fullKey, tmpl);\n+ templateCache.add(fullKey, layout);\n+ // if the fullKey was an alias, also set to the normalized key\n+ // e.g. `layout: \"default\"` and `layout: \"default.liquid\"` will both map to the same template.\n+ templateCache.add(layout.getKey(), layout);\n- return tmpl;\n- } else {\n- return new TemplateLayout(key, inputDir, extensionMap, config);\n- }\n+ return layout;\n}\nasync getTemplateLayoutMapEntry() {\n@@ -137,11 +142,7 @@ class TemplateLayout extends TemplateContent {\nlet fns = [];\ntry {\nfor (let layoutEntry of layoutMap) {\n- fns.push(\n- await layoutEntry.template.compile(\n- await layoutEntry.template.getPreRender()\n- )\n- );\n+ fns.push(await layoutEntry.template.compile(await layoutEntry.template.getPreRender()));\n}\n} catch (e) {\ndebugDev(\"Clearing TemplateCache after error.\");\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateLayoutPathResolver.js", "new_path": "src/TemplateLayoutPathResolver.js", "diff": "@@ -6,9 +6,7 @@ const { TemplatePath } = require(\"@11ty/eleventy-utils\");\nclass TemplateLayoutPathResolver {\nconstructor(path, inputDir, extensionMap, config) {\nif (!config) {\n- throw new Error(\n- \"Expected `config` in TemplateLayoutPathResolver constructor\"\n- );\n+ throw new Error(\"Expected `config` in TemplateLayoutPathResolver constructor\");\n}\nthis._config = config;\nthis.inputDir = inputDir;\n@@ -17,9 +15,7 @@ class TemplateLayoutPathResolver {\nthis.aliases = {};\nthis.extensionMap = extensionMap;\nif (!extensionMap) {\n- throw new Error(\n- \"Expected `extensionMap` in TemplateLayoutPathResolver constructor.\"\n- );\n+ throw new Error(\"Expected `extensionMap` in TemplateLayoutPathResolver constructor.\");\n}\nthis.init();\n@@ -67,19 +63,12 @@ class TemplateLayoutPathResolver {\nthis.pathAlreadyHasExtension = this.dir + \"/\" + this.path;\n- if (\n- this.path.split(\".\").length > 0 &&\n- fs.existsSync(this.pathAlreadyHasExtension)\n- ) {\n+ if (this.path.split(\".\").length > 0 && fs.existsSync(this.pathAlreadyHasExtension)) {\nthis.filename = this.path;\n- this.fullPath = TemplatePath.addLeadingDotSlash(\n- this.pathAlreadyHasExtension\n- );\n+ this.fullPath = TemplatePath.addLeadingDotSlash(this.pathAlreadyHasExtension);\n} else if (useLayoutResolution) {\nthis.filename = this.findFileName();\n- this.fullPath = TemplatePath.addLeadingDotSlash(\n- this.dir + \"/\" + this.filename\n- );\n+ this.fullPath = TemplatePath.addLeadingDotSlash(this.dir + \"/\" + this.filename);\n}\n}\n@@ -110,10 +99,7 @@ class TemplateLayoutPathResolver {\nfindFileName() {\nif (!fs.existsSync(this.dir)) {\nthrow Error(\n- \"TemplateLayoutPathResolver directory does not exist for \" +\n- this.path +\n- \": \" +\n- this.dir\n+ \"TemplateLayoutPathResolver directory does not exist for \" + this.path + \": \" + this.dir\n);\n}\n@@ -138,6 +124,10 @@ class TemplateLayoutPathResolver {\nreturn TemplatePath.join(this.inputDir, layoutsDir);\n}\n+\n+ getNormalizedLayoutKey() {\n+ return TemplatePath.stripLeadingSubPath(this.fullPath, this.getLayoutsDir());\n+ }\n}\nmodule.exports = TemplateLayoutPathResolver;\n" } ]
JavaScript
MIT License
11ty/eleventy
Layout resolution keys and pathed layouts now share a cache
699
03.01.2023 17:20:03
21,600
aa9fdaba0a1ca622e8e700b2695cc98c192ef903
Fix regression with layouts not applying during --incremental
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -269,7 +269,7 @@ class Eleventy {\nasync restart() {\ndebug(\"Restarting\");\nthis.start = this.getNewTimestamp();\n- templateCache.clear();\n+\nthis.bench.reset();\nthis.eleventyFiles.restart();\nthis.extensionMap.reset();\n" }, { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -134,17 +134,14 @@ class Template extends TemplateContent {\n}\ngetLayout(layoutKey) {\n- if (!this._layout || layoutKey !== this._layoutKey) {\n- this._layoutKey = layoutKey;\n- this._layout = TemplateLayout.getTemplate(\n+ // already cached downstream in TemplateLayout -> TemplateCache\n+ return TemplateLayout.getTemplate(\nlayoutKey,\nthis.getInputDir(),\nthis.config,\nthis.extensionMap\n);\n}\n- return this._layout;\n- }\nget baseFile() {\nreturn this.extensionMap.removeTemplateExtension(this.parsed.base);\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateCache.js", "new_path": "src/TemplateCache.js", "diff": "+const { TemplatePath } = require(\"@11ty/eleventy-utils\");\n+\n+const eventBus = require(\"./EventBus\");\n+\n// Note: this is only used for TemplateLayout right now but could be used for more\n// Just be careful because right now the TemplateLayout cache keys are not directly mapped to paths\n// So you may get collisions if you use this for other things.\nclass TemplateCache {\nconstructor() {\nthis.cache = {};\n+ this.cacheByInputPath = {};\n}\nclear() {\nthis.cache = {};\n+ this.cacheByInputPath = {};\n}\nsize() {\nreturn Object.keys(this.cache).length;\n}\n- add(key, template) {\n- this.cache[key] = template;\n+ add(key, layoutTemplate) {\n+ let keys = new Set();\n+\n+ keys.add(key);\n+\n+ if (\"getKey\" in layoutTemplate) {\n+ // if `key` was an alias, also set to the pathed layout value too\n+ // e.g. `layout: \"default\"` and `layout: \"default.liquid\"` will both map to the same template.\n+ keys.add(layoutTemplate.getKey());\n+ }\n+\n+ for (let key of keys) {\n+ this.cache[key] = layoutTemplate;\n+ }\n+\n+ // also the full template input path for use with eleventy --serve/--watch `_includes/default.liquid`\n+ let fullPath = TemplatePath.stripLeadingDotSlash(layoutTemplate.inputPath);\n+ this.cacheByInputPath[fullPath] = layoutTemplate;\n}\nhas(key) {\n@@ -30,12 +52,27 @@ class TemplateCache {\nreturn this.cache[key];\n}\n- remove(key) {\n- if (this.cache[key]) {\n+ remove(filePath) {\n+ filePath = TemplatePath.stripLeadingDotSlash(filePath);\n+\n+ if (!this.cacheByInputPath[filePath]) {\n+ return;\n+ }\n+\n+ let keys = this.cacheByInputPath[filePath].getCacheKeys();\n+ delete this.cacheByInputPath[filePath];\n+\n+ for (let key of keys) {\ndelete this.cache[key];\n}\n}\n}\n+let layoutCache = new TemplateCache();\n+\n+eventBus.on(\"eleventy.resourceModified\", (path) => {\n+ layoutCache.remove(path);\n+});\n+\n// singleton\n-module.exports = new TemplateCache();\n+module.exports = layoutCache;\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateContent.js", "new_path": "src/TemplateContent.js", "diff": "@@ -190,12 +190,16 @@ class TemplateContent {\nif (!this.engine.needsToReadFileContents()) {\nreturn \"\";\n}\n+\nlet templateBenchmark = this.bench.get(\"Template Read\");\ntemplateBenchmark.before();\n+\nlet content;\n+\nif (this.config.useTemplateCache) {\ncontent = TemplateContent.getCached(this.inputPath);\n}\n+\nif (!content) {\ncontent = await readFile(this.inputPath, \"utf8\");\n@@ -203,6 +207,7 @@ class TemplateContent {\nTemplateContent.cache(this.inputPath, content);\n}\n}\n+\ntemplateBenchmark.after();\nreturn content;\n@@ -550,7 +555,7 @@ eventBus.on(\"eleventy.resourceModified\", (path) => {\n// delete from input cache\nTemplateContent.deleteFromInputCache(path);\n- // delete form compile cache\n+ // delete from compile cache\nlet normalized = TemplatePath.addLeadingDotSlash(path);\nlet compileCache = TemplateContent._compileCache.get(normalized);\nif (compileCache) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -34,6 +34,10 @@ class TemplateLayout extends TemplateContent {\nreturn this.key;\n}\n+ getCacheKeys() {\n+ return new Set([this.dataKeyLayoutPath, this.key]);\n+ }\n+\nstatic resolveFullKey(key, inputDir) {\nreturn TemplatePath.join(inputDir, key);\n}\n@@ -52,9 +56,6 @@ class TemplateLayout extends TemplateContent {\nlet layout = new TemplateLayout(key, inputDir, extensionMap, config);\ndebugDev(\"Added %o to TemplateCache\", key);\ntemplateCache.add(fullKey, layout);\n- // if the fullKey was an alias, also set to the normalized key\n- // e.g. `layout: \"default\"` and `layout: \"default.liquid\"` will both map to the same template.\n- templateCache.add(layout.getKey(), layout);\nreturn layout;\n}\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -273,11 +273,11 @@ class TemplateWriter {\nrender: true,\n});\n} else {\n- // during incremental we only reset the data cache for non-matching templates\n- // https://github.com/11ty/eleventy/issues/2710\n+ // During incremental we only reset the data cache for non-matching templates, see https://github.com/11ty/eleventy/issues/2710\ntmpl.resetCaches({\ndata: true,\n});\n+\ntmpl.setDryRunViaIncremental();\nthis.skippedCount++;\n}\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateTest.js", "new_path": "test/TemplateTest.js", "diff": "@@ -1589,9 +1589,9 @@ test(\"Get Layout Chain\", async (t) => {\n\"./dist\"\n);\n- await tmpl.getData();\n+ let data = await tmpl.getData();\n- t.deepEqual(await tmpl._layout.getLayoutChain(), [\n+ t.deepEqual(await tmpl.getLayout(data.layout).getLayoutChain(), [\n\"./test/stubs-incremental/layout-chain/_includes/base.njk\",\n\"./test/stubs-incremental/layout-chain/_includes/parent.njk\",\n]);\n" } ]
JavaScript
MIT License
11ty/eleventy
Fix regression with layouts not applying during --incremental
699
04.01.2023 10:49:35
21,600
bb409cfa20a4206c824b8c8a6d587e230ed8454e
Remove _layoutContent
[ { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -160,9 +160,6 @@ class TemplateLayout extends TemplateContent {\nif (templateContent !== undefined) {\ndata.content = templateContent;\ndata.layoutContent = templateContent;\n-\n- // deprecated\n- data._layoutContent = templateContent;\n}\nreturn data;\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateMap.js", "new_path": "src/TemplateMap.js", "diff": "@@ -3,7 +3,6 @@ const { isPlainObject } = require(\"@11ty/eleventy-utils\");\nconst TemplateCollection = require(\"./TemplateCollection\");\nconst EleventyErrorUtil = require(\"./EleventyErrorUtil\");\n-const GlobalDependencyMap = require(\"./GlobalDependencyMap\");\nconst UsingCircularTemplateContentReferenceError = require(\"./Errors/UsingCircularTemplateContentReferenceError\");\nconst EleventyBaseError = require(\"./EleventyBaseError\");\n@@ -205,10 +204,7 @@ class TemplateMap {\n}\nlet paginationTagTarget = this.getPaginationTagTarget(entry);\n- if (\n- paginationTagTarget &&\n- this.isUserConfigCollectionName(paginationTagTarget)\n- ) {\n+ if (paginationTagTarget && this.isUserConfigCollectionName(paginationTagTarget)) {\nif (!graph.hasNode(entry.inputPath)) {\ngraph.addNode(entry.inputPath);\n}\n@@ -240,10 +236,7 @@ class TemplateMap {\nlet allNodeAdded = false;\nfor (let entry of this.map) {\n- if (\n- this.isPaginationOverAllCollections(entry) &&\n- !this.getPaginationTagTarget(entry)\n- ) {\n+ if (this.isPaginationOverAllCollections(entry) && !this.getPaginationTagTarget(entry)) {\nif (!allNodeAdded) {\ngraph.addNode(tagPrefix + \"all\");\nallNodeAdded = true;\n@@ -323,9 +316,7 @@ class TemplateMap {\ngetFullTemplateMapOrder() {\n// convert dependency graphs to ordered arrays\n- return this.getTemplateMapDependencyGraph().map((entry) =>\n- entry.overallOrder()\n- );\n+ return this.getTemplateMapDependencyGraph().map((entry) => entry.overallOrder());\n}\nsetupDependencyGraphChangesForIncrementalFile(incrementalFile) {\n@@ -356,9 +347,7 @@ class TemplateMap {\n// This _must_ happen before any additions, the other ones are in Custom.js and GlobalDependencyMap.js (from the eleventy.layouts Event)\nthis.config.uses.resetNode(incrementalFile);\n- return this.config.uses.getTemplatesThatConsumeCollections(\n- deletedCollectionNames\n- );\n+ return this.config.uses.getTemplatesThatConsumeCollections(deletedCollectionNames);\n}\n// Similar to getTemplateMapDependencyGraph but adds those relationships to the global dependency graph used for incremental builds\n@@ -366,34 +355,22 @@ class TemplateMap {\nfor (let entry of this.map) {\nlet paginationTagTarget = this.getPaginationTagTarget(entry);\nif (paginationTagTarget) {\n- this.config.uses.addDependencyConsumesCollection(\n- entry.inputPath,\n- paginationTagTarget\n- );\n+ this.config.uses.addDependencyConsumesCollection(entry.inputPath, paginationTagTarget);\n}\nif (!entry.data.eleventyExcludeFromCollections) {\n- this.config.uses.addDependencyPublishesToCollection(\n- entry.inputPath,\n- \"all\"\n- );\n+ this.config.uses.addDependencyPublishesToCollection(entry.inputPath, \"all\");\nif (Array.isArray(entry.data.tags)) {\nfor (let tag of entry.data.tags) {\n- this.config.uses.addDependencyPublishesToCollection(\n- entry.inputPath,\n- tag\n- );\n+ this.config.uses.addDependencyPublishesToCollection(entry.inputPath, tag);\n}\n}\n}\nif (Array.isArray(entry.data.eleventyImport?.collections)) {\nfor (let tag of entry.data.eleventyImport.collections) {\n- this.config.uses.addDependencyConsumesCollection(\n- entry.inputPath,\n- tag\n- );\n+ this.config.uses.addDependencyConsumesCollection(entry.inputPath, tag);\n}\n}\n}\n@@ -402,9 +379,7 @@ class TemplateMap {\nasync setCollectionByTagName(tagName) {\nif (this.isUserConfigCollectionName(tagName)) {\n// async\n- this.collectionsData[tagName] = await this.getUserConfigCollection(\n- tagName\n- );\n+ this.collectionsData[tagName] = await this.getUserConfigCollection(tagName);\n} else {\nthis.collectionsData[tagName] = this.getTaggedCollection(tagName);\n}\n@@ -440,9 +415,7 @@ class TemplateMap {\n// include Sanity drafts.\n// We want these empty-data pagination templates to show up in the serverlessUrlMap.\n- map.template.initServerlessUrlsForEmptyPaginationTemplates(\n- map.data.permalink\n- );\n+ map.template.initServerlessUrlsForEmptyPaginationTemplates(map.data.permalink);\n} else {\nlet counter = 0;\nfor (let page of map._pages) {\n@@ -453,8 +426,7 @@ class TemplateMap {\nif (\ncounter === 0 ||\n- (map.data.pagination &&\n- map.data.pagination.addAllPagesToCollections)\n+ (map.data.pagination && map.data.pagination.addAllPagesToCollections)\n) {\nif (!map.data.eleventyExcludeFromCollections) {\n// TODO do we need .template in collection entries?\n@@ -476,12 +448,8 @@ class TemplateMap {\nentry.data.collections = this.collectionsData;\n}\n- let [\n- dependencyMap,\n- delayedDependencyMap,\n- firstPaginatedDepMap,\n- secondPaginatedDepMap,\n- ] = this.getFullTemplateMapOrder();\n+ let [dependencyMap, delayedDependencyMap, firstPaginatedDepMap, secondPaginatedDepMap] =\n+ this.getFullTemplateMapOrder();\nawait this.initDependencyMap(dependencyMap);\nawait this.initDependencyMap(delayedDependencyMap);\n@@ -515,9 +483,7 @@ class TemplateMap {\nthis.checkForDuplicatePermalinks();\n- await this.config.events.emitLazy(\"eleventy.layouts\", () =>\n- this.generateLayoutsMap()\n- );\n+ await this.config.events.emitLazy(\"eleventy.layouts\", () => this.generateLayoutsMap());\nawait this.config.events.emitLazy(\"eleventy.serverlessUrlMap\", () =>\nthis.generateServerlessUrlMap(orderedMap)\n@@ -616,8 +582,7 @@ class TemplateMap {\n// IMPORTANT: this is where template content is rendered\ntry {\nfor (let pageEntry of map._pages) {\n- pageEntry.templateContent =\n- await pageEntry.template.renderWithoutLayout(pageEntry.data);\n+ pageEntry.templateContent = await pageEntry.template.renderWithoutLayout(pageEntry.data);\n}\n} catch (e) {\nif (EleventyErrorUtil.isPrematureTemplateContentError(e)) {\n@@ -626,16 +591,13 @@ class TemplateMap {\nthrow e;\n}\n}\n- debugDev(\n- \"Added this.map[...].templateContent, outputPath, et al for one map entry\"\n- );\n+ debugDev(\"Added this.map[...].templateContent, outputPath, et al for one map entry\");\n}\nfor (let map of usedTemplateContentTooEarlyMap) {\ntry {\nfor (let pageEntry of map._pages) {\n- pageEntry.templateContent =\n- await pageEntry.template.renderWithoutLayout(pageEntry.data);\n+ pageEntry.templateContent = await pageEntry.template.renderWithoutLayout(pageEntry.data);\n}\n} catch (e) {\nif (EleventyErrorUtil.isPrematureTemplateContentError(e)) {\n@@ -693,20 +655,16 @@ class TemplateMap {\n}\nisUserConfigCollectionName(name) {\n- let collections =\n- this.configCollections || this.userConfig.getCollections();\n+ let collections = this.configCollections || this.userConfig.getCollections();\nreturn name && !!collections[name];\n}\ngetUserConfigCollectionNames() {\n- return Object.keys(\n- this.configCollections || this.userConfig.getCollections()\n- );\n+ return Object.keys(this.configCollections || this.userConfig.getCollections());\n}\nasync getUserConfigCollection(name) {\n- let configCollections =\n- this.configCollections || this.userConfig.getCollections();\n+ let configCollections = this.configCollections || this.userConfig.getCollections();\n// This works with async now\nlet result = await configCollections[name](this.collection);\n@@ -717,15 +675,12 @@ class TemplateMap {\nasync _testGetUserConfigCollectionsData() {\nlet collections = {};\n- let configCollections =\n- this.configCollections || this.userConfig.getCollections();\n+ let configCollections = this.configCollections || this.userConfig.getCollections();\nfor (let name in configCollections) {\ncollections[name] = configCollections[name](this.collection);\n- debug(\n- `Collection: collections.${name} size: ${collections[name].length}`\n- );\n+ debug(`Collection: collections.${name} size: ${collections[name].length}`);\n}\nreturn collections;\n@@ -822,9 +777,7 @@ class TemplateMap {\n} else if (!permalinks[page.outputPath]) {\npermalinks[page.outputPath] = [entry.inputPath];\n} else {\n- warnings[\n- page.outputPath\n- ] = `Output conflict: multiple input files are writing to \\`${\n+ warnings[page.outputPath] = `Output conflict: multiple input files are writing to \\`${\npage.outputPath\n}\\`. Use distinct \\`permalink\\` values to resolve this conflict.\n1. ${entry.inputPath}\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateLayoutTest.js", "new_path": "test/TemplateLayoutTest.js", "diff": "@@ -68,25 +68,21 @@ test(\"Augment data with layoutContent\", async (t) => {\nt.deepEqual(TemplateLayout.augmentDataWithContent(null, null), {\ncontent: null,\nlayoutContent: null,\n- _layoutContent: null,\n});\nt.deepEqual(TemplateLayout.augmentDataWithContent(null, \"Test\"), {\ncontent: \"Test\",\nlayoutContent: \"Test\",\n- _layoutContent: \"Test\",\n});\nt.deepEqual(TemplateLayout.augmentDataWithContent({}, \"Test 2\"), {\ncontent: \"Test 2\",\nlayoutContent: \"Test 2\",\n- _layoutContent: \"Test 2\",\n});\nt.deepEqual(TemplateLayout.augmentDataWithContent({ content: \"Abc\" }, \"Test 3\"), {\ncontent: \"Test 3\",\nlayoutContent: \"Test 3\",\n- _layoutContent: \"Test 3\",\n});\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateTest.js", "new_path": "test/TemplateTest.js", "diff": "@@ -239,35 +239,6 @@ test(\"One Layout (layouts disabled)\", async (t) => {\nt.is(data.keylayout, \"valuelayout\");\n});\n-test(\"One Layout (_layoutContent deprecated but supported)\", async (t) => {\n- let eleventyConfig = new TemplateConfig();\n-\n- let dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\n- let tmpl = getNewTemplate(\n- \"./test/stubs/templateWithLayoutBackCompat.ejs\",\n- \"./test/stubs/\",\n- \"dist\",\n- dataObj,\n- null,\n- eleventyConfig\n- );\n-\n- t.is((await tmpl.getFrontMatter()).data[tmpl.config.keys.layout], \"defaultLayout_layoutContent\");\n-\n- let data = await tmpl.getData();\n- t.is(data[tmpl.config.keys.layout], \"defaultLayout_layoutContent\");\n-\n- t.is(\n- normalizeNewLines(cleanHtml(await tmpl.renderLayout(tmpl, data))),\n- `<div id=\"layout\">\n- <p>Hello.</p>\n-</div>`\n- );\n-\n- t.is(data.keymain, \"valuemain\");\n- t.is(data.keylayout, \"valuelayout\");\n-});\n-\ntest(\"One Layout (liquid test)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\n" }, { "change_type": "MODIFY", "old_path": "test/stubs/_includes/defaultLayout_layoutContent.ejs", "new_path": "test/stubs/_includes/defaultLayout_layoutContent.ejs", "diff": "@@ -6,5 +6,5 @@ yearsPosted: 0.4\n---\n<div id=\"layout\">\n- <%- _layoutContent %>\n+ <%- layoutContent %>\n</div>\n\\ No newline at end of file\n" } ]
JavaScript
MIT License
11ty/eleventy
Remove _layoutContent
699
04.01.2023 16:55:24
21,600
b1f06d907f8aab7db703452a511ee02e62eaf9b3
Status commit for incremental layout rendering fixes
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -16,7 +16,6 @@ const PathPrefixer = require(\"./Util/PathPrefixer\");\nconst TemplateConfig = require(\"./TemplateConfig\");\nconst FileSystemSearch = require(\"./FileSystemSearch\");\n-const templateCache = require(\"./TemplateCache\");\nconst simplePlural = require(\"./Util/Pluralize\");\nconst deleteRequireCache = require(\"./Util/DeleteRequireCache\");\nconst checkPassthroughCopyBehavior = require(\"./Util/PassthroughCopyBehaviorCheck\");\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateCache.js", "new_path": "src/TemplateCache.js", "diff": "@@ -17,13 +17,22 @@ class TemplateCache {\n}\nsize() {\n- return Object.keys(this.cache).length;\n+ return Object.keys(this.cacheByInputPath).length;\n}\n- add(key, layoutTemplate) {\n+ add(layoutTemplate) {\nlet keys = new Set();\n- keys.add(key);\n+ if (typeof layoutTemplate === \"string\") {\n+ throw new Error(\n+ \"Invalid argument type passed to TemplateCache->add(). Should be a TemplateLayout.\"\n+ );\n+ }\n+\n+ if (\"getFullKey\" in layoutTemplate) {\n+ let fullKey = layoutTemplate.getFullKey();\n+ keys.add(fullKey);\n+ }\nif (\"getKey\" in layoutTemplate) {\n// if `key` was an alias, also set to the pathed layout value too\n@@ -35,7 +44,7 @@ class TemplateCache {\nthis.cache[key] = layoutTemplate;\n}\n- // also the full template input path for use with eleventy --serve/--watch `_includes/default.liquid`\n+ // also the full template input path for use with eleventy --serve/--watch e.g. `_includes/default.liquid` (see `remove` below)\nlet fullPath = TemplatePath.stripLeadingDotSlash(layoutTemplate.inputPath);\nthis.cacheByInputPath[fullPath] = layoutTemplate;\n}\n@@ -59,12 +68,15 @@ class TemplateCache {\nreturn;\n}\n- let keys = this.cacheByInputPath[filePath].getCacheKeys();\n- delete this.cacheByInputPath[filePath];\n+ let layoutTemplate = this.cacheByInputPath[filePath];\n+ layoutTemplate.resetCaches();\n+ let keys = layoutTemplate.getCacheKeys();\nfor (let key of keys) {\ndelete this.cache[key];\n}\n+\n+ delete this.cacheByInputPath[filePath];\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateContent.js", "new_path": "src/TemplateContent.js", "diff": "@@ -62,7 +62,7 @@ class TemplateContent {\ntypes = this.getResetTypes(types);\nif (types.read) {\n- delete this.frontMatter;\n+ delete this.readingPromise;\ndelete this.inputContent;\ndelete this._frontMatterDataCache;\n}\n@@ -124,32 +124,39 @@ class TemplateContent {\n}\nasync read() {\n- if (this.inputContent) {\n- await this.inputContent;\n- } else {\n- this.inputContent = await this.getInputContent();\n+ if (!this.readingPromise) {\n+ if (!this.inputContent) {\n+ // cache the promise\n+ this.inputContent = this.getInputContent();\n}\n- if (this.inputContent) {\n+ this.readingPromise = new Promise(async (resolve, reject) => {\n+ try {\n+ let content = await this.inputContent;\n+\n+ if (content) {\nlet options = this.config.frontMatterParsingOptions || {};\nlet fm;\ntry {\n- fm = matter(this.inputContent, options);\n+ fm = matter(content, options);\n} catch (e) {\nthrow new TemplateContentFrontMatterError(\n`Having trouble reading front matter from template ${this.inputPath}`,\ne\n);\n}\n+\nif (options.excerpt && fm.excerpt) {\nlet excerptString = fm.excerpt + (options.excerpt_separator || \"---\");\nif (fm.content.startsWith(excerptString + os.EOL)) {\n// with an os-specific newline after excerpt separator\n- fm.content = fm.excerpt.trim() + \"\\n\" + fm.content.slice((excerptString + os.EOL).length);\n+ fm.content =\n+ fm.excerpt.trim() + \"\\n\" + fm.content.slice((excerptString + os.EOL).length);\n} else if (fm.content.startsWith(excerptString + \"\\n\")) {\n// with a newline (\\n) after excerpt separator\n// This is necessary for some git configurations on windows\n- fm.content = fm.excerpt.trim() + \"\\n\" + fm.content.slice((excerptString + 1).length);\n+ fm.content =\n+ fm.excerpt.trim() + \"\\n\" + fm.content.slice((excerptString + 1).length);\n} else if (fm.content.startsWith(excerptString)) {\n// no newline after excerpt separator\nfm.content = fm.excerpt + fm.content.slice(excerptString.length);\n@@ -159,14 +166,21 @@ class TemplateContent {\nlet alias = options.excerpt_alias || \"page.excerpt\";\nlodashSet(fm.data, alias, fm.excerpt);\n}\n- this.frontMatter = fm;\n+ resolve(fm);\n} else {\n- this.frontMatter = {\n+ resolve({\ndata: {},\ncontent: \"\",\nexcerpt: \"\",\n- };\n+ });\n}\n+ } catch (e) {\n+ reject(e);\n+ }\n+ });\n+ }\n+\n+ return this.readingPromise;\n}\nstatic cache(path, content) {\n@@ -213,35 +227,36 @@ class TemplateContent {\nreturn content;\n}\n+ // This might only be used in tests\nasync getFrontMatter() {\n- if (!this.frontMatter) {\n- await this.read();\n- }\n-\n- return this.frontMatter;\n+ let fm = await this.read();\n+ return fm;\n}\nasync getPreRender() {\n- if (!this.frontMatter) {\n- await this.read();\n- }\n+ let fm = await this.read();\n- return this.frontMatter.content;\n+ return fm.content;\n}\nasync getFrontMatterData() {\n- if (this._frontMatterDataCache) {\n- return this._frontMatterDataCache;\n- }\n+ if (!this._frontMatterDataCache) {\n+ this._frontMatterDataCache = new Promise(async (resolve, reject) => {\n+ try {\n+ let fm = await this.read();\n- if (!this.frontMatter) {\n- await this.read();\n- }\nlet extraData = await this.engine.getExtraDataFromFile(this.inputPath);\n- let data = TemplateData.mergeDeep({}, this.frontMatter.data, extraData);\n+ let data = TemplateData.mergeDeep({}, fm.data, extraData);\n+\nlet cleanedData = TemplateData.cleanupData(data);\n- this._frontMatterDataCache = cleanedData;\n- return cleanedData;\n+ resolve(cleanedData);\n+ } catch (e) {\n+ reject(e);\n+ }\n+ });\n+ }\n+\n+ return this._frontMatterDataCache;\n}\nasync getEngineOverride() {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -34,6 +34,10 @@ class TemplateLayout extends TemplateContent {\nreturn this.key;\n}\n+ getFullKey() {\n+ return TemplateLayout.resolveFullKey(this.dataKeyLayoutPath, this.inputDir);\n+ }\n+\ngetCacheKeys() {\nreturn new Set([this.dataKeyLayoutPath, this.key]);\n}\n@@ -48,18 +52,18 @@ class TemplateLayout extends TemplateContent {\n}\nlet fullKey = TemplateLayout.resolveFullKey(key, inputDir);\n- if (templateCache.has(fullKey)) {\n- debugDev(\"Found %o in TemplateCache\", key);\n- return templateCache.get(fullKey);\n- }\n-\n+ if (!templateCache.has(fullKey)) {\nlet layout = new TemplateLayout(key, inputDir, extensionMap, config);\n+\n+ templateCache.add(layout);\ndebugDev(\"Added %o to TemplateCache\", key);\n- templateCache.add(fullKey, layout);\nreturn layout;\n}\n+ return templateCache.get(fullKey);\n+ }\n+\nasync getTemplateLayoutMapEntry() {\nreturn {\nkey: this.dataKeyLayoutPath,\n@@ -73,28 +77,19 @@ class TemplateLayout extends TemplateContent {\nif (this.mapCache) {\nreturn this.mapCache;\n}\n+ // For both the eleventy.layouts event and cyclical layout chain checking (e.g., a => b => c => a)\n+ let layoutChain = new Set();\n+ layoutChain.add(this.inputPath);\nlet cfgKey = this.config.keys.layout;\nlet map = [];\nlet mapEntry = await this.getTemplateLayoutMapEntry();\n- map.push(mapEntry);\n- // Keep track of every layout we see so we can detect cyclical layout chains (e.g., a => b => c => a).\n- const seenLayoutKeys = new Set();\n- seenLayoutKeys.add(mapEntry.key);\n+ map.push(mapEntry);\nwhile (mapEntry.frontMatterData && cfgKey in mapEntry.frontMatterData) {\n// Layout of the current layout\n- const parentLayoutKey = mapEntry.frontMatterData[cfgKey];\n- // Abort if a circular layout chain is detected. Otherwise, we'll time out and run out of memory.\n- if (seenLayoutKeys.has(parentLayoutKey)) {\n- throw new Error(\n- `Your layouts have a circular reference, starting at ${map[0].key}! The layout ${parentLayoutKey} was specified twice in this layout chain.`\n- );\n- }\n-\n- // Keep track of this layout so we can detect duplicates in subsequent iterations\n- seenLayoutKeys.add(parentLayoutKey);\n+ let parentLayoutKey = mapEntry.frontMatterData[cfgKey];\nlet layout = TemplateLayout.getTemplate(\nparentLayoutKey,\n@@ -102,29 +97,40 @@ class TemplateLayout extends TemplateContent {\nthis.config,\nthis.extensionMap\n);\n+\n+ // Abort if a circular layout chain is detected. Otherwise, we'll time out and run out of memory.\n+ if (layoutChain.has(layout.inputPath)) {\n+ throw new Error(\n+ `Your layouts have a circular reference, starting at ${map[0].key}! The layout at ${layout.inputPath} was specified twice in this layout chain.`\n+ );\n+ }\n+\n+ // Keep track of this layout so we can detect duplicates in subsequent iterations\n+ layoutChain.add(layout.inputPath);\n+\n+ // reassign for next loop\nmapEntry = await layout.getTemplateLayoutMapEntry();\n+\nmap.push(mapEntry);\n}\n- this.mapCache = map;\n+ this.layoutChain = Array.from(layoutChain);\n+\nreturn map;\n}\nasync getLayoutChain() {\n- let map = await this.getTemplateLayoutMap();\n- let layoutChain = [];\n- for (let j = map.length - 1; j >= 0; j--) {\n- layoutChain.push(map[j].template.inputPath);\n- }\n- layoutChain.reverse();\n- return layoutChain;\n+ if (!Array.isArray(this.layoutChain)) {\n+ throw new Error(\"Layout chain not yet available for \" + this.inputPath);\n}\n- async getData() {\n- if (this.dataCache) {\n- return this.dataCache;\n+ return this.layoutChain;\n}\n+ async getData() {\n+ if (!this.dataCache) {\n+ this.dataCache = new Promise(async (resolve, reject) => {\n+ try {\nlet map = await this.getTemplateLayoutMap();\nlet dataToMerge = [];\nfor (let j = map.length - 1; j >= 0; j--) {\n@@ -135,23 +141,32 @@ class TemplateLayout extends TemplateContent {\nlet data = TemplateData.mergeDeep(this.config, {}, ...dataToMerge);\ndelete data[this.config.keys.layout];\n- this.dataCache = data;\n- return data;\n+ resolve(data);\n+ } catch (e) {\n+ reject(e);\n+ }\n+ });\n+ }\n+\n+ return this.dataCache;\n}\nasync getCompiledLayoutFunctions(layoutMap) {\nlet fns = [];\ntry {\nfor (let layoutEntry of layoutMap) {\n- fns.push(await layoutEntry.template.compile(await layoutEntry.template.getPreRender()));\n+ let rawInput = await layoutEntry.template.getPreRender();\n+\n+ fns.push({\n+ render: await layoutEntry.template.compile(rawInput),\n+ });\n}\n+ return fns;\n} catch (e) {\ndebugDev(\"Clearing TemplateCache after error.\");\ntemplateCache.clear();\nreturn Promise.reject(e);\n}\n-\n- return fns;\n}\nstatic augmentDataWithContent(data, templateContent) {\n@@ -167,18 +182,28 @@ class TemplateLayout extends TemplateContent {\n// Inefficient? We want to compile all the templatelayouts into a single reusable callback?\n// Trouble: layouts may need data variables present downstream/upstream\n+ // This is called from Template->renderPageEntry\nasync render(data, templateContent) {\ndata = TemplateLayout.augmentDataWithContent(data, templateContent);\nlet layoutMap = await this.getTemplateLayoutMap();\n- let fns = await this.getCompiledLayoutFunctions(layoutMap);\n- for (let fn of fns) {\n- templateContent = await fn(data);\n+\n+ let compiledFunctions = await this.getCompiledLayoutFunctions(layoutMap);\n+\n+ for (let { render } of compiledFunctions) {\n+ templateContent = await render(data);\ndata = TemplateLayout.augmentDataWithContent(data, templateContent);\n}\nreturn templateContent;\n}\n+\n+ resetCaches(types) {\n+ super.resetCaches(types);\n+\n+ delete this.dataCache;\n+ delete this.layoutChain;\n+ }\n}\nmodule.exports = TemplateLayout;\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -267,13 +267,14 @@ class TemplateWriter {\nisFullTemplate: isIncrementalFileAFullTemplate,\n})\n) {\n- // Related to the template but not the template (only reset the render cache)\n+ // Related to the template but not the template (reset the render cache, not the read cache)\ntmpl.resetCaches({\ndata: true,\nrender: true,\n});\n} else {\n// During incremental we only reset the data cache for non-matching templates, see https://github.com/11ty/eleventy/issues/2710\n+ // Keep caches for read/render\ntmpl.resetCaches({\ndata: true,\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateCacheTest.js", "new_path": "test/TemplateCacheTest.js", "diff": "const test = require(\"ava\");\n-const Template = require(\"../src/Template\");\nconst templateCache = require(\"../src/TemplateCache\");\nconst getNewTemplate = require(\"./_getNewTemplateForTests\");\n@@ -7,26 +6,18 @@ const getNewTemplate = require(\"./_getNewTemplateForTests\");\ntest(\"Cache can save templates\", (t) => {\ntemplateCache.clear();\n- let tmpl = getNewTemplate(\n- \"./test/stubs/template.ejs\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/template.ejs\", \"./test/stubs/\", \"./dist\");\n- templateCache.add(\"./test/stubs/template.ejs\", tmpl);\n+ templateCache.add(tmpl);\nt.is(templateCache.size(), 1);\n});\ntest(\"TemplateCache clear\", (t) => {\ntemplateCache.clear();\n- let tmpl = getNewTemplate(\n- \"./test/stubs/template.ejs\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/template.ejs\", \"./test/stubs/\", \"./dist\");\n- templateCache.add(\"./test/stubs/template.ejs\", tmpl);\n+ templateCache.add(tmpl);\nt.is(templateCache.size(), 1);\ntemplateCache.clear();\nt.is(templateCache.size(), 0);\n@@ -35,39 +26,32 @@ test(\"TemplateCache clear\", (t) => {\ntest(\"TemplateCache has\", (t) => {\ntemplateCache.clear();\n- let tmpl = getNewTemplate(\n- \"./test/stubs/template.ejs\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/template.ejs\", \"./test/stubs/\", \"./dist\");\n- templateCache.add(\"./test/stubs/template.ejs\", tmpl);\n- t.is(templateCache.has(\"./test/stubs/template.ejs\"), true);\n+ templateCache.add(tmpl);\n+ // Only TemplateLayout is cached\n+ t.is(templateCache.has(\"./test/stubs/template.ejs\"), false);\n});\ntest(\"TemplateCache get success\", (t) => {\ntemplateCache.clear();\n- let tmpl = getNewTemplate(\n- \"./test/stubs/template.ejs\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/template.ejs\", \"./test/stubs/\", \"./dist\");\n- templateCache.add(\"./test/stubs/template.ejs\", tmpl);\n- t.truthy(templateCache.get(\"./test/stubs/template.ejs\"));\n+ templateCache.add(tmpl);\n+\n+ // Only TemplateLayout is cached\n+ t.throws(() => {\n+ templateCache.get(\"./test/stubs/template.ejs\");\n+ });\n});\ntest(\"TemplateCache get fail\", (t) => {\ntemplateCache.clear();\n- let tmpl = getNewTemplate(\n- \"./test/stubs/template.ejs\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/template.ejs\", \"./test/stubs/\", \"./dist\");\n- templateCache.add(\"./test/stubs/template.ejs\", tmpl);\n+ templateCache.add(tmpl);\nt.throws(function () {\ntemplateCache.get(\"./test/stubs/template298374892.ejs\");\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateTest.js", "new_path": "test/TemplateTest.js", "diff": "@@ -1561,8 +1561,9 @@ test(\"Get Layout Chain\", async (t) => {\n);\nlet data = await tmpl.getData();\n+ let layout = tmpl.getLayout(data.layout);\n- t.deepEqual(await tmpl.getLayout(data.layout).getLayoutChain(), [\n+ t.deepEqual(await layout.getLayoutChain(), [\n\"./test/stubs-incremental/layout-chain/_includes/base.njk\",\n\"./test/stubs-incremental/layout-chain/_includes/parent.njk\",\n]);\n" } ]
JavaScript
MIT License
11ty/eleventy
Status commit for incremental layout rendering fixes
699
04.01.2023 17:14:50
21,600
5418022a8812c6933159e44b68a0931047b7679a
Another status
[ { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -66,17 +66,16 @@ class TemplateLayout extends TemplateContent {\nasync getTemplateLayoutMapEntry() {\nreturn {\n+ // Used by `getTemplate()`\nkey: this.dataKeyLayoutPath,\ninputDir: this.inputDir,\n- template: this,\n+\n+ // used by `getData()`\nfrontMatterData: await this.getFrontMatterData(),\n};\n}\nasync getTemplateLayoutMap() {\n- if (this.mapCache) {\n- return this.mapCache;\n- }\n// For both the eleventy.layouts event and cyclical layout chain checking (e.g., a => b => c => a)\nlet layoutChain = new Set();\nlayoutChain.add(this.inputPath);\n@@ -154,11 +153,19 @@ class TemplateLayout extends TemplateContent {\nasync getCompiledLayoutFunctions(layoutMap) {\nlet fns = [];\ntry {\n- for (let layoutEntry of layoutMap) {\n- let rawInput = await layoutEntry.template.getPreRender();\n+ for (let { key, inputDir } of layoutMap) {\n+ let layoutTemplate = TemplateLayout.getTemplate(\n+ key,\n+ inputDir,\n+ this.config,\n+ this.extensionMap\n+ );\n+\n+ let rawInput = await layoutTemplate.getPreRender();\n+ let renderFunction = await layoutTemplate.compile(rawInput);\nfns.push({\n- render: await layoutEntry.template.compile(rawInput),\n+ render: renderFunction,\n});\n}\nreturn fns;\n" } ]
JavaScript
MIT License
11ty/eleventy
Another status
699
05.01.2023 12:19:10
21,600
762014b8bb0ad5e0810b223eb830a099f8cae051
Fix bug with incremental missing collection nodes
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "@@ -131,11 +131,12 @@ class GlobalDependencyMap {\nreturn new Set();\n}\n- let prevDeps = this.getDependantsFor(node).map((entry) => {\n- if (entry.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\n+ let prevDeps = this.getDependantsFor(node)\n+ .filter((entry) => {\n+ return entry.startsWith(GlobalDependencyMap.COLLECTION_PREFIX);\n+ })\n+ .map((entry) => {\nreturn GlobalDependencyMap.getEntryFromCollectionKey(entry);\n- }\n- return entry;\n});\nlet prevDepsSet = new Set(prevDeps);\n@@ -167,7 +168,11 @@ class GlobalDependencyMap {\ngetTemplatesThatConsumeCollections(collectionNames) {\nlet templates = new Set();\nfor (let name of collectionNames) {\n- for (let node of this.map.dependantsOf(GlobalDependencyMap.getCollectionKeyForEntry(name))) {\n+ let collectionName = GlobalDependencyMap.getCollectionKeyForEntry(name);\n+ if (!this.map.hasNode(collectionName)) {\n+ continue;\n+ }\n+ for (let node of this.map.dependantsOf(collectionName)) {\nif (!node.startsWith(GlobalDependencyMap.COLLECTION_PREFIX)) {\ntemplates.add(node);\n}\n@@ -190,13 +195,11 @@ class GlobalDependencyMap {\nreturn true;\n}\n- // filter out layouts\n+ // When includeLayouts is `false` we want to filter out layouts\nlet data = this.map.getNodeData(node);\n- if (data && data.type) {\n- if (data.type === \"layout\") {\n+ if (data && data.type && data.type === \"layout\") {\nreturn false;\n}\n- }\nreturn true;\n});\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Fix bug with incremental missing collection nodes
699
05.01.2023 13:25:40
21,600
b9d83d0e6f2409c2490772265bec2c6b0d233550
Unskip a test, it works now
[ { "change_type": "MODIFY", "old_path": "test/TemplateTest_Permalink.js", "new_path": "test/TemplateTest_Permalink.js", "diff": "@@ -9,9 +9,7 @@ async function writeMapEntries(mapEntries) {\nlet promises = [];\nfor (let entry of mapEntries) {\nif (entry.template.behavior.isWriteable()) {\n- promises.push(\n- entry.template._write(entry.outputPath, entry.templateContent)\n- );\n+ promises.push(entry.template._write(entry.outputPath, entry.templateContent));\n}\n}\nreturn Promise.all(promises);\n@@ -25,9 +23,7 @@ async function getTemplateMapEntriesWithContent(template, data) {\nentry._pages = await entry.template.getTemplates(entry.data);\nawait Promise.all(\nentry._pages.map(async (page) => {\n- page.templateContent = await page.template.renderWithoutLayout(\n- page.data\n- );\n+ page.templateContent = await page.template.renderWithoutLayout(page.data);\nreturn page;\n})\n);\n@@ -61,10 +57,7 @@ test(\"permalink: false\", async (t) => {\n// Output does not exist\nt.is(fs.existsSync(\"./test/stubs/_site/permalink-false/\"), false);\nt.is(fs.existsSync(\"./test/stubs/_site/permalink-false/test/\"), false);\n- t.is(\n- fs.existsSync(\"./test/stubs/_site/permalink-false/test/index.html\"),\n- false\n- );\n+ t.is(fs.existsSync(\"./test/stubs/_site/permalink-false/test/index.html\"), false);\n});\ntest(\"permalink: false inside of eleventyComputed, Issue #1754\", async (t) => {\n@@ -89,16 +82,8 @@ test(\"permalink: false inside of eleventyComputed, Issue #1754\", async (t) => {\n// Output does not exist\nt.is(fs.existsSync(\"./test/stubs/_site/permalink-false-computed/\"), false);\n- t.is(\n- fs.existsSync(\"./test/stubs/_site/permalink-false-computed/test/\"),\n- false\n- );\n- t.is(\n- fs.existsSync(\n- \"./test/stubs/_site/permalink-false-computed/test/index.html\"\n- ),\n- false\n- );\n+ t.is(fs.existsSync(\"./test/stubs/_site/permalink-false-computed/test/\"), false);\n+ t.is(fs.existsSync(\"./test/stubs/_site/permalink-false-computed/test/index.html\"), false);\n});\ntest(\"permalink: true\", async (t) => {\n@@ -127,32 +112,20 @@ test(\"Disable dynamic permalinks\", async (t) => {\n});\ntest(\"Permalink with variables!\", async (t) => {\n- let tmpl = getNewTemplate(\n- \"./test/stubs/permalinkdata.njk\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/permalinkdata.njk\", \"./test/stubs/\", \"./dist\");\nlet data = await tmpl.getData();\n- t.is(\n- await tmpl.getOutputPath(data),\n- \"./dist/subdir/slug-candidate/index.html\"\n- );\n+ t.is(await tmpl.getOutputPath(data), \"./dist/subdir/slug-candidate/index.html\");\n});\ntest(\"Permalink with variables and JS front matter!\", async (t) => {\n- let tmpl = getNewTemplate(\n- \"./test/stubs/permalinkdata-jsfn.njk\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/permalinkdata-jsfn.njk\", \"./test/stubs/\", \"./dist\");\nlet data = await tmpl.getData();\nt.is(await tmpl.getOutputPath(data), \"./dist/subdir/slug/index.html\");\n});\n-// This is broken right now, permalink must use the same template language as the template\n-test.skip(\"Use a JavaScript function for permalink in any template language\", async (t) => {\n+test(\"Use a JavaScript function for permalink in any template language\", async (t) => {\nlet tmpl = getNewTemplate(\n\"./test/stubs/permalinkdata-jspermalinkfn.njk\",\n\"./test/stubs/\",\n@@ -164,11 +137,7 @@ test.skip(\"Use a JavaScript function for permalink in any template language\", as\n});\ntest(\"Permalink with dates!\", async (t) => {\n- let tmpl = getNewTemplate(\n- \"./test/stubs/permalinkdate.liquid\",\n- \"./test/stubs/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/stubs/permalinkdate.liquid\", \"./test/stubs/\", \"./dist\");\nlet data = await tmpl.getData();\nt.is(await tmpl.getOutputPath(data), \"./dist/2016/01/01/index.html\");\n});\n@@ -197,24 +166,13 @@ test(\"Reuse permalink in directory specific data file\", async (t) => {\n});\ntest(\"Using slugify filter!\", async (t) => {\n- let tmpl = getNewTemplate(\n- \"./test/slugify-filter/test.njk\",\n- \"./test/slugify-filter/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/slugify-filter/test.njk\", \"./test/slugify-filter/\", \"./dist\");\nlet data = await tmpl.getData();\n- t.is(\n- await tmpl.getOutputPath(data),\n- \"./dist/subdir/slug-love-candidate-lyublyu/index.html\"\n- );\n+ t.is(await tmpl.getOutputPath(data), \"./dist/subdir/slug-love-candidate-lyublyu/index.html\");\n});\ntest(\"Using slugify filter with comma and apostrophe\", async (t) => {\n- let tmpl = getNewTemplate(\n- \"./test/slugify-filter/comma.njk\",\n- \"./test/slugify-filter/\",\n- \"./dist\"\n- );\n+ let tmpl = getNewTemplate(\"./test/slugify-filter/comma.njk\", \"./test/slugify-filter/\", \"./dist\");\nlet data = await tmpl.getData();\nt.is(await tmpl.getOutputPath(data), \"./dist/subdir/hi-i-m-zach/index.html\");\n});\n" } ]
JavaScript
MIT License
11ty/eleventy
Unskip a test, it works now
699
06.01.2023 10:18:29
21,600
c904d26e6f0bad2bc484ba3a05c5f00f4a1d82b5
Some more tweaks after deep diving into
[ { "change_type": "MODIFY", "old_path": "src/GlobalDependencyMap.js", "new_path": "src/GlobalDependencyMap.js", "diff": "const { DepGraph } = require(\"dependency-graph\");\nconst { TemplatePath } = require(\"@11ty/eleventy-utils\");\n+const debug = require(\"debug\")(\"Eleventy:Dependencies\");\nconst PathNormalizer = require(\"./Util/PathNormalizer.js\");\nconst eventBus = require(\"./EventBus.js\");\n@@ -60,6 +61,9 @@ class GlobalDependencyMap {\nfor (let pageTemplate of layouts[rawLayout]) {\nthis.addDependency(pageTemplate, [layout]);\n+\n+ // Potential improvement: only add the first template in the chain for a template and manage any upstream layouts by their own relationships\n+ break;\n}\n}\n}\n@@ -214,6 +218,8 @@ class GlobalDependencyMap {\nthrow new Error(\"Second argument to `addDependency` must be an Array.\");\n}\n+ // debug(\"%o depends on %o\", from, toArray);\n+\nfor (let to of toArray) {\nif (!this.map.hasNode(to)) {\nthis.map.addNode(to);\n@@ -240,9 +246,9 @@ class GlobalDependencyMap {\n}\naddDependencyConsumesCollection(from, collectionName) {\n- this._addDependency(this.normalizeNode(from), [\n- GlobalDependencyMap.getCollectionKeyForEntry(collectionName),\n- ]);\n+ let nodeName = this.normalizeNode(from);\n+ debug(\"%o depends on collection: %o\", nodeName, collectionName);\n+ this._addDependency(nodeName, [GlobalDependencyMap.getCollectionKeyForEntry(collectionName)]);\n}\naddDependencyPublishesToCollection(from, collectionName) {\n" } ]
JavaScript
MIT License
11ty/eleventy
Some more tweaks after deep diving into #2710
699
06.01.2023 12:03:49
21,600
de9b478e435e50a71616b58835ef1730e6068a2d
Fix Layout chain not yet available error
[ { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -130,7 +130,7 @@ class TemplateLayout extends TemplateContent {\nasync getLayoutChain() {\nif (!Array.isArray(this.layoutChain)) {\n- throw new Error(\"Layout chain not yet available for \" + this.inputPath);\n+ await this.getTemplateLayoutMap();\n}\nreturn this.layoutChain;\n" } ]
JavaScript
MIT License
11ty/eleventy
Fix Layout chain not yet available error
699
06.01.2023 14:25:04
21,600
ce7fe13468473a98f16b1e9b9f1ecd1315d98588
Adds `--initial` to run initial build on incremental
[ { "change_type": "MODIFY", "old_path": "cmd.js", "new_path": "cmd.js", "diff": "@@ -17,24 +17,8 @@ try {\nlet errorHandler = new EleventyErrorHandler();\nconst EleventyCommandCheckError = require(\"./src/EleventyCommandCheckError\");\nconst argv = require(\"minimist\")(process.argv.slice(2), {\n- string: [\n- \"input\",\n- \"output\",\n- \"formats\",\n- \"config\",\n- \"pathprefix\",\n- \"port\",\n- \"to\",\n- ],\n- boolean: [\n- \"quiet\",\n- \"version\",\n- \"watch\",\n- \"dryrun\",\n- \"help\",\n- \"serve\",\n- \"incremental\",\n- ],\n+ string: [\"input\", \"output\", \"formats\", \"config\", \"pathprefix\", \"port\", \"to\"],\n+ boolean: [\"quiet\", \"version\", \"watch\", \"dryrun\", \"help\", \"serve\", \"incremental\", \"initial\"],\ndefault: {\nquiet: null,\n},\n@@ -55,10 +39,7 @@ try {\nerrorHandler.fatal(error, \"Uncaught exception\");\n});\nprocess.on(\"rejectionHandled\", (promise) => {\n- errorHandler.warn(\n- promise,\n- \"A promise rejection was handled asynchronously\"\n- );\n+ errorHandler.warn(promise, \"A promise rejection was handled asynchronously\");\n});\nif (argv.version) {\n@@ -83,7 +64,7 @@ try {\n}\nelev.setDryRun(argv.dryrun);\n- elev.setIncrementalBuild(argv.incremental);\n+ elev.setIncrementalBuild(argv.incremental, argv.initial);\nelev.setFormats(argv.formats);\nif (argv.serve) {\n" }, { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -87,6 +87,10 @@ class Template extends TemplateContent {\nthis._logger = logger;\n}\n+ setRenderableOverride(renderableOverride) {\n+ this.behavior.setRenderableOverride(renderableOverride);\n+ }\n+\nreset() {\nthis.writeCount = 0;\n}\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateBehavior.js", "new_path": "src/TemplateBehavior.js", "diff": "@@ -12,9 +12,13 @@ class TemplateBehavior {\nthis.config = config;\n}\n+ setRenderableOverride(renderableOverride) {\n+ this.renderableOverride = renderableOverride;\n+ }\n+\n// permalink *has* a build key or output is json/ndjson\nisRenderable() {\n- return this.render || this.isRenderForced();\n+ return this.renderableOverride ?? (this.render || this.isRenderForced());\n}\nsetOutputFormat(format) {\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -203,6 +203,13 @@ class TemplateWriter {\n};\n}\n+ _setTemplateRenderOverride(tmpl, value) {\n+ // Render overrides are only used when `--initial` is not in play and an initial build is not run during incremental use\n+ if (this.isIncremental && !this.isIncrementalInitialBuild) {\n+ tmpl.setRenderableOverride(value);\n+ }\n+ }\n+\nasync _addToTemplateMap(paths, to = \"fs\") {\nlet promises = [];\n@@ -221,6 +228,7 @@ class TemplateWriter {\nif (wasCached) {\ntmpl.resetCaches(); // reset internal caches on the cached template instance\n}\n+ this._setTemplateRenderOverride(tmpl, undefined); // no override (enabled)\nlet p = this.templateMap.add(tmpl);\npromises.push(p);\n@@ -253,6 +261,8 @@ class TemplateWriter {\nlet { template: tmpl, wasCached } = this._createTemplate(path, to);\nif (!this.incrementalFile) {\n+ this._setTemplateRenderOverride(tmpl, false); // disable rendering on all files for initial build\n+\nif (wasCached) {\ntmpl.resetCaches();\n}\n@@ -272,6 +282,8 @@ class TemplateWriter {\ndata: true,\nrender: true,\n});\n+\n+ this._setTemplateRenderOverride(tmpl, undefined); // no override (enabled)\n} else {\n// During incremental we only reset the data cache for non-matching templates, see https://github.com/11ty/eleventy/issues/2710\n// Keep caches for read/render\n@@ -279,6 +291,7 @@ class TemplateWriter {\ndata: true,\n});\n+ this._setTemplateRenderOverride(tmpl, false); // disabled\ntmpl.setDryRunViaIncremental();\nthis.skippedCount++;\n}\n@@ -412,6 +425,10 @@ class TemplateWriter {\nthis.eleventyFiles.getPassthroughManager().setDryRun(this.isDryRun);\n}\n+ setIncrementalBuild(isIncremental, runInitialBuild) {\n+ this.isIncremental = isIncremental;\n+ this.isIncrementalInitialBuild = runInitialBuild;\n+ }\nsetIncrementalFile(incrementalFile) {\nthis.incrementalFile = incrementalFile;\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Adds `--initial` to run initial build on incremental
699
06.01.2023 14:51:04
21,600
ad24276b7a46a3e14b40b6fb8ee881712c335e54
Swap to `--ignore-initial` and make it work with and without incremental. Fixes
[ { "change_type": "MODIFY", "old_path": "cmd.js", "new_path": "cmd.js", "diff": "@@ -18,9 +18,19 @@ try {\nconst EleventyCommandCheckError = require(\"./src/EleventyCommandCheckError\");\nconst argv = require(\"minimist\")(process.argv.slice(2), {\nstring: [\"input\", \"output\", \"formats\", \"config\", \"pathprefix\", \"port\", \"to\"],\n- boolean: [\"quiet\", \"version\", \"watch\", \"dryrun\", \"help\", \"serve\", \"incremental\", \"initial\"],\n+ boolean: [\n+ \"quiet\",\n+ \"version\",\n+ \"watch\",\n+ \"dryrun\",\n+ \"help\",\n+ \"serve\",\n+ \"incremental\",\n+ \"ignore-initial\",\n+ ],\ndefault: {\nquiet: null,\n+ \"ignore-initial\": false,\n},\nunknown: function (unknownArgument) {\nthrow new EleventyCommandCheckError(\n@@ -64,7 +74,8 @@ try {\n}\nelev.setDryRun(argv.dryrun);\n- elev.setIncrementalBuild(argv.incremental, argv.initial);\n+ elev.setIgnoreInitial(argv[\"ignore-initial\"]);\n+ elev.setIncrementalBuild(argv.incremental);\nelev.setFormats(argv.formats);\nif (argv.serve) {\n" }, { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -184,7 +184,7 @@ class Eleventy {\nthis.fileSystemSearch = new FileSystemSearch();\nthis.isIncremental = false;\n- this.isIncrementalInitialBuild = false;\n+ this.isRunInitialBuild = true;\n}\ngetNewTimestamp() {\n@@ -234,11 +234,20 @@ class Eleventy {\n* @method\n* @param {Boolean} isIncremental - Shall Eleventy run in incremental build mode and only write the files that trigger watch updates\n*/\n- setIncrementalBuild(isIncremental, runInitialBuild) {\n+ setIncrementalBuild(isIncremental) {\nthis.isIncremental = !!isIncremental;\nthis.watchManager.incremental = !!isIncremental;\n+ }\n- this.isIncrementalInitialBuild = runInitialBuild;\n+ /**\n+ * Set whether or not to do an initial build\n+ *\n+ * @method\n+ * @param {Boolean} ignoreInitialBuild - Shall Eleventy ignore the default initial build before watching in watch/serve mode?\n+ * @default true\n+ */\n+ setIgnoreInitial(ignoreInitialBuild) {\n+ this.isRunInitialBuild = !ignoreInitialBuild;\n}\n/**\n@@ -414,7 +423,9 @@ class Eleventy {\nthis.writer.logger = this.logger;\nthis.writer.extensionMap = this.extensionMap;\nthis.writer.setEleventyFiles(this.eleventyFiles);\n- this.writer.setIncrementalBuild(this.isIncremental, this.isIncrementalInitialBuild);\n+\n+ this.writer.setRunInitialBuild(this.isRunInitialBuild);\n+ this.writer.setIncrementalBuild(this.isIncremental);\nlet dirs = {\ninput: this.inputDir,\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -43,6 +43,7 @@ class TemplateWriter {\nthis.isDryRun = false;\nthis.writeCount = 0;\nthis.skippedCount = 0;\n+ this.runInitialBuild = true;\nthis._templatePathCache = new Map();\n}\n@@ -203,13 +204,6 @@ class TemplateWriter {\n};\n}\n- _setTemplateRenderOverride(tmpl, value) {\n- // Render overrides are only used when `--initial` is not in play and an initial build is not run during incremental use\n- if (this.isIncremental && !this.isIncrementalInitialBuild) {\n- tmpl.setRenderableOverride(value);\n- }\n- }\n-\nasync _addToTemplateMap(paths, to = \"fs\") {\nlet promises = [];\n@@ -228,7 +222,11 @@ class TemplateWriter {\nif (wasCached) {\ntmpl.resetCaches(); // reset internal caches on the cached template instance\n}\n- this._setTemplateRenderOverride(tmpl, undefined); // no override (enabled)\n+\n+ // Render overrides are only used when `--ignore-initial` is in play and an initial build is not run\n+ if (!this.isRunInitialBuild) {\n+ tmpl.setRenderableOverride(undefined); // reset to render enabled\n+ }\nlet p = this.templateMap.add(tmpl);\npromises.push(p);\n@@ -261,7 +259,14 @@ class TemplateWriter {\nlet { template: tmpl, wasCached } = this._createTemplate(path, to);\nif (!this.incrementalFile) {\n- this._setTemplateRenderOverride(tmpl, false); // disable rendering on all files for initial build\n+ // Render overrides are only used when `--ignore-initial` is in play and an initial build is not run\n+ if (!this.isRunInitialBuild) {\n+ if (wasCached) {\n+ tmpl.setRenderableOverride(undefined); // enable render\n+ } else {\n+ tmpl.setRenderableOverride(false); // disable render\n+ }\n+ }\nif (wasCached) {\ntmpl.resetCaches();\n@@ -283,7 +288,10 @@ class TemplateWriter {\nrender: true,\n});\n- this._setTemplateRenderOverride(tmpl, undefined); // no override (enabled)\n+ // Render overrides are only used when `--ignore-initial` is in play and an initial build is not run\n+ if (!this.isRunInitialBuild) {\n+ tmpl.setRenderableOverride(undefined); // reset to render enabled\n+ }\n} else {\n// During incremental we only reset the data cache for non-matching templates, see https://github.com/11ty/eleventy/issues/2710\n// Keep caches for read/render\n@@ -291,7 +299,11 @@ class TemplateWriter {\ndata: true,\n});\n- this._setTemplateRenderOverride(tmpl, false); // disabled\n+ // Render overrides are only used when `--ignore-initial` is in play and an initial build is not run\n+ if (!this.isRunInitialBuild) {\n+ tmpl.setRenderableOverride(false); // false to disable render\n+ }\n+\ntmpl.setDryRunViaIncremental();\nthis.skippedCount++;\n}\n@@ -425,9 +437,11 @@ class TemplateWriter {\nthis.eleventyFiles.getPassthroughManager().setDryRun(this.isDryRun);\n}\n- setIncrementalBuild(isIncremental, runInitialBuild) {\n+ setRunInitialBuild(runInitialBuild) {\n+ this.isRunInitialBuild = runInitialBuild;\n+ }\n+ setIncrementalBuild(isIncremental) {\nthis.isIncremental = isIncremental;\n- this.isIncrementalInitialBuild = runInitialBuild;\n}\nsetIncrementalFile(incrementalFile) {\nthis.incrementalFile = incrementalFile;\n" } ]
JavaScript
MIT License
11ty/eleventy
Swap to `--ignore-initial` and make it work with and without incremental. Fixes #1336
699
06.01.2023 15:01:38
21,600
9f7c3295e06c9029ba2fc894bbf8cc5a8f2a14e3
Help text addition for
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -646,6 +646,9 @@ Arguments:\n--watch\nWait for files to change and automatically rewrite (no web server)\n+ --ignore-initial\n+ Start without a build; build when files change. Works best with watch/serve/incremental.\n+\n--formats=liquid,md\nWhitelist only certain template types (default: \\`*\\`)\n" } ]
JavaScript
MIT License
11ty/eleventy
Help text addition for https://github.com/11ty/eleventy/issues/1336
699
09.01.2023 12:37:51
21,600
b5fc1c350907e8ca367d6d41e7a52222c6d371d5
Adds `singleTemplateScope` option to serverless to slow-roll collections-friendly serverless builds
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -184,6 +184,7 @@ class Eleventy {\nthis.fileSystemSearch = new FileSystemSearch();\nthis.isIncremental = false;\n+ this.programmaticApiIncrementalFile = undefined;\nthis.isRunInitialBuild = true;\n}\n@@ -599,6 +600,23 @@ Verbose Output: ${this.verboseMode}`);\nthis.runMode = runMode;\n}\n+ /**\n+ * Set the file that needs to be rendered/compiled/written for an incremental build.\n+ * This method is part of the programmatic API and is not used internally.\n+ *\n+ * @method\n+ * @param {String} incrementalFile - File path (added or modified in a project)\n+ */\n+ setIncrementalFile(incrementalFile) {\n+ if (incrementalFile) {\n+ // This is used for collections-friendly serverless mode.\n+ this.setIgnoreInitial(true);\n+ this.setIncrementalBuild(true);\n+\n+ this.programmaticApiIncrementalFile = incrementalFile;\n+ }\n+ }\n+\n/**\n* Reads the version of Eleventy.\n*\n@@ -712,13 +730,6 @@ Arguments:\nthis.watchManager.addToPendingQueue(changedFilePath);\n}\n- // Testing\n- _setIncrementalFile(incrementalFile) {\n- if (incrementalFile) {\n- this.writer.setIncrementalFile(incrementalFile);\n- }\n- }\n-\n_shouldResetConfig() {\nlet configFilePaths = this.eleventyConfig.getLocalProjectConfigFiles();\nlet configFilesChanged = this.watchManager.hasQueuedFiles(configFilePaths);\n@@ -1151,6 +1162,10 @@ Arguments:\n);\n}\n+ if (this.programmaticApiIncrementalFile) {\n+ this.writer.setIncrementalFile(this.programmaticApiIncrementalFile);\n+ }\n+\nlet ret;\nlet hasError = false;\n" }, { "change_type": "MODIFY", "old_path": "test/EleventyTest.js", "new_path": "test/EleventyTest.js", "diff": "@@ -628,7 +628,7 @@ ${previousContents}\n// Trigger that the file has changed\neventBus.emit(\"eleventy.resourceModified\", includeFilePath);\n- elev._setIncrementalFile(includeFilePath);\n+ elev.setIncrementalFile(includeFilePath);\nlet results3 = await elev.toJSON();\nt.is(\n" } ]
JavaScript
MIT License
11ty/eleventy
Adds `singleTemplateScope` option to serverless to slow-roll collections-friendly serverless builds
699
09.01.2023 14:42:55
21,600
44327de59b0ae7416c454b1fdac1334fd3fb739e
Copy input folder to serverless bundle
[ { "change_type": "ADD", "old_path": null, "new_path": "src/Util/DirContains.js", "diff": "+const path = require(\"path\");\n+\n+// Returns true if subfolder is in parent (accepts absolute or relative paths for both)\n+module.exports = function (parent, subfolder) {\n+ if (path.resolve(subfolder).startsWith(path.resolve(parent))) {\n+ return true;\n+ }\n+ return false;\n+};\n" }, { "change_type": "ADD", "old_path": null, "new_path": "test/DirContainsTest.js", "diff": "+const test = require(\"ava\");\n+const DirContains = require(\"../src/Util/DirContains.js\");\n+\n+test(\"Compare to current dir\", (t) => {\n+ t.true(DirContains(\".\", \".\"));\n+ t.false(DirContains(\".\", \"..\"));\n+ t.true(DirContains(\".\", \"test\"));\n+ t.true(DirContains(\".\", \"./test\"));\n+ t.false(DirContains(\".\", \"../test\"));\n+});\n+\n+test(\"Compare to parent dir\", (t) => {\n+ t.true(DirContains(\"..\", \".\"));\n+ t.true(DirContains(\"..\", \"..\"));\n+ t.false(DirContains(\"..\", \"../..\"));\n+ t.true(DirContains(\"..\", \"test\"));\n+ t.true(DirContains(\"..\", \"./test\"));\n+ t.true(DirContains(\"..\", \"../test\"));\n+});\n+\n+test(\"Compare to subfolder\", (t) => {\n+ t.false(DirContains(\"test\", \".\"));\n+ t.false(DirContains(\"test\", \"..\"));\n+ t.false(DirContains(\"test\", \"../..\"));\n+ t.true(DirContains(\"test\", \"test\"));\n+ t.true(DirContains(\"test\", \"./test\"));\n+ t.false(DirContains(\"test\", \"../test\"));\n+});\n+\n+test(\"Compare to subfolder dot slash\", (t) => {\n+ t.false(DirContains(\"./test\", \".\"));\n+ t.false(DirContains(\"./test\", \"..\"));\n+ t.false(DirContains(\"./test\", \"../..\"));\n+ t.true(DirContains(\"./test\", \"test\"));\n+ t.true(DirContains(\"./test\", \"./test\"));\n+ t.false(DirContains(\"./test\", \"../test\"));\n+});\n+\n+test(\"Compare to sibling folder\", (t) => {\n+ t.false(DirContains(\"../test\", \".\"));\n+ t.false(DirContains(\"../test\", \"..\"));\n+ t.false(DirContains(\"../test\", \"../..\"));\n+ t.false(DirContains(\"../test\", \"test\"));\n+ t.false(DirContains(\"../test\", \"./test\"));\n+ t.true(DirContains(\"../test\", \"../test\"));\n+ t.true(DirContains(\"../test\", \"../test/sub1\"));\n+});\n" } ]
JavaScript
MIT License
11ty/eleventy
Copy input folder to serverless bundle
699
10.01.2023 11:54:51
21,600
6de93363b80eeed226bf2b29729708c896dd2a0c
Combine file extension globs for template/data files
[ { "change_type": "MODIFY", "old_path": "src/EleventyExtensionMap.js", "new_path": "src/EleventyExtensionMap.js", "diff": "@@ -32,9 +32,7 @@ class EleventyExtensionMap {\nthis.hasExtension(key)\n);\n- this.passthroughCopyKeys = this.unfilteredFormatKeys.filter(\n- (key) => !this.hasExtension(key)\n- );\n+ this.passthroughCopyKeys = this.unfilteredFormatKeys.filter((key) => !this.hasExtension(key));\n}\nset config(cfg) {\n@@ -152,16 +150,24 @@ class EleventyExtensionMap {\n_getGlobs(formatKeys, inputDir) {\nlet dir = TemplatePath.convertToRecursiveGlobSync(inputDir);\n- let globs = [];\n+ let extensions = [];\nfor (let key of formatKeys) {\nif (this.hasExtension(key)) {\nfor (let extension of this.getExtensionsFromKey(key)) {\n- globs.push(dir + \"/*.\" + extension);\n+ extensions.push(extension);\n}\n} else {\n- globs.push(dir + \"/*.\" + key);\n+ extensions.push(key);\n}\n}\n+\n+ let globs = [];\n+ if (extensions.length === 1) {\n+ globs.push(`${dir}/*.${extensions[0]}`);\n+ } else if (extensions.length > 1) {\n+ globs.push(`${dir}/*.{${extensions.join(\",\")}}`);\n+ }\n+\nreturn globs;\n}\n@@ -219,9 +225,7 @@ class EleventyExtensionMap {\nif (path === extension || path.endsWith(\".\" + extension)) {\nreturn path.slice(\n0,\n- path.length - 1 - extension.length < 0\n- ? 0\n- : path.length - 1 - extension.length\n+ path.length - 1 - extension.length < 0 ? 0 : path.length - 1 - extension.length\n);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "test/EleventyExtensionMapTest.js", "new_path": "test/EleventyExtensionMapTest.js", "diff": "@@ -18,8 +18,8 @@ test(\"Single format\", (t) => {\n});\ntest(\"Multiple formats\", (t) => {\nlet map = getExtensionMap([\"njk\", \"pug\"]);\n- t.deepEqual(map.getGlobs(\".\"), [\"./**/*.njk\", \"./**/*.pug\"]);\n- t.deepEqual(map.getGlobs(\"src\"), [\"./src/**/*.njk\", \"./src/**/*.pug\"]);\n+ t.deepEqual(map.getGlobs(\".\"), [\"./**/*.{njk,pug}\"]);\n+ t.deepEqual(map.getGlobs(\"src\"), [\"./src/**/*.{njk,pug}\"]);\n});\ntest(\"Invalid keys are filtered (using passthrough copy)\", (t) => {\n@@ -29,7 +29,7 @@ test(\"Invalid keys are filtered (using passthrough copy)\", (t) => {\ntest(\"Keys are mapped to lower case\", (t) => {\nlet map = getExtensionMap([\"PUG\", \"NJK\"]);\n- t.deepEqual(map.getGlobs(\".\"), [\"./**/*.pug\", \"./**/*.njk\"]);\n+ t.deepEqual(map.getGlobs(\".\"), [\"./**/*.{pug,njk}\"]);\n});\ntest(\"Pruned globs\", (t) => {\n@@ -134,15 +134,7 @@ test(\"getKey\", (t) => {\n});\ntest(\"isFullTemplateFilePath (not a passthrough copy extension)\", (t) => {\n- let map = getExtensionMap([\n- \"liquid\",\n- \"njk\",\n- \"11ty.js\",\n- \"ejs\",\n- \"pug\",\n- \"js\",\n- \"css\",\n- ]);\n+ let map = getExtensionMap([\"liquid\", \"njk\", \"11ty.js\", \"ejs\", \"pug\", \"js\", \"css\"]);\nt.true(map.isFullTemplateFilePath(\"template.liquid\"));\nt.true(map.isFullTemplateFilePath(\"template.njk\"));\nt.true(map.isFullTemplateFilePath(\"template.11ty.js\"));\n@@ -162,16 +154,10 @@ test(\"getValidExtensionsForPath\", (t) => {\nlet map = getExtensionMap([\"liquid\", \"njk\", \"11ty.js\", \"js\"], cfg);\nt.deepEqual(map.getValidExtensionsForPath(\"template.liquid\"), [\"liquid\"]);\n- t.deepEqual(map.getValidExtensionsForPath(\"template.11ty.js\"), [\n- \"11ty.js\",\n- \"js\",\n- ]);\n+ t.deepEqual(map.getValidExtensionsForPath(\"template.11ty.js\"), [\"11ty.js\", \"js\"]);\nt.deepEqual(map.getValidExtensionsForPath(\"template.pug\"), []);\nt.deepEqual(map.getValidExtensionsForPath(\"template.liquid.js\"), [\"js\"]);\n- t.deepEqual(map.getValidExtensionsForPath(\"njk.liquid.11ty.js\"), [\n- \"11ty.js\",\n- \"js\",\n- ]);\n+ t.deepEqual(map.getValidExtensionsForPath(\"njk.liquid.11ty.js\"), [\"11ty.js\", \"js\"]);\n});\ntest(\"shouldSpiderJavaScriptDependencies\", (t) => {\n" }, { "change_type": "MODIFY", "old_path": "test/EleventyFilesTest.js", "new_path": "test/EleventyFilesTest.js", "diff": "@@ -137,7 +137,7 @@ test(\"Mutually exclusive Input and Output dirs\", async (t) => {\nevf.init();\nlet files = await fastglob(evf.getFileGlobs());\n- t.is(evf.getRawFiles().length, 2);\n+ t.deepEqual(evf.getRawFiles(), [\"./test/stubs/writeTest/**/*.{ejs,md}\"]);\nt.true(files.length > 0);\nt.is(files[0], \"./test/stubs/writeTest/test.md\");\n});\n@@ -286,9 +286,7 @@ test(\"Input to 'src' and empty includes dir (issue #403)\", (t) => {\nevf.init();\nt.deepEqual(evf.getFileGlobs(), [\n- \"./src/**/*.md\",\n- \"./src/**/*.liquid\",\n- \"./src/**/*.html\",\n+ \"./src/**/*.{md,liquid,html}\",\n// \"!./src/_includes/**\",\n// \"!./src/_site/**\",\n// \"!./src/_data/**\",\n@@ -385,9 +383,7 @@ test(\"Glob Watcher Files with Config Passthroughs (no template formats)\", async\nevf.init();\nt.deepEqual(await evf.getGlobWatcherTemplateDataFiles(), [\n- \"./test/stubs/**/*.json\",\n- \"./test/stubs/**/*.11tydata.cjs\",\n- \"./test/stubs/**/*.11tydata.js\",\n+ \"./test/stubs/**/*.{json,11tydata.cjs,11tydata.js}\",\n]);\n});\n" }, { "change_type": "MODIFY", "old_path": "test/EleventyTest.js", "new_path": "test/EleventyTest.js", "diff": "@@ -80,9 +80,7 @@ test(\"Eleventy file watching\", async (t) => {\n\"./.eleventy.js\",\n\"./eleventy.config.js\",\n\"./eleventy.config.cjs\",\n- \"./test/stubs/**/*.json\",\n- \"./test/stubs/**/*.11tydata.cjs\",\n- \"./test/stubs/**/*.11tydata.js\",\n+ \"./test/stubs/**/*.{json,11tydata.cjs,11tydata.js}\",\n\"./test/stubs/deps/dep1.js\",\n\"./test/stubs/deps/dep2.js\",\n]);\n@@ -119,9 +117,7 @@ test(\"Eleventy file watching (no JS dependencies)\", async (t) => {\n\"./.eleventy.js\",\n\"./eleventy.config.js\",\n\"./eleventy.config.cjs\",\n- \"./test/stubs/**/*.json\",\n- \"./test/stubs/**/*.11tydata.cjs\",\n- \"./test/stubs/**/*.11tydata.js\",\n+ \"./test/stubs/**/*.{json,11tydata.cjs,11tydata.js}\",\n]);\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateDataTest.js", "new_path": "test/TemplateDataTest.js", "diff": "@@ -136,14 +136,14 @@ test(\"Global Dir Directory\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./\", eleventyConfig);\n- t.deepEqual(await dataObj.getGlobalDataGlob(), [\"./_data/**/*.(json|cjs|js)\"]);\n+ t.deepEqual(await dataObj.getGlobalDataGlob(), [\"./_data/**/*.{json,cjs,js}\"]);\n});\ntest(\"Global Dir Directory with Constructor Path Arg\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\n- t.deepEqual(await dataObj.getGlobalDataGlob(), [\"./test/stubs/_data/**/*.(json|cjs|js)\"]);\n+ t.deepEqual(await dataObj.getGlobalDataGlob(), [\"./test/stubs/_data/**/*.{json,cjs,js}\"]);\n});\ntest(\"getAllGlobalData() with other data files\", async (t) => {\n@@ -482,9 +482,7 @@ test(\"getTemplateDataFileGlob\", async (t) => {\nlet tw = new TemplateData(\"test/stubs\", eleventyConfig);\nt.deepEqual(await tw.getTemplateDataFileGlob(), [\n- \"./test/stubs/**/*.json\",\n- \"./test/stubs/**/*.11tydata.cjs\",\n- \"./test/stubs/**/*.11tydata.js\",\n+ \"./test/stubs/**/*.{json,11tydata.cjs,11tydata.js}\",\n]);\n});\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateWriterTest.js", "new_path": "test/TemplateWriterTest.js", "diff": "@@ -30,7 +30,7 @@ test(\"Output is a subdir of input\", async (t) => {\nevf.init();\nlet files = await fastglob(evf.getFileGlobs());\n- t.is(evf.getRawFiles().length, 2);\n+ t.deepEqual(evf.getRawFiles(), [\"./test/stubs/writeTest/**/*.{ejs,md}\"]);\nt.true(files.length > 0);\nlet { template: tmpl } = tw._createTemplate(files[0]);\n@@ -531,10 +531,7 @@ test(\"Write Test 11ty.js\", async (t) => {\nevf.init();\nlet files = await fastglob(evf.getFileGlobs());\n- t.deepEqual(evf.getRawFiles(), [\n- \"./test/stubs/writeTestJS/**/*.11ty.js\",\n- \"./test/stubs/writeTestJS/**/*.11ty.cjs\",\n- ]);\n+ t.deepEqual(evf.getRawFiles(), [\"./test/stubs/writeTestJS/**/*.{11ty.js,11ty.cjs}\"]);\nt.deepEqual(files, [\"./test/stubs/writeTestJS/test.11ty.js\"]);\nlet { template: tmpl } = tw._createTemplate(files[0]);\n" }, { "change_type": "MODIFY", "old_path": "test/UserDataExtensionsTest.js", "new_path": "test/UserDataExtensionsTest.js", "diff": "@@ -81,7 +81,7 @@ test(\"Global data\", async (t) => {\ndataObj.setFileSystemSearch(new FileSystemSearch());\nt.deepEqual(await dataObj.getGlobalDataGlob(), [\n- \"./test/stubs-630/_data/**/*.(nosj|yaml|json|cjs|js)\",\n+ \"./test/stubs-630/_data/**/*.{nosj,yaml,json,cjs,js}\",\n]);\nlet data = await dataObj.getData();\n" } ]
JavaScript
MIT License
11ty/eleventy
Combine file extension globs for template/data files
699
10.01.2023 15:20:21
21,600
3225fc9c7861a5118c7ec27e53a9f181ef004e14
Make dataFilterSelectors apply to the eleventy.after argument too!
[ { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -724,7 +724,7 @@ class Template extends TemplateContent {\n}\n}\n- async _write({ url, outputPath }, finalContent) {\n+ async _write({ url, outputPath, data }, finalContent) {\nlet lang = {\nstart: \"Writing\",\nfinished: \"written.\",\n@@ -759,12 +759,18 @@ class Template extends TemplateContent {\nthis.writeCount++;\ndebug(`${outputPath} ${lang.finished}.`);\n- return {\n+ let ret = {\ninputPath: this.inputPath,\noutputPath: outputPath,\nurl,\ncontent: finalContent,\n};\n+\n+ if (data && this.config.dataFilterSelectors && this.config.dataFilterSelectors.size > 0) {\n+ ret.data = this.retrieveDataForJsonOutput(data, this.config.dataFilterSelectors);\n+ }\n+\n+ return ret;\n});\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Make dataFilterSelectors apply to the eleventy.after argument too!
699
10.01.2023 16:07:54
21,600
1ac69fcdc6527733867c9296591be3cd52fa8759
Simplify the render plugin code
[ { "change_type": "MODIFY", "old_path": "src/Plugins/RenderPlugin.js", "new_path": "src/Plugins/RenderPlugin.js", "diff": "@@ -13,11 +13,7 @@ const TemplateConfig = require(\"../TemplateConfig\");\nconst EleventyErrorUtil = require(\"../EleventyErrorUtil\");\nconst Liquid = require(\"../Engines/Liquid\");\n-async function compile(\n- content,\n- templateLang,\n- { templateConfig, extensionMap } = {}\n-) {\n+async function compile(content, templateLang, { templateConfig, extensionMap } = {}) {\nif (!templateConfig) {\ntemplateConfig = new TemplateConfig(null, false);\n}\n@@ -48,23 +44,14 @@ async function compile(\n}\n// No templateLang default, it should infer from the inputPath.\n-async function compileFile(\n- inputPath,\n- { templateConfig, extensionMap, config } = {},\n- templateLang\n-) {\n+async function compileFile(inputPath, { templateConfig, extensionMap, config } = {}, templateLang) {\nif (!inputPath) {\n- throw new Error(\n- \"Missing file path argument passed to the `renderFile` shortcode.\"\n- );\n+ throw new Error(\"Missing file path argument passed to the `renderFile` shortcode.\");\n}\n- if (\n- !fs.existsSync(TemplatePath.normalizeOperatingSystemFilePath(inputPath))\n- ) {\n+ if (!fs.existsSync(TemplatePath.normalizeOperatingSystemFilePath(inputPath))) {\nthrow new Error(\n- \"Could not find render plugin file for the `renderFile` shortcode, looking for: \" +\n- inputPath\n+ \"Could not find render plugin file for the `renderFile` shortcode, looking for: \" + inputPath\n);\n}\n@@ -95,9 +82,7 @@ async function renderShortcodeFn(fn, data) {\nif (fn === undefined) {\nreturn;\n} else if (typeof fn !== \"function\") {\n- throw new Error(\n- `The \\`compile\\` function did not return a function. Received ${fn}`\n- );\n+ throw new Error(`The \\`compile\\` function did not return a function. Received ${fn}`);\n}\n// if the user passes a string or other literal, remap to an object.\n@@ -210,10 +195,7 @@ function EleventyPlugin(eleventyConfig, options = {}) {\n// Exit when there's nothing to match\n// or when we've found the matching \"endraw\" block\n- while (\n- (matches = parser.tokens._extractRegex(rawBlockRegex)) &&\n- rawLevel > 0\n- ) {\n+ while ((matches = parser.tokens._extractRegex(rawBlockRegex)) && rawLevel > 0) {\nconst all = matches[0];\nconst pre = matches[1];\nconst blockName = matches[2];\n@@ -341,10 +323,7 @@ function EleventyPlugin(eleventyConfig, options = {}) {\n// Render strings\nif (opts.tagName) {\n// use falsy to opt-out\n- eleventyConfig.addJavaScriptFunction(\n- opts.tagName,\n- _renderStringShortcodeFn\n- );\n+ eleventyConfig.addJavaScriptFunction(opts.tagName, _renderStringShortcodeFn);\neleventyConfig.addLiquidTag(opts.tagName, function (liquidEngine) {\nreturn liquidTemplateTag(liquidEngine, opts.tagName);\n@@ -356,17 +335,9 @@ function EleventyPlugin(eleventyConfig, options = {}) {\n}\n// Render File\n- if (opts.tagNameFile) {\n// use `false` to opt-out\n- eleventyConfig.addJavaScriptFunction(\n- opts.tagNameFile,\n- _renderFileShortcodeFn\n- );\n- eleventyConfig.addLiquidShortcode(opts.tagNameFile, _renderFileShortcodeFn);\n- eleventyConfig.addNunjucksAsyncShortcode(\n- opts.tagNameFile,\n- _renderFileShortcodeFn\n- );\n+ if (opts.tagNameFile) {\n+ eleventyConfig.addAsyncShortcode(opts.tagNameFile, _renderFileShortcodeFn);\n}\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Simplify the render plugin code
699
10.01.2023 17:18:05
21,600
7f36250b35223f86491aeca142c2f786968b29f1
Helper for the eleventy-upgrade-help plugin
[ { "change_type": "MODIFY", "old_path": "src/UserConfig.js", "new_path": "src/UserConfig.js", "diff": "@@ -774,6 +774,7 @@ class UserConfig {\n}\nsetBrowserSyncConfig() {\n+ this._attemptedBrowserSyncUse = true;\ndebug(\n\"The `setBrowserSyncConfig` method was removed in Eleventy 2.0.0. Use `setServerOptions` with the new Eleventy development server or the `@11ty/eleventy-browser-sync` plugin moving forward.\"\n);\n" } ]
JavaScript
MIT License
11ty/eleventy
Helper for the eleventy-upgrade-help plugin
699
13.01.2023 15:00:54
21,600
2b2c14e9824a3341601def51fef729c6fec41c34
Updates to Eleventy Dev Server 1.0
[ { "change_type": "MODIFY", "old_path": "package.json", "new_path": "package.json", "diff": "},\n\"dependencies\": {\n\"@11ty/dependency-tree\": \"^2.0.1\",\n- \"@11ty/eleventy-dev-server\": \"^1.0.0-canary.14\",\n+ \"@11ty/eleventy-dev-server\": \"^1.0.0\",\n\"@11ty/eleventy-utils\": \"^1.0.1\",\n\"@iarna/toml\": \"^2.2.5\",\n\"@sindresorhus/slugify\": \"^1.1.2\",\n" }, { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -390,6 +390,8 @@ class Eleventy {\n// eleventyServe is always available, even when not in --serve mode\nthis.eleventyServe.setOutputDir(this.outputDir);\n+ // TODO\n+ // this.eleventyServe.setWatcherOptions(this.getChokidarConfig());\nthis.eleventyFiles = new EleventyFiles(\nthis.inputDir,\n@@ -403,6 +405,12 @@ class Eleventy {\nthis.eleventyFiles.extensionMap = this.extensionMap;\nthis.eleventyFiles.init();\n+ if (checkPassthroughCopyBehavior(this.config, this.runMode)) {\n+ this.eleventyServe.watchPassthroughCopy(\n+ this.eleventyFiles.getGlobWatcherFilesForPassthroughCopy()\n+ );\n+ }\n+\nthis.templateData = new TemplateData(this.inputDir, this.eleventyConfig);\nthis.templateData.extensionMap = this.extensionMap;\nif (this.env) {\n@@ -825,8 +833,6 @@ Arguments:\nfiles: this.watchManager.getActiveQueue(),\nsubtype: onlyCssChanges ? \"css\" : undefined,\nbuild: {\n- // For later?\n- // passthroughCopy: passthroughCopyResults,\ntemplates: templateResults\n.flat()\n.filter((entry) => !!entry)\n@@ -961,21 +967,6 @@ Arguments:\n);\n}\n- async triggerServerReload(changedFiles) {\n- let onlyApplyingCssChanges =\n- changedFiles.filter((entry) => entry.endsWith(\".css\")).length === changedFiles.length;\n-\n- // returns a promise\n- return this.eleventyServe.reload({\n- files: changedFiles,\n- subtype: onlyApplyingCssChanges ? \"css\" : undefined,\n- build: {\n- // As of right now this is only used for the passthrough copy watcher so templates are unnecessary\n- templates: [],\n- },\n- });\n- }\n-\n/**\n* Start the watching of files\n*\n@@ -1058,26 +1049,10 @@ Arguments:\n});\nwatcher.on(\"unlink\", (path) => {\n+ // this.logger.forceLog(`File removed: ${path}`);\nthis.fileSystemSearch.delete(path);\n});\n- if (checkPassthroughCopyBehavior(this.config, this.runMode)) {\n- // Separate watcher for passthrough copy, we only want to trigger a server reload for changes to these files\n- this.passthroughWatcher = chokidar.watch(\n- this.eleventyFiles.getGlobWatcherFilesForPassthroughCopy(),\n- this.getChokidarConfig()\n- );\n- this.passthroughWatcher.on(\"change\", async (path) => {\n- this.logger.forceLog(`Passthrough copy file changed: ${path}`);\n- this.triggerServerReload([path]);\n- });\n-\n- this.passthroughWatcher.on(\"add\", async (path) => {\n- this.logger.forceLog(`Passthrough copy file added: ${path}`);\n- this.triggerServerReload([path]);\n- });\n- }\n-\nprocess.on(\"SIGINT\", () => this.stopWatch());\n}\n@@ -1086,10 +1061,6 @@ Arguments:\nthis.eleventyServe.close();\nthis.watcher.close();\n- if (this.passthroughWatcher) {\n- this.passthroughWatcher.close();\n- }\n-\nprocess.exit();\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Updates to Eleventy Dev Server 1.0
699
13.01.2023 19:31:24
21,600
8aa7ed5331e3ac07a7353e9c9f3b0b3b344f2fb8
Fixes bug with changes to data files keeping old cached values.
[ { "change_type": "MODIFY", "old_path": "src/Template.js", "new_path": "src/Template.js", "diff": "@@ -53,10 +53,8 @@ class Template extends TemplateContent {\nthis.linters = [];\nthis.transforms = [];\n- this.templateData = templateData;\n- if (this.templateData) {\n- this.templateData.setInputDir(this.inputDir);\n- }\n+\n+ this.setTemplateData(templateData);\nthis.isVerbose = true;\nthis.isDryRun = false;\n@@ -74,6 +72,13 @@ class Template extends TemplateContent {\nthis.serverlessUrls = null;\n}\n+ setTemplateData(templateData) {\n+ this.templateData = templateData;\n+ if (this.templateData) {\n+ this.templateData.setInputDir(this.inputDir);\n+ }\n+ }\n+\nget logger() {\nif (!this._logger) {\nthis._logger = new ConsoleLogger();\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateData.js", "new_path": "src/TemplateData.js", "diff": "@@ -123,12 +123,6 @@ class TemplateData {\nthis.templateDirectoryData = {};\n}\n- async cacheData() {\n- this.clearData();\n-\n- return this.getData();\n- }\n-\n_getGlobalDataGlobByExtension(dir, extension) {\nreturn TemplateGlob.normalizePath(\ndir,\n" }, { "change_type": "MODIFY", "old_path": "src/TemplateWriter.js", "new_path": "src/TemplateWriter.js", "diff": "@@ -158,6 +158,8 @@ class TemplateWriter {\nlet wasCached = false;\nif (tmpl) {\nwasCached = true;\n+ // TODO reset other constructor things here like inputDir/outputDir/extensionMap/\n+ tmpl.setTemplateData(this.templateData);\n} else {\ntmpl = new Template(\npath,\n" } ]
JavaScript
MIT License
11ty/eleventy
Fixes bug with changes to data files keeping old cached values.
699
13.01.2023 20:41:43
21,600
e6db367a1094bfebde492a5c696d708c75a42e35
Fix tests, importantly global data is no longer fetched in empty projects. and TemplateData->getData renamed to getGlobalData
[ { "change_type": "MODIFY", "old_path": "src/TemplateData.js", "new_path": "src/TemplateData.js", "diff": "@@ -345,7 +345,7 @@ class TemplateData {\nreturn globalData;\n}\n- async getData() {\n+ async getGlobalData() {\nlet rawImports = this.getRawImports();\nif (!this.globalData) {\n@@ -418,10 +418,6 @@ class TemplateData {\nreturn this.templateDirectoryData[templatePath];\n}\n- async getGlobalData() {\n- return this.getData();\n- }\n-\ngetUserDataExtensions() {\nif (!this.config.dataExtensions) {\nreturn [];\n" }, { "change_type": "MODIFY", "old_path": "test/PaginationTest.js", "new_path": "test/PaginationTest.js", "diff": "@@ -160,7 +160,7 @@ test(\"Paginate external data file\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/paged/paged.njk\",\n@@ -366,7 +366,7 @@ test(\"Issue 135\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/issue-135/template.njk\",\n@@ -678,7 +678,7 @@ test(\"Pagination new v0.10.0 href/hrefs\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/paged/paged.njk\",\n@@ -708,7 +708,7 @@ test(\"Pagination new v0.10.0 page/pages\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/paged/paged.njk\",\n@@ -762,7 +762,7 @@ test(\"Pagination mutable global data\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/paged-global-data-mutable/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/paged-global-data-mutable/paged-differing-data-set.njk\",\n" }, { "change_type": "MODIFY", "old_path": "test/TemplateTest.js", "new_path": "test/TemplateTest.js", "diff": "@@ -369,7 +369,7 @@ test(\"Local template data file import (without a global data json)\", async (t) =\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/component/component.njk\",\n@@ -397,7 +397,7 @@ test(\"Local template data file import (two subdirectories deep)\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/firstdir/seconddir/component.njk\",\n@@ -430,7 +430,7 @@ test(\"Posts inherits local JSON, layouts\", async (t) => {\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\"./test/stubs/posts/post1.njk\", \"./test/stubs/\", \"./dist\", dataObj);\n@@ -470,7 +470,7 @@ test(\"Template and folder name are the same, make sure data imports work ok\", as\nlet eleventyConfig = new TemplateConfig();\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\"./test/stubs/posts/posts.njk\", \"./test/stubs/\", \"./dist\", dataObj);\n@@ -962,7 +962,7 @@ test(\"Data Cascade (Deep merge)\", async (t) => {\n// eleventyConfig.userConfig.setDataDeepMerge(true);\nlet dataObj = new TemplateData(\"./test/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/data-cascade/template.njk\",\n@@ -995,7 +995,7 @@ test(\"Data Cascade (Shallow merge)\", async (t) => {\neleventyConfig.userConfig.setDataDeepMerge(false);\nlet dataObj = new TemplateData(\"./test/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/data-cascade/template.njk\",\n@@ -1028,7 +1028,7 @@ test(\"Data Cascade Tag Merge (Deep merge)\", async (t) => {\n// eleventyConfig.userConfig.setDataDeepMerge(true);\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/data-cascade/template.njk\",\n@@ -1049,7 +1049,7 @@ test(\"Data Cascade Tag Merge (Deep Merge - Deduplication)\", async (t) => {\n// eleventyConfig.userConfig.setDataDeepMerge(true);\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/data-cascade/template.njk\",\n@@ -1070,7 +1070,7 @@ test(\"Data Cascade Tag Merge (Shallow merge)\", async (t) => {\neleventyConfig.userConfig.setDataDeepMerge(false);\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/data-cascade/template.njk\",\n@@ -1091,7 +1091,7 @@ test('Local data inherits tags string ([tags] vs \"tags\") Shallow Merge', async (\neleventyConfig.userConfig.setDataDeepMerge(false);\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/local-data-tags/component.njk\",\n@@ -1112,7 +1112,7 @@ test('Local data inherits tags string ([tags] vs \"tags\") Deep Merge', async (t)\n// eleventyConfig.userConfig.setDataDeepMerge(true);\nlet dataObj = new TemplateData(\"./test/stubs/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- await dataObj.cacheData();\n+ await dataObj.getGlobalData();\nlet tmpl = getNewTemplate(\n\"./test/stubs/local-data-tags/component.njk\",\n" }, { "change_type": "MODIFY", "old_path": "test/UserDataExtensionsTest.js", "new_path": "test/UserDataExtensionsTest.js", "diff": "@@ -18,7 +18,7 @@ test(\"Local data\", async (t) => {\ninjectDataExtensions(dataObj);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\n// YAML GLOBAL DATA\nt.is(data.globalData3.datakey1, \"datavalue3\");\n@@ -84,7 +84,7 @@ test(\"Global data\", async (t) => {\n\"./test/stubs-630/_data/**/*.{nosj,yaml,json,cjs,js}\",\n]);\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\n// JS GLOBAL DATA\nt.is(data.globalData0.datakey1, \"datavalue0\");\n@@ -113,7 +113,7 @@ test(\"Global data merging and priority\", async (t) => {\ninjectDataExtensions(dataObj);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\n// TESTING GLOBAL DATA PRIORITY AND MERGING\nt.is(data.mergingGlobalData.datakey0, \"js-value0\");\n@@ -151,7 +151,7 @@ test(\"Binary data files, encoding: null\", async (t) => {\n]);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\nt.is(data.images.dog, 43183);\n});\n@@ -177,7 +177,7 @@ test(\"Binary data files, read: false\", async (t) => {\n]);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\nt.is(data.images.dog, \"./test/stubs-2378/_data/images/dog.jpg\");\n});\n@@ -197,7 +197,7 @@ test(\"Binary data files, encoding: null (multiple data extensions)\", async (t) =\nlet dataObj = new TemplateData(\"./test/stubs-2378/\", eleventyConfig);\ndataObj.setFileSystemSearch(new FileSystemSearch());\n- let data = await dataObj.getData();\n+ let data = await dataObj.getGlobalData();\nt.is(data.images.dog, 43183);\nt.is(data.images.dogpng, 2890);\n});\n" }, { "change_type": "RENAME", "old_path": "test/stubs-noop/test.txt", "new_path": "test/stubs-addglobaldata-noop/test.txt", "diff": "" }, { "change_type": "ADD", "old_path": "test/stubs-addglobaldata/test.liquid", "new_path": "test/stubs-addglobaldata/test.liquid", "diff": "" }, { "change_type": "ADD", "old_path": "test/stubs/exitCode_globalData/test.liquid", "new_path": "test/stubs/exitCode_globalData/test.liquid", "diff": "" } ]
JavaScript
MIT License
11ty/eleventy
Fix tests, importantly global data is no longer fetched in empty projects. and TemplateData->getData renamed to getGlobalData
714
18.01.2023 08:08:39
18,000
baf7c733e51b27e38bfe281bda3643703ccdab3e
Replaces reject with throw For
[ { "change_type": "MODIFY", "old_path": "src/TemplateLayout.js", "new_path": "src/TemplateLayout.js", "diff": "@@ -208,7 +208,7 @@ class TemplateLayout extends TemplateContent {\n} catch (e) {\ndebugDev(\"Clearing TemplateCache after error.\");\ntemplateCache.clear();\n- reject(e);\n+ throw e;\n}\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Replaces reject with throw For #2749
699
19.01.2023 16:46:55
21,600
3810ccf7c9c5ab7a5759ab9f039f1b3b4a693613
Fixes by normalizing references for `.canary` to `.alpha`.
[ { "change_type": "MODIFY", "old_path": "src/UserConfig.js", "new_path": "src/UserConfig.js", "diff": "const chalk = require(\"kleur\");\n-const semver = require(\"semver\");\nconst { DateTime } = require(\"luxon\");\n+\nconst EventEmitter = require(\"./Util/AsyncEventEmitter\");\n+const EleventyCompatibility = require(\"./Util/Compatibility\");\nconst EleventyBaseError = require(\"./EleventyBaseError\");\nconst BenchmarkManager = require(\"./BenchmarkManager\");\nconst merge = require(\"./Util/Merge\");\n+\nconst debug = require(\"debug\")(\"Eleventy:UserConfig\");\n-const pkg = require(\"../package.json\");\nclass UserConfigError extends EleventyBaseError {}\n@@ -106,15 +107,12 @@ class UserConfig {\nthis.dataFileDirBaseNameOverride = false;\n}\n- versionCheck(expected) {\n- if (\n- !semver.satisfies(pkg.version, expected, {\n- includePrerelease: true,\n- })\n- ) {\n- throw new UserConfigError(\n- `This project requires the Eleventy version to match '${expected}' but found ${pkg.version}. Use \\`npm update @11ty/eleventy -g\\` to upgrade the eleventy global or \\`npm update @11ty/eleventy --save\\` to upgrade your local project version.`\n- );\n+ // compatibleRange is optional in 2.0.0-beta.2\n+ versionCheck(compatibleRange) {\n+ let compat = new EleventyCompatibility(compatibleRange);\n+\n+ if (!compat.isCompatible()) {\n+ throw new UserConfigError(compat.getErrorMessage());\n}\n}\n" } ]
JavaScript
MIT License
11ty/eleventy
Fixes #2758 by normalizing references for `.canary` to `.alpha`.
699
23.01.2023 17:17:07
21,600
2cb8ba22851ba7405ffb058e38cc7cda8c97c5a3
debug log ignores for glob search
[ { "change_type": "MODIFY", "old_path": "src/FileSystemSearch.js", "new_path": "src/FileSystemSearch.js", "diff": "@@ -32,6 +32,7 @@ class FileSystemSearch {\nif (options.ignore && Array.isArray(options.ignore)) {\noptions.ignore = options.ignore.map((entry) => TemplatePath.stripLeadingDotSlash(entry));\n+ debug(\"Glob search (%o) ignoring: %o\", key, options.ignore);\n}\nlet cacheKey = this.getCacheKey(key, globs, options);\n" } ]
JavaScript
MIT License
11ty/eleventy
debug log ignores for glob search
699
24.01.2023 11:11:40
21,600
99140d82c7844e53e611c4d875bcb0bf8715f2fe
Adds `runMode` to `eleventy` global data. Fixes
[ { "change_type": "MODIFY", "old_path": "src/Eleventy.js", "new_path": "src/Eleventy.js", "diff": "@@ -78,18 +78,23 @@ class Eleventy {\n* @member {Boolean} - Running in serverless mode\n* @default false\n*/\n-\n- // This needs to happen before `getEnvironmentVariableValues` below.\nif (\"isServerless\" in options) {\nthis.isServerless = !!options.isServerless;\n} else {\nthis.isServerless = !!process.env.AWS_LAMBDA_FUNCTION_NAME;\n}\n+ /**\n+ * @member {String} - One of build, serve, or watch\n+ * @default \"build\"\n+ */\n+ this.runMode = options.runMode || \"build\";\n+\n/**\n* @member {Object} - Initialize Eleventy environment variables\n* @default null\n*/\n+ // both this.isServerless and this.runMode need to be set before this\nthis.env = this.getEnvironmentVariableValues();\nthis.initializeEnvironmentVariables(this.env);\n@@ -109,12 +114,6 @@ class Eleventy {\n*/\nthis.verboseModeSetViaCommandLineParam = false;\n- /**\n- * @member {String} - One of build, serve, or watch\n- * @default \"build\"\n- */\n- this.runMode = \"build\";\n-\n/**\n* @member {Boolean} - Is Eleventy running in verbose mode?\n* @default true\n@@ -468,6 +467,7 @@ Verbose Output: ${this.verboseMode}`);\ngetEnvironmentVariableValues() {\nlet values = {\nsource: this.source,\n+ runMode: this.runMode,\n};\nlet configPath = this.eleventyConfig.getLocalProjectConfigFile();\nif (configPath) {\n@@ -495,6 +495,7 @@ Verbose Output: ${this.verboseMode}`);\ndebug(\"Setting process.env.ELEVENTY_ROOT: %o\", env.root);\nprocess.env.ELEVENTY_SOURCE = env.source;\n+ process.env.ELEVENTY_RUN_MODE = env.runMode;\n// https://github.com/11ty/eleventy/issues/1957\n// Note: when using --serve, ELEVENTY_SERVERLESS is also set in Serverless.js\n" } ]
JavaScript
MIT License
11ty/eleventy
Adds `runMode` to `eleventy` global data. Fixes #2770
699
26.01.2023 16:47:12
21,600
6fedb868227a6002b8ddd2123153a9b2a24ce3ff
Update dev server dependency
[ { "change_type": "MODIFY", "old_path": "package.json", "new_path": "package.json", "diff": "},\n\"dependencies\": {\n\"@11ty/dependency-tree\": \"^2.0.1\",\n- \"@11ty/eleventy-dev-server\": \"^1.0.1\",\n+ \"@11ty/eleventy-dev-server\": \"^1.0.2\",\n\"@11ty/eleventy-utils\": \"^1.0.1\",\n\"@iarna/toml\": \"^2.2.5\",\n\"@sindresorhus/slugify\": \"^1.1.2\",\n" } ]
JavaScript
MIT License
11ty/eleventy
Update dev server dependency
699
26.01.2023 16:47:23
21,600
c5ce8df2417225da36ac37ba731f14d1c78b6d77
A few notes about beta/canary
[ { "change_type": "MODIFY", "old_path": "docs/release-instructions.md", "new_path": "docs/release-instructions.md", "diff": "1. Tag new version\n1. Release\n- (Canary) `npm publish --access=public --tag=canary`\n+ - NOTE: that in 3.0 we need to switch this to `alpha` to avoid https://github.com/11ty/eleventy/issues/2758\n- (Beta) `npm publish --access=public --tag=beta`\n+ - NOTE: When releasing a `beta`, make sure to also release a `canary` to mitigate https://github.com/11ty/eleventy/issues/2758.\n- (Main) `npm publish --access=public`\n1. (Optional) Build and commit a new the `eleventy-edge-cdn` project to generate a new Eleventy Edge lib.\n" } ]
JavaScript
MIT License
11ty/eleventy
A few notes about beta/canary
699
26.01.2023 17:09:46
21,600
153ea8fcf0312153e07d60193ccce7abba51ae50
One more update to the dev server dep
[ { "change_type": "MODIFY", "old_path": "package.json", "new_path": "package.json", "diff": "},\n\"dependencies\": {\n\"@11ty/dependency-tree\": \"^2.0.1\",\n- \"@11ty/eleventy-dev-server\": \"^1.0.2\",\n+ \"@11ty/eleventy-dev-server\": \"^1.0.3\",\n\"@11ty/eleventy-utils\": \"^1.0.1\",\n\"@iarna/toml\": \"^2.2.5\",\n\"@sindresorhus/slugify\": \"^1.1.2\",\n" } ]
JavaScript
MIT License
11ty/eleventy
One more update to the dev server dep
726
29.01.2023 14:33:56
-7,200
b4662583701d7b33bdb2ef21b0cd4bafc360a0d2
Make markdown library .set() method optional
[ { "change_type": "MODIFY", "old_path": "src/Engines/Markdown.js", "new_path": "src/Engines/Markdown.js", "diff": "@@ -18,7 +18,7 @@ class Markdown extends TemplateEngine {\n// Overrides a highlighter set in `markdownOptions`\n// This is separate so devs can pass in a new mdLib and still use the official eleventy plugin for markdown highlighting\n- if (this.config.markdownHighlighter) {\n+ if (this.config.markdownHighlighter && typeof this.mdLib.set === \"function\") {\nthis.mdLib.set({\nhighlight: this.config.markdownHighlighter,\n});\n" } ]
JavaScript
MIT License
11ty/eleventy
Make markdown library .set() method optional
734
30.01.2023 09:11:45
0
9f13b8e861d053fa2db160cda2c9249c2e5627c0
Fixes serverlessFilePath is not defined (2.0.0-beta.2)
[ { "change_type": "MODIFY", "old_path": "src/Plugins/ServerlessBundlerPlugin.js", "new_path": "src/Plugins/ServerlessBundlerPlugin.js", "diff": "@@ -168,7 +168,7 @@ class BundlerHelper {\n);\nreturn async function EleventyServerlessMiddleware(req, res, next) {\n- deleteRequireCache(serverlessFilePath);\n+ deleteRequireCache(serverlessFilepath);\nlet serverlessFunction = EleventyRequire(serverlessFilepath);\nlet url = new URL(req.url, \"http://localhost/\"); // any domain will do here, we just want the searchParams\n" } ]
JavaScript
MIT License
11ty/eleventy
Fixes serverlessFilePath is not defined (2.0.0-beta.2) #2782
686,936
05.01.2017 18:47:42
0
42b567633ae370e3c568134c7a7bddb92b225484
Added ability to name stub mappings
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/BasicMappingBuilder.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/BasicMappingBuilder.java", "diff": "@@ -39,6 +39,7 @@ class BasicMappingBuilder implements ScenarioMappingBuilder {\nprivate String requiredScenarioState;\nprivate String newScenarioState;\nprivate UUID id = UUID.randomUUID();\n+ private String name;\nprivate boolean isPersistent = false;\nprivate Map<String, Parameters> postServeActions = newLinkedHashMap();\n@@ -116,6 +117,12 @@ class BasicMappingBuilder implements ScenarioMappingBuilder {\nreturn this;\n}\n+ @Override\n+ public BasicMappingBuilder withName(String name) {\n+ this.name = name;\n+ return this;\n+ }\n+\n@Override\npublic ScenarioMappingBuilder persistent() {\nthis.isPersistent = true;\n@@ -150,6 +157,7 @@ class BasicMappingBuilder implements ScenarioMappingBuilder {\nmapping.setRequiredScenarioState(requiredScenarioState);\nmapping.setNewScenarioState(newScenarioState);\nmapping.setUuid(id);\n+ mapping.setName(name);\nmapping.setPersistent(isPersistent);\nmapping.setPostServeActions(postServeActions.isEmpty() ? null : postServeActions);\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/MappingBuilder.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/MappingBuilder.java", "diff": "@@ -28,9 +28,11 @@ public interface MappingBuilder {\nMappingBuilder withRequestBody(StringValuePattern bodyPattern);\nScenarioMappingBuilder inScenario(String scenarioName);\nMappingBuilder withId(UUID id);\n- MappingBuilder persistent();\n+ MappingBuilder withName(String name);\n+ MappingBuilder persistent();\nMappingBuilder withBasicAuth(String username, String password);\n+\nMappingBuilder withCookie(String name, StringValuePattern cookieValuePattern);\n<P> MappingBuilder withPostServeAction(String extensionName, P parameters);\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/stubbing/StubMapping.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/stubbing/StubMapping.java", "diff": "@@ -28,29 +28,30 @@ import java.util.UUID;\nimport static com.google.common.base.MoreObjects.firstNonNull;\n-@JsonPropertyOrder({ \"id\", \"uuid\", \"request\", \"newRequest\", \"response\" })\n+@JsonPropertyOrder({ \"id\", \"name\", \"request\", \"newRequest\", \"response\", \"uuid\" })\npublic class StubMapping {\npublic static final int DEFAULT_PRIORITY = 5;\nprivate UUID uuid = UUID.randomUUID();\n+ private String name;\nprivate boolean persistent;\nprivate RequestPattern request;\n-\nprivate ResponseDefinition response;\nprivate Integer priority;\nprivate String scenarioName;\nprivate String requiredScenarioState;\nprivate String newScenarioState;\n+\nprivate Scenario scenario;\nprivate Map<String, Parameters> postServeActions;\nprivate long insertionIndex;\n-\nprivate boolean isDirty = true;\n+\npublic StubMapping(RequestPattern requestPattern, ResponseDefinition response) {\nsetRequest(requestPattern);\nthis.response = response;\n@@ -83,6 +84,14 @@ public class StubMapping {\nreturn uuid;\n}\n+ public String getName() {\n+ return name;\n+ }\n+\n+ public void setName(String name) {\n+ this.name = name;\n+ }\n+\npublic void setUuid(UUID uuid) {\nthis.uuid = uuid;\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/AdminApiTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/AdminApiTest.java", "diff": "@@ -299,8 +299,9 @@ public class AdminApiTest extends AcceptanceTestBase {\npublic void createStubMappingReturnsTheCreatedMapping() {\nWireMockResponse response = testClient.postJson(\"/__admin/mappings\",\n\"{ \\n\" +\n+ \" \\\"name\\\": \\\"Teapot putter\\\", \\n\" +\n\" \\\"request\\\": { \\n\" +\n- \" \\\"method\\\": \\\"GET\\\", \\n\" +\n+ \" \\\"method\\\": \\\"PUT\\\", \\n\" +\n\" \\\"url\\\": \\\"/put/this\\\" \\n\" +\n\" }, \\n\" +\n\" \\\"response\\\": { \\n\" +\n@@ -313,6 +314,7 @@ public class AdminApiTest extends AcceptanceTestBase {\nassertThat(response.firstHeader(\"Content-Type\"), is(\"application/json\"));\nString body = response.content();\nJsonAssertion.assertThat(body).field(\"id\").matches(\"[a-z0-9\\\\-]{36}\");\n+ JsonAssertion.assertThat(body).field(\"name\").isEqualTo(\"Teapot putter\");\n}\n@Test\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/StubbingAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/StubbingAcceptanceTest.java", "diff": "*/\npackage com.github.tomakehurst.wiremock;\n-import com.github.tomakehurst.wiremock.http.Fault;\nimport com.github.tomakehurst.wiremock.admin.model.ListStubMappingsResult;\n+import com.github.tomakehurst.wiremock.common.Json;\n+import com.github.tomakehurst.wiremock.http.Fault;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.testsupport.WireMockResponse;\nimport org.apache.http.MalformedChunkCodingException;\nimport org.apache.http.NoHttpResponseException;\nimport org.apache.http.client.ClientProtocolException;\n+import org.hamcrest.Description;\n+import org.hamcrest.Matcher;\n+import org.hamcrest.TypeSafeMatcher;\nimport org.junit.BeforeClass;\nimport org.junit.Test;\nimport java.util.UUID;\nimport static com.github.tomakehurst.wiremock.client.WireMock.*;\n+import static com.github.tomakehurst.wiremock.client.WireMock.any;\n+import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.POST;\nimport static com.github.tomakehurst.wiremock.testsupport.TestHttpHeader.withHeader;\n@@ -478,7 +484,28 @@ public class StubbingAcceptanceTest extends AcceptanceTestBase {\nassertThat(testClient.get(\"/anything-is-matched\").statusCode(), is(200));\n}\n+ @Test\n+ public void stubMappingsCanOptionallyBeNamed() {\n+ stubFor(any(urlPathEqualTo(\"/things\"))\n+ .withName(\"Get all the things\")\n+ .willReturn(aResponse().withBody(\"Named stub\")));\n+\n+ assertThat(listAllStubMappings().getMappings(), hasItem(named(\"Get all the things\")));\n+ }\n+ private Matcher<StubMapping> named(final String name) {\n+ return new TypeSafeMatcher<StubMapping>() {\n+ @Override\n+ public void describeTo(Description description) {\n+ description.appendText(\"named \" + name);\n+ }\n+\n+ @Override\n+ protected boolean matchesSafely(StubMapping item) {\n+ return name.equals(item.getName());\n+ }\n+ };\n+ }\nprivate void getAndAssertUnderlyingExceptionInstanceClass(String url, Class<?> expectedClass) {\nboolean thrown = false;\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added ability to name stub mappings
686,936
05.01.2017 19:03:21
0
c7597a766aaad79d895deae834145b3cb6b5753a
Made ClasspathFileSource fail silently when attempting writes so that it doesn't cause errors when all stubs are deleted
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/common/ClasspathFileSource.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/common/ClasspathFileSource.java", "diff": "@@ -112,7 +112,6 @@ public class ClasspathFileSource implements FileSource {\n@Override\npublic void createIfNecessary() {\n- throw new UnsupportedOperationException(\"Classpath file sources are read-only\");\n}\n@Override\n@@ -179,12 +178,10 @@ public class ClasspathFileSource implements FileSource {\n@Override\npublic void writeTextFile(String name, String contents) {\n- throw new UnsupportedOperationException(\"Classpath file sources are read-only\");\n}\n@Override\npublic void writeBinaryFile(String name, byte[] contents) {\n- throw new UnsupportedOperationException(\"Classpath file sources are read-only\");\n}\n@Override\n@@ -195,7 +192,6 @@ public class ClasspathFileSource implements FileSource {\n@Override\npublic void deleteFile(String name) {\n- throw new UnsupportedOperationException(\"Classpath file sources are read-only\");\n}\nprivate static <T> Iterable<T> toIterable(final Enumeration<T> e) {\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/common/ClasspathFileSourceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/common/ClasspathFileSourceTest.java", "diff": "@@ -101,6 +101,15 @@ public class ClasspathFileSourceTest {\nassertFalse(\"Expected not to exist\", new ClasspathFileSource(\"not/exist\").exists());\n}\n+ @Test\n+ public void failsSilentlyOnWrites() {\n+ initForFileSystem();\n+ classpathFileSource.deleteFile(\"one\");\n+ classpathFileSource.writeBinaryFile(\"any-bytes\", new byte[] {});\n+ classpathFileSource.writeTextFile(\"any-text\", \"things\");\n+ classpathFileSource.createIfNecessary();\n+ }\n+\nvoid initForJar() {\nclasspathFileSource = new ClasspathFileSource(\"META-INF/maven/com.google.guava\");\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Made ClasspathFileSource fail silently when attempting writes so that it doesn't cause errors when all stubs are deleted
686,936
06.01.2017 17:52:52
0
bfb5bbed81cb6d4150294cbadcc8447a272213b4
Fix - bind HTTPS to a specific host if required
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyHttpServer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyHttpServer.java", "diff": "@@ -78,6 +78,7 @@ class JettyHttpServer implements HttpServer {\nif (options.httpsSettings().enabled()) {\nhttpsConnector = createHttpsConnector(\n+ options.bindAddress(),\noptions.httpsSettings(),\noptions.jettySettings(),\nnetworkTrafficListenerAdapter);\n@@ -158,16 +159,18 @@ class JettyHttpServer implements HttpServer {\nHttpConfiguration httpConfig = createHttpConfig(jettySettings);\nServerConnector connector = createServerConnector(\n+ bindAddress,\njettySettings,\nport,\nlistener,\nnew HttpConnectionFactory(httpConfig)\n);\n- connector.setHost(bindAddress);\n+\nreturn connector;\n}\nprivate ServerConnector createHttpsConnector(\n+ String bindAddress,\nHttpsSettings httpsSettings,\nJettySettings jettySettings,\nNetworkTrafficListener listener) {\n@@ -190,8 +193,8 @@ class JettyHttpServer implements HttpServer {\nfinal int port = httpsSettings.port();\n-\nreturn createServerConnector(\n+ bindAddress,\njettySettings,\nport,\nlistener,\n@@ -212,7 +215,10 @@ class JettyHttpServer implements HttpServer {\nreturn httpConfig;\n}\n- private ServerConnector createServerConnector(JettySettings jettySettings, int port, NetworkTrafficListener listener, ConnectionFactory... connectionFactories) {\n+ private ServerConnector createServerConnector(String bindAddress,\n+ JettySettings jettySettings,\n+ int port, NetworkTrafficListener listener,\n+ ConnectionFactory... connectionFactories) {\nint acceptors = jettySettings.getAcceptors().or(2);\nNetworkTrafficServerConnector connector = new NetworkTrafficServerConnector(\njettyServer,\n@@ -232,6 +238,8 @@ class JettyHttpServer implements HttpServer {\nsetJettySettings(jettySettings, connector);\n+ connector.setHost(bindAddress);\n+\nreturn connector;\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/BindAddressTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/BindAddressTest.java", "diff": "@@ -19,6 +19,7 @@ import static com.github.tomakehurst.wiremock.client.WireMock.*;\nimport static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;\nimport static org.hamcrest.Matchers.is;\nimport static org.junit.Assert.assertThat;\n+import static org.junit.Assert.fail;\nimport java.net.Inet4Address;\nimport java.net.InetAddress;\n@@ -27,6 +28,12 @@ import java.net.SocketException;\nimport java.util.Collections;\nimport java.util.Enumeration;\n+import com.github.tomakehurst.wiremock.common.HttpClientUtils;\n+import com.github.tomakehurst.wiremock.http.HttpClientFactory;\n+import org.apache.http.HttpResponse;\n+import org.apache.http.client.HttpClient;\n+import org.apache.http.client.methods.RequestBuilder;\n+import org.apache.http.util.EntityUtils;\nimport org.junit.After;\nimport org.junit.Assert;\nimport org.junit.Before;\n@@ -42,11 +49,13 @@ public class BindAddressTest {\nprivate String nonBindAddress;\nprivate WireMockServer wireMockServer;\n+ final HttpClient client = HttpClientFactory.createClient();\n+\n@Before\npublic void prepare() throws Exception {\nnonBindAddress = getIpAddressOtherThan(localhost);\nif (nonBindAddress == null) {\n- Assert.fail(\"Impossible to validate the binding address. This machine has only a one Ip address [\"\n+ fail(\"Impossible to validate the binding address. This machine has only a one Ip address [\"\n+ localhost + \"]\");\n}\n@@ -73,14 +82,32 @@ public class BindAddressTest {\nexecuteGetIn(localhost);\ntry {\nexecuteGetIn(nonBindAddress);\n- Assert.fail(\"Should not accept the connection in [\" + nonBindAddress + \"]\");\n+ fail(\"Should not accept HTTP connection to [\" + nonBindAddress + \"]\");\n} catch (Exception ex) {\n}\n}\n@Test\npublic void shouldRespondInTheBindAddressOnlyOnHttps() throws Exception {\n+ int localhostStatus = getStatusViaHttps(localhost);\n+ assertThat(localhostStatus, is(200));\n+\n+ try {\n+ getStatusViaHttps(nonBindAddress);\n+ fail(\"Should not accept HTTPS connection to [\" + nonBindAddress + \"]\");\n+ } catch (Exception e) {\n+ }\n+ }\n+\n+ private int getStatusViaHttps(String host) throws Exception {\n+ HttpResponse localhostResponse = client.execute(RequestBuilder\n+ .get(\"https://\" + host + \":\" + wireMockServer.httpsPort() + \"/bind-test\")\n+ .build()\n+ );\n+ int status = localhostResponse.getStatusLine().getStatusCode();\n+ EntityUtils.consume(localhostResponse.getEntity());\n+ return status;\n}\nprivate void executeGetIn(String address) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fix #539 - bind HTTPS to a specific host if required
686,936
06.01.2017 18:35:56
0
ed43ebc4e7c19d29d67a3c439661d6a8cc5ca3a2
Added note about using standalone JAR with Spring Boot
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/getting-started.md", "new_path": "docs-v2/_docs/getting-started.md", "diff": "@@ -10,11 +10,13 @@ WireMock is distributed in two flavours - a standard JAR containing just\nWireMock, and a standalone fat JAR containing WireMock plus all its\ndependencies.\n-The fat JAR's dependencies are shaded i.e. they are hidden in\n+The standalone JAR's dependencies are shaded i.e. they are hidden in\nalternative packages. This allows WireMock to be used in projects with\nconflicting versions of its dependencies. The standalone JAR is also\nrunnable (discussed in more detail below).\n+**Currently it is recommended that you use the standalone JAR as a dependency with Spring Boot projects. This avoids a conflict over the Jetty version**\n+\n## Maven\nTo add the standard WireMock JAR as a project dependency, put the\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added note about using standalone JAR with Spring Boot
687,020
07.01.2017 13:58:37
-3,600
11f169aff2f347dfacd1c088c2aab5c375fddabc
Add additional information about file serving to the documentation
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/running-standalone.md", "new_path": "docs-v2/_docs/running-standalone.md", "diff": "@@ -180,7 +180,7 @@ You can push a collection of mappings to a remote\n## File serving\n-When running standalone files placed under the `__files` directory will\n+When running the standalone JAR, files placed under the `__files` directory will\nbe served up as if from under the docroot, except if stub mapping\nmatching the URL exists. For example if a file exists\n`__files/things/myfile.html` and no stub mapping will match\n" }, { "change_type": "MODIFY", "old_path": "docs-v2/_docs/stubbing.md", "new_path": "docs-v2/_docs/stubbing.md", "diff": "@@ -346,6 +346,16 @@ To do the equivalent via the JSON API, `PUT` the edited stub mapping to `/__admi\n}\n```\n+## File serving\n+When running the standalone JAR, files placed under the `__files` directory will\n+be served up as if from under the docroot, except if stub mapping\n+matching the URL exists. For example if a file exists\n+`__files/things/myfile.html` and no stub mapping will match\n+`/things/myfile.html` then hitting\n+`http://<host>:<port>/things/myfile.html` will serve the file.\n+\n+This feature is also available with the standard JAR. To use it, define the filesRoot using `options.withRootDirectory()`, i.e. `options.withRootDirectory(getClass.getResource(\"/wiremock\").getPath)`\n+\n## Removing stubs\nStub mappings can be deleted via the Java API as follows:\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add additional information about file serving to the documentation
686,936
10.01.2017 09:20:16
0
5e3c4b0c7746d7fe901f9714d680fb4f0396ac94
Added DSL shortcuts for common response types
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -31,6 +31,8 @@ import com.github.tomakehurst.wiremock.standalone.RemoteMappingsLoader;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.*;\n+import com.google.common.net.HttpHeaders;\n+import org.apache.http.entity.ContentType;\nimport java.io.File;\nimport java.util.Collections;\n@@ -41,6 +43,8 @@ import java.util.UUID;\nimport static com.github.tomakehurst.wiremock.matching.RequestPattern.thatMatch;\nimport static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.allRequests;\nimport static com.google.common.collect.FluentIterable.from;\n+import static com.google.common.net.HttpHeaders.CONTENT_TYPE;\n+import static com.google.common.net.HttpHeaders.LOCATION;\npublic class WireMock {\n@@ -360,6 +364,69 @@ public class WireMock {\nreturn new ResponseDefinitionBuilder();\n}\n+ public static ResponseDefinitionBuilder ok() {\n+ return aResponse().withStatus(200);\n+ }\n+\n+ public static ResponseDefinitionBuilder ok(String body) {\n+ return aResponse().withStatus(200).withBody(body);\n+ }\n+\n+ public static ResponseDefinitionBuilder okJson(String body) {\n+ return aResponse()\n+ .withStatus(200)\n+ .withHeader(CONTENT_TYPE, \"application/json\")\n+ .withBody(body);\n+ }\n+\n+ public static ResponseDefinitionBuilder created() {\n+ return aResponse().withStatus(201);\n+ }\n+\n+ public static ResponseDefinitionBuilder noContent() {\n+ return aResponse().withStatus(204);\n+ }\n+\n+ public static ResponseDefinitionBuilder permanentRedirect(String location) {\n+ return aResponse().withStatus(301).withHeader(LOCATION, location);\n+ }\n+\n+ public static ResponseDefinitionBuilder temporaryRedirect(String location) {\n+ return aResponse().withStatus(302).withHeader(LOCATION, location);\n+ }\n+\n+ public static ResponseDefinitionBuilder seeOther(String location) {\n+ return aResponse().withStatus(303).withHeader(LOCATION, location);\n+ }\n+\n+ public static ResponseDefinitionBuilder badRequest() {\n+ return aResponse().withStatus(400);\n+ }\n+\n+ public static ResponseDefinitionBuilder badRequestEntity() {\n+ return aResponse().withStatus(422);\n+ }\n+\n+ public static ResponseDefinitionBuilder unauthorized() {\n+ return aResponse().withStatus(401);\n+ }\n+\n+ public static ResponseDefinitionBuilder forbidden() {\n+ return aResponse().withStatus(403);\n+ }\n+\n+ public static ResponseDefinitionBuilder notFound() {\n+ return aResponse().withStatus(404);\n+ }\n+\n+ public static ResponseDefinitionBuilder serverError() {\n+ return aResponse().withStatus(500);\n+ }\n+\n+ public static ResponseDefinitionBuilder serviceUnavailable() {\n+ return aResponse().withStatus(503);\n+ }\n+\npublic void verifyThat(RequestPatternBuilder requestPatternBuilder) {\nverifyThat(moreThanOrExactly(1), requestPatternBuilder);\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added DSL shortcuts for common response types
686,936
12.01.2017 18:51:38
0
0a34aa8ebef608e2f710bb1543c133a86b2e462b
Asserts that Transfer-Encoding is absent when Content-Length header sent in test case
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/MappingsAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/MappingsAcceptanceTest.java", "diff": "@@ -25,6 +25,7 @@ import static com.github.tomakehurst.wiremock.testsupport.MappingJsonSamples.MAP\nimport static com.github.tomakehurst.wiremock.testsupport.MappingJsonSamples.MAPPING_REQUEST_FOR_BYTE_BODY;\nimport static java.net.HttpURLConnection.HTTP_NOT_FOUND;\nimport static org.hamcrest.Matchers.is;\n+import static org.junit.Assert.assertFalse;\nimport static org.junit.Assert.assertNull;\nimport static org.junit.Assert.assertThat;\n@@ -147,7 +148,7 @@ public class MappingsAcceptanceTest extends AcceptanceTestBase {\n}\n@Test\n- public void responseContainsContentLengthHeaderIfItIsDefinedInTheMapping() throws Exception {\n+ public void responseContainsContentLengthAndChunkedEncodingHeadersIfItIsDefinedInTheMapping() throws Exception {\ntestClient.addResponse(\n\"{ \\n\" +\n\" \\\"request\\\": { \\n\" +\n@@ -165,6 +166,7 @@ public class MappingsAcceptanceTest extends AcceptanceTestBase {\nWireMockResponse response = testClient.get(\"/with/body\");\nassertThat(response.firstHeader(\"Content-Length\"), is(\"12\"));\n+ assertFalse(\"expected Transfer-Encoding head to be absent\", response.headers().containsKey(\"Transfer-Encoding\"));\n}\nprivate void getResponseAndAssert200Status(String url) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Asserts that Transfer-Encoding is absent when Content-Length header sent in test case
686,936
12.01.2017 19:13:34
0
07f8834eb562748bd88e9da4bbfc8f644ecd9c24
Fixed - when converting an escaped URL query to a logged request field it no longer attempts (and fails) to URL escape the values twice
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/common/Urls.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/common/Urls.java", "diff": "@@ -62,7 +62,7 @@ public class Urls {\nreturn Collections.emptyMap();\n}\n- return splitQuery(uri.getQuery());\n+ return splitQuery(uri.getRawQuery());\n}\npublic static String decode(String encoded) {\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/common/UrlsTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/common/UrlsTest.java", "diff": "@@ -51,4 +51,11 @@ public class UrlsTest {\nassertThat(params.get(\"param1\").isSingleValued(), is(false));\nassertThat(params.get(\"param1\").values(), hasItems(\"1\", \"2\", \"3\"));\n}\n+\n+ @Test\n+ public void doesNotAttemptToDoubleDecodeSplitQueryString() {\n+ URI url = URI.create(\"/thing?q=a%25b\");\n+ Map<String, QueryParameter> query = Urls.splitQuery(url);\n+ assertThat(query.get(\"q\").firstValue(), is(\"a%b\"));\n+ }\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #571 - when converting an escaped URL query to a logged request field it no longer attempts (and fails) to URL escape the values twice
686,985
19.01.2017 12:53:27
0
4aae11db8fb2d21718d86ad9ed0923fd6f558cfd
fixing docs, the code did not compile because the method has been rename a while back
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/extending-wiremock.md", "new_path": "docs-v2/_docs/extending-wiremock.md", "diff": "@@ -234,7 +234,7 @@ at the top of this page e.g.\npublic class BodyLengthMatcher extends RequestMatcherExtension {\n@Override\n- public String name() {\n+ public String getName() {\nreturn \"body-too-long\";\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
fixing docs, the code did not compile because the method has been rename a while back
686,936
20.01.2017 17:59:17
0
eb44a6010023e5a1983466ce08cb95c50557b002
Fixed - response is now provided to post serve actions (was previously null)
[ { "change_type": "DELETE", "old_path": "notes.txt", "new_path": null, "diff": "-value: is equal\n-object: are all keys present and values equal, recursing into objects?\n-array: for each in source array, match each in target array + calc distance, add 1 distance point for each additional target element\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/AbstractRequestHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/AbstractRequestHandler.java", "diff": "@@ -45,6 +45,7 @@ public abstract class AbstractRequestHandler implements RequestHandler, RequestE\nResponseDefinition responseDefinition = serveEvent.getResponseDefinition();\nresponseDefinition.setOriginalRequest(request);\nResponse response = responseRenderer.render(responseDefinition);\n+ ServeEvent completedServeEvent = serveEvent.complete(response);\nif (logRequests()) {\nnotifier().info(\"Request received:\\n\" +\n@@ -57,11 +58,11 @@ public abstract class AbstractRequestHandler implements RequestHandler, RequestE\nlistener.requestReceived(request, response);\n}\n- beforeResponseSent(serveEvent, response);\n+ beforeResponseSent(completedServeEvent, response);\nhttpResponder.respond(request, response);\n- afterResponseSent(serveEvent, response);\n+ afterResponseSent(completedServeEvent, response);\n}\nprivate static String formatRequest(Request request) {\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/StubRequestHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/StubRequestHandler.java", "diff": "@@ -57,7 +57,7 @@ public class StubRequestHandler extends AbstractRequestHandler {\n@Override\nprotected void beforeResponseSent(ServeEvent serveEvent, Response response) {\n- requestJournal.requestReceived(serveEvent.complete(response));\n+ requestJournal.requestReceived(serveEvent);\n}\n@Override\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "diff": "@@ -17,6 +17,8 @@ import org.junit.After;\nimport org.junit.Test;\nimport java.util.concurrent.ConcurrentHashMap;\n+import java.util.concurrent.atomic.AtomicInteger;\n+import java.util.concurrent.atomic.AtomicReference;\nimport static com.github.tomakehurst.wiremock.PostServeActionExtensionTest.CounterNameParameter.counterNameParameter;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.responseDefinition;\n@@ -82,6 +84,32 @@ public class PostServeActionExtensionTest {\nassertThat(client.get(\"/as-normal\").statusCode(), is(200));\n}\n+ @Test\n+ public void providesServeEventWithResponseFieldPopulated() {\n+ final AtomicInteger finalStatus = new AtomicInteger();\n+ initWithOptions(options().dynamicPort().extensions(new PostServeAction() {\n+ @Override\n+ public String getName() {\n+ return \"response-field-test\";\n+ }\n+\n+ @Override\n+ public void doGlobalAction(ServeEvent serveEvent, Admin admin) {\n+ if (serveEvent.getResponse() != null) {\n+ finalStatus.set(serveEvent.getResponse().getStatus());\n+ }\n+ }\n+ }));\n+\n+ wm.stubFor(get(urlPathEqualTo(\"/response-status\"))\n+ .willReturn(aResponse().withStatus(418))\n+ );\n+\n+ client.get(\"/response-status\");\n+\n+ assertThat(finalStatus.get(), is(418));\n+ }\n+\npublic static class NamedCounterAction extends PostServeAction implements AdminApiExtension {\nprivate final ConcurrentHashMap<String, Integer> counters = new ConcurrentHashMap<>();\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #585 - response is now provided to post serve actions (was previously null)
686,936
21.01.2017 17:54:44
0
2e5ac644187c9f8af2db6f7b288a11b2e4f67974
Fixed flakey test for presence of response in post serve action extension
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "diff": "@@ -17,6 +17,8 @@ import org.junit.After;\nimport org.junit.Test;\nimport java.util.concurrent.ConcurrentHashMap;\n+import java.util.concurrent.CountDownLatch;\n+import java.util.concurrent.TimeUnit;\nimport java.util.concurrent.atomic.AtomicInteger;\nimport java.util.concurrent.atomic.AtomicReference;\n@@ -26,6 +28,7 @@ import static com.github.tomakehurst.wiremock.client.WireMock.*;\nimport static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.google.common.base.MoreObjects.firstNonNull;\n+import static java.util.concurrent.TimeUnit.MILLISECONDS;\nimport static org.hamcrest.Matchers.is;\nimport static org.junit.Assert.assertThat;\n@@ -85,8 +88,9 @@ public class PostServeActionExtensionTest {\n}\n@Test\n- public void providesServeEventWithResponseFieldPopulated() {\n+ public void providesServeEventWithResponseFieldPopulated() throws InterruptedException {\nfinal AtomicInteger finalStatus = new AtomicInteger();\n+ final CountDownLatch countDownLatch = new CountDownLatch(1);\ninitWithOptions(options().dynamicPort().extensions(new PostServeAction() {\n@Override\npublic String getName() {\n@@ -96,6 +100,7 @@ public class PostServeActionExtensionTest {\n@Override\npublic void doGlobalAction(ServeEvent serveEvent, Admin admin) {\nif (serveEvent.getResponse() != null) {\n+ countDownLatch.countDown();\nfinalStatus.set(serveEvent.getResponse().getStatus());\n}\n}\n@@ -107,6 +112,8 @@ public class PostServeActionExtensionTest {\nclient.get(\"/response-status\");\n+ countDownLatch.await(500, MILLISECONDS);\n+\nassertThat(finalStatus.get(), is(418));\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed flakey test for presence of response in post serve action extension
686,936
21.01.2017 19:42:05
0
062d2cfa3ec0a197797be4d2e672a9097a75e576
Further test race condition fixes
[ { "change_type": "MODIFY", "old_path": "build.gradle", "new_path": "build.gradle", "diff": "@@ -79,6 +79,7 @@ dependencies {\n}\ntestCompile \"org.skyscreamer:jsonassert:1.2.3\"\ntestCompile 'com.toomuchcoding.jsonassert:jsonassert:0.4.7'\n+ testCompile 'org.awaitility:awaitility:2.0.0'\ntestCompile \"com.googlecode.jarjar:jarjar:1.3\"\ntestCompile \"commons-io:commons-io:2.4\"\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "diff": "@@ -16,11 +16,10 @@ import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\nimport org.junit.After;\nimport org.junit.Test;\n+import java.util.concurrent.Callable;\nimport java.util.concurrent.ConcurrentHashMap;\nimport java.util.concurrent.CountDownLatch;\n-import java.util.concurrent.TimeUnit;\nimport java.util.concurrent.atomic.AtomicInteger;\n-import java.util.concurrent.atomic.AtomicReference;\nimport static com.github.tomakehurst.wiremock.PostServeActionExtensionTest.CounterNameParameter.counterNameParameter;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.responseDefinition;\n@@ -29,6 +28,8 @@ import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.google.common.base.MoreObjects.firstNonNull;\nimport static java.util.concurrent.TimeUnit.MILLISECONDS;\n+import static org.awaitility.Awaitility.await;\n+import static org.awaitility.Duration.ONE_SECOND;\nimport static org.hamcrest.Matchers.is;\nimport static org.junit.Assert.assertThat;\n@@ -51,7 +52,7 @@ public class PostServeActionExtensionTest {\n}\n@Test\n- public void triggersActionWhenAppliedToAStubMapping() {\n+ public void triggersActionWhenAppliedToAStubMapping() throws Exception {\ninitWithOptions(options()\n.dynamicPort()\n.extensions(new NamedCounterAction()));\n@@ -68,8 +69,18 @@ public class PostServeActionExtensionTest {\nclient.get(\"/count-me\");\nclient.get(\"/count-me\");\n- String count = client.get(\"/__admin/named-counter/things\").content();\n- assertThat(count, is(\"4\"));\n+ await()\n+ .atMost(ONE_SECOND)\n+ .until(getContent(\"/__admin/named-counter/things\"), is(\"4\"));\n+ }\n+\n+ private Callable<String> getContent(final String url) {\n+ return new Callable<String>() {\n+ @Override\n+ public String call() throws Exception {\n+ return client.get(url).content();\n+ }\n+ };\n}\n@Test\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Further test race condition fixes
686,936
23.01.2017 09:36:52
0
593c34600597faa203d27f9575193beaf2086b21
Fixed - added missing annotation onto matcher and added a reflective test to ensure future matchers have this
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/matching/MatchesJsonPathPattern.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/matching/MatchesJsonPathPattern.java", "diff": "@@ -25,7 +25,7 @@ import static com.github.tomakehurst.wiremock.common.LocalNotifier.notifier;\npublic class MatchesJsonPathPattern extends StringValuePattern {\n- public MatchesJsonPathPattern(String value) {\n+ public MatchesJsonPathPattern(@JsonProperty(\"matchesJsonPath\") String value) {\nsuper(value);\n}\n@@ -34,7 +34,7 @@ public class MatchesJsonPathPattern extends StringValuePattern {\n}\n@Override\n- public MatchResult match(@JsonProperty(\"matchesJsonPath\") String value) {\n+ public MatchResult match(String value) {\nreturn MatchResult.of(isJsonPathMatch(value));\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/matching/StringValuePatternTest.java", "diff": "+package com.github.tomakehurst.wiremock.matching;\n+\n+import com.google.common.base.Function;\n+import com.google.common.base.Predicate;\n+import com.google.common.base.Predicates;\n+import com.google.common.base.Stopwatch;\n+import com.google.common.collect.FluentIterable;\n+import com.google.common.collect.ImmutableSet;\n+import com.google.common.collect.Iterables;\n+import com.google.common.reflect.ClassPath;\n+import org.junit.Test;\n+\n+import java.lang.reflect.Constructor;\n+import java.lang.reflect.Modifier;\n+import java.util.concurrent.TimeUnit;\n+\n+import static com.google.common.collect.FluentIterable.from;\n+import static java.util.Arrays.asList;\n+import static org.hamcrest.Matchers.is;\n+import static org.junit.Assert.assertThat;\n+\n+public class StringValuePatternTest {\n+\n+ @Test\n+ public void allSubclassesHaveWorkingToString() throws Exception {\n+ ImmutableSet<ClassPath.ClassInfo> allClasses = ClassPath\n+ .from(Thread.currentThread().getContextClassLoader())\n+ .getAllClasses();\n+\n+ FluentIterable<Class<?>> classes = from(allClasses)\n+ .filter(new Predicate<ClassPath.ClassInfo>() {\n+ @Override\n+ public boolean apply(ClassPath.ClassInfo input) {\n+ return input.getPackageName().startsWith(\"com.github.tomakehurst.wiremock.matching\");\n+ }\n+ })\n+ .transform(new Function<ClassPath.ClassInfo, Class<?>>() {\n+ @Override\n+ public Class<?> apply(ClassPath.ClassInfo input) {\n+ try {\n+ return input.load();\n+ } catch (Throwable e) {\n+ return Object.class;\n+ }\n+ }\n+ })\n+ .filter(Predicates.assignableFrom(StringValuePattern.class))\n+ .filter(new Predicate<Class<?>>() {\n+ @Override\n+ public boolean apply(Class<?> input) {\n+ return !Modifier.isAbstract(input.getModifiers());\n+ }\n+ });\n+\n+\n+ for (Class<?> clazz: classes) {\n+ Constructor<?> constructor = findConstructorWithStringParamInFirstPosition(clazz);\n+ Stopwatch stopwatch = Stopwatch.createStarted();\n+ assertThat(constructor\n+ .getParameterAnnotations()[0][0]\n+ .annotationType()\n+ .getSimpleName(), is(\"JsonProperty\"));\n+ stopwatch.stop();\n+ }\n+\n+ }\n+\n+ private Constructor<?> findConstructorWithStringParamInFirstPosition(Class<?> clazz) {\n+ return Iterables.find(asList(clazz.getConstructors()), new Predicate<Constructor<?>>() {\n+ @Override\n+ public boolean apply(Constructor<?> input) {\n+ return input.getParameterTypes().length > 0 && input.getParameterTypes()[0].equals(String.class);\n+ }\n+ });\n+ }\n+}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #580 - added missing @JsonProperty annotation onto matcher and added a reflective test to ensure future matchers have this
686,936
23.01.2017 19:41:48
0
2c7166ef6d92dd51a40f4477d10bc7ef87fcb6dd
Fixed - ClasspathFileSource now supports spaces in paths to zip/jar/war/ear files
[ { "change_type": "MODIFY", "old_path": "build.gradle", "new_path": "build.gradle", "diff": "@@ -86,7 +86,7 @@ dependencies {\ntestCompile 'org.scala-lang:scala-library:2.11.8'\ntestRuntime 'org.slf4j:slf4j-log4j12:1.7.12'\n- testRuntime files('src/test/resources/classpathfiles.zip', 'src/test/resources/classpath-filesource.jar')\n+ testRuntime files('src/test/resources/classpath file source/classpathfiles.zip', 'src/test/resources/classpath-filesource.jar')\n}\ncompileTestJava {\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/common/ClasspathFileSource.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/common/ClasspathFileSource.java", "diff": "@@ -25,6 +25,7 @@ import java.io.File;\nimport java.net.URI;\nimport java.net.URISyntaxException;\nimport java.net.URL;\n+import java.net.URLEncoder;\nimport java.util.Enumeration;\nimport java.util.Iterator;\nimport java.util.List;\n@@ -66,7 +67,8 @@ public class ClasspathFileSource implements FileSource {\nif (asList(\"jar\", \"war\", \"ear\", \"zip\").contains(pathUri.getScheme())) {\nString jarFileUri = pathUri.getSchemeSpecificPart().split(\"!\")[0];\n- File file = new File(URI.create(jarFileUri));\n+ String jarFilePath = jarFileUri.replace(\"file:\", \"\");\n+ File file = new File(jarFilePath);\nzipFile = new ZipFile(file);\n} else if (pathUri.getScheme().equals(\"file\")) {\nrootDirectory = new File(pathUri);\n" }, { "change_type": "RENAME", "old_path": "src/test/resources/classpathfiles.zip", "new_path": "src/test/resources/classpath file source/classpathfiles.zip", "diff": "Binary files a/src/test/resources/classpathfiles.zip and b/src/test/resources/classpath file source/classpathfiles.zip differ\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #552 - ClasspathFileSource now supports spaces in paths to zip/jar/war/ear files
686,936
28.01.2017 20:51:12
0
12a362f6c717a5b775e728c77b23d6a08f744fa3
Fixed - now applies response templates to body files
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/extension/responsetemplating/ResponseTemplateTransformer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/extension/responsetemplating/ResponseTemplateTransformer.java", "diff": "@@ -6,6 +6,7 @@ import com.github.jknack.handlebars.Template;\nimport com.github.jknack.handlebars.helper.StringHelpers;\nimport com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;\nimport com.github.tomakehurst.wiremock.common.FileSource;\n+import com.github.tomakehurst.wiremock.common.TextFile;\nimport com.github.tomakehurst.wiremock.extension.Parameters;\nimport com.github.tomakehurst.wiremock.extension.ResponseDefinitionTransformer;\nimport com.github.tomakehurst.wiremock.http.HttpHeader;\n@@ -66,10 +67,13 @@ public class ResponseTemplateTransformer extends ResponseDefinitionTransformer {\nResponseDefinitionBuilder newResponseDefBuilder = ResponseDefinitionBuilder.like(responseDefinition);\nfinal ImmutableMap<String, RequestTemplateModel> model = ImmutableMap.of(\"request\", RequestTemplateModel.from(request));\n- if (responseDefinition.getBody() != null) {\n+ if (responseDefinition.specifiesBodyContent()) {\nTemplate bodyTemplate = uncheckedCompileTemplate(responseDefinition.getBody());\n- String newBody = uncheckedApplyTemplate(bodyTemplate, model);\n- newResponseDefBuilder.withBody(newBody);\n+ applyTemplatedResponseBody(newResponseDefBuilder, model, bodyTemplate);\n+ } else if (responseDefinition.specifiesBodyFile()) {\n+ TextFile file = files.getTextFileNamed(responseDefinition.getBodyFileName());\n+ Template bodyTemplate = uncheckedCompileTemplate(file.readContentsAsString());\n+ applyTemplatedResponseBody(newResponseDefBuilder, model, bodyTemplate);\n}\nif (responseDefinition.getHeaders() != null) {\n@@ -93,6 +97,11 @@ public class ResponseTemplateTransformer extends ResponseDefinitionTransformer {\nreturn newResponseDefBuilder.build();\n}\n+ private void applyTemplatedResponseBody(ResponseDefinitionBuilder newResponseDefBuilder, ImmutableMap<String, RequestTemplateModel> model, Template bodyTemplate) {\n+ String newBody = uncheckedApplyTemplate(bodyTemplate, model);\n+ newResponseDefBuilder.withBody(newBody);\n+ }\n+\nprivate String uncheckedApplyTemplate(Template template, Object context) {\ntry {\nreturn template.apply(context);\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/ResponseTemplatingAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/ResponseTemplatingAcceptanceTest.java", "diff": "@@ -75,5 +75,14 @@ public class ResponseTemplatingAcceptanceTest {\nassertThat(client.get(\"/templated\").content(), is(\"templated\"));\n}\n+\n+ @Test\n+ public void appliesToResponseBodyFromFile() {\n+ wm.stubFor(get(urlPathEqualTo(\"/templated\"))\n+ .willReturn(aResponse()\n+ .withBodyFile(\"templated-example.txt\")));\n+\n+ assertThat(client.get(\"/templated\").content(), is(\"templated\"));\n+ }\n}\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/resources/__files/templated-example.txt", "diff": "+{{request.path.[0]}}\n\\ No newline at end of file\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #593 - now applies response templates to body files
686,936
28.01.2017 21:40:04
0
7d8a488008dadb714e8a140a6360da5a630959e5
Fixed - ConsoleNotifier now renders dates with padded milliseconds for consistency with other log output and ease of parsing
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/common/ConsoleNotifier.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/common/ConsoleNotifier.java", "diff": "@@ -52,7 +52,7 @@ public class ConsoleNotifier implements Notifier {\n}\nprivate static String formatMessage(String message) {\n- DateFormat df = new SimpleDateFormat(\"yyyy-MM-dd HH:mm:ss.S\");\n+ DateFormat df = new SimpleDateFormat(\"yyyy-MM-dd HH:mm:ss.SSS\");\nString date = df.format(new Date());\nreturn String.format(\"%s %s\", date, message);\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #587 - ConsoleNotifier now renders dates with padded milliseconds for consistency with other log output and ease of parsing
686,936
28.01.2017 21:45:42
0
6910787e403d57a72ed41b604ba6212526fb11a4
Deleted redundant test class
[ { "change_type": "DELETE", "old_path": "src/test/java/com/github/tomakehurst/wiremock/extension/HandlebarsTest.java", "new_path": null, "diff": "-package com.github.tomakehurst.wiremock.extension;\n-\n-import com.github.jknack.handlebars.Handlebars;\n-import com.github.jknack.handlebars.Helper;\n-import com.github.jknack.handlebars.Options;\n-import com.github.jknack.handlebars.Template;\n-import com.github.jknack.handlebars.helper.StringHelpers;\n-import com.github.tomakehurst.wiremock.extension.responsetemplating.ListOrSingle;\n-import com.google.common.collect.ImmutableMap;\n-import org.junit.Test;\n-\n-import java.io.IOException;\n-import java.util.List;\n-import java.util.Map;\n-\n-public class HandlebarsTest {\n-\n- @Test\n- public void singleOrList() throws Exception {\n- Handlebars handlebars = new Handlebars();\n- handlebars.registerHelper(\"get\", new Helper<List<?>>() {\n- @Override\n- public Object apply(List<?> context, Options options) throws IOException {\n- Integer index = options.param(0, 0);\n- return context.get(index);\n- }\n- }\n- );\n- handlebars.registerHelper(\"join\", StringHelpers.join);\n- Template singleTemplate = handlebars.compileInline(\"{{model}}\");\n- Template manyTemplate = handlebars.compileInline(\"{{join model ','}}\");\n- Template getTemplate = handlebars.compileInline(\"{{model.[2]}}\");\n-\n- ListOrSingle<String> many = new ListOrSingle<>(\"one\", \"two\", \"three\");\n- ListOrSingle<Object> none = new ListOrSingle<>();\n-\n- System.out.println(singleTemplate.apply(ImmutableMap.of(\"model\", many)));\n- System.out.println(singleTemplate.apply(ImmutableMap.of(\"model\", none)));\n- System.out.println(manyTemplate.apply(ImmutableMap.of(\"model\", many)));\n- System.out.println(getTemplate.apply(ImmutableMap.of(\"model\", many)));\n- }\n-\n- @Test\n- public void awkwardKeyNames() throws IOException {\n- Handlebars handlebars = new Handlebars();\n-\n- Map<String, ListOrSingle<String>> headers = ImmutableMap.of(\n- \"X-Header_One\", ListOrSingle.of(\"one\", \"two\"),\n- \"$%Myheader\", ListOrSingle.of(\"three\", \"four\")\n- );\n-\n- System.out.println(\n- handlebars.compileInline(\"{{model.X-Header_One}}\")\n- .apply(ImmutableMap.of(\"model\", headers)));\n-\n- System.out.println(\n- handlebars.compileInline(\"{{model.[$%Myheader]}}\")\n- .apply(ImmutableMap.of(\"model\", headers)));\n- }\n-}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Deleted redundant test class
686,936
01.02.2017 18:50:44
0
4ed80bd192eefd7e0050fbd77f91636f511b5f7e
Documented Java shortcuts and added status() shortcut to the DSL
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/stubbing.md", "new_path": "docs-v2/_docs/stubbing.md", "diff": "@@ -55,6 +55,39 @@ document can either be posted to\n}\n```\n+### Java Shortcuts\n+\n+Some common request and response patterns can be expressed in Java in abbreviated forms.\n+\n+Requests matching an exact URL plus one of the most common HTTP methods (GET, POST, PUT, DELETE) can be stubbed like this:\n+\n+```java\n+stubFor(get(\"/some/thing\")\n+ .willReturn(aResponse().withStatus(200)));\n+```\n+\n+Common responses can also be abbreviated e.g.:\n+\n+```java\n+stubFor(delete(\"/fine\")\n+ .willReturn(ok()));\n+\n+stubFor(get(\"/fine-with-body\")\n+ .willReturn(ok(\"body content\")));\n+\n+stubFor(get(\"/json\")\n+ .willReturn(okJson(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\n+\n+stubFor(post(\"/redirect\")\n+ .willReturn(temporaryRedirect(\"/new/place\")));\n+\n+stubFor(post(\"/sorry-no\")\n+ .willReturn(unauthorized()));\n+\n+stubFor(put(\"/status-only\")\n+ .willReturn(status(418)));\n+\n+```\nHTTP methods currently supported are:\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -379,6 +379,22 @@ public class WireMock {\n.withBody(body);\n}\n+ public static MappingBuilder get(String url) {\n+ return get(urlEqualTo(url));\n+ }\n+\n+ public static MappingBuilder post(String url) {\n+ return post(urlEqualTo(url));\n+ }\n+\n+ public static MappingBuilder put(String url) {\n+ return put(urlEqualTo(url));\n+ }\n+\n+ public static MappingBuilder delete(String url) {\n+ return delete(urlEqualTo(url));\n+ }\n+\npublic static ResponseDefinitionBuilder created() {\nreturn aResponse().withStatus(201);\n}\n@@ -427,6 +443,10 @@ public class WireMock {\nreturn aResponse().withStatus(503);\n}\n+ public static ResponseDefinitionBuilder status(int status) {\n+ return aResponse().withStatus(status);\n+ }\n+\npublic void verifyThat(RequestPatternBuilder requestPatternBuilder) {\nverifyThat(moreThanOrExactly(1), requestPatternBuilder);\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/ignored/Examples.java", "new_path": "src/test/java/ignored/Examples.java", "diff": "@@ -369,4 +369,17 @@ public class Examples extends AcceptanceTestBase {\n.notifier(new ConsoleNotifier(true)\n);\n}\n+\n+ @Test\n+ public void abbregiatedDsl() {\n+ stubFor(get(\"/some/thing\").willReturn(aResponse().withStatus(200)));\n+\n+ stubFor(delete(\"/fine\").willReturn(ok()));\n+ stubFor(get(\"/json\").willReturn(okJson(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\n+ stubFor(post(\"/redirect\").willReturn(temporaryRedirect(\"/new/place\")));\n+ stubFor(post(\"/sorry-no\").willReturn(unauthorized()));\n+\n+ stubFor(put(\"/status-only\").willReturn(status(418)));\n+\n+ }\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Documented Java shortcuts and added status() shortcut to the DSL
687,010
05.03.2017 11:15:36
-3,600
51e95249ff2c947a08977df5d95c38b083f0a38b
Upgrade to latest version of zjsonpatch
[ { "change_type": "MODIFY", "old_path": "build.gradle", "new_path": "build.gradle", "diff": "@@ -61,7 +61,7 @@ dependencies {\nexclude group: \"org.hamcrest\", module: \"hamcrest-core\"\n}\ncompile 'org.apache.commons:commons-lang3:3.4'\n- compile 'com.flipkart.zjsonpatch:zjsonpatch:0.2.1'\n+ compile 'com.flipkart.zjsonpatch:zjsonpatch:0.3.0'\ncompile 'com.github.jknack:handlebars:4.0.6', {\nexclude group: 'org.mozilla', module: 'rhino'\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Upgrade to latest version of zjsonpatch
686,936
13.03.2017 09:16:48
0
bd14bd0ba1e3766ff4f1c14a3f35306f12d0a811
Fixed bug causing the same mapping to be recorded twice the first time round (stopping only after two identical requests seen).
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorder.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorder.java", "diff": "@@ -144,7 +144,7 @@ public class StubMappingJsonRecorder implements RequestListener {\nprivate boolean requestNotAlreadyReceived(RequestPattern requestPattern) {\nVerificationResult verificationResult = admin.countRequestsMatching(requestPattern);\nverificationResult.assertRequestJournalEnabled();\n- return (verificationResult.getCount() <= 1);\n+ return (verificationResult.getCount() < 1);\n}\npublic void setIdGenerator(IdGenerator idGenerator) {\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorderTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorderTest.java", "diff": "@@ -153,7 +153,7 @@ public class StubMappingJsonRecorderTest {\n@Test\npublic void doesNotWriteFileIfRequestAlreadyReceived() {\ncontext.checking(new Expectations() {{\n- atLeast(1).of(admin).countRequestsMatching(with(any(RequestPattern.class))); will(returnValue(VerificationResult.withCount(2)));\n+ atLeast(1).of(admin).countRequestsMatching(with(any(RequestPattern.class))); will(returnValue(VerificationResult.withCount(1)));\nnever(mappingsFileSource).writeTextFile(with(any(String.class)), with(any(String.class)));\nnever(filesFileSource).writeTextFile(with(any(String.class)), with(any(String.class)));\n}});\n@@ -162,7 +162,7 @@ public class StubMappingJsonRecorderTest {\n.withMethod(RequestMethod.GET)\n.withUrl(\"/headered/content\")\n.build(),\n- response().status(200).build());\n+ response().fromProxy(true).status(200).build());\n}\n@Test\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed bug causing the same mapping to be recorded twice the first time round (stopping only after two identical requests seen).
686,936
13.03.2017 22:30:57
0
10e092ac08a92927166364f906743aa3f8191b2d
Fix tests broken by fixing recorded file count bug
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/StandaloneAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/StandaloneAcceptanceTest.java", "diff": "@@ -23,6 +23,7 @@ import com.github.tomakehurst.wiremock.testsupport.WireMockResponse;\nimport com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\nimport com.google.common.base.Charsets;\nimport com.google.common.base.Predicate;\n+import com.google.common.base.Predicates;\nimport com.google.common.io.Files;\nimport org.apache.commons.io.FileUtils;\nimport org.apache.http.conn.HttpHostConnectException;\n@@ -45,7 +46,10 @@ import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;\nimport static com.github.tomakehurst.wiremock.testsupport.Network.findFreePort;\nimport static com.github.tomakehurst.wiremock.testsupport.TestHttpHeader.withHeader;\nimport static com.google.common.base.Charsets.UTF_8;\n+import static com.google.common.base.Predicates.containsPattern;\nimport static com.google.common.collect.Iterables.any;\n+import static com.google.common.collect.Iterables.filter;\n+import static com.google.common.collect.Iterables.size;\nimport static com.google.common.io.Files.createParentDirs;\nimport static com.google.common.io.Files.write;\nimport static java.io.File.separator;\n@@ -363,6 +367,22 @@ public class StandaloneAcceptanceTest {\nassertThat(mappingsDirectory, doesNotContainAFileWithNameContaining(\"try-to-record\"));\n}\n+ @Test\n+ public void doesNotRecordRequestWhenAlreadySeen() {\n+ WireMock otherServerClient = startOtherServerAndClient();\n+ startRunner(\"--record-mappings\");\n+ givenThat(get(urlEqualTo(\"/try-to/record-this\"))\n+ .willReturn(aResponse().proxiedFrom(\"http://localhost:\" + otherServer.port())));\n+ otherServerClient.register(\n+ get(urlEqualTo(\"/try-to/record-this\"))\n+ .willReturn(aResponse().withStatus(HTTP_OK).withBody(\"Proxied body\")));\n+\n+ testClient.get(\"/try-to/record-this\");\n+ testClient.get(\"/try-to/record-this\");\n+\n+ assertThat(mappingsDirectory, containsExactlyOneFileWithNameContaining(\"try-to-record\"));\n+ }\n+\n@Test\npublic void canBeShutDownRemotely() {\nstartRunner();\n@@ -527,31 +547,35 @@ public class StandaloneAcceptanceTest {\n@Override\npublic boolean matchesSafely(File dir) {\n- return !any(Arrays.<String>asList(dir.list()), new Predicate<String>() {\n- @Override\n- public boolean apply(String input) {\n- return input.contains(namePart);\n- }\n- });\n+ return !any(asList(dir.list()), contains(namePart));\n}\n};\n}\n- private Matcher<Exception> causedByHttpHostConnectException() {\n- return new TypeSafeMatcher<Exception>() {\n+ private Matcher<File> containsExactlyOneFileWithNameContaining(final String namePart) {\n+ return new TypeSafeMatcher<File>() {\n+\n@Override\n- public boolean matchesSafely(Exception o) {\n- if (!(o instanceof RuntimeException)) {\n- return false;\n+ public void describeTo(Description desc) {\n+ desc.appendText(\"exactly one file named like \" + namePart);\n+\n}\n- RuntimeException re = (RuntimeException)o;\n- return re.getCause() instanceof HttpHostConnectException;\n+\n+ @Override\n+ public boolean matchesSafely(File dir) {\n+ Iterable<String> fileNames = filter(asList(dir.list()), contains(namePart));\n+ return size(fileNames) == 1;\n+ }\n+\n+ };\n}\n+ private static Predicate<String> contains(final String part) {\n+ return new Predicate<String>() {\n@Override\n- public void describeTo(Description description) {\n- description.appendText(\"Expected RuntimeException with nested HttpHostConnectException\");\n+ public boolean apply(String s) {\n+ return s.contains(part);\n}\n};\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorderTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/stubbing/StubMappingJsonRecorderTest.java", "diff": "@@ -127,7 +127,7 @@ public class StubMappingJsonRecorderTest {\n@Test\npublic void addsResponseHeaders() {\ncontext.checking(new Expectations() {{\n- allowing(admin).countRequestsMatching(with(any(RequestPattern.class))); will(returnValue(VerificationResult.withCount(1)));\n+ allowing(admin).countRequestsMatching(with(any(RequestPattern.class))); will(returnValue(VerificationResult.withCount(0)));\none(mappingsFileSource).writeTextFile(with(equal(\"mapping-headered-content-1$2!3.json\")),\nwith(equalToJson(SAMPLE_REQUEST_MAPPING_WITH_HEADERS, STRICT_ORDER)));\none(filesFileSource).writeBinaryFile(\"body-headered-content-1$2!3.txt\", \"Recorded body content\".getBytes(UTF_8));\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fix tests broken by fixing recorded file count bug
686,936
13.03.2017 23:00:54
0
2ea6003c35015bd958acd6e94f566afa8ff576ef
Updated external resources page on the website
[ { "change_type": "MODIFY", "old_path": "docs-v2/external-resources/index.md", "new_path": "docs-v2/external-resources/index.md", "diff": "@@ -12,7 +12,7 @@ Code, articles and videos related to WireMock from around the web.\nSpring Contract Verifier (previously called Accurest) is a consumer driven contracts tool that generates WireMock stub mappings as\nexamples for client testing.\n-[http://codearte.github.io/accurest/](http://codearte.github.io/accurest/)\n+[http://cloud.spring.io/spring-cloud-contract/](http://cloud.spring.io/spring-cloud-contract/)\nA Spring REST Docs integration for WireMock that generates WireMock stub mappings from your test cases:<br>\n[https://github.com/epages-de/restdocs-wiremock](https://github.com/epages-de/restdocs-wiremock)\n@@ -58,6 +58,9 @@ Bas Dijkstra kindly open sourced the content for the workshop he ran on WireMock\n## Videos\n+Interesting and detailed presentation by Lotte Johansen on testing microservices with WireMock at Norway's top online marketplace:<br>\n+[https://www.youtube.com/watch?v=cmJfMnGK-r0](https://www.youtube.com/watch?v=cmJfMnGK-r0)\n+\nChris Batey did an excellent talk at Skillsmatter in London about building fault tolerant microservices. He showed some practical\nfailure testing strategies using WireMock and Saboteur he'd used for real while working at Sky:<br>\n[https://skillsmatter.com/skillscasts/5810-building-fault-tolerant-microservices](https://skillsmatter.com/skillscasts/5810-building-fault-tolerant-microservices)\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Updated external resources page on the website
686,936
14.03.2017 09:11:25
0
8d0f76b956263619d303f6729d777be232276e36
Added DSL shortcuts for XML
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -372,13 +372,25 @@ public class WireMock {\nreturn aResponse().withStatus(200).withBody(body);\n}\n- public static ResponseDefinitionBuilder okJson(String body) {\n+ public static ResponseDefinitionBuilder okForContentType(String contentType, String body) {\nreturn aResponse()\n.withStatus(200)\n- .withHeader(CONTENT_TYPE, \"application/json\")\n+ .withHeader(CONTENT_TYPE, contentType)\n.withBody(body);\n}\n+ public static ResponseDefinitionBuilder okJson(String body) {\n+ return okForContentType(\"application/json\", body);\n+ }\n+\n+ public static ResponseDefinitionBuilder okXml(String body) {\n+ return okForContentType(\"application/xml\", body);\n+ }\n+\n+ public static ResponseDefinitionBuilder okTextXml(String body) {\n+ return okForContentType(\"text/xml\", body);\n+ }\n+\npublic static MappingBuilder get(String url) {\nreturn get(urlEqualTo(url));\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/ignored/Examples.java", "new_path": "src/test/java/ignored/Examples.java", "diff": "@@ -376,6 +376,7 @@ public class Examples extends AcceptanceTestBase {\nstubFor(delete(\"/fine\").willReturn(ok()));\nstubFor(get(\"/json\").willReturn(okJson(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\n+ stubFor(get(\"/xml\").willReturn(okXml(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\nstubFor(post(\"/redirect\").willReturn(temporaryRedirect(\"/new/place\")));\nstubFor(post(\"/sorry-no\").willReturn(unauthorized()));\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added DSL shortcuts for XML
686,936
15.03.2017 09:15:03
0
40e0dd03421801dd2835c771ee787b978d085ee2
Added proxyAll DSL shortcut. Improved DSL shortcuts docs and examples.
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/stubbing.md", "new_path": "docs-v2/_docs/stubbing.md", "diff": "@@ -89,6 +89,8 @@ stubFor(put(\"/status-only\")\n```\n+More DSL examples [can be found here](https://github.com/tomakehurst/wiremock/tree/master/src/test/java/ignored/Examples.java#374).\n+\nHTTP methods currently supported are:\n`GET, POST, PUT, DELETE, HEAD, TRACE, OPTIONS`. You can specify `ANY` if\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -391,6 +391,10 @@ public class WireMock {\nreturn okForContentType(\"text/xml\", body);\n}\n+ public static MappingBuilder proxyAllTo(String url) {\n+ return any(anyUrl()).willReturn(aResponse().proxiedFrom(url));\n+ }\n+\npublic static MappingBuilder get(String url) {\nreturn get(urlEqualTo(url));\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/ignored/Examples.java", "new_path": "src/test/java/ignored/Examples.java", "diff": "@@ -371,16 +371,32 @@ public class Examples extends AcceptanceTestBase {\n}\n@Test\n- public void abbregiatedDsl() {\n+ public void abbreviatedDsl() {\nstubFor(get(\"/some/thing\").willReturn(aResponse().withStatus(200)));\nstubFor(delete(\"/fine\").willReturn(ok()));\nstubFor(get(\"/json\").willReturn(okJson(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\n- stubFor(get(\"/xml\").willReturn(okXml(\"{ \\\"message\\\": \\\"Hello\\\" }\")));\n- stubFor(post(\"/redirect\").willReturn(temporaryRedirect(\"/new/place\")));\n+ stubFor(get(\"/xml\").willReturn(okXml(\"<hello />\"))); // application/xml\n+ stubFor(get(\"/xml\").willReturn(okTextXml(\"<hello />\"))); // text/xml\n+ stubFor(post(\"/things\").willReturn(noContent()));\n+\n+ stubFor(post(\"/temp-redirect\").willReturn(temporaryRedirect(\"/new/place\")));\n+ stubFor(post(\"/perm-redirect\").willReturn(permanentRedirect(\"/new/place\")));\n+ stubFor(post(\"/see-other\").willReturn(seeOther(\"/new/place\")));\n+\nstubFor(post(\"/sorry-no\").willReturn(unauthorized()));\n+ stubFor(post(\"/still-no\").willReturn(forbidden()));\n+\n+ stubFor(put(\"/dodgy\").willReturn(badRequest()));\n+ stubFor(put(\"/dodgy-body\").willReturn(badRequestEntity()));\n+ stubFor(put(\"/nothing-to-see-here\").willReturn(notFound()));\nstubFor(put(\"/status-only\").willReturn(status(418)));\n+ stubFor(get(\"/dead-server\").willReturn(serviceUnavailable()));\n+ stubFor(put(\"/error\").willReturn(serverError()));\n+\n+ stubFor(proxyAllTo(\"http://my.example.com\"));\n+\n}\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added proxyAll DSL shortcut. Improved DSL shortcuts docs and examples.
686,960
28.03.2017 14:53:53
-7,200
6bbc97e8af82ae8d7df4932b68bf44adc6e2b6a3
added proxy settings to connect to remote wiremock server over a http proxy e.g. WireMock instance = new WireMock("https", "wiremock.server.url", 443, null, "" "proxyhost", proxyport);
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/HttpAdminClient.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/HttpAdminClient.java", "diff": "*/\npackage com.github.tomakehurst.wiremock.client;\n-import com.github.tomakehurst.wiremock.admin.*;\n+import com.github.tomakehurst.wiremock.admin.AdminRoutes;\n+import com.github.tomakehurst.wiremock.admin.AdminTask;\n+import com.github.tomakehurst.wiremock.admin.RequestSpec;\nimport com.github.tomakehurst.wiremock.admin.model.*;\nimport com.github.tomakehurst.wiremock.admin.tasks.*;\nimport com.github.tomakehurst.wiremock.common.AdminException;\nimport com.github.tomakehurst.wiremock.common.Json;\n+import com.github.tomakehurst.wiremock.common.ProxySettings;\nimport com.github.tomakehurst.wiremock.core.Admin;\nimport com.github.tomakehurst.wiremock.global.GlobalSettings;\nimport com.github.tomakehurst.wiremock.http.HttpClientFactory;\n@@ -29,6 +32,7 @@ import com.github.tomakehurst.wiremock.verification.FindNearMissesResult;\nimport com.github.tomakehurst.wiremock.verification.FindRequestsResult;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\nimport com.github.tomakehurst.wiremock.verification.VerificationResult;\n+import org.apache.commons.lang3.StringUtils;\nimport org.apache.http.client.methods.*;\nimport org.apache.http.entity.StringEntity;\nimport org.apache.http.impl.client.CloseableHttpClient;\n@@ -39,7 +43,8 @@ import static com.github.tomakehurst.wiremock.common.Exceptions.throwUnchecked;\nimport static com.github.tomakehurst.wiremock.common.HttpClientUtils.getEntityAsStringAndCloseStream;\nimport static com.google.common.base.Charsets.UTF_8;\nimport static com.google.common.base.Preconditions.checkNotNull;\n-import static java.net.HttpURLConnection.*;\n+import static java.net.HttpURLConnection.HTTP_NO_CONTENT;\n+import static java.net.HttpURLConnection.HTTP_OK;\nimport static org.apache.http.HttpHeaders.HOST;\npublic class HttpAdminClient implements Admin {\n@@ -65,10 +70,16 @@ public class HttpAdminClient implements Admin {\n}\npublic HttpAdminClient(String scheme, String host, int port, String urlPathPrefix) {\n- this(scheme, host, port, urlPathPrefix, null);\n+ this(scheme, host, port, urlPathPrefix, null, null, 0);\n}\n- public HttpAdminClient(String scheme, String host, int port, String urlPathPrefix, String hostHeader) {\n+ public HttpAdminClient(String scheme,\n+ String host,\n+ int port,\n+ String urlPathPrefix,\n+ String hostHeader,\n+ String proxyHost,\n+ int proxyPort) {\nthis.scheme = scheme;\nthis.host = host;\nthis.port = port;\n@@ -77,13 +88,17 @@ public class HttpAdminClient implements Admin {\nadminRoutes = AdminRoutes.defaults();\n- httpClient = HttpClientFactory.createClient();\n+ httpClient = HttpClientFactory.createClient(createProxySettings(proxyHost, proxyPort));\n}\npublic HttpAdminClient(String host, int port) {\nthis(host, port, \"\");\n}\n+ private static StringEntity jsonStringEntity(String json) {\n+ return new StringEntity(json, UTF_8.name());\n+ }\n+\n@Override\npublic void addStubMapping(StubMapping stubMapping) {\nif (stubMapping.getRequest().hasCustomMatcher()) {\n@@ -252,6 +267,13 @@ public class HttpAdminClient implements Admin {\nreturn port;\n}\n+ private ProxySettings createProxySettings(String proxyHost, int proxyPort) {\n+ if(StringUtils.isNotBlank(proxyHost)) {\n+ return new ProxySettings(proxyHost, proxyPort);\n+ }\n+ return ProxySettings.NO_PROXY;\n+ }\n+\nprivate String postJsonAssertOkAndReturnBody(String url, String json, int expectedStatus) {\nHttpPost post = new HttpPost(url);\nif (json != null) {\n@@ -261,10 +283,6 @@ public class HttpAdminClient implements Admin {\nreturn safelyExecuteRequest(url, expectedStatus, post);\n}\n- private static StringEntity jsonStringEntity(String json) {\n- return new StringEntity(json, UTF_8.name());\n- }\n-\nprotected String getJsonAssertOkAndReturnBody(String url, int expectedStatus) {\nHttpGet get = new HttpGet(url);\nreturn safelyExecuteRequest(url, expectedStatus, get);\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -86,6 +86,10 @@ public class WireMock {\nadmin = new HttpAdminClient(scheme, host, port, urlPathPrefix);\n}\n+ public WireMock(String scheme, String host, int port, String urlPathPrefix, String hostHeader, String proxyHost, int proxyPort) {\n+ admin = new HttpAdminClient(scheme, host, port, urlPathPrefix, hostHeader, proxyHost, proxyPort);\n+ }\n+\npublic WireMock() {\nadmin = new HttpAdminClient(DEFAULT_HOST, DEFAULT_PORT);\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/HttpClientFactory.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/HttpClientFactory.java", "diff": "@@ -41,9 +41,13 @@ import static com.github.tomakehurst.wiremock.http.RequestMethod.*;\npublic class HttpClientFactory {\npublic static final int DEFAULT_MAX_CONNECTIONS = 50;\n+ public static final int DEFAULT_TIMEOUT = 30000;\npublic static CloseableHttpClient createClient(\n- int maxConnections, int timeoutMilliseconds, ProxySettings proxySettings, KeyStoreSettings trustStoreSettings) {\n+ int maxConnections,\n+ int timeoutMilliseconds,\n+ ProxySettings proxySettings,\n+ KeyStoreSettings trustStoreSettings) {\nHttpClientBuilder builder = HttpClientBuilder.create()\n.disableAuthCaching()\n@@ -104,8 +108,12 @@ public class HttpClientFactory {\nreturn createClient(DEFAULT_MAX_CONNECTIONS, timeoutMilliseconds);\n}\n+ public static CloseableHttpClient createClient(ProxySettings proxySettings) {\n+ return createClient(DEFAULT_MAX_CONNECTIONS, DEFAULT_TIMEOUT, proxySettings, NO_STORE);\n+ }\n+\npublic static CloseableHttpClient createClient() {\n- return createClient(30000);\n+ return createClient(DEFAULT_TIMEOUT);\n}\npublic static HttpUriRequest getHttpRequestFor(RequestMethod method, String url) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
added proxy settings to connect to remote wiremock server over a http proxy e.g. WireMock instance = new WireMock("https", "wiremock.server.url", 443, null, "" "proxyhost", proxyport);
686,933
06.04.2017 13:23:28
-7,200
77743d03594da1b00d83838b29ffb21aea4b9bf2
Prevent null pointer exception when getting MimeTypePart
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/ContentTypeHeader.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/ContentTypeHeader.java", "diff": "@@ -41,7 +41,7 @@ public class ContentTypeHeader extends HttpHeader {\n}\npublic String mimeTypePart() {\n- return parts[0];\n+ return parts != null ? parts[0] : null;\n}\npublic Optional<String> encodingPart() {\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/http/ContentTypeHeaderTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/http/ContentTypeHeaderTest.java", "diff": "@@ -24,6 +24,7 @@ import org.junit.Test;\nimport org.junit.runner.RunWith;\nimport static org.hamcrest.Matchers.is;\n+import static org.hamcrest.Matchers.nullValue;\nimport static org.junit.Assert.assertFalse;\nimport static org.junit.Assert.assertThat;\nimport static org.junit.Assert.assertTrue;\n@@ -93,4 +94,10 @@ public class ContentTypeHeaderTest {\nrequest.contentTypeHeader();\n}\n+\n+ @Test\n+ public void returnsNullFromMimeTypePartWhenContentTypeIsAbsent() {\n+ ContentTypeHeader header = ContentTypeHeader.absent();\n+ assertThat(header.mimeTypePart(), is(nullValue()));\n+ }\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
#643 Prevent null pointer exception when getting MimeTypePart
686,936
06.04.2017 14:16:33
-3,600
211a0e271c6b20f3b25579cc7bf27b1ea47a06ed
Attempt to make post serve action tests less flakey by extending timeouts. Switched away from countdown latch to async test framework code.
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/PostServeActionExtensionTest.java", "diff": "@@ -18,7 +18,6 @@ import org.junit.Test;\nimport java.util.concurrent.Callable;\nimport java.util.concurrent.ConcurrentHashMap;\n-import java.util.concurrent.CountDownLatch;\nimport java.util.concurrent.atomic.AtomicInteger;\nimport static com.github.tomakehurst.wiremock.PostServeActionExtensionTest.CounterNameParameter.counterNameParameter;\n@@ -27,9 +26,8 @@ import static com.github.tomakehurst.wiremock.client.WireMock.*;\nimport static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.google.common.base.MoreObjects.firstNonNull;\n-import static java.util.concurrent.TimeUnit.MILLISECONDS;\n+import static java.util.concurrent.TimeUnit.SECONDS;\nimport static org.awaitility.Awaitility.await;\n-import static org.awaitility.Duration.ONE_SECOND;\nimport static org.hamcrest.Matchers.is;\nimport static org.junit.Assert.assertThat;\n@@ -70,19 +68,10 @@ public class PostServeActionExtensionTest {\nclient.get(\"/count-me\");\nawait()\n- .atMost(ONE_SECOND)\n+ .atMost(5, SECONDS)\n.until(getContent(\"/__admin/named-counter/things\"), is(\"4\"));\n}\n- private Callable<String> getContent(final String url) {\n- return new Callable<String>() {\n- @Override\n- public String call() throws Exception {\n- return client.get(url).content();\n- }\n- };\n- }\n-\n@Test\npublic void continuesWithNoEffectIfANonExistentActionIsReferenced() {\ninitWithOptions(options().dynamicPort());\n@@ -101,7 +90,6 @@ public class PostServeActionExtensionTest {\n@Test\npublic void providesServeEventWithResponseFieldPopulated() throws InterruptedException {\nfinal AtomicInteger finalStatus = new AtomicInteger();\n- final CountDownLatch countDownLatch = new CountDownLatch(1);\ninitWithOptions(options().dynamicPort().extensions(new PostServeAction() {\n@Override\npublic String getName() {\n@@ -111,21 +99,39 @@ public class PostServeActionExtensionTest {\n@Override\npublic void doGlobalAction(ServeEvent serveEvent, Admin admin) {\nif (serveEvent.getResponse() != null) {\n- countDownLatch.countDown();\nfinalStatus.set(serveEvent.getResponse().getStatus());\n}\n}\n}));\nwm.stubFor(get(urlPathEqualTo(\"/response-status\"))\n- .willReturn(aResponse().withStatus(418))\n+ .willReturn(aResponse()\n+ .withStatus(418))\n);\nclient.get(\"/response-status\");\n- countDownLatch.await(1500, MILLISECONDS);\n+ await()\n+ .atMost(5, SECONDS)\n+ .until(getValue(finalStatus), is(418));\n+ }\n- assertThat(finalStatus.get(), is(418));\n+ private Callable<Integer> getValue(final AtomicInteger value) {\n+ return new Callable<Integer>() {\n+ @Override\n+ public Integer call() throws Exception {\n+ return value.get();\n+ }\n+ };\n+ }\n+\n+ private Callable<String> getContent(final String url) {\n+ return new Callable<String>() {\n+ @Override\n+ public String call() throws Exception {\n+ return client.get(url).content();\n+ }\n+ };\n}\npublic static class NamedCounterAction extends PostServeAction implements AdminApiExtension {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Attempt to make post serve action tests less flakey by extending timeouts. Switched away from countdown latch to async test framework code.
686,936
06.04.2017 14:53:01
-3,600
08a817936df1b2836f9915e06e8ce60cc2ec40c8
Added shading of Handlebars and Antlr to the build
[ { "change_type": "MODIFY", "old_path": "build.gradle", "new_path": "build.gradle", "diff": "@@ -151,6 +151,8 @@ shadowJar {\nrelocate \"org.custommonkey\", \"wiremock.org.custommonkey\"\nrelocate \"com.flipkart\", \"wiremock.com.flipkart\"\nrelocate \"net.sf\", \"wiremock.net.sf\"\n+ relocate \"com.github.jknack\", \"wiremock.com.github.jknack\"\n+ relocate \"org.antlr\", \"wiremock.org.antlr\"\ndependencies {\nexclude(dependency('junit:junit'))\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Added shading of Handlebars and Antlr to the build
686,936
06.04.2017 15:07:26
-3,600
da0cf4428aa625d0e2ca53a550b907b612cdcacc
Fixed - incorrectly documented default thread count
[ { "change_type": "MODIFY", "old_path": "docs-v2/_docs/running-standalone.md", "new_path": "docs-v2/_docs/running-standalone.md", "diff": "@@ -82,7 +82,7 @@ exhausting the heap. The `--record-mappings` option isn't available if\nthis one is specified.\n`--container-threads`: The number of threads created for incoming\n-requests. Defaults to 200.\n+requests. Defaults to 10.\n`--max-request-journal-entries`: Set maximum number of entries in\nrequest journal (if enabled). When this limit is reached oldest entries\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fixed #598 - incorrectly documented default thread count
686,972
10.04.2017 11:11:47
-3,600
9dcbfd02bcca05714f0bda73ce542892c3af0fa8
Suggested API doc change to fix
[ { "change_type": "MODIFY", "old_path": "src/main/resources/raml/wiremock-admin-api.raml", "new_path": "src/main/resources/raml/wiremock-admin-api.raml", "diff": "@@ -162,6 +162,14 @@ schemas:\nbody:\napplication/json:\nexample: !include examples/serve-events.example.json\n+ delete:\n+ description: Delete all received requests\n+ responses:\n+ 200:\n+ description: Successfully deleted\n+ body:\n+ application/json:\n+ example: !include examples/empty.example.json\n/{requestId}:\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Suggested API doc change to fix #581
686,960
11.04.2017 11:21:36
-7,200
42b5d1f053523b15b34dd30cba2badb989039ed5
added proxy settings to connect to remote wiremock server over a http proxy e.g. WireMock instance = new WireMock("https", "wiremock.server.url", 443, null, "" "proxyhost", proxyport); See WireMockClientWithProxyAcceptanceTest
[ { "change_type": "MODIFY", "old_path": "build.gradle", "new_path": "build.gradle", "diff": "@@ -60,7 +60,7 @@ dependencies {\ncompile(\"junit:junit:4.12\") {\nexclude group: \"org.hamcrest\", module: \"hamcrest-core\"\n}\n- compile 'org.apache.commons:commons-lang3:3.4'\n+ compile 'org.apache.commons:commons-lang3:3.5'\ncompile 'com.flipkart.zjsonpatch:zjsonpatch:0.2.1'\ncompile 'com.github.jknack:handlebars:4.0.6', {\nexclude group: 'org.mozilla', module: 'rhino'\n@@ -84,6 +84,7 @@ dependencies {\ntestCompile \"com.googlecode.jarjar:jarjar:1.3\"\ntestCompile \"commons-io:commons-io:2.4\"\ntestCompile 'org.scala-lang:scala-library:2.11.8'\n+ testCompile 'org.littleshoot:littleproxy:1.1.2'\ntestRuntime 'org.slf4j:slf4j-log4j12:1.7.12'\ntestRuntime files('src/test/resources/classpath file source/classpathfiles.zip', 'src/test/resources/classpath-filesource.jar')\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java", "diff": "@@ -142,6 +142,10 @@ public class WireMock {\ndefaultInstance.set(new WireMock(scheme, host, port));\n}\n+ public static void configureFor(String scheme, String host, int port, String proxyHost, int proxyPort) {\n+ defaultInstance.set(new WireMock(scheme, host, port, \"\", null, proxyHost, proxyPort));\n+ }\n+\npublic static void configure() {\ndefaultInstance.set(new WireMock());\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
added proxy settings to connect to remote wiremock server over a http proxy e.g. WireMock instance = new WireMock("https", "wiremock.server.url", 443, null, "" "proxyhost", proxyport); See WireMockClientWithProxyAcceptanceTest
686,958
02.05.2017 10:01:39
-3,600
2330049834abf8ff766a03786ff01309613645f1
Issue - Added check to remove trailing forward slash if found in proxy URL
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/ProxyResponseRenderer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/ProxyResponseRenderer.java", "diff": "@@ -95,7 +95,10 @@ public class ProxyResponseRenderer implements ResponseRenderer {\npublic static HttpUriRequest getHttpRequestFor(ResponseDefinition response) {\nfinal RequestMethod method = response.getOriginalRequest().getMethod();\n- final String url = response.getProxyUrl();\n+ String url = response.getProxyUrl();\n+ if (url.endsWith(\"/\")) {\n+ url = url.substring(0, url.length() - 1);\n+ }\nreturn HttpClientFactory.getHttpRequestFor(method, url);\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Issue #655 - Added check to remove trailing forward slash if found in proxy URL
687,032
04.05.2017 18:07:09
-10,800
e0c4c46fa75d4e7391fabcd558018be24782a1a4
Enabled query parameters to be logged in request log separately from the URL
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/QueryParameter.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/QueryParameter.java", "diff": "*/\npackage com.github.tomakehurst.wiremock.http;\n+import com.fasterxml.jackson.annotation.*;\n+\nimport java.util.Collections;\nimport java.util.List;\n@@ -22,7 +24,8 @@ import static java.util.Arrays.asList;\npublic class QueryParameter extends MultiValue {\n- public QueryParameter(String key, List<String> values) {\n+ @JsonCreator\n+ public QueryParameter(@JsonProperty(\"key\") String key, @JsonProperty(\"values\") List<String> values) {\nsuper(key, values);\n}\n@@ -33,4 +36,28 @@ public class QueryParameter extends MultiValue {\npublic static QueryParameter absent(String key) {\nreturn new QueryParameter(key, Collections.<String>emptyList());\n}\n+\n+ @JsonIgnore\n+ @Override\n+ public boolean isPresent() {\n+ return super.isPresent();\n+ }\n+\n+ @JsonProperty\n+ @Override\n+ public String key() {\n+ return super.key();\n+ }\n+\n+ @JsonProperty\n+ @Override\n+ public List<String> values() {\n+ return super.values();\n+ }\n+\n+ @JsonIgnore\n+ @Override\n+ public boolean isSingleValued() {\n+ return super.isSingleValued();\n+ }\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/verification/LoggedRequest.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/verification/LoggedRequest.java", "diff": "@@ -166,6 +166,11 @@ public class LoggedRequest implements Request {\nreturn firstNonNull(queryParams.get(key), QueryParameter.absent(key));\n}\n+ @JsonProperty(\"queryParams\")\n+ public Map<String, QueryParameter> getQueryParams() {\n+ return queryParams;\n+ }\n+\npublic HttpHeaders getHeaders() {\nreturn headers;\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/verification/LoggedRequestTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/verification/LoggedRequestTest.java", "diff": "*/\npackage com.github.tomakehurst.wiremock.verification;\n+import com.fasterxml.jackson.databind.ObjectMapper;\nimport com.github.tomakehurst.wiremock.common.Dates;\nimport com.github.tomakehurst.wiremock.common.Json;\nimport com.github.tomakehurst.wiremock.http.HttpHeaders;\n@@ -29,7 +30,9 @@ import org.junit.Test;\nimport org.junit.runner.RunWith;\nimport org.skyscreamer.jsonassert.JSONAssert;\n+import java.io.IOException;\nimport java.util.Date;\n+import java.util.List;\nimport java.util.Map;\nimport java.util.TimeZone;\n@@ -140,4 +143,56 @@ public class LoggedRequestTest {\nassertThat(loggedRequest.getBodyAsString(), is(equalTo(REQUEST_BODY)));\n}\n+\n+ static final String JSON_PARAMS_EXAMPLE = \"{\\n\" +\n+ \" \\\"url\\\" : \\\"/sample/path?test-param-1=value1&test-param-2=value2\\\",\\n\" +\n+ \" \\\"absoluteUrl\\\" : \\\"http://ex.ample/sample/path?test-param-1=value1&test-param-2=value2\\\",\\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\",\\n\" +\n+ \" \\\"clientIp\\\" : \\\"0.0.0.0\\\",\\n\" +\n+ \" \\\"browserProxyRequest\\\" : true,\\n\" +\n+ \" \\\"loggedDate\\\" : 0,\\n\" +\n+ \" \\\"loggedDateString\\\" : \\\"1970-01-01T00:00:00Z\\\",\\n\" +\n+ \" \\\"queryParams\\\" : {\\n\" +\n+ \" \\\"test-param-1\\\" : {\\n\" +\n+ \" \\\"key\\\" : \\\"test-param-1\\\",\\n\" +\n+ \" \\\"values\\\" : [ \\\"value-1\\\" ]\\n\" +\n+ \" },\\n\" +\n+ \" \\\"test-param-2\\\" : {\\n\" +\n+ \" \\\"key\\\" : \\\"test-param-2\\\",\\n\" +\n+ \" \\\"values\\\" : [ \\\"value-2\\\" ]\\n\" +\n+ \" }\\n\" +\n+ \" }\\n\" +\n+ \"}\";\n+\n+ @Test\n+ public void queryParametersAreSerialized() {\n+ LoggedRequest req = new LoggedRequest(\n+ \"/sample/path?test-param-1=value-1&test-param-2=value-2\",\n+ \"http://ex.ample/sample/path?test-param-1=value-1&test-param-2=value-2\",\n+ RequestMethod.GET,\n+ \"0.0.0.0\",\n+ null,\n+ null,\n+ true,\n+ new Date(0),\n+ null,\n+ null);\n+\n+ Map<String, Object> reqMap = Json.objectToMap(req);\n+\n+ assertTrue(reqMap.containsKey(\"queryParams\"));\n+ assertEquals(\"value-1\", ((List)((Map)((Map)reqMap.get(\"queryParams\")).get(\"test-param-1\")).get(\"values\")).get(0));\n+ assertEquals(\"value-2\", ((List)((Map)((Map)reqMap.get(\"queryParams\")).get(\"test-param-2\")).get(\"values\")).get(0));\n+ }\n+\n+ @Test\n+ public void queryParametersAreDeserialized() throws IOException {\n+ LoggedRequest req = new ObjectMapper().readValue(JSON_PARAMS_EXAMPLE, LoggedRequest.class);\n+\n+ assertEquals(\"test-param-1\", req.queryParameter(\"test-param-1\").key());\n+ assertEquals(\"value-1\" , req.queryParameter(\"test-param-1\").firstValue());\n+\n+ assertEquals(\"test-param-2\", req.queryParameter(\"test-param-2\").key());\n+ assertEquals(\"value-2\" , req.queryParameter(\"test-param-2\").firstValue());\n+ }\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Enabled query parameters to be logged in request log separately from the URL
686,965
03.06.2017 21:08:14
25,200
3fb618be8100c88e6ac5f5bea95c9e28e20f7aef
Fix "persist" flag to default to true
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -2,6 +2,7 @@ package com.github.tomakehurst.wiremock.admin.model;\nimport com.fasterxml.jackson.annotation.JsonCreator;\nimport com.fasterxml.jackson.annotation.JsonProperty;\n+import com.fasterxml.jackson.databind.JsonNode;\nimport com.github.tomakehurst.wiremock.http.RequestFieldsComparator;\nimport com.github.tomakehurst.wiremock.matching.MultiValuePattern;\n@@ -28,11 +29,11 @@ public class SnapshotSpec {\n@JsonProperty(\"sortFields\") String[] sortFields,\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n@JsonProperty(\"outputFormat\") String outputFormat,\n- @JsonProperty(\"persist\") boolean persist) {\n+ @JsonProperty(\"persist\") JsonNode persistNode) {\nthis.filters = filters;\nthis.outputFormat = outputFormat;\nthis.captureHeaders = new RequestPatternTransformer(captureHeaders);\n- this.persist = persist;\n+ this.persist = persistNode.asBoolean(true);\nif (sortFields != null) this.sortFields = new RequestFieldsComparator(sortFields);\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -14,8 +14,10 @@ import com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\nimport org.jmock.Expectations;\nimport org.jmock.Mockery;\n+import org.jmock.integration.junit4.JMock;\nimport org.junit.Before;\nimport org.junit.Test;\n+import org.junit.runner.RunWith;\nimport java.util.Arrays;\nimport java.util.UUID;\n@@ -31,6 +33,7 @@ import static java.net.HttpURLConnection.HTTP_OK;\nimport static org.hamcrest.MatcherAssert.assertThat;\nimport static org.junit.Assert.assertEquals;\n+@RunWith(JMock.class)\npublic class SnapshotTaskTest {\nprivate Mockery context;\nprivate Admin mockAdmin;\n@@ -58,15 +61,22 @@ public class SnapshotTaskTest {\nexpectedStub.setId(UUID.fromString(\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\"));\ncontext.checking(new Expectations() {{\n- oneOf(mockAdmin).addStubMapping(with(expectedStub));\n+ exactly(2).of(mockAdmin).addStubMapping(with(expectedStub));\n}});\nsetReturnForGetStubMapping(null);\n+ // Check when explicitly set\nassertThat(\nexecute(\"{ \\\"persist\\\": true}\"),\nequalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n);\n+\n+ // Check with default value of true\n+ assertThat(\n+ execute(\"{}\"),\n+ equalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n+ );\n}\n@Test\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Fix "persist" flag to default to true
686,965
10.06.2017 00:42:20
25,200
97a767f8cc834ed39499c81af419c87e6ff62241
Add ability to filter by ServeEvent ids
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/ServeEventRequestFilters.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/ServeEventRequestFilters.java", "diff": "@@ -7,22 +7,37 @@ import com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.google.common.base.Predicate;\n+import java.util.List;\n+import java.util.UUID;\n+\n/**\n- * A collection a RequestPattern filters to apply to ServeEvents\n+ * A collection a RequestPattern filters and IDs to apply to ServeEvents\n*/\npublic class ServeEventRequestFilters implements Predicate<ServeEvent> {\n@JsonUnwrapped\nprivate final RequestPattern filters;\n+ private final List<UUID> ids;\n@JsonCreator\n- public ServeEventRequestFilters(@JsonProperty(\"filters\") RequestPattern filters) {\n+ public ServeEventRequestFilters(\n+ @JsonProperty(\"filters\") RequestPattern filters,\n+ @JsonProperty(\"ids\") List<UUID> ids\n+ ) {\nthis.filters = filters;\n+ this.ids = ids;\n}\n@Override\npublic boolean apply(ServeEvent serveEvent) {\n- return filters\n- .match(serveEvent.getRequest())\n- .isExactMatch();\n+ if (\n+ filters != null\n+ && !filters.match(serveEvent.getRequest()).isExactMatch()\n+ ) {\n+ return false;\n+ }\n+ if (ids != null && !ids.contains(serveEvent.getId())) {\n+ return false;\n+ }\n+ return true;\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/ServeEventRequestFiltersTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/ServeEventRequestFiltersTest.java", "diff": "@@ -6,6 +6,10 @@ import com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport org.junit.Test;\n+import java.util.Arrays;\n+import java.util.List;\n+import java.util.UUID;\n+\nimport static com.github.tomakehurst.wiremock.client.WireMock.anyUrl;\nimport static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\n@@ -17,13 +21,13 @@ import static org.junit.Assert.*;\npublic class ServeEventRequestFiltersTest {\n@Test\npublic void applyWithUniversalRequestPattern() {\n- ServeEventRequestFilters filters = new ServeEventRequestFilters(RequestPattern.ANYTHING);\n+ ServeEventRequestFilters filters = new ServeEventRequestFilters(RequestPattern.ANYTHING, null);\nassertTrue(filters.apply(toServeEvent(mockRequest())));\n}\n@Test\n- public void applyWithUrlPattern() {\n- ServeEventRequestFilters filters = new ServeEventRequestFilters(newRequestPattern(GET, anyUrl()).build());\n+ public void applyWitMethodPattern() {\n+ ServeEventRequestFilters filters = new ServeEventRequestFilters(newRequestPattern(GET, anyUrl()).build(), null);\nMockRequest request = mockRequest().method(GET).url(\"/foo\");\nassertTrue(filters.apply(toServeEvent(request)));\n@@ -31,9 +35,22 @@ public class ServeEventRequestFiltersTest {\nassertFalse(filters.apply(toServeEvent(request.method(POST))));\n}\n+ @Test\n+ public void applyWithIds() {\n+ List<UUID> ids = Arrays.asList(\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000000\"),\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000001\")\n+ );\n+ ServeEventRequestFilters filters = new ServeEventRequestFilters(null, ids);\n+\n+ assertTrue(filters.apply(toServeEvent(ids.get(0))));\n+ assertTrue(filters.apply(toServeEvent(ids.get(1))));\n+ assertFalse(filters.apply(toServeEvent(UUID.fromString(\"00000000-0000-0000-0000-000000000002\"))));\n+ }\n+\n@Test\npublic void applyWithMethodAndUrlPattern() {\n- ServeEventRequestFilters filters = new ServeEventRequestFilters(newRequestPattern(GET, urlEqualTo(\"/foo\")).build());\n+ ServeEventRequestFilters filters = new ServeEventRequestFilters(newRequestPattern(GET, urlEqualTo(\"/foo\")).build(), null);\nMockRequest request = mockRequest().method(GET).url(\"/foo\");\nassertTrue(filters.apply(toServeEvent(request)));\n@@ -41,7 +58,39 @@ public class ServeEventRequestFiltersTest {\nassertFalse(filters.apply(toServeEvent(request.method(POST))));\n}\n+ @Test\n+ public void applyWithIdsAndMethodPattern() {\n+ MockRequest request = mockRequest().method(GET).url(\"/foo\");\n+ List<UUID> ids = Arrays.asList(\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000000\"),\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000001\")\n+ );\n+ ServeEventRequestFilters filters = new ServeEventRequestFilters(\n+ newRequestPattern(GET, anyUrl()).build(),\n+ ids\n+ );\n+\n+ assertTrue(filters.apply(toServeEvent(ids.get(0), request)));\n+ assertFalse(filters.apply(toServeEvent(UUID.fromString(\"00000000-0000-0000-0000-000000000002\"), request)));\n+ assertFalse(filters.apply(toServeEvent(ids.get(0), request.method(POST))));\n+ }\n+\n+ private ServeEvent toServeEvent(UUID id, MockRequest request) {\n+ return new ServeEvent(\n+ id,\n+ request != null ? request.asLoggedRequest() : null,\n+ null,\n+ null,\n+ null,\n+ true\n+ );\n+ }\n+\nprivate ServeEvent toServeEvent(MockRequest request) {\n- return ServeEvent.forUnmatchedRequest(request.asLoggedRequest());\n+ return toServeEvent(null, request);\n+ }\n+\n+ private ServeEvent toServeEvent(UUID id) {\n+ return toServeEvent(id, null);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -129,7 +129,7 @@ public class SnapshotTaskTest {\n);\n}\n- private static final String FILTERED_SNAPSHOT_REQUEST =\n+ private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST =\n\"{ \\n\" +\n\" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n\" \\\"persist\\\": \\\"false\\\", \\n\" +\n@@ -141,7 +141,7 @@ public class SnapshotTaskTest {\n\" } \\n\" +\n\"} \";\n- private static final String FILTERED_SNAPSHOT_RESPONSE =\n+ private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE =\n\"[ \\n\" +\n\" { \\n\" +\n\" \\\"id\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\", \\n\" +\n@@ -168,7 +168,7 @@ public class SnapshotTaskTest {\n\" ] \";\n@Test\n- public void returnsFilteredRequestsWithFullOutputFormat() {\n+ public void returnsFilteredRequestsWithJustRequestPatternsAndFullOutputFormat() {\nsetServeEvents(\n// Matches both\nserveEvent(mockRequest().url(\"/foo/bar\").header(\"A\",\"B\"), response(), true),\n@@ -182,7 +182,70 @@ public class SnapshotTaskTest {\nserveEvent(mockRequest().url(\"/foo/bar/baz\").header(\"A\",\"B\"), response(), true)\n);\nsetReturnForGetStubMapping(null);\n- assertThat(execute(FILTERED_SNAPSHOT_REQUEST), equalToJson(FILTERED_SNAPSHOT_RESPONSE));\n+ assertThat(\n+ execute(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE)\n+ );\n+ }\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"filters\\\": { \\n\" +\n+ \" \\\"ids\\\": [ \\n\" +\n+ \" \\\"00000000-0000-0000-0000-000000000001\\\", \\n\" +\n+ \" \\\"00000000-0000-0000-0000-000000000002\\\" \\n\" +\n+ \" ], \\n\" +\n+ \" \\\"urlPattern\\\": \\\"/foo.*\\\" \\n\" +\n+ \" } \\n\" +\n+ \"} \";\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"id\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\", \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"uuid\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\" \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsFilteredRequestsWithRequestPatternAndIdsWithFullOutputFormat() {\n+ setServeEvents(\n+ // Matches both\n+ serveEvent(\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000001\"),\n+ mockRequest().url(\"/foo/bar\"),\n+ response(),\n+ true\n+ ),\n+ // Fails URL match\n+ serveEvent(\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000001\"),\n+ mockRequest().url(\"/bar\"),\n+ response(),\n+ true\n+ ),\n+ // Fails ID match\n+ serveEvent(\n+ UUID.fromString(\"00000000-0000-0000-0000-000000000003\"),\n+ mockRequest().url(\"/foo/bar\"),\n+ response(),\n+ true\n+ )\n+ );\n+ setReturnForGetStubMapping(null);\n+ assertThat(\n+ execute(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST),\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE)\n+ );\n}\nprivate static final String CAPTURE_HEADERS_SNAPSHOT_REQUEST =\n@@ -350,12 +413,16 @@ public class SnapshotTaskTest {\n}\nprivate static ServeEvent serveEvent(Request request, Response.Builder responseBuilder, boolean wasProxied) {\n+ return serveEvent(UUID.randomUUID(), request, responseBuilder, wasProxied);\n+ }\n+\n+ private static ServeEvent serveEvent(UUID id, Request request, Response.Builder responseBuilder, boolean wasProxied) {\nResponseDefinitionBuilder responseDefinition = responseDefinition();\nif (wasProxied) {\nresponseDefinition.proxiedFrom(\"/foo\");\n}\nreturn new ServeEvent(\n- UUID.randomUUID(),\n+ id,\nLoggedRequest.createFrom(request),\nnull,\nresponseDefinition.build(),\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add ability to filter by ServeEvent ids
686,965
10.06.2017 00:47:14
25,200
18d44f5af1c7a3f18a7c177a8b433d16b7dbcdc6
Remove sorting option from SnapshotSpec, since it could be confusing
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -3,7 +3,6 @@ package com.github.tomakehurst.wiremock.admin.model;\nimport com.fasterxml.jackson.annotation.JsonCreator;\nimport com.fasterxml.jackson.annotation.JsonProperty;\nimport com.fasterxml.jackson.databind.JsonNode;\n-import com.github.tomakehurst.wiremock.http.RequestFieldsComparator;\nimport com.github.tomakehurst.wiremock.matching.MultiValuePattern;\nimport java.util.Map;\n@@ -14,8 +13,6 @@ import java.util.Map;\npublic class SnapshotSpec {\n// Whitelist requests to generate StubMappings for\nprivate ServeEventRequestFilters filters;\n- // How to sort the StubMappings (mainly for output purposes)\n- private RequestFieldsComparator sortFields;\n// Headers from the request to include in the stub mapping, if they match the corresponding matcher\nprivate RequestPatternTransformer captureHeaders;\n// How to format StubMappings in the response body\n@@ -34,15 +31,12 @@ public class SnapshotSpec {\nthis.outputFormat = outputFormat;\nthis.captureHeaders = new RequestPatternTransformer(captureHeaders);\nthis.persist = persistNode.asBoolean(true);\n- if (sortFields != null) this.sortFields = new RequestFieldsComparator(sortFields);\n}\npublic SnapshotSpec() {}\npublic ServeEventRequestFilters getFilters() { return filters; }\n- public RequestFieldsComparator getSortFields() { return sortFields; }\n-\npublic RequestPatternTransformer getCaptureHeaders() { return captureHeaders; }\npublic String getOutputFormat() { return outputFormat; }\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -73,10 +73,6 @@ public class SnapshotTask implements AdminTask {\nnew StubMappingTransformer(snapshotSpec.getCaptureHeaders())\n);\n- if (snapshotSpec.getSortFields() != null) {\n- stubMappings = from(stubMappings.toSortedSet(snapshotSpec.getSortFields()));\n- }\n-\nreturn stubMappings;\n}\n" }, { "change_type": "DELETE", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/RequestFieldsComparator.java", "new_path": null, "diff": "-package com.github.tomakehurst.wiremock.http;\n-\n-import com.fasterxml.jackson.annotation.JsonCreator;\n-import com.fasterxml.jackson.annotation.JsonProperty;\n-import com.github.tomakehurst.wiremock.matching.MultiValuePattern;\n-import com.github.tomakehurst.wiremock.matching.RequestPattern;\n-import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import com.google.common.collect.Lists;\n-\n-import java.util.Comparator;\n-import java.util.List;\n-\n-/**\n- * Contains a list of request fields that can be used to sort/compare StubMappings\n- */\n-public class RequestFieldsComparator implements Comparator<StubMapping> {\n- private final List<String> fields;\n-\n- @JsonCreator\n- public RequestFieldsComparator(@JsonProperty(\"fields\") String ...fields) {\n- this.fields = Lists.newArrayList(fields);\n- }\n-\n- @Override\n- public int compare(StubMapping one, StubMapping two) {\n- int result = 0;\n- for (String field : fields) {\n- result = compareByField(field, one.getRequest(), two.getRequest());\n- if (result != 0) {\n- break;\n- }\n- }\n- return result;\n- }\n-\n- /**\n- * Compares two RequestPatterns in terms of the field.\n- */\n- private int compareByField(String field, RequestPattern one, RequestPattern two) {\n- switch (field) {\n- case \"url\":\n- if (one.getUrl() == null && two.getUrl() != null) {\n- return -1;\n- } else if (one.getUrl() != null && two.getUrl() == null) {\n- return 1;\n- } else if (one.getUrl() == null && two.getUrl() == null) {\n- return 0;\n- }\n- return one.getUrl().compareToIgnoreCase(two.getUrl());\n- case \"method\":\n- return one.getMethod().equals(two.getMethod()) ? 0 : 1;\n- default: // assume field is a header\n- if (one.getHeaders() == null) {\n- return -1;\n- } else if (two.getHeaders() == null) {\n- return 1;\n- }\n-\n- MultiValuePattern headerOne = one.getHeaders().get(field);\n- MultiValuePattern headerTwo = two.getHeaders().get(field);\n- if (headerOne == null) {\n- return -1;\n- } else if (headerTwo == null) {\n- return 1;\n- }\n- return headerOne.getExpected().compareToIgnoreCase(headerTwo.getExpected());\n- }\n- }\n-}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -302,83 +302,6 @@ public class SnapshotTaskTest {\n);\n}\n- private static final String SORTED_SNAPSHOT_REQUEST =\n- \"{ \\n\" +\n- \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n- \" \\\"sortFields\\\": [ \\\"url\\\" ], \\n\" +\n- \" \\\"persist\\\": \\\"false\\\", \\n\" +\n- \" \\\"captureHeaders\\\": { \\n\" +\n- \" \\\"X-Foo\\\": { \\n\" +\n- \" \\\"matches\\\": \\\".ar\\\" \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \"} \";\n-\n- private static final String SORTED_SNAPSHOT_RESPONSE =\n- \"[ \\n\" +\n- \" { \\n\" +\n- \" \\\"id\\\" : \\\"0237fc26-8cd6-3985-af0d-83431fa128ad\\\", \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/a\\\", \\n\" +\n- \" \\\"method\\\" : \\\"POST\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"0237fc26-8cd6-3985-af0d-83431fa128ad\\\" \\n\" +\n- \" }, \\n\" +\n- \" { \\n\" +\n- \" \\\"id\\\" : \\\"dd876a1d-58b9-3e42-9e24-5f283ddc6175\\\", \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/b\\\", \\n\" +\n- \" \\\"method\\\" : \\\"GET\\\", \\n\" +\n- \" \\\"headers\\\" : { \\n\" +\n- \" \\\"X-Foo\\\" : { \\n\" +\n- \" \\\"equalTo\\\" : \\\"bar\\\" \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"dd876a1d-58b9-3e42-9e24-5f283ddc6175\\\" \\n\" +\n- \" }, \\n\" +\n- \" { \\n\" +\n- \" \\\"id\\\" : \\\"373b99eb-49dc-360f-b46b-abf9f224a904\\\", \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/z\\\", \\n\" +\n- \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"373b99eb-49dc-360f-b46b-abf9f224a904\\\" \\n\" +\n- \" } \\n\" +\n- \"] \";\n-\n- @Test\n- public void returnsSortedStubMappings() {\n- setServeEvents(\n- serveEvent(\n- mockRequest().method(GET).url(\"/b\").header(\"X-Foo\", \"bar\"),\n- response(),\n- true\n- ),\n- serveEvent(\n- mockRequest().method(POST).url(\"/a\").header(\"X-Foo\", \"no match\"),\n- response(),\n- true\n- ),\n- serveEvent(\n- mockRequest().method(GET).url(\"/z\"),\n- response(),\n- true\n- )\n- );\n- setReturnForGetStubMapping(null);\n- assertThat(execute(SORTED_SNAPSHOT_REQUEST), equalToJson(SORTED_SNAPSHOT_RESPONSE));\n- }\n-\nprivate String executeWithoutPersist() {\nreturn execute(\"{ \\\"persist\\\": false }\");\n}\n" }, { "change_type": "DELETE", "old_path": "src/test/java/com/github/tomakehurst/wiremock/http/RequestFieldsComparatorTest.java", "new_path": null, "diff": "-package com.github.tomakehurst.wiremock.http;\n-\n-import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n-import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import org.junit.Test;\n-\n-import static com.github.tomakehurst.wiremock.client.WireMock.equalTo;\n-import static org.hamcrest.MatcherAssert.assertThat;\n-import static org.hamcrest.Matchers.greaterThan;\n-import static org.hamcrest.Matchers.lessThan;\n-import static org.junit.Assert.assertEquals;\n-import static org.junit.Assert.assertNotEquals;\n-\n-public class RequestFieldsComparatorTest {\n- @Test\n- public void compareWithNoFields(){\n- RequestFieldsComparator fields = new RequestFieldsComparator();\n- assertEquals(0, fields.compare(new StubMapping(), new StubMapping()));\n- }\n-\n- @Test\n- public void compareUrlWithNull() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"url\");\n- StubMapping one = newStubMapping(RequestPatternBuilder.allRequests());\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withUrl(\"FOO\"));\n-\n- assertEquals(0, field.compare(one, one));\n- assertEquals(-1, field.compare(one, two));\n- assertEquals(1, field.compare(two, one));\n- }\n-\n- @Test\n- public void compareUrlWithEqualUrlsCaseInsenstive() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"url\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withUrl(\"foo\"));\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withUrl(\"FOO\"));\n-\n- assertEquals(0, field.compare(one, one));\n- assertEquals(0, field.compare(one, two));\n- }\n-\n- @Test\n- public void compareUrlWithUnequalUrls() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"url\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withUrl(\"foo\"));\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withUrl(\"bar\"));\n-\n- assertThat(0, greaterThan(field.compare(two, one)));\n- assertThat(0, lessThan(field.compare(one, two)));\n- }\n-\n- @Test\n- public void compareMethod() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"method\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder(RequestMethod.GET, null));\n- StubMapping two = newStubMapping(new RequestPatternBuilder(RequestMethod.TRACE, null));\n-\n- assertEquals(0, field.compare(one, one));\n- assertEquals(0, field.compare(one, newStubMapping(new RequestPatternBuilder(RequestMethod.GET, null))));\n-\n- assertNotEquals(0, field.compare(one, two));\n- assertNotEquals(0, field.compare(two, one));\n- }\n-\n- @Test\n- public void compareHeaderWithOneMissingAllHeaders() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"Accept\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withHeader(\"foo\", equalTo(\"bar\")));\n- StubMapping two = newStubMapping(new RequestPatternBuilder());\n-\n- assertEquals(1, field.compare(one, two));\n- assertEquals(-1, field.compare(two, one));\n- }\n-\n- @Test\n- public void compareHeaderWithOneMissingHeader() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"Accept\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withHeader(\"foo\", equalTo(\"bar\")));\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withHeader(\"Accept\", equalTo(\"bar\")));\n-\n- assertEquals(-1, field.compare(one, two));\n- assertEquals(1, field.compare(two, one));\n- }\n-\n- @Test\n- public void compareHeaderNotEqual() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"Accept\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withHeader(\"Accept\", equalTo(\"foo\")));\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withHeader(\"Accept\", equalTo(\"bar\")));\n-\n- assertThat(0, greaterThan(field.compare(two, one)));\n- assertThat(0, lessThan(field.compare(one, two)));\n- }\n-\n- @Test\n- public void compareHeaderEqual() {\n- RequestFieldsComparator field = new RequestFieldsComparator(\"Accept\");\n- StubMapping one = newStubMapping(new RequestPatternBuilder().withHeader(\"Accept\", equalTo(\"foo\")));\n- StubMapping two = newStubMapping(new RequestPatternBuilder().withHeader(\"Accept\", equalTo(\"FOo\")));\n-\n- assertEquals(0, field.compare(one, one));\n- assertEquals(0, field.compare(one, two));\n- assertEquals(0, field.compare(two, one));\n- }\n-\n- private static StubMapping newStubMapping(RequestPatternBuilder builder) {\n- return new StubMapping(builder.build(), ResponseDefinition.ok());\n- }\n-}\n\\ No newline at end of file\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Remove sorting option from SnapshotSpec, since it could be confusing
686,965
10.06.2017 00:50:54
25,200
47f4adcacf9afb8e65d091abd208efb2b46b69de
Make default output format for SnapshotSpec "full" for consistency with other formats
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -50,7 +50,7 @@ public class SnapshotTask implements AdminTask {\nstubMapping.setPersistent(true);\nadmin.addStubMapping(stubMapping);\n}\n- response.add((format != null && format.equals(\"full\")) ? stubMapping : stubMapping.getId());\n+ response.add((format != null && format.equals(\"ids\")) ? stubMapping.getId() : stubMapping);\n}\nreturn jsonResponse(response.toArray(), HTTP_OK);\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -68,13 +68,13 @@ public class SnapshotTaskTest {\n// Check when explicitly set\nassertThat(\n- execute(\"{ \\\"persist\\\": true}\"),\n+ execute(\"{ \\\"persist\\\": true, \\\"outputFormat\\\": \\\"ids\\\" }\"),\nequalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n);\n// Check with default value of true\nassertThat(\n- execute(\"{}\"),\n+ execute(\"{ \\\"outputFormat\\\": \\\"ids\\\" }\"),\nequalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n);\n}\n@@ -113,7 +113,10 @@ public class SnapshotTaskTest {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\nsetReturnForGetStubMapping(null);\n// the UUID shouldn't change, as it's based on the hash of the request and response\n- assertThat(executeWithoutPersist(), equalToJson(\"[\\\"82df0a3e-c3a2-30c1-bd97-098668b3e5f4\\\"]\"));\n+ assertThat(\n+ executeWithoutPersist(),\n+ equalToJson(\"[\\\"82df0a3e-c3a2-30c1-bd97-098668b3e5f4\\\"]\")\n+ );\n}\n@Test\n@@ -303,7 +306,7 @@ public class SnapshotTaskTest {\n}\nprivate String executeWithoutPersist() {\n- return execute(\"{ \\\"persist\\\": false }\");\n+ return execute(\"{ \\\"persist\\\": false, \\\"outputFormat\\\": \\\"ids\\\" }\");\n}\nprivate String execute(String requestBody) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Make default output format for SnapshotSpec "full" for consistency with other formats
686,965
10.06.2017 02:14:32
25,200
7e49cfb21d48d7767ecb186131664d98d5a03efb
Don't generate a content-based UUID for the stub mapping, because it isn't necessary to de-dupe
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/StubMappingTransformer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/StubMappingTransformer.java", "diff": "package com.github.tomakehurst.wiremock.admin.model;\n-import com.github.tomakehurst.wiremock.common.Json;\nimport com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.google.common.base.Function;\n-import com.google.common.primitives.Bytes;\n-\n-import java.util.UUID;\n/**\n* Transforms ServeEvents to StubMappings using RequestPatternTransformer and SnapshotResponseDefinitionTransformer\n@@ -36,13 +32,6 @@ public class StubMappingTransformer implements Function<ServeEvent, StubMapping>\npublic StubMapping apply(ServeEvent event) {\nRequestPattern requestPattern = requestTransformer.apply(event.getRequest()).build();\nResponseDefinition responseDefinition = responseTransformer.apply(event.getResponse());\n- StubMapping stubMapping = new StubMapping(requestPattern, responseDefinition);\n-\n- // create (hopefully) unique ID for the stub mapping using JSON representation of the RequestPattern,\n- // which will be used in Task to de-dupe StubMappings\n- byte[] hashCode = Json.toByteArray(requestPattern);\n- stubMapping.setId(UUID.nameUUIDFromBytes(hashCode));\n-\n- return stubMapping;\n+ return new StubMapping(requestPattern, responseDefinition);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -80,7 +80,7 @@ public class SnapshotTask implements AdminTask {\nreturn new Predicate<StubMapping>() {\n@Override\npublic boolean apply(StubMapping stubMapping) {\n- return !admin.getStubMapping(stubMapping.getId()).isPresent();\n+ return admin.countRequestsMatching(stubMapping.getRequest()).getCount() == 0;\n}\n};\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -3,33 +3,35 @@ package com.github.tomakehurst.wiremock.admin;\nimport com.github.tomakehurst.wiremock.admin.model.GetServeEventsResult;\nimport com.github.tomakehurst.wiremock.admin.model.PaginatedResult;\nimport com.github.tomakehurst.wiremock.admin.model.PathParams;\n-import com.github.tomakehurst.wiremock.admin.model.SingleStubMappingResult;\nimport com.github.tomakehurst.wiremock.admin.tasks.SnapshotTask;\nimport com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;\nimport com.github.tomakehurst.wiremock.core.Admin;\nimport com.github.tomakehurst.wiremock.http.*;\n-import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n+import com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\n+import com.github.tomakehurst.wiremock.verification.VerificationResult;\n+import com.toomuchcoding.jsonassert.JsonAssertion;\nimport org.jmock.Expectations;\nimport org.jmock.Mockery;\nimport org.jmock.integration.junit4.JMock;\nimport org.junit.Before;\nimport org.junit.Test;\nimport org.junit.runner.RunWith;\n+import org.skyscreamer.jsonassert.JSONCompareMode;\nimport java.util.Arrays;\nimport java.util.UUID;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.responseDefinition;\n-import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.POST;\nimport static com.github.tomakehurst.wiremock.http.Response.response;\nimport static com.github.tomakehurst.wiremock.matching.MockRequest.mockRequest;\nimport static com.github.tomakehurst.wiremock.testsupport.WireMatchers.equalToJson;\nimport static java.net.HttpURLConnection.HTTP_OK;\n+import static junit.framework.TestCase.assertFalse;\nimport static org.hamcrest.MatcherAssert.assertThat;\nimport static org.junit.Assert.assertEquals;\n@@ -50,43 +52,35 @@ public class SnapshotTaskTest {\nserveEvent(\nmockRequest().url(\"/foo\").method(GET),\nresponse().body(\"body\"),\n- true)\n- );\n-\n- final StubMapping expectedStub = new StubMapping(\n- new RequestPatternBuilder(RequestMethod.GET, urlEqualTo(\"/foo\")).build(),\n- new ResponseDefinitionBuilder().withBody(\"body\").build()\n+ true\n+ )\n);\n- expectedStub.setPersistent(true);\n- expectedStub.setId(UUID.fromString(\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\"));\n-\ncontext.checking(new Expectations() {{\n- exactly(2).of(mockAdmin).addStubMapping(with(expectedStub));\n+ exactly(2).of(mockAdmin).addStubMapping(with(any(StubMapping.class)));\n}});\n-\n- setReturnForGetStubMapping(null);\n+ setReturnForCountRequestsMatching(0);\n// Check when explicitly set\n- assertThat(\n- execute(\"{ \\\"persist\\\": true, \\\"outputFormat\\\": \\\"ids\\\" }\"),\n- equalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n- );\n+ JsonAssertion.assertThat(execute(\"{ \\\"persist\\\": true, \\\"outputFormat\\\": \\\"ids\\\"}\"))\n+ .hasSize(1)\n+ .arrayField()\n+ .matches(\"[a-z0-9\\\\-]{36}\");\n// Check with default value of true\n- assertThat(\n- execute(\"{ \\\"outputFormat\\\": \\\"ids\\\" }\"),\n- equalToJson(\"[\\\"79caf251-ad1f-3d1b-b7c7-a0dfab33d19d\\\"]\")\n- );\n+ JsonAssertion.assertThat(execute(\"{ \\\"outputFormat\\\": \\\"ids\\\"}\"))\n+ .hasSize(1)\n+ .arrayField()\n+ .matches(\"[a-z0-9\\\\-]{36}\");\n}\n@Test\npublic void shouldNotPersistWhenSetToFalse() {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForGetStubMapping(null);\n- assertThat(\n- executeWithoutPersist(),\n- equalToJson(\"[\\\"82df0a3e-c3a2-30c1-bd97-098668b3e5f4\\\"]\")\n- );\n+ setReturnForCountRequestsMatching(0);\n+ JsonAssertion.assertThat(executeWithoutPersist())\n+ .hasSize(1)\n+ .arrayField()\n+ .matches(\"[a-z0-9\\\\-]{36}\");\n}\n@Test\n@@ -104,32 +98,20 @@ public class SnapshotTaskTest {\n@Test\npublic void returnsEmptyArrayForExistingStubMapping() {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForGetStubMapping(StubMapping.NOT_CONFIGURED);\n+ setReturnForCountRequestsMatching(1);\nassertEquals(\"[ ]\", executeWithoutPersist());\n}\n- @Test\n- public void returnsOneMappingWithOneServeEvent() {\n- setServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForGetStubMapping(null);\n- // the UUID shouldn't change, as it's based on the hash of the request and response\n- assertThat(\n- executeWithoutPersist(),\n- equalToJson(\"[\\\"82df0a3e-c3a2-30c1-bd97-098668b3e5f4\\\"]\")\n- );\n- }\n-\n@Test\npublic void returnsTwoMappingsForTwoServeEvents() {\nsetServeEvents(\nserveEvent(mockRequest(), response(), true),\nserveEvent(mockRequest().url(\"/foo\"), response(), true)\n);\n- setReturnForGetStubMapping(null);\n- assertThat(\n- executeWithoutPersist(),\n- equalToJson(\"[\\\"82df0a3e-c3a2-30c1-bd97-098668b3e5f4\\\", \\\"4901a9f4-43ba-31f9-9e16-4a8eeba4ef6a\\\"]\")\n- );\n+ setReturnForCountRequestsMatching(0);\n+ JsonAssertion.assertThat(executeWithoutPersist())\n+ .hasSize(2)\n+ .arrayField();\n}\nprivate static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST =\n@@ -147,26 +129,22 @@ public class SnapshotTaskTest {\nprivate static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE =\n\"[ \\n\" +\n\" { \\n\" +\n- \" \\\"id\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\", \\n\" +\n\" \\\"request\\\" : { \\n\" +\n\" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n\" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n\" }, \\n\" +\n\" \\\"response\\\" : { \\n\" +\n\" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\" \\n\" +\n+ \" } \\n\" +\n\" }, \\n\" +\n\" { \\n\" +\n- \" \\\"id\\\" : \\\"8ce282ae-cdbb-3818-8d06-9dde11913217\\\", \\n\" +\n\" \\\"request\\\" : { \\n\" +\n\" \\\"url\\\" : \\\"/foo/bar/baz\\\", \\n\" +\n\" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n\" }, \\n\" +\n\" \\\"response\\\" : { \\n\" +\n\" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"8ce282ae-cdbb-3818-8d06-9dde11913217\\\" \\n\" +\n+ \" } \\n\" +\n\" } \\n\" +\n\" ] \";\n@@ -184,10 +162,10 @@ public class SnapshotTaskTest {\n// Matches both\nserveEvent(mockRequest().url(\"/foo/bar/baz\").header(\"A\",\"B\"), response(), true)\n);\n- setReturnForGetStubMapping(null);\n+ setReturnForCountRequestsMatching(0);\nassertThat(\nexecute(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\n- equalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE)\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n@@ -207,15 +185,13 @@ public class SnapshotTaskTest {\nprivate static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE =\n\"[ \\n\" +\n\" { \\n\" +\n- \" \\\"id\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\", \\n\" +\n\" \\\"request\\\" : { \\n\" +\n\" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n\" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n\" }, \\n\" +\n\" \\\"response\\\" : { \\n\" +\n\" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"e88ab645-69d5-34d1-8e4a-382ad56be0e4\\\" \\n\" +\n+ \" } \\n\" +\n\" } \\n\" +\n\" ] \";\n@@ -244,10 +220,10 @@ public class SnapshotTaskTest {\ntrue\n)\n);\n- setReturnForGetStubMapping(null);\n+ setReturnForCountRequestsMatching(0);\nassertThat(\nexecute(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST),\n- equalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE)\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n@@ -268,7 +244,6 @@ public class SnapshotTaskTest {\nprivate static final String CAPTURE_HEADERS_SNAPSHOT_RESPONSE =\n\"[ \\n\" +\n\" { \\n\" +\n- \" \\\"id\\\" : \\\"5c4d527c-bcc3-3c89-bb41-fc697a90ee9b\\\", \\n\" +\n\" \\\"request\\\" : { \\n\" +\n\" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n\" \\\"method\\\" : \\\"POST\\\", \\n\" +\n@@ -280,8 +255,7 @@ public class SnapshotTaskTest {\n\" }, \\n\" +\n\" \\\"response\\\" : { \\n\" +\n\" \\\"status\\\" : 200 \\n\" +\n- \" }, \\n\" +\n- \" \\\"uuid\\\" : \\\"5c4d527c-bcc3-3c89-bb41-fc697a90ee9b\\\" \\n\" +\n+ \" } \\n\" +\n\" } \\n\" +\n\"] \";\n@@ -298,11 +272,11 @@ public class SnapshotTaskTest {\ntrue\n)\n);\n- setReturnForGetStubMapping(null);\n- assertThat(\n- execute(CAPTURE_HEADERS_SNAPSHOT_REQUEST),\n- equalToJson(CAPTURE_HEADERS_SNAPSHOT_RESPONSE)\n- );\n+ setReturnForCountRequestsMatching(0);\n+\n+ String actual = execute(CAPTURE_HEADERS_SNAPSHOT_REQUEST);\n+ assertThat(actual, equalToJson(CAPTURE_HEADERS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER));\n+ assertFalse(actual.contains(\"X-NoMatch\"));\n}\nprivate String executeWithoutPersist() {\n@@ -331,10 +305,10 @@ public class SnapshotTaskTest {\n}});\n}\n- private void setReturnForGetStubMapping(final StubMapping stubMapping) {\n+ private void setReturnForCountRequestsMatching(final int numMatching) {\ncontext.checking(new Expectations() {{\n- allowing(mockAdmin).getStubMapping(with(any(UUID.class)));\n- will(returnValue(new SingleStubMappingResult(stubMapping)));\n+ allowing(mockAdmin).countRequestsMatching(with(any(RequestPattern.class)));\n+ will(returnValue(new VerificationResult(numMatching, false)));\n}});\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/StubMappingTransformerTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/StubMappingTransformerTest.java", "diff": "@@ -14,8 +14,6 @@ import com.github.tomakehurst.wiremock.verification.LoggedRequest;\nimport org.jmock.Mockery;\nimport org.junit.Test;\n-import java.util.UUID;\n-\nimport static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\nimport static com.github.tomakehurst.wiremock.testsupport.MockRequestBuilder.aRequest;\nimport static org.junit.Assert.assertEquals;\n@@ -44,16 +42,17 @@ public class StubMappingTransformerTest {\nresponseTransformer\n);\n- StubMapping expected = new StubMapping(requestPatternBuilder.build(), responseDefinition);\n- expected.setId(UUID.fromString(\"808bdbde-19f5-3006-84e1-770c12e737b9\"));\n-\n- assertEquals(expected, stubMappingTransformer.apply(new ServeEvent(\n+ StubMapping actual = stubMappingTransformer.apply(new ServeEvent(\nnull,\nLoggedRequest.createFrom(aRequest(new Mockery()).build()),\nnull,\nnull,\nLoggedResponse.from(Response.notConfigured()),\nfalse\n- )));\n+ ));\n+ StubMapping expected = new StubMapping(requestPatternBuilder.build(), responseDefinition);\n+ expected.setId(actual.getId());\n+\n+ assertEquals(expected, actual);\n}\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Don't generate a content-based UUID for the stub mapping, because it isn't necessary to de-dupe
686,965
10.06.2017 19:53:08
25,200
403bf9f42beda433d4b1dc6fa51c4b7d66685768
Make output formats into an enum, which is slightly cleaner
[ { "change_type": "ADD", "old_path": null, "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotOutputFormat.java", "diff": "+package com.github.tomakehurst.wiremock.admin.model;\n+\n+import com.fasterxml.jackson.annotation.JsonCreator;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+\n+/**\n+ * Possible output formats for snapshot task\n+ */\n+public enum SnapshotOutputFormat {\n+ FULL,\n+ IDS {\n+ @Override\n+ public Object format(StubMapping stubMapping) {\n+ return stubMapping.getId();\n+ }\n+ };\n+\n+ @JsonCreator\n+ public static SnapshotOutputFormat fromString(String value) {\n+ if (value == null || value.equalsIgnoreCase(\"ids\")) {\n+ return IDS;\n+ }\n+ return FULL;\n+ }\n+\n+ public Object format(StubMapping stubMapping) {\n+ return stubMapping;\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -17,7 +17,7 @@ public class SnapshotSpec {\nprivate RequestPatternTransformer captureHeaders;\n// How to format StubMappings in the response body\n// Either \"full\" (meaning return an array of rendered StubMappings) or \"ids\", which returns an array of UUIDs\n- private String outputFormat;\n+ private SnapshotOutputFormat outputFormat;\n// Whether to persist stub mappings\nprivate boolean persist = true;\n@@ -25,7 +25,7 @@ public class SnapshotSpec {\npublic SnapshotSpec(@JsonProperty(\"filters\") ServeEventRequestFilters filters ,\n@JsonProperty(\"sortFields\") String[] sortFields,\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n- @JsonProperty(\"outputFormat\") String outputFormat,\n+ @JsonProperty(\"outputFormat\") SnapshotOutputFormat outputFormat,\n@JsonProperty(\"persist\") JsonNode persistNode) {\nthis.filters = filters;\nthis.outputFormat = outputFormat;\n@@ -39,7 +39,7 @@ public class SnapshotSpec {\npublic RequestPatternTransformer getCaptureHeaders() { return captureHeaders; }\n- public String getOutputFormat() { return outputFormat; }\n+ public SnapshotOutputFormat getOutputFormat() { return outputFormat; }\npublic boolean shouldPersist() { return persist; }\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "package com.github.tomakehurst.wiremock.admin.tasks;\nimport com.github.tomakehurst.wiremock.admin.AdminTask;\n-import com.github.tomakehurst.wiremock.admin.model.GetServeEventsResult;\n-import com.github.tomakehurst.wiremock.admin.model.PathParams;\n-import com.github.tomakehurst.wiremock.admin.model.SnapshotSpec;\n-import com.github.tomakehurst.wiremock.admin.model.StubMappingTransformer;\n+import com.github.tomakehurst.wiremock.admin.model.*;\nimport com.github.tomakehurst.wiremock.common.Json;\nimport com.github.tomakehurst.wiremock.core.Admin;\nimport com.github.tomakehurst.wiremock.http.Request;\n@@ -43,14 +40,13 @@ public class SnapshotTask implements AdminTask {\n.filter(noDupes(admin));\nfinal ArrayList<Object> response = new ArrayList<>(stubMappings.size());\n- final String format = snapshotSpec.getOutputFormat();\nfor (StubMapping stubMapping : stubMappings) {\nif (snapshotSpec.shouldPersist()) {\nstubMapping.setPersistent(true);\nadmin.addStubMapping(stubMapping);\n}\n- response.add((format != null && format.equals(\"ids\")) ? stubMapping.getId() : stubMapping);\n+ response.add(snapshotSpec.getOutputFormat().format(stubMapping));\n}\nreturn jsonResponse(response.toArray(), HTTP_OK);\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Make output formats into an enum, which is slightly cleaner
686,965
11.06.2017 22:37:21
25,200
b66c1afa84fd99cc3ce789c5295aeaae631a5d7d
Refactoring to facilitate scenario support
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/LoggedResponseDefinitionTransformer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/LoggedResponseDefinitionTransformer.java", "diff": "@@ -16,7 +16,7 @@ import static com.google.common.collect.Iterables.filter;\npublic class LoggedResponseDefinitionTransformer implements Function<LoggedResponse, ResponseDefinition> {\n@Override\npublic ResponseDefinition apply(LoggedResponse response) {\n- ResponseDefinitionBuilder responseDefinitionBuilder = new ResponseDefinitionBuilder()\n+ final ResponseDefinitionBuilder responseDefinitionBuilder = new ResponseDefinitionBuilder()\n.withStatus(response.getStatus());\nif (response.getBody() != null && !response.getBody().isEmpty()) {\n" }, { "change_type": "RENAME", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/StubMappingTransformer.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "diff": "@@ -4,16 +4,18 @@ import com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import com.google.common.base.Function;\n+\n+import java.util.ArrayList;\n+import java.util.List;\n/**\n- * Transforms ServeEvents to StubMappings using RequestPatternTransformer and SnapshotResponseDefinitionTransformer\n+ * Transforms ServeEvents to StubMappings using SnapshotRequestPatternTransformer and SnapshotResponseDefinitionTransformer\n*/\n-public class StubMappingTransformer implements Function<ServeEvent, StubMapping> {\n+public class SnapshotStubMappingGenerator {\nprivate final RequestPatternTransformer requestTransformer;\nprivate final LoggedResponseDefinitionTransformer responseTransformer;\n- public StubMappingTransformer(\n+ public SnapshotStubMappingGenerator(\nRequestPatternTransformer requestTransformer,\nLoggedResponseDefinitionTransformer responseTransformer\n) {\n@@ -21,17 +23,25 @@ public class StubMappingTransformer implements Function<ServeEvent, StubMapping>\nthis.responseTransformer = responseTransformer;\n}\n- public StubMappingTransformer(RequestPatternTransformer requestTransformer) {\n+ public SnapshotStubMappingGenerator(RequestPatternTransformer requestTransformer) {\nthis(\nrequestTransformer == null ? new RequestPatternTransformer() : requestTransformer,\nnew LoggedResponseDefinitionTransformer()\n);\n}\n- @Override\n- public StubMapping apply(ServeEvent event) {\n- RequestPattern requestPattern = requestTransformer.apply(event.getRequest()).build();\n- ResponseDefinition responseDefinition = responseTransformer.apply(event.getResponse());\n+ public List<StubMapping> generateFrom(Iterable<ServeEvent> events) {\n+ final ArrayList<StubMapping> stubMappings = new ArrayList<>();\n+ for (ServeEvent event : events) {\n+ stubMappings.add(generateFrom(event));\n+ }\n+ return stubMappings;\n+ }\n+\n+ private StubMapping generateFrom(ServeEvent event) {\n+ final RequestPattern requestPattern = requestTransformer.apply(event.getRequest()).build();\n+ final ResponseDefinition responseDefinition = responseTransformer.apply(event.getResponse());\n+\nreturn new StubMapping(requestPattern, responseDefinition);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -27,19 +27,19 @@ public class SnapshotTask implements AdminTask {\nreturn execute(admin, snapshotSpec);\n}\n- /**\n- * Central method, mainly glue code\n- *\n- * @param admin Admin instance\n- * @param snapshotSpec User input parameters/options\n- * @return ResponseDefinition\n- */\nprivate ResponseDefinition execute(Admin admin, SnapshotSpec snapshotSpec) {\n- final FluentIterable<StubMapping> stubMappings =\n- generateStubMappings(admin.getServeEvents(), snapshotSpec)\n- .filter(noDupes(admin));\n+ final Iterable<ServeEvent> serveEvents = filterServeEvents(\n+ admin.getServeEvents(),\n+ snapshotSpec.getFilters()\n+ );\n+\n+ Iterable<StubMapping> stubMappings = new SnapshotStubMappingGenerator(\n+ snapshotSpec.getCaptureHeaders()\n+ ).generateFrom(serveEvents);\n+\n+ stubMappings = from(stubMappings).filter(noDupes(admin));\n- final ArrayList<Object> response = new ArrayList<>(stubMappings.size());\n+ final ArrayList<Object> response = new ArrayList<>();\nfor (StubMapping stubMapping : stubMappings) {\nif (snapshotSpec.shouldPersist()) {\n@@ -52,24 +52,18 @@ public class SnapshotTask implements AdminTask {\nreturn jsonResponse(response.toArray(), HTTP_OK);\n}\n- /**\n- * Transforms a list of ServeEvents to StubMappings according to the options in SnapshotSpec\n- * @param serveEventResult List of ServeEvents from the request journal\n- * @param snapshotSpec User input parameters/options\n- * @return List of StubMappings\n- */\n- private FluentIterable<StubMapping> generateStubMappings(GetServeEventsResult serveEventResult, SnapshotSpec snapshotSpec) {\n- FluentIterable<ServeEvent> serveEvents = from(serveEventResult.getServeEvents()).filter(onlyProxied());\n-\n- if (snapshotSpec.getFilters() != null) {\n- serveEvents = serveEvents.filter(snapshotSpec.getFilters());\n- }\n+ private Iterable<ServeEvent> filterServeEvents(\n+ GetServeEventsResult serveEventsResult,\n+ ServeEventRequestFilters snapshotFilters\n+ ) {\n+ FluentIterable<ServeEvent> serveEvents = from(serveEventsResult.getServeEvents())\n+ .filter(onlyProxied());\n- FluentIterable<StubMapping> stubMappings = serveEvents.transform(\n- new StubMappingTransformer(snapshotSpec.getCaptureHeaders())\n- );\n+ if (snapshotFilters != null) {\n+ serveEvents = serveEvents.filter(snapshotFilters);\n+ }\n- return stubMappings;\n+ return serveEvents;\n}\nprivate Predicate<StubMapping> noDupes(final Admin admin) {\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "diff": "+package com.github.tomakehurst.wiremock.admin;\n+\n+import com.github.tomakehurst.wiremock.admin.model.LoggedResponseDefinitionTransformer;\n+import com.github.tomakehurst.wiremock.admin.model.RequestPatternTransformer;\n+import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingGenerator;\n+import com.github.tomakehurst.wiremock.http.LoggedResponse;\n+import com.github.tomakehurst.wiremock.http.Request;\n+import com.github.tomakehurst.wiremock.http.Response;\n+import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n+import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n+import com.github.tomakehurst.wiremock.stubbing.ServeEvent;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.github.tomakehurst.wiremock.verification.LoggedRequest;\n+import com.google.common.collect.Lists;\n+import org.jmock.Mockery;\n+import org.junit.Test;\n+\n+import java.util.ArrayList;\n+import java.util.List;\n+\n+import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n+import static com.github.tomakehurst.wiremock.testsupport.MockRequestBuilder.aRequest;\n+import static org.junit.Assert.assertEquals;\n+\n+public class SnapshotStubMappingGeneratorTest {\n+ @Test\n+ public void generateFromWithEmptyList() {\n+ List<StubMapping> actual = new SnapshotStubMappingGenerator(\n+ requestPatternTransformer(null)\n+ ).generateFrom(Lists.<ServeEvent>newArrayList());\n+\n+ assertEquals(new ArrayList<>(), actual);\n+ }\n+\n+ @Test\n+ public void generateFromWithSingleServeEvent() {\n+ final RequestPatternBuilder requestPatternBuilder = newRequestPattern();\n+ final ResponseDefinition responseDefinition = ResponseDefinition.ok();\n+\n+ SnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\n+ requestPatternTransformer(requestPatternBuilder),\n+ responseDefinitionTransformer(responseDefinition)\n+ );\n+\n+ List<StubMapping> actual = stubMappingTransformer.generateFrom(\n+ Lists.newArrayList(serveEvent())\n+ );\n+\n+ StubMapping expected = new StubMapping(requestPatternBuilder.build(), responseDefinition);\n+ expected.setId(actual.get(0).getId());\n+\n+ assertEquals(expected, actual.get(0));\n+ }\n+\n+ @Test\n+ public void generateWithMultipleServeEvents() {\n+ final RequestPatternBuilder requestPatternBuilder = newRequestPattern();\n+ final ResponseDefinition responseDefinition = ResponseDefinition.ok();\n+\n+ SnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\n+ requestPatternTransformer(requestPatternBuilder),\n+ responseDefinitionTransformer(responseDefinition)\n+ );\n+\n+ List<StubMapping> actual = stubMappingTransformer.generateFrom(\n+ Lists.newArrayList(serveEvent(), serveEvent())\n+ );\n+\n+ ArrayList<StubMapping> expected = new ArrayList<>();\n+ for (int i = 0; i < 2; i++ ) {\n+ StubMapping stubMapping = new StubMapping(requestPatternBuilder.build(), responseDefinition);\n+ stubMapping.setId(actual.get(i).getId());\n+ expected.add(stubMapping);\n+ }\n+\n+ assertEquals(expected, actual);\n+ }\n+\n+ private static RequestPatternTransformer requestPatternTransformer(final RequestPatternBuilder requestPatternBuilder) {\n+ return new RequestPatternTransformer() {\n+ @Override\n+ public RequestPatternBuilder apply(Request request) {\n+ return requestPatternBuilder;\n+ }\n+ };\n+ }\n+\n+ private static LoggedResponseDefinitionTransformer responseDefinitionTransformer(final ResponseDefinition responseDefinition) {\n+ return new LoggedResponseDefinitionTransformer() {\n+ @Override\n+ public ResponseDefinition apply(LoggedResponse response) {\n+ return responseDefinition;\n+ }\n+ };\n+ }\n+\n+ private static ServeEvent serveEvent() {\n+ return new ServeEvent(\n+ null,\n+ LoggedRequest.createFrom(aRequest(new Mockery()).build()),\n+ null,\n+ null,\n+ LoggedResponse.from(Response.notConfigured()),\n+ false\n+ );\n+ }\n+}\n" }, { "change_type": "DELETE", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/StubMappingTransformerTest.java", "new_path": null, "diff": "-package com.github.tomakehurst.wiremock.admin;\n-\n-import com.github.tomakehurst.wiremock.admin.model.LoggedResponseDefinitionTransformer;\n-import com.github.tomakehurst.wiremock.admin.model.RequestPatternTransformer;\n-import com.github.tomakehurst.wiremock.admin.model.StubMappingTransformer;\n-import com.github.tomakehurst.wiremock.http.LoggedResponse;\n-import com.github.tomakehurst.wiremock.http.Request;\n-import com.github.tomakehurst.wiremock.http.Response;\n-import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n-import com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n-import com.github.tomakehurst.wiremock.stubbing.ServeEvent;\n-import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import com.github.tomakehurst.wiremock.verification.LoggedRequest;\n-import org.jmock.Mockery;\n-import org.junit.Test;\n-\n-import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n-import static com.github.tomakehurst.wiremock.testsupport.MockRequestBuilder.aRequest;\n-import static org.junit.Assert.assertEquals;\n-\n-public class StubMappingTransformerTest {\n- @Test\n- public void apply() {\n- final RequestPatternBuilder requestPatternBuilder = newRequestPattern();\n- final ResponseDefinition responseDefinition = ResponseDefinition.ok();\n- RequestPatternTransformer requestTransformer = new RequestPatternTransformer() {\n- @Override\n- public RequestPatternBuilder apply(Request request) {\n- return requestPatternBuilder;\n- }\n- };\n-\n- LoggedResponseDefinitionTransformer responseTransformer = new LoggedResponseDefinitionTransformer() {\n- @Override\n- public ResponseDefinition apply(LoggedResponse response) {\n- return responseDefinition;\n- }\n- };\n-\n- StubMappingTransformer stubMappingTransformer = new StubMappingTransformer(\n- requestTransformer,\n- responseTransformer\n- );\n-\n- StubMapping actual = stubMappingTransformer.apply(new ServeEvent(\n- null,\n- LoggedRequest.createFrom(aRequest(new Mockery()).build()),\n- null,\n- null,\n- LoggedResponse.from(Response.notConfigured()),\n- false\n- ));\n- StubMapping expected = new StubMapping(requestPatternBuilder.build(), responseDefinition);\n- expected.setId(actual.getId());\n-\n- assertEquals(expected, actual);\n- }\n-}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Refactoring to facilitate scenario support
686,965
11.06.2017 22:46:46
25,200
6eaffd841c2b11be7539a7ff8e7c9c0bd515a671
Add support for recording identical requests as a scenario
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -20,17 +20,23 @@ public class SnapshotSpec {\nprivate SnapshotOutputFormat outputFormat;\n// Whether to persist stub mappings\nprivate boolean persist = true;\n+ // Whether duplicate reuqests should be recorded as scenarios or just discarded\n+ private boolean repeatsAsScenarios = false;\n+\n@JsonCreator\npublic SnapshotSpec(@JsonProperty(\"filters\") ServeEventRequestFilters filters ,\n@JsonProperty(\"sortFields\") String[] sortFields,\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n@JsonProperty(\"outputFormat\") SnapshotOutputFormat outputFormat,\n- @JsonProperty(\"persist\") JsonNode persistNode) {\n+ @JsonProperty(\"persist\") JsonNode persistNode,\n+ @JsonProperty(\"repeatsAsScenarios\") JsonNode repeatsNode\n+ ) {\nthis.filters = filters;\nthis.outputFormat = outputFormat;\nthis.captureHeaders = new RequestPatternTransformer(captureHeaders);\nthis.persist = persistNode.asBoolean(true);\n+ this.repeatsAsScenarios = repeatsNode.asBoolean(false);\n}\npublic SnapshotSpec() {}\n@@ -42,4 +48,6 @@ public class SnapshotSpec {\npublic SnapshotOutputFormat getOutputFormat() { return outputFormat; }\npublic boolean shouldPersist() { return persist; }\n+\n+ public boolean shouldRecordRepeatsAsScenarios() { return repeatsAsScenarios; }\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "diff": "@@ -4,8 +4,10 @@ import com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.google.common.collect.Iterables;\nimport java.util.ArrayList;\n+import java.util.HashMap;\nimport java.util.List;\n/**\n@@ -14,27 +16,38 @@ import java.util.List;\npublic class SnapshotStubMappingGenerator {\nprivate final RequestPatternTransformer requestTransformer;\nprivate final LoggedResponseDefinitionTransformer responseTransformer;\n+ private final boolean shouldRecordRepeatsAsScenarios;\n+ private HashMap<RequestPattern, SnapshotStubMappingScenarioHandler> requestScenarioHandlerMap;\npublic SnapshotStubMappingGenerator(\nRequestPatternTransformer requestTransformer,\n- LoggedResponseDefinitionTransformer responseTransformer\n+ LoggedResponseDefinitionTransformer responseTransformer,\n+ boolean shouldRecordRepeatsAsScenarios\n) {\nthis.requestTransformer = requestTransformer;\nthis.responseTransformer = responseTransformer;\n+ this.shouldRecordRepeatsAsScenarios = shouldRecordRepeatsAsScenarios;\n}\n- public SnapshotStubMappingGenerator(RequestPatternTransformer requestTransformer) {\n+ public SnapshotStubMappingGenerator(\n+ RequestPatternTransformer requestTransformer,\n+ boolean shouldRecordRepeatsAsScenarios\n+ ) {\nthis(\nrequestTransformer == null ? new RequestPatternTransformer() : requestTransformer,\n- new LoggedResponseDefinitionTransformer()\n+ new LoggedResponseDefinitionTransformer(),\n+ shouldRecordRepeatsAsScenarios\n);\n}\npublic List<StubMapping> generateFrom(Iterable<ServeEvent> events) {\n+ this.requestScenarioHandlerMap = new HashMap<>(Iterables.size(events));\n+\nfinal ArrayList<StubMapping> stubMappings = new ArrayList<>();\nfor (ServeEvent event : events) {\nstubMappings.add(generateFrom(event));\n}\n+\nreturn stubMappings;\n}\n@@ -42,6 +55,16 @@ public class SnapshotStubMappingGenerator {\nfinal RequestPattern requestPattern = requestTransformer.apply(event.getRequest()).build();\nfinal ResponseDefinition responseDefinition = responseTransformer.apply(event.getResponse());\n- return new StubMapping(requestPattern, responseDefinition);\n+ final StubMapping stubMapping = new StubMapping(requestPattern, responseDefinition);\n+\n+ if (shouldRecordRepeatsAsScenarios) {\n+ if (requestScenarioHandlerMap.containsKey(stubMapping.getRequest())) {\n+ requestScenarioHandlerMap.get(stubMapping.getRequest()).trackStubMapping(stubMapping);\n+ } else {\n+ requestScenarioHandlerMap.put(stubMapping.getRequest(), new SnapshotStubMappingScenarioHandler(stubMapping));\n+ }\n+ }\n+\n+ return stubMapping;\n}\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "diff": "+package com.github.tomakehurst.wiremock.admin.model;\n+\n+import com.github.tomakehurst.wiremock.matching.RequestPattern;\n+import com.github.tomakehurst.wiremock.stubbing.Scenario;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.google.common.base.Joiner;\n+import com.google.common.base.Splitter;\n+import com.google.common.collect.Iterables;\n+\n+import java.net.URI;\n+import java.util.ArrayList;\n+import java.util.List;\n+\n+import static java.lang.Math.min;\n+\n+/**\n+ * Tracks stub mappings and set scenario details for duplicate requests\n+ */\n+public class SnapshotStubMappingScenarioHandler {\n+ final private static String SCENARIO_NAME_PREFIX = \"scenario\";\n+\n+ private int count = 1;\n+ private String name = \"\";\n+ final private List<StubMapping> stubMappings = new ArrayList<>();\n+\n+ public SnapshotStubMappingScenarioHandler(StubMapping stubMapping) {\n+ stubMappings.add(stubMapping);\n+ }\n+\n+ public void trackStubMapping(StubMapping stubMapping) {\n+ stubMappings.add(stubMapping);\n+\n+ if (count == 1) {\n+ name = generateScenarioName(stubMapping.getRequest());\n+ // We have multiple identical requests. Go back and make previous stub the start\n+ stubMappings.get(0).setScenarioName(name);\n+ stubMappings.get(0).setRequiredScenarioState(Scenario.STARTED);\n+ }\n+\n+ if (count >= 1) {\n+ stubMapping.setScenarioName(name);\n+ stubMapping.setNewScenarioState(name + \"-\" + (count + 1));\n+ String previousState = stubMappings.get(count - 1).getRequiredScenarioState();\n+ stubMapping.setRequiredScenarioState(previousState);\n+ }\n+\n+ count++;\n+ }\n+\n+ /**\n+ * Generates a scenario name from the request. Based on UniqueFilenameGenerator\n+ *\n+ * @TODO Use a better name generator\n+ * @param request\n+ * @return Scenario name as a string\n+ */\n+ private String generateScenarioName(RequestPattern request) {\n+ final URI uri = URI.create(request.getUrl());\n+ final Iterable<String> uriPathNodes = Splitter\n+ .on(\"/\")\n+ .omitEmptyStrings()\n+ .split(uri.getPath());\n+\n+ final int nodeCount = Iterables.size(uriPathNodes);\n+\n+ String pathPart = \"(root)\";\n+ if (nodeCount > 0) {\n+ pathPart = Joiner\n+ .on(\"-\")\n+ .join(\n+ Iterables.skip(uriPathNodes, nodeCount - min(nodeCount, 2))\n+ );\n+ pathPart = sanitise(pathPart);\n+ }\n+\n+ return SCENARIO_NAME_PREFIX + \"-\" + pathPart;\n+ }\n+\n+ private static String sanitise(String input) {\n+ return input.replaceAll(\"[,~:/?#\\\\[\\\\]@!\\\\$&'()*+;=]\", \"_\");\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -34,7 +34,9 @@ public class SnapshotTask implements AdminTask {\n);\nIterable<StubMapping> stubMappings = new SnapshotStubMappingGenerator(\n- snapshotSpec.getCaptureHeaders()\n+ snapshotSpec.getCaptureHeaders(),\n+ snapshotSpec.shouldRecordRepeatsAsScenarios()\n+\n).generateFrom(serveEvents);\nstubMappings = from(stubMappings).filter(noDupes(admin));\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "diff": "@@ -8,6 +8,7 @@ import com.github.tomakehurst.wiremock.http.Request;\nimport com.github.tomakehurst.wiremock.http.Response;\nimport com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n+import com.github.tomakehurst.wiremock.stubbing.Scenario;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\n@@ -26,7 +27,8 @@ public class SnapshotStubMappingGeneratorTest {\n@Test\npublic void generateFromWithEmptyList() {\nList<StubMapping> actual = new SnapshotStubMappingGenerator(\n- requestPatternTransformer(null)\n+ requestPatternTransformer(null),\n+ false\n).generateFrom(Lists.<ServeEvent>newArrayList());\nassertEquals(new ArrayList<>(), actual);\n@@ -39,7 +41,8 @@ public class SnapshotStubMappingGeneratorTest {\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\n- responseDefinitionTransformer(responseDefinition)\n+ responseDefinitionTransformer(responseDefinition),\n+ false\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -54,12 +57,13 @@ public class SnapshotStubMappingGeneratorTest {\n@Test\npublic void generateWithMultipleServeEvents() {\n- final RequestPatternBuilder requestPatternBuilder = newRequestPattern();\n+ final RequestPatternBuilder requestPatternBuilder = newRequestPattern().withUrl(\"/foo\");\nfinal ResponseDefinition responseDefinition = ResponseDefinition.ok();\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\n- responseDefinitionTransformer(responseDefinition)\n+ responseDefinitionTransformer(responseDefinition),\n+ true\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -73,6 +77,15 @@ public class SnapshotStubMappingGeneratorTest {\nexpected.add(stubMapping);\n}\n+ // Make sure scenario was generated properly\n+ expected.get(0).setScenarioName(\"scenario-foo\");\n+ expected.get(0).setRequiredScenarioState(Scenario.STARTED);\n+\n+ expected.get(1).setScenarioName(\"scenario-foo\");\n+ expected.get(1).setRequiredScenarioState(Scenario.STARTED);\n+ expected.get(1).setNewScenarioState(\"scenario-foo-2\");\n+\n+\nassertEquals(expected, actual);\n}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -279,6 +279,63 @@ public class SnapshotTaskTest {\nassertFalse(actual.contains(\"X-NoMatch\"));\n}\n+ private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"repeatsAsScenarios\\\": \\\"true\\\" \\n\" +\n+ \"} \";\n+\n+ private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n+ \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n+ \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n+ \" \\\"newScenarioState\\\" : \\\"scenario-bar-baz-2\\\", \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsStubMappingsWithScenariosForRepeatedRequests() {\n+ setServeEvents(\n+ serveEvent(mockRequest().url(\"/foo\"), response(), true),\n+ serveEvent(mockRequest().url(\"/bar/baz\"), response(), true),\n+ serveEvent(mockRequest().url(\"/bar/baz\"), response(), true)\n+ );\n+ setReturnForCountRequestsMatching(0);\n+ assertThat(\n+ execute(REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST),\n+ equalToJson(REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\nprivate String executeWithoutPersist() {\nreturn execute(\"{ \\\"persist\\\": false, \\\"outputFormat\\\": \\\"ids\\\" }\");\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add support for recording identical requests as a scenario
686,965
11.06.2017 22:50:33
25,200
ddfbf578367b5c6dd0e729bc8cc5e0859ac61518
Relocate snapshot endpoint to /recordings/snapshot
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/AdminRoutes.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/AdminRoutes.java", "diff": "@@ -80,7 +80,7 @@ public class AdminRoutes {\nrouter.add(GET, \"/requests/unmatched/near-misses\", FindNearMissesForUnmatchedTask.class);\nrouter.add(GET, \"/requests/{id}\", GetServedStubTask.class);\n- router.add(POST, \"/snapshot\", SnapshotTask.class);\n+ router.add(POST, \"/recordings/snapshot\", SnapshotTask.class);\nrouter.add(POST, \"/near-misses/request\", FindNearMissesForRequestTask.class);\nrouter.add(POST, \"/near-misses/request-pattern\", FindNearMissesForRequestPatternTask.class);\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Relocate snapshot endpoint to /recordings/snapshot
686,965
11.06.2017 23:13:37
25,200
442368c6db8622296f14bba8e8982d0c662f3048
Don't need to track every stub mapping, just the previous
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "diff": "@@ -8,8 +8,6 @@ import com.google.common.base.Splitter;\nimport com.google.common.collect.Iterables;\nimport java.net.URI;\n-import java.util.ArrayList;\n-import java.util.List;\nimport static java.lang.Math.min;\n@@ -21,29 +19,28 @@ public class SnapshotStubMappingScenarioHandler {\nprivate int count = 1;\nprivate String name = \"\";\n- final private List<StubMapping> stubMappings = new ArrayList<>();\n+ private StubMapping previousStubMapping;\npublic SnapshotStubMappingScenarioHandler(StubMapping stubMapping) {\n- stubMappings.add(stubMapping);\n+ previousStubMapping = stubMapping;\n}\npublic void trackStubMapping(StubMapping stubMapping) {\n- stubMappings.add(stubMapping);\n-\nif (count == 1) {\nname = generateScenarioName(stubMapping.getRequest());\n// We have multiple identical requests. Go back and make previous stub the start\n- stubMappings.get(0).setScenarioName(name);\n- stubMappings.get(0).setRequiredScenarioState(Scenario.STARTED);\n+ previousStubMapping.setScenarioName(name);\n+ previousStubMapping.setRequiredScenarioState(Scenario.STARTED);\n}\nif (count >= 1) {\nstubMapping.setScenarioName(name);\nstubMapping.setNewScenarioState(name + \"-\" + (count + 1));\n- String previousState = stubMappings.get(count - 1).getRequiredScenarioState();\n+ String previousState = previousStubMapping.getRequiredScenarioState();\nstubMapping.setRequiredScenarioState(previousState);\n}\n+ previousStubMapping = stubMapping;\ncount++;\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Don't need to track every stub mapping, just the previous
686,965
11.06.2017 23:28:11
25,200
aca8eacf4f507ccecd234775a27ece11a0c79e6f
Don't need to track name either because it's stored in the StubMapping
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "diff": "@@ -18,7 +18,6 @@ public class SnapshotStubMappingScenarioHandler {\nfinal private static String SCENARIO_NAME_PREFIX = \"scenario\";\nprivate int count = 1;\n- private String name = \"\";\nprivate StubMapping previousStubMapping;\npublic SnapshotStubMappingScenarioHandler(StubMapping stubMapping) {\n@@ -27,13 +26,14 @@ public class SnapshotStubMappingScenarioHandler {\npublic void trackStubMapping(StubMapping stubMapping) {\nif (count == 1) {\n- name = generateScenarioName(stubMapping.getRequest());\n+ String name = generateScenarioName(stubMapping.getRequest());\n// We have multiple identical requests. Go back and make previous stub the start\npreviousStubMapping.setScenarioName(name);\npreviousStubMapping.setRequiredScenarioState(Scenario.STARTED);\n}\nif (count >= 1) {\n+ String name = previousStubMapping.getScenarioName();\nstubMapping.setScenarioName(name);\nstubMapping.setNewScenarioState(name + \"-\" + (count + 1));\nString previousState = previousStubMapping.getRequiredScenarioState();\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/ServeEventRequestFiltersTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/ServeEventRequestFiltersTest.java", "diff": "@@ -26,7 +26,7 @@ public class ServeEventRequestFiltersTest {\n}\n@Test\n- public void applyWitMethodPattern() {\n+ public void applyWithMethodPattern() {\nServeEventRequestFilters filters = new ServeEventRequestFilters(newRequestPattern(GET, anyUrl()).build(), null);\nMockRequest request = mockRequest().method(GET).url(\"/foo\");\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Don't need to track name either because it's stored in the StubMapping
686,965
14.06.2017 00:29:08
25,200
f68b37e6010a07f5cc77000450923e23b5d58b12
Refactoring, cleanup, and adding tests
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotOutputFormat.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotOutputFormat.java", "diff": "@@ -7,7 +7,12 @@ import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n* Possible output formats for snapshot task\n*/\npublic enum SnapshotOutputFormat {\n- FULL,\n+ FULL {\n+ @Override\n+ public Object format(StubMapping stubMapping) {\n+ return stubMapping;\n+ }\n+ },\nIDS {\n@Override\npublic Object format(StubMapping stubMapping) {\n@@ -15,6 +20,8 @@ public enum SnapshotOutputFormat {\n}\n};\n+ public abstract Object format(StubMapping stubMapping);\n+\n@JsonCreator\npublic static SnapshotOutputFormat fromString(String value) {\nif (value == null || value.equalsIgnoreCase(\"ids\")) {\n@@ -22,8 +29,4 @@ public enum SnapshotOutputFormat {\n}\nreturn FULL;\n}\n-\n- public Object format(StubMapping stubMapping) {\n- return stubMapping;\n- }\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -20,12 +20,12 @@ public class SnapshotSpec {\nprivate SnapshotOutputFormat outputFormat;\n// Whether to persist stub mappings\nprivate boolean persist = true;\n- // Whether duplicate reuqests should be recorded as scenarios or just discarded\n+ // Whether duplicate requests should be recorded as scenarios or just discarded\nprivate boolean repeatsAsScenarios = false;\n-\n@JsonCreator\n- public SnapshotSpec(@JsonProperty(\"filters\") ServeEventRequestFilters filters ,\n+ public SnapshotSpec(\n+ @JsonProperty(\"filters\") ServeEventRequestFilters filters ,\n@JsonProperty(\"sortFields\") String[] sortFields,\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n@JsonProperty(\"outputFormat\") SnapshotOutputFormat outputFormat,\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "diff": "@@ -4,10 +4,8 @@ import com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import com.google.common.collect.Iterables;\nimport java.util.ArrayList;\n-import java.util.HashMap;\nimport java.util.List;\n/**\n@@ -17,16 +15,19 @@ public class SnapshotStubMappingGenerator {\nprivate final RequestPatternTransformer requestTransformer;\nprivate final LoggedResponseDefinitionTransformer responseTransformer;\nprivate final boolean shouldRecordRepeatsAsScenarios;\n- private HashMap<RequestPattern, SnapshotStubMappingScenarioHandler> requestScenarioHandlerMap;\n+ private final SnapshotStubMappingScenarioHandler stubMappingScenarioHandler;\n+\npublic SnapshotStubMappingGenerator(\nRequestPatternTransformer requestTransformer,\nLoggedResponseDefinitionTransformer responseTransformer,\n- boolean shouldRecordRepeatsAsScenarios\n+ boolean shouldRecordRepeatsAsScenarios,\n+ SnapshotStubMappingScenarioHandler stubMappingScenarioHandler\n) {\nthis.requestTransformer = requestTransformer;\nthis.responseTransformer = responseTransformer;\nthis.shouldRecordRepeatsAsScenarios = shouldRecordRepeatsAsScenarios;\n+ this.stubMappingScenarioHandler = stubMappingScenarioHandler;\n}\npublic SnapshotStubMappingGenerator(\n@@ -36,12 +37,13 @@ public class SnapshotStubMappingGenerator {\nthis(\nrequestTransformer == null ? new RequestPatternTransformer() : requestTransformer,\nnew LoggedResponseDefinitionTransformer(),\n- shouldRecordRepeatsAsScenarios\n+ shouldRecordRepeatsAsScenarios,\n+ new SnapshotStubMappingScenarioHandler()\n);\n}\npublic List<StubMapping> generateFrom(Iterable<ServeEvent> events) {\n- this.requestScenarioHandlerMap = new HashMap<>(Iterables.size(events));\n+ this.stubMappingScenarioHandler.reset();\nfinal ArrayList<StubMapping> stubMappings = new ArrayList<>();\nfor (ServeEvent event : events) {\n@@ -58,11 +60,7 @@ public class SnapshotStubMappingGenerator {\nfinal StubMapping stubMapping = new StubMapping(requestPattern, responseDefinition);\nif (shouldRecordRepeatsAsScenarios) {\n- if (requestScenarioHandlerMap.containsKey(stubMapping.getRequest())) {\n- requestScenarioHandlerMap.get(stubMapping.getRequest()).trackStubMapping(stubMapping);\n- } else {\n- requestScenarioHandlerMap.put(stubMapping.getRequest(), new SnapshotStubMappingScenarioHandler(stubMapping));\n- }\n+ stubMappingScenarioHandler.trackStubMapping(stubMapping);\n}\nreturn stubMapping;\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "diff": "@@ -8,47 +8,59 @@ import com.google.common.base.Splitter;\nimport com.google.common.collect.Iterables;\nimport java.net.URI;\n+import java.util.HashMap;\nimport static java.lang.Math.min;\n/**\n- * Tracks stub mappings and set scenario details for duplicate requests\n+ * Tracks RequestPatterns from StubMappings and generates scenarios when multiple identical requests are seen.\n*/\npublic class SnapshotStubMappingScenarioHandler {\n- final private static String SCENARIO_NAME_PREFIX = \"scenario\";\n+ private final static String SCENARIO_NAME_PREFIX = \"scenario\";\n- private int count = 1;\n- private StubMapping previousStubMapping;\n+ private final HashMap<RequestPattern, StubMappingTracker> requestStubMappingTracker;\n+\n+ public SnapshotStubMappingScenarioHandler() {\n+ requestStubMappingTracker = new HashMap<>();\n+ }\n- public SnapshotStubMappingScenarioHandler(StubMapping stubMapping) {\n- previousStubMapping = stubMapping;\n+ public void reset() {\n+ this.requestStubMappingTracker.clear();\n}\npublic void trackStubMapping(StubMapping stubMapping) {\n- if (count == 1) {\n- String name = generateScenarioName(stubMapping.getRequest());\n- // We have multiple identical requests. Go back and make previous stub the start\n- previousStubMapping.setScenarioName(name);\n- previousStubMapping.setRequiredScenarioState(Scenario.STARTED);\n+ StubMappingTracker tracker = requestStubMappingTracker.get(stubMapping.getRequest());\n+\n+ if (tracker == null) {\n+ requestStubMappingTracker.put(stubMapping.getRequest(), new StubMappingTracker(stubMapping));\n+ return;\n}\n- if (count >= 1) {\n- String name = previousStubMapping.getScenarioName();\n- stubMapping.setScenarioName(name);\n- stubMapping.setNewScenarioState(name + \"-\" + (count + 1));\n- String previousState = previousStubMapping.getRequiredScenarioState();\n+ tracker.count++;\n+\n+ if (tracker.count == 2) {\n+ // We have multiple identical requests. Go back and make previous stub the start\n+ String name = generateScenarioName(stubMapping.getRequest());\n+ tracker.previousStubMapping.setScenarioName(name);\n+ tracker.previousStubMapping.setRequiredScenarioState(Scenario.STARTED);\n+ stubMapping.setRequiredScenarioState(Scenario.STARTED);\n+ } else {\n+ String previousState = tracker.previousStubMapping.getNewScenarioState();\nstubMapping.setRequiredScenarioState(previousState);\n}\n- previousStubMapping = stubMapping;\n- count++;\n+ String name = tracker.previousStubMapping.getScenarioName();\n+ stubMapping.setScenarioName(name);\n+ stubMapping.setNewScenarioState(name + \"-\" + tracker.count);\n+\n+ tracker.previousStubMapping = stubMapping;\n}\n/**\n* Generates a scenario name from the request. Based on UniqueFilenameGenerator\n*\n* @TODO Use a better name generator\n- * @param request\n+ * @param request A RequestPattern from a StubMapping\n* @return Scenario name as a string\n*/\nprivate String generateScenarioName(RequestPattern request) {\n@@ -76,4 +88,17 @@ public class SnapshotStubMappingScenarioHandler {\nprivate static String sanitise(String input) {\nreturn input.replaceAll(\"[,~:/?#\\\\[\\\\]@!\\\\$&'()*+;=]\", \"_\");\n}\n+\n+ /**\n+ * Simple container class to store the previous stub mapping and sequence count for the scenario\n+ */\n+ private class StubMappingTracker {\n+ private int count;\n+ private StubMapping previousStubMapping;\n+\n+ public StubMappingTracker(StubMapping stubMapping) {\n+ this.count = 1;\n+ this.previousStubMapping = stubMapping;\n+ }\n+ }\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -36,7 +36,6 @@ public class SnapshotTask implements AdminTask {\nIterable<StubMapping> stubMappings = new SnapshotStubMappingGenerator(\nsnapshotSpec.getCaptureHeaders(),\nsnapshotSpec.shouldRecordRepeatsAsScenarios()\n-\n).generateFrom(serveEvents);\nstubMappings = from(stubMappings).filter(noDupes(admin));\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "diff": "@@ -3,12 +3,12 @@ package com.github.tomakehurst.wiremock.admin;\nimport com.github.tomakehurst.wiremock.admin.model.LoggedResponseDefinitionTransformer;\nimport com.github.tomakehurst.wiremock.admin.model.RequestPatternTransformer;\nimport com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingGenerator;\n+import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingScenarioHandler;\nimport com.github.tomakehurst.wiremock.http.LoggedResponse;\nimport com.github.tomakehurst.wiremock.http.Request;\nimport com.github.tomakehurst.wiremock.http.Response;\nimport com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.matching.RequestPatternBuilder;\n-import com.github.tomakehurst.wiremock.stubbing.Scenario;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\n@@ -42,7 +42,8 @@ public class SnapshotStubMappingGeneratorTest {\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\nresponseDefinitionTransformer(responseDefinition),\n- false\n+ false,\n+ stubbedScenarioHandler()\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -63,7 +64,8 @@ public class SnapshotStubMappingGeneratorTest {\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\nresponseDefinitionTransformer(responseDefinition),\n- true\n+ true,\n+ stubbedScenarioHandler()\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -77,18 +79,16 @@ public class SnapshotStubMappingGeneratorTest {\nexpected.add(stubMapping);\n}\n- // Make sure scenario was generated properly\n- expected.get(0).setScenarioName(\"scenario-foo\");\n- expected.get(0).setRequiredScenarioState(Scenario.STARTED);\n-\n- expected.get(1).setScenarioName(\"scenario-foo\");\n- expected.get(1).setRequiredScenarioState(Scenario.STARTED);\n- expected.get(1).setNewScenarioState(\"scenario-foo-2\");\n-\n-\nassertEquals(expected, actual);\n}\n+ private static SnapshotStubMappingScenarioHandler stubbedScenarioHandler() {\n+ return new SnapshotStubMappingScenarioHandler() {\n+ @Override\n+ public void trackStubMapping(StubMapping stubMapping) {}\n+ };\n+ }\n+\nprivate static RequestPatternTransformer requestPatternTransformer(final RequestPatternBuilder requestPatternBuilder) {\nreturn new RequestPatternTransformer() {\n@Override\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingScenarioHandlerTest.java", "diff": "+package com.github.tomakehurst.wiremock.admin;\n+\n+import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingScenarioHandler;\n+import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n+import com.github.tomakehurst.wiremock.stubbing.Scenario;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import org.junit.Test;\n+\n+import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n+import static org.junit.Assert.assertEquals;\n+import static org.junit.Assert.assertNull;\n+\n+public class SnapshotStubMappingScenarioHandlerTest {\n+ @Test\n+ public void trackSingleStubMapping() {\n+ StubMapping stubMapping = stubMappingForUrl(\"\");\n+ new SnapshotStubMappingScenarioHandler().trackStubMapping(stubMapping);\n+\n+ // Shouldn't have changed anything, since there hasn't been multiple identical requests\n+ assertNull(stubMapping.getScenarioName());\n+ assertNull(stubMapping.getNewScenarioState());\n+ assertNull(stubMapping.getRequiredScenarioState());\n+ }\n+\n+ @Test\n+ public void reset() {\n+ StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n+ SnapshotStubMappingScenarioHandler handler = new SnapshotStubMappingScenarioHandler();\n+\n+ handler.trackStubMapping(stubMapping);\n+ handler.reset();\n+ handler.trackStubMapping(stubMapping);\n+\n+ assertNull(stubMapping.getScenarioName());\n+ }\n+\n+ @Test\n+ public void trackMultipleStubMappings() {\n+ StubMapping stubMapping1 = stubMappingForUrl(\"/foo/bar-baz\");\n+ StubMapping stubMapping2 = stubMappingForUrl(\"/foo/bar-baz\");\n+ StubMapping stubMapping3 = stubMappingForUrl(\"/foo/bar-baz\");\n+ SnapshotStubMappingScenarioHandler handler = new SnapshotStubMappingScenarioHandler();\n+\n+ handler.trackStubMapping(stubMapping1);\n+ handler.trackStubMapping(stubMappingForUrl(\"this stub mapping should be ignored\"));\n+ handler.trackStubMapping(stubMapping2);\n+ handler.trackStubMapping(stubMapping3);\n+\n+ // Check first stub mapping, which should be the start of the scenario\n+ assertEquals(\"scenario-foo-bar-baz\", stubMapping1.getScenarioName());\n+ assertEquals(Scenario.STARTED, stubMapping1.getRequiredScenarioState());\n+ assertNull(stubMapping1.getNewScenarioState());\n+\n+ // Check second stub mapping\n+ assertEquals(stubMapping1.getScenarioName(), stubMapping2.getScenarioName());\n+ assertEquals(Scenario.STARTED, stubMapping2.getRequiredScenarioState());\n+ assertEquals(\"scenario-foo-bar-baz-2\", stubMapping2.getNewScenarioState());\n+\n+ // Check third stub mapping\n+ assertEquals(stubMapping1.getScenarioName(), stubMapping3.getScenarioName());\n+ assertEquals(\"scenario-foo-bar-baz-2\", stubMapping3.getRequiredScenarioState());\n+ assertEquals(\"scenario-foo-bar-baz-3\", stubMapping3.getNewScenarioState());\n+ }\n+\n+ private StubMapping stubMappingForUrl(String url) {\n+ return new StubMapping(\n+ newRequestPattern().withUrl(url).build(),\n+ ResponseDefinition.ok()\n+ );\n+ }\n+}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Refactoring, cleanup, and adding tests
687,057
15.06.2017 12:55:33
25,200
6af50bf145d436c186d92fd15ef5b5607a61102f
Adding new type of fault, CONNECTION_RESET_BY_PEER
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/core/FaultInjector.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/core/FaultInjector.java", "diff": "@@ -17,6 +17,7 @@ package com.github.tomakehurst.wiremock.core;\npublic interface FaultInjector {\n+ void connectionResetByPeer();\nvoid emptyResponseAndCloseConnection();\nvoid malformedResponseChunk();\nvoid randomDataAndCloseConnection();\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/http/Fault.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/http/Fault.java", "diff": "@@ -19,6 +19,13 @@ import com.github.tomakehurst.wiremock.core.FaultInjector;\npublic enum Fault {\n+ CONNECTION_RESET_BY_PEER {\n+ @Override\n+ public void apply(FaultInjector faultInjector) {\n+ faultInjector.connectionResetByPeer();\n+ }\n+ },\n+\nEMPTY_RESPONSE {\n@Override\npublic void apply(FaultInjector faultInjector) {\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyFaultInjector.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyFaultInjector.java", "diff": "@@ -43,6 +43,16 @@ public class JettyFaultInjector implements FaultInjector {\nthis.socket = socket();\n}\n+ @Override\n+ public void connectionResetByPeer() {\n+ try {\n+ socket.setSoLinger(true, 0);\n+ socket.close();\n+ } catch (IOException e) {\n+ throwUnchecked(e);\n+ }\n+ }\n+\n@Override\npublic void emptyResponseAndCloseConnection() {\ntry {\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyHttpsFaultInjector.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyHttpsFaultInjector.java", "diff": "@@ -46,6 +46,16 @@ public class JettyHttpsFaultInjector implements FaultInjector {\nthis.socket = selectChannelEndPoint.getSocket();\n}\n+ @Override\n+ public void connectionResetByPeer() {\n+ try {\n+ socket.setSoLinger(true, 0);\n+ socket.close();\n+ } catch (IOException e) {\n+ throwUnchecked(e);\n+ }\n+ }\n+\n@Override\npublic void emptyResponseAndCloseConnection() {\ntry {\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/servlet/NoFaultInjector.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/servlet/NoFaultInjector.java", "diff": "@@ -30,6 +30,11 @@ public class NoFaultInjector implements FaultInjector {\nthis.httpServletResponse = httpServletResponse;\n}\n+ @Override\n+ public void connectionResetByPeer() {\n+ sendError();\n+ }\n+\n@Override\npublic void emptyResponseAndCloseConnection() {\nsendError();\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/HttpsAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/HttpsAcceptanceTest.java", "diff": "@@ -34,8 +34,12 @@ import org.apache.http.impl.client.CloseableHttpClient;\nimport org.apache.http.impl.client.HttpClients;\nimport org.apache.http.util.EntityUtils;\nimport org.hamcrest.Matchers;\n+import org.hamcrest.core.IsInstanceOf;\nimport org.junit.After;\n+import org.junit.Rule;\nimport org.junit.Test;\n+import org.junit.internal.matchers.ThrowableCauseMatcher;\n+import org.junit.rules.ExpectedException;\nimport javax.net.ssl.SSLContext;\nimport javax.net.ssl.SSLHandshakeException;\n@@ -83,6 +87,21 @@ public class HttpsAcceptanceTest {\nassertThat(contentFor(url(\"/https-test\")), is(\"HTTPS content\"));\n}\n+ @Rule\n+ public final ExpectedException exception = ExpectedException.none();\n+\n+ @Test\n+ public void connectionResetByPeerFault() throws IOException {\n+ startServerWithDefaultKeystore();\n+ stubFor(get(urlEqualTo(\"/connection/reset\")).willReturn(\n+ aResponse()\n+ .withFault(Fault.CONNECTION_RESET_BY_PEER)));\n+\n+ exception.expect(SocketException.class);\n+ exception.expectMessage(\"Connection reset\");\n+ httpClient.execute(new HttpGet(url(\"/connection/reset\"))).getEntity();\n+ }\n+\n@Test\npublic void emptyResponseFault() {\nstartServerWithDefaultKeystore();\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/StubbingAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/StubbingAcceptanceTest.java", "diff": "@@ -26,9 +26,13 @@ import org.apache.http.client.ClientProtocolException;\nimport org.hamcrest.Description;\nimport org.hamcrest.Matcher;\nimport org.hamcrest.TypeSafeMatcher;\n+import org.hamcrest.core.IsInstanceOf;\nimport org.junit.BeforeClass;\n+import org.junit.Rule;\nimport org.junit.Test;\n+import org.junit.rules.ExpectedException;\n+import java.net.SocketException;\nimport java.util.UUID;\nimport static com.github.tomakehurst.wiremock.client.WireMock.*;\n@@ -323,6 +327,20 @@ public class StubbingAcceptanceTest extends AcceptanceTestBase {\nassertThat(testClient.get(\"/priority/resource\").statusCode(), is(200));\n}\n+ @Rule\n+ public final ExpectedException exception = ExpectedException.none();\n+\n+ @Test\n+ public void connectionResetByPeerFault() {\n+ stubFor(get(urlEqualTo(\"/connection/reset\")).willReturn(\n+ aResponse()\n+ .withFault(Fault.CONNECTION_RESET_BY_PEER)));\n+\n+ exception.expectCause(IsInstanceOf.<Throwable>instanceOf(SocketException.class));\n+ exception.expectMessage(\"java.net.SocketException: Connection reset\");\n+ testClient.get(\"/connection/reset\");\n+ }\n+\n@Test\npublic void emptyResponseFault() {\nstubFor(get(urlEqualTo(\"/empty/response\")).willReturn(\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Adding new type of fault, CONNECTION_RESET_BY_PEER
687,057
16.06.2017 09:34:34
25,200
7e693de1e1ed54b4408ec8319917d0c4cd5cf14d
Add CONNECTION_RESET_BY_PEER fault to raml response definition schema
[ { "change_type": "MODIFY", "old_path": "src/main/resources/raml/schemas/response-definition.schema.json", "new_path": "src/main/resources/raml/schemas/response-definition.schema.json", "diff": "\"type\": \"string\",\n\"description\": \"The fault to apply (instead of a full, valid response).\",\n\"enum\": [\n+ \"CONNECTION_RESET_BY_PEER\",\n\"EMPTY_RESPONSE\",\n\"MALFORMED_RESPONSE_CHUNK\",\n\"RANDOM_DATA_THEN_CLOSE\"\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add CONNECTION_RESET_BY_PEER fault to raml response definition schema
686,965
17.06.2017 03:15:36
25,200
194b85142eeaeca4738e43ed769d808741e244bd
Add SnapshotAcceptanceTest, mostly with tests moved from SnapshotTaskTest These tests ended up uncovering a few bugs, which I've fixed.
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -33,7 +33,7 @@ public class SnapshotSpec {\n@JsonProperty(\"repeatsAsScenarios\") JsonNode repeatsNode\n) {\nthis.filters = filters;\n- this.outputFormat = outputFormat;\n+ this.outputFormat = outputFormat == null ? SnapshotOutputFormat.FULL : outputFormat;\nthis.captureHeaders = new RequestPatternTransformer(captureHeaders);\nthis.persist = persistNode.asBoolean(true);\nthis.repeatsAsScenarios = repeatsNode.asBoolean(false);\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -38,7 +38,9 @@ public class SnapshotTask implements AdminTask {\nsnapshotSpec.shouldRecordRepeatsAsScenarios()\n).generateFrom(serveEvents);\n+ if (!snapshotSpec.shouldRecordRepeatsAsScenarios()) {\nstubMappings = from(stubMappings).filter(noDupes(admin));\n+ }\nfinal ArrayList<Object> response = new ArrayList<>();\n@@ -71,7 +73,7 @@ public class SnapshotTask implements AdminTask {\nreturn new Predicate<StubMapping>() {\n@Override\npublic boolean apply(StubMapping stubMapping) {\n- return admin.countRequestsMatching(stubMapping.getRequest()).getCount() == 0;\n+ return admin.countRequestsMatching(stubMapping.getRequest()).getCount() == 1;\n}\n};\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "diff": "+/*\n+ * Copyright (C) 2017 Thomas Akehurst\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package com.github.tomakehurst.wiremock;\n+\n+import com.fasterxml.jackson.databind.JsonNode;\n+import com.github.tomakehurst.wiremock.client.WireMock;\n+import com.github.tomakehurst.wiremock.common.Json;\n+import com.github.tomakehurst.wiremock.testsupport.WireMockResponse;\n+import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\n+import org.junit.Test;\n+import org.skyscreamer.jsonassert.JSONCompareMode;\n+\n+import static com.github.tomakehurst.wiremock.client.WireMock.*;\n+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;\n+import static com.github.tomakehurst.wiremock.testsupport.TestHttpHeader.withHeader;\n+import static com.github.tomakehurst.wiremock.testsupport.WireMatchers.equalToJson;\n+import static java.net.HttpURLConnection.HTTP_OK;\n+import static junit.framework.TestCase.assertFalse;\n+import static org.junit.Assert.assertThat;\n+\n+public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n+ private WireMockServer proxyingService;\n+ private WireMockTestClient proxyingTestClient;\n+\n+ public void init() {\n+ proxyingService = new WireMockServer(wireMockConfig().dynamicPort());\n+ proxyingService.start();\n+ proxyingService.stubFor(proxyAllTo(\"http://localhost:\" + wireMockServer.port()));\n+\n+ proxyingTestClient = new WireMockTestClient(proxyingService.port());\n+ }\n+\n+ private static final String DEFAULT_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsRequestsWithDefaultOptions() throws Exception {\n+ wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n+\n+ proxyingTestClient.get(\"/foo/bar\", withHeader(\"A\", \"B\"));\n+ proxyingTestClient.get(\"/foo/bar/baz\", withHeader(\"A\", \"B\"));\n+\n+ assertThat(\n+ snapshot(\"{}\"),\n+ equalToJson(DEFAULT_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"filters\\\": { \\n\" +\n+ \" \\\"urlPattern\\\": \\\"/foo.*\\\", \\n\" +\n+ \" \\\"headers\\\": { \\n\" +\n+ \" \\\"A\\\": { \\\"equalTo\\\": \\\"B\\\" } \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \"} \";\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsFilteredRequestsWithJustRequestPatternsAndFullOutputFormat() throws Exception {\n+ wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n+\n+ // Matches both\n+ proxyingTestClient.get(\"/foo/bar\", withHeader(\"A\", \"B\"));\n+ // Fails header match\n+ proxyingTestClient.get(\"/foo\");\n+ // Fails URL match\n+ proxyingTestClient.get(\"/bar\", withHeader(\"A\", \"B\"));\n+ // Fails header match\n+ proxyingTestClient.get(\"/foo/\", withHeader(\"A\", \"C\"));\n+ // Matches both\n+ proxyingTestClient.get(\"/foo/bar/baz\", withHeader(\"A\", \"B\"));\n+\n+ assertThat(\n+ snapshot(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST_TEMPLATE =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"filters\\\": { \\n\" +\n+ \" \\\"ids\\\": [ %s, %s ], \\n\" +\n+ \" \\\"urlPattern\\\": \\\"/foo.*\\\" \\n\" +\n+ \" } \\n\" +\n+ \"} \";\n+\n+ private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsFilteredRequestsWithRequestPatternAndIdsWithFullOutputFormat() {\n+ wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n+\n+ // Matches both\n+ proxyingTestClient.get(\"/foo/bar\");\n+ // Fails URL match\n+ proxyingTestClient.get(\"/bar\");\n+ // Fails ID match\n+ proxyingTestClient.get(\"/foo\");\n+\n+ String requestsJson = proxyingTestClient.get(\"/__admin/requests\").content();\n+ JsonNode requestsNode = Json.node(requestsJson).path(\"requests\");\n+\n+ String request = String.format(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST_TEMPLATE,\n+ requestsNode.get(2).get(\"id\"),\n+ requestsNode.get(1).get(\"id\")\n+ );\n+\n+ assertThat(\n+ snapshot(request),\n+ equalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+\n+ private static final String CAPTURE_HEADERS_SNAPSHOT_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"captureHeaders\\\": { \\n\" +\n+ \" \\\"Accept\\\": { \\n\" +\n+ \" \\\"anything\\\": true \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"X-NoMatch\\\": { \\n\" +\n+ \" \\\"equalTo\\\": \\\"!\\\" \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \"} \";\n+\n+ private static final String CAPTURE_HEADERS_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"PUT\\\", \\n\" +\n+ \" \\\"headers\\\": { \\n\" +\n+ \" \\\"Accept\\\": { \\n\" +\n+ \" \\\"equalTo\\\": \\\"B\\\" \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \"] \";\n+\n+ @Test\n+ public void returnsStubMappingWithCapturedHeaders() {\n+ wireMockServer.stubFor(put(anyUrl()).willReturn(ok()));\n+\n+ proxyingTestClient.put(\"/foo/bar\",\n+ withHeader(\"A\", \"B\"),\n+ withHeader(\"Accept\", \"B\"),\n+ withHeader(\"X-NoMatch\", \"should be ignored\")\n+ );\n+\n+ String actual = snapshot(CAPTURE_HEADERS_SNAPSHOT_REQUEST);\n+ assertThat(actual, equalToJson(CAPTURE_HEADERS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER));\n+ assertFalse(actual.contains(\"X-NoMatch\"));\n+ }\n+\n+ private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"repeatsAsScenarios\\\": \\\"true\\\" \\n\" +\n+ \"} \";\n+\n+ private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n+ \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n+ \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n+ \" \\\"newScenarioState\\\" : \\\"scenario-bar-baz-2\\\", \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\" \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsStubMappingsWithScenariosForRepeatedRequests() {\n+ wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n+\n+ proxyingTestClient.get(\"/bar/baz\");\n+ proxyingTestClient.get(\"/foo\");\n+ proxyingTestClient.get(\"/bar/baz\");\n+\n+ assertThat(\n+ snapshot(REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST),\n+ equalToJson(REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+ private String snapshot(String snapshotSpecJson) {\n+ WireMockResponse response = proxyingTestClient.postJson(\"/__admin/recordings/snapshot\", snapshotSpecJson);\n+ if (response.statusCode() != HTTP_OK) {\n+ throw new RuntimeException(\"Returned status code was \" + response.statusCode());\n+ }\n+ return response.content();\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -19,20 +19,15 @@ import org.jmock.integration.junit4.JMock;\nimport org.junit.Before;\nimport org.junit.Test;\nimport org.junit.runner.RunWith;\n-import org.skyscreamer.jsonassert.JSONCompareMode;\nimport java.util.Arrays;\nimport java.util.UUID;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.responseDefinition;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\n-import static com.github.tomakehurst.wiremock.http.RequestMethod.POST;\nimport static com.github.tomakehurst.wiremock.http.Response.response;\nimport static com.github.tomakehurst.wiremock.matching.MockRequest.mockRequest;\n-import static com.github.tomakehurst.wiremock.testsupport.WireMatchers.equalToJson;\nimport static java.net.HttpURLConnection.HTTP_OK;\n-import static junit.framework.TestCase.assertFalse;\n-import static org.hamcrest.MatcherAssert.assertThat;\nimport static org.junit.Assert.assertEquals;\n@RunWith(JMock.class)\n@@ -58,7 +53,7 @@ public class SnapshotTaskTest {\ncontext.checking(new Expectations() {{\nexactly(2).of(mockAdmin).addStubMapping(with(any(StubMapping.class)));\n}});\n- setReturnForCountRequestsMatching(0);\n+ setReturnForCountRequestsMatching(1);\n// Check when explicitly set\nJsonAssertion.assertThat(execute(\"{ \\\"persist\\\": true, \\\"outputFormat\\\": \\\"ids\\\"}\"))\n@@ -76,7 +71,7 @@ public class SnapshotTaskTest {\n@Test\npublic void shouldNotPersistWhenSetToFalse() {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForCountRequestsMatching(0);\n+ setReturnForCountRequestsMatching(1);\nJsonAssertion.assertThat(executeWithoutPersist())\n.hasSize(1)\n.arrayField()\n@@ -98,7 +93,7 @@ public class SnapshotTaskTest {\n@Test\npublic void returnsEmptyArrayForExistingStubMapping() {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForCountRequestsMatching(1);\n+ setReturnForCountRequestsMatching(2);\nassertEquals(\"[ ]\", executeWithoutPersist());\n}\n@@ -108,234 +103,12 @@ public class SnapshotTaskTest {\nserveEvent(mockRequest(), response(), true),\nserveEvent(mockRequest().url(\"/foo\"), response(), true)\n);\n- setReturnForCountRequestsMatching(0);\n+ setReturnForCountRequestsMatching(1);\nJsonAssertion.assertThat(executeWithoutPersist())\n.hasSize(2)\n.arrayField();\n}\n- private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST =\n- \"{ \\n\" +\n- \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n- \" \\\"persist\\\": \\\"false\\\", \\n\" +\n- \" \\\"filters\\\": { \\n\" +\n- \" \\\"urlPattern\\\": \\\"/foo.*\\\", \\n\" +\n- \" \\\"headers\\\": { \\n\" +\n- \" \\\"A\\\": { \\\"equalTo\\\": \\\"B\\\" } \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \"} \";\n-\n- private static final String FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE =\n- \"[ \\n\" +\n- \" { \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" }, \\n\" +\n- \" { \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/foo/bar/baz\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \" ] \";\n-\n- @Test\n- public void returnsFilteredRequestsWithJustRequestPatternsAndFullOutputFormat() {\n- setServeEvents(\n- // Matches both\n- serveEvent(mockRequest().url(\"/foo/bar\").header(\"A\",\"B\"), response(), true),\n- // Fails header match\n- serveEvent(mockRequest().url(\"/foo\"), response(), true),\n- // Fails URL match\n- serveEvent(mockRequest().url(\"/bar\").header(\"A\", \"B\"), response(), true),\n- // Fails header match\n- serveEvent(mockRequest().url(\"/foo/\").header(\"A\", \"C\"), response(), true),\n- // Matches both\n- serveEvent(mockRequest().url(\"/foo/bar/baz\").header(\"A\",\"B\"), response(), true)\n- );\n- setReturnForCountRequestsMatching(0);\n- assertThat(\n- execute(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\n- equalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n- );\n- }\n-\n- private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST =\n- \"{ \\n\" +\n- \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n- \" \\\"persist\\\": \\\"false\\\", \\n\" +\n- \" \\\"filters\\\": { \\n\" +\n- \" \\\"ids\\\": [ \\n\" +\n- \" \\\"00000000-0000-0000-0000-000000000001\\\", \\n\" +\n- \" \\\"00000000-0000-0000-0000-000000000002\\\" \\n\" +\n- \" ], \\n\" +\n- \" \\\"urlPattern\\\": \\\"/foo.*\\\" \\n\" +\n- \" } \\n\" +\n- \"} \";\n-\n- private static final String FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE =\n- \"[ \\n\" +\n- \" { \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \" ] \";\n-\n- @Test\n- public void returnsFilteredRequestsWithRequestPatternAndIdsWithFullOutputFormat() {\n- setServeEvents(\n- // Matches both\n- serveEvent(\n- UUID.fromString(\"00000000-0000-0000-0000-000000000001\"),\n- mockRequest().url(\"/foo/bar\"),\n- response(),\n- true\n- ),\n- // Fails URL match\n- serveEvent(\n- UUID.fromString(\"00000000-0000-0000-0000-000000000001\"),\n- mockRequest().url(\"/bar\"),\n- response(),\n- true\n- ),\n- // Fails ID match\n- serveEvent(\n- UUID.fromString(\"00000000-0000-0000-0000-000000000003\"),\n- mockRequest().url(\"/foo/bar\"),\n- response(),\n- true\n- )\n- );\n- setReturnForCountRequestsMatching(0);\n- assertThat(\n- execute(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_REQUEST),\n- equalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n- );\n- }\n-\n- private static final String CAPTURE_HEADERS_SNAPSHOT_REQUEST =\n- \"{ \\n\" +\n- \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n- \" \\\"persist\\\": \\\"false\\\", \\n\" +\n- \" \\\"captureHeaders\\\": { \\n\" +\n- \" \\\"Accept\\\": { \\n\" +\n- \" \\\"anything\\\": true \\n\" +\n- \" }, \\n\" +\n- \" \\\"X-NoMatch\\\": { \\n\" +\n- \" \\\"equalTo\\\": \\\"!\\\" \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \"} \";\n-\n- private static final String CAPTURE_HEADERS_SNAPSHOT_RESPONSE =\n- \"[ \\n\" +\n- \" { \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/foo/bar\\\", \\n\" +\n- \" \\\"method\\\" : \\\"POST\\\", \\n\" +\n- \" \\\"headers\\\": { \\n\" +\n- \" \\\"Accept\\\": { \\n\" +\n- \" \\\"equalTo\\\": \\\"B\\\" \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \"] \";\n-\n- @Test\n- public void returnsStubMappingWithCapturedHeaders() {\n- setServeEvents(\n- serveEvent(\n- mockRequest()\n- .url(\"/foo/bar\")\n- .method(POST)\n- .header(\"Accept\",\"B\")\n- .header(\"X-NoMatch\",\"should be ignored\"),\n- response(),\n- true\n- )\n- );\n- setReturnForCountRequestsMatching(0);\n-\n- String actual = execute(CAPTURE_HEADERS_SNAPSHOT_REQUEST);\n- assertThat(actual, equalToJson(CAPTURE_HEADERS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER));\n- assertFalse(actual.contains(\"X-NoMatch\"));\n- }\n-\n- private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST =\n- \"{ \\n\" +\n- \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n- \" \\\"persist\\\": \\\"false\\\", \\n\" +\n- \" \\\"repeatsAsScenarios\\\": \\\"true\\\" \\n\" +\n- \"} \";\n-\n- private static final String REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE =\n- \"[ \\n\" +\n- \" { \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/foo\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" }, \\n\" +\n- \" { \\n\" +\n- \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n- \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" }, \\n\" +\n- \" { \\n\" +\n- \" \\\"scenarioName\\\" : \\\"scenario-bar-baz\\\", \\n\" +\n- \" \\\"requiredScenarioState\\\" : \\\"Started\\\", \\n\" +\n- \" \\\"newScenarioState\\\" : \\\"scenario-bar-baz-2\\\", \\n\" +\n- \" \\\"request\\\" : { \\n\" +\n- \" \\\"url\\\" : \\\"/bar/baz\\\", \\n\" +\n- \" \\\"method\\\" : \\\"ANY\\\" \\n\" +\n- \" }, \\n\" +\n- \" \\\"response\\\" : { \\n\" +\n- \" \\\"status\\\" : 200 \\n\" +\n- \" } \\n\" +\n- \" } \\n\" +\n- \" ] \";\n-\n- @Test\n- public void returnsStubMappingsWithScenariosForRepeatedRequests() {\n- setServeEvents(\n- serveEvent(mockRequest().url(\"/foo\"), response(), true),\n- serveEvent(mockRequest().url(\"/bar/baz\"), response(), true),\n- serveEvent(mockRequest().url(\"/bar/baz\"), response(), true)\n- );\n- setReturnForCountRequestsMatching(0);\n- assertThat(\n- execute(REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST),\n- equalToJson(REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n- );\n- }\n-\nprivate String executeWithoutPersist() {\nreturn execute(\"{ \\\"persist\\\": false, \\\"outputFormat\\\": \\\"ids\\\" }\");\n}\n@@ -370,16 +143,12 @@ public class SnapshotTaskTest {\n}\nprivate static ServeEvent serveEvent(Request request, Response.Builder responseBuilder, boolean wasProxied) {\n- return serveEvent(UUID.randomUUID(), request, responseBuilder, wasProxied);\n- }\n-\n- private static ServeEvent serveEvent(UUID id, Request request, Response.Builder responseBuilder, boolean wasProxied) {\nResponseDefinitionBuilder responseDefinition = responseDefinition();\nif (wasProxied) {\nresponseDefinition.proxiedFrom(\"/foo\");\n}\nreturn new ServeEvent(\n- id,\n+ UUID.randomUUID(),\nLoggedRequest.createFrom(request),\nnull,\nresponseDefinition.build(),\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add SnapshotAcceptanceTest, mostly with tests moved from SnapshotTaskTest These tests ended up uncovering a few bugs, which I've fixed.
686,965
17.06.2017 16:00:43
25,200
43a325058e20e0dbf6f69e9ec3ec8ee79ff0cf40
Don't persist stub mappings in SnapshotAcceptanceTest#returnsRequestsWithDefaultOptions()
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "diff": "@@ -36,7 +36,9 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\nprivate WireMockTestClient proxyingTestClient;\npublic void init() {\n- proxyingService = new WireMockServer(wireMockConfig().dynamicPort());\n+ proxyingService = new WireMockServer(wireMockConfig()\n+ .dynamicPort()\n+ .withRootDirectory(\"src/test/resources/empty\"));\nproxyingService.start();\nproxyingService.stubFor(proxyAllTo(\"http://localhost:\" + wireMockServer.port()));\n@@ -73,7 +75,7 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\nproxyingTestClient.get(\"/foo/bar/baz\", withHeader(\"A\", \"B\"));\nassertThat(\n- snapshot(\"{}\"),\n+ snapshot(\"{ \\\"persist\\\": false }\"),\nequalToJson(DEFAULT_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Don't persist stub mappings in SnapshotAcceptanceTest#returnsRequestsWithDefaultOptions()
686,965
17.06.2017 16:49:36
25,200
b4f37f36efd3bbafd10380bb1808df78178db4c0
Complete refactoring for repeated request/scenario handling
[ { "change_type": "RENAME", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingScenarioHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotRepeatedRequestHandler.java", "diff": "@@ -8,36 +8,50 @@ import com.google.common.base.Splitter;\nimport com.google.common.collect.Iterables;\nimport java.net.URI;\n+import java.util.ArrayList;\nimport java.util.HashMap;\n+import java.util.List;\nimport static java.lang.Math.min;\n/**\n- * Tracks RequestPatterns from StubMappings and generates scenarios when multiple identical requests are seen.\n+ * Counts unique RequestPatterns from StubMappings. If shouldRecordRepeatsAsScenarios is enabled, then multiple\n+ * identical requests will be recorded as scenarios. Otherwise, they're skipped.\n*/\n-public class SnapshotStubMappingScenarioHandler {\n+public class SnapshotRepeatedRequestHandler {\nprivate final static String SCENARIO_NAME_PREFIX = \"scenario\";\n-\n+ private final boolean shouldRecordRepeatsAsScenarios;\nprivate final HashMap<RequestPattern, StubMappingTracker> requestStubMappingTracker;\n- public SnapshotStubMappingScenarioHandler() {\n- requestStubMappingTracker = new HashMap<>();\n+ public SnapshotRepeatedRequestHandler(boolean shouldRecordRepeatsAsScenarios) {\n+ this.shouldRecordRepeatsAsScenarios = shouldRecordRepeatsAsScenarios;\n+ this.requestStubMappingTracker = new HashMap<>();\n}\n- public void reset() {\n+ public List<StubMapping> processStubMappings(List<StubMapping> stubMappings) {\nthis.requestStubMappingTracker.clear();\n- }\n+ ArrayList<StubMapping> processedMappings = new ArrayList<>(stubMappings.size());\n- public void trackStubMapping(StubMapping stubMapping) {\n+ for (StubMapping stubMapping : stubMappings) {\nStubMappingTracker tracker = requestStubMappingTracker.get(stubMapping.getRequest());\n+ // If tracker is null, this request has not been seen before. Otherwise, it's a repeat.\n+ if (tracker == null || shouldRecordRepeatsAsScenarios) {\nif (tracker == null) {\nrequestStubMappingTracker.put(stubMapping.getRequest(), new StubMappingTracker(stubMapping));\n- return;\n+ } else {\n+ tracker.count++;\n+ setScenarioDetailsIfApplicable(stubMapping, tracker);\n+ tracker.previousStubMapping = stubMapping;\n+ }\n+ processedMappings.add(stubMapping);\n+ }\n}\n- tracker.count++;\n+ return processedMappings;\n+ }\n+ private void setScenarioDetailsIfApplicable(StubMapping stubMapping, StubMappingTracker tracker) {\nif (tracker.count == 2) {\n// We have multiple identical requests. Go back and make previous stub the start\nString name = generateScenarioName(stubMapping.getRequest());\n@@ -52,8 +66,6 @@ public class SnapshotStubMappingScenarioHandler {\nString name = tracker.previousStubMapping.getScenarioName();\nstubMapping.setScenarioName(name);\nstubMapping.setNewScenarioState(name + \"-\" + tracker.count);\n-\n- tracker.previousStubMapping = stubMapping;\n}\n/**\n@@ -90,7 +102,7 @@ public class SnapshotStubMappingScenarioHandler {\n}\n/**\n- * Simple container class to store the previous stub mapping and sequence count for the scenario\n+ * Simple container class to store the previous stub mapping and sequence count for building scenarios\n*/\nprivate class StubMappingTracker {\nprivate int count;\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingGenerator.java", "diff": "@@ -14,42 +14,28 @@ import java.util.List;\npublic class SnapshotStubMappingGenerator {\nprivate final RequestPatternTransformer requestTransformer;\nprivate final LoggedResponseDefinitionTransformer responseTransformer;\n- private final boolean shouldRecordRepeatsAsScenarios;\n- private final SnapshotStubMappingScenarioHandler stubMappingScenarioHandler;\npublic SnapshotStubMappingGenerator(\nRequestPatternTransformer requestTransformer,\n- LoggedResponseDefinitionTransformer responseTransformer,\n- boolean shouldRecordRepeatsAsScenarios,\n- SnapshotStubMappingScenarioHandler stubMappingScenarioHandler\n+ LoggedResponseDefinitionTransformer responseTransformer\n) {\nthis.requestTransformer = requestTransformer;\nthis.responseTransformer = responseTransformer;\n- this.shouldRecordRepeatsAsScenarios = shouldRecordRepeatsAsScenarios;\n- this.stubMappingScenarioHandler = stubMappingScenarioHandler;\n}\n- public SnapshotStubMappingGenerator(\n- RequestPatternTransformer requestTransformer,\n- boolean shouldRecordRepeatsAsScenarios\n- ) {\n+ public SnapshotStubMappingGenerator(RequestPatternTransformer requestTransformer) {\nthis(\nrequestTransformer == null ? new RequestPatternTransformer() : requestTransformer,\n- new LoggedResponseDefinitionTransformer(),\n- shouldRecordRepeatsAsScenarios,\n- new SnapshotStubMappingScenarioHandler()\n+ new LoggedResponseDefinitionTransformer()\n);\n}\npublic List<StubMapping> generateFrom(Iterable<ServeEvent> events) {\n- this.stubMappingScenarioHandler.reset();\n-\nfinal ArrayList<StubMapping> stubMappings = new ArrayList<>();\nfor (ServeEvent event : events) {\nstubMappings.add(generateFrom(event));\n}\n-\nreturn stubMappings;\n}\n@@ -57,12 +43,6 @@ public class SnapshotStubMappingGenerator {\nfinal RequestPattern requestPattern = requestTransformer.apply(event.getRequest()).build();\nfinal ResponseDefinition responseDefinition = responseTransformer.apply(event.getResponse());\n- final StubMapping stubMapping = new StubMapping(requestPattern, responseDefinition);\n-\n- if (shouldRecordRepeatsAsScenarios) {\n- stubMappingScenarioHandler.trackStubMapping(stubMapping);\n- }\n-\n- return stubMapping;\n+ return new StubMapping(requestPattern, responseDefinition);\n}\n}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -12,6 +12,7 @@ import com.google.common.base.Predicate;\nimport com.google.common.collect.FluentIterable;\nimport java.util.ArrayList;\n+import java.util.List;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.jsonResponse;\nimport static com.google.common.collect.FluentIterable.from;\n@@ -33,14 +34,11 @@ public class SnapshotTask implements AdminTask {\nsnapshotSpec.getFilters()\n);\n- Iterable<StubMapping> stubMappings = new SnapshotStubMappingGenerator(\n- snapshotSpec.getCaptureHeaders(),\n- snapshotSpec.shouldRecordRepeatsAsScenarios()\n- ).generateFrom(serveEvents);\n+ List<StubMapping> stubMappings = new SnapshotStubMappingGenerator(snapshotSpec.getCaptureHeaders())\n+ .generateFrom(serveEvents);\n- if (!snapshotSpec.shouldRecordRepeatsAsScenarios()) {\n- stubMappings = from(stubMappings).filter(noDupes(admin));\n- }\n+ stubMappings = new SnapshotRepeatedRequestHandler(snapshotSpec.shouldRecordRepeatsAsScenarios())\n+ .processStubMappings(stubMappings);\nfinal ArrayList<Object> response = new ArrayList<>();\n@@ -69,15 +67,6 @@ public class SnapshotTask implements AdminTask {\nreturn serveEvents;\n}\n- private Predicate<StubMapping> noDupes(final Admin admin) {\n- return new Predicate<StubMapping>() {\n- @Override\n- public boolean apply(StubMapping stubMapping) {\n- return admin.countRequestsMatching(stubMapping.getRequest()).getCount() == 1;\n- }\n- };\n- }\n-\nprivate Predicate<ServeEvent> onlyProxied() {\nreturn new Predicate<ServeEvent>() {\n@Override\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotRepeatedRequestHandlerTest.java", "diff": "+package com.github.tomakehurst.wiremock.admin;\n+\n+import com.github.tomakehurst.wiremock.admin.model.SnapshotRepeatedRequestHandler;\n+import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n+import com.github.tomakehurst.wiremock.stubbing.Scenario;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.google.common.collect.Lists;\n+import org.junit.Test;\n+\n+import java.util.List;\n+\n+import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n+import static org.junit.Assert.assertEquals;\n+import static org.junit.Assert.assertNull;\n+\n+public class SnapshotRepeatedRequestHandlerTest {\n+ @Test\n+ public void processSingleStubMapping() {\n+ List<StubMapping> mappings = Lists.newArrayList(stubMappingForUrl(\"\"));\n+ List<StubMapping> results = new SnapshotRepeatedRequestHandler(true)\n+ .processStubMappings(mappings);\n+\n+ // Shouldn't have changed anything, since there hasn't been multiple identical requests\n+ assertEquals(mappings, results);\n+ }\n+\n+ @Test\n+ public void resetsAfterRun() {\n+ List<StubMapping> mappings = Lists.newArrayList(stubMappingForUrl(\"\"));\n+ SnapshotRepeatedRequestHandler handler = new SnapshotRepeatedRequestHandler(false);\n+\n+ List<StubMapping> results1 = handler.processStubMappings(mappings);\n+ // Should not have persisted request tracking state\n+ List<StubMapping> results2 = handler.processStubMappings(mappings);\n+\n+ assertEquals(mappings, results1);\n+ assertEquals(results1, results2);\n+ }\n+\n+ @Test\n+ public void trackMultipleStubMappingsAsScenarios() {\n+ List<StubMapping> stubMappings = Lists.newArrayList(\n+ stubMappingForUrl(\"/foo/bar\"),\n+ stubMappingForUrl(\"/foo/bar\"),\n+ stubMappingForUrl(\"/not/part/of/scenario\"),\n+ stubMappingForUrl(\"/foo/bar\")\n+ );\n+\n+ SnapshotRepeatedRequestHandler handler = new SnapshotRepeatedRequestHandler(true);\n+ List<StubMapping> results = handler.processStubMappings(stubMappings);\n+\n+ assertEquals(4, results.size());\n+\n+ // Check first stub mapping, which should be the start of the scenario\n+ assertEquals(\"/foo/bar\", results.get(0).getRequest().getUrl());\n+ assertEquals(\"scenario-foo-bar\", results.get(0).getScenarioName());\n+ assertEquals(Scenario.STARTED, results.get(0).getRequiredScenarioState());\n+ assertNull(results.get(0).getNewScenarioState());\n+\n+ // Check second stub mapping\n+ assertEquals(results.get(0).getRequest(), results.get(1).getRequest());\n+ assertEquals(results.get(1).getScenarioName(), results.get(1).getScenarioName());\n+ assertEquals(Scenario.STARTED, results.get(1).getRequiredScenarioState());\n+ assertEquals(\"scenario-foo-bar-2\", results.get(1).getNewScenarioState());\n+\n+ // Check third stub mapping, which is not part of the scenario\n+ assertEquals(\"/not/part/of/scenario\", results.get(2).getRequest().getUrl());\n+ assertNull(results.get(2).getScenarioName());\n+ assertNull(results.get(2).getRequiredScenarioState());\n+ assertNull(results.get(2).getNewScenarioState());\n+\n+ // Check fourth stub mapping, which is the final state in the scenario\n+ assertEquals(results.get(0).getRequest(), results.get(3).getRequest());\n+ assertEquals(results.get(3).getScenarioName(), results.get(3).getScenarioName());\n+ assertEquals(\"scenario-foo-bar-2\", results.get(3).getRequiredScenarioState());\n+ assertEquals(\"scenario-foo-bar-3\", results.get(3).getNewScenarioState());\n+ }\n+\n+ private StubMapping stubMappingForUrl(String url) {\n+ return new StubMapping(\n+ newRequestPattern().withUrl(url).build(),\n+ ResponseDefinition.ok()\n+ );\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingGeneratorTest.java", "diff": "@@ -3,7 +3,6 @@ package com.github.tomakehurst.wiremock.admin;\nimport com.github.tomakehurst.wiremock.admin.model.LoggedResponseDefinitionTransformer;\nimport com.github.tomakehurst.wiremock.admin.model.RequestPatternTransformer;\nimport com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingGenerator;\n-import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingScenarioHandler;\nimport com.github.tomakehurst.wiremock.http.LoggedResponse;\nimport com.github.tomakehurst.wiremock.http.Request;\nimport com.github.tomakehurst.wiremock.http.Response;\n@@ -27,8 +26,7 @@ public class SnapshotStubMappingGeneratorTest {\n@Test\npublic void generateFromWithEmptyList() {\nList<StubMapping> actual = new SnapshotStubMappingGenerator(\n- requestPatternTransformer(null),\n- false\n+ requestPatternTransformer(null)\n).generateFrom(Lists.<ServeEvent>newArrayList());\nassertEquals(new ArrayList<>(), actual);\n@@ -41,9 +39,7 @@ public class SnapshotStubMappingGeneratorTest {\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\n- responseDefinitionTransformer(responseDefinition),\n- false,\n- stubbedScenarioHandler()\n+ responseDefinitionTransformer(responseDefinition)\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -63,9 +59,7 @@ public class SnapshotStubMappingGeneratorTest {\nSnapshotStubMappingGenerator stubMappingTransformer = new SnapshotStubMappingGenerator(\nrequestPatternTransformer(requestPatternBuilder),\n- responseDefinitionTransformer(responseDefinition),\n- true,\n- stubbedScenarioHandler()\n+ responseDefinitionTransformer(responseDefinition)\n);\nList<StubMapping> actual = stubMappingTransformer.generateFrom(\n@@ -82,13 +76,6 @@ public class SnapshotStubMappingGeneratorTest {\nassertEquals(expected, actual);\n}\n- private static SnapshotStubMappingScenarioHandler stubbedScenarioHandler() {\n- return new SnapshotStubMappingScenarioHandler() {\n- @Override\n- public void trackStubMapping(StubMapping stubMapping) {}\n- };\n- }\n-\nprivate static RequestPatternTransformer requestPatternTransformer(final RequestPatternBuilder requestPatternBuilder) {\nreturn new RequestPatternTransformer() {\n@Override\n" }, { "change_type": "DELETE", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingScenarioHandlerTest.java", "new_path": null, "diff": "-package com.github.tomakehurst.wiremock.admin;\n-\n-import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingScenarioHandler;\n-import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n-import com.github.tomakehurst.wiremock.stubbing.Scenario;\n-import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import org.junit.Test;\n-\n-import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n-import static org.junit.Assert.assertEquals;\n-import static org.junit.Assert.assertNull;\n-\n-public class SnapshotStubMappingScenarioHandlerTest {\n- @Test\n- public void trackSingleStubMapping() {\n- StubMapping stubMapping = stubMappingForUrl(\"\");\n- new SnapshotStubMappingScenarioHandler().trackStubMapping(stubMapping);\n-\n- // Shouldn't have changed anything, since there hasn't been multiple identical requests\n- assertNull(stubMapping.getScenarioName());\n- assertNull(stubMapping.getNewScenarioState());\n- assertNull(stubMapping.getRequiredScenarioState());\n- }\n-\n- @Test\n- public void reset() {\n- StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n- SnapshotStubMappingScenarioHandler handler = new SnapshotStubMappingScenarioHandler();\n-\n- handler.trackStubMapping(stubMapping);\n- handler.reset();\n- handler.trackStubMapping(stubMapping);\n-\n- assertNull(stubMapping.getScenarioName());\n- }\n-\n- @Test\n- public void trackMultipleStubMappings() {\n- StubMapping stubMapping1 = stubMappingForUrl(\"/foo/bar-baz\");\n- StubMapping stubMapping2 = stubMappingForUrl(\"/foo/bar-baz\");\n- StubMapping stubMapping3 = stubMappingForUrl(\"/foo/bar-baz\");\n- SnapshotStubMappingScenarioHandler handler = new SnapshotStubMappingScenarioHandler();\n-\n- handler.trackStubMapping(stubMapping1);\n- handler.trackStubMapping(stubMappingForUrl(\"this stub mapping should be ignored\"));\n- handler.trackStubMapping(stubMapping2);\n- handler.trackStubMapping(stubMapping3);\n-\n- // Check first stub mapping, which should be the start of the scenario\n- assertEquals(\"scenario-foo-bar-baz\", stubMapping1.getScenarioName());\n- assertEquals(Scenario.STARTED, stubMapping1.getRequiredScenarioState());\n- assertNull(stubMapping1.getNewScenarioState());\n-\n- // Check second stub mapping\n- assertEquals(stubMapping1.getScenarioName(), stubMapping2.getScenarioName());\n- assertEquals(Scenario.STARTED, stubMapping2.getRequiredScenarioState());\n- assertEquals(\"scenario-foo-bar-baz-2\", stubMapping2.getNewScenarioState());\n-\n- // Check third stub mapping\n- assertEquals(stubMapping1.getScenarioName(), stubMapping3.getScenarioName());\n- assertEquals(\"scenario-foo-bar-baz-2\", stubMapping3.getRequiredScenarioState());\n- assertEquals(\"scenario-foo-bar-baz-3\", stubMapping3.getNewScenarioState());\n- }\n-\n- private StubMapping stubMappingForUrl(String url) {\n- return new StubMapping(\n- newRequestPattern().withUrl(url).build(),\n- ResponseDefinition.ok()\n- );\n- }\n-}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -7,11 +7,9 @@ import com.github.tomakehurst.wiremock.admin.tasks.SnapshotTask;\nimport com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;\nimport com.github.tomakehurst.wiremock.core.Admin;\nimport com.github.tomakehurst.wiremock.http.*;\n-import com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\nimport com.github.tomakehurst.wiremock.verification.LoggedRequest;\n-import com.github.tomakehurst.wiremock.verification.VerificationResult;\nimport com.toomuchcoding.jsonassert.JsonAssertion;\nimport org.jmock.Expectations;\nimport org.jmock.Mockery;\n@@ -53,7 +51,6 @@ public class SnapshotTaskTest {\ncontext.checking(new Expectations() {{\nexactly(2).of(mockAdmin).addStubMapping(with(any(StubMapping.class)));\n}});\n- setReturnForCountRequestsMatching(1);\n// Check when explicitly set\nJsonAssertion.assertThat(execute(\"{ \\\"persist\\\": true, \\\"outputFormat\\\": \\\"ids\\\"}\"))\n@@ -71,7 +68,6 @@ public class SnapshotTaskTest {\n@Test\npublic void shouldNotPersistWhenSetToFalse() {\nsetServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForCountRequestsMatching(1);\nJsonAssertion.assertThat(executeWithoutPersist())\n.hasSize(1)\n.arrayField()\n@@ -91,10 +87,15 @@ public class SnapshotTaskTest {\n}\n@Test\n- public void returnsEmptyArrayForExistingStubMapping() {\n- setServeEvents(serveEvent(mockRequest(), response(), true));\n- setReturnForCountRequestsMatching(2);\n- assertEquals(\"[ ]\", executeWithoutPersist());\n+ public void returnsSingleStubMappingForRepeatedRequests() {\n+ setServeEvents(\n+ serveEvent(mockRequest().url(\"/foo\"), response(), true),\n+ serveEvent(mockRequest().url(\"/foo\"), response(), true)\n+ );\n+ JsonAssertion.assertThat(executeWithoutPersist())\n+ .hasSize(1)\n+ .arrayField()\n+ .matches(\"[a-z0-9\\\\-]{36}\");\n}\n@Test\n@@ -103,7 +104,6 @@ public class SnapshotTaskTest {\nserveEvent(mockRequest(), response(), true),\nserveEvent(mockRequest().url(\"/foo\"), response(), true)\n);\n- setReturnForCountRequestsMatching(1);\nJsonAssertion.assertThat(executeWithoutPersist())\n.hasSize(2)\n.arrayField();\n@@ -135,13 +135,6 @@ public class SnapshotTaskTest {\n}});\n}\n- private void setReturnForCountRequestsMatching(final int numMatching) {\n- context.checking(new Expectations() {{\n- allowing(mockAdmin).countRequestsMatching(with(any(RequestPattern.class)));\n- will(returnValue(new VerificationResult(numMatching, false)));\n- }});\n- }\n-\nprivate static ServeEvent serveEvent(Request request, Response.Builder responseBuilder, boolean wasProxied) {\nResponseDefinitionBuilder responseDefinition = responseDefinition();\nif (wasProxied) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Complete refactoring for repeated request/scenario handling
686,965
17.06.2017 17:16:00
25,200
462af43dba1162d4e4886f3ef7ccd2179b069905
Make sure proxy server is stopped in SnapshotAcceptanceTest
[ { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "diff": "@@ -20,6 +20,7 @@ import com.github.tomakehurst.wiremock.client.WireMock;\nimport com.github.tomakehurst.wiremock.common.Json;\nimport com.github.tomakehurst.wiremock.testsupport.WireMockResponse;\nimport com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\n+import org.junit.After;\nimport org.junit.Test;\nimport org.skyscreamer.jsonassert.JSONCompareMode;\n@@ -45,6 +46,11 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\nproxyingTestClient = new WireMockTestClient(proxyingService.port());\n}\n+ @After\n+ public void proxyServerShutdown() {\n+ proxyingService.stop();\n+ }\n+\nprivate static final String DEFAULT_SNAPSHOT_RESPONSE =\n\"[ \\n\" +\n\" { \\n\" +\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Make sure proxy server is stopped in SnapshotAcceptanceTest
686,965
17.06.2017 19:02:48
25,200
44634c5f072ecc5c1bf11de530dd3dd5e38c4097
Add StubMappingTransfer extension interface and update snapshot to use it
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -3,8 +3,10 @@ package com.github.tomakehurst.wiremock.admin.model;\nimport com.fasterxml.jackson.annotation.JsonCreator;\nimport com.fasterxml.jackson.annotation.JsonProperty;\nimport com.fasterxml.jackson.databind.JsonNode;\n+import com.github.tomakehurst.wiremock.extension.Parameters;\nimport com.github.tomakehurst.wiremock.matching.MultiValuePattern;\n+import java.util.List;\nimport java.util.Map;\n/**\n@@ -22,6 +24,10 @@ public class SnapshotSpec {\nprivate boolean persist = true;\n// Whether duplicate requests should be recorded as scenarios or just discarded\nprivate boolean repeatsAsScenarios = false;\n+ // Stub mapping transformers\n+ private List<String> transformers;\n+ // Parameters for stub mapping transformers\n+ private Parameters transformerParameters;\n@JsonCreator\npublic SnapshotSpec(\n@@ -30,13 +36,17 @@ public class SnapshotSpec {\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n@JsonProperty(\"outputFormat\") SnapshotOutputFormat outputFormat,\n@JsonProperty(\"persist\") JsonNode persistNode,\n- @JsonProperty(\"repeatsAsScenarios\") JsonNode repeatsNode\n+ @JsonProperty(\"repeatsAsScenarios\") JsonNode repeatsNode,\n+ @JsonProperty(\"transformers\") List<String> transformers,\n+ @JsonProperty(\"transformerParameters\") Parameters transformerParameters\n) {\nthis.filters = filters;\nthis.outputFormat = outputFormat == null ? SnapshotOutputFormat.FULL : outputFormat;\nthis.captureHeaders = new RequestPatternTransformer(captureHeaders);\nthis.persist = persistNode.asBoolean(true);\nthis.repeatsAsScenarios = repeatsNode.asBoolean(false);\n+ this.transformers = transformers;\n+ this.transformerParameters = transformerParameters;\n}\npublic SnapshotSpec() {}\n@@ -50,4 +60,8 @@ public class SnapshotSpec {\npublic boolean shouldPersist() { return persist; }\npublic boolean shouldRecordRepeatsAsScenarios() { return repeatsAsScenarios; }\n+\n+ public List<String> getTransformers() { return transformers; }\n+\n+ public Parameters getTransformerParameters() { return transformerParameters; }\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotStubMappingTransformerRunner.java", "diff": "+package com.github.tomakehurst.wiremock.admin.model;\n+\n+import com.github.tomakehurst.wiremock.common.FileSource;\n+import com.github.tomakehurst.wiremock.extension.Parameters;\n+import com.github.tomakehurst.wiremock.extension.StubMappingTransformer;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.google.common.base.Function;\n+\n+import java.util.List;\n+\n+public class SnapshotStubMappingTransformerRunner implements Function<StubMapping, StubMapping> {\n+ private final FileSource fileSource;\n+ private final Parameters parameters;\n+ private final Iterable<StubMappingTransformer> registeredTransformers;\n+ private final List<String> requestedTransformers;\n+\n+ public SnapshotStubMappingTransformerRunner(Iterable<StubMappingTransformer> registeredTransformers) {\n+ this(registeredTransformers, null, null, null);\n+ }\n+\n+ public SnapshotStubMappingTransformerRunner(\n+ Iterable<StubMappingTransformer> registeredTransformers,\n+ List<String> requestedTransformers,\n+ Parameters parameters,\n+ FileSource fileSource\n+ ) {\n+ this.requestedTransformers = requestedTransformers;\n+ this.registeredTransformers = registeredTransformers;\n+ this.parameters = parameters;\n+ this.fileSource = fileSource;\n+ }\n+\n+ public StubMapping apply(StubMapping stubMapping) {\n+ for (StubMappingTransformer transformer : registeredTransformers) {\n+ if (\n+ transformer.applyGlobally()\n+ || (requestedTransformers != null && requestedTransformers.contains(transformer.getName()))\n+ ) {\n+ stubMapping = transformer.transform(stubMapping, fileSource, parameters);\n+ }\n+ }\n+ return stubMapping;\n+\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/tasks/SnapshotTask.java", "diff": "@@ -4,6 +4,8 @@ import com.github.tomakehurst.wiremock.admin.AdminTask;\nimport com.github.tomakehurst.wiremock.admin.model.*;\nimport com.github.tomakehurst.wiremock.common.Json;\nimport com.github.tomakehurst.wiremock.core.Admin;\n+import com.github.tomakehurst.wiremock.core.Options;\n+import com.github.tomakehurst.wiremock.extension.StubMappingTransformer;\nimport com.github.tomakehurst.wiremock.http.Request;\nimport com.github.tomakehurst.wiremock.http.ResponseDefinition;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\n@@ -40,9 +42,14 @@ public class SnapshotTask implements AdminTask {\nstubMappings = new SnapshotRepeatedRequestHandler(snapshotSpec.shouldRecordRepeatsAsScenarios())\n.processStubMappings(stubMappings);\n+ final SnapshotStubMappingTransformerRunner transformerRunner = getTransformerRunner(\n+ admin.getOptions(),\n+ snapshotSpec\n+ );\nfinal ArrayList<Object> response = new ArrayList<>();\nfor (StubMapping stubMapping : stubMappings) {\n+ stubMapping = transformerRunner.apply(stubMapping);\nif (snapshotSpec.shouldPersist()) {\nstubMapping.setPersistent(true);\nadmin.addStubMapping(stubMapping);\n@@ -53,6 +60,19 @@ public class SnapshotTask implements AdminTask {\nreturn jsonResponse(response.toArray(), HTTP_OK);\n}\n+ private SnapshotStubMappingTransformerRunner getTransformerRunner(Options options, SnapshotSpec snapshotSpec) {\n+ final Iterable<StubMappingTransformer> registeredTransformers = options\n+ .extensionsOfType(StubMappingTransformer.class)\n+ .values();\n+\n+ return new SnapshotStubMappingTransformerRunner(\n+ registeredTransformers,\n+ snapshotSpec.getTransformers(),\n+ snapshotSpec.getTransformerParameters(),\n+ options.filesRoot()\n+ );\n+ }\n+\nprivate Iterable<ServeEvent> filterServeEvents(\nGetServeEventsResult serveEventsResult,\nServeEventRequestFilters snapshotFilters\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/main/java/com/github/tomakehurst/wiremock/extension/StubMappingTransformer.java", "diff": "+package com.github.tomakehurst.wiremock.extension;\n+\n+import com.github.tomakehurst.wiremock.common.FileSource;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+\n+public abstract class StubMappingTransformer implements Extension {\n+ public abstract StubMapping transform(StubMapping stubMapping, FileSource files, Parameters parameters);\n+\n+ public boolean applyGlobally() {\n+ return true;\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotAcceptanceTest.java", "diff": "package com.github.tomakehurst.wiremock;\nimport com.fasterxml.jackson.databind.JsonNode;\n-import com.github.tomakehurst.wiremock.client.WireMock;\nimport com.github.tomakehurst.wiremock.common.Json;\n-import com.github.tomakehurst.wiremock.testsupport.WireMockResponse;\nimport com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\nimport org.junit.After;\nimport org.junit.Test;\n@@ -28,7 +26,6 @@ import static com.github.tomakehurst.wiremock.client.WireMock.*;\nimport static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;\nimport static com.github.tomakehurst.wiremock.testsupport.TestHttpHeader.withHeader;\nimport static com.github.tomakehurst.wiremock.testsupport.WireMatchers.equalToJson;\n-import static java.net.HttpURLConnection.HTTP_OK;\nimport static junit.framework.TestCase.assertFalse;\nimport static org.junit.Assert.assertThat;\n@@ -44,6 +41,7 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\nproxyingService.stubFor(proxyAllTo(\"http://localhost:\" + wireMockServer.port()));\nproxyingTestClient = new WireMockTestClient(proxyingService.port());\n+ wireMockServer.stubFor(any(anyUrl()).willReturn(ok()));\n}\n@After\n@@ -75,13 +73,11 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n@Test\npublic void returnsRequestsWithDefaultOptions() throws Exception {\n- wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n-\nproxyingTestClient.get(\"/foo/bar\", withHeader(\"A\", \"B\"));\nproxyingTestClient.get(\"/foo/bar/baz\", withHeader(\"A\", \"B\"));\nassertThat(\n- snapshot(\"{ \\\"persist\\\": false }\"),\n+ proxyingTestClient.snapshot(\"{ \\\"persist\\\": false }\"),\nequalToJson(DEFAULT_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n@@ -122,8 +118,6 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n@Test\npublic void returnsFilteredRequestsWithJustRequestPatternsAndFullOutputFormat() throws Exception {\n- wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n-\n// Matches both\nproxyingTestClient.get(\"/foo/bar\", withHeader(\"A\", \"B\"));\n// Fails header match\n@@ -136,7 +130,7 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\nproxyingTestClient.get(\"/foo/bar/baz\", withHeader(\"A\", \"B\"));\nassertThat(\n- snapshot(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\n+ proxyingTestClient.snapshot(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_REQUEST),\nequalToJson(FILTER_BY_REQUEST_PATTERN_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n@@ -166,8 +160,6 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n@Test\npublic void returnsFilteredRequestsWithRequestPatternAndIdsWithFullOutputFormat() {\n- wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n-\n// Matches both\nproxyingTestClient.get(\"/foo/bar\");\n// Fails URL match\n@@ -184,12 +176,11 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n);\nassertThat(\n- snapshot(request),\n+ proxyingTestClient.snapshot(request),\nequalToJson(FILTER_BY_REQUEST_PATTERN_AND_IDS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n-\nprivate static final String CAPTURE_HEADERS_SNAPSHOT_REQUEST =\n\"{ \\n\" +\n\" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n@@ -224,15 +215,13 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n@Test\npublic void returnsStubMappingWithCapturedHeaders() {\n- wireMockServer.stubFor(put(anyUrl()).willReturn(ok()));\n-\nproxyingTestClient.put(\"/foo/bar\",\nwithHeader(\"A\", \"B\"),\nwithHeader(\"Accept\", \"B\"),\nwithHeader(\"X-NoMatch\", \"should be ignored\")\n);\n- String actual = snapshot(CAPTURE_HEADERS_SNAPSHOT_REQUEST);\n+ String actual = proxyingTestClient.snapshot(CAPTURE_HEADERS_SNAPSHOT_REQUEST);\nassertThat(actual, equalToJson(CAPTURE_HEADERS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER));\nassertFalse(actual.contains(\"X-NoMatch\"));\n}\n@@ -273,23 +262,13 @@ public class SnapshotAcceptanceTest extends AcceptanceTestBase {\n@Test\npublic void returnsStubMappingsWithScenariosForRepeatedRequests() {\n- wireMockServer.stubFor(get(anyUrl()).willReturn(ok()));\n-\nproxyingTestClient.get(\"/bar/baz\");\nproxyingTestClient.get(\"/foo\");\nproxyingTestClient.get(\"/bar/baz\");\nassertThat(\n- snapshot(REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST),\n+ proxyingTestClient.snapshot(REPEATS_AS_SCENARIOS_SNAPSHOT_REQUEST),\nequalToJson(REPEATS_AS_SCENARIOS_SNAPSHOT_RESPONSE, JSONCompareMode.STRICT_ORDER)\n);\n}\n-\n- private String snapshot(String snapshotSpecJson) {\n- WireMockResponse response = proxyingTestClient.postJson(\"/__admin/recordings/snapshot\", snapshotSpecJson);\n- if (response.statusCode() != HTTP_OK) {\n- throw new RuntimeException(\"Returned status code was \" + response.statusCode());\n- }\n- return response.content();\n- }\n}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/SnapshotTransformerAcceptanceTest.java", "diff": "+/*\n+ * Copyright (C) 2017 Thomas Akehurst\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package com.github.tomakehurst.wiremock;\n+\n+import com.github.tomakehurst.wiremock.client.WireMock;\n+import com.github.tomakehurst.wiremock.common.FileSource;\n+import com.github.tomakehurst.wiremock.extension.Parameters;\n+import com.github.tomakehurst.wiremock.extension.StubMappingTransformer;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;\n+import org.junit.After;\n+import org.junit.Test;\n+import org.skyscreamer.jsonassert.JSONCompareMode;\n+\n+import static com.github.tomakehurst.wiremock.client.WireMock.*;\n+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;\n+import static com.github.tomakehurst.wiremock.testsupport.WireMatchers.equalToJson;\n+import static org.junit.Assert.assertThat;\n+\n+public class SnapshotTransformerAcceptanceTest extends AcceptanceTestBase {\n+ private WireMockServer proxyingService;\n+ private WireMockTestClient proxyingTestClient;\n+\n+ public void proxyServerStart(Class<? extends StubMappingTransformer> ... extensions) {\n+ proxyingService = new WireMockServer(wireMockConfig()\n+ .dynamicPort()\n+ .withRootDirectory(\"src/test/resources/empty\")\n+ .extensions(extensions)\n+ );\n+ proxyingService.start();\n+ proxyingService.stubFor(proxyAllTo(\"http://localhost:\" + wireMockServer.port()));\n+\n+ proxyingTestClient = new WireMockTestClient(proxyingService.port());\n+ wireMockServer.stubFor(any(anyUrl()).willReturn(ok()));\n+ }\n+\n+ @After\n+ public void proxyServerShutdown() {\n+ proxyingService.stop();\n+ }\n+\n+ private static final String GLOBAL_TRANSFORMED_STUB_MAPPING_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\" \\n\" +\n+ \"} \";\n+\n+ private static final String GLOBAL_TRANSFORMED_STUB_MAPPING_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo?transformed=true\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"PUT\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/?transformed=true\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"PUT\\\" \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" ] \";\n+\n+ @Test\n+ public void returnsTransformedStubMappingWithGlobalTransformer() {\n+ proxyServerStart(\n+ GlobalStubMappingTransformer.class,\n+ NonGlobalStubMappingTransformer.class // should ignore this one\n+ );\n+\n+ proxyingTestClient.get(\"/\");\n+ proxyingTestClient.get(\"/foo\");\n+\n+ assertThat(\n+ proxyingTestClient.snapshot(GLOBAL_TRANSFORMED_STUB_MAPPING_REQUEST),\n+ equalToJson(GLOBAL_TRANSFORMED_STUB_MAPPING_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+ private static final String NONGLOBAL_TRANSFORMED_STUB_MAPPING_REQUEST =\n+ \"{ \\n\" +\n+ \" \\\"outputFormat\\\": \\\"full\\\", \\n\" +\n+ \" \\\"persist\\\": \\\"false\\\", \\n\" +\n+ \" \\\"transformers\\\": [ \\n\" +\n+ \" \\\"nonglobal-transformer\\\" \\n\" +\n+ \" ] \\n\" +\n+ \"} \";\n+\n+ private static final String NONGLOBAL_TRANSFORMED_STUB_MAPPING_RESPONSE =\n+ \"[ \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/foo\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\", \\n\" +\n+ \" \\\"headers\\\": { \\n\" +\n+ \" \\\"Accept\\\": { \\n\" +\n+ \" \\\"equalTo\\\": \\\"B\\\" \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" { \\n\" +\n+ \" \\\"request\\\" : { \\n\" +\n+ \" \\\"url\\\" : \\\"/\\\", \\n\" +\n+ \" \\\"method\\\" : \\\"GET\\\", \\n\" +\n+ \" \\\"headers\\\": { \\n\" +\n+ \" \\\"Accept\\\": { \\n\" +\n+ \" \\\"equalTo\\\": \\\"B\\\" \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \" }, \\n\" +\n+ \" \\\"response\\\" : { \\n\" +\n+ \" \\\"status\\\" : 200 \\n\" +\n+ \" } \\n\" +\n+ \" } \\n\" +\n+ \"] \";\n+\n+ @Test\n+ public void returnsTransformedStubMappingWithNonGlobalTransformer() {\n+ proxyServerStart(NonGlobalStubMappingTransformer.class);\n+\n+ proxyingTestClient.get(\"/\");\n+ proxyingTestClient.get(\"/foo\");\n+\n+ assertThat(\n+ proxyingTestClient.snapshot(NONGLOBAL_TRANSFORMED_STUB_MAPPING_REQUEST),\n+ equalToJson(NONGLOBAL_TRANSFORMED_STUB_MAPPING_RESPONSE, JSONCompareMode.STRICT_ORDER)\n+ );\n+ }\n+\n+ public static class GlobalStubMappingTransformer extends StubMappingTransformer {\n+ @Override\n+ public StubMapping transform(StubMapping stubMapping, FileSource files, Parameters parameters) {\n+ return WireMock\n+ .put(urlEqualTo(stubMapping.getRequest().getUrl() + \"?transformed=true\"))\n+ .build();\n+ }\n+\n+ @Override\n+ public String getName() {\n+ return \"stub-transformer\";\n+ }\n+ }\n+\n+ public static class NonGlobalStubMappingTransformer extends StubMappingTransformer {\n+ @Override\n+ public StubMapping transform(StubMapping stubMapping, FileSource files, Parameters parameters) {\n+ return WireMock\n+ .request(\"GET\", stubMapping.getRequest().getUrlMatcher())\n+ .withHeader(\"Accept\", equalTo(\"B\"))\n+ .build();\n+ }\n+\n+ @Override\n+ public boolean applyGlobally() {\n+ return false;\n+ }\n+\n+ @Override\n+ public String getName() {\n+ return \"nonglobal-transformer\";\n+ }\n+ }\n+}\n" }, { "change_type": "ADD", "old_path": null, "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotStubMappingTransformerRunnerTest.java", "diff": "+package com.github.tomakehurst.wiremock.admin;\n+\n+import com.github.tomakehurst.wiremock.admin.model.SnapshotStubMappingTransformerRunner;\n+import com.github.tomakehurst.wiremock.client.WireMock;\n+import com.github.tomakehurst.wiremock.common.FileSource;\n+import com.github.tomakehurst.wiremock.extension.Parameters;\n+import com.github.tomakehurst.wiremock.extension.StubMappingTransformer;\n+import com.github.tomakehurst.wiremock.http.ResponseDefinition;\n+import com.github.tomakehurst.wiremock.stubbing.StubMapping;\n+import com.google.common.collect.Lists;\n+import org.junit.Test;\n+\n+import java.util.ArrayList;\n+\n+import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo;\n+import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.newRequestPattern;\n+import static org.junit.Assert.assertEquals;\n+\n+public class SnapshotStubMappingTransformerRunnerTest {\n+ @Test\n+ public void applyWithNoTransformers() {\n+ StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n+ StubMapping result = new SnapshotStubMappingTransformerRunner(\n+ new ArrayList<StubMappingTransformer>()\n+ ).apply(stubMapping);\n+ assertEquals(stubMapping, result);\n+ }\n+\n+ @Test\n+ public void applyWithUnregisteredNonGlobalTransformer() {\n+ StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n+\n+ // Should not apply the transformer as it isn't registered\n+ StubMapping result = new SnapshotStubMappingTransformerRunner(\n+ Lists.<StubMappingTransformer>newArrayList(new NonGlobalStubMappingTransformer())\n+ ).apply(stubMapping);\n+\n+ assertEquals(stubMapping, result);\n+ }\n+\n+ @Test\n+ public void applyWithRegisteredNonGlobalTransformer() {\n+ StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n+\n+ StubMapping result = new SnapshotStubMappingTransformerRunner(\n+ Lists.<StubMappingTransformer>newArrayList(new NonGlobalStubMappingTransformer()),\n+ Lists.newArrayList(\"nonglobal-transformer\"),\n+ null,\n+ null\n+ ).apply(stubMapping);\n+\n+ assertEquals(\"/foo?transformed=nonglobal\", result.getRequest().getUrl());\n+ }\n+\n+ @Test\n+ public void applyWithGlobalTransformer() {\n+ StubMapping stubMapping = stubMappingForUrl(\"/foo\");\n+\n+ StubMapping result = new SnapshotStubMappingTransformerRunner(\n+ Lists.<StubMappingTransformer>newArrayList(new GlobalStubMappingTransformer())\n+ ).apply(stubMapping);\n+\n+ assertEquals(\"/foo?transformed=global\", result.getRequest().getUrl());\n+ }\n+\n+ public static class GlobalStubMappingTransformer extends StubMappingTransformer {\n+ @Override\n+ public StubMapping transform(StubMapping stubMapping, FileSource files, Parameters parameters) {\n+ return WireMock\n+ .get(urlEqualTo(stubMapping.getRequest().getUrl() + \"?transformed=global\"))\n+ .build();\n+ }\n+\n+ @Override\n+ public String getName() {\n+ return \"stub-transformer\";\n+ }\n+ }\n+\n+ public static class NonGlobalStubMappingTransformer extends StubMappingTransformer {\n+ @Override\n+ public StubMapping transform(StubMapping stubMapping, FileSource files, Parameters parameters) {\n+ return WireMock\n+ .get(urlEqualTo(stubMapping.getRequest().getUrl() + \"?transformed=nonglobal\"))\n+ .build();\n+ }\n+\n+ @Override\n+ public boolean applyGlobally() {\n+ return false;\n+ }\n+\n+ @Override\n+ public String getName() {\n+ return \"nonglobal-transformer\";\n+ }\n+ }\n+\n+ private StubMapping stubMappingForUrl(String url) {\n+ return new StubMapping(\n+ newRequestPattern().withUrl(url).build(),\n+ ResponseDefinition.ok()\n+ );\n+ }\n+}\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/admin/SnapshotTaskTest.java", "diff": "@@ -6,6 +6,7 @@ import com.github.tomakehurst.wiremock.admin.model.PathParams;\nimport com.github.tomakehurst.wiremock.admin.tasks.SnapshotTask;\nimport com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder;\nimport com.github.tomakehurst.wiremock.core.Admin;\n+import com.github.tomakehurst.wiremock.core.WireMockConfiguration;\nimport com.github.tomakehurst.wiremock.http.*;\nimport com.github.tomakehurst.wiremock.stubbing.ServeEvent;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\n@@ -22,6 +23,7 @@ import java.util.Arrays;\nimport java.util.UUID;\nimport static com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder.responseDefinition;\n+import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;\nimport static com.github.tomakehurst.wiremock.http.RequestMethod.GET;\nimport static com.github.tomakehurst.wiremock.http.Response.response;\nimport static com.github.tomakehurst.wiremock.matching.MockRequest.mockRequest;\n@@ -41,6 +43,7 @@ public class SnapshotTaskTest {\n@Test\npublic void persistsStubMappingWhenPersistSet() {\n+ withOptions(wireMockConfig());\nsetServeEvents(\nserveEvent(\nmockRequest().url(\"/foo\").method(GET),\n@@ -67,6 +70,7 @@ public class SnapshotTaskTest {\n@Test\npublic void shouldNotPersistWhenSetToFalse() {\n+ withOptions(wireMockConfig());\nsetServeEvents(serveEvent(mockRequest(), response(), true));\nJsonAssertion.assertThat(executeWithoutPersist())\n.hasSize(1)\n@@ -76,18 +80,21 @@ public class SnapshotTaskTest {\n@Test\npublic void returnsEmptyArrayWithNoServeEvents() {\n+ withOptions(wireMockConfig());\nsetServeEvents();\nassertEquals(\"[ ]\", executeWithoutPersist());\n}\n@Test\npublic void returnsEmptyArrayWithUnproxiedServeEvent() {\n+ withOptions(wireMockConfig());\nsetServeEvents(serveEvent(mockRequest(), response(), false));\nassertEquals(\"[ ]\", executeWithoutPersist());\n}\n@Test\npublic void returnsSingleStubMappingForRepeatedRequests() {\n+ withOptions(wireMockConfig());\nsetServeEvents(\nserveEvent(mockRequest().url(\"/foo\"), response(), true),\nserveEvent(mockRequest().url(\"/foo\"), response(), true)\n@@ -100,6 +107,7 @@ public class SnapshotTaskTest {\n@Test\npublic void returnsTwoMappingsForTwoServeEvents() {\n+ withOptions(wireMockConfig());\nsetServeEvents(\nserveEvent(mockRequest(), response(), true),\nserveEvent(mockRequest().url(\"/foo\"), response(), true)\n@@ -135,6 +143,12 @@ public class SnapshotTaskTest {\n}});\n}\n+ private void withOptions(final WireMockConfiguration options) {\n+ context.checking(new Expectations() {{\n+ allowing(mockAdmin).getOptions(); will(returnValue(options));\n+ }});\n+ }\n+\nprivate static ServeEvent serveEvent(Request request, Response.Builder responseBuilder, boolean wasProxied) {\nResponseDefinitionBuilder responseDefinition = responseDefinition();\nif (wasProxied) {\n" }, { "change_type": "MODIFY", "old_path": "src/test/java/com/github/tomakehurst/wiremock/testsupport/WireMockTestClient.java", "new_path": "src/test/java/com/github/tomakehurst/wiremock/testsupport/WireMockTestClient.java", "diff": "@@ -55,6 +55,7 @@ public class WireMockTestClient {\nprivate static final String LOCAL_WIREMOCK_EDIT_RESPONSE_URL = \"http://%s:%d/__admin/mappings/edit\";\nprivate static final String LOCAL_WIREMOCK_RESET_URL = \"http://%s:%d/__admin/reset\";\nprivate static final String LOCAL_WIREMOCK_RESET_DEFAULT_MAPPINS_URL = \"http://%s:%d/__admin/mappings/reset\";\n+ private static final String LOCAL_WIREMOCK_SNAPSHOT_PATH = \"/__admin/recordings/snapshot\";\nprivate int port;\nprivate String address;\n@@ -205,6 +206,14 @@ public class WireMockTestClient {\n}\n}\n+ public String snapshot(String snapshotSpecJson) {\n+ WireMockResponse response = postJson(LOCAL_WIREMOCK_SNAPSHOT_PATH, snapshotSpecJson);\n+ if (response.statusCode() != HTTP_OK) {\n+ throw new RuntimeException(\"Returned status code was \" + response.statusCode());\n+ }\n+ return response.content();\n+ }\n+\nprivate int postJsonAndReturnStatus(String url, String json) {\nHttpPost post = new HttpPost(url);\ntry {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Add StubMappingTransfer extension interface and update snapshot to use it
686,965
17.06.2017 20:03:25
25,200
2be25f76c0870674a54d30739a815738ecdd82f6
Remove sortFields argument to SnapshotSpec that I forgot about
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotSpec.java", "diff": "@@ -32,7 +32,6 @@ public class SnapshotSpec {\n@JsonCreator\npublic SnapshotSpec(\n@JsonProperty(\"filters\") ServeEventRequestFilters filters ,\n- @JsonProperty(\"sortFields\") String[] sortFields,\n@JsonProperty(\"captureHeaders\") Map<String, MultiValuePattern> captureHeaders,\n@JsonProperty(\"outputFormat\") SnapshotOutputFormat outputFormat,\n@JsonProperty(\"persist\") JsonNode persistNode,\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Remove sortFields argument to SnapshotSpec that I forgot about
686,965
17.06.2017 21:13:54
25,200
056016f9261cb65568ef50dc6bcd6b3a4916768e
Moving some logic over to UniqueFilenameGenerator
[ { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotRepeatedRequestHandler.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/admin/model/SnapshotRepeatedRequestHandler.java", "diff": "package com.github.tomakehurst.wiremock.admin.model;\n+import com.github.tomakehurst.wiremock.common.UniqueFilenameGenerator;\nimport com.github.tomakehurst.wiremock.matching.RequestPattern;\nimport com.github.tomakehurst.wiremock.stubbing.Scenario;\nimport com.github.tomakehurst.wiremock.stubbing.StubMapping;\n-import com.google.common.base.Joiner;\n-import com.google.common.base.Splitter;\n-import com.google.common.collect.Iterables;\n-import java.net.URI;\nimport java.util.ArrayList;\nimport java.util.HashMap;\nimport java.util.List;\n@@ -54,7 +51,9 @@ public class SnapshotRepeatedRequestHandler {\nprivate void setScenarioDetailsIfApplicable(StubMapping stubMapping, StubMappingTracker tracker) {\nif (tracker.count == 2) {\n// We have multiple identical requests. Go back and make previous stub the start\n- String name = generateScenarioName(stubMapping.getRequest());\n+ String name = SCENARIO_NAME_PREFIX + \"-\" + UniqueFilenameGenerator.urlToPathParts(\n+ stubMapping.getRequest().getUrl()\n+ );\ntracker.previousStubMapping.setScenarioName(name);\ntracker.previousStubMapping.setRequiredScenarioState(Scenario.STARTED);\nstubMapping.setRequiredScenarioState(Scenario.STARTED);\n@@ -68,39 +67,6 @@ public class SnapshotRepeatedRequestHandler {\nstubMapping.setNewScenarioState(name + \"-\" + tracker.count);\n}\n- /**\n- * Generates a scenario name from the request. Based on UniqueFilenameGenerator\n- *\n- * @TODO Use a better name generator\n- * @param request A RequestPattern from a StubMapping\n- * @return Scenario name as a string\n- */\n- private String generateScenarioName(RequestPattern request) {\n- final URI uri = URI.create(request.getUrl());\n- final Iterable<String> uriPathNodes = Splitter\n- .on(\"/\")\n- .omitEmptyStrings()\n- .split(uri.getPath());\n-\n- final int nodeCount = Iterables.size(uriPathNodes);\n-\n- String pathPart = \"(root)\";\n- if (nodeCount > 0) {\n- pathPart = Joiner\n- .on(\"-\")\n- .join(\n- Iterables.skip(uriPathNodes, nodeCount - min(nodeCount, 2))\n- );\n- pathPart = sanitise(pathPart);\n- }\n-\n- return SCENARIO_NAME_PREFIX + \"-\" + pathPart;\n- }\n-\n- private static String sanitise(String input) {\n- return input.replaceAll(\"[,~:/?#\\\\[\\\\]@!\\\\$&'()*+;=]\", \"_\");\n- }\n-\n/**\n* Simple container class to store the previous stub mapping and sequence count for building scenarios\n*/\n" }, { "change_type": "MODIFY", "old_path": "src/main/java/com/github/tomakehurst/wiremock/common/UniqueFilenameGenerator.java", "new_path": "src/main/java/com/github/tomakehurst/wiremock/common/UniqueFilenameGenerator.java", "diff": "@@ -32,11 +32,24 @@ public class UniqueFilenameGenerator {\n}\npublic static String generate(Request request, String prefix, String id, String extension) {\n- URI uri = URI.create(request.getUrl());\n+ String pathPart = urlToPathParts(request.getUrl());\n+\n+ return new StringBuilder(prefix)\n+ .append(\"-\")\n+ .append(pathPart)\n+ .append(\"-\")\n+ .append(id)\n+ .append(\".\")\n+ .append(extension)\n+ .toString();\n+ }\n+\n+ public static String urlToPathParts(String url) {\n+ URI uri = URI.create(url);\nIterable<String> uriPathNodes = on(\"/\").omitEmptyStrings().split(uri.getPath());\nint nodeCount = size(uriPathNodes);\n- String pathPart = nodeCount > 0 ?\n+ return nodeCount > 0 ?\nsanitise(\nJoiner.on(\"-\")\n.join(from(uriPathNodes)\n@@ -44,16 +57,6 @@ public class UniqueFilenameGenerator {\n)\n):\n\"(root)\";\n-\n-\n- return new StringBuilder(prefix)\n- .append(\"-\")\n- .append(pathPart)\n- .append(\"-\")\n- .append(id)\n- .append(\".\")\n- .append(extension)\n- .toString();\n}\nprivate static String sanitise(String input) {\n" } ]
Java
Apache License 2.0
tomakehurst/wiremock
Moving some logic over to UniqueFilenameGenerator