@opencrvs/create-countryconfig 2.0.1 → 2.1.0-beta.2

package/index.js

@@ -11,25 +11,37 @@
  * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
  */
 
-const { execSync } = require('child_process')
 const path = require('path')
 const fs = require('fs')
+const { execSync } = require('child_process')
+const readline = require('readline/promises')
+const degit = require('degit').default
+
+const INFRASTRUCTURE_REPOSITORY = 'opencrvs/infrastructure'
+const CORE_REPOSITORY = 'opencrvs/opencrvs-core'
+const COUNTRYCONFIG_TEMPLATE_REPOSITORY_SUBPATH =
+  'packages/countryconfig-template'
 
-const COUNTRYCONFIG_REPO_URL =
-  'https://github.com/opencrvs/opencrvs-countryconfig.git'
-const INFRASTRUCTURE_REPO_URL = 'https://github.com/opencrvs/infrastructure.git'
+const CORE_REPO_URL = 'https://github.com/' + CORE_REPOSITORY + '.git'
+const INFRASTRUCTURE_REPO_URL =
+  'https://github.com/' + INFRASTRUCTURE_REPOSITORY + '.git'
 
 const { version } = JSON.parse(
   fs.readFileSync(path.join(__dirname, 'package.json'), 'utf-8')
 )
 
+function joinValues(values, separator) {
+  return values
+    .filter((value) => !!value)
+    .join(separator)
+    .trim()
+}
+
 function tagExists(repoUrl, tag) {
   try {
     execSync(
       'git ls-remote --exit-code --tags ' + repoUrl + ' refs/tags/' + tag,
-      {
-        stdio: 'pipe'
-      }
+      { stdio: 'pipe' }
     )
     return true
   } catch (err) {
@@ -41,9 +53,7 @@ function branchExists(repoUrl, branch) {
   try {
     execSync(
       'git ls-remote --exit-code --heads ' + repoUrl + ' refs/heads/' + branch,
-      {
-        stdio: 'pipe'
-      }
+      { stdio: 'pipe' }
     )
     return true
   } catch (err) {
@@ -80,38 +90,39 @@ function listReleaseTags(repoUrl) {
 function getLatestCommonReleaseTag() {
   const infrastructureTags = new Set(listReleaseTags(INFRASTRUCTURE_REPO_URL))
   return (
-    listReleaseTags(COUNTRYCONFIG_REPO_URL).find((tag) =>
-      infrastructureTags.has(tag)
-    ) || null
+    listReleaseTags(CORE_REPO_URL).find((tag) => infrastructureTags.has(tag)) ||
+    null
   )
 }
 
 /**
- * A prerelease-shaped own version (e.g. "2.1.0-rc.f5ea803", what npm resolves
- * `@next` to - a build published from every push to a branch) never has a
- * matching release tag, so it's resolved as a branch instead. Its base
- * version (stripped of the "-rc.<sha>" suffix) tells apart two different
- * situations: an RC for a version already being stabilized on its own
- * "release/X.Y.Z" branch (e.g. "2.0.1-rc.*" while a patch release is in
- * progress) versus an RC for a version that hasn't been branched off yet and
- * only exists on develop (e.g. "2.1.0-rc.*" while that release branch hasn't
- * been cut). Scaffold from the release branch when it exists in both
- * repositories, otherwise fall back to develop.
+ * Resolves the ref that both repositories are cloned from. A single ref
+ * clones both, so every candidate must exist in *both* - a tag present in
+ * only one of them can't be used.
  *
- * Otherwise, the own "X.Y.Z" version - whether resolved via npm's `latest`
- * dist-tag (bare invocation) or an explicit `@X.Y.Z` pin - scaffolds from the
- * matching "vX.Y.Z" tag when it exists in both repositories. If it doesn't
- * (e.g. `latest` lagging behind the repos, or a pin that predates one repo's
- * tagging), fall back to the highest release tag common to both, rather than
- * a mismatched pairing of one tagged repo at that version and another repo
- * at a different release. Exits with an error if no matching release tag
- * exists in both repositories.
+ * The exact "v<version>" tag wins whenever it exists: it pins a commit, so
+ * a release, an explicit `@X.Y.Z` pin, or a blessed prerelease (npm `@beta`,
+ * published from that tag) reproduces however late it's scaffolded.
+ *
+ * Otherwise a prerelease falls back to a branch, since a rolling release
+ * candidate (npm `@next`) is never tagged: "release/X.Y.Z" of the base
+ * version when that release has been cut, otherwise develop. A release
+ * falls back to the highest tag common to both repositories - never a
+ * mismatched pairing of the two at different releases - or errors.
  */
 function resolveRef() {
+  const versionTag = 'v' + version
+  if (
+    tagExists(CORE_REPO_URL, versionTag) &&
+    tagExists(INFRASTRUCTURE_REPO_URL, versionTag)
+  ) {
+    return versionTag
+  }
+
   if (version.includes('-')) {
     const releaseBranch = 'release/' + version.split('-')[0]
     if (
-      branchExists(COUNTRYCONFIG_REPO_URL, releaseBranch) &&
+      branchExists(CORE_REPO_URL, releaseBranch) &&
       branchExists(INFRASTRUCTURE_REPO_URL, releaseBranch)
     ) {
       return releaseBranch
@@ -119,19 +130,11 @@ function resolveRef() {
     return 'develop'
   }
 
-  const tag = 'v' + version
-  if (
-    tagExists(COUNTRYCONFIG_REPO_URL, tag) &&
-    tagExists(INFRASTRUCTURE_REPO_URL, tag)
-  ) {
-    return tag
-  }
-
   const latestCommonTag = getLatestCommonReleaseTag()
   if (latestCommonTag) {
     console.warn(
       '\nWarning: tag "' +
-        tag +
+        versionTag +
         '" was not found in both repositories; falling back to the latest ' +
         'available release, ' +
         latestCommonTag +
@@ -141,126 +144,307 @@ function resolveRef() {
   }
 
   console.error(
-    '\nError: no matching release tag was found in both the country config and ' +
+    '\nError: no matching release tag was found in both the core and ' +
       'infrastructure repositories.'
   )
   process.exit(1)
 }
 
-function cloneRepository(repoUrl, ref, targetDir) {
-  execSync(
-    'git clone --depth 1 --branch ' + ref + ' ' + repoUrl + ' ' + targetDir,
-    { stdio: 'inherit' }
-  )
+/**
+ * Clones a repository from GitHub to a target directory.
+ *
+ * @param {*} param0 repository - The repository to clone (e.g., 'opencrvs/opencrvs-core').
+ * @param {*} param0 repositorySubPath - The subpath within the repository to clone (optional). Otherwise the entire repository will be cloned.
+ * @param {*} param0 branch - The branch to clone (optional). Defaults to the default branch if not specified.
+ *
+ * @param {*} targetDir - The target directory where the repository will be cloned.
+ */
+async function cloneRepository(
+  { repository, repositorySubPath, branch },
+  targetDir
+) {
+  const repositoryPath = joinValues([repository, repositorySubPath], '/')
+  const fullPath = joinValues([repositoryPath, branch], '#')
+
+  console.log(`Cloning repository from ${fullPath} to ${targetDir}...`)
+
+  const emitter = degit(fullPath, {
+    mode: 'git'
+  })
+
+  await emitter.clone(targetDir)
+  console.log(`Copied files from ${fullPath} to ${targetDir} succesfully.`)
 }
 
-const projectName = process.argv[2]
+function ensureTargetDirectoryDoesNotExist(directoryName) {
+  const targetDirectoryPath = path.resolve(process.cwd(), directoryName)
 
-if (!projectName) {
-  console.error(
-    'Please specify a project name:\n\n  npm create @opencrvs/countryconfig <project-name>\n'
-  )
-  process.exit(1)
+  if (fs.existsSync(targetDirectoryPath)) {
+    console.error(
+      'Error: Directory already exists in path "' + targetDirectoryPath + '".'
+    )
+    process.exit(1)
+  }
 }
 
-const countryconfigDirName = projectName + '-countryconfig'
-const infrastructureDirName = projectName + '-infrastructure'
+/**
+ * Asks whether to enable telemetry. Defaults to yes, and answers yes without
+ * prompting when not attached to a terminal (e.g. non-interactive scaffolding).
+ */
+async function promptEnableTelemetry() {
+  if (!process.stdin.isTTY) {
+    return true
+  }
 
-const countryconfigTargetDir = path.resolve(process.cwd(), countryconfigDirName)
-const infrastructureTargetDir = path.resolve(
-  process.cwd(),
-  infrastructureDirName
-)
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  })
+  try {
+    const answer = (
+      await rl.question(
+        '\nEnable anonymous usage telemetry to help improve OpenCRVS? Only ' +
+          'aggregate metrics are shared — no personal or protected data. [Y/n] '
+      )
+    )
+      .trim()
+      .toLowerCase()
+    return answer === '' || answer === 'y' || answer === 'yes'
+  } finally {
+    rl.close()
+  }
+}
 
-if (fs.existsSync(countryconfigTargetDir)) {
-  console.error(
-    'Error: Directory "' + countryconfigDirName + '" already exists.'
+/**
+ * Prompts for a single line of input, re-asking until `validate` accepts the
+ * trimmed answer. `validate` returns an error message string when the answer is
+ * invalid, or a falsy value when it is accepted. Exits when not attached to a
+ * terminal, since a mandatory value cannot be gathered non-interactively.
+ */
+async function promptRequired(question, validate) {
+  if (!process.stdin.isTTY) {
+    console.error(
+      '\nError: interactive input is required to set the organisation name and country code.'
+    )
+    process.exit(1)
+  }
+
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  })
+  try {
+    while (true) {
+      const answer = (await rl.question(question)).trim()
+      const error = validate(answer)
+      if (!error) {
+        return answer
+      }
+      console.error(error)
+    }
+  } finally {
+    rl.close()
+  }
+}
+
+/**
+ * Prompts for the organisation name reported with telemetry. Mandatory.
+ */
+function promptOrganisation() {
+  return promptRequired('\nOrganisation running this instance: ', (answer) =>
+    answer === '' ? 'Please enter an organisation name.' : undefined
   )
-  process.exit(1)
 }
 
-if (fs.existsSync(infrastructureTargetDir)) {
-  console.error(
-    'Error: Directory "' + infrastructureDirName + '" already exists.'
+/**
+ * Prompts for the alpha-3 ISO country code reported with telemetry, re-asking
+ * until a valid three-letter code is given. Mandatory.
+ */
+async function promptCountryCode() {
+  const answer = await promptRequired(
+    '\nAlpha-3 ISO country code of this instance (e.g. "GBR"): ',
+    (value) =>
+      /^[A-Za-z]{3}$/.test(value)
+        ? undefined
+        : 'Please enter a three-letter alpha-3 ISO country code (e.g. "GBR").'
   )
-  process.exit(1)
+  return answer.toUpperCase()
 }
 
-const ref = resolveRef()
+/**
+ * Flips the `TELEMETRY_ENABLED` env var default in the cloned country config's
+ * environment to `true`. The template ships it defaulting to `false`.
+ */
+function enableTelemetryInEnvironment(targetPath) {
+  const environmentPath = path.join(targetPath, 'src', 'environment.ts')
+  if (!fs.existsSync(environmentPath)) {
+    console.warn(
+      '\nWarning: could not find src/environment.ts; telemetry default not changed.'
+    )
+    return
+  }
+
+  const original = fs.readFileSync(environmentPath, 'utf-8')
+  const updated = original.replace(
+    /(TELEMETRY_ENABLED:\s*bool\(\{[\s\S]*?default:\s*)false/,
+    '$1true'
+  )
 
-console.log(
-  '\nScaffolding OpenCRVS country config in ./' + countryconfigDirName + '...\n'
-)
+  if (updated === original) {
+    console.warn(
+      '\nWarning: could not update the TELEMETRY_ENABLED default in src/environment.ts.'
+    )
+    return
+  }
 
-try {
-  cloneRepository(COUNTRYCONFIG_REPO_URL, ref, countryconfigDirName)
-} catch (err) {
-  console.error('Failed to clone the country config repository:', err.message)
-  process.exit(1)
+  fs.writeFileSync(environmentPath, updated)
+  console.log('\nTelemetry enabled (TELEMETRY_ENABLED now defaults to true).')
 }
 
-try {
-  fs.rmSync(path.join(countryconfigTargetDir, '.git'), {
-    recursive: true,
-    force: true
-  })
-} catch (err) {
-  console.error(
-    'Failed to remove .git directory from country config:',
-    err.message
+/**
+ * Replaces the string `default` of an envalid `str({ ... })` field in the
+ * cloned country config's environment. Returns the updated source, or the
+ * original source (with a warning) when the field could not be located.
+ */
+function setEnvironmentStringDefault(source, key, value) {
+  const pattern = new RegExp(
+    `(${key}:\\s*str\\(\\{[\\s\\S]*?default:\\s*)'[^']*'`
   )
-  process.exit(1)
+  // Escape for a single-quoted TS string literal, and use a function replacer
+  // so `$` in the value is not treated as a replacement pattern.
+  const literal = "'" + value.replace(/\\/g, '\\\\').replace(/'/g, "\\'") + "'"
+  const updated = source.replace(pattern, (_, prefix) => prefix + literal)
+
+  if (updated === source) {
+    console.warn(
+      `\nWarning: could not update the ${key} default in src/environment.ts.`
+    )
+  }
+
+  return updated
+}
+
+/**
+ * Writes the given organisation name and alpha-3 country code as the defaults
+ * for the `ORGANISATION` and `COUNTRY_CODE` env vars in the cloned country
+ * config's environment.
+ */
+function setTelemetryIdentityInEnvironment(
+  targetPath,
+  { organisation, countryCode }
+) {
+  const environmentPath = path.join(targetPath, 'src', 'environment.ts')
+  if (!fs.existsSync(environmentPath)) {
+    console.warn(
+      '\nWarning: could not find src/environment.ts; organisation and country code defaults not changed.'
+    )
+    return
+  }
+
+  let source = fs.readFileSync(environmentPath, 'utf-8')
+  source = setEnvironmentStringDefault(source, 'ORGANISATION', organisation)
+  source = setEnvironmentStringDefault(source, 'COUNTRY_CODE', countryCode)
+  fs.writeFileSync(environmentPath, source)
 }
 
-const pkgPath = path.join(countryconfigTargetDir, 'package.json')
-if (fs.existsSync(pkgPath)) {
+function updatePackageJsonName(targetPath, newName) {
+  console.log('\nUpdating package.json with project name: ' + newName + '\n')
+
+  const pkgPath = path.join(targetPath, 'package.json')
+  if (fs.existsSync(pkgPath)) {
+    try {
+      const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
+      pkg.name = newName
+      fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+    } catch (err) {
+      console.error('\nFailed to update package.json:', err.message)
+      process.exit(1)
+    }
+  } else {
+    console.warn(
+      '\nWarning: No package.json found in the targetPath: ' +
+        targetPath +
+        '. Project name was not updated.'
+    )
+  }
+}
+
+async function main() {
+  const projectName = process.argv[2]
+
+  if (!projectName) {
+    console.error(
+      'Please specify a project name:\n\n  npm create @opencrvs/countryconfig <project-name>\n'
+    )
+    process.exit(1)
+  }
+
+  const countryconfigDirName = projectName + '-countryconfig'
+  const countryconfigTargetPath = path.resolve(
+    process.cwd(),
+    countryconfigDirName
+  )
+  const infrastructureDirName = projectName + '-infrastructure'
+  const infrastructureTargetPath = path.resolve(
+    process.cwd(),
+    infrastructureDirName
+  )
+
+  ensureTargetDirectoryDoesNotExist(countryconfigDirName)
+  ensureTargetDirectoryDoesNotExist(infrastructureDirName)
+
+  const ref = resolveRef()
+
+  // Gather all answers up front so the operator isn't interrupted mid-clone.
+  const organisation = await promptOrganisation()
+  const countryCode = await promptCountryCode()
+  const telemetryEnabled = await promptEnableTelemetry()
+
   try {
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
-    pkg.name = countryconfigDirName
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+    await cloneRepository(
+      {
+        repository: CORE_REPOSITORY,
+        repositorySubPath: COUNTRYCONFIG_TEMPLATE_REPOSITORY_SUBPATH,
+        branch: ref
+      },
+      countryconfigTargetPath
+    )
   } catch (err) {
-    console.error('Failed to update package.json:', err.message)
+    console.error('\nFailed to clone country config template:', err.message)
     process.exit(1)
   }
-} else {
-  console.warn(
-    'Warning: No package.json found in the cloned country config repository. Project name was not updated.'
-  )
-}
 
-console.log(
-  '\nScaffolding OpenCRVS infrastructure in ./' +
-    infrastructureDirName +
-    '...\n'
-)
+  updatePackageJsonName(countryconfigTargetPath, countryconfigDirName)
 
-try {
-  cloneRepository(INFRASTRUCTURE_REPO_URL, ref, infrastructureDirName)
-} catch (err) {
-  console.error('Failed to clone the infrastructure repository:', err.message)
-  process.exit(1)
-}
+  try {
+    await cloneRepository(
+      { repository: INFRASTRUCTURE_REPOSITORY, branch: ref },
+      infrastructureTargetPath
+    )
+  } catch (err) {
+    console.error('Failed to clone the infrastructure repository:', err.message)
+    process.exit(1)
+  }
 
-try {
-  fs.rmSync(path.join(infrastructureTargetDir, '.git'), {
-    recursive: true,
-    force: true
+  setTelemetryIdentityInEnvironment(countryconfigTargetPath, {
+    organisation,
+    countryCode
   })
-} catch (err) {
-  console.error(
-    'Failed to remove .git directory from infrastructure:',
-    err.message
-  )
-  process.exit(1)
+
+  if (telemetryEnabled) {
+    enableTelemetryInEnvironment(countryconfigTargetPath)
+  }
+
+  console.log('\nDone! Your project has been set up in two directories:\n')
+  console.log('  ./' + countryconfigDirName + '   -- country configuration')
+  console.log('  ./' + infrastructureDirName + '  -- server infrastructure\n')
+  console.log('To get started with the country config:\n')
+  console.log('  cd ' + countryconfigDirName)
+  console.log('  git init')
+  console.log('  tilt up\n')
+  console.log('To get started with the infrastructure:\n')
+  console.log('  cd ' + infrastructureDirName)
+  console.log('  git init\n')
 }
 
-console.log('\nDone! Your project has been set up in two directories:\n')
-console.log('  ./' + countryconfigDirName + '   -- country configuration')
-console.log('  ./' + infrastructureDirName + '  -- server infrastructure\n')
-console.log('To get started with the country config:\n')
-console.log('  cd ' + countryconfigDirName)
-console.log('  git init')
-console.log('  npm install\n')
-console.log('To get started with the infrastructure:\n')
-console.log('  cd ' + infrastructureDirName)
-console.log('  git init\n')
+main()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/create-countryconfig",
-  "version": "2.0.1",
+  "version": "2.1.0-beta.2",
   "description": "Scaffold a new OpenCRVS country configuration",
   "bin": {
     "create-countryconfig": "./index.js"
@@ -17,5 +17,8 @@
     "countryconfig",
     "create"
   ],
-  "license": "MPL-2.0"
+  "license": "MPL-2.0",
+  "dependencies": {
+    "degit": "^3.6.5"
+  }
 }