Skip to content

feat: add useAccelerateEndpoint option to S3 Config #85

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nickchauhan
Copy link
Contributor

Description

This PR adds the useAccelerateEndpoint option to the S3 configuration.

Additional chores:

  • Update to latest dependencies
  • Upgrade eslint to v9
  • Remove tslint (not required since using eslint v9)
  • Fix deprecated husky configuration

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Unit tests
  • E2E tests

Following is the test results

nestjs-s3 % yarn test
yarn run v1.22.22
$ jest --runInBand --testTimeout=60000
PASS tests/e2e/deletion-service.e2e.test.ts (5.823 s)
PASS tests/e2e/bucket-service.test.ts (6.872 s)
PASS tests/e2e/download-service.test.ts
PASS tests/e2e/objects-service.e2e.test.ts
PASS tests/e2e/pre-signed-url.service.test.ts
PASS tests/unit-tests/s3-module.test.ts
PASS tests/unit-tests/bucket-module.test.ts
PASS tests/unit-tests/prefix-service.test.ts
------------------------------------------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------------------------------------|---------|----------|---------|---------|-------------------
All files | 82.53 | 63.44 | 79.06 | 90.31 |
src | 90.69 | 61.9 | 100 | 97.14 |
constants.ts | 100 | 100 | 100 | 100 |
s3-service.factory.ts | 100 | 75 | 100 | 100 | 12-14
s3.module.ts | 86.2 | 58.82 | 100 | 95.45 | 5
src/exceptions | 100 | 100 | 100 | 100 |
missing-download-directory.exception.ts | 100 | 100 | 100 | 100 |
src/helpers | 100 | 91.66 | 100 | 100 |
prepare-options.helper.ts | 100 | 91.66 | 100 | 100 | 6-7
src/interfaces | 100 | 100 | 100 | 100 |
prefix-algorithm.interface.ts | 100 | 100 | 100 | 100 |
src/services | 77.37 | 59.8 | 73.33 | 84.74 |
buckets.service.ts | 69.49 | 63.63 | 60.6 | 71.73 | 5,56-87
default-prefix-algorithm.service.ts | 100 | 100 | 100 | 100 |
objects.service.ts | 79.71 | 60.56 | 79.31 | 89.47 | 5,15,17-18,87-88
prefix.service.ts | 85.18 | 53.12 | 100 | 95 | 5
signed-url.service.ts | 76.66 | 58.18 | 76.19 | 85.41 | 5,18,69-76
src/types | 100 | 100 | 100 | 100 |
download-options.type.ts | 100 | 100 | 100 | 100 |
object-command-options.type.ts | 100 | 100 | 100 | 100 |
prefix-algorithm.type.ts | 100 | 100 | 100 | 100 |
prefix.type.ts | 100 | 100 | 100 | 100 |
s3-config.type.ts | 100 | 100 | 100 | 100 |
signed-url.type.ts | 100 | 100 | 100 | 100 |
src/utils | 86.48 | 64.7 | 89.65 | 96.59 |
deletion.service.ts | 83.63 | 65.38 | 86.66 | 95.34 | 5,18
download.service.ts | 89.28 | 64 | 92.85 | 97.77 | 5
------------------------------------------|---------|----------|---------|---------|-------------------

Test Suites: 8 passed, 8 total
Tests: 32 passed, 32 total
Snapshots: 0 total
Time: 22.275 s, estimated 32 s
Ran all test suites.
✨ Done in 23.98s.

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

nickchauhan and others added 2 commits May 2, 2025 16:12
- Update to latest dependencies
- Upgrade eslint to v9
- tslint removed (not required since using eslint v9)
- fix husky issues (deprecated)
@MartinAndreev
Copy link
Collaborator

@nickchauhan Looks good, but maybe should be split on 2 prs. One that adds the feature and one with the dev updates.

@MartinAndreev
Copy link
Collaborator

@nickchauhan Also documentation related to the new config is not set. You can check /site/docs

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.

2 participants