docker-storage-gc 3.5.3 → 3.5.4

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,27 @@
+- commits:
+    - subject: Run tests using dind to avoid interactions with existing images
+      hash: ee161f87df98729d935c47c7c2a9f20d72a39e46
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+    - subject: Only default the mtime to "now" for unrecognized images rather than old
+      hash: 134083f6655449470bc92438a94e79b11b6c1461
+      body: |
+        This avoids issues where images that existed before the garbage
+        collector was attached would always have their mtime set to "now" and
+        be avoided for removal. Instead we now only do it for images we haven't
+        seen which should only be the case for newly added images which haven't
+        yet had an mtime added but shortly will do, in which case `now` is a
+        good approximation
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+  version: 3.5.4
+  title: ""
+  date: 2023-08-01T13:38:01.904Z
 - commits:
     - subject: Add typings
       hash: 15a645990da1f763088a843c9a8876b4b5cddff8
@@ -8,7 +32,7 @@
       author: Pagan Gazzard
   version: 3.5.3
   title: ""
-  date: 2023-03-27T16:33:41.726Z
+  date: 2023-03-27T16:36:50.392Z
 - commits:
     - subject: Replace balenaCI with flowzone
       hash: 1f5029fed1b1d7713665274949f2c8badb6d4f0f

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# v3.5.4
+## (2023-08-01)
+
+* Run tests using dind to avoid interactions with existing images [Pagan Gazzard]
+* Only default the mtime to "now" for unrecognized images rather than old [Pagan Gazzard]
+
 # v3.5.3
 ## (2023-03-27)
 

package/build/docker-event-stream.js

@@ -19,11 +19,9 @@
     }).then(function(images) {
       var i, image, layer_mtimes, len;
       layer_mtimes = {};
-      if (!process.env.LOCAL_TESTS) {
-        for (i = 0, len = images.length; i < len; i++) {
-          image = images[i];
-          layer_mtimes[image.Id] = 0;
-        }
+      for (i = 0, len = images.length; i < len; i++) {
+        image = images[i];
+        layer_mtimes[image.Id] = 0;
       }
       return es.pipeline(JSONStream.parse(), es.mapSync(function(arg) {
         var from, id, status, timeNano;

package/build/docker-image-tree.js

@@ -50,7 +50,7 @@
   };
 
   exports.createTree = createTree = function(images, containers, layer_mtimes) {
-    var i, image, len, name, node, now, parent, parentId, root, tree, usedImageIds;
+    var i, image, len, name, node, now, parent, parentId, ref, root, tree, usedImageIds;
     now = Date.now() * Math.pow(10, 6);
     usedImageIds = new Set(_(containers).map('ImageID'));
     tree = {};
@@ -63,7 +63,7 @@
       node.repoTags = saneRepoAttrs(image.RepoTags);
       node.repoDigests = saneRepoAttrs(image.RepoDigests);
       node.size = image.Size;
-      node.mtime = getMtime(node, layer_mtimes) || now;
+      node.mtime = (ref = getMtime(node, layer_mtimes)) != null ? ref : now;
       node.isUsedByAContainer = usedImageIds.has(image.Id);
       parent.children[image.Id] = node;
     }

package/build/docker.js

@@ -15,35 +15,13 @@
   url = require('url');
 
   getDockerConnectOpts = function(hostObj) {
-    var certs;
     if (!_.isEmpty(hostObj)) {
       return Promise.resolve(hostObj);
     }
-    if (process.env.CIRCLECI != null) {
-      certs = ['ca.pem', 'cert.pem', 'key.pem'].map(function(file) {
-        return path.join(process.env.DOCKER_CERT_PATH, file);
-      });
-      return Promise.map(certs, function(c) {
-        return fs.readFile(c, 'utf-8');
-      }).then(function(arg) {
-        var ca, cert, key, parsed;
-        ca = arg[0], cert = arg[1], key = arg[2];
-        parsed = url.parse(process.env.DOCKER_HOST);
-        return {
-          host: 'https://' + parsed.hostname,
-          port: parsed.port,
-          ca: ca,
-          cert: cert,
-          key: key,
-          Promise: Promise
-        };
-      });
-    } else {
-      return Promise.resolve({
-        socketPath: '/var/run/docker.sock',
-        Promise: Promise
-      });
-    }
+    return Promise.resolve({
+      socketPath: '/var/run/docker.sock',
+      Promise: Promise
+    });
   };
 
   exports.getDocker = function(hostObj) {

package/lib/docker-event-stream.coffee

@@ -17,12 +17,8 @@ exports.parseEventStream = parseEventStream = (docker) ->
 		# If we've never seen the layer used then it's likely created before we started
 		# listening and so set the last used time to 0 as we know it should be older than
 		# anything we've seen
-		#
-		# Disable this behaviour for local testing, otherwise the GC will try to remove already
-		# existing images and the tests will break
-		if ! process.env.LOCAL_TESTS
-			for image in images
-				layer_mtimes[image.Id] = 0
+		for image in images
+			layer_mtimes[image.Id] = 0
 
 		return es.pipeline(
 			JSONStream.parse()

package/lib/docker-image-tree.coffee

@@ -37,7 +37,9 @@ exports.createTree = createTree = (images, containers, layer_mtimes) ->
 		node.repoTags = saneRepoAttrs(image.RepoTags)
 		node.repoDigests = saneRepoAttrs(image.RepoDigests)
 		node.size = image.Size
-		node.mtime = getMtime(node, layer_mtimes) or now
+		# If we haven't seen the image at all then assume it is brand new and default it's
+		# mtime to `now` to avoid removing it
+		node.mtime = getMtime(node, layer_mtimes) ? now
 		node.isUsedByAContainer = usedImageIds.has(image.Id)
 		parent.children[image.Id] = node
 

package/lib/docker.coffee

@@ -6,28 +6,9 @@ fs = require 'mz/fs'
 url = require 'url'
 
 getDockerConnectOpts = (hostObj) ->
-
-	return Promise.resolve(hostObj) if !_.isEmpty(hostObj)
-
-	# Detect circleCi build
-	if process.env.CIRCLECI?
-		certs = ['ca.pem', 'cert.pem', 'key.pem'].map((file) -> path.join(process.env.DOCKER_CERT_PATH, file))
-
-		Promise.map(certs, (c) -> fs.readFile(c, 'utf-8'))
-		.then ([ca, cert, key]) ->
-
-			parsed = url.parse(process.env.DOCKER_HOST)
-
-			return {
-				host: 'https://' + parsed.hostname
-				port: parsed.port
-				ca
-				cert
-				key
-				Promise
-			}
-	else
-		return Promise.resolve({ socketPath: '/var/run/docker.sock', Promise })
+	if !_.isEmpty(hostObj)
+		return Promise.resolve(hostObj)
+	return Promise.resolve({ socketPath: '/var/run/docker.sock', Promise })
 
 exports.getDocker = (hostObj) ->
 	getDockerConnectOpts(hostObj)

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "docker-storage-gc",
-  "version": "3.5.3",
+  "version": "3.5.4",
   "main": "build/index.js",
   "types": "index.d.ts",
   "scripts": {
     "lint": "resin-lint lib test tools",
-    "pretest": "npm run lint",
+    "pretest": "npm run lint && docker rm -vf docker-storage-gc-tests && docker run --privileged --name docker-storage-gc-tests -v /tmp/dind:/var/run/ -d docker:24.0.5-dind && sleep 5 && docker exec docker-storage-gc-tests chown $(id -u) /var/run/docker.sock",
     "test": "mocha --compilers coffee:coffee-script/register test",
-    "test:local": "LOCAL_TESTS=true npm test",
+    "posttest": "docker rm -vf docker-storage-gc-tests",
     "prepare": "coffee -o build -c lib"
   },
   "author": "",
@@ -33,6 +33,6 @@
     "timekeeper": "0.0.5"
   },
   "versionist": {
-    "publishedAt": "2023-03-27T16:33:41.957Z"
+    "publishedAt": "2023-08-01T13:38:02.081Z"
   }
 }

package/test/index.coffee

@@ -32,8 +32,14 @@ describe 'Garbage collection', ->
 		@dockerStorage = new DockerGC()
 		# Use either local or CI docker
 		Promise.join(
-			dockerUtils.getDocker({})
-			@dockerStorage.setDocker({})
+			dockerUtils.getDocker({
+				socketPath: '/tmp/dind/docker.sock',
+				Promise,
+			})
+			@dockerStorage.setDocker({
+				socketPath: '/tmp/dind/docker.sock',
+				Promise,
+			})
 			(docker) =>
 				@dockerStorage.setupMtimeStream()
 				@docker = docker
@@ -57,7 +63,7 @@ describe 'Garbage collection', ->
 		.then ->
 			dockerStorage.garbageCollect(1)
 		.then ->
-			promiseToBool(docker.getImage(NONE_TAG_IMAGES[0]).inspect())
+			promiseToBool(docker.getImage(IMAGES[0]).inspect())
 		.then (image_found) ->
 			expect(image_found).to.be.false
 
@@ -68,7 +74,7 @@ describe 'Garbage collection', ->
 
 		pullAsync(docker, NONE_TAG_IMAGES[0])
 		.then ->
-			docker.getImage(NONE_TAG_IMAGES[0])	.inspect()
+			docker.getImage(NONE_TAG_IMAGES[0]).inspect()
 		.then ->
 			dockerStorage.garbageCollect(1)
 		.then ->
@@ -84,7 +90,7 @@ describe 'Garbage collection', ->
 		Promise.each NONE_TAG_IMAGES, (image) ->
 			pullAsync(docker, image)
 		.then ->
-			docker.getImage(NONE_TAG_IMAGES[0])	.inspect()
+			docker.getImage(NONE_TAG_IMAGES[0]).inspect()
 		.then ->
 			dockerStorage.garbageCollect(1)
 		.then ->