@backstage/plugin-techdocs-node 1.12.5-next.3 → 1.12.6

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/plugin-techdocs-node
 
+## 1.12.6
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.23.1
+  - @backstage/backend-plugin-api@0.6.20
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration@1.12.0
+  - @backstage/integration-aws-node@0.1.12
+  - @backstage/plugin-search-common@1.2.12
+
+## 1.12.5
+
+### Patch Changes
+
+- e64bfb2: Allow defining custom build log transport for techdocs builder
+- 48c38f0: `TechdocsGenerator` won't require a `containerRunner` option anymore for generating TechDocs in docker.
+- d44a20a: Added additional plugin metadata to `package.json`.
+- 5db7536: Updated `getRepoUrlFromLocationAnnotation` to check for Harness SCM integration
+- Updated dependencies
+  - @backstage/backend-common@0.23.0
+  - @backstage/backend-plugin-api@0.6.19
+  - @backstage/integration@1.12.0
+  - @backstage/plugin-search-common@1.2.12
+  - @backstage/catalog-model@1.5.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/integration-aws-node@0.1.12
+
 ## 1.12.5-next.3
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -13,6 +13,8 @@ var catalogModel = require('@backstage/catalog-model');
 var mime = require('mime-types');
 var createLimiter = require('p-limit');
 var recursiveReadDir = require('recursive-readdir');
+var Docker = require('dockerode');
+var util = require('util');
 var integrationAwsNode = require('@backstage/integration-aws-node');
 var clientS3 = require('@aws-sdk/client-s3');
 var credentialProviders = require('@aws-sdk/credential-providers');
@@ -37,6 +39,7 @@ var yaml__default = /*#__PURE__*/_interopDefaultCompat(yaml);
 var mime__default = /*#__PURE__*/_interopDefaultCompat(mime);
 var createLimiter__default = /*#__PURE__*/_interopDefaultCompat(createLimiter);
 var recursiveReadDir__default = /*#__PURE__*/_interopDefaultCompat(recursiveReadDir);
+var Docker__default = /*#__PURE__*/_interopDefaultCompat(Docker);
 var JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
 var express__default = /*#__PURE__*/_interopDefaultCompat(express);
 var os__default = /*#__PURE__*/_interopDefaultCompat(os);
@@ -158,7 +161,9 @@ const getRepoUrlFromLocationAnnotation = (parsedLocationAnnotation, scmIntegrati
   const { type: locationType, target } = parsedLocationAnnotation;
   if (locationType === "url") {
     const integration = scmIntegrations.byUrl(target);
-    if (integration && ["github", "gitlab", "bitbucketServer"].includes(integration.type)) {
+    if (integration && ["github", "gitlab", "bitbucketServer", "harness"].includes(
+      integration.type
+    )) {
       const { filepathtype } = gitUrlParse__default.default(target);
       if (filepathtype === "") {
         return { repo_url: target };
@@ -429,6 +434,84 @@ const patchMkdocsYmlWithPlugins = async (mkdocsYmlPath, logger, defaultPlugins =
   });
 };
 
+const pipeline = util.promisify(stream.pipeline);
+class DockerContainerRunner {
+  dockerClient;
+  constructor() {
+    this.dockerClient = new Docker__default.default();
+  }
+  async runContainer(options) {
+    const {
+      imageName,
+      command,
+      args,
+      logStream = new stream.PassThrough(),
+      mountDirs = {},
+      workingDir,
+      envVars = {},
+      pullImage = true,
+      defaultUser = false
+    } = options;
+    try {
+      await this.dockerClient.ping();
+    } catch (e) {
+      throw new errors.ForwardedError(
+        "This operation requires Docker. Docker does not appear to be available. Docker.ping() failed with",
+        e
+      );
+    }
+    if (pullImage) {
+      await new Promise((resolve, reject) => {
+        this.dockerClient.pull(imageName, {}, (err, stream) => {
+          if (err) {
+            reject(err);
+            return;
+          }
+          pipeline(stream, logStream, { end: false }).then(resolve).catch(reject);
+        });
+      });
+    }
+    const userOptions = {};
+    if (!defaultUser && process.getuid && process.getgid) {
+      userOptions.User = `${process.getuid()}:${process.getgid()}`;
+    }
+    const Volumes = {};
+    for (const containerDir of Object.values(mountDirs)) {
+      Volumes[containerDir] = {};
+    }
+    const Binds = [];
+    for (const [hostDir, containerDir] of Object.entries(mountDirs)) {
+      const realHostDir = await fs__default.default.realpath(hostDir);
+      Binds.push(`${realHostDir}:${containerDir}`);
+    }
+    const Env = [];
+    for (const [key, value] of Object.entries(envVars)) {
+      Env.push(`${key}=${value}`);
+    }
+    const [{ Error: error, StatusCode: statusCode }] = await this.dockerClient.run(imageName, args, logStream, {
+      Volumes,
+      HostConfig: {
+        AutoRemove: true,
+        Binds
+      },
+      ...workingDir ? { WorkingDir: workingDir } : {},
+      Entrypoint: command,
+      Env,
+      ...userOptions
+    });
+    if (error) {
+      throw new Error(
+        `Docker failed to run with the following error message: ${error}`
+      );
+    }
+    if (statusCode !== 0) {
+      throw new Error(
+        `Docker container returned a non-zero exit code (${statusCode})`
+      );
+    }
+  }
+}
+
 class TechdocsGenerator {
   /**
    * The default docker image (and version) used to generate content. Public
@@ -512,13 +595,9 @@ class TechdocsGenerator {
             `Successfully generated docs from ${inputDir} into ${outputDir} using local mkdocs`
           );
           break;
-        case "docker":
-          if (this.containerRunner === void 0) {
-            throw new Error(
-              "Invalid state: containerRunner cannot be undefined when runIn is 'docker'"
-            );
-          }
-          await this.containerRunner.runContainer({
+        case "docker": {
+          const containerRunner = this.containerRunner || new DockerContainerRunner();
+          await containerRunner.runContainer({
             imageName: this.options.dockerImage ?? TechdocsGenerator.defaultDockerImage,
             args: ["build", "-d", "/output"],
             logStream,
@@ -534,6 +613,7 @@ class TechdocsGenerator {
             `Successfully generated docs from ${inputDir} into ${outputDir} using techdocs-container`
           );
           break;
+        }
         default:
           throw new Error(
             `Invalid config value "${this.options.runIn}" provided in 'techdocs.generators.techdocs'.`