POC - Seed Secrets

.changeset/green-melons-jump.md

@@ -0,0 +1,2 @@
+---
+---

packages/backend-seed/.npmignore

@@ -0,0 +1,14 @@
+# Be very careful editing this file. It is crafted to work around [this issue](https://github.com/npm/npm/issues/4479)
+
+# First ignore everything
+**/*
+
+# Then add back in transpiled js and ts declaration files
+!lib/**/*.js
+!lib/**/*.d.ts
+
+# Then ignore test js and ts declaration files
+*.test.js
+*.test.d.ts
+
+# This leaves us with including only js and ts declaration files of functional code

packages/backend-seed/API.md

@@ -0,0 +1,12 @@
+## API Report File for "@aws-amplify/backend-seed"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public (undocumented)
+export const GetSeedSecret: (secretName: string) => Promise<string>;
+
+// (No @packageDocumentation comment for this package)
+
+```

packages/backend-seed/README.md

@@ -0,0 +1,3 @@
+# Description
+
+Replace with a description of this package

packages/backend-seed/api-extractor.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../api-extractor.base.json"
+}

packages/backend-seed/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@aws-amplify/backend-seed",
+  "version": "0.1.0",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./lib/index.js"
+    }
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "update:api": "api-extractor run --local"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@aws-amplify/backend-secret": "^1.1.5",
+    "@aws-amplify/platform-core": "^1.3.0",
+    "@aws-amplify/plugin-types": "^1.6.0"
+  }
+}

packages/backend-seed/src/get_secret_seed.ts

@@ -0,0 +1,19 @@
+import { getSecretClientWithAmplifyErrorHandling } from '@aws-amplify/backend-secret';
+import { BackendIdentifier } from '@aws-amplify/plugin-types';
+
+//eslint-disable-next-line jsdoc/require-description
+/**
+ *
+ */
+export const GetSeedSecret = async (secretName: string): Promise<string> => {
+  if (!process.env.AMPLIFY_SANDBOX_IDENTIFIER) {
+    throw new Error('SANDBOX_IDENTIFIER is undefined.');
+  }
+  const backendId: BackendIdentifier = JSON.parse(
+    process.env.AMPLIFY_SANDBOX_IDENTIFIER
+  );
+
+  const secretClient = getSecretClientWithAmplifyErrorHandling();
+  const secret = await secretClient.getSecret(backendId, { name: secretName });
+  return secret.value;
+};

packages/backend-seed/src/index.ts

@@ -0,0 +1,3 @@
+import { GetSeedSecret } from './get_secret_seed.js';
+
+export { GetSeedSecret };

packages/backend-seed/src/namespace_resolver.ts

@@ -0,0 +1,35 @@
+import {
+  AmplifyUserError,
+  PackageJsonReader,
+} from '@aws-amplify/platform-core';
+import { EOL } from 'os';
+
+//not using this anymore
+//stole this from ../packages/cli/src/backend-identifier/local_namespace_resolver.ts for the POC
+
+export type NamespaceResolver = {
+  resolve: () => Promise<string>;
+};
+
+/**
+ * Reads the local app name from package.json#name in the current directory
+ */
+export class LocalNamespaceResolver implements NamespaceResolver {
+  /**
+   * packageJsonReader is assigned to an instance member for testing.
+   * resolve is bound to this so that it can be passed as a function reference
+   */
+  constructor(private readonly packageJsonReader: PackageJsonReader) {}
+
+  /**
+   * Returns the value of package.json#name from the current working directory
+   */
+  resolve = async () => {
+    const name = this.packageJsonReader.readFromCwd().name;
+    if (name) return name;
+    throw new AmplifyUserError('InvalidPackageJsonError', {
+      message: 'Cannot load name from the package.json',
+      resolution: `Ensure you are running ampx commands in root of your project (i.e. in the parent of the 'amplify' directory).${EOL}Also ensure that your root package.json file has a "name" field.`,
+    });
+  };
+}

packages/backend-seed/src/sandbox_id_resolver.ts

@@ -0,0 +1,33 @@
+import { userInfo as _userInfo } from 'os';
+import { NamespaceResolver } from './namespace_resolver.js';
+import { BackendIdentifier } from '@aws-amplify/plugin-types';
+
+//not using this anymore
+//stole this from ../packages/cli/src/commands/sandbox/sandbox_id_resolver.ts for the POC
+
+/**
+ * Resolves an ID that can be used to uniquely identify sandbox environments
+ */
+export class SandboxBackendIdResolver {
+  /**
+   * Initialize with an appName resolver
+   */
+  constructor(
+    private readonly namespaceResolver: NamespaceResolver,
+    private readonly userInfo = _userInfo
+  ) {}
+
+  /**
+   * Returns a concatenation of the resolved appName and the current username
+   */
+  resolve = async (identifier?: string): Promise<BackendIdentifier> => {
+    const namespace = await this.namespaceResolver.resolve();
+    const name = identifier || this.userInfo().username;
+
+    return {
+      namespace,
+      name,
+      type: 'sandbox',
+    };
+  };
+}

packages/backend-seed/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": { "rootDir": "src", "outDir": "lib" },
+  "references": [
+    { "path": "../backend-secret" },
+    { "path": "../platform-core" },
+    { "path": "../plugin-types" }
+  ]
+}

packages/backend-seed/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}

packages/cli/src/commands/sandbox/sandbox-seed/sandbox_seed_command.ts

@@ -0,0 +1,63 @@
+import { Argv, CommandModule } from 'yargs';
+import path from 'path';
+import { existsSync } from 'fs';
+import { execa } from 'execa';
+import { SandboxBackendIdResolver } from '../sandbox_id_resolver.js';
+import { PackageJsonReader } from '@aws-amplify/platform-core';
+import { LocalNamespaceResolver } from '../../../backend-identifier/local_namespace_resolver.js';
+
+/**
+ *
+ */
+export class SandboxSeedCommand implements CommandModule<object> {
+  /**
+   * @inheritDoc
+   */
+  readonly command: string;
+
+  /**
+   * @inheritDoc
+   */
+  readonly describe: string;
+
+  /**
+   * Seeds sandbox environment.
+   */
+  constructor() {
+    this.command = 'seed';
+    this.describe = 'Seeds sandbox environment';
+  }
+
+  /**
+   * @inheritDoc
+   */
+  handler = async (): Promise<void> => {
+    const sandboxID = await new SandboxBackendIdResolver(
+      new LocalNamespaceResolver(new PackageJsonReader())
+    ).resolve();
+
+    //most of this comes from the initial POC for seed, changed filepath to be more inline with discussions that have happened since then
+    const seedPath = path.join('seed.ts');
+    await execa('tsx', [seedPath], {
+      cwd: process.cwd(),
+      stdio: 'inherit',
+      env: {
+        AMPLIFY_SANDBOX_IDENTIFIER: JSON.stringify(sandboxID),
+      },
+    });
+  };
+
+  /**
+   * @inheritDoc
+   */
+  //this section also comes from the initial POC for seed
+  builder = (yargs: Argv) => {
+    return yargs.check(() => {
+      const seedPath = path.join(process.cwd(), 'seed.ts');
+      if (!existsSync(seedPath)) {
+        throw new Error(`${seedPath} must exist`);
+      }
+      return true;
+    });
+  };
+}

packages/cli/src/commands/sandbox/sandbox_command_factory.ts

@@ -10,6 +10,7 @@ import { SandboxBackendIdResolver } from './sandbox_id_resolver.js';
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import { LocalNamespaceResolver } from '../../backend-identifier/local_namespace_resolver.js';
 import { createSandboxSecretCommand } from './sandbox-secret/sandbox_secret_command_factory.js';
+import { SandboxSeedCommand } from './sandbox-seed/sandbox_seed_command.js';
 import {
   PackageJsonReader,
   UsageDataEmitterFactory,
@@ -63,7 +64,11 @@ export const createSandboxCommand = (): CommandModule<
   const commandMiddleWare = new CommandMiddleware(printer);
   return new SandboxCommand(
     sandboxFactory,
-    [new SandboxDeleteCommand(sandboxFactory), createSandboxSecretCommand()],
+    [
+      new SandboxDeleteCommand(sandboxFactory),
+      createSandboxSecretCommand(),
+      new SandboxSeedCommand(),
+    ],
     clientConfigGeneratorAdapter,
     commandMiddleWare,
     eventHandlerFactory.getSandboxEventHandlers