-
Notifications
You must be signed in to change notification settings - Fork 60
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 SequenceIndexerOpts #528
Open
xiam
wants to merge
2
commits into
master
Choose a base branch
from
issue-2358_add-sequenceopts-to-constructor
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,13 +4,40 @@ import { Indexer as IndexerRpc } from './indexer.gen' | |
|
||
const fetch = typeof global === 'object' ? global.fetch : window.fetch | ||
|
||
export interface SequenceIndexerOpts { | ||
JWTAuth?: string | ||
ProjectAccessKey?: string | ||
} | ||
|
||
export class SequenceIndexer extends IndexerRpc { | ||
public jwtAuth?: string | ||
public projectAccessKey?: string | ||
|
||
constructor( | ||
hostname: string, | ||
public projectAccessKey?: string, | ||
public jwtAuth?: string | ||
opts: SequenceIndexerOpts | ||
); | ||
constructor( | ||
hostname: string, | ||
projectAccessKey?: string, | ||
jwtAuth?: string | ||
); | ||
constructor( | ||
hostname: string, | ||
...args: any[] | ||
) { | ||
super(hostname.endsWith('/') ? hostname.slice(0, -1) : hostname, fetch) | ||
|
||
if (args.length === 1 && typeof args[0] === 'object') { | ||
const opts = args[0] as SequenceIndexerOpts | ||
this.projectAccessKey = opts.ProjectAccessKey | ||
this.jwtAuth = opts.JWTAuth | ||
} else { | ||
const [projectAccessKey, jwtAuth] = args | ||
this.projectAccessKey = projectAccessKey || undefined | ||
this.jwtAuth = jwtAuth || undefined | ||
Comment on lines
+36
to
+38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is for backward-compatibility? can we was this implemented a long time ago? do you expect customers using it? |
||
} | ||
|
||
this.fetch = this._fetch | ||
} | ||
|
||
|
@@ -19,6 +46,7 @@ export class SequenceIndexer extends IndexerRpc { | |
// if its been set on the api client | ||
const headers: { [key: string]: any } = {} | ||
|
||
|
||
const jwtAuth = this.jwtAuth | ||
const projectAccessKey = this.projectAccessKey | ||
|
||
|
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 |
---|---|---|
@@ -0,0 +1,94 @@ | ||
import * as chai from 'chai' | ||
import chaiAsPromised from 'chai-as-promised' | ||
|
||
import { SequenceIndexer, SequenceIndexerOpts } from '@0xsequence/indexer' | ||
|
||
const { expect } = chai.use(chaiAsPromised) | ||
|
||
describe('SequenceIndexer initialization', () => { | ||
it('should initialize without arguments', async () => { | ||
const x = new SequenceIndexer('http://localhost:3000') | ||
expect(x.jwtAuth).to.be.undefined | ||
expect(x.projectAccessKey).to.be.undefined | ||
}); | ||
|
||
it('should initialize with PAK', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
'project-access-key' | ||
) | ||
expect(x.jwtAuth).to.be.undefined | ||
expect(x.projectAccessKey).to.equal('project-access-key') | ||
}) | ||
|
||
it('should initialize with JWT', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
null, | ||
'jwt-auth' | ||
) | ||
|
||
expect(x.jwtAuth).to.equal('jwt-auth') | ||
expect(x.projectAccessKey).to.be.undefined | ||
}) | ||
|
||
it('should initialize with JWT and PAK', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
'project-access-key', | ||
'jwt-auth' | ||
) | ||
|
||
expect(x.jwtAuth).to.equal('jwt-auth') | ||
expect(x.projectAccessKey).to.equal('project-access-key') | ||
}) | ||
|
||
it('should initialize with opts', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
{ | ||
JWTAuth: 'jwt-auth', | ||
ProjectAccessKey: 'project-access-key' | ||
} | ||
) | ||
|
||
expect(x.jwtAuth).to.equal('jwt-auth') | ||
expect(x.projectAccessKey).to.equal('project-access-key') | ||
}) | ||
|
||
it('should initialize with only PAK in opts', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
<SequenceIndexerOpts>{ | ||
ProjectAccessKey: 'project-access-key' | ||
} | ||
) | ||
|
||
expect(x.jwtAuth).to.be.undefined | ||
expect(x.projectAccessKey).to.equal('project-access-key') | ||
}) | ||
|
||
it('should initialize with empty opts', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
<SequenceIndexerOpts>{ | ||
} | ||
) | ||
|
||
expect(x.jwtAuth).to.be.undefined | ||
expect(x.projectAccessKey).to.be.undefined | ||
}) | ||
|
||
it('should ignore invalid arguments', async () => { | ||
const x = new SequenceIndexer( | ||
'http://localhost:3000', | ||
{ | ||
A: 'a', | ||
B: 'b' | ||
}, | ||
) | ||
|
||
expect(x.jwtAuth).to.be.undefined | ||
expect(x.projectAccessKey).to.be.undefined | ||
}) | ||
}); |
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.
I think this is fine
I'm just thinking - should we call it SecretKey as in the Builder UI? cc @moskalyk