Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api_id to the client output file amplify_outputs.json. #1913

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

michael-trinity
Copy link

Problem

Using DBB in lambda would result in issues since the table names generated contain the api_id

Issue number, if available:

Changes

Added the api_id to the json output file so it can be used for the dynamically generated tables.

Corresponding docs PR, if applicable:

Validation

I'm using the changed files myself currently to generate the needed file.

I tested it with this lambda code

import { DynamoDBClient } from "@aws-sdk/client-dynamodb"; import { DynamoDBDocumentClient, TransactWriteCommand } from "@aws-sdk/lib-dynamodb";

import config from '../../../../amplify_outputs.json';

const client = new DynamoDBClient({});
const docClient = DynamoDBDocumentClient.from(client);

const createTableName = (name: string) => {
    return `${name}-${config.data.api_id}-NONE`;
}

export const handler = async (event: any) => {
    const { userId, amount } = event.arguments;

    const transactItems = [
        // Update UserProfile
        {
            Update: {
                TableName: createTableName('UserProfile'),
                Key: { id: userId },
                UpdateExpression: 'ADD currentPoints :pointsToAdd',
                ExpressionAttributeValues: { ':pointsToAdd': amount }
            }
        }
    ];

    try {
        const results = await docClient.send(new TransactWriteCommand({ TransactItems: transactItems }));

        console.log(results)

        return results['$metadata']
    } catch (error) {
        console.error('Error:', error);
        throw new Error('Failed to process the transaction');
    }
};

Checklist

  • If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
  • If this PR requires a change to the Project Architecture README, I have included that update in this PR.
  • If this PR requires a docs update, I have linked to that docs PR above.
  • If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

This allows for the backend to import the json and use raw DBB queries on tables using the api_id

for example:

import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
import { DynamoDBDocumentClient, TransactWriteCommand } from "@aws-sdk/lib-dynamodb";

import config from '../../../../amplify_outputs.json';

const client = new DynamoDBClient({});
const docClient = DynamoDBDocumentClient.from(client);

const createTableName = (name: string) => {
    return `${name}-${config.data.api_id}-NONE`;
}

export const handler = async (event: any) => {
    const { userId, amount } = event.arguments;

    const transactItems = [
        // Update UserProfile
        {
            Update: {
                TableName: createTableName('UserProfile'),
                Key: { id: userId },
                UpdateExpression: 'ADD currentPoints :pointsToAdd',
                ExpressionAttributeValues: { ':pointsToAdd': amount }
            }
        }
    ];

    try {
        const results = await docClient.send(new TransactWriteCommand({ TransactItems: transactItems }));

        console.log(results)

        return results['$metadata']
    } catch (error) {
        console.error('Error:', error);
        throw new Error('Failed to process the transaction');
    }
};
@michael-trinity michael-trinity requested a review from a team as a code owner August 24, 2024 00:24
Copy link

changeset-bot bot commented Aug 24, 2024

⚠️ No Changeset found

Latest commit: d7c5f70

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant