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

docs(ecs): make examples compile #16912

Merged
merged 8 commits into from
Oct 12, 2021
Merged

docs(ecs): make examples compile #16912

merged 8 commits into from
Oct 12, 2021

Conversation

kaizencc
Copy link
Contributor


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

@gitpod-io
Copy link

gitpod-io bot commented Oct 11, 2021

@kaizencc kaizencc requested a review from rix0rrr October 11, 2021 21:29
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 11, 2021
});
```

### Generic Log Driver
Copy link
Contributor Author

@kaizencc kaizencc Oct 11, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So GenericLogDriver.ts is not exported in index.ts. Relevant PR. Originally I thought, why not just export it and well, it causes a circular dependency (gives error: Class extends value undefined is not a constructor or null). I have no idea why. In fact, it doesn't look like GenericLogDriver or GenericLogDriverProps (the only two classes in the file) are referenced anywhere in the CDK. The file itself isn't even tested. Maybe it's safe to delete the file, but then again, how is there a circular dependency if it is not referenced anywhere?

This is all spooky to me so I did not end up touching it at all. As it stands, GenericLogDriver is not exposed therefore it shouldn't be referenced in the README.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's probably useful to have a GenericLogDriver -- we should strive to have some "escape hatch" style class everywhere, so that users can roll their own if ECS tomorrow rolls out a new feature and we haven't implemented it yet.

Let's have a look-see at what's going on here.

@rix0rrr
Copy link
Contributor

rix0rrr commented Oct 12, 2021

Oh I know. This is the issue in generic-log-driver.ts:

import { LogDriver, LogDriverConfig } from '../index';

It reads it from the main index.ts, which is in turn including the file we are currently in (generic-log-driver.ts). This is the cyclic bit.

Basically import from an index file at the same lever or higher should never be allowed--potentially we could allow importing from deeper index files. But this is the issue. Should have been:

import { LogDriver, LogDriverConfig } from './log-driver';

@mergify
Copy link
Contributor

mergify bot commented Oct 12, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify
Copy link
Contributor

mergify bot commented Oct 12, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 66a95db
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 4300a30 into aws:master Oct 12, 2021
@mergify
Copy link
Contributor

mergify bot commented Oct 12, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@kaizencc kaizencc deleted the ecs/compile branch October 12, 2021 16:08
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants