feat: support cname #19
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,16 @@ | ||
| { | ||
| "name": "oss-client", | ||
| "version": "2.1.0", | ||
| "engines": { | ||
| "node": ">= 16.0.0" | ||
| }, | ||
| "description": "Aliyun OSS(Object Storage Service) Node.js Client", | ||
| "scripts": { | ||
| "lint": "eslint src test --ext .ts", | ||
| "test": "egg-bin test", | ||
| "test-local": "egg-bin test", | ||
| "cov": "egg-bin cov", | ||
| "ci": "npm run lint && npm run cov && npm run prepublishOnly && attw --pack", | ||
| "prepublishOnly": "tshy && tshy-after" | ||
| }, | ||
| "repository": { | ||
|
|
@@ -25,9 +27,6 @@ | |
| "bugs": { | ||
| "url": "https://github.com/node-modules/oss-client/issues" | ||
| }, | ||
| "homepage": "https://github.com/node-modules/oss-client", | ||
| "dependencies": { | ||
| "is-type-of": "^2.0.1", | ||
|
|
@@ -40,6 +39,7 @@ | |
| "xml2js": "^0.6.2" | ||
| }, | ||
| "devDependencies": { | ||
| "@arethetypeswrong/cli": "^0.15.3", | ||
|
There was a problem hiding this comment. Tip Codebase Verification No usage of The dependency
Analysis chainAdd new dependency The addition of Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Description: Verify the usage of `@arethetypeswrong/cli` in npm scripts.
# Test: Search for usage in npm scripts.
grep -R '@arethetypeswrong/cli' package.json
Length of output: 84 Script: #!/bin/bash
# Description: Verify the usage of `@arethetypeswrong/cli` in npm scripts.
# Extract and check the scripts section in package.json for any usage of @arethetypeswrong/cli.
jq '.scripts' package.json | grep '@arethetypeswrong/cli'
Length of output: 55 |
||
| "@eggjs/tsconfig": "^1.1.0", | ||
| "@types/mime": "^3.0.1", | ||
| "@types/mocha": "^10.0.1", | ||
|
|
@@ -49,12 +49,10 @@ | |
| "egg-bin": "^6.4.1", | ||
| "eslint": "^8.25.0", | ||
| "eslint-config-egg": "^13.0.0", | ||
| "tshy": "^1.0.0", | ||
| "tshy-after": "^1.0.0", | ||
| "typescript": "^5.2.2" | ||
| }, | ||
| "files": [ | ||
| "dist", | ||
| "src" | ||
|
|
@@ -70,14 +68,17 @@ | |
| "./package.json": "./package.json", | ||
| ".": { | ||
| "import": { | ||
| "source": "./src/index.ts", | ||
| "types": "./dist/esm/index.d.ts", | ||
| "default": "./dist/esm/index.js" | ||
| }, | ||
| "require": { | ||
| "source": "./src/index.ts", | ||
| "types": "./dist/commonjs/index.d.ts", | ||
| "default": "./dist/commonjs/index.js" | ||
| } | ||
| } | ||
| }, | ||
| "types": "./dist/commonjs/index.d.ts", | ||
| "main": "./dist/commonjs/index.js" | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,20 +64,36 @@ import { | |
| } from './util/index.js'; | ||
|
|
||
| export interface OSSObjectClientInitOptions extends OSSBaseClientInitOptions { | ||
| bucket?: string; | ||
| /** | ||
| * Enable cname | ||
| * @see https://help.aliyun.com/zh/oss/user-guide/map-custom-domain-names-5 | ||
| */ | ||
| cname?: boolean; | ||
| } | ||
|
|
||
| export class OSSObject extends OSSBaseClient implements IObjectSimple { | ||
| #bucket: string; | ||
| #bucketEndpoint: string; | ||
|
|
||
| constructor(options: OSSObjectClientInitOptions) { | ||
| if (!options.cname) { | ||
| assert(options.bucket, 'bucket required'); | ||
| } | ||
| if (options.bucket) { | ||
| checkBucketName(options.bucket); | ||
| } | ||
| super(options); | ||
| if (options.cname) { | ||
| // ignore bucket on cname set to true | ||
| this.#bucket = ''; | ||
| this.#bucketEndpoint = this.options.endpoint; | ||
| } else { | ||
| this.#bucket = options.bucket!; | ||
| const urlObject = new URL(this.options.endpoint); | ||
| urlObject.hostname = `${this.#bucket}.${urlObject.hostname}`; | ||
| this.#bucketEndpoint = urlObject.toString(); | ||
| } | ||
| } | ||
|
|
||
| /** public methods */ | ||
|
|
@@ -882,9 +898,11 @@ export class OSSObject extends OSSBaseClient implements IObjectSimple { | |
| bucketName = sourceName.replace(/\/(.+?)(\/.*)/, '$1'); | ||
| sourceName = sourceName.replace(/(\/.+?\/)(.*)/, '$2'); | ||
| } | ||
| sourceName = encodeURIComponent(sourceName); | ||
| if (bucketName) { | ||
| checkBucketName(bucketName); | ||
| sourceName = `/${bucketName}/${sourceName}`; | ||
| } | ||
| return sourceName; | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2296,4 +2296,25 @@ describe('test/OSSObject.test.ts', () => { | |
| assert.equal(result.status, 200); | ||
| }); | ||
| }); | ||
|
|
||
| describe('options.cname = true', () => { | ||
| it('should work', async () => { | ||
| const ossObject = new OSSObject({ | ||
| ...config.oss, | ||
| cname: true, | ||
| endpoint: 'https://foo.bar.com', | ||
| }); | ||
| const url = ossObject.signatureUrl('foo.jpg'); | ||
| assert.match(url, /https:\/\/foo\.bar\.com\/foo\.jpg\?OSSAccessKeyId=/); | ||
| }); | ||
|
|
||
| it('should throw error when bucket empty', async () => { | ||
| assert.throws(() => { | ||
| new OSSObject({ | ||
| ...config.oss, | ||
| bucket: '', | ||
| }); | ||
| }, /bucket required/); | ||
| }); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Specify the type of
regionin the documentation.The
regionparameter is used in the initialization ofOSSObject, but its type isn't specified in the documentation. This could lead to confusion about what values are expected (string, object, etc.).Committable suggestion