libdragon 11.0.1 → 11.0.3

package/modules/actions/destroy.js

@@ -1,7 +1,7 @@
 const fs = require('fs/promises');
 const path = require('path');
 
-const { destroyContainer } = require('./utils');
+const { destroyContainer } = require('../utils');
 const { CONFIG_FILE, LIBDRAGON_PROJECT_MANIFEST } = require('../constants');
 const { fileExists, dirExists, log, ValidationError } = require('../helpers');
 const chalk = require('chalk');

package/modules/actions/exec.js

@@ -13,8 +13,8 @@ const {
 } = require('../helpers');
 
 const { start } = require('./start');
-const { dockerHostUserParams } = require('./docker-utils');
-const { installDependencies } = require('./utils');
+const { dockerHostUserParams } = require('../docker-utils');
+const { installDependencies } = require('../utils');
 
 /**
  * @param {import('../project-info').LibdragonInfo} libdragonInfo

package/modules/actions/init.js

@@ -10,7 +10,8 @@ const {
   updateImage,
   runGitMaybeHost,
   destroyContainer,
-} = require('./utils');
+  ensureGit,
+} = require('../utils');
 
 const {
   LIBDRAGON_PROJECT_MANIFEST,
@@ -109,9 +110,8 @@ const autoVendor = async (info) => {
   }
 
   // Container re-init breaks file modes assume there is git for this case.
-  // TODO: we should remove the unnecessary inits in the future.
   if (!process.env.DOCKER_CONTAINER) {
-    await runGitMaybeHost(info, ['init']);
+    await ensureGit(info);
   }
 
   // TODO: TS thinks this is already defined
@@ -172,6 +172,8 @@ const autoVendor = async (info) => {
       // This will throw if git user name/email is not set up. Let's not assume
       // anything for now. This means subtree is not supported for someone without
       // git on the host machine.
+      // TODO: this is probably creating an unnecessary commit for someone who
+      // just created a git repo and knows what they are doing.
       await runGitMaybeHost(info, [
         'commit',
         '--allow-empty',
@@ -262,6 +264,7 @@ async function init(info) {
     // We have created a new container, save the new info ASAP
     // When in a container, we should already have git
     // Re-initing breaks file modes anyways
+    // TODO: if this fails, we leave the project in a bad state
     await initGitAndCacheContainerId(
       /** @type Parameters<initGitAndCacheContainerId>[0] */ (info)
     );
@@ -289,7 +292,7 @@ module.exports = /** @type {const} */ ({
   usage: {
     name: 'init',
     summary: 'Create a libdragon project in the current directory.',
-    description: `Creates a libdragon project in the current directory. Every libdragon project will have its own docker container instance. If you are in a git repository or an NPM project, libdragon will be initialized at their root also marking there with a \`.libdragon\` folder. Do not remove the \`.libdragon\` folder and commit its contents if you are using source control, as it keeps persistent libdragon project information.
+    description: `Creates a libdragon project in the current directory. Every libdragon project will have its own docker container instance. If you are in a git repository or an NPM project, libdragon will be initialized at their root also marking there with a \`.libdragon\` folder. When running in a submodule, initializion will take place at that level rather than the superproject. Do not remove the \`.libdragon\` folder and commit its contents if you are using source control, as it keeps persistent libdragon project information.
 
     By default, a git repository and a submodule at \`./libdragon\` will be created to automatically update the vendored libdragon files on subsequent \`update\`s. If you intend to opt-out from this feature, see the \`--strategy manual\` flag to provide your self-managed libdragon copy. The default behaviour is intended for users who primarily want to consume libdragon as is.
 

package/modules/actions/install.js

@@ -1,4 +1,4 @@
-const { installDependencies } = require('./utils');
+const { installDependencies } = require('../utils');
 const { start } = require('./start');
 
 /**

package/modules/actions/start.js

@@ -14,7 +14,7 @@ const {
   checkContainerAndClean,
   checkContainerRunning,
   destroyContainer,
-} = require('./utils');
+} = require('../utils');
 
 /**
  * Create a new container

package/modules/actions/stop.js

@@ -1,6 +1,6 @@
 const { spawnProcess, ValidationError } = require('../helpers');
 
-const { checkContainerRunning } = require('./utils');
+const { checkContainerRunning } = require('../utils');
 
 /**
  * @param {import('../project-info').LibdragonInfo} libdragonInfo

package/modules/actions/update.js

@@ -5,7 +5,7 @@ const {
   installDependencies,
   updateImage,
   destroyContainer,
-} = require('./utils');
+} = require('../utils');
 const { start } = require('./start');
 
 /**

package/modules/{actions/docker-utils.js → docker-utils.js}

@@ -1,6 +1,6 @@
 /**
  *
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  */
 function dockerHostUserParams(libdragonInfo) {
   const { uid, gid } = libdragonInfo.userInfo;

package/modules/{actions/npm-utils.js → npm-utils.js}

@@ -5,14 +5,14 @@ const _ = require('lodash');
 
 const { dockerHostUserParams } = require('./docker-utils');
 
-const { CONTAINER_TARGET_PATH } = require('../constants');
+const { CONTAINER_TARGET_PATH } = require('./constants');
 const {
   fileExists,
   toPosixPath,
   spawnProcess,
   dockerExec,
   ValidationError,
-} = require('../helpers');
+} = require('./helpers');
 
 async function findNPMRoot() {
   try {
@@ -29,7 +29,7 @@ async function findNPMRoot() {
 
 /**
  * Install other NPM dependencies if this is an NPM project
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  */
 const installNPMDependencies = async (libdragonInfo) => {
   const npmRoot = await findNPMRoot();

package/modules/project-info.js

@@ -5,9 +5,9 @@ const fs = require('fs/promises');
 const {
   checkContainerAndClean,
   initGitAndCacheContainerId,
-} = require('./actions/utils');
+} = require('./utils');
 
-const { findNPMRoot } = require('./actions/npm-utils');
+const { findNPMRoot } = require('./npm-utils');
 
 const {
   LIBDRAGON_PROJECT_MANIFEST,
@@ -105,8 +105,7 @@ async function findContainerId(libdragonInfo) {
     if (longId.length === 64) {
       // This shouldn't happen but if the user somehow deleted the .git folder
       // (we don't have the container id file at this point) we can recover the
-      // project. `git init` is safe anyways and it is not executed if strategy
-      // is `manual`
+      // project. This is safe and it is not executed if strategy is `manual`
       await initGitAndCacheContainerId({
         ...libdragonInfo,
         containerId: longId,

package/modules/{actions/utils.js → utils.js}

@@ -1,10 +1,7 @@
 const path = require('path');
 const fs = require('fs/promises');
 
-const {
-  CONTAINER_TARGET_PATH,
-  CACHED_CONTAINER_FILE,
-} = require('../constants');
+const { CONTAINER_TARGET_PATH, CACHED_CONTAINER_FILE } = require('./constants');
 
 const {
   fileExists,
@@ -16,13 +13,13 @@ const {
   CommandError,
   ValidationError,
   toNativePath,
-} = require('../helpers');
+} = require('./helpers');
 
 const { dockerHostUserParams } = require('./docker-utils');
 const { installNPMDependencies } = require('./npm-utils');
 
 /**
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  */
 const installDependencies = async (libdragonInfo) => {
   const buildScriptPath = path.join(
@@ -54,7 +51,7 @@ const installDependencies = async (libdragonInfo) => {
 /**
  * Downloads the given docker image. Returns false if the local image is the
  * same, true otherwise.
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  * @param {string} newImageName
  */
 const updateImage = async (libdragonInfo, newImageName) => {
@@ -98,7 +95,7 @@ const updateImage = async (libdragonInfo, newImageName) => {
 };
 
 /**
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  */
 const destroyContainer = async (libdragonInfo) => {
   assert(
@@ -128,9 +125,9 @@ const destroyContainer = async (libdragonInfo) => {
 
 /**
  *
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  * @param {string[]} params
- * @param {import('../helpers').SpawnOptions} options
+ * @param {import('./helpers').SpawnOptions} options
  */
 async function runGitMaybeHost(libdragonInfo, params, options = {}) {
   assert(
@@ -139,9 +136,30 @@ async function runGitMaybeHost(libdragonInfo, params, options = {}) {
   );
   try {
     const isWin = /^win/.test(process.platform);
+
+    // When using host's git the actual top level can be higher in the tree
+    // rather that at the root of the project. We need to find it to run some
+    // git operations like subtree.
+    const gitRoot = (
+      await spawnProcess(
+        'git',
+        ['-C', libdragonInfo.root, 'rev-parse', '--show-toplevel'],
+        { inheritStdin: false }
+      ).catch(() => {
+        // Either this is not a git repo or the host does not have git
+        // We might also screw something up but we can live with it for now
+        return '';
+      })
+    ).trim();
+
     return await spawnProcess(
       'git',
-      ['-C', libdragonInfo.root, ...params],
+      [
+        '-C',
+        libdragonInfo.root,
+        ...(gitRoot ? ['--git-dir', `${gitRoot}/.git`] : []),
+        ...params,
+      ],
       // Windows git is breaking the TTY somehow - disable TTY for now
       // We are not able to display progress for the initial clone b/c of this
       // Enable progress otherwise.
@@ -171,7 +189,7 @@ async function runGitMaybeHost(libdragonInfo, params, options = {}) {
 }
 
 /**
- * @param {import('../project-info').LibdragonInfo} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo} libdragonInfo
  */
 async function checkContainerAndClean(libdragonInfo) {
   assert(
@@ -229,20 +247,31 @@ async function checkContainerRunning(containerId) {
 }
 
 /**
- * @param {import('../project-info').LibdragonInfo & {containerId: string}} libdragonInfo
+ * @param {import('./project-info').LibdragonInfo & {containerId: string}} libdragonInfo
  */
 async function initGitAndCacheContainerId(libdragonInfo) {
   if (!libdragonInfo.containerId) {
     return;
   }
 
-  // If there is managed vendoring, make sure we have a git repo. `git init` is
-  // safe anyways...
+  // If there is managed vendoring, make sure we have a git repo.
   if (libdragonInfo.vendorStrategy !== 'manual') {
-    await runGitMaybeHost(libdragonInfo, ['init']);
+    await ensureGit(libdragonInfo);
   }
 
-  const gitFolder = path.join(libdragonInfo.root, '.git');
+  const rootGitFolder = (
+    await spawnProcess('git', [
+      'rev-parse',
+      '--show-superproject-working-tree',
+    ]).catch(() => {
+      // Probably host does not have git, can ignore
+      return '';
+    })
+  ).trim();
+
+  // Fallback to the potential git root on the project root if there is no parent
+  // git project.
+  const gitFolder = path.join(rootGitFolder || libdragonInfo.root, '.git');
   if (await dirExists(gitFolder)) {
     await fs.writeFile(
       path.join(gitFolder, CACHED_CONTAINER_FILE),
@@ -251,6 +280,29 @@ async function initGitAndCacheContainerId(libdragonInfo) {
   }
 }
 
+/**
+ * Makes sure there is a parent git repository. If not, it will create one at
+ * project root.
+ * @param {import('./project-info').LibdragonInfo} info
+ */
+async function ensureGit(info) {
+  const gitRoot = (
+    await runGitMaybeHost(info, ['rev-parse', '--show-toplevel']).catch(() => {
+      // Probably host does not have git, can ignore
+      return '';
+    })
+  ).trim();
+
+  // If the host does not have git installed, this will not run unless we
+  // have already initialized it via the container, in which case we would
+  // have it as the git root. This is not expected to mess with host git flows
+  // where there is a git working tree higher in the host filesystem, which
+  // the container does not have access to.
+  if (!gitRoot) {
+    await runGitMaybeHost(info, ['init']);
+  }
+}
+
 module.exports = {
   installDependencies,
   updateImage,
@@ -259,4 +311,5 @@ module.exports = {
   checkContainerAndClean,
   initGitAndCacheContainerId,
   runGitMaybeHost,
+  ensureGit,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libdragon",
-  "version": "11.0.1",
+  "version": "11.0.3",
   "description": "This is a docker wrapper for libdragon",
   "main": "index.js",
   "engines": {